Skip to content

Latest commit

 

History

History
954 lines (645 loc) · 27.3 KB

InteractionsApi.md

File metadata and controls

954 lines (645 loc) · 27.3 KB

OpenAPI\Client\InteractionsApi

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

Method HTTP request Description
claimTicket() PUT /wallet/ticket/claim/{id} Update ticket
createAdvertisementCreditScan() POST /wallet/advertisementCredit/scan/{adCreditID} Create ad credit scan
createEmployeeVCard() GET /wallet/employee/vcard/{id} Fetch an employee's VCard
createIcsFile() GET /wallet/liveevent/ics/{id} Fetch ICS for live event
createVirtualBusinessCardVCard() GET /wallet/virtualBusinessCard/vCard/{id} Fetch an employee's VCard
fetchAllStaticVouchersAssociatedWithCustomerWithVoucherID() GET /wallet/staticVoucher/all Fetch a customer's static vouchers on the basis of a given voucher ID
fetchCustomerTicketsWithToken() POST /wallet/tickets/fetchCustomerTicketsWithToken Update ticket
fetchDynamicVoucherWithVoucherID() GET /wallet/dynamicVoucher/{voucherID} Fetch dynamic voucher
fetchMemberInformation() GET /wallet/member Fetch member information
fetchStaticVoucherWithVoucherID() GET /wallet/staticVoucher/{voucherID} Fetch static voucher
fetchWalletPageWithToken() POST /wallet/page/token Fetch page with token NOTE: This route exists because a token can completely change the dataset returned to the client. A simple fetch just logs the token with the request, but a fetchWithToken request can have a very different object returned to the client.
fetchWalletPaymentObjectsWithToken() POST /wallet/paymentObject/token Fetch payment objects with token NOTE: This route exists because a token can completely change the dataset returned to the client. A simple fetch just logs the token with the request, but a fetchWithToken request can have a very different object returned to the client.
findByVanityHandle() GET /wallet/vanityHandle/{handle} Fetch vanity handle
identifyItem() GET /wallet/item/identify/{itemID} Identify item
requestMerchantURLRedirect() POST /wallet/merchantURL/{itemID} Request Merchant URL
subscribeEmail() POST /wallet/subscribeEmail Create email subscriber
subscribeSms() POST /wallet/subscribeSms Create sms subscriber

claimTicket()

claimTicket($id, $claim_ticket_request): \OpenAPI\Client\Model\Ticket

Update ticket

Example

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



$apiInstance = new OpenAPI\Client\Api\InteractionsApi(
    // 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
$claim_ticket_request = new \OpenAPI\Client\Model\ClaimTicketRequest(); // \OpenAPI\Client\Model\ClaimTicketRequest

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

Parameters

Name Type Description Notes
id mixed
claim_ticket_request \OpenAPI\Client\Model\ClaimTicketRequest

Return type

\OpenAPI\Client\Model\Ticket

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]

createAdvertisementCreditScan()

createAdvertisementCreditScan($ad_credit_id): \OpenAPI\Client\Model\AdvertisementCreditScan

Create ad credit scan

Example

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



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

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

Parameters

Name Type Description Notes
ad_credit_id mixed

Return type

\OpenAPI\Client\Model\AdvertisementCreditScan

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]

createEmployeeVCard()

createEmployeeVCard($id): string

Fetch an employee's VCard

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

string

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]

createIcsFile()

createIcsFile($id): mixed

Fetch ICS for live event

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

mixed

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]

createVirtualBusinessCardVCard()

createVirtualBusinessCardVCard($id): string

Fetch an employee's VCard

Example

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



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

Parameters

Name Type Description Notes
id mixed

Return type

string

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]

fetchAllStaticVouchersAssociatedWithCustomerWithVoucherID()

fetchAllStaticVouchersAssociatedWithCustomerWithVoucherID($voucher_id): \OpenAPI\Client\Model\FetchAllStaticVouchersAssociatedWithCustomerWithVoucherID200ResponseInner[]

Fetch a customer's static vouchers on the basis of a given voucher ID

Example

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



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

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

Parameters

Name Type Description Notes
voucher_id mixed

Return type

\OpenAPI\Client\Model\FetchAllStaticVouchersAssociatedWithCustomerWithVoucherID200ResponseInner[]

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]

fetchCustomerTicketsWithToken()

fetchCustomerTicketsWithToken($fetch_customer_tickets_with_token_request): \OpenAPI\Client\Model\Ticket[]

Update ticket

Example

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



$apiInstance = new OpenAPI\Client\Api\InteractionsApi(
    // 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()
);
$fetch_customer_tickets_with_token_request = new \OpenAPI\Client\Model\FetchCustomerTicketsWithTokenRequest(); // \OpenAPI\Client\Model\FetchCustomerTicketsWithTokenRequest

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

Parameters

Name Type Description Notes
fetch_customer_tickets_with_token_request \OpenAPI\Client\Model\FetchCustomerTicketsWithTokenRequest

Return type

\OpenAPI\Client\Model\Ticket[]

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]

fetchDynamicVoucherWithVoucherID()

fetchDynamicVoucherWithVoucherID($voucher_id): \OpenAPI\Client\Model\DynamicVoucher

Fetch dynamic voucher

Example

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



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

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

Parameters

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

fetchMemberInformation()

fetchMemberInformation($member_id, $merchant_id): \OpenAPI\Client\Model\Member

Fetch member information

Example

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



$apiInstance = new OpenAPI\Client\Api\InteractionsApi(
    // 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()
);
$member_id = 'member_id_example'; // string
$merchant_id = 'merchant_id_example'; // string

try {
    $result = $apiInstance->fetchMemberInformation($member_id, $merchant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InteractionsApi->fetchMemberInformation: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
member_id string
merchant_id string

Return type

\OpenAPI\Client\Model\Member

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]

fetchStaticVoucherWithVoucherID()

fetchStaticVoucherWithVoucherID($voucher_id): \OpenAPI\Client\Model\StaticVoucher

Fetch static voucher

Example

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



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

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

Parameters

Name Type Description Notes
voucher_id mixed

Return type

\OpenAPI\Client\Model\StaticVoucher

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]

fetchWalletPageWithToken()

fetchWalletPageWithToken($wt_fetch_wallet_payment_objects_with_token): mixed

Fetch page with token NOTE: This route exists because a token can completely change the dataset returned to the client. A simple fetch just logs the token with the request, but a fetchWithToken request can have a very different object returned to the client.

Example

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



$apiInstance = new OpenAPI\Client\Api\InteractionsApi(
    // 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_fetch_wallet_payment_objects_with_token = new \OpenAPI\Client\Model\WTFetchWalletPaymentObjectsWithToken(); // \OpenAPI\Client\Model\WTFetchWalletPaymentObjectsWithToken

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

Parameters

Name Type Description Notes
wt_fetch_wallet_payment_objects_with_token \OpenAPI\Client\Model\WTFetchWalletPaymentObjectsWithToken

Return type

mixed

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]

fetchWalletPaymentObjectsWithToken()

fetchWalletPaymentObjectsWithToken($wt_fetch_wallet_payment_objects_with_token): mixed

Fetch payment objects with token NOTE: This route exists because a token can completely change the dataset returned to the client. A simple fetch just logs the token with the request, but a fetchWithToken request can have a very different object returned to the client.

Example

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



$apiInstance = new OpenAPI\Client\Api\InteractionsApi(
    // 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_fetch_wallet_payment_objects_with_token = new \OpenAPI\Client\Model\WTFetchWalletPaymentObjectsWithToken(); // \OpenAPI\Client\Model\WTFetchWalletPaymentObjectsWithToken

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

Parameters

Name Type Description Notes
wt_fetch_wallet_payment_objects_with_token \OpenAPI\Client\Model\WTFetchWalletPaymentObjectsWithToken

Return type

mixed

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]

findByVanityHandle()

findByVanityHandle($handle): \OpenAPI\Client\Model\WalletConfiguration

Fetch vanity handle

Example

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



$apiInstance = new OpenAPI\Client\Api\InteractionsApi(
    // 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()
);
$handle = 'handle_example'; // string

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

Parameters

Name Type Description Notes
handle string

Return type

\OpenAPI\Client\Model\WalletConfiguration

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]

identifyItem()

identifyItem($item_id, $is_refresh, $phone_verification_token, $referrer): mixed

Identify item

Example

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



$apiInstance = new OpenAPI\Client\Api\InteractionsApi(
    // 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()
);
$item_id = 'item_id_example'; // string
$is_refresh = True; // bool
$phone_verification_token = 'phone_verification_token_example'; // string
$referrer = 'referrer_example'; // string

try {
    $result = $apiInstance->identifyItem($item_id, $is_refresh, $phone_verification_token, $referrer);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InteractionsApi->identifyItem: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
item_id string
is_refresh bool [optional]
phone_verification_token string [optional]
referrer string [optional]

Return type

mixed

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]

requestMerchantURLRedirect()

requestMerchantURLRedirect($item_id, $browser_details): mixed

Request Merchant URL

Example

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



$apiInstance = new OpenAPI\Client\Api\InteractionsApi(
    // 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()
);
$item_id = 'item_id_example'; // string
$browser_details = new \OpenAPI\Client\Model\BrowserDetails(); // \OpenAPI\Client\Model\BrowserDetails

try {
    $result = $apiInstance->requestMerchantURLRedirect($item_id, $browser_details);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InteractionsApi->requestMerchantURLRedirect: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
item_id string
browser_details \OpenAPI\Client\Model\BrowserDetails

Return type

mixed

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]

subscribeEmail()

subscribeEmail($wt_email_subscriber_create_params_wallet_ui): \OpenAPI\Client\Model\EmailSubscriber

Create email subscriber

Example

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



$apiInstance = new OpenAPI\Client\Api\InteractionsApi(
    // 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_email_subscriber_create_params_wallet_ui = new \OpenAPI\Client\Model\WTEmailSubscriberCreateParamsWalletUI(); // \OpenAPI\Client\Model\WTEmailSubscriberCreateParamsWalletUI

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

Parameters

Name Type Description Notes
wt_email_subscriber_create_params_wallet_ui \OpenAPI\Client\Model\WTEmailSubscriberCreateParamsWalletUI

Return type

\OpenAPI\Client\Model\EmailSubscriber

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]

subscribeSms()

subscribeSms($wt_sms_subscriber_create_params_wallet_ui): \OpenAPI\Client\Model\SmsSubscriber

Create sms subscriber

Example

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



$apiInstance = new OpenAPI\Client\Api\InteractionsApi(
    // 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_sms_subscriber_create_params_wallet_ui = new \OpenAPI\Client\Model\WTSmsSubscriberCreateParamsWalletUI(); // \OpenAPI\Client\Model\WTSmsSubscriberCreateParamsWalletUI

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

Parameters

Name Type Description Notes
wt_sms_subscriber_create_params_wallet_ui \OpenAPI\Client\Model\WTSmsSubscriberCreateParamsWalletUI

Return type

\OpenAPI\Client\Model\SmsSubscriber

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]