flowcommerce 0.0.55 → 0.0.56

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d167ff1b4c20e941d36705eaed756ca3de6ab5d
-  data.tar.gz: ef38cea89253b7e7869708ed8bb34d8532744d4c
+  metadata.gz: e5a643e3836082882233959441243e34cf95922c
+  data.tar.gz: b18df52a17747a1564f4a28292bf816c5e5c3b78
 SHA512:
-  metadata.gz: 4540144065a686e19b92b415e4a115b5527ddc26e466e23e8edb9f23122f5a7addb4d8b18fc71717c28a6d666ff54d1cb4e7bf0aa60f17c0773bfc080190f05e
-  data.tar.gz: 5959bc452527192108ed970ab272715a12cc4c6cd7069944fb7e35a603172bae20685254a543fbb375eb1ae6e6e56b505e9ca596636a46adf16968cc8ee1d51a
+  metadata.gz: 3f5876523eca03b728285d8da0ccacb0f383ca84f11afce4ef43766a105e42ea3539d5f403750f8567b16bb2f49fbc9d070f0aff1d71e716bcaf523ba9625f63
+  data.tar.gz: c5466bddaa18dbc84982edbefc32efa8b7dd792603725ea792c4b57b90b7725ae61a970b4c2e49bc82f1fbadedb8b6beef55a0874b7d119382e98b52cfc48183

data/lib/flow_commerce/flow_api_v0_client.rb

@@ -1,6 +1,6 @@
 # Generated by apidoc - http://www.apidoc.me
-# Service version: 0.1.51
-# apidoc:0.11.37 http://www.apidoc.me/flow/api/0.1.52/ruby_client
+# Service version: 0.1.54
+# apidoc:0.11.37 http://www.apidoc.me/flow/api/0.1.54/ruby_client
 
 require 'cgi'
 require 'net/http'
@@ -25,8 +25,8 @@ module Io
 
           BASE_URL = 'https://api.flow.io' unless defined?(Constants::BASE_URL)
           NAMESPACE = 'io.flow.v0' unless defined?(Constants::NAMESPACE)
-          USER_AGENT = 'apidoc:0.11.37 http://www.apidoc.me/flow/api/0.1.52/ruby_client' unless defined?(Constants::USER_AGENT)
-          VERSION = '0.1.51' unless defined?(Constants::VERSION)
+          USER_AGENT = 'apidoc:0.11.37 http://www.apidoc.me/flow/api/0.1.54/ruby_client' unless defined?(Constants::USER_AGENT)
+          VERSION = '0.1.54' unless defined?(Constants::VERSION)
           VERSION_MAJOR = 0 unless defined?(VERSION_MAJOR)
 
         end
@@ -5419,6 +5419,199 @@ module Io
 
         end
 
+        class OrderPriceDetailComponentKey
+
+          attr_reader :value
+
+          def initialize(value)
+            @value = HttpClient::Preconditions.assert_class('value', value, String)
+          end
+
+          # Returns the instance of OrderPriceDetailComponentKey for this value, creating a new instance for an unknown value
+          def OrderPriceDetailComponentKey.apply(value)
+            if value.instance_of?(OrderPriceDetailComponentKey)
+              value
+            else
+              HttpClient::Preconditions.assert_class_or_nil('value', value, String)
+              value.nil? ? nil : (from_string(value) || OrderPriceDetailComponentKey.new(value))
+            end
+          end
+
+          # Returns the instance of OrderPriceDetailComponentKey for this value, or nil if not found
+          def OrderPriceDetailComponentKey.from_string(value)
+            HttpClient::Preconditions.assert_class('value', value, String)
+            OrderPriceDetailComponentKey.ALL.find { |v| v.value == value }
+          end
+
+          def OrderPriceDetailComponentKey.ALL
+            @@all ||= [OrderPriceDetailComponentKey.adjustment, OrderPriceDetailComponentKey.tax_deminimus, OrderPriceDetailComponentKey.duty_deminimus, OrderPriceDetailComponentKey.duties_item_price, OrderPriceDetailComponentKey.duties_freight, OrderPriceDetailComponentKey.duties_insurance, OrderPriceDetailComponentKey.vat_item_price, OrderPriceDetailComponentKey.vat_freight, OrderPriceDetailComponentKey.vat_insurance, OrderPriceDetailComponentKey.vat_duties_item_price, OrderPriceDetailComponentKey.vat_duties_freight, OrderPriceDetailComponentKey.vat_duties_insurance, OrderPriceDetailComponentKey.item_price, OrderPriceDetailComponentKey.rounding, OrderPriceDetailComponentKey.insurance, OrderPriceDetailComponentKey.shipping, OrderPriceDetailComponentKey.order_discount]
+          end
+
+          # A general purpose adjustment applied to the order.
+          def OrderPriceDetailComponentKey.adjustment
+            @@_adjustment ||= OrderPriceDetailComponentKey.new('adjustment')
+          end
+
+          # An adjustment based on whether the tax deminimus applies to the order.
+          def OrderPriceDetailComponentKey.tax_deminimus
+            @@_tax_deminimus ||= OrderPriceDetailComponentKey.new('tax_deminimus')
+          end
+
+          # An adjustment based on whether the duty deminimus applies to the order.
+          def OrderPriceDetailComponentKey.duty_deminimus
+            @@_duty_deminimus ||= OrderPriceDetailComponentKey.new('duty_deminimus')
+          end
+
+          # The VAT owed on the price of the order's items, including any added margins
+          # and rounding.
+          def OrderPriceDetailComponentKey.duties_item_price
+            @@_duties_item_price ||= OrderPriceDetailComponentKey.new('duties_item_price')
+          end
+
+          # The duty owed on the freight cost of the order.
+          def OrderPriceDetailComponentKey.duties_freight
+            @@_duties_freight ||= OrderPriceDetailComponentKey.new('duties_freight')
+          end
+
+          # The duty owed on the insurance cost of the order.
+          def OrderPriceDetailComponentKey.duties_insurance
+            @@_duties_insurance ||= OrderPriceDetailComponentKey.new('duties_insurance')
+          end
+
+          # The VAT owed on the price of the order's items, including any added margins
+          # and rounding.
+          def OrderPriceDetailComponentKey.vat_item_price
+            @@_vat_item_price ||= OrderPriceDetailComponentKey.new('vat_item_price')
+          end
+
+          # The VAT owed on the freight cost of the order.
+          def OrderPriceDetailComponentKey.vat_freight
+            @@_vat_freight ||= OrderPriceDetailComponentKey.new('vat_freight')
+          end
+
+          # The VAT owed on the insurance cost of the order.
+          def OrderPriceDetailComponentKey.vat_insurance
+            @@_vat_insurance ||= OrderPriceDetailComponentKey.new('vat_insurance')
+          end
+
+          # The VAT owed on the duties on the price of the order's items, including any
+          # added margins and rounding.
+          def OrderPriceDetailComponentKey.vat_duties_item_price
+            @@_vat_duties_item_price ||= OrderPriceDetailComponentKey.new('vat_duties_item_price')
+          end
+
+          # The VAT owed on the duties on the freight cost of the order.
+          def OrderPriceDetailComponentKey.vat_duties_freight
+            @@_vat_duties_freight ||= OrderPriceDetailComponentKey.new('vat_duties_freight')
+          end
+
+          # The VAT owed on the duties on the insurance cost of the order.
+          def OrderPriceDetailComponentKey.vat_duties_insurance
+            @@_vat_duties_insurance ||= OrderPriceDetailComponentKey.new('vat_duties_insurance')
+          end
+
+          # The sum of the price of the order's items with their currency margins, percent
+          # margins, and fixed margins included.
+          def OrderPriceDetailComponentKey.item_price
+            @@_item_price ||= OrderPriceDetailComponentKey.new('item_price')
+          end
+
+          # The sum of any rounding applied to the order's items.
+          def OrderPriceDetailComponentKey.rounding
+            @@_rounding ||= OrderPriceDetailComponentKey.new('rounding')
+          end
+
+          # The insurance cost for the order.
+          def OrderPriceDetailComponentKey.insurance
+            @@_insurance ||= OrderPriceDetailComponentKey.new('insurance')
+          end
+
+          # The shipping cost for the order.
+          def OrderPriceDetailComponentKey.shipping
+            @@_shipping ||= OrderPriceDetailComponentKey.new('shipping')
+          end
+
+          # A discount applied to the entire order.
+          def OrderPriceDetailComponentKey.order_discount
+            @@_order_discount ||= OrderPriceDetailComponentKey.new('order_discount')
+          end
+
+          def to_hash
+            value
+          end
+
+        end
+
+        class OrderPriceDetailKey
+
+          attr_reader :value
+
+          def initialize(value)
+            @value = HttpClient::Preconditions.assert_class('value', value, String)
+          end
+
+          # Returns the instance of OrderPriceDetailKey for this value, creating a new instance for an unknown value
+          def OrderPriceDetailKey.apply(value)
+            if value.instance_of?(OrderPriceDetailKey)
+              value
+            else
+              HttpClient::Preconditions.assert_class_or_nil('value', value, String)
+              value.nil? ? nil : (from_string(value) || OrderPriceDetailKey.new(value))
+            end
+          end
+
+          # Returns the instance of OrderPriceDetailKey for this value, or nil if not found
+          def OrderPriceDetailKey.from_string(value)
+            HttpClient::Preconditions.assert_class('value', value, String)
+            OrderPriceDetailKey.ALL.find { |v| v.value == value }
+          end
+
+          def OrderPriceDetailKey.ALL
+            @@all ||= [OrderPriceDetailKey.adjustment, OrderPriceDetailKey.subtotal, OrderPriceDetailKey.vat, OrderPriceDetailKey.duty, OrderPriceDetailKey.shipping, OrderPriceDetailKey.insurance, OrderPriceDetailKey.discount]
+          end
+
+          # The details of any adjustments made to the order.
+          def OrderPriceDetailKey.adjustment
+            @@_adjustment ||= OrderPriceDetailKey.new('adjustment')
+          end
+
+          # The details of the subtotal for the order, including item prices, margins, and
+          # rounding.
+          def OrderPriceDetailKey.subtotal
+            @@_subtotal ||= OrderPriceDetailKey.new('subtotal')
+          end
+
+          # The details of any VAT owed on the order.
+          def OrderPriceDetailKey.vat
+            @@_vat ||= OrderPriceDetailKey.new('vat')
+          end
+
+          # The details of any duties owed on the order.
+          def OrderPriceDetailKey.duty
+            @@_duty ||= OrderPriceDetailKey.new('duty')
+          end
+
+          # The details of shipping costs for the order.
+          def OrderPriceDetailKey.shipping
+            @@_shipping ||= OrderPriceDetailKey.new('shipping')
+          end
+
+          # The details of insurance costs for the order.
+          def OrderPriceDetailKey.insurance
+            @@_insurance ||= OrderPriceDetailKey.new('insurance')
+          end
+
+          # The details of any discount applied to the order.
+          def OrderPriceDetailKey.discount
+            @@_discount ||= OrderPriceDetailKey.new('discount')
+          end
+
+          def to_hash
+            value
+          end
+
+        end
+
         class PricingLevySetting
 
           attr_reader :value
@@ -12295,6 +12488,116 @@ module Io
 
         end
 
+        # Represents a top-level order price detail, e.g. 'Subtotal' or 'VAT'.
+        class OrderPriceDetail
+
+          attr_reader :key, :currency, :amount, :label, :components
+
+          def initialize(incoming={})
+            opts = HttpClient::Helper.symbolize_keys(incoming)
+            HttpClient::Preconditions.require_keys(opts, [:key, :currency, :amount, :label, :components], 'OrderPriceDetail')
+            @key = (x = opts.delete(:key); x.is_a?(::Io::Flow::V0::Models::OrderPriceDetailKey) ? x : ::Io::Flow::V0::Models::OrderPriceDetailKey.apply(x))
+            @currency = HttpClient::Preconditions.assert_class('currency', opts.delete(:currency), String)
+            @amount = HttpClient::Preconditions.assert_class('amount', opts.delete(:amount), Numeric)
+            @label = HttpClient::Preconditions.assert_class('label', opts.delete(:label), String)
+            @components = HttpClient::Preconditions.assert_class('components', opts.delete(:components), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::OrderPriceDetailComponent) ? x : ::Io::Flow::V0::Models::OrderPriceDetailComponent.new(x)) }
+          end
+
+          def to_json
+            JSON.dump(to_hash)
+          end
+
+          def copy(incoming={})
+            OrderPriceDetail.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+          end
+
+          def to_hash
+            {
+              :key => key.value,
+              :currency => currency,
+              :amount => amount,
+              :label => label,
+              :components => components.map { |o| o.to_hash }
+            }
+          end
+
+        end
+
+        class OrderPriceDetailComponent
+
+          attr_reader :key, :currency, :amount, :label, :base
+
+          def initialize(incoming={})
+            opts = HttpClient::Helper.symbolize_keys(incoming)
+            HttpClient::Preconditions.require_keys(opts, [:key, :currency, :amount, :label, :base], 'OrderPriceDetailComponent')
+            @key = (x = opts.delete(:key); x.is_a?(::Io::Flow::V0::Models::OrderPriceDetailComponentKey) ? x : ::Io::Flow::V0::Models::OrderPriceDetailComponentKey.apply(x))
+            @currency = HttpClient::Preconditions.assert_class('currency', opts.delete(:currency), String)
+            @amount = HttpClient::Preconditions.assert_class('amount', opts.delete(:amount), Numeric)
+            @label = HttpClient::Preconditions.assert_class('label', opts.delete(:label), String)
+            @base = (x = opts.delete(:base); x.is_a?(::Io::Flow::V0::Models::Price) ? x : ::Io::Flow::V0::Models::Price.new(x))
+          end
+
+          def to_json
+            JSON.dump(to_hash)
+          end
+
+          def copy(incoming={})
+            OrderPriceDetailComponent.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+          end
+
+          def to_hash
+            {
+              :key => key.value,
+              :currency => currency,
+              :amount => amount,
+              :label => label,
+              :base => base.to_hash
+            }
+          end
+
+        end
+
+        # Represents the price details for the entire order.
+        class OrderPriceDetails
+
+          attr_reader :subtotal, :vat, :duty, :shipping, :insurance, :discounts, :adjustments, :total
+
+          def initialize(incoming={})
+            opts = HttpClient::Helper.symbolize_keys(incoming)
+            HttpClient::Preconditions.require_keys(opts, [:subtotal, :vat, :duty, :shipping, :insurance, :discounts, :adjustments, :total], 'OrderPriceDetails')
+            @subtotal = (x = opts.delete(:subtotal); x.is_a?(::Io::Flow::V0::Models::OrderPriceDetail) ? x : ::Io::Flow::V0::Models::OrderPriceDetail.new(x))
+            @vat = (x = opts.delete(:vat); x.is_a?(::Io::Flow::V0::Models::OrderPriceDetail) ? x : ::Io::Flow::V0::Models::OrderPriceDetail.new(x))
+            @duty = (x = opts.delete(:duty); x.is_a?(::Io::Flow::V0::Models::OrderPriceDetail) ? x : ::Io::Flow::V0::Models::OrderPriceDetail.new(x))
+            @shipping = (x = opts.delete(:shipping); x.is_a?(::Io::Flow::V0::Models::OrderPriceDetail) ? x : ::Io::Flow::V0::Models::OrderPriceDetail.new(x))
+            @insurance = (x = opts.delete(:insurance); x.is_a?(::Io::Flow::V0::Models::OrderPriceDetail) ? x : ::Io::Flow::V0::Models::OrderPriceDetail.new(x))
+            @discounts = (x = opts.delete(:discounts); x.is_a?(::Io::Flow::V0::Models::OrderPriceDetail) ? x : ::Io::Flow::V0::Models::OrderPriceDetail.new(x))
+            @adjustments = (x = opts.delete(:adjustments); x.is_a?(::Io::Flow::V0::Models::OrderPriceDetail) ? x : ::Io::Flow::V0::Models::OrderPriceDetail.new(x))
+            @total = (x = opts.delete(:total); x.is_a?(::Io::Flow::V0::Models::PriceWithBase) ? x : ::Io::Flow::V0::Models::PriceWithBase.new(x))
+          end
+
+          def to_json
+            JSON.dump(to_hash)
+          end
+
+          def copy(incoming={})
+            OrderPriceDetails.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+          end
+
+          def to_hash
+            {
+              :subtotal => subtotal.to_hash,
+              :vat => vat.to_hash,
+              :duty => duty.to_hash,
+              :shipping => shipping.to_hash,
+              :insurance => insurance.to_hash,
+              :discounts => discounts.to_hash,
+              :adjustments => adjustments.to_hash,
+              :total => total.to_hash
+            }
+          end
+
+        end
+
         # The order put form is used to upsert an order, providing the details on
         # pricing and delivery options for destination and items/quantities specified.
         class OrderPutForm
@@ -13125,6 +13428,38 @@ module Io
 
         end
 
+        class PriceWithBase
+
+          attr_reader :currency, :amount, :label, :base
+
+          def initialize(incoming={})
+            opts = HttpClient::Helper.symbolize_keys(incoming)
+            HttpClient::Preconditions.require_keys(opts, [:currency, :amount, :label, :base], 'PriceWithBase')
+            @currency = HttpClient::Preconditions.assert_class('currency', opts.delete(:currency), String)
+            @amount = HttpClient::Preconditions.assert_class('amount', opts.delete(:amount), Numeric)
+            @label = HttpClient::Preconditions.assert_class('label', opts.delete(:label), String)
+            @base = (x = opts.delete(:base); x.is_a?(::Io::Flow::V0::Models::Price) ? x : ::Io::Flow::V0::Models::Price.new(x))
+          end
+
+          def to_json
+            JSON.dump(to_hash)
+          end
+
+          def copy(incoming={})
+            PriceWithBase.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+          end
+
+          def to_hash
+            {
+              :currency => currency,
+              :amount => amount,
+              :label => label,
+              :base => base.to_hash
+            }
+          end
+
+        end
+
         # Pricing determines how the item price is calculated when items are requests
         # via the experience.
         class Pricing
@@ -13599,19 +13934,22 @@ module Io
 
         end
 
-        # Refunds are used to issue refunds against a prior capture.
+        # Refunds can be created against either a specific capture or an authorization
+        # (in which case we will select 1 or more specific captures against which to
+        # execute the refund).
         class Refund
 
-          attr_reader :id, :key, :capture, :amount, :currency
+          attr_reader :id, :key, :authorization, :amount, :currency, :captures
 
           def initialize(incoming={})
             opts = HttpClient::Helper.symbolize_keys(incoming)
-            HttpClient::Preconditions.require_keys(opts, [:id, :key, :capture, :amount, :currency], 'Refund')
+            HttpClient::Preconditions.require_keys(opts, [:id, :key, :authorization, :amount, :currency, :captures], 'Refund')
             @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
             @key = HttpClient::Preconditions.assert_class('key', opts.delete(:key), String)
-            @capture = (x = opts.delete(:capture); x.is_a?(::Io::Flow::V0::Models::Capture) ? x : ::Io::Flow::V0::Models::Capture.new(x))
+            @authorization = (x = opts.delete(:authorization); x.is_a?(::Io::Flow::V0::Models::AuthorizationReference) ? x : ::Io::Flow::V0::Models::AuthorizationReference.new(x))
             @amount = HttpClient::Preconditions.assert_class('amount', HttpClient::Helper.to_big_decimal(opts.delete(:amount)), BigDecimal)
             @currency = HttpClient::Preconditions.assert_class('currency', opts.delete(:currency), String)
+            @captures = HttpClient::Preconditions.assert_class('captures', opts.delete(:captures), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::RefundCapture) ? x : ::Io::Flow::V0::Models::RefundCapture.new(x)) }
           end
 
           def to_json
@@ -13626,9 +13964,40 @@ module Io
             {
               :id => id,
               :key => key,
-              :capture => capture.to_hash,
+              :authorization => authorization.to_hash,
               :amount => amount,
-              :currency => currency
+              :currency => currency,
+              :captures => captures.map { |o| o.to_hash }
+            }
+          end
+
+        end
+
+        # Refund captures provide the detailed information on the amount refunded
+        # against a specific capture
+        class RefundCapture
+
+          attr_reader :capture, :amount
+
+          def initialize(incoming={})
+            opts = HttpClient::Helper.symbolize_keys(incoming)
+            HttpClient::Preconditions.require_keys(opts, [:capture, :amount], 'RefundCapture')
+            @capture = (x = opts.delete(:capture); x.is_a?(::Io::Flow::V0::Models::Capture) ? x : ::Io::Flow::V0::Models::Capture.new(x))
+            @amount = HttpClient::Preconditions.assert_class('amount', HttpClient::Helper.to_big_decimal(opts.delete(:amount)), BigDecimal)
+          end
+
+          def to_json
+            JSON.dump(to_hash)
+          end
+
+          def copy(incoming={})
+            RefundCapture.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+          end
+
+          def to_hash
+            {
+              :capture => capture.to_hash,
+              :amount => amount
             }
           end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flowcommerce
 version: !ruby/object:Gem::Version
-  version: 0.0.55
+  version: 0.0.56
 platform: ruby
 authors:
 - Flow Commerce, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-16 00:00:00.000000000 Z
+date: 2016-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json