Skip to content

Commit a771483

Browse files
author
PureCloud Jenkins
committed
243.0.0
1 parent ea0f6f2 commit a771483

188 files changed

Lines changed: 1519 additions & 1970 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@242.0.0
9+
Documentation version purecloud-platform-client-v2@243.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/242.0.0/purecloud-platform-client-v2.min.js"></script>
32+
<script src="https://sdk-cdn.mypurecloud.com/javascript/243.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/242.0.0/purecloud-platform-client-v2.min.js'], (platformClient) => {
49+
requirejs(['https://sdk-cdn.mypurecloud.com/javascript/amd/243.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
@@ -2057,6 +2057,7 @@ docs/patchJourneyViewVersionJob-example.txt
20572057
docs/patchKnowledgeGuestSessionDocumentsSearchSearchId-example.txt
20582058
docs/patchKnowledgeKnowledgebase-example.txt
20592059
docs/patchKnowledgeKnowledgebaseCategory-example.txt
2060+
docs/patchKnowledgeKnowledgebaseChunksSearchSearchId-example.txt
20602061
docs/patchKnowledgeKnowledgebaseDocument-example.txt
20612062
docs/patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId-example.txt
20622063
docs/patchKnowledgeKnowledgebaseDocumentVariation-example.txt
@@ -2543,6 +2544,8 @@ docs/postGuideVersionJobs-example.txt
25432544
docs/postGuideVersions-example.txt
25442545
docs/postGuides-example.txt
25452546
docs/postGuidesJobs-example.txt
2547+
docs/postGuidesUploads-example.txt
2548+
docs/postGuidesUploads-example.txt
25462549
docs/postIdentityproviders-example.txt
25472550
docs/postInfrastructureascodeJobs-example.txt
25482551
docs/postIntegrations-example.txt

‎build/APIData.json‎

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -378,6 +378,20 @@
378378
"return": "GuideContentGenerationJob",
379379
"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.AIStudioApi();\n\nlet body = {}; // Object | \n\n// Start a guide content generation job.\napiInstance.postGuidesJobs(body)\n .then((data) => {\n console.log(`postGuidesJobs success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postGuidesJobs\");\n console.error(err);\n });"
380380
},
381+
"postguidesuploads": {
382+
"operationId": "postguidesuploads",
383+
"functionName": "postGuidesUploads",
384+
"signature": "postGuidesUploads(body)",
385+
"parameters": [
386+
{
387+
"name": "body",
388+
"type": "Object",
389+
"required": "true"
390+
}
391+
],
392+
"return": "UploadUrlResponse",
393+
"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.UploadsApi();\n\nlet body = {}; // Object | query\n\n// Generate presigned URL for uploading a file content to generate guide\napiInstance.postGuidesUploads(body)\n .then((data) => {\n console.log(`postGuidesUploads success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postGuidesUploads\");\n console.error(err);\n });"
394+
},
381395
"putconversationssummariessetting": {
382396
"operationId": "putconversationssummariessetting",
383397
"functionName": "putConversationsSummariesSetting",
@@ -16985,7 +16999,7 @@
1698516999
}
1698617000
],
1698717001
"return": "NoteListing",
16988-
"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 contactId = \"contactId_example\"; // String | ExternalContact Id\nlet opts = { \n \"pageSize\": 20, // Number | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)\n \"pageNumber\": 1, // Number | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)\n \"sortOrder\": \"sortOrder_example\", // String | The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. createDate:asc, createDate:desc\n \"expand\": [\"expand_example\"] // [String] | which fields, if any, to expand\n};\n\n// List notes for an external contact\napiInstance.getExternalcontactsContactNotes(contactId, opts)\n .then((data) => {\n console.log(`getExternalcontactsContactNotes success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getExternalcontactsContactNotes\");\n console.error(err);\n });"
17002+
"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 contactId = \"contactId_example\"; // String | ExternalContact Id\nlet opts = { \n \"pageSize\": 20, // Number | Page size (limited to fetching first 1,000 records; pageSize <= 100; pageNumber * pageSize must be <= 1,000)\n \"pageNumber\": 1, // Number | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)\n \"sortOrder\": \"sortOrder_example\", // String | The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. createDate:asc, createDate:desc\n \"expand\": [\"expand_example\"] // [String] | which fields, if any, to expand\n};\n\n// List notes for an external contact\napiInstance.getExternalcontactsContactNotes(contactId, opts)\n .then((data) => {\n console.log(`getExternalcontactsContactNotes success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getExternalcontactsContactNotes\");\n console.error(err);\n });"
1698917003
},
1699017004
"getexternalcontactscontactunresolved": {
1699117005
"operationId": "getexternalcontactscontactunresolved",
@@ -27169,6 +27183,29 @@
2716927183
"return": "CategoryResponse",
2717027184
"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.KnowledgeApi();\n\nlet knowledgeBaseId = \"knowledgeBaseId_example\"; // String | Knowledge base ID\nlet categoryId = \"categoryId_example\"; // String | Category ID\nlet body = {}; // Object | \n\n// Update category\napiInstance.patchKnowledgeKnowledgebaseCategory(knowledgeBaseId, categoryId, body)\n .then((data) => {\n console.log(`patchKnowledgeKnowledgebaseCategory success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling patchKnowledgeKnowledgebaseCategory\");\n console.error(err);\n });"
2717127185
},
27186+
"patchknowledgeknowledgebasechunkssearchsearchid": {
27187+
"operationId": "patchknowledgeknowledgebasechunkssearchsearchid",
27188+
"functionName": "patchKnowledgeKnowledgebaseChunksSearchSearchId",
27189+
"signature": "patchKnowledgeKnowledgebaseChunksSearchSearchId(knowledgeBaseId, searchId, body)",
27190+
"parameters": [
27191+
{
27192+
"name": "knowledgeBaseId",
27193+
"type": "String",
27194+
"required": "true"
27195+
},
27196+
{
27197+
"name": "searchId",
27198+
"type": "String",
27199+
"required": "true"
27200+
},
27201+
{
27202+
"name": "body",
27203+
"type": "Object",
27204+
"required": "false"
27205+
}
27206+
],
27207+
"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.KnowledgeApi();\n\nlet knowledgeBaseId = \"knowledgeBaseId_example\"; // String | Knowledge Base ID\nlet searchId = \"searchId_example\"; // String | Unique identifier of search request\nlet opts = { \n \"body\": {} // Object | \n};\n\n// Register chunk search result.\napiInstance.patchKnowledgeKnowledgebaseChunksSearchSearchId(knowledgeBaseId, searchId, opts)\n .then(() => {\n console.log(\"patchKnowledgeKnowledgebaseChunksSearchSearchId returned successfully.\");\n })\n .catch((err) => {\n console.log(\"There was a failure calling patchKnowledgeKnowledgebaseChunksSearchSearchId\");\n console.error(err);\n });"
27208+
},
2717227209
"patchknowledgeknowledgebasedocument": {
2717327210
"operationId": "patchknowledgeknowledgebasedocument",
2717427211
"functionName": "patchKnowledgeKnowledgebaseDocument",
@@ -44605,7 +44642,7 @@
4460544642
"required": "false"
4460644643
}
4460744644
],
44608-
"return": "SocialTopicResponseEntityListing",
44645+
"return": "SocialTopicWithDataIngestionRuleMetadataResponseEntityListing",
4460944646
"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.SocialMediaApi();\n\nlet opts = { \n \"pageNumber\": 1, // Number | Page number\n \"pageSize\": 25, // Number | Page size\n \"divisionIds\": [\"divisionIds_example\"], // [String] | One or more division IDs. If nothing is provided, the social topics associated withthe list of divisions that the user has access to will be returned.\n \"includeDeleted\": true, // Boolean | Determines whether to include soft-deleted items in the result.\n \"name\": \"name_example\", // String | Search for topic by name that contains the given search string, search is case insensitive\n \"ids\": [\"ids_example\"] // [String] | One or more topic IDs to search through the topics.\n};\n\n// Retrieve all social topics.\napiInstance.getSocialmediaTopics(opts)\n .then((data) => {\n console.log(`getSocialmediaTopics success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getSocialmediaTopics\");\n console.error(err);\n });"
4461044647
},
4461144648
"patchsocialmediatopic": {
@@ -45361,7 +45398,7 @@
4536145398
"required": "true"
4536245399
}
4536345400
],
45364-
"return": "ProgramMappings",
45401+
"return": "TopicsDefinitionsProgramMappings",
4536545402
"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.SpeechTextAnalyticsApi();\n\nlet programId = \"programId_example\"; // String | The id of the program\n\n// Get Speech and Text Analytics program mappings to queues and flows by id\napiInstance.getSpeechandtextanalyticsProgramMappings(programId)\n .then((data) => {\n console.log(`getSpeechandtextanalyticsProgramMappings success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getSpeechandtextanalyticsProgramMappings\");\n console.error(err);\n });"
4536645403
},
4536745404
"getspeechandtextanalyticsprogramsettingsinsights": {
@@ -45446,7 +45483,7 @@
4544645483
"required": "false"
4544745484
}
4544845485
],
45449-
"return": "ProgramsMappingsEntityListing",
45486+
"return": "TopicsDefinitionsProgramsMappingsEntityListing",
4545045487
"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.SpeechTextAnalyticsApi();\n\nlet opts = { \n \"nextPage\": \"nextPage_example\", // String | The key for listing the next page\n \"pageSize\": 20 // Number | The page size for the listing\n};\n\n// Get the list of Speech and Text Analytics programs mappings to queues and flows\napiInstance.getSpeechandtextanalyticsProgramsMappings(opts)\n .then((data) => {\n console.log(`getSpeechandtextanalyticsProgramsMappings success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getSpeechandtextanalyticsProgramsMappings\");\n console.error(err);\n });"
4545145488
},
4545245489
"getspeechandtextanalyticsprogramspublishjob": {
@@ -45992,7 +46029,7 @@
4599246029
"required": "true"
4599346030
}
4599446031
],
45995-
"return": "ProgramMappings",
46032+
"return": "TopicsDefinitionsProgramMappings",
4599646033
"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.SpeechTextAnalyticsApi();\n\nlet programId = \"programId_example\"; // String | The id of the program\nlet body = {}; // Object | The program to set mappings for\n\n// Set Speech and Text Analytics program mappings to queues and flows\napiInstance.putSpeechandtextanalyticsProgramMappings(programId, body)\n .then((data) => {\n console.log(`putSpeechandtextanalyticsProgramMappings success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling putSpeechandtextanalyticsProgramMappings\");\n console.error(err);\n });"
4599746034
},
4599846035
"putspeechandtextanalyticsprogramsettingsinsights": {

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

0 commit comments

Comments
 (0)