@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/bulk-update.proto

@@ -0,0 +1,85 @@
+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 BulkUpdateDataItemsRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection in which to update items.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Data items to 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 updated 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;
+
+  // Condition for updating the items.
+  //
+  // When a condition is provided, the items are only updated if the condition is met.
+  Condition condition = 10;
+
+  // Whether to save multi-reference fields.
+  // When `true`, multi-reference fields in the data items will be updated to match the provided values,
+  // replacing any existing references.
+  // Multi-reference field values must be arrays of referenced item IDs (strings)
+  // or referenced items containing an `_id` field.
+  //
+  // Default: `false`
+  bool save_references = 11 [(wix.api.field_exposure) = PRIVATE];
+}
+
+message BulkUpdateDataItemsResponse {
+  // Information about the updated 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/condition.proto

@@ -0,0 +1,15 @@
+//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";
+
+message Condition {
+  // Filter, changes to item(s) will only apply if they satisfy this filter.
+  // Learn more about filters in [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#filters).
+  google.protobuf.Struct filter = 1;
+}

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

@@ -0,0 +1,82 @@
+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 CountDataItemsRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection for which to count query results.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Filter object in the following format:
+  //
+  // `"filter" : {
+  //              "fieldName1": "value1",
+  //              "fieldName2":{"$operator":"value2"}
+  // }`.
+  //
+  // Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
+  //
+  // **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
+  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];
+
+  // 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 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 = 6;
+
+  // 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 = 7 [(wix.api.format) = LANGUAGE_TAG];
+
+  // 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 = 8 [(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 = 9;
+
+  // 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 = 10;
+}
+
+// flynt-disable crud-count-message-validation
+message CountDataItemsResponse {
+  // Number of items matching the query.
+  int32 total_count = 1;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/create-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 CreateDataItemDraftRequest {
+  // 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 published data item to copy into the draft collection.
+  string data_item_id = 3 [(wix.api.maxLength) = 128];
+}
+
+message CreateDataItemDraftResponse {
+  // The newly-created draft data item, seeded with the current published data.
+  DataItem data_item = 1;
+}

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

@@ -0,0 +1,23 @@
+//flynt-disable missing-entity-id-field
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "wix/api/entity.proto";
+import "wix/api/validations.proto";
+
+message DataItemReference {
+  option (.wix.api.entity) = {
+    fqdn: "wix.data.v1.data_reference",
+    segment: PUBLIC
+  };
+
+  // Referring item field containing the references to the referenced items.
+  string referring_item_field_name = 1 [(wix.api.maxLength) = 1000];
+
+  // ID of the referring item.
+  string referring_item_id = 2 [(wix.api.maxLength) = 128];
+
+  // ID of the referenced item.
+  string referenced_item_id = 3 [(wix.api.maxLength) = 128];
+}

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

@@ -0,0 +1,84 @@
+//flynt-disable missing-taggable-annotation
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/entity.proto";
+import "wix/api/validations.proto";
+import "com/wixpress/cloud/data/api/common.proto";
+
+// A data item represents a single entry in a site's data collection.
+message DataItem {
+  option (.wix.api.entity) = {
+    fqdn: "wix.data.v2.data_item",
+    app_def_id: "e593b0bd-b783-45b8-97c2-873d42aacaf4",
+    segment: PUBLIC,
+    appendix_files: {
+      type: AUTO_VELO
+      path: "appendices/velo"
+    }
+    appendix_files: {
+      type: DOCS_CONF
+      path: "appendices/docs"
+    }
+    domain_events: {
+      // Entity will NOT have the data field populate.
+      // It's included so that consumer can know the collection of the entity.
+      deleted_include_entity: true,
+    }
+    domain_events_read_permission: "WIX_DATA.GET"
+  };
+
+// Triggered when a data item is inserted.
+  option (wix.api.domain_event) = {
+    event_type: CREATED
+    exposure: PUBLIC
+    maturity: GA
+  };
+
+  // Triggered when a data item is updated or patched.
+  option (wix.api.domain_event) = {
+    event_type: UPDATED
+    exposure: PUBLIC
+    maturity: GA
+  };
+
+  // Triggered when a data item is deleted or truncated.
+  option (wix.api.domain_event) = {
+    event_type: DELETED
+    exposure: PUBLIC
+    maturity: GA
+  };
+
+  // created_date
+  reserved 2;
+  // updated_date
+  reserved 3;
+  // owner_id
+  reserved 4;
+
+  // Data item ID.
+  //
+  // When an item is inserted into a collection, the item's ID is automatically assigned a random value. You can optionally provide a custom ID in `dataItem.id` when inserting the item. If you specify an ID that already exists in the collection, the insertion will fail.
+  string id = 1 [(.wix.api.immutable) = true, (wix.api.maxLength) = 128];
+
+  // ID of the collection this item belongs to.
+  //
+  // This is the user-defined collection identifier set when the collection is created (for example, `EvalCustomers`), not a GUID.
+  string data_collection_id = 6 [(.wix.api.readOnly) = true, (wix.api.maxLength) = 256];
+
+  // Data item contents.
+  //
+  // Property-value pairs representing the data item's payload. When retrieving a data item, it also includes the following read-only fields:
+  //
+  // + `_id`: Item ID.
+  // + `_createdDate`: Date and time the item was added to the collection.
+  // + `_updatedDate`: Date and time the item was last modified. When the item is first inserted, `_createdDate` and `_updatedDate` have the same value.
+  // + `_ownerId`: ID of the user who created the item. Can be modified with site owner permissions.
+  google.protobuf.Struct data = 5;
+}
+

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

@@ -0,0 +1,92 @@
+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";
+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 QueryDistinctValuesRequest {
+  // 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];
+
+  // Item field name for which to return all distinct values.
+  string field_name = 3 [(wix.api.maxLength) = 1000];
+
+  // Filter object in the following format:
+  //
+  // `"filter" : {
+  //              "fieldName1": "value1",
+  //              "fieldName2":{"$operator":"value2"}
+  // }`.
+  //
+  // Examples of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`.
+  //
+  // **Note:** The values you provide for each field must adhere to that field's type. For example, when filtering by a field whose type is Date and Time, use an object in the following format: `"someDateAndTimeFieldKey": { "$date": "YYYY-MM-DDTHH:mm:ss.sssZ"}`. Learn more about [data types in Wix Data](https://dev.wix.com/docs/rest/business-solutions/cms/data-items/data-types-in-wix-data).
+  google.protobuf.Struct filter = 4;
+
+  // Sort order.
+  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 for a query with offset paging.
+  // 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];
+
+  // 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;
+}
+
+message QueryDistinctValuesResponse {
+  // List of distinct values contained in the field specified in `fieldName`.
+  repeated google.protobuf.Value distinct_values = 1;
+
+  // Paging information.
+  upstream.wix.common.PagingMetadataV2 paging_metadata = 3;
+}
+

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

@@ -0,0 +1,101 @@
+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";
+
+message GetDataItemRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection from which to retrieve the data item.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // ID of the data item to retrieve.
+  string data_item_id = 3 [(wix.api.maxLength) = 128];
+
+  // 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 = 6 [
+    (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 = 7;
+
+  // 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 = 8 [(wix.api.format) = LANGUAGE_TAG];
+
+  // Fields to return for the 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 = 9 [(wix.api.maxSize) = 1000, (wix.api.maxLength) = 1000];
+
+  // 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 = 10 [(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 = 11;
+
+  // 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 = 12;
+
+  // Options for retrieving referenced items.
+  repeated ReferencedItemOptions referenced_item_options = 13 [
+    deprecated = true,
+    (wix.api.field_deprecated) = {
+      replaced_by: "include_references"
+      target_removal_date: "2026-08-01"
+    },
+    (wix.api.maxSize) = 100
+  ];
+
+  // Requests conditional fields. Currently used in App Collections.
+  // Please refer to app collection documentation for a list of valid values.
+  repeated string include_field_groups = 14 [(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.
+  repeated IncludeReference include_references = 15 [(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];
+  }
+}
+
+message GetDataItemResponse {
+  // Retrieved item.
+  DataItem data_item = 1;
+}

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

@@ -0,0 +1,47 @@
+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 InsertDataItemReferenceRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection in which to insert the reference.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Reference to insert
+  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 = 10 [
+    (wix.api.field_exposure) = PRIVATE,
+    deprecated = true,
+    (wix.api.field_deprecated) = {
+      replaced_by: "inlined"
+      target_removal_date: "2024-07-12"
+    }
+  ];
+
+  // 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 = 11;
+}
+
+message InsertDataItemReferenceResponse {
+  // Inserted reference.
+  DataItemReference data_item_reference = 1;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/insert.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/data-item.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+
+message InsertDataItemRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection in which to insert the item.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Item to insert.
+  DataItem data_item = 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 include referenced items in the response.
+  // When `true`, items referenced by reference and multi-reference fields are included inline in the returned data item.
+  //
+  // Default: `false`
+  bool include_referenced_items = 5 [(wix.api.field_exposure) = PRIVATE];
+
+  // Data access options
+  Options options = 6 [
+    (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 = 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 the inserted item to the 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 InsertDataItemResponse {
+  // Inserted data item.
+  DataItem data_item = 1;
+}