Class: Freeclimb::OutDial

Inherits:
PerclCommand show all
Defined in:
lib/freeclimb/models/out_dial.rb

Overview

The OutDial command is used to call a phone number

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from PerclCommand

#command

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PerclCommand

openapi_discriminator_name, #to_percl_hash

Constructor Details

#initialize(attributes = {}) ⇒ OutDial

Initializes the object

Parameters:

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

    Model attributes in the form of hash



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/freeclimb/models/out_dial.rb', line 119

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

  # call parent's initialize
  super

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

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

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

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

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

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

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

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

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

  if attributes.key?(:privacy_mode)
    self.privacy_mode = attributes[:privacy_mode]
  end
  self.command = "OutDial"
end

Instance Attribute Details

#action_url ⇒ Object

URL to which FreeClimb sends an HTTP POST request.



18
19
20
 
# File 'lib/freeclimb/models/out_dial.rb', line 18

def action_url
  @action_url
end

#call_connect_url ⇒ Object

URL to which FreeClimb makes an HTTP POST request informing the result of the OutDial.



21
22
23
 
# File 'lib/freeclimb/models/out_dial.rb', line 21

def call_connect_url
  @call_connect_url
end

#calling_number ⇒ Object

he caller ID to show to the called party when FreeClimb calls. This can be one of the following: The To or From number provided in the first Webhook to your webserver. Any phone number you have purchased from FreeClimb.



24
25
26
 
# File 'lib/freeclimb/models/out_dial.rb', line 24

def calling_number
  @calling_number
end

#destination ⇒ Object

E.164 representation of the phone number to Call.



27
28
29
 
# File 'lib/freeclimb/models/out_dial.rb', line 27

def destination
  @destination
end

#if_machine ⇒ Object

Returns the value of attribute if_machine.



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

def if_machine
  @if_machine
end

#if_machine_url ⇒ Object

When the ‘ifMachine` flag is set to `redirect`, this attribute specifies a URL to which FreeClimb makes a POST request when an answering machine or a fax machine is detected. This URL is required if the `ifMachine` flag is set to `redirect`. Otherwise, it should not be included.



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

def if_machine_url
  @if_machine_url
end

#privacy_mode ⇒ Object

Parameter ‘privacyMode` will not log the `text` as required by PCI compliance.



44
45
46
 
# File 'lib/freeclimb/models/out_dial.rb', line 44

def privacy_mode
  @privacy_mode
end

#send_digits ⇒ Object

DTMF tones to play to the outdialed Call. This is typically used to dial a number and then dial an extension.



35
36
37
 
# File 'lib/freeclimb/models/out_dial.rb', line 35

def send_digits
  @send_digits
end

#status_callback_url ⇒ Object

When the outdialed Call leg terminates, FreeClimb sends a ‘callStatus` Webhook to the `statusCallbackUrl`. This is a notification only; any PerCL command returned is ignored.



38
39
40
 
# File 'lib/freeclimb/models/out_dial.rb', line 38

def status_callback_url
  @status_callback_url
end

#timeout ⇒ Object

Maximum time in seconds the ‘OutDial` command waits for the called party to answer the Call. When a timeout occurs, FreeClimb invokes the `callConnectUrl` Webhook to report that the out-dialed Call has ended with a status of `noAnswer`.



41
42
43
 
# File 'lib/freeclimb/models/out_dial.rb', line 41

def timeout
  @timeout
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



85
86
87
 
# File 'lib/freeclimb/models/out_dial.rb', line 85

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/freeclimb/models/out_dial.rb', line 69

def self.attribute_map
  {
    action_url: :actionUrl,
    call_connect_url: :callConnectUrl,
    calling_number: :callingNumber,
    destination: :destination,
    if_machine: :ifMachine,
    if_machine_url: :ifMachineUrl,
    send_digits: :sendDigits,
    status_callback_url: :statusCallbackUrl,
    timeout: :timeout,
    privacy_mode: :privacyMode
  }
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



242
243
244
 
# File 'lib/freeclimb/models/out_dial.rb', line 242

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



111
112
113
114
115
 
# File 'lib/freeclimb/models/out_dial.rb', line 111

def self.openapi_all_of
  [
    :PerclCommand
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



106
107
108
 
# File 'lib/freeclimb/models/out_dial.rb', line 106

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

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/freeclimb/models/out_dial.rb', line 90

def self.openapi_types
  {
    action_url: :String,
    call_connect_url: :String,
    calling_number: :String,
    destination: :String,
    if_machine: :IfMachine,
    if_machine_url: :String,
    send_digits: :String,
    status_callback_url: :String,
    timeout: :Integer,
    privacy_mode: :Boolean
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/freeclimb/models/out_dial.rb', line 212

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    action_url == other.action_url &&
    call_connect_url == other.call_connect_url &&
    calling_number == other.calling_number &&
    destination == other.destination &&
    if_machine == other.if_machine &&
    if_machine_url == other.if_machine_url &&
    send_digits == other.send_digits &&
    status_callback_url == other.status_callback_url &&
    timeout == other.timeout &&
    privacy_mode == other.privacy_mode && super
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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/freeclimb/models/out_dial.rb', line 273

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



344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/freeclimb/models/out_dial.rb', line 344

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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/freeclimb/models/out_dial.rb', line 249

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

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


229
230
231
 
# File 'lib/freeclimb/models/out_dial.rb', line 229

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



235
236
237
 
# File 'lib/freeclimb/models/out_dial.rb', line 235

def hash
  [action_url, call_connect_url, calling_number, destination, if_machine, if_machine_url, send_digits, status_callback_url, timeout, privacy_mode].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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/freeclimb/models/out_dial.rb', line 179

def list_invalid_properties
  invalid_properties = super
  if @action_url.nil?
    invalid_properties.push('invalid value for "action_url", action_url cannot be nil.')
  end

  if @call_connect_url.nil?
    invalid_properties.push('invalid value for "call_connect_url", call_connect_url cannot be nil.')
  end

  if @calling_number.nil?
    invalid_properties.push('invalid value for "calling_number", calling_number cannot be nil.')
  end

  if @destination.nil?
    invalid_properties.push('invalid value for "destination", destination cannot be nil.')
  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



320
321
322
 
# File 'lib/freeclimb/models/out_dial.rb', line 320

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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/freeclimb/models/out_dial.rb', line 326

def to_hash
  hash = super
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



314
315
316
 
# File 'lib/freeclimb/models/out_dial.rb', line 314

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



202
203
204
205
206
207
208
 
# File 'lib/freeclimb/models/out_dial.rb', line 202

def valid?
  if @action_url.nil?
    false
  else
    list_invalid_properties.length == 0
  end
end