purecloudplatformclientv2 39.1.0 → 40.0.0

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 (38) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/AuthorizationApi.md +80 -0
  4. data/docs/CreateQueueRequest.md +1 -1
  5. data/docs/DomainOrganizationRole.md +1 -1
  6. data/docs/DomainOrganizationRoleCreate.md +1 -1
  7. data/docs/DomainOrganizationRoleUpdate.md +1 -1
  8. data/docs/ExternalContactsApi.md +3 -3
  9. data/docs/JsonNode.md +4 -4
  10. data/docs/QualityApi.md +1 -1
  11. data/docs/QueueRequest.md +37 -0
  12. data/docs/RoutingApi.md +5 -5
  13. data/docs/SubjectDivisionGrants.md +17 -0
  14. data/docs/SubjectDivisionGrantsEntityListing.md +22 -0
  15. data/docs/TimeZone.md +2 -2
  16. data/docs/UserQueue.md +0 -1
  17. data/docs/WritableDivision.md +15 -0
  18. data/lib/purecloudplatformclientv2.rb +4 -0
  19. data/lib/purecloudplatformclientv2/api/authorization_api.rb +119 -0
  20. data/lib/purecloudplatformclientv2/api/external_contacts_api.rb +2 -2
  21. data/lib/purecloudplatformclientv2/api/routing_api.rb +2 -2
  22. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  23. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +1 -1
  24. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
  25. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
  26. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
  27. data/lib/purecloudplatformclientv2/models/forecast_time_series_result.rb +2 -2
  28. data/lib/purecloudplatformclientv2/models/history_listing.rb +2 -2
  29. data/lib/purecloudplatformclientv2/models/json_node.rb +76 -76
  30. data/lib/purecloudplatformclientv2/models/operation.rb +2 -2
  31. data/lib/purecloudplatformclientv2/models/queue_request.rb +870 -0
  32. data/lib/purecloudplatformclientv2/models/subject_division_grants.rb +319 -0
  33. data/lib/purecloudplatformclientv2/models/subject_division_grants_entity_listing.rb +428 -0
  34. data/lib/purecloudplatformclientv2/models/time_zone.rb +24 -24
  35. data/lib/purecloudplatformclientv2/models/user_queue.rb +1 -27
  36. data/lib/purecloudplatformclientv2/models/writable_division.rb +253 -0
  37. data/lib/purecloudplatformclientv2/version.rb +1 -1
  38. metadata +10 -2
@@ -0,0 +1,319 @@
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@genesys.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 SubjectDivisionGrants
21
+ # The globally unique identifier for the object.
22
+ attr_accessor :id
23
+
24
+ attr_accessor :name
25
+
26
+ attr_accessor :divisions
27
+
28
+ attr_accessor :type
29
+
30
+ # The URI for this object
31
+ attr_accessor :self_uri
32
+
33
+ # Attribute mapping from ruby-style variable name to JSON key.
34
+ def self.attribute_map
35
+ {
36
+
37
+ :'id' => :'id',
38
+
39
+ :'name' => :'name',
40
+
41
+ :'divisions' => :'divisions',
42
+
43
+ :'type' => :'type',
44
+
45
+ :'self_uri' => :'selfUri'
46
+
47
+ }
48
+ end
49
+
50
+ # Attribute type mapping.
51
+ def self.swagger_types
52
+ {
53
+
54
+ :'id' => :'String',
55
+
56
+ :'name' => :'String',
57
+
58
+ :'divisions' => :'Array<Division>',
59
+
60
+ :'type' => :'String',
61
+
62
+ :'self_uri' => :'String'
63
+
64
+ }
65
+ end
66
+
67
+ # Initializes the object
68
+ # @param [Hash] attributes Model attributes in the form of hash
69
+ def initialize(attributes = {})
70
+ return unless attributes.is_a?(Hash)
71
+
72
+ # convert string to symbol for hash key
73
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
74
+
75
+
76
+ if attributes.has_key?(:'id')
77
+
78
+
79
+ self.id = attributes[:'id']
80
+
81
+
82
+ end
83
+
84
+
85
+ if attributes.has_key?(:'name')
86
+
87
+
88
+ self.name = attributes[:'name']
89
+
90
+
91
+ end
92
+
93
+
94
+ if attributes.has_key?(:'divisions')
95
+
96
+ if (value = attributes[:'divisions']).is_a?(Array)
97
+ self.divisions = value
98
+ end
99
+
100
+
101
+
102
+ end
103
+
104
+
105
+ if attributes.has_key?(:'type')
106
+
107
+
108
+ self.type = attributes[:'type']
109
+
110
+
111
+ end
112
+
113
+
114
+ if attributes.has_key?(:'selfUri')
115
+
116
+
117
+ self.self_uri = attributes[:'selfUri']
118
+
119
+
120
+ end
121
+
122
+
123
+ end
124
+
125
+ # Show invalid properties with the reasons. Usually used together with valid?
126
+ # @return Array for valid properies with the reasons
127
+ def list_invalid_properties
128
+ invalid_properties = Array.new
129
+
130
+
131
+ return invalid_properties
132
+ end
133
+
134
+ # Check to see if the all the properties in the model are valid
135
+ # @return true if the model is valid
136
+ def valid?
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+ allowed_values = ["PC_USER", "PC_GROUP", "UNKNOWN"]
153
+ if @type && !allowed_values.include?(@type)
154
+ return false
155
+ end
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+ end
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+ # Custom attribute writer method checking allowed values (enum).
183
+ # @param [Object] type Object to be assigned
184
+ def type=(type)
185
+ allowed_values = ["PC_USER", "PC_GROUP", "UNKNOWN"]
186
+ if type && !allowed_values.include?(type)
187
+ fail ArgumentError, "invalid value for 'type', must be one of #{allowed_values}."
188
+ end
189
+ @type = type
190
+ end
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+ # Checks equality by comparing each attribute.
201
+ # @param [Object] Object to be compared
202
+ def ==(o)
203
+ return true if self.equal?(o)
204
+ self.class == o.class &&
205
+ id == o.id &&
206
+ name == o.name &&
207
+ divisions == o.divisions &&
208
+ type == o.type &&
209
+ self_uri == o.self_uri
210
+ end
211
+
212
+ # @see the `==` method
213
+ # @param [Object] Object to be compared
214
+ def eql?(o)
215
+ self == o
216
+ end
217
+
218
+ # Calculates hash code according to all attributes.
219
+ # @return [Fixnum] Hash code
220
+ def hash
221
+ [id, name, divisions, type, self_uri].hash
222
+ end
223
+
224
+ # build the object from hash
225
+ def build_from_hash(attributes)
226
+ return nil unless attributes.is_a?(Hash)
227
+ self.class.swagger_types.each_pair do |key, type|
228
+ if type =~ /^Array<(.*)>/i
229
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
230
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
231
+ else
232
+ #TODO show warning in debug mode
233
+ end
234
+ elsif !attributes[self.class.attribute_map[key]].nil?
235
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
236
+ else
237
+ # data not found in attributes(hash), not an issue as the data can be optional
238
+ end
239
+ end
240
+
241
+ self
242
+ end
243
+
244
+ def _deserialize(type, value)
245
+ case type.to_sym
246
+ when :DateTime
247
+ DateTime.parse(value)
248
+ when :Date
249
+ Date.parse(value)
250
+ when :String
251
+ value.to_s
252
+ when :Integer
253
+ value.to_i
254
+ when :Float
255
+ value.to_f
256
+ when :BOOLEAN
257
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
258
+ true
259
+ else
260
+ false
261
+ end
262
+ when :Object
263
+ # generic object (usually a Hash), return directly
264
+ value
265
+ when /\AArray<(?<inner_type>.+)>\z/
266
+ inner_type = Regexp.last_match[:inner_type]
267
+ value.map { |v| _deserialize(inner_type, v) }
268
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
269
+ k_type = Regexp.last_match[:k_type]
270
+ v_type = Regexp.last_match[:v_type]
271
+ {}.tap do |hash|
272
+ value.each do |k, v|
273
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
274
+ end
275
+ end
276
+ else # model
277
+ _model = Object.const_get("PureCloud").const_get(type).new
278
+ _model.build_from_hash(value)
279
+ end
280
+ end
281
+
282
+ def to_s
283
+ to_hash.to_s
284
+ end
285
+
286
+ # to_body is an alias to to_body (backward compatibility))
287
+ def to_body
288
+ to_hash
289
+ end
290
+
291
+ # return the object in the form of hash
292
+ def to_hash
293
+ hash = {}
294
+ self.class.attribute_map.each_pair do |attr, param|
295
+ value = self.send(attr)
296
+ next if value.nil?
297
+ hash[param] = _to_hash(value)
298
+ end
299
+ hash
300
+ end
301
+
302
+ # Method to output non-array value in the form of hash
303
+ # For object, use to_hash. Otherwise, just return the value
304
+ def _to_hash(value)
305
+ if value.is_a?(Array)
306
+ value.compact.map{ |v| _to_hash(v) }
307
+ elsif value.is_a?(Hash)
308
+ {}.tap do |hash|
309
+ value.each { |k, v| hash[k] = _to_hash(v) }
310
+ end
311
+ elsif value.respond_to? :to_hash
312
+ value.to_hash
313
+ else
314
+ value
315
+ end
316
+ end
317
+
318
+ end
319
+ end
@@ -0,0 +1,428 @@
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@genesys.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 SubjectDivisionGrantsEntityListing
21
+ attr_accessor :entities
22
+
23
+ attr_accessor :page_size
24
+
25
+ attr_accessor :page_number
26
+
27
+ attr_accessor :total
28
+
29
+ attr_accessor :self_uri
30
+
31
+ attr_accessor :previous_uri
32
+
33
+ attr_accessor :next_uri
34
+
35
+ attr_accessor :last_uri
36
+
37
+ attr_accessor :first_uri
38
+
39
+ attr_accessor :page_count
40
+
41
+ # Attribute mapping from ruby-style variable name to JSON key.
42
+ def self.attribute_map
43
+ {
44
+
45
+ :'entities' => :'entities',
46
+
47
+ :'page_size' => :'pageSize',
48
+
49
+ :'page_number' => :'pageNumber',
50
+
51
+ :'total' => :'total',
52
+
53
+ :'self_uri' => :'selfUri',
54
+
55
+ :'previous_uri' => :'previousUri',
56
+
57
+ :'next_uri' => :'nextUri',
58
+
59
+ :'last_uri' => :'lastUri',
60
+
61
+ :'first_uri' => :'firstUri',
62
+
63
+ :'page_count' => :'pageCount'
64
+
65
+ }
66
+ end
67
+
68
+ # Attribute type mapping.
69
+ def self.swagger_types
70
+ {
71
+
72
+ :'entities' => :'Array<SubjectDivisionGrants>',
73
+
74
+ :'page_size' => :'Integer',
75
+
76
+ :'page_number' => :'Integer',
77
+
78
+ :'total' => :'Integer',
79
+
80
+ :'self_uri' => :'String',
81
+
82
+ :'previous_uri' => :'String',
83
+
84
+ :'next_uri' => :'String',
85
+
86
+ :'last_uri' => :'String',
87
+
88
+ :'first_uri' => :'String',
89
+
90
+ :'page_count' => :'Integer'
91
+
92
+ }
93
+ end
94
+
95
+ # Initializes the object
96
+ # @param [Hash] attributes Model attributes in the form of hash
97
+ def initialize(attributes = {})
98
+ return unless attributes.is_a?(Hash)
99
+
100
+ # convert string to symbol for hash key
101
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
102
+
103
+
104
+ if attributes.has_key?(:'entities')
105
+
106
+ if (value = attributes[:'entities']).is_a?(Array)
107
+ self.entities = value
108
+ end
109
+
110
+
111
+
112
+ end
113
+
114
+
115
+ if attributes.has_key?(:'pageSize')
116
+
117
+
118
+ self.page_size = attributes[:'pageSize']
119
+
120
+
121
+ end
122
+
123
+
124
+ if attributes.has_key?(:'pageNumber')
125
+
126
+
127
+ self.page_number = attributes[:'pageNumber']
128
+
129
+
130
+ end
131
+
132
+
133
+ if attributes.has_key?(:'total')
134
+
135
+
136
+ self.total = attributes[:'total']
137
+
138
+
139
+ end
140
+
141
+
142
+ if attributes.has_key?(:'selfUri')
143
+
144
+
145
+ self.self_uri = attributes[:'selfUri']
146
+
147
+
148
+ end
149
+
150
+
151
+ if attributes.has_key?(:'previousUri')
152
+
153
+
154
+ self.previous_uri = attributes[:'previousUri']
155
+
156
+
157
+ end
158
+
159
+
160
+ if attributes.has_key?(:'nextUri')
161
+
162
+
163
+ self.next_uri = attributes[:'nextUri']
164
+
165
+
166
+ end
167
+
168
+
169
+ if attributes.has_key?(:'lastUri')
170
+
171
+
172
+ self.last_uri = attributes[:'lastUri']
173
+
174
+
175
+ end
176
+
177
+
178
+ if attributes.has_key?(:'firstUri')
179
+
180
+
181
+ self.first_uri = attributes[:'firstUri']
182
+
183
+
184
+ end
185
+
186
+
187
+ if attributes.has_key?(:'pageCount')
188
+
189
+
190
+ self.page_count = attributes[:'pageCount']
191
+
192
+
193
+ end
194
+
195
+
196
+ end
197
+
198
+ # Show invalid properties with the reasons. Usually used together with valid?
199
+ # @return Array for valid properies with the reasons
200
+ def list_invalid_properties
201
+ invalid_properties = Array.new
202
+
203
+
204
+ return invalid_properties
205
+ end
206
+
207
+ # Check to see if the all the properties in the model are valid
208
+ # @return true if the model is valid
209
+ def valid?
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+ end
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
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+ # Checks equality by comparing each attribute.
305
+ # @param [Object] Object to be compared
306
+ def ==(o)
307
+ return true if self.equal?(o)
308
+ self.class == o.class &&
309
+ entities == o.entities &&
310
+ page_size == o.page_size &&
311
+ page_number == o.page_number &&
312
+ total == o.total &&
313
+ self_uri == o.self_uri &&
314
+ previous_uri == o.previous_uri &&
315
+ next_uri == o.next_uri &&
316
+ last_uri == o.last_uri &&
317
+ first_uri == o.first_uri &&
318
+ page_count == o.page_count
319
+ end
320
+
321
+ # @see the `==` method
322
+ # @param [Object] Object to be compared
323
+ def eql?(o)
324
+ self == o
325
+ end
326
+
327
+ # Calculates hash code according to all attributes.
328
+ # @return [Fixnum] Hash code
329
+ def hash
330
+ [entities, page_size, page_number, total, self_uri, previous_uri, next_uri, last_uri, first_uri, page_count].hash
331
+ end
332
+
333
+ # build the object from hash
334
+ def build_from_hash(attributes)
335
+ return nil unless attributes.is_a?(Hash)
336
+ self.class.swagger_types.each_pair do |key, type|
337
+ if type =~ /^Array<(.*)>/i
338
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
339
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
340
+ else
341
+ #TODO show warning in debug mode
342
+ end
343
+ elsif !attributes[self.class.attribute_map[key]].nil?
344
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
345
+ else
346
+ # data not found in attributes(hash), not an issue as the data can be optional
347
+ end
348
+ end
349
+
350
+ self
351
+ end
352
+
353
+ def _deserialize(type, value)
354
+ case type.to_sym
355
+ when :DateTime
356
+ DateTime.parse(value)
357
+ when :Date
358
+ Date.parse(value)
359
+ when :String
360
+ value.to_s
361
+ when :Integer
362
+ value.to_i
363
+ when :Float
364
+ value.to_f
365
+ when :BOOLEAN
366
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
367
+ true
368
+ else
369
+ false
370
+ end
371
+ when :Object
372
+ # generic object (usually a Hash), return directly
373
+ value
374
+ when /\AArray<(?<inner_type>.+)>\z/
375
+ inner_type = Regexp.last_match[:inner_type]
376
+ value.map { |v| _deserialize(inner_type, v) }
377
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
378
+ k_type = Regexp.last_match[:k_type]
379
+ v_type = Regexp.last_match[:v_type]
380
+ {}.tap do |hash|
381
+ value.each do |k, v|
382
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
383
+ end
384
+ end
385
+ else # model
386
+ _model = Object.const_get("PureCloud").const_get(type).new
387
+ _model.build_from_hash(value)
388
+ end
389
+ end
390
+
391
+ def to_s
392
+ to_hash.to_s
393
+ end
394
+
395
+ # to_body is an alias to to_body (backward compatibility))
396
+ def to_body
397
+ to_hash
398
+ end
399
+
400
+ # return the object in the form of hash
401
+ def to_hash
402
+ hash = {}
403
+ self.class.attribute_map.each_pair do |attr, param|
404
+ value = self.send(attr)
405
+ next if value.nil?
406
+ hash[param] = _to_hash(value)
407
+ end
408
+ hash
409
+ end
410
+
411
+ # Method to output non-array value in the form of hash
412
+ # For object, use to_hash. Otherwise, just return the value
413
+ def _to_hash(value)
414
+ if value.is_a?(Array)
415
+ value.compact.map{ |v| _to_hash(v) }
416
+ elsif value.is_a?(Hash)
417
+ {}.tap do |hash|
418
+ value.each { |k, v| hash[k] = _to_hash(v) }
419
+ end
420
+ elsif value.respond_to? :to_hash
421
+ value.to_hash
422
+ else
423
+ value
424
+ end
425
+ end
426
+
427
+ end
428
+ end