export interface Conversation { /** Conversation ID. */ _id?: string; /** Whether the site visitor engaging in this conversation is a contact. */ contact?: boolean; /** Date and time the conversation was created. */ _createdDate?: Date | null; } export interface GetConversationRequest { } export interface GetConversationResponse { /** Rertrieved conversation. */ conversation?: Conversation; } export interface GetConversationsUsageRequest { } export interface GetConversationsUsageResponse { /** Maximum number of conversations for the site's plan. */ quota?: number; /** Conversations used in the current cycle. */ current?: number; } export interface ListConversationsRequest { /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */ cursorPaging?: CursorPaging; } export interface CursorPaging { /** Maximum number of items to return in the results. */ limit?: number | null; /** * Pointer to the next or previous page in the list of results. * * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. * Not relevant for the first request. */ cursor?: string | null; } export interface ListConversationsResponse { /** List of Conversations. */ conversations?: Conversation[]; /** Paging metadata */ pagingMetadata?: PagingMetadataV2; } export interface PagingMetadataV2 { /** Number of items returned in the response. */ count?: number | null; /** Offset that was requested. */ offset?: number | null; /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */ total?: number | null; /** Flag that indicates the server failed to calculate the `total` field. */ tooManyToCount?: boolean | null; /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */ cursors?: Cursors; } export interface Cursors { /** Cursor string pointing to the next page in the list of results. */ next?: string | null; /** Cursor pointing to the previous page in the list of results. */ prev?: string | null; } interface ConversationNonNullableFields { _id: string; contact: boolean; } export interface GetConversationResponseNonNullableFields { conversation?: ConversationNonNullableFields; } export interface GetConversationsUsageResponseNonNullableFields { quota: number; current: number; } /** * Retrieves the conversation for the site visitor calling this method. * * This method must be called using the site visitor or site member identity ([SDK](https://dev.wix.com/docs/sdk/articles/get-started/about-identities#site-member) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/about-identities#site-member)) to identify the site visitor that is requesting the conversation. Therefore, [Wix apps](https://dev.wix.com/docs/build-apps) can't currently call this method using REST. * @public * @documentationMaturity preview * @permissionId INNOVATION_LAB.CHAT_WIDGET * @permissionScope Manage Bookings Services and Settings * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION * @permissionScope Manage Portfolio * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO * @permissionScope Manage Restaurants - all permissions * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES * @applicableIdentity APP * @applicableIdentity VISITOR * @fqn wix.innovation.assistant.widget.v1.Conversations.GetConversation */ export declare function getConversation(): Promise; /** * Retrives the conversation usage and quota for the site. * @public * @documentationMaturity preview * @permissionId INNOVATION_LAB.CHAT_WIDGET * @permissionScope Manage Bookings Services and Settings * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION * @permissionScope Manage Portfolio * @permissionScopeId SCOPE.PORTFOLIO.MANAGE-PORTFOLIO * @permissionScope Manage Restaurants - all permissions * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES * @applicableIdentity APP * @applicableIdentity VISITOR * @fqn wix.innovation.assistant.widget.v1.Conversations.GetConversationsUsage * @deprecated * @replacedBy .wix.innovation.assistant.v1.quota.CheckQuota */ export declare function getConversationsUsage(): Promise; export {};