@wix/auto_sdk_forms_interactive-form-sessions 1.0.13 → 1.0.14

package/build/internal/es/meta.d.mts

@@ -502,6 +502,492 @@ interface SendUserMessageStreamedResponse {
      */
     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;
+}
+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 message role. */
+    UNKNOWN_ROLE = "UNKNOWN_ROLE",
+    /** Message from the user. */
+    USER = "USER",
+    /** Message from the AI assistant. */
+    ASSISTANT = "ASSISTANT",
+    /** Function call message. */
+    FUNCTION_CALL = "FUNCTION_CALL",
+    /** Function call output message. */
+    FUNCTION_CALL_OUTPUT = "FUNCTION_CALL_OUTPUT",
+    /** Message from the developer/system. */
+    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 {
+    /** Whether request processing was 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;
+}
+/** Request to report a conversation for quality assurance. */
+interface ReportConversationRequest {
+    /**
+     * Interactive form session ID to report.
+     * @format GUID
+     */
+    interactiveFormSessionId?: string;
+    /**
+     * Details about the issue or feedback.
+     * @minLength 1
+     * @maxLength 10000
+     */
+    description?: string;
+    /**
+     * Viewer debug URL of the conversation
+     * @format WEB_URL
+     */
+    viewerDebugUrl?: string;
+}
+/** Response confirming conversation report submission. */
+interface ReportConversationResponse {
+    /** Whether the report was successfully created. */
+    success?: boolean | null;
+    /**
+     * Error message.
+     * @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 {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+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.
+     */
+    currentEntityAsJson?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntityAsJson?: string | null;
+}
+interface ActionEvent {
+    bodyAsJson?: 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>;
+};
 
 type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
     getUrl: (context: any) => string;
@@ -522,4 +1008,4 @@ declare function sendUserMessageStreamed(): __PublicMethodMetaInfo<'POST', {
     interactiveFormSessionId: string;
 }, SendUserMessageStreamedRequest$1, SendUserMessageStreamedRequest, SendUserMessageStreamedResponse$1, SendUserMessageStreamedResponse>;
 
-export { type __PublicMethodMetaInfo, createInteractiveFormSession, createInteractiveFormSessionStreamed, sendUserMessage, sendUserMessageStreamed };
+export { type AcknowledgmentResponse as AcknowledgmentResponseOriginal, type ActionEvent as ActionEventOriginal, type AssistantOptions as AssistantOptionsOriginal, type Call as CallOriginal, type CallToolsRequest as CallToolsRequestOriginal, type CallToolsResponse as CallToolsResponseOriginal, ChunkType as ChunkTypeOriginal, type ChunkTypeWithLiterals as ChunkTypeWithLiteralsOriginal, type ClientTime as ClientTimeOriginal, type ContextMessageOptionsOneOf as ContextMessageOptionsOneOfOriginal, type ContextMessage as ContextMessageOriginal, type ConverseRequest as ConverseRequestOriginal, type ConverseRequestRequestOneOf as ConverseRequestRequestOneOfOriginal, type ConverseResponse as ConverseResponseOriginal, type ConverseResponseResponseOneOf as ConverseResponseResponseOneOfOriginal, type CreateInteractiveFormSessionRequest as CreateInteractiveFormSessionRequestOriginal, type CreateInteractiveFormSessionResponse as CreateInteractiveFormSessionResponseOriginal, type CreateInteractiveFormSessionStreamedRequest as CreateInteractiveFormSessionStreamedRequestOriginal, type CreateInteractiveFormSessionStreamedResponse as CreateInteractiveFormSessionStreamedResponseOriginal, type CustomValue as CustomValueOriginal, type DebugDetails as DebugDetailsOriginal, type DeveloperOptions as DeveloperOptionsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EndOfResponseDetails as EndOfResponseDetailsOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ErrorDetails as ErrorDetailsOriginal, type FileUploadDetails as FileUploadDetailsOriginal, type FunctionCallOptions as FunctionCallOptionsOriginal, type FunctionCallOutputOptions as FunctionCallOutputOptionsOriginal, type GetStateRequest as GetStateRequestOriginal, type GetStateResponse as GetStateResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ImportantTextDetails as ImportantTextDetailsOriginal, type InteractiveFormSession as InteractiveFormSessionOriginal, type InteractiveFormSessionResponseChunkOfOneOf as InteractiveFormSessionResponseChunkOfOneOfOriginal, type InteractiveFormSessionResponseChunk as InteractiveFormSessionResponseChunkOriginal, type MeaningfulInput as MeaningfulInputOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MultiSelectInputDetails as MultiSelectInputDetailsOriginal, type NumberInputDetails as NumberInputDetailsOriginal, type NumberRangeLimitEndOneOf as NumberRangeLimitEndOneOfOriginal, type NumberRangeLimit as NumberRangeLimitOriginal, type Option as OptionOriginal, type OutputInteractiveFormSessionStreamedRequest as OutputInteractiveFormSessionStreamedRequestOriginal, type OutputInteractiveFormSessionStreamedResponse as OutputInteractiveFormSessionStreamedResponseOriginal, type RelayAssistantMessageRequest as RelayAssistantMessageRequestOriginal, type ReportConversationRequest as ReportConversationRequestOriginal, type ReportConversationResponse as ReportConversationResponseOriginal, type Response as ResponseOriginal, type RestoreInfo as RestoreInfoOriginal, Role as RoleOriginal, type RoleWithLiterals as RoleWithLiteralsOriginal, type SendUserMessageApplicationErrors as SendUserMessageApplicationErrorsOriginal, type SendUserMessageRequest as SendUserMessageRequestOriginal, type SendUserMessageResponse as SendUserMessageResponseOriginal, type SendUserMessageStreamedApplicationErrors as SendUserMessageStreamedApplicationErrorsOriginal, type SendUserMessageStreamedRequest as SendUserMessageStreamedRequestOriginal, type SendUserMessageStreamedResponse as SendUserMessageStreamedResponseOriginal, type SeparatorDetails as SeparatorDetailsOriginal, type SignatureDetails as SignatureDetailsOriginal, type SingleSelectInputDetails as SingleSelectInputDetailsOriginal, Style as StyleOriginal, type StyleWithLiterals as StyleWithLiteralsOriginal, type SubmissionDetails as SubmissionDetailsOriginal, type TextDataDetails as TextDataDetailsOriginal, type TextDetails as TextDetailsOriginal, type Tool as ToolOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type Usage as UsageOriginal, type UsageRequest as UsageRequestOriginal, type UserOptions as UserOptionsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, createInteractiveFormSession, createInteractiveFormSessionStreamed, sendUserMessage, sendUserMessageStreamed };

package/build/internal/es/meta.mjs

@@ -213,6 +213,53 @@ function sendUserMessageStreamed(payload) {
   return __sendUserMessageStreamed;
 }
 
+// src/forms-ai-v1-interactive-form-session-interactive-form-sessions.types.ts
+var ChunkType = /* @__PURE__ */ ((ChunkType2) => {
+  ChunkType2["UNKNOWN_CHUNK_TYPE"] = "UNKNOWN_CHUNK_TYPE";
+  ChunkType2["TEXT"] = "TEXT";
+  ChunkType2["TEXT_DATA"] = "TEXT_DATA";
+  ChunkType2["MULTI_SELECT_INPUT"] = "MULTI_SELECT_INPUT";
+  ChunkType2["NUMBER_INPUT"] = "NUMBER_INPUT";
+  ChunkType2["SEPARATOR"] = "SEPARATOR";
+  ChunkType2["SINGLE_SELECT_INPUT"] = "SINGLE_SELECT_INPUT";
+  ChunkType2["ERROR"] = "ERROR";
+  ChunkType2["SUBMISSION"] = "SUBMISSION";
+  ChunkType2["IMPORTANT_TEXT"] = "IMPORTANT_TEXT";
+  ChunkType2["DEBUG"] = "DEBUG";
+  ChunkType2["END_OF_RESPONSE"] = "END_OF_RESPONSE";
+  ChunkType2["FILE_UPLOAD"] = "FILE_UPLOAD";
+  ChunkType2["SIGNATURE"] = "SIGNATURE";
+  return ChunkType2;
+})(ChunkType || {});
+var Style = /* @__PURE__ */ ((Style2) => {
+  Style2["UNKNOWN_STYLE"] = "UNKNOWN_STYLE";
+  Style2["NORMAL"] = "NORMAL";
+  Style2["BOLD"] = "BOLD";
+  return Style2;
+})(Style || {});
+var Type = /* @__PURE__ */ ((Type2) => {
+  Type2["UNKNOWN_TYPE"] = "UNKNOWN_TYPE";
+  Type2["PARAGRAPH"] = "PARAGRAPH";
+  return Type2;
+})(Type || {});
+var Role = /* @__PURE__ */ ((Role2) => {
+  Role2["UNKNOWN_ROLE"] = "UNKNOWN_ROLE";
+  Role2["USER"] = "USER";
+  Role2["ASSISTANT"] = "ASSISTANT";
+  Role2["FUNCTION_CALL"] = "FUNCTION_CALL";
+  Role2["FUNCTION_CALL_OUTPUT"] = "FUNCTION_CALL_OUTPUT";
+  Role2["DEVELOPER"] = "DEVELOPER";
+  return Role2;
+})(Role || {});
+var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
+  WebhookIdentityType2["UNKNOWN"] = "UNKNOWN";
+  WebhookIdentityType2["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+  WebhookIdentityType2["MEMBER"] = "MEMBER";
+  WebhookIdentityType2["WIX_USER"] = "WIX_USER";
+  WebhookIdentityType2["APP"] = "APP";
+  return WebhookIdentityType2;
+})(WebhookIdentityType || {});
+
 // src/forms-ai-v1-interactive-form-session-interactive-form-sessions.meta.ts
 function createInteractiveFormSession2() {
   const payload = {};
@@ -297,6 +344,11 @@ function sendUserMessageStreamed2() {
   };
 }
 export {
+  ChunkType as ChunkTypeOriginal,
+  Role as RoleOriginal,
+  Style as StyleOriginal,
+  Type as TypeOriginal,
+  WebhookIdentityType as WebhookIdentityTypeOriginal,
   createInteractiveFormSession2 as createInteractiveFormSession,
   createInteractiveFormSessionStreamed2 as createInteractiveFormSessionStreamed,
   sendUserMessage2 as sendUserMessage,