Class: MergeATSClient::EndUserDetailsRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ats_client/models/end_user_details_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EndUserDetailsRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



70
71
72
73
74
75
76
77
78
79
80
81
82
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
108
109
110
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 70

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

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

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

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

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

  if attributes.key?(:'link_expiry_mins')
    self.link_expiry_mins = attributes[:'link_expiry_mins']
  else
    self.link_expiry_mins = 30
  end
end

Instance Attribute Details

#categories ⇒ Object

Returns the value of attribute categories.



24
25
26
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 24

def categories
  @categories
end

#end_user_email_address ⇒ Object

Returns the value of attribute end_user_email_address.



18
19
20
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 18

def end_user_email_address
  @end_user_email_address
end

#end_user_organization_name ⇒ Object

Returns the value of attribute end_user_organization_name.



20
21
22
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 20

def end_user_organization_name
  @end_user_organization_name
end

#end_user_origin_id ⇒ Object

Returns the value of attribute end_user_origin_id.



22
23
24
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 22

def end_user_origin_id
  @end_user_origin_id
end

#integration ⇒ Object

The slug of a specific pre-selected integration for this linking flow token, for examples of slugs see www.merge.dev/docs/basics/integration-metadata



27
28
29
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 27

def integration
  @integration
end

#link_expiry_mins ⇒ Object

An integer number of minutes between [30, 720] for how long this token is valid. Defaults to 30



30
31
32
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 30

def link_expiry_mins
  @link_expiry_mins
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



45
46
47
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 45

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 33

def self.attribute_map
  {
    :'end_user_email_address' => :'end_user_email_address',
    :'end_user_organization_name' => :'end_user_organization_name',
    :'end_user_origin_id' => :'end_user_origin_id',
    :'categories' => :'categories',
    :'integration' => :'integration',
    :'link_expiry_mins' => :'link_expiry_mins'
  }
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



296
297
298
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 296

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
66
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 62

def self.openapi_nullable
  Set.new([
    :'integration',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 50

def self.openapi_types
  {
    :'end_user_email_address' => :'String',
    :'end_user_organization_name' => :'String',
    :'end_user_origin_id' => :'String',
    :'categories' => :'Array<CategoriesEnum>',
    :'integration' => :'String',
    :'link_expiry_mins' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



270
271
272
273
274
275
276
277
278
279
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 270

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      end_user_email_address == o.end_user_email_address &&
      end_user_organization_name == o.end_user_organization_name &&
      end_user_origin_id == o.end_user_origin_id &&
      categories == o.categories &&
      integration == o.integration &&
      link_expiry_mins == o.link_expiry_mins
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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 326

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  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 = MergeATSClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 397

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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 303

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


283
284
285
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 283

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



289
290
291
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 289

def hash
  [end_user_email_address, end_user_organization_name, end_user_origin_id, categories, integration, link_expiry_mins].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



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
165
166
167
168
169
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 114

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

  if @end_user_email_address.to_s.length > 100
    invalid_properties.push('invalid value for "end_user_email_address", the character length must be smaller than or equal to 100.')
  end

  if @end_user_email_address.to_s.length < 1
    invalid_properties.push('invalid value for "end_user_email_address", the character length must be great than or equal to 1.')
  end

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

  if @end_user_organization_name.to_s.length > 100
    invalid_properties.push('invalid value for "end_user_organization_name", the character length must be smaller than or equal to 100.')
  end

  if @end_user_organization_name.to_s.length < 1
    invalid_properties.push('invalid value for "end_user_organization_name", the character length must be great than or equal to 1.')
  end

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

  if @end_user_origin_id.to_s.length > 100
    invalid_properties.push('invalid value for "end_user_origin_id", the character length must be smaller than or equal to 100.')
  end

  if @end_user_origin_id.to_s.length < 1
    invalid_properties.push('invalid value for "end_user_origin_id", the character length must be great than or equal to 1.')
  end

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

  if !@integration.nil? && @integration.to_s.length < 1
    invalid_properties.push('invalid value for "integration", the character length must be great than or equal to 1.')
  end

  if !@link_expiry_mins.nil? && @link_expiry_mins > 720
    invalid_properties.push('invalid value for "link_expiry_mins", must be smaller than or equal to 720.')
  end

  if !@link_expiry_mins.nil? && @link_expiry_mins < 30
    invalid_properties.push('invalid value for "link_expiry_mins", must be greater than or equal to 30.')
  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



373
374
375
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 373

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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 379

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



367
368
369
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 367

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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/merge_ats_client/models/end_user_details_request.rb', line 173

def valid?
  return false if @end_user_email_address.nil?
  return false if @end_user_email_address.to_s.length > 100
  return false if @end_user_email_address.to_s.length < 1
  return false if @end_user_organization_name.nil?
  return false if @end_user_organization_name.to_s.length > 100
  return false if @end_user_organization_name.to_s.length < 1
  return false if @end_user_origin_id.nil?
  return false if @end_user_origin_id.to_s.length > 100
  return false if @end_user_origin_id.to_s.length < 1
  return false if @categories.nil?
  return false if !@integration.nil? && @integration.to_s.length < 1
  return false if !@link_expiry_mins.nil? && @link_expiry_mins > 720
  return false if !@link_expiry_mins.nil? && @link_expiry_mins < 30
  true
end