Class CustomersAccessor

Hierarchy (View Summary)

ElementListAccessor<Customer, FindCustomersQuery, CreateCustomerRequest>
- CustomersAccessor

Index

Constructors

Methods

find findAll create

Constructors

constructor

new CustomersAccessor(client: IntegrationAppApiClient): CustomersAccessor
Parameters
- client: IntegrationAppApiClient
Returns CustomersAccessor
Overrides ElementListAccessor.constructor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:1713

Methods

find

find(query?: FindCustomersQuery): Promise<PaginationResponse<Customer>>
Parameters
- Optionalquery: FindCustomersQuery
Returns Promise<PaginationResponse<Customer>>
Inherited from ElementListAccessor.find
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:287

findAll

findAll(query?: Omit<FindCustomersQuery, "limit">): Promise<Customer[]>
Parameters
- Optionalquery: Omit<FindCustomersQuery, "limit">
Returns Promise<Customer[]>
Inherited from ElementListAccessor.findAll
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:288

create

create(data: CreateCustomerRequest): Promise<Customer>
Parameters
- data: CreateCustomerRequest
Returns Promise<Customer>
Inherited from ElementListAccessor.create
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:289