@gobodo/gobodo-api 0.1.240 → 1.0.1

package/dist/api/CurrencyApi.d.ts

@@ -1,7 +1,7 @@
 /**
 * Currency service.
 * @module api/CurrencyApi
-* @version 0.1.240
+* @version 1.0.1
 */
 export default class CurrencyApi {
     /**
@@ -21,278 +21,238 @@ export default class CurrencyApi {
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Create a new currency
      * @param {module:model/CurrencyInput} currencyInput
      * @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] 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/CurrencyApi~createCurrencyCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/CurrencyResponse}
      */
     createCurrency(currencyInput: any, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the getAllCurrencies operation.
-     * @callback module:api/CurrencyApi~getAllCurrenciesCallback
-     * @param {String} error Error message, if any.
-     * @param {Array.<module:model/CurrencyResponse>} data The data returned by the service call.
-     * @param {String} response The complete HTTP response.
-     */
-    /**
-     * Get all currencies
-     * @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 {Number} [userid]
-     * @param {Number} [pagenum]
-     * @param {Number} [pagesize]
-     * @param {module:api/CurrencyApi~getAllCurrenciesCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Array.<module:model/CurrencyResponse>}
-     */
-    getAllCurrencies(opts: any, callback: any): any;
-    /**
-     * Callback function to receive the result of the getCurrencyById operation.
-     * @callback module:api/CurrencyApi~getCurrencyByIdCallback
+     * Callback function to receive the result of the getCurrency operation.
+     * @callback module:api/CurrencyApi~getCurrencyCallback
      * @param {String} error Error message, if any.
      * @param {module:model/CurrencyResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Get a currency by id
      * @param {Number} currencyId
      * @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 {module:api/CurrencyApi~getCurrencyByIdCallback} callback The callback function, accepting three arguments: error, data, response
+     * @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/CurrencyApi~getCurrencyCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/CurrencyResponse}
      */
-    getCurrencyById(currencyId: number, opts: any, callback: any): any;
+    getCurrency(currencyId: number, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the getCurrencyHolderDetail operation.
-     * @callback module:api/CurrencyApi~getCurrencyHolderDetailCallback
+     * Callback function to receive the result of the getCurrencyHolder operation.
+     * @callback module:api/CurrencyApi~getCurrencyHolderCallback
      * @param {String} error Error message, if any.
      * @param {module:model/CurrencyHolderDetailResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Get one user's combined balance for a currency
+     * Requires currency manage permission
      * @param {Number} currencyId
      * @param {Number} userId
      * @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 {module:api/CurrencyApi~getCurrencyHolderDetailCallback} callback The callback function, accepting three arguments: error, data, response
+     * @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/CurrencyApi~getCurrencyHolderCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/CurrencyHolderDetailResponse}
      */
-    getCurrencyHolderDetail(currencyId: number, userId: number, opts: any, callback: any): any;
+    getCurrencyHolder(currencyId: number, userId: number, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the getCurrencyHolders operation.
-     * @callback module:api/CurrencyApi~getCurrencyHoldersCallback
+     * Callback function to receive the result of the getCurrencyLedger operation.
+     * @callback module:api/CurrencyApi~getCurrencyLedgerCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/CurrencyHolderPageResponse} data The data returned by the service call.
+     * @param {module:model/CurrencyLedgerPageResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * List wallets and balances for a currency (admins or a minting root app)
+     * Requires currency manage permission
      * @param {Number} currencyId
      * @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 {Number} [userid]
-     * @param {Number} [pagenum]
-     * @param {Number} [pagesize]
-     * @param {module:api/CurrencyApi~getCurrencyHoldersCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/CurrencyHolderPageResponse}
+     * @param {Number} [userId]
+     * @param {String} [type]
+     * @param {Number} [pageNum]
+     * @param {Number} [pageSize]
+     * @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/CurrencyApi~getCurrencyLedgerCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/CurrencyLedgerPageResponse}
      */
-    getCurrencyHolders(currencyId: number, opts: any, callback: any): any;
+    getCurrencyLedger(currencyId: number, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the getCurrencyLedger operation.
-     * @callback module:api/CurrencyApi~getCurrencyLedgerCallback
+     * Callback function to receive the result of the getCurrencyRegistrationStatus operation.
+     * @callback module:api/CurrencyApi~getCurrencyRegistrationStatusCallback
      * @param {String} error Error message, if any.
-     * @param {module:model/CurrencyLedgerPageResponse} data The data returned by the service call.
+     * @param {module:model/CurrencyRegistrationStatusResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * List wallet transactions for a currency
+     * Whether the currency is registered with a minter (the root category when minterId is omitted)
      * @param {Number} currencyId
      * @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 {Number} [userid]
-     * @param {String} [type]
-     * @param {Number} [pagenum]
-     * @param {Number} [pagesize]
-     * @param {module:api/CurrencyApi~getCurrencyLedgerCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link module:model/CurrencyLedgerPageResponse}
+     * @param {Number} [minterId]
+     * @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/CurrencyApi~getCurrencyRegistrationStatusCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/CurrencyRegistrationStatusResponse}
      */
-    getCurrencyLedger(currencyId: number, opts: any, callback: any): any;
+    getCurrencyRegistrationStatus(currencyId: number, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the getRegisteredCurrencies operation.
-     * @callback module:api/CurrencyApi~getRegisteredCurrenciesCallback
+     * Callback function to receive the result of the listCurrencies operation.
+     * @callback module:api/CurrencyApi~listCurrenciesCallback
      * @param {String} error Error message, if any.
      * @param {Array.<module:model/CurrencyResponse>} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Get all currencies registered by a minter
-     * @param {Number} minterId
      * @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 {module:api/CurrencyApi~getRegisteredCurrenciesCallback} callback The callback function, accepting three arguments: error, data, response
+     * @param {Number} [userId]
+     * @param {Number} [pageNum]
+     * @param {Number} [pageSize]
+     * @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/CurrencyApi~listCurrenciesCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link Array.<module:model/CurrencyResponse>}
      */
-    getRegisteredCurrencies(minterId: number, opts: any, callback: any): any;
+    listCurrencies(opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the isCurrencyRegistered operation.
-     * @callback module:api/CurrencyApi~isCurrencyRegisteredCallback
+     * Callback function to receive the result of the listCurrencyHolders operation.
+     * @callback module:api/CurrencyApi~listCurrencyHoldersCallback
      * @param {String} error Error message, if any.
-     * @param {Boolean} data The data returned by the service call.
+     * @param {module:model/CurrencyHolderPageResponse} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Check if a currency is registered
+     * Requires currency manage permission
      * @param {Number} currencyId
      * @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 {module:api/CurrencyApi~isCurrencyRegisteredCallback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Boolean}
+     * @param {Number} [userId]
+     * @param {Number} [pageNum]
+     * @param {Number} [pageSize]
+     * @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/CurrencyApi~listCurrencyHoldersCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/CurrencyHolderPageResponse}
      */
-    isCurrencyRegistered(currencyId: number, opts: any, callback: any): any;
+    listCurrencyHolders(currencyId: number, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the isCurrencyRegistered1 operation.
-     * @callback module:api/CurrencyApi~isCurrencyRegistered1Callback
+     * Callback function to receive the result of the listMinterCurrencies operation.
+     * @callback module:api/CurrencyApi~listMinterCurrenciesCallback
      * @param {String} error Error message, if any.
-     * @param {Boolean} data The data returned by the service call.
+     * @param {Array.<module:model/CurrencyResponse>} data The data returned by the service call.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Check if a currency is registered with a minter
      * @param {Number} minterId
-     * @param {Number} currencyId
      * @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 {module:api/CurrencyApi~isCurrencyRegistered1Callback} callback The callback function, accepting three arguments: error, data, response
-     * data is of type: {@link Boolean}
+     * @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/CurrencyApi~listMinterCurrenciesCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/CurrencyResponse>}
      */
-    isCurrencyRegistered1(minterId: number, currencyId: number, opts: any, callback: any): any;
+    listMinterCurrencies(minterId: number, opts: any, callback: any): any;
     /**
-     * Callback function to receive the result of the registerCurrency operation.
-     * @callback module:api/CurrencyApi~registerCurrencyCallback
+     * Callback function to receive the result of the registerCurrencyMinter operation.
+     * @callback module:api/CurrencyApi~registerCurrencyMinterCallback
      * @param {String} error Error message, if any.
      * @param data This operation does not return a value.
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Register a currency with a minter
+     * Register a currency with a minter; requires currency manage permission
      * @param {module:model/CurrencyMinterRegistrationInput} currencyMinterRegistrationInput
      * @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 {module:api/CurrencyApi~registerCurrencyCallback} callback The callback function, accepting three arguments: error, data, response
+     * @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/CurrencyApi~registerCurrencyMinterCallback} callback The callback function, accepting three arguments: error, data, response
      */
-    registerCurrency(currencyMinterRegistrationInput: any, opts: any, callback: any): any;
+    registerCurrencyMinter(currencyMinterRegistrationInput: any, opts: any, callback: any): any;
     /**
      * Callback function to receive the result of the updateCurrency operation.
      * @callback module:api/CurrencyApi~updateCurrencyCallback
@@ -301,22 +261,21 @@ export default class CurrencyApi {
      * @param {String} response The complete HTTP response.
      */
     /**
-     * Update a currency
+     * Replace a currency's settings; requires edit permission on the currency
      * @param {Number} currencyId
      * @param {module:model/CurrencyInput} currencyInput
      * @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] 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/CurrencyApi~updateCurrencyCallback} callback The callback function, accepting three arguments: error, data, response
      * data is of type: {@link module:model/CurrencyResponse}
      */

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

@@ -1 +1 @@
-{"version":3,"file":"CurrencyApi.d.ts","sourceRoot":"","sources":["../../src/api/CurrencyApi.js"],"names":[],"mappings":"AAuBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAIpD;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,8BAjBW,GAA0B,uBAc1B,GAA6C,OAyCvD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,sCAHW,GAA+C,OAwCzD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,yDAHW,GAA8C,OA0CxD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,iFAHW,GAAsD,OA+ChE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,4DAHW,GAAiD,OA6C3D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,2DAHW,GAAgD,OA8C1D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,+DAHW,GAAsD,OA0ChE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,8DAHW,GAAmD,OA0C7D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,iFAHW,GAAoD,OA+C9D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,kDAhBW,GAA4C,uBAc5C,GAA+C,OAwCzD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,kDAjBW,GAA0B,uBAc1B,GAA6C,OA8CvD;CAGJ"}
+{"version":3,"file":"CurrencyApi.d.ts","sourceRoot":"","sources":["../../src/api/CurrencyApi.js"],"names":[],"mappings":"AAuBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAIpD;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,8BAhBW,GAA0B,uBAa1B,GAA6C,OAwCvD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,qDAHW,GAA0C,OAyCpD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,2EAHW,GAAgD,OA8C1D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,2DAHW,GAAgD,OA6C1D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,uEAHW,GAA4D,OA0CtE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,oCAHW,GAA6C,OAuCvD;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,6DAHW,GAAkD,OA4C5D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,4DAHW,GAAmD,OAyC7D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,wDAfW,GAA4C,uBAa5C,GAAqD,OAuC/D;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,kDAhBW,GAA0B,uBAa1B,GAA6C,OA6CvD;CAGJ"}