Skip to content

UserApi.md

Latest commit

 

History

History
271 lines (188 loc) · 5.98 KB

UserApi.md

File metadata and controls

271 lines (188 loc) · 5.98 KB
Raw

UserApi

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

Method HTTP request Description
userCreate POST /v4/api/user
userDelete DELETE /v4/api/user/{id}
userGet GET /v4/api/user/{id}
userSearch GET /v4/api/user
userUpdate PUT /v4/api/user/{id}

userCreate

User userCreate(body)

Create a user.

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.UserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


UserApi apiInstance = new UserApi();
UserCreate body = new UserCreate(); // UserCreate | 
try {
    User result = apiInstance.userCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#userCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body UserCreate [optional]

Return type

User

Authorization

Bearer

HTTP request headers

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

userDelete

userDelete(id)

Remove a user.

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.UserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


UserApi apiInstance = new UserApi();
String id = "id_example"; // String | 
try {
    apiInstance.userDelete(id);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#userDelete");
    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: application/json

userGet

User userGet(id)

Retrieve an user.

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.UserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

Parameters

Name Type Description Notes
id String

Return type

User

Authorization

Bearer

HTTP request headers

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

userSearch

UserPaginationResponse userSearch(filter, query, page, perPage, sort)

Search users.

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.UserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


UserApi apiInstance = new UserApi();
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 {
    UserPaginationResponse result = apiInstance.userSearch(filter, query, page, perPage, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#userSearch");
    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

UserPaginationResponse

Authorization

Bearer

HTTP request headers

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

userUpdate

User userUpdate(id, body)

Update a user.

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.UserApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


UserApi apiInstance = new UserApi();
String id = "id_example"; // String | 
UserUpdate body = new UserUpdate(); // UserUpdate | 
try {
    User result = apiInstance.userUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling UserApi#userUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body UserUpdate [optional]

Return type

User

Authorization

Bearer

HTTP request headers

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