@gobodo/gobodo-api 0.1.240 → 1.0.1

package/dist/api/CommentsApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * Comments service.
 * @module api/CommentsApi
-* @version 0.1.240
+* @version 1.0.1
 */
 export default class CommentsApi {
     /**
@@ -14,85 +14,81 @@ export default class CommentsApi {
     constructor(apiClient?: any);
     apiClient: any;
     /**
-     * Callback function to receive the result of the addReplyToComment operation.
-     * @callback module:api/CommentsApi~addReplyToCommentCallback
+     * Callback function to receive the result of the addCommentReply operation.
+     * @callback module:api/CommentsApi~addCommentReplyCallback
      * @param {String} error Error message, if any.
      * @param {module:model/CommentResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Add a reply to a comment
-     * @param {Number} commentId
+     * @param {Number} id
      * @param {module:model/CommentInput} commentInput
      * @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/CommentsApi~addReplyToCommentCallback} callback The callback function, accepting three arguments: error, data, response
+     * @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/CommentsApi~addCommentReplyCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/CommentResponse}
      */
-    addReplyToComment(commentId: number, commentInput: any, opts: any, callback: any): any;
+    addCommentReply(id: number, commentInput: any, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the commentExists operation.
-     * @callback module:api/CommentsApi~commentExistsCallback
+     * Callback function to receive the result of the countCommentsByParent operation.
+     * @callback module:api/CommentsApi~countCommentsByParentCallback
      * @param {String} error Error message, if any.
-     * @param data This operation does not return a value.
+     * @param {module:model/CommentCountResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Check if a comment exists
-     * @param {Number} commentId
+     * @param {Number} parentId
      * @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/CommentsApi~commentExistsCallback} 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/CommentsApi~countCommentsByParentCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/CommentCountResponse}
      */
-    commentExists(commentId: number, opts: any, callback: any): any;
+    countCommentsByParent(parentId: number, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the createComment operation.
      * @callback module:api/CommentsApi~createCommentCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/CommentResponse} data The data returned by the service call.
+     * @param {module:model/CommentOperationResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Create a new comment
+     * Create a comment, or queue it on a batch when batchId is given
      * @param {module:model/CommentInput} commentInput
      * @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} [batchId] Optional batch id to record this operation
+     * @param {String} [batchId]
+     * @param {String} [transactionid] Id of a transaction started with POST /transaction. This write is staged on that transaction (202 with the batch receipt) instead of running now. 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/CommentsApi~createCommentCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/CommentResponse}
+     * data is of type: {@link module:model/CommentOperationResponse}
      */
     createComment(commentInput: any, opts: any, callback: any): any;
     /**
@@ -103,24 +99,22 @@ export default class CommentsApi {
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Delete a comment
-     * @param {Number} commentId
+     * @param {Number} id
      * @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/CommentsApi~deleteCommentCallback} callback The callback function, accepting three arguments: error, data, response
      */
-    deleteComment(commentId: number, opts: any, callback: any): any;
+    deleteComment(id: number, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the getCommentById operation.
      * @callback module:api/CommentsApi~getCommentByIdCallback
@@ -129,110 +123,77 @@ export default class CommentsApi {
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Get a comment by id
-     * @param {Number} commentId
+     * @param {Number} id
      * @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/CommentsApi~getCommentByIdCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/CommentResponse}
      */
-    getCommentById(commentId: number, opts: any, callback: any): any;
-    /**
-     * Callback function to receive the result of the getCommentCount operation.
-     * @callback module:api/CommentsApi~getCommentCountCallback
-     * @param {String} error Error message, if any.
-     * @param {Object} data The data returned by the service call.
-     * @param {String} response The complete HTTP response.
-     */
+    getCommentById(id: number, opts: any, callback: any): any;
     /**
-     * Get count of comments by parent object
-     * @param {Number} parentObjectId
-     * @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/CommentsApi~getCommentCountCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Object}
-     */
-    getCommentCount(parentObjectId: number, opts: any, callback: any): any;
-    /**
-     * Callback function to receive the result of the getCommentReplies operation.
-     * @callback module:api/CommentsApi~getCommentRepliesCallback
+     * Callback function to receive the result of the listCommentReplies operation.
+     * @callback module:api/CommentsApi~listCommentRepliesCallback
      * @param {String} error Error message, if any.
      * @param {Array.<module:model/CommentResponse>} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Get replies to a comment
-     * @param {Number} commentId
+     * @param {Number} id
      * @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 {Number} [pagenum]
-     * @param {Number} [pagesize]
-     * @param {module:api/CommentsApi~getCommentRepliesCallback} callback The callback function, accepting three arguments: error, data, response
+     * @param {Number} [pageNum = 0)]
+     * @param {Number} [pageSize = 100)]
+     * @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/CommentsApi~listCommentRepliesCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link Array.<module:model/CommentResponse>}
      */
-    getCommentReplies(commentId: number, opts: any, callback: any): any;
+    listCommentReplies(id: number, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the getComments operation.
-     * @callback module:api/CommentsApi~getCommentsCallback
+     * Callback function to receive the result of the listCommentsByParent operation.
+     * @callback module:api/CommentsApi~listCommentsByParentCallback
      * @param {String} error Error message, if any.
      * @param {Array.<module:model/CommentResponse>} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Get comments by parent object
-     * @param {Number} parentObjectId
+     * @param {Number} parentId
      * @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 {Number} [pagenum]
-     * @param {Number} [pagesize]
-     * @param {module:api/CommentsApi~getCommentsCallback} callback The callback function, accepting three arguments: error, data, response
+     * @param {Number} [pageNum = 0)]
+     * @param {Number} [pageSize = 100)]
+     * @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/CommentsApi~listCommentsByParentCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link Array.<module:model/CommentResponse>}
      */
-    getComments(parentObjectId: number, opts: any, callback: any): any;
+    listCommentsByParent(parentId: number, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the updateComment operation.
      * @callback module:api/CommentsApi~updateCommentCallback
@@ -241,80 +202,76 @@ export default class CommentsApi {
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Update a comment
-     * @param {Number} commentId
+     * @param {Number} id
      * @param {module:model/CommentInput} commentInput
      * @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/CommentsApi~updateCommentCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/CommentResponse}
      */
-    updateComment(commentId: number, commentInput: any, opts: any, callback: any): any;
+    updateComment(id: number, commentInput: any, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the upsertComment operation.
      * @callback module:api/CommentsApi~upsertCommentCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/CommentResponse} data The data returned by the service call.
+     * @param {module:model/CommentOperationResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
      * Create or update a comment by key
      * @param {module:model/CommentInput} commentInput
      * @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} [batchId] Optional batch id to record this operation
+     * @param {String} [batchId]
+     * @param {String} [transactionid] Id of a transaction started with POST /transaction. This write is staged on that transaction (202 with the batch receipt) instead of running now. 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/CommentsApi~upsertCommentCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/CommentResponse}
+     * data is of type: {@link module:model/CommentOperationResponse}
      */
     upsertComment(commentInput: any, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the upsertComments operation.
      * @callback module:api/CommentsApi~upsertCommentsCallback
      * @param {String} error Error message, if any.
-     * @param {Array.<module:model/CommentResponse>} data The data returned by the service call.
+     * @param {module:model/CommentOperationResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Create or update multiple comments by key
+     * Create or update several comments by key
      * @param {Array.<module:model/CommentInput>} commentInput
      * @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} [batchId] Optional batch id to record this operation
+     * @param {String} [batchId]
+     * @param {String} [transactionid] Id of a transaction started with POST /transaction. This write is staged on that transaction (202 with the batch receipt) instead of running now. 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/CommentsApi~upsertCommentsCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Array.<module:model/CommentResponse>}
+     * data is of type: {@link module:model/CommentOperationResponse}
      */
     upsertComments(commentInput: any, opts: any, callback: any): any;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"CommentsApi.d.ts","sourceRoot":"","sources":["../../src/api/CommentsApi.js"],"names":[],"mappings":"AAmBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAIpD;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,mDAjBW,GAAyB,uBAczB,GAAgD,OA8C1D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,sDAFW,GAA4C,OAyCtD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,4BAlBW,GAAyB,uBAezB,GAA4C,OA0CtD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,sDAFW,GAA4C,OAyCtD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,uDAHW,GAA6C,OA0CvD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,6DAHW,GAA8C,OA0CxD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,0DAHW,GAAgD,OA4C1D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,yDAHW,GAA0C,OA4CpD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,+CAjBW,GAAyB,uBAczB,GAA4C,OA8CtD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,4BAlBW,GAAyB,uBAezB,GAA4C,OA0CtD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,uDAHW,GAA6C,OA0CvD;CAGJ"}
+{"version":3,"file":"CommentsApi.d.ts","sourceRoot":"","sources":["../../src/api/CommentsApi.js"],"names":[],"mappings":"AAoBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAIpD;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,0CAhBW,GAAyB,uBAazB,GAA8C,OA6CxD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,6DAHW,GAAoD,OAyC9D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,4BAjBW,GAAyB,uBAczB,GAA4C,OAyCtD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;OAeG;IACH,+CAFW,GAA4C,OAwCtD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,gDAHW,GAA6C,OAyCvD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,oDAHW,GAAiD,OA2C3D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,4DAHW,GAAmD,OA2C7D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,wCAhBW,GAAyB,uBAazB,GAA4C,OA6CtD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,4BAjBW,GAAyB,uBAczB,GAA4C,OAyCtD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,uDAHW,GAA6C,OAyCvD;CAGJ"}