Interface InvoicesClient

Hierarchy

BasicClient
Hierarchy
- InvoicesClient

Index

Properties

create delete list listAsyncGenerator retrieve

Properties

create

create: ((config: InvoiceCreateRequestBody) => Promise<{ id: string; token: string }>)

Type declaration

- (config: InvoiceCreateRequestBody): Promise<{ id: string; token: string }>
- Parameters
  - config: InvoiceCreateRequestBody
  Returns Promise<{ id: string; token: string }>

delete

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

Type declaration

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

list

list: ((options?: InvoiceListOptions) => Promise<InvoiceListResponseBody>)

Type declaration

- (options?: InvoiceListOptions): Promise<InvoiceListResponseBody>
- Parameters
  - Optional options: InvoiceListOptions
  Returns Promise<InvoiceListResponseBody>

listAsyncGenerator

listAsyncGenerator: ((options?: InvoiceListOptions) => AsyncGenerator<InvoiceListResponseBody, any, unknown>)

Type declaration

- (options?: InvoiceListOptions): AsyncGenerator<InvoiceListResponseBody, any, unknown>
- Parameters
  - Optional options: InvoiceListOptions
  Returns AsyncGenerator<InvoiceListResponseBody, any, unknown>

retrieve

retrieve: ((config: InvoiceRetrieveConfig) => Promise<InvoiceDetail>)

Type declaration

- (config: InvoiceRetrieveConfig): Promise<InvoiceDetail>
- Parameters
  - config: InvoiceRetrieveConfig
  Returns Promise<InvoiceDetail>

Generated using TypeDoc