Skip to content

Latest commit

 

History

History
221 lines (154 loc) · 5.24 KB

MessagesApi.md

File metadata and controls

221 lines (154 loc) · 5.24 KB

MessagesApi

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

Method HTTP request Description
messageCreate POST /v4/api/message
messageGet GET /v4/api/message/{id}
messageSearch GET /v4/api/message
messageUpdate PUT /v4/api/message/{id}

messageCreate

Message messageCreate(body)

Create a message.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


MessagesApi apiInstance = new MessagesApi();
MessageCreate body = new MessageCreate(); // MessageCreate | 
try {
    Message result = apiInstance.messageCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MessagesApi#messageCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body MessageCreate [optional]

Return type

Message

Authorization

Bearer

HTTP request headers

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

messageGet

Message messageGet(id)

Retrieve a message.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

Parameters

Name Type Description Notes
id String

Return type

Message

Authorization

Bearer

HTTP request headers

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

messageSearch

MessagePaginationResponse messageSearch(filter, query, page, perPage, sort)

Search messages.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

MessagePaginationResponse

Authorization

Bearer

HTTP request headers

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

messageUpdate

Message messageUpdate(id, body)

Update a message.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


MessagesApi apiInstance = new MessagesApi();
String id = "id_example"; // String | 
MessageUpdate body = new MessageUpdate(); // MessageUpdate | 
try {
    Message result = apiInstance.messageUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MessagesApi#messageUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body MessageUpdate [optional]

Return type

Message

Authorization

Bearer

HTTP request headers

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