Skip to content

Commit a1f5360

Browse files
author
InIn Devops
committed
6.1.0
1 parent 460f2a8 commit a1f5360

51 files changed

Lines changed: 515 additions & 125 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ npm install purecloud-platform-client-v2
2525
Reference from the CDN:
2626

2727
~~~ html
28-
<!-- Replace `6.0.1` with the version you want to use. -->
29-
<script src="https://sdk-cdn.mypurecloud.com/javascript/6.0.1/purecloud-platform-client-v2.min.js"></script>
28+
<!-- Replace `6.1.0` with the version you want to use. -->
29+
<script src="https://sdk-cdn.mypurecloud.com/javascript/6.1.0/purecloud-platform-client-v2.min.js"></script>
3030
~~~
3131

3232
View the documentation on the [PureCloud Developer Center](https://developer.mypurecloud.com/api/rest/client-libraries/javascript/).

‎build/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ npm install purecloud-platform-client-v2
2525
Reference from the CDN:
2626

2727
~~~ html
28-
<!-- Replace `6.0.1` with the version you want to use. -->
29-
<script src="https://sdk-cdn.mypurecloud.com/javascript/6.0.1/purecloud-platform-client-v2.min.js"></script>
28+
<!-- Replace `6.1.0` with the version you want to use. -->
29+
<script src="https://sdk-cdn.mypurecloud.com/javascript/6.1.0/purecloud-platform-client-v2.min.js"></script>
3030
~~~
3131

3232
View the documentation on the [PureCloud Developer Center](https://developer.mypurecloud.com/api/rest/client-libraries/javascript/).

‎build/docs/LicenseApi.md‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,10 @@ All URIs are relative to *https://api.mypurecloud.com*
1010
[**getLicenseDefinition**](LicenseApi.html#getLicenseDefinition) | **GET** /api/v2/license/definitions/{licenseId} | Get PureCloud license definition.
1111
[**getLicenseDefinitions**](LicenseApi.html#getLicenseDefinitions) | **GET** /api/v2/license/definitions | Get all PureCloud license definitions available for the organization.
1212
[**getLicenseOrganization**](LicenseApi.html#getLicenseOrganization) | **GET** /api/v2/license/organization | Get license assignments for the organization.
13+
[**getLicenseToggle**](LicenseApi.html#getLicenseToggle) | **GET** /api/v2/license/toggles/{featureName} | Get PureCloud license feature toggle value.
1314
[**getLicenseUser**](LicenseApi.html#getLicenseUser) | **GET** /api/v2/license/users/{userId} | Get licenses for specified user.
1415
[**postLicenseOrganization**](LicenseApi.html#postLicenseOrganization) | **POST** /api/v2/license/organization | Update the organization&#39;s license assignments in a batch.
16+
[**postLicenseToggle**](LicenseApi.html#postLicenseToggle) | **POST** /api/v2/license/toggles/{featureName} | Switch PureCloud license feature toggle value.
1517
[**postLicenseUsers**](LicenseApi.html#postLicenseUsers) | **POST** /api/v2/license/users | Fetch user licenses in a batch.
1618
{: class="table table-striped"}
1719

@@ -138,6 +140,51 @@ This endpoint does not need any parameter.
138140

139141
[**LicenseOrganization**](LicenseOrganization.html)
140142

143+
<a name="getLicenseToggle"></a>
144+
145+
# [**LicenseOrgToggle**](LicenseOrgToggle.html) getLicenseToggle(featureName)
146+
147+
GET /api/v2/license/toggles/{featureName}
148+
149+
Get PureCloud license feature toggle value.
150+
151+
152+
153+
### Example
154+
155+
~~~ javascript
156+
const platformClient = require('purecloud-platform-client-v2');
157+
158+
// Configure OAuth2 access token for authorization: PureCloud Auth
159+
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
160+
161+
var apiInstance = new platformClient.LicenseApi();
162+
163+
var featureName = "featureName_example"; // String | featureName
164+
165+
apiInstance.getLicenseToggle(featureName)
166+
.then(function(data) {
167+
console.log(`getLicenseToggle success! data: ${JSON.stringify(data, null, 2)}`);
168+
})
169+
.catch(function(error) {
170+
console.log('There was a failure calling getLicenseToggle');
171+
console.error(error);
172+
});
173+
174+
~~~
175+
176+
### Parameters
177+
178+
179+
| Name | Type | Description | Notes |
180+
| ------------- | ------------- | ------------- | ------------- |
181+
**featureName** | **String**| featureName | |
182+
{: class="table table-striped"}
183+
184+
### Return type
185+
186+
[**LicenseOrgToggle**](LicenseOrgToggle.html)
187+
141188
<a name="getLicenseUser"></a>
142189

143190
# [**LicenseUser**](LicenseUser.html) getLicenseUser(userId)
@@ -229,6 +276,51 @@ apiInstance.postLicenseOrganization(opts)
229276

230277
[**[LicenseUpdateStatus]**](LicenseUpdateStatus.html)
231278

279+
<a name="postLicenseToggle"></a>
280+
281+
# [**LicenseOrgToggle**](LicenseOrgToggle.html) postLicenseToggle(featureName)
282+
283+
POST /api/v2/license/toggles/{featureName}
284+
285+
Switch PureCloud license feature toggle value.
286+
287+
288+
289+
### Example
290+
291+
~~~ javascript
292+
const platformClient = require('purecloud-platform-client-v2');
293+
294+
// Configure OAuth2 access token for authorization: PureCloud Auth
295+
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
296+
297+
var apiInstance = new platformClient.LicenseApi();
298+
299+
var featureName = "featureName_example"; // String | featureName
300+
301+
apiInstance.postLicenseToggle(featureName)
302+
.then(function(data) {
303+
console.log(`postLicenseToggle success! data: ${JSON.stringify(data, null, 2)}`);
304+
})
305+
.catch(function(error) {
306+
console.log('There was a failure calling postLicenseToggle');
307+
console.error(error);
308+
});
309+
310+
~~~
311+
312+
### Parameters
313+
314+
315+
| Name | Type | Description | Notes |
316+
| ------------- | ------------- | ------------- | ------------- |
317+
**featureName** | **String**| featureName | |
318+
{: class="table table-striped"}
319+
320+
### Return type
321+
322+
[**LicenseOrgToggle**](LicenseOrgToggle.html)
323+
232324
<a name="postLicenseUsers"></a>
233325

234326
# **{&#39;String&#39;: Object}** postLicenseUsers(opts)

‎build/docs/UsersApi.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1791,7 +1791,7 @@ var apiInstance = new platformClient.UsersApi();
17911791

17921792
var userId = "userId_example"; // String | User ID
17931793

1794-
var body = new platformClient.OutOfOffice(); // OutOfOffice | The updated UserPresence
1794+
var body = new platformClient.OutOfOffice(); // OutOfOffice | The updated OutOffOffice
17951795

17961796
apiInstance.putUserOutofoffice(userId, body)
17971797
.then(function(data) {
@@ -1810,7 +1810,7 @@ apiInstance.putUserOutofoffice(userId, body)
18101810
| Name | Type | Description | Notes |
18111811
| ------------- | ------------- | ------------- | ------------- |
18121812
**userId** | **String**| User ID | |
1813-
**body** | [**OutOfOffice**](OutOfOffice.html)| The updated UserPresence | |
1813+
**body** | [**OutOfOffice**](OutOfOffice.html)| The updated OutOffOffice | |
18141814
{: class="table table-striped"}
18151815

18161816
### Return type

‎build/docs/VoicemailApi.md‎

Lines changed: 59 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ All URIs are relative to *https://api.mypurecloud.com*
77

88
| Method | HTTP request | Description |
99
| ------------- | ------------- | ------------- |
10-
[**deleteVoicemailMessage**](VoicemailApi.html#deleteVoicemailMessage) | **DELETE** /api/v2/voicemail/messages/{messageId} | Delete a message.
10+
[**deleteVoicemailMessage**](VoicemailApi.html#deleteVoicemailMessage) | **DELETE** /api/v2/voicemail/messages/{messageId} | Delete a voicemail message.
1111
[**deleteVoicemailMessages**](VoicemailApi.html#deleteVoicemailMessages) | **DELETE** /api/v2/voicemail/messages | Delete all voicemail messages
1212
[**getVoicemailGroupMailbox**](VoicemailApi.html#getVoicemailGroupMailbox) | **GET** /api/v2/voicemail/groups/{groupId}/mailbox | Get the group&#39;s mailbox information
1313
[**getVoicemailGroupMessages**](VoicemailApi.html#getVoicemailGroupMessages) | **GET** /api/v2/voicemail/groups/{groupId}/messages | List voicemail messages
@@ -16,18 +16,19 @@ All URIs are relative to *https://api.mypurecloud.com*
1616
[**getVoicemailMeMailbox**](VoicemailApi.html#getVoicemailMeMailbox) | **GET** /api/v2/voicemail/me/mailbox | Get the current user&#39;s mailbox information
1717
[**getVoicemailMeMessages**](VoicemailApi.html#getVoicemailMeMessages) | **GET** /api/v2/voicemail/me/messages | List voicemail messages
1818
[**getVoicemailMePolicy**](VoicemailApi.html#getVoicemailMePolicy) | **GET** /api/v2/voicemail/me/policy | Get the current user&#39;s voicemail policy
19-
[**getVoicemailMessage**](VoicemailApi.html#getVoicemailMessage) | **GET** /api/v2/voicemail/messages/{messageId} | Get message.
20-
[**getVoicemailMessageMedia**](VoicemailApi.html#getVoicemailMessageMedia) | **GET** /api/v2/voicemail/messages/{messageId}/media | Get media playback URI for this message
19+
[**getVoicemailMessage**](VoicemailApi.html#getVoicemailMessage) | **GET** /api/v2/voicemail/messages/{messageId} | Get a voicemail message
20+
[**getVoicemailMessageMedia**](VoicemailApi.html#getVoicemailMessageMedia) | **GET** /api/v2/voicemail/messages/{messageId}/media | Get media playback URI for this voicemail message
2121
[**getVoicemailMessages**](VoicemailApi.html#getVoicemailMessages) | **GET** /api/v2/voicemail/messages | List voicemail messages
2222
[**getVoicemailPolicy**](VoicemailApi.html#getVoicemailPolicy) | **GET** /api/v2/voicemail/policy | Get a policy
2323
[**getVoicemailSearch**](VoicemailApi.html#getVoicemailSearch) | **GET** /api/v2/voicemail/search | Search voicemails using the q64 value returned from a previous search
2424
[**getVoicemailUserpolicy**](VoicemailApi.html#getVoicemailUserpolicy) | **GET** /api/v2/voicemail/userpolicies/{userId} | Get a user&#39;s voicemail policy
2525
[**patchVoicemailGroupPolicy**](VoicemailApi.html#patchVoicemailGroupPolicy) | **PATCH** /api/v2/voicemail/groups/{groupId}/policy | Update a group&#39;s voicemail policy
2626
[**patchVoicemailMePolicy**](VoicemailApi.html#patchVoicemailMePolicy) | **PATCH** /api/v2/voicemail/me/policy | Update the current user&#39;s voicemail policy
27+
[**patchVoicemailMessage**](VoicemailApi.html#patchVoicemailMessage) | **PATCH** /api/v2/voicemail/messages/{messageId} | Update a voicemail message
2728
[**patchVoicemailUserpolicy**](VoicemailApi.html#patchVoicemailUserpolicy) | **PATCH** /api/v2/voicemail/userpolicies/{userId} | Update a user&#39;s voicemail policy
2829
[**postVoicemailMessages**](VoicemailApi.html#postVoicemailMessages) | **POST** /api/v2/voicemail/messages | Copy a voicemail message to a user or group
2930
[**postVoicemailSearch**](VoicemailApi.html#postVoicemailSearch) | **POST** /api/v2/voicemail/search | Search voicemails
30-
[**putVoicemailMessage**](VoicemailApi.html#putVoicemailMessage) | **PUT** /api/v2/voicemail/messages/{messageId} | Update a message.
31+
[**putVoicemailMessage**](VoicemailApi.html#putVoicemailMessage) | **PUT** /api/v2/voicemail/messages/{messageId} | Update a voicemail message
3132
[**putVoicemailPolicy**](VoicemailApi.html#putVoicemailPolicy) | **PUT** /api/v2/voicemail/policy | Update a policy
3233
{: class="table table-striped"}
3334

@@ -37,9 +38,9 @@ All URIs are relative to *https://api.mypurecloud.com*
3738

3839
DELETE /api/v2/voicemail/messages/{messageId}
3940

40-
Delete a message.
41-
41+
Delete a voicemail message.
4242

43+
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.
4344

4445
### Example
4546

@@ -427,7 +428,7 @@ This endpoint does not need any parameter.
427428

428429
GET /api/v2/voicemail/messages/{messageId}
429430

430-
Get message.
431+
Get a voicemail message
431432

432433

433434

@@ -476,7 +477,7 @@ apiInstance.getVoicemailMessage(messageId, opts)
476477

477478
GET /api/v2/voicemail/messages/{messageId}/media
478479

479-
Get media playback URI for this message
480+
Get media playback URI for this voicemail message
480481

481482

482483

@@ -793,6 +794,54 @@ apiInstance.patchVoicemailMePolicy(body)
793794

794795
[**VoicemailUserPolicy**](VoicemailUserPolicy.html)
795796

797+
<a name="patchVoicemailMessage"></a>
798+
799+
# [**VoicemailMessage**](VoicemailMessage.html) patchVoicemailMessage(messageId, body)
800+
801+
PATCH /api/v2/voicemail/messages/{messageId}
802+
803+
Update a voicemail message
804+
805+
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.
806+
807+
### Example
808+
809+
~~~ javascript
810+
const platformClient = require('purecloud-platform-client-v2');
811+
812+
// Configure OAuth2 access token for authorization: PureCloud Auth
813+
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
814+
815+
var apiInstance = new platformClient.VoicemailApi();
816+
817+
var messageId = "messageId_example"; // String | Message ID
818+
819+
var body = new platformClient.VoicemailMessage(); // VoicemailMessage | VoicemailMessage
820+
821+
apiInstance.patchVoicemailMessage(messageId, body)
822+
.then(function(data) {
823+
console.log(`patchVoicemailMessage success! data: ${JSON.stringify(data, null, 2)}`);
824+
})
825+
.catch(function(error) {
826+
console.log('There was a failure calling patchVoicemailMessage');
827+
console.error(error);
828+
});
829+
830+
~~~
831+
832+
### Parameters
833+
834+
835+
| Name | Type | Description | Notes |
836+
| ------------- | ------------- | ------------- | ------------- |
837+
**messageId** | **String**| Message ID | |
838+
**body** | [**VoicemailMessage**](VoicemailMessage.html)| VoicemailMessage | |
839+
{: class="table table-striped"}
840+
841+
### Return type
842+
843+
[**VoicemailMessage**](VoicemailMessage.html)
844+
796845
<a name="patchVoicemailUserpolicy"></a>
797846

798847
# [**VoicemailUserPolicy**](VoicemailUserPolicy.html) patchVoicemailUserpolicy(userId, body)
@@ -938,9 +987,9 @@ apiInstance.postVoicemailSearch(body)
938987

939988
PUT /api/v2/voicemail/messages/{messageId}
940989

941-
Update a message.
942-
990+
Update a voicemail message
943991

992+
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.
944993

945994
### Example
946995

‎build/docs/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ npm install purecloud-platform-client-v2
2525
Reference from the CDN:
2626

2727
~~~ html
28-
<!-- Replace `6.0.1` with the version you want to use. -->
29-
<script src="https://sdk-cdn.mypurecloud.com/javascript/6.0.1/purecloud-platform-client-v2.min.js"></script>
28+
<!-- Replace `6.1.0` with the version you want to use. -->
29+
<script src="https://sdk-cdn.mypurecloud.com/javascript/6.1.0/purecloud-platform-client-v2.min.js"></script>
3030
~~~
3131

3232
View the documentation on the [PureCloud Developer Center](https://developer.mypurecloud.com/api/rest/client-libraries/javascript/).

‎build/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "purecloud-platform-client-v2",
3-
"version": "6.0.1",
3+
"version": "6.1.0",
44
"description": "A JavaScript library to interface with the PureCloud Platform API",
55
"license": "MIT",
66
"main": "src/purecloud-platform-client-v2/index.js",

‎build/src/purecloud-platform-client-v2/ApiClient.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
/**
1919
* @module purecloud-platform-client-v2/ApiClient
20-
* @version 6.0.1
20+
* @version 6.1.0
2121
*/
2222

2323
/**
@@ -641,7 +641,7 @@
641641

642642
// set header parameters
643643
request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
644-
request.set({ 'purecloud-sdk': '6.0.1' });
644+
request.set({ 'purecloud-sdk': '6.1.0' });
645645

646646
// set request timeout
647647
request.timeout(this.timeout);

‎build/src/purecloud-platform-client-v2/api/AlertingApi.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
/**
1919
* Alerting service.
2020
* @module purecloud-platform-client-v2/api/AlertingApi
21-
* @version 6.0.1
21+
* @version 6.1.0
2222
*/
2323

2424
/**

‎build/src/purecloud-platform-client-v2/api/AnalyticsApi.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
/**
1919
* Analytics service.
2020
* @module purecloud-platform-client-v2/api/AnalyticsApi
21-
* @version 6.0.1
21+
* @version 6.1.0
2222
*/
2323

2424
/**

0 commit comments

Comments
 (0)