@wix/bex-utils 1.28.0

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

@@ -0,0 +1,259 @@
+syntax = "proto3";
+
+package wix.catalog.api.v1;
+
+import "google/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+import "wix/api/permissions.proto";
+import "wix/catalog/api/v1/query.proto";
+import "wix/catalog/api/v1/productOption.proto";
+import "wix/catalog/api/v1/ribbon.proto";
+
+option java_package = "com.wix.ecommerce.catalog.api.v1";
+
+service CatalogReadAPINotReviewed {
+    option (wix.api.service_exposure) = PRIVATE;
+
+    //Returns up to 100 options
+    rpc ListOptions (ListOptionsRequest) returns (ListOptionsResponse) {
+        option (google.api.http) = {
+            get: "/v1/options"
+        };
+        option (wix.api.maturity) = ALPHA;
+
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+    }
+
+    rpc ListRibbons (ListRibbonsRequest) returns (ListRibbonsResponse) {
+        option (google.api.http) = {
+            get: "/v1/ribbons"
+        };
+        option (wix.api.maturity) = ALPHA;
+
+        option (wix.api.permission).name = "WIX_STORES.READ_PRODUCTS";
+    }
+}
+
+message ListOptionsRequest {
+    Paging paging = 1;
+}
+
+message ListOptionsResponse {
+    //Options in store that satisfy request
+    repeated ProductOptionInBank options = 1;
+    PagingMetadata metadata = 2;
+    //Number of all options in store that satisfy request
+    int32 total_results = 3;
+}
+
+message ListRibbonsRequest {
+    Paging paging = 2;
+}
+
+message ListRibbonsResponse {
+    repeated RibbonInBank ribbons = 1;
+    PagingMetadata metadata = 2;
+    //Number of all ribbons in store that satisfy request
+    int32 total_results = 3;
+}
+
+service CatalogWriteAPINotReviewed {
+    option (wix.api.service_exposure) = PRIVATE;
+
+    //delete all additional info sections from product
+    // Need to add full CRUD
+    rpc DeleteProductAdditionalInfoSections (DeleteProductAdditionalInfoSectionsRequest) returns (DeleteProductAdditionalInfoSectionsResponse) {
+        option (wix.api.required) = "DeleteProductAdditionalInfoSectionsRequest.id";
+        option (google.api.http) = {
+            delete: "/v1/products/{id}/additionalInfoSections"
+        };
+        option (wix.api.maturity) = ALPHA;
+
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    //delete all custom text fields from product
+    // Need to add full CRUD
+    rpc DeleteProductCustomTextFields (DeleteProductCustomTextFieldsRequest) returns (DeleteProductCustomTextFieldsResponse) {
+        option (wix.api.required) = "DeleteProductCustomTextFieldsRequest.id";
+        option (google.api.http) = {
+            delete: "/v1/products/{id}/customTextFields"
+        };
+        option (wix.api.maturity) = ALPHA;
+
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    // update or delete media of collection
+    // Change API to be like product media
+    rpc UpdateCollectionMedia (UpdateCollectionMediaRequest) returns (UpdateCollectionMediaResponse) {
+        option (wix.api.required) = "UpdateCollectionMediaRequest.id";
+        option (wix.api.required) = "UpdateCollectionMediaRequest.callback_url";
+        option (google.api.http) = {
+            patch: "/v1/collections/{id}/media"
+        };
+        option (wix.api.maturity) = ALPHA;
+
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    // Change API to be like product media
+    rpc DeleteCollectionMedia (DeleteCollectionMediaRequest) returns (DeleteCollectionMediaResponse) {
+        option (wix.api.required) = "DeleteCollectionMediaRequest.id";
+        option (google.api.http) = {
+            delete: "/v1/collections/{id}/media"
+        };
+        option (wix.api.maturity) = ALPHA;
+
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    //rename option across all store
+    rpc RenameOption (RenameOptionRequest) returns (RenameOptionResponse) {
+        option (wix.api.required) = "RenameOptionRequest.id";
+        option (google.api.http) = {
+            post: "/v1/options/{id}/rename"
+        };
+        option (wix.api.maturity) = ALPHA;
+
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    //rename ribbon across all store
+    rpc RenameRibbon (RenameRibbonRequest) returns (RenameRibbonResponse) {
+        option (wix.api.required) = "RenameRibbonRequest.id";
+        option (google.api.http) = {
+            post: "/v1/ribbons/{id}/rename"
+        };
+        option (wix.api.maturity) = ALPHA;
+
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    //delete ribbon from all products in store
+    rpc DeleteRibbon (DeleteRibbonRequest) returns (DeleteRibbonResponse) {
+        option (wix.api.required) = "DeleteRibbonRequest.id";
+        option (google.api.http) = {
+            delete: "/v1/ribbons/{id}"
+        };
+        option (wix.api.maturity) = ALPHA;
+
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+
+    rpc SetProductCustomData (SetProductCustomDataRequest) returns (SetProductCustomDataResponse) {
+        option (wix.api.required) = "SetProductCustomDataRequest.id";
+        option (google.api.http) = {
+            patch: "/v1/products/{id}/custom_data"
+        };
+
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    rpc RemoveProductCustomData (RemoveProductCustomDataRequest) returns (RemoveProductCustomDataResponse) {
+        option (wix.api.required) = "RemoveProductCustomDataRequest.id";
+        option (google.api.http) = {
+            delete: "/v1/products/{id}/custom_data/{key}"
+        };
+
+        option (wix.api.permission).name = "WIX_STORES.MODIFY_PRODUCTS";
+    }
+
+    // Need to add full CRUD for options
+}
+
+message UpdateCollectionMediaRequest {
+    //id of collection
+    string id = 1;
+    //new media, don't send it if you want to remove media
+    //MediaDataForWrite media = 2;
+    //callback URL
+    string callback_url = 3;
+}
+
+message UpdateCollectionMediaResponse {
+}
+
+message DeleteCollectionMediaRequest {
+    //id of collection
+    string id = 1;
+}
+
+message DeleteCollectionMediaResponse {
+}
+
+message SetProductCustomDataRequest {
+    // id of product
+    string id = 1;
+    // Data to set
+    map<string, string> custom_data = 2;
+}
+
+message SetProductCustomDataResponse {
+
+}
+
+message RemoveProductCustomDataRequest {
+    // id of product
+    string id = 1;
+    // Key to remove
+    string key = 2;
+}
+
+message RemoveProductCustomDataResponse {
+
+}
+
+message DeleteProductAdditionalInfoSectionsRequest {
+    //id of product
+    string id = 1;
+}
+
+message DeleteProductAdditionalInfoSectionsResponse {
+}
+
+message DeleteProductRibbonsRequest {
+    //id of product
+    string id = 1;
+}
+
+message DeleteProductRibbonsResponse {
+}
+
+message DeleteProductCustomTextFieldsRequest {
+    //id of product
+    string id = 1;
+}
+
+message DeleteProductCustomTextFieldsResponse {
+}
+
+message RenameOptionRequest {
+    //id of option
+    string id = 1;
+    //new option name
+    string name = 3 [(wix.api.maxLength)=50];
+}
+
+message RenameOptionResponse {
+}
+
+message RenameRibbonRequest {
+    //id of ribbon
+    string id = 1;
+    // The text that will appear on the ribbon
+    string text = 2[(wix.api.maxLength)=30];
+}
+
+message RenameRibbonResponse {
+}
+
+message DeleteRibbonRequest {
+    //id of ribbon
+    string id = 1;
+}
+
+message DeleteRibbonResponse {
+}

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

@@ -0,0 +1,8 @@
+syntax = "proto3";
+
+package wix.catalog.api.v1;
+
+message AllowedProductsCountLimitExceededErrorData {
+    // Total number of products
+    int32 total_count = 1;
+}

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

@@ -0,0 +1,39 @@
+syntax = "proto3";
+
+package wix.catalog.api.v1;
+
+import "wix/catalog/api/v1/media.proto";
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/entity.proto";
+import "advanced-seo-api.proto";
+
+option java_package = "com.wix.ecommerce.catalog.api.v1";
+
+message Collection {
+    option (wix.api.entity) = {
+        fqdn: "wix.stores.catalog.v1.collection"
+        segment: USERS
+        appendix_files: {
+            type: AUTO_VELO
+            path: "appendices/velo/collection"
+        };
+    };
+    // Collection ID (generated automatically by the catalog).
+    google.protobuf.StringValue id = 1 [(wix.api.minLength) = 35, (wix.api.maxLength) = 36, (wix.api.readOnly) = true];
+    // Collection name.
+    google.protobuf.StringValue name = 2 [(wix.api.minLength) = 1, (wix.api.maxLength) = 50];
+    // Media items (images, videos etc) associated with this collection. Read only.
+    Media media = 3 [(wix.api.readOnly) = true];
+    // Number of products in the collection. Read only.
+    int32 number_of_products = 4 [(wix.api.readOnly) = true];
+    // Collection description.
+    google.protobuf.StringValue description = 5 [(wix.api.minLength) = 0, (wix.api.maxLength) = 600];
+    // Collection slug.
+    google.protobuf.StringValue slug = 6 [(wix.api.minLength) = 1, (wix.api.maxLength) = 100];
+    // Collection visibility. Only impacts dynamic pages, no impact on static pages. Default: `true`.
+    google.protobuf.BoolValue visible = 7;
+    // Custom SEO data for the collection.
+    com.wixpress.advanced.seo.SeoSchema seo_schema = 8 [(.wix.api.field_exposure) = INTERNAL];
+}

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

@@ -0,0 +1,22 @@
+syntax = "proto3";
+
+package wix.catalog.api.v1;
+
+import "wix/api/validations.proto";
+import "google/protobuf/wrappers.proto";
+
+option java_package = "com.wix.ecommerce.catalog.api.v1";
+
+message CostAndProfitData {
+    // Item cost.
+    google.protobuf.DoubleValue item_cost = 1 [(wix.api.min) = 0, (wix.api.max) = 999999999.99];
+    // Item cost formatted with currency symbol.
+    string formatted_item_cost = 2 [(wix.api.readOnly) = true];
+    // Profit. Calculated by reducing `cost` from `discounted_price`.
+    double profit = 3 [(wix.api.readOnly) = true, (wix.api.min) = 0, (wix.api.max) = 999999999.99];
+    // Profit formatted with currency symbol.
+    string formatted_profit = 4 [(wix.api.readOnly) = true];
+    // Profit Margin. Calculated by dividing `profit` by `discounted_price`.
+    // The result is rounded to 4 decimal places.
+    double profit_margin = 5 [(wix.api.readOnly) = true, (wix.api.min) = 0, (wix.api.max) = 1];
+}

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

@@ -0,0 +1,104 @@
+syntax = "proto3";
+
+package wix.catalog.api.v1.event;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/catalog/api/v1/costAndProfit.proto";
+import "wix/catalog/api/v1/media.proto";
+import "wix/catalog/api/v1/pageUrl.proto";
+import "wix/catalog/api/v1/price.proto";
+import "wix/api/annotations.proto";
+
+option java_package = "com.wix.ecommerce.catalog.api.v1";
+
+message ProductCreated {
+    // Product ID (generated automatically by the catalog).
+    string product_id = 1;
+    // Product name.
+    string name = 2;
+    // Product price.
+    PriceData price = 3;
+    // Whether the product is visible to customers.
+    bool visible = 4;
+    // Media items (images, videos, etc.) associated with this product.
+    Media media = 5;
+    // Product stock keeping unit (SKU). If variants are being managed, this will be empty.
+    string sku = 6;
+    // Product page URL for this product (generated automatically by the server).
+    PageUrl product_page_url = 7;
+    // Product brand.
+    google.protobuf.StringValue brand = 8;
+    // Cost and profit data
+    CostAndProfitData cost_and_profit_data = 9;
+}
+
+message PriceChanged {
+    string product_id = 1;
+    // Price before change.
+    PriceDataV2 old_price = 3;
+    // Price after change.
+    PriceDataV2 new_price = 4;
+}
+
+message ProductChanged {
+    // Product ID.
+    string product_id = 1;
+    // List of product fields that were changed.
+    repeated string changed_fields = 2;
+    // product revision
+    int64 revision = 3 [(.wix.api.field_exposure) = INTERNAL];;
+}
+
+message ProductDeleted {
+    // ID of the product that was deleted.
+    string product_id = 1;
+}
+
+message VariantsChanged {
+    // Product ID.
+    string product_id = 1;
+    // List of variants that were changed. 
+    repeated VariantChanged variants = 2;
+}
+
+message VariantChanged {
+    // Variant ID.
+    string variant_id = 1;
+    map<string, string> choices = 2;
+    // List of variant fields that were changed.
+    repeated string changed_fields = 3;
+}
+
+message CollectionCreated {
+    // Collection ID (generated automatically by the catalog).
+    string collection_Id = 1;
+    // Collection name.
+    string name = 2;
+    // Media items (images, videos, etc.) associated with this collection.
+    Media media = 3;
+    // Collection slug
+    string slug = 4;
+    // Collection visible status
+    bool visible = 5;
+}
+
+message CollectionChanged {
+    // Collection ID (generated automatically by the catalog).
+    string collection_Id = 1;
+    // List of collection fields that were changed.
+    repeated string changed_fields = 2;
+}
+
+message CollectionDeleted {
+    // ID of the collection that was deleted.
+    string collection_Id = 1;
+}
+
+//internal
+message CustomFieldChanged {
+    string product_id = 1;
+    string field_name = 2;
+    google.protobuf.Value old_value = 3;
+    google.protobuf.Value new_value = 4;
+}

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

@@ -0,0 +1,89 @@
+syntax = "proto3";
+
+package wix.catalog.api.v1;
+
+import "wix/api/validations.proto";
+import "google/protobuf/wrappers.proto";
+
+message Media {
+    // Primary media (image, video etc) associated with this product.
+    MediaItem main_media = 1;
+    // Media (images, videos etc) associated with this product.
+    repeated MediaItem items = 2;
+}
+
+message MediaItem {
+    // Media item thumbnail details.
+    MediaItemUrlAndSize thumbnail = 1;
+    // Media item type (image, video, etc.).
+    MediaItemType media_type = 2;
+    // Media item title.
+    string title = 3;
+    oneof item {
+        // Image data (URL, size).
+        MediaItemUrlAndSize image = 4;
+        // Video data (URL, size).
+        MediaItemVideo video = 5;
+    }
+    // Media ID (for example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`).
+    string id = 6;
+}
+
+message MediaItemUrlAndSize {
+    // Media item URL.
+    string url = 1 [(wix.api.format) = URI];
+    // Media item width.
+    int32 width = 2 [(wix.api.min) = 0];
+    // Media item height.
+    int32 height = 3 [(wix.api.min) = 0];
+    // Media format (mp4, png, etc.).
+    google.protobuf.StringValue format = 4;
+    // Alt text. This text will be shown in case the image is not available.
+    google.protobuf.StringValue alt_text = 5;
+}
+
+message MediaItemVideo {
+    // Data (URL, size) about each resolution for which this video is available.
+    repeated MediaItemUrlAndSize files = 1;
+    // ID of an image taken from the video. Used primarily for Wix Search indexing. For example, `"nsplsh_306d666a123a4a74306459~mv2_d_4517_2992_s_4_2.jpg"`.
+    string still_frame_media_id = 2;
+}
+
+enum MediaItemType {
+    unspecified_media_item_type = 0;
+    image = 1;
+    video = 2;
+    audio = 3;
+    document = 4;
+    zip = 5;
+}
+
+message MediaDataForWrite {
+    message OptionAndChoice {
+        // Option to add the media to.
+        string option = 1 [(wix.api.minLength) = 1, (wix.api.maxLength) = 50];
+        // Choice to add the media to.
+        string choice = 2 [(wix.api.minLength) = 1, (wix.api.maxLength) = 50];
+    }
+
+    oneof media_source {
+        // 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];
+    }
+
+    // Assign this media item to a specific product choice.
+    // Note that you may set media items for choices under only one option (e.g., if Colors blue, green, and red have media items, Sizes S, M, and L can't have media items assigned to them).
+    // You may clear existing media from choices with the [Remove Product Media From Choices](/catalog/products/remove-product-media-from-choices).
+    OptionAndChoice choice = 3;
+}
+
+message MediaAssignmentToChoice {
+    // Option name.
+    string option = 1 [(wix.api.minLength) = 1, (wix.api.maxLength) = 50];
+    // Choice name.
+    string choice = 2 [(wix.api.minLength) = 1, (wix.api.maxLength) = 50];
+    // Media IDs (available via the Query Product endpoint).
+    repeated string media_ids = 3 [(wix.api.maxSize) = 50];
+}

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

@@ -0,0 +1,10 @@
+syntax = "proto3";
+
+package wix.catalog.api.v1;
+
+message PageUrl {
+    // Base URL. For premium sites, this is the domain. For free sites, this is the site URL (e.g mysite.wixsite.com/mysite).
+    string base = 1;
+    // Path to the product page - e.g /product-page/a-product.
+    string path = 2;
+}

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

@@ -0,0 +1,65 @@
+syntax = "proto3";
+
+package wix.catalog.api.v1;
+
+import "wix/api/validations.proto";
+import "google/protobuf/wrappers.proto";
+
+option java_package = "com.wix.ecommerce.catalog.api.v1";
+
+message PriceData {
+    // Product price currency
+    string currency = 1 [(wix.api.readOnly) = true];
+    // Product price
+    google.protobuf.DoubleValue price = 2 [(wix.api.min) = 0, (wix.api.max) = 999999999.99];
+    // Discounted product price (if no discounted price is set, the product price is returned)
+    double discounted_price = 3 [(wix.api.readOnly) = true];
+    // The product price and discounted price, formatted with the currency
+    FormattedPrice formatted = 4 [(wix.api.readOnly) = true];
+    // Price per unit
+    google.protobuf.DoubleValue price_per_unit = 5 [(wix.api.readOnly) = true];
+}
+
+message PriceDataV2 {
+    // Product price currency
+    Currency currency = 1 [(wix.api.readOnly) = true];
+    // Product price
+    double price = 2 [(wix.api.min) = 0, (wix.api.max) = 999999999.99];
+    // Discounted product price (if no discounted price is set, the product price is returned)
+    double discounted_price = 3 [(wix.api.readOnly) = true];
+    // The product price and discounted price, formatted with the currency
+    FormattedPrice formatted = 4 [(wix.api.readOnly) = true];
+}
+
+message FormattedPrice {
+    // Product price formatted with the currency
+    string price = 1;
+    // Discounted product price formatted with the currency (if no discounted price is set, the product formatted price is returned)
+    string discounted_price = 2;
+    // Price per unit
+    google.protobuf.StringValue price_per_unit = 3 [(wix.api.readOnly) = true];
+}
+
+message Discount {
+    enum DiscountType {
+        UNDEFINED = 0;
+        // No discount
+        NONE = 1;
+        AMOUNT = 2;
+        PERCENT = 3;
+    }
+
+    /* 
+    Discount type:  
+    + `"AMOUNT"`  
+    + `"PERCENT"`
+    */
+    DiscountType type = 1;
+    // Discount value
+    double value = 2;
+}
+
+message Currency {
+    string currency = 1;
+    string symbol = 2;
+}