@gobodo/gobodo-api 0.1.221 → 0.1.223

package/dist/api/ApprovalsApi.d.ts

@@ -0,0 +1,340 @@
+/**
+* Approvals service.
+* @module api/ApprovalsApi
+* @version 0.1.223
+*/
+export default class ApprovalsApi {
+    /**
+    * Constructs a new ApprovalsApi.
+    * @alias module:api/ApprovalsApi
+    * @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 approveRequest operation.
+     * @callback module:api/ApprovalsApi~approveRequestCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ApprovalRequestResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Approve an approval request
+     * @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/ApprovalsApi~approveRequestCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ApprovalRequestResponse}
+     */
+    approveRequest(id: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the createApprovalProcess operation.
+     * @callback module:api/ApprovalsApi~createApprovalProcessCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ApprovalProcessResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Create an approval process
+     * @param {module:model/ApprovalProcessInput} approvalProcessInput
+     * @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/ApprovalsApi~createApprovalProcessCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ApprovalProcessResponse}
+     */
+    createApprovalProcess(approvalProcessInput: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the deleteApprovalProcess operation.
+     * @callback module:api/ApprovalsApi~deleteApprovalProcessCallback
+     * @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 approval process
+     * @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/ApprovalsApi~deleteApprovalProcessCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+    deleteApprovalProcess(id: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the getApprovalProcess operation.
+     * @callback module:api/ApprovalsApi~getApprovalProcessCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ApprovalProcessResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Get an approval process 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/ApprovalsApi~getApprovalProcessCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ApprovalProcessResponse}
+     */
+    getApprovalProcess(id: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the listApprovalProcesses operation.
+     * @callback module:api/ApprovalsApi~listApprovalProcessesCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/ApprovalProcessResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List approval processes
+     * @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 {Number} [graphId] Filter by graph id
+     * @param {module:api/ApprovalsApi~listApprovalProcessesCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/ApprovalProcessResponse>}
+     */
+    listApprovalProcesses(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the listApprovalRequests operation.
+     * @callback module:api/ApprovalsApi~listApprovalRequestsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/ApprovalRequestResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List approval requests
+     * @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 {Number} [recordId] Filter by record id
+     * @param {module:api/ApprovalsApi~listApprovalRequestsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/ApprovalRequestResponse>}
+     */
+    listApprovalRequests(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the listPendingApprovalRequests operation.
+     * @callback module:api/ApprovalsApi~listPendingApprovalRequestsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/ApprovalRequestResponse>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * List pending approval requests
+     * @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/ApprovalsApi~listPendingApprovalRequestsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/ApprovalRequestResponse>}
+     */
+    listPendingApprovalRequests(opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the reassignRequest operation.
+     * @callback module:api/ApprovalsApi~reassignRequestCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ApprovalRequestResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Reassign an approval request
+     * @param {Number} id
+     * @param {module:model/ApprovalActionRequest} approvalActionRequest
+     * @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/ApprovalsApi~reassignRequestCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ApprovalRequestResponse}
+     */
+    reassignRequest(id: number, approvalActionRequest: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the recallRequest operation.
+     * @callback module:api/ApprovalsApi~recallRequestCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ApprovalRequestResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Recall an approval request
+     * @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/ApprovalsApi~recallRequestCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ApprovalRequestResponse}
+     */
+    recallRequest(id: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the rejectRequest operation.
+     * @callback module:api/ApprovalsApi~rejectRequestCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ApprovalRequestResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Reject an approval request
+     * @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/ApprovalsApi~rejectRequestCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ApprovalRequestResponse}
+     */
+    rejectRequest(id: number, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the submitApprovalRequest operation.
+     * @callback module:api/ApprovalsApi~submitApprovalRequestCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ApprovalRequestResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Submit a record for approval
+     * @param {module:model/ApprovalSubmitRequest} approvalSubmitRequest
+     * @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/ApprovalsApi~submitApprovalRequestCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ApprovalRequestResponse}
+     */
+    submitApprovalRequest(approvalSubmitRequest: any, opts: any, callback: any): any;
+    /**
+     * Callback function to receive the result of the updateApprovalProcess operation.
+     * @callback module:api/ApprovalsApi~updateApprovalProcessCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ApprovalProcessResponse} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+    /**
+     * Update an approval process
+     * @param {Number} id
+     * @param {module:model/ApprovalProcessInput} approvalProcessInput
+     * @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/ApprovalsApi~updateApprovalProcessCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ApprovalProcessResponse}
+     */
+    updateApprovalProcess(id: number, approvalProcessInput: any, opts: any, callback: any): any;
+}