@gobodo/gobodo-api 0.1.236 → 0.1.237

package/dist/api/MembershipsApi.d.ts

@@ -0,0 +1,552 @@
+/**
+* Memberships service.
+* @module api/MembershipsApi
+* @version 0.1.237
+*/
+export default class MembershipsApi {
+    /**
+    * Constructs a new MembershipsApi.
+    * @alias module:api/MembershipsApi
+    * @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/MembershipsApi~adoptMembershipConsoleCurrencyCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ConsoleCurrencyResponse} 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 {module:model/ConsoleCurrencyAdoptionInput} consoleCurrencyAdoptionInput
+     * @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/MembershipsApi~adoptMembershipConsoleCurrencyCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ConsoleCurrencyResponse}
+     */
+    adoptMembershipConsoleCurrency(currencyId: number, consoleCurrencyAdoptionInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the bootstrapFreeMembershipTier operation.
+     * @callback module:api/MembershipsApi~bootstrapFreeMembershipTierCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create the free membership catalog tier when absent
+     * @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/MembershipsApi~bootstrapFreeMembershipTierCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    bootstrapFreeMembershipTier(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createMembershipCatalogTier operation.
+     * @callback module:api/MembershipsApi~createMembershipCatalogTierCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MembershipTierResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create a platform membership tier
+     * @param {module:model/MembershipTierInput} membershipTierInput
+     * @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/MembershipsApi~createMembershipCatalogTierCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MembershipTierResponse}
+     */
+    createMembershipCatalogTier(membershipTierInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createMembershipConsoleCurrency operation.
+     * @callback module:api/MembershipsApi~createMembershipConsoleCurrencyCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ConsoleCurrencyResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create a non-cash-out membership console currency
+     * @param {module:model/ConsoleCurrencyInput} consoleCurrencyInput
+     * @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/MembershipsApi~createMembershipConsoleCurrencyCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ConsoleCurrencyResponse}
+     */
+    createMembershipConsoleCurrency(consoleCurrencyInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createMembershipTierCurrencyGrant operation.
+     * @callback module:api/MembershipsApi~createMembershipTierCurrencyGrantCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MembershipCurrencyGrantResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create a membership tier currency grant
+     * @param {Number} tierId
+     * @param {module:model/MembershipCurrencyGrantInput} membershipCurrencyGrantInput
+     * @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/MembershipsApi~createMembershipTierCurrencyGrantCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MembershipCurrencyGrantResponse}
+     */
+    createMembershipTierCurrencyGrant(tierId: number, membershipCurrencyGrantInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the deactivateMembershipCatalogTier operation.
+     * @callback module:api/MembershipsApi~deactivateMembershipCatalogTierCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MembershipTierResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Deactivate a platform membership tier
+     * @param {Number} tierId
+     * @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/MembershipsApi~deactivateMembershipCatalogTierCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MembershipTierResponse}
+     */
+    deactivateMembershipCatalogTier(tierId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the deleteMembershipCatalogTier operation.
+     * @callback module:api/MembershipsApi~deleteMembershipCatalogTierCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MembershipTierResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Deactivate a platform membership tier
+     * @param {Number} tierId
+     * @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/MembershipsApi~deleteMembershipCatalogTierCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MembershipTierResponse}
+     */
+    deleteMembershipCatalogTier(tierId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the deleteMembershipConsoleCurrency operation.
+     * @callback module:api/MembershipsApi~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 non-main console currency
+     * @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/MembershipsApi~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 deleteMembershipTierCurrencyGrant operation.
+     * @callback module:api/MembershipsApi~deleteMembershipTierCurrencyGrantCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Delete a membership tier currency grant
+     * @param {Number} tierId
+     * @param {Number} grantId
+     * @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/MembershipsApi~deleteMembershipTierCurrencyGrantCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    deleteMembershipTierCurrencyGrant(tierId: number, grantId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getActiveMembershipTiers operation.
+     * @callback module:api/MembershipsApi~getActiveMembershipTiersCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List active membership tiers
+     * @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/MembershipsApi~getActiveMembershipTiersCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    getActiveMembershipTiers(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getFreeMembershipTier operation.
+     * @callback module:api/MembershipsApi~getFreeMembershipTierCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Read the implicit free membership tier
+     * @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/MembershipsApi~getFreeMembershipTierCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    getFreeMembershipTier(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getMainMembershipConsoleCurrency operation.
+     * @callback module:api/MembershipsApi~getMainMembershipConsoleCurrencyCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ConsoleCurrencyResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Read the configured main console currency
+     * @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/MembershipsApi~getMainMembershipConsoleCurrencyCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ConsoleCurrencyResponse}
+     */
+    getMainMembershipConsoleCurrency(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the listAdoptableMembershipConsoleCurrencies operation.
+     * @callback module:api/MembershipsApi~listAdoptableMembershipConsoleCurrenciesCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/ConsoleCurrencyResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List existing non-cash-out currencies that can be adopted as console 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 {module:api/MembershipsApi~listAdoptableMembershipConsoleCurrenciesCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/ConsoleCurrencyResponse>}
+     */
+    listAdoptableMembershipConsoleCurrencies(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the listMembershipCatalogTiers operation.
+     * @callback module:api/MembershipsApi~listMembershipCatalogTiersCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/MembershipTierResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List platform membership tiers
+     * @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/MembershipsApi~listMembershipCatalogTiersCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/MembershipTierResponse>}
+     */
+    listMembershipCatalogTiers(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the listMembershipConsoleCurrencies operation.
+     * @callback module:api/MembershipsApi~listMembershipConsoleCurrenciesCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/ConsoleCurrencyResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List non-cash-out membership console 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 {module:api/MembershipsApi~listMembershipConsoleCurrenciesCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/ConsoleCurrencyResponse>}
+     */
+    listMembershipConsoleCurrencies(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the listMembershipTierCurrencyGrants operation.
+     * @callback module:api/MembershipsApi~listMembershipTierCurrencyGrantsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/MembershipCurrencyGrantResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List membership tier currency grants
+     * @param {Number} tierId
+     * @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/MembershipsApi~listMembershipTierCurrencyGrantsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/MembershipCurrencyGrantResponse>}
+     */
+    listMembershipTierCurrencyGrants(tierId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the retryMembershipCatalogTierSync operation.
+     * @callback module:api/MembershipsApi~retryMembershipCatalogTierSyncCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MembershipTierResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Retry Stripe catalog synchronization
+     * @param {Number} tierId
+     * @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/MembershipsApi~retryMembershipCatalogTierSyncCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MembershipTierResponse}
+     */
+    retryMembershipCatalogTierSync(tierId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the updateMembershipCatalogTier operation.
+     * @callback module:api/MembershipsApi~updateMembershipCatalogTierCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MembershipTierResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Update a platform membership tier
+     * @param {Number} tierId
+     * @param {module:model/MembershipTierInput} membershipTierInput
+     * @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/MembershipsApi~updateMembershipCatalogTierCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MembershipTierResponse}
+     */
+    updateMembershipCatalogTier(tierId: number, membershipTierInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the updateMembershipConsoleCurrency operation.
+     * @callback module:api/MembershipsApi~updateMembershipConsoleCurrencyCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ConsoleCurrencyResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Update a non-cash-out membership console currency
+     * @param {Number} currencyId
+     * @param {module:model/ConsoleCurrencyInput} consoleCurrencyInput
+     * @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/MembershipsApi~updateMembershipConsoleCurrencyCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ConsoleCurrencyResponse}
+     */
+    updateMembershipConsoleCurrency(currencyId: number, consoleCurrencyInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the updateMembershipTierCurrencyGrant operation.
+     * @callback module:api/MembershipsApi~updateMembershipTierCurrencyGrantCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MembershipCurrencyGrantResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Update a membership tier currency grant
+     * @param {Number} tierId
+     * @param {Number} grantId
+     * @param {module:model/MembershipCurrencyGrantInput} membershipCurrencyGrantInput
+     * @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/MembershipsApi~updateMembershipTierCurrencyGrantCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MembershipCurrencyGrantResponse}
+     */
+    updateMembershipTierCurrencyGrant(tierId: number, grantId: number, membershipCurrencyGrantInput: any, opts: any, callback: any): any;
+}
+//# sourceMappingURL=MembershipsApi.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"MembershipsApi.d.ts","sourceRoot":"","sources":["../../src/api/MembershipsApi.js"],"names":[],"mappings":"AAyBA;;;;EAIE;AACF;IAEI;;;;;;MAME;IACF,wBAHU,GAAgB,EAKzB;IADG,eAAgD;IAIpD;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,iFAjBW,GAAyC,uBAczC,GAAgE,OA8C1E;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,iDAFW,GAA6D,OAoCvE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,iDAjBW,GAAgC,uBAchC,GAA6D,OAyCvE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,sDAjBW,GAAiC,uBAcjC,GAAiE,OAyC3E;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,gFAjBW,GAAyC,uBAczC,GAAmE,OA8C7E;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,qEAHW,GAAiE,OA0C3E;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,iEAHW,GAA6D,OA0CvE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,yEAFW,GAAiE,OAyC3E;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,wFAFW,GAAmE,OA8C7E;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,8CAFW,GAA0D,OAoCpE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;OAgBG;IACH,2CAFW,GAAuD,OAoCjE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,sDAHW,GAAkE,OAqC5E;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,8DAHW,GAA0E,OAqCpF;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,gDAHW,GAA4D,OAqCtE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;OAiBG;IACH,qDAHW,GAAiE,OAqC3E;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,sEAHW,GAAkE,OA0C5E;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;OAkBG;IACH,oEAHW,GAAgE,OA0C1E;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,iEAjBW,GAAgC,uBAchC,GAA6D,OA8CvE;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACH,0EAjBW,GAAiC,uBAcjC,GAAiE,OA8C3E;IAED;;;;;;OAMG;IAEH;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,iGAjBW,GAAyC,uBAczC,GAAmE,OAmD7E;CAGJ"}