- storeKeapClient(__namedParameters): {
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: {
persistRefreshedTokens: ((options?: PersistRefreshedTokensOptions) => Promise<void>);
tokens: (() => Promise<Tokens>);
};
} Parameters
- __namedParameters: StoreKeapClientConfig
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: {
persistRefreshedTokens: ((options?: PersistRefreshedTokensOptions) => Promise<void>);
tokens: (() => Promise<Tokens>);
};
}
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: {
persistRefreshedTokens: ((options?: PersistRefreshedTokensOptions) => Promise<void>);
tokens: (() => Promise<Tokens>);
}
persistRefreshedTokens: ((options?: PersistRefreshedTokensOptions) => Promise<void>)
- (options?): Promise<void>
Parameters
- options: PersistRefreshedTokensOptions = {}
Returns Promise<void>
tokens: (() => Promise<Tokens>)
- (): Promise<Tokens>
Returns Promise<Tokens>
Retrieve fresh access/refresh tokens from the Keap OAuth server, then persist them.