Class: Io::Flow::V0::Clients::Items
- Inherits:
-
Object
- Object
- Io::Flow::V0::Clients::Items
- Defined in:
- lib/flow_commerce/flow_api_v0_client.rb
Instance Method Summary collapse
-
#delete_by_number(organization, number) ⇒ Object
Delete the item with this number.
-
#get(organization, incoming = {}) ⇒ Object
Search items.
-
#get_by_number(organization, number) ⇒ Object
Returns information about a specific item.
-
#get_versions(organization, incoming = {}) ⇒ Object
Provides visibility into recent changes of each object, including deletion.
-
#initialize(client) ⇒ Items
constructor
A new instance of Items.
-
#patch_attributes_by_number(organization, number, item_attributes_patch_form) ⇒ Object
Update item with the specified attributes.
-
#post(organization, item_form) ⇒ Object
Add catalog item(s).
-
#put_by_number(organization, number, item_form) ⇒ Object
Update item with the specified number, creating if it does not exist.
-
#put_price_by_number(organization, number, item_price_update_put_form) ⇒ Object
Update item with the specified number, creating if it does not exist.
Constructor Details
#initialize(client) ⇒ Items
Returns a new instance of Items.
1655 1656 1657 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1655 def initialize(client) @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client) end |
Instance Method Details
#delete_by_number(organization, number) ⇒ Object
Delete the item with this number
1715 1716 1717 1718 1719 1720 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1715 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 = {}) ⇒ Object
Search items. Always paginated.
1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1660 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) ⇒ Object
Returns information about a specific item.
1698 1699 1700 1701 1702 1703 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1698 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 = {}) ⇒ Object
Provides visibility into recent changes of each object, including deletion
1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1683 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) ⇒ Object
Update item with the specified attributes.
1723 1724 1725 1726 1727 1728 1729 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1723 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) ⇒ Object
Add catalog item(s)
1675 1676 1677 1678 1679 1680 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1675 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) ⇒ Object
Update item with the specified number, creating if it does not exist.
1706 1707 1708 1709 1710 1711 1712 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1706 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) ⇒ Object
Update item with the specified number, creating if it does not exist.
1732 1733 1734 1735 1736 1737 1738 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1732 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 |