Function getUuidsPage

Returns (
    qualifier:
        | Readonly<{ contactType: string }>
        | Readonly<{ freetext: string }>,
    cursor?: Nullable<string>,
    limit?: number | `${number}`,
) => Promise<Page<string>>

a function for retrieving a paged array of contact identifiers

• • (
        qualifier:
            | Readonly<{ contactType: string }>
            | Readonly<{ freetext: string }>,
        cursor?: Nullable<string>,
        limit?: number | `${number}`,
    ): Promise<Page<string>>

  • Returns an array of contact identifiers for the provided page specifications.

    Parameters

    • qualifier: Readonly<{ contactType: string }> | Readonly<{ freetext: string }>

      the limiter defining which identifiers to return
    • cursor: Nullable<string> = null

      the token identifying which page to retrieve. A null value indicates the first page should be returned. Subsequent pages can be retrieved by providing the cursor returned with the previous page.
    • limit: number | `${number}` = DEFAULT_IDS_PAGE_LIMIT

      the maximum number of identifiers to return. Default is 10000.

    Returns Promise<Page<string>>

    a page of contact identifiers for the provided specification

    Throws

    InvalidArrgumentError if no qualifier is provided or if the qualifier is invalid

    Throws

    InvalidArgumentError if the provided limit value is <=0

    Throws

    InvalidArgumentError if the provided cursor is not a valid page token or null