@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/software/services/security-information-service.ts

@@ -1,495 +0,0 @@
-// DO NOT EDIT!
-// This file is generated by "api-typescript-generator".
-// To update this file run "yarn build:openapi".
-import { z } from "zod";
-
-import * as commonHttpClient from "../core/common-http-client";
-import { CommonHttpService } from "../core/common-http-service";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * Send security information to Jira Software and enable your teams to turn
- * unplanned vulnerabilities into planned and tracked work.
- *
- * Security is everyone's responsibility, and the security feature in Jira lets
- * you triage and track relevant vulnerabilities as a team. Discuss and prioritise
- * issues, minimise errors and duplication, and plan security work to complete in
- * your sprints.
- *
- * APIs related to integrating Security information with Jira Software are
- * available to Atlassian Connect apps. To use these APIs you must have the
- * Security module in your app's descriptor. Read more about Jira Software modules
- * [here](https://developer.atlassian.com/cloud/jira/software/about-jira-modules/).
- */
-export class SecurityInformationService extends CommonHttpService {
-  /**
-   * Bulk delete all linked Security Workspaces that match the given request.
-   *
-   * Only Connect apps that define the `jiraSecurityInfoProvider` 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/security/1.0/linkedWorkspaces/bulk
-   */
-  deleteLinkedWorkspaces({
-    authorization,
-  }: {
-    /**
-     * All requests must be signed with a Connect JWT token that corresponds to the
-     * Provider app installed in Jira.
-     *
-     * If the JWT token corresponds to an app that does not define the Security
-     * Information module it will be rejected with a 403.
-     *
-     * Read [understanding
-     * jwt](https://developer.atlassian.com/blog/2015/01/understanding-jwt/) for more
-     * details.
-     */
-    authorization: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/security/1.0/linkedWorkspaces/bulk",
-        method: "DELETE",
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Bulk delete all Vulnerabilities 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).
-   * Read the POST bulk endpoint documentation for more details.
-   *
-   * e.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456
-   *
-   * Deletion is performed asynchronously. The GET vulnerability endpoint can be
-   * used to confirm that data has been deleted successfully (if needed).
-   *
-   * Only Connect apps that define the `jiraSecurityInfoProvider` module can access
-   * this resource.
-   * This resource requires the 'DELETE' scope for Connect apps.
-   *
-   * @path {DELETE} /rest/security/1.0/bulkByProperties
-   */
-  deleteVulnerabilitiesByProperty({
-    authorization,
-  }: {
-    /**
-     * All requests must be signed with a Connect JWT token that corresponds to the
-     * Provider app installed in Jira.
-     *
-     * If the JWT token corresponds to an app that does not define Security
-     * Information module it will be rejected with a 403.
-     *
-     * Read more about JWT
-     * [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
-     */
-    authorization: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/security/1.0/bulkByProperties",
-        method: "DELETE",
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Delete the Vulnerability data currently stored for the given ID.
-   *
-   * Deletion is performed asynchronously. The GET vulnerability endpoint can be
-   * used to confirm that data has been deleted successfully (if needed).
-   *
-   * Only Connect apps that define the `jiraSecurityInfoProvider` module can access
-   * this resource.
-   * This resource requires the 'DELETE' scope for Connect apps.
-   *
-   * @path {DELETE} /rest/security/1.0/vulnerability/{vulnerabilityId}
-   */
-  deleteVulnerabilityById({
-    vulnerabilityId,
-    authorization,
-  }: {
-    /** The ID of the Vulnerability to delete. */
-    vulnerabilityId: string;
-    /**
-     * All requests must be signed with a Connect JWT token that corresponds to the
-     * Provider app installed in Jira.
-     *
-     * If the JWT token corresponds to an app that does not define Security
-     * Information module it will be rejected with a 403.
-     *
-     * Read more about JWT
-     * [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
-     */
-    authorization: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/security/1.0/vulnerability/{vulnerabilityId}",
-        method: "DELETE",
-        pathParams: {
-          vulnerabilityId,
-        },
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Retrieve a specific Security Workspace linked to the Jira site for the given
-   * workspace ID.
-   *
-   * The result will be what is currently stored, ignoring any pending updates or
-   * deletes.
-   *
-   * Only Connect apps that define the `jiraSecurityInfoProvider` module can access
-   * this resource.
-   * This resource requires the 'READ' scope for Connect apps.
-   *
-   * @returns The Security Workspace information stored for the given ID.
-   * @path {GET} /rest/security/1.0/linkedWorkspaces/{workspaceId}
-   */
-  getLinkedWorkspaceById({
-    workspaceId,
-    authorization,
-  }: {
-    /** The ID of the workspace to fetch. */
-    workspaceId: string;
-    /**
-     * All requests must be signed with a Connect JWT token that corresponds to the
-     * Provider app installed in Jira.
-     *
-     * If the JWT token corresponds to an app that does not define the Security
-     * Information module it will be rejected with a 403.
-     *
-     * Read more about JWT
-     * [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
-     */
-    authorization: string;
-  }): Promise<unknown> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/security/1.0/linkedWorkspaces/{workspaceId}",
-        method: "GET",
-        pathParams: {
-          workspaceId,
-        },
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: unknown;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "SecurityInformationService.getLinkedWorkspaceById.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Retrieve all Security Workspaces linked with the Jira site.
-   *
-   * The result will be what is currently stored, ignoring any pending updates or
-   * deletes.
-   *
-   * Only Connect apps that define the `jiraSecurityInfoProvider` module can access
-   * this resource.
-   * This resource requires the 'READ' scope for Connect apps.
-   *
-   * @returns A list of all stored workspace IDs.
-   * @path {GET} /rest/security/1.0/linkedWorkspaces
-   */
-  getLinkedWorkspaces({
-    authorization,
-  }: {
-    /**
-     * All requests must be signed with a Connect JWT token that corresponds to the
-     * Provider app installed in Jira.
-     *
-     * If the JWT token corresponds to an app that does not define the Security
-     * Information module it will be rejected with a 403.
-     *
-     * Read more about JWT
-     * [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
-     */
-    authorization: string;
-  }): Promise<unknown> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/security/1.0/linkedWorkspaces",
-        method: "GET",
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: unknown;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "SecurityInformationService.getLinkedWorkspaces.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Retrieve the currently stored Vulnerability 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 `jiraSecurityInfoProvider` module can access
-   * this resource.
-   * This resource requires the 'READ' scope for Connect apps.
-   *
-   * @returns The Vulnerability data currently stored for the given ID.
-   * @path {GET} /rest/security/1.0/vulnerability/{vulnerabilityId}
-   */
-  getVulnerabilityById({
-    vulnerabilityId,
-    authorization,
-  }: {
-    /** The ID of the Vulnerability to fetch. */
-    vulnerabilityId: string;
-    /**
-     * All requests must be signed with a Connect JWT token that corresponds to the
-     * Provider app installed in Jira.
-     *
-     * If the JWT token corresponds to an app that does not define Security
-     * Information module it will be rejected with a 403.
-     *
-     * Read more about JWT
-     * [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
-     */
-    authorization: string;
-  }): Promise<unknown> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/security/1.0/vulnerability/{vulnerabilityId}",
-        method: "GET",
-        pathParams: {
-          vulnerabilityId,
-        },
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: unknown;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "SecurityInformationService.getVulnerabilityById.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Update / Insert Vulnerability data.
-   *
-   * Vulnerabilities are identified by their ID, any existing Vulnerability data
-   * with the same ID will be replaced if it exists and the updateSequenceNumber of
-   * the existing data is less than the incoming data.
-   *
-   * Submissions are performed asynchronously. Most updates are available within a
-   * short period of time but may take some time during peak load and/or maintenance
-   * times. The GET vulnerability endpoint can be used to confirm that data has been
-   * stored successfully (if needed).
-   *
-   * In the case of multiple Vulnerabilities being submitted in one request, each is
-   * validated individually prior to submission. Details of Vulnerabilities that
-   * failed submission (if any) are available in the response object.
-   *
-   * A maximum of 1000 vulnerabilities can be submitted in one request.
-   *
-   * Only Connect apps that define the `jiraSecurityInfoProvider` module can access
-   * this resource.
-   * This resource requires the 'WRITE' scope for Connect apps.
-   *
-   * @returns Submission accepted. Each Vulnerability submitted in a valid format will
-   * eventually be available in Jira.
-   *
-   * Details of any Vulnerabilities that were submitted but failed submission (due
-   * to data format problems, etc.) are available in the response object.
-   * @path {POST} /rest/security/1.0/bulk
-   */
-  submitVulnerabilities({
-    authorization,
-    requestBody,
-  }: {
-    /**
-     * All requests must be signed with a Connect JWT token that corresponds to the
-     * Provider app installed in Jira.
-     *
-     * If the JWT token corresponds to an app that does not define the Security
-     * Information module it will be rejected with a 403.
-     *
-     * Read more about JWT
-     * [here](https://developer.atlassian.com/blog/2015/01/understanding-jwt/).
-     */
-    authorization: string;
-    /** Vulnerability data to submit. */
-    requestBody: unknown;
-  }): Promise<unknown> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/security/1.0/bulk",
-        method: "POST",
-        headers: {
-          Authorization: authorization,
-          "Content-Type": "application/json",
-        },
-        body: requestBody,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          202: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 202;
-          mediaType: "application/json";
-          body: unknown;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "SecurityInformationService.submitVulnerabilities.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Insert Security Workspace IDs to establish a relationship between them and the
-   * Jira site the app is installed on. 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 `jiraSecurityInfoProvider` module can access
-   * this resource.
-   * This resource requires the 'WRITE' scope for Connect apps.
-   *
-   * @path {POST} /rest/security/1.0/linkedWorkspaces/bulk
-   */
-  submitWorkspaces({
-    authorization,
-    requestBody,
-  }: {
-    /**
-     * All requests must be signed with a Connect JWT token that corresponds to the
-     * Provider app installed in Jira.
-     *
-     * If the JWT token corresponds to an app that does not define the Security
-     * Information module it will be rejected with a 403.
-     *
-     * Read [understanding
-     * jwt](https://developer.atlassian.com/blog/2015/01/understanding-jwt/) for more
-     * details.
-     */
-    authorization: string;
-    /** Security Workspace IDs to submit. */
-    requestBody: unknown;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/security/1.0/linkedWorkspaces/bulk",
-        method: "POST",
-        headers: {
-          Authorization: authorization,
-          "Content-Type": "application/json",
-        },
-        body: requestBody,
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "SecurityInformationService.submitVulnerabilities.response",
-      z
-        .object({
-          status: z.literal(202),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("SecurityInformationService.submitVulnerabilities.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "SecurityInformationService.getLinkedWorkspaces.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("SecurityInformationService.getLinkedWorkspaces.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "SecurityInformationService.getLinkedWorkspaceById.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("SecurityInformationService.getLinkedWorkspaceById.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "SecurityInformationService.getVulnerabilityById.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("SecurityInformationService.getVulnerabilityById.response"),
-    );
-  }
-}