Skip to content

Latest commit

 

History

History
1182 lines (801 loc) · 36.3 KB

StaticVoucherCampaignsApi.md

File metadata and controls

1182 lines (801 loc) · 36.3 KB

OpenAPI\Client\StaticVoucherCampaignsApi

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

Method HTTP request Description
archiveStaticVoucherCampaign() DELETE /v2/payment/staticVoucherCampaign/{campaignID} Archive static voucher campaign
countVouchersLoaded() GET /v2/payment/staticVoucherCampaign/count/vouchers/loaded/{campaignID} Count loaded vouchers
countVouchersRedeemed() GET /v2/payment/staticVoucherCampaign/count/vouchers/redeemed/{campaignID} Count redeemed vouchers
createStaticVoucherCampaign() POST /v2/payment/staticVoucherCampaign Create static voucher campaign
createStaticVoucherCampaignFromCSV() POST /v2/payment/staticVoucherCampaign/csv Import static voucher campaign
createStaticVoucherCampaignWithVoucher() POST /v2/payment/staticVoucherCampaign/voucher Create static voucher campaign with voucher
duplicateStaticVoucherCampaignById() POST /v2/payment/staticVoucherCampaign/duplicate/{campaignID} Duplicate static voucher campaign
fetchPerformanceOverview() GET /v2/payment/staticVoucherCampaign/overview/performance/{campaignID} Fetch performance overview
fetchReachStatsOfAllStaticVoucherCampaigns() GET /v2/payment/staticVoucherCampaign/reach/all Get the reach statistics of all the static voucher campaigns
fetchReachStatsOfIndividualStaticVoucherCampaign() GET /v2/payment/staticVoucherCampaign/reach/{staticVoucherCampaignID} Get the reach statistics of an individual static voucher campaign
fetchStaticVoucherCampaignById() GET /v2/payment/staticVoucherCampaign/{id} Fetch static voucher campaign
fetchStaticVoucherCampaigns() GET /v2/payment/staticVoucherCampaign/all Fetches all static vouchers campaigns
fetchStaticVouchers() GET /v2/payment/staticVoucherCampaign/staticVouchers/{campaignID} Fetch static vouchers
fetchStaticVouchersPage() GET /v2/payment/staticVoucherCampaign/staticVouchers/page/{campaignID} Fetch static vouchers by page
fetchViews() GET /v2/payment/staticVoucherCampaign/views/{campaignID} Fetch views
fetchVouchersRedeemed() GET /v2/payment/staticVoucherCampaign/vouchers/redeemed/{campaignID} Fetch redeemed vouchers
previewMessages() PUT /v2/payment/staticVoucherCampaign/preview/{campaignID} Preview static vouchers. This method has been deprecated. Please use /preview/page/{campaignID} for better performance.
previewMessagesByPage() PUT /v2/payment/staticVoucherCampaign/preview/page/{campaignID} Preview static vouchers by page
restoreStaticVoucherCampaign() PATCH /v2/payment/staticVoucherCampaign/{campaignID} Restore static voucher campaign
updateStaticVoucherCampaign() PUT /v2/payment/staticVoucherCampaign/{campaignID} Update static voucher campaign
updateStaticVoucherCampaignWithVoucher() PUT /v2/payment/staticVoucherCampaign/voucher/{campaignID} Update static voucher campaign with voucher

archiveStaticVoucherCampaign()

archiveStaticVoucherCampaign($campaign_id): \OpenAPI\Client\Model\StaticVoucherCampaign

Archive static voucher campaign

Example

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



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

Parameters

Name Type Description Notes
campaign_id mixed

Return type

\OpenAPI\Client\Model\StaticVoucherCampaign

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]

countVouchersLoaded()

countVouchersLoaded($campaign_id): \OpenAPI\Client\Model\FetchMembersCount200Response

Count loaded vouchers

Example

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



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

Parameters

Name Type Description Notes
campaign_id mixed

Return type

\OpenAPI\Client\Model\FetchMembersCount200Response

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]

countVouchersRedeemed()

countVouchersRedeemed($campaign_id): \OpenAPI\Client\Model\FetchMembersCount200Response

Count redeemed vouchers

Example

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



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

Parameters

Name Type Description Notes
campaign_id mixed

Return type

\OpenAPI\Client\Model\FetchMembersCount200Response

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]

createStaticVoucherCampaign()

createStaticVoucherCampaign($create_static_voucher_campaign): \OpenAPI\Client\Model\WTStaticVoucherCampaign

Create static voucher campaign

Example

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



$apiInstance = new OpenAPI\Client\Api\StaticVoucherCampaignsApi(
    // 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()
);
$create_static_voucher_campaign = new \OpenAPI\Client\Model\CreateStaticVoucherCampaign(); // \OpenAPI\Client\Model\CreateStaticVoucherCampaign

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

Parameters

Name Type Description Notes
create_static_voucher_campaign \OpenAPI\Client\Model\CreateStaticVoucherCampaign

Return type

\OpenAPI\Client\Model\WTStaticVoucherCampaign

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]

createStaticVoucherCampaignFromCSV()

createStaticVoucherCampaignFromCSV($create_static_voucher_campaign_with_voucher_with_csv): \OpenAPI\Client\Model\WTStaticVoucherCampaign

Import static voucher campaign

Example

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



$apiInstance = new OpenAPI\Client\Api\StaticVoucherCampaignsApi(
    // 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()
);
$create_static_voucher_campaign_with_voucher_with_csv = new \OpenAPI\Client\Model\CreateStaticVoucherCampaignWithVoucherWithCSV(); // \OpenAPI\Client\Model\CreateStaticVoucherCampaignWithVoucherWithCSV

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

Parameters

Name Type Description Notes
create_static_voucher_campaign_with_voucher_with_csv \OpenAPI\Client\Model\CreateStaticVoucherCampaignWithVoucherWithCSV

Return type

\OpenAPI\Client\Model\WTStaticVoucherCampaign

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]

createStaticVoucherCampaignWithVoucher()

createStaticVoucherCampaignWithVoucher($body): \OpenAPI\Client\Model\WTStaticVoucherCampaign

Create static voucher campaign with voucher

Example

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



$apiInstance = new OpenAPI\Client\Api\StaticVoucherCampaignsApi(
    // 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()
);
$body = new \OpenAPI\Client\Model\PickCreateStaticVoucherCampaignWithVoucherExcludeKeyofcreateStaticVoucherCampaignWithVoucherIsActive(); // \OpenAPI\Client\Model\PickCreateStaticVoucherCampaignWithVoucherExcludeKeyofcreateStaticVoucherCampaignWithVoucherIsActive

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

Parameters

Name Type Description Notes
body \OpenAPI\Client\Model\PickCreateStaticVoucherCampaignWithVoucherExcludeKeyofcreateStaticVoucherCampaignWithVoucherIsActive

Return type

\OpenAPI\Client\Model\WTStaticVoucherCampaign

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]

duplicateStaticVoucherCampaignById()

duplicateStaticVoucherCampaignById($campaign_id): \OpenAPI\Client\Model\WTStaticVoucherCampaign

Duplicate static voucher campaign

Example

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



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

Parameters

Name Type Description Notes
campaign_id mixed

Return type

\OpenAPI\Client\Model\WTStaticVoucherCampaign

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]

fetchPerformanceOverview()

fetchPerformanceOverview($campaign_id): object

Fetch performance overview

Example

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



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

Parameters

Name Type Description Notes
campaign_id mixed

Return type

object

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]

fetchReachStatsOfAllStaticVoucherCampaigns()

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

Get the reach statistics of all the static voucher campaigns

Example

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



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

fetchReachStatsOfIndividualStaticVoucherCampaign()

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

Get the reach statistics of an individual static voucher campaign

Example

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



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

Parameters

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

fetchStaticVoucherCampaignById()

fetchStaticVoucherCampaignById($id): \OpenAPI\Client\Model\WTStaticVoucherCampaign

Fetch static voucher campaign

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\WTStaticVoucherCampaign

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]

fetchStaticVoucherCampaigns()

fetchStaticVoucherCampaigns($is_archive_included, $source_id): \OpenAPI\Client\Model\WTStaticVoucherCampaign[]

Fetches all static vouchers campaigns

Example

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



$apiInstance = new OpenAPI\Client\Api\StaticVoucherCampaignsApi(
    // 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
$source_id = 3.4; // float

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

Parameters

Name Type Description Notes
is_archive_included bool [optional]
source_id float [optional]

Return type

\OpenAPI\Client\Model\WTStaticVoucherCampaign[]

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]

fetchStaticVouchers()

fetchStaticVouchers($campaign_id): \OpenAPI\Client\Model\WTStaticVoucher[]

Fetch static vouchers

Example

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



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

Parameters

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

fetchStaticVouchersPage()

fetchStaticVouchersPage($campaign_id, $pagenum, $pagesize): \OpenAPI\Client\Model\FetchStaticVouchersPage200Response

Fetch static vouchers by page

Example

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



$apiInstance = new OpenAPI\Client\Api\StaticVoucherCampaignsApi(
    // 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
$pagenum = 3.4; // float
$pagesize = 3.4; // float

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

Parameters

Name Type Description Notes
campaign_id mixed
pagenum float
pagesize float

Return type

\OpenAPI\Client\Model\FetchStaticVouchersPage200Response

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]

fetchViews()

fetchViews($campaign_id): \OpenAPI\Client\Model\WTWalletPageView[]

Fetch views

Example

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



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

Parameters

Name Type Description Notes
campaign_id mixed

Return type

\OpenAPI\Client\Model\WTWalletPageView[]

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]

fetchVouchersRedeemed()

fetchVouchersRedeemed($campaign_id): \OpenAPI\Client\Model\WTStaticVoucher[]

Fetch redeemed vouchers

Example

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



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

Parameters

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

previewMessages()

previewMessages($campaign_id, $wt_static_voucher_campaign_preview_messages): \OpenAPI\Client\Model\VSCampaignGeneratedMessage[]

Preview static vouchers. This method has been deprecated. Please use /preview/page/{campaignID} for better performance.

Example

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



$apiInstance = new OpenAPI\Client\Api\StaticVoucherCampaignsApi(
    // 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
$wt_static_voucher_campaign_preview_messages = new \OpenAPI\Client\Model\WTStaticVoucherCampaignPreviewMessages(); // \OpenAPI\Client\Model\WTStaticVoucherCampaignPreviewMessages

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

Parameters

Name Type Description Notes
campaign_id mixed
wt_static_voucher_campaign_preview_messages \OpenAPI\Client\Model\WTStaticVoucherCampaignPreviewMessages

Return type

\OpenAPI\Client\Model\VSCampaignGeneratedMessage[]

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]

previewMessagesByPage()

previewMessagesByPage($campaign_id, $wt_static_voucher_campaign_preview_messages_by_page): \OpenAPI\Client\Model\VSCampaignGeneratedMessagePagination

Preview static vouchers by page

Example

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



$apiInstance = new OpenAPI\Client\Api\StaticVoucherCampaignsApi(
    // 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
$wt_static_voucher_campaign_preview_messages_by_page = new \OpenAPI\Client\Model\WTStaticVoucherCampaignPreviewMessagesByPage(); // \OpenAPI\Client\Model\WTStaticVoucherCampaignPreviewMessagesByPage

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

Parameters

Name Type Description Notes
campaign_id mixed
wt_static_voucher_campaign_preview_messages_by_page \OpenAPI\Client\Model\WTStaticVoucherCampaignPreviewMessagesByPage

Return type

\OpenAPI\Client\Model\VSCampaignGeneratedMessagePagination

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]

restoreStaticVoucherCampaign()

restoreStaticVoucherCampaign($campaign_id): \OpenAPI\Client\Model\StaticVoucherCampaign

Restore static voucher campaign

Example

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



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

Parameters

Name Type Description Notes
campaign_id mixed

Return type

\OpenAPI\Client\Model\StaticVoucherCampaign

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]

updateStaticVoucherCampaign()

updateStaticVoucherCampaign($campaign_id, $static_voucher_campaign_update): \OpenAPI\Client\Model\WTStaticVoucherCampaign

Update static voucher campaign

Example

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



$apiInstance = new OpenAPI\Client\Api\StaticVoucherCampaignsApi(
    // 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
$static_voucher_campaign_update = new \OpenAPI\Client\Model\StaticVoucherCampaignUpdate(); // \OpenAPI\Client\Model\StaticVoucherCampaignUpdate

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

Parameters

Name Type Description Notes
campaign_id mixed
static_voucher_campaign_update \OpenAPI\Client\Model\StaticVoucherCampaignUpdate

Return type

\OpenAPI\Client\Model\WTStaticVoucherCampaign

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]

updateStaticVoucherCampaignWithVoucher()

updateStaticVoucherCampaignWithVoucher($campaign_id, $update_static_voucher_campaign_with_voucher): \OpenAPI\Client\Model\WTStaticVoucherCampaign

Update static voucher campaign with voucher

Example

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



$apiInstance = new OpenAPI\Client\Api\StaticVoucherCampaignsApi(
    // 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
$update_static_voucher_campaign_with_voucher = new \OpenAPI\Client\Model\UpdateStaticVoucherCampaignWithVoucher(); // \OpenAPI\Client\Model\UpdateStaticVoucherCampaignWithVoucher

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

Parameters

Name Type Description Notes
campaign_id mixed
update_static_voucher_campaign_with_voucher \OpenAPI\Client\Model\UpdateStaticVoucherCampaignWithVoucher

Return type

\OpenAPI\Client\Model\WTStaticVoucherCampaign

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]