Function getPage

Returns (
    qualifier: ReportingPeriodQualifier & (
        ContactIdQualifier
        | ContactIdsQualifier
    ),
    cursor?: Nullable<string>,
    limit?: number | `${number}`,
) => Promise<Page<Target.v1.Target>>

a function for retrieving a paged array of targets

• • (
        qualifier: ReportingPeriodQualifier & (
            ContactIdQualifier
            | ContactIdsQualifier
        ),
        cursor?: Nullable<string>,
        limit?: number | `${number}`,
    ): Promise<Page<Target.v1.Target>>

  • Returns an array of targets for the provided page specifications.

    Parameters

    • qualifier: ReportingPeriodQualifier & (ContactIdQualifier | ContactIdsQualifier)

      the limiter defining which targets 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_DOCS_PAGE_LIMIT

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

    Returns Promise<Page<Target.v1.Target>>

    a page of targets 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