@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/platform/services/project-permission-schemes-service.ts

@@ -1,384 +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 PermissionScheme,
-  registerCommonValidationSchemas,
-  type SecurityScheme,
-} from "../models/common";
-import {
-  type IdBean,
-  type ProjectIssueSecurityLevels,
-  registerProjectPermissionSchemesValidationSchemas,
-} from "../models/project-permission-schemes";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents permission schemes for a project. Use this resource to:
- *
- *  *  get details of a project's issue security levels available to the calling
- * user.
- *  *  get the permission scheme associated with the project or assign different
- * permission scheme to the project.
- *  *  get details of a project's issue security scheme.
- *
- * See [Managing project permissions](https://confluence.atlassian.com/x/yodKLg)
- * for more information about permission schemes.
- */
-export class ProjectPermissionSchemesService extends CommonHttpService {
-  /**
-   * Assigns a permission scheme with a project. See [Managing project
-   * permissions](https://confluence.atlassian.com/x/yodKLg) for more information
-   * about permission schemes.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg)
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "description": "description",
-   *   "id": 10000,
-   *   "name": "Example permission scheme",
-   *   "self": "https://your-domain.atlassian.net/rest/api/3/permissionscheme/10000"
-   * }
-   * @path {PUT} /rest/api/3/project/{projectKeyOrId}/permissionscheme
-   * @scopes-current manage:jira-project
-   * @scopes-beta read:application-role:jira, read:field:jira, read:group:jira,
-   * read:permission-scheme:jira, read:permission:jira, read:project-role:jira,
-   * read:user:jira, write:project:jira, read:avatar:jira,
-   * read:project-category:jira, read:project:jira
-   */
-  assignPermissionScheme({
-    projectKeyOrId,
-    expand,
-    idBean,
-  }: {
-    /** The project ID or project key (case sensitive). */
-    projectKeyOrId: string;
-    /**
-     * Use [expand](#expansion) to include additional information in the response.
-     * This parameter accepts a comma-separated list. Note that permissions are
-     * included when you specify any value. Expand options include:
-     *
-     *  *  `all` Returns all expandable information.
-     *  *  `field` Returns information about the custom field granted the permission.
-     *  *  `group` Returns information about the group that is granted the permission.
-     *  *  `permissions` Returns all permission grants for each permission scheme.
-     *  *  `projectRole` Returns information about the project role granted the
-     * permission.
-     *  *  `user` Returns information about the user who is granted the permission.
-     */
-    expand?: string;
-    /**
-     * @example {
-     *     "id": 10000
-     * }
-     */
-    idBean: IdBean;
-  }): Promise<PermissionScheme> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/project/{projectKeyOrId}/permissionscheme",
-        method: "PUT",
-        pathParams: {
-          projectKeyOrId,
-        },
-        query: {
-          expand,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: idBean,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: PermissionScheme;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectPermissionSchemesService.assignPermissionScheme.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Gets the [permission scheme](https://confluence.atlassian.com/x/yodKLg)
-   * associated with the project.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer projects*
-   * [project permission](https://confluence.atlassian.com/x/yodKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "description": "description",
-   *   "id": 10000,
-   *   "name": "Example permission scheme",
-   *   "self": "https://your-domain.atlassian.net/rest/api/3/permissionscheme/10000"
-   * }
-   * @path {GET} /rest/api/3/project/{projectKeyOrId}/permissionscheme
-   * @scopes-current read:jira-work
-   * @scopes-beta read:application-role:jira, read:field:jira, read:group:jira,
-   * read:permission-scheme:jira, read:permission:jira, read:project-role:jira,
-   * read:user:jira, read:avatar:jira, read:project-category:jira, read:project:jira
-   */
-  getAssignedPermissionScheme({
-    projectKeyOrId,
-    expand,
-  }: {
-    /** The project ID or project key (case sensitive). */
-    projectKeyOrId: string;
-    /**
-     * Use [expand](#expansion) to include additional information in the response.
-     * This parameter accepts a comma-separated list. Note that permissions are
-     * included when you specify any value. Expand options include:
-     *
-     *  *  `all` Returns all expandable information.
-     *  *  `field` Returns information about the custom field granted the permission.
-     *  *  `group` Returns information about the group that is granted the permission.
-     *  *  `permissions` Returns all permission grants for each permission scheme.
-     *  *  `projectRole` Returns information about the project role granted the
-     * permission.
-     *  *  `user` Returns information about the user who is granted the permission.
-     */
-    expand?: string;
-  }): Promise<PermissionScheme> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/project/{projectKeyOrId}/permissionscheme",
-        method: "GET",
-        pathParams: {
-          projectKeyOrId,
-        },
-        query: {
-          expand,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: PermissionScheme;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectPermissionSchemesService.getAssignedPermissionScheme.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns the [issue security scheme](https://confluence.atlassian.com/x/J4lKLg)
-   * associated with the project.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg) or the *Administer
-   * Projects* [project permission](https://confluence.atlassian.com/x/yodKLg).
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "defaultSecurityLevelId": 10021,
-   *   "description": "Description for the default issue security scheme",
-   *   "id": 10000,
-   *   "levels": [
-   *     {
-   *       "description": "Only the reporter and internal staff can see this issue.",
-   *       "id": "10021",
-   *       "name": "Reporter Only",
-   *       "self": "https://your-domain.atlassian.net/rest/api/3/securitylevel/10021"
-   *     }
-   *   ],
-   *   "name": "Default Issue Security Scheme",
-   *   "self":
-   * "https://your-domain.atlassian.net/rest/api/3/issuesecurityschemes/10000"
-   * }
-   * @path {GET} /rest/api/3/project/{projectKeyOrId}/issuesecuritylevelscheme
-   * @scopes-current read:jira-work
-   * @scopes-beta read:issue-security-level:jira, read:issue-security-scheme:jira
-   */
-  getProjectIssueSecurityScheme({
-    projectKeyOrId,
-  }: {
-    /** The project ID or project key (case sensitive). */
-    projectKeyOrId: string;
-  }): Promise<SecurityScheme> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/project/{projectKeyOrId}/issuesecuritylevelscheme",
-        method: "GET",
-        pathParams: {
-          projectKeyOrId,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: SecurityScheme;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectPermissionSchemesService.getProjectIssueSecurityScheme.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns all [issue security](https://confluence.atlassian.com/x/J4lKLg) levels
-   * for the project that the user has access to.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** *Browse projects* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg) for the project,
-   * however, issue security levels are only returned for authenticated user with
-   * *Set Issue Security* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg) for the project.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "levels": [
-   *     {
-   *       "description": "Only the reporter and internal staff can see this issue.",
-   *       "id": "100000",
-   *       "name": "Reporter Only",
-   *       "self":
-   * "https://your-domain.atlassian.net/rest/api/3/securitylevel/100000"
-   *     },
-   *     {
-   *       "description": "Only internal staff can see this issue.",
-   *       "id": "100001",
-   *       "name": "Staff Only",
-   *       "self":
-   * "https://your-domain.atlassian.net/rest/api/3/securitylevel/100001"
-   *     }
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/project/{projectKeyOrId}/securitylevel
-   * @scopes-current read:jira-work
-   * @scopes-beta read:issue-security-level:jira
-   */
-  getSecurityLevelsForProject({
-    projectKeyOrId,
-  }: {
-    /** The project ID or project key (case sensitive). */
-    projectKeyOrId: string;
-  }): Promise<ProjectIssueSecurityLevels> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/project/{projectKeyOrId}/securitylevel",
-        method: "GET",
-        pathParams: {
-          projectKeyOrId,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: ProjectIssueSecurityLevels;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectPermissionSchemesService.getSecurityLevelsForProject.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "ProjectPermissionSchemesService.getProjectIssueSecurityScheme.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("SecurityScheme"),
-        })
-        .describe(
-          "ProjectPermissionSchemesService.getProjectIssueSecurityScheme.response",
-        ),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ProjectPermissionSchemesService.getAssignedPermissionScheme.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("PermissionScheme"),
-        })
-        .describe(
-          "ProjectPermissionSchemesService.getAssignedPermissionScheme.response",
-        ),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ProjectPermissionSchemesService.assignPermissionScheme.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("PermissionScheme"),
-        })
-        .describe(
-          "ProjectPermissionSchemesService.assignPermissionScheme.response",
-        ),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ProjectPermissionSchemesService.getSecurityLevelsForProject.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("ProjectIssueSecurityLevels"),
-        })
-        .describe(
-          "ProjectPermissionSchemesService.getSecurityLevelsForProject.response",
-        ),
-    );
-    validationSchemaStorage.registerOnce([
-      registerCommonValidationSchemas,
-      registerProjectPermissionSchemesValidationSchemas,
-    ]);
-  }
-}

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

@@ -1,320 +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 EntityProperty,
-  type PropertyKeys,
-  registerCommonValidationSchemas,
-} from "../models/common";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents [project](#api-group-Projects) properties, which
- * provides for storing custom data against a project. Use it to get, create, and
- * delete project properties as well as get a list of property keys for a project.
- * Project properties are a type of [entity
- * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
- */
-export class ProjectPropertiesService extends CommonHttpService {
-  /**
-   * Deletes the
-   * [property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties)
-   * from a project.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects*
-   * [project permission](https://confluence.atlassian.com/x/yodKLg) for the project
-   * containing the property.
-   *
-   * @path {DELETE} /rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}
-   * @scopes-current manage:jira-project
-   * @scopes-beta delete:project.property:jira
-   */
-  deleteProjectProperty({
-    projectIdOrKey,
-    propertyKey,
-  }: {
-    /** The project ID or project key (case sensitive). */
-    projectIdOrKey: string;
-    /**
-     * The project property key. Use [Get project property
-     * keys](#api-rest-api-3-project-projectIdOrKey-properties-get) to get a list of
-     * all project property keys.
-     */
-    propertyKey: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}",
-        method: "DELETE",
-        pathParams: {
-          projectIdOrKey,
-          propertyKey,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Returns the value of a [project
-   * property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties).
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** *Browse Projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for the project
-   * containing the property.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "key": "issue.support",
-   *   "value": {
-   *     "system.conversation.id": "b1bf38be-5e94-4b40-a3b8-9278735ee1e6",
-   *     "system.support.time": "1m"
-   *   }
-   * }
-   * @path {GET} /rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}
-   * @scopes-current read:jira-work
-   * @scopes-beta read:project.property:jira
-   */
-  getProjectProperty({
-    projectIdOrKey,
-    propertyKey,
-  }: {
-    /** The project ID or project key (case sensitive). */
-    projectIdOrKey: string;
-    /**
-     * The project property key. Use [Get project property
-     * keys](#api-rest-api-3-project-projectIdOrKey-properties-get) to get a list of
-     * all project property keys.
-     */
-    propertyKey: string;
-  }): Promise<EntityProperty> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}",
-        method: "GET",
-        pathParams: {
-          projectIdOrKey,
-          propertyKey,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: EntityProperty;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectPropertiesService.getProjectProperty.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns all [project
-   * property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties)
-   * keys for the project.
-   *
-   * 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 the request is successful.
-   *
-   * example: {
-   *   "keys": [
-   *     {
-   *       "key": "issue.support",
-   *       "self":
-   * "https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support"
-   *     }
-   *   ]
-   * }
-   * @path {GET} /rest/api/3/project/{projectIdOrKey}/properties
-   * @scopes-current read:jira-work
-   * @scopes-beta read:project.property:jira
-   */
-  getProjectPropertyKeys({
-    projectIdOrKey,
-  }: {
-    /** The project ID or project key (case sensitive). */
-    projectIdOrKey: string;
-  }): Promise<PropertyKeys> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/project/{projectIdOrKey}/properties",
-        method: "GET",
-        pathParams: {
-          projectIdOrKey,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: PropertyKeys;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectPropertiesService.getProjectPropertyKeys.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Sets the value of the [project
-   * property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties).
-   * You can use project properties to store custom data against the project.
-   *
-   * The value of the request body must be a
-   * [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum
-   * length is 32768 characters.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects*
-   * [project permission](https://confluence.atlassian.com/x/yodKLg) for the project
-   * in which the property is created.
-   *
-   * @returns * status: 200, mediaType: application/json
-   *
-   *    Returned if the project property is updated.
-   *
-   *  * status: 201, mediaType: application/json
-   *
-   *    Returned if the project property is created.
-   * @path {PUT} /rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}
-   * @scopes-current manage:jira-project
-   * @scopes-beta write:project.property:jira
-   */
-  setProjectProperty({
-    projectIdOrKey,
-    propertyKey,
-    requestBody,
-  }: {
-    /** The project ID or project key (case sensitive). */
-    projectIdOrKey: string;
-    /** The key of the project property. The maximum length is 255 characters. */
-    propertyKey: string;
-    /**
-     * The value of the property. The value has to be a valid, non-empty
-     * [JSON](https://tools.ietf.org/html/rfc4627) value. The maximum length of the
-     * property value is 32768 bytes.
-     *
-     * @example {
-     *     "number": 5,
-     *     "string": "string-value"
-     * }
-     */
-    requestBody: unknown;
-  }): Promise<{
-    created: boolean;
-    body: unknown;
-  }> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}",
-        method: "PUT",
-        pathParams: {
-          projectIdOrKey,
-          propertyKey,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: requestBody,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-          201: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200 | 201;
-          mediaType: "application/json";
-          body: unknown;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "ProjectPropertiesService.setProjectProperty.response",
-        ),
-      )
-      .then(commonHttpClient.asCreatedResponse("body"));
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "ProjectPropertiesService.getProjectPropertyKeys.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("PropertyKeys"),
-        })
-        .describe("ProjectPropertiesService.getProjectPropertyKeys.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ProjectPropertiesService.getProjectProperty.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("EntityProperty"),
-        })
-        .describe("ProjectPropertiesService.getProjectProperty.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "ProjectPropertiesService.setProjectProperty.response",
-      z
-        .object({
-          status: z.number(),
-          mediaType: z.string(),
-          body: z.unknown(),
-        })
-        .superRefine(({ status: status, body: body }, ctx) => {
-          if (status === 200 || status === 201) {
-            z.unknown().parse(body);
-          } else {
-            ctx.addIssue({
-              code: z.ZodIssueCode.custom,
-              path: ["status"],
-              message: `Unexpected status code: ${status}`,
-            });
-          }
-        })
-        .describe("ProjectPropertiesService.setProjectProperty.response"),
-    );
-    validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
-  }
-}