@wix/bex-utils 2.71.0 → 2.73.0

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

@@ -0,0 +1,37 @@
+syntax = "proto3";
+
+package wix.dealerBackoffice.api.v1.upstream.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.dealerBackoffice.api.v1.upstream.wix.common";
+
+message Sorting {
+    option (.wix.api.decomposite_of) = "wix.common.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/dealerOffersServing/api/v1/dealer-offers-debug.proto

@@ -0,0 +1,188 @@
+syntax = "proto3";
+
+package wix.dealerOffersServing.api.v1;
+
+import "google/api/annotations.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/entity.proto";
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/timestamp.proto";
+import "wix/api/permissions.proto";
+
+import "wix/dealerOffersServing/api/v1/offer.proto";
+import "wix/dealerBackoffice/api/v1/targeting.proto";
+import "wix/dealerBackoffice/api/v1/frequency-caps.proto";
+import "wix/personalize/targeting/v1/targeting.proto";
+
+option java_package = "com.wix.dealerOffersServing.api.v1";
+
+// Endpoint for evaluating dealer runtime results explicitly and understanding why user was eligible or not to an offer.
+service DealerOffersDebug {
+  option (wix.api.service_entity).message = "wix.dealerOffersServing.api.v1.Offer";
+  option (wix.api.service_maturity) = ALPHA;
+  option (wix.api.service_exposure) = PRIVATE;
+
+  // Debug offer in a given context.
+  // Will return the offer and its audience result.
+  // Only for permitted users.
+  // Context is always explicit and can contains information such as userId, siteId, loggedInAccounnt etc.
+  rpc DebugOffer (DebugOfferRequest) returns (DebugOfferResponse) {
+    option (wix.api.maturity) = ALPHA;
+    option (google.api.http) = {
+      post: "/v1/dealer/debug/offers/{offer_id}/debug"
+      additional_bindings: {
+        get: "/v1/dealer/debug/offers/{offer_id}"
+      }
+    };
+    option (wix.api.permission).name = "DEALER.DEBUG";
+    option (wix.api.required) = "DebugOfferRequest.offer_id";
+  }
+
+  // Get a single offer with creative.
+  rpc GetOffer (GetOfferRequest) returns (GetOfferResponse) {
+    option (google.api.http).get = "/v1/dealer/debug/offer/{offer_id}";
+    option (wix.api.permission).name = "DEALER.DEBUG";
+    option (wix.api.required) = "GetOfferRequest.offer_id";
+  }
+}
+
+// Input params for evaluating an offer.
+message DebugOfferRequest {
+  // Offer guid to debug
+  string offer_id = 1;
+
+  // Explicit request params. Required.
+  RequestContext context = 2;
+
+  // List of custom param's values, some offers are targeted by those values. Optional.
+  repeated CustomParam custom_params = 3;
+}
+
+// Input params for evaluating the offer's creative.
+message GetOfferRequest {
+  // Offer guid to evaluate
+  string offer_id = 1;
+
+  // Explicit request context params. Optional.
+  RequestContext context = 2;
+}
+
+message DebugOfferResponse {
+  // Offer being inspected
+  Offer offer = 1;
+
+  // Offer targeting tree inflated with execution results
+  wix.dealerBackoffice.api.v1.Targeting targeting = 2 [deprecated = true, (.wix.api.field_deprecated) = {
+    // Property is deprecated and replaced by TargetingTree
+    replaced_by: "targeting_tree"
+    target_removal_date: "2024-09-01"
+  }];
+
+  // General release rules results such as experiment and offer status
+  ReleaseAudience release_audience = 6;
+
+  // Debug results for this offer frequency caps (null if no FC applicable)
+  FrequencyCapsExecutionResult frequency_caps_execution_result = 7;
+
+  // Nile targeting tree with execution results
+  wix.personalize.targeting.v1.TargetingTree targeting_tree = 8;
+}
+
+// Return the requested offer with personalized content for given request params & aspects.
+message GetOfferResponse {
+  // Offer being inspected
+  Offer offer = 1;
+}
+
+// Results of an offer frequency caps evaluation.
+message FrequencyCapsExecutionResult {
+  // true — the offer is eligible based on frequency caps limits
+  // false — the offer is limited (not returned from runtime) by frequency caps conditions
+  bool offerEligible = 1;
+
+  // The offer's frequency caps config being applied (either placement level FC or the offer's)
+  wix.dealerBackoffice.api.v1.FrequencyCaps frequency_caps = 2;
+
+  // Frequency caps conditions with values set to current offer+user+metasite+events data
+  FrequencyCapsConditionsResult conditions_execution_result = 3;
+}
+
+// Execution result per each FC limit type, currentValue is human readable representation of actual data
+// success = true means limit has not been reached (offer is eligible according to this limit)
+message FrequencyCapsConditionsResult {
+  // Number of total VIEW events
+  wix.dealerBackoffice.api.v1.ExecutionResult views = 1;
+  // Number of total MAIN_CTA events
+  wix.dealerBackoffice.api.v1.ExecutionResult main_cta_clicks = 2;
+  // Number of total SKIP events
+  wix.dealerBackoffice.api.v1.ExecutionResult skips = 3;
+  // Number of total CLOSE events
+  wix.dealerBackoffice.api.v1.ExecutionResult closes = 4;
+  // Number of total SHOW_LATER events
+  wix.dealerBackoffice.api.v1.ExecutionResult show_later = 5;
+}
+
+// Explicit context to simulate real user requests to runtime.
+message RequestContext {
+  // User guid. Optional.
+  google.protobuf.StringValue user_id = 1 [(wix.api.format) = GUID];
+
+  // Target account. Optional.
+  google.protobuf.StringValue target_account_id = 2 [(wix.api.format) = GUID];
+
+  // Logged in account. Optional.
+  google.protobuf.StringValue logged_in_account_id = 3 [(wix.api.format) = GUID];
+
+  // Metasite id. Optional.
+  google.protobuf.StringValue site_id = 4 [(wix.api.format) = GUID];
+
+  // User's two letters geo ("il", "us")
+  google.protobuf.StringValue geo = 5;
+
+  // User's two letters language ("en", "fr")
+  google.protobuf.StringValue language = 6;
+
+  reserved 7;
+  reserved 8;
+
+  // Nile targeting brand
+  wix.personalize.targeting.v1.BrandsCriteria.Brand brand_value = 9;
+}
+
+// Current offer eligibility status related data:
+// - offer's availability for all users or employees only
+// - current timeframe eligibility
+// - offer's petri experiment based eligibility
+//
+message ReleaseAudience {
+  // Who can see the offer (wix staff vs all users)
+  Status release_status = 1;
+
+  // Execution result of release_status filter (if current audience match offer's one)
+  wix.dealerBackoffice.api.v1.ExecutionResult release_execution_result = 11;
+
+  // The offer is active from this timestamp
+  google.protobuf.Timestamp time_start = 2;
+  // The offer is inactive after this timestamp
+  google.protobuf.Timestamp time_stop = 3;
+
+  // If current time is inside the offer timeframe
+  wix.dealerBackoffice.api.v1.ExecutionResult time_execution_result = 12;
+
+  // If offer is active only for some petri experiment - here is its key
+  google.protobuf.StringValue experiment_key = 4;
+  // If offer is active only for some petri experiment - here is its required value
+  google.protobuf.StringValue experiment_value = 5;
+
+  // If given user petri experiment matches offer's value
+  wix.dealerBackoffice.api.v1.ExecutionResult experiment_execution_result = 13;
+
+  // Target release audience scope of the offer
+  enum Status {
+    UNKNOWN = 0;
+    ALL = 1;
+    WIX_EMPLOYEE = 2;
+  }
+}
+

package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerOffersServing/api/v1/dealer-offers-serving.proto

@@ -0,0 +1,177 @@
+syntax = "proto3";
+
+package wix.dealerOffersServing.api.v1;
+
+import "google/api/annotations.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/entity.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/permissions.proto";
+
+import "wix/dealerOffersServing/api/v1/offer.proto";
+import "wix/dealerBackoffice/api/v1/frequency-caps.proto";
+import "wix/dealerBackoffice/api/v1/placements.proto";
+
+option java_package = "com.wix.dealerOffersServing.api.v1";
+
+// Main runtime endpoint of the Dealer.
+// TODO: add explicit permission
+// https://bo.wix.com/wix-docs/rnd/platformization-guidelines/authorization-&-permissions#platformization-guidelines_authorization-&-permissions_1-in-your-proto-files
+service DealerOffersServing {
+  option (wix.api.service_entity).message = "wix.dealerOffersServing.api.v1.Offer";
+  option (wix.api.service_maturity) = GA;
+  option (wix.api.service_exposure) = INTERNAL;
+
+  // Get all offers the user or site are eligible for.
+  // A realEstateId (placementId) defines the product location of the offers and is always required,
+  // Context is taken implicitly from request with authorization header and wix session.
+  rpc ListOffers (ListOffersRequest) returns (ListOffersResponse) {
+    option (google.api.http) = {
+      post: "/v1/dealer/serving/offers/list"
+      additional_bindings: {
+        get: "/v1/dealer/serving/offers"
+      }
+    };
+    option (wix.api.required) = "ListOffersRequest.real_estate_id";
+  }
+
+  // Get a single offer if the user or site are eligible for.
+  // Context is taken implicitly from request with authorization header and wix session.
+  rpc ResolveOffer (ResolveOfferRequest) returns (ResolveOfferResponse) {
+    option (google.api.http) = {
+      post: "/v1/dealer/serving/offer/resolve"
+      additional_bindings: {
+        get: "/v1/dealer/serving/offer/resolve"
+      }
+    };
+    option (wix.api.required) = "ResolveOfferRequest.offer_id";
+  }
+
+  // Get all offers the user or site are eligible for.
+  // This is a bulk request for more then one realEstate (placement),
+  // max limit of 30 offers is applied for each placement.
+  // Context is taken implicitly from request with authorization header and wix session.
+  rpc ListOffersBulk (ListOffersBulkRequest) returns (ListOffersBulkResponse) {
+    option (google.api.http) = {
+      post: "/v1/dealer/serving/offers/bulk"
+      additional_bindings: {
+        get: "/v1/dealer/serving/offers/bulk"
+      }
+    };
+    option (wix.api.required) = "ListOffersBulkRequest.real_estate_ids";
+  }
+}
+
+// Params required to list offers for given placement (real estate).
+message ListOffersRequest {
+  // Dealer placement guid (product location). Required.
+  string real_estate_id = 1;
+
+  // Only <= limit number of offers returned if more are applicable. Optional, default limit is 30 offers
+  google.protobuf.Int32Value limit = 2;
+
+  // Which offers to exclude from results. Optional.
+  repeated string exclude_offer_ids = 3 [(wix.api.format) = GUID];
+
+  reserved 4;
+
+  // DEPRECATED - plz use server signer.
+  // Optional - override specific fields that by default coming from aspects
+  // if not set will be taken implicitly from request
+  RequestExtensions extensions = 5;
+
+  // Deviant Art specific use-case: signed jwt token with uuid of deviant art user in wix bi infra
+  google.protobuf.StringValue deviant_art_user_id = 6;
+
+  // List of custom param's values, some offers are targeted by those values. Optional
+  repeated CustomParam custom_params = 7;
+
+  // Optional - Enable to override or abort frequency caps configuration
+  // if not set, the default offer or placement frequency caps hierarchy will be used (if configured)
+  FrequencyCapsRequestOverrides frequency_caps_overrides = 8;
+
+  // SkipTargeting flag allows bypassing the targeting validation and retrieving all live offers, regardless of user/site eligibility. Optional.
+  google.protobuf.BoolValue skip_targeting = 9;
+
+  // Optional - Enable to override the placement default prioritization strategy configuration
+  PrioritizationStrategyOverrides prioritization_strategy_overrides = 10;
+
+  message FrequencyCapsRequestOverrides {
+    //Set of frequency caps conditions to use in the request
+    //Set as null if you want to abort the frequency caps for this request (this will also follow the override type behaviour)
+    wix.dealerBackoffice.api.v1.FrequencyCaps.Conditions conditions = 1;
+    //Mandatory - this controls the conditions overrides behaviour and must be one of those 2 types:
+    //PLACEMENT_LEVEL - Will only be applied for offers without frequency caps
+    //OFFER_LEVEL - Will be applied to all offers with or without frequency caps
+    FrequencyCapsOverridesType type = 2;
+
+    enum FrequencyCapsOverridesType {
+      UNKNOWN = 0;
+      PLACEMENT_LEVEL = 1;
+      OFFER_LEVEL = 2;
+    }
+  }
+
+  message PrioritizationStrategyOverrides {
+    // Set of prioritization strategy conditions to use in the request
+    wix.dealerBackoffice.api.v1.Placement.PrioritizationStrategyConfig prioritization_strategy_config = 1;
+  }
+}
+
+// Params required to list offers for multiple placements (real estates) in a single call.
+message ListOffersBulkRequest {
+
+  // List of dealer real estates (placements). Required.
+  repeated string real_estate_ids = 1 [(wix.api.minSize) = 1];
+
+  // Excluded offer ids will never be returend to the user. Optional
+  repeated string exclude_offer_ids = 2 [(wix.api.format) = GUID];
+
+  reserved 3;
+
+  // DEPRECATED
+  // This data overrides specific fields coming from aspects if not set will be taken implicitly from request.
+  // Optional.
+  RequestExtensions extensions = 4;
+
+  // List of custom param's values, some offers are targeted by those values. Optional.
+  repeated CustomParam custom_params = 5;
+
+  // SkipTargeting flag allows bypassing the targeting validation and retrieving all live offers, regardless of user/site eligibility. Optional.
+  google.protobuf.BoolValue skip_targeting = 6;
+}
+
+// Input params for evaluating the offer.
+message ResolveOfferRequest {
+  // Offer guid to evaluate
+  string offer_id = 1;
+
+  // List of custom param's values, some offers are targeted by those values. Optional
+  repeated CustomParam custom_params = 2;
+}
+
+
+// DEPRECATED
+// Explicit metasite id request option.
+message RequestExtensions {
+  // User needs permission DEALER.OFFERS_SERVING_SITE_TARGETING to pass it. Optional.
+  google.protobuf.StringValue site_id = 1 [(wix.api.format) = GUID];
+}
+
+// All eligible offers with personalized content for given request params & aspects.
+message ListOffersResponse {
+  // Offers eligible for correspondent request at the moment of the call
+  repeated Offer offers = 1;
+}
+
+// Return the requested offer (if eligible) with personalized content for given request params & aspects.
+message ResolveOfferResponse {
+  // Offer being inspected
+  Offer offer = 1;
+}
+
+message ListOffersBulkResponse {
+  // a map from realEstate(placement) id to list of offers
+  map<string, ListOffersResponse> real_estates = 1;
+}

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

@@ -0,0 +1,87 @@
+syntax = "proto3";
+
+package wix.dealerOffersServing.api.v1;
+
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/timestamp.proto";
+import "wix/api/entity.proto";
+import "wix/api/validations.proto";
+import "google/protobuf/struct.proto";
+
+option java_package = "com.wix.dealerOffersServing.api.v1";
+
+// Main dealer runtime entity. Always belongs to some placement (real estate) and represents specific set of data
+// intended to be returned conditionally from dealer runtime for given input (user, aspects, time etc.).
+// Main source of the conditions is targeting property, which holds the rules.
+message Offer {
+  option (wix.api.entity).fqdn = "wix.dealer.v1.serving_offer";
+
+  // Unique offer id
+  string offer_guid = 1 [(wix.api.format) = GUID];
+
+  // Dealer real estate (placement) id
+  string real_estate_id = 2;
+
+  // Backoffice name of offer (not needed for users, but needed for PMMs to distinguish one offer from another in BO UI)
+  string offer_name = 3;
+
+  reserved 4;
+
+  // Offer data payload (actual things clients show to user in some form)
+  Asset asset = 5;
+
+  reserved 6;
+
+  // Dealer campaign this offer belongs to (optional)
+  google.protobuf.StringValue campaign_id = 7;
+
+  // The date the offer was created or scheduled to — not related to date of activation
+  google.protobuf.Timestamp start_date = 8;
+
+  // The date this offers is intended to stop at
+  google.protobuf.Timestamp end_date = 9;
+
+  // Prioritziation metadata
+  google.protobuf.Struct priority_metadata = 10;
+}
+
+// Actual offer content to show to user or use by dealer clients. For example strings to show to user in some widget,
+// banner id to show, etc.
+message Asset {
+  // DEPRECATED - The personlized content for the user - json string
+  // The field wont be avilable for new placements that were created after 8.11
+  string payload_json = 1;
+
+  // Key<->Value dynamic params defined in BO
+  // the key is the interpolation key and the value is stringify json
+  // for example {myKeyWithMail:"'menir@wix.com'", keyWithNumberValue:"55", keyWithBool:"false"}
+  // in client side you will need to json parse in order to get correct data types.
+  // Returns only dynamic params that has some value
+  map<string, string> dynamic_params = 2;
+
+  // Same array of key<->value translations as in BO, but only for 1 client language-country
+  // DEPRECATED, used for New Releases only
+  reserved 3;
+
+  // The personlized and localized content for the user - json object mataching the placement schema.
+  // Avilable only on new placements that were created after 8.11 or on placement that were migrated to use new creative infra
+  google.protobuf.Struct creative = 4;
+
+}
+
+// DEPRECATED, used for New Releases only.
+// List of offers localized strings, defined in BO on offer creation/update.
+// Runtime returns only user language-country localized values (or "en" as fallback)
+// while BO API can give you full list of strings in all locales
+message LocalizedData {
+  // string key -> content map
+  map<string, string> translations = 1;
+}
+
+// Custom params object used as additional data input for runtime/debug endpoint calls.
+message CustomParam {
+  // unique key for custom param
+  google.protobuf.StringValue key = 1;
+  // current request value or values for given key
+  repeated google.protobuf.StringValue values = 2;
+}

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

@@ -0,0 +1,57 @@
+syntax = "proto3";
+
+package wix.dealerPriority.api.v1;
+
+import "google/api/annotations.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/struct.proto";
+
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/permissions.proto";
+import "wix/api/api_errors.proto";
+import "wix/api/entity.proto";
+import "wix/common/query.proto";
+import "wix/common/paging.proto";
+
+import "wix/dealerPriority/api/v1/priority.proto";
+
+option java_package = "com.wix.dealerPriority.api.v1";
+
+service PriorityService {
+  option (wix.api.service_entity).message = "wix.dealerPriority.api.v1.PriorityItem";
+  option (wix.api.service_maturity) = ALPHA;
+  option (wix.api.service_exposure) = INTERNAL;
+
+  rpc Prioritize (PrioritizeRequest) returns (PrioritizeResponse) {
+    option (google.api.http).post = "/v1/prioritize";
+    option (wix.api.required) = "PrioritizeRequest.items";
+  }
+}
+
+message PrioritizeRequest {
+  repeated PriorityItem items = 1;
+
+  reserved 2;
+
+  Context context = 3;
+
+  PrioritizationStrategyParams strategy_params = 4;
+}
+
+message PrioritizeResponse {
+  repeated ItemPrioritized prioritization = 1;
+}
+
+// Explicit context to simulate user requests.
+message Context {
+  // User guid. Optional.
+  google.protobuf.StringValue user_id = 1 [(wix.api.format) = GUID];
+
+  // Client id. Optional.
+  google.protobuf.StringValue client_id = 2 [(wix.api.format) = GUID];
+
+  // Placement ID of the placement associated with the offers that need to be prioritized.
+  google.protobuf.StringValue placement_id = 3 [(wix.api.format) = GUID];
+}

package/@wix/ambassador-dealer-v1-serving-offer/src/main/proto/wix/dealerPriority/api/v1/priority.proto

@@ -0,0 +1,132 @@
+syntax = "proto3";
+
+package wix.dealerPriority.api.v1;
+
+import "wix/api/permissions.proto";
+import "google/api/annotations.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/struct.proto";
+
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/entity.proto";
+
+option java_package = "com.wix.dealerPriority.api.v1";
+
+message PriorityItem {
+  option (wix.api.entity) = {fqdn:"wix.dealer.v1.priority_item", segment: USERS};
+
+  google.protobuf.StringValue item_id = 1 [(wix.api.format) = GUID];
+
+  google.protobuf.Int32Value weight = 2;
+}
+
+message ItemPrioritized {
+  google.protobuf.StringValue item_id = 1 [(wix.api.format) = GUID];
+
+  google.protobuf.Int32Value priority = 2;
+
+  google.protobuf.Struct metadata = 3;
+}
+
+enum PrioritizationStrategy {
+  UNKNOWN = 0;
+
+  // Manual - Prioritize by weight of the items.
+  // - The items with the largest weight will have the highest priority
+  // - Undefined weights will have the lowest priority
+  MANUAL = 1;
+
+  // CTR based, item prioritized from highest CTR to the lowest
+  CTR = 2;
+
+  // Random based item prioritization
+  RANDOM = 3;
+
+  // AB test based item prioritization
+  ABCTR = 4;
+
+  // Premium based item prioritization
+  PremiumCTR = 5;
+
+  // ML Model item prioritization
+  MLModel = 6;
+
+  // LLM Model item prioritization
+  reserved 7;
+
+  // Whats Next item prioritization
+  reserved 8;
+
+  // Advices item prioritization
+  ADVICES = 9;
+
+  // Collections based item prioritization
+  COLLECTIONS = 10;
+}
+
+message PrioritizationStrategyParams {
+  PrioritizationStrategy strategy = 1;
+
+  // Learning rate for the supporting strategy
+  // should be between 0 and 1
+  google.protobuf.StringValue learning_allocation = 2 [(.wix.api.decimalValue) = { gte: "0.000", lte: "1", maxScale: 3 }];
+
+  //flynt-disable field-type-breaking-change
+  repeated FixedItem fixed_items = 5 [(.wix.api.maxSize) = 20];
+
+  message FixedItem {
+    string item_id = 1 [(wix.api.format) = GUID];
+    int32 priority = 2;
+  }
+
+  oneof Configuration {
+    ABCTRConfig ab_ctr_config = 3;
+
+    WHATSNEXTConfig whats_next_config = 4;
+
+    AdvicesConfig advices_config = 6;
+  }
+
+  message ABCTRConfig {
+    google.protobuf.StringValue spec_name = 1;
+  }
+
+  message WHATSNEXTConfig {
+    google.protobuf.Struct custom_params = 1;
+  }
+
+  message AdvicesConfig {
+    reserved 1;
+
+    google.protobuf.StringValue vespa_threshold = 2 [(.wix.api.decimalValue) = { gte: "0.000", lte: "1", maxScale: 3 }];
+
+    PrioritizationStrategy fallback_strategy = 3;
+
+    oneof AdvicesCustomConfig {
+      WhatsNextConfiguration whats_next_custom_params = 4;
+
+      Advices advices = 5;
+    }
+
+    message Advices {
+      repeated string advices = 1 [(.wix.api.maxSize) = 20];
+    }
+
+    message WhatsNextConfiguration {
+      // customParams - Custom parameters to be used for the WhatsNext Completion.
+      google.protobuf.Struct custom_params = 1;
+
+      // The fixed number of advices to be returned.
+      // Default: 5
+      // flynt-disable field-type-breaking-change
+      google.protobuf.Int32Value total_advices = 2;
+
+      // llmTimeout - The maximum time to wait for the WhatsNext Completion.
+      // Maximum 10 seconds, WIX Cancels requests after 10 seconds.
+      // Represented in milliseconds.
+      int32 llm_timeout_in_ms = 3 [(.wix.api.min) = 0, (.wix.api.max) = 10000];
+    }
+  }
+}