@wix/auto_sdk_automations_action-catalog 1.0.5 → 1.0.7

package/build/cjs/{automations-actioncatalog-v1-action-action-catalog.universal-CrVo0pBg.d.ts → index.typings.d.ts}

@@ -1,3 +1,5 @@
+import { NonNullablePaths } from '@wix/sdk-types';
+
 interface Action {
     /**
      * Action ID.
@@ -331,20 +333,20 @@ interface ResolveActionsRequest {
     query?: QueryV2;
 }
 interface QueryV2 extends QueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
+    /** Paging options to limit and offset the number of items. */
     paging?: Paging;
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
     /**
      * Filter object.
      *
-     * Learn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
      */
     filter?: Record<string, any> | null;
     /**
      * Sort object.
      *
-     * Learn more about the [sort section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
      */
     sort?: Sorting[];
     /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
@@ -354,7 +356,7 @@ interface QueryV2 extends QueryV2PagingMethodOneOf {
 }
 /** @oneof */
 interface QueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
+    /** Paging options to limit and offset the number of items. */
     paging?: Paging;
     /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
     cursorPaging?: CursorPaging;
@@ -676,6 +678,17 @@ declare enum WebhookIdentityType {
 }
 /** @enumType */
 type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+type ActionNonNullablePaths = `appId` | `actionKey` | `implementedMethods.validateConfiguration` | `implementedMethods.duplicateInputMapping` | `implementedMethods.generateApplicationAutomationInputMapping` | `implementedMethods.getQuotaInfo` | `implementedMethods.onBeforeSave` | `implementedMethods.onReset` | `implementedMethods.generateActionInputMappingFromTemplate` | `implementedMethods.onRemove` | `implementedMethods.getDynamicInputSchema` | `implementedMethods.mergeInputMappings` | `implementedMethods.getDynamicOutputSchema` | `executionType` | `interfaceConfiguration.type`;
+/**
+ * Create an action
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.action.actionKey
+ * @requiredField options.action.appId
+ * @returns The created action
+ * @fqn wix.automations.actioncatalog.v1.ActionCatalogService.CreateAction
+ */
+declare function createAction(options?: NonNullablePaths<CreateActionOptions, `action.actionKey` | `action.appId`>): Promise<NonNullablePaths<Action, ActionNonNullablePaths>>;
 interface CreateActionOptions {
     /** The action to create */
     action?: Action;
@@ -687,6 +700,18 @@ interface CreateActionOptions {
      */
     baseUri?: string;
 }
+/**
+ * Create a new version for a trigger, update the latest version of the component to point to this trigger
+ * @param _id - Action ID.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @requiredField options.action.actionKey
+ * @requiredField options.action.appId
+ * @returns Action Configuration
+ * @fqn wix.automations.actioncatalog.v1.ActionCatalogService.UpdateAction
+ */
+declare function updateAction(_id: string, options?: NonNullablePaths<UpdateActionOptions, `action.actionKey` | `action.appId`>): Promise<NonNullablePaths<Action, ActionNonNullablePaths>>;
 interface UpdateActionOptions {
     action: {
         /**
@@ -765,6 +790,17 @@ interface UpdateActionOptions {
     /** Action spec info */
     actionSpecInfo?: ActionSpecInfo;
 }
+/**
+ * Delete a trigger by app id and key
+ * @param actionAppId - The action App Id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField actionAppId
+ * @requiredField options
+ * @requiredField options.actionKey
+ * @fqn wix.automations.actioncatalog.v1.ActionCatalogService.DeleteAction
+ */
+declare function deleteAction(actionAppId: string, options: NonNullablePaths<DeleteActionOptions, `actionKey`>): Promise<void>;
 interface DeleteActionOptions {
     /**
      * Action Configuration key
@@ -773,12 +809,39 @@ interface DeleteActionOptions {
      */
     actionKey: string;
 }
+/**
+ * Returns action configuration by action key
+ * @public
+ * @documentationMaturity preview
+ * @requiredField identifiers
+ * @requiredField identifiers.actionKey
+ * @requiredField identifiers.appId
+ * @permissionId AUTOMATIONS.ACTION_READ
+ * @applicableIdentity APP
+ * @returns Action Configuration
+ * @fqn wix.automations.actioncatalog.v1.ActionCatalogService.GetRuntimeAction
+ */
+declare function getRuntimeAction(identifiers: NonNullablePaths<GetRuntimeActionIdentifiers, `actionKey` | `appId`>): Promise<NonNullablePaths<Action, ActionNonNullablePaths>>;
 interface GetRuntimeActionIdentifiers {
     /** The action App Id */
     appId: string;
     /** Action key */
     actionKey: string;
 }
+/**
+ * Returns action dynamic schema and ui schema for the given action key and input mapping (action config)
+ * @param appId - The App ID of the action's owner.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField appId
+ * @requiredField options
+ * @requiredField options.actionKey
+ * @requiredField options.inputMapping
+ * @permissionId AUTOMATIONS.ACTION_READ
+ * @applicableIdentity APP
+ * @fqn wix.automations.actioncatalog.v1.ActionCatalogService.GetActionDynamicInputSchema
+ */
+declare function getActionDynamicInputSchema(appId: string, options: NonNullablePaths<GetActionDynamicInputSchemaOptions, `actionKey` | `inputMapping`>): Promise<GetActionDynamicInputSchemaResponse>;
 interface GetActionDynamicInputSchemaOptions {
     /**
      * Action key as defined in an app's action configuration in the Wix Developers Center.
@@ -794,10 +857,41 @@ interface GetActionDynamicInputSchemaOptions {
      */
     inputMapping: Record<string, any> | null;
 }
+/**
+ * Returns action configurations that are installed on the site and exposed to Wix users.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId AUTOMATIONS.ACTION_READ
+ * @applicableIdentity APP
+ * @fqn wix.automations.actioncatalog.v1.ActionCatalogService.ResolveActions
+ */
+declare function resolveActions(options?: ResolveActionsOptions): Promise<NonNullablePaths<ResolveActionsResponse, {
+    [P in ActionNonNullablePaths]: `actions.${number}.${P}`;
+}[ActionNonNullablePaths]>>;
 interface ResolveActionsOptions {
     /** Query options. */
     query?: QueryV2;
 }
+/**
+ * Get action input mapping copy
+ * The main use case is to call this method from the automations editor, when the user wants to copy an action. So
+ * this method is getting an input mapping of an existing action and returns a changed input mapping. It's changing
+ * the input mapping by passing it through the SPI endpoint of `DuplicateInputMapping` in the case that this SPI
+ * endpoint is implemented.
+ * A possible usage is by `triggered-email` action - Wix Emails need to change the `messageId` inside the input mapping
+ * so such that the `messageId` stays unique across multiple actions.
+ * @param appId - Action app id
+ * @public
+ * @documentationMaturity preview
+ * @requiredField appId
+ * @requiredField options
+ * @requiredField options.actionKey
+ * @requiredField options.inputMapping
+ * @permissionId AUTOMATIONS.ACTION_COPY
+ * @applicableIdentity APP
+ * @fqn wix.automations.actioncatalog.v1.ActionCatalogService.CopyInputMapping
+ */
+declare function copyInputMapping(appId: string, options: NonNullablePaths<CopyInputMappingOptions, `actionKey` | `inputMapping`>): Promise<CopyInputMappingResponse>;
 interface CopyInputMappingOptions {
     /**
      * Action key
@@ -807,6 +901,20 @@ interface CopyInputMappingOptions {
     /** Action input mapping */
     inputMapping: Record<string, any> | null;
 }
+/**
+ * Returns action dynamic output schema for the given action key and the [users] action configuration
+ * @param appId - The App ID of the action's owner.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField appId
+ * @requiredField options
+ * @requiredField options.actionKey
+ * @requiredField options.inputMapping
+ * @permissionId AUTOMATIONS.ACTION_READ
+ * @applicableIdentity APP
+ * @fqn wix.automations.actioncatalog.v1.ActionCatalogService.GetActionDynamicOutputSchema
+ */
+declare function getActionDynamicOutputSchema(appId: string, options: NonNullablePaths<GetActionDynamicOutputSchemaOptions, `actionKey` | `inputMapping`>): Promise<GetActionDynamicOutputSchemaResponse>;
 interface GetActionDynamicOutputSchemaOptions {
     /**
      * Action key as defined in an app's action configuration in the Wix Developers Center.
@@ -823,5 +931,16 @@ interface GetActionDynamicOutputSchemaOptions {
      */
     inputMapping: Record<string, any> | null;
 }
+/**
+ * Returns action dynamic output schema for the given actions
+ * @param actionsInputMappings - list of actions details which will be used to generate the output schemas
+ * @public
+ * @documentationMaturity preview
+ * @requiredField actionsInputMappings
+ * @permissionId AUTOMATIONS.ACTION_READ
+ * @applicableIdentity APP
+ * @fqn wix.automations.actioncatalog.v1.ActionCatalogService.BulkGetActionDynamicOutputSchemas
+ */
+declare function bulkGetActionDynamicOutputSchemas(actionsInputMappings: ActionInputMappings[]): Promise<NonNullablePaths<BulkGetActionDynamicOutputSchemasResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
 
-export { type GetActionDynamicOutputSchemaRequest as $, type Action as A, type BulkGetActionDynamicOutputSchemasResponse as B, type CreateActionOptions as C, type DeleteActionOptions as D, ExecutionType as E, type FocalPoint as F, type GetRuntimeActionIdentifiers as G, type MigrateComponentToActionResponse as H, type ImplementedMethods as I, type GetRuntimeActionRequest as J, type GetRuntimeActionResponse as K, type GetActionDynamicInputSchemaRequest as L, type Metadata as M, type ResolveActionsRequest as N, type QueryV2PagingMethodOneOf as O, type Sorting as P, type QueryV2 as Q, type ResolveActionsOptions as R, SourceType as S, Type as T, type UpdateActionOptions as U, type Paging as V, WebhookIdentityType as W, type CursorPaging as X, type PagingMetadataV2 as Y, type Cursors as Z, type CopyInputMappingRequest as _, type GetActionDynamicInputSchemaOptions as a, type BulkGetActionDynamicOutputSchemasRequest as a0, type ItemMetadata as a1, type ApplicationError as a2, type BulkActionOutputSchemaResult as a3, type BulkActionMetadata as a4, type DomainEvent as a5, type DomainEventBodyOneOf as a6, type EntityCreatedEvent as a7, type RestoreInfo as a8, type EntityUpdatedEvent as a9, type EntityDeletedEvent as aa, type ActionEvent as ab, type MessageEnvelope as ac, type IdentificationData as ad, type IdentificationDataIdOneOf as ae, type GetActionDynamicInputSchemaResponse as b, type ResolveActionsResponse as c, type CopyInputMappingOptions as d, type CopyInputMappingResponse as e, type GetActionDynamicOutputSchemaOptions as f, type GetActionDynamicOutputSchemaResponse as g, type ActionInputMappings as h, ExperimentActionType as i, SortOrder as j, type WidgetComponentOptions as k, type GenericOptions as l, type WixApiOptions as m, type InterfaceConfiguration as n, type InterfaceConfigurationOptionsOneOf as o, type Source as p, type SourceOptionsOneOf as q, type RetryExperimentCreation as r, type ActionSpecInfo as s, type CreateActionRequest as t, type CreateActionResponse as u, type UpdateActionRequest as v, type UpdateActionResponse as w, type DeleteActionRequest as x, type DeleteActionResponse as y, type MigrateComponentToActionRequest as z };
+export { type Action, type ActionEvent, type ActionInputMappings, type ActionSpecInfo, type ApplicationError, type BulkActionMetadata, type BulkActionOutputSchemaResult, type BulkGetActionDynamicOutputSchemasRequest, type BulkGetActionDynamicOutputSchemasResponse, type CopyInputMappingOptions, type CopyInputMappingRequest, type CopyInputMappingResponse, type CreateActionOptions, type CreateActionRequest, type CreateActionResponse, type CursorPaging, type Cursors, type DeleteActionOptions, type DeleteActionRequest, type DeleteActionResponse, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, ExecutionType, type ExecutionTypeWithLiterals, ExperimentActionType, type ExperimentActionTypeWithLiterals, type FocalPoint, type GenericOptions, type GetActionDynamicInputSchemaOptions, type GetActionDynamicInputSchemaRequest, type GetActionDynamicInputSchemaResponse, type GetActionDynamicOutputSchemaOptions, type GetActionDynamicOutputSchemaRequest, type GetActionDynamicOutputSchemaResponse, type GetRuntimeActionIdentifiers, type GetRuntimeActionRequest, type GetRuntimeActionResponse, type IdentificationData, type IdentificationDataIdOneOf, type ImplementedMethods, type InterfaceConfiguration, type InterfaceConfigurationOptionsOneOf, type ItemMetadata, type MessageEnvelope, type Metadata, type MigrateComponentToActionRequest, type MigrateComponentToActionResponse, type Paging, type PagingMetadataV2, type QueryV2, type QueryV2PagingMethodOneOf, type ResolveActionsOptions, type ResolveActionsRequest, type ResolveActionsResponse, type RestoreInfo, type RetryExperimentCreation, SortOrder, type SortOrderWithLiterals, type Sorting, type Source, type SourceOptionsOneOf, SourceType, type SourceTypeWithLiterals, Type, type TypeWithLiterals, type UpdateActionOptions, type UpdateActionRequest, type UpdateActionResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WidgetComponentOptions, type WixApiOptions, bulkGetActionDynamicOutputSchemas, copyInputMapping, createAction, deleteAction, getActionDynamicInputSchema, getActionDynamicOutputSchema, getRuntimeAction, resolveActions, updateAction };