@wix/auto_sdk_automations_action-catalog 1.0.0

package/build/es/src/automations-actioncatalog-v1-action-action-catalog.types.d.ts

@@ -0,0 +1,699 @@
+export interface Action {
+    /**
+     * Action ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * The ID of the app that defines the action.
+     * @format GUID
+     * @readonly
+     */
+    appId?: string;
+    /**
+     * Human-readable identifier for the action.
+     * @minLength 5
+     * @maxLength 50
+     * @readonly
+     */
+    actionKey?: string;
+    /**
+     * The action [input schema](https://dev.wix.com/docs/rest/business-management/automations/actions/about-actions#the-input-schema)
+     * as defined in the app dashboard.
+     * @readonly
+     */
+    inputSchema?: Record<string, any> | null;
+    /**
+     * The action [output schema](https://dev.wix.com/docs/rest/business-management/automations/actions/about-actions#the-output-schema)
+     * as defined in the app dashboard.
+     * @readonly
+     */
+    outputSchema?: Record<string, any> | null;
+    /**
+     * Action name displayed in the site dashboard to Wix users. For example, "Send SMS" or "Create Coupon".
+     * @minLength 1
+     * @maxLength 80
+     * @readonly
+     */
+    displayName?: string | null;
+    /**
+     * Action description displayed in the site dashboard to Wix users.
+     * @readonly
+     */
+    description?: string | null;
+    /** The optional service plugin methods that are implemented for this action. Invoke is required and therefore excluded from this list. */
+    implementedMethods?: ImplementedMethods;
+    /** Whether the action is executed immediately or with a delay. */
+    executionType?: ExecutionType;
+    /** The chosen user interface for the action. The UI is displayed to the Wix user in the site dashboard when they configure the action. */
+    interfaceConfiguration?: InterfaceConfiguration;
+    /** Action icon displayed in the site dashboard to Wix users. */
+    icon?: Image;
+    /**
+     * Date and time the action was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the action was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Action component ID.
+     * @format GUID
+     * @readonly
+     */
+    componentId?: string | null;
+    /**
+     * Component version at the time the action was created.
+     * @readonly
+     */
+    componentVersion?: string | null;
+}
+export declare enum Type {
+    /** Unknown action configuration UI. */
+    UNKNOWN_TYPE = "UNKNOWN_TYPE",
+    /**
+     * The generic action configuration UI. This requires you to provide a
+     * [UI schema](https://dev.wix.com/docs/rest/business-management/automations/actions/about-actions#the-ui-schema).
+     */
+    GENERIC = "GENERIC"
+}
+export interface WidgetComponentOptions {
+    /**
+     * Widget component name.
+     * @minLength 1
+     * @maxLength 80
+     */
+    componentName?: string;
+}
+export interface GenericOptions {
+    /** UI schema. */
+    uiSchema?: Record<string, any> | null;
+}
+export declare enum SourceType {
+    UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
+    /** The input/output schemas are constructed by developers in Dev Center using the self-service flow */
+    DEV_CENTER = "DEV_CENTER",
+    /** The input/output schemas are derived from an existing Wix API through the API-to-Action feature */
+    WIX_API = "WIX_API"
+}
+export interface WixApiOptions {
+    /**
+     * Service entity fqdn
+     * @minLength 1
+     * @maxLength 100
+     */
+    serviceEntityFqdn?: string;
+    /**
+     * The service providing the API
+     * @minLength 1
+     * @maxLength 200
+     */
+    serviceName?: string;
+    /**
+     * The method name
+     * @minLength 1
+     * @maxLength 200
+     */
+    methodName?: string;
+}
+export interface Metadata {
+    /** Whether the action is only shown to advanced mode users (Wix staff). */
+    hidden?: boolean;
+}
+export interface ImplementedMethods {
+    /** Whether Validate Configuration is implemented. */
+    validateConfiguration?: boolean;
+    /** Whether Duplicate Input Mapping is implemented. */
+    duplicateInputMapping?: boolean;
+    /** Whether Generate Application Automation Input Mapping is implemented. */
+    generateApplicationAutomationInputMapping?: boolean;
+    /** Whether Get Quota Info is implemented. */
+    getQuotaInfo?: boolean;
+    /** Whether On Before Save is implemented. */
+    onBeforeSave?: boolean;
+    /** Whether On Reset is implemented. */
+    onReset?: boolean;
+    /** Whether Generate Action Input Mapping From Template is implemented. */
+    generateActionInputMappingFromTemplate?: boolean;
+    /** Whether On Remove is implemented. */
+    onRemove?: boolean;
+    /** Whether Get Dynamic Input Schema is implemented. */
+    getDynamicInputSchema?: boolean;
+    /** Whether Merge Input Mappings is implemented. */
+    mergeInputMappings?: boolean;
+    /** Whether Get Dynamic Output Schema is implemented. */
+    getDynamicOutputSchema?: boolean;
+}
+export declare enum ExecutionType {
+    /** Unknown type. */
+    UNKNOWN_EXECUTION_TYPE = "UNKNOWN_EXECUTION_TYPE",
+    /** Action completes immediately. */
+    SYNC = "SYNC",
+    /** Action completes asynchronously. */
+    ASYNC = "ASYNC"
+}
+export interface InterfaceConfiguration extends InterfaceConfigurationOptionsOneOf {
+    /** Details for the generic UI. */
+    genericOptions?: GenericOptions;
+    /** Type of action configuration UI. */
+    type?: Type;
+}
+/** @oneof */
+export interface InterfaceConfigurationOptionsOneOf {
+    /** Details for the generic UI. */
+    genericOptions?: GenericOptions;
+}
+export interface Image {
+    /** WixMedia image ID. */
+    id?: string;
+    /** Image URL. */
+    url?: string;
+    /**
+     * Original image height.
+     * @readonly
+     */
+    height?: number;
+    /**
+     * Original image width.
+     * @readonly
+     */
+    width?: number;
+    /** Image alt text. */
+    altText?: string | null;
+    /**
+     * Image filename.
+     * @readonly
+     */
+    filename?: string | null;
+}
+export interface FocalPoint {
+    /** X-coordinate of the focal point. */
+    x?: number;
+    /** Y-coordinate of the focal point. */
+    y?: number;
+    /** crop by height */
+    height?: number | null;
+    /** crop by width */
+    width?: number | null;
+}
+export interface Source extends SourceOptionsOneOf {
+    /** Wix API options */
+    wixApiOptions?: WixApiOptions;
+    /** the source type */
+    type?: SourceType;
+}
+/** @oneof */
+export interface SourceOptionsOneOf {
+    /** Wix API options */
+    wixApiOptions?: WixApiOptions;
+}
+export interface RetryExperimentCreation {
+    /** action spec info */
+    actionSpecInfo?: ActionSpecInfo;
+    /**
+     * app id
+     * @format GUID
+     */
+    appId?: string;
+    /** experiment action type */
+    experimentActionType?: ExperimentActionType;
+    /**
+     * component id
+     * @format GUID
+     */
+    componentId?: string;
+}
+export interface ActionSpecInfo {
+    /**
+     * Spec to conduct on for the automation
+     * @maxLength 128
+     */
+    spec?: string;
+    /**
+     * Value the spec should return in order to affect the user with the operation
+     * e.g. creation - show the users the automation, update - show the users the updated automation, deletion - not show the users the automation
+     * @maxLength 128
+     */
+    variantValue?: string | null;
+    /**
+     * Version from which the experiment should decide whether to expose it to users when !conduct(spec).contains(variant_value)
+     * For example, if 50 is set, version 49 and below (including 49) will not expose the preinstalled automation to the user.
+     */
+    experimentVersion?: number;
+}
+export declare enum ExperimentActionType {
+    UNKNOWN_ACTION = "UNKNOWN_ACTION",
+    CREATE_COMPONENT = "CREATE_COMPONENT",
+    UPDATE_COMPONENT = "UPDATE_COMPONENT",
+    DELETE_COMPONENT = "DELETE_COMPONENT"
+}
+export interface CreateActionRequest {
+    /** The action to create */
+    action?: Action;
+    /** Action spec info */
+    actionSpecInfo?: ActionSpecInfo;
+    /**
+     * base uri for the action
+     * @maxLength 256
+     */
+    baseUri?: string;
+}
+export interface CreateActionResponse {
+    /** The created action */
+    action?: Action;
+}
+export interface UpdateActionRequest {
+    /** Action Configuration */
+    action?: Action;
+    /** Action spec info */
+    actionSpecInfo?: ActionSpecInfo;
+}
+export interface UpdateActionResponse {
+    /** Action Configuration */
+    updatedAction?: Action;
+}
+export interface DeleteActionRequest {
+    /**
+     * The action App Id
+     * @format GUID
+     */
+    actionAppId: string;
+    /**
+     * Action Configuration key
+     * @minLength 1
+     * @maxLength 100
+     */
+    actionKey: string;
+}
+export interface DeleteActionResponse {
+}
+export interface MigrateComponentToActionRequest {
+    /**
+     * The action App Id
+     * @format GUID
+     */
+    appId?: string;
+    /**
+     * The component id
+     * @format GUID
+     */
+    componentId?: string;
+}
+export interface MigrateComponentToActionResponse {
+}
+export interface GetRuntimeActionRequest {
+    /** The action App Id */
+    appId: string;
+    /** Action key */
+    actionKey: string;
+}
+export interface GetRuntimeActionResponse {
+    /** Action Configuration */
+    action?: Action;
+}
+export interface GetActionDynamicInputSchemaRequest {
+    /**
+     * The App ID of the action's owner.
+     * @format GUID
+     */
+    appId: string;
+    /**
+     * Action key as defined in an app's action configuration in the Wix Developers Center.
+     * For example, `send-email` or `generate-invoice`.
+     * @minLength 5
+     * @maxLength 50
+     */
+    actionKey: string;
+    /**
+     * Object representing the mapping a site contributor made between keys in the [input schema](https://dev.wix.com/docs/rest/api-reference/wix-automations/action-spi/about-the-action-spi-input-schema) and their expected
+     * values when running the automation. A field can be a static value mapping, or an expression that will be evaluated
+     * dynamically on each activation.
+     */
+    inputMapping: Record<string, any> | null;
+}
+export interface GetActionDynamicInputSchemaResponse {
+    /** A [JSON schema](https://json-schema.org/) containing the action's added dynamic fields and its static fields. */
+    inputSchema?: Record<string, any> | null;
+    /** A [UI schema](https://bo.wix.com/pages/automations-ui-lib/?path=/story/getting-started--about) is a JSON Schema that describes the UI of the static and dynamic fields. */
+    uiSchema?: Record<string, any> | null;
+}
+export interface ResolveActionsRequest {
+    /** Query options. */
+    query?: QueryV2;
+}
+export interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip 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).
+     */
+    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).
+     */
+    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. */
+    fields?: string[];
+    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fieldsets?: string[];
+}
+/** @oneof */
+export interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and skip 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;
+}
+export interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+export interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+export interface ResolveActionsResponse {
+    /** Retrieved actions. */
+    actions?: Action[];
+    /** Paging metadata of the response. */
+    paging?: PagingMetadataV2;
+}
+export interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+export interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+export interface CopyInputMappingRequest {
+    /**
+     * Action app id
+     * @format GUID
+     */
+    appId: string;
+    /**
+     * Action key
+     * @maxLength 100
+     */
+    actionKey: string;
+    /** Action input mapping */
+    inputMapping: Record<string, any> | null;
+}
+export interface CopyInputMappingResponse {
+    /** New action input mapping */
+    inputMapping?: Record<string, any> | null;
+}
+export interface GetActionDynamicOutputSchemaRequest {
+    /**
+     * The App ID of the action's owner.
+     * @format GUID
+     */
+    appId: string;
+    /**
+     * Action key as defined in an app's action configuration in the Wix Developers Center.
+     * For example, `send-email` or `generate-invoice`.
+     * @minLength 5
+     * @maxLength 50
+     */
+    actionKey: string;
+    /**
+     * Object representing the mapping a site contributor made between keys in the [input schema](https://dev.wix.com/docs/rest/api-reference/wix-automations/action-spi/about-the-action-spi-input-schema) and their expected
+     * values when running the automation. A field can be a static value mapping, or an expression that will be evaluated
+     * dynamically on each activation.
+     * For example:  [users] configuration contains cms collection id, the output schema will contain the fields of the selected collection.
+     */
+    inputMapping: Record<string, any> | null;
+}
+export interface GetActionDynamicOutputSchemaResponse {
+    /** A [JSON schema](https://json-schema.org/) containing the action's output schema. */
+    outputSchema?: Record<string, any> | null;
+}
+export interface BulkGetActionDynamicOutputSchemasRequest {
+    /**
+     * list of actions details which will be used to generate the output schemas
+     * @maxSize 20
+     * @minSize 1
+     */
+    actionsInputMappings: ActionInputMappings[];
+}
+export interface ActionInputMappings {
+    /**
+     * The App ID of the action's owner.
+     * @format GUID
+     */
+    appId?: string;
+    /**
+     * Action key as defined in an app's action configuration in the Wix Developers Center.
+     * For example, `send-email` or `generate-invoice`.
+     * @minLength 5
+     * @maxLength 50
+     */
+    actionKey?: string;
+    /**
+     * action identifier in the automation, useful for extracting out the output schema
+     * @format GUID
+     */
+    actionId?: string;
+    /**
+     * Object representing the mapping a site contributor made between keys in the [input schema](https://dev.wix.com/docs/rest/api-reference/wix-automations/action-spi/about-the-action-spi-input-schema) and their expected
+     * values when running the automation. A field can be a static value mapping, or an expression that will be evaluated
+     * dynamically on each activation.
+     * For example:  [users] configuration contains cms collection id, the output schema will contain the fields of the selected collection.
+     */
+    inputMapping?: Record<string, any> | null;
+}
+export interface BulkGetActionDynamicOutputSchemasResponse {
+    /** list of action output schemas */
+    results?: BulkActionOutputSchemaResult[];
+    /** metadata of the bulk action */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface ItemMetadata {
+    /**
+     * Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+     * @format GUID
+     */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface BulkActionOutputSchemaResult {
+    itemMetadata?: ItemMetadata;
+    /** A [JSON schema](https://json-schema.org/) containing the action's output schema. */
+    outputSchema?: Record<string, any> | null;
+}
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * 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
+     */
+    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 */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** 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.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+export interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+export interface EntityCreatedEvent {
+    entityAsJson?: string;
+    /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
+    restoreInfo?: RestoreInfo;
+}
+export interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+export interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntityAsJson?: string;
+}
+export interface EntityDeletedEvent {
+    /** Entity that was deleted */
+    deletedEntityAsJson?: string | null;
+}
+export interface ActionEvent {
+    bodyAsJson?: string;
+}
+export interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}