Skip to content

Commit 24ca5c8

Browse files
author
PureCloud Jenkins
committed
26.1.0
1 parent 840cb3c commit 24ca5c8

54 files changed

Lines changed: 705 additions & 327 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: 3 additions & 3 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 `26.0.0` with the version you want to use. -->
29-
<script src="https://sdk-cdn.mypurecloud.com/javascript/26.0.0/purecloud-platform-client-v2.min.js"></script>
28+
<!-- Replace `26.1.0` with the version you want to use. -->
29+
<script src="https://sdk-cdn.mypurecloud.com/javascript/26.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/).
@@ -41,7 +41,7 @@ Reference the SDK in your HTML document. For convenience, all modules are bundle
4141

4242
~~~ html
4343
<!-- Include the full library -->
44-
<script src="https://sdk-cdn.mypurecloud.com/javascript/26.0.0/purecloud-platform-client-v2.min.js"></script>
44+
<script src="https://sdk-cdn.mypurecloud.com/javascript/26.1.0/purecloud-platform-client-v2.min.js"></script>
4545
~~~
4646

4747

‎build/README.md‎

Lines changed: 3 additions & 3 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 `26.0.0` with the version you want to use. -->
29-
<script src="https://sdk-cdn.mypurecloud.com/javascript/26.0.0/purecloud-platform-client-v2.min.js"></script>
28+
<!-- Replace `26.1.0` with the version you want to use. -->
29+
<script src="https://sdk-cdn.mypurecloud.com/javascript/26.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/).
@@ -41,7 +41,7 @@ Reference the SDK in your HTML document. For convenience, all modules are bundle
4141

4242
~~~ html
4343
<!-- Include the full library -->
44-
<script src="https://sdk-cdn.mypurecloud.com/javascript/26.0.0/purecloud-platform-client-v2.min.js"></script>
44+
<script src="https://sdk-cdn.mypurecloud.com/javascript/26.1.0/purecloud-platform-client-v2.min.js"></script>
4545
~~~
4646

4747

‎build/docs/GeneralDataProtectionRegulationApi.md‎

Lines changed: 217 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,217 @@
1+
---
2+
title: GeneralDataProtectionRegulationApi
3+
---
4+
# platformClient.GeneralDataProtectionRegulationApi
5+
6+
All URIs are relative to *https://api.mypurecloud.com*
7+
8+
| Method | HTTP request | Description |
9+
| ------------- | ------------- | ------------- |
10+
[**getGdprRequest**](GeneralDataProtectionRegulationApi.html#getGdprRequest) | **GET** /api/v2/gdpr/requests/{requestId} | Get an existing GDPR request
11+
[**getGdprRequests**](GeneralDataProtectionRegulationApi.html#getGdprRequests) | **GET** /api/v2/gdpr/requests | Get all GDPR requests
12+
[**getGdprSubjects**](GeneralDataProtectionRegulationApi.html#getGdprSubjects) | **GET** /api/v2/gdpr/subjects | Get GDPR subjects
13+
[**postGdprRequests**](GeneralDataProtectionRegulationApi.html#postGdprRequests) | **POST** /api/v2/gdpr/requests | Submit a new GDPR request
14+
{: class="table table-striped"}
15+
16+
<a name="getGdprRequest"></a>
17+
18+
# GDPRRequest getGdprRequest(requestId)
19+
20+
GET /api/v2/gdpr/requests/{requestId}
21+
22+
Get an existing GDPR request
23+
24+
25+
26+
### Example
27+
28+
~~~ javascript
29+
// Browser
30+
const platformClient = require('platformClient');
31+
// Node
32+
const platformClient = require('purecloud-platform-client-v2');
33+
34+
// Configure OAuth2 access token for authorization: PureCloud Auth
35+
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
36+
37+
var apiInstance = new platformClient.GeneralDataProtectionRegulationApi();
38+
39+
var requestId = "requestId_example"; // String | Request id
40+
41+
apiInstance.getGdprRequest(requestId)
42+
.then(function(data) {
43+
console.log(`getGdprRequest success! data: ${JSON.stringify(data, null, 2)}`);
44+
})
45+
.catch(function(err) {
46+
console.log('There was a failure calling getGdprRequest');
47+
console.error(err);
48+
});
49+
50+
~~~
51+
52+
### Parameters
53+
54+
55+
| Name | Type | Description | Notes |
56+
| ------------- | ------------- | ------------- | ------------- |
57+
**requestId** | **String** | Request id | |
58+
{: class="table table-striped"}
59+
60+
### Return type
61+
62+
**GDPRRequest**
63+
64+
<a name="getGdprRequests"></a>
65+
66+
# GDPRRequestEntityListing getGdprRequests(opts)
67+
68+
GET /api/v2/gdpr/requests
69+
70+
Get all GDPR requests
71+
72+
73+
74+
### Example
75+
76+
~~~ javascript
77+
// Browser
78+
const platformClient = require('platformClient');
79+
// Node
80+
const platformClient = require('purecloud-platform-client-v2');
81+
82+
// Configure OAuth2 access token for authorization: PureCloud Auth
83+
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
84+
85+
var apiInstance = new platformClient.GeneralDataProtectionRegulationApi();
86+
87+
var opts = {
88+
'pageSize': 25, // Number | Page size
89+
'pageNumber': 1 // Number | Page number
90+
};
91+
apiInstance.getGdprRequests(opts)
92+
.then(function(data) {
93+
console.log(`getGdprRequests success! data: ${JSON.stringify(data, null, 2)}`);
94+
})
95+
.catch(function(err) {
96+
console.log('There was a failure calling getGdprRequests');
97+
console.error(err);
98+
});
99+
100+
~~~
101+
102+
### Parameters
103+
104+
105+
| Name | Type | Description | Notes |
106+
| ------------- | ------------- | ------------- | ------------- |
107+
**pageSize** | **Number** | Page size | [optional] [default to 25] |
108+
**pageNumber** | **Number** | Page number | [optional] [default to 1] |
109+
{: class="table table-striped"}
110+
111+
### Return type
112+
113+
**GDPRRequestEntityListing**
114+
115+
<a name="getGdprSubjects"></a>
116+
117+
# GDPRSubjectEntityListing getGdprSubjects(searchType, searchValue)
118+
119+
GET /api/v2/gdpr/subjects
120+
121+
Get GDPR subjects
122+
123+
124+
125+
### Example
126+
127+
~~~ javascript
128+
// Browser
129+
const platformClient = require('platformClient');
130+
// Node
131+
const platformClient = require('purecloud-platform-client-v2');
132+
133+
// Configure OAuth2 access token for authorization: PureCloud Auth
134+
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
135+
136+
var apiInstance = new platformClient.GeneralDataProtectionRegulationApi();
137+
138+
var searchType = "searchType_example"; // String | Search Type
139+
140+
var searchValue = "searchValue_example"; // String | Search Value
141+
142+
apiInstance.getGdprSubjects(searchType, searchValue)
143+
.then(function(data) {
144+
console.log(`getGdprSubjects success! data: ${JSON.stringify(data, null, 2)}`);
145+
})
146+
.catch(function(err) {
147+
console.log('There was a failure calling getGdprSubjects');
148+
console.error(err);
149+
});
150+
151+
~~~
152+
153+
### Parameters
154+
155+
156+
| Name | Type | Description | Notes |
157+
| ------------- | ------------- | ------------- | ------------- |
158+
**searchType** | **String** | Search Type | <br />**Values**: NAME, ADDRESS, PHONE, EMAIL |
159+
**searchValue** | **String** | Search Value | |
160+
{: class="table table-striped"}
161+
162+
### Return type
163+
164+
**GDPRSubjectEntityListing**
165+
166+
<a name="postGdprRequests"></a>
167+
168+
# GDPRRequest postGdprRequests(body, opts)
169+
170+
POST /api/v2/gdpr/requests
171+
172+
Submit a new GDPR request
173+
174+
175+
176+
### Example
177+
178+
~~~ javascript
179+
// Browser
180+
const platformClient = require('platformClient');
181+
// Node
182+
const platformClient = require('purecloud-platform-client-v2');
183+
184+
// Configure OAuth2 access token for authorization: PureCloud Auth
185+
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
186+
187+
var apiInstance = new platformClient.GeneralDataProtectionRegulationApi();
188+
189+
var body = {}; // Object | GDPR request
190+
191+
var opts = {
192+
'deleteConfirmed': false // Boolean | Confirm delete
193+
};
194+
apiInstance.postGdprRequests(body, opts)
195+
.then(function(data) {
196+
console.log(`postGdprRequests success! data: ${JSON.stringify(data, null, 2)}`);
197+
})
198+
.catch(function(err) {
199+
console.log('There was a failure calling postGdprRequests');
200+
console.error(err);
201+
});
202+
203+
~~~
204+
205+
### Parameters
206+
207+
208+
| Name | Type | Description | Notes |
209+
| ------------- | ------------- | ------------- | ------------- |
210+
**body** | **Object** | GDPR request | |
211+
**deleteConfirmed** | **Boolean** | Confirm delete | [optional] [default to false] |
212+
{: class="table table-striped"}
213+
214+
### Return type
215+
216+
**GDPRRequest**
217+

‎build/docs/index.md‎

Lines changed: 3 additions & 3 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 `26.0.0` with the version you want to use. -->
29-
<script src="https://sdk-cdn.mypurecloud.com/javascript/26.0.0/purecloud-platform-client-v2.min.js"></script>
28+
<!-- Replace `26.1.0` with the version you want to use. -->
29+
<script src="https://sdk-cdn.mypurecloud.com/javascript/26.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/).
@@ -41,7 +41,7 @@ Reference the SDK in your HTML document. For convenience, all modules are bundle
4141

4242
~~~ html
4343
<!-- Include the full library -->
44-
<script src="https://sdk-cdn.mypurecloud.com/javascript/26.0.0/purecloud-platform-client-v2.min.js"></script>
44+
<script src="https://sdk-cdn.mypurecloud.com/javascript/26.1.0/purecloud-platform-client-v2.min.js"></script>
4545
~~~
4646

4747

‎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": "26.0.0",
3+
"version": "26.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 26.0.0
20+
* @version 26.1.0
2121
*/
2222

2323
/**
@@ -694,7 +694,7 @@
694694

695695
// set header parameters
696696
request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
697-
//request.set({ 'purecloud-sdk': '26.0.0' });
697+
//request.set({ 'purecloud-sdk': '26.1.0' });
698698

699699
// set request timeout
700700
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 26.0.0
21+
* @version 26.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 26.0.0
21+
* @version 26.1.0
2222
*/
2323

2424
/**

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

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

2424
/**

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

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

2424
/**

0 commit comments

Comments
 (0)