@resolution/jira-api-client 0.4.2 → 0.4.5

package/lib/openapi/platform/services/IssueFieldsService.js

@@ -17,487 +17,490 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
  * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields
  */
 class IssueFieldsService extends CommonHttpService_1.CommonHttpService {
-    /**
-     * Creates a custom field.
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @returns Returned if the custom field is created.
-     *
-     * example: {
-     *   "clauseNames": [
-     *     "cf[10101]",
-     *     "New custom field"
-     *   ],
-     *   "custom": true,
-     *   "id": "customfield_10101",
-     *   "key": "customfield_10101",
-     *   "name": "New custom field",
-     *   "navigable": true,
-     *   "orderable": true,
-     *   "schema": {
-     *     "custom": "com.atlassian.jira.plugin.system.customfieldtypes:project",
-     *     "customId": 10101,
-     *     "type": "project"
-     *   },
-     *   "searchable": true,
-     *   "untranslatedName": "New custom field"
-     * }
-     * @path {POST} /rest/api/3/field
-     * @scopes-current manage:jira-configuration
-     * @scopes-beta write:field:jira, read:avatar:jira, read:field:jira,
-     * read:project-category:jira, read:project:jira, read:field-configuration:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-post
-     */
-    createCustomField({ customFieldDefinitionJsonBean, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/field",
-            method: "POST",
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: customFieldDefinitionJsonBean,
-        })
-            .then(this.getClientInstance().responseHandler({
-            201: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueFieldsService.createCustomField.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Deletes a custom field. The custom field is deleted whether it is in the trash
-     * or not. See [Edit or delete a custom
-     * field](https://confluence.atlassian.com/x/Z44fOw) for more information on
-     * trashing and deleting custom fields.
-     *
-     * This operation is [asynchronous](#async). Follow the `location` link in the
-     * response to determine the status of the task and use [Get
-     * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @path {DELETE} /rest/api/3/field/{id}
-     * @scopes-current manage:jira-configuration
-     * @scopes-beta delete:field:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-id-delete
-     */
-    deleteCustomField({ id, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/field/{id}",
-            method: "DELETE",
-            pathParams: {
-                id,
-            },
-        })
-            .then(commonHttpClient.discardResult);
-    }
-    /**
-     * Returns a [paginated](#pagination) list of the contexts a field is used in.
-     * Deprecated, use [ Get custom field
-     * contexts](#api-rest-api-3-field-fieldId-context-get).
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @deprecated
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "isLast": false,
-     *   "maxResults": 1,
-     *   "startAt": 0,
-     *   "total": 5,
-     *   "values": [
-     *     {
-     *       "id": 10001,
-     *       "name": "Default Context"
-     *     }
-     *   ]
-     * }
-     * @path {GET} /rest/api/3/field/{fieldId}/contexts
-     * @scopes-current manage:jira-project
-     * @scopes-beta read:field:jira, read:avatar:jira, read:project-category:jira, read:project:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-fieldid-contexts-get
-     */
-    getContextsForFieldDeprecated({ fieldId, startAt, maxResults, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/field/{fieldId}/contexts",
-            method: "GET",
-            pathParams: {
-                fieldId,
-            },
-            query: {
-                startAt,
-                maxResults,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueFieldsService.getContextsForFieldDeprecated.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Returns system and custom issue fields according to the following rules:
-     *
-     *  *  Fields that cannot be added to the issue navigator are always returned.
-     *  *  Fields that cannot be placed on an issue screen are always returned.
-     *  *  Fields that depend on global Jira settings are only returned if the setting
-     * is enabled. That is, timetracking fields, subtasks, votes, and watches.
-     *  *  For all other fields, this operation only returns the fields that the user
-     * has permission to view (that is, the field is used in at least one project that
-     * the user has *Browse Projects* [project
-     * permission](https://confluence.atlassian.com/x/yodKLg) for.)
-     *
-     * This operation can be accessed anonymously.
-     *
-     * **[Permissions](#permissions) required:** None.
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: [
-     *   {
-     *     "clauseNames": [
-     *       "description"
-     *     ],
-     *     "custom": false,
-     *     "id": "description",
-     *     "name": "Description",
-     *     "navigable": true,
-     *     "orderable": true,
-     *     "schema": {
-     *       "system": "description",
-     *       "type": "string"
-     *     },
-     *     "searchable": true
-     *   },
-     *   {
-     *     "clauseNames": [
-     *       "summary"
-     *     ],
-     *     "custom": false,
-     *     "id": "summary",
-     *     "key": "summary",
-     *     "name": "Summary",
-     *     "navigable": true,
-     *     "orderable": true,
-     *     "schema": {
-     *       "system": "summary",
-     *       "type": "string"
-     *     },
-     *     "searchable": true
-     *   }
-     * ]
-     * @path {GET} /rest/api/3/field
-     * @scopes-current read:jira-work
-     * @scopes-beta read:field:jira, read:avatar:jira, read:project-category:jira,
-     * read:project:jira, read:field-configuration:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-get
-     */
-    getFields() {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/field",
-            method: "GET",
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueFieldsService.getFields.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Returns a [paginated](#pagination) list of fields for Classic Jira projects.
-     * The list can include:
-     *
-     *  *  all fields
-     *  *  specific fields, by defining `id`
-     *  *  fields that contain a string in the field name or description, by defining
-     * `query`
-     *  *  specific fields that contain a string in the field name or description, by
-     * defining `id` and `query`
-     *
-     * Only custom fields can be queried, `type` must be set to `custom`.
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "isLast": false,
-     *   "maxResults": 50,
-     *   "startAt": 0,
-     *   "total": 2,
-     *   "values": [
-     *     {
-     *       "id": "customfield_10000",
-     *       "name": "Approvers",
-     *       "schema": {
-     *         "custom":
-     * "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker",
-     *         "customId": 10000,
-     *         "items": "user",
-     *         "type": "array"
-     *       },
-     *       "description": "Contains users needed for approval. This custom field was
-     * created by Jira Service Desk.",
-     *       "key": "customfield_10000",
-     *       "stableId": "sfid:approvers",
-     *       "isLocked": true,
-     *       "searcherKey":
-     * "com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher",
-     *       "screensCount": 2,
-     *       "contextsCount": 2,
-     *       "lastUsed": {
-     *         "type": "TRACKED",
-     *         "value": "2021-01-28T07:37:40.000+0000"
-     *       }
-     *     },
-     *     {
-     *       "id": "customfield_10001",
-     *       "name": "Change reason",
-     *       "schema": {
-     *         "custom": "com.atlassian.jira.plugin.system.customfieldtypes:select",
-     *         "customId": 10001,
-     *         "type": "option"
-     *       },
-     *       "description": "Choose the reason for the change request",
-     *       "key": "customfield_10001",
-     *       "stableId": "sfid:change-reason",
-     *       "isLocked": false,
-     *       "searcherKey":
-     * "com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher",
-     *       "screensCount": 2,
-     *       "contextsCount": 2,
-     *       "projectsCount": 2,
-     *       "lastUsed": {
-     *         "type": "NOT_TRACKED"
-     *       }
-     *     }
-     *   ]
-     * }
-     * @path {GET} /rest/api/3/field/search
-     * @scopes-current read:jira-work
-     * @scopes-beta read:field:jira, read:field-configuration:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-search-get
-     */
-    getFieldsPaginated({ startAt, maxResults, type, id, query, orderBy, expand, } = {}) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/field/search",
-            method: "GET",
-            query: {
-                startAt,
-                maxResults,
-                type,
-                id,
-                query,
-                orderBy,
-                expand,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueFieldsService.getFieldsPaginated.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Returns a [paginated](#pagination) list of fields in the trash. The list may be
-     * restricted to fields whose field name or description partially match a string.
-     *
-     * Only custom fields can be queried, `type` must be set to `custom`.
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @returns Returned if the request is successful.
-     *
-     * example: {
-     *   "isLast": false,
-     *   "maxResults": 50,
-     *   "startAt": 0,
-     *   "total": 1,
-     *   "values": [
-     *     {
-     *       "id": "customfield_10000",
-     *       "name": "Approvers",
-     *       "schema": {
-     *         "custom":
-     * "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker",
-     *         "customId": 10003,
-     *         "type": "array"
-     *       },
-     *       "description": "Contains users needed for approval. This custom field was
-     * created by Jira Service Desk.",
-     *       "key": "customfield_10003",
-     *       "trashedDate": "2022-10-06T07:32:47.000+0000",
-     *       "trashedBy": {
-     *         "accountId": "5b10a2844c20165700ede21g",
-     *         "active": true,
-     *         "avatarUrls": {
-     *           "16x16":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-     *           "24x24":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-     *           "32x32":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-     *           "48x48":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
-     *         },
-     *         "displayName": "Mia Krystof",
-     *         "emailAddress": "mia@example.com",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
-     *         "timeZone": "Australia/Sydney"
-     *       },
-     *       "plannedDeletionDate": "2022-10-24T07:32:47.000+0000"
-     *     }
-     *   ]
-     * }
-     * @path {GET} /rest/api/3/field/search/trashed
-     * @scopes-current read:jira-work
-     * @scopes-beta read:field:jira, read:field-configuration:jira, read:user:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-search-trashed-get
-     */
-    getTrashedFieldsPaginated({ startAt, maxResults, id, query, expand, orderBy, } = {}) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/field/search/trashed",
-            method: "GET",
-            query: {
-                startAt,
-                maxResults,
-                id,
-                query,
-                expand,
-                orderBy,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueFieldsService.getTrashedFieldsPaginated.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Restores a custom field from trash. See [Edit or delete a custom
-     * field](https://confluence.atlassian.com/x/Z44fOw) for more information on
-     * trashing and deleting custom fields.
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @returns Returned if the request is successful.
-     * @path {POST} /rest/api/3/field/{id}/restore
-     * @scopes-current manage:jira-configuration
-     * @scopes-beta write:field:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-id-restore-post
-     */
-    restoreCustomField({ id, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/field/{id}/restore",
-            method: "POST",
-            pathParams: {
-                id,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueFieldsService.restoreCustomField.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Moves a custom field to trash. See [Edit or delete a custom
-     * field](https://confluence.atlassian.com/x/Z44fOw) for more information on
-     * trashing and deleting custom fields.
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @returns Returned if the request is successful.
-     * @path {POST} /rest/api/3/field/{id}/trash
-     * @scopes-current manage:jira-configuration
-     * @scopes-beta delete:field:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-id-trash-post
-     */
-    trashCustomField({ id, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/field/{id}/trash",
-            method: "POST",
-            pathParams: {
-                id,
-            },
-        })
-            .then(this.getClientInstance().responseHandler({
-            200: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueFieldsService.trashCustomField.response"))
-            .then(commonHttpClient.getBody);
-    }
-    /**
-     * Updates a custom field.
-     *
-     * **[Permissions](#permissions) required:** *Administer Jira* [global
-     * permission](https://confluence.atlassian.com/x/x4dKLg).
-     *
-     * @returns Returned if the request is successful.
-     * @path {PUT} /rest/api/3/field/{fieldId}
-     * @scopes-current manage:jira-configuration
-     * @scopes-beta write:field:jira
-     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-fieldid-put
-     */
-    updateCustomField({ fieldId, updateCustomFieldDetails, }) {
-        return this.getClientInstance()
-            .request({
-            path: "/rest/api/3/field/{fieldId}",
-            method: "PUT",
-            pathParams: {
-                fieldId,
-            },
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: updateCustomFieldDetails,
-        })
-            .then(this.getClientInstance().responseHandler({
-            204: {
-                "application/json": "json",
-            },
-        }))
-            .then(commonHttpClient.castResponse())
-            .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueFieldsService.updateCustomField.response"))
-            .then(commonHttpClient.getBody);
+    constructor() {
+        super(...arguments);
+        /**
+         * Creates a custom field.
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @returns Returned if the custom field is created.
+         *
+         * example: {
+         *   "clauseNames": [
+         *     "cf[10101]",
+         *     "New custom field"
+         *   ],
+         *   "custom": true,
+         *   "id": "customfield_10101",
+         *   "key": "customfield_10101",
+         *   "name": "New custom field",
+         *   "navigable": true,
+         *   "orderable": true,
+         *   "schema": {
+         *     "custom": "com.atlassian.jira.plugin.system.customfieldtypes:project",
+         *     "customId": 10101,
+         *     "type": "project"
+         *   },
+         *   "searchable": true,
+         *   "untranslatedName": "New custom field"
+         * }
+         * @path {POST} /rest/api/3/field
+         * @scopes-current manage:jira-configuration
+         * @scopes-beta write:field:jira, read:avatar:jira, read:field:jira,
+         * read:project-category:jira, read:project:jira, read:field-configuration:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-post
+         */
+        this.createCustomField = ({ customFieldDefinitionJsonBean, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/field",
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: customFieldDefinitionJsonBean,
+            })
+                .then(this.getClientInstance().responseHandler({
+                201: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueFieldsService.createCustomField.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Deletes a custom field. The custom field is deleted whether it is in the trash
+         * or not. See [Edit or delete a custom
+         * field](https://confluence.atlassian.com/x/Z44fOw) for more information on
+         * trashing and deleting custom fields.
+         *
+         * This operation is [asynchronous](#async). Follow the `location` link in the
+         * response to determine the status of the task and use [Get
+         * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @path {DELETE} /rest/api/3/field/{id}
+         * @scopes-current manage:jira-configuration
+         * @scopes-beta delete:field:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-id-delete
+         */
+        this.deleteCustomField = ({ id, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/field/{id}",
+                method: "DELETE",
+                pathParams: {
+                    id,
+                },
+            })
+                .then(commonHttpClient.discardResult);
+        };
+        /**
+         * Returns a [paginated](#pagination) list of the contexts a field is used in.
+         * Deprecated, use [ Get custom field
+         * contexts](#api-rest-api-3-field-fieldId-context-get).
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @deprecated
+         * @returns Returned if the request is successful.
+         *
+         * example: {
+         *   "isLast": false,
+         *   "maxResults": 1,
+         *   "startAt": 0,
+         *   "total": 5,
+         *   "values": [
+         *     {
+         *       "id": 10001,
+         *       "name": "Default Context"
+         *     }
+         *   ]
+         * }
+         * @path {GET} /rest/api/3/field/{fieldId}/contexts
+         * @scopes-current manage:jira-project
+         * @scopes-beta read:field:jira, read:avatar:jira, read:project-category:jira, read:project:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-fieldid-contexts-get
+         */
+        this.getContextsForFieldDeprecated = ({ fieldId, startAt, maxResults, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/field/{fieldId}/contexts",
+                method: "GET",
+                pathParams: {
+                    fieldId,
+                },
+                query: {
+                    startAt,
+                    maxResults,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueFieldsService.getContextsForFieldDeprecated.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Returns system and custom issue fields according to the following rules:
+         *
+         *  *  Fields that cannot be added to the issue navigator are always returned.
+         *  *  Fields that cannot be placed on an issue screen are always returned.
+         *  *  Fields that depend on global Jira settings are only returned if the setting
+         * is enabled. That is, timetracking fields, subtasks, votes, and watches.
+         *  *  For all other fields, this operation only returns the fields that the user
+         * has permission to view (that is, the field is used in at least one project that
+         * the user has *Browse Projects* [project
+         * permission](https://confluence.atlassian.com/x/yodKLg) for.)
+         *
+         * This operation can be accessed anonymously.
+         *
+         * **[Permissions](#permissions) required:** None.
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: [
+         *   {
+         *     "clauseNames": [
+         *       "description"
+         *     ],
+         *     "custom": false,
+         *     "id": "description",
+         *     "name": "Description",
+         *     "navigable": true,
+         *     "orderable": true,
+         *     "schema": {
+         *       "system": "description",
+         *       "type": "string"
+         *     },
+         *     "searchable": true
+         *   },
+         *   {
+         *     "clauseNames": [
+         *       "summary"
+         *     ],
+         *     "custom": false,
+         *     "id": "summary",
+         *     "key": "summary",
+         *     "name": "Summary",
+         *     "navigable": true,
+         *     "orderable": true,
+         *     "schema": {
+         *       "system": "summary",
+         *       "type": "string"
+         *     },
+         *     "searchable": true
+         *   }
+         * ]
+         * @path {GET} /rest/api/3/field
+         * @scopes-current read:jira-work
+         * @scopes-beta read:field:jira, read:avatar:jira, read:project-category:jira,
+         * read:project:jira, read:field-configuration:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-get
+         */
+        this.getFields = () => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/field",
+                method: "GET",
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueFieldsService.getFields.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Returns a [paginated](#pagination) list of fields for Classic Jira projects.
+         * The list can include:
+         *
+         *  *  all fields
+         *  *  specific fields, by defining `id`
+         *  *  fields that contain a string in the field name or description, by defining
+         * `query`
+         *  *  specific fields that contain a string in the field name or description, by
+         * defining `id` and `query`
+         *
+         * Only custom fields can be queried, `type` must be set to `custom`.
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: {
+         *   "isLast": false,
+         *   "maxResults": 50,
+         *   "startAt": 0,
+         *   "total": 2,
+         *   "values": [
+         *     {
+         *       "id": "customfield_10000",
+         *       "name": "Approvers",
+         *       "schema": {
+         *         "custom":
+         * "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker",
+         *         "customId": 10000,
+         *         "items": "user",
+         *         "type": "array"
+         *       },
+         *       "description": "Contains users needed for approval. This custom field was
+         * created by Jira Service Desk.",
+         *       "key": "customfield_10000",
+         *       "stableId": "sfid:approvers",
+         *       "isLocked": true,
+         *       "searcherKey":
+         * "com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher",
+         *       "screensCount": 2,
+         *       "contextsCount": 2,
+         *       "lastUsed": {
+         *         "type": "TRACKED",
+         *         "value": "2021-01-28T07:37:40.000+0000"
+         *       }
+         *     },
+         *     {
+         *       "id": "customfield_10001",
+         *       "name": "Change reason",
+         *       "schema": {
+         *         "custom": "com.atlassian.jira.plugin.system.customfieldtypes:select",
+         *         "customId": 10001,
+         *         "type": "option"
+         *       },
+         *       "description": "Choose the reason for the change request",
+         *       "key": "customfield_10001",
+         *       "stableId": "sfid:change-reason",
+         *       "isLocked": false,
+         *       "searcherKey":
+         * "com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher",
+         *       "screensCount": 2,
+         *       "contextsCount": 2,
+         *       "projectsCount": 2,
+         *       "lastUsed": {
+         *         "type": "NOT_TRACKED"
+         *       }
+         *     }
+         *   ]
+         * }
+         * @path {GET} /rest/api/3/field/search
+         * @scopes-current read:jira-work
+         * @scopes-beta read:field:jira, read:field-configuration:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-search-get
+         */
+        this.getFieldsPaginated = ({ startAt, maxResults, type, id, query, orderBy, expand, } = {}) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/field/search",
+                method: "GET",
+                query: {
+                    startAt,
+                    maxResults,
+                    type,
+                    id,
+                    query,
+                    orderBy,
+                    expand,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueFieldsService.getFieldsPaginated.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Returns a [paginated](#pagination) list of fields in the trash. The list may be
+         * restricted to fields whose field name or description partially match a string.
+         *
+         * Only custom fields can be queried, `type` must be set to `custom`.
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @returns Returned if the request is successful.
+         *
+         * example: {
+         *   "isLast": false,
+         *   "maxResults": 50,
+         *   "startAt": 0,
+         *   "total": 1,
+         *   "values": [
+         *     {
+         *       "id": "customfield_10000",
+         *       "name": "Approvers",
+         *       "schema": {
+         *         "custom":
+         * "com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker",
+         *         "customId": 10003,
+         *         "type": "array"
+         *       },
+         *       "description": "Contains users needed for approval. This custom field was
+         * created by Jira Service Desk.",
+         *       "key": "customfield_10003",
+         *       "trashedDate": "2022-10-06T07:32:47.000+0000",
+         *       "trashedBy": {
+         *         "accountId": "5b10a2844c20165700ede21g",
+         *         "active": true,
+         *         "avatarUrls": {
+         *           "16x16":
+         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+         *           "24x24":
+         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+         *           "32x32":
+         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+         *           "48x48":
+         * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+         *         },
+         *         "displayName": "Mia Krystof",
+         *         "emailAddress": "mia@example.com",
+         *         "self":
+         * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+         *         "timeZone": "Australia/Sydney"
+         *       },
+         *       "plannedDeletionDate": "2022-10-24T07:32:47.000+0000"
+         *     }
+         *   ]
+         * }
+         * @path {GET} /rest/api/3/field/search/trashed
+         * @scopes-current read:jira-work
+         * @scopes-beta read:field:jira, read:field-configuration:jira, read:user:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-search-trashed-get
+         */
+        this.getTrashedFieldsPaginated = ({ startAt, maxResults, id, query, expand, orderBy, } = {}) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/field/search/trashed",
+                method: "GET",
+                query: {
+                    startAt,
+                    maxResults,
+                    id,
+                    query,
+                    expand,
+                    orderBy,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueFieldsService.getTrashedFieldsPaginated.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Restores a custom field from trash. See [Edit or delete a custom
+         * field](https://confluence.atlassian.com/x/Z44fOw) for more information on
+         * trashing and deleting custom fields.
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @returns Returned if the request is successful.
+         * @path {POST} /rest/api/3/field/{id}/restore
+         * @scopes-current manage:jira-configuration
+         * @scopes-beta write:field:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-id-restore-post
+         */
+        this.restoreCustomField = ({ id, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/field/{id}/restore",
+                method: "POST",
+                pathParams: {
+                    id,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueFieldsService.restoreCustomField.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Moves a custom field to trash. See [Edit or delete a custom
+         * field](https://confluence.atlassian.com/x/Z44fOw) for more information on
+         * trashing and deleting custom fields.
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @returns Returned if the request is successful.
+         * @path {POST} /rest/api/3/field/{id}/trash
+         * @scopes-current manage:jira-configuration
+         * @scopes-beta delete:field:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-id-trash-post
+         */
+        this.trashCustomField = ({ id, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/field/{id}/trash",
+                method: "POST",
+                pathParams: {
+                    id,
+                },
+            })
+                .then(this.getClientInstance().responseHandler({
+                200: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueFieldsService.trashCustomField.response"))
+                .then(commonHttpClient.getBody);
+        };
+        /**
+         * Updates a custom field.
+         *
+         * **[Permissions](#permissions) required:** *Administer Jira* [global
+         * permission](https://confluence.atlassian.com/x/x4dKLg).
+         *
+         * @returns Returned if the request is successful.
+         * @path {PUT} /rest/api/3/field/{fieldId}
+         * @scopes-current manage:jira-configuration
+         * @scopes-beta write:field:jira
+         * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields#api-rest-api-3-field-fieldid-put
+         */
+        this.updateCustomField = ({ fieldId, updateCustomFieldDetails, }) => {
+            return this.getClientInstance()
+                .request({
+                path: "/rest/api/3/field/{fieldId}",
+                method: "PUT",
+                pathParams: {
+                    fieldId,
+                },
+                headers: {
+                    "Content-Type": "application/json",
+                },
+                body: updateCustomFieldDetails,
+            })
+                .then(this.getClientInstance().responseHandler({
+                204: {
+                    "application/json": "json",
+                },
+            }))
+                .then(commonHttpClient.castResponse())
+                .then(validationSchemaStorage_1.validationSchemaStorage.validator("IssueFieldsService.updateCustomField.response"))
+                .then(commonHttpClient.getBody);
+        };
     }
     static initialize() {
         validationSchemaStorage_1.validationSchemaStorage.registerExtensible("IssueFieldsService.getFields.response", zod_1.z