purecloud 0.63.1 → 0.64.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 (262) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/config-ruby.json +1 -1
  4. data/doc_out/ADFS.html.md +1 -1
  5. data/doc_out/AggregationQuery.html.md +1 -1
  6. data/doc_out/AnalyticsConversationSegment.html.md +3 -3
  7. data/doc_out/AnalyticsSession.html.md +2 -2
  8. data/doc_out/AttributesApi.html.md +29 -29
  9. data/doc_out/AuditMessage.html.md +1 -1
  10. data/doc_out/Call.html.md +4 -4
  11. data/doc_out/CallForwarding.html.md +1 -1
  12. data/doc_out/CallMediaParticipant.html.md +6 -6
  13. data/doc_out/Callback.html.md +2 -2
  14. data/doc_out/CallbackMediaParticipant.html.md +4 -4
  15. data/doc_out/Campaign.html.md +1 -1
  16. data/doc_out/CampaignInteraction.html.md +1 -1
  17. data/doc_out/CampaignRule.html.md +2 -2
  18. data/doc_out/CampaignRuleActionEntities.html.md +1 -1
  19. data/doc_out/CampaignSequence.html.md +1 -1
  20. data/doc_out/CertificateDetails.html.md +3 -3
  21. data/doc_out/ChatMediaParticipant.html.md +3 -3
  22. data/doc_out/CobrowseMediaParticipant.html.md +3 -3
  23. data/doc_out/Condition.html.md +1 -1
  24. data/doc_out/ContactSort.html.md +1 -1
  25. data/doc_out/ContentQueryRequest.html.md +1 -1
  26. data/doc_out/ContentSortItem.html.md +1 -1
  27. data/doc_out/ConversationChat.html.md +1 -1
  28. data/doc_out/ConversationsApi.html.md +58 -58
  29. data/doc_out/CustomerInteractionCenter.html.md +1 -1
  30. data/doc_out/DialerContact.html.md +1 -1
  31. data/doc_out/Document.html.md +1 -1
  32. data/doc_out/DocumentAudit.html.md +1 -1
  33. data/doc_out/DocumentUpdate.html.md +1 -1
  34. data/doc_out/DomainCapabilities.html.md +4 -4
  35. data/doc_out/DomainEdgeSoftwareUpdateDto.html.md +2 -2
  36. data/doc_out/DomainEdgeSoftwareVersionDto.html.md +2 -2
  37. data/doc_out/DomainLogicalInterface.html.md +3 -3
  38. data/doc_out/DomainNetworkAddress.html.md +1 -1
  39. data/doc_out/DomainNetworkCommandResponse.html.md +1 -1
  40. data/doc_out/DomainNetworkRoute.html.md +1 -1
  41. data/doc_out/DomainOrganizationRole.html.md +3 -3
  42. data/doc_out/DomainOrganizationRoleCreate.html.md +3 -3
  43. data/doc_out/DomainOrganizationRoleUpdate.html.md +3 -3
  44. data/doc_out/DomainPermission.html.md +1 -1
  45. data/doc_out/DomainPermissionPolicy.html.md +1 -1
  46. data/doc_out/DomainPhysicalCapabilities.html.md +2 -2
  47. data/doc_out/Edge.html.md +2 -2
  48. data/doc_out/EdgeAutoUpdateConfig.html.md +2 -2
  49. data/doc_out/EdgeGroup.html.md +1 -1
  50. data/doc_out/EdgeLogsJobRequest.html.md +1 -1
  51. data/doc_out/Email.html.md +1 -1
  52. data/doc_out/EmailMediaParticipant.html.md +3 -3
  53. data/doc_out/Endpoint.html.md +1 -1
  54. data/doc_out/Evaluation.html.md +4 -4
  55. data/doc_out/EvaluationForm.html.md +1 -1
  56. data/doc_out/EvaluationScoringSet.html.md +1 -1
  57. data/doc_out/FaxDocument.html.md +1 -1
  58. data/doc_out/FieldList.html.md +3 -3
  59. data/doc_out/Geolocation.html.md +1 -1
  60. data/doc_out/GeolocationSettings.html.md +1 -1
  61. data/doc_out/GreetingsApi.html.md +50 -50
  62. data/doc_out/Group.html.md +1 -1
  63. data/doc_out/GroupUpdate.html.md +1 -1
  64. data/doc_out/GroupsApi.html.md +68 -68
  65. data/doc_out/HeartBeatRule.html.md +2 -2
  66. data/doc_out/IdentityProviderApi.html.md +22 -22
  67. data/doc_out/InboundDomain.html.md +1 -1
  68. data/doc_out/InitiateScreenRecording.html.md +1 -1
  69. data/doc_out/InteractionStatsAlert.html.md +1 -1
  70. data/doc_out/InteractionStatsRule.html.md +2 -2
  71. data/doc_out/JsonNode.html.md +20 -20
  72. data/doc_out/LineStatus.html.md +1 -1
  73. data/doc_out/LocationDefinition.html.md +1 -1
  74. data/doc_out/MediaParticipantRequest.html.md +5 -5
  75. data/doc_out/MeteredEvaluationAssignment.html.md +1 -1
  76. data/doc_out/OAuthProvider.html.md +1 -1
  77. data/doc_out/Okta.html.md +1 -1
  78. data/doc_out/OneLogin.html.md +1 -1
  79. data/doc_out/OrgMediaUtilization.html.md +1 -1
  80. data/doc_out/Organization.html.md +1 -1
  81. data/doc_out/OrganizationPresence.html.md +2 -2
  82. data/doc_out/OutOfOffice.html.md +1 -1
  83. data/doc_out/OutboundRoute.html.md +2 -2
  84. data/doc_out/Parameter.html.md +1 -1
  85. data/doc_out/Participant.html.md +2 -2
  86. data/doc_out/PhoneCapabilities.html.md +5 -5
  87. data/doc_out/PhoneNumberStatus.html.md +1 -1
  88. data/doc_out/Policy.html.md +1 -1
  89. data/doc_out/PolicyActions.html.md +3 -3
  90. data/doc_out/PolicyCreate.html.md +1 -1
  91. data/doc_out/PresenceApi.html.md +33 -33
  92. data/doc_out/PureCloud.html.md +1 -1
  93. data/doc_out/QueryRequest.html.md +1 -1
  94. data/doc_out/QuestionGroup.html.md +4 -4
  95. data/doc_out/QuestionGroupScore.html.md +1 -1
  96. data/doc_out/QuestionScore.html.md +2 -2
  97. data/doc_out/QueueMember.html.md +1 -1
  98. data/doc_out/RecordingApi.html.md +70 -70
  99. data/doc_out/ReportSchedule.html.md +1 -1
  100. data/doc_out/ResourcePermissionPolicy.html.md +1 -1
  101. data/doc_out/RoutingStatusRule.html.md +2 -2
  102. data/doc_out/Salesforce.html.md +1 -1
  103. data/doc_out/Screenshare.html.md +1 -1
  104. data/doc_out/ScriptsApi.html.md +72 -72
  105. data/doc_out/Site.html.md +1 -1
  106. data/doc_out/SocialExpression.html.md +1 -1
  107. data/doc_out/SortItem.html.md +1 -1
  108. data/doc_out/TagValue.html.md +1 -1
  109. data/doc_out/TimeAllowed.html.md +1 -1
  110. data/doc_out/TimeOffRequest.html.md +2 -2
  111. data/doc_out/TimeOffRequestPatch.html.md +1 -1
  112. data/doc_out/TransferRequest.html.md +1 -1
  113. data/doc_out/Trunk.html.md +1 -1
  114. data/doc_out/TrunkBase.html.md +1 -1
  115. data/doc_out/UnreadStatus.html.md +1 -1
  116. data/doc_out/UserPresence.html.md +1 -1
  117. data/doc_out/UserPresenceRule.html.md +2 -2
  118. data/doc_out/UserQueue.html.md +1 -1
  119. data/doc_out/UserRecording.html.md +1 -1
  120. data/doc_out/UserRecordingsApi.html.md +47 -47
  121. data/doc_out/UserScheduleAdherence.html.md +1 -1
  122. data/doc_out/ValidateAddressResponse.html.md +1 -1
  123. data/doc_out/Video.html.md +3 -3
  124. data/doc_out/VoicemailGroupPolicy.html.md +2 -2
  125. data/doc_out/VoicemailMessage.html.md +2 -2
  126. data/doc_out/VoicemailOrganizationPolicy.html.md +4 -4
  127. data/doc_out/VoicemailUserPolicy.html.md +1 -1
  128. data/doc_out/Workspace.html.md +1 -1
  129. data/doc_out/Wrapup.html.md +1 -1
  130. data/doc_out/index.html.md +3 -3
  131. data/lib/purecloud/api/attributes_api.rb +39 -39
  132. data/lib/purecloud/api/conversations_api.rb +58 -58
  133. data/lib/purecloud/api/greetings_api.rb +67 -67
  134. data/lib/purecloud/api/groups_api.rb +104 -104
  135. data/lib/purecloud/api/identity_provider_api.rb +33 -33
  136. data/lib/purecloud/api/presence_api.rb +46 -46
  137. data/lib/purecloud/api/recording_api.rb +76 -76
  138. data/lib/purecloud/api/scripts_api.rb +87 -87
  139. data/lib/purecloud/api/user_recordings_api.rb +64 -64
  140. data/lib/purecloud/api_client.rb +1 -1
  141. data/lib/purecloud/models/adfs.rb +2 -0
  142. data/lib/purecloud/models/aggregation_query.rb +2 -0
  143. data/lib/purecloud/models/analytics_conversation_segment.rb +6 -0
  144. data/lib/purecloud/models/analytics_session.rb +4 -0
  145. data/lib/purecloud/models/audit_message.rb +2 -0
  146. data/lib/purecloud/models/call.rb +8 -0
  147. data/lib/purecloud/models/call_forwarding.rb +2 -0
  148. data/lib/purecloud/models/call_media_participant.rb +12 -0
  149. data/lib/purecloud/models/callback.rb +4 -0
  150. data/lib/purecloud/models/callback_media_participant.rb +8 -0
  151. data/lib/purecloud/models/campaign.rb +2 -0
  152. data/lib/purecloud/models/campaign_interaction.rb +2 -0
  153. data/lib/purecloud/models/campaign_rule.rb +4 -0
  154. data/lib/purecloud/models/campaign_rule_action_entities.rb +2 -0
  155. data/lib/purecloud/models/campaign_sequence.rb +2 -0
  156. data/lib/purecloud/models/certificate_details.rb +6 -0
  157. data/lib/purecloud/models/chat_media_participant.rb +6 -0
  158. data/lib/purecloud/models/cobrowse_media_participant.rb +6 -0
  159. data/lib/purecloud/models/condition.rb +2 -0
  160. data/lib/purecloud/models/contact_sort.rb +2 -0
  161. data/lib/purecloud/models/content_query_request.rb +2 -0
  162. data/lib/purecloud/models/content_sort_item.rb +2 -0
  163. data/lib/purecloud/models/conversation_chat.rb +2 -0
  164. data/lib/purecloud/models/customer_interaction_center.rb +2 -0
  165. data/lib/purecloud/models/dialer_contact.rb +2 -0
  166. data/lib/purecloud/models/document.rb +2 -0
  167. data/lib/purecloud/models/document_audit.rb +2 -0
  168. data/lib/purecloud/models/document_update.rb +2 -0
  169. data/lib/purecloud/models/domain_capabilities.rb +8 -0
  170. data/lib/purecloud/models/domain_edge_software_update_dto.rb +4 -0
  171. data/lib/purecloud/models/domain_edge_software_version_dto.rb +4 -0
  172. data/lib/purecloud/models/domain_logical_interface.rb +6 -0
  173. data/lib/purecloud/models/domain_network_address.rb +2 -0
  174. data/lib/purecloud/models/domain_network_command_response.rb +2 -0
  175. data/lib/purecloud/models/domain_network_route.rb +2 -0
  176. data/lib/purecloud/models/domain_organization_role.rb +17 -11
  177. data/lib/purecloud/models/domain_organization_role_create.rb +17 -11
  178. data/lib/purecloud/models/domain_organization_role_update.rb +17 -11
  179. data/lib/purecloud/models/domain_permission.rb +2 -0
  180. data/lib/purecloud/models/domain_permission_policy.rb +2 -0
  181. data/lib/purecloud/models/domain_physical_capabilities.rb +4 -0
  182. data/lib/purecloud/models/edge.rb +4 -0
  183. data/lib/purecloud/models/edge_auto_update_config.rb +4 -4
  184. data/lib/purecloud/models/edge_group.rb +2 -0
  185. data/lib/purecloud/models/edge_logs_job_request.rb +2 -0
  186. data/lib/purecloud/models/email.rb +2 -0
  187. data/lib/purecloud/models/email_media_participant.rb +6 -0
  188. data/lib/purecloud/models/endpoint.rb +2 -0
  189. data/lib/purecloud/models/evaluation.rb +8 -0
  190. data/lib/purecloud/models/evaluation_form.rb +2 -0
  191. data/lib/purecloud/models/evaluation_scoring_set.rb +2 -0
  192. data/lib/purecloud/models/fax_document.rb +2 -0
  193. data/lib/purecloud/models/field_list.rb +6 -0
  194. data/lib/purecloud/models/geolocation.rb +2 -0
  195. data/lib/purecloud/models/geolocation_settings.rb +2 -0
  196. data/lib/purecloud/models/group.rb +2 -0
  197. data/lib/purecloud/models/group_update.rb +2 -0
  198. data/lib/purecloud/models/heart_beat_rule.rb +4 -0
  199. data/lib/purecloud/models/inbound_domain.rb +2 -0
  200. data/lib/purecloud/models/initiate_screen_recording.rb +2 -0
  201. data/lib/purecloud/models/interaction_stats_alert.rb +2 -0
  202. data/lib/purecloud/models/interaction_stats_rule.rb +4 -0
  203. data/lib/purecloud/models/json_node.rb +64 -24
  204. data/lib/purecloud/models/line_status.rb +2 -0
  205. data/lib/purecloud/models/location_definition.rb +2 -0
  206. data/lib/purecloud/models/media_participant_request.rb +10 -0
  207. data/lib/purecloud/models/metered_evaluation_assignment.rb +2 -0
  208. data/lib/purecloud/models/o_auth_provider.rb +2 -0
  209. data/lib/purecloud/models/okta.rb +2 -0
  210. data/lib/purecloud/models/one_login.rb +2 -0
  211. data/lib/purecloud/models/org_media_utilization.rb +2 -0
  212. data/lib/purecloud/models/organization.rb +2 -0
  213. data/lib/purecloud/models/organization_presence.rb +4 -0
  214. data/lib/purecloud/models/out_of_office.rb +2 -0
  215. data/lib/purecloud/models/outbound_route.rb +4 -0
  216. data/lib/purecloud/models/parameter.rb +2 -0
  217. data/lib/purecloud/models/participant.rb +4 -0
  218. data/lib/purecloud/models/phone_capabilities.rb +10 -0
  219. data/lib/purecloud/models/phone_number_status.rb +2 -0
  220. data/lib/purecloud/models/policy.rb +2 -0
  221. data/lib/purecloud/models/policy_actions.rb +6 -0
  222. data/lib/purecloud/models/policy_create.rb +2 -0
  223. data/lib/purecloud/models/pure_cloud.rb +2 -0
  224. data/lib/purecloud/models/query_request.rb +2 -0
  225. data/lib/purecloud/models/question_group.rb +8 -0
  226. data/lib/purecloud/models/question_group_score.rb +2 -0
  227. data/lib/purecloud/models/question_score.rb +4 -0
  228. data/lib/purecloud/models/queue_member.rb +2 -0
  229. data/lib/purecloud/models/report_schedule.rb +2 -0
  230. data/lib/purecloud/models/resource_permission_policy.rb +2 -0
  231. data/lib/purecloud/models/routing_status_rule.rb +4 -0
  232. data/lib/purecloud/models/salesforce.rb +2 -0
  233. data/lib/purecloud/models/screenshare.rb +2 -0
  234. data/lib/purecloud/models/site.rb +2 -0
  235. data/lib/purecloud/models/social_expression.rb +2 -0
  236. data/lib/purecloud/models/sort_item.rb +2 -0
  237. data/lib/purecloud/models/tag_value.rb +2 -0
  238. data/lib/purecloud/models/time_allowed.rb +2 -0
  239. data/lib/purecloud/models/time_off_request.rb +4 -0
  240. data/lib/purecloud/models/time_off_request_patch.rb +2 -0
  241. data/lib/purecloud/models/transfer_request.rb +2 -0
  242. data/lib/purecloud/models/trunk.rb +2 -0
  243. data/lib/purecloud/models/trunk_base.rb +2 -0
  244. data/lib/purecloud/models/unread_status.rb +2 -0
  245. data/lib/purecloud/models/user_presence.rb +2 -0
  246. data/lib/purecloud/models/user_presence_rule.rb +4 -0
  247. data/lib/purecloud/models/user_queue.rb +2 -0
  248. data/lib/purecloud/models/user_recording.rb +2 -0
  249. data/lib/purecloud/models/user_schedule_adherence.rb +2 -0
  250. data/lib/purecloud/models/validate_address_response.rb +2 -0
  251. data/lib/purecloud/models/video.rb +6 -0
  252. data/lib/purecloud/models/voicemail_group_policy.rb +4 -0
  253. data/lib/purecloud/models/voicemail_message.rb +4 -0
  254. data/lib/purecloud/models/voicemail_organization_policy.rb +8 -0
  255. data/lib/purecloud/models/voicemail_user_policy.rb +2 -0
  256. data/lib/purecloud/models/workspace.rb +2 -0
  257. data/lib/purecloud/models/wrapup.rb +2 -0
  258. data/lib/purecloud/version.rb +1 -1
  259. data/newVersion.md +1 -1
  260. data/swagger.json +1 -1
  261. data/version.json +1 -1
  262. metadata +2 -2
@@ -149,74 +149,6 @@ module PureCloud
149
149
  return data, status_code, headers
150
150
  end
151
151
 
152
- # Get a group list
153
- #
154
- # @param [Hash] opts the optional parameters
155
- # @option opts [Integer] :page_size Page size (default to 25)
156
- # @option opts [Integer] :page_number Page number (default to 1)
157
- # @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
158
- # @return [GroupEntityListing]
159
- def get(opts = {})
160
- data, status_code, headers = get_with_http_info(opts)
161
- return data
162
- end
163
-
164
- # Get a group list
165
- #
166
- # @param [Hash] opts the optional parameters
167
- # @option opts [Integer] :page_size Page size
168
- # @option opts [Integer] :page_number Page number
169
- # @option opts [String] :sort_order Ascending or descending sort order
170
- # @return [Array<(GroupEntityListing, Fixnum, Hash)>] GroupEntityListing data, response status code and response headers
171
- def get_with_http_info(opts = {})
172
- if @api_client.config.debugging
173
- @api_client.config.logger.debug "Calling API: GroupsApi#get ..."
174
- end
175
-
176
- if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
177
- fail 'invalid value for "sort_order", must be one of ascending, descending'
178
- end
179
-
180
- # resource path
181
- local_var_path = "/api/v2/groups".sub('{format}','json')
182
-
183
- # query parameters
184
- query_params = {}
185
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
186
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
187
- query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
188
-
189
- # header parameters
190
- header_params = {}
191
-
192
- # HTTP header 'Accept' (if needed)
193
- _header_accept = ['application/json']
194
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
195
-
196
- # HTTP header 'Content-Type'
197
- _header_content_type = ['application/json']
198
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
199
-
200
- # form parameters
201
- form_params = {}
202
-
203
- # http body (model)
204
- post_body = nil
205
-
206
- auth_names = ['PureCloud Auth']
207
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
208
- :header_params => header_params,
209
- :query_params => query_params,
210
- :form_params => form_params,
211
- :body => post_body,
212
- :auth_names => auth_names,
213
- :return_type => 'GroupEntityListing')
214
- if @api_client.config.debugging
215
- @api_client.config.logger.debug "API called: GroupsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
216
- end
217
- return data, status_code, headers
218
- end
219
-
220
152
  # Fetch field config for an entity type
221
153
  #
222
154
  # @param type Field type
@@ -417,38 +349,42 @@ module PureCloud
417
349
  return data, status_code, headers
418
350
  end
419
351
 
420
- # Search groups using the q64 value returned from a previous search
352
+ # Get a group list
421
353
  #
422
- # @param q64 q64
423
354
  # @param [Hash] opts the optional parameters
424
- # @option opts [Array<String>] :expand expand
425
- # @return [GroupsSearchResponse]
426
- def get_search(q64, opts = {})
427
- data, status_code, headers = get_search_with_http_info(q64, opts)
355
+ # @option opts [Integer] :page_size Page size (default to 25)
356
+ # @option opts [Integer] :page_number Page number (default to 1)
357
+ # @option opts [String] :sort_order Ascending or descending sort order (default to ASC)
358
+ # @return [GroupEntityListing]
359
+ def get_groups(opts = {})
360
+ data, status_code, headers = get_groups_with_http_info(opts)
428
361
  return data
429
362
  end
430
363
 
431
- # Search groups using the q64 value returned from a previous search
364
+ # Get a group list
432
365
  #
433
- # @param q64 q64
434
366
  # @param [Hash] opts the optional parameters
435
- # @option opts [Array<String>] :expand expand
436
- # @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse data, response status code and response headers
437
- def get_search_with_http_info(q64, opts = {})
367
+ # @option opts [Integer] :page_size Page size
368
+ # @option opts [Integer] :page_number Page number
369
+ # @option opts [String] :sort_order Ascending or descending sort order
370
+ # @return [Array<(GroupEntityListing, Fixnum, Hash)>] GroupEntityListing data, response status code and response headers
371
+ def get_groups_with_http_info(opts = {})
438
372
  if @api_client.config.debugging
439
- @api_client.config.logger.debug "Calling API: GroupsApi#get_search ..."
373
+ @api_client.config.logger.debug "Calling API: GroupsApi#get_groups ..."
440
374
  end
441
375
 
442
- # verify the required parameter 'q64' is set
443
- fail "Missing the required parameter 'q64' when calling get_search" if q64.nil?
376
+ if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
377
+ fail 'invalid value for "sort_order", must be one of ascending, descending'
378
+ end
444
379
 
445
380
  # resource path
446
- local_var_path = "/api/v2/groups/search".sub('{format}','json')
381
+ local_var_path = "/api/v2/groups".sub('{format}','json')
447
382
 
448
383
  # query parameters
449
384
  query_params = {}
450
- query_params[:'q64'] = q64
451
- query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
385
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
386
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
387
+ query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
452
388
 
453
389
  # header parameters
454
390
  header_params = {}
@@ -474,41 +410,45 @@ module PureCloud
474
410
  :form_params => form_params,
475
411
  :body => post_body,
476
412
  :auth_names => auth_names,
477
- :return_type => 'GroupsSearchResponse')
413
+ :return_type => 'GroupEntityListing')
478
414
  if @api_client.config.debugging
479
- @api_client.config.logger.debug "API called: GroupsApi#get_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
415
+ @api_client.config.logger.debug "API called: GroupsApi#get_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
480
416
  end
481
417
  return data, status_code, headers
482
418
  end
483
419
 
484
- # Create a group
420
+ # Search groups using the q64 value returned from a previous search
485
421
  #
486
- # @param body Group
422
+ # @param q64 q64
487
423
  # @param [Hash] opts the optional parameters
488
- # @return [Group]
489
- def post(body, opts = {})
490
- data, status_code, headers = post_with_http_info(body, opts)
424
+ # @option opts [Array<String>] :expand expand
425
+ # @return [GroupsSearchResponse]
426
+ def get_search(q64, opts = {})
427
+ data, status_code, headers = get_search_with_http_info(q64, opts)
491
428
  return data
492
429
  end
493
430
 
494
- # Create a group
431
+ # Search groups using the q64 value returned from a previous search
495
432
  #
496
- # @param body Group
433
+ # @param q64 q64
497
434
  # @param [Hash] opts the optional parameters
498
- # @return [Array<(Group, Fixnum, Hash)>] Group data, response status code and response headers
499
- def post_with_http_info(body, opts = {})
435
+ # @option opts [Array<String>] :expand expand
436
+ # @return [Array<(GroupsSearchResponse, Fixnum, Hash)>] GroupsSearchResponse data, response status code and response headers
437
+ def get_search_with_http_info(q64, opts = {})
500
438
  if @api_client.config.debugging
501
- @api_client.config.logger.debug "Calling API: GroupsApi#post ..."
439
+ @api_client.config.logger.debug "Calling API: GroupsApi#get_search ..."
502
440
  end
503
441
 
504
- # verify the required parameter 'body' is set
505
- fail "Missing the required parameter 'body' when calling post" if body.nil?
442
+ # verify the required parameter 'q64' is set
443
+ fail "Missing the required parameter 'q64' when calling get_search" if q64.nil?
506
444
 
507
445
  # resource path
508
- local_var_path = "/api/v2/groups".sub('{format}','json')
446
+ local_var_path = "/api/v2/groups/search".sub('{format}','json')
509
447
 
510
448
  # query parameters
511
449
  query_params = {}
450
+ query_params[:'q64'] = q64
451
+ query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
512
452
 
513
453
  # header parameters
514
454
  header_params = {}
@@ -525,18 +465,18 @@ module PureCloud
525
465
  form_params = {}
526
466
 
527
467
  # http body (model)
528
- post_body = @api_client.object_to_http_body(body)
468
+ post_body = nil
529
469
 
530
470
  auth_names = ['PureCloud Auth']
531
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
471
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
532
472
  :header_params => header_params,
533
473
  :query_params => query_params,
534
474
  :form_params => form_params,
535
475
  :body => post_body,
536
476
  :auth_names => auth_names,
537
- :return_type => 'Group')
477
+ :return_type => 'GroupsSearchResponse')
538
478
  if @api_client.config.debugging
539
- @api_client.config.logger.debug "API called: GroupsApi#post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
479
+ @api_client.config.logger.debug "API called: GroupsApi#get_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
540
480
  end
541
481
  return data, status_code, headers
542
482
  end
@@ -605,6 +545,66 @@ module PureCloud
605
545
  return data, status_code, headers
606
546
  end
607
547
 
548
+ # Create a group
549
+ #
550
+ # @param body Group
551
+ # @param [Hash] opts the optional parameters
552
+ # @return [Group]
553
+ def post_groups(body, opts = {})
554
+ data, status_code, headers = post_groups_with_http_info(body, opts)
555
+ return data
556
+ end
557
+
558
+ # Create a group
559
+ #
560
+ # @param body Group
561
+ # @param [Hash] opts the optional parameters
562
+ # @return [Array<(Group, Fixnum, Hash)>] Group data, response status code and response headers
563
+ def post_groups_with_http_info(body, opts = {})
564
+ if @api_client.config.debugging
565
+ @api_client.config.logger.debug "Calling API: GroupsApi#post_groups ..."
566
+ end
567
+
568
+ # verify the required parameter 'body' is set
569
+ fail "Missing the required parameter 'body' when calling post_groups" if body.nil?
570
+
571
+ # resource path
572
+ local_var_path = "/api/v2/groups".sub('{format}','json')
573
+
574
+ # query parameters
575
+ query_params = {}
576
+
577
+ # header parameters
578
+ header_params = {}
579
+
580
+ # HTTP header 'Accept' (if needed)
581
+ _header_accept = ['application/json']
582
+ _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
583
+
584
+ # HTTP header 'Content-Type'
585
+ _header_content_type = ['application/json']
586
+ header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
587
+
588
+ # form parameters
589
+ form_params = {}
590
+
591
+ # http body (model)
592
+ post_body = @api_client.object_to_http_body(body)
593
+
594
+ auth_names = ['PureCloud Auth']
595
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
596
+ :header_params => header_params,
597
+ :query_params => query_params,
598
+ :form_params => form_params,
599
+ :body => post_body,
600
+ :auth_names => auth_names,
601
+ :return_type => 'Group')
602
+ if @api_client.config.debugging
603
+ @api_client.config.logger.debug "API called: GroupsApi#post_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
604
+ end
605
+ return data, status_code, headers
606
+ end
607
+
608
608
  # Search groups
609
609
  #
610
610
  # @param body Search request options
@@ -402,26 +402,26 @@ module PureCloud
402
402
  return data, status_code, headers
403
403
  end
404
404
 
405
- # The list of identity providers
405
+ # Get ADFS Identity Provider
406
406
  #
407
407
  # @param [Hash] opts the optional parameters
408
- # @return [OAuthProviderEntityListing]
409
- def get(opts = {})
410
- data, status_code, headers = get_with_http_info(opts)
408
+ # @return [ADFS]
409
+ def get_adfs(opts = {})
410
+ data, status_code, headers = get_adfs_with_http_info(opts)
411
411
  return data
412
412
  end
413
413
 
414
- # The list of identity providers
414
+ # Get ADFS Identity Provider
415
415
  #
416
416
  # @param [Hash] opts the optional parameters
417
- # @return [Array<(OAuthProviderEntityListing, Fixnum, Hash)>] OAuthProviderEntityListing data, response status code and response headers
418
- def get_with_http_info(opts = {})
417
+ # @return [Array<(ADFS, Fixnum, Hash)>] ADFS data, response status code and response headers
418
+ def get_adfs_with_http_info(opts = {})
419
419
  if @api_client.config.debugging
420
- @api_client.config.logger.debug "Calling API: IdentityProviderApi#get ..."
420
+ @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_adfs ..."
421
421
  end
422
422
 
423
423
  # resource path
424
- local_var_path = "/api/v2/identityproviders".sub('{format}','json')
424
+ local_var_path = "/api/v2/identityproviders/adfs".sub('{format}','json')
425
425
 
426
426
  # query parameters
427
427
  query_params = {}
@@ -450,33 +450,33 @@ module PureCloud
450
450
  :form_params => form_params,
451
451
  :body => post_body,
452
452
  :auth_names => auth_names,
453
- :return_type => 'OAuthProviderEntityListing')
453
+ :return_type => 'ADFS')
454
454
  if @api_client.config.debugging
455
- @api_client.config.logger.debug "API called: IdentityProviderApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
455
+ @api_client.config.logger.debug "API called: IdentityProviderApi#get_adfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
456
456
  end
457
457
  return data, status_code, headers
458
458
  end
459
459
 
460
- # Get ADFS Identity Provider
460
+ # Get Customer Interaction Center (CIC) Identity Provider
461
461
  #
462
462
  # @param [Hash] opts the optional parameters
463
- # @return [ADFS]
464
- def get_adfs(opts = {})
465
- data, status_code, headers = get_adfs_with_http_info(opts)
463
+ # @return [CustomerInteractionCenter]
464
+ def get_cic(opts = {})
465
+ data, status_code, headers = get_cic_with_http_info(opts)
466
466
  return data
467
467
  end
468
468
 
469
- # Get ADFS Identity Provider
469
+ # Get Customer Interaction Center (CIC) Identity Provider
470
470
  #
471
471
  # @param [Hash] opts the optional parameters
472
- # @return [Array<(ADFS, Fixnum, Hash)>] ADFS data, response status code and response headers
473
- def get_adfs_with_http_info(opts = {})
472
+ # @return [Array<(CustomerInteractionCenter, Fixnum, Hash)>] CustomerInteractionCenter data, response status code and response headers
473
+ def get_cic_with_http_info(opts = {})
474
474
  if @api_client.config.debugging
475
- @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_adfs ..."
475
+ @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_cic ..."
476
476
  end
477
477
 
478
478
  # resource path
479
- local_var_path = "/api/v2/identityproviders/adfs".sub('{format}','json')
479
+ local_var_path = "/api/v2/identityproviders/cic".sub('{format}','json')
480
480
 
481
481
  # query parameters
482
482
  query_params = {}
@@ -505,33 +505,33 @@ module PureCloud
505
505
  :form_params => form_params,
506
506
  :body => post_body,
507
507
  :auth_names => auth_names,
508
- :return_type => 'ADFS')
508
+ :return_type => 'CustomerInteractionCenter')
509
509
  if @api_client.config.debugging
510
- @api_client.config.logger.debug "API called: IdentityProviderApi#get_adfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
510
+ @api_client.config.logger.debug "API called: IdentityProviderApi#get_cic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
511
511
  end
512
512
  return data, status_code, headers
513
513
  end
514
514
 
515
- # Get Customer Interaction Center (CIC) Identity Provider
515
+ # The list of identity providers
516
516
  #
517
517
  # @param [Hash] opts the optional parameters
518
- # @return [CustomerInteractionCenter]
519
- def get_cic(opts = {})
520
- data, status_code, headers = get_cic_with_http_info(opts)
518
+ # @return [OAuthProviderEntityListing]
519
+ def get_identityproviders(opts = {})
520
+ data, status_code, headers = get_identityproviders_with_http_info(opts)
521
521
  return data
522
522
  end
523
523
 
524
- # Get Customer Interaction Center (CIC) Identity Provider
524
+ # The list of identity providers
525
525
  #
526
526
  # @param [Hash] opts the optional parameters
527
- # @return [Array<(CustomerInteractionCenter, Fixnum, Hash)>] CustomerInteractionCenter data, response status code and response headers
528
- def get_cic_with_http_info(opts = {})
527
+ # @return [Array<(OAuthProviderEntityListing, Fixnum, Hash)>] OAuthProviderEntityListing data, response status code and response headers
528
+ def get_identityproviders_with_http_info(opts = {})
529
529
  if @api_client.config.debugging
530
- @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_cic ..."
530
+ @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_identityproviders ..."
531
531
  end
532
532
 
533
533
  # resource path
534
- local_var_path = "/api/v2/identityproviders/cic".sub('{format}','json')
534
+ local_var_path = "/api/v2/identityproviders".sub('{format}','json')
535
535
 
536
536
  # query parameters
537
537
  query_params = {}
@@ -560,9 +560,9 @@ module PureCloud
560
560
  :form_params => form_params,
561
561
  :body => post_body,
562
562
  :auth_names => auth_names,
563
- :return_type => 'CustomerInteractionCenter')
563
+ :return_type => 'OAuthProviderEntityListing')
564
564
  if @api_client.config.debugging
565
- @api_client.config.logger.debug "API called: IdentityProviderApi#get_cic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
565
+ @api_client.config.logger.debug "API called: IdentityProviderApi#get_identityproviders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
566
566
  end
567
567
  return data, status_code, headers
568
568
  end
@@ -83,40 +83,36 @@ module PureCloud
83
83
  return data, status_code, headers
84
84
  end
85
85
 
86
- # Get an Organization's list of Presence Definitions
86
+ # Get a Presence Definition
87
87
  #
88
+ # @param presence_id Organization Presence ID
88
89
  # @param [Hash] opts the optional parameters
89
- # @option opts [Integer] :page_number Page number (default to 1)
90
- # @option opts [Integer] :page_size Page size (default to 25)
91
- # @option opts [String] :deleted Deleted query can be TRUE, FALSE or ALL (default to false)
92
- # @option opts [String] :locale_code The locale code to fetch for each presence definition. Use ALL to fetch everything.
93
- # @return [OrganizationPresenceEntityListing]
94
- def get(opts = {})
95
- data, status_code, headers = get_with_http_info(opts)
90
+ # @option opts [String] :locale_code The locale code to fetch for the presence definition. Use ALL to fetch everything.
91
+ # @return [OrganizationPresence]
92
+ def get_presence_id(presence_id, opts = {})
93
+ data, status_code, headers = get_presence_id_with_http_info(presence_id, opts)
96
94
  return data
97
95
  end
98
96
 
99
- # Get an Organization&#39;s list of Presence Definitions
97
+ # Get a Presence Definition
100
98
  #
99
+ # @param presence_id Organization Presence ID
101
100
  # @param [Hash] opts the optional parameters
102
- # @option opts [Integer] :page_number Page number
103
- # @option opts [Integer] :page_size Page size
104
- # @option opts [String] :deleted Deleted query can be TRUE, FALSE or ALL
105
- # @option opts [String] :locale_code The locale code to fetch for each presence definition. Use ALL to fetch everything.
106
- # @return [Array<(OrganizationPresenceEntityListing, Fixnum, Hash)>] OrganizationPresenceEntityListing data, response status code and response headers
107
- def get_with_http_info(opts = {})
101
+ # @option opts [String] :locale_code The locale code to fetch for the presence definition. Use ALL to fetch everything.
102
+ # @return [Array<(OrganizationPresence, Fixnum, Hash)>] OrganizationPresence data, response status code and response headers
103
+ def get_presence_id_with_http_info(presence_id, opts = {})
108
104
  if @api_client.config.debugging
109
- @api_client.config.logger.debug "Calling API: PresenceApi#get ..."
105
+ @api_client.config.logger.debug "Calling API: PresenceApi#get_presence_id ..."
110
106
  end
111
107
 
108
+ # verify the required parameter 'presence_id' is set
109
+ fail "Missing the required parameter 'presence_id' when calling get_presence_id" if presence_id.nil?
110
+
112
111
  # resource path
113
- local_var_path = "/api/v2/presencedefinitions".sub('{format}','json')
112
+ local_var_path = "/api/v2/presencedefinitions/{presenceId}".sub('{format}','json').sub('{' + 'presenceId' + '}', presence_id.to_s)
114
113
 
115
114
  # query parameters
116
115
  query_params = {}
117
- query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
118
- query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
119
- query_params[:'deleted'] = opts[:'deleted'] if opts[:'deleted']
120
116
  query_params[:'localeCode'] = opts[:'locale_code'] if opts[:'locale_code']
121
117
 
122
118
  # header parameters
@@ -143,43 +139,47 @@ module PureCloud
143
139
  :form_params => form_params,
144
140
  :body => post_body,
145
141
  :auth_names => auth_names,
146
- :return_type => 'OrganizationPresenceEntityListing')
142
+ :return_type => 'OrganizationPresence')
147
143
  if @api_client.config.debugging
148
- @api_client.config.logger.debug "API called: PresenceApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
144
+ @api_client.config.logger.debug "API called: PresenceApi#get_presence_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
149
145
  end
150
146
  return data, status_code, headers
151
147
  end
152
148
 
153
- # Get a Presence Definition
149
+ # Get an Organization's list of Presence Definitions
154
150
  #
155
- # @param presence_id Organization Presence ID
156
151
  # @param [Hash] opts the optional parameters
157
- # @option opts [String] :locale_code The locale code to fetch for the presence definition. Use ALL to fetch everything.
158
- # @return [OrganizationPresence]
159
- def get_presence_id(presence_id, opts = {})
160
- data, status_code, headers = get_presence_id_with_http_info(presence_id, opts)
152
+ # @option opts [Integer] :page_number Page number (default to 1)
153
+ # @option opts [Integer] :page_size Page size (default to 25)
154
+ # @option opts [String] :deleted Deleted query can be TRUE, FALSE or ALL (default to false)
155
+ # @option opts [String] :locale_code The locale code to fetch for each presence definition. Use ALL to fetch everything.
156
+ # @return [OrganizationPresenceEntityListing]
157
+ def get_presencedefinitions(opts = {})
158
+ data, status_code, headers = get_presencedefinitions_with_http_info(opts)
161
159
  return data
162
160
  end
163
161
 
164
- # Get a Presence Definition
162
+ # Get an Organization&#39;s list of Presence Definitions
165
163
  #
166
- # @param presence_id Organization Presence ID
167
164
  # @param [Hash] opts the optional parameters
168
- # @option opts [String] :locale_code The locale code to fetch for the presence definition. Use ALL to fetch everything.
169
- # @return [Array<(OrganizationPresence, Fixnum, Hash)>] OrganizationPresence data, response status code and response headers
170
- def get_presence_id_with_http_info(presence_id, opts = {})
165
+ # @option opts [Integer] :page_number Page number
166
+ # @option opts [Integer] :page_size Page size
167
+ # @option opts [String] :deleted Deleted query can be TRUE, FALSE or ALL
168
+ # @option opts [String] :locale_code The locale code to fetch for each presence definition. Use ALL to fetch everything.
169
+ # @return [Array<(OrganizationPresenceEntityListing, Fixnum, Hash)>] OrganizationPresenceEntityListing data, response status code and response headers
170
+ def get_presencedefinitions_with_http_info(opts = {})
171
171
  if @api_client.config.debugging
172
- @api_client.config.logger.debug "Calling API: PresenceApi#get_presence_id ..."
172
+ @api_client.config.logger.debug "Calling API: PresenceApi#get_presencedefinitions ..."
173
173
  end
174
174
 
175
- # verify the required parameter 'presence_id' is set
176
- fail "Missing the required parameter 'presence_id' when calling get_presence_id" if presence_id.nil?
177
-
178
175
  # resource path
179
- local_var_path = "/api/v2/presencedefinitions/{presenceId}".sub('{format}','json').sub('{' + 'presenceId' + '}', presence_id.to_s)
176
+ local_var_path = "/api/v2/presencedefinitions".sub('{format}','json')
180
177
 
181
178
  # query parameters
182
179
  query_params = {}
180
+ query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
181
+ query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
182
+ query_params[:'deleted'] = opts[:'deleted'] if opts[:'deleted']
183
183
  query_params[:'localeCode'] = opts[:'locale_code'] if opts[:'locale_code']
184
184
 
185
185
  # header parameters
@@ -206,9 +206,9 @@ module PureCloud
206
206
  :form_params => form_params,
207
207
  :body => post_body,
208
208
  :auth_names => auth_names,
209
- :return_type => 'OrganizationPresence')
209
+ :return_type => 'OrganizationPresenceEntityListing')
210
210
  if @api_client.config.debugging
211
- @api_client.config.logger.debug "API called: PresenceApi#get_presence_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
211
+ @api_client.config.logger.debug "API called: PresenceApi#get_presencedefinitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
212
212
  end
213
213
  return data, status_code, headers
214
214
  end
@@ -408,8 +408,8 @@ module PureCloud
408
408
  # @param body The Presence Definition to create
409
409
  # @param [Hash] opts the optional parameters
410
410
  # @return [OrganizationPresence]
411
- def post(body, opts = {})
412
- data, status_code, headers = post_with_http_info(body, opts)
411
+ def post_presencedefinitions(body, opts = {})
412
+ data, status_code, headers = post_presencedefinitions_with_http_info(body, opts)
413
413
  return data
414
414
  end
415
415
 
@@ -418,13 +418,13 @@ module PureCloud
418
418
  # @param body The Presence Definition to create
419
419
  # @param [Hash] opts the optional parameters
420
420
  # @return [Array<(OrganizationPresence, Fixnum, Hash)>] OrganizationPresence data, response status code and response headers
421
- def post_with_http_info(body, opts = {})
421
+ def post_presencedefinitions_with_http_info(body, opts = {})
422
422
  if @api_client.config.debugging
423
- @api_client.config.logger.debug "Calling API: PresenceApi#post ..."
423
+ @api_client.config.logger.debug "Calling API: PresenceApi#post_presencedefinitions ..."
424
424
  end
425
425
 
426
426
  # verify the required parameter 'body' is set
427
- fail "Missing the required parameter 'body' when calling post" if body.nil?
427
+ fail "Missing the required parameter 'body' when calling post_presencedefinitions" if body.nil?
428
428
 
429
429
  # resource path
430
430
  local_var_path = "/api/v2/presencedefinitions".sub('{format}','json')
@@ -458,7 +458,7 @@ module PureCloud
458
458
  :auth_names => auth_names,
459
459
  :return_type => 'OrganizationPresence')
460
460
  if @api_client.config.debugging
461
- @api_client.config.logger.debug "API called: PresenceApi#post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
461
+ @api_client.config.logger.debug "API called: PresenceApi#post_presencedefinitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
462
462
  end
463
463
  return data, status_code, headers
464
464
  end