Skip to content

Latest commit

 

History

History
345 lines (234 loc) · 10.1 KB

StaticVouchersApi.md

File metadata and controls

345 lines (234 loc) · 10.1 KB
Raw

OpenAPI\Client\StaticVouchersApi

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

Method HTTP request Description
createStaticVoucher() POST /v2/payment/staticVoucher Create static voucher
deleteStaticVoucher() DELETE /v2/payment/staticVoucher/{id} Delete static voucher
fetchReachStatsOfAllStaticVouchers() GET /v2/payment/staticVoucher/reach/all Get the reach statistics of all the static vouchers
fetchReachStatsOfIndividualStaticVoucher() GET /v2/payment/staticVoucher/reach/{staticVoucherID} Get the reach statistics of an individual static voucher
fetchStaticVoucher() GET /v2/payment/staticVoucher/{id} Fetch static voucher
updateStaticVoucher() PUT /v2/payment/staticVoucher/{id} Update static voucher

createStaticVoucher()

createStaticVoucher($wt_static_voucher_create_params): \OpenAPI\Client\Model\WTStaticVoucher

Create static voucher

Example

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



$apiInstance = new OpenAPI\Client\Api\StaticVouchersApi(
    // 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_static_voucher_create_params = new \OpenAPI\Client\Model\WTStaticVoucherCreateParams(); // \OpenAPI\Client\Model\WTStaticVoucherCreateParams

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

Parameters

Name Type Description Notes
wt_static_voucher_create_params \OpenAPI\Client\Model\WTStaticVoucherCreateParams

Return type

\OpenAPI\Client\Model\WTStaticVoucher

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]

deleteStaticVoucher()

deleteStaticVoucher($id): bool

Delete static voucher

Example

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



$apiInstance = new OpenAPI\Client\Api\StaticVouchersApi(
    // 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->deleteStaticVoucher($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StaticVouchersApi->deleteStaticVoucher: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id mixed

Return type

bool

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]

fetchReachStatsOfAllStaticVouchers()

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

Get the reach statistics of all the static vouchers

Example

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



$apiInstance = new OpenAPI\Client\Api\StaticVouchersApi(
    // 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->fetchReachStatsOfAllStaticVouchers($broadcast_scheduled_start_at, $broadcast_scheduled_end_at);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StaticVouchersApi->fetchReachStatsOfAllStaticVouchers: ', $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]

fetchReachStatsOfIndividualStaticVoucher()

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

Get the reach statistics of an individual static voucher

Example

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



$apiInstance = new OpenAPI\Client\Api\StaticVouchersApi(
    // 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()
);
$static_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->fetchReachStatsOfIndividualStaticVoucher($static_voucher_id, $broadcast_scheduled_start_at, $broadcast_scheduled_end_at);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StaticVouchersApi->fetchReachStatsOfIndividualStaticVoucher: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
static_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]

fetchStaticVoucher()

fetchStaticVoucher($id): \OpenAPI\Client\Model\WTStaticVoucher

Fetch static voucher

Example

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



$apiInstance = new OpenAPI\Client\Api\StaticVouchersApi(
    // 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->fetchStaticVoucher($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling StaticVouchersApi->fetchStaticVoucher: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\WTStaticVoucher

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]

updateStaticVoucher()

updateStaticVoucher($id, $wt_static_voucher_update_params): \OpenAPI\Client\Model\WTStaticVoucher

Update static voucher

Example

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



$apiInstance = new OpenAPI\Client\Api\StaticVouchersApi(
    // 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_static_voucher_update_params = new \OpenAPI\Client\Model\WTStaticVoucherUpdateParams(); // \OpenAPI\Client\Model\WTStaticVoucherUpdateParams

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

Parameters

Name Type Description Notes
id mixed
wt_static_voucher_update_params \OpenAPI\Client\Model\WTStaticVoucherUpdateParams

Return type

\OpenAPI\Client\Model\WTStaticVoucher

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]