Class: Bandwidth::Diversion

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Diversion

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
119
120
121
122
123
124
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 83

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
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_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: " + acceptable_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

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 58

def self.acceptable_attributes
  acceptable_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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 170

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



76
77
78
79
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 76

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 63

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



143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 143

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



163
164
165
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 163

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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 192

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



136
137
138
139
 
# File 'lib/bandwidth-sdk/models/diversion.rb', line 136

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