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/Site.html.md CHANGED
@@ -26,7 +26,7 @@ title: Site
26
26
  | **edges** | [**Array<Edge>**](Edge.html) | | [optional] |
27
27
  | **edge_auto_update_config** | [**EdgeAutoUpdateConfig**](EdgeAutoUpdateConfig.html) | Recurrance rule, time zone, and start/end settings for automatic edge updates for this site | [optional] |
28
28
  | **location** | [**LocationDefinition**](LocationDefinition.html) | Location | |
29
- | **managed** | **BOOLEAN** | | [optional] |
29
+ | **managed** | **BOOLEAN** | | [optional] [default to false]|
30
30
  | **self_uri** | **String** | The URI for this object | [optional] |
31
31
  {: class="table table-striped"}
32
32
 
data/doc_out/SocialExpression.html.md CHANGED
@@ -15,7 +15,7 @@ title: SocialExpression
15
15
  | **preview_text** | **String** | The text preview of the communication contents | [optional] |
16
16
  | **recording_id** | **String** | A globally unique identifier for the recording associated with this chat. | [optional] |
17
17
  | **segments** | [**Array<Segment>**](Segment.html) | The time line of the participant's chat, divided into activity segments. | [optional] |
18
- | **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional] |
18
+ | **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional] [default to false]|
19
19
  | **disconnect_type** | **String** | System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. | [optional] |
20
20
  | **start_hold_time** | **DateTime** | The timestamp the chat was placed on hold in the cloud clock if the chat is currently on hold. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
21
21
  | **connected_time** | **DateTime** | The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
data/doc_out/SortItem.html.md CHANGED
@@ -8,7 +8,7 @@ title: SortItem
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **name** | **String** | | [optional] |
11
- | **ascending** | **BOOLEAN** | | [optional] |
11
+ | **ascending** | **BOOLEAN** | | [optional] [default to false]|
12
12
  {: class="table table-striped"}
13
13
 
14
14
 
data/doc_out/TagValue.html.md CHANGED
@@ -9,7 +9,7 @@ title: TagValue
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | The workspace tag name. | |
12
- | **in_use** | **BOOLEAN** | | [optional] |
12
+ | **in_use** | **BOOLEAN** | | [optional] [default to false]|
13
13
  | **acl** | **Array<String>** | | [optional] |
14
14
  | **self_uri** | **String** | The URI for this object | [optional] |
15
15
  {: class="table table-striped"}
data/doc_out/TimeAllowed.html.md CHANGED
@@ -9,7 +9,7 @@ title: TimeAllowed
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **time_slots** | [**Array<TimeSlot>**](TimeSlot.html) | | [optional] |
11
11
  | **time_zone_id** | **String** | | [optional] |
12
- | **empty** | **BOOLEAN** | | [optional] |
12
+ | **empty** | **BOOLEAN** | | [optional] [default to false]|
13
13
  {: class="table table-striped"}
14
14
 
15
15
 
data/doc_out/TimeOffRequest.html.md CHANGED
@@ -10,8 +10,8 @@ title: TimeOffRequest
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **user** | [**User**](User.html) | The user associated with this TimeOffRequest | |
13
- | **is_full_day_request** | **BOOLEAN** | Whether this is a full day request (false means partial day) | |
14
- | **marked_as_read** | **BOOLEAN** | Whether this request has been marked as read by the agent | |
13
+ | **is_full_day_request** | **BOOLEAN** | Whether this is a full day request (false means partial day) | [default to false]|
14
+ | **marked_as_read** | **BOOLEAN** | Whether this request has been marked as read by the agent | [default to false]|
15
15
  | **activity_code_id** | **String** | The ID of the activity code associated with this TimeOffRequest | |
16
16
  | **status** | **String** | The administrative status of this TimeOffRequest | |
17
17
  | **partial_day_start_date_times** | **Array<DateTime>** | The start date-times for partial day requests. Required if isFullDayRequest == false | [optional] |
data/doc_out/TimeOffRequestPatch.html.md CHANGED
@@ -7,7 +7,7 @@ title: TimeOffRequestPatch
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **marked_as_read** | **BOOLEAN** | | [optional] |
10
+ | **marked_as_read** | **BOOLEAN** | | [optional] [default to false]|
11
11
  {: class="table table-striped"}
12
12
 
13
13
 
data/doc_out/TransferRequest.html.md CHANGED
@@ -11,7 +11,7 @@ title: TransferRequest
11
11
  | **address** | **String** | The phone number or address of the transfer target. | [optional] |
12
12
  | **user_name** | **String** | The user name of the transfer target. | [optional] |
13
13
  | **queue_id** | **String** | The queue ID of the transfer target. | [optional] |
14
- | **voicemail** | **BOOLEAN** | If true, then transfer to the user's voicemail. | [optional] |
14
+ | **voicemail** | **BOOLEAN** | If true, then transfer to the user's voicemail. | [optional] [default to false]|
15
15
  {: class="table table-striped"}
16
16
 
17
17
 
data/doc_out/Trunk.html.md CHANGED
@@ -23,7 +23,7 @@ title: Trunk
23
23
  | **trunk_base** | [**UriReference**](UriReference.html) | The trunk base configuration used on this trunk. | [optional] |
24
24
  | **trunk_metabase** | [**UriReference**](UriReference.html) | The metabase used to create this trunk. | [optional] |
25
25
  | **edge_group** | [**UriReference**](UriReference.html) | The edge group associated with this trunk. | [optional] |
26
- | **enabled** | **BOOLEAN** | True if this trunk is in-service. This comes from the trunk_enabled property of the referenced trunk base. | [optional] |
26
+ | **enabled** | **BOOLEAN** | True if this trunk is in-service. This comes from the trunk_enabled property of the referenced trunk base. | [optional] [default to false]|
27
27
  | **self_uri** | **String** | The URI for this object | [optional] |
28
28
  {: class="table table-striped"}
29
29
 
data/doc_out/TrunkBase.html.md CHANGED
@@ -21,7 +21,7 @@ title: TrunkBase
21
21
  | **trunk_metabase** | [**UriReference**](UriReference.html) | The meta-base this trunk is based on. | |
22
22
  | **properties** | **Hash<String, Object>** | | [optional] |
23
23
  | **trunk_type** | **String** | The type of this trunk base. | |
24
- | **managed** | **BOOLEAN** | Is this trunk being managed remotely. | [optional] |
24
+ | **managed** | **BOOLEAN** | Is this trunk being managed remotely. | [optional] [default to false]|
25
25
  | **self_uri** | **String** | The URI for this object | [optional] |
26
26
  {: class="table table-striped"}
27
27
 
data/doc_out/UnreadStatus.html.md CHANGED
@@ -7,7 +7,7 @@ title: UnreadStatus
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **unread** | **BOOLEAN** | Sets if the alert is read or unread. | [optional] |
10
+ | **unread** | **BOOLEAN** | Sets if the alert is read or unread. | [optional] [default to false]|
11
11
  {: class="table table-striped"}
12
12
 
13
13
 
data/doc_out/UserPresence.html.md CHANGED
@@ -10,7 +10,7 @@ title: UserPresence
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **source** | **String** | Represents the source where the Presence was set. Some examples are: PURECLOUD, LYNC, OUTLOOK, etc. | [optional] |
13
- | **primary** | **BOOLEAN** | A boolean used to tell whether or not to set this presence source as the primary on a PATCH | [optional] |
13
+ | **primary** | **BOOLEAN** | A boolean used to tell whether or not to set this presence source as the primary on a PATCH | [optional] [default to false]|
14
14
  | **presence_definition** | [**OrganizationPresence**](OrganizationPresence.html) | | [optional] |
15
15
  | **message** | **String** | | [optional] |
16
16
  | **modified_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
data/doc_out/UserPresenceRule.html.md CHANGED
@@ -13,8 +13,8 @@ title: UserPresenceRule
13
13
  | **presence_type** | **String** | Indicates to which presence type the presence value belongs. | |
14
14
  | **presence_value** | **String** | The Org's UUID or Systems enum constance indicating the presence of concern. | |
15
15
  | **presence_limit_in_seconds** | **Integer** | The number of seconds to wait before alerting based upon the user's presence. | |
16
- | **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | |
17
- | **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] |
16
+ | **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | [default to false]|
17
+ | **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] [default to false]|
18
18
  | **notification_users** | [**Array<User>**](User.html) | The ids of users who will be notified of alarm state change. | |
19
19
  | **alert_types** | **Array<String>** | A collection of notification methods. | |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
data/doc_out/UserQueue.html.md CHANGED
@@ -26,7 +26,7 @@ title: UserQueue
26
26
  | **calling_party_name** | **String** | The name to use for caller identification for outbound calls from this queue. | [optional] |
27
27
  | **calling_party_number** | **String** | The phone number to use for caller identification for outbound calls from this queue. | [optional] |
28
28
  | **outbound_email_address** | [**QueueEmailAddress**](QueueEmailAddress.html) | | [optional] |
29
- | **joined** | **BOOLEAN** | | [optional] |
29
+ | **joined** | **BOOLEAN** | | [optional] [default to false]|
30
30
  | **member_count** | **Integer** | | [optional] |
31
31
  | **self_uri** | **String** | The URI for this object | [optional] |
32
32
  {: class="table table-striped"}
data/doc_out/UserRecording.html.md CHANGED
@@ -18,7 +18,7 @@ title: UserRecording
18
18
  | **content_length** | **Integer** | | [optional] |
19
19
  | **duration_milliseconds** | **Integer** | | [optional] |
20
20
  | **thumbnails** | [**Array<DocumentThumbnail>**](DocumentThumbnail.html) | | [optional] |
21
- | **read** | **BOOLEAN** | | [optional] |
21
+ | **read** | **BOOLEAN** | | [optional] [default to false]|
22
22
  | **self_uri** | **String** | The URI for this object | [optional] |
23
23
  {: class="table table-striped"}
24
24
 
data/doc_out/UserRecordingsApi.html.md CHANGED
@@ -9,10 +9,10 @@ All URIs are relative to *https://api.mypurecloud.com*
9
9
  Method | HTTP request | Description
10
10
  ------------- | ------------- | -------------
11
11
  |[**delete_recording_id**](UserRecordingsApi.html#delete_recording_id) | **DELETE** /api/v2/userrecordings/{recordingId} | Delete a user recording.|
12
- |[**get**](UserRecordingsApi.html#get) | **GET** /api/v2/userrecordings | Get a list of user recordings.|
13
12
  |[**get_recording_id**](UserRecordingsApi.html#get_recording_id) | **GET** /api/v2/userrecordings/{recordingId} | Get a user recording.|
14
13
  |[**get_recording_id_media**](UserRecordingsApi.html#get_recording_id_media) | **GET** /api/v2/userrecordings/{recordingId}/media | Download a user recording.|
15
14
  |[**get_summary**](UserRecordingsApi.html#get_summary) | **GET** /api/v2/userrecordings/summary | Get user recording summary|
15
+ |[**get_userrecordings**](UserRecordingsApi.html#get_userrecordings) | **GET** /api/v2/userrecordings | Get a list of user recordings.|
16
16
  |[**put_recording_id**](UserRecordingsApi.html#put_recording_id) | **PUT** /api/v2/userrecordings/{recordingId} | Update a user recording.|
17
17
  {: class="table table-striped"}
18
18
 
@@ -71,11 +71,11 @@ nil (empty response body)
71
71
 
72
72
 
73
73
 
74
- <a name="get"></a>
74
+ <a name="get_recording_id"></a>
75
75
 
76
- ## -[**UserRecordingEntityListing**](UserRecordingEntityListing.html) get(opts)
76
+ ## -[**UserRecording**](UserRecording.html) get_recording_id(recording_id, opts)
77
77
 
78
- Get a list of user recordings.
78
+ Get a user recording.
79
79
 
80
80
 
81
81
 
@@ -96,18 +96,18 @@ end
96
96
 
97
97
  api_instance = PureCloud::UserRecordingsApi.new
98
98
 
99
+ recording_id = "recording_id_example" # String | User Recording ID
100
+
99
101
  opts = {
100
- page_size: 25, # Integer | Page size
101
- page_number: 1, # Integer | Page number
102
102
  expand: ["expand_example"] # Array<String> | Which fields, if any, to expand.
103
103
  }
104
104
 
105
105
  begin
106
- #Get a list of user recordings.
107
- result = api_instance.get(opts)
106
+ #Get a user recording.
107
+ result = api_instance.get_recording_id(recording_id, opts)
108
108
  p result
109
109
  rescue PureCloud::ApiError => e
110
- puts "Exception when calling UserRecordingsApi->get: #{e}"
110
+ puts "Exception when calling UserRecordingsApi->get_recording_id: #{e}"
111
111
  end
112
112
  ~~~
113
113
 
@@ -115,15 +115,14 @@ end
115
115
 
116
116
  Name | Type | Description | Notes
117
117
  ------------- | ------------- | ------------- | -------------
118
- **page_size** | **Integer**| Page size | [optional] [default to 25]
119
- **page_number** | **Integer**| Page number | [optional] [default to 1]
118
+ **recording_id** | **String**| User Recording ID |
120
119
  **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional]
121
120
  {: class="table table-striped"}
122
121
 
123
122
 
124
123
  ### Return type
125
124
 
126
- [**UserRecordingEntityListing**](UserRecordingEntityListing.html)
125
+ [**UserRecording**](UserRecording.html)
127
126
 
128
127
  ### HTTP request headers
129
128
 
@@ -132,11 +131,11 @@ Name | Type | Description | Notes
132
131
 
133
132
 
134
133
 
135
- <a name="get_recording_id"></a>
134
+ <a name="get_recording_id_media"></a>
136
135
 
137
- ## -[**UserRecording**](UserRecording.html) get_recording_id(recording_id, opts)
136
+ ## -[**DownloadResponse**](DownloadResponse.html) get_recording_id_media(recording_id, opts)
138
137
 
139
- Get a user recording.
138
+ Download a user recording.
140
139
 
141
140
 
142
141
 
@@ -160,15 +159,15 @@ api_instance = PureCloud::UserRecordingsApi.new
160
159
  recording_id = "recording_id_example" # String | User Recording ID
161
160
 
162
161
  opts = {
163
- expand: ["expand_example"] # Array<String> | Which fields, if any, to expand.
162
+ format_id: "WEBM" # String | The desired media format.
164
163
  }
165
164
 
166
165
  begin
167
- #Get a user recording.
168
- result = api_instance.get_recording_id(recording_id, opts)
166
+ #Download a user recording.
167
+ result = api_instance.get_recording_id_media(recording_id, opts)
169
168
  p result
170
169
  rescue PureCloud::ApiError => e
171
- puts "Exception when calling UserRecordingsApi->get_recording_id: #{e}"
170
+ puts "Exception when calling UserRecordingsApi->get_recording_id_media: #{e}"
172
171
  end
173
172
  ~~~
174
173
 
@@ -177,13 +176,13 @@ end
177
176
  Name | Type | Description | Notes
178
177
  ------------- | ------------- | ------------- | -------------
179
178
  **recording_id** | **String**| User Recording ID |
180
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional]
179
+ **format_id** | **String**| The desired media format. | [optional] [default to WEBM]
181
180
  {: class="table table-striped"}
182
181
 
183
182
 
184
183
  ### Return type
185
184
 
186
- [**UserRecording**](UserRecording.html)
185
+ [**DownloadResponse**](DownloadResponse.html)
187
186
 
188
187
  ### HTTP request headers
189
188
 
@@ -192,11 +191,11 @@ Name | Type | Description | Notes
192
191
 
193
192
 
194
193
 
195
- <a name="get_recording_id_media"></a>
194
+ <a name="get_summary"></a>
196
195
 
197
- ## -[**DownloadResponse**](DownloadResponse.html) get_recording_id_media(recording_id, opts)
196
+ ## -[**FaxSummary**](FaxSummary.html) get_summary
198
197
 
199
- Download a user recording.
198
+ Get user recording summary
200
199
 
201
200
 
202
201
 
@@ -217,33 +216,23 @@ end
217
216
 
218
217
  api_instance = PureCloud::UserRecordingsApi.new
219
218
 
220
- recording_id = "recording_id_example" # String | User Recording ID
221
-
222
- opts = {
223
- format_id: "WEBM" # String | The desired media format.
224
- }
225
-
226
219
  begin
227
- #Download a user recording.
228
- result = api_instance.get_recording_id_media(recording_id, opts)
220
+ #Get user recording summary
221
+ result = api_instance.get_summary
229
222
  p result
230
223
  rescue PureCloud::ApiError => e
231
- puts "Exception when calling UserRecordingsApi->get_recording_id_media: #{e}"
224
+ puts "Exception when calling UserRecordingsApi->get_summary: #{e}"
232
225
  end
233
226
  ~~~
234
227
 
235
228
  ### Parameters
236
-
237
- Name | Type | Description | Notes
238
- ------------- | ------------- | ------------- | -------------
239
- **recording_id** | **String**| User Recording ID |
240
- **format_id** | **String**| The desired media format. | [optional] [default to WEBM]
229
+ This endpoint does not need any parameter.
241
230
  {: class="table table-striped"}
242
231
 
243
232
 
244
233
  ### Return type
245
234
 
246
- [**DownloadResponse**](DownloadResponse.html)
235
+ [**FaxSummary**](FaxSummary.html)
247
236
 
248
237
  ### HTTP request headers
249
238
 
@@ -252,11 +241,11 @@ Name | Type | Description | Notes
252
241
 
253
242
 
254
243
 
255
- <a name="get_summary"></a>
244
+ <a name="get_userrecordings"></a>
256
245
 
257
- ## -[**FaxSummary**](FaxSummary.html) get_summary
246
+ ## -[**UserRecordingEntityListing**](UserRecordingEntityListing.html) get_userrecordings(opts)
258
247
 
259
- Get user recording summary
248
+ Get a list of user recordings.
260
249
 
261
250
 
262
251
 
@@ -277,23 +266,34 @@ end
277
266
 
278
267
  api_instance = PureCloud::UserRecordingsApi.new
279
268
 
269
+ opts = {
270
+ page_size: 25, # Integer | Page size
271
+ page_number: 1, # Integer | Page number
272
+ expand: ["expand_example"] # Array<String> | Which fields, if any, to expand.
273
+ }
274
+
280
275
  begin
281
- #Get user recording summary
282
- result = api_instance.get_summary
276
+ #Get a list of user recordings.
277
+ result = api_instance.get_userrecordings(opts)
283
278
  p result
284
279
  rescue PureCloud::ApiError => e
285
- puts "Exception when calling UserRecordingsApi->get_summary: #{e}"
280
+ puts "Exception when calling UserRecordingsApi->get_userrecordings: #{e}"
286
281
  end
287
282
  ~~~
288
283
 
289
284
  ### Parameters
290
- This endpoint does not need any parameter.
285
+
286
+ Name | Type | Description | Notes
287
+ ------------- | ------------- | ------------- | -------------
288
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
289
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
290
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional]
291
291
  {: class="table table-striped"}
292
292
 
293
293
 
294
294
  ### Return type
295
295
 
296
- [**FaxSummary**](FaxSummary.html)
296
+ [**UserRecordingEntityListing**](UserRecordingEntityListing.html)
297
297
 
298
298
  ### HTTP request headers
299
299
 
data/doc_out/UserScheduleAdherence.html.md CHANGED
@@ -16,7 +16,7 @@ title: UserScheduleAdherence
16
16
  | **organization_secondary_presence_id** | **String** | Organization Secondary Presence Id. | [optional] |
17
17
  | **routing_status** | **String** | Actual underlying routing status, used to determine whether a user is actually in adherence when OnQueue | [optional] |
18
18
  | **actual_activity_category** | **String** | Activity in which the user is actually engaged | [optional] |
19
- | **is_out_of_office** | **BOOLEAN** | Whether the user is marked OutOfOffice | [optional] |
19
+ | **is_out_of_office** | **BOOLEAN** | Whether the user is marked OutOfOffice | [optional] [default to false]|
20
20
  | **adherence_state** | **String** | The user&#39;s current adherence state | [optional] |
21
21
  | **impact** | **String** | The impact of the user&#39;s current adherenceState | [optional] |
22
22
  | **time_of_adherence_change** | **String** | Time when the user entered the current adherenceState in ISO-8601 format | [optional] |
data/doc_out/ValidateAddressResponse.html.md CHANGED
@@ -7,7 +7,7 @@ title: ValidateAddressResponse
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **valid** | **BOOLEAN** | Was the passed in address valid | |
10
+ | **valid** | **BOOLEAN** | Was the passed in address valid | [default to false]|
11
11
  | **response** | [**SubscriberResponse**](SubscriberResponse.html) | Subscriber schema | [optional] |
12
12
  {: class="table table-striped"}
13
13
 
data/doc_out/Video.html.md CHANGED
@@ -10,9 +10,9 @@ title: Video
10
10
  | **state** | **String** | The connection state of this communication. | [optional] |
11
11
  | **id** | **String** | A globally unique identifier for this communication. | [optional] |
12
12
  | **context** | **String** | The room id context (xmpp jid) for the conference session. | [optional] |
13
- | **audio_muted** | **BOOLEAN** | Indicates whether this participant has muted their outgoing audio. | [optional] |
14
- | **video_muted** | **BOOLEAN** | Indicates whether this participant has muted/paused their outgoing video. | [optional] |
15
- | **sharing_screen** | **BOOLEAN** | Indicates whether this participant is sharing their screen to the session. | [optional] |
13
+ | **audio_muted** | **BOOLEAN** | Indicates whether this participant has muted their outgoing audio. | [optional] [default to false]|
14
+ | **video_muted** | **BOOLEAN** | Indicates whether this participant has muted/paused their outgoing video. | [optional] [default to false]|
15
+ | **sharing_screen** | **BOOLEAN** | Indicates whether this participant is sharing their screen to the session. | [optional] [default to false]|
16
16
  | **peer_count** | **Integer** | The number of peer participants from the perspective of the participant in the conference. | [optional] |
17
17
  | **disconnect_type** | **String** | System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. | [optional] |
18
18
  | **connected_time** | **DateTime** | The timestamp when this communication was connected in the cloud clock. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
data/doc_out/VoicemailGroupPolicy.html.md CHANGED
@@ -9,8 +9,8 @@ title: VoicemailGroupPolicy
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **name** | **String** | | [optional] |
11
11
  | **group** | [**Group**](Group.html) | The group associated with the policy | [optional] |
12
- | **enabled** | **BOOLEAN** | Whether voicemail is enabled for the group | [optional] |
13
- | **send_email_notifications** | **BOOLEAN** | Whether email notifications are sent to group members when a new voicemail is received | [optional] |
12
+ | **enabled** | **BOOLEAN** | Whether voicemail is enabled for the group | [optional] [default to false]|
13
+ | **send_email_notifications** | **BOOLEAN** | Whether email notifications are sent to group members when a new voicemail is received | [optional] [default to false]|
14
14
  | **rotate_calls_secs** | **Integer** | How many seconds to ring before rotating to the next member in the group | [optional] |
15
15
  | **stop_ringing_after_rotations** | **Integer** | How many rotations to go through | [optional] |
16
16
  {: class="table table-striped"}
data/doc_out/VoicemailMessage.html.md CHANGED
@@ -9,7 +9,7 @@ title: VoicemailMessage
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **conversation** | [**Conversation**](Conversation.html) | The conversation that the voicemail message is associated with | [optional] |
12
- | **read** | **BOOLEAN** | Whether the voicemail message is marked as read | [optional] |
12
+ | **read** | **BOOLEAN** | Whether the voicemail message is marked as read | [optional] [default to false]|
13
13
  | **audio_recording_duration_seconds** | **Integer** | The voicemail message&#39;s audio recording duration in seconds | [optional] |
14
14
  | **audio_recording_size_bytes** | **Integer** | The voicemail message&#39;s audio recording size in bytes | [optional] |
15
15
  | **created_date** | **DateTime** | The date the voicemail message was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
@@ -17,7 +17,7 @@ title: VoicemailMessage
17
17
  | **caller_address** | **String** | The caller address | [optional] |
18
18
  | **caller_name** | **String** | Optionally the name of the caller that left the voicemail message if the caller was a known user | [optional] |
19
19
  | **caller_user** | [**User**](User.html) | Optionally the user that left the voicemail message if the caller was a known user | [optional] |
20
- | **deleted** | **BOOLEAN** | Whether the voicemail message has been marked as deleted | [optional] |
20
+ | **deleted** | **BOOLEAN** | Whether the voicemail message has been marked as deleted | [optional] [default to false]|
21
21
  | **note** | **String** | An optional note | [optional] |
22
22
  | **user** | [**User**](User.html) | The user that the voicemail message belongs to or null which means the voicemail message belongs to a group | [optional] |
23
23
  | **group** | [**Group**](Group.html) | The group that the voicemail message belongs to or null which means the voicemail message belongs to a user | [optional] |
data/doc_out/VoicemailOrganizationPolicy.html.md CHANGED
@@ -7,7 +7,7 @@ title: VoicemailOrganizationPolicy
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **enabled** | **BOOLEAN** | | [optional] |
10
+ | **enabled** | **BOOLEAN** | | [optional] [default to false]|
11
11
  | **retention_time_days** | **Integer** | | [optional] |
12
12
  | **alert_timeout_seconds** | **Integer** | | [optional] |
13
13
  | **minimum_recording_time_seconds** | **Integer** | | [optional] |
@@ -15,14 +15,14 @@ title: VoicemailOrganizationPolicy
15
15
  | **unavailable_message_uri** | **String** | | [optional] |
16
16
  | **name_prompt_message_uri** | **String** | | [optional] |
17
17
  | **full_message_uri** | **String** | | [optional] |
18
- | **compress_silence** | **BOOLEAN** | | [optional] |
18
+ | **compress_silence** | **BOOLEAN** | | [optional] [default to false]|
19
19
  | **pin_configuration** | [**PINConfiguration**](PINConfiguration.html) | | [optional] |
20
20
  | **quota_size_bytes** | **Integer** | | [optional] |
21
21
  | **created_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
22
22
  | **modified_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
23
23
  | **voicemail_extension** | **String** | The extension for voicemail retrieval. The default value is *86. | [optional] |
24
- | **pin_required** | **BOOLEAN** | If this is true, a PIN is required when accessing a user&#39;s voicemail from a phone. | [optional] |
25
- | **send_email_notifications** | **BOOLEAN** | Whether email notifications are sent for new voicemails in the organization. If false, new voicemail email notifications are not be sent for the organization overriding any user or group setting. | [optional] |
24
+ | **pin_required** | **BOOLEAN** | If this is true, a PIN is required when accessing a user&#39;s voicemail from a phone. | [optional] [default to false]|
25
+ | **send_email_notifications** | **BOOLEAN** | Whether email notifications are sent for new voicemails in the organization. If false, new voicemail email notifications are not be sent for the organization overriding any user or group setting. | [optional] [default to false]|
26
26
  {: class="table table-striped"}
27
27
 
28
28