flowcommerce 0.0.9 → 0.0.10

data/lib/clients/flow_common_v0_client.rb

@@ -1,6 +1,6 @@
 # Generated by apidoc - http://www.apidoc.me
-# Service version: 0.0.11
-# apidoc:0.11.21 http://www.apidoc.me/flow/common/0.0.11/ruby_client
+# Service version: 0.0.19
+# apidoc:0.11.27 http://www.apidoc.me/flow/common/0.0.19/ruby_client
 
 require 'cgi'
 require 'net/http'
@@ -13,6 +13,8 @@ require 'rubygems'
 require 'json'
 require 'bigdecimal'
 
+# The Flow Commerce REST API provides full access to the global ecommerce
+# platform.
 module Io
   module Flow
     module Common
@@ -22,9 +24,10 @@ module Io
 
           module Constants
 
+            BASE_URL = 'https://api.flow.io' unless defined?(Constants::BASE_URL)
             NAMESPACE = 'io.flow.common.v0' unless defined?(Constants::NAMESPACE)
-            USER_AGENT = 'apidoc:0.11.21 http://www.apidoc.me/flow/common/0.0.11/ruby_client' unless defined?(Constants::USER_AGENT)
-            VERSION = '0.0.11' unless defined?(Constants::VERSION)
+            USER_AGENT = 'apidoc:0.11.27 http://www.apidoc.me/flow/common/0.0.19/ruby_client' unless defined?(Constants::USER_AGENT)
+            VERSION = '0.0.19' unless defined?(Constants::VERSION)
             VERSION_MAJOR = 0 unless defined?(VERSION_MAJOR)
 
           end
@@ -39,6 +42,11 @@ module Io
             HttpClient::Preconditions.check_state(url.match(/http.+/i), "URL[%s] must start with http" % url)
           end
 
+          # Creates an instance of the client using the base url specified in the API spec.
+          def Client.at_base_url(opts={})
+            Client.new(Constants::BASE_URL, opts)
+          end
+
           def request(path=nil)
             HttpClient::Preconditions.assert_class_or_nil('path', path, String)
             request = HttpClient::Request.new(URI.parse(@url + path.to_s)).with_header('User-Agent', Constants::USER_AGENT).with_header('X-Apidoc-Version', Constants::VERSION).with_header('X-Apidoc-Version-Major', Constants::VERSION_MAJOR)
@@ -54,17 +62,82 @@ module Io
             request
           end
 
-
+          def healthchecks
+            @healthchecks ||= ::Io::Flow::Common::V0::Clients::Healthchecks.new(self)
+          end
         end
 
         module Clients
 
+          class Healthchecks
 
+            def initialize(client)
+              @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::Common::V0::Client)
+            end
+
+            def get_healthcheck
+              r = @client.request("/_internal_/healthcheck").get
+              ::Io::Flow::Common::V0::Models::Healthcheck.new(r)
+            end
+
+          end
 
         end
 
         module Models
 
+          class ExpandableLocation
+
+            module Types
+              LOCATION = 'location' unless defined?(LOCATION)
+              LOCATION_REFERENCE = 'location_reference' unless defined?(LOCATION_REFERENCE)
+            end
+
+            def initialize(incoming={})
+              opts = HttpClient::Helper.symbolize_keys(incoming)
+              HttpClient::Preconditions.require_keys(opts, [:name], 'ExpandableLocation')
+              @name = HttpClient::Preconditions.assert_class('name', opts.delete(:name), String)
+            end
+
+            def to_hash
+              subtype_to_hash.merge(:discriminator => @name)
+            end
+
+            def ExpandableLocation.from_json(hash)
+              HttpClient::Preconditions.assert_class('hash', hash, Hash)
+              case HttpClient::Helper.symbolize_keys(hash)[:discriminator]
+                when Types::LOCATION; Location.new(hash)
+                when Types::LOCATION_REFERENCE; LocationReference.new(hash)
+                else ExpandableLocationUndefinedType.new(:name => union_type_name)
+              end
+            end
+
+          end
+
+          class ExpandableLocationUndefinedType < ExpandableLocation
+
+            attr_reader :name
+
+            def initialize(incoming={})
+              super(:name => 'undefined_type')
+              opts = HttpClient::Helper.symbolize_keys(incoming)
+              @name = HttpClient::Preconditions.assert_class('name', opts.delete(:name), String)
+            end
+
+            def subtype_to_hash
+              raise 'Unable to serialize undefined type to json'
+            end
+
+            def copy(incoming={})
+              raise 'Operation not supported for undefined type'
+            end
+
+            def to_hash
+              raise 'Operation not supported for undefined type'
+            end
+
+          end
+
           class ExpandableOrganization
 
             module Types
@@ -194,22 +267,17 @@ module Io
             end
 
             def Calendar.ALL
-              @@all ||= [Calendar.weekdays, Calendar.everyday, Calendar.unknown]
+              @@all ||= [Calendar.weekdays, Calendar.everyday]
             end
 
             # Mon - Fri
             def Calendar.weekdays
-              @@_weekdays ||= Calendar.new('Weekdays')
+              @@_weekdays ||= Calendar.new('weekdays')
             end
 
             # 7 days per week
             def Calendar.everyday
-              @@_everyday ||= Calendar.new('Everyday')
-            end
-
-            # We do not yet know the calendar
-            def Calendar.unknown
-              @@_unknown ||= Calendar.new('Unknown')
+              @@_everyday ||= Calendar.new('everyday')
             end
 
             def to_hash
@@ -302,6 +370,134 @@ module Io
 
           end
 
+          class DimensionType
+
+            attr_reader :value
+
+            def initialize(value)
+              @value = HttpClient::Preconditions.assert_class('value', value, String)
+            end
+
+            # Returns the instance of DimensionType for this value, creating a new instance for an unknown value
+            def DimensionType.apply(value)
+              if value.instance_of?(DimensionType)
+                value
+              else
+                HttpClient::Preconditions.assert_class_or_nil('value', value, String)
+                value.nil? ? nil : (from_string(value) || DimensionType.new(value))
+              end
+            end
+
+            # Returns the instance of DimensionType for this value, or nil if not found
+            def DimensionType.from_string(value)
+              HttpClient::Preconditions.assert_class('value', value, String)
+              DimensionType.ALL.find { |v| v.value == value }
+            end
+
+            def DimensionType.ALL
+              @@all ||= [DimensionType.product, DimensionType.package]
+            end
+
+            # The standalone dimensions of an item.
+            def DimensionType.product
+              @@_product ||= DimensionType.new('product')
+            end
+
+            # The boxed dimensions of an item.
+            def DimensionType.package
+              @@_package ||= DimensionType.new('package')
+            end
+
+            def to_hash
+              value
+            end
+
+          end
+
+          class ExceptionType
+
+            attr_reader :value
+
+            def initialize(value)
+              @value = HttpClient::Preconditions.assert_class('value', value, String)
+            end
+
+            # Returns the instance of ExceptionType for this value, creating a new instance for an unknown value
+            def ExceptionType.apply(value)
+              if value.instance_of?(ExceptionType)
+                value
+              else
+                HttpClient::Preconditions.assert_class_or_nil('value', value, String)
+                value.nil? ? nil : (from_string(value) || ExceptionType.new(value))
+              end
+            end
+
+            # Returns the instance of ExceptionType for this value, or nil if not found
+            def ExceptionType.from_string(value)
+              HttpClient::Preconditions.assert_class('value', value, String)
+              ExceptionType.ALL.find { |v| v.value == value }
+            end
+
+            def ExceptionType.ALL
+              @@all ||= [ExceptionType.open, ExceptionType.closed]
+            end
+
+            def ExceptionType.open
+              @@_open ||= ExceptionType.new('open')
+            end
+
+            def ExceptionType.closed
+              @@_closed ||= ExceptionType.new('closed')
+            end
+
+            def to_hash
+              value
+            end
+
+          end
+
+          class HolidayCalendar
+
+            attr_reader :value
+
+            def initialize(value)
+              @value = HttpClient::Preconditions.assert_class('value', value, String)
+            end
+
+            # Returns the instance of HolidayCalendar for this value, creating a new instance for an unknown value
+            def HolidayCalendar.apply(value)
+              if value.instance_of?(HolidayCalendar)
+                value
+              else
+                HttpClient::Preconditions.assert_class_or_nil('value', value, String)
+                value.nil? ? nil : (from_string(value) || HolidayCalendar.new(value))
+              end
+            end
+
+            # Returns the instance of HolidayCalendar for this value, or nil if not found
+            def HolidayCalendar.from_string(value)
+              HttpClient::Preconditions.assert_class('value', value, String)
+              HolidayCalendar.ALL.find { |v| v.value == value }
+            end
+
+            def HolidayCalendar.ALL
+              @@all ||= [HolidayCalendar.us_bank_holidays, HolidayCalendar.jewish_holidays]
+            end
+
+            def HolidayCalendar.us_bank_holidays
+              @@_us_bank_holidays ||= HolidayCalendar.new('us_bank_holidays')
+            end
+
+            def HolidayCalendar.jewish_holidays
+              @@_jewish_holidays ||= HolidayCalendar.new('jewish_holidays')
+            end
+
+            def to_hash
+              value
+            end
+
+          end
+
           class ScheduleExceptionStatus
 
             attr_reader :value
@@ -344,6 +540,48 @@ module Io
 
           end
 
+          class SortDirection
+
+            attr_reader :value
+
+            def initialize(value)
+              @value = HttpClient::Preconditions.assert_class('value', value, String)
+            end
+
+            # Returns the instance of SortDirection for this value, creating a new instance for an unknown value
+            def SortDirection.apply(value)
+              if value.instance_of?(SortDirection)
+                value
+              else
+                HttpClient::Preconditions.assert_class_or_nil('value', value, String)
+                value.nil? ? nil : (from_string(value) || SortDirection.new(value))
+              end
+            end
+
+            # Returns the instance of SortDirection for this value, or nil if not found
+            def SortDirection.from_string(value)
+              HttpClient::Preconditions.assert_class('value', value, String)
+              SortDirection.ALL.find { |v| v.value == value }
+            end
+
+            def SortDirection.ALL
+              @@all ||= [SortDirection.ascending, SortDirection.descending]
+            end
+
+            def SortDirection.ascending
+              @@_ascending ||= SortDirection.new('ascending')
+            end
+
+            def SortDirection.descending
+              @@_descending ||= SortDirection.new('descending')
+            end
+
+            def to_hash
+              value
+            end
+
+          end
+
           class UnitOfMeasurement
 
             attr_reader :value
@@ -560,43 +798,6 @@ module Io
 
           end
 
-          # Defines structured fields for address to be used in user/form input. Either
-          # text or the structured input needs to be present.
-          class Address
-
-            attr_reader :text, :streets, :city, :province, :postal_code, :country
-
-            def initialize(incoming={})
-              opts = HttpClient::Helper.symbolize_keys(incoming)
-              @text = (x = opts.delete(:text); x.nil? ? nil : HttpClient::Preconditions.assert_class('text', x, String))
-              @streets = (x = opts.delete(:streets); x.nil? ? nil : HttpClient::Preconditions.assert_class('streets', x, Array).map { |v| HttpClient::Preconditions.assert_class('streets', v, String) })
-              @city = (x = opts.delete(:city); x.nil? ? nil : HttpClient::Preconditions.assert_class('city', x, String))
-              @province = (x = opts.delete(:province); x.nil? ? nil : HttpClient::Preconditions.assert_class('province', x, String))
-              @postal_code = (x = opts.delete(:postal_code); x.nil? ? nil : HttpClient::Preconditions.assert_class('postal_code', x, String))
-              @country = (x = opts.delete(:country); x.nil? ? nil : HttpClient::Preconditions.assert_class('country', x, String))
-            end
-
-            def to_json
-              JSON.dump(to_hash)
-            end
-
-            def copy(incoming={})
-              Address.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
-            end
-
-            def to_hash
-              {
-                :text => text,
-                :streets => streets.nil? ? nil : streets,
-                :city => city,
-                :province => province,
-                :postal_code => postal_code,
-                :country => country
-              }
-            end
-
-          end
-
           # Defines structured fields for a contact person. Typically used for specifying
           # contact person for an account, shipment, or organization representative
           class Contact
@@ -659,13 +860,16 @@ module Io
 
           class Dimension
 
-            attr_reader :value, :units
+            attr_reader :type, :depth, :length, :weight, :width
 
             def initialize(incoming={})
               opts = HttpClient::Helper.symbolize_keys(incoming)
-              HttpClient::Preconditions.require_keys(opts, [:value, :units], 'Dimension')
-              @value = HttpClient::Preconditions.assert_class('value', opts.delete(:value), Numeric)
-              @units = (x = opts.delete(:units); x.is_a?(::Io::Flow::Common::V0::Models::UnitOfMeasurement) ? x : ::Io::Flow::Common::V0::Models::UnitOfMeasurement.apply(x))
+              HttpClient::Preconditions.require_keys(opts, [:type], 'Dimension')
+              @type = (x = opts.delete(:type); x.is_a?(::Io::Flow::Common::V0::Models::DimensionType) ? x : ::Io::Flow::Common::V0::Models::DimensionType.apply(x))
+              @depth = (x = opts.delete(:depth); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::Common::V0::Models::Measurement) ? x : ::Io::Flow::Common::V0::Models::Measurement.new(x)))
+              @length = (x = opts.delete(:length); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::Common::V0::Models::Measurement) ? x : ::Io::Flow::Common::V0::Models::Measurement.new(x)))
+              @weight = (x = opts.delete(:weight); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::Common::V0::Models::Measurement) ? x : ::Io::Flow::Common::V0::Models::Measurement.new(x)))
+              @width = (x = opts.delete(:width); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::Common::V0::Models::Measurement) ? x : ::Io::Flow::Common::V0::Models::Measurement.new(x)))
             end
 
             def to_json
@@ -678,8 +882,11 @@ module Io
 
             def to_hash
               {
-                :value => value,
-                :units => units.value
+                :type => type.value,
+                :depth => depth.nil? ? nil : depth.to_hash,
+                :length => length.nil? ? nil : length.to_hash,
+                :weight => weight.nil? ? nil : weight.to_hash,
+                :width => width.nil? ? nil : width.to_hash
               }
             end
 
@@ -713,6 +920,70 @@ module Io
 
           end
 
+          # Represents an exception to the schedule of a location.
+          class Exception
+
+            attr_reader :type, :datetime_range
+
+            def initialize(incoming={})
+              opts = HttpClient::Helper.symbolize_keys(incoming)
+              HttpClient::Preconditions.require_keys(opts, [:type, :datetime_range], 'Exception')
+              @type = (x = opts.delete(:type); x.is_a?(::Io::Flow::Common::V0::Models::ExceptionType) ? x : ::Io::Flow::Common::V0::Models::ExceptionType.apply(x))
+              @datetime_range = (x = opts.delete(:datetime_range); x.is_a?(::Io::Flow::Common::V0::Models::DatetimeRange) ? x : ::Io::Flow::Common::V0::Models::DatetimeRange.new(x))
+            end
+
+            def to_json
+              JSON.dump(to_hash)
+            end
+
+            def copy(incoming={})
+              Exception.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+            end
+
+            def to_hash
+              {
+                :type => type.value,
+                :datetime_range => datetime_range.to_hash
+              }
+            end
+
+          end
+
+          # Some important fields related to experiences used in various APIs
+          class ExperienceSummary
+
+            attr_reader :id, :key, :name, :currency, :country
+
+            def initialize(incoming={})
+              opts = HttpClient::Helper.symbolize_keys(incoming)
+              HttpClient::Preconditions.require_keys(opts, [:id, :key, :name], 'ExperienceSummary')
+              @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
+              @key = HttpClient::Preconditions.assert_class('key', opts.delete(:key), String)
+              @name = HttpClient::Preconditions.assert_class('name', opts.delete(:name), String)
+              @currency = (x = opts.delete(:currency); x.nil? ? nil : HttpClient::Preconditions.assert_class('currency', x, String))
+              @country = (x = opts.delete(:country); x.nil? ? nil : HttpClient::Preconditions.assert_class('country', x, String))
+            end
+
+            def to_json
+              JSON.dump(to_hash)
+            end
+
+            def copy(incoming={})
+              ExperienceSummary.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+            end
+
+            def to_hash
+              {
+                :id => id,
+                :key => key,
+                :name => name,
+                :currency => currency,
+                :country => country
+              }
+            end
+
+          end
+
           class Healthcheck
 
             attr_reader :status
@@ -739,17 +1010,56 @@ module Io
 
           end
 
-          # We capture the location as a string; over time we anticipate storing structued
-          # data by parsing the location (e.g. the country) to enable things like
-          # reporting, filtering in bulk
-          class Location
+          # Defines structured fields for address to be used in user/form input. Either
+          # text or the structured input needs to be present.
+          class Location < ExpandableLocation
+
+            attr_reader :text, :streets, :city, :province, :postal, :country, :latitude, :longitude
+
+            def initialize(incoming={})
+              super(:name => ExpandableLocation::Types::LOCATION)
+              opts = HttpClient::Helper.symbolize_keys(incoming)
+              @text = (x = opts.delete(:text); x.nil? ? nil : HttpClient::Preconditions.assert_class('text', x, String))
+              @streets = (x = opts.delete(:streets); x.nil? ? nil : HttpClient::Preconditions.assert_class('streets', x, Array).map { |v| HttpClient::Preconditions.assert_class('streets', v, String) })
+              @city = (x = opts.delete(:city); x.nil? ? nil : HttpClient::Preconditions.assert_class('city', x, String))
+              @province = (x = opts.delete(:province); x.nil? ? nil : HttpClient::Preconditions.assert_class('province', x, String))
+              @postal = (x = opts.delete(:postal); x.nil? ? nil : HttpClient::Preconditions.assert_class('postal', x, String))
+              @country = (x = opts.delete(:country); x.nil? ? nil : HttpClient::Preconditions.assert_class('country', x, String))
+              @latitude = (x = opts.delete(:latitude); x.nil? ? nil : HttpClient::Preconditions.assert_class('latitude', x, String))
+              @longitude = (x = opts.delete(:longitude); x.nil? ? nil : HttpClient::Preconditions.assert_class('longitude', x, String))
+            end
+
+            def to_json
+              JSON.dump(to_hash)
+            end
+
+            def copy(incoming={})
+              Location.new(subtype_to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+            end
+
+            def subtype_to_hash
+              {
+                :text => text,
+                :streets => streets.nil? ? nil : streets,
+                :city => city,
+                :province => province,
+                :postal => postal,
+                :country => country,
+                :latitude => latitude,
+                :longitude => longitude
+              }
+            end
+
+          end
+
+          class LocationReference < ExpandableLocation
 
-            attr_reader :value
+            attr_reader :text
 
             def initialize(incoming={})
+              super(:name => ExpandableLocation::Types::LOCATION_REFERENCE)
               opts = HttpClient::Helper.symbolize_keys(incoming)
-              HttpClient::Preconditions.require_keys(opts, [:value], 'Location')
-              @value = HttpClient::Preconditions.assert_class('value', opts.delete(:value), String)
+              @text = (x = opts.delete(:text); x.nil? ? nil : HttpClient::Preconditions.assert_class('text', x, String))
             end
 
             def to_json
@@ -757,12 +1067,12 @@ module Io
             end
 
             def copy(incoming={})
-              Location.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+              LocationReference.new(subtype_to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
             end
 
-            def to_hash
+            def subtype_to_hash
               {
-                :value => value
+                :text => text
               }
             end
 
@@ -908,15 +1218,18 @@ module Io
 
           end
 
-          class Price
+          # Represents operating calendar and holidays of a location
+          class Schedule
 
-            attr_reader :amount, :currency
+            attr_reader :calendar, :holiday, :exception, :cutoff
 
             def initialize(incoming={})
               opts = HttpClient::Helper.symbolize_keys(incoming)
-              HttpClient::Preconditions.require_keys(opts, [:amount, :currency], 'Price')
-              @amount = HttpClient::Preconditions.assert_class('amount', opts.delete(:amount), Numeric)
-              @currency = HttpClient::Preconditions.assert_class('currency', opts.delete(:currency), String)
+              HttpClient::Preconditions.require_keys(opts, [:holiday, :exception], 'Schedule')
+              @calendar = (x = opts.delete(:calendar); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::Common::V0::Models::Calendar) ? x : ::Io::Flow::Common::V0::Models::Calendar.apply(x)))
+              @holiday = (x = opts.delete(:holiday); x.is_a?(::Io::Flow::Common::V0::Models::HolidayCalendar) ? x : ::Io::Flow::Common::V0::Models::HolidayCalendar.apply(x))
+              @exception = HttpClient::Preconditions.assert_class('exception', opts.delete(:exception), Array).map { |v| (x = v; x.is_a?(::Io::Flow::Common::V0::Models::Exception) ? x : ::Io::Flow::Common::V0::Models::Exception.new(x)) }
+              @cutoff = (x = opts.delete(:cutoff); x.nil? ? nil : HttpClient::Preconditions.assert_class('cutoff', x, String))
             end
 
             def to_json
@@ -924,13 +1237,15 @@ module Io
             end
 
             def copy(incoming={})
-              Price.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+              Schedule.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
             end
 
             def to_hash
               {
-                :amount => amount,
-                :currency => currency
+                :calendar => calendar.nil? ? nil : calendar.value,
+                :holiday => holiday.value,
+                :exception => exception.map { |o| o.to_hash },
+                :cutoff => cutoff
               }
             end