OpenAPI\Client\DynamicVouchersApi

All URIs are relative to https://api.wall.et, except if the operation defines another base path.

Method	HTTP request	Description
archiveDynamicVoucherCampaign()	DELETE /v2/payment/dynamicVoucher/{campaignID}	Archive dynamic voucher campaign
createDynamicVoucher()	POST /v2/payment/dynamicVoucher	Create dynamic voucher
fetchAllDynamicVouchers()	GET /v2/payment/dynamicVoucher/all	Fetch all active dynamic vouchers
fetchDynamicVoucherById()	GET /v2/payment/dynamicVoucher/{id}	Fetch dynamic voucher
fetchDynamicVoucherRedemptions()	GET /v2/payment/dynamicVoucher/redemptions/{id}	Fetch redemptions
fetchReachStatsOfAllDynamicVouchers()	GET /v2/payment/dynamicVoucher/reach/all	Get the reach statistics of all the dynamic vouchers
fetchReachStatsOfIndividualDynamicVoucher()	GET /v2/payment/dynamicVoucher/reach/{dynamicVoucherID}	Get the reach statistics of an individual dynamic voucher
restoreDynamicVoucherCampaign()	PATCH /v2/payment/dynamicVoucher/{campaignID}	Restore dynamic voucher campaign
saveDynamicVoucher()	PUT /v2/payment/dynamicVoucher/{id}	Update dynamic voucher

`archiveDynamicVoucherCampaign()`

archiveDynamicVoucherCampaign($campaign_id): \OpenAPI\Client\Model\DynamicVoucher

Archive dynamic voucher campaign

Example

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



$apiInstance = new OpenAPI\Client\Api\DynamicVouchersApi(
    // 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()
);
$campaign_id = NULL; // mixed

try {
    $result = $apiInstance->archiveDynamicVoucherCampaign($campaign_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DynamicVouchersApi->archiveDynamicVoucherCampaign: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	mixed

Return type

\OpenAPI\Client\Model\DynamicVoucher

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`createDynamicVoucher()`

createDynamicVoucher($wt_dynamic_voucher_create_params): \OpenAPI\Client\Model\WTDynamicVoucher

Create dynamic voucher

Example

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



$apiInstance = new OpenAPI\Client\Api\DynamicVouchersApi(
    // 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()
);
$wt_dynamic_voucher_create_params = new \OpenAPI\Client\Model\WTDynamicVoucherCreateParams(); // \OpenAPI\Client\Model\WTDynamicVoucherCreateParams

try {
    $result = $apiInstance->createDynamicVoucher($wt_dynamic_voucher_create_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DynamicVouchersApi->createDynamicVoucher: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
wt_dynamic_voucher_create_params	\OpenAPI\Client\Model\WTDynamicVoucherCreateParams

Return type

\OpenAPI\Client\Model\WTDynamicVoucher

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

`fetchAllDynamicVouchers()`

fetchAllDynamicVouchers($is_archive_included): \OpenAPI\Client\Model\WTDynamicVoucher[]

Fetch all active dynamic vouchers

Example

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



$apiInstance = new OpenAPI\Client\Api\DynamicVouchersApi(
    // 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()
);
$is_archive_included = True; // bool

try {
    $result = $apiInstance->fetchAllDynamicVouchers($is_archive_included);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DynamicVouchersApi->fetchAllDynamicVouchers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
is_archive_included	bool		[optional]

Return type

\OpenAPI\Client\Model\WTDynamicVoucher[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`fetchDynamicVoucherById()`

fetchDynamicVoucherById($id): \OpenAPI\Client\Model\WTDynamicVoucher

Fetch dynamic voucher

Example

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



$apiInstance = new OpenAPI\Client\Api\DynamicVouchersApi(
    // 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()
);
$id = NULL; // mixed

try {
    $result = $apiInstance->fetchDynamicVoucherById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DynamicVouchersApi->fetchDynamicVoucherById: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	mixed

Return type

\OpenAPI\Client\Model\WTDynamicVoucher

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`fetchDynamicVoucherRedemptions()`

fetchDynamicVoucherRedemptions($id): \OpenAPI\Client\Model\WTDynamicVoucherRedemption[]

Fetch redemptions

Example

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



$apiInstance = new OpenAPI\Client\Api\DynamicVouchersApi(
    // 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()
);
$id = NULL; // mixed

try {
    $result = $apiInstance->fetchDynamicVoucherRedemptions($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DynamicVouchersApi->fetchDynamicVoucherRedemptions: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	mixed

Return type

\OpenAPI\Client\Model\WTDynamicVoucherRedemption[]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`fetchReachStatsOfAllDynamicVouchers()`

fetchReachStatsOfAllDynamicVouchers($broadcast_scheduled_start_at, $broadcast_scheduled_end_at): \OpenAPI\Client\Model\ReachPerformanceStats

Get the reach statistics of all the dynamic vouchers

Example

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



$apiInstance = new OpenAPI\Client\Api\DynamicVouchersApi(
    // 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()
);
$broadcast_scheduled_start_at = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$broadcast_scheduled_end_at = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchReachStatsOfAllDynamicVouchers($broadcast_scheduled_start_at, $broadcast_scheduled_end_at);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DynamicVouchersApi->fetchReachStatsOfAllDynamicVouchers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
broadcast_scheduled_start_at	\DateTime		[optional]
broadcast_scheduled_end_at	\DateTime		[optional]

Return type

\OpenAPI\Client\Model\ReachPerformanceStats

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`fetchReachStatsOfIndividualDynamicVoucher()`

fetchReachStatsOfIndividualDynamicVoucher($dynamic_voucher_id, $broadcast_scheduled_start_at, $broadcast_scheduled_end_at): \OpenAPI\Client\Model\ReachPerformanceStats

Get the reach statistics of an individual dynamic voucher

Example

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



$apiInstance = new OpenAPI\Client\Api\DynamicVouchersApi(
    // 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()
);
$dynamic_voucher_id = NULL; // mixed
$broadcast_scheduled_start_at = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime
$broadcast_scheduled_end_at = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime

try {
    $result = $apiInstance->fetchReachStatsOfIndividualDynamicVoucher($dynamic_voucher_id, $broadcast_scheduled_start_at, $broadcast_scheduled_end_at);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DynamicVouchersApi->fetchReachStatsOfIndividualDynamicVoucher: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
dynamic_voucher_id	mixed
broadcast_scheduled_start_at	\DateTime	[optional]
broadcast_scheduled_end_at	\DateTime	[optional]

Return type

\OpenAPI\Client\Model\ReachPerformanceStats

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`restoreDynamicVoucherCampaign()`

restoreDynamicVoucherCampaign($campaign_id): \OpenAPI\Client\Model\DynamicVoucher

Restore dynamic voucher campaign

Example

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



$apiInstance = new OpenAPI\Client\Api\DynamicVouchersApi(
    // 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()
);
$campaign_id = NULL; // mixed

try {
    $result = $apiInstance->restoreDynamicVoucherCampaign($campaign_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DynamicVouchersApi->restoreDynamicVoucherCampaign: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	mixed

Return type

\OpenAPI\Client\Model\DynamicVoucher

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`saveDynamicVoucher()`

saveDynamicVoucher($id, $wt_dynamic_voucher_update_params): \OpenAPI\Client\Model\WTDynamicVoucher

Update dynamic voucher

Example

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



$apiInstance = new OpenAPI\Client\Api\DynamicVouchersApi(
    // 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()
);
$id = NULL; // mixed
$wt_dynamic_voucher_update_params = new \OpenAPI\Client\Model\WTDynamicVoucherUpdateParams(); // \OpenAPI\Client\Model\WTDynamicVoucherUpdateParams

try {
    $result = $apiInstance->saveDynamicVoucher($id, $wt_dynamic_voucher_update_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DynamicVouchersApi->saveDynamicVoucher: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	mixed
wt_dynamic_voucher_update_params	\OpenAPI\Client\Model\WTDynamicVoucherUpdateParams

Return type

\OpenAPI\Client\Model\WTDynamicVoucher

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

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

Files

DynamicVouchersApi.md

Latest commit

History

DynamicVouchersApi.md

File metadata and controls

OpenAPI\Client\DynamicVouchersApi

archiveDynamicVoucherCampaign()

Example

Parameters

Return type

Authorization

HTTP request headers

createDynamicVoucher()

Example

Parameters

Return type

Authorization

HTTP request headers

fetchAllDynamicVouchers()

Example

Parameters

Return type

Authorization

HTTP request headers

fetchDynamicVoucherById()

Example

Parameters

Return type

Authorization

HTTP request headers

fetchDynamicVoucherRedemptions()

Example

Parameters

Return type

Authorization

HTTP request headers

fetchReachStatsOfAllDynamicVouchers()

Example

Parameters

Return type

Authorization

HTTP request headers

fetchReachStatsOfIndividualDynamicVoucher()

Example

Parameters

Return type

Authorization

HTTP request headers

restoreDynamicVoucherCampaign()

Example

Parameters

Return type

Authorization

HTTP request headers

saveDynamicVoucher()

Example

Parameters

Return type

Authorization

HTTP request headers

`archiveDynamicVoucherCampaign()`

`createDynamicVoucher()`

`fetchAllDynamicVouchers()`

`fetchDynamicVoucherById()`

`fetchDynamicVoucherRedemptions()`

`fetchReachStatsOfAllDynamicVouchers()`

`fetchReachStatsOfIndividualDynamicVoucher()`

`restoreDynamicVoucherCampaign()`

`saveDynamicVoucher()`