Skip to content

Latest commit

 

History

History
271 lines (188 loc) · 6.29 KB

AccountsApi.md

File metadata and controls

271 lines (188 loc) · 6.29 KB

AccountsApi

All URIs are relative to https://app.statflo.com

Method HTTP request Description
accountCreate POST /v4/api/account
accountDelete DELETE /v4/api/account/{id}
accountGet GET /v4/api/account/{id}
accountSearch GET /v4/api/account
accountUpdate PUT /v4/api/account/{id}

accountCreate

Account accountCreate(body)

Create an account.

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


AccountsApi apiInstance = new AccountsApi();
AccountCreate body = new AccountCreate(); // AccountCreate | 
try {
    Account result = apiInstance.accountCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#accountCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body AccountCreate [optional]

Return type

Account

Authorization

Bearer

HTTP request headers

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

accountDelete

accountDelete(id)

Remove an account.

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


AccountsApi apiInstance = new AccountsApi();
String id = "id_example"; // String | 
try {
    apiInstance.accountDelete(id);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#accountDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

accountGet

Account accountGet(id)

Retrieve an account.

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


AccountsApi apiInstance = new AccountsApi();
String id = "id_example"; // String | 
try {
    Account result = apiInstance.accountGet(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#accountGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

Account

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

accountSearch

AccountPaginationResponse accountSearch(filter, query, page, perPage, sort)

Search accounts.

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


AccountsApi apiInstance = new AccountsApi();
java.util.HashMap filter = new java.util.HashMap(); // java.util.HashMap | 
String query = "query_example"; // String | 
Integer page = 56; // Integer | 
Integer perPage = 56; // Integer | 
String sort = "sort_example"; // String | 
try {
    AccountPaginationResponse result = apiInstance.accountSearch(filter, query, page, perPage, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#accountSearch");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
filter java.util.HashMap [optional]
query String [optional]
page Integer [optional]
perPage Integer [optional]
sort String [optional]

Return type

AccountPaginationResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

accountUpdate

Account accountUpdate(id, body)

Update an account.

Example

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


AccountsApi apiInstance = new AccountsApi();
String id = "id_example"; // String | 
AccountUpdate body = new AccountUpdate(); // AccountUpdate | 
try {
    Account result = apiInstance.accountUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AccountsApi#accountUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body AccountUpdate [optional]

Return type

Account

Authorization

Bearer

HTTP request headers

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