Class: module:api/VouchersApi

module:api/VouchersApi(apiClient)

new module:api/VouchersApi(apiClient)

Constructs a new VouchersApi.

Parameters:
Name Type Description
apiClient module:ApiClient

Optional API client implementation to use, default to module:ApiClient#instance if unspecified.

Source:

Methods

getVoucher(code, opts) → {Promise}

getVoucher Returns details of a single voucher according to a voucher code. Security: Permitted only for trusted client

Parameters:
Name Type Description
code String

Voucher identifier (code)

opts Object

Optional parameters

Properties
Name Type Description
fields String

Response configuration (list of fields, which should be returned in response)

Source:
Returns:

a Promise">www.promisejs.org/|Promise}, with data of type module:models/Voucher

Type
Promise

vouchersByCodeWithHttpInfo(code, opts) → {Promise}

getVoucher Returns details of a single voucher according to a voucher code. Security: Permitted only for trusted client

Parameters:
Name Type Description
code String

Voucher identifier (code)

opts Object

Optional parameters

Properties
Name Type Description
fields String

Response configuration (list of fields, which should be returned in response)

Source:
Returns:

a Promise">www.promisejs.org/|Promise}, with an object containing data of type module:models/Voucher and HTTP response

Type
Promise