Class Customers

Hierarchy

Customers

Index

Constructors

constructor

Methods

Constructors

constructor

new Customers(client: RequestController): Customers

Parameters
- client: RequestController
Returns Customers

Methods

create

create(customer: CustomerRequest): Promise<CustomersCreateResponse>

see

https://docs.voucherify.io/reference/create-customer

Parameters
- customer: CustomerRequest
Returns Promise<CustomersCreateResponse>

delete

delete(customerId: string): Promise<undefined>

see

https://docs.voucherify.io/reference/delete-customer

Parameters
- customerId: string
Returns Promise<undefined>

deletePermanently

deletePermanently(customerId: string): Promise<CustomersDeletePermanentlyResponseBody>

see

https://docs.voucherify.io/reference/delete-customer-permanently

Parameters
- customerId: string
Returns Promise<CustomersDeletePermanentlyResponseBody>

get

get(customerId: string): Promise<CustomersCreateResponse>

see

https://docs.voucherify.io/reference/read-customer

Parameters
- customerId: string
Returns Promise<CustomersCreateResponse>

importCSV

importCSV(filePath: string): Promise<AsyncActionCreateResponse>

see

https://docs.voucherify.io/reference/import-customers-using-csv

Parameters
- filePath: string
Returns Promise<AsyncActionCreateResponse>

list

list(params: CustomersCommonListRequest): Promise<CustomersCommonListResponse>

see

https://docs.voucherify.io/reference/list-customers

Parameters
- params: CustomersCommonListRequest
Returns Promise<CustomersCommonListResponse>

listActivities

listActivities(customerId: string, params?: CustomerActivitiesListQueryParams): Promise<CustomerActivitiesListResponse>

deprecated

This method is deprecated in favor of the listActivity method. We’re removing this method in next major version.

Parameters
- customerId: string
- Optional params: CustomerActivitiesListQueryParams
Returns Promise<CustomerActivitiesListResponse>

listActivity

listActivity(customerIdOrSourceId: string, params?: CustomerActivityListQueryParams): Promise<CustomerActivityListResponse>

see

https://docs.voucherify.io/reference/list-customer-activity

Parameters
- customerIdOrSourceId: string
- Optional params: CustomerActivityListQueryParams
Returns Promise<CustomerActivityListResponse>

listRedeemables

listRedeemables(id: string, params?: CustomerRedeemablesListQueryParams): Promise<CustomerRedeemablesListResponse>

see

https://docs.voucherify.io/reference/list-customer-redeemables

Parameters
- id: string
- Optional params: CustomerRedeemablesListQueryParams
Returns Promise<CustomerRedeemablesListResponse>

scroll

scroll(params: CustomersCommonListRequest): AsyncGenerator<CustomerObject, void, CustomerObject>

Standard list customers API has limitation of available pages to be shown equal to 100. To cover cases when you would like to fetch more, you must use scroll capabilities.
```
async function () {
        for await (const customer of voucherify.customers.scroll(params)) {
            console.log('Customer', customer)
        }
}
```
Parameters
- params: CustomersCommonListRequest
Returns AsyncGenerator<CustomerObject, void, CustomerObject>

update

update(customer: CustomersUpdateParams): Promise<CustomersCreateResponse>

see

https://docs.voucherify.io/reference/update-customer

Parameters
- customer: CustomersUpdateParams
Returns Promise<CustomersCreateResponse>

updateConsents

updateConsents(idOrSourceId: string, consents: Record<string, boolean>): Promise<undefined>

deprecated

This method is deprecated. We’re removing this method in next major version.

Parameters
- idOrSourceId: string
- consents: Record<string, boolean>
Returns Promise<undefined>

updateInBulk

updateInBulk(customers: CustomersUpdateInBulkRequestBody): Promise<AsyncActionCreateResponse>

see

https://docs.voucherify.io/reference/update-customers-in-bulk

Parameters
- customers: CustomersUpdateInBulkRequestBody
Returns Promise<AsyncActionCreateResponse>

updateMetadataInBulk

updateMetadataInBulk(sourceIdsAndMetadata: CustomersUpdateMetadataInBulkRequestBody): Promise<AsyncActionCreateResponse>

see

https://docs.voucherify.io/reference/update-customers-metadata-in-bulk

Parameters
- sourceIdsAndMetadata: CustomersUpdateMetadataInBulkRequestBody
Returns Promise<AsyncActionCreateResponse>