Class: Freeclimb::MakeCallRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MakeCallRequest

Initializes the object



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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/freeclimb/models/make_call_request.rb', line 77

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

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

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

  if attributes.key?(:'send_digits')
    self.send_digits = attributes[:'send_digits']
  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?(:'timeout')
    self.timeout = attributes[:'timeout']
  end

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

Instance Attribute Details

#application_id ⇒ Object

ID of the application FreeClimb should use to handle this phone call. FreeClimb will use the ‘callConnectUrl` and `statusCallbackUrl` set on the application. The application must have a `callConnectUrl` associated with it or an error will be returned. The application’s `voiceUrl` parameter is not used for outbound calls.



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

def application_id
  @application_id
end

#from ⇒ Object

Phone number to use as the caller ID. This can be: (a) The To or From number provided in FreeClimb’s initial request to your app or (b) Any incoming phone number you have purchased from FreeClimb.



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

def from
  @from
end

#if_machine ⇒ Object

Specifies how FreeClimb should handle this Call if an answering machine answers it.



30
31
32
 
# File 'lib/freeclimb/models/make_call_request.rb', line 30

def if_machine
  @if_machine
end

#if_machine_url ⇒ Object

This attribute specifies a URL to which FreeClimb will make 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. When ifMachine is set to hangup, ifMachineUrl must not be included in the request. For more information, see **ifMachineUrl example** below.



33
34
35
 
# File 'lib/freeclimb/models/make_call_request.rb', line 33

def if_machine_url
  @if_machine_url
end

#parent_call_id ⇒ Object

The ID of the parent Call in the case that this new Call is meant to be treated as a child of an existing Call. This attribute should be included when possible to reduce latency when adding child calls to Conferences containing the parent Call. A call can only be used as a parent once the call is in progress or as an inbound call that is still ringing. An outbound call is considered to be in progress once the outdialConnect or outdialApiConnect webhook is invoked. An inbound call is ringing when the inbound webhook is invoked.



39
40
41
 
# File 'lib/freeclimb/models/make_call_request.rb', line 39

def parent_call_id
  @parent_call_id
end

#send_digits ⇒ Object

String of digits to dial after connecting to the number. It can include digits ‘0-9`, `*`, and `#`, and allows embedding a pause between the output of individual digits. The default pause is 500 milliseconds. So, a string such as 1234# will be played in 2 seconds because of the 4 standard pauses implied within the string. A custom pause is specified by including a positive integer wrapped in curly braces: n. For more information, see **sendDigits examples** below.



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

def send_digits
  @send_digits
end

#timeout ⇒ Object

Number of seconds that FreeClimb should allow the phone to ring before assuming there is no answer. Default is 30 seconds. Maximum allowed ring-time is determined by the target phone’s provider. Note that most providers limit ring-time to 120 seconds.



36
37
38
 
# File 'lib/freeclimb/models/make_call_request.rb', line 36

def timeout
  @timeout
end

#to ⇒ Object

Phone number to place the Call to.



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

def to
  @to
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/freeclimb/models/make_call_request.rb', line 42

def self.attribute_map
  {
    :'from' => :'from',
    :'to' => :'to',
    :'application_id' => :'applicationId',
    :'send_digits' => :'sendDigits',
    :'if_machine' => :'ifMachine',
    :'if_machine_url' => :'ifMachineUrl',
    :'timeout' => :'timeout',
    :'parent_call_id' => :'parentCallId'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



181
182
183
 
# File 'lib/freeclimb/models/make_call_request.rb', line 181

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



70
71
72
73
 
# File 'lib/freeclimb/models/make_call_request.rb', line 70

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

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/freeclimb/models/make_call_request.rb', line 56

def self.openapi_types
  {
    :'from' => :'String',
    :'to' => :'String',
    :'application_id' => :'String',
    :'send_digits' => :'String',
    :'if_machine' => :'String',
    :'if_machine_url' => :'String',
    :'timeout' => :'Integer',
    :'parent_call_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/freeclimb/models/make_call_request.rb', line 153

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      from == o.from &&
      to == o.to &&
      application_id == o.application_id &&
      send_digits == o.send_digits &&
      if_machine == o.if_machine &&
      if_machine_url == o.if_machine_url &&
      timeout == o.timeout &&
      parent_call_id == o.parent_call_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



209
210
211
212
213
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
 
# File 'lib/freeclimb/models/make_call_request.rb', line 209

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
    Freeclimb.const_get(type).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



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/freeclimb/models/make_call_request.rb', line 278

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/freeclimb/models/make_call_request.rb', line 188

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


168
169
170
 
# File 'lib/freeclimb/models/make_call_request.rb', line 168

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



174
175
176
 
# File 'lib/freeclimb/models/make_call_request.rb', line 174

def hash
  [from, to, application_id, send_digits, if_machine, if_machine_url, timeout, parent_call_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/freeclimb/models/make_call_request.rb', line 125

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



254
255
256
 
# File 'lib/freeclimb/models/make_call_request.rb', line 254

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/freeclimb/models/make_call_request.rb', line 260

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



248
249
250
 
# File 'lib/freeclimb/models/make_call_request.rb', line 248

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



144
145
146
147
148
149
 
# File 'lib/freeclimb/models/make_call_request.rb', line 144

def valid?
  return false if @from.nil?
  return false if @to.nil?
  return false if @application_id.nil?
  true
end