@resolution/jira-api-client 0.1.0 → 0.1.2

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

@@ -1,741 +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 Incident and Post-Incident Review (PIR) data with
- * Jira Software. These APIs are available to Atlassian Connect
- * apps. To use these APIs you must have the Operations 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 Operations module allows third-party providers to add incident and PIR
- * information through a public REST API.
- *
- * Supplied incident information 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, one which allows Jira to provide a direct
- * link to the operations provider where the user can create a post-incident
- * review and two which allow Jira to search for relevant workspaces and devops
- * components.
- *
- * 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": {
- *     "jiraOperationsInfoProvider": {
- *       "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": {
- *           "fetchWorkspaces": {
- *               "templateUrl": "/workspaces/list"
- *           },
- *           "searchContainers": {
- *               "templateUrl": "/containers/search"
- *           },
- *           "createPostIncidentReview": {
- *               "url":
- * "https://my-operations-provider.com/my-workspace/create-post-incident-review?affected-component={component-id}&incident={incident-id}
- *           }
- *       },
- *       "name": {
- *         "value": "My Operations Provider"
- *       },
- *       "key": "operations-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 |
- * |------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
- * | fetchWorkspaces | object | An action defined by the provider to allow Jira to
- * retrieve details about operations workspaces via a post endpoint.
- *
- * | Yes      |
- * | searchContainers | object | An action defined by the provider to allow Jira
- * to search using details about devops components via a get endpoint.
- *
- * | Yes      |
- * | createPostIncidentReview | object | An action defined by the provider to
- * allow Jira to create a new Post-Incident Review object via a post endpoint.
- *
- * |       |
- */
-export class OperationsService extends CommonHttpService {
-  /**
-   * Bulk delete all Entties 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 submitEntity operation for more details.
-   *
-   * e.g. DELETE /bulkByProperties?accountId=account-123&createdBy=user-456
-   *
-   * Deletion is performed asynchronously. The getIncidentById operation can be used
-   * to confirm that data has been deleted successfully (if needed).
-   *
-   * Only Connect apps that define the `jiraOperationsInfoProvider` module can
-   * access this resource.
-   * This resource requires the 'DELETE' scope for Connect apps.
-   *
-   * @path {DELETE} /rest/operations/1.0/bulkByProperties
-   */
-  deleteEntityByProperty({
-    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 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/operations/1.0/bulkByProperties",
-        method: "DELETE",
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Delete the Incident data currently stored for the given ID.
-   *
-   * Deletion is performed asynchronously. The getIncidentById operation can be used
-   * to confirm that data has been deleted successfully (if needed).
-   *
-   * Only Connect apps that define the `jiraOperationsInfoProvider` module can
-   * access this resource.
-   * This resource requires the 'DELETE' scope for Connect apps.
-   *
-   * @path {DELETE} /rest/operations/1.0/incidents/{incidentId}
-   */
-  deleteIncidentById({
-    incidentId,
-    authorization,
-  }: {
-    /** The ID of the Incident to delete. */
-    incidentId: 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/operations/1.0/incidents/{incidentId}",
-        method: "DELETE",
-        pathParams: {
-          incidentId,
-        },
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Delete the Review data currently stored for the given ID.
-   *
-   * Deletion is performed asynchronously. The getReviewById operation can be used
-   * to confirm that data has been deleted successfully (if needed).
-   *
-   * Only Connect apps that define the `jiraOperationsInfoProvider` module can
-   * access this resource.
-   * This resource requires the 'DELETE' scope for Connect apps.
-   *
-   * @path {DELETE} /rest/operations/1.0/post-incident-reviews/{reviewId}
-   */
-  deleteReviewById({
-    reviewId,
-    authorization,
-  }: {
-    /** The ID of the Review to delete. */
-    reviewId: 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/operations/1.0/post-incident-reviews/{reviewId}",
-        method: "DELETE",
-        pathParams: {
-          reviewId,
-        },
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Bulk delete all Operations Workspaces that match the given request.
-   *
-   * Only Connect apps that define the `jiraOperationsInfoProvider` 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/operations/1.0/linkedWorkspaces/bulk
-   */
-  deleteWorkspaces({
-    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
-     * 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/operations/1.0/linkedWorkspaces/bulk",
-        method: "DELETE",
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Retrieve the currently stored Incident 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 `jiraOperationsInfoProvider` module can
-   * access this resource.
-   * This resource requires the 'READ' scope for Connect apps.
-   *
-   * @returns The Incident data currently stored for the given ID.
-   * @path {GET} /rest/operations/1.0/incidents/{incidentId}
-   */
-  getIncidentById({
-    incidentId,
-    authorization,
-  }: {
-    /** The ID of the Incident to fetch. */
-    incidentId: 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/operations/1.0/incidents/{incidentId}",
-        method: "GET",
-        pathParams: {
-          incidentId,
-        },
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: unknown;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "OperationsService.getIncidentById.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Retrieve the currently stored Review 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 `jiraOperationsInfoProvider` module can
-   * access this resource.
-   * This resource requires the 'READ' scope for Connect apps.
-   *
-   * @returns The Review data currently stored for the given ID.
-   * @path {GET} /rest/operations/1.0/post-incident-reviews/{reviewId}
-   */
-  getReviewById({
-    reviewId,
-    authorization,
-  }: {
-    /** The ID of the Review to fetch. */
-    reviewId: 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/operations/1.0/post-incident-reviews/{reviewId}",
-        method: "GET",
-        pathParams: {
-          reviewId,
-        },
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: unknown;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "OperationsService.getReviewById.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Retrieve the either all Operations Workspace IDs associated with the Jira site
-   * or a specific Operations Workspace ID for the given ID.
-   *
-   * The result will be what is currently stored, ignoring any pending updates or
-   * deletes.
-   *
-   * e.g. GET /workspace?workspaceId=111-222-333
-   *
-   * Only Connect apps that define the `jiraOperationsInfoProvider` module can
-   * access this resource.
-   * This resource requires the 'READ' scope for Connect apps.
-   *
-   * @returns Either the ID provided if stored or a list of available IDs.
-   * @path {GET} /rest/operations/1.0/linkedWorkspaces
-   */
-  getWorkspaces({
-    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<unknown> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/operations/1.0/linkedWorkspaces",
-        method: "GET",
-        headers: {
-          Authorization: authorization,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: unknown;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "OperationsService.getWorkspaces.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Update / insert Incident or Review data.
-   *
-   * Incidents and reviews are identified by their ID, and existing Incident and
-   * Review 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
-   * getIncidentById or getReviewById operation can be used to confirm that data has
-   * been stored successfully (if needed).
-   *
-   * In the case of multiple Incidents and Reviews being submitted in one request,
-   * each is validated individually prior to submission. Details of which entities
-   * failed submission (if any) are available in the response object.
-   *
-   * A maximum of 1000 incidents can be submitted in one request.
-   *
-   * Only Connect apps that define the `jiraOperationsInfoProvider` module can
-   * access this resource.
-   * This resource requires the 'WRITE' scope for Connect apps.
-   *
-   * @returns Submission accepted. Each submitted Incident that is of a valid format will be
-   * eventually available in Jira.
-   *
-   * Details of which Incidents were submitted and which failed submission (due to
-   * data format problems etc.) are available in the response object.
-   * @path {POST} /rest/operations/1.0/bulk
-   */
-  submitEntity({
-    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 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;
-    /** Incident data to submit. */
-    requestBody:
-      | ({
-          /**
-           * Properties
-           *
-           * Properties assigned to incidents/components/review 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;
-          };
-          /**
-           * 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 incidents.
-             *
-             * @example Atlassian Operations Platform 2.1.0
-             */
-            product?: string;
-          };
-          incidents?: unknown[];
-        } & {
-          [key: string]: unknown;
-        })
-      | ({
-          /**
-           * Properties
-           *
-           * Properties assigned to incidents/components/review 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;
-          };
-          /**
-           * 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 incidents.
-             *
-             * @example Atlassian Operations Platform 2.1.0
-             */
-            product?: string;
-          };
-          reviews?: unknown[];
-        } & {
-          [key: string]: unknown;
-        });
-  }): Promise<unknown> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/operations/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(
-          "OperationsService.submitEntity.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Insert Operations Workspace IDs to establish a relationship between them and
-   * the Jira site the app is installed in. 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 `jiraOperationsInfoProvider` module can
-   * access this resource.
-   * This resource requires the 'WRITE' scope for Connect apps.
-   *
-   * @returns Submission accepted. Each submitted Operations Workspace ID will be linked to
-   * Jira.
-   * @path {POST} /rest/operations/1.0/linkedWorkspaces/bulk
-   */
-  submitOperationsWorkspaces({
-    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 Operations
-     * module it will be rejected with a 403.
-     *
-     * See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more
-     * details.
-     */
-    authorization: string;
-    /** Operations Workspace ids to submit. */
-    requestBody: unknown;
-  }): Promise<unknown> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/operations/1.0/linkedWorkspaces/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(
-          "OperationsService.submitOperationsWorkspaces.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "OperationsService.submitEntity.response",
-      z
-        .object({
-          status: z.literal(202),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("OperationsService.submitEntity.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "OperationsService.getIncidentById.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("OperationsService.getIncidentById.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "OperationsService.getWorkspaces.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("OperationsService.getWorkspaces.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "OperationsService.submitOperationsWorkspaces.response",
-      z
-        .object({
-          status: z.literal(202),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("OperationsService.submitOperationsWorkspaces.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "OperationsService.getReviewById.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("OperationsService.getReviewById.response"),
-    );
-  }
-}