Class Products

Things you sell. A product's price lives on default_price.

Index

Constructors

Methods

create list retrieve update

Constructors

constructor

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

Methods

create

create(params: ProductCreateParams): Promise<Product>
Parameters
- params: ProductCreateParams
Returns Promise<Product>
- Defined in work/shieldz-sdk/shieldz-sdk/src/catalog.ts:20

list

list(params?: { active?: boolean }): Promise<List<Product>>
Parameters
- params: { active?: boolean } = {}
Returns Promise<List<Product>>
- Defined in work/shieldz-sdk/shieldz-sdk/src/catalog.ts:33

retrieve

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

update

update(id: string, params: ProductUpdateParams): Promise<Product>
default_price_data adds a new price, archives the old one and moves payment links to it.
Parameters
- id: string
- params: ProductUpdateParams
Returns Promise<Product>
- Defined in work/shieldz-sdk/shieldz-sdk/src/catalog.ts:29