@wix/bex-utils 2.71.0 → 2.72.0

package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/sorting.proto

@@ -0,0 +1,36 @@
+syntax = "proto3";
+
+package wix.common;
+
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "google/protobuf/struct.proto";
+
+option java_multiple_files = true;
+option java_package = "com.wix.common";
+
+message Sorting {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "field_name"
+        field: "order"
+    };
+    // Name of the field to sort by.
+    string field_name = 1 [(.wix.api.maxLength) = 512];
+    // Sort order.
+    SortOrder order = 2;
+    // When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+    // a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
+    //
+    // If multiple filters are provided, they are combined with AND operator.
+    //
+    // Example:
+    // Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+    // and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+    // { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+    repeated google.protobuf.Struct select_items_by = 3 [(.wix.api.maxSize) = 10, (.wix.api.field_exposure) = PRIVATE];
+}
+
+enum SortOrder {
+    ASC = 0;
+    DESC = 1;
+}

package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/spi.proto

@@ -0,0 +1,85 @@
+syntax = "proto3";
+
+package wix.common.spi;
+
+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.common";
+
+message SpiBaseUri {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "base_uri"
+        field: "alternative_uris"
+    };
+    message AlternativeUri {
+        /*
+        Name of the method to create a custom URI for.  
+        
+        For `methodName`, use the name of the method in PascalCase. 
+        For example, for Get Shipping Rates use `GetShippingRates`.
+        */
+        string method_name = 1 [(.wix.api.minLength) = 3, (.wix.api.maxLength) = 128];
+        /*
+        Custom URI that Wix uses to call your server for this method. The path-suffix documented in the method will not be appended to this URI. 
+        Must be a secured endpoint beginning with `https://`. For example, `https://www.my-shipping-provider.com/my-shipping-rates`.
+        */
+        string absolute_uri = 2 [(.wix.api.minLength) = 6, (.wix.api.maxLength) = 2048];
+    }
+    /*
+    Base URI where the methods are called. Wix appends the path to the `baseUri`. 
+    For example, to call the Get Shipping Rates method at `https://my-shipping-provider.com/v1/getRates`, the base URI you provide here is `https://my-shipping-provider.com/`.
+    */
+    string base_uri = 1 [(.wix.api.minLength) = 6, (.wix.api.maxLength) = 2048];
+    // Alternate, custom URIs to replace the default URIs for specific service plugin methods.
+    repeated AlternativeUri alternative_uris = 2;
+}
+
+/**
+this message is not directly used by any service,
+it exists to describe the expected parameters that SHOULD be provided to invoked Velo methods as part of open-platform.
+e.g. SPIs, event-handlers, etc..
+NOTE: this context object MUST be provided as the last argument in each Velo method signature.
+
+Example:
+```typescript
+export function wixStores_onOrderCanceled({ event, metadata }: OrderCanceledEvent) {
+  ...
+}
+```
+ */
+message Context {
+    message IdentificationData {
+        option (.wix.api.decomposite_of) = "wix.common.IdentificationData";
+        enum IdentityType {
+            UNKNOWN = 0;
+            ANONYMOUS_VISITOR = 1;
+            MEMBER = 2;
+            WIX_USER = 3;
+            APP = 4;
+        }
+        reserved 1;
+        IdentityType identity_type = 6 [(.wix.api.readOnly) = true];
+        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];
+        }
+    }
+    google.protobuf.StringValue request_id = 1; // A unique identifier of the request. You may print this ID to your logs to help with future debugging and easier correlation with Wix's logs.
+    google.protobuf.StringValue currency = 2 [(.wix.api.format) = CURRENCY]; // [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) 3-letter currency code.
+    IdentificationData identity = 3; // An object that describes the identity that triggered this request.
+    repeated string languages = 4; // A string representing a language and region in the format of `"xx-XX"`. First 2 letters represent the language code according to ISO 639-1. This is followed by a dash "-", and then a by 2 capital letters representing the region according to ISO 3166-2. For example, `"en-US"`.
+    google.protobuf.StringValue instance_id = 5 [(.wix.api.format) = GUID]; // The service provider app's instance ID.
+    google.protobuf.StringValue app_extension_id = 6 [(.wix.api.maxLength) = 256, (wix.api.field_maturity) = ALPHA]; // Extension ID in Dev Center.
+    google.protobuf.StringValue app_extension_type = 7 [(.wix.api.maxLength) = 256, (wix.api.field_maturity) = ALPHA]; // Extension type in Dev Center.
+    google.protobuf.StringValue function_name = 8 [(.wix.api.maxLength) = 256, (wix.api.field_maturity) = ALPHA]; // Invoked function.
+
+}

package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/tags.proto

@@ -0,0 +1,55 @@
+syntax = "proto3";
+
+package wix.common.tags;
+
+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.common";
+/*
+  Common object for tags.
+  Should be use as in this example:
+  message Foo {
+    string id = 1;
+    // ...
+    Tags tags = 5
+  }
+
+  example of taggable entity
+  {
+    id: "123"
+    tags: {
+      tags: {
+        tag_ids:["11","22"]
+      },
+      private_tags: {
+        tag_ids: ["33", "44"]
+      }
+    }
+  }
+ */
+message Tags {
+  option (.wix.api.decomposition_minimum_fields) = {
+    field: "tags"
+  };
+
+  message TagList {
+    repeated string tag_ids = 1 [(.wix.api.referenced_entity) = "wix.os.tags.v1.tag", (.wix.api.maxSize) = 100, (.wix.api.maxLength) = 5]; // List of tag IDs
+  }
+  TagList private_tags = 1; // Tags that require an additional permission in order to access them, normally not given to site members or visitors.
+  TagList tags = 2; // Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.
+}
+
+message PublicTags {
+  option (.wix.api.decomposite_of) = "wix.common.tags.Tags";
+  option (.wix.api.decomposition_minimum_fields) = {
+    field: "tags"
+  };
+
+  message TagList {
+    repeated string tag_ids = 1 [(.wix.api.referenced_entity) = "wix.os.tags.v1.tag", (.wix.api.maxSize) = 100, (.wix.api.maxLength) = 5]; // List of tag IDs
+  }
+  TagList tags = 2; // Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.
+}

package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/common/wixlink.proto

@@ -0,0 +1,203 @@
+syntax = "proto3";
+
+package wix.common;
+
+option java_multiple_files = true;
+option java_outer_classname = "WixLinkProto";
+option java_package = "com.wix.common";
+
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "google/protobuf/wrappers.proto";
+
+//The link object generated by panels in the editor and used by applications in Wix
+message WixLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "external"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "page"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "anchor"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "dynamic_page"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "document"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "email"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "phone"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "address"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "whats_app"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "tpa_page_link"
+    };
+    oneof Link {
+        ExternalLink external = 1; // External link type
+        PageLink page = 2; // Page link type
+        AnchorLink anchor = 3; // Anchor link type
+        DynamicPageLink dynamic_page = 4; // Dynamic page link type
+        DocumentLink document = 5; // Document link type
+        EmailLink email = 6; // Email link type
+        PhoneLink phone = 7; // Phone link type
+        AddressLink address = 8; // Address link type
+        WhatsAppLink whats_app = 9; // WhatsApp link type
+        TpaPageLink tpa_page = 10; // TPA link type
+    }
+}
+
+message ExternalLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "url"
+    };
+    //The url of the page
+    string url = 1 [(.wix.api.format) = WEB_URL];
+    //Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page.
+    google.protobuf.StringValue target = 2;
+    //rel of link
+    repeated LinkRel rel = 3 [(.wix.api.maxSize) = 20, (.wix.api.field_exposure) = PRIVATE];
+}
+
+message PageLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "page_id"
+    };
+    //The page id we want from the site
+    string page_id = 1;
+    //Where this link should open, supports _self and _blank or any name the user chooses. _self means same page, _blank means new page.
+    google.protobuf.StringValue target = 2;
+    //rel of link
+    repeated LinkRel rel = 3 [(wix.api.maxSize) = 20];
+}
+
+message AnchorLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "anchor_name"
+        field: "anchor_data_id"
+        field: "page_id"
+    };
+    //The name of the anchor
+    string anchor_name = 1;
+    //The data id (from the JSON page) of the anchor that should be used
+    string anchor_data_id = 2;
+    //The page id we want from the site
+    string page_id = 3;
+    //rel of link
+    repeated LinkRel rel = 4 [(wix.api.maxSize) = 20];
+}
+
+message DynamicPageLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "router_id"
+        field: "inner_route"
+        field: "anchor_data_id"
+    };
+    //The router that handles this link
+    string router_id = 1;
+    //The path data we'd like
+    string inner_route = 2;
+    //The data id (from the JSON page) of the anchor that should be used
+    google.protobuf.StringValue anchor_data_id = 3;
+    //rel of link
+    repeated LinkRel rel = 4 [(wix.api.maxSize) = 20];
+}
+
+message DocumentLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "doc_id"
+        field: "name"
+    };
+    //The id of the document
+    string doc_id = 1;
+    //The name of the document for download purposes
+    google.protobuf.StringValue name = 2;
+    //If this document can be indexed by scrapers, default is false
+    bool indexable = 3;
+}
+
+message EmailLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "recipient"
+        field: "subject"
+        field: "body"
+    };
+    //The email we will be sending a message to
+    string recipient = 1 [(.wix.api.format) = EMAIL];
+    //The subject of the email
+    google.protobuf.StringValue subject = 2;
+    //The body of the email
+    google.protobuf.StringValue body = 3;
+}
+
+message PhoneLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "phone_number"
+    };
+    //The phone number we want to link to
+    string phone_number = 1 [(.wix.api.pii) = true, (.wix.api.format) = PHONE, (.wix.api.maxLength) = 100];
+}
+
+message AddressLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "address"
+    };
+    //An address that we can link to
+    string address = 1 [(.wix.api.pii) = true];
+}
+
+message WhatsAppLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "phone_number"
+    };
+    //The whatsApp phone number we want to connect with
+    string phone_number = 1 [(.wix.api.pii) = true, (.wix.api.format) = PHONE];
+}
+
+//Link to a TPA page
+message TpaPageLink {
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "item_type_identifier"
+        field: "item_id"
+        field: "page_id"
+        field: "app_definition_id"
+        field: "path"
+    };
+    //Type of item (e.g. 'wix.stores.sub_pages.product')
+    string item_type_identifier = 1;
+    //Id of linked item
+    string item_id = 2;
+    //Id of linked page
+    string page_id = 3;
+    //Id of app being linked to (AppDefId)
+    string app_definition_id = 4;
+    //The relativepath of linked page
+    string path = 5;
+    //rel of link
+    repeated LinkRel rel = 6 [(wix.api.maxSize) = 20];
+}
+
+//The 'rel' attribute of the link. The rel attribute defines the relationship between a linked resource and the current document.
+//Further reading (also about different possible rel types): https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel
+//Following are the accepted 'rel' types by Wix applications.
+enum LinkRel {
+    // default (not implemented)
+    unknown_link_rel = 0 [(.wix.api.enum_maturity) = NOT_IMPLEMENTED];
+    //Indicates that the current document's original author or publisher does not endorse the referenced document.
+    nofollow = 1;
+    //Instructs the browser to navigate to the target resource without granting the new browsing context access to the document that opened it.
+    noopener = 2;
+    //No Referer header will be included. Additionally, has the same effect as noopener.
+    noreferrer = 3;
+    //Indicates a link that resulted from advertisements or paid placements.
+    sponsored = 4;
+}

package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerBackoffice/api/v1/audiences.proto

@@ -0,0 +1,226 @@
+syntax = "proto3";
+
+package wix.dealerBackoffice.api.v1;
+
+import "google/api/annotations.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/callback.proto";
+
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/permissions.proto";
+import "wix/api/entity.proto";
+import "wix/dealerBackoffice/api/v1/targeting.proto";
+import "wix/dealerBackoffice/api/v1/managers.proto";
+
+option java_package = "com.wix.dealerBackoffice.api.v1";
+
+// Endpoint for managing dealer audiences (see description of Audience entity)
+service AudienceService {
+  option (wix.api.service_entity).message = "wix.dealerBackoffice.api.v1.Audience";
+  option (wix.api.service_maturity) = ALPHA;
+  option (wix.api.service_exposure) = INTERNAL;
+
+  // Get all audiences by ids.
+  // No exceptions are thrown if some/all audiences were not found.
+  // Worst case scenario (no audiences are found by provided id list) — you get empty array.
+  rpc GetAudiencesBulk (GetAudiencesBulkRequest) returns (GetAudiencesBulkResponse) {
+    option (google.api.http).get = "/v1/dealer/backoffice/audiences/bulk";
+    option (wix.api.required) = "GetAudiencesBulkRequest.audience_ids";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.READ_AUDIENCE";
+  }
+
+  // Get an audience by id.
+  // GrpcStatus.NOT_FOUND is thrown if requested audience is not found in DB
+  rpc GetAudience (GetAudienceRequest) returns (GetAudienceResponse) {
+    option (google.api.http).get = "/v1/dealer/backoffice/audiences/{audience_id}";
+    option (wix.api.required) = "GetAudienceRequest.audience_id";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.READ_AUDIENCE";
+    option (wix.api.crud) = {
+      method: GET_ITEM
+      get_options: {
+        id_field: "audience_id"
+      }
+    };
+  }
+
+  // List all audiences
+  rpc ListAudiences (ListAudiencesRequest) returns (ListAudiencesResponse) {
+    option (google.api.http).get = "/v1/dealer/backoffice/audiences";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.READ_AUDIENCE";
+  }
+
+  rpc CreateAudience (CreateAudienceRequest) returns (CreateAudienceResponse) {
+    option (google.api.http).post = "/v1/dealer/backoffice/audiences";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.MUTATE_AUDIENCE";
+    option (wix.api.required) = "CreateAudienceRequest.audience";
+    option (wix.api.crud) = {
+      method: CREATE
+      create_options: {
+        item_field: "audience"
+      }
+    };
+    option (wix.api.callback) = {
+      event_type: CREATED
+    };
+  }
+
+  // Update audience.
+  // Cannot update audience criteria or external criteria. Use SetAudienceCriteria instead.
+  rpc updateAudience (UpdateAudienceRequest) returns (UpdateAudienceResponse) {
+    option (google.api.http).put = "/v1/dealer/backoffice/audiences";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.MUTATE_AUDIENCE";
+  }
+
+  rpc ArchiveAudience (ArchiveAudienceRequest) returns (ArchiveAudienceResponse) {
+    option (wix.api.required) = "ArchiveAudienceRequest.audience_id";
+    option (google.api.http).post = "/v1/dealer/backoffice/audiences/archive";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.MUTATE_AUDIENCE";
+  }
+
+  // Set specific audience criteria
+  rpc SetAudienceCriteria(SetAudienceCriteriaRequest) returns (SetAudienceCriteriaResponse) {
+    option (google.api.http).put = "/v1/dealer/backoffice/audiences/{audience_id}/criteria";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.MUTATE_AUDIENCE";
+  }
+
+  // Migrate audience to new Nile Audience Service
+  rpc MigrateAudience (MigrateAudienceRequest) returns (MigrateAudienceResponse) {
+    option (google.api.http).put = "/v1/dealer/backoffice/audiences/{audience_id}/migrate";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.MUTATE_AUDIENCE";
+  }
+}
+
+// Single audience request
+message GetAudienceRequest {
+  // required
+  string audience_id = 1 [(wix.api.format) = GUID];
+}
+
+// Single audience response
+message GetAudienceResponse {
+  Audience audience = 1;
+}
+
+message ListAudiencesRequest {
+}
+
+// List all audiences response
+message ListAudiencesResponse {
+  repeated Audience audiences = 1;
+}
+
+message CreateAudienceRequest {
+  Audience audience = 1;
+}
+
+message CreateAudienceResponse {
+  Audience audience = 1;
+}
+
+message UpdateAudienceRequest {
+  Audience audience = 1;
+}
+
+message UpdateAudienceResponse {
+  Audience audience = 1;
+}
+
+message ArchiveAudienceRequest {
+  string audience_id = 1 [(wix.api.format) = GUID, (wix.api.readOnly) = true];
+}
+
+message ArchiveAudienceResponse {}
+
+message SetAudienceCriteriaRequest {
+  string audience_id = 1 [(wix.api.format) = GUID, (wix.api.readOnly) = true];
+
+  CustomFilterCriteria criteria = 2;
+
+  ExternalCriteria external_criteria = 3;
+
+  Audience.Level level = 4;
+}
+
+message SetAudienceCriteriaResponse {
+  Audience audience = 1;
+}
+
+// Multi audiences request
+message GetAudiencesBulkRequest {
+  // required
+  repeated string audience_ids = 1 [(wix.api.format) = GUID];
+}
+
+// Multi audiences bulk response
+message GetAudiencesBulkResponse {
+  repeated Audience audiences = 1;
+}
+
+message MigrateAudienceRequest {
+  string audience_id = 1 [(wix.api.format) = GUID, (wix.api.readOnly) = true];
+}
+
+message MigrateAudienceResponse { }
+
+// Audience defines a group of Wix users and used as a filter in dealer offers https://bo.wix.com/wix-docs/rest/internal-tools/dealer-offers-serving/introduction
+// When dealer offer has audience filter, dealer filters the offer based on wether user belongs to provided
+// audience or not.
+//
+// Audience targeting currently supports bi profile user groups, site groups and simple bi field value
+// conditions https://bo.wix.com/bi-profile-service#/groups
+// Dor example 'Editor X users' audience mean "all users who has `editor_x_users` in  bi profile user_groups".
+message Audience {
+  option (wix.api.entity) = {fqdn:"wix.dealer.v1.audience", segment: USERS};
+
+  enum Level {
+    UNKNOWN = 0;
+    USER = 1;
+    SITE = 2;
+  };
+
+  // Unique audience guid
+  string guid = 1 [(wix.api.format) = GUID, (wix.api.readOnly) = true];
+
+  // Audience name
+  google.protobuf.StringValue name = 2 [(wix.api.minLength) = 1];
+
+  // Audience description
+  google.protobuf.StringValue description = 3 [(wix.api.minLength) = 1];
+
+  // URL of wix bi service catalog on profile field used for this audience
+  google.protobuf.StringValue field_link = 4 [(wix.api.minLength) = 1];
+
+  // Used as link to bi table for reports of audiences
+  google.protobuf.StringValue offline_source_table = 5 [(wix.api.minLength) = 1];
+
+  // Used as link to bi table for reports of audiences
+  google.protobuf.StringValue offline_query_condition = 6;
+
+  // Category of the audience (for example "App Funnels")
+  google.protobuf.StringValue category = 7 [(wix.api.minLength) = 1];
+
+  // Label of the audience (for example "Events")
+  google.protobuf.StringValue label = 8 [(wix.api.minLength) = 1];
+
+  // BI filter criteria, corresponding to this audience.
+  // Basically a user belongs to this audience if and only if this criteria for the user is satisfied.
+  // Different audiences should have different criterias.
+  CustomFilterCriteria criteria = 9;
+
+  // Priority of the audience to be used in BO UI etc.
+  google.protobuf.Int32Value ui_order = 10;
+
+  // If this audience is updated in realtime or not (from BI side).
+  google.protobuf.BoolValue real_time_update = 11 [(wix.api.readOnly) = true];
+
+  // Who are the managers of the audience in Wix
+  ManagerIdsWrapper managers_ids = 12;
+
+  reserved 13;
+
+  // SPI for audience
+  ExternalCriteria external_criteria = 14;
+
+  Level level = 15;
+}