workarea-global_e 1.2.1

data/app/services/workarea/global_e/merchant/brand.rb

@@ -0,0 +1,21 @@
+module Workarea
+  module GlobalE
+    module Merchant
+      class Brand
+        # Brand code
+        #
+        # @return [String]
+        #
+        def code
+        end
+
+        # Brand name
+        #
+        # @return [String]
+        #
+        def name
+        end
+      end
+    end
+  end
+end

data/app/services/workarea/global_e/merchant/category.rb

@@ -0,0 +1,21 @@
+module Workarea
+  module GlobalE
+    module Merchant
+      class Category
+        # CategoryCode
+        #
+        # @return [String]
+        #
+        def code
+        end
+
+        # Category name
+        #
+        # @return [String]
+        #
+        def name
+        end
+      end
+    end
+  end
+end

data/app/services/workarea/global_e/merchant/customer.rb

@@ -0,0 +1,36 @@
+module Workarea
+  module GlobalE
+    module Merchant
+      class Customer
+        attr_reader :hash
+
+        def initialize(hash)
+          @hash = hash
+        end
+
+        # Indicates if e-mail confirmation of the respective order’s status
+        # change needs to be sent to the paying customer (Global-e acts
+        # as a paying customer).
+        #
+        # @return [Boolean]
+        #
+        def send_confirmation
+          hash["SendConfirmation"]
+        end
+
+        # Indicates if end customer details are “swapped” with a paying
+        # (Global-e) customer’s details when submitting the order to the
+        # Merchant. By default IsEndCustomerPrimary is FALSE which means that
+        # Primary customer denotes the paying (Global-e) customer and Secondary
+        # customer denotes the end customer who has placed the order with
+        # Global-e checkout
+        #
+        # @return [Boolean]
+        #
+        def is_end_customer_primary
+          hash["IsEndCustomerPrimary"]
+        end
+      end
+    end
+  end
+end

data/app/services/workarea/global_e/merchant/customer_details.rb

@@ -0,0 +1,201 @@
+module Workarea
+  module GlobalE
+    module Merchant
+      class CustomerDetails
+        attr_reader :hash, :url_encoded
+
+        def initialize(hash, url_encoded: false)
+          @hash = hash
+          @url_encoded = url_encoded
+        end
+
+        # Attributes used for saving to a {Workarea::Address}
+        #
+        # @return [Hash]
+        #
+        def workarea_address_attributes
+          {
+            first_name:           first_name,
+            last_name:            last_name,
+            street:               address1,
+            street_2:             address2,
+            city:                 city,
+            region:               state_code,
+            postal_code:          zip,
+            country:              Country[country_code],
+            phone_number:         phone1,
+            skip_region_presence: true
+          }
+        end
+
+        # First Name
+        #
+        # @return [String]
+        #
+        def first_name
+          decode hash["FirstName"]
+        end
+
+        # Last name
+        #
+        # @return [String]
+        #
+        def last_name
+          decode hash["LastName"]
+        end
+
+        # Middle name
+        #
+        # @return [String]
+        #
+        def middle_name
+          decode hash["MiddleName"]
+        end
+
+        # Salutation or title (e.g. Dr., Mr., etc.)
+        #
+        # @return [String]
+        #
+        def salutation
+          decode hash["Salutation"]
+        end
+
+        # Phone 1
+        #
+        # @return [String]
+        #
+        def phone1
+          decode hash["Phone1"]
+        end
+
+        # Phone 2
+        #
+        # @return [String]
+        #
+        def phone2
+          decode hash["Phone2"]
+        end
+
+        # Fax
+        #
+        # @return [String]
+        #
+        def fax
+          decode hash["Fax"]
+        end
+
+        # E-mail address
+        #
+        # @return [String]
+        #
+        def email
+          decode hash["Email"]
+        end
+
+        #  Company name
+        #
+        #  @return [String]
+        #
+        def company
+          decode hash["Company"]
+        end
+
+        # Address line 1
+        #
+        # @return [String]
+        #
+        def address1
+          decode hash["Address1"]
+        end
+
+        # Address line 2
+        #
+        # @return [String]
+        #
+        def address2
+          decode hash["Address2"]
+        end
+
+        # City name
+        #
+        # @return [String]
+        #
+        def city
+          decode hash["City"]
+        end
+
+        # State or province name
+        #
+        # @return [String]
+        #
+        def state_or_province
+          decode hash["StateOrProvince"]
+        end
+
+        # State or province ISO code such as AZ for Arizona (if applicable)
+        #
+        # @return [String]
+        #
+        def state_code
+          decode hash["StateCode"]
+        end
+
+        # Zip or postal code
+        #
+        # @return [String]
+        #
+        def zip
+          decode hash["Zip"]
+        end
+
+        # 2-char ISO country code
+        #
+        # @return [String]
+        #
+        def country_code
+          decode hash["CountryCode"]
+        end
+
+        # Country name
+        #
+        # @return [String]
+        #
+        def country_name
+          decode hash["CountryName"]
+        end
+
+        # Id of the current address from within the address book
+        #
+        # @return [String]
+        #
+        def address_book_id
+          hash["AddressBookId"]
+        end
+
+        # Name of the current address from within the address book
+        #
+        # @return [String]
+        #
+        def address_book_name
+        end
+
+        # Indicates that the current address should be saved in merchant platform
+        #
+        # @return [Boolean]
+        #
+        def save_address
+        end
+
+        private
+
+          def decode(value)
+            if url_encoded && value
+              CGI.unescape value
+            else
+              value
+            end
+          end
+      end
+    end
+  end
+end

data/app/services/workarea/global_e/merchant/discount.rb

@@ -0,0 +1,127 @@
+module Workarea
+  module GlobalE
+    module Merchant
+      class Discount
+        attr_reader :hash
+
+        def initialize(hash)
+          @hash = hash
+        end
+
+        # Discount Name
+        #
+        # @return [String]
+        #
+        def name
+          hash["Name"]
+        end
+
+        # Discount value in currency defined in CurrencyCode property of the
+        # respective Merchant.Order object for the order being submitted to the Merchant.
+        #
+        # @return [Float]
+        #
+        def price
+          hash["Price"]
+        end
+
+        # VAT rate applied to this discount
+        #
+        # @return [Float]
+        #
+        def vat_rate
+          hash["VATRate"]
+        end
+
+        # VAT rate that would be applied to this discount if the order was
+        # placed by the local customer. This value must be specified if
+        # UseCountryVAT for the current Country is TRUE and therefore VATRate
+        # property actually denotes the VAT for the target country.
+        #
+        # @return [Float]
+        #
+        def local_vat_rate
+          hash["LocalVATRate"]
+        end
+
+        # Discount value in end customer’s currency (specified in
+        # InternationalDetails.CurrencyCode property for the respective
+        # Merchant.Order), after applying country coefficient, FX conversion and
+        # IncludeVAT handling.
+        #
+        # @return [Float]
+        #
+        def international_price
+          hash["InternationalPrice"]
+        end
+
+        # Discount textual description
+        #
+        # @return [String]
+        #
+        def description
+          hash["Description"]
+        end
+
+        # Merchant’s coupon code used for this discount (applicable to
+        # coupon-based discounts only)
+        #
+        # @return [String]
+        #
+        def coupon_code
+          hash["CouponCode"]
+        end
+
+        # Identifier of the product cart item related to this discount on the
+        # Merchant’s site originally specified in Discount.ProductCartItemId
+        # property of the respective discount in SendCart method for the cart
+        # converted to this order on Global-e.
+        #
+        # @return [String[
+        #
+        def product_cart_item_id
+          hash["ProductCartItemId"]
+        end
+
+        # Discount code originally specified in Discount.DiscountCode property of
+        # the respective discount in SendCart method for the cart converted to
+        # this order on Global-e.
+        #
+        # @return [String]
+        #
+        def discount_code
+          hash["DiscountCode"]
+        end
+
+        # Loyalty Voucher code originally specified in
+        # Discount.LoyaltyVoucherCode property of the respective discount in
+        # SendCart method for the cart converted to this order on Global-e.
+        #
+        # @return [String]
+        #
+        def loyalty_voucher_code
+          hash["LoyaltyVoucherCode"]
+        end
+
+        # Discount type (“Cart”, “Shipping”, etc.), as defined in
+        # | DiscountType Option Value | Name                             | Description |
+        # | 1                         | Cart Discount                    | Discount related to volume, amount, coupon or another promotion value. |
+        # | 2                         | Shipping Discount                | Discount aimed to sponsor international shipping. |
+        # | 3                         | Loyalty points discount          | Discount applied against the Merchant’s loyalty points to be spent for this purchase. |
+        # | 4                         | Duties discount                  | Discount aimed to sponsor taxes & duties pre- paid by the end customer in Global-e checkout. |
+        # | 5                         | Checkout Loyalty Points Discount | Discount applied against the Merchant’s loyalty points in Global-e checkout. |
+        # | 6                         | Payment Charge                   | Discount aimed to sponsor “Cash on Delivery” fee. |
+        #
+        # @return [Integer]
+        #
+        def discount_type
+          hash["DiscountType"]
+        end
+
+        def shipping?
+          discount_type == 2
+        end
+      end
+    end
+  end
+end

data/app/services/workarea/global_e/merchant/international_details.rb

@@ -0,0 +1,296 @@
+module Workarea
+  module GlobalE
+    module Merchant
+      class InternationalDetails
+        attr_reader :hash
+
+        def initialize(hash)
+          @hash = hash
+        end
+
+        # 3-char ISO code for the currency selected by the end customer for the
+        # order payment.
+        #
+        # @return [String]
+        #
+        def currency_code
+          hash["CurrencyCode"]
+        end
+
+        # Total order price in the currency denoted by CurrencyCode.
+        #
+        # @return [Float]
+        #
+        def total_price
+          hash["TotalPrice"]
+        end
+
+        # 3-char ISO code for the currency actually used for the current order
+        # payment. TransactionCurrencyCode may differ from CurrencyCode if the
+        # currency selected by the end customer could not be used with the
+        # selected payment method.
+        #
+        # @return [String]
+        #
+        def transaction_currency_code
+          hash["TransactionCurrencyCode"]
+        end
+
+        # Total order price actually paid by the end customer in the currency
+        # denoted by TransactionCurrencyCode.
+        #
+        # @return [Float]
+        #
+        def transaction_total_price
+          hash["TransactionTotalPrice"]
+        end
+
+        # Total shipping price in the currency denoted by CurrencyCode.
+        #
+        # @return [Float]
+        #
+        def total_shipping_price
+          hash["TotalShippingPrice"]
+        end
+
+        # Consignment fee paid by the end customer in the currency denoted by
+        # CurrencyCode. This value is included in TotalShippingPrice.
+        #
+        # @return [Float]
+        #
+        def consignment_fee
+          hash["ConsignmentFee"]
+        end
+
+        # Oversized items charge paid by the end customer in the currency
+        # denoted by CurrencyCode. This value is included in TotalShippingPrice.
+        #
+        # @return [Float]
+        #
+        def size_overchange_value
+          hash["SizeOverchargeValue"]
+        end
+
+        # Remote area surcharge paid by the end customer in the currency
+        # denoted by CurrencyCode. This value is included in TotalShippingPrice.
+        #
+        # @return [Float]
+        #
+        def remote_area_surcharge
+          hash["RemoteAreaSurcharge"]
+        end
+
+        # Cost of “Same Day Dispatch” option (if selected by the end customer
+        # on Global-e checkout), in the currency denoted by CurrencyCode. This
+        # value is NOT included in TotalShippingPrice.
+        #
+        # @return [Float]
+        #
+        def same_day_dispatch_cost
+          hash["SameDayDispatchCost"]
+        end
+
+        # Total Duties & Taxes value including Customs Clearance Fees, in the
+        # currency denoted by CurrencyCode.
+        #
+        # @return [Float]
+        #
+        def total_duties_price
+          hash["TotalDutiesPrice"]
+        end
+
+        # Total Customs Clearance Fees value in the currency denoted by
+        # CurrencyCode. This value is included in TotalDutiesPrice.
+        #
+        # @return [Float]
+        #
+        def total_ccf_price
+          hash["TotalCCFPrice"]
+        end
+
+        # Code denoting the selected international shipping method as defined
+        # on the Merchant’s site (to be mapped on Global-e side). If this
+        # international shipping method doesn’t exist on the Merchant’s site,
+        # the internal Global-e shipping method code will be specified instead.
+        #
+        # @return [String]
+        #
+        def shipping_method_code
+          hash["ShippingMethodCode"]
+        end
+
+        # Name of the selected international shipping method.
+        #
+        # @return [String]
+        #
+        def shipping_method_name
+          hash["ShippingMethodName"]
+        end
+
+        # Code denoting the selected international shipping method type as
+        # defined on the Merchant’s site (to be mapped on Global-e side). If
+        # this international shipping method type doesn’t exist on the
+        # Merchant’s site, the internal Global-e shipping method type code will
+        # be specified instead.
+        #
+        # @return [String]
+        #
+        def shipping_method_type_code
+          hash["ShippingMethodTypeCode"]
+        end
+
+        # Name of the selected international shipping method type.
+        #
+        # @return [String]
+        #
+        def shipping_method_type_name
+          hash["ShippingMethodTypeName"]
+        end
+
+        # Minimum number of days for delivery to the end customer for the
+        # selected shipping method.
+        #
+        # @return [Integer]
+        #
+        def delivery_days_from
+          hash["DeliveryDaysFrom"]
+        end
+
+        # Maximum number of days for delivery to the end customer for the
+        # selected shipping method.
+        #
+        # @return [Integer]
+        #
+        def delivery_days_to
+          hash["DeliveryDaysTo"]
+        end
+
+        # Code denoting the selected payment method as defined on the Merchant’s
+        # site (to be mapped on Global-e side). If this payment method doesn’t
+        # exist on the Merchant’s site, the internal Global-e payment method
+        # code will be specified instead.
+        #
+        # @return [String]
+        #
+        def payment_method_code
+          hash["PaymentMethodCode"]
+        end
+
+        # Name of the selected payment method.
+        #
+        # @return [String]
+        #
+        def payment_method_name
+          hash["PaymentMethodName"]
+        end
+
+        # Indicates if the end customer has selected the “guaranteed duties
+        # and taxes” option.
+        #
+        # @return [Boolean]
+        #
+        def duties_guaranteed
+          hash["DutiesGuaranteed"]
+        end
+
+        # Tracking number used by the selected international shipping method
+        # for this order.
+        #
+        # @return [String]
+        #
+        def order_tracking_number
+          hash["OrderTrackingNumber"]
+        end
+
+        # Full tracking URL including OrderTrackingNumber used by the selected
+        # international shipping method for this order.
+        #
+        # @return [String]
+        #
+        def order_tracking_url
+          hash["OrderTrackingUrl"]
+        end
+
+        # Waybill number used by the selected international shipping method for
+        # this order.
+        #
+        # @return [String]
+        #
+        def order_waybill_number
+          hash["OrderWaybillNumber"]
+        end
+
+        # Code denoting the selected shipping status as defined on the
+        # Merchant’s site (to be mapped on Global- e side). If this shipping
+        # status doesn’t exist on the Merchant’s site, the internal Global-e
+        # shipping status code will be specified instead.
+        #
+        # @return [String]
+        #
+        def shipping_method_status_code
+          hash["ShippingMethodStatusCode"]
+        end
+
+        #  Name of the shipping status.
+        #
+        #  @return [String]
+        #
+        def shipping_method_status_name
+          hash["ShippingMethodStatusName"]
+        end
+
+        # The price paid by customer in local currency. Total Shipping price
+        # reducing Order Discounts International price.
+        #
+        # @return [Float]
+        #
+        def discounted_shipping_price
+          hash["DiscountedShippingPrice"]
+        end
+
+        # List of Merchant.ParcelTracking objects, each object holds parcel
+        # tracking number and full tracking URL for the relevant shipper (with
+        # the parcel tracking number).
+        #
+        # @return [Array<Workarea::GlobalE::Merchant::ParcelTracking>]
+        #
+        def parcels_tracking
+          hash["ParcelsTracking"]
+        end
+
+        # The last 4 digits of Card number (if applicable).
+        #
+        # @return [String]
+        #
+        def card_number_last_four_digits
+          hash["CardNumberLastFourDigits"]
+        end
+
+        # Card expiration date in YYYY-MM-DD format (if applicable).
+        #
+        # @return [String]
+        #
+        def expiration_date
+          hash["ExpirationDate"]
+        end
+
+        # Additional charge paid by the end customer when “Cash on Delivery”
+        # payment method has been selected.
+        #
+        # @return [Float]
+        #
+        def cash_on_delivery_fee_customer_currency
+          hash["CashOnDeliveryFee"]
+        end
+
+        # Amount of VAT paid by the customer to Global-e
+        #
+        # @return [Float]
+        #
+        def total_vat_amount
+          hash["TotalDutiesPrice"]
+        end
+      end
+    end
+  end
+end