AdminCustomersResource

admin/customers.AdminCustomersResource

Methods

create

create(payload, customHeaders?): ResponsePromise<AdminCustomersRes>

Creates a customer

Parameters

payloadAdminPostCustomersReqRequired

information of customer

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminCustomersRes>

ResponsePromiseResponsePromise<AdminCustomersRes>Required

---

list

list(query?, customHeaders?): ResponsePromise<AdminCustomersListRes>

Lists customers

Parameters

queryAdminGetCustomersParams

optional

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminCustomersListRes>

ResponsePromiseResponsePromise<AdminCustomersListRes>Required

---

retrieve

retrieve(id, customHeaders?): ResponsePromise<AdminCustomersRes>

Retrieves a customer

Parameters

idstringRequired

customer id

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminCustomersRes>

ResponsePromiseResponsePromise<AdminCustomersRes>Required

---

update

update(id, payload, customHeaders?): ResponsePromise<AdminCustomersRes>

Updates a customer

Parameters

idstringRequired

customer id

payloadAdminPostCustomersCustomerReqRequired

data to update customer with

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminCustomersRes>

ResponsePromiseResponsePromise<AdminCustomersRes>Required