@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/platform/services/issue-comment-properties-service.ts

@@ -1,324 +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 [issue comment](#api-group-Issue-comments) properties,
- * which provides for storing custom data against an issue comment. Use is to get,
- * set, and delete issue comment properties as well as obtain the keys of all
- * properties on a comment. Comment properties are a type of [entity
- * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
- */
-export class IssueCommentPropertiesService extends CommonHttpService {
-  /**
-   * Deletes a comment property.
-   *
-   * **[Permissions](#permissions) required:** either of:
-   *
-   *  *  *Edit All Comments* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) to delete a property
-   * from any comment.
-   *  *  *Edit Own Comments* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) to delete a property
-   * from a comment created by the user.
-   *
-   * Also, when the visibility of a comment is restricted to a role or group the
-   * user must be a member of that role or group.
-   *
-   * @path {DELETE} /rest/api/3/comment/{commentId}/properties/{propertyKey}
-   * @scopes-current write:jira-work
-   * @scopes-beta delete:comment.property:jira
-   */
-  deleteCommentProperty({
-    commentId,
-    propertyKey,
-  }: {
-    /** The ID of the comment. */
-    commentId: string;
-    /** The key of the property. */
-    propertyKey: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/comment/{commentId}/properties/{propertyKey}",
-        method: "DELETE",
-        pathParams: {
-          commentId,
-          propertyKey,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Returns the value of a comment property.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  *Browse projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
-   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-   * configured, issue-level security permission to view the issue.
-   *  *  If the comment has visibility restrictions, belongs to the group or has the
-   * role visibility is restricted to.
-   *
-   * @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/comment/{commentId}/properties/{propertyKey}
-   * @scopes-current read:jira-work
-   * @scopes-beta read:comment.property:jira
-   */
-  getCommentProperty({
-    commentId,
-    propertyKey,
-  }: {
-    /** The ID of the comment. */
-    commentId: string;
-    /** The key of the property. */
-    propertyKey: string;
-  }): Promise<EntityProperty> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/comment/{commentId}/properties/{propertyKey}",
-        method: "GET",
-        pathParams: {
-          commentId,
-          propertyKey,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: EntityProperty;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueCommentPropertiesService.getCommentProperty.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns the keys of all the properties of a comment.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  *Browse projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for the project.
-   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-   * configured, issue-level security permission to view the issue.
-   *  *  If the comment has visibility restrictions, belongs to the group or has the
-   * role visibility is restricted to.
-   *
-   * @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/comment/{commentId}/properties
-   * @scopes-current read:jira-work
-   * @scopes-beta read:comment.property:jira
-   */
-  getCommentPropertyKeys({
-    commentId,
-  }: {
-    /** The ID of the comment. */
-    commentId: string;
-  }): Promise<PropertyKeys> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/comment/{commentId}/properties",
-        method: "GET",
-        pathParams: {
-          commentId,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: PropertyKeys;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssueCommentPropertiesService.getCommentPropertyKeys.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Creates or updates the value of a property for a comment. Use this resource to
-   * store custom data against a comment.
-   *
-   * 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.
-   *
-   * **[Permissions](#permissions) required:** either of:
-   *
-   *  *  *Edit All Comments* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) to create or update the
-   * value of a property on any comment.
-   *  *  *Edit Own Comments* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) to create or update the
-   * value of a property on a comment created by the user.
-   *
-   * Also, when the visibility of a comment is restricted to a role or group the
-   * user must be a member of that role or group.
-   *
-   * @returns * status: 200, mediaType: application/json
-   *
-   *    Returned if the comment property is updated.
-   *
-   *  * status: 201, mediaType: application/json
-   *
-   *    Returned if the comment property is created.
-   * @path {PUT} /rest/api/3/comment/{commentId}/properties/{propertyKey}
-   * @scopes-current write:jira-work
-   * @scopes-beta write:comment.property:jira
-   */
-  setCommentProperty({
-    commentId,
-    propertyKey,
-    requestBody,
-  }: {
-    /** The ID of the comment. */
-    commentId: string;
-    /** The key of the 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.
-     */
-    requestBody: unknown;
-  }): Promise<{
-    created: boolean;
-    body: unknown;
-  }> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/comment/{commentId}/properties/{propertyKey}",
-        method: "PUT",
-        pathParams: {
-          commentId,
-          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(
-          "IssueCommentPropertiesService.setCommentProperty.response",
-        ),
-      )
-      .then(commonHttpClient.asCreatedResponse("body"));
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "IssueCommentPropertiesService.getCommentPropertyKeys.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("PropertyKeys"),
-        })
-        .describe(
-          "IssueCommentPropertiesService.getCommentPropertyKeys.response",
-        ),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueCommentPropertiesService.getCommentProperty.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("EntityProperty"),
-        })
-        .describe("IssueCommentPropertiesService.getCommentProperty.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssueCommentPropertiesService.setCommentProperty.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("IssueCommentPropertiesService.setCommentProperty.response"),
-    );
-    validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
-  }
-}