@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/platform/services/project-avatars-service.ts

@@ -1,341 +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 { type Avatar, registerCommonValidationSchemas } from "../models/common";
-import {
-  type ProjectAvatars,
-  registerProjectAvatarsValidationSchemas,
-} from "../models/project-avatars";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents avatars associated with a project. Use it to get,
- * load, set, and remove project avatars.
- */
-export class ProjectAvatarsService extends CommonHttpService {
-  /**
-   * Loads an avatar for a project.
-   *
-   * Specify the avatar's local file location in the body of the request. Also,
-   * include the following headers:
-   *
-   *  *  `X-Atlassian-Token: no-check` To prevent XSRF protection blocking the
-   * request, for more information see [Special Headers](#special-request-headers).
-   *  *  `Content-Type: image/image type` Valid image types are JPEG, GIF, or PNG.
-   *
-   * For example:
-   * `curl --request POST `
-   *
-   * `--user email@example.com:<api_token> `
-   *
-   * `--header 'X-Atlassian-Token: no-check' `
-   *
-   * `--header 'Content-Type: image/< image_type>' `
-   *
-   * `--data-binary "<@/path/to/file/with/your/avatar>" `
-   *
-   * `--url
-   * 'https://your-domain.atlassian.net/rest/api/3/project/{projectIdOrKey}/avatar2'`
-   *
-   * The avatar is cropped to a square. If no crop parameters are specified, the
-   * square originates at the top left of the image. The length of the square's
-   * sides is set to the smaller of the height or width of the image.
-   *
-   * The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and
-   * 48x48 in size.
-   *
-   * After creating the avatar use [Set project
-   * avatar](#api-rest-api-3-project-projectIdOrKey-avatar-put) to set it as the
-   * project's displayed avatar.
-   *
-   * **[Permissions](#permissions) required:** *Administer projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "id": "1010",
-   *   "isDeletable": true,
-   *   "isSelected": false,
-   *   "isSystemAvatar": false
-   * }
-   * @path {POST} /rest/api/3/project/{projectIdOrKey}/avatar2
-   * @scopes-current manage:jira-project
-   * @scopes-beta write:project.avatar:jira, read:avatar:jira
-   */
-  createProjectAvatar({
-    projectIdOrKey,
-    x,
-    y,
-    size,
-    mediaType,
-    requestBody,
-  }: {
-    /** The ID or (case-sensitive) key of the project. */
-    projectIdOrKey: string;
-    /** The X coordinate of the top-left corner of the crop region. */
-    x?: number;
-    /** The Y coordinate of the top-left corner of the crop region. */
-    y?: number;
-    /** The length of each side of the crop region. */
-    size?: number;
-    mediaType: string;
-    requestBody: unknown;
-  }): Promise<Avatar> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/project/{projectIdOrKey}/avatar2",
-        method: "POST",
-        pathParams: {
-          projectIdOrKey,
-        },
-        query: {
-          x,
-          y,
-          size,
-        },
-        headers: {
-          "Content-Type": mediaType,
-        },
-        body: requestBody,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          201: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 201;
-          mediaType: "application/json";
-          body: Avatar;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectAvatarsService.createProjectAvatar.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Deletes a custom avatar from a project. Note that system avatars cannot be
-   * deleted.
-   *
-   * **[Permissions](#permissions) required:** *Administer projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg).
-   *
-   * @path {DELETE} /rest/api/3/project/{projectIdOrKey}/avatar/{id}
-   * @scopes-current manage:jira-project
-   * @scopes-beta delete:project.avatar:jira
-   */
-  deleteProjectAvatar({
-    projectIdOrKey,
-    id,
-  }: {
-    /** The project ID or (case-sensitive) key. */
-    projectIdOrKey: string;
-    /** The ID of the avatar. */
-    id: number;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/project/{projectIdOrKey}/avatar/{id}",
-        method: "DELETE",
-        pathParams: {
-          projectIdOrKey,
-          id,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Returns all project avatars, grouped by system and custom avatars.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** *Browse projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
-   *
-   * @returns Returned if request is successful.
-   *
-   * example: {
-   *   "custom": [
-   *     {
-   *       "id": "1010",
-   *       "isDeletable": true,
-   *       "isSelected": false,
-   *       "isSystemAvatar": false,
-   *       "urls": {
-   *         "16x16":
-   * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10080&avatarType=project",
-   *         "24x24":
-   * "https://your-domain.atlassian.net/secure/viewavatar?size=small&avatarId=10080&avatarType=project",
-   *         "32x32":
-   * "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10080&avatarType=project",
-   *         "48x48":
-   * "https://your-domain.atlassian.net/secure/viewavatar?avatarId=10080&avatarType=project"
-   *       }
-   *     }
-   *   ],
-   *   "system": [
-   *     {
-   *       "id": "1000",
-   *       "isDeletable": false,
-   *       "isSelected": false,
-   *       "isSystemAvatar": true,
-   *       "urls": {
-   *         "16x16":
-   * "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10040&avatarType=project",
-   *         "24x24":
-   * "https://your-domain.atlassian.net/secure/viewavatar?size=small&avatarId=10040&avatarType=project",
-   *         "32x32":
-   * "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10040&avatarType=project",
-   *         "48x48":
-   * "https://your-domain.atlassian.net/secure/viewavatar?avatarId=10040&avatarType=project"
-   *       }
-   *     }
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/project/{projectIdOrKey}/avatars
-   * @scopes-current read:jira-work
-   * @scopes-beta read:project.avatar:jira, read:avatar:jira
-   */
-  getAllProjectAvatars({
-    projectIdOrKey,
-  }: {
-    /** The ID or (case-sensitive) key of the project. */
-    projectIdOrKey: string;
-  }): Promise<ProjectAvatars> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/project/{projectIdOrKey}/avatars",
-        method: "GET",
-        pathParams: {
-          projectIdOrKey,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ProjectAvatars;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectAvatarsService.getAllProjectAvatars.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Sets the avatar displayed for a project.
-   *
-   * Use [Load project avatar](#api-rest-api-3-project-projectIdOrKey-avatar2-post)
-   * to store avatars against the project, before using this operation to set the
-   * displayed avatar.
-   *
-   * **[Permissions](#permissions) required:** *Administer projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg).
-   *
-   * @returns Returned if the request is successful.
-   * @path {PUT} /rest/api/3/project/{projectIdOrKey}/avatar
-   * @scopes-current manage:jira-project
-   * @scopes-beta write:project.avatar:jira
-   */
-  updateProjectAvatar({
-    projectIdOrKey,
-    avatar,
-  }: {
-    /** The ID or (case-sensitive) key of the project. */
-    projectIdOrKey: string;
-    /**
-     * @example {
-     *     "id": "10010"
-     * }
-     */
-    avatar: Avatar;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/project/{projectIdOrKey}/avatar",
-        method: "PUT",
-        pathParams: {
-          projectIdOrKey,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: avatar,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectAvatarsService.updateProjectAvatar.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "ProjectAvatarsService.updateProjectAvatar.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("ProjectAvatarsService.updateProjectAvatar.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ProjectAvatarsService.createProjectAvatar.response",
-      z
-        .object({
-          status: z.literal(201),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("Avatar"),
-        })
-        .describe("ProjectAvatarsService.createProjectAvatar.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ProjectAvatarsService.getAllProjectAvatars.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("ProjectAvatars"),
-        })
-        .describe("ProjectAvatarsService.getAllProjectAvatars.response"),
-    );
-    validationSchemaStorage.registerOnce([
-      registerCommonValidationSchemas,
-      registerProjectAvatarsValidationSchemas,
-    ]);
-  }
-}

package/src/openapi/platform/services/project-categories-service.ts

@@ -1,318 +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 {
-  type ProjectCategory,
-  registerCommonValidationSchemas,
-  type UpdatedProjectCategory,
-} from "../models/common";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents project categories. Use it to create, update, and
- * delete project categories as well as obtain a list of all project categories
- * and details of individual categories. For more information on managing project
- * categories, see [Adding, assigning, and deleting project
- * categories](https://confluence.atlassian.com/x/-A5WMg).
- */
-export class ProjectCategoriesService extends CommonHttpService {
-  /**
-   * Creates a project category.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "description": "Created Project Category",
-   *   "id": "10100",
-   *   "name": "CREATED",
-   *   "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10100"
-   * }
-   * @path {POST} /rest/api/3/projectCategory
-   * @scopes-current manage:jira-project
-   * @scopes-beta write:project-category:jira, read:project-category:jira
-   */
-  createProjectCategory({
-    projectCategory,
-  }: {
-    /**
-     * @example {
-     *     "description": "Created Project Category",
-     *     "name": "CREATED"
-     * }
-     */
-    projectCategory: ProjectCategory;
-  }): Promise<ProjectCategory> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/projectCategory",
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: projectCategory,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          201: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 201;
-          mediaType: "application/json";
-          body: ProjectCategory;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectCategoriesService.createProjectCategory.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns all project categories.
-   *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: [
-   *   {
-   *     "description": "First Project Category",
-   *     "id": "10000",
-   *     "name": "FIRST",
-   *     "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
-   *   },
-   *   {
-   *     "description": "Second Project Category",
-   *     "id": "10001",
-   *     "name": "SECOND",
-   *     "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10001"
-   *   }
-   * ]
-   * @path {GET} /rest/api/3/projectCategory
-   * @scopes-current read:jira-work
-   * @scopes-beta read:project-category:jira
-   */
-  getAllProjectCategories(): Promise<ProjectCategory[]> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/projectCategory",
-        method: "GET",
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ProjectCategory[];
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectCategoriesService.getAllProjectCategories.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns a project category.
-   *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "description": "First Project Category",
-   *   "id": "10000",
-   *   "name": "FIRST",
-   *   "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
-   * }
-   * @path {GET} /rest/api/3/projectCategory/{id}
-   * @scopes-current read:jira-work
-   * @scopes-beta read:project-category:jira
-   */
-  getProjectCategoryById({
-    id,
-  }: {
-    /** The ID of the project category. */
-    id: number;
-  }): Promise<ProjectCategory> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/projectCategory/{id}",
-        method: "GET",
-        pathParams: {
-          id,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ProjectCategory;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectCategoriesService.getProjectCategoryById.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Deletes a project category.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @path {DELETE} /rest/api/3/projectCategory/{id}
-   * @scopes-current manage:jira-project
-   * @scopes-beta delete:project-category:jira
-   */
-  removeProjectCategory({
-    id,
-  }: {
-    /** ID of the project category to delete. */
-    id: number;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/projectCategory/{id}",
-        method: "DELETE",
-        pathParams: {
-          id,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Updates a project category.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "description": "Updated Project Category",
-   *   "id": "10100",
-   *   "name": "UPDATED",
-   *   "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10100"
-   * }
-   * @path {PUT} /rest/api/3/projectCategory/{id}
-   * @scopes-current manage:jira-project
-   * @scopes-beta read:project-category:jira, write:project-category:jira
-   */
-  updateProjectCategory({
-    id,
-    projectCategory,
-  }: {
-    id: number;
-    /**
-     * @example {
-     *     "description": "Updated Project Category",
-     *     "name": "UPDATED"
-     * }
-     */
-    projectCategory: ProjectCategory;
-  }): Promise<UpdatedProjectCategory> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/projectCategory/{id}",
-        method: "PUT",
-        pathParams: {
-          id,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: projectCategory,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: UpdatedProjectCategory;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectCategoriesService.updateProjectCategory.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "ProjectCategoriesService.getAllProjectCategories.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.array(validationSchemaStorage.lazy("ProjectCategory")),
-        })
-        .describe("ProjectCategoriesService.getAllProjectCategories.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ProjectCategoriesService.createProjectCategory.response",
-      z
-        .object({
-          status: z.literal(201),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("ProjectCategory"),
-        })
-        .describe("ProjectCategoriesService.createProjectCategory.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ProjectCategoriesService.getProjectCategoryById.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("ProjectCategory"),
-        })
-        .describe("ProjectCategoriesService.getProjectCategoryById.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ProjectCategoriesService.updateProjectCategory.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("UpdatedProjectCategory"),
-        })
-        .describe("ProjectCategoriesService.updateProjectCategory.response"),
-    );
-    validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
-  }
-}