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.



2420
2421
2422
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2420

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



2478
2479
2480
2481
2482
2483
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2478

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



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

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



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

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



2623
2624
2625
2626
2627
2628
2629
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2623

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.



2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2425

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.



2461
2462
2463
2464
2465
2466
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2461

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.



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

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.



2519
2520
2521
2522
2523
2524
2525
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2519

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.



2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2546

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.



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

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.



2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2589

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.



2614
2615
2616
2617
2618
2619
2620
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2614

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.



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

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



2632
2633
2634
2635
2636
2637
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2632

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



2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2447

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



2439
2440
2441
2442
2443
2444
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2439

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



2605
2606
2607
2608
2609
2610
2611
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2605

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.



2469
2470
2471
2472
2473
2474
2475
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2469

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



2528
2529
2530
2531
2532
2533
2534
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 2528

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



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

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.



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

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