Class: Io::Flow::V0::Models::ExportForm

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

Overview

Export forms are used to create exports. The export type defines both the type of the export (e.g. the CSV File format) and the available parameters for each export (e.g. the filters to apply to select the desired data).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(incoming = {}) ⇒ ExportForm

Returns a new instance of ExportForm.



10952
10953
10954
10955
10956
10957
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10952

def initialize(incoming={})
  opts = HttpClient::Helper.symbolize_keys(incoming)
  HttpClient::Preconditions.require_keys(opts, [:type], 'ExportForm')
  @type = (x = opts.delete(:type); x.is_a?(::Io::Flow::V0::Models::ExportType) ? x : ::Io::Flow::V0::Models::ExportType.from_json(x))
  @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.



10950
10951
10952
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10950

def emails
  @emails
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



10950
10951
10952
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10950

def type
  @type
end

Instance Method Details

#copy(incoming = {}) ⇒ Object 



10963
10964
10965
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10963

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

#to_hash ⇒ Object 



10967
10968
10969
10970
10971
10972
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10967

def to_hash
  {
    :type => type.to_hash,
    :emails => emails.nil? ? nil : emails
  }
end

#to_json ⇒ Object 



10959
10960
10961
 
# File 'lib/flow_commerce/flow_api_v0_client.rb', line 10959

def to_json
  JSON.dump(to_hash)
end