@gobodo/gobodo-api 0.1.111 → 0.1.113

package/dist/api/PostsApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * Posts service.
 * @module api/PostsApi
-* @version 0.1.111
+* @version 0.1.113
 */
 export default class PostsApi {
     /**
@@ -17,11 +17,12 @@ export default class PostsApi {
      * Callback function to receive the result of the createPost operation.
      * @callback module:api/PostsApi~createPostCallback
      * @param {String} error Error message, if any.
-     * @param {Array.<module:model/Post>} data The data returned by the service call.
+     * @param {module:model/PostResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * @param {Array.<module:model/Post>} post Post or array of posts to create
+     * Create a new post
+     * @param {module:model/PostInput} postInput
      * @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
@@ -36,18 +37,19 @@ export default class PostsApi {
      * @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/PostsApi~createPostCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Array.<module:model/Post>}
+     * data is of type: {@link module:model/PostResponse}
      */
-    createPost(post: any, opts: any, callback: any): any;
+    createPost(postInput: any, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the get25 operation.
-     * @callback module:api/PostsApi~get25Callback
+     * Callback function to receive the result of the deletePost operation.
+     * @callback module:api/PostsApi~deletePostCallback
      * @param {String} error Error message, if any.
      * @param data This operation does not return a value.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Root for the API
+     * Delete a post
+     * @param {Number} postId
      * @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
@@ -61,20 +63,47 @@ export default class PostsApi {
      * @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/PostsApi~get25Callback} callback The callback function, accepting three arguments: error, data, response
+     * @param {module:api/PostsApi~deletePostCallback} callback The callback function, accepting three arguments: error, data, response
      */
-    get25(opts: any, callback: any): any;
+    deletePost(postId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getAllPosts operation.
+     * @callback module:api/PostsApi~getAllPostsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/PostResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get all posts
+     * @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 {Number} [pagenum]
+     * @param {Number} [pagesize]
+     * @param {module:api/PostsApi~getAllPostsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/PostResponse>}
+     */
+    getAllPosts(opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the getPostById operation.
      * @callback module:api/PostsApi~getPostByIdCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/Post} data The data returned by the service call.
+     * @param {module:model/PostResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Gets a post by id
-     * Gets a post by id
-     * @param {Number} id
+     * Get a post by id
+     * @param {Number} postId
      * @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
@@ -89,19 +118,133 @@ export default class PostsApi {
      * @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/PostsApi~getPostByIdCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/Post}
+     * data is of type: {@link module:model/PostResponse}
+     */
+    getPostById(postId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getPostsByMember operation.
+     * @callback module:api/PostsApi~getPostsByMemberCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/PostResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get posts by member
+     * @param {Number} memberId
+     * @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 {Number} [pagenum]
+     * @param {Number} [pagesize]
+     * @param {module:api/PostsApi~getPostsByMemberCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/PostResponse>}
+     */
+    getPostsByMember(memberId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getPostsByParentObject operation.
+     * @callback module:api/PostsApi~getPostsByParentObjectCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/PostResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get posts 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] 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 {Number} [pagenum]
+     * @param {Number} [pagesize]
+     * @param {module:api/PostsApi~getPostsByParentObjectCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/PostResponse>}
+     */
+    getPostsByParentObject(parentObjectId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the postExists operation.
+     * @callback module:api/PostsApi~postExistsCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Check if a post exists
+     * @param {Number} postId
+     * @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/PostsApi~postExistsCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    postExists(postId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the searchPosts operation.
+     * @callback module:api/PostsApi~searchPostsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/PostResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Search posts by subject or body content
+     * @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 {String} [q]
+     * @param {Number} [pagenum]
+     * @param {Number} [pagesize]
+     * @param {module:api/PostsApi~searchPostsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/PostResponse>}
      */
-    getPostById(id: number, opts: any, callback: any): any;
+    searchPosts(opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the updatePost operation.
      * @callback module:api/PostsApi~updatePostCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/Post} data The data returned by the service call.
+     * @param {module:model/PostResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * @param {Number} id
-     * @param {module:model/Post} post Post to update
+     * Update a post
+     * @param {Number} postId
+     * @param {module:model/PostInput} postInput
      * @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
@@ -116,7 +259,7 @@ export default class PostsApi {
      * @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/PostsApi~updatePostCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/Post}
+     * data is of type: {@link module:model/PostResponse}
      */
-    updatePost(id: number, post: any, opts: any, callback: any): any;
+    updatePost(postId: number, postInput: any, opts: any, callback: any): any;
 }