purecloudplatformclientv2 14.0.0 → 14.1.0

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 (40) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +2 -2
  3. data/docs/CertificateDetails.md +1 -1
  4. data/docs/DomainOrganizationRole.md +1 -1
  5. data/docs/DomainOrganizationRoleCreate.md +1 -1
  6. data/docs/DomainOrganizationRoleUpdate.md +1 -1
  7. data/docs/Edge.md +1 -0
  8. data/docs/JsonNode.md +2 -2
  9. data/docs/LicenseApi.md +120 -0
  10. data/docs/LicenseOrgToggle.md +14 -0
  11. data/docs/OAuthClient.md +4 -0
  12. data/docs/OAuthClientListing.md +4 -0
  13. data/docs/OrgOAuthClient.md +4 -0
  14. data/docs/OutOfOffice.md +1 -0
  15. data/docs/UsersApi.md +2 -2
  16. data/docs/VoicemailApi.md +77 -14
  17. data/docs/VoicemailMessage.md +1 -0
  18. data/docs/VoicemailRetentionPolicy.md +14 -0
  19. data/lib/purecloudplatformclientv2.rb +2 -0
  20. data/lib/purecloudplatformclientv2/api/license_api.rb +130 -0
  21. data/lib/purecloudplatformclientv2/api/users_api.rb +2 -2
  22. data/lib/purecloudplatformclientv2/api/voicemail_api.rb +87 -12
  23. data/lib/purecloudplatformclientv2/api_client.rb +1 -1
  24. data/lib/purecloudplatformclientv2/models/activity_code.rb +2 -2
  25. data/lib/purecloudplatformclientv2/models/certificate_details.rb +13 -13
  26. data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
  27. data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
  28. data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
  29. data/lib/purecloudplatformclientv2/models/edge.rb +27 -1
  30. data/lib/purecloudplatformclientv2/models/json_node.rb +50 -50
  31. data/lib/purecloudplatformclientv2/models/license_org_toggle.rb +226 -0
  32. data/lib/purecloudplatformclientv2/models/o_auth_client.rb +105 -1
  33. data/lib/purecloudplatformclientv2/models/o_auth_client_listing.rb +105 -1
  34. data/lib/purecloudplatformclientv2/models/org_o_auth_client.rb +105 -1
  35. data/lib/purecloudplatformclientv2/models/out_of_office.rb +26 -1
  36. data/lib/purecloudplatformclientv2/models/user_schedule_adherence.rb +4 -4
  37. data/lib/purecloudplatformclientv2/models/voicemail_message.rb +27 -1
  38. data/lib/purecloudplatformclientv2/models/voicemail_retention_policy.rb +243 -0
  39. data/lib/purecloudplatformclientv2/version.rb +1 -1
  40. metadata +6 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: b14a3081eaec15589a6376100176c3e45cb9437d
4
- data.tar.gz: c0a012e0b722abda8369b7ae2ee095e8a1d60be2
3
+ metadata.gz: c1b46eb5b8a6e922c883f23c9d386016c06badc2
4
+ data.tar.gz: eafcd5cf8df3a1e66831447b1c795a5b6bc07a80
5
5
  SHA512:
6
- metadata.gz: c31dee8c96939a6183ee1c7fa88ce05ead884c8026f98d202d1c688103cd78401e818a018dd8621e31f7fb58b14fbf79a5c85be213b096036f4e606b56c82cb2
7
- data.tar.gz: 887368fd459d1dfef889b1aef3d723d2c6edc6234a0996918f1a21dae0e858835a71886553867e44a115a4d519337810af6ed195d550f8a803f40bb3b96f1027
6
+ metadata.gz: fd6c4b964d25eaa66ec72d03b64faf9cecb8875a5615d7972a5e9b16af7579cb9418ec1fe68a61bc0cfb47928d0a5652a847a6e2727cbc7c4fc356039dd995f1
7
+ data.tar.gz: 72000c0e9e8a189239f4bc88c3eb65256dd6b5a9d99169743b66d824718562121c2aff29b67604a2a49eeec908c658ba28af74905758a3ab8a5adb3bf943da08
data/README.md CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  title: PureCloud Ruby Gem
3
3
  ---
4
- ![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=14.0.0)
4
+ ![](http://ruby-gem-downloads-badge.herokuapp.com/purecloudplatformclientv2?label=14.1.0)
5
5
 
6
6
  Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
7
7
 
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
10
10
  ### from rubygems.org
11
11
 
12
12
  ~~~ ruby
13
- gem install 'purecloudplatformclientv2', '~> 14.0.0'
13
+ gem install 'purecloudplatformclientv2', '~> 14.1.0'
14
14
  ~~~
15
15
 
16
16
  ### Install from Git
@@ -12,8 +12,8 @@ title: CertificateDetails
12
12
  | **expiration_date** | **DateTime** | The expiration date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
13
  | **issue_date** | **DateTime** | The issue date of the certificate. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
14
  | **expired** | **BOOLEAN** | True if the certificate is expired, false otherwise. | [optional] |
15
- | **signature_valid** | **BOOLEAN** | | [optional] |
16
15
  | **valid** | **BOOLEAN** | | [optional] |
16
+ | **signature_valid** | **BOOLEAN** | | [optional] |
17
17
  {: class="table table-striped"}
18
18
 
19
19
 
@@ -15,8 +15,8 @@ title: DomainOrganizationRole
15
15
  | **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
16
16
  | **user_count** | **Integer** | | [optional] |
17
17
  | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
18
- | **base** | **BOOLEAN** | | [optional] |
19
18
  | **default** | **BOOLEAN** | | [optional] |
19
+ | **base** | **BOOLEAN** | | [optional] |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
@@ -15,8 +15,8 @@ title: DomainOrganizationRoleCreate
15
15
  | **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
16
16
  | **user_count** | **Integer** | | [optional] |
17
17
  | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
18
- | **base** | **BOOLEAN** | | [optional] |
19
18
  | **default** | **BOOLEAN** | | [optional] |
19
+ | **base** | **BOOLEAN** | | [optional] |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
@@ -15,8 +15,8 @@ title: DomainOrganizationRoleUpdate
15
15
  | **permission_policies** | [**Array<DomainPermissionPolicy>**](DomainPermissionPolicy.html) | | [optional] |
16
16
  | **user_count** | **Integer** | | [optional] |
17
17
  | **role_needs_update** | **BOOLEAN** | Optional unless patch operation. | [optional] |
18
- | **base** | **BOOLEAN** | | [optional] |
19
18
  | **default** | **BOOLEAN** | | [optional] |
19
+ | **base** | **BOOLEAN** | | [optional] |
20
20
  | **self_uri** | **String** | The URI for this object | [optional] |
21
21
  {: class="table table-striped"}
22
22
 
data/docs/Edge.md CHANGED
@@ -45,6 +45,7 @@ title: Edge
45
45
  | **call_draining_state** | **String** | | [optional] |
46
46
  | **conversation_count** | **Integer** | | [optional] |
47
47
  | **proxy** | **String** | Edge HTTP proxy configuration for the WAN port. The field can be a hostname, FQDN, IPv4 or IPv6 address. If port is not included, port 80 is assumed. | [optional] |
48
+ | **offline_config_called** | **BOOLEAN** | True if the offline edge configuration endpoint has been called for this edge. | [optional] |
48
49
  | **os_name** | **String** | The name provided by the operating system of the Edge. | [optional] |
49
50
  | **self_uri** | **String** | The URI for this object | [optional] |
50
51
  {: class="table table-striped"}
data/docs/JsonNode.md CHANGED
@@ -7,6 +7,8 @@ title: JsonNode
7
7
 
8
8
  |Name | Type | Description | Notes|
9
9
  |------------ | ------------- | ------------- | -------------|
10
+ | **array** | **BOOLEAN** | | [optional] |
11
+ | **null** | **BOOLEAN** | | [optional] |
10
12
  | **node_type** | **String** | | [optional] |
11
13
  | **float** | **BOOLEAN** | | [optional] |
12
14
  | **object** | **BOOLEAN** | | [optional] |
@@ -26,8 +28,6 @@ title: JsonNode
26
28
  | **big_integer** | **BOOLEAN** | | [optional] |
27
29
  | **textual** | **BOOLEAN** | | [optional] |
28
30
  | **binary** | **BOOLEAN** | | [optional] |
29
- | **array** | **BOOLEAN** | | [optional] |
30
- | **null** | **BOOLEAN** | | [optional] |
31
31
  {: class="table table-striped"}
32
32
 
33
33
 
data/docs/LicenseApi.md CHANGED
@@ -11,8 +11,10 @@ Method | Description
11
11
  [**get_license_definition**](LicenseApi.html#get_license_definition) | Get PureCloud license definition.
12
12
  [**get_license_definitions**](LicenseApi.html#get_license_definitions) | Get all PureCloud license definitions available for the organization.
13
13
  [**get_license_organization**](LicenseApi.html#get_license_organization) | Get license assignments for the organization.
14
+ [**get_license_toggle**](LicenseApi.html#get_license_toggle) | Get PureCloud license feature toggle value.
14
15
  [**get_license_user**](LicenseApi.html#get_license_user) | Get licenses for specified user.
15
16
  [**post_license_organization**](LicenseApi.html#post_license_organization) | Update the organization's license assignments in a batch.
17
+ [**post_license_toggle**](LicenseApi.html#post_license_toggle) | Switch PureCloud license feature toggle value.
16
18
  [**post_license_users**](LicenseApi.html#post_license_users) | Fetch user licenses in a batch.
17
19
  {: class="table table-striped"}
18
20
 
@@ -181,6 +183,65 @@ This endpoint does not need any parameter.
181
183
 
182
184
 
183
185
 
186
+ <a name="get_license_toggle"></a>
187
+
188
+ ## -[**LicenseOrgToggle**](LicenseOrgToggle.html) get_license_toggle(feature_name)
189
+
190
+ Get PureCloud license feature toggle value.
191
+
192
+
193
+
194
+ Wraps GET /api/v2/license/toggles/{featureName}
195
+
196
+
197
+ ### Example
198
+ ~~~ruby
199
+ # load the gem
200
+ require 'purecloudplatformclientv2'
201
+ # setup authorization
202
+ @secret = ENV['PURECLOUD_SECRET']
203
+ @id = ENV['PURECLOUD_CLIENT_ID']
204
+ environment = "mypurecloud.com"
205
+
206
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
207
+
208
+ PureCloud.configure do |config|
209
+ config.access_token = @authToken
210
+ end
211
+
212
+ api_instance = PureCloud::LicenseApi.new
213
+
214
+ feature_name = "feature_name_example" # String | featureName
215
+
216
+
217
+ begin
218
+ #Get PureCloud license feature toggle value.
219
+ result = api_instance.get_license_toggle(feature_name)
220
+ p result
221
+ rescue PureCloud::ApiError => e
222
+ puts "Exception when calling LicenseApi->get_license_toggle: #{e}"
223
+ end
224
+ ~~~
225
+
226
+ ### Parameters
227
+
228
+ Name | Type | Description | Notes
229
+ ------------- | ------------- | ------------- | -------------
230
+ **feature_name** | **String**| featureName | |
231
+ {: class="table table-striped"}
232
+
233
+
234
+ ### Return type
235
+
236
+ [**LicenseOrgToggle**](LicenseOrgToggle.html)
237
+
238
+ ### HTTP request headers
239
+
240
+ - **Content-Type**: application/json
241
+ - **Accept**: application/json
242
+
243
+
244
+
184
245
  <a name="get_license_user"></a>
185
246
 
186
247
  ## -[**LicenseUser**](LicenseUser.html) get_license_user(user_id)
@@ -300,6 +361,65 @@ Name | Type | Description | Notes
300
361
 
301
362
 
302
363
 
364
+ <a name="post_license_toggle"></a>
365
+
366
+ ## -[**LicenseOrgToggle**](LicenseOrgToggle.html) post_license_toggle(feature_name)
367
+
368
+ Switch PureCloud license feature toggle value.
369
+
370
+
371
+
372
+ Wraps POST /api/v2/license/toggles/{featureName}
373
+
374
+
375
+ ### Example
376
+ ~~~ruby
377
+ # load the gem
378
+ require 'purecloudplatformclientv2'
379
+ # setup authorization
380
+ @secret = ENV['PURECLOUD_SECRET']
381
+ @id = ENV['PURECLOUD_CLIENT_ID']
382
+ environment = "mypurecloud.com"
383
+
384
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
385
+
386
+ PureCloud.configure do |config|
387
+ config.access_token = @authToken
388
+ end
389
+
390
+ api_instance = PureCloud::LicenseApi.new
391
+
392
+ feature_name = "feature_name_example" # String | featureName
393
+
394
+
395
+ begin
396
+ #Switch PureCloud license feature toggle value.
397
+ result = api_instance.post_license_toggle(feature_name)
398
+ p result
399
+ rescue PureCloud::ApiError => e
400
+ puts "Exception when calling LicenseApi->post_license_toggle: #{e}"
401
+ end
402
+ ~~~
403
+
404
+ ### Parameters
405
+
406
+ Name | Type | Description | Notes
407
+ ------------- | ------------- | ------------- | -------------
408
+ **feature_name** | **String**| featureName | |
409
+ {: class="table table-striped"}
410
+
411
+
412
+ ### Return type
413
+
414
+ [**LicenseOrgToggle**](LicenseOrgToggle.html)
415
+
416
+ ### HTTP request headers
417
+
418
+ - **Content-Type**: application/json
419
+ - **Accept**: application/json
420
+
421
+
422
+
303
423
  <a name="post_license_users"></a>
304
424
 
305
425
  ## -Hash&lt;String, Object&gt;** post_license_users(opts)
@@ -0,0 +1,14 @@
1
+ ---
2
+ title: LicenseOrgToggle
3
+ ---
4
+ ## PureCloud::LicenseOrgToggle
5
+
6
+ ## Properties
7
+
8
+ |Name | Type | Description | Notes|
9
+ |------------ | ------------- | ------------- | -------------|
10
+ | **feature_name** | **String** | | [optional] |
11
+ | **enabled** | **BOOLEAN** | | [optional] |
12
+ {: class="table table-striped"}
13
+
14
+
data/docs/OAuthClient.md CHANGED
@@ -14,6 +14,10 @@ title: OAuthClient
14
14
  | **registered_redirect_uri** | **Array&lt;String&gt;** | List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback | [optional] |
15
15
  | **secret** | **String** | System created secret assigned to this client. Secrets are required for code authorization and client credential grants. | [optional] |
16
16
  | **role_ids** | **Array&lt;String&gt;** | Roles assigned to this client. Roles only apply to clients using the client_credential grant | [optional] |
17
+ | **date_created** | **DateTime** | Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
18
+ | **date_modified** | **DateTime** | Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
19
+ | **created_by** | [**UriReference**](UriReference.html) | User that created this client | [optional] |
20
+ | **modified_by** | [**UriReference**](UriReference.html) | User that last modified this client | [optional] |
17
21
  | **authorized_grant_type** | **String** | The OAuth Grant/Client type supported by this client. Code Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured. Implicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured. SAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint. Client Credential grant type - Used to created access tokens that are tied only to the client. | |
18
22
  | **self_uri** | **String** | The URI for this object | [optional] |
19
23
  {: class="table table-striped"}
@@ -14,6 +14,10 @@ title: OAuthClientListing
14
14
  | **registered_redirect_uri** | **Array&lt;String&gt;** | List of allowed callbacks for this client. For example: https://myap.example.com/auth/callback | [optional] |
15
15
  | **secret** | **String** | System created secret assigned to this client. Secrets are required for code authorization and client credential grants. | [optional] |
16
16
  | **role_ids** | **Array&lt;String&gt;** | Roles assigned to this client. Roles only apply to clients using the client_credential grant | [optional] |
17
+ | **date_created** | **DateTime** | Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
18
+ | **date_modified** | **DateTime** | Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
19
+ | **created_by** | [**UriReference**](UriReference.html) | User that created this client | [optional] |
20
+ | **modified_by** | [**UriReference**](UriReference.html) | User that last modified this client | [optional] |
17
21
  | **self_uri** | **String** | The URI for this object | [optional] |
18
22
  {: class="table table-striped"}
19
23
 
@@ -9,6 +9,10 @@ title: OrgOAuthClient
9
9
  |------------ | ------------- | ------------- | -------------|
10
10
  | **id** | **String** | The globally unique identifier for the object. | [optional] |
11
11
  | **name** | **String** | The name of the OAuth client. | |
12
+ | **date_created** | **DateTime** | Date this client was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
13
+ | **date_modified** | **DateTime** | Date this client was last modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
14
+ | **created_by** | [**UriReference**](UriReference.html) | User that created this client | [optional] |
15
+ | **modified_by** | [**UriReference**](UriReference.html) | User that last modified this client | [optional] |
12
16
  | **authorized_grant_type** | **String** | The OAuth Grant/Client type supported by this client. Code Authorization Grant/Client type - Preferred client type where the Client ID and Secret are required to create tokens. Used where the secret can be secured. Implicit grant type - Client ID only is required to create tokens. Used in browser and mobile apps where the secret can not be secured. SAML2-Bearer extension grant type - SAML2 assertion provider for user authentication at the token endpoint. Client Credential grant type - Used to created access tokens that are tied only to the client. | |
13
17
  | **organization** | [**Entity**](Entity.html) | The oauth client&#39;s organization. | [optional] |
14
18
  {: class="table table-striped"}
data/docs/OutOfOffice.md CHANGED
@@ -13,6 +13,7 @@ title: OutOfOffice
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
15
  | **active** | **BOOLEAN** | | [optional] |
16
+ | **indefinite** | **BOOLEAN** | | [optional] |
16
17
  | **self_uri** | **String** | The URI for this object | [optional] |
17
18
  {: class="table table-striped"}
18
19
 
data/docs/UsersApi.md CHANGED
@@ -2299,7 +2299,7 @@ api_instance = PureCloud::UsersApi.new
2299
2299
 
2300
2300
  user_id = "user_id_example" # String | User ID
2301
2301
 
2302
- body = PureCloud::OutOfOffice.new # OutOfOffice | The updated UserPresence
2302
+ body = PureCloud::OutOfOffice.new # OutOfOffice | The updated OutOffOffice
2303
2303
 
2304
2304
 
2305
2305
  begin
@@ -2316,7 +2316,7 @@ end
2316
2316
  Name | Type | Description | Notes
2317
2317
  ------------- | ------------- | ------------- | -------------
2318
2318
  **user_id** | **String**| User ID | |
2319
- **body** | [**OutOfOffice**](OutOfOffice.html)| The updated UserPresence | |
2319
+ **body** | [**OutOfOffice**](OutOfOffice.html)| The updated OutOffOffice | |
2320
2320
  {: class="table table-striped"}
2321
2321
 
2322
2322
 
data/docs/VoicemailApi.md CHANGED
@@ -8,7 +8,7 @@ All URIs are relative to *https://api.mypurecloud.com*
8
8
 
9
9
  Method | Description
10
10
  ------------- | ------------- | -------------
11
- [**delete_voicemail_message**](VoicemailApi.html#delete_voicemail_message) | Delete a message.
11
+ [**delete_voicemail_message**](VoicemailApi.html#delete_voicemail_message) | Delete a voicemail message.
12
12
  [**delete_voicemail_messages**](VoicemailApi.html#delete_voicemail_messages) | Delete all voicemail messages
13
13
  [**get_voicemail_group_mailbox**](VoicemailApi.html#get_voicemail_group_mailbox) | Get the group&#39;s mailbox information
14
14
  [**get_voicemail_group_messages**](VoicemailApi.html#get_voicemail_group_messages) | List voicemail messages
@@ -17,18 +17,19 @@ Method | Description
17
17
  [**get_voicemail_me_mailbox**](VoicemailApi.html#get_voicemail_me_mailbox) | Get the current user&#39;s mailbox information
18
18
  [**get_voicemail_me_messages**](VoicemailApi.html#get_voicemail_me_messages) | List voicemail messages
19
19
  [**get_voicemail_me_policy**](VoicemailApi.html#get_voicemail_me_policy) | Get the current user&#39;s voicemail policy
20
- [**get_voicemail_message**](VoicemailApi.html#get_voicemail_message) | Get message.
21
- [**get_voicemail_message_media**](VoicemailApi.html#get_voicemail_message_media) | Get media playback URI for this message
20
+ [**get_voicemail_message**](VoicemailApi.html#get_voicemail_message) | Get a voicemail message
21
+ [**get_voicemail_message_media**](VoicemailApi.html#get_voicemail_message_media) | Get media playback URI for this voicemail message
22
22
  [**get_voicemail_messages**](VoicemailApi.html#get_voicemail_messages) | List voicemail messages
23
23
  [**get_voicemail_policy**](VoicemailApi.html#get_voicemail_policy) | Get a policy
24
24
  [**get_voicemail_search**](VoicemailApi.html#get_voicemail_search) | Search voicemails using the q64 value returned from a previous search
25
25
  [**get_voicemail_userpolicy**](VoicemailApi.html#get_voicemail_userpolicy) | Get a user&#39;s voicemail policy
26
26
  [**patch_voicemail_group_policy**](VoicemailApi.html#patch_voicemail_group_policy) | Update a group&#39;s voicemail policy
27
27
  [**patch_voicemail_me_policy**](VoicemailApi.html#patch_voicemail_me_policy) | Update the current user&#39;s voicemail policy
28
+ [**patch_voicemail_message**](VoicemailApi.html#patch_voicemail_message) | Update a voicemail message
28
29
  [**patch_voicemail_userpolicy**](VoicemailApi.html#patch_voicemail_userpolicy) | Update a user&#39;s voicemail policy
29
30
  [**post_voicemail_messages**](VoicemailApi.html#post_voicemail_messages) | Copy a voicemail message to a user or group
30
31
  [**post_voicemail_search**](VoicemailApi.html#post_voicemail_search) | Search voicemails
31
- [**put_voicemail_message**](VoicemailApi.html#put_voicemail_message) | Update a message.
32
+ [**put_voicemail_message**](VoicemailApi.html#put_voicemail_message) | Update a voicemail message
32
33
  [**put_voicemail_policy**](VoicemailApi.html#put_voicemail_policy) | Update a policy
33
34
  {: class="table table-striped"}
34
35
 
@@ -36,9 +37,9 @@ Method | Description
36
37
 
37
38
  ## - delete_voicemail_message(message_id)
38
39
 
39
- Delete a message.
40
-
40
+ Delete a voicemail message.
41
41
 
42
+ A user voicemail can only be deleted by its associated user. A group voicemail can only be deleted by a user that is a member of the group. A queue voicemail can only be deleted by a user with the acd voicemail delete permission.
42
43
 
43
44
  Wraps DELETE /api/v2/voicemail/messages/{messageId}
44
45
 
@@ -64,7 +65,7 @@ message_id = "message_id_example" # String | Message ID
64
65
 
65
66
 
66
67
  begin
67
- #Delete a message.
68
+ #Delete a voicemail message.
68
69
  api_instance.delete_voicemail_message(message_id)
69
70
  rescue PureCloud::ApiError => e
70
71
  puts "Exception when calling VoicemailApi->delete_voicemail_message: #{e}"
@@ -550,7 +551,7 @@ This endpoint does not need any parameter.
550
551
 
551
552
  ## -[**VoicemailMessage**](VoicemailMessage.html) get_voicemail_message(message_id, opts)
552
553
 
553
- Get message.
554
+ Get a voicemail message
554
555
 
555
556
 
556
557
 
@@ -581,7 +582,7 @@ opts = {
581
582
  }
582
583
 
583
584
  begin
584
- #Get message.
585
+ #Get a voicemail message
585
586
  result = api_instance.get_voicemail_message(message_id, opts)
586
587
  p result
587
588
  rescue PureCloud::ApiError => e
@@ -613,7 +614,7 @@ Name | Type | Description | Notes
613
614
 
614
615
  ## -[**VoicemailMediaInfo**](VoicemailMediaInfo.html) get_voicemail_message_media(message_id, opts)
615
616
 
616
- Get media playback URI for this message
617
+ Get media playback URI for this voicemail message
617
618
 
618
619
 
619
620
 
@@ -644,7 +645,7 @@ opts = {
644
645
  }
645
646
 
646
647
  begin
647
- #Get media playback URI for this message
648
+ #Get media playback URI for this voicemail message
648
649
  result = api_instance.get_voicemail_message_media(message_id, opts)
649
650
  p result
650
651
  rescue PureCloud::ApiError => e
@@ -1030,6 +1031,68 @@ Name | Type | Description | Notes
1030
1031
 
1031
1032
 
1032
1033
 
1034
+ <a name="patch_voicemail_message"></a>
1035
+
1036
+ ## -[**VoicemailMessage**](VoicemailMessage.html) patch_voicemail_message(message_id, body)
1037
+
1038
+ Update a voicemail message
1039
+
1040
+ A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.
1041
+
1042
+ Wraps PATCH /api/v2/voicemail/messages/{messageId}
1043
+
1044
+
1045
+ ### Example
1046
+ ~~~ruby
1047
+ # load the gem
1048
+ require 'purecloudplatformclientv2'
1049
+ # setup authorization
1050
+ @secret = ENV['PURECLOUD_SECRET']
1051
+ @id = ENV['PURECLOUD_CLIENT_ID']
1052
+ environment = "mypurecloud.com"
1053
+
1054
+ @authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
1055
+
1056
+ PureCloud.configure do |config|
1057
+ config.access_token = @authToken
1058
+ end
1059
+
1060
+ api_instance = PureCloud::VoicemailApi.new
1061
+
1062
+ message_id = "message_id_example" # String | Message ID
1063
+
1064
+ body = PureCloud::VoicemailMessage.new # VoicemailMessage | VoicemailMessage
1065
+
1066
+
1067
+ begin
1068
+ #Update a voicemail message
1069
+ result = api_instance.patch_voicemail_message(message_id, body)
1070
+ p result
1071
+ rescue PureCloud::ApiError => e
1072
+ puts "Exception when calling VoicemailApi->patch_voicemail_message: #{e}"
1073
+ end
1074
+ ~~~
1075
+
1076
+ ### Parameters
1077
+
1078
+ Name | Type | Description | Notes
1079
+ ------------- | ------------- | ------------- | -------------
1080
+ **message_id** | **String**| Message ID | |
1081
+ **body** | [**VoicemailMessage**](VoicemailMessage.html)| VoicemailMessage | |
1082
+ {: class="table table-striped"}
1083
+
1084
+
1085
+ ### Return type
1086
+
1087
+ [**VoicemailMessage**](VoicemailMessage.html)
1088
+
1089
+ ### HTTP request headers
1090
+
1091
+ - **Content-Type**: application/json
1092
+ - **Accept**: application/json
1093
+
1094
+
1095
+
1033
1096
  <a name="patch_voicemail_userpolicy"></a>
1034
1097
 
1035
1098
  ## -[**VoicemailUserPolicy**](VoicemailUserPolicy.html) patch_voicemail_userpolicy(user_id, body)
@@ -1215,9 +1278,9 @@ Name | Type | Description | Notes
1215
1278
 
1216
1279
  ## -[**VoicemailMessage**](VoicemailMessage.html) put_voicemail_message(message_id, body)
1217
1280
 
1218
- Update a message.
1219
-
1281
+ Update a voicemail message
1220
1282
 
1283
+ A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.
1221
1284
 
1222
1285
  Wraps PUT /api/v2/voicemail/messages/{messageId}
1223
1286
 
@@ -1245,7 +1308,7 @@ body = PureCloud::VoicemailMessage.new # VoicemailMessage | VoicemailMessage
1245
1308
 
1246
1309
 
1247
1310
  begin
1248
- #Update a message.
1311
+ #Update a voicemail message
1249
1312
  result = api_instance.put_voicemail_message(message_id, body)
1250
1313
  p result
1251
1314
  rescue PureCloud::ApiError => e