@gobodo/gobodo-api 0.1.97 → 0.1.100

package/dist/api/GraphActionsApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * GraphActions service.
 * @module api/GraphActionsApi
-* @version 0.1.97
+* @version 0.1.100
 */
 export default class GraphActionsApi {
     /**
@@ -21,8 +21,10 @@ export default class GraphActionsApi {
      * @param {String} response The complete HTTP response.
      */
     /**
-     * @param {Number} id The id of the object that we are performing the action on
-     * @param {Array.<module:model/GraphActionPayload>} graphActionPayload Conversation object or array of objects to create
+     * Create Actions
+     * Create actions on an object
+     * @param {Number} id
+     * @param {Array.<module:model/GraphActionPayload>} graphActionPayload Actions payload
      * @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
@@ -30,6 +32,7 @@ export default class GraphActionsApi {
      * @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} [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
@@ -38,85 +41,11 @@ export default class GraphActionsApi {
      * data is of type: {@link Array.<module:model/GraphActionResponse>}
      */
     createActions(id: number, graphActionPayload: any, opts: any, callback: any): any;
-    /**
-     * Callback function to receive the result of the createBulkActions operation.
-     * @callback module:api/GraphActionsApi~createBulkActionsCallback
-     * @param {String} error Error message, if any.
-     * @param {Array.<module:model/GraphAction>} data The data returned by the service call.
-     * @param {String} response The complete HTTP response.
-     */
-    /**
-     * Perform multiple actions in a single bulk operation
-     * Create a new action
-     * @param {Array.<module:model/GraphAction>} graphAction Conversation object or array of objects to create
-     * @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 {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} [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/GraphActionsApi~createBulkActionsCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Array.<module:model/GraphAction>}
-     */
-    createBulkActions(graphAction: any, opts: any, callback: any): any;
-    /**
-     * Callback function to receive the result of the deleteAction operation.
-     * @callback module:api/GraphActionsApi~deleteActionCallback
-     * @param {String} error Error message, if any.
-     * @param data This operation does not return a value.
-     * @param {String} response The complete HTTP response.
-     */
-    /**
-     * Delete Action
-     * Delete an individual action
-     * @param {Number} id
-     * @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 {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} [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/GraphActionsApi~deleteActionCallback} callback The callback function, accepting three arguments: error, data, response
-     */
-    deleteAction(id: number, opts: any, callback: any): any;
-    /**
-     * Callback function to receive the result of the get4 operation.
-     * @callback module:api/GraphActionsApi~get4Callback
-     * @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 {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} [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/GraphActionsApi~get4Callback} callback The callback function, accepting three arguments: error, data, response
-     */
-    get4(opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the getActionById operation.
      * @callback module:api/GraphActionsApi~getActionByIdCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/GraphAction} data The data returned by the service call.
+     * @param {module:model/GraphActionResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
@@ -129,24 +58,25 @@ export default class GraphActionsApi {
      * @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} [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/GraphActionsApi~getActionByIdCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/GraphAction}
+     * data is of type: {@link module:model/GraphActionResponse}
      */
     getActionById(id: number, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the getActionProperties operation.
      * @callback module:api/GraphActionsApi~getActionPropertiesCallback
      * @param {String} error Error message, if any.
-     * @param {Object.<String, module:model/{String: PurgeDataDefaultResponseValue}>} data The data returned by the service call.
+     * @param data This operation does not return a value.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Get Properties
-     * Get all properties attached to an action
+     * Get Action Properties
+     * Get properties of an action
      * @param {Number} id
      * @param {Object} opts Optional parameters
      * @param {String} [authorization] The authorization token of the logged in user
@@ -155,52 +85,25 @@ export default class GraphActionsApi {
      * @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} [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/GraphActionsApi~getActionPropertiesCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Object.<String, module:model/{String: PurgeDataDefaultResponseValue}>}
      */
     getActionProperties(id: number, opts: any, callback: any): any;
-    /**
-     * Callback function to receive the result of the getActionProperty operation.
-     * @callback module:api/GraphActionsApi~getActionPropertyCallback
-     * @param {String} error Error message, if any.
-     * @param {Object.<String, module:model/{String: PurgeDataDefaultResponseValue}>} data The data returned by the service call.
-     * @param {String} response The complete HTTP response.
-     */
-    /**
-     * Get Property
-     * Get a single property attached to an action
-     * @param {Number} id
-     * @param {String} prop
-     * @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 {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} [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/GraphActionsApi~getActionPropertyCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Object.<String, module:model/{String: PurgeDataDefaultResponseValue}>}
-     */
-    getActionProperty(id: number, prop: string, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the getActions operation.
      * @callback module:api/GraphActionsApi~getActionsCallback
      * @param {String} error Error message, if any.
-     * @param {Array.<module:model/GraphAction>} data The data returned by the service call.
+     * @param {Array.<module:model/GraphActionResponse>} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
      * Get Actions
      * Get actions attached to an object
-     * @param {Number} id The id of the object that we are retrieving actions on
+     * @param {Number} id
      * @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
@@ -208,19 +111,20 @@ export default class GraphActionsApi {
      * @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} [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/GraphActionsApi~getActionsCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Array.<module:model/GraphAction>}
+     * data is of type: {@link Array.<module:model/GraphActionResponse>}
      */
     getActions(id: number, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the getActionsByType operation.
      * @callback module:api/GraphActionsApi~getActionsByTypeCallback
      * @param {String} error Error message, if any.
-     * @param {Array.<module:model/GraphAction>} data The data returned by the service call.
+     * @param {Array.<module:model/GraphActionResponse>} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
@@ -235,53 +139,26 @@ export default class GraphActionsApi {
      * @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} [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/GraphActionsApi~getActionsByTypeCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Array.<module:model/GraphAction>}
+     * data is of type: {@link Array.<module:model/GraphActionResponse>}
      */
     getActionsByType(id: number, actiontypeid: number, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the setActionProperties operation.
-     * @callback module:api/GraphActionsApi~setActionPropertiesCallback
-     * @param {String} error Error message, if any.
-     * @param data This operation does not return a value.
-     * @param {String} response The complete HTTP response.
-     */
-    /**
-     * Set Multiple Properties
-     * Set multiple properties attaced to an object / record
-     * @param {Number} id
-     * @param {Object.<String, Object>} body The key/value of the property map with the properties to update
-     * @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 {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} [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/GraphActionsApi~setActionPropertiesCallback} callback The callback function, accepting three arguments: error, data, response
-     */
-    setActionProperties(id: number, body: any, opts: any, callback: any): any;
-    /**
-     * Callback function to receive the result of the setActionProperty operation.
-     * @callback module:api/GraphActionsApi~setActionPropertyCallback
+     * Callback function to receive the result of the updateActionProperties operation.
+     * @callback module:api/GraphActionsApi~updateActionPropertiesCallback
      * @param {String} error Error message, if any.
      * @param data This operation does not return a value.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Update Property
-     * Update a specific property
+     * Update Action Properties
+     * Update properties of an action
      * @param {Number} id
-     * @param {String} prop
-     * @param {String} body The value of the property
      * @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
@@ -289,11 +166,13 @@ export default class GraphActionsApi {
      * @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} [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/GraphActionsApi~setActionPropertyCallback} callback The callback function, accepting three arguments: error, data, response
+     * @param {Object.<String, Object>} [body]
+     * @param {module:api/GraphActionsApi~updateActionPropertiesCallback} callback The callback function, accepting three arguments: error, data, response
      */
-    setActionProperty(id: number, prop: string, body: string, opts: any, callback: any): any;
+    updateActionProperties(id: number, opts: any, callback: any): any;
 }