purecloudplatformclientv2 15.0.0 → 16.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/Action.md +21 -0
- data/docs/ActionConfig.md +14 -0
- data/docs/ActionContract.md +14 -0
- data/docs/ActionContractInput.md +14 -0
- data/docs/ActionEntityListing.md +22 -0
- data/docs/ActionInput.md +15 -0
- data/docs/ActionOutput.md +18 -0
- data/docs/ActiveAlertCount.md +13 -0
- data/docs/AggregationQuery.md +1 -1
- data/docs/AlertingApi.md +54 -0
- data/docs/ArchitectApi.md +31 -25
- data/docs/CallConversationNotificationCallMediaParticipant.md +1 -0
- data/docs/CallConversationNotificationParticipants.md +1 -0
- data/docs/CallbackConversationNotificationCallbackMediaParticipant.md +1 -0
- data/docs/CallbackConversationNotificationParticipants.md +1 -0
- data/docs/Category.md +13 -0
- data/docs/CategoryEntityListing.md +17 -0
- data/docs/ChatConversationNotificationChatMediaParticipant.md +1 -0
- data/docs/ChatConversationNotificationParticipants.md +1 -0
- data/docs/CobrowseConversationNotificationCobrowseMediaParticipant.md +1 -0
- data/docs/CobrowseConversationNotificationParticipants.md +1 -0
- data/docs/ConversationNotificationCall.md +1 -0
- data/docs/ConversationNotificationCalls.md +1 -0
- data/docs/ConversationNotificationEmail.md +1 -0
- data/docs/ConversationNotificationEmails.md +1 -0
- data/docs/ConversationNotificationParticipant.md +1 -0
- data/docs/ConversationNotificationParticipants.md +1 -0
- data/docs/ConversationsApi.md +3 -3
- data/docs/Document.md +1 -1
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/DraftValidationResult.md +14 -0
- data/docs/EmailConversationNotificationEmailMediaParticipant.md +2 -0
- data/docs/EmailConversationNotificationParticipants.md +2 -0
- data/docs/FaxDocument.md +1 -1
- data/docs/IntegrationsApi.md +1355 -0
- data/docs/JsonNode.md +4 -4
- data/docs/ManagementUnit.md +1 -1
- data/docs/ManagementUnitListing.md +22 -0
- data/docs/OutboundApi.md +59 -0
- data/docs/PostActionInput.md +18 -0
- data/docs/PostInputContract.md +13 -0
- data/docs/PostOutputContract.md +13 -0
- data/docs/PublishDraftInput.md +13 -0
- data/docs/RecordingApi.md +123 -0
- data/docs/RequestConfig.md +17 -0
- data/docs/ResponseConfig.md +15 -0
- data/docs/ScreenShareConversationNotificationParticipants.md +1 -0
- data/docs/ScreenShareConversationNotificationScreenShareMediaParticipant.md +1 -0
- data/docs/SocialConversationNotificationParticipants.md +1 -0
- data/docs/SocialConversationNotificationSocialMediaParticipant.md +1 -0
- data/docs/TestExecutionOperationResult.md +17 -0
- data/docs/TestExecutionResult.md +16 -0
- data/docs/UpdateActionInput.md +16 -0
- data/docs/UpdateDraftInput.md +18 -0
- data/docs/VideoConversationNotificationParticipants.md +1 -0
- data/docs/VideoConversationNotificationVideoMediaParticipant.md +1 -0
- data/docs/WorkforceManagementApi.md +2 -4
- data/lib/purecloudplatformclientv2.rb +23 -1
- data/lib/purecloudplatformclientv2/api/alerting_api.rb +55 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +52 -20
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +2 -2
- data/lib/purecloudplatformclientv2/api/integrations_api.rb +1723 -0
- data/lib/purecloudplatformclientv2/api/outbound_api.rb +65 -0
- data/lib/purecloudplatformclientv2/api/recording_api.rb +140 -0
- data/lib/purecloudplatformclientv2/api/workforce_management_api.rb +3 -12
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/action.rb +409 -0
- data/lib/purecloudplatformclientv2/models/action_config.rb +229 -0
- data/lib/purecloudplatformclientv2/models/action_contract.rb +229 -0
- data/lib/purecloudplatformclientv2/models/action_contract_input.rb +239 -0
- data/lib/purecloudplatformclientv2/models/action_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/action_input.rb +255 -0
- data/lib/purecloudplatformclientv2/models/action_output.rb +333 -0
- data/lib/purecloudplatformclientv2/models/active_alert_count.rb +202 -0
- data/lib/purecloudplatformclientv2/models/aggregation_query.rb +1 -1
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_call_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/call_conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_callback_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/callback_conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/category.rb +203 -0
- data/lib/purecloudplatformclientv2/models/category_entity_listing.rb +303 -0
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_chat_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/chat_conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_cobrowse_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/cobrowse_conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/condition.rb +2 -2
- data/lib/purecloudplatformclientv2/models/conversation_notification_call.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_calls.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_email.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_emails.rb +26 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_participant.rb +40 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_participants.rb +40 -1
- data/lib/purecloudplatformclientv2/models/dependency.rb +2 -2
- data/lib/purecloudplatformclientv2/models/dependency_object.rb +2 -2
- data/lib/purecloudplatformclientv2/models/document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/draft_validation_result.rb +231 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_email_media_participant.rb +54 -4
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_participants.rb +54 -4
- data/lib/purecloudplatformclientv2/models/fax_document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/flow.rb +2 -2
- data/lib/purecloudplatformclientv2/models/interaction_stats_alert.rb +2 -2
- data/lib/purecloudplatformclientv2/models/interaction_stats_rule.rb +2 -2
- data/lib/purecloudplatformclientv2/models/json_node.rb +72 -72
- data/lib/purecloudplatformclientv2/models/management_unit.rb +7 -7
- data/lib/purecloudplatformclientv2/models/management_unit_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/post_action_input.rb +358 -0
- data/lib/purecloudplatformclientv2/models/post_input_contract.rb +208 -0
- data/lib/purecloudplatformclientv2/models/post_output_contract.rb +208 -0
- data/lib/purecloudplatformclientv2/models/publish_draft_input.rb +208 -0
- data/lib/purecloudplatformclientv2/models/request_config.rb +309 -0
- data/lib/purecloudplatformclientv2/models/response_config.rb +257 -0
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/screen_share_conversation_notification_screen_share_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/social_conversation_notification_social_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/models/test_execution_operation_result.rb +306 -0
- data/lib/purecloudplatformclientv2/models/test_execution_result.rb +282 -0
- data/lib/purecloudplatformclientv2/models/{publish_flow_notification_notification.rb → update_action_input.rb} +35 -26
- data/lib/purecloudplatformclientv2/models/update_draft_input.rb +338 -0
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_participants.rb +26 -1
- data/lib/purecloudplatformclientv2/models/video_conversation_notification_video_media_participant.rb +26 -1
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +91 -47
- data/docs/PublishFlowNotificationNotification.md +0 -16
@@ -4656,7 +4656,7 @@ module PureCloud
|
|
4656
4656
|
return data, status_code, headers
|
4657
4657
|
end
|
4658
4658
|
|
4659
|
-
#
|
4659
|
+
# Place a new call as part of a callback conversation.
|
4660
4660
|
#
|
4661
4661
|
# @param conversation_id conversationId
|
4662
4662
|
# @param body Conversation
|
@@ -4667,7 +4667,7 @@ module PureCloud
|
|
4667
4667
|
return data
|
4668
4668
|
end
|
4669
4669
|
|
4670
|
-
#
|
4670
|
+
# Place a new call as part of a callback conversation.
|
4671
4671
|
#
|
4672
4672
|
# @param conversation_id conversationId
|
4673
4673
|
# @param body Conversation
|
@@ -0,0 +1,1723 @@
|
|
1
|
+
=begin
|
2
|
+
PureCloud Platform API
|
3
|
+
|
4
|
+
With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
|
5
|
+
|
6
|
+
OpenAPI spec version: v2
|
7
|
+
Contact: DeveloperEvangelists@genesys.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
|
10
|
+
License: ININ
|
11
|
+
http://www.inin.com
|
12
|
+
|
13
|
+
Terms of Service: https://developer.mypurecloud.com/tos
|
14
|
+
|
15
|
+
=end
|
16
|
+
|
17
|
+
require "uri"
|
18
|
+
|
19
|
+
module PureCloud
|
20
|
+
class IntegrationsApi
|
21
|
+
attr_accessor :api_client
|
22
|
+
|
23
|
+
def initialize(api_client = ApiClient.default)
|
24
|
+
@api_client = api_client
|
25
|
+
end
|
26
|
+
|
27
|
+
# Delete an Action
|
28
|
+
#
|
29
|
+
# @param action_id actionId
|
30
|
+
# @param [Hash] opts the optional parameters
|
31
|
+
# @return [nil]
|
32
|
+
def delete_integrations_action(action_id, opts = {})
|
33
|
+
delete_integrations_action_with_http_info(action_id, opts)
|
34
|
+
return nil
|
35
|
+
end
|
36
|
+
|
37
|
+
# Delete an Action
|
38
|
+
#
|
39
|
+
# @param action_id actionId
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
42
|
+
def delete_integrations_action_with_http_info(action_id, opts = {})
|
43
|
+
if @api_client.config.debugging
|
44
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.delete_integrations_action ..."
|
45
|
+
end
|
46
|
+
|
47
|
+
|
48
|
+
# verify the required parameter 'action_id' is set
|
49
|
+
fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.delete_integrations_action" if action_id.nil?
|
50
|
+
|
51
|
+
|
52
|
+
|
53
|
+
|
54
|
+
|
55
|
+
# resource path
|
56
|
+
local_var_path = "/api/v2/integrations/actions/{actionId}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s)
|
57
|
+
|
58
|
+
# query parameters
|
59
|
+
query_params = {}
|
60
|
+
|
61
|
+
# header parameters
|
62
|
+
header_params = {}
|
63
|
+
|
64
|
+
# HTTP header 'Accept' (if needed)
|
65
|
+
local_header_accept = ['application/json']
|
66
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
67
|
+
|
68
|
+
# HTTP header 'Content-Type'
|
69
|
+
local_header_content_type = ['application/json']
|
70
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
71
|
+
|
72
|
+
# form parameters
|
73
|
+
form_params = {}
|
74
|
+
|
75
|
+
# http body (model)
|
76
|
+
post_body = nil
|
77
|
+
|
78
|
+
auth_names = ['PureCloud Auth']
|
79
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
80
|
+
:header_params => header_params,
|
81
|
+
:query_params => query_params,
|
82
|
+
:form_params => form_params,
|
83
|
+
:body => post_body,
|
84
|
+
:auth_names => auth_names)
|
85
|
+
if @api_client.config.debugging
|
86
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#delete_integrations_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
87
|
+
end
|
88
|
+
return data, status_code, headers
|
89
|
+
end
|
90
|
+
|
91
|
+
# Delete a Draft
|
92
|
+
#
|
93
|
+
# @param action_id actionId
|
94
|
+
# @param [Hash] opts the optional parameters
|
95
|
+
# @return [nil]
|
96
|
+
def delete_integrations_action_draft(action_id, opts = {})
|
97
|
+
delete_integrations_action_draft_with_http_info(action_id, opts)
|
98
|
+
return nil
|
99
|
+
end
|
100
|
+
|
101
|
+
# Delete a Draft
|
102
|
+
#
|
103
|
+
# @param action_id actionId
|
104
|
+
# @param [Hash] opts the optional parameters
|
105
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
106
|
+
def delete_integrations_action_draft_with_http_info(action_id, opts = {})
|
107
|
+
if @api_client.config.debugging
|
108
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.delete_integrations_action_draft ..."
|
109
|
+
end
|
110
|
+
|
111
|
+
|
112
|
+
# verify the required parameter 'action_id' is set
|
113
|
+
fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.delete_integrations_action_draft" if action_id.nil?
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
# resource path
|
120
|
+
local_var_path = "/api/v2/integrations/actions/{actionId}/draft".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s)
|
121
|
+
|
122
|
+
# query parameters
|
123
|
+
query_params = {}
|
124
|
+
|
125
|
+
# header parameters
|
126
|
+
header_params = {}
|
127
|
+
|
128
|
+
# HTTP header 'Accept' (if needed)
|
129
|
+
local_header_accept = ['application/json']
|
130
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
131
|
+
|
132
|
+
# HTTP header 'Content-Type'
|
133
|
+
local_header_content_type = ['application/json']
|
134
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
135
|
+
|
136
|
+
# form parameters
|
137
|
+
form_params = {}
|
138
|
+
|
139
|
+
# http body (model)
|
140
|
+
post_body = nil
|
141
|
+
|
142
|
+
auth_names = ['PureCloud Auth']
|
143
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
144
|
+
:header_params => header_params,
|
145
|
+
:query_params => query_params,
|
146
|
+
:form_params => form_params,
|
147
|
+
:body => post_body,
|
148
|
+
:auth_names => auth_names)
|
149
|
+
if @api_client.config.debugging
|
150
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#delete_integrations_action_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
151
|
+
end
|
152
|
+
return data, status_code, headers
|
153
|
+
end
|
154
|
+
|
155
|
+
# Retrieves a single Action matching id.
|
156
|
+
#
|
157
|
+
# @param action_id actionId
|
158
|
+
# @param [Hash] opts the optional parameters
|
159
|
+
# @option opts [String] :expand Indicates fields of the response which should be expanded.
|
160
|
+
# @option opts [BOOLEAN] :include_config Show config when available (default to false)
|
161
|
+
# @return [Action]
|
162
|
+
def get_integrations_action(action_id, opts = {})
|
163
|
+
data, _status_code, _headers = get_integrations_action_with_http_info(action_id, opts)
|
164
|
+
return data
|
165
|
+
end
|
166
|
+
|
167
|
+
# Retrieves a single Action matching id.
|
168
|
+
#
|
169
|
+
# @param action_id actionId
|
170
|
+
# @param [Hash] opts the optional parameters
|
171
|
+
# @option opts [String] :expand Indicates fields of the response which should be expanded.
|
172
|
+
# @option opts [BOOLEAN] :include_config Show config when available
|
173
|
+
# @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers
|
174
|
+
def get_integrations_action_with_http_info(action_id, opts = {})
|
175
|
+
if @api_client.config.debugging
|
176
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action ..."
|
177
|
+
end
|
178
|
+
|
179
|
+
|
180
|
+
# verify the required parameter 'action_id' is set
|
181
|
+
fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action" if action_id.nil?
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
if opts[:'expand'] && !['contract'].include?(opts[:'expand'])
|
191
|
+
fail ArgumentError, 'invalid value for "expand", must be one of contract'
|
192
|
+
end
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
# resource path
|
204
|
+
local_var_path = "/api/v2/integrations/actions/{actionId}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s)
|
205
|
+
|
206
|
+
# query parameters
|
207
|
+
query_params = {}
|
208
|
+
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
209
|
+
query_params[:'includeConfig'] = opts[:'include_config'] if opts[:'include_config']
|
210
|
+
|
211
|
+
# header parameters
|
212
|
+
header_params = {}
|
213
|
+
|
214
|
+
# HTTP header 'Accept' (if needed)
|
215
|
+
local_header_accept = ['application/json']
|
216
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
217
|
+
|
218
|
+
# HTTP header 'Content-Type'
|
219
|
+
local_header_content_type = ['application/json']
|
220
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
221
|
+
|
222
|
+
# form parameters
|
223
|
+
form_params = {}
|
224
|
+
|
225
|
+
# http body (model)
|
226
|
+
post_body = nil
|
227
|
+
|
228
|
+
auth_names = ['PureCloud Auth']
|
229
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
230
|
+
:header_params => header_params,
|
231
|
+
:query_params => query_params,
|
232
|
+
:form_params => form_params,
|
233
|
+
:body => post_body,
|
234
|
+
:auth_names => auth_names,
|
235
|
+
:return_type => 'Action')
|
236
|
+
if @api_client.config.debugging
|
237
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
238
|
+
end
|
239
|
+
return data, status_code, headers
|
240
|
+
end
|
241
|
+
|
242
|
+
# Retrieve a Draft
|
243
|
+
#
|
244
|
+
# @param action_id actionId
|
245
|
+
# @param [Hash] opts the optional parameters
|
246
|
+
# @option opts [String] :expand Indicates fields of the response which should be expanded.
|
247
|
+
# @option opts [BOOLEAN] :include_config Show config when available (default to false)
|
248
|
+
# @return [Action]
|
249
|
+
def get_integrations_action_draft(action_id, opts = {})
|
250
|
+
data, _status_code, _headers = get_integrations_action_draft_with_http_info(action_id, opts)
|
251
|
+
return data
|
252
|
+
end
|
253
|
+
|
254
|
+
# Retrieve a Draft
|
255
|
+
#
|
256
|
+
# @param action_id actionId
|
257
|
+
# @param [Hash] opts the optional parameters
|
258
|
+
# @option opts [String] :expand Indicates fields of the response which should be expanded.
|
259
|
+
# @option opts [BOOLEAN] :include_config Show config when available
|
260
|
+
# @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers
|
261
|
+
def get_integrations_action_draft_with_http_info(action_id, opts = {})
|
262
|
+
if @api_client.config.debugging
|
263
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_draft ..."
|
264
|
+
end
|
265
|
+
|
266
|
+
|
267
|
+
# verify the required parameter 'action_id' is set
|
268
|
+
fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_draft" if action_id.nil?
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
if opts[:'expand'] && !['contract'].include?(opts[:'expand'])
|
278
|
+
fail ArgumentError, 'invalid value for "expand", must be one of contract'
|
279
|
+
end
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
# resource path
|
291
|
+
local_var_path = "/api/v2/integrations/actions/{actionId}/draft".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s)
|
292
|
+
|
293
|
+
# query parameters
|
294
|
+
query_params = {}
|
295
|
+
query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
|
296
|
+
query_params[:'includeConfig'] = opts[:'include_config'] if opts[:'include_config']
|
297
|
+
|
298
|
+
# header parameters
|
299
|
+
header_params = {}
|
300
|
+
|
301
|
+
# HTTP header 'Accept' (if needed)
|
302
|
+
local_header_accept = ['application/json']
|
303
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
304
|
+
|
305
|
+
# HTTP header 'Content-Type'
|
306
|
+
local_header_content_type = ['application/json']
|
307
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
308
|
+
|
309
|
+
# form parameters
|
310
|
+
form_params = {}
|
311
|
+
|
312
|
+
# http body (model)
|
313
|
+
post_body = nil
|
314
|
+
|
315
|
+
auth_names = ['PureCloud Auth']
|
316
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
317
|
+
:header_params => header_params,
|
318
|
+
:query_params => query_params,
|
319
|
+
:form_params => form_params,
|
320
|
+
:body => post_body,
|
321
|
+
:auth_names => auth_names,
|
322
|
+
:return_type => 'Action')
|
323
|
+
if @api_client.config.debugging
|
324
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
325
|
+
end
|
326
|
+
return data, status_code, headers
|
327
|
+
end
|
328
|
+
|
329
|
+
# Retrieve schema for a Draft based on filename.
|
330
|
+
#
|
331
|
+
# @param action_id actionId
|
332
|
+
# @param file_name Name of schema file to be retrieved for this draft.
|
333
|
+
# @param [Hash] opts the optional parameters
|
334
|
+
# @return [JsonSchemaDocument]
|
335
|
+
def get_integrations_action_draft_schema(action_id, file_name, opts = {})
|
336
|
+
data, _status_code, _headers = get_integrations_action_draft_schema_with_http_info(action_id, file_name, opts)
|
337
|
+
return data
|
338
|
+
end
|
339
|
+
|
340
|
+
# Retrieve schema for a Draft based on filename.
|
341
|
+
#
|
342
|
+
# @param action_id actionId
|
343
|
+
# @param file_name Name of schema file to be retrieved for this draft.
|
344
|
+
# @param [Hash] opts the optional parameters
|
345
|
+
# @return [Array<(JsonSchemaDocument, Fixnum, Hash)>] JsonSchemaDocument data, response status code and response headers
|
346
|
+
def get_integrations_action_draft_schema_with_http_info(action_id, file_name, opts = {})
|
347
|
+
if @api_client.config.debugging
|
348
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_draft_schema ..."
|
349
|
+
end
|
350
|
+
|
351
|
+
|
352
|
+
# verify the required parameter 'action_id' is set
|
353
|
+
fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_draft_schema" if action_id.nil?
|
354
|
+
|
355
|
+
|
356
|
+
|
357
|
+
|
358
|
+
|
359
|
+
|
360
|
+
# verify the required parameter 'file_name' is set
|
361
|
+
fail ArgumentError, "Missing the required parameter 'file_name' when calling IntegrationsApi.get_integrations_action_draft_schema" if file_name.nil?
|
362
|
+
|
363
|
+
|
364
|
+
|
365
|
+
|
366
|
+
|
367
|
+
# resource path
|
368
|
+
local_var_path = "/api/v2/integrations/actions/{actionId}/draft/schemas/{fileName}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s).sub('{' + 'fileName' + '}', file_name.to_s)
|
369
|
+
|
370
|
+
# query parameters
|
371
|
+
query_params = {}
|
372
|
+
|
373
|
+
# header parameters
|
374
|
+
header_params = {}
|
375
|
+
|
376
|
+
# HTTP header 'Accept' (if needed)
|
377
|
+
local_header_accept = ['application/json']
|
378
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
379
|
+
|
380
|
+
# HTTP header 'Content-Type'
|
381
|
+
local_header_content_type = ['application/json']
|
382
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
383
|
+
|
384
|
+
# form parameters
|
385
|
+
form_params = {}
|
386
|
+
|
387
|
+
# http body (model)
|
388
|
+
post_body = nil
|
389
|
+
|
390
|
+
auth_names = ['PureCloud Auth']
|
391
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
392
|
+
:header_params => header_params,
|
393
|
+
:query_params => query_params,
|
394
|
+
:form_params => form_params,
|
395
|
+
:body => post_body,
|
396
|
+
:auth_names => auth_names,
|
397
|
+
:return_type => 'JsonSchemaDocument')
|
398
|
+
if @api_client.config.debugging
|
399
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_draft_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
400
|
+
end
|
401
|
+
return data, status_code, headers
|
402
|
+
end
|
403
|
+
|
404
|
+
# Retrieve templates for a Draft based on filename.
|
405
|
+
#
|
406
|
+
# @param action_id actionId
|
407
|
+
# @param file_name Name of template file to be retrieved for this action draft.
|
408
|
+
# @param [Hash] opts the optional parameters
|
409
|
+
# @return [String]
|
410
|
+
def get_integrations_action_draft_template(action_id, file_name, opts = {})
|
411
|
+
data, _status_code, _headers = get_integrations_action_draft_template_with_http_info(action_id, file_name, opts)
|
412
|
+
return data
|
413
|
+
end
|
414
|
+
|
415
|
+
# Retrieve templates for a Draft based on filename.
|
416
|
+
#
|
417
|
+
# @param action_id actionId
|
418
|
+
# @param file_name Name of template file to be retrieved for this action draft.
|
419
|
+
# @param [Hash] opts the optional parameters
|
420
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
421
|
+
def get_integrations_action_draft_template_with_http_info(action_id, file_name, opts = {})
|
422
|
+
if @api_client.config.debugging
|
423
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_draft_template ..."
|
424
|
+
end
|
425
|
+
|
426
|
+
|
427
|
+
# verify the required parameter 'action_id' is set
|
428
|
+
fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_draft_template" if action_id.nil?
|
429
|
+
|
430
|
+
|
431
|
+
|
432
|
+
|
433
|
+
|
434
|
+
|
435
|
+
# verify the required parameter 'file_name' is set
|
436
|
+
fail ArgumentError, "Missing the required parameter 'file_name' when calling IntegrationsApi.get_integrations_action_draft_template" if file_name.nil?
|
437
|
+
|
438
|
+
|
439
|
+
|
440
|
+
|
441
|
+
|
442
|
+
# resource path
|
443
|
+
local_var_path = "/api/v2/integrations/actions/{actionId}/draft/templates/{fileName}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s).sub('{' + 'fileName' + '}', file_name.to_s)
|
444
|
+
|
445
|
+
# query parameters
|
446
|
+
query_params = {}
|
447
|
+
|
448
|
+
# header parameters
|
449
|
+
header_params = {}
|
450
|
+
|
451
|
+
# HTTP header 'Accept' (if needed)
|
452
|
+
local_header_accept = ['text/plain']
|
453
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
454
|
+
|
455
|
+
# HTTP header 'Content-Type'
|
456
|
+
local_header_content_type = ['application/json']
|
457
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
458
|
+
|
459
|
+
# form parameters
|
460
|
+
form_params = {}
|
461
|
+
|
462
|
+
# http body (model)
|
463
|
+
post_body = nil
|
464
|
+
|
465
|
+
auth_names = ['PureCloud Auth']
|
466
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
467
|
+
:header_params => header_params,
|
468
|
+
:query_params => query_params,
|
469
|
+
:form_params => form_params,
|
470
|
+
:body => post_body,
|
471
|
+
:auth_names => auth_names,
|
472
|
+
:return_type => 'String')
|
473
|
+
if @api_client.config.debugging
|
474
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_draft_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
475
|
+
end
|
476
|
+
return data, status_code, headers
|
477
|
+
end
|
478
|
+
|
479
|
+
# Validate current Draft configuration.
|
480
|
+
#
|
481
|
+
# @param action_id actionId
|
482
|
+
# @param [Hash] opts the optional parameters
|
483
|
+
# @return [DraftValidationResult]
|
484
|
+
def get_integrations_action_draft_validation(action_id, opts = {})
|
485
|
+
data, _status_code, _headers = get_integrations_action_draft_validation_with_http_info(action_id, opts)
|
486
|
+
return data
|
487
|
+
end
|
488
|
+
|
489
|
+
# Validate current Draft configuration.
|
490
|
+
#
|
491
|
+
# @param action_id actionId
|
492
|
+
# @param [Hash] opts the optional parameters
|
493
|
+
# @return [Array<(DraftValidationResult, Fixnum, Hash)>] DraftValidationResult data, response status code and response headers
|
494
|
+
def get_integrations_action_draft_validation_with_http_info(action_id, opts = {})
|
495
|
+
if @api_client.config.debugging
|
496
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_draft_validation ..."
|
497
|
+
end
|
498
|
+
|
499
|
+
|
500
|
+
# verify the required parameter 'action_id' is set
|
501
|
+
fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_draft_validation" if action_id.nil?
|
502
|
+
|
503
|
+
|
504
|
+
|
505
|
+
|
506
|
+
|
507
|
+
# resource path
|
508
|
+
local_var_path = "/api/v2/integrations/actions/{actionId}/draft/validation".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s)
|
509
|
+
|
510
|
+
# query parameters
|
511
|
+
query_params = {}
|
512
|
+
|
513
|
+
# header parameters
|
514
|
+
header_params = {}
|
515
|
+
|
516
|
+
# HTTP header 'Accept' (if needed)
|
517
|
+
local_header_accept = ['application/json']
|
518
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
519
|
+
|
520
|
+
# HTTP header 'Content-Type'
|
521
|
+
local_header_content_type = ['application/json']
|
522
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
523
|
+
|
524
|
+
# form parameters
|
525
|
+
form_params = {}
|
526
|
+
|
527
|
+
# http body (model)
|
528
|
+
post_body = nil
|
529
|
+
|
530
|
+
auth_names = ['PureCloud Auth']
|
531
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
532
|
+
:header_params => header_params,
|
533
|
+
:query_params => query_params,
|
534
|
+
:form_params => form_params,
|
535
|
+
:body => post_body,
|
536
|
+
:auth_names => auth_names,
|
537
|
+
:return_type => 'DraftValidationResult')
|
538
|
+
if @api_client.config.debugging
|
539
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_draft_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
540
|
+
end
|
541
|
+
return data, status_code, headers
|
542
|
+
end
|
543
|
+
|
544
|
+
# Retrieve schema for an action based on filename.
|
545
|
+
#
|
546
|
+
# @param action_id actionId
|
547
|
+
# @param file_name Name of schema file to be retrieved for this action.
|
548
|
+
# @param [Hash] opts the optional parameters
|
549
|
+
# @return [JsonSchemaDocument]
|
550
|
+
def get_integrations_action_schema(action_id, file_name, opts = {})
|
551
|
+
data, _status_code, _headers = get_integrations_action_schema_with_http_info(action_id, file_name, opts)
|
552
|
+
return data
|
553
|
+
end
|
554
|
+
|
555
|
+
# Retrieve schema for an action based on filename.
|
556
|
+
#
|
557
|
+
# @param action_id actionId
|
558
|
+
# @param file_name Name of schema file to be retrieved for this action.
|
559
|
+
# @param [Hash] opts the optional parameters
|
560
|
+
# @return [Array<(JsonSchemaDocument, Fixnum, Hash)>] JsonSchemaDocument data, response status code and response headers
|
561
|
+
def get_integrations_action_schema_with_http_info(action_id, file_name, opts = {})
|
562
|
+
if @api_client.config.debugging
|
563
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_schema ..."
|
564
|
+
end
|
565
|
+
|
566
|
+
|
567
|
+
# verify the required parameter 'action_id' is set
|
568
|
+
fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_schema" if action_id.nil?
|
569
|
+
|
570
|
+
|
571
|
+
|
572
|
+
|
573
|
+
|
574
|
+
|
575
|
+
# verify the required parameter 'file_name' is set
|
576
|
+
fail ArgumentError, "Missing the required parameter 'file_name' when calling IntegrationsApi.get_integrations_action_schema" if file_name.nil?
|
577
|
+
|
578
|
+
|
579
|
+
|
580
|
+
|
581
|
+
|
582
|
+
# resource path
|
583
|
+
local_var_path = "/api/v2/integrations/actions/{actionId}/schemas/{fileName}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s).sub('{' + 'fileName' + '}', file_name.to_s)
|
584
|
+
|
585
|
+
# query parameters
|
586
|
+
query_params = {}
|
587
|
+
|
588
|
+
# header parameters
|
589
|
+
header_params = {}
|
590
|
+
|
591
|
+
# HTTP header 'Accept' (if needed)
|
592
|
+
local_header_accept = ['application/json']
|
593
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
594
|
+
|
595
|
+
# HTTP header 'Content-Type'
|
596
|
+
local_header_content_type = ['application/json']
|
597
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
598
|
+
|
599
|
+
# form parameters
|
600
|
+
form_params = {}
|
601
|
+
|
602
|
+
# http body (model)
|
603
|
+
post_body = nil
|
604
|
+
|
605
|
+
auth_names = ['PureCloud Auth']
|
606
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
607
|
+
:header_params => header_params,
|
608
|
+
:query_params => query_params,
|
609
|
+
:form_params => form_params,
|
610
|
+
:body => post_body,
|
611
|
+
:auth_names => auth_names,
|
612
|
+
:return_type => 'JsonSchemaDocument')
|
613
|
+
if @api_client.config.debugging
|
614
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
615
|
+
end
|
616
|
+
return data, status_code, headers
|
617
|
+
end
|
618
|
+
|
619
|
+
# Retrieve text of templates for an action based on filename.
|
620
|
+
#
|
621
|
+
# @param action_id actionId
|
622
|
+
# @param file_name Name of template file to be retrieved for this action.
|
623
|
+
# @param [Hash] opts the optional parameters
|
624
|
+
# @return [String]
|
625
|
+
def get_integrations_action_template(action_id, file_name, opts = {})
|
626
|
+
data, _status_code, _headers = get_integrations_action_template_with_http_info(action_id, file_name, opts)
|
627
|
+
return data
|
628
|
+
end
|
629
|
+
|
630
|
+
# Retrieve text of templates for an action based on filename.
|
631
|
+
#
|
632
|
+
# @param action_id actionId
|
633
|
+
# @param file_name Name of template file to be retrieved for this action.
|
634
|
+
# @param [Hash] opts the optional parameters
|
635
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
636
|
+
def get_integrations_action_template_with_http_info(action_id, file_name, opts = {})
|
637
|
+
if @api_client.config.debugging
|
638
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_action_template ..."
|
639
|
+
end
|
640
|
+
|
641
|
+
|
642
|
+
# verify the required parameter 'action_id' is set
|
643
|
+
fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.get_integrations_action_template" if action_id.nil?
|
644
|
+
|
645
|
+
|
646
|
+
|
647
|
+
|
648
|
+
|
649
|
+
|
650
|
+
# verify the required parameter 'file_name' is set
|
651
|
+
fail ArgumentError, "Missing the required parameter 'file_name' when calling IntegrationsApi.get_integrations_action_template" if file_name.nil?
|
652
|
+
|
653
|
+
|
654
|
+
|
655
|
+
|
656
|
+
|
657
|
+
# resource path
|
658
|
+
local_var_path = "/api/v2/integrations/actions/{actionId}/templates/{fileName}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s).sub('{' + 'fileName' + '}', file_name.to_s)
|
659
|
+
|
660
|
+
# query parameters
|
661
|
+
query_params = {}
|
662
|
+
|
663
|
+
# header parameters
|
664
|
+
header_params = {}
|
665
|
+
|
666
|
+
# HTTP header 'Accept' (if needed)
|
667
|
+
local_header_accept = ['text/plain']
|
668
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
669
|
+
|
670
|
+
# HTTP header 'Content-Type'
|
671
|
+
local_header_content_type = ['application/json']
|
672
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
673
|
+
|
674
|
+
# form parameters
|
675
|
+
form_params = {}
|
676
|
+
|
677
|
+
# http body (model)
|
678
|
+
post_body = nil
|
679
|
+
|
680
|
+
auth_names = ['PureCloud Auth']
|
681
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
682
|
+
:header_params => header_params,
|
683
|
+
:query_params => query_params,
|
684
|
+
:form_params => form_params,
|
685
|
+
:body => post_body,
|
686
|
+
:auth_names => auth_names,
|
687
|
+
:return_type => 'String')
|
688
|
+
if @api_client.config.debugging
|
689
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_action_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
690
|
+
end
|
691
|
+
return data, status_code, headers
|
692
|
+
end
|
693
|
+
|
694
|
+
# Retrieves all actions associated with filters passed in via query param.
|
695
|
+
#
|
696
|
+
# @param [Hash] opts the optional parameters
|
697
|
+
# @option opts [String] :category Filter by category name
|
698
|
+
# @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
|
699
|
+
# @option opts [Integer] :page_size The total page size requested (default to 25)
|
700
|
+
# @option opts [Integer] :page_number The page number requested (default to 1)
|
701
|
+
# @option opts [String] :sort_by variable name requested to sort by
|
702
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
703
|
+
# @option opts [String] :next_page next page token
|
704
|
+
# @option opts [String] :previous_page Previous page token
|
705
|
+
# @return [ActionEntityListing]
|
706
|
+
def get_integrations_actions(opts = {})
|
707
|
+
data, _status_code, _headers = get_integrations_actions_with_http_info(opts)
|
708
|
+
return data
|
709
|
+
end
|
710
|
+
|
711
|
+
# Retrieves all actions associated with filters passed in via query param.
|
712
|
+
#
|
713
|
+
# @param [Hash] opts the optional parameters
|
714
|
+
# @option opts [String] :category Filter by category name
|
715
|
+
# @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
|
716
|
+
# @option opts [Integer] :page_size The total page size requested
|
717
|
+
# @option opts [Integer] :page_number The page number requested
|
718
|
+
# @option opts [String] :sort_by variable name requested to sort by
|
719
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
720
|
+
# @option opts [String] :next_page next page token
|
721
|
+
# @option opts [String] :previous_page Previous page token
|
722
|
+
# @return [Array<(ActionEntityListing, Fixnum, Hash)>] ActionEntityListing data, response status code and response headers
|
723
|
+
def get_integrations_actions_with_http_info(opts = {})
|
724
|
+
if @api_client.config.debugging
|
725
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_actions ..."
|
726
|
+
end
|
727
|
+
|
728
|
+
|
729
|
+
|
730
|
+
|
731
|
+
|
732
|
+
|
733
|
+
|
734
|
+
|
735
|
+
|
736
|
+
|
737
|
+
if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
|
738
|
+
fail ArgumentError, 'invalid value for "secure", must be one of true, false'
|
739
|
+
end
|
740
|
+
|
741
|
+
|
742
|
+
|
743
|
+
|
744
|
+
|
745
|
+
|
746
|
+
|
747
|
+
|
748
|
+
|
749
|
+
|
750
|
+
|
751
|
+
|
752
|
+
|
753
|
+
|
754
|
+
|
755
|
+
|
756
|
+
|
757
|
+
|
758
|
+
|
759
|
+
|
760
|
+
|
761
|
+
|
762
|
+
|
763
|
+
|
764
|
+
|
765
|
+
|
766
|
+
|
767
|
+
|
768
|
+
|
769
|
+
|
770
|
+
|
771
|
+
|
772
|
+
|
773
|
+
|
774
|
+
|
775
|
+
|
776
|
+
|
777
|
+
|
778
|
+
|
779
|
+
|
780
|
+
# resource path
|
781
|
+
local_var_path = "/api/v2/integrations/actions".sub('{format}','json')
|
782
|
+
|
783
|
+
# query parameters
|
784
|
+
query_params = {}
|
785
|
+
query_params[:'category'] = opts[:'category'] if opts[:'category']
|
786
|
+
query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
|
787
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
788
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
789
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
790
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
791
|
+
query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
|
792
|
+
query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
|
793
|
+
|
794
|
+
# header parameters
|
795
|
+
header_params = {}
|
796
|
+
|
797
|
+
# HTTP header 'Accept' (if needed)
|
798
|
+
local_header_accept = ['application/json']
|
799
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
800
|
+
|
801
|
+
# HTTP header 'Content-Type'
|
802
|
+
local_header_content_type = ['application/json']
|
803
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
804
|
+
|
805
|
+
# form parameters
|
806
|
+
form_params = {}
|
807
|
+
|
808
|
+
# http body (model)
|
809
|
+
post_body = nil
|
810
|
+
|
811
|
+
auth_names = ['PureCloud Auth']
|
812
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
813
|
+
:header_params => header_params,
|
814
|
+
:query_params => query_params,
|
815
|
+
:form_params => form_params,
|
816
|
+
:body => post_body,
|
817
|
+
:auth_names => auth_names,
|
818
|
+
:return_type => 'ActionEntityListing')
|
819
|
+
if @api_client.config.debugging
|
820
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_actions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
821
|
+
end
|
822
|
+
return data, status_code, headers
|
823
|
+
end
|
824
|
+
|
825
|
+
# Retrieves all categories of available Actions
|
826
|
+
#
|
827
|
+
# @param [Hash] opts the optional parameters
|
828
|
+
# @option opts [String] :secure Filter to only include/exclude Action categories based on if they are considered secure. True will only include categories with Actions marked secured. False will only include categories of unsecured Actions.
|
829
|
+
# @option opts [Integer] :page_size The total page size requested (default to 25)
|
830
|
+
# @option opts [Integer] :page_number The page number requested (default to 1)
|
831
|
+
# @option opts [String] :sort_by variable name requested to sort by
|
832
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
833
|
+
# @option opts [String] :next_page next page token
|
834
|
+
# @option opts [String] :previous_page Previous page token
|
835
|
+
# @return [CategoryEntityListing]
|
836
|
+
def get_integrations_actions_categories(opts = {})
|
837
|
+
data, _status_code, _headers = get_integrations_actions_categories_with_http_info(opts)
|
838
|
+
return data
|
839
|
+
end
|
840
|
+
|
841
|
+
# Retrieves all categories of available Actions
|
842
|
+
#
|
843
|
+
# @param [Hash] opts the optional parameters
|
844
|
+
# @option opts [String] :secure Filter to only include/exclude Action categories based on if they are considered secure. True will only include categories with Actions marked secured. False will only include categories of unsecured Actions.
|
845
|
+
# @option opts [Integer] :page_size The total page size requested
|
846
|
+
# @option opts [Integer] :page_number The page number requested
|
847
|
+
# @option opts [String] :sort_by variable name requested to sort by
|
848
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
849
|
+
# @option opts [String] :next_page next page token
|
850
|
+
# @option opts [String] :previous_page Previous page token
|
851
|
+
# @return [Array<(CategoryEntityListing, Fixnum, Hash)>] CategoryEntityListing data, response status code and response headers
|
852
|
+
def get_integrations_actions_categories_with_http_info(opts = {})
|
853
|
+
if @api_client.config.debugging
|
854
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_actions_categories ..."
|
855
|
+
end
|
856
|
+
|
857
|
+
|
858
|
+
|
859
|
+
|
860
|
+
if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
|
861
|
+
fail ArgumentError, 'invalid value for "secure", must be one of true, false'
|
862
|
+
end
|
863
|
+
|
864
|
+
|
865
|
+
|
866
|
+
|
867
|
+
|
868
|
+
|
869
|
+
|
870
|
+
|
871
|
+
|
872
|
+
|
873
|
+
|
874
|
+
|
875
|
+
|
876
|
+
|
877
|
+
|
878
|
+
|
879
|
+
|
880
|
+
|
881
|
+
|
882
|
+
|
883
|
+
|
884
|
+
|
885
|
+
|
886
|
+
|
887
|
+
|
888
|
+
|
889
|
+
|
890
|
+
|
891
|
+
|
892
|
+
|
893
|
+
|
894
|
+
|
895
|
+
|
896
|
+
|
897
|
+
|
898
|
+
|
899
|
+
|
900
|
+
|
901
|
+
|
902
|
+
|
903
|
+
# resource path
|
904
|
+
local_var_path = "/api/v2/integrations/actions/categories".sub('{format}','json')
|
905
|
+
|
906
|
+
# query parameters
|
907
|
+
query_params = {}
|
908
|
+
query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
|
909
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
910
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
911
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
912
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
913
|
+
query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
|
914
|
+
query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
|
915
|
+
|
916
|
+
# header parameters
|
917
|
+
header_params = {}
|
918
|
+
|
919
|
+
# HTTP header 'Accept' (if needed)
|
920
|
+
local_header_accept = ['application/json']
|
921
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
922
|
+
|
923
|
+
# HTTP header 'Content-Type'
|
924
|
+
local_header_content_type = ['application/json']
|
925
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
926
|
+
|
927
|
+
# form parameters
|
928
|
+
form_params = {}
|
929
|
+
|
930
|
+
# http body (model)
|
931
|
+
post_body = nil
|
932
|
+
|
933
|
+
auth_names = ['PureCloud Auth']
|
934
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
935
|
+
:header_params => header_params,
|
936
|
+
:query_params => query_params,
|
937
|
+
:form_params => form_params,
|
938
|
+
:body => post_body,
|
939
|
+
:auth_names => auth_names,
|
940
|
+
:return_type => 'CategoryEntityListing')
|
941
|
+
if @api_client.config.debugging
|
942
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_actions_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
943
|
+
end
|
944
|
+
return data, status_code, headers
|
945
|
+
end
|
946
|
+
|
947
|
+
# Retrieves all action drafts associated with the filters passed in via query param.
|
948
|
+
#
|
949
|
+
# @param [Hash] opts the optional parameters
|
950
|
+
# @option opts [String] :category Filter by category name
|
951
|
+
# @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
|
952
|
+
# @option opts [Integer] :page_size The total page size requested (default to 25)
|
953
|
+
# @option opts [Integer] :page_number The page number requested (default to 1)
|
954
|
+
# @option opts [String] :sort_by variable name requested to sort by
|
955
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
956
|
+
# @option opts [String] :next_page next page token
|
957
|
+
# @option opts [String] :previous_page Previous page token
|
958
|
+
# @return [ActionEntityListing]
|
959
|
+
def get_integrations_actions_drafts(opts = {})
|
960
|
+
data, _status_code, _headers = get_integrations_actions_drafts_with_http_info(opts)
|
961
|
+
return data
|
962
|
+
end
|
963
|
+
|
964
|
+
# Retrieves all action drafts associated with the filters passed in via query param.
|
965
|
+
#
|
966
|
+
# @param [Hash] opts the optional parameters
|
967
|
+
# @option opts [String] :category Filter by category name
|
968
|
+
# @option opts [String] :secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
|
969
|
+
# @option opts [Integer] :page_size The total page size requested
|
970
|
+
# @option opts [Integer] :page_number The page number requested
|
971
|
+
# @option opts [String] :sort_by variable name requested to sort by
|
972
|
+
# @option opts [Array<Object>] :expand variable name requested by expand list
|
973
|
+
# @option opts [String] :next_page next page token
|
974
|
+
# @option opts [String] :previous_page Previous page token
|
975
|
+
# @return [Array<(ActionEntityListing, Fixnum, Hash)>] ActionEntityListing data, response status code and response headers
|
976
|
+
def get_integrations_actions_drafts_with_http_info(opts = {})
|
977
|
+
if @api_client.config.debugging
|
978
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.get_integrations_actions_drafts ..."
|
979
|
+
end
|
980
|
+
|
981
|
+
|
982
|
+
|
983
|
+
|
984
|
+
|
985
|
+
|
986
|
+
|
987
|
+
|
988
|
+
|
989
|
+
|
990
|
+
if opts[:'secure'] && !['true', 'false'].include?(opts[:'secure'])
|
991
|
+
fail ArgumentError, 'invalid value for "secure", must be one of true, false'
|
992
|
+
end
|
993
|
+
|
994
|
+
|
995
|
+
|
996
|
+
|
997
|
+
|
998
|
+
|
999
|
+
|
1000
|
+
|
1001
|
+
|
1002
|
+
|
1003
|
+
|
1004
|
+
|
1005
|
+
|
1006
|
+
|
1007
|
+
|
1008
|
+
|
1009
|
+
|
1010
|
+
|
1011
|
+
|
1012
|
+
|
1013
|
+
|
1014
|
+
|
1015
|
+
|
1016
|
+
|
1017
|
+
|
1018
|
+
|
1019
|
+
|
1020
|
+
|
1021
|
+
|
1022
|
+
|
1023
|
+
|
1024
|
+
|
1025
|
+
|
1026
|
+
|
1027
|
+
|
1028
|
+
|
1029
|
+
|
1030
|
+
|
1031
|
+
|
1032
|
+
|
1033
|
+
# resource path
|
1034
|
+
local_var_path = "/api/v2/integrations/actions/drafts".sub('{format}','json')
|
1035
|
+
|
1036
|
+
# query parameters
|
1037
|
+
query_params = {}
|
1038
|
+
query_params[:'category'] = opts[:'category'] if opts[:'category']
|
1039
|
+
query_params[:'secure'] = opts[:'secure'] if opts[:'secure']
|
1040
|
+
query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
|
1041
|
+
query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
|
1042
|
+
query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
|
1043
|
+
query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
|
1044
|
+
query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
|
1045
|
+
query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
|
1046
|
+
|
1047
|
+
# header parameters
|
1048
|
+
header_params = {}
|
1049
|
+
|
1050
|
+
# HTTP header 'Accept' (if needed)
|
1051
|
+
local_header_accept = ['application/json']
|
1052
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1053
|
+
|
1054
|
+
# HTTP header 'Content-Type'
|
1055
|
+
local_header_content_type = ['application/json']
|
1056
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1057
|
+
|
1058
|
+
# form parameters
|
1059
|
+
form_params = {}
|
1060
|
+
|
1061
|
+
# http body (model)
|
1062
|
+
post_body = nil
|
1063
|
+
|
1064
|
+
auth_names = ['PureCloud Auth']
|
1065
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1066
|
+
:header_params => header_params,
|
1067
|
+
:query_params => query_params,
|
1068
|
+
:form_params => form_params,
|
1069
|
+
:body => post_body,
|
1070
|
+
:auth_names => auth_names,
|
1071
|
+
:return_type => 'ActionEntityListing')
|
1072
|
+
if @api_client.config.debugging
|
1073
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#get_integrations_actions_drafts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1074
|
+
end
|
1075
|
+
return data, status_code, headers
|
1076
|
+
end
|
1077
|
+
|
1078
|
+
# Patch an Action
|
1079
|
+
#
|
1080
|
+
# @param action_id actionId
|
1081
|
+
# @param body Input used to patch the Action.
|
1082
|
+
# @param [Hash] opts the optional parameters
|
1083
|
+
# @return [Action]
|
1084
|
+
def patch_integrations_action(action_id, body, opts = {})
|
1085
|
+
data, _status_code, _headers = patch_integrations_action_with_http_info(action_id, body, opts)
|
1086
|
+
return data
|
1087
|
+
end
|
1088
|
+
|
1089
|
+
# Patch an Action
|
1090
|
+
#
|
1091
|
+
# @param action_id actionId
|
1092
|
+
# @param body Input used to patch the Action.
|
1093
|
+
# @param [Hash] opts the optional parameters
|
1094
|
+
# @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers
|
1095
|
+
def patch_integrations_action_with_http_info(action_id, body, opts = {})
|
1096
|
+
if @api_client.config.debugging
|
1097
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.patch_integrations_action ..."
|
1098
|
+
end
|
1099
|
+
|
1100
|
+
|
1101
|
+
# verify the required parameter 'action_id' is set
|
1102
|
+
fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.patch_integrations_action" if action_id.nil?
|
1103
|
+
|
1104
|
+
|
1105
|
+
|
1106
|
+
|
1107
|
+
|
1108
|
+
|
1109
|
+
# verify the required parameter 'body' is set
|
1110
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.patch_integrations_action" if body.nil?
|
1111
|
+
|
1112
|
+
|
1113
|
+
|
1114
|
+
|
1115
|
+
|
1116
|
+
# resource path
|
1117
|
+
local_var_path = "/api/v2/integrations/actions/{actionId}".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s)
|
1118
|
+
|
1119
|
+
# query parameters
|
1120
|
+
query_params = {}
|
1121
|
+
|
1122
|
+
# header parameters
|
1123
|
+
header_params = {}
|
1124
|
+
|
1125
|
+
# HTTP header 'Accept' (if needed)
|
1126
|
+
local_header_accept = ['application/json']
|
1127
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1128
|
+
|
1129
|
+
# HTTP header 'Content-Type'
|
1130
|
+
local_header_content_type = ['application/json']
|
1131
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1132
|
+
|
1133
|
+
# form parameters
|
1134
|
+
form_params = {}
|
1135
|
+
|
1136
|
+
# http body (model)
|
1137
|
+
post_body = @api_client.object_to_http_body(body)
|
1138
|
+
|
1139
|
+
auth_names = ['PureCloud Auth']
|
1140
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
1141
|
+
:header_params => header_params,
|
1142
|
+
:query_params => query_params,
|
1143
|
+
:form_params => form_params,
|
1144
|
+
:body => post_body,
|
1145
|
+
:auth_names => auth_names,
|
1146
|
+
:return_type => 'Action')
|
1147
|
+
if @api_client.config.debugging
|
1148
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#patch_integrations_action\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1149
|
+
end
|
1150
|
+
return data, status_code, headers
|
1151
|
+
end
|
1152
|
+
|
1153
|
+
# Update an existing Draft
|
1154
|
+
#
|
1155
|
+
# @param action_id actionId
|
1156
|
+
# @param body Input used to patch the Action Draft.
|
1157
|
+
# @param [Hash] opts the optional parameters
|
1158
|
+
# @return [Action]
|
1159
|
+
def patch_integrations_action_draft(action_id, body, opts = {})
|
1160
|
+
data, _status_code, _headers = patch_integrations_action_draft_with_http_info(action_id, body, opts)
|
1161
|
+
return data
|
1162
|
+
end
|
1163
|
+
|
1164
|
+
# Update an existing Draft
|
1165
|
+
#
|
1166
|
+
# @param action_id actionId
|
1167
|
+
# @param body Input used to patch the Action Draft.
|
1168
|
+
# @param [Hash] opts the optional parameters
|
1169
|
+
# @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers
|
1170
|
+
def patch_integrations_action_draft_with_http_info(action_id, body, opts = {})
|
1171
|
+
if @api_client.config.debugging
|
1172
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.patch_integrations_action_draft ..."
|
1173
|
+
end
|
1174
|
+
|
1175
|
+
|
1176
|
+
# verify the required parameter 'action_id' is set
|
1177
|
+
fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.patch_integrations_action_draft" if action_id.nil?
|
1178
|
+
|
1179
|
+
|
1180
|
+
|
1181
|
+
|
1182
|
+
|
1183
|
+
|
1184
|
+
# verify the required parameter 'body' is set
|
1185
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.patch_integrations_action_draft" if body.nil?
|
1186
|
+
|
1187
|
+
|
1188
|
+
|
1189
|
+
|
1190
|
+
|
1191
|
+
# resource path
|
1192
|
+
local_var_path = "/api/v2/integrations/actions/{actionId}/draft".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s)
|
1193
|
+
|
1194
|
+
# query parameters
|
1195
|
+
query_params = {}
|
1196
|
+
|
1197
|
+
# header parameters
|
1198
|
+
header_params = {}
|
1199
|
+
|
1200
|
+
# HTTP header 'Accept' (if needed)
|
1201
|
+
local_header_accept = ['application/json']
|
1202
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1203
|
+
|
1204
|
+
# HTTP header 'Content-Type'
|
1205
|
+
local_header_content_type = ['application/json']
|
1206
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1207
|
+
|
1208
|
+
# form parameters
|
1209
|
+
form_params = {}
|
1210
|
+
|
1211
|
+
# http body (model)
|
1212
|
+
post_body = @api_client.object_to_http_body(body)
|
1213
|
+
|
1214
|
+
auth_names = ['PureCloud Auth']
|
1215
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
1216
|
+
:header_params => header_params,
|
1217
|
+
:query_params => query_params,
|
1218
|
+
:form_params => form_params,
|
1219
|
+
:body => post_body,
|
1220
|
+
:auth_names => auth_names,
|
1221
|
+
:return_type => 'Action')
|
1222
|
+
if @api_client.config.debugging
|
1223
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#patch_integrations_action_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1224
|
+
end
|
1225
|
+
return data, status_code, headers
|
1226
|
+
end
|
1227
|
+
|
1228
|
+
# Create a new Draft from existing Action
|
1229
|
+
#
|
1230
|
+
# @param action_id actionId
|
1231
|
+
# @param [Hash] opts the optional parameters
|
1232
|
+
# @return [Action]
|
1233
|
+
def post_integrations_action_draft(action_id, opts = {})
|
1234
|
+
data, _status_code, _headers = post_integrations_action_draft_with_http_info(action_id, opts)
|
1235
|
+
return data
|
1236
|
+
end
|
1237
|
+
|
1238
|
+
# Create a new Draft from existing Action
|
1239
|
+
#
|
1240
|
+
# @param action_id actionId
|
1241
|
+
# @param [Hash] opts the optional parameters
|
1242
|
+
# @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers
|
1243
|
+
def post_integrations_action_draft_with_http_info(action_id, opts = {})
|
1244
|
+
if @api_client.config.debugging
|
1245
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_action_draft ..."
|
1246
|
+
end
|
1247
|
+
|
1248
|
+
|
1249
|
+
# verify the required parameter 'action_id' is set
|
1250
|
+
fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.post_integrations_action_draft" if action_id.nil?
|
1251
|
+
|
1252
|
+
|
1253
|
+
|
1254
|
+
|
1255
|
+
|
1256
|
+
# resource path
|
1257
|
+
local_var_path = "/api/v2/integrations/actions/{actionId}/draft".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s)
|
1258
|
+
|
1259
|
+
# query parameters
|
1260
|
+
query_params = {}
|
1261
|
+
|
1262
|
+
# header parameters
|
1263
|
+
header_params = {}
|
1264
|
+
|
1265
|
+
# HTTP header 'Accept' (if needed)
|
1266
|
+
local_header_accept = ['application/json']
|
1267
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1268
|
+
|
1269
|
+
# HTTP header 'Content-Type'
|
1270
|
+
local_header_content_type = ['application/json']
|
1271
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1272
|
+
|
1273
|
+
# form parameters
|
1274
|
+
form_params = {}
|
1275
|
+
|
1276
|
+
# http body (model)
|
1277
|
+
post_body = nil
|
1278
|
+
|
1279
|
+
auth_names = ['PureCloud Auth']
|
1280
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1281
|
+
:header_params => header_params,
|
1282
|
+
:query_params => query_params,
|
1283
|
+
:form_params => form_params,
|
1284
|
+
:body => post_body,
|
1285
|
+
:auth_names => auth_names,
|
1286
|
+
:return_type => 'Action')
|
1287
|
+
if @api_client.config.debugging
|
1288
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_action_draft\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1289
|
+
end
|
1290
|
+
return data, status_code, headers
|
1291
|
+
end
|
1292
|
+
|
1293
|
+
# Publish a Draft and make it the active Action configuration
|
1294
|
+
#
|
1295
|
+
# @param action_id actionId
|
1296
|
+
# @param body Input used to patch the Action.
|
1297
|
+
# @param [Hash] opts the optional parameters
|
1298
|
+
# @return [Action]
|
1299
|
+
def post_integrations_action_draft_publish(action_id, body, opts = {})
|
1300
|
+
data, _status_code, _headers = post_integrations_action_draft_publish_with_http_info(action_id, body, opts)
|
1301
|
+
return data
|
1302
|
+
end
|
1303
|
+
|
1304
|
+
# Publish a Draft and make it the active Action configuration
|
1305
|
+
#
|
1306
|
+
# @param action_id actionId
|
1307
|
+
# @param body Input used to patch the Action.
|
1308
|
+
# @param [Hash] opts the optional parameters
|
1309
|
+
# @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers
|
1310
|
+
def post_integrations_action_draft_publish_with_http_info(action_id, body, opts = {})
|
1311
|
+
if @api_client.config.debugging
|
1312
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_action_draft_publish ..."
|
1313
|
+
end
|
1314
|
+
|
1315
|
+
|
1316
|
+
# verify the required parameter 'action_id' is set
|
1317
|
+
fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.post_integrations_action_draft_publish" if action_id.nil?
|
1318
|
+
|
1319
|
+
|
1320
|
+
|
1321
|
+
|
1322
|
+
|
1323
|
+
|
1324
|
+
# verify the required parameter 'body' is set
|
1325
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.post_integrations_action_draft_publish" if body.nil?
|
1326
|
+
|
1327
|
+
|
1328
|
+
|
1329
|
+
|
1330
|
+
|
1331
|
+
# resource path
|
1332
|
+
local_var_path = "/api/v2/integrations/actions/{actionId}/draft/publish".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s)
|
1333
|
+
|
1334
|
+
# query parameters
|
1335
|
+
query_params = {}
|
1336
|
+
|
1337
|
+
# header parameters
|
1338
|
+
header_params = {}
|
1339
|
+
|
1340
|
+
# HTTP header 'Accept' (if needed)
|
1341
|
+
local_header_accept = ['application/json']
|
1342
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1343
|
+
|
1344
|
+
# HTTP header 'Content-Type'
|
1345
|
+
local_header_content_type = ['application/json']
|
1346
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1347
|
+
|
1348
|
+
# form parameters
|
1349
|
+
form_params = {}
|
1350
|
+
|
1351
|
+
# http body (model)
|
1352
|
+
post_body = @api_client.object_to_http_body(body)
|
1353
|
+
|
1354
|
+
auth_names = ['PureCloud Auth']
|
1355
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1356
|
+
:header_params => header_params,
|
1357
|
+
:query_params => query_params,
|
1358
|
+
:form_params => form_params,
|
1359
|
+
:body => post_body,
|
1360
|
+
:auth_names => auth_names,
|
1361
|
+
:return_type => 'Action')
|
1362
|
+
if @api_client.config.debugging
|
1363
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_action_draft_publish\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1364
|
+
end
|
1365
|
+
return data, status_code, headers
|
1366
|
+
end
|
1367
|
+
|
1368
|
+
# Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.
|
1369
|
+
#
|
1370
|
+
# @param action_id actionId
|
1371
|
+
# @param body Map of parameters used for variable substitution.
|
1372
|
+
# @param [Hash] opts the optional parameters
|
1373
|
+
# @return [TestExecutionResult]
|
1374
|
+
def post_integrations_action_draft_test(action_id, body, opts = {})
|
1375
|
+
data, _status_code, _headers = post_integrations_action_draft_test_with_http_info(action_id, body, opts)
|
1376
|
+
return data
|
1377
|
+
end
|
1378
|
+
|
1379
|
+
# Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.
|
1380
|
+
#
|
1381
|
+
# @param action_id actionId
|
1382
|
+
# @param body Map of parameters used for variable substitution.
|
1383
|
+
# @param [Hash] opts the optional parameters
|
1384
|
+
# @return [Array<(TestExecutionResult, Fixnum, Hash)>] TestExecutionResult data, response status code and response headers
|
1385
|
+
def post_integrations_action_draft_test_with_http_info(action_id, body, opts = {})
|
1386
|
+
if @api_client.config.debugging
|
1387
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_action_draft_test ..."
|
1388
|
+
end
|
1389
|
+
|
1390
|
+
|
1391
|
+
# verify the required parameter 'action_id' is set
|
1392
|
+
fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.post_integrations_action_draft_test" if action_id.nil?
|
1393
|
+
|
1394
|
+
|
1395
|
+
|
1396
|
+
|
1397
|
+
|
1398
|
+
|
1399
|
+
# verify the required parameter 'body' is set
|
1400
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.post_integrations_action_draft_test" if body.nil?
|
1401
|
+
|
1402
|
+
|
1403
|
+
|
1404
|
+
|
1405
|
+
|
1406
|
+
# resource path
|
1407
|
+
local_var_path = "/api/v2/integrations/actions/{actionId}/draft/test".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s)
|
1408
|
+
|
1409
|
+
# query parameters
|
1410
|
+
query_params = {}
|
1411
|
+
|
1412
|
+
# header parameters
|
1413
|
+
header_params = {}
|
1414
|
+
|
1415
|
+
# HTTP header 'Accept' (if needed)
|
1416
|
+
local_header_accept = ['application/json']
|
1417
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1418
|
+
|
1419
|
+
# HTTP header 'Content-Type'
|
1420
|
+
local_header_content_type = ['application/json']
|
1421
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1422
|
+
|
1423
|
+
# form parameters
|
1424
|
+
form_params = {}
|
1425
|
+
|
1426
|
+
# http body (model)
|
1427
|
+
post_body = @api_client.object_to_http_body(body)
|
1428
|
+
|
1429
|
+
auth_names = ['PureCloud Auth']
|
1430
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1431
|
+
:header_params => header_params,
|
1432
|
+
:query_params => query_params,
|
1433
|
+
:form_params => form_params,
|
1434
|
+
:body => post_body,
|
1435
|
+
:auth_names => auth_names,
|
1436
|
+
:return_type => 'TestExecutionResult')
|
1437
|
+
if @api_client.config.debugging
|
1438
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_action_draft_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1439
|
+
end
|
1440
|
+
return data, status_code, headers
|
1441
|
+
end
|
1442
|
+
|
1443
|
+
# Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.
|
1444
|
+
#
|
1445
|
+
# @param action_id actionId
|
1446
|
+
# @param body Map of parameters used for variable substitution.
|
1447
|
+
# @param [Hash] opts the optional parameters
|
1448
|
+
# @return [Object]
|
1449
|
+
def post_integrations_action_execute(action_id, body, opts = {})
|
1450
|
+
data, _status_code, _headers = post_integrations_action_execute_with_http_info(action_id, body, opts)
|
1451
|
+
return data
|
1452
|
+
end
|
1453
|
+
|
1454
|
+
# Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.
|
1455
|
+
#
|
1456
|
+
# @param action_id actionId
|
1457
|
+
# @param body Map of parameters used for variable substitution.
|
1458
|
+
# @param [Hash] opts the optional parameters
|
1459
|
+
# @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
|
1460
|
+
def post_integrations_action_execute_with_http_info(action_id, body, opts = {})
|
1461
|
+
if @api_client.config.debugging
|
1462
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_action_execute ..."
|
1463
|
+
end
|
1464
|
+
|
1465
|
+
|
1466
|
+
# verify the required parameter 'action_id' is set
|
1467
|
+
fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.post_integrations_action_execute" if action_id.nil?
|
1468
|
+
|
1469
|
+
|
1470
|
+
|
1471
|
+
|
1472
|
+
|
1473
|
+
|
1474
|
+
# verify the required parameter 'body' is set
|
1475
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.post_integrations_action_execute" if body.nil?
|
1476
|
+
|
1477
|
+
|
1478
|
+
|
1479
|
+
|
1480
|
+
|
1481
|
+
# resource path
|
1482
|
+
local_var_path = "/api/v2/integrations/actions/{actionId}/execute".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s)
|
1483
|
+
|
1484
|
+
# query parameters
|
1485
|
+
query_params = {}
|
1486
|
+
|
1487
|
+
# header parameters
|
1488
|
+
header_params = {}
|
1489
|
+
|
1490
|
+
# HTTP header 'Accept' (if needed)
|
1491
|
+
local_header_accept = ['application/json']
|
1492
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1493
|
+
|
1494
|
+
# HTTP header 'Content-Type'
|
1495
|
+
local_header_content_type = ['application/json']
|
1496
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1497
|
+
|
1498
|
+
# form parameters
|
1499
|
+
form_params = {}
|
1500
|
+
|
1501
|
+
# http body (model)
|
1502
|
+
post_body = @api_client.object_to_http_body(body)
|
1503
|
+
|
1504
|
+
auth_names = ['PureCloud Auth']
|
1505
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1506
|
+
:header_params => header_params,
|
1507
|
+
:query_params => query_params,
|
1508
|
+
:form_params => form_params,
|
1509
|
+
:body => post_body,
|
1510
|
+
:auth_names => auth_names,
|
1511
|
+
:return_type => 'Object')
|
1512
|
+
if @api_client.config.debugging
|
1513
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_action_execute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1514
|
+
end
|
1515
|
+
return data, status_code, headers
|
1516
|
+
end
|
1517
|
+
|
1518
|
+
# Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.
|
1519
|
+
#
|
1520
|
+
# @param action_id actionId
|
1521
|
+
# @param body Map of parameters used for variable substitution.
|
1522
|
+
# @param [Hash] opts the optional parameters
|
1523
|
+
# @return [TestExecutionResult]
|
1524
|
+
def post_integrations_action_test(action_id, body, opts = {})
|
1525
|
+
data, _status_code, _headers = post_integrations_action_test_with_http_info(action_id, body, opts)
|
1526
|
+
return data
|
1527
|
+
end
|
1528
|
+
|
1529
|
+
# Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.
|
1530
|
+
#
|
1531
|
+
# @param action_id actionId
|
1532
|
+
# @param body Map of parameters used for variable substitution.
|
1533
|
+
# @param [Hash] opts the optional parameters
|
1534
|
+
# @return [Array<(TestExecutionResult, Fixnum, Hash)>] TestExecutionResult data, response status code and response headers
|
1535
|
+
def post_integrations_action_test_with_http_info(action_id, body, opts = {})
|
1536
|
+
if @api_client.config.debugging
|
1537
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_action_test ..."
|
1538
|
+
end
|
1539
|
+
|
1540
|
+
|
1541
|
+
# verify the required parameter 'action_id' is set
|
1542
|
+
fail ArgumentError, "Missing the required parameter 'action_id' when calling IntegrationsApi.post_integrations_action_test" if action_id.nil?
|
1543
|
+
|
1544
|
+
|
1545
|
+
|
1546
|
+
|
1547
|
+
|
1548
|
+
|
1549
|
+
# verify the required parameter 'body' is set
|
1550
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.post_integrations_action_test" if body.nil?
|
1551
|
+
|
1552
|
+
|
1553
|
+
|
1554
|
+
|
1555
|
+
|
1556
|
+
# resource path
|
1557
|
+
local_var_path = "/api/v2/integrations/actions/{actionId}/test".sub('{format}','json').sub('{' + 'actionId' + '}', action_id.to_s)
|
1558
|
+
|
1559
|
+
# query parameters
|
1560
|
+
query_params = {}
|
1561
|
+
|
1562
|
+
# header parameters
|
1563
|
+
header_params = {}
|
1564
|
+
|
1565
|
+
# HTTP header 'Accept' (if needed)
|
1566
|
+
local_header_accept = ['application/json']
|
1567
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1568
|
+
|
1569
|
+
# HTTP header 'Content-Type'
|
1570
|
+
local_header_content_type = ['application/json']
|
1571
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1572
|
+
|
1573
|
+
# form parameters
|
1574
|
+
form_params = {}
|
1575
|
+
|
1576
|
+
# http body (model)
|
1577
|
+
post_body = @api_client.object_to_http_body(body)
|
1578
|
+
|
1579
|
+
auth_names = ['PureCloud Auth']
|
1580
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1581
|
+
:header_params => header_params,
|
1582
|
+
:query_params => query_params,
|
1583
|
+
:form_params => form_params,
|
1584
|
+
:body => post_body,
|
1585
|
+
:auth_names => auth_names,
|
1586
|
+
:return_type => 'TestExecutionResult')
|
1587
|
+
if @api_client.config.debugging
|
1588
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_action_test\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1589
|
+
end
|
1590
|
+
return data, status_code, headers
|
1591
|
+
end
|
1592
|
+
|
1593
|
+
# Create a new Action
|
1594
|
+
#
|
1595
|
+
# @param body Input used to create Action.
|
1596
|
+
# @param [Hash] opts the optional parameters
|
1597
|
+
# @return [Action]
|
1598
|
+
def post_integrations_actions(body, opts = {})
|
1599
|
+
data, _status_code, _headers = post_integrations_actions_with_http_info(body, opts)
|
1600
|
+
return data
|
1601
|
+
end
|
1602
|
+
|
1603
|
+
# Create a new Action
|
1604
|
+
#
|
1605
|
+
# @param body Input used to create Action.
|
1606
|
+
# @param [Hash] opts the optional parameters
|
1607
|
+
# @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers
|
1608
|
+
def post_integrations_actions_with_http_info(body, opts = {})
|
1609
|
+
if @api_client.config.debugging
|
1610
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_actions ..."
|
1611
|
+
end
|
1612
|
+
|
1613
|
+
|
1614
|
+
# verify the required parameter 'body' is set
|
1615
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.post_integrations_actions" if body.nil?
|
1616
|
+
|
1617
|
+
|
1618
|
+
|
1619
|
+
|
1620
|
+
|
1621
|
+
# resource path
|
1622
|
+
local_var_path = "/api/v2/integrations/actions".sub('{format}','json')
|
1623
|
+
|
1624
|
+
# query parameters
|
1625
|
+
query_params = {}
|
1626
|
+
|
1627
|
+
# header parameters
|
1628
|
+
header_params = {}
|
1629
|
+
|
1630
|
+
# HTTP header 'Accept' (if needed)
|
1631
|
+
local_header_accept = ['application/json']
|
1632
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1633
|
+
|
1634
|
+
# HTTP header 'Content-Type'
|
1635
|
+
local_header_content_type = ['application/json']
|
1636
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1637
|
+
|
1638
|
+
# form parameters
|
1639
|
+
form_params = {}
|
1640
|
+
|
1641
|
+
# http body (model)
|
1642
|
+
post_body = @api_client.object_to_http_body(body)
|
1643
|
+
|
1644
|
+
auth_names = ['PureCloud Auth']
|
1645
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1646
|
+
:header_params => header_params,
|
1647
|
+
:query_params => query_params,
|
1648
|
+
:form_params => form_params,
|
1649
|
+
:body => post_body,
|
1650
|
+
:auth_names => auth_names,
|
1651
|
+
:return_type => 'Action')
|
1652
|
+
if @api_client.config.debugging
|
1653
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_actions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1654
|
+
end
|
1655
|
+
return data, status_code, headers
|
1656
|
+
end
|
1657
|
+
|
1658
|
+
# Create a new Draft
|
1659
|
+
#
|
1660
|
+
# @param body Input used to create Action Draft.
|
1661
|
+
# @param [Hash] opts the optional parameters
|
1662
|
+
# @return [Action]
|
1663
|
+
def post_integrations_actions_drafts(body, opts = {})
|
1664
|
+
data, _status_code, _headers = post_integrations_actions_drafts_with_http_info(body, opts)
|
1665
|
+
return data
|
1666
|
+
end
|
1667
|
+
|
1668
|
+
# Create a new Draft
|
1669
|
+
#
|
1670
|
+
# @param body Input used to create Action Draft.
|
1671
|
+
# @param [Hash] opts the optional parameters
|
1672
|
+
# @return [Array<(Action, Fixnum, Hash)>] Action data, response status code and response headers
|
1673
|
+
def post_integrations_actions_drafts_with_http_info(body, opts = {})
|
1674
|
+
if @api_client.config.debugging
|
1675
|
+
@api_client.config.logger.debug "Calling API: IntegrationsApi.post_integrations_actions_drafts ..."
|
1676
|
+
end
|
1677
|
+
|
1678
|
+
|
1679
|
+
# verify the required parameter 'body' is set
|
1680
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling IntegrationsApi.post_integrations_actions_drafts" if body.nil?
|
1681
|
+
|
1682
|
+
|
1683
|
+
|
1684
|
+
|
1685
|
+
|
1686
|
+
# resource path
|
1687
|
+
local_var_path = "/api/v2/integrations/actions/drafts".sub('{format}','json')
|
1688
|
+
|
1689
|
+
# query parameters
|
1690
|
+
query_params = {}
|
1691
|
+
|
1692
|
+
# header parameters
|
1693
|
+
header_params = {}
|
1694
|
+
|
1695
|
+
# HTTP header 'Accept' (if needed)
|
1696
|
+
local_header_accept = ['application/json']
|
1697
|
+
local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
|
1698
|
+
|
1699
|
+
# HTTP header 'Content-Type'
|
1700
|
+
local_header_content_type = ['application/json']
|
1701
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
|
1702
|
+
|
1703
|
+
# form parameters
|
1704
|
+
form_params = {}
|
1705
|
+
|
1706
|
+
# http body (model)
|
1707
|
+
post_body = @api_client.object_to_http_body(body)
|
1708
|
+
|
1709
|
+
auth_names = ['PureCloud Auth']
|
1710
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
1711
|
+
:header_params => header_params,
|
1712
|
+
:query_params => query_params,
|
1713
|
+
:form_params => form_params,
|
1714
|
+
:body => post_body,
|
1715
|
+
:auth_names => auth_names,
|
1716
|
+
:return_type => 'Action')
|
1717
|
+
if @api_client.config.debugging
|
1718
|
+
@api_client.config.logger.debug "API called: IntegrationsApi#post_integrations_actions_drafts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1719
|
+
end
|
1720
|
+
return data, status_code, headers
|
1721
|
+
end
|
1722
|
+
end
|
1723
|
+
end
|