@tillhub/javascript-sdk
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Vouchers
constructor
endpoint
endpoint
V1
http
logs
options
uri
Helper
uri
Helper
V1
base
Endpoint
base
Endpoint
V1
count
create
create
Bounded
Customers
delete
get
get
All
get
All
Users
get
Bounded
Customers
get
Logs
meta
patch
put
update
Bounded
Customers
Vouchers
Fetch
Failed
Vouchers
Query
Options
Vouchers
Response
Hierarchy
Vouchers
Vouchers
Index
Constructors
constructor
Properties
endpoint
endpoint
V1
http
logs
options
uri
Helper
uri
Helper
V1
base
Endpoint
base
Endpoint
V1
Methods
count
create
create
Bounded
Customers
delete
get
get
All
get
All
Users
get
Bounded
Customers
get
Logs
meta
patch
put
update
Bounded
Customers
Constructors
constructor
new
Vouchers
(
options
:
VouchersOptions
, http
:
Client
)
:
Vouchers
Parameters
options:
VouchersOptions
http:
Client
Returns
Vouchers
Properties
endpoint
endpoint
:
string
endpoint
V1
endpoint
V1
:
string
http
http
:
Client
logs
logs
:
VoucherLogs
options
options
:
VouchersOptions
uri
Helper
uri
Helper
:
UriHelper
uri
Helper
V1
uri
Helper
V1
:
UriHelper
Static
base
Endpoint
base
Endpoint
:
string
= '/api/v0/vouchers'
Static
base
Endpoint
V1
base
Endpoint
V1
:
string
= '/api/v1/vouchers'
Methods
count
count
(
)
:
Promise
<
VouchersResponse
>
Returns
Promise
<
VouchersResponse
>
create
create
(
voucher
:
Voucher
)
:
Promise
<
VoucherResponse
>
Parameters
voucher:
Voucher
Returns
Promise
<
VoucherResponse
>
create
Bounded
Customers
create
Bounded
Customers
(
voucherId
:
string
, customers
:
string
[]
)
:
Promise
<
BoundedCustomersPostResponse
>
Parameters
voucherId:
string
customers:
string
[]
Returns
Promise
<
BoundedCustomersPostResponse
>
delete
delete
(
voucherId
:
string
)
:
Promise
<
VouchersResponse
>
Parameters
voucherId:
string
Returns
Promise
<
VouchersResponse
>
get
get
(
voucherId
:
string
)
:
Promise
<
VoucherResponse
>
Parameters
voucherId:
string
Returns
Promise
<
VoucherResponse
>
get
All
get
All
(
optionsOrQuery
?:
VouchersQueryOptions
)
:
Promise
<
VouchersResponse
>
Parameters
Optional
optionsOrQuery:
VouchersQueryOptions
Returns
Promise
<
VouchersResponse
>
get
All
Users
get
All
Users
(
)
:
Promise
<
UsersResponse
>
Returns
Promise
<
UsersResponse
>
get
Bounded
Customers
get
Bounded
Customers
(
voucherId
:
string
)
:
Promise
<
BoundedCustomersGetResponse
>
Parameters
voucherId:
string
Returns
Promise
<
BoundedCustomersGetResponse
>
get
Logs
get
Logs
(
voucherId
:
string
, optionsOrQuery
?:
VouchersQueryOptions
)
:
Promise
<
VoucherLogsResponse
>
Parameters
voucherId:
string
Optional
optionsOrQuery:
VouchersQueryOptions
Returns
Promise
<
VoucherLogsResponse
>
meta
meta
(
q
?:
VouchersMetaQuery
)
:
Promise
<
VouchersResponse
>
Parameters
Optional
q:
VouchersMetaQuery
Returns
Promise
<
VouchersResponse
>
patch
patch
(
source
:
Voucher
, target
:
Voucher
)
:
Promise
<
VoucherResponse
>
Parameters
source:
Voucher
target:
Voucher
Returns
Promise
<
VoucherResponse
>
put
put
(
voucherId
:
string
, voucher
:
Voucher
)
:
Promise
<
VoucherResponse
>
Parameters
voucherId:
string
voucher:
Voucher
Returns
Promise
<
VoucherResponse
>
update
Bounded
Customers
update
Bounded
Customers
(
voucherId
:
string
, customers
:
string
[]
)
:
Promise
<
BoundedCustomersPostResponse
>
Parameters
voucherId:
string
customers:
string
[]
Returns
Promise
<
BoundedCustomersPostResponse
>
Generated using
TypeDoc