Skip to content

Latest commit

 

History

History
222 lines (158 loc) · 6.08 KB

StuartApi.md

File metadata and controls

222 lines (158 loc) · 6.08 KB

StuartApi

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

Method HTTP request Description
stuartCancelJob DELETE /api/v1.0/stuart/jobs/{jobId}
stuartGetJob GET /api/v1.0/stuart/jobs/{jobId}
stuartGetStuartSettings GET /api/v1.0/stuart/settings/{storeId}
stuartPostStuartSettings POST /api/v1.0/stuart/settings/{storeId}

stuartCancelJob

Object stuartCancelJob(jobId, storeId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StuartApi apiInstance = new StuartApi();
Integer jobId = 56; // Integer | 
Integer storeId = 56; // Integer | 
try {
    Object result = apiInstance.stuartCancelJob(jobId, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StuartApi#stuartCancelJob");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
jobId Integer
storeId Integer

Return type

Object

Authorization

oauth2

HTTP request headers

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

stuartGetJob

RestApiResultJobResponse stuartGetJob(jobId, storeId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StuartApi apiInstance = new StuartApi();
Integer jobId = 56; // Integer | 
Integer storeId = 56; // Integer | 
try {
    RestApiResultJobResponse result = apiInstance.stuartGetJob(jobId, storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StuartApi#stuartGetJob");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
jobId Integer
storeId Integer

Return type

RestApiResultJobResponse

Authorization

oauth2

HTTP request headers

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

stuartGetStuartSettings

RestApiResultStuartSettings stuartGetStuartSettings(storeId)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StuartApi apiInstance = new StuartApi();
Integer storeId = 56; // Integer | 
try {
    RestApiResultStuartSettings result = apiInstance.stuartGetStuartSettings(storeId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StuartApi#stuartGetStuartSettings");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
storeId Integer

Return type

RestApiResultStuartSettings

Authorization

oauth2

HTTP request headers

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

stuartPostStuartSettings

Object stuartPostStuartSettings(storeId, stuartSettings)

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

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

StuartApi apiInstance = new StuartApi();
Integer storeId = 56; // Integer | 
StuartSettings stuartSettings = new StuartSettings(); // StuartSettings | 
try {
    Object result = apiInstance.stuartPostStuartSettings(storeId, stuartSettings);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling StuartApi#stuartPostStuartSettings");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
storeId Integer
stuartSettings StuartSettings

Return type

Object

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