workarea-global_e 1.2.1

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

@@ -0,0 +1,161 @@
+module Workarea
+  module GlobalE
+    module Merchant
+      class PaymentDetails
+        #  Card owner’s first name
+        #  (optional if OwnerName is specified)
+        #
+        #  @return [String]
+        #
+        def owner_first_name
+        end
+
+        # Card owner’s last name
+        # (optional if OwnerName is specified)
+        #
+        # @return [String]
+        #
+        def owner_last_name
+        end
+
+        # Card owner’s full name (the Merchant’s may choose to consider either
+        # full name or first name with last name, according to the existing
+        # payment method input validation requirements).
+        #
+        # @return [String]
+        #
+        def owner_name
+        end
+
+        # Card numer
+        #
+        # @return [String]
+        #
+        def card_number
+        end
+
+        # Card CVV number
+        #
+        # @return [String]
+        #
+        def cvv_number
+        end
+
+        # Payment method name
+        #
+        # @return [String]
+        #
+        def payment_method_name
+        end
+
+        # Payment method code used to identify the payment method on the
+        # Merchant’s site (to be mapped on Global-e side).
+        #
+        # @return [String]
+        #
+        def payment_method_code
+        end
+
+        # Payment method type’s code used to identify the payment method type
+        # (such as Credit Card or Check) on the Merchant’s site (to be mapped
+        # on Global-e side).
+        #
+        # @return [String]
+        #
+        def payment_method_type_code
+        end
+
+        # Card expiration date (in YYYY-MM-DD format)
+        #
+        # @return [String]
+        #
+        def expiration_date
+        end
+
+        # Country name
+        #
+        # @return [String]
+        #
+        def country_name
+        end
+
+        # 2-char ISO country code
+        #
+        # @return [String]
+        #
+        def country_code
+        end
+
+        # State or province ISO code such as AZ for Arizona (if applicable)
+        #
+        # @return [String]
+        #
+        def state_code
+        end
+
+        # State or province name
+        #
+        # @return [String]
+        #
+        def state_or_province
+        end
+
+        # City name
+        #
+        # @return [String]
+        #
+        def city
+        end
+
+        # Zip or postal code
+        #
+        # @return [String]
+        #
+        def zip
+        end
+
+        # Address line 1
+        #
+        # @return [String]
+        #
+        def address1
+        end
+
+        # Address line 2
+        #
+        # @return [String]
+        #
+        def address2
+        end
+
+        # Phone 1
+        #
+        # @return [String]
+        #
+        def phone1
+        end
+
+        # Phone 2
+        #
+        # @return [String]
+        #
+        def phone2
+        end
+
+        # Fax
+        #
+        # @return [String]
+        #
+        def fax
+        end
+
+        # E-mail address
+        #
+        # @return [String]
+        #
+        def email
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,222 @@
+module Workarea
+  module GlobalE
+    module Merchant
+      class Product
+        attr_reader :hash
+
+        def initialize(hash)
+          @hash = hash
+        end
+
+        # SKU code used to identify the product on the Merchant’s site (to be
+        # mapped on Global-e side).
+        #
+        # @return [String]
+        #
+        def sku
+          hash["Sku"]
+        end
+
+        # Single product price 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 product
+        #
+        # @return [Float]
+        #
+        def vat_rate
+          hash["VATRate"]
+        end
+
+        # Single product price in end customer’s currency (specified in
+        # InternationalDetails.CurrencyCode property for the respective
+        # Merchant.Order), after applying country coefficient, FX conversion,
+        # rounding rule (if applicable) and IncludeVAT handling.
+        #
+        # @return [Float]
+        #
+        def international_price
+          hash["InternationalPrice"]
+        end
+
+        # Line item (product in ordered quantity) price in end customer’s
+        # currency (specified in InternationalDetails.CurrencyCode property for
+        # the respective Merchant.Order), after applying country coefficient,
+        # FX conversion, rounding rule (if applicable) and IncludeVAT handling.
+        # If not specified, should be deemed equal to “InternationalPrice *
+        # Quantity”. If specified, should take preference over InternationalPrice.
+        #
+        # @return [Float]
+        #
+        def line_item_international_price
+        end
+
+        # Conversion rate applied to this product’s price paid by the end
+        # customer, when calculating the prices paid by Global-e to the Merchant
+        # in the original Merchant’s currency. This rate includes “FX conversion”
+        # and “marketing rounding” factors.
+        #
+        # @return [Float]
+        #
+        def rounding_rate
+          hash["RoundingRate"]
+        end
+
+        # Product quantity in the order that is currently being submitted to the Merchant.
+        #
+        # @return [Integer]
+        #
+        def quantity
+          hash["Quantity"]
+        end
+
+        # Identifier of the cart item on the Merchant’s site originally
+        # specified in Product.CartItemId property of the respective product in
+        # SendCart method for the cart converted to this order on Global-e.
+        #
+        # @return [String]
+        #
+        def cart_item_id
+          hash["CartItemId"]
+        end
+
+        # Identifier of the current item’s parent cart item on the Merchant’s
+        # site originally specified in Product.ParentCartItemId property of the
+        # respective product in SendCart method for the cart converted to this
+        # order on Global-e.
+        #
+        # @return [String]
+        #
+        def parent_cart_item_id
+          hash["ParentCartItemId"]
+        end
+
+        # Identifier of the child cart item “option” on the Merchant’s site
+        # originally specified in Product.CartItemOptionId property of the
+        # respective product in SendCart method for the cart converted to this
+        # order on Global-e.
+        #
+        # @return [String]
+        #
+        def cart_item_option_id
+          hash["CartItemOptionId"]
+        end
+
+        # Code originally specified in Product.HandlingCode property of the
+        # respective product in SendCart method for the cart converted to this
+        # order on Global-e.
+        #
+        # @return [String]
+        #
+        def handling_code
+          hash["HandlingCode"]
+        end
+
+        # Text originally specified in Product.GiftMessage property of the
+        # respective product in SendCart method for the cart converted to this order on Global-e.
+        #
+        # @return [String]
+        #
+        def gift_message
+          hash["GiftMessage"]
+        end
+
+        # Boolean specifying if the product was ordered as a backed ordered item
+        #
+        # @return [Boolean]
+        #
+        def is_back_ordered
+          hash["IsBackOrdered"]
+        end
+
+        # Estimated date for the backordered item to be in stock
+        #
+        # @return [String]
+        #
+        def back_order_date
+          hash["BackOrderDate"]
+        end
+
+        # The product value in merchant currency after deducting all product and
+        # cart level discounts from the price. Product level discounts will be
+        # fully deducted from the respective product’s price and cart discounts
+        # will be prorated over all products according to the remaining value.
+        #
+        # This value can be used as pre-calculated value for returned product’s refund.
+        #
+        # @return [Float]
+        #
+        def discounted_price
+          hash["DiscountedPrice"]
+        end
+
+        # The product value in customer currency after deducting all product and
+        # cart level discounts from the price. Product level discounts will be
+        # fully deducted from the respective product’s price and cart discounts
+        # will be prorated over all products according to the remaining value.
+        #
+        # This value can be used as pre-calculated value for returned product’s refund.
+        #
+        # @return [Float]
+        #
+        def international_discounted_price
+          hash["InternationalDiscountedPrice"]
+        end
+
+        # Product’s brand
+        #
+        # @return [Workarea::GlobalE::MerchantBrand]
+        #
+        def brand
+        end
+
+        # Product’s categories
+        #
+        # @return [Array<Workarea::GlobalE::MerchantCategory>]
+        #
+        def categories
+        end
+
+        # Custom attributes describe product that customer can personalize
+        # according to what the site offers. Each Attribute holds Key to specify
+        # attribute name and Value properties.
+        #
+        # @return [Array<Workarea::GlobalE::CartProductAttribute>]
+        #
+        def attributes
+        end
+
+        def list_price
+          hash["ListPrice"]
+        end
+
+        def international_list_price
+          hash["InternationalListPrice"]
+        end
+
+        # Product price exclusive of duties & taxes in base currency
+        #
+        # @return [String]
+        #
+        def discounted_price_for_customs
+          hash["DiscountedPriceForCustoms"]
+        end
+
+        # Product HS code
+        #
+        # @return [String]
+        #
+        def generic_hs_code
+          hash["GenericHSCode"]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+module Workarea
+  module GlobalE
+    module Merchant
+      class RefundProduct
+        attr_reader :hash
+
+        def initialize(hash)
+          @hash = hash
+        end
+
+        # Identifier of the line item on the Merchant’s site. This property is
+        # mandatory and should be equal to the respective Product’s CartItemId
+        # originally specified in SendCart method for the order being refunded.
+        #
+        # @return [String]
+        #
+        def cart_item_id
+          hash["CartItemId"]
+        end
+
+        # Product quantity (i.e. a part of the originally ordered quantity)
+        # that the refund refers to.
+        #
+        # @return [Integer]
+        #
+        def refund_quantity
+          hash["RefundQuantity"]
+        end
+
+        # Refund amount in original Merchant’s currency including the local
+        # Merchant’s VAT for this product line item, before applying any price
+        # modifications (i.e. part of or the full value paid by Global-e to the
+        # Merchant, as was specified in Merchant.Product.Price for the
+        # respective order).
+        #
+        # @return [Float]
+        #
+        def original_refund_amount
+          hash["OriginalRefundAmount"]
+        end
+
+        # Refund amount for this product line item in end customer’s currency
+        # used for this order’s payment.
+        #
+        # @return [Float]
+        #
+        def refund_amount
+          hash["RefundAmount"]
+        end
+
+        # Reason for this product’s refund
+        #
+        # @return [Hash]
+        #
+        def refund_reason
+          hash["RefundReason"]
+        end
+
+        # Comments for this product’s refund
+        #
+        # @return [String]
+        #
+        def refund_comments
+          hash["RefundComments"]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,115 @@
+module Workarea
+  module GlobalE
+    module Merchant
+      class ResponseInfo
+        attr_reader :order
+
+        def self.error(message:, order: nil)
+          new(success: false, message: message, order: order)
+        end
+
+        def initialize(order: nil, message: nil, success: true)
+          @order = order
+          @message = message
+          @success = success
+        end
+
+        def to_h
+          {
+            InternalOrderId: internal_order_id,
+            OrderId: order_id,
+            StatusCode: status_code,
+            PaymentCurrencyCode: payment_currency_code,
+            PaymentAmount: payment_amount,
+            Success: success,
+            ErrorCode: error_code,
+            Message: message,
+            Description: description
+          }
+        end
+
+        def as_json(*args)
+          to_h
+        end
+
+        # Order unique identifier on the Merchant’s site
+        # (optional in case of error, failure or if the action is not related
+        # to a specific order)
+        #
+        # @return [String]
+        #
+        def internal_order_id
+          order&.id
+        end
+
+        # Order identifier on the Merchant’s site used for display and reporting
+        # purposes only. Unlike InternalOrderId, this identifier is not
+        # necessarily unique over time, as the Merchant’s site may potentially
+        # reuse it (for example after deleting the old order having the same
+        # OrderId).
+        #
+        # @return [String]
+        #
+        def order_id
+        end
+
+        # Code denoting the order status on the Merchant’s site (to be mapped
+        # on Global-e side).
+        # (optional in case of error or failure)
+        #
+        # @return [String]
+        #
+        def status_code
+        end
+
+        # 3-char ISO currency code for the order (if payment was processed in
+        # the respective API method call).
+        #
+        # @return [String]
+        #
+        def payment_currency_code
+        end
+
+        # The total payment amount in PaymentCurrency charged for the order
+        # (if payment was processed in the respective API method call).
+        #
+        # @return [String]
+        #
+        def payment_amount
+        end
+
+        # Indicates if the call has succeeded. FALSE denotes an error or failure.
+        #
+        # @return [Boolean]
+        #
+        def success
+          @success
+        end
+
+        # Error code to be returned when an error occurs.
+        #
+        # @return [String]
+        #
+        def error_code
+        end
+
+        # Optional response message. In case of an error, this property
+        # indicates the error message text.
+        #
+        # @return [String]
+        #
+        def message
+          @message
+        end
+
+        # Optional response description. In case of an error, this property
+        # indicates the error message description.
+        #
+        # @return [String]
+        #
+        def description
+        end
+      end
+    end
+  end
+end

data/app/services/workarea/global_e/merchant_cart_product_attribute.rb

@@ -0,0 +1,21 @@
+module Workarea
+  module GlobalE
+    module Merchant
+      class CartProductAttribute
+        # Custom product attribute name that is used to describe personalized product.
+        #
+        # @return [String]
+        #
+        def attribute_key
+        end
+
+        # Custom product attribute value that is used to describe personalized product.
+        #
+        # @return [String]
+        #
+        def attribute_value
+        end
+      end
+    end
+  end
+end

data/app/services/workarea/global_e/order_status.rb

@@ -0,0 +1,20 @@
+module Workarea
+  module GlobalE
+    class OrderStatus
+      # Code denoting the order status on the Merchant’s site (to be mapped on
+      # Global-e side)
+      #
+      # @return [String]
+      #
+      def status_code
+      end
+
+      # Order status name
+      #
+      # @return [String]
+      #
+      def name
+      end
+    end
+  end
+end

data/app/services/workarea/global_e/order_status_details.rb

@@ -0,0 +1,79 @@
+module Workarea
+  module GlobalE
+    class OrderStatusDetails
+      # Global-e order unique identifier (previously submitted to the Merchant’s
+      # SendOrderToMerchant method defined below in this document when an order
+      # had been created with Global-e checkout)
+      #
+      # @return [String]
+      #
+      def order_id
+      end
+
+      # Order status
+      #
+      # @return [Workarea::GlobalE::OrderStatus]
+      #
+      def order_status
+      end
+
+      # Reason for the order status
+      #
+      # @return [Workarea::GlobalE::OrderStatusReason]
+      #
+      def order_status_reason
+      end
+
+      # Merchant's comments for the order
+      #
+      # @return [String]
+      #
+      def order_comments
+      end
+
+      # Merchant's Order confirmation number
+      #
+      # @return [String]
+      #
+      def confirmation_number
+      end
+
+      # Name of the tracking service used by the Merchant for this order
+      #
+      # @return [String]
+      #
+      def tracking_service_name
+      end
+
+      # URL of the tracking service site used by the Merchant for this order
+      #
+      # @return [String]
+      #
+      def tracking_service_site
+      end
+
+      # Reference number valid for the tracking service used by the Merchant
+      # for this order
+      #
+      # @return [String]
+      #
+      def tracking_number
+      end
+
+      # Full tracking URL on the tracking service site used by the Merchant
+      # (if specified overrides all other “Tracking...” properties)
+      #
+      # @return [String]
+      #
+      def tracking_number
+      end
+
+      # Merchant’s internal Delivery Reference Number for this order
+      #
+      # @return [String]
+      #
+      def delivery_reference_number
+      end
+    end
+  end
+end

data/app/services/workarea/global_e/order_status_reason.rb

@@ -0,0 +1,20 @@
+module Workarea
+  module GlobalE
+    class OrderStatusReason
+      # Code denoting the order status reason on the Merchant’s site (to be
+      # mapped on Global-e side)
+      #
+      # @return [String]
+      #
+      def reason_code
+      end
+
+      # Order status reason name
+      #
+      # @return [String]
+      #
+      def name
+      end
+    end
+  end
+end