|
34222 | 34222 | ], |
34223 | 34223 | "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.WebDeploymentsApi();\n\nlet deploymentId = \"deploymentId_example\"; // String | The deployment ID\n\n// Delete a deployment\napiInstance.deleteWebdeploymentsDeployment(deploymentId)\n .then(() => {\n console.log(\"deleteWebdeploymentsDeployment returned successfully.\");\n })\n .catch((err) => {\n console.log(\"There was a failure calling deleteWebdeploymentsDeployment\");\n console.error(err);\n });" |
34224 | 34224 | }, |
| 34225 | + "deletewebdeploymentstokenrevoke": { |
| 34226 | + "operationId": "deletewebdeploymentstokenrevoke", |
| 34227 | + "functionName": "deleteWebdeploymentsTokenRevoke", |
| 34228 | + "signature": "deleteWebdeploymentsTokenRevoke(xJourneySessionId, xJourneySessionType)", |
| 34229 | + "parameters": [ |
| 34230 | + { |
| 34231 | + "name": "xJourneySessionId", |
| 34232 | + "type": "String", |
| 34233 | + "required": "false" |
| 34234 | + }, |
| 34235 | + { |
| 34236 | + "name": "xJourneySessionType", |
| 34237 | + "type": "String", |
| 34238 | + "required": "false" |
| 34239 | + } |
| 34240 | + ], |
| 34241 | + "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\nlet apiInstance = new platformClient.WebDeploymentsApi();\n\nlet opts = { \n \"xJourneySessionId\": \"xJourneySessionId_example\", // String | The Customer's journey sessionId.\n \"xJourneySessionType\": \"xJourneySessionType_example\" // String | The Customer's journey session type.\n};\n\n// Invalidate JWT\napiInstance.deleteWebdeploymentsTokenRevoke(opts)\n .then(() => {\n console.log(\"deleteWebdeploymentsTokenRevoke returned successfully.\");\n })\n .catch((err) => {\n console.log(\"There was a failure calling deleteWebdeploymentsTokenRevoke\");\n console.error(err);\n });" |
| 34242 | + }, |
34225 | 34243 | "getwebdeploymentsconfigurationversion": { |
34226 | 34244 | "operationId": "getwebdeploymentsconfigurationversion", |
34227 | 34245 | "functionName": "getWebdeploymentsConfigurationVersion", |
|
34372 | 34390 | "return": "WebDeployment", |
34373 | 34391 | "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.WebDeploymentsApi();\n\nlet deployment = {}; // Object | \n\n// Create a deployment\napiInstance.postWebdeploymentsDeployments(deployment)\n .then((data) => {\n console.log(`postWebdeploymentsDeployments success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postWebdeploymentsDeployments\");\n console.error(err);\n });" |
34374 | 34392 | }, |
| 34393 | + "postwebdeploymentstokenoauthcodegrantjwtexchange": { |
| 34394 | + "operationId": "postwebdeploymentstokenoauthcodegrantjwtexchange", |
| 34395 | + "functionName": "postWebdeploymentsTokenOauthcodegrantjwtexchange", |
| 34396 | + "signature": "postWebdeploymentsTokenOauthcodegrantjwtexchange(body)", |
| 34397 | + "parameters": [ |
| 34398 | + { |
| 34399 | + "name": "body", |
| 34400 | + "type": "Object", |
| 34401 | + "required": "true" |
| 34402 | + } |
| 34403 | + ], |
| 34404 | + "return": "WebDeploymentsAuthorizationResponse", |
| 34405 | + "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\nlet apiInstance = new platformClient.WebDeploymentsApi();\n\nlet body = {}; // Object | webDeploymentsOAuthExchangeRequest\n\n// Exchange an oAuth code (obtained using the Authorization Code Flow) for a JWT that can be used by webdeployments.\napiInstance.postWebdeploymentsTokenOauthcodegrantjwtexchange(body)\n .then((data) => {\n console.log(`postWebdeploymentsTokenOauthcodegrantjwtexchange success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postWebdeploymentsTokenOauthcodegrantjwtexchange\");\n console.error(err);\n });" |
| 34406 | + }, |
| 34407 | + "postwebdeploymentstokenrefresh": { |
| 34408 | + "operationId": "postwebdeploymentstokenrefresh", |
| 34409 | + "functionName": "postWebdeploymentsTokenRefresh", |
| 34410 | + "signature": "postWebdeploymentsTokenRefresh(body)", |
| 34411 | + "parameters": [ |
| 34412 | + { |
| 34413 | + "name": "body", |
| 34414 | + "type": "Object", |
| 34415 | + "required": "false" |
| 34416 | + } |
| 34417 | + ], |
| 34418 | + "return": "SignedData", |
| 34419 | + "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\nlet apiInstance = new platformClient.WebDeploymentsApi();\n\nlet opts = { \n \"body\": {} // Object | \n};\n\n// Refresh a JWT.\napiInstance.postWebdeploymentsTokenRefresh(opts)\n .then((data) => {\n console.log(`postWebdeploymentsTokenRefresh success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postWebdeploymentsTokenRefresh\");\n console.error(err);\n });" |
| 34420 | + }, |
34375 | 34421 | "putwebdeploymentsconfigurationversionsdraft": { |
34376 | 34422 | "operationId": "putwebdeploymentsconfigurationversionsdraft", |
34377 | 34423 | "functionName": "putWebdeploymentsConfigurationVersionsDraft", |
|
34761 | 34807 | "return": "AdherenceExplanationJob", |
34762 | 34808 | "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.WorkforceManagementApi();\n\nlet jobId = \"jobId_example\"; // String | The ID of the job\n\n// Query the status of an adherence explanation operation. Only the user who started the operation can query the status\napiInstance.getWorkforcemanagementAdherenceExplanationsJob(jobId)\n .then((data) => {\n console.log(`getWorkforcemanagementAdherenceExplanationsJob success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getWorkforcemanagementAdherenceExplanationsJob\");\n console.error(err);\n });" |
34763 | 34809 | }, |
| 34810 | + "getworkforcemanagementadherencehistoricalbulkjob": { |
| 34811 | + "operationId": "getworkforcemanagementadherencehistoricalbulkjob", |
| 34812 | + "functionName": "getWorkforcemanagementAdherenceHistoricalBulkJob", |
| 34813 | + "signature": "getWorkforcemanagementAdherenceHistoricalBulkJob(jobId)", |
| 34814 | + "parameters": [ |
| 34815 | + { |
| 34816 | + "name": "jobId", |
| 34817 | + "type": "String", |
| 34818 | + "required": "true" |
| 34819 | + } |
| 34820 | + ], |
| 34821 | + "return": "WfmHistoricalAdherenceBulkResponse", |
| 34822 | + "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.WorkforceManagementApi();\n\nlet jobId = \"jobId_example\"; // String | ID of the job to get\n\n// Request to fetch the status of the historical adherence bulk job. Only the user who started the operation can query the status\napiInstance.getWorkforcemanagementAdherenceHistoricalBulkJob(jobId)\n .then((data) => {\n console.log(`getWorkforcemanagementAdherenceHistoricalBulkJob success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getWorkforcemanagementAdherenceHistoricalBulkJob\");\n console.error(err);\n });" |
| 34823 | + }, |
34764 | 34824 | "getworkforcemanagementadherencehistoricaljob": { |
34765 | 34825 | "operationId": "getworkforcemanagementadherencehistoricaljob", |
34766 | 34826 | "functionName": "getWorkforcemanagementAdherenceHistoricalJob", |
|
36386 | 36446 | "return": "WfmHistoricalAdherenceResponse", |
36387 | 36447 | "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.WorkforceManagementApi();\n\nlet opts = { \n \"body\": {} // Object | body\n};\n\n// Request a historical adherence report for users across management units\napiInstance.postWorkforcemanagementAdherenceHistorical(opts)\n .then((data) => {\n console.log(`postWorkforcemanagementAdherenceHistorical success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postWorkforcemanagementAdherenceHistorical\");\n console.error(err);\n });" |
36388 | 36448 | }, |
| 36449 | + "postworkforcemanagementadherencehistoricalbulk": { |
| 36450 | + "operationId": "postworkforcemanagementadherencehistoricalbulk", |
| 36451 | + "functionName": "postWorkforcemanagementAdherenceHistoricalBulk", |
| 36452 | + "signature": "postWorkforcemanagementAdherenceHistoricalBulk(body)", |
| 36453 | + "parameters": [ |
| 36454 | + { |
| 36455 | + "name": "body", |
| 36456 | + "type": "Object", |
| 36457 | + "required": "false" |
| 36458 | + } |
| 36459 | + ], |
| 36460 | + "return": "WfmHistoricalAdherenceBulkResponse", |
| 36461 | + "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.WorkforceManagementApi();\n\nlet opts = { \n \"body\": {} // Object | body\n};\n\n// Request a historical adherence report in bulk\napiInstance.postWorkforcemanagementAdherenceHistoricalBulk(opts)\n .then((data) => {\n console.log(`postWorkforcemanagementAdherenceHistoricalBulk success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postWorkforcemanagementAdherenceHistoricalBulk\");\n console.error(err);\n });" |
| 36462 | + }, |
36389 | 36463 | "postworkforcemanagementagentadherenceexplanations": { |
36390 | 36464 | "operationId": "postworkforcemanagementagentadherenceexplanations", |
36391 | 36465 | "functionName": "postWorkforcemanagementAgentAdherenceExplanations", |
|
0 commit comments