@wix/bex-utils 1.28.0

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

@@ -0,0 +1,176 @@
+syntax = "proto3";
+
+package wix.catalog.api.v1;
+
+import "wix/api/validations.proto";
+import "wix/api/entity.proto";
+import "wix/api/annotations.proto";
+import "wix/catalog/api/v1/media.proto";
+import "wix/catalog/api/v1/productOption.proto";
+import "wix/catalog/api/v1/price.proto";
+import "wix/catalog/api/v1/costAndProfit.proto";
+import "wix/catalog/api/v1/pageUrl.proto";
+import "wix/catalog/api/v1/variant.proto";
+import "google/protobuf/wrappers.proto";
+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";
+
+
+option java_package = "com.wix.ecommerce.catalog.api.v1";
+
+message Product {
+    option (wix.api.entity) = {
+        fqdn: "wix.stores.catalog.v1.product"
+        segment: USERS
+        appendix_files: {
+            type: AUTO_VELO
+            path: "appendices/velo/product"
+        };
+    };
+    // Product ID (generated automatically by the catalog).
+    string id = 1 [(wix.api.readOnly) = true];
+    /*
+    Product name.
+
+    Min: 1 character  
+    Max: 80 characters
+    */
+    google.protobuf.StringValue name = 2 [(wix.api.minLength) = 1, (wix.api.maxLength) = 80];
+    // A friendly URL name (generated automatically by the catalog when a product is created), can be updated.
+    string slug = 3 [(wix.api.maxLength) = 100];
+    // Whether the product is visible to site visitors.
+    google.protobuf.BoolValue visible = 4;
+    // Currently, only creating physical products ( `"productType": "physical"` ) is supported via the API.
+    ProductType product_type = 5;
+    // Product description. Accepts [rich text](https://dev.wix.com/api/rest/wix-stores/rich-text).
+    google.protobuf.StringValue description = 6 [(wix.api.maxLength) = 8000];
+    // Stock keeping unit. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, SKUs will be set per variant, and this field will be empty.
+    google.protobuf.StringValue sku = 7 [(wix.api.maxLength) = 40];
+    // Product weight. If [variant management](https://support.wix.com/en/article/wix-stores-adding-and-customizing-product-options#setting-different-prices-for-variants) is enabled, weight will be set per variant, and this field will be empty.
+    google.protobuf.DoubleValue weight = 8 [(wix.api.min) = 0, (wix.api.max) = 999999999.99];
+    // Product weight range. The minimum and maximum weights of all the variants.
+    com.wix.ecommerce.catalog_spi.api.v1.NumericPropertyRange weight_range = 32 [(wix.api.readOnly) = true];
+    // Product inventory status (in future this will be writable via Inventory API).
+    Stock stock = 9 [(wix.api.readOnly) = true];
+    // Deprecated (use `priceData` instead).
+    PriceData price = 10 [(wix.api.readOnly) = true, deprecated = true];
+    // Price data.
+    PriceData priceData = 22;
+    // Price data, converted to the currency specified in request header.
+    PriceData converted_price_data = 25 [(wix.api.readOnly) = true];
+    // Product price range. The minimum and maximum prices of all the variants.
+    com.wix.ecommerce.catalog_spi.api.v1.NumericPropertyRange price_range = 31 [(wix.api.readOnly) = true];
+    // Cost and profit data.
+    CostAndProfitData cost_and_profit_data = 30;
+    // Product cost range. The minimum and maximum costs of all the variants.
+    com.wix.ecommerce.catalog_spi.api.v1.NumericPropertyRange cost_range = 33 [(wix.api.readOnly) = true];
+    // Price per unit data.
+    PricePerUnitData price_per_unit_data = 26;
+    // Additional text that the store owner can assign to the product (e.g. shipping details, refund policy, etc.).
+    repeated AdditionalInfoSection additional_info_sections = 11;
+    // Deprecated (use `ribbon` instead).
+    repeated Ribbon ribbons = 12 [(wix.api.readOnly) = true, deprecated = true];
+    // Media items (images, videos etc) associated with this product (writable via [Add Product Media](https://dev.wix.com/api/rest/wix-stores/catalog/products/add-product-media) endpoint).
+    Media media = 13 [(wix.api.readOnly) = true];
+    // Text box for the customer to add a message to their order (e.g., customization request). Currently writable only from the UI.
+    repeated CustomTextField custom_text_fields = 14 [(wix.api.readOnly) = true];
+    // Whether variants are being managed for this product - enables unique SKU, price and weight per variant. Also affects inventory data.
+    google.protobuf.BoolValue manage_variants = 15;
+    // Options for this product.
+    repeated ProductOption product_options = 16 [(wix.api.maxSize) = 6];
+    // Product page URL for this product (generated automatically by the server).
+    PageUrl product_page_url = 17 [(wix.api.readOnly) = true];
+    // Product’s unique numeric ID (assigned in ascending order).
+    // Primarily used for sorting and filtering when crawling all products.
+    uint64 numericId = 18 [(wix.api.readOnly) = true];
+    // Inventory item ID - ID referencing the inventory system.
+    string inventory_item_id = 19 [(wix.api.readOnly) = true, (.wix.api.referenced_entity) = "wix.stores.v2.inventory"];
+    // Discount deducted from the product's original price.
+    Discount discount = 20;
+    // A list of all collection IDs that this product is included in (writable via the Catalog > Collection APIs).
+    repeated string collection_ids = 21 [(wix.api.readOnly) = true];
+    // Product variants, will be provided if the the request was sent with the includeVariants flag.
+    repeated Variant variants = 23 [(wix.api.readOnly) = true];
+    // Date and time the product was last updated.
+    google.protobuf.Timestamp last_updated = 24 [(wix.api.readOnly) = true];
+    // Date and time the product was created.
+    google.protobuf.Timestamp created_date = 34 [(wix.api.readOnly) = true];
+    // Custom SEO data for the product.
+    com.wixpress.advanced.seo.SeoSchema seo_data = 27;
+    // Product ribbon. Used to highlight relevant information about a product. For example, "Sale", "New Arrival", "Sold Out".
+    google.protobuf.StringValue ribbon = 28 [(wix.api.maxLength) = 30];
+    // Product brand. Including a brand name can help improve site and product [visibility on search engines](https://support.wix.com/en/article/adding-brand-names-to-boost-product-page-seo-in-wix-stores).
+    google.protobuf.StringValue brand = 29 [(wix.api.minLength) = 1, (wix.api.maxLength) = 50];
+    //tax group id
+    google.protobuf.StringValue tax_group_id = 35 [(wix.api.readOnly) = true, (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];
+}
+
+enum ProductType {
+    unspecified_product_type = 0;
+    physical = 1;
+    digital = 2;
+}
+
+enum WeightUnit {
+    unspecified_weight_unit = 0;
+    KG = 1;
+    LB = 2;
+}
+
+message Ribbon {
+    // Ribbon text
+    string text = 1 [(wix.api.maxLength) = 30];
+}
+
+message Stock {
+    enum InventoryStatus {
+        IN_STOCK = 0;
+        OUT_OF_STOCK = 1;
+        PARTIALLY_OUT_OF_STOCK = 2;
+    }
+
+    // Whether inventory is being tracked
+    bool track_inventory = 1;
+    // Quantity currently left in inventory
+    google.protobuf.Int32Value quantity = 2 [(wix.api.min) = 0, (wix.api.max) = 99999];
+    // Whether the product is currently in stock (relevant only when tracking manually)
+    // Deprecated (use `inventoryStatus` instead)
+    bool in_stock = 3 [deprecated = true];
+    // The current status of the inventory
+    // + `IN_STOCK` - In stock
+    // + `OUT_OF_STOCK` - Not in stock
+    // + `PARTIALLY_OUT_OF_STOCK` - Some of the variants are not in stock
+    InventoryStatus inventory_status = 4;
+}
+
+message AdditionalInfoSection {
+    // Product info section title
+    string title = 1 [(wix.api.maxLength) = 50];
+    // Product info section description
+    string description = 2 [(wix.api.maxLength) = 16000];
+}
+
+
+message CustomTextField {
+    // Text box title
+    string title = 1 [(wix.api.maxLength) = 100];
+    // Text box input max length
+    int32 max_length = 2 [(wix.api.max) = 500];
+    // Whether this text box is mandatory
+    bool mandatory = 3;
+}
+
+message PricePerUnitData {
+    // Total quantity
+    double total_quantity = 1 [(wix.api.min) = 0.01, (wix.api.max) = 999999999.99];
+    // Total measurement unit
+    com.wix.ecommerce.commons.api.MeasurementUnitEnum.MeasurementUnit total_measurement_unit = 2;
+    // Base quantity
+    double base_quantity = 3 [(wix.api.min) = 0.01, (wix.api.max) = 999999999.99];
+    // Base measurement unit
+    com.wix.ecommerce.commons.api.MeasurementUnitEnum.MeasurementUnit base_measurement_unit = 4;
+}

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

@@ -0,0 +1,56 @@
+syntax = "proto3";
+
+package wix.catalog.api.v1;
+
+import "wix/api/validations.proto";
+import "wix/catalog/api/v1/media.proto";
+
+option java_package = "com.wix.ecommerce.catalog.api.v1";
+
+message ProductOption {
+    // Option type - color or other(drop down)
+    OptionType optionType = 1 [(wix.api.readOnly) = true];
+    // Option name.
+    string name = 2 [(wix.api.minLength) = 1, (wix.api.maxLength) = 50];
+    // Choices available for this option.
+    repeated Choice choices = 3 [(wix.api.minSize) = 1, (wix.api.maxSize) = 100];
+}
+
+enum OptionType {
+    unspecified_option_type = 0;
+    drop_down = 1;
+    color = 2;
+}
+
+message Choice {
+    // Choice value.
+    string value = 1 [(wix.api.minLength) = 1, (wix.api.maxLength) = 50];
+    // Choice description.
+    string description = 2 [(wix.api.minLength) = 1, (wix.api.maxLength) = 50];
+    // Media items (images, videos) associated with this choice
+    Media media = 3 [(wix.api.readOnly) = true];
+    // Based on the customer’s choices, which (if any) variants that include the selected choices are in stock
+    bool in_stock = 4 [(wix.api.readOnly) = true];
+    // Based on the customer’s choices, which (if any) variants that include the selected choices are visible
+    bool visible = 5 [(wix.api.readOnly) = true];
+}
+
+message ProductOptionInBank {
+    //Option ID 
+    string id = 1;
+    // Option type - color or other(drop down)
+    OptionType optionType = 2;
+    // Option name (e.g., color, size)
+    string name = 3;
+    // Choices available for this option
+    repeated ChoiceInBank choices = 4;
+    //Number of products that have this option (option can be removed only if response is 0)
+    int32 number_of_products = 5;
+}
+
+message ChoiceInBank {
+    // Color hex value or choice name
+    string value = 1;
+    // Choice name
+    string description = 2;
+}

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

@@ -0,0 +1,45 @@
+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 Query {
+    Paging paging = 1;
+    // Filter string
+    google.protobuf.StringValue filter = 2;
+    // Sort string
+    google.protobuf.StringValue sort = 3;
+}
+
+message QueryWithBigPageLimit {
+    PagingWithBigLimit paging = 1;
+    // Filter string
+    google.protobuf.StringValue filter = 2;
+    // Sort string
+    google.protobuf.StringValue sort = 3;
+}
+
+message Paging {
+    // Amount of items to load per page
+    google.protobuf.Int32Value limit = 1 [(wix.api.min) = 0, (wix.api.max) = 100];
+    // Number of items to skip in the display (relevant for all pages after the first)
+    google.protobuf.Int32Value offset = 2 [(wix.api.min) = 0];
+}
+
+message PagingMetadata {
+    // Amount of items to load per page
+    int32 items = 1;
+    // Number of items to skip in the display (relevant for all pages after the first)
+    int32 offset = 2;
+}
+
+message PagingWithBigLimit {
+    // Amount of items to load per page
+    google.protobuf.Int32Value limit = 1 [(wix.api.min) = 0, (wix.api.max) = 600];
+    // Number of items to skip in the display (relevant for all pages after the first)
+    google.protobuf.Int32Value offset = 2 [(wix.api.min) = 0];
+}

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

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+package wix.catalog.api.v1;
+
+option java_package = "com.wix.ecommerce.catalog.api.v1";
+
+
+message RibbonInBank {
+    // Ribbon ID
+    string id = 1;
+    // Ribbon text
+    string text = 2;
+    //Number of products with this ribbon
+    int32 number_of_products = 3;
+}

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

@@ -0,0 +1,118 @@
+syntax = "proto3";
+
+package wix.catalog.api.v1;
+
+import "wix/catalog/api/v1/price.proto";
+import "wix/catalog/api/v1/costAndProfit.proto";
+import "wix/api/validations.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "google/protobuf/struct.proto";
+import "com/wix/ecommerce/commons/api/platformMedia.proto";
+import "wix/inventory/api/v1/preOrderInfo.proto";
+
+message VariantData {
+    // Variant price.
+    PriceData price = 1;
+    //Variant price data converted to currency provided in header.
+    PriceData converted_price_data = 7 [(wix.api.readOnly) = true];
+    // Variant weight.
+    google.protobuf.DoubleValue weight = 2;
+    // Variant SKU (stock keeping unit).
+    string sku = 3;
+    // Quantity currently in inventory (relevant only when tracking by inventory).
+    google.protobuf.Int32Value quantity = 4;
+    // Whether the product is currently in stock (relevant only when tracking manually).
+    bool in_stock = 5;
+    // Whether the variant is visible to customers.
+    bool visible = 6;
+    // Variant ID.
+    string variant_id = 8 [(wix.api.format) = GUID, (wix.api.field_exposure) = PRIVATE];
+}
+
+message VariantDataWithNoStock {
+    // Variant price.
+    PriceData priceData = 1;
+    // Variant price data, converted to currency requested in header.
+    PriceData converted_price_data = 6 [(wix.api.readOnly) = true];
+    // Cost and profit data.
+    CostAndProfitData cost_and_profit_data = 7;
+    // Variant weight.
+    double weight = 2;
+    // Variant SKU (stock keeping unit).
+    string sku = 3;
+    // Whether the variant is visible to customers.
+    bool visible = 5;
+}
+
+message Variant {
+    // Requested Variant ID
+    string id = 1 [(wix.api.format) = GUID];
+    // Specific choices within a selection, as option-choice key-value pairs
+    map<string, string> choices = 2;
+    VariantDataWithNoStock variant = 3;
+    // Variant inventory status.
+    VariantStock stock = 4 [(wix.api.readOnly) = true];
+}
+
+message VariantOverride {
+    // The specific choices available or chosen from within a selection (e.g., choosing the red Selection triggers the red Choice). You may specify all the relevant choices for a specific variant, or only some of the options, which will return all corresponding variants (Not relevant when passing variant IDs)
+    map<string, string> choices = 1;
+    // List of variant IDs
+    // (Not relevant when passing choices)
+    repeated string variantIds = 2;
+    // Variant price
+    google.protobuf.DoubleValue price = 3 [(wix.api.min) = 0, (wix.api.max) = 999999999.99];
+    // Variant cost of goods
+    google.protobuf.DoubleValue cost = 7 [(wix.api.min) = 0, (wix.api.max) = 999999999.99];
+    // Variant weight
+    google.protobuf.DoubleValue weight = 4 [(wix.api.min) = 0, (wix.api.max) = 999999999.99];
+    // Variant SKU (stock keeping unit)
+    google.protobuf.StringValue sku = 5 [(wix.api.maxLength) = 40];
+    // Whether the variant is visible to  customers
+    google.protobuf.BoolValue visible = 6;
+}
+
+message OptionWithChoice {
+    //Option name e.g., Color, Size
+    string option = 1;
+    //Choice value e.g., Blue, Large
+    string choice = 2;
+}
+
+message StoreVariant {
+    // Store variant ID. Comprised of the `productId` and the `variantId`, separated by a hyphen: {productId}.{variantId}.
+    string id = 12;
+    // Variant ID.
+    string variant_id = 1 [(wix.api.format) = GUID];
+    //Product ID.
+    string product_id = 2 [(wix.api.referenced_entity) = "wix.stores.catalog.v1.product"];
+    // Variant name.
+    string variant_name = 3 [(wix.api.minLength) = 1, (wix.api.maxLength) = 80];
+    //Product name.
+    string product_name = 4 [(wix.api.minLength) = 1, (wix.api.maxLength) = 80];
+    //Whether the variant is managed or represents a product.
+    bool managed_variant = 5;
+    // Variant SKU (stock keeping unit).
+    string sku = 6 [(wix.api.maxLength) = 40];
+    // Variant inventory status.
+    VariantStock stock = 7;
+    // The selected options of this variant. For example, `{"Color": "Blue", "Size": "Large"}`.
+    map<string, string> choices = 8;
+    // Collections that include this variant.
+    repeated string collection_ids = 9 [(wix.api.format) = GUID, (wix.api.referenced_entity) = "wix.stores.catalog.v1.collection"];
+    // Media items (images, videos) associated with this variant.
+    com.wix.ecommerce.commons.api.PlatformMedia media = 10 [(wix.api.readOnly) = true];
+    map<string, google.protobuf.Value> custom_fields = 11 [(.wix.api.field_exposure) = PRIVATE];
+    // Preorder information.
+    .wix.inventory.api.v1.PreorderInfo preorder_info = 13;
+}
+
+message VariantStock {
+    // Whether inventory is being tracked.
+    bool track_quantity = 1;
+    // Quantity currently left in inventory.
+    google.protobuf.Int32Value quantity = 2 [(wix.api.min) = 0, (wix.api.max) = 99999];
+    // Whether the product is currently in stock (relevant only when tracking manually).
+    bool in_stock = 3;
+}

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

@@ -0,0 +1,75 @@
+syntax = "proto3";
+
+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";
+
+option java_package = "com.wix.ecommerce.catalog.api.v2";
+
+service CollectionReadApi {
+    option (wix.api.service_exposure) = PUBLIC;
+    option (wix.api.service_maturity) = GA;
+    option (wix.api.service_entity).message = "wix.catalog.api.v1.Collection";
+
+    // Retrieves a list of up to 100 collections, given the provided paging, sorting and filtering.
+    // See [Stores Pagination](https://dev.wix.com/api/rest/wix-stores/pagination) for more information.
+    rpc QueryCollections (QueryCollectionsRequest) returns (QueryCollectionsResponse) {
+        option (google.api.http) = {
+            post: "/v2/collections/query"
+        };
+        option (wix.api.exposure) = INTERNAL;
+
+        option (.wix.api.crud) = {
+            method: QUERY
+            query_options: {
+                items_field: 'collections'
+                paging: {
+                    type: OFFSET
+                }
+                wql: {
+                    pattern: {
+                        operator: ALL_APPLICABLE_OPERATORS
+                        field: "name"
+                        field: "id"
+                        sort: BOTH
+                    }
+                }
+            }
+        };
+    }
+
+    // Retrieves a collection with the provided ID.
+    rpc GetCollection (GetCollectionRequest) returns (GetCollectionResponse) {
+        option (google.api.http) = {
+            get: "/v2/collections/{id}"
+        };
+        option (wix.api.crud).method = GET_ITEM;
+    }
+}
+
+message QueryCollectionsRequest {
+    com.wix.ecommerce.commons.api.PlatformQuery query = 1;
+    // Whether number of products should be included in the response.
+}
+
+message QueryCollectionsResponse {
+    repeated wix.catalog.api.v1.Collection collections = 1 [(wix.api.maxSize) = 100];
+    com.wix.ecommerce.commons.api.PlatformPagingMetadata metadata = 2;
+}
+
+message GetCollectionRequest {
+    // Requested collection ID.
+    string id = 1;
+}
+
+message GetCollectionResponse {
+    wix.catalog.api.v1.Collection collection = 1;
+}

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

@@ -0,0 +1,140 @@
+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/validations.proto";
+
+// A common address format to use if you plan to store addresses in your service
+
+// Physical address
+message Address {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "country"
+        field: "subdivision"
+        field: "city"
+        field: "postal_code"
+        field: "street_address"
+        field: "formatted_address"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "country"
+        field: "subdivision"
+        field: "city"
+        field: "postal_code"
+        field: "address_line"
+        field: "address_line_2"
+        field: "formatted_address"
+    };
+    google.protobuf.StringValue country = 1 [(.wix.api.format) = COUNTRY]; // Country code.
+    google.protobuf.StringValue subdivision = 2; // Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
+    google.protobuf.StringValue city = 3 [(.wix.api.pii) = true]; // City name.
+    google.protobuf.StringValue postal_code = 4 [(.wix.api.pii) = true]; // Zip/postal code.
+    oneof street {
+        StreetAddress street_address = 5; // Street name and number.
+        google.protobuf.StringValue address_line = 6 [(.wix.api.pii) = true]; // Main address line, usually street and number as free text.
+    }
+    google.protobuf.StringValue address_line_2 = 7 [(.wix.api.pii) = true]; // Free text providing more detailed address info. Usually contains Apt, Suite, and Floor.
+
+    google.protobuf.StringValue formatted_address = 8 [(.wix.api.pii) = true, (.wix.api.field_exposure) = PRIVATE]; // A string containing the full address of this location.
+    google.protobuf.StringValue hint = 9 [(.wix.api.pii) = true, (.wix.api.field_exposure) = PRIVATE]; // Free text to help find the address.
+    AddressLocation geocode = 10 [(.wix.api.field_exposure) = PRIVATE]; // Coordinates of the physical address.
+    google.protobuf.StringValue country_fullname = 11 [(.wix.api.pii) = false, (.wix.api.field_exposure) = PRIVATE]; // Country full name.
+    google.protobuf.StringValue subdivision_fullname = 13 [(.wix.api.pii) = false, (.wix.api.field_exposure) = PRIVATE]; // Subdivision full name.
+    repeated Subdivision subdivisions = 12 [(.wix.api.field_exposure) = PRIVATE, (.wix.api.maxSize) = 6]; // Multi-level subdivisions from top to bottom.
+}
+
+message Subdivision {
+    enum SubdivisionType {
+        UNKNOWN_SUBDIVISION_TYPE = 0;
+        ADMINISTRATIVE_AREA_LEVEL_1 = 1; // State
+        ADMINISTRATIVE_AREA_LEVEL_2 = 2; // County
+        ADMINISTRATIVE_AREA_LEVEL_3 = 3; // City/town
+        ADMINISTRATIVE_AREA_LEVEL_4 = 4; // Neighborhood/quarter
+        ADMINISTRATIVE_AREA_LEVEL_5 = 5; // Street/block
+        COUNTRY = 6; // ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder.
+    }
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "code"
+    };
+    string code = 1; // Short subdivision code.
+    string name = 2; // Subdivision full name.
+    SubdivisionType type = 3 [(.wix.api.field_exposure) = PRIVATE]; // Subdivision level
+    google.protobuf.StringValue type_info = 4 [(.wix.api.field_exposure) = PRIVATE]; // Free text description of subdivision type.
+}
+
+message StreetAddress {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "number"
+        field: "name"
+    };
+    string number = 1 [(.wix.api.pii) = true]; // Street number.
+    string name = 2 [(.wix.api.pii) = true]; // Street name.
+    string apt = 3 [(.wix.api.pii) = true, (.wix.api.field_exposure) = PRIVATE]; // Apartment number.
+    google.protobuf.StringValue formatted_address_line = 4 [(.wix.api.pii) = true, (.wix.api.field_exposure) = PRIVATE]; // Optional address line 1
+}
+
+//Contact details for the address
+message AddressContactDetails {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "full_name"
+    };
+    google.protobuf.StringValue full_name = 1 [(.wix.api.pii) = true]; // Contact's full name.
+    google.protobuf.StringValue phone = 2 [(.wix.api.pii) = true, (.wix.api.format) = PHONE]; // Contact's phone number.
+    google.protobuf.StringValue company = 3; // Contact's company name.
+    google.protobuf.StringValue email = 4 [(.wix.api.pii) = true, (.wix.api.format) = EMAIL]; // Email associated with the address.
+}
+
+//Full contact details for an address
+message FullAddressContactDetails {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "first_name"
+        field: "last_name"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "full_name"
+    };
+    google.protobuf.StringValue first_name = 1 [(.wix.api.pii) = true]; // Contact's first name.
+    google.protobuf.StringValue last_name = 2 [(.wix.api.pii) = true]; // Contact's last name.
+    google.protobuf.StringValue full_name = 8 [(.wix.api.pii) = true, (.wix.api.field_exposure) = PRIVATE]; // Contact's full name.
+    google.protobuf.StringValue phone = 3 [(.wix.api.pii) = true, (.wix.api.format) = PHONE]; // Contact's phone number.
+    google.protobuf.StringValue company = 4; // Contact's company name.
+    google.protobuf.StringValue email = 5 [(.wix.api.pii) = true, (.wix.api.format) = EMAIL]; // Email associated with the address.
+    VatId vat_id = 7; // Tax info. Currently usable only in Brazil.
+}
+
+message VatId {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "id"
+        field: "type"
+    };
+    string id = 1 [(.wix.api.pii) = true]; // Customer's tax ID.
+     /*
+     Tax type.
+     
+     Supported values:
+     + `CPF`: for individual tax payers
+     + `CNPJ`: for corporations
+     */
+    VatType type = 2;
+}
+
+// tax info types
+enum VatType {
+    UNSPECIFIED = 0;
+    CPF = 1; // CPF - for individual tax payers.
+    CNPJ = 2; // CNPJ - for corporations
+}
+
+message AddressLocation {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "latitude"
+        field: "longitude"
+    };
+    google.protobuf.DoubleValue latitude = 1 [(.wix.api.pii) = true]; // Address latitude.
+    google.protobuf.DoubleValue longitude = 2 [(.wix.api.pii) = true]; // Address longitude.
+}