@gobodo/gobodo-api 0.1.181 → 0.1.183

package/dist/api/PrivateMessagesApi.js

@@ -20,7 +20,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  * gobodo-api
  * REST Interface for Gobodo API
  *
- * The version of the OpenAPI document: 0.1.181
+ * The version of the OpenAPI document: 0.1.183
  * Contact: info@gobodo.io
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -31,7 +31,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * PrivateMessages service.
 * @module api/PrivateMessagesApi
-* @version 0.1.181
+* @version 0.1.183
 */
 var PrivateMessagesApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/api/ProxyServersApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * ProxyServers service.
 * @module api/ProxyServersApi
-* @version 0.1.181
+* @version 0.1.183
 */
 export default class ProxyServersApi {
     /**
@@ -53,7 +53,7 @@ export default class ProxyServersApi {
      */
     /**
      * Create Proxy Server
-     * Requires CATEGORY_ADMIN on root category.
+     * Requires CATEGORY_ADMIN on root category, or on the container when container is a Site or RestApplicationRoot.
      * @param {module:model/ProxyServerInput} proxyServerInput Proxy server with targetUrl and optional name
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
@@ -135,7 +135,7 @@ export default class ProxyServersApi {
      */
     /**
      * Invoke Proxy (GET)
-     * Forwards GET request to the proxy's target URL. Optional 'path' query param appends to target URL.
+     * Forwards GET to the proxy target. Use the 'path' query parameter for the path suffix. Add any query parameters to the request URL; they are forwarded to the target. For path-in-query style, the 'path' parameter is used only as the path suffix and is not forwarded. Generated clients should append desired query parameters to the request URL (e.g. ?category=books&limit=10).  When the proxy requires authentication, unauthenticated callers receive 401.
      * @param {Number} id
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
@@ -150,10 +150,38 @@ export default class ProxyServersApi {
      * @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} [path] Optional path suffix to append to target URL
+     * @param {String} [path] Optional path suffix to append to target URL (not forwarded to target)
      * @param {module:api/ProxyServersApi~invokeProxyServerGetCallback} callback The callback function, accepting three arguments: error, data, response
      */
     invokeProxyServerGet(id: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the invokeProxyServerGetWithPathInUrl operation.
+     * @callback module:api/ProxyServersApi~invokeProxyServerGetWithPathInUrlCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Invoke Proxy (GET) with path in URL
+     * Forwards GET to the proxy target. Path suffix is taken from the URL (e.g. /proxyservers/1/invoke/api/foo). Add any query parameters to the request URL; they are forwarded to the target. For path-in-query style, the 'path' parameter is used only as the path suffix and is not forwarded. Generated clients should append desired query parameters to the request URL (e.g. ?category=books&limit=10).  When the proxy requires authentication, unauthenticated callers receive 401.
+     * @param {Number} id
+     * @param {String} path Path suffix appended to target URL
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @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)
+     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
+     * @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/ProxyServersApi~invokeProxyServerGetWithPathInUrlCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    invokeProxyServerGetWithPathInUrl(id: number, path: string, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the invokeProxyServerPatch operation.
      * @callback module:api/ProxyServersApi~invokeProxyServerPatchCallback
@@ -163,7 +191,7 @@ export default class ProxyServersApi {
      */
     /**
      * Invoke Proxy (PATCH)
-     * Forwards PATCH request to the proxy's target URL. Optional 'path' query param appends to target URL. Request body is forwarded.
+     * Forwards PATCH to the proxy target. Use 'path' query parameter for the path suffix. Add any query parameters to the request URL; they are forwarded to the target. For path-in-query style, the 'path' parameter is used only as the path suffix and is not forwarded. Generated clients should append desired query parameters to the request URL (e.g. ?category=books&limit=10).  Request body is forwarded. When the proxy requires authentication, unauthenticated callers receive 401.
      * @param {Number} id
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
@@ -178,10 +206,38 @@ export default class ProxyServersApi {
      * @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} [path] Optional path suffix to append to target URL
+     * @param {String} [path] Optional path suffix to append to target URL (not forwarded to target)
      * @param {module:api/ProxyServersApi~invokeProxyServerPatchCallback} callback The callback function, accepting three arguments: error, data, response
      */
     invokeProxyServerPatch(id: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the invokeProxyServerPatchWithPathInUrl operation.
+     * @callback module:api/ProxyServersApi~invokeProxyServerPatchWithPathInUrlCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Invoke Proxy (PATCH) with path in URL
+     * Forwards PATCH to the proxy target. Path suffix is taken from the URL. Add any query parameters to the request URL; they are forwarded to the target. For path-in-query style, the 'path' parameter is used only as the path suffix and is not forwarded. Generated clients should append desired query parameters to the request URL (e.g. ?category=books&limit=10).  Request body is forwarded. When the proxy requires authentication, unauthenticated callers receive 401.
+     * @param {Number} id
+     * @param {String} path Path suffix appended to target URL
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @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)
+     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
+     * @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/ProxyServersApi~invokeProxyServerPatchWithPathInUrlCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    invokeProxyServerPatchWithPathInUrl(id: number, path: string, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the invokeProxyServerPost operation.
      * @callback module:api/ProxyServersApi~invokeProxyServerPostCallback
@@ -191,7 +247,7 @@ export default class ProxyServersApi {
      */
     /**
      * Invoke Proxy (POST)
-     * Forwards POST request to the proxy's target URL. Optional 'path' query param appends to target URL. Request body is forwarded.
+     * Forwards POST to the proxy target. Use 'path' query parameter for the path suffix. Add any query parameters to the request URL; they are forwarded to the target. For path-in-query style, the 'path' parameter is used only as the path suffix and is not forwarded. Generated clients should append desired query parameters to the request URL (e.g. ?category=books&limit=10).  Request body is forwarded. When the proxy requires authentication, unauthenticated callers receive 401.
      * @param {Number} id
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
@@ -206,10 +262,38 @@ export default class ProxyServersApi {
      * @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} [path] Optional path suffix to append to target URL
+     * @param {String} [path] Optional path suffix to append to target URL (not forwarded to target)
      * @param {module:api/ProxyServersApi~invokeProxyServerPostCallback} callback The callback function, accepting three arguments: error, data, response
      */
     invokeProxyServerPost(id: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the invokeProxyServerPostWithPathInUrl operation.
+     * @callback module:api/ProxyServersApi~invokeProxyServerPostWithPathInUrlCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Invoke Proxy (POST) with path in URL
+     * Forwards POST to the proxy target. Path suffix is taken from the URL. Add any query parameters to the request URL; they are forwarded to the target. For path-in-query style, the 'path' parameter is used only as the path suffix and is not forwarded. Generated clients should append desired query parameters to the request URL (e.g. ?category=books&limit=10).  Request body is forwarded. When the proxy requires authentication, unauthenticated callers receive 401.
+     * @param {Number} id
+     * @param {String} path Path suffix appended to target URL
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @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)
+     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
+     * @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/ProxyServersApi~invokeProxyServerPostWithPathInUrlCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    invokeProxyServerPostWithPathInUrl(id: number, path: string, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the invokeProxyServerPut operation.
      * @callback module:api/ProxyServersApi~invokeProxyServerPutCallback
@@ -219,7 +303,7 @@ export default class ProxyServersApi {
      */
     /**
      * Invoke Proxy (PUT)
-     * Forwards PUT request to the proxy's target URL. Optional 'path' query param appends to target URL. Request body is forwarded.
+     * Forwards PUT to the proxy target. Use 'path' query parameter for the path suffix. Add any query parameters to the request URL; they are forwarded to the target. For path-in-query style, the 'path' parameter is used only as the path suffix and is not forwarded. Generated clients should append desired query parameters to the request URL (e.g. ?category=books&limit=10).  Request body is forwarded. When the proxy requires authentication, unauthenticated callers receive 401.
      * @param {Number} id
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
@@ -234,10 +318,38 @@ export default class ProxyServersApi {
      * @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} [path] Optional path suffix to append to target URL
+     * @param {String} [path] Optional path suffix to append to target URL (not forwarded to target)
      * @param {module:api/ProxyServersApi~invokeProxyServerPutCallback} callback The callback function, accepting three arguments: error, data, response
      */
     invokeProxyServerPut(id: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the invokeProxyServerPutWithPathInUrl operation.
+     * @callback module:api/ProxyServersApi~invokeProxyServerPutWithPathInUrlCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Invoke Proxy (PUT) with path in URL
+     * Forwards PUT to the proxy target. Path suffix is taken from the URL. Add any query parameters to the request URL; they are forwarded to the target. For path-in-query style, the 'path' parameter is used only as the path suffix and is not forwarded. Generated clients should append desired query parameters to the request URL (e.g. ?category=books&limit=10).  Request body is forwarded. When the proxy requires authentication, unauthenticated callers receive 401.
+     * @param {Number} id
+     * @param {String} path Path suffix appended to target URL
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @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)
+     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation
+     * @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/ProxyServersApi~invokeProxyServerPutWithPathInUrlCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    invokeProxyServerPutWithPathInUrl(id: number, path: string, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the listProxyServers operation.
      * @callback module:api/ProxyServersApi~listProxyServersCallback