@wix/bex-utils 1.28.0

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v3/resources/order.proto

@@ -0,0 +1,80 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v3;
+
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/common/address.proto";
+import "wix/payment/api/pay/v3/resources/payment-details.proto";
+
+option java_package = "com.wix.payment.api.pay.v3";
+
+message Order {
+    string id                                                       = 1;
+
+    // Wix app order ID
+    string wix_app_order_id                                         = 2;
+
+    // Wix app buyer ID
+    google.protobuf.StringValue wix_app_buyer_id                    = 3;
+
+    // Items included in the order
+    repeated OrderItem items                                        = 4;
+
+    // total number of items in order
+    // items_total_count > `items`.size if `items` doesn't contain all items
+    int32 items_total_count                                         = 5;
+
+    // Additional charges to the order - e.g., tax, shipping or discount (optional)
+    OrderAdditionalCharges additional_charges                       = 6;
+
+    // Customer's shipping address (optional)
+    wix.common.Address shipping_address                             = 7;
+
+    // Customer's shipping address details (optional)
+    wix.common.FullAddressContactDetails shipping_address_contacts  = 8;
+
+    // Order creation date
+    google.protobuf.Timestamp created_at                            = 9;
+
+    map<string, string> external_data                               = 10;
+}
+
+// Describing any additional charges in the order. They are not required, but can't be added later.
+message OrderAdditionalCharges {
+    // Absolute taxes charged to the order
+    double tax      = 1;
+    // Shipping cost charged to the order
+    double shipping = 2;
+    // Discount amount applied to the order
+    double discount = 4;
+    // Application fee
+    double application_fee = 5;
+}
+
+// Item included in order
+message OrderItem {
+    // Order item ID (required)
+    string id                   = 1;
+    // Order item name (required)
+    string name                 = 2;
+    // Quantity (required)
+    int32 quantity              = 3;
+    // Total price charged for this item in the order - quantity * price (required)
+    double price                = 4;
+    // Order item description
+    string description          = 5;
+    // Weight of one item
+    double weight_in_kg         = 6;
+    // Whether the item is a physical a digital product
+    OrderItemCategory category  = 7;
+
+    // Order item type
+    enum OrderItemCategory {
+        UNDEFINED         = 0;
+        // Physical product
+        PHYSICAL          = 1;
+        // Digital product
+        DIGITAL           = 2;
+    }
+}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v3/resources/payment-details.proto

@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v3;
+
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+
+option java_package = "com.wix.payment.api.pay.v3";
+
+message CurrencyAmount {
+    // Amount
+    double amount   = 1;
+
+    string currency = 2;
+}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v3/resources/payment-event.proto

@@ -0,0 +1,121 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v3;
+
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/payment/api/pay/v3/resources/transaction.proto";
+import "wix/payment/api/pay/v3/resources/order.proto";
+import "wix/payment/api/pay/v3/resources/refund.proto";
+import "wix/payment/api/pay/v3/resources/recurring-payment.proto";
+import "wix/api/entity.proto";
+
+option java_package = "com.wix.payment.api.pay.v3";
+
+// This webhook is triggered whenever a payment transaction is updated (including refunds) via specific [Wix Apps](https://dev.wix.com/api/rest/wix-payments/about-wix-payments).
+message PaymentEvent {
+
+    option (wix.api.entity) = {
+        fqdn: "wix.cashier.pay.v3.payment_event"
+        segment: PUBLIC // no domain events produced, but the entity is sent to a topic cashier-payment-event
+    };
+
+    // Unique event ID.
+    string id                               = 1;
+
+    // Event timestamp
+    google.protobuf.Timestamp event_time    = 2;
+
+    // ID of the [Wix app](https://dev.wix.com/api/rest/wix-payments/about-wix-payments) that triggered this event.
+    string wix_app_id                       = 3;
+
+    // Unique ID assigned to each Wix app in each site.
+    string wix_app_instance_id              = 4;
+
+    // Event type.
+    EventType event_type                    = 5;
+
+    // ID of Wix app that mediated between Wix Payments and the Wix app that triggered the event (if relevant).
+    google.protobuf.StringValue managing_wix_app_id = 6;
+
+    // Event details.
+    oneof event {
+        TransactionStatusChangedEvent transaction_status_changed_event              = 101;
+        RefundStatusChangedEvent refund_status_changed_event                        = 102;
+        RecurringPaymentStatusChangedEvent recurring_payment_status_changed_event   = 103;
+        TransactionUpdatedEvent transaction_updated_event                           = 104;
+        TransactionCreatedEvent transaction_created_event                           = 105;
+    }
+
+    enum EventType {
+        UNDEFINED                           = 0;
+        TRANSACTION_STATUS_CHANGED          = 1;
+        REFUND_STATUS_CHANGED               = 2;
+        RECURRING_PAYMENT_STATUS_CHANGED    = 3;
+        TRANSACTION_UPDATED                 = 4;
+        TRANSACTION_CREATED                 = 5;
+    }
+}
+
+message TransactionStatusChangedEvent {
+
+    // Order details (limited to 30 items).
+    Order order                                     = 1;
+
+    // New transaction details.
+    Transaction transaction                         = 2;
+
+    // Previous transaction status.
+    Transaction.TransactionStatus previous_status   = 3;
+}
+
+message RefundStatusChangedEvent {
+
+    // Order details (limited to 30 items).
+    Order order                         = 1;
+
+    // Updated transaction details.
+    Transaction transaction             = 2;
+
+    // Updated refund details.
+    Refund refund                       = 3;
+
+    // Previous refund status.
+    Refund.RefundStatus previous_status = 4;
+}
+
+message RecurringPaymentStatusChangedEvent {
+
+    // Order details(limited to 30 items).
+    Order order                                                 = 1;
+
+    // Recurring payment status.
+    RecurringPaymentStatus.Status status                        = 2;
+
+    // Previous recurring payment status.
+    RecurringPaymentStatus.Status previous_status               = 3;
+
+    // Details of RecurringPayment cancellation (empty if `status` is not CANCELLED).
+    RecurringPaymentCancellationDetails cancellation_details    = 4;
+}
+
+message TransactionUpdatedEvent {
+
+    // Order details (limited to 30 items).
+    Order order                                              = 1;
+
+    // Updated transaction details.
+    Transaction transaction                                  = 2;
+
+    // Is event triggered by request to clean user data
+    google.protobuf.BoolValue triggered_by_anonymize_request = 3;
+}
+
+message TransactionCreatedEvent {
+
+    // Order details (limited to 30 items).
+    Order order                                              = 1;
+
+    // Updated transaction details.
+    Transaction transaction                                  = 2;
+}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v3/resources/recurring-payment.proto

@@ -0,0 +1,32 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v3;
+
+option java_package = "com.wix.payment.api.pay.v3";
+
+message RecurringPaymentStatus {
+    enum Status {
+        UNDEFINED = 0;
+        PENDING = 1;
+        ACTIVE = 2;
+        CANCELLED = 3;
+        FINISHED = 4;
+        SUSPENDED = 5;
+    }
+}
+
+message RecurringPaymentCancellationDetails {
+    // Initiator of cancellation
+    Initiator initiator             = 1;
+
+    // Successfully paid recurring cycles count before the cancellation
+    uint32 paid_regular_cycle_count = 2;
+
+    enum Initiator {
+        UNDEFINED   = 0;
+        BUYER       = 1;
+        MERCHANT    = 2;
+        PAYMENT     = 3;
+        SETUP       = 4;
+    }
+}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v3/resources/refund.proto

@@ -0,0 +1,34 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v3;
+
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/payment/api/pay/v3/resources/payment-details.proto";
+
+option java_package = "com.wix.payment.api.pay.v3";
+
+message Refund {
+
+    string id                               = 1;
+
+    // Amount and currency of refund
+    CurrencyAmount amount                   = 2;
+
+    // Updated refund status
+    RefundStatus status                     = 3;
+
+    // Reason provided for status change
+    google.protobuf.StringValue reason_code = 4;
+
+    // Refund creation date
+    google.protobuf.Timestamp created_at    = 10;
+
+    enum RefundStatus {
+        UNDEFINED            = 0;
+        APPROVED             = 1;
+        PENDING              = 2;
+        DECLINED             = 3;
+    }
+}
+

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v3/resources/transaction.proto

@@ -0,0 +1,82 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v3;
+
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/common/address.proto";
+import "wix/payment/api/pay/v3/resources/payment-details.proto";
+import "wix/api/annotations.proto";
+
+option java_package = "com.wix.payment.api.pay.v3";
+
+message Transaction {
+
+    // Transaction ID
+    string id                                                       = 1;
+
+    // Provider transaction ID
+    google.protobuf.StringValue provider_transaction_id             = 2;
+
+    // Amount and currency of transaction
+    CurrencyAmount amount                                           = 3;
+
+    // Refunded amount and currency of transaction
+    CurrencyAmount refundedAmount                                   = 4;
+
+    // Updated transaction status
+    TransactionStatus status                                        = 5;
+
+    // Reason provided for status change
+    google.protobuf.StringValue reason_code                         = 6;
+
+    // Payment method
+    string payment_method                                           = 7;
+
+    // Payment service provider
+    string payment_provider                                         = 8;
+
+    // Customer's billing address (optional)
+    wix.common.Address billing_address                              = 9;
+
+    // Customer's billing address - contact details (optional)
+    wix.common.FullAddressContactDetails billing_address_contacts   = 10;
+
+    RecurringPaymentDetails recurring_payment_details               = 11;
+
+    // Map with payment method data
+    oneof payment_method_data {
+        CreditCardPaymentMethodData credit_card_payment_method_data = 101;
+    }
+
+    // Transaction creation date
+    google.protobuf.Timestamp created_at                            = 12;
+
+    // Total number of installments 
+    int32 installments                                              = 13;
+
+    enum TransactionStatus {
+        UNDEFINED           = 0;
+        APPROVED            = 1;
+        PENDING             = 2;
+        PENDING_MERCHANT    = 3;
+        CANCELED            = 4;
+        DECLINED            = 5;
+        REFUNDED            = 6;
+        PARTIALLY_REFUNDED  = 7;
+        AUTHORIZED          = 8;
+        VOIDED              = 9;
+    }
+}
+
+message RecurringPaymentDetails {
+    // Current cycle number (Recurring payments only)
+    int32 cycle_number = 1;
+}
+
+message CreditCardPaymentMethodData {
+    string network              = 1;
+    string masked_credit_card   = 2[(.wix.api.pii) = false];
+    string holder_name          = 3[(.wix.api.pii) = true];
+    string expiry_month         = 4;
+}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/sdk/definitions.proto

@@ -0,0 +1,191 @@
+syntax = "proto2";
+
+package wix.sdk;
+
+import "google/protobuf/descriptor.proto";
+
+option java_multiple_files = true;
+option java_outer_classname = "DefinitionsProto";
+option java_package = "com.wix.sdk";
+
+
+/**
+logic of signature generation:
+==============================
+
+1) `id` (path-param) should be the first argument.
+2) if there are more identifiers (path-params), a parent object called `identifiers` containing those will be the first argument.
+3) first payload member will be the second argument unless overridden via proto option. in case of override, args will be taken from override option value in-order.
+4) rest of arguments (if exist) will follow under the `options` parent.
+
+internal logic for `identifiers` field:
+take all path-params, merge with all `unique` fields, distinct.
+if you have total args > 1 -> put all in `identifiers` parent.
+otherwise - use single (usually id) arg as is and make it the first param.
+
+`sdk.signature.params` cannot control neither `options` (last param) nor `id`/`identifiers` (first param) as those are needed by convention in Velo.
+
+
+Examples:
+=========
+
+  // Example-1: Default behavior, single identifier:
+  message GetProductRequest {
+    option (.wix.api.unique) = {field: "id"}; //not needed, automatically assumed
+    string id = 1;
+    string product_family = 2;
+    bool include_pii = 3;
+  }
+  rpc GetProduct (GetProductRequest) returns (GetProductResponse) {
+    option (google.api.http) = {
+      get = "/v1/products/{id}"
+    };
+    // ...
+  }
+  // Resulted signature: getProduct(id: string, productFamily: string, options: {includePii: boolean}) Product {...}
+  {
+    sdkSignatures: [
+      {
+        args: [
+          {
+            field: {
+              path: "id"  <-- field name in proto request message
+            }
+          },
+          {
+            field: {
+              path: "productFamily"  <-- field name in proto request message
+            }
+          },
+          parent: {
+            name: "options"
+            fields: [
+              {
+                path: "includePii" <-- field name in proto request message
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+
+  // Example-2: Default behavior, multiple identifiers:
+    message GetProductRequest {
+      option (.wix.api.unique) = {
+        field: "catalogId"
+        field: "productId"
+      };
+      string catalogId = 1;
+      string productId = 2;
+      string product_family = 3;
+      bool include_pii = 4;
+    }
+  rpc GetProduct (GetProductRequest) returns (GetProductResponse) {
+    option (google.api.http) = {
+      get = "/v1/catalog/{catalogId}/products/{productId}"
+    };
+    // ...
+  }
+  // Resulted signature: getProduct(identifiers: {catalogId: string, productId: string}, productFamily: string, options: {includePii: boolean}) Product {...}
+  // schema response:
+  {
+    sdkSignatures: [
+      {
+        args: [
+          {
+            parent: {
+              name: "identifiers"
+              fields: [
+                {
+                  path: "catalogId"  <-- field name in proto request message
+                },
+                {
+                  path: "productId" <-- field name in proto request message
+                },
+              ]
+            }
+          },
+          {
+            field: {
+              path: "productFamily" <-- field name in proto request message
+            }
+          },
+          parent: {
+            name: "options"
+            fields: [
+              {
+                path: "includePii" <-- field name in proto request message
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+
+  // Example-3: Using override option, multiple identifiers:
+    message GetProductRequest {
+      option (.wix.api.unique) = {
+        field: "catalogId"
+        field: "productId"
+      };
+      string catalogId = 1;
+      string productId = 2;
+      string product_family = 3;
+      bool include_pii = 4;
+    }
+  rpc GetProduct (GetProductRequest) returns (GetProductResponse) {
+    option (google.api.http) = {
+      get = "/v1/catalog/{catalogId}/products/{productId}"
+    };
+    option (.wix.sdk.signature) = {
+      params = "include_pii" // the rest will be auto wired to options arg
+    };
+    // ...
+  }
+  // Resulted signature: getProduct(identifiers: {catalogId: string, productId: string}, includePii: boolean, options: {productFamily: string}) Product {...}
+  // schema response:
+  {
+    sdkSignatures: [
+      {
+        args: [
+          {
+            parent: {
+              name: "identifiers"
+              fields: [
+                {
+                  path: "catalogId"  <-- field name in proto request message
+                },
+                {
+                  path: "productId" <-- field name in proto request message
+                }
+              ]
+            }
+          },
+          {
+            field: {
+              path: "includePii" <-- field name in proto request message
+            }
+          },
+          parent: {
+            name: "options"
+            fields: [
+              {
+                path: "productFamily" <-- field name in proto request message
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  }
+**/
+
+extend google.protobuf.MethodOptions {
+  repeated Signature signature = 60100;
+}
+
+message Signature {
+  repeated string params = 1;
+}