@gobodo/gobodo-api 0.1.240 → 1.0.1

package/dist/api/SyncApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * Sync service.
 * @module api/SyncApi
-* @version 0.1.240
+* @version 1.0.1
 */
 export default class SyncApi {
     /**
@@ -13,6 +13,64 @@ export default class SyncApi {
     */
     constructor(apiClient?: any);
     apiClient: any;
+    /**
+     * Callback function to receive the result of the exportToDynamoDB operation.
+     * @callback module:api/SyncApi~exportToDynamoDBCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/SyncExportResult} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Tenant one-time export to DynamoDB
+     * @param {Object} opts Optional parameters
+     * @param {Number} [objectTypeId]
+     * @param {Number} [relationshipTypeId]
+     * @param {Number} [actionTypeId]
+     * @param {String} [transactionid] Not supported here: this write cannot be staged, so a request carrying a transaction id is rejected with 400 rather than run outside the transaction. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
+     * @param {module:api/SyncApi~exportToDynamoDBCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/SyncExportResult}
+     */
+    exportToDynamoDB(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the exportToSql operation.
+     * @callback module:api/SyncApi~exportToSqlCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/SyncExportResult} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Tenant one-time export to SQL
+     * @param {Object} opts Optional parameters
+     * @param {Number} [objectTypeId]
+     * @param {Number} [relationshipTypeId]
+     * @param {Number} [actionTypeId]
+     * @param {Number} [siteId]
+     * @param {Number} [appId]
+     * @param {String} [transactionid] Not supported here: this write cannot be staged, so a request carrying a transaction id is rejected with 400 rather than run outside the transaction. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
+     * @param {module:api/SyncApi~exportToSqlCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/SyncExportResult}
+     */
+    exportToSql(opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the getPortalSyncStatus operation.
      * @callback module:api/SyncApi~getPortalSyncStatusCallback
@@ -22,23 +80,131 @@ export default class SyncApi {
      */
     /**
      * Get portal-wide sync status
-     * Returns whether SQL and DynamoDB sync are enabled portal-wide. Used by tenant Data Sync UI to gate configuration when portal sync is off.
      * @param {Object} opts Optional parameters
-     * @param {String} [authorization] The authorization token of the logged in user
-     * @param {Number} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
-     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to. May be provided as repeated query params.
-     * @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 {Array.<String>} [cacheuser] The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user). May be provided as repeated query params.
-     * @param {Array.<module:model/CacheInvalidation>} [invalidationkeys] Cache keys that should be invalidated in this operation. May be provided as repeated query params or as a JSON array string.
-     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
-     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
-     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
-     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
-     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {String} [transactionid] Ignored on reads. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
      * @param {module:api/SyncApi~getPortalSyncStatusCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/SyncPortalStatusResponse}
      */
     getPortalSyncStatus(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getTenantDynamoDbSyncConfig operation.
+     * @callback module:api/SyncApi~getTenantDynamoDbSyncConfigCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/DynamoDbSyncTenantConfigResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get tenant DynamoDB sync config
+     * @param {Object} opts Optional parameters
+     * @param {Number} [siteId]
+     * @param {Number} [appId]
+     * @param {String} [transactionid] Ignored on reads. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
+     * @param {module:api/SyncApi~getTenantDynamoDbSyncConfigCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/DynamoDbSyncTenantConfigResponse}
+     */
+    getTenantDynamoDbSyncConfig(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getTenantSqlSyncConfig operation.
+     * @callback module:api/SyncApi~getTenantSqlSyncConfigCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/SqlSyncTenantConfigResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get tenant SQL sync config
+     * @param {Object} opts Optional parameters
+     * @param {Number} [siteId]
+     * @param {Number} [appId]
+     * @param {String} [transactionid] Ignored on reads. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
+     * @param {module:api/SyncApi~getTenantSqlSyncConfigCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/SqlSyncTenantConfigResponse}
+     */
+    getTenantSqlSyncConfig(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the updateTenantDynamoDbSyncConfig operation.
+     * @callback module:api/SyncApi~updateTenantDynamoDbSyncConfigCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/DynamoDbSyncTenantConfigResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Update tenant DynamoDB sync config
+     * @param {Object} opts Optional parameters
+     * @param {Number} [siteId]
+     * @param {Number} [appId]
+     * @param {String} [transactionid] Not supported here: this write cannot be staged, so a request carrying a transaction id is rejected with 400 rather than run outside the transaction. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
+     * @param {module:model/DynamoDbSyncTenantConfigRequest} [dynamoDbSyncTenantConfigRequest]
+     * @param {module:api/SyncApi~updateTenantDynamoDbSyncConfigCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/DynamoDbSyncTenantConfigResponse}
+     */
+    updateTenantDynamoDbSyncConfig(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the updateTenantSqlSyncConfig operation.
+     * @callback module:api/SyncApi~updateTenantSqlSyncConfigCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/SqlSyncTenantConfigResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Update tenant SQL sync config
+     * @param {Object} opts Optional parameters
+     * @param {Number} [siteId]
+     * @param {Number} [appId]
+     * @param {String} [transactionid] Not supported here: this write cannot be staged, so a request carrying a transaction id is rejected with 400 rather than run outside the transaction. Alias: X-Gobodo-Transaction-Id.
+     * @param {Number} [zeusportalPostas] Id of the organization page to perform this operation as; the caller must administer the page. Alias: X-Gobodo-Post-As-Page.
+     * @param {Number} [zeusportalPostasApp] Id of the application to perform this operation as; the caller must administer the application. Alias: X-Gobodo-Post-As-App.
+     * @param {Number} [zeusportalPostasSite] Id of the site to perform this operation as; the caller must administer the site. Alias: X-Gobodo-Post-As-Site.
+     * @param {Number} [zeusportalPostasOrg] Id of the console organization to perform this operation as; the caller needs create permission in the organization. Alias: X-Gobodo-Post-As-Organization.
+     * @param {Array.<String>} [cachekey] REST request cache key. Repeat the parameter or send one JSON array string. Applies only where the platform enables the REST request cache.
+     * @param {module:model/String} [cachescope = 'APPLICATION')] Scope of the cachekey entry.
+     * @param {Number} [cacheduration] Cache duration override in seconds, capped by the platform maximum.
+     * @param {Array.<String>} [cachegroup] Cache group(s) the cachekey entry belongs to. Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {Array.<String>} [cacheuser] Users the cachekey entry applies to (used to clear entries cached for those users). Repeat the parameter. Honored by the gobodo-rest-cache edge layer; no effect on the v1 path until it is routed through that layer.
+     * @param {String} [invalidationkeys] On writes, a JSON array of {\"key\": [...], \"scope\": \"APPLICATION|SESSION|USER|ALL\"} entries whose cached responses are removed.
+     * @param {module:model/SqlSyncTenantConfigRequest} [sqlSyncTenantConfigRequest]
+     * @param {module:api/SyncApi~updateTenantSqlSyncConfigCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/SqlSyncTenantConfigResponse}
+     */
+    updateTenantSqlSyncConfig(opts: any, callback: any): any;
 }
 //# sourceMappingURL=SyncApi.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"SyncApi.d.ts","sourceRoot":"","sources":["../../src/api/SyncApi.js"],"names":[],"mappings":"AAkBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAIpD;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,yCAHW,GAA8C,OAqCxD;CAGJ"}
+{"version":3,"file":"SyncApi.d.ts","sourceRoot":"","sources":["../../src/api/SyncApi.js"],"names":[],"mappings":"AAsBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAIpD;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,sCAHW,GAA2C,OAuCrD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,iCAHW,GAAsC,OAyChD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,yCAHW,GAA8C,OAoCxD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,iDAHW,GAAsD,OAsChE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,4CAHW,GAAiD,OAsC3D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,oDAHW,GAAyD,OAsCnE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,+CAHW,GAAoD,OAsC9D;CAGJ"}