@resolution/jira-api-client 0.1.6 → 0.3.0

package/lib/openapi/software/models/securityInformation.d.ts

@@ -0,0 +1,386 @@
+import { type ZodTypeAny } from "zod";
+import type { CommonValidationSchemaStorage } from "../core/CommonValidationSchemaStorage";
+/**
+ * SecurityWorkspaceIds
+ *
+ * The payload of linked Security Workspace IDs.
+ */
+export interface SecurityWorkspaceIds extends Record<string, unknown> {
+    /**
+     * Security Workspace IDs
+     *
+     * The IDs of Security Workspaces that are linked to this Jira site.
+     *
+     * @example [
+     *     "111-222-333",
+     *     "444-555-666"
+     * ]
+     */
+    workspaceIds: string[];
+}
+/**
+ * SecurityWorkspaceResponse
+ *
+ * The Security Workspace information stored for the given ID.
+ */
+export interface SecurityWorkspaceResponse extends Record<string, unknown> {
+    /**
+     * The Security Workspace ID
+     *
+     * @example 111-222-333
+     */
+    workspaceId: string;
+    /**
+     * Latest date and time that the Security Workspace was updated in Jira.
+     *
+     * @example 2020-01-17T09:30:00.000Z
+     */
+    updatedAt: string;
+}
+/**
+ * SubmitSecurityWorkspacesRequest
+ *
+ * The payload used to submit (update / insert) Security Workspace IDs.
+ */
+export interface SubmitSecurityWorkspacesRequest extends Record<string, unknown> {
+    /**
+     * Security Workspace IDs
+     *
+     * The IDs of Security Workspaces to link to this Jira site. These must follow
+     * this regex pattern: `[a-zA-Z0-9\\-_.~@:{}=]+(\/[a-zA-Z0-9\\-_.~@:{}=]+)*`
+     *
+     * @example [
+     *     "111-222-333",
+     *     "444-555-666"
+     * ]
+     */
+    workspaceIds: string[];
+}
+/**
+ * SubmitVulnerabilitiesRequest
+ *
+ * The payload used to submit (update / insert) Vulnerability data.
+ */
+export interface SubmitVulnerabilitiesRequest extends Record<string, unknown> {
+    /**
+     * Indicates the operation being performed by the provider system when sending
+     * this data. "NORMAL" - Data received during real-time, user-triggered actions
+     * (e.g. user closed or updated a vulnerability). "SCAN" - Data sent through some
+     * automated process (e.g. some periodically scheduled repository scan).
+     * "BACKFILL" - Data received while backfilling existing data (e.g. pushing
+     * historical vulnerabilities when re-connect a workspace). Default is "NORMAL".
+     * "NORMAL" traffic has higher priority but tighter rate limits, "SCAN" traffic
+     * has medium priority and looser limits, "BACKFILL" has lower priority and much
+     * looser limits
+     *
+     * @example SCAN
+     */
+    operationType?: "NORMAL" | "SCAN" | "BACKFILL";
+    /**
+     * Properties
+     *
+     * Properties assigned to vulnerability data that can then be used for delete /
+     * query operations.
+     *
+     * Examples might be an account or user ID that can then be used to clean up data
+     * if an account is removed from the Provider system.
+     *
+     * Properties are supplied as key/value pairs, and a maximum of 5 properties can
+     * be supplied, keys cannot contain ':' or start with '_'.
+     *
+     * @example {
+     *     "accountId": "account-234",
+     *     "projectId": "project-123"
+     * }
+     */
+    properties?: {
+        [key: string]: string;
+    };
+    vulnerabilities: unknown[];
+    /**
+     * ProviderMetadata
+     *
+     * Information about the provider. This is useful for auditing, logging, debugging,
+     * and other internal uses. Information in this property is not considered
+     * private, so it should not contain personally identifiable information
+     */
+    providerMetadata?: {
+        /**
+         * An optional name of the source of the vulnerabilities.
+         *
+         * @example Atlassian Security Platform 2.1.0
+         */
+        product?: string;
+    } & {
+        [key: string]: unknown;
+    };
+}
+/**
+ * SubmitVulnerabilitiesResponse
+ *
+ * The result of a successful submitVulnerabilities request.
+ */
+export interface SubmitVulnerabilitiesResponse extends Record<string, unknown> {
+    /**
+     * The IDs of Vulnerabilities that have been accepted for submission.
+     *
+     * A Vulnerability may be rejected if it was only associated with unknown project
+     * keys.
+     *
+     * Note that a Vulnerability that isn't updated due to it's updateSequenceNumber
+     * being out of order is not considered a failed submission.
+     *
+     * @example [
+     *     "111-222-333",
+     *     "444-555-666"
+     * ]
+     */
+    acceptedVulnerabilities?: string[];
+    /**
+     * Details of Vulnerabilities that have not been accepted for submission, usually
+     * due to a problem with the request data.
+     *
+     * The object (if present) will be keyed by Vulnerability ID and include any
+     * errors associated with that Vulnerability that have prevented it being
+     * submitted.
+     */
+    failedVulnerabilities?: {
+        [key: string]: unknown[];
+    };
+    /**
+     * Associations (e.g. Service IDs) that are not known on this Jira instance (if
+     * any).
+     *
+     * If a Vulnerability has been associated with any other association other than
+     * those in this array it will still be stored against those valid associations.
+     * If a Vulnerability was only associated with the associations in this array, it
+     * is deemed to be invalid and it won't be persisted.
+     */
+    unknownAssociations?: ({
+        /**
+         * Defines the association type.
+         *
+         * @example issueIdOrKeys
+         */
+        associationType: "issueIdOrKeys";
+        /**
+         * The Jira issue id or keys to associate the Security information with.
+         *
+         * The number of values counted across all associationTypes (issueIdOrKeys) must
+         * not exceed a limit of 500.
+         */
+        values: string[];
+    } & {
+        [key: string]: unknown;
+    })[];
+}
+/**
+ * Vulnerability details
+ *
+ * Data related to a specific vulnerability in a specific workspace that the
+ * vulnerability is present in. Must specify at least one association.
+ */
+export interface VulnerabilityDetails {
+    /**
+     * The VulnerabilityData schema version used for this vulnerability data.
+     *
+     * Placeholder to support potential schema changes in the future.
+     *
+     * @example 1
+     */
+    schemaVersion: "1.0";
+    /**
+     * The identifier for the Vulnerability. Must be unique for a given Provider.
+     *
+     * @example 111-222-333
+     */
+    id: string;
+    /**
+     * An ID used to apply an ordering to updates for this Vulnerability in the case
+     * of out-of-order receipt of update requests.
+     *
+     * This can be any monotonically increasing number. A suggested implementation is
+     * to use epoch millis from the Provider system, but other alternatives are valid
+     * (e.g. a Provider could store a counter against each Vulnerability and increment
+     * that on each update to Jira).
+     *
+     * Updates for a Vulnerability that are received with an updateSequenceId lower
+     * than what is currently stored will be ignored.
+     *
+     * @example 1523494301448
+     */
+    updateSequenceNumber: number;
+    /**
+     * The identifier of the Container where this Vulnerability was found. Must be
+     * unique for a given Provider. This must follow this regex pattern:
+     * `[a-zA-Z0-9\\-_.~@:{}=]+(/[a-zA-Z0-9\\-_.~@:{}=]+)*`
+     *
+     * @example 111-222-333
+     */
+    containerId: string;
+    /**
+     * The human-readable name for the Vulnerability. Will be shown in the UI.
+     *
+     * If not provided, will use the ID for display.
+     *
+     * @example curl/libcurl3 - Buffer Override
+     */
+    displayName: string;
+    /**
+     * A description of the issue in markdown format that will be shown in the UI and
+     * used when creating Jira Issues. HTML tags are not supported in the markdown
+     * format. For creating a new line `\n` can be used. Read more about the accepted
+     * markdown transformations
+     * [here](https://atlaskit.atlassian.com/packages/editor/editor-markdown-transformer).
+     *
+     * @example ## Overview
+     *
+     *
+     * Affected versions of this package are vulnerable to MeltLeak
+     */
+    description: string;
+    /**
+     * A URL users can use to link to a summary view of this vulnerability, if
+     * appropriate.
+     *
+     * This could be any location that makes sense in the Provider system (e.g. if the
+     * summary information comes from a specific project, it might make sense to link
+     * the user to the vulnerability in that project).
+     *
+     * @example https://example.com/project/CWE-123/summary
+     */
+    url: string;
+    /**
+     * The type of Vulnerability detected.
+     *
+     * @example sca
+     */
+    type: "sca" | "sast" | "dast" | "unknown";
+    /**
+     * The timestamp to present to the user that shows when the Vulnerability was
+     * introduced.
+     *
+     * Expected format is an RFC3339 formatted string.
+     *
+     * @example 2018-01-20T23:27:25.000Z
+     */
+    introducedDate: string;
+    /**
+     * The last-updated timestamp to present to the user the last time the
+     * Vulnerability was updated.
+     *
+     * Expected format is an RFC3339 formatted string.
+     *
+     * @example 2018-01-20T23:27:25.000Z
+     */
+    lastUpdated: string;
+    /**
+     * VulnerabilitySeverity
+     *
+     * Severity information for a single Vulnerability.
+     *
+     * This is the severity information that will be presented to the user on e.g. the
+     * Jira Security screen.
+     */
+    severity: unknown;
+    /** The identifying information for the Vulnerability. */
+    identifiers?: unknown[];
+    /**
+     * VulnerabilityStatus
+     *
+     * The current status of the Vulnerability.
+     *
+     * @example open
+     */
+    status: "open" | "closed" | "ignored" | "unknown";
+    /**
+     * VulnerabilityAdditionalInfo
+     *
+     * Extra information (optional). This data will be shown in the security feature
+     * under the vulnerability displayName.
+     */
+    additionalInfo?: {
+        /**
+         * The content of the additionalInfo.
+         *
+         * @example More information on the vulnerability, as a string
+         */
+        content: string;
+        /**
+         * Optional URL linking to the information
+         *
+         * @example https://example.com/project/CWE-123/additionalInfo
+         */
+        url?: string;
+    } & {
+        [key: string]: unknown;
+    };
+    /**
+     * The associations (e.g. Jira issue) to add in addition to the currently stored
+     * associations of the Security Vulnerability.
+     */
+    addAssociations?: ({
+        /**
+         * Defines the association type.
+         *
+         * @example issueIdOrKeys
+         */
+        associationType: "issueIdOrKeys";
+        /**
+         * The Jira issue id or keys to associate the Security information with.
+         *
+         * The number of values counted across all associationTypes (issueIdOrKeys) must
+         * not exceed a limit of 500.
+         */
+        values: string[];
+    } & {
+        [key: string]: unknown;
+    })[];
+    /**
+     * The associations (e.g. Jira issue) to remove from currently stored associations
+     * of the Security Vulnerability.
+     */
+    removeAssociations?: ({
+        /**
+         * Defines the association type.
+         *
+         * @example issueIdOrKeys
+         */
+        associationType: "issueIdOrKeys";
+        /**
+         * The Jira issue id or keys to associate the Security information with.
+         *
+         * The number of values counted across all associationTypes (issueIdOrKeys) must
+         * not exceed a limit of 500.
+         */
+        values: string[];
+    } & {
+        [key: string]: unknown;
+    })[];
+    /**
+     * An ISO-8601 Date-time string representing the last time the provider updated
+     * associations on this entity.
+     *
+     * Expected format is an RFC3339 formatted string.
+     *
+     * @example 2018-01-20T23:27:25.000Z
+     */
+    associationsLastUpdated?: string;
+    /**
+     * A sequence number to compare when writing entity associations to the database.
+     *
+     * This can be any monotonically increasing number. A highly recommended
+     * implementation is to use epoch millis.
+     *
+     * This is an optional field. If it is not provided it will default to being equal
+     * to the corresponding entity's `updateSequenceNumber`.
+     *
+     * Associations are written following a LastWriteWins strategy, association that
+     * are received with an associationsUpdateSequenceNumber lower than what is
+     * currently stored will be ignored.
+     *
+     * @example 1523494301448
+     */
+    associationsUpdateSequenceNumber?: number;
+}
+export declare function registerSecurityInformationValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;

package/lib/openapi/software/models/securityInformation.js

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerSecurityInformationValidationSchemas = 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");
+function registerSecurityInformationValidationSchemas(validationSchemaStorage) {
+    validationSchemaStorage.register("SecurityWorkspaceIds", zod_1.z
+        .object({
+        workspaceIds: zod_1.z.array(zod_1.z.string()).min(1),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("SecurityWorkspaceIds"));
+    validationSchemaStorage.register("SecurityWorkspaceResponse", zod_1.z
+        .object({
+        workspaceId: zod_1.z.string(),
+        updatedAt: zod_1.z.string(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("SecurityWorkspaceResponse"));
+    validationSchemaStorage.register("SubmitSecurityWorkspacesRequest", zod_1.z
+        .object({
+        workspaceIds: zod_1.z
+            .array(zod_1.z
+            .string()
+            .regex(new RegExp("[a-zA-Z0-9\\-_.~@:{}=]+(/[a-zA-Z0-9\\-_.~@:{}=]+)*")))
+            .min(1)
+            .max(100),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("SubmitSecurityWorkspacesRequest"));
+    validationSchemaStorage.register("SubmitVulnerabilitiesRequest", zod_1.z
+        .object({
+        operationType: zod_1.z.enum(["NORMAL", "SCAN", "BACKFILL"]).optional(),
+        properties: zod_1.z
+            .object({})
+            .catchall(zod_1.z.string().max(255))
+            .superRefine((obj, ctx) => {
+            if (Object.keys(obj).length > 5) {
+                ctx.addIssue({
+                    code: zod_1.z.ZodIssueCode.custom,
+                    path: [],
+                    message: "Should have at most 5 properties",
+                });
+            }
+        })
+            .optional(),
+        vulnerabilities: zod_1.z.array(zod_1.z.unknown()).min(1).max(1000),
+        providerMetadata: zod_1.z
+            .object({
+            product: zod_1.z.string().optional(),
+        })
+            .catchall(zod_1.z.unknown())
+            .optional(),
+    })
+        .catchall(zod_1.z.unknown())
+        .describe("SubmitVulnerabilitiesRequest"));
+    validationSchemaStorage.register("SubmitVulnerabilitiesResponse", zod_1.z
+        .object({
+        acceptedVulnerabilities: zod_1.z.array(zod_1.z.string()).optional(),
+        failedVulnerabilities: zod_1.z
+            .object({})
+            .catchall(zod_1.z.array(zod_1.z.unknown()))
+            .optional(),
+        unknownAssociations: zod_1.z
+            .array(zod_1.z
+            .object({
+            associationType: zod_1.z.enum(["issueIdOrKeys"]),
+            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("SubmitVulnerabilitiesResponse"));
+    validationSchemaStorage.register("VulnerabilityDetails", zod_1.z
+        .object({
+        schemaVersion: zod_1.z.enum(["1.0"]),
+        id: zod_1.z.string().max(255),
+        updateSequenceNumber: zod_1.z.number().int(),
+        containerId: zod_1.z
+            .string()
+            .max(255)
+            .regex(new RegExp("[a-zA-Z0-9\\-_.~@:{}=]+(/[a-zA-Z0-9\\-_.~@:{}=]+)*")),
+        displayName: zod_1.z.string().max(255),
+        description: zod_1.z.string().max(5000),
+        url: zod_1.z.string().max(2000),
+        type: zod_1.z.enum(["sca", "sast", "dast", "unknown"]),
+        introducedDate: zod_1.z.string(),
+        lastUpdated: zod_1.z.string(),
+        severity: zod_1.z.unknown(),
+        identifiers: zod_1.z.array(zod_1.z.unknown()).min(1).max(100).optional(),
+        status: zod_1.z.enum(["open", "closed", "ignored", "unknown"]),
+        additionalInfo: zod_1.z
+            .object({
+            content: zod_1.z.string().max(255),
+            url: zod_1.z.string().max(2000).optional(),
+        })
+            .catchall(zod_1.z.unknown())
+            .optional(),
+        addAssociations: zod_1.z
+            .array(zod_1.z
+            .object({
+            associationType: zod_1.z.enum(["issueIdOrKeys"]),
+            values: zod_1.z.array(zod_1.z.string().max(255)).min(1).max(500),
+        })
+            .catchall(zod_1.z.unknown()))
+            .min(0)
+            .max(1)
+            .optional(),
+        removeAssociations: zod_1.z
+            .array(zod_1.z
+            .object({
+            associationType: zod_1.z.enum(["issueIdOrKeys"]),
+            values: zod_1.z.array(zod_1.z.string().max(255)).min(1).max(500),
+        })
+            .catchall(zod_1.z.unknown()))
+            .min(0)
+            .max(1)
+            .optional(),
+        associationsLastUpdated: zod_1.z.string().optional(),
+        associationsUpdateSequenceNumber: zod_1.z.number().int().optional(),
+    })
+        .strict()
+        .describe("VulnerabilityDetails"));
+}
+exports.registerSecurityInformationValidationSchemas = registerSecurityInformationValidationSchemas;
+//# sourceMappingURL=securityInformation.js.map

package/lib/openapi/software/models/securityInformation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"securityInformation.js","sourceRoot":"","sources":["../../../../src/openapi/software/models/securityInformation.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAmYzC,SAAgB,4CAA4C,CAC1D,uBAAkE;IAElE,uBAAuB,CAAC,QAAQ,CAC9B,sBAAsB,EACtB,OAAC;SACE,MAAM,CAAC;QACN,YAAY,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;KACzC,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,sBAAsB,CAAC,CACpC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,2BAA2B,EAC3B,OAAC;SACE,MAAM,CAAC;QACN,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;QACvB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;KACtB,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,2BAA2B,CAAC,CACzC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,iCAAiC,EACjC,OAAC;SACE,MAAM,CAAC;QACN,YAAY,EAAE,OAAC;aACZ,KAAK,CACJ,OAAC;aACE,MAAM,EAAE;aACR,KAAK,CACJ,IAAI,MAAM,CACR,oDAAoD,CACrD,CACF,CACJ;aACA,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,GAAG,CAAC;KACZ,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,iCAAiC,CAAC,CAC/C,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,8BAA8B,EAC9B,OAAC;SACE,MAAM,CAAC;QACN,aAAa,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE;QAChE,UAAU,EAAE,OAAC;aACV,MAAM,CAAC,EAAE,CAAC;aACV,QAAQ,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;aAC7B,WAAW,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACxB,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAChC,GAAG,CAAC,QAAQ,CAAC;oBACX,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,MAAM;oBAC3B,IAAI,EAAE,EAAE;oBACR,OAAO,EAAE,kCAAkC;iBAC5C,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC;aACD,QAAQ,EAAE;QACb,eAAe,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC;QACtD,gBAAgB,EAAE,OAAC;aAChB,MAAM,CAAC;YACN,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SAC/B,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;aACrB,QAAQ,EAAE;KACd,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,8BAA8B,CAAC,CAC5C,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,+BAA+B,EAC/B,OAAC;SACE,MAAM,CAAC;QACN,uBAAuB,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;QACvD,qBAAqB,EAAE,OAAC;aACrB,MAAM,CAAC,EAAE,CAAC;aACV,QAAQ,CAAC,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC;aAC9B,QAAQ,EAAE;QACb,mBAAmB,EAAE,OAAC;aACnB,KAAK,CACJ,OAAC;aACE,MAAM,CAAC;YACN,eAAe,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,eAAe,CAAC,CAAC;YAC1C,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;SACrD,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CACzB;aACA,QAAQ,EAAE;KACd,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,+BAA+B,CAAC,CAC7C,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,sBAAsB,EACtB,OAAC;SACE,MAAM,CAAC;QACN,aAAa,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;QAC9B,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;QACvB,oBAAoB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;QACtC,WAAW,EAAE,OAAC;aACX,MAAM,EAAE;aACR,GAAG,CAAC,GAAG,CAAC;aACR,KAAK,CACJ,IAAI,MAAM,CAAC,oDAAoD,CAAC,CACjE;QACH,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;QAChC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC;QACjC,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC;QACzB,IAAI,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;QAChD,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE;QAC1B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE;QACvB,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE;QACrB,WAAW,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;QAC5D,MAAM,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QACxD,cAAc,EAAE,OAAC;aACd,MAAM,CAAC;YACN,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC;YAC5B,GAAG,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE;SACrC,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;aACrB,QAAQ,EAAE;QACb,eAAe,EAAE,OAAC;aACf,KAAK,CACJ,OAAC;aACE,MAAM,CAAC;YACN,eAAe,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,eAAe,CAAC,CAAC;YAC1C,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;SACrD,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CACzB;aACA,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,EAAE;QACb,kBAAkB,EAAE,OAAC;aAClB,KAAK,CACJ,OAAC;aACE,MAAM,CAAC;YACN,eAAe,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,eAAe,CAAC,CAAC;YAC1C,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;SACrD,CAAC;aACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CACzB;aACA,GAAG,CAAC,CAAC,CAAC;aACN,GAAG,CAAC,CAAC,CAAC;aACN,QAAQ,EAAE;QACb,uBAAuB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9C,gCAAgC,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;KAC9D,CAAC;SACD,MAAM,EAAE;SACR,QAAQ,CAAC,sBAAsB,CAAC,CACpC,CAAC;AACJ,CAAC;AAzJD,oGAyJC"}

package/lib/openapi/software/models/sprint.d.ts

@@ -0,0 +1,13 @@
+import { type ZodTypeAny } from "zod";
+import type { CommonValidationSchemaStorage } from "../core/CommonValidationSchemaStorage";
+export interface SprintCreateBean {
+    endDate?: string;
+    goal?: string;
+    name?: string;
+    originBoardId?: number;
+    startDate?: string;
+}
+export interface SprintSwapBean {
+    sprintToSwapWith?: number;
+}
+export declare function registerSprintValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;

package/lib/openapi/software/models/sprint.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerSprintValidationSchemas = 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");
+function registerSprintValidationSchemas(validationSchemaStorage) {
+    validationSchemaStorage.register("SprintCreateBean", zod_1.z
+        .object({
+        endDate: zod_1.z.string().optional(),
+        goal: zod_1.z.string().optional(),
+        name: zod_1.z.string().optional(),
+        originBoardId: zod_1.z.number().int().optional(),
+        startDate: zod_1.z.string().optional(),
+    })
+        .strict()
+        .describe("SprintCreateBean"));
+    validationSchemaStorage.register("SprintSwapBean", zod_1.z
+        .object({
+        sprintToSwapWith: zod_1.z.number().int().optional(),
+    })
+        .strict()
+        .describe("SprintSwapBean"));
+}
+exports.registerSprintValidationSchemas = registerSprintValidationSchemas;
+//# sourceMappingURL=sprint.js.map

package/lib/openapi/software/models/sprint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sprint.js","sourceRoot":"","sources":["../../../../src/openapi/software/models/sprint.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAazC,SAAgB,+BAA+B,CAC7C,uBAAkE;IAElE,uBAAuB,CAAC,QAAQ,CAC9B,kBAAkB,EAClB,OAAC;SACE,MAAM,CAAC;QACN,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QAC1C,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KACjC,CAAC;SACD,MAAM,EAAE;SACR,QAAQ,CAAC,kBAAkB,CAAC,CAChC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,gBAAgB,EAChB,OAAC;SACE,MAAM,CAAC;QACN,gBAAgB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;KAC9C,CAAC;SACD,MAAM,EAAE;SACR,QAAQ,CAAC,gBAAgB,CAAC,CAC9B,CAAC;AACJ,CAAC;AAzBD,0EAyBC"}

package/lib/openapi/software/services/BacklogService.d.ts

@@ -0,0 +1,75 @@
+import { CommonHttpService } from "../core/CommonHttpService";
+import type { IssueAssignRequestBean, IssueRankRequestBean } from "../models/common";
+/** Apis related to the backlog */
+export declare class BacklogService extends CommonHttpService {
+    /**
+     * Move issues to the backlog.
+     * This operation is equivalent to remove future and active sprints from a given
+     * set of issues. At most 50 issues may be moved at once.
+     *
+     * @path {POST} /rest/agile/1.0/backlog/issue
+     */
+    moveIssuesToBacklog({ issueAssignRequestBean, }: {
+        /**
+         * @example {
+         *     "issues": [
+         *         "10001",
+         *         "PR-1",
+         *         "PR-3"
+         *     ]
+         * }
+         */
+        issueAssignRequestBean: IssueAssignRequestBean;
+    }): Promise<void>;
+    /**
+     * Move issues to the backlog of a particular board (if they are already on that
+     * board).
+     * This operation is equivalent to remove future and active sprints from a given
+     * set of issues if the board has sprints If the board does not have sprints this
+     * will put the issues back into the backlog from the board. At most 50 issues may
+     * be moved at once.
+     *
+     * @returns Returns the list of issue with status of rank operation.
+     *
+     * example: {
+     *   "entries": [
+     *     {
+     *       "issueId": 10000,
+     *       "issueKey": "PR-1",
+     *       "status": 200
+     *     },
+     *     {
+     *       "issueId": 10001,
+     *       "issueKey": "PR-2",
+     *       "status": 200
+     *     },
+     *     {
+     *       "errors": [
+     *         "JIRA Agile cannot execute the rank operation at this time. Please try
+     * again later."
+     *       ],
+     *       "issueId": 10002,
+     *       "issueKey": "PR-3",
+     *       "status": 503
+     *     }
+     *   ]
+     * }
+     * @path {POST} /rest/agile/1.0/backlog/{boardId}/issue
+     */
+    moveIssuesToBacklogForBoard({ boardId, issueRankRequestBean, }: {
+        boardId: number;
+        /**
+         * @example {
+         *     "issues": [
+         *         "PR-1",
+         *         "10001",
+         *         "PR-3"
+         *     ],
+         *     "rankBeforeIssue": "PR-4",
+         *     "rankCustomFieldId": 10521
+         * }
+         */
+        issueRankRequestBean: IssueRankRequestBean;
+    }): Promise<unknown>;
+    static initialize(): void;
+}