purecloud 0.62.1 → 0.63.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (264) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +3 -3
  3. data/config-ruby.json +1 -1
  4. data/doc_out/ADFS.html.md +1 -1
  5. data/doc_out/AggregationQuery.html.md +1 -1
  6. data/doc_out/AnalyticsConversationSegment.html.md +3 -3
  7. data/doc_out/AnalyticsSession.html.md +2 -2
  8. data/doc_out/AttributesApi.html.md +29 -29
  9. data/doc_out/AuditMessage.html.md +1 -1
  10. data/doc_out/Call.html.md +4 -4
  11. data/doc_out/CallForwarding.html.md +1 -1
  12. data/doc_out/CallMediaParticipant.html.md +6 -6
  13. data/doc_out/Callback.html.md +2 -2
  14. data/doc_out/CallbackMediaParticipant.html.md +4 -4
  15. data/doc_out/Campaign.html.md +1 -1
  16. data/doc_out/CampaignInteraction.html.md +1 -1
  17. data/doc_out/CampaignRule.html.md +2 -2
  18. data/doc_out/CampaignRuleActionEntities.html.md +1 -1
  19. data/doc_out/CampaignSequence.html.md +1 -1
  20. data/doc_out/CertificateDetails.html.md +3 -3
  21. data/doc_out/ChatMediaParticipant.html.md +3 -3
  22. data/doc_out/CobrowseMediaParticipant.html.md +3 -3
  23. data/doc_out/Condition.html.md +1 -1
  24. data/doc_out/ContactSort.html.md +1 -1
  25. data/doc_out/ContentQueryRequest.html.md +1 -1
  26. data/doc_out/ContentSortItem.html.md +1 -1
  27. data/doc_out/ConversationChat.html.md +1 -1
  28. data/doc_out/ConversationsApi.html.md +58 -58
  29. data/doc_out/CustomerInteractionCenter.html.md +1 -1
  30. data/doc_out/DialerContact.html.md +1 -1
  31. data/doc_out/Document.html.md +1 -1
  32. data/doc_out/DocumentAudit.html.md +1 -1
  33. data/doc_out/DocumentUpdate.html.md +1 -1
  34. data/doc_out/DomainCapabilities.html.md +4 -4
  35. data/doc_out/DomainEdgeSoftwareUpdateDto.html.md +2 -2
  36. data/doc_out/DomainEdgeSoftwareVersionDto.html.md +2 -2
  37. data/doc_out/DomainLogicalInterface.html.md +3 -3
  38. data/doc_out/DomainNetworkAddress.html.md +1 -1
  39. data/doc_out/DomainNetworkCommandResponse.html.md +1 -1
  40. data/doc_out/DomainNetworkRoute.html.md +1 -1
  41. data/doc_out/DomainOrganizationRole.html.md +3 -3
  42. data/doc_out/DomainOrganizationRoleCreate.html.md +3 -3
  43. data/doc_out/DomainOrganizationRoleUpdate.html.md +3 -3
  44. data/doc_out/DomainPermission.html.md +1 -1
  45. data/doc_out/DomainPermissionPolicy.html.md +1 -1
  46. data/doc_out/DomainPhysicalCapabilities.html.md +2 -2
  47. data/doc_out/Edge.html.md +2 -2
  48. data/doc_out/EdgeAutoUpdateConfig.html.md +2 -2
  49. data/doc_out/EdgeGroup.html.md +1 -1
  50. data/doc_out/EdgeLogsJobRequest.html.md +1 -1
  51. data/doc_out/Email.html.md +1 -1
  52. data/doc_out/EmailMediaParticipant.html.md +3 -3
  53. data/doc_out/Endpoint.html.md +1 -1
  54. data/doc_out/Evaluation.html.md +4 -4
  55. data/doc_out/EvaluationForm.html.md +1 -1
  56. data/doc_out/EvaluationScoringSet.html.md +1 -1
  57. data/doc_out/FaxDocument.html.md +1 -1
  58. data/doc_out/FieldList.html.md +3 -3
  59. data/doc_out/Geolocation.html.md +1 -1
  60. data/doc_out/GeolocationSettings.html.md +1 -1
  61. data/doc_out/GreetingsApi.html.md +50 -50
  62. data/doc_out/Group.html.md +1 -1
  63. data/doc_out/GroupUpdate.html.md +1 -1
  64. data/doc_out/GroupsApi.html.md +68 -68
  65. data/doc_out/HeartBeatRule.html.md +2 -2
  66. data/doc_out/IdentityProviderApi.html.md +22 -22
  67. data/doc_out/InboundDomain.html.md +1 -1
  68. data/doc_out/InitiateScreenRecording.html.md +1 -1
  69. data/doc_out/InteractionStatsAlert.html.md +1 -1
  70. data/doc_out/InteractionStatsRule.html.md +2 -2
  71. data/doc_out/JsonNode.html.md +20 -20
  72. data/doc_out/LineStatus.html.md +1 -1
  73. data/doc_out/LocationDefinition.html.md +1 -1
  74. data/doc_out/MediaParticipantRequest.html.md +5 -5
  75. data/doc_out/MeteredEvaluationAssignment.html.md +1 -1
  76. data/doc_out/OAuthProvider.html.md +1 -1
  77. data/doc_out/Okta.html.md +1 -1
  78. data/doc_out/OneLogin.html.md +1 -1
  79. data/doc_out/OrgMediaUtilization.html.md +1 -1
  80. data/doc_out/Organization.html.md +1 -1
  81. data/doc_out/OrganizationPresence.html.md +2 -2
  82. data/doc_out/OutOfOffice.html.md +1 -1
  83. data/doc_out/OutboundRoute.html.md +2 -2
  84. data/doc_out/Parameter.html.md +1 -1
  85. data/doc_out/Participant.html.md +2 -2
  86. data/doc_out/PhoneCapabilities.html.md +5 -5
  87. data/doc_out/PhoneNumberStatus.html.md +1 -1
  88. data/doc_out/Policy.html.md +1 -1
  89. data/doc_out/PolicyActions.html.md +3 -3
  90. data/doc_out/PolicyCreate.html.md +1 -1
  91. data/doc_out/PresenceApi.html.md +33 -33
  92. data/doc_out/PureCloud.html.md +1 -1
  93. data/doc_out/QualityAudit.html.md +1 -1
  94. data/doc_out/QueryRequest.html.md +1 -1
  95. data/doc_out/QuestionGroup.html.md +4 -4
  96. data/doc_out/QuestionGroupScore.html.md +1 -1
  97. data/doc_out/QuestionScore.html.md +2 -2
  98. data/doc_out/QueueMember.html.md +1 -1
  99. data/doc_out/RecordingApi.html.md +70 -70
  100. data/doc_out/ReportSchedule.html.md +1 -1
  101. data/doc_out/ResourcePermissionPolicy.html.md +1 -1
  102. data/doc_out/RoutingStatusRule.html.md +2 -2
  103. data/doc_out/Salesforce.html.md +1 -1
  104. data/doc_out/Screenshare.html.md +1 -1
  105. data/doc_out/ScriptsApi.html.md +72 -72
  106. data/doc_out/Site.html.md +1 -1
  107. data/doc_out/SocialExpression.html.md +1 -1
  108. data/doc_out/SortItem.html.md +1 -1
  109. data/doc_out/TagValue.html.md +1 -1
  110. data/doc_out/TimeAllowed.html.md +1 -1
  111. data/doc_out/TimeOffRequest.html.md +2 -2
  112. data/doc_out/TimeOffRequestPatch.html.md +1 -1
  113. data/doc_out/TransferRequest.html.md +1 -1
  114. data/doc_out/Trunk.html.md +1 -1
  115. data/doc_out/TrunkBase.html.md +1 -1
  116. data/doc_out/UnreadStatus.html.md +1 -1
  117. data/doc_out/UserPresence.html.md +1 -1
  118. data/doc_out/UserPresenceRule.html.md +2 -2
  119. data/doc_out/UserQueue.html.md +1 -1
  120. data/doc_out/UserRecording.html.md +1 -1
  121. data/doc_out/UserRecordingsApi.html.md +47 -47
  122. data/doc_out/UserScheduleAdherence.html.md +1 -1
  123. data/doc_out/ValidateAddressResponse.html.md +1 -1
  124. data/doc_out/Video.html.md +3 -3
  125. data/doc_out/VoicemailGroupPolicy.html.md +2 -2
  126. data/doc_out/VoicemailMessage.html.md +2 -2
  127. data/doc_out/VoicemailOrganizationPolicy.html.md +4 -4
  128. data/doc_out/VoicemailUserPolicy.html.md +1 -1
  129. data/doc_out/Workspace.html.md +1 -1
  130. data/doc_out/Wrapup.html.md +1 -1
  131. data/doc_out/index.html.md +3 -3
  132. data/lib/purecloud/api/attributes_api.rb +39 -39
  133. data/lib/purecloud/api/conversations_api.rb +58 -58
  134. data/lib/purecloud/api/greetings_api.rb +67 -67
  135. data/lib/purecloud/api/groups_api.rb +104 -104
  136. data/lib/purecloud/api/identity_provider_api.rb +33 -33
  137. data/lib/purecloud/api/presence_api.rb +46 -46
  138. data/lib/purecloud/api/recording_api.rb +76 -76
  139. data/lib/purecloud/api/scripts_api.rb +87 -87
  140. data/lib/purecloud/api/user_recordings_api.rb +64 -64
  141. data/lib/purecloud/api_client.rb +1 -1
  142. data/lib/purecloud/models/adfs.rb +0 -2
  143. data/lib/purecloud/models/aggregation_query.rb +0 -2
  144. data/lib/purecloud/models/analytics_conversation_segment.rb +0 -6
  145. data/lib/purecloud/models/analytics_session.rb +0 -4
  146. data/lib/purecloud/models/audit_message.rb +0 -2
  147. data/lib/purecloud/models/call.rb +0 -8
  148. data/lib/purecloud/models/call_forwarding.rb +0 -2
  149. data/lib/purecloud/models/call_media_participant.rb +0 -12
  150. data/lib/purecloud/models/callback.rb +0 -4
  151. data/lib/purecloud/models/callback_media_participant.rb +0 -8
  152. data/lib/purecloud/models/campaign.rb +0 -2
  153. data/lib/purecloud/models/campaign_interaction.rb +0 -2
  154. data/lib/purecloud/models/campaign_rule.rb +0 -4
  155. data/lib/purecloud/models/campaign_rule_action_entities.rb +0 -2
  156. data/lib/purecloud/models/campaign_sequence.rb +0 -2
  157. data/lib/purecloud/models/certificate_details.rb +0 -6
  158. data/lib/purecloud/models/chat_media_participant.rb +0 -6
  159. data/lib/purecloud/models/cobrowse_media_participant.rb +0 -6
  160. data/lib/purecloud/models/condition.rb +0 -2
  161. data/lib/purecloud/models/contact_sort.rb +0 -2
  162. data/lib/purecloud/models/content_query_request.rb +0 -2
  163. data/lib/purecloud/models/content_sort_item.rb +0 -2
  164. data/lib/purecloud/models/conversation_chat.rb +0 -2
  165. data/lib/purecloud/models/customer_interaction_center.rb +0 -2
  166. data/lib/purecloud/models/dialer_contact.rb +0 -2
  167. data/lib/purecloud/models/document.rb +0 -2
  168. data/lib/purecloud/models/document_audit.rb +0 -2
  169. data/lib/purecloud/models/document_update.rb +0 -2
  170. data/lib/purecloud/models/domain_capabilities.rb +0 -8
  171. data/lib/purecloud/models/domain_edge_software_update_dto.rb +0 -4
  172. data/lib/purecloud/models/domain_edge_software_version_dto.rb +0 -4
  173. data/lib/purecloud/models/domain_logical_interface.rb +0 -6
  174. data/lib/purecloud/models/domain_network_address.rb +0 -2
  175. data/lib/purecloud/models/domain_network_command_response.rb +0 -2
  176. data/lib/purecloud/models/domain_network_route.rb +0 -2
  177. data/lib/purecloud/models/domain_organization_role.rb +11 -17
  178. data/lib/purecloud/models/domain_organization_role_create.rb +11 -17
  179. data/lib/purecloud/models/domain_organization_role_update.rb +11 -17
  180. data/lib/purecloud/models/domain_permission.rb +0 -2
  181. data/lib/purecloud/models/domain_permission_policy.rb +0 -2
  182. data/lib/purecloud/models/domain_physical_capabilities.rb +0 -4
  183. data/lib/purecloud/models/edge.rb +0 -4
  184. data/lib/purecloud/models/edge_auto_update_config.rb +4 -4
  185. data/lib/purecloud/models/edge_group.rb +0 -2
  186. data/lib/purecloud/models/edge_logs_job_request.rb +0 -2
  187. data/lib/purecloud/models/email.rb +0 -2
  188. data/lib/purecloud/models/email_media_participant.rb +0 -6
  189. data/lib/purecloud/models/endpoint.rb +0 -2
  190. data/lib/purecloud/models/evaluation.rb +0 -8
  191. data/lib/purecloud/models/evaluation_form.rb +0 -2
  192. data/lib/purecloud/models/evaluation_scoring_set.rb +0 -2
  193. data/lib/purecloud/models/fax_document.rb +0 -2
  194. data/lib/purecloud/models/field_list.rb +0 -6
  195. data/lib/purecloud/models/geolocation.rb +0 -2
  196. data/lib/purecloud/models/geolocation_settings.rb +0 -2
  197. data/lib/purecloud/models/group.rb +0 -2
  198. data/lib/purecloud/models/group_update.rb +0 -2
  199. data/lib/purecloud/models/heart_beat_rule.rb +0 -4
  200. data/lib/purecloud/models/inbound_domain.rb +0 -2
  201. data/lib/purecloud/models/initiate_screen_recording.rb +0 -2
  202. data/lib/purecloud/models/interaction_stats_alert.rb +0 -2
  203. data/lib/purecloud/models/interaction_stats_rule.rb +0 -4
  204. data/lib/purecloud/models/json_node.rb +24 -64
  205. data/lib/purecloud/models/line_status.rb +0 -2
  206. data/lib/purecloud/models/location_definition.rb +0 -2
  207. data/lib/purecloud/models/media_participant_request.rb +0 -10
  208. data/lib/purecloud/models/metered_evaluation_assignment.rb +0 -2
  209. data/lib/purecloud/models/o_auth_provider.rb +0 -2
  210. data/lib/purecloud/models/okta.rb +0 -2
  211. data/lib/purecloud/models/one_login.rb +0 -2
  212. data/lib/purecloud/models/org_media_utilization.rb +0 -2
  213. data/lib/purecloud/models/organization.rb +0 -2
  214. data/lib/purecloud/models/organization_presence.rb +0 -4
  215. data/lib/purecloud/models/out_of_office.rb +0 -2
  216. data/lib/purecloud/models/outbound_route.rb +0 -4
  217. data/lib/purecloud/models/parameter.rb +0 -2
  218. data/lib/purecloud/models/participant.rb +0 -4
  219. data/lib/purecloud/models/phone_capabilities.rb +0 -10
  220. data/lib/purecloud/models/phone_number_status.rb +0 -2
  221. data/lib/purecloud/models/policy.rb +0 -2
  222. data/lib/purecloud/models/policy_actions.rb +0 -6
  223. data/lib/purecloud/models/policy_create.rb +0 -2
  224. data/lib/purecloud/models/pure_cloud.rb +0 -2
  225. data/lib/purecloud/models/quality_audit.rb +11 -11
  226. data/lib/purecloud/models/query_request.rb +0 -2
  227. data/lib/purecloud/models/question_group.rb +0 -8
  228. data/lib/purecloud/models/question_group_score.rb +0 -2
  229. data/lib/purecloud/models/question_score.rb +0 -4
  230. data/lib/purecloud/models/queue_member.rb +0 -2
  231. data/lib/purecloud/models/report_schedule.rb +0 -2
  232. data/lib/purecloud/models/resource_permission_policy.rb +0 -2
  233. data/lib/purecloud/models/routing_status_rule.rb +0 -4
  234. data/lib/purecloud/models/salesforce.rb +0 -2
  235. data/lib/purecloud/models/screenshare.rb +0 -2
  236. data/lib/purecloud/models/site.rb +0 -2
  237. data/lib/purecloud/models/social_expression.rb +0 -2
  238. data/lib/purecloud/models/sort_item.rb +0 -2
  239. data/lib/purecloud/models/tag_value.rb +0 -2
  240. data/lib/purecloud/models/time_allowed.rb +0 -2
  241. data/lib/purecloud/models/time_off_request.rb +0 -4
  242. data/lib/purecloud/models/time_off_request_patch.rb +0 -2
  243. data/lib/purecloud/models/transfer_request.rb +0 -2
  244. data/lib/purecloud/models/trunk.rb +0 -2
  245. data/lib/purecloud/models/trunk_base.rb +0 -2
  246. data/lib/purecloud/models/unread_status.rb +0 -2
  247. data/lib/purecloud/models/user_presence.rb +0 -2
  248. data/lib/purecloud/models/user_presence_rule.rb +0 -4
  249. data/lib/purecloud/models/user_queue.rb +0 -2
  250. data/lib/purecloud/models/user_recording.rb +0 -2
  251. data/lib/purecloud/models/user_schedule_adherence.rb +0 -2
  252. data/lib/purecloud/models/validate_address_response.rb +0 -2
  253. data/lib/purecloud/models/video.rb +0 -6
  254. data/lib/purecloud/models/voicemail_group_policy.rb +0 -4
  255. data/lib/purecloud/models/voicemail_message.rb +0 -4
  256. data/lib/purecloud/models/voicemail_organization_policy.rb +0 -8
  257. data/lib/purecloud/models/voicemail_user_policy.rb +0 -2
  258. data/lib/purecloud/models/workspace.rb +0 -2
  259. data/lib/purecloud/models/wrapup.rb +0 -2
  260. data/lib/purecloud/version.rb +1 -1
  261. data/newVersion.md +1 -1
  262. data/swagger.json +1 -1
  263. data/version.json +1 -1
  264. metadata +2 -2
@@ -10,7 +10,7 @@ title: Screenshare
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
- | **sharing** | **BOOLEAN** | Indicates whether this participant is sharing their screen. | [optional] [default to false]|
13
+ | **sharing** | **BOOLEAN** | Indicates whether this participant is sharing their screen. | [optional] |
14
14
  | **peer_count** | **Integer** | The number of peer participants from the perspective of the participant in the conference. | [optional] |
15
15
  | **disconnect_type** | **String** | System defined string indicating what caused the communication to disconnect. Will be null until the communication disconnects. | [optional] |
16
16
  | **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] |
@@ -8,6 +8,7 @@ All URIs are relative to *https://api.mypurecloud.com*
8
8
 
9
9
  Method | HTTP request | Description
10
10
  ------------- | ------------- | -------------
11
+ |[**get**](ScriptsApi.html#get) | **GET** /api/v2/scripts | Get the list of scripts|
11
12
  |[**get_published**](ScriptsApi.html#get_published) | **GET** /api/v2/scripts/published | Get the published scripts.|
12
13
  |[**get_published_script_id**](ScriptsApi.html#get_published_script_id) | **GET** /api/v2/scripts/published/{scriptId} | Get the published script.|
13
14
  |[**get_published_script_id_pages**](ScriptsApi.html#get_published_script_id_pages) | **GET** /api/v2/scripts/published/{scriptId}/pages | Get the list of published pages|
@@ -16,9 +17,79 @@ Method | HTTP request | Description
16
17
  |[**get_script_id**](ScriptsApi.html#get_script_id) | **GET** /api/v2/scripts/{scriptId} | Get a script|
17
18
  |[**get_script_id_pages**](ScriptsApi.html#get_script_id_pages) | **GET** /api/v2/scripts/{scriptId}/pages | Get the list of pages|
18
19
  |[**get_script_id_pages_page_id**](ScriptsApi.html#get_script_id_pages_page_id) | **GET** /api/v2/scripts/{scriptId}/pages/{pageId} | Get a page|
19
- |[**get_scripts**](ScriptsApi.html#get_scripts) | **GET** /api/v2/scripts | Get the list of scripts|
20
20
  {: class="table table-striped"}
21
21
 
22
+ <a name="get"></a>
23
+
24
+ ## -[**ScriptEntityListing**](ScriptEntityListing.html) get(opts)
25
+
26
+ Get the list of scripts
27
+
28
+
29
+
30
+ ### Example
31
+ ~~~ruby
32
+ # load the gem
33
+ require 'purecloud'
34
+ # setup authorization
35
+ @secret = ENV['PURECLOUD_SECRET']
36
+ @id = ENV['PURECLOUD_CLIENT_ID']
37
+ environment = "mypurecloud.com"
38
+
39
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
40
+
41
+ PureCloud.configure do |config|
42
+ config.access_token = @authToken
43
+ end
44
+
45
+ api_instance = PureCloud::ScriptsApi.new
46
+
47
+ opts = {
48
+ page_size: 25, # Integer | Page size
49
+ page_number: 1, # Integer | Page number
50
+ expand: "expand_example", # String | Expand
51
+ name: "name_example", # String | Name filter
52
+ feature: "feature_example", # String | Feature filter
53
+ flow_id: "flow_id_example", # String | Secure flow id filter
54
+ sort_by: "sort_by_example", # String | SortBy
55
+ sort_order: "sort_order_example" # String | SortOrder
56
+ }
57
+
58
+ begin
59
+ #Get the list of scripts
60
+ result = api_instance.get(opts)
61
+ p result
62
+ rescue PureCloud::ApiError => e
63
+ puts "Exception when calling ScriptsApi->get: #{e}"
64
+ end
65
+ ~~~
66
+
67
+ ### Parameters
68
+
69
+ Name | Type | Description | Notes
70
+ ------------- | ------------- | ------------- | -------------
71
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
72
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
73
+ **expand** | **String**| Expand | [optional]
74
+ **name** | **String**| Name filter | [optional]
75
+ **feature** | **String**| Feature filter | [optional]
76
+ **flow_id** | **String**| Secure flow id filter | [optional]
77
+ **sort_by** | **String**| SortBy | [optional]
78
+ **sort_order** | **String**| SortOrder | [optional]
79
+ {: class="table table-striped"}
80
+
81
+
82
+ ### Return type
83
+
84
+ [**ScriptEntityListing**](ScriptEntityListing.html)
85
+
86
+ ### HTTP request headers
87
+
88
+ - **Content-Type**: application/json
89
+ - **Accept**: application/json
90
+
91
+
92
+
22
93
  <a name="get_published"></a>
23
94
 
24
95
  ## -[**ScriptEntityListing**](ScriptEntityListing.html) get_published(opts)
@@ -484,74 +555,3 @@ Name | Type | Description | Notes
484
555
 
485
556
 
486
557
 
487
- <a name="get_scripts"></a>
488
-
489
- ## -[**ScriptEntityListing**](ScriptEntityListing.html) get_scripts(opts)
490
-
491
- Get the list of scripts
492
-
493
-
494
-
495
- ### Example
496
- ~~~ruby
497
- # load the gem
498
- require 'purecloud'
499
- # setup authorization
500
- @secret = ENV['PURECLOUD_SECRET']
501
- @id = ENV['PURECLOUD_CLIENT_ID']
502
- environment = "mypurecloud.com"
503
-
504
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
505
-
506
- PureCloud.configure do |config|
507
- config.access_token = @authToken
508
- end
509
-
510
- api_instance = PureCloud::ScriptsApi.new
511
-
512
- opts = {
513
- page_size: 25, # Integer | Page size
514
- page_number: 1, # Integer | Page number
515
- expand: "expand_example", # String | Expand
516
- name: "name_example", # String | Name filter
517
- feature: "feature_example", # String | Feature filter
518
- flow_id: "flow_id_example", # String | Secure flow id filter
519
- sort_by: "sort_by_example", # String | SortBy
520
- sort_order: "sort_order_example" # String | SortOrder
521
- }
522
-
523
- begin
524
- #Get the list of scripts
525
- result = api_instance.get_scripts(opts)
526
- p result
527
- rescue PureCloud::ApiError => e
528
- puts "Exception when calling ScriptsApi->get_scripts: #{e}"
529
- end
530
- ~~~
531
-
532
- ### Parameters
533
-
534
- Name | Type | Description | Notes
535
- ------------- | ------------- | ------------- | -------------
536
- **page_size** | **Integer**| Page size | [optional] [default to 25]
537
- **page_number** | **Integer**| Page number | [optional] [default to 1]
538
- **expand** | **String**| Expand | [optional]
539
- **name** | **String**| Name filter | [optional]
540
- **feature** | **String**| Feature filter | [optional]
541
- **flow_id** | **String**| Secure flow id filter | [optional]
542
- **sort_by** | **String**| SortBy | [optional]
543
- **sort_order** | **String**| SortOrder | [optional]
544
- {: class="table table-striped"}
545
-
546
-
547
- ### Return type
548
-
549
- [**ScriptEntityListing**](ScriptEntityListing.html)
550
-
551
- ### HTTP request headers
552
-
553
- - **Content-Type**: application/json
554
- - **Accept**: application/json
555
-
556
-
557
-
data/doc_out/Site.html.md CHANGED
@@ -26,7 +26,7 @@ title: Site
26
26
  | **edges** | [**Array&lt;Edge&gt;**](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] [default to false]|
29
+ | **managed** | **BOOLEAN** | | [optional] |
30
30
  | **self_uri** | **String** | The URI for this object | [optional] |
31
31
  {: class="table table-striped"}
32
32
 
@@ -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&lt;Segment&gt;**](Segment.html) | The time line of the participant&#39;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] [default to false]|
18
+ | **held** | **BOOLEAN** | True if this call is held and the person on this side hears silence. | [optional] |
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] |
@@ -8,7 +8,7 @@ title: SortItem
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **name** | **String** | | [optional] |
11
- | **ascending** | **BOOLEAN** | | [optional] [default to false]|
11
+ | **ascending** | **BOOLEAN** | | [optional] |
12
12
  {: class="table table-striped"}
13
13
 
14
14
 
@@ -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] [default to false]|
12
+ | **in_use** | **BOOLEAN** | | [optional] |
13
13
  | **acl** | **Array&lt;String&gt;** | | [optional] |
14
14
  | **self_uri** | **String** | The URI for this object | [optional] |
15
15
  {: class="table table-striped"}
@@ -9,7 +9,7 @@ title: TimeAllowed
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **time_slots** | [**Array&lt;TimeSlot&gt;**](TimeSlot.html) | | [optional] |
11
11
  | **time_zone_id** | **String** | | [optional] |
12
- | **empty** | **BOOLEAN** | | [optional] [default to false]|
12
+ | **empty** | **BOOLEAN** | | [optional] |
13
13
  {: class="table table-striped"}
14
14
 
15
15
 
@@ -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) | [default to false]|
14
- | **marked_as_read** | **BOOLEAN** | Whether this request has been marked as read by the agent | [default to false]|
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 | |
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&lt;DateTime&gt;** | The start date-times for partial day requests. Required if isFullDayRequest == false | [optional] |
@@ -7,7 +7,7 @@ title: TimeOffRequestPatch
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
- | **marked_as_read** | **BOOLEAN** | | [optional] [default to false]|
10
+ | **marked_as_read** | **BOOLEAN** | | [optional] |
11
11
  {: class="table table-striped"}
12
12
 
13
13
 
@@ -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&#39;s voicemail. | [optional] [default to false]|
14
+ | **voicemail** | **BOOLEAN** | If true, then transfer to the user&#39;s voicemail. | [optional] |
15
15
  {: class="table table-striped"}
16
16
 
17
17
 
@@ -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] [default to false]|
26
+ | **enabled** | **BOOLEAN** | True if this trunk is in-service. This comes from the trunk_enabled property of the referenced trunk base. | [optional] |
27
27
  | **self_uri** | **String** | The URI for this object | [optional] |
28
28
  {: class="table table-striped"}
29
29
 
@@ -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&lt;String, Object&gt;** | | [optional] |
23
23
  | **trunk_type** | **String** | The type of this trunk base. | |
24
- | **managed** | **BOOLEAN** | Is this trunk being managed remotely. | [optional] [default to false]|
24
+ | **managed** | **BOOLEAN** | Is this trunk being managed remotely. | [optional] |
25
25
  | **self_uri** | **String** | The URI for this object | [optional] |
26
26
  {: class="table table-striped"}
27
27
 
@@ -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] [default to false]|
10
+ | **unread** | **BOOLEAN** | Sets if the alert is read or unread. | [optional] |
11
11
  {: class="table table-striped"}
12
12
 
13
13
 
@@ -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] [default to false]|
13
+ | **primary** | **BOOLEAN** | A boolean used to tell whether or not to set this presence source as the primary on a PATCH | [optional] |
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] |
@@ -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&#39;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&#39;s presence. | |
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]|
16
+ | **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | |
17
+ | **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] |
18
18
  | **notification_users** | [**Array&lt;User&gt;**](User.html) | The ids of users who will be notified of alarm state change. | |
19
19
  | **alert_types** | **Array&lt;String&gt;** | A collection of notification methods. | |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
@@ -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] [default to false]|
29
+ | **joined** | **BOOLEAN** | | [optional] |
30
30
  | **member_count** | **Integer** | | [optional] |
31
31
  | **self_uri** | **String** | The URI for this object | [optional] |
32
32
  {: class="table table-striped"}
@@ -18,7 +18,7 @@ title: UserRecording
18
18
  | **content_length** | **Integer** | | [optional] |
19
19
  | **duration_milliseconds** | **Integer** | | [optional] |
20
20
  | **thumbnails** | [**Array&lt;DocumentThumbnail&gt;**](DocumentThumbnail.html) | | [optional] |
21
- | **read** | **BOOLEAN** | | [optional] [default to false]|
21
+ | **read** | **BOOLEAN** | | [optional] |
22
22
  | **self_uri** | **String** | The URI for this object | [optional] |
23
23
  {: class="table table-striped"}
24
24
 
@@ -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.|
12
13
  |[**get_recording_id**](UserRecordingsApi.html#get_recording_id) | **GET** /api/v2/userrecordings/{recordingId} | Get a user recording.|
13
14
  |[**get_recording_id_media**](UserRecordingsApi.html#get_recording_id_media) | **GET** /api/v2/userrecordings/{recordingId}/media | Download a user recording.|
14
15
  |[**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_recording_id"></a>
74
+ <a name="get"></a>
75
75
 
76
- ## -[**UserRecording**](UserRecording.html) get_recording_id(recording_id, opts)
76
+ ## -[**UserRecordingEntityListing**](UserRecordingEntityListing.html) get(opts)
77
77
 
78
- Get a user recording.
78
+ Get a list of user recordings.
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
-
101
99
  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 user recording.
107
- result = api_instance.get_recording_id(recording_id, opts)
106
+ #Get a list of user recordings.
107
+ result = api_instance.get(opts)
108
108
  p result
109
109
  rescue PureCloud::ApiError => e
110
- puts "Exception when calling UserRecordingsApi->get_recording_id: #{e}"
110
+ puts "Exception when calling UserRecordingsApi->get: #{e}"
111
111
  end
112
112
  ~~~
113
113
 
@@ -115,14 +115,15 @@ end
115
115
 
116
116
  Name | Type | Description | Notes
117
117
  ------------- | ------------- | ------------- | -------------
118
- **recording_id** | **String**| User Recording ID |
118
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
119
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
119
120
  **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional]
120
121
  {: class="table table-striped"}
121
122
 
122
123
 
123
124
  ### Return type
124
125
 
125
- [**UserRecording**](UserRecording.html)
126
+ [**UserRecordingEntityListing**](UserRecordingEntityListing.html)
126
127
 
127
128
  ### HTTP request headers
128
129
 
@@ -131,11 +132,11 @@ Name | Type | Description | Notes
131
132
 
132
133
 
133
134
 
134
- <a name="get_recording_id_media"></a>
135
+ <a name="get_recording_id"></a>
135
136
 
136
- ## -[**DownloadResponse**](DownloadResponse.html) get_recording_id_media(recording_id, opts)
137
+ ## -[**UserRecording**](UserRecording.html) get_recording_id(recording_id, opts)
137
138
 
138
- Download a user recording.
139
+ Get a user recording.
139
140
 
140
141
 
141
142
 
@@ -159,15 +160,15 @@ api_instance = PureCloud::UserRecordingsApi.new
159
160
  recording_id = "recording_id_example" # String | User Recording ID
160
161
 
161
162
  opts = {
162
- format_id: "WEBM" # String | The desired media format.
163
+ expand: ["expand_example"] # Array<String> | Which fields, if any, to expand.
163
164
  }
164
165
 
165
166
  begin
166
- #Download a user recording.
167
- result = api_instance.get_recording_id_media(recording_id, opts)
167
+ #Get a user recording.
168
+ result = api_instance.get_recording_id(recording_id, opts)
168
169
  p result
169
170
  rescue PureCloud::ApiError => e
170
- puts "Exception when calling UserRecordingsApi->get_recording_id_media: #{e}"
171
+ puts "Exception when calling UserRecordingsApi->get_recording_id: #{e}"
171
172
  end
172
173
  ~~~
173
174
 
@@ -176,13 +177,13 @@ end
176
177
  Name | Type | Description | Notes
177
178
  ------------- | ------------- | ------------- | -------------
178
179
  **recording_id** | **String**| User Recording ID |
179
- **format_id** | **String**| The desired media format. | [optional] [default to WEBM]
180
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand. | [optional]
180
181
  {: class="table table-striped"}
181
182
 
182
183
 
183
184
  ### Return type
184
185
 
185
- [**DownloadResponse**](DownloadResponse.html)
186
+ [**UserRecording**](UserRecording.html)
186
187
 
187
188
  ### HTTP request headers
188
189
 
@@ -191,11 +192,11 @@ Name | Type | Description | Notes
191
192
 
192
193
 
193
194
 
194
- <a name="get_summary"></a>
195
+ <a name="get_recording_id_media"></a>
195
196
 
196
- ## -[**FaxSummary**](FaxSummary.html) get_summary
197
+ ## -[**DownloadResponse**](DownloadResponse.html) get_recording_id_media(recording_id, opts)
197
198
 
198
- Get user recording summary
199
+ Download a user recording.
199
200
 
200
201
 
201
202
 
@@ -216,23 +217,33 @@ end
216
217
 
217
218
  api_instance = PureCloud::UserRecordingsApi.new
218
219
 
220
+ recording_id = "recording_id_example" # String | User Recording ID
221
+
222
+ opts = {
223
+ format_id: "WEBM" # String | The desired media format.
224
+ }
225
+
219
226
  begin
220
- #Get user recording summary
221
- result = api_instance.get_summary
227
+ #Download a user recording.
228
+ result = api_instance.get_recording_id_media(recording_id, opts)
222
229
  p result
223
230
  rescue PureCloud::ApiError => e
224
- puts "Exception when calling UserRecordingsApi->get_summary: #{e}"
231
+ puts "Exception when calling UserRecordingsApi->get_recording_id_media: #{e}"
225
232
  end
226
233
  ~~~
227
234
 
228
235
  ### Parameters
229
- This endpoint does not need any parameter.
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]
230
241
  {: class="table table-striped"}
231
242
 
232
243
 
233
244
  ### Return type
234
245
 
235
- [**FaxSummary**](FaxSummary.html)
246
+ [**DownloadResponse**](DownloadResponse.html)
236
247
 
237
248
  ### HTTP request headers
238
249
 
@@ -241,11 +252,11 @@ This endpoint does not need any parameter.
241
252
 
242
253
 
243
254
 
244
- <a name="get_userrecordings"></a>
255
+ <a name="get_summary"></a>
245
256
 
246
- ## -[**UserRecordingEntityListing**](UserRecordingEntityListing.html) get_userrecordings(opts)
257
+ ## -[**FaxSummary**](FaxSummary.html) get_summary
247
258
 
248
- Get a list of user recordings.
259
+ Get user recording summary
249
260
 
250
261
 
251
262
 
@@ -266,34 +277,23 @@ end
266
277
 
267
278
  api_instance = PureCloud::UserRecordingsApi.new
268
279
 
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
-
275
280
  begin
276
- #Get a list of user recordings.
277
- result = api_instance.get_userrecordings(opts)
281
+ #Get user recording summary
282
+ result = api_instance.get_summary
278
283
  p result
279
284
  rescue PureCloud::ApiError => e
280
- puts "Exception when calling UserRecordingsApi->get_userrecordings: #{e}"
285
+ puts "Exception when calling UserRecordingsApi->get_summary: #{e}"
281
286
  end
282
287
  ~~~
283
288
 
284
289
  ### Parameters
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]
290
+ This endpoint does not need any parameter.
291
291
  {: class="table table-striped"}
292
292
 
293
293
 
294
294
  ### Return type
295
295
 
296
- [**UserRecordingEntityListing**](UserRecordingEntityListing.html)
296
+ [**FaxSummary**](FaxSummary.html)
297
297
 
298
298
  ### HTTP request headers
299
299