|
6013 | 6013 | "return": "OrganizationRoleEntityListing", |
6014 | 6014 | "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.AuthorizationApi();\n\nlet opts = { \n \"pageSize\": 25, // Number | The total page size requested\n \"pageNumber\": 1, // Number | The page number requested\n \"sortBy\": \"sortBy_example\", // String | variable name requested to sort by\n \"expand\": [\"expand_example\"], // [String] | variable name requested by expand list\n \"nextPage\": \"nextPage_example\", // String | next page token\n \"previousPage\": \"previousPage_example\", // String | Previous page token\n \"name\": \"name_example\", // String | \n \"permission\": [\"permission_example\"], // [String] | \n \"defaultRoleId\": [\"defaultRoleId_example\"], // [String] | \n \"userCount\": true, // Boolean | \n \"id\": [\"id_example\"] // [String] | id\n};\n\n// Retrieve a list of all roles defined for the organization\napiInstance.getAuthorizationRoles(opts)\n .then((data) => {\n console.log(`getAuthorizationRoles success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getAuthorizationRoles\");\n console.error(err);\n });" |
6015 | 6015 | }, |
| 6016 | + "getauthorizationrolessettings": { |
| 6017 | + "operationId": "getauthorizationrolessettings", |
| 6018 | + "functionName": "getAuthorizationRolesSettings", |
| 6019 | + "signature": "getAuthorizationRolesSettings()", |
| 6020 | + "return": "RoleSettings", |
| 6021 | + "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.AuthorizationApi();\n\n// Get authorization role settings\napiInstance.getAuthorizationRolesSettings()\n .then((data) => {\n console.log(`getAuthorizationRolesSettings success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling getAuthorizationRolesSettings\");\n console.error(err);\n });" |
| 6022 | + }, |
6016 | 6023 | "getauthorizationsettings": { |
6017 | 6024 | "operationId": "getauthorizationsettings", |
6018 | 6025 | "functionName": "getAuthorizationSettings", |
|
6427 | 6434 | "return": "OrganizationRoleEntityListing", |
6428 | 6435 | "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.AuthorizationApi();\n\nlet body = [{}]; // Object | Organization roles list\n\n// Restore specified default roles\napiInstance.putAuthorizationRolesDefault(body)\n .then((data) => {\n console.log(`putAuthorizationRolesDefault success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling putAuthorizationRolesDefault\");\n console.error(err);\n });" |
6429 | 6436 | }, |
| 6437 | + "putauthorizationrolessettings": { |
| 6438 | + "operationId": "putauthorizationrolessettings", |
| 6439 | + "functionName": "putAuthorizationRolesSettings", |
| 6440 | + "signature": "putAuthorizationRolesSettings(body)", |
| 6441 | + "parameters": [ |
| 6442 | + { |
| 6443 | + "name": "body", |
| 6444 | + "type": "Object", |
| 6445 | + "required": "true" |
| 6446 | + } |
| 6447 | + ], |
| 6448 | + "return": "RoleSettings", |
| 6449 | + "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.AuthorizationApi();\n\nlet body = {}; // Object | Authorization Role Settings\n\n// Change authorization role settings\napiInstance.putAuthorizationRolesSettings(body)\n .then((data) => {\n console.log(`putAuthorizationRolesSettings success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling putAuthorizationRolesSettings\");\n console.error(err);\n });" |
| 6450 | + }, |
6430 | 6451 | "putuserroles": { |
6431 | 6452 | "operationId": "putuserroles", |
6432 | 6453 | "functionName": "putUserRoles", |
|
22070 | 22091 | ], |
22071 | 22092 | "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 opts = { \n \"body\": {} // Object | \n};\n\n// Indicate that documents were presented to the user.\napiInstance.postKnowledgeKnowledgebaseDocumentsPresentations(knowledgeBaseId, opts)\n .then(() => {\n console.log(\"postKnowledgeKnowledgebaseDocumentsPresentations returned successfully.\");\n })\n .catch((err) => {\n console.log(\"There was a failure calling postKnowledgeKnowledgebaseDocumentsPresentations\");\n console.error(err);\n });" |
22072 | 22093 | }, |
| 22094 | + "postknowledgeknowledgebasedocumentsquery": { |
| 22095 | + "operationId": "postknowledgeknowledgebasedocumentsquery", |
| 22096 | + "functionName": "postKnowledgeKnowledgebaseDocumentsQuery", |
| 22097 | + "signature": "postKnowledgeKnowledgebaseDocumentsQuery(knowledgeBaseId, expand, body)", |
| 22098 | + "parameters": [ |
| 22099 | + { |
| 22100 | + "name": "knowledgeBaseId", |
| 22101 | + "type": "String", |
| 22102 | + "required": "true" |
| 22103 | + }, |
| 22104 | + { |
| 22105 | + "name": "expand", |
| 22106 | + "type": "[String]", |
| 22107 | + "required": "false" |
| 22108 | + }, |
| 22109 | + { |
| 22110 | + "name": "body", |
| 22111 | + "type": "Object", |
| 22112 | + "required": "false" |
| 22113 | + } |
| 22114 | + ], |
| 22115 | + "return": "KnowledgeDocumentQueryResponse", |
| 22116 | + "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 opts = { \n \"expand\": [\"expand_example\"], // [String] | Fields, if any, to expand for each document in the search result matching the query.\n \"body\": {} // Object | \n};\n\n// Query for knowledge documents.\napiInstance.postKnowledgeKnowledgebaseDocumentsQuery(knowledgeBaseId, opts)\n .then((data) => {\n console.log(`postKnowledgeKnowledgebaseDocumentsQuery success! data: ${JSON.stringify(data, null, 2)}`);\n })\n .catch((err) => {\n console.log(\"There was a failure calling postKnowledgeKnowledgebaseDocumentsQuery\");\n console.error(err);\n });" |
| 22117 | + }, |
22073 | 22118 | "postknowledgeknowledgebasedocumentssearch": { |
22074 | 22119 | "operationId": "postknowledgeknowledgebasedocumentssearch", |
22075 | 22120 | "functionName": "postKnowledgeKnowledgebaseDocumentsSearch", |
|
0 commit comments