@planet-a/affinity-node
Version:
API wrapper for the affinity.co API
28 lines (27 loc) • 2.66 kB
TypeScript
import { BaseAPIRequestFactory } from './baseapi.js';
import { Configuration } from '../configuration.js';
import { RequestContext, ResponseContext, HttpInfo } from '../http/http.js';
import { InteractionsEmailPaged } from '../models/InteractionsEmailPaged.js';
/**
* no description
*/
export declare class EmailsApiRequestFactory extends BaseAPIRequestFactory {
/**
* Paginate through all emails in Affinity. Returns basic information about the email interaction and its participants. Will only return emails or subject lines that the current authenticated user has permission to see. You can filter emails using the `filter` query parameter. The filter parameter is a string that you can specify conditions based on the following properties. | **Property Name** | **Description** | **Type** | **Allowed Operators** | **Examples** | |-----------------------------|-----------------------------------------------------------------|------------|--------------------------------------|----------------------------------| | `id` | Unique identifier for Emails | `int64` | `=` | `id=1` | | `sentAt` | When the Email was sent at | `datetime` | `>`, `<`, `>=`, `<=` | `sentAt>2025-01-01T01:00:00Z` | | `createdAt` | When the Email was created in Affinity | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt<2025-01-01T01:00:00Z` | | `updatedAt` | When the Email was updated in Affinity | `datetime` | `>`, `<`, `>=`, `<=` | `updatedAt>=2025-01-01T01:00:00Z`|
* Get metadata on all Emails
* @param cursor Cursor for the next or previous page
* @param limit Number of items to include in the page
* @param filter Filter options
*/
v2EmailsGET(cursor?: string, limit?: number, filter?: string, _options?: Configuration): Promise<RequestContext>;
}
export declare class EmailsApiResponseProcessor {
/**
* Unwraps the actual response sent by the server from the response context and deserializes the response content
* to the expected objects
*
* @params response Response returned by the server for a request to v2EmailsGET
* @throws ApiException if the response code was not in [200, 299]
*/
v2EmailsGETWithHttpInfo(response: ResponseContext): Promise<HttpInfo<InteractionsEmailPaged>>;
}