class PureCloud::CreateOutboundMessagingConversationRequest

Attributes

external_contact_id[RW]

The external contact Id of the recipient of the message.

external_organization_id[RW]

The external organization Id of the recipient of the message.

queue_id[RW]

The ID of the queue to be associated with the message. This will determine the fromAddress of the message.

to_address[RW]

The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234

to_address_messenger_type[RW]

The messaging address messenger type.

use_existing_conversation[RW]

An override to use an existing conversation. If set to true, an existing conversation will be used if there is one within the conversation window. If set to false, create request fails if there is a conversation within the conversation window.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/purecloudplatformclientv2/models/create_outbound_messaging_conversation_request.rb, line 40
def self.attribute_map
  {
    
    :'queue_id' => :'queueId',
    
    :'to_address' => :'toAddress',
    
    :'to_address_messenger_type' => :'toAddressMessengerType',
    
    :'use_existing_conversation' => :'useExistingConversation',
    
    :'external_contact_id' => :'externalContactId',
    
    :'external_organization_id' => :'externalOrganizationId'
    
  }
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_outbound_messaging_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?(:'queueId')
    
    
    self.queue_id = attributes[:'queueId']
    
  
  end

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

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

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

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

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

  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloudplatformclientv2/models/create_outbound_messaging_conversation_request.rb, line 59
def self.swagger_types
  {
    
    :'queue_id' => :'String',
    
    :'to_address' => :'String',
    
    :'to_address_messenger_type' => :'String',
    
    :'use_existing_conversation' => :'BOOLEAN',
    
    :'external_contact_id' => :'String',
    
    :'external_organization_id' => :'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_outbound_messaging_conversation_request.rb, line 243
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      queue_id == o.queue_id &&
      to_address == o.to_address &&
      to_address_messenger_type == o.to_address_messenger_type &&
      use_existing_conversation == o.use_existing_conversation &&
      external_contact_id == o.external_contact_id &&
      external_organization_id == o.external_organization_id
end
_deserialize(type, value) click to toggle source
# File lib/purecloudplatformclientv2/models/create_outbound_messaging_conversation_request.rb, line 286
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_outbound_messaging_conversation_request.rb, line 346
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_outbound_messaging_conversation_request.rb, line 267
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_outbound_messaging_conversation_request.rb, line 256
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_outbound_messaging_conversation_request.rb, line 262
def hash
  [queue_id, to_address, to_address_messenger_type, use_existing_conversation, external_contact_id, external_organization_id].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_outbound_messaging_conversation_request.rb, line 144
def list_invalid_properties
  invalid_properties = Array.new
  
  
  return invalid_properties
end
to_address_messenger_type=(to_address_messenger_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] to_address_messenger_type Object to be assigned

# File lib/purecloudplatformclientv2/models/create_outbound_messaging_conversation_request.rb, line 215
def to_address_messenger_type=(to_address_messenger_type)
  allowed_values = ["sms", "facebook", "twitter", "line", "whatsapp", "webmessaging"]
  if to_address_messenger_type && !allowed_values.include?(to_address_messenger_type)
    fail ArgumentError, "invalid value for 'to_address_messenger_type', must be one of #{allowed_values}."
  end
  @to_address_messenger_type = to_address_messenger_type
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloudplatformclientv2/models/create_outbound_messaging_conversation_request.rb, line 329
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_outbound_messaging_conversation_request.rb, line 334
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_outbound_messaging_conversation_request.rb, line 324
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_outbound_messaging_conversation_request.rb, line 153
def valid?
  
  
  if @queue_id.nil?
    return false
  end

  
  
  
  
  
  if @to_address.nil?
    return false
  end

  
  
  
  
  
  if @to_address_messenger_type.nil?
    return false
  end

  
  
  allowed_values = ["sms", "facebook", "twitter", "line", "whatsapp", "webmessaging"]
  if @to_address_messenger_type && !allowed_values.include?(@to_address_messenger_type)
    return false
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
end