Class: XeroRuby::Accounting::Phone

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/accounting/phone.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

DEFAULT = 
"DEFAULT".freeze
DDI = 
"DDI".freeze
MOBILE = 
"MOBILE".freeze
FAX = 
"FAX".freeze
OFFICE = 
"OFFICE".freeze

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



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
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 81

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

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

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

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

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

Instance Attribute Details

#phone_area_code ⇒ Object

max length = 10



32
33
34
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 32

def phone_area_code
  @phone_area_code
end

#phone_country_code ⇒ Object

max length = 20



35
36
37
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 35

def phone_country_code
  @phone_country_code
end

#phone_number ⇒ Object

max length = 50



29
30
31
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 29

def phone_number
  @phone_number
end

#phone_type ⇒ Object

Returns the value of attribute phone_type.



21
22
23
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 21

def phone_type
  @phone_type
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 60

def self.attribute_map
  {
    :'phone_type' => :'PhoneType',
    :'phone_number' => :'PhoneNumber',
    :'phone_area_code' => :'PhoneAreaCode',
    :'phone_country_code' => :'PhoneCountryCode'
  }
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



207
208
209
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 207

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

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 70

def self.openapi_types
  {
    :'phone_type' => :'String',
    :'phone_number' => :'String',
    :'phone_area_code' => :'String',
    :'phone_country_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



183
184
185
186
187
188
189
190
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      phone_type == o.phone_type &&
      phone_number == o.phone_number &&
      phone_area_code == o.phone_area_code &&
      phone_country_code == o.phone_country_code
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



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
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 235

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(parse_date(value))
  when :Date
    Date.parse(parse_date(value))
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BigDecimal
    BigDecimal(value.to_s)
  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
    XeroRuby::Accounting.const_get(type).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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 302

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 214

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


194
195
196
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



200
201
202
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 200

def hash
  [phone_type, phone_number, phone_area_code, phone_country_code].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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 113

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

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

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

  invalid_properties
end

#parse_date(datestring) ⇒ Object

customized data_parser



317
318
319
320
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 317

def parse_date(datestring)
  seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
  return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



282
283
284
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 282

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



288
289
290
291
292
293
294
295
296
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 288

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



276
277
278
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 276

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



132
133
134
135
136
137
138
139
 
# File 'lib/xero-ruby/models/accounting/phone.rb', line 132

def valid?
  phone_type_validator = EnumAttributeValidator.new('String', ["DEFAULT", "DDI", "MOBILE", "FAX", "OFFICE"])
  return false unless phone_type_validator.valid?(@phone_type)
  return false if !@phone_number.nil? && @phone_number.to_s.length > 50
  return false if !@phone_area_code.nil? && @phone_area_code.to_s.length > 10
  return false if !@phone_country_code.nil? && @phone_country_code.to_s.length > 20
  true
end