Class: Io::Flow::V0::Clients::Imports

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Imports

Returns a new instance of Imports.



4683
4684
4685
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4683

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

Instance Method Details

#delete_by_id(organization, id) ⇒ Object 



4719
4720
4721
4722
4723
4724
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4719

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

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

Search imports. Always paginated.



4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4688

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

#get_by_id(organization, id) ⇒ Object

Get a single import.



4712
4713
4714
4715
4716
4717
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4712

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

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

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



4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4727

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

#post(organization, import_form) ⇒ Object

Create an import.



4704
4705
4706
4707
4708
4709
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 4704

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