@wix/bex-utils 2.34.0 → 2.36.0

package/@wix/ambassador-items-selection-spi-host-v1-provider/src/main/proto/wix/api/entity.proto

@@ -0,0 +1,122 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+import "wix/api/annotations.proto";
+import "wix/api/callback.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "EntityProto";
+option java_package = "com.wix.api";
+
+/*
+Marks that message X is the "main" entity of service Y
+Key requirement for DomainEvents used in callback/event
+
+package com.wixpress.examples;
+
+service BlooperService {
+    option (wix.api.service_entity).message = "com.wixpress.examples.Blooper"; //the "main" entity
+    rpc Update (BlooperRequest) returns (BlooperResponse) {
+        //...
+    };
+}
+
+message Blooper {
+   option (wix.api.entity) = {
+       fqdn: "wix.examples.Blooper" // A fully qualified domain name for this entity. Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+       exposure: PUBLIC //Optional exposure field. Will be used by systems like corvid and webhooks to decide if to expose events related to this entity to external parties
+
+   };
+}
+*/
+
+extend google.protobuf.ServiceOptions {
+    optional ServiceEntity service_entity = 50500;
+}
+
+message ServiceEntity {
+    required string message = 1;
+    optional string namespace = 50501; // use to avoid naming collisions between functions listed under the same fqdn/entity. Business Schema service shall use it using this hierarchy: [Entity > namespace > action]
+}
+
+extend google.protobuf.MessageOptions {
+    optional Entity entity = 50500;
+    repeated DomainEvent domain_event = 50501;
+}
+
+message Entity {
+    required string fqdn = 1;
+    optional Exposure exposure = 2 [deprecated=true];
+    repeated MessageAppendix appendix_files = 3; // declare external configuration info
+    optional string old_fqdn_for_backwards_compatibility = 4; // Topic name for domain events will be based on this attribute if present (only for known legacy FQDNs)
+    optional Segment.SegmentName segment = 5; // the cluster to which domain events will be produced
+    repeated string implements = 6; // FQDNs of interfaces (i.e. SPIs) that this entity implements. Must begin with `wix.interfaces.`
+    optional Extensible extensible = 7; // Indicates that this entity can be extended by apps using data-extension mechanism.
+    optional bool trashbin = 8; // Indicates whether trash-bin is exposed on this entity.
+    optional string plural = 9; // plural form of this entity. e.g. singular: `entity`; plural: `entities`;
+    optional string domain_events_read_permission = 10; // permission to consume all event types of this entity from topic. affects internal/external consumers. For external webhook subscribers - MAY be overridden by event/callback `permission` field.
+    optional string app_def_id = 11; // the app in devcenter that owns this entity
+    optional DomainEventOptions domain_events = 12;
+    optional Taggable taggable = 13; // Indicates whether this entity supports tagging
+    optional QueryOptions query_options = 14;
+    optional Exposure events_exposure = 15; // default events exposure, may be overridden in `wix.api.domain_event`
+    optional Maturity events_maturity = 16; // default events maturity, may be overridden in `wix.api.domain_event`
+    optional Persistence persistence = 17; // persistence config: type and tenancy model
+}
+
+message Persistence {
+    enum Type {
+        STANDARD = 0; // multiple records per tenant
+        SINGLETON = 1; // single record per tenant
+        NONE = 2; // zero records per tenant - stateless
+    }
+    optional Type type = 1;
+}
+
+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;
+    repeated NestedExtensionPointMapping nested_extension_point_mappings = 3; // mappings for nested extensionPoint
+}
+
+message NestedExtensionPointMapping {
+    required string extension_point = 1; // the logical name of the extension point
+    required string path = 2; // the path to the parent object that contains the `extended_fields` field
+}
+
+message MessageAppendix {
+    enum Type {
+        UNKNOWN_APPENDIX_TYPE = 0;
+        AUTO_VELO = 1; // auto velo configuration
+        DOCS_CONF = 2; // wix docs configuration: `documentation.yaml`
+        MULTILINGUAL = 3; // wix multilingual configuration
+        SEARCH = 4; // nile search configuration
+        AUTO_SDK = 5; // auto sdk configuration 
+    }
+    required Type type = 1; // appendix type
+    required string path = 2; // absolute from module root
+}
+
+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.
+}
+
+message Taggable {}
+
+message QueryOptions {
+    required Wql wql = 1; // mark fields that are available for filtering and sorting via WixQueryLanguage
+    repeated Search search = 2; // mark fields that are available for search
+    repeated NamedQueryOptions additional_query_options = 10; //additional query options
+}
+
+message NamedQueryOptions {
+    required string name  = 1; // additional options should be named
+    required Wql wql = 2; // mark fields that are available for filtering and sorting via WixQueryLanguage
+    repeated Search search = 3; // mark fields that are available for search
+}

package/@wix/ambassador-items-selection-spi-host-v1-provider/src/main/proto/wix/api/errors.proto

@@ -0,0 +1,119 @@
+syntax = "proto3";
+
+package wix.api;
+
+option java_package = "com.wix.api";
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+
+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
+}
+
+message ApplicationError {
+    // Error code.
+    string code = 1;
+    // Description of the error.
+    string description = 2;
+    // Data related to the error.
+    google.protobuf.Struct data = 3;
+}
+
+message SystemError {
+    // Error code.
+    google.protobuf.StringValue errorCode = 1;
+}
+
+/**
+example result:
+{
+  "fieldViolations": [
+    {
+      "field": "fieldA",
+      "description": "invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]",
+      "violatedRule": "OTHER",
+      "ruleName": "INVALID_NOTE",
+      "data": {
+        "value": "FI"
+      }
+    },
+    {
+      "field": "fieldB",
+      "description": "field value out of range. supported range: [0-20]",
+      "violatedRule": "MAX",
+      "data": {
+        "threshold": 20
+      }
+    },
+    {
+      "field": "fieldC",
+      "description": "invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]",
+      "violatedRule": "FORMAT",
+      "data": {
+        "type": "PHONE"
+      }
+    }
+  ]
+}
+**/
+message ValidationError {
+    enum RuleType {
+        VALIDATION = 0;
+        OTHER = 1;
+        MAX = 2;
+        MIN = 3;
+        MAX_LENGTH = 4;
+        MIN_LENGTH = 5;
+        MAX_SIZE = 6;
+        MIN_SIZE = 7;
+        FORMAT = 8;
+        DECIMAL_LTE = 9;
+        DECIMAL_GTE = 10;
+        DECIMAL_LT = 11;
+        DECIMAL_GT = 12;
+        DECIMAL_MAX_SCALE = 13;
+        INVALID_ENUM_VALUE = 14;
+        REQUIRED_FIELD = 15;
+        FIELD_NOT_ALLOWED = 16;
+        ONE_OF_ALIGNMENT = 17;
+    }
+    message FieldViolation {
+        string field = 1;
+        string description = 2;
+        RuleType violated_rule = 3;
+        google.protobuf.StringValue rule_name = 4; // applicable when violated_rule=OTHER
+        google.protobuf.Struct data = 5;
+    }
+    repeated FieldViolation field_violations = 1;
+}
+
+// for all kinds of min/max violations - match to type provided in annotation
+message LimitRuleInt32DataPayload {
+    int32 threshold = 1;
+}
+
+// for all kinds of min/max violations - match to type provided in annotation
+message LimitRuleDoubleDataPayload {
+    double threshold = 1;
+}
+
+// for all kinds of min/max violations - match to type provided in annotation
+message LimitRuleStringDataPayload {
+    string threshold = 1;
+}
+
+// for format violations
+message FormatRuleDataPayload {
+    string type = 1;
+}
+
+// for enum violations
+message EnumRuleDataPayload {
+    repeated string supported = 1;
+}

package/@wix/ambassador-items-selection-spi-host-v1-provider/src/main/proto/wix/api/idempotency.proto

@@ -0,0 +1,25 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "IdempotencyProto";
+option java_package = "com.wix.api";
+
+/* Idempotency annotation for Loom Prime
+Configures idempotency for the method.
+See ExecutionGuard README for more details: https://github.com/wix-private/server-infra/blob/master/aglianico/execution-guard/README.md#loom-prime-with-zero-code
+
+[NOTE]:
+The annotation affects only Loom Prime services.
+Any other service will ignore this annotation.
+*/
+extend google.protobuf.MethodOptions {
+    optional Idempotency idempotency = 50153;
+}
+
+message Idempotency {
+    optional string key = 1;
+}

package/@wix/ambassador-items-selection-spi-host-v1-provider/src/main/proto/wix/api/permissions.proto

@@ -0,0 +1,40 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "PermissionsProto";
+option java_package = "com.wix.api";
+
+/**
+* Annotation for method permission rules
+* example usage:
+* import "wix/api/permissions.proto";
+* service Bloop {
+*    rpc Create (CreateBloopRequest) returns (CreateBloopResponse) {
+*        option (wix.api.permission).name = "SOME_PERMISSION_NAME";
+*    }
+*    rpc SpecialDelete (SpecialDeleteBloopRequest) returns (SpecialDeleteResponse) {
+*        option (wix.api.permission) = {
+*           name: "SOME_PERMISSION_NAME"
+*           type: MANUAL
+*        }
+*    }
+* }
+**/
+extend google.protobuf.MethodOptions {
+    optional PermissionRule permission = 50301;
+    repeated PermissionRule additional_permission = 50302;
+}
+
+message PermissionRule {
+  optional string name = 1;
+  optional PermissionType type = 2;
+}
+
+enum PermissionType {
+    AUTO = 0;
+    MANUAL = 1;
+}

package/@wix/ambassador-items-selection-spi-host-v1-provider/src/main/proto/wix/api/sla.proto

@@ -0,0 +1,24 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "SlaProto";
+option java_package = "com.wix.api";
+
+extend google.protobuf.MethodOptions {
+    optional Sla sla = 50700;
+}
+
+message Sla {
+    /*
+     * Number of milliseconds after which the method will timeout
+     * and return TIMEOUT (504) response for http or DEADLINE_EXCEEDED
+     * for grpc.
+     * This default deadline will be applied automatically
+     * iff request does not contain deadline information.
+     */
+    optional int32 response_time_ms = 1;
+}

package/@wix/ambassador-items-selection-spi-host-v1-provider/src/main/proto/wix/api/subscription.proto

@@ -0,0 +1,32 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+import "wix/api/callback.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "SubscriptionProto";
+option java_package = "com.wix.api";
+
+/*
+Marks a method as a topic consumer.
+service BlooperService {
+   rpc Update (BlooperUpdateNotification) returns (google.protobuf.Empty) {
+       option (wix.api.subscription) = {
+           topic: "Blooper.Update"
+       };
+   };
+}
+*/
+extend google.protobuf.MethodOptions {
+    optional Subscription subscription = 50400;
+}
+
+message Subscription {
+    optional string topic = 1;
+    optional Segment.SegmentName segment = 4; // currently defaults to "legacy", will be `required` when legacy cluster is removed
+    optional bool batch = 2 [deprecated = true];
+    optional string entity = 3;
+    optional bool dynamic = 5;
+}

package/@wix/ambassador-items-selection-spi-host-v1-provider/src/main/proto/wix/api/validations.proto

@@ -0,0 +1,137 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "wix/api/api_errors.proto";
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "ValidationsProto";
+option java_package = "com.wix.api";
+
+/**
+*  Annotation for field validation rules
+*  example usage:
+*    import "wix/api/validations.proto";
+*
+*    message User {
+*      string id = 1 [(wix.api.readOnly)=true, (wix.api.format)=GUID];
+*      double age = 2 [(wix.api.max)=120, (wix.api.min)=0];
+*      string email = 3 [(wix.api.format)=EMAIL];
+*      string username = 4 [(wix.api.minLength)=3];
+*      string phone = 5 [(wix.api.format)=PHONE];
+*    }
+*
+*    message Invoice {
+*      string id = 1 [(wix.api.readOnly)=true, (wix.api.format)=GUID];
+*      string amount_paid = 2 [(wix.api.decimalValue) = { gte: "0.01" lt: "10" maxScale: 2 }];
+*    }
+**/
+extend google.protobuf.FieldOptions {
+    // max possible value
+    optional double max = 50201;
+    // min possible value
+    optional double min = 50202;
+    // max length for strings
+    optional int32 maxLength = 50203;
+    // min length for strings
+    optional int32 minLength = 50204;
+    // max size for repeated field, map
+    optional int32 maxSize = 50209;
+    // min size for repeated field, map
+    optional int32 minSize = 50210;
+    // common known formats like email, URI, etc.
+    optional Format format = 50205;
+    // indicates this field cannot be set by the client. E.g. Id field assigned by the server
+    optional bool readOnly = 50208;
+    // indicates this field can be set by the client, but can never be changed or updated
+    optional bool immutable = 50212;
+    // indicates this field is input-only, it will NOT be returned in output response
+    optional bool writeOnly = 50154;
+    // decimal value format
+    optional DecimalValueOptions decimalValue = 50211;
+    // declare custom field validation for all methods
+    optional CustomValidationError custom_validation = 50214;
+}
+
+/**
+* Decimal value validation rules.
+* Based on java.math.BigDecimal, implies (wix.api.format) = DECIMAL_VALUE
+*/
+message DecimalValueOptions {
+    optional string lte = 1; // less than or equal
+    optional string gte = 2; // greater than or equal
+    optional string lt = 3; // less than
+    optional string gt = 4; // greater than
+    optional int32 maxScale = 5; // max number of fractional digits
+}
+
+/**
+* Annotation for method validation rules
+* example usage:
+* import "wix/api/validations.proto";
+* service Bloop {
+*    rpc Create (CreateBloopRequest) returns (CreateBloopResponse) {
+*       option (wix.api.required) = "CreateBloopRequest.Bloop.name";
+*    }
+* }
+**/
+extend google.protobuf.MethodOptions {
+    // Specify which fields are required in this method.
+    // Annotating a nested field as `required` does not imply that the whole path to that field is required, eg.
+    // `option (wix.api.required) = "person.pet.name";` means that if a `person` has a `pet`, then the `pet` must have
+    // a `name` set; it does not mean that `person` or `person.pet` themselves are required - these fields should be
+    // annotated individually if needed.
+    // This option can be repeated multiple times to specify multiple fields.
+    // example use:
+    //    option (wix.api.required) = "userId";
+    //    option (wix.api.required) = "userName";
+    repeated string required = 50200;
+    // Specify list of `immutable` fields which can be writable in this method.
+    // Most common in Create methods
+    // Only `immutable` AND NOT `readOnly` fields are allowed to be referenced via this annotation
+    // example use:
+    //    option (wix.api.writable) = "id"; // user-generated id is enabled
+    repeated string writable = 50213;
+
+}
+
+extend google.protobuf.OneofOptions {
+    // name of the enum field that must be aligned with this oneof (AIP 7015)
+    // ADR 038: Linking oneOf with Enum: https://github.com/wix-private/server-infra/blob/master/framework/docs/adr/adr-038-aligned-with-enum.md
+    optional AlignedWithEnum aligned_with_enum = 50800;
+}
+
+message AlignedWithEnum {
+    required string field = 1;
+    // defaults to _options if not specified
+    optional string suffix = 2;
+}
+
+enum Format {
+    EMAIL = 0;
+    HOSTNAME = 1;
+    IPV4 = 2;
+    IPV6 = 3;
+    URI = 4;
+    WEB_URL = 5; // HTTP or HTTPS
+    PHONE = 7;
+    CREDIT_CARD = 8;
+    GUID = 9;
+    COUNTRY = 10; // 2 letters ISO-3166-1
+    LANGUAGE = 11; // 2 letters ISO-639-1
+    /*
+      Use this on string or stringValue types to validate the format of that field is same as a decimal value.
+      This will ensure keeping the precision of decimal value, such as when passing monetary values.
+    */
+    DECIMAL_VALUE = 12;
+    CURRENCY = 13; // 3 letters - all available currencies
+    LANGUAGE_TAG = 14; // IETF BCP 47 language tag (e.g. en-US)
+    COLOR_HEX = 15; // hex color format as defined by the MDN https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color
+    LOCAL_DATE = 16; // ISO-8601 extended local date format (YYYY-MM-DD)
+    LOCAL_TIME = 17; // ISO-8601 extended local time format (hh:mm[:ss][.sss])
+    LOCAL_DATE_TIME = 18; // ISO-8601 extended local date-time format (YYYY-MM-DDThh:mm[:ss][.sss])
+    URL_SLUG = 19;
+    SYSTEM_SLUG = 20;
+    SECURE_WEB_URL = 21; // HTTPS only
+}

package/@wix/ambassador-items-selection-spi-host-v1-provider/src/main/proto/wix/common/address.proto

@@ -0,0 +1,148 @@
+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 shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY
+    google.protobuf.StringValue subdivision_iso_3166_2 = 14 [(.wix.api.maxLength) = 20, (.wix.api.field_exposure) = PRIVATE]; // Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2), e.g. US-NY
+    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.
+    }
+
+    // Subdivision Concordance values
+    message StandardDetails {
+        google.protobuf.StringValue iso_3166_2 = 1 [(.wix.api.maxLength) = 20]; // subdivision iso-3166-2 code according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). e.g. US-NY, GB-SCT, NO-30
+    }
+
+    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.
+    StandardDetails standard_details = 5 [(.wix.api.field_exposure) = PRIVATE]; // Standard organizations details (e.g. ISO).
+}
+
+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.
+}