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



121
122
123
124
125
126
127
128
129
130
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
 
# File 'lib/docspring/models/submission_data_request.rb', line 121

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'email')
    self.email = attributes[:'email']
  end

  if attributes.has_key?(:'order')
    self.order = attributes[:'order']
  end

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

  if attributes.has_key?(:'metadata')
    self.metadata = attributes[:'metadata']
  end

  if attributes.has_key?(:'state')
    self.state = attributes[:'state']
  end

  if attributes.has_key?(:'viewed_at')
    self.viewed_at = attributes[:'viewed_at']
  end

  if attributes.has_key?(:'completed_at')
    self.completed_at = attributes[:'completed_at']
  end

  if attributes.has_key?(:'auth_type')
    self.auth_type = attributes[:'auth_type']
  end

  if attributes.has_key?(:'auth_second_factor_type')
    self.auth_second_factor_type = attributes[:'auth_second_factor_type']
  end

  if attributes.has_key?(:'auth_provider')
    self.auth_provider = attributes[:'auth_provider']
  end

  if attributes.has_key?(:'auth_session_started_at')
    self.auth_session_started_at = attributes[:'auth_session_started_at']
  end

  if attributes.has_key?(:'auth_session_id_hash')
    self.auth_session_id_hash = attributes[:'auth_session_id_hash']
  end

  if attributes.has_key?(:'auth_user_id_hash')
    self.auth_user_id_hash = attributes[:'auth_user_id_hash']
  end

  if attributes.has_key?(:'auth_username_hash')
    self.auth_username_hash = attributes[:'auth_username_hash']
  end

  if attributes.has_key?(:'auth_phone_number_hash')
    self.auth_phone_number_hash = attributes[:'auth_phone_number_hash']
  end
end

Instance Attribute Details

#auth_phone_number_hash ⇒ Object

Returns the value of attribute auth_phone_number_hash.



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

def auth_phone_number_hash
  @auth_phone_number_hash
end

#auth_provider ⇒ Object

Returns the value of attribute auth_provider.



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

def auth_provider
  @auth_provider
end

#auth_second_factor_type ⇒ Object

Returns the value of attribute auth_second_factor_type.



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

def auth_second_factor_type
  @auth_second_factor_type
end

#auth_session_id_hash ⇒ Object

Returns the value of attribute auth_session_id_hash.



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

def auth_session_id_hash
  @auth_session_id_hash
end

#auth_session_started_at ⇒ Object

Returns the value of attribute auth_session_started_at.



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

def auth_session_started_at
  @auth_session_started_at
end

#auth_type ⇒ Object

Returns the value of attribute auth_type.



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

def auth_type
  @auth_type
end

#auth_user_id_hash ⇒ Object

Returns the value of attribute auth_user_id_hash.



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

def auth_user_id_hash
  @auth_user_id_hash
end

#auth_username_hash ⇒ Object

Returns the value of attribute auth_username_hash.



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

def auth_username_hash
  @auth_username_hash
end

#completed_at ⇒ Object

Returns the value of attribute completed_at.



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

def completed_at
  @completed_at
end

#email ⇒ Object

Returns the value of attribute email.



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

def email
  @email
end

#fields ⇒ Object

Returns the value of attribute fields.



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

def fields
  @fields
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#metadata ⇒ Object

Returns the value of attribute metadata.



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

def metadata
  @metadata
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#order ⇒ Object

Returns the value of attribute order.



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

def order
  @order
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#viewed_at ⇒ Object

Returns the value of attribute viewed_at.



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

def viewed_at
  @viewed_at
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/docspring/models/submission_data_request.rb', line 74

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'email' => :'email',
    :'order' => :'order',
    :'fields' => :'fields',
    :'metadata' => :'metadata',
    :'state' => :'state',
    :'viewed_at' => :'viewed_at',
    :'completed_at' => :'completed_at',
    :'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'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/docspring/models/submission_data_request.rb', line 97

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'email' => :'String',
    :'order' => :'Integer',
    :'fields' => :'Array<String>',
    :'metadata' => :'Object',
    :'state' => :'String',
    :'viewed_at' => :'String',
    :'completed_at' => :'String',
    :'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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/docspring/models/submission_data_request.rb', line 284

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      email == o.email &&
      order == o.order &&
      fields == o.fields &&
      metadata == o.metadata &&
      state == o.state &&
      viewed_at == o.viewed_at &&
      completed_at == o.completed_at &&
      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
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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/docspring/models/submission_data_request.rb', line 342

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
    temp_model = DocSpring.const_get(type).new
    temp_model.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



408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/docspring/models/submission_data_request.rb', line 408

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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/docspring/models/submission_data_request.rb', line 321

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


308
309
310
 
# File 'lib/docspring/models/submission_data_request.rb', line 308

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



314
315
316
 
# File 'lib/docspring/models/submission_data_request.rb', line 314

def hash
  [id, name, email, order, fields, metadata, state, viewed_at, completed_at, 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].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



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
 
# File 'lib/docspring/models/submission_data_request.rb', line 200

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

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

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

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

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

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

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



388
389
390
 
# File 'lib/docspring/models/submission_data_request.rb', line 388

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



394
395
396
397
398
399
400
401
402
 
# File 'lib/docspring/models/submission_data_request.rb', line 394

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



382
383
384
 
# File 'lib/docspring/models/submission_data_request.rb', line 382

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/docspring/models/submission_data_request.rb', line 235

def valid?
  return false if @id.nil?
  return false if @name.nil?
  return false if @email.nil?
  return false if @order.nil?
  return false if @fields.nil?
  return false if @metadata.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ['pending', 'completed'])
  return false unless state_validator.valid?(@state)
  auth_type_validator = EnumAttributeValidator.new('String', ['none', 'password', 'oauth', 'email_link', 'phone_number', 'ldap', 'saml'])
  return false unless auth_type_validator.valid?(@auth_type)
  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