/** * The Jira Cloud platform REST API * Jira Cloud platform REST API documentation * * The version of the OpenAPI document: 1001.0.0-SNAPSHOT * Contact: ecosystem@atlassian.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { Locale, User } from '../models'; export interface GetCurrentUserRequest { expand?: string; } export interface GetPreferenceRequest { key: string; } export interface RemovePreferenceRequest { key: string; } export interface SetLocaleRequest { Locale: Locale; } export interface SetPreferenceRequest { key: string; body: string; } /** * no description */ export declare class MyselfApi extends runtime.BaseAPI { /** * Deletes the locale of the user, which restores the default setting. **[Permissions](#permissions) required:** Permission to access Jira. * Delete locale */ deleteLocaleRaw(): Promise>; /** * Deletes the locale of the user, which restores the default setting. **[Permissions](#permissions) required:** Permission to access Jira. * Delete locale */ deleteLocale(): Promise; /** * Returns details for the current user. **[Permissions](#permissions) required:** Permission to access Jira. * Get current user */ getCurrentUserRaw(requestParameters: GetCurrentUserRequest): Promise>; /** * Returns details for the current user. **[Permissions](#permissions) required:** Permission to access Jira. * Get current user */ getCurrentUser(requestParameters: GetCurrentUserRequest): Promise; /** * 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. * Get locale */ getLocaleRaw(): Promise>; /** * 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. * Get locale */ getLocale(): Promise; /** * Returns the value of a preference of the current user. **[Permissions](#permissions) required:** Permission to access Jira. * Get preference */ getPreferenceRaw(requestParameters: GetPreferenceRequest): Promise>; /** * Returns the value of a preference of the current user. **[Permissions](#permissions) required:** Permission to access Jira. * Get preference */ getPreference(requestParameters: GetPreferenceRequest): Promise; /** * Deletes a preference of the user, which restores the default value of system defined settings. **[Permissions](#permissions) required:** Permission to access Jira. * Delete preference */ removePreferenceRaw(requestParameters: RemovePreferenceRequest): Promise>; /** * Deletes a preference of the user, which restores the default value of system defined settings. **[Permissions](#permissions) required:** Permission to access Jira. * Delete preference */ removePreference(requestParameters: RemovePreferenceRequest): Promise; /** * Sets the locale of the user. The locale must be one supported by the instance of Jira. **[Permissions](#permissions) required:** Permission to access Jira. * Set locale */ setLocaleRaw(requestParameters: SetLocaleRequest): Promise>; /** * Sets the locale of the user. The locale must be one supported by the instance of Jira. **[Permissions](#permissions) required:** Permission to access Jira. * Set locale */ setLocale(requestParameters: SetLocaleRequest): Promise; /** * 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.notify.own.changes* Indicates whether the user gets notified of their own changes. Defaults to `false`. * *jira.user.locale* The locale of the user. By default, not set: the user takes the instance locale. See also, [Set locale](#api-rest-api-3-mypreferences-locale-put). * *jira.user.timezone* The time zone of the user. By default, not set, the user takes the instance time zone. * *user.default.share.private* Indicates whether new [ filters](https://confluence.atlassian.com/x/eQiiLQ) are set to private. Defaults to `true`. * *user.keyboard.shortcuts.disabled* Indicates whether keyboard shortcuts are disabled. Defaults to `false`. * *user.autowatch.disabled* Indicates whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting. **[Permissions](#permissions) required:** Permission to access Jira. * Set preference */ setPreferenceRaw(requestParameters: SetPreferenceRequest): Promise>; /** * 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.notify.own.changes* Indicates whether the user gets notified of their own changes. Defaults to `false`. * *jira.user.locale* The locale of the user. By default, not set: the user takes the instance locale. See also, [Set locale](#api-rest-api-3-mypreferences-locale-put). * *jira.user.timezone* The time zone of the user. By default, not set, the user takes the instance time zone. * *user.default.share.private* Indicates whether new [ filters](https://confluence.atlassian.com/x/eQiiLQ) are set to private. Defaults to `true`. * *user.keyboard.shortcuts.disabled* Indicates whether keyboard shortcuts are disabled. Defaults to `false`. * *user.autowatch.disabled* Indicates whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting. **[Permissions](#permissions) required:** Permission to access Jira. * Set preference */ setPreference(requestParameters: SetPreferenceRequest): Promise; }