class Io::Flow::V0::Clients::Items
Public Class Methods
new(client)
click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 1799 def initialize(client) @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client) end
Public Instance Methods
delete_by_number(organization, number)
click to toggle source
Delete the item with this number
# File lib/flow_commerce/flow_api_v0_client.rb, line 1859 def delete_by_number(organization, number) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('number', number, String) r = @client.request("/#{CGI.escape(organization)}/catalog/items/#{CGI.escape(number)}").delete nil end
get(organization, incoming={})
click to toggle source
Search items. Always paginated.
# File lib/flow_commerce/flow_api_v0_client.rb, line 1804 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) }), :number => (x = opts.delete(:number); x.nil? ? nil : HttpClient::Preconditions.assert_class('number', x, Array).map { |v| HttpClient::Preconditions.assert_class('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? ? "name" : x), String) }.delete_if { |k, v| v.nil? } r = @client.request("/#{CGI.escape(organization)}/catalog/items").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::Item.new(x) } end
get_by_number(organization, number)
click to toggle source
Returns
information about a specific item.
# File lib/flow_commerce/flow_api_v0_client.rb, line 1842 def get_by_number(organization, number) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('number', number, String) r = @client.request("/#{CGI.escape(organization)}/catalog/items/#{CGI.escape(number)}").get ::Io::Flow::V0::Models::Item.new(r) end
get_versions(organization, incoming={})
click to toggle source
Provides visibility into recent changes of each object, including deletion
# File lib/flow_commerce/flow_api_v0_client.rb, line 1827 def get_versions(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) }), :number => (x = opts.delete(:number); x.nil? ? nil : HttpClient::Preconditions.assert_class('number', x, Array).map { |v| HttpClient::Preconditions.assert_class('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? ? "journal_timestamp" : x), String) }.delete_if { |k, v| v.nil? } r = @client.request("/#{CGI.escape(organization)}/catalog/items/versions").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::ItemVersion.new(x) } end
patch_attributes_by_number(organization, number, item_attributes_patch_form)
click to toggle source
Update item with the specified attributes.
# File lib/flow_commerce/flow_api_v0_client.rb, line 1867 def patch_attributes_by_number(organization, number, item_attributes_patch_form) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('number', number, String) (x = item_attributes_patch_form; x.is_a?(::Io::Flow::V0::Models::ItemAttributesPatchForm) ? x : ::Io::Flow::V0::Models::ItemAttributesPatchForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/catalog/items/#{CGI.escape(number)}/attributes").with_json(item_attributes_patch_form.to_json).patch ::Io::Flow::V0::Models::Item.new(r) end
post(organization, item_form)
click to toggle source
Add catalog item(s)
# File lib/flow_commerce/flow_api_v0_client.rb, line 1819 def post(organization, item_form) HttpClient::Preconditions.assert_class('organization', organization, String) (x = item_form; x.is_a?(::Io::Flow::V0::Models::ItemForm) ? x : ::Io::Flow::V0::Models::ItemForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/catalog/items").with_json(item_form.to_json).post ::Io::Flow::V0::Models::Item.new(r) end
put_by_number(organization, number, item_form)
click to toggle source
Update item with the specified number, creating if it does not exist.
# File lib/flow_commerce/flow_api_v0_client.rb, line 1850 def put_by_number(organization, number, item_form) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('number', number, String) (x = item_form; x.is_a?(::Io::Flow::V0::Models::ItemForm) ? x : ::Io::Flow::V0::Models::ItemForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/catalog/items/#{CGI.escape(number)}").with_json(item_form.to_json).put ::Io::Flow::V0::Models::Item.new(r) end
put_price_by_number(organization, number, item_price_update_put_form)
click to toggle source
Update item with the specified number, creating if it does not exist.
# File lib/flow_commerce/flow_api_v0_client.rb, line 1876 def put_price_by_number(organization, number, item_price_update_put_form) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('number', number, String) (x = item_price_update_put_form; x.is_a?(::Io::Flow::V0::Models::ItemPriceUpdatePutForm) ? x : ::Io::Flow::V0::Models::ItemPriceUpdatePutForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/catalog/items/#{CGI.escape(number)}/price").with_json(item_price_update_put_form.to_json).put ::Io::Flow::V0::Models::Item.new(r) end