class PureCloud::CreateCallRequest

Attributes

call_from_queue_id[RW]

The queue ID to call on behalf of.

call_queue_id[RW]

The queue ID to call.

call_user_id[RW]

The user ID to call.

caller_id[RW]

The caller id phone number for this outbound call.

caller_id_name[RW]

The caller id name for this outbound call.

conversation_ids[RW]

The list of existing call conversations to merge into a new ad-hoc conference.

language_id[RW]

The language skill ID to use for routing this call (if calling a queue).

participants[RW]

The list of participants to call to create a new ad-hoc conference.

phone_number[RW]

The phone number to dial.

priority[RW]

The priority to assign to this call (if calling a queue).

routing_skills_ids[RW]

The skill ID's to use for routing this call (if calling a queue).

uui_data[RW]

User to User Information (UUI) data managed by SIP session application.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/create_call_request.rb, line 58
def self.attribute_map
  {
    
    :'phone_number' => :'phoneNumber',
    
    :'caller_id' => :'callerId',
    
    :'caller_id_name' => :'callerIdName',
    
    :'call_from_queue_id' => :'callFromQueueId',
    
    :'call_queue_id' => :'callQueueId',
    
    :'call_user_id' => :'callUserId',
    
    :'priority' => :'priority',
    
    :'language_id' => :'languageId',
    
    :'routing_skills_ids' => :'routingSkillsIds',
    
    :'conversation_ids' => :'conversationIds',
    
    :'participants' => :'participants',
    
    :'uui_data' => :'uuiData'
    
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/purecloudplatformclientv2/models/create_call_request.rb, line 121
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?(:'phoneNumber')
    
    
    self.phone_number = attributes[:'phoneNumber']
    
  
  end

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

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

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

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

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

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

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

  
  if attributes.has_key?(:'routingSkillsIds')
    
    if (value = attributes[:'routingSkillsIds']).is_a?(Array)
      self.routing_skills_ids = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'conversationIds')
    
    if (value = attributes[:'conversationIds']).is_a?(Array)
      self.conversation_ids = value
    end
    
    
  
  end

  
  if attributes.has_key?(:'participants')
    
    if (value = attributes[:'participants']).is_a?(Array)
      self.participants = value
    end
    
    
  
  end

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/create_call_request.rb, line 89
def self.swagger_types
  {
    
    :'phone_number' => :'String',
    
    :'caller_id' => :'String',
    
    :'caller_id_name' => :'String',
    
    :'call_from_queue_id' => :'String',
    
    :'call_queue_id' => :'String',
    
    :'call_user_id' => :'String',
    
    :'priority' => :'Integer',
    
    :'language_id' => :'String',
    
    :'routing_skills_ids' => :'Array<String>',
    
    :'conversation_ids' => :'Array<String>',
    
    :'participants' => :'Array<Destination>',
    
    :'uui_data' => :'String'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/create_call_request.rb, line 370
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      phone_number == o.phone_number &&
      caller_id == o.caller_id &&
      caller_id_name == o.caller_id_name &&
      call_from_queue_id == o.call_from_queue_id &&
      call_queue_id == o.call_queue_id &&
      call_user_id == o.call_user_id &&
      priority == o.priority &&
      language_id == o.language_id &&
      routing_skills_ids == o.routing_skills_ids &&
      conversation_ids == o.conversation_ids &&
      participants == o.participants &&
      uui_data == o.uui_data
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/create_call_request.rb, line 419
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 =~ /^(true|t|yes|y|1)$/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
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

# File lib/purecloudplatformclientv2/models/create_call_request.rb, line 479
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) click to toggle source

build the object from hash

# File lib/purecloudplatformclientv2/models/create_call_request.rb, line 400
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/purecloudplatformclientv2/models/create_call_request.rb, line 389
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/purecloudplatformclientv2/models/create_call_request.rb, line 395
def hash
  [phone_number, caller_id, caller_id_name, call_from_queue_id, call_queue_id, call_user_id, priority, language_id, routing_skills_ids, conversation_ids, participants, uui_data].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons

# File lib/purecloudplatformclientv2/models/create_call_request.rb, line 246
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/create_call_request.rb, line 462
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloudplatformclientv2/models/create_call_request.rb, line 467
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() click to toggle source
# File lib/purecloudplatformclientv2/models/create_call_request.rb, line 457
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/purecloudplatformclientv2/models/create_call_request.rb, line 255
def valid?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end