Class: PhoneComClient::RuleSetForwardItem

Inherits:
Object
  • Object
show all
Defined in:
lib/phone_com_client/models/rule_set_forward_item.rb

Overview

Array of Forward Item Objects. See below for details. Required.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RuleSetForwardItem

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
69
70
71
72
73
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
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 67

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'extension')
    self.extension = attributes[:'extension']
  end

  if attributes.has_key?(:'number')
    self.number = attributes[:'number']
  end

  if attributes.has_key?(:'screening')
    self.screening = attributes[:'screening']
  else
    self.screening = false
  end

  if attributes.has_key?(:'caller_id')
    self.caller_id = attributes[:'caller_id']
  else
    self.caller_id = 'calling_number'
  end

  if attributes.has_key?(:'voice_tag')
    self.voice_tag = attributes[:'voice_tag']
  end

  if attributes.has_key?(:'distinctive_ring')
    self.distinctive_ring = attributes[:'distinctive_ring']
  end
end

Instance Attribute Details

#caller_id ⇒ Object

Optional. Must equal calling_number or called_number. Defines which phone number should be used for Caller ID. Default is calling_number.



31
32
33
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 31

def caller_id
  @caller_id
end

#distinctive_ring ⇒ Object

Optional. Must equal one of: DEFAULT, STYLE_2, STYLE_3, STYLE_4, STYLE_5, STYLE_6, STYLE_7, STYLE_8, or STYLE_9. Identifies the style of ring tone you will hear when an incoming call is waiting.



37
38
39
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 37

def distinctive_ring
  @distinctive_ring
end

#extension ⇒ Object

Required if type = "extension". Extension that callers should be directed to. Output is an Extension Summary Object. Input must be an Extension Lookup Object.



22
23
24
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 22

def extension
  @extension
end

#number ⇒ Object

Required if type = "phone_number". Phone number that callers should be directed to. Must be a string in E.164 format.



25
26
27
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 25

def number
  @number
end

#screening ⇒ Object

Boolean. Optional. Default is FALSE. Use this to activate call screening. If TRUE, the timeout on the parent action should be at least 30 seconds.



28
29
30
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 28

def screening
  @screening
end

#type ⇒ Object

Required. Must equal phone_number or extension.



19
20
21
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 19

def type
  @type
end

#voice_tag ⇒ Object

Optional string. If screening = TRUE, this value will be passed into our Text-To-Speech engine and used to inform the caller of who they have reached.



34
35
36
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 34

def voice_tag
  @voice_tag
end

Class Method Details

.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/phone_com_client/models/rule_set_forward_item.rb', line 40

def self.attribute_map
  {
    :'type' => :'type',
    :'extension' => :'extension',
    :'number' => :'number',
    :'screening' => :'screening',
    :'caller_id' => :'caller_id',
    :'voice_tag' => :'voice_tag',
    :'distinctive_ring' => :'distinctive_ring'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 53

def self.swagger_types
  {
    :'type' => :'String',
    :'extension' => :'ExtensionSummary',
    :'number' => :'String',
    :'screening' => :'BOOLEAN',
    :'caller_id' => :'String',
    :'voice_tag' => :'String',
    :'distinctive_ring' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      extension == o.extension &&
      number == o.number &&
      screening == o.screening &&
      caller_id == o.caller_id &&
      voice_tag == o.voice_tag &&
      distinctive_ring == o.distinctive_ring
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



214
215
216
217
218
219
220
221
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
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 214

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = PhoneComClient.const_get(type).new
    temp_model.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



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 280

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 193

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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


180
181
182
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 180

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



186
187
188
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 186

def hash
  [type, extension, number, screening, caller_id, voice_tag, distinctive_ring].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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 108

def list_invalid_properties
  invalid_properties = Array.new
  if !@type.nil? && @type !~ Regexp.new(/phone_number|extension/)
    invalid_properties.push('invalid value for "type", must conform to the pattern /phone_number|extension/.')
  end

  if !@caller_id.nil? && @caller_id !~ Regexp.new(/calling_number|called_number/)
    invalid_properties.push('invalid value for "caller_id", must conform to the pattern /calling_number|called_number/.')
  end

  if !@distinctive_ring.nil? && @distinctive_ring !~ Regexp.new(/DEFAULT|STYLE_2|STYLE_3|STYLE_4|STYLE_5|STYLE_6|STYLE_7|STYLE_8|STYLE_9/)
    invalid_properties.push('invalid value for "distinctive_ring", must conform to the pattern /DEFAULT|STYLE_2|STYLE_3|STYLE_4|STYLE_5|STYLE_6|STYLE_7|STYLE_8|STYLE_9/.')
  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



260
261
262
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 260

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



266
267
268
269
270
271
272
273
274
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 266

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



254
255
256
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 254

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



127
128
129
130
131
132
 
# File 'lib/phone_com_client/models/rule_set_forward_item.rb', line 127

def valid?
  return false if !@type.nil? && @type !~ Regexp.new(/phone_number|extension/)
  return false if !@caller_id.nil? && @caller_id !~ Regexp.new(/calling_number|called_number/)
  return false if !@distinctive_ring.nil? && @distinctive_ring !~ Regexp.new(/DEFAULT|STYLE_2|STYLE_3|STYLE_4|STYLE_5|STYLE_6|STYLE_7|STYLE_8|STYLE_9/)
  true
end