@gobodo/gobodo-api 0.1.197 → 0.1.198

package/dist/api/PrivateMessagesApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * PrivateMessages service.
 * @module api/PrivateMessagesApi
-* @version 0.1.197
+* @version 0.1.198
 */
 export default class PrivateMessagesApi {
     /**
@@ -13,44 +13,17 @@ export default class PrivateMessagesApi {
     */
     constructor(apiClient?: any);
     apiClient: any;
-    /**
-     * Callback function to receive the result of the createBranch operation.
-     * @callback module:api/PrivateMessagesApi~createBranchCallback
-     * @param {String} error Error message, if any.
-     * @param {module:model/PrivateMessage} data The data returned by the service call.
-     * @param {String} response The complete HTTP response.
-     */
-    /**
-     * @param {Number} messageid
-     * @param {module:model/PrivateMessage} privateMessage Private Message Object
-     * @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/PrivateMessagesApi~createBranchCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/PrivateMessage}
-     */
-    createBranch(messageid: number, privateMessage: any, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the createConversation operation.
      * @callback module:api/PrivateMessagesApi~createConversationCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/PrivateMessageConversation} data The data returned by the service call.
+     * @param {module:model/PrivateMessageConversationResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Create conversation(s)
-     * Create a new conversation or list of conversations.
-     * @param {module:model/PrivateMessageConversationSchema} privateMessageConversationSchema Conversation object or array of objects to create
+     * Create conversation
+     * Create a new conversation.
+     * @param {module:model/PrivateMessageConversationPayload} privateMessageConversationPayload
      * @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
@@ -65,19 +38,21 @@ export default class PrivateMessagesApi {
      * @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/PrivateMessagesApi~createConversationCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/PrivateMessageConversation}
+     * data is of type: {@link module:model/PrivateMessageConversationResponse}
      */
-    createConversation(privateMessageConversationSchema: any, opts: any, callback: any): any;
+    createConversation(privateMessageConversationPayload: any, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the createReply operation.
-     * @callback module:api/PrivateMessagesApi~createReplyCallback
+     * Callback function to receive the result of the createPrivateMessageBranch operation.
+     * @callback module:api/PrivateMessagesApi~createPrivateMessageBranchCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/PrivateMessage} data The data returned by the service call.
+     * @param {module:model/PrivateMessageResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * @param {Number} messageid
-     * @param {module:model/PrivateMessage} privateMessage Private Message Object
+     * Create branch
+     * Creates and returns a new private message in a new branch conversation
+     * @param {Number} messageId
+     * @param {module:model/PrivateMessageInput} privateMessageInput
      * @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
@@ -91,19 +66,22 @@ export default class PrivateMessagesApi {
      * @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/PrivateMessagesApi~createReplyCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/PrivateMessage}
+     * @param {module:api/PrivateMessagesApi~createPrivateMessageBranchCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/PrivateMessageResponse}
      */
-    createReply(messageid: number, privateMessage: any, opts: any, callback: any): any;
+    createPrivateMessageBranch(messageId: number, privateMessageInput: any, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the deleteMessage operation.
-     * @callback module:api/PrivateMessagesApi~deleteMessageCallback
+     * Callback function to receive the result of the createPrivateMessageReply operation.
+     * @callback module:api/PrivateMessagesApi~createPrivateMessageReplyCallback
      * @param {String} error Error message, if any.
-     * @param data This operation does not return a value.
+     * @param {module:model/PrivateMessageResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * @param {Number} messageid
+     * Create reply
+     * Creates and returns a new private message as a reply to the parent message
+     * @param {Number} messageId
+     * @param {module:model/PrivateMessageInput} privateMessageInput
      * @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
@@ -117,43 +95,21 @@ export default class PrivateMessagesApi {
      * @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/PrivateMessagesApi~deleteMessageCallback} callback The callback function, accepting three arguments: error, data, response
+     * @param {module:api/PrivateMessagesApi~createPrivateMessageReplyCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/PrivateMessageResponse}
      */
-    deleteMessage(messageid: number, opts: any, callback: any): any;
+    createPrivateMessageReply(messageId: number, privateMessageInput: any, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the get24 operation.
-     * @callback module:api/PrivateMessagesApi~get24Callback
-     * @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
-     * @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/PrivateMessagesApi~get24Callback} callback The callback function, accepting three arguments: error, data, response
-     */
-    get24(opts: any, callback: any): any;
-    /**
-     * Callback function to receive the result of the get25 operation.
-     * @callback module:api/PrivateMessagesApi~get25Callback
+     * Callback function to receive the result of the deleteMessage operation.
+     * @callback module:api/PrivateMessagesApi~deleteMessageCallback
      * @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 private message
+     * Deletes the private message
+     * @param {Number} messageId
      * @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
@@ -167,14 +123,14 @@ export default class PrivateMessagesApi {
      * @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/PrivateMessagesApi~get25Callback} callback The callback function, accepting three arguments: error, data, response
+     * @param {module:api/PrivateMessagesApi~deleteMessageCallback} callback The callback function, accepting three arguments: error, data, response
      */
-    get25(opts: any, callback: any): any;
+    deleteMessage(messageId: number, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the getAllConversations operation.
      * @callback module:api/PrivateMessagesApi~getAllConversationsCallback
      * @param {String} error Error message, if any.
-     * @param {Array.<module:model/PrivateMessageConversation>} data The data returned by the service call.
+     * @param {Array.<module:model/PrivateMessageConversationResponse>} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
@@ -194,20 +150,20 @@ export default class PrivateMessagesApi {
      * @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/PrivateMessagesApi~getAllConversationsCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Array.<module:model/PrivateMessageConversation>}
+     * data is of type: {@link Array.<module:model/PrivateMessageConversationResponse>}
      */
     getAllConversations(opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the getChildConversations operation.
      * @callback module:api/PrivateMessagesApi~getChildConversationsCallback
      * @param {String} error Error message, if any.
-     * @param {Array.<module:model/PrivateMessageConversation>} data The data returned by the service call.
+     * @param {Array.<module:model/PrivateMessageConversationResponse>} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Get Child Conversations
-     * Returns the child private conversations
-     * @param {Number} convoid
+     * Get child conversations
+     * Returns child conversations for the given conversation
+     * @param {Number} conversationId
      * @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
@@ -222,14 +178,14 @@ export default class PrivateMessagesApi {
      * @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/PrivateMessagesApi~getChildConversationsCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Array.<module:model/PrivateMessageConversation>}
+     * data is of type: {@link Array.<module:model/PrivateMessageConversationResponse>}
      */
-    getChildConversations(convoid: number, opts: any, callback: any): any;
+    getChildConversations(conversationId: number, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the getConversationById operation.
      * @callback module:api/PrivateMessagesApi~getConversationByIdCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/PrivateMessageConversation} data The data returned by the service call.
+     * @param {module:model/PrivateMessageConversationResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
@@ -250,20 +206,20 @@ export default class PrivateMessagesApi {
      * @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/PrivateMessagesApi~getConversationByIdCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/PrivateMessageConversation}
+     * data is of type: {@link module:model/PrivateMessageConversationResponse}
      */
     getConversationById(id: number, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the getConversationMessages operation.
      * @callback module:api/PrivateMessagesApi~getConversationMessagesCallback
      * @param {String} error Error message, if any.
-     * @param {Array.<module:model/PrivateMessage>} data The data returned by the service call.
+     * @param {Array.<module:model/PrivateMessageResponse>} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Get Messages in a Conversation
-     * Returns the messages within a conversation
-     * @param {Number} convoid
+     * Get conversation messages
+     * Returns the messages in a conversation
+     * @param {Number} conversationId
      * @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
@@ -278,20 +234,20 @@ export default class PrivateMessagesApi {
      * @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/PrivateMessagesApi~getConversationMessagesCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Array.<module:model/PrivateMessage>}
+     * data is of type: {@link Array.<module:model/PrivateMessageResponse>}
      */
-    getConversationMessages(convoid: number, opts: any, callback: any): any;
+    getConversationMessages(conversationId: number, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the getConversationParticipants operation.
-     * @callback module:api/PrivateMessagesApi~getConversationParticipantsCallback
+     * Callback function to receive the result of the getGroupedMessages operation.
+     * @callback module:api/PrivateMessagesApi~getGroupedMessagesCallback
      * @param {String} error Error message, if any.
-     * @param {Array.<module:model/MessageGroup>} data The data returned by the service call.
+     * @param {Array.<module:model/PrivateMessageGroupResponse>} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Get Grouped Messages
-     * Get messages attached to a conversation with consecutive messages posted by the same user grouped together
-     * @param {Number} convoid
+     * Get grouped messages
+     * Returns grouped messages for the given conversation
+     * @param {Number} conversationId
      * @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
@@ -305,19 +261,20 @@ export default class PrivateMessagesApi {
      * @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/PrivateMessagesApi~getConversationParticipantsCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Array.<module:model/MessageGroup>}
+     * @param {module:api/PrivateMessagesApi~getGroupedMessagesCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/PrivateMessageGroupResponse>}
      */
-    getConversationParticipants(convoid: number, opts: any, callback: any): any;
+    getGroupedMessages(conversationId: number, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the getPrivateMessageById operation.
      * @callback module:api/PrivateMessagesApi~getPrivateMessageByIdCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/PrivateMessage} data The data returned by the service call.
+     * @param {module:model/PrivateMessageResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * @param {Number} id
+     * Get private message by ID
+     * @param {Number} messageId
      * @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
@@ -332,19 +289,19 @@ export default class PrivateMessagesApi {
      * @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/PrivateMessagesApi~getPrivateMessageByIdCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/PrivateMessage}
+     * data is of type: {@link module:model/PrivateMessageResponse}
      */
-    getPrivateMessageById(id: number, opts: any, callback: any): any;
+    getPrivateMessageById(messageId: number, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the getUnreadMessageCount operation.
-     * @callback module:api/PrivateMessagesApi~getUnreadMessageCountCallback
+     * Callback function to receive the result of the getUnreadConversationCount operation.
+     * @callback module:api/PrivateMessagesApi~getUnreadConversationCountCallback
      * @param {String} error Error message, if any.
      * @param {Number} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Get the number of unread messages
-     * Returns the number of unread messages
+     * Get unread conversation count
+     * Returns the number of conversations with unread messages
      * @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
@@ -358,19 +315,21 @@ export default class PrivateMessagesApi {
      * @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/PrivateMessagesApi~getUnreadMessageCountCallback} callback The callback function, accepting three arguments: error, data, response
+     * @param {module:api/PrivateMessagesApi~getUnreadConversationCountCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link Number}
      */
-    getUnreadMessageCount(opts: any, callback: any): any;
+    getUnreadConversationCount(opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the sendMessage operation.
      * @callback module:api/PrivateMessagesApi~sendMessageCallback
      * @param {String} error Error message, if any.
-     * @param {Array.<module:model/PrivateMessage>} data The data returned by the service call.
+     * @param {module:model/PrivateMessageResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * @param {Number} messageid
+     * Send private message
+     * Sets the message status to SENT
+     * @param {Number} messageId
      * @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
@@ -385,19 +344,21 @@ export default class PrivateMessagesApi {
      * @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/PrivateMessagesApi~sendMessageCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Array.<module:model/PrivateMessage>}
+     * data is of type: {@link module:model/PrivateMessageResponse}
      */
-    sendMessage(messageid: number, opts: any, callback: any): any;
+    sendMessage(messageId: number, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the updateMessage operation.
-     * @callback module:api/PrivateMessagesApi~updateMessageCallback
+     * Callback function to receive the result of the updatePrivateMessage operation.
+     * @callback module:api/PrivateMessagesApi~updatePrivateMessageCallback
      * @param {String} error Error message, if any.
-     * @param {Array.<module:model/PrivateMessage>} data The data returned by the service call.
+     * @param {module:model/PrivateMessageResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * @param {Number} messageid
-     * @param {module:model/PrivateMessage} privateMessage Private Message Object
+     * Update private message
+     * Updates an existing private message
+     * @param {Number} messageId
+     * @param {module:model/PrivateMessageInput} privateMessageInput
      * @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
@@ -411,8 +372,8 @@ export default class PrivateMessagesApi {
      * @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/PrivateMessagesApi~updateMessageCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Array.<module:model/PrivateMessage>}
+     * @param {module:api/PrivateMessagesApi~updatePrivateMessageCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/PrivateMessageResponse}
      */
-    updateMessage(messageid: number, privateMessage: any, opts: any, callback: any): any;
+    updatePrivateMessage(messageId: number, privateMessageInput: any, opts: any, callback: any): any;
 }