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.



2290
2291
2292
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2290

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



2348
2349
2350
2351
2352
2353
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2348

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

#delete_exclusions_by_subcatalog_id_and_number(organization, subcatalog_id, number) ⇒ Object

Delete an exclusion with this catalog item number



2407
2408
2409
2410
2411
2412
2413
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2407

def delete_exclusions_by_subcatalog_id_and_number(organization, subcatalog_id, number)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('subcatalog_id', subcatalog_id, String)
  HttpClient::Preconditions.assert_class('number', number, String)
  r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs/#{CGI.escape(subcatalog_id)}/exclusions/#{CGI.escape(number)}").delete
  nil
end

#delete_inclusions_by_subcatalog_id_and_number(organization, subcatalog_id, number) ⇒ Object

Delete an inclusion with this catalog item number



2450
2451
2452
2453
2454
2455
2456
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2450

def delete_inclusions_by_subcatalog_id_and_number(organization, subcatalog_id, number)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('subcatalog_id', subcatalog_id, String)
  HttpClient::Preconditions.assert_class('number', number, String)
  r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs/#{CGI.escape(subcatalog_id)}/inclusions/#{CGI.escape(number)}").delete
  nil
end

#delete_queries_by_subcatalog_id_and_id(organization, subcatalog_id, id) ⇒ Object

Delete a query with this id



2493
2494
2495
2496
2497
2498
2499
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2493

def delete_queries_by_subcatalog_id_and_id(organization, subcatalog_id, id)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('subcatalog_id', subcatalog_id, String)
  HttpClient::Preconditions.assert_class('id', id, String)
  r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs/#{CGI.escape(subcatalog_id)}/queries/#{CGI.escape(id)}").delete
  nil
end

#get(organization, incoming = {}) ⇒ Object

Search subcatalogs. Always paginated.



2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2295

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.



2331
2332
2333
2334
2335
2336
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2331

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_exclusions_by_subcatalog_id(organization, subcatalog_id, incoming = {}) ⇒ Object

Search exclusions. Always paginated.



2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2373

def get_exclusions_by_subcatalog_id(organization, subcatalog_id, incoming={})
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('subcatalog_id', subcatalog_id, 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/subcatalogs/#{CGI.escape(subcatalog_id)}/exclusions").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::Item.new(x) }
end

#get_exclusions_by_subcatalog_id_and_number(organization, subcatalog_id, number) ⇒ Object

Returns information about a specific exclusion by catalog item number.



2389
2390
2391
2392
2393
2394
2395
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2389

def get_exclusions_by_subcatalog_id_and_number(organization, subcatalog_id, number)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('subcatalog_id', subcatalog_id, String)
  HttpClient::Preconditions.assert_class('number', number, String)
  r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs/#{CGI.escape(subcatalog_id)}/exclusions/#{CGI.escape(number)}").get
  ::Io::Flow::V0::Models::Item.new(r)
end

#get_inclusions_by_subcatalog_id(organization, subcatalog_id, incoming = {}) ⇒ Object

Search inclusions. Always paginated.



2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2416

def get_inclusions_by_subcatalog_id(organization, subcatalog_id, incoming={})
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('subcatalog_id', subcatalog_id, 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/subcatalogs/#{CGI.escape(subcatalog_id)}/inclusions").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::Item.new(x) }
end

#get_inclusions_by_subcatalog_id_and_number(organization, subcatalog_id, number) ⇒ Object

Returns information about a specific inclusion by catalog item number.



2432
2433
2434
2435
2436
2437
2438
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2432

def get_inclusions_by_subcatalog_id_and_number(organization, subcatalog_id, number)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('subcatalog_id', subcatalog_id, String)
  HttpClient::Preconditions.assert_class('number', number, String)
  r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs/#{CGI.escape(subcatalog_id)}/inclusions/#{CGI.escape(number)}").get
  ::Io::Flow::V0::Models::Item.new(r)
end

#get_queries_by_subcatalog_id(organization, subcatalog_id, incoming = {}) ⇒ Object

Search queries. Always paginated.



2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2459

def get_queries_by_subcatalog_id(organization, subcatalog_id, incoming={})
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('subcatalog_id', subcatalog_id, 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) }),
    :type => (x = opts.delete(:type); x.nil? ? nil : HttpClient::Preconditions.assert_class('type', x, Array).map { |v| HttpClient::Preconditions.assert_class('type', 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/#{CGI.escape(subcatalog_id)}/queries").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::SubcatalogQuery.new(x) }
end

#get_queries_by_subcatalog_id_and_id(organization, subcatalog_id, id) ⇒ Object

Returns information about a specific query.



2484
2485
2486
2487
2488
2489
2490
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2484

def get_queries_by_subcatalog_id_and_id(organization, subcatalog_id, id)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('subcatalog_id', subcatalog_id, String)
  HttpClient::Preconditions.assert_class('id', id, String)
  r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs/#{CGI.escape(subcatalog_id)}/queries/#{CGI.escape(id)}").get
  ::Io::Flow::V0::Models::SubcatalogQuery.new(r)
end

#get_settings_by_id(organization, id) ⇒ Object

Returns information about a specific subcatalog’s settings.



2356
2357
2358
2359
2360
2361
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2356

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



2502
2503
2504
2505
2506
2507
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2502

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



2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2317

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



2309
2310
2311
2312
2313
2314
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2309

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

#post_queries_by_subcatalog_id(organization, subcatalog_id, subcatalog_query_form) ⇒ Object

Add query



2475
2476
2477
2478
2479
2480
2481
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2475

def post_queries_by_subcatalog_id(organization, subcatalog_id, subcatalog_query_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('subcatalog_id', subcatalog_id, String)
  (x = subcatalog_query_form; x.is_a?(::Io::Flow::V0::Models::SubcatalogQueryForm) ? x : ::Io::Flow::V0::Models::SubcatalogQueryForm.new(x))
  r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs/#{CGI.escape(subcatalog_id)}/queries").with_json(subcatalog_query_form.to_json).post
  ::Io::Flow::V0::Models::SubcatalogQuery.new(r)
end

#put_by_id(organization, id, subcatalog_form) ⇒ Object

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



2339
2340
2341
2342
2343
2344
2345
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2339

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_exclusions_by_subcatalog_id_and_number(organization, subcatalog_id, number) ⇒ Object

Add exclusion



2398
2399
2400
2401
2402
2403
2404
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2398

def put_exclusions_by_subcatalog_id_and_number(organization, subcatalog_id, number)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('subcatalog_id', subcatalog_id, String)
  HttpClient::Preconditions.assert_class('number', number, String)
  r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs/#{CGI.escape(subcatalog_id)}/exclusions/#{CGI.escape(number)}").put
  ::Io::Flow::V0::Models::Item.new(r)
end

#put_inclusions_by_subcatalog_id_and_number(organization, subcatalog_id, number) ⇒ Object

Add inclusion



2441
2442
2443
2444
2445
2446
2447
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2441

def put_inclusions_by_subcatalog_id_and_number(organization, subcatalog_id, number)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  HttpClient::Preconditions.assert_class('subcatalog_id', subcatalog_id, String)
  HttpClient::Preconditions.assert_class('number', number, String)
  r = @client.request("/#{CGI.escape(organization)}/catalog/subcatalogs/#{CGI.escape(subcatalog_id)}/inclusions/#{CGI.escape(number)}").put
  ::Io::Flow::V0::Models::Item.new(r)
end

#put_settings_by_id(organization, id, subcatalog_settings_form) ⇒ Object

Update subcatalog settings for the specified subcatalog.



2364
2365
2366
2367
2368
2369
2370
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2364

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