@gobodo/gobodo-api 0.1.238 → 1.0.0

package/dist/api/MembershipAdministrationApi.d.ts

@@ -0,0 +1,436 @@
+/**
+* MembershipAdministration service.
+* @module api/MembershipAdministrationApi
+* @version 1.0.0
+*/
+export default class MembershipAdministrationApi {
+    /**
+    * Constructs a new MembershipAdministrationApi.
+    * @alias module:api/MembershipAdministrationApi
+    * @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 adoptMembershipConsoleCurrency operation.
+     * @callback module:api/MembershipAdministrationApi~adoptMembershipConsoleCurrencyCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ConsoleCurrency} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Adopt an existing non-cash-out currency as a console currency
+     * @param {Number} currencyId
+     * @param {Object} opts Optional parameters
+     * @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/ConsoleCurrencyAdoptionInput} [consoleCurrencyAdoptionInput]
+     * @param {module:api/MembershipAdministrationApi~adoptMembershipConsoleCurrencyCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ConsoleCurrency}
+     */
+    adoptMembershipConsoleCurrency(currencyId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createMembershipCatalogTier operation.
+     * @callback module:api/MembershipAdministrationApi~createMembershipCatalogTierCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MembershipTier} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create a membership tier and sync it to Stripe
+     * @param {module:model/MembershipTierInput} membershipTierInput
+     * @param {Object} opts Optional parameters
+     * @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/MembershipAdministrationApi~createMembershipCatalogTierCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MembershipTier}
+     */
+    createMembershipCatalogTier(membershipTierInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createMembershipConsoleCurrency operation.
+     * @callback module:api/MembershipAdministrationApi~createMembershipConsoleCurrencyCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ConsoleCurrency} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create a console currency
+     * @param {module:model/ConsoleCurrencyInput} consoleCurrencyInput
+     * @param {Object} opts Optional parameters
+     * @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/MembershipAdministrationApi~createMembershipConsoleCurrencyCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ConsoleCurrency}
+     */
+    createMembershipConsoleCurrency(consoleCurrencyInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createMembershipTierGrant operation.
+     * @callback module:api/MembershipAdministrationApi~createMembershipTierGrantCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MembershipCurrencyGrant} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Add a currency grant policy to a tier
+     * @param {Number} tierId
+     * @param {module:model/MembershipCurrencyGrantInput} membershipCurrencyGrantInput
+     * @param {Object} opts Optional parameters
+     * @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/MembershipAdministrationApi~createMembershipTierGrantCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MembershipCurrencyGrant}
+     */
+    createMembershipTierGrant(tierId: number, membershipCurrencyGrantInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the deactivateMembershipCatalogTier operation.
+     * @callback module:api/MembershipAdministrationApi~deactivateMembershipCatalogTierCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MembershipTier} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Deactivate a membership tier
+     * @param {Number} tierId
+     * @param {Object} opts Optional parameters
+     * @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/MembershipAdministrationApi~deactivateMembershipCatalogTierCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MembershipTier}
+     */
+    deactivateMembershipCatalogTier(tierId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the deleteMembershipCatalogTier operation.
+     * @callback module:api/MembershipAdministrationApi~deleteMembershipCatalogTierCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MembershipTier} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Deactivate a membership tier
+     * Tiers are never removed, so existing subscriptions keep their tier.
+     * @param {Number} tierId
+     * @param {Object} opts Optional parameters
+     * @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/MembershipAdministrationApi~deleteMembershipCatalogTierCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MembershipTier}
+     */
+    deleteMembershipCatalogTier(tierId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the deleteMembershipConsoleCurrency operation.
+     * @callback module:api/MembershipAdministrationApi~deleteMembershipConsoleCurrencyCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Delete an unused console currency
+     * @param {Number} currencyId
+     * @param {Object} opts Optional parameters
+     * @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/MembershipAdministrationApi~deleteMembershipConsoleCurrencyCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    deleteMembershipConsoleCurrency(currencyId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the deleteMembershipTierGrant operation.
+     * @callback module:api/MembershipAdministrationApi~deleteMembershipTierGrantCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Remove a tier's currency grant policy
+     * @param {Number} tierId
+     * @param {Number} grantId
+     * @param {Object} opts Optional parameters
+     * @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/MembershipAdministrationApi~deleteMembershipTierGrantCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    deleteMembershipTierGrant(tierId: number, grantId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the listAdoptableMembershipConsoleCurrencies operation.
+     * @callback module:api/MembershipAdministrationApi~listAdoptableMembershipConsoleCurrenciesCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/ConsoleCurrency>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List non-cash-out currencies that can be adopted as console currencies
+     * @param {Object} opts Optional parameters
+     * @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/MembershipAdministrationApi~listAdoptableMembershipConsoleCurrenciesCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/ConsoleCurrency>}
+     */
+    listAdoptableMembershipConsoleCurrencies(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the listMembershipCatalogTiers operation.
+     * @callback module:api/MembershipAdministrationApi~listMembershipCatalogTiersCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/MembershipTier>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List all membership tiers, including inactive tiers
+     * @param {Object} opts Optional parameters
+     * @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/MembershipAdministrationApi~listMembershipCatalogTiersCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/MembershipTier>}
+     */
+    listMembershipCatalogTiers(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the listMembershipConsoleCurrencies operation.
+     * @callback module:api/MembershipAdministrationApi~listMembershipConsoleCurrenciesCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/ConsoleCurrency>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List console currencies
+     * @param {Object} opts Optional parameters
+     * @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/MembershipAdministrationApi~listMembershipConsoleCurrenciesCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/ConsoleCurrency>}
+     */
+    listMembershipConsoleCurrencies(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the listMembershipTierGrants operation.
+     * @callback module:api/MembershipAdministrationApi~listMembershipTierGrantsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/MembershipCurrencyGrant>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List a tier's currency grant policies
+     * @param {Number} tierId
+     * @param {Object} opts Optional parameters
+     * @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/MembershipAdministrationApi~listMembershipTierGrantsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/MembershipCurrencyGrant>}
+     */
+    listMembershipTierGrants(tierId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the syncMembershipCatalogTier operation.
+     * @callback module:api/MembershipAdministrationApi~syncMembershipCatalogTierCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MembershipTier} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Retry the Stripe catalog sync for a tier
+     * @param {Number} tierId
+     * @param {Object} opts Optional parameters
+     * @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/MembershipAdministrationApi~syncMembershipCatalogTierCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MembershipTier}
+     */
+    syncMembershipCatalogTier(tierId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the updateMembershipCatalogTier operation.
+     * @callback module:api/MembershipAdministrationApi~updateMembershipCatalogTierCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MembershipTier} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Update a membership tier and sync it to Stripe
+     * @param {Number} tierId
+     * @param {module:model/MembershipTierInput} membershipTierInput
+     * @param {Object} opts Optional parameters
+     * @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/MembershipAdministrationApi~updateMembershipCatalogTierCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MembershipTier}
+     */
+    updateMembershipCatalogTier(tierId: number, membershipTierInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the updateMembershipConsoleCurrency operation.
+     * @callback module:api/MembershipAdministrationApi~updateMembershipConsoleCurrencyCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ConsoleCurrency} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Update a console currency
+     * @param {Number} currencyId
+     * @param {module:model/ConsoleCurrencyInput} consoleCurrencyInput
+     * @param {Object} opts Optional parameters
+     * @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/MembershipAdministrationApi~updateMembershipConsoleCurrencyCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ConsoleCurrency}
+     */
+    updateMembershipConsoleCurrency(currencyId: number, consoleCurrencyInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the updateMembershipTierGrant operation.
+     * @callback module:api/MembershipAdministrationApi~updateMembershipTierGrantCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MembershipCurrencyGrant} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Update a tier's currency grant policy
+     * @param {Number} tierId
+     * @param {Number} grantId
+     * @param {module:model/MembershipCurrencyGrantInput} membershipCurrencyGrantInput
+     * @param {Object} opts Optional parameters
+     * @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/MembershipAdministrationApi~updateMembershipTierGrantCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MembershipCurrencyGrant}
+     */
+    updateMembershipTierGrant(tierId: number, grantId: number, membershipCurrencyGrantInput: any, opts: any, callback: any): any;
+}
+//# sourceMappingURL=MembershipAdministrationApi.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"MembershipAdministrationApi.d.ts","sourceRoot":"","sources":["../../src/api/MembershipAdministrationApi.js"],"names":[],"mappings":"AAuBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAIpD;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,wEAHW,GAA6E,OAyCvF;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,iDAhBW,GAAgC,uBAahC,GAA0E,OAwCpF;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,sDAhBW,GAAiC,uBAajC,GAA8E,OAwCxF;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,wEAhBW,GAAyC,uBAazC,GAAwE,OA6ClF;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,qEAHW,GAA8E,OAyCxF;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,iEAHW,GAA0E,OAyCpF;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,yEAFW,GAA8E,OAwCxF;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,gFAFW,GAAwE,OA6ClF;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,8DAHW,GAAuF,OAoCjG;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,gDAHW,GAAyE,OAoCnF;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,qDAHW,GAA8E,OAoCxF;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,8DAHW,GAAuE,OAyCjF;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,+DAHW,GAAwE,OAyClF;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,iEAhBW,GAAgC,uBAahC,GAA0E,OA6CpF;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,0EAhBW,GAAiC,uBAajC,GAA8E,OA6CxF;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,yFAhBW,GAAyC,uBAazC,GAAwE,OAkDlF;CAGJ"}