flowcommerce 0.2.19 → 0.2.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afc95c1997b26e43995dcb615a80a2da52d561b6
-  data.tar.gz: 65b268ec436733976c79b6dcea4421632dd3aa02
+  metadata.gz: 8428501e2efb49365c317cad3ab87935641a633c
+  data.tar.gz: 6e2c51771003a515df1f9dbb1ac4e374f03874e2
 SHA512:
-  metadata.gz: 63fd6e67c8b29f727623fbdb97f09f1e88baf87387fb4d48cad18a5bdf5e53227efe773aa0202c5bae3e3a8fa01bbe66b87f25e3a31548df8557ae6b64097784
-  data.tar.gz: 38c2917e4a1e35e67c09eb7e42d670f3af2fca18e6493979b8a6a0c8a38aad20e9ec9efe0791b44f8da663fe48d39112b49a568ea150cfaf48fae50173ec5276
+  metadata.gz: 1ef2330e31b6c91229e54c590057d27ecbccdd3b879e731f5eadd22ed979fdc4073d5010be47c0a211bad3909697dff8041d10997d3d24ca8ae3332a93ebf4d3
+  data.tar.gz: 8950cc292dd9e72b7b35a5db2cd127cd9192d888aa384ad3616ac141a5632f02581a7c8b4aeeea678227048906d1e20c01330c1fe34ae86122e259bdf2df207d

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.89 http://www.apidoc.me/flow/api/0.3.34/ruby_client
+# apidoc:0.11.92 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.89 http://www.apidoc.me/flow/api/0.3.34/ruby_client' unless defined?(Constants::USER_AGENT)
+          USER_AGENT = 'apidoc:0.11.92 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)
 
@@ -212,6 +212,10 @@ module Io
           @inventory_updates ||= ::Io::Flow::V0::Clients::InventoryUpdates.new(self)
         end
 
+        def manifests
+          @manifests ||= ::Io::Flow::V0::Clients::Manifests.new(self)
+        end
+
         def quotes
           @quotes ||= ::Io::Flow::V0::Clients::Quotes.new(self)
         end
@@ -2721,6 +2725,58 @@ module Io
 
         end
 
+        class Manifests
+
+          def initialize(client)
+            @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client)
+          end
+
+          def get(organization, incoming={})
+            HttpClient::Preconditions.assert_class('organization', organization, String)
+            opts = HttpClient::Helper.symbolize_keys(incoming)
+            query = {
+              :id => (x = opts.delete(:id); x.nil? ? nil : HttpClient::Preconditions.assert_class('id', x, Array).map { |v| HttpClient::Preconditions.assert_class('id', v, String) }),
+              :carrier_tracking_number => (x = opts.delete(:carrier_tracking_number); x.nil? ? nil : HttpClient::Preconditions.assert_class('carrier_tracking_number', x, Array).map { |v| HttpClient::Preconditions.assert_class('carrier_tracking_number', v, String) }),
+              :flow_tracking_number => (x = opts.delete(:flow_tracking_number); x.nil? ? nil : HttpClient::Preconditions.assert_class('flow_tracking_number', x, Array).map { |v| HttpClient::Preconditions.assert_class('flow_tracking_number', v, String) }),
+              :service => (x = opts.delete(:service); x.nil? ? nil : HttpClient::Preconditions.assert_class('service', x, Array).map { |v| HttpClient::Preconditions.assert_class('service', v, String) }),
+              :limit => HttpClient::Preconditions.assert_class('limit', (x = opts.delete(:limit); x.nil? ? 25 : x), Integer),
+              :offset => HttpClient::Preconditions.assert_class('offset', (x = opts.delete(:offset); x.nil? ? 0 : x), Integer),
+              :sort => HttpClient::Preconditions.assert_class('sort', (x = opts.delete(:sort); x.nil? ? "-created_at" : x), String)
+            }.delete_if { |k, v| v.nil? }
+            r = @client.request("/#{CGI.escape(organization)}/manifests").with_query(query).get
+            r.map { |x| ::Io::Flow::V0::Models::Manifest.new(x) }
+          end
+
+          def get_by_id(organization, id)
+            HttpClient::Preconditions.assert_class('organization', organization, String)
+            HttpClient::Preconditions.assert_class('id', id, String)
+            r = @client.request("/#{CGI.escape(organization)}/manifests/#{CGI.escape(id)}").get
+            ::Io::Flow::V0::Models::Manifest.new(r)
+          end
+
+          # Generates a new manifest with all outstanding labels and redirects to a
+          # downloadable PDF of carrier-generated manifest or bill of lading (BOL). If
+          # no outstanding labels, this will generate a 422 error.
+          def get_type_and_all(organization, incoming={})
+            HttpClient::Preconditions.assert_class('organization', organization, String)
+            opts = HttpClient::Helper.symbolize_keys(incoming)
+            query = {
+              :service => HttpClient::Preconditions.assert_class('service', opts.delete(:service), String)
+            }.delete_if { |k, v| v.nil? }
+            r = @client.request("/#{CGI.escape(organization)}/manifests/type/all").with_query(query).get
+            r
+          end
+
+          # Generate a new manifest/carrier BOL with specific tracking numbers
+          def post_type_and_list(organization, manifest_form)
+            HttpClient::Preconditions.assert_class('organization', organization, String)
+            (x = manifest_form; x.is_a?(::Io::Flow::V0::Models::ManifestForm) ? x : ::Io::Flow::V0::Models::ManifestForm.new(x))
+            r = @client.request("/#{CGI.escape(organization)}/manifests/type/list").with_json(manifest_form.to_json).post
+            ::Io::Flow::V0::Models::Manifest.new(r)
+          end
+
+        end
+
         class Quotes
 
           def initialize(client)
@@ -8539,6 +8595,51 @@ module Io
 
         end
 
+        class ManifestType
+
+          attr_reader :value
+
+          def initialize(value)
+            @value = HttpClient::Preconditions.assert_class('value', value, String)
+          end
+
+          # Returns the instance of ManifestType for this value, creating a new instance for an unknown value
+          def ManifestType.apply(value)
+            if value.instance_of?(ManifestType)
+              value
+            else
+              HttpClient::Preconditions.assert_class_or_nil('value', value, String)
+              value.nil? ? nil : (from_string(value) || ManifestType.new(value))
+            end
+          end
+
+          # Returns the instance of ManifestType for this value, or nil if not found
+          def ManifestType.from_string(value)
+            HttpClient::Preconditions.assert_class('value', value, String)
+            ManifestType.ALL.find { |v| v.value == value }
+          end
+
+          def ManifestType.ALL
+            @@all ||= [ManifestType.all, ManifestType.list]
+          end
+
+          # Manifest all open shipping labels that are not part of a manifest yet for the
+          # organization and carrier service
+          def ManifestType.all
+            @@_all ||= ManifestType.new('all')
+          end
+
+          # Manifest only the list of specified labels
+          def ManifestType.list
+            @@_list ||= ManifestType.new('list')
+          end
+
+          def to_hash
+            value
+          end
+
+        end
+
         class MarginType
 
           attr_reader :value
@@ -10354,6 +10455,48 @@ module Io
 
         end
 
+        class TrackingNumberType
+
+          attr_reader :value
+
+          def initialize(value)
+            @value = HttpClient::Preconditions.assert_class('value', value, String)
+          end
+
+          # Returns the instance of TrackingNumberType for this value, creating a new instance for an unknown value
+          def TrackingNumberType.apply(value)
+            if value.instance_of?(TrackingNumberType)
+              value
+            else
+              HttpClient::Preconditions.assert_class_or_nil('value', value, String)
+              value.nil? ? nil : (from_string(value) || TrackingNumberType.new(value))
+            end
+          end
+
+          # Returns the instance of TrackingNumberType for this value, or nil if not found
+          def TrackingNumberType.from_string(value)
+            HttpClient::Preconditions.assert_class('value', value, String)
+            TrackingNumberType.ALL.find { |v| v.value == value }
+          end
+
+          def TrackingNumberType.ALL
+            @@all ||= [TrackingNumberType.flow, TrackingNumberType.carrier]
+          end
+
+          def TrackingNumberType.flow
+            @@_flow ||= TrackingNumberType.new('flow')
+          end
+
+          def TrackingNumberType.carrier
+            @@_carrier ||= TrackingNumberType.new('carrier')
+          end
+
+          def to_hash
+            value
+          end
+
+        end
+
         class TrackingStatus
 
           attr_reader :value
@@ -18704,6 +18847,74 @@ module Io
 
         end
 
+        # Represents closeout of a group of labels that have been transfered to the
+        # carrier for shipping
+        class Manifest
+
+          attr_reader :id, :type, :service, :timestamp, :shipping_labels, :pdf
+
+          def initialize(incoming={})
+            opts = HttpClient::Helper.symbolize_keys(incoming)
+            HttpClient::Preconditions.require_keys(opts, [:id, :type, :service, :timestamp, :shipping_labels], 'Manifest')
+            @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
+            @type = (x = opts.delete(:type); x.is_a?(::Io::Flow::V0::Models::ManifestType) ? x : ::Io::Flow::V0::Models::ManifestType.apply(x))
+            @service = (x = opts.delete(:service); x.is_a?(::Io::Flow::V0::Models::ServiceSummary) ? x : ::Io::Flow::V0::Models::ServiceSummary.new(x))
+            @timestamp = HttpClient::Preconditions.assert_class('timestamp', HttpClient::Helper.to_date_time_iso8601(opts.delete(:timestamp)), DateTime)
+            @shipping_labels = HttpClient::Preconditions.assert_class('shipping_labels', opts.delete(:shipping_labels), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::ShippingLabelSummary) ? x : ::Io::Flow::V0::Models::ShippingLabelSummary.new(x)) }
+            @pdf = (x = opts.delete(:pdf); x.nil? ? nil : HttpClient::Preconditions.assert_class('pdf', x, String))
+          end
+
+          def to_json
+            JSON.dump(to_hash)
+          end
+
+          def copy(incoming={})
+            Manifest.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+          end
+
+          def to_hash
+            {
+              :id => id,
+              :type => type.value,
+              :service => service.to_hash,
+              :timestamp => timestamp,
+              :shipping_labels => shipping_labels.map { |o| o.to_hash },
+              :pdf => pdf
+            }
+          end
+
+        end
+
+        class ManifestForm
+
+          attr_reader :service, :tracking_number_type, :tracking_numbers
+
+          def initialize(incoming={})
+            opts = HttpClient::Helper.symbolize_keys(incoming)
+            HttpClient::Preconditions.require_keys(opts, [:service, :tracking_number_type, :tracking_numbers], 'ManifestForm')
+            @service = HttpClient::Preconditions.assert_class('service', opts.delete(:service), String)
+            @tracking_number_type = (x = opts.delete(:tracking_number_type); x.is_a?(::Io::Flow::V0::Models::TrackingNumberType) ? x : ::Io::Flow::V0::Models::TrackingNumberType.apply(x))
+            @tracking_numbers = HttpClient::Preconditions.assert_class('tracking_numbers', opts.delete(:tracking_numbers), Array).map { |v| HttpClient::Preconditions.assert_class('tracking_numbers', v, String) }
+          end
+
+          def to_json
+            JSON.dump(to_hash)
+          end
+
+          def copy(incoming={})
+            ManifestForm.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+          end
+
+          def to_hash
+            {
+              :service => service,
+              :tracking_number_type => tracking_number_type.value,
+              :tracking_numbers => tracking_numbers
+            }
+          end
+
+        end
+
         class Margin
 
           attr_reader :type, :value
@@ -23686,6 +23897,36 @@ module Io
 
         end
 
+        class ShippingLabelSummary
+
+          attr_reader :id, :flow_tracking_number, :carrier_tracking_number
+
+          def initialize(incoming={})
+            opts = HttpClient::Helper.symbolize_keys(incoming)
+            HttpClient::Preconditions.require_keys(opts, [:id, :flow_tracking_number, :carrier_tracking_number], 'ShippingLabelSummary')
+            @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
+            @flow_tracking_number = HttpClient::Preconditions.assert_class('flow_tracking_number', opts.delete(:flow_tracking_number), String)
+            @carrier_tracking_number = HttpClient::Preconditions.assert_class('carrier_tracking_number', opts.delete(:carrier_tracking_number), String)
+          end
+
+          def to_json
+            JSON.dump(to_hash)
+          end
+
+          def copy(incoming={})
+            ShippingLabelSummary.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+          end
+
+          def to_hash
+            {
+              :id => id,
+              :flow_tracking_number => flow_tracking_number,
+              :carrier_tracking_number => carrier_tracking_number
+            }
+          end
+
+        end
+
         class ShippingLabelVersion
 
           attr_reader :id, :timestamp, :type, :shipping_label

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flowcommerce
 version: !ruby/object:Gem::Version
-  version: 0.2.19
+  version: 0.2.20
 platform: ruby
 authors:
 - Flow Commerce, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-09 00:00:00.000000000 Z
+date: 2017-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json