Class CustomerAccessor

Hierarchy (View Summary)

ElementAccessor<Customer, UpdateCustomerRequest, CustomerSelector>
- CustomerAccessor

Index

Constructors

Methods

getUniqueIdentifier get put patch archive getPath

Properties

Constructors

constructor

new CustomerAccessor(
client: IntegrationAppApiClient,
selector: string | CustomerSelector,
): CustomerAccessor
Parameters
- client: IntegrationAppApiClient
- selector: string | CustomerSelector
Returns CustomerAccessor
Overrides ElementAccessor.constructor
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:1716

Methods

getUniqueIdentifier

getUniqueIdentifier(): string
Returns string
Inherited from ElementAccessor.getUniqueIdentifier
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:276

get

get(): Promise<Customer>
Returns Promise<Customer>
Inherited from ElementAccessor.get
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:277

put

put(data: UpdateCustomerRequest): Promise<Customer>
Parameters
- data: UpdateCustomerRequest
Returns Promise<Customer>
Inherited from ElementAccessor.put
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:278

patch

patch(data: Partial<UpdateCustomerRequest>): Promise<Customer>
Parameters
- data: Partial<UpdateCustomerRequest>
Returns Promise<Customer>
Inherited from ElementAccessor.patch
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:279

archive

archive(): Promise<void>
Returns Promise<void>
Inherited from ElementAccessor.archive
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:280

getPath

getPath(operation?: string): string
Parameters
- Optionaloperation: string
Returns string
Inherited from ElementAccessor.getPath
- Defined in ../../node_modules/@integration-app/sdk/dist/index.module.d.mts:281

Properties

`Protected`options

options: {
    client: IntegrationAppApiClient;
    path: string;
    selector: string | CustomerSelector;
}