@gobodo/gobodo-api 0.1.221 → 0.1.223

package/dist/api/IntegrationsApi.d.ts

@@ -0,0 +1,331 @@
+/**
+* Integrations service.
+* @module api/IntegrationsApi
+* @version 0.1.223
+*/
+export default class IntegrationsApi {
+    /**
+    * Constructs a new IntegrationsApi.
+    * @alias module:api/IntegrationsApi
+    * @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 createIntegrationInstance operation.
+     * @callback module:api/IntegrationsApi~createIntegrationInstanceCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Provision integration from template
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
+     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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/IntegrationInstanceInput} [integrationInstanceInput]
+     * @param {module:api/IntegrationsApi~createIntegrationInstanceCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    createIntegrationInstance(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the deleteAirtableSyncRule operation.
+     * @callback module:api/IntegrationsApi~deleteAirtableSyncRuleCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Delete Airtable sync rule
+     * @param {String} ruleId
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
+     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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/IntegrationsApi~deleteAirtableSyncRuleCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    deleteAirtableSyncRule(ruleId: string, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the deleteIntegrationInstance operation.
+     * @callback module:api/IntegrationsApi~deleteIntegrationInstanceCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Disable and delete integration instance
+     * @param {Number} id
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
+     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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/IntegrationsApi~deleteIntegrationInstanceCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    deleteIntegrationInstance(id: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getIntegrationInstance operation.
+     * @callback module:api/IntegrationsApi~getIntegrationInstanceCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get integration instance
+     * @param {Number} id
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
+     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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/IntegrationsApi~getIntegrationInstanceCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    getIntegrationInstance(id: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the listAirtableSyncRules operation.
+     * @callback module:api/IntegrationsApi~listAirtableSyncRulesCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List Airtable sync rules
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
+     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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 {Number} [graphId]
+     * @param {Number} [objectTypeId]
+     * @param {String} [scope]
+     * @param {module:api/IntegrationsApi~listAirtableSyncRulesCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    listAirtableSyncRules(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the listIntegrationInstances operation.
+     * @callback module:api/IntegrationsApi~listIntegrationInstancesCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List integration instances
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
+     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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 {Number} [graphId]
+     * @param {module:api/IntegrationsApi~listIntegrationInstancesCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    listIntegrationInstances(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the listIntegrationTemplates operation.
+     * @callback module:api/IntegrationsApi~listIntegrationTemplatesCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List OOTB integration templates
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
+     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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/IntegrationsApi~listIntegrationTemplatesCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    listIntegrationTemplates(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the migrateAirtableSyncRule operation.
+     * @callback module:api/IntegrationsApi~migrateAirtableSyncRuleCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * One-time import for rule
+     * @param {String} ruleId
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
+     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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/IntegrationsApi~migrateAirtableSyncRuleCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    migrateAirtableSyncRule(ruleId: string, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the provisionAirtableSyncRule operation.
+     * @callback module:api/IntegrationsApi~provisionAirtableSyncRuleCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Provision DataSync for rule
+     * @param {String} ruleId
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
+     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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/IntegrationsApi~provisionAirtableSyncRuleCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    provisionAirtableSyncRule(ruleId: string, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the saveAirtableSyncRule operation.
+     * @callback module:api/IntegrationsApi~saveAirtableSyncRuleCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create or update Airtable sync rule
+     * @param {String} ruleId
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
+     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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/AirtableSyncRuleInput} [airtableSyncRuleInput]
+     * @param {module:api/IntegrationsApi~saveAirtableSyncRuleCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    saveAirtableSyncRule(ruleId: string, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the testIntegrationInstance operation.
+     * @callback module:api/IntegrationsApi~testIntegrationInstanceCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Test integration connection
+     * @param {Number} id
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
+     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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/IntegrationsApi~testIntegrationInstanceCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    testIntegrationInstance(id: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the updateIntegrationInstance operation.
+     * @callback module:api/IntegrationsApi~updateIntegrationInstanceCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Update integration instance
+     * @param {Number} id
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
+     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @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/IntegrationInstanceInput} [integrationInstanceInput]
+     * @param {module:api/IntegrationsApi~updateIntegrationInstanceCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    updateIntegrationInstance(id: number, opts: any, callback: any): any;
+}