class Freeclimb::AddToConferenceAllOf
Attributes
If `true`, Call control will be enabled for this Participant's Call leg.
Defines a sequence of digits that, when entered by this caller, invokes the `callControlUrl`. Only digits plus '*', and '#' may be used.
URL to be invoked when this Participant enters the digit sequence defined in the `callControlSequence` attribute.
ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one.
ID of the Conference to which to add the Participant (Call leg). Conference must exist or an error will result.
URL to be invoked when the Participant leaves the Conference.
If `true`, the Participant joins the Conference with listen privileges. This may be modified later via the REST API or `SetListen` PerCL command.
When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters.
Flag that indicates whether a Conference starts upon entry of this particular Participant. This is usually set to `true` for moderators and `false` for all other Participants.
If `true`, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or `SetTalk` PerCL command.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/freeclimb/models/add_to_conference_all_of.rb, line 48 def self.attribute_map { :'allow_call_control' => :'allowCallControl', :'call_control_sequence' => :'callControlSequence', :'call_control_url' => :'callControlUrl', :'conference_id' => :'conferenceId', :'call_id' => :'callId', :'leave_conference_url' => :'leaveConferenceUrl', :'listen' => :'listen', :'notification_url' => :'notificationUrl', :'start_conf_on_enter' => :'startConfOnEnter', :'talk' => :'talk' } 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/add_to_conference_all_of.rb, line 196 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/add_to_conference_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::AddToConferenceAllOf` 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::AddToConferenceAllOf`. 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?(:'allow_call_control') self.allow_call_control = attributes[:'allow_call_control'] end if attributes.key?(:'call_control_sequence') self.call_control_sequence = attributes[:'call_control_sequence'] end if attributes.key?(:'call_control_url') self.call_control_url = attributes[:'call_control_url'] end if attributes.key?(:'conference_id') self.conference_id = attributes[:'conference_id'] end if attributes.key?(:'call_id') self.call_id = attributes[:'call_id'] end if attributes.key?(:'leave_conference_url') self.leave_conference_url = attributes[:'leave_conference_url'] end if attributes.key?(:'listen') self.listen = attributes[:'listen'] end if attributes.key?(:'notification_url') self.notification_url = attributes[:'notification_url'] end if attributes.key?(:'start_conf_on_enter') self.start_conf_on_enter = attributes[:'start_conf_on_enter'] end if attributes.key?(:'talk') self.talk = attributes[:'talk'] end end
List of attributes with nullable: true
# File lib/freeclimb/models/add_to_conference_all_of.rb, line 80 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/freeclimb/models/add_to_conference_all_of.rb, line 64 def self.openapi_types { :'allow_call_control' => :'Boolean', :'call_control_sequence' => :'String', :'call_control_url' => :'String', :'conference_id' => :'String', :'call_id' => :'Boolean', :'leave_conference_url' => :'String', :'listen' => :'Boolean', :'notification_url' => :'String', :'start_conf_on_enter' => :'Boolean', :'talk' => :'Boolean' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/freeclimb/models/add_to_conference_all_of.rb, line 166 def ==(o) return true if self.equal?(o) self.class == o.class && allow_call_control == o.allow_call_control && call_control_sequence == o.call_control_sequence && call_control_url == o.call_control_url && conference_id == o.conference_id && call_id == o.call_id && leave_conference_url == o.leave_conference_url && listen == o.listen && notification_url == o.notification_url && start_conf_on_enter == o.start_conf_on_enter && talk == o.talk 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/add_to_conference_all_of.rb, line 224 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/add_to_conference_all_of.rb, line 293 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/add_to_conference_all_of.rb, line 203 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/add_to_conference_all_of.rb, line 183 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/freeclimb/models/add_to_conference_all_of.rb, line 189 def hash [allow_call_control, call_control_sequence, call_control_url, conference_id, call_id, leave_conference_url, listen, notification_url, start_conf_on_enter, talk].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/add_to_conference_all_of.rb, line 143 def list_invalid_properties invalid_properties = Array.new if @conference_id.nil? invalid_properties.push('invalid value for "conference_id", conference_id cannot be nil.') end if @call_id.nil? invalid_properties.push('invalid value for "call_id", call_id 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/add_to_conference_all_of.rb, line 275 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/add_to_conference_all_of.rb, line 263 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/add_to_conference_all_of.rb, line 158 def valid? return false if @conference_id.nil? return false if @call_id.nil? true end