Class: PureCloud::CreateWebChatRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/models/create_web_chat_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateWebChatRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 70

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?(:'provider')
    self.provider = attributes[:'provider']
  end

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

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

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

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

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

end

Instance Attribute Details

#attributes ⇒ Object

The list of attributes to associate with the customer participant.



37
38
39
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 37

def attributes
  @attributes
end

#customer_name ⇒ Object

The name of the customer participating in the web chat.



40
41
42
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 40

def customer_name
  @customer_name
end

#language_id ⇒ Object

The ID of the langauge to use for routing.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 31

def language_id
  @language_id
end

#priority ⇒ Object

The priority to assign to the conversation for routing.



34
35
36
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 34

def priority
  @priority
end

#provider ⇒ Object

The name of the provider that is sourcing the web chat.



25
26
27
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 25

def provider
  @provider
end

#queue_id ⇒ Object

The ID of the queue to use for routing the chat conversation.



22
23
24
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 22

def queue_id
  @queue_id
end

#skill_ids ⇒ Object

The list of skill ID’s to use for routing.



28
29
30
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 28

def skill_ids
  @skill_ids
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 43

def self.attribute_map
  {
    :'queue_id' => :'queueId',
    :'provider' => :'provider',
    :'skill_ids' => :'skillIds',
    :'language_id' => :'languageId',
    :'priority' => :'priority',
    :'attributes' => :'attributes',
    :'customer_name' => :'customerName'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 56

def self.swagger_types
  {
    :'queue_id' => :'String',
    :'provider' => :'String',
    :'skill_ids' => :'Array<String>',
    :'language_id' => :'String',
    :'priority' => :'Integer',
    :'attributes' => :'Hash<String, String>',
    :'customer_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 132

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      queue_id == o.queue_id &&
      provider == o.provider &&
      skill_ids == o.skill_ids &&
      language_id == o.language_id &&
      priority == o.priority &&
      attributes == o.attributes &&
      customer_name == o.customer_name
end

#_deserialize(type, value) ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 176

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) ⇒ Object

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



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 236

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) ⇒ Object

build the object from hash



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 157

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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


146
147
148
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 146

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



152
153
154
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 152

def hash
  [queue_id, provider, skill_ids, language_id, priority, attributes, customer_name].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



112
113
114
115
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 112

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Object

to_body is an alias to to_body (backward compatibility))



219
220
221
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 219

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



224
225
226
227
228
229
230
231
232
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 224

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 ⇒ Object 



214
215
216
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 214

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



119
120
121
122
123
124
125
126
127
128
 
# File 'lib/purecloudplatformclientv2/models/create_web_chat_request.rb', line 119

def valid?
  if @queue_id.nil?
    return false
  end

  if @provider.nil?
    return false
  end

end