@wix/auto_sdk_automations_action-catalog 1.0.2 → 1.0.4

package/build/index.d.mts

@@ -0,0 +1,94 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { C as CreateActionOptions, A as Action, U as UpdateActionOptions, D as DeleteActionOptions, G as GetRuntimeActionIdentifiers, a as GetActionDynamicInputSchemaOptions, b as GetActionDynamicInputSchemaResponse, R as ResolveActionsOptions, c as ResolveActionsResponse, d as CopyInputMappingOptions, e as CopyInputMappingResponse, f as GetActionDynamicOutputSchemaOptions, g as GetActionDynamicOutputSchemaResponse, h as ActionInputMappings, B as BulkGetActionDynamicOutputSchemasResponse } from './automations-actioncatalog-v1-action-action-catalog.universal-CrVo0pBg.mjs';
+export { ab as ActionEvent, s as ActionSpecInfo, a2 as ApplicationError, a4 as BulkActionMetadata, a3 as BulkActionOutputSchemaResult, a0 as BulkGetActionDynamicOutputSchemasRequest, _ as CopyInputMappingRequest, t as CreateActionRequest, u as CreateActionResponse, X as CursorPaging, Z as Cursors, x as DeleteActionRequest, y as DeleteActionResponse, a5 as DomainEvent, a6 as DomainEventBodyOneOf, a7 as EntityCreatedEvent, aa as EntityDeletedEvent, a9 as EntityUpdatedEvent, E as ExecutionType, i as ExperimentActionType, F as FocalPoint, l as GenericOptions, L as GetActionDynamicInputSchemaRequest, $ as GetActionDynamicOutputSchemaRequest, J as GetRuntimeActionRequest, K as GetRuntimeActionResponse, ad as IdentificationData, ae as IdentificationDataIdOneOf, I as ImplementedMethods, n as InterfaceConfiguration, o as InterfaceConfigurationOptionsOneOf, a1 as ItemMetadata, ac as MessageEnvelope, M as Metadata, z as MigrateComponentToActionRequest, H as MigrateComponentToActionResponse, V as Paging, Y as PagingMetadataV2, Q as QueryV2, O as QueryV2PagingMethodOneOf, N as ResolveActionsRequest, a8 as RestoreInfo, r as RetryExperimentCreation, j as SortOrder, P as Sorting, p as Source, q as SourceOptionsOneOf, S as SourceType, T as Type, v as UpdateActionRequest, w as UpdateActionResponse, W as WebhookIdentityType, k as WidgetComponentOptions, m as WixApiOptions } from './automations-actioncatalog-v1-action-action-catalog.universal-CrVo0pBg.mjs';
+
+declare function createAction$1(httpClient: HttpClient): CreateActionSignature;
+interface CreateActionSignature {
+    /**
+     * Create an action
+     * @returns The created action
+     */
+    (options?: CreateActionOptions | undefined): Promise<Action>;
+}
+declare function updateAction$1(httpClient: HttpClient): UpdateActionSignature;
+interface UpdateActionSignature {
+    /**
+     * Create a new version for a trigger, update the latest version of the component to point to this trigger
+     * @param - Action ID.
+     * @returns Action Configuration
+     */
+    (_id: string, options?: UpdateActionOptions | undefined): Promise<Action>;
+}
+declare function deleteAction$1(httpClient: HttpClient): DeleteActionSignature;
+interface DeleteActionSignature {
+    /**
+     * Delete a trigger by app id and key
+     * @param - The action App Id
+     */
+    (actionAppId: string, options: DeleteActionOptions): Promise<void>;
+}
+declare function getRuntimeAction$1(httpClient: HttpClient): GetRuntimeActionSignature;
+interface GetRuntimeActionSignature {
+    /**
+     * Returns action configuration by action key
+     * @returns Action Configuration
+     */
+    (identifiers: GetRuntimeActionIdentifiers): Promise<Action>;
+}
+declare function getActionDynamicInputSchema$1(httpClient: HttpClient): GetActionDynamicInputSchemaSignature;
+interface GetActionDynamicInputSchemaSignature {
+    /**
+     * Returns action dynamic schema and ui schema for the given action key and input mapping (action config)
+     * @param - The App ID of the action's owner.
+     */
+    (appId: string, options: GetActionDynamicInputSchemaOptions): Promise<GetActionDynamicInputSchemaResponse>;
+}
+declare function resolveActions$1(httpClient: HttpClient): ResolveActionsSignature;
+interface ResolveActionsSignature {
+    /**
+     * Returns action configurations that are installed on the site and exposed to Wix users.
+     */
+    (options?: ResolveActionsOptions | undefined): Promise<ResolveActionsResponse>;
+}
+declare function copyInputMapping$1(httpClient: HttpClient): CopyInputMappingSignature;
+interface CopyInputMappingSignature {
+    /**
+     * 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 - Action app id
+     */
+    (appId: string, options: CopyInputMappingOptions): Promise<CopyInputMappingResponse>;
+}
+declare function getActionDynamicOutputSchema$1(httpClient: HttpClient): GetActionDynamicOutputSchemaSignature;
+interface GetActionDynamicOutputSchemaSignature {
+    /**
+     * Returns action dynamic output schema for the given action key and the [users] action configuration
+     * @param - The App ID of the action's owner.
+     */
+    (appId: string, options: GetActionDynamicOutputSchemaOptions): Promise<GetActionDynamicOutputSchemaResponse>;
+}
+declare function bulkGetActionDynamicOutputSchemas$1(httpClient: HttpClient): BulkGetActionDynamicOutputSchemasSignature;
+interface BulkGetActionDynamicOutputSchemasSignature {
+    /**
+     * Returns action dynamic output schema for the given actions
+     * @param - list of actions details which will be used to generate the output schemas
+     */
+    (actionsInputMappings: ActionInputMappings[]): Promise<BulkGetActionDynamicOutputSchemasResponse>;
+}
+
+declare const createAction: MaybeContext<BuildRESTFunction<typeof createAction$1> & typeof createAction$1>;
+declare const updateAction: MaybeContext<BuildRESTFunction<typeof updateAction$1> & typeof updateAction$1>;
+declare const deleteAction: MaybeContext<BuildRESTFunction<typeof deleteAction$1> & typeof deleteAction$1>;
+declare const getRuntimeAction: MaybeContext<BuildRESTFunction<typeof getRuntimeAction$1> & typeof getRuntimeAction$1>;
+declare const getActionDynamicInputSchema: MaybeContext<BuildRESTFunction<typeof getActionDynamicInputSchema$1> & typeof getActionDynamicInputSchema$1>;
+declare const resolveActions: MaybeContext<BuildRESTFunction<typeof resolveActions$1> & typeof resolveActions$1>;
+declare const copyInputMapping: MaybeContext<BuildRESTFunction<typeof copyInputMapping$1> & typeof copyInputMapping$1>;
+declare const getActionDynamicOutputSchema: MaybeContext<BuildRESTFunction<typeof getActionDynamicOutputSchema$1> & typeof getActionDynamicOutputSchema$1>;
+declare const bulkGetActionDynamicOutputSchemas: MaybeContext<BuildRESTFunction<typeof bulkGetActionDynamicOutputSchemas$1> & typeof bulkGetActionDynamicOutputSchemas$1>;
+
+export { Action, ActionInputMappings, BulkGetActionDynamicOutputSchemasResponse, CopyInputMappingOptions, CopyInputMappingResponse, CreateActionOptions, DeleteActionOptions, GetActionDynamicInputSchemaOptions, GetActionDynamicInputSchemaResponse, GetActionDynamicOutputSchemaOptions, GetActionDynamicOutputSchemaResponse, GetRuntimeActionIdentifiers, ResolveActionsOptions, ResolveActionsResponse, UpdateActionOptions, bulkGetActionDynamicOutputSchemas, copyInputMapping, createAction, deleteAction, getActionDynamicInputSchema, getActionDynamicOutputSchema, getRuntimeAction, resolveActions, updateAction };

package/build/index.d.ts

@@ -0,0 +1,94 @@
+import { HttpClient, MaybeContext, BuildRESTFunction } from '@wix/sdk-types';
+import { C as CreateActionOptions, A as Action, U as UpdateActionOptions, D as DeleteActionOptions, G as GetRuntimeActionIdentifiers, a as GetActionDynamicInputSchemaOptions, b as GetActionDynamicInputSchemaResponse, R as ResolveActionsOptions, c as ResolveActionsResponse, d as CopyInputMappingOptions, e as CopyInputMappingResponse, f as GetActionDynamicOutputSchemaOptions, g as GetActionDynamicOutputSchemaResponse, h as ActionInputMappings, B as BulkGetActionDynamicOutputSchemasResponse } from './automations-actioncatalog-v1-action-action-catalog.universal-CrVo0pBg.js';
+export { ab as ActionEvent, s as ActionSpecInfo, a2 as ApplicationError, a4 as BulkActionMetadata, a3 as BulkActionOutputSchemaResult, a0 as BulkGetActionDynamicOutputSchemasRequest, _ as CopyInputMappingRequest, t as CreateActionRequest, u as CreateActionResponse, X as CursorPaging, Z as Cursors, x as DeleteActionRequest, y as DeleteActionResponse, a5 as DomainEvent, a6 as DomainEventBodyOneOf, a7 as EntityCreatedEvent, aa as EntityDeletedEvent, a9 as EntityUpdatedEvent, E as ExecutionType, i as ExperimentActionType, F as FocalPoint, l as GenericOptions, L as GetActionDynamicInputSchemaRequest, $ as GetActionDynamicOutputSchemaRequest, J as GetRuntimeActionRequest, K as GetRuntimeActionResponse, ad as IdentificationData, ae as IdentificationDataIdOneOf, I as ImplementedMethods, n as InterfaceConfiguration, o as InterfaceConfigurationOptionsOneOf, a1 as ItemMetadata, ac as MessageEnvelope, M as Metadata, z as MigrateComponentToActionRequest, H as MigrateComponentToActionResponse, V as Paging, Y as PagingMetadataV2, Q as QueryV2, O as QueryV2PagingMethodOneOf, N as ResolveActionsRequest, a8 as RestoreInfo, r as RetryExperimentCreation, j as SortOrder, P as Sorting, p as Source, q as SourceOptionsOneOf, S as SourceType, T as Type, v as UpdateActionRequest, w as UpdateActionResponse, W as WebhookIdentityType, k as WidgetComponentOptions, m as WixApiOptions } from './automations-actioncatalog-v1-action-action-catalog.universal-CrVo0pBg.js';
+
+declare function createAction$1(httpClient: HttpClient): CreateActionSignature;
+interface CreateActionSignature {
+    /**
+     * Create an action
+     * @returns The created action
+     */
+    (options?: CreateActionOptions | undefined): Promise<Action>;
+}
+declare function updateAction$1(httpClient: HttpClient): UpdateActionSignature;
+interface UpdateActionSignature {
+    /**
+     * Create a new version for a trigger, update the latest version of the component to point to this trigger
+     * @param - Action ID.
+     * @returns Action Configuration
+     */
+    (_id: string, options?: UpdateActionOptions | undefined): Promise<Action>;
+}
+declare function deleteAction$1(httpClient: HttpClient): DeleteActionSignature;
+interface DeleteActionSignature {
+    /**
+     * Delete a trigger by app id and key
+     * @param - The action App Id
+     */
+    (actionAppId: string, options: DeleteActionOptions): Promise<void>;
+}
+declare function getRuntimeAction$1(httpClient: HttpClient): GetRuntimeActionSignature;
+interface GetRuntimeActionSignature {
+    /**
+     * Returns action configuration by action key
+     * @returns Action Configuration
+     */
+    (identifiers: GetRuntimeActionIdentifiers): Promise<Action>;
+}
+declare function getActionDynamicInputSchema$1(httpClient: HttpClient): GetActionDynamicInputSchemaSignature;
+interface GetActionDynamicInputSchemaSignature {
+    /**
+     * Returns action dynamic schema and ui schema for the given action key and input mapping (action config)
+     * @param - The App ID of the action's owner.
+     */
+    (appId: string, options: GetActionDynamicInputSchemaOptions): Promise<GetActionDynamicInputSchemaResponse>;
+}
+declare function resolveActions$1(httpClient: HttpClient): ResolveActionsSignature;
+interface ResolveActionsSignature {
+    /**
+     * Returns action configurations that are installed on the site and exposed to Wix users.
+     */
+    (options?: ResolveActionsOptions | undefined): Promise<ResolveActionsResponse>;
+}
+declare function copyInputMapping$1(httpClient: HttpClient): CopyInputMappingSignature;
+interface CopyInputMappingSignature {
+    /**
+     * 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 - Action app id
+     */
+    (appId: string, options: CopyInputMappingOptions): Promise<CopyInputMappingResponse>;
+}
+declare function getActionDynamicOutputSchema$1(httpClient: HttpClient): GetActionDynamicOutputSchemaSignature;
+interface GetActionDynamicOutputSchemaSignature {
+    /**
+     * Returns action dynamic output schema for the given action key and the [users] action configuration
+     * @param - The App ID of the action's owner.
+     */
+    (appId: string, options: GetActionDynamicOutputSchemaOptions): Promise<GetActionDynamicOutputSchemaResponse>;
+}
+declare function bulkGetActionDynamicOutputSchemas$1(httpClient: HttpClient): BulkGetActionDynamicOutputSchemasSignature;
+interface BulkGetActionDynamicOutputSchemasSignature {
+    /**
+     * Returns action dynamic output schema for the given actions
+     * @param - list of actions details which will be used to generate the output schemas
+     */
+    (actionsInputMappings: ActionInputMappings[]): Promise<BulkGetActionDynamicOutputSchemasResponse>;
+}
+
+declare const createAction: MaybeContext<BuildRESTFunction<typeof createAction$1> & typeof createAction$1>;
+declare const updateAction: MaybeContext<BuildRESTFunction<typeof updateAction$1> & typeof updateAction$1>;
+declare const deleteAction: MaybeContext<BuildRESTFunction<typeof deleteAction$1> & typeof deleteAction$1>;
+declare const getRuntimeAction: MaybeContext<BuildRESTFunction<typeof getRuntimeAction$1> & typeof getRuntimeAction$1>;
+declare const getActionDynamicInputSchema: MaybeContext<BuildRESTFunction<typeof getActionDynamicInputSchema$1> & typeof getActionDynamicInputSchema$1>;
+declare const resolveActions: MaybeContext<BuildRESTFunction<typeof resolveActions$1> & typeof resolveActions$1>;
+declare const copyInputMapping: MaybeContext<BuildRESTFunction<typeof copyInputMapping$1> & typeof copyInputMapping$1>;
+declare const getActionDynamicOutputSchema: MaybeContext<BuildRESTFunction<typeof getActionDynamicOutputSchema$1> & typeof getActionDynamicOutputSchema$1>;
+declare const bulkGetActionDynamicOutputSchemas: MaybeContext<BuildRESTFunction<typeof bulkGetActionDynamicOutputSchemas$1> & typeof bulkGetActionDynamicOutputSchemas$1>;
+
+export { Action, ActionInputMappings, BulkGetActionDynamicOutputSchemasResponse, CopyInputMappingOptions, CopyInputMappingResponse, CreateActionOptions, DeleteActionOptions, GetActionDynamicInputSchemaOptions, GetActionDynamicInputSchemaResponse, GetActionDynamicOutputSchemaOptions, GetActionDynamicOutputSchemaResponse, GetRuntimeActionIdentifiers, ResolveActionsOptions, ResolveActionsResponse, UpdateActionOptions, bulkGetActionDynamicOutputSchemas, copyInputMapping, createAction, deleteAction, getActionDynamicInputSchema, getActionDynamicOutputSchema, getRuntimeAction, resolveActions, updateAction };