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

ApolloRESTClient

Index

Methods

createLabel findLabelByName listLabels moveAccounts moveContacts searchAccounts searchContacts searchPeople

Methods

createLabel

createLabel(
name: string,
modality?: "accounts" | "contacts",
): Promise<ApolloLabel>
Create a label. modality is required by Apollo — omitting it returns 422.
Parameters
- name: string
- Optionalmodality: "accounts" | "contacts"
Returns Promise<ApolloLabel>
- Defined in packages/Actions/ApolloEnrichment/src/generic/apollo-lists.types.ts:266

findLabelByName

findLabelByName(name: string): Promise<ApolloLabel>
Resolve a label by exact name, case-insensitive; null when no match.
Parameters
- name: string
Returns Promise<ApolloLabel>
- Defined in packages/Actions/ApolloEnrichment/src/generic/apollo-lists.types.ts:268

listLabels

listLabels(): Promise<ApolloLabel[]>
Every label, account and contact alike. Master key required.

Returns Promise<ApolloLabel[]>
- Defined in packages/Actions/ApolloEnrichment/src/generic/apollo-lists.types.ts:264

moveAccounts

moveAccounts(
    accounts: ApolloAccount[],
    fromList: string,
    toList: string,
    options?: { verify?: boolean },
): Promise<ApolloMoveResult>
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>
- Defined in packages/Actions/ApolloEnrichment/src/generic/apollo-lists.types.ts:282

moveContacts

moveContacts(
    contacts: ApolloContact[],
    fromList: string,
    toList: string,
    options?: { verify?: boolean },
): Promise<ApolloMoveResult>
The same for contacts.
Parameters
- contacts: ApolloContact[]
- fromList: string
- toList: string
- Optionaloptions: { verify?: boolean }
Returns Promise<ApolloMoveResult>
- Defined in packages/Actions/ApolloEnrichment/src/generic/apollo-lists.types.ts:289

searchAccounts

searchAccounts(
filter: ApolloAccountSearchFilter,
paging?: ApolloPagingOptions,
): Promise<ApolloAccountsPage>
One page of saved accounts.
Parameters
- filter: ApolloAccountSearchFilter
- Optionalpaging: ApolloPagingOptions
Returns Promise<ApolloAccountsPage>
- Defined in packages/Actions/ApolloEnrichment/src/generic/apollo-lists.types.ts:271

searchContacts

searchContacts(
filter: ApolloContactSearchFilter,
paging?: ApolloPagingOptions,
): Promise<ApolloContactsPage>
One page of saved contacts.
Parameters
- filter: ApolloContactSearchFilter
- Optionalpaging: ApolloPagingOptions
Returns Promise<ApolloContactsPage>
- Defined in packages/Actions/ApolloEnrichment/src/generic/apollo-lists.types.ts:273

searchPeople

searchPeople(
filter: ApolloPeopleSearchFilter,
paging?: ApolloPagingOptions,
): Promise<ApolloPeoplePage>
One page of net-new prospects.
Parameters
- filter: ApolloPeopleSearchFilter
- Optionalpaging: ApolloPagingOptions
Returns Promise<ApolloPeoplePage>
- Defined in packages/Actions/ApolloEnrichment/src/generic/apollo-lists.types.ts:275