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
data/doc_out/PresenceApi.html.md CHANGED
@@ -9,12 +9,12 @@ All URIs are relative to *https://api.mypurecloud.com*
9
9
  Method | HTTP request | Description
10
10
  ------------- | ------------- | -------------
11
11
  |[**delete_presence_id**](PresenceApi.html#delete_presence_id) | **DELETE** /api/v2/presencedefinitions/{presenceId} | Delete a Presence Definition|
12
+ |[**get**](PresenceApi.html#get) | **GET** /api/v2/presencedefinitions | Get an Organization's list of Presence Definitions|
12
13
  |[**get_presence_id**](PresenceApi.html#get_presence_id) | **GET** /api/v2/presencedefinitions/{presenceId} | Get a Presence Definition|
13
- |[**get_presencedefinitions**](PresenceApi.html#get_presencedefinitions) | **GET** /api/v2/presencedefinitions | Get an Organization's list of Presence Definitions|
14
14
  |[**get_systempresences**](PresenceApi.html#get_systempresences) | **GET** /api/v2/systempresences | Get the list of SystemPresences|
15
15
  |[**get_user_id_presences_source_id**](PresenceApi.html#get_user_id_presences_source_id) | **GET** /api/v2/users/{userId}/presences/{sourceId} | Get a user's Presence|
16
16
  |[**patch_user_id_presences_source_id**](PresenceApi.html#patch_user_id_presences_source_id) | **PATCH** /api/v2/users/{userId}/presences/{sourceId} | Patch a user's Presence|
17
- |[**post_presencedefinitions**](PresenceApi.html#post_presencedefinitions) | **POST** /api/v2/presencedefinitions | Create a Presence Definition|
17
+ |[**post**](PresenceApi.html#post) | **POST** /api/v2/presencedefinitions | Create a Presence Definition|
18
18
  |[**put_presence_id**](PresenceApi.html#put_presence_id) | **PUT** /api/v2/presencedefinitions/{presenceId} | Update a Presence Definition|
19
19
  {: class="table table-striped"}
20
20
 
@@ -73,11 +73,11 @@ nil (empty response body)
73
73
 
74
74
 
75
75
 
76
- <a name="get_presence_id"></a>
76
+ <a name="get"></a>
77
77
 
78
- ## -[**OrganizationPresence**](OrganizationPresence.html) get_presence_id(presence_id, opts)
78
+ ## -[**OrganizationPresenceEntityListing**](OrganizationPresenceEntityListing.html) get(opts)
79
79
 
80
- Get a Presence Definition
80
+ Get an Organization's list of Presence Definitions
81
81
 
82
82
 
83
83
 
@@ -98,18 +98,19 @@ end
98
98
 
99
99
  api_instance = PureCloud::PresenceApi.new
100
100
 
101
- presence_id = "presence_id_example" # String | Organization Presence ID
102
-
103
101
  opts = {
104
- locale_code: "locale_code_example" # String | The locale code to fetch for the presence definition. Use ALL to fetch everything.
102
+ page_number: 1, # Integer | Page number
103
+ page_size: 25, # Integer | Page size
104
+ deleted: "false", # String | Deleted query can be TRUE, FALSE or ALL
105
+ locale_code: "locale_code_example" # String | The locale code to fetch for each presence definition. Use ALL to fetch everything.
105
106
  }
106
107
 
107
108
  begin
108
- #Get a Presence Definition
109
- result = api_instance.get_presence_id(presence_id, opts)
109
+ #Get an Organization's list of Presence Definitions
110
+ result = api_instance.get(opts)
110
111
  p result
111
112
  rescue PureCloud::ApiError => e
112
- puts "Exception when calling PresenceApi->get_presence_id: #{e}"
113
+ puts "Exception when calling PresenceApi->get: #{e}"
113
114
  end
114
115
  ~~~
115
116
 
@@ -117,14 +118,16 @@ end
117
118
 
118
119
  Name | Type | Description | Notes
119
120
  ------------- | ------------- | ------------- | -------------
120
- **presence_id** | **String**| Organization Presence ID |
121
- **locale_code** | **String**| The locale code to fetch for the presence definition. Use ALL to fetch everything. | [optional]
121
+ **page_number** | **Integer**| Page number | [optional] [default to 1]
122
+ **page_size** | **Integer**| Page size | [optional] [default to 25]
123
+ **deleted** | **String**| Deleted query can be TRUE, FALSE or ALL | [optional] [default to false]
124
+ **locale_code** | **String**| The locale code to fetch for each presence definition. Use ALL to fetch everything. | [optional]
122
125
  {: class="table table-striped"}
123
126
 
124
127
 
125
128
  ### Return type
126
129
 
127
- [**OrganizationPresence**](OrganizationPresence.html)
130
+ [**OrganizationPresenceEntityListing**](OrganizationPresenceEntityListing.html)
128
131
 
129
132
  ### HTTP request headers
130
133
 
@@ -133,11 +136,11 @@ Name | Type | Description | Notes
133
136
 
134
137
 
135
138
 
136
- <a name="get_presencedefinitions"></a>
139
+ <a name="get_presence_id"></a>
137
140
 
138
- ## -[**OrganizationPresenceEntityListing**](OrganizationPresenceEntityListing.html) get_presencedefinitions(opts)
141
+ ## -[**OrganizationPresence**](OrganizationPresence.html) get_presence_id(presence_id, opts)
139
142
 
140
- Get an Organization's list of Presence Definitions
143
+ Get a Presence Definition
141
144
 
142
145
 
143
146
 
@@ -158,19 +161,18 @@ end
158
161
 
159
162
  api_instance = PureCloud::PresenceApi.new
160
163
 
164
+ presence_id = "presence_id_example" # String | Organization Presence ID
165
+
161
166
  opts = {
162
- page_number: 1, # Integer | Page number
163
- page_size: 25, # Integer | Page size
164
- deleted: "false", # String | Deleted query can be TRUE, FALSE or ALL
165
- locale_code: "locale_code_example" # String | The locale code to fetch for each presence definition. Use ALL to fetch everything.
167
+ locale_code: "locale_code_example" # String | The locale code to fetch for the presence definition. Use ALL to fetch everything.
166
168
  }
167
169
 
168
170
  begin
169
- #Get an Organization's list of Presence Definitions
170
- result = api_instance.get_presencedefinitions(opts)
171
+ #Get a Presence Definition
172
+ result = api_instance.get_presence_id(presence_id, opts)
171
173
  p result
172
174
  rescue PureCloud::ApiError => e
173
- puts "Exception when calling PresenceApi->get_presencedefinitions: #{e}"
175
+ puts "Exception when calling PresenceApi->get_presence_id: #{e}"
174
176
  end
175
177
  ~~~
176
178
 
@@ -178,16 +180,14 @@ end
178
180
 
179
181
  Name | Type | Description | Notes
180
182
  ------------- | ------------- | ------------- | -------------
181
- **page_number** | **Integer**| Page number | [optional] [default to 1]
182
- **page_size** | **Integer**| Page size | [optional] [default to 25]
183
- **deleted** | **String**| Deleted query can be TRUE, FALSE or ALL | [optional] [default to false]
184
- **locale_code** | **String**| The locale code to fetch for each presence definition. Use ALL to fetch everything. | [optional]
183
+ **presence_id** | **String**| Organization Presence ID |
184
+ **locale_code** | **String**| The locale code to fetch for the presence definition. Use ALL to fetch everything. | [optional]
185
185
  {: class="table table-striped"}
186
186
 
187
187
 
188
188
  ### Return type
189
189
 
190
- [**OrganizationPresenceEntityListing**](OrganizationPresenceEntityListing.html)
190
+ [**OrganizationPresence**](OrganizationPresence.html)
191
191
 
192
192
  ### HTTP request headers
193
193
 
@@ -367,9 +367,9 @@ Name | Type | Description | Notes
367
367
 
368
368
 
369
369
 
370
- <a name="post_presencedefinitions"></a>
370
+ <a name="post"></a>
371
371
 
372
- ## -[**OrganizationPresence**](OrganizationPresence.html) post_presencedefinitions(body)
372
+ ## -[**OrganizationPresence**](OrganizationPresence.html) post(body)
373
373
 
374
374
  Create a Presence Definition
375
375
 
@@ -397,10 +397,10 @@ body = PureCloud::OrganizationPresence.new # OrganizationPresence | The Presence
397
397
 
398
398
  begin
399
399
  #Create a Presence Definition
400
- result = api_instance.post_presencedefinitions(body)
400
+ result = api_instance.post(body)
401
401
  p result
402
402
  rescue PureCloud::ApiError => e
403
- puts "Exception when calling PresenceApi->post_presencedefinitions: #{e}"
403
+ puts "Exception when calling PresenceApi->post: #{e}"
404
404
  end
405
405
  ~~~
406
406
 
data/doc_out/PureCloud.html.md CHANGED
@@ -9,7 +9,7 @@ title: PureCloud
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
- | **disabled** | **BOOLEAN** | | [optional] [default to false]|
12
+ | **disabled** | **BOOLEAN** | | [optional] |
13
13
  | **self_uri** | **String** | The URI for this object | [optional] |
14
14
  {: class="table table-striped"}
15
15
 
data/doc_out/QualityAudit.html.md CHANGED
@@ -15,8 +15,8 @@ title: QualityAudit
15
15
  | **entity** | [**AuditEntity**](AuditEntity.html) | | [optional] |
16
16
  | **action** | **String** | | [optional] |
17
17
  | **status** | **String** | | [optional] |
18
- | **entity_type** | **String** | | [optional] |
19
18
  | **changes** | [**Array&lt;Change&gt;**](Change.html) | | [optional] |
19
+ | **entity_type** | **String** | | [optional] |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
data/doc_out/QueryRequest.html.md CHANGED
@@ -14,7 +14,7 @@ title: QueryRequest
14
14
  | **sort** | [**Array&lt;SortItem&gt;**](SortItem.html) | | [optional] |
15
15
  | **filters** | [**Array&lt;ContentFilterItem&gt;**](ContentFilterItem.html) | | [optional] |
16
16
  | **attribute_filters** | [**Array&lt;AttributeFilterItem&gt;**](AttributeFilterItem.html) | | [optional] |
17
- | **include_shares** | **BOOLEAN** | | [optional] [default to false]|
17
+ | **include_shares** | **BOOLEAN** | | [optional] |
18
18
  {: class="table table-striped"}
19
19
 
20
20
 
data/doc_out/QuestionGroup.html.md CHANGED
@@ -10,11 +10,11 @@ title: QuestionGroup
10
10
  | **id** | **String** | | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **type** | **String** | | [optional] |
13
- | **default_answers_to_highest** | **BOOLEAN** | | [optional] [default to false]|
14
- | **default_answers_to_na** | **BOOLEAN** | | [optional] [default to false]|
15
- | **na_enabled** | **BOOLEAN** | | [optional] [default to false]|
13
+ | **default_answers_to_highest** | **BOOLEAN** | | [optional] |
14
+ | **default_answers_to_na** | **BOOLEAN** | | [optional] |
15
+ | **na_enabled** | **BOOLEAN** | | [optional] |
16
16
  | **weight** | **Float** | | [optional] |
17
- | **manual_weight** | **BOOLEAN** | | [optional] [default to false]|
17
+ | **manual_weight** | **BOOLEAN** | | [optional] |
18
18
  | **questions** | **Array&lt;Hash&lt;String, Object&gt;&gt;** | | [optional] |
19
19
  | **visibility_condition** | [**VisibilityCondition**](VisibilityCondition.html) | | [optional] |
20
20
  {: class="table table-striped"}
data/doc_out/QuestionGroupScore.html.md CHANGED
@@ -16,7 +16,7 @@ title: QuestionGroupScore
16
16
  | **max_total_score_unweighted** | **Float** | | [optional] |
17
17
  | **total_critical_score_unweighted** | **Float** | | [optional] |
18
18
  | **max_total_critical_score_unweighted** | **Float** | | [optional] |
19
- | **marked_na** | **BOOLEAN** | | [optional] [default to false]|
19
+ | **marked_na** | **BOOLEAN** | | [optional] |
20
20
  | **question_scores** | [**Array&lt;QuestionScore&gt;**](QuestionScore.html) | | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
data/doc_out/QuestionScore.html.md CHANGED
@@ -10,8 +10,8 @@ title: QuestionScore
10
10
  | **question_id** | **String** | | [optional] |
11
11
  | **answer_id** | **String** | | [optional] |
12
12
  | **score** | **Integer** | | [optional] |
13
- | **marked_na** | **BOOLEAN** | | [optional] [default to false]|
14
- | **failed_kill_question** | **BOOLEAN** | | [optional] [default to false]|
13
+ | **marked_na** | **BOOLEAN** | | [optional] |
14
+ | **failed_kill_question** | **BOOLEAN** | | [optional] |
15
15
  | **comments** | **String** | | [optional] |
16
16
  {: class="table table-striped"}
17
17
 
data/doc_out/QueueMember.html.md CHANGED
@@ -11,7 +11,7 @@ title: QueueMember
11
11
  | **name** | **String** | | [optional] |
12
12
  | **user** | [**User**](User.html) | | [optional] |
13
13
  | **ring_number** | **Integer** | | [optional] |
14
- | **joined** | **BOOLEAN** | | [optional] [default to false]|
14
+ | **joined** | **BOOLEAN** | | [optional] |
15
15
  | **member_by** | **String** | | [optional] |
16
16
  | **routing_status** | [**RoutingStatus**](RoutingStatus.html) | | [optional] |
17
17
  | **self_uri** | **String** | The URI for this object | [optional] |
data/doc_out/RecordingApi.html.md CHANGED
@@ -12,6 +12,7 @@ Method | HTTP request | Description
12
12
  |[**delete_mediaretentionpolicies**](RecordingApi.html#delete_mediaretentionpolicies) | **DELETE** /api/v2/recording/mediaretentionpolicies | Delete media retention policies|
13
13
  |[**delete_mediaretentionpolicies_policy_id**](RecordingApi.html#delete_mediaretentionpolicies_policy_id) | **DELETE** /api/v2/recording/mediaretentionpolicies/{policyId} | Delete a media retention policy|
14
14
  |[**delete_orphan_id**](RecordingApi.html#delete_orphan_id) | **DELETE** /api/v2/orphanrecordings/{orphanId} | Deletes a single orphan recording|
15
+ |[**get**](RecordingApi.html#get) | **GET** /api/v2/orphanrecordings | Gets all orphan recordings|
15
16
  |[**get_conversation_id_recordings**](RecordingApi.html#get_conversation_id_recordings) | **GET** /api/v2/conversations/{conversationId}/recordings | Get all of a Conversation&#39;s Recordings.|
16
17
  |[**get_conversation_id_recordings_recording_id**](RecordingApi.html#get_conversation_id_recordings_recording_id) | **GET** /api/v2/conversations/{conversationId}/recordings/{recordingId} | Gets a specific recording.|
17
18
  |[**get_conversation_id_recordings_recording_id_annotations**](RecordingApi.html#get_conversation_id_recordings_recording_id_annotations) | **GET** /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations | Get annotations for recording|
@@ -22,7 +23,6 @@ Method | HTTP request | Description
22
23
  |[**get_mediaretentionpolicies_policy_id**](RecordingApi.html#get_mediaretentionpolicies_policy_id) | **GET** /api/v2/recording/mediaretentionpolicies/{policyId} | Get a media retention policy|
23
24
  |[**get_orphan_id**](RecordingApi.html#get_orphan_id) | **GET** /api/v2/orphanrecordings/{orphanId} | Gets a single orphan recording|
24
25
  |[**get_orphan_id_media**](RecordingApi.html#get_orphan_id_media) | **GET** /api/v2/orphanrecordings/{orphanId}/media | Gets the media of a single orphan recording|
25
- |[**get_orphanrecordings**](RecordingApi.html#get_orphanrecordings) | **GET** /api/v2/orphanrecordings | Gets all orphan recordings|
26
26
  |[**get_recordingkeys**](RecordingApi.html#get_recordingkeys) | **GET** /api/v2/recording/recordingkeys | Get encryption key list|
27
27
  |[**get_recordingkeys_rotationschedule**](RecordingApi.html#get_recordingkeys_rotationschedule) | **GET** /api/v2/recording/recordingkeys/rotationschedule | Get key rotation schedule|
28
28
  |[**get_settings**](RecordingApi.html#get_settings) | **GET** /api/v2/recording/settings | Get the Recording Settings for the Organization|
@@ -272,6 +272,75 @@ Name | Type | Description | Notes
272
272
 
273
273
 
274
274
 
275
+ <a name="get"></a>
276
+
277
+ ## -[**OrphanRecordingListing**](OrphanRecordingListing.html) get(opts)
278
+
279
+ Gets all orphan recordings
280
+
281
+
282
+
283
+ ### Example
284
+ ~~~ruby
285
+ # load the gem
286
+ require 'purecloud'
287
+ # setup authorization
288
+ @secret = ENV['PURECLOUD_SECRET']
289
+ @id = ENV['PURECLOUD_CLIENT_ID']
290
+ environment = "mypurecloud.com"
291
+
292
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
293
+
294
+ PureCloud.configure do |config|
295
+ config.access_token = @authToken
296
+ end
297
+
298
+ api_instance = PureCloud::RecordingApi.new
299
+
300
+ opts = {
301
+ page_size: 25, # Integer | The total page size requested
302
+ page_number: 1, # Integer | The page number requested
303
+ sort_by: "sort_by_example", # String | variable name requested to sort by
304
+ expand: nil, # Array<Object> | variable name requested by expand list
305
+ next_page: "next_page_example", # String | next page token
306
+ previous_page: "previous_page_example", # String | Previous page token
307
+ has_conversation: false # BOOLEAN | Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.
308
+ }
309
+
310
+ begin
311
+ #Gets all orphan recordings
312
+ result = api_instance.get(opts)
313
+ p result
314
+ rescue PureCloud::ApiError => e
315
+ puts "Exception when calling RecordingApi->get: #{e}"
316
+ end
317
+ ~~~
318
+
319
+ ### Parameters
320
+
321
+ Name | Type | Description | Notes
322
+ ------------- | ------------- | ------------- | -------------
323
+ **page_size** | **Integer**| The total page size requested | [optional] [default to 25]
324
+ **page_number** | **Integer**| The page number requested | [optional] [default to 1]
325
+ **sort_by** | **String**| variable name requested to sort by | [optional]
326
+ **expand** | [**Array&lt;Object&gt;**](Object.html)| variable name requested by expand list | [optional]
327
+ **next_page** | **String**| next page token | [optional]
328
+ **previous_page** | **String**| Previous page token | [optional]
329
+ **has_conversation** | **BOOLEAN**| Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. | [optional] [default to false]
330
+ {: class="table table-striped"}
331
+
332
+
333
+ ### Return type
334
+
335
+ [**OrphanRecordingListing**](OrphanRecordingListing.html)
336
+
337
+ ### HTTP request headers
338
+
339
+ - **Content-Type**: application/json
340
+ - **Accept**: application/json
341
+
342
+
343
+
275
344
  <a name="get_conversation_id_recordings"></a>
276
345
 
277
346
  ## -[**Array&lt;Recording&gt;**](Recording.html) get_conversation_id_recordings(conversation_id, opts)
@@ -879,75 +948,6 @@ Name | Type | Description | Notes
879
948
 
880
949
 
881
950
 
882
- <a name="get_orphanrecordings"></a>
883
-
884
- ## -[**OrphanRecordingListing**](OrphanRecordingListing.html) get_orphanrecordings(opts)
885
-
886
- Gets all orphan recordings
887
-
888
-
889
-
890
- ### Example
891
- ~~~ruby
892
- # load the gem
893
- require 'purecloud'
894
- # setup authorization
895
- @secret = ENV['PURECLOUD_SECRET']
896
- @id = ENV['PURECLOUD_CLIENT_ID']
897
- environment = "mypurecloud.com"
898
-
899
- @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
900
-
901
- PureCloud.configure do |config|
902
- config.access_token = @authToken
903
- end
904
-
905
- api_instance = PureCloud::RecordingApi.new
906
-
907
- opts = {
908
- page_size: 25, # Integer | The total page size requested
909
- page_number: 1, # Integer | The page number requested
910
- sort_by: "sort_by_example", # String | variable name requested to sort by
911
- expand: nil, # Array<Object> | variable name requested by expand list
912
- next_page: "next_page_example", # String | next page token
913
- previous_page: "previous_page_example", # String | Previous page token
914
- has_conversation: false # BOOLEAN | Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization.
915
- }
916
-
917
- begin
918
- #Gets all orphan recordings
919
- result = api_instance.get_orphanrecordings(opts)
920
- p result
921
- rescue PureCloud::ApiError => e
922
- puts "Exception when calling RecordingApi->get_orphanrecordings: #{e}"
923
- end
924
- ~~~
925
-
926
- ### Parameters
927
-
928
- Name | Type | Description | Notes
929
- ------------- | ------------- | ------------- | -------------
930
- **page_size** | **Integer**| The total page size requested | [optional] [default to 25]
931
- **page_number** | **Integer**| The page number requested | [optional] [default to 1]
932
- **sort_by** | **String**| variable name requested to sort by | [optional]
933
- **expand** | [**Array&lt;Object&gt;**](Object.html)| variable name requested by expand list | [optional]
934
- **next_page** | **String**| next page token | [optional]
935
- **previous_page** | **String**| Previous page token | [optional]
936
- **has_conversation** | **BOOLEAN**| Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. | [optional] [default to false]
937
- {: class="table table-striped"}
938
-
939
-
940
- ### Return type
941
-
942
- [**OrphanRecordingListing**](OrphanRecordingListing.html)
943
-
944
- ### HTTP request headers
945
-
946
- - **Content-Type**: application/json
947
- - **Accept**: application/json
948
-
949
-
950
-
951
951
  <a name="get_recordingkeys"></a>
952
952
 
953
953
  ## -[**EncryptionKeyEntityListing**](EncryptionKeyEntityListing.html) get_recordingkeys(opts)
data/doc_out/ReportSchedule.html.md CHANGED
@@ -19,7 +19,7 @@ title: ReportSchedule
19
19
  | **interval** | **String** | Interval. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
20
20
  | **report_format** | **String** | | [optional] |
21
21
  | **locale** | **String** | | [optional] |
22
- | **enabled** | **BOOLEAN** | | [optional] [default to false]|
22
+ | **enabled** | **BOOLEAN** | | [optional] |
23
23
  | **report_id** | **String** | Report ID | |
24
24
  | **parameters** | **Hash&lt;String, Object&gt;** | | [optional] |
25
25
  | **last_run** | [**ReportRunEntry**](ReportRunEntry.html) | | [optional] |
data/doc_out/ResourcePermissionPolicy.html.md CHANGED
@@ -13,7 +13,7 @@ title: ResourcePermissionPolicy
13
13
  | **policy_name** | **String** | | [optional] |
14
14
  | **policy_description** | **String** | | [optional] |
15
15
  | **action_set_key** | **String** | | [optional] |
16
- | **allow_conditions** | **BOOLEAN** | | [optional] [default to false]|
16
+ | **allow_conditions** | **BOOLEAN** | | [optional] |
17
17
  | **resource_condition_node** | [**ResourceConditionNode**](ResourceConditionNode.html) | | [optional] |
18
18
  | **named_resources** | **Array&lt;String&gt;** | | [optional] |
19
19
  | **resource_condition** | **String** | | [optional] |
data/doc_out/RoutingStatusRule.html.md CHANGED
@@ -12,8 +12,8 @@ title: RoutingStatusRule
12
12
  | **agent** | [**User**](User.html) | The agent whose routing status will be watched. | |
13
13
  | **routing_status** | **String** | The routing status on which to alert. | |
14
14
  | **routing_limit_in_seconds** | **Integer** | The number of seconds to wait before alerting based upon the agent&#39;s routing status. | |
15
- | **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | [default to false]|
16
- | **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] [default to false]|
15
+ | **enabled** | **BOOLEAN** | Indicates if the rule is enabled. | |
16
+ | **in_alarm** | **BOOLEAN** | Indicates if the rule is in alarm state. | [optional] |
17
17
  | **notification_users** | [**Array&lt;User&gt;**](User.html) | The ids of users who will be notified of alarm state change. | |
18
18
  | **alert_types** | **Array&lt;String&gt;** | A collection of notification methods. | |
19
19
  | **self_uri** | **String** | The URI for this object | [optional] |
data/doc_out/Salesforce.html.md CHANGED
@@ -12,7 +12,7 @@ title: Salesforce
12
12
  | **certificate** | **String** | | [optional] |
13
13
  | **issuer_uri** | **String** | | [optional] |
14
14
  | **sso_target_uri** | **String** | | [optional] |
15
- | **disabled** | **BOOLEAN** | | [optional] [default to false]|
15
+ | **disabled** | **BOOLEAN** | | [optional] |
16
16
  | **self_uri** | **String** | The URI for this object | [optional] |
17
17
  {: class="table table-striped"}
18
18