@wix/auto_sdk_automations_automations-v-2 1.0.0 → 1.0.2

package/build/internal/cjs/src/automations-v2-automation-automations-v-2.universal.d.ts

@@ -53,7 +53,7 @@ export interface Automation extends AutomationOriginInfoOneOf {
      * How the automation was added to the user's site.
      * @immutable
      */
-    origin?: Origin;
+    origin?: OriginWithLiterals;
     /** Automation settings. */
     settings?: AutomationSettings;
     /**
@@ -113,6 +113,8 @@ export declare enum Domain {
     /** Wix account-level domain. */
     WIX_ACCOUNT = "WIX_ACCOUNT"
 }
+/** @enumType */
+export type DomainWithLiterals = Domain | 'USER' | 'WIX' | 'WIX_ACCOUNT';
 export interface Enrichment {
     /**
      * Enrichment input mappings.
@@ -151,7 +153,7 @@ export interface AuditInfoIdOneOf {
 }
 export interface AutomationConfiguration {
     /** Status of the automation on the site. */
-    status?: Status;
+    status?: StatusWithLiterals;
     /** Trigger configuration. */
     trigger?: Trigger;
     /**
@@ -178,6 +180,8 @@ export declare enum TimeUnit {
     /** Months. */
     MONTHS = "MONTHS"
 }
+/** @enumType */
+export type TimeUnitWithLiterals = TimeUnit | 'UNKNOWN_TIME_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS' | 'WEEKS' | 'MONTHS';
 export interface Filter {
     /**
      * Filter ID.
@@ -209,7 +213,7 @@ export interface FutureDateActivationOffset {
      */
     preScheduledEventOffsetExpression?: string;
     /** Unit in which to set the action offset. */
-    scheduledEventOffsetTimeUnit?: TimeUnit;
+    scheduledEventOffsetTimeUnit?: TimeUnitWithLiterals;
 }
 export interface RateLimit {
     /**
@@ -225,7 +229,7 @@ export interface RateLimit {
      */
     durationExpression?: string | null;
     /** Unit in which to set the duration of the rate limit. */
-    durationTimeUnit?: TimeUnit;
+    durationTimeUnit?: TimeUnitWithLiterals;
     /**
      * Activation identifier used to count the number of activations.
      * @minLength 1
@@ -243,7 +247,7 @@ export interface FilterValueSelection {
 }
 export interface ConditionExpressionGroup {
     /** Logical operator used to evaluate the condition expressions. */
-    operator?: Operator;
+    operator?: OperatorWithLiterals;
     /**
      * Expressions evaluated using the selected operator.
      * @minSize 1
@@ -260,6 +264,8 @@ export declare enum Operator {
     /** `AND` operator. */
     AND = "AND"
 }
+/** @enumType */
+export type OperatorWithLiterals = Operator | 'UNKNOWN_OPERATOR' | 'OR' | 'AND';
 /** Path definition */
 export interface Path {
     /**
@@ -291,6 +297,8 @@ export declare enum Type {
     /** Rate-limiter. This stops the automation flow if the subsequent action has reached its maximum allowed executions. */
     RATE_LIMIT = "RATE_LIMIT"
 }
+/** @enumType */
+export type TypeWithLiterals = Type | 'UNKNOWN_ACTION_TYPE' | 'APP_DEFINED' | 'CONDITION' | 'DELAY' | 'RATE_LIMIT';
 export interface AppDefinedAction {
     /**
      * ID of the app that defines the action.
@@ -350,7 +358,7 @@ export interface DelayAction {
      */
     offsetExpression?: string | null;
     /** Unit in which to set the wait time to wait before the action runs. */
-    offsetTimeUnit?: TimeUnit;
+    offsetTimeUnit?: TimeUnitWithLiterals;
     /**
      * Action run date in milliseconds elapsed since January 1, 1970 UTC.
      *
@@ -379,7 +387,7 @@ export interface RateLimitAction {
      */
     rateLimitDurationExpression?: string | null;
     /** Unit in which to set the duration of the rate limit. */
-    rateLimitDurationTimeUnit?: TimeUnit;
+    rateLimitDurationTimeUnit?: TimeUnitWithLiterals;
     /**
      * Unique identifier of each activation by which rate limiter counts activations.
      * @minLength 1
@@ -429,6 +437,8 @@ export declare enum Status {
     /** Inactive. Inactive automations cannot be triggered. */
     INACTIVE = "INACTIVE"
 }
+/** @enumType */
+export type StatusWithLiterals = Status | 'UNKNOWN_STATUS' | 'ACTIVE' | 'INACTIVE';
 export interface Trigger {
     /**
      * ID of the app that defines the trigger.
@@ -466,6 +476,8 @@ export interface Action extends ActionInfoOneOf {
     appDefinedInfo?: AppDefinedAction;
     /** Details of the action when its `type` is `CONDITION`. */
     conditionInfo?: ConditionAction;
+    /** Details of the action when its `type` is `CODE_CONDITION`. */
+    codeConditionInfo?: CodeConditionAction;
     /** Details of the action when its `type` is `DELAY`. */
     delayInfo?: DelayAction;
     /** Details of the action when its `type` is `RATE_LIMIT`. */
@@ -478,7 +490,7 @@ export interface Action extends ActionInfoOneOf {
      */
     _id?: string | null;
     /** [Action type](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#action-type). */
-    type?: Type;
+    type?: TypeWithLiterals;
     /**
      * [Action namespace](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#namespace). This differentiates it from other actions of the same type.
      *
@@ -494,6 +506,8 @@ export interface ActionInfoOneOf {
     appDefinedInfo?: AppDefinedAction;
     /** Details of the action when its `type` is `CONDITION`. */
     conditionInfo?: ConditionAction;
+    /** Details of the action when its `type` is `CODE_CONDITION`. */
+    codeConditionInfo?: CodeConditionAction;
     /** Details of the action when its `type` is `DELAY`. */
     delayInfo?: DelayAction;
     /** Details of the action when its `type` is `RATE_LIMIT`. */
@@ -519,6 +533,8 @@ export declare enum Origin {
     /** [Preinstalled automation](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/pre-installed-automations/about-pre-installed-automations). */
     PREINSTALLED = "PREINSTALLED"
 }
+/** @enumType */
+export type OriginWithLiterals = Origin | 'UNKNOWN_ORIGIN' | 'USER' | 'APPLICATION' | 'PREINSTALLED';
 export interface ApplicationOrigin {
     /**
      * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
@@ -655,25 +671,21 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     updatedEvent?: EntityUpdatedEvent;
     deletedEvent?: EntityDeletedEvent;
     actionEvent?: ActionEvent;
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
     _id?: string;
     /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     * 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;
     /**
-     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
-     * This is although the created/updated/deleted notion is duplication of the oneof types
-     * Example: created/updated/deleted/started/completed/email_opened
+     * 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 */
+    /** 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
@@ -683,12 +695,8 @@ export interface DomainEvent extends DomainEventBodyOneOf {
     /** If present, indicates the action that triggered the event. */
     originatedFrom?: string | null;
     /**
-     * A sequence number defining the order of updates to the underlying entity.
-     * For example, given that some entity was updated at 16:00 and than again at 16:01,
-     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
-     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
-     * To do so, you will need to persist this number on your end, and compare the sequence number from the
-     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     * 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;
 }
@@ -714,7 +722,7 @@ export interface EntityUpdatedEvent {
     currentEntity?: string;
 }
 export interface EntityDeletedEvent {
-    /** Entity that was deleted */
+    /** Entity that was deleted. */
     deletedEntity?: string | null;
 }
 export interface ActionEvent {
@@ -820,7 +828,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
      */
     appId?: string;
     /** @readonly */
-    identityType?: WebhookIdentityType;
+    identityType?: WebhookIdentityTypeWithLiterals;
 }
 /** @oneof */
 export interface IdentificationDataIdOneOf {
@@ -852,6 +860,41 @@ export declare enum WebhookIdentityType {
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
+/** @enumType */
+export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+export interface CodeSnippet {
+    /** Logical operator used to evaluate the condition expressions. */
+    language?: LanguageWithLiterals;
+    /**
+     * Expressions evaluated using the selected operator. this code should comply the language syntax. and format
+     * @maxLength 1000
+     */
+    code?: string;
+}
+export declare enum Language {
+    /** Unknown. */
+    UNKNOWN_LANGUAGE = "UNKNOWN_LANGUAGE",
+    /** `JAVASCRIPT` language. */
+    JAVASCRIPT = "JAVASCRIPT"
+}
+/** @enumType */
+export type LanguageWithLiterals = Language | 'UNKNOWN_LANGUAGE' | 'JAVASCRIPT';
+export interface CodeConditionAction {
+    /** condition code. This is a code that can be used to identify the condition in the automation. code should return a boolean value. otherwise the value will be tried to be casted to boolean. */
+    snippet?: CodeSnippet;
+    /**
+     * IDs of actions to run when the condition evaluates to `true`.
+     * @maxSize 20
+     * @format GUID
+     */
+    truePostActionIds?: string[];
+    /**
+     * IDs of actions to run when the condition evaluates to `false`.
+     * @maxSize 20
+     * @format GUID
+     */
+    falsePostActionIds?: string[];
+}
 export interface CreateAutomationRequest {
     /** Automation to create. */
     automation: Automation;
@@ -861,6 +904,8 @@ export declare enum RequestedFields {
     /** whether to return in response `configuration.trigger.override_output_schema` field and in `configuration.actions` the `override_output_schema` field */
     OVERRIDE_SCHEMA = "OVERRIDE_SCHEMA"
 }
+/** @enumType */
+export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'OVERRIDE_SCHEMA';
 export interface CreateAutomationResponse {
     /** Details of the created automation. */
     automation?: Automation;
@@ -1102,12 +1147,14 @@ export interface Sorting {
      */
     fieldName?: string;
     /** Sort order. */
-    order?: SortOrder;
+    order?: SortOrderWithLiterals;
 }
 export declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
+/** @enumType */
+export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
 export interface CursorPaging {
     /**
      * Maximum number of items to return in the results.
@@ -1227,7 +1274,7 @@ export interface CopyAutomationRequest {
      */
     automationId: string;
     /** Origin of the automation to copy. */
-    origin?: Origin;
+    origin?: OriginWithLiterals;
     /** Automation to copy. Skips fetching by ID. */
     automation?: Automation;
 }
@@ -1363,7 +1410,7 @@ export interface Asset {
      */
     instanceId?: string;
     /** An application state. */
-    state?: State;
+    state?: StateWithLiterals;
 }
 export declare enum State {
     UNKNOWN = "UNKNOWN",
@@ -1372,6 +1419,8 @@ export declare enum State {
     PENDING = "PENDING",
     DEMO = "DEMO"
 }
+/** @enumType */
+export type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
 export interface SiteCreated {
     /**
      * A template identifier (empty if not created from a template).
@@ -1384,7 +1433,7 @@ export interface SiteCreated {
      */
     ownerId?: string;
     /** A context in which meta site was created. */
-    context?: SiteCreatedContext;
+    context?: SiteCreatedContextWithLiterals;
     /**
      * A meta site id from which this site was created.
      *
@@ -1399,7 +1448,7 @@ export interface SiteCreated {
      */
     siteName?: string;
     /** A namespace. */
-    namespace?: Namespace;
+    namespace?: NamespaceWithLiterals;
 }
 export declare enum SiteCreatedContext {
     /** A valid option, we don't expose all reasons why site might be created. */
@@ -1415,6 +1464,8 @@ export declare enum SiteCreatedContext {
     /** deprecated A meta site was created for Flash editor. */
     FLASH = "FLASH"
 }
+/** @enumType */
+export type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
 export declare enum Namespace {
     UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
     /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
@@ -1497,6 +1548,8 @@ export declare enum Namespace {
     /** MIMIR - Siteless account for MIMIR Ai Job runner. */
     MIMIR = "MIMIR"
 }
+/** @enumType */
+export type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
 /** Site transferred to another user. */
 export interface SiteTransferred {
     /**
@@ -1519,7 +1572,7 @@ export interface DeleteContext {
     /** When the meta site was deleted. */
     dateDeleted?: Date | null;
     /** A status. */
-    deleteStatus?: DeleteStatus;
+    deleteStatus?: DeleteStatusWithLiterals;
     /**
      * A reason (flow).
      * @maxLength 255
@@ -1538,6 +1591,8 @@ export declare enum DeleteStatus {
     PENDING_PURGE = "PENDING_PURGE",
     PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
 }
+/** @enumType */
+export type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
 /** Restoration of the meta site. */
 export interface SiteUndeleted {
 }
@@ -1639,9 +1694,9 @@ export interface SiteHardDeleted {
 }
 export interface NamespaceChanged {
     /** A previous namespace. */
-    oldNamespace?: Namespace;
+    oldNamespace?: NamespaceWithLiterals;
     /** A new namespace. */
-    newNamespace?: Namespace;
+    newNamespace?: NamespaceWithLiterals;
 }
 /** Assigned Studio editor */
 export interface StudioAssigned {
@@ -1805,9 +1860,9 @@ export interface TriggerValidationError extends TriggerValidationErrorErrorOneOf
     /** Provider configuration error. */
     providerConfigurationError?: ProviderConfigurationError;
     /** Validation error type. */
-    errorType?: TriggerValidationErrorValidationErrorType;
+    errorType?: TriggerValidationErrorValidationErrorTypeWithLiterals;
     /** Validation error severity */
-    severity?: ValidationErrorSeverity;
+    severity?: ValidationErrorSeverityWithLiterals;
 }
 /** @oneof */
 export interface TriggerValidationErrorErrorOneOf {
@@ -1823,9 +1878,11 @@ export declare enum TriggerValidationErrorValidationErrorType {
     /** Provider error. */
     PROVIDER_ERROR = "PROVIDER_ERROR"
 }
+/** @enumType */
+export type TriggerValidationErrorValidationErrorTypeWithLiterals = TriggerValidationErrorValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
 export interface TriggerConfigurationError {
     /** Trigger error type. */
-    errorType?: TriggerErrorType;
+    errorType?: TriggerErrorTypeWithLiterals;
     /**
      * Related filter field key.
      * @maxLength 110
@@ -1849,6 +1906,8 @@ export declare enum TriggerErrorType {
     /** Invalid filter expression. */
     INVALID_FILTER_EXPRESSION = "INVALID_FILTER_EXPRESSION"
 }
+/** @enumType */
+export type TriggerErrorTypeWithLiterals = TriggerErrorType | 'UNKNOWN_TRIGGER_ERROR_TYPE' | 'NOT_FOUND' | 'APP_NOT_INSTALLED' | 'MODERATION_MISMATCH' | 'DEPRECATED' | 'INVALID_TRIGGER_KEY' | 'INVALID_FILTER_FIELD_KEY' | 'INVALID_FILTER_EXPRESSION';
 export interface ProviderConfigurationError {
     /** Key corresponding to the field in the schema. */
     fieldKey?: string | null;
@@ -1868,6 +1927,8 @@ export declare enum ValidationErrorSeverity {
     /** Error. */
     ERROR = "ERROR"
 }
+/** @enumType */
+export type ValidationErrorSeverityWithLiterals = ValidationErrorSeverity | 'UNKNOWN_VALIDATION_ERROR_SEVERITY' | 'WARNING' | 'ERROR';
 export interface ActionValidationInfo {
     /**
      * Action ID.
@@ -1897,9 +1958,9 @@ export interface ActionValidationError extends ActionValidationErrorErrorOneOf {
     /** Provider configuration error. */
     providerConfigurationError?: ProviderConfigurationError;
     /** Validation error type. */
-    errorType?: ValidationErrorType;
+    errorType?: ValidationErrorTypeWithLiterals;
     /** Validation error severity */
-    severity?: ValidationErrorSeverity;
+    severity?: ValidationErrorSeverityWithLiterals;
 }
 /** @oneof */
 export interface ActionValidationErrorErrorOneOf {
@@ -1915,9 +1976,11 @@ export declare enum ValidationErrorType {
     /** Provider error. */
     PROVIDER_ERROR = "PROVIDER_ERROR"
 }
+/** @enumType */
+export type ValidationErrorTypeWithLiterals = ValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
 export interface ActionConfigurationError {
     /** Action error type. */
-    errorType?: ActionErrorType;
+    errorType?: ActionErrorTypeWithLiterals;
     /**
      * Related field key.
      * @maxLength 110
@@ -1937,15 +2000,17 @@ export declare enum ActionErrorType {
     MAPPING_SCHEMA_MISMATCH = "MAPPING_SCHEMA_MISMATCH",
     MAPPING_VARIABLE_MISSING_FROM_SCHEMA = "MAPPING_VARIABLE_MISSING_FROM_SCHEMA"
 }
+/** @enumType */
+export type ActionErrorTypeWithLiterals = ActionErrorType | 'UNKNOWN_ACTION_ERROR_TYPE' | 'NOT_FOUND' | 'APP_NOT_INSTALLED' | 'MODERATION_MISMATCH' | 'DEPRECATED' | 'INVALID_ACTION_KEY' | 'INVALID_MAPPING' | 'MAPPING_TYPE_MISMATCH' | 'MAPPING_MISSING_REQUIRED_FIELD' | 'MAPPING_SCHEMA_MISMATCH' | 'MAPPING_VARIABLE_MISSING_FROM_SCHEMA';
 export interface AutomationValidationError extends AutomationValidationErrorErrorOneOf {
     /** Automation configuration error. */
     configurationError?: AutomationConfigurationError;
     /** Provider configuration error. */
     providerConfigurationError?: ProviderConfigurationError;
     /** Validation error type. */
-    errorType?: AutomationValidationErrorValidationErrorType;
+    errorType?: AutomationValidationErrorValidationErrorTypeWithLiterals;
     /** Validation error severity. */
-    severity?: ValidationErrorSeverity;
+    severity?: ValidationErrorSeverityWithLiterals;
 }
 /** @oneof */
 export interface AutomationValidationErrorErrorOneOf {
@@ -1959,13 +2024,17 @@ export declare enum AutomationValidationErrorValidationErrorType {
     CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
     PROVIDER_ERROR = "PROVIDER_ERROR"
 }
+/** @enumType */
+export type AutomationValidationErrorValidationErrorTypeWithLiterals = AutomationValidationErrorValidationErrorType | 'UNKNOWN_VALIDATION_ERROR_TYPE' | 'CONFIGURATION_ERROR' | 'PROVIDER_ERROR';
 export interface AutomationConfigurationError {
     /** Automation error type. */
-    errorType?: AutomationErrorType;
+    errorType?: AutomationErrorTypeWithLiterals;
 }
 export declare enum AutomationErrorType {
     UNKNOWN_AUTOMATION_ERROR_TYPE = "UNKNOWN_AUTOMATION_ERROR_TYPE"
 }
+/** @enumType */
+export type AutomationErrorTypeWithLiterals = AutomationErrorType | 'UNKNOWN_AUTOMATION_ERROR_TYPE';
 export interface ValidateAutomationByIdRequest {
     /**
      * Automation ID.
@@ -2144,7 +2213,7 @@ export interface GetAutomationRevisionRequest {
      * Requested fields.
      * @maxSize 20
      */
-    fields?: RequestedFields[];
+    fields?: RequestedFieldsWithLiterals[];
 }
 export interface GetAutomationRevisionResponse {
     /** Automation revision. */
@@ -2165,25 +2234,21 @@ export interface BaseEventMetadata {
     identity?: IdentificationData;
 }
 export interface EventMetadata extends BaseEventMetadata {
-    /**
-     * Unique event ID.
-     * Allows clients to ignore duplicate webhooks.
-     */
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
     _id?: string;
     /**
-     * Assumes actions are also always typed to an entity_type
-     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     * 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;
     /**
-     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
-     * This is although the created/updated/deleted notion is duplication of the oneof types
-     * Example: created/updated/deleted/started/completed/email_opened
+     * 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 */
+    /** 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
@@ -2193,12 +2258,8 @@ export interface EventMetadata extends BaseEventMetadata {
     /** If present, indicates the action that triggered the event. */
     originatedFrom?: string | null;
     /**
-     * A sequence number defining the order of updates to the underlying entity.
-     * For example, given that some entity was updated at 16:00 and than again at 16:01,
-     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
-     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
-     * To do so, you will need to persist this number on your end, and compare the sequence number from the
-     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     * 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;
 }
@@ -2369,7 +2430,7 @@ export interface UpdateAutomation {
      * How the automation was added to the user's site.
      * @immutable
      */
-    origin?: Origin;
+    origin?: OriginWithLiterals;
     /** Automation settings. */
     settings?: AutomationSettings;
     /**
@@ -2539,7 +2600,7 @@ export declare function copyAutomation(automationId: string, options?: CopyAutom
 }[AutomationNonNullablePaths]>>;
 export interface CopyAutomationOptions {
     /** Origin of the automation to copy. */
-    origin?: Origin;
+    origin?: OriginWithLiterals;
     /** Automation to copy. Skips fetching by ID. */
     automation?: Automation;
 }
@@ -2653,7 +2714,7 @@ export interface UpdateDraftAutomation {
      * How the automation was added to the user's site.
      * @immutable
      */
-    origin?: Origin;
+    origin?: OriginWithLiterals;
     /** Automation settings. */
     settings?: AutomationSettings;
     /**
@@ -2799,6 +2860,6 @@ export interface GetAutomationRevisionOptions {
      * Requested fields.
      * @maxSize 20
      */
-    fields?: RequestedFields[];
+    fields?: RequestedFieldsWithLiterals[];
 }
 export {};

package/build/internal/cjs/src/automations-v2-automation-automations-v-2.universal.js

@@ -23,11 +23,13 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAutomationRevision = exports.validateAutomationById = exports.validateAutomation = exports.publishDraftAutomation = exports.deleteDraftAutomation = exports.queryAutomationsWithDrafts = exports.updateDraftAutomation = exports.getOrCreateDraftAutomation = exports.createDraftAutomation = exports.copyAutomation = exports.queryAutomations = exports.generatePreinstalledAutomation = exports.bulkDeleteAutomations = exports.deleteAutomation = exports.updateAutomation = exports.getAutomation = exports.createAutomation = exports.AutomationErrorType = exports.AutomationValidationErrorValidationErrorType = exports.ActionErrorType = exports.ValidationErrorType = exports.ValidationErrorSeverity = exports.TriggerErrorType = exports.TriggerValidationErrorValidationErrorType = exports.DeleteStatus = exports.Namespace = exports.SiteCreatedContext = exports.State = exports.SortOrder = exports.RequestedFields = exports.WebhookIdentityType = exports.Origin = exports.Status = exports.Type = exports.Operator = exports.TimeUnit = exports.Domain = void 0;
+exports.getAutomationRevision = exports.validateAutomationById = exports.validateAutomation = exports.publishDraftAutomation = exports.deleteDraftAutomation = exports.queryAutomationsWithDrafts = exports.updateDraftAutomation = exports.getOrCreateDraftAutomation = exports.createDraftAutomation = exports.copyAutomation = exports.queryAutomations = exports.generatePreinstalledAutomation = exports.bulkDeleteAutomations = exports.deleteAutomation = exports.updateAutomation = exports.getAutomation = exports.createAutomation = exports.AutomationErrorType = exports.AutomationValidationErrorValidationErrorType = exports.ActionErrorType = exports.ValidationErrorType = exports.ValidationErrorSeverity = exports.TriggerErrorType = exports.TriggerValidationErrorValidationErrorType = exports.DeleteStatus = exports.Namespace = exports.SiteCreatedContext = exports.State = exports.SortOrder = exports.RequestedFields = exports.Language = exports.WebhookIdentityType = exports.Origin = exports.Status = exports.Type = exports.Operator = exports.TimeUnit = exports.Domain = void 0;
 const transform_error_1 = require("@wix/sdk-runtime/transform-error");
 const query_builder_1 = require("@wix/sdk-runtime/query-builder");
 const rename_all_nested_keys_1 = require("@wix/sdk-runtime/rename-all-nested-keys");
 const ambassadorWixAutomationsV2Automation = __importStar(require("./automations-v2-automation-automations-v-2.http.js"));
+// @ts-ignore
+const transform_paths_1 = require("@wix/sdk-runtime/transformations/transform-paths");
 var Domain;
 (function (Domain) {
     /** User domain (default). */
@@ -101,6 +103,13 @@ var WebhookIdentityType;
     WebhookIdentityType["WIX_USER"] = "WIX_USER";
     WebhookIdentityType["APP"] = "APP";
 })(WebhookIdentityType || (exports.WebhookIdentityType = WebhookIdentityType = {}));
+var Language;
+(function (Language) {
+    /** Unknown. */
+    Language["UNKNOWN_LANGUAGE"] = "UNKNOWN_LANGUAGE";
+    /** `JAVASCRIPT` language. */
+    Language["JAVASCRIPT"] = "JAVASCRIPT";
+})(Language || (exports.Language = Language = {}));
 var RequestedFields;
 (function (RequestedFields) {
     RequestedFields["UNKNOWN_REQUESTED_FIELD"] = "UNKNOWN_REQUESTED_FIELD";
@@ -578,7 +587,7 @@ function queryAutomations(options) {
             });
         },
         responseTransformer: ({ data }) => {
-            const transformedData = (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)(data);
+            const transformedData = (0, rename_all_nested_keys_1.renameKeysFromRESTResponseToSDKResponse)((0, transform_paths_1.transformPaths)(data, []));
             return {
                 items: transformedData?.automations,
                 pagingMetadata: transformedData?.pagingMetadata,