AccountsApi

All URIs are relative to https://api.togai.com

Method	HTTP request	Description
addAliases	POST /customers/{customer_id}/accounts/{account_id}/add_aliases	Add Aliases to account
createAccount	POST /customers/{customer_id}/accounts	Create an account
deleteAccount	DELETE /customers/{customer_id}/accounts/{account_id}	Delete an account
getAccount	GET /customers/{customer_id}/accounts/{account_id}	Get an account
getAccounts	GET /customers/{customer_id}/accounts	List accounts of customer
removeAliases	POST /customers/{customer_id}/accounts/{account_id}/remove_aliases	Remove Aliases to account
updateAccount	PATCH /customers/{customer_id}/accounts/{account_id}	Update an account
updatePricingSchedule	POST /customers/{customer_id}/accounts/{account_id}/price_plans	Dis/associate a plan from/to an account

addAliases

Account addAliases(customerId, accountId, addAccountAliasesRequest)

Add Aliases to account

Add aliases to an account using customer_id and account_id.

Example

// Import classes:
import com.togai.client.ApiClient;
import com.togai.client.ApiException;
import com.togai.client.Configuration;
import com.togai.client.auth.*;
import com.togai.client.models.*;
import com.togai.client.api.AccountsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.togai.com");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    AccountsApi apiInstance = new AccountsApi(defaultClient);
    String customerId = "customerId_example"; // String | 
    String accountId = "accountId_example"; // String | account_id corresponding to an account
    AddAccountAliasesRequest addAccountAliasesRequest = new AddAccountAliasesRequest(); // AddAccountAliasesRequest | Payload to add aliases to account
    try {
      Account result = apiInstance.addAliases(customerId, accountId, addAccountAliasesRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccountsApi#addAliases");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
customerId	String
accountId	String	account_id corresponding to an account
addAccountAliasesRequest	AddAccountAliasesRequest	Payload to add aliases to account

Return type

Account

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Response for Create and Get account requests	-
400	Error response	-
401	Error response	-
403	Error response	-
404	Error response	-
429	Error response	-
0	Error response	-

createAccount

Account createAccount(customerId, createAccountRequest)

Create an account

This API let’s you to create an account for a customer using customer_id.

Example

// Import classes:
import com.togai.client.ApiClient;
import com.togai.client.ApiException;
import com.togai.client.Configuration;
import com.togai.client.auth.*;
import com.togai.client.models.*;
import com.togai.client.api.AccountsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.togai.com");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    AccountsApi apiInstance = new AccountsApi(defaultClient);
    String customerId = "customerId_example"; // String | 
    CreateAccountRequest createAccountRequest = new CreateAccountRequest(); // CreateAccountRequest | Payload to create account
    try {
      Account result = apiInstance.createAccount(customerId, createAccountRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccountsApi#createAccount");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
customerId	String
createAccountRequest	CreateAccountRequest	Payload to create account

Return type

Account

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Response for Create and Get account requests	-
400	Error response	-
401	Error response	-
403	Error response	-
404	Error response	-
429	Error response	-
0	Error response	-

deleteAccount

BaseSuccessResponse deleteAccount(customerId, accountId)

Delete an account

This API let’s you to delete a customer using customer_id and account_id.

Example

// Import classes:
import com.togai.client.ApiClient;
import com.togai.client.ApiException;
import com.togai.client.Configuration;
import com.togai.client.auth.*;
import com.togai.client.models.*;
import com.togai.client.api.AccountsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.togai.com");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    AccountsApi apiInstance = new AccountsApi(defaultClient);
    String customerId = "customerId_example"; // String | 
    String accountId = "accountId_example"; // String | account_id corresponding to an account
    try {
      BaseSuccessResponse result = apiInstance.deleteAccount(customerId, accountId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccountsApi#deleteAccount");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
customerId	String
accountId	String	account_id corresponding to an account

Return type

BaseSuccessResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	Error response	-
401	Error response	-
403	Error response	-
404	Error response	-
429	Error response	-
0	Error response	-

getAccount

Account getAccount(customerId, accountId)

Get an account

Get account information using customer_id and account_id.

Example

// Import classes:
import com.togai.client.ApiClient;
import com.togai.client.ApiException;
import com.togai.client.Configuration;
import com.togai.client.auth.*;
import com.togai.client.models.*;
import com.togai.client.api.AccountsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.togai.com");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    AccountsApi apiInstance = new AccountsApi(defaultClient);
    String customerId = "customerId_example"; // String | 
    String accountId = "accountId_example"; // String | account_id corresponding to an account
    try {
      Account result = apiInstance.getAccount(customerId, accountId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccountsApi#getAccount");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
customerId	String
accountId	String	account_id corresponding to an account

Return type

Account

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Response for Create and Get account requests	-
400	Error response	-
401	Error response	-
403	Error response	-
404	Error response	-
429	Error response	-
0	Error response	-

getAccounts

AccountPaginatedResponse getAccounts(customerId, nextToken, pageSize)

List accounts of customer

Returns a list of accounts of a customer with pagination and sort.

Example

// Import classes:
import com.togai.client.ApiClient;
import com.togai.client.ApiException;
import com.togai.client.Configuration;
import com.togai.client.auth.*;
import com.togai.client.models.*;
import com.togai.client.api.AccountsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.togai.com");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    AccountsApi apiInstance = new AccountsApi(defaultClient);
    String customerId = "customerId_example"; // String | 
    String nextToken = "eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ=="; // String | 
    BigDecimal pageSize = new BigDecimal("10"); // BigDecimal | 
    try {
      AccountPaginatedResponse result = apiInstance.getAccounts(customerId, nextToken, pageSize);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccountsApi#getAccounts");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Notes
customerId	String
nextToken	String	[optional]
pageSize	BigDecimal	[optional]

Return type

AccountPaginatedResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Response for list customers request	-
400	Error response	-
401	Error response	-
403	Error response	-
404	Error response	-
429	Error response	-
0	Error response	-

removeAliases

Account removeAliases(customerId, accountId, removeAccountAliasesRequest)

Remove Aliases to account

Remove existing aliases tagged to an account using this API

Example

// Import classes:
import com.togai.client.ApiClient;
import com.togai.client.ApiException;
import com.togai.client.Configuration;
import com.togai.client.auth.*;
import com.togai.client.models.*;
import com.togai.client.api.AccountsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.togai.com");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    AccountsApi apiInstance = new AccountsApi(defaultClient);
    String customerId = "customerId_example"; // String | 
    String accountId = "accountId_example"; // String | account_id corresponding to an account
    RemoveAccountAliasesRequest removeAccountAliasesRequest = new RemoveAccountAliasesRequest(); // RemoveAccountAliasesRequest | Payload to remove aliases from account
    try {
      Account result = apiInstance.removeAliases(customerId, accountId, removeAccountAliasesRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccountsApi#removeAliases");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
customerId	String
accountId	String	account_id corresponding to an account
removeAccountAliasesRequest	RemoveAccountAliasesRequest	Payload to remove aliases from account

Return type

Account

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Response for Create and Get account requests	-
400	Error response	-
401	Error response	-
403	Error response	-
404	Error response	-
429	Error response	-
0	Error response	-

updateAccount

Account updateAccount(customerId, accountId, updateAccountRequest)

Update an account

This API let’s you to update an account’s information using customer_id and account_id.

Example

// Import classes:
import com.togai.client.ApiClient;
import com.togai.client.ApiException;
import com.togai.client.Configuration;
import com.togai.client.auth.*;
import com.togai.client.models.*;
import com.togai.client.api.AccountsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.togai.com");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    AccountsApi apiInstance = new AccountsApi(defaultClient);
    String customerId = "customerId_example"; // String | 
    String accountId = "accountId_example"; // String | account_id corresponding to an account
    UpdateAccountRequest updateAccountRequest = new UpdateAccountRequest(); // UpdateAccountRequest | Payload to update account
    try {
      Account result = apiInstance.updateAccount(customerId, accountId, updateAccountRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccountsApi#updateAccount");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
customerId	String
accountId	String	account_id corresponding to an account
updateAccountRequest	UpdateAccountRequest	Payload to update account

Return type

Account

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Response for Create and Get account requests	-
400	Error response	-
401	Error response	-
403	Error response	-
404	Error response	-
429	Error response	-
0	Error response	-

updatePricingSchedule

UpdatePricingScheduleResponse updatePricingSchedule(customerId, accountId, updatePricingScheduleRequest)

Dis/associate a plan from/to an account

This API let’s you to detach/attach a price plan from/to an existing account

Example

// Import classes:
import com.togai.client.ApiClient;
import com.togai.client.ApiException;
import com.togai.client.Configuration;
import com.togai.client.auth.*;
import com.togai.client.models.*;
import com.togai.client.api.AccountsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.togai.com");
    
    // Configure HTTP bearer authorization: bearerAuth
    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
    bearerAuth.setBearerToken("BEARER TOKEN");

    AccountsApi apiInstance = new AccountsApi(defaultClient);
    String customerId = "customerId_example"; // String | 
    String accountId = "accountId_example"; // String | account_id corresponding to an account
    UpdatePricingScheduleRequest updatePricingScheduleRequest = new UpdatePricingScheduleRequest(); // UpdatePricingScheduleRequest | Payload to dis/associate a price plan to an account
    try {
      UpdatePricingScheduleResponse result = apiInstance.updatePricingSchedule(customerId, accountId, updatePricingScheduleRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AccountsApi#updatePricingSchedule");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description
customerId	String
accountId	String	account_id corresponding to an account
updatePricingScheduleRequest	UpdatePricingScheduleRequest	Payload to dis/associate a price plan to an account

Return type

UpdatePricingScheduleResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Response for dis/associate price plan request	-
400	Error response	-
401	Error response	-
403	Error response	-
404	Error response	-
429	Error response	-
0	Error response	-

Files

AccountsApi.md

Latest commit

History

AccountsApi.md

File metadata and controls

AccountsApi

addAliases

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createAccount

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteAccount

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAccount

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAccounts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

removeAliases

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateAccount

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updatePricingSchedule

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details