Class Products

Products resource handler

Index

Constructors

Methods

count create delete get list update

Constructors

constructor

new Products(client): Products
Parameters
- client: SapoClient
Returns Products
- Defined in resources/products.ts:10

Methods

count

count(params?): Promise<number>
Get total product count
Parameters
- Optional params: Partial<ProductListParams>
Returns Promise<number>
- Defined in resources/products.ts:57

create

create(data): Promise<Product>
Create a new product
Parameters
- data: CreateProductData
Returns Promise<Product>
- Defined in resources/products.ts:30

delete

delete(id): Promise<void>
Delete a product
Parameters
- id: number
Returns Promise<void>
- Defined in resources/products.ts:50

get

get(id): Promise<Product>
Get a single product by ID
Parameters
- id: number
Returns Promise<Product>
- Defined in resources/products.ts:22

list

list(params?): Promise<PaginatedResponse<Product>>
Get a list of products
Parameters
- Optional params: ProductListParams
Returns Promise<PaginatedResponse<Product>>
- Defined in resources/products.ts:15

update

update(id, data): Promise<Product>
Update an existing product
Parameters
- id: number
- data: Partial<CreateProductData>
Returns Promise<Product>
- Defined in resources/products.ts:40