|
| 1 | +import * as Models from './models'; |
| 2 | +import * as Parameters from './parameters'; |
| 3 | +import { Client } from '../clients'; |
| 4 | +import { Callback } from '../callback'; |
| 5 | +import { RequestConfig } from '../requestConfig'; |
| 6 | + |
| 7 | +export class IssueCustomFieldConfigurationApps { |
| 8 | + constructor(private client: Client) {} |
| 9 | + |
| 10 | + /** |
| 11 | + * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#pagination) list of configurations for a custom field. The result can be filtered by |
| 12 | + * `contextId` or `issueId`, otherwise all configurations are returned. Invalid IDs are ignored. |
| 13 | + * |
| 14 | + * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** *Administer Jira* [global |
| 15 | + * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app that created |
| 16 | + * the custom field. |
| 17 | + */ |
| 18 | + async getCustomFieldConfiguration<T = Models.PageContextualConfiguration>( |
| 19 | + parameters: Parameters.GetCustomFieldConfiguration, |
| 20 | + callback: Callback<T> |
| 21 | + ): Promise<void>; |
| 22 | + /** |
| 23 | + * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#pagination) list of configurations for a custom field. The result can be filtered by |
| 24 | + * `contextId` or `issueId`, otherwise all configurations are returned. Invalid IDs are ignored. |
| 25 | + * |
| 26 | + * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** *Administer Jira* [global |
| 27 | + * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app that created |
| 28 | + * the custom field. |
| 29 | + */ |
| 30 | + async getCustomFieldConfiguration<T = Models.PageContextualConfiguration>( |
| 31 | + parameters: Parameters.GetCustomFieldConfiguration, |
| 32 | + callback?: never |
| 33 | + ): Promise<T>; |
| 34 | + async getCustomFieldConfiguration<T = Models.PageContextualConfiguration>( |
| 35 | + parameters: Parameters.GetCustomFieldConfiguration, |
| 36 | + callback?: Callback<T>, |
| 37 | + ): Promise<void | T> { |
| 38 | + const config: RequestConfig = { |
| 39 | + url: `/rest/api/2/app/field/${parameters.fieldIdOrKey}/context/configuration`, |
| 40 | + method: 'GET', |
| 41 | + params: { |
| 42 | + contextId: parameters.contextId, |
| 43 | + issueId: parameters.issueId, |
| 44 | + startAt: parameters.startAt, |
| 45 | + maxResults: parameters.maxResults, |
| 46 | + }, |
| 47 | + }; |
| 48 | + |
| 49 | + return this.client.sendRequest(config, callback, { |
| 50 | + methodName: 'version2.issueCustomFieldConfigurationApps.getCustomFieldConfiguration', |
| 51 | + }); |
| 52 | + } |
| 53 | + |
| 54 | + /** |
| 55 | + * Update the configuration for contexts of a custom field. |
| 56 | + * |
| 57 | + * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** *Administer Jira* [global |
| 58 | + * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app that created |
| 59 | + * the custom field. |
| 60 | + */ |
| 61 | + async updateCustomFieldConfiguration<T = unknown>( |
| 62 | + parameters: Parameters.UpdateCustomFieldConfiguration, |
| 63 | + callback: Callback<T> |
| 64 | + ): Promise<void>; |
| 65 | + /** |
| 66 | + * Update the configuration for contexts of a custom field. |
| 67 | + * |
| 68 | + * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** *Administer Jira* [global |
| 69 | + * permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the app that created |
| 70 | + * the custom field. |
| 71 | + */ |
| 72 | + async updateCustomFieldConfiguration<T = unknown>( |
| 73 | + parameters: Parameters.UpdateCustomFieldConfiguration, |
| 74 | + callback?: never |
| 75 | + ): Promise<T>; |
| 76 | + async updateCustomFieldConfiguration<T = unknown>( |
| 77 | + parameters: Parameters.UpdateCustomFieldConfiguration, |
| 78 | + callback?: Callback<T>, |
| 79 | + ): Promise<void | T> { |
| 80 | + const config: RequestConfig = { |
| 81 | + url: `/rest/api/2/app/field/${parameters.fieldIdOrKey}/context/configuration`, |
| 82 | + method: 'PUT', |
| 83 | + data: { |
| 84 | + configurations: parameters.configurations, |
| 85 | + }, |
| 86 | + }; |
| 87 | + |
| 88 | + return this.client.sendRequest(config, callback, { |
| 89 | + methodName: 'version2.issueCustomFieldConfigurationApps.updateCustomFieldConfiguration', |
| 90 | + }); |
| 91 | + } |
| 92 | +} |
0 commit comments