@resolution/jira-api-client 0.4.2 → 0.4.5

package/lib/openapi/software/services/OperationsService.js

@@ -115,304 +115,307 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
  * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations
  */
 class OperationsService extends CommonHttpService_1.CommonHttpService {
-    /**
-     * Bulk delete all Entties that match the given request.
-     *
-     * One or more query params must be supplied to specify Properties to delete by.
-     * If more than one Property is provided, data will be deleted that matches ALL of
-     * the Properties (e.g. treated as an AND).
-     * See the documentation for the submitEntity operation for more details.
-     *
-     * e.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456
-     *
-     * Deletion is performed asynchronously. The getIncidentById operation can be used
-     * to confirm that data has been deleted successfully (if needed).
-     *
-     * Only Connect apps that define the `jiraOperationsInfoProvider` module can
-     * access this resource.
-     * This resource requires the 'DELETE' scope for Connect apps.
-     *
-     * @path {DELETE} /rest/operations/1.0/bulkByProperties
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-bulkbyproperties-delete
-     */
-    deleteEntityByProperty({ authorization, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/operations/1.0/bulkByProperties",
-            method: "DELETE",
-            headers: {
-                Authorization: authorization,
-            },
-        })
-            .then(commonHttpClient.discardResult);
-    }
-    /**
-     * Delete the Incident data currently stored for the given ID.
-     *
-     * Deletion is performed asynchronously. The getIncidentById operation can be used
-     * to confirm that data has been deleted successfully (if needed).
-     *
-     * Only Connect apps that define the `jiraOperationsInfoProvider` module can
-     * access this resource.
-     * This resource requires the 'DELETE' scope for Connect apps.
-     *
-     * @path {DELETE} /rest/operations/1.0/incidents/{incidentId}
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-incidents-incidentid-delete
-     */
-    deleteIncidentById({ incidentId, authorization, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/operations/1.0/incidents/{incidentId}",
-            method: "DELETE",
-            pathParams: {
-                incidentId,
-            },
-            headers: {
-                Authorization: authorization,
-            },
-        })
-            .then(commonHttpClient.discardResult);
-    }
-    /**
-     * Delete the Review data currently stored for the given ID.
-     *
-     * Deletion is performed asynchronously. The getReviewById operation can be used
-     * to confirm that data has been deleted successfully (if needed).
-     *
-     * Only Connect apps that define the `jiraOperationsInfoProvider` module can
-     * access this resource.
-     * This resource requires the 'DELETE' scope for Connect apps.
-     *
-     * @path {DELETE} /rest/operations/1.0/post-incident-reviews/{reviewId}
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-post-incident-reviews-reviewid-delete
-     */
-    deleteReviewById({ reviewId, authorization, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/operations/1.0/post-incident-reviews/{reviewId}",
-            method: "DELETE",
-            pathParams: {
-                reviewId,
-            },
-            headers: {
-                Authorization: authorization,
-            },
-        })
-            .then(commonHttpClient.discardResult);
-    }
-    /**
-     * Bulk delete all Operations Workspaces that match the given request.
-     *
-     * Only Connect apps that define the `jiraOperationsInfoProvider` module can
-     * access this resource.
-     * This resource requires the 'DELETE' scope for Connect apps.
-     *
-     * e.g. DELETE /bulk?workspaceIds=111-222-333,444-555-666
-     *
-     * @path {DELETE} /rest/operations/1.0/linkedWorkspaces/bulk
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-linkedworkspaces-bulk-delete
-     */
-    deleteWorkspaces({ authorization, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/operations/1.0/linkedWorkspaces/bulk",
-            method: "DELETE",
-            headers: {
-                Authorization: authorization,
-            },
-        })
-            .then(commonHttpClient.discardResult);
-    }
-    /**
-     * Retrieve the currently stored Incident data for the given ID.
-     *
-     * The result will be what is currently stored, ignoring any pending updates or
-     * deletes.
-     *
-     * Only Connect apps that define the `jiraOperationsInfoProvider` module can
-     * access this resource.
-     * This resource requires the 'READ' scope for Connect apps.
-     *
-     * @returns The Incident data currently stored for the given ID.
-     * @path {GET} /rest/operations/1.0/incidents/{incidentId}
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-incidents-incidentid-get
-     */
-    getIncidentById({ incidentId, authorization, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/operations/1.0/incidents/{incidentId}",
-            method: "GET",
-            pathParams: {
-                incidentId,
-            },
-            headers: {
-                Authorization: authorization,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("OperationsService.getIncidentById.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Retrieve the currently stored Review data for the given ID.
-     *
-     * The result will be what is currently stored, ignoring any pending updates or
-     * deletes.
-     *
-     * Only Connect apps that define the `jiraOperationsInfoProvider` module can
-     * access this resource.
-     * This resource requires the 'READ' scope for Connect apps.
-     *
-     * @returns The Review data currently stored for the given ID.
-     * @path {GET} /rest/operations/1.0/post-incident-reviews/{reviewId}
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-post-incident-reviews-reviewid-get
-     */
-    getReviewById({ reviewId, authorization, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/operations/1.0/post-incident-reviews/{reviewId}",
-            method: "GET",
-            pathParams: {
-                reviewId,
-            },
-            headers: {
-                Authorization: authorization,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("OperationsService.getReviewById.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Retrieve the either all Operations Workspace IDs associated with the Jira site
-     * or a specific Operations Workspace ID for the given ID.
-     *
-     * The result will be what is currently stored, ignoring any pending updates or
-     * deletes.
-     *
-     * e.g. GET /workspace?workspaceId=111-222-333
-     *
-     * Only Connect apps that define the `jiraOperationsInfoProvider` module can
-     * access this resource.
-     * This resource requires the 'READ' scope for Connect apps.
-     *
-     * @returns Either the ID provided if stored or a list of available IDs.
-     * @path {GET} /rest/operations/1.0/linkedWorkspaces
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-linkedworkspaces-get
-     */
-    getWorkspaces({ authorization, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/operations/1.0/linkedWorkspaces",
-            method: "GET",
-            headers: {
-                Authorization: authorization,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("OperationsService.getWorkspaces.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Update / insert Incident or Review data.
-     *
-     * Incidents and reviews are identified by their ID, and existing Incident and
-     * Review data for the same ID will be replaced if it exists and the
-     * updateSequenceNumber of existing data is less than the incoming data.
-     *
-     * Submissions are performed asynchronously. Submitted data will eventually be
-     * available in Jira; most updates are available within a short period of time,
-     * but may take some time during peak load and/or maintenance times. The
-     * getIncidentById or getReviewById operation can be used to confirm that data has
-     * been stored successfully (if needed).
-     *
-     * In the case of multiple Incidents and Reviews being submitted in one request,
-     * each is validated individually prior to submission. Details of which entities
-     * failed submission (if any) are available in the response object.
-     *
-     * A maximum of 1000 incidents can be submitted in one request.
-     *
-     * Only Connect apps that define the `jiraOperationsInfoProvider` module can
-     * access this resource.
-     * This resource requires the 'WRITE' scope for Connect apps.
-     *
-     * @returns Submission accepted. Each submitted Incident that is of a valid format will be
-     * eventually available in Jira.
-     *
-     * Details of which Incidents were submitted and which failed submission (due to
-     * data format problems etc.) are available in the response object.
-     * @path {POST} /rest/operations/1.0/bulk
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-bulk-post
-     */
-    submitEntity({ authorization, submitIncidentsRequest, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/operations/1.0/bulk",
-            method: "POST",
-            headers: {
-                Authorization: authorization,
-                "Content-Type": "application/json",
-            },
-            body: submitIncidentsRequest,
-        })
-            .then(this.getClientInstance().responseHandler({
-            202: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("OperationsService.submitEntity.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Insert Operations Workspace IDs to establish a relationship between them and
-     * the Jira site the app is installed in. If a relationship between the Workspace
-     * ID and Jira already exists then the workspace ID will be ignored and Jira will
-     * process the rest of the entries.
-     *
-     * Only Connect apps that define the `jiraOperationsInfoProvider` module can
-     * access this resource.
-     * This resource requires the 'WRITE' scope for Connect apps.
-     *
-     * @returns Submission accepted. Each submitted Operations Workspace ID will be linked to
-     * Jira.
-     * @path {POST} /rest/operations/1.0/linkedWorkspaces/bulk
-     * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-linkedworkspaces-bulk-post
-     */
-    submitOperationsWorkspaces({ authorization, submitOperationsWorkspacesRequest, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/operations/1.0/linkedWorkspaces/bulk",
-            method: "POST",
-            headers: {
-                Authorization: authorization,
-                "Content-Type": "application/json",
-            },
-            body: submitOperationsWorkspacesRequest,
-        })
-            .then(this.getClientInstance().responseHandler({
-            202: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("OperationsService.submitOperationsWorkspaces.response"))
-            .then(commonHttpClient.getBody);
+    constructor() {
+        super(...arguments);
+        /**
+         * Bulk delete all Entties that match the given request.
+         *
+         * One or more query params must be supplied to specify Properties to delete by.
+         * If more than one Property is provided, data will be deleted that matches ALL of
+         * the Properties (e.g. treated as an AND).
+         * See the documentation for the submitEntity operation for more details.
+         *
+         * e.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456
+         *
+         * Deletion is performed asynchronously. The getIncidentById operation can be used
+         * to confirm that data has been deleted successfully (if needed).
+         *
+         * Only Connect apps that define the `jiraOperationsInfoProvider` module can
+         * access this resource.
+         * This resource requires the 'DELETE' scope for Connect apps.
+         *
+         * @path {DELETE} /rest/operations/1.0/bulkByProperties
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-bulkbyproperties-delete
+         */
+        this.deleteEntityByProperty = ({ authorization, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/operations/1.0/bulkByProperties",
+                method: "DELETE",
+                headers: {
+                    Authorization: authorization,
+                },
+            })
+                .then(commonHttpClient.discardResult);
+        };
+        /**
+         * Delete the Incident data currently stored for the given ID.
+         *
+         * Deletion is performed asynchronously. The getIncidentById operation can be used
+         * to confirm that data has been deleted successfully (if needed).
+         *
+         * Only Connect apps that define the `jiraOperationsInfoProvider` module can
+         * access this resource.
+         * This resource requires the 'DELETE' scope for Connect apps.
+         *
+         * @path {DELETE} /rest/operations/1.0/incidents/{incidentId}
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-incidents-incidentid-delete
+         */
+        this.deleteIncidentById = ({ incidentId, authorization, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/operations/1.0/incidents/{incidentId}",
+                method: "DELETE",
+                pathParams: {
+                    incidentId,
+                },
+                headers: {
+                    Authorization: authorization,
+                },
+            })
+                .then(commonHttpClient.discardResult);
+        };
+        /**
+         * Delete the Review data currently stored for the given ID.
+         *
+         * Deletion is performed asynchronously. The getReviewById operation can be used
+         * to confirm that data has been deleted successfully (if needed).
+         *
+         * Only Connect apps that define the `jiraOperationsInfoProvider` module can
+         * access this resource.
+         * This resource requires the 'DELETE' scope for Connect apps.
+         *
+         * @path {DELETE} /rest/operations/1.0/post-incident-reviews/{reviewId}
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-post-incident-reviews-reviewid-delete
+         */
+        this.deleteReviewById = ({ reviewId, authorization, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/operations/1.0/post-incident-reviews/{reviewId}",
+                method: "DELETE",
+                pathParams: {
+                    reviewId,
+                },
+                headers: {
+                    Authorization: authorization,
+                },
+            })
+                .then(commonHttpClient.discardResult);
+        };
+        /**
+         * Bulk delete all Operations Workspaces that match the given request.
+         *
+         * Only Connect apps that define the `jiraOperationsInfoProvider` module can
+         * access this resource.
+         * This resource requires the 'DELETE' scope for Connect apps.
+         *
+         * e.g. DELETE /bulk?workspaceIds=111-222-333,444-555-666
+         *
+         * @path {DELETE} /rest/operations/1.0/linkedWorkspaces/bulk
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-linkedworkspaces-bulk-delete
+         */
+        this.deleteWorkspaces = ({ authorization, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/operations/1.0/linkedWorkspaces/bulk",
+                method: "DELETE",
+                headers: {
+                    Authorization: authorization,
+                },
+            })
+                .then(commonHttpClient.discardResult);
+        };
+        /**
+         * Retrieve the currently stored Incident data for the given ID.
+         *
+         * The result will be what is currently stored, ignoring any pending updates or
+         * deletes.
+         *
+         * Only Connect apps that define the `jiraOperationsInfoProvider` module can
+         * access this resource.
+         * This resource requires the 'READ' scope for Connect apps.
+         *
+         * @returns The Incident data currently stored for the given ID.
+         * @path {GET} /rest/operations/1.0/incidents/{incidentId}
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-incidents-incidentid-get
+         */
+        this.getIncidentById = ({ incidentId, authorization, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/operations/1.0/incidents/{incidentId}",
+                method: "GET",
+                pathParams: {
+                    incidentId,
+                },
+                headers: {
+                    Authorization: authorization,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("OperationsService.getIncidentById.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Retrieve the currently stored Review data for the given ID.
+         *
+         * The result will be what is currently stored, ignoring any pending updates or
+         * deletes.
+         *
+         * Only Connect apps that define the `jiraOperationsInfoProvider` module can
+         * access this resource.
+         * This resource requires the 'READ' scope for Connect apps.
+         *
+         * @returns The Review data currently stored for the given ID.
+         * @path {GET} /rest/operations/1.0/post-incident-reviews/{reviewId}
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-post-incident-reviews-reviewid-get
+         */
+        this.getReviewById = ({ reviewId, authorization, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/operations/1.0/post-incident-reviews/{reviewId}",
+                method: "GET",
+                pathParams: {
+                    reviewId,
+                },
+                headers: {
+                    Authorization: authorization,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("OperationsService.getReviewById.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Retrieve the either all Operations Workspace IDs associated with the Jira site
+         * or a specific Operations Workspace ID for the given ID.
+         *
+         * The result will be what is currently stored, ignoring any pending updates or
+         * deletes.
+         *
+         * e.g. GET /workspace?workspaceId=111-222-333
+         *
+         * Only Connect apps that define the `jiraOperationsInfoProvider` module can
+         * access this resource.
+         * This resource requires the 'READ' scope for Connect apps.
+         *
+         * @returns Either the ID provided if stored or a list of available IDs.
+         * @path {GET} /rest/operations/1.0/linkedWorkspaces
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-linkedworkspaces-get
+         */
+        this.getWorkspaces = ({ authorization, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/operations/1.0/linkedWorkspaces",
+                method: "GET",
+                headers: {
+                    Authorization: authorization,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("OperationsService.getWorkspaces.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Update / insert Incident or Review data.
+         *
+         * Incidents and reviews are identified by their ID, and existing Incident and
+         * Review data for the same ID will be replaced if it exists and the
+         * updateSequenceNumber of existing data is less than the incoming data.
+         *
+         * Submissions are performed asynchronously. Submitted data will eventually be
+         * available in Jira; most updates are available within a short period of time,
+         * but may take some time during peak load and/or maintenance times. The
+         * getIncidentById or getReviewById operation can be used to confirm that data has
+         * been stored successfully (if needed).
+         *
+         * In the case of multiple Incidents and Reviews being submitted in one request,
+         * each is validated individually prior to submission. Details of which entities
+         * failed submission (if any) are available in the response object.
+         *
+         * A maximum of 1000 incidents can be submitted in one request.
+         *
+         * Only Connect apps that define the `jiraOperationsInfoProvider` module can
+         * access this resource.
+         * This resource requires the 'WRITE' scope for Connect apps.
+         *
+         * @returns Submission accepted. Each submitted Incident that is of a valid format will be
+         * eventually available in Jira.
+         *
+         * Details of which Incidents were submitted and which failed submission (due to
+         * data format problems etc.) are available in the response object.
+         * @path {POST} /rest/operations/1.0/bulk
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-bulk-post
+         */
+        this.submitEntity = ({ authorization, submitIncidentsRequest, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/operations/1.0/bulk",
+                method: "POST",
+                headers: {
+                    Authorization: authorization,
+                    "Content-Type": "application/json",
+                },
+                body: submitIncidentsRequest,
+            })
+                .then(this.getClientInstance().responseHandler({
+                202: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("OperationsService.submitEntity.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Insert Operations Workspace IDs to establish a relationship between them and
+         * the Jira site the app is installed in. If a relationship between the Workspace
+         * ID and Jira already exists then the workspace ID will be ignored and Jira will
+         * process the rest of the entries.
+         *
+         * Only Connect apps that define the `jiraOperationsInfoProvider` module can
+         * access this resource.
+         * This resource requires the 'WRITE' scope for Connect apps.
+         *
+         * @returns Submission accepted. Each submitted Operations Workspace ID will be linked to
+         * Jira.
+         * @path {POST} /rest/operations/1.0/linkedWorkspaces/bulk
+         * @see https://developer.atlassian.com/cloud/jira/software/rest/api-group-operations#api-rest-operations-1-0-linkedworkspaces-bulk-post
+         */
+        this.submitOperationsWorkspaces = ({ authorization, submitOperationsWorkspacesRequest, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/operations/1.0/linkedWorkspaces/bulk",
+                method: "POST",
+                headers: {
+                    Authorization: authorization,
+                    "Content-Type": "application/json",
+                },
+                body: submitOperationsWorkspacesRequest,
+            })
+                .then(this.getClientInstance().responseHandler({
+                202: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("OperationsService.submitOperationsWorkspaces.response"))
+                .then(commonHttpClient.getBody);
+        };
     }
     static initialize() {
         validationSchemaStorage_1.validationSchemaStorage.registerExtensible("OperationsService.submitEntity.response", zod_1.z