Interface ProductsClient

Hierarchy

BasicClient
Hierarchy
- ProductsClient

Index

Properties

create delete list listAsyncGenerator retrieve

Properties

create

create: ((config: ProductCreateRequestBody) => Promise<{ id: string }>)

Type declaration

- (config: ProductCreateRequestBody): Promise<{ id: string }>
- Parameters
  - config: ProductCreateRequestBody
  Returns Promise<{ id: string }>

delete

delete: ((config: ProductDeleteRequestBody) => Promise<{ id: string }>)

Type declaration

- (config: ProductDeleteRequestBody): Promise<{ id: string }>
- Parameters
  - config: ProductDeleteRequestBody
  Returns Promise<{ id: string }>

list

list: ((options?: ProductListOptions) => Promise<ProductListResponseBody>)

Type declaration

- (options?: ProductListOptions): Promise<ProductListResponseBody>
- Parameters
  - Optional options: ProductListOptions
  Returns Promise<ProductListResponseBody>

listAsyncGenerator

listAsyncGenerator: ((options?: ProductListOptions) => AsyncGenerator<ProductListResponseBody, any, unknown>)

Type declaration

- (options?: ProductListOptions): AsyncGenerator<ProductListResponseBody, any, unknown>
- Parameters
  - Optional options: ProductListOptions
  Returns AsyncGenerator<ProductListResponseBody, any, unknown>

retrieve

retrieve: ((config: ProductRetrieveConfig) => Promise<Product>)

Type declaration

- (config: ProductRetrieveConfig): Promise<Product>
- Parameters
  - config: ProductRetrieveConfig
  Returns Promise<Product>

Generated using TypeDoc