Class: MoneyKit::Phone

Inherits:
Object
  • Object
show all
Defined in:
lib/moneykit/models/phone.rb

Overview

The user’s mobile phone number. This field is optional, but either email or phone must be provided to enable improved link conversion via the MoneyID system.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Phone

Initializes the object

Parameters:

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

    Model attributes in the form of hash



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/moneykit/models/phone.rb', line 86

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError, 'The input argument (attributes) must be a hash in `MoneyKit::Phone` initialize method'
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    unless self.class.attribute_map.key?(k.to_sym)
      raise ArgumentError,
            "`#{k}` is not a valid attribute in `MoneyKit::Phone`. 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
  end

  self.number = attributes[:number] if attributes.key?(:number)

  self.country = attributes[:country] if attributes.key?(:country)

  return unless attributes.key?(:customer_verified_at)

  self.customer_verified_at = attributes[:customer_verified_at]
end

Instance Attribute Details

#country ⇒ Object

Returns the value of attribute country.



20
21
22
 
# File 'lib/moneykit/models/phone.rb', line 20

def country
  @country
end

#customer_verified_at ⇒ Object

Optional timestamp that marks when you last verified this number (such as when the user most recently returned a verification code sent via SMS to this number). Only include this field if you verified the number. You may supply zeros if the time (but not the date) is unknown.



23
24
25
 
# File 'lib/moneykit/models/phone.rb', line 23

def customer_verified_at
  @customer_verified_at
end

#number ⇒ Object

The user’s phone number, preferably in E164 format, including the country code.



18
19
20
 
# File 'lib/moneykit/models/phone.rb', line 18

def number
  @number
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



56
57
58
 
# File 'lib/moneykit/models/phone.rb', line 56

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
 
# File 'lib/moneykit/models/phone.rb', line 47

def self.attribute_map
  {
    'number': :number,
    'country': :country,
    'customer_verified_at': :customer_verified_at
  }
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



188
189
190
 
# File 'lib/moneykit/models/phone.rb', line 188

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



78
79
80
81
82
 
# File 'lib/moneykit/models/phone.rb', line 78

def self.openapi_all_of
  [
    :LinkSessionCustomerUserPhone
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



70
71
72
73
74
75
 
# File 'lib/moneykit/models/phone.rb', line 70

def self.openapi_nullable
  Set.new(%i[
            country
            customer_verified_at
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
 
# File 'lib/moneykit/models/phone.rb', line 61

def self.openapi_types
  {
    'number': :String,
    'country': :Country,
    'customer_verified_at': :Time
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



164
165
166
167
168
169
170
171
 
# File 'lib/moneykit/models/phone.rb', line 164

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    number == other.number &&
    country == other.country &&
    customer_verified_at == other.customer_verified_at
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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/moneykit/models/phone.rb', line 222

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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/moneykit/models/phone.rb', line 293

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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/moneykit/models/phone.rb', line 195

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      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)
        send("#{key}=", attributes[self.class.attribute_map[key]].map do |v|
                          _deserialize(::Regexp.last_match(1), v)
                        end)
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


175
176
177
 
# File 'lib/moneykit/models/phone.rb', line 175

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



181
182
183
 
# File 'lib/moneykit/models/phone.rb', line 181

def hash
  [number, country, customer_verified_at].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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/moneykit/models/phone.rb', line 112

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "number", number cannot be nil.') if @number.nil?

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

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

  pattern = Regexp.new(/^\+?[ 0-9().#]+$/)
  if @number !~ pattern
    invalid_properties.push("invalid value for \"number\", must conform to the pattern #{pattern}.")
  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



269
270
271
 
# File 'lib/moneykit/models/phone.rb', line 269

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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/moneykit/models/phone.rb', line 275

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



263
264
265
 
# File 'lib/moneykit/models/phone.rb', line 263

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



134
135
136
137
138
139
140
141
 
# File 'lib/moneykit/models/phone.rb', line 134

def valid?
  return false if @number.nil?
  return false if @number.to_s.length > 250
  return false if @number.to_s.length < 4
  return false if @number !~ Regexp.new(/^\+?[ 0-9().#]+$/)

  true
end