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