@gobodo/gobodo-api 0.1.221 → 0.1.223

package/dist/api/DocumentPartsApi.d.ts

@@ -0,0 +1,312 @@
+/**
+* DocumentParts service.
+* @module api/DocumentPartsApi
+* @version 0.1.223
+*/
+export default class DocumentPartsApi {
+    /**
+    * Constructs a new DocumentPartsApi.
+    * @alias module:api/DocumentPartsApi
+    * @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 changeDocumentPartType operation.
+     * @callback module:api/DocumentPartsApi~changeDocumentPartTypeCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Change document part type
+     * @param {Number} id
+     * @param {Number} typeId
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [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/DocumentPartsApi~changeDocumentPartTypeCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    changeDocumentPartType(id: number, typeId: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the copyDocumentPart operation.
+     * @callback module:api/DocumentPartsApi~copyDocumentPartCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Copy document part
+     * @param {Number} id
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [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/DocumentPartsApi~copyDocumentPartCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    copyDocumentPart(id: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createChildDocumentParts operation.
+     * @callback module:api/DocumentPartsApi~createChildDocumentPartsCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create child document parts
+     * @param {Number} id
+     * @param {Array.<module:model/DocumentPartInput>} documentPartInput
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [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/DocumentPartsApi~createChildDocumentPartsCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    createChildDocumentParts(id: number, documentPartInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createDocumentPart operation.
+     * @callback module:api/DocumentPartsApi~createDocumentPartCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create document part
+     * @param {module:model/DocumentPartInput} documentPartInput
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [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/DocumentPartsApi~createDocumentPartCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    createDocumentPart(documentPartInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the deleteDocumentPart operation.
+     * @callback module:api/DocumentPartsApi~deleteDocumentPartCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Delete document part
+     * @param {Number} id
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [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/DocumentPartsApi~deleteDocumentPartCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    deleteDocumentPart(id: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getChildDocumentPartByPageNum operation.
+     * @callback module:api/DocumentPartsApi~getChildDocumentPartByPageNumCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get child document part by page number
+     * @param {Number} id
+     * @param {Number} pageNum
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [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/DocumentPartsApi~getChildDocumentPartByPageNumCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    getChildDocumentPartByPageNum(id: number, pageNum: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getChildDocumentParts operation.
+     * @callback module:api/DocumentPartsApi~getChildDocumentPartsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/DocumentPartResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List child document parts
+     * @param {Number} id
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [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/DocumentPartsApi~getChildDocumentPartsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/DocumentPartResponse>}
+     */
+    getChildDocumentParts(id: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getDocumentPartById operation.
+     * @callback module:api/DocumentPartsApi~getDocumentPartByIdCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/DocumentPartResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get document part by id
+     * @param {Number} id
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [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/DocumentPartsApi~getDocumentPartByIdCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/DocumentPartResponse}
+     */
+    getDocumentPartById(id: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the moveDocumentPartToDocument operation.
+     * @callback module:api/DocumentPartsApi~moveDocumentPartToDocumentCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Move document part to a document
+     * @param {Number} id
+     * @param {Number} documentId
+     * @param {Number} partIndex
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [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/DocumentPartsApi~moveDocumentPartToDocumentCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    moveDocumentPartToDocument(id: number, documentId: number, partIndex: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the moveDocumentPartToParent operation.
+     * @callback module:api/DocumentPartsApi~moveDocumentPartToParentCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Move document part under another part
+     * @param {Number} id
+     * @param {Number} parentId
+     * @param {Number} partIndex
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [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/DocumentPartsApi~moveDocumentPartToParentCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    moveDocumentPartToParent(id: number, parentId: number, partIndex: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the updateDocumentPart operation.
+     * @callback module:api/DocumentPartsApi~updateDocumentPartCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Update document part
+     * @param {Number} id
+     * @param {module:model/DocumentPartInput} documentPartInput
+     * @param {Object} opts Optional parameters
+     * @param {String} [authorization] The authorization token of the logged in user
+     * @param {String} [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/DocumentPartsApi~updateDocumentPartCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    updateDocumentPart(id: number, documentPartInput: any, opts: any, callback: any): any;
+}