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
@@ -0,0 +1,687 @@
|
|
1
|
+
require "uri"
|
2
|
+
|
3
|
+
module PureCloud
|
4
|
+
class ResponseManagementApi
|
5
|
+
attr_accessor :api_client
|
6
|
+
|
7
|
+
def initialize(api_client = ApiClient.default)
|
8
|
+
@api_client = api_client
|
9
|
+
end
|
10
|
+
|
11
|
+
# Gets a list of existing response libraries.
|
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
|
+
# @return [LibraryEntityListing]
|
17
|
+
def get_libraries(opts = {})
|
18
|
+
data, status_code, headers = get_libraries_with_http_info(opts)
|
19
|
+
return data
|
20
|
+
end
|
21
|
+
|
22
|
+
# Gets a list of existing response libraries.
|
23
|
+
#
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @option opts [Integer] :page_number Page number
|
26
|
+
# @option opts [Integer] :page_size Page size
|
27
|
+
# @return [Array<(LibraryEntityListing, Fixnum, Hash)>] LibraryEntityListing data, response status code and response headers
|
28
|
+
def get_libraries_with_http_info(opts = {})
|
29
|
+
if @api_client.config.debugging
|
30
|
+
@api_client.config.logger.debug "Calling API: ResponseManagementApi#get_libraries ..."
|
31
|
+
end
|
32
|
+
|
33
|
+
# resource path
|
34
|
+
path = "/api/v1/responsemanagement/libraries".sub('{format}','json')
|
35
|
+
|
36
|
+
# query parameters
|
37
|
+
query_params = {}
|
38
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
39
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
40
|
+
|
41
|
+
# header parameters
|
42
|
+
header_params = {}
|
43
|
+
|
44
|
+
# HTTP header 'Accept' (if needed)
|
45
|
+
_header_accept = ['application/json']
|
46
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
47
|
+
|
48
|
+
# HTTP header 'Content-Type'
|
49
|
+
_header_content_type = ['application/json']
|
50
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
51
|
+
|
52
|
+
# form parameters
|
53
|
+
form_params = {}
|
54
|
+
|
55
|
+
# http body (model)
|
56
|
+
post_body = nil
|
57
|
+
|
58
|
+
|
59
|
+
auth_names = ['PureCloud Auth']
|
60
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
61
|
+
:header_params => header_params,
|
62
|
+
:query_params => query_params,
|
63
|
+
:form_params => form_params,
|
64
|
+
:body => post_body,
|
65
|
+
:auth_names => auth_names,
|
66
|
+
:return_type => 'LibraryEntityListing')
|
67
|
+
if @api_client.config.debugging
|
68
|
+
@api_client.config.logger.debug "API called: ResponseManagementApi#get_libraries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
69
|
+
end
|
70
|
+
return data, status_code, headers
|
71
|
+
end
|
72
|
+
|
73
|
+
# Create a response library.
|
74
|
+
#
|
75
|
+
# @param [Hash] opts the optional parameters
|
76
|
+
# @option opts [Library] :body Library
|
77
|
+
# @return [Library]
|
78
|
+
def post_libraries(opts = {})
|
79
|
+
data, status_code, headers = post_libraries_with_http_info(opts)
|
80
|
+
return data
|
81
|
+
end
|
82
|
+
|
83
|
+
# Create a response library.
|
84
|
+
#
|
85
|
+
# @param [Hash] opts the optional parameters
|
86
|
+
# @option opts [Library] :body Library
|
87
|
+
# @return [Array<(Library, Fixnum, Hash)>] Library data, response status code and response headers
|
88
|
+
def post_libraries_with_http_info(opts = {})
|
89
|
+
if @api_client.config.debugging
|
90
|
+
@api_client.config.logger.debug "Calling API: ResponseManagementApi#post_libraries ..."
|
91
|
+
end
|
92
|
+
|
93
|
+
# resource path
|
94
|
+
path = "/api/v1/responsemanagement/libraries".sub('{format}','json')
|
95
|
+
|
96
|
+
# query parameters
|
97
|
+
query_params = {}
|
98
|
+
|
99
|
+
# header parameters
|
100
|
+
header_params = {}
|
101
|
+
|
102
|
+
# HTTP header 'Accept' (if needed)
|
103
|
+
_header_accept = ['application/json']
|
104
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
105
|
+
|
106
|
+
# HTTP header 'Content-Type'
|
107
|
+
_header_content_type = ['application/json']
|
108
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
109
|
+
|
110
|
+
# form parameters
|
111
|
+
form_params = {}
|
112
|
+
|
113
|
+
# http body (model)
|
114
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
115
|
+
|
116
|
+
|
117
|
+
auth_names = ['PureCloud Auth']
|
118
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
119
|
+
:header_params => header_params,
|
120
|
+
:query_params => query_params,
|
121
|
+
:form_params => form_params,
|
122
|
+
:body => post_body,
|
123
|
+
:auth_names => auth_names,
|
124
|
+
:return_type => 'Library')
|
125
|
+
if @api_client.config.debugging
|
126
|
+
@api_client.config.logger.debug "API called: ResponseManagementApi#post_libraries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
127
|
+
end
|
128
|
+
return data, status_code, headers
|
129
|
+
end
|
130
|
+
|
131
|
+
# Get details about an existing response library.
|
132
|
+
#
|
133
|
+
# @param library_id Library ID
|
134
|
+
# @param [Hash] opts the optional parameters
|
135
|
+
# @return [Library]
|
136
|
+
def get_libraries_library_id(library_id, opts = {})
|
137
|
+
data, status_code, headers = get_libraries_library_id_with_http_info(library_id, opts)
|
138
|
+
return data
|
139
|
+
end
|
140
|
+
|
141
|
+
# Get details about an existing response library.
|
142
|
+
#
|
143
|
+
# @param library_id Library ID
|
144
|
+
# @param [Hash] opts the optional parameters
|
145
|
+
# @return [Array<(Library, Fixnum, Hash)>] Library data, response status code and response headers
|
146
|
+
def get_libraries_library_id_with_http_info(library_id, opts = {})
|
147
|
+
if @api_client.config.debugging
|
148
|
+
@api_client.config.logger.debug "Calling API: ResponseManagementApi#get_libraries_library_id ..."
|
149
|
+
end
|
150
|
+
|
151
|
+
# verify the required parameter 'library_id' is set
|
152
|
+
fail "Missing the required parameter 'library_id' when calling get_libraries_library_id" if library_id.nil?
|
153
|
+
|
154
|
+
# resource path
|
155
|
+
path = "/api/v1/responsemanagement/libraries/{libraryId}".sub('{format}','json').sub('{' + 'libraryId' + '}', library_id.to_s)
|
156
|
+
|
157
|
+
# query parameters
|
158
|
+
query_params = {}
|
159
|
+
|
160
|
+
# header parameters
|
161
|
+
header_params = {}
|
162
|
+
|
163
|
+
# HTTP header 'Accept' (if needed)
|
164
|
+
_header_accept = ['application/json']
|
165
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
166
|
+
|
167
|
+
# HTTP header 'Content-Type'
|
168
|
+
_header_content_type = ['application/json']
|
169
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
170
|
+
|
171
|
+
# form parameters
|
172
|
+
form_params = {}
|
173
|
+
|
174
|
+
# http body (model)
|
175
|
+
post_body = nil
|
176
|
+
|
177
|
+
|
178
|
+
auth_names = ['PureCloud Auth']
|
179
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
180
|
+
:header_params => header_params,
|
181
|
+
:query_params => query_params,
|
182
|
+
:form_params => form_params,
|
183
|
+
:body => post_body,
|
184
|
+
:auth_names => auth_names,
|
185
|
+
:return_type => 'Library')
|
186
|
+
if @api_client.config.debugging
|
187
|
+
@api_client.config.logger.debug "API called: ResponseManagementApi#get_libraries_library_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
188
|
+
end
|
189
|
+
return data, status_code, headers
|
190
|
+
end
|
191
|
+
|
192
|
+
# Update an existing response library.
|
193
|
+
# Fields that can be updated: name. The most recent version is required for updates.
|
194
|
+
# @param library_id Library ID
|
195
|
+
# @param [Hash] opts the optional parameters
|
196
|
+
# @option opts [Library] :body Library
|
197
|
+
# @return [Library]
|
198
|
+
def put_libraries_library_id(library_id, opts = {})
|
199
|
+
data, status_code, headers = put_libraries_library_id_with_http_info(library_id, opts)
|
200
|
+
return data
|
201
|
+
end
|
202
|
+
|
203
|
+
# Update an existing response library.
|
204
|
+
# Fields that can be updated: name. The most recent version is required for updates.
|
205
|
+
# @param library_id Library ID
|
206
|
+
# @param [Hash] opts the optional parameters
|
207
|
+
# @option opts [Library] :body Library
|
208
|
+
# @return [Array<(Library, Fixnum, Hash)>] Library data, response status code and response headers
|
209
|
+
def put_libraries_library_id_with_http_info(library_id, opts = {})
|
210
|
+
if @api_client.config.debugging
|
211
|
+
@api_client.config.logger.debug "Calling API: ResponseManagementApi#put_libraries_library_id ..."
|
212
|
+
end
|
213
|
+
|
214
|
+
# verify the required parameter 'library_id' is set
|
215
|
+
fail "Missing the required parameter 'library_id' when calling put_libraries_library_id" if library_id.nil?
|
216
|
+
|
217
|
+
# resource path
|
218
|
+
path = "/api/v1/responsemanagement/libraries/{libraryId}".sub('{format}','json').sub('{' + 'libraryId' + '}', library_id.to_s)
|
219
|
+
|
220
|
+
# query parameters
|
221
|
+
query_params = {}
|
222
|
+
|
223
|
+
# header parameters
|
224
|
+
header_params = {}
|
225
|
+
|
226
|
+
# HTTP header 'Accept' (if needed)
|
227
|
+
_header_accept = ['application/json']
|
228
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
229
|
+
|
230
|
+
# HTTP header 'Content-Type'
|
231
|
+
_header_content_type = ['application/json']
|
232
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
233
|
+
|
234
|
+
# form parameters
|
235
|
+
form_params = {}
|
236
|
+
|
237
|
+
# http body (model)
|
238
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
239
|
+
|
240
|
+
|
241
|
+
auth_names = ['PureCloud Auth']
|
242
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
243
|
+
:header_params => header_params,
|
244
|
+
:query_params => query_params,
|
245
|
+
:form_params => form_params,
|
246
|
+
:body => post_body,
|
247
|
+
:auth_names => auth_names,
|
248
|
+
:return_type => 'Library')
|
249
|
+
if @api_client.config.debugging
|
250
|
+
@api_client.config.logger.debug "API called: ResponseManagementApi#put_libraries_library_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
251
|
+
end
|
252
|
+
return data, status_code, headers
|
253
|
+
end
|
254
|
+
|
255
|
+
# Delete an existing response library.
|
256
|
+
# This will remove any responses associated with the library.
|
257
|
+
# @param library_id Library ID
|
258
|
+
# @param [Hash] opts the optional parameters
|
259
|
+
# @return [nil]
|
260
|
+
def delete_libraries_library_id(library_id, opts = {})
|
261
|
+
delete_libraries_library_id_with_http_info(library_id, opts)
|
262
|
+
return nil
|
263
|
+
end
|
264
|
+
|
265
|
+
# Delete an existing response library.
|
266
|
+
# This will remove any responses associated with the library.
|
267
|
+
# @param library_id Library ID
|
268
|
+
# @param [Hash] opts the optional parameters
|
269
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
270
|
+
def delete_libraries_library_id_with_http_info(library_id, opts = {})
|
271
|
+
if @api_client.config.debugging
|
272
|
+
@api_client.config.logger.debug "Calling API: ResponseManagementApi#delete_libraries_library_id ..."
|
273
|
+
end
|
274
|
+
|
275
|
+
# verify the required parameter 'library_id' is set
|
276
|
+
fail "Missing the required parameter 'library_id' when calling delete_libraries_library_id" if library_id.nil?
|
277
|
+
|
278
|
+
# resource path
|
279
|
+
path = "/api/v1/responsemanagement/libraries/{libraryId}".sub('{format}','json').sub('{' + 'libraryId' + '}', library_id.to_s)
|
280
|
+
|
281
|
+
# query parameters
|
282
|
+
query_params = {}
|
283
|
+
|
284
|
+
# header parameters
|
285
|
+
header_params = {}
|
286
|
+
|
287
|
+
# HTTP header 'Accept' (if needed)
|
288
|
+
_header_accept = ['application/json']
|
289
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
290
|
+
|
291
|
+
# HTTP header 'Content-Type'
|
292
|
+
_header_content_type = ['application/json']
|
293
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
294
|
+
|
295
|
+
# form parameters
|
296
|
+
form_params = {}
|
297
|
+
|
298
|
+
# http body (model)
|
299
|
+
post_body = nil
|
300
|
+
|
301
|
+
|
302
|
+
auth_names = ['PureCloud Auth']
|
303
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
304
|
+
:header_params => header_params,
|
305
|
+
:query_params => query_params,
|
306
|
+
:form_params => form_params,
|
307
|
+
:body => post_body,
|
308
|
+
:auth_names => auth_names)
|
309
|
+
if @api_client.config.debugging
|
310
|
+
@api_client.config.logger.debug "API called: ResponseManagementApi#delete_libraries_library_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
311
|
+
end
|
312
|
+
return data, status_code, headers
|
313
|
+
end
|
314
|
+
|
315
|
+
# Gets a list of existing responses.
|
316
|
+
#
|
317
|
+
# @param library_id Library ID
|
318
|
+
# @param [Hash] opts the optional parameters
|
319
|
+
# @option opts [Integer] :page_number Page number
|
320
|
+
# @option opts [Integer] :page_size Page size
|
321
|
+
# @return [ResponseEntityListing]
|
322
|
+
def get_responses(library_id, opts = {})
|
323
|
+
data, status_code, headers = get_responses_with_http_info(library_id, opts)
|
324
|
+
return data
|
325
|
+
end
|
326
|
+
|
327
|
+
# Gets a list of existing responses.
|
328
|
+
#
|
329
|
+
# @param library_id Library ID
|
330
|
+
# @param [Hash] opts the optional parameters
|
331
|
+
# @option opts [Integer] :page_number Page number
|
332
|
+
# @option opts [Integer] :page_size Page size
|
333
|
+
# @return [Array<(ResponseEntityListing, Fixnum, Hash)>] ResponseEntityListing data, response status code and response headers
|
334
|
+
def get_responses_with_http_info(library_id, opts = {})
|
335
|
+
if @api_client.config.debugging
|
336
|
+
@api_client.config.logger.debug "Calling API: ResponseManagementApi#get_responses ..."
|
337
|
+
end
|
338
|
+
|
339
|
+
# verify the required parameter 'library_id' is set
|
340
|
+
fail "Missing the required parameter 'library_id' when calling get_responses" if library_id.nil?
|
341
|
+
|
342
|
+
# resource path
|
343
|
+
path = "/api/v1/responsemanagement/responses".sub('{format}','json')
|
344
|
+
|
345
|
+
# query parameters
|
346
|
+
query_params = {}
|
347
|
+
query_params[:'libraryId'] = library_id
|
348
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
349
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
350
|
+
|
351
|
+
# header parameters
|
352
|
+
header_params = {}
|
353
|
+
|
354
|
+
# HTTP header 'Accept' (if needed)
|
355
|
+
_header_accept = ['application/json']
|
356
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
357
|
+
|
358
|
+
# HTTP header 'Content-Type'
|
359
|
+
_header_content_type = ['application/json']
|
360
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
361
|
+
|
362
|
+
# form parameters
|
363
|
+
form_params = {}
|
364
|
+
|
365
|
+
# http body (model)
|
366
|
+
post_body = nil
|
367
|
+
|
368
|
+
|
369
|
+
auth_names = ['PureCloud Auth']
|
370
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
371
|
+
:header_params => header_params,
|
372
|
+
:query_params => query_params,
|
373
|
+
:form_params => form_params,
|
374
|
+
:body => post_body,
|
375
|
+
:auth_names => auth_names,
|
376
|
+
:return_type => 'ResponseEntityListing')
|
377
|
+
if @api_client.config.debugging
|
378
|
+
@api_client.config.logger.debug "API called: ResponseManagementApi#get_responses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
379
|
+
end
|
380
|
+
return data, status_code, headers
|
381
|
+
end
|
382
|
+
|
383
|
+
# Create a response.
|
384
|
+
#
|
385
|
+
# @param [Hash] opts the optional parameters
|
386
|
+
# @option opts [Response] :body Response
|
387
|
+
# @return [Response]
|
388
|
+
def post_responses(opts = {})
|
389
|
+
data, status_code, headers = post_responses_with_http_info(opts)
|
390
|
+
return data
|
391
|
+
end
|
392
|
+
|
393
|
+
# Create a response.
|
394
|
+
#
|
395
|
+
# @param [Hash] opts the optional parameters
|
396
|
+
# @option opts [Response] :body Response
|
397
|
+
# @return [Array<(Response, Fixnum, Hash)>] Response data, response status code and response headers
|
398
|
+
def post_responses_with_http_info(opts = {})
|
399
|
+
if @api_client.config.debugging
|
400
|
+
@api_client.config.logger.debug "Calling API: ResponseManagementApi#post_responses ..."
|
401
|
+
end
|
402
|
+
|
403
|
+
# resource path
|
404
|
+
path = "/api/v1/responsemanagement/responses".sub('{format}','json')
|
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 = @api_client.object_to_http_body(opts[:'body'])
|
425
|
+
|
426
|
+
|
427
|
+
auth_names = ['PureCloud Auth']
|
428
|
+
data, status_code, headers = @api_client.call_api(:POST, 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 => 'Response')
|
435
|
+
if @api_client.config.debugging
|
436
|
+
@api_client.config.logger.debug "API called: ResponseManagementApi#post_responses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
437
|
+
end
|
438
|
+
return data, status_code, headers
|
439
|
+
end
|
440
|
+
|
441
|
+
# Query responses
|
442
|
+
#
|
443
|
+
# @param [Hash] opts the optional parameters
|
444
|
+
# @option opts [ResponseQueryRequest] :body Response
|
445
|
+
# @return [ResponseQueryResults]
|
446
|
+
def post_responses_query(opts = {})
|
447
|
+
data, status_code, headers = post_responses_query_with_http_info(opts)
|
448
|
+
return data
|
449
|
+
end
|
450
|
+
|
451
|
+
# Query responses
|
452
|
+
#
|
453
|
+
# @param [Hash] opts the optional parameters
|
454
|
+
# @option opts [ResponseQueryRequest] :body Response
|
455
|
+
# @return [Array<(ResponseQueryResults, Fixnum, Hash)>] ResponseQueryResults data, response status code and response headers
|
456
|
+
def post_responses_query_with_http_info(opts = {})
|
457
|
+
if @api_client.config.debugging
|
458
|
+
@api_client.config.logger.debug "Calling API: ResponseManagementApi#post_responses_query ..."
|
459
|
+
end
|
460
|
+
|
461
|
+
# resource path
|
462
|
+
path = "/api/v1/responsemanagement/responses/query".sub('{format}','json')
|
463
|
+
|
464
|
+
# query parameters
|
465
|
+
query_params = {}
|
466
|
+
|
467
|
+
# header parameters
|
468
|
+
header_params = {}
|
469
|
+
|
470
|
+
# HTTP header 'Accept' (if needed)
|
471
|
+
_header_accept = ['application/json']
|
472
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
473
|
+
|
474
|
+
# HTTP header 'Content-Type'
|
475
|
+
_header_content_type = ['application/json']
|
476
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
477
|
+
|
478
|
+
# form parameters
|
479
|
+
form_params = {}
|
480
|
+
|
481
|
+
# http body (model)
|
482
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
483
|
+
|
484
|
+
|
485
|
+
auth_names = ['PureCloud Auth']
|
486
|
+
data, status_code, headers = @api_client.call_api(:POST, path,
|
487
|
+
:header_params => header_params,
|
488
|
+
:query_params => query_params,
|
489
|
+
:form_params => form_params,
|
490
|
+
:body => post_body,
|
491
|
+
:auth_names => auth_names,
|
492
|
+
:return_type => 'ResponseQueryResults')
|
493
|
+
if @api_client.config.debugging
|
494
|
+
@api_client.config.logger.debug "API called: ResponseManagementApi#post_responses_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
495
|
+
end
|
496
|
+
return data, status_code, headers
|
497
|
+
end
|
498
|
+
|
499
|
+
# Get details about an existing response.
|
500
|
+
#
|
501
|
+
# @param response_id Response ID
|
502
|
+
# @param [Hash] opts the optional parameters
|
503
|
+
# @return [Response]
|
504
|
+
def get_responses_response_id(response_id, opts = {})
|
505
|
+
data, status_code, headers = get_responses_response_id_with_http_info(response_id, opts)
|
506
|
+
return data
|
507
|
+
end
|
508
|
+
|
509
|
+
# Get details about an existing response.
|
510
|
+
#
|
511
|
+
# @param response_id Response ID
|
512
|
+
# @param [Hash] opts the optional parameters
|
513
|
+
# @return [Array<(Response, Fixnum, Hash)>] Response data, response status code and response headers
|
514
|
+
def get_responses_response_id_with_http_info(response_id, opts = {})
|
515
|
+
if @api_client.config.debugging
|
516
|
+
@api_client.config.logger.debug "Calling API: ResponseManagementApi#get_responses_response_id ..."
|
517
|
+
end
|
518
|
+
|
519
|
+
# verify the required parameter 'response_id' is set
|
520
|
+
fail "Missing the required parameter 'response_id' when calling get_responses_response_id" if response_id.nil?
|
521
|
+
|
522
|
+
# resource path
|
523
|
+
path = "/api/v1/responsemanagement/responses/{responseId}".sub('{format}','json').sub('{' + 'responseId' + '}', response_id.to_s)
|
524
|
+
|
525
|
+
# query parameters
|
526
|
+
query_params = {}
|
527
|
+
|
528
|
+
# header parameters
|
529
|
+
header_params = {}
|
530
|
+
|
531
|
+
# HTTP header 'Accept' (if needed)
|
532
|
+
_header_accept = ['application/json']
|
533
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
534
|
+
|
535
|
+
# HTTP header 'Content-Type'
|
536
|
+
_header_content_type = ['application/json']
|
537
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
538
|
+
|
539
|
+
# form parameters
|
540
|
+
form_params = {}
|
541
|
+
|
542
|
+
# http body (model)
|
543
|
+
post_body = nil
|
544
|
+
|
545
|
+
|
546
|
+
auth_names = ['PureCloud Auth']
|
547
|
+
data, status_code, headers = @api_client.call_api(:GET, path,
|
548
|
+
:header_params => header_params,
|
549
|
+
:query_params => query_params,
|
550
|
+
:form_params => form_params,
|
551
|
+
:body => post_body,
|
552
|
+
:auth_names => auth_names,
|
553
|
+
:return_type => 'Response')
|
554
|
+
if @api_client.config.debugging
|
555
|
+
@api_client.config.logger.debug "API called: ResponseManagementApi#get_responses_response_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
556
|
+
end
|
557
|
+
return data, status_code, headers
|
558
|
+
end
|
559
|
+
|
560
|
+
# Update an existing response.
|
561
|
+
# Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.
|
562
|
+
# @param response_id Response ID
|
563
|
+
# @param [Hash] opts the optional parameters
|
564
|
+
# @option opts [Response] :body Response
|
565
|
+
# @return [Response]
|
566
|
+
def put_responses_response_id(response_id, opts = {})
|
567
|
+
data, status_code, headers = put_responses_response_id_with_http_info(response_id, opts)
|
568
|
+
return data
|
569
|
+
end
|
570
|
+
|
571
|
+
# Update an existing response.
|
572
|
+
# Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.
|
573
|
+
# @param response_id Response ID
|
574
|
+
# @param [Hash] opts the optional parameters
|
575
|
+
# @option opts [Response] :body Response
|
576
|
+
# @return [Array<(Response, Fixnum, Hash)>] Response data, response status code and response headers
|
577
|
+
def put_responses_response_id_with_http_info(response_id, opts = {})
|
578
|
+
if @api_client.config.debugging
|
579
|
+
@api_client.config.logger.debug "Calling API: ResponseManagementApi#put_responses_response_id ..."
|
580
|
+
end
|
581
|
+
|
582
|
+
# verify the required parameter 'response_id' is set
|
583
|
+
fail "Missing the required parameter 'response_id' when calling put_responses_response_id" if response_id.nil?
|
584
|
+
|
585
|
+
# resource path
|
586
|
+
path = "/api/v1/responsemanagement/responses/{responseId}".sub('{format}','json').sub('{' + 'responseId' + '}', response_id.to_s)
|
587
|
+
|
588
|
+
# query parameters
|
589
|
+
query_params = {}
|
590
|
+
|
591
|
+
# header parameters
|
592
|
+
header_params = {}
|
593
|
+
|
594
|
+
# HTTP header 'Accept' (if needed)
|
595
|
+
_header_accept = ['application/json']
|
596
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
597
|
+
|
598
|
+
# HTTP header 'Content-Type'
|
599
|
+
_header_content_type = ['application/json']
|
600
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
601
|
+
|
602
|
+
# form parameters
|
603
|
+
form_params = {}
|
604
|
+
|
605
|
+
# http body (model)
|
606
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
607
|
+
|
608
|
+
|
609
|
+
auth_names = ['PureCloud Auth']
|
610
|
+
data, status_code, headers = @api_client.call_api(:PUT, path,
|
611
|
+
:header_params => header_params,
|
612
|
+
:query_params => query_params,
|
613
|
+
:form_params => form_params,
|
614
|
+
:body => post_body,
|
615
|
+
:auth_names => auth_names,
|
616
|
+
:return_type => 'Response')
|
617
|
+
if @api_client.config.debugging
|
618
|
+
@api_client.config.logger.debug "API called: ResponseManagementApi#put_responses_response_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
619
|
+
end
|
620
|
+
return data, status_code, headers
|
621
|
+
end
|
622
|
+
|
623
|
+
# Delete an existing response.
|
624
|
+
# This will remove the response from any libraries associated with it.
|
625
|
+
# @param response_id Response ID
|
626
|
+
# @param [Hash] opts the optional parameters
|
627
|
+
# @return [nil]
|
628
|
+
def delete_responses_response_id(response_id, opts = {})
|
629
|
+
delete_responses_response_id_with_http_info(response_id, opts)
|
630
|
+
return nil
|
631
|
+
end
|
632
|
+
|
633
|
+
# Delete an existing response.
|
634
|
+
# This will remove the response from any libraries associated with it.
|
635
|
+
# @param response_id Response ID
|
636
|
+
# @param [Hash] opts the optional parameters
|
637
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
638
|
+
def delete_responses_response_id_with_http_info(response_id, opts = {})
|
639
|
+
if @api_client.config.debugging
|
640
|
+
@api_client.config.logger.debug "Calling API: ResponseManagementApi#delete_responses_response_id ..."
|
641
|
+
end
|
642
|
+
|
643
|
+
# verify the required parameter 'response_id' is set
|
644
|
+
fail "Missing the required parameter 'response_id' when calling delete_responses_response_id" if response_id.nil?
|
645
|
+
|
646
|
+
# resource path
|
647
|
+
path = "/api/v1/responsemanagement/responses/{responseId}".sub('{format}','json').sub('{' + 'responseId' + '}', response_id.to_s)
|
648
|
+
|
649
|
+
# query parameters
|
650
|
+
query_params = {}
|
651
|
+
|
652
|
+
# header parameters
|
653
|
+
header_params = {}
|
654
|
+
|
655
|
+
# HTTP header 'Accept' (if needed)
|
656
|
+
_header_accept = ['application/json']
|
657
|
+
_header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
|
658
|
+
|
659
|
+
# HTTP header 'Content-Type'
|
660
|
+
_header_content_type = ['application/json']
|
661
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
|
662
|
+
|
663
|
+
# form parameters
|
664
|
+
form_params = {}
|
665
|
+
|
666
|
+
# http body (model)
|
667
|
+
post_body = nil
|
668
|
+
|
669
|
+
|
670
|
+
auth_names = ['PureCloud Auth']
|
671
|
+
data, status_code, headers = @api_client.call_api(:DELETE, path,
|
672
|
+
:header_params => header_params,
|
673
|
+
:query_params => query_params,
|
674
|
+
:form_params => form_params,
|
675
|
+
:body => post_body,
|
676
|
+
:auth_names => auth_names)
|
677
|
+
if @api_client.config.debugging
|
678
|
+
@api_client.config.logger.debug "API called: ResponseManagementApi#delete_responses_response_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
679
|
+
end
|
680
|
+
return data, status_code, headers
|
681
|
+
end
|
682
|
+
end
|
683
|
+
end
|
684
|
+
|
685
|
+
|
686
|
+
|
687
|
+
|