@wix/bex-utils 1.28.0

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/payment/api/pay/v2/orders.proto

@@ -0,0 +1,588 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "google/api/annotations.proto";
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/timestamp.proto";
+import "wix/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/payment/api/pay/v2/resources/address.proto";
+import "wix/payment/api/pay/v2/resources/order.proto";
+import "wix/payment/api/pay/v2/resources/order-cof-intent.proto";
+import "wix/api/entity.proto";
+import "wix/api/permissions.proto";
+import "wix/api/api_errors.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+service OrderService {
+
+    option (wix.api.service_entity).message = "wix.payment.api.pay.v2.Order";
+
+    // **Only Server to server calls are allowed.**
+    //
+    // Creates a new order in the account and sets its [state][2] to
+    // `Initialized`. When creating a new order, you need to supply also
+    // relevant return URLs where the user will be redirected following the
+    // transaction, as well as event hooks to deal with async payment processes.
+    // The newly created order is return, together with a unique order_id.
+    //
+    // Note that in some cases you might want to create order before you have
+    // billing or shipping address. Please use [UpdateBuyerInfo][1] method for
+    // providing any missing details.
+    //
+    // Please checkout Order overview page for more information.
+    //
+    // **Required params**
+    //
+    // - `account_id`
+    // - `description`
+    // - `urls`
+    //
+    // **Auth rules**
+    //
+    // Requires person and server identities to be present.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][3].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity or server identity is missing.
+    //
+    //   [1]: .wix.payment.api.pay.v2.-order-service.-update-buyer-info
+    //   [2]: ../../guides/Order%20overview
+    //   [3]: ../../guides/Authentication%20and%20authorization
+    rpc Create(CreateOrderRequest) returns (CreateOrderResponse) {
+        option (wix.api.required) = "CreateOrderRequest.account_id";
+        option (wix.api.required) = "CreateOrderRequest.description";
+        option (wix.api.required) = "CreateOrderRequest.urls";
+        option (google.api.http) = {
+            post: "/api/payments/v2/orders"
+        };
+
+        option (wix.api.error) = {
+            http_code: FAILED_PRECONDITION
+            application_code: "AUTH_CAPTURE_RECURRING_ORDER"
+        };
+
+        option (wix.api.error) = {
+            http_code: FAILED_PRECONDITION
+            application_code: "AUTH_CAPTURE_SCHEDULED_ACTION"
+        };
+    };
+
+    // Update order, only order without successful transactions can be updated
+    rpc Update(UpdateOrderRequest) returns (UpdateOrderResponse) {
+        option (wix.api.required) = "UpdateOrderRequest.account_id";
+        option (wix.api.required) = "UpdateOrderRequest.description";
+        option (wix.api.required) = "UpdateOrderRequest.urls";
+        option (google.api.http) = {
+            put: "/api/payments/v2/orders/{order_id}"
+        };
+    }
+
+    // Creates a new setup order with zero amount, and default values in order to authorize payment.
+    // Newly created setup order is returned, together with unique order_id.
+    //
+    // **Required params**
+    //
+    // - `currency`
+    //
+    // **Auth rules**
+    //
+    // Requires member identity and cashier app installed on the meta site.
+    //
+    // **Error responses**
+    //
+    // - 403 - member identity is missing or cashier app is not installed.
+    rpc Setup(SetupRequest) returns (SetupResponse) {
+        option (google.api.http) = {
+            post: "/api/payments/v2/orders/setup"
+        };
+    }
+
+    // Updates order if it is in Initialized state. Otherwise, `InvalidOrderSnapshotStateException` is thrown.
+    //
+    // **Auth rules**
+    //
+    // Requires person identity to be present.
+    //
+    // Person identity has permissions to update buyer info if it was used to
+    // create the order.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][1].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity is missing.
+    // - 403 - passed identity does not have permission to read this order.
+    //
+    //   [1]: ../../guides/Authentication%20and%20authorization
+    rpc UpdateBuyerInfo(UpdateBuyerInfoRequest) returns (UpdateBuyerInfoResponse) {
+        option (google.api.http) = { post: "/api/payments/v2/orders/{order_id}/buyer-info" };
+    };
+
+    // Returns information about particular order.
+    //
+    // **Auth rules**
+    //
+    // Requires person or server identity to be present.
+    //
+    // Server identity has permissions to view the order without any additional
+    // rules.
+    //
+    // Person identity has permissions to view the order iff it was used to
+    // create an order or it represents the site owner.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][1].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity and server identity are both missing.
+    // - 403 - passed identity does not have permission to perform this action.
+    //
+    //   [1]: ../../guides/Authentication%20and%20authorization
+    rpc Get(GetOrderRequest) returns (GetOrderResponse) {
+        option (google.api.http) = { get: "/api/payments/v2/orders/{order_id}" };
+    };
+
+    // If order is a subscription - cancels it. Otherwise, `CancelSubscriptionException` is thrown.
+    //
+    // **Auth rules**
+    //
+    // Requires person identity to be present.
+    //
+    // Person identity has permissions to cancel subscription iff it was
+    // used to create an order or it represents the site owner.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][1].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity is missing.
+    // - 403 - passed identity does not have permission to perform this action.
+    //
+    //   [1]: ../../guides/Authentication%20and%20authorization
+    rpc CancelSubscription(CancelSubscriptionRequest) returns (CancelSubscriptionResponse) {
+        option (google.api.http) = { delete: "/api/payments/v2/orders/{order_id}/subscription" };
+    }
+
+    // If order is a subscription - suspends it. Otherwise, an exception is thrown.
+    //
+    // **Auth rules**
+    //
+    // Requires person identity to be present.
+    //
+    // Person identity has permissions to suspend subscription if it represents the site owner.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][1].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity is missing.
+    // - 403 - passed identity does not have permission to perform this action.
+    //
+    //   [1]: ../../guides/Authentication%20and%20authorization
+    rpc SuspendSubscription(SuspendSubscriptionRequest) returns (SuspendSubscriptionResponse) {
+        option (google.api.http) = { post: "/api/payments/v2/orders/{order_id}/subscription/suspend" };
+    }
+
+    // If order is a subscription - reactivates it after suspension. Otherwise, an exception is thrown.
+    //
+    // **Auth rules**
+    //
+    // Requires person identity to be present.
+    //
+    // Person identity has permissions to reactivate subscription if it represents the site owner.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][1].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity is missing.
+    // - 403 - passed identity does not have permission to perform this action.
+    //
+    //   [1]: ../../guides/Authentication%20and%20authorization
+    rpc ReactivateSubscription(ReactivateSubscriptionRequest) returns (ReactivateSubscriptionResponse) {
+        option (google.api.http) = { post: "/api/payments/v2/orders/{order_id}/subscription/reactivate" };
+    }
+
+    // Disables subscription from the recurring engine in order to move its management to BASS.
+    // If order is not a subscription an exception is thrown.
+    //
+    // **Auth rules**
+    //
+    // Requires person identity to be present.
+    //
+    // Person identity has permissions to disable subscription if it represents the site owner.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][1].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity is missing.
+    // - 403 - passed identity does not have permission to perform this action.
+    //
+    //   [1]: ../../guides/Authentication%20and%20authorization
+    rpc DisableSubscription(DisableSubscriptionRequest) returns (DisableSubscriptionResponse) {
+        option (google.api.http) = { post: "/api/payments/v2/orders/{order_id}/subscription/disable" };
+    }
+
+    // Disables subscription from the recurring engine in order to move its management to BASS.
+    // If order is not a subscription an exception is thrown.
+    //
+    // **Auth rules**
+    //
+    // Requires person identity to be present.
+    //
+    // Person identity has permissions to disable subscription if it represents the site owner.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][1].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity is missing.
+    // - 403 - passed identity does not have permission to perform this action.
+    //
+    //   [1]: ../../guides/Authentication%20and%20authorization
+    rpc EnableSubscription(EnableSubscriptionRequest) returns (EnableSubscriptionResponse) {
+        option (google.api.http) = { post: "/api/payments/v2/orders/{order_id}/subscription/enable" };
+    }
+
+    // If order is a subscription returns subscription details. Otherwise, and exception is thrown.
+    //
+    // **Auth rules**
+    //
+    // Requires person identity to be present.
+    //
+    // Person identity has permissions to get subscription details if it was
+    // used to create an order or it represents the site owner.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][1].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity is missing.
+    // - 403 - passed identity does not have permission to perform this action.
+    //
+    //   [1]: ../../guides/Authentication%20and%20authorization
+    rpc GetSubscriptionInfo (GetSubscriptionInfoRequest) returns (GetSubscriptionInfoResponse) {
+        option (google.api.http) = { get: "/api/payments/v2/orders/{order_id}/subscription/info" };
+    }
+
+    // If order is a subscription in Initialized state - changes it`s start date. Otherwise, an exception is thrown.
+    //
+    // **Auth rules**
+    //
+    // Requires server signing to be present.
+    //
+    // ManagingWixAppId must be the same as in the subscription.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][1].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity is missing.
+    // - 403 - passed identity does not have permission to perform this action.
+    //
+    //   [1]: ../../guides/Authentication%20and%20authorization
+    rpc UpdateSubscription (UpdateSubscriptionRequest) returns (UpdateSubscriptionResponse) {
+        option (google.api.http) = { patch: "/api/payments/v2/orders/{order_id}/subscription" };
+    };
+
+    // **Only Server to server calls are allowed.**
+    //
+    // Clears payment method credentials stored after successful payment
+    // e.g. if an order has been created with `cof_intent.setup_cof_recurring.store_payment_credentials`
+    rpc ClearPaymentCredentials (ClearPaymentCredentialsRequest) returns (ClearPaymentCredentialsResponse) {
+        option (google.api.http) = { post: "/api/payments/v2/orders/{order_id}/clear-payment-credentials" };
+    };
+
+    rpc UpdateManagingWixAppId (UpdateManagingWixAppIdRequest) returns (UpdateManagingWixAppIdResponse) {
+        option (wix.api.maturity) = ALPHA;
+        option (wix.api.exposure) = PRIVATE;
+    };
+
+    // Removes user data from orders with given ids and all their transactions
+    //
+    // Doesn't work with transaction service transactions
+    // If your flow uses transaction service you need to call TransactionService endpoint anonymizeTransactions
+    //
+    // **Auth rules**
+    //
+    // Requires CASHIER.ORDERS_ANONYMIZE permission
+    // ManagingWixAppId must be the same as in the all orders.
+    //
+    rpc AnonymizeOrders(AnonymizeOrdersRequest) returns (AnonymizeOrdersResponse) {
+        option (wix.api.permission).name = "CASHIER.ORDERS_ANONYMIZE";
+        option (google.api.http) = { post: "/api/payments/v2/orders/anonymize" };
+    }
+
+    // Find agreement id by order id
+    rpc FindAgreementIdByOrderId(FindAgreementIdByOrderIdRequest) returns (FindAgreementIdByOrderIdResponse) {
+        option (wix.api.permission).name = "PAYMENTS.AGREEMENTS_READ";
+        option (google.api.http) = { get: "/api/payments/v2/orders/{order_id}/agreement" };
+   }
+
+  rpc Expire(ExpireOrderRequest) returns (ExpireOrderResponse) {
+    option (google.api.http) = { post: "/api/payments/v2/orders/{order_id}/expire" };
+  }
+}
+
+// Describing `Create` order request.
+message CreateOrderRequest {
+    // Unique identifier on an account for which the order is created (required).
+    //
+    // Logical owner of an order. For Wix TPAs `account_id` is a pair of `appId:instanceId`
+    string account_id            = 1;
+
+    // Description of new order (required).
+    OrderDescription description = 2;
+
+    // Third party system urls which should be used when as callback/event_hook (required).
+    OrderUrls urls               = 3;
+
+    // Credential-on-File intent when externally initiating recurring payments. Should not be specified for one-time payments.
+    CofIntent cof_intent         = 4;
+
+    // Idempotency key
+    google.protobuf.StringValue idempotency_key = 5;
+
+}
+
+// Describing `Create` order response.
+message CreateOrderResponse {
+    // newly created order
+    Order order = 1;
+}
+
+message UpdateOrderRequest {
+    // unique identifier of order
+    string order_id                    = 1;
+
+    // Unique identifier on an account for which the order is created (required).
+    //
+    // Logical owner of an order. For Wix TPAs `account_id` is a pair of `appId:instanceId`
+    string account_id            = 2;
+
+    // Description of new order (required).
+    OrderDescription description = 3;
+
+    // Third party system urls which should be used when as callback/event_hook (required).
+    OrderUrls urls               = 4;
+}
+
+message UpdateOrderResponse {
+    // updated order
+    Order order = 1;
+}
+
+message SetupRequest {
+    // Currency of the order (required). Supported values are: AFN, USD, EUR, BMD, BGN, BIF, CVE, KMF, CDF, DJF, ERN, FKP, GHS, GNF, LAK, LSL, LYD, MWK, MRO, MZN, PAB, RON, RUB, SHP, RSD, SLL, SBD, SOS, SZL, TJS, TOP, TMT, YER, ZMW, GIP, ZAR, XPF, XOF, XCD, XAF, WST, VUV, VND, VEF, UZS, UYU, UGX, UAH, TZS, TWD, TTD, TRY, TND, THB, STD, SGD, SEK, SCR, SAR, RWF, QAR, PYG, PLN, PKR, PHP, PGK, PEN, OMR, NZD, NPR, NOK, NIO, NGN, MYR, MXN, MVR, MUR, MOP, MNT, MMK, MKD, MDL, MAD, LRD, LKR, LBP, KZT, KYD, KWD, KRW, KHR, KGS, KES, JPY, JOD, JMD, ISK, INR, ILS, IDR, HUF, HTG, HRK, HNL, HKD, GYD, GTQ, GMD, GEL, GBP, FJD, ETB, EGP, DZD, DOP, DKK, CZK, CRC, COP, CNY, CLP, CHF, CAD, BZD, BYN, BWP, BTN, BSD, BRL, BOB, BND, BHD, BDT, BBD, BAM, AZN, AWG, AUD, ARS, AOA, ANG, AMD, ALL, AED, MGA, MZN, NAD, RON, GHS, SRD, TMT, ZMW, IQD
+    string currency                   = 1;
+    // Buyer information which can use to provide better service (optional)
+    OrderBuyerInfo buyer_info         = 2;
+    // Is this order creation initiated by merchant
+    bool merchant_initiated           = 3;
+}
+
+message SetupResponse {
+    // newly created order
+    Order order = 1;
+}
+
+// Describing `UpdateBuyerInfo` request.
+message UpdateBuyerInfoRequest {
+    // unique identifier of an order which should be updated (required)
+    string order_id           = 1;
+
+    // billing address of the order (optional)
+    Address billing_address   = 2;
+
+    // billing address of the order (optional)
+    Address shipping_address  = 3;
+
+    // buyer information which can be used to provide better service (optional)
+    OrderBuyerInfo buyer_info = 4;
+}
+
+// Describing `UpdateBuyerInfo` response.
+message UpdateBuyerInfoResponse {
+    // unique identifier of the order
+    string order_id              = 1;
+
+    // order description
+    OrderDescription description = 2;
+}
+
+// Describing `Get` order request.
+message GetOrderRequest {
+    // unique identifier of requested order
+    string order_id = 1;
+}
+
+// Describing `Get` order response.
+message GetOrderResponse {
+    // the order returned by GetOrder request
+    Order order = 1;
+}
+
+// Describing `CancelSubscription` request.
+message CancelSubscriptionRequest {
+    // unique identifier of an order which subscription should be canceled
+    string order_id = 1;
+}
+
+// Describing `CancelSubscription` response.
+message CancelSubscriptionResponse {}
+
+// Describing `GetSubscriptionInfo` request.
+message GetSubscriptionInfoRequest {
+
+    // unique identifier of an order which subscription details should be returned
+    string order_id = 1;
+}
+
+// Describing `GetSubscriptionInfo` response.
+message GetSubscriptionInfoResponse {
+
+    // number of cycles paid successfully
+    uint32 total_successful_payments = 1;
+
+    // number of pay cycles in subscription or empty if indefinite
+    google.protobuf.UInt32Value total_billing_cycles = 2;
+
+    // The payment method used to setup subscription
+    google.protobuf.StringValue payment_method = 3;
+
+    // The date and time of the last successful charge
+    google.protobuf.Timestamp last_successfully_charged_date = 4;
+
+    // The date and time of the next charge attempt
+    google.protobuf.Timestamp next_charge_attempt_date = 5;
+
+    bool suspendable = 6;
+
+    // Number of current billing cycle starting from 0. Empty until a first payment is attempted and during a free trial.
+    google.protobuf.UInt32Value current_cycle_number = 7;
+}
+
+// Describing `SuspendSubscription` request.
+message SuspendSubscriptionRequest {
+    // unique identifier of an order which subscription should be suspended
+    string order_id = 1;
+}
+
+// Describing `SuspendSubscription` response.
+message SuspendSubscriptionResponse {
+}
+
+// Describing `ReactivateSubscription` request.
+message ReactivateSubscriptionRequest {
+    // unique identifier of an order which subscription should be reactivated
+    string order_id = 1;
+}
+
+// Describing `ReactivateSubscription` response.
+message ReactivateSubscriptionResponse {
+}
+
+// Describing `UpdateSubscription` request.
+message UpdateSubscriptionRequest {
+    // unique identifier of an order which subscription should be updated
+    string order_id = 1;
+
+    // date in the future or in the past when the first billing cycle begins
+    // (the first off-session payment is performed when it ends)
+    google.protobuf.Timestamp first_cycle_start_date = 2;
+
+    UpdateIncludedCharges included_charges = 3;
+}
+
+// Describing `UpdateSubscription` response.
+message UpdateSubscriptionResponse {
+    // unique identifier of the order
+    string order_id              = 1;
+
+    // updated order description
+    OrderDescription description = 2;
+}
+
+// Describing `DisableSubscription` request.
+message DisableSubscriptionRequest {
+    // unique identifier of an order which subscription should be disabled
+    string order_id = 1;
+}
+
+// Describing `DisableSubscription` response.
+message DisableSubscriptionResponse {
+}
+
+// Describing `EnableSubscription` request.
+message EnableSubscriptionRequest {
+    // unique identifier of an order which subscription should be enabled
+    string order_id = 1;
+}
+
+// Describing `EnableSubscription` response.
+message EnableSubscriptionResponse {
+}
+
+message UpdateIncludedCharges {
+    google.protobuf.DoubleValue tax = 1;
+}
+
+// Describing `ClearPaymentCredentials` request.
+message ClearPaymentCredentialsRequest {
+    // unique identifier of an order which credentials should be cleared
+    string order_id = 1;
+}
+
+// Describing `ClearPaymentCredentials` response.
+message ClearPaymentCredentialsResponse {
+}
+
+message UpdateManagingWixAppIdRequest {
+    bool resend_events = 1;
+    repeated string order_ids = 2;
+}
+
+message UpdateManagingWixAppIdResponse {
+    uint32 total_orders = 1;
+}
+
+message AnonymizeOrdersRequest {
+    repeated string order_ids = 1;
+}
+
+message AnonymizeOrdersResponse {
+}
+
+message FindAgreementIdByOrderIdRequest {
+    string order_id = 1;
+}
+
+message FindAgreementIdByOrderIdResponse {
+    google.protobuf.StringValue payment_agreement_id = 1;
+}
+
+message ExpireOrderRequest {
+  string order_id = 1;
+}
+
+message ExpireOrderResponse {
+  OrderStatus.Status order_status = 1;
+
+  repeated string pending_transaction_ids = 10;
+}

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

@@ -0,0 +1,42 @@
+syntax = "proto3";
+
+package wix.payment.api.pay.v2;
+
+import "wix/payment/api/pay/v2/resources/payment.proto";
+import "google/api/annotations.proto";
+import "wix/api/entity.proto";
+
+option java_package = "com.wix.payment.api.pay.v2";
+
+service PaymentDetailsService {
+
+    option (wix.api.service_entity).message = "wix.payment.api.pay.v2.PaymentDetails";
+
+    // Stores payment details so one can reference them by ID during payment
+    //
+    // **Auth rules**
+    //
+    // Requires person identity to be present.
+    //
+    // You can find more information about authentication and authorization in a
+    // separate [guide][1].
+    //
+    // **Error responses**
+    //
+    // - 401 - person identity is missing.
+    //
+    //   [1]: ../../guides/Authentication%20and%20authorization
+    rpc Create(CreatePaymentDetailsRequest) returns (CreatePaymentDetailsResponse) {
+        option (google.api.http) = {
+            post: "/api/payments/v2/payment-details"
+        };
+    }
+}
+
+message CreatePaymentDetailsRequest {
+    PaymentDetails details  = 1;
+}
+
+message CreatePaymentDetailsResponse {
+    string details_id   = 1;
+}