Class: Io::Flow::V0::Clients::Items

Inherits:
Object
  • Object
show all
Defined in:
lib/flow_commerce/flow_api_v0_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Items

Returns a new instance of Items.



1537
1538
1539
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1537

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



1597
1598
1599
1600
1601
1602
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1597

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.



1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1542

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.



1580
1581
1582
1583
1584
1585
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1580

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



1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1565

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.



1605
1606
1607
1608
1609
1610
1611
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1605

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)



1557
1558
1559
1560
1561
1562
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1557

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.



1588
1589
1590
1591
1592
1593
1594
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1588

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.



1614
1615
1616
1617
1618
1619
1620
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 1614

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