Class: DocSpring::CreateSubmissionDataRequestData

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSubmissionDataRequestData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



105
106
107
108
109
110
111
112
113
114
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
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
 
# File 'lib/docspring/models/create_submission_data_request_data.rb', line 105

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?(:'auth_type')
    self.auth_type = attributes[:'auth_type']
  end

  if attributes.has_key?(:'metadata')
    self.metadata = attributes[:'metadata']
  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_phone_number_hash')
    self.auth_phone_number_hash = attributes[:'auth_phone_number_hash']
  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_user_id_hash')
    self.auth_user_id_hash = attributes[:'auth_user_id_hash']
  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_username_hash')
    self.auth_username_hash = attributes[:'auth_username_hash']
  end

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

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

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

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

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

Instance Attribute Details

#auth_phone_number_hash ⇒ Object

Returns the value of attribute auth_phone_number_hash.



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

def auth_phone_number_hash
  @auth_phone_number_hash
end

#auth_provider ⇒ Object

Returns the value of attribute auth_provider.



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

def auth_provider
  @auth_provider
end

#auth_second_factor_type ⇒ Object

Returns the value of attribute auth_second_factor_type.



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

def auth_second_factor_type
  @auth_second_factor_type
end

#auth_session_id_hash ⇒ Object

Returns the value of attribute auth_session_id_hash.



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

def auth_session_id_hash
  @auth_session_id_hash
end

#auth_session_started_at ⇒ Object

Returns the value of attribute auth_session_started_at.



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

def auth_session_started_at
  @auth_session_started_at
end

#auth_type ⇒ Object

Returns the value of attribute auth_type.



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

def auth_type
  @auth_type
end

#auth_user_id_hash ⇒ Object

Returns the value of attribute auth_user_id_hash.



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

def auth_user_id_hash
  @auth_user_id_hash
end

#auth_username_hash ⇒ Object

Returns the value of attribute auth_username_hash.



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

def auth_username_hash
  @auth_username_hash
end

#email ⇒ Object

Returns the value of attribute email.



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

def email
  @email
end

#fields ⇒ Object

Returns the value of attribute fields.



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

def fields
  @fields
end

#metadata ⇒ Object

Returns the value of attribute metadata.



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

def metadata
  @metadata
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#order ⇒ Object

Returns the value of attribute order.



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

def order
  @order
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/docspring/models/create_submission_data_request_data.rb', line 66

def self.attribute_map
  {
    :'auth_type' => :'auth_type',
    :'metadata' => :'metadata',
    :'auth_second_factor_type' => :'auth_second_factor_type',
    :'auth_phone_number_hash' => :'auth_phone_number_hash',
    :'auth_session_started_at' => :'auth_session_started_at',
    :'auth_user_id_hash' => :'auth_user_id_hash',
    :'auth_session_id_hash' => :'auth_session_id_hash',
    :'auth_username_hash' => :'auth_username_hash',
    :'name' => :'name',
    :'fields' => :'fields',
    :'auth_provider' => :'auth_provider',
    :'email' => :'email',
    :'order' => :'order'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/docspring/models/create_submission_data_request_data.rb', line 85

def self.openapi_types
  {
    :'auth_type' => :'String',
    :'metadata' => :'Object',
    :'auth_second_factor_type' => :'String',
    :'auth_phone_number_hash' => :'String',
    :'auth_session_started_at' => :'String',
    :'auth_user_id_hash' => :'String',
    :'auth_session_id_hash' => :'String',
    :'auth_username_hash' => :'String',
    :'name' => :'String',
    :'fields' => :'Array<String>',
    :'auth_provider' => :'String',
    :'email' => :'String',
    :'order' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/docspring/models/create_submission_data_request_data.rb', line 205

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



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

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/docspring/models/create_submission_data_request_data.rb', line 325

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/docspring/models/create_submission_data_request_data.rb', line 238

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


225
226
227
 
# File 'lib/docspring/models/create_submission_data_request_data.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



231
232
233
 
# File 'lib/docspring/models/create_submission_data_request_data.rb', line 231

def hash
  [auth_type, metadata, auth_second_factor_type, auth_phone_number_hash, auth_session_started_at, auth_user_id_hash, auth_session_id_hash, auth_username_hash, name, fields, auth_provider, email, order].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



168
169
170
171
 
# File 'lib/docspring/models/create_submission_data_request_data.rb', line 168

def list_invalid_properties
  invalid_properties = Array.new
  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



305
306
307
 
# File 'lib/docspring/models/create_submission_data_request_data.rb', line 305

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



311
312
313
314
315
316
317
318
319
 
# File 'lib/docspring/models/create_submission_data_request_data.rb', line 311

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



299
300
301
 
# File 'lib/docspring/models/create_submission_data_request_data.rb', line 299

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



175
176
177
178
179
180
181
 
# File 'lib/docspring/models/create_submission_data_request_data.rb', line 175

def valid?
  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