@gobodo/gobodo-api 0.1.212 → 0.1.214

package/dist/api/GraphObjectsApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * GraphObjects service.
 * @module api/GraphObjectsApi
-* @version 0.1.212
+* @version 0.1.214
 */
 export default class GraphObjectsApi {
     /**
@@ -1285,8 +1285,8 @@ export default class GraphObjectsApi {
      */
     searchGraphObjects(q: string, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the setObjectProperties operation.
-     * @callback module:api/GraphObjectsApi~setObjectPropertiesCallback
+     * Callback function to receive the result of the setObjectPropertiesById operation.
+     * @callback module:api/GraphObjectsApi~setObjectPropertiesByIdCallback
      * @param {String} error Error message, if any.
      * @param data This operation does not return a value.
      * @param {String} response The complete HTTP response.
@@ -1309,12 +1309,42 @@ export default class GraphObjectsApi {
      * @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/GraphObjectsApi~setObjectPropertiesCallback} callback The callback function, accepting three arguments: error, data, response
+     * @param {String} [batchId] Optional batch id to record this operation
+     * @param {module:api/GraphObjectsApi~setObjectPropertiesByIdCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    setObjectPropertiesById(id: number, body: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the setObjectPropertiesByKey operation.
+     * @callback module:api/GraphObjectsApi~setObjectPropertiesByKeyCallback
+     * @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 By Key
+     * Set multiple properties attached to an object / record using the object key
+     * @param {String} key The key of the object whose properties we are updating
+     * @param {Object.<String, Object>} body The property map to set in Json format
+     * @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} [batchId] Optional batch id to record this operation
+     * @param {module:api/GraphObjectsApi~setObjectPropertiesByKeyCallback} callback The callback function, accepting three arguments: error, data, response
      */
-    setObjectProperties(id: number, body: any, opts: any, callback: any): any;
+    setObjectPropertiesByKey(key: string, body: any, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the setObjectProperty operation.
-     * @callback module:api/GraphObjectsApi~setObjectPropertyCallback
+     * Callback function to receive the result of the setObjectPropertyById operation.
+     * @callback module:api/GraphObjectsApi~setObjectPropertyByIdCallback
      * @param {String} error Error message, if any.
      * @param data This operation does not return a value.
      * @param {String} response The complete HTTP response.
@@ -1337,10 +1367,41 @@ export default class GraphObjectsApi {
      * @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 {Object.<String, Object>} [body] The value that is being set
+     * @param {module:api/GraphObjectsApi~setObjectPropertyByIdCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    setObjectPropertyById(id: number, prop: string, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the setObjectPropertyByKey operation.
+     * @callback module:api/GraphObjectsApi~setObjectPropertyByKeyCallback
+     * @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 By Key
+     * Update a specific property using the object key
+     * @param {String} key The key of the object whose properties we are updating
+     * @param {String} prop The property being updated
+     * @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} [batchId] Optional batch id to record this operation
      * @param {Object.<String, Object>} [body] The value that is being set
-     * @param {module:api/GraphObjectsApi~setObjectPropertyCallback} callback The callback function, accepting three arguments: error, data, response
+     * @param {module:api/GraphObjectsApi~setObjectPropertyByKeyCallback} callback The callback function, accepting three arguments: error, data, response
      */
-    setObjectProperty(id: number, prop: string, opts: any, callback: any): any;
+    setObjectPropertyByKey(key: string, prop: string, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the updateObject operation.
      * @callback module:api/GraphObjectsApi~updateObjectCallback
@@ -1372,6 +1433,101 @@ export default class GraphObjectsApi {
      * data is of type: {@link module:model/GraphObjectResponse}
      */
     updateObject(id: number, graphObjectPayload: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the updateObjects operation.
+     * @callback module:api/GraphObjectsApi~updateObjectsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/GraphObjectResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Update Objects (batch)
+     * Update multiple existing graph objects by id or key. Missing targets fail per row and are never created. Optional query batchId to record for batch.
+     * @param {Array.<module:model/GraphObjectPayload>} graphObjectPayload Array of GraphObject payloads; each item must resolve to an existing object by id or key
+     * @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} [batchId] Optional batch id to record this operation
+     * @param {module:model/String} [priority] Optional queue priority when batchId is present. Allowed values: normal, high, critical.
+     * @param {Boolean} [summary = false)] If true, return a summary response instead of the full list of updated objects
+     * @param {module:api/GraphObjectsApi~updateObjectsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/GraphObjectResponse>}
+     */
+    updateObjects(graphObjectPayload: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the updateObjectsImport operation.
+     * @callback module:api/GraphObjectsApi~updateObjectsImportCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/GraphObjectResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Update Objects from file (multipart)
+     * Bulk update existing objects. Upload a JSON file containing an array of GraphObject payloads. Each item must resolve to an existing object by id or key.
+     * @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} [batchId] Optional batch id to record this operation
+     * @param {module:model/String} [priority] Optional queue priority when batchId is present. Allowed values: normal, high, critical.
+     * @param {Boolean} [summary = false)] If true, return a summary response instead of the full list of updated objects
+     * @param {Object.<String, {String: [InputPart]}>} [formDataMap]
+     * @param {Array.<module:model/InputPart>} [parts]
+     * @param {String} [preamble]
+     * @param {module:api/GraphObjectsApi~updateObjectsImportCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/GraphObjectResponse>}
+     */
+    updateObjectsImport(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the updateObjectsImportBase64 operation.
+     * @callback module:api/GraphObjectsApi~updateObjectsImportBase64Callback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/GraphObjectResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Update Objects from file (base64)
+     * Bulk update existing objects. Send JSON with base64-encoded file content. File must be a JSON array of GraphObject payloads.
+     * @param {module:model/Base64ImportUpload} base64ImportUpload Base64 file upload
+     * @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} [batchId] Optional batch id to record this operation
+     * @param {module:model/String} [priority] Optional queue priority when batchId is present. Allowed values: normal, high, critical.
+     * @param {Boolean} [summary = false)] If true, return a summary response instead of the full list of updated objects
+     * @param {module:api/GraphObjectsApi~updateObjectsImportBase64Callback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/GraphObjectResponse>}
+     */
+    updateObjectsImportBase64(base64ImportUpload: any, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the upsertAction operation.
      * @callback module:api/GraphObjectsApi~upsertActionCallback