Class Prices

What a product costs. A price's amount never changes; archive it and add a new one.

Index

Constructors

Methods

create list retrieve update

Constructors

constructor

new Prices(client: Shieldz): Prices
Parameters
- client: Shieldz
Returns Prices
- Defined in work/shieldz-sdk/shieldz-sdk/src/catalog.ts:40

Methods

create

create(params: PriceCreateParams): Promise<Price>
Parameters
- params: PriceCreateParams
Returns Promise<Price>
- Defined in work/shieldz-sdk/shieldz-sdk/src/catalog.ts:42

list

list(params?: { product?: string }): Promise<List<Price>>
Parameters
- params: { product?: string } = {}
Returns Promise<List<Price>>
- Defined in work/shieldz-sdk/shieldz-sdk/src/catalog.ts:55

retrieve

retrieve(id: string): Promise<Price>
Parameters
- id: string
Returns Promise<Price>
- Defined in work/shieldz-sdk/shieldz-sdk/src/catalog.ts:46

update

update(id: string, params: { active: boolean }): Promise<Price>
Archive (active: false) or restore a price.
Parameters
- id: string
- params: { active: boolean }
Returns Promise<Price>
- Defined in work/shieldz-sdk/shieldz-sdk/src/catalog.ts:51