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.



2498
2499
2500
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2498

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



2556
2557
2558
2559
2560
2561
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2556

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.



2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2503

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.



2539
2540
2541
2542
2543
2544
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2539

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.



2564
2565
2566
2567
2568
2569
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2564

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



2581
2582
2583
2584
2585
2586
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2581

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



2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2525

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



2517
2518
2519
2520
2521
2522
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2517

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.



2547
2548
2549
2550
2551
2552
2553
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2547

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.



2572
2573
2574
2575
2576
2577
2578
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2572

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