Typescript SDK Type Docs
    Preparing search index...

    Class ByProjectKeyCustomersRequestBuilder

    Index

    Constructors

    constructor

    Properties

    args

    Methods

    emailConfirm emailToken get head password passwordReset passwordToken post search searchIndexingStatus withEmailToken withId withKey withPasswordToken

    Constructors

    Properties

    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { projectKey: string };
    }

    Methods

    • Parameters

      • OptionalmethodArgs: {
            headers?: { [key: string]: string | string[] };
            queryArgs?: {
                expand?: string | string[];
                limit?: number;
                offset?: number;
                sort?: string | string[];
                where?: string | string[];
                withTotal?: boolean;
                [key: string]: QueryParam;
            };
        }

      Returns ApiRequest<CustomerPagedQueryResponse>

    • Checks if one or more Customers exist for the provided query predicate. Returns a 200 status if any Customers match the query predicate, or a 404 status otherwise.

      Parameters

      • OptionalmethodArgs: {
            headers?: { [key: string]: string | string[] };
            queryArgs?: { where?: string | string[]; [key: string]: QueryParam };
        }

      Returns ApiRequest<void>

    post

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods