@wix/auto_sdk_forms_interactive-form-sessions 1.0.0

package/build/internal/cjs/meta.d.ts

@@ -0,0 +1,494 @@
+import { CreateInteractiveFormSessionRequest as CreateInteractiveFormSessionRequest$1, CreateInteractiveFormSessionResponse as CreateInteractiveFormSessionResponse$1, CreateInteractiveFormSessionStreamedRequest as CreateInteractiveFormSessionStreamedRequest$1, CreateInteractiveFormSessionStreamedResponse as CreateInteractiveFormSessionStreamedResponse$1, SendUserMessageRequest as SendUserMessageRequest$1, SendUserMessageResponse as SendUserMessageResponse$1, SendUserMessageStreamedRequest as SendUserMessageStreamedRequest$1, SendUserMessageStreamedResponse as SendUserMessageStreamedResponse$1, ReportConversationRequest as ReportConversationRequest$1, ReportConversationResponse as ReportConversationResponse$1 } from './index.typings.js';
+import '@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 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;
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function createInteractiveFormSession(): __PublicMethodMetaInfo<'POST', {}, CreateInteractiveFormSessionRequest$1, CreateInteractiveFormSessionRequest, CreateInteractiveFormSessionResponse$1, CreateInteractiveFormSessionResponse>;
+declare function createInteractiveFormSessionStreamed(): __PublicMethodMetaInfo<'POST', {}, CreateInteractiveFormSessionStreamedRequest$1, CreateInteractiveFormSessionStreamedRequest, CreateInteractiveFormSessionStreamedResponse$1, CreateInteractiveFormSessionStreamedResponse>;
+declare function sendUserMessage(): __PublicMethodMetaInfo<'POST', {
+    interactiveFormSessionId: string;
+}, SendUserMessageRequest$1, SendUserMessageRequest, SendUserMessageResponse$1, SendUserMessageResponse>;
+declare function sendUserMessageStreamed(): __PublicMethodMetaInfo<'POST', {
+    interactiveFormSessionId: string;
+}, SendUserMessageStreamedRequest$1, SendUserMessageStreamedRequest, SendUserMessageStreamedResponse$1, SendUserMessageStreamedResponse>;
+declare function reportConversation(): __PublicMethodMetaInfo<'POST', {}, ReportConversationRequest$1, ReportConversationRequest, ReportConversationResponse$1, ReportConversationResponse>;
+
+export { type __PublicMethodMetaInfo, createInteractiveFormSession, createInteractiveFormSessionStreamed, reportConversation, sendUserMessage, sendUserMessageStreamed };