Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Customers

Index

Constructors

constructor

Methods

create

delete

  • delete(customerId: string): Promise<undefined>

deletePermanently

get

importCSV

  • importCSV(filePath: string): Promise<AsyncActionCreateResponse>

list

listActivities

listRedeemables

scroll

  • 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

    Returns AsyncGenerator<CustomerObject, void, CustomerObject>

update

updateConsents

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

updateInBulk

updateMetadataInBulk