@wix/auto_sdk_data_movement-workflows 1.0.0

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

@@ -0,0 +1,1003 @@
+import * as _wix_sdk_types from '@wix/sdk-types';
+import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
+
+/** Workflow run composed of ordered data movement steps. */
+interface Workflow {
+    /**
+     * Workflow ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Revision number incremented on each workflow update.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time when the workflow was created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date and time when the workflow was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /**
+     * Current workflow lifecycle status.
+     * @readonly
+     */
+    status?: StatusWithLiterals;
+    /**
+     * Immutable ordered execution plan for the workflow.
+     * @minSize 1
+     * @maxSize 100
+     */
+    specs?: JobSpec[];
+}
+/** Workflow lifecycle status. */
+declare enum Status {
+    UNINITIALIZED = "UNINITIALIZED",
+    RUNNING = "RUNNING",
+    FINISHED = "FINISHED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'UNINITIALIZED' | 'RUNNING' | 'FINISHED';
+/** Immutable specification for a single data movement step. */
+interface JobSpec extends JobSpecSiteOverrideOneOf {
+    /**
+     * Site ID to read from instead of the current site.
+     * @format GUID
+     */
+    sourceSiteId?: string;
+    /**
+     * Site ID to write to instead of the current site.
+     * @format GUID
+     */
+    destinationSiteId?: string;
+    /** Source to read data from. */
+    source?: Source;
+    /** Destination to write data to. */
+    destination?: Destination;
+}
+/** @oneof */
+interface JobSpecSiteOverrideOneOf {
+    /**
+     * Site ID to read from instead of the current site.
+     * @format GUID
+     */
+    sourceSiteId?: string;
+    /**
+     * Site ID to write to instead of the current site.
+     * @format GUID
+     */
+    destinationSiteId?: string;
+}
+interface Source extends SourceSourceOneOf {
+    /**
+     * Wix data collection.
+     *
+     * You can move items from native Wix collections, [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code), and [external database collections](https://dev.wix.com/docs/develop-websites/articles/databases/external-databases/overview/integrating-external-databases-with-your-wix-site).
+     */
+    wixDataCollection?: WixDataSource;
+    /**
+     * Localized CMS content. Available when the site has [Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) installed.
+     *
+     * Learn more about working with [translated CMS content](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content).
+     */
+    localization?: LocalizationSource;
+    /**
+     * Source file.
+     *
+     * You can import data from files in CSV or JSONL formats. Uploading a file with an invalid format causes the movement job to fail.
+     *
+     * To upload a file, call Create File Upload Url ([SDK](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/create-file-upload-url) | [REST](https://dev.wix.com/docs/rest/business-solutions/cms/data-movement-jobs/create-file-upload-url)) and use the `uploadUrl` from the response. For example:
+     *
+     * `curl --request PUT --upload-file "${path_to_file}" "${uploadUrl}"`
+     */
+    file?: FileSource;
+}
+/** @oneof */
+interface SourceSourceOneOf {
+    /**
+     * Wix data collection.
+     *
+     * You can move items from native Wix collections, [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code), and [external database collections](https://dev.wix.com/docs/develop-websites/articles/databases/external-databases/overview/integrating-external-databases-with-your-wix-site).
+     */
+    wixDataCollection?: WixDataSource;
+    /**
+     * Localized CMS content. Available when the site has [Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) installed.
+     *
+     * Learn more about working with [translated CMS content](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content).
+     */
+    localization?: LocalizationSource;
+    /**
+     * Source file.
+     *
+     * You can import data from files in CSV or JSONL formats. Uploading a file with an invalid format causes the movement job to fail.
+     *
+     * To upload a file, call Create File Upload Url ([SDK](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/create-file-upload-url) | [REST](https://dev.wix.com/docs/rest/business-solutions/cms/data-movement-jobs/create-file-upload-url)) and use the `uploadUrl` from the response. For example:
+     *
+     * `curl --request PUT --upload-file "${path_to_file}" "${uploadUrl}"`
+     */
+    file?: FileSource;
+}
+declare enum WixDataEnvironment {
+    /** Collection's [live environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#sandbox-collections). */
+    LIVE = "LIVE",
+    /** Collection's [sandbox environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing#live-collections). */
+    SANDBOX = "SANDBOX"
+}
+/** @enumType */
+type WixDataEnvironmentWithLiterals = WixDataEnvironment | 'LIVE' | 'SANDBOX';
+declare enum FileFormat {
+    /** Unknown format. */
+    UNKNOWN = "UNKNOWN",
+    /** CSV format. */
+    CSV = "CSV",
+    /** JSONL format. */
+    JSONL = "JSONL"
+}
+/** @enumType */
+type FileFormatWithLiterals = FileFormat | 'UNKNOWN' | 'CSV' | 'JSONL';
+declare enum MediaType {
+    /** All media types. */
+    ALL = "ALL",
+    /** Images. */
+    IMAGE = "IMAGE",
+    /** Videos. */
+    VIDEO = "VIDEO",
+    /** Audio files. */
+    AUDIO = "AUDIO",
+    /** Documents. */
+    DOCUMENT = "DOCUMENT"
+}
+/** @enumType */
+type MediaTypeWithLiterals = MediaType | 'ALL' | 'IMAGE' | 'VIDEO' | 'AUDIO' | 'DOCUMENT';
+/** Wix data collection. */
+interface WixDataSource {
+    /**
+     * ID of the data collection.
+     * @minLength 1
+     * @maxLength 256
+     */
+    collectionId?: string;
+    /**
+     * Filter to apply to the items. Only items that pass the filter are moved.
+     *
+     * Learn more about building a query filter using [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     */
+    filter?: Record<string, any> | null;
+    /** Item fields to move. If not set, the method moves the full items. */
+    fields?: string[];
+}
+interface LocalizationSource {
+    /**
+     * Translated CMS content in the specified languages. Content in these languages is exported to the destination, with the first specified language treated as the main one.
+     *
+     * Use two-letter language codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format. You can also specify a two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
+     *
+     * Learn more about [available languages in Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-languages-available).
+     * @format LANGUAGE_TAG
+     * @minSize 2
+     * @maxSize 64
+     */
+    languages?: string[];
+}
+/**
+ * File.
+ *
+ * To create a file upload URL, call the Create File Upload Url method and use the `uploadURL` in the response to upload the source file.
+ */
+interface FileSource {
+    /** File format. If not specified, automatically determined by Wix. */
+    format?: FileFormatWithLiterals;
+    /**
+     * File ID as returned in the `fileId` property of the Create File Upload URL method's response.
+     * @maxLength 512
+     */
+    fileId?: string;
+    /**
+     * URL where the source file is uploaded. Automatically generated by Wix.
+     * @readonly
+     * @maxLength 2048
+     */
+    url?: string;
+}
+interface TestSource {
+    /**
+     * Discriminator value for a particular test source.
+     * @maxLength 512
+     */
+    type?: string;
+    /** Test source details. */
+    details?: Record<string, any> | null;
+}
+/** Job logs. */
+interface DataMovementJobLogs {
+    /**
+     * ID of the job from which to export logs.
+     * @format GUID
+     */
+    jobId?: string;
+}
+/** File. */
+interface ExternalFileSource {
+    /** File format. If not specified, automatically determined by Wix. */
+    format?: FileFormatWithLiterals;
+    /**
+     * URL where the source file is located.
+     * @maxLength 2048
+     * @format WEB_URL
+     */
+    url?: string;
+}
+/** Google Sheets source. */
+interface GoogleSheetsSource {
+    /**
+     * ID of the Google Sheets spreadsheet.
+     * @minLength 1
+     * @maxLength 256
+     */
+    spreadsheetId?: string;
+    /**
+     * Name of the sheet within the spreadsheet.
+     * @maxLength 256
+     */
+    sheetName?: string | null;
+    /**
+     * Range of cells within the sheet.
+     * @maxLength 256
+     */
+    range?: string | null;
+    /**
+     * Entity ID of the saved OAuth token.
+     * @format GUID
+     */
+    oauthTokenId?: string;
+}
+/** Wix Media Manager source. */
+interface WixMediaSource {
+    /**
+     * ID of the source folder in the Media Manager. If not specified, all media items are included.
+     * @maxLength 256
+     */
+    sourceFolderId?: string | null;
+}
+/** Exports collection structure (fields, permissions, etc.) from a site. */
+interface WixDataCollectionDefinitionSource {
+    /**
+     * IDs of collections whose definitions to read.
+     * @minSize 1
+     * @maxSize 1000
+     * @maxLength 256
+     */
+    collectionIds?: string[];
+}
+interface Destination extends DestinationDestinationOneOf {
+    /**
+     * Wix data collection.
+     *
+     * You can move items to native Wix collections, [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code), and [external database collections](https://dev.wix.com/docs/develop-websites/articles/databases/external-databases/overview/integrating-external-databases-with-your-wix-site).
+     */
+    wixDataCollection?: WixDataDestination;
+    /**
+     * Localized CMS content. Available when the site has [Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) installed.
+     *
+     * Learn more about working with [translated CMS content](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content).
+     */
+    localization?: LocalizationDestination;
+    /** Downloadable file with the moved items. */
+    file?: FileDestination;
+}
+/** @oneof */
+interface DestinationDestinationOneOf {
+    /**
+     * Wix data collection.
+     *
+     * You can move items to native Wix collections, [Wix app collections](https://dev.wix.com/docs/develop-websites/articles/databases/wix-data/collections/working-with-wix-app-collections-and-code), and [external database collections](https://dev.wix.com/docs/develop-websites/articles/databases/external-databases/overview/integrating-external-databases-with-your-wix-site).
+     */
+    wixDataCollection?: WixDataDestination;
+    /**
+     * Localized CMS content. Available when the site has [Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-an-overview) installed.
+     *
+     * Learn more about working with [translated CMS content](https://support.wix.com/en/article/wix-multilingual-translating-cms-collection-content).
+     */
+    localization?: LocalizationDestination;
+    /** Downloadable file with the moved items. */
+    file?: FileDestination;
+}
+/** Wix data collection. */
+interface WixDataDestination {
+    /**
+     * ID of the destination collection.
+     * @maxLength 256
+     */
+    collectionId?: string;
+    /**
+     * When items already exist in the destination collection, the data writing policy.
+     *
+     * Default: `OVERWRITE`.
+     */
+    writePolicy?: WixDataDestinationWritePolicyWithLiterals;
+}
+declare enum WixDataDestinationWritePolicy {
+    /** When an item with the same ID exists in the collection, overwrite it. */
+    OVERWRITE = "OVERWRITE",
+    /** When an item with the same ID exists in the collection, skip it. */
+    SKIP_EXISTING = "SKIP_EXISTING",
+    /** Clear the destination collection before moving data. When the job completes, the collection contains only the moved data. */
+    TRUNCATE_BEFORE = "TRUNCATE_BEFORE"
+}
+/** @enumType */
+type WixDataDestinationWritePolicyWithLiterals = WixDataDestinationWritePolicy | 'OVERWRITE' | 'SKIP_EXISTING' | 'TRUNCATE_BEFORE';
+interface LocalizationDestination {
+    /**
+     * Translated CMS content in the specified languages. Content in these languages is imported from the source, with the first specified language treated as the main one.
+     *
+     * Use two-letter language codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) format. You can also specify a two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format.
+     *
+     * Learn more about [available languages in Wix Multilingual](https://support.wix.com/en/article/wix-multilingual-languages-available).
+     * @minSize 2
+     * @maxSize 64
+     * @format LANGUAGE_TAG
+     */
+    languages?: string[];
+}
+/** Destination file. Creates a file and generates a download URL. */
+interface FileDestination {
+    /** File format. */
+    format?: FileFormatWithLiterals;
+    /**
+     * File name.
+     * @maxLength 512
+     */
+    fileName?: string | null;
+    /**
+     * File download URL.
+     * @readonly
+     * @maxLength 2048
+     */
+    url?: string;
+}
+/** Schema used to specify item format. */
+interface Schema {
+    /**
+     * Item fields to move to the destination file.
+     * @maxSize 1000
+     */
+    fields?: Field[];
+}
+interface Field {
+    /**
+     * Field ID.
+     *
+     * If the field type is `Array`, specify the item index. If the field type is `Object`, specify the field path. Use dot notation to specify nested fields, for example: `data.address.city`.
+     * @maxLength 1024
+     */
+    key?: string;
+    /**
+     * Field display name.
+     *
+     * When moving items to CSV files, use this to set the header of the target column.
+     * @maxLength 1024
+     */
+    displayName?: string;
+    /**
+     * Field data type. Default: `ANY`.
+     *
+     * Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-types-in-wix-data).
+     */
+    fieldType?: FieldTypeWithLiterals;
+}
+declare enum FieldType {
+    /** Any data type. */
+    ANY = "ANY",
+    /** String. */
+    STRING = "STRING",
+    /** Number. */
+    NUMBER = "NUMBER",
+    /** Boolean. */
+    BOOLEAN = "BOOLEAN",
+    /** Date string in ISO 8601 date format: `YYYY-MM-DD`. */
+    DATE = "DATE",
+    /** [Date object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) (SDK) or an object in the following format: `"someFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. */
+    DATETIME = "DATETIME",
+    /** Binary file. */
+    BINARY = "BINARY",
+    /** object. */
+    OBJECT = "OBJECT",
+    /** Array. */
+    ARRAY = "ARRAY",
+    /** Web URL. */
+    URL = "URL",
+    WIX_MEDIA_URL = "WIX_MEDIA_URL",
+    WIX_MEDIA_IMAGE_URL = "WIX_MEDIA_IMAGE_URL",
+    WIX_MEDIA_VIDEO_URL = "WIX_MEDIA_VIDEO_URL",
+    WIX_MEDIA_DOCUMENT_URL = "WIX_MEDIA_DOCUMENT_URL",
+    IMAGE_URL = "IMAGE_URL",
+    VIDEO_URL = "VIDEO_URL"
+}
+/** @enumType */
+type FieldTypeWithLiterals = FieldType | 'ANY' | 'STRING' | 'NUMBER' | 'BOOLEAN' | 'DATE' | 'DATETIME' | 'BINARY' | 'OBJECT' | 'ARRAY' | 'URL' | 'WIX_MEDIA_URL' | 'WIX_MEDIA_IMAGE_URL' | 'WIX_MEDIA_VIDEO_URL' | 'WIX_MEDIA_DOCUMENT_URL' | 'IMAGE_URL' | 'VIDEO_URL';
+interface StoresCatalogProductsDestination {
+}
+/** Wix Media Manager destination. */
+interface WixMediaDestination {
+    /**
+     * ID of the target folder in the Media Manager. If not specified, media is imported to the root folder.
+     * @maxLength 256
+     */
+    targetFolderId?: string | null;
+}
+declare enum WixMediaDestinationWritePolicy {
+    /** Overwrite existing media with the same name. */
+    OVERWRITE = "OVERWRITE",
+    /** Skip media that already exists. */
+    SKIP_EXISTING = "SKIP_EXISTING"
+}
+/** @enumType */
+type WixMediaDestinationWritePolicyWithLiterals = WixMediaDestinationWritePolicy | 'OVERWRITE' | 'SKIP_EXISTING';
+/** Creates empty Wix data collections (no data items are inserted). */
+interface WixDataCollectionDefinitionDestination {
+    /** Policy for handling collections that already exist on the target site. */
+    writePolicy?: WritePolicyWithLiterals;
+}
+declare enum WritePolicy {
+    /** Only create new collections. Skip collections that already exist on the target site. */
+    SKIP_EXISTING = "SKIP_EXISTING",
+    /** Create new collections and overwrite existing ones. */
+    OVERWRITE = "OVERWRITE"
+}
+/** @enumType */
+type WritePolicyWithLiterals = WritePolicy | 'SKIP_EXISTING' | 'OVERWRITE';
+interface TestDestination {
+    /**
+     * Discriminator value for a particular test destination.
+     * @maxLength 512
+     */
+    type?: string;
+    /** Test destination details. */
+    details?: Record<string, any> | null;
+}
+interface Transformation extends TransformationTransformationOneOf {
+}
+/** @oneof */
+interface TransformationTransformationOneOf {
+}
+interface TestTransformation {
+}
+/** Create workflow request. */
+interface CreateWorkflowRequest {
+    /** Workflow to create. */
+    workflow: Workflow;
+}
+/** Create workflow response. */
+interface CreateWorkflowResponse {
+    /** Created workflow. */
+    workflow?: Workflow;
+}
+/** Get workflow request. */
+interface GetWorkflowRequest {
+    /**
+     * ID of the workflow to retrieve.
+     * @format GUID
+     */
+    workflowId: string;
+}
+/** Get workflow response. */
+interface GetWorkflowResponse {
+    /** Retrieved workflow. */
+    workflow?: Workflow;
+}
+/** Query workflows request. */
+interface QueryWorkflowsRequest {
+    /** Query options. */
+    query?: CursorQuery;
+}
+interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor paging options. */
+    cursorPaging?: CursorPaging;
+    /** Filter object. */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort fields.
+     * @maxSize 5
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+interface CursorQueryPagingMethodOneOf {
+    /** Cursor paging options. */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface CursorPaging {
+    /**
+     * Maximum number of items to return.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Cursor token from a previous response.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+/** Query workflows response. */
+interface QueryWorkflowsResponse {
+    /** Matching workflows. */
+    workflows?: Workflow[];
+    /** Cursor paging metadata for the current result set. */
+    pagingMetadata?: CursorPagingMetadata;
+}
+interface CursorPagingMetadata {
+    /** Number of items returned in the current page. */
+    count?: number | null;
+    /** Cursor values for navigating between pages. */
+    cursors?: Cursors;
+    /** Whether another page can be retrieved. */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /**
+     * Cursor pointing to the next page.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+/** Terminate workflow request. */
+interface TerminateWorkflowRequest {
+    /**
+     * ID of the workflow to terminate.
+     * @format GUID
+     */
+    workflowId: string;
+}
+/** Terminate workflow response. */
+interface TerminateWorkflowResponse {
+    /** Terminated workflow. */
+    workflow?: Workflow;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * 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;
+    /**
+     * 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`. */
+    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 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;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+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.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface Empty {
+}
+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;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+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?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+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;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * 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;
+    /**
+     * 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`. */
+    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 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;
+    accountInfo?: AccountInfoMetadata;
+}
+interface AccountInfoMetadata {
+    /** ID of the Wix account associated with the event */
+    accountId: string;
+    /** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */
+    siteId?: string;
+    /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
+    parentAccountId?: string;
+}
+interface WorkflowCreatedEnvelope {
+    entity: Workflow;
+    metadata: EventMetadata;
+}
+/** @permissionScope Data Mover Manage Jobs
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE_MOVEMENT_JOBS
+ * @permissionId hub:v1:workflow:get_workflow
+ * @webhook
+ * @eventType wix.hub.v1.workflow_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onWorkflowCreated(handler: (event: WorkflowCreatedEnvelope) => void | Promise<void>): void;
+interface WorkflowUpdatedEnvelope {
+    entity: Workflow;
+    metadata: EventMetadata;
+}
+/** @permissionScope Data Mover Manage Jobs
+ * @permissionScopeId SCOPE.DC-DATA.MANAGE_MOVEMENT_JOBS
+ * @permissionId hub:v1:workflow:get_workflow
+ * @webhook
+ * @eventType wix.hub.v1.workflow_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onWorkflowUpdated(handler: (event: WorkflowUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Creates a workflow and persists its immutable execution plan.
+ * @param workflow - Workflow to create.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField workflow
+ * @requiredField workflow.specs
+ * @permissionId hub:v1:workflow:create_workflow
+ * @applicableIdentity APP
+ * @returns Created workflow.
+ * @fqn wix.hub.v1.DataMovementWorkflowService.CreateWorkflow
+ */
+declare function createWorkflow(workflow: NonNullablePaths<Workflow, `specs`, 2>): Promise<NonNullablePaths<Workflow, `_id` | `status` | `specs` | `specs.${number}.sourceSiteId` | `specs.${number}.destinationSiteId` | `specs.${number}.source.wixDataCollection.collectionId` | `specs.${number}.source.file.format` | `specs.${number}.source.file.fileId` | `specs.${number}.source.file.url` | `specs.${number}.destination.wixDataCollection.collectionId` | `specs.${number}.destination.wixDataCollection.writePolicy` | `specs.${number}.destination.file.format` | `specs.${number}.destination.file.url`, 6>>;
+/**
+ * Retrieves a workflow by ID.
+ * @param workflowId - ID of the workflow to retrieve.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField workflowId
+ * @permissionId hub:v1:workflow:get_workflow
+ * @applicableIdentity APP
+ * @returns Retrieved workflow.
+ * @fqn wix.hub.v1.DataMovementWorkflowService.GetWorkflow
+ */
+declare function getWorkflow(workflowId: string): Promise<NonNullablePaths<Workflow, `_id` | `status` | `specs` | `specs.${number}.sourceSiteId` | `specs.${number}.destinationSiteId` | `specs.${number}.source.wixDataCollection.collectionId` | `specs.${number}.source.file.format` | `specs.${number}.source.file.fileId` | `specs.${number}.source.file.url` | `specs.${number}.destination.wixDataCollection.collectionId` | `specs.${number}.destination.wixDataCollection.writePolicy` | `specs.${number}.destination.file.format` | `specs.${number}.destination.file.url`, 6>>;
+/**
+ * Queries workflows using cursor paging, filtering, and sorting.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId hub:v1:workflow:query_workflows
+ * @applicableIdentity APP
+ * @fqn wix.hub.v1.DataMovementWorkflowService.QueryWorkflows
+ */
+declare function queryWorkflows(): WorkflowsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface WorkflowsQueryResult extends QueryCursorResult {
+    items: Workflow[];
+    query: WorkflowsQueryBuilder;
+    next: () => Promise<WorkflowsQueryResult>;
+    prev: () => Promise<WorkflowsQueryResult>;
+}
+interface WorkflowsQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    eq: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status', value: any) => WorkflowsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ne: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status', value: any) => WorkflowsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    ge: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => WorkflowsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    gt: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => WorkflowsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    le: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => WorkflowsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     * @documentationMaturity preview
+     */
+    lt: (propertyName: '_id' | '_createdDate' | '_updatedDate', value: any) => WorkflowsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     * @documentationMaturity preview
+     */
+    startsWith: (propertyName: '_id', value: string) => WorkflowsQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     * @documentationMaturity preview
+     */
+    hasSome: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status', value: any[]) => WorkflowsQueryBuilder;
+    /** @documentationMaturity preview */
+    in: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status', value: any) => WorkflowsQueryBuilder;
+    /** @documentationMaturity preview */
+    exists: (propertyName: '_id' | '_createdDate' | '_updatedDate' | 'status', value: boolean) => WorkflowsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    ascending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'status'>) => WorkflowsQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
+     * @documentationMaturity preview
+     */
+    descending: (...propertyNames: Array<'_id' | '_createdDate' | '_updatedDate' | 'status'>) => WorkflowsQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => WorkflowsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => WorkflowsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<WorkflowsQueryResult>;
+}
+/**
+ * @hidden
+ * @fqn wix.hub.v1.DataMovementWorkflowService.QueryWorkflows
+ * @requiredField query
+ * @returns Query workflows response.
+ */
+declare function typedQueryWorkflows(query: WorkflowQuery): Promise<NonNullablePaths<QueryWorkflowsResponse, `workflows` | `workflows.${number}._id` | `workflows.${number}.status`, 4>>;
+interface WorkflowQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [
+        {
+            fields: ['_createdDate', '_id', '_updatedDate', 'status'];
+            operators: '*';
+            sort: 'BOTH';
+        }
+    ];
+}
+type CommonQueryWithEntityContext = Query<Workflow, WorkflowQuerySpec>;
+type WorkflowQuery = {
+    /**
+    Cursor paging options.
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Cursor token from a previous response.
+      @maxLength: 16000
+      */
+        cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort fields.
+    @maxSize: 5
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
+declare const utils: {
+    query: {
+        QueryBuilder: () => _wix_sdk_types.QueryBuilder<Workflow, WorkflowQuerySpec, WorkflowQuery>;
+        Filter: _wix_sdk_types.FilterFactory<Workflow, WorkflowQuerySpec>;
+        Sort: _wix_sdk_types.SortFactory<WorkflowQuerySpec>;
+    };
+};
+/**
+ * Terminates a workflow and prevents further step creation.
+ * @param workflowId - ID of the workflow to terminate.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField workflowId
+ * @permissionId hub:v1:workflow:terminate_workflow
+ * @applicableIdentity APP
+ * @returns Terminate workflow response.
+ * @fqn wix.hub.v1.DataMovementWorkflowService.TerminateWorkflow
+ */
+declare function terminateWorkflow(workflowId: string): Promise<NonNullablePaths<TerminateWorkflowResponse, `workflow._id` | `workflow.status` | `workflow.specs` | `workflow.specs.${number}.sourceSiteId` | `workflow.specs.${number}.destinationSiteId` | `workflow.specs.${number}.source.wixDataCollection.collectionId` | `workflow.specs.${number}.source.file.format` | `workflow.specs.${number}.source.file.fileId` | `workflow.specs.${number}.source.file.url` | `workflow.specs.${number}.destination.wixDataCollection.collectionId` | `workflow.specs.${number}.destination.wixDataCollection.writePolicy` | `workflow.specs.${number}.destination.file.format` | `workflow.specs.${number}.destination.file.url`, 7>>;
+
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type BaseEventMetadata, type CommonQueryWithEntityContext, type CreateWorkflowRequest, type CreateWorkflowResponse, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DataMovementJobLogs, type Destination, type DestinationDestinationOneOf, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExternalFileSource, type Field, FieldType, type FieldTypeWithLiterals, type FileDestination, FileFormat, type FileFormatWithLiterals, type FileSource, type GetWorkflowRequest, type GetWorkflowResponse, type GoogleSheetsSource, type IdentificationData, type IdentificationDataIdOneOf, type JobSpec, type JobSpecSiteOverrideOneOf, type LocalizationDestination, type LocalizationSource, MediaType, type MediaTypeWithLiterals, type MessageEnvelope, type QueryWorkflowsRequest, type QueryWorkflowsResponse, type RestoreInfo, type Schema, SortOrder, type SortOrderWithLiterals, type Sorting, type Source, type SourceSourceOneOf, Status, type StatusWithLiterals, type StoresCatalogProductsDestination, type TerminateWorkflowRequest, type TerminateWorkflowResponse, type TestDestination, type TestSource, type TestTransformation, type Transformation, type TransformationTransformationOneOf, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixDataCollectionDefinitionDestination, type WixDataCollectionDefinitionSource, type WixDataDestination, WixDataDestinationWritePolicy, type WixDataDestinationWritePolicyWithLiterals, WixDataEnvironment, type WixDataEnvironmentWithLiterals, type WixDataSource, type WixMediaDestination, WixMediaDestinationWritePolicy, type WixMediaDestinationWritePolicyWithLiterals, type WixMediaSource, type Workflow, type WorkflowCreatedEnvelope, type WorkflowQuery, type WorkflowQuerySpec, type WorkflowUpdatedEnvelope, type WorkflowsQueryBuilder, type WorkflowsQueryResult, WritePolicy, type WritePolicyWithLiterals, createWorkflow, getWorkflow, onWorkflowCreated, onWorkflowUpdated, queryWorkflows, terminateWorkflow, typedQueryWorkflows, utils };