@planet-a/affinity-node
Version:
API wrapper for the affinity.co API
28 lines (27 loc) • 2.63 kB
TypeScript
import { BaseAPIRequestFactory } from './baseapi.js';
import { Configuration } from '../configuration.js';
import { RequestContext, ResponseContext, HttpInfo } from '../http/http.js';
import { InteractionsCallPaged } from '../models/InteractionsCallPaged.js';
/**
* no description
*/
export declare class CallsApiRequestFactory extends BaseAPIRequestFactory {
/**
* Paginate through all calls in Affinity. Returns basic information about the call interaction and its participants. Will only return calls that the current authenticated user has permission to see. You can filter calls 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 Calls | `int64` | `=` | `id=1` | | `startTime` | Start time of when the Call was held | `datetime` | `>`, `<`, `>=`, `<=` | `sentAt>2025-01-01T01:00:00Z` | | `createdAt` | When the Call was created in Affinity | `datetime` | `>`, `<`, `>=`, `<=` | `createdAt<2025-01-01T01:00:00Z` | | `updatedAt` | When the Call was updated in Affinity | `datetime` | `>`, `<`, `>=`, `<=` | `updatedAt>=2025-01-01T01:00:00Z`|
* Get metadata on all Calls
* @param cursor Cursor for the next or previous page
* @param limit Number of items to include in the page
* @param filter Filter options
*/
v2CallsGET(cursor?: string, limit?: number, filter?: string, _options?: Configuration): Promise<RequestContext>;
}
export declare class CallsApiResponseProcessor {
/**
* 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 v2CallsGET
* @throws ApiException if the response code was not in [200, 299]
*/
v2CallsGETWithHttpInfo(response: ResponseContext): Promise<HttpInfo<InteractionsCallPaged>>;
}