flowcommerce 0.0.19 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b92bf91f71330ca707d40dc304753db206910a1
-  data.tar.gz: 240876db6a950b588d838319faab4609d7e4e428
+  metadata.gz: 88a0ee5512e740845dac43fade0d5c3c698ee244
+  data.tar.gz: 737a1b1f72da00a597be1df2eb8d8a7256b70424
 SHA512:
-  metadata.gz: 19100dabe8a83d1fc692621bafcbfc4d2c7dbe6b6b04a76ff7819d4a7733c54bf87cd1b20596b0b2d6c213b6b96c05cf2db7183fda58411dbe6a25be52779d57
-  data.tar.gz: 579139b4d1ae1261bdcccd1c49118f1e2853795825e189027fe3bb852466cdca4e0e08bccaca56bd1c3c00e0b5bc016e6f231db32f39f9d3cfd1ce9897aeb10c
+  metadata.gz: 70a16853a2e7645a03036b0e01d04162930b2317cd15f4e756f05d988ff1c9ce04dc5367a96f3bf6fb91f818f0080e5538164cd095e0ef3048d680e944d61b89
+  data.tar.gz: 49c823e90d99edaa90417af5e1149db60b5a6329060e2d1667f30d296d0898801320348b94d546348e0731ea248d0391eadb6fe349926106a3f9bdae01a62532

data/lib/flow_commerce/flow_api_v0_client.rb

@@ -1,6 +1,6 @@
 # Generated by apidoc - http://www.apidoc.me
-# Service version: 0.0.60
-# apidoc:0.11.32 http://www.apidoc.me/flow/api/0.0.60/ruby_client
+# Service version: 0.0.61
+# apidoc:0.11.32 http://www.apidoc.me/flow/api/0.0.61/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.32 http://www.apidoc.me/flow/api/0.0.60/ruby_client' unless defined?(Constants::USER_AGENT)
-          VERSION = '0.0.60' unless defined?(Constants::VERSION)
+          USER_AGENT = 'apidoc:0.11.32 http://www.apidoc.me/flow/api/0.0.61/ruby_client' unless defined?(Constants::USER_AGENT)
+          VERSION = '0.0.61' unless defined?(Constants::VERSION)
           VERSION_MAJOR = 0 unless defined?(VERSION_MAJOR)
 
         end
@@ -437,16 +437,16 @@ module Io
             ::Io::Flow::V0::Models::Experience.new(r)
           end
 
-          # Returns information about 1 or more items, localized based on the query
-          # parameters
+          # Returns localized information about 1 or more items. The items will be
+          # localized based on the experience selected by the query parameters in the
+          # order of experience, then country, then ip address.
           def get_items(organization, incoming={})
             HttpClient::Preconditions.assert_class('organization', organization, String)
             opts = HttpClient::Helper.symbolize_keys(incoming)
             query = {
               :number => (x = opts.delete(:number); x.nil? ? nil : HttpClient::Preconditions.assert_class('number', x, Array).map { |v| HttpClient::Preconditions.assert_class('number', v, String) }),
               :experience => (x = opts.delete(:experience); x.nil? ? nil : HttpClient::Preconditions.assert_class('experience', x, String)),
-              :destination => (x = opts.delete(:destination); x.nil? ? nil : HttpClient::Preconditions.assert_class('destination', x, String)),
-              :from_country => (x = opts.delete(:from_country); x.nil? ? nil : HttpClient::Preconditions.assert_class('from_country', x, String)),
+              :country => (x = opts.delete(:country); x.nil? ? nil : HttpClient::Preconditions.assert_class('country', x, String)),
               :ip => (x = opts.delete(:ip); x.nil? ? nil : HttpClient::Preconditions.assert_class('ip', x, String)),
               :currency => (x = opts.delete(:currency); x.nil? ? nil : HttpClient::Preconditions.assert_class('currency', x, String)),
               :language => (x = opts.delete(:language); x.nil? ? nil : HttpClient::Preconditions.assert_class('language', x, String)),
@@ -465,8 +465,7 @@ module Io
             opts = HttpClient::Helper.symbolize_keys(incoming)
             query = {
               :experience => (x = opts.delete(:experience); x.nil? ? nil : HttpClient::Preconditions.assert_class('experience', x, String)),
-              :destination => (x = opts.delete(:destination); x.nil? ? nil : HttpClient::Preconditions.assert_class('destination', x, String)),
-              :from_country => (x = opts.delete(:from_country); x.nil? ? nil : HttpClient::Preconditions.assert_class('from_country', x, String)),
+              :country => (x = opts.delete(:country); x.nil? ? nil : HttpClient::Preconditions.assert_class('country', x, String)),
               :ip => (x = opts.delete(:ip); x.nil? ? nil : HttpClient::Preconditions.assert_class('ip', x, String)),
               :currency => (x = opts.delete(:currency); x.nil? ? nil : HttpClient::Preconditions.assert_class('currency', x, String)),
               :language => (x = opts.delete(:language); x.nil? ? nil : HttpClient::Preconditions.assert_class('language', x, String))
@@ -584,12 +583,21 @@ module Io
             r.map { |x| ::Io::Flow::V0::Models::Order.new(x) }
           end
 
-          # Create an order - the order must be booked (see bookings) before its
-          # expiration
-          def post(organization, order_form)
+          # Create an order, using the localized information from the experience
+          # selected by the query parameters. Note the order must be booked (see
+          # bookings) before its expiration
+          def post(organization, order_form, incoming={})
             HttpClient::Preconditions.assert_class('organization', organization, String)
+            opts = HttpClient::Helper.symbolize_keys(incoming)
+            query = {
+              :experience => (x = opts.delete(:experience); x.nil? ? nil : HttpClient::Preconditions.assert_class('experience', x, String)),
+              :country => (x = opts.delete(:country); x.nil? ? nil : HttpClient::Preconditions.assert_class('country', x, String)),
+              :ip => (x = opts.delete(:ip); x.nil? ? nil : HttpClient::Preconditions.assert_class('ip', x, String)),
+              :currency => (x = opts.delete(:currency); x.nil? ? nil : HttpClient::Preconditions.assert_class('currency', x, String)),
+              :language => (x = opts.delete(:language); x.nil? ? nil : HttpClient::Preconditions.assert_class('language', x, String))
+            }.delete_if { |k, v| v.nil? }
             HttpClient::Preconditions.assert_class('order_form', order_form, ::Io::Flow::V0::Models::OrderForm)
-            r = @client.request("/#{CGI.escape(organization)}/orders").with_json(order_form.to_json).post
+            r = @client.request("/#{CGI.escape(organization)}/orders").with_query(query).with_json(order_form.to_json).post
             ::Io::Flow::V0::Models::Order.new(r)
           end
 
@@ -601,6 +609,15 @@ module Io
             ::Io::Flow::V0::Models::Order.new(r)
           end
 
+          # Update an order.
+          def put_by_number(organization, number, order_put_form)
+            HttpClient::Preconditions.assert_class('organization', organization, String)
+            HttpClient::Preconditions.assert_class('number', number, String)
+            HttpClient::Preconditions.assert_class('order_put_form', order_put_form, ::Io::Flow::V0::Models::OrderPutForm)
+            r = @client.request("/#{CGI.escape(organization)}/orders/#{CGI.escape(number)}").with_json(order_put_form.to_json).put
+            ::Io::Flow::V0::Models::Order.new(r)
+          end
+
           # Delete an order. Note that only orders that have not yet been booked may be
           # deleted.
           def delete_by_number(organization, number)
@@ -614,11 +631,11 @@ module Io
           # expired (and a new quote could not be automatically recreated for a lower or
           # same price). This method is idempotent - booking an order a second time has
           # no effect.
-          def put_bookings_by_number(organization, number, order_booking_form)
+          def put_bookings_by_number(organization, number, hash)
             HttpClient::Preconditions.assert_class('organization', organization, String)
             HttpClient::Preconditions.assert_class('number', number, String)
-            HttpClient::Preconditions.assert_class('order_booking_form', order_booking_form, ::Io::Flow::V0::Models::OrderBookingForm)
-            r = @client.request("/#{CGI.escape(organization)}/orders/#{CGI.escape(number)}/bookings").with_json(order_booking_form.to_json).put
+            HttpClient::Preconditions.assert_class('hash', hash, Hash)
+            r = @client.request("/#{CGI.escape(organization)}/orders/#{CGI.escape(number)}/bookings").with_json(hash.to_json).put
             ::Io::Flow::V0::Models::OrderBooking.new(r)
           end
 
@@ -6613,7 +6630,7 @@ module Io
         # management (verification of who the person id), and reporting. We also
         # recommend including your customer.number whenever possible as doing so will
         # allow Flow to link up transactions for this customer making customer service
-        # easieer.
+        # easier.
         class Customer
 
           attr_reader :number, :name, :phone, :email
@@ -7295,14 +7312,15 @@ module Io
         # region
         class Experience
 
-          attr_reader :id, :key, :region, :currency, :language, :measurement_system, :name, :subcatalog, :price_display
+          attr_reader :id, :key, :region, :country, :currency, :language, :measurement_system, :name, :subcatalog, :price_display
 
           def initialize(incoming={})
             opts = HttpClient::Helper.symbolize_keys(incoming)
-            HttpClient::Preconditions.require_keys(opts, [:id, :key, :region, :currency, :language, :measurement_system, :name, :subcatalog, :price_display], 'Experience')
+            HttpClient::Preconditions.require_keys(opts, [:id, :key, :region, :country, :currency, :language, :measurement_system, :name, :subcatalog, :price_display], 'Experience')
             @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
             @key = HttpClient::Preconditions.assert_class('key', opts.delete(:key), String)
             @region = (x = opts.delete(:region); x.is_a?(::Io::Flow::V0::Models::RegionReference) ? x : ::Io::Flow::V0::Models::RegionReference.new(x))
+            @country = HttpClient::Preconditions.assert_class('country', opts.delete(:country), String)
             @currency = HttpClient::Preconditions.assert_class('currency', opts.delete(:currency), String)
             @language = HttpClient::Preconditions.assert_class('language', opts.delete(:language), String)
             @measurement_system = (x = opts.delete(:measurement_system); x.is_a?(::Io::Flow::V0::Models::MeasurementSystem) ? x : ::Io::Flow::V0::Models::MeasurementSystem.apply(x))
@@ -7324,6 +7342,7 @@ module Io
               :id => id,
               :key => key,
               :region => region.to_hash,
+              :country => country,
               :currency => currency,
               :language => language,
               :measurement_system => measurement_system.value,
@@ -7338,13 +7357,14 @@ module Io
         # Data needed to create an experience for a given geographic region
         class ExperienceForm
 
-          attr_reader :region_id, :name, :currency, :language, :key, :measurement_system, :subcatalog_id
+          attr_reader :region_id, :name, :country, :currency, :language, :key, :measurement_system, :subcatalog_id
 
           def initialize(incoming={})
             opts = HttpClient::Helper.symbolize_keys(incoming)
             HttpClient::Preconditions.require_keys(opts, [:region_id, :name], 'ExperienceForm')
             @region_id = HttpClient::Preconditions.assert_class('region_id', opts.delete(:region_id), String)
             @name = HttpClient::Preconditions.assert_class('name', opts.delete(:name), String)
+            @country = (x = opts.delete(:country); x.nil? ? nil : HttpClient::Preconditions.assert_class('country', x, String))
             @currency = (x = opts.delete(:currency); x.nil? ? nil : HttpClient::Preconditions.assert_class('currency', x, String))
             @language = (x = opts.delete(:language); x.nil? ? nil : HttpClient::Preconditions.assert_class('language', x, String))
             @key = (x = opts.delete(:key); x.nil? ? nil : HttpClient::Preconditions.assert_class('key', x, String))
@@ -7364,6 +7384,7 @@ module Io
             {
               :region_id => region_id,
               :name => name,
+              :country => country,
               :currency => currency,
               :language => language,
               :key => key,
@@ -8947,7 +8968,7 @@ module Io
 
         end
 
-        # Summary of product line item as part of the quote
+        # Summary of product line item
         class ItemSummary
 
           attr_reader :number, :quantity
@@ -9449,35 +9470,6 @@ module Io
 
         end
 
-        # Represents an order line item
-        class Line
-
-          attr_reader :number, :quantity
-
-          def initialize(incoming={})
-            opts = HttpClient::Helper.symbolize_keys(incoming)
-            HttpClient::Preconditions.require_keys(opts, [:number, :quantity], 'Line')
-            @number = HttpClient::Preconditions.assert_class('number', opts.delete(:number), String)
-            @quantity = HttpClient::Preconditions.assert_class('quantity', opts.delete(:quantity), Integer)
-          end
-
-          def to_json
-            JSON.dump(to_hash)
-          end
-
-          def copy(incoming={})
-            Line.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
-          end
-
-          def to_hash
-            {
-              :number => number,
-              :quantity => quantity
-            }
-          end
-
-        end
-
         class Local
 
           attr_reader :prices
@@ -9879,17 +9871,18 @@ module Io
         # then to book that order in order processing.
         class Order
 
-          attr_reader :id, :number, :customer, :expires_at, :destination, :deliveries, :prices, :total
+          attr_reader :id, :number, :customer, :expires_at, :destination, :deliveries, :selections, :prices, :total
 
           def initialize(incoming={})
             opts = HttpClient::Helper.symbolize_keys(incoming)
-            HttpClient::Preconditions.require_keys(opts, [:id, :number, :customer, :expires_at, :destination, :deliveries, :prices, :total], 'Order')
+            HttpClient::Preconditions.require_keys(opts, [:id, :number, :customer, :expires_at, :destination, :deliveries, :selections, :prices, :total], 'Order')
             @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
             @number = HttpClient::Preconditions.assert_class('number', opts.delete(:number), String)
             @customer = (x = opts.delete(:customer); x.is_a?(::Io::Flow::V0::Models::Customer) ? x : ::Io::Flow::V0::Models::Customer.new(x))
             @expires_at = HttpClient::Preconditions.assert_class('expires_at', HttpClient::Helper.to_date_time_iso8601(opts.delete(:expires_at)), DateTime)
             @destination = (x = opts.delete(:destination); x.is_a?(::Io::Flow::V0::Models::Location) ? x : ::Io::Flow::V0::Models::Location.new(x))
             @deliveries = HttpClient::Preconditions.assert_class('deliveries', opts.delete(:deliveries), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::Delivery) ? x : ::Io::Flow::V0::Models::Delivery.new(x)) }
+            @selections = HttpClient::Preconditions.assert_class('selections', opts.delete(:selections), Array).map { |v| HttpClient::Preconditions.assert_class('selections', v, String) }
             @prices = HttpClient::Preconditions.assert_class('prices', opts.delete(:prices), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::LocalizedPrice) ? x : ::Io::Flow::V0::Models::LocalizedPrice.new(x)) }
             @total = (x = opts.delete(:total); x.is_a?(::Io::Flow::V0::Models::LocalizedPrice) ? x : ::Io::Flow::V0::Models::LocalizedPrice.new(x))
           end
@@ -9910,6 +9903,7 @@ module Io
               :expires_at => expires_at,
               :destination => destination.to_hash,
               :deliveries => deliveries.map { |o| o.to_hash },
+              :selections => selections,
               :prices => prices.map { |o| o.to_hash },
               :total => total.to_hash
             }
@@ -9918,7 +9912,7 @@ module Io
         end
 
         # Represents an order that has been booked. Booked orders can no longer be
-        # deleted as they represent transactions in the real world
+        # deleted as they represent transactions in the real world.
         class OrderBooking
 
           attr_reader :id, :order, :created_at
@@ -9949,17 +9943,19 @@ module Io
 
         end
 
-        # Books an order. This means two things: a. all pricing in the quote will be
-        # guaranteed by Flow (subject to an active contract); b. you will be invoiced
-        # for any relevant costs.
-        class OrderBookingForm
+        # The order form is used to create an open order, providing the details on
+        # pricing and delivery options for destination and items/quantities specified
+        class OrderForm
 
-          attr_reader :options
+          attr_reader :number, :customer, :destination, :items
 
           def initialize(incoming={})
             opts = HttpClient::Helper.symbolize_keys(incoming)
-            HttpClient::Preconditions.require_keys(opts, [:options], 'OrderBookingForm')
-            @options = HttpClient::Preconditions.assert_class('options', opts.delete(:options), Array).map { |v| HttpClient::Preconditions.assert_class('options', v, String) }
+            HttpClient::Preconditions.require_keys(opts, [:number, :customer, :destination, :items], 'OrderForm')
+            @number = HttpClient::Preconditions.assert_class('number', opts.delete(:number), String)
+            @customer = (x = opts.delete(:customer); x.is_a?(::Io::Flow::V0::Models::Customer) ? x : ::Io::Flow::V0::Models::Customer.new(x))
+            @destination = (x = opts.delete(:destination); x.is_a?(::Io::Flow::V0::Models::Location) ? x : ::Io::Flow::V0::Models::Location.new(x))
+            @items = HttpClient::Preconditions.assert_class('items', opts.delete(:items), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::ItemSummary) ? x : ::Io::Flow::V0::Models::ItemSummary.new(x)) }
           end
 
           def to_json
@@ -9967,30 +9963,29 @@ module Io
           end
 
           def copy(incoming={})
-            OrderBookingForm.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+            OrderForm.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
           end
 
           def to_hash
             {
-              :options => options
+              :number => number,
+              :customer => customer.to_hash,
+              :destination => destination.to_hash,
+              :items => items.map { |o| o.to_hash }
             }
           end
 
         end
 
-        # The order form is used to create an open order, providing the details on
-        # pricing and delivery options for destination and items/quantities specified
-        class OrderForm
+        # Updates the selections on an order.
+        class OrderPutForm
 
-          attr_reader :number, :customer, :destination, :items
+          attr_reader :options
 
           def initialize(incoming={})
             opts = HttpClient::Helper.symbolize_keys(incoming)
-            HttpClient::Preconditions.require_keys(opts, [:number, :customer, :destination, :items], 'OrderForm')
-            @number = HttpClient::Preconditions.assert_class('number', opts.delete(:number), String)
-            @customer = (x = opts.delete(:customer); x.is_a?(::Io::Flow::V0::Models::Customer) ? x : ::Io::Flow::V0::Models::Customer.new(x))
-            @destination = (x = opts.delete(:destination); x.is_a?(::Io::Flow::V0::Models::Location) ? x : ::Io::Flow::V0::Models::Location.new(x))
-            @items = HttpClient::Preconditions.assert_class('items', opts.delete(:items), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::Line) ? x : ::Io::Flow::V0::Models::Line.new(x)) }
+            HttpClient::Preconditions.require_keys(opts, [:options], 'OrderPutForm')
+            @options = HttpClient::Preconditions.assert_class('options', opts.delete(:options), Array).map { |v| HttpClient::Preconditions.assert_class('options', v, String) }
           end
 
           def to_json
@@ -9998,15 +9993,12 @@ module Io
           end
 
           def copy(incoming={})
-            OrderForm.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+            OrderPutForm.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
           end
 
           def to_hash
             {
-              :number => number,
-              :customer => customer.to_hash,
-              :destination => destination.to_hash,
-              :items => items.map { |o| o.to_hash }
+              :options => options
             }
           end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flowcommerce
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.20
 platform: ruby
 authors:
 - Flow Commerce, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-28 00:00:00.000000000 Z
+date: 2016-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json