purecloud 0.18.0 → 0.25.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (143) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +2 -2
  3. data/Gemfile.lock +2 -2
  4. data/README.md +1 -7
  5. data/config-ruby.json +1 -1
  6. data/extensions/auth.rb +2 -2
  7. data/lib/purecloud.rb +110 -75
  8. data/lib/purecloud/api/architect_api.rb +3127 -74
  9. data/lib/purecloud/api/attributes_api.rb +33 -33
  10. data/lib/purecloud/api/authorization_api.rb +83 -83
  11. data/lib/purecloud/api/compliance_api.rb +5 -5
  12. data/lib/purecloud/api/configuration_api.rb +594 -397
  13. data/lib/purecloud/api/content_management_api.rb +183 -183
  14. data/lib/purecloud/api/conversations_api.rb +289 -159
  15. data/lib/purecloud/api/downloads_api.rb +6 -6
  16. data/lib/purecloud/api/external_contacts_api.rb +1693 -0
  17. data/lib/purecloud/api/fax_api.rb +24 -24
  18. data/lib/purecloud/api/geolocation_api.rb +14 -14
  19. data/lib/purecloud/api/greetings_api.rb +68 -68
  20. data/lib/purecloud/api/groups_api.rb +31 -20
  21. data/lib/purecloud/api/languages_api.rb +18 -11
  22. data/lib/purecloud/api/licensing_api.rb +5 -5
  23. data/lib/purecloud/api/locations_api.rb +11 -11
  24. data/lib/purecloud/api/notifications_api.rb +41 -41
  25. data/lib/purecloud/api/o_auth_api.rb +69 -69
  26. data/lib/purecloud/api/outbound_api.rb +505 -325
  27. data/lib/purecloud/api/presence_api.rb +65 -65
  28. data/lib/purecloud/api/quality_api.rb +66 -639
  29. data/lib/purecloud/api/recording_api.rb +1343 -0
  30. data/lib/purecloud/api/response_management_api.rb +687 -0
  31. data/lib/purecloud/api/routing_api.rb +224 -170
  32. data/lib/purecloud/api/scripts_api.rb +52 -52
  33. data/lib/purecloud/api/search_api.rb +5 -5
  34. data/lib/purecloud/api/stations_api.rb +8 -8
  35. data/lib/purecloud/api/telephony_providers_edge_api.rb +138 -138
  36. data/lib/purecloud/api/user_recordings_api.rb +29 -29
  37. data/lib/purecloud/api/users_api.rb +123 -123
  38. data/lib/purecloud/api/utilities_api.rb +71 -15
  39. data/lib/purecloud/api/voicemail_api.rb +42 -42
  40. data/lib/purecloud/api_client.rb +1 -1
  41. data/lib/purecloud/models/address.rb +49 -51
  42. data/lib/purecloud/models/attribute_filter_item.rb +177 -0
  43. data/lib/purecloud/models/automate_queue_member_entity_listing.rb +238 -0
  44. data/lib/purecloud/models/available_additional_service.rb +40 -1
  45. data/lib/purecloud/models/{topic_entity_listing.rb → available_topic_entity_listing.rb} +1 -1
  46. data/lib/purecloud/models/call.rb +36 -5
  47. data/lib/purecloud/models/{line_properties.rb → call_command.rb} +13 -3
  48. data/lib/purecloud/models/callback.rb +15 -4
  49. data/lib/purecloud/models/campaign.rb +219 -17
  50. data/lib/purecloud/models/campaign_progress.rb +186 -0
  51. data/lib/purecloud/models/channel_topic_entity_listing.rb +238 -0
  52. data/lib/purecloud/models/charge.rb +14 -4
  53. data/lib/purecloud/models/{attribute_value.rb → client_text_table_transform.rb} +52 -82
  54. data/lib/purecloud/models/contact.rb +1 -1
  55. data/lib/purecloud/models/contact_list.rb +111 -1
  56. data/lib/purecloud/models/contact_listing.rb +238 -0
  57. data/lib/purecloud/models/content_attribute_filter_item.rb +177 -0
  58. data/lib/purecloud/models/content_facet_filter_item.rb +1 -1
  59. data/lib/purecloud/models/content_query_request.rb +16 -4
  60. data/lib/purecloud/models/control.rb +221 -0
  61. data/lib/purecloud/models/{flow_activate_request.rb → control_options.rb} +18 -12
  62. data/lib/purecloud/models/create_callback_command.rb +200 -0
  63. data/lib/purecloud/models/discount.rb +220 -0
  64. data/lib/purecloud/models/document.rb +13 -1
  65. data/lib/purecloud/models/document_attribute.rb +158 -0
  66. data/lib/purecloud/models/document_update.rb +28 -16
  67. data/lib/purecloud/models/document_upload.rb +4 -16
  68. data/lib/purecloud/models/domain_voice_rate_extended_response_item_entity_listing.rb +238 -0
  69. data/lib/purecloud/models/domain_voice_rate_international_response_item_entity_listing.rb +238 -0
  70. data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb +1 -1
  71. data/lib/purecloud/models/edge_line.rb +1 -1
  72. data/lib/purecloud/models/edge_logs_job.rb +181 -0
  73. data/lib/purecloud/models/edge_logs_job_file.rb +243 -0
  74. data/lib/purecloud/models/edge_logs_job_request.rb +168 -0
  75. data/lib/purecloud/models/{backend_work_item_data_element.rb → edge_logs_job_response.rb} +16 -24
  76. data/lib/purecloud/models/{flow_lock_request.rb → edge_logs_job_upload_request.rb} +10 -12
  77. data/lib/purecloud/models/email.rb +15 -4
  78. data/lib/purecloud/models/endpoint.rb +1 -1
  79. data/lib/purecloud/models/{flow_associate_workspaces_request.rb → estimated_wait_time_predictions.rb} +10 -11
  80. data/lib/purecloud/models/external_contact.rb +320 -0
  81. data/lib/purecloud/models/external_organization.rb +306 -0
  82. data/lib/purecloud/models/external_organization_listing.rb +238 -0
  83. data/lib/purecloud/models/facet_filter_item.rb +1 -1
  84. data/lib/purecloud/models/flow_body.rb +1 -1
  85. data/lib/purecloud/models/flow_body_format.rb +10 -20
  86. data/lib/purecloud/models/flow_terminate_request.rb +3 -16
  87. data/lib/purecloud/models/form.rb +148 -0
  88. data/lib/purecloud/models/group.rb +11 -1
  89. data/lib/purecloud/models/health_check_info.rb +268 -0
  90. data/lib/purecloud/models/{body_2.rb → inline_response_200.rb} +1 -1
  91. data/lib/purecloud/models/integration_type.rb +209 -0
  92. data/lib/purecloud/models/integration_type_entity_listing.rb +238 -0
  93. data/lib/purecloud/models/key_rotation_schedule.rb +1 -0
  94. data/lib/purecloud/models/language.rb +41 -1
  95. data/lib/purecloud/models/line.rb +1 -1
  96. data/lib/purecloud/models/line_base.rb +1 -1
  97. data/lib/purecloud/models/media_policies.rb +169 -0
  98. data/lib/purecloud/models/media_policy.rb +171 -0
  99. data/lib/purecloud/models/note.rb +200 -0
  100. data/lib/purecloud/models/{user_station_resource.rb → note_listing.rb} +68 -58
  101. data/lib/purecloud/models/o_auth_client.rb +1 -1
  102. data/lib/purecloud/models/page.rb +2 -2
  103. data/lib/purecloud/models/{byte_buffer.rb → payment_method.rb} +48 -61
  104. data/lib/purecloud/models/payment_method_listing.rb +238 -0
  105. data/lib/purecloud/models/payment_token_provider.rb +180 -0
  106. data/lib/purecloud/models/phone.rb +1 -1
  107. data/lib/purecloud/models/phone_base.rb +1 -1
  108. data/lib/purecloud/models/phone_number.rb +198 -0
  109. data/lib/purecloud/models/phones_reboot.rb +14 -4
  110. data/lib/purecloud/models/policy.rb +14 -1
  111. data/lib/purecloud/models/prediction_results.rb +167 -0
  112. data/lib/purecloud/models/query_request.rb +16 -4
  113. data/lib/purecloud/models/queue_member_entity_listing.rb +1 -1
  114. data/lib/purecloud/models/quote.rb +13 -1
  115. data/lib/purecloud/models/recording_settings.rb +146 -0
  116. data/lib/purecloud/models/relationship.rb +201 -0
  117. data/lib/purecloud/models/relationship_listing.rb +238 -0
  118. data/lib/purecloud/models/report_schedule.rb +3 -2
  119. data/lib/purecloud/models/service_type.rb +12 -1
  120. data/lib/purecloud/models/social_expression.rb +25 -4
  121. data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +1 -1
  122. data/lib/purecloud/models/template.rb +1 -1
  123. data/lib/purecloud/models/text_table_transform_entity_listing.rb +1 -1
  124. data/lib/purecloud/models/ticker.rb +158 -0
  125. data/lib/purecloud/models/time_slot.rb +1 -0
  126. data/lib/purecloud/models/trunk_base.rb +1 -1
  127. data/lib/purecloud/models/vendor_connection_request.rb +166 -0
  128. data/lib/purecloud/models/video.rb +15 -4
  129. data/lib/purecloud/models/work_item_definition.rb +8 -10
  130. data/lib/purecloud/version.rb +1 -1
  131. data/ossindex.json +17 -0
  132. data/purecloud.gemspec +4 -3
  133. data/rakefile +3 -15
  134. data/spec/test.rb +6 -3
  135. data/swagger.json +1 -1
  136. data/swagger_template/api_client.mustache +304 -0
  137. data/swagger_template/base_object.mustache +90 -0
  138. data/{PureCloud.gemspec → swagger_template/gemspec.mustache} +12 -11
  139. data/version.json +1 -1
  140. metadata +76 -25
  141. data/lib/purecloud/api/analytics_api.rb +0 -1554
  142. data/lib/purecloud/api/orphaned_recordings_api.rb +0 -205
  143. data/newVersion.md +0 -1
@@ -0,0 +1,1343 @@
1
+ require "uri"
2
+
3
+ module PureCloud
4
+ class RecordingApi
5
+ attr_accessor :api_client
6
+
7
+ def initialize(api_client = ApiClient.default)
8
+ @api_client = api_client
9
+ end
10
+
11
+ # Get all of a Conversation's Recordings.
12
+ #
13
+ # @param conversation_id Conversation ID
14
+ # @param [Hash] opts the optional parameters
15
+ # @option opts [Integer] :max_wait_ms The maximum number of milliseconds to wait for the recording to be ready.
16
+ # @option opts [String] :format_id The desired format (WEBM, WAV, etc.)
17
+ # @return [Array<Recording>]
18
+ def get_conversation_id_recordings(conversation_id, opts = {})
19
+ data, status_code, headers = get_conversation_id_recordings_with_http_info(conversation_id, opts)
20
+ return data
21
+ end
22
+
23
+ # Get all of a Conversation&#39;s Recordings.
24
+ #
25
+ # @param conversation_id Conversation ID
26
+ # @param [Hash] opts the optional parameters
27
+ # @option opts [Integer] :max_wait_ms The maximum number of milliseconds to wait for the recording to be ready.
28
+ # @option opts [String] :format_id The desired format (WEBM, WAV, etc.)
29
+ # @return [Array<(Array<Recording>, Fixnum, Hash)>] Array<Recording> data, response status code and response headers
30
+ def get_conversation_id_recordings_with_http_info(conversation_id, opts = {})
31
+ if @api_client.config.debugging
32
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings ..."
33
+ end
34
+
35
+ # verify the required parameter 'conversation_id' is set
36
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings" if conversation_id.nil?
37
+
38
+ if opts[:'format_id'] && !['WEBM', 'WAV'].include?(opts[:'format_id'])
39
+ fail 'invalid value for "format_id", must be one of WEBM, WAV'
40
+ end
41
+
42
+ # resource path
43
+ path = "/api/v1/conversations/{conversationId}/recordings".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s)
44
+
45
+ # query parameters
46
+ query_params = {}
47
+ query_params[:'maxWaitMs'] = opts[:'max_wait_ms'] if opts[:'max_wait_ms']
48
+ query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
49
+
50
+ # header parameters
51
+ header_params = {}
52
+
53
+ # HTTP header 'Accept' (if needed)
54
+ _header_accept = ['application/json']
55
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
56
+
57
+ # HTTP header 'Content-Type'
58
+ _header_content_type = ['application/json']
59
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
60
+
61
+ # form parameters
62
+ form_params = {}
63
+
64
+ # http body (model)
65
+ post_body = nil
66
+
67
+
68
+ auth_names = ['PureCloud Auth']
69
+ data, status_code, headers = @api_client.call_api(:GET, path,
70
+ :header_params => header_params,
71
+ :query_params => query_params,
72
+ :form_params => form_params,
73
+ :body => post_body,
74
+ :auth_names => auth_names,
75
+ :return_type => 'Array<Recording>')
76
+ if @api_client.config.debugging
77
+ @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
78
+ end
79
+ return data, status_code, headers
80
+ end
81
+
82
+ # Gets a specific recording.
83
+ #
84
+ # @param conversation_id Conversation ID
85
+ # @param recording_id Recording ID
86
+ # @param [Hash] opts the optional parameters
87
+ # @option opts [Integer] :max_wait_ms The maximum number of milliseconds to wait for completion.
88
+ # @option opts [String] :format_id The desired format (WEBM, WAV, etc.)
89
+ # @option opts [BOOLEAN] :download requesting a download format of the recording
90
+ # @option opts [String] :file_name the name of the downloaded fileName
91
+ # @return [nil]
92
+ def get_conversation_id_recordings_recording_id(conversation_id, recording_id, opts = {})
93
+ get_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, opts)
94
+ return nil
95
+ end
96
+
97
+ # Gets a specific recording.
98
+ #
99
+ # @param conversation_id Conversation ID
100
+ # @param recording_id Recording ID
101
+ # @param [Hash] opts the optional parameters
102
+ # @option opts [Integer] :max_wait_ms The maximum number of milliseconds to wait for completion.
103
+ # @option opts [String] :format_id The desired format (WEBM, WAV, etc.)
104
+ # @option opts [BOOLEAN] :download requesting a download format of the recording
105
+ # @option opts [String] :file_name the name of the downloaded fileName
106
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
107
+ def get_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, opts = {})
108
+ if @api_client.config.debugging
109
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings_recording_id ..."
110
+ end
111
+
112
+ # verify the required parameter 'conversation_id' is set
113
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings_recording_id" if conversation_id.nil?
114
+
115
+ # verify the required parameter 'recording_id' is set
116
+ fail "Missing the required parameter 'recording_id' when calling get_conversation_id_recordings_recording_id" if recording_id.nil?
117
+
118
+ if opts[:'format_id'] && !['WEBM', 'WAV'].include?(opts[:'format_id'])
119
+ fail 'invalid value for "format_id", must be one of WEBM, WAV'
120
+ end
121
+
122
+ # resource path
123
+ path = "/api/v1/conversations/{conversationId}/recordings/{recordingId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)
124
+
125
+ # query parameters
126
+ query_params = {}
127
+ query_params[:'maxWaitMs'] = opts[:'max_wait_ms'] if opts[:'max_wait_ms']
128
+ query_params[:'formatId'] = opts[:'format_id'] if opts[:'format_id']
129
+ query_params[:'download'] = opts[:'download'] if opts[:'download']
130
+ query_params[:'fileName'] = opts[:'file_name'] if opts[:'file_name']
131
+
132
+ # header parameters
133
+ header_params = {}
134
+
135
+ # HTTP header 'Accept' (if needed)
136
+ _header_accept = ['application/json']
137
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
138
+
139
+ # HTTP header 'Content-Type'
140
+ _header_content_type = ['application/json']
141
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
142
+
143
+ # form parameters
144
+ form_params = {}
145
+
146
+ # http body (model)
147
+ post_body = nil
148
+
149
+
150
+ auth_names = ['PureCloud Auth']
151
+ data, status_code, headers = @api_client.call_api(:GET, path,
152
+ :header_params => header_params,
153
+ :query_params => query_params,
154
+ :form_params => form_params,
155
+ :body => post_body,
156
+ :auth_names => auth_names)
157
+ if @api_client.config.debugging
158
+ @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
159
+ end
160
+ return data, status_code, headers
161
+ end
162
+
163
+ # Updates the retention records on a recording.
164
+ # Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. Use of the query parameter &#39;restoreDays&#39; is deprecated and will be removed in the next major version release. If &#39;restoreDays&#39; is provided, no attempt at updating other retention data will be made. To migrate to the new usage, issuing a request with restoreDays=10 would instead set the archiveDate&#39;s time stamp in the PUT body to 10 days in the future.
165
+ # @param conversation_id Conversation ID
166
+ # @param recording_id Recording ID
167
+ # @param body recording
168
+ # @param [Hash] opts the optional parameters
169
+ # @option opts [Integer] :restore_days The number of days the recording will be available before it is re-archived. Deprecated.
170
+ # @return [nil]
171
+ def put_conversation_id_recordings_recording_id(conversation_id, recording_id, body, opts = {})
172
+ put_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, body, opts)
173
+ return nil
174
+ end
175
+
176
+ # Updates the retention records on a recording.
177
+ # Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. Use of the query parameter &#39;restoreDays&#39; is deprecated and will be removed in the next major version release. If &#39;restoreDays&#39; is provided, no attempt at updating other retention data will be made. To migrate to the new usage, issuing a request with restoreDays=10 would instead set the archiveDate&#39;s time stamp in the PUT body to 10 days in the future.
178
+ # @param conversation_id Conversation ID
179
+ # @param recording_id Recording ID
180
+ # @param body recording
181
+ # @param [Hash] opts the optional parameters
182
+ # @option opts [Integer] :restore_days The number of days the recording will be available before it is re-archived. Deprecated.
183
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
184
+ def put_conversation_id_recordings_recording_id_with_http_info(conversation_id, recording_id, body, opts = {})
185
+ if @api_client.config.debugging
186
+ @api_client.config.logger.debug "Calling API: RecordingApi#put_conversation_id_recordings_recording_id ..."
187
+ end
188
+
189
+ # verify the required parameter 'conversation_id' is set
190
+ fail "Missing the required parameter 'conversation_id' when calling put_conversation_id_recordings_recording_id" if conversation_id.nil?
191
+
192
+ # verify the required parameter 'recording_id' is set
193
+ fail "Missing the required parameter 'recording_id' when calling put_conversation_id_recordings_recording_id" if recording_id.nil?
194
+
195
+ # verify the required parameter 'body' is set
196
+ fail "Missing the required parameter 'body' when calling put_conversation_id_recordings_recording_id" if body.nil?
197
+
198
+ # resource path
199
+ path = "/api/v1/conversations/{conversationId}/recordings/{recordingId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)
200
+
201
+ # query parameters
202
+ query_params = {}
203
+ query_params[:'restoreDays'] = opts[:'restore_days'] if opts[:'restore_days']
204
+
205
+ # header parameters
206
+ header_params = {}
207
+
208
+ # HTTP header 'Accept' (if needed)
209
+ _header_accept = ['application/json']
210
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
211
+
212
+ # HTTP header 'Content-Type'
213
+ _header_content_type = ['application/json']
214
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
215
+
216
+ # form parameters
217
+ form_params = {}
218
+
219
+ # http body (model)
220
+ post_body = @api_client.object_to_http_body(body)
221
+
222
+
223
+ auth_names = ['PureCloud Auth']
224
+ data, status_code, headers = @api_client.call_api(:PUT, path,
225
+ :header_params => header_params,
226
+ :query_params => query_params,
227
+ :form_params => form_params,
228
+ :body => post_body,
229
+ :auth_names => auth_names)
230
+ if @api_client.config.debugging
231
+ @api_client.config.logger.debug "API called: RecordingApi#put_conversation_id_recordings_recording_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
232
+ end
233
+ return data, status_code, headers
234
+ end
235
+
236
+ # Get annotations for recording
237
+ #
238
+ # @param conversation_id Conversation ID
239
+ # @param recording_id Recording ID
240
+ # @param [Hash] opts the optional parameters
241
+ # @return [Array<Annotation>]
242
+ def get_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id, opts = {})
243
+ data, status_code, headers = get_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts)
244
+ return data
245
+ end
246
+
247
+ # Get annotations for recording
248
+ #
249
+ # @param conversation_id Conversation ID
250
+ # @param recording_id Recording ID
251
+ # @param [Hash] opts the optional parameters
252
+ # @return [Array<(Array<Annotation>, Fixnum, Hash)>] Array<Annotation> data, response status code and response headers
253
+ def get_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts = {})
254
+ if @api_client.config.debugging
255
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings_recording_id_annotations ..."
256
+ end
257
+
258
+ # verify the required parameter 'conversation_id' is set
259
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings_recording_id_annotations" if conversation_id.nil?
260
+
261
+ # verify the required parameter 'recording_id' is set
262
+ fail "Missing the required parameter 'recording_id' when calling get_conversation_id_recordings_recording_id_annotations" if recording_id.nil?
263
+
264
+ # resource path
265
+ path = "/api/v1/conversations/{conversationId}/recordings/{recordingId}/annotations".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)
266
+
267
+ # query parameters
268
+ query_params = {}
269
+
270
+ # header parameters
271
+ header_params = {}
272
+
273
+ # HTTP header 'Accept' (if needed)
274
+ _header_accept = ['application/json']
275
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
276
+
277
+ # HTTP header 'Content-Type'
278
+ _header_content_type = ['application/json']
279
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
280
+
281
+ # form parameters
282
+ form_params = {}
283
+
284
+ # http body (model)
285
+ post_body = nil
286
+
287
+
288
+ auth_names = ['PureCloud Auth']
289
+ data, status_code, headers = @api_client.call_api(:GET, path,
290
+ :header_params => header_params,
291
+ :query_params => query_params,
292
+ :form_params => form_params,
293
+ :body => post_body,
294
+ :auth_names => auth_names,
295
+ :return_type => 'Array<Annotation>')
296
+ if @api_client.config.debugging
297
+ @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings_recording_id_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
298
+ end
299
+ return data, status_code, headers
300
+ end
301
+
302
+ # Create annotation
303
+ #
304
+ # @param conversation_id Conversation ID
305
+ # @param recording_id Recording ID
306
+ # @param [Hash] opts the optional parameters
307
+ # @option opts [Annotation] :body annotation
308
+ # @return [Annotation]
309
+ def post_conversation_id_recordings_recording_id_annotations(conversation_id, recording_id, opts = {})
310
+ data, status_code, headers = post_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts)
311
+ return data
312
+ end
313
+
314
+ # Create annotation
315
+ #
316
+ # @param conversation_id Conversation ID
317
+ # @param recording_id Recording ID
318
+ # @param [Hash] opts the optional parameters
319
+ # @option opts [Annotation] :body annotation
320
+ # @return [Array<(Annotation, Fixnum, Hash)>] Annotation data, response status code and response headers
321
+ def post_conversation_id_recordings_recording_id_annotations_with_http_info(conversation_id, recording_id, opts = {})
322
+ if @api_client.config.debugging
323
+ @api_client.config.logger.debug "Calling API: RecordingApi#post_conversation_id_recordings_recording_id_annotations ..."
324
+ end
325
+
326
+ # verify the required parameter 'conversation_id' is set
327
+ fail "Missing the required parameter 'conversation_id' when calling post_conversation_id_recordings_recording_id_annotations" if conversation_id.nil?
328
+
329
+ # verify the required parameter 'recording_id' is set
330
+ fail "Missing the required parameter 'recording_id' when calling post_conversation_id_recordings_recording_id_annotations" if recording_id.nil?
331
+
332
+ # resource path
333
+ path = "/api/v1/conversations/{conversationId}/recordings/{recordingId}/annotations".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s)
334
+
335
+ # query parameters
336
+ query_params = {}
337
+
338
+ # header parameters
339
+ header_params = {}
340
+
341
+ # HTTP header 'Accept' (if needed)
342
+ _header_accept = ['application/json']
343
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
344
+
345
+ # HTTP header 'Content-Type'
346
+ _header_content_type = ['application/json']
347
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
348
+
349
+ # form parameters
350
+ form_params = {}
351
+
352
+ # http body (model)
353
+ post_body = @api_client.object_to_http_body(opts[:'body'])
354
+
355
+
356
+ auth_names = ['PureCloud Auth']
357
+ data, status_code, headers = @api_client.call_api(:POST, path,
358
+ :header_params => header_params,
359
+ :query_params => query_params,
360
+ :form_params => form_params,
361
+ :body => post_body,
362
+ :auth_names => auth_names,
363
+ :return_type => 'Annotation')
364
+ if @api_client.config.debugging
365
+ @api_client.config.logger.debug "API called: RecordingApi#post_conversation_id_recordings_recording_id_annotations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
366
+ end
367
+ return data, status_code, headers
368
+ end
369
+
370
+ # Get annotation
371
+ #
372
+ # @param conversation_id Conversation ID
373
+ # @param recording_id Recording ID
374
+ # @param annotation_id Annotation ID
375
+ # @param [Hash] opts the optional parameters
376
+ # @return [Annotation]
377
+ def get_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {})
378
+ data, status_code, headers = get_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts)
379
+ return data
380
+ end
381
+
382
+ # Get annotation
383
+ #
384
+ # @param conversation_id Conversation ID
385
+ # @param recording_id Recording ID
386
+ # @param annotation_id Annotation ID
387
+ # @param [Hash] opts the optional parameters
388
+ # @return [Array<(Annotation, Fixnum, Hash)>] Annotation data, response status code and response headers
389
+ def get_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {})
390
+ if @api_client.config.debugging
391
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_conversation_id_recordings_recording_id_annotations_annotation_id ..."
392
+ end
393
+
394
+ # verify the required parameter 'conversation_id' is set
395
+ fail "Missing the required parameter 'conversation_id' when calling get_conversation_id_recordings_recording_id_annotations_annotation_id" if conversation_id.nil?
396
+
397
+ # verify the required parameter 'recording_id' is set
398
+ fail "Missing the required parameter 'recording_id' when calling get_conversation_id_recordings_recording_id_annotations_annotation_id" if recording_id.nil?
399
+
400
+ # verify the required parameter 'annotation_id' is set
401
+ fail "Missing the required parameter 'annotation_id' when calling get_conversation_id_recordings_recording_id_annotations_annotation_id" if annotation_id.nil?
402
+
403
+ # resource path
404
+ path = "/api/v1/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
405
+
406
+ # query parameters
407
+ query_params = {}
408
+
409
+ # header parameters
410
+ header_params = {}
411
+
412
+ # HTTP header 'Accept' (if needed)
413
+ _header_accept = ['application/json']
414
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
415
+
416
+ # HTTP header 'Content-Type'
417
+ _header_content_type = ['application/json']
418
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
419
+
420
+ # form parameters
421
+ form_params = {}
422
+
423
+ # http body (model)
424
+ post_body = nil
425
+
426
+
427
+ auth_names = ['PureCloud Auth']
428
+ data, status_code, headers = @api_client.call_api(:GET, path,
429
+ :header_params => header_params,
430
+ :query_params => query_params,
431
+ :form_params => form_params,
432
+ :body => post_body,
433
+ :auth_names => auth_names,
434
+ :return_type => 'Annotation')
435
+ if @api_client.config.debugging
436
+ @api_client.config.logger.debug "API called: RecordingApi#get_conversation_id_recordings_recording_id_annotations_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
437
+ end
438
+ return data, status_code, headers
439
+ end
440
+
441
+ # Update annotation
442
+ #
443
+ # @param conversation_id Conversation ID
444
+ # @param recording_id Recording ID
445
+ # @param annotation_id Annotation ID
446
+ # @param [Hash] opts the optional parameters
447
+ # @option opts [Annotation] :body annotation
448
+ # @return [Annotation]
449
+ def put_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {})
450
+ data, status_code, headers = put_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts)
451
+ return data
452
+ end
453
+
454
+ # Update annotation
455
+ #
456
+ # @param conversation_id Conversation ID
457
+ # @param recording_id Recording ID
458
+ # @param annotation_id Annotation ID
459
+ # @param [Hash] opts the optional parameters
460
+ # @option opts [Annotation] :body annotation
461
+ # @return [Array<(Annotation, Fixnum, Hash)>] Annotation data, response status code and response headers
462
+ def put_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {})
463
+ if @api_client.config.debugging
464
+ @api_client.config.logger.debug "Calling API: RecordingApi#put_conversation_id_recordings_recording_id_annotations_annotation_id ..."
465
+ end
466
+
467
+ # verify the required parameter 'conversation_id' is set
468
+ fail "Missing the required parameter 'conversation_id' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if conversation_id.nil?
469
+
470
+ # verify the required parameter 'recording_id' is set
471
+ fail "Missing the required parameter 'recording_id' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if recording_id.nil?
472
+
473
+ # verify the required parameter 'annotation_id' is set
474
+ fail "Missing the required parameter 'annotation_id' when calling put_conversation_id_recordings_recording_id_annotations_annotation_id" if annotation_id.nil?
475
+
476
+ # resource path
477
+ path = "/api/v1/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
478
+
479
+ # query parameters
480
+ query_params = {}
481
+
482
+ # header parameters
483
+ header_params = {}
484
+
485
+ # HTTP header 'Accept' (if needed)
486
+ _header_accept = ['application/json']
487
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
488
+
489
+ # HTTP header 'Content-Type'
490
+ _header_content_type = ['application/json']
491
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
492
+
493
+ # form parameters
494
+ form_params = {}
495
+
496
+ # http body (model)
497
+ post_body = @api_client.object_to_http_body(opts[:'body'])
498
+
499
+
500
+ auth_names = ['PureCloud Auth']
501
+ data, status_code, headers = @api_client.call_api(:PUT, path,
502
+ :header_params => header_params,
503
+ :query_params => query_params,
504
+ :form_params => form_params,
505
+ :body => post_body,
506
+ :auth_names => auth_names,
507
+ :return_type => 'Annotation')
508
+ if @api_client.config.debugging
509
+ @api_client.config.logger.debug "API called: RecordingApi#put_conversation_id_recordings_recording_id_annotations_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
510
+ end
511
+ return data, status_code, headers
512
+ end
513
+
514
+ # Delete annotation
515
+ #
516
+ # @param conversation_id Conversation ID
517
+ # @param recording_id Recording ID
518
+ # @param annotation_id Annotation ID
519
+ # @param [Hash] opts the optional parameters
520
+ # @return [nil]
521
+ def delete_conversation_id_recordings_recording_id_annotations_annotation_id(conversation_id, recording_id, annotation_id, opts = {})
522
+ delete_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts)
523
+ return nil
524
+ end
525
+
526
+ # Delete annotation
527
+ #
528
+ # @param conversation_id Conversation ID
529
+ # @param recording_id Recording ID
530
+ # @param annotation_id Annotation ID
531
+ # @param [Hash] opts the optional parameters
532
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
533
+ def delete_conversation_id_recordings_recording_id_annotations_annotation_id_with_http_info(conversation_id, recording_id, annotation_id, opts = {})
534
+ if @api_client.config.debugging
535
+ @api_client.config.logger.debug "Calling API: RecordingApi#delete_conversation_id_recordings_recording_id_annotations_annotation_id ..."
536
+ end
537
+
538
+ # verify the required parameter 'conversation_id' is set
539
+ fail "Missing the required parameter 'conversation_id' when calling delete_conversation_id_recordings_recording_id_annotations_annotation_id" if conversation_id.nil?
540
+
541
+ # verify the required parameter 'recording_id' is set
542
+ fail "Missing the required parameter 'recording_id' when calling delete_conversation_id_recordings_recording_id_annotations_annotation_id" if recording_id.nil?
543
+
544
+ # verify the required parameter 'annotation_id' is set
545
+ fail "Missing the required parameter 'annotation_id' when calling delete_conversation_id_recordings_recording_id_annotations_annotation_id" if annotation_id.nil?
546
+
547
+ # resource path
548
+ path = "/api/v1/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId}".sub('{format}','json').sub('{' + 'conversationId' + '}', conversation_id.to_s).sub('{' + 'recordingId' + '}', recording_id.to_s).sub('{' + 'annotationId' + '}', annotation_id.to_s)
549
+
550
+ # query parameters
551
+ query_params = {}
552
+
553
+ # header parameters
554
+ header_params = {}
555
+
556
+ # HTTP header 'Accept' (if needed)
557
+ _header_accept = ['application/json']
558
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
559
+
560
+ # HTTP header 'Content-Type'
561
+ _header_content_type = ['application/json']
562
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
563
+
564
+ # form parameters
565
+ form_params = {}
566
+
567
+ # http body (model)
568
+ post_body = nil
569
+
570
+
571
+ auth_names = ['PureCloud Auth']
572
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
573
+ :header_params => header_params,
574
+ :query_params => query_params,
575
+ :form_params => form_params,
576
+ :body => post_body,
577
+ :auth_names => auth_names)
578
+ if @api_client.config.debugging
579
+ @api_client.config.logger.debug "API called: RecordingApi#delete_conversation_id_recordings_recording_id_annotations_annotation_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
580
+ end
581
+ return data, status_code, headers
582
+ end
583
+
584
+ # Gets all orphan recordings
585
+ #
586
+ # @param [Hash] opts the optional parameters
587
+ # @option opts [Integer] :page_size The total page size requested
588
+ # @option opts [Integer] :page_number The page number requested
589
+ # @option opts [String] :sort_by variable name requested to sort by
590
+ # @option opts [Array<String>] :expand variable name requested by expand list
591
+ # @return [OrphanRecordingListing]
592
+ def get_orphanrecordings(opts = {})
593
+ data, status_code, headers = get_orphanrecordings_with_http_info(opts)
594
+ return data
595
+ end
596
+
597
+ # Gets all orphan recordings
598
+ #
599
+ # @param [Hash] opts the optional parameters
600
+ # @option opts [Integer] :page_size The total page size requested
601
+ # @option opts [Integer] :page_number The page number requested
602
+ # @option opts [String] :sort_by variable name requested to sort by
603
+ # @option opts [Array<String>] :expand variable name requested by expand list
604
+ # @return [Array<(OrphanRecordingListing, Fixnum, Hash)>] OrphanRecordingListing data, response status code and response headers
605
+ def get_orphanrecordings_with_http_info(opts = {})
606
+ if @api_client.config.debugging
607
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_orphanrecordings ..."
608
+ end
609
+
610
+ # resource path
611
+ path = "/api/v1/orphanrecordings".sub('{format}','json')
612
+
613
+ # query parameters
614
+ query_params = {}
615
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
616
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
617
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
618
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
619
+
620
+ # header parameters
621
+ header_params = {}
622
+
623
+ # HTTP header 'Accept' (if needed)
624
+ _header_accept = ['application/json']
625
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
626
+
627
+ # HTTP header 'Content-Type'
628
+ _header_content_type = ['application/json']
629
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
630
+
631
+ # form parameters
632
+ form_params = {}
633
+
634
+ # http body (model)
635
+ post_body = nil
636
+
637
+
638
+ auth_names = ['PureCloud Auth']
639
+ data, status_code, headers = @api_client.call_api(:GET, path,
640
+ :header_params => header_params,
641
+ :query_params => query_params,
642
+ :form_params => form_params,
643
+ :body => post_body,
644
+ :auth_names => auth_names,
645
+ :return_type => 'OrphanRecordingListing')
646
+ if @api_client.config.debugging
647
+ @api_client.config.logger.debug "API called: RecordingApi#get_orphanrecordings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
648
+ end
649
+ return data, status_code, headers
650
+ end
651
+
652
+ # Gets a single orphan recording
653
+ #
654
+ # @param orphan_id Orphan ID
655
+ # @param [Hash] opts the optional parameters
656
+ # @return [OrphanRecording]
657
+ def get_orphan_id(orphan_id, opts = {})
658
+ data, status_code, headers = get_orphan_id_with_http_info(orphan_id, opts)
659
+ return data
660
+ end
661
+
662
+ # Gets a single orphan recording
663
+ #
664
+ # @param orphan_id Orphan ID
665
+ # @param [Hash] opts the optional parameters
666
+ # @return [Array<(OrphanRecording, Fixnum, Hash)>] OrphanRecording data, response status code and response headers
667
+ def get_orphan_id_with_http_info(orphan_id, opts = {})
668
+ if @api_client.config.debugging
669
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_orphan_id ..."
670
+ end
671
+
672
+ # verify the required parameter 'orphan_id' is set
673
+ fail "Missing the required parameter 'orphan_id' when calling get_orphan_id" if orphan_id.nil?
674
+
675
+ # resource path
676
+ path = "/api/v1/orphanrecordings/{orphanId}".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_id.to_s)
677
+
678
+ # query parameters
679
+ query_params = {}
680
+
681
+ # header parameters
682
+ header_params = {}
683
+
684
+ # HTTP header 'Accept' (if needed)
685
+ _header_accept = ['application/json']
686
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
687
+
688
+ # HTTP header 'Content-Type'
689
+ _header_content_type = ['application/json']
690
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
691
+
692
+ # form parameters
693
+ form_params = {}
694
+
695
+ # http body (model)
696
+ post_body = nil
697
+
698
+
699
+ auth_names = ['PureCloud Auth']
700
+ data, status_code, headers = @api_client.call_api(:GET, path,
701
+ :header_params => header_params,
702
+ :query_params => query_params,
703
+ :form_params => form_params,
704
+ :body => post_body,
705
+ :auth_names => auth_names,
706
+ :return_type => 'OrphanRecording')
707
+ if @api_client.config.debugging
708
+ @api_client.config.logger.debug "API called: RecordingApi#get_orphan_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
709
+ end
710
+ return data, status_code, headers
711
+ end
712
+
713
+ # deletes a single orphan recording
714
+ #
715
+ # @param orphan_id Orphan ID
716
+ # @param [Hash] opts the optional parameters
717
+ # @return [OrphanRecording]
718
+ def delete_orphan_id(orphan_id, opts = {})
719
+ data, status_code, headers = delete_orphan_id_with_http_info(orphan_id, opts)
720
+ return data
721
+ end
722
+
723
+ # deletes a single orphan recording
724
+ #
725
+ # @param orphan_id Orphan ID
726
+ # @param [Hash] opts the optional parameters
727
+ # @return [Array<(OrphanRecording, Fixnum, Hash)>] OrphanRecording data, response status code and response headers
728
+ def delete_orphan_id_with_http_info(orphan_id, opts = {})
729
+ if @api_client.config.debugging
730
+ @api_client.config.logger.debug "Calling API: RecordingApi#delete_orphan_id ..."
731
+ end
732
+
733
+ # verify the required parameter 'orphan_id' is set
734
+ fail "Missing the required parameter 'orphan_id' when calling delete_orphan_id" if orphan_id.nil?
735
+
736
+ # resource path
737
+ path = "/api/v1/orphanrecordings/{orphanId}".sub('{format}','json').sub('{' + 'orphanId' + '}', orphan_id.to_s)
738
+
739
+ # query parameters
740
+ query_params = {}
741
+
742
+ # header parameters
743
+ header_params = {}
744
+
745
+ # HTTP header 'Accept' (if needed)
746
+ _header_accept = ['application/json']
747
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
748
+
749
+ # HTTP header 'Content-Type'
750
+ _header_content_type = ['application/json']
751
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
752
+
753
+ # form parameters
754
+ form_params = {}
755
+
756
+ # http body (model)
757
+ post_body = nil
758
+
759
+
760
+ auth_names = ['PureCloud Auth']
761
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
762
+ :header_params => header_params,
763
+ :query_params => query_params,
764
+ :form_params => form_params,
765
+ :body => post_body,
766
+ :auth_names => auth_names,
767
+ :return_type => 'OrphanRecording')
768
+ if @api_client.config.debugging
769
+ @api_client.config.logger.debug "API called: RecordingApi#delete_orphan_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
770
+ end
771
+ return data, status_code, headers
772
+ end
773
+
774
+ # Gets media retention policy list with query options to filter on name and enabled.
775
+ # for a less verbose response, add summary=true to this endpoint
776
+ # @param [Hash] opts the optional parameters
777
+ # @option opts [Integer] :page_size The total page size requested
778
+ # @option opts [Integer] :page_number The page number requested
779
+ # @option opts [String] :sort_by variable name requested to sort by
780
+ # @option opts [Array<String>] :expand variable name requested by expand list
781
+ # @option opts [String] :name the policy name - used for filtering results in searches.
782
+ # @option opts [BOOLEAN] :enabled checks to see if policy is enabled - use enabled = true or enabled = false
783
+ # @option opts [BOOLEAN] :summary provides a less verbose response of policy lists.
784
+ # @option opts [BOOLEAN] :has_errors provides a way to fetch all policies with errors or policies that do not have errors
785
+ # @return [PolicyEntityListing]
786
+ def get_mediaretentionpolicies(opts = {})
787
+ data, status_code, headers = get_mediaretentionpolicies_with_http_info(opts)
788
+ return data
789
+ end
790
+
791
+ # Gets media retention policy list with query options to filter on name and enabled.
792
+ # for a less verbose response, add summary=true to this endpoint
793
+ # @param [Hash] opts the optional parameters
794
+ # @option opts [Integer] :page_size The total page size requested
795
+ # @option opts [Integer] :page_number The page number requested
796
+ # @option opts [String] :sort_by variable name requested to sort by
797
+ # @option opts [Array<String>] :expand variable name requested by expand list
798
+ # @option opts [String] :name the policy name - used for filtering results in searches.
799
+ # @option opts [BOOLEAN] :enabled checks to see if policy is enabled - use enabled = true or enabled = false
800
+ # @option opts [BOOLEAN] :summary provides a less verbose response of policy lists.
801
+ # @option opts [BOOLEAN] :has_errors provides a way to fetch all policies with errors or policies that do not have errors
802
+ # @return [Array<(PolicyEntityListing, Fixnum, Hash)>] PolicyEntityListing data, response status code and response headers
803
+ def get_mediaretentionpolicies_with_http_info(opts = {})
804
+ if @api_client.config.debugging
805
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_mediaretentionpolicies ..."
806
+ end
807
+
808
+ # resource path
809
+ path = "/api/v1/recording/mediaretentionpolicies".sub('{format}','json')
810
+
811
+ # query parameters
812
+ query_params = {}
813
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
814
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
815
+ query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
816
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
817
+ query_params[:'name'] = opts[:'name'] if opts[:'name']
818
+ query_params[:'enabled'] = opts[:'enabled'] if opts[:'enabled']
819
+ query_params[:'summary'] = opts[:'summary'] if opts[:'summary']
820
+ query_params[:'hasErrors'] = opts[:'has_errors'] if opts[:'has_errors']
821
+
822
+ # header parameters
823
+ header_params = {}
824
+
825
+ # HTTP header 'Accept' (if needed)
826
+ _header_accept = ['application/json']
827
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
828
+
829
+ # HTTP header 'Content-Type'
830
+ _header_content_type = ['application/json']
831
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
832
+
833
+ # form parameters
834
+ form_params = {}
835
+
836
+ # http body (model)
837
+ post_body = nil
838
+
839
+
840
+ auth_names = ['PureCloud Auth']
841
+ data, status_code, headers = @api_client.call_api(:GET, path,
842
+ :header_params => header_params,
843
+ :query_params => query_params,
844
+ :form_params => form_params,
845
+ :body => post_body,
846
+ :auth_names => auth_names,
847
+ :return_type => 'PolicyEntityListing')
848
+ if @api_client.config.debugging
849
+ @api_client.config.logger.debug "API called: RecordingApi#get_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
850
+ end
851
+ return data, status_code, headers
852
+ end
853
+
854
+ # Create media retention policy
855
+ #
856
+ # @param [Hash] opts the optional parameters
857
+ # @option opts [Policy] :body Policy
858
+ # @return [Policy]
859
+ def post_mediaretentionpolicies(opts = {})
860
+ data, status_code, headers = post_mediaretentionpolicies_with_http_info(opts)
861
+ return data
862
+ end
863
+
864
+ # Create media retention policy
865
+ #
866
+ # @param [Hash] opts the optional parameters
867
+ # @option opts [Policy] :body Policy
868
+ # @return [Array<(Policy, Fixnum, Hash)>] Policy data, response status code and response headers
869
+ def post_mediaretentionpolicies_with_http_info(opts = {})
870
+ if @api_client.config.debugging
871
+ @api_client.config.logger.debug "Calling API: RecordingApi#post_mediaretentionpolicies ..."
872
+ end
873
+
874
+ # resource path
875
+ path = "/api/v1/recording/mediaretentionpolicies".sub('{format}','json')
876
+
877
+ # query parameters
878
+ query_params = {}
879
+
880
+ # header parameters
881
+ header_params = {}
882
+
883
+ # HTTP header 'Accept' (if needed)
884
+ _header_accept = ['application/json']
885
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
886
+
887
+ # HTTP header 'Content-Type'
888
+ _header_content_type = ['application/json']
889
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
890
+
891
+ # form parameters
892
+ form_params = {}
893
+
894
+ # http body (model)
895
+ post_body = @api_client.object_to_http_body(opts[:'body'])
896
+
897
+
898
+ auth_names = ['PureCloud Auth']
899
+ data, status_code, headers = @api_client.call_api(:POST, path,
900
+ :header_params => header_params,
901
+ :query_params => query_params,
902
+ :form_params => form_params,
903
+ :body => post_body,
904
+ :auth_names => auth_names,
905
+ :return_type => 'Policy')
906
+ if @api_client.config.debugging
907
+ @api_client.config.logger.debug "API called: RecordingApi#post_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
908
+ end
909
+ return data, status_code, headers
910
+ end
911
+
912
+ # Delete media retention policies
913
+ # Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.
914
+ # @param ids
915
+ # @param [Hash] opts the optional parameters
916
+ # @return [String]
917
+ def delete_mediaretentionpolicies(ids, opts = {})
918
+ data, status_code, headers = delete_mediaretentionpolicies_with_http_info(ids, opts)
919
+ return data
920
+ end
921
+
922
+ # Delete media retention policies
923
+ # Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the query param.
924
+ # @param ids
925
+ # @param [Hash] opts the optional parameters
926
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
927
+ def delete_mediaretentionpolicies_with_http_info(ids, opts = {})
928
+ if @api_client.config.debugging
929
+ @api_client.config.logger.debug "Calling API: RecordingApi#delete_mediaretentionpolicies ..."
930
+ end
931
+
932
+ # verify the required parameter 'ids' is set
933
+ fail "Missing the required parameter 'ids' when calling delete_mediaretentionpolicies" if ids.nil?
934
+
935
+ # resource path
936
+ path = "/api/v1/recording/mediaretentionpolicies".sub('{format}','json')
937
+
938
+ # query parameters
939
+ query_params = {}
940
+ query_params[:'ids'] = ids
941
+
942
+ # header parameters
943
+ header_params = {}
944
+
945
+ # HTTP header 'Accept' (if needed)
946
+ _header_accept = ['application/json']
947
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
948
+
949
+ # HTTP header 'Content-Type'
950
+ _header_content_type = ['application/json']
951
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
952
+
953
+ # form parameters
954
+ form_params = {}
955
+
956
+ # http body (model)
957
+ post_body = nil
958
+
959
+
960
+ auth_names = ['PureCloud Auth']
961
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
962
+ :header_params => header_params,
963
+ :query_params => query_params,
964
+ :form_params => form_params,
965
+ :body => post_body,
966
+ :auth_names => auth_names,
967
+ :return_type => 'String')
968
+ if @api_client.config.debugging
969
+ @api_client.config.logger.debug "API called: RecordingApi#delete_mediaretentionpolicies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
970
+ end
971
+ return data, status_code, headers
972
+ end
973
+
974
+ # Get a media retention policy
975
+ #
976
+ # @param policy_id Policy ID
977
+ # @param [Hash] opts the optional parameters
978
+ # @return [Policy]
979
+ def get_mediaretentionpolicies_policy_id(policy_id, opts = {})
980
+ data, status_code, headers = get_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts)
981
+ return data
982
+ end
983
+
984
+ # Get a media retention policy
985
+ #
986
+ # @param policy_id Policy ID
987
+ # @param [Hash] opts the optional parameters
988
+ # @return [Array<(Policy, Fixnum, Hash)>] Policy data, response status code and response headers
989
+ def get_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {})
990
+ if @api_client.config.debugging
991
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_mediaretentionpolicies_policy_id ..."
992
+ end
993
+
994
+ # verify the required parameter 'policy_id' is set
995
+ fail "Missing the required parameter 'policy_id' when calling get_mediaretentionpolicies_policy_id" if policy_id.nil?
996
+
997
+ # resource path
998
+ path = "/api/v1/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)
999
+
1000
+ # query parameters
1001
+ query_params = {}
1002
+
1003
+ # header parameters
1004
+ header_params = {}
1005
+
1006
+ # HTTP header 'Accept' (if needed)
1007
+ _header_accept = ['application/json']
1008
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1009
+
1010
+ # HTTP header 'Content-Type'
1011
+ _header_content_type = ['application/json']
1012
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1013
+
1014
+ # form parameters
1015
+ form_params = {}
1016
+
1017
+ # http body (model)
1018
+ post_body = nil
1019
+
1020
+
1021
+ auth_names = ['PureCloud Auth']
1022
+ data, status_code, headers = @api_client.call_api(:GET, path,
1023
+ :header_params => header_params,
1024
+ :query_params => query_params,
1025
+ :form_params => form_params,
1026
+ :body => post_body,
1027
+ :auth_names => auth_names,
1028
+ :return_type => 'Policy')
1029
+ if @api_client.config.debugging
1030
+ @api_client.config.logger.debug "API called: RecordingApi#get_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1031
+ end
1032
+ return data, status_code, headers
1033
+ end
1034
+
1035
+ # Update a media retention policy
1036
+ #
1037
+ # @param policy_id Policy ID
1038
+ # @param [Hash] opts the optional parameters
1039
+ # @option opts [Policy] :body Policy
1040
+ # @return [Policy]
1041
+ def put_mediaretentionpolicies_policy_id(policy_id, opts = {})
1042
+ data, status_code, headers = put_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts)
1043
+ return data
1044
+ end
1045
+
1046
+ # Update a media retention policy
1047
+ #
1048
+ # @param policy_id Policy ID
1049
+ # @param [Hash] opts the optional parameters
1050
+ # @option opts [Policy] :body Policy
1051
+ # @return [Array<(Policy, Fixnum, Hash)>] Policy data, response status code and response headers
1052
+ def put_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {})
1053
+ if @api_client.config.debugging
1054
+ @api_client.config.logger.debug "Calling API: RecordingApi#put_mediaretentionpolicies_policy_id ..."
1055
+ end
1056
+
1057
+ # verify the required parameter 'policy_id' is set
1058
+ fail "Missing the required parameter 'policy_id' when calling put_mediaretentionpolicies_policy_id" if policy_id.nil?
1059
+
1060
+ # resource path
1061
+ path = "/api/v1/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)
1062
+
1063
+ # query parameters
1064
+ query_params = {}
1065
+
1066
+ # header parameters
1067
+ header_params = {}
1068
+
1069
+ # HTTP header 'Accept' (if needed)
1070
+ _header_accept = ['application/json']
1071
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1072
+
1073
+ # HTTP header 'Content-Type'
1074
+ _header_content_type = ['application/json']
1075
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1076
+
1077
+ # form parameters
1078
+ form_params = {}
1079
+
1080
+ # http body (model)
1081
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1082
+
1083
+
1084
+ auth_names = ['PureCloud Auth']
1085
+ data, status_code, headers = @api_client.call_api(:PUT, path,
1086
+ :header_params => header_params,
1087
+ :query_params => query_params,
1088
+ :form_params => form_params,
1089
+ :body => post_body,
1090
+ :auth_names => auth_names,
1091
+ :return_type => 'Policy')
1092
+ if @api_client.config.debugging
1093
+ @api_client.config.logger.debug "API called: RecordingApi#put_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1094
+ end
1095
+ return data, status_code, headers
1096
+ end
1097
+
1098
+ # Delete a media retention policy
1099
+ #
1100
+ # @param policy_id Policy ID
1101
+ # @param [Hash] opts the optional parameters
1102
+ # @return [String]
1103
+ def delete_mediaretentionpolicies_policy_id(policy_id, opts = {})
1104
+ data, status_code, headers = delete_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts)
1105
+ return data
1106
+ end
1107
+
1108
+ # Delete a media retention policy
1109
+ #
1110
+ # @param policy_id Policy ID
1111
+ # @param [Hash] opts the optional parameters
1112
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
1113
+ def delete_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {})
1114
+ if @api_client.config.debugging
1115
+ @api_client.config.logger.debug "Calling API: RecordingApi#delete_mediaretentionpolicies_policy_id ..."
1116
+ end
1117
+
1118
+ # verify the required parameter 'policy_id' is set
1119
+ fail "Missing the required parameter 'policy_id' when calling delete_mediaretentionpolicies_policy_id" if policy_id.nil?
1120
+
1121
+ # resource path
1122
+ path = "/api/v1/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)
1123
+
1124
+ # query parameters
1125
+ query_params = {}
1126
+
1127
+ # header parameters
1128
+ header_params = {}
1129
+
1130
+ # HTTP header 'Accept' (if needed)
1131
+ _header_accept = ['application/json']
1132
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1133
+
1134
+ # HTTP header 'Content-Type'
1135
+ _header_content_type = ['application/json']
1136
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1137
+
1138
+ # form parameters
1139
+ form_params = {}
1140
+
1141
+ # http body (model)
1142
+ post_body = nil
1143
+
1144
+
1145
+ auth_names = ['PureCloud Auth']
1146
+ data, status_code, headers = @api_client.call_api(:DELETE, path,
1147
+ :header_params => header_params,
1148
+ :query_params => query_params,
1149
+ :form_params => form_params,
1150
+ :body => post_body,
1151
+ :auth_names => auth_names,
1152
+ :return_type => 'String')
1153
+ if @api_client.config.debugging
1154
+ @api_client.config.logger.debug "API called: RecordingApi#delete_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1155
+ end
1156
+ return data, status_code, headers
1157
+ end
1158
+
1159
+ # Patch a media retention policy
1160
+ #
1161
+ # @param policy_id Policy ID
1162
+ # @param [Hash] opts the optional parameters
1163
+ # @option opts [Policy] :body Policy
1164
+ # @return [Policy]
1165
+ def patch_mediaretentionpolicies_policy_id(policy_id, opts = {})
1166
+ data, status_code, headers = patch_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts)
1167
+ return data
1168
+ end
1169
+
1170
+ # Patch a media retention policy
1171
+ #
1172
+ # @param policy_id Policy ID
1173
+ # @param [Hash] opts the optional parameters
1174
+ # @option opts [Policy] :body Policy
1175
+ # @return [Array<(Policy, Fixnum, Hash)>] Policy data, response status code and response headers
1176
+ def patch_mediaretentionpolicies_policy_id_with_http_info(policy_id, opts = {})
1177
+ if @api_client.config.debugging
1178
+ @api_client.config.logger.debug "Calling API: RecordingApi#patch_mediaretentionpolicies_policy_id ..."
1179
+ end
1180
+
1181
+ # verify the required parameter 'policy_id' is set
1182
+ fail "Missing the required parameter 'policy_id' when calling patch_mediaretentionpolicies_policy_id" if policy_id.nil?
1183
+
1184
+ # resource path
1185
+ path = "/api/v1/recording/mediaretentionpolicies/{policyId}".sub('{format}','json').sub('{' + 'policyId' + '}', policy_id.to_s)
1186
+
1187
+ # query parameters
1188
+ query_params = {}
1189
+
1190
+ # header parameters
1191
+ header_params = {}
1192
+
1193
+ # HTTP header 'Accept' (if needed)
1194
+ _header_accept = ['application/json']
1195
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1196
+
1197
+ # HTTP header 'Content-Type'
1198
+ _header_content_type = ['application/json']
1199
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1200
+
1201
+ # form parameters
1202
+ form_params = {}
1203
+
1204
+ # http body (model)
1205
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1206
+
1207
+
1208
+ auth_names = ['PureCloud Auth']
1209
+ data, status_code, headers = @api_client.call_api(:PATCH, path,
1210
+ :header_params => header_params,
1211
+ :query_params => query_params,
1212
+ :form_params => form_params,
1213
+ :body => post_body,
1214
+ :auth_names => auth_names,
1215
+ :return_type => 'Policy')
1216
+ if @api_client.config.debugging
1217
+ @api_client.config.logger.debug "API called: RecordingApi#patch_mediaretentionpolicies_policy_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1218
+ end
1219
+ return data, status_code, headers
1220
+ end
1221
+
1222
+ # Get the Recording Settings for the Organization
1223
+ #
1224
+ # @param [Hash] opts the optional parameters
1225
+ # @option opts [BOOLEAN] :create_default If no settings are found, a new one is created with default values
1226
+ # @return [RecordingSettings]
1227
+ def get_settings(opts = {})
1228
+ data, status_code, headers = get_settings_with_http_info(opts)
1229
+ return data
1230
+ end
1231
+
1232
+ # Get the Recording Settings for the Organization
1233
+ #
1234
+ # @param [Hash] opts the optional parameters
1235
+ # @option opts [BOOLEAN] :create_default If no settings are found, a new one is created with default values
1236
+ # @return [Array<(RecordingSettings, Fixnum, Hash)>] RecordingSettings data, response status code and response headers
1237
+ def get_settings_with_http_info(opts = {})
1238
+ if @api_client.config.debugging
1239
+ @api_client.config.logger.debug "Calling API: RecordingApi#get_settings ..."
1240
+ end
1241
+
1242
+ # resource path
1243
+ path = "/api/v1/recording/settings".sub('{format}','json')
1244
+
1245
+ # query parameters
1246
+ query_params = {}
1247
+ query_params[:'createDefault'] = opts[:'create_default'] if opts[:'create_default']
1248
+
1249
+ # header parameters
1250
+ header_params = {}
1251
+
1252
+ # HTTP header 'Accept' (if needed)
1253
+ _header_accept = ['application/json']
1254
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1255
+
1256
+ # HTTP header 'Content-Type'
1257
+ _header_content_type = ['application/json']
1258
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1259
+
1260
+ # form parameters
1261
+ form_params = {}
1262
+
1263
+ # http body (model)
1264
+ post_body = nil
1265
+
1266
+
1267
+ auth_names = ['PureCloud Auth']
1268
+ data, status_code, headers = @api_client.call_api(:GET, path,
1269
+ :header_params => header_params,
1270
+ :query_params => query_params,
1271
+ :form_params => form_params,
1272
+ :body => post_body,
1273
+ :auth_names => auth_names,
1274
+ :return_type => 'RecordingSettings')
1275
+ if @api_client.config.debugging
1276
+ @api_client.config.logger.debug "API called: RecordingApi#get_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1277
+ end
1278
+ return data, status_code, headers
1279
+ end
1280
+
1281
+ # Update the Recording Settings for the Organization
1282
+ #
1283
+ # @param [Hash] opts the optional parameters
1284
+ # @option opts [RecordingSettings] :body
1285
+ # @return [RecordingSettings]
1286
+ def put_settings(opts = {})
1287
+ data, status_code, headers = put_settings_with_http_info(opts)
1288
+ return data
1289
+ end
1290
+
1291
+ # Update the Recording Settings for the Organization
1292
+ #
1293
+ # @param [Hash] opts the optional parameters
1294
+ # @option opts [RecordingSettings] :body
1295
+ # @return [Array<(RecordingSettings, Fixnum, Hash)>] RecordingSettings data, response status code and response headers
1296
+ def put_settings_with_http_info(opts = {})
1297
+ if @api_client.config.debugging
1298
+ @api_client.config.logger.debug "Calling API: RecordingApi#put_settings ..."
1299
+ end
1300
+
1301
+ # resource path
1302
+ path = "/api/v1/recording/settings".sub('{format}','json')
1303
+
1304
+ # query parameters
1305
+ query_params = {}
1306
+
1307
+ # header parameters
1308
+ header_params = {}
1309
+
1310
+ # HTTP header 'Accept' (if needed)
1311
+ _header_accept = ['application/json']
1312
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
1313
+
1314
+ # HTTP header 'Content-Type'
1315
+ _header_content_type = ['application/json']
1316
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
1317
+
1318
+ # form parameters
1319
+ form_params = {}
1320
+
1321
+ # http body (model)
1322
+ post_body = @api_client.object_to_http_body(opts[:'body'])
1323
+
1324
+
1325
+ auth_names = ['PureCloud Auth']
1326
+ data, status_code, headers = @api_client.call_api(:PUT, path,
1327
+ :header_params => header_params,
1328
+ :query_params => query_params,
1329
+ :form_params => form_params,
1330
+ :body => post_body,
1331
+ :auth_names => auth_names,
1332
+ :return_type => 'RecordingSettings')
1333
+ if @api_client.config.debugging
1334
+ @api_client.config.logger.debug "API called: RecordingApi#put_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1335
+ end
1336
+ return data, status_code, headers
1337
+ end
1338
+ end
1339
+ end
1340
+
1341
+
1342
+
1343
+