Interface CustomersClient

Hierarchy

BasicClient
Hierarchy
- CustomersClient

Index

Properties

create delete list listAsyncGenerator retrieve update

Properties

create

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

Type declaration

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

delete

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

Type declaration

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

list

list: ((options?: CustomerListOptions) => Promise<CustomerListResponseBody>)

Type declaration

- (options?: CustomerListOptions): Promise<CustomerListResponseBody>
- Parameters
  - Optional options: CustomerListOptions
  Returns Promise<CustomerListResponseBody>

listAsyncGenerator

listAsyncGenerator: ((options?: CustomerListOptions) => AsyncGenerator<CustomerListResponseBody, any, unknown>)

Type declaration

- (options?: CustomerListOptions): AsyncGenerator<CustomerListResponseBody, any, unknown>
- Parameters
  - Optional options: CustomerListOptions
  Returns AsyncGenerator<CustomerListResponseBody, any, unknown>

retrieve

retrieve: ((config: CustomerRetrieveConfig) => Promise<Customer>)

Type declaration

- (config: CustomerRetrieveConfig): Promise<Customer>
- Parameters
  - config: CustomerRetrieveConfig
  Returns Promise<Customer>

update

update: ((config: CustomerUpdateRequestBody) => Promise<{ campi: string[]; id: string }>)

Type declaration

- (config: CustomerUpdateRequestBody): Promise<{ campi: string[]; id: string }>
- Parameters
  - config: CustomerUpdateRequestBody
  Returns Promise<{ campi: string[]; id: string }>

Generated using TypeDoc