Class: Trulioo::BusinessRegistrationNumberMask

Inherits:
Object
  • Object
show all
Defined in:
lib/trulioo_sdk/models/business_registration_number_mask.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BusinessRegistrationNumberMask

Initializes the object

Parameters:

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

    Model attributes in the form of hash


54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 54

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

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

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

Instance Attribute Details

#ignore_special_character ⇒ Object

Flag showing whether we can ignore special character


21
22
23
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 21

def ignore_special_character
  @ignore_special_character
end

#ignore_whitespace ⇒ Object

Flag showing whether we can ignore whitespace


18
19
20
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 18

def ignore_whitespace
  @ignore_whitespace
end

#mask ⇒ Object

The mask used to validate the format of the business registration number


15
16
17
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 15

def mask
  @mask
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about


33
34
35
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 33

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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


24
25
26
27
28
29
30
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 24

def self.attribute_map
  {
    :'mask' => :'Mask',
    :'ignore_whitespace' => :'IgnoreWhitespace',
    :'ignore_special_character' => :'IgnoreSpecialCharacter'
  }
end

.build_from_hash(attributes) ⇒ Object

:nocov: Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself


143
144
145
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 143

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true


47
48
49
50
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 47

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.


38
39
40
41
42
43
44
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 38

def self.openapi_types
  {
    :'mask' => :'String',
    :'ignore_whitespace' => :'Boolean',
    :'ignore_special_character' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared


119
120
121
122
123
124
125
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 119

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      mask == o.mask &&
      ignore_whitespace == o.ignore_whitespace &&
      ignore_special_character == o.ignore_special_character
end

#_deserialize(type, value) ⇒ Object

:nocov: Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data


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
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 177

def _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 = Trulioo.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

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


256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 256

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

:nocov: Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself


152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 152

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

129
130
131
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 129

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code


135
136
137
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 135

def hash
  [mask, ignore_whitespace, ignore_special_character].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


82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 82

def list_invalid_properties
  invalid_properties = Array.new
  if !@mask.nil? && @mask.to_s.length > 512
    invalid_properties.push('invalid value for "mask", the character length must be smaller than or equal to 512.')
  end

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

  invalid_properties
end

#to_body ⇒ Hash

:nocov: to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash


228
229
230
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 228

def to_body
  to_hash
end

#to_hash ⇒ Hash

:nocov: Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash


236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 236

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

:nocov: Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object


220
221
222
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 220

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


97
98
99
100
101
 
# File 'lib/trulioo_sdk/models/business_registration_number_mask.rb', line 97

def valid?
  return false if !@mask.nil? && @mask.to_s.length > 512
  return false if !@mask.nil? && @mask.to_s.length < 0
  true
end