@esm-js/jira.js

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 JiraSettings { constructor(private client: Client) {} /** * Returns all application properties or an application property. * * If you specify a value for the `key` parameter, then an application property is returned as an object (not in an * array). Otherwise, an array of all editable application properties is returned. See [Set application * property](#api-rest-api-3-application-properties-id-put) for descriptions of editable properties. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async getApplicationProperty<T = Models.ApplicationProperty[]>( parameters: Parameters.GetApplicationProperty | undefined, callback: Callback<T>, ): Promise<void>; /** * Returns all application properties or an application property. * * If you specify a value for the `key` parameter, then an application property is returned as an object (not in an * array). Otherwise, an array of all editable application properties is returned. See [Set application * property](#api-rest-api-3-application-properties-id-put) for descriptions of editable properties. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async getApplicationProperty<T = Models.ApplicationProperty[]>( parameters?: Parameters.GetApplicationProperty, callback?: never, ): Promise<T>; async getApplicationProperty<T = Models.ApplicationProperty[]>( parameters?: Parameters.GetApplicationProperty, callback?: Callback<T>, ): Promise<void | T> { const config: RequestConfig = { url: '/rest/api/3/application-properties', method: 'GET', params: { key: parameters?.key, permissionLevel: parameters?.permissionLevel, keyFilter: parameters?.keyFilter, }, }; return this.client.sendRequest(config, callback); } /** * Returns the application properties that are accessible on the _Advanced Settings_ page. To navigate to the * _Advanced Settings_ page in Jira, choose the Jira icon > **Jira settings** > **System**, **General Configuration** * and then click **Advanced Settings** (in the upper right). * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async getAdvancedSettings<T = Models.ApplicationProperty[]>(callback: Callback<T>): Promise<void>; /** * Returns the application properties that are accessible on the _Advanced Settings_ page. To navigate to the * _Advanced Settings_ page in Jira, choose the Jira icon > **Jira settings** > **System**, **General Configuration** * and then click **Advanced Settings** (in the upper right). * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async getAdvancedSettings<T = Models.ApplicationProperty[]>(callback?: never): Promise<T>; async getAdvancedSettings<T = Models.ApplicationProperty[]>(callback?: Callback<T>): Promise<void | T> { const config: RequestConfig = { url: '/rest/api/3/application-properties/advanced-settings', method: 'GET', }; return this.client.sendRequest(config, callback); } /** * Changes the value of an application property. For example, you can change the value of the `jira.clone.prefix` from * its default value of _CLONE -_ to _Clone -_ if you prefer sentence case capitalization. Editable properties are * described below along with their default values. * * #### Advanced settings * * The advanced settings below are also accessible in [Jira](https://confluence.atlassian.com/x/vYXKM). * * | Key | Description | Default value | * | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | * | `jira.clone.prefix` | The string of text prefixed to the title of a cloned issue. | `CLONE -` | * | `jira.date.picker.java.format` | The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting. | `d/MMM/yy` | * | `jira.date.picker.javascript.format` | The date format for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting. | `%e/%b/%y` | * | `jira.date.time.picker.java.format` | The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting. | `dd/MMM/yy h:mm a` | * | `jira.date.time.picker.javascript.format` | The date format for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting. | `%e/%b/%y %I:%M %p` | * | `jira.issue.actions.order` | The default order of actions (such as _Comments_ or _Change history_) displayed on the issue view. | `asc` | * | `jira.view.issue.links.sort.order` | The sort order of the list of issue links on the issue view. | `type, status, priority` | * | `jira.comment.collapsing.minimum.hidden` | The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing. | `4` | * | `jira.newsletter.tip.delay.days` | The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this feature. | `7` | * * #### Look and feel * * The settings listed below adjust the [look and feel](https://confluence.atlassian.com/x/VwCLLg). * * | Key | Description | Default value | * | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ---------------------------- | * | `jira.lf.date.time` | The [ time format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html). | `h:mm a` | * | `jira.lf.date.day` | The [ day format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html). | `EEEE h:mm a` | * | `jira.lf.date.complete` | The [ date and time format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html). | `dd/MMM/yy h:mm a` | * | `jira.lf.date.dmy` | The [ date format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html). | `dd/MMM/yy` | * | `jira.date.time.picker.use.iso8061` | When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard. | `false` | * | `jira.lf.logo.url` | The URL of the logo image file. | `/images/icon-jira-logo.png` | * | `jira.lf.logo.show.application.title` | Controls the visibility of the application title on the sidebar. | `false` | * | `jira.lf.favicon.url` | The URL of the favicon. | `/favicon.ico` | * | `jira.lf.favicon.hires.url` | The URL of the high-resolution favicon. | `/images/64jira.png` | * | `jira.lf.navigation.bgcolour` | The background color of the sidebar. | `#0747A6` | * | `jira.lf.navigation.highlightcolour` | The color of the text and logo of the sidebar. | `#DEEBFF` | * | `jira.lf.hero.button.base.bg.colour` | The background color of the hero button. | `#3b7fc4` | * | `jira.title` | The text for the application title. The application title can also be set in _General settings_. | `Jira` | * | `jira.option.globalsharing` | Whether filters and dashboards can be shared with anyone signed into Jira. | `true` | * | `xflow.product.suggestions.enabled` | Whether to expose product suggestions for other Atlassian products within Jira. | `true` | * * #### Other settings * * | Key | Description | Default value | * | ----------------------------------- | ----------------------------------------------------- | ------------- | * | `jira.issuenav.criteria.autoupdate` | Whether instant updates to search criteria is active. | `true` | * * _Note: Be careful when changing [application properties and advanced * settings](https://confluence.atlassian.com/x/vYXKM)._ * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async setApplicationProperty<T = Models.ApplicationProperty>( parameters: Parameters.SetApplicationProperty, callback: Callback<T>, ): Promise<void>; /** * Changes the value of an application property. For example, you can change the value of the `jira.clone.prefix` from * its default value of _CLONE -_ to _Clone -_ if you prefer sentence case capitalization. Editable properties are * described below along with their default values. * * #### Advanced settings * * The advanced settings below are also accessible in [Jira](https://confluence.atlassian.com/x/vYXKM). * * | Key | Description | Default value | * | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ | * | `jira.clone.prefix` | The string of text prefixed to the title of a cloned issue. | `CLONE -` | * | `jira.date.picker.java.format` | The date format for the Java (server-side) generated dates. This must be the same as the `jira.date.picker.javascript.format` format setting. | `d/MMM/yy` | * | `jira.date.picker.javascript.format` | The date format for the JavaScript (client-side) generated dates. This must be the same as the `jira.date.picker.java.format` format setting. | `%e/%b/%y` | * | `jira.date.time.picker.java.format` | The date format for the Java (server-side) generated date times. This must be the same as the `jira.date.time.picker.javascript.format` format setting. | `dd/MMM/yy h:mm a` | * | `jira.date.time.picker.javascript.format` | The date format for the JavaScript (client-side) generated date times. This must be the same as the `jira.date.time.picker.java.format` format setting. | `%e/%b/%y %I:%M %p` | * | `jira.issue.actions.order` | The default order of actions (such as _Comments_ or _Change history_) displayed on the issue view. | `asc` | * | `jira.view.issue.links.sort.order` | The sort order of the list of issue links on the issue view. | `type, status, priority` | * | `jira.comment.collapsing.minimum.hidden` | The minimum number of comments required for comment collapsing to occur. A value of `0` disables comment collapsing. | `4` | * | `jira.newsletter.tip.delay.days` | The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of `-1` disables this feature. | `7` | * * #### Look and feel * * The settings listed below adjust the [look and feel](https://confluence.atlassian.com/x/VwCLLg). * * | Key | Description | Default value | * | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | ---------------------------- | * | `jira.lf.date.time` | The [ time format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html). | `h:mm a` | * | `jira.lf.date.day` | The [ day format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html). | `EEEE h:mm a` | * | `jira.lf.date.complete` | The [ date and time format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html). | `dd/MMM/yy h:mm a` | * | `jira.lf.date.dmy` | The [ date format](https://docs.oracle.com/javase/6/docs/api/index.html?java/text/SimpleDateFormat.html). | `dd/MMM/yy` | * | `jira.date.time.picker.use.iso8061` | When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard. | `false` | * | `jira.lf.logo.url` | The URL of the logo image file. | `/images/icon-jira-logo.png` | * | `jira.lf.logo.show.application.title` | Controls the visibility of the application title on the sidebar. | `false` | * | `jira.lf.favicon.url` | The URL of the favicon. | `/favicon.ico` | * | `jira.lf.favicon.hires.url` | The URL of the high-resolution favicon. | `/images/64jira.png` | * | `jira.lf.navigation.bgcolour` | The background color of the sidebar. | `#0747A6` | * | `jira.lf.navigation.highlightcolour` | The color of the text and logo of the sidebar. | `#DEEBFF` | * | `jira.lf.hero.button.base.bg.colour` | The background color of the hero button. | `#3b7fc4` | * | `jira.title` | The text for the application title. The application title can also be set in _General settings_. | `Jira` | * | `jira.option.globalsharing` | Whether filters and dashboards can be shared with anyone signed into Jira. | `true` | * | `xflow.product.suggestions.enabled` | Whether to expose product suggestions for other Atlassian products within Jira. | `true` | * * #### Other settings * * | Key | Description | Default value | * | ----------------------------------- | ----------------------------------------------------- | ------------- | * | `jira.issuenav.criteria.autoupdate` | Whether instant updates to search criteria is active. | `true` | * * _Note: Be careful when changing [application properties and advanced * settings](https://confluence.atlassian.com/x/vYXKM)._ * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async setApplicationProperty<T = Models.ApplicationProperty>( parameters: Parameters.SetApplicationProperty, callback?: never, ): Promise<T>; async setApplicationProperty<T = Models.ApplicationProperty>( parameters: Parameters.SetApplicationProperty, callback?: Callback<T>, ): Promise<void | T> { const config: RequestConfig = { url: `/rest/api/3/application-properties/${parameters.id}`, method: 'PUT', data: parameters.body, }; return this.client.sendRequest(config, callback); } /** * Returns the [global settings](https://confluence.atlassian.com/x/qYXKM) in Jira. These settings determine whether * optional features (for example, subtasks, time tracking, and others) are enabled. If time tracking is enabled, this * operation also returns the time tracking configuration. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** * Permission to access Jira. */ async getConfiguration<T = Models.Configuration>(callback: Callback<T>): Promise<void>; /** * Returns the [global settings](https://confluence.atlassian.com/x/qYXKM) in Jira. These settings determine whether * optional features (for example, subtasks, time tracking, and others) are enabled. If time tracking is enabled, this * operation also returns the time tracking configuration. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** * Permission to access Jira. */ async getConfiguration<T = Models.Configuration>(callback?: never): Promise<T>; async getConfiguration<T = Models.Configuration>(callback?: Callback<T>): Promise<void | T> { const config: RequestConfig = { url: '/rest/api/3/configuration', method: 'GET', }; return this.client.sendRequest(config, callback); } }