purecloud 0.57.1 → 0.58.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/config-ruby.json +1 -1
  4. data/doc_out/CreateCallbackCommand.html.md +0 -2
  5. data/doc_out/CreateQueueRequest.html.md +1 -0
  6. data/doc_out/DomainOrganizationRole.html.md +1 -1
  7. data/doc_out/DomainOrganizationRoleCreate.html.md +1 -1
  8. data/doc_out/DomainOrganizationRoleUpdate.html.md +1 -1
  9. data/doc_out/JsonNode.html.md +3 -3
  10. data/doc_out/Location.html.md +5 -9
  11. data/doc_out/LocationDefinition.html.md +21 -0
  12. data/doc_out/LocationsApi.html.md +4 -4
  13. data/doc_out/LocationsSearchResponse.html.md +1 -1
  14. data/doc_out/Queue.html.md +1 -0
  15. data/doc_out/QueueEmailAddress.html.md +14 -0
  16. data/doc_out/RecordingApi.html.md +8 -6
  17. data/doc_out/RoutingApi.html.md +13 -3
  18. data/doc_out/Site.html.md +1 -1
  19. data/doc_out/User.html.md +1 -0
  20. data/doc_out/UserMe.html.md +2 -1
  21. data/doc_out/UserQueue.html.md +1 -0
  22. data/doc_out/index.html.md +3 -3
  23. data/lib/purecloud.rb +2 -0
  24. data/lib/purecloud/api/locations_api.rb +6 -6
  25. data/lib/purecloud/api/recording_api.rb +12 -10
  26. data/lib/purecloud/api/routing_api.rb +12 -0
  27. data/lib/purecloud/api_client.rb +1 -1
  28. data/lib/purecloud/models/create_callback_command.rb +1 -25
  29. data/lib/purecloud/models/create_queue_request.rb +11 -1
  30. data/lib/purecloud/models/domain_organization_role.rb +13 -13
  31. data/lib/purecloud/models/domain_organization_role_create.rb +13 -13
  32. data/lib/purecloud/models/domain_organization_role_update.rb +13 -13
  33. data/lib/purecloud/models/json_node.rb +32 -32
  34. data/lib/purecloud/models/location.rb +27 -81
  35. data/lib/purecloud/models/location_definition.rb +261 -0
  36. data/lib/purecloud/models/locations_search_response.rb +1 -1
  37. data/lib/purecloud/models/queue.rb +11 -1
  38. data/lib/purecloud/models/queue_email_address.rb +175 -0
  39. data/lib/purecloud/models/site.rb +1 -1
  40. data/lib/purecloud/models/user.rb +14 -1
  41. data/lib/purecloud/models/user_me.rb +22 -9
  42. data/lib/purecloud/models/user_queue.rb +11 -1
  43. data/lib/purecloud/version.rb +1 -1
  44. data/newVersion.md +1 -1
  45. data/swagger.json +1 -1
  46. data/version.json +1 -1
  47. metadata +6 -2
@@ -81,7 +81,7 @@ module PureCloud
81
81
  :'current_page' => :'String',
82
82
  :'next_page' => :'String',
83
83
  :'types' => :'Array<String>',
84
- :'results' => :'Array<Location>'
84
+ :'results' => :'Array<LocationDefinition>'
85
85
 
86
86
  }
87
87
  end
@@ -64,6 +64,8 @@ module PureCloud
64
64
  # The phone number to use for caller identification for outbound calls from this queue.
65
65
  attr_accessor :calling_party_number
66
66
 
67
+ attr_accessor :outbound_email_address
68
+
67
69
  attr_accessor :member_count
68
70
 
69
71
  # The URI for this object
@@ -109,6 +111,8 @@ module PureCloud
109
111
 
110
112
  :'calling_party_number' => :'callingPartyNumber',
111
113
 
114
+ :'outbound_email_address' => :'outboundEmailAddress',
115
+
112
116
  :'member_count' => :'memberCount',
113
117
 
114
118
  :'self_uri' => :'selfUri'
@@ -137,6 +141,7 @@ module PureCloud
137
141
  :'queue_flow' => :'UriReference',
138
142
  :'calling_party_name' => :'String',
139
143
  :'calling_party_number' => :'String',
144
+ :'outbound_email_address' => :'QueueEmailAddress',
140
145
  :'member_count' => :'Integer',
141
146
  :'self_uri' => :'String'
142
147
 
@@ -224,6 +229,10 @@ module PureCloud
224
229
  self.calling_party_number = attributes[:'callingPartyNumber']
225
230
  end
226
231
 
232
+ if attributes[:'outboundEmailAddress']
233
+ self.outbound_email_address = attributes[:'outboundEmailAddress']
234
+ end
235
+
227
236
  if attributes[:'memberCount']
228
237
  self.member_count = attributes[:'memberCount']
229
238
  end
@@ -274,6 +283,7 @@ module PureCloud
274
283
  queue_flow == o.queue_flow &&
275
284
  calling_party_name == o.calling_party_name &&
276
285
  calling_party_number == o.calling_party_number &&
286
+ outbound_email_address == o.outbound_email_address &&
277
287
  member_count == o.member_count &&
278
288
  self_uri == o.self_uri
279
289
  end
@@ -285,7 +295,7 @@ module PureCloud
285
295
 
286
296
  # Calculate hash code according to all attributes.
287
297
  def hash
288
- [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, media_settings, bullseye, acw_settings, skill_evaluation_method, queue_flow, calling_party_name, calling_party_number, member_count, self_uri].hash
298
+ [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, media_settings, bullseye, acw_settings, skill_evaluation_method, queue_flow, calling_party_name, calling_party_number, outbound_email_address, member_count, self_uri].hash
289
299
  end
290
300
 
291
301
  # build the object from hash
@@ -0,0 +1,175 @@
1
+ =begin
2
+ PureCloud Platform API
3
+
4
+ With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
5
+
6
+ OpenAPI spec version: v2
7
+ Contact: DeveloperEvangelists@inin.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+
10
+ License: ININ
11
+ http://www.inin.com
12
+
13
+ Terms of Service: https://developer.mypurecloud.com/tos
14
+
15
+ =end
16
+
17
+ require 'date'
18
+
19
+ module PureCloud
20
+ class QueueEmailAddress
21
+ attr_accessor :domain
22
+
23
+ attr_accessor :route
24
+
25
+ # Attribute mapping from ruby-style variable name to JSON key.
26
+ def self.attribute_map
27
+ {
28
+
29
+ :'domain' => :'domain',
30
+
31
+ :'route' => :'route'
32
+
33
+ }
34
+ end
35
+
36
+ # Attribute type mapping.
37
+ def self.swagger_types
38
+ {
39
+ :'domain' => :'UriReference',
40
+ :'route' => :'UriReference'
41
+
42
+ }
43
+ end
44
+
45
+ def initialize(attributes = {})
46
+ return unless attributes.is_a?(Hash)
47
+
48
+ # convert string to symbol for hash key
49
+ attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
50
+
51
+
52
+ if attributes[:'domain']
53
+ self.domain = attributes[:'domain']
54
+ end
55
+
56
+ if attributes[:'route']
57
+ self.route = attributes[:'route']
58
+ end
59
+
60
+ end
61
+
62
+ # Check equality by comparing each attribute.
63
+ def ==(o)
64
+ return true if self.equal?(o)
65
+ self.class == o.class &&
66
+ domain == o.domain &&
67
+ route == o.route
68
+ end
69
+
70
+ # @see the `==` method
71
+ def eql?(o)
72
+ self == o
73
+ end
74
+
75
+ # Calculate hash code according to all attributes.
76
+ def hash
77
+ [domain, route].hash
78
+ end
79
+
80
+ # build the object from hash
81
+ def build_from_hash(attributes)
82
+ return nil unless attributes.is_a?(Hash)
83
+ self.class.swagger_types.each_pair do |key, type|
84
+ if type =~ /^Array<(.*)>/i
85
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
86
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
87
+ else
88
+ #TODO show warning in debug mode
89
+ end
90
+ elsif !attributes[self.class.attribute_map[key]].nil?
91
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
92
+ else
93
+ # data not found in attributes(hash), not an issue as the data can be optional
94
+ end
95
+ end
96
+
97
+ self
98
+ end
99
+
100
+ def _deserialize(type, value)
101
+ case type.to_sym
102
+ when :DateTime
103
+ DateTime.parse(value)
104
+ when :Date
105
+ Date.parse(value)
106
+ when :String
107
+ value.to_s
108
+ when :Integer
109
+ value.to_i
110
+ when :Float
111
+ value.to_f
112
+ when :BOOLEAN
113
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
114
+ true
115
+ else
116
+ false
117
+ end
118
+ when :Object
119
+ # generic object (usually a Hash), return directly
120
+ value
121
+ when /\AArray<(?<inner_type>.+)>\z/
122
+ inner_type = Regexp.last_match[:inner_type]
123
+ value.map { |v| _deserialize(inner_type, v) }
124
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
125
+ k_type = Regexp.last_match[:k_type]
126
+ v_type = Regexp.last_match[:v_type]
127
+ {}.tap do |hash|
128
+ value.each do |k, v|
129
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
130
+ end
131
+ end
132
+ else # model
133
+ _model = Object.const_get("PureCloud").const_get(type).new
134
+ _model.build_from_hash(value)
135
+ end
136
+ end
137
+
138
+ def to_s
139
+ to_hash.to_s
140
+ end
141
+
142
+ # to_body is an alias to to_body (backward compatibility))
143
+ def to_body
144
+ to_hash
145
+ end
146
+
147
+ # return the object in the form of hash
148
+ def to_hash
149
+ hash = {}
150
+ self.class.attribute_map.each_pair do |attr, param|
151
+ value = self.send(attr)
152
+ next if value.nil?
153
+ hash[param] = _to_hash(value)
154
+ end
155
+ hash
156
+ end
157
+
158
+ # Method to output non-array value in the form of hash
159
+ # For object, use to_hash. Otherwise, just return the value
160
+ def _to_hash(value)
161
+ if value.is_a?(Array)
162
+ value.compact.map{ |v| _to_hash(v) }
163
+ elsif value.is_a?(Hash)
164
+ {}.tap do |hash|
165
+ value.each { |k, v| hash[k] = _to_hash(v) }
166
+ end
167
+ elsif value.respond_to? :to_hash
168
+ value.to_hash
169
+ else
170
+ value
171
+ end
172
+ end
173
+
174
+ end
175
+ end
@@ -137,7 +137,7 @@ module PureCloud
137
137
  :'addresses' => :'Array<Contact>',
138
138
  :'edges' => :'Array<Edge>',
139
139
  :'edge_auto_update_config' => :'EdgeAutoUpdateConfig',
140
- :'location' => :'Location',
140
+ :'location' => :'LocationDefinition',
141
141
  :'managed' => :'BOOLEAN',
142
142
  :'self_uri' => :'String'
143
143
 
@@ -73,6 +73,9 @@ module PureCloud
73
73
  # Skills possessed by the user
74
74
  attr_accessor :profile_skills
75
75
 
76
+ # The user placement at each site location.
77
+ attr_accessor :locations
78
+
76
79
  # The URI for this object
77
80
  attr_accessor :self_uri
78
81
 
@@ -122,6 +125,8 @@ module PureCloud
122
125
 
123
126
  :'profile_skills' => :'profileSkills',
124
127
 
128
+ :'locations' => :'locations',
129
+
125
130
  :'self_uri' => :'selfUri'
126
131
 
127
132
  }
@@ -151,6 +156,7 @@ module PureCloud
151
156
  :'station' => :'UserStations',
152
157
  :'authorization' => :'UserAuthorization',
153
158
  :'profile_skills' => :'Array<String>',
159
+ :'locations' => :'Array<Location>',
154
160
  :'self_uri' => :'String'
155
161
 
156
162
  }
@@ -255,6 +261,12 @@ module PureCloud
255
261
  end
256
262
  end
257
263
 
264
+ if attributes[:'locations']
265
+ if (value = attributes[:'locations']).is_a?(Array)
266
+ self.locations = value
267
+ end
268
+ end
269
+
258
270
  if attributes[:'selfUri']
259
271
  self.self_uri = attributes[:'selfUri']
260
272
  end
@@ -295,6 +307,7 @@ module PureCloud
295
307
  station == o.station &&
296
308
  authorization == o.authorization &&
297
309
  profile_skills == o.profile_skills &&
310
+ locations == o.locations &&
298
311
  self_uri == o.self_uri
299
312
  end
300
313
 
@@ -305,7 +318,7 @@ module PureCloud
305
318
 
306
319
  # Calculate hash code according to all attributes.
307
320
  def hash
308
- [id, name, chat, department, email, primary_contact_info, addresses, state, title, username, manager, images, version, routing_status, presence, conversation_summary, out_of_office, geolocation, station, authorization, profile_skills, self_uri].hash
321
+ [id, name, chat, department, email, primary_contact_info, addresses, state, title, username, manager, images, version, routing_status, presence, conversation_summary, out_of_office, geolocation, station, authorization, profile_skills, locations, self_uri].hash
309
322
  end
310
323
 
311
324
  # build the object from hash
@@ -73,6 +73,9 @@ module PureCloud
73
73
  # Skills possessed by the user
74
74
  attr_accessor :profile_skills
75
75
 
76
+ # The user placement at each site location.
77
+ attr_accessor :locations
78
+
76
79
  # The PureCloud system date time.
77
80
  attr_accessor :date
78
81
 
@@ -85,8 +88,8 @@ module PureCloud
85
88
  # The first 100 presence definitions for user's organization.
86
89
  attr_accessor :presence_definitions
87
90
 
88
- # The first 100 locations for user's organization
89
- attr_accessor :locations
91
+ # The first 100 site locations for user's organization
92
+ attr_accessor :location_definitions
90
93
 
91
94
  # The first 100 organization roles, with applicable permission policies, for user's organization.
92
95
  attr_accessor :org_authorization
@@ -155,6 +158,8 @@ module PureCloud
155
158
 
156
159
  :'profile_skills' => :'profileSkills',
157
160
 
161
+ :'locations' => :'locations',
162
+
158
163
  :'date' => :'date',
159
164
 
160
165
  :'geolocation_settings' => :'geolocationSettings',
@@ -163,7 +168,7 @@ module PureCloud
163
168
 
164
169
  :'presence_definitions' => :'presenceDefinitions',
165
170
 
166
- :'locations' => :'locations',
171
+ :'location_definitions' => :'locationDefinitions',
167
172
 
168
173
  :'org_authorization' => :'orgAuthorization',
169
174
 
@@ -206,11 +211,12 @@ module PureCloud
206
211
  :'station' => :'UserStations',
207
212
  :'authorization' => :'UserAuthorization',
208
213
  :'profile_skills' => :'Array<String>',
214
+ :'locations' => :'Array<Location>',
209
215
  :'date' => :'ServerDate',
210
216
  :'geolocation_settings' => :'GeolocationSettings',
211
217
  :'organization' => :'Organization',
212
218
  :'presence_definitions' => :'Array<OrganizationPresence>',
213
- :'locations' => :'Array<Location>',
219
+ :'location_definitions' => :'Array<LocationDefinition>',
214
220
  :'org_authorization' => :'Array<DomainOrganizationRole>',
215
221
  :'favorites' => :'Array<User>',
216
222
  :'superiors' => :'Array<User>',
@@ -321,6 +327,12 @@ module PureCloud
321
327
  end
322
328
  end
323
329
 
330
+ if attributes[:'locations']
331
+ if (value = attributes[:'locations']).is_a?(Array)
332
+ self.locations = value
333
+ end
334
+ end
335
+
324
336
  if attributes[:'date']
325
337
  self.date = attributes[:'date']
326
338
  end
@@ -339,9 +351,9 @@ module PureCloud
339
351
  end
340
352
  end
341
353
 
342
- if attributes[:'locations']
343
- if (value = attributes[:'locations']).is_a?(Array)
344
- self.locations = value
354
+ if attributes[:'locationDefinitions']
355
+ if (value = attributes[:'locationDefinitions']).is_a?(Array)
356
+ self.location_definitions = value
345
357
  end
346
358
  end
347
359
 
@@ -419,11 +431,12 @@ module PureCloud
419
431
  station == o.station &&
420
432
  authorization == o.authorization &&
421
433
  profile_skills == o.profile_skills &&
434
+ locations == o.locations &&
422
435
  date == o.date &&
423
436
  geolocation_settings == o.geolocation_settings &&
424
437
  organization == o.organization &&
425
438
  presence_definitions == o.presence_definitions &&
426
- locations == o.locations &&
439
+ location_definitions == o.location_definitions &&
427
440
  org_authorization == o.org_authorization &&
428
441
  favorites == o.favorites &&
429
442
  superiors == o.superiors &&
@@ -440,7 +453,7 @@ module PureCloud
440
453
 
441
454
  # Calculate hash code according to all attributes.
442
455
  def hash
443
- [id, name, chat, department, email, primary_contact_info, addresses, state, title, username, manager, images, version, routing_status, presence, conversation_summary, out_of_office, geolocation, station, authorization, profile_skills, date, geolocation_settings, organization, presence_definitions, locations, org_authorization, favorites, superiors, direct_reports, adjacents, routing_skills, self_uri].hash
456
+ [id, name, chat, department, email, primary_contact_info, addresses, state, title, username, manager, images, version, routing_status, presence, conversation_summary, out_of_office, geolocation, station, authorization, profile_skills, locations, date, geolocation_settings, organization, presence_definitions, location_definitions, org_authorization, favorites, superiors, direct_reports, adjacents, routing_skills, self_uri].hash
444
457
  end
445
458
 
446
459
  # build the object from hash
@@ -64,6 +64,8 @@ module PureCloud
64
64
  # The phone number to use for caller identification for outbound calls from this queue.
65
65
  attr_accessor :calling_party_number
66
66
 
67
+ attr_accessor :outbound_email_address
68
+
67
69
  attr_accessor :joined
68
70
 
69
71
  attr_accessor :member_count
@@ -111,6 +113,8 @@ module PureCloud
111
113
 
112
114
  :'calling_party_number' => :'callingPartyNumber',
113
115
 
116
+ :'outbound_email_address' => :'outboundEmailAddress',
117
+
114
118
  :'joined' => :'joined',
115
119
 
116
120
  :'member_count' => :'memberCount',
@@ -141,6 +145,7 @@ module PureCloud
141
145
  :'queue_flow' => :'UriReference',
142
146
  :'calling_party_name' => :'String',
143
147
  :'calling_party_number' => :'String',
148
+ :'outbound_email_address' => :'QueueEmailAddress',
144
149
  :'joined' => :'BOOLEAN',
145
150
  :'member_count' => :'Integer',
146
151
  :'self_uri' => :'String'
@@ -229,6 +234,10 @@ module PureCloud
229
234
  self.calling_party_number = attributes[:'callingPartyNumber']
230
235
  end
231
236
 
237
+ if attributes[:'outboundEmailAddress']
238
+ self.outbound_email_address = attributes[:'outboundEmailAddress']
239
+ end
240
+
232
241
  if attributes[:'joined']
233
242
  self.joined = attributes[:'joined']
234
243
  else
@@ -285,6 +294,7 @@ module PureCloud
285
294
  queue_flow == o.queue_flow &&
286
295
  calling_party_name == o.calling_party_name &&
287
296
  calling_party_number == o.calling_party_number &&
297
+ outbound_email_address == o.outbound_email_address &&
288
298
  joined == o.joined &&
289
299
  member_count == o.member_count &&
290
300
  self_uri == o.self_uri
@@ -297,7 +307,7 @@ module PureCloud
297
307
 
298
308
  # Calculate hash code according to all attributes.
299
309
  def hash
300
- [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, media_settings, bullseye, acw_settings, skill_evaluation_method, queue_flow, calling_party_name, calling_party_number, joined, member_count, self_uri].hash
310
+ [id, name, description, version, date_created, date_modified, modified_by, created_by, state, modified_by_app, created_by_app, media_settings, bullseye, acw_settings, skill_evaluation_method, queue_flow, calling_party_name, calling_party_number, outbound_email_address, joined, member_count, self_uri].hash
301
311
  end
302
312
 
303
313
  # build the object from hash