Skip to content

Latest commit

 

History

History
394 lines (265 loc) · 11.1 KB

AdvertisementCreditsApi.md

File metadata and controls

394 lines (265 loc) · 11.1 KB
Raw

OpenAPI\Client\AdvertisementCreditsApi

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

Method HTTP request Description
archiveAdvertisementCredit() DELETE /v2/payment/advertisementCredit/{id} Archive ad credit
createAdvertisementCredit() POST /v2/payment/advertisementCredit Create ad credit
fetchAdvertisementCreditById() GET /v2/payment/advertisementCredit/{id} Fetch ad credit
fetchAdvertisementCreditScans() GET /v2/payment/advertisementCredit/scans/{id} Fetch scans
fetchAllAdvertisementCredits() GET /v2/payment/advertisementCredit/all Fetch all active ad credits
restoreAdvertisementCredit() PATCH /v2/payment/advertisementCredit/{id} Restore ad credit
updateAdvertisementCredit() PUT /v2/payment/advertisementCredit/{id} Update ad credit

archiveAdvertisementCredit()

archiveAdvertisementCredit($id): \OpenAPI\Client\Model\WTAdvertisementCredit

Archive ad credit

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\WTAdvertisementCredit

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]

createAdvertisementCredit()

createAdvertisementCredit($wt_advertisement_credit_create_params): \OpenAPI\Client\Model\WTAdvertisementCredit

Create ad credit

Example

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



$apiInstance = new OpenAPI\Client\Api\AdvertisementCreditsApi(
    // 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_advertisement_credit_create_params = new \OpenAPI\Client\Model\WTAdvertisementCreditCreateParams(); // \OpenAPI\Client\Model\WTAdvertisementCreditCreateParams

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

Parameters

Name Type Description Notes
wt_advertisement_credit_create_params \OpenAPI\Client\Model\WTAdvertisementCreditCreateParams

Return type

\OpenAPI\Client\Model\WTAdvertisementCredit

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]

fetchAdvertisementCreditById()

fetchAdvertisementCreditById($id): \OpenAPI\Client\Model\WTAdvertisementCredit

Fetch ad credit

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\WTAdvertisementCredit

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]

fetchAdvertisementCreditScans()

fetchAdvertisementCreditScans($id): \OpenAPI\Client\Model\WTAdvertisementCreditScan[]

Fetch scans

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\WTAdvertisementCreditScan[]

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]

fetchAllAdvertisementCredits()

fetchAllAdvertisementCredits($is_archive_included): \OpenAPI\Client\Model\WTAdvertisementCredit[]

Fetch all active ad credits

Example

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



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

Parameters

Name Type Description Notes
is_archive_included bool [optional]

Return type

\OpenAPI\Client\Model\WTAdvertisementCredit[]

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]

restoreAdvertisementCredit()

restoreAdvertisementCredit($id): \OpenAPI\Client\Model\WTAdvertisementCredit

Restore ad credit

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

\OpenAPI\Client\Model\WTAdvertisementCredit

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]

updateAdvertisementCredit()

updateAdvertisementCredit($id, $wt_advertisement_credit_update_params): \OpenAPI\Client\Model\WTAdvertisementCredit

Update ad credit

Example

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



$apiInstance = new OpenAPI\Client\Api\AdvertisementCreditsApi(
    // 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_advertisement_credit_update_params = new \OpenAPI\Client\Model\WTAdvertisementCreditUpdateParams(); // \OpenAPI\Client\Model\WTAdvertisementCreditUpdateParams

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

Parameters

Name Type Description Notes
id mixed
wt_advertisement_credit_update_params \OpenAPI\Client\Model\WTAdvertisementCreditUpdateParams

Return type

\OpenAPI\Client\Model\WTAdvertisementCredit

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]