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

@@ -0,0 +1,65 @@
+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/message/condition.proto";
+
+message RemoveDataItemRequest {
+  // 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];
+
+  // ID of the item to remove.
+  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 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 removing the item.
+  //
+  // When a condition is provided, the item is only removed if the condition is met.
+  Condition condition = 10;
+}
+
+message RemoveDataItemResponse {
+  // Removed item.
+  DataItem data_item = 1;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/replace-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/data-item-reference.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+
+message ReplaceDataItemReferencesRequest {
+  // 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];
+
+  // Field containing references in the referring item.
+  string referring_item_field_name = 3 [(wix.api.maxLength) = 1000];
+
+  // ID of the referring item.
+  string referring_item_id = 4 [(wix.api.maxLength) = 128];
+
+  // List of new referenced item IDs to replace the existing ones.
+  repeated string new_referenced_item_ids = 5 [(wix.api.maxLength) = 128, (wix.api.maxSize) = 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"
+    }
+  ];
+
+  google.protobuf.Struct app_options = 8 [(wix.api.field_exposure) = PRIVATE];
+}
+
+message ReplaceDataItemReferencesResponse {
+  // Updated references.
+  repeated DataItemReference data_item_references = 1;
+}

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

@@ -0,0 +1,87 @@
+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 SaveDataItemRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection in which to insert or update the item.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Data item to insert or update.
+  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;
+
+  // 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 SaveDataItemResponse {
+  enum Action {
+    // Undefined action.
+    UNKNOWN_ACTION = 0 [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
+    // A new item was added to the collection.
+    INSERTED = 1;
+    // An existing item in the collection was updated.
+    UPDATED = 2;
+  }
+  // The action carried out for the item.
+  Action action = 1;
+  
+  // Inserted or updated data item.
+  DataItem data_item = 2;
+
+}

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

@@ -0,0 +1,78 @@
+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 SearchDataItemsRequest {
+  // Environment: `LIVE` or `SANDBOX`.
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection to search.
+  string data_collection_id = 2 [(wix.api.maxLength) = 255];
+
+  // Search query configuration.
+  upstream.wix.common.Search search = 3;
+
+  // Grid app id. Optional in Live segment.
+  google.protobuf.StringValue app_id = 6 [(wix.api.format) = GUID, (wix.api.field_exposure) = PRIVATE];
+
+  // NOT IMPLEMENTED!
+  // 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. If not provided, result text is not translated.
+  // 
+  // > **Note:** Translation for the specified language must be enabled for the collection in [Wix Multilingual](https://www.wix.com/app-market/wix-multilingual).
+  google.protobuf.StringValue language = 9 [(wix.api.format) = LANGUAGE_TAG, (wix.api.field_exposure) = PRIVATE];
+
+  // Whether to suppress data hooks.
+  //
+  // When `true`, data hooks typically triggered by this endpoint don't run.
+  //
+  // Default: `false`.
+  //
+  // > **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).
+  bool suppress_hooks = 11 [(wix.api.field_exposure) = PRIVATE];
+
+  // Options for the Publish plugin.
+  //
+  // This plugin allows items 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.
+  //
+  // Learn more about [using reference fields](https://support.wix.com/en/article/cms-using-reference-fields-to-display-content-from-multiple-collections).
+  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
+  ];
+
+  // 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 = 15 [(wix.api.maxSize) = 100];
+
+  message ReferencedItemOptions {
+    // Field in the retrieved item that contains references.
+    string field_name = 1 [(wix.api.maxLength) = 1000];
+    // Maximum number of referenced items to include for each retrieved item.
+    google.protobuf.Int32Value limit = 2 [(wix.api.max) = 1000];
+  }
+}
+
+message SearchDataItemsResponse {
+  // Retrieved items.
+  repeated DataItem data_items = 1 [(wix.api.maxSize) = 1000];
+
+  // Paging configuration.
+  upstream.wix.common.PagingMetadataV2 paging_metadata = 5;
+}

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

@@ -0,0 +1,33 @@
+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/options.proto";
+
+message TruncateDataItemsRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection to truncate.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // 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"
+    }
+  ];
+}
+
+message TruncateDataItemsResponse {
+}

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

@@ -0,0 +1,31 @@
+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 "google/protobuf/wrappers.proto";
+import "com/wixpress/cloud/data/api/common.proto";
+import "wix/api/annotations.proto";
+
+message UnpublishDataItemRequest {
+  // 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 retract. The published copy is removed and a draft is created (or, if a draft already exists, overwritten) seeded with the previously-published data. Returns `NOT_FOUND` if no published item exists with this ID.
+  string data_item_id = 3 [(wix.api.maxLength) = 128];
+
+  // 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 = 4;
+}
+
+message UnpublishDataItemResponse {
+  // The newly-created (or overwritten) draft data item, seeded with the previously-published data. The published copy has been removed.
+  DataItem data_item = 1;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/message/update.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/data-item.proto";
+import "com/wixpress/cloud/data/api/data/message/options.proto";
+import "com/wixpress/cloud/data/api/data/message/condition.proto";
+
+message UpdateDataItemRequest {
+  // Environment: LIVE or SANDBOX
+  Environment environment = 1 [(wix.api.field_exposure) = PRIVATE];
+
+  // ID of the collection containing the existing item.
+  string data_collection_id = 2 [(wix.api.maxLength) = 256];
+
+  // Updated data item content. The existing data item's content is replaced entirely.
+  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;
+
+  // 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 item.
+  //
+  // When a condition is provided, the item is only updated if the condition is met.
+  Condition condition = 10;
+
+  // Whether to save multi-reference fields.
+  // When `true`, multi-reference fields in the data item 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 UpdateDataItemResponse {
+  // Updated data item.
+  DataItem data_item = 1;
+}

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

@@ -0,0 +1,60 @@
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data.upstream.wix.common;
+
+option java_multiple_files = true;
+option java_package = "com.wixpress.cloud.data.api.data.upstream.wix.common";
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/errors.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+
+
+message BulkActionMetadata {
+    option (.wix.api.decomposite_of) = "wix.common.BulkActionMetadata";
+    // Number of items successfully processed.
+    int32 total_successes = 1;
+    // Number of items that couldn't be processed.
+    int32 total_failures = 2;
+
+    reserved 3;
+}
+
+message ItemMetadata {
+    option (.wix.api.decomposite_of) = "wix.common.ItemMetadata";
+    // Item ID. Does not appear if the item ID is missing. For example, when item creation fails.
+    google.protobuf.StringValue id = 1 [(.wix.api.maxLength) = 128];
+    // Original index of the item in the array specified in the request. Use this to match items in the request with those in the response.
+    int32 original_index = 2;
+    // Whether the requested action was successful. When `false`, the `error` field is populated.
+    bool success = 3;
+    // In case of failure, the error details.
+    .wix.api.ApplicationError error = 4;
+}
+
+enum BulkActionType {
+    UNKNOWN_ACTION_TYPE = 0;
+    INSERT = 1;
+    UPDATE = 2;
+    DELETE = 3;
+    PATCH = 4;
+}
+
+/*
+
+Example for using it in your service:
+
+message BulkOrderResult {
+    option (.wix.api.decomposite_of) = "wix.common.BulkOrderResult";
+    ItemMetadata item_metadata = 1;
+    Order item = 2;
+}
+
+message BulkArchiveOrdersResponse {
+    option (.wix.api.decomposite_of) = "wix.common.BulkArchiveOrdersResponse";
+    repeated BulkOrderResult results = 1;
+    BulkActionMetadata bulk_action_metadata = 2;
+}
+
+*/

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/upstream/wix/common/paging.proto

@@ -0,0 +1,113 @@
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data.upstream.wix.common;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+
+option java_multiple_files = true;
+option java_package = "com.wixpress.cloud.data.api.data.upstream.wix.common";
+
+message Paging {
+    option (.wix.api.decomposite_of) = "wix.common.Paging";
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "limit"
+        field: "offset"
+    };
+    // Number of items to load.
+    google.protobuf.Int32Value limit = 1 [(.wix.api.min) = 0];
+    // Number of items to skip in the current sort order.
+    google.protobuf.Int32Value offset = 2 [(.wix.api.min) = 0];
+}
+
+message CursorPaging {
+    option (.wix.api.decomposite_of) = "wix.common.CursorPaging";
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "limit"
+        field: "cursor"
+    };
+    // Number of items to load.
+    google.protobuf.Int32Value limit = 1 [(.wix.api.min) = 0, (.wix.api.max) = 1000];
+    /*
+    Pointer to the next or previous page in the list of results.
+
+    You can get the relevant cursor token
+    from the `pagingMetadata` object in the previous call's response.
+    Not relevant for the first request.
+    */
+    google.protobuf.StringValue cursor = 2 [(.wix.api.maxLength) = 150000];
+}
+
+message PagingMetadata {
+    option (.wix.api.decomposite_of) = "wix.common.PagingMetadata";
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "count"
+        field: "offset"
+    };
+    // Number of items returned in the response.
+    google.protobuf.Int32Value count = 1;
+    // Offset that was requested.
+    google.protobuf.Int32Value offset = 2;
+    // Total number of items that match the query.
+    google.protobuf.Int32Value total = 3;
+    // Flag that indicates the server failed to calculate the `total` field.
+    google.protobuf.BoolValue too_many_to_count = 4;
+    // Indicates if there are more results after the current page.
+    // If `true`, another page of results can be retrieved.
+    // If `false`, this is the last page.
+    google.protobuf.BoolValue has_next = 5 [(.wix.api.field_exposure) = PRIVATE];
+}
+
+message PagingMetadataV2 {
+    option (.wix.api.decomposite_of) = "wix.common.PagingMetadataV2";
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "count"
+        field: "offset"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "count"
+        field: "cursors"
+    };
+    // Number of items returned in the response.
+    google.protobuf.Int32Value count = 1;
+    // Offset that was requested.
+    google.protobuf.Int32Value offset = 2;
+    // Total number of items that match the query. Returned if offset paging is used, `returnTotalCount` is `true` in the request, and `tooManyToCount` is false.
+    google.protobuf.Int32Value total = 3;
+    // Whether the server failed to calculate the `total` field.
+    google.protobuf.BoolValue too_many_to_count = 4;
+    // Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used.
+    Cursors cursors = 5;
+
+    // Indicates if there are more results after the current page.
+    // If `true`, another page of results can be retrieved.
+    // If `false`, this is the last page.
+    google.protobuf.BoolValue has_next = 6 [(.wix.api.field_exposure) = PRIVATE];
+}
+
+
+// This is the preferred message for cursor-paging enabled services
+
+message CursorPagingMetadata {
+    option (.wix.api.decomposite_of) = "wix.common.CursorPagingMetadata";
+    // Number of items returned in the response.
+    google.protobuf.Int32Value count = 1;
+    // Offset that was requested.
+    Cursors cursors = 2;
+    // Indicates if there are more results after the current page.
+    // If `true`, another page of results can be retrieved.
+    // If `false`, this is the last page.
+    google.protobuf.BoolValue has_next = 3;
+}
+
+message Cursors {
+    option (.wix.api.decomposite_of) = "wix.common.Cursors";
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "next"
+    };
+    // Cursor pointing to next page in the list of results.
+    google.protobuf.StringValue next = 1 [(.wix.api.maxLength) = 150000];
+    // Cursor pointing to previous page in the list of results.
+    google.protobuf.StringValue prev = 2 [(.wix.api.maxLength) = 150000];
+}