@wix/auto_sdk_automations_trigger-provider 1.0.11 → 1.0.12

package/build/{es/src/service-plugins-types.d.ts → internal/index.d.mts}

@@ -1,4 +1,6 @@
-export interface ValidateConfigurationRequest {
+import { ServicePluginDefinition, BuildServicePluginDefinition } from '@wix/sdk-types';
+
+interface ValidateConfigurationRequest {
     /**
      * Trigger key as defined in your app's trigger configuration in the app dashboard. For example, `form_submitted` or `invoice_due`.
      * @minLength 1
@@ -13,7 +15,7 @@ export interface ValidateConfigurationRequest {
     /** Trigger configuration mapping that's saved on the automation. */
     automationConfigMapping?: Record<string, any> | null;
 }
-export interface SelectedFilterOptions {
+interface SelectedFilterOptions {
     /**
      * Key representing a field from the trigger's [payload schema](https://dev.wix.com/docs/rest/business-management/automations/triggers/the-trigger-payload-schema) that has been configured as an [item selection filter](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/triggers/filter-fields#item-selection). For example `formId`.
      * @minLength 1
@@ -26,13 +28,13 @@ export interface SelectedFilterOptions {
      */
     values?: string[];
 }
-export interface ValidateConfigurationResponse {
+interface ValidateConfigurationResponse {
     /** Whether the trigger configuration is valid. */
     valid?: boolean;
     /** Error details for an invalid trigger configuration. */
     configurationErrors?: ProviderConfigurationError[];
 }
-export interface ProviderConfigurationError {
+interface ProviderConfigurationError {
     /** Key corresponding to the field in the schema. */
     fieldKey?: string | null;
     /** Error message. */
@@ -44,7 +46,7 @@ export interface ProviderConfigurationError {
     /** Title for the error. */
     title?: string;
 }
-export interface GetDynamicSchemaRequest {
+interface GetDynamicSchemaRequest {
     /**
      * Trigger key as defined in your app's trigger configuration in the app dashboard. For example, `form_submitted` or `invoice_due`.
      * @minLength 1
@@ -57,11 +59,11 @@ export interface GetDynamicSchemaRequest {
      */
     selectedFilterOptions?: SelectedFilterOptions[];
 }
-export interface GetDynamicSchemaResponse {
+interface GetDynamicSchemaResponse {
     /** A [JSON schema](https://json-schema.org/) corresponding to the filter selection sent in the request. */
     dynamicSchema?: Record<string, any> | null;
 }
-export interface RefreshPayloadRequest {
+interface RefreshPayloadRequest {
     /**
      * Trigger key as defined in your app's trigger configuration in the app dashboard. For example, `form_submitted` or `invoice_due`.
      * @minLength 1
@@ -76,7 +78,7 @@ export interface RefreshPayloadRequest {
     /** Payload to update. */
     payload: Record<string, any> | null;
 }
-export interface RefreshPayloadResponse {
+interface RefreshPayloadResponse {
     /** Updated payload. */
     payload?: Record<string, any> | null;
     /**
@@ -86,11 +88,11 @@ export interface RefreshPayloadResponse {
      */
     cancelActivation?: boolean | null;
 }
-export interface OnAutomationSavedRequest {
+interface OnAutomationSavedRequest {
     /** Saved automation. */
     automation: Automation;
 }
-export interface Automation extends AutomationOriginInfoOneOf {
+interface Automation extends AutomationOriginInfoOneOf {
     /** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
     applicationInfo?: ApplicationOrigin;
     /** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
@@ -160,13 +162,13 @@ export interface Automation extends AutomationOriginInfoOneOf {
     archived?: boolean;
 }
 /** @oneof */
-export interface AutomationOriginInfoOneOf {
+interface AutomationOriginInfoOneOf {
     /** When the origin of the automation is `APPLICATION`, the details of the app that created it. */
     applicationInfo?: ApplicationOrigin;
     /** When the origin of the automation is `PREINSTALLED`, the details of the preinstalled automation. */
     preinstalledInfo?: PreinstalledOrigin;
 }
-export interface ActionSettings {
+interface ActionSettings {
     /**
      * Permanent actions. Permanent actions cannot be deleted.
      *
@@ -196,7 +198,7 @@ export interface ActionSettings {
      */
     disableConditionAddition?: boolean;
 }
-export declare enum Domain {
+declare enum Domain {
     /** User domain (default). */
     USER = "USER",
     /** Wix domain. */
@@ -204,14 +206,14 @@ export declare enum Domain {
     /** Wix account-level domain. */
     WIX_ACCOUNT = "WIX_ACCOUNT"
 }
-export interface Enrichment {
+interface Enrichment {
     /**
      * Enrichment input mappings.
      * @maxSize 2
      */
     inputMappings?: Record<string, any>[] | null;
 }
-export interface AuditInfo extends AuditInfoIdOneOf {
+interface AuditInfo extends AuditInfoIdOneOf {
     /**
      * [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
      * @format GUID
@@ -226,7 +228,7 @@ export interface AuditInfo extends AuditInfoIdOneOf {
     appId?: string;
 }
 /** @oneof */
-export interface AuditInfoIdOneOf {
+interface AuditInfoIdOneOf {
     /**
      * [User ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#user-id).
      * @format GUID
@@ -240,7 +242,7 @@ export interface AuditInfoIdOneOf {
      */
     appId?: string;
 }
-export interface AutomationConfiguration {
+interface AutomationConfiguration {
     /** Status of the automation on the site. */
     status?: Status;
     /** Trigger configuration. */
@@ -256,7 +258,7 @@ export interface AutomationConfiguration {
     /** Actions the automation can execute, as key:value pairs. For the key, specify the action ID. The value must be an object structured as described below. */
     actions?: Record<string, Action>;
 }
-export declare enum TimeUnit {
+declare enum TimeUnit {
     UNKNOWN_TIME_UNIT = "UNKNOWN_TIME_UNIT",
     /** Minutes. */
     MINUTES = "MINUTES",
@@ -269,7 +271,7 @@ export declare enum TimeUnit {
     /** Months. */
     MONTHS = "MONTHS"
 }
-export interface Filter {
+interface Filter {
     /**
      * Filter ID.
      * @format GUID
@@ -291,7 +293,7 @@ export interface Filter {
      */
     filterExpression?: string;
 }
-export interface FutureDateActivationOffset {
+interface FutureDateActivationOffset {
     /**
      * Amount of time before the trigger to run the automation.
      *
@@ -302,7 +304,7 @@ export interface FutureDateActivationOffset {
     /** Unit in which to set the action offset. */
     scheduledEventOffsetTimeUnit?: TimeUnit;
 }
-export interface RateLimit {
+interface RateLimit {
     /**
      * Maximum number of times the trigger can be activated.
      * @maxLength 1000
@@ -324,7 +326,7 @@ export interface RateLimit {
      */
     uniqueIdentifierExpression?: string | null;
 }
-export interface FilterValueSelection {
+interface FilterValueSelection {
     /**
      * Values that can help the user filter certain automations. Specify values in the following format: `<filter_id>__<selected_value>`.
      * @maxLength 80
@@ -332,7 +334,7 @@ export interface FilterValueSelection {
      */
     selectedFilterValues?: string[];
 }
-export interface ConditionExpressionGroup {
+interface ConditionExpressionGroup {
     /** Logical operator used to evaluate the condition expressions. */
     operator?: Operator;
     /**
@@ -343,7 +345,7 @@ export interface ConditionExpressionGroup {
      */
     booleanExpressions?: string[];
 }
-export declare enum Operator {
+declare enum Operator {
     /** Unknown. */
     UNKNOWN_OPERATOR = "UNKNOWN_OPERATOR",
     /** `OR` operator. */
@@ -351,7 +353,7 @@ export declare enum Operator {
     /** `AND` operator. */
     AND = "AND"
 }
-export interface CodeSnippet {
+interface CodeSnippet {
     /** Logical operator used to evaluate the condition expressions. */
     language?: Language;
     /**
@@ -360,14 +362,14 @@ export interface CodeSnippet {
      */
     code?: string;
 }
-export declare enum Language {
+declare enum Language {
     /** Unknown. */
     UNKNOWN_LANGUAGE = "UNKNOWN_LANGUAGE",
     /** `JAVASCRIPT` language. */
     JAVASCRIPT = "JAVASCRIPT"
 }
 /** Path definition */
-export interface Path {
+interface Path {
     /**
      * Unique path ID.
      * @format GUID
@@ -385,7 +387,7 @@ export interface Path {
      */
     postActionId?: string | null;
 }
-export declare enum Type {
+declare enum Type {
     /** Based on the trigger. */
     UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
     /** Defined by a [Wix app](https://dev.wix.com/docs/rest/business-management/automations/automations/automations-v2/about-automation-configuration#app-defined-actions). This action type is available in the site dashboard. */
@@ -397,7 +399,7 @@ 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"
 }
-export interface AppDefinedAction {
+interface AppDefinedAction {
     /**
      * ID of the app that defines the action.
      * @format GUID
@@ -427,7 +429,7 @@ export interface AppDefinedAction {
     /** Action output schema. When specified, this replaces the action schema. */
     overrideOutputSchema?: Record<string, any> | null;
 }
-export interface ConditionAction {
+interface ConditionAction {
     /**
      * Condition is `true` if one or more of the expression groups evaluates to `true`.
      * @minSize 1
@@ -447,7 +449,7 @@ export interface ConditionAction {
      */
     falsePostActionIds?: string[];
 }
-export interface CodeConditionAction {
+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;
     /**
@@ -463,7 +465,7 @@ export interface CodeConditionAction {
      */
     falsePostActionIds?: string[];
 }
-export interface DelayAction {
+interface DelayAction {
     /**
      * Time to wait before running the action. The wait time starts from when the current action completes.
      *
@@ -487,7 +489,7 @@ export interface DelayAction {
      */
     postActionIds?: string[];
 }
-export interface RateLimitAction {
+interface RateLimitAction {
     /**
      * Maximum number of times the action can run.
      * @maxLength 1000
@@ -515,7 +517,7 @@ export interface RateLimitAction {
      */
     postActionIds?: string[];
 }
-export interface SetVariablesAction {
+interface SetVariablesAction {
     /** Output mapping. For example: `{"someField": "{{10}}", "someOtherField": "{{multiply( var('account.points.balance') ;2 )}}" }`. */
     outputMapping?: Record<string, any> | null;
     /**
@@ -531,11 +533,11 @@ export interface SetVariablesAction {
      */
     postActionIds?: string[];
 }
-export interface OutputAction {
+interface OutputAction {
     /** Output action output mapping. */
     outputMapping?: Record<string, any> | null;
 }
-export interface SplitAction {
+interface SplitAction {
     /**
      * List of paths to split execution into.
      * @minSize 2
@@ -543,7 +545,7 @@ export interface SplitAction {
      */
     paths?: Path[];
 }
-export declare enum Status {
+declare enum Status {
     /** Unknown. */
     UNKNOWN_STATUS = "UNKNOWN_STATUS",
     /** Active. Active automations can be triggered. */
@@ -551,7 +553,7 @@ export declare enum Status {
     /** Inactive. Inactive automations cannot be triggered. */
     INACTIVE = "INACTIVE"
 }
-export interface Trigger {
+interface Trigger {
     /**
      * ID of the app that defines the trigger.
      * @format GUID
@@ -583,7 +585,7 @@ export interface Trigger {
     /** Trigger schema override. When specified, this replaces the trigger schema. */
     overrideSchema?: Record<string, any> | null;
 }
-export interface Action extends ActionInfoOneOf {
+interface Action extends ActionInfoOneOf {
     /** Details of the action when its `type` is `APP_DEFINED`. */
     appDefinedInfo?: AppDefinedAction;
     /** Details of the action when its `type` is `CONDITION`. */
@@ -613,7 +615,7 @@ export interface Action extends ActionInfoOneOf {
     namespace?: string | null;
 }
 /** @oneof */
-export interface ActionInfoOneOf {
+interface ActionInfoOneOf {
     /** Details of the action when its `type` is `APP_DEFINED`. */
     appDefinedInfo?: AppDefinedAction;
     /** Details of the action when its `type` is `CONDITION`. */
@@ -625,7 +627,7 @@ export interface ActionInfoOneOf {
     /** Details of the action when its `type` is `RATE_LIMIT`. */
     rateLimitInfo?: RateLimitAction;
 }
-export interface FilterableAppDefinedActions {
+interface FilterableAppDefinedActions {
     /**
      * App-defined action identifiers. Identifiers have the following format: `${appId}_${actionKey}`.
      * @minSize 1
@@ -635,7 +637,7 @@ export interface FilterableAppDefinedActions {
      */
     actionIdentifiers?: string[];
 }
-export declare enum Origin {
+declare enum Origin {
     /** Default value. */
     UNKNOWN_ORIGIN = "UNKNOWN_ORIGIN",
     /** Created by a [Wix user](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#wix-user). */
@@ -645,7 +647,7 @@ 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"
 }
-export interface ApplicationOrigin {
+interface ApplicationOrigin {
     /**
      * [App ID](https://dev.wix.com/docs/build-apps/get-started/overview/glossary#app-id).
      *
@@ -654,7 +656,7 @@ export interface ApplicationOrigin {
      */
     appId?: string;
 }
-export interface PreinstalledOrigin {
+interface PreinstalledOrigin {
     /**
      * ID of the app that added the [preinstalled automation](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/pre-installed-automations/about-pre-installed-automations).
      * @format GUID
@@ -675,7 +677,7 @@ export interface PreinstalledOrigin {
      */
     override?: boolean | null;
 }
-export interface AutomationSettings {
+interface AutomationSettings {
     /**
      * Whether the automation is hidden from users.
      *
@@ -703,7 +705,7 @@ export interface AutomationSettings {
     /** Automation action settings. */
     actionSettings?: ActionSettings;
 }
-export interface DraftInfo {
+interface DraftInfo {
     /**
      * ID of the original automation.
      * @format GUID
@@ -711,11 +713,11 @@ export interface DraftInfo {
      */
     originalAutomationId?: string | null;
 }
-export interface Enrichments {
+interface Enrichments {
     /** Whether the studio site enrichment is wanted. */
     studioSite?: Enrichment;
 }
-export interface ExtendedFields {
+interface ExtendedFields {
     /**
      * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
      * The value of each key is structured according to the schema defined when the extended fields were configured.
@@ -726,18 +728,18 @@ export interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
-export interface OnAutomationSavedResponse {
+interface OnAutomationSavedResponse {
 }
-export interface OnAutomationDeletedRequest {
+interface OnAutomationDeletedRequest {
     /**
      * ID of the deleted automation.
      * @format GUID
      */
     automationId: string;
 }
-export interface OnAutomationDeletedResponse {
+interface OnAutomationDeletedResponse {
 }
-export interface TriggerProviderSPIConfig {
+interface TriggerProviderSPIConfig {
     /**
      * The trigger configuration
      *
@@ -818,7 +820,7 @@ export interface TriggerProviderSPIConfig {
  * }
  * ```
  */
-export interface Context {
+interface Context {
     /** A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs. */
     requestId?: string | null;
     /**
@@ -836,14 +838,14 @@ export interface Context {
      */
     instanceId?: string | null;
 }
-export declare enum IdentityType {
+declare enum IdentityType {
     UNKNOWN = "UNKNOWN",
     ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
     MEMBER = "MEMBER",
     WIX_USER = "WIX_USER",
     APP = "APP"
 }
-export interface IdentificationData extends IdentificationDataIdOneOf {
+interface IdentificationData extends IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -868,7 +870,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
     identityType?: IdentityType;
 }
 /** @oneof */
-export interface IdentificationDataIdOneOf {
+interface IdentificationDataIdOneOf {
     /**
      * ID of a site visitor that has not logged in to the site.
      * @format GUID
@@ -890,3 +892,76 @@ export interface IdentificationDataIdOneOf {
      */
     appId?: string;
 }
+
+interface ValidateConfigurationEnvelope {
+    request: ValidateConfigurationRequest;
+    metadata: Context;
+}
+interface GetDynamicSchemaEnvelope {
+    request: GetDynamicSchemaRequest;
+    metadata: Context;
+}
+interface RefreshPayloadEnvelope {
+    request: RefreshPayloadRequest;
+    metadata: Context;
+}
+declare const provideHandlers$1: ServicePluginDefinition<{
+    /**
+     *
+     * This endpoint allows you to run your own logic to validate trigger fields. Implement this endpoint if you need to perform extra validation on top of
+     * the Wix validation process.
+     *
+     * Wix calls Validate Configuration in the following cases:
+     *
+     * - When a Wix user activates the automation.
+     * - When a Wix user selects the automation from the **Your automations** list in the [**Automations**](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Ftriggers/site-automations)
+     * dashboard.
+     * - When a Wix user opens the automation to edit it.
+     *
+     * If the user configured filters when setting up their automation, these are included in the request.
+     * Wix uses the returned response to display an error message to a user if the requested trigger is invalid. */
+    validateConfiguration(payload: ValidateConfigurationEnvelope): ValidateConfigurationResponse | Promise<ValidateConfigurationResponse>;
+    /**
+     *
+     * This endpoint returns a [JSON schema](https://json-schema.org/) object
+     * that's used to dynamically update the fields available to a Wix user
+     * when they configure an [automation](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Ftriggers/site-automations).
+     *
+     * Wix calls this endpoint when a user selects an option from an
+     * [item selection filter](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/triggers/filter-fields#item-selection)
+     * configured for a trigger.
+     * Wix appends the returned schema to the
+     * [payload schema](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/triggers/payload-schema)
+     * you defined for the trigger and makes the fields available to the Wix user's automation. */
+    getDynamicSchema(payload: GetDynamicSchemaEnvelope): GetDynamicSchemaResponse | Promise<GetDynamicSchemaResponse>;
+    /**
+     *
+     * If an automation's action is delayed, implement this method to retrieve the latest data in the trigger payload before the action fires.
+     *
+     * For example, if an automation is triggered but its action is set to fire only 24 hours later, Wix calls Refresh Payload before starting
+     * the action. This fetches the latest data in the trigger payload. The returned data can be used to update the trigger payload that is passed
+     * to the action. */
+    refreshPayload(payload: RefreshPayloadEnvelope): RefreshPayloadResponse | Promise<RefreshPayloadResponse>;
+}>;
+
+declare const provideHandlers: BuildServicePluginDefinition<typeof provideHandlers$1>;
+
+declare class ProviderNotFoundWixError extends Error {
+    /** @hidden */
+    httpCode: number;
+    /** @hidden */
+    statusCode: string;
+    /** @hidden */
+    applicationCode: string;
+    /** @hidden */
+    name: string;
+    /** @hidden */
+    errorType: string;
+    /** @hidden */
+    spiErrorData: object;
+    constructor();
+    /** @hidden */
+    static readonly __type = "wix_spi_error";
+}
+
+export { type Action, type ActionInfoOneOf, type ActionSettings, type AppDefinedAction, type ApplicationOrigin, type AuditInfo, type AuditInfoIdOneOf, type Automation, type AutomationConfiguration, type AutomationOriginInfoOneOf, type AutomationSettings, type CodeConditionAction, type CodeSnippet, type ConditionAction, type ConditionExpressionGroup, type Context, type DelayAction, Domain, type DraftInfo, type Enrichment, type Enrichments, type ExtendedFields, type Filter, type FilterValueSelection, type FilterableAppDefinedActions, type FutureDateActivationOffset, type GetDynamicSchemaRequest, type GetDynamicSchemaResponse, type IdentificationData, type IdentificationDataIdOneOf, IdentityType, Language, type OnAutomationDeletedRequest, type OnAutomationDeletedResponse, type OnAutomationSavedRequest, type OnAutomationSavedResponse, Operator, Origin, type OutputAction, type Path, type PreinstalledOrigin, type ProviderConfigurationError, ProviderNotFoundWixError, type RateLimit, type RateLimitAction, type RefreshPayloadRequest, type RefreshPayloadResponse, type SelectedFilterOptions, type SetVariablesAction, type SplitAction, Status, TimeUnit, type Trigger, type TriggerProviderSPIConfig, Type, type ValidateConfigurationRequest, type ValidateConfigurationResponse, provideHandlers, provideHandlers$1 as publicProvideHandlers };