@wix/bex-utils 2.115.0 → 2.116.0

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

@@ -0,0 +1,55 @@
+//flynt-disable boolean-field-name-prefix
+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/options.proto";
+
+message IsReferencedDataItemRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection containing the referring data item.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Field to check for a reference to the item that may be referenced.
+  string referring_item_field_name = 3 [(wix.api.maxLength) = 1000];
+
+  // ID of the referring item.
+  string referring_item_id = 4 [(wix.api.maxLength) = 128];
+
+  // ID of the item that may be referenced.
+  string referenced_item_id = 5 [(wix.api.maxLength) = 1000];
+
+  // Grid app id. Optional in Live segment.
+  google.protobuf.StringValue app_id = 6 [(wix.api.format) = GUID, (wix.api.field_exposure) = PRIVATE];
+
+  // Data access options
+  Options options = 7 [
+    (wix.api.field_exposure) = PRIVATE,
+    deprecated = true,
+    (wix.api.field_deprecated) = {
+      replaced_by: "inlined"
+      target_removal_date: "2024-07-12"
+    }
+  ];
+
+  // Whether to retrieve data from the primary database instance.
+  // This decreases performance but ensures data retrieved is up to date even immediately after an update.
+  // Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+  //
+  // Default: `false`
+  bool consistent_read = 8;
+
+  google.protobuf.Struct app_options = 9 [(wix.api.field_exposure) = PRIVATE];
+}
+
+message IsReferencedDataItemResponse {
+  // Whether the specified reference exists.
+  bool is_referenced = 1;
+}

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

@@ -0,0 +1,37 @@
+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";
+
+message IncludeReference {
+  // Field containing references in the item. This field must be configured as a reference or multi-reference field in the collection schema.
+  string field = 1 [(wix.api.maxLength) = 1000];
+  // Maximum number of referenced items to include for each item. When a reference field contains more items than this limit, only the first items up to the limit are included in the response. If not specified, up to 50 items are included.
+  google.protobuf.Int32Value limit = 2 [(wix.api.max) = 1000];
+}
+
+message PublishPluginOptions {
+  reserved 1;
+  // Whether to include draft items. 
+  //
+  // When `true`, both published and draft items are affected. Default: `false`.
+  bool include_draft_items = 2;
+}
+
+
+
+message Options {
+  message PublishPluginOptions {
+    bool show_draft_items = 1;
+  }
+  // Should hooks execution be suppressed.
+  // This option can only be used with Corvid backend
+  // code identity.
+  bool suppress_hooks = 1 [(wix.api.field_exposure) = PRIVATE];
+  google.protobuf.Struct app_options = 2 [(wix.api.field_exposure) = PRIVATE];
+  PublishPluginOptions publish_plugin_options = 3 [(wix.api.field_exposure) = PRIVATE];
+}

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

@@ -0,0 +1,184 @@
+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/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 PatchDataItemRequest {
+  // [Collection environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing) from which to delete item.
+  //
+  // Default: `LIVE`.
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection that contains the item to patch.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Patch to apply to the item.
+  Patch patch = 3;
+
+  // Grid app id. Optional in Live segment.
+  google.protobuf.StringValue app_id = 4 [(wix.api.format) = GUID, (wix.api.field_exposure) = PRIVATE];
+
+  reserved 6;
+
+  // Whether to suppress data hooks. When `true`, data hooks typically triggered by this method don't run. 
+  //  
+  // > **Note:** This can only be used in code that runs in a [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 options specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying. 
+  //
+  // Learn more about [querying Wix app collections](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-app-collections/querying-wix-app-collections).
+  google.protobuf.Struct app_options = 8 [(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 = 9;
+
+  // Condition for patching the item.
+  //
+  // When a condition is provided, the item is only patched if the condition is met.
+  Condition condition = 10;
+}
+
+message PatchDataItemResponse {
+  // Patched data item.
+  DataItem data_item = 1;
+}
+
+message Patch {
+  // ID of the item to patch.
+  string data_item_id = 1 [(wix.api.maxLength) = 256];
+
+  // Modifications to apply.
+  repeated FieldModification field_modifications = 2 [(wix.api.minSize) = 1, (wix.api.maxSize) = 100];
+}
+
+message FieldModification {
+  // Path of the field to be modified. For example: `title`. 
+  // 
+  // Nested fields can be specified using dot notation. For example: `address.street`.
+  string field_path = 1 [(wix.api.maxLength) = 1000];
+
+  // Patch action to apply to the specified field.
+  ACTION action = 2;
+
+  oneof action_options {
+    option (wix.api.aligned_with_enum) = {
+      field: "action"
+    };
+    // Options for setting the value of the specified field. Required when `action` is `SET_FIELD`.
+    SetFieldOptions set_field_options = 3;
+    // Options for incrementing the value of the specified field. Required when `action` is `INCREMENT_FIELD`.
+    IncrementFieldOptions increment_field_options = 4;
+    // Options for appending a value to the specified array. Required when `action` is `APPEND_TO_ARRAY`.
+    AppendToArrayOptions append_to_array_options = 5;
+    // Options for removing a value from the specified array. Required when `action` is `REMOVE_FROM_ARRAY`.
+    RemoveFromArrayOptions remove_from_array_options = 6;
+  }
+
+  message SetFieldOptions {
+    // Value to set for the specified field. This replaces the existing value.
+    google.protobuf.Value value = 1;
+  }
+
+  message IncrementFieldOptions {
+    // Numerical value by which to increment the field value. To decrement, specify a negative value.
+    double value = 1;
+  }
+
+  message AppendToArrayOptions {
+    // Value to append to the specified array.
+    google.protobuf.Value value = 1;
+  }
+
+  message RemoveFromArrayOptions {
+    // Value whose first instance is removed from the specified array.
+    google.protobuf.Value value = 2;
+  }
+
+  enum ACTION {
+    UNKNOWN_ACTION = 0 [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
+    // Sets the specified field to the specified value.
+    SET_FIELD = 1;
+    // Clears the specified field.
+    REMOVE_FIELD = 2;
+    // Increments the specified field by the specified value. To decrement, specify a negative value.
+    INCREMENT_FIELD = 3;
+    // Appends the specified value to the array.
+    //
+    // Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-types-in-wix-data).
+    APPEND_TO_ARRAY = 4;
+    // Removes the first instance of the specified value from the array.
+    //
+    // Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-types-in-wix-data).
+    REMOVE_FROM_ARRAY = 5;
+  }
+}
+
+message BulkPatchDataItemsRequest {
+  // [Collection environment](https://support.wix.com/en/article/cms-about-sandbox-and-live-collections-and-syncing) from which to delete item.
+  //
+  // Default: `LIVE`.
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection that contains the items to patch.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Patches to apply to the items.
+  repeated Patch patches = 3 [(wix.api.minSize) = 1, (wix.api.maxSize) = 100];
+
+  // Grid app id. Optional in Live segment.
+  google.protobuf.StringValue app_id = 4 [(wix.api.format) = GUID, (wix.api.field_exposure) = PRIVATE];
+
+  reserved 5;
+
+  // Whether to return the patched data items. When `true`, each item in the `results` array contains a `dataItem` field with the full patched data item.
+  //
+  // 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 options specific to the [Wix app collection](https://support.wix.com/en/article/cms-formerly-content-manager-working-with-wix-app-collections) you are querying. 
+  //
+  // Learn more about [querying Wix app collections](https://dev.wix.com/docs/develop-websites/articles/wix-apps/wix-app-collections/querying-wix-app-collections).
+  google.protobuf.Struct app_options = 8 [(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 = 9;
+
+  // Condition for patching the items.
+  //
+  // When a condition is provided, the items are only patched if the condition is met.
+  Condition condition = 10;
+}
+
+message BulkPatchDataItemsResponse {
+  // Patched 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/publish-data-item-draft.proto

@@ -0,0 +1,24 @@
+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/common.proto";
+import "wix/api/annotations.proto";
+
+message PublishDataItemDraftRequest {
+  // 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];
+
+  // ID of the data item whose draft will be published. Returns `NOT_FOUND` if no pending draft exists for this ID.
+  string data_item_id = 3 [(wix.api.maxLength) = 128];
+}
+
+message PublishDataItemDraftResponse {
+  // The newly-published data item, reflecting the draft's content. The draft has been deleted.
+  DataItem data_item = 1;
+}

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

@@ -0,0 +1,145 @@
+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/data-item.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/paging.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/sorting.proto";
+
+message QueryReferencedDataItemsRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection containing the referring item.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // ID of the referring item.
+  string referring_item_id = 3 [(wix.api.maxLength) = 128];
+//  Uncomment after referring_item_ids is GAed
+//  [
+//    deprecated = true,
+//    (wix.api.field_deprecated) = {
+//      replaced_by: "referring_item_ids"
+//      target_removal_date: "2025-03-01"
+//    }
+//  ];
+
+  // Field containing references in the referring item.
+  string referring_item_field_name = 4 [(wix.api.maxLength) = 1000];
+
+  // Order of the returned referenced items. Sorted by the date each item was referenced.
+  upstream.wix.common.SortOrder order = 5;
+
+  oneof paging_method {
+    //Paging options to limit and skip the number of items.
+    upstream.wix.common.Paging paging = 6;
+
+    //Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.
+    upstream.wix.common.CursorPaging cursor_paging = 7;
+  }
+
+  // Whether to return the total count in the response.
+  // When `true`, the `pagingMetadata` object in the response contains a `total` field.
+  //
+  // Default: `false`
+  bool return_total_count = 8;
+
+  // Grid app id. Optional in Live segment.
+  google.protobuf.StringValue app_id = 9 [(wix.api.format) = GUID, (wix.api.field_exposure) = PRIVATE];
+
+  // Data access options
+  Options options = 10 [
+    (wix.api.field_exposure) = PRIVATE,
+    deprecated = true,
+    (wix.api.field_deprecated) = {
+      replaced_by: "inlined"
+      target_removal_date: "2024-07-12"
+    }
+  ];
+
+  // Whether to retrieve data from the primary database instance.
+  // This decreases performance but ensures data retrieved is up to date even immediately after an update.
+  // Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+  //
+  // Default: `false`
+  bool consistent_read = 11;
+
+  // Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+  // If provided, the result text is returned in the specified language.
+  // **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
+  //
+  // If not provided, result text is not translated.
+  google.protobuf.StringValue language = 12 [(wix.api.format) = LANGUAGE_TAG];
+
+  // Fields to return for each referenced item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
+  // **Note:** The `_id` system field is always returned.
+  repeated string fields = 13 [(wix.api.maxSize) = 10000, (wix.api.maxLength) = 1000];
+
+  // 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 = 14;
+
+  // 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 = 15;
+
+  // IDs of the referring items.
+  repeated string referring_item_ids = 16 [(wix.api.field_maturity) = ALPHA, (wix.api.maxSize) = 1000, (wix.api.maxLength) = 128];
+}
+
+message QueryReferencedDataItemsResponse {
+  message UnresolvedReference {
+    // ID of the referring item.
+    string referring_item_id = 3 [
+      deprecated = true,
+      (wix.api.field_deprecated) = {
+        target_removal_date: "2025-03-01"
+      },
+      (wix.api.maxLength) = 128
+    ];
+
+    // Field specified to query for references.
+    string referring_item_field_name = 4 [
+      deprecated = true,
+      (wix.api.field_deprecated) = {
+        target_removal_date: "2025-03-01"
+      },
+      (wix.api.maxLength) = 1000
+    ];
+
+    // ID of unresolved referenced item
+    string referenced_item_id = 5 [(wix.api.maxLength) = 128];
+    
+    // Flag is set if item exists, but user is not authorized to read it
+    bool unauthorized = 6;
+  }
+
+  message ReferencedResult {
+    oneof entity {
+      // Data item referenced.
+      DataItem data_item = 1;
+
+      // Unresolved reference. Appears instead of the data item when the reference doesn't resolve, for example, when an ID isn't found or if an item is in draft state.
+      UnresolvedReference unresolved_reference = 2;
+    }
+
+    // ID of the referring item.
+    string referring_item_id = 3 [(wix.api.maxLength) = 128];
+  }
+
+  // Referenced items and/or IDs. For successfully resolved references, the referenced data item is returned. For references that can't be resolved, the ID is returned.
+  repeated ReferencedResult results = 1;
+
+  // Paging information.
+  upstream.wix.common.PagingMetadataV2 paging_metadata = 5;
+}
+;

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

@@ -0,0 +1,157 @@
+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/data-item.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/paging.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/query.proto";
+
+message QueryDataItemsRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection to query.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Query preferences. For more details on using queries, see [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
+  upstream.wix.common.QueryV2 query = 3;
+
+  // Whether to return the total count in the response for a query with offset paging.
+  // When `true`, the `pagingMetadata` object in the response contains a `total` field.
+  //
+  // Default: `false`
+  bool return_total_count = 4;
+
+  // Properties for which to include referenced items in the query's results.
+  // Up to 50 referenced items can be included for each item that matches the query.
+  repeated string include_referenced_items = 5 [
+    deprecated = true,
+    (wix.api.field_deprecated) = {
+      replaced_by: "include_references"
+      target_removal_date: "2025-08-01"
+    },
+    (wix.api.maxSize) = 50,
+    (wix.api.maxLength) = 1000
+  ];
+
+  // Grid app id. Optional in Live segment.
+  google.protobuf.StringValue app_id = 6 [(wix.api.format) = GUID, (wix.api.field_exposure) = PRIVATE];
+
+  // Data access options
+  Options options = 7 [
+    (wix.api.field_exposure) = PRIVATE,
+    deprecated = true,
+    (wix.api.field_deprecated) = {
+      replaced_by: "inlined"
+      target_removal_date: "2024-07-12"
+    }
+  ];
+
+  // Whether to retrieve data from the primary database instance.
+  // This decreases performance but ensures data retrieved is up to date even immediately after an update.
+  // Learn more about [Wix Data and eventual consistency](https://dev.wix.com/api/rest/wix-data/wix-data/eventual-consistency).
+  //
+  // Default: `false`
+  bool consistent_read = 8;
+
+  // Language to translate result text into, in [IETF BCP 47 language tag](https://en.wikipedia.org/wiki/IETF_language_tag) format.
+  // If provided, the result text is returned in the specified language. 
+  // **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
+  //
+  // If not provided, result text is not translated.
+  google.protobuf.StringValue language = 9 [(wix.api.format) = LANGUAGE_TAG];
+
+  // Request information about this collection caching
+  bool request_caching_info = 10 [(wix.api.field_exposure) = INTERNAL];
+
+  // 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 = 11 [(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 = 12;
+
+  // 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 = 13;
+
+  // Options for retrieving referenced items.
+  repeated ReferencedItemOptions referenced_item_options = 14 [
+    deprecated = true,
+    (wix.api.field_deprecated) = {
+      replaced_by: "include_references"
+      target_removal_date: "2026-08-01"
+    },
+    (wix.api.maxSize) = 100
+  ];
+
+  message ReferencedItemOptions {
+    // Field containing references in the queried item.
+    string field_name = 1 [(wix.api.maxLength) = 1000];
+    // Maximum number of referenced items to include for each queried item.
+    google.protobuf.Int32Value limit = 2 [(wix.api.max) = 1000];
+  }
+
+  // Selects how sorting is applied to the response.
+  SortMode sort_mode = 15;
+
+  enum SortMode {
+    // Placeholder. Falls back to REGULAR.
+    UNKNOWN_SORT_MODE = 0 [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
+    // Use the sorting specified in query.sort.
+    WIX_QUERY = 1;
+    // Return randomly sorted results, disregarding query.sort.
+    RANDOM = 2;
+  }
+
+  // Additional configuration for the selected sorting mode.
+  oneof sort_mode_options {
+    option (.wix.api.aligned_with_enum).field = "sort_mode";
+    // Additional options for random sorting.
+    RandomOptions random_options = 16;
+  }
+
+  // Requests conditional fields. Currently used only in App Collections.
+  // Please refer to app collection documentation or [collection field definitions](https://dev.wix.com/docs/api-reference/business-solutions/cms/collection-management/data-collections/get-data-collection) for a list of valid values.
+  repeated string include_field_groups = 17 [(wix.api.maxSize) = 100, (wix.api.maxLength) = 100];
+
+  // Fields for which to include referenced items. For each reference field specified, the response includes the full data items being referenced. Use this to retrieve related data in a single call without additional queries. Maximum 100 reference configurations can be specified.
+  repeated IncludeReference include_references = 18 [(wix.api.maxSize) = 100];
+
+  message RandomOptions {
+    // Seed for the pseudo-random generator. The same seed always generates the same order.
+    google.protobuf.Int32Value seed = 1;
+  }
+}
+
+message QueryDataItemsResponse {
+  // Retrieved items.
+  repeated DataItem data_items = 1;
+
+  // Caching info, returned if `request_caching_info` is set and caching is allowed
+  CachingInfo caching_info = 2 [(wix.api.field_exposure) = INTERNAL];
+
+  // Paging information.
+  upstream.wix.common.PagingMetadataV2 paging_metadata = 5;
+}
+
+message CachingInfo {
+  // Caching tags for this collection
+  repeated string tags = 1 [(wix.api.maxLength) = 1024, (wix.api.maxSize) = 50];
+  // max caching time if set
+  google.protobuf.Int32Value max_age = 2;
+}

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

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "wix/api/errors.proto";
+import "wix/api/annotations.proto";
+
+message ReferenceMetadata {
+  // Index of the reference within the request array. Allows for correlation between request and response references.
+  int32 original_index = 2;
+  // Whether the requested action was successful for this reference. When `false`, the `error` field is populated.
+  bool success = 3;
+  // Details about the error in case of failure.
+  .wix.api.ApplicationError error = 4;
+}

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

@@ -0,0 +1,42 @@
+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/data-item-reference.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+
+message RemoveDataItemReferenceRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection containing the referring item.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Reference to remove.
+  DataItemReference data_item_reference = 3;
+
+  // 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 RemoveDataItemReferenceResponse {
+  // Removed reference.
+  DataItemReference data_item_reference = 1;
+}