Skip to content

Commit 30bd07d

Browse files
author
PureCloud Jenkins
committed
239.0.0
1 parent 85e17e9 commit 30bd07d

186 files changed

Lines changed: 1628 additions & 1317 deletions

File tree

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
@@ -6,7 +6,7 @@ A JavaScript library to interface with the Genesys Cloud Platform API. View the
66
[![npm](https://img.shields.io/npm/v/purecloud-platform-client-v2.svg)](https://www.npmjs.com/package/purecloud-platform-client-v2)
77
[![Release Notes Badge](https://developer-content.genesys.cloud/images/sdk-release-notes.png)](https://github.com/MyPureCloud/platform-client-sdk-javascript/blob/master/releaseNotes.md)
88

9-
Documentation version purecloud-platform-client-v2@238.0.0
9+
Documentation version purecloud-platform-client-v2@239.0.0
1010

1111
## Preview APIs
1212

@@ -29,7 +29,7 @@ For direct use in a browser script:
2929

3030
```html
3131
<!-- Include the CJS SDK -->
32-
<script src="https://sdk-cdn.mypurecloud.com/javascript/238.0.0/purecloud-platform-client-v2.min.js"></script>
32+
<script src="https://sdk-cdn.mypurecloud.com/javascript/239.0.0/purecloud-platform-client-v2.min.js"></script>
3333

3434
<script type="text/javascript">
3535
// Obtain a reference to the platformClient object
@@ -46,7 +46,7 @@ For direct use in a browser script:
4646

4747
<script type="text/javascript">
4848
// Obtain a reference to the platformClient object
49-
requirejs(['https://sdk-cdn.mypurecloud.com/javascript/amd/238.0.0/purecloud-platform-client-v2.min.js'], (platformClient) => {
49+
requirejs(['https://sdk-cdn.mypurecloud.com/javascript/amd/239.0.0/purecloud-platform-client-v2.min.js'], (platformClient) => {
5050
console.log(platformClient);
5151
});
5252
</script>

‎build/.openapi-generator/FILES‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -848,6 +848,7 @@ docs/getEmailsSettingsThreading-example.txt
848848
docs/getEmailsSettingsThreading-example.txt
849849
docs/getEmployeeengagementCelebrations-example.txt
850850
docs/getEmployeeengagementRecognition-example.txt
851+
docs/getEmployeeengagementRecognitions-example.txt
851852
docs/getEmployeeperformanceExternalmetricsDefinition-example.txt
852853
docs/getEmployeeperformanceExternalmetricsDefinitions-example.txt
853854
docs/getExternalcontactsContact-example.txt

‎build/APIData.json‎

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16139,6 +16139,45 @@
1613916139
"return": "Recognition",
1614016140
"example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.EmployeeEngagementApi();\n\nlet recognitionId = \"recognitionId_example\"; // String | The Recognition ID\n\n// Gets a single recognition\napiInstance.getEmployeeengagementRecognition(recognitionId)\n .then((data) => {\n console.log(`getEmployeeengagementRecognition success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getEmployeeengagementRecognition\");\n console.error(err);\n });"
1614116141
},
16142+
"getemployeeengagementrecognitions": {
16143+
"operationId": "getemployeeengagementrecognitions",
16144+
"functionName": "getEmployeeengagementRecognitions",
16145+
"signature": "getEmployeeengagementRecognitions(direction, recipient, dateStart, dateEnd, pageSize, pageNumber)",
16146+
"parameters": [
16147+
{
16148+
"name": "direction",
16149+
"type": "String",
16150+
"required": "false"
16151+
},
16152+
{
16153+
"name": "recipient",
16154+
"type": "String",
16155+
"required": "false"
16156+
},
16157+
{
16158+
"name": "dateStart",
16159+
"type": "Date",
16160+
"required": "false"
16161+
},
16162+
{
16163+
"name": "dateEnd",
16164+
"type": "Date",
16165+
"required": "false"
16166+
},
16167+
{
16168+
"name": "pageSize",
16169+
"type": "Number",
16170+
"required": "false"
16171+
},
16172+
{
16173+
"name": "pageNumber",
16174+
"type": "Number",
16175+
"required": "false"
16176+
}
16177+
],
16178+
"return": "Recognitions",
16179+
"example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.EmployeeEngagementApi();\n\nlet opts = { \n \"direction\": \"received\", // String | The direction of the recognitions.\n \"recipient\": \"recipient_example\", // String | The ID of the recipient (when direction is sent).\n \"dateStart\": new Date(\"2013-10-20T19:20:30+01:00\"), // Date | The start date of the search range. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z\n \"dateEnd\": new Date(\"2013-10-20T19:20:30+01:00\"), // Date | The end date of the search range. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z\n \"pageSize\": 100, // Number | Page size\n \"pageNumber\": 1 // Number | Page number\n};\n\n// Gets sent recognitions\napiInstance.getEmployeeengagementRecognitions(opts)\n .then((data) => {\n console.log(`getEmployeeengagementRecognitions success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getEmployeeengagementRecognitions\");\n console.error(err);\n });"
16180+
},
1614216181
"patchemployeeengagementcelebration": {
1614316182
"operationId": "patchemployeeengagementcelebration",
1614416183
"functionName": "patchEmployeeengagementCelebration",
@@ -33355,7 +33394,7 @@
3335533394
"getoutboundmessagingcampaigns": {
3335633395
"operationId": "getoutboundmessagingcampaigns",
3335733396
"functionName": "getOutboundMessagingcampaigns",
33358-
"signature": "getOutboundMessagingcampaigns(pageSize, pageNumber, sortBy, sortOrder, name, contactListId, divisionId, type, senderSmsPhoneNumber, id, contentTemplateId, campaignStatus)",
33397+
"signature": "getOutboundMessagingcampaigns(pageSize, pageNumber, sortBy, sortOrder, name, contactListId, divisionId, type, senderSmsPhoneNumber, id, contentTemplateId, campaignStatus, ruleSetIds)",
3335933398
"parameters": [
3336033399
{
3336133400
"name": "pageSize",
@@ -33416,10 +33455,15 @@
3341633455
"name": "campaignStatus",
3341733456
"type": "String",
3341833457
"required": "false"
33458+
},
33459+
{
33460+
"name": "ruleSetIds",
33461+
"type": "[String]",
33462+
"required": "false"
3341933463
}
3342033464
],
3342133465
"return": "MessagingCampaignEntityListing",
33422-
"example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.OutboundApi();\n\nlet opts = { \n \"pageSize\": 25, // Number | Page size. The max that will be returned is 100.\n \"pageNumber\": 1, // Number | Page number\n \"sortBy\": \"name\", // String | The field to sort by\n \"sortOrder\": \"ascending\", // String | The direction to sort\n \"name\": \"name_example\", // String | Name\n \"contactListId\": \"contactListId_example\", // String | Contact List ID\n \"divisionId\": [\"divisionId_example\"], // [String] | Division ID(s)\n \"type\": \"type_example\", // String | Campaign Type\n \"senderSmsPhoneNumber\": \"senderSmsPhoneNumber_example\", // String | Sender SMS Phone Number\n \"id\": [\"id_example\"], // [String] | A list of messaging campaign ids to bulk fetch\n \"contentTemplateId\": \"contentTemplateId_example\", // String | Content template ID\n \"campaignStatus\": \"campaignStatus_example\" // String | Campaign Status\n};\n\n// Query a list of Messaging Campaigns\napiInstance.getOutboundMessagingcampaigns(opts)\n .then((data) => {\n console.log(`getOutboundMessagingcampaigns success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getOutboundMessagingcampaigns\");\n console.error(err);\n });"
33466+
"example": "const platformClient = require(\"purecloud-platform-client-v2\");\n\nconst client = platformClient.ApiClient.instance;\nclient.setEnvironment(platformClient.PureCloudRegionHosts.us_east_1); // Genesys Cloud region\n\n// Manually set auth token or use loginImplicitGrant(...) or loginClientCredentialsGrant(...) or loginPKCEGrant(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.OutboundApi();\n\nlet opts = { \n \"pageSize\": 25, // Number | Page size. The max that will be returned is 100.\n \"pageNumber\": 1, // Number | Page number\n \"sortBy\": \"name\", // String | The field to sort by\n \"sortOrder\": \"ascending\", // String | The direction to sort\n \"name\": \"name_example\", // String | Name\n \"contactListId\": \"contactListId_example\", // String | Contact List ID\n \"divisionId\": [\"divisionId_example\"], // [String] | Division ID(s)\n \"type\": \"type_example\", // String | Campaign Type\n \"senderSmsPhoneNumber\": \"senderSmsPhoneNumber_example\", // String | Sender SMS Phone Number\n \"id\": [\"id_example\"], // [String] | A list of messaging campaign ids to bulk fetch\n \"contentTemplateId\": \"contentTemplateId_example\", // String | Content template ID\n \"campaignStatus\": \"campaignStatus_example\", // String | Campaign Status\n \"ruleSetIds\": [\"ruleSetIds_example\"] // [String] | Ruleset ID(s)\n};\n\n// Query a list of Messaging Campaigns\napiInstance.getOutboundMessagingcampaigns(opts)\n .then((data) => {\n console.log(`getOutboundMessagingcampaigns success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getOutboundMessagingcampaigns\");\n console.error(err);\n });"
3342333467
},
3342433468
"getoutboundmessagingcampaignsdivisionview": {
3342533469
"operationId": "getoutboundmessagingcampaignsdivisionview",

‎build/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ A JavaScript library to interface with the Genesys Cloud Platform API. View the
66
[![npm](https://img.shields.io/npm/v/purecloud-platform-client-v2.svg)](https://www.npmjs.com/package/purecloud-platform-client-v2)
77
[![Release Notes Badge](https://developer-content.genesys.cloud/images/sdk-release-notes.png)](https://github.com/MyPureCloud/platform-client-sdk-javascript/blob/master/releaseNotes.md)
88

9-
Documentation version purecloud-platform-client-v2@238.0.0
9+
Documentation version purecloud-platform-client-v2@239.0.0
1010

1111
## Preview APIs
1212

@@ -29,7 +29,7 @@ For direct use in a browser script:
2929

3030
```html
3131
<!-- Include the CJS SDK -->
32-
<script src="https://sdk-cdn.mypurecloud.com/javascript/238.0.0/purecloud-platform-client-v2.min.js"></script>
32+
<script src="https://sdk-cdn.mypurecloud.com/javascript/239.0.0/purecloud-platform-client-v2.min.js"></script>
3333

3434
<script type="text/javascript">
3535
// Obtain a reference to the platformClient object
@@ -46,7 +46,7 @@ For direct use in a browser script:
4646

4747
<script type="text/javascript">
4848
// Obtain a reference to the platformClient object
49-
requirejs(['https://sdk-cdn.mypurecloud.com/javascript/amd/238.0.0/purecloud-platform-client-v2.min.js'], (platformClient) => {
49+
requirejs(['https://sdk-cdn.mypurecloud.com/javascript/amd/239.0.0/purecloud-platform-client-v2.min.js'], (platformClient) => {
5050
console.log(platformClient);
5151
});
5252
</script>

0 commit comments

Comments
 (0)