class Freeclimb::OutDialAllOf
Attributes
URL to which FreeClimb
sends an HTTP POST request.
E.164 representation of the phone number to Call.
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.
Parameter `privacyMode` will not log the `text` as required by PCI compliance.
DTMF tones to play to the outdialed Call. This is typically used to dial a number and then dial an extension.
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.
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`.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/freeclimb/models/out_dial_all_of.rb, line 48 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/freeclimb/models/out_dial_all_of.rb, line 206 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/freeclimb/models/out_dial_all_of.rb, line 87 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::OutDialAllOf` 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::OutDialAllOf`. 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?(:'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 end
List of attributes with nullable: true
# File lib/freeclimb/models/out_dial_all_of.rb, line 80 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/freeclimb/models/out_dial_all_of.rb, line 64 def self.openapi_types { :'action_url' => :'String', :'call_connect_url' => :'String', :'calling_number' => :'Float', :'destination' => :'Float', :'if_machine' => :'String', :'if_machine_url' => :'String', :'send_digits' => :'String', :'status_callback_url' => :'String', :'timeout' => :'Integer', :'privacy_mode' => :'Boolean' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/freeclimb/models/out_dial_all_of.rb, line 176 def ==(o) return true if self.equal?(o) self.class == o.class && action_url == o.action_url && call_connect_url == o.call_connect_url && calling_number == o.calling_number && destination == o.destination && if_machine == o.if_machine && if_machine_url == o.if_machine_url && send_digits == o.send_digits && status_callback_url == o.status_callback_url && timeout == o.timeout && privacy_mode == o.privacy_mode end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/freeclimb/models/out_dial_all_of.rb, line 234 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/freeclimb/models/out_dial_all_of.rb, line 303 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/freeclimb/models/out_dial_all_of.rb, line 213 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
@see the `==` method @param [Object] Object to be compared
# File lib/freeclimb/models/out_dial_all_of.rb, line 193 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/freeclimb/models/out_dial_all_of.rb, line 199 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/freeclimb/models/out_dial_all_of.rb, line 143 def list_invalid_properties invalid_properties = Array.new 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
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/freeclimb/models/out_dial_all_of.rb, line 285 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/freeclimb/models/out_dial_all_of.rb, line 273 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/freeclimb/models/out_dial_all_of.rb, line 166 def valid? return false if @action_url.nil? return false if @call_connect_url.nil? return false if @calling_number.nil? return false if @destination.nil? true end