@wix/bex-utils 2.4.0 → 2.5.0

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

@@ -0,0 +1,63 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api;
+
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/struct.proto";
+import "components_catalog_data.proto";
+import "com/wixpress/appservice/api/components_catalog_type.proto";
+import "wix/api/annotations.proto";
+
+// Component Catalog Entity
+message ComponentCatalog {
+  // Enum of Component Type
+  ComponentType component_type = 1;
+  // Component name *from proto comment*
+  string name = 2;
+  // Component description *from proto comment*
+  string description = 3;
+  // Exposed in Dev Center to Internal users (Wix employees) or to all users (Wix users) *from proto comment*
+  Exposure exposure = 4;
+  // Learn more link *from proto comment*
+  string learn_more_link = 5;
+  // Can be deleted
+  bool deletable = 6;
+  // Editable in Dev Center
+  bool editable = 7;
+  // Only one per app / multiple per app
+  bool singular = 8;
+  // if required approval before adding the component
+  bool requires_approval = 9;
+  // Present in Editor / Dashboard / Extension
+  ComponentPresent component_present = 10;
+}
+
+enum Exposure {
+  NONE_EXPOSURE = 0;
+  PRIVATE_EXPOSURE = 1;
+  INTERNAL_EXPOSURE = 2;
+  PUBLIC_EXPOSURE = 3;
+}
+
+enum ComponentPresent {
+  NONE_PRESENT = 0;
+  EDITOR_PRESENT = 1;
+  DASHBOARD_PRESENT = 2;
+  EXTENSION_PRESENT = 3;
+}
+
+message GetComponentsCatalogResponse {
+  repeated ComponentCatalog components_catalog = 1;
+}
+
+message CreateComponentCatalogRequest {
+  ComponentCatalog component_catalog = 1;
+}
+
+message UpdateComponentCatalogRequest {
+  ComponentCatalog component_catalog = 1;
+}
+
+message DeleteComponentCatalogRequest {
+  ComponentType component_type = 1;
+}

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

@@ -0,0 +1,149 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api;
+
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/struct.proto";
+import "wix/api/validations.proto";
+import "components_catalog_data.proto";
+import "com/wixpress/appservice/api/components_catalog_type.proto";
+import "wix/common/query.proto";
+import "wix/api/entity.proto";
+
+// Create a new component for the app
+message CreateComponentRequest {
+  // Given app id
+  string app_id = 1 [(wix.api.format) = GUID];
+  // Component to be created, ENUM
+  ComponentType comp_type = 2;
+  // Component initial Data in JSON format, can be empty which, in that case it will recieve default values or complete with all of the properties
+  ComponentData comp_data = 3;
+  // Required to all types except app studio
+  google.protobuf.StringValue comp_name = 4;
+}
+
+// Create a new component for the app
+message CreateComponentResponse {
+  // The component id that was just created
+  string comp_id = 1 [(wix.api.readOnly) = true, (wix.api.format) = GUID];
+}
+
+// Update a given component type and ID
+message UpdateComponentRequest {
+  // Component in this app
+  string app_id = 1 [(wix.api.format) = GUID];
+  // Component type to update, ENUM
+  ComponentType comp_type = 2 [(wix.api.readOnly) = true];
+  // Component data wished to be updated
+  ComponentData comp_data = 3;
+  // Component id to update, empty component id is relevant for app studio and platform ONLY
+  google.protobuf.StringValue comp_id = 4 [(wix.api.format) = GUID];
+  // The component name
+  google.protobuf.StringValue comp_name = 5;
+}
+
+// The updated components
+message UpdateComponentResponse {
+  // Component in this app
+  string app_id = 1 [(wix.api.readOnly) = true, (wix.api.format) = GUID];
+  // Components that was just updated
+  repeated Component components = 2;
+}
+
+// Update a given components bulk type and ID
+message UpdateComponentsRequest {
+  // Component in this app
+  string app_id = 1 [(wix.api.format) = GUID];
+  // Update components request list
+  repeated Component components = 2;
+}
+
+// The updated components
+message UpdateComponentsResponse {
+  // Component in this app
+  string app_id = 1 [(wix.api.readOnly) = true, (wix.api.format) = GUID];
+  // Components that was just updated
+  repeated Component components = 2;
+}
+
+// Delete a given component
+message DeleteComponentRequest {
+  // Component in this app
+  string app_id = 1 [(wix.api.format) = GUID];
+  // Component Id to delete
+  string comp_id = 2 [(wix.api.format) = GUID];
+}
+
+// Empty response
+message DeleteComponentResponse {}
+
+// Return the created version
+message UpdateAndCreateRcVersionComponentResponse {
+  // The version that was just created
+  string current_rc_version = 1 [(wix.api.readOnly) = true, (wix.api.format) = GUID];
+}
+
+// Get components for some specific app ids, and filter it by list of components types
+message GetComponentsRequest {
+  // Components for these app Id
+  repeated string apps = 1 [(wix.api.format) = GUID];
+
+  // Filter the result and select which component type to return
+  repeated ComponentType components_type = 2;
+}
+
+// List of apps and their component list
+message GetComponentsResponse {
+  // List of components
+  repeated AppComponents app_components = 1;
+}
+
+// Map from app id to component list
+message AppComponents {
+  // App Id for these components
+  string app_id = 1 [(wix.api.format) = GUID];
+  // Components list
+  repeated Component components = 2;
+}
+
+// App Component
+message Component {
+  option (.wix.api.entity) = {
+    fqdn: "wix.devcenter.components.v1.component"
+    segment: USERS
+  };
+  // Unique component Id
+  string comp_id = 1 [(wix.api.readOnly) = true];
+  // Enum of Component Type
+  ComponentType comp_type = 2;
+  // One of components data: Editor Widget, Editor Page, Editor Worker (Pixel), Dashboard Page, Editor Widget Out Of Iframe, , Editor Page Out Of Iframe, Editor Platform, Dashboard Platform, Wix Blocks, Wix Blocks Widget, Embedded Script, Web (Custom Element), Data, Static File, App Config
+  ComponentData comp_data = 3;
+  // Required to all types except Studio (Blocks)
+  google.protobuf.StringValue comp_name = 4;
+}
+
+// Create a new component for the app
+message CreateComponentByStructRequest {
+  // Given app id
+  string app_id = 1 [(wix.api.format) = GUID];
+  // Component to be created, ENUM
+  string comp_type = 2;
+  // Component initial Data in JSON format, can be empty which, in that case it will recieve default values or complete with all of the properties
+  google.protobuf.Struct comp_data = 3;
+  // Required to all types except app studio
+  google.protobuf.StringValue comp_name = 4;
+}
+
+// Update a given component type and ID
+message UpdateComponentByStructRequest {
+  // Component in this app
+  string app_id = 1 [(wix.api.format) = GUID];
+  // Component type to update, ENUM
+  string comp_type = 2 [(wix.api.readOnly) = true];
+  // Component data wished to be updated
+  google.protobuf.Struct comp_data = 3;
+  // Component id to update, empty component id is relevant for app studio and platform ONLY
+  google.protobuf.StringValue comp_id = 4 [(wix.api.format) = GUID];
+  // The component name
+  google.protobuf.StringValue comp_name = 5;
+}

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

@@ -0,0 +1,111 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api;
+
+import "wix/api/validations.proto";
+import "wix/api/entity.proto";
+import "google/protobuf/wrappers.proto";
+
+
+enum ExtensionType {
+  NONE_EXTENSION = 0;
+  PAYMENTS_GATEWAY_EXTENSION = 1;
+  COUPONS_EXTENSION = 2;
+  DROPSHIPPING_EXTENSION = 3;
+  FULFILMENT_EXTENSION = 4;
+  DROPSHIPPING_SUPPLIER_EXTENSION = 5;
+  FULFILLMENT_CENTER_EXTENSION = 6;
+  RESTAURANTS_POS_EXTENSION = 7;
+  ART_STORE_EXTENSION = 8;
+  ASCEND_AUTOMATION_EXTENSION = 9;
+  CONTACT_LABELS_EXTENSION = 10;
+}
+
+message Metadata {
+  string title = 1;
+  string name = 2;
+  string description = 3;
+  string kb_link = 4;
+  string navigation = 5;
+}
+
+message Extension {
+  option (.wix.api.entity) = {
+    fqdn: "wix.devcenter.extensions.v1.extension"
+    segment: USERS
+  };
+  string extension_id = 1 [(wix.api.format) = GUID];
+  string schema = 2;
+  ExtensionType extension_type = 3;
+  Metadata meta_data = 4;
+  Status status = 5;
+}
+
+message GetExtensionsRequest {
+}
+
+message GetExtensionsResponse {
+  repeated Extension extensions = 1;
+}
+
+message CreateExtensionRequest {
+  string schema = 1;
+  ExtensionType extension_type = 2;
+  Metadata meta_data = 3;
+}
+
+message CreateExtensionResponse {
+  string extension_id = 1 [(wix.api.readOnly) = true, (wix.api.format) = GUID];
+  string schema = 2;
+  ExtensionType extension_type = 3;
+  Metadata meta_data = 4;
+  Status status = 5;
+}
+
+message UpdateExtensionRequest {
+  string extension_id = 1 [(wix.api.format) = GUID];
+  google.protobuf.StringValue schema = 2;
+  ExtensionType extension_type = 3;
+  Metadata meta_data = 4;
+  Status status = 5;
+}
+
+message UpdateExtensionResponse {
+  string extension_id = 1 [(wix.api.readOnly) = true, (wix.api.format) = GUID];
+  string schema = 2;
+  ExtensionType extension_type = 3;
+  Metadata meta_data = 4;
+  Status status = 5;
+}
+
+message GetExtendersRequest {
+  ExtensionType extension_type = 1;
+  bool includeDraft = 2;
+  bool onlyInstalledOnSite = 3;
+}
+
+message GetExtendersResponse {
+  repeated Extender extenders = 1;
+}
+
+message Extender {
+  string app_id = 1 [(wix.api.format) = GUID];
+  google.protobuf.StringValue version = 2;
+  bool is_draft = 3;
+  AppExtensionMessageValue extension_data = 4;
+}
+
+message AppExtensionMessageValue {
+  ExtensionData extension_data = 1;
+}
+
+message ExtensionData {
+  string data = 1;
+  ExtensionType extension_type = 2;
+}
+
+enum Status {
+  NONE_EXTENSION_STATUS = 0;
+  INTERNAL = 1;
+  EXTERNAL = 2;
+}

package/@wix/ambassador-devcenter-app-market-listing-v1-market-listing/src/main/proto/features/features_messages.proto

@@ -0,0 +1,73 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api.pricing;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+
+option java_package = "com.wixpress.appservice.api.pricing";
+
+message Feature {
+    google.protobuf.StringValue id = 1;
+    google.protobuf.StringValue name = 2;
+    google.protobuf.StringValue description = 3;
+    FeatureSection section = 4;
+}
+
+message FeatureSection {
+    google.protobuf.StringValue intent = 1;
+    google.protobuf.StringValue displayName = 2;
+}
+
+message CreateFeatureRequest {
+    string app_id = 1 [(wix.api.format) = GUID];
+    string language_code = 2; // todo: add format LANGUAGE when client is ready
+    Feature feature = 3;
+}
+
+message CreateFeatureResponse {
+    string id = 1;
+    Feature feature = 2;
+}
+
+message UpdateFeatureRequest {
+    string app_id = 1 [(wix.api.format) = GUID];
+    string language_code = 2; // todo: add format LANGUAGE when client is ready
+    string feature_id = 3 [(wix.api.format) = GUID];
+    Feature feature = 4;
+}
+
+message UpdateFeatureResponse {
+    Feature feature = 1;
+}
+
+message GetFeatureRequest {
+    string app_id = 1 [(wix.api.format) = GUID];
+    string language_code = 2; // todo: add format LANGUAGE when client is ready
+    string feature_id = 3 [(wix.api.format) = GUID];
+}
+
+message GetFeatureResponse {
+    Feature feature = 1;
+}
+
+message DeleteFeatureRequest {
+    string app_id = 1 [(wix.api.format) = GUID];
+    string language_code = 2; // todo: add format LANGUAGE when client is ready
+    string feature_id = 3 [(wix.api.format) = GUID];
+}
+
+message DeleteFeatureResponse {
+    string feature_id = 1;
+}
+
+message UpdateFeatureTranslationWithRequest {
+    map<string, string> translation_data = 1;
+    string app_id = 2 [(wix.api.format) = GUID];
+    string feature_id = 3 [(wix.api.format) = GUID];
+    string language_code = 4 [(wix.api.format) = LANGUAGE];
+}
+
+message UpdateFeatureTranslationWithResponse {
+
+}

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

@@ -0,0 +1,117 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api;
+
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/timestamp.proto";
+import "google/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+import "marketListing_messages.proto";
+import "wix/api/entity.proto";
+
+option java_package = "com.wixpress.appservice.api";
+
+
+message GetListingInfoRequest {
+    string app_id = 1 [(wix.api.format) = GUID]; // the app id.
+    string language_code = 2;
+}
+
+message GetListingInfoResponse {
+    // marketing materials
+    string name = 1 [(wix.api.minLength) = 1];
+    google.protobuf.StringValue icon_url = 2 [(wix.api.format) = URI];
+    google.protobuf.StringValue short_description = 3;
+    google.protobuf.StringValue long_description = 4;
+    repeated string benefits = 6;
+    google.protobuf.StringValue demo_url = 7 [(wix.api.format) = URI];
+    repeated string screenshots = 10 [(wix.api.format) = URI];
+    SupportInfo support_info = 15;
+    CompanyInfo company_info = 16;
+    // classification
+    repeated string categories = 20 [(wix.api.format) = GUID];
+    repeated string tags = 21;
+    google.protobuf.StringValue developer_site_url = 22;
+    google.protobuf.StringValue developer_meta_site_id = 23;
+    string language_code = 24;
+}
+
+message UpdateListingInfoRequest {
+    string app_id = 1 [(wix.api.format) = GUID]; // the app id.
+    // marketing materials
+    google.protobuf.StringValue name = 2 [(wix.api.minLength) = 1];
+    google.protobuf.StringValue icon_url = 3 [(wix.api.format) = URI];
+    google.protobuf.StringValue short_description = 4;
+    google.protobuf.StringValue long_description = 5;
+    repeated string benefits = 6;
+    google.protobuf.StringValue demo_url = 7 [(wix.api.format) = URI];
+    repeated string screenshots = 10 [(wix.api.format) = URI];
+    SupportInfo support_info = 15;
+    CompanyInfo company_info = 16;
+    // classification
+    repeated string categories = 20 [(wix.api.format) = GUID];
+    repeated string tags = 21;
+    google.protobuf.StringValue developer_site_url = 22;
+    google.protobuf.StringValue developer_meta_site_id = 23;
+    string language_code = 24;
+}
+
+message UpdateListingInfoResponse {
+}
+
+message SupportInfo {
+    google.protobuf.StringValue email = 1 [(wix.api.format) = EMAIL, (.wix.api.pii) = true];
+    google.protobuf.StringValue web_page = 2 [(wix.api.format) = URI];
+    google.protobuf.StringValue privacy_policy_url = 3 [(wix.api.format) = URI];
+    google.protobuf.StringValue terms_of_use_url = 4 [(wix.api.format) = URI];
+    repeated FAQ faqs = 11;
+}
+
+message CompanyInfo {
+    google.protobuf.StringValue name = 1 [(wix.api.maxLength) = 50];
+    google.protobuf.StringValue website = 2 [(wix.api.format) = URI];
+    google.protobuf.StringValue info = 3 [(wix.api.maxLength) = 2000];
+}
+
+message FAQ {
+    string question = 1;
+    string answer = 2;
+}
+
+message AppListing {
+    // marketing materials
+    string name = 1 [(wix.api.minLength) = 1];
+    google.protobuf.StringValue icon_url = 2 [(wix.api.format) = URI];
+    google.protobuf.StringValue short_description = 3;
+    google.protobuf.StringValue long_description = 4;
+    repeated string benefits = 6;
+    google.protobuf.StringValue demo_url = 7 [(wix.api.format) = URI];
+    repeated string screenshots = 10 [(wix.api.format) = URI];
+    SupportInfo support_info = 15;
+    CompanyInfo company_info = 16;
+    // classification
+    repeated string categories = 20 [(wix.api.format) = GUID];
+    repeated string tags = 21;
+    google.protobuf.StringValue developer_site_url = 22;
+    google.protobuf.StringValue developer_meta_site_id = 23;
+    string language_code = 24;
+    // new marketing materials
+    MarketListing market_listing = 25;
+}
+
+message EncryptSupportEmailRequest {
+    int32 limit = 1;
+    google.protobuf.Timestamp date = 2;
+}
+
+message EncryptSupportEmailResponse {
+    int32 changed_records = 1;
+}
+
+message ListingInfoEntity {
+    option (.wix.api.entity) = {
+        fqdn: "wix.devcenter.listing_info.v1.listing_info_entity"
+        segment: USERS
+    };
+}

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

@@ -0,0 +1,107 @@
+syntax = "proto3";
+
+package com.wixpress.appservice.api;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+import "google/api/annotations.proto";
+import "wix/api/annotations.proto";
+import "assets_messages.proto";
+import "wix/api/entity.proto";
+
+option java_package = "com.wixpress.appservice.api";
+
+message InsertAssetsToMapRequest {
+    string app_id = 1 [(wix.api.format) = GUID]; // the app id.
+    string language_code = 2[(wix.api.format) = LANGUAGE]; // the language code;
+    string key = 3 [(wix.api.minLength) = 1];
+    com.wixpress.appservice.api.assets.Assets assets = 4;
+}
+
+message AddAssetRequest {
+    string app_id = 1 [(wix.api.format) = GUID]; // the app id.
+    string language_code = 2[(wix.api.format) = LANGUAGE]; // the language code;
+    string key = 3 [(wix.api.minLength) = 1];
+    com.wixpress.appservice.api.assets.Asset asset = 4;
+}
+
+message UpdateListingInfo {
+    string app_id = 1 [(wix.api.format) = GUID]; // the app id.
+    string language_code = 2[(wix.api.format) = LANGUAGE]; // the language code;
+    MarketListing  market_listing = 3;
+}
+
+message GetListingInfo {
+    string app_id = 1 [(wix.api.format) = GUID]; // the app id.
+    string language_code = 2[(wix.api.format) = LANGUAGE]; // the language code;
+}
+
+
+message MarketListing {
+    option (.wix.api.entity) = {
+        fqdn: "wix.devcenter.listing_info.v2.market_listing"
+        segment: USERS
+    };
+    // marketing materials
+    BasicInfo basic_info = 1;
+    map<string, com.wixpress.appservice.api.assets.Assets> assetsMap = 2; // map of all marketing assets
+    ContactInfo contact_info = 3;
+    Tracking tracking_and_analytics = 4;
+    string language_code = 5 [(wix.api.format) = LANGUAGE]; // the language code;
+    InstallationRequirement installation_requirement = 6;
+}
+
+message InstallationRequirement {
+    repeated RequiredApp required_apps = 1; // the vertical appIds needed for this app, for example Store
+    repeated string include_countries = 2 [(wix.api.format) = COUNTRY];
+    repeated string exclude_countries = 3 [(wix.api.format) = COUNTRY];
+
+    // language options
+    repeated string include_languages = 4 [(wix.api.format) = LANGUAGE];
+    repeated string exclude_languages = 5 [(wix.api.format) = LANGUAGE];
+    bool allow_language_customization = 6;
+}
+
+message RequiredApp{
+    string id = 1 [(wix.api.format) = GUID];
+    string slug = 2;
+}
+
+message BasicInfo {
+    string app_id = 1 [(wix.api.format) = GUID]; // the app id.
+    string name = 2;
+    google.protobuf.StringValue teaser = 3;
+    google.protobuf.StringValue long_description = 4;
+    repeated Benefits benefits = 5;
+    repeated string search_keywords = 6;
+    google.protobuf.StringValue demo_url = 7 [(wix.api.format) = URI];
+    repeated string categories = 8;
+}
+
+message Benefits {
+    string title = 1;
+}
+
+message ContactInfo {
+    google.protobuf.StringValue website = 1 [(wix.api.format) = URI];
+    google.protobuf.StringValue developer_meta_site_id = 2;
+    google.protobuf.StringValue support_email = 3 [(wix.api.format) = EMAIL, (.wix.api.pii) = true];
+    google.protobuf.StringValue privacy_policy_url = 4 [(wix.api.format) = URI];
+    google.protobuf.StringValue terms_of_use_url = 5 [(wix.api.format) = URI];
+}
+
+message Tracking {
+    google.protobuf.StringValue google_analytics_tracking_id = 1;
+    google.protobuf.StringValue google_conversion_id = 2;
+    google.protobuf.StringValue adRolll_adv_id = 3;
+    google.protobuf.StringValue adRolll_pix_id = 4;
+}
+
+//payload for kafka event to update new app market listing
+message OldListingChanged {
+    string appId = 1;
+    MarketListing market_listing = 2;
+    string language_code = 3 [(wix.api.format) = LANGUAGE];
+    google.protobuf.StringValue name = 4;
+    google.protobuf.StringValue icon_url = 5;
+}