@esm-js/jira.js
Version:
A comprehensive JavaScript/TypeScript library designed for both Node.JS and browsers, facilitating seamless interaction with the Atlassian Jira API.
122 lines (114 loc) • 5.04 kB
text/typescript
import type * as Parameters from './parameters';
import type { Client } from '../clients';
import type { Callback } from '../callback';
import type { RequestConfig } from '../requestConfig';
export class ProjectClassificationLevels {
constructor(private client: Client) {}
/**
* Returns the default data classification for a project.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
*
* - _Browse Projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* - _Administer projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* - _Administer jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async getDefaultProjectClassification<T = unknown>(
parameters: Parameters.GetDefaultProjectClassification,
callback: Callback<T>,
): Promise<void>;
/**
* Returns the default data classification for a project.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
*
* - _Browse Projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* - _Administer projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* - _Administer jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async getDefaultProjectClassification<T = unknown>(
parameters: Parameters.GetDefaultProjectClassification,
callback?: never,
): Promise<T>;
async getDefaultProjectClassification<T = unknown>(
parameters: Parameters.GetDefaultProjectClassification,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/2/project/${parameters.projectIdOrKey}/classification-level/default`,
method: 'GET',
};
return this.client.sendRequest(config, callback);
}
/**
* Updates the default data classification level for a project.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
*
* - _Administer projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* - _Administer jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async updateDefaultProjectClassification<T = void>(
parameters: Parameters.UpdateDefaultProjectClassification,
callback: Callback<T>,
): Promise<void>;
/**
* Updates the default data classification level for a project.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
*
* - _Administer projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* - _Administer jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async updateDefaultProjectClassification<T = void>(
parameters: Parameters.UpdateDefaultProjectClassification,
callback?: never,
): Promise<T>;
async updateDefaultProjectClassification<T = void>(
parameters: Parameters.UpdateDefaultProjectClassification,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/2/project/${parameters.projectIdOrKey}/classification-level/default`,
method: 'PUT',
data: {
id: parameters.id,
},
};
return this.client.sendRequest(config, callback);
}
/**
* Remove the default data classification level for a project.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
*
* - _Administer projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* - _Administer jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async removeDefaultProjectClassification<T = void>(
parameters: Parameters.RemoveDefaultProjectClassification,
callback: Callback<T>,
): Promise<void>;
/**
* Remove the default data classification level for a project.
*
* **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
*
* - _Administer projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.
* - _Administer jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
*/
async removeDefaultProjectClassification<T = void>(
parameters: Parameters.RemoveDefaultProjectClassification,
callback?: never,
): Promise<T>;
async removeDefaultProjectClassification<T = void>(
parameters: Parameters.RemoveDefaultProjectClassification,
callback?: Callback<T>,
): Promise<void | T> {
const config: RequestConfig = {
url: `/rest/api/2/project/${parameters.projectIdOrKey}/classification-level/default`,
method: 'DELETE',
};
return this.client.sendRequest(config, callback);
}
}