Skip to content

StuartApi.md

Latest commit

 

History

History
222 lines (154 loc) · 6.63 KB

StuartApi.md

File metadata and controls

222 lines (154 loc) · 6.63 KB

Flipdish\Client\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($job_id, $store_id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\StuartApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$job_id = 56; // int | 
$store_id = 56; // int | 

try {
    $result = $apiInstance->stuartCancelJob($job_id, $store_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StuartApi->stuartCancelJob: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
job_id int
store_id int

Return type

object

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

stuartGetJob

\Flipdish\Client\Models\RestApiResultJobResponse stuartGetJob($job_id, $store_id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\StuartApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$job_id = 56; // int | 
$store_id = 56; // int | 

try {
    $result = $apiInstance->stuartGetJob($job_id, $store_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StuartApi->stuartGetJob: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
job_id int
store_id int

Return type

\Flipdish\Client\Models\RestApiResultJobResponse

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

stuartGetStuartSettings

\Flipdish\Client\Models\RestApiResultStuartSettings stuartGetStuartSettings($store_id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\StuartApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$store_id = 56; // int | 

try {
    $result = $apiInstance->stuartGetStuartSettings($store_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StuartApi->stuartGetStuartSettings: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
store_id int

Return type

\Flipdish\Client\Models\RestApiResultStuartSettings

Authorization

oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

stuartPostStuartSettings

object stuartPostStuartSettings($store_id, $stuart_settings)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: oauth2
$config = Flipdish\\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Flipdish\\Client\Api\StuartApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$store_id = 56; // int | 
$stuart_settings = new \Flipdish\\Client\Models\StuartSettings(); // \Flipdish\\Client\Models\StuartSettings | 

try {
    $result = $apiInstance->stuartPostStuartSettings($store_id, $stuart_settings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StuartApi->stuartPostStuartSettings: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
store_id int
stuart_settings \Flipdish\Client\Models\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

[Back to top] [Back to API list] [Back to Model list] [Back to README]