@gobodo/gobodo-api 0.1.222 → 0.1.224

package/dist/api/LegacyAdministratorsApi.d.ts

@@ -0,0 +1,262 @@
+/**
+* LegacyAdministrators service.
+* @module api/LegacyAdministratorsApi
+* @version 0.1.224
+*/
+export default class LegacyAdministratorsApi {
+    /**
+    * Constructs a new LegacyAdministratorsApi.
+    * @alias module:api/LegacyAdministratorsApi
+    * @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 addAppAdministrator operation.
+     * @callback module:api/LegacyAdministratorsApi~addAppAdministratorCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Add REST application administrator
+     * @param {Number} appId
+     * @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 {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {module:model/AdministratorPayload} [administratorPayload]
+     * @param {module:api/LegacyAdministratorsApi~addAppAdministratorCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    addAppAdministrator(appId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the addCategoryAdministrator operation.
+     * @callback module:api/LegacyAdministratorsApi~addCategoryAdministratorCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Add category administrator
+     * @param {Number} categoryId
+     * @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 {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {module:model/AdministratorPayload} [administratorPayload]
+     * @param {module:api/LegacyAdministratorsApi~addCategoryAdministratorCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    addCategoryAdministrator(categoryId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the addSiteAdministrator operation.
+     * @callback module:api/LegacyAdministratorsApi~addSiteAdministratorCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Add site administrator
+     * Grants CATEGORY_ADMIN to a user on the site
+     * @param {Number} siteId
+     * @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 {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {module:model/AdministratorPayload} [administratorPayload]
+     * @param {module:api/LegacyAdministratorsApi~addSiteAdministratorCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    addSiteAdministrator(siteId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getAppAdministrators operation.
+     * @callback module:api/LegacyAdministratorsApi~getAppAdministratorsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/UserResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List REST application administrators
+     * @param {Number} appId
+     * @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 {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {module:api/LegacyAdministratorsApi~getAppAdministratorsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/UserResponse>}
+     */
+    getAppAdministrators(appId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getCategoryAdministrators operation.
+     * @callback module:api/LegacyAdministratorsApi~getCategoryAdministratorsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/UserResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List category administrators
+     * @param {Number} categoryId
+     * @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 {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {module:api/LegacyAdministratorsApi~getCategoryAdministratorsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/UserResponse>}
+     */
+    getCategoryAdministrators(categoryId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getSiteAdministrators operation.
+     * @callback module:api/LegacyAdministratorsApi~getSiteAdministratorsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/UserResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List site administrators
+     * Returns users with CATEGORY_ADMIN on the site
+     * @param {Number} siteId
+     * @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 {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {module:api/LegacyAdministratorsApi~getSiteAdministratorsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/UserResponse>}
+     */
+    getSiteAdministrators(siteId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the removeAppAdministrator operation.
+     * @callback module:api/LegacyAdministratorsApi~removeAppAdministratorCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Remove REST application administrator
+     * @param {Number} appId
+     * @param {Number} userId
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
+     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {module:api/LegacyAdministratorsApi~removeAppAdministratorCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    removeAppAdministrator(appId: number, userId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the removeCategoryAdministrator operation.
+     * @callback module:api/LegacyAdministratorsApi~removeCategoryAdministratorCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Remove category administrator
+     * @param {Number} categoryId
+     * @param {Number} userId
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
+     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {module:api/LegacyAdministratorsApi~removeCategoryAdministratorCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    removeCategoryAdministrator(categoryId: number, userId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the removeSiteAdministrator operation.
+     * @callback module:api/LegacyAdministratorsApi~removeSiteAdministratorCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Remove site administrator
+     * Revokes CATEGORY_ADMIN from a user on the site
+     * @param {Number} siteId
+     * @param {Number} userId
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] Optional cache duration override in seconds for cache-aware infrastructure.
+     * @param {String} [cachegroup] Optional cache grouping hint for cache-aware infrastructure.
+     * @param {Array.<String>} [cachekey] Cache key used by the REST request cache layer. May be provided as repeated query params or as a JSON array string.
+     * @param {module:model/String} [cachescope] Cache scope for the REST request cache layer.
+     * @param {String} [cacheuser] Optional cache user hint for cache-aware infrastructure.
+     * @param {String} [invalidationkeys] JSON array of cache invalidation descriptors processed by the REST cache filter on mutation requests.
+     * @param {Number} [zeusportalPostasApp] The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasOrg] The id of the console organization this operation is being performed as if the caller chooses to post as a console organization
+     * @param {Number} [zeusportalPostas] The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} [zeusportalPostasSite] The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} [transactionid] The id of the transaction this operation is being run in
+     * @param {module:api/LegacyAdministratorsApi~removeSiteAdministratorCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    removeSiteAdministrator(siteId: number, userId: number, opts: any, callback: any): any;
+}