purecloud 0.62.1 → 0.63.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 (264) 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/QualityAudit.html.md +1 -1
  94. data/doc_out/QueryRequest.html.md +1 -1
  95. data/doc_out/QuestionGroup.html.md +4 -4
  96. data/doc_out/QuestionGroupScore.html.md +1 -1
  97. data/doc_out/QuestionScore.html.md +2 -2
  98. data/doc_out/QueueMember.html.md +1 -1
  99. data/doc_out/RecordingApi.html.md +70 -70
  100. data/doc_out/ReportSchedule.html.md +1 -1
  101. data/doc_out/ResourcePermissionPolicy.html.md +1 -1
  102. data/doc_out/RoutingStatusRule.html.md +2 -2
  103. data/doc_out/Salesforce.html.md +1 -1
  104. data/doc_out/Screenshare.html.md +1 -1
  105. data/doc_out/ScriptsApi.html.md +72 -72
  106. data/doc_out/Site.html.md +1 -1
  107. data/doc_out/SocialExpression.html.md +1 -1
  108. data/doc_out/SortItem.html.md +1 -1
  109. data/doc_out/TagValue.html.md +1 -1
  110. data/doc_out/TimeAllowed.html.md +1 -1
  111. data/doc_out/TimeOffRequest.html.md +2 -2
  112. data/doc_out/TimeOffRequestPatch.html.md +1 -1
  113. data/doc_out/TransferRequest.html.md +1 -1
  114. data/doc_out/Trunk.html.md +1 -1
  115. data/doc_out/TrunkBase.html.md +1 -1
  116. data/doc_out/UnreadStatus.html.md +1 -1
  117. data/doc_out/UserPresence.html.md +1 -1
  118. data/doc_out/UserPresenceRule.html.md +2 -2
  119. data/doc_out/UserQueue.html.md +1 -1
  120. data/doc_out/UserRecording.html.md +1 -1
  121. data/doc_out/UserRecordingsApi.html.md +47 -47
  122. data/doc_out/UserScheduleAdherence.html.md +1 -1
  123. data/doc_out/ValidateAddressResponse.html.md +1 -1
  124. data/doc_out/Video.html.md +3 -3
  125. data/doc_out/VoicemailGroupPolicy.html.md +2 -2
  126. data/doc_out/VoicemailMessage.html.md +2 -2
  127. data/doc_out/VoicemailOrganizationPolicy.html.md +4 -4
  128. data/doc_out/VoicemailUserPolicy.html.md +1 -1
  129. data/doc_out/Workspace.html.md +1 -1
  130. data/doc_out/Wrapup.html.md +1 -1
  131. data/doc_out/index.html.md +3 -3
  132. data/lib/purecloud/api/attributes_api.rb +39 -39
  133. data/lib/purecloud/api/conversations_api.rb +58 -58
  134. data/lib/purecloud/api/greetings_api.rb +67 -67
  135. data/lib/purecloud/api/groups_api.rb +104 -104
  136. data/lib/purecloud/api/identity_provider_api.rb +33 -33
  137. data/lib/purecloud/api/presence_api.rb +46 -46
  138. data/lib/purecloud/api/recording_api.rb +76 -76
  139. data/lib/purecloud/api/scripts_api.rb +87 -87
  140. data/lib/purecloud/api/user_recordings_api.rb +64 -64
  141. data/lib/purecloud/api_client.rb +1 -1
  142. data/lib/purecloud/models/adfs.rb +0 -2
  143. data/lib/purecloud/models/aggregation_query.rb +0 -2
  144. data/lib/purecloud/models/analytics_conversation_segment.rb +0 -6
  145. data/lib/purecloud/models/analytics_session.rb +0 -4
  146. data/lib/purecloud/models/audit_message.rb +0 -2
  147. data/lib/purecloud/models/call.rb +0 -8
  148. data/lib/purecloud/models/call_forwarding.rb +0 -2
  149. data/lib/purecloud/models/call_media_participant.rb +0 -12
  150. data/lib/purecloud/models/callback.rb +0 -4
  151. data/lib/purecloud/models/callback_media_participant.rb +0 -8
  152. data/lib/purecloud/models/campaign.rb +0 -2
  153. data/lib/purecloud/models/campaign_interaction.rb +0 -2
  154. data/lib/purecloud/models/campaign_rule.rb +0 -4
  155. data/lib/purecloud/models/campaign_rule_action_entities.rb +0 -2
  156. data/lib/purecloud/models/campaign_sequence.rb +0 -2
  157. data/lib/purecloud/models/certificate_details.rb +0 -6
  158. data/lib/purecloud/models/chat_media_participant.rb +0 -6
  159. data/lib/purecloud/models/cobrowse_media_participant.rb +0 -6
  160. data/lib/purecloud/models/condition.rb +0 -2
  161. data/lib/purecloud/models/contact_sort.rb +0 -2
  162. data/lib/purecloud/models/content_query_request.rb +0 -2
  163. data/lib/purecloud/models/content_sort_item.rb +0 -2
  164. data/lib/purecloud/models/conversation_chat.rb +0 -2
  165. data/lib/purecloud/models/customer_interaction_center.rb +0 -2
  166. data/lib/purecloud/models/dialer_contact.rb +0 -2
  167. data/lib/purecloud/models/document.rb +0 -2
  168. data/lib/purecloud/models/document_audit.rb +0 -2
  169. data/lib/purecloud/models/document_update.rb +0 -2
  170. data/lib/purecloud/models/domain_capabilities.rb +0 -8
  171. data/lib/purecloud/models/domain_edge_software_update_dto.rb +0 -4
  172. data/lib/purecloud/models/domain_edge_software_version_dto.rb +0 -4
  173. data/lib/purecloud/models/domain_logical_interface.rb +0 -6
  174. data/lib/purecloud/models/domain_network_address.rb +0 -2
  175. data/lib/purecloud/models/domain_network_command_response.rb +0 -2
  176. data/lib/purecloud/models/domain_network_route.rb +0 -2
  177. data/lib/purecloud/models/domain_organization_role.rb +11 -17
  178. data/lib/purecloud/models/domain_organization_role_create.rb +11 -17
  179. data/lib/purecloud/models/domain_organization_role_update.rb +11 -17
  180. data/lib/purecloud/models/domain_permission.rb +0 -2
  181. data/lib/purecloud/models/domain_permission_policy.rb +0 -2
  182. data/lib/purecloud/models/domain_physical_capabilities.rb +0 -4
  183. data/lib/purecloud/models/edge.rb +0 -4
  184. data/lib/purecloud/models/edge_auto_update_config.rb +4 -4
  185. data/lib/purecloud/models/edge_group.rb +0 -2
  186. data/lib/purecloud/models/edge_logs_job_request.rb +0 -2
  187. data/lib/purecloud/models/email.rb +0 -2
  188. data/lib/purecloud/models/email_media_participant.rb +0 -6
  189. data/lib/purecloud/models/endpoint.rb +0 -2
  190. data/lib/purecloud/models/evaluation.rb +0 -8
  191. data/lib/purecloud/models/evaluation_form.rb +0 -2
  192. data/lib/purecloud/models/evaluation_scoring_set.rb +0 -2
  193. data/lib/purecloud/models/fax_document.rb +0 -2
  194. data/lib/purecloud/models/field_list.rb +0 -6
  195. data/lib/purecloud/models/geolocation.rb +0 -2
  196. data/lib/purecloud/models/geolocation_settings.rb +0 -2
  197. data/lib/purecloud/models/group.rb +0 -2
  198. data/lib/purecloud/models/group_update.rb +0 -2
  199. data/lib/purecloud/models/heart_beat_rule.rb +0 -4
  200. data/lib/purecloud/models/inbound_domain.rb +0 -2
  201. data/lib/purecloud/models/initiate_screen_recording.rb +0 -2
  202. data/lib/purecloud/models/interaction_stats_alert.rb +0 -2
  203. data/lib/purecloud/models/interaction_stats_rule.rb +0 -4
  204. data/lib/purecloud/models/json_node.rb +24 -64
  205. data/lib/purecloud/models/line_status.rb +0 -2
  206. data/lib/purecloud/models/location_definition.rb +0 -2
  207. data/lib/purecloud/models/media_participant_request.rb +0 -10
  208. data/lib/purecloud/models/metered_evaluation_assignment.rb +0 -2
  209. data/lib/purecloud/models/o_auth_provider.rb +0 -2
  210. data/lib/purecloud/models/okta.rb +0 -2
  211. data/lib/purecloud/models/one_login.rb +0 -2
  212. data/lib/purecloud/models/org_media_utilization.rb +0 -2
  213. data/lib/purecloud/models/organization.rb +0 -2
  214. data/lib/purecloud/models/organization_presence.rb +0 -4
  215. data/lib/purecloud/models/out_of_office.rb +0 -2
  216. data/lib/purecloud/models/outbound_route.rb +0 -4
  217. data/lib/purecloud/models/parameter.rb +0 -2
  218. data/lib/purecloud/models/participant.rb +0 -4
  219. data/lib/purecloud/models/phone_capabilities.rb +0 -10
  220. data/lib/purecloud/models/phone_number_status.rb +0 -2
  221. data/lib/purecloud/models/policy.rb +0 -2
  222. data/lib/purecloud/models/policy_actions.rb +0 -6
  223. data/lib/purecloud/models/policy_create.rb +0 -2
  224. data/lib/purecloud/models/pure_cloud.rb +0 -2
  225. data/lib/purecloud/models/quality_audit.rb +11 -11
  226. data/lib/purecloud/models/query_request.rb +0 -2
  227. data/lib/purecloud/models/question_group.rb +0 -8
  228. data/lib/purecloud/models/question_group_score.rb +0 -2
  229. data/lib/purecloud/models/question_score.rb +0 -4
  230. data/lib/purecloud/models/queue_member.rb +0 -2
  231. data/lib/purecloud/models/report_schedule.rb +0 -2
  232. data/lib/purecloud/models/resource_permission_policy.rb +0 -2
  233. data/lib/purecloud/models/routing_status_rule.rb +0 -4
  234. data/lib/purecloud/models/salesforce.rb +0 -2
  235. data/lib/purecloud/models/screenshare.rb +0 -2
  236. data/lib/purecloud/models/site.rb +0 -2
  237. data/lib/purecloud/models/social_expression.rb +0 -2
  238. data/lib/purecloud/models/sort_item.rb +0 -2
  239. data/lib/purecloud/models/tag_value.rb +0 -2
  240. data/lib/purecloud/models/time_allowed.rb +0 -2
  241. data/lib/purecloud/models/time_off_request.rb +0 -4
  242. data/lib/purecloud/models/time_off_request_patch.rb +0 -2
  243. data/lib/purecloud/models/transfer_request.rb +0 -2
  244. data/lib/purecloud/models/trunk.rb +0 -2
  245. data/lib/purecloud/models/trunk_base.rb +0 -2
  246. data/lib/purecloud/models/unread_status.rb +0 -2
  247. data/lib/purecloud/models/user_presence.rb +0 -2
  248. data/lib/purecloud/models/user_presence_rule.rb +0 -4
  249. data/lib/purecloud/models/user_queue.rb +0 -2
  250. data/lib/purecloud/models/user_recording.rb +0 -2
  251. data/lib/purecloud/models/user_schedule_adherence.rb +0 -2
  252. data/lib/purecloud/models/validate_address_response.rb +0 -2
  253. data/lib/purecloud/models/video.rb +0 -6
  254. data/lib/purecloud/models/voicemail_group_policy.rb +0 -4
  255. data/lib/purecloud/models/voicemail_message.rb +0 -4
  256. data/lib/purecloud/models/voicemail_organization_policy.rb +0 -8
  257. data/lib/purecloud/models/voicemail_user_policy.rb +0 -2
  258. data/lib/purecloud/models/workspace.rb +0 -2
  259. data/lib/purecloud/models/wrapup.rb +0 -2
  260. data/lib/purecloud/version.rb +1 -1
  261. data/newVersion.md +1 -1
  262. data/swagger.json +1 -1
  263. data/version.json +1 -1
  264. metadata +2 -2
@@ -149,6 +149,74 @@ 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
+
152
220
  # Fetch field config for an entity type
153
221
  #
154
222
  # @param type Field type
@@ -349,74 +417,6 @@ module PureCloud
349
417
  return data, status_code, headers
350
418
  end
351
419
 
352
- # Get a group list
353
- #
354
- # @param [Hash] opts the optional parameters
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)
361
- return data
362
- end
363
-
364
- # Get a group list
365
- #
366
- # @param [Hash] opts the optional parameters
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 = {})
372
- if @api_client.config.debugging
373
- @api_client.config.logger.debug "Calling API: GroupsApi#get_groups ..."
374
- end
375
-
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
379
-
380
- # resource path
381
- local_var_path = "/api/v2/groups".sub('{format}','json')
382
-
383
- # query parameters
384
- query_params = {}
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']
388
-
389
- # header parameters
390
- header_params = {}
391
-
392
- # HTTP header 'Accept' (if needed)
393
- _header_accept = ['application/json']
394
- _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result
395
-
396
- # HTTP header 'Content-Type'
397
- _header_content_type = ['application/json']
398
- header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type)
399
-
400
- # form parameters
401
- form_params = {}
402
-
403
- # http body (model)
404
- post_body = nil
405
-
406
- auth_names = ['PureCloud Auth']
407
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
408
- :header_params => header_params,
409
- :query_params => query_params,
410
- :form_params => form_params,
411
- :body => post_body,
412
- :auth_names => auth_names,
413
- :return_type => 'GroupEntityListing')
414
- if @api_client.config.debugging
415
- @api_client.config.logger.debug "API called: GroupsApi#get_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
416
- end
417
- return data, status_code, headers
418
- end
419
-
420
420
  # Search groups using the q64 value returned from a previous search
421
421
  #
422
422
  # @param q64 q64
@@ -481,36 +481,31 @@ module PureCloud
481
481
  return data, status_code, headers
482
482
  end
483
483
 
484
- # Add members
484
+ # Create a group
485
485
  #
486
- # @param group_id Group ID
487
- # @param body Add members
486
+ # @param body Group
488
487
  # @param [Hash] opts the optional parameters
489
- # @return [nil]
490
- def post_group_id_members(group_id, body, opts = {})
491
- post_group_id_members_with_http_info(group_id, body, opts)
492
- return nil
488
+ # @return [Group]
489
+ def post(body, opts = {})
490
+ data, status_code, headers = post_with_http_info(body, opts)
491
+ return data
493
492
  end
494
493
 
495
- # Add members
494
+ # Create a group
496
495
  #
497
- # @param group_id Group ID
498
- # @param body Add members
496
+ # @param body Group
499
497
  # @param [Hash] opts the optional parameters
500
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
501
- def post_group_id_members_with_http_info(group_id, body, opts = {})
498
+ # @return [Array<(Group, Fixnum, Hash)>] Group data, response status code and response headers
499
+ def post_with_http_info(body, opts = {})
502
500
  if @api_client.config.debugging
503
- @api_client.config.logger.debug "Calling API: GroupsApi#post_group_id_members ..."
501
+ @api_client.config.logger.debug "Calling API: GroupsApi#post ..."
504
502
  end
505
503
 
506
- # verify the required parameter 'group_id' is set
507
- fail "Missing the required parameter 'group_id' when calling post_group_id_members" if group_id.nil?
508
-
509
504
  # verify the required parameter 'body' is set
510
- fail "Missing the required parameter 'body' when calling post_group_id_members" if body.nil?
505
+ fail "Missing the required parameter 'body' when calling post" if body.nil?
511
506
 
512
507
  # resource path
513
- local_var_path = "/api/v2/groups/{groupId}/members".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
508
+ local_var_path = "/api/v2/groups".sub('{format}','json')
514
509
 
515
510
  # query parameters
516
511
  query_params = {}
@@ -538,38 +533,44 @@ module PureCloud
538
533
  :query_params => query_params,
539
534
  :form_params => form_params,
540
535
  :body => post_body,
541
- :auth_names => auth_names)
536
+ :auth_names => auth_names,
537
+ :return_type => 'Group')
542
538
  if @api_client.config.debugging
543
- @api_client.config.logger.debug "API called: GroupsApi#post_group_id_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
539
+ @api_client.config.logger.debug "API called: GroupsApi#post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
544
540
  end
545
541
  return data, status_code, headers
546
542
  end
547
543
 
548
- # Create a group
544
+ # Add members
549
545
  #
550
- # @param body Group
546
+ # @param group_id Group ID
547
+ # @param body Add members
551
548
  # @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
549
+ # @return [nil]
550
+ def post_group_id_members(group_id, body, opts = {})
551
+ post_group_id_members_with_http_info(group_id, body, opts)
552
+ return nil
556
553
  end
557
554
 
558
- # Create a group
555
+ # Add members
559
556
  #
560
- # @param body Group
557
+ # @param group_id Group ID
558
+ # @param body Add members
561
559
  # @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 = {})
560
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
561
+ def post_group_id_members_with_http_info(group_id, body, opts = {})
564
562
  if @api_client.config.debugging
565
- @api_client.config.logger.debug "Calling API: GroupsApi#post_groups ..."
563
+ @api_client.config.logger.debug "Calling API: GroupsApi#post_group_id_members ..."
566
564
  end
567
565
 
566
+ # verify the required parameter 'group_id' is set
567
+ fail "Missing the required parameter 'group_id' when calling post_group_id_members" if group_id.nil?
568
+
568
569
  # verify the required parameter 'body' is set
569
- fail "Missing the required parameter 'body' when calling post_groups" if body.nil?
570
+ fail "Missing the required parameter 'body' when calling post_group_id_members" if body.nil?
570
571
 
571
572
  # resource path
572
- local_var_path = "/api/v2/groups".sub('{format}','json')
573
+ local_var_path = "/api/v2/groups/{groupId}/members".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)
573
574
 
574
575
  # query parameters
575
576
  query_params = {}
@@ -597,10 +598,9 @@ module PureCloud
597
598
  :query_params => query_params,
598
599
  :form_params => form_params,
599
600
  :body => post_body,
600
- :auth_names => auth_names,
601
- :return_type => 'Group')
601
+ :auth_names => auth_names)
602
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}"
603
+ @api_client.config.logger.debug "API called: GroupsApi#post_group_id_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
604
604
  end
605
605
  return data, status_code, headers
606
606
  end
@@ -402,26 +402,26 @@ module PureCloud
402
402
  return data, status_code, headers
403
403
  end
404
404
 
405
- # Get ADFS Identity Provider
405
+ # The list of identity providers
406
406
  #
407
407
  # @param [Hash] opts the optional parameters
408
- # @return [ADFS]
409
- def get_adfs(opts = {})
410
- data, status_code, headers = get_adfs_with_http_info(opts)
408
+ # @return [OAuthProviderEntityListing]
409
+ def get(opts = {})
410
+ data, status_code, headers = get_with_http_info(opts)
411
411
  return data
412
412
  end
413
413
 
414
- # Get ADFS Identity Provider
414
+ # The list of identity providers
415
415
  #
416
416
  # @param [Hash] opts the optional parameters
417
- # @return [Array<(ADFS, Fixnum, Hash)>] ADFS data, response status code and response headers
418
- def get_adfs_with_http_info(opts = {})
417
+ # @return [Array<(OAuthProviderEntityListing, Fixnum, Hash)>] OAuthProviderEntityListing data, response status code and response headers
418
+ def get_with_http_info(opts = {})
419
419
  if @api_client.config.debugging
420
- @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_adfs ..."
420
+ @api_client.config.logger.debug "Calling API: IdentityProviderApi#get ..."
421
421
  end
422
422
 
423
423
  # resource path
424
- local_var_path = "/api/v2/identityproviders/adfs".sub('{format}','json')
424
+ local_var_path = "/api/v2/identityproviders".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 => 'ADFS')
453
+ :return_type => 'OAuthProviderEntityListing')
454
454
  if @api_client.config.debugging
455
- @api_client.config.logger.debug "API called: IdentityProviderApi#get_adfs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
455
+ @api_client.config.logger.debug "API called: IdentityProviderApi#get\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 Customer Interaction Center (CIC) Identity Provider
460
+ # Get ADFS Identity Provider
461
461
  #
462
462
  # @param [Hash] opts the optional parameters
463
- # @return [CustomerInteractionCenter]
464
- def get_cic(opts = {})
465
- data, status_code, headers = get_cic_with_http_info(opts)
463
+ # @return [ADFS]
464
+ def get_adfs(opts = {})
465
+ data, status_code, headers = get_adfs_with_http_info(opts)
466
466
  return data
467
467
  end
468
468
 
469
- # Get Customer Interaction Center (CIC) Identity Provider
469
+ # Get ADFS Identity Provider
470
470
  #
471
471
  # @param [Hash] opts the optional parameters
472
- # @return [Array<(CustomerInteractionCenter, Fixnum, Hash)>] CustomerInteractionCenter data, response status code and response headers
473
- def get_cic_with_http_info(opts = {})
472
+ # @return [Array<(ADFS, Fixnum, Hash)>] ADFS data, response status code and response headers
473
+ def get_adfs_with_http_info(opts = {})
474
474
  if @api_client.config.debugging
475
- @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_cic ..."
475
+ @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_adfs ..."
476
476
  end
477
477
 
478
478
  # resource path
479
- local_var_path = "/api/v2/identityproviders/cic".sub('{format}','json')
479
+ local_var_path = "/api/v2/identityproviders/adfs".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 => 'CustomerInteractionCenter')
508
+ :return_type => 'ADFS')
509
509
  if @api_client.config.debugging
510
- @api_client.config.logger.debug "API called: IdentityProviderApi#get_cic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
510
+ @api_client.config.logger.debug "API called: IdentityProviderApi#get_adfs\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
- # The list of identity providers
515
+ # Get Customer Interaction Center (CIC) Identity Provider
516
516
  #
517
517
  # @param [Hash] opts the optional parameters
518
- # @return [OAuthProviderEntityListing]
519
- def get_identityproviders(opts = {})
520
- data, status_code, headers = get_identityproviders_with_http_info(opts)
518
+ # @return [CustomerInteractionCenter]
519
+ def get_cic(opts = {})
520
+ data, status_code, headers = get_cic_with_http_info(opts)
521
521
  return data
522
522
  end
523
523
 
524
- # The list of identity providers
524
+ # Get Customer Interaction Center (CIC) Identity Provider
525
525
  #
526
526
  # @param [Hash] opts the optional parameters
527
- # @return [Array<(OAuthProviderEntityListing, Fixnum, Hash)>] OAuthProviderEntityListing data, response status code and response headers
528
- def get_identityproviders_with_http_info(opts = {})
527
+ # @return [Array<(CustomerInteractionCenter, Fixnum, Hash)>] CustomerInteractionCenter data, response status code and response headers
528
+ def get_cic_with_http_info(opts = {})
529
529
  if @api_client.config.debugging
530
- @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_identityproviders ..."
530
+ @api_client.config.logger.debug "Calling API: IdentityProviderApi#get_cic ..."
531
531
  end
532
532
 
533
533
  # resource path
534
- local_var_path = "/api/v2/identityproviders".sub('{format}','json')
534
+ local_var_path = "/api/v2/identityproviders/cic".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 => 'OAuthProviderEntityListing')
563
+ :return_type => 'CustomerInteractionCenter')
564
564
  if @api_client.config.debugging
565
- @api_client.config.logger.debug "API called: IdentityProviderApi#get_identityproviders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
565
+ @api_client.config.logger.debug "API called: IdentityProviderApi#get_cic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
566
566
  end
567
567
  return data, status_code, headers
568
568
  end
@@ -83,36 +83,40 @@ module PureCloud
83
83
  return data, status_code, headers
84
84
  end
85
85
 
86
- # Get a Presence Definition
86
+ # Get an Organization's list of Presence Definitions
87
87
  #
88
- # @param presence_id Organization Presence ID
89
88
  # @param [Hash] opts the optional parameters
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)
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)
94
96
  return data
95
97
  end
96
98
 
97
- # Get a Presence Definition
99
+ # Get an Organization&#39;s list of Presence Definitions
98
100
  #
99
- # @param presence_id Organization Presence ID
100
101
  # @param [Hash] opts the optional parameters
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 = {})
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 = {})
104
108
  if @api_client.config.debugging
105
- @api_client.config.logger.debug "Calling API: PresenceApi#get_presence_id ..."
109
+ @api_client.config.logger.debug "Calling API: PresenceApi#get ..."
106
110
  end
107
111
 
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
-
111
112
  # resource path
112
- local_var_path = "/api/v2/presencedefinitions/{presenceId}".sub('{format}','json').sub('{' + 'presenceId' + '}', presence_id.to_s)
113
+ local_var_path = "/api/v2/presencedefinitions".sub('{format}','json')
113
114
 
114
115
  # query parameters
115
116
  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']
116
120
  query_params[:'localeCode'] = opts[:'locale_code'] if opts[:'locale_code']
117
121
 
118
122
  # header parameters
@@ -139,47 +143,43 @@ module PureCloud
139
143
  :form_params => form_params,
140
144
  :body => post_body,
141
145
  :auth_names => auth_names,
142
- :return_type => 'OrganizationPresence')
146
+ :return_type => 'OrganizationPresenceEntityListing')
143
147
  if @api_client.config.debugging
144
- @api_client.config.logger.debug "API called: PresenceApi#get_presence_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
148
+ @api_client.config.logger.debug "API called: PresenceApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
145
149
  end
146
150
  return data, status_code, headers
147
151
  end
148
152
 
149
- # Get an Organization's list of Presence Definitions
153
+ # Get a Presence Definition
150
154
  #
155
+ # @param presence_id Organization Presence ID
151
156
  # @param [Hash] opts the optional parameters
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)
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)
159
161
  return data
160
162
  end
161
163
 
162
- # Get an Organization&#39;s list of Presence Definitions
164
+ # Get a Presence Definition
163
165
  #
166
+ # @param presence_id Organization Presence ID
164
167
  # @param [Hash] opts the optional parameters
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 = {})
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 = {})
171
171
  if @api_client.config.debugging
172
- @api_client.config.logger.debug "Calling API: PresenceApi#get_presencedefinitions ..."
172
+ @api_client.config.logger.debug "Calling API: PresenceApi#get_presence_id ..."
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
+
175
178
  # resource path
176
- local_var_path = "/api/v2/presencedefinitions".sub('{format}','json')
179
+ local_var_path = "/api/v2/presencedefinitions/{presenceId}".sub('{format}','json').sub('{' + 'presenceId' + '}', presence_id.to_s)
177
180
 
178
181
  # query parameters
179
182
  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 => 'OrganizationPresenceEntityListing')
209
+ :return_type => 'OrganizationPresence')
210
210
  if @api_client.config.debugging
211
- @api_client.config.logger.debug "API called: PresenceApi#get_presencedefinitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
211
+ @api_client.config.logger.debug "API called: PresenceApi#get_presence_id\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_presencedefinitions(body, opts = {})
412
- data, status_code, headers = post_presencedefinitions_with_http_info(body, opts)
411
+ def post(body, opts = {})
412
+ data, status_code, headers = post_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_presencedefinitions_with_http_info(body, opts = {})
421
+ def post_with_http_info(body, opts = {})
422
422
  if @api_client.config.debugging
423
- @api_client.config.logger.debug "Calling API: PresenceApi#post_presencedefinitions ..."
423
+ @api_client.config.logger.debug "Calling API: PresenceApi#post ..."
424
424
  end
425
425
 
426
426
  # verify the required parameter 'body' is set
427
- fail "Missing the required parameter 'body' when calling post_presencedefinitions" if body.nil?
427
+ fail "Missing the required parameter 'body' when calling post" 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_presencedefinitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
461
+ @api_client.config.logger.debug "API called: PresenceApi#post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
462
462
  end
463
463
  return data, status_code, headers
464
464
  end