|
3320 | 3320 | "return": "Object", |
3321 | 3321 | "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(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.ArchitectApi();\n\nlet flowId = \"flowId_example\"; // String | Flow ID\nlet versionId = \"versionId_example\"; // String | Version ID\nlet opts = { \n \"deleted\": \"deleted_example\" // String | Deleted flows\n};\n\n// Create flow version configuration\napiInstance.getFlowVersionConfiguration(flowId, versionId, opts)\n .then((data) => {\n console.log(`getFlowVersionConfiguration success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getFlowVersionConfiguration\");\n console.error(err);\n });" |
3322 | 3322 | }, |
| 3323 | + "getflowversionhealth": { |
| 3324 | + "operationId": "getflowversionhealth", |
| 3325 | + "functionName": "getFlowVersionHealth", |
| 3326 | + "signature": "getFlowVersionHealth(flowId, versionId, language)", |
| 3327 | + "parameters": [ |
| 3328 | + { |
| 3329 | + "name": "flowId", |
| 3330 | + "type": "String", |
| 3331 | + "required": "true" |
| 3332 | + }, |
| 3333 | + { |
| 3334 | + "name": "versionId", |
| 3335 | + "type": "String", |
| 3336 | + "required": "true" |
| 3337 | + }, |
| 3338 | + { |
| 3339 | + "name": "language", |
| 3340 | + "type": "String", |
| 3341 | + "required": "false" |
| 3342 | + } |
| 3343 | + ], |
| 3344 | + "return": "FlowHealth", |
| 3345 | + "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(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.ArchitectApi();\n\nlet flowId = \"flowId_example\"; // String | Flow ID.\nlet versionId = \"versionId_example\"; // String | Version ID.\nlet opts = { \n \"language\": \"language_example\" // String | Language to filter for\n};\n\n// Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.\napiInstance.getFlowVersionHealth(flowId, versionId, opts)\n .then((data) => {\n console.log(`getFlowVersionHealth success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getFlowVersionHealth\");\n console.error(err);\n });" |
| 3346 | + }, |
| 3347 | + "getflowversionintenthealth": { |
| 3348 | + "operationId": "getflowversionintenthealth", |
| 3349 | + "functionName": "getFlowVersionIntentHealth", |
| 3350 | + "signature": "getFlowVersionIntentHealth(flowId, versionId, intentId, language)", |
| 3351 | + "parameters": [ |
| 3352 | + { |
| 3353 | + "name": "flowId", |
| 3354 | + "type": "String", |
| 3355 | + "required": "true" |
| 3356 | + }, |
| 3357 | + { |
| 3358 | + "name": "versionId", |
| 3359 | + "type": "String", |
| 3360 | + "required": "true" |
| 3361 | + }, |
| 3362 | + { |
| 3363 | + "name": "intentId", |
| 3364 | + "type": "String", |
| 3365 | + "required": "true" |
| 3366 | + }, |
| 3367 | + { |
| 3368 | + "name": "language", |
| 3369 | + "type": "String", |
| 3370 | + "required": "true" |
| 3371 | + } |
| 3372 | + ], |
| 3373 | + "return": "FlowHealthIntent", |
| 3374 | + "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(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.ArchitectApi();\n\nlet flowId = \"flowId_example\"; // String | Flow ID.\nlet versionId = \"versionId_example\"; // String | Version ID.\nlet intentId = \"intentId_example\"; // String | Intent ID.\nlet language = \"language_example\"; // String | Language to filter for\n\n// Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.\napiInstance.getFlowVersionIntentHealth(flowId, versionId, intentId, language)\n .then((data) => {\n console.log(`getFlowVersionIntentHealth success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getFlowVersionIntentHealth\");\n console.error(err);\n });" |
| 3375 | + }, |
| 3376 | + "getflowversionintentutterancehealth": { |
| 3377 | + "operationId": "getflowversionintentutterancehealth", |
| 3378 | + "functionName": "getFlowVersionIntentUtteranceHealth", |
| 3379 | + "signature": "getFlowVersionIntentUtteranceHealth(flowId, versionId, intentId, utteranceId, language)", |
| 3380 | + "parameters": [ |
| 3381 | + { |
| 3382 | + "name": "flowId", |
| 3383 | + "type": "String", |
| 3384 | + "required": "true" |
| 3385 | + }, |
| 3386 | + { |
| 3387 | + "name": "versionId", |
| 3388 | + "type": "String", |
| 3389 | + "required": "true" |
| 3390 | + }, |
| 3391 | + { |
| 3392 | + "name": "intentId", |
| 3393 | + "type": "String", |
| 3394 | + "required": "true" |
| 3395 | + }, |
| 3396 | + { |
| 3397 | + "name": "utteranceId", |
| 3398 | + "type": "String", |
| 3399 | + "required": "true" |
| 3400 | + }, |
| 3401 | + { |
| 3402 | + "name": "language", |
| 3403 | + "type": "String", |
| 3404 | + "required": "true" |
| 3405 | + } |
| 3406 | + ], |
| 3407 | + "return": "FlowHealthUtterance", |
| 3408 | + "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(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.ArchitectApi();\n\nlet flowId = \"flowId_example\"; // String | Flow ID.\nlet versionId = \"versionId_example\"; // String | Version ID.\nlet intentId = \"intentId_example\"; // String | Intent ID.\nlet utteranceId = \"utteranceId_example\"; // String | Utterance ID.\nlet language = \"language_example\"; // String | Language to filter for\n\n// Get health metrics associated with a specific utterance of an intent.\napiInstance.getFlowVersionIntentUtteranceHealth(flowId, versionId, intentId, utteranceId, language)\n .then((data) => {\n console.log(`getFlowVersionIntentUtteranceHealth success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getFlowVersionIntentUtteranceHealth\");\n console.error(err);\n });" |
| 3409 | + }, |
3323 | 3410 | "getflowversions": { |
3324 | 3411 | "operationId": "getflowversions", |
3325 | 3412 | "functionName": "getFlowVersions", |
@@ -21646,16 +21733,21 @@ |
21646 | 21733 | "postlearningmodulepublish": { |
21647 | 21734 | "operationId": "postlearningmodulepublish", |
21648 | 21735 | "functionName": "postLearningModulePublish", |
21649 | | - "signature": "postLearningModulePublish(moduleId)", |
| 21736 | + "signature": "postLearningModulePublish(moduleId, body)", |
21650 | 21737 | "parameters": [ |
21651 | 21738 | { |
21652 | 21739 | "name": "moduleId", |
21653 | 21740 | "type": "String", |
21654 | 21741 | "required": "true" |
| 21742 | + }, |
| 21743 | + { |
| 21744 | + "name": "body", |
| 21745 | + "type": "Object", |
| 21746 | + "required": "false" |
21655 | 21747 | } |
21656 | 21748 | ], |
21657 | 21749 | "return": "LearningModulePublishResponse", |
21658 | | - "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(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.LearningApi();\n\nlet moduleId = \"moduleId_example\"; // String | The ID of the learning module\n\n// Publish a Learning module\napiInstance.postLearningModulePublish(moduleId)\n .then((data) => {\n console.log(`postLearningModulePublish success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postLearningModulePublish\");\n console.error(err);\n });" |
| 21750 | + "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(...)\nclient.setAccessToken(\"your_access_token\");\n\nlet apiInstance = new platformClient.LearningApi();\n\nlet moduleId = \"moduleId_example\"; // String | The ID of the learning module\nlet opts = { \n \"body\": {} // Object | The request body\n};\n\n// Publish a Learning module\napiInstance.postLearningModulePublish(moduleId, opts)\n .then((data) => {\n console.log(`postLearningModulePublish success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postLearningModulePublish\");\n console.error(err);\n });" |
21659 | 21751 | }, |
21660 | 21752 | "postlearningmodules": { |
21661 | 21753 | "operationId": "postlearningmodules", |
|
0 commit comments