Member Junction
    Preparing search index...

    Interface IApolloRESTClient

    The operations the list/search actions need. No delete surface, by design.

    interface IApolloRESTClient {
        createLabel(
            name: string,
            modality?: "accounts" | "contacts",
        ): Promise<ApolloLabel>;
        findLabelByName(name: string): Promise<ApolloLabel>;
        listLabels(): Promise<ApolloLabel[]>;
        moveAccounts(
            accounts: ApolloAccount[],
            fromList: string,
            toList: string,
            options?: { verify?: boolean },
        ): Promise<ApolloMoveResult>;
        moveContacts(
            contacts: ApolloContact[],
            fromList: string,
            toList: string,
            options?: { verify?: boolean },
        ): Promise<ApolloMoveResult>;
        searchAccounts(
            filter: ApolloAccountSearchFilter,
            paging?: ApolloPagingOptions,
        ): Promise<ApolloAccountsPage>;
        searchContacts(
            filter: ApolloContactSearchFilter,
            paging?: ApolloPagingOptions,
        ): Promise<ApolloContactsPage>;
        searchPeople(
            filter: ApolloPeopleSearchFilter,
            paging?: ApolloPagingOptions,
        ): Promise<ApolloPeoplePage>;
    }

    Implemented by

    Index

    Methods

    createLabel findLabelByName listLabels moveAccounts moveContacts searchAccounts searchContacts searchPeople

    Methods

    • Move accounts between lists, two-step and label-preserving. The supplied accounts MUST carry current labelNames from a fresh read — stale labels would be written back as the intended set and strip real memberships.

      Parameters

      • accounts: ApolloAccount[]
      • fromList: string
      • toList: string
      • Optionaloptions: { verify?: boolean }

      Returns Promise<ApolloMoveResult>

    Settings

    Member Visibility

    On This Page

    Methods