@resolution/jira-api-client 0.1.0 → 0.1.2

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

@@ -1,413 +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 [user](#api-group-Users) properties and provides for
- * storing custom data against a user. Use it to get, create, and delete user
- * properties as well as get a list of property keys for a user. This resourse is
- * designed for integrations and apps to store per-user data and settings. This
- * enables data used to customized the user experience to be kept in the Jira
- * Cloud instance's database. User properties are a type of [entity
- * property](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).
- *
- * This resource does not access the [user
- * properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in
- * Jira.
- */
-export class UserPropertiesService extends CommonHttpService {
-  /**
-   * Deletes a property from a user.
-   *
-   * Note: This operation does not access the [user
-   * properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in
-   * Jira.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg), to delete a property
-   * from any user.
-   *  *  Access to Jira, to delete a property from the calling user's record.
-   *
-   * @path {DELETE} /rest/api/3/user/properties/{propertyKey}
-   * @scopes-current write:jira-work
-   * @scopes-beta delete:user.property:jira
-   */
-  deleteUserProperty({
-    propertyKey,
-    accountId,
-    userKey,
-    username,
-  }: {
-    /** The key of the user's property. */
-    propertyKey: string;
-    /**
-     * The account ID of the user, which uniquely identifies the user across all
-     * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
-     */
-    accountId?: string;
-    /**
-     * This parameter is no longer available and will be removed from the
-     * documentation soon. See the [deprecation
-     * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
-     * for details.
-     */
-    userKey?: string;
-    /**
-     * This parameter is no longer available and will be removed from the
-     * documentation soon. See the [deprecation
-     * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
-     * for details.
-     */
-    username?: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/user/properties/{propertyKey}",
-        method: "DELETE",
-        pathParams: {
-          propertyKey,
-        },
-        query: {
-          accountId,
-          userKey,
-          username,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Returns the value of a user's property. If no property key is provided [Get
-   * user property keys](#api-rest-api-3-user-properties-get) is called.
-   *
-   * Note: This operation does not access the [user
-   * properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in
-   * Jira.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg), to get a property from
-   * any user.
-   *  *  Access to Jira, to get a property from the calling user's record.
-   *
-   * @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/user/properties/{propertyKey}
-   * @scopes-current read:jira-user
-   * @scopes-beta read:user.property:jira
-   */
-  getUserProperty({
-    propertyKey,
-    accountId,
-    userKey,
-    username,
-  }: {
-    /** The key of the user's property. */
-    propertyKey: string;
-    /**
-     * The account ID of the user, which uniquely identifies the user across all
-     * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
-     */
-    accountId?: string;
-    /**
-     * This parameter is no longer available and will be removed from the
-     * documentation soon. See the [deprecation
-     * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
-     * for details.
-     */
-    userKey?: string;
-    /**
-     * This parameter is no longer available and will be removed from the
-     * documentation soon. See the [deprecation
-     * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
-     * for details.
-     */
-    username?: string;
-  }): Promise<EntityProperty> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/user/properties/{propertyKey}",
-        method: "GET",
-        pathParams: {
-          propertyKey,
-        },
-        query: {
-          accountId,
-          userKey,
-          username,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: EntityProperty;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "UserPropertiesService.getUserProperty.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns the keys of all properties for a user.
-   *
-   * Note: This operation does not access the [user
-   * properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in
-   * Jira.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg), to access the property
-   * keys on any user.
-   *  *  Access to Jira, to access the calling user's property keys.
-   *
-   * @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/user/properties
-   * @scopes-current read:jira-user
-   * @scopes-beta read:user.property:jira
-   */
-  getUserPropertyKeys({
-    accountId,
-    userKey,
-    username,
-  }: {
-    /**
-     * The account ID of the user, which uniquely identifies the user across all
-     * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
-     */
-    accountId?: string;
-    /**
-     * This parameter is no longer available and will be removed from the
-     * documentation soon. See the [deprecation
-     * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
-     * for details.
-     */
-    userKey?: string;
-    /**
-     * This parameter is no longer available and will be removed from the
-     * documentation soon. See the [deprecation
-     * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
-     * for details.
-     */
-    username?: string;
-  }): Promise<PropertyKeys> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/user/properties",
-        method: "GET",
-        query: {
-          accountId,
-          userKey,
-          username,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: PropertyKeys;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "UserPropertiesService.getUserPropertyKeys.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Sets the value of a user's property. Use this resource to store custom data
-   * against a user.
-   *
-   * Note: This operation does not access the [user
-   * properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in
-   * Jira.
-   *
-   * **[Permissions](#permissions) required:**
-   *
-   *  *  *Administer Jira* [global
-   * permission](https://confluence.atlassian.com/x/x4dKLg), to set a property on
-   * any user.
-   *  *  Access to Jira, to set a property on the calling user's record.
-   *
-   * @returns * status: 200, mediaType: application/json
-   *
-   *    Returned if the user property is updated.
-   *
-   *  * status: 201, mediaType: application/json
-   *
-   *    Returned if the user property is created.
-   * @path {PUT} /rest/api/3/user/properties/{propertyKey}
-   * @scopes-current write:jira-work
-   * @scopes-beta write:user.property:jira
-   */
-  setUserProperty({
-    propertyKey,
-    accountId,
-    userKey,
-    username,
-    requestBody,
-  }: {
-    /** The key of the user's property. The maximum length is 255 characters. */
-    propertyKey: string;
-    /**
-     * The account ID of the user, which uniquely identifies the user across all
-     * Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.
-     */
-    accountId?: string;
-    /**
-     * This parameter is no longer available and will be removed from the
-     * documentation soon. See the [deprecation
-     * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
-     * for details.
-     */
-    userKey?: string;
-    /**
-     * This parameter is no longer available and will be removed from the
-     * documentation soon. See the [deprecation
-     * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/)
-     * for details.
-     */
-    username?: 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/user/properties/{propertyKey}",
-        method: "PUT",
-        pathParams: {
-          propertyKey,
-        },
-        query: {
-          accountId,
-          userKey,
-          username,
-        },
-        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(
-          "UserPropertiesService.setUserProperty.response",
-        ),
-      )
-      .then(commonHttpClient.asCreatedResponse("body"));
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "UserPropertiesService.getUserPropertyKeys.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("PropertyKeys"),
-        })
-        .describe("UserPropertiesService.getUserPropertyKeys.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "UserPropertiesService.getUserProperty.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("EntityProperty"),
-        })
-        .describe("UserPropertiesService.getUserProperty.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "UserPropertiesService.setUserProperty.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("UserPropertiesService.setUserProperty.response"),
-    );
-    validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
-  }
-}