@gobodo/gobodo-api-promise 0.1.87 → 0.1.89

package/dist/api/CategoriesApi.d.ts

@@ -0,0 +1,339 @@
+/**
+* Categories service.
+* @module api/CategoriesApi
+* @version 0.1.89
+*/
+export default class CategoriesApi {
+    /**
+    * Constructs a new CategoriesApi.
+    * @alias module:api/CategoriesApi
+    * @class
+    * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+    * default to {@link module:ApiClient#instance} if unspecified.
+    */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Create Category
+     * Creates a new Category
+     * @param {module:model/ZeusPortalCategory} zeusPortalCategory The ZeusPortalCategory to create
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @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)
+     * @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} [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
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ZeusPortalCategory} and HTTP response
+     */
+    createCategoryWithHttpInfo(zeusPortalCategory: any, opts: any): Promise<any>;
+    /**
+     * Create Category
+     * Creates a new Category
+     * @param {module:model/ZeusPortalCategory} zeusPortalCategory The ZeusPortalCategory to create
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.cacheuser The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ZeusPortalCategory}
+     */
+    createCategory(zeusPortalCategory: any, opts: {
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+    /**
+     * Create a child category
+     * Creates a child Category
+     * @param {Number} id
+     * @param {module:model/ZeusPortalCategory} zeusPortalCategory The ZeusPortalCategory to create
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @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)
+     * @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} [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
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ZeusPortalCategory} and HTTP response
+     */
+    createChildCategoryWithHttpInfo(id: number, zeusPortalCategory: any, opts: any): Promise<any>;
+    /**
+     * Create a child category
+     * Creates a child Category
+     * @param {Number} id
+     * @param {module:model/ZeusPortalCategory} zeusPortalCategory The ZeusPortalCategory to create
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.cacheuser The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ZeusPortalCategory}
+     */
+    createChildCategory(id: number, zeusPortalCategory: any, opts: {
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+    /**
+     * Root for the API
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @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)
+     * @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} [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
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response
+     */
+    get18WithHttpInfo(opts: any): Promise<any>;
+    /**
+     * Root for the API
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.cacheuser The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+     */
+    get18(opts: {
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+    /**
+     * Gets a category by id
+     * Gets a category by id
+     * @param {Number} id The id of the category that we are retreiving
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @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)
+     * @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} [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
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ZeusPortalCategory} and HTTP response
+     */
+    getCategoryByIdWithHttpInfo(id: number, opts: any): Promise<any>;
+    /**
+     * Gets a category by id
+     * Gets a category by id
+     * @param {Number} id The id of the category that we are retreiving
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.cacheuser The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ZeusPortalCategory}
+     */
+    getCategoryById(id: number, opts: {
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+    /**
+     * @param {Number} id
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @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)
+     * @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} [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
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PurgeDataDefaultResponseValue} and HTTP response
+     */
+    getChildCategoriesWithHttpInfo(id: number, opts: any): Promise<any>;
+    /**
+     * @param {Number} id
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.cacheuser The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PurgeDataDefaultResponseValue}
+     */
+    getChildCategories(id: number, opts: {
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+    /**
+     * Gets the root category
+     * Gets the root category
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @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)
+     * @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} [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
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ZeusPortalCategory} and HTTP response
+     */
+    getRootCategoryWithHttpInfo(opts: any): Promise<any>;
+    /**
+     * Gets the root category
+     * Gets the root category
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.cacheuser The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ZeusPortalCategory}
+     */
+    getRootCategory(opts: {
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+    /**
+     * Update Category
+     * Updates the Category
+     * @param {Number} id
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {Number} [cacheduration] The how long the cache entry should persist
+     * @param {Array.<String>} [cachegroup] The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} [cachekey] The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} [cachescope] The scope of storage of the cache item
+     * @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)
+     * @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} [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 {Object.<String, module:model/{String: PurgeDataDefaultResponseValue}>} [requestBody]
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/PurgeDataDefaultResponseValue} and HTTP response
+     */
+    updateCategoryWithHttpInfo(id: number, opts: any): Promise<any>;
+    /**
+     * Update Category
+     * Updates the Category
+     * @param {Number} id
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.authorization The authorization token of the logged in user
+     * @param {Number} opts.cacheduration The how long the cache entry should persist
+     * @param {Array.<String>} opts.cachegroup The cache group(s) the cache entry specified by the cachekey should be grouped to
+     * @param {Array.<String>} opts.cachekey The key to cache the response or the key to remove if a post, put, or delete operation
+     * @param {module:model/String} opts.cachescope The scope of storage of the cache item
+     * @param {Array.<String>} opts.cacheuser The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
+     * @param {Number} opts.zeusportalPostasApp The id of the application this operation is being performed as if the caller chooses to post as an organization page
+     * @param {Number} opts.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} opts.zeusportalPostasSite The id of the site this operation is being performed as if the caller chooses to post as an organization page
+     * @param {String} opts.transactionid The id of the transaction this operation is being run in
+     * @param {Object.<String, module:model/{String: PurgeDataDefaultResponseValue}>} opts.requestBody
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/PurgeDataDefaultResponseValue}
+     */
+    updateCategory(id: number, opts: {
+        authorization: string;
+        cacheduration: number;
+        cachegroup: Array<string>;
+        cachekey: Array<string>;
+        cachescope: any;
+        cacheuser: Array<string>;
+        zeusportalPostasApp: number;
+        zeusportalPostas: number;
+        zeusportalPostasSite: number;
+        transactionid: string;
+    }): Promise<any>;
+}

package/dist/api/CategoriesApi.js

@@ -17,7 +17,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  * gobodo-api
  * REST Interface for Gobodo API
  *
- * The version of the OpenAPI document: 0.1.87
+ * The version of the OpenAPI document: 0.1.89
  * Contact: info@gobodo.io
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -28,7 +28,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
 /**
 * Categories service.
 * @module api/CategoriesApi
-* @version 0.1.87
+* @version 0.1.89
 */
 var CategoriesApi = exports["default"] = /*#__PURE__*/function () {
   /**