@wix/auto_sdk_forms_chat-settings 1.0.0

package/build/internal/es/index.typings.d.mts

@@ -0,0 +1,608 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+interface ChatSettings {
+    /**
+     * The ID of the chat settings. The chat settings specified in this object apply to the form with a matching ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Custom greeting message displayed when a visitor opens the AI chat.
+     * @maxLength 50
+     */
+    greetingMessage?: string | null;
+    /**
+     * Whether AI chat is enabled for this form.
+     *
+     * Default: `true`
+     */
+    chatEnabled?: boolean | null;
+    /**
+     * Revision number, which increments by 1 each time the chat settings are updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the chat settings.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the chat settings were created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the chat settings were last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Message that summarizes the contents of the form. Appears after the greeting message.
+     * @maxLength 255
+     */
+    summaryMessage?: string | null;
+    /** Extended fields. */
+    extendedFields?: ExtendedFields;
+    /**
+     * Whether the summary message is manually set or AI-generated.
+     * When `false` the summary message is automatically generated by AI when the chat settings are saved.
+     * When `true`, the summary message can be manually set and won't be overwritten by AI.
+     *
+     * Default: `false`
+     */
+    manualSummary?: boolean | null;
+}
+interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+interface CreateChatSettingsRequest {
+    /** Chat settings to be created. */
+    chatSettings: ChatSettings;
+}
+interface CreateChatSettingsResponse {
+    /** Created chat settings. */
+    chatSettings?: ChatSettings;
+}
+interface UpdateChatSettingsRequest {
+    /** Chat settings to be updated. */
+    chatSettings: ChatSettings;
+}
+interface UpdateChatSettingsResponse {
+    /** Updated chat settings. */
+    chatSettings?: ChatSettings;
+}
+interface DeleteChatSettingsRequest {
+    /**
+     * Chat settings ID.
+     * @format GUID
+     */
+    chatSettingsId: string;
+}
+interface DeleteChatSettingsResponse {
+}
+interface GetChatSettingsRequest {
+    /**
+     * Chat settings ID.
+     * @format GUID
+     */
+    chatSettingsId: string;
+}
+interface GetChatSettingsResponse {
+    /** Retrieved chat settings. */
+    chatSettings?: ChatSettings;
+}
+interface QueryChatSettingsRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /**
+     * Cursor paging options.
+     *
+     * Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
+     */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    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.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QueryChatSettingsResponse {
+    /** List of chat settings matching the query. */
+    chatSettings?: ChatSettings[];
+    /** Metadata about the pagination of the results. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in current page. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface Empty {
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+interface ChatSettingsCreatedEnvelope {
+    entity: ChatSettings;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId WIX_FORMS.FORM_SCHEMA_CREATE
+ * @webhook
+ * @eventType wix.forms.ai.v1.chat_settings_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onChatSettingsCreated(handler: (event: ChatSettingsCreatedEnvelope) => void | Promise<void>): void;
+interface ChatSettingsDeletedEnvelope {
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId WIX_FORMS.FORM_SCHEMA_CREATE
+ * @webhook
+ * @eventType wix.forms.ai.v1.chat_settings_deleted
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onChatSettingsDeleted(handler: (event: ChatSettingsDeletedEnvelope) => void | Promise<void>): void;
+interface ChatSettingsUpdatedEnvelope {
+    entity: ChatSettings;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Challenges
+ * @permissionScopeId SCOPE.CHALLENGES.MANAGE
+ * @permissionId WIX_FORMS.FORM_SCHEMA_CREATE
+ * @webhook
+ * @eventType wix.forms.ai.v1.chat_settings_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onChatSettingsUpdated(handler: (event: ChatSettingsUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Creates a chat settings entity.
+ *
+ * The settings specified in a chat settings entity apply to the form with the same ID as the chat settings entity. Each form can have exactly one set of chat settings.
+ * @param chatSettings - Chat settings to be created.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField chatSettings
+ * @requiredField chatSettings._id
+ * @permissionId WIX_FORMS.FORM_SCHEMA_CREATE
+ * @applicableIdentity APP
+ * @returns Created chat settings.
+ * @fqn wix.forms.ai.v1.ChatSettingsService.CreateChatSettings
+ */
+declare function createChatSettings(chatSettings: NonNullablePaths<ChatSettings, `_id`, 2>): Promise<NonNullablePaths<ChatSettings, `_id`, 2>>;
+/**
+ * Updates a chat settings entity.
+ *
+ * Changes take effect immediately for new interactive form sessions.
+ * @param _id - The ID of the chat settings. The chat settings specified in this object apply to the form with a matching ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField chatSettings
+ * @permissionId WIX_FORMS.FORM_SCHEMA_UPDATE
+ * @applicableIdentity APP
+ * @returns Updated chat settings.
+ * @fqn wix.forms.ai.v1.ChatSettingsService.UpdateChatSettings
+ */
+declare function updateChatSettings(_id: string, chatSettings: UpdateChatSettings): Promise<NonNullablePaths<ChatSettings, `_id`, 2>>;
+interface UpdateChatSettings {
+    /**
+     * The ID of the chat settings. The chat settings specified in this object apply to the form with a matching ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Custom greeting message displayed when a visitor opens the AI chat.
+     * @maxLength 50
+     */
+    greetingMessage?: string | null;
+    /**
+     * Whether AI chat is enabled for this form.
+     *
+     * Default: `true`
+     */
+    chatEnabled?: boolean | null;
+    /**
+     * Revision number, which increments by 1 each time the chat settings are updated.
+     * To prevent conflicting changes, the current revision must be passed when updating the chat settings.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the chat settings were created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time the chat settings were last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Message that summarizes the contents of the form. Appears after the greeting message.
+     * @maxLength 255
+     */
+    summaryMessage?: string | null;
+    /** Extended fields. */
+    extendedFields?: ExtendedFields;
+    /**
+     * Whether the summary message is manually set or AI-generated.
+     * When `false` the summary message is automatically generated by AI when the chat settings are saved.
+     * When `true`, the summary message can be manually set and won't be overwritten by AI.
+     *
+     * Default: `false`
+     */
+    manualSummary?: boolean | null;
+}
+/**
+ * Deletes a chat settings entity.
+ * @param chatSettingsId - Chat settings ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField chatSettingsId
+ * @permissionId WIX_FORMS.FORM_SCHEMA_DELETE
+ * @applicableIdentity APP
+ * @fqn wix.forms.ai.v1.ChatSettingsService.DeleteChatSettings
+ */
+declare function deleteChatSettings(chatSettingsId: string): Promise<void>;
+/**
+ * Retrieves a chat settings entity.
+ * @param chatSettingsId - Chat settings ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField chatSettingsId
+ * @permissionId WIX_FORMS.FORM_SCHEMA_READ
+ * @applicableIdentity APP
+ * @returns Retrieved chat settings.
+ * @fqn wix.forms.ai.v1.ChatSettingsService.GetChatSettings
+ */
+declare function getChatSettings(chatSettingsId: string): Promise<NonNullablePaths<ChatSettings, `_id`, 2>>;
+/**
+ * Retrieves a list of chat settings entities given the provided paging, filtering, and sorting.
+ *
+ * ### Defaults
+ * Query Chat Settings has the following default settings, which you can override:
+ * + Sorted by `id` in ascending order.
+ * + `cursorPaging.limit` set to `100`.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId WIX_FORMS.FORM_SCHEMA_READ
+ * @applicableIdentity APP
+ * @fqn wix.forms.ai.v1.ChatSettingsService.QueryChatSettings
+ */
+declare function queryChatSettings(): ChatSettingsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface ChatSettingsQueryResult extends QueryCursorResult {
+    items: ChatSettings[];
+    query: ChatSettingsQueryBuilder;
+    next: () => Promise<ChatSettingsQueryResult>;
+    prev: () => Promise<ChatSettingsQueryResult>;
+}
+interface ChatSettingsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: 'greetingMessage' | 'summaryMessage', value: any) => ChatSettingsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: 'greetingMessage' | 'summaryMessage', value: any) => ChatSettingsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: 'greetingMessage' | 'summaryMessage', value: any) => ChatSettingsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: 'greetingMessage' | 'summaryMessage', value: any) => ChatSettingsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: 'greetingMessage' | 'summaryMessage', value: any) => ChatSettingsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: 'greetingMessage' | 'summaryMessage', value: any) => ChatSettingsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: 'greetingMessage' | 'summaryMessage', value: string) => ChatSettingsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: 'greetingMessage' | 'summaryMessage', value: any[]) => ChatSettingsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: 'greetingMessage' | 'summaryMessage', value: any) => ChatSettingsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: 'greetingMessage' | 'summaryMessage', value: boolean) => ChatSettingsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'greetingMessage' | 'summaryMessage'>) => ChatSettingsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'greetingMessage' | 'summaryMessage'>) => ChatSettingsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => ChatSettingsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => ChatSettingsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<ChatSettingsQueryResult>;
+}
+
+export { type ActionEvent, type BaseEventMetadata, type ChatSettings, type ChatSettingsCreatedEnvelope, type ChatSettingsDeletedEnvelope, type ChatSettingsQueryBuilder, type ChatSettingsQueryResult, type ChatSettingsUpdatedEnvelope, type CreateChatSettingsRequest, type CreateChatSettingsResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DeleteChatSettingsRequest, type DeleteChatSettingsResponse, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetChatSettingsRequest, type GetChatSettingsResponse, type IdentificationData, type IdentificationDataIdOneOf, type MessageEnvelope, type QueryChatSettingsRequest, type QueryChatSettingsResponse, type RestoreInfo, SortOrder, type SortOrderWithLiterals, type Sorting, type UpdateChatSettings, type UpdateChatSettingsRequest, type UpdateChatSettingsResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createChatSettings, deleteChatSettings, getChatSettings, onChatSettingsCreated, onChatSettingsDeleted, onChatSettingsUpdated, queryChatSettings, updateChatSettings };