purecloud 0.30.1 → 0.31.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (181) hide show
  1. checksums.yaml +4 -4
  2. data/config-ruby.json +1 -1
  3. data/lib/purecloud/api/configuration_api.rb +4 -814
  4. data/lib/purecloud/api/conversations_api.rb +1035 -1763
  5. data/lib/purecloud/api/organization_api.rb +0 -58
  6. data/lib/purecloud/api/quality_api.rb +629 -0
  7. data/lib/purecloud/api/telephony_providers_edge_api.rb +1033 -677
  8. data/lib/purecloud/api/users_api.rb +311 -0
  9. data/lib/purecloud/api/voicemail_api.rb +176 -176
  10. data/lib/purecloud/models/address_listing.rb +17 -17
  11. data/lib/purecloud/models/agent_activity_entity_listing.rb +17 -17
  12. data/lib/purecloud/models/aggregate_metric_data.rb +1 -1
  13. data/lib/purecloud/models/analytics_conversation_segment.rb +18 -235
  14. data/lib/purecloud/models/analytics_participant.rb +40 -1
  15. data/lib/purecloud/models/analytics_query_predicate.rb +2 -2
  16. data/lib/purecloud/models/analytics_session.rb +150 -1
  17. data/lib/purecloud/models/attribute_entity_listing.rb +17 -17
  18. data/lib/purecloud/models/automate_queue_member_entity_listing.rb +17 -17
  19. data/lib/purecloud/models/available_additional_service_listing.rb +17 -17
  20. data/lib/purecloud/models/available_topic_entity_listing.rb +17 -17
  21. data/lib/purecloud/models/calibration_entity_listing.rb +17 -17
  22. data/lib/purecloud/models/call_conversation_entity_listing.rb +17 -17
  23. data/lib/purecloud/models/callable_time_set_entity_listing.rb +17 -17
  24. data/lib/purecloud/models/callback_conversation_entity_listing.rb +17 -17
  25. data/lib/purecloud/models/campaign_entity_listing.rb +17 -17
  26. data/lib/purecloud/models/campaign_sequence_entity_listing.rb +17 -17
  27. data/lib/purecloud/models/carrier_entity_listing.rb +17 -17
  28. data/lib/purecloud/models/certificate_authority_entity_listing.rb +17 -17
  29. data/lib/purecloud/models/channel_entity_listing.rb +17 -17
  30. data/lib/purecloud/models/channel_topic_entity_listing.rb +17 -17
  31. data/lib/purecloud/models/chat_conversation_entity_listing.rb +17 -17
  32. data/lib/purecloud/models/command_status_entity_listing.rb +17 -17
  33. data/lib/purecloud/models/consumed_resources_entity_listing.rb +17 -17
  34. data/lib/purecloud/models/consuming_resources_entity_listing.rb +17 -17
  35. data/lib/purecloud/models/contact_list_entity_listing.rb +17 -17
  36. data/lib/purecloud/models/contact_listing.rb +17 -17
  37. data/lib/purecloud/models/conversation_entity_listing.rb +17 -17
  38. data/lib/purecloud/models/create_user.rb +1 -11
  39. data/lib/purecloud/models/data_item.rb +23 -19
  40. data/lib/purecloud/models/deleted_resource_consumer_entity_listing.rb +17 -17
  41. data/lib/purecloud/models/dependency_object_entity_listing.rb +17 -17
  42. data/lib/purecloud/models/dependency_type_entity_listing.rb +17 -17
  43. data/lib/purecloud/models/did_entity_listing.rb +17 -17
  44. data/lib/purecloud/models/did_pool_entity_listing.rb +17 -17
  45. data/lib/purecloud/models/dnc_list_entity_listing.rb +17 -17
  46. data/lib/purecloud/models/document_audit_entity_listing.rb +17 -17
  47. data/lib/purecloud/models/document_entity_listing.rb +17 -17
  48. data/lib/purecloud/models/domain_billing_period_entity_listing.rb +17 -17
  49. data/lib/purecloud/models/domain_entity_listing.rb +17 -17
  50. data/lib/purecloud/models/domain_entity_listing_evaluation_form.rb +17 -17
  51. data/lib/purecloud/models/domain_entity_listing_query_result.rb +17 -17
  52. data/lib/purecloud/models/domain_invoice_entity_listing.rb +17 -17
  53. data/lib/purecloud/models/domain_third_party_account_entity_listing.rb +17 -17
  54. data/lib/purecloud/models/domain_third_party_subscription_entity_listing.rb +17 -17
  55. data/lib/purecloud/models/domain_voice_rate_extended_response_item_entity_listing.rb +17 -17
  56. data/lib/purecloud/models/domain_voice_rate_international_response_item_entity_listing.rb +17 -17
  57. data/lib/purecloud/models/domain_voice_rate_response_item_entity_listing.rb +17 -17
  58. data/lib/purecloud/models/edge_entity_listing.rb +17 -17
  59. data/lib/purecloud/models/edge_group_entity_listing.rb +17 -17
  60. data/lib/purecloud/models/edge_line_entity_listing.rb +17 -17
  61. data/lib/purecloud/models/email_conversation_entity_listing.rb +17 -17
  62. data/lib/purecloud/models/email_message_listing.rb +17 -17
  63. data/lib/purecloud/models/encryption_key_entity_listing.rb +17 -17
  64. data/lib/purecloud/models/endpoint_entity_listing.rb +17 -17
  65. data/lib/purecloud/models/evaluation_entity_listing.rb +17 -17
  66. data/lib/purecloud/models/evaluation_form_entity_listing.rb +17 -17
  67. data/lib/purecloud/models/evaluator_activity_entity_listing.rb +17 -17
  68. data/lib/purecloud/models/extension_entity_listing.rb +17 -17
  69. data/lib/purecloud/models/extension_pool_entity_listing.rb +17 -17
  70. data/lib/purecloud/models/external_organization_listing.rb +17 -17
  71. data/lib/purecloud/models/fax_document_entity_listing.rb +17 -17
  72. data/lib/purecloud/models/flow_config_meta_data_entity_listing.rb +17 -17
  73. data/lib/purecloud/models/flow_entity_listing.rb +17 -17
  74. data/lib/purecloud/models/flow_history_result_item_entity_listing.rb +17 -17
  75. data/lib/purecloud/models/flow_version_config_meta_data_entity_listing.rb +17 -17
  76. data/lib/purecloud/models/flow_version_entity_listing.rb +17 -17
  77. data/lib/purecloud/models/group_entity_listing.rb +17 -17
  78. data/lib/purecloud/models/hardware_rate_listing.rb +17 -17
  79. data/lib/purecloud/models/inbound_domain_entity_listing.rb +17 -17
  80. data/lib/purecloud/models/inbound_route_entity_listing.rb +17 -17
  81. data/lib/purecloud/models/integration_type_entity_listing.rb +17 -17
  82. data/lib/purecloud/models/interaction_stats_alert_container.rb +17 -17
  83. data/lib/purecloud/models/interaction_stats_rule_container.rb +17 -17
  84. data/lib/purecloud/models/ivr_entity_listing.rb +17 -17
  85. data/lib/purecloud/models/json_node.rb +32 -32
  86. data/lib/purecloud/models/language_entity_listing.rb +17 -17
  87. data/lib/purecloud/models/library_entity_listing.rb +17 -17
  88. data/lib/purecloud/models/line_base_entity_listing.rb +17 -17
  89. data/lib/purecloud/models/line_entity_listing.rb +17 -17
  90. data/lib/purecloud/models/linked_entity_listing_flow_details.rb +17 -17
  91. data/lib/purecloud/models/linked_entity_listing_work_item_search_details.rb +17 -17
  92. data/lib/purecloud/models/location_entity_listing.rb +17 -17
  93. data/lib/purecloud/models/logical_interface_entity_listing.rb +17 -17
  94. data/lib/purecloud/models/note_listing.rb +17 -17
  95. data/lib/purecloud/models/o_auth_client_entity_listing.rb +17 -17
  96. data/lib/purecloud/models/o_auth_provider_entity_listing.rb +17 -17
  97. data/lib/purecloud/models/organization.rb +1 -0
  98. data/lib/purecloud/models/organization_presence_entity_listing.rb +17 -17
  99. data/lib/purecloud/models/organization_role_entity_listing.rb +17 -17
  100. data/lib/purecloud/models/orphan_recording_listing.rb +17 -17
  101. data/lib/purecloud/models/outbound_route_entity_listing.rb +17 -17
  102. data/lib/purecloud/models/payment_method_listing.rb +17 -17
  103. data/lib/purecloud/models/permission_collection_entity_listing.rb +17 -17
  104. data/lib/purecloud/models/phone_base_entity_listing.rb +17 -17
  105. data/lib/purecloud/models/phone_entity_listing.rb +17 -17
  106. data/lib/purecloud/models/phone_meta_base_entity_listing.rb +17 -17
  107. data/lib/purecloud/models/physical_interface_entity_listing.rb +17 -17
  108. data/lib/purecloud/models/policy_entity_listing.rb +17 -17
  109. data/lib/purecloud/models/prompt_asset_entity_listing.rb +17 -17
  110. data/lib/purecloud/models/prompt_entity_listing.rb +17 -17
  111. data/lib/purecloud/models/property_index_request.rb +1 -12
  112. data/lib/purecloud/models/quality_audit_page.rb +17 -17
  113. data/lib/purecloud/models/queue_entity_listing.rb +17 -17
  114. data/lib/purecloud/models/queues_entity_listing.rb +17 -17
  115. data/lib/purecloud/models/quote_listing.rb +17 -17
  116. data/lib/purecloud/models/relationship_listing.rb +17 -17
  117. data/lib/purecloud/models/report_meta_data_entity_listing.rb +17 -17
  118. data/lib/purecloud/models/report_run_entry_entity_domain_listing.rb +17 -17
  119. data/lib/purecloud/models/report_schedule_entity_listing.rb +17 -17
  120. data/lib/purecloud/models/response_entity_list.rb +17 -17
  121. data/lib/purecloud/models/response_entity_listing.rb +17 -17
  122. data/lib/purecloud/models/response_set_entity_listing.rb +17 -17
  123. data/lib/purecloud/models/rule_set_entity_listing.rb +17 -17
  124. data/lib/purecloud/models/schedule_entity_listing.rb +17 -17
  125. data/lib/purecloud/models/schedule_group_entity_listing.rb +17 -17
  126. data/lib/purecloud/models/schema_category_entity_listing.rb +17 -17
  127. data/lib/purecloud/models/schema_reference_entity_listing.rb +17 -17
  128. data/lib/purecloud/models/script_entity_listing.rb +17 -17
  129. data/lib/purecloud/models/security_profile_entity_listing.rb +17 -17
  130. data/lib/purecloud/models/service_entity_listing.rb +17 -17
  131. data/lib/purecloud/models/share_entity_listing.rb +17 -17
  132. data/lib/purecloud/models/site.rb +1 -1
  133. data/lib/purecloud/models/site_entity_listing.rb +17 -17
  134. data/lib/purecloud/models/skill_entity_listing.rb +17 -17
  135. data/lib/purecloud/models/social_conversation_entity_listing.rb +17 -17
  136. data/lib/purecloud/models/spreadsheet_transform_entity_listing.rb +17 -17
  137. data/lib/purecloud/models/station_entity_listing.rb +17 -17
  138. data/lib/purecloud/models/system_prompt_asset_entity_listing.rb +17 -17
  139. data/lib/purecloud/models/system_prompt_entity_listing.rb +17 -17
  140. data/lib/purecloud/models/tag_value_entity_listing.rb +17 -17
  141. data/lib/purecloud/models/template_entity_listing.rb +17 -17
  142. data/lib/purecloud/models/text_table_transform_entity_listing.rb +17 -17
  143. data/lib/purecloud/models/time_zone_entity_listing.rb +17 -17
  144. data/lib/purecloud/models/trunk_metabase_entity_listing.rb +17 -17
  145. data/lib/purecloud/models/user_action_category_entity_listing.rb +17 -17
  146. data/lib/purecloud/models/user_action_metadata_entity_listing.rb +11 -11
  147. data/lib/purecloud/models/user_entity_listing.rb +17 -17
  148. data/lib/purecloud/models/user_queue_entity_listing.rb +17 -17
  149. data/lib/purecloud/models/user_recording_entity_listing.rb +17 -17
  150. data/lib/purecloud/models/user_skill_entity_listing.rb +17 -17
  151. data/lib/purecloud/models/users_entity_listing.rb +17 -17
  152. data/lib/purecloud/models/video_conversation_entity_listing.rb +17 -17
  153. data/lib/purecloud/models/voice_rate_international_entity_listing.rb +17 -17
  154. data/lib/purecloud/models/voice_xml_operation_entity_listing.rb +17 -17
  155. data/lib/purecloud/models/voicemail_message_entity_listing.rb +17 -17
  156. data/lib/purecloud/models/workspace_entity_listing.rb +17 -17
  157. data/lib/purecloud/models/workspace_member_entity_listing.rb +17 -17
  158. data/lib/purecloud/models/wrapup_code_entity_listing.rb +17 -17
  159. data/lib/purecloud/version.rb +1 -1
  160. data/lib/purecloud.rb +83 -100
  161. data/newVersion.md +1 -1
  162. data/swagger.json +1 -1
  163. data/version.json +1 -1
  164. metadata +2 -19
  165. data/lib/purecloud/api/callbacks_api.rb +0 -483
  166. data/lib/purecloud/api/calls_api.rb +0 -1088
  167. data/lib/purecloud/api/chats_api.rb +0 -483
  168. data/lib/purecloud/api/compliance_api.rb +0 -129
  169. data/lib/purecloud/api/downloads_api.rb +0 -140
  170. data/lib/purecloud/api/emails_api.rb +0 -1013
  171. data/lib/purecloud/api/evaluations_api.rb +0 -73
  172. data/lib/purecloud/api/faxes_api.rb +0 -73
  173. data/lib/purecloud/api/integrations_api.rb +0 -150
  174. data/lib/purecloud/api/integrations_workforce_management_api.rb +0 -73
  175. data/lib/purecloud/api/licensing_api.rb +0 -428
  176. data/lib/purecloud/api/scripts_api.rb +0 -718
  177. data/lib/purecloud/api/socials_api.rb +0 -483
  178. data/lib/purecloud/api/videos_api.rb +0 -483
  179. data/lib/purecloud/models/body.rb +0 -136
  180. data/lib/purecloud/models/organization_address.rb +0 -194
  181. data/lib/purecloud/models/participant_request.rb +0 -242
@@ -1,718 +0,0 @@
1
- require "uri"
2
-
3
- module PureCloud
4
- class ScriptsApi
5
- attr_accessor :api_client
6
-
7
- def initialize(api_client = ApiClient.default)
8
- @api_client = api_client
9
- end
10
-
11
- # Get the list of evaluation forms
12
- #
13
- # @param [Hash] opts the optional parameters
14
- # @option opts [Integer] :page_size The total page size requested
15
- # @option opts [Integer] :page_number The page number requested
16
- # @option opts [String] :sort_by variable name requested to sort by
17
- # @option opts [Array<String>] :expand variable name requested by expand list
18
- # @option opts [String] :next_page next page token
19
- # @option opts [String] :previous_page Previous page token
20
- # @option opts [String] :expand2 Expand
21
- # @option opts [String] :name Name
22
- # @return [EvaluationFormEntityListing]
23
- def get_forms(opts = {})
24
- data, status_code, headers = get_forms_with_http_info(opts)
25
- return data
26
- end
27
-
28
- # Get the list of evaluation forms
29
- #
30
- # @param [Hash] opts the optional parameters
31
- # @option opts [Integer] :page_size The total page size requested
32
- # @option opts [Integer] :page_number The page number requested
33
- # @option opts [String] :sort_by variable name requested to sort by
34
- # @option opts [Array<String>] :expand variable name requested by expand list
35
- # @option opts [String] :next_page next page token
36
- # @option opts [String] :previous_page Previous page token
37
- # @option opts [String] :expand2 Expand
38
- # @option opts [String] :name Name
39
- # @return [Array<(EvaluationFormEntityListing, Fixnum, Hash)>] EvaluationFormEntityListing data, response status code and response headers
40
- def get_forms_with_http_info(opts = {})
41
- if @api_client.config.debugging
42
- @api_client.config.logger.debug "Calling API: ScriptsApi#get_forms ..."
43
- end
44
-
45
- # resource path
46
- path = "/api/v2/quality/forms".sub('{format}','json')
47
-
48
- # query parameters
49
- query_params = {}
50
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
51
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
52
- query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
53
- query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
54
- query_params[:'nextPage'] = opts[:'next_page'] if opts[:'next_page']
55
- query_params[:'previousPage'] = opts[:'previous_page'] if opts[:'previous_page']
56
- query_params[:'expand'] = opts[:'expand2'] if opts[:'expand2']
57
- query_params[:'name'] = opts[:'name'] if opts[:'name']
58
-
59
- # header parameters
60
- header_params = {}
61
-
62
- # HTTP header 'Accept' (if needed)
63
- _header_accept = ['application/json']
64
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
65
-
66
- # HTTP header 'Content-Type'
67
- _header_content_type = ['application/json']
68
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
69
-
70
- # form parameters
71
- form_params = {}
72
-
73
- # http body (model)
74
- post_body = nil
75
-
76
-
77
- auth_names = ['PureCloud Auth']
78
- data, status_code, headers = @api_client.call_api(:GET, path,
79
- :header_params => header_params,
80
- :query_params => query_params,
81
- :form_params => form_params,
82
- :body => post_body,
83
- :auth_names => auth_names,
84
- :return_type => 'EvaluationFormEntityListing')
85
- if @api_client.config.debugging
86
- @api_client.config.logger.debug "API called: ScriptsApi#get_forms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
87
- end
88
- return data, status_code, headers
89
- end
90
-
91
- # Create an evaluation form.
92
- #
93
- # @param [Hash] opts the optional parameters
94
- # @option opts [EvaluationForm] :body
95
- # @return [EvaluationForm]
96
- def post_forms(opts = {})
97
- data, status_code, headers = post_forms_with_http_info(opts)
98
- return data
99
- end
100
-
101
- # Create an evaluation form.
102
- #
103
- # @param [Hash] opts the optional parameters
104
- # @option opts [EvaluationForm] :body
105
- # @return [Array<(EvaluationForm, Fixnum, Hash)>] EvaluationForm data, response status code and response headers
106
- def post_forms_with_http_info(opts = {})
107
- if @api_client.config.debugging
108
- @api_client.config.logger.debug "Calling API: ScriptsApi#post_forms ..."
109
- end
110
-
111
- # resource path
112
- path = "/api/v2/quality/forms".sub('{format}','json')
113
-
114
- # query parameters
115
- query_params = {}
116
-
117
- # header parameters
118
- header_params = {}
119
-
120
- # HTTP header 'Accept' (if needed)
121
- _header_accept = ['application/json']
122
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
123
-
124
- # HTTP header 'Content-Type'
125
- _header_content_type = ['application/json']
126
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
127
-
128
- # form parameters
129
- form_params = {}
130
-
131
- # http body (model)
132
- post_body = @api_client.object_to_http_body(opts[:'body'])
133
-
134
-
135
- auth_names = ['PureCloud Auth']
136
- data, status_code, headers = @api_client.call_api(:POST, path,
137
- :header_params => header_params,
138
- :query_params => query_params,
139
- :form_params => form_params,
140
- :body => post_body,
141
- :auth_names => auth_names,
142
- :return_type => 'EvaluationForm')
143
- if @api_client.config.debugging
144
- @api_client.config.logger.debug "API called: ScriptsApi#post_forms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
145
- end
146
- return data, status_code, headers
147
- end
148
-
149
- # Get an evaluation form
150
- #
151
- # @param form_id Form ID
152
- # @param [Hash] opts the optional parameters
153
- # @return [EvaluationForm]
154
- def get_forms_form_id(form_id, opts = {})
155
- data, status_code, headers = get_forms_form_id_with_http_info(form_id, opts)
156
- return data
157
- end
158
-
159
- # Get an evaluation form
160
- #
161
- # @param form_id Form ID
162
- # @param [Hash] opts the optional parameters
163
- # @return [Array<(EvaluationForm, Fixnum, Hash)>] EvaluationForm data, response status code and response headers
164
- def get_forms_form_id_with_http_info(form_id, opts = {})
165
- if @api_client.config.debugging
166
- @api_client.config.logger.debug "Calling API: ScriptsApi#get_forms_form_id ..."
167
- end
168
-
169
- # verify the required parameter 'form_id' is set
170
- fail "Missing the required parameter 'form_id' when calling get_forms_form_id" if form_id.nil?
171
-
172
- # resource path
173
- path = "/api/v2/quality/forms/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
174
-
175
- # query parameters
176
- query_params = {}
177
-
178
- # header parameters
179
- header_params = {}
180
-
181
- # HTTP header 'Accept' (if needed)
182
- _header_accept = ['application/json']
183
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
184
-
185
- # HTTP header 'Content-Type'
186
- _header_content_type = ['application/json']
187
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
188
-
189
- # form parameters
190
- form_params = {}
191
-
192
- # http body (model)
193
- post_body = nil
194
-
195
-
196
- auth_names = ['PureCloud Auth']
197
- data, status_code, headers = @api_client.call_api(:GET, path,
198
- :header_params => header_params,
199
- :query_params => query_params,
200
- :form_params => form_params,
201
- :body => post_body,
202
- :auth_names => auth_names,
203
- :return_type => 'EvaluationForm')
204
- if @api_client.config.debugging
205
- @api_client.config.logger.debug "API called: ScriptsApi#get_forms_form_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
206
- end
207
- return data, status_code, headers
208
- end
209
-
210
- # Update an evaluation form.
211
- #
212
- # @param form_id Form ID
213
- # @param [Hash] opts the optional parameters
214
- # @option opts [EvaluationForm] :body
215
- # @return [EvaluationForm]
216
- def put_forms_form_id(form_id, opts = {})
217
- data, status_code, headers = put_forms_form_id_with_http_info(form_id, opts)
218
- return data
219
- end
220
-
221
- # Update an evaluation form.
222
- #
223
- # @param form_id Form ID
224
- # @param [Hash] opts the optional parameters
225
- # @option opts [EvaluationForm] :body
226
- # @return [Array<(EvaluationForm, Fixnum, Hash)>] EvaluationForm data, response status code and response headers
227
- def put_forms_form_id_with_http_info(form_id, opts = {})
228
- if @api_client.config.debugging
229
- @api_client.config.logger.debug "Calling API: ScriptsApi#put_forms_form_id ..."
230
- end
231
-
232
- # verify the required parameter 'form_id' is set
233
- fail "Missing the required parameter 'form_id' when calling put_forms_form_id" if form_id.nil?
234
-
235
- # resource path
236
- path = "/api/v2/quality/forms/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
237
-
238
- # query parameters
239
- query_params = {}
240
-
241
- # header parameters
242
- header_params = {}
243
-
244
- # HTTP header 'Accept' (if needed)
245
- _header_accept = ['application/json']
246
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
247
-
248
- # HTTP header 'Content-Type'
249
- _header_content_type = ['application/json']
250
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
251
-
252
- # form parameters
253
- form_params = {}
254
-
255
- # http body (model)
256
- post_body = @api_client.object_to_http_body(opts[:'body'])
257
-
258
-
259
- auth_names = ['PureCloud Auth']
260
- data, status_code, headers = @api_client.call_api(:PUT, path,
261
- :header_params => header_params,
262
- :query_params => query_params,
263
- :form_params => form_params,
264
- :body => post_body,
265
- :auth_names => auth_names,
266
- :return_type => 'EvaluationForm')
267
- if @api_client.config.debugging
268
- @api_client.config.logger.debug "API called: ScriptsApi#put_forms_form_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
269
- end
270
- return data, status_code, headers
271
- end
272
-
273
- # Delete an evaluation form.
274
- #
275
- # @param form_id Form ID
276
- # @param [Hash] opts the optional parameters
277
- # @return [String]
278
- def delete_forms_form_id(form_id, opts = {})
279
- data, status_code, headers = delete_forms_form_id_with_http_info(form_id, opts)
280
- return data
281
- end
282
-
283
- # Delete an evaluation form.
284
- #
285
- # @param form_id Form ID
286
- # @param [Hash] opts the optional parameters
287
- # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
288
- def delete_forms_form_id_with_http_info(form_id, opts = {})
289
- if @api_client.config.debugging
290
- @api_client.config.logger.debug "Calling API: ScriptsApi#delete_forms_form_id ..."
291
- end
292
-
293
- # verify the required parameter 'form_id' is set
294
- fail "Missing the required parameter 'form_id' when calling delete_forms_form_id" if form_id.nil?
295
-
296
- # resource path
297
- path = "/api/v2/quality/forms/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
298
-
299
- # query parameters
300
- query_params = {}
301
-
302
- # header parameters
303
- header_params = {}
304
-
305
- # HTTP header 'Accept' (if needed)
306
- _header_accept = ['application/json']
307
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
308
-
309
- # HTTP header 'Content-Type'
310
- _header_content_type = ['application/json']
311
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
312
-
313
- # form parameters
314
- form_params = {}
315
-
316
- # http body (model)
317
- post_body = nil
318
-
319
-
320
- auth_names = ['PureCloud Auth']
321
- data, status_code, headers = @api_client.call_api(:DELETE, path,
322
- :header_params => header_params,
323
- :query_params => query_params,
324
- :form_params => form_params,
325
- :body => post_body,
326
- :auth_names => auth_names,
327
- :return_type => 'String')
328
- if @api_client.config.debugging
329
- @api_client.config.logger.debug "API called: ScriptsApi#delete_forms_form_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
330
- end
331
- return data, status_code, headers
332
- end
333
-
334
- # Gets all the revisions for a specific evaluation.
335
- #
336
- # @param form_id Form ID
337
- # @param [Hash] opts the optional parameters
338
- # @option opts [Integer] :page_size Page size
339
- # @option opts [Integer] :page_number Page number
340
- # @return [EvaluationFormEntityListing]
341
- def get_forms_form_id_versions(form_id, opts = {})
342
- data, status_code, headers = get_forms_form_id_versions_with_http_info(form_id, opts)
343
- return data
344
- end
345
-
346
- # Gets all the revisions for a specific evaluation.
347
- #
348
- # @param form_id Form ID
349
- # @param [Hash] opts the optional parameters
350
- # @option opts [Integer] :page_size Page size
351
- # @option opts [Integer] :page_number Page number
352
- # @return [Array<(EvaluationFormEntityListing, Fixnum, Hash)>] EvaluationFormEntityListing data, response status code and response headers
353
- def get_forms_form_id_versions_with_http_info(form_id, opts = {})
354
- if @api_client.config.debugging
355
- @api_client.config.logger.debug "Calling API: ScriptsApi#get_forms_form_id_versions ..."
356
- end
357
-
358
- # verify the required parameter 'form_id' is set
359
- fail "Missing the required parameter 'form_id' when calling get_forms_form_id_versions" if form_id.nil?
360
-
361
- # resource path
362
- path = "/api/v2/quality/forms/{formId}/versions".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
363
-
364
- # query parameters
365
- query_params = {}
366
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
367
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
368
-
369
- # header parameters
370
- header_params = {}
371
-
372
- # HTTP header 'Accept' (if needed)
373
- _header_accept = ['application/json']
374
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
375
-
376
- # HTTP header 'Content-Type'
377
- _header_content_type = ['application/json']
378
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
379
-
380
- # form parameters
381
- form_params = {}
382
-
383
- # http body (model)
384
- post_body = nil
385
-
386
-
387
- auth_names = ['PureCloud Auth']
388
- data, status_code, headers = @api_client.call_api(:GET, path,
389
- :header_params => header_params,
390
- :query_params => query_params,
391
- :form_params => form_params,
392
- :body => post_body,
393
- :auth_names => auth_names,
394
- :return_type => 'EvaluationFormEntityListing')
395
- if @api_client.config.debugging
396
- @api_client.config.logger.debug "API called: ScriptsApi#get_forms_form_id_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
397
- end
398
- return data, status_code, headers
399
- end
400
-
401
- # Get the published evaluation forms.
402
- #
403
- # @param [Hash] opts the optional parameters
404
- # @option opts [Integer] :page_size Page size
405
- # @option opts [Integer] :page_number Page number
406
- # @option opts [String] :name Name
407
- # @return [EvaluationFormEntityListing]
408
- def get_publishedforms(opts = {})
409
- data, status_code, headers = get_publishedforms_with_http_info(opts)
410
- return data
411
- end
412
-
413
- # Get the published evaluation forms.
414
- #
415
- # @param [Hash] opts the optional parameters
416
- # @option opts [Integer] :page_size Page size
417
- # @option opts [Integer] :page_number Page number
418
- # @option opts [String] :name Name
419
- # @return [Array<(EvaluationFormEntityListing, Fixnum, Hash)>] EvaluationFormEntityListing data, response status code and response headers
420
- def get_publishedforms_with_http_info(opts = {})
421
- if @api_client.config.debugging
422
- @api_client.config.logger.debug "Calling API: ScriptsApi#get_publishedforms ..."
423
- end
424
-
425
- # resource path
426
- path = "/api/v2/quality/publishedforms".sub('{format}','json')
427
-
428
- # query parameters
429
- query_params = {}
430
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
431
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
432
- query_params[:'name'] = opts[:'name'] if opts[:'name']
433
-
434
- # header parameters
435
- header_params = {}
436
-
437
- # HTTP header 'Accept' (if needed)
438
- _header_accept = ['application/json']
439
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
440
-
441
- # HTTP header 'Content-Type'
442
- _header_content_type = ['application/json']
443
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
444
-
445
- # form parameters
446
- form_params = {}
447
-
448
- # http body (model)
449
- post_body = nil
450
-
451
-
452
- auth_names = ['PureCloud Auth']
453
- data, status_code, headers = @api_client.call_api(:GET, path,
454
- :header_params => header_params,
455
- :query_params => query_params,
456
- :form_params => form_params,
457
- :body => post_body,
458
- :auth_names => auth_names,
459
- :return_type => 'EvaluationFormEntityListing')
460
- if @api_client.config.debugging
461
- @api_client.config.logger.debug "API called: ScriptsApi#get_publishedforms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
462
- end
463
- return data, status_code, headers
464
- end
465
-
466
- # Publish an evaluation form.
467
- #
468
- # @param [Hash] opts the optional parameters
469
- # @option opts [EvaluationForm] :body
470
- # @return [EvaluationForm]
471
- def post_publishedforms(opts = {})
472
- data, status_code, headers = post_publishedforms_with_http_info(opts)
473
- return data
474
- end
475
-
476
- # Publish an evaluation form.
477
- #
478
- # @param [Hash] opts the optional parameters
479
- # @option opts [EvaluationForm] :body
480
- # @return [Array<(EvaluationForm, Fixnum, Hash)>] EvaluationForm data, response status code and response headers
481
- def post_publishedforms_with_http_info(opts = {})
482
- if @api_client.config.debugging
483
- @api_client.config.logger.debug "Calling API: ScriptsApi#post_publishedforms ..."
484
- end
485
-
486
- # resource path
487
- path = "/api/v2/quality/publishedforms".sub('{format}','json')
488
-
489
- # query parameters
490
- query_params = {}
491
-
492
- # header parameters
493
- header_params = {}
494
-
495
- # HTTP header 'Accept' (if needed)
496
- _header_accept = ['application/json']
497
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
498
-
499
- # HTTP header 'Content-Type'
500
- _header_content_type = ['application/json']
501
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
502
-
503
- # form parameters
504
- form_params = {}
505
-
506
- # http body (model)
507
- post_body = @api_client.object_to_http_body(opts[:'body'])
508
-
509
-
510
- auth_names = ['PureCloud Auth']
511
- data, status_code, headers = @api_client.call_api(:POST, path,
512
- :header_params => header_params,
513
- :query_params => query_params,
514
- :form_params => form_params,
515
- :body => post_body,
516
- :auth_names => auth_names,
517
- :return_type => 'EvaluationForm')
518
- if @api_client.config.debugging
519
- @api_client.config.logger.debug "API called: ScriptsApi#post_publishedforms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
520
- end
521
- return data, status_code, headers
522
- end
523
-
524
- # Get the published evaluation forms.
525
- #
526
- # @param form_id Form ID
527
- # @param [Hash] opts the optional parameters
528
- # @return [EvaluationForm]
529
- def get_publishedforms_form_id(form_id, opts = {})
530
- data, status_code, headers = get_publishedforms_form_id_with_http_info(form_id, opts)
531
- return data
532
- end
533
-
534
- # Get the published evaluation forms.
535
- #
536
- # @param form_id Form ID
537
- # @param [Hash] opts the optional parameters
538
- # @return [Array<(EvaluationForm, Fixnum, Hash)>] EvaluationForm data, response status code and response headers
539
- def get_publishedforms_form_id_with_http_info(form_id, opts = {})
540
- if @api_client.config.debugging
541
- @api_client.config.logger.debug "Calling API: ScriptsApi#get_publishedforms_form_id ..."
542
- end
543
-
544
- # verify the required parameter 'form_id' is set
545
- fail "Missing the required parameter 'form_id' when calling get_publishedforms_form_id" if form_id.nil?
546
-
547
- # resource path
548
- path = "/api/v2/quality/publishedforms/{formId}".sub('{format}','json').sub('{' + 'formId' + '}', form_id.to_s)
549
-
550
- # query parameters
551
- query_params = {}
552
-
553
- # header parameters
554
- header_params = {}
555
-
556
- # HTTP header 'Accept' (if needed)
557
- _header_accept = ['application/json']
558
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
559
-
560
- # HTTP header 'Content-Type'
561
- _header_content_type = ['application/json']
562
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
563
-
564
- # form parameters
565
- form_params = {}
566
-
567
- # http body (model)
568
- post_body = nil
569
-
570
-
571
- auth_names = ['PureCloud Auth']
572
- data, status_code, headers = @api_client.call_api(:GET, path,
573
- :header_params => header_params,
574
- :query_params => query_params,
575
- :form_params => form_params,
576
- :body => post_body,
577
- :auth_names => auth_names,
578
- :return_type => 'EvaluationForm')
579
- if @api_client.config.debugging
580
- @api_client.config.logger.debug "API called: ScriptsApi#get_publishedforms_form_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
581
- end
582
- return data, status_code, headers
583
- end
584
-
585
- # Get the list of scripts
586
- #
587
- # @param [Hash] opts the optional parameters
588
- # @option opts [Integer] :page_size Page size
589
- # @option opts [Integer] :page_number Page number
590
- # @option opts [String] :expand Expand
591
- # @option opts [String] :name Name
592
- # @option opts [String] :feature Feature
593
- # @return [ScriptEntityListing]
594
- def get_scripts(opts = {})
595
- data, status_code, headers = get_scripts_with_http_info(opts)
596
- return data
597
- end
598
-
599
- # Get the list of scripts
600
- #
601
- # @param [Hash] opts the optional parameters
602
- # @option opts [Integer] :page_size Page size
603
- # @option opts [Integer] :page_number Page number
604
- # @option opts [String] :expand Expand
605
- # @option opts [String] :name Name
606
- # @option opts [String] :feature Feature
607
- # @return [Array<(ScriptEntityListing, Fixnum, Hash)>] ScriptEntityListing data, response status code and response headers
608
- def get_scripts_with_http_info(opts = {})
609
- if @api_client.config.debugging
610
- @api_client.config.logger.debug "Calling API: ScriptsApi#get_scripts ..."
611
- end
612
-
613
- # resource path
614
- path = "/api/v2/scripts".sub('{format}','json')
615
-
616
- # query parameters
617
- query_params = {}
618
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
619
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
620
- query_params[:'expand'] = opts[:'expand'] if opts[:'expand']
621
- query_params[:'name'] = opts[:'name'] if opts[:'name']
622
- query_params[:'feature'] = opts[:'feature'] if opts[:'feature']
623
-
624
- # header parameters
625
- header_params = {}
626
-
627
- # HTTP header 'Accept' (if needed)
628
- _header_accept = ['application/json']
629
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
630
-
631
- # HTTP header 'Content-Type'
632
- _header_content_type = ['application/json']
633
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
634
-
635
- # form parameters
636
- form_params = {}
637
-
638
- # http body (model)
639
- post_body = nil
640
-
641
-
642
- auth_names = ['PureCloud Auth']
643
- data, status_code, headers = @api_client.call_api(:GET, path,
644
- :header_params => header_params,
645
- :query_params => query_params,
646
- :form_params => form_params,
647
- :body => post_body,
648
- :auth_names => auth_names,
649
- :return_type => 'ScriptEntityListing')
650
- if @api_client.config.debugging
651
- @api_client.config.logger.debug "API called: ScriptsApi#get_scripts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
652
- end
653
- return data, status_code, headers
654
- end
655
-
656
- # Create a script.
657
- #
658
- # @param [Hash] opts the optional parameters
659
- # @option opts [Body] :body
660
- # @return [Script]
661
- def post_scripts(opts = {})
662
- data, status_code, headers = post_scripts_with_http_info(opts)
663
- return data
664
- end
665
-
666
- # Create a script.
667
- #
668
- # @param [Hash] opts the optional parameters
669
- # @option opts [Body] :body
670
- # @return [Array<(Script, Fixnum, Hash)>] Script data, response status code and response headers
671
- def post_scripts_with_http_info(opts = {})
672
- if @api_client.config.debugging
673
- @api_client.config.logger.debug "Calling API: ScriptsApi#post_scripts ..."
674
- end
675
-
676
- # resource path
677
- path = "/api/v2/scripts".sub('{format}','json')
678
-
679
- # query parameters
680
- query_params = {}
681
-
682
- # header parameters
683
- header_params = {}
684
-
685
- # HTTP header 'Accept' (if needed)
686
- _header_accept = ['application/json']
687
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
688
-
689
- # HTTP header 'Content-Type'
690
- _header_content_type = ['application/json']
691
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
692
-
693
- # form parameters
694
- form_params = {}
695
-
696
- # http body (model)
697
- post_body = @api_client.object_to_http_body(opts[:'body'])
698
-
699
-
700
- auth_names = ['PureCloud Auth']
701
- data, status_code, headers = @api_client.call_api(:POST, path,
702
- :header_params => header_params,
703
- :query_params => query_params,
704
- :form_params => form_params,
705
- :body => post_body,
706
- :auth_names => auth_names,
707
- :return_type => 'Script')
708
- if @api_client.config.debugging
709
- @api_client.config.logger.debug "API called: ScriptsApi#post_scripts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
710
- end
711
- return data, status_code, headers
712
- end
713
- end
714
- end
715
-
716
-
717
-
718
-