purecloudplatformclientv2 22.0.0 → 23.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (116) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/ActivityCode.md +8 -5
  4. data/docs/ActivityCodeContainer.md +1 -0
  5. data/docs/AdherenceSettings.md +1 -1
  6. data/docs/ArchitectApi.md +14 -14
  7. data/docs/AuthorizationApi.md +3 -1
  8. data/docs/BatchDownloadJobResult.md +20 -0
  9. data/docs/BatchDownloadJobStatusResult.md +20 -0
  10. data/docs/BatchDownloadJobSubmission.md +13 -0
  11. data/docs/BatchDownloadJobSubmissionResult.md +15 -0
  12. data/docs/BatchDownloadRequest.md +14 -0
  13. data/docs/Call.md +2 -0
  14. data/docs/CallBasic.md +2 -0
  15. data/docs/CallForwardingNotification.md +17 -0
  16. data/docs/CallForwardingNotificationCall.md +13 -0
  17. data/docs/CallForwardingNotificationCalls.md +13 -0
  18. data/docs/CallForwardingNotificationTarget.md +14 -0
  19. data/docs/CallForwardingNotificationTargets.md +14 -0
  20. data/docs/CallForwardingNotificationUser.md +13 -0
  21. data/docs/CallRoute.md +0 -1
  22. data/docs/{SignedData.md → ContactColumnTimeZone.md} +2 -3
  23. data/docs/CreateActivityCodeRequest.md +18 -0
  24. data/docs/CreateQueueRequest.md +12 -11
  25. data/docs/ExternalContact.md +1 -0
  26. data/docs/IgnoredActivityCategories.md +13 -0
  27. data/docs/ManagementUnit.md +4 -3
  28. data/docs/ManagementUnitSettings.md +1 -3
  29. data/docs/MessageDetails.md +1 -0
  30. data/docs/MessageMedia.md +14 -0
  31. data/docs/MoveAgentResponse.md +14 -0
  32. data/docs/MoveAgentsRequest.md +14 -0
  33. data/docs/MoveAgentsResponse.md +15 -0
  34. data/docs/NTPSettings.md +13 -0
  35. data/docs/OrganizationAuthorizationApi.md +2 -2
  36. data/docs/OutOfOfficeNotification.md +1 -0
  37. data/docs/OutboundApi.md +63 -0
  38. data/docs/Queue.md +12 -11
  39. data/docs/Recording.md +1 -0
  40. data/docs/RecordingApi.md +120 -0
  41. data/docs/RecordingMessagingMessage.md +18 -0
  42. data/docs/RoutingApi.md +2 -2
  43. data/docs/SchedulingSettings.md +1 -0
  44. data/docs/ShrinkageOverride.md +14 -0
  45. data/docs/ShrinkageOverrides.md +14 -0
  46. data/docs/Site.md +1 -0
  47. data/docs/TrustCreate.md +2 -1
  48. data/docs/TrustGroup.md +26 -0
  49. data/docs/{TrustUserCreate.md → TrustMemberCreate.md} +4 -4
  50. data/docs/TrustRequest.md +2 -1
  51. data/docs/TrustRequestCreate.md +2 -1
  52. data/docs/UserQueue.md +12 -11
  53. data/docs/WfmVersionedEntityMetadata.md +15 -0
  54. data/docs/WorkforceManagementApi.md +128 -3
  55. data/docs/{Entity.md → WrapUpCodeReference.md} +2 -2
  56. data/lib/purecloudplatformclientv2.rb +26 -4
  57. data/lib/purecloudplatformclientv2/api/architect_api.rb +6 -6
  58. data/lib/purecloudplatformclientv2/api/authorization_api.rb +9 -0
  59. data/lib/purecloudplatformclientv2/api/outbound_api.rb +75 -0
  60. data/lib/purecloudplatformclientv2/api/recording_api.rb +130 -0
  61. data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +138 -2
  62. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  63. data/lib/purecloudplatformclientv2/models/activity_code.rb +95 -12
  64. data/lib/purecloudplatformclientv2/models/activity_code_container.rb +35 -4
  65. data/lib/purecloudplatformclientv2/models/adherence_settings.rb +2 -4
  66. data/lib/purecloudplatformclientv2/models/batch_download_job_result.rb +383 -0
  67. data/lib/purecloudplatformclientv2/models/batch_download_job_status_result.rb +385 -0
  68. data/lib/purecloudplatformclientv2/models/batch_download_job_submission.rb +209 -0
  69. data/lib/purecloudplatformclientv2/models/batch_download_job_submission_result.rb +253 -0
  70. data/lib/purecloudplatformclientv2/models/batch_download_request.rb +228 -0
  71. data/lib/purecloudplatformclientv2/models/call.rb +56 -4
  72. data/lib/purecloudplatformclientv2/models/call_basic.rb +56 -4
  73. data/lib/purecloudplatformclientv2/models/call_forwarding_notification.rb +303 -0
  74. data/lib/purecloudplatformclientv2/models/call_forwarding_notification_call.rb +203 -0
  75. data/lib/purecloudplatformclientv2/models/call_forwarding_notification_calls.rb +203 -0
  76. data/lib/purecloudplatformclientv2/models/call_forwarding_notification_target.rb +226 -0
  77. data/lib/purecloudplatformclientv2/models/call_forwarding_notification_targets.rb +226 -0
  78. data/lib/purecloudplatformclientv2/models/{signed_data.rb → call_forwarding_notification_user.rb} +8 -8
  79. data/lib/purecloudplatformclientv2/models/call_route.rb +4 -30
  80. data/lib/purecloudplatformclientv2/models/contact_column_time_zone.rb +176 -0
  81. data/lib/purecloudplatformclientv2/models/create_activity_code_request.rb +358 -0
  82. data/lib/purecloudplatformclientv2/models/create_queue_request.rb +38 -12
  83. data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
  84. data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
  85. data/lib/purecloudplatformclientv2/models/event_message.rb +2 -2
  86. data/lib/purecloudplatformclientv2/models/external_contact.rb +26 -1
  87. data/lib/purecloudplatformclientv2/models/ignored_activity_categories.rb +204 -0
  88. data/lib/purecloudplatformclientv2/models/management_unit.rb +36 -5
  89. data/lib/purecloudplatformclientv2/models/management_unit_settings.rb +9 -61
  90. data/lib/purecloudplatformclientv2/models/message_details.rb +32 -4
  91. data/lib/purecloudplatformclientv2/models/message_media.rb +228 -0
  92. data/lib/purecloudplatformclientv2/models/move_agent_response.rb +243 -0
  93. data/lib/purecloudplatformclientv2/models/move_agents_request.rb +236 -0
  94. data/lib/purecloudplatformclientv2/models/move_agents_response.rb +257 -0
  95. data/lib/purecloudplatformclientv2/models/ntp_settings.rb +204 -0
  96. data/lib/purecloudplatformclientv2/models/out_of_office_notification.rb +26 -1
  97. data/lib/purecloudplatformclientv2/models/prediction_results.rb +2 -2
  98. data/lib/purecloudplatformclientv2/models/queue.rb +38 -12
  99. data/lib/purecloudplatformclientv2/models/recording.rb +29 -1
  100. data/lib/purecloudplatformclientv2/models/recording_messaging_message.rb +327 -0
  101. data/lib/purecloudplatformclientv2/models/scheduling_settings.rb +30 -4
  102. data/lib/purecloudplatformclientv2/models/shrinkage_override.rb +233 -0
  103. data/lib/purecloudplatformclientv2/models/shrinkage_overrides.rb +230 -0
  104. data/lib/purecloudplatformclientv2/models/site.rb +27 -1
  105. data/lib/purecloudplatformclientv2/models/trust_create.rb +32 -9
  106. data/lib/purecloudplatformclientv2/models/trust_group.rb +603 -0
  107. data/lib/purecloudplatformclientv2/models/{trust_user_create.rb → trust_member_create.rb} +3 -3
  108. data/lib/purecloudplatformclientv2/models/trust_request.rb +28 -5
  109. data/lib/purecloudplatformclientv2/models/trust_request_create.rb +32 -9
  110. data/lib/purecloudplatformclientv2/models/user_queue.rb +38 -12
  111. data/lib/purecloudplatformclientv2/models/wfm_versioned_entity_metadata.rb +260 -0
  112. data/lib/purecloudplatformclientv2/models/{entity.rb → wrap_up_code_reference.rb} +1 -1
  113. data/lib/purecloudplatformclientv2/version.rb +1 -1
  114. metadata +54 -10
  115. data/docs/SignedDataApi.md +0 -73
  116. data/lib/purecloudplatformclientv2/api/signed_data_api.rb +0 -90
@@ -83,6 +83,12 @@ module PureCloud
83
83
  # User to User Information (UUI) data managed by SIP session application.
84
84
  attr_accessor :uui_data
85
85
 
86
+ # Address and name data for a call endpoint.
87
+ attr_accessor :_self
88
+
89
+ # Address and name data for a call endpoint.
90
+ attr_accessor :other
91
+
86
92
  # Attribute mapping from ruby-style variable name to JSON key.
87
93
  def self.attribute_map
88
94
  {
@@ -129,7 +135,11 @@ module PureCloud
129
135
 
130
136
  :'peer_id' => :'peerId',
131
137
 
132
- :'uui_data' => :'uuiData'
138
+ :'uui_data' => :'uuiData',
139
+
140
+ :'_self' => :'self',
141
+
142
+ :'other' => :'other'
133
143
 
134
144
  }
135
145
  end
@@ -180,7 +190,11 @@ module PureCloud
180
190
 
181
191
  :'peer_id' => :'String',
182
192
 
183
- :'uui_data' => :'String'
193
+ :'uui_data' => :'String',
194
+
195
+ :'_self' => :'Address',
196
+
197
+ :'other' => :'Address'
184
198
 
185
199
  }
186
200
  end
@@ -396,6 +410,24 @@ module PureCloud
396
410
  end
397
411
 
398
412
 
413
+ if attributes.has_key?(:'self')
414
+
415
+
416
+ self._self = attributes[:'self']
417
+
418
+
419
+ end
420
+
421
+
422
+ if attributes.has_key?(:'other')
423
+
424
+
425
+ self.other = attributes[:'other']
426
+
427
+
428
+ end
429
+
430
+
399
431
  end
400
432
 
401
433
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -510,6 +542,14 @@ module PureCloud
510
542
 
511
543
 
512
544
 
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+
513
553
 
514
554
 
515
555
 
@@ -657,6 +697,16 @@ module PureCloud
657
697
 
658
698
 
659
699
 
700
+
701
+
702
+
703
+
704
+
705
+
706
+
707
+
708
+
709
+
660
710
 
661
711
 
662
712
 
@@ -694,7 +744,9 @@ module PureCloud
694
744
  provider == o.provider &&
695
745
  script_id == o.script_id &&
696
746
  peer_id == o.peer_id &&
697
- uui_data == o.uui_data
747
+ uui_data == o.uui_data &&
748
+ _self == o._self &&
749
+ other == o.other
698
750
  end
699
751
 
700
752
  # @see the `==` method
@@ -706,7 +758,7 @@ module PureCloud
706
758
  # Calculates hash code according to all attributes.
707
759
  # @return [Fixnum] Hash code
708
760
  def hash
709
- [state, id, direction, recording, recording_state, muted, confined, held, recording_id, segments, error_info, disconnect_type, start_hold_time, document_id, connected_time, disconnected_time, disconnect_reasons, fax_status, provider, script_id, peer_id, uui_data].hash
761
+ [state, id, direction, recording, recording_state, muted, confined, held, recording_id, segments, error_info, disconnect_type, start_hold_time, document_id, connected_time, disconnected_time, disconnect_reasons, fax_status, provider, script_id, peer_id, uui_data, _self, other].hash
710
762
  end
711
763
 
712
764
  # build the object from hash
@@ -83,6 +83,12 @@ module PureCloud
83
83
  # User to User Information (UUI) data managed by SIP session application.
84
84
  attr_accessor :uui_data
85
85
 
86
+ # Address and name data for a call endpoint.
87
+ attr_accessor :_self
88
+
89
+ # Address and name data for a call endpoint.
90
+ attr_accessor :other
91
+
86
92
  # Attribute mapping from ruby-style variable name to JSON key.
87
93
  def self.attribute_map
88
94
  {
@@ -129,7 +135,11 @@ module PureCloud
129
135
 
130
136
  :'peer_id' => :'peerId',
131
137
 
132
- :'uui_data' => :'uuiData'
138
+ :'uui_data' => :'uuiData',
139
+
140
+ :'_self' => :'self',
141
+
142
+ :'other' => :'other'
133
143
 
134
144
  }
135
145
  end
@@ -180,7 +190,11 @@ module PureCloud
180
190
 
181
191
  :'peer_id' => :'String',
182
192
 
183
- :'uui_data' => :'String'
193
+ :'uui_data' => :'String',
194
+
195
+ :'_self' => :'Address',
196
+
197
+ :'other' => :'Address'
184
198
 
185
199
  }
186
200
  end
@@ -396,6 +410,24 @@ module PureCloud
396
410
  end
397
411
 
398
412
 
413
+ if attributes.has_key?(:'self')
414
+
415
+
416
+ self._self = attributes[:'self']
417
+
418
+
419
+ end
420
+
421
+
422
+ if attributes.has_key?(:'other')
423
+
424
+
425
+ self.other = attributes[:'other']
426
+
427
+
428
+ end
429
+
430
+
399
431
  end
400
432
 
401
433
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -510,6 +542,14 @@ module PureCloud
510
542
 
511
543
 
512
544
 
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+
513
553
 
514
554
 
515
555
 
@@ -657,6 +697,16 @@ module PureCloud
657
697
 
658
698
 
659
699
 
700
+
701
+
702
+
703
+
704
+
705
+
706
+
707
+
708
+
709
+
660
710
 
661
711
 
662
712
 
@@ -694,7 +744,9 @@ module PureCloud
694
744
  provider == o.provider &&
695
745
  script_id == o.script_id &&
696
746
  peer_id == o.peer_id &&
697
- uui_data == o.uui_data
747
+ uui_data == o.uui_data &&
748
+ _self == o._self &&
749
+ other == o.other
698
750
  end
699
751
 
700
752
  # @see the `==` method
@@ -706,7 +758,7 @@ module PureCloud
706
758
  # Calculates hash code according to all attributes.
707
759
  # @return [Fixnum] Hash code
708
760
  def hash
709
- [state, id, direction, recording, recording_state, muted, confined, held, recording_id, segments, error_info, disconnect_type, start_hold_time, document_id, connected_time, disconnected_time, disconnect_reasons, fax_status, provider, script_id, peer_id, uui_data].hash
761
+ [state, id, direction, recording, recording_state, muted, confined, held, recording_id, segments, error_info, disconnect_type, start_hold_time, document_id, connected_time, disconnected_time, disconnect_reasons, fax_status, provider, script_id, peer_id, uui_data, _self, other].hash
710
762
  end
711
763
 
712
764
  # build the object from hash
@@ -0,0 +1,303 @@
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 CallForwardingNotification
21
+ attr_accessor :user
22
+
23
+ attr_accessor :enabled
24
+
25
+ attr_accessor :calls
26
+
27
+ attr_accessor :voicemail
28
+
29
+ attr_accessor :modified_date
30
+
31
+ # Attribute mapping from ruby-style variable name to JSON key.
32
+ def self.attribute_map
33
+ {
34
+
35
+ :'user' => :'user',
36
+
37
+ :'enabled' => :'enabled',
38
+
39
+ :'calls' => :'calls',
40
+
41
+ :'voicemail' => :'voicemail',
42
+
43
+ :'modified_date' => :'modifiedDate'
44
+
45
+ }
46
+ end
47
+
48
+ # Attribute type mapping.
49
+ def self.swagger_types
50
+ {
51
+
52
+ :'user' => :'DocumentDataV2NotificationWorkspace',
53
+
54
+ :'enabled' => :'BOOLEAN',
55
+
56
+ :'calls' => :'Array<CallForwardingNotificationCalls>',
57
+
58
+ :'voicemail' => :'String',
59
+
60
+ :'modified_date' => :'DateTime'
61
+
62
+ }
63
+ end
64
+
65
+ # Initializes the object
66
+ # @param [Hash] attributes Model attributes in the form of hash
67
+ def initialize(attributes = {})
68
+ return unless attributes.is_a?(Hash)
69
+
70
+ # convert string to symbol for hash key
71
+ attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
72
+
73
+
74
+ if attributes.has_key?(:'user')
75
+
76
+
77
+ self.user = attributes[:'user']
78
+
79
+
80
+ end
81
+
82
+
83
+ if attributes.has_key?(:'enabled')
84
+
85
+
86
+ self.enabled = attributes[:'enabled']
87
+
88
+
89
+ end
90
+
91
+
92
+ if attributes.has_key?(:'calls')
93
+
94
+ if (value = attributes[:'calls']).is_a?(Array)
95
+ self.calls = value
96
+ end
97
+
98
+
99
+
100
+ end
101
+
102
+
103
+ if attributes.has_key?(:'voicemail')
104
+
105
+
106
+ self.voicemail = attributes[:'voicemail']
107
+
108
+
109
+ end
110
+
111
+
112
+ if attributes.has_key?(:'modifiedDate')
113
+
114
+
115
+ self.modified_date = attributes[:'modifiedDate']
116
+
117
+
118
+ end
119
+
120
+
121
+ end
122
+
123
+ # Show invalid properties with the reasons. Usually used together with valid?
124
+ # @return Array for valid properies with the reasons
125
+ def list_invalid_properties
126
+ invalid_properties = Array.new
127
+
128
+
129
+ return invalid_properties
130
+ end
131
+
132
+ # Check to see if the all the properties in the model are valid
133
+ # @return true if the model is valid
134
+ def valid?
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+ end
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+ # Checks equality by comparing each attribute.
185
+ # @param [Object] Object to be compared
186
+ def ==(o)
187
+ return true if self.equal?(o)
188
+ self.class == o.class &&
189
+ user == o.user &&
190
+ enabled == o.enabled &&
191
+ calls == o.calls &&
192
+ voicemail == o.voicemail &&
193
+ modified_date == o.modified_date
194
+ end
195
+
196
+ # @see the `==` method
197
+ # @param [Object] Object to be compared
198
+ def eql?(o)
199
+ self == o
200
+ end
201
+
202
+ # Calculates hash code according to all attributes.
203
+ # @return [Fixnum] Hash code
204
+ def hash
205
+ [user, enabled, calls, voicemail, modified_date].hash
206
+ end
207
+
208
+ # build the object from hash
209
+ def build_from_hash(attributes)
210
+ return nil unless attributes.is_a?(Hash)
211
+ self.class.swagger_types.each_pair do |key, type|
212
+ if type =~ /^Array<(.*)>/i
213
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
214
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
215
+ else
216
+ #TODO show warning in debug mode
217
+ end
218
+ elsif !attributes[self.class.attribute_map[key]].nil?
219
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
220
+ else
221
+ # data not found in attributes(hash), not an issue as the data can be optional
222
+ end
223
+ end
224
+
225
+ self
226
+ end
227
+
228
+ def _deserialize(type, value)
229
+ case type.to_sym
230
+ when :DateTime
231
+ DateTime.parse(value)
232
+ when :Date
233
+ Date.parse(value)
234
+ when :String
235
+ value.to_s
236
+ when :Integer
237
+ value.to_i
238
+ when :Float
239
+ value.to_f
240
+ when :BOOLEAN
241
+ if value.to_s =~ /^(true|t|yes|y|1)$/i
242
+ true
243
+ else
244
+ false
245
+ end
246
+ when :Object
247
+ # generic object (usually a Hash), return directly
248
+ value
249
+ when /\AArray<(?<inner_type>.+)>\z/
250
+ inner_type = Regexp.last_match[:inner_type]
251
+ value.map { |v| _deserialize(inner_type, v) }
252
+ when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
253
+ k_type = Regexp.last_match[:k_type]
254
+ v_type = Regexp.last_match[:v_type]
255
+ {}.tap do |hash|
256
+ value.each do |k, v|
257
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
258
+ end
259
+ end
260
+ else # model
261
+ _model = Object.const_get("PureCloud").const_get(type).new
262
+ _model.build_from_hash(value)
263
+ end
264
+ end
265
+
266
+ def to_s
267
+ to_hash.to_s
268
+ end
269
+
270
+ # to_body is an alias to to_body (backward compatibility))
271
+ def to_body
272
+ to_hash
273
+ end
274
+
275
+ # return the object in the form of hash
276
+ def to_hash
277
+ hash = {}
278
+ self.class.attribute_map.each_pair do |attr, param|
279
+ value = self.send(attr)
280
+ next if value.nil?
281
+ hash[param] = _to_hash(value)
282
+ end
283
+ hash
284
+ end
285
+
286
+ # Method to output non-array value in the form of hash
287
+ # For object, use to_hash. Otherwise, just return the value
288
+ def _to_hash(value)
289
+ if value.is_a?(Array)
290
+ value.compact.map{ |v| _to_hash(v) }
291
+ elsif value.is_a?(Hash)
292
+ {}.tap do |hash|
293
+ value.each { |k, v| hash[k] = _to_hash(v) }
294
+ end
295
+ elsif value.respond_to? :to_hash
296
+ value.to_hash
297
+ else
298
+ value
299
+ end
300
+ end
301
+
302
+ end
303
+ end