Class: Io::Flow::V0::Models::ImportForm
- Inherits:
-
Object
- Object
- Io::Flow::V0::Models::ImportForm
- Defined in:
- lib/flow_commerce/flow_api_v0_client.rb
Overview
Import forms create imports. The import type defines both the type of the import (e.g. the CSV File format) and the URL at which the source data are available. If you do not have a URL readily available, you can first upload a file via the Flow API - see the resource named ‘Upload’
Instance Attribute Summary collapse
-
#emails ⇒ Object
readonly
Returns the value of attribute emails.
-
#filename ⇒ Object
readonly
Returns the value of attribute filename.
-
#source_url ⇒ Object
readonly
Returns the value of attribute source_url.
-
#type ⇒ Object
readonly
Returns the value of attribute type.
Instance Method Summary collapse
- #copy(incoming = {}) ⇒ Object
-
#initialize(incoming = {}) ⇒ ImportForm
constructor
A new instance of ImportForm.
- #to_hash ⇒ Object
- #to_json ⇒ Object
Constructor Details
#initialize(incoming = {}) ⇒ ImportForm
Returns a new instance of ImportForm.
45553 45554 45555 45556 45557 45558 45559 45560 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45553 def initialize(incoming={}) opts = HttpClient::Helper.symbolize_keys(incoming) HttpClient::Preconditions.require_keys(opts, [:type, :source_url], 'ImportForm') @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 = (x = opts.delete(:filename); x.nil? ? nil : HttpClient::Preconditions.assert_class('filename', x, String)) @emails = (x = opts.delete(:emails); x.nil? ? nil : HttpClient::Preconditions.assert_class('emails', x, Array).map { |v| HttpClient::Preconditions.assert_class('emails', v, String) }) end |
Instance Attribute Details
#emails ⇒ Object (readonly)
Returns the value of attribute emails.
45551 45552 45553 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45551 def emails @emails end |
#filename ⇒ Object (readonly)
Returns the value of attribute filename.
45551 45552 45553 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45551 def filename @filename end |
#source_url ⇒ Object (readonly)
Returns the value of attribute source_url.
45551 45552 45553 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45551 def source_url @source_url end |
#type ⇒ Object (readonly)
Returns the value of attribute type.
45551 45552 45553 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45551 def type @type end |
Instance Method Details
#copy(incoming = {}) ⇒ Object
45566 45567 45568 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45566 def copy(incoming={}) ImportForm.new(to_hash.merge(HttpClient::Helper.symbolize_keys(incoming))) end |
#to_hash ⇒ Object
45570 45571 45572 45573 45574 45575 45576 45577 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45570 def to_hash { :type => type.value, :source_url => source_url, :filename => filename, :emails => emails.nil? ? nil : emails } end |
#to_json ⇒ Object
45562 45563 45564 |
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 45562 def to_json JSON.dump(to_hash) end |