Skip to content

Latest commit

 

History

History
168 lines (117 loc) · 4.36 KB

VendorMessagesApi.md

File metadata and controls

168 lines (117 loc) · 4.36 KB

VendorMessagesApi

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

Method HTTP request Description
vendorMessageCreate POST /v4/api/vendor-message
vendorMessageGet GET /v4/api/vendor-message/{id}
vendorMessageSearch GET /v4/api/vendor-message

vendorMessageCreate

VendorMessage vendorMessageCreate(body)

Create a 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.VendorMessagesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


VendorMessagesApi apiInstance = new VendorMessagesApi();
VendorMessageCreate body = new VendorMessageCreate(); // VendorMessageCreate | 
try {
    VendorMessage result = apiInstance.vendorMessageCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling VendorMessagesApi#vendorMessageCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body VendorMessageCreate [optional]

Return type

VendorMessage

Authorization

Bearer

HTTP request headers

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

vendorMessageGet

VendorMessage vendorMessageGet(id)

Retrieve a 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.VendorMessagesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

Parameters

Name Type Description Notes
id String

Return type

VendorMessage

Authorization

Bearer

HTTP request headers

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

vendorMessageSearch

VendorMessagePaginationResponse vendorMessageSearch(filter, query, page, perPage, sort)

Search vendor 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.VendorMessagesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

VendorMessagePaginationResponse

Authorization

Bearer

HTTP request headers

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