flowcommerce 0.0.22 → 0.0.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca499ee693efdc71a8cead7daf2d54c6b964eaf8
-  data.tar.gz: 3f4de27a4edbc09df06c2c4340385e51afa97ec8
+  metadata.gz: 1cfa65a9bf67ec6615f71dab03639fa4aa448f8b
+  data.tar.gz: 385346b70cfb4a10050572139ce61e0d8fa59753
 SHA512:
-  metadata.gz: e9df3b57af4a45821c74e51e20e95f73531350db1b850a175bf2542c3c64d590d3fa287902d6d898ec8194dd30ff371089829a612311b89f72b55690dbe2deea
-  data.tar.gz: ab2c3588cbc691ef24ad8004de19312ddd4af3f6fb5740ad47a985ad4e019511b8fb48b3b316221a5aaef20f6e95e8355ca04886d0f0ce8508f1b185382e0a19
+  metadata.gz: 4c747fa5afe81b6238d3bc546c433bb6f4c17d464cb9f411b43f32350c258556642aa3837e16ec19fe37437d8ef4214e9cb96bfa68fb0534dd0c1750d16c2e92
+  data.tar.gz: 1b012bd86c20def9b4d873a5401f4725b584bdd68c5281189dedfe9ffaac3758b3dea6c2786f157716ac39f8b49d9007981c0974b200e925377827a1824c6e45

data/lib/flow_commerce/flow_api_v0_client.rb

@@ -1,6 +1,6 @@
 # Generated by apidoc - http://www.apidoc.me
-# Service version: 0.0.65
-# apidoc:0.11.33 http://www.apidoc.me/flow/api/0.0.65/ruby_client
+# Service version: 0.0.67
+# apidoc:0.11.33 http://www.apidoc.me/flow/api/0.0.67/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.33 http://www.apidoc.me/flow/api/0.0.65/ruby_client' unless defined?(Constants::USER_AGENT)
-          VERSION = '0.0.65' unless defined?(Constants::VERSION)
+          USER_AGENT = 'apidoc:0.11.33 http://www.apidoc.me/flow/api/0.0.67/ruby_client' unless defined?(Constants::USER_AGENT)
+          VERSION = '0.0.67' unless defined?(Constants::VERSION)
           VERSION_MAJOR = 0 unless defined?(VERSION_MAJOR)
 
         end
@@ -865,6 +865,14 @@ module Io
             nil
           end
 
+          # Get statistics for the specified subcatalog. Always paginated.
+          def get_statistics_by_subcatalog_id(organization, subcatalog_id)
+            HttpClient::Preconditions.assert_class('organization', organization, String)
+            HttpClient::Preconditions.assert_class('subcatalog_id', subcatalog_id, String)
+            r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs/#{CGI.escape(subcatalog_id)}/statistics").get
+            ::Io::Flow::V0::Models::SubcatalogStatistics.new(r)
+          end
+
           # Provides visibility into recent changes of each object, including deletion
           def get_versions(organization, incoming={})
             HttpClient::Preconditions.assert_class('organization', organization, String)
@@ -943,7 +951,6 @@ module Io
             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) }),
-              :key => (x = opts.delete(:key); x.nil? ? nil : HttpClient::Preconditions.assert_class('key', x, Array).map { |v| HttpClient::Preconditions.assert_class('key', v, String) }),
               :subcatalog => (x = opts.delete(:subcatalog); x.nil? ? nil : HttpClient::Preconditions.assert_class('subcatalog', x, 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),
@@ -962,27 +969,18 @@ module Io
           end
 
           # Returns information about a specific function.
-          def get_by_key(organization, key)
-            HttpClient::Preconditions.assert_class('organization', organization, String)
-            HttpClient::Preconditions.assert_class('key', key, String)
-            r = @client.request("/#{CGI.escape(organization)}/functions/#{CGI.escape(key)}").get
-            ::Io::Flow::V0::Models::Function.new(r)
-          end
-
-          # Update function with the specified key, creating if it does not exist.
-          def put_by_key(organization, key, function_form)
+          def get_by_id(organization, id)
             HttpClient::Preconditions.assert_class('organization', organization, String)
-            HttpClient::Preconditions.assert_class('key', key, String)
-            HttpClient::Preconditions.assert_class('function_form', function_form, ::Io::Flow::V0::Models::FunctionForm)
-            r = @client.request("/#{CGI.escape(organization)}/functions/#{CGI.escape(key)}").with_json(function_form.to_json).put
+            HttpClient::Preconditions.assert_class('id', id, String)
+            r = @client.request("/#{CGI.escape(organization)}/functions/#{CGI.escape(id)}").get
             ::Io::Flow::V0::Models::Function.new(r)
           end
 
-          # Delete the function with this key
-          def delete_by_key(organization, key)
+          # Delete the function with this id
+          def delete_by_id(organization, id)
             HttpClient::Preconditions.assert_class('organization', organization, String)
-            HttpClient::Preconditions.assert_class('key', key, String)
-            r = @client.request("/#{CGI.escape(organization)}/functions/#{CGI.escape(key)}").delete
+            HttpClient::Preconditions.assert_class('id', id, String)
+            r = @client.request("/#{CGI.escape(organization)}/functions/#{CGI.escape(id)}").delete
             nil
           end
 
@@ -992,8 +990,6 @@ module Io
             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) }),
-              :key => (x = opts.delete(:key); x.nil? ? nil : HttpClient::Preconditions.assert_class('key', x, Array).map { |v| HttpClient::Preconditions.assert_class('key', v, String) }),
-              :name => (x = opts.delete(:name); x.nil? ? nil : HttpClient::Preconditions.assert_class('name', x, Array).map { |v| HttpClient::Preconditions.assert_class('name', 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? ? "journal_timestamp" : x), String)
@@ -1860,7 +1856,7 @@ module Io
             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) }),
               :center => (x = opts.delete(:center); x.nil? ? nil : HttpClient::Preconditions.assert_class('center', x, Array).map { |v| HttpClient::Preconditions.assert_class('center', v, String) }),
-              :item => (x = opts.delete(:item); x.nil? ? nil : HttpClient::Preconditions.assert_class('item', x, Array).map { |v| HttpClient::Preconditions.assert_class('item', v, String) }),
+              :item_number => (x = opts.delete(:item_number); x.nil? ? nil : HttpClient::Preconditions.assert_class('item_number', x, Array).map { |v| HttpClient::Preconditions.assert_class('item_number', 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)
@@ -1904,7 +1900,7 @@ module Io
             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) }),
               :center => (x = opts.delete(:center); x.nil? ? nil : HttpClient::Preconditions.assert_class('center', x, Array).map { |v| HttpClient::Preconditions.assert_class('center', v, String) }),
-              :item => (x = opts.delete(:item); x.nil? ? nil : HttpClient::Preconditions.assert_class('item', x, Array).map { |v| HttpClient::Preconditions.assert_class('item', v, String) }),
+              :item_number => (x = opts.delete(:item_number); x.nil? ? nil : HttpClient::Preconditions.assert_class('item_number', x, Array).map { |v| HttpClient::Preconditions.assert_class('item_number', 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)
@@ -6305,6 +6301,36 @@ module Io
 
         end
 
+        # Statistics covering product catalog item information, including total catalog
+        # item count, number of distinct categories, etc.
+        class CatalogStatistics
+
+          attr_reader :number_items, :number_categories
+
+          def initialize(incoming={})
+            opts = HttpClient::Helper.symbolize_keys(incoming)
+            HttpClient::Preconditions.require_keys(opts, [:number_items, :number_categories], 'CatalogStatistics')
+            @number_items = HttpClient::Preconditions.assert_class('number_items', opts.delete(:number_items), Integer)
+            @number_categories = HttpClient::Preconditions.assert_class('number_categories', opts.delete(:number_categories), Integer)
+          end
+
+          def to_json
+            JSON.dump(to_hash)
+          end
+
+          def copy(incoming={})
+            CatalogStatistics.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+          end
+
+          def to_hash
+            {
+              :number_items => number_items,
+              :number_categories => number_categories
+            }
+          end
+
+        end
+
         class CatalogVersion
 
           attr_reader :id, :timestamp, :type, :catalog
@@ -7678,20 +7704,20 @@ module Io
         # functions if needed.
         class Function < ExpandableFunction
 
-          attr_reader :id, :subcatalog_id, :key, :name, :position, :presets, :code, :q
+          attr_reader :id, :subcatalog_id, :name, :position, :adjustments, :levies, :code, :q
 
           def initialize(incoming={})
             super(:name => ExpandableFunction::Types::FUNCTION)
             opts = HttpClient::Helper.symbolize_keys(incoming)
-            HttpClient::Preconditions.require_keys(opts, [:id, :subcatalog_id, :key, :name, :position, :presets, :code], 'Function')
+            HttpClient::Preconditions.require_keys(opts, [:id, :subcatalog_id, :name, :position, :adjustments, :levies, :code, :q], 'Function')
             @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
             @subcatalog_id = HttpClient::Preconditions.assert_class('subcatalog_id', opts.delete(:subcatalog_id), String)
-            @key = HttpClient::Preconditions.assert_class('key', opts.delete(:key), String)
             @name = HttpClient::Preconditions.assert_class('name', opts.delete(:name), String)
             @position = HttpClient::Preconditions.assert_class('position', opts.delete(:position), Integer)
-            @presets = (x = opts.delete(:presets); x.is_a?(::Io::Flow::V0::Models::Presets) ? x : ::Io::Flow::V0::Models::Presets.new(x))
+            @adjustments = HttpClient::Preconditions.assert_class('adjustments', opts.delete(:adjustments), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::Adjustment) ? x : ::Io::Flow::V0::Models::Adjustment.from_json(x)) }
+            @levies = HttpClient::Preconditions.assert_class('levies', opts.delete(:levies), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::Levy) ? x : ::Io::Flow::V0::Models::Levy.apply(x)) }
             @code = HttpClient::Preconditions.assert_class('code', opts.delete(:code), String)
-            @q = (x = opts.delete(:q); x.nil? ? nil : HttpClient::Preconditions.assert_class('q', x, String))
+            @q = HttpClient::Preconditions.assert_class('q', opts.delete(:q), String)
           end
 
           def to_json
@@ -7706,10 +7732,10 @@ module Io
             {
               :id => id,
               :subcatalog_id => subcatalog_id,
-              :key => key,
               :name => name,
               :position => position,
-              :presets => presets.to_hash,
+              :adjustments => adjustments.map { |o| o.to_hash },
+              :levies => levies.map { |o| o.value },
               :code => code,
               :q => q
             }
@@ -7728,17 +7754,18 @@ module Io
         # functions if needed.
         class FunctionForm
 
-          attr_reader :name, :subcatalog_id, :q, :presets, :code, :position
+          attr_reader :name, :subcatalog_id, :q, :adjustments, :levies, :code, :position
 
           def initialize(incoming={})
             opts = HttpClient::Helper.symbolize_keys(incoming)
-            HttpClient::Preconditions.require_keys(opts, [:name, :subcatalog_id, :position], 'FunctionForm')
+            HttpClient::Preconditions.require_keys(opts, [:name, :subcatalog_id], 'FunctionForm')
             @name = HttpClient::Preconditions.assert_class('name', opts.delete(:name), String)
             @subcatalog_id = HttpClient::Preconditions.assert_class('subcatalog_id', opts.delete(:subcatalog_id), String)
             @q = (x = opts.delete(:q); x.nil? ? nil : HttpClient::Preconditions.assert_class('q', x, String))
-            @presets = (x = opts.delete(:presets); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::Presets) ? x : ::Io::Flow::V0::Models::Presets.new(x)))
+            @adjustments = (x = opts.delete(:adjustments); x.nil? ? nil : HttpClient::Preconditions.assert_class('adjustments', x, Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::Adjustment) ? x : ::Io::Flow::V0::Models::Adjustment.from_json(x)) })
+            @levies = (x = opts.delete(:levies); x.nil? ? nil : HttpClient::Preconditions.assert_class('levies', x, Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::Levy) ? x : ::Io::Flow::V0::Models::Levy.apply(x)) })
             @code = (x = opts.delete(:code); x.nil? ? nil : HttpClient::Preconditions.assert_class('code', x, String))
-            @position = HttpClient::Preconditions.assert_class('position', opts.delete(:position), Integer)
+            @position = (x = opts.delete(:position); x.nil? ? nil : HttpClient::Preconditions.assert_class('position', x, Integer))
           end
 
           def to_json
@@ -7754,7 +7781,8 @@ module Io
               :name => name,
               :subcatalog_id => subcatalog_id,
               :q => q,
-              :presets => presets.nil? ? nil : presets.to_hash,
+              :adjustments => adjustments.nil? ? nil : adjustments.map { |o| o.to_hash },
+              :levies => levies.nil? ? nil : levies.map { |o| o.value },
               :code => code,
               :position => position
             }
@@ -8856,14 +8884,14 @@ module Io
         # not been previously created, a new row is created for the center/item tuple.
         class InventoryUpdateForm
 
-          attr_reader :center, :idempotency_key, :item, :quantity, :type, :notes
+          attr_reader :center, :idempotency_key, :item_number, :quantity, :type, :notes
 
           def initialize(incoming={})
             opts = HttpClient::Helper.symbolize_keys(incoming)
-            HttpClient::Preconditions.require_keys(opts, [:center, :idempotency_key, :item, :quantity, :type], 'InventoryUpdateForm')
+            HttpClient::Preconditions.require_keys(opts, [:center, :idempotency_key, :item_number, :quantity, :type], 'InventoryUpdateForm')
             @center = HttpClient::Preconditions.assert_class('center', opts.delete(:center), String)
             @idempotency_key = HttpClient::Preconditions.assert_class('idempotency_key', opts.delete(:idempotency_key), String)
-            @item = HttpClient::Preconditions.assert_class('item', opts.delete(:item), String)
+            @item_number = HttpClient::Preconditions.assert_class('item_number', opts.delete(:item_number), String)
             @quantity = HttpClient::Preconditions.assert_class('quantity', opts.delete(:quantity), Integer)
             @type = (x = opts.delete(:type); x.is_a?(::Io::Flow::V0::Models::UpdateType) ? x : ::Io::Flow::V0::Models::UpdateType.apply(x))
             @notes = (x = opts.delete(:notes); x.nil? ? nil : HttpClient::Preconditions.assert_class('notes', HttpClient::Helper.to_object(x), Hash))
@@ -8881,7 +8909,7 @@ module Io
             {
               :center => center,
               :idempotency_key => idempotency_key,
-              :item => item,
+              :item_number => item_number,
               :quantity => quantity,
               :type => type.value,
               :notes => notes
@@ -10525,34 +10553,6 @@ module Io
 
         end
 
-        # Presentation for UI that is used to generate a localized price function
-        class Presets
-
-          attr_reader :adjustments, :levies
-
-          def initialize(incoming={})
-            opts = HttpClient::Helper.symbolize_keys(incoming)
-            @adjustments = HttpClient::Preconditions.assert_class('adjustments', (x = opts.delete(:adjustments); x.nil? ? [] : x), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::Adjustment) ? x : ::Io::Flow::V0::Models::Adjustment.from_json(x)) }
-            @levies = HttpClient::Preconditions.assert_class('levies', (x = opts.delete(:levies); x.nil? ? [] : x), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::Levy) ? x : ::Io::Flow::V0::Models::Levy.apply(x)) }
-          end
-
-          def to_json
-            JSON.dump(to_hash)
-          end
-
-          def copy(incoming={})
-            Presets.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
-          end
-
-          def to_hash
-            {
-              :adjustments => adjustments.map { |o| o.to_hash },
-              :levies => levies.map { |o| o.value }
-            }
-          end
-
-        end
-
         # Represents an amount-currency pair for a basic price
         class Price
 
@@ -11773,6 +11773,42 @@ module Io
 
         end
 
+        # Statistics related to the items in this subcatalog, including item count,
+        # number of distinct categories, etc.
+        class SubcatalogStatistics
+
+          attr_reader :number_items, :number_categories, :number_additions_queued, :number_updates_queued, :catalog
+
+          def initialize(incoming={})
+            opts = HttpClient::Helper.symbolize_keys(incoming)
+            HttpClient::Preconditions.require_keys(opts, [:number_items, :number_categories, :number_additions_queued, :number_updates_queued, :catalog], 'SubcatalogStatistics')
+            @number_items = HttpClient::Preconditions.assert_class('number_items', opts.delete(:number_items), Integer)
+            @number_categories = HttpClient::Preconditions.assert_class('number_categories', opts.delete(:number_categories), Integer)
+            @number_additions_queued = HttpClient::Preconditions.assert_class('number_additions_queued', opts.delete(:number_additions_queued), Integer)
+            @number_updates_queued = HttpClient::Preconditions.assert_class('number_updates_queued', opts.delete(:number_updates_queued), Integer)
+            @catalog = (x = opts.delete(:catalog); x.is_a?(::Io::Flow::V0::Models::CatalogStatistics) ? x : ::Io::Flow::V0::Models::CatalogStatistics.new(x))
+          end
+
+          def to_json
+            JSON.dump(to_hash)
+          end
+
+          def copy(incoming={})
+            SubcatalogStatistics.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
+          end
+
+          def to_hash
+            {
+              :number_items => number_items,
+              :number_categories => number_categories,
+              :number_additions_queued => number_additions_queued,
+              :number_updates_queued => number_updates_queued,
+              :catalog => catalog.to_hash
+            }
+          end
+
+        end
+
         class SubcatalogVersion
 
           attr_reader :id, :timestamp, :type, :subcatalog

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flowcommerce
 version: !ruby/object:Gem::Version
-  version: 0.0.22
+  version: 0.0.23
 platform: ruby
 authors:
 - Flow Commerce, Inc.