@wix/auto_sdk_automations_action-catalog 1.0.17 → 1.0.18

package/build/cjs/meta.d.ts

@@ -86,10 +86,51 @@ declare enum Type {
 }
 /** @enumType */
 type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'GENERIC';
+interface WidgetComponentOptions {
+    /**
+     * Widget component name.
+     * @minLength 1
+     * @maxLength 80
+     */
+    componentName?: string;
+}
 interface GenericOptions {
     /** UI schema. */
     uiSchema?: Record<string, any> | null;
 }
+declare enum SourceType {
+    UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
+    /** The input/output schemas are constructed by developers in Dev Center using the self-service flow */
+    DEV_CENTER = "DEV_CENTER",
+    /** The input/output schemas are derived from an existing Wix API through the API-to-Action feature */
+    WIX_API = "WIX_API"
+}
+/** @enumType */
+type SourceTypeWithLiterals = SourceType | 'UNKNOWN_SOURCE_TYPE' | 'DEV_CENTER' | 'WIX_API';
+interface WixApiOptions {
+    /**
+     * Service entity fqdn
+     * @minLength 1
+     * @maxLength 100
+     */
+    serviceEntityFqdn?: string;
+    /**
+     * The service providing the API
+     * @minLength 1
+     * @maxLength 200
+     */
+    serviceName?: string;
+    /**
+     * The method name
+     * @minLength 1
+     * @maxLength 200
+     */
+    methodName?: string;
+}
+interface Metadata {
+    /** Whether the action is only shown to advanced mode users (Wix staff). */
+    hidden?: boolean;
+}
 interface ImplementedMethods {
     /** Whether Validate Configuration is implemented. */
     validateConfiguration?: boolean;
@@ -160,6 +201,43 @@ interface Image {
      */
     filename?: string | null;
 }
+interface FocalPoint {
+    /** X-coordinate of the focal point. */
+    x?: number;
+    /** Y-coordinate of the focal point. */
+    y?: number;
+    /** crop by height */
+    height?: number | null;
+    /** crop by width */
+    width?: number | null;
+}
+interface Source extends SourceOptionsOneOf {
+    /** Wix API options */
+    wixApiOptions?: WixApiOptions;
+    /** the source type */
+    type?: SourceTypeWithLiterals;
+}
+/** @oneof */
+interface SourceOptionsOneOf {
+    /** Wix API options */
+    wixApiOptions?: WixApiOptions;
+}
+interface RetryExperimentCreation {
+    /** action spec info */
+    actionSpecInfo?: ActionSpecInfo;
+    /**
+     * app id
+     * @format GUID
+     */
+    appId?: string;
+    /** experiment action type */
+    experimentActionType?: ExperimentActionTypeWithLiterals;
+    /**
+     * component id
+     * @format GUID
+     */
+    componentId?: string;
+}
 interface ActionSpecInfo {
     /**
      * Spec to conduct on for the automation
@@ -178,6 +256,14 @@ interface ActionSpecInfo {
      */
     experimentVersion?: number;
 }
+declare enum ExperimentActionType {
+    UNKNOWN_ACTION = "UNKNOWN_ACTION",
+    CREATE_COMPONENT = "CREATE_COMPONENT",
+    UPDATE_COMPONENT = "UPDATE_COMPONENT",
+    DELETE_COMPONENT = "DELETE_COMPONENT"
+}
+/** @enumType */
+type ExperimentActionTypeWithLiterals = ExperimentActionType | 'UNKNOWN_ACTION' | 'CREATE_COMPONENT' | 'UPDATE_COMPONENT' | 'DELETE_COMPONENT';
 interface CreateActionRequest {
     /** The action to create */
     action?: Action;
@@ -218,6 +304,20 @@ interface DeleteActionRequest {
 }
 interface DeleteActionResponse {
 }
+interface MigrateComponentToActionRequest {
+    /**
+     * The action App Id
+     * @format GUID
+     */
+    appId?: string;
+    /**
+     * The component id
+     * @format GUID
+     */
+    componentId?: string;
+}
+interface MigrateComponentToActionResponse {
+}
 interface GetRuntimeActionRequest {
     /** The action App Id */
     appId: string;
@@ -470,6 +570,203 @@ interface BulkActionMetadata {
     /** Number of failures without details because detailed failure threshold was exceeded. */
     undetailedFailures?: number;
 }
+interface GenerateInputMappingFromIntentRequest {
+    /**
+     * The App ID of the action's owner
+     * @format GUID
+     */
+    appId?: string;
+    /**
+     * Action key as defined in an app's action configuration
+     * @minLength 5
+     * @maxLength 100
+     */
+    actionKey?: string;
+    /**
+     * User's/Agent's natural language intent describing the desired action configuration
+     * @minLength 1
+     * @maxLength 10000
+     */
+    intent?: string;
+    /**
+     * Conversation identifier for maintaining context across multiple requests.
+     * This represents the entire conversation ID with the clients agent.
+     * @format GUID
+     */
+    conversationId?: string;
+    /** The accumulated payload schema for an action. */
+    actionSchema?: Record<string, any> | null;
+}
+interface GenerateInputMappingFromIntentResponse extends GenerateInputMappingFromIntentResponseStatusInfoOneOf {
+    /** The generated input mapping conforming to the action's input schema */
+    inputMappingGeneratedInfo?: InputMappingGeneratedInfo;
+    /** Human-readable feedback for the user to refine their intent and structured reason for the failure */
+    additionalInformationRequiredInfo?: AdditionalInformationRequiredInfo;
+    /** Type of result returned */
+    status?: StatusWithLiterals;
+}
+/** @oneof */
+interface GenerateInputMappingFromIntentResponseStatusInfoOneOf {
+    /** The generated input mapping conforming to the action's input schema */
+    inputMappingGeneratedInfo?: InputMappingGeneratedInfo;
+    /** Human-readable feedback for the user to refine their intent and structured reason for the failure */
+    additionalInformationRequiredInfo?: AdditionalInformationRequiredInfo;
+}
+declare enum Status {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    INPUT_MAPPING_GENERATED = "INPUT_MAPPING_GENERATED",
+    ADDITIONAL_INFORMATION_REQUIRED = "ADDITIONAL_INFORMATION_REQUIRED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'INPUT_MAPPING_GENERATED' | 'ADDITIONAL_INFORMATION_REQUIRED';
+interface InputMappingGeneratedInfo {
+    /** The generated action input mapping conforming to the action's input schema */
+    inputMapping?: Record<string, any> | null;
+}
+interface AdditionalInformationRequiredInfo {
+    /**
+     * Human-readable feedback for the user to refine their intent
+     * @minLength 1
+     * @maxLength 10000
+     */
+    feedback?: string;
+}
+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';
 
 type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
     getUrl: (context: any) => string;
@@ -496,4 +793,4 @@ declare function copyInputMapping(): __PublicMethodMetaInfo<'POST', {}, CopyInpu
 declare function getActionDynamicOutputSchema(): __PublicMethodMetaInfo<'POST', {}, GetActionDynamicOutputSchemaRequest$1, GetActionDynamicOutputSchemaRequest, GetActionDynamicOutputSchemaResponse$1, GetActionDynamicOutputSchemaResponse>;
 declare function bulkGetActionDynamicOutputSchemas(): __PublicMethodMetaInfo<'POST', {}, BulkGetActionDynamicOutputSchemasRequest$1, BulkGetActionDynamicOutputSchemasRequest, BulkGetActionDynamicOutputSchemasResponse$1, BulkGetActionDynamicOutputSchemasResponse>;
 
-export { type __PublicMethodMetaInfo, bulkGetActionDynamicOutputSchemas, copyInputMapping, createAction, deleteAction, getActionDynamicInputSchema, getActionDynamicOutputSchema, getRuntimeAction, resolveActions, updateAction };
+export { type ActionEvent as ActionEventOriginal, type ActionInputMappings as ActionInputMappingsOriginal, type Action as ActionOriginal, type ActionSpecInfo as ActionSpecInfoOriginal, type AdditionalInformationRequiredInfo as AdditionalInformationRequiredInfoOriginal, type ApplicationError as ApplicationErrorOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkActionOutputSchemaResult as BulkActionOutputSchemaResultOriginal, type BulkGetActionDynamicOutputSchemasRequest as BulkGetActionDynamicOutputSchemasRequestOriginal, type BulkGetActionDynamicOutputSchemasResponse as BulkGetActionDynamicOutputSchemasResponseOriginal, type CopyInputMappingRequest as CopyInputMappingRequestOriginal, type CopyInputMappingResponse as CopyInputMappingResponseOriginal, type CreateActionRequest as CreateActionRequestOriginal, type CreateActionResponse as CreateActionResponseOriginal, type CursorPaging as CursorPagingOriginal, type Cursors as CursorsOriginal, type DeleteActionRequest as DeleteActionRequestOriginal, type DeleteActionResponse as DeleteActionResponseOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, ExecutionType as ExecutionTypeOriginal, type ExecutionTypeWithLiterals as ExecutionTypeWithLiteralsOriginal, ExperimentActionType as ExperimentActionTypeOriginal, type ExperimentActionTypeWithLiterals as ExperimentActionTypeWithLiteralsOriginal, type FocalPoint as FocalPointOriginal, type GenerateInputMappingFromIntentRequest as GenerateInputMappingFromIntentRequestOriginal, type GenerateInputMappingFromIntentResponse as GenerateInputMappingFromIntentResponseOriginal, type GenerateInputMappingFromIntentResponseStatusInfoOneOf as GenerateInputMappingFromIntentResponseStatusInfoOneOfOriginal, type GenericOptions as GenericOptionsOriginal, type GetActionDynamicInputSchemaRequest as GetActionDynamicInputSchemaRequestOriginal, type GetActionDynamicInputSchemaResponse as GetActionDynamicInputSchemaResponseOriginal, type GetActionDynamicOutputSchemaRequest as GetActionDynamicOutputSchemaRequestOriginal, type GetActionDynamicOutputSchemaResponse as GetActionDynamicOutputSchemaResponseOriginal, type GetRuntimeActionRequest as GetRuntimeActionRequestOriginal, type GetRuntimeActionResponse as GetRuntimeActionResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImplementedMethods as ImplementedMethodsOriginal, type InputMappingGeneratedInfo as InputMappingGeneratedInfoOriginal, type InterfaceConfigurationOptionsOneOf as InterfaceConfigurationOptionsOneOfOriginal, type InterfaceConfiguration as InterfaceConfigurationOriginal, type ItemMetadata as ItemMetadataOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type Metadata as MetadataOriginal, type MigrateComponentToActionRequest as MigrateComponentToActionRequestOriginal, type MigrateComponentToActionResponse as MigrateComponentToActionResponseOriginal, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type ResolveActionsRequest as ResolveActionsRequestOriginal, type ResolveActionsResponse as ResolveActionsResponseOriginal, type RestoreInfo as RestoreInfoOriginal, type RetryExperimentCreation as RetryExperimentCreationOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type SourceOptionsOneOf as SourceOptionsOneOfOriginal, type Source as SourceOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, Type as TypeOriginal, type TypeWithLiterals as TypeWithLiteralsOriginal, type UpdateActionRequest as UpdateActionRequestOriginal, type UpdateActionResponse as UpdateActionResponseOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type WidgetComponentOptions as WidgetComponentOptionsOriginal, type WixApiOptions as WixApiOptionsOriginal, type __PublicMethodMetaInfo, bulkGetActionDynamicOutputSchemas, copyInputMapping, createAction, deleteAction, getActionDynamicInputSchema, getActionDynamicOutputSchema, getRuntimeAction, resolveActions, updateAction };

package/build/cjs/meta.js

@@ -20,6 +20,13 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // meta.ts
 var meta_exports = {};
 __export(meta_exports, {
+  ExecutionTypeOriginal: () => ExecutionType,
+  ExperimentActionTypeOriginal: () => ExperimentActionType,
+  SortOrderOriginal: () => SortOrder,
+  SourceTypeOriginal: () => SourceType,
+  StatusOriginal: () => Status,
+  TypeOriginal: () => Type,
+  WebhookIdentityTypeOriginal: () => WebhookIdentityType,
   bulkGetActionDynamicOutputSchemas: () => bulkGetActionDynamicOutputSchemas2,
   copyInputMapping: () => copyInputMapping2,
   createAction: () => createAction2,
@@ -400,6 +407,51 @@ function bulkGetActionDynamicOutputSchemas(payload) {
   return __bulkGetActionDynamicOutputSchemas;
 }
 
+// src/automations-actioncatalog-v1-action-action-catalog.types.ts
+var Type = /* @__PURE__ */ ((Type2) => {
+  Type2["UNKNOWN_TYPE"] = "UNKNOWN_TYPE";
+  Type2["GENERIC"] = "GENERIC";
+  return Type2;
+})(Type || {});
+var SourceType = /* @__PURE__ */ ((SourceType2) => {
+  SourceType2["UNKNOWN_SOURCE_TYPE"] = "UNKNOWN_SOURCE_TYPE";
+  SourceType2["DEV_CENTER"] = "DEV_CENTER";
+  SourceType2["WIX_API"] = "WIX_API";
+  return SourceType2;
+})(SourceType || {});
+var ExecutionType = /* @__PURE__ */ ((ExecutionType2) => {
+  ExecutionType2["UNKNOWN_EXECUTION_TYPE"] = "UNKNOWN_EXECUTION_TYPE";
+  ExecutionType2["SYNC"] = "SYNC";
+  ExecutionType2["ASYNC"] = "ASYNC";
+  return ExecutionType2;
+})(ExecutionType || {});
+var ExperimentActionType = /* @__PURE__ */ ((ExperimentActionType2) => {
+  ExperimentActionType2["UNKNOWN_ACTION"] = "UNKNOWN_ACTION";
+  ExperimentActionType2["CREATE_COMPONENT"] = "CREATE_COMPONENT";
+  ExperimentActionType2["UPDATE_COMPONENT"] = "UPDATE_COMPONENT";
+  ExperimentActionType2["DELETE_COMPONENT"] = "DELETE_COMPONENT";
+  return ExperimentActionType2;
+})(ExperimentActionType || {});
+var SortOrder = /* @__PURE__ */ ((SortOrder2) => {
+  SortOrder2["ASC"] = "ASC";
+  SortOrder2["DESC"] = "DESC";
+  return SortOrder2;
+})(SortOrder || {});
+var Status = /* @__PURE__ */ ((Status2) => {
+  Status2["UNKNOWN_STATUS"] = "UNKNOWN_STATUS";
+  Status2["INPUT_MAPPING_GENERATED"] = "INPUT_MAPPING_GENERATED";
+  Status2["ADDITIONAL_INFORMATION_REQUIRED"] = "ADDITIONAL_INFORMATION_REQUIRED";
+  return Status2;
+})(Status || {});
+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/automations-actioncatalog-v1-action-action-catalog.meta.ts
 function createAction2() {
   const payload = {};
@@ -571,6 +623,13 @@ function bulkGetActionDynamicOutputSchemas2() {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ExecutionTypeOriginal,
+  ExperimentActionTypeOriginal,
+  SortOrderOriginal,
+  SourceTypeOriginal,
+  StatusOriginal,
+  TypeOriginal,
+  WebhookIdentityTypeOriginal,
   bulkGetActionDynamicOutputSchemas,
   copyInputMapping,
   createAction,