@wix/bex-utils 2.115.0 → 2.116.0

package/@wix/ambassador-hub-v1-job/src/main/proto/wix/hub/v1/data_movement_service.proto

@@ -0,0 +1,287 @@
+syntax = "proto3";
+
+package wix.hub.v1;
+
+option java_package = "com.wixpress.hub.v1";
+
+import "google/protobuf/empty.proto";
+import "google/protobuf/wrappers.proto";
+import "google/api/annotations.proto";
+import "wix/api/annotations.proto";
+import "wix/api/entity.proto";
+import "wix/api/subscription.proto";
+import "wix/api/permissions.proto";
+import "wix/api/validations.proto";
+import "wix/sdk/definitions.proto";
+import "wix/common/paging.proto";
+import "wix/common/sorting.proto";
+import "wix/common/query.proto";
+
+import 'wix/hub/v1/job.proto';
+import 'wix/hub/v1/common.proto';
+import 'wix/hub/v1/shared.proto';
+
+service DataMovementService {
+    option (.wix.api.service_entity).message = "wix.hub.v1.DataMovementJob";
+    option (.wix.api.service_maturity) = GA;
+    option (wix.api.service_exposure) = PUBLIC;
+
+    // Submit a data movement job.
+    //
+    // > **Note**: By default, the job is submitted for the current site.
+    rpc SubmitJob (SubmitJobRequest) returns (SubmitJobResponse) {
+        option (wix.api.maturity) = GA;
+        option (wix.api.exposure) = PUBLIC;
+        option (.google.api.http).post = "/v1/jobs";
+        option (.wix.api.permission).name = "WIX_DATA.DATA_JOB_SUBMIT";
+
+        option (.wix.sdk.signature) = {
+            params: "source"
+            params: "destination"
+        };
+
+        option (.wix.api.required) = "SubmitJobRequest.source";
+        option (.wix.api.required) = "SubmitJobRequest.source.source";
+
+        option (.wix.api.required) = "SubmitJobRequest.source.source.wix_data_collection.collection_id";
+        option (.wix.api.required) = "SubmitJobRequest.source.source.localization.languages";
+        option (.wix.api.required) = "SubmitJobRequest.source.source.file.file_id";
+
+
+        option (.wix.api.required) = "SubmitJobRequest.destination";
+        option (.wix.api.required) = "SubmitJobRequest.destination.destination";
+        option (.wix.api.required) = "SubmitJobRequest.destination.destination.wix_data_collection.collection_id";
+        option (.wix.api.required) = "SubmitJobRequest.destination.destination.localization.languages";
+        option (.wix.api.required) = "SubmitJobRequest.destination.destination.file.format";
+    }
+
+    // Creates an upload URL for a data source file.
+    //
+    // Before submitting a job to import data from a file to a collection, call this method to generate an upload URL. Use the `uploadUrl` in the response to upload your source file. For example:
+    //
+    // `curl --request PUT --upload-file "${path_to_file}" "${uploadUrl}"`
+    //
+    // > **Note**: The URL is valid for 15 minutes.
+    rpc CreateFileUploadUrl (CreateFileUploadUrlRequest) returns (CreateFileUploadUrlResponse) {
+        option (wix.api.maturity) = GA;
+        option (wix.api.exposure) = PUBLIC;
+        option (google.api.http) = {
+            post: "/v1/temporary-files/upload-url"
+        };
+        option (.wix.api.permission).name = "WIX_DATA.TMP_FILE_UPLOAD_CREATE";
+    }
+
+    // Retrieves the specified data movement job. 
+    //
+    // > **Note**: You can only retrieve jobs submitted for the current site.
+    rpc GetJob (GetJobRequest) returns (GetJobResponse) {
+        option (wix.api.maturity) = GA;
+        option (wix.api.exposure) = PUBLIC;
+        option (.google.api.http).get = "/v1/jobs/{job_id}";
+        option (.wix.api.permission).name = "WIX_DATA.DATA_JOB_GET";
+        option (.wix.api.crud) = {
+            method: GET_ITEM
+        };
+    }
+
+    // Lists data movement jobs for the current site. 
+    //
+    //The `listJobs()` method builds a query to retrieve a list of jobs for the current site, and returns a [`JobsQueryBuilder`](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/jobs-query-builder/ascending) object. The returned object contains the query definition, which is typically used to run the query using the [`find()`](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/jobs-query-builder/find) method. 
+    //
+    // You can refine the query by chaining `JobsQueryBuilder` methods onto the query. `JobsQueryBuilder` methods enable you to sort, filter, and control the results `listJobs()` returns. 
+    //
+    // `listJobs()` runs with these `JobsQueryBuilder` defaults, which you can override:
+    //
+    // - [`skipTo`: `0`](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/jobs-query-builder/skip-to)
+    // - [`limit`: `50`](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/jobs-query-builder/limit)
+    // - [`ascending`: by `_id`](https://dev.wix.com/docs/sdk/backend-modules/data/movement-jobs/jobs-query-builder/ascending)
+    // 
+    // The methods chained to `listJobs()` are applied in the order they're called. For example, if you apply `ascending('firstName')` and then `descending('age')`, the results are sorted first by firstName, and then, if there are multiple results with the same `firstName`, the items are sorted by `age`.
+    rpc ListJobs (ListJobsRequest) returns (ListJobsResponse) {
+        option (wix.api.maturity) = GA;
+        option (wix.api.exposure) = PUBLIC;
+        option (.google.api.http) = {
+            post: "/v1/jobs/list",
+            additional_bindings: {
+                get: "/v1/jobs"
+            }
+        };
+        option (.wix.api.permission).name = "WIX_DATA.DATA_JOB_LIST";
+        option (wix.api.crud) = {
+            method: LIST
+            list_options: {
+                items_field: 'jobs'
+                paging: {
+                    type: CURSOR
+                    cursor_paging_metadata_field: 'paging_metadata'
+                }
+            }
+        };
+    }
+
+    // Retrieves data movement jobs for the current site, on the basis of the filtering, sorting, and paging preferences you provide.
+    //
+    // Learn more about [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language) and [sorting and paging](https://dev.wix.com/docs/rest/articles/get-started/sorting-and-paging) configuration.
+    // flynt-disable crud-query-message-validation
+    rpc QueryJobs (QueryJobsRequest) returns (QueryJobsResponse) {
+        option (wix.api.maturity) = GA;
+        option (wix.api.exposure) = PUBLIC;
+        option (.google.api.http) = {
+            post: "/v1/jobs/query",
+            additional_bindings: {
+                get: "/v1/jobs/query"
+            }
+        };
+        option (.wix.api.permission).name = "WIX_DATA.DATA_JOB_LIST";
+        option (wix.api.crud) = {
+            method: QUERY
+            query_options: {
+                items_field: 'jobs'
+                paging: {
+                    type: CURSOR
+                    cursor_paging_metadata_field: 'paging_metadata'
+                }
+            }
+        };
+    }
+
+    // Terminates the specified job.
+    rpc TerminateJob (TerminateJobRequest) returns (TerminateJobResponse) {
+        option (wix.api.maturity) = GA;
+        option (wix.api.exposure) = PUBLIC;
+        option (.google.api.http).post = "/v1/jobs/{job_id}/terminate";
+        option (.wix.api.permission).name = "WIX_DATA.DATA_JOB_TERMINATE";
+    }
+
+    // Lists logs for the specified job.
+    // 
+    // Logs are generated by the destination for each item that failed to move. Some destinations also generate logs for items that moved successfully. 
+    rpc ListMovementLogs (ListMovementLogsRequest) returns (ListMovementLogsResponse) {
+        option (wix.api.maturity) = GA;
+        option (wix.api.exposure) = PUBLIC;
+        option (.google.api.http).get = "/v1/jobs/{job_id}/logs";
+        option (.wix.api.permission).name = "WIX_DATA.DATA_JOB_LIST_LOGS";
+    }
+
+    // --- private part ---
+
+    // Callback sent from job executor pod
+    rpc OnJobCallback (JobCallback) returns (google.protobuf.Empty) {
+        option (.wix.api.exposure) = INTERNAL;
+        option (.wix.api.subscription) = {
+            topic: "wix_hub_v1_job_callback"
+            segment: USERS
+        };
+    }
+
+    // Get job by ID without restricting current metaSiteId
+    rpc TerminateJobById (TerminateJobByIdRequest) returns (TerminateJobByIdResponse) {
+        option (.wix.api.exposure) = PRIVATE;
+    }
+
+}
+
+message TerminateJobRequest {
+    // ID of the job to terminate.
+    string job_id = 1 [(wix.api.format) = GUID];
+}
+
+message TerminateJobResponse {
+    // Details of the terminated job.
+    DataMovementJob job = 1;
+}
+
+message SubmitJobResponse {
+    // Details of the submitted job.
+    DataMovementJob job = 1;
+}
+
+
+message GetJobRequest {
+    // Job ID.
+    string job_id = 1 [(wix.api.format) = GUID];
+}
+
+message GetJobResponse {
+    // Details of the retrieved job.
+    DataMovementJob job = 1;
+}
+
+message ListJobsRequest {
+    // Paging metadata.
+    wix.common.CursorPaging paging = 1;
+    // Query preferences. Learn more about [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+    wix.common.QueryV2 query = 2 [
+        (wix.api.field_exposure) = INTERNAL,
+        deprecated = true,
+        (wix.api.field_deprecated) = {
+            target_removal_date: "2025-09-30"
+        }
+    ];
+}
+
+message ListJobsResponse {
+    // List of jobs for the current site.
+    repeated DataMovementJob jobs = 1;
+    // Paging metadata.
+    wix.common.CursorPagingMetadata paging_metadata = 2;
+}
+
+message GetJobByIdRequest {
+    // ID of the job to retrieve.
+    string job_id = 1 [(wix.api.format) = GUID];
+}
+
+message GetJobByIdResponse {
+    // Details of the retrieved job.
+    DataMovementJob job = 1;
+}
+
+message QueryJobsRequest {
+    // Query preferences. Learn more about [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+    wix.common.CursorQuery query = 1;
+}
+
+message QueryJobsResponse {
+  // List of jobs matching the query.
+  repeated DataMovementJob jobs = 1;
+  // Paging metadata.
+  wix.common.CursorPagingMetadata paging_metadata = 2;
+}
+
+message TerminateJobByIdRequest {
+    // ID of the job to terminate.
+    string job_id = 1 [(wix.api.format) = GUID];
+}
+
+message TerminateJobByIdResponse {
+    // Details of the terminated job.
+    DataMovementJob job = 1;
+}
+
+message ListMovementLogsRequest {
+    // ID of the job for which to list logs.
+    string job_id = 1 [(wix.api.format) = GUID];
+    // Paging metadata.
+    wix.common.CursorPaging paging = 2;
+}
+
+message ListMovementLogsResponse {
+    // Job logs.
+    repeated MovementLog logs = 1;
+    // Paging metadata.
+    wix.common.CursorPagingMetadata paging_metadata = 2;
+}
+
+
+message CreateFileUploadUrlRequest {
+  // Name of uploaded file.
+  google.protobuf.StringValue file_name = 2 [(wix.api.maxLength) = 512];
+}
+
+message CreateFileUploadUrlResponse {
+  // File ID.
+  string file_id = 1 [(.wix.api.maxLength) = 512];
+  // URL to which you can upload the file.
+  string upload_url = 2 [(.wix.api.maxLength) = 8192];
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/wix/hub/v1/destinations.proto

@@ -0,0 +1,154 @@
+// flynt-disable no-oneof-empty-markers
+syntax = "proto3";
+
+package wix.hub.v1;
+option java_package = "com.wixpress.hub.v1";
+
+import 'wix/hub/v1/common.proto';
+import 'wix/hub/v1/schema.proto';
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+
+message Destination {
+  oneof destination {
+    // 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).
+    WixDataDestination wix_data_collection = 201;
+    // 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).
+    LocalizationDestination localization = 202;
+    // Downloadable file with the moved items.
+    FileDestination file = 203;
+    // Stores Catalog V3 Products collection.
+    StoresCatalogProductsDestination stores_catalog_products = 204 [(wix.api.field_exposure) = INTERNAL, (wix.api.field_maturity) = ALPHA];
+    
+    // Wix Media Manager destination.
+    //
+    // You can use the destination to import media from another site or from an external source. 
+    // To import external media, item in the source should have these fields:
+    // * `url` - external HTTP(S) link to download the item
+    // * `displayName` - new name in the Media Manager
+    WixMediaDestination wix_media = 205 [(wix.api.field_exposure) = INTERNAL, (wix.api.field_maturity) = ALPHA];
+    // Target for creating new Wix data collections.
+    //
+    // Creates new empty collections on the target site (structure only, no data items). Each item describes structure of a single collection (e.g. fields, display names, and other information).
+    WixDataCollectionDefinitionDestination wix_data_collection_definition = 206 [(wix.api.field_exposure) = INTERNAL, (wix.api.field_maturity) = ALPHA];
+    // Stores Catalog V3 Inventory collection.
+    StoresCatalogInventoryDestination stores_catalog_inventory = 207 [(wix.api.field_exposure) = INTERNAL, (wix.api.field_maturity) = ALPHA];
+
+    // Test destination used for destinations in development. Once development is complete, specify a destination with a well-defined API.
+    TestDestination test = 106 [(wix.api.field_exposure) = INTERNAL, (wix.api.field_maturity) = ALPHA];
+  }
+}
+
+message TestDestination {
+  // Discriminator value for a particular test destination.
+  string type = 1 [(wix.api.maxLength) = 512];
+  // Test destination details.
+  google.protobuf.Struct details = 2;
+}
+
+// Wix data collection.
+message WixDataDestination {
+  enum WritePolicy {
+    // When an item with the same ID exists in the collection, overwrite it. 
+    OVERWRITE = 0;
+
+    // When an item with the same ID exists in the collection, skip it. 
+    SKIP_EXISTING = 1;
+
+    // Clear the destination collection before moving data. When the job completes, the collection contains only the moved data.
+    TRUNCATE_BEFORE = 2;
+  }
+
+  // ID of the destination collection.
+  string collection_id = 1 [(wix.api.maxLength) = 256];
+
+  // When items already exist in the destination collection, the data writing policy.
+  //
+  // Default: `OVERWRITE`.
+  WritePolicy write_policy = 2;
+
+  // [Collection environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing) to which to write data. Default: `LIVE`.
+  WixDataEnvironment environment = 3 [(wix.api.field_exposure) = INTERNAL];
+
+  // Grid App ID. Optional in a collection's LIVE environment.
+  google.protobuf.StringValue app_id = 4 [(wix.api.format) = GUID, (wix.api.field_exposure) = INTERNAL];
+}
+
+message 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).
+  repeated string languages = 1 [(wix.api.minSize) = 2, (wix.api.maxSize) = 64, (wix.api.format) = LANGUAGE_TAG];
+}
+
+
+// Destination file. Creates a file and generates a download URL.
+message FileDestination {
+  // File format. 
+  FileFormat format = 1 ;
+
+  // File name.
+  google.protobuf.StringValue file_name = 2 [(wix.api.maxLength) = 512];
+
+  // File ID.
+  string file_id = 3 [(wix.api.readOnly) = true, (wix.api.maxLength) = 128, (wix.api.field_exposure) = INTERNAL];
+
+  // File download URL.
+  string url = 101 [(wix.api.readOnly) = true, (wix.api.maxLength) = 2048];
+
+  // Formatting schema for the destination file. 
+  //
+  // When moving data to CSV files, use each field's `key` to specify the path of the data in the source item. Use each field's `display_name` property to set the header in the CSV file's first row.
+  // 
+  // For example, a source item of the [type](https://dev.wix.com/docs/rest/business-solutions/cms/data-types-in-wix-data) `Object` with the nested properties `data: {address: {city: cityName}}` can be mapped to the CSV file by specifying the field's `key` as `data.address.city` and its `display_name` as `City`.
+  // 
+  // If the schema isn't set, the source file schema is used. 
+  Schema schema = 4 [(wix.api.field_maturity) = ALPHA];
+}
+
+message StoresCatalogProductsDestination {
+
+}
+
+message StoresCatalogInventoryDestination {
+
+}
+
+// Creates empty Wix data collections (no data items are inserted).
+message WixDataCollectionDefinitionDestination {
+  // Policy for handling collections that already exist on the target site.
+  WritePolicy write_policy = 1;
+
+  enum WritePolicy {
+    // Only create new collections. Skip collections that already exist on the target site.
+    SKIP_EXISTING = 0;
+    // Create new collections and overwrite existing ones.
+    OVERWRITE = 1;
+  }
+}
+
+// Wix Media Manager destination.
+message WixMediaDestination {
+  reserved 1;
+  // ID of the target folder in the Media Manager. If not specified, media is imported to the root folder.
+  google.protobuf.StringValue target_folder_id = 3 [(wix.api.maxLength) = 256];
+
+  // Policy for handling duplicate media items.
+  // Not currently supported.
+  WritePolicy write_policy = 2 [(wix.api.field_exposure) = INTERNAL];
+
+  enum WritePolicy {
+    // Overwrite existing media with the same name.
+    OVERWRITE = 0;
+    // Skip media that already exists.
+    SKIP_EXISTING = 1;
+  }
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/wix/hub/v1/job.proto

@@ -0,0 +1,164 @@
+//flynt-disable aligned-with-enum-empty-options
+//flynt-disable missing-taggable-annotation
+
+syntax = "proto3";
+
+package wix.hub.v1;
+
+option java_package = "com.wixpress.hub.v1";
+
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+import "wix/api/entity.proto";
+import "wix/api/errors.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/common/data/dataextensions/extended-fields.proto";
+
+import 'wix/hub/v1/sources.proto';
+import 'wix/hub/v1/destinations.proto';
+import 'wix/hub/v1/transformations.proto';
+import 'wix/hub/v1/common.proto';
+
+// Data movement job object. 
+message DataMovementJob {
+  option (wix.api.entity) = {
+    fqdn: "wix.hub.v1.job"
+    segment: USERS
+    extensible: {}
+    appendix_files: {
+      type: DOCS_CONF
+      path: "appendices/docs"
+    }
+    appendix_files: {
+      type: AUTO_SDK
+      path: "appendices/sdk"
+    }
+    domain_events_read_permission: "WIX_DATA.DATA_JOB_GET"
+    query_options: {
+      wql: {
+        pattern: {
+          operator: ALL_APPLICABLE_OPERATORS
+          field: "id",
+          field: "name",
+          field: "started_at",
+          field: "finished_at",
+          field: "status",
+          field: "schedule_id",
+          field: "workflow_id",
+          sort: BOTH
+        }
+      }
+    }
+  };
+
+  // Triggered when a job is submitted.
+  option (wix.api.domain_event) = {
+    event_type: CREATED
+    exposure: PUBLIC
+    maturity: GA
+  };
+
+  // Triggered when a job's `status` updates.
+  option (wix.api.domain_event) = {
+    event_type: UPDATED
+    exposure: PUBLIC
+    maturity: GA
+  };
+  
+  // Triggered when a job is terminated.
+  option (wix.api.domain_event) = {
+    event_type: DELETED
+    exposure: PUBLIC
+    maturity: GA
+  };
+
+
+  // Job ID.
+  string id = 1 [(.wix.api.format) = GUID, (.wix.api.readOnly) = true];
+
+  // When the job was submitted.
+  google.protobuf.Timestamp started_at = 2 [(.wix.api.readOnly) = true];
+
+  // Current job status.
+  JobStatus status = 3 [(.wix.api.readOnly) = true];
+
+  // Source to move data from.
+  Source source = 4;
+
+  // Destination to move data to.
+  Destination destination = 5;
+
+  // Transformations to apply to the data before moving it to the destination.
+  repeated Transformation transformations = 6 [(wix.api.maxSize) = 32, (wix.api.field_exposure) = INTERNAL];
+
+  // Job name.
+  string name = 7 [(wix.api.maxLength) = 1024];
+
+  // When the job `status` is `IN_PROGRESS`, the progress details. 
+  Progress progress = 21 [(.wix.api.readOnly) = true];
+
+  // Job finish time. 
+  //
+  // A job is considered finished when its `status` updates to `COMPLETED`, `FAILED`, or `PARTIALLY_SUCCESSFUL`.
+  google.protobuf.Timestamp finished_at = 22 [(.wix.api.readOnly) = true];
+
+  // Error information.
+  wix.api.ApplicationError error = 24 [(.wix.api.readOnly) = true];
+
+  // Data center where the job started.
+  google.protobuf.StringValue data_center = 25 [(wix.api.readOnly) = true, (wix.api.field_exposure) = INTERNAL, (wix.api.maxLength) = 64];
+
+  // When moving data from a Wix data collection, the source site ID. 
+  //
+  // By default, the source site is the current site. To move data from [any site in the same Wix Account](https://support.wix.com/en/article/managing-multiple-sites-under-one-account), specify the site ID, which you can retrieve by calling [Get App Instance](https://dev.wix.com/docs/rest/app-management/app-instance/get-app-instance).
+  //
+  // > **Note**: You can specify the ID of a source site or destination site, but not both.
+  string source_site_id = 26 [(wix.api.format) = GUID];
+
+  // When moving data to a Wix data collection, the destination site ID. 
+  //
+  // By default, the destination site is the current site. To move data to [any site in the same Wix Account](https://support.wix.com/en/article/managing-multiple-sites-under-one-account), specify the site ID, which you can retrieve by calling [Get App Instance](https://dev.wix.com/docs/rest/app-management/app-instance/get-app-instance).
+  //
+  // > **Note**: You can specify the ID of a source site or destination site, but not both.
+  string destination_site_id = 27 [(wix.api.format) = GUID];
+
+  // Number of recorded logs.
+  int32 logs_recorded = 28;
+
+  oneof status_options {
+    option (wix.api.aligned_with_enum).field = "status";
+
+    // When the job's `status` is `PARTIALLY_SUCCESSFUL`, the additional details.
+    PartiallySuccessfulStatusOptions partially_successful_options = 29;
+  }
+
+  // Sync Schedule ID, if the job was triggered by a sync schedule.
+  google.protobuf.StringValue schedule_id = 30 [(wix.api.format) = GUID, (wix.api.readOnly) = true];
+
+  // Extended fields for custom metadata added by applications.
+  wix.common.data.dataextensions.ExtendedFields extended_fields = 31;
+
+  // Workflow ID, if the job was created as a child step of a workflow.
+  google.protobuf.StringValue workflow_id = 32 [(wix.api.format) = GUID, (.wix.api.readOnly) = true];
+}
+
+enum JobStatus {
+  // Job was submitted but has not yet started.
+  UNINITIALIZED = 0;
+  // Job is initializing.
+  INITIALIZING = 1;
+  // Job is in progress.
+  IN_PROGRESS = 3;
+  // Job has successfully completed.
+  COMPLETED = 4;
+  // Job has failed.
+  FAILED = 5;
+  // Job has completed but was partially successful due to a destination limitation. See `PartiallySuccessfulOptions` for additional details.
+  PARTIALLY_SUCCESSFUL = 6;
+}
+
+message PartiallySuccessfulStatusOptions {
+  // Reason the job was partially successful.
+  string cause = 1 [(wix.api.maxLength) = 1000];
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/wix/hub/v1/job_spec.proto

@@ -0,0 +1,41 @@
+syntax = "proto3";
+
+package wix.hub.v1;
+
+option java_package = "com.wixpress.hub.v1";
+
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+
+import "wix/hub/v1/destinations.proto";
+import "wix/hub/v1/sources.proto";
+import "wix/hub/v1/transformations.proto";
+
+// Immutable specification for a single data movement step.
+message JobSpec {
+  // Source to read data from.
+  Source source = 1;
+  // Destination to write data to.
+  Destination destination = 2;
+  // Transformations to apply before writing to the destination.
+  repeated Transformation transformations = 3 [(wix.api.maxSize) = 32, (wix.api.field_exposure) = INTERNAL];
+
+  oneof site_override {
+    /*
+    When moving data from the Wix data collection of a site other than the current site, the ID of the site to read from.
+
+    By default, the `source` site is the current site. However, you can move data from any site in the same [Wix Account](https://support.wix.com/en/article/managing-multiple-sites-under-one-account).
+
+    > **Note**: You can specify the ID of a `source` site or a `destination` site other than the current site, but not both.
+    */
+    string source_site_id = 4 [(wix.api.format) = GUID];
+    /*
+    When moving data to the Wix data collection of a site other than the current site, the ID of the site to write to.
+
+    By default, the `destination` site is the current site. However, you can move data to any site in the same [Wix Account](https://support.wix.com/en/article/managing-multiple-sites-under-one-account).
+
+    > **Note**: You can specify the ID of a `destination` site or a `source` site other than the current site, but not both.
+    */
+    string destination_site_id = 5 [(wix.api.format) = GUID];
+  }
+}