Vouchers | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Vouchers
  - Vouchers

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Vouchers(options: VouchersOptions, http: Client): Vouchers

Overrides ThBaseHandler.constructor
- Defined in src/v0/vouchers.ts:111
Parameters
- options: VouchersOptions
- http: Client
Returns Vouchers

Properties

endpoint

endpoint: string

http

http: Client

logs

logs: VoucherLogs

options

options: VouchersOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/vouchers'

Methods

count

count(): Promise<VouchersResponse>

- Defined in src/v0/vouchers.ts:192
Returns Promise<VouchersResponse>

create

create(voucher: Voucher): Promise<VoucherResponse>

- Defined in src/v0/vouchers.ts:298
Parameters
- voucher: Voucher
Returns Promise<VoucherResponse>

createBoundedCustomers

createBoundedCustomers(voucherId: string, customers: string[]): Promise<BoundedCustomersPostResponse>

- Defined in src/v0/vouchers.ts:356
Parameters
- voucherId: string
- customers: string[]
Returns Promise<BoundedCustomersPostResponse>

delete

delete(voucherId: string): Promise<VouchersResponse>

- Defined in src/v0/vouchers.ts:176
Parameters
- voucherId: string
Returns Promise<VouchersResponse>

get

get(voucherId: string): Promise<VoucherResponse>

- Defined in src/v0/vouchers.ts:210
Parameters
- voucherId: string
Returns Promise<VoucherResponse>

getAll

getAll(optionsOrQuery?: VouchersQueryOptions): Promise<VouchersResponse>

- Defined in src/v0/vouchers.ts:127
Parameters
- Optional optionsOrQuery: VouchersQueryOptions
Returns Promise<VouchersResponse>

getAllUsers

getAllUsers(): Promise<UsersResponse>

- Defined in src/v0/vouchers.ts:323
Returns Promise<UsersResponse>

getBoundedCustomers

getBoundedCustomers(voucherId: string): Promise<BoundedCustomersGetResponse>

- Defined in src/v0/vouchers.ts:340
Parameters
- voucherId: string
Returns Promise<BoundedCustomersGetResponse>

getLogs

getLogs(voucherId: string, optionsOrQuery?: VouchersQueryOptions): Promise<VoucherLogsResponse>

- Defined in src/v0/vouchers.ts:226
Parameters
- voucherId: string
- Optional optionsOrQuery: VouchersQueryOptions
Returns Promise<VoucherLogsResponse>

meta

meta(q?: VouchersMetaQuery): Promise<VouchersResponse>

- Defined in src/v0/vouchers.ts:153
Parameters
- Optional q: VouchersMetaQuery
Returns Promise<VouchersResponse>

patch

patch(source: Voucher, target: Voucher): Promise<VoucherResponse>

- Defined in src/v0/vouchers.ts:269
Parameters
- source: Voucher
- target: Voucher
Returns Promise<VoucherResponse>

put

put(voucherId: string, voucher: Voucher): Promise<VoucherResponse>

- Defined in src/v0/vouchers.ts:255
Parameters
- voucherId: string
- voucher: Voucher
Returns Promise<VoucherResponse>

updateBoundedCustomers

updateBoundedCustomers(voucherId: string, customers: string[]): Promise<BoundedCustomersPostResponse>

- Defined in src/v0/vouchers.ts:376
Parameters
- voucherId: string
- customers: string[]
Returns Promise<BoundedCustomersPostResponse>

Generated using TypeDoc