@gobodo/gobodo-api 0.1.240 → 1.0.1

package/dist/api/PlatformUtilitiesApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * PlatformUtilities service.
 * @module api/PlatformUtilitiesApi
-* @version 1.0.0
+* @version 1.0.1
 */
 export default class PlatformUtilitiesApi {
     /**
@@ -23,10 +23,22 @@ export default class PlatformUtilitiesApi {
     /**
      * Base64-encode a username:password pair for Basic auth
      * @param {String} body
+     * @param {Object} opts Optional parameters
+     * @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/PlatformUtilitiesApi~encodeAuthCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link String}
      */
-    encodeAuth(body: string, callback: any): any;
+    encodeAuth(body: string, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the getMapsClientConfig operation.
      * @callback module:api/PlatformUtilitiesApi~getMapsClientConfigCallback
@@ -36,10 +48,22 @@ export default class PlatformUtilitiesApi {
      */
     /**
      * Public maps provider bootstrap for browser clients
+     * @param {Object} opts Optional parameters
+     * @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/PlatformUtilitiesApi~getMapsClientConfigCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/MapsClientConfigResponse}
      */
-    getMapsClientConfig(callback: any): any;
+    getMapsClientConfig(opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the purgeObjects operation.
      * @callback module:api/PlatformUtilitiesApi~purgeObjectsCallback
@@ -53,6 +77,17 @@ export default class PlatformUtilitiesApi {
      * @param {String} [type]
      * @param {Number} [days]
      * @param {String} [range]
+     * @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/PlatformUtilitiesApi~purgeObjectsCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/DataPurgeResponse}
      */

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

@@ -1 +1 @@
-{"version":3,"file":"PlatformUtilitiesApi.d.ts","sourceRoot":"","sources":["../../src/api/PlatformUtilitiesApi.js"],"names":[],"mappings":"AAkBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAIpD;;;;;;OAMG;IAEH;;;;;OAKG;IACH,mCAHW,GAAkD,OA4B5D;IAED;;;;;;OAMG;IAEH;;;;OAIG;IACH,8BAHW,GAA2D,OAwBrE;IAED;;;;;;OAMG;IAEH;;;;;;;;OAQG;IACH,kCAHW,GAAoD,OA4B9D;CAGJ"}
+{"version":3,"file":"PlatformUtilitiesApi.d.ts","sourceRoot":"","sources":["../../src/api/PlatformUtilitiesApi.js"],"names":[],"mappings":"AAkBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAIpD;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,8CAHW,GAAkD,OAwC5D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,yCAHW,GAA2D,OAoCrE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,kCAHW,GAAoD,OAuC9D;CAGJ"}

package/dist/api/PlatformUtilitiesApi.js

@@ -17,7 +17,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  * Gobodo Spring API
  * Typed Spring MVC v1 API for Gobodo graph metadata.
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.0.1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,7 +28,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * PlatformUtilities service.
 * @module api/PlatformUtilitiesApi
-* @version 1.0.0
+* @version 1.0.1
 */
 var PlatformUtilitiesApi = exports["default"] = /*#__PURE__*/function () {
   /**
@@ -54,20 +54,46 @@ var PlatformUtilitiesApi = exports["default"] = /*#__PURE__*/function () {
   /**
    * Base64-encode a username:password pair for Basic auth
    * @param {String} body 
+   * @param {Object} opts Optional parameters
+   * @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/PlatformUtilitiesApi~encodeAuthCallback} callback The callback function, accepting three arguments: error, data, response
    * data is of type: {@link String}
    */
   return _createClass(PlatformUtilitiesApi, [{
     key: "encodeAuth",
-    value: function encodeAuth(body, callback) {
+    value: function encodeAuth(body, opts, callback) {
+      opts = opts || {};
       var postBody = body;
       // verify the required parameter 'body' is set
       if (body === undefined || body === null) {
         throw new Error("Missing the required parameter 'body' when calling encodeAuth");
       }
       var pathParams = {};
-      var queryParams = {};
-      var headerParams = {};
+      var queryParams = {
+        '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': opts['invalidationkeys']
+      };
+      var headerParams = {
+        'transactionid': opts['transactionid'],
+        'zeusportal-postas': opts['zeusportalPostas'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
+        'zeusportal-postas-site': opts['zeusportalPostasSite'],
+        'zeusportal-postas-org': opts['zeusportalPostasOrg']
+      };
       var formParams = {};
       var authNames = ['apiKey', 'bearerAuth'];
       var contentTypes = ['text/plain'];
@@ -86,16 +112,42 @@ var PlatformUtilitiesApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Public maps provider bootstrap for browser clients
+     * @param {Object} opts Optional parameters
+     * @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/PlatformUtilitiesApi~getMapsClientConfigCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/MapsClientConfigResponse}
      */
   }, {
     key: "getMapsClientConfig",
-    value: function getMapsClientConfig(callback) {
+    value: function getMapsClientConfig(opts, callback) {
+      opts = opts || {};
       var postBody = null;
       var pathParams = {};
-      var queryParams = {};
-      var headerParams = {};
+      var queryParams = {
+        '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': opts['invalidationkeys']
+      };
+      var headerParams = {
+        'transactionid': opts['transactionid'],
+        'zeusportal-postas': opts['zeusportalPostas'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
+        'zeusportal-postas-site': opts['zeusportalPostasSite'],
+        'zeusportal-postas-org': opts['zeusportalPostasOrg']
+      };
       var formParams = {};
       var authNames = ['apiKey', 'bearerAuth'];
       var contentTypes = [];
@@ -118,6 +170,17 @@ var PlatformUtilitiesApi = exports["default"] = /*#__PURE__*/function () {
      * @param {String} [type] 
      * @param {Number} [days] 
      * @param {String} [range] 
+     * @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/PlatformUtilitiesApi~purgeObjectsCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/DataPurgeResponse}
      */
@@ -130,9 +193,21 @@ var PlatformUtilitiesApi = exports["default"] = /*#__PURE__*/function () {
       var queryParams = {
         'type': opts['type'],
         'days': opts['days'],
-        'range': opts['range']
+        'range': opts['range'],
+        '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': opts['invalidationkeys']
+      };
+      var headerParams = {
+        'transactionid': opts['transactionid'],
+        'zeusportal-postas': opts['zeusportalPostas'],
+        'zeusportal-postas-app': opts['zeusportalPostasApp'],
+        'zeusportal-postas-site': opts['zeusportalPostasSite'],
+        'zeusportal-postas-org': opts['zeusportalPostasOrg']
       };
-      var headerParams = {};
       var formParams = {};
       var authNames = ['apiKey', 'bearerAuth'];
       var contentTypes = [];