Skip to content

Commit 4ce0533

Browse files
author
PureCloud Jenkins
committed
227.0.0
1 parent 2526e19 commit 4ce0533

184 files changed

Lines changed: 1983 additions & 1769 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@226.0.0
9+
Documentation version purecloud-platform-client-v2@227.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/226.0.0/purecloud-platform-client-v2.min.js"></script>
32+
<script src="https://sdk-cdn.mypurecloud.com/javascript/227.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/226.0.0/purecloud-platform-client-v2.min.js'], (platformClient) => {
49+
requirejs(['https://sdk-cdn.mypurecloud.com/javascript/amd/227.0.0/purecloud-platform-client-v2.min.js'], (platformClient) => {
5050
console.log(platformClient);
5151
});
5252
</script>

‎build/.openapi-generator/FILES‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,7 @@ docs/deleteChatsRoomMessagesPin-example.txt
202202
docs/deleteChatsRoomParticipant-example.txt
203203
docs/deleteChatsUserMessage-example.txt
204204
docs/deleteChatsUserMessagesPin-example.txt
205+
docs/deleteChatsUsersMeSettings-example.txt
205206
docs/deleteCoachingAppointment-example.txt
206207
docs/deleteCoachingAppointmentAnnotation-example.txt
207208
docs/deleteContentmanagementDocument-example.txt
@@ -1852,6 +1853,7 @@ docs/getWorkforcemanagementNotifications-example.txt
18521853
docs/getWorkforcemanagementSchedulingjob-example.txt
18531854
docs/getWorkforcemanagementShifttrades-example.txt
18541855
docs/getWorkforcemanagementShrinkageJob-example.txt
1856+
docs/getWorkforcemanagementTeamAdherence-example.txt
18551857
docs/getWorkforcemanagementTimeoffbalanceJob-example.txt
18561858
docs/getWorkforcemanagementTimeoffrequest-example.txt
18571859
docs/getWorkforcemanagementTimeoffrequestWaitlistpositions-example.txt
@@ -2216,6 +2218,7 @@ docs/postChatsRoomParticipant-example.txt
22162218
docs/postChatsRooms-example.txt
22172219
docs/postChatsUserMessages-example.txt
22182220
docs/postChatsUserMessagesPins-example.txt
2221+
docs/postChatsUsersMeSettings-example.txt
22192222
docs/postCoachingAppointmentAnnotations-example.txt
22202223
docs/postCoachingAppointmentConversations-example.txt
22212224
docs/postCoachingAppointments-example.txt

‎build/APIData.json‎

Lines changed: 36 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8341,6 +8341,12 @@
83418341
],
83428342
"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.ChatApi();\n\nlet userId = \"userId_example\"; // String | userId\nlet pinnedMessageId = \"pinnedMessageId_example\"; // String | pinnedMessageId\n\n// Remove a pinned message from a 1on1\napiInstance.deleteChatsUserMessagesPin(userId, pinnedMessageId)\n .then(() => {\n console.log(\"deleteChatsUserMessagesPin returned successfully.\");\n })\n .catch((err) => {\n console.log(\"There was a failure calling deleteChatsUserMessagesPin\");\n console.error(err);\n });"
83438343
},
8344+
"deletechatsusersmesettings": {
8345+
"operationId": "deletechatsusersmesettings",
8346+
"functionName": "deleteChatsUsersMeSettings",
8347+
"signature": "deleteChatsUsersMeSettings()",
8348+
"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.ChatApi();\n\n// Delete a user's chat settings\napiInstance.deleteChatsUsersMeSettings()\n .then(() => {\n console.log(\"deleteChatsUsersMeSettings returned successfully.\");\n })\n .catch((err) => {\n console.log(\"There was a failure calling deleteChatsUsersMeSettings\");\n console.error(err);\n });"
8349+
},
83448350
"getchatsmessage": {
83458351
"operationId": "getchatsmessage",
83468352
"functionName": "getChatsMessage",
@@ -8793,6 +8799,19 @@
87938799
],
87948800
"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.ChatApi();\n\nlet userId = \"userId_example\"; // String | userId\nlet body = {}; // Object | Pinned Message Ids\n\n// Add pinned messages for a 1on1, up to a maximum of 5 pinned messages\napiInstance.postChatsUserMessagesPins(userId, body)\n .then(() => {\n console.log(\"postChatsUserMessagesPins returned successfully.\");\n })\n .catch((err) => {\n console.log(\"There was a failure calling postChatsUserMessagesPins\");\n console.error(err);\n });"
87958801
},
8802+
"postchatsusersmesettings": {
8803+
"operationId": "postchatsusersmesettings",
8804+
"functionName": "postChatsUsersMeSettings",
8805+
"signature": "postChatsUsersMeSettings(body)",
8806+
"parameters": [
8807+
{
8808+
"name": "body",
8809+
"type": "Object",
8810+
"required": "true"
8811+
}
8812+
],
8813+
"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.ChatApi();\n\nlet body = {}; // Object | \n\n// Create a user's chat settings\napiInstance.postChatsUsersMeSettings(body)\n .then(() => {\n console.log(\"postChatsUsersMeSettings returned successfully.\");\n })\n .catch((err) => {\n console.log(\"There was a failure calling postChatsUsersMeSettings\");\n console.error(err);\n });"
8814+
},
87968815
"putchatsmessagereactions": {
87978816
"operationId": "putchatsmessagereactions",
87988817
"functionName": "putChatsMessageReactions",
@@ -15840,7 +15859,7 @@
1584015859
"required": "true"
1584115860
}
1584215861
],
15843-
"return": "DataSchema",
15862+
"return": "DataSchemaListing",
1584415863
"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.ExternalContactsApi();\n\nlet schemaId = \"schemaId_example\"; // String | Schema ID\n\n// Get all versions of an external contact's schema\napiInstance.getExternalcontactsContactsSchemaVersions(schemaId)\n .then((data) => {\n console.log(`getExternalcontactsContactsSchemaVersions success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getExternalcontactsContactsSchemaVersions\");\n console.error(err);\n });"
1584515864
},
1584615865
"getexternalcontactscontactsschemas": {
@@ -16345,7 +16364,7 @@
1634516364
"required": "true"
1634616365
}
1634716366
],
16348-
"return": "DataSchema",
16367+
"return": "DataSchemaListing",
1634916368
"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.ExternalContactsApi();\n\nlet schemaId = \"schemaId_example\"; // String | Schema ID\n\n// Get all versions of an external organization's schema\napiInstance.getExternalcontactsOrganizationsSchemaVersions(schemaId)\n .then((data) => {\n console.log(`getExternalcontactsOrganizationsSchemaVersions success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getExternalcontactsOrganizationsSchemaVersions\");\n console.error(err);\n });"
1635016369
},
1635116370
"getexternalcontactsorganizationsschemas": {
@@ -44749,7 +44768,7 @@
4474944768
"required": "true"
4475044769
}
4475144770
],
44752-
"return": "DataSchema",
44771+
"return": "DataSchemaListing",
4475344772
"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.TaskManagementApi();\n\nlet schemaId = \"schemaId_example\"; // String | Schema ID\n\n// Get all versions of a schema\napiInstance.getTaskmanagementWorkitemsSchemaVersions(schemaId)\n .then((data) => {\n console.log(`getTaskmanagementWorkitemsSchemaVersions success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getTaskmanagementWorkitemsSchemaVersions\");\n console.error(err);\n });"
4475444773
},
4475544774
"gettaskmanagementworkitemsschemas": {
@@ -53199,6 +53218,20 @@
5319953218
"return": "WfmHistoricalShrinkageResponse",
5320053219
"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.WorkforceManagementApi();\n\nlet jobId = \"jobId_example\"; // String | jobId\n\n// Request to fetch the status of the historical shrinkage query\napiInstance.getWorkforcemanagementShrinkageJob(jobId)\n .then((data) => {\n console.log(`getWorkforcemanagementShrinkageJob success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getWorkforcemanagementShrinkageJob\");\n console.error(err);\n });"
5320153220
},
53221+
"getworkforcemanagementteamadherence": {
53222+
"operationId": "getworkforcemanagementteamadherence",
53223+
"functionName": "getWorkforcemanagementTeamAdherence",
53224+
"signature": "getWorkforcemanagementTeamAdherence(teamId)",
53225+
"parameters": [
53226+
{
53227+
"name": "teamId",
53228+
"type": "String",
53229+
"required": "true"
53230+
}
53231+
],
53232+
"return": "UserScheduleAdherenceListing",
53233+
"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.WorkforceManagementApi();\n\nlet teamId = \"teamId_example\"; // String | The ID of the team\n\n// Get a list of user schedule adherence records for the requested team\napiInstance.getWorkforcemanagementTeamAdherence(teamId)\n .then((data) => {\n console.log(`getWorkforcemanagementTeamAdherence success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getWorkforcemanagementTeamAdherence\");\n console.error(err);\n });"
53234+
},
5320253235
"getworkforcemanagementtimeoffbalancejob": {
5320353236
"operationId": "getworkforcemanagementtimeoffbalancejob",
5320453237
"functionName": "getWorkforcemanagementTimeoffbalanceJob",

‎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@226.0.0
9+
Documentation version purecloud-platform-client-v2@227.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/226.0.0/purecloud-platform-client-v2.min.js"></script>
32+
<script src="https://sdk-cdn.mypurecloud.com/javascript/227.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/226.0.0/purecloud-platform-client-v2.min.js'], (platformClient) => {
49+
requirejs(['https://sdk-cdn.mypurecloud.com/javascript/amd/227.0.0/purecloud-platform-client-v2.min.js'], (platformClient) => {
5050
console.log(platformClient);
5151
});
5252
</script>

0 commit comments

Comments
 (0)