purecloud 0.63.1 → 0.64.1

Sign up to get free protection for your applications and to get access to all the features.
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/HeartBeatRule.html.md CHANGED
@@ -11,8 +11,8 @@ title: HeartBeatRule
11
11
  | **name** | **String** | Name of the rule | |
12
12
  | **sender_id** | **String** | The value that identifies the sender of the heartbeat. | |
13
13
  | **heart_beat_timeout_in_minutes** | **Integer** | The number of minutes to wait before alerting missing heartbeats. | |
14
- | **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | |
15
- | **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] |
14
+ | **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | [default to false]|
15
+ | **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] [default to false]|
16
16
  | **notification_users** | [**Array<User>**](User.html) | The ids of users who will be notified of alarm state change. | |
17
17
  | **alert_types** | **Array<String>** | A collection of notification methods. | |
18
18
  | **rule_type** | **String** | The type of system the will be generating the heartbeat. | |
data/doc_out/IdentityProviderApi.html.md CHANGED
@@ -15,9 +15,9 @@ Method | HTTP request | Description
15
15
  |[**delete_provider_id**](IdentityProviderApi.html#delete_provider_id) | **DELETE** /api/v2/identityproviders/{providerId} | Delete an identity provider|
16
16
  |[**delete_purecloud**](IdentityProviderApi.html#delete_purecloud) | **DELETE** /api/v2/identityproviders/purecloud | Delete PureCloud Identity Provider|
17
17
  |[**delete_salesforce**](IdentityProviderApi.html#delete_salesforce) | **DELETE** /api/v2/identityproviders/salesforce | Delete Salesforce Identity Provider|
18
- |[**get**](IdentityProviderApi.html#get) | **GET** /api/v2/identityproviders | The list of identity providers|
19
18
  |[**get_adfs**](IdentityProviderApi.html#get_adfs) | **GET** /api/v2/identityproviders/adfs | Get ADFS Identity Provider|
20
19
  |[**get_cic**](IdentityProviderApi.html#get_cic) | **GET** /api/v2/identityproviders/cic | Get Customer Interaction Center (CIC) Identity Provider|
20
+ |[**get_identityproviders**](IdentityProviderApi.html#get_identityproviders) | **GET** /api/v2/identityproviders | The list of identity providers|
21
21
  |[**get_okta**](IdentityProviderApi.html#get_okta) | **GET** /api/v2/identityproviders/okta | Get Okta Identity Provider|
22
22
  |[**get_onelogin**](IdentityProviderApi.html#get_onelogin) | **GET** /api/v2/identityproviders/onelogin | Get OneLogin Identity Provider|
23
23
  |[**get_provider_id**](IdentityProviderApi.html#get_provider_id) | **GET** /api/v2/identityproviders/{providerId} | Get an identity provider|
@@ -375,11 +375,11 @@ nil (empty response body)
375
375
 
376
376
 
377
377
 
378
- <a name="get"></a>
378
+ <a name="get_adfs"></a>
379
379
 
380
- ## -[**OAuthProviderEntityListing**](OAuthProviderEntityListing.html) get
380
+ ## -[**ADFS**](ADFS.html) get_adfs
381
381
 
382
- The list of identity providers
382
+ Get ADFS Identity Provider
383
383
 
384
384
 
385
385
 
@@ -401,11 +401,11 @@ end
401
401
  api_instance = PureCloud::IdentityProviderApi.new
402
402
 
403
403
  begin
404
- #The list of identity providers
405
- result = api_instance.get
404
+ #Get ADFS Identity Provider
405
+ result = api_instance.get_adfs
406
406
  p result
407
407
  rescue PureCloud::ApiError => e
408
- puts "Exception when calling IdentityProviderApi->get: #{e}"
408
+ puts "Exception when calling IdentityProviderApi->get_adfs: #{e}"
409
409
  end
410
410
  ~~~
411
411
 
@@ -416,7 +416,7 @@ This endpoint does not need any parameter.
416
416
 
417
417
  ### Return type
418
418
 
419
- [**OAuthProviderEntityListing**](OAuthProviderEntityListing.html)
419
+ [**ADFS**](ADFS.html)
420
420
 
421
421
  ### HTTP request headers
422
422
 
@@ -425,11 +425,11 @@ This endpoint does not need any parameter.
425
425
 
426
426
 
427
427
 
428
- <a name="get_adfs"></a>
428
+ <a name="get_cic"></a>
429
429
 
430
- ## -[**ADFS**](ADFS.html) get_adfs
430
+ ## -[**CustomerInteractionCenter**](CustomerInteractionCenter.html) get_cic
431
431
 
432
- Get ADFS Identity Provider
432
+ Get Customer Interaction Center (CIC) Identity Provider
433
433
 
434
434
 
435
435
 
@@ -451,11 +451,11 @@ end
451
451
  api_instance = PureCloud::IdentityProviderApi.new
452
452
 
453
453
  begin
454
- #Get ADFS Identity Provider
455
- result = api_instance.get_adfs
454
+ #Get Customer Interaction Center (CIC) Identity Provider
455
+ result = api_instance.get_cic
456
456
  p result
457
457
  rescue PureCloud::ApiError => e
458
- puts "Exception when calling IdentityProviderApi->get_adfs: #{e}"
458
+ puts "Exception when calling IdentityProviderApi->get_cic: #{e}"
459
459
  end
460
460
  ~~~
461
461
 
@@ -466,7 +466,7 @@ This endpoint does not need any parameter.
466
466
 
467
467
  ### Return type
468
468
 
469
- [**ADFS**](ADFS.html)
469
+ [**CustomerInteractionCenter**](CustomerInteractionCenter.html)
470
470
 
471
471
  ### HTTP request headers
472
472
 
@@ -475,11 +475,11 @@ This endpoint does not need any parameter.
475
475
 
476
476
 
477
477
 
478
- <a name="get_cic"></a>
478
+ <a name="get_identityproviders"></a>
479
479
 
480
- ## -[**CustomerInteractionCenter**](CustomerInteractionCenter.html) get_cic
480
+ ## -[**OAuthProviderEntityListing**](OAuthProviderEntityListing.html) get_identityproviders
481
481
 
482
- Get Customer Interaction Center (CIC) Identity Provider
482
+ The list of identity providers
483
483
 
484
484
 
485
485
 
@@ -501,11 +501,11 @@ end
501
501
  api_instance = PureCloud::IdentityProviderApi.new
502
502
 
503
503
  begin
504
- #Get Customer Interaction Center (CIC) Identity Provider
505
- result = api_instance.get_cic
504
+ #The list of identity providers
505
+ result = api_instance.get_identityproviders
506
506
  p result
507
507
  rescue PureCloud::ApiError => e
508
- puts "Exception when calling IdentityProviderApi->get_cic: #{e}"
508
+ puts "Exception when calling IdentityProviderApi->get_identityproviders: #{e}"
509
509
  end
510
510
  ~~~
511
511
 
@@ -516,7 +516,7 @@ This endpoint does not need any parameter.
516
516
 
517
517
  ### Return type
518
518
 
519
- [**CustomerInteractionCenter**](CustomerInteractionCenter.html)
519
+ [**OAuthProviderEntityListing**](OAuthProviderEntityListing.html)
520
520
 
521
521
  ### HTTP request headers
522
522
 
data/doc_out/InboundDomain.html.md CHANGED
@@ -10,7 +10,7 @@ title: InboundDomain
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **mx_record_status** | **String** | Mx Record Status | |
13
- | **sub_domain** | **BOOLEAN** | Indicates if this a PureCloud sub-domain. If true, then the appropriate DNS records are created for sending/receiving email. | [optional] |
13
+ | **sub_domain** | **BOOLEAN** | Indicates if this a PureCloud sub-domain. If true, then the appropriate DNS records are created for sending/receiving email. | [optional] [default to false]|
14
14
  | **self_uri** | **String** | The URI for this object | [optional] |
15
15
  {: class="table table-striped"}
16
16
 
data/doc_out/InitiateScreenRecording.html.md CHANGED
@@ -7,7 +7,7 @@ title: InitiateScreenRecording
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **record_acw** | **BOOLEAN** | | [optional] |
10
+ | **record_acw** | **BOOLEAN** | | [optional] [default to false]|
11
11
  | **archive_retention** | [**ArchiveRetention**](ArchiveRetention.html) | | [optional] |
12
12
  | **delete_retention** | [**DeleteRetention**](DeleteRetention.html) | | [optional] |
13
13
  {: class="table table-striped"}
data/doc_out/InteractionStatsAlert.html.md CHANGED
@@ -17,7 +17,7 @@ title: InteractionStatsAlert
17
17
  | **statistic** | **String** | The statistic of concern for the metric. | |
18
18
  | **value** | **Float** | The threshold value. | |
19
19
  | **rule_id** | **String** | The id of the rule. | |
20
- | **unread** | **BOOLEAN** | Indicates if the alert has been read. | |
20
+ | **unread** | **BOOLEAN** | Indicates if the alert has been read. | [default to false]|
21
21
  | **start_date** | **DateTime** | The date/time the alert was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | |
22
22
  | **end_date** | **DateTime** | The date/time the owning rule exiting in alarm status. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
23
23
  | **notification_users** | [**Array&lt;User&gt;**](User.html) | The ids of users who were notified of alarm state change. | |
data/doc_out/InteractionStatsRule.html.md CHANGED
@@ -16,8 +16,8 @@ title: InteractionStatsRule
16
16
  | **numeric_range** | **String** | The comparison descriptor used against the metric&#39;s value. | |
17
17
  | **statistic** | **String** | The statistic of concern for the metric. | |
18
18
  | **value** | **Float** | The threshold value. | |
19
- | **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | |
20
- | **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] |
19
+ | **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | [default to false]|
20
+ | **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] [default to false]|
21
21
  | **notification_users** | [**Array&lt;User&gt;**](User.html) | The ids of users who will be notified of alarm state change. | |
22
22
  | **alert_types** | **Array&lt;String&gt;** | A collection of notification methods. | |
23
23
  | **self_uri** | **String** | The URI for this object | [optional] |
data/doc_out/JsonNode.html.md CHANGED
@@ -7,27 +7,27 @@ title: JsonNode
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **array** | **BOOLEAN** | | [optional] |
11
- | **null** | **BOOLEAN** | | [optional] |
12
10
  | **node_type** | **String** | | [optional] |
13
- | **object** | **BOOLEAN** | | [optional] |
14
- | **boolean** | **BOOLEAN** | | [optional] |
15
- | **number** | **BOOLEAN** | | [optional] |
16
- | **float** | **BOOLEAN** | | [optional] |
17
- | **value_node** | **BOOLEAN** | | [optional] |
18
- | **container_node** | **BOOLEAN** | | [optional] |
19
- | **missing_node** | **BOOLEAN** | | [optional] |
20
- | **pojo** | **BOOLEAN** | | [optional] |
21
- | **integral_number** | **BOOLEAN** | | [optional] |
22
- | **floating_point_number** | **BOOLEAN** | | [optional] |
23
- | **short** | **BOOLEAN** | | [optional] |
24
- | **int** | **BOOLEAN** | | [optional] |
25
- | **long** | **BOOLEAN** | | [optional] |
26
- | **double** | **BOOLEAN** | | [optional] |
27
- | **big_decimal** | **BOOLEAN** | | [optional] |
28
- | **big_integer** | **BOOLEAN** | | [optional] |
29
- | **textual** | **BOOLEAN** | | [optional] |
30
- | **binary** | **BOOLEAN** | | [optional] |
11
+ | **object** | **BOOLEAN** | | [optional] [default to false]|
12
+ | **boolean** | **BOOLEAN** | | [optional] [default to false]|
13
+ | **number** | **BOOLEAN** | | [optional] [default to false]|
14
+ | **float** | **BOOLEAN** | | [optional] [default to false]|
15
+ | **value_node** | **BOOLEAN** | | [optional] [default to false]|
16
+ | **container_node** | **BOOLEAN** | | [optional] [default to false]|
17
+ | **missing_node** | **BOOLEAN** | | [optional] [default to false]|
18
+ | **pojo** | **BOOLEAN** | | [optional] [default to false]|
19
+ | **integral_number** | **BOOLEAN** | | [optional] [default to false]|
20
+ | **floating_point_number** | **BOOLEAN** | | [optional] [default to false]|
21
+ | **short** | **BOOLEAN** | | [optional] [default to false]|
22
+ | **int** | **BOOLEAN** | | [optional] [default to false]|
23
+ | **long** | **BOOLEAN** | | [optional] [default to false]|
24
+ | **double** | **BOOLEAN** | | [optional] [default to false]|
25
+ | **big_decimal** | **BOOLEAN** | | [optional] [default to false]|
26
+ | **big_integer** | **BOOLEAN** | | [optional] [default to false]|
27
+ | **textual** | **BOOLEAN** | | [optional] [default to false]|
28
+ | **binary** | **BOOLEAN** | | [optional] [default to false]|
29
+ | **array** | **BOOLEAN** | | [optional] [default to false]|
30
+ | **null** | **BOOLEAN** | | [optional] [default to false]|
31
31
  {: class="table table-striped"}
32
32
 
33
33
 
data/doc_out/LineStatus.html.md CHANGED
@@ -8,7 +8,7 @@ title: LineStatus
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The id of this line | [optional] |
11
- | **reachable** | **BOOLEAN** | Indicates whether the edge can reach the line. | [optional] |
11
+ | **reachable** | **BOOLEAN** | Indicates whether the edge can reach the line. | [optional] [default to false]|
12
12
  | **address_of_record** | **String** | The line&#39;s address of record. | [optional] |
13
13
  | **contact_addresses** | **Array&lt;String&gt;** | The addresses used to contact the line. | [optional] |
14
14
  | **reachable_state_time** | **DateTime** | The time the line entered its current reachable state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
data/doc_out/LocationDefinition.html.md CHANGED
@@ -10,7 +10,7 @@ title: LocationDefinition
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **address** | [**LocationAddress**](LocationAddress.html) | | [optional] |
13
- | **address_verified** | **BOOLEAN** | | [optional] |
13
+ | **address_verified** | **BOOLEAN** | | [optional] [default to false]|
14
14
  | **emergency_number** | [**LocationEmergencyNumber**](LocationEmergencyNumber.html) | | [optional] |
15
15
  | **state** | **String** | Current activity status of the location. | [optional] |
16
16
  | **version** | **Integer** | | [optional] |
data/doc_out/MediaParticipantRequest.html.md CHANGED
@@ -9,11 +9,11 @@ title: MediaParticipantRequest
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **wrapup** | [**Wrapup**](Wrapup.html) | Wrap-up to assign to this participant. | [optional] |
11
11
  | **state** | **String** | The state to update to set for this participant&#39;s communications. Possible values are: &#39;connected&#39; and &#39;disconnected&#39;. | [optional] |
12
- | **recording** | **BOOLEAN** | True to enable recording of this participant, otherwise false to disable recording. | [optional] |
13
- | **muted** | **BOOLEAN** | True to mute this conversation participant. | [optional] |
14
- | **confined** | **BOOLEAN** | True to confine this conversation participant. Should only be used for ad-hoc conferences | [optional] |
15
- | **held** | **BOOLEAN** | True to hold this conversation participant. | [optional] |
16
- | **wrapup_skipped** | **BOOLEAN** | True to skip wrap-up for this participant. | [optional] |
12
+ | **recording** | **BOOLEAN** | True to enable recording of this participant, otherwise false to disable recording. | [optional] [default to false]|
13
+ | **muted** | **BOOLEAN** | True to mute this conversation participant. | [optional] [default to false]|
14
+ | **confined** | **BOOLEAN** | True to confine this conversation participant. Should only be used for ad-hoc conferences | [optional] [default to false]|
15
+ | **held** | **BOOLEAN** | True to hold this conversation participant. | [optional] [default to false]|
16
+ | **wrapup_skipped** | **BOOLEAN** | True to skip wrap-up for this participant. | [optional] [default to false]|
17
17
  {: class="table table-striped"}
18
18
 
19
19
 
data/doc_out/MeteredEvaluationAssignment.html.md CHANGED
@@ -11,7 +11,7 @@ title: MeteredEvaluationAssignment
11
11
  | **evaluators** | [**Array&lt;User&gt;**](User.html) | | [optional] |
12
12
  | **max_number_evaluations** | **Integer** | | [optional] |
13
13
  | **evaluation_form** | [**EvaluationForm**](EvaluationForm.html) | | [optional] |
14
- | **assign_to_active_user** | **BOOLEAN** | | [optional] |
14
+ | **assign_to_active_user** | **BOOLEAN** | | [optional] [default to false]|
15
15
  | **time_interval** | [**TimeInterval**](TimeInterval.html) | | [optional] |
16
16
  {: class="table table-striped"}
17
17
 
data/doc_out/OAuthProvider.html.md CHANGED
@@ -9,7 +9,7 @@ title: OAuthProvider
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
- | **disabled** | **BOOLEAN** | | [optional] |
12
+ | **disabled** | **BOOLEAN** | | [optional] [default to false]|
13
13
  | **self_uri** | **String** | The URI for this object | [optional] |
14
14
  {: class="table table-striped"}
15
15
 
data/doc_out/Okta.html.md CHANGED
@@ -12,7 +12,7 @@ title: Okta
12
12
  | **certificate** | **String** | | [optional] |
13
13
  | **issuer_uri** | **String** | | [optional] |
14
14
  | **sso_target_uri** | **String** | | [optional] |
15
- | **disabled** | **BOOLEAN** | | [optional] |
15
+ | **disabled** | **BOOLEAN** | | [optional] [default to false]|
16
16
  | **self_uri** | **String** | The URI for this object | [optional] |
17
17
  {: class="table table-striped"}
18
18
 
data/doc_out/OneLogin.html.md CHANGED
@@ -12,7 +12,7 @@ title: OneLogin
12
12
  | **certificate** | **String** | | [optional] |
13
13
  | **issuer_uri** | **String** | | [optional] |
14
14
  | **sso_target_uri** | **String** | | [optional] |
15
- | **disabled** | **BOOLEAN** | | [optional] |
15
+ | **disabled** | **BOOLEAN** | | [optional] [default to false]|
16
16
  | **self_uri** | **String** | The URI for this object | [optional] |
17
17
  {: class="table table-striped"}
18
18
 
data/doc_out/OrgMediaUtilization.html.md CHANGED
@@ -9,7 +9,7 @@ title: OrgMediaUtilization
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **maximum_capacity** | **Integer** | Defines the maximum number of conversations of this type that an agent can handle at one time. | [optional] |
11
11
  | **interruptable_media_types** | **Array&lt;String&gt;** | Defines the list of other media types that can interrupt a conversation of this media type. Values can be: call, chat, email, or socialExpression | [optional] |
12
- | **include_non_acd** | **BOOLEAN** | If true, then track non-ACD conversations against utilization | [optional] |
12
+ | **include_non_acd** | **BOOLEAN** | If true, then track non-ACD conversations against utilization | [optional] [default to false]|
13
13
  {: class="table table-striped"}
14
14
 
15
15
 
data/doc_out/Organization.html.md CHANGED
@@ -16,7 +16,7 @@ title: Organization
16
16
  | **version** | **Integer** | The current version of the organization. | |
17
17
  | **state** | **String** | | [optional] |
18
18
  | **default_site_id** | **String** | | [optional] |
19
- | **deletable** | **BOOLEAN** | | [optional] |
19
+ | **deletable** | **BOOLEAN** | | [optional] [default to false]|
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
data/doc_out/OrganizationPresence.html.md CHANGED
@@ -11,8 +11,8 @@ title: OrganizationPresence
11
11
  | **name** | **String** | | [optional] |
12
12
  | **language_labels** | **Hash&lt;String, String&gt;** | The label used for the system presence in each specified language | |
13
13
  | **system_presence** | **String** | | [optional] |
14
- | **deactivated** | **BOOLEAN** | | [optional] |
15
- | **primary** | **BOOLEAN** | | [optional] |
14
+ | **deactivated** | **BOOLEAN** | | [optional] [default to false]|
15
+ | **primary** | **BOOLEAN** | | [optional] [default to false]|
16
16
  | **created_by** | [**User**](User.html) | | [optional] |
17
17
  | **created_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
18
18
  | **modified_by** | [**User**](User.html) | | [optional] |
data/doc_out/OutOfOffice.html.md CHANGED
@@ -12,7 +12,7 @@ title: OutOfOffice
12
12
  | **user** | [**User**](User.html) | | [optional] |
13
13
  | **start_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
14
  | **end_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
15
- | **active** | **BOOLEAN** | | [optional] |
15
+ | **active** | **BOOLEAN** | | [optional] [default to false]|
16
16
  | **self_uri** | **String** | The URI for this object | [optional] |
17
17
  {: class="table table-striped"}
18
18
 
data/doc_out/OutboundRoute.html.md CHANGED
@@ -20,9 +20,9 @@ title: OutboundRoute
20
20
  | **created_by_app** | **String** | | [optional] |
21
21
  | **site** | [**Site**](Site.html) | The site associated to the outbound route. | |
22
22
  | **classification_types** | **Array&lt;String&gt;** | | [optional] |
23
- | **enabled** | **BOOLEAN** | | [optional] |
23
+ | **enabled** | **BOOLEAN** | | [optional] [default to false]|
24
24
  | **distribution** | **String** | | [optional] |
25
- | **managed** | **BOOLEAN** | | [optional] |
25
+ | **managed** | **BOOLEAN** | | [optional] [default to false]|
26
26
  | **external_trunk_bases** | [**Array&lt;UriReference&gt;**](UriReference.html) | Trunk base settings of trunkType \&quot;EXTERNAL\&quot;. This base must also be set on an edge logical interface for correct routing. | [optional] |
27
27
  | **self_uri** | **String** | The URI for this object | [optional] |
28
28
  {: class="table table-striped"}
data/doc_out/Parameter.html.md CHANGED
@@ -10,7 +10,7 @@ title: Parameter
10
10
  | **name** | **String** | | [optional] |
11
11
  | **parameter_type** | **String** | | [optional] |
12
12
  | **domain** | **String** | | [optional] |
13
- | **required** | **BOOLEAN** | | [optional] |
13
+ | **required** | **BOOLEAN** | | [optional] [default to false]|
14
14
  {: class="table table-striped"}
15
15
 
16
16
 
data/doc_out/Participant.html.md CHANGED
@@ -27,10 +27,10 @@ title: Participant
27
27
  | **ani_name** | **String** | The ani-based name for this participant. | [optional] |
28
28
  | **dnis** | **String** | The address for the this participant. For a phone call this will be the ANI. | [optional] |
29
29
  | **locale** | **String** | An ISO 639 language code specifying the locale for this participant | [optional] |
30
- | **wrapup_required** | **BOOLEAN** | True iff this participant is required to enter wrapup for this conversation. | [optional] |
30
+ | **wrapup_required** | **BOOLEAN** | True iff this participant is required to enter wrapup for this conversation. | [optional] [default to false]|
31
31
  | **wrapup_prompt** | **String** | This field controls how the UI prompts the agent for a wrapup. | [optional] |
32
32
  | **wrapup_timeout_ms** | **Integer** | Specifies how long a timed ACW session will last. | [optional] |
33
- | **wrapup_skipped** | **BOOLEAN** | The UI sets this field when the agent chooses to skip entering a wrapup for this participant. | [optional] |
33
+ | **wrapup_skipped** | **BOOLEAN** | The UI sets this field when the agent chooses to skip entering a wrapup for this participant. | [optional] [default to false]|
34
34
  | **wrapup** | [**Wrapup**](Wrapup.html) | Call wrap up or disposition data. | [optional] |
35
35
  | **monitored_participant_id** | **String** | If this participant is a monitor, then this will be the id of the participant that is being monitored. | [optional] |
36
36
  | **attributes** | **Hash&lt;String, String&gt;** | Additional participant attributes | [optional] |
data/doc_out/PhoneCapabilities.html.md CHANGED
@@ -7,12 +7,12 @@ title: PhoneCapabilities
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **provisions** | **BOOLEAN** | | [optional] |
11
- | **registers** | **BOOLEAN** | | [optional] |
12
- | **dual_registers** | **BOOLEAN** | | [optional] |
10
+ | **provisions** | **BOOLEAN** | | [optional] [default to false]|
11
+ | **registers** | **BOOLEAN** | | [optional] [default to false]|
12
+ | **dual_registers** | **BOOLEAN** | | [optional] [default to false]|
13
13
  | **hardware_id_type** | **String** | | [optional] |
14
- | **allow_reboot** | **BOOLEAN** | | [optional] |
15
- | **no_rebalance** | **BOOLEAN** | | [optional] |
14
+ | **allow_reboot** | **BOOLEAN** | | [optional] [default to false]|
15
+ | **no_rebalance** | **BOOLEAN** | | [optional] [default to false]|
16
16
  {: class="table table-striped"}
17
17
 
18
18
 
data/doc_out/PhoneNumberStatus.html.md CHANGED
@@ -7,7 +7,7 @@ title: PhoneNumberStatus
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **callable** | **BOOLEAN** | false if the phone number is not callable | [optional] |
10
+ | **callable** | **BOOLEAN** | false if the phone number is not callable | [optional] [default to false]|
11
11
  {: class="table table-striped"}
12
12
 
13
13
 
data/doc_out/Policy.html.md CHANGED
@@ -13,7 +13,7 @@ title: Policy
13
13
  | **created_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
14
  | **order** | **Integer** | | [optional] |
15
15
  | **description** | **String** | | [optional] |
16
- | **enabled** | **BOOLEAN** | | [optional] |
16
+ | **enabled** | **BOOLEAN** | | [optional] [default to false]|
17
17
  | **media_policies** | [**MediaPolicies**](MediaPolicies.html) | Conditions and actions per media type | [optional] |
18
18
  | **conditions** | [**PolicyConditions**](PolicyConditions.html) | Conditions | [optional] |
19
19
  | **actions** | [**PolicyActions**](PolicyActions.html) | Actions | [optional] |
data/doc_out/PolicyActions.html.md CHANGED
@@ -7,9 +7,9 @@ title: PolicyActions
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **retain_recording** | **BOOLEAN** | true to retain the recording associated with the conversation. Default = true | [optional] |
11
- | **delete_recording** | **BOOLEAN** | true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false | [optional] |
12
- | **always_delete** | **BOOLEAN** | true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false | [optional] |
10
+ | **retain_recording** | **BOOLEAN** | true to retain the recording associated with the conversation. Default = true | [optional] [default to false]|
11
+ | **delete_recording** | **BOOLEAN** | true to delete the recording associated with the conversation. If retainRecording = true, this will be ignored. Default = false | [optional] [default to false]|
12
+ | **always_delete** | **BOOLEAN** | true to delete the recording associated with the conversation regardless of the values of retainRecording or deleteRecording. Default = false | [optional] [default to false]|
13
13
  | **assign_evaluations** | [**Array&lt;EvaluationAssignment&gt;**](EvaluationAssignment.html) | | [optional] |
14
14
  | **assign_metered_evaluations** | [**Array&lt;MeteredEvaluationAssignment&gt;**](MeteredEvaluationAssignment.html) | | [optional] |
15
15
  | **assign_calibrations** | [**Array&lt;CalibrationAssignment&gt;**](CalibrationAssignment.html) | | [optional] |
data/doc_out/PolicyCreate.html.md CHANGED
@@ -13,7 +13,7 @@ title: PolicyCreate
13
13
  | **created_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
14
  | **order** | **Integer** | | [optional] |
15
15
  | **description** | **String** | | [optional] |
16
- | **enabled** | **BOOLEAN** | | [optional] |
16
+ | **enabled** | **BOOLEAN** | | [optional] [default to false]|
17
17
  | **media_policies** | [**MediaPolicies**](MediaPolicies.html) | Conditions and actions per media type | [optional] |
18
18
  | **conditions** | [**PolicyConditions**](PolicyConditions.html) | Conditions | [optional] |
19
19
  | **actions** | [**PolicyActions**](PolicyActions.html) | Actions | [optional] |