Class PriceRules

Price Rules resource handler

Index

Constructors

Methods

count create createDiscountCode delete deleteDiscountCode get getDiscountCode list listDiscountCodes lookupDiscountCode update updateDiscountCode

Constructors

constructor

new PriceRules(client): PriceRules
Parameters
- client: SapoClient
Returns PriceRules
- Defined in resources/price-rules.ts:18

Methods

count

count(params?): Promise<number>
Get total price rule count
Parameters
- Optional params: Partial<PriceRuleListParams>
Returns Promise<number>
- Defined in resources/price-rules.ts:68

create

create(data): Promise<PriceRule>
Create a new price rule
Parameters
- data: CreatePriceRuleData
Returns Promise<PriceRule>
- Defined in resources/price-rules.ts:40

createDiscountCode

createDiscountCode(priceRuleId, data): Promise<DiscountCode>
Create a discount code for a price rule
Parameters
- priceRuleId: number
- data: CreateDiscountCodeData
Returns Promise<DiscountCode>
- Defined in resources/price-rules.ts:99

delete

delete(id): Promise<void>
Delete a price rule
Parameters
- id: number
Returns Promise<void>
- Defined in resources/price-rules.ts:61

deleteDiscountCode

deleteDiscountCode(priceRuleId, id): Promise<void>
Delete a discount code
Parameters
- priceRuleId: number
- id: number
Returns Promise<void>
- Defined in resources/price-rules.ts:128

get

get(id): Promise<PriceRule>
Get a single price rule by ID
Parameters
- id: number
Returns Promise<PriceRule>
- Defined in resources/price-rules.ts:30

getDiscountCode

getDiscountCode(priceRuleId, id): Promise<DiscountCode>
Get a single discount code
Parameters
- priceRuleId: number
- id: number
Returns Promise<DiscountCode>
- Defined in resources/price-rules.ts:89

list

list(params?): Promise<PaginatedResponse<PriceRule>>
Get a list of price rules
Parameters
- Optional params: PriceRuleListParams
Returns Promise<PaginatedResponse<PriceRule>>
- Defined in resources/price-rules.ts:23

listDiscountCodes

listDiscountCodes(priceRuleId, params?): Promise<PaginatedResponse<DiscountCode>>
Get discount codes for a price rule
Parameters
- priceRuleId: number
- Optional params: DiscountCodeListParams
Returns Promise<PaginatedResponse<DiscountCode>>
- Defined in resources/price-rules.ts:79

lookupDiscountCode

lookupDiscountCode(code): Promise<null | DiscountCode>
Lookup discount code by code
Parameters
- code: string
Returns Promise<null | DiscountCode>
- Defined in resources/price-rules.ts:135

update

update(id, data): Promise<PriceRule>
Update an existing price rule
Parameters
- id: number
- data: Partial<CreatePriceRuleData>
Returns Promise<PriceRule>
- Defined in resources/price-rules.ts:50

updateDiscountCode

updateDiscountCode(priceRuleId, id, data): Promise<DiscountCode>
Update a discount code
Parameters
- priceRuleId: number
- id: number
- data: Partial<CreateDiscountCodeData>
Returns Promise<DiscountCode>
- Defined in resources/price-rules.ts:113