Class: Io::Flow::V0::Clients::Exports

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Exports

Returns a new instance of Exports.



4534
4535
4536
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4534

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

Instance Method Details

#delete_by_id(organization, id) ⇒ Object 



4570
4571
4572
4573
4574
4575
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4570

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)}/exports/#{CGI.escape(id)}").delete
  nil
end

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

Search exports. Always paginated.



4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4539

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) }),
    :created_by_user_id => (x = opts.delete(:created_by_user_id); x.nil? ? nil : HttpClient::Preconditions.assert_class('created_by_user_id', x, String)),
    :discriminator => (x = opts.delete(:discriminator); x.nil? ? nil : HttpClient::Preconditions.assert_class('discriminator', x, 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)}/exports").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::Export.new(x) }
end

#get_by_id(organization, id) ⇒ Object

Get a single export.



4563
4564
4565
4566
4567
4568
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4563

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)}/exports/#{CGI.escape(id)}").get
  ::Io::Flow::V0::Models::Export.new(r)
end

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

Provides visibility into recent changes of each export, including deletion.



4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4578

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) }),
    :export_id => (x = opts.delete(:export_id); x.nil? ? nil : HttpClient::Preconditions.assert_class('export_id', x, Array).map { |v| HttpClient::Preconditions.assert_class('export_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)}/exports/versions").with_query(query).get
  r.map { |x| ::Io::Flow::V0::Models::ExportVersion.new(x) }
end

#post(organization, export_form) ⇒ Object

Create an export.



4555
4556
4557
4558
4559
4560
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4555

def post(organization, export_form)
  HttpClient::Preconditions.assert_class('organization', organization, String)
  (x = export_form; x.is_a?(::Io::Flow::V0::Models::ExportForm) ? x : ::Io::Flow::V0::Models::ExportForm.new(x))
  r = @client.request("/#{CGI.escape(organization)}/exports").with_json(export_form.to_json).post
  ::Io::Flow::V0::Models::Export.new(r)
end