@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/software/services/dev-ops-components-service.ts

@@ -1,371 +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 Dev Ops Components affected by Incident data with
- * Jira Software. These APIs are available to Atlassian Connect
- * apps. To use these APIs you must have the DevOps Component 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 DevOps Component module allows third-party providers to add devops
- * components through a public REST API.
- *
- * Supplied devops components information will be used by the Connection Manager
- * tab in Jira to allow users to associate devops components with Jira projects.
- * All incident and PIR information related to that devops component will be
- * presented in the Incidents page in Jira Software, and as a link to any issues
- * created via the Incidents Page.
- *
- * This module also provides actions, two will be used by Jira to let the provider
- * know when the devops component has been associated or disassociated with a Jira
- * project, and two can be used by the Provider to associate a devops component
- * with a Jira Issue.
- *
- * Note that the module key and name are not private and therefore should 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": {
- *     "jiraDevOpsComponentProvider": {
- *       "homeUrl": "https://my-operations-provider.com",
- *       "logoUrl": "https://my-operations-provider.com/images/logo.svg",
- *       "documentationUrl":
- * "https://my-operations-provider.com/docs/jira-integration",
- *       "actions": {
- *         "associateEntity": {
- *             "templateUrl": "/components/associate"
- *         },
- *         "disassociateEntity": {
- *             "templateUrl": "/components/disassociate"
- *         },
- *         "onEntityAssociated": {
- *             "templateUrl": "/components/associate"
- *         },
- *         "onEntityDisassociated": {
- *             "templateUrl": "/components/disassociate"
- *         }
- *       },
- *       "name": {
- *         "value": "My DevOps Component Provider"
- *       },
- *       "key": "devops-component-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        | Actions the can be used by Jira to improve
- * the integrated experience
- *                      | Yes      |
- *
- * ### Actions object
- *
- * | Property               | type   | Description
- *
- * | Required |
- * |------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
- * | associateEntity | object | An action defined by the provider to allow Jira to
- * retrieve details about operations workspaces via a post endpoint.
- *
- * | Yes      |
- * | disassociateEntity | object | An action defined by the provider to allow Jira
- * to search using details about operations workspaces via a get endpoint.
- *
- * | Yes      |
- * | onEntityAssociated | object | An action defined by the provider to allow Jira
- * to create a new operations container via a post endpoint.
- *
- * |          |
- * | onEntityDisassociated | object | An action defined by the provider to allow
- * Jira to create a new Post-Incident Review object via a post endpoint.
- *
- * |       |
- */
-export class DevOpsComponentsService extends CommonHttpService {
-  /**
-   * Delete the Component data currently stored for the given ID.
-   *
-   * Deletion is performed asynchronously. The getComponentById operation can be
-   * used to confirm that data has been deleted successfully (if needed).
-   *
-   * Only Connect apps that define the `jiraDevOpsComponentProvider` module can
-   * access this resource.
-   * This resource requires the 'DELETE' scope for Connect apps.
-   *
-   * @path {DELETE} /rest/devopscomponents/1.0/{componentId}
-   */
-  deleteComponentById({
-    componentId,
-    authorization,
-  }: {
-    /** The ID of the Component to delete. */
-    componentId: 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 Operations
-     * Information module it will be rejected with a 403.
-     *
-     * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
-     * details.
-     */
-    authorization: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/devopscomponents/1.0/{componentId}",
-        method: "DELETE",
-        pathParams: {
-          componentId,
-        },
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Bulk delete all Components 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).
-   * See the documentation for the submitComponents operation for more details.
-   *
-   * e.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456
-   *
-   * Deletion is performed asynchronously. The getComponentById operation can be
-   * used to confirm that data has been deleted successfully (if needed).
-   *
-   * Only Connect apps that define the `jiraDevOpsComponentProvider` module can
-   * access this resource.
-   * This resource requires the 'DELETE' scope for Connect apps.
-   *
-   * @path {DELETE} /rest/devopscomponents/1.0/bulkByProperties
-   */
-  deleteComponentsByProperty({
-    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 Operations
-     * Information module it will be rejected with a 403.
-     *
-     * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
-     * details.
-     */
-    authorization: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/devopscomponents/1.0/bulkByProperties",
-        method: "DELETE",
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Retrieve the currently stored Component 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 `jiraDevOpsComponentProvider` module can
-   * access this resource.
-   * This resource requires the 'READ' scope for Connect apps.
-   *
-   * @returns The Component data currently stored for the given ID.
-   * @path {GET} /rest/devopscomponents/1.0/{componentId}
-   */
-  getComponentById({
-    componentId,
-    authorization,
-  }: {
-    /** The ID of the Component to fetch. */
-    componentId: 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 Operations
-     * Information module it will be rejected with a 403.
-     *
-     * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
-     * details.
-     */
-    authorization: string;
-  }): Promise<unknown> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/devopscomponents/1.0/{componentId}",
-        method: "GET",
-        pathParams: {
-          componentId,
-        },
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: unknown;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "DevOpsComponentsService.getComponentById.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Update / insert DevOps Component data.
-   *
-   * Components are identified by their ID, and existing Component data for the same
-   * ID will be replaced if it exists and the updateSequenceNumber 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
-   * getComponentById operation can be used to confirm that data has been stored
-   * successfully (if needed).
-   *
-   * In the case of multiple Components being submitted in one request, each is
-   * validated individually prior to submission. Details of which Components failed
-   * submission (if any) are available in the response object.
-   *
-   * A maximum of 1000 components can be submitted in one request.
-   *
-   * Only Connect apps that define the `jiraDevOpsComponentProvider` module can
-   * access this resource.
-   * This resource requires the 'WRITE' scope for Connect apps.
-   *
-   * @returns Submission accepted. Each submitted Component that is of a valid format will be
-   * eventually available in Jira.
-   * Details of which Components were submitted and which failed submission (due to
-   * data format problems etc.) are available in the response object.
-   * @path {POST} /rest/devopscomponents/1.0/bulk
-   */
-  submitComponents({
-    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 DevOps
-     * Information module it will be rejected with a 403.
-     *
-     * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
-     * details.
-     */
-    authorization: string;
-    /** DevOps Component data to submit. */
-    requestBody: unknown;
-  }): Promise<unknown> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/devopscomponents/1.0/bulk",
-        method: "POST",
-        headers: {
-          Authorization: authorization,
-          "Content-Type": "application/json",
-        },
-        body: requestBody,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          202: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 202;
-          mediaType: "application/json";
-          body: unknown;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "DevOpsComponentsService.submitComponents.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "DevOpsComponentsService.getComponentById.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("DevOpsComponentsService.getComponentById.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "DevOpsComponentsService.submitComponents.response",
-      z
-        .object({
-          status: z.literal(202),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("DevOpsComponentsService.submitComponents.response"),
-    );
-  }
-}