Class: Io::Flow::V0::Clients::Subcatalogs

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Subcatalogs

Returns a new instance of Subcatalogs.



2917
2918
2919
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2917

def initialize(client)
  @client = HttpClient::Preconditions.assert_class('client', client, ::Io::Flow::V0::Client)
end

Instance Method Details

#delete_by_id(organization, id) ⇒ Object

Delete the subcatalog with this id



2975
2976
2977
2978
2979
2980
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2975

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 = {}) ⇒ Object

Search subcatalogs. Always paginated.



2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2922

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) ⇒ Object

Returns information about a specific subcatalog.



2958
2959
2960
2961
2962
2963
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2958

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) ⇒ Object

Returns information about a specific subcatalog’s settings.



2983
2984
2985
2986
2987
2988
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2983

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) ⇒ Object

Get statistics for the specified subcatalog



3000
3001
3002
3003
3004
3005
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 3000

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 = {}) ⇒ Object

Provides visibility into recent changes of each object, including deletion



2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2944

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) ⇒ Object

Add subcatalog



2936
2937
2938
2939
2940
2941
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2936

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) ⇒ Object

Update subcatalog with the specified id, creating if it does not exist.



2966
2967
2968
2969
2970
2971
2972
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2966

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) ⇒ Object

Update subcatalog settings for the specified subcatalog.



2991
2992
2993
2994
2995
2996
2997
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2991

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