Class: MailSlurpClient::ExportTransformerOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/models/export_transformer_options.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExportTransformerOptions

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 131

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::ExportTransformerOptions` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::ExportTransformerOptions`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'ai_transform_id')
    self.ai_transform_id = attributes[:'ai_transform_id']
  end

  if attributes.key?(:'ai_mapping_id')
    self.ai_mapping_id = attributes[:'ai_mapping_id']
  end

  if attributes.key?(:'flatten_arrays')
    self.flatten_arrays = attributes[:'flatten_arrays']
  end

  if attributes.key?(:'since')
    self.since = attributes[:'since']
  end

  if attributes.key?(:'before')
    self.before = attributes[:'before']
  end

  if attributes.key?(:'format')
    self.format = attributes[:'format']
  end

  if attributes.key?(:'inbox_id')
    self.inbox_id = attributes[:'inbox_id']
  end

  if attributes.key?(:'phone_id')
    self.phone_id = attributes[:'phone_id']
  end

  if attributes.key?(:'email_id')
    self.email_id = attributes[:'email_id']
  end

  if attributes.key?(:'sms_id')
    self.sms_id = attributes[:'sms_id']
  end

  if attributes.key?(:'attachment_id')
    self.attachment_id = attributes[:'attachment_id']
  end

  if attributes.key?(:'include_meta_data')
    self.include_meta_data = attributes[:'include_meta_data']
  end

  if attributes.key?(:'delimiter')
    self.delimiter = attributes[:'delimiter']
  end

  if attributes.key?(:'array_separator')
    self.array_separator = attributes[:'array_separator']
  end

  if attributes.key?(:'include_meta_data_columns')
    if (value = attributes[:'include_meta_data_columns']).is_a?(Array)
      self.include_meta_data_columns = value
    end
  end
end

Instance Attribute Details

#ai_mapping_id ⇒ Object

Returns the value of attribute ai_mapping_id.



19
20
21
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 19

def ai_mapping_id
  @ai_mapping_id
end

#ai_transform_id ⇒ Object

Returns the value of attribute ai_transform_id.



17
18
19
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 17

def ai_transform_id
  @ai_transform_id
end

#array_separator ⇒ Object

Returns the value of attribute array_separator.



43
44
45
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 43

def array_separator
  @array_separator
end

#attachment_id ⇒ Object

Returns the value of attribute attachment_id.



37
38
39
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 37

def attachment_id
  @attachment_id
end

#before ⇒ Object

Returns the value of attribute before.



25
26
27
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 25

def before
  @before
end

#delimiter ⇒ Object

Returns the value of attribute delimiter.



41
42
43
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 41

def delimiter
  @delimiter
end

#email_id ⇒ Object

Returns the value of attribute email_id.



33
34
35
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 33

def email_id
  @email_id
end

#flatten_arrays ⇒ Object

Returns the value of attribute flatten_arrays.



21
22
23
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 21

def flatten_arrays
  @flatten_arrays
end

#format ⇒ Object

Returns the value of attribute format.



27
28
29
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 27

def format
  @format
end

#inbox_id ⇒ Object

Returns the value of attribute inbox_id.



29
30
31
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 29

def inbox_id
  @inbox_id
end

#include_meta_data ⇒ Object

Returns the value of attribute include_meta_data.



39
40
41
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 39

def include_meta_data
  @include_meta_data
end

#include_meta_data_columns ⇒ Object

Returns the value of attribute include_meta_data_columns.



45
46
47
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 45

def include_meta_data_columns
  @include_meta_data_columns
end

#phone_id ⇒ Object

Returns the value of attribute phone_id.



31
32
33
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 31

def phone_id
  @phone_id
end

#since ⇒ Object

Returns the value of attribute since.



23
24
25
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 23

def since
  @since
end

#sms_id ⇒ Object

Returns the value of attribute sms_id.



35
36
37
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 35

def sms_id
  @sms_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 70

def self.attribute_map
  {
    :'ai_transform_id' => :'aiTransformId',
    :'ai_mapping_id' => :'aiMappingId',
    :'flatten_arrays' => :'flattenArrays',
    :'since' => :'since',
    :'before' => :'before',
    :'format' => :'format',
    :'inbox_id' => :'inboxId',
    :'phone_id' => :'phoneId',
    :'email_id' => :'emailId',
    :'sms_id' => :'smsId',
    :'attachment_id' => :'attachmentId',
    :'include_meta_data' => :'includeMetaData',
    :'delimiter' => :'delimiter',
    :'array_separator' => :'arraySeparator',
    :'include_meta_data_columns' => :'includeMetaDataColumns'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



284
285
286
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 284

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 112

def self.openapi_nullable
  Set.new([
    :'ai_transform_id',
    :'ai_mapping_id',
    :'since',
    :'before',
    :'inbox_id',
    :'phone_id',
    :'email_id',
    :'sms_id',
    :'attachment_id',
    :'delimiter',
    :'array_separator',
    :'include_meta_data_columns'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 91

def self.openapi_types
  {
    :'ai_transform_id' => :'String',
    :'ai_mapping_id' => :'String',
    :'flatten_arrays' => :'Boolean',
    :'since' => :'DateTime',
    :'before' => :'DateTime',
    :'format' => :'String',
    :'inbox_id' => :'String',
    :'phone_id' => :'String',
    :'email_id' => :'String',
    :'sms_id' => :'String',
    :'attachment_id' => :'String',
    :'include_meta_data' => :'Boolean',
    :'delimiter' => :'String',
    :'array_separator' => :'String',
    :'include_meta_data_columns' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 249

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ai_transform_id == o.ai_transform_id &&
      ai_mapping_id == o.ai_mapping_id &&
      flatten_arrays == o.flatten_arrays &&
      since == o.since &&
      before == o.before &&
      format == o.format &&
      inbox_id == o.inbox_id &&
      phone_id == o.phone_id &&
      email_id == o.email_id &&
      sms_id == o.sms_id &&
      attachment_id == o.attachment_id &&
      include_meta_data == o.include_meta_data &&
      delimiter == o.delimiter &&
      array_separator == o.array_separator &&
      include_meta_data_columns == o.include_meta_data_columns
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 312

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    MailSlurpClient.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 381

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 291

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


271
272
273
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 271

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



277
278
279
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 277

def hash
  [ai_transform_id, ai_mapping_id, flatten_arrays, since, before, format, inbox_id, phone_id, email_id, sms_id, attachment_id, include_meta_data, delimiter, array_separator, include_meta_data_columns].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 209

def list_invalid_properties
  invalid_properties = Array.new
  if @flatten_arrays.nil?
    invalid_properties.push('invalid value for "flatten_arrays", flatten_arrays cannot be nil.')
  end

  if @format.nil?
    invalid_properties.push('invalid value for "format", format cannot be nil.')
  end

  if @include_meta_data.nil?
    invalid_properties.push('invalid value for "include_meta_data", include_meta_data cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



357
358
359
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 357

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 363

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



351
352
353
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 351

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



228
229
230
231
232
233
234
235
 
# File 'lib/mailslurp_client/models/export_transformer_options.rb', line 228

def valid?
  return false if @flatten_arrays.nil?
  return false if @format.nil?
  format_validator = EnumAttributeValidator.new('String', ["CSV", "EXCEL", "XML", "JSON"])
  return false unless format_validator.valid?(@format)
  return false if @include_meta_data.nil?
  true
end