@wix/bex-utils 2.4.0 → 2.5.0

package/@wix/ambassador-devcenter-app-market-listing-v1-market-listing/src/main/proto/components_catalog_data/pricing_plans_form_configuration.proto

@@ -0,0 +1,655 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+
+message PricingPlansFormConfiguration {
+  reserved 1, 2;
+  // "Plan preview" section configuration.
+  PlanFormPreviewSection plan_preview = 3;
+  // "Plan info" section configuration
+  PlanFormInfoSection info_section = 4;
+  // "Settings" section configuration
+  PlanFormPlanSettingsSection settings_section = 5;
+  // "Benefits" section configuration
+  PlanFormBenefitsSection benefits_section = 6;
+  // "Pricing options" section configuration
+  PlanFormPricingAndDurationSection pricing_and_duration_section = 7;
+  // Custom sections to render inside the form
+  repeated PlanFormCustomSection custom_sections = 8 [(wix.api.maxSize) = 99];
+  // Order, in which sections will be rendered. Can include default section ids or custom section component ids.
+  // Visible sections that don't exist in this array will be displayed below others, in default oder.
+  repeated PlanFormSection section_order = 9 [(wix.api.maxSize) = 99];
+  // Information about custom plan form
+  PlanFormTypeMetadata metadata = 10;
+
+  reserved 11;
+
+  // "Page permissions" section configuration
+  PlanFormPagePermissionsSection page_permissions = 12;
+  // Initial plan data to prefill in the form
+  PlanFormInitialValue initial_plan_value = 13;
+  // Custom form name (e.g., 'bookings-membership'). Should be unique within the app
+  string form_name = 14 [(wix.api.minLength) = 1, (wix.api.maxLength) = 100];
+
+  message PlanFormPreviewSection {
+    // Hide Preview section. If set to `true`, remaining fields will be ignored
+    bool hide = 1;
+
+    reserved 2;
+
+    // Preview card title
+    TextWithTooltip title = 3;
+    // Preview card subtitle
+    TextWithSuffix subtitle = 4;
+    // Placeholder overrides for previewed plan 
+    PreviewCardPlaceholders placeholders = 5;
+    // Stick Preview section to the right while scrolling. Makes rest of the sections narrower.
+    google.protobuf.BoolValue is_sticky = 6;
+
+    message PreviewCardPlaceholders {
+      // Placeholder plan name for preview, e.g. "Untitled Package"
+      string name = 1 [(wix.api.translatable) = {
+        type: SHORT_TEXT,
+        grouping: ""
+      }];
+    };
+  }
+
+  message PlanFormInfoSection {
+    // Hide Info section. If set to `true`, remaining fields will be ignored
+    bool hide = 1;
+    // Tooltip title
+    TextWithTooltip title = 2;
+    // Tooltip subtitle
+    TextWithSuffix subtitle = 3;
+    // Plan name input configuration
+    InputWithPlaceholder name = 4;
+    // Plan tagline input configuration
+    InputWithPlaceholder tagline = 5;
+    // Plan cover image input configuration
+    CoverImageConfiguration cover_image = 6;
+    // Plan perks subsection configuration
+    PerksConfiguration perks = 7;
+
+    message CoverImageConfiguration {
+      // Hide cover image input. If set to `true`, remaining fields will be ignored
+      bool hide = 1;
+      // Cover image input label
+      TextWithTooltip label = 2;
+    }
+
+    message PerksConfiguration {
+      // Hide Perks subsection. If set to `true`, remaining fields will be ignored
+      bool hide = 1;
+      // Perks subsection title
+      TextWithTooltip title = 2;
+      // Perks input placeholder
+      string placeholder = 3 [(wix.api.translatable) = {
+        type: SHORT_TEXT
+        grouping: ""
+      }];
+    }
+  }
+
+  message PlanFormPlanSettingsSection {
+    // Hide "Advanced settings" section. If set to `true`, remaining fields will be ignored
+    bool hide = 1;
+    // Section title configuration
+    TextWithTooltip title = 2;
+    // Section subtitle configuration
+    TextWithSuffix subtitle = 3;
+    // Configuration for "Limit to 1 purchase per person" plan setting
+    PlanSettingsRowConfiguration single_purchase = 4;
+    // Configuration for "Allow plan cancellation" plan setting
+    PlanSettingsRowConfiguration allow_cancellation = 5;
+    // Configuration for "Let people set start date" plan setting
+    PlanSettingsRowConfiguration custom_start_date = 6;
+    // Configuration for "Add a policy" plan setting
+    TermsAndConditionsConfiguration terms_and_conditions = 7;
+    // Configuration for "Collect additional info" plan setting
+    PlanSettingsRowConfiguration custom_forms = 8;
+    // Configuration for "Customize a Thank You page" plan setting
+    ThankYouPageConfiguration thank_you_page = 9;
+
+    message PlanSettingsRowConfiguration {
+      // Hide row. If set to `true`, remaining fields will be ignored
+      bool hide = 1;
+      // Row title
+      TextWithTooltip title = 2;
+      // Row subtitle
+      TextWithTooltip subtitle = 3;
+    }
+
+    message TermsAndConditionsConfiguration {
+      // Hide row. If set to `true`, remaining fields will be ignored
+      bool hide = 1;
+      // Row title
+      TextWithTooltip title = 2;
+      // Row subtitle
+      TextWithTooltip subtitle = 3;
+      // "Plan policies" modal configuration
+      TermsModalConfiguration modal = 4;
+      message TermsModalConfiguration {
+        // Modal title
+        string title = 1 [(wix.api.translatable) = {
+          type: SHORT_TEXT,
+          grouping: ""
+        }];   
+        // Modal subtitle
+        string subtitle = 2 [(wix.api.translatable) = {
+          type: SHORT_TEXT,
+          grouping: ""
+        }];   
+        // "Save" button text
+        string primary_button_text = 3 [(wix.api.translatable) = {
+          type: SHORT_TEXT,
+          grouping: ""
+        }];   
+        // "Cancel" button text
+        string secondary_button_text = 4 [(wix.api.translatable) = {
+          type: SHORT_TEXT,
+          grouping: ""
+        }];
+        // "Terms and conditions" input configuration
+        InputWithPlaceholder input = 5;
+        // "Policy agreement checkbox" input configuratino
+        CheckboxConfiguration checkbox = 6;
+        // Terms and conditions preview configuration
+        PreviewConfiguration preview = 7;
+        // Modal footer text
+        string footer = 8 [(wix.api.translatable) = {
+          type: SHORT_TEXT,
+          grouping: ""
+        }];
+
+        message CheckboxConfiguration {
+          // "Policy agreement checkbox" input label
+          string label = 1 [(wix.api.translatable) = {
+            type: SHORT_TEXT,
+            grouping: ""
+          }];
+          // "Policy checkbox" toggle configuration
+          TextWithTooltip accept_required_toggle = 2;
+          // "Checked by default" toggle configuration
+          TextWithTooltip accepted_by_default_toggle = 3;
+        }
+
+        message PreviewConfiguration {
+          // Preview card title
+          string title = 1 [(wix.api.translatable) = {
+            type: SHORT_TEXT,
+            grouping: ""
+          }];
+          // Preview card subtitle
+          string subtitle = 2 [(wix.api.translatable) = {
+            type: SHORT_TEXT,
+            grouping: ""
+          }];
+          // Label for checkbox in preview
+          string checkbox_label = 3 [(wix.api.translatable) = {
+            type: SHORT_TEXT,
+            grouping: ""
+          }];
+          // Text for "Buy now" in preview
+          string button_text = 4 [(wix.api.translatable) = {
+            type: SHORT_TEXT,
+            grouping: ""
+          }];
+        }
+      }
+    }
+
+    message ThankYouPageConfiguration {
+      // Hide row. If set to `true`, remaining fields will be ignored
+      bool hide = 1;
+      // Row title
+      TextWithTooltip title = 2;
+      // Row subtitle
+      TextWithTooltip subtitle = 3;
+      // "Thank you page" modal configuration
+      ThankYouPageModalConfiguration modal = 4;
+
+      message ThankYouPageModalConfiguration {
+        // Modal title
+        string title = 1 [(wix.api.translatable) = {
+          type: SHORT_TEXT,
+          grouping: ""
+        }];
+        // Modal subtitle
+        TextWithSuffix subtitle = 2;
+        // "Save" button text
+        string primary_button_text = 3 [(wix.api.translatable) = {
+          type: SHORT_TEXT,
+          grouping: ""
+        }];
+        // "Cancel" button text
+        string secondary_button_text = 4 [(wix.api.translatable) = {
+          type: SHORT_TEXT,
+          grouping: ""
+        }];
+        // "Reset to default" button text
+        string reset_button_text = 5 [(wix.api.translatable) = {
+          type: SHORT_TEXT,
+          grouping: ""
+        }];
+        // Thank you page title input configuration
+        ThankYouPageInputConfig title_input = 6;
+        // Thank you page content input configuration
+        ThankYouPageInputConfig message_input = 7;
+        // Thank you page button text input configuration
+        ThankYouPageInputConfig button_text_input = 8;
+        // Thank you page button action field configuration
+        ThankYouPageRedirectsConfiguration redirects = 9;
+        // Thank you page preview configuration
+        ThankYouPagePreviewConfiguration preview = 10;
+
+        message ThankYouPageRedirectsConfiguration {
+          // Hide "Redirects". If set to `true`, remaining fields will be ignored
+          bool hide = 1;
+          // "Redirects" field label
+          TextWithTooltip label = 2;
+          // "Homde Page" option label
+          string home_page_option = 3 [(wix.api.translatable) = {
+            type: SHORT_TEXT,
+            grouping: ""
+          }];
+          // "Other Page" option label
+          string redirect_url_option = 4 [(wix.api.translatable) = {
+            type: SHORT_TEXT,
+            grouping: ""
+          }];
+        }
+
+        message ThankYouPagePreviewConfiguration {
+          // Preview card title
+          string title = 1 [(wix.api.translatable) = {
+            type: SHORT_TEXT,
+            grouping: ""
+          }];
+          // Preview card subtitle
+          string subtitle = 2 [(wix.api.translatable) = {
+            type: SHORT_TEXT,
+            grouping: ""
+          }];
+        }
+
+        message ThankYouPageInputConfig {
+          // Hide input. If set to `true`, remaining fields will be ignored
+          bool hide = 1;
+          // Label config
+          TextWithTooltip label = 2;
+        }
+      }
+    }
+  }
+
+  message PlanFormBenefitsSection {
+    // Hide Benefits section. If set to `true`, remaining fields will be ignored
+    bool hide = 1;
+    // Benefits section title
+    TextWithTooltip title = 2;
+    // Benefits section subtitle
+    TextWithSuffix subtitle = 3;
+    // Suffix link configuration. Rendered at the right side of section header
+    LinkSuffix suffix = 4;
+    // Hide specific benefits from section
+    repeated string hidden_benefits = 5 [(wix.api.maxSize) = 99];
+  }
+
+  message PlanFormPricingAndDurationSection {
+    // Hide Pricing and Duration section. If set to `true`, remaining fields will be ignored
+    bool hide = 1;
+    // Section title
+    TextWithTooltip title = 2;
+    // Section subtitle
+    TextWithSuffix subtitle = 3;
+    // "Free" pricing option configuration
+    FreeOptionConfiguration free_pricing_option = 4;
+    // "One-time payment" pricing option configuration
+    OneTimeOptionConfiguration one_time_option = 5;
+    // "Recurring" pricing option configuration
+    RecurringOptionConfiguration recurring_option = 6;
+    // Order, in which pricing options should be displayed
+    repeated PlanFormPricingOption pricing_option_order = 7 [(wix.api.maxSize) = 99];
+
+    message FreeOptionConfiguration {
+      // Hide free option. If set to `true`, remaining fields will be ignored
+      bool hide = 1;
+      // Option title
+      string title = 2 [(wix.api.translatable) = {
+        type: SHORT_TEXT
+        grouping: ""
+      }];
+      // Option subtitle
+      string subtitle = 3 [(wix.api.translatable) = {
+        type: SHORT_TEXT
+        grouping: ""
+      }];
+      // Plan duration dropdown configuration
+      DurationInputConfiguration duration = 4;
+      // Custom duration period dropdown configuration
+      InputConfiguration custom_duration_period = 5;
+      // Custom  duration input configuration
+      InputConfiguration custom_duration_input = 6;
+
+      reserved 7;
+    }
+
+    message OneTimeOptionConfiguration {
+      // Hide "One-time payment" option. If set to `true`, remaining fields will be ignored
+      bool hide = 1;
+      // Option title
+      string title = 2 [(wix.api.translatable) = {
+        type: SHORT_TEXT
+        grouping: ""
+      }];
+      // Option subtitle
+      string subtitle = 3 [(wix.api.translatable) = {
+        type: SHORT_TEXT
+        grouping: ""
+      }];
+      // Plan duration dropdown configuration
+      DurationInputConfiguration duration = 4;
+      // Custom duration period dropdown configuration
+      InputConfiguration custom_duration_period = 5;
+      // Custom  duration input configuration
+      InputConfiguration custom_duration_input = 6;
+      // Price input configuration
+      InputWithPlaceholder price = 7;
+      // Setup fee field configuration
+      SetupFeeConfiguration setup_fee = 8;
+
+      reserved 9;
+    }
+
+    message RecurringOptionConfiguration {
+      // hide "recurring" option. if set to `true`, remaining fields will be ignored
+      bool hide = 1;
+      // Option title
+      string title = 2 [(wix.api.translatable) = {
+        type: SHORT_TEXT
+        grouping: ""
+      }];
+      // Option subtitle
+      string subtitle = 3 [(wix.api.translatable) = {
+        type: SHORT_TEXT
+        grouping: ""
+      }];
+      // Plan duration dropdown configuration
+      DurationInputConfiguration duration = 4;
+      // Price input configuration
+      InputWithPlaceholder price = 5;
+      // Setup fee field configuration
+      SetupFeeConfiguration setup_fee = 6;
+      // Free trial field configuration
+      FreeTrialConfiguration free_trial = 7;
+      // Frequency dropdown configuration
+      InputConfiguration frequency = 8;
+      // Custom frequency input configuration
+      InputConfiguration custom_frequency = 9;
+      
+      reserved 10;
+
+      message FreeTrialConfiguration {
+        // Hide "Free trial" toggle. If set to `true`, remaining fields will be ignored
+        bool hide = 1;
+        // Free trial toggle label
+        TextWithTooltip label = 2;
+        // Free trial duration dropdown configuration
+        InputConfiguration duration = 3;
+      }
+    }
+
+    message DurationInputConfiguration {
+      // Duration dropdown label
+      TextWithTooltip label = 1;
+      // Duration dropdown placeholder
+      string placeholder = 2 [(wix.api.translatable) = {
+        type: SHORT_TEXT
+        grouping: ""
+      }];
+      // Labels for duration dropdown options
+      DurationRenameOptions rename_options = 3;
+
+      message DurationRenameOptions {
+        // Text for "Forever" duration option
+        string forever = 1 [(wix.api.translatable) = {
+          type: SHORT_TEXT
+          grouping: ""
+        }];
+        // Text for "Custom" duration option
+        string custom = 2 [(wix.api.translatable) = {
+          type: SHORT_TEXT
+          grouping: ""
+        }];
+      }
+    }
+
+    message SetupFeeConfiguration {
+      // Hide "Setup fee" toggle. If set to `true`, remaining fields will be ignored
+      bool hide = 1;
+      // Setup fee toggle label
+      TextWithTooltip label = 2;
+      // Setup fee amount input configuration
+      InputWithPlaceholder amount = 3;
+      // Setup fee name input configuration
+      InputWithPlaceholder name = 4;
+    }
+
+    message InputConfiguration {
+      // Input label
+      TextWithTooltip label = 1;
+    }
+
+    enum PlanFormPricingOption {
+      UNKNOWN_OPTION = 0 [(wix.api.enum_maturity) = NOT_IMPLEMENTED, (wix.api.enum_exposure) = PRIVATE];
+      FREE = 1;
+      ONE_TIME = 2;
+      RECURRING = 3;
+    }
+  }
+
+  message PlanFormCustomSection {
+    // Id of dashboard extension component.
+    // Extensions should have containerId `fb869315-532f-4057-9049-e316f94e192f`
+    string component_id = 1 [(wix.api.format) = GUID];
+  }
+
+  message PlanFormSection {
+    oneof section {
+      // Extension component id
+      string component_id = 1;
+      // Default section name
+      PlanFormDefaultSection section_name = 2;
+    }
+
+    reserved 3;
+
+    enum PlanFormDefaultSection {
+      UNKNWON_PLAN_FORM_SECTION = 0 [(wix.api.enum_maturity) = NOT_IMPLEMENTED, (wix.api.enum_exposure) = PRIVATE];
+      INFO = 1;
+      BENEFITS = 2;
+      PAGE_PERMISSIONS = 3;
+      PRICING_AND_DURATION = 4;
+      ADVANCED_SETTINGS = 5;
+    }
+  }
+
+  message PlanFormTypeMetadata {
+    // Name of configuration (i.e. plan type). Used in various places. Should be short, but clear
+    string title = 1 [(wix.api.translatable) = {
+      type: SHORT_TEXT,
+      grouping: ""
+    }];
+    // Plan type subtitle. Used in type choice modal
+    string subtitle = 2 [(wix.api.translatable) = {
+      type: SHORT_TEXT,
+      grouping: ""
+    }];
+    // Longer description of plan type. Used in type choice modal
+    string description = 3 [(wix.api.translatable) = {
+      type: SHORT_TEXT,
+      grouping: ""
+    }];
+    // Plan type illustration. Used in type choice modal
+    Illustration illustration = 4;
+    // Your business manager module id
+    string module_id = 5;
+
+    message Illustration {
+      oneof illustration {
+        // Custom exported component id to be rendered as illustration
+        string component_id = 1 [(wix.api.format) = GUID];
+        // 96x96 image used in type choice modal
+        string src = 2;
+      }
+    }
+  }
+
+  message PlanFormInitialValue {
+    // Plan name
+    google.protobuf.StringValue name = 1;
+    // Plan description
+    google.protobuf.StringValue description = 2;
+    // What is included with this plan (e.g., 1 weekly entrance to a specific class).
+    PerkValues perks = 3;
+    // Plan price, payment schedule, and expiration
+    PlanPricing pricing = 4;
+    // Whether the plan is public (visible to site visitors and members)
+    google.protobuf.BoolValue public = 5;
+    // Number of times the same buyer can purchase the plan. Currently limited to support:  
+    // - Empty value or a value of `0`, meaning no limitation.
+    // - Value of `1`, meaning limited to one purchase per buyer.
+    google.protobuf.Int32Value max_purchases_per_buyer = 6;
+    // Whether the buyer can start the plan at a later date
+    google.protobuf.BoolValue allow_future_start_date = 7;
+    // Whether the buyer is allowed to cancel their plan
+    google.protobuf.BoolValue buyer_can_cancel = 8;
+    // Any terms and conditions that apply to the plan. This information will be displayed during checkout
+    google.protobuf.StringValue terms_and_conditions = 9 [(wix.api.maxLength) = 3000];
+    // Additional plan data, related to it's display in the client
+    map<string, string> client_data = 10;
+
+    message PerkValues {
+      // List of perks
+      repeated string values = 1 [(wix.api.maxSize) = 99];
+    }
+
+    message PlanPricing {
+      // Amount for a single payment (or the whole subscription if it's not a recurring plan)
+      PlanPriceData price = 1;
+
+      // Type of payment schedule and its details.
+      oneof pricing_model {
+        // Plan has recurring payments.
+        PricingRecurring subscription = 2;
+        // One time payment, plan is valid for the specified duration.
+        PlanDuration single_payment_for_duration = 3;
+        // One time payment, plan is valid until it is canceled.
+        bool single_payment_unlimited = 4;
+      }
+
+      message PlanPriceData {
+        // Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99)
+        string value = 1;
+        // Currency code. Must be valid ISO 4217 currency code (e.g., USD).
+        string currency = 2;
+      }
+
+      message PricingRecurring {
+        // Length of one payment cycle.
+        PlanDuration cycle_duration = 1;
+        // Amount of payment cycles this subscription is valid for.
+        // `0` for unlimited or until-canceled.
+        int32 cycle_count = 2;
+      }
+
+      message PlanDuration {
+        // The amount of a duration `unit` in a single payment cycle.
+        int32 count = 1;
+        // Unit of time for the cycle duration.
+        PlanPeriodUnit unit = 2;
+
+        // A predefined basic time unit.
+        enum PlanPeriodUnit {
+          UNDEFINED = 0 [(wix.api.enum_maturity) = NOT_IMPLEMENTED, (wix.api.enum_exposure) = PRIVATE];
+          DAY = 1;
+          WEEK = 2;
+          MONTH = 3;
+          YEAR = 4;
+        }
+      }
+    }
+  }
+
+  message PlanFormPagePermissionsSection {
+    // Hide "Page permissions" section. If set to `true`, remaining fields will be ignored
+    bool hide = 1;
+  }
+}
+
+message TextWithSuffix {
+  // Hide element. If set to `true`, remaining fields will be ignored
+  bool hide = 1;
+  // Displayed text
+  string text = 2 [(wix.api.translatable) = {
+    type: SHORT_TEXT,
+    grouping: ""
+  }];
+  oneof suffix {
+    // Tooltip to show next to the text
+    TooltipSuffix suffix_tooltip = 3;
+    // Link to show next to the text
+    LinkSuffix suffix_link = 4;
+  }
+}
+
+message TextWithTooltip {
+  // Displayed text
+  string text = 1 [(wix.api.translatable) = {
+    type: SHORT_TEXT,
+    grouping: ""
+  }];
+  // Tooltip to show next to text
+  TooltipSuffix tooltip = 2;
+}
+
+message TooltipSuffix {
+  // Tooltip content
+  string text = 1 [(wix.api.translatable) = {
+    type: SHORT_TEXT
+    grouping: ""
+  }];
+}
+
+message LinkSuffix {
+  // Hide element. If set to `true`, remaining fields will be ignored
+  bool hide = 1;
+  // Link text
+  string text = 2 [(wix.api.translatable) = {
+    type: SHORT_TEXT
+    grouping: ""
+  }];
+  // External url to open on link click
+  string url = 3 [(wix.api.translatable) = {
+    type: SHORT_TEXT
+    grouping: ""
+  }];
+
+  // Text, passed to click BI event as referral_info field
+  string referral_info = 4;
+}
+
+message InputWithPlaceholder {
+  // Input label
+  TextWithTooltip label = 1;
+  // Input placeholder
+  string placeholder = 2 [(wix.api.translatable) = {
+    type: SHORT_TEXT
+    grouping: ""
+  }];
+}

package/@wix/ambassador-devcenter-app-market-listing-v1-market-listing/src/main/proto/components_catalog_data/proposal-editor-provider/com/wixpress/appservice/api/upstream/wix/proposals/spi/v1/proposals-editor-provider.proto

@@ -0,0 +1,22 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api.upstream.wix.proposals.spi.v1;
+option java_package = "com.wixpress.appservice.api.upstream.wix.proposals.spi.v1";
+
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/common/spi.proto";
+import "google/protobuf/struct.proto";
+
+
+message ProposalEditorProviderConfig {
+  option (.wix.api.decomposite_of) = "wix.proposals.spi.v1.ProposalEditorProviderConfig";
+  // URI where the SPI Implementer is deployed
+  .wix.common.spi.SpiBaseUri deployment_uri = 1;
+
+  // User-friendly name of ProposalEditor provider
+  string provider_name = 2 [(.wix.api.maxLength) = 100];
+
+  // todo decide whether we need supported_fields
+}
+