@wix/bex-utils 2.71.0 → 2.73.0

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

@@ -0,0 +1,423 @@
+syntax = "proto3";
+
+package wix.dealerBackoffice.api.v1;
+
+import "google/api/annotations.proto";
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/struct.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/common/data/dataextensions/extended-fields.proto";
+
+import "wix/dealerPriority/api/v1/priority.proto";
+
+import "wix/dealerBackoffice/api/v1/frequency-caps.proto";
+import "wix/dealerBackoffice/api/v1/managers.proto";
+import "wix/dealerBackoffice/api/v1/localization-managers.proto";
+import "wix/api/sla.proto";
+
+option java_package = "com.wix.dealerBackoffice.api.v1";
+
+// Endpoint for manipulating dealer Placements data (see docs to Placement entity).
+service PlacementService {
+  option (wix.api.service_entity).message = "wix.dealerBackoffice.api.v1.Placement";
+  option (wix.api.service_maturity) = ALPHA;
+  option (wix.api.service_exposure) = INTERNAL;
+
+  // Get placement by id
+  rpc GetPlacement (GetPlacementRequest) returns (GetPlacementResponse) {
+    option (google.api.http).get = "/v1/dealer/backoffice/placements/{placement_id}";
+    option (wix.api.required) = "GetPlacementRequest.placement_id";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.READ_PLACEMENT";
+    option (wix.api.crud) = {
+      method: GET_ITEM
+      get_options: {
+        id_field: "placement_id"
+      }
+    };
+  }
+
+  // Create placement
+  rpc CreatePlacement (CreatePlacementRequest) returns (CreatePlacementResponse) {
+    option (google.api.http).post = "/v1/dealer/backoffice/placements";
+    option (wix.api.required) = "CreatePlacementRequest.placement.name";
+    option (wix.api.required) = "CreatePlacementRequest.placement.parent";
+    option (wix.api.required) = "CreatePlacementRequest.placement.level";
+    option (wix.api.required) = "CreatePlacementRequest.placement.prioritization_strategy_config.strategy_params.ab_test_strategies.params_a";
+    option (wix.api.required) = "CreatePlacementRequest.placement.prioritization_strategy_config.strategy_params.ab_test_strategies.params_b";
+    option (wix.api.required) = "CreatePlacementRequest.placement.prioritization_strategy_config.strategy_params.ab_test_strategies.spec_name";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.CREATE_PLACEMENT";
+    option (wix.api.crud) = {
+      method: CREATE
+      create_options: {
+        item_field: "placement"
+      }
+    };
+    option (wix.api.callback) = {
+      event_type: CREATED
+    };
+  }
+
+  // Update placement (partial update)
+  rpc UpdatePlacement (UpdatePlacementRequest) returns (UpdatePlacementResponse) {
+    option (google.api.http).patch = "/v1/dealer/backoffice/placements/{placement.guid}";
+    option (wix.api.required) = "UpdatePlacementRequest.placement.guid";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.UPDATE_PLACEMENT";
+    option (wix.api.required) = "UpdatePlacementRequest.placement.prioritization_strategy_config.strategy_params.ab_test_strategies.params_a";
+    option (wix.api.required) = "UpdatePlacementRequest.placement.prioritization_strategy_config.strategy_params.ab_test_strategies.params_b";
+    option (wix.api.required) = "UpdatePlacementRequest.placement.prioritization_strategy_config.strategy_params.ab_test_strategies.spec_name";
+    option (wix.api.crud) = {
+      method: UPDATE
+      update_options: {
+        item_field: "placement"
+      }
+    };
+    option (wix.api.callback) = {
+      event_type: UPDATED
+    };
+  }
+
+  // Duplicate placement
+  rpc DuplicatePlacement (DuplicatePlacementRequest) returns (DuplicatePlacementResponse) {
+    option (google.api.http).post = "/v1/dealer/backoffice/placements/duplicate";
+    option (wix.api.required) = "DuplicatePlacementRequest.placement_id";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.DUPLICATE_PLACEMENT";
+    option (wix.api.sla).response_time_ms = 60000;
+  }
+
+  // Update placement (partial update)
+  rpc UpdateSlug (UpdatePlacementSlugRequest) returns (UpdatePlacementSlugResponse) {
+    option (google.api.http).put = "/v1/dealer/backoffice/placements/{placement_guid}/slug";
+    option (wix.api.required) = "UpdatePlacementSlugRequest.placement_guid";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.UPDATE_PLACEMENT";
+  }
+
+  // List all placements
+  rpc ListPlacements (ListPlacementsRequest) returns (ListPlacementsResponse) {
+    option (google.api.http).get = "/v1/dealer/backoffice/placements";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.READ_PLACEMENT";
+  }
+
+  // Get multiples placements by ids
+  rpc GetPlacementsBulk (GetPlacementsBulkRequest) returns (GetPlacementsBulkResponse) {
+    option (google.api.http).get = "/v1/dealer/backoffice/placements/bulk";
+    option (wix.api.required) = "GetPlacementsBulkRequest.placement_ids";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.READ_PLACEMENT";
+  }
+
+  // Update Placement Status
+  rpc UpdatePlacementStatus (UpdatePlacementStatusRequest) returns (UpdatePlacementStatusResponse) {
+    option (google.api.http).put = "/v1/dealer/backoffice/placements/{placement_guid}/status";
+    option (wix.api.required) = "UpdatePlacementStatusRequest.placement_guid";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.UPDATE_PLACEMENT";
+  }
+
+  // Publish Placement
+  rpc PublishPlacement (PublishPlacementRequest) returns (PublishPlacementResponse) {
+    option (google.api.http).put = "/v1/dealer/backoffice/placements/{placement_guid}/publish";
+    option (wix.api.required) = "PublishPlacementRequest.placement_guid";
+    option (wix.api.permission).name = "DEALER_BACKOFFICE.UPDATE_PLACEMENT";
+  }
+
+}
+message GetPlacementRequest {
+  // required
+  string placement_id = 1 [(wix.api.format) = GUID];
+}
+
+// Placement asset schema
+// https://github.com/wix-private/dealer-backoffice/tree/master/packages/dealer-forms-renderer/docs
+// https://docs.google.com/document/d/1Z6KGtk-UZC3-PWwMa4dfGgFvi9uPxCYyMDlW68RxXk8/edit#heading=h.hu6usdgde4b3
+message Schema {
+  option (.wix.api.entity) = {fqdn:"wix.dealer.v1.schema", segment: USERS, extensible: {}};
+
+  google.protobuf.StringValue id = 1 [(wix.api.format) = GUID, (wix.api.readOnly) = true];
+
+  // The data schema of the placement creative
+  google.protobuf.Struct data_schema = 2;
+
+  // The ui schema of the placement creative
+  google.protobuf.Struct ui_schema = 3;
+
+  // field is deprecated due to duplicate field, use id instead
+  google.protobuf.StringValue schema_id = 4 [(wix.api.format) = GUID, (.wix.api.field_deprecated) = {
+    replaced_by: "id",
+    target_removal_date: "2023-12-01"
+  }];
+
+  // the type of the schema (json or banner)
+  google.protobuf.StringValue type = 5;
+
+  // The revision ID of the schema. A new revision is committed whenever the schemas are changed.
+  google.protobuf.Int32Value revision = 6 [(.wix.api.readOnly) = true];
+
+  // Revision creation timestamp. when the represented revision was created.
+  google.protobuf.Timestamp created_date = 7 [(.wix.api.readOnly) = true];
+
+  // The user id who created this schema. Readonly.
+  google.protobuf.StringValue created_by = 8 [(.wix.api.format) = GUID, (.wix.api.readOnly) = true];
+
+  // Data extensions ExtendedFields.
+  wix.common.data.dataextensions.ExtendedFields extended_fields = 9;
+}
+
+// Single placement result
+message GetPlacementResponse {
+  Placement placement = 1;
+}
+
+// Create placement request
+message CreatePlacementRequest {
+  Placement placement = 1;
+}
+
+message CreatePlacementResponse {
+  Placement placement = 1;
+}
+
+// Partial update placement request
+message UpdatePlacementRequest {
+  Placement placement = 1;
+}
+
+message DuplicatePlacementRequest {
+  // required
+  string placement_id = 1 [(wix.api.format) = GUID];
+  bool duplicate_offers = 2;
+}
+
+message DuplicatePlacementResponse {
+  Placement placement = 1;
+}
+
+message UpdatePlacementResponse {
+  Placement placement = 1;
+}
+
+// Partial update placement request
+message UpdatePlacementSlugRequest {
+  google.protobuf.StringValue placement_guid = 1 [(wix.api.format) = GUID, (wix.api.readOnly) = true];
+  google.protobuf.StringValue slug = 2 [(wix.api.minLength) = 1];
+}
+
+message UpdatePlacementSlugResponse {
+  bool success = 1;
+}
+
+// List all placements request
+message ListPlacementsRequest {
+}
+
+// All placements result
+message ListPlacementsResponse {
+  repeated Placement placements = 1;
+}
+
+message GetPlacementsBulkRequest {
+  // required
+  repeated string placement_ids = 1 [(wix.api.format) = GUID];
+}
+
+message GetPlacementsBulkResponse {
+  repeated Placement placements = 1;
+}
+
+message UpdatePlacementStatusRequest {
+  google.protobuf.StringValue placement_guid = 1 [(wix.api.format) = GUID];
+  Placement.Status status = 2;
+}
+
+message UpdatePlacementStatusResponse {}
+
+message PublishPlacementRequest {
+  google.protobuf.StringValue placement_guid = 1 [(wix.api.format) = GUID];
+}
+
+message PublishPlacementResponse {
+  PublishStatus status = 1;
+  repeated PublishErrors errors = 2;
+
+  enum PublishStatus {
+    UNKNOWN = 0;
+    OK = 1;
+    FAILED = 2;
+  }
+
+  message PublishErrors {
+    string field = 1;
+    string description = 2;
+  }
+}
+
+// A Dealer placement is the area in a Wix page where we render some dealer asset(s)
+// i.e: "Dashboard Main - Top Right" is a dealer placement.
+// Placement can also be just a jsom schema with payload.
+// Placements usually contain multiple dealer offers sorted by "priority in placement".
+message Placement {
+  option (wix.api.entity) = {fqdn:"wix.dealer.v1.placement", segment: USERS};
+  // Unique placement guid
+  google.protobuf.StringValue guid = 1 [(wix.api.format) = GUID, (wix.api.readOnly) = true];
+
+  // BO placement name
+  google.protobuf.StringValue name = 2 [(wix.api.minLength) = 1];
+
+  // "Location" in UI — i.e. logical group, folder or label this placement belongs to.
+  // Every placement has a location (parent), for example the location of "Dashboard Main - Top Right"
+  // placement is "Business Manager"
+  google.protobuf.StringValue parent = 3 [(wix.api.minLength) = 1];
+
+  // The asset type of the placement.
+  // i.e: Asset type for the placement "Dashboard Main - Top Right" is "banner"
+  google.protobuf.StringValue asset_type = 4 [(wix.api.minLength) = 1];
+
+  reserved 6;
+
+  // Description of the placement
+  google.protobuf.StringValue description = 7;
+
+  // User oriented help text to show in UI. What is this placement for at Wix.
+  google.protobuf.StringValue best_for = 9;
+
+  // Who created the placement
+  // ignored when creating/updating placement - set by server
+  google.protobuf.StringValue created_by = 10 [(wix.api.format) = GUID, (wix.api.readOnly) = true];
+
+  // Who updated the placement
+  // ignored when creating/updating placement - set by server
+  google.protobuf.StringValue updated_by = 11 [(wix.api.format) = GUID, (wix.api.readOnly) = true];
+
+  // When created the placement
+  // ignored when creating/updating placement - set by server
+  google.protobuf.Timestamp created_date = 12 [(wix.api.readOnly) = true];
+
+  // WHen updated the placement
+  // ignored when creating/updating new placement - set by server
+  google.protobuf.Timestamp updated_date = 13 [(wix.api.readOnly) = true];
+
+  // URL to find placement
+  google.protobuf.StringValue url = 14;
+
+  // How to work with this placement (for PMMs)
+  google.protobuf.StringValue guidelines = 15;
+
+  google.protobuf.StringValue availability = 16;
+
+  // Unique human and URL friendly shortname of the placement
+  google.protobuf.StringValue slug = 17 [(wix.api.minLength) = 1];
+
+  // Frequency caps config of the placement. Works as a default value for all offers in the placement.
+  FrequencyCapsConfig frequency_caps_config = 18;
+
+  // Who are the managers of the placement in Wix
+  ManagerIdsWrapper managers_ids = 19;
+
+  // Asset schema of the placement.
+  // Different placements have different assets needed by dealer clients.
+  // This schema is a way to declare (edit, validate etc.) the structure of asset data.
+  // Contains the schema of this placement offers' assets data
+  // and schema of ui needed for editing this data.
+  Schema schema = 20;
+
+  // Does this placement work on User or Site level.
+  // Different kind of data is available to dealer runtime for site vs user level placements.
+  //
+  // For example requests to dealer runtime for "Site List Banner" placement lack metasiteId
+  // because the placement is shown outside of metasite context (USER level).
+  // But requests to "Payments Dashboard" placement are expected to have metasiteId value, because this is
+  // the SITE level placement
+  Level level = 21;
+
+  // Wether this placement is serving users new asset and UI for this placement has new creative screen
+  google.protobuf.BoolValue is_creative_v2_opt_in = 22;
+
+  ManagerLocalizationIdsWrapper localization_managers_ids = 23;
+
+  google.protobuf.BoolValue is_translatable = 24 [(wix.api.readOnly) = true];
+
+  reserved 25;
+
+  reserved 26;
+
+  // status of the placement
+  Status status = 27 [(wix.api.readOnly) = true];
+
+  message FrequencyCapsConfig {
+    // Placement level limits
+    FrequencyCaps frequency_caps = 1;
+    // List of dealer events supported (reported) by this placement
+    FrequencyCapsEvents supported_events = 2;
+  }
+
+  message Level {
+    LevelEnum value = 1;
+
+    enum LevelEnum {
+      UNKNOWN = 0;
+      USER = 1;
+      SITE = 2;
+    }
+  }
+
+  enum Status {
+    UNKNOWN = 0;
+    ACTIVE = 1;
+    CREATIVE_READ_ONLY = 2;
+    ARCHIVED = 3;
+    DRAFT = 4;
+  }
+
+  // Prioritization strategy config
+  PrioritizationStrategyConfig prioritization_strategy_config = 28;
+
+  message PrioritizationStrategyConfig {
+    oneof strategy_params {
+      wix.dealerPriority.api.v1.PrioritizationStrategyParams default_params = 1;
+
+      PrioritizationABTestStrategies ab_test_strategies = 2;
+
+      ShadowedStrategy shadowed_strategy = 3;
+    }
+
+    message PrioritizationABTestStrategies {
+      // the spec name of the test
+      string spec_name = 1 [(wix.api.minLength) = 1, (wix.api.maxLength) = 100];
+
+      wix.dealerPriority.api.v1.PrioritizationStrategyParams params_a = 2;
+      wix.dealerPriority.api.v1.PrioritizationStrategyParams params_b = 3;
+    }
+
+    message ShadowedStrategy {
+      wix.dealerPriority.api.v1.PrioritizationStrategyParams main_strategy = 1;
+      wix.dealerPriority.api.v1.PrioritizationStrategyParams shadowed_strategy = 2;
+    }
+  }
+
+  // Configuration for offers in placement
+  OffersConfig offers_config = 29;
+
+  message OffersConfig {
+    DateUnit maximum_live_time = 1;
+    message DateUnit {
+      google.protobuf.Int32Value days = 1;
+    }
+  }
+
+  PlacementType placement_type = 30;
+
+  google.protobuf.StringValue image_path = 31;
+
+  message PlacementType {
+    PlacementTypeEnum value = 1;
+
+    enum PlacementTypeEnum {
+      UNKNOWN = 0;
+      CREATIVE = 1;
+      CONFIGURATION = 2;
+    }
+  }
+}

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

@@ -0,0 +1,142 @@
+syntax = "proto3";
+
+package wix.dealerBackoffice.api.v1;
+
+import "google/api/annotations.proto";
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/struct.proto";
+
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/permissions.proto";
+import "wix/api/entity.proto";
+import "wix/api/callback.proto";
+
+
+import "wix/dealerBackoffice/api/v1/placements.proto";
+
+option java_package = "com.wix.dealerBackoffice.api.v1";
+
+service SchemaService {
+  option (.wix.api.service_maturity) = ALPHA;
+  option (.wix.api.service_exposure) = INTERNAL;
+  option (.wix.api.service_entity) = {
+    message: "wix.dealerBackoffice.api.v1.Schema"
+    namespace: "DealerPlacementSchema"
+  };
+
+  rpc GetSchema (GetSchemaRequest) returns (GetSchemaResponse) {
+    option (google.api.http).get = "/v1/dealer/backoffice/schemas/{schema_id}";
+    option (.wix.api.required) = "GetSchemaRequest.schema_id";
+    option (.wix.api.permission).name = "DEALER_BACKOFFICE.SCHEMA_READ";
+    option (wix.api.crud) = {
+      method: GET_ITEM
+      get_options: {
+        id_field: "schema_id"
+      }
+    };
+  }
+
+  rpc UpdateSchema (UpdateSchemaRequest) returns (UpdateSchemaResponse) {
+    option (google.api.http).put = "/v1/dealer/backoffice/schemas/{schema.id}";
+    option (.wix.api.required) = "UpdateSchemaRequest.schema.id";
+    option (.wix.api.required) = "UpdateSchemaRequest.schema.data_schema";
+    option (.wix.api.required) = "UpdateSchemaRequest.schema.ui_schema";
+    option (.wix.api.permission).name = "DEALER_BACKOFFICE.SCHEMA_UPDATE";
+  }
+
+  rpc CreateSchema (CreateSchemaRequest) returns (CreateSchemaResponse) {
+    option (.wix.api.crud) = {
+      method: CREATE
+      create_options: {
+        item_field: "schema"
+      }
+    };
+    option (wix.api.callback) = {
+      event_type: CREATED
+    };
+
+    option (google.api.http).post = "/v1/dealer/backoffice/schemas";
+    option (.wix.api.required) = "CreateSchemaRequest.schema.data_schema";
+    option (.wix.api.required) = "CreateSchemaRequest.schema.ui_schema";
+    option (.wix.api.permission).name = "DEALER_BACKOFFICE.SCHEMA_CREATE";
+  }
+
+  rpc ValidateSchema (ValidateSchemaRequest) returns (ValidateSchemaResponse) {
+    option (google.api.http).post = "/v1/dealer/backoffice/schemas/validate";
+    option (.wix.api.required) = "ValidateSchemaRequest.schema.data_schema";
+    option (.wix.api.required) = "ValidateSchemaRequest.schema.ui_schema";
+    option (.wix.api.permission).name = "DEALER_BACKOFFICE.SCHEMA_VALIDATE";
+  }
+}
+
+message CreateSchemaRequest {
+  Schema schema = 1;
+}
+
+message CreateSchemaResponse {
+  Schema schema = 1;
+  SchemaStatus status = 2;
+  repeated SchemaErrors errors = 3;
+
+  message SchemaErrors {
+    string field = 1;
+    string description = 2;
+  }
+
+  enum SchemaStatus {
+    UNKNOWN = 0;
+    OK = 1;
+    FAILED = 2;
+  }
+}
+
+message GetSchemaRequest {
+  string schema_id = 1 [(.wix.api.format) = GUID];
+}
+
+message GetSchemaResponse {
+  Schema schema = 1;
+}
+
+message UpdateSchemaRequest {
+  Schema schema = 1;
+}
+
+message UpdateSchemaResponse {
+  Schema schema = 1;
+  SchemaStatus status = 2;
+  repeated SchemaErrors errors = 3;
+
+  message SchemaErrors {
+    string field = 1;
+    string description = 2;
+  }
+
+  enum SchemaStatus {
+    UNKNOWN = 0;
+    OK = 1;
+    FAILED = 2;
+  }
+}
+
+message ValidateSchemaRequest {
+  Schema schema = 1;
+}
+
+message ValidateSchemaResponse {
+  SchemaStatus status = 1;
+  repeated SchemaErrors errors = 2;
+
+  message SchemaErrors {
+    string field = 1  [(wix.api.minLength) = 1, (wix.api.maxLength) = 100];
+    string description = 2 [(wix.api.minLength) = 1, (wix.api.maxLength) = 9999];
+  }
+
+  enum SchemaStatus {
+    UNKNOWN = 0;
+    OK = 1;
+    FAILED = 2;
+  }
+}