Class: Io::Flow::V0::Models::Import

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

Overview

Imports allow you to upload data to Flow via files in batch. Each import fetches data from a given URL. The type of the import determines which file format to expect and what data to update

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ Import

Returns a new instance of Import.



45439
45440
45441
45442
45443
45444
45445
45446
45447
45448
45449
45450
45451
45452
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45439

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :type, :source_url, :filename, :status, :created_at, :deliveries], 'Import')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @type = (x = opts.delete(:type); x.is_a?(::Io::Flow::V0::Models::ImportType) ? x : ::Io::Flow::V0::Models::ImportType.apply(x))
  @source_url = HttpClient::Preconditions.assert_class('source_url', opts.delete(:source_url), String)
  @filename = HttpClient::Preconditions.assert_class('filename', opts.delete(:filename), String)
  @status = (x = opts.delete(:status); x.is_a?(::Io::Flow::V0::Models::ExportStatus) ? x : ::Io::Flow::V0::Models::ExportStatus.apply(x))
  @created_at = HttpClient::Preconditions.assert_class('created_at', HttpClient::Helper.to_date_time_iso8601(opts.delete(:created_at)), DateTime)
  @started_at = (x = opts.delete(:started_at); x.nil? ? nil : HttpClient::Preconditions.assert_class('started_at', HttpClient::Helper.to_date_time_iso8601(x), DateTime))
  @completed_at = (x = opts.delete(:completed_at); x.nil? ? nil : HttpClient::Preconditions.assert_class('completed_at', HttpClient::Helper.to_date_time_iso8601(x), DateTime))
  @results = (x = opts.delete(:results); x.nil? ? nil : (x = x; x.is_a?(::Io::Flow::V0::Models::ImportResults) ? x : ::Io::Flow::V0::Models::ImportResults.new(x)))
  @deliveries = HttpClient::Preconditions.assert_class('deliveries', opts.delete(:deliveries), Array).map { |v| (x = v; x.is_a?(::Io::Flow::V0::Models::ExportDelivery) ? x : ::Io::Flow::V0::Models::ExportDelivery.from_json(x)) }
end

Instance Attribute Details

#completed_at ⇒ Object (readonly)

Returns the value of attribute completed_at.



45437
45438
45439
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45437

def completed_at
  @completed_at
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



45437
45438
45439
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45437

def created_at
  @created_at
end

#deliveries ⇒ Object (readonly)

Returns the value of attribute deliveries.



45437
45438
45439
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45437

def deliveries
  @deliveries
end

#filename ⇒ Object (readonly)

Returns the value of attribute filename.



45437
45438
45439
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45437

def filename
  @filename
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



45437
45438
45439
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45437

def id
  @id
end

#results ⇒ Object (readonly)

Returns the value of attribute results.



45437
45438
45439
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45437

def results
  @results
end

#source_url ⇒ Object (readonly)

Returns the value of attribute source_url.



45437
45438
45439
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45437

def source_url
  @source_url
end

#started_at ⇒ Object (readonly)

Returns the value of attribute started_at.



45437
45438
45439
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45437

def started_at
  @started_at
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



45437
45438
45439
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45437

def status
  @status
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



45437
45438
45439
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45437

def type
  @type
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



45458
45459
45460
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45458

def copy(incoming={})
  Import.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming)))
end

#to_hash ⇒ Object 



45462
45463
45464
45465
45466
45467
45468
45469
45470
45471
45472
45473
45474
45475
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45462

def to_hash
  {
    :id => id,
    :type => type.value,
    :source_url => source_url,
    :filename => filename,
    :status => status.value,
    :created_at => created_at,
    :started_at => started_at,
    :completed_at => completed_at,
    :results => results.nil? ? nil : results.to_hash,
    :deliveries => deliveries.map { |o| o.to_hash }
  }
end

#to_json ⇒ Object 



45454
45455
45456
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45454

def to_json
  JSON.dump(to_hash)
end