@wix/auto_sdk_forms_interactive-form-sessions 1.0.0

package/build/internal/cjs/index.typings.d.ts

@@ -0,0 +1,1082 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
+interface InteractiveFormSession {
+    /**
+     * Form completion id
+     * @format GUID
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Form id to complete
+     * @format GUID
+     */
+    formId?: string;
+}
+interface CreateInteractiveFormSessionRequest {
+    /**
+     * Interactive form session to be created.
+     * @format GUID
+     */
+    formId: string;
+    /**
+     * ID of the prompt to use.
+     * @format GUID
+     */
+    promptId?: string | null;
+    /**
+     * Sets current values for the form fields, used to pre-fill the form (e.g. when switching from classic form to chat form).
+     * These values are merged with existing values in the session.
+     * For example, if user has already filled field "Name" and then sends a message with current_values containing
+     * "LastName" field, "Name" will remain unchanged. If user sends a message with current_values containing "Name" field,
+     * it will override the existing value.
+     */
+    currentValues?: Record<string, any> | null;
+    /**
+     * Dry run mode. The completion will not conduct submission if set to true. Intended for preview mode.
+     * @immutable
+     */
+    dryRun?: boolean;
+    /**
+     * Current date-time string with user's timezone offset in ISO 8601 format (e.g. "2023-10-01T12:00:00+03:00").
+     * @minLength 1
+     * @maxLength 200
+     */
+    currentTime?: string | null;
+    /** Current date-time of api client */
+    clientTime?: ClientTime;
+}
+interface ClientTime {
+    /**
+     * Current date-time string UTC in ISO 8601 format (e.g. "2023-10-01T12:00:00Z).
+     * @minLength 1
+     * @maxLength 200
+     */
+    currentTime?: string | null;
+    /**
+     * Current time zone in format like: "Europe/Vilnius".
+     * @minLength 1
+     * @maxLength 50
+     */
+    timeZone?: string | null;
+}
+interface CreateInteractiveFormSessionResponse {
+    /** Interactive form session created */
+    interactiveFormSession?: InteractiveFormSession;
+    /** Assistant response chunks for the session */
+    responseChunks?: InteractiveFormSessionResponseChunk[];
+}
+interface InteractiveFormSessionResponseChunk extends InteractiveFormSessionResponseChunkOfOneOf {
+    /** Text chunk to display to the user */
+    textDetails?: TextDetails;
+    /** Data chunk which was extracted from the user input */
+    textDataDetails?: TextDataDetails;
+    /** Multi-select input chunk to display to the user */
+    multiSelectInputDetails?: MultiSelectInputDetails;
+    /** Number input chunk to display to the user */
+    numberInputDetails?: NumberInputDetails;
+    /** Separator chunk (e.g. paragraph break) */
+    separatorDetails?: SeparatorDetails;
+    /** Single-select input chunk to display to the user */
+    singleSelectInputDetails?: SingleSelectInputDetails;
+    /** Exception happened during processing, contains error message and details */
+    errorDetails?: ErrorDetails;
+    /** Form submission event acknowledgment chunk, contains submission id and checkout id if applicable */
+    submissionDetails?: SubmissionDetails;
+    /** Important information which might be used to derive TEXT_DATA */
+    importantTextDetails?: ImportantTextDetails;
+    /** Debug information, what tools were called, what was the input, etc. */
+    debugDetails?: DebugDetails;
+    /** End of chunk stream, indicates that no more chunks will be sent */
+    endOfResponseDetails?: EndOfResponseDetails;
+    /** Multi-select input chunk to display to the user */
+    fileUploadDetails?: FileUploadDetails;
+    /** Multi-select input chunk to display to the user */
+    signatureDetails?: SignatureDetails;
+    /** Type of the chunk */
+    chunkType?: ChunkTypeWithLiterals;
+    /** Marks which part of the original user input deemed meaningful by the assistant for extracting the answer. */
+    meaningfulInput?: MeaningfulInput;
+}
+/** @oneof */
+interface InteractiveFormSessionResponseChunkOfOneOf {
+    /** Text chunk to display to the user */
+    textDetails?: TextDetails;
+    /** Data chunk which was extracted from the user input */
+    textDataDetails?: TextDataDetails;
+    /** Multi-select input chunk to display to the user */
+    multiSelectInputDetails?: MultiSelectInputDetails;
+    /** Number input chunk to display to the user */
+    numberInputDetails?: NumberInputDetails;
+    /** Separator chunk (e.g. paragraph break) */
+    separatorDetails?: SeparatorDetails;
+    /** Single-select input chunk to display to the user */
+    singleSelectInputDetails?: SingleSelectInputDetails;
+    /** Exception happened during processing, contains error message and details */
+    errorDetails?: ErrorDetails;
+    /** Form submission event acknowledgment chunk, contains submission id and checkout id if applicable */
+    submissionDetails?: SubmissionDetails;
+    /** Important information which might be used to derive TEXT_DATA */
+    importantTextDetails?: ImportantTextDetails;
+    /** Debug information, what tools were called, what was the input, etc. */
+    debugDetails?: DebugDetails;
+    /** End of chunk stream, indicates that no more chunks will be sent */
+    endOfResponseDetails?: EndOfResponseDetails;
+    /** Multi-select input chunk to display to the user */
+    fileUploadDetails?: FileUploadDetails;
+    /** Multi-select input chunk to display to the user */
+    signatureDetails?: SignatureDetails;
+}
+declare enum ChunkType {
+    UNKNOWN_CHUNK_TYPE = "UNKNOWN_CHUNK_TYPE",
+    /** Text chunk to display to the user */
+    TEXT = "TEXT",
+    /** Data chunk which was extracted from the user input */
+    TEXT_DATA = "TEXT_DATA",
+    /** Multi-select input chunk to display to the user */
+    MULTI_SELECT_INPUT = "MULTI_SELECT_INPUT",
+    /** Number input chunk to display to the user */
+    NUMBER_INPUT = "NUMBER_INPUT",
+    SEPARATOR = "SEPARATOR",
+    /** Single-select input chunk to display to the user */
+    SINGLE_SELECT_INPUT = "SINGLE_SELECT_INPUT",
+    /** Exception happened during processing, contains error message and details */
+    ERROR = "ERROR",
+    /** Form submission event acknowledgment chunk, contains submission id and checkout id if applicable */
+    SUBMISSION = "SUBMISSION",
+    /** Important information which might be used to derive TEXT_DATA */
+    IMPORTANT_TEXT = "IMPORTANT_TEXT",
+    /** Debug information, what tools were called, what was the input, etc. */
+    DEBUG = "DEBUG",
+    /** End of chunk stream, indicates that no more chunks will be sent */
+    END_OF_RESPONSE = "END_OF_RESPONSE",
+    /** File Upload input chunk to display to the user */
+    FILE_UPLOAD = "FILE_UPLOAD",
+    /** Signature input chunk to display to the user */
+    SIGNATURE = "SIGNATURE"
+}
+/** @enumType */
+type ChunkTypeWithLiterals = ChunkType | 'UNKNOWN_CHUNK_TYPE' | 'TEXT' | 'TEXT_DATA' | 'MULTI_SELECT_INPUT' | 'NUMBER_INPUT' | 'SEPARATOR' | 'SINGLE_SELECT_INPUT' | 'ERROR' | 'SUBMISSION' | 'IMPORTANT_TEXT' | 'DEBUG' | 'END_OF_RESPONSE' | 'FILE_UPLOAD' | 'SIGNATURE';
+interface TextDetails {
+    /**
+     * Text content to display
+     * @minLength 1
+     * @maxLength 10000
+     */
+    text?: string;
+    /** Style of the text (e.g. normal, bold) */
+    style?: StyleWithLiterals;
+}
+declare enum Style {
+    UNKNOWN_STYLE = "UNKNOWN_STYLE",
+    NORMAL = "NORMAL",
+    BOLD = "BOLD"
+}
+/** @enumType */
+type StyleWithLiterals = Style | 'UNKNOWN_STYLE' | 'NORMAL' | 'BOLD';
+interface TextDataDetails {
+    /**
+     * Target field key for the data
+     * @minLength 1
+     * @maxLength 200
+     */
+    fieldTarget?: string;
+    /**
+     * Text content to display
+     * @minLength 1
+     * @maxLength 10000
+     */
+    text?: string;
+    /** "Technical" value used for the form submission, e.g. if it's boolean, value will be `true` or `false` */
+    value?: any;
+    /**
+     * User friendly string to display user's submitted value, e.g. if it's boolean, value will be "Yes" or "No"
+     * @minLength 1
+     * @maxLength 10000
+     */
+    displayValue?: string;
+}
+interface MultiSelectInputDetails {
+    /**
+     * Field id for the multi-select input
+     * @minLength 1
+     * @maxLength 200
+     */
+    fieldTarget?: string;
+    /**
+     * Options available for selection
+     * @minSize 1
+     * @maxSize 100
+     */
+    options?: Option[];
+    /** If present, then user is allowed to provide custom values */
+    allowedCustomValue?: CustomValue;
+}
+interface Option {
+    /**
+     * Value to be submitted for the option
+     * @minLength 1
+     * @maxLength 10000
+     */
+    value?: string;
+    /**
+     * Label to display for the option
+     * @minLength 1
+     * @maxLength 10000
+     */
+    label?: string;
+}
+interface CustomValue {
+    /**
+     * Description of expected custom value
+     * @maxLength 10000
+     */
+    description?: string;
+}
+interface NumberInputDetails {
+    /**
+     * Field id for the number input
+     * @minLength 1
+     * @maxLength 200
+     */
+    fieldTarget?: string;
+    /** Limit min and max range for the input */
+    rangeLimit?: NumberRangeLimit;
+    /** If provided, only multiples of this value are accepted */
+    multipleOf?: number | null;
+}
+interface NumberRangeLimit extends NumberRangeLimitEndOneOf {
+    /** Maximum value of the range (inclusive) */
+    maxInclusiveValue?: number | null;
+    /** Maximum value of the range (exclusive) */
+    maxExclusiveValue?: number | null;
+    /** Minimum value of the range (inclusive) */
+    minInclusiveValue?: number | null;
+}
+/** @oneof */
+interface NumberRangeLimitEndOneOf {
+    /** Maximum value of the range (inclusive) */
+    maxInclusiveValue?: number | null;
+    /** Maximum value of the range (exclusive) */
+    maxExclusiveValue?: number | null;
+}
+interface SeparatorDetails {
+    /** Type of separator (e.g. paragraph) */
+    type?: TypeWithLiterals;
+}
+declare enum Type {
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    PARAGRAPH = "PARAGRAPH"
+}
+/** @enumType */
+type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'PARAGRAPH';
+interface SingleSelectInputDetails {
+    /**
+     * Field id for the single-select input
+     * @minLength 1
+     * @maxLength 200
+     */
+    fieldTarget?: string;
+    /**
+     * Options available for selection
+     * @minSize 1
+     * @maxSize 100
+     */
+    options?: Option[];
+    /** If present, then user is allowed to provide custom values */
+    allowedCustomValue?: CustomValue;
+}
+interface ErrorDetails {
+    /**
+     * Error message text
+     * @minLength 1
+     * @maxLength 1000
+     */
+    messageText?: string;
+}
+interface SubmissionDetails {
+    /**
+     * Created submission id
+     * @format GUID
+     */
+    submissionId?: string;
+    /**
+     * ID of the ecom checkout related to submission (only applicable if a form has payments).
+     * @format GUID
+     * @readonly
+     */
+    checkoutId?: string | null;
+}
+interface ImportantTextDetails {
+    /**
+     * Target field key for the important text
+     * @minLength 1
+     * @maxLength 200
+     */
+    fieldTarget?: string;
+    /**
+     * Important text content to display
+     * @minLength 1
+     * @maxLength 10000
+     */
+    text?: string;
+}
+interface DebugDetails {
+    /** Debug data for troubleshooting */
+    data?: Record<string, any> | null;
+}
+interface EndOfResponseDetails {
+    /** If the response was successful */
+    success?: boolean;
+}
+interface FileUploadDetails {
+    /**
+     * Field id for the file upload input
+     * @minLength 1
+     * @maxLength 200
+     */
+    fieldTarget?: string;
+}
+interface SignatureDetails {
+    /**
+     * Field id for the signature input
+     * @minLength 1
+     * @maxLength 200
+     */
+    fieldTarget?: string;
+}
+interface MeaningfulInput {
+    /**
+     * Character offset (0-indexed) from the start of the user input to where the meaningful text starts
+     * @max 10000
+     */
+    startOffset?: number;
+    /**
+     * Length of the meaningful text in characters
+     * @max 10000
+     */
+    length?: number;
+}
+interface CreateInteractiveFormSessionStreamedRequest {
+    /**
+     * Interactive form session to be created.
+     * @format GUID
+     */
+    formId: string;
+    /**
+     * ID of the prompt to use.
+     * @format GUID
+     */
+    promptId?: string | null;
+    /** Sets current values for the form fields, used to pre-fill the form (e.g. when switching from classic form to chat form). */
+    currentValues?: Record<string, any> | null;
+    /**
+     * Dry run mode. The completion will not conduct submission if set to true. Intended for preview mode.
+     * @immutable
+     */
+    dryRun?: boolean;
+    /**
+     * Current date-time string with user's timezone offset in ISO 8601 format (e.g. "2023-10-01T12:00:00+03:00").
+     * @minLength 1
+     * @maxLength 200
+     */
+    currentTime?: string | null;
+    /** Current date-time of api client */
+    clientTime?: ClientTime;
+}
+interface CreateInteractiveFormSessionStreamedResponse {
+    /** Assistant response chunk */
+    responseChunk?: InteractiveFormSessionResponseChunk;
+    /** Interactive form session. Only returned on the 1st chunk of the stream. */
+    interactiveFormSession?: InteractiveFormSession;
+}
+interface SendUserMessageRequest {
+    /**
+     * Interactive form session id
+     * @format GUID
+     */
+    interactiveFormSessionId: string;
+    /**
+     * User input to add to the session
+     * @maxLength 10000
+     */
+    input?: string | null;
+    /**
+     * Sets current values for the form fields, used to pre-fill the form (e.g. when switching from classic form to chat form).
+     * These values are merged with existing values in the session.
+     * For example, if user has already filled field "Name" and then sends a message with current_values containing
+     * "LastName" field, "Name" will remain unchanged. If user sends a message with current_values containing "Name" field,
+     * it will override the existing value.
+     */
+    currentValues?: Record<string, any> | null;
+}
+interface SendUserMessageResponse {
+    /** Interactive form session after input is added */
+    interactiveFormSession?: InteractiveFormSession;
+    /** Assistant response chunks for the input */
+    responseChunks?: InteractiveFormSessionResponseChunk[];
+}
+interface SendUserMessageStreamedRequest {
+    /**
+     * Interactive form session id
+     * @format GUID
+     */
+    interactiveFormSessionId: string;
+    /**
+     * User input to add to the session
+     * @maxLength 10000
+     */
+    input?: string | null;
+    /**
+     * Sets current values for the form fields, used to pre-fill the form (e.g. when switching from classic form to chat form).
+     * These values are merged with existing values in the session.
+     * For example, if user has already filled field "Name" and then sends a message with current_values containing
+     * "LastName" field, "Name" will remain unchanged. If user sends a message with current_values containing "Name" field,
+     * it will override the existing value.
+     */
+    currentValues?: Record<string, any> | null;
+}
+interface SendUserMessageStreamedResponse {
+    /** Assistant response chunk for the streamed input */
+    responseChunk?: InteractiveFormSessionResponseChunk;
+    /** Interactive form session after input is added */
+    interactiveFormSession?: InteractiveFormSession;
+}
+interface ConverseRequest extends ConverseRequestRequestOneOf {
+    /** Get state request */
+    getStateRequest?: GetStateRequest;
+    /** Call tools request */
+    callToolsRequest?: CallToolsRequest;
+    /** Relay assistant message request */
+    relayAssistantMessage?: RelayAssistantMessageRequest;
+    /** Usage request */
+    usageRequest?: UsageRequest;
+    /**
+     * Request ID used for mapping the request to the response
+     * @format GUID
+     */
+    requestId?: string;
+}
+/** @oneof */
+interface ConverseRequestRequestOneOf {
+    /** Get state request */
+    getStateRequest?: GetStateRequest;
+    /** Call tools request */
+    callToolsRequest?: CallToolsRequest;
+    /** Relay assistant message request */
+    relayAssistantMessage?: RelayAssistantMessageRequest;
+    /** Usage request */
+    usageRequest?: UsageRequest;
+}
+interface GetStateRequest {
+    /**
+     * Interactive form session ID
+     * @format GUID
+     */
+    interactiveFormSessionId?: string;
+    /**
+     * System prompt ID
+     * @format GUID
+     */
+    promptId?: string;
+}
+interface CallToolsRequest {
+    /**
+     * Tool calls to be executed
+     * @maxSize 100
+     */
+    calls?: Call[];
+    /**
+     * Interactive form session ID
+     * @format GUID
+     */
+    interactiveFormSessionId?: string;
+}
+interface Call {
+    /** Tool call arguments */
+    args?: Record<string, any> | null;
+    /**
+     * Tool name to call
+     * @minLength 1
+     * @maxLength 100
+     */
+    toolName?: string;
+    /**
+     * Tool call ID
+     * @minLength 1
+     * @maxLength 100
+     */
+    callId?: string;
+}
+interface RelayAssistantMessageRequest {
+    /**
+     * Assistant message text
+     * @minLength 1
+     * @maxLength 10000
+     */
+    text?: string;
+    /**
+     * Interactive form session ID
+     * @format GUID
+     */
+    interactiveFormSessionId?: string;
+}
+interface UsageRequest {
+    /** Microcents spent for the request */
+    microcentsSpent?: string;
+    /**
+     * Interactive form session ID
+     * @format GUID
+     */
+    interactiveFormSessionId?: string;
+    /**
+     * Form ID
+     * @format GUID
+     */
+    formId?: string;
+    /** Usage details for the request */
+    usage?: Usage;
+}
+interface Usage {
+    /**
+     * Model name used for the session
+     * @minLength 1
+     * @maxLength 100
+     */
+    model?: string | null;
+    /** The total number of tokens in the Response including input and output text and audio tokens */
+    totalTokens?: string;
+    /** The number of input tokens used in the Response, including text and audio tokens. */
+    inputTokens?: string;
+    /** The number of output tokens sent in the Response, including text and audio tokens. */
+    outputTokens?: string;
+    /** Token details */
+    tokenDetails?: Record<string, any> | null;
+}
+interface ConverseResponse extends ConverseResponseResponseOneOf {
+    /** Get state response */
+    getStateResponse?: GetStateResponse;
+    /** Call tools response */
+    callToolsResponse?: CallToolsResponse;
+    /** Assistant response chunk */
+    responseChunk?: InteractiveFormSessionResponseChunk;
+    /** Response that signals that the request has been processed */
+    acknowledgmentResponse?: AcknowledgmentResponse;
+    /**
+     * Request ID used for mapping the request to the response
+     * @format GUID
+     */
+    requestId?: string;
+}
+/** @oneof */
+interface ConverseResponseResponseOneOf {
+    /** Get state response */
+    getStateResponse?: GetStateResponse;
+    /** Call tools response */
+    callToolsResponse?: CallToolsResponse;
+    /** Assistant response chunk */
+    responseChunk?: InteractiveFormSessionResponseChunk;
+    /** Response that signals that the request has been processed */
+    acknowledgmentResponse?: AcknowledgmentResponse;
+}
+interface GetStateResponse {
+    /**
+     * Available tools for the session
+     * @maxSize 100
+     */
+    tools?: Tool[];
+    /**
+     * Context messages for the session
+     * @maxSize 10000
+     */
+    contextMessages?: ContextMessage[];
+    /**
+     * System prompt text
+     * @minLength 1
+     * @maxLength 10000
+     */
+    systemPrompt?: string;
+    /**
+     * Form ID for the session
+     * @format GUID
+     */
+    formId?: string;
+    /**
+     * Submission state message
+     * @maxLength 10000
+     */
+    submissionStateMessage?: string | null;
+}
+interface Tool {
+    /**
+     * Tool type identifier
+     * @minLength 1
+     * @maxLength 10000
+     */
+    type?: string;
+    /**
+     * Tool name
+     * @minLength 1
+     * @maxLength 10000
+     */
+    name?: string | null;
+    /**
+     * Tool description
+     * @minLength 1
+     * @maxLength 10000
+     */
+    description?: string | null;
+    /** Tool parameters */
+    parameters?: Record<string, any> | null;
+}
+interface ContextMessage extends ContextMessageOptionsOneOf {
+    /** User options */
+    userOptions?: UserOptions;
+    /** Assistant options */
+    assistantOptions?: AssistantOptions;
+    /** Function call options */
+    functionCallOptions?: FunctionCallOptions;
+    /** Function call output options */
+    functionCallOutputOptions?: FunctionCallOutputOptions;
+    /** Developer options */
+    developerOptions?: DeveloperOptions;
+    /** Role of the message sender */
+    role?: RoleWithLiterals;
+}
+/** @oneof */
+interface ContextMessageOptionsOneOf {
+    /** User options */
+    userOptions?: UserOptions;
+    /** Assistant options */
+    assistantOptions?: AssistantOptions;
+    /** Function call options */
+    functionCallOptions?: FunctionCallOptions;
+    /** Function call output options */
+    functionCallOutputOptions?: FunctionCallOutputOptions;
+    /** Developer options */
+    developerOptions?: DeveloperOptions;
+}
+declare enum Role {
+    UNKNOWN_ROLE = "UNKNOWN_ROLE",
+    USER = "USER",
+    ASSISTANT = "ASSISTANT",
+    FUNCTION_CALL = "FUNCTION_CALL",
+    FUNCTION_CALL_OUTPUT = "FUNCTION_CALL_OUTPUT",
+    DEVELOPER = "DEVELOPER"
+}
+/** @enumType */
+type RoleWithLiterals = Role | 'UNKNOWN_ROLE' | 'USER' | 'ASSISTANT' | 'FUNCTION_CALL' | 'FUNCTION_CALL_OUTPUT' | 'DEVELOPER';
+interface UserOptions {
+    /**
+     * User message content
+     * @minLength 1
+     * @maxLength 10000
+     */
+    content?: string;
+}
+interface AssistantOptions {
+    /**
+     * Assistant message content
+     * @minLength 1
+     * @maxLength 10000
+     */
+    content?: string;
+}
+interface FunctionCallOptions {
+    /**
+     * Call name
+     * @minLength 1
+     * @maxLength 100
+     */
+    functionName?: string;
+    /** Call arguments */
+    args?: Record<string, any> | null;
+    /**
+     * Call ID
+     * @minLength 1
+     * @maxLength 100
+     */
+    callId?: string;
+}
+interface FunctionCallOutputOptions {
+    /** Call output data */
+    output?: Record<string, any> | null;
+    /**
+     * Call ID
+     * @minLength 1
+     * @maxLength 100
+     */
+    callId?: string;
+}
+interface DeveloperOptions {
+    /**
+     * Developer message content
+     * @minLength 1
+     * @maxLength 10000
+     */
+    content?: string;
+}
+interface CallToolsResponse {
+    /**
+     * Tool call responses
+     * @maxSize 100
+     */
+    responses?: Response[];
+}
+interface Response {
+    /**
+     * Tool call ID
+     * @minLength 1
+     * @maxLength 100
+     */
+    callId?: string;
+    /** Tool call response data */
+    response?: Record<string, any> | null;
+}
+interface AcknowledgmentResponse {
+    /** If request processing is successful */
+    success?: boolean;
+}
+interface OutputInteractiveFormSessionStreamedRequest {
+    /**
+     * Interactive form session id to output
+     * @format GUID
+     */
+    interactiveFormSessionId?: string;
+}
+interface OutputInteractiveFormSessionStreamedResponse {
+    /** Interactive form session id */
+    interactiveFormSession?: InteractiveFormSession;
+    /** Assistant response chunk for the session */
+    responseChunk?: InteractiveFormSessionResponseChunk;
+}
+interface ReportConversationRequest {
+    /**
+     * Interactive form session id
+     * @format GUID
+     */
+    interactiveFormSessionId?: string;
+    /**
+     * Report description
+     * @minLength 1
+     * @maxLength 10000
+     */
+    description?: string;
+    /**
+     * Viewer debug URL of the conversation
+     * @format WEB_URL
+     */
+    viewerDebugUrl?: string;
+}
+interface ReportConversationResponse {
+    /** If the report was successfully created */
+    success?: boolean | null;
+    /**
+     * Error message if the report creation failed
+     * @maxLength 10000
+     */
+    errorMessage?: 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 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';
+/** @docsIgnore */
+type SendUserMessageApplicationErrors = {
+    code?: 'EMPTY_REQUEST';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type SendUserMessageStreamedApplicationErrors = {
+    code?: 'EMPTY_REQUEST';
+    description?: string;
+    data?: Record<string, any>;
+};
+/**
+ * Starts interactive form session for a given form
+ * @param formId - Interactive form session to be created.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField formId
+ * @permissionId WIX_FORMS.CREATE_INTERACTIVE_FORM_SESSION
+ * @applicableIdentity APP
+ * @returns Interactive form session created
+ * @fqn wix.forms.ai.v1.InteractiveFormSessionsService.CreateInteractiveFormSession
+ */
+declare function createInteractiveFormSession(formId: string, options?: CreateInteractiveFormSessionOptions): Promise<NonNullablePaths<InteractiveFormSession, `_id` | `formId`, 2>>;
+interface CreateInteractiveFormSessionOptions {
+    /**
+     * ID of the prompt to use.
+     * @format GUID
+     */
+    promptId?: string | null;
+    /**
+     * Sets current values for the form fields, used to pre-fill the form (e.g. when switching from classic form to chat form).
+     * These values are merged with existing values in the session.
+     * For example, if user has already filled field "Name" and then sends a message with current_values containing
+     * "LastName" field, "Name" will remain unchanged. If user sends a message with current_values containing "Name" field,
+     * it will override the existing value.
+     */
+    currentValues?: Record<string, any> | null;
+    /**
+     * Dry run mode. The completion will not conduct submission if set to true. Intended for preview mode.
+     * @immutable
+     */
+    dryRun?: boolean;
+    /**
+     * Current date-time string with user's timezone offset in ISO 8601 format (e.g. "2023-10-01T12:00:00+03:00").
+     * @minLength 1
+     * @maxLength 200
+     */
+    currentTime?: string | null;
+    /** Current date-time of api client */
+    clientTime?: ClientTime;
+}
+/**
+ * Starts interactive form session for a given form with streamed response
+ * @param formId - Interactive form session to be created.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField formId
+ * @permissionId WIX_FORMS.CREATE_INTERACTIVE_FORM_SESSION
+ * @applicableIdentity APP
+ * @fqn wix.forms.ai.v1.InteractiveFormSessionsService.CreateInteractiveFormSessionStreamed
+ */
+declare function createInteractiveFormSessionStreamed(formId: string, options?: CreateInteractiveFormSessionStreamedOptions): Promise<NonNullablePaths<CreateInteractiveFormSessionStreamedResponse, `responseChunk.textDetails.text` | `responseChunk.textDetails.style` | `responseChunk.textDataDetails.fieldTarget` | `responseChunk.textDataDetails.text` | `responseChunk.textDataDetails.displayValue` | `responseChunk.multiSelectInputDetails.fieldTarget` | `responseChunk.multiSelectInputDetails.options` | `responseChunk.multiSelectInputDetails.options.${number}.value` | `responseChunk.multiSelectInputDetails.options.${number}.label` | `responseChunk.multiSelectInputDetails.allowedCustomValue.description` | `responseChunk.numberInputDetails.fieldTarget` | `responseChunk.separatorDetails.type` | `responseChunk.singleSelectInputDetails.fieldTarget` | `responseChunk.singleSelectInputDetails.options` | `responseChunk.errorDetails.messageText` | `responseChunk.submissionDetails.submissionId` | `responseChunk.importantTextDetails.fieldTarget` | `responseChunk.importantTextDetails.text` | `responseChunk.endOfResponseDetails.success` | `responseChunk.fileUploadDetails.fieldTarget` | `responseChunk.signatureDetails.fieldTarget` | `responseChunk.chunkType` | `responseChunk.meaningfulInput.startOffset` | `responseChunk.meaningfulInput.length` | `interactiveFormSession._id` | `interactiveFormSession.formId`, 6>>;
+interface CreateInteractiveFormSessionStreamedOptions {
+    /**
+     * ID of the prompt to use.
+     * @format GUID
+     */
+    promptId?: string | null;
+    /** Sets current values for the form fields, used to pre-fill the form (e.g. when switching from classic form to chat form). */
+    currentValues?: Record<string, any> | null;
+    /**
+     * Dry run mode. The completion will not conduct submission if set to true. Intended for preview mode.
+     * @immutable
+     */
+    dryRun?: boolean;
+    /**
+     * Current date-time string with user's timezone offset in ISO 8601 format (e.g. "2023-10-01T12:00:00+03:00").
+     * @minLength 1
+     * @maxLength 200
+     */
+    currentTime?: string | null;
+    /** Current date-time of api client */
+    clientTime?: ClientTime;
+}
+/**
+ * Sends user message to the interactive form session
+ * @param interactiveFormSessionId - Interactive form session id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField interactiveFormSessionId
+ * @permissionId WIX_FORMS.SEND_USER_MESSAGE_TO_INTERACTIVE_FORM_SESSION
+ * @applicableIdentity APP
+ * @fqn wix.forms.ai.v1.InteractiveFormSessionsService.SendUserMessage
+ */
+declare function sendUserMessage(interactiveFormSessionId: string, options?: SendUserMessageOptions): Promise<NonNullablePaths<SendUserMessageResponse, `interactiveFormSession._id` | `interactiveFormSession.formId` | `responseChunks` | `responseChunks.${number}.textDetails.text` | `responseChunks.${number}.textDetails.style` | `responseChunks.${number}.textDataDetails.fieldTarget` | `responseChunks.${number}.textDataDetails.text` | `responseChunks.${number}.textDataDetails.displayValue` | `responseChunks.${number}.multiSelectInputDetails.fieldTarget` | `responseChunks.${number}.multiSelectInputDetails.allowedCustomValue.description` | `responseChunks.${number}.numberInputDetails.fieldTarget` | `responseChunks.${number}.separatorDetails.type` | `responseChunks.${number}.singleSelectInputDetails.fieldTarget` | `responseChunks.${number}.errorDetails.messageText` | `responseChunks.${number}.submissionDetails.submissionId` | `responseChunks.${number}.importantTextDetails.fieldTarget` | `responseChunks.${number}.importantTextDetails.text` | `responseChunks.${number}.endOfResponseDetails.success` | `responseChunks.${number}.fileUploadDetails.fieldTarget` | `responseChunks.${number}.signatureDetails.fieldTarget` | `responseChunks.${number}.chunkType` | `responseChunks.${number}.meaningfulInput.startOffset` | `responseChunks.${number}.meaningfulInput.length`, 6> & {
+    __applicationErrorsType?: SendUserMessageApplicationErrors;
+}>;
+interface SendUserMessageOptions {
+    /**
+     * User input to add to the session
+     * @maxLength 10000
+     */
+    input?: string | null;
+    /**
+     * Sets current values for the form fields, used to pre-fill the form (e.g. when switching from classic form to chat form).
+     * These values are merged with existing values in the session.
+     * For example, if user has already filled field "Name" and then sends a message with current_values containing
+     * "LastName" field, "Name" will remain unchanged. If user sends a message with current_values containing "Name" field,
+     * it will override the existing value.
+     */
+    currentValues?: Record<string, any> | null;
+}
+/**
+ * Sends user message to the interactive form session with streamed response
+ * @param interactiveFormSessionId - Interactive form session id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField interactiveFormSessionId
+ * @permissionId WIX_FORMS.SEND_USER_MESSAGE_TO_INTERACTIVE_FORM_SESSION
+ * @applicableIdentity APP
+ * @fqn wix.forms.ai.v1.InteractiveFormSessionsService.SendUserMessageStreamed
+ */
+declare function sendUserMessageStreamed(interactiveFormSessionId: string, options?: SendUserMessageStreamedOptions): Promise<NonNullablePaths<SendUserMessageStreamedResponse, `responseChunk.textDetails.text` | `responseChunk.textDetails.style` | `responseChunk.textDataDetails.fieldTarget` | `responseChunk.textDataDetails.text` | `responseChunk.textDataDetails.displayValue` | `responseChunk.multiSelectInputDetails.fieldTarget` | `responseChunk.multiSelectInputDetails.options` | `responseChunk.multiSelectInputDetails.options.${number}.value` | `responseChunk.multiSelectInputDetails.options.${number}.label` | `responseChunk.multiSelectInputDetails.allowedCustomValue.description` | `responseChunk.numberInputDetails.fieldTarget` | `responseChunk.separatorDetails.type` | `responseChunk.singleSelectInputDetails.fieldTarget` | `responseChunk.singleSelectInputDetails.options` | `responseChunk.errorDetails.messageText` | `responseChunk.submissionDetails.submissionId` | `responseChunk.importantTextDetails.fieldTarget` | `responseChunk.importantTextDetails.text` | `responseChunk.endOfResponseDetails.success` | `responseChunk.fileUploadDetails.fieldTarget` | `responseChunk.signatureDetails.fieldTarget` | `responseChunk.chunkType` | `responseChunk.meaningfulInput.startOffset` | `responseChunk.meaningfulInput.length` | `interactiveFormSession._id` | `interactiveFormSession.formId`, 6> & {
+    __applicationErrorsType?: SendUserMessageStreamedApplicationErrors;
+}>;
+interface SendUserMessageStreamedOptions {
+    /**
+     * User input to add to the session
+     * @maxLength 10000
+     */
+    input?: string | null;
+    /**
+     * Sets current values for the form fields, used to pre-fill the form (e.g. when switching from classic form to chat form).
+     * These values are merged with existing values in the session.
+     * For example, if user has already filled field "Name" and then sends a message with current_values containing
+     * "LastName" field, "Name" will remain unchanged. If user sends a message with current_values containing "Name" field,
+     * it will override the existing value.
+     */
+    currentValues?: Record<string, any> | null;
+}
+/**
+ * Report conversation for quality assurance
+ * @public
+ * @documentationMaturity preview
+ * @permissionId WIX_FORMS.REPORT_INTERACTIVE_FORM_SESSION
+ * @fqn wix.forms.ai.v1.InteractiveFormSessionsService.ReportConversation
+ */
+declare function reportConversation(options?: ReportConversationOptions): Promise<ReportConversationResponse>;
+interface ReportConversationOptions {
+    /**
+     * Interactive form session id
+     * @format GUID
+     */
+    interactiveFormSessionId?: string;
+    /**
+     * Report description
+     * @minLength 1
+     * @maxLength 10000
+     */
+    description?: string;
+    /**
+     * Viewer debug URL of the conversation
+     * @format WEB_URL
+     */
+    viewerDebugUrl?: string;
+}
+
+export { type AcknowledgmentResponse, type ActionEvent, type AssistantOptions, type Call, type CallToolsRequest, type CallToolsResponse, ChunkType, type ChunkTypeWithLiterals, type ClientTime, type ContextMessage, type ContextMessageOptionsOneOf, type ConverseRequest, type ConverseRequestRequestOneOf, type ConverseResponse, type ConverseResponseResponseOneOf, type CreateInteractiveFormSessionOptions, type CreateInteractiveFormSessionRequest, type CreateInteractiveFormSessionResponse, type CreateInteractiveFormSessionStreamedOptions, type CreateInteractiveFormSessionStreamedRequest, type CreateInteractiveFormSessionStreamedResponse, type CustomValue, type DebugDetails, type DeveloperOptions, type DomainEvent, type DomainEventBodyOneOf, type EndOfResponseDetails, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ErrorDetails, type FileUploadDetails, type FunctionCallOptions, type FunctionCallOutputOptions, type GetStateRequest, type GetStateResponse, type IdentificationData, type IdentificationDataIdOneOf, type ImportantTextDetails, type InteractiveFormSession, type InteractiveFormSessionResponseChunk, type InteractiveFormSessionResponseChunkOfOneOf, type MeaningfulInput, type MessageEnvelope, type MultiSelectInputDetails, type NumberInputDetails, type NumberRangeLimit, type NumberRangeLimitEndOneOf, type Option, type OutputInteractiveFormSessionStreamedRequest, type OutputInteractiveFormSessionStreamedResponse, type RelayAssistantMessageRequest, type ReportConversationOptions, type ReportConversationRequest, type ReportConversationResponse, type Response, type RestoreInfo, Role, type RoleWithLiterals, type SendUserMessageApplicationErrors, type SendUserMessageOptions, type SendUserMessageRequest, type SendUserMessageResponse, type SendUserMessageStreamedApplicationErrors, type SendUserMessageStreamedOptions, type SendUserMessageStreamedRequest, type SendUserMessageStreamedResponse, type SeparatorDetails, type SignatureDetails, type SingleSelectInputDetails, Style, type StyleWithLiterals, type SubmissionDetails, type TextDataDetails, type TextDetails, type Tool, Type, type TypeWithLiterals, type Usage, type UsageRequest, type UserOptions, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, createInteractiveFormSession, createInteractiveFormSessionStreamed, reportConversation, sendUserMessage, sendUserMessageStreamed };