Skip to content

Latest commit

 

History

History
271 lines (188 loc) · 7.61 KB

File metadata and controls

271 lines (188 loc) · 7.61 KB

MessageDeliveryStatusApi

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

Method HTTP request Description
messageDeliveryStatusCreate POST /v4/api/message-delivery-status
messageDeliveryStatusDelete DELETE /v4/api/message-delivery-status/{id}
messageDeliveryStatusGet GET /v4/api/message-delivery-status/{id}
messageDeliveryStatusSearch GET /v4/api/message-delivery-status
messageDeliveryStatusUpdate PUT /v4/api/message-delivery-status/{id}

messageDeliveryStatusCreate

MessageDeliveryStatus messageDeliveryStatusCreate(body)

Create a message delivery status.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


MessageDeliveryStatusApi apiInstance = new MessageDeliveryStatusApi();
MessageDeliveryStatusCreate body = new MessageDeliveryStatusCreate(); // MessageDeliveryStatusCreate | 
try {
    MessageDeliveryStatus result = apiInstance.messageDeliveryStatusCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MessageDeliveryStatusApi#messageDeliveryStatusCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body MessageDeliveryStatusCreate [optional]

Return type

MessageDeliveryStatus

Authorization

Bearer

HTTP request headers

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

messageDeliveryStatusDelete

messageDeliveryStatusDelete(id)

Remove a Message Delivery Status.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

messageDeliveryStatusGet

MessageDeliveryStatus messageDeliveryStatusGet(id)

Retrieve message delivery status.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

Parameters

Name Type Description Notes
id String

Return type

MessageDeliveryStatus

Authorization

Bearer

HTTP request headers

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

messageDeliveryStatusSearch

MessageDeliveryStatusPaginationResponse messageDeliveryStatusSearch(filter, query, page, perPage, sort)

Search message delivery status.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

MessageDeliveryStatusPaginationResponse

Authorization

Bearer

HTTP request headers

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

messageDeliveryStatusUpdate

MessageDeliveryStatus messageDeliveryStatusUpdate(id, body)

Update a message delivery status.

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

ApiClient defaultClient = Configuration.getDefaultApiClient();


MessageDeliveryStatusApi apiInstance = new MessageDeliveryStatusApi();
String id = "id_example"; // String | 
MessageDeliveryStatusUpdate body = new MessageDeliveryStatusUpdate(); // MessageDeliveryStatusUpdate | 
try {
    MessageDeliveryStatus result = apiInstance.messageDeliveryStatusUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MessageDeliveryStatusApi#messageDeliveryStatusUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body MessageDeliveryStatusUpdate [optional]

Return type

MessageDeliveryStatus

Authorization

Bearer

HTTP request headers

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