Skip to content

Commit dc6ea30

Browse files
author
InIn Devops
committed
6.1.4
1 parent aa36366 commit dc6ea30

84 files changed

Lines changed: 959 additions & 958 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: 10 additions & 10 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.1.3` with the version you want to use. -->
29-
<script src="https://sdk-cdn.mypurecloud.com/javascript/6.1.3/purecloud-platform-client-v2.min.js"></script>
28+
<!-- Replace `6.1.4` with the version you want to use. -->
29+
<script src="https://sdk-cdn.mypurecloud.com/javascript/6.1.4/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/).
@@ -50,7 +50,7 @@ Reference the SDK in your HTML document. For convenience, all modules are bundle
5050
Require the SDK in your node app. All modules are obtained from the `purecloud-platform-client-v2` package.
5151

5252
~~~ javascript
53-
const platformClient = require('purecloud-platform-client-v2');
53+
const platformClient = require('platformClient');
5454
~~~
5555

5656

@@ -63,7 +63,7 @@ After authentication has completed, the access token is stored on the `ApiClient
6363
The Client Credentials grant only works when used in node.js. This is restricted intentionally because it is impossible for client credentials to be handled securely in a browser application.
6464

6565
~~~ javascript
66-
const platformClient = require('purecloud-platform-client-v2');
66+
const platformClient = require('platformClient');
6767
var client = platformClient.ApiClient.instance;
6868
client.loginClientCredentialsGrant(clientId, clientSecret)
6969
.then(function() {
@@ -80,7 +80,7 @@ client.loginClientCredentialsGrant(clientId, clientSecret)
8080
The Implicit grant only works when used in a browser. This is because a node.js application does not have a browser interface that can display the PureCloud login window.
8181

8282
~~~ javascript
83-
const platformClient = require('purecloud-platform-client-v2');
83+
const platformClient = require('platformClient');
8484
var client = platformClient.ApiClient.instance;
8585
client.loginImplicitGrant(clientId, redirectUri)
8686
.then(function() {
@@ -95,7 +95,7 @@ client.loginImplicitGrant(clientId, redirectUri)
9595
**Any platform** Provide an existing auth token
9696

9797
~~~ javascript
98-
const platformClient = require('purecloud-platform-client-v2');
98+
const platformClient = require('platformClient');
9999
var client = platformClient.ApiClient.instance;
100100
client.setAccessToken(yourAccessToken);
101101
// Do authenticated things; no login function needed
@@ -107,7 +107,7 @@ client.setAccessToken(yourAccessToken);
107107
If connecting to a PureCloud environment other than mypurecloud.com (e.g. mypurecloud.ie), set the environment on the `ApiClient` instance.
108108

109109
~~~ js
110-
const platformClient = require('purecloud-platform-client-v2');
110+
const platformClient = require('platformClient');
111111
var client = platformClient.ApiClient.instance;
112112
client.setEnvironment('mypurecloud.ie');
113113
~~~
@@ -118,7 +118,7 @@ client.setEnvironment('mypurecloud.ie');
118118
In a web environment, it is possible to persist the access token to prevent an authentication request from being made on each page load. To enable this function, simply enable settings persistence prior to attempting a login. To maintain multiple auth tokens in storage, specify the prefix to use for storage/retrieval when enabling persistence. Otherwise, the prefix is optional and will default to `purecloud`.
119119

120120
~~~ js
121-
const platformClient = require('purecloud-platform-client-v2');
121+
const platformClient = require('platformClient');
122122
var client = purecloud-platform-client-v2.ApiClient.instance;
123123
client.setPersistSettings(true, 'optional_prefix');
124124
~~~
@@ -180,7 +180,7 @@ client.loginImplicitGrant(clientId, redirectUri)
180180
By default, the SDK will return only the response body as the result of an API function call. To retrieve additional information about the response, enable extended responses. This will return the extended response for all API function calls:
181181

182182
~~~ js
183-
const platformClient = require('purecloud-platform-client-v2');
183+
const platformClient = require('platformClient');
184184
var client = purecloud-platform-client-v2.ApiClient.instance;
185185
client.setReturnExtendedResponses(true);
186186
~~~
@@ -249,7 +249,7 @@ Example error response object:
249249
There are hooks to trace requests and responses. To enable debug tracing, provide a log object. Optionally, specify a maximum number of lines. If specified, the response body trace will be truncated. If not specified, the entire response body will be traced out.
250250

251251
~~~ js
252-
const platformClient = require('purecloud-platform-client-v2');
252+
const platformClient = require('platformClient');
253253
var client = purecloud-platform-client-v2.ApiClient.instance;
254254
client.setDebugLog(console.log, 25);
255255
~~~

‎build/README.md‎

Lines changed: 10 additions & 10 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.1.3` with the version you want to use. -->
29-
<script src="https://sdk-cdn.mypurecloud.com/javascript/6.1.3/purecloud-platform-client-v2.min.js"></script>
28+
<!-- Replace `6.1.4` with the version you want to use. -->
29+
<script src="https://sdk-cdn.mypurecloud.com/javascript/6.1.4/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/).
@@ -50,7 +50,7 @@ Reference the SDK in your HTML document. For convenience, all modules are bundle
5050
Require the SDK in your node app. All modules are obtained from the `purecloud-platform-client-v2` package.
5151

5252
~~~ javascript
53-
const platformClient = require('purecloud-platform-client-v2');
53+
const platformClient = require('platformClient');
5454
~~~
5555

5656

@@ -63,7 +63,7 @@ After authentication has completed, the access token is stored on the `ApiClient
6363
The Client Credentials grant only works when used in node.js. This is restricted intentionally because it is impossible for client credentials to be handled securely in a browser application.
6464

6565
~~~ javascript
66-
const platformClient = require('purecloud-platform-client-v2');
66+
const platformClient = require('platformClient');
6767
var client = platformClient.ApiClient.instance;
6868
client.loginClientCredentialsGrant(clientId, clientSecret)
6969
.then(function() {
@@ -80,7 +80,7 @@ client.loginClientCredentialsGrant(clientId, clientSecret)
8080
The Implicit grant only works when used in a browser. This is because a node.js application does not have a browser interface that can display the PureCloud login window.
8181

8282
~~~ javascript
83-
const platformClient = require('purecloud-platform-client-v2');
83+
const platformClient = require('platformClient');
8484
var client = platformClient.ApiClient.instance;
8585
client.loginImplicitGrant(clientId, redirectUri)
8686
.then(function() {
@@ -95,7 +95,7 @@ client.loginImplicitGrant(clientId, redirectUri)
9595
**Any platform** Provide an existing auth token
9696

9797
~~~ javascript
98-
const platformClient = require('purecloud-platform-client-v2');
98+
const platformClient = require('platformClient');
9999
var client = platformClient.ApiClient.instance;
100100
client.setAccessToken(yourAccessToken);
101101
// Do authenticated things; no login function needed
@@ -107,7 +107,7 @@ client.setAccessToken(yourAccessToken);
107107
If connecting to a PureCloud environment other than mypurecloud.com (e.g. mypurecloud.ie), set the environment on the `ApiClient` instance.
108108

109109
~~~ js
110-
const platformClient = require('purecloud-platform-client-v2');
110+
const platformClient = require('platformClient');
111111
var client = platformClient.ApiClient.instance;
112112
client.setEnvironment('mypurecloud.ie');
113113
~~~
@@ -118,7 +118,7 @@ client.setEnvironment('mypurecloud.ie');
118118
In a web environment, it is possible to persist the access token to prevent an authentication request from being made on each page load. To enable this function, simply enable settings persistence prior to attempting a login. To maintain multiple auth tokens in storage, specify the prefix to use for storage/retrieval when enabling persistence. Otherwise, the prefix is optional and will default to `purecloud`.
119119

120120
~~~ js
121-
const platformClient = require('purecloud-platform-client-v2');
121+
const platformClient = require('platformClient');
122122
var client = purecloud-platform-client-v2.ApiClient.instance;
123123
client.setPersistSettings(true, 'optional_prefix');
124124
~~~
@@ -180,7 +180,7 @@ client.loginImplicitGrant(clientId, redirectUri)
180180
By default, the SDK will return only the response body as the result of an API function call. To retrieve additional information about the response, enable extended responses. This will return the extended response for all API function calls:
181181

182182
~~~ js
183-
const platformClient = require('purecloud-platform-client-v2');
183+
const platformClient = require('platformClient');
184184
var client = purecloud-platform-client-v2.ApiClient.instance;
185185
client.setReturnExtendedResponses(true);
186186
~~~
@@ -249,7 +249,7 @@ Example error response object:
249249
There are hooks to trace requests and responses. To enable debug tracing, provide a log object. Optionally, specify a maximum number of lines. If specified, the response body trace will be truncated. If not specified, the entire response body will be traced out.
250250

251251
~~~ js
252-
const platformClient = require('purecloud-platform-client-v2');
252+
const platformClient = require('platformClient');
253253
var client = purecloud-platform-client-v2.ApiClient.instance;
254254
client.setDebugLog(console.log, 25);
255255
~~~

‎build/docs/AlertingApi.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Delete an interaction stats alert
3232
### Example
3333

3434
~~~ javascript
35-
const platformClient = require('purecloud-platform-client-v2');
35+
const platformClient = require('platformClient');
3636

3737
// Configure OAuth2 access token for authorization: PureCloud Auth
3838
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
@@ -77,7 +77,7 @@ Delete an interaction stats rule.
7777
### Example
7878

7979
~~~ javascript
80-
const platformClient = require('purecloud-platform-client-v2');
80+
const platformClient = require('platformClient');
8181

8282
// Configure OAuth2 access token for authorization: PureCloud Auth
8383
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
@@ -122,7 +122,7 @@ Get an interaction stats alert
122122
### Example
123123

124124
~~~ javascript
125-
const platformClient = require('purecloud-platform-client-v2');
125+
const platformClient = require('platformClient');
126126

127127
// Configure OAuth2 access token for authorization: PureCloud Auth
128128
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
@@ -171,7 +171,7 @@ Get interaction stats alert list.
171171
### Example
172172

173173
~~~ javascript
174-
const platformClient = require('purecloud-platform-client-v2');
174+
const platformClient = require('platformClient');
175175

176176
// Configure OAuth2 access token for authorization: PureCloud Auth
177177
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
@@ -217,7 +217,7 @@ Gets user unread count of interaction stats alerts.
217217
### Example
218218

219219
~~~ javascript
220-
const platformClient = require('purecloud-platform-client-v2');
220+
const platformClient = require('platformClient');
221221

222222
// Configure OAuth2 access token for authorization: PureCloud Auth
223223
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
@@ -256,7 +256,7 @@ Get an interaction stats rule.
256256
### Example
257257

258258
~~~ javascript
259-
const platformClient = require('purecloud-platform-client-v2');
259+
const platformClient = require('platformClient');
260260

261261
// Configure OAuth2 access token for authorization: PureCloud Auth
262262
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
@@ -305,7 +305,7 @@ Get an interaction stats rule list.
305305
### Example
306306

307307
~~~ javascript
308-
const platformClient = require('purecloud-platform-client-v2');
308+
const platformClient = require('platformClient');
309309

310310
// Configure OAuth2 access token for authorization: PureCloud Auth
311311
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
@@ -351,7 +351,7 @@ Create an interaction stats rule.
351351
### Example
352352

353353
~~~ javascript
354-
const platformClient = require('purecloud-platform-client-v2');
354+
const platformClient = require('platformClient');
355355

356356
// Configure OAuth2 access token for authorization: PureCloud Auth
357357
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
@@ -400,7 +400,7 @@ Update an interaction stats alert read status
400400
### Example
401401

402402
~~~ javascript
403-
const platformClient = require('purecloud-platform-client-v2');
403+
const platformClient = require('platformClient');
404404

405405
// Configure OAuth2 access token for authorization: PureCloud Auth
406406
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
@@ -452,7 +452,7 @@ Update an interaction stats rule
452452
### Example
453453

454454
~~~ javascript
455-
const platformClient = require('purecloud-platform-client-v2');
455+
const platformClient = require('platformClient');
456456

457457
// Configure OAuth2 access token for authorization: PureCloud Auth
458458
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';

0 commit comments

Comments
 (0)