purecloud 0.18.0 → 0.25.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +2 -2
- data/Gemfile.lock +2 -2
- data/README.md +1 -7
- data/config-ruby.json +1 -1
- data/extensions/auth.rb +2 -2
- data/lib/purecloud.rb +110 -75
- data/lib/purecloud/api/architect_api.rb +3127 -74
- data/lib/purecloud/api/attributes_api.rb +33 -33
- data/lib/purecloud/api/authorization_api.rb +83 -83
- data/lib/purecloud/api/compliance_api.rb +5 -5
- data/lib/purecloud/api/configuration_api.rb +594 -397
- data/lib/purecloud/api/content_management_api.rb +183 -183
- data/lib/purecloud/api/conversations_api.rb +289 -159
- data/lib/purecloud/api/downloads_api.rb +6 -6
- data/lib/purecloud/api/external_contacts_api.rb +1693 -0
- data/lib/purecloud/api/fax_api.rb +24 -24
- data/lib/purecloud/api/geolocation_api.rb +14 -14
- data/lib/purecloud/api/greetings_api.rb +68 -68
- data/lib/purecloud/api/groups_api.rb +31 -20
- data/lib/purecloud/api/languages_api.rb +18 -11
- data/lib/purecloud/api/licensing_api.rb +5 -5
- data/lib/purecloud/api/locations_api.rb +11 -11
- data/lib/purecloud/api/notifications_api.rb +41 -41
- data/lib/purecloud/api/o_auth_api.rb +69 -69
- data/lib/purecloud/api/outbound_api.rb +505 -325
- data/lib/purecloud/api/presence_api.rb +65 -65
- data/lib/purecloud/api/quality_api.rb +66 -639
- data/lib/purecloud/api/recording_api.rb +1343 -0
- data/lib/purecloud/api/response_management_api.rb +687 -0
- data/lib/purecloud/api/routing_api.rb +224 -170
- data/lib/purecloud/api/scripts_api.rb +52 -52
- data/lib/purecloud/api/search_api.rb +5 -5
- data/lib/purecloud/api/stations_api.rb +8 -8
- data/lib/purecloud/api/telephony_providers_edge_api.rb +138 -138
- data/lib/purecloud/api/user_recordings_api.rb +29 -29
- data/lib/purecloud/api/users_api.rb +123 -123
- data/lib/purecloud/api/utilities_api.rb +71 -15
- data/lib/purecloud/api/voicemail_api.rb +42 -42
- data/lib/purecloud/api_client.rb +1 -1
- data/lib/purecloud/models/address.rb +49 -51
- data/lib/purecloud/models/attribute_filter_item.rb +177 -0
- data/lib/purecloud/models/automate_queue_member_entity_listing.rb +238 -0
- data/lib/purecloud/models/available_additional_service.rb +40 -1
- data/lib/purecloud/models/{topic_entity_listing.rb → available_topic_entity_listing.rb} +1 -1
- data/lib/purecloud/models/call.rb +36 -5
- data/lib/purecloud/models/{line_properties.rb → call_command.rb} +13 -3
- data/lib/purecloud/models/callback.rb +15 -4
- data/lib/purecloud/models/campaign.rb +219 -17
- data/lib/purecloud/models/campaign_progress.rb +186 -0
- data/lib/purecloud/models/channel_topic_entity_listing.rb +238 -0
- data/lib/purecloud/models/charge.rb +14 -4
- data/lib/purecloud/models/{attribute_value.rb → client_text_table_transform.rb} +52 -82
- data/lib/purecloud/models/contact.rb +1 -1
- data/lib/purecloud/models/contact_list.rb +111 -1
- data/lib/purecloud/models/contact_listing.rb +238 -0
- data/lib/purecloud/models/content_attribute_filter_item.rb +177 -0
- data/lib/purecloud/models/content_facet_filter_item.rb +1 -1
- data/lib/purecloud/models/content_query_request.rb +16 -4
- data/lib/purecloud/models/control.rb +221 -0
- data/lib/purecloud/models/{flow_activate_request.rb → control_options.rb} +18 -12
- data/lib/purecloud/models/create_callback_command.rb +200 -0
- data/lib/purecloud/models/discount.rb +220 -0
- data/lib/purecloud/models/document.rb +13 -1
- data/lib/purecloud/models/document_attribute.rb +158 -0
- data/lib/purecloud/models/document_update.rb +28 -16
- data/lib/purecloud/models/document_upload.rb +4 -16
- data/lib/purecloud/models/domain_voice_rate_extended_response_item_entity_listing.rb +238 -0
- data/lib/purecloud/models/domain_voice_rate_international_response_item_entity_listing.rb +238 -0
- data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb +1 -1
- data/lib/purecloud/models/edge_line.rb +1 -1
- data/lib/purecloud/models/edge_logs_job.rb +181 -0
- data/lib/purecloud/models/edge_logs_job_file.rb +243 -0
- data/lib/purecloud/models/edge_logs_job_request.rb +168 -0
- data/lib/purecloud/models/{backend_work_item_data_element.rb → edge_logs_job_response.rb} +16 -24
- data/lib/purecloud/models/{flow_lock_request.rb → edge_logs_job_upload_request.rb} +10 -12
- data/lib/purecloud/models/email.rb +15 -4
- data/lib/purecloud/models/endpoint.rb +1 -1
- data/lib/purecloud/models/{flow_associate_workspaces_request.rb → estimated_wait_time_predictions.rb} +10 -11
- data/lib/purecloud/models/external_contact.rb +320 -0
- data/lib/purecloud/models/external_organization.rb +306 -0
- data/lib/purecloud/models/external_organization_listing.rb +238 -0
- data/lib/purecloud/models/facet_filter_item.rb +1 -1
- data/lib/purecloud/models/flow_body.rb +1 -1
- data/lib/purecloud/models/flow_body_format.rb +10 -20
- data/lib/purecloud/models/flow_terminate_request.rb +3 -16
- data/lib/purecloud/models/form.rb +148 -0
- data/lib/purecloud/models/group.rb +11 -1
- data/lib/purecloud/models/health_check_info.rb +268 -0
- data/lib/purecloud/models/{body_2.rb → inline_response_200.rb} +1 -1
- data/lib/purecloud/models/integration_type.rb +209 -0
- data/lib/purecloud/models/integration_type_entity_listing.rb +238 -0
- data/lib/purecloud/models/key_rotation_schedule.rb +1 -0
- data/lib/purecloud/models/language.rb +41 -1
- data/lib/purecloud/models/line.rb +1 -1
- data/lib/purecloud/models/line_base.rb +1 -1
- data/lib/purecloud/models/media_policies.rb +169 -0
- data/lib/purecloud/models/media_policy.rb +171 -0
- data/lib/purecloud/models/note.rb +200 -0
- data/lib/purecloud/models/{user_station_resource.rb → note_listing.rb} +68 -58
- data/lib/purecloud/models/o_auth_client.rb +1 -1
- data/lib/purecloud/models/page.rb +2 -2
- data/lib/purecloud/models/{byte_buffer.rb → payment_method.rb} +48 -61
- data/lib/purecloud/models/payment_method_listing.rb +238 -0
- data/lib/purecloud/models/payment_token_provider.rb +180 -0
- data/lib/purecloud/models/phone.rb +1 -1
- data/lib/purecloud/models/phone_base.rb +1 -1
- data/lib/purecloud/models/phone_number.rb +198 -0
- data/lib/purecloud/models/phones_reboot.rb +14 -4
- data/lib/purecloud/models/policy.rb +14 -1
- data/lib/purecloud/models/prediction_results.rb +167 -0
- data/lib/purecloud/models/query_request.rb +16 -4
- data/lib/purecloud/models/queue_member_entity_listing.rb +1 -1
- data/lib/purecloud/models/quote.rb +13 -1
- data/lib/purecloud/models/recording_settings.rb +146 -0
- data/lib/purecloud/models/relationship.rb +201 -0
- data/lib/purecloud/models/relationship_listing.rb +238 -0
- data/lib/purecloud/models/report_schedule.rb +3 -2
- data/lib/purecloud/models/service_type.rb +12 -1
- data/lib/purecloud/models/social_expression.rb +25 -4
- data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +1 -1
- data/lib/purecloud/models/template.rb +1 -1
- data/lib/purecloud/models/text_table_transform_entity_listing.rb +1 -1
- data/lib/purecloud/models/ticker.rb +158 -0
- data/lib/purecloud/models/time_slot.rb +1 -0
- data/lib/purecloud/models/trunk_base.rb +1 -1
- data/lib/purecloud/models/vendor_connection_request.rb +166 -0
- data/lib/purecloud/models/video.rb +15 -4
- data/lib/purecloud/models/work_item_definition.rb +8 -10
- data/lib/purecloud/version.rb +1 -1
- data/ossindex.json +17 -0
- data/purecloud.gemspec +4 -3
- data/rakefile +3 -15
- data/spec/test.rb +6 -3
- data/swagger.json +1 -1
- data/swagger_template/api_client.mustache +304 -0
- data/swagger_template/base_object.mustache +90 -0
- data/{PureCloud.gemspec → swagger_template/gemspec.mustache} +12 -11
- data/version.json +1 -1
- metadata +76 -25
- data/lib/purecloud/api/analytics_api.rb +0 -1554
- data/lib/purecloud/api/orphaned_recordings_api.rb +0 -205
- data/newVersion.md +0 -1
@@ -1,1554 +0,0 @@
|
|
1
|
-
require "uri"
|
2
|
-
|
3
|
-
module PureCloud
|
4
|
-
class AnalyticsApi
|
5
|
-
attr_accessor :api_client
|
6
|
-
|
7
|
-
def initialize(api_client = ApiClient.default)
|
8
|
-
@api_client = api_client
|
9
|
-
end
|
10
|
-
|
11
|
-
# Get a list of alerts.
|
12
|
-
#
|
13
|
-
# @param [Hash] opts the optional parameters
|
14
|
-
# @option opts [Integer] :page_number Page number
|
15
|
-
# @option opts [Integer] :page_size Page size
|
16
|
-
# @option opts [String] :sort_by title, startTime, endTime, description or unread
|
17
|
-
# @option opts [String] :sort_order ascending or descending
|
18
|
-
# @return [AlertEntityListing]
|
19
|
-
def get_alerting_alerts(opts = {})
|
20
|
-
data, status_code, headers = get_alerting_alerts_with_http_info(opts)
|
21
|
-
return data
|
22
|
-
end
|
23
|
-
|
24
|
-
# Get a list of alerts.
|
25
|
-
#
|
26
|
-
# @param [Hash] opts the optional parameters
|
27
|
-
# @option opts [Integer] :page_number Page number
|
28
|
-
# @option opts [Integer] :page_size Page size
|
29
|
-
# @option opts [String] :sort_by title, startTime, endTime, description or unread
|
30
|
-
# @option opts [String] :sort_order ascending or descending
|
31
|
-
# @return [Array<(AlertEntityListing, Fixnum, Hash)>] AlertEntityListing data, response status code and response headers
|
32
|
-
def get_alerting_alerts_with_http_info(opts = {})
|
33
|
-
if @api_client.config.debugging
|
34
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_alerts ..."
|
35
|
-
end
|
36
|
-
|
37
|
-
# resource path
|
38
|
-
path = "/api/v1/analytics/alerting/alerts".sub('{format}','json')
|
39
|
-
|
40
|
-
# query parameters
|
41
|
-
query_params = {}
|
42
|
-
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
43
|
-
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
44
|
-
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
45
|
-
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
46
|
-
|
47
|
-
# header parameters
|
48
|
-
header_params = {}
|
49
|
-
|
50
|
-
# HTTP header 'Accept' (if needed)
|
51
|
-
_header_accept = ['application/json']
|
52
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
53
|
-
|
54
|
-
# HTTP header 'Content-Type'
|
55
|
-
_header_content_type = ['application/json']
|
56
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
57
|
-
|
58
|
-
# form parameters
|
59
|
-
form_params = {}
|
60
|
-
|
61
|
-
# http body (model)
|
62
|
-
post_body = nil
|
63
|
-
|
64
|
-
|
65
|
-
auth_names = ['PureCloud Auth']
|
66
|
-
data, status_code, headers = @api_client.call_api(:GET, path,
|
67
|
-
:header_params => header_params,
|
68
|
-
:query_params => query_params,
|
69
|
-
:form_params => form_params,
|
70
|
-
:body => post_body,
|
71
|
-
:auth_names => auth_names,
|
72
|
-
:return_type => 'AlertEntityListing')
|
73
|
-
if @api_client.config.debugging
|
74
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_alerts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
75
|
-
end
|
76
|
-
return data, status_code, headers
|
77
|
-
end
|
78
|
-
|
79
|
-
# A count of unread alerts.
|
80
|
-
#
|
81
|
-
# @param [Hash] opts the optional parameters
|
82
|
-
# @return [UnreadMetric]
|
83
|
-
def get_alerting_alerts_unread(opts = {})
|
84
|
-
data, status_code, headers = get_alerting_alerts_unread_with_http_info(opts)
|
85
|
-
return data
|
86
|
-
end
|
87
|
-
|
88
|
-
# A count of unread alerts.
|
89
|
-
#
|
90
|
-
# @param [Hash] opts the optional parameters
|
91
|
-
# @return [Array<(UnreadMetric, Fixnum, Hash)>] UnreadMetric data, response status code and response headers
|
92
|
-
def get_alerting_alerts_unread_with_http_info(opts = {})
|
93
|
-
if @api_client.config.debugging
|
94
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_alerts_unread ..."
|
95
|
-
end
|
96
|
-
|
97
|
-
# resource path
|
98
|
-
path = "/api/v1/analytics/alerting/alerts/unread".sub('{format}','json')
|
99
|
-
|
100
|
-
# query parameters
|
101
|
-
query_params = {}
|
102
|
-
|
103
|
-
# header parameters
|
104
|
-
header_params = {}
|
105
|
-
|
106
|
-
# HTTP header 'Accept' (if needed)
|
107
|
-
_header_accept = ['application/json']
|
108
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
109
|
-
|
110
|
-
# HTTP header 'Content-Type'
|
111
|
-
_header_content_type = ['application/json']
|
112
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
113
|
-
|
114
|
-
# form parameters
|
115
|
-
form_params = {}
|
116
|
-
|
117
|
-
# http body (model)
|
118
|
-
post_body = nil
|
119
|
-
|
120
|
-
|
121
|
-
auth_names = ['PureCloud Auth']
|
122
|
-
data, status_code, headers = @api_client.call_api(:GET, path,
|
123
|
-
:header_params => header_params,
|
124
|
-
:query_params => query_params,
|
125
|
-
:form_params => form_params,
|
126
|
-
:body => post_body,
|
127
|
-
:auth_names => auth_names,
|
128
|
-
:return_type => 'UnreadMetric')
|
129
|
-
if @api_client.config.debugging
|
130
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_alerts_unread\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
131
|
-
end
|
132
|
-
return data, status_code, headers
|
133
|
-
end
|
134
|
-
|
135
|
-
# Get an alert.
|
136
|
-
#
|
137
|
-
# @param alert_id Alert ID
|
138
|
-
# @param [Hash] opts the optional parameters
|
139
|
-
# @return [Alert]
|
140
|
-
def get_alerting_alert(alert_id, opts = {})
|
141
|
-
data, status_code, headers = get_alerting_alert_with_http_info(alert_id, opts)
|
142
|
-
return data
|
143
|
-
end
|
144
|
-
|
145
|
-
# Get an alert.
|
146
|
-
#
|
147
|
-
# @param alert_id Alert ID
|
148
|
-
# @param [Hash] opts the optional parameters
|
149
|
-
# @return [Array<(Alert, Fixnum, Hash)>] Alert data, response status code and response headers
|
150
|
-
def get_alerting_alert_with_http_info(alert_id, opts = {})
|
151
|
-
if @api_client.config.debugging
|
152
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_alert ..."
|
153
|
-
end
|
154
|
-
|
155
|
-
# verify the required parameter 'alert_id' is set
|
156
|
-
fail "Missing the required parameter 'alert_id' when calling get_alerting_alert" if alert_id.nil?
|
157
|
-
|
158
|
-
# resource path
|
159
|
-
path = "/api/v1/analytics/alerting/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)
|
160
|
-
|
161
|
-
# query parameters
|
162
|
-
query_params = {}
|
163
|
-
|
164
|
-
# header parameters
|
165
|
-
header_params = {}
|
166
|
-
|
167
|
-
# HTTP header 'Accept' (if needed)
|
168
|
-
_header_accept = ['application/json']
|
169
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
170
|
-
|
171
|
-
# HTTP header 'Content-Type'
|
172
|
-
_header_content_type = ['application/json']
|
173
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
174
|
-
|
175
|
-
# form parameters
|
176
|
-
form_params = {}
|
177
|
-
|
178
|
-
# http body (model)
|
179
|
-
post_body = nil
|
180
|
-
|
181
|
-
|
182
|
-
auth_names = ['PureCloud Auth']
|
183
|
-
data, status_code, headers = @api_client.call_api(:GET, path,
|
184
|
-
:header_params => header_params,
|
185
|
-
:query_params => query_params,
|
186
|
-
:form_params => form_params,
|
187
|
-
:body => post_body,
|
188
|
-
:auth_names => auth_names,
|
189
|
-
:return_type => 'Alert')
|
190
|
-
if @api_client.config.debugging
|
191
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
192
|
-
end
|
193
|
-
return data, status_code, headers
|
194
|
-
end
|
195
|
-
|
196
|
-
# Update an alerts unread status.
|
197
|
-
#
|
198
|
-
# @param alert_id Alert ID
|
199
|
-
# @param [Hash] opts the optional parameters
|
200
|
-
# @option opts [Alert] :body Alert
|
201
|
-
# @return [Alert]
|
202
|
-
def update_alerting_alert(alert_id, opts = {})
|
203
|
-
data, status_code, headers = update_alerting_alert_with_http_info(alert_id, opts)
|
204
|
-
return data
|
205
|
-
end
|
206
|
-
|
207
|
-
# Update an alerts unread status.
|
208
|
-
#
|
209
|
-
# @param alert_id Alert ID
|
210
|
-
# @param [Hash] opts the optional parameters
|
211
|
-
# @option opts [Alert] :body Alert
|
212
|
-
# @return [Array<(Alert, Fixnum, Hash)>] Alert data, response status code and response headers
|
213
|
-
def update_alerting_alert_with_http_info(alert_id, opts = {})
|
214
|
-
if @api_client.config.debugging
|
215
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#update_alerting_alert ..."
|
216
|
-
end
|
217
|
-
|
218
|
-
# verify the required parameter 'alert_id' is set
|
219
|
-
fail "Missing the required parameter 'alert_id' when calling update_alerting_alert" if alert_id.nil?
|
220
|
-
|
221
|
-
# resource path
|
222
|
-
path = "/api/v1/analytics/alerting/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)
|
223
|
-
|
224
|
-
# query parameters
|
225
|
-
query_params = {}
|
226
|
-
|
227
|
-
# header parameters
|
228
|
-
header_params = {}
|
229
|
-
|
230
|
-
# HTTP header 'Accept' (if needed)
|
231
|
-
_header_accept = ['application/json']
|
232
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
233
|
-
|
234
|
-
# HTTP header 'Content-Type'
|
235
|
-
_header_content_type = ['application/json']
|
236
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
237
|
-
|
238
|
-
# form parameters
|
239
|
-
form_params = {}
|
240
|
-
|
241
|
-
# http body (model)
|
242
|
-
post_body = @api_client.object_to_http_body(opts[:'body'])
|
243
|
-
|
244
|
-
|
245
|
-
auth_names = ['PureCloud Auth']
|
246
|
-
data, status_code, headers = @api_client.call_api(:PUT, path,
|
247
|
-
:header_params => header_params,
|
248
|
-
:query_params => query_params,
|
249
|
-
:form_params => form_params,
|
250
|
-
:body => post_body,
|
251
|
-
:auth_names => auth_names,
|
252
|
-
:return_type => 'Alert')
|
253
|
-
if @api_client.config.debugging
|
254
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#update_alerting_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
255
|
-
end
|
256
|
-
return data, status_code, headers
|
257
|
-
end
|
258
|
-
|
259
|
-
# Delete an alert.
|
260
|
-
#
|
261
|
-
# @param alert_id Alert ID
|
262
|
-
# @param [Hash] opts the optional parameters
|
263
|
-
# @return [nil]
|
264
|
-
def delete_alerting_alert(alert_id, opts = {})
|
265
|
-
delete_alerting_alert_with_http_info(alert_id, opts)
|
266
|
-
return nil
|
267
|
-
end
|
268
|
-
|
269
|
-
# Delete an alert.
|
270
|
-
#
|
271
|
-
# @param alert_id Alert ID
|
272
|
-
# @param [Hash] opts the optional parameters
|
273
|
-
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
274
|
-
def delete_alerting_alert_with_http_info(alert_id, opts = {})
|
275
|
-
if @api_client.config.debugging
|
276
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#delete_alerting_alert ..."
|
277
|
-
end
|
278
|
-
|
279
|
-
# verify the required parameter 'alert_id' is set
|
280
|
-
fail "Missing the required parameter 'alert_id' when calling delete_alerting_alert" if alert_id.nil?
|
281
|
-
|
282
|
-
# resource path
|
283
|
-
path = "/api/v1/analytics/alerting/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s)
|
284
|
-
|
285
|
-
# query parameters
|
286
|
-
query_params = {}
|
287
|
-
|
288
|
-
# header parameters
|
289
|
-
header_params = {}
|
290
|
-
|
291
|
-
# HTTP header 'Accept' (if needed)
|
292
|
-
_header_accept = ['application/json']
|
293
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
294
|
-
|
295
|
-
# HTTP header 'Content-Type'
|
296
|
-
_header_content_type = ['application/json']
|
297
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
298
|
-
|
299
|
-
# form parameters
|
300
|
-
form_params = {}
|
301
|
-
|
302
|
-
# http body (model)
|
303
|
-
post_body = nil
|
304
|
-
|
305
|
-
|
306
|
-
auth_names = ['PureCloud Auth']
|
307
|
-
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
308
|
-
:header_params => header_params,
|
309
|
-
:query_params => query_params,
|
310
|
-
:form_params => form_params,
|
311
|
-
:body => post_body,
|
312
|
-
:auth_names => auth_names)
|
313
|
-
if @api_client.config.debugging
|
314
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#delete_alerting_alert\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
315
|
-
end
|
316
|
-
return data, status_code, headers
|
317
|
-
end
|
318
|
-
|
319
|
-
# Get a list of rules.
|
320
|
-
#
|
321
|
-
# @param [Hash] opts the optional parameters
|
322
|
-
# @option opts [Integer] :page_number Page number
|
323
|
-
# @option opts [Integer] :page_size Page size
|
324
|
-
# @option opts [String] :sort_by title, description, inAlarm or enabled
|
325
|
-
# @option opts [String] :sort_order ascending or descending
|
326
|
-
# @return [RuleEntityListing]
|
327
|
-
def get_alerting_rules(opts = {})
|
328
|
-
data, status_code, headers = get_alerting_rules_with_http_info(opts)
|
329
|
-
return data
|
330
|
-
end
|
331
|
-
|
332
|
-
# Get a list of rules.
|
333
|
-
#
|
334
|
-
# @param [Hash] opts the optional parameters
|
335
|
-
# @option opts [Integer] :page_number Page number
|
336
|
-
# @option opts [Integer] :page_size Page size
|
337
|
-
# @option opts [String] :sort_by title, description, inAlarm or enabled
|
338
|
-
# @option opts [String] :sort_order ascending or descending
|
339
|
-
# @return [Array<(RuleEntityListing, Fixnum, Hash)>] RuleEntityListing data, response status code and response headers
|
340
|
-
def get_alerting_rules_with_http_info(opts = {})
|
341
|
-
if @api_client.config.debugging
|
342
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_rules ..."
|
343
|
-
end
|
344
|
-
|
345
|
-
# resource path
|
346
|
-
path = "/api/v1/analytics/alerting/rules".sub('{format}','json')
|
347
|
-
|
348
|
-
# query parameters
|
349
|
-
query_params = {}
|
350
|
-
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
351
|
-
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
352
|
-
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
353
|
-
query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
|
354
|
-
|
355
|
-
# header parameters
|
356
|
-
header_params = {}
|
357
|
-
|
358
|
-
# HTTP header 'Accept' (if needed)
|
359
|
-
_header_accept = ['application/json']
|
360
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
361
|
-
|
362
|
-
# HTTP header 'Content-Type'
|
363
|
-
_header_content_type = ['application/json']
|
364
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
365
|
-
|
366
|
-
# form parameters
|
367
|
-
form_params = {}
|
368
|
-
|
369
|
-
# http body (model)
|
370
|
-
post_body = nil
|
371
|
-
|
372
|
-
|
373
|
-
auth_names = ['PureCloud Auth']
|
374
|
-
data, status_code, headers = @api_client.call_api(:GET, path,
|
375
|
-
:header_params => header_params,
|
376
|
-
:query_params => query_params,
|
377
|
-
:form_params => form_params,
|
378
|
-
:body => post_body,
|
379
|
-
:auth_names => auth_names,
|
380
|
-
:return_type => 'RuleEntityListing')
|
381
|
-
if @api_client.config.debugging
|
382
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
383
|
-
end
|
384
|
-
return data, status_code, headers
|
385
|
-
end
|
386
|
-
|
387
|
-
# Create an alerting rule.
|
388
|
-
#
|
389
|
-
# @param [Hash] opts the optional parameters
|
390
|
-
# @option opts [Rule] :body Rule
|
391
|
-
# @return [Rule]
|
392
|
-
def create_alerting_rules(opts = {})
|
393
|
-
data, status_code, headers = create_alerting_rules_with_http_info(opts)
|
394
|
-
return data
|
395
|
-
end
|
396
|
-
|
397
|
-
# Create an alerting rule.
|
398
|
-
#
|
399
|
-
# @param [Hash] opts the optional parameters
|
400
|
-
# @option opts [Rule] :body Rule
|
401
|
-
# @return [Array<(Rule, Fixnum, Hash)>] Rule data, response status code and response headers
|
402
|
-
def create_alerting_rules_with_http_info(opts = {})
|
403
|
-
if @api_client.config.debugging
|
404
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#create_alerting_rules ..."
|
405
|
-
end
|
406
|
-
|
407
|
-
# resource path
|
408
|
-
path = "/api/v1/analytics/alerting/rules".sub('{format}','json')
|
409
|
-
|
410
|
-
# query parameters
|
411
|
-
query_params = {}
|
412
|
-
|
413
|
-
# header parameters
|
414
|
-
header_params = {}
|
415
|
-
|
416
|
-
# HTTP header 'Accept' (if needed)
|
417
|
-
_header_accept = ['application/json']
|
418
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
419
|
-
|
420
|
-
# HTTP header 'Content-Type'
|
421
|
-
_header_content_type = ['application/json']
|
422
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
423
|
-
|
424
|
-
# form parameters
|
425
|
-
form_params = {}
|
426
|
-
|
427
|
-
# http body (model)
|
428
|
-
post_body = @api_client.object_to_http_body(opts[:'body'])
|
429
|
-
|
430
|
-
|
431
|
-
auth_names = ['PureCloud Auth']
|
432
|
-
data, status_code, headers = @api_client.call_api(:POST, path,
|
433
|
-
:header_params => header_params,
|
434
|
-
:query_params => query_params,
|
435
|
-
:form_params => form_params,
|
436
|
-
:body => post_body,
|
437
|
-
:auth_names => auth_names,
|
438
|
-
:return_type => 'Rule')
|
439
|
-
if @api_client.config.debugging
|
440
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#create_alerting_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
441
|
-
end
|
442
|
-
return data, status_code, headers
|
443
|
-
end
|
444
|
-
|
445
|
-
# Get an alerting rule.
|
446
|
-
#
|
447
|
-
# @param rule_id Rule ID
|
448
|
-
# @param [Hash] opts the optional parameters
|
449
|
-
# @return [Rule]
|
450
|
-
def get_alerting_rule(rule_id, opts = {})
|
451
|
-
data, status_code, headers = get_alerting_rule_with_http_info(rule_id, opts)
|
452
|
-
return data
|
453
|
-
end
|
454
|
-
|
455
|
-
# Get an alerting rule.
|
456
|
-
#
|
457
|
-
# @param rule_id Rule ID
|
458
|
-
# @param [Hash] opts the optional parameters
|
459
|
-
# @return [Array<(Rule, Fixnum, Hash)>] Rule data, response status code and response headers
|
460
|
-
def get_alerting_rule_with_http_info(rule_id, opts = {})
|
461
|
-
if @api_client.config.debugging
|
462
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_rule ..."
|
463
|
-
end
|
464
|
-
|
465
|
-
# verify the required parameter 'rule_id' is set
|
466
|
-
fail "Missing the required parameter 'rule_id' when calling get_alerting_rule" if rule_id.nil?
|
467
|
-
|
468
|
-
# resource path
|
469
|
-
path = "/api/v1/analytics/alerting/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)
|
470
|
-
|
471
|
-
# query parameters
|
472
|
-
query_params = {}
|
473
|
-
|
474
|
-
# header parameters
|
475
|
-
header_params = {}
|
476
|
-
|
477
|
-
# HTTP header 'Accept' (if needed)
|
478
|
-
_header_accept = ['application/json']
|
479
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
480
|
-
|
481
|
-
# HTTP header 'Content-Type'
|
482
|
-
_header_content_type = ['application/json']
|
483
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
484
|
-
|
485
|
-
# form parameters
|
486
|
-
form_params = {}
|
487
|
-
|
488
|
-
# http body (model)
|
489
|
-
post_body = nil
|
490
|
-
|
491
|
-
|
492
|
-
auth_names = ['PureCloud Auth']
|
493
|
-
data, status_code, headers = @api_client.call_api(:GET, path,
|
494
|
-
:header_params => header_params,
|
495
|
-
:query_params => query_params,
|
496
|
-
:form_params => form_params,
|
497
|
-
:body => post_body,
|
498
|
-
:auth_names => auth_names,
|
499
|
-
:return_type => 'Rule')
|
500
|
-
if @api_client.config.debugging
|
501
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
502
|
-
end
|
503
|
-
return data, status_code, headers
|
504
|
-
end
|
505
|
-
|
506
|
-
# Update an alerting rule.
|
507
|
-
#
|
508
|
-
# @param rule_id Rule ID
|
509
|
-
# @param [Hash] opts the optional parameters
|
510
|
-
# @option opts [Rule] :body Rule
|
511
|
-
# @return [Rule]
|
512
|
-
def update_alerting_rule(rule_id, opts = {})
|
513
|
-
data, status_code, headers = update_alerting_rule_with_http_info(rule_id, opts)
|
514
|
-
return data
|
515
|
-
end
|
516
|
-
|
517
|
-
# Update an alerting rule.
|
518
|
-
#
|
519
|
-
# @param rule_id Rule ID
|
520
|
-
# @param [Hash] opts the optional parameters
|
521
|
-
# @option opts [Rule] :body Rule
|
522
|
-
# @return [Array<(Rule, Fixnum, Hash)>] Rule data, response status code and response headers
|
523
|
-
def update_alerting_rule_with_http_info(rule_id, opts = {})
|
524
|
-
if @api_client.config.debugging
|
525
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#update_alerting_rule ..."
|
526
|
-
end
|
527
|
-
|
528
|
-
# verify the required parameter 'rule_id' is set
|
529
|
-
fail "Missing the required parameter 'rule_id' when calling update_alerting_rule" if rule_id.nil?
|
530
|
-
|
531
|
-
# resource path
|
532
|
-
path = "/api/v1/analytics/alerting/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)
|
533
|
-
|
534
|
-
# query parameters
|
535
|
-
query_params = {}
|
536
|
-
|
537
|
-
# header parameters
|
538
|
-
header_params = {}
|
539
|
-
|
540
|
-
# HTTP header 'Accept' (if needed)
|
541
|
-
_header_accept = ['application/json']
|
542
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
543
|
-
|
544
|
-
# HTTP header 'Content-Type'
|
545
|
-
_header_content_type = ['application/json']
|
546
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
547
|
-
|
548
|
-
# form parameters
|
549
|
-
form_params = {}
|
550
|
-
|
551
|
-
# http body (model)
|
552
|
-
post_body = @api_client.object_to_http_body(opts[:'body'])
|
553
|
-
|
554
|
-
|
555
|
-
auth_names = ['PureCloud Auth']
|
556
|
-
data, status_code, headers = @api_client.call_api(:PUT, path,
|
557
|
-
:header_params => header_params,
|
558
|
-
:query_params => query_params,
|
559
|
-
:form_params => form_params,
|
560
|
-
:body => post_body,
|
561
|
-
:auth_names => auth_names,
|
562
|
-
:return_type => 'Rule')
|
563
|
-
if @api_client.config.debugging
|
564
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#update_alerting_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
565
|
-
end
|
566
|
-
return data, status_code, headers
|
567
|
-
end
|
568
|
-
|
569
|
-
# Delete an alerting rule.
|
570
|
-
#
|
571
|
-
# @param rule_id Rule ID
|
572
|
-
# @param [Hash] opts the optional parameters
|
573
|
-
# @return [nil]
|
574
|
-
def delete_alerting_rule(rule_id, opts = {})
|
575
|
-
delete_alerting_rule_with_http_info(rule_id, opts)
|
576
|
-
return nil
|
577
|
-
end
|
578
|
-
|
579
|
-
# Delete an alerting rule.
|
580
|
-
#
|
581
|
-
# @param rule_id Rule ID
|
582
|
-
# @param [Hash] opts the optional parameters
|
583
|
-
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
584
|
-
def delete_alerting_rule_with_http_info(rule_id, opts = {})
|
585
|
-
if @api_client.config.debugging
|
586
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#delete_alerting_rule ..."
|
587
|
-
end
|
588
|
-
|
589
|
-
# verify the required parameter 'rule_id' is set
|
590
|
-
fail "Missing the required parameter 'rule_id' when calling delete_alerting_rule" if rule_id.nil?
|
591
|
-
|
592
|
-
# resource path
|
593
|
-
path = "/api/v1/analytics/alerting/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s)
|
594
|
-
|
595
|
-
# query parameters
|
596
|
-
query_params = {}
|
597
|
-
|
598
|
-
# header parameters
|
599
|
-
header_params = {}
|
600
|
-
|
601
|
-
# HTTP header 'Accept' (if needed)
|
602
|
-
_header_accept = ['application/json']
|
603
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
604
|
-
|
605
|
-
# HTTP header 'Content-Type'
|
606
|
-
_header_content_type = ['application/json']
|
607
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
608
|
-
|
609
|
-
# form parameters
|
610
|
-
form_params = {}
|
611
|
-
|
612
|
-
# http body (model)
|
613
|
-
post_body = nil
|
614
|
-
|
615
|
-
|
616
|
-
auth_names = ['PureCloud Auth']
|
617
|
-
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
618
|
-
:header_params => header_params,
|
619
|
-
:query_params => query_params,
|
620
|
-
:form_params => form_params,
|
621
|
-
:body => post_body,
|
622
|
-
:auth_names => auth_names)
|
623
|
-
if @api_client.config.debugging
|
624
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#delete_alerting_rule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
625
|
-
end
|
626
|
-
return data, status_code, headers
|
627
|
-
end
|
628
|
-
|
629
|
-
# Executes a metrics query against the analytics service
|
630
|
-
#
|
631
|
-
# @param [Hash] opts the optional parameters
|
632
|
-
# @option opts [Body] :body queryObject
|
633
|
-
# @return [nil]
|
634
|
-
def create_metrics_query(opts = {})
|
635
|
-
create_metrics_query_with_http_info(opts)
|
636
|
-
return nil
|
637
|
-
end
|
638
|
-
|
639
|
-
# Executes a metrics query against the analytics service
|
640
|
-
#
|
641
|
-
# @param [Hash] opts the optional parameters
|
642
|
-
# @option opts [Body] :body queryObject
|
643
|
-
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
644
|
-
def create_metrics_query_with_http_info(opts = {})
|
645
|
-
if @api_client.config.debugging
|
646
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#create_metrics_query ..."
|
647
|
-
end
|
648
|
-
|
649
|
-
# resource path
|
650
|
-
path = "/api/v1/analytics/metrics/query".sub('{format}','json')
|
651
|
-
|
652
|
-
# query parameters
|
653
|
-
query_params = {}
|
654
|
-
|
655
|
-
# header parameters
|
656
|
-
header_params = {}
|
657
|
-
|
658
|
-
# HTTP header 'Accept' (if needed)
|
659
|
-
_header_accept = ['application/json']
|
660
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
661
|
-
|
662
|
-
# HTTP header 'Content-Type'
|
663
|
-
_header_content_type = ['application/json']
|
664
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
665
|
-
|
666
|
-
# form parameters
|
667
|
-
form_params = {}
|
668
|
-
|
669
|
-
# http body (model)
|
670
|
-
post_body = @api_client.object_to_http_body(opts[:'body'])
|
671
|
-
|
672
|
-
|
673
|
-
auth_names = ['PureCloud Auth']
|
674
|
-
data, status_code, headers = @api_client.call_api(:POST, path,
|
675
|
-
:header_params => header_params,
|
676
|
-
:query_params => query_params,
|
677
|
-
:form_params => form_params,
|
678
|
-
:body => post_body,
|
679
|
-
:auth_names => auth_names)
|
680
|
-
if @api_client.config.debugging
|
681
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#create_metrics_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
682
|
-
end
|
683
|
-
return data, status_code, headers
|
684
|
-
end
|
685
|
-
|
686
|
-
# Get list of reporting metadata.
|
687
|
-
#
|
688
|
-
# @param [Hash] opts the optional parameters
|
689
|
-
# @option opts [Integer] :page_number Page number
|
690
|
-
# @option opts [Integer] :page_size Page size
|
691
|
-
# @option opts [String] :accept_language Accepted language
|
692
|
-
# @option opts [String] :locale Locale
|
693
|
-
# @return [ReportMetaDataEntityListing]
|
694
|
-
def get_reporting_metadata(opts = {})
|
695
|
-
data, status_code, headers = get_reporting_metadata_with_http_info(opts)
|
696
|
-
return data
|
697
|
-
end
|
698
|
-
|
699
|
-
# Get list of reporting metadata.
|
700
|
-
#
|
701
|
-
# @param [Hash] opts the optional parameters
|
702
|
-
# @option opts [Integer] :page_number Page number
|
703
|
-
# @option opts [Integer] :page_size Page size
|
704
|
-
# @option opts [String] :accept_language Accepted language
|
705
|
-
# @option opts [String] :locale Locale
|
706
|
-
# @return [Array<(ReportMetaDataEntityListing, Fixnum, Hash)>] ReportMetaDataEntityListing data, response status code and response headers
|
707
|
-
def get_reporting_metadata_with_http_info(opts = {})
|
708
|
-
if @api_client.config.debugging
|
709
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_metadata ..."
|
710
|
-
end
|
711
|
-
|
712
|
-
# resource path
|
713
|
-
path = "/api/v1/analytics/reporting/metadata".sub('{format}','json')
|
714
|
-
|
715
|
-
# query parameters
|
716
|
-
query_params = {}
|
717
|
-
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
718
|
-
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
719
|
-
query_params[:'locale'] = opts[:'locale'] if opts[:'locale']
|
720
|
-
|
721
|
-
# header parameters
|
722
|
-
header_params = {}
|
723
|
-
|
724
|
-
# HTTP header 'Accept' (if needed)
|
725
|
-
_header_accept = ['application/json']
|
726
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
727
|
-
|
728
|
-
# HTTP header 'Content-Type'
|
729
|
-
_header_content_type = ['application/json']
|
730
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
731
|
-
header_params[:'Accept-Language'] = opts[:'accept_language'] if opts[:'accept_language']
|
732
|
-
|
733
|
-
# form parameters
|
734
|
-
form_params = {}
|
735
|
-
|
736
|
-
# http body (model)
|
737
|
-
post_body = nil
|
738
|
-
|
739
|
-
|
740
|
-
auth_names = ['PureCloud Auth']
|
741
|
-
data, status_code, headers = @api_client.call_api(:GET, path,
|
742
|
-
:header_params => header_params,
|
743
|
-
:query_params => query_params,
|
744
|
-
:form_params => form_params,
|
745
|
-
:body => post_body,
|
746
|
-
:auth_names => auth_names,
|
747
|
-
:return_type => 'ReportMetaDataEntityListing')
|
748
|
-
if @api_client.config.debugging
|
749
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
750
|
-
end
|
751
|
-
return data, status_code, headers
|
752
|
-
end
|
753
|
-
|
754
|
-
# Get a list of report formats
|
755
|
-
# Get a list of report formats.
|
756
|
-
# @param [Hash] opts the optional parameters
|
757
|
-
# @return [Array<String>]
|
758
|
-
def get_reporting_reportformats(opts = {})
|
759
|
-
data, status_code, headers = get_reporting_reportformats_with_http_info(opts)
|
760
|
-
return data
|
761
|
-
end
|
762
|
-
|
763
|
-
# Get a list of report formats
|
764
|
-
# Get a list of report formats.
|
765
|
-
# @param [Hash] opts the optional parameters
|
766
|
-
# @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
|
767
|
-
def get_reporting_reportformats_with_http_info(opts = {})
|
768
|
-
if @api_client.config.debugging
|
769
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_reportformats ..."
|
770
|
-
end
|
771
|
-
|
772
|
-
# resource path
|
773
|
-
path = "/api/v1/analytics/reporting/reportformats".sub('{format}','json')
|
774
|
-
|
775
|
-
# query parameters
|
776
|
-
query_params = {}
|
777
|
-
|
778
|
-
# header parameters
|
779
|
-
header_params = {}
|
780
|
-
|
781
|
-
# HTTP header 'Accept' (if needed)
|
782
|
-
_header_accept = ['application/json']
|
783
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
784
|
-
|
785
|
-
# HTTP header 'Content-Type'
|
786
|
-
_header_content_type = ['application/json']
|
787
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
788
|
-
|
789
|
-
# form parameters
|
790
|
-
form_params = {}
|
791
|
-
|
792
|
-
# http body (model)
|
793
|
-
post_body = nil
|
794
|
-
|
795
|
-
|
796
|
-
auth_names = ['PureCloud Auth']
|
797
|
-
data, status_code, headers = @api_client.call_api(:GET, path,
|
798
|
-
:header_params => header_params,
|
799
|
-
:query_params => query_params,
|
800
|
-
:form_params => form_params,
|
801
|
-
:body => post_body,
|
802
|
-
:auth_names => auth_names,
|
803
|
-
:return_type => 'Array<String>')
|
804
|
-
if @api_client.config.debugging
|
805
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_reportformats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
806
|
-
end
|
807
|
-
return data, status_code, headers
|
808
|
-
end
|
809
|
-
|
810
|
-
# Get a list of scheduled report jobs
|
811
|
-
# Get a list of scheduled report jobs.
|
812
|
-
# @param [Hash] opts the optional parameters
|
813
|
-
# @option opts [Integer] :page_number Page number
|
814
|
-
# @option opts [Integer] :page_size Page size
|
815
|
-
# @return [ReportScheduleEntityListing]
|
816
|
-
def get_reporting_schedules(opts = {})
|
817
|
-
data, status_code, headers = get_reporting_schedules_with_http_info(opts)
|
818
|
-
return data
|
819
|
-
end
|
820
|
-
|
821
|
-
# Get a list of scheduled report jobs
|
822
|
-
# Get a list of scheduled report jobs.
|
823
|
-
# @param [Hash] opts the optional parameters
|
824
|
-
# @option opts [Integer] :page_number Page number
|
825
|
-
# @option opts [Integer] :page_size Page size
|
826
|
-
# @return [Array<(ReportScheduleEntityListing, Fixnum, Hash)>] ReportScheduleEntityListing data, response status code and response headers
|
827
|
-
def get_reporting_schedules_with_http_info(opts = {})
|
828
|
-
if @api_client.config.debugging
|
829
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedules ..."
|
830
|
-
end
|
831
|
-
|
832
|
-
# resource path
|
833
|
-
path = "/api/v1/analytics/reporting/schedules".sub('{format}','json')
|
834
|
-
|
835
|
-
# query parameters
|
836
|
-
query_params = {}
|
837
|
-
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
838
|
-
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
839
|
-
|
840
|
-
# header parameters
|
841
|
-
header_params = {}
|
842
|
-
|
843
|
-
# HTTP header 'Accept' (if needed)
|
844
|
-
_header_accept = ['application/json']
|
845
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
846
|
-
|
847
|
-
# HTTP header 'Content-Type'
|
848
|
-
_header_content_type = ['application/json']
|
849
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
850
|
-
|
851
|
-
# form parameters
|
852
|
-
form_params = {}
|
853
|
-
|
854
|
-
# http body (model)
|
855
|
-
post_body = nil
|
856
|
-
|
857
|
-
|
858
|
-
auth_names = ['PureCloud Auth']
|
859
|
-
data, status_code, headers = @api_client.call_api(:GET, path,
|
860
|
-
:header_params => header_params,
|
861
|
-
:query_params => query_params,
|
862
|
-
:form_params => form_params,
|
863
|
-
:body => post_body,
|
864
|
-
:auth_names => auth_names,
|
865
|
-
:return_type => 'ReportScheduleEntityListing')
|
866
|
-
if @api_client.config.debugging
|
867
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
868
|
-
end
|
869
|
-
return data, status_code, headers
|
870
|
-
end
|
871
|
-
|
872
|
-
# Create a scheduled report job
|
873
|
-
# Create a scheduled report job.
|
874
|
-
# @param [Hash] opts the optional parameters
|
875
|
-
# @option opts [ReportSchedule] :body ReportSchedule
|
876
|
-
# @return [ReportSchedule]
|
877
|
-
def create_reporting_schedules(opts = {})
|
878
|
-
data, status_code, headers = create_reporting_schedules_with_http_info(opts)
|
879
|
-
return data
|
880
|
-
end
|
881
|
-
|
882
|
-
# Create a scheduled report job
|
883
|
-
# Create a scheduled report job.
|
884
|
-
# @param [Hash] opts the optional parameters
|
885
|
-
# @option opts [ReportSchedule] :body ReportSchedule
|
886
|
-
# @return [Array<(ReportSchedule, Fixnum, Hash)>] ReportSchedule data, response status code and response headers
|
887
|
-
def create_reporting_schedules_with_http_info(opts = {})
|
888
|
-
if @api_client.config.debugging
|
889
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#create_reporting_schedules ..."
|
890
|
-
end
|
891
|
-
|
892
|
-
# resource path
|
893
|
-
path = "/api/v1/analytics/reporting/schedules".sub('{format}','json')
|
894
|
-
|
895
|
-
# query parameters
|
896
|
-
query_params = {}
|
897
|
-
|
898
|
-
# header parameters
|
899
|
-
header_params = {}
|
900
|
-
|
901
|
-
# HTTP header 'Accept' (if needed)
|
902
|
-
_header_accept = ['application/json']
|
903
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
904
|
-
|
905
|
-
# HTTP header 'Content-Type'
|
906
|
-
_header_content_type = ['application/json']
|
907
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
908
|
-
|
909
|
-
# form parameters
|
910
|
-
form_params = {}
|
911
|
-
|
912
|
-
# http body (model)
|
913
|
-
post_body = @api_client.object_to_http_body(opts[:'body'])
|
914
|
-
|
915
|
-
|
916
|
-
auth_names = ['PureCloud Auth']
|
917
|
-
data, status_code, headers = @api_client.call_api(:POST, path,
|
918
|
-
:header_params => header_params,
|
919
|
-
:query_params => query_params,
|
920
|
-
:form_params => form_params,
|
921
|
-
:body => post_body,
|
922
|
-
:auth_names => auth_names,
|
923
|
-
:return_type => 'ReportSchedule')
|
924
|
-
if @api_client.config.debugging
|
925
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#create_reporting_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
926
|
-
end
|
927
|
-
return data, status_code, headers
|
928
|
-
end
|
929
|
-
|
930
|
-
# Get a scheduled report job.
|
931
|
-
#
|
932
|
-
# @param schedule_id Schedule ID
|
933
|
-
# @param [Hash] opts the optional parameters
|
934
|
-
# @return [ReportSchedule]
|
935
|
-
def get_reporting_schedule(schedule_id, opts = {})
|
936
|
-
data, status_code, headers = get_reporting_schedule_with_http_info(schedule_id, opts)
|
937
|
-
return data
|
938
|
-
end
|
939
|
-
|
940
|
-
# Get a scheduled report job.
|
941
|
-
#
|
942
|
-
# @param schedule_id Schedule ID
|
943
|
-
# @param [Hash] opts the optional parameters
|
944
|
-
# @return [Array<(ReportSchedule, Fixnum, Hash)>] ReportSchedule data, response status code and response headers
|
945
|
-
def get_reporting_schedule_with_http_info(schedule_id, opts = {})
|
946
|
-
if @api_client.config.debugging
|
947
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedule ..."
|
948
|
-
end
|
949
|
-
|
950
|
-
# verify the required parameter 'schedule_id' is set
|
951
|
-
fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedule" if schedule_id.nil?
|
952
|
-
|
953
|
-
# resource path
|
954
|
-
path = "/api/v1/analytics/reporting/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
|
955
|
-
|
956
|
-
# query parameters
|
957
|
-
query_params = {}
|
958
|
-
|
959
|
-
# header parameters
|
960
|
-
header_params = {}
|
961
|
-
|
962
|
-
# HTTP header 'Accept' (if needed)
|
963
|
-
_header_accept = ['application/json']
|
964
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
965
|
-
|
966
|
-
# HTTP header 'Content-Type'
|
967
|
-
_header_content_type = ['application/json']
|
968
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
969
|
-
|
970
|
-
# form parameters
|
971
|
-
form_params = {}
|
972
|
-
|
973
|
-
# http body (model)
|
974
|
-
post_body = nil
|
975
|
-
|
976
|
-
|
977
|
-
auth_names = ['PureCloud Auth']
|
978
|
-
data, status_code, headers = @api_client.call_api(:GET, path,
|
979
|
-
:header_params => header_params,
|
980
|
-
:query_params => query_params,
|
981
|
-
:form_params => form_params,
|
982
|
-
:body => post_body,
|
983
|
-
:auth_names => auth_names,
|
984
|
-
:return_type => 'ReportSchedule')
|
985
|
-
if @api_client.config.debugging
|
986
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
987
|
-
end
|
988
|
-
return data, status_code, headers
|
989
|
-
end
|
990
|
-
|
991
|
-
# Update a scheduled report job.
|
992
|
-
#
|
993
|
-
# @param schedule_id Schedule ID
|
994
|
-
# @param [Hash] opts the optional parameters
|
995
|
-
# @option opts [ReportSchedule] :body ReportSchedule
|
996
|
-
# @return [ReportSchedule]
|
997
|
-
def update_reporting_schedule(schedule_id, opts = {})
|
998
|
-
data, status_code, headers = update_reporting_schedule_with_http_info(schedule_id, opts)
|
999
|
-
return data
|
1000
|
-
end
|
1001
|
-
|
1002
|
-
# Update a scheduled report job.
|
1003
|
-
#
|
1004
|
-
# @param schedule_id Schedule ID
|
1005
|
-
# @param [Hash] opts the optional parameters
|
1006
|
-
# @option opts [ReportSchedule] :body ReportSchedule
|
1007
|
-
# @return [Array<(ReportSchedule, Fixnum, Hash)>] ReportSchedule data, response status code and response headers
|
1008
|
-
def update_reporting_schedule_with_http_info(schedule_id, opts = {})
|
1009
|
-
if @api_client.config.debugging
|
1010
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#update_reporting_schedule ..."
|
1011
|
-
end
|
1012
|
-
|
1013
|
-
# verify the required parameter 'schedule_id' is set
|
1014
|
-
fail "Missing the required parameter 'schedule_id' when calling update_reporting_schedule" if schedule_id.nil?
|
1015
|
-
|
1016
|
-
# resource path
|
1017
|
-
path = "/api/v1/analytics/reporting/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
|
1018
|
-
|
1019
|
-
# query parameters
|
1020
|
-
query_params = {}
|
1021
|
-
|
1022
|
-
# header parameters
|
1023
|
-
header_params = {}
|
1024
|
-
|
1025
|
-
# HTTP header 'Accept' (if needed)
|
1026
|
-
_header_accept = ['application/json']
|
1027
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
1028
|
-
|
1029
|
-
# HTTP header 'Content-Type'
|
1030
|
-
_header_content_type = ['application/json']
|
1031
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
1032
|
-
|
1033
|
-
# form parameters
|
1034
|
-
form_params = {}
|
1035
|
-
|
1036
|
-
# http body (model)
|
1037
|
-
post_body = @api_client.object_to_http_body(opts[:'body'])
|
1038
|
-
|
1039
|
-
|
1040
|
-
auth_names = ['PureCloud Auth']
|
1041
|
-
data, status_code, headers = @api_client.call_api(:PUT, path,
|
1042
|
-
:header_params => header_params,
|
1043
|
-
:query_params => query_params,
|
1044
|
-
:form_params => form_params,
|
1045
|
-
:body => post_body,
|
1046
|
-
:auth_names => auth_names,
|
1047
|
-
:return_type => 'ReportSchedule')
|
1048
|
-
if @api_client.config.debugging
|
1049
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#update_reporting_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1050
|
-
end
|
1051
|
-
return data, status_code, headers
|
1052
|
-
end
|
1053
|
-
|
1054
|
-
# Delete a scheduled report job.
|
1055
|
-
#
|
1056
|
-
# @param schedule_id Schedule ID
|
1057
|
-
# @param [Hash] opts the optional parameters
|
1058
|
-
# @return [String]
|
1059
|
-
def delete_reporting_schedule(schedule_id, opts = {})
|
1060
|
-
data, status_code, headers = delete_reporting_schedule_with_http_info(schedule_id, opts)
|
1061
|
-
return data
|
1062
|
-
end
|
1063
|
-
|
1064
|
-
# Delete a scheduled report job.
|
1065
|
-
#
|
1066
|
-
# @param schedule_id Schedule ID
|
1067
|
-
# @param [Hash] opts the optional parameters
|
1068
|
-
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
1069
|
-
def delete_reporting_schedule_with_http_info(schedule_id, opts = {})
|
1070
|
-
if @api_client.config.debugging
|
1071
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#delete_reporting_schedule ..."
|
1072
|
-
end
|
1073
|
-
|
1074
|
-
# verify the required parameter 'schedule_id' is set
|
1075
|
-
fail "Missing the required parameter 'schedule_id' when calling delete_reporting_schedule" if schedule_id.nil?
|
1076
|
-
|
1077
|
-
# resource path
|
1078
|
-
path = "/api/v1/analytics/reporting/schedules/{scheduleId}".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
|
1079
|
-
|
1080
|
-
# query parameters
|
1081
|
-
query_params = {}
|
1082
|
-
|
1083
|
-
# header parameters
|
1084
|
-
header_params = {}
|
1085
|
-
|
1086
|
-
# HTTP header 'Accept' (if needed)
|
1087
|
-
_header_accept = ['application/json']
|
1088
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
1089
|
-
|
1090
|
-
# HTTP header 'Content-Type'
|
1091
|
-
_header_content_type = ['application/json']
|
1092
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
1093
|
-
|
1094
|
-
# form parameters
|
1095
|
-
form_params = {}
|
1096
|
-
|
1097
|
-
# http body (model)
|
1098
|
-
post_body = nil
|
1099
|
-
|
1100
|
-
|
1101
|
-
auth_names = ['PureCloud Auth']
|
1102
|
-
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
1103
|
-
:header_params => header_params,
|
1104
|
-
:query_params => query_params,
|
1105
|
-
:form_params => form_params,
|
1106
|
-
:body => post_body,
|
1107
|
-
:auth_names => auth_names,
|
1108
|
-
:return_type => 'String')
|
1109
|
-
if @api_client.config.debugging
|
1110
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#delete_reporting_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1111
|
-
end
|
1112
|
-
return data, status_code, headers
|
1113
|
-
end
|
1114
|
-
|
1115
|
-
# Get list of completed scheduled report jobs.
|
1116
|
-
#
|
1117
|
-
# @param schedule_id Schedule ID
|
1118
|
-
# @param [Hash] opts the optional parameters
|
1119
|
-
# @option opts [Integer] :page_number
|
1120
|
-
# @option opts [Integer] :page_size
|
1121
|
-
# @return [ReportRunEntryEntityDomainListing]
|
1122
|
-
def get_reporting_schedule_history(schedule_id, opts = {})
|
1123
|
-
data, status_code, headers = get_reporting_schedule_history_with_http_info(schedule_id, opts)
|
1124
|
-
return data
|
1125
|
-
end
|
1126
|
-
|
1127
|
-
# Get list of completed scheduled report jobs.
|
1128
|
-
#
|
1129
|
-
# @param schedule_id Schedule ID
|
1130
|
-
# @param [Hash] opts the optional parameters
|
1131
|
-
# @option opts [Integer] :page_number
|
1132
|
-
# @option opts [Integer] :page_size
|
1133
|
-
# @return [Array<(ReportRunEntryEntityDomainListing, Fixnum, Hash)>] ReportRunEntryEntityDomainListing data, response status code and response headers
|
1134
|
-
def get_reporting_schedule_history_with_http_info(schedule_id, opts = {})
|
1135
|
-
if @api_client.config.debugging
|
1136
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedule_history ..."
|
1137
|
-
end
|
1138
|
-
|
1139
|
-
# verify the required parameter 'schedule_id' is set
|
1140
|
-
fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedule_history" if schedule_id.nil?
|
1141
|
-
|
1142
|
-
# resource path
|
1143
|
-
path = "/api/v1/analytics/reporting/schedules/{scheduleId}/history".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
|
1144
|
-
|
1145
|
-
# query parameters
|
1146
|
-
query_params = {}
|
1147
|
-
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
1148
|
-
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
1149
|
-
|
1150
|
-
# header parameters
|
1151
|
-
header_params = {}
|
1152
|
-
|
1153
|
-
# HTTP header 'Accept' (if needed)
|
1154
|
-
_header_accept = ['application/json']
|
1155
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
1156
|
-
|
1157
|
-
# HTTP header 'Content-Type'
|
1158
|
-
_header_content_type = ['application/json']
|
1159
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
1160
|
-
|
1161
|
-
# form parameters
|
1162
|
-
form_params = {}
|
1163
|
-
|
1164
|
-
# http body (model)
|
1165
|
-
post_body = nil
|
1166
|
-
|
1167
|
-
|
1168
|
-
auth_names = ['PureCloud Auth']
|
1169
|
-
data, status_code, headers = @api_client.call_api(:GET, path,
|
1170
|
-
:header_params => header_params,
|
1171
|
-
:query_params => query_params,
|
1172
|
-
:form_params => form_params,
|
1173
|
-
:body => post_body,
|
1174
|
-
:auth_names => auth_names,
|
1175
|
-
:return_type => 'ReportRunEntryEntityDomainListing')
|
1176
|
-
if @api_client.config.debugging
|
1177
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedule_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1178
|
-
end
|
1179
|
-
return data, status_code, headers
|
1180
|
-
end
|
1181
|
-
|
1182
|
-
# Get most recently completed scheduled report job.
|
1183
|
-
#
|
1184
|
-
# @param schedule_id Schedule ID
|
1185
|
-
# @param [Hash] opts the optional parameters
|
1186
|
-
# @return [ReportRunEntry]
|
1187
|
-
def get_reporting_schedule_history_latest(schedule_id, opts = {})
|
1188
|
-
data, status_code, headers = get_reporting_schedule_history_latest_with_http_info(schedule_id, opts)
|
1189
|
-
return data
|
1190
|
-
end
|
1191
|
-
|
1192
|
-
# Get most recently completed scheduled report job.
|
1193
|
-
#
|
1194
|
-
# @param schedule_id Schedule ID
|
1195
|
-
# @param [Hash] opts the optional parameters
|
1196
|
-
# @return [Array<(ReportRunEntry, Fixnum, Hash)>] ReportRunEntry data, response status code and response headers
|
1197
|
-
def get_reporting_schedule_history_latest_with_http_info(schedule_id, opts = {})
|
1198
|
-
if @api_client.config.debugging
|
1199
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedule_history_latest ..."
|
1200
|
-
end
|
1201
|
-
|
1202
|
-
# verify the required parameter 'schedule_id' is set
|
1203
|
-
fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedule_history_latest" if schedule_id.nil?
|
1204
|
-
|
1205
|
-
# resource path
|
1206
|
-
path = "/api/v1/analytics/reporting/schedules/{scheduleId}/history/latest".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
|
1207
|
-
|
1208
|
-
# query parameters
|
1209
|
-
query_params = {}
|
1210
|
-
|
1211
|
-
# header parameters
|
1212
|
-
header_params = {}
|
1213
|
-
|
1214
|
-
# HTTP header 'Accept' (if needed)
|
1215
|
-
_header_accept = ['application/json']
|
1216
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
1217
|
-
|
1218
|
-
# HTTP header 'Content-Type'
|
1219
|
-
_header_content_type = ['application/json']
|
1220
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
1221
|
-
|
1222
|
-
# form parameters
|
1223
|
-
form_params = {}
|
1224
|
-
|
1225
|
-
# http body (model)
|
1226
|
-
post_body = nil
|
1227
|
-
|
1228
|
-
|
1229
|
-
auth_names = ['PureCloud Auth']
|
1230
|
-
data, status_code, headers = @api_client.call_api(:GET, path,
|
1231
|
-
:header_params => header_params,
|
1232
|
-
:query_params => query_params,
|
1233
|
-
:form_params => form_params,
|
1234
|
-
:body => post_body,
|
1235
|
-
:auth_names => auth_names,
|
1236
|
-
:return_type => 'ReportRunEntry')
|
1237
|
-
if @api_client.config.debugging
|
1238
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedule_history_latest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1239
|
-
end
|
1240
|
-
return data, status_code, headers
|
1241
|
-
end
|
1242
|
-
|
1243
|
-
# A completed scheduled report job
|
1244
|
-
# A completed scheduled report job.
|
1245
|
-
# @param run_id Run ID
|
1246
|
-
# @param schedule_id Schedule ID
|
1247
|
-
# @param [Hash] opts the optional parameters
|
1248
|
-
# @return [ReportRunEntry]
|
1249
|
-
def get_reporting_schedule_history_by_run_id(run_id, schedule_id, opts = {})
|
1250
|
-
data, status_code, headers = get_reporting_schedule_history_by_run_id_with_http_info(run_id, schedule_id, opts)
|
1251
|
-
return data
|
1252
|
-
end
|
1253
|
-
|
1254
|
-
# A completed scheduled report job
|
1255
|
-
# A completed scheduled report job.
|
1256
|
-
# @param run_id Run ID
|
1257
|
-
# @param schedule_id Schedule ID
|
1258
|
-
# @param [Hash] opts the optional parameters
|
1259
|
-
# @return [Array<(ReportRunEntry, Fixnum, Hash)>] ReportRunEntry data, response status code and response headers
|
1260
|
-
def get_reporting_schedule_history_by_run_id_with_http_info(run_id, schedule_id, opts = {})
|
1261
|
-
if @api_client.config.debugging
|
1262
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_schedule_history_by_run_id ..."
|
1263
|
-
end
|
1264
|
-
|
1265
|
-
# verify the required parameter 'run_id' is set
|
1266
|
-
fail "Missing the required parameter 'run_id' when calling get_reporting_schedule_history_by_run_id" if run_id.nil?
|
1267
|
-
|
1268
|
-
# verify the required parameter 'schedule_id' is set
|
1269
|
-
fail "Missing the required parameter 'schedule_id' when calling get_reporting_schedule_history_by_run_id" if schedule_id.nil?
|
1270
|
-
|
1271
|
-
# resource path
|
1272
|
-
path = "/api/v1/analytics/reporting/schedules/{scheduleId}/history/{runId}".sub('{format}','json').sub('{' + 'runId' + '}', run_id.to_s).sub('{' + 'scheduleId' + '}', schedule_id.to_s)
|
1273
|
-
|
1274
|
-
# query parameters
|
1275
|
-
query_params = {}
|
1276
|
-
|
1277
|
-
# header parameters
|
1278
|
-
header_params = {}
|
1279
|
-
|
1280
|
-
# HTTP header 'Accept' (if needed)
|
1281
|
-
_header_accept = ['application/json']
|
1282
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
1283
|
-
|
1284
|
-
# HTTP header 'Content-Type'
|
1285
|
-
_header_content_type = ['application/json']
|
1286
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
1287
|
-
|
1288
|
-
# form parameters
|
1289
|
-
form_params = {}
|
1290
|
-
|
1291
|
-
# http body (model)
|
1292
|
-
post_body = nil
|
1293
|
-
|
1294
|
-
|
1295
|
-
auth_names = ['PureCloud Auth']
|
1296
|
-
data, status_code, headers = @api_client.call_api(:GET, path,
|
1297
|
-
:header_params => header_params,
|
1298
|
-
:query_params => query_params,
|
1299
|
-
:form_params => form_params,
|
1300
|
-
:body => post_body,
|
1301
|
-
:auth_names => auth_names,
|
1302
|
-
:return_type => 'ReportRunEntry')
|
1303
|
-
if @api_client.config.debugging
|
1304
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_schedule_history_by_run_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1305
|
-
end
|
1306
|
-
return data, status_code, headers
|
1307
|
-
end
|
1308
|
-
|
1309
|
-
# Place a scheduled report immediately into the reporting queue
|
1310
|
-
#
|
1311
|
-
# @param schedule_id Schedule ID
|
1312
|
-
# @param [Hash] opts the optional parameters
|
1313
|
-
# @return [RunNowResponse]
|
1314
|
-
def create_reporting_schedule_runreport(schedule_id, opts = {})
|
1315
|
-
data, status_code, headers = create_reporting_schedule_runreport_with_http_info(schedule_id, opts)
|
1316
|
-
return data
|
1317
|
-
end
|
1318
|
-
|
1319
|
-
# Place a scheduled report immediately into the reporting queue
|
1320
|
-
#
|
1321
|
-
# @param schedule_id Schedule ID
|
1322
|
-
# @param [Hash] opts the optional parameters
|
1323
|
-
# @return [Array<(RunNowResponse, Fixnum, Hash)>] RunNowResponse data, response status code and response headers
|
1324
|
-
def create_reporting_schedule_runreport_with_http_info(schedule_id, opts = {})
|
1325
|
-
if @api_client.config.debugging
|
1326
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#create_reporting_schedule_runreport ..."
|
1327
|
-
end
|
1328
|
-
|
1329
|
-
# verify the required parameter 'schedule_id' is set
|
1330
|
-
fail "Missing the required parameter 'schedule_id' when calling create_reporting_schedule_runreport" if schedule_id.nil?
|
1331
|
-
|
1332
|
-
# resource path
|
1333
|
-
path = "/api/v1/analytics/reporting/schedules/{scheduleId}/runreport".sub('{format}','json').sub('{' + 'scheduleId' + '}', schedule_id.to_s)
|
1334
|
-
|
1335
|
-
# query parameters
|
1336
|
-
query_params = {}
|
1337
|
-
|
1338
|
-
# header parameters
|
1339
|
-
header_params = {}
|
1340
|
-
|
1341
|
-
# HTTP header 'Accept' (if needed)
|
1342
|
-
_header_accept = ['application/json']
|
1343
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
1344
|
-
|
1345
|
-
# HTTP header 'Content-Type'
|
1346
|
-
_header_content_type = ['application/json']
|
1347
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
1348
|
-
|
1349
|
-
# form parameters
|
1350
|
-
form_params = {}
|
1351
|
-
|
1352
|
-
# http body (model)
|
1353
|
-
post_body = nil
|
1354
|
-
|
1355
|
-
|
1356
|
-
auth_names = ['PureCloud Auth']
|
1357
|
-
data, status_code, headers = @api_client.call_api(:POST, path,
|
1358
|
-
:header_params => header_params,
|
1359
|
-
:query_params => query_params,
|
1360
|
-
:form_params => form_params,
|
1361
|
-
:body => post_body,
|
1362
|
-
:auth_names => auth_names,
|
1363
|
-
:return_type => 'RunNowResponse')
|
1364
|
-
if @api_client.config.debugging
|
1365
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#create_reporting_schedule_runreport\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1366
|
-
end
|
1367
|
-
return data, status_code, headers
|
1368
|
-
end
|
1369
|
-
|
1370
|
-
# Get a list of report time periods.
|
1371
|
-
#
|
1372
|
-
# @param [Hash] opts the optional parameters
|
1373
|
-
# @return [Array<String>]
|
1374
|
-
def get_reporting_timeperiods(opts = {})
|
1375
|
-
data, status_code, headers = get_reporting_timeperiods_with_http_info(opts)
|
1376
|
-
return data
|
1377
|
-
end
|
1378
|
-
|
1379
|
-
# Get a list of report time periods.
|
1380
|
-
#
|
1381
|
-
# @param [Hash] opts the optional parameters
|
1382
|
-
# @return [Array<(Array<String>, Fixnum, Hash)>] Array<String> data, response status code and response headers
|
1383
|
-
def get_reporting_timeperiods_with_http_info(opts = {})
|
1384
|
-
if @api_client.config.debugging
|
1385
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_timeperiods ..."
|
1386
|
-
end
|
1387
|
-
|
1388
|
-
# resource path
|
1389
|
-
path = "/api/v1/analytics/reporting/timeperiods".sub('{format}','json')
|
1390
|
-
|
1391
|
-
# query parameters
|
1392
|
-
query_params = {}
|
1393
|
-
|
1394
|
-
# header parameters
|
1395
|
-
header_params = {}
|
1396
|
-
|
1397
|
-
# HTTP header 'Accept' (if needed)
|
1398
|
-
_header_accept = ['application/json']
|
1399
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
1400
|
-
|
1401
|
-
# HTTP header 'Content-Type'
|
1402
|
-
_header_content_type = ['application/json']
|
1403
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
1404
|
-
|
1405
|
-
# form parameters
|
1406
|
-
form_params = {}
|
1407
|
-
|
1408
|
-
# http body (model)
|
1409
|
-
post_body = nil
|
1410
|
-
|
1411
|
-
|
1412
|
-
auth_names = ['PureCloud Auth']
|
1413
|
-
data, status_code, headers = @api_client.call_api(:GET, path,
|
1414
|
-
:header_params => header_params,
|
1415
|
-
:query_params => query_params,
|
1416
|
-
:form_params => form_params,
|
1417
|
-
:body => post_body,
|
1418
|
-
:auth_names => auth_names,
|
1419
|
-
:return_type => 'Array<String>')
|
1420
|
-
if @api_client.config.debugging
|
1421
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_timeperiods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1422
|
-
end
|
1423
|
-
return data, status_code, headers
|
1424
|
-
end
|
1425
|
-
|
1426
|
-
# Get a reporting metadata.
|
1427
|
-
#
|
1428
|
-
# @param report_id Report ID
|
1429
|
-
# @param [Hash] opts the optional parameters
|
1430
|
-
# @option opts [String] :accept_language Accepted language
|
1431
|
-
# @option opts [String] :locale Locale
|
1432
|
-
# @return [ReportMetaData]
|
1433
|
-
def get_reporting_report_metadata(report_id, opts = {})
|
1434
|
-
data, status_code, headers = get_reporting_report_metadata_with_http_info(report_id, opts)
|
1435
|
-
return data
|
1436
|
-
end
|
1437
|
-
|
1438
|
-
# Get a reporting metadata.
|
1439
|
-
#
|
1440
|
-
# @param report_id Report ID
|
1441
|
-
# @param [Hash] opts the optional parameters
|
1442
|
-
# @option opts [String] :accept_language Accepted language
|
1443
|
-
# @option opts [String] :locale Locale
|
1444
|
-
# @return [Array<(ReportMetaData, Fixnum, Hash)>] ReportMetaData data, response status code and response headers
|
1445
|
-
def get_reporting_report_metadata_with_http_info(report_id, opts = {})
|
1446
|
-
if @api_client.config.debugging
|
1447
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#get_reporting_report_metadata ..."
|
1448
|
-
end
|
1449
|
-
|
1450
|
-
# verify the required parameter 'report_id' is set
|
1451
|
-
fail "Missing the required parameter 'report_id' when calling get_reporting_report_metadata" if report_id.nil?
|
1452
|
-
|
1453
|
-
# resource path
|
1454
|
-
path = "/api/v1/analytics/reporting/{reportId}/metadata".sub('{format}','json').sub('{' + 'reportId' + '}', report_id.to_s)
|
1455
|
-
|
1456
|
-
# query parameters
|
1457
|
-
query_params = {}
|
1458
|
-
query_params[:'locale'] = opts[:'locale'] if opts[:'locale']
|
1459
|
-
|
1460
|
-
# header parameters
|
1461
|
-
header_params = {}
|
1462
|
-
|
1463
|
-
# HTTP header 'Accept' (if needed)
|
1464
|
-
_header_accept = ['application/json']
|
1465
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
1466
|
-
|
1467
|
-
# HTTP header 'Content-Type'
|
1468
|
-
_header_content_type = ['application/json']
|
1469
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
1470
|
-
header_params[:'Accept-Language'] = opts[:'accept_language'] if opts[:'accept_language']
|
1471
|
-
|
1472
|
-
# form parameters
|
1473
|
-
form_params = {}
|
1474
|
-
|
1475
|
-
# http body (model)
|
1476
|
-
post_body = nil
|
1477
|
-
|
1478
|
-
|
1479
|
-
auth_names = ['PureCloud Auth']
|
1480
|
-
data, status_code, headers = @api_client.call_api(:GET, path,
|
1481
|
-
:header_params => header_params,
|
1482
|
-
:query_params => query_params,
|
1483
|
-
:form_params => form_params,
|
1484
|
-
:body => post_body,
|
1485
|
-
:auth_names => auth_names,
|
1486
|
-
:return_type => 'ReportMetaData')
|
1487
|
-
if @api_client.config.debugging
|
1488
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#get_reporting_report_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1489
|
-
end
|
1490
|
-
return data, status_code, headers
|
1491
|
-
end
|
1492
|
-
|
1493
|
-
# Executes a segments query against the analytics service
|
1494
|
-
#
|
1495
|
-
# @param [Hash] opts the optional parameters
|
1496
|
-
# @option opts [Body1] :body queryObject
|
1497
|
-
# @return [nil]
|
1498
|
-
def create_segments_query(opts = {})
|
1499
|
-
create_segments_query_with_http_info(opts)
|
1500
|
-
return nil
|
1501
|
-
end
|
1502
|
-
|
1503
|
-
# Executes a segments query against the analytics service
|
1504
|
-
#
|
1505
|
-
# @param [Hash] opts the optional parameters
|
1506
|
-
# @option opts [Body1] :body queryObject
|
1507
|
-
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1508
|
-
def create_segments_query_with_http_info(opts = {})
|
1509
|
-
if @api_client.config.debugging
|
1510
|
-
@api_client.config.logger.debug "Calling API: AnalyticsApi#create_segments_query ..."
|
1511
|
-
end
|
1512
|
-
|
1513
|
-
# resource path
|
1514
|
-
path = "/api/v1/analytics/segments/query".sub('{format}','json')
|
1515
|
-
|
1516
|
-
# query parameters
|
1517
|
-
query_params = {}
|
1518
|
-
|
1519
|
-
# header parameters
|
1520
|
-
header_params = {}
|
1521
|
-
|
1522
|
-
# HTTP header 'Accept' (if needed)
|
1523
|
-
_header_accept = ['application/json']
|
1524
|
-
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
1525
|
-
|
1526
|
-
# HTTP header 'Content-Type'
|
1527
|
-
_header_content_type = ['application/json']
|
1528
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
1529
|
-
|
1530
|
-
# form parameters
|
1531
|
-
form_params = {}
|
1532
|
-
|
1533
|
-
# http body (model)
|
1534
|
-
post_body = @api_client.object_to_http_body(opts[:'body'])
|
1535
|
-
|
1536
|
-
|
1537
|
-
auth_names = ['PureCloud Auth']
|
1538
|
-
data, status_code, headers = @api_client.call_api(:POST, path,
|
1539
|
-
:header_params => header_params,
|
1540
|
-
:query_params => query_params,
|
1541
|
-
:form_params => form_params,
|
1542
|
-
:body => post_body,
|
1543
|
-
:auth_names => auth_names)
|
1544
|
-
if @api_client.config.debugging
|
1545
|
-
@api_client.config.logger.debug "API called: AnalyticsApi#create_segments_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1546
|
-
end
|
1547
|
-
return data, status_code, headers
|
1548
|
-
end
|
1549
|
-
end
|
1550
|
-
end
|
1551
|
-
|
1552
|
-
|
1553
|
-
|
1554
|
-
|