Flipdish\Client\RestaurantVouchersPayGreenApi

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

Method	HTTP request	Description
createPayGreenConfiguration	POST /api/v1.0/{appId}/restaurant-vouchers/paygreen
deletePayGreenConfiguration	DELETE /api/v1.0/{appId}/restaurant-vouchers/paygreen/{paygreenConfigurationId}
getElegibleStores	GET /api/v1.0/{appId}/restaurant-vouchers/paygreen/stores
getPayGreenConfigurations	GET /api/v1.0/{appId}/restaurant-vouchers/paygreen
getStoreAvailablePayGreenConfigurations	GET /api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}/available-configurations
getStorePayGreenConfiguration_	GET /api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}
listPayGreenConfigurations	GET /api/v1.0/{appId}/restaurant-vouchers/paygreen/{paygreenConfigurationId}
updatePayGreenConfiguration	POST /api/v1.0/{appId}/restaurant-vouchers/paygreen/{paygreenConfigurationId}
updateStorePayGreenConfiguration_	POST /api/v1.0/{appId}/restaurant-vouchers/paygreen/stores/{storeId}

createPayGreenConfiguration

\Flipdish\Client\Models\RestApiResultRestaurantVoucherPayGreenConfiguration createPayGreenConfiguration($app_id, $request)

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\RestaurantVouchersPayGreenApi(
    // 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 | 
$request = new \Flipdish\\Client\Models\CreatePayGreenConfigurationRequest(); // \Flipdish\\Client\Models\CreatePayGreenConfigurationRequest | 

try {
    $result = $apiInstance->createPayGreenConfiguration($app_id, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RestaurantVouchersPayGreenApi->createPayGreenConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	string
request	\Flipdish\Client\Models\CreatePayGreenConfigurationRequest

Return type

\Flipdish\Client\Models\RestApiResultRestaurantVoucherPayGreenConfiguration

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]

deletePayGreenConfiguration

object deletePayGreenConfiguration($app_id, $paygreen_configuration_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\RestaurantVouchersPayGreenApi(
    // 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 | 
$paygreen_configuration_id = 56; // int | 

try {
    $result = $apiInstance->deletePayGreenConfiguration($app_id, $paygreen_configuration_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RestaurantVouchersPayGreenApi->deletePayGreenConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	string
paygreen_configuration_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]

getElegibleStores

\Flipdish\Client\Models\RestApiArrayResultRestaurantVoucherEligibleStore getElegibleStores($app_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\RestaurantVouchersPayGreenApi(
    // 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 | 

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

Parameters

Name	Type	Description	Notes
app_id	string

Return type

\Flipdish\Client\Models\RestApiArrayResultRestaurantVoucherEligibleStore

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]

getPayGreenConfigurations

\Flipdish\Client\Models\RestApiArrayResultRestaurantVoucherPayGreenConfiguration getPayGreenConfigurations($app_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\RestaurantVouchersPayGreenApi(
    // 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 | 

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

Parameters

Name	Type	Description	Notes
app_id	string

Return type

\Flipdish\Client\Models\RestApiArrayResultRestaurantVoucherPayGreenConfiguration

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]

getStoreAvailablePayGreenConfigurations

\Flipdish\Client\Models\RestApiArrayResultRestaurantVoucherPayGreenConfigurationSummary getStoreAvailablePayGreenConfigurations($app_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\RestaurantVouchersPayGreenApi(
    // 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_id = 56; // int | 

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

Parameters

Name	Type	Description	Notes
app_id	string
store_id	int

Return type

\Flipdish\Client\Models\RestApiArrayResultRestaurantVoucherPayGreenConfigurationSummary

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]

getStorePayGreenConfiguration_

\Flipdish\Client\Models\RestApiResultRestaurantVoucherPayGreenStoreConfiguration getStorePayGreenConfiguration_($app_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\RestaurantVouchersPayGreenApi(
    // 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_id = 56; // int | 

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

Parameters

Name	Type	Description	Notes
app_id	string
store_id	int

Return type

\Flipdish\Client\Models\RestApiResultRestaurantVoucherPayGreenStoreConfiguration

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]

listPayGreenConfigurations

\Flipdish\Client\Models\RestApiResultRestaurantVoucherPayGreenConfiguration listPayGreenConfigurations($app_id, $paygreen_configuration_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\RestaurantVouchersPayGreenApi(
    // 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 | 
$paygreen_configuration_id = 56; // int | 

try {
    $result = $apiInstance->listPayGreenConfigurations($app_id, $paygreen_configuration_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RestaurantVouchersPayGreenApi->listPayGreenConfigurations: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	string
paygreen_configuration_id	int

Return type

\Flipdish\Client\Models\RestApiResultRestaurantVoucherPayGreenConfiguration

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]

updatePayGreenConfiguration

\Flipdish\Client\Models\RestApiResultRestaurantVoucherPayGreenConfiguration updatePayGreenConfiguration($app_id, $paygreen_configuration_id, $request)

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\RestaurantVouchersPayGreenApi(
    // 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 | 
$paygreen_configuration_id = 56; // int | 
$request = new \Flipdish\\Client\Models\UpdatePayGreenConfigurationRequest(); // \Flipdish\\Client\Models\UpdatePayGreenConfigurationRequest | 

try {
    $result = $apiInstance->updatePayGreenConfiguration($app_id, $paygreen_configuration_id, $request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RestaurantVouchersPayGreenApi->updatePayGreenConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
app_id	string
paygreen_configuration_id	int
request	\Flipdish\Client\Models\UpdatePayGreenConfigurationRequest

Return type

\Flipdish\Client\Models\RestApiResultRestaurantVoucherPayGreenConfiguration

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]

updateStorePayGreenConfiguration_

\Flipdish\Client\Models\RestApiResultRestaurantVoucherPayGreenStoreConfiguration updateStorePayGreenConfiguration_($app_id, $store_id, $request)

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\RestaurantVouchersPayGreenApi(
    // 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_id = 56; // int | 
$request = new \Flipdish\\Client\Models\UpdateStorePayGreenConfigurationRequest(); // \Flipdish\\Client\Models\UpdateStorePayGreenConfigurationRequest | 

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

Parameters

Name	Type	Description	Notes
app_id	string
store_id	int
request	\Flipdish\Client\Models\UpdateStorePayGreenConfigurationRequest

Return type

\Flipdish\Client\Models\RestApiResultRestaurantVoucherPayGreenStoreConfiguration

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]

FilesExpand file tree

RestaurantVouchersPayGreenApi.md

Latest commit

History

RestaurantVouchersPayGreenApi.md

File metadata and controls

Flipdish\Client\RestaurantVouchersPayGreenApi

createPayGreenConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

deletePayGreenConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

getElegibleStores

Example

Parameters

Return type

Authorization

HTTP request headers

getPayGreenConfigurations

Example

Parameters

Return type

Authorization

HTTP request headers

getStoreAvailablePayGreenConfigurations

Example

Parameters

Return type

Authorization

HTTP request headers

getStorePayGreenConfiguration_

Example

Parameters

Return type

Authorization

HTTP request headers

listPayGreenConfigurations

Example

Parameters

Return type

Authorization

HTTP request headers

updatePayGreenConfiguration

Example

Parameters

Return type

Authorization

HTTP request headers

updateStorePayGreenConfiguration_

Example

Parameters

Return type

Authorization

HTTP request headers