Skip to content

Commit 2c9c718

Browse files
author
PureCloud Jenkins
committed
236.0.0
1 parent c4b4fb3 commit 2c9c718

File tree

185 files changed

+1856
-1710
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

185 files changed

+1856
-1710
lines changed

‎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@235.0.0
9+
Documentation version purecloud-platform-client-v2@236.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/235.0.0/purecloud-platform-client-v2.min.js"></script>
32+
<script src="https://sdk-cdn.mypurecloud.com/javascript/236.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/235.0.0/purecloud-platform-client-v2.min.js'], (platformClient) => {
49+
requirejs(['https://sdk-cdn.mypurecloud.com/javascript/amd/236.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
@@ -778,6 +778,7 @@ docs/getConversationsInternalmessages-example.txt
778778
docs/getConversationsKeyconfiguration-example.txt
779779
docs/getConversationsKeyconfigurations-example.txt
780780
docs/getConversationsMessage-example.txt
781+
docs/getConversationsMessageCommunicationMessagesMedia-example.txt
781782
docs/getConversationsMessageCommunicationMessagesMediaMediaId-example.txt
782783
docs/getConversationsMessageDetails-example.txt
783784
docs/getConversationsMessageMessage-example.txt

‎build/APIData.json‎

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6918,7 +6918,7 @@
69186918
}
69196919
],
69206920
"return": "AuthzDivisionCursorListing",
6921-
"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.ObjectsApi();\n\nlet opts = { \n \"before\": \"before_example\", // String | The cursor that points to the start of the set of entities that has been returned.\n \"after\": \"after_example\", // String | The cursor that points to the end of the set of entities that has been returned.\n \"pageSize\": \"pageSize_example\", // String | Number of entities to return. Maximum of 200.\n \"id\": [\"id_example\"], // [String] | Optionally request specific divisions by their IDs\n \"name\": \"name_example\" // String | Optionally request specific divisions by division name\n};\n\n// Retrieve a list of all divisions defined for the organization with cursor\napiInstance.getAuthorizationDivisionsQuery(opts)\n .then((data) => {\n console.log(`getAuthorizationDivisionsQuery success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getAuthorizationDivisionsQuery\");\n console.error(err);\n });"
6921+
"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.ObjectsApi();\n\nlet opts = { \n \"before\": \"before_example\", // String | The cursor that points to the start of the set of entities that has been returned.\n \"after\": \"after_example\", // String | The cursor that points to the end of the set of entities that has been returned.\n \"pageSize\": \"25\", // String | Page size (max 200, default 25)\n \"id\": [\"id_example\"], // [String] | Optionally request specific divisions by their IDs\n \"name\": \"name_example\" // String | Optionally request specific divisions by division name\n};\n\n// Retrieve a list of all divisions defined for the organization with cursor\napiInstance.getAuthorizationDivisionsQuery(opts)\n .then((data) => {\n console.log(`getAuthorizationDivisionsQuery success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getAuthorizationDivisionsQuery\");\n console.error(err);\n });"
69226922
},
69236923
"getauthorizationdivisionspermittedme": {
69246924
"operationId": "getauthorizationdivisionspermittedme",
@@ -11704,6 +11704,40 @@
1170411704
"return": "MessageConversation",
1170511705
"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.ConversationsApi();\n\nlet conversationId = \"conversationId_example\"; // String | conversationId\n\n// Get message conversation\napiInstance.getConversationsMessage(conversationId)\n .then((data) => {\n console.log(`getConversationsMessage success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getConversationsMessage\");\n console.error(err);\n });"
1170611706
},
11707+
"getconversationsmessagecommunicationmessagesmedia": {
11708+
"operationId": "getconversationsmessagecommunicationmessagesmedia",
11709+
"functionName": "getConversationsMessageCommunicationMessagesMedia",
11710+
"signature": "getConversationsMessageCommunicationMessagesMedia(conversationId, communicationId, status, pageNumber, pageSize)",
11711+
"parameters": [
11712+
{
11713+
"name": "conversationId",
11714+
"type": "String",
11715+
"required": "true"
11716+
},
11717+
{
11718+
"name": "communicationId",
11719+
"type": "String",
11720+
"required": "true"
11721+
},
11722+
{
11723+
"name": "status",
11724+
"type": "String",
11725+
"required": "false"
11726+
},
11727+
{
11728+
"name": "pageNumber",
11729+
"type": "Number",
11730+
"required": "false"
11731+
},
11732+
{
11733+
"name": "pageSize",
11734+
"type": "Number",
11735+
"required": "false"
11736+
}
11737+
],
11738+
"return": "MessageMediaListing",
11739+
"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.ConversationsApi();\n\nlet conversationId = \"conversationId_example\"; // String | conversationId\nlet communicationId = \"communicationId_example\"; // String | communicationId\nlet opts = { \n \"status\": \"status_example\", // String | The status on which to filter the response.\n \"pageNumber\": 1, // Number | Page number\n \"pageSize\": 25 // Number | Page size\n};\n\n// Get message media list by status\napiInstance.getConversationsMessageCommunicationMessagesMedia(conversationId, communicationId, opts)\n .then((data) => {\n console.log(`getConversationsMessageCommunicationMessagesMedia success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getConversationsMessageCommunicationMessagesMedia\");\n console.error(err);\n });"
11740+
},
1170711741
"getconversationsmessagecommunicationmessagesmediamediaid": {
1170811742
"operationId": "getconversationsmessagecommunicationmessagesmediamediaid",
1170911743
"functionName": "getConversationsMessageCommunicationMessagesMediaMediaId",
@@ -28730,7 +28764,7 @@
2873028764
"required": "false"
2873128765
}
2873228766
],
28733-
"return": "LearningModulesDomainEntityListing",
28767+
"return": "LearningModuleList",
2873428768
"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.LearningApi();\n\nlet opts = { \n \"isArchived\": false, // Boolean | Archive status\n \"types\": [\"types_example\"], // [String] | Specifies the module types. Informational, AssessedContent and Assessment are deprecated\n \"pageSize\": 25, // Number | Page size\n \"pageNumber\": 1, // Number | Page number\n \"sortOrder\": \"ascending\", // String | Sort order\n \"sortBy\": \"name\", // String | Sort by\n \"searchTerm\": \"searchTerm_example\", // String | Search Term (searchable by name)\n \"expand\": [\"expand_example\"], // [String] | Fields to expand in response(case insensitive)\n \"isPublished\": \"Any\", // String | Specifies if only the Unpublished (isPublished is False) or Published (isPublished is True) modules are returned. If isPublished is Any or omitted, both types are returned\n \"statuses\": [\"statuses_example\"], // [String] | Specifies the module statuses to filter by\n \"externalIds\": [\"externalIds_example\"] // [String] | Specifies the module external IDs to filter by. Only one ID is allowed\n};\n\n// Get all learning modules of an organization\napiInstance.getLearningModules(opts)\n .then((data) => {\n console.log(`getLearningModules success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getLearningModules\");\n console.error(err);\n });"
2873528769
},
2873628770
"getlearningmodulesassignments": {
@@ -46052,8 +46086,7 @@
4605246086
"required": "true"
4605346087
}
4605446088
],
46055-
"return": "WorkitemWrapup",
46056-
"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 workitemId = \"workitemId_example\"; // String | The ID of the Workitem.\nlet userId = \"userId_example\"; // String | The ID of the user\nlet body = {}; // Object | Request body to add/remove a wrapup code for a workitem\n\n// Add/Remove a wrapup code for a given user in a workitem.\napiInstance.patchTaskmanagementWorkitemUserWrapups(workitemId, userId, body)\n .then((data) => {\n console.log(`patchTaskmanagementWorkitemUserWrapups success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling patchTaskmanagementWorkitemUserWrapups\");\n console.error(err);\n });"
46089+
"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 workitemId = \"workitemId_example\"; // String | The ID of the Workitem.\nlet userId = \"userId_example\"; // String | The ID of the user\nlet body = {}; // Object | Request body to add/remove a wrapup code for a workitem\n\n// Add/Remove a wrapup code for a given user in a workitem.\napiInstance.patchTaskmanagementWorkitemUserWrapups(workitemId, userId, body)\n .then(() => {\n console.log(\"patchTaskmanagementWorkitemUserWrapups returned successfully.\");\n })\n .catch((err) => {\n console.log(\"There was a failure calling patchTaskmanagementWorkitemUserWrapups\");\n console.error(err);\n });"
4605746090
},
4605846091
"patchtaskmanagementworkitemusersmewrapups": {
4605946092
"operationId": "patchtaskmanagementworkitemusersmewrapups",
@@ -46071,8 +46104,7 @@
4607146104
"required": "true"
4607246105
}
4607346106
],
46074-
"return": "WorkitemWrapup",
46075-
"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 workitemId = \"workitemId_example\"; // String | The ID of the Workitem.\nlet body = {}; // Object | Request body to add/remove the wrapup code for workitem\n\n// Add/Remove a wrapup code for the current user in a workitem.\napiInstance.patchTaskmanagementWorkitemUsersMeWrapups(workitemId, body)\n .then((data) => {\n console.log(`patchTaskmanagementWorkitemUsersMeWrapups success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling patchTaskmanagementWorkitemUsersMeWrapups\");\n console.error(err);\n });"
46107+
"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 workitemId = \"workitemId_example\"; // String | The ID of the Workitem.\nlet body = {}; // Object | Request body to add/remove the wrapup code for workitem\n\n// Add/Remove a wrapup code for the current user in a workitem.\napiInstance.patchTaskmanagementWorkitemUsersMeWrapups(workitemId, body)\n .then(() => {\n console.log(\"patchTaskmanagementWorkitemUsersMeWrapups returned successfully.\");\n })\n .catch((err) => {\n console.log(\"There was a failure calling patchTaskmanagementWorkitemUsersMeWrapups\");\n console.error(err);\n });"
4607646108
},
4607746109
"patchtaskmanagementworkitemsbulkaddjob": {
4607846110
"operationId": "patchtaskmanagementworkitemsbulkaddjob",

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

0 commit comments

Comments
 (0)