@gobodo/gobodo-api 0.1.239 → 1.0.0

package/dist/api/AbilitiesApi.js

@@ -7,7 +7,6 @@ exports["default"] = void 0;
 var _ApiClient = _interopRequireDefault(require("../ApiClient"));
 var _AbilityResponse = _interopRequireDefault(require("../model/AbilityResponse"));
 var _AuthorizationCheckResponse = _interopRequireDefault(require("../model/AuthorizationCheckResponse"));
-var _CacheInvalidation = _interopRequireDefault(require("../model/CacheInvalidation"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
 function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
 function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
@@ -15,11 +14,11 @@ function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o =
 function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /**
- * gobodo-api
- * REST Interface for Gobodo API
+ * Gobodo Spring API
+ * Typed Spring MVC v1 API for Gobodo graph metadata.
  *
- * The version of the OpenAPI document: 0.1.239
- * Contact: info@gobodo.io
+ * The version of the OpenAPI document: 1.0.0
+ * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -29,7 +28,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * Abilities service.
 * @module api/AbilitiesApi
-* @version 0.1.239
+* @version 1.0.0
 */
 var AbilitiesApi = exports["default"] = /*#__PURE__*/function () {
   /**
@@ -45,194 +44,182 @@ var AbilitiesApi = exports["default"] = /*#__PURE__*/function () {
   }
 
   /**
-   * Callback function to receive the result of the checkAuthorization operation.
-   * @callback module:api/AbilitiesApi~checkAuthorizationCallback
+   * Callback function to receive the result of the checkObjectAuthorization operation.
+   * @callback module:api/AbilitiesApi~checkObjectAuthorizationCallback
    * @param {String} error Error message, if any.
    * @param {module:model/AuthorizationCheckResponse} data The data returned by the service call.
    * @param {String} response The complete HTTP response.
    */
 
   /**
-   * Check if user is authorized for a permission
-   * Returns a simple true/false indicating if the current user has the specified permission on the object. The permission parameter must be a valid permission name from the PermissionType enum (e.g., 'CREATE_COMMENT', 'READ_GRAPH_OBJECT', 'PORTAL_ADMIN'). See PermissionType enum for all valid permission names.
    * @param {Number} objectId 
-   * @param {module:model/String} permission The permission to check. Must be one of the PermissionType enum values (e.g., CREATE_COMMENT, READ_GRAPH_OBJECT, PORTAL_ADMIN)
+   * @param {String} permission 
    * @param {Object} opts Optional parameters
-   * @param {String} [authorization] The authorization token of the logged in user
-   * @param {Number} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
-   * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to. May be provided as repeated query params.
-   * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
-   * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
-   * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user). May be provided as repeated query params.
-   * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation. May be provided as repeated query params or as a JSON array string.
-   * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
-   * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
-   * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
-   * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
-   * @param {String} [transactionid] The id of the transaction this operation is being run in
-   * @param {module:api/AbilitiesApi~checkAuthorizationCallback} callback The callback function, accepting three arguments: error, data, response
+   * @param {String} [transactionid] Ignored on reads. Alias: X-Gobodo-Transaction-Id.
+   * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+   * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+   * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+   * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+   * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+   * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+   * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+   * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+   * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+   * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
+   * @param {module:api/AbilitiesApi~checkObjectAuthorizationCallback} callback The callback function, accepting three arguments: error, data, response
    * data is of type: {@link module:model/AuthorizationCheckResponse}
    */
   return _createClass(AbilitiesApi, [{
-    key: "checkAuthorization",
-    value: function checkAuthorization(objectId, permission, opts, callback) {
+    key: "checkObjectAuthorization",
+    value: function checkObjectAuthorization(objectId, permission, opts, callback) {
       opts = opts || {};
       var postBody = null;
       // verify the required parameter 'objectId' is set
       if (objectId === undefined || objectId === null) {
-        throw new Error("Missing the required parameter 'objectId' when calling checkAuthorization");
+        throw new Error("Missing the required parameter 'objectId' when calling checkObjectAuthorization");
       }
       // verify the required parameter 'permission' is set
       if (permission === undefined || permission === null) {
-        throw new Error("Missing the required parameter 'permission' when calling checkAuthorization");
+        throw new Error("Missing the required parameter 'permission' when calling checkObjectAuthorization");
       }
       var pathParams = {
         'objectId': objectId
       };
       var queryParams = {
-        'cacheduration': opts['cacheduration'],
-        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
+        'permission': permission,
         'cachekey': this.apiClient.buildCollectionParam(opts['cachekey'], 'multi'),
         'cachescope': opts['cachescope'],
+        'cacheduration': opts['cacheduration'],
+        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
         'cacheuser': this.apiClient.buildCollectionParam(opts['cacheuser'], 'multi'),
-        'invalidationkeys': this.apiClient.buildCollectionParam(opts['invalidationkeys'], 'multi'),
-        'permission': permission
+        'invalidationkeys': opts['invalidationkeys']
       };
       var headerParams = {
-        'Authorization': opts['authorization'],
-        'zeusportal-postas-app': opts['zeusportalPostasApp'],
-        'zeusportal-postas-org': opts['zeusportalPostasOrg'],
+        'transactionid': opts['transactionid'],
         'zeusportal-postas': opts['zeusportalPostas'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
         'zeusportal-postas-site': opts['zeusportalPostasSite'],
-        'transactionid': opts['transactionid']
+        'zeusportal-postas-org': opts['zeusportalPostasOrg']
       };
       var formParams = {};
-      var authNames = ['NexusGraphAPIAuth', 'NexusGraphAPIKey'];
+      var authNames = ['apiKey', 'bearerAuth'];
       var contentTypes = [];
-      var accepts = ['application/json'];
+      var accepts = ['*/*'];
       var returnType = _AuthorizationCheckResponse["default"];
       return this.apiClient.callApi('/abilities/check/{objectId}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
 
     /**
-     * Callback function to receive the result of the getAbilitiesForObject operation.
-     * @callback module:api/AbilitiesApi~getAbilitiesForObjectCallback
+     * Callback function to receive the result of the getMyAbilities operation.
+     * @callback module:api/AbilitiesApi~getMyAbilitiesCallback
      * @param {String} error Error message, if any.
      * @param {Array.<module:model/AbilityResponse>} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
 
     /**
-     * Get user abilities for an object
-     * Returns a CASL-compatible list of abilities/permissions the current user has on the specified graph object
-     * @param {Number} objectId 
      * @param {Object} opts Optional parameters
-     * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to. May be provided as repeated query params.
-     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
-     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user). May be provided as repeated query params.
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation. May be provided as repeated query params or as a JSON array string.
-     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
-     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
-     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
-     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
-     * @param {String} [transactionid] The id of the transaction this operation is being run in
-     * @param {module:api/AbilitiesApi~getAbilitiesForObjectCallback} callback The callback function, accepting three arguments: error, data, response
+     * @param {String} [transactionid] Ignored on reads. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
+     * @param {module:api/AbilitiesApi~getMyAbilitiesCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link Array.<module:model/AbilityResponse>}
      */
   }, {
-    key: "getAbilitiesForObject",
-    value: function getAbilitiesForObject(objectId, opts, callback) {
+    key: "getMyAbilities",
+    value: function getMyAbilities(opts, callback) {
       opts = opts || {};
       var postBody = null;
-      // verify the required parameter 'objectId' is set
-      if (objectId === undefined || objectId === null) {
-        throw new Error("Missing the required parameter 'objectId' when calling getAbilitiesForObject");
-      }
-      var pathParams = {
-        'objectId': objectId
-      };
+      var pathParams = {};
       var queryParams = {
-        'cacheduration': opts['cacheduration'],
-        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
         'cachekey': this.apiClient.buildCollectionParam(opts['cachekey'], 'multi'),
         'cachescope': opts['cachescope'],
+        'cacheduration': opts['cacheduration'],
+        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
         'cacheuser': this.apiClient.buildCollectionParam(opts['cacheuser'], 'multi'),
-        'invalidationkeys': this.apiClient.buildCollectionParam(opts['invalidationkeys'], 'multi')
+        'invalidationkeys': opts['invalidationkeys']
       };
       var headerParams = {
-        'Authorization': opts['authorization'],
-        'zeusportal-postas-app': opts['zeusportalPostasApp'],
-        'zeusportal-postas-org': opts['zeusportalPostasOrg'],
+        'transactionid': opts['transactionid'],
         'zeusportal-postas': opts['zeusportalPostas'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
         'zeusportal-postas-site': opts['zeusportalPostasSite'],
-        'transactionid': opts['transactionid']
+        'zeusportal-postas-org': opts['zeusportalPostasOrg']
       };
       var formParams = {};
-      var authNames = ['NexusGraphAPIAuth', 'NexusGraphAPIKey'];
+      var authNames = ['apiKey', 'bearerAuth'];
       var contentTypes = [];
-      var accepts = ['application/json'];
+      var accepts = ['*/*'];
       var returnType = [_AbilityResponse["default"]];
-      return this.apiClient.callApi('/abilities/object/{objectId}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+      return this.apiClient.callApi('/abilities/me', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
 
     /**
-     * Callback function to receive the result of the getMyAbilities operation.
-     * @callback module:api/AbilitiesApi~getMyAbilitiesCallback
+     * Callback function to receive the result of the getObjectAbilities operation.
+     * @callback module:api/AbilitiesApi~getObjectAbilitiesCallback
      * @param {String} error Error message, if any.
      * @param {Array.<module:model/AbilityResponse>} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
 
     /**
-     * Get current user's global abilities
-     * Returns a CASL-compatible list of global abilities/permissions for the current user
+     * @param {Number} objectId 
      * @param {Object} opts Optional parameters
-     * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to. May be provided as repeated query params.
-     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
-     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user). May be provided as repeated query params.
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation. May be provided as repeated query params or as a JSON array string.
-     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
-     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
-     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
-     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
-     * @param {String} [transactionid] The id of the transaction this operation is being run in
-     * @param {module:api/AbilitiesApi~getMyAbilitiesCallback} callback The callback function, accepting three arguments: error, data, response
+     * @param {String} [transactionid] Ignored on reads. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
+     * @param {module:api/AbilitiesApi~getObjectAbilitiesCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link Array.<module:model/AbilityResponse>}
      */
   }, {
-    key: "getMyAbilities",
-    value: function getMyAbilities(opts, callback) {
+    key: "getObjectAbilities",
+    value: function getObjectAbilities(objectId, opts, callback) {
       opts = opts || {};
       var postBody = null;
-      var pathParams = {};
+      // verify the required parameter 'objectId' is set
+      if (objectId === undefined || objectId === null) {
+        throw new Error("Missing the required parameter 'objectId' when calling getObjectAbilities");
+      }
+      var pathParams = {
+        'objectId': objectId
+      };
       var queryParams = {
-        'cacheduration': opts['cacheduration'],
-        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
         'cachekey': this.apiClient.buildCollectionParam(opts['cachekey'], 'multi'),
         'cachescope': opts['cachescope'],
+        'cacheduration': opts['cacheduration'],
+        'cachegroup': this.apiClient.buildCollectionParam(opts['cachegroup'], 'multi'),
         'cacheuser': this.apiClient.buildCollectionParam(opts['cacheuser'], 'multi'),
-        'invalidationkeys': this.apiClient.buildCollectionParam(opts['invalidationkeys'], 'multi')
+        'invalidationkeys': opts['invalidationkeys']
       };
       var headerParams = {
-        'Authorization': opts['authorization'],
-        'zeusportal-postas-app': opts['zeusportalPostasApp'],
-        'zeusportal-postas-org': opts['zeusportalPostasOrg'],
+        'transactionid': opts['transactionid'],
         'zeusportal-postas': opts['zeusportalPostas'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
         'zeusportal-postas-site': opts['zeusportalPostasSite'],
-        'transactionid': opts['transactionid']
+        'zeusportal-postas-org': opts['zeusportalPostasOrg']
       };
       var formParams = {};
-      var authNames = ['NexusGraphAPIAuth', 'NexusGraphAPIKey'];
+      var authNames = ['apiKey', 'bearerAuth'];
       var contentTypes = [];
-      var accepts = ['application/json'];
+      var accepts = ['*/*'];
       var returnType = [_AbilityResponse["default"]];
-      return this.apiClient.callApi('/abilities/me', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+      return this.apiClient.callApi('/abilities/object/{objectId}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
     }
   }]);
 }();

package/dist/api/AdminRequestLogConfigApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * AdminRequestLogConfig service.
 * @module api/AdminRequestLogConfigApi
-* @version 0.1.239
+* @version 1.0.0
 */
 export default class AdminRequestLogConfigApi {
     /**
@@ -17,53 +17,49 @@ export default class AdminRequestLogConfigApi {
      * Callback function to receive the result of the getGlobalRequestLogConfig operation.
      * @callback module:api/AdminRequestLogConfigApi~getGlobalRequestLogConfigCallback
      * @param {String} error Error message, if any.
-     * @param data This operation does not return a value.
+     * @param {module:model/RequestLogConfigResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Get global request log configuration
-     * Returns the global request logging enabled flag. Requires CATEGORY_ADMIN on the root category.
      * @param {Object} opts Optional parameters
-     * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to. May be provided as repeated query params.
-     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
-     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user). May be provided as repeated query params.
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation. May be provided as repeated query params or as a JSON array string.
-     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
-     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
-     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
-     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
-     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {String} [transactionid] Ignored on reads. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
      * @param {module:api/AdminRequestLogConfigApi~getGlobalRequestLogConfigCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/RequestLogConfigResponse}
      */
     getGlobalRequestLogConfig(opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the updateGlobalRequestLogConfig operation.
      * @callback module:api/AdminRequestLogConfigApi~updateGlobalRequestLogConfigCallback
      * @param {String} error Error message, if any.
-     * @param data This operation does not return a value.
+     * @param {module:model/RequestLogConfigResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Update global request log configuration
-     * Updates the global request logging enabled flag. Requires CATEGORY_ADMIN on the root category.
      * @param {module:model/RequestLogConfigRequest} requestLogConfigRequest
      * @param {Object} opts Optional parameters
-     * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to. May be provided as repeated query params.
-     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
-     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
-     * @param {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user). May be provided as repeated query params.
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation. May be provided as repeated query params or as a JSON array string.
-     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
-     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
-     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
-     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
-     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {String} [transactionid] Not supported here: this write cannot be staged, so a request carrying a transaction id is rejected with 400 rather than run outside the transaction. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
      * @param {module:api/AdminRequestLogConfigApi~updateGlobalRequestLogConfigCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/RequestLogConfigResponse}
      */
     updateGlobalRequestLogConfig(requestLogConfigRequest: any, opts: any, callback: any): any;
 }

package/dist/api/AdminRequestLogConfigApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AdminRequestLogConfigApi.d.ts","sourceRoot":"","sources":["../../src/api/AdminRequestLogConfigApi.js"],"names":[],"mappings":"AAkBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAIpD;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,+CAFW,GAAqE,OAoC/E;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,sDAhBW,GAAoC,uBAcpC,GAAwE,OAwClF;CAGJ"}
+{"version":3,"file":"AdminRequestLogConfigApi.d.ts","sourceRoot":"","sources":["../../src/api/AdminRequestLogConfigApi.js"],"names":[],"mappings":"AAkBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAIpD;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;OAeG;IACH,+CAHW,GAAqE,OAoC/E;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,sDAhBW,GAAoC,uBAapC,GAAwE,OAwClF;CAGJ"}