@resolution/jira-api-client 0.1.0

package/src/openapi/platform/services/status-service.ts

@@ -0,0 +1,498 @@
+// 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 {
+  type JiraStatus,
+  type PageOfStatuses,
+  registerStatusValidationSchemas,
+  type StatusCreateRequest,
+  type StatusUpdateRequest,
+} from "../models/status";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/**
+ * This resource represents statuses. Use it to search, get, create, delete, and
+ * change statuses.
+ */
+export class StatusService extends CommonHttpService {
+  /**
+   * Creates statuses for a global or project scope.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Administer projects* [project
+   * permission.](https://confluence.atlassian.com/x/yodKLg)
+   *  *  *Administer Jira* [project
+   * permission.](https://confluence.atlassian.com/x/yodKLg)
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: [
+   *   {
+   *     "description": "The issue is resolved",
+   *     "id": "1000",
+   *     "name": "Finished",
+   *     "scope": {
+   *       "project": {
+   *         "id": "1"
+   *       },
+   *       "type": "PROJECT"
+   *     },
+   *     "statusCategory": "DONE",
+   *     "usages": [],
+   *     "workflowUsages": []
+   *   }
+   * ]
+   * @path {POST} /rest/api/3/statuses
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:workflow:jira
+   */
+  createStatuses({
+    statusCreateRequest,
+  }: {
+    /**
+     * Details of the statuses being created and their scope.
+     *
+     * @example {
+     *     "scope": {
+     *         "project": {
+     *             "id": "1"
+     *         },
+     *         "type": "PROJECT"
+     *     },
+     *     "statuses": [
+     *         {
+     *             "description": "The issue is resolved",
+     *             "name": "Finished",
+     *             "statusCategory": "DONE"
+     *         }
+     *     ]
+     * }
+     */
+    statusCreateRequest: StatusCreateRequest;
+  }): Promise<JiraStatus[]> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/statuses",
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: statusCreateRequest,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: JiraStatus[];
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "StatusService.createStatuses.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Deletes statuses by ID.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Administer projects* [project
+   * permission.](https://confluence.atlassian.com/x/yodKLg)
+   *  *  *Administer Jira* [project
+   * permission.](https://confluence.atlassian.com/x/yodKLg)
+   *
+   * @returns Returned if the request is successful.
+   * @path {DELETE} /rest/api/3/statuses
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:workflow:jira
+   */
+  deleteStatusesById({
+    id,
+  }: {
+    /**
+     * The list of status IDs. To include multiple IDs, provide an ampersand-separated
+     * list. For example, id=10000&id=10001.
+     *
+     * Min items `1`, Max items `50`
+     */
+    id: string[];
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/statuses",
+        method: "DELETE",
+        query: {
+          id,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          204: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 204;
+          mediaType: "application/json";
+          body: void;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "StatusService.deleteStatusesById.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns a list of the statuses specified by one or more status IDs.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Administer projects* [project
+   * permission.](https://confluence.atlassian.com/x/yodKLg)
+   *  *  *Administer Jira* [project
+   * permission.](https://confluence.atlassian.com/x/yodKLg)
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: [
+   *   {
+   *     "description": "The issue is resolved",
+   *     "id": "1000",
+   *     "name": "Finished",
+   *     "scope": {
+   *       "project": {
+   *         "id": "1"
+   *       },
+   *       "type": "PROJECT"
+   *     },
+   *     "statusCategory": "DONE",
+   *     "usages": [
+   *       {
+   *         "issueTypes": [
+   *           "10002"
+   *         ],
+   *         "project": {
+   *           "id": "1"
+   *         }
+   *       }
+   *     ],
+   *     "workflowUsages": [
+   *       {
+   *         "workflowId": "545d80a3-91ff-4949-8b0d-a2bc484e70e5",
+   *         "workflowName": "Workflow 1"
+   *       }
+   *     ]
+   *   }
+   * ]
+   * @path {GET} /rest/api/3/statuses
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta read:workflow:jira
+   */
+  getStatusesById({
+    expand,
+    id,
+  }: {
+    /**
+     * Use [expand](#expansion) to include additional information in the response.
+     * This parameter accepts a comma-separated list. Expand options include:
+     *
+     *  *  `usages` Returns the project and issue types that use the status in their
+     * workflow.
+     *  *  `workflowUsages` Returns the workflows that use the status.
+     */
+    expand?: string;
+    /**
+     * The list of status IDs. To include multiple IDs, provide an ampersand-separated
+     * list. For example, id=10000&id=10001.
+     *
+     * Min items `1`, Max items `50`
+     */
+    id: string[];
+  }): Promise<JiraStatus[]> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/statuses",
+        method: "GET",
+        query: {
+          expand,
+          id,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: JiraStatus[];
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "StatusService.getStatusesById.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns a
+   * [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination)
+   * list of statuses that match a search on name or project.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Administer projects* [project
+   * permission.](https://confluence.atlassian.com/x/yodKLg)
+   *  *  *Administer Jira* [project
+   * permission.](https://confluence.atlassian.com/x/yodKLg)
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "isLast": true,
+   *   "maxResults": 2,
+   *   "nextPage":
+   * "https://your-domain.atlassian.net/rest/api/3/statuses/search?startAt=2&maxResults=2",
+   *   "self":
+   * "https://your-domain.atlassian.net/rest/api/3/statuses/search?startAt=0&maxResults=2",
+   *   "startAt": 0,
+   *   "total": 5,
+   *   "values": [
+   *     {
+   *       "description": "The issue is resolved",
+   *       "id": "1000",
+   *       "name": "Finished",
+   *       "scope": {
+   *         "project": {
+   *           "id": "1"
+   *         },
+   *         "type": "PROJECT"
+   *       },
+   *       "statusCategory": "DONE",
+   *       "usages": [
+   *         {
+   *           "issueTypes": [
+   *             "10002"
+   *           ],
+   *           "project": {
+   *             "id": "1"
+   *           }
+   *         }
+   *       ],
+   *       "workflowUsages": [
+   *         {
+   *           "workflowId": "545d80a3-91ff-4949-8b0d-a2bc484e70e5",
+   *           "workflowName": "Workflow 1"
+   *         }
+   *       ]
+   *     }
+   *   ]
+   * }
+   * @path {GET} /rest/api/3/statuses/search
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta read:workflow:jira
+   */
+  search({
+    expand,
+    projectId,
+    startAt,
+    maxResults,
+    searchString,
+    statusCategory,
+  }: {
+    /**
+     * Use [expand](#expansion) to include additional information in the response.
+     * This parameter accepts a comma-separated list. Expand options include:
+     *
+     *  *  `usages` Returns the project and issue types that use the status in their
+     * workflow.
+     *  *  `workflowUsages` Returns the workflows that use the status.
+     */
+    expand?: string;
+    /** The project the status is part of or null for global statuses. */
+    projectId?: string;
+    /** The index of the first item to return in a page of results (page offset). */
+    startAt?: number;
+    /** The maximum number of items to return per page. */
+    maxResults?: number;
+    /**
+     * Term to match status names against or null to search for all statuses in the
+     * search scope.
+     */
+    searchString?: string;
+    /**
+     * Category of the status to filter by. The supported values are: `TODO`,
+     * `IN_PROGRESS`, and `DONE`.
+     */
+    statusCategory?: string;
+  }): Promise<PageOfStatuses> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/statuses/search",
+        method: "GET",
+        query: {
+          expand,
+          projectId,
+          startAt,
+          maxResults,
+          searchString,
+          statusCategory,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: PageOfStatuses;
+        }>(),
+      )
+      .then(validationSchemaStorage.validator("StatusService.search.response"))
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Updates statuses by ID.
+   *
+   * **[Permissions](#permissions) required:**
+   *
+   *  *  *Administer projects* [project
+   * permission.](https://confluence.atlassian.com/x/yodKLg)
+   *  *  *Administer Jira* [project
+   * permission.](https://confluence.atlassian.com/x/yodKLg)
+   *
+   * @returns Returned if the request is successful.
+   * @path {PUT} /rest/api/3/statuses
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:workflow:jira
+   */
+  updateStatuses({
+    statusUpdateRequest,
+  }: {
+    /**
+     * The list of statuses that will be updated.
+     *
+     * @example {
+     *     "statuses": [
+     *         {
+     *             "description": "The issue is resolved",
+     *             "id": "1000",
+     *             "name": "Finished",
+     *             "statusCategory": "DONE"
+     *         }
+     *     ]
+     * }
+     */
+    statusUpdateRequest: StatusUpdateRequest;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/statuses",
+        method: "PUT",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: statusUpdateRequest,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          204: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 204;
+          mediaType: "application/json";
+          body: void;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "StatusService.updateStatuses.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "StatusService.getStatusesById.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.array(validationSchemaStorage.lazy("JiraStatus")),
+        })
+        .describe("StatusService.getStatusesById.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "StatusService.updateStatuses.response",
+      z
+        .object({
+          status: z.literal(204),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("StatusService.updateStatuses.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "StatusService.createStatuses.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: z.array(validationSchemaStorage.lazy("JiraStatus")),
+        })
+        .describe("StatusService.createStatuses.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "StatusService.deleteStatusesById.response",
+      z
+        .object({
+          status: z.literal(204),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("StatusService.deleteStatusesById.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "StatusService.search.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("PageOfStatuses"),
+        })
+        .describe("StatusService.search.response"),
+    );
+    validationSchemaStorage.registerOnce([registerStatusValidationSchemas]);
+  }
+}

package/src/openapi/platform/services/tasks-service.ts

@@ -0,0 +1,159 @@
+// 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 {
+  registerCommonValidationSchemas,
+  type TaskProgressBeanObject,
+} from "../models/common";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/**
+ * This resource represents a [long-running asynchronous
+ * tasks](#async-operations). Use it to obtain details about the progress of a
+ * long-running task or cancel a long-running task.
+ */
+export class TasksService extends CommonHttpService {
+  /**
+   * Cancels a task.
+   *
+   * **[Permissions](#permissions) required:** either of:
+   *
+   *  *  *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *  *  Creator of the task.
+   *
+   * @returns Returned if the request is successful.
+   * @path {POST} /rest/api/3/task/{taskId}/cancel
+   * @scopes-current write:jira-work
+   * @scopes-beta delete:async-task:jira
+   */
+  cancelTask({
+    taskId,
+  }: {
+    /** The ID of the task. */
+    taskId: string;
+  }): Promise<unknown> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/task/{taskId}/cancel",
+        method: "POST",
+        pathParams: {
+          taskId,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          202: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 202;
+          mediaType: "application/json";
+          body: unknown;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator("TasksService.cancelTask.response"),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns the status of a [long-running asynchronous task](#async).
+   *
+   * When a task has finished, this operation returns the JSON blob applicable to
+   * the task. See the documentation of the operation that created the task for
+   * details. Task details are not permanently retained. As of September 2019,
+   * details are retained for 14 days although this period may change without notice.
+   *
+   * **Deprecation notice:** The required OAuth 2.0 scopes will be updated on June
+   * 15, 2024.
+   *
+   *  *  `read:jira-work`
+   *
+   * **[Permissions](#permissions) required:** either of:
+   *
+   *  *  *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *  *  Creator of the task.
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "self": "https://your-domain.atlassian.net/rest/api/3/task/1",
+   *   "id": "1",
+   *   "description": "Task description",
+   *   "status": "COMPLETE",
+   *   "result": "the task result, this may be any JSON",
+   *   "submittedBy": 10000,
+   *   "progress": 100,
+   *   "elapsedRuntime": 156,
+   *   "submitted": 1501708132800,
+   *   "started": 1501708132900,
+   *   "finished": 1501708133000,
+   *   "lastUpdate": 1501708133000
+   * }
+   * @path {GET} /rest/api/3/task/{taskId}
+   * @scopes-current read:jira-work
+   * @scopes-beta
+   */
+  getTask({
+    taskId,
+  }: {
+    /** The ID of the task. */
+    taskId: string;
+  }): Promise<TaskProgressBeanObject> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/task/{taskId}",
+        method: "GET",
+        pathParams: {
+          taskId,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: TaskProgressBeanObject;
+        }>(),
+      )
+      .then(validationSchemaStorage.validator("TasksService.getTask.response"))
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "TasksService.getTask.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("TaskProgressBeanObject"),
+        })
+        .describe("TasksService.getTask.response"),
+    );
+    validationSchemaStorage.registerExtensible(
+      "TasksService.cancelTask.response",
+      z
+        .object({
+          status: z.literal(202),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe("TasksService.cancelTask.response"),
+    );
+    validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
+  }
+}