Class: Freeclimb::Capabilities

Inherits:
Object
  • Object
show all
Defined in:
lib/freeclimb/models/capabilities.rb

Overview

Details for which features this number may be used.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Capabilities

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/freeclimb/models/capabilities.rb', line 74

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

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

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

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

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

Instance Attribute Details

#short_code ⇒ Object

Indicates that a number is a short code and can be used for short code messaging



32
33
34
 
# File 'lib/freeclimb/models/capabilities.rb', line 32

def short_code
  @short_code
end

#sms ⇒ Object

Indicates whether a number can be used SMS messaging. Replaces smsEnabled.



23
24
25
 
# File 'lib/freeclimb/models/capabilities.rb', line 23

def sms
  @sms
end

#ten_dlc ⇒ Object

Indicates that a number, if sms is true, will be used for 10DLC messaging



29
30
31
 
# File 'lib/freeclimb/models/capabilities.rb', line 29

def ten_dlc
  @ten_dlc
end

#toll_free ⇒ Object

Indicates that a number is toll-free and will make toll-free calls, and when enabled, toll-free messages.



26
27
28
 
# File 'lib/freeclimb/models/capabilities.rb', line 26

def toll_free
  @toll_free
end

#voice ⇒ Object

Indicates whether a number can be used for voice calls. Replaces voiceEnabled.



20
21
22
 
# File 'lib/freeclimb/models/capabilities.rb', line 20

def voice
  @voice
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



46
47
48
 
# File 'lib/freeclimb/models/capabilities.rb', line 46

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/freeclimb/models/capabilities.rb', line 35

def self.attribute_map
  {
    :'voice' => :'voice',
    :'sms' => :'sms',
    :'toll_free' => :'tollFree',
    :'ten_dlc' => :'tenDLC',
    :'short_code' => :'shortCode'
  }
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



153
154
155
 
# File 'lib/freeclimb/models/capabilities.rb', line 153

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
67
68
69
70
 
# File 'lib/freeclimb/models/capabilities.rb', line 62

def self.openapi_nullable
  Set.new([
    :'voice',
    :'sms',
    :'toll_free',
    :'ten_dlc',
    :'short_code'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
 
# File 'lib/freeclimb/models/capabilities.rb', line 51

def self.openapi_types
  {
    :'voice' => :'Boolean',
    :'sms' => :'Boolean',
    :'toll_free' => :'Boolean',
    :'ten_dlc' => :'Boolean',
    :'short_code' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
134
135
136
 
# File 'lib/freeclimb/models/capabilities.rb', line 128

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      voice == o.voice &&
      sms == o.sms &&
      toll_free == o.toll_free &&
      ten_dlc == o.ten_dlc &&
      short_code == o.short_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



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
 
# File 'lib/freeclimb/models/capabilities.rb', line 183

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



254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/freeclimb/models/capabilities.rb', line 254

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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/freeclimb/models/capabilities.rb', line 160

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


140
141
142
 
# File 'lib/freeclimb/models/capabilities.rb', line 140

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



146
147
148
 
# File 'lib/freeclimb/models/capabilities.rb', line 146

def hash
  [voice, sms, toll_free, ten_dlc, short_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



110
111
112
113
 
# File 'lib/freeclimb/models/capabilities.rb', line 110

def list_invalid_properties
  invalid_properties = Array.new
  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



230
231
232
 
# File 'lib/freeclimb/models/capabilities.rb', line 230

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



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/freeclimb/models/capabilities.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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



224
225
226
 
# File 'lib/freeclimb/models/capabilities.rb', line 224

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



117
118
119
120
121
122
123
124
 
# File 'lib/freeclimb/models/capabilities.rb', line 117

def valid?
  
  if @voice.nil?
    false
  else
    list_invalid_properties.length() == 0
  end
end