Skip to content

Latest commit

 

History

History
329 lines (235 loc) · 11.4 KB

FulfillmentStateConfigurationApi.md

File metadata and controls

329 lines (235 loc) · 11.4 KB

FulfillmentStateConfigurationApi

All URIs are relative to https://api.flipdish.co

Method HTTP request Description
createFulfillmentStatesConfig POST /api/v1.0/{appId}/fulfillment/configuration/states
deleteFulfillmentStatesConfig DELETE /api/v1.0/{appId}/fulfillment/configuration/states/{configId}
getFulfillmentStatesConfiguration GET /api/v1.0/{appId}/fulfillment/configuration/states/{configId}
getFulfillmentStatesConfigurationTemplate GET /api/v1.0/{appId}/fulfillment/configuration/states_template
searchFulfillmentStatesConfigurations GET /api/v1.0/{appId}/fulfillment/configuration/states
updateFulfillmentStatesConfig POST /api/v1.0/{appId}/fulfillment/configuration/states/{configId}

createFulfillmentStatesConfig

RestApiResultFulfillmentStatesConfiguration createFulfillmentStatesConfig(appId, fulfillmentStateConfiguration)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.FulfillmentStateConfigurationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

FulfillmentStateConfigurationApi apiInstance = new FulfillmentStateConfigurationApi();
String appId = "appId_example"; // String | 
CreateFulfillmentStatesConfiguration fulfillmentStateConfiguration = new CreateFulfillmentStatesConfiguration(); // CreateFulfillmentStatesConfiguration | 
try {
    RestApiResultFulfillmentStatesConfiguration result = apiInstance.createFulfillmentStatesConfig(appId, fulfillmentStateConfiguration);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FulfillmentStateConfigurationApi#createFulfillmentStatesConfig");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
fulfillmentStateConfiguration CreateFulfillmentStatesConfiguration

Return type

RestApiResultFulfillmentStatesConfiguration

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

deleteFulfillmentStatesConfig

RestApiStringResult deleteFulfillmentStatesConfig(appId, configId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.FulfillmentStateConfigurationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

FulfillmentStateConfigurationApi apiInstance = new FulfillmentStateConfigurationApi();
String appId = "appId_example"; // String | 
String configId = "configId_example"; // String | 
try {
    RestApiStringResult result = apiInstance.deleteFulfillmentStatesConfig(appId, configId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FulfillmentStateConfigurationApi#deleteFulfillmentStatesConfig");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
configId String

Return type

RestApiStringResult

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getFulfillmentStatesConfiguration

FulfillmentStatesConfiguration getFulfillmentStatesConfiguration(appId, configId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.FulfillmentStateConfigurationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

FulfillmentStateConfigurationApi apiInstance = new FulfillmentStateConfigurationApi();
String appId = "appId_example"; // String | 
String configId = "configId_example"; // String | 
try {
    FulfillmentStatesConfiguration result = apiInstance.getFulfillmentStatesConfiguration(appId, configId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FulfillmentStateConfigurationApi#getFulfillmentStatesConfiguration");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
configId String

Return type

FulfillmentStatesConfiguration

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

getFulfillmentStatesConfigurationTemplate

FulfillmentStatesConfiguration getFulfillmentStatesConfigurationTemplate(appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.FulfillmentStateConfigurationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

FulfillmentStateConfigurationApi apiInstance = new FulfillmentStateConfigurationApi();
String appId = "appId_example"; // String | 
try {
    FulfillmentStatesConfiguration result = apiInstance.getFulfillmentStatesConfigurationTemplate(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FulfillmentStateConfigurationApi#getFulfillmentStatesConfigurationTemplate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String

Return type

FulfillmentStatesConfiguration

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

searchFulfillmentStatesConfigurations

RestApiArrayResultFulfillmentStatesConfigurationSummary searchFulfillmentStatesConfigurations(appId)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.FulfillmentStateConfigurationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

FulfillmentStateConfigurationApi apiInstance = new FulfillmentStateConfigurationApi();
String appId = "appId_example"; // String | 
try {
    RestApiArrayResultFulfillmentStatesConfigurationSummary result = apiInstance.searchFulfillmentStatesConfigurations(appId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling FulfillmentStateConfigurationApi#searchFulfillmentStatesConfigurations");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String

Return type

RestApiArrayResultFulfillmentStatesConfigurationSummary

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

updateFulfillmentStatesConfig

updateFulfillmentStatesConfig(appId, configId, updateFulfillmentStatesConfiguration)

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.FulfillmentStateConfigurationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

FulfillmentStateConfigurationApi apiInstance = new FulfillmentStateConfigurationApi();
String appId = "appId_example"; // String | 
String configId = "configId_example"; // String | 
UpdateFulfillmentStatesConfiguration updateFulfillmentStatesConfiguration = new UpdateFulfillmentStatesConfiguration(); // UpdateFulfillmentStatesConfiguration | 
try {
    apiInstance.updateFulfillmentStatesConfig(appId, configId, updateFulfillmentStatesConfiguration);
} catch (ApiException e) {
    System.err.println("Exception when calling FulfillmentStateConfigurationApi#updateFulfillmentStatesConfig");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
appId String
configId String
updateFulfillmentStatesConfiguration UpdateFulfillmentStatesConfiguration

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml