Function basicKeapClient

Returns {
    contacts: {
        retrieve: ((options: RetrieveContactsOptions) => Promise<{
            count: number;
            data: Contact[];
            next: string;
            previous: string;
        }>);
        retrieveAsyncGenerator: ((options: RetrieveContactsOptions) => Promise<AsyncGenerator<PaginatedContactsClientResponse, void, unknown>>);
        retrieveByEmail: ((email: string, options: RetrieveContactsOptions) => Promise<PaginatedContactsClientResponse>);
        retrieveById: ((id: number, options: RetrieveContactOptions) => Promise<ResponseBody>);
        retrieveByQueryString: ((qs: string, options: RetrieveContactsOptions) => Promise<PaginatedContactsClientResponse>);
    };
    tokens: {
        tokens: ((options?: RefreshedTokensOptions) => Promise<{
            access_token: string;
            expires_in: number;
            refresh_token: string;
            scope: string;
            token_type: "bearer";
        }>);
    };
}

• contacts: {
      retrieve: ((options: RetrieveContactsOptions) => Promise<{
          count: number;
          data: Contact[];
          next: string;
          previous: string;
      }>);
      retrieveAsyncGenerator: ((options: RetrieveContactsOptions) => Promise<AsyncGenerator<PaginatedContactsClientResponse, void, unknown>>);
      retrieveByEmail: ((email: string, options: RetrieveContactsOptions) => Promise<PaginatedContactsClientResponse>);
      retrieveById: ((id: number, options: RetrieveContactOptions) => Promise<ResponseBody>);
      retrieveByQueryString: ((qs: string, options: RetrieveContactsOptions) => Promise<PaginatedContactsClientResponse>);
  }

  • retrieve: ((options: RetrieveContactsOptions) => Promise<{
        count: number;
        data: Contact[];
        next: string;
        previous: string;
    }>)

    • • (options): Promise<{
            count: number;
            data: Contact[];
            next: string;
            previous: string;
        }>

      • Parameters

        • options: RetrieveContactsOptions

        Returns Promise<{
            count: number;
            data: Contact[];
            next: string;
            previous: string;
        }>

  • retrieveAsyncGenerator: ((options: RetrieveContactsOptions) => Promise<AsyncGenerator<PaginatedContactsClientResponse, void, unknown>>)

    • • (options): Promise<AsyncGenerator<PaginatedContactsClientResponse, void, unknown>>

      • Parameters

        • options: RetrieveContactsOptions

        Returns Promise<AsyncGenerator<PaginatedContactsClientResponse, void, unknown>>

  • retrieveByEmail: ((email: string, options: RetrieveContactsOptions) => Promise<PaginatedContactsClientResponse>)

    • • (email, options): Promise<PaginatedContactsClientResponse>

      • Parameters

        • email: string
        • options: RetrieveContactsOptions

        Returns Promise<PaginatedContactsClientResponse>

  • retrieveById: ((id: number, options: RetrieveContactOptions) => Promise<ResponseBody>)

    • • (id, options): Promise<ResponseBody>

      • Parameters

        • id: number
        • options: RetrieveContactOptions

        Returns Promise<ResponseBody>

  • retrieveByQueryString: ((qs: string, options: RetrieveContactsOptions) => Promise<PaginatedContactsClientResponse>)

    • • (qs, options): Promise<PaginatedContactsClientResponse>

      • Parameters

        • qs: string
        • options: RetrieveContactsOptions

        Returns Promise<PaginatedContactsClientResponse>

• tokens: {
      tokens: ((options?: RefreshedTokensOptions) => Promise<{
          access_token: string;
          expires_in: number;
          refresh_token: string;
          scope: string;
          token_type: "bearer";
      }>);
  }

  • tokens: ((options?: RefreshedTokensOptions) => Promise<{
        access_token: string;
        expires_in: number;
        refresh_token: string;
        scope: string;
        token_type: "bearer";
    }>)

    • • (options?): Promise<{
            access_token: string;
            expires_in: number;
            refresh_token: string;
            scope: string;
            token_type: "bearer";
        }>

      • Parameters

        • options: RefreshedTokensOptions = {}

        Returns Promise<{
            access_token: string;
            expires_in: number;
            refresh_token: string;
            scope: string;
            token_type: "bearer";
        }>