@gobodo/gobodo-api 0.1.205 → 0.1.206

package/dist/api/GraphObjectsApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * GraphObjects service.
 * @module api/GraphObjectsApi
-* @version 0.1.205
+* @version 0.1.206
 */
 export default class GraphObjectsApi {
     /**
@@ -156,6 +156,35 @@ export default class GraphObjectsApi {
      * data is of type: {@link module:model/GraphObjectResponse}
      */
     createObject(graphObjectPayload: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createObjectIfAbsent operation.
+     * @callback module:api/GraphObjectsApi~createObjectIfAbsentCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/GraphObjectResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create Object If Absent
+     * Create a graph object if its key does not already exist. Existing keyed objects are returned unchanged. Optional query batchId to record for batch.
+     * @param {module:model/GraphObjectPayload} graphObjectPayload GraphObject payload; key is required
+     * @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~createObjectIfAbsentCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/GraphObjectResponse}
+     */
+    createObjectIfAbsent(graphObjectPayload: any, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the createObjects operation.
      * @callback module:api/GraphObjectsApi~createObjectsCallback
@@ -186,6 +215,96 @@ export default class GraphObjectsApi {
      * data is of type: {@link Array.<module:model/GraphObjectResponse>}
      */
     createObjects(graphObjectPayload: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createObjectsIfAbsent operation.
+     * @callback module:api/GraphObjectsApi~createObjectsIfAbsentCallback
+     * @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.
+     */
+    /**
+     * Create Objects If Absent (batch)
+     * Create multiple graph objects only when their keys do not already exist. Existing keyed objects are returned unchanged. Optional query batchId to record for batch.
+     * @param {Array.<module:model/GraphObjectPayload>} graphObjectPayload Array of GraphObject payloads; key is required for each item
+     * @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 {Boolean} [summary = false)] If true, return a summary response instead of the full list of created or existing objects
+     * @param {module:api/GraphObjectsApi~createObjectsIfAbsentCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/GraphObjectResponse>}
+     */
+    createObjectsIfAbsent(graphObjectPayload: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createObjectsIfAbsentImport operation.
+     * @callback module:api/GraphObjectsApi~createObjectsIfAbsentImportCallback
+     * @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.
+     */
+    /**
+     * Create Objects If Absent from file (multipart)
+     * Bulk create objects if absent. Upload a JSON file containing an array of GraphObject payloads.
+     * @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 {Boolean} [summary = false)] If true, return a summary response instead of the full list of created or existing objects
+     * @param {Object.<String, {String: [InputPart]}>} [formDataMap]
+     * @param {Array.<module:model/InputPart>} [parts]
+     * @param {String} [preamble]
+     * @param {module:api/GraphObjectsApi~createObjectsIfAbsentImportCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/GraphObjectResponse>}
+     */
+    createObjectsIfAbsentImport(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createObjectsIfAbsentImportBase64 operation.
+     * @callback module:api/GraphObjectsApi~createObjectsIfAbsentImportBase64Callback
+     * @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.
+     */
+    /**
+     * Create Objects If Absent from file (base64)
+     * Bulk create objects if absent. 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 {Boolean} [summary = false)] If true, return a summary response instead of the full list of created or existing objects
+     * @param {module:api/GraphObjectsApi~createObjectsIfAbsentImportBase64Callback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/GraphObjectResponse>}
+     */
+    createObjectsIfAbsentImportBase64(base64ImportUpload: any, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the createObjectsImport operation.
      * @callback module:api/GraphObjectsApi~createObjectsImportCallback
@@ -211,8 +330,8 @@ export default class GraphObjectsApi {
      * @param {String} [transactionid] The id of the transaction this operation is being run in
      * @param {Boolean} [summary = false)] If true, return a summary response instead of the full list of created objects
      * @param {Object.<String, {String: [InputPart]}>} [formDataMap]
-     * @param {String} [preamble]
      * @param {Array.<module:model/InputPart>} [parts]
+     * @param {String} [preamble]
      * @param {module:api/GraphObjectsApi~createObjectsImportCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link Array.<module:model/GraphObjectResponse>}
      */
@@ -276,6 +395,36 @@ export default class GraphObjectsApi {
      * data is of type: {@link module:model/GraphRelationshipResponse}
      */
     createRelationship(id: number, graphRelationshipPayload: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createRelationshipIfAbsent operation.
+     * @callback module:api/GraphObjectsApi~createRelationshipIfAbsentCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/GraphRelationshipResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create Relationship If Absent
+     * Create a relationship if its key does not already exist. Existing keyed relationships are returned unchanged. Optional query batchId to record for batch.
+     * @param {Number} id
+     * @param {module:model/GraphRelationshipPayload} graphRelationshipPayload Relationship payload; key is required
+     * @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~createRelationshipIfAbsentCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/GraphRelationshipResponse}
+     */
+    createRelationshipIfAbsent(id: number, graphRelationshipPayload: any, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the createRelationships operation.
      * @callback module:api/GraphObjectsApi~createRelationshipsCallback
@@ -307,6 +456,96 @@ export default class GraphObjectsApi {
      * data is of type: {@link Array.<module:model/GraphRelationshipResponse>}
      */
     createRelationships(id: number, graphRelationshipPayload: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createRelationshipsIfAbsent operation.
+     * @callback module:api/GraphObjectsApi~createRelationshipsIfAbsentCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/GraphRelationshipResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create Relationships If Absent (batch)
+     * Create multiple relationships only when their keys do not already exist. Existing keyed relationships are returned unchanged. Optional query batchId to record for batch.
+     * @param {Array.<module:model/BulkUpsertRelationshipPayload>} bulkUpsertRelationshipPayload Array of bulk relationship payloads; key is required for each item
+     * @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 {Boolean} [summary = false)] If true, return a summary response instead of the full list of created or existing relationships
+     * @param {module:api/GraphObjectsApi~createRelationshipsIfAbsentCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/GraphRelationshipResponse>}
+     */
+    createRelationshipsIfAbsent(bulkUpsertRelationshipPayload: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createRelationshipsIfAbsentImport operation.
+     * @callback module:api/GraphObjectsApi~createRelationshipsIfAbsentImportCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/GraphRelationshipResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create Relationships If Absent from file (multipart)
+     * Bulk create relationships if absent. Upload a JSON file containing an array of relationship payloads with keys.
+     * @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 {Boolean} [summary = false)] If true, return a summary response instead of the full list of created or existing relationships
+     * @param {Object.<String, {String: [InputPart]}>} [formDataMap]
+     * @param {Array.<module:model/InputPart>} [parts]
+     * @param {String} [preamble]
+     * @param {module:api/GraphObjectsApi~createRelationshipsIfAbsentImportCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/GraphRelationshipResponse>}
+     */
+    createRelationshipsIfAbsentImport(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createRelationshipsIfAbsentImportBase64 operation.
+     * @callback module:api/GraphObjectsApi~createRelationshipsIfAbsentImportBase64Callback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/GraphRelationshipResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create Relationships If Absent from file (base64)
+     * Bulk create relationships if absent. Send JSON with base64-encoded file content. File must be a JSON array of relationship payloads with keys.
+     * @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 {Boolean} [summary = false)] If true, return a summary response instead of the full list of created or existing relationships
+     * @param {module:api/GraphObjectsApi~createRelationshipsIfAbsentImportBase64Callback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/GraphRelationshipResponse>}
+     */
+    createRelationshipsIfAbsentImportBase64(base64ImportUpload: any, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the createRelationshipsImport operation.
      * @callback module:api/GraphObjectsApi~createRelationshipsImportCallback
@@ -333,8 +572,8 @@ export default class GraphObjectsApi {
      * @param {String} [transactionid] The id of the transaction this operation is being run in
      * @param {Boolean} [summary = false)] If true, return a summary response instead of the full list of created relationships
      * @param {Object.<String, {String: [InputPart]}>} [formDataMap]
-     * @param {String} [preamble]
      * @param {Array.<module:model/InputPart>} [parts]
+     * @param {String} [preamble]
      * @param {module:api/GraphObjectsApi~createRelationshipsImportCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link Array.<module:model/GraphRelationshipResponse>}
      */
@@ -1179,8 +1418,8 @@ export default class GraphObjectsApi {
      * @param {String} [transactionid] The id of the transaction this operation is being run in
      * @param {Boolean} [summary = false)] If true, return a summary response instead of the full list of created or updated objects
      * @param {Object.<String, {String: [InputPart]}>} [formDataMap]
-     * @param {String} [preamble]
      * @param {Array.<module:model/InputPart>} [parts]
+     * @param {String} [preamble]
      * @param {module:api/GraphObjectsApi~upsertObjectsImportCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link Array.<module:model/GraphObjectResponse>}
      */
@@ -1299,8 +1538,8 @@ export default class GraphObjectsApi {
      * @param {String} [transactionid] The id of the transaction this operation is being run in
      * @param {Boolean} [summary = false)] If true, return a summary response instead of the full list of created or updated relationships
      * @param {Object.<String, {String: [InputPart]}>} [formDataMap]
-     * @param {String} [preamble]
      * @param {Array.<module:model/InputPart>} [parts]
+     * @param {String} [preamble]
      * @param {module:api/GraphObjectsApi~upsertRelationshipsImportCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link Array.<module:model/GraphRelationshipResponse>}
      */