Class: DocSpring::SubmissionDataRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/docspring/models/submission_data_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubmissionDataRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash

[View source]

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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/docspring/models/submission_data_request.rb', line 166

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DocSpring::SubmissionDataRequest` 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 `DocSpring::SubmissionDataRequest`. 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?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

  if attributes.key?(:'email')
    self.email = attributes[:'email']
  else
    self.email = nil
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'order')
    self.order = attributes[:'order']
  else
    self.order = nil
  end

  if attributes.key?(:'sort_order')
    self.sort_order = attributes[:'sort_order']
  else
    self.sort_order = nil
  end

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

  if attributes.key?(:'metadata')
    self.metadata = attributes[:'metadata']
  else
    self.metadata = nil
  end

  if attributes.key?(:'state')
    self.state = attributes[:'state']
  else
    self.state = nil
  end

  if attributes.key?(:'viewed_at')
    self.viewed_at = attributes[:'viewed_at']
  else
    self.viewed_at = nil
  end

  if attributes.key?(:'completed_at')
    self.completed_at = attributes[:'completed_at']
  else
    self.completed_at = nil
  end

  if attributes.key?(:'data')
    self.data = attributes[:'data']
  else
    self.data = nil
  end

  if attributes.key?(:'auth_type')
    self.auth_type = attributes[:'auth_type']
  else
    self.auth_type = nil
  end

  if attributes.key?(:'auth_second_factor_type')
    self.auth_second_factor_type = attributes[:'auth_second_factor_type']
  else
    self.auth_second_factor_type = nil
  end

  if attributes.key?(:'auth_provider')
    self.auth_provider = attributes[:'auth_provider']
  else
    self.auth_provider = nil
  end

  if attributes.key?(:'auth_session_started_at')
    self.auth_session_started_at = attributes[:'auth_session_started_at']
  else
    self.auth_session_started_at = nil
  end

  if attributes.key?(:'auth_session_id_hash')
    self.auth_session_id_hash = attributes[:'auth_session_id_hash']
  else
    self.auth_session_id_hash = nil
  end

  if attributes.key?(:'auth_user_id_hash')
    self.auth_user_id_hash = attributes[:'auth_user_id_hash']
  else
    self.auth_user_id_hash = nil
  end

  if attributes.key?(:'auth_username_hash')
    self.auth_username_hash = attributes[:'auth_username_hash']
  else
    self.auth_username_hash = nil
  end

  if attributes.key?(:'auth_phone_number_hash')
    self.auth_phone_number_hash = attributes[:'auth_phone_number_hash']
  else
    self.auth_phone_number_hash = nil
  end

  if attributes.key?(:'ip_address')
    self.ip_address = attributes[:'ip_address']
  else
    self.ip_address = nil
  end

  if attributes.key?(:'user_agent')
    self.user_agent = attributes[:'user_agent']
  else
    self.user_agent = nil
  end
end

Instance Attribute Details

#auth_phone_number_hash ⇒ Object

Returns the value of attribute auth_phone_number_hash.


54
55
56
 
# File 'lib/docspring/models/submission_data_request.rb', line 54

def auth_phone_number_hash
  @auth_phone_number_hash
end

#auth_provider ⇒ Object

Returns the value of attribute auth_provider.


44
45
46
 
# File 'lib/docspring/models/submission_data_request.rb', line 44

def auth_provider
  @auth_provider
end

#auth_second_factor_type ⇒ Object

Returns the value of attribute auth_second_factor_type.


42
43
44
 
# File 'lib/docspring/models/submission_data_request.rb', line 42

def auth_second_factor_type
  @auth_second_factor_type
end

#auth_session_id_hash ⇒ Object

Returns the value of attribute auth_session_id_hash.


48
49
50
 
# File 'lib/docspring/models/submission_data_request.rb', line 48

def auth_session_id_hash
  @auth_session_id_hash
end

#auth_session_started_at ⇒ Object

Returns the value of attribute auth_session_started_at.


46
47
48
 
# File 'lib/docspring/models/submission_data_request.rb', line 46

def auth_session_started_at
  @auth_session_started_at
end

#auth_type ⇒ Object

Returns the value of attribute auth_type.


40
41
42
 
# File 'lib/docspring/models/submission_data_request.rb', line 40

def auth_type
  @auth_type
end

#auth_user_id_hash ⇒ Object

Returns the value of attribute auth_user_id_hash.


50
51
52
 
# File 'lib/docspring/models/submission_data_request.rb', line 50

def auth_user_id_hash
  @auth_user_id_hash
end

#auth_username_hash ⇒ Object

Returns the value of attribute auth_username_hash.


52
53
54
 
# File 'lib/docspring/models/submission_data_request.rb', line 52

def auth_username_hash
  @auth_username_hash
end

#completed_at ⇒ Object

Returns the value of attribute completed_at.


36
37
38
 
# File 'lib/docspring/models/submission_data_request.rb', line 36

def completed_at
  @completed_at
end

#data ⇒ Object

Returns the value of attribute data.


38
39
40
 
# File 'lib/docspring/models/submission_data_request.rb', line 38

def data
  @data
end

#email ⇒ Object

Returns the value of attribute email.


20
21
22
 
# File 'lib/docspring/models/submission_data_request.rb', line 20

def email
  @email
end

#fields ⇒ Object

Returns the value of attribute fields.


28
29
30
 
# File 'lib/docspring/models/submission_data_request.rb', line 28

def fields
  @fields
end

#id ⇒ Object

Returns the value of attribute id.


18
19
20
 
# File 'lib/docspring/models/submission_data_request.rb', line 18

def id
  @id
end

#ip_address ⇒ Object

Returns the value of attribute ip_address.


56
57
58
 
# File 'lib/docspring/models/submission_data_request.rb', line 56

def ip_address
  @ip_address
end

#metadata ⇒ Object

Returns the value of attribute metadata.


30
31
32
 
# File 'lib/docspring/models/submission_data_request.rb', line 30

def metadata
  @metadata
end

#name ⇒ Object

Returns the value of attribute name.


22
23
24
 
# File 'lib/docspring/models/submission_data_request.rb', line 22

def name
  @name
end

#order ⇒ Object

Returns the value of attribute order.


24
25
26
 
# File 'lib/docspring/models/submission_data_request.rb', line 24

def order
  @order
end

#sort_order ⇒ Object

Returns the value of attribute sort_order.


26
27
28
 
# File 'lib/docspring/models/submission_data_request.rb', line 26

def sort_order
  @sort_order
end

#state ⇒ Object

Returns the value of attribute state.


32
33
34
 
# File 'lib/docspring/models/submission_data_request.rb', line 32

def state
  @state
end

#user_agent ⇒ Object

Returns the value of attribute user_agent.


58
59
60
 
# File 'lib/docspring/models/submission_data_request.rb', line 58

def user_agent
  @user_agent
end

#viewed_at ⇒ Object

Returns the value of attribute viewed_at.


34
35
36
 
# File 'lib/docspring/models/submission_data_request.rb', line 34

def viewed_at
  @viewed_at
end

Class Method Details

._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

[View source]

446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/docspring/models/submission_data_request.rb', line 446

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = DocSpring.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about

[View source]

110
111
112
 
# File 'lib/docspring/models/submission_data_request.rb', line 110

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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

[View source]

83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/docspring/models/submission_data_request.rb', line 83

def self.attribute_map
  {
    :'id' => :'id',
    :'email' => :'email',
    :'name' => :'name',
    :'order' => :'order',
    :'sort_order' => :'sort_order',
    :'fields' => :'fields',
    :'metadata' => :'metadata',
    :'state' => :'state',
    :'viewed_at' => :'viewed_at',
    :'completed_at' => :'completed_at',
    :'data' => :'data',
    :'auth_type' => :'auth_type',
    :'auth_second_factor_type' => :'auth_second_factor_type',
    :'auth_provider' => :'auth_provider',
    :'auth_session_started_at' => :'auth_session_started_at',
    :'auth_session_id_hash' => :'auth_session_id_hash',
    :'auth_user_id_hash' => :'auth_user_id_hash',
    :'auth_username_hash' => :'auth_username_hash',
    :'auth_phone_number_hash' => :'auth_phone_number_hash',
    :'ip_address' => :'ip_address',
    :'user_agent' => :'user_agent'
  }
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

[View source]

422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/docspring/models/submission_data_request.rb', line 422

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true

[View source]

142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/docspring/models/submission_data_request.rb', line 142

def self.openapi_nullable
  Set.new([
    :'id',
    :'email',
    :'name',
    :'order',
    :'fields',
    :'metadata',
    :'viewed_at',
    :'completed_at',
    :'data',
    :'auth_provider',
    :'auth_session_started_at',
    :'auth_session_id_hash',
    :'auth_user_id_hash',
    :'auth_username_hash',
    :'auth_phone_number_hash',
    :'ip_address',
    :'user_agent'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.

[View source]

115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/docspring/models/submission_data_request.rb', line 115

def self.openapi_types
  {
    :'id' => :'String',
    :'email' => :'String',
    :'name' => :'String',
    :'order' => :'Integer',
    :'sort_order' => :'Integer',
    :'fields' => :'Array<String>',
    :'metadata' => :'Object',
    :'state' => :'String',
    :'viewed_at' => :'String',
    :'completed_at' => :'String',
    :'data' => :'Object',
    :'auth_type' => :'String',
    :'auth_second_factor_type' => :'String',
    :'auth_provider' => :'String',
    :'auth_session_started_at' => :'String',
    :'auth_session_id_hash' => :'String',
    :'auth_user_id_hash' => :'String',
    :'auth_username_hash' => :'String',
    :'auth_phone_number_hash' => :'String',
    :'ip_address' => :'String',
    :'user_agent' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared

[View source]

381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/docspring/models/submission_data_request.rb', line 381

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      email == o.email &&
      name == o.name &&
      order == o.order &&
      sort_order == o.sort_order &&
      fields == o.fields &&
      metadata == o.metadata &&
      state == o.state &&
      viewed_at == o.viewed_at &&
      completed_at == o.completed_at &&
      data == o.data &&
      auth_type == o.auth_type &&
      auth_second_factor_type == o.auth_second_factor_type &&
      auth_provider == o.auth_provider &&
      auth_session_started_at == o.auth_session_started_at &&
      auth_session_id_hash == o.auth_session_id_hash &&
      auth_user_id_hash == o.auth_user_id_hash &&
      auth_username_hash == o.auth_username_hash &&
      auth_phone_number_hash == o.auth_phone_number_hash &&
      ip_address == o.ip_address &&
      user_agent == o.user_agent
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

[View source]

517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/docspring/models/submission_data_request.rb', line 517

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method
[View source]

409
410
411
 
# File 'lib/docspring/models/submission_data_request.rb', line 409

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code

[View source]

415
416
417
 
# File 'lib/docspring/models/submission_data_request.rb', line 415

def hash
  [id, email, name, order, sort_order, fields, metadata, state, viewed_at, completed_at, data, auth_type, auth_second_factor_type, auth_provider, auth_session_started_at, auth_session_id_hash, auth_user_id_hash, auth_username_hash, auth_phone_number_hash, ip_address, user_agent].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

[View source]

310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/docspring/models/submission_data_request.rb', line 310

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @sort_order.nil?
    invalid_properties.push('invalid value for "sort_order", sort_order cannot be nil.')
  end

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

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

  if @auth_second_factor_type.nil?
    invalid_properties.push('invalid value for "auth_second_factor_type", auth_second_factor_type 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

[View source]

493
494
495
 
# File 'lib/docspring/models/submission_data_request.rb', line 493

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

[View source]

499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/docspring/models/submission_data_request.rb', line 499

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

[View source]

487
488
489
 
# File 'lib/docspring/models/submission_data_request.rb', line 487

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

[View source]

334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/docspring/models/submission_data_request.rb', line 334

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @sort_order.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["pending", "completed"])
  return false unless state_validator.valid?(@state)
  return false if @auth_type.nil?
  auth_type_validator = EnumAttributeValidator.new('String', ["none", "password", "oauth", "email_link", "phone_number", "ldap", "saml"])
  return false unless auth_type_validator.valid?(@auth_type)
  return false if @auth_second_factor_type.nil?
  auth_second_factor_type_validator = EnumAttributeValidator.new('String', ["none", "phone_number", "totp", "mobile_push", "security_key", "fingerprint"])
  return false unless auth_second_factor_type_validator.valid?(@auth_second_factor_type)
  true
end