class Io::Flow::V0::Clients::Catalogs

Public Class Methods

new(client) click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 909
def initialize(client)
  @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client)
end

Public Instance Methods

delete_catalog_and_restrictions_by_number(organization, number) click to toggle source

Delete the global restriction for this catalog item number

# File lib/flow_commerce/flow_api_v0_client.rb, line 952
def delete_catalog_and_restrictions_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/restrictions/#{CGI.escape(number)}").delete
  nil
end
get_catalog(organization) click to toggle source

Returns information about a specific catalog.

# File lib/flow_commerce/flow_api_v0_client.rb, line 914
def get_catalog(organization)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  r = @client.request("/#{CGI.escape(organization)}/catalog").get
  ::Io::Flow::V0::Models::Catalog.new(r)
end
get_catalog_and_restrictions(organization, incoming={}) click to toggle source

Search global restrictions. Always paginated.

# File lib/flow_commerce/flow_api_v0_client.rb, line 921
def get_catalog_and_restrictions(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/restrictions").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::Item.new(x) }
end
get_catalog_and_restrictions_by_number(organization, number) click to toggle source

Returns a specific globally restricted item.

# File lib/flow_commerce/flow_api_v0_client.rb, line 936
def get_catalog_and_restrictions_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/restrictions/#{CGI.escape(number)}").get
  ::Io::Flow::V0::Models::Item.new(r)
end
get_catalog_and_statistics(organization) click to toggle source

Get statistics for this organization’s catalog.

# File lib/flow_commerce/flow_api_v0_client.rb, line 960
def get_catalog_and_statistics(organization)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  r = @client.request("/#{CGI.escape(organization)}/catalog/statistics").get
  ::Io::Flow::V0::Models::CatalogStatistics.new(r)
end
put_catalog_and_restrictions_by_number(organization, number) click to toggle source

Upsert a global restriction

# File lib/flow_commerce/flow_api_v0_client.rb, line 944
def put_catalog_and_restrictions_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/restrictions/#{CGI.escape(number)}").put
  ::Io::Flow::V0::Models::Item.new(r)
end