@wix/bex-utils 2.115.0 → 2.117.0

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/async-job-status.proto

@@ -0,0 +1,34 @@
+//flynt-disable package-matches-structure
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+
+message GetAsyncJobStatusRequest {
+  // Job ID returned from an async operation, such as
+  // [Async Patch Data Items By Filter](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/async-patch-data-items-by-filter)
+  // or [Async Remove Data Items By Filter](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/async-remove-data-items-by-filter).
+  string job_id = 1 [(.wix.api.maxLength) = 256];
+}
+
+message GetAsyncJobStatusResponse {
+  // Current status of the async operation.
+  Status status = 1;
+
+  // Number of items successfully processed so far.
+  int32 success_count = 2;
+
+  enum Status {
+    UNKNOWN_STATUS = 0 [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
+    // Job has been created but processing has not started yet.
+    INITIALIZED = 1;
+    // Job is actively processing items.
+    PROCESSING = 2;
+    // Job has completed successfully.
+    SUCCEEDED = 3;
+    // Job stopped due to an error. Some items may already have been processed.
+    FAILED = 4;
+  }
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/async-patch-by-filter.proto

@@ -0,0 +1,66 @@
+//flynt-disable package-matches-structure
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "com/wixpress/cloud/data/api/common.proto";
+import "com/wixpress/cloud/data/api/data/message/patch-data-item.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+
+message AsyncPatchDataItemsByFilterRequest {
+  // [Collection environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing) from which to patch items.
+  //
+  // Default: `LIVE`.
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection containing items to patch.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Filter to select items to patch, using [WQL filter syntax](https://dev.wix.com/docs/rest/api-reference/api-query-language/filtering).
+  //
+  // Filtering is supported for fields explicitly defined in the
+  // [data collection structure](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/introduction#data-collections-and-their-structure).
+  // Fields not defined in the collection structure can't be used for filtering.
+  // Using an undefined field in the filter causes the async job to fail after the method returns a job ID.
+  // Each [field type](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-type)
+  // supports specific [filter operators](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#operators).
+  // Using an unsupported operator causes the async job to fail after the method returns a job ID.
+  // Poll [Get Async Job Status](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/get-async-job-status)
+  // for the final status.
+  //
+  // An empty filter patches all items in the collection.
+  google.protobuf.Struct filter = 3;
+
+  // Field modifications to apply to each matching item.
+  // Supports the same modification model as
+  // [Patch Data Item](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/patch-data-item),
+  // including setting, removing, and incrementing fields.
+  repeated FieldModification field_modifications = 4 [(.wix.api.minSize) = 1, (.wix.api.maxSize) = 100];
+
+  // Grid app id. Optional in Live segment.
+  google.protobuf.StringValue app_id = 5 [(.wix.api.format) = GUID, (wix.api.field_exposure) = PRIVATE];
+
+  // Whether to suppress data hooks.
+  // When `true`, data hooks typically triggered by this endpoint don't run.
+  //
+  // > **Note:** This option can only be used in code that runs in [the Wix site backend](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/backend-code/about-the-site-backend).
+  //
+  // Default: `false`
+  bool suppress_hooks = 6 [(wix.api.field_exposure) = PRIVATE];
+
+  // Options for the [Publish plugin](https://support.wix.com/en/article/cms-controlling-live-site-item-visibility-from-your-collection).
+  //
+  // This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+  PublishPluginOptions publish_plugin_options = 7;
+}
+
+message AsyncPatchDataItemsByFilterResponse {
+  // Job ID for tracking the async operation.
+  //
+  // Call [Get Async Job Status](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/get-async-job-status) with this ID to poll for status.
+  string job_id = 1 [(.wix.api.maxLength) = 256];
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/async-remove-by-filter.proto

@@ -0,0 +1,59 @@
+//flynt-disable package-matches-structure
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "com/wixpress/cloud/data/api/common.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+
+message AsyncRemoveDataItemsByFilterRequest {
+  // [Collection environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing) from which to remove items.
+  //
+  // Default: `LIVE`.
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection containing items to remove.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Filter to select items to remove, using [WQL filter syntax](https://dev.wix.com/docs/rest/api-reference/api-query-language/filtering).
+  //
+  // Filtering is supported for fields explicitly defined in the
+  // [data collection structure](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/introduction#data-collections-and-their-structure).
+  // Fields not defined in the collection structure can't be used for filtering.
+  // Using an undefined field in the filter causes the async job to fail after the method returns a job ID.
+  // Each [field type](https://support.wix.com/en/article/cms-formerly-content-manager-about-your-collection-fields#field-type)
+  // supports specific [filter operators](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#operators).
+  // Using an unsupported operator causes the async job to fail after the method returns a job ID.
+  // Poll [Get Async Job Status](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/get-async-job-status)
+  // for the final status.
+  //
+  // An empty filter removes all items in the collection.
+  google.protobuf.Struct filter = 3;
+
+  // Grid app id. Optional in Live segment.
+  google.protobuf.StringValue app_id = 4 [(.wix.api.format) = GUID, (wix.api.field_exposure) = PRIVATE];
+
+  // Whether to suppress data hooks.
+  // When `true`, data hooks typically triggered by this endpoint don't run.
+  //
+  // > **Note:** This option can only be used in code that runs in [the Wix site backend](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/backend-code/about-the-site-backend).
+  //
+  // Default: `false`
+  bool suppress_hooks = 5 [(wix.api.field_exposure) = PRIVATE];
+
+  // Options for the [Publish plugin](https://support.wix.com/en/article/cms-controlling-live-site-item-visibility-from-your-collection).
+  //
+  // This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.
+  PublishPluginOptions publish_plugin_options = 6;
+}
+
+message AsyncRemoveDataItemsByFilterResponse {
+  // Job ID for tracking the async operation.
+  //
+  // Call [Get Async Job Status](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/get-async-job-status) with this ID to poll for status.
+  string job_id = 1 [(.wix.api.maxLength) = 256];
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/bulk-data-item-reference-result.proto

@@ -0,0 +1,22 @@
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "com/wixpress/cloud/data/api/common.proto";
+import "com/wixpress/cloud/data/api/data/message/data-item-reference.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/bulk.proto";
+
+message BulkDataItemReferenceResult {
+  // The action attempted for the reference.
+  upstream.wix.common.BulkActionType action = 1;
+
+  // Metadata related to the reference for which the action was attempted.
+  upstream.wix.common.ItemMetadata reference_metadata = 2;
+
+  // The reference for which the action was attempted. Only returned if `returnEntity` is `true` in the request and the action is successful.
+  DataItemReference data_item_reference = 3;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/bulk-data-item-result.proto

@@ -0,0 +1,24 @@
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "com/wixpress/cloud/data/api/common.proto";
+import "com/wixpress/cloud/data/api/data/message/data-item.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/bulk.proto";
+
+message BulkDataItemResult {
+  // Action attempted for the data item.
+  upstream.wix.common.BulkActionType action = 1;
+
+  // Item metadata.
+  upstream.wix.common.ItemMetadata item_metadata = 2;
+
+  // Updated data item. 
+  //
+  // Returned if `returnEntity` is set to `true` and the action is successful.
+  DataItem data_item = 3;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/bulk-insert-references.proto

@@ -0,0 +1,54 @@
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/struct.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "com/wixpress/cloud/data/api/common.proto";
+import "com/wixpress/cloud/data/api/data/message/bulk-data-item-reference-result.proto";
+import "com/wixpress/cloud/data/api/data/message/data-item-reference.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+import "com/wixpress/cloud/data/api/data/message/reference-metadata.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/bulk.proto";
+
+message BulkInsertDataItemReferencesRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection containing the referring items.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // References to insert.
+  repeated DataItemReference data_item_references = 3 [(wix.api.maxSize) = 1000];
+
+  // Grid app id. Optional in Live segment.
+  google.protobuf.StringValue app_id = 4 [(wix.api.format) = GUID, (wix.api.field_exposure) = PRIVATE];
+
+  // Data access options
+  Options options = 5 [
+    (wix.api.field_exposure) = PRIVATE,
+    deprecated = true,
+    (wix.api.field_deprecated) = {
+      replaced_by: "inlined"
+      target_removal_date: "2024-07-12"
+    }
+  ];
+
+  // Whether to return the inserted data item references.
+  // When `true`, the `results` objects contain a `dataItemReference` field.
+  //
+  // Default: `false`
+  bool return_entity = 6;
+
+  google.protobuf.Struct app_options = 7 [(wix.api.field_exposure) = PRIVATE];
+}
+
+message BulkInsertDataItemReferencesResponse {
+  // Information about the inserted references.
+  repeated BulkDataItemReferenceResult results = 1;
+
+  // Bulk action metadata.
+  upstream.wix.common.BulkActionMetadata bulk_action_metadata = 2;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/bulk-insert.proto

@@ -0,0 +1,75 @@
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/struct.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "com/wixpress/cloud/data/api/common.proto";
+import "com/wixpress/cloud/data/api/data/message/bulk-data-item-result.proto";
+import "com/wixpress/cloud/data/api/data/message/data-item.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/bulk.proto";
+
+message BulkInsertDataItemsRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection in which to insert the items.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Data items to insert.
+  repeated DataItem data_items = 3 [(wix.api.maxSize) = 1000];
+
+  // Grid app id. Optional in Live segment.
+  google.protobuf.StringValue app_id = 4 [(wix.api.format) = GUID, (wix.api.field_exposure) = PRIVATE];
+
+  // Data access options.
+  Options options = 5 [
+    (wix.api.field_exposure) = PRIVATE,
+    deprecated = true,
+    (wix.api.field_deprecated) = {
+      replaced_by: "inlined"
+      target_removal_date: "2024-07-12"
+    }
+  ];
+
+  // Whether to return the inserted data items.
+  // When `true`, the `results` objects contain a `dataItem` field.
+  //
+  // Default: `false`
+  bool return_entity = 6;
+
+  // Whether to suppress data hooks. 
+  // When `true`, data hooks typically triggered by this endpoint don't run. 
+  //  
+  // **Note:** This option can only be used in code that runs in [the Wix site backend](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/backend-code/about-the-site-backend).
+  //
+  // Default: `false`
+  bool suppress_hooks = 7 [(wix.api.field_exposure) = PRIVATE];
+
+  // Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+  //
+  // When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters: 
+  // - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+  // - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+  google.protobuf.Struct app_options = 8;
+
+  // Whether to create references from multi-reference fields.
+  // When `true`, array values in multi-reference fields are extracted and stored as references
+  // linking each inserted item to its referenced items.
+  // Multi-reference field values must be arrays of referenced item IDs (strings)
+  // or referenced items containing an `_id` field.
+  //
+  // Default: `false`
+  bool save_references = 9 [(wix.api.field_exposure) = PRIVATE];
+}
+
+message BulkInsertDataItemsResponse {
+  // Information about the inserted items.
+  repeated BulkDataItemResult results = 1;
+
+  // Bulk action metadata.
+  upstream.wix.common.BulkActionMetadata bulk_action_metadata = 2;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/bulk-publish-data-item-drafts.proto

@@ -0,0 +1,46 @@
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "com/wixpress/cloud/data/api/data/message/data-item.proto";
+import "wix/api/validations.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/bulk.proto";
+import "com/wixpress/cloud/data/api/common.proto";
+import "wix/api/annotations.proto";
+
+message BulkPublishDataItemDraftsRequest {
+  // Environment: `LIVE` or `SANDBOX`.
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the published data collection.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // IDs of the data items whose drafts will be published. Each ID must reference an item with a pending draft; per-item `NOT_FOUND` is reported in the response when no draft exists for a given ID.
+  repeated string data_item_ids = 3 [(wix.api.maxLength) = 128, (wix.api.maxSize) = 1000];
+
+  // Whether to return the published data items.
+  // When `true`, the `results` objects contain a `dataItem` field.
+  //
+  // Default: `false`
+  bool return_entity = 4;
+}
+
+message BulkPublishDataItemDraftsResponse {
+  // Per-item results, in the same order as BulkPublishDataItemDraftsRequest.data_item_ids.
+  // Each entry carries item-level success/error metadata and (when return_entity was true) the published item.
+  repeated BulkPublishDataItemDraftResult results = 1;
+
+  // Aggregate counts: total_successes, total_failures, and undetailed_failures.
+  upstream.wix.common.BulkActionMetadata bulk_action_metadata = 2;
+}
+
+// Per-item result of a BulkPublishDataItemDrafts call.
+message BulkPublishDataItemDraftResult {
+
+  // Per-item success/failure metadata. item_metadata.original_index correlates with the same index in
+  // the request's data_item_ids.
+  upstream.wix.common.ItemMetadata item_metadata = 1;
+
+  // The newly published item. Populated only when BulkPublishDataItemDraftsRequest.return_entity = true.
+  com.wixpress.cloud.data.api.data.DataItem data_item = 2;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/bulk-remove-references.proto

@@ -0,0 +1,48 @@
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/struct.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "com/wixpress/cloud/data/api/common.proto";
+import "com/wixpress/cloud/data/api/data/message/bulk-data-item-reference-result.proto";
+import "com/wixpress/cloud/data/api/data/message/data-item-reference.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+import "com/wixpress/cloud/data/api/data/message/reference-metadata.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/bulk.proto";
+
+message BulkRemoveDataItemReferencesRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection containing the referring items.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // References to remove.
+  repeated DataItemReference data_item_references = 3 [(wix.api.maxSize) = 1000];
+
+  // Grid app id. Optional in Live segment.
+  google.protobuf.StringValue app_id = 4 [(wix.api.format) = GUID, (wix.api.field_exposure) = PRIVATE];
+
+  // Data access options
+  Options options = 5 [
+    (wix.api.field_exposure) = PRIVATE,
+    deprecated = true,
+    (wix.api.field_deprecated) = {
+      replaced_by: "inlined"
+      target_removal_date: "2024-07-12"
+    }
+  ];
+
+  google.protobuf.Struct app_options = 6 [(wix.api.field_exposure) = PRIVATE];
+}
+
+message BulkRemoveDataItemReferencesResponse {
+  // Information about the removed references.
+  repeated BulkDataItemReferenceResult results = 1;
+
+  // Bulk action metadata.
+  upstream.wix.common.BulkActionMetadata bulk_action_metadata = 2;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/bulk-remove.proto

@@ -0,0 +1,70 @@
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/struct.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "com/wixpress/cloud/data/api/common.proto";
+import "com/wixpress/cloud/data/api/data/message/bulk-data-item-result.proto";
+import "com/wixpress/cloud/data/api/data/message/data-item.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+import "com/wixpress/cloud/data/api/data/message/condition.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/bulk.proto";
+
+message BulkRemoveDataItemsRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection from which to remove the item.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // IDs of data items to remove.
+  repeated string data_item_ids = 3 [(wix.api.maxLength) = 128, (wix.api.maxSize) = 1000];
+
+  // Grid app id. Optional in Live segment.
+  google.protobuf.StringValue app_id = 4 [(wix.api.format) = GUID, (wix.api.field_exposure) = PRIVATE];
+
+  // Data access options
+  Options options = 5 [
+    (wix.api.field_exposure) = PRIVATE,
+    deprecated = true,
+    (wix.api.field_deprecated) = {
+      replaced_by: "inlined"
+      target_removal_date: "2024-07-12"
+    }
+  ];
+
+  // Whether to suppress data hooks. 
+  // When `true`, data hooks typically triggered by this endpoint don't run. 
+  //  
+  // **Note:** This option can only be used in code that runs in [the Wix site backend](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/backend-code/about-the-site-backend).
+  //
+  // Default: `false`
+  bool suppress_hooks = 6 [(wix.api.field_exposure) = PRIVATE];
+  
+  // Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+  //
+  // When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters: 
+  // - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+  // - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+  google.protobuf.Struct app_options = 7;
+
+  // Options for the Publish plugin. 
+  // This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.  
+  PublishPluginOptions publish_plugin_options = 8;
+
+  // Condition for removing the items.
+  //
+  // When a condition is provided, the items are only removed if the condition is met.
+  Condition condition = 9;
+}
+
+message BulkRemoveDataItemsResponse {
+  // Information about the removed data items.
+  repeated BulkDataItemResult results = 1;
+
+  // Bulk action metadata.
+  upstream.wix.common.BulkActionMetadata bulk_action_metadata = 2;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/bulk-save.proto

@@ -0,0 +1,80 @@
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/struct.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "com/wixpress/cloud/data/api/common.proto";
+import "com/wixpress/cloud/data/api/data/message/bulk-data-item-result.proto";
+import "com/wixpress/cloud/data/api/data/message/data-item.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/bulk.proto";
+
+message BulkSaveDataItemsRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection in which to insert or update the items.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Data items to insert or update.
+  repeated DataItem data_items = 3 [(wix.api.maxSize) = 1000];
+
+  // Grid app id. Optional in Live segment.
+  google.protobuf.StringValue app_id = 4 [(wix.api.format) = GUID, (wix.api.field_exposure) = PRIVATE];
+
+  // Data access options
+  Options options = 5 [
+    (wix.api.field_exposure) = PRIVATE,
+    deprecated = true,
+    (wix.api.field_deprecated) = {
+      replaced_by: "inlined"
+      target_removal_date: "2024-07-12"
+    }
+  ];
+
+  // Whether to return the saved data items.
+  // When `true`, the `results` objects contain a `dataItem` field.
+  //
+  // Default: `false`
+  bool return_entity = 6;
+
+  // Whether to suppress data hooks. 
+  // When `true`, data hooks typically triggered by this endpoint don't run. 
+  //  
+  // **Note:** This option can only be used in code that runs in [the Wix site backend](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/backend-code/about-the-site-backend).
+  //
+  // Default: `false`
+  bool suppress_hooks = 7 [(wix.api.field_exposure) = PRIVATE];
+  
+  // Additional parameters specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying.
+  //
+  // When querying the Wix Stores [Products collection](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-e-commerce-stores/wix-stores-products-collection-fields), pass the following optional parameters: 
+  // - `includeHiddenProducts`: Whether to include hidden products in the response. Default: `false`.
+  // - `includeVariants`: Whether to include product variants in the query. Default: `false`.
+  google.protobuf.Struct app_options = 8;
+
+  // Options for the Publish plugin. 
+  // This plugin allows items in a [data collection](https://dev.wix.com/docs/rest/business-solutions/cms/data-collections/data-collection-object) to be marked as draft or published. Published items are visible to site visitors, while draft items are not.  
+  PublishPluginOptions publish_plugin_options = 9;
+
+  // Whether to create or replace references from multi-reference fields.
+  // When `true`, array values in multi-reference fields are stored as references.
+  // For new items, references are created. For existing items, existing references are replaced
+  // with the provided values.
+  // Multi-reference field values must be arrays of referenced item IDs (strings)
+  // or referenced items containing an `_id` field.
+  //
+  // Default: `false`
+  bool save_references = 10 [(wix.api.field_exposure) = PRIVATE];
+}
+
+message BulkSaveDataItemsResponse {
+  // Information about the saved items.
+  repeated BulkDataItemResult results = 1;
+
+  // Bulk action metadata.
+  upstream.wix.common.BulkActionMetadata bulk_action_metadata = 2;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/bulk-unpublish-data-items.proto

@@ -0,0 +1,53 @@
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "com/wixpress/cloud/data/api/data/message/data-item.proto";
+import "wix/api/validations.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/bulk.proto";
+import "google/protobuf/wrappers.proto";
+import "com/wixpress/cloud/data/api/common.proto";
+import "wix/api/annotations.proto";
+
+message BulkUnpublishDataItemsRequest {
+  // Environment: `LIVE` or `SANDBOX`.
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the published data collection.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // IDs of the published data items to retract. Each ID must reference a published item; per-item `NOT_FOUND` is reported in the response when no published item exists with a given ID.
+  repeated string data_item_ids = 3 [(wix.api.maxLength) = 128, (wix.api.maxSize) = 1000];
+
+  // Whether to return the resulting draft data items.
+  // When `true`, the `results` objects contain a `dataItem` field.
+  //
+  // Default: `false`
+  bool return_entity = 4;
+
+  // Whether to create a draft copy of the published item.
+  // If `true`, any existing draft will be overwritten.
+  // If `false`, the published item is simply removed without creating a draft.
+  // Defaults to `true`.
+  google.protobuf.BoolValue copy_to_draft = 5;
+}
+
+message BulkUnpublishDataItemsResponse {
+  // Per-item results, in the same order as BulkUnpublishDataItemsRequest.data_item_ids.
+  // Each entry carries item-level success/error metadata and (when return_entity was true) the unpublished item.
+  repeated BulkUnpublishDataItemsResult results = 1;
+
+  // Aggregate counts: total_successes, total_failures, and undetailed_failures.
+  upstream.wix.common.BulkActionMetadata bulk_action_metadata = 2;
+}
+
+// Per-item result of a BulkUnpublishDataItems call.
+message BulkUnpublishDataItemsResult {
+
+  // Per-item success/failure metadata. item_metadata.original_index correlates with the same index in
+  // the request's data_item_ids.
+  upstream.wix.common.ItemMetadata item_metadata = 1;
+
+  // The unpublished item. Populated only when BulkUnpublishDataItemsRequest.return_entity = true.
+  com.wixpress.cloud.data.api.data.DataItem data_item = 2;
+}