@resolution/jira-api-client 0.1.0

package/lib/openapi/software/services/remote-links-service.js

@@ -0,0 +1,327 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemoteLinksService = void 0;
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+const zod_1 = require("zod");
+const commonHttpClient = require("../core/common-http-client");
+const common_http_service_1 = require("../core/common-http-service");
+const validation_schema_storage_1 = require("../validation-schema-storage");
+/**
+ * APIs related to integrating Remote Links data with Jira Software. These APIs
+ * are available to Atlassian Connect
+ * apps. To use these APIs you must have the Remote Link module in your app's
+ * descriptor. Read more about Jira Software modules
+ * [here](https://developer.atlassian.com/cloud/jira/software/about-jira-modules/).
+ *
+ * # Module
+ *
+ * The Remote Link module allows third-party providers to add a generic link
+ * through a public REST API and associate it with Jira issues or services.
+ *
+ * Supplied remote link information will be presented in the right sidebar of the
+ * new Jira issue view under Releases.
+ *
+ * This module also provides actions, which allows users to perform an action on
+ * the remote link.
+ *
+ * Note that the module key and name are not private and should therefore not
+ * contain any sensitive or personally identifiable information.
+ *
+ * ## Example Module
+ *
+ * An example can also be found at
+ * [jira-data-provider-sample-addon](https://bitbucket.org/atlassianlabs/jira-data-provider-sample-addon/src/master/),
+ * which has an `atlassian-connect.json`.
+ *
+ * ```
+ * {
+ *   "modules": {
+ *     "jiraRemoteLinkInfoProvider": {
+ *       "homeUrl": "https://my-remotelink-provider.com",
+ *       "logoUrl": "https://my-remotelink-provider.com/images/logo.svg",
+ *       "documentationUrl":
+ * "https://my-remotelink-provider.com/docs/jira-integration",
+ *       "actions": [
+ *         {
+ *           "actionId": "action-1",
+ *           "actionLabel": {
+ *             "value": {
+ *               "value": "Acknowledge"
+ *             }
+ *           },
+ *           "templateUrl": "https://my-remotelink-provider.com/ack/{ack-id}"
+ *         }
+ *       ],
+ *       "name": {
+ *         "value": "My Remote Link Provider"
+ *       },
+ *       "key": "remotelink-integration"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### Properties
+ *
+ * | Property         | type          | Description
+ *
+ * | Required |
+ * |------------------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------|----------|
+ * | key              | string        | A key to identify this module.  Must match
+ * `^[a-zA-Z0-9-]+$` pattern, with a max length of 100
+ *                      | Yes      |
+ * | name             | object (i18N) | A human readable name. This object
+ * supports
+ * [internationalization](https://developer.atlassian.com/cloud/jira/software/internationalization/).
+ * | Yes      |
+ * | homeUrl          | string        | URL to the provider’s homepage
+ *
+ * | Yes      |
+ * | logoUrl          | string        | Optional URL to the provider’s logo, which
+ * will be displayed in the UI
+ *                      |          |
+ * | documentationUrl | string        | Optional URL to documentation about the
+ * provider’s Jira integration
+ *                         |          |
+ * | actions          | object        | Optional actions that can be performed by
+ * Jira users on the remote link
+ *
+ * ### Actions object
+ *
+ * | Property    | type   | Description
+ *
+ * | Required |
+ * |-------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
+ * | actionId    | string | A key to identify a specific action. Used for
+ * associating a specific Remote link to an action of this ID.  <br> The actionId
+ * of an action must be unique across all actions.
+ *                                     | Yes      |
+ * | actionLabel | object | The actionLabel of an Action is shown visibly to the
+ * User alongside the Remote Link.
+ *
+ * | Yes      |
+ * | templateUrl | string | The templateUrl of an Action is a template where
+ * strings can be substituted into the URL for a specific Remote Link. <br>
+ * Strings used in the templateUrl must be passed in via an attribute map when
+ * associating an action with a remote link. | Yes      |
+ *
+ * ### ActionLabel Object
+ *
+ * | Property | type          | Description
+ *
+ * | Required |
+ * |----------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------|
+ * | value    | object (i18n) | The label shown on the UI. This object supports
+ * [internationalization](https://developer.atlassian.com/cloud/jira/software/internationalization/).
+ * | Yes      |
+ */
+class RemoteLinksService extends common_http_service_1.CommonHttpService {
+    /**
+     * Delete the Remote Link data currently stored for the given ID.
+     *
+     * Deletion is performed asynchronously. The `getRemoteLinkById` operation can be
+     * used to confirm that data has been
+     * deleted successfully (if needed).
+     *
+     * Only Connect apps that define the `jiraRemoteLinkInfoProvider` module, and
+     * on-premise integrations, can access this resource.
+     * This resource requires the 'DELETE' scope for Connect apps.
+     *
+     * @path {DELETE} /rest/remotelinks/1.0/remotelink/{remoteLinkId}
+     */
+    deleteRemoteLinkById({ remoteLinkId, updateSequenceNumber, authorization, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/remotelinks/1.0/remotelink/{remoteLinkId}",
+            method: "DELETE",
+            pathParams: {
+                remoteLinkId,
+            },
+            query: {
+                _updateSequenceNumber: updateSequenceNumber,
+            },
+            headers: {
+                Authorization: authorization,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Bulk delete all Remote Links data that match the given request.
+     *
+     * One or more query params must be supplied to specify Properties to delete by.
+     * Optional param `_updateSequenceNumber` is no longer supported. 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 `submitRemoteLinks` operation for more details.
+     *
+     * e.g. DELETE /bulkByProperties?accountId=account-123&repoId=repo-345
+     *
+     * Deletion is performed asynchronously. The `getRemoteLinkById` operation can be
+     * used to confirm that data has been
+     * deleted successfully (if needed).
+     *
+     * Only Connect apps that define the `jiraRemoteLinkInfoProvider` module, and
+     * on-premise integrations, can access this resource.
+     * This resource requires the 'DELETE' scope for Connect apps.
+     *
+     * @path {DELETE} /rest/remotelinks/1.0/bulkByProperties
+     */
+    deleteRemoteLinksByProperty({ updateSequenceNumber, params, authorization, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/remotelinks/1.0/bulkByProperties",
+            method: "DELETE",
+            query: {
+                _updateSequenceNumber: updateSequenceNumber,
+                params,
+            },
+            headers: {
+                Authorization: authorization,
+            },
+        })
+            .then(commonHttpClient.discardResult);
+    }
+    /**
+     * Retrieve the currently stored Remote Link 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 `jiraRemoteLinkInfoProvider` module, and
+     * on-premise integrations, can access this resource.
+     * This resource requires the 'READ' scope for Connect apps.
+     *
+     * @returns The Remote Link data currently stored for the given ID.
+     * @path {GET} /rest/remotelinks/1.0/remotelink/{remoteLinkId}
+     */
+    getRemoteLinkById({ remoteLinkId, authorization, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/remotelinks/1.0/remotelink/{remoteLinkId}",
+            method: "GET",
+            pathParams: {
+                remoteLinkId,
+            },
+            headers: {
+                Authorization: authorization,
+            },
+        })
+            .then(this.getClientInstance().responseHandler({
+            200: {
+                "application/json": "json",
+            },
+        }))
+            .then(commonHttpClient.castResponse())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("RemoteLinksService.getRemoteLinkById.response"))
+            .then(commonHttpClient.getBody);
+    }
+    /**
+     * Update / insert Remote Link data.
+     *
+     * Remote Links are identified by their ID, existing Remote Link data for the same
+     * ID will be replaced if it
+     * exists and the updateSequenceId 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 `getRemoteLinkById` operation can be used to confirm that data has been
+     * stored successfully (if needed).
+     *
+     * In the case of multiple Remote Links being submitted in one request, each is
+     * validated individually prior to
+     * submission. Details of which Remote LInk failed submission (if any) are
+     * available in the response object.
+     *
+     * Only Connect apps that define the `jiraRemoteLinkInfoProvider` module can
+     * access this resource. This resource
+     * requires the 'WRITE' scope for Connect apps.
+     *
+     * @returns Submission accepted. Each submitted Remote Link that is of a valid format will
+     * be eventually available in
+     * Jira.
+     *
+     * Details of which Remote Links were submitted and which failed submission (due
+     * to data format problems etc.)
+     * are available in the response object.
+     * @path {POST} /rest/remotelinks/1.0/bulk
+     */
+    submitRemoteLinks({ authorization, requestBody, }) {
+        return this.getClientInstance()
+            .request({
+            path: "/rest/remotelinks/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())
+            .then(validation_schema_storage_1.validationSchemaStorage.validator("RemoteLinksService.submitRemoteLinks.response"))
+            .then(commonHttpClient.getBody);
+    }
+    static initialize() {
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("RemoteLinksService.submitRemoteLinks.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(202),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z
+                .object({
+                acceptedRemoteLinks: zod_1.z.array(zod_1.z.string()).optional(),
+                rejectedRemoteLinks: zod_1.z
+                    .object({})
+                    .catchall(zod_1.z.array(zod_1.z
+                    .object({
+                    message: zod_1.z.string(),
+                    errorTraceId: zod_1.z.string().optional(),
+                })
+                    .catchall(zod_1.z.unknown())))
+                    .optional(),
+                unknownAssociations: zod_1.z
+                    .array(zod_1.z.union([
+                    zod_1.z
+                        .object({
+                        associationType: zod_1.z.enum(["issueKeys"]),
+                        values: zod_1.z
+                            .array(zod_1.z
+                            .string()
+                            .regex(new RegExp("^\\w{1,255}-\\d{1,255}$")))
+                            .min(1)
+                            .max(500),
+                    })
+                        .catchall(zod_1.z.unknown()),
+                    zod_1.z
+                        .object({
+                        associationType: zod_1.z.enum(["serviceIdOrKeys"]),
+                        values: zod_1.z.array(zod_1.z.string().max(255)).min(1).max(500),
+                    })
+                        .catchall(zod_1.z.unknown()),
+                ]))
+                    .optional(),
+            })
+                .catchall(zod_1.z.unknown()),
+        })
+            .describe("RemoteLinksService.submitRemoteLinks.response"));
+        validation_schema_storage_1.validationSchemaStorage.registerExtensible("RemoteLinksService.getRemoteLinkById.response", zod_1.z
+            .object({
+            status: zod_1.z.literal(200),
+            mediaType: zod_1.z.literal("application/json"),
+            body: zod_1.z.unknown(),
+        })
+            .describe("RemoteLinksService.getRemoteLinkById.response"));
+    }
+}
+exports.RemoteLinksService = RemoteLinksService;
+//# sourceMappingURL=remote-links-service.js.map

package/lib/openapi/software/services/remote-links-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remote-links-service.js","sourceRoot":"","sources":["../../../../src/openapi/software/services/remote-links-service.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,+DAA+D;AAC/D,qEAAgE;AAChE,4EAAuE;AACvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4GG;AACH,MAAa,kBAAmB,SAAQ,uCAAiB;IACvD;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAAC,EACnB,YAAY,EACZ,oBAAoB,EACpB,aAAa,GAgCd;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,iDAAiD;YACvD,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,YAAY;aACb;YACD,KAAK,EAAE;gBACL,qBAAqB,EAAE,oBAAoB;aAC5C;YACD,OAAO,EAAE;gBACP,aAAa,EAAE,aAAa;aAC7B;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,2BAA2B,CAAC,EAC1B,oBAAoB,EACpB,MAAM,EACN,aAAa,GAiDd;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,wCAAwC;YAC9C,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE;gBACL,qBAAqB,EAAE,oBAAoB;gBAC3C,MAAM;aACP;YACD,OAAO,EAAE;gBACP,aAAa,EAAE,aAAa;aAC7B;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,EAChB,YAAY,EACZ,aAAa,GAmBd;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,iDAAiD;YACvD,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,YAAY;aACb;YACD,OAAO,EAAE;gBACP,aAAa,EAAE,aAAa;aAC7B;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,+CAA+C,CAChD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,iBAAiB,CAAC,EAChB,aAAa,EACb,WAAW,GAqEZ;QAwFC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,4BAA4B;YAClC,MAAM,EAAE,MAAM;YACd,OAAO,EAAE;gBACP,aAAa,EAAE,aAAa;gBAC5B,cAAc,EAAE,kBAAkB;aACnC;YACD,IAAI,EAAE,WAAW;SAClB,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EA8BzB,CACL;aACA,IAAI,CACH,mDAAuB,CAAC,SAAS,CAC/B,+CAA+C,CAChD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,mDAAuB,CAAC,kBAAkB,CACxC,+CAA+C,EAC/C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC;iBACJ,MAAM,CAAC;gBACN,mBAAmB,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;gBACnD,mBAAmB,EAAE,OAAC;qBACnB,MAAM,CAAC,EAAE,CAAC;qBACV,QAAQ,CACP,OAAC,CAAC,KAAK,CACL,OAAC;qBACE,MAAM,CAAC;oBACN,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE;oBACnB,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;iBACpC,CAAC;qBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CACzB,CACF;qBACA,QAAQ,EAAE;gBACb,mBAAmB,EAAE,OAAC;qBACnB,KAAK,CACJ,OAAC,CAAC,KAAK,CAAC;oBACN,OAAC;yBACE,MAAM,CAAC;wBACN,eAAe,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,WAAW,CAAC,CAAC;wBACtC,MAAM,EAAE,OAAC;6BACN,KAAK,CACJ,OAAC;6BACE,MAAM,EAAE;6BACR,KAAK,CAAC,IAAI,MAAM,CAAC,yBAAyB,CAAC,CAAC,CAChD;6BACA,GAAG,CAAC,CAAC,CAAC;6BACN,GAAG,CAAC,GAAG,CAAC;qBACZ,CAAC;yBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;oBACxB,OAAC;yBACE,MAAM,CAAC;wBACN,eAAe,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,iBAAiB,CAAC,CAAC;wBAC5C,MAAM,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;qBACrD,CAAC;yBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;iBACzB,CAAC,CACH;qBACA,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,+CAA+C,CAAC,CAC7D,CAAC;QACF,mDAAuB,CAAC,kBAAkB,CACxC,+CAA+C,EAC/C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,OAAO,EAAE;SAClB,CAAC;aACD,QAAQ,CAAC,+CAA+C,CAAC,CAC7D,CAAC;IACJ,CAAC;CACF;AAvhBD,gDAuhBC"}

package/lib/openapi/software/services/security-information-service.d.ts

@@ -0,0 +1,257 @@
+import { CommonHttpService } from "../core/common-http-service";
+/**
+ * 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 declare 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    static initialize(): void;
+}