Class DiscountsClient

Index

Constructors

Methods

applyToCart create delete get list preview removeFromCart request update validate

Constructors

constructor

new DiscountsClient(opts: DiscountsClientOptions): DiscountsClient
Parameters
- opts: DiscountsClientOptions
Returns DiscountsClient
- Defined in client.ts:21

Methods

applyToCart

applyToCart(cartId: string, code: string): Promise<Cart>
Parameters
- cartId: string
- code: string
Returns Promise<Cart>
- Defined in client.ts:130

create

create(input: CreateDiscountInput): Promise<Discount>
Parameters
- input: CreateDiscountInput
Returns Promise<Discount>
- Defined in client.ts:76

delete

delete(id: string): Promise<void>
Parameters
- id: string
Returns Promise<void>
- Defined in client.ts:110

get

get(id: string): Promise<Discount>
Parameters
- id: string
Returns Promise<Discount>
- Defined in client.ts:98

list

list(params?: DiscountListParams): Promise<PaginatedDiscounts>
Parameters
- params: DiscountListParams = {}
Returns Promise<PaginatedDiscounts>
- Defined in client.ts:80

preview

preview(input: DiscountPreviewInput): Promise<DiscountPreviewResult>
Parameters
- input: DiscountPreviewInput
Returns Promise<DiscountPreviewResult>
- Defined in client.ts:126

removeFromCart

removeFromCart(cartId: string): Promise<Cart>
Parameters
- cartId: string
Returns Promise<Cart>
- Defined in client.ts:140

request

request<T = unknown>(method: string, path: string, body?: unknown): Promise<T>
Type Parameters
- T = unknown
Parameters
- method: string
- path: string
- Optionalbody: unknown
Returns Promise<T>
- Defined in client.ts:32

update

update(id: string, input: UpdateDiscountInput): Promise<Discount>
Parameters
- id: string
- input: UpdateDiscountInput
Returns Promise<Discount>
- Defined in client.ts:102

validate

validate(
    code: string,
    orderTotal: number,
    customerId?: string,
): Promise<DiscountValidationResult>
Parameters
- code: string
- orderTotal: number
- OptionalcustomerId: string
Returns Promise<DiscountValidationResult>
- Defined in client.ts:114