@wix/bex-utils 1.28.0

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/coupons/api/v1/cart.proto

@@ -0,0 +1,44 @@
+syntax = "proto3";
+
+package wix.coupons.api.v1;
+
+option java_package = "com.wix.coupons.api.v1";
+
+// Cart is passed to coupon service's apply function in order to
+// apply the coupons calculation on it
+message Cart {
+
+    message AppliedDiscount {
+        double discountAmount = 1; // the amount of the discount in case discount is given per line
+        double afterDiscountAmount = 2; // the amount of the line item after applying the discount
+        repeated string appliedLineId = 3; // if this discount is related to lineIds they will be listed here
+    }
+
+    // represents a single line in the cart
+    message LineItem {
+        string lineId = 1; // the id of the cart line item (could be 1,2,3) (mandatory)
+        string externalId = 2; // the id of the item in the external system - usually will be product id
+        double amount = 3; // the amount of the line item (while quantity = 1)
+        int32 quantity = 4; // the quantity of this line item. must be > 0
+        repeated string scopes = 5; // which scopes does this line item refers to
+        AppliedDiscount appliedDiscount = 6; // after calculation - the applied discount on that line
+    }
+
+    message Totals {
+        double subTotal = 1; // cart subtotal
+        double discount = 2; // sum of all discounts
+        double total = 3;
+    }
+
+    // represents the shipping line in the cart
+    // the coupons need to know about it because of the free shipping coupon
+    message Shipping {
+        double amount = 1; // the shipping amount before applying the coupon
+        AppliedDiscount appliedDiscount = 2; // after calculation - the discount on shipping
+    }
+
+    repeated LineItem lineItems = 1; // array of line items of the cart
+    Shipping shipping = 2; // the shipping line in the cart
+    Totals totals = 3; // summary of cart totals
+}
+

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/coupons/api/v1/coupon.proto

@@ -0,0 +1,25 @@
+syntax = "proto3";
+
+package wix.coupons.api.v1;
+
+import "wix/coupons/api/v1/specification.proto";
+import "wix/api/entity.proto";
+
+option java_package = "com.wix.coupons.api.v1";
+
+// Coupon represents all information available for a coupon
+// including its basic definition and runtime information
+message Coupon {
+    option (wix.api.entity) = {
+        fqdn: "wix.coupons.api.v1.coupon"
+        segment: PUBLIC
+    };
+    string id = 1; // the id of the coupon. should not be passed on creation
+
+    Specification specification = 2; // the basic meta data of the coupon
+
+    // runtime information about the coupon
+    int64 createdTime = 10; // creation time of the coupon in milliseconds since 1/1/1970
+    bool expired = 11; // is the coupon expired
+    int32 usedCount = 12; // how many times was this coupon used
+}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/coupons/api/v1/coupons-adapter.proto

@@ -0,0 +1,101 @@
+syntax = "proto3";
+
+package wix.coupons.api.v1;
+
+import "google/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+import "google/protobuf/wrappers.proto";
+
+option java_package = "com.wix.coupons.api.v1";
+
+service CouponsAdapter {
+    option (wix.api.service_exposure) = PRIVATE;
+
+    rpc GetItemsForCoupons (GetItemsForCouponsRequest) returns (GetItemsForCouponsResponse) {
+        option (google.api.http) = {
+            get: "/api/v1/items-for-coupons/group/{group}/ids/{ids}"
+            additional_bindings {
+                get: "/api/v1/items-for-coupons/group/{group}/limit/{limit}/offset/{offset}"
+            }
+        };
+        option (wix.api.maturity) = ALPHA;
+        option (wix.api.exposure) = INTERNAL;
+    }
+}
+
+message GetItemsForCouponsRequest {
+    string group = 1;
+    string ids = 2;
+    int32 limit = 3;
+    int32 offset = 4;
+}
+
+message ItemForCoupon {
+    string id = 1;
+    string name = 2;
+    MediaItem mediaItem = 3;
+    google.protobuf.StringValue formattedPrice = 4;
+}
+
+message GetItemsForCouponsResponse {
+    repeated ItemForCoupon items = 1;
+}
+
+
+service CouponsManagerUI {
+    option (wix.api.service_exposure) = PRIVATE;
+
+    rpc GetAllScopeConfigs (AllScopeConfigsRequest) returns (AllScopeConfigsResponse) {
+        option (google.api.http) = {
+            get: "/api/v1/coupons-scope-configs"
+        };
+    }
+}
+
+message AllScopeConfigsRequest {
+}
+
+message AllScopeConfigsResponse {
+    repeated string supportedCouponTypes = 1; // coupon types from all scopes
+    repeated ScopeConfig scopeConfigs = 2; // scopeConfigs from all verticals
+}
+
+message ScopeConfig {
+    string namespace = 1; // stores / bookings / events
+    google.protobuf.StringValue group = 2; // group - optional
+    string displayName = 3; // name in drop down
+    string type = 4; // "SCOPE"/"MINSUBTOTAL"/"DEFAULT"
+    InputDataConfig inputDataConfig = 5; // right drop down data - optional
+    LimitedToOneItemConfig limitedToOneItem = 6;
+    LimitPerCustomerConfig limitPerCustomer = 8;
+    SubscriptionConfig subscriptionConfig = 9;
+    repeated string supportedCouponTypes = 7;
+}
+
+message InputDataConfig {
+    string label = 1;
+    string placeholder = 2;
+    bool shouldShowMedia = 3;
+}
+
+message LimitedToOneItemConfig {
+    bool visible = 1;
+    bool default = 2;
+}
+
+message SubscriptionConfig {
+    bool visible = 1;
+    bool default = 2;
+}
+
+message LimitPerCustomerConfig {
+    bool visible = 1;
+    bool default = 2;
+}
+
+message MediaItem {
+    string url = 1 [(wix.api.format)=URI]; // Media item URL
+    int32 width = 2 [(wix.api.min)=0,(wix.api.max)=5000]; // Media item width
+    int32 height = 3 [(wix.api.min)=0,(wix.api.max)=5000]; // Media item height
+}

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

@@ -0,0 +1,206 @@
+syntax = "proto3";
+
+package wix.coupons.api.v1;
+
+import "wix/coupons/api/v1/specification.proto";
+import "wix/coupons/api/v1/coupon.proto";
+import "wix/coupons/api/v1/cart.proto";
+import "wix/coupons/api/v1/response-status.proto";
+import "google/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/field_mask.proto";
+import "wix/api/entity.proto";
+
+option java_package = "com.wix.coupons.api.v1";
+
+service Coupons {
+    option (wix.api.service_exposure) = PUBLIC;
+    option (.wix.api.service_entity).message = "wix.coupons.api.v1.Coupon";
+
+    // create a coupon. if a coupon with the same id already exist - an error will be returned
+    rpc Create (CreateCouponRequest) returns (CreateCouponResponse) {
+        option (google.api.http) = {
+            post: "/api/v1/coupons"
+        };
+    }
+
+    // update a coupon. changing coupon type is not allowed
+    rpc Update (UpdateCouponRequest) returns (UpdateCouponResponse) {
+        option (google.api.http) = {
+            patch: "/api/v1/coupons/{id}"
+        };
+    }
+
+    // retrieve a coupon by id or code
+    rpc Get (GetCouponRequest) returns (GetCouponResponse) {
+        option (google.api.http) = {
+            get: "/api/v1/coupons/{id}"
+        };
+    }
+
+    rpc Delete (DeleteCouponRequest) returns (DeleteCouponResponse) {
+        option (google.api.http) = {
+            delete: "/api/v1/coupons/{id}"
+        };
+    }
+
+    // get list of coupons according to the request pagination.
+    // no more than 100 coupons will be returned per request
+    rpc List (ListCouponsRequest) returns (ListCouponsResponse) {
+        option (google.api.http).get = "/api/v1/coupons";
+    }
+
+    // calculate the cart with the coupon.
+    // cart with line items and shipping will be passed and the cart will be returned
+    // along with its coupons calculations applied
+    rpc CalculateCart (CalculateRequest) returns (CalculateResponse) {
+        option (google.api.http) = {
+            post: "/api/v1/coupons/codes/{code}/calculate-cart"
+            additional_bindings {
+                post: "/api/v1/coupons/{id}/calculate-cart"
+            }
+        };
+        option (wix.api.exposure) = INTERNAL;
+    }
+
+    // increase coupon usage increase the usage counter of the coupon
+    // it is the responsibility of the payment process to call it after
+    // the coupon was used
+    rpc IncreaseUsage (IncreaseUsageRequest) returns (IncreaseUsageResponse) {
+        option (google.api.http) = {
+            post: "/api/v1/coupons/{id}/increase-usage"
+        };
+        option (wix.api.exposure) = INTERNAL;
+    }
+
+    // get list of coupons according to the request pagination.
+    // no more than 100 coupons will be returned per request
+    rpc HasCoupons (HasCouponsRequest) returns (HasCouponsResponse) {
+        option (google.api.http).get = "/api/v1/coupons/has-coupons";
+        option (wix.api.exposure) = INTERNAL;
+    }
+
+}
+
+message HasCouponsRequest {
+}
+
+message HasCouponsResponse {
+    bool hasCoupons = 1; // true if store has ever had a coupon
+    repeated Error error = 10;
+}
+
+
+message CreateCouponRequest {
+    Specification specification = 1; // the coupon meta data. id is ignored and created by the server
+}
+
+message CreateCouponResponse {
+    string id = 1; // the id of the created coupon. if the call is successful
+    repeated Error error = 10; // errors, in case call failed
+}
+
+message UpdateCouponRequest {
+    string id = 1;
+    google.protobuf.FieldMask fieldMask = 3; // field mask of fields to update. Valid field masks are
+                                             // code,name,startTime,expirationTime,usageLimit,behavior,scopes,minimumSubtotal,active
+    Specification specification = 2; // the coupon meta data to change. changing the type is not allowed
+}
+
+message UpdateCouponResponse {
+    repeated Error error = 10; // errors, in case call failed
+}
+
+message GetCouponRequest {
+    string id = 1; // id of the coupon
+}
+
+message GetCouponResponse {
+    Coupon coupon = 1; // the returned coupon
+    repeated Error error = 10; // errors, in case call failed
+}
+
+message ListCouponsRequest {
+    int32 offset = 1;
+    int32 limit = 2;
+}
+
+message ListCouponsResponse {
+    repeated Coupon coupons = 1; // list of returned coupons
+    repeated Error error = 10; // errors, in case call failed
+    google.protobuf.Int32Value total = 3;
+}
+
+message CalculateRequest {
+    oneof CalculateBy {
+        string id = 1; // set id for calculating coupon by id (usually for cart calculate phase)
+        string code = 2; // set code for calculating coupon by code (usually for apply coupon phase- for validation)
+        Specification discount = 3; //kind of in memory discount that can be applied when coupon doesn't exist
+    }
+    Cart cart = 10; // the cart with line items and shipping on which to applied the coupon
+    string currencySymbol = 20; // the currency symbol for error message and applied coupon
+    google.protobuf.Int32Value precision = 21; // round the result to /precision/ places after the decimal dot. if not supplied - default to 2
+}
+
+message CalculateResponse {
+    message AppliedCoupon {
+        string name = 1; // name of the coupon applied
+        string id = 3; // the coupon id which is used for the calculation
+        string code = 4; // the coupon id which is used for the calculation
+        bool isFreeShipping = 5;
+        string couponType = 6;
+        string discountValue = 7;
+    }
+    Cart cart = 1; // the calculated cart which is returned after applying the coupon
+    AppliedCoupon appliedCoupon = 2; // information about the applied coupon
+    repeated Error error = 10; // errors, in case call failed
+}
+
+message IncreaseUsageRequest {
+    string id = 1; // which coupon id
+    google.protobuf.StringValue usedBy = 2; // optional unique identifier in order for the increase usage to be idempotent
+}
+
+message IncreaseUsageResponse {
+    repeated Error error = 10; // errors, in case call failed
+}
+
+
+message DeleteCouponRequest {
+    string id = 1; // which coupon id to delete
+}
+
+message DeleteCouponResponse {
+    repeated Error error = 10; // errors, in case call failed
+}
+
+
+
+
+
+message Query {
+    // not used yet
+    Paging paging = 1;
+    // A filter string, supports filter by expired and specification.active for now according to platformization query guidelines.
+    // example: {"expired":"true"} will return expired coupons
+    google.protobuf.StringValue filter = 2;
+    // Sort string, not used yet
+    google.protobuf.StringValue sort = 3;
+}
+
+message Paging {
+    // The number of items to load
+    google.protobuf.Int32Value limit = 1 [(wix.api.min)=0,(wix.api.max)=100];
+    // Offset since the begginging of the collection
+    google.protobuf.Int32Value offset = 2[(wix.api.min)=0];
+}
+
+message PagingMetadata {
+    // Requested number of items to load
+    int32 items = 1;
+    // Requested offset since the begginging of the collection
+    int32 offset = 2;
+}
+

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/coupons/api/v1/response-status.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+
+package wix.coupons.api.v1;
+
+option java_package = "com.wix.coupons.api.v1";
+
+message Error {
+    string code = 1; // error code
+    string message = 2; // descriptive error message
+}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/coupons/api/v1/specification.proto

@@ -0,0 +1,37 @@
+syntax = "proto3";
+
+package wix.coupons.api.v1;
+
+import "google/protobuf/wrappers.proto";
+
+option java_package = "com.wix.coupons.api.v1";
+
+message Specification {
+    // coupons data
+
+    google.protobuf.StringValue name = 2; // friendly name for display. up to 80 characters
+    google.protobuf.StringValue code = 3; // the code by which the end user is applying the coupon. up to 20 characters. must be unique
+    google.protobuf.Int64Value startTime = 4; // what time to start using this coupon. in milliseconds. mandatory
+    google.protobuf.Int64Value expirationTime = 5; // when will this coupon expire. in milliseconds. optional
+    google.protobuf.Int32Value usageLimit = 6; // what is the usage limit. if not supplied then it is unlimited by number
+    google.protobuf.BoolValue perItem = 7; // coupon is applied for each item in scope. the default is applied once
+    google.protobuf.BoolValue active = 8; // the coupon in active state. inactive coupon will be ignored when applied
+                                          // if not passed - the default is active
+    google.protobuf.DoubleValue minimumSubtotal = 9; // limit the coupon to carts which their subtotal is above this number
+    repeated string scopes = 10; // if scopes is empty - the coupon is applied on the whole cart
+                                 // otherwise the calculation is matching the line item scopes against the coupon scope
+
+    // coupon type and information according to its type
+    // the coupon type is mandatory and must be passed on creation
+    message BuyXGetY { int32 x = 1; int32 y = 2; }
+    oneof Behavior {
+        double moneyOffAmount = 11; // discount by amount
+        double percentOffRate = 12; // discount by percentage rate
+        bool freeShipping = 13; // free shipping
+        double fixedPriceAmount = 14; // the price of the
+        BuyXGetY buyXGetY = 15;
+    }
+}
+
+
+

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/coupons/api/v2/cart.proto

@@ -0,0 +1,46 @@
+syntax = "proto3";
+
+package wix.coupons.api.v2;
+
+import "wix/coupons/api/v2/scope.proto";
+
+option java_package = "com.wix.coupons.api.v2";
+
+// Cart is passed to coupon service's apply function in order to
+// apply the coupons calculation on it
+message Cart {
+
+    message AppliedDiscount {
+        double discount_amount = 1; // Discount amount, in case discount is applied per line.
+        double after_discount_amount = 2; // Line item price after applied discount.
+    }
+
+    // represents a single line in the cart
+    message LineItem {
+        string line_id = 1; //  Cart line item ID - represents index position (required).
+        string external_id = 2; // Item ID in the external system - will usually be a product ID.
+        double amount = 3; // Line item amount (while quantity = 1).
+        int32 quantity = 4; // Line item quantity. Must be greater than 0.
+        repeated Scope scopes = 5; // Coupon scopes this line item applies to.
+        AppliedDiscount applied_discount = 6; // Applied discount on line item after calculation.
+        bool subscription= 7; // // Whether the line item is of type subscription.
+    }
+
+    message Totals {
+        double sub_total = 1; // Cart subtotal.
+        double discount = 2; // Sum of all discounts.
+        double total = 3;
+    }
+
+    // represents the shipping line in the cart
+    // the coupons need to know about it because of the free shipping coupon
+    message Shipping {
+        double amount = 1; // Shipping price before applying the coupon.
+        AppliedDiscount applied_discount = 2; // Discount on shipping price.
+    }
+
+    repeated LineItem line_items = 1; // Array of cart line items.
+    Shipping shipping = 2; // Cart shipping information.
+    Totals totals = 3; // Summary of cart totals.
+}
+

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/coupons/api/v2/coupon.proto

@@ -0,0 +1,43 @@
+syntax = "proto3";
+
+package wix.coupons.api.v2;
+
+import "wix/coupons/api/v2/specification.proto";
+import "google/protobuf/wrappers.proto";
+import "wix/coupons/api/v2/mediaitem.proto";
+import "wix/api/entity.proto";
+import "wix/api/validations.proto";
+
+option java_package = "com.wix.coupons.api.v2";
+
+// The `Coupon` object represents all information available for a coupon
+// including its basic definition and runtime information.
+message Coupon {
+    option (wix.api.entity) = {
+        fqdn: "wix.ecommerce.coupons.v2.coupon"
+        appendix_files: {
+            type: AUTO_VELO
+            path: "appendices/velo"
+        };
+    };
+
+    string id = 1; // Coupon ID.
+
+    Specification specification = 2; // Basic coupon info.
+
+    int64 date_created = 10; // Time the coupon was created (UNIX Epoch time in milliseconds).
+    bool expired = 11; // Whether the coupon is expired.
+
+    int32 number_of_usages = 12; // How many times this coupon has been used.
+
+    message DisplayData {
+        string name = 1; // Coupon name to be displayed.
+        MediaItem media_item = 2; // Displayed media item information.
+        google.protobuf.StringValue formatted_price = 3; // Formatted price for display.
+    }
+
+    DisplayData display_data = 20; // Coupon display information.
+
+    google.protobuf.StringValue app_id = 21 [(wix.api.format) = GUID, (wix.api.readOnly) = true]; // ID of the app that created the coupon. Empty if created by the site owner.
+}
+

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/coupons/api/v2/couponAppliedEvent.proto

@@ -0,0 +1,25 @@
+syntax = "proto3";
+
+package wix.coupons.api.v2;
+
+import "wix/coupons/api/v2/coupon.proto";
+import "wix/api/validations.proto";
+import "wix/api/action_payload.proto";
+
+option java_package = "com.wix.coupons.api.v2";
+
+message CouponApplied {
+    option (wix.api.action_payload).custom_slug = "applied";
+
+    // Applied coupon information.
+    Coupon coupon = 1;
+
+    // ID of Wix app that applied the coupon. Supported values:
+    // + Wix Stores - `1380b703-ce81-ff05-f115-39571d94dfcd`
+    // + Wix Bookings - `13d21c63-b5ec-5912-8397-c3a5ddb27a97`
+    // + Wix Events - `140603ad-af8d-84a5-2c80-a0f60cb47351`
+    string wix_app_id = 2 [(wix.api.format) = GUID];
+
+    // ID of the entity that the coupon was applied to (orderId, bookingId, etc.).
+    string wix_app_order_id = 3;
+}

package/@wix/ambassador-fedinfra-exportservice-v1-export-async-job/src/main/proto/wix/coupons/api/v2/coupons-adapter.proto

@@ -0,0 +1,61 @@
+syntax = "proto3";
+
+package wix.coupons.api.v2;
+
+import "google/api/annotations.proto";
+import "wix/api/validations.proto";
+import "wix/api/annotations.proto";
+import "wix/coupons/api/v2/item-for-coupon.proto";
+import "google/protobuf/wrappers.proto";
+
+option java_package = "com.wix.coupons.api.v2";
+
+service CouponsAdapter {
+    option (wix.api.service_exposure) = PRIVATE;
+
+    rpc GetItemsForCouponsByIds (GetItemsForCouponsByIdsRequest) returns (GetItemsForCouponsResponse) {
+        option (google.api.http) = {
+            get: "/api/v2/items-for-coupons-by-ids"
+        };
+        option (wix.api.maturity) = ALPHA;
+    }
+
+    rpc GetItemsForCouponsByFilters (GetItemsForCouponsByFiltersRequest) returns (GetItemsForCouponsResponse) {
+        option (google.api.http) = {
+            get: "/api/v2/items-for-coupons-by-filters"
+        };
+        option (wix.api.maturity) = ALPHA;
+    }
+
+    rpc GetItemsForShoutout (GetItemsForShoutoutRequest) returns (GetItemsForCouponsResponse) {
+        option (google.api.http) = {
+            get: "/api/v2/items-for-shoutout"
+        };
+        option (wix.api.maturity) = ALPHA;
+    }
+}
+
+message GetItemsForCouponsByIdsRequest {
+    string group = 1;
+    repeated string ids = 2 [(wix.api.maxLength)=100];
+}
+
+message GetItemsForCouponsByFiltersRequest {
+    string group = 1;
+    int32 offset = 2;
+    int32 limit = 3 [(wix.api.max) = 100];
+    google.protobuf.StringValue text = 4;
+}
+
+message GetItemsForShoutoutRequest {
+    google.protobuf.StringValue group = 1;
+    google.protobuf.StringValue entityId = 2;
+}
+
+message GetItemsForCouponsResponse {
+    repeated ItemForCoupon items = 1;
+    int32 totalCount = 2;
+}
+
+
+