@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/software/services/builds-service.ts

@@ -1,571 +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";
-/**
- * APIs related to integrating builds data with Jira Software. These APIs
- * are available to Atlassian Connect apps. To use these APIs you must
- * have the Build module see
- * https://developer.atlassian.com/cloud/jira/software/modules/build/
- * in your app's descriptor. They are also related to integrating Jira
- * Software Cloud with on-premises tools using
- * OAuth 2.0 credentials, see
- * https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/.
- */
-export class BuildsService extends CommonHttpService {
-  /**
-   * Delete the build data currently stored for the given `pipelineId` and
-   * `buildNumber` combination.
-   *
-   * Deletion is performed asynchronously. The `getBuildByKey` operation can be used
-   * to confirm that data has been
-   * deleted successfully (if needed).
-   *
-   * Only Connect apps that define the `jiraBuildInfoProvider` module, and
-   * on-premise integrations, can access this resource.
-   * This resource requires the 'DELETE' scope for Connect apps.
-   *
-   * @path {DELETE} /rest/builds/0.1/pipelines/{pipelineId}/builds/{buildNumber}
-   */
-  deleteBuildByKey({
-    pipelineId,
-    buildNumber,
-    updateSequenceNumber,
-    authorization,
-  }: {
-    /** The `pipelineId` of the build to delete. */
-    pipelineId: string;
-    /** The `buildNumber` of the build to delete. */
-    buildNumber: number;
-    /**
-     * This parameter usage is no longer supported.
-     *
-     * An optional `_updateSequenceNumber` to use to control deletion.
-     *
-     * Only stored data with an `updateSequenceNumber` less than or equal to that
-     * provided will be deleted.
-     * This can be used help ensure submit/delete requests are applied correctly if
-     * issued close together.
-     *
-     * @deprecated
-     */
-    updateSequenceNumber?: number;
-    /**
-     * All requests must be signed with either a Connect JWT token or OAuth token for
-     * an on-premise integration that corresponds to an app installed in Jira.
-     *
-     * If the Connect JWT token corresponds to an app that does not define
-     * `jiraBuildInfoProvider` module it will be rejected with a 403.
-     *
-     * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
-     * details about Connect JWT tokens.
-     * See
-     * https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/
-     * for details about on-premise integrations.
-     */
-    authorization: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/builds/0.1/pipelines/{pipelineId}/builds/{buildNumber}",
-        method: "DELETE",
-        pathParams: {
-          pipelineId,
-          buildNumber,
-        },
-        query: {
-          _updateSequenceNumber: updateSequenceNumber,
-        },
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Bulk delete all builds 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 `submitBuilds` operation for more details.
-   *
-   * e.g. DELETE /bulkByProperties?accountId=account-123&repoId=repo-345
-   *
-   * Deletion is performed asynchronously. The `getBuildByKey` operation can be used
-   * to confirm that data has been
-   * deleted successfully (if needed).
-   *
-   * Only Connect apps that define the `jiraBuildInfoProvider` module, and
-   * on-premise integrations, can access this resource.
-   * This resource requires the 'DELETE' scope for Connect apps.
-   *
-   * @path {DELETE} /rest/builds/0.1/bulkByProperties
-   */
-  deleteBuildsByProperty({
-    updateSequenceNumber,
-    authorization,
-  }: {
-    /**
-     * This parameter usage is no longer supported.
-     *
-     * An optional `_updateSequenceNumber` to use to control deletion.
-     *
-     * Only stored data with an `updateSequenceNumber` less than or equal to that
-     * provided will be deleted.
-     * This can be used help ensure submit/delete requests are applied correctly if
-     * issued close together.
-     *
-     * If not provided, all stored data that matches the request will be deleted.
-     *
-     * @deprecated
-     */
-    updateSequenceNumber?: number;
-    /**
-     * All requests must be signed with either a Connect JWT token or OAuth token for
-     * an on-premise integration that corresponds to an app installed in Jira.
-     *
-     * If the Connect JWT token corresponds to an app that does not define
-     * `jiraBuildInfoProvider` module it will be rejected with a 403.
-     *
-     * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
-     * details about Connect JWT tokens.
-     * See
-     * https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/
-     * for details about on-premise integrations.
-     */
-    authorization: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/builds/0.1/bulkByProperties",
-        method: "DELETE",
-        query: {
-          _updateSequenceNumber: updateSequenceNumber,
-        },
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Retrieve the currently stored build data for the given `pipelineId` and
-   * `buildNumber` combination.
-   *
-   * The result will be what is currently stored, ignoring any pending updates or
-   * deletes.
-   *
-   * Only Connect apps that define the `jiraBuildInfoProvider` module, and
-   * on-premise integrations, can access this resource.
-   * This resource requires the 'READ' scope for Connect apps.
-   *
-   * @returns The build data currently stored for the given key.
-   * @path {GET} /rest/builds/0.1/pipelines/{pipelineId}/builds/{buildNumber}
-   */
-  getBuildByKey({
-    pipelineId,
-    buildNumber,
-    authorization,
-  }: {
-    /** The `pipelineId` of the build. */
-    pipelineId: string;
-    /** The `buildNumber` of the build. */
-    buildNumber: number;
-    /**
-     * All requests must be signed with either a Connect JWT token or OAuth token for
-     * an on-premise integration that corresponds to an app installed in Jira.
-     *
-     * If the Connect JWT token corresponds to an app that does not define
-     * `jiraBuildInfoProvider` module it will be rejected with a 403.
-     *
-     * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
-     * details about Connect JWT tokens.
-     * See
-     * https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/
-     * for details about on-premise integrations.
-     */
-    authorization: string;
-  }): Promise<unknown> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/builds/0.1/pipelines/{pipelineId}/builds/{buildNumber}",
-        method: "GET",
-        pathParams: {
-          pipelineId,
-          buildNumber,
-        },
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: unknown;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "BuildsService.getBuildByKey.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Update / insert builds data.
-   *
-   * Builds are identified by the combination of `pipelineId` and `buildNumber`, and
-   * existing build data for the same
-   * build will be replaced if it exists and the `updateSequenceNumber` of the
-   * 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 `getBuildByKey` operation can be used to confirm that data has been stored
-   * successfully (if needed).
-   *
-   * In the case of multiple builds being submitted in one request, each is
-   * validated individually prior to
-   * submission. Details of which build failed submission (if any) are available in
-   * the response object.
-   *
-   * Only Connect apps that define the `jiraBuildInfoProvider` module, and
-   * on-premise integrations, can access this resource.
-   * This resource requires the 'WRITE' scope for Connect apps.
-   *
-   * @returns Submission accepted. Each submitted build that is of a valid format will be
-   * eventually available in Jira.
-   *
-   * Details of which builds were submitted and which failed submission (due to data
-   * format problems etc.)
-   * are available in the response object.
-   * @path {POST} /rest/builds/0.1/bulk
-   */
-  submitBuilds({
-    authorization,
-    requestBody,
-  }: {
-    /**
-     * All requests must be signed with either a Connect JWT token or OAuth token for
-     * an on-premise integration that corresponds to an app installed in Jira.
-     *
-     * If the Connect JWT token corresponds to an app that does not define
-     * `jiraBuildInfoProvider` module it will be rejected with a 403.
-     *
-     * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
-     * details about Connect JWT tokens.
-     * See
-     * https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/
-     * for details about on-premise integrations.
-     */
-    authorization: string;
-    /** Builds data to submit. */
-    requestBody: {
-      /**
-       * Properties
-       *
-       * Properties assigned to build 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.
-       *
-       * Note that these properties will never be returned with build data. They are not
-       * intended for use as
-       * metadata to associate with a build. Internally they are stored as a hash so
-       * that personal information etc.
-       * is never stored within Jira.
-       *
-       * Properties are supplied as key/value pairs, a maximum of 5 properties can be
-       * supplied, and keys must not
-       * contain ':' or start with '_'.
-       *
-       * @example {
-       *     "accountId": "account-234",
-       *     "projectId": "project-123"
-       * }
-       */
-      properties?: {
-        [key: string]: string;
-      };
-      /**
-       * A list of builds to submit to Jira.
-       *
-       * Each build may be associated with one or more Jira issue keys, and will be
-       * associated with any properties
-       * included in this request.
-       */
-      builds: unknown[];
-      /**
-       * ProviderMetadata
-       *
-       * Information about the provider. This is useful for auditing, logging, debugging,
-       * and other internal uses. It is not considered private information. Hence, it
-       * may not contain personally
-       * identifiable information.
-       */
-      providerMetadata?: {
-        /**
-         * An optional name of the source of the builds data.
-         *
-         * @example Bamboo 6.10.2
-         */
-        product?: string;
-      } & {
-        [key: string]: unknown;
-      };
-    } & {
-      [key: string]: unknown;
-    };
-  }): Promise<
-    {
-      /**
-       * The keys of builds that have been accepted for submission. A build key is a
-       * composite key that consists of
-       * `pipelineId` and `buildNumber`.
-       *
-       * A build may be rejected if it was only associated with unknown issue keys, or
-       * if the submitted data for that
-       * build does not match the required schema.
-       *
-       * Note that a build that isn't updated due to it's `updateSequenceNumber` being
-       * out of order is not
-       * considered a failed submission.
-       */
-      acceptedBuilds?: ({
-        /**
-         * An ID that relates a sequence of builds. Depending on your system this might be
-         * a project ID, pipeline ID,
-         * plan key etc. - whatever logical unit you use to group a sequence of builds.
-         *
-         * The combination of `pipelineId` and `buildNumber` must uniquely identify the
-         * build.
-         *
-         * @example my-build-plan
-         */
-        pipelineId: string;
-        /**
-         * Identifies a build within the sequence of builds identified by the build
-         * `pipelineId`.
-         *
-         * Used to identify the 'most recent' build in that sequence of builds.
-         *
-         * The combination of `pipelineId` and `buildNumber` must uniquely identify the
-         * build.
-         *
-         * @example 16
-         */
-        buildNumber: number;
-      } & {
-        [key: string]: unknown;
-      })[];
-      /**
-       * Details of builds that have not been accepted for submission.
-       *
-       * A build may be rejected if it was only associated with unknown issue keys, or
-       * if the submitted data for the
-       * build does not match the required schema.
-       */
-      rejectedBuilds?: ({
-        /**
-         * BuildKey
-         *
-         * Fields that uniquely reference a build.
-         */
-        key: {
-          /**
-           * An ID that relates a sequence of builds. Depending on your system this might be
-           * a project ID, pipeline ID,
-           * plan key etc. - whatever logical unit you use to group a sequence of builds.
-           *
-           * The combination of `pipelineId` and `buildNumber` must uniquely identify the
-           * build.
-           *
-           * @example my-build-plan
-           */
-          pipelineId: string;
-          /**
-           * Identifies a build within the sequence of builds identified by the build
-           * `pipelineId`.
-           *
-           * Used to identify the 'most recent' build in that sequence of builds.
-           *
-           * The combination of `pipelineId` and `buildNumber` must uniquely identify the
-           * build.
-           *
-           * @example 16
-           */
-          buildNumber: number;
-        } & {
-          [key: string]: unknown;
-        };
-        /** The error messages for the rejected build */
-        errors: ({
-          /** A human-readable message describing the error. */
-          message: string;
-          /**
-           * An optional trace ID that can be used by Jira developers to locate the source
-           * of the error.
-           */
-          errorTraceId?: string;
-        } & {
-          [key: string]: unknown;
-        })[];
-      } & {
-        [key: string]: unknown;
-      })[];
-      /**
-       * Issue keys that are not known on this Jira instance (if any).
-       *
-       * These may be invalid keys (e.g. `UTF-8` is sometimes incorrectly identified as
-       * a Jira issue key), or they
-       * may be for projects that no longer exist.
-       *
-       * If a build has been associated with issue keys other than those in this array
-       * it will still be stored against
-       * those valid keys. If a build was only associated with issue keys deemed to be
-       * invalid it won't be persisted.
-       */
-      unknownIssueKeys?: string[];
-    } & {
-      [key: string]: unknown;
-    }
-  > {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/builds/0.1/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: {
-            acceptedBuilds?: ({
-              pipelineId: string;
-              buildNumber: number;
-            } & {
-              [key: string]: unknown;
-            })[];
-            rejectedBuilds?: ({
-              key: {
-                pipelineId: string;
-                buildNumber: number;
-              } & {
-                [key: string]: unknown;
-              };
-              errors: ({
-                message: string;
-                errorTraceId?: string;
-              } & {
-                [key: string]: unknown;
-              })[];
-            } & {
-              [key: string]: unknown;
-            })[];
-            unknownIssueKeys?: string[];
-          } & {
-            [key: string]: unknown;
-          };
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "BuildsService.submitBuilds.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "BuildsService.submitBuilds.response",
-      z
-        .object({
-          status: z.literal(202),
-          mediaType: z.literal("application/json"),
-          body: z
-            .object({
-              acceptedBuilds: z
-                .array(
-                  z
-                    .object({
-                      pipelineId: z.string().max(255),
-                      buildNumber: z.number().int(),
-                    })
-                    .catchall(z.unknown()),
-                )
-                .optional(),
-              rejectedBuilds: z
-                .array(
-                  z
-                    .object({
-                      key: z
-                        .object({
-                          pipelineId: z.string().max(255),
-                          buildNumber: z.number().int(),
-                        })
-                        .catchall(z.unknown()),
-                      errors: z.array(
-                        z
-                          .object({
-                            message: z.string(),
-                            errorTraceId: z.string().optional(),
-                          })
-                          .catchall(z.unknown()),
-                      ),
-                    })
-                    .catchall(z.unknown()),
-                )
-                .optional(),
-              unknownIssueKeys: z
-                .array(z.string().regex(new RegExp("^\\w{1,255}-\\d{1,255}$")))
-                .optional(),
-            })
-            .catchall(z.unknown()),
-        })
-        .describe("BuildsService.submitBuilds.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "BuildsService.getBuildByKey.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("BuildsService.getBuildByKey.response"),
-    );
-  }
-}