Skip to content

Latest commit

 

History

History
271 lines (188 loc) · 7.06 KB

MessageTemplatesApi.md

File metadata and controls

271 lines (188 loc) · 7.06 KB

MessageTemplatesApi

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

Method HTTP request Description
messageTemplateCreate POST /v4/api/message-template
messageTemplateDelete DELETE /v4/api/message-template/{id}
messageTemplateGet GET /v4/api/message-template/{id}
messageTemplateSearch GET /v4/api/message-template
messageTemplateUpdate PUT /v4/api/message-template/{id}

messageTemplateCreate

MessageTemplate messageTemplateCreate(body)

Create an message template.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


MessageTemplatesApi apiInstance = new MessageTemplatesApi();
MessageTemplateCreate body = new MessageTemplateCreate(); // MessageTemplateCreate | 
try {
    MessageTemplate result = apiInstance.messageTemplateCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MessageTemplatesApi#messageTemplateCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body MessageTemplateCreate [optional]

Return type

MessageTemplate

Authorization

Bearer

HTTP request headers

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

messageTemplateDelete

messageTemplateDelete(id)

Remove an message template.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

messageTemplateGet

MessageTemplate messageTemplateGet(id)

Retrieve an message template.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

Parameters

Name Type Description Notes
id String

Return type

MessageTemplate

Authorization

Bearer

HTTP request headers

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

messageTemplateSearch

MessageTemplatePaginationResponse messageTemplateSearch(filter, query, page, perPage, sort)

Search message templates.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

MessageTemplatePaginationResponse

Authorization

Bearer

HTTP request headers

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

messageTemplateUpdate

MessageTemplate messageTemplateUpdate(id, body)

Update an message template.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


MessageTemplatesApi apiInstance = new MessageTemplatesApi();
String id = "id_example"; // String | 
MessageTemplateUpdate body = new MessageTemplateUpdate(); // MessageTemplateUpdate | 
try {
    MessageTemplate result = apiInstance.messageTemplateUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MessageTemplatesApi#messageTemplateUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body MessageTemplateUpdate [optional]

Return type

MessageTemplate

Authorization

Bearer

HTTP request headers

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