@wix/bex-utils 1.28.0

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/api/validations.proto

@@ -0,0 +1,131 @@
+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;
+    // 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;
+}
+
+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;
+}

package/@wix/ambassador-os-tags-v1-tag/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.
+}

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/common/bulk.proto

@@ -0,0 +1,52 @@
+syntax = "proto3";
+
+package wix.common;
+
+option java_multiple_files = true;
+option java_package = "com.wix.common";
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/errors.proto";
+
+message BulkActionMetadata {
+    // Number of items that were successfully processed.
+    uint32 total_successes = 1;
+    // Number of items that couldn't be processed.
+    uint32 total_failures = 2;
+    // Number of failures without details because detailed failure threshold was exceeded.
+    uint32 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.
+    uint32 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-os-tags-v1-tag/src/main/proto/wix/common/data/dataextensions/extended-fields.proto

@@ -0,0 +1,18 @@
+syntax = "proto3";
+
+import "google/protobuf/struct.proto";
+
+package wix.common.data.dataextensions;
+
+option java_multiple_files = true;
+option java_package = "com.wix.common.data.dataextensions";
+
+message ExtendedFields {
+  /*  
+   Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+   The value of each key is structured according to the schema defined when the extended fields were configured.
+   
+   You can only access fields for which you have the appropriate permissions.
+   */
+  map<string, google.protobuf.Struct> namespaces = 1;
+}

package/@wix/ambassador-os-tags-v1-tag/src/main/proto/wix/common/data/dataextensions/update-extended-fields-messages.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/field_mask.proto";
+
+package wix.common.data.dataextensions;
+
+option java_multiple_files = true;
+option java_package = "com.wix.common.data.dataextensions";
+
+message UpdateExtendedFieldsRequest {
+  string id = 1; // ID of the entity to update.
+  string namespace = 2; // Identifier for the app whose extended fields are being updated.
+  google.protobuf.Struct namespace_data = 3; //  Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured.
+}