@esm-js/jira.js/src/version3/myself.ts

A comprehensive JavaScript/TypeScript library designed for both Node.JS and browsers, facilitating seamless interaction with the Atlassian Jira API.

import type * as Models from './models';
import type * as Parameters from './parameters';
import type { Client } from '../clients';
import type { Callback } from '../callback';
import type { RequestConfig } from '../requestConfig';

export class Myself {
  constructor(private client: Client) {}

  /**
   * 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](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
   * Permission to access Jira.
   */
  async getPreference<T = string>(parameters: Parameters.GetPreference, callback: Callback<T>): Promise<void>;
  /**
   * 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](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
   * Permission to access Jira.
   */
  async getPreference<T = string>(parameters: Parameters.GetPreference, callback?: never): Promise<T>;
  async getPreference<T = string>(parameters: Parameters.GetPreference, callback?: Callback<T>): Promise<void | T> {
    const config: RequestConfig = {
      url: '/rest/api/3/mypreferences',
      method: 'GET',
      params: {
        key: parameters.key,
      },
    };

    return this.client.sendRequest(config, callback);
  }

  /**
   * 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](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
   * Permission to access Jira.
   */
  async setPreference<T = void>(parameters: Parameters.SetPreference, callback: Callback<T>): Promise<void>;
  /**
   * 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](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
   * Permission to access Jira.
   */
  async setPreference<T = void>(parameters: Parameters.SetPreference, callback?: never): Promise<T>;
  async setPreference<T = void>(parameters: Parameters.SetPreference, callback?: Callback<T>): Promise<void | T> {
    const config: RequestConfig = {
      url: '/rest/api/3/mypreferences',
      method: 'PUT',
      params: {
        key: parameters.key,
      },
    };

    return this.client.sendRequest(config, callback);
  }

  /**
   * 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](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
   * Permission to access Jira.
   */
  async removePreference<T = void>(parameters: Parameters.RemovePreference, callback: Callback<T>): Promise<void>;
  /**
   * 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](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
   * Permission to access Jira.
   */
  async removePreference<T = void>(parameters: Parameters.RemovePreference, callback?: never): Promise<T>;
  async removePreference<T = void>(parameters: Parameters.RemovePreference, callback?: Callback<T>): Promise<void | T> {
    const config: RequestConfig = {
      url: '/rest/api/3/mypreferences',
      method: 'DELETE',
      params: {
        key: parameters.key,
      },
    };

    return this.client.sendRequest(config, callback);
  }

  /**
   * 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](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** None.
   */
  async getLocale<T = Models.Locale>(callback: Callback<T>): Promise<void>;
  /**
   * 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](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** None.
   */
  async getLocale<T = Models.Locale>(callback?: never): Promise<T>;
  async getLocale<T = Models.Locale>(callback?: Callback<T>): Promise<void | T> {
    const config: RequestConfig = {
      url: '/rest/api/3/mypreferences/locale',
      method: 'GET',
    };

    return this.client.sendRequest(config, callback);
  }

  /**
   * Returns details for the current user.
   *
   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
   * Permission to access Jira.
   */
  async getCurrentUser<T = Models.User>(
    parameters: Parameters.GetCurrentUser | undefined,
    callback: Callback<T>,
  ): Promise<void>;
  /**
   * Returns details for the current user.
   *
   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:**
   * Permission to access Jira.
   */
  async getCurrentUser<T = Models.User>(parameters?: Parameters.GetCurrentUser, callback?: never): Promise<T>;
  async getCurrentUser<T = Models.User>(
    parameters?: Parameters.GetCurrentUser,
    callback?: Callback<T>,
  ): Promise<void | T> {
    const config: RequestConfig = {
      url: '/rest/api/3/myself',
      method: 'GET',
      params: {
        expand: parameters?.expand,
      },
    };

    return this.client.sendRequest(config, callback);
  }
}