@wix/auto_sdk_automations_automations-v-2 1.0.4 → 1.0.6

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

@@ -0,0 +1,202 @@
+import { HttpClient, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
+import { A as Automation, U as UpdateAutomation, B as BulkDeleteAutomationsResponse, G as GeneratePreinstalledAutomationOptions, a as GeneratePreinstalledAutomationResponse, b as AutomationsQueryBuilder, C as CopyAutomationOptions, c as CopyAutomationResponse, d as CreateDraftAutomationOptions, e as CreateDraftAutomationResponse, f as GetOrCreateDraftAutomationResponse, g as UpdateDraftAutomation, h as UpdateDraftAutomationResponse, Q as QueryAutomationsWithDraftsOptions, i as QueryAutomationsWithDraftsResponse, P as PublishDraftAutomationResponse, V as ValidateAutomationOptions, j as ValidateAutomationResponse, k as ValidateAutomationByIdOptions, l as ValidateAutomationByIdResponse, m as GetAutomationRevisionOptions, n as GetAutomationRevisionResponse, o as AutomationCreatedEnvelope, p as AutomationDeletedEnvelope, q as AutomationUpdatedEnvelope } from './automations-v2-automation-automations-v-2.universal-CUoGClWF.mjs';
+export { ac as Action, bV as ActionConfigurationError, F as ActionErrorType, av as ActionEvent, ad as ActionInfoOneOf, c2 as ActionProviderQuotaInfo, c3 as ActionQuotaInfo, K as ActionSettings, bd as ActionUsageSummary, bT as ActionValidationError, bU as ActionValidationErrorErrorOneOf, bS as ActionValidationInfo, c8 as AdditionalInfo, a4 as AppDefinedAction, aR as ApplicationError, af as ApplicationOrigin, bh as Asset, X as AuditInfo, Y as AuditInfoIdOneOf, Z as AutomationConfiguration, bY as AutomationConfigurationError, I as AutomationErrorType, al as AutomationMigrationRequest, J as AutomationOriginInfoOneOf, ah as AutomationSettings, bW as AutomationValidationError, bX as AutomationValidationErrorErrorOneOf, H as AutomationValidationErrorValidationErrorType, cf as AutomationsQueryResult, cd as BaseEventMetadata, aS as BulkActionMetadata, aO as BulkDeleteAutomationsRequest, aP as BulkDeleteResult, c7 as CTA, aF as CodeConditionAction, aE as CodeSnippet, a5 as ConditionAction, a2 as ConditionExpressionGroup, be as CopyAutomationRequest, aG as CreateAutomationRequest, aH as CreateAutomationResponse, bE as CreateDraftAutomationRequest, aT as CreatePreinstalledAutomationRequest, aW as CreatePreinstalledAutomationResponse, b4 as CursorPaging, b6 as CursorPagingMetadata, b1 as CursorQuery, b2 as CursorQueryPagingMethodOneOf, b7 as Cursors, a6 as DelayAction, aM as DeleteAutomationRequest, aN as DeleteAutomationResponse, bl as DeleteContext, bJ as DeleteDraftAutomationRequest, bK as DeleteDraftAutomationResponse, aZ as DeletePreinstalledAutomationRequest, a_ as DeletePreinstalledAutomationResponse, w as DeleteStatus, an as DeletedWithEntity, D as Domain, ap as DomainEvent, aq as DomainEventBodyOneOf, ai as DraftInfo, ao as DraftPublished, bI as DraftsInfo, aw as Empty, M as Enrichment, aj as Enrichments, ar as EntityCreatedEvent, au as EntityDeletedEvent, at as EntityUpdatedEvent, ce as EventMetadata, ak as ExtendedFields, _ as Filter, a1 as FilterValueSelection, ae as FilterableAppDefinedActions, $ as FutureDateActivationOffset, a$ as GeneratePreinstalledAutomationRequest, c0 as GetActionsQuotaInfoRequest, c1 as GetActionsQuotaInfoResponse, ba as GetAggregatedUsageInfoRequest, bb as GetAggregatedUsageInfoResponse, b_ as GetAutomationActionSchemaRequest, b$ as GetAutomationActionSchemaResponse, aI as GetAutomationRequest, aJ as GetAutomationResponse, cc as GetAutomationRevisionRequest, bF as GetOrCreateDraftAutomationRequest, aC as IdentificationData, aD as IdentificationDataIdOneOf, aQ as ItemMetadata, L as Language, aB as MessageEnvelope, bf as MetaSiteSpecialEvent, bg as MetaSiteSpecialEventPayloadOneOf, ca as MigrateVeloActionAutomationsRequest, cb as MigrateVeloActionAutomationsResponse, N as Namespace, bv as NamespaceChanged, bA as OdeditorAssigned, bB as OdeditorUnassigned, O as Operator, s as Origin, aV as OriginAutomationInfo, a9 as OutputAction, a3 as Path, bC as PicassoAssigned, bD as PicassoUnassigned, c5 as Plan, aU as PreinstalledAutomationSpecInfo, ag as PreinstalledOrigin, bR as ProviderConfigurationError, bL as PublishDraftAutomationRequest, b8 as QueryAutomationsRequest, b9 as QueryAutomationsResponse, bH as QueryAutomationsWithDraftsRequest, b0 as QueryPreinstalledAutomationsForAppRequest, b5 as QueryPreinstalledAutomationsForAppResponse, c6 as Quota, c4 as QuotaInfo, a0 as RateLimit, a7 as RateLimitAction, R as RequestedFields, as as RestoreInfo, br as ServiceProvisioned, bs as ServiceRemoved, a8 as SetVariablesAction, bi as SiteCreated, v as SiteCreatedContext, bk as SiteDeleted, bu as SiteHardDeleted, bp as SiteMarkedAsTemplate, bq as SiteMarkedAsWixSite, bn as SitePublished, bz as SitePurgedExternally, bt as SiteRenamed, bj as SiteTransferred, bm as SiteUndeleted, bo as SiteUnpublished, by as SiteUrlChanged, t as SortOrder, b3 as Sorting, aa as SplitAction, u as State, S as Status, bw as StudioAssigned, bx as StudioUnassigned, az as TestUpdateApplicationAutomationRequest, aA as TestUpdateApplicationAutomationResponse, T as TimeUnit, ab as Trigger, bQ as TriggerConfigurationError, y as TriggerErrorType, bc as TriggerUsageSummary, bO as TriggerValidationError, bP as TriggerValidationErrorErrorOneOf, x as TriggerValidationErrorValidationErrorType, r as Type, ax as UpdateApplicationAutomationsRequest, ay as UpdateApplicationAutomationsResponse, aK as UpdateAutomationRequest, aL as UpdateAutomationResponse, bG as UpdateDraftAutomationRequest, aX as UpdatePreinstalledAutomationRequest, aY as UpdatePreinstalledAutomationResponse, am as UpdatedWithPreviousEntity, c9 as UpgradeCTA, bZ as ValidateAutomationByIdRequest, bM as ValidateAutomationRequest, z as ValidationErrorSeverity, E as ValidationErrorType, bN as ValidationSettings, W as WebhookIdentityType } from './automations-v2-automation-automations-v-2.universal-CUoGClWF.mjs';
+
+declare function createAutomation$1(httpClient: HttpClient): CreateAutomationSignature;
+interface CreateAutomationSignature {
+    /**
+     * Creates an automation.
+     * @param - Automation to create.
+     * @returns Details of the created automation.
+     */
+    (automation: Automation): Promise<Automation>;
+}
+declare function getAutomation$1(httpClient: HttpClient): GetAutomationSignature;
+interface GetAutomationSignature {
+    /**
+     * Retrieves an automation by ID.
+     * @param - Automation ID.
+     * @returns Retrieved automation.
+     */
+    (automationId: string): Promise<Automation>;
+}
+declare function updateAutomation$1(httpClient: HttpClient): UpdateAutomationSignature;
+interface UpdateAutomationSignature {
+    /**
+     * Updates the specified automation.
+     *
+     * When an automation is updated, its `revision` property is incremented by 1. When updating an automation, you must specify the current revision number.
+     * @param - Automation ID.
+     * @returns Updated automation.
+     */
+    (_id: string, automation: UpdateAutomation): Promise<Automation>;
+}
+declare function deleteAutomation$1(httpClient: HttpClient): DeleteAutomationSignature;
+interface DeleteAutomationSignature {
+    /**
+     * Deletes the specified automation.
+     * @param - Automation ID.
+     */
+    (automationId: string): Promise<void>;
+}
+declare function bulkDeleteAutomations$1(httpClient: HttpClient): BulkDeleteAutomationsSignature;
+interface BulkDeleteAutomationsSignature {
+    /**
+     * Deletes one or more automations.
+     * @param - IDs of the automations to delete.
+     */
+    (automationIds: string[]): Promise<BulkDeleteAutomationsResponse>;
+}
+declare function generatePreinstalledAutomation$1(httpClient: HttpClient): GeneratePreinstalledAutomationSignature;
+interface GeneratePreinstalledAutomationSignature {
+    /**
+     * Generates a preinstalled automation from another automation.
+     *
+     * Calls the action providers for changes needed to make a preinstalled automation, such as changes made to email template.
+     *
+     * > **Note**: You must have an account permission to edit an app.
+     * @param - Automation.
+     */
+    (automation: Automation, options?: GeneratePreinstalledAutomationOptions | undefined): Promise<GeneratePreinstalledAutomationResponse>;
+}
+declare function queryAutomations$1(httpClient: HttpClient): QueryAutomationsSignature;
+interface QueryAutomationsSignature {
+    /**
+     * Retrieves a list of automations. This includes both automations overridden on a site and preinstalled automations. If a preinstalled automation has been overridden on the site, the method returns the override automation.
+     *
+     * > **Note**: The method only returns automations by apps installed on the site.
+     *
+     * Learn more about [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+     */
+    (): AutomationsQueryBuilder;
+}
+declare function copyAutomation$1(httpClient: HttpClient): CopyAutomationSignature;
+interface CopyAutomationSignature {
+    /**
+     * Creates a copy of an action with a new ID, and changes the action's input mapping if necessary.
+     *
+     * The action copy isn't saved automatically. To save it, the user must perform an action
+     * such as clicking the **Save** button.
+     * @param - ID of the automation to copy.
+     */
+    (automationId: string, options?: CopyAutomationOptions | undefined): Promise<CopyAutomationResponse>;
+}
+declare function createDraftAutomation$1(httpClient: HttpClient): CreateDraftAutomationSignature;
+interface CreateDraftAutomationSignature {
+    /**
+     * Creates a draft automation.
+     */
+    (options?: CreateDraftAutomationOptions | undefined): Promise<CreateDraftAutomationResponse>;
+}
+declare function getOrCreateDraftAutomation$1(httpClient: HttpClient): GetOrCreateDraftAutomationSignature;
+interface GetOrCreateDraftAutomationSignature {
+    /**
+     * Retrieves the draft of the specified automation. If a draft doesn't exist, the method creates one.
+     *
+     * > **Note**: If the specified automation is a draft, the method returns it.
+     * @param - ID of the original automation on which the draft is based.
+     */
+    (originalAutomationId: string): Promise<GetOrCreateDraftAutomationResponse>;
+}
+declare function updateDraftAutomation$1(httpClient: HttpClient): UpdateDraftAutomationSignature;
+interface UpdateDraftAutomationSignature {
+    /**
+     * Updates a draft automation.
+     * @param - Automation ID.
+     */
+    (_id: string, automation: UpdateDraftAutomation): Promise<UpdateDraftAutomationResponse>;
+}
+declare function queryAutomationsWithDrafts$1(httpClient: HttpClient): QueryAutomationsWithDraftsSignature;
+interface QueryAutomationsWithDraftsSignature {
+    /**
+     * Retrieves a list of automations, including drafts. Max query filter depth is 3.
+     *
+     * Relevant automations for the query are returned. This includes automations created on the site and pre-installed automations.
+     * If there's an existing override for a pre-installed automation, the override is returned in the query result.
+     * The query only returns automations from apps that are installed on the site.
+     *
+     * - new drafts that are not related to existing automations will be returned in the list
+     * - the response will contain a map of originalAutomationId => relatedDrafts
+     *
+     * To learn about working with _Query_ endpoints, see
+     * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language),
+     * [Sorting and Paging](https://dev.wix.com/api/rest/getting-started/pagination),
+     * and [Field Projection](https://dev.wix.com/api/rest/getting-started/field-projection).
+     */
+    (options?: QueryAutomationsWithDraftsOptions | undefined): Promise<QueryAutomationsWithDraftsResponse>;
+}
+declare function deleteDraftAutomation$1(httpClient: HttpClient): DeleteDraftAutomationSignature;
+interface DeleteDraftAutomationSignature {
+    /**
+     * Deletes a draft automation.
+     * @param - ID of the draft automation to delete.
+     */
+    (automationId: string): Promise<void>;
+}
+declare function publishDraftAutomation$1(httpClient: HttpClient): PublishDraftAutomationSignature;
+interface PublishDraftAutomationSignature {
+    /**
+     * Publishes a draft automation. This applies any changes to the live automation.
+     * @param - ID of the draft automation to publish.
+     */
+    (automationId: string): Promise<PublishDraftAutomationResponse>;
+}
+declare function validateAutomation$1(httpClient: HttpClient): ValidateAutomationSignature;
+interface ValidateAutomationSignature {
+    /**
+     * Validates the specified automation.
+     * @param - Automation to validate.
+     */
+    (automation: Automation, options?: ValidateAutomationOptions | undefined): Promise<ValidateAutomationResponse>;
+}
+declare function validateAutomationById$1(httpClient: HttpClient): ValidateAutomationByIdSignature;
+interface ValidateAutomationByIdSignature {
+    /**
+     * Validates the automation specified by ID.
+     * @param - Automation ID.
+     */
+    (automationId: string, options?: ValidateAutomationByIdOptions | undefined): Promise<ValidateAutomationByIdResponse>;
+}
+declare function getAutomationRevision$1(httpClient: HttpClient): GetAutomationRevisionSignature;
+interface GetAutomationRevisionSignature {
+    /**
+     * Gets the specified automation revision.
+     * @param - Automation ID.
+     */
+    (automationId: string, options?: GetAutomationRevisionOptions | undefined): Promise<GetAutomationRevisionResponse>;
+}
+declare const onAutomationCreated$1: EventDefinition<AutomationCreatedEnvelope, "wix.automations.v2.automation_created">;
+declare const onAutomationDeleted$1: EventDefinition<AutomationDeletedEnvelope, "wix.automations.v2.automation_deleted">;
+declare const onAutomationUpdated$1: EventDefinition<AutomationUpdatedEnvelope, "wix.automations.v2.automation_updated">;
+
+declare const createAutomation: MaybeContext<BuildRESTFunction<typeof createAutomation$1> & typeof createAutomation$1>;
+declare const getAutomation: MaybeContext<BuildRESTFunction<typeof getAutomation$1> & typeof getAutomation$1>;
+declare const updateAutomation: MaybeContext<BuildRESTFunction<typeof updateAutomation$1> & typeof updateAutomation$1>;
+declare const deleteAutomation: MaybeContext<BuildRESTFunction<typeof deleteAutomation$1> & typeof deleteAutomation$1>;
+declare const bulkDeleteAutomations: MaybeContext<BuildRESTFunction<typeof bulkDeleteAutomations$1> & typeof bulkDeleteAutomations$1>;
+declare const generatePreinstalledAutomation: MaybeContext<BuildRESTFunction<typeof generatePreinstalledAutomation$1> & typeof generatePreinstalledAutomation$1>;
+declare const queryAutomations: MaybeContext<BuildRESTFunction<typeof queryAutomations$1> & typeof queryAutomations$1>;
+declare const copyAutomation: MaybeContext<BuildRESTFunction<typeof copyAutomation$1> & typeof copyAutomation$1>;
+declare const createDraftAutomation: MaybeContext<BuildRESTFunction<typeof createDraftAutomation$1> & typeof createDraftAutomation$1>;
+declare const getOrCreateDraftAutomation: MaybeContext<BuildRESTFunction<typeof getOrCreateDraftAutomation$1> & typeof getOrCreateDraftAutomation$1>;
+declare const updateDraftAutomation: MaybeContext<BuildRESTFunction<typeof updateDraftAutomation$1> & typeof updateDraftAutomation$1>;
+declare const queryAutomationsWithDrafts: MaybeContext<BuildRESTFunction<typeof queryAutomationsWithDrafts$1> & typeof queryAutomationsWithDrafts$1>;
+declare const deleteDraftAutomation: MaybeContext<BuildRESTFunction<typeof deleteDraftAutomation$1> & typeof deleteDraftAutomation$1>;
+declare const publishDraftAutomation: MaybeContext<BuildRESTFunction<typeof publishDraftAutomation$1> & typeof publishDraftAutomation$1>;
+declare const validateAutomation: MaybeContext<BuildRESTFunction<typeof validateAutomation$1> & typeof validateAutomation$1>;
+declare const validateAutomationById: MaybeContext<BuildRESTFunction<typeof validateAutomationById$1> & typeof validateAutomationById$1>;
+declare const getAutomationRevision: MaybeContext<BuildRESTFunction<typeof getAutomationRevision$1> & typeof getAutomationRevision$1>;
+/**
+ * Triggered when a new automation is created.
+ */
+declare const onAutomationCreated: BuildEventDefinition<typeof onAutomationCreated$1>;
+/**
+ * Triggered when an automation is deleted.
+ */
+declare const onAutomationDeleted: BuildEventDefinition<typeof onAutomationDeleted$1>;
+/**
+ * Triggered when an automation is updated.
+ */
+declare const onAutomationUpdated: BuildEventDefinition<typeof onAutomationUpdated$1>;
+
+export { Automation, AutomationCreatedEnvelope, AutomationDeletedEnvelope, AutomationUpdatedEnvelope, AutomationsQueryBuilder, BulkDeleteAutomationsResponse, CopyAutomationOptions, CopyAutomationResponse, CreateDraftAutomationOptions, CreateDraftAutomationResponse, GeneratePreinstalledAutomationOptions, GeneratePreinstalledAutomationResponse, GetAutomationRevisionOptions, GetAutomationRevisionResponse, GetOrCreateDraftAutomationResponse, PublishDraftAutomationResponse, QueryAutomationsWithDraftsOptions, QueryAutomationsWithDraftsResponse, UpdateAutomation, UpdateDraftAutomation, UpdateDraftAutomationResponse, ValidateAutomationByIdOptions, ValidateAutomationByIdResponse, ValidateAutomationOptions, ValidateAutomationResponse, bulkDeleteAutomations, copyAutomation, createAutomation, createDraftAutomation, deleteAutomation, deleteDraftAutomation, generatePreinstalledAutomation, getAutomation, getAutomationRevision, getOrCreateDraftAutomation, onAutomationCreated, onAutomationDeleted, onAutomationUpdated, publishDraftAutomation, queryAutomations, queryAutomationsWithDrafts, updateAutomation, updateDraftAutomation, validateAutomation, validateAutomationById };