Skip to content

Latest commit

 

History

History
445 lines (313 loc) · 14.6 KB

StoreGroupsApi.md

File metadata and controls

445 lines (313 loc) · 14.6 KB

Flipdish\Client\StoreGroupsApi

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

Method HTTP request Description
assignStoresToStoreGroup POST /api/v1.0/{appId}/storegroups/{storeGroupId}/assignStores
createStoreGroup POST /api/v1.0/{appNameId}/storegroups
getStoreGroup GET /api/v1.0/storegroups/{storeGroupId}
getStoreGroups GET /api/v1.0/{appNameId}/storegroups
getStoreGroupsExtended GET /api/v1.0/{appNameId}/storegroups/extended
removeStoreGroup DELETE /api/v1.0/storegroups/{storeGroupId}
setCustomerMessages POST /api/v1.0/storegroups/{storeGroupId}/CustomerMessages
updateStoreGroup POST /api/v1.0/storegroups/{storeGroupId}

assignStoresToStoreGroup

assignStoresToStoreGroup($app_id, $store_group_id, $store_ids)

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\StoreGroupsApi(
    // 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
);
$app_id = "app_id_example"; // string | 
$store_group_id = 56; // int | 
$store_ids = array(new \Flipdish\\Client\Models\int[]()); // int[] | 

try {
    $apiInstance->assignStoresToStoreGroup($app_id, $store_group_id, $store_ids);
} catch (Exception $e) {
    echo 'Exception when calling StoreGroupsApi->assignStoresToStoreGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_id string
store_group_id int
store_ids int[]

Return type

void (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

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

createStoreGroup

\Flipdish\Client\Models\RestApiResultStoreGroup createStoreGroup($app_name_id, $store_group)

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\StoreGroupsApi(
    // 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
);
$app_name_id = "app_name_id_example"; // string | 
$store_group = new \Flipdish\\Client\Models\StoreGroupBase(); // \Flipdish\\Client\Models\StoreGroupBase | 

try {
    $result = $apiInstance->createStoreGroup($app_name_id, $store_group);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreGroupsApi->createStoreGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_name_id string
store_group \Flipdish\Client\Models\StoreGroupBase

Return type

\Flipdish\Client\Models\RestApiResultStoreGroup

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]

getStoreGroup

\Flipdish\Client\Models\RestApiResultStoreGroup getStoreGroup($store_group_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\StoreGroupsApi(
    // 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_group_id = 56; // int | 

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

Parameters

Name Type Description Notes
store_group_id int

Return type

\Flipdish\Client\Models\RestApiResultStoreGroup

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]

getStoreGroups

\Flipdish\Client\Models\RestApiPaginationResultStoreGroup getStoreGroups($app_name_id, $search_query, $page, $limit)

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\StoreGroupsApi(
    // 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
);
$app_name_id = "app_name_id_example"; // string | 
$search_query = "search_query_example"; // string | 
$page = 56; // int | 
$limit = 56; // int | 

try {
    $result = $apiInstance->getStoreGroups($app_name_id, $search_query, $page, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreGroupsApi->getStoreGroups: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_name_id string
search_query string [optional]
page int [optional]
limit int [optional]

Return type

\Flipdish\Client\Models\RestApiPaginationResultStoreGroup

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]

getStoreGroupsExtended

\Flipdish\Client\Models\RestApiPaginationResultStoreGroupExtended getStoreGroupsExtended($app_name_id, $search_query, $page, $limit, $grouping_radius)

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\StoreGroupsApi(
    // 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
);
$app_name_id = "app_name_id_example"; // string | 
$search_query = "search_query_example"; // string | 
$page = 56; // int | 
$limit = 56; // int | 
$grouping_radius = 56; // int | 

try {
    $result = $apiInstance->getStoreGroupsExtended($app_name_id, $search_query, $page, $limit, $grouping_radius);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreGroupsApi->getStoreGroupsExtended: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
app_name_id string
search_query string [optional]
page int [optional]
limit int [optional]
grouping_radius int [optional]

Return type

\Flipdish\Client\Models\RestApiPaginationResultStoreGroupExtended

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]

removeStoreGroup

removeStoreGroup($store_group_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\StoreGroupsApi(
    // 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_group_id = 56; // int | 

try {
    $apiInstance->removeStoreGroup($store_group_id);
} catch (Exception $e) {
    echo 'Exception when calling StoreGroupsApi->removeStoreGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
store_group_id int

Return type

void (empty response body)

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]

setCustomerMessages

setCustomerMessages($store_group_id, $customer_messages)

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\StoreGroupsApi(
    // 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_group_id = 56; // int | 
$customer_messages = new \Flipdish\\Client\Models\CustomerMessages(); // \Flipdish\\Client\Models\CustomerMessages | 

try {
    $apiInstance->setCustomerMessages($store_group_id, $customer_messages);
} catch (Exception $e) {
    echo 'Exception when calling StoreGroupsApi->setCustomerMessages: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
store_group_id int
customer_messages \Flipdish\Client\Models\CustomerMessages

Return type

void (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

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

updateStoreGroup

\Flipdish\Client\Models\RestApiResultStoreGroupBase updateStoreGroup($store_group_id, $store_group)

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\StoreGroupsApi(
    // 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_group_id = 56; // int | 
$store_group = new \Flipdish\\Client\Models\StoreGroupBase(); // \Flipdish\\Client\Models\StoreGroupBase | 

try {
    $result = $apiInstance->updateStoreGroup($store_group_id, $store_group);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StoreGroupsApi->updateStoreGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
store_group_id int
store_group \Flipdish\Client\Models\StoreGroupBase

Return type

\Flipdish\Client\Models\RestApiResultStoreGroupBase

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]