@wix/bex-utils 2.93.0 → 2.94.0

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/common/domainevents/domainevents.proto

@@ -0,0 +1,112 @@
+//flynt-disable renamed-field-breaking-change, missing-string-validations
+syntax = "proto3";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+
+package wix.common.domainevents;
+
+
+option java_multiple_files = true;
+option java_package = "com.wix.common.domainevents";
+
+message EntityCreatedEvent {
+    string entity_as_json = 2 [(wix.api.pii) = true];
+
+    // Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
+    google.protobuf.BoolValue triggered_by_undelete = 3 [(.wix.api.field_exposure) = PRIVATE];
+
+    // Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity
+    RestoreInfo restore_info = 4;
+
+    // Optional domain-specific metadata defined by the API owner, encoded as JSON.
+    google.protobuf.StringValue additional_metadata_as_json = 5 [(wix.api.pii) = true, (.wix.api.field_exposure) = PRIVATE];
+}
+
+message EntityUpdatedEvent {
+    // Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+    // This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+    // We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+    string current_entity_as_json = 2 [(wix.api.pii) = true];
+
+    // This field is currently part of the of the EntityUpdatedEvent msg, but scala/node libraries which implements the domain events standard
+    // wont populate it / have any reference to it in the API.
+    // The main reason for it is that fetching the old entity from the DB will have a performance hit on an update operation so unless truly needed,
+    // the developer should send only the new (current) entity.
+    // An additional reason is not wanting to send this additional entity over the wire (kafka) since in some cases it can be really big
+    //Developers that must reflect the old entity will have to implement their own domain event sender mechanism which will follow the DomainEvent proto message.
+    google.protobuf.StringValue previous_entity_as_json = 3 [(wix.api.pii) = true, deprecated = true, (.wix.api.field_exposure) = INTERNAL];
+
+    reserved 4;
+
+    // Map of fully qualified field paths to their previous values for fields that changed.
+    // For more details please see [AIP](https://dev.wix.com/docs/rnd-general/articles/p13n-guidelines-aips/guidance-aips/design-patterns/7016-events#modified-fields-format)
+    map<string, google.protobuf.Value> modified_fields = 5 [(wix.api.pii) = true, (.wix.api.field_exposure) = PRIVATE];
+
+    // Optional domain-specific metadata defined by the API owner, encoded as JSON.
+    google.protobuf.StringValue additional_metadata_as_json = 6 [(wix.api.pii) = true, (.wix.api.field_exposure) = PRIVATE];
+}
+
+message EntityDeletedEvent {
+    // Indicates if the entity is sent to trash-bin. only available when trash-bin is enabled
+    google.protobuf.BoolValue moved_to_trash = 1 [(.wix.api.field_exposure) = PRIVATE];
+
+    // Entity that was deleted.
+    google.protobuf.StringValue deleted_entity_as_json = 2 [(wix.api.pii) = true];
+
+    // Optional domain-specific metadata defined by the API owner, encoded as JSON.
+    google.protobuf.StringValue additional_metadata_as_json = 3 [(wix.api.pii) = true, (.wix.api.field_exposure) = PRIVATE];
+}
+
+message ActionEvent {
+    string body_as_json = 2 [(wix.api.pii) = true];
+}
+
+message DomainEvent {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "id"
+        field: "entity_fqdn"
+        field: "slug"
+        field: "entity_id"
+        field: "event_time"
+    };
+    // Event ID. With this ID you can easily spot duplicated events and ignore them.
+    string id = 1;
+    // Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+    // For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+    string entity_fqdn = 2;
+    // Event action name, placed at the top level to make it easier for users to dispatch messages.
+    // For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+    string slug = 3;
+    // ID of the entity associated with the event.
+    string entity_id = 4;
+    oneof body {
+        EntityCreatedEvent created_event = 5;
+        EntityUpdatedEvent updated_event = 6;
+        EntityDeletedEvent deleted_event = 7;
+        ActionEvent action_event = 8;
+    }
+    reserved 12;
+    // Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`.
+    google.protobuf.Timestamp event_time = 9;
+    // Whether the event was triggered as a result of a privacy regulation application
+    // (for example, GDPR).
+    google.protobuf.BoolValue triggered_by_anonymize_request = 10;
+
+    // If present, indicates the action that triggered the event.
+    google.protobuf.StringValue originated_from = 11;
+
+    // A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+    // You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+    google.protobuf.Int64Value entity_event_sequence = 13;
+}
+
+// Used for batch consumers
+message DomainEvents {
+  repeated DomainEvent domain_events = 1;
+}
+
+message RestoreInfo {
+  google.protobuf.Timestamp deleted_date = 1;
+}

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/common/query.proto

@@ -178,6 +178,19 @@ message SearchRelatedDetails {
     repeated string fields = 3 [(.wix.api.maxLength) = 200, (.wix.api.maxSize) = 20];
 }
 
+message SearchSuggest {
+    SearchSuggestDetails suggest = 1; // Suggest details.
+    repeated Sorting sort = 2 [(.wix.api.maxSize) = 10]; // Sorting of suggested documents.
+    google.protobuf.Struct filter = 3; // Filter in platformized query language (for example) {'field': {'$eq': 'value'}}.
+    google.protobuf.Int32Value limit = 4 [(.wix.api.max) = 100]; // Limit of suggested documents to return, defaults to 10.
+}
+
+message SearchSuggestDetails {
+    // Search query to suggest for.
+    string expression = 1 [(.wix.api.minLength) = 1, (.wix.api.maxLength) = 100];
+    // Fields to search in. If empty - will search in all searchable fields. Use dot notation to specify json path.
+    repeated string fields = 2 [(.wix.api.maxLength) = 200, (.wix.api.maxSize) = 20];
+}
 
 message SearchDetails {
     enum Mode {
@@ -354,6 +367,11 @@ message AggregationData {
             double value = 2; // Value of the scalar aggregation.
         }
 
+        message ScalarDateResult {
+            ScalarType type = 1; // Type of scalar date aggregation. Possible values: `MIN`, `MAX`.
+            string value = 2 [(.wix.api.maxLength) = 100]; // Date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+        }
+
         message GroupByValueResults {
             message NestedValueAggregationResult {
                 string value = 1 [(.wix.api.maxLength) = 1000]; // Value of the field.
@@ -390,12 +408,17 @@ message AggregationData {
                 double value = 1; // Value of the scalar aggregation.
             }
 
+            message ScalarDateResult {
+                string value = 1 [(.wix.api.maxLength) = 100]; // Date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+            }
+
             message NestedResultValue {
                 oneof result {
                     ValueResult value = 1; // Value aggregation result.
                     RangeResult range = 2; // Range aggregation result.
                     ScalarResult scalar = 3; // Scalar aggregation result.
                     ValueResult date_histogram = 4; // Date histogram aggregation result.
+                    ScalarDateResult scalar_date = 5; // Scalar date aggregation result.
                 }
             }
 
@@ -424,6 +447,7 @@ message AggregationData {
             GroupByValueResults grouped_by_value = 7; // Group by value aggregation results.
             DateHistogramResults date_histogram = 8; // Date histogram aggregation results.
             NestedResults nested = 9; // Nested aggregation results.
+            ScalarDateResult scalar_date = 10; // Date aggregation results.
         }
     }
 
@@ -604,6 +628,51 @@ message ProductSearchResponse {
       products: [...]
 }
 
+// example Scalar date type Request:
+{
+    search: {
+        expression: "term"
+    },
+    aggregations: [
+        {
+            name: "my-scalar-aggregation-on-date",
+            type: "SCALAR",
+            fieldPath: "path.to.date.field",
+            scalar: {
+                type: "MAX"
+            }
+        }
+    ]
+}
+
+// example Scalar type Response:
+{
+    aggregations: {
+        results: [
+            {
+                name: "my-scalar-aggregation-on-date",
+                type: "SCALAR",
+                field_path: "path.to.date.field",
+                scalar_date: {
+                    type: "MAX",
+                    value: "2019-02-25T00:00:00.000Z"
+                }
+            }
+        ]
+    },
+    metadata: {
+        items: 25,
+        offset: 25,
+        total: 420,
+        tooManyToCount: false,
+        cursors: {
+          next: "SOMEHASHFORNEXT",
+          prev: "SOMEHASHFORPREV"
+        }
+      },
+      products: [...]
+}
+
 // example Group By Aggregation Request:
 {
   "filter" : {

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/os/v1/tag.proto

@@ -22,6 +22,18 @@ message Tag {
     domain_events: {
       deleted_include_entity: true
     }
+    query_options: {
+      wql: {
+        pattern: {
+          operator: ALL_APPLICABLE_OPERATORS
+          field: "id"
+          field: "created_date"
+          field: "updated_date"
+          field: "name"
+          sort: BOTH
+        }
+      }
+    }
   };
 
   // Tag ID.

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/os/v1/tags_account_service.proto

@@ -11,18 +11,18 @@ import "wix/api/entity.proto";
 import "wix/api/permissions.proto";
 import "wix/api/callback.proto";
 import "wix/http/field_mask.proto";
-import "wix/common/query.proto";
-import "wix/common/paging.proto";
 import "wix/os/v1/tag.proto";
 import "wix/os/v1/tag_exposure.proto";
 import "wix/api/errors.proto";
 import "wix/api/api_errors.proto";
+import "wix/os/v1/upstream/wix/common/query.proto";
+import "wix/os/v1/upstream/wix/common/paging.proto";
 
 /**
   Manages Tags
  */
 service TagsAccountService {
-  option (wix.api.service_maturity) = BETA;
+  option (wix.api.service_maturity) = GA;
   option (wix.api.service_exposure) = PUBLIC;
   option (wix.api.service_entity).message = "wix.os.v1.Tag";
 
@@ -42,21 +42,25 @@ service TagsAccountService {
       event_type: CREATED
     };
 
+    // Couldn't find the FQDN.
     option (.wix.api.error) = {
       http_code: NOT_FOUND
       application_code: "FQDN_NOT_FOUND"
     };
 
+    // There is already a tag with this name.
     option (.wix.api.error) = {
       http_code: ALREADY_EXISTS
       application_code: "TAG_NAME_ALREADY_EXISTS"
     };
 
+    // Number of tags exceeds the server's limit.
     option (.wix.api.error) = {
       http_code: RESOURCE_EXHAUSTED
       application_code: "TAGS_REACHED_LIMIT"
     };
 
+    // Failed to generate a unique tag ID.
     option (.wix.api.error) = {
       http_code: INTERNAL
       application_code: "CREATE_ID_EXHAUSTED_RETRY_ATTEMPTS"
@@ -112,6 +116,22 @@ service TagsAccountService {
     option (wix.api.permission).name = "TAGS.ACCOUNT_TAG_READ";
     option (wix.api.required) = "ListTagsForAccountRequest.fqdn";
   }
+
+  /**
+    Retrieves a list of tags.
+  */
+  rpc QueryTagsForAccount (QueryTagsForAccountRequest) returns (QueryTagsForAccountResponse) {
+    option (google.api.http) = {
+      post: "/v1/account/tags/query"
+      additional_bindings : {
+        get: "/v1/account/tags/query";
+      }
+    };
+    option (wix.api.permission).name = "TAGS.ACCOUNT_TAG_READ";
+    option (wix.api.required) = "QueryTagsForAccountRequest.fqdn";
+    option (wix.api.required) = "QueryTagsForAccountRequest.query";
+  }
+
 }
 
 
@@ -165,3 +185,23 @@ message ListTagsForAccountResponse {
   // A list of tags.
   repeated Tag tags = 1;
 }
+
+message QueryTagsForAccountRequest {
+  // The Fully Qualified Domain Name (FQDN) to which the tags are associated. Currently supports only eCommerce Orders: `wix.ecom.v1.order`.
+  string fqdn = 1 [(wix.api.maxLength) = 255];
+
+  // The tag exposure.
+  TagExposure exposure = 2 [(wix.api.field_exposure) = INTERNAL];
+
+  // WQL expression.
+  wix.os.v1.upstream.wix.common.CursorQuery query = 3;
+}
+
+message QueryTagsForAccountResponse {
+  // A list of tags.
+  repeated Tag tags = 1;
+
+  // Paging metadata
+  wix.os.v1.upstream.wix.common.CursorPagingMetadata paging_metadata = 2;
+}
+

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/os/v1/tags_global_service.proto

@@ -0,0 +1,171 @@
+syntax = "proto3";
+
+package wix.os.v1;
+option java_package = "com.wixpress.os.v1";
+
+import "google/protobuf/field_mask.proto";
+import "google/api/annotations.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/entity.proto";
+import "wix/api/permissions.proto";
+import "wix/api/callback.proto";
+import "wix/http/field_mask.proto";
+import "wix/common/query.proto";
+import "wix/common/paging.proto";
+import "wix/os/v1/tag.proto";
+import "wix/os/v1/tag_exposure.proto";
+import "wix/api/errors.proto";
+import "wix/api/api_errors.proto";
+
+/**
+  Manages Global Tags
+ */
+service TagsGlobalService {
+  option (wix.api.service_maturity) = GA;
+  option (wix.api.service_exposure) = PUBLIC;
+  option (wix.api.service_entity).message = "wix.os.v1.Tag";
+
+  /**
+    Creates a global tag.
+   */
+  // flynt-disable crud-add-create-annotation
+  rpc CreateGlobalTag (CreateGlobalTagRequest) returns (CreateGlobalTagResponse) {
+    option (google.api.http).post = "/v1/global/tags";
+    option (wix.api.permission).name = "TAGS.GLOBAL_TAG_CREATE";
+    option (wix.api.required) = "CreateGlobalTagRequest.tag";
+    option (wix.api.required) = "CreateGlobalTagRequest.tag.fqdn";
+    option (wix.api.required) = "CreateGlobalTagRequest.tag.exposure";
+    option (wix.api.required) = "CreateGlobalTagRequest.tag.name";
+
+    option (wix.api.callback) = {
+      event_type: CREATED
+    };
+
+    // Couldn't find the FQDN.
+    option (.wix.api.error) = {
+      http_code: NOT_FOUND
+      application_code: "FQDN_NOT_FOUND"
+    };
+
+    // There is already a tag with this name.
+    option (.wix.api.error) = {
+      http_code: ALREADY_EXISTS
+      application_code: "TAG_NAME_ALREADY_EXISTS"
+    };
+
+    // Number of tags exceeds the server's limit.
+    option (.wix.api.error) = {
+      http_code: RESOURCE_EXHAUSTED
+      application_code: "TAGS_REACHED_LIMIT"
+    };
+
+    // Failed to generate a unique tag ID.
+    option (.wix.api.error) = {
+      http_code: INTERNAL
+      application_code: "CREATE_ID_EXHAUSTED_RETRY_ATTEMPTS"
+    };
+  }
+
+  /**
+    Retrieves a global tag.
+   */
+  // flynt-disable crud-add-get-annotation
+  rpc GetGlobalTag (GetGlobalTagRequest) returns (GetGlobalTagResponse) {
+    option (google.api.http).get = "/v1/global/tags/{tag_id}";
+    option (wix.api.permission).name = "TAGS.GLOBAL_TAG_READ";
+    option (wix.api.required) = "GetGlobalTagRequest.tag_id";
+  }
+
+  /**
+  Updates a global tag.
+   */
+  // flynt-disable crud-add-update-annotation
+  rpc UpdateGlobalTag (UpdateGlobalTagRequest) returns (UpdateGlobalTagResponse) {
+    option (google.api.http).patch = "/v1/global/tags/{tag.id}";
+    option (wix.api.permission).name = "TAGS.GLOBAL_TAG_UPDATE";
+    option (wix.api.required) = "UpdateGlobalTagRequest.tag";
+    option (wix.api.required) = "UpdateGlobalTagRequest.tag.id";
+    option (wix.api.required) = "UpdateGlobalTagRequest.tag.revision";
+    option (wix.api.required) = "UpdateGlobalTagRequest.tag.name";
+
+    option (wix.api.callback) = {
+      event_type: UPDATED
+    };
+  }
+
+  /**
+    Deletes a global tag.
+   */
+  // flynt-disable crud-add-delete-annotation
+  rpc DeleteGlobalTag (DeleteGlobalTagRequest) returns (DeleteGlobalTagResponse) {
+    option (google.api.http).delete = "/v1/global/tags/{tag_id}";
+    option (wix.api.permission).name = "TAGS.GLOBAL_TAG_DELETE";
+    option (wix.api.required) = "DeleteGlobalTagRequest.tag_id";
+
+    option (wix.api.callback) = {
+      event_type: DELETED
+    };
+  }
+
+  /**
+    Retrieves a list of global tags.
+   */
+  rpc ListGlobalTags (ListGlobalTagsRequest) returns (ListGlobalTagsResponse) {
+    option (google.api.http).get = "/v1/global/tags";
+    option (wix.api.permission).name = "TAGS.GLOBAL_TAG_READ";
+    option (wix.api.required) = "ListGlobalTagsRequest.fqdn";
+  }
+}
+
+
+message CreateGlobalTagRequest {
+  // The tag to be created.
+  Tag tag = 1;
+}
+
+message CreateGlobalTagResponse {
+  // The created tag.
+  Tag tag = 1;
+}
+
+message GetGlobalTagRequest {
+  // The ID of the tag to retrieve.
+  string tag_id = 1 [(wix.api.maxLength) = 5];
+}
+
+message GetGlobalTagResponse {
+  // The requested tag.
+  Tag tag = 1;
+}
+
+message UpdateGlobalTagRequest {
+  // The tag to be updated, which may be partial.
+  Tag tag = 1;
+}
+
+message UpdateGlobalTagResponse {
+  // The updated tag.
+  Tag tag = 1;
+}
+
+message DeleteGlobalTagRequest {
+  // ID of the tag to delete.
+  string tag_id = 1 [(wix.api.maxLength) = 5];
+}
+
+message DeleteGlobalTagResponse {
+}
+
+message ListGlobalTagsRequest {
+  // The Fully Qualified Domain Name (FQDN) to which the tags are associated.
+  string fqdn = 1 [(wix.api.maxLength) = 255];
+
+  // The tag exposure.
+  TagExposure exposure = 2 [(wix.api.field_exposure) = INTERNAL];
+}
+
+message ListGlobalTagsResponse {
+  // A list of tags.
+  repeated Tag tags = 1;
+}

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/os/v1/tags_service.proto

@@ -11,18 +11,18 @@ import "wix/api/entity.proto";
 import "wix/api/permissions.proto";
 import "wix/api/callback.proto";
 import "wix/http/field_mask.proto";
-import "wix/common/query.proto";
-import "wix/common/paging.proto";
 import "wix/os/v1/tag.proto";
 import "wix/os/v1/tag_exposure.proto";
 import "wix/api/errors.proto";
 import "wix/api/api_errors.proto";
+import "wix/os/v1/upstream/wix/common/query.proto";
+import "wix/os/v1/upstream/wix/common/paging.proto";
 
 /**
   Manages Tags
  */
 service TagsService {
-  option (wix.api.service_maturity) = BETA;
+  option (wix.api.service_maturity) = GA;
   option (wix.api.service_exposure) = PUBLIC;
   option (wix.api.service_entity).message = "wix.os.v1.Tag";
 
@@ -48,26 +48,31 @@ service TagsService {
       event_type: CREATED
     };
 
+    // Couldn't find the FQDN.
     option (.wix.api.error) = {
       http_code: NOT_FOUND
       application_code: "FQDN_NOT_FOUND"
     };
 
+    // There is already a tag with this name.
     option (.wix.api.error) = {
       http_code: ALREADY_EXISTS
       application_code: "TAG_NAME_ALREADY_EXISTS"
     };
 
+    // Number of tags exceeds the server's limit.
     option (.wix.api.error) = {
       http_code: RESOURCE_EXHAUSTED
       application_code: "TAGS_REACHED_LIMIT"
     };
 
+    // Failed to generate a unique tag ID after multiple attempts.
     option (.wix.api.error) = {
       http_code: INTERNAL
       application_code: "CREATE_ID_EXHAUSTED_RETRY_ATTEMPTS"
     };
 
+    // The specified `exposure` value isn't supported for this FQDN.
     option (.wix.api.error) = {
       http_code: INVALID_ARGUMENT
       application_code: "EXPOSURE_NOT_SUPPORTED"
@@ -149,6 +154,28 @@ service TagsService {
     };
   }
 
+  /**
+  Retrieves a list of tags.
+ */
+  rpc QueryTags (QueryTagsRequest) returns (QueryTagsResponse) {
+    option (google.api.http) = {
+      post: "/v1/tags/query"
+      additional_bindings : {
+        get: "/v1/tags/query";
+      }
+    };
+    option (wix.api.permission).name = "TAGS.TAG_READ";
+    option (wix.api.required) = "QueryTagsRequest.fqdn";
+    option (wix.api.required) = "QueryTagsRequest.query";
+
+    option (.wix.api.crud) = {
+      method: QUERY
+      query_options: {
+        items_field: 'tags'
+      }
+    };
+  }
+
   /**
     Creates a tag with a custom createdDate for migration purposes.
    */
@@ -214,6 +241,25 @@ message ListTagsResponse {
   repeated Tag tags = 1;
 }
 
+message QueryTagsRequest {
+  // The Fully Qualified Domain Name (FQDN) to which the tags are associated. Currently supports only eCommerce Orders: `wix.ecom.v1.order`.
+  string fqdn = 1 [(wix.api.maxLength) = 255];
+
+  // The tag exposure.
+  TagExposure exposure = 2 [(wix.api.field_exposure) = INTERNAL];
+
+  // WQL expression.
+  wix.os.v1.upstream.wix.common.CursorQuery query = 3;
+}
+
+message QueryTagsResponse {
+  // A list of tags.
+  repeated Tag tags = 1;
+
+  // Paging metadata
+  wix.os.v1.upstream.wix.common.CursorPagingMetadata paging_metadata = 2;
+}
+
 message MigrateTagRequest {
   // The tag to be migrated with custom createdDate.
   Tag tag = 1;

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/os/v1/upstream/wix/common/bulk.proto

@@ -0,0 +1,69 @@
+syntax = "proto3";
+
+package wix.os.v1.upstream.wix.common;
+
+option java_multiple_files = true;
+option java_package = "com.wixpress.os.v1.upstream.wix.common";
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+import "wix/api/errors.proto";
+
+message BulkActionMetadata {
+    option (.wix.api.decomposite_of) = "wix.commons.v2.BulkActionMetadata";
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "total_successes"
+        field: "total_failures"
+        field: "undetailed_failures"
+    };
+    // Number of items that were successfully processed.
+    int32 total_successes = 1 [(.wix.api.min) = 0];
+    // Number of items that couldn't be processed.
+    int32 total_failures = 2 [(.wix.api.min) = 0];
+    // Number of failures without details because detailed failure threshold was exceeded.
+    int32 undetailed_failures = 3 [(.wix.api.min) = 0];
+}
+
+message ItemMetadata {
+    option (.wix.api.decomposite_of) = "wix.commons.v2.ItemMetadata";
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "id"
+        field: "original_index"
+        field: "success"
+        field: "error"
+    };
+    // Item ID. Provided only whenever possible. For example, `itemId` can't be provided when item creation has failed.
+    google.protobuf.StringValue id = 1 [(.wix.api.format) = GUID];
+    // Index of the item within the request array. Allows for correlation between request and response items.
+    int32 original_index = 2 [(.wix.api.min) = 0];
+    // Whether the requested action for this item was successful. When `false`, the `error` field is returned.
+    bool success = 3;
+    // Details about the error in case of failure.
+    .wix.api.ApplicationError error = 4;
+}
+
+enum BulkActionType {
+    UNKNOWN_ACTION_TYPE = 0 [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
+    INSERT = 1;
+    UPDATE = 2;
+    DELETE = 3;
+}
+
+/*
+
+Example for using it in your service:
+
+message BulkOrderResult {
+    option (.wix.api.decomposite_of) = "wix.commons.v2.BulkOrderResult";
+    ItemMetadata item_metadata = 1;
+    Order item = 2;
+}
+
+message BulkArchiveOrdersResponse {
+    option (.wix.api.decomposite_of) = "wix.commons.v2.BulkArchiveOrdersResponse";
+    repeated BulkOrderResult results = 1;
+    BulkActionMetadata bulk_action_metadata = 2;
+}
+
+*/