@wix/bex-utils 2.38.0 → 2.40.0

package/@wix/ambassador-infra-asyncjobs-v1-async-job/src/main/proto/wix/common/bulk.proto

@@ -0,0 +1,53 @@
+syntax = "proto3";
+
+package wix.common;
+
+option java_multiple_files = true;
+option java_package = "com.wix.common";
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/errors.proto";
+
+message BulkActionMetadata {
+    // Number of items that were successfully processed.
+    int32 total_successes = 1;
+    // Number of items that couldn't be processed.
+    int32 total_failures = 2;
+    // Number of failures without details because detailed failure threshold was exceeded.
+    int32 undetailed_failures = 3;
+}
+
+message ItemMetadata {
+    // Item ID. Should always be available, unless it's impossible (for example, when failing to create an item).
+    google.protobuf.StringValue id = 1;
+    // Index of the item within the request array. Allows for correlation between request and response items.
+    int32 original_index = 2;
+    // Whether the requested action was successful for this item. When `false`, the `error` field is populated.
+    bool success = 3;
+    // Details about the error in case of failure.
+    .wix.api.ApplicationError error = 4;
+}
+
+enum BulkActionType {
+    UNKNOWN_ACTION_TYPE = 0;
+    INSERT = 1;
+    UPDATE = 2;
+    DELETE = 3;
+}
+
+/*
+
+Example for using it in your service:
+
+message BulkOrderResult {
+    ItemMetadata item_metadata = 1;
+    Order item = 2;
+}
+
+message BulkArchiveOrdersResponse {
+    repeated BulkOrderResult results = 1;
+    BulkActionMetadata bulk_action_metadata = 2;
+}
+
+*/

package/@wix/ambassador-infra-asyncjobs-v1-async-job/src/main/proto/wix/common/identification.proto

@@ -0,0 +1,40 @@
+syntax = "proto3";
+
+package wix.common;
+
+option java_multiple_files = true;
+option java_package = "com.wix.common";
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+
+message IdentificationData {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "identity_type"
+        field: "anonymous_visitor_id"
+        field: "member_id"
+        field: "wix_user_id"
+        field: "app_id"
+    };
+    enum IdentityType {
+        UNKNOWN = 0;
+        ANONYMOUS_VISITOR = 1;
+        MEMBER = 2;
+        WIX_USER = 3;
+        APP = 4;
+    }
+    // ID of of a contact in the site's [CRM by Ascend](https://www.wix.com/ascend/crm) system.
+    google.protobuf.StringValue contact_id = 1 [(.wix.api.format) = GUID, (.wix.api.referenced_entity) = "wix.contacts.v4.contact"];
+    IdentityType identity_type = 6 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE];
+    oneof id {
+        // ID of a site visitor that has not logged in to the site.
+        string anonymous_visitor_id = 2 [(.wix.api.format) = GUID];
+        // ID of a site visitor that has logged in to the site.
+        string member_id = 3 [(.wix.api.format) = GUID, (.wix.api.referenced_entity) = "wix.members.v1.member"];
+        // ID of a Wix user (site owner, contributor, etc.).
+        string wix_user_id = 4 [(.wix.api.format) = GUID];
+        // ID of an app.
+        string app_id = 5 [(.wix.api.format) = GUID];
+    }
+}

package/@wix/ambassador-infra-asyncjobs-v1-async-job/src/main/proto/wix/common/image.proto

@@ -0,0 +1,8 @@
+syntax = "proto3";
+
+package wix.common;
+
+option java_multiple_files = true;
+option java_package = "com.wix.common";
+
+//Moved to media.proto - please update your references

package/@wix/ambassador-infra-asyncjobs-v1-async-job/src/main/proto/wix/common/media.proto

@@ -0,0 +1,253 @@
+syntax = "proto3";
+
+package wix.common;
+
+option java_multiple_files = true;
+option java_package = "com.wix.common";
+
+import "wix/api/annotations.proto";
+import "wix/common/image.proto";
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/timestamp.proto";
+import "wix/api/validations.proto";
+
+message Image {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "id"
+        field: "height"
+        field: "width"
+    };
+    // WixMedia image ID.
+    string id = 1;
+    // Image URL.
+    string url = 2;
+    // Original image height.
+    int32 height = 3 [(.wix.api.readOnly) = true];
+    // Original image width.
+    int32 width = 4 [(.wix.api.readOnly) = true];
+    // Image alt text.
+    google.protobuf.StringValue alt_text = 5;
+    // Image URL expiration date (when relevant).
+    google.protobuf.Timestamp url_expiration_date = 6 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE];
+    // Image filename.
+    google.protobuf.StringValue filename = 7 [(.wix.api.readOnly) = true];
+    // Image size in bytes.
+    google.protobuf.StringValue size_in_bytes = 8 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE, (.wix.api.format) = DECIMAL_VALUE];
+    // Focal point of the image.
+    FocalPoint focal_point = 9 [(.wix.api.field_exposure) = PRIVATE];
+}
+
+// Deprecated - use VideoV2
+message Video {
+    option deprecated = true;
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "id"
+        field: "url"
+        field: "height"
+        field: "width"
+    };
+    // WixMedia ID
+    string id = 1;
+    // URL of video
+    string url = 2;
+    // Original image height
+    int32 height = 3 [(.wix.api.readOnly) = true];
+    // Original image width
+    int32 width = 4 [(.wix.api.readOnly) = true];
+    // Video poster
+    Image thumbnail = 5;
+}
+
+message VideoV2 {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "id"
+        field: "resolutions"
+    };
+    // WixMedia ID.
+    string id = 1;
+    // Original video URL.
+    string url = 4 [(.wix.api.field_exposure) = PRIVATE];
+    // Available resolutions for the video, starting with the optimal resolution.
+    repeated VideoResolution resolutions = 2 [(.wix.api.readOnly) = true, (.wix.api.maxSize) = 100];
+    // Video filename.
+    google.protobuf.StringValue filename = 3 [(.wix.api.readOnly) = true];
+    // Video posters.
+    repeated Image posters = 5 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE];
+    // Original video size in bytes.
+    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];
+    // A short title for the video. will be used for SEO purposes.
+    google.protobuf.StringValue title = 9 [(wix.api.maxLength) = 300, (.wix.api.field_exposure) = PRIVATE];
+    // A long description for the video. will be used for SEO purposes.
+    google.protobuf.StringValue description = 10 [(wix.api.maxLength) = 2000, (.wix.api.field_exposure) = PRIVATE];
+    // Original video height.
+    google.protobuf.Int32Value height = 11 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE, (.wix.api.min) = 0];
+    // Original video width.
+    google.protobuf.Int32Value width = 12 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE, (.wix.api.min) = 0];
+}
+
+message VideoResolution {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "url"
+        field: "height"
+        field: "width"
+        field: "poster"
+        field: "format"
+    };
+    // Video URL.
+    string url = 2;
+    // Video height.
+    int32 height = 3;
+    // Video width.
+    int32 width = 4;
+    // Deprecated. Use the `posters` property in the parent entity instead.
+    Image poster = 5 [(.wix.api.field_exposure) = PRIVATE, deprecated = true];
+    // Video format for example, mp4, hls.
+    string format = 6;
+    // Deprecated. Use the `urlExpirationDate` property in the parent entity instead.
+    google.protobuf.Timestamp url_expiration_date = 7 [(.wix.api.field_exposure) = PRIVATE, deprecated = true];
+    // Deprecated. Use the `sizeInBytes` property in the parent entity instead. Size cannot be provided per resolution.
+    google.protobuf.StringValue size_in_bytes = 8 [(.wix.api.field_exposure) = PRIVATE, (.wix.api.format) = DECIMAL_VALUE, deprecated = true];
+    // Video quality. For example: 480p, 720p.
+    google.protobuf.StringValue quality = 9 [(.wix.api.field_exposure) = PRIVATE];
+    // 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, (.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:
+    // `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
+    google.protobuf.BoolValue private = 30 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE];
+    // Key to identify the video resolution's relationship to the original media in WixMedia.
+    // Can be used to request a download for the specific video resolution.
+    // For example: 480p.mp4, 720p.mp4, 1080p.mp4, trailer-720p.mp4, clip-720p.mp4
+    google.protobuf.StringValue asset_key = 31 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE];
+}
+
+message Audio {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "id"
+        field: "url"
+    };
+    // WixMedia ID.
+    string id = 1;
+    // Audio URL.
+    string url = 2;
+    // Audio URL expiration date (when relevant).
+    google.protobuf.Timestamp url_expiration_date = 3 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE];
+    // Audio size in bytes.
+    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 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.
+    // In order to access private assets, make a request to:
+    // `GenerateFileDownloadUrl` with the WixMedia id and specify the asset_key in the request
+    google.protobuf.BoolValue private = 30 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE];
+    // Key to identify the object relationship to the original media in WixMedia.
+    // Can be used to request a download for the specific asset.
+    // For example: 128-30kbs.mp3, 320kbs.mp3, 128kbs.mp3
+    google.protobuf.StringValue asset_key = 31 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE];
+    // Audio format.
+    google.protobuf.StringValue format = 32 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE];
+    // Audio quality.
+    google.protobuf.StringValue quality = 33 [(.wix.api.readOnly) = true, (.wix.api.field_exposure) = PRIVATE];
+}
+
+message Document {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "id"
+        field: "url"
+    };
+    // WixMedia ID.
+    string id = 1;
+    // Document URL.
+    string url = 2;
+    // Document URL expiration date (when relevant).
+    google.protobuf.Timestamp url_expiration_date = 3 [(.wix.api.field_exposure) = PRIVATE];
+    // Document size in bytes.
+    google.protobuf.StringValue size_in_bytes = 4 [(.wix.api.field_exposure) = PRIVATE, (.wix.api.format) = DECIMAL_VALUE];
+    // Document filename.
+    google.protobuf.StringValue filename = 5;
+}
+
+message Model3D {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "id"
+    };
+    // WixMedia 3D ID.
+    string id = 1;
+    // 3D URL.
+    string url = 2;
+    // 3D thumbnail Image
+    Image thumbnail = 3;
+    // 3D alt text.
+    google.protobuf.StringValue alt_text = 5;
+    // 3D URL expiration date (when relevant).
+    google.protobuf.Timestamp url_expiration_date = 6 [(.wix.api.readOnly) = true];
+    // 3D filename.
+    google.protobuf.StringValue filename = 7 [(.wix.api.readOnly) = true];
+    // 3D size in bytes.
+    google.protobuf.StringValue size_in_bytes = 8 [(.wix.api.readOnly) = true, (.wix.api.format) = DECIMAL_VALUE];
+}
+
+
+message Archive {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "id"
+    };
+    // WixMedia ID.
+    string id = 1;
+    // Archive URL.
+    string url = 2;
+    // Archive URL expiration date (when relevant).
+    google.protobuf.Timestamp url_expiration_date = 3 [(.wix.api.readOnly) = true];
+    // Archive size in bytes.
+    google.protobuf.StringValue size_in_bytes = 4 [(.wix.api.format) = DECIMAL_VALUE];
+    // Archive filename.
+    google.protobuf.StringValue filename = 5;
+}
+
+
+
+
+// Deprecated - Copy this message into your service, do not reference it
+message MediaItem {
+    option deprecated = true;
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "image"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "video"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "document"
+    };
+    oneof media {
+        Image image = 1; // WixMedia image
+        Video video = 2; // WixMedia video
+        Document document = 3; // WixMedia document
+    }
+}
+
+message FocalPoint {
+    // X-coordinate of the focal point.
+    double x = 1;
+    // Y-coordinate of the focal point.
+    double y = 2;
+    // crop by height
+    google.protobuf.Int32Value height = 3;
+    // crop by width
+    google.protobuf.Int32Value width = 4;
+}

package/@wix/ambassador-infra-asyncjobs-v1-async-job/src/main/proto/wix/common/money.proto

@@ -0,0 +1,32 @@
+syntax = "proto3";
+
+package wix.common;
+
+option java_multiple_files = true;
+option java_package = "com.wix.common";
+
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "google/protobuf/wrappers.proto";
+
+// Common money formats.
+
+// Money.
+// Default format to use. Sufficiently compliant with majority of standards: w3c, ISO 4217, ISO 20022, ISO 8583:2003.
+message Money {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "value"
+        field: "currency"
+    };
+    // For special cases, one may use just a value without currency to represent money. But:
+    // - money MUST be a decimal string, as described below
+    // - currency MUST be provided somewhere at the top level of your object
+
+    // Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). Optionally, a single (-), to indicate that the amount is negative.
+    string value = 1 [(.wix.api.format) = DECIMAL_VALUE];
+    // Currency code. Must be valid ISO 4217 currency code (e.g., USD).
+    string currency = 2 [(.wix.api.format) = CURRENCY];
+    // Monetary amount. Decimal string in local format (e.g., 1 000,30). Optionally, a single (-), to indicate that the amount is negative.
+    google.protobuf.StringValue formatted_value = 3;
+
+}

package/@wix/ambassador-infra-asyncjobs-v1-async-job/src/main/proto/wix/common/pageurl.proto

@@ -0,0 +1,32 @@
+syntax = "proto3";
+
+package wix.common;
+
+option java_multiple_files = true;
+option java_outer_classname = "PageUrlProto";
+option java_package = "com.wix.common";
+
+import "wix/api/annotations.proto";
+import "google/protobuf/wrappers.proto";
+
+message PageUrl {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "base"
+        field: "path"
+    };
+    // 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 relative path for the page within the site. For example, `/product-page/a-product`.
+    string path = 2;
+}
+
+message PageUrlV2 {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "relative_path"
+        field: "url"
+    };
+    // The relative path for the page within the site. For example, `/product-page/a-product`.
+    string relative_path = 1;
+    // 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/stores/catalog/location/v3/upstream → ambassador-infra-asyncjobs-v1-async-job/src/main/proto}/wix/common/paging.proto

@@ -1,16 +1,15 @@
 syntax = "proto3";
 
-package wix.stores.catalog.location.v3.upstream.wix.common;
+package 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.wix.stores.catalog.location.v3.upstream.wix.common";
+option java_package = "com.wix.common";
 
 message Paging {
-    option (.wix.api.decomposite_of) = "wix.common.Paging";
     option (.wix.api.decomposition_minimum_fields) = {
         field: "limit"
         field: "offset"
@@ -22,25 +21,24 @@ message Paging {
 }
 
 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.
+
+    // 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 [(.wix.api.maxLength) = 16000];;
+    google.protobuf.StringValue cursor = 2 [(.wix.api.maxLength) = 16000];
 }
 
 message PagingMetadata {
-    option (.wix.api.decomposite_of) = "wix.common.PagingMetadata";
     option (.wix.api.decomposition_minimum_fields) = {
         field: "count"
         field: "offset"
@@ -53,17 +51,13 @@ message PagingMetadata {
     google.protobuf.Int32Value total = 3;
     // Flag that indicates the server failed to calculate the `total` field.
     google.protobuf.BoolValue too_many_to_count = 4;
-    /*
-    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.
-    */
+    // 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"
@@ -82,12 +76,9 @@ message PagingMetadataV2 {
     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;
-    /*
-    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.
-    */
+    // 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];
 }
 
@@ -95,11 +86,14 @@ message PagingMetadataV2 {
 // 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.
+    option (.wix.api.decomposite_of) = "wix.common.PagingMetadataV2";
+
+    // Number of items returned in current page.
     google.protobuf.Int32Value count = 1;
-    // Offset that was requested.
+
+    // Cursor strings that point to the next page, previous page, or both.
     Cursors cursors = 2;
+
     /*
     Whether there are more pages to retrieve following the current page.
 
@@ -107,15 +101,21 @@ message CursorPagingMetadata {
     + `false`: This is the last page.
     */
     google.protobuf.BoolValue has_next = 3;
+
+    // Total number of items matching the filter.
+    // Available only on the first page of *Search* results, not included in *Query* or *List* results.
+    // If the Search results span multiple pages, the value of `total` will exceed the number of items returned on the first page.
+    google.protobuf.Int32Value total = 4 [(.wix.api.field_exposure) = PRIVATE];
 }
 
 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.
+
+    // Cursor string pointing to the next page in the list of results.
     google.protobuf.StringValue next = 1 [(.wix.api.maxLength) = 16000];
-    // Cursor pointing to previous page in the list of results.
+
+    // Cursor pointing to the previous page in the list of results.
     google.protobuf.StringValue prev = 2 [(.wix.api.maxLength) = 16000];
 }