Skip to content

Commit 0877f42

Browse files
author
InIn Devops
committed
11.0.0
1 parent 98c1cbd commit 0877f42

56 files changed

Lines changed: 1015 additions & 174 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 `10.0.0` with the version you want to use. -->
29-
<script src="https://sdk-cdn.mypurecloud.com/javascript/10.0.0/purecloud-platform-client-v2.min.js"></script>
28+
<!-- Replace `11.0.0` with the version you want to use. -->
29+
<script src="https://sdk-cdn.mypurecloud.com/javascript/11.0.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 `10.0.0` with the version you want to use. -->
29-
<script src="https://sdk-cdn.mypurecloud.com/javascript/10.0.0/purecloud-platform-client-v2.min.js"></script>
28+
<!-- Replace `11.0.0` with the version you want to use. -->
29+
<script src="https://sdk-cdn.mypurecloud.com/javascript/11.0.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/ArchitectApi.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2127,7 +2127,9 @@ var opts = {
21272127
'lockedBy': "lockedBy_example", // String | Locked by
21282128
'secure': "secure_example", // String | Secure
21292129
'deleted': false, // Boolean | Include deleted
2130-
'includeSchemas': false // Boolean | Include variable schemas
2130+
'includeSchemas': false, // Boolean | Include variable schemas
2131+
'publishedAfter': "2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01", // String | Published after
2132+
'publishedBefore': "2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01" // String | Published before
21312133
};
21322134
apiInstance.getFlows(type, opts)
21332135
.then(function(data) {
@@ -2160,6 +2162,8 @@ apiInstance.getFlows(type, opts)
21602162
**secure** | **String** | Secure | [optional] <br />**Values**: any, checkedin, published |
21612163
**deleted** | **Boolean** | Include deleted | [optional] [default to false] |
21622164
**includeSchemas** | **Boolean** | Include variable schemas | [optional] [default to false] |
2165+
**publishedAfter** | **String** | Published after | [optional] |
2166+
**publishedBefore** | **String** | Published before | [optional] |
21632167
{: class="table table-striped"}
21642168

21652169
### Return type

build/docs/ConversationsApi.md

Lines changed: 61 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ All URIs are relative to *https://api.mypurecloud.com*
6767
[**postAnalyticsConversationsAggregatesQuery**](ConversationsApi.html#postAnalyticsConversationsAggregatesQuery) | **POST** /api/v2/analytics/conversations/aggregates/query | Query for conversation aggregates
6868
[**postAnalyticsConversationsDetailsQuery**](ConversationsApi.html#postAnalyticsConversationsDetailsQuery) | **POST** /api/v2/analytics/conversations/details/query | Query for conversation details
6969
[**postConversationParticipantCallbacks**](ConversationsApi.html#postConversationParticipantCallbacks) | **POST** /api/v2/conversations/{conversationId}/participants/{participantId}/callbacks | Create a new callback for the specified participant on the conversation.
70+
[**postConversationParticipantDigits**](ConversationsApi.html#postConversationParticipantDigits) | **POST** /api/v2/conversations/{conversationId}/participants/{participantId}/digits | Sends DTMF to the participant
7071
[**postConversationParticipantReplace**](ConversationsApi.html#postConversationParticipantReplace) | **POST** /api/v2/conversations/{conversationId}/participants/{participantId}/replace | Replace this participant with the specified user and/or address
7172
[**postConversationsCall**](ConversationsApi.html#postConversationsCall) | **POST** /api/v2/conversations/calls/{conversationId} | Place a new call as part of a callback conversation.
7273
[**postConversationsCallParticipantConsult**](ConversationsApi.html#postConversationsCallParticipantConsult) | **POST** /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult | Initiate and update consult transfer
@@ -911,9 +912,10 @@ platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken
911912
var apiInstance = new platformClient.ConversationsApi();
912913

913914
var opts = {
914-
'pageSize': 25, // Number | Page size
915+
'pageSize': 25, // Number | Page size, maximum 50
915916
'pageNumber': 1, // Number | Page number
916-
'interval': "interval_example" // String | Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
917+
'interval': "interval_example", // String | Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
918+
'expand': ["expand_example"] // [String] | Which fields, if any, to expand.
917919
};
918920
apiInstance.getConversationsCallsHistory(opts)
919921
.then(function(data) {
@@ -931,9 +933,10 @@ apiInstance.getConversationsCallsHistory(opts)
931933

932934
| Name | Type | Description | Notes |
933935
| ------------- | ------------- | ------------- | ------------- |
934-
**pageSize** | **Number** | Page size | [optional] [default to 25] |
936+
**pageSize** | **Number** | Page size, maximum 50 | [optional] [default to 25] |
935937
**pageNumber** | **Number** | Page number | [optional] [default to 1] |
936938
**interval** | **String** | Interval string; format is ISO-8601. Separate start and end times with forward slash &#39;/&#39; | [optional] |
939+
**expand** | **[String]** | Which fields, if any, to expand. | [optional] <br />**Values**: externalorganization, externalcontact, user, queue, group |
937940
{: class="table table-striped"}
938941

939942
### Return type
@@ -3163,6 +3166,61 @@ apiInstance.postConversationParticipantCallbacks(conversationId, participantId,
31633166

31643167
void (no response body)
31653168

3169+
<a name="postConversationParticipantDigits"></a>
3170+
3171+
# void postConversationParticipantDigits(conversationId, participantId, opts)
3172+
3173+
POST /api/v2/conversations/{conversationId}/participants/{participantId}/digits
3174+
3175+
Sends DTMF to the participant
3176+
3177+
3178+
3179+
### Example
3180+
3181+
~~~ javascript
3182+
// Browser
3183+
const platformClient = require('platformClient');
3184+
// Node
3185+
const platformClient = require('purecloud-platform-client-v2');
3186+
3187+
// Configure OAuth2 access token for authorization: PureCloud Auth
3188+
platformClient.ApiClient.instance.authentications['PureCloud Auth'].accessToken = 'YOUR ACCESS TOKEN';
3189+
3190+
var apiInstance = new platformClient.ConversationsApi();
3191+
3192+
var conversationId = "conversationId_example"; // String | conversation ID
3193+
3194+
var participantId = "participantId_example"; // String | participant ID
3195+
3196+
var opts = {
3197+
'body': {} // Object | Digits
3198+
};
3199+
apiInstance.postConversationParticipantDigits(conversationId, participantId, opts)
3200+
.then(function() {
3201+
console.log('postConversationParticipantDigits returned successfully.');
3202+
})
3203+
.catch(function(error) {
3204+
console.log('There was a failure calling postConversationParticipantDigits');
3205+
console.error(error);
3206+
});
3207+
3208+
~~~
3209+
3210+
### Parameters
3211+
3212+
3213+
| Name | Type | Description | Notes |
3214+
| ------------- | ------------- | ------------- | ------------- |
3215+
**conversationId** | **String** | conversation ID | |
3216+
**participantId** | **String** | participant ID | |
3217+
**body** | **Object** | Digits | [optional] |
3218+
{: class="table table-striped"}
3219+
3220+
### Return type
3221+
3222+
void (no response body)
3223+
31663224
<a name="postConversationParticipantReplace"></a>
31673225

31683226
# void postConversationParticipantReplace(conversationId, participantId, body)

build/docs/QualityApi.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.mypurecloud.com*
1313
[**deleteQualityKeywordset**](QualityApi.html#deleteQualityKeywordset) | **DELETE** /api/v2/quality/keywordsets/{keywordSetId} | Delete a keywordSet by id.
1414
[**deleteQualityKeywordsets**](QualityApi.html#deleteQualityKeywordsets) | **DELETE** /api/v2/quality/keywordsets | Delete keyword sets
1515
[**getQualityAgentsActivity**](QualityApi.html#getQualityAgentsActivity) | **GET** /api/v2/quality/agents/activity | Gets a list of Agent Activities
16-
[**getQualityCalibration**](QualityApi.html#getQualityCalibration) | **GET** /api/v2/quality/calibrations/{calibrationId} | Get a calibration by id.
16+
[**getQualityCalibration**](QualityApi.html#getQualityCalibration) | **GET** /api/v2/quality/calibrations/{calibrationId} | Get a calibration by id. Requires either calibrator id or conversation id
1717
[**getQualityCalibrations**](QualityApi.html#getQualityCalibrations) | **GET** /api/v2/quality/calibrations | Get the list of calibrations
1818
[**getQualityConversationAudits**](QualityApi.html#getQualityConversationAudits) | **GET** /api/v2/quality/conversations/{conversationId}/audits | Get audits for conversation or recording
1919
[**getQualityConversationEvaluation**](QualityApi.html#getQualityConversationEvaluation) | **GET** /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId} | Get an evaluation
@@ -363,11 +363,11 @@ apiInstance.getQualityAgentsActivity(opts)
363363

364364
<a name="getQualityCalibration"></a>
365365

366-
# [**Calibration**](Calibration.html) getQualityCalibration(calibrationId, calibratorId)
366+
# [**Calibration**](Calibration.html) getQualityCalibration(calibrationId, opts)
367367

368368
GET /api/v2/quality/calibrations/{calibrationId}
369369

370-
Get a calibration by id.
370+
Get a calibration by id. Requires either calibrator id or conversation id
371371

372372

373373

@@ -386,9 +386,11 @@ var apiInstance = new platformClient.QualityApi();
386386

387387
var calibrationId = "calibrationId_example"; // String | Calibration ID
388388

389-
var calibratorId = "calibratorId_example"; // String | calibratorId
390-
391-
apiInstance.getQualityCalibration(calibrationId, calibratorId)
389+
var opts = {
390+
'calibratorId': "calibratorId_example", // String | calibratorId
391+
'conversationId': "conversationId_example" // String | conversationId
392+
};
393+
apiInstance.getQualityCalibration(calibrationId, opts)
392394
.then(function(data) {
393395
console.log(`getQualityCalibration success! data: ${JSON.stringify(data, null, 2)}`);
394396
})
@@ -405,7 +407,8 @@ apiInstance.getQualityCalibration(calibrationId, calibratorId)
405407
| Name | Type | Description | Notes |
406408
| ------------- | ------------- | ------------- | ------------- |
407409
**calibrationId** | **String** | Calibration ID | |
408-
**calibratorId** | **String** | calibratorId | |
410+
**calibratorId** | **String** | calibratorId | [optional] |
411+
**conversationId** | **String** | conversationId | [optional] |
409412
{: class="table table-striped"}
410413

411414
### Return type

0 commit comments

Comments
 (0)