@wix/bex-utils 2.115.0 → 2.117.0

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/upstream/wix/common/query.proto

@@ -0,0 +1,121 @@
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data.upstream.wix.common;
+
+import "google/protobuf/struct.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/paging.proto";
+import "com/wixpress/cloud/data/api/data/upstream/wix/common/sorting.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "QueryProto";
+option java_package = "com.wixpress.cloud.data.api.data.upstream.wix.common";
+
+message QueryV2 {
+    option (.wix.api.decomposite_of) = "wix.common.QueryV2";
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "filter"
+        field: "sort"
+        field: "paging"
+    };
+    option (.wix.api.decomposition_minimum_fields) = {
+        field: "filter"
+        field: "sort"
+        field: "cursorPaging"
+    };
+    // Filter object.
+    //
+    // Learn more about filters in [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#filters).
+    google.protobuf.Struct filter = 1;
+
+    // Sort object.
+    //
+    // Learn more about sorting in [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#sorting).
+    repeated Sorting sort = 2 [(.wix.api.maxSize) = 100];
+
+    // Fields to include for each retrieved item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
+    //
+    // > **Note:** The `_id` system field is always returned.
+    repeated string fields = 4 [(.wix.api.maxSize) = 1000, (.wix.api.maxLength) = 5000];
+
+    reserved 5;
+
+    oneof pagingMethod {
+        // Paging options to limit and skip the number of retrieved items.
+        Paging paging = 3;
+        // Cursor pointing to a page of results. Not used in the first request. 
+        //
+        // Subsequent requests use the cursor and ignore `filter` and `sort`.
+        CursorPaging cursor_paging = 6;
+    }
+}
+
+message Search {
+  option (.wix.api.decomposition_minimum_fields) = {
+    field: "filter"
+    field: "sort"
+    field: "paging"
+  };
+  option (.wix.api.decomposition_minimum_fields) = {
+    field: "filter"
+    field: "sort"
+    field: "cursor_paging"
+  };
+  // Filter object.
+  //
+  // Learn more about filters in [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#filters).
+  google.protobuf.Struct filter = 1;
+
+  // Sort object.
+  //
+  // Learn more about sorting in [API Query Language](https://dev.wix.com/docs/rest/articles/get-started/api-query-language#sorting).
+  repeated Sorting sort = 2 [(.wix.api.maxSize) = 10];
+
+  // Fields to include for each retrieved item. Only fields specified in the array are included in the response. If the array is empty, all fields are returned.
+  //
+  // > **Note:** The `_id` system field is always returned.
+  repeated string fields = 3 [(.wix.api.maxLength) = 200, (.wix.api.maxSize) = 20];
+
+  // fieldsets
+  reserved 4;
+  // aggregations
+  reserved  5;
+
+  // Text to search in the specified collection.
+  SearchDetails search = 6;
+  oneof paging_method {
+    // Options for limiting and skipping the number of retrieved items.
+    Paging paging = 7;
+    
+    // Cursor pointing to a page of results. Not used in the first request. 
+    //
+    // Subsequent requests use this cursor and ignore `filter` and `sort`.
+    CursorPaging cursor_paging = 8;
+  }
+  // Time Zone.
+  reserved 9;
+}
+
+message SearchDetails {
+  enum Mode {
+    // Logical **OR** relationship. Any search term must exist for an item to be retrieved.
+    OR = 0;
+    // Logical **AND** relationship. All search terms must exist for an item to be retrieved.
+    AND = 1;
+  }
+  // Determines how multiple search terms are handled.
+  //
+  // Default: `OR`.
+  Mode mode = 1; 
+  // Search query. Search terms are separated by whitespace.
+  google.protobuf.StringValue expression = 2 [(.wix.api.maxLength) = 100]; 
+  // Fields.
+  reserved 3;
+
+  // Whether to use fuzzy search to accommodate typos and partial matches.
+  //
+  // Default: `false`.
+  bool fuzzy = 4; 
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/cloud/data/api/data/upstream/wix/common/sorting.proto

@@ -0,0 +1,26 @@
+syntax = "proto3";
+
+package com.wixpress.cloud.data.api.data.upstream.wix.common;
+
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+
+option java_multiple_files = true;
+option java_package = "com.wixpress.cloud.data.api.data.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.minLength) = 1, (.wix.api.maxLength) = 1000];
+    // Sort order.
+    SortOrder order = 2;
+}
+
+enum SortOrder {
+    ASC = 0;
+    DESC = 1;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/iptf/webhooks/debug.proto

@@ -0,0 +1,34 @@
+syntax = "proto3";
+
+import "google/protobuf/wrappers.proto";
+import "google/api/annotations.proto";
+
+package com.wixpress.iptf.webhooks;
+
+service Debug {
+  rpc queryMessageId(QueryMessageIdRequest) returns (QueryResponse){
+    option (google.api.http) = {
+      post: "/queryMessageId"
+    };
+  };
+
+  rpc queryOffset(QueryOffsetRequest) returns (QueryResponse){
+    option (google.api.http) = {
+      post: "/queryOffset"
+    };
+  };
+}
+
+message QueryOffsetRequest {
+  string topic = 1;
+  int32 partition = 2;
+  int64 offset = 3;
+}
+
+message QueryMessageIdRequest {
+  string message_id = 1;
+}
+
+message QueryResponse {
+  repeated string json = 1;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/iptf/webhooks/kv.proto

@@ -0,0 +1,42 @@
+syntax = "proto3";
+
+import "google/protobuf/wrappers.proto";
+import "google/api/annotations.proto";
+
+package com.wixpress.iptf.webhooks;
+
+service WebhooksKV {
+  rpc queryApp(QueryAppRequest) returns (QueryAppResponse){
+    option (google.api.http) = {};
+  };
+
+  rpc queryAppSecretAndPrivateKey(QueryAppSecretAndPrivateKeyRequest) returns (QueryAppSecretAndPrivateKeyResponse){
+    option (google.api.http) = {};
+  };
+}
+
+message QueryAppRequest {
+  string app_def_id = 1;
+  string version = 2;
+}
+
+message QueryAppSecretAndPrivateKeyRequest {
+  string app_def_id = 1;
+}
+
+message QueryAppSecretAndPrivateKeyResponse {
+  google.protobuf.StringValue private_key = 1;
+  string secret = 2;
+}
+
+message QueryAppResponse {
+  repeated string permissions = 1;
+  google.protobuf.StringValue private_key = 2;
+  string secret = 3;
+  repeated DispatcherAppWebhook webhook = 4;
+}
+
+message DispatcherAppWebhook {
+    string webhookSlug = 1;
+    string callback_url = 2;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/com/wixpress/iptf/webhooks/message_envelope.proto

@@ -0,0 +1,54 @@
+syntax = "proto3";
+
+package com.wixpress.iptf.v1.webhooks;
+
+import "google/protobuf/wrappers.proto";
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+
+
+message MessageEnvelope {
+  reserved "account_details";
+  reserved 5;
+
+  google.protobuf.StringValue instance_id = 1 [(.wix.api.format) = GUID]; // App instance ID.
+  string event_type = 2 [(.wix.api.maxLength) = 150]; // Event type.
+  IdentificationData identity = 3; // The identification type and identity data.
+  // flynt-disable missing-string-validations
+  string data = 4; // Stringify payload.
+  AccountInfo account_info = 6 [(.wix.api.field_maturity) = BETA]; // Details related to the account
+}
+
+message IdentificationData {
+  option (.wix.api.decomposite_of) = "wix.common.IdentificationData";
+  enum WebhookIdentityType {
+    UNKNOWN = 0;
+    ANONYMOUS_VISITOR = 1;
+    MEMBER = 2;
+    WIX_USER = 3;
+    APP = 4;
+  }
+  reserved 1;
+  WebhookIdentityType 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];
+  }
+}
+
+message AccountInfo {
+  // ID of the Wix account associated with the event.
+  google.protobuf.StringValue account_id = 1 [(.wix.api.format) = GUID];
+
+  // ID of the parent Wix account. Only included when accountId belongs to a child account.
+  google.protobuf.StringValue parent_account_id = 2 [(.wix.api.format) = GUID];
+
+  // ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+  google.protobuf.StringValue site_id = 3 [(.wix.api.format) = GUID];
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/raw-http-messages.proto

@@ -0,0 +1,39 @@
+//flynt-disable missing-array-limits, missing-field-comments, missing-string-validations, unsigned-integers-not-allowed, package-matches-structure
+syntax = "proto3";
+
+package com.wixpress.rest;
+
+import "google/protobuf/wrappers.proto";
+
+message RawHttpResponse {
+    bytes body = 2;
+    google.protobuf.UInt32Value status_code = 3;
+    repeated HeadersEntry headers = 4;
+}
+
+
+
+message RawHttpRequest {
+    bytes body = 1;
+    repeated PathParametersEntry path_params = 2;
+    repeated QueryParametersEntry query_params = 3;
+    repeated HeadersEntry headers = 4;
+    string method = 5;
+    string raw_path = 6;
+    string raw_query = 7;
+}
+
+message PathParametersEntry {
+     string key = 1;
+     string value = 2;
+}
+
+message QueryParametersEntry {
+    string key = 1;
+    string value = 2;
+}
+
+message HeadersEntry {
+    string key = 1;
+    string value = 2;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/webhooks_debug_service.proto

@@ -0,0 +1,32 @@
+syntax = "proto3";
+
+package com.wixpress.iptf.webhooks.api.v1;
+
+import "google/api/annotations.proto";
+import "wix/api/validations.proto";
+
+service WebhooksDebugService {
+    rpc submit(SubmitWebhookRequest) returns (SubmitWebhookResponse) {
+        option (google.api.http) = {
+            post: "debug/submit"
+        };
+    }
+}
+
+message SubmitWebhookRequest {
+    string url = 1;
+    string event_type = 2;
+    string topic = 3;
+    string payload = 4;
+    string http_method = 5;
+    string jwt_secret = 6;
+    int64 expireInMs = 7;
+    int64 submitted = 8;
+    bool should_override_proxy = 9;
+    string rsa_private_key = 10;
+}
+
+message SubmitWebhookResponse {
+    int32 status_code = 1;
+    string message = 2;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/webhooks_sync_service.proto

@@ -0,0 +1,33 @@
+syntax = "proto3";
+
+package com.wixpress.iptf.webhooks.api.v1;
+
+import "google/api/annotations.proto";
+import "wix/api/validations.proto";
+import "google/protobuf/wrappers.proto";
+
+service WebhooksSyncService {
+    rpc signHash(SignHashRequest) returns (SignResponse) {
+        option (wix.api.required) = "SignHashRequest.hashedPayload";
+        option (wix.api.required) = "SignHashRequest.appdef_id";
+        option (google.api.http) = {
+            get: "v1/sign/hash"
+        };
+    }
+}
+
+message SignHashRequest {
+    string hashedPayload = 1;
+    HashFunction algorithm = 2;
+    string appdef_id = 3 [(wix.api.format)=GUID]; // appdef id of the external app
+    int64 expiration_in_millis = 4;
+    google.protobuf.StringValue artifact_id = 5 [(wix.api.maxLength) = 200]; // caller
+}
+
+message SignResponse {
+    string token = 1;
+}
+
+enum HashFunction {
+    SHA256 = 0;
+}

package/@wix/ambassador-hub-v1-job/src/main/proto/wix/api/action_payload.proto

@@ -0,0 +1,33 @@
+syntax = "proto2";
+
+package wix.api;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "ActionPayloadProto";
+option java_package = "com.wix.api";
+
+/*
+action_payload option is used to configure custom slugs for the payload type of a DomainEvent Action:
+service BlooperService {
+   option (wix.api.service_entity).message = "com.wixpress.examples.Blooper"; //the "main" entity
+   rpc MissedBlooper (MissedBlooperRequest) returns (MissedBlooperResponse) {
+       option (wix.api.callback) = {
+           event_type: Action
+           payload: "com.wixpress.examples.BlooperWasMissed"
+       };
+   };
+}
+message BlooperWasMissed {
+   option (wix.api.action_payload).custom_slug = "super_custom_slug"; // only define if the default slug value (snake case of the message name) is out of the question
+    int32 how_funny_it_could_have_been = 1;
+}
+*/
+extend google.protobuf.MessageOptions {
+    optional ActionPayload action_payload = 50600;
+}
+
+message ActionPayload {
+    optional string custom_slug = 1;
+}