class Io::Flow::V0::Clients::Subcatalogs
Public Class Methods
new(client)
click to toggle source
# File lib/flow_commerce/flow_api_v0_client.rb, line 2998 def initialize(client) @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client) end
Public Instance Methods
delete_by_id(organization, id)
click to toggle source
Delete the subcatalog with this id
# File lib/flow_commerce/flow_api_v0_client.rb, line 3056 def delete_by_id(organization, id) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('id', id, String) r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs/#{CGI.escape(id)}").delete nil end
get(organization, incoming={})
click to toggle source
Search subcatalogs. Always paginated.
# File lib/flow_commerce/flow_api_v0_client.rb, line 3003 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) }), :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) }.delete_if { |k, v| v.nil? } r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::Subcatalog.new(x) } end
get_by_id(organization, id)
click to toggle source
Returns
information about a specific subcatalog.
# File lib/flow_commerce/flow_api_v0_client.rb, line 3039 def get_by_id(organization, id) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('id', id, String) r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs/#{CGI.escape(id)}").get ::Io::Flow::V0::Models::Subcatalog.new(r) end
get_settings_by_id(organization, id)
click to toggle source
Returns
information about a specific subcatalog’s settings.
# File lib/flow_commerce/flow_api_v0_client.rb, line 3064 def get_settings_by_id(organization, id) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('id', id, String) r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs/#{CGI.escape(id)}/settings").get ::Io::Flow::V0::Models::SubcatalogSettings.new(r) end
get_statistics_by_subcatalog_id(organization, subcatalog_id)
click to toggle source
Get statistics for the specified subcatalog
# File lib/flow_commerce/flow_api_v0_client.rb, line 3081 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
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 3025 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) }), :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/subcatalogs/versions").with_query(query).get r.map { |x| ::Io::Flow::V0::Models::SubcatalogVersion.new(x) } end
post(organization, subcatalog_form)
click to toggle source
Add subcatalog
# File lib/flow_commerce/flow_api_v0_client.rb, line 3017 def post(organization, subcatalog_form) HttpClient::Preconditions.assert_class('organization', organization, String) (x = subcatalog_form; x.is_a?(::Io::Flow::V0::Models::SubcatalogForm) ? x : ::Io::Flow::V0::Models::SubcatalogForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs").with_json(subcatalog_form.to_json).post ::Io::Flow::V0::Models::Subcatalog.new(r) end
put_by_id(organization, id, subcatalog_form)
click to toggle source
Update subcatalog with the specified id, creating if it does not exist.
# File lib/flow_commerce/flow_api_v0_client.rb, line 3047 def put_by_id(organization, id, subcatalog_form) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('id', id, String) (x = subcatalog_form; x.is_a?(::Io::Flow::V0::Models::SubcatalogForm) ? x : ::Io::Flow::V0::Models::SubcatalogForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs/#{CGI.escape(id)}").with_json(subcatalog_form.to_json).put ::Io::Flow::V0::Models::Subcatalog.new(r) end
put_settings_by_id(organization, id, subcatalog_settings_form)
click to toggle source
Update subcatalog settings for the specified subcatalog.
# File lib/flow_commerce/flow_api_v0_client.rb, line 3072 def put_settings_by_id(organization, id, subcatalog_settings_form) HttpClient::Preconditions.assert_class('organization', organization, String) HttpClient::Preconditions.assert_class('id', id, String) (x = subcatalog_settings_form; x.is_a?(::Io::Flow::V0::Models::SubcatalogSettingsForm) ? x : ::Io::Flow::V0::Models::SubcatalogSettingsForm.new(x)) r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs/#{CGI.escape(id)}/settings").with_json(subcatalog_settings_form.to_json).put ::Io::Flow::V0::Models::SubcatalogSettings.new(r) end