Class: Io::Flow::V0::Models::Export

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

Overview

Exports represent data extraction requests (e.g. download my catalog items to a CSV file)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ Export 



18400
18401
18402
18403
18404
18405
18406
18407
18408
18409
18410
18411
18412
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18400

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:id, :type, :status, :organization_q, :created_at, :deliveries], 'Export')
  @id = HttpClient::Preconditions.assert_class('id', opts.delete(:id), String)
  @type = (x = opts.delete(:type); x.is_a?(::Io::Flow::V0::Models::ExportType) ? x : ::Io::Flow::V0::Models::ExportType.from_json(x))
  @status = (x = opts.delete(:status); x.is_a?(::Io::Flow::V0::Models::ExportStatus) ? x : ::Io::Flow::V0::Models::ExportStatus.apply(x))
  @organization_q = HttpClient::Preconditions.assert_class('organization_q', opts.delete(:organization_q), String)
  @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))
  @url = (x = opts.delete(:url); x.nil? ? nil : HttpClient::Preconditions.assert_class('url', x, String))
  @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.



18398
18399
18400
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18398

def completed_at
  @completed_at
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



18398
18399
18400
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18398

def created_at
  @created_at
end

#deliveries ⇒ Object (readonly)

Returns the value of attribute deliveries.



18398
18399
18400
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18398

def deliveries
  @deliveries
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



18398
18399
18400
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18398

def id
  @id
end

#organization_q ⇒ Object (readonly)

Returns the value of attribute organization_q.



18398
18399
18400
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18398

def organization_q
  @organization_q
end

#started_at ⇒ Object (readonly)

Returns the value of attribute started_at.



18398
18399
18400
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18398

def started_at
  @started_at
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



18398
18399
18400
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18398

def status
  @status
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



18398
18399
18400
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18398

def type
  @type
end

#url ⇒ Object (readonly)

Returns the value of attribute url.



18398
18399
18400
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18398

def url
  @url
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



18418
18419
18420
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18418

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

#to_hash ⇒ Object 



18422
18423
18424
18425
18426
18427
18428
18429
18430
18431
18432
18433
18434
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18422

def to_hash
  {
    :id => id,
    :type => type.to_hash,
    :status => status.value,
    :organization_q => organization_q,
    :created_at => created_at,
    :started_at => started_at,
    :completed_at => completed_at,
    :url => url,
    :deliveries => deliveries.map { |o| o.to_hash }
  }
end

#to_json ⇒ Object 



18414
18415
18416
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 18414

def to_json
  JSON.dump(to_hash)
end