@gobodo/gobodo-api 0.1.185 → 0.1.187

package/README.md

@@ -4,8 +4,8 @@ GobodoGobodoApi - JavaScript client for @gobodo/gobodo-api
 REST Interface for Gobodo API
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 0.1.185
-- Package version: 0.1.185
+- API version: 0.1.187
+- Package version: 0.1.187
 - Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
 
 ## Installation
@@ -199,6 +199,12 @@ Class | Method | HTTP request | Description
 *GobodoGobodoApi.AuthenticationApi* | [**loginLinkedIn**](docs/AuthenticationApi.md#loginLinkedIn) | **POST** /auth_linkedin | 
 *GobodoGobodoApi.AuthenticationApi* | [**loginTwitter**](docs/AuthenticationApi.md#loginTwitter) | **POST** /auth_twitter | 
 *GobodoGobodoApi.AuthenticationApi* | [**logout**](docs/AuthenticationApi.md#logout) | **POST** /signout | 
+*GobodoGobodoApi.BatchApi* | [**deleteBatch**](docs/BatchApi.md#deleteBatch) | **DELETE** /batch/{batchId} | Delete batch
+*GobodoGobodoApi.BatchApi* | [**executeBatch**](docs/BatchApi.md#executeBatch) | **POST** /batch/{batchId}/execute | Execute batch
+*GobodoGobodoApi.BatchApi* | [**getBatch**](docs/BatchApi.md#getBatch) | **GET** /batch/{batchId} | Get batch
+*GobodoGobodoApi.BatchApi* | [**retireBatch**](docs/BatchApi.md#retireBatch) | **POST** /batch/{batchId}/retire | Retire batch
+*GobodoGobodoApi.BatchApi* | [**startBatch**](docs/BatchApi.md#startBatch) | **POST** /batch | Start batch
+*GobodoGobodoApi.BatchApi* | [**updateBatch**](docs/BatchApi.md#updateBatch) | **PATCH** /batch/{batchId} | Update batch
 *GobodoGobodoApi.CategoriesApi* | [**createCategory**](docs/CategoriesApi.md#createCategory) | **POST** /categories | Create Category
 *GobodoGobodoApi.CategoriesApi* | [**createChildCategory**](docs/CategoriesApi.md#createChildCategory) | **POST** /categories/{id}/subcategories | Create a child category
 *GobodoGobodoApi.CategoriesApi* | [**get14**](docs/CategoriesApi.md#get14) | **GET** /categories | 
@@ -323,6 +329,7 @@ Class | Method | HTTP request | Description
 *GobodoGobodoApi.DocumentsApi* | [**getDocumentsByType**](docs/DocumentsApi.md#getDocumentsByType) | **GET** /articles/entrytype/{typeid} | 
 *GobodoGobodoApi.DocumentsApi* | [**listDocuments**](docs/DocumentsApi.md#listDocuments) | **GET** /documents | List Documents
 *GobodoGobodoApi.DynamoDBSyncApi* | [**exportToDynamoDB**](docs/DynamoDBSyncApi.md#exportToDynamoDB) | **POST** /sync/dynamodb/export | One-time export to DynamoDB
+*GobodoGobodoApi.EmailApi* | [**sendEmail**](docs/EmailApi.md#sendEmail) | **POST** /notifications/email/send | Send email
 *GobodoGobodoApi.EmailsApi* | [**createEmailForPage**](docs/EmailsApi.md#createEmailForPage) | **POST** /emails/page/{pageId} | Creates an email address for a page
 *GobodoGobodoApi.EmailsApi* | [**createEmailForUser**](docs/EmailsApi.md#createEmailForUser) | **POST** /emails/user/{userId} | Creates an email address for a user
 *GobodoGobodoApi.EmailsApi* | [**getEmailsByPage**](docs/EmailsApi.md#getEmailsByPage) | **GET** /emails/page/{pageId} | Returns all email addresses for a given page
@@ -606,10 +613,10 @@ Class | Method | HTTP request | Description
 *GobodoGobodoApi.GraphTraversalApi* | [**traverseRelationships**](docs/GraphTraversalApi.md#traverseRelationships) | **POST** /traverse/relationships | Traverses the graph based on the traversal query provided and returns the discovered relationships
 *GobodoGobodoApi.GraphsApi* | [**addFunctionIdsToGraph**](docs/GraphsApi.md#addFunctionIdsToGraph) | **PUT** /functions/graph/{id}/functions/ids | Add existing functions to graph by IDs
 *GobodoGobodoApi.GraphsApi* | [**addFunctionsToGraph**](docs/GraphsApi.md#addFunctionsToGraph) | **PUT** /functions/graph/{id}/functions | Add functions to graph
-*GobodoGobodoApi.GraphsApi* | [**addObjectsToGraphById**](docs/GraphsApi.md#addObjectsToGraphById) | **PUT** /graph/{id}/objects/ids | Add existing objects to the graph by id
+*GobodoGobodoApi.GraphsApi* | [**addObjectsToGraphById**](docs/GraphsApi.md#addObjectsToGraphById) | **PUT** /graph/{id}/objects/ids | Add existing objects to the graph by id. Optional query batchId to record for batch.
 *GobodoGobodoApi.GraphsApi* | [**addSchemas**](docs/GraphsApi.md#addSchemas) | **PUT** /graph/{id}/schemas | Adds schemas to the graph
-*GobodoGobodoApi.GraphsApi* | [**createAddObjectToGraph**](docs/GraphsApi.md#createAddObjectToGraph) | **POST** /graph/{id}/objects | Add a new object to the graph
-*GobodoGobodoApi.GraphsApi* | [**createAddObjectsToGraph**](docs/GraphsApi.md#createAddObjectsToGraph) | **POST** /graph/{id}/objects/batch | Add new objects to the graph
+*GobodoGobodoApi.GraphsApi* | [**createAddObjectToGraph**](docs/GraphsApi.md#createAddObjectToGraph) | **POST** /graph/{id}/objects | Add a new object to the graph. Optional query batchId to record for batch.
+*GobodoGobodoApi.GraphsApi* | [**createAddObjectsToGraph**](docs/GraphsApi.md#createAddObjectsToGraph) | **POST** /graph/{id}/objects/batch | Add new objects to the graph. Optional query batchId to record for batch.
 *GobodoGobodoApi.GraphsApi* | [**createGraph**](docs/GraphsApi.md#createGraph) | **POST** /graph | Create Graph
 *GobodoGobodoApi.GraphsApi* | [**deleteGraph**](docs/GraphsApi.md#deleteGraph) | **DELETE** /graph/{id} | Delete Graph
 *GobodoGobodoApi.GraphsApi* | [**getActionTypesInGraph**](docs/GraphsApi.md#getActionTypesInGraph) | **GET** /graph/{id}/actiontypes | Get action types in the graph
@@ -1170,6 +1177,12 @@ Class | Method | HTTP request | Description
  - [GobodoGobodoApi.Base64ImportUpload](docs/Base64ImportUpload.md)
  - [GobodoGobodoApi.Base64Upload](docs/Base64Upload.md)
  - [GobodoGobodoApi.Base64VideoUpload](docs/Base64VideoUpload.md)
+ - [GobodoGobodoApi.BatchExecuteResult](docs/BatchExecuteResult.md)
+ - [GobodoGobodoApi.BatchOperationDetailResponse](docs/BatchOperationDetailResponse.md)
+ - [GobodoGobodoApi.BatchOperationResponse](docs/BatchOperationResponse.md)
+ - [GobodoGobodoApi.BatchStartInput](docs/BatchStartInput.md)
+ - [GobodoGobodoApi.BatchStartResponse](docs/BatchStartResponse.md)
+ - [GobodoGobodoApi.BatchUpdateInput](docs/BatchUpdateInput.md)
  - [GobodoGobodoApi.BillingDetails](docs/BillingDetails.md)
  - [GobodoGobodoApi.BillingThresholds](docs/BillingThresholds.md)
  - [GobodoGobodoApi.Blik](docs/Blik.md)
@@ -1577,6 +1590,8 @@ Class | Method | HTTP request | Description
  - [GobodoGobodoApi.ScreenSchema](docs/ScreenSchema.md)
  - [GobodoGobodoApi.Seicomart](docs/Seicomart.md)
  - [GobodoGobodoApi.SellerProtection](docs/SellerProtection.md)
+ - [GobodoGobodoApi.SendEmailInput](docs/SendEmailInput.md)
+ - [GobodoGobodoApi.SendEmailResponse](docs/SendEmailResponse.md)
  - [GobodoGobodoApi.SepaCreditTransfer](docs/SepaCreditTransfer.md)
  - [GobodoGobodoApi.SepaDebit](docs/SepaDebit.md)
  - [GobodoGobodoApi.SepaDebitPayments](docs/SepaDebitPayments.md)

package/dist/ApiClient.d.ts

@@ -1,7 +1,7 @@
 export default ApiClient;
 /**
 * @module ApiClient
-* @version 0.1.185
+* @version 0.1.187
 */
 /**
 * Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an

package/dist/ApiClient.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).
@@ -26,7 +26,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  */
 /**
 * @module ApiClient
-* @version 0.1.185
+* @version 0.1.187
 */
 /**
 * Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
@@ -78,7 +78,7 @@ var ApiClient = /*#__PURE__*/function () {
      * @default {}
      */
     this.defaultHeaders = {
-      'User-Agent': 'OpenAPI-Generator/0.1.185/Javascript'
+      'User-Agent': 'OpenAPI-Generator/0.1.187/Javascript'
     };
 
     /**

package/dist/api/AIApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * AI service.
 * @module api/AIApi
-* @version 0.1.185
+* @version 0.1.187
 */
 export default class AIApi {
     /**

package/dist/api/AIApi.js

@@ -18,7 +18,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).
@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * AI service.
 * @module api/AIApi
-* @version 0.1.185
+* @version 0.1.187
 */
 var AIApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/api/AIConversationsApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * AIConversations service.
 * @module api/AIConversationsApi
-* @version 0.1.185
+* @version 0.1.187
 */
 export default class AIConversationsApi {
     /**

package/dist/api/AIConversationsApi.js

@@ -17,7 +17,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).
@@ -28,7 +28,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * AIConversations service.
 * @module api/AIConversationsApi
-* @version 0.1.185
+* @version 0.1.187
 */
 var AIConversationsApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/api/AbilitiesApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * Abilities service.
 * @module api/AbilitiesApi
-* @version 0.1.185
+* @version 0.1.187
 */
 export default class AbilitiesApi {
     /**

package/dist/api/AbilitiesApi.js

@@ -18,7 +18,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).
@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * Abilities service.
 * @module api/AbilitiesApi
-* @version 0.1.185
+* @version 0.1.187
 */
 var AbilitiesApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/api/AdCampaignsApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * AdCampaigns service.
 * @module api/AdCampaignsApi
-* @version 0.1.185
+* @version 0.1.187
 */
 export default class AdCampaignsApi {
     /**

package/dist/api/AdCampaignsApi.js

@@ -18,7 +18,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).
@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * AdCampaigns service.
 * @module api/AdCampaignsApi
-* @version 0.1.185
+* @version 0.1.187
 */
 var AdCampaignsApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/api/AdManagementApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * AdManagement service.
 * @module api/AdManagementApi
-* @version 0.1.185
+* @version 0.1.187
 */
 export default class AdManagementApi {
     /**

package/dist/api/AdManagementApi.js

@@ -18,7 +18,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).
@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * AdManagement service.
 * @module api/AdManagementApi
-* @version 0.1.185
+* @version 0.1.187
 */
 var AdManagementApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/api/AdminDataManagementApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * AdminDataManagement service.
 * @module api/AdminDataManagementApi
-* @version 0.1.185
+* @version 0.1.187
 */
 export default class AdminDataManagementApi {
     /**

package/dist/api/AdminDataManagementApi.js

@@ -17,7 +17,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).
@@ -28,7 +28,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * AdminDataManagement service.
 * @module api/AdminDataManagementApi
-* @version 0.1.185
+* @version 0.1.187
 */
 var AdminDataManagementApi = exports["default"] = /*#__PURE__*/function () {
   /**

package/dist/api/AdsApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * Ads service.
 * @module api/AdsApi
-* @version 0.1.185
+* @version 0.1.187
 */
 export default class AdsApi {
     /**

package/dist/api/AdsApi.js

@@ -18,7 +18,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).
@@ -29,7 +29,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * Ads service.
 * @module api/AdsApi
-* @version 0.1.185
+* @version 0.1.187
 */
 var AdsApi = exports["default"] = /*#__PURE__*/function () {
   /**

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 {
     /**

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,185 @@
+/**
+* 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;
+    /**
+     * Callback function to receive the result of the deleteBatch operation.
+     * @callback module:api/BatchApi~deleteBatchCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * 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
+     * @param {module:api/BatchApi~deleteBatchCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    deleteBatch(batchId: string, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the executeBatch operation.
+     * @callback module:api/BatchApi~executeBatchCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/BatchExecuteResult} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * 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
+     * @param {module:api/BatchApi~executeBatchCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/BatchExecuteResult}
+     */
+    executeBatch(batchId: string, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getBatch operation.
+     * @callback module:api/BatchApi~getBatchCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/BatchOperationResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * 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
+     * @param {module:api/BatchApi~getBatchCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/BatchOperationResponse}
+     */
+    getBatch(batchId: string, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the retireBatch operation.
+     * @callback module:api/BatchApi~retireBatchCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * 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
+     * @param {module:api/BatchApi~retireBatchCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    retireBatch(batchId: string, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the startBatch operation.
+     * @callback module:api/BatchApi~startBatchCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/BatchStartResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * 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
+     * @param {module:api/BatchApi~startBatchCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/BatchStartResponse}
+     */
+    startBatch(batchStartInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the updateBatch operation.
+     * @callback module:api/BatchApi~updateBatchCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/BatchOperationResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * 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)
+     * @param {module:api/BatchApi~updateBatchCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/BatchOperationResponse}
+     */
+    updateBatch(batchId: string, opts: any, callback: any): any;
+}