Class: PureCloud::CreateEmailRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateEmailRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 95

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

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

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

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

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

  if attributes.has_key?(:'direction')
    self.direction = attributes[:'direction']
  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_email_request.rb', line 37

def attributes
  @attributes
end

#direction ⇒ Object

Specify INBOUND to create an inbound email conversation to route to a queue, or OUTBOUND to send an email on behalf of a queue.



55
56
57
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 55

def direction
  @direction
end

#from_address ⇒ Object

The email address of the sender of the email.



46
47
48
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 46

def from_address
  @from_address
end

#from_name ⇒ Object

The name of the sender of the email.



49
50
51
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 49

def from_name
  @from_name
end

#language_id ⇒ Object

The ID of the langauge to use for routing.



31
32
33
 
# File 'lib/purecloudplatformclientv2/models/create_email_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_email_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_email_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_email_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_email_request.rb', line 28

def skill_ids
  @skill_ids
end

#subject ⇒ Object

The subject of the email



52
53
54
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 52

def subject
  @subject
end

#to_address ⇒ Object

The email address of the recipient of the email.



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

def to_address
  @to_address
end

#to_name ⇒ Object

The name of the recipient of the email.



43
44
45
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 43

def to_name
  @to_name
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 58

def self.attribute_map
  {
    :'queue_id' => :'queueId',
    :'provider' => :'provider',
    :'skill_ids' => :'skillIds',
    :'language_id' => :'languageId',
    :'priority' => :'priority',
    :'attributes' => :'attributes',
    :'to_address' => :'toAddress',
    :'to_name' => :'toName',
    :'from_address' => :'fromAddress',
    :'from_name' => :'fromName',
    :'subject' => :'subject',
    :'direction' => :'direction'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 76

def self.swagger_types
  {
    :'queue_id' => :'String',
    :'provider' => :'String',
    :'skill_ids' => :'Array<String>',
    :'language_id' => :'String',
    :'priority' => :'Integer',
    :'attributes' => :'Hash<String, String>',
    :'to_address' => :'String',
    :'to_name' => :'String',
    :'from_address' => :'String',
    :'from_name' => :'String',
    :'subject' => :'String',
    :'direction' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 191

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 &&
      to_address == o.to_address &&
      to_name == o.to_name &&
      from_address == o.from_address &&
      from_name == o.from_name &&
      subject == o.subject &&
      direction == o.direction
end

#_deserialize(type, value) ⇒ Object 



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 240

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



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 300

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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 221

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


210
211
212
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 210

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



216
217
218
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 216

def hash
  [queue_id, provider, skill_ids, language_id, priority, attributes, to_address, to_name, from_address, from_name, subject, direction].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



157
158
159
160
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 157

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



283
284
285
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 283

def to_body
  to_hash
end

#to_hash ⇒ Object

return the object in the form of hash



288
289
290
291
292
293
294
295
296
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 288

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 



278
279
280
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 278

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



164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/purecloudplatformclientv2/models/create_email_request.rb', line 164

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

  if @provider.nil?
    return false
  end

  allowed_values = ["OUTBOUND", "INBOUND"]
  if @direction && !allowed_values.include?(@direction)
    return false
  end
end