@resolution/jira-api-client 0.1.0 → 0.1.2

package/src/openapi/platform/services/myself-service.ts

@@ -1,520 +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 { registerCommonValidationSchemas, type User } from "../models/common";
-import { type Locale, registerMyselfValidationSchemas } from "../models/myself";
-import { validationSchemaStorage } from "../validation-schema-storage";
-/**
- * This resource represents information about the current user, such as basic
- * details, group membership, application roles, preferences, and locale. Use it
- * to get, create, update, and delete (restore default) values of the user's
- * preferences and locale.
- */
-export class MyselfService extends CommonHttpService {
-  /**
-   * Deprecated, use [ Update a user
-   * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch)
-   * from the user management REST API instead.
-   *
-   * Deletes the locale of the user, which restores the default setting.
-   *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
-   *
-   * @deprecated
-   * @returns Returned if the request is successful.
-   * @path {DELETE} /rest/api/3/mypreferences/locale
-   */
-  deleteLocale(): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/mypreferences/locale",
-        method: "DELETE",
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "MyselfService.deleteLocale.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns details for the current user.
-   *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "accountId": "5b10a2844c20165700ede21g",
-   *   "accountType": "atlassian",
-   *   "active": true,
-   *   "applicationRoles": {
-   *     "items": [],
-   *     "size": 1
-   *   },
-   *   "avatarUrls": {
-   *     "16x16":
-   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-   *     "24x24":
-   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-   *     "32x32":
-   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-   *     "48x48":
-   * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
-   *   },
-   *   "displayName": "Mia Krystof",
-   *   "emailAddress": "mia@example.com",
-   *   "groups": {
-   *     "items": [],
-   *     "size": 3
-   *   },
-   *   "key": "",
-   *   "name": "",
-   *   "self":
-   * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
-   *   "timeZone": "Australia/Sydney"
-   * }
-   * @path {GET} /rest/api/3/myself
-   * @scopes-current read:jira-user
-   * @scopes-beta read:application-role:jira, read:group:jira, read:user:jira, read:avatar:jira
-   */
-  getCurrentUser({
-    expand,
-  }: {
-    /**
-     * Use [expand](#expansion) to include additional information about user in the
-     * response. This parameter accepts a comma-separated list. Expand options include:
-     *
-     *  *  `groups` Returns all groups, including nested groups, the user belongs to.
-     *  *  `applicationRoles` Returns the application roles the user is assigned to.
-     */
-    expand?: string;
-  }): Promise<User> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/myself",
-        method: "GET",
-        query: {
-          expand,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: User;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "MyselfService.getCurrentUser.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns the locale for the user.
-   *
-   * If the user has no language preference set (which is the default setting) or
-   * this resource is accessed anonymous, the browser locale detected by Jira is
-   * returned. Jira detects the browser locale using the *Accept-Language* header in
-   * the request. However, if this doesn't match a locale available Jira, the site
-   * default locale is returned.
-   *
-   * This operation can be accessed anonymously.
-   *
-   * **[Permissions](#permissions) required:** None.
-   *
-   * @returns Returned if the request is successful.
-   *
-   * example: {
-   *   "locale": "en_US"
-   * }
-   * @path {GET} /rest/api/3/mypreferences/locale
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta read:user-configuration:jira
-   */
-  getLocale(): Promise<Locale> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/mypreferences/locale",
-        method: "GET",
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: Locale;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator("MyselfService.getLocale.response"),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Returns the value of a preference of the current user.
-   *
-   * Note that these keys are deprecated:
-   *
-   *  *  *jira.user.locale* The locale of the user. By default this is not set and
-   * the user takes the locale of the instance.
-   *  *  *jira.user.timezone* The time zone of the user. By default this is not set
-   * and the user takes the timezone of the instance.
-   *
-   * These system preferences keys will be deprecated by 15/07/2024. You can still
-   * retrieve these keys, but it will not have any impact on Notification behaviour.
-   *
-   *  *  *user.notifications.watcher* Whether the user gets notified when they are
-   * watcher.
-   *  *  *user.notifications.assignee* Whether the user gets notified when they are
-   * assignee.
-   *  *  *user.notifications.reporter* Whether the user gets notified when they are
-   * reporter.
-   *  *  *user.notifications.mentions* Whether the user gets notified when they are
-   * mentions.
-   *
-   * Use [ Update a user
-   * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch)
-   * from the user management REST API to manage timezone and locale instead.
-   *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
-   *
-   * @returns Returned if the request is successful.
-   * @path {GET} /rest/api/3/mypreferences
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta read:user-configuration:jira
-   */
-  getPreference({
-    key,
-  }: {
-    /** The key of the preference. */
-    key: string;
-  }): Promise<string> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/mypreferences",
-        method: "GET",
-        query: {
-          key,
-        },
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          200: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 200;
-          mediaType: "application/json";
-          body: string;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "MyselfService.getPreference.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Deletes a preference of the user, which restores the default value of system
-   * defined settings.
-   *
-   * Note that these keys are deprecated:
-   *
-   *  *  *jira.user.locale* The locale of the user. By default, not set. The user
-   * takes the instance locale.
-   *  *  *jira.user.timezone* The time zone of the user. By default, not set. The
-   * user takes the instance timezone.
-   *
-   * Use [ Update a user
-   * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch)
-   * from the user management REST API to manage timezone and locale instead.
-   *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
-   *
-   * @path {DELETE} /rest/api/3/mypreferences
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta delete:user-configuration:jira
-   */
-  removePreference({
-    key,
-  }: {
-    /** The key of the preference. */
-    key: string;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/mypreferences",
-        method: "DELETE",
-        query: {
-          key,
-        },
-      })
-      .then(commonHttpClient.discardResult);
-  }
-  /**
-   * Deprecated, use [ Update a user
-   * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch)
-   * from the user management REST API instead.
-   *
-   * Sets the locale of the user. The locale must be one supported by the instance
-   * of Jira.
-   *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
-   *
-   * @deprecated
-   * @returns Returned if the request is successful.
-   * @path {PUT} /rest/api/3/mypreferences/locale
-   */
-  setLocale({
-    locale,
-  }: {
-    /**
-     * The locale defined in a LocaleBean.
-     *
-     * @example {
-     *     "locale": "en_US"
-     * }
-     */
-    locale: Locale;
-  }): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/mypreferences/locale",
-        method: "PUT",
-        headers: {
-          "Content-Type": "application/json",
-        },
-        body: locale,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator("MyselfService.setLocale.response"),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  /**
-   * Creates a preference for the user or updates a preference's value by sending a
-   * plain text string. For example, `false`. An arbitrary preference can be created
-   * with the value containing up to 255 characters. In addition, the following keys
-   * define system preferences that can be set or created:
-   *
-   *  *  *user.notifications.mimetype* The mime type used in notifications sent to
-   * the user. Defaults to `html`.
-   *  *  *user.default.share.private* Whether new [
-   * filters](https://confluence.atlassian.com/x/eQiiLQ) are set to private.
-   * Defaults to `true`.
-   *  *  *user.keyboard.shortcuts.disabled* Whether keyboard shortcuts are disabled.
-   * Defaults to `false`.
-   *  *  *user.autowatch.disabled* Whether the user automatically watches issues
-   * they create or add a comment to. By default, not set: the user takes the
-   * instance autowatch setting.
-   *  *  *user.notifiy.own.changes* Whether the user gets notified of their own
-   * changes.
-   *
-   * Note that these keys are deprecated:
-   *
-   *  *  *jira.user.locale* The locale of the user. By default, not set. The user
-   * takes the instance locale.
-   *  *  *jira.user.timezone* The time zone of the user. By default, not set. The
-   * user takes the instance timezone.
-   *
-   * These system preferences keys will be deprecated by 15/07/2024. You can still
-   * use these keys to create arbitrary preferences, but it will not have any impact
-   * on Notification behaviour.
-   *
-   *  *  *user.notifications.watcher* Whether the user gets notified when they are
-   * watcher.
-   *  *  *user.notifications.assignee* Whether the user gets notified when they are
-   * assignee.
-   *  *  *user.notifications.reporter* Whether the user gets notified when they are
-   * reporter.
-   *  *  *user.notifications.mentions* Whether the user gets notified when they are
-   * mentions.
-   *
-   * Use [ Update a user
-   * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch)
-   * from the user management REST API to manage timezone and locale instead.
-   *
-   * **[Permissions](#permissions) required:** Permission to access Jira.
-   *
-   * @returns Returned if the request is successful.
-   * @path {PUT} /rest/api/3/mypreferences
-   * @scopes-current manage:jira-configuration
-   * @scopes-beta write:user-configuration:jira
-   */
-  setPreference({
-    key,
-    mediaType = "application/json",
-    requestBody,
-  }: {
-    /** The key of the preference. The maximum length is 255 characters. */
-    key: string;
-  } & (
-    | {
-        mediaType?: "application/json";
-        /**
-         * The value of the preference as a plain text string. The maximum length is 255
-         * characters.
-         */
-        requestBody: string;
-      }
-    | {
-        mediaType: "text/plain";
-        /**
-         * The value of the preference as a plain text string. The maximum length is 255
-         * characters.
-         */
-        requestBody: string;
-      }
-  )): Promise<void> {
-    return this.getClientInstance()
-      .request({
-        path: "/rest/api/3/mypreferences",
-        method: "PUT",
-        query: {
-          key,
-        },
-        headers: {
-          "Content-Type": mediaType,
-        },
-        body: requestBody,
-      })
-      .then(
-        this.getClientInstance().responseHandler({
-          204: {
-            "application/json": "json",
-          },
-        }),
-      )
-      .then(
-        commonHttpClient.castResponse<{
-          status: 204;
-          mediaType: "application/json";
-          body: void;
-        }>(),
-      )
-      .then(
-        validationSchemaStorage.validator(
-          "MyselfService.setPreference.response",
-        ),
-      )
-      .then(commonHttpClient.getBody);
-  }
-  static initialize() {
-    validationSchemaStorage.registerExtensible(
-      "MyselfService.getPreference.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: z.string(),
-        })
-        .describe("MyselfService.getPreference.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "MyselfService.setPreference.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("MyselfService.setPreference.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "MyselfService.getLocale.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("Locale"),
-        })
-        .describe("MyselfService.getLocale.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "MyselfService.setLocale.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("MyselfService.setLocale.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "MyselfService.deleteLocale.response",
-      z
-        .object({
-          status: z.literal(204),
-          mediaType: z.literal("application/json"),
-          body: z.unknown(),
-        })
-        .describe("MyselfService.deleteLocale.response"),
-    );
-    validationSchemaStorage.registerExtensible(
-      "MyselfService.getCurrentUser.response",
-      z
-        .object({
-          status: z.literal(200),
-          mediaType: z.literal("application/json"),
-          body: validationSchemaStorage.lazy("User"),
-        })
-        .describe("MyselfService.getCurrentUser.response"),
-    );
-    validationSchemaStorage.registerOnce([
-      registerMyselfValidationSchemas,
-      registerCommonValidationSchemas,
-    ]);
-  }
-}