@gobodo/gobodo-api-promise 0.1.185 → 0.1.187

package/dist/api/AttachmentsApi.d.ts

@@ -48,7 +48,7 @@ export default class AttachmentsApi {
      * @param {String} opts.transactionid The id of the transaction this operation is being run in
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */
-    get14(opts?: { [key: string]: any;  [key: string]: any; 
+    get14(opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         authorization?: string;
         cacheduration?: number;
         cachegroup?: Array<string>;
@@ -95,7 +95,7 @@ export default class AttachmentsApi {
      * @param {String} opts.transactionid The id of the transaction this operation is being run in
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link File}
      */
-    getFileById(id: number, opts?: { [key: string]: any;  [key: string]: any; 
+    getFileById(id: number, opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         authorization?: string;
         cacheduration?: number;
         cachegroup?: Array<string>;
@@ -144,7 +144,7 @@ export default class AttachmentsApi {
      * @param {module:model/PurgeDataDefaultResponse} opts.purgeDataDefaultResponse
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link File}
      */
-    updateFile(id: number, opts?: { [key: string]: any;  [key: string]: any; 
+    updateFile(id: number, opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         authorization?: string;
         cacheduration?: number;
         cachegroup?: Array<string>;
@@ -193,7 +193,7 @@ export default class AttachmentsApi {
      * @param {String} opts.preamble
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PurgeDataDefaultResponse}
      */
-    upload(id: number, opts?: { [key: string]: any;  [key: string]: any; 
+    upload(id: number, opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         authorization?: string;
         cacheduration?: number;
         cachegroup?: Array<string>;
@@ -242,7 +242,7 @@ export default class AttachmentsApi {
      * @param {module:model/MultipartBody} opts.body
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<File>}
      */
-    uploadFile(opts?: { [key: string]: any;  [key: string]: any; 
+    uploadFile(opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         authorization?: string;
         cacheduration?: number;
         cachegroup?: Array<string>;
@@ -301,7 +301,7 @@ export default class AttachmentsApi {
      * @param {String} opts.description Description for the uploaded attachment(s)
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.<File>}
      */
-    uploadFileBase64(base64AttachmentUpload: any, opts?: { [key: string]: any;  [key: string]: any; 
+    uploadFileBase64(base64AttachmentUpload: any, opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         authorization?: string;
         cacheduration?: number;
         cachegroup?: Array<string>;

package/dist/api/AuthenticationApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * Authentication service.
 * @module api/AuthenticationApi
-* @version 0.1.185
+* @version 0.1.187
 */
 export default class AuthenticationApi {
     /**
@@ -26,7 +26,7 @@ export default class AuthenticationApi {
      * @param {String} opts.loginToken
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AuthResponse}
      */
-    login(opts?: { [key: string]: any;  [key: string]: any; 
+    login(opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         apiKey?: string;
         loginToken?: string;
     }): Promise<any>;
@@ -45,7 +45,7 @@ export default class AuthenticationApi {
      * @param {Number} opts.appid
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AuthResponse}
      */
-    loginAsApp(opts?: { [key: string]: any;  [key: string]: any; 
+    loginAsApp(opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         apiKey?: string;
         authorization?: string;
         appid?: number;
@@ -65,7 +65,7 @@ export default class AuthenticationApi {
      * @param {Number} opts.siteid
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AuthResponse}
      */
-    loginAsFunction(opts?: { [key: string]: any;  [key: string]: any; 
+    loginAsFunction(opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         apiKey?: string;
         authorization?: string;
         siteid?: number;
@@ -85,7 +85,7 @@ export default class AuthenticationApi {
      * @param {Number} opts.orgid
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AuthResponse}
      */
-    loginAsOrg(opts?: { [key: string]: any;  [key: string]: any; 
+    loginAsOrg(opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         apiKey?: string;
         authorization?: string;
         orgid?: number;
@@ -105,7 +105,7 @@ export default class AuthenticationApi {
      * @param {Number} opts.pageid
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AuthResponse}
      */
-    loginAsPage(opts?: { [key: string]: any;  [key: string]: any; 
+    loginAsPage(opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         apiKey?: string;
         authorization?: string;
         pageid?: number;
@@ -125,7 +125,7 @@ export default class AuthenticationApi {
      * @param {Number} opts.siteid
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AuthResponse}
      */
-    loginAsSite(opts?: { [key: string]: any;  [key: string]: any; 
+    loginAsSite(opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         apiKey?: string;
         authorization?: string;
         siteid?: number;
@@ -145,7 +145,7 @@ export default class AuthenticationApi {
      * @param {String} opts.createIfNotUser
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AuthResponse}
      */
-    loginFacebook(opts?: { [key: string]: any;  [key: string]: any; 
+    loginFacebook(opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         apiKey?: string;
         authorization?: string;
         createIfNotUser?: string;
@@ -165,7 +165,7 @@ export default class AuthenticationApi {
      * @param {String} opts.createIfNotUser
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AuthResponse}
      */
-    loginGoogle(opts?: { [key: string]: any;  [key: string]: any; 
+    loginGoogle(opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         apiKey?: string;
         authorization?: string;
         createIfNotUser?: string;
@@ -185,7 +185,7 @@ export default class AuthenticationApi {
      * @param {String} opts.createIfNotUser
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AuthResponse}
      */
-    loginLinkedIn(opts?: { [key: string]: any;  [key: string]: any; 
+    loginLinkedIn(opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         apiKey?: string;
         authorization?: string;
         createIfNotUser?: string;
@@ -205,7 +205,7 @@ export default class AuthenticationApi {
      * @param {String} opts.createIfNotUser
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/AuthResponse}
      */
-    loginTwitter(opts?: { [key: string]: any;  [key: string]: any; 
+    loginTwitter(opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         apiKey?: string;
         authorization?: string;
         createIfNotUser?: string;
@@ -223,7 +223,7 @@ export default class AuthenticationApi {
      * @param {String} opts.authorization
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}
      */
-    logout(opts?: { [key: string]: any;  [key: string]: any; 
+    logout(opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
         apiKey?: string;
         authorization?: string;
     }): Promise<any>;

package/dist/api/AuthenticationApi.js

@@ -16,7 +16,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  * gobodo-api
  * REST Interface for Gobodo API
  *
- * The version of the OpenAPI document: 0.1.185
+ * The version of the OpenAPI document: 0.1.187
  * Contact: info@gobodo.io
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -27,7 +27,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * Authentication service.
 * @module api/AuthenticationApi
-* @version 0.1.185
+* @version 0.1.187
 */
 var AuthenticationApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/api/BatchApi.d.ts

@@ -0,0 +1,305 @@
+/**
+* Batch service.
+* @module api/BatchApi
+* @version 0.1.187
+*/
+export default class BatchApi {
+    /**
+    * Constructs a new BatchApi.
+    * @alias module:api/BatchApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Delete batch
+     * Delete batch and all its details
+     * @param {String} batchId Batch 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 {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
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
+     */
+    deleteBatchWithHttpInfo(batchId: string, opts: any): Promise<any>;
+    /**
+     * Delete batch
+     * Delete batch and all its details
+     * @param {String} batchId Batch id
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.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>} opts.invalidationkeys Cache keys that should be invalidated in this operation
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+     */
+    deleteBatch(batchId: string, opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
+        authorization?: string;
+        cacheduration?: number;
+        cachegroup?: Array<string>;
+        cachekey?: Array<string>;
+        cachescope?: any;
+        cacheuser?: Array<string>;
+    }): Promise<any>;
+    /**
+     * Execute batch
+     * Run all recorded details in order. Use async=true to return 202 and run in background; poll GET /batch/{batchId} for status.
+     * @param {String} batchId Batch 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 {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} [async = false)] If true, return 202 immediately and run execution in background
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BatchExecuteResult} and HTTP response
+     */
+    executeBatchWithHttpInfo(batchId: string, opts: any): Promise<any>;
+    /**
+     * Execute batch
+     * Run all recorded details in order. Use async=true to return 202 and run in background; poll GET /batch/{batchId} for status.
+     * @param {String} batchId Batch id
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.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>} opts.invalidationkeys Cache keys that should be invalidated in this operation
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @param {Boolean} opts.async If true, return 202 immediately and run execution in background (default to false)
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BatchExecuteResult}
+     */
+    executeBatch(batchId: string, opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
+        authorization?: string;
+        cacheduration?: number;
+        cachegroup?: Array<string>;
+        cachekey?: Array<string>;
+        cachescope?: any;
+        cacheuser?: Array<string>;
+    }): Promise<any>;
+    /**
+     * Get batch
+     * Get batch by id. List view: payload is never included. Use includePayloadRef=true to get payloadFileId and payloadFileUrl for details that store payload as a file.
+     * @param {String} batchId Batch 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 {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} [includePayloadRef = false)] If true, include payloadFileId and payloadFileUrl for details that have payload stored as file
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BatchOperationResponse} and HTTP response
+     */
+    getBatchWithHttpInfo(batchId: string, opts: any): Promise<any>;
+    /**
+     * Get batch
+     * Get batch by id. List view: payload is never included. Use includePayloadRef=true to get payloadFileId and payloadFileUrl for details that store payload as a file.
+     * @param {String} batchId Batch id
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.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>} opts.invalidationkeys Cache keys that should be invalidated in this operation
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @param {Boolean} opts.includePayloadRef If true, include payloadFileId and payloadFileUrl for details that have payload stored as file (default to false)
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BatchOperationResponse}
+     */
+    getBatch(batchId: string, opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
+        authorization?: string;
+        cacheduration?: number;
+        cachegroup?: Array<string>;
+        cachekey?: Array<string>;
+        cachescope?: any;
+        cacheuser?: Array<string>;
+    }): Promise<any>;
+    /**
+     * Retire batch
+     * Mark batch as retired so it cannot be executed again
+     * @param {String} batchId Batch 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 {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
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
+     */
+    retireBatchWithHttpInfo(batchId: string, opts: any): Promise<any>;
+    /**
+     * Retire batch
+     * Mark batch as retired so it cannot be executed again
+     * @param {String} batchId Batch id
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.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>} opts.invalidationkeys Cache keys that should be invalidated in this operation
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+     */
+    retireBatch(batchId: string, opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
+        authorization?: string;
+        cacheduration?: number;
+        cachegroup?: Array<string>;
+        cachekey?: Array<string>;
+        cachescope?: any;
+        cacheuser?: Array<string>;
+    }): Promise<any>;
+    /**
+     * Start batch
+     * Create a new batch operation (pending). Required body: { batchId, key }
+     * @param {module:model/BatchStartInput} batchStartInput Batch start parameters (batchId, 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
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BatchStartResponse} and HTTP response
+     */
+    startBatchWithHttpInfo(batchStartInput: any, opts: any): Promise<any>;
+    /**
+     * Start batch
+     * Create a new batch operation (pending). Required body: { batchId, key }
+     * @param {module:model/BatchStartInput} batchStartInput Batch start parameters (batchId, key)
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.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>} opts.invalidationkeys Cache keys that should be invalidated in this operation
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BatchStartResponse}
+     */
+    startBatch(batchStartInput: any, opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
+        authorization?: string;
+        cacheduration?: number;
+        cachegroup?: Array<string>;
+        cachekey?: Array<string>;
+        cachescope?: any;
+        cacheuser?: Array<string>;
+    }): Promise<any>;
+    /**
+     * Update batch
+     * Update batch key and/or metadata (PATCH semantics; only provided fields are updated).
+     * @param {String} batchId Batch 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 {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:model/BatchUpdateInput} [batchUpdateInput] Fields to update (key, metadata)
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BatchOperationResponse} and HTTP response
+     */
+    updateBatchWithHttpInfo(batchId: string, opts: any): Promise<any>;
+    /**
+     * Update batch
+     * Update batch key and/or metadata (PATCH semantics; only provided fields are updated).
+     * @param {String} batchId Batch id
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.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>} opts.invalidationkeys Cache keys that should be invalidated in this operation
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @param {module:model/BatchUpdateInput} opts.batchUpdateInput Fields to update (key, metadata)
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BatchOperationResponse}
+     */
+    updateBatch(batchId: string, opts?: { [key: string]: any;  [key: string]: any;  [key: string]: any;  [key: string]: any; 
+        authorization?: string;
+        cacheduration?: number;
+        cachegroup?: Array<string>;
+        cachekey?: Array<string>;
+        cachescope?: any;
+        cacheuser?: Array<string>;
+    }): Promise<any>;
+}
+//# sourceMappingURL=BatchApi.d.ts.map

package/dist/api/BatchApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BatchApi.d.ts","sourceRoot":"","sources":["../../src/api/BatchApi.js"],"names":[],"mappings":"AAsBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAKpD;;;;;;;;;;;;;;;;;;OAkBG;IACH,kEAuCC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,mCAdG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAaF;IAGD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,mEAwCC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,oCAfG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAcF;IAGD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,+DAwCC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,gCAfG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAcF;IAGD;;;;;;;;;;;;;;;;;;OAkBG;IACH,kEAuCC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,mCAdG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAaF;IAGD;;;;;;;;;;;;;;;;;;OAkBG;IACH,wCAhBW,GAA4B,2BAsDtC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,4BAhBW,GAA4B,QAEpC;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAaF;IAGD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,kEAuCC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,mCAfG;QAAqB,aAAa;QACb,aAAa;QACL,UAAU,EAA/B,KAAK,QAAS;QACO,QAAQ,EAA7B,KAAK,QAAS;QACY,UAAU,EAApC,GAAmB;QACE,SAAS,EAA9B,KAAK,QAAS;KACtB,gBAcF;CAGJ"}