Class: MergeHRISClient::EndUserDetailsRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_hris_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



104
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
165
166
167
168
169
170
171
172
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 104

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

  if attributes.key?(:'should_create_magic_link_url')
    self.should_create_magic_link_url = attributes[:'should_create_magic_link_url']
  else
    self.should_create_magic_link_url = false
  end

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

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

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

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

Instance Attribute Details

#categories ⇒ Object

The integration categories to show in Merge Link.



28
29
30
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 28

def categories
  @categories
end

#category_common_model_scopes ⇒ Object

When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.



43
44
45
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 43

def category_common_model_scopes
  @category_common_model_scopes
end

#common_models ⇒ Object

An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.



40
41
42
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 40

def common_models
  @common_models
end

#end_user_email_address ⇒ Object

Your end user’s email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.



19
20
21
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 19

def end_user_email_address
  @end_user_email_address
end

#end_user_organization_name ⇒ Object

Your end user’s organization.



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

def end_user_organization_name
  @end_user_organization_name
end

#end_user_origin_id ⇒ Object

This unique identifier typically represents the ID for your end user in your product’s database. This value must be distinct from other Linked Accounts’ unique identifiers.



25
26
27
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 25

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 docs.merge.dev/guides/merge-link/single-integration/.



31
32
33
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 31

def integration
  @integration
end

#integration_specific_config ⇒ Object

A JSON object containing integration-specific configuration options.



49
50
51
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 49

def integration_specific_config
  @integration_specific_config
end

#language ⇒ Object

The language code for the language to localize Merge Link to.



46
47
48
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 46

def language
  @language
end

#link_expiry_mins ⇒ Object

An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.



34
35
36
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 34

def link_expiry_mins
  @link_expiry_mins
end

#should_create_magic_link_url ⇒ Object

Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see merge.dev/blog/integrations-fast-say-hello-to-magic-link.



37
38
39
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 37

def should_create_magic_link_url
  @should_create_magic_link_url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 69

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 52

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',
    :'should_create_magic_link_url' => :'should_create_magic_link_url',
    :'common_models' => :'common_models',
    :'category_common_model_scopes' => :'category_common_model_scopes',
    :'language' => :'language',
    :'integration_specific_config' => :'integration_specific_config'
  }
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



387
388
389
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 387

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
95
96
97
98
99
100
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 91

def self.openapi_nullable
  Set.new([
    :'integration',
    :'should_create_magic_link_url',
    :'common_models',
    :'category_common_model_scopes',
    :'language',
    :'integration_specific_config'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 74

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',
    :'should_create_magic_link_url' => :'Boolean',
    :'common_models' => :'Array<CommonModelScopesBodyRequest>',
    :'category_common_model_scopes' => :'Hash<String, Array<IndividualCommonModelScopeDeserializerRequest>>',
    :'language' => :'String',
    :'integration_specific_config' => :'Hash<String, Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 356

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 &&
      should_create_magic_link_url == o.should_create_magic_link_url &&
      common_models == o.common_models &&
      category_common_model_scopes == o.category_common_model_scopes &&
      language == o.language &&
      integration_specific_config == o.integration_specific_config
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



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 417

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 = MergeHRISClient.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



488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 488

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



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 394

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


374
375
376
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 374

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



380
381
382
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 380

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



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
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 176

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 > 10080
    invalid_properties.push('invalid value for "link_expiry_mins", must be smaller than or equal to 10080.')
  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

  if !@language.nil? && @language.to_s.length > 2
    invalid_properties.push('invalid value for "language", the character length must be smaller than or equal to 2.')
  end

  if !@language.nil? && @language.to_s.length < 1
    invalid_properties.push('invalid value for "language", the character length must be great than or equal to 1.')
  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



464
465
466
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 464

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



470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 470

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



458
459
460
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 458

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/merge_hris_client/models/end_user_details_request.rb', line 243

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 > 10080
  return false if !@link_expiry_mins.nil? && @link_expiry_mins < 30
  return false if !@language.nil? && @language.to_s.length > 2
  return false if !@language.nil? && @language.to_s.length < 1
  true
end