@resolution/jira-api-client 0.1.0 → 0.1.2

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

@@ -1,403 +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 deployments data with Jira Software. These APIs
- * are available to Atlassian Connect apps. To use these APIs you must
- * have the Deployment module see
- * https://developer.atlassian.com/cloud/jira/software/modules/deployment/
- * 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 DeploymentsService extends CommonHttpService {
-  /**
-   * Delete the currently stored deployment data for the given `pipelineId`,
-   * `environmentId` and `deploymentSequenceNumber` combination.
-   *
-   * Deletion is performed asynchronously. The `getDeploymentByKey` operation can be
-   * used to confirm that data has been deleted successfully (if needed).
-   *
-   * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and
-   * on-premise integrations, can access this resource.
-   * This resource requires the 'DELETE' scope for Connect apps.
-   *
-   * @path {DELETE}
-   * /rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}
-   */
-  deleteDeploymentByKey({
-    pipelineId,
-    environmentId,
-    deploymentSequenceNumber,
-    updateSequenceNumber,
-    authorization,
-  }: {
-    /** The ID of the deployment's pipeline. */
-    pipelineId: string;
-    /** The ID of the deployment's environment. */
-    environmentId: string;
-    /** The deployment's deploymentSequenceNumber. */
-    deploymentSequenceNumber: 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
-     * `jiraDeploymentInfoProvider` 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/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}",
-        method: "DELETE",
-        pathParams: {
-          pipelineId,
-          environmentId,
-          deploymentSequenceNumber,
-        },
-        query: {
-          _updateSequenceNumber: updateSequenceNumber,
-        },
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Bulk delete all deployments that match the given request.
-   *
-   * One or more query params must be supplied to specify the 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 (i.e. treated as AND).
-   * See the documentation for the `submitDeployments` operation for more details.
-   *
-   * Example operation: DELETE
-   * /bulkByProperties?accountId=account-123&createdBy=user-456
-   *
-   * Deletion is performed asynchronously. The `getDeploymentByKey` operation can be
-   * used to confirm that data has been deleted successfully (if needed).
-   *
-   * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and
-   * on-premise integrations, can access this resource.
-   * This resource requires the 'DELETE' scope for Connect apps.
-   *
-   * @path {DELETE} /rest/deployments/0.1/bulkByProperties
-   */
-  deleteDeploymentsByProperty({
-    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
-     * `jiraDeploymentInfoProvider` 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/deployments/0.1/bulkByProperties",
-        method: "DELETE",
-        query: {
-          _updateSequenceNumber: updateSequenceNumber,
-        },
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Retrieve the currently stored deployment data for the given `pipelineId`,
-   * `environmentId` and `deploymentSequenceNumber` combination.
-   *
-   * The result will be what is currently stored, ignoring any pending updates or
-   * deletes.
-   *
-   * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and
-   * on-premise integrations, can access this resource.
-   * This resource requires the 'READ' scope for Connect apps.
-   *
-   * @returns The deployment data currently stored for the given ID.
-   * @path {GET}
-   * /rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}
-   */
-  getDeploymentByKey({
-    pipelineId,
-    environmentId,
-    deploymentSequenceNumber,
-    authorization,
-  }: {
-    /** The ID of the deployment's pipeline. */
-    pipelineId: string;
-    /** The ID of the deployment's environment. */
-    environmentId: string;
-    /** The deployment's deploymentSequenceNumber. */
-    deploymentSequenceNumber: 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
-     * `jiraDeploymentInfoProvider` 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/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}",
-        method: "GET",
-        pathParams: {
-          pipelineId,
-          environmentId,
-          deploymentSequenceNumber,
-        },
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: unknown;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "DeploymentsService.getDeploymentByKey.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Retrieve the  Deployment gating status for the given `pipelineId +
-   * environmentId + deploymentSequenceNumber` combination.
-   * Only apps that define the `jiraDeploymentInfoProvider` module can access this
-   * resource. This resource requires the 'READ' scope.
-   *
-   * @returns The current gating status for the given Deployment
-   * @path {GET}
-   * /rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}/gating-status
-   */
-  getDeploymentGatingStatusByKey({
-    pipelineId,
-    environmentId,
-    deploymentSequenceNumber,
-  }: {
-    /** The ID of the Deployment's pipeline. */
-    pipelineId: string;
-    /** The ID of the Deployment's environment. */
-    environmentId: string;
-    /** The Deployment's deploymentSequenceNumber. */
-    deploymentSequenceNumber: number;
-  }): Promise<unknown> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/deployments/0.1/pipelines/{pipelineId}/environments/{environmentId}/deployments/{deploymentSequenceNumber}/gating-status",
-        method: "GET",
-        pathParams: {
-          pipelineId,
-          environmentId,
-          deploymentSequenceNumber,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: unknown;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "DeploymentsService.getDeploymentGatingStatusByKey.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Update / insert deployment data.
-   *
-   * Deployments are identified by the combination of `pipelineId`, `environmentId`
-   * and `deploymentSequenceNumber`, and existing deployment data for the same
-   * deployment will be replaced if it exists and the `updateSequenceNumber` of
-   * existing data is less than the incoming data.
-   *
-   * Submissions are processed 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
-   * `getDeploymentByKey` operation can be used to confirm that data has been stored
-   * successfully (if needed).
-   *
-   * In the case of multiple deployments being submitted in one request, each is
-   * validated individually prior to submission. Details of which deployments failed
-   * submission (if any) are available in the response object.
-   *
-   * Only Connect apps that define the `jiraDeploymentInfoProvider` module, and
-   * on-premise integrations, can access this resource.
-   * This resource requires the 'WRITE' scope for Connect apps.
-   *
-   * @returns Submission accepted. Each submitted deployment that is of a valid format will
-   * eventually be available in Jira.
-   *
-   * Details of which deployments were submitted and which failed submission (due to
-   * data format problems etc.) are available in the response object.
-   * @path {POST} /rest/deployments/0.1/bulk
-   */
-  submitDeployments({
-    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
-     * `jiraDeploymentInfoProvider` 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;
-    /** Deployment data to submit. */
-    requestBody: unknown;
-  }): Promise<unknown> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/deployments/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: unknown;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "DeploymentsService.submitDeployments.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "DeploymentsService.submitDeployments.response",
-      z
-        .object({
-          status: z.literal(202),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("DeploymentsService.submitDeployments.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "DeploymentsService.getDeploymentByKey.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("DeploymentsService.getDeploymentByKey.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "DeploymentsService.getDeploymentGatingStatusByKey.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("DeploymentsService.getDeploymentGatingStatusByKey.response"),
-    );
-  }
-}