class PureCloud::CreateWebChatConversationRequest

Attributes

deployment_id[RW]

The web chat Deployment ID which contains the appropriate settings for this chat conversation.

journey_context[RW]

A subset of the Journey System's data relevant to this conversation/session request (for external linkage and internal usage/context).

member_auth_token[RW]

If the guest member is an authenticated member (ie, not anonymous) his JWT is provided here. The token will have been previously generated with the "POST /api/v2/signeddata" resource.

member_info[RW]

The guest member info to use for the new chat conversation.

organization_id[RW]

The organization identifier.

routing_target[RW]

The routing information to use for the new chat conversation.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/create_web_chat_conversation_request.rb, line 40
def self.attribute_map
  {
    
    :'organization_id' => :'organizationId',
    
    :'deployment_id' => :'deploymentId',
    
    :'routing_target' => :'routingTarget',
    
    :'member_info' => :'memberInfo',
    
    :'member_auth_token' => :'memberAuthToken',
    
    :'journey_context' => :'journeyContext'
    
  }
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_web_chat_conversation_request.rb, line 79
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?(:'organizationId')
    
    
    self.organization_id = attributes[:'organizationId']
    
  
  end

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/create_web_chat_conversation_request.rb, line 59
def self.swagger_types
  {
    
    :'organization_id' => :'String',
    
    :'deployment_id' => :'String',
    
    :'routing_target' => :'WebChatRoutingTarget',
    
    :'member_info' => :'GuestMemberInfo',
    
    :'member_auth_token' => :'String',
    
    :'journey_context' => :'JourneyContext'
    
  }
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_web_chat_conversation_request.rb, line 234
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      organization_id == o.organization_id &&
      deployment_id == o.deployment_id &&
      routing_target == o.routing_target &&
      member_info == o.member_info &&
      member_auth_token == o.member_auth_token &&
      journey_context == o.journey_context
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/create_web_chat_conversation_request.rb, line 277
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_web_chat_conversation_request.rb, line 337
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_web_chat_conversation_request.rb, line 258
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_web_chat_conversation_request.rb, line 247
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_web_chat_conversation_request.rb, line 253
def hash
  [organization_id, deployment_id, routing_target, member_info, member_auth_token, journey_context].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_web_chat_conversation_request.rb, line 144
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_web_chat_conversation_request.rb, line 320
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_web_chat_conversation_request.rb, line 325
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_web_chat_conversation_request.rb, line 315
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_web_chat_conversation_request.rb, line 153
def valid?
  
  
  if @organization_id.nil?
    return false
  end

  
  
  
  
  
  if @deployment_id.nil?
    return false
  end

  
  
  
  
  
  if @routing_target.nil?
    return false
  end

  
  
  
  
  
  if @member_info.nil?
    return false
  end

  
  
  
  
  
  
  
  
  
  
  
  
end