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
data/doc_out/Email.html.md CHANGED
@@ -9,7 +9,7 @@ title: Email
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **state** | **String** | The connection state of this communication. | [optional] |
11
11
  | **id** | **String** | A globally unique identifier for this communication. | [optional] |
12
- | **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional] |
12
+ | **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional] [default to false]|
13
13
  | **subject** | **String** | The subject for the initial email that started this conversation. | [optional] |
14
14
  | **messages_sent** | **Integer** | The number of email messages sent by this participant. | [optional] |
15
15
  | **segments** | [**Array<Segment>**](Segment.html) | The time line of the participant's email, divided into activity segments. | [optional] |
data/doc_out/EmailMediaParticipant.html.md CHANGED
@@ -18,8 +18,8 @@ title: EmailMediaParticipant
18
18
  | **state** | **String** | The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting | [optional] |
19
19
  | **direction** | **String** | The participant's direction. Values can be: 'inbound' or 'outbound' | [optional] |
20
20
  | **disconnect_type** | **String** | The reason the participant was disconnected from the conversation. | [optional] |
21
- | **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional] |
22
- | **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional] |
21
+ | **held** | **BOOLEAN** | Value is true when the participant is on hold. | [optional] [default to false]|
22
+ | **wrapup_required** | **BOOLEAN** | Value is true when the participant requires wrap-up. | [optional] [default to false]|
23
23
  | **wrapup_prompt** | **String** | The wrap-up prompt indicating the type of wrap-up to be performed. | [optional] |
24
24
  | **user** | [**UriReference**](UriReference.html) | The PureCloud user for this participant. | [optional] |
25
25
  | **queue** | [**UriReference**](UriReference.html) | The PureCloud queue for this participant. | [optional] |
@@ -27,7 +27,7 @@ title: EmailMediaParticipant
27
27
  | **error_info** | [**ErrorBody**](ErrorBody.html) | If the conversation ends in error, contains additional error details. | [optional] |
28
28
  | **script** | [**UriReference**](UriReference.html) | The Engage script that should be used by this participant. | [optional] |
29
29
  | **wrapup_timeout_ms** | **Integer** | The amount of time the participant has to complete wrap-up. | [optional] |
30
- | **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] |
30
+ | **wrapup_skipped** | **BOOLEAN** | Value is true when the participant has skipped wrap-up. | [optional] [default to false]|
31
31
  | **provider** | **String** | The source provider for the communication. | [optional] |
32
32
  | **external_contact** | [**UriReference**](UriReference.html) | If this participant represents an external contact, then this will be the reference for the external contact. | [optional] |
33
33
  | **external_organization** | [**UriReference**](UriReference.html) | If this participant represents an external org, then this will be the reference for the external org. | [optional] |
data/doc_out/Endpoint.html.md CHANGED
@@ -21,7 +21,7 @@ title: Endpoint
21
21
  | **count** | **Integer** | | [optional] |
22
22
  | **properties** | **Hash<String, Object>** | | [optional] |
23
23
  | **schema** | [**UriReference**](UriReference.html) | Schema | |
24
- | **enabled** | **BOOLEAN** | | [optional] |
24
+ | **enabled** | **BOOLEAN** | | [optional] [default to false]|
25
25
  | **site** | [**UriReference**](UriReference.html) | | [optional] |
26
26
  | **dids** | **Array<String>** | | [optional] |
27
27
  | **self_uri** | **String** | The URI for this object | [optional] |
data/doc_out/Evaluation.html.md CHANGED
@@ -16,16 +16,16 @@ title: Evaluation
16
16
  | **calibration** | [**Calibration**](Calibration.html) | | [optional] |
17
17
  | **status** | **String** | | [optional] |
18
18
  | **answers** | [**EvaluationScoringSet**](EvaluationScoringSet.html) | | [optional] |
19
- | **agent_has_read** | **BOOLEAN** | | [optional] |
19
+ | **agent_has_read** | **BOOLEAN** | | [optional] [default to false]|
20
20
  | **release_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
21
21
  | **assigned_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
22
22
  | **changed_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
23
23
  | **queue** | [**Queue**](Queue.html) | | [optional] |
24
- | **never_release** | **BOOLEAN** | Signifies if the evaluation is never to be released. This cannot be set true if release date is also set. | [optional] |
24
+ | **never_release** | **BOOLEAN** | Signifies if the evaluation is never to be released. This cannot be set true if release date is also set. | [optional] [default to false]|
25
25
  | **resource_id** | **String** | Only used for email evaluations. Will be null for all other evaluations. | [optional] |
26
26
  | **resource_type** | **String** | The type of resource. Only used for email evaluations. Will be null for evaluations on all other resources. | [optional] |
27
- | **redacted** | **BOOLEAN** | Is only true when the user making the request does not have sufficient permissions to see evaluation | [optional] |
28
- | **is_scoring_index** | **BOOLEAN** | | [optional] |
27
+ | **redacted** | **BOOLEAN** | Is only true when the user making the request does not have sufficient permissions to see evaluation | [optional] [default to false]|
28
+ | **is_scoring_index** | **BOOLEAN** | | [optional] [default to false]|
29
29
  | **self_uri** | **String** | The URI for this object | [optional] |
30
30
  {: class="table table-striped"}
31
31
 
data/doc_out/EvaluationForm.html.md CHANGED
@@ -11,7 +11,7 @@ title: EvaluationForm
11
11
  | **name** | **String** | The evaluation form name | |
12
12
  | **type** | **String** | The form type (evaluation) | |
13
13
  | **modified_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
- | **published** | **BOOLEAN** | | [optional] |
14
+ | **published** | **BOOLEAN** | | [optional] [default to false]|
15
15
  | **context_id** | **String** | | [optional] |
16
16
  | **question_groups** | [**Array<QuestionGroup>**](QuestionGroup.html) | A list of question groups | |
17
17
  | **published_versions** | [**DomainEntityListingEvaluationForm**](DomainEntityListingEvaluationForm.html) | | [optional] |
data/doc_out/EvaluationScoringSet.html.md CHANGED
@@ -10,7 +10,7 @@ title: EvaluationScoringSet
10
10
  | **total_score** | **Float** | | [optional] |
11
11
  | **total_critical_score** | **Float** | | [optional] |
12
12
  | **question_group_scores** | [**Array<QuestionGroupScore>**](QuestionGroupScore.html) | | [optional] |
13
- | **any_failed_kill_questions** | **BOOLEAN** | | [optional] |
13
+ | **any_failed_kill_questions** | **BOOLEAN** | | [optional] [default to false]|
14
14
  | **comments** | **String** | | [optional] |
15
15
  | **agent_comments** | **String** | | [optional] |
16
16
  {: class="table table-striped"}
data/doc_out/FaxDocument.html.md CHANGED
@@ -17,7 +17,7 @@ title: FaxDocument
17
17
  | **content_type** | **String** | | [optional] |
18
18
  | **content_length** | **Integer** | | [optional] |
19
19
  | **filename** | **String** | | [optional] |
20
- | **read** | **BOOLEAN** | | [optional] |
20
+ | **read** | **BOOLEAN** | | [optional] [default to false]|
21
21
  | **page_count** | **Integer** | | [optional] |
22
22
  | **caller_address** | **String** | | [optional] |
23
23
  | **receiver_address** | **String** | | [optional] |
data/doc_out/FieldList.html.md CHANGED
@@ -7,15 +7,15 @@ title: FieldList
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **custom_labels** | **BOOLEAN** | | [optional] |
10
+ | **custom_labels** | **BOOLEAN** | | [optional] [default to false]|
11
11
  | **instruction_text** | **String** | | [optional] |
12
12
  | **key** | **String** | | [optional] |
13
13
  | **label_keys** | **Array<String>** | | [optional] |
14
14
  | **params** | **Hash<String, Object>** | | [optional] |
15
- | **repeatable** | **BOOLEAN** | | [optional] |
15
+ | **repeatable** | **BOOLEAN** | | [optional] [default to false]|
16
16
  | **state** | **String** | | [optional] |
17
17
  | **type** | **String** | | [optional] |
18
- | **required** | **BOOLEAN** | | [optional] |
18
+ | **required** | **BOOLEAN** | | [optional] [default to false]|
19
19
  {: class="table table-striped"}
20
20
 
21
21
 
data/doc_out/Geolocation.html.md CHANGED
@@ -10,7 +10,7 @@ title: Geolocation
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **type** | **String** | A string used to describe the type of client the geolocation is being updated from e.g. ios, android, web, etc. | [optional] |
13
- | **primary** | **BOOLEAN** | A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH | [optional] |
13
+ | **primary** | **BOOLEAN** | A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH | [optional] [default to false]|
14
14
  | **latitude** | **Float** | | [optional] |
15
15
  | **longitude** | **Float** | | [optional] |
16
16
  | **country** | **String** | | [optional] |
data/doc_out/GeolocationSettings.html.md CHANGED
@@ -9,7 +9,7 @@ title: GeolocationSettings
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
- | **enabled** | **BOOLEAN** | | [optional] |
12
+ | **enabled** | **BOOLEAN** | | [optional] [default to false]|
13
13
  | **mapbox_key** | **String** | | [optional] |
14
14
  | **self_uri** | **String** | The URI for this object | [optional] |
15
15
  {: class="table table-striped"}
data/doc_out/GreetingsApi.html.md CHANGED
@@ -9,15 +9,15 @@ All URIs are relative to *https://api.mypurecloud.com*
9
9
  Method | HTTP request | Description
10
10
  ------------- | ------------- | -------------
11
11
  |[**delete_greeting_id**](GreetingsApi.html#delete_greeting_id) | **DELETE** /api/v2/greetings/{greetingId} | Deletes a Greeting with the given GreetingId|
12
- |[**get**](GreetingsApi.html#get) | **GET** /api/v2/greetings | Gets an Organization's Greetings|
13
12
  |[**get_defaults**](GreetingsApi.html#get_defaults) | **GET** /api/v2/greetings/defaults | Get an Organization's DefaultGreetingList|
14
13
  |[**get_greeting_id**](GreetingsApi.html#get_greeting_id) | **GET** /api/v2/greetings/{greetingId} | Get a Greeting with the given GreetingId|
15
14
  |[**get_greeting_id_media**](GreetingsApi.html#get_greeting_id_media) | **GET** /api/v2/greetings/{greetingId}/media | Get media playback URI for this greeting|
15
+ |[**get_greetings**](GreetingsApi.html#get_greetings) | **GET** /api/v2/greetings | Gets an Organization's Greetings|
16
16
  |[**get_group_id_greetings**](GreetingsApi.html#get_group_id_greetings) | **GET** /api/v2/groups/{groupId}/greetings | Get a list of the Group's Greetings|
17
17
  |[**get_group_id_greetings_defaults**](GreetingsApi.html#get_group_id_greetings_defaults) | **GET** /api/v2/groups/{groupId}/greetings/defaults | Grabs the list of Default Greetings given a Group's ID|
18
18
  |[**get_user_id_greetings**](GreetingsApi.html#get_user_id_greetings) | **GET** /api/v2/users/{userId}/greetings | Get a list of the User's Greetings|
19
19
  |[**get_user_id_greetings_defaults**](GreetingsApi.html#get_user_id_greetings_defaults) | **GET** /api/v2/users/{userId}/greetings/defaults | Grabs the list of Default Greetings given a User's ID|
20
- |[**post**](GreetingsApi.html#post) | **POST** /api/v2/greetings | Create a Greeting for an Organization|
20
+ |[**post_greetings**](GreetingsApi.html#post_greetings) | **POST** /api/v2/greetings | Create a Greeting for an Organization|
21
21
  |[**post_group_id_greetings**](GreetingsApi.html#post_group_id_greetings) | **POST** /api/v2/groups/{groupId}/greetings | Creates a Greeting for a Group|
22
22
  |[**post_user_id_greetings**](GreetingsApi.html#post_user_id_greetings) | **POST** /api/v2/users/{userId}/greetings | Creates a Greeting for a User|
23
23
  |[**put_defaults**](GreetingsApi.html#put_defaults) | **PUT** /api/v2/greetings/defaults | Update an Organization's DefaultGreetingList|
@@ -82,11 +82,11 @@ Name | Type | Description | Notes
82
82
 
83
83
 
84
84
 
85
- <a name="get"></a>
85
+ <a name="get_defaults"></a>
86
86
 
87
- ## -[**DomainEntityListing**](DomainEntityListing.html) get(opts)
87
+ ## -[**DefaultGreetingList**](DefaultGreetingList.html) get_defaults
88
88
 
89
- Gets an Organization's Greetings
89
+ Get an Organization's DefaultGreetingList
90
90
 
91
91
 
92
92
 
@@ -107,32 +107,23 @@ end
107
107
 
108
108
  api_instance = PureCloud::GreetingsApi.new
109
109
 
110
- opts = {
111
- page_size: 25, # Integer | Page size
112
- page_number: 1 # Integer | Page number
113
- }
114
-
115
110
  begin
116
- #Gets an Organization's Greetings
117
- result = api_instance.get(opts)
111
+ #Get an Organization's DefaultGreetingList
112
+ result = api_instance.get_defaults
118
113
  p result
119
114
  rescue PureCloud::ApiError => e
120
- puts "Exception when calling GreetingsApi->get: #{e}"
115
+ puts "Exception when calling GreetingsApi->get_defaults: #{e}"
121
116
  end
122
117
  ~~~
123
118
 
124
119
  ### Parameters
125
-
126
- Name | Type | Description | Notes
127
- ------------- | ------------- | ------------- | -------------
128
- **page_size** | **Integer**| Page size | [optional] [default to 25]
129
- **page_number** | **Integer**| Page number | [optional] [default to 1]
120
+ This endpoint does not need any parameter.
130
121
  {: class="table table-striped"}
131
122
 
132
123
 
133
124
  ### Return type
134
125
 
135
- [**DomainEntityListing**](DomainEntityListing.html)
126
+ [**DefaultGreetingList**](DefaultGreetingList.html)
136
127
 
137
128
  ### HTTP request headers
138
129
 
@@ -141,11 +132,11 @@ Name | Type | Description | Notes
141
132
 
142
133
 
143
134
 
144
- <a name="get_defaults"></a>
135
+ <a name="get_greeting_id"></a>
145
136
 
146
- ## -[**DefaultGreetingList**](DefaultGreetingList.html) get_defaults
137
+ ## -[**Greeting**](Greeting.html) get_greeting_id(greeting_id)
147
138
 
148
- Get an Organization's DefaultGreetingList
139
+ Get a Greeting with the given GreetingId
149
140
 
150
141
 
151
142
 
@@ -166,23 +157,29 @@ end
166
157
 
167
158
  api_instance = PureCloud::GreetingsApi.new
168
159
 
160
+ greeting_id = "greeting_id_example" # String | Greeting ID
161
+
162
+
169
163
  begin
170
- #Get an Organization's DefaultGreetingList
171
- result = api_instance.get_defaults
164
+ #Get a Greeting with the given GreetingId
165
+ result = api_instance.get_greeting_id(greeting_id)
172
166
  p result
173
167
  rescue PureCloud::ApiError => e
174
- puts "Exception when calling GreetingsApi->get_defaults: #{e}"
168
+ puts "Exception when calling GreetingsApi->get_greeting_id: #{e}"
175
169
  end
176
170
  ~~~
177
171
 
178
172
  ### Parameters
179
- This endpoint does not need any parameter.
173
+
174
+ Name | Type | Description | Notes
175
+ ------------- | ------------- | ------------- | -------------
176
+ **greeting_id** | **String**| Greeting ID |
180
177
  {: class="table table-striped"}
181
178
 
182
179
 
183
180
  ### Return type
184
181
 
185
- [**DefaultGreetingList**](DefaultGreetingList.html)
182
+ [**Greeting**](Greeting.html)
186
183
 
187
184
  ### HTTP request headers
188
185
 
@@ -191,11 +188,11 @@ This endpoint does not need any parameter.
191
188
 
192
189
 
193
190
 
194
- <a name="get_greeting_id"></a>
191
+ <a name="get_greeting_id_media"></a>
195
192
 
196
- ## -[**Greeting**](Greeting.html) get_greeting_id(greeting_id)
193
+ ## -[**GreetingMediaInfo**](GreetingMediaInfo.html) get_greeting_id_media(greeting_id, opts)
197
194
 
198
- Get a Greeting with the given GreetingId
195
+ Get media playback URI for this greeting
199
196
 
200
197
 
201
198
 
@@ -218,13 +215,16 @@ api_instance = PureCloud::GreetingsApi.new
218
215
 
219
216
  greeting_id = "greeting_id_example" # String | Greeting ID
220
217
 
218
+ opts = {
219
+ format_id: "WAV" # String | The desired media format.
220
+ }
221
221
 
222
222
  begin
223
- #Get a Greeting with the given GreetingId
224
- result = api_instance.get_greeting_id(greeting_id)
223
+ #Get media playback URI for this greeting
224
+ result = api_instance.get_greeting_id_media(greeting_id, opts)
225
225
  p result
226
226
  rescue PureCloud::ApiError => e
227
- puts "Exception when calling GreetingsApi->get_greeting_id: #{e}"
227
+ puts "Exception when calling GreetingsApi->get_greeting_id_media: #{e}"
228
228
  end
229
229
  ~~~
230
230
 
@@ -233,12 +233,13 @@ end
233
233
  Name | Type | Description | Notes
234
234
  ------------- | ------------- | ------------- | -------------
235
235
  **greeting_id** | **String**| Greeting ID |
236
+ **format_id** | **String**| The desired media format. | [optional] [default to WAV]
236
237
  {: class="table table-striped"}
237
238
 
238
239
 
239
240
  ### Return type
240
241
 
241
- [**Greeting**](Greeting.html)
242
+ [**GreetingMediaInfo**](GreetingMediaInfo.html)
242
243
 
243
244
  ### HTTP request headers
244
245
 
@@ -247,11 +248,11 @@ Name | Type | Description | Notes
247
248
 
248
249
 
249
250
 
250
- <a name="get_greeting_id_media"></a>
251
+ <a name="get_greetings"></a>
251
252
 
252
- ## -[**GreetingMediaInfo**](GreetingMediaInfo.html) get_greeting_id_media(greeting_id, opts)
253
+ ## -[**DomainEntityListing**](DomainEntityListing.html) get_greetings(opts)
253
254
 
254
- Get media playback URI for this greeting
255
+ Gets an Organization's Greetings
255
256
 
256
257
 
257
258
 
@@ -272,18 +273,17 @@ end
272
273
 
273
274
  api_instance = PureCloud::GreetingsApi.new
274
275
 
275
- greeting_id = "greeting_id_example" # String | Greeting ID
276
-
277
276
  opts = {
278
- format_id: "WAV" # String | The desired media format.
277
+ page_size: 25, # Integer | Page size
278
+ page_number: 1 # Integer | Page number
279
279
  }
280
280
 
281
281
  begin
282
- #Get media playback URI for this greeting
283
- result = api_instance.get_greeting_id_media(greeting_id, opts)
282
+ #Gets an Organization's Greetings
283
+ result = api_instance.get_greetings(opts)
284
284
  p result
285
285
  rescue PureCloud::ApiError => e
286
- puts "Exception when calling GreetingsApi->get_greeting_id_media: #{e}"
286
+ puts "Exception when calling GreetingsApi->get_greetings: #{e}"
287
287
  end
288
288
  ~~~
289
289
 
@@ -291,14 +291,14 @@ end
291
291
 
292
292
  Name | Type | Description | Notes
293
293
  ------------- | ------------- | ------------- | -------------
294
- **greeting_id** | **String**| Greeting ID |
295
- **format_id** | **String**| The desired media format. | [optional] [default to WAV]
294
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
295
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
296
296
  {: class="table table-striped"}
297
297
 
298
298
 
299
299
  ### Return type
300
300
 
301
- [**GreetingMediaInfo**](GreetingMediaInfo.html)
301
+ [**DomainEntityListing**](DomainEntityListing.html)
302
302
 
303
303
  ### HTTP request headers
304
304
 
@@ -543,9 +543,9 @@ Name | Type | Description | Notes
543
543
 
544
544
 
545
545
 
546
- <a name="post"></a>
546
+ <a name="post_greetings"></a>
547
547
 
548
- ## -[**DefaultGreetingList**](DefaultGreetingList.html) post(body)
548
+ ## -[**DefaultGreetingList**](DefaultGreetingList.html) post_greetings(body)
549
549
 
550
550
  Create a Greeting for an Organization
551
551
 
@@ -573,10 +573,10 @@ body = PureCloud::Greeting.new # Greeting | The Greeting to create
573
573
 
574
574
  begin
575
575
  #Create a Greeting for an Organization
576
- result = api_instance.post(body)
576
+ result = api_instance.post_greetings(body)
577
577
  p result
578
578
  rescue PureCloud::ApiError => e
579
- puts "Exception when calling GreetingsApi->post: #{e}"
579
+ puts "Exception when calling GreetingsApi->post_greetings: #{e}"
580
580
  end
581
581
  ~~~
582
582
 
data/doc_out/Group.html.md CHANGED
@@ -17,7 +17,7 @@ title: Group
17
17
  | **type** | **String** | Type of group. | |
18
18
  | **images** | [**Array&lt;UserImage&gt;**](UserImage.html) | | [optional] |
19
19
  | **addresses** | [**Array&lt;Contact&gt;**](Contact.html) | | [optional] |
20
- | **rules_visible** | **BOOLEAN** | Are membership rules visible to the person requesting to view the group | |
20
+ | **rules_visible** | **BOOLEAN** | Are membership rules visible to the person requesting to view the group | [default to false]|
21
21
  | **visibility** | **String** | Who can view this group | |
22
22
  | **self_uri** | **String** | The URI for this object | [optional] |
23
23
  {: class="table table-striped"}
data/doc_out/GroupUpdate.html.md CHANGED
@@ -14,7 +14,7 @@ title: GroupUpdate
14
14
  | **version** | **Integer** | Current version for this resource. | |
15
15
  | **images** | [**Array&lt;UserImage&gt;**](UserImage.html) | | [optional] |
16
16
  | **addresses** | [**Array&lt;Contact&gt;**](Contact.html) | | [optional] |
17
- | **rules_visible** | **BOOLEAN** | Are membership rules visible to the person requesting to view the group | [optional] |
17
+ | **rules_visible** | **BOOLEAN** | Are membership rules visible to the person requesting to view the group | [optional] [default to false]|
18
18
  | **visibility** | **String** | Who can view this group | [optional] |
19
19
  | **self_uri** | **String** | The URI for this object | [optional] |
20
20
  {: class="table table-striped"}
data/doc_out/GroupsApi.html.md CHANGED
@@ -10,13 +10,13 @@ Method | HTTP request | Description
10
10
  ------------- | ------------- | -------------
11
11
  |[**delete_group_id**](GroupsApi.html#delete_group_id) | **DELETE** /api/v2/groups/{groupId} | Delete group|
12
12
  |[**delete_group_id_members**](GroupsApi.html#delete_group_id_members) | **DELETE** /api/v2/groups/{groupId}/members | Remove members|
13
- |[**get**](GroupsApi.html#get) | **GET** /api/v2/groups | Get a group list|
14
13
  |[**get_fieldconfig**](GroupsApi.html#get_fieldconfig) | **GET** /api/v2/fieldconfig | Fetch field config for an entity type|
15
14
  |[**get_group_id**](GroupsApi.html#get_group_id) | **GET** /api/v2/groups/{groupId} | Get group|
16
15
  |[**get_group_id_members**](GroupsApi.html#get_group_id_members) | **GET** /api/v2/groups/{groupId}/members | Get group members|
16
+ |[**get_groups**](GroupsApi.html#get_groups) | **GET** /api/v2/groups | Get a group list|
17
17
  |[**get_search**](GroupsApi.html#get_search) | **GET** /api/v2/groups/search | Search groups using the q64 value returned from a previous search|
18
- |[**post**](GroupsApi.html#post) | **POST** /api/v2/groups | Create a group|
19
18
  |[**post_group_id_members**](GroupsApi.html#post_group_id_members) | **POST** /api/v2/groups/{groupId}/members | Add members|
19
+ |[**post_groups**](GroupsApi.html#post_groups) | **POST** /api/v2/groups | Create a group|
20
20
  |[**post_search**](GroupsApi.html#post_search) | **POST** /api/v2/groups/search | Search groups|
21
21
  |[**put_group_id**](GroupsApi.html#put_group_id) | **PUT** /api/v2/groups/{groupId} | Update group|
22
22
  {: class="table table-striped"}
@@ -135,11 +135,11 @@ nil (empty response body)
135
135
 
136
136
 
137
137
 
138
- <a name="get"></a>
138
+ <a name="get_fieldconfig"></a>
139
139
 
140
- ## -[**GroupEntityListing**](GroupEntityListing.html) get(opts)
140
+ ## -[**FieldConfig**](FieldConfig.html) get_fieldconfig(type)
141
141
 
142
- Get a group list
142
+ Fetch field config for an entity type
143
143
 
144
144
 
145
145
 
@@ -160,18 +160,15 @@ end
160
160
 
161
161
  api_instance = PureCloud::GroupsApi.new
162
162
 
163
- opts = {
164
- page_size: 25, # Integer | Page size
165
- page_number: 1, # Integer | Page number
166
- sort_order: "ASC" # String | Ascending or descending sort order
167
- }
163
+ type = "type_example" # String | Field type
164
+
168
165
 
169
166
  begin
170
- #Get a group list
171
- result = api_instance.get(opts)
167
+ #Fetch field config for an entity type
168
+ result = api_instance.get_fieldconfig(type)
172
169
  p result
173
170
  rescue PureCloud::ApiError => e
174
- puts "Exception when calling GroupsApi->get: #{e}"
171
+ puts "Exception when calling GroupsApi->get_fieldconfig: #{e}"
175
172
  end
176
173
  ~~~
177
174
 
@@ -179,15 +176,13 @@ end
179
176
 
180
177
  Name | Type | Description | Notes
181
178
  ------------- | ------------- | ------------- | -------------
182
- **page_size** | **Integer**| Page size | [optional] [default to 25]
183
- **page_number** | **Integer**| Page number | [optional] [default to 1]
184
- **sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]
179
+ **type** | **String**| Field type |
185
180
  {: class="table table-striped"}
186
181
 
187
182
 
188
183
  ### Return type
189
184
 
190
- [**GroupEntityListing**](GroupEntityListing.html)
185
+ [**FieldConfig**](FieldConfig.html)
191
186
 
192
187
  ### HTTP request headers
193
188
 
@@ -196,11 +191,11 @@ Name | Type | Description | Notes
196
191
 
197
192
 
198
193
 
199
- <a name="get_fieldconfig"></a>
194
+ <a name="get_group_id"></a>
200
195
 
201
- ## -[**FieldConfig**](FieldConfig.html) get_fieldconfig(type)
196
+ ## -[**Group**](Group.html) get_group_id(group_id)
202
197
 
203
- Fetch field config for an entity type
198
+ Get group
204
199
 
205
200
 
206
201
 
@@ -221,15 +216,15 @@ end
221
216
 
222
217
  api_instance = PureCloud::GroupsApi.new
223
218
 
224
- type = "type_example" # String | Field type
219
+ group_id = "group_id_example" # String | Group ID
225
220
 
226
221
 
227
222
  begin
228
- #Fetch field config for an entity type
229
- result = api_instance.get_fieldconfig(type)
223
+ #Get group
224
+ result = api_instance.get_group_id(group_id)
230
225
  p result
231
226
  rescue PureCloud::ApiError => e
232
- puts "Exception when calling GroupsApi->get_fieldconfig: #{e}"
227
+ puts "Exception when calling GroupsApi->get_group_id: #{e}"
233
228
  end
234
229
  ~~~
235
230
 
@@ -237,13 +232,13 @@ end
237
232
 
238
233
  Name | Type | Description | Notes
239
234
  ------------- | ------------- | ------------- | -------------
240
- **type** | **String**| Field type |
235
+ **group_id** | **String**| Group ID |
241
236
  {: class="table table-striped"}
242
237
 
243
238
 
244
239
  ### Return type
245
240
 
246
- [**FieldConfig**](FieldConfig.html)
241
+ [**Group**](Group.html)
247
242
 
248
243
  ### HTTP request headers
249
244
 
@@ -252,11 +247,11 @@ Name | Type | Description | Notes
252
247
 
253
248
 
254
249
 
255
- <a name="get_group_id"></a>
250
+ <a name="get_group_id_members"></a>
256
251
 
257
- ## -[**Group**](Group.html) get_group_id(group_id)
252
+ ## -[**UserEntityListing**](UserEntityListing.html) get_group_id_members(group_id, opts)
258
253
 
259
- Get group
254
+ Get group members
260
255
 
261
256
 
262
257
 
@@ -279,13 +274,19 @@ api_instance = PureCloud::GroupsApi.new
279
274
 
280
275
  group_id = "group_id_example" # String | Group ID
281
276
 
277
+ opts = {
278
+ page_size: 25, # Integer | Page size
279
+ page_number: 1, # Integer | Page number
280
+ sort_order: "ASC", # String | Ascending or descending sort order
281
+ expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
282
+ }
282
283
 
283
284
  begin
284
- #Get group
285
- result = api_instance.get_group_id(group_id)
285
+ #Get group members
286
+ result = api_instance.get_group_id_members(group_id, opts)
286
287
  p result
287
288
  rescue PureCloud::ApiError => e
288
- puts "Exception when calling GroupsApi->get_group_id: #{e}"
289
+ puts "Exception when calling GroupsApi->get_group_id_members: #{e}"
289
290
  end
290
291
  ~~~
291
292
 
@@ -294,12 +295,16 @@ end
294
295
  Name | Type | Description | Notes
295
296
  ------------- | ------------- | ------------- | -------------
296
297
  **group_id** | **String**| Group ID |
298
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
299
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
300
+ **sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]
301
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional]
297
302
  {: class="table table-striped"}
298
303
 
299
304
 
300
305
  ### Return type
301
306
 
302
- [**Group**](Group.html)
307
+ [**UserEntityListing**](UserEntityListing.html)
303
308
 
304
309
  ### HTTP request headers
305
310
 
@@ -308,11 +313,11 @@ Name | Type | Description | Notes
308
313
 
309
314
 
310
315
 
311
- <a name="get_group_id_members"></a>
316
+ <a name="get_groups"></a>
312
317
 
313
- ## -[**UserEntityListing**](UserEntityListing.html) get_group_id_members(group_id, opts)
318
+ ## -[**GroupEntityListing**](GroupEntityListing.html) get_groups(opts)
314
319
 
315
- Get group members
320
+ Get a group list
316
321
 
317
322
 
318
323
 
@@ -333,21 +338,18 @@ end
333
338
 
334
339
  api_instance = PureCloud::GroupsApi.new
335
340
 
336
- group_id = "group_id_example" # String | Group ID
337
-
338
341
  opts = {
339
342
  page_size: 25, # Integer | Page size
340
343
  page_number: 1, # Integer | Page number
341
- sort_order: "ASC", # String | Ascending or descending sort order
342
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand
344
+ sort_order: "ASC" # String | Ascending or descending sort order
343
345
  }
344
346
 
345
347
  begin
346
- #Get group members
347
- result = api_instance.get_group_id_members(group_id, opts)
348
+ #Get a group list
349
+ result = api_instance.get_groups(opts)
348
350
  p result
349
351
  rescue PureCloud::ApiError => e
350
- puts "Exception when calling GroupsApi->get_group_id_members: #{e}"
352
+ puts "Exception when calling GroupsApi->get_groups: #{e}"
351
353
  end
352
354
  ~~~
353
355
 
@@ -355,17 +357,15 @@ end
355
357
 
356
358
  Name | Type | Description | Notes
357
359
  ------------- | ------------- | ------------- | -------------
358
- **group_id** | **String**| Group ID |
359
360
  **page_size** | **Integer**| Page size | [optional] [default to 25]
360
361
  **page_number** | **Integer**| Page number | [optional] [default to 1]
361
362
  **sort_order** | **String**| Ascending or descending sort order | [optional] [default to ASC]
362
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional]
363
363
  {: class="table table-striped"}
364
364
 
365
365
 
366
366
  ### Return type
367
367
 
368
- [**UserEntityListing**](UserEntityListing.html)
368
+ [**GroupEntityListing**](GroupEntityListing.html)
369
369
 
370
370
  ### HTTP request headers
371
371
 
@@ -434,11 +434,11 @@ Name | Type | Description | Notes
434
434
 
435
435
 
436
436
 
437
- <a name="post"></a>
437
+ <a name="post_group_id_members"></a>
438
438
 
439
- ## -[**Group**](Group.html) post(body)
439
+ ## - post_group_id_members(group_id, body)
440
440
 
441
- Create a group
441
+ Add members
442
442
 
443
443
 
444
444
 
@@ -459,15 +459,16 @@ end
459
459
 
460
460
  api_instance = PureCloud::GroupsApi.new
461
461
 
462
- body = PureCloud::Group.new # Group | Group
462
+ group_id = "group_id_example" # String | Group ID
463
+
464
+ body = PureCloud::GroupMembersUpdate.new # GroupMembersUpdate | Add members
463
465
 
464
466
 
465
467
  begin
466
- #Create a group
467
- result = api_instance.post(body)
468
- p result
468
+ #Add members
469
+ api_instance.post_group_id_members(group_id, body)
469
470
  rescue PureCloud::ApiError => e
470
- puts "Exception when calling GroupsApi->post: #{e}"
471
+ puts "Exception when calling GroupsApi->post_group_id_members: #{e}"
471
472
  end
472
473
  ~~~
473
474
 
@@ -475,13 +476,14 @@ end
475
476
 
476
477
  Name | Type | Description | Notes
477
478
  ------------- | ------------- | ------------- | -------------
478
- **body** | [**Group**](Group.html)| Group |
479
+ **group_id** | **String**| Group ID |
480
+ **body** | [**GroupMembersUpdate**](GroupMembersUpdate.html)| Add members |
479
481
  {: class="table table-striped"}
480
482
 
481
483
 
482
484
  ### Return type
483
485
 
484
- [**Group**](Group.html)
486
+ nil (empty response body)
485
487
 
486
488
  ### HTTP request headers
487
489
 
@@ -490,11 +492,11 @@ Name | Type | Description | Notes
490
492
 
491
493
 
492
494
 
493
- <a name="post_group_id_members"></a>
495
+ <a name="post_groups"></a>
494
496
 
495
- ## - post_group_id_members(group_id, body)
497
+ ## -[**Group**](Group.html) post_groups(body)
496
498
 
497
- Add members
499
+ Create a group
498
500
 
499
501
 
500
502
 
@@ -515,16 +517,15 @@ end
515
517
 
516
518
  api_instance = PureCloud::GroupsApi.new
517
519
 
518
- group_id = "group_id_example" # String | Group ID
519
-
520
- body = PureCloud::GroupMembersUpdate.new # GroupMembersUpdate | Add members
520
+ body = PureCloud::Group.new # Group | Group
521
521
 
522
522
 
523
523
  begin
524
- #Add members
525
- api_instance.post_group_id_members(group_id, body)
524
+ #Create a group
525
+ result = api_instance.post_groups(body)
526
+ p result
526
527
  rescue PureCloud::ApiError => e
527
- puts "Exception when calling GroupsApi->post_group_id_members: #{e}"
528
+ puts "Exception when calling GroupsApi->post_groups: #{e}"
528
529
  end
529
530
  ~~~
530
531
 
@@ -532,14 +533,13 @@ end
532
533
 
533
534
  Name | Type | Description | Notes
534
535
  ------------- | ------------- | ------------- | -------------
535
- **group_id** | **String**| Group ID |
536
- **body** | [**GroupMembersUpdate**](GroupMembersUpdate.html)| Add members |
536
+ **body** | [**Group**](Group.html)| Group |
537
537
  {: class="table table-striped"}
538
538
 
539
539
 
540
540
  ### Return type
541
541
 
542
- nil (empty response body)
542
+ [**Group**](Group.html)
543
543
 
544
544
  ### HTTP request headers
545
545