@wix/bex-utils 1.37.0 → 1.38.0

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/catalog_spi/api/v1/subscription_option_info.proto

@@ -9,6 +9,7 @@ import "google/protobuf/wrappers.proto";
 import "wix/payment/api/pay/v2/resources/subscription.proto";
 
 message SubscriptionOptionInfo {
+
     // Subscription option settings.
     SubscriptionSettings subscription_settings = 1;
 
@@ -20,29 +21,38 @@ message SubscriptionOptionInfo {
 }
 
 message SubscriptionSettings {
+
     // Frequency of recurring payment.
     .wix.payment.api.pay.v2.SubscriptionFrequency frequency = 1;
 
-    // Interval of recurring payment (optional: default value 1 will be used if not provided)
+    // Interval of recurring payment.
+    //
+    // Default: `1`.
     google.protobuf.Int32Value interval = 2 [(.wix.api.min) = 1, (.wix.api.max) = 50, (.wix.api.field_exposure) = INTERNAL];
 
     // Whether subscription is renewed automatically at the end of each period.
     bool auto_renewal = 3;
 
-    // Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
+    // Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
     google.protobuf.Int32Value billing_cycles = 4 [(.wix.api.min) = 2];
 }
 
 message Title {
-    // Subscription option name.
+
+    // Subscription option name in the site's default language.
     string original = 1 [(.wix.api.minLength) = 1, (.wix.api.maxLength) = 20];
-    // Translated subscription option name.
+
+    // Subscription option name translated into the buyer's language.
+    // 
+    // Default: Same as `original`.
     google.protobuf.StringValue translated = 2 [(.wix.api.minLength) = 1, (.wix.api.maxLength) = 20];
 }
 
 message Description {
+
     // Subscription option description.
     string original = 1 [(.wix.api.maxLength) = 60];
+    
     // Translated subscription option description.
     google.protobuf.StringValue translated = 2 [(.wix.api.maxLength) = 60];
 }

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/inventory/api/v1/inventoryEvents.proto

@@ -4,6 +4,7 @@ package com.wix.ecommerce.inventory.api.v1;
 
 import "google/protobuf/wrappers.proto";
 import "google/protobuf/field_mask.proto";
+import "google/protobuf/timestamp.proto";
 import "wix/inventory/api/v1/inventoryItem.proto";
 import "wix/api/annotations.proto";
 import "wix/api/entity.proto";
@@ -23,6 +24,8 @@ message InventoryItemChanged {
     .wix.inventory.api.v1.PreorderInfo preorder_info = 6;
     // Field mask of updated fields.
     google.protobuf.FieldMask fieldMask = 7;
+    // Date and time the inventory item was last updated.
+    google.protobuf.Timestamp updated_date = 8;
 }
 
 message InventoryVariantsChanged {
@@ -40,6 +43,8 @@ message InventoryVariantsChanged {
     repeated ChangedInventoryVariant variants = 3;
     // Reason data
     .wix.inventory.api.v1.ReasonTypeWrapper.ReasonType reason = 6 [(.wix.api.field_exposure) = INTERNAL];
+    // Date and time the inventory variant item was last updated.
+    google.protobuf.Timestamp updated_date = 8;
 }
 
 message ChangedInventoryVariant {

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/platform_common/api/address_with_contact.proto

@@ -2,7 +2,6 @@ syntax = "proto3";
 
 package com.wix.ecommerce.platform_common.api;
 
-import "wix/api/annotations.proto";
 import "com/wix/ecommerce/platform_common/api/address.proto";
 
 // Billing Info and shipping details

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/com/wix/ecommerce/platform_common/api/locations.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+
+package com.wix.ecommerce.platform_common.api;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+
+message LocationAndQuantity {
+  // Location id in the associated owner app.
+  string id = 1 [(.wix.api.format) = GUID];
+  // Location owner app, if not provided then the site business info locations will be used.
+  google.protobuf.StringValue app_id = 2 [(.wix.api.format) = GUID];
+  // Quantity for specific location.
+  int32 quantity = 3 [(.wix.api.min) = 1, (.wix.api.max) = 100000];
+
+}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/api/annotations.proto

@@ -43,6 +43,7 @@ extend google.protobuf.FieldOptions {
     optional Translatable translatable = 50144; // Mark this field as translatable using MultiLingual services
     optional string sample_data = 50149; // Example of data that may be assigned as a value of this field
     optional Conditional conditional = 50151; // Configure the conditions required for this field to be returned
+    optional bool nullable = 50152; // Mark specific field as nullable
 }
 
 extend google.protobuf.EnumValueOptions {
@@ -249,7 +250,8 @@ message Wql {
         ANY = 12 [deprecated = true]; // [Array] Matches arrays that contain at least one element specified in the query.
         HAS_SOME = 12; // [Array] Matches arrays that contain at least one element specified in the query.
         EMPTY = 13; // [Array] Matches arrays that contain no elements.
-        MATCH_ALL = 14; // [Array] match multiple fields within array with AND operator semantics.
+        MATCH_ALL = 14; // Matches all items. Intended for expressing intent in selecting everything for ex. destructive operations - bulk deletes, updates, etc.
+        MATCH_ITEMS = 16; // [Array] match multiple fields within array with AND operator semantics.
     }
     enum Sort {
         NONE = 0; // no sorting enabled
@@ -287,6 +289,7 @@ message Wql {
         target_removal_date: "2023-03-31"
     }];
     repeated OperatorFieldSupport pattern = 4; // supported operators for subject query method
+    optional bool validate_query = 6; // false by default. all new services will have it set to true
 }
 
 message Search {

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/api/entity.proto

@@ -61,7 +61,10 @@ message Entity {
 }
 
 message Extensible {
+
     optional string nested_extension_field_path = 1;
+    // Indicates whether this entity supports filtering by extended fields which are marked in schema as `x-wix-filterable`
+    optional bool filterable = 2;
 }
 
 message MessageAppendix {
@@ -70,6 +73,7 @@ message MessageAppendix {
         AUTO_VELO = 1; // auto velo configuration
         DOCS_CONF = 2; // wix docs configuration: `documentation.yaml`
         MULTILINGUAL = 3; // wix multilingual configuration
+        SEARCH = 4; // nile search configuration
     }
     required Type type = 1; // appendix type
     required string path = 2; // absolute from module root
@@ -77,4 +81,6 @@ message MessageAppendix {
 
 message DomainEventOptions {
     optional bool event_sequence_number = 1; // indicated whenever `entity_event_sequence` in the envelope is set/populated for CUD events.
+    optional bool deleted_include_entity = 2; // indicated whenever `deleted_entity_as_json` is set/populated for EntityDeletedEvent events.
+    optional bool updated_include_modified_fields = 3; // indicated whenever `modified_fields` is set/populated for EntityUpdatedEvent events.
 }

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/api/errors.proto

@@ -11,6 +11,7 @@ message Details {
     oneof kind {
         ApplicationError application_error = 1;
         ValidationError validation_error = 2;
+        SystemError system_error = 4;
     }
     map<string, string> tracing = 3 [deprecated = true]; // deprecated in API's - to enable migration from rendering arbitrary tracing to rest response
 }
@@ -24,6 +25,11 @@ message ApplicationError {
     google.protobuf.Struct data = 3;
 }
 
+message SystemError {
+    // Error code.
+    google.protobuf.StringValue errorCode = 1;
+}
+
 /**
 example result:
 {

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/catalog/api/v1/catalog.proto

@@ -3,10 +3,10 @@ syntax = "proto3";
 package wix.catalog.api.v1;
 
 import "google/api/annotations.proto";
-import "wix/api/callback.proto";
 import "wix/api/api_errors.proto";
 import "wix/api/validations.proto";
 import "wix/api/annotations.proto";
+import "wix/api/callback.proto";
 import "wix/api/entity.proto";
 import "wix/common/bulk.proto";
 import "wix/catalog/api/v1/bulk.proto";
@@ -147,6 +147,7 @@ service CatalogReadApi {
     }
 
     // Retrieves a product with the provided ID.
+    //flynt-disable crud-add-get-annotation
     rpc GetProduct (GetProductRequest) returns (GetProductResponse) {
         option (google.api.http) = {
             get: "/v1/products/{id}"
@@ -579,6 +580,8 @@ service CatalogWriteApi {
     option (wix.api.service_entity).message = "wix.catalog.api.v1.Product";
 
     //Creates a new product.
+    //flynt-disable missing-cud-event
+    //flynt-disable crud-add-create-annotation
     rpc CreateProduct (CreateProductRequest) returns (CreateProductResponse) {
         option (wix.api.required) = "CreateProductRequest.product.name";
         option (wix.api.required) = "CreateProductRequest.product.priceData";
@@ -592,6 +595,7 @@ service CatalogWriteApi {
     }
 
     //Creates a new product.
+    //flynt-disable crud-add-create-annotation
     rpc CreateProductPlatformized (CreateProductPlatformizedRequest) returns (CreateProductPlatformizedResponse) {
         option (wix.api.required) = "CreateProductPlatformizedRequest.product.name";
         option (wix.api.required) = "CreateProductPlatformizedRequest.product.priceData";
@@ -603,13 +607,30 @@ service CatalogWriteApi {
         };
         option (.wix.sdk.signature) = {params: "product"};
         option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
-       option (.wix.api.callback) = {
-         event_type: CREATED
-         permission: "WIX_STORES.READ_PRODUCTS"
-       };
+    }
+
+    //Creates a new digital product.
+    //flynt-disable missing-cud-event
+    //flynt-disable crud-add-create-annotation
+    rpc CreateDigitalProduct (CreateDigitalProductRequest) returns (CreateDigitalProductResponse) {
+        option (wix.api.exposure) = INTERNAL;
+        option (wix.api.required) = "CreateDigitalProductRequest.product.name";
+        option (wix.api.required) = "CreateDigitalProductRequest.product.priceData";
+        option (wix.api.required) = "CreateDigitalProductRequest.product.priceData.price";
+        option (wix.api.required) = "CreateDigitalProductRequest.product.cost_and_profit_data.item_cost";
+        option (wix.api.required) = "CreateDigitalProductRequest.product.digital_file";
+        option (wix.api.required) = "CreateDigitalProductRequest.product.digital_file.id";
+        option (wix.api.required) = "CreateDigitalProductRequest.product.digital_file.file_name";
+        option (wix.api.required) = "CreateDigitalProductRequest.product.digital_file.file_type";
+        option (google.api.http) = {
+            post: "/v1/products-digital"
+        };
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
     }
 
     //Updates specified fields in a product.
+    //flynt-disable missing-cud-event
+    //flynt-disable crud-add-update-annotation
     rpc UpdateProduct (UpdateProductRequest) returns (UpdateProductResponse) {
         option (wix.api.required) = "UpdateProductRequest.product.id";
         option (wix.api.required) = "UpdateProductRequest.product";
@@ -620,6 +641,7 @@ service CatalogWriteApi {
     }
 
     //Updates specified fields in a product.
+    //flynt-disable crud-add-update-annotation
     rpc UpdateProductPlatformized (UpdateProductPlatformizedRequest) returns (UpdateProductPlatformizedResponse) {
         option (wix.api.required) = "UpdateProductPlatformizedRequest.product.id";
         option (wix.api.required) = "UpdateProductPlatformizedRequest.product";
@@ -628,13 +650,11 @@ service CatalogWriteApi {
             patch: "/v1/products-platformized/{product.id}"
         };
         option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
-        option (.wix.api.callback) = {
-          event_type: UPDATED
-          permission: "WIX_STORES.READ_PRODUCTS"
-        };
     }
 
     //Deletes a product.
+    //flynt-disable missing-cud-event
+    //flynt-disable crud-add-delete-annotation
     rpc DeleteProduct (DeleteProductRequest) returns (DeleteProductResponse) {
         option (wix.api.required) = "DeleteProductRequest.id";
         option (google.api.http) = {
@@ -644,6 +664,7 @@ service CatalogWriteApi {
     }
 
     //Deletes a product.
+    //flynt-disable crud-add-delete-annotation
     rpc DeleteProductPlatformized (DeleteProductPlatformizedRequest) returns (DeleteProductPlatformizedResponse) {
         option (wix.api.required) = "DeleteProductPlatformizedRequest.id";
         option (wix.api.exposure) = PUBLIC;
@@ -651,10 +672,6 @@ service CatalogWriteApi {
             delete: "/v1/products-platformized/{id}"
         };
         option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
-        option (.wix.api.callback) = {
-          event_type: DELETED
-          permission: "WIX_STORES.READ_PRODUCTS"
-        };
     }
 
     //Deletes a bulk of products.
@@ -758,6 +775,8 @@ service CatalogWriteApi {
     }
 
     // Delete all options from a specific product. Only available when [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is disabled.
+    //flynt-disable missing-cud-event
+    //flynt-disable crud-add-delete-annotation
     rpc DeleteProductOptions (DeleteProductOptionsRequest) returns (DeleteProductOptionsResponse) {
         option (wix.api.required) = "DeleteProductOptionsRequest.id";
         option (google.api.http) = {
@@ -765,6 +784,13 @@ service CatalogWriteApi {
         };
         option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
         option (wix.api.maturity) = BETA;
+
+//      option (.wix.api.crud) = {
+//        method: DELETE
+//        delete_options: {
+//          id_field: "id"
+//        }
+//      };
     }
 
     rpc SetCustomFields (SetCustomFieldsRequest) returns (SetCustomFieldsResponse) {
@@ -946,6 +972,16 @@ message CreateProductPlatformizedResponse {
     Product product = 1;
 }
 
+message CreateDigitalProductRequest {
+    //Product information.
+    Product product = 1;
+}
+
+message CreateDigitalProductResponse {
+    //Created product.
+    Product product = 1;
+}
+
 message UpdateProductRequest {
     Product product = 1;
 }

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/catalog/api/v1/media.proto

@@ -31,7 +31,7 @@ message MediaItem {
 
 message MediaItemUrlAndSize {
     // Media item URL.
-    string url = 1 [(wix.api.format) = URI];
+    string url = 1 [(wix.api.format) = WEB_URL];
     // Media item width.
     int32 width = 2 [(wix.api.min) = 0];
     // Media item height.
@@ -70,7 +70,7 @@ message MediaDataForWrite {
         // Media ID. For media items previously saved in Wix Media, the media ID is returned in the Query Product response.
         string mediaId = 1;
         // Media external URL (for new media items).
-        string url = 2 [(wix.api.format) = URI];
+        string url = 2 [(wix.api.format) = WEB_URL];
     }
 
     // Assign this media item to a specific product choice.

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/catalog/api/v1/product.proto

@@ -16,6 +16,7 @@ import "google/protobuf/timestamp.proto";
 import "com/wix/ecommerce/commons/api/measurementUnit.proto";
 import "advanced-seo-api.proto";
 import "com/wix/ecommerce/catalog_spi/api/v1/platform_catalog_spi.proto";
+import "com/wix/ecommerce/catalog_spi/api/v1/secured_media.proto";
 
 
 option java_package = "com.wix.ecommerce.catalog.api.v1";
@@ -23,6 +24,7 @@ option java_package = "com.wix.ecommerce.catalog.api.v1";
 message Product {
     option (wix.api.entity) = {
         fqdn: "wix.stores.catalog.v1.product"
+        app_def_id: "215238eb-22a5-4c36-9e7b-e7c08025e04e"
         segment: USERS
         appendix_files: {
             type: AUTO_VELO
@@ -107,6 +109,9 @@ message Product {
     google.protobuf.StringValue tax_group_id = 35 [(wix.api.format) = GUID, (wix.api.field_exposure) = INTERNAL];
     //internal field used by import/export to know how to link products in csv file to product ids
     string export_product_id = 36 [(wix.api.readOnly) = true, (wix.api.field_exposure) = PRIVATE, (wix.api.maxLength) = 100];
+
+    //Digital file which will be downloaded by buyer after successful purchase.
+    com.wix.ecommerce.catalog_spi.api.v1.SecuredMedia digital_file = 200 [(wix.api.readOnly) = true, (.wix.api.field_exposure) = INTERNAL];
 }
 
 enum ProductType {

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/catalog/api/v2/collectionRead.proto

@@ -5,10 +5,8 @@ package wix.catalog.api.v2;
 import "google/api/annotations.proto";
 import "wix/api/annotations.proto";
 import "wix/api/entity.proto";
-import "wix/catalog/api/v1/catalog.proto";
 import "wix/catalog/api/v1/collection.proto";
 import "com/wix/ecommerce/commons/api/platformQuery.proto";
-import "com/wix/ecommerce/commons/api/unlimitedPlatformQuery.proto";
 import "com/wix/ecommerce/commons/api/platformPagingMetadata.proto";
 import "wix/api/validations.proto";
 
@@ -79,6 +77,7 @@ message QueryCollectionsResponse {
     com.wix.ecommerce.commons.api.PlatformPagingMetadata metadata = 2;
 }
 
+//flynt-disable crud-get-item-message-validation
 message GetCollectionRequest {
     // Requested collection ID.
     string id = 1;

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/common/media.proto

@@ -75,6 +75,8 @@ message VideoV2 {
     google.protobuf.StringValue size_in_bytes = 6 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE, (.wix.api.format) = DECIMAL_VALUE];
     // Video URL expiration date (when relevant).
     google.protobuf.Timestamp url_expiration_date = 7 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE];
+    // Original video duration in milliseconds.
+    google.protobuf.Int32Value duration_in_milliseconds = 8 [(.wix.api.field_exposure) = PRIVATE, (.wix.api.readOnly) = true, (.wix.api.min) = 0];
 }
 
 message VideoResolution {
@@ -104,7 +106,12 @@ message VideoResolution {
     // Video filename.
     google.protobuf.StringValue filename = 10 [(.wix.api.field_exposure) = PRIVATE];
     // Video duration in seconds.
-    google.protobuf.Int32Value duration_in_seconds = 11 [(.wix.api.field_exposure) = PRIVATE, (.wix.api.readOnly) = true, (.wix.api.min) = 0];
+    google.protobuf.Int32Value duration_in_seconds = 11 [(.wix.api.field_exposure) = PRIVATE, (.wix.api.readOnly) = true, (.wix.api.min) = 0, (.wix.api.field_deprecated) = {
+        replaced_by: "duration_in_milliseconds"
+        target_removal_date: "2024-08-01"
+    }];
+    // Video duration in milliseconds.
+    google.protobuf.Int32Value duration_in_milliseconds = 12 [(.wix.api.field_exposure) = PRIVATE, (.wix.api.readOnly) = true, (.wix.api.min) = 0];
 
     // When true, this is a protected asset, and calling the URL will return a 403 error.
     // In order to access private assets, make a request to:
@@ -131,7 +138,7 @@ message Audio {
     google.protobuf.StringValue size_in_bytes = 4 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE, (.wix.api.format) = DECIMAL_VALUE];
     // Audio filename.
     google.protobuf.StringValue filename = 5 [(.wix.api.readOnly) = true];
-    // Audio duration in seconds.
+    // Audio duration in milliseconds.
     google.protobuf.Int32Value duration = 6 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE, (.wix.api.min) = 0];
 
     // When true, this is a protected asset, and calling the URL will return a 403 error.

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/common/pageurl.proto

@@ -14,9 +14,9 @@ message PageUrl {
         field: "base"
         field: "path"
     };
-    // The base URL. For premium sites, this will be the domain. For free sites, this would be site URL (e.g mysite.wixsite.com/mysite)
+    // The base URL. For premium sites, this is the domain. For free sites, this is the site URL. For example, `mysite.wixsite.com/mysite`.
     string base = 1;
-    // The path to that page - e.g /product-page/a-product
+    // The relative path for the page within the site. For example, `/product-page/a-product`.
     string path = 2;
 }
 
@@ -25,8 +25,8 @@ message PageUrlV2 {
         field: "relative_path"
         field: "url"
     };
-    // The path to that page - e.g /product-page/a-product
+    // The relative path for the page within the site. For example, `/product-page/a-product`.
     string relative_path = 1;
-    // The URL of that page. e.g https://mysite.com/product-page/a-product
+    // The page's full URL. For example, `https://mysite.com/product-page/a-product`.
     google.protobuf.StringValue url = 2;
 }

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/common/paging.proto

@@ -25,16 +25,17 @@ message CursorPaging {
         field: "limit"
         field: "cursor"
     };
-    // Number of items to load.
+
+    // Maximum number of items to return in the results.
     google.protobuf.Int32Value limit = 1 [(.wix.api.min) = 0, (.wix.api.max) = 100];
+
     /*
     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.
+    Pass 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;
+    google.protobuf.StringValue cursor = 2 [(.wix.api.maxLength) = 16000];
 }
 
 message PagingMetadata {
@@ -86,13 +87,19 @@ message PagingMetadataV2 {
 
 message CursorPagingMetadata {
     option (.wix.api.decomposite_of) = "wix.common.PagingMetadataV2";
+
     // Number of items returned in the response.
     google.protobuf.Int32Value count = 1;
-    // Offset that was requested.
+
+    // Cursor strings that point to the next page, previous page, or both.
     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.
+
+    /*
+    Whether there are more pages to retrieve following the current page.
+
+    + `true`: Another page of results can be retrieved.
+    + `false`: This is the last page.
+    */
     google.protobuf.BoolValue has_next = 3;
 }
 
@@ -100,8 +107,10 @@ message Cursors {
     option (.wix.api.decomposition_minimum_fields) = {
         field: "next"
     };
-    // Cursor pointing to next page in the list of results.
-    google.protobuf.StringValue next = 1;
-    // Cursor pointing to previous page in the list of results.
-    google.protobuf.StringValue prev = 2;
+
+    // Cursor string pointing to the next page in the list of results.
+    google.protobuf.StringValue next = 1 [(.wix.api.maxLength) = 16000];
+
+    // Cursor pointing to the previous page in the list of results.
+    google.protobuf.StringValue prev = 2 [(.wix.api.maxLength) = 16000];
 }