Class: Bandwidth::Diversion

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth-sdk/models/diversion.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Diversion

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 78

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

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

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

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

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

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

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

Instance Attribute Details

#counter ⇒ Object

The number of diversions that have occurred



28
29
30
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 28

def counter
  @counter
end

#limit ⇒ Object

The maximum number of diversions allowed for this session



31
32
33
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 31

def limit
  @limit
end

#orig_to ⇒ Object

Always present. Indicates the last telephone number that the call was diverted from.



37
38
39
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 37

def orig_to
  @orig_to
end

#privacy ⇒ Object

off or full



22
23
24
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 22

def privacy
  @privacy
end

#reason ⇒ Object

The reason for the diversion. Common values: unknown, user-busy, no-answer, unavailable, unconditional, time-of-day, do-not-disturb, deflection, follow-me, out-of-service, away.



19
20
21
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 19

def reason
  @reason
end

#screen ⇒ Object

No if the number was provided by the user, yes if the number was provided by the network



25
26
27
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 25

def screen
  @screen
end

#unknown ⇒ Object

The normal list of values is not exhaustive. Your application must be tolerant of unlisted keys and unlisted values of those keys.



34
35
36
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 34

def unknown
  @unknown
end

Class Method Details

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



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
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 188

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

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



53
54
55
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 53

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 40

def self.attribute_map
  {
    :'reason' => :'reason',
    :'privacy' => :'privacy',
    :'screen' => :'screen',
    :'counter' => :'counter',
    :'limit' => :'limit',
    :'unknown' => :'unknown',
    :'orig_to' => :'origTo'
  }
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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 164

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
74
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 71

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

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 58

def self.openapi_types
  {
    :'reason' => :'String',
    :'privacy' => :'String',
    :'screen' => :'String',
    :'counter' => :'String',
    :'limit' => :'String',
    :'unknown' => :'String',
    :'orig_to' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 137

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      reason == o.reason &&
      privacy == o.privacy &&
      screen == o.screen &&
      counter == o.counter &&
      limit == o.limit &&
      unknown == o.unknown &&
      orig_to == o.orig_to
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



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 259

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


151
152
153
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 151

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



157
158
159
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 157

def hash
  [reason, privacy, screen, counter, limit, unknown, orig_to].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



122
123
124
125
126
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 122

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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



235
236
237
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 235

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



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 241

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



229
230
231
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 229

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



130
131
132
133
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 130

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end