@resolution/jira-api-client 0.1.0 → 0.1.2

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

@@ -1,606 +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 type {
-  BulkIssuePropertyUpdateRequest,
-  IssueEntityProperties,
-  IssueFilterForBulkPropertyDelete,
-  MultiIssueEntityProperties,
-} from "../models/issue-properties";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents [issue](#api-group-Issues) properties, which provides
- * for storing custom data against an issue. Use it to get, set, and delete issue
- * properties as well as obtain details of all properties on an issue. Operations
- * to bulk update and delete issue properties are also provided. Issue properties
- * are a type of [entity
- * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
- */
-export class IssuePropertiesService extends CommonHttpService {
-  /**
-   * Deletes a property value from multiple issues. The issues to be updated can be
-   * specified by filter criteria.
-   *
-   * The criteria the filter used to identify eligible issues are:
-   *
-   *  *  `entityIds` Only issues from this list are eligible.
-   *  *  `currentValue` Only issues with the property set to this value are eligible.
-   *
-   * If both criteria is specified, they are joined with the logical *AND*: only
-   * issues that satisfy both criteria are considered eligible.
-   *
-   * If no filter criteria are specified, all the issues visible to the user and
-   * where the user has the EDIT\_ISSUES permission for the issue are considered
-   * eligible.
-   *
-   * This operation is:
-   *
-   *  *  transactional, either the property is deleted from all eligible issues or,
-   * when errors occur, no properties are deleted.
-   *  *  [asynchronous](#async). Follow the `location` link in the response to
-   * determine the status of the task and use [Get
-   * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  *Browse projects* [ project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for each project
-   * containing issues.
-   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-   * configured, issue-level security permission to view the issue.
-   *  *  *Edit issues* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for each issue.
-   *
-   * @path {DELETE} /rest/api/3/issue/properties/{propertyKey}
-   * @scopes-current write:jira-work
-   * @scopes-beta delete:issue.property:jira
-   */
-  bulkDeleteIssueProperty({
-    propertyKey,
-    issueFilterForBulkPropertyDelete,
-  }: {
-    /** The key of the property. */
-    propertyKey: string;
-    /**
-     * @example {
-     *     "currentValue": "deprecated value",
-     *     "entityIds": [
-     *         10100,
-     *         100010
-     *     ]
-     * }
-     */
-    issueFilterForBulkPropertyDelete: IssueFilterForBulkPropertyDelete;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issue/properties/{propertyKey}",
-        method: "DELETE",
-        pathParams: {
-          propertyKey,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: issueFilterForBulkPropertyDelete,
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Sets or updates entity property values on issues. Up to 10 entity properties
-   * can be specified for each issue and up to 100 issues included in the request.
-   *
-   * The value of the request body must be a
-   * [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON.
-   *
-   * This operation is:
-   *
-   *  *  [asynchronous](#async). Follow the `location` link in the response to
-   * determine the status of the task and use [Get
-   * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
-   *  *  non-transactional. Updating some entities may fail. Such information will
-   * available in the task result.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  *Browse projects* and *Edit issues* [project
-   * permissions](https://confluence.atlassian.com/x/yodKLg) for the project
-   * containing the issue.
-   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-   * configured, issue-level security permission to view the issue.
-   *
-   * @path {POST} /rest/api/3/issue/properties/multi
-   * @scopes-current write:jira-work
-   * @scopes-beta write:issue.property:jira
-   */
-  bulkSetIssuePropertiesByIssue({
-    multiIssueEntityProperties,
-  }: {
-    /**
-     * Details of the issue properties to be set or updated. Note that if an issue is
-     * not found, it is ignored.
-     *
-     * @example {
-     *     "issues": [
-     *         {
-     *             "issueID": 1000,
-     *             "properties": {
-     *                 "myProperty": {
-     *                     "owner": "admin",
-     *                     "weight": 100
-     *                 }
-     *             }
-     *         },
-     *         {
-     *             "issueID": 1001,
-     *             "properties": {
-     *                 "myOtherProperty": {
-     *                     "cost": 150,
-     *                     "transportation": "car"
-     *                 }
-     *             }
-     *         }
-     *     ]
-     * }
-     */
-    multiIssueEntityProperties: MultiIssueEntityProperties;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issue/properties/multi",
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: multiIssueEntityProperties,
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Sets a property value on multiple issues.
-   *
-   * The value set can be a constant or determined by a [Jira
-   * expression](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/).
-   * Expressions must be computable with constant complexity when applied to a set
-   * of issues. Expressions must also comply with the
-   * [restrictions](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#restrictions)
-   * that apply to all Jira expressions.
-   *
-   * The issues to be updated can be specified by a filter.
-   *
-   * The filter identifies issues eligible for update using these criteria:
-   *
-   *  *  `entityIds` Only issues from this list are eligible.
-   *  *  `currentValue` Only issues with the property set to this value are eligible.
-   *  *  `hasProperty`:
-   *
-   *      *  If *true*, only issues with the property are eligible.
-   *      *  If *false*, only issues without the property are eligible.
-   *
-   * If more than one criteria is specified, they are joined with the logical *AND*:
-   * only issues that satisfy all criteria are eligible.
-   *
-   * If an invalid combination of criteria is provided, an error is returned. For
-   * example, specifying a `currentValue` and `hasProperty` as *false* would not
-   * match any issues (because without the property the property cannot have a
-   * value).
-   *
-   * The filter is optional. Without the filter all the issues visible to the user
-   * and where the user has the EDIT\_ISSUES permission for the issue are considered
-   * eligible.
-   *
-   * This operation is:
-   *
-   *  *  transactional, either all eligible issues are updated or, when errors
-   * occur, none are updated.
-   *  *  [asynchronous](#async). Follow the `location` link in the response to
-   * determine the status of the task and use [Get
-   * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  *Browse projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for each project
-   * containing issues.
-   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-   * configured, issue-level security permission to view the issue.
-   *  *  *Edit issues* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for each issue.
-   *
-   * @path {PUT} /rest/api/3/issue/properties/{propertyKey}
-   * @scopes-current write:jira-work
-   * @scopes-beta read:jira-expressions:jira, write:issue.property:jira
-   */
-  bulkSetIssueProperty({
-    propertyKey,
-    bulkIssuePropertyUpdateRequest,
-  }: {
-    /** The key of the property. The maximum length is 255 characters. */
-    propertyKey: string;
-    /**
-     * @example {
-     *     "filter": {
-     *         "currentValue": {
-     *             "owner": "admin",
-     *             "weight": 50
-     *         },
-     *         "entityIds": [
-     *             10100,
-     *             100010
-     *         ],
-     *         "hasProperty": true
-     *     },
-     *     "value": {
-     *         "owner": "admin",
-     *         "weight": 100
-     *     }
-     * }
-     */
-    bulkIssuePropertyUpdateRequest: BulkIssuePropertyUpdateRequest;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issue/properties/{propertyKey}",
-        method: "PUT",
-        pathParams: {
-          propertyKey,
-        },
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: bulkIssuePropertyUpdateRequest,
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Sets or updates a list of entity property values on issues. A list of up to 10
-   * entity properties can be specified along with up to 10,000 issues on which to
-   * set or update that list of entity properties.
-   *
-   * The value of the request body must be a
-   * [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON. The maximum length
-   * of single issue property value is 32768 characters. This operation can be
-   * accessed anonymously.
-   *
-   * This operation is:
-   *
-   *  *  transactional, either all properties are updated in all eligible issues or,
-   * when errors occur, no properties are updated.
-   *  *  [asynchronous](#async). Follow the `location` link in the response to
-   * determine the status of the task and use [Get
-   * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  *Browse projects* and *Edit issues* [project
-   * permissions](https://confluence.atlassian.com/x/yodKLg) for the project
-   * containing the issue.
-   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-   * configured, issue-level security permission to view the issue.
-   *
-   * @path {POST} /rest/api/3/issue/properties
-   * @scopes-current write:jira-work
-   * @scopes-beta write:issue.property:jira
-   */
-  bulkSetIssuesPropertiesList({
-    issueEntityProperties,
-  }: {
-    /** Issue properties to be set or updated with values. */
-    issueEntityProperties: IssueEntityProperties;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issue/properties",
-        method: "POST",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: issueEntityProperties,
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Deletes an issue's property.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  *Browse projects* and *Edit issues* [project
-   * permissions](https://confluence.atlassian.com/x/yodKLg) for the project
-   * containing the issue.
-   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-   * configured, issue-level security permission to view the issue.
-   *
-   * @path {DELETE} /rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}
-   * @scopes-current write:jira-work
-   * @scopes-beta delete:issue.property:jira
-   */
-  deleteIssueProperty({
-    issueIdOrKey,
-    propertyKey,
-  }: {
-    /** The key or ID of the issue. */
-    issueIdOrKey: string;
-    /** The key of the property. */
-    propertyKey: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}",
-        method: "DELETE",
-        pathParams: {
-          issueIdOrKey,
-          propertyKey,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Returns the key and value of an issue's property.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  *Browse projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for the project
-   * containing the issue.
-   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-   * configured, issue-level security permission to view the issue.
-   *
-   * @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/issue/{issueIdOrKey}/properties/{propertyKey}
-   * @scopes-current read:jira-work
-   * @scopes-beta read:issue.property:jira
-   */
-  getIssueProperty({
-    issueIdOrKey,
-    propertyKey,
-  }: {
-    /** The key or ID of the issue. */
-    issueIdOrKey: string;
-    /** The key of the property. */
-    propertyKey: string;
-  }): Promise<EntityProperty> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}",
-        method: "GET",
-        pathParams: {
-          issueIdOrKey,
-          propertyKey,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: EntityProperty;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssuePropertiesService.getIssueProperty.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns the URLs and keys of an issue's properties.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** Property details are only returned
-   * where the user has:
-   *
-   *  *  *Browse projects* [project
-   * permission](https://confluence.atlassian.com/x/yodKLg) for the project
-   * containing the issue.
-   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-   * configured, issue-level security permission to view the issue.
-   *
-   * @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/issue/{issueIdOrKey}/properties
-   * @scopes-current read:jira-work
-   * @scopes-beta read:issue.property:jira
-   */
-  getIssuePropertyKeys({
-    issueIdOrKey,
-  }: {
-    /** The key or ID of the issue. */
-    issueIdOrKey: string;
-  }): Promise<PropertyKeys> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/issue/{issueIdOrKey}/properties",
-        method: "GET",
-        pathParams: {
-          issueIdOrKey,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: PropertyKeys;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "IssuePropertiesService.getIssuePropertyKeys.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Sets the value of an issue's property. Use this resource to store custom data
-   * against an issue.
-   *
-   * 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:**
-   *
-   *  *  *Browse projects* and *Edit issues* [project
-   * permissions](https://confluence.atlassian.com/x/yodKLg) for the project
-   * containing the issue.
-   *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
-   * configured, issue-level security permission to view the issue.
-   *
-   * @returns * status: 200, mediaType: application/json
-   *
-   *    Returned if the issue property is updated.
-   *
-   *  * status: 201, mediaType: application/json
-   *
-   *    Returned if the issue property is created.
-   * @path {PUT} /rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}
-   * @scopes-current write:jira-work
-   * @scopes-beta write:issue.property:jira
-   */
-  setIssueProperty({
-    issueIdOrKey,
-    propertyKey,
-    requestBody,
-  }: {
-    /** The ID or key of the issue. */
-    issueIdOrKey: string;
-    /** The key of the issue 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/issue/{issueIdOrKey}/properties/{propertyKey}",
-        method: "PUT",
-        pathParams: {
-          issueIdOrKey,
-          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(
-          "IssuePropertiesService.setIssueProperty.response",
-        ),
-      )
-      .then(commonHttpClient.asCreatedResponse("body"));
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "IssuePropertiesService.getIssuePropertyKeys.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("PropertyKeys"),
-        })
-        .describe("IssuePropertiesService.getIssuePropertyKeys.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssuePropertiesService.getIssueProperty.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("EntityProperty"),
-        })
-        .describe("IssuePropertiesService.getIssueProperty.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "IssuePropertiesService.setIssueProperty.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("IssuePropertiesService.setIssueProperty.response"),
-    );
-    validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
-  }
-}