flowcommerce 0.2.18 → 0.2.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72a5107c84e60eb68dd95478e53bc389f652ee8a
-  data.tar.gz: c70fa4bde6b7e370fe4f2438f24cfe1f64514e20
+  metadata.gz: afc95c1997b26e43995dcb615a80a2da52d561b6
+  data.tar.gz: 65b268ec436733976c79b6dcea4421632dd3aa02
 SHA512:
-  metadata.gz: 93064d8cb7d0cdc0218a63efe6fb9e570c4e28bf07d127bc7e56cf29e168efa839d08251ae3ff430a24ef3a6a07399fa11dfbe322ede4749ed73881a3fc66004
-  data.tar.gz: a699e831f89e1444ba38d2c82bd3a3f4d3130bf7bb6fdf26a6daaac66dcc4775917c2b3b16f779ee205f0f67dd5465632c06e0fc4d7f00b00c61d084410e263b
+  metadata.gz: 63fd6e67c8b29f727623fbdb97f09f1e88baf87387fb4d48cad18a5bdf5e53227efe773aa0202c5bae3e3a8fa01bbe66b87f25e3a31548df8557ae6b64097784
+  data.tar.gz: 38c2917e4a1e35e67c09eb7e42d670f3af2fca18e6493979b8a6a0c8a38aad20e9ec9efe0791b44f8da663fe48d39112b49a568ea150cfaf48fae50173ec5276

data/lib/flow_commerce/flow_api_v0_client.rb

@@ -1,6 +1,6 @@
 # Generated by apidoc - http://www.apidoc.me
 # Service version: 0.3.28
-# apidoc:0.11.84 http://www.apidoc.me/flow/api/0.3.30/ruby_client
+# apidoc:0.11.89 http://www.apidoc.me/flow/api/0.3.34/ruby_client
 
 require 'cgi'
 require 'net/http'
@@ -25,7 +25,7 @@ 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.84 http://www.apidoc.me/flow/api/0.3.30/ruby_client' unless defined?(Constants::USER_AGENT)
+          USER_AGENT = 'apidoc:0.11.89 http://www.apidoc.me/flow/api/0.3.34/ruby_client' unless defined?(Constants::USER_AGENT)
           VERSION = '0.3.28' unless defined?(Constants::VERSION)
           VERSION_MAJOR = 0 unless defined?(VERSION_MAJOR)
 
@@ -4223,13 +4223,6 @@ module Io
             ::Io::Flow::V0::Models::OrganizationSession.new(r)
           end
 
-          def post_shopify_by_shop(shop, session_form)
-            HttpClient::Preconditions.assert_class('shop', shop, String)
-            (x = session_form; x.is_a?(::Io::Flow::V0::Models::SessionForm) ? x : ::Io::Flow::V0::Models::SessionForm.new(x))
-            r = @client.request("/sessions/shopify/#{CGI.escape(shop)}").with_json(session_form.to_json).post
-            ::Io::Flow::V0::Models::OrganizationSession.new(r)
-          end
-
         end
 
         class SessionAuthorizations
@@ -6637,7 +6630,13 @@ module Io
           end
 
           def AttributeIntent.ALL
-            @@all ||= [AttributeIntent.price]
+            @@all ||= [AttributeIntent.fulfillment_method, AttributeIntent.price, AttributeIntent.taxability]
+          end
+
+          # Attributes with this data type imply whether delivery is a package or digital
+          # good.
+          def AttributeIntent.fulfillment_method
+            @@_fulfillment_method ||= AttributeIntent.new('fulfillment_method')
           end
 
           # Attributes with this data type are inferred to be prices in the organization's
@@ -6646,6 +6645,11 @@ module Io
             @@_price ||= AttributeIntent.new('price')
           end
 
+          # Attributes with this data type imply whether taxes are applicable to an item.
+          def AttributeIntent.taxability
+            @@_taxability ||= AttributeIntent.new('taxability')
+          end
+
           def to_hash
             value
           end
@@ -8040,6 +8044,91 @@ module Io
 
         end
 
+        class FulfillmentMethodType
+
+          attr_reader :value
+
+          def initialize(value)
+            @value = HttpClient::Preconditions.assert_class('value', value, String)
+          end
+
+          # Returns the instance of FulfillmentMethodType for this value, creating a new instance for an unknown value
+          def FulfillmentMethodType.apply(value)
+            if value.instance_of?(FulfillmentMethodType)
+              value
+            else
+              HttpClient::Preconditions.assert_class_or_nil('value', value, String)
+              value.nil? ? nil : (from_string(value) || FulfillmentMethodType.new(value))
+            end
+          end
+
+          # Returns the instance of FulfillmentMethodType for this value, or nil if not found
+          def FulfillmentMethodType.from_string(value)
+            HttpClient::Preconditions.assert_class('value', value, String)
+            FulfillmentMethodType.ALL.find { |v| v.value == value }
+          end
+
+          def FulfillmentMethodType.ALL
+            @@all ||= [FulfillmentMethodType.fulfillment_method]
+          end
+
+          # Indicates how an item will be shipped or fulfilled.  Acceptable values are
+          # defined by the 'fulfillment_method_value' enum.
+          def FulfillmentMethodType.fulfillment_method
+            @@_fulfillment_method ||= FulfillmentMethodType.new('fulfillment_method')
+          end
+
+          def to_hash
+            value
+          end
+
+        end
+
+        class FulfillmentMethodValue
+
+          attr_reader :value
+
+          def initialize(value)
+            @value = HttpClient::Preconditions.assert_class('value', value, String)
+          end
+
+          # Returns the instance of FulfillmentMethodValue for this value, creating a new instance for an unknown value
+          def FulfillmentMethodValue.apply(value)
+            if value.instance_of?(FulfillmentMethodValue)
+              value
+            else
+              HttpClient::Preconditions.assert_class_or_nil('value', value, String)
+              value.nil? ? nil : (from_string(value) || FulfillmentMethodValue.new(value))
+            end
+          end
+
+          # Returns the instance of FulfillmentMethodValue for this value, or nil if not found
+          def FulfillmentMethodValue.from_string(value)
+            HttpClient::Preconditions.assert_class('value', value, String)
+            FulfillmentMethodValue.ALL.find { |v| v.value == value }
+          end
+
+          def FulfillmentMethodValue.ALL
+            @@all ||= [FulfillmentMethodValue.digital, FulfillmentMethodValue.physical]
+          end
+
+          # Indicates item will be fulfilled digitally and no shipment is required (e.g.
+          # Gift Card).
+          def FulfillmentMethodValue.digital
+            @@_digital ||= FulfillmentMethodValue.new('digital')
+          end
+
+          # Indicates item will be shipped in a phystical package.
+          def FulfillmentMethodValue.physical
+            @@_physical ||= FulfillmentMethodValue.new('physical')
+          end
+
+          def to_hash
+            value
+          end
+
+        end
+
         class GenericErrorCode
 
           attr_reader :value
@@ -8625,6 +8714,62 @@ module Io
 
         end
 
+        class OrderPaymentType
+
+          attr_reader :value
+
+          def initialize(value)
+            @value = HttpClient::Preconditions.assert_class('value', value, String)
+          end
+
+          # Returns the instance of OrderPaymentType for this value, creating a new instance for an unknown value
+          def OrderPaymentType.apply(value)
+            if value.instance_of?(OrderPaymentType)
+              value
+            else
+              HttpClient::Preconditions.assert_class_or_nil('value', value, String)
+              value.nil? ? nil : (from_string(value) || OrderPaymentType.new(value))
+            end
+          end
+
+          # Returns the instance of OrderPaymentType for this value, or nil if not found
+          def OrderPaymentType.from_string(value)
+            HttpClient::Preconditions.assert_class('value', value, String)
+            OrderPaymentType.ALL.find { |v| v.value == value }
+          end
+
+          def OrderPaymentType.ALL
+            @@all ||= [OrderPaymentType.card, OrderPaymentType.online, OrderPaymentType.credit, OrderPaymentType.cash_on_delivery]
+          end
+
+          # Represents a payment in the form of a credit or debit card
+          def OrderPaymentType.card
+            @@_card ||= OrderPaymentType.new('card')
+          end
+
+          # Represents an online payment (e.g. paypal, alipay, etc)
+          def OrderPaymentType.online
+            @@_online ||= OrderPaymentType.new('online')
+          end
+
+          # A payment in the form of a credit of some type (e.g. a store credit, gift
+          # card) applied to an order
+          def OrderPaymentType.credit
+            @@_credit ||= OrderPaymentType.new('credit')
+          end
+
+          # Request to pay the balance with cash on delivery. Offered only when the final
+          # mile carriers support cash on delivery.
+          def OrderPaymentType.cash_on_delivery
+            @@_cash_on_delivery ||= OrderPaymentType.new('cash_on_delivery')
+          end
+
+          def to_hash
+            value
+          end
+
+        end
+
         class OrderPriceDetailComponentKey
 
           attr_reader :value
@@ -10044,6 +10189,85 @@ module Io
 
         end
 
+        class TaxabilityType
+
+          attr_reader :value
+
+          def initialize(value)
+            @value = HttpClient::Preconditions.assert_class('value', value, String)
+          end
+
+          # Returns the instance of TaxabilityType for this value, creating a new instance for an unknown value
+          def TaxabilityType.apply(value)
+            if value.instance_of?(TaxabilityType)
+              value
+            else
+              HttpClient::Preconditions.assert_class_or_nil('value', value, String)
+              value.nil? ? nil : (from_string(value) || TaxabilityType.new(value))
+            end
+          end
+
+          # Returns the instance of TaxabilityType for this value, or nil if not found
+          def TaxabilityType.from_string(value)
+            HttpClient::Preconditions.assert_class('value', value, String)
+            TaxabilityType.ALL.find { |v| v.value == value }
+          end
+
+          def TaxabilityType.ALL
+            @@all ||= [TaxabilityType.tax_rule]
+          end
+
+          # Rule indicating how taxes should be applied.  Acceptable values are defined by
+          # the 'taxability_value' enum.
+          def TaxabilityType.tax_rule
+            @@_tax_rule ||= TaxabilityType.new('tax_rule')
+          end
+
+          def to_hash
+            value
+          end
+
+        end
+
+        class TaxabilityValue
+
+          attr_reader :value
+
+          def initialize(value)
+            @value = HttpClient::Preconditions.assert_class('value', value, String)
+          end
+
+          # Returns the instance of TaxabilityValue for this value, creating a new instance for an unknown value
+          def TaxabilityValue.apply(value)
+            if value.instance_of?(TaxabilityValue)
+              value
+            else
+              HttpClient::Preconditions.assert_class_or_nil('value', value, String)
+              value.nil? ? nil : (from_string(value) || TaxabilityValue.new(value))
+            end
+          end
+
+          # Returns the instance of TaxabilityValue for this value, or nil if not found
+          def TaxabilityValue.from_string(value)
+            HttpClient::Preconditions.assert_class('value', value, String)
+            TaxabilityValue.ALL.find { |v| v.value == value }
+          end
+
+          def TaxabilityValue.ALL
+            @@all ||= [TaxabilityValue.exempt]
+          end
+
+          # An item with this value is exempt from being taxed.
+          def TaxabilityValue.exempt
+            @@_exempt ||= TaxabilityValue.new('exempt')
+          end
+
+          def to_hash
+            value
+          end
+
+        end
+
         class TierDirection
 
           attr_reader :value
@@ -19208,7 +19432,7 @@ module Io
         # payment authorization for an order.
         class Order
 
-          attr_reader :id, :number, :experience, :customer, :delivered_duty, :destination, :expires_at, :items, :deliveries, :selections, :prices, :total, :attributes, :submitted_at, :lines, :identifiers, :promotions
+          attr_reader :id, :number, :experience, :customer, :delivered_duty, :destination, :expires_at, :items, :deliveries, :selections, :prices, :total, :attributes, :submitted_at, :lines, :identifiers, :promotions, :payments, :balance
 
           def initialize(incoming={})
             opts = HttpClient::Helper.symbolize_keys(incoming)
@@ -19230,6 +19454,8 @@ module Io
             @lines = (x = opts.delete(:lines); x.nil? ? nil : HttpClient::Preconditions.assert_class('lines', x, Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::Line) ? x : ::Io::Flow::V0::Models::Line.new(x)) })
             @identifiers = (x = opts.delete(:identifiers); x.nil? ? nil : HttpClient::Preconditions.assert_class('identifiers', x, Array).map { |v| HttpClient::Preconditions.assert_class('identifiers', v, String) })
             @promotions = (x = opts.delete(:promotions); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::Promotions) ? x : ::Io::Flow::V0::Models::Promotions.new(x)))
+            @payments = (x = opts.delete(:payments); x.nil? ? nil : HttpClient::Preconditions.assert_class('payments', x, Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::OrderPayment) ? x : ::Io::Flow::V0::Models::OrderPayment.new(x)) })
+            @balance = (x = opts.delete(:balance); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::LocalizedTotal) ? x : ::Io::Flow::V0::Models::LocalizedTotal.new(x)))
           end
 
           def to_json
@@ -19258,7 +19484,9 @@ module Io
               :submitted_at => submitted_at,
               :lines => lines.nil? ? nil : lines.map { |o| o.to_hash },
               :identifiers => identifiers.nil? ? nil : identifiers,
-              :promotions => promotions.nil? ? nil : promotions.to_hash
+              :promotions => promotions.nil? ? nil : promotions.to_hash,
+              :payments => payments.nil? ? nil : payments.map { |o| o.to_hash },
+              :balance => balance.nil? ? nil : balance.to_hash
             }
           end
 
@@ -19708,6 +19936,42 @@ module Io
 
         end
 
+        # An Order Payment represents an individual payment applied to an order. The
+        # type of the payment can be used to further lookup transaction level detail
+        class OrderPayment
+
+          attr_reader :id, :type, :reference, :description, :total
+
+          def initialize(incoming={})
+            opts = HttpClient::Helper.symbolize_keys(incoming)
+            HttpClient::Preconditions.require_keys(opts, [:id, :type, :reference, :description, :total], 'OrderPayment')
+            @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
+            @type = (x = opts.delete(:type); x.is_a?(::Io::Flow::V0::Models::OrderPaymentType) ? x : ::Io::Flow::V0::Models::OrderPaymentType.apply(x))
+            @reference = HttpClient::Preconditions.assert_class('reference', opts.delete(:reference), String)
+            @description = HttpClient::Preconditions.assert_class('description', opts.delete(:description), String)
+            @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={})
+            OrderPayment.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+          end
+
+          def to_hash
+            {
+              :id => id,
+              :type => type.value,
+              :reference => reference,
+              :description => description,
+              :total => total.to_hash
+            }
+          end
+
+        end
+
         # Represents a top-level order price detail, e.g. 'Subtotal' or 'VAT'.
         class OrderPriceDetail
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flowcommerce
 version: !ruby/object:Gem::Version
-  version: 0.2.18
+  version: 0.2.19
 platform: ruby
 authors:
 - Flow Commerce, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-27 00:00:00.000000000 Z
+date: 2017-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -45,7 +45,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- lib/flow_commerce/#client.rb#
 - lib/flow_commerce/client.rb
 - lib/flow_commerce/flow_api_v0_client.rb
 - lib/flowcommerce.rb

data/lib/flow_commerce/#client.rb#

@@ -1,48 +0,0 @@
-module FlowCommerce
-
-  DEFAULT_TOKEN_FILE_LOCATION = "~/.flow/token"
-
-  # Creates a new instance of the flow cient, using standard
-  # conventions to identify the API TOKEN, checking in order:
-  #
-  #  1. an environment variable named FLOW_TOKEN
-  #  2. an environment variable named FLOW_TOKEN_FILE containing
-  #     the path of the file with the token in it
-  #
-  # @param base_url Alternate URL for the API
-  def FlowCommerce.instance(opts={})
-    base_url = opts[:base_url].to_s.strip
-    token = opts[:token].to_s.strip
-    http_handler = opts[:http_handler]
-
-    if token.empty?
-      token = ENV['FLOW_TOKEN'].to_s.strip
-
-      if token.empty?
-        file = ENV['FLOW_TOKEN_FILE'].to_s.strip
-        if file.empty?
-          file = DEFAULT_TOKEN_FILE_LOCATION
-        end
-        path = File.expand_path(file)
-
-        if !File.exists?(path)
-          raise "File %s does not exist. You can specify environment variable FLOW_TOKEN or FLOW_TOKEN_FILE to explicitly provide the token" % path
-        end
-
-        token = IO.read(path).strip
-        if token.empty?
-          raise "File %s did not contain an API Token" % path
-        end
-      end
-    end
-
-    auth = Io::Flow::V0::HttpClient::Authorization.basic(token)
-
-    if base_url.empty?
-      Io::Flow::V0::Client.at_base_url(:authorization => auth, :http_handler => http_handler)
-    else
-      Io::Flow::V0::Client.new(base_url, :authorization => auth, :http_handler => http_handler)
-    end
-  end
-
-end