@resolution/jira-api-client 0.15.8 → 0.16.0

package/lib/openapi/platform/services/FieldSchemesService.d.ts

@@ -0,0 +1,901 @@
+import * as commonHttpClient from "../../core/CommonHttpClient";
+import { CommonHttpService } from "../../core/CommonHttpService";
+import { type PageBean2GetFieldAssociationSchemeResponse, type CreateFieldAssociationSchemeRequest, type CreateFieldAssociationSchemeResponse, type GetFieldAssociationSchemeByIdResponse, type UpdateFieldAssociationSchemeRequest, type UpdateFieldAssociationSchemeResponse, type DeleteFieldAssociationSchemeResponse, type PageBean2FieldAssociationSchemeFieldSearchResult, type GetFieldAssociationParametersResponse, type PageBean2FieldAssociationSchemeProjectSearchResult, type UpdateFieldAssociationsRequestItem, type FieldSchemeToFieldsResponse, type RemoveFieldAssociationsRequestItem, type MinimalFieldSchemeToFieldsResponse, type UpdateFieldSchemeParametersRequest, type UpdateFieldSchemeParametersResponse, type ParameterRemovalDetails, type RemoveFieldParametersResult, type PageBean2GetProjectsWithFieldSchemesResponse, type FieldSchemeToProjectsRequest, type FieldSchemeToProjectsResponse } from "../models/fieldSchemes";
+/**
+ * This resource represents field schemes which are replacing field configuration
+ * schemes to control field associations. They are currently in beta and only
+ * available to customers who have opted-in to the beta program. For more
+ * information see [RFC-103: Jira Field Configuration Overhaul: Admin Experience
+ * and API
+ * Changes](https://community.developer.atlassian.com/t/rfc-103-jira-field-configuration-overhaul-admin-experience-and-api-changes/94205)
+ *
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes
+ * @category Services
+ */
+export declare class FieldSchemesService extends CommonHttpService {
+    /**
+     * Associate projects to field association schemes.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns
+     *  * status: 200, mediaType: application/json
+     *
+     *    Returned if the association was successful.
+     *
+     *    example:
+     *    ```
+     * {
+     *      "results": [
+     *        {
+     *          "projectId": 10001,
+     *          "schemeId": 10000,
+     *          "success": true
+     *        },
+     *        {
+     *          "projectId": 10002,
+     *          "schemeId": 10001,
+     *          "success": true
+     *        }
+     *      ]
+     *    }
+     *    ```
+     *
+     *  * status: 204, mediaType: application/json
+     *
+     *    The request completed successfully. No additional content will be sent in the response.
+     *
+     *  * status: 207, mediaType: application/json
+     *
+     *    Returned if the association was partially successful.
+     *
+     *    example:
+     *    ```
+     * {
+     *      "results": [
+     *        {
+     *          "projectId": 10001,
+     *          "schemeId": 10000,
+     *          "success": true
+     *        },
+     *        {
+     *          "error": "Project #10001 doesn't exist",
+     *          "projectId": 10002,
+     *          "schemeId": 10001,
+     *          "success": false
+     *        }
+     *      ]
+     *    }
+     *    ```
+     * @path PUT `/rest/api/3/config/fieldschemes/projects`
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:field-configuration:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes#api-rest-api-3-config-fieldschemes-projects-put
+     * @param params
+     */
+    associateProjectsToFieldAssociationSchemes: ({ requestBody }: {
+        /**
+         * @example
+         * ```
+         * {
+         * "10000": {
+         *     "projectIds": [
+         *       10000,
+         *       10001
+         *     ]
+         *   },
+         *   "10001": {
+         *     "projectIds": [
+         *       10002
+         *     ]
+         *   }
+         * }
+         * ```
+         */
+        requestBody: {
+            [key: string]: FieldSchemeToProjectsRequest;
+        };
+    }) => Promise<commonHttpClient.WithResponse<{
+        status: 200 | 207;
+        mediaType: "application/json";
+        body: FieldSchemeToProjectsResponse;
+    } | {
+        status: 204;
+        mediaType: "application/json";
+        body: void;
+    }>>;
+    /**
+     * Endpoint for creating a new field association scheme.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the creation was successful.
+     *
+     * example:
+     * ```
+     * {
+     *   "description": "Field association scheme description",
+     *   "id": 10000,
+     *   "links": {
+     *     "associations": "{BASE_API_URL}/rest/api/2/config/fieldschemes/9/associations",
+     *     "projects": "{BASE_API_URL}/rest/api/2/config/fieldschemes/9/projects"
+     *   },
+     *   "name": "Field association scheme name"
+     * }
+     * ```
+     * @path POST `/rest/api/3/config/fieldschemes`
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:field-configuration-scheme:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes#api-rest-api-3-config-fieldschemes-post
+     * @param params
+     */
+    createFieldAssociationScheme: ({ createFieldAssociationSchemeRequest }: {
+        /**
+         * The request containing the name and description of the field association scheme
+         *
+         * @example
+         * ```
+         * {
+         * "description": "Field association scheme description",
+         *   "name": "Field association scheme name"
+         * }
+         * ```
+         */
+        createFieldAssociationSchemeRequest: CreateFieldAssociationSchemeRequest;
+    }) => Promise<CreateFieldAssociationSchemeResponse>;
+    /**
+     * Delete a specified field association scheme
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the field association scheme deletion was successful.
+     *
+     * example:
+     * ```
+     * {
+     *   "deleted": true,
+     *   "id": "10000"
+     * }
+     * ```
+     * @path DELETE `/rest/api/3/config/fieldschemes/{id}`
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:field-configuration-scheme:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes#api-rest-api-3-config-fieldschemes-id-delete
+     * @param params
+     */
+    deleteFieldAssociationScheme: ({ id }: {
+        /** The ID of the field association scheme to delete. */
+        id: number;
+    }) => Promise<DeleteFieldAssociationSchemeResponse>;
+    /**
+     * Endpoint for fetching a field association scheme by its ID
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if a field association scheme matches the given scheme ID
+     *
+     * example:
+     * ```
+     * {
+     *   "description": "This is a field association scheme",
+     *   "id": "123",
+     *   "isDefault": false,
+     *   "links": {
+     *     "associations": "rest/api/3/config/fieldschemes/10000/associations",
+     *     "projects": "rest/api/3/config/fieldschemes/10000/projects"
+     *   },
+     *   "name": "Scheme"
+     * }
+     * ```
+     * @path GET `/rest/api/3/config/fieldschemes/{id}`
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:field-configuration-scheme:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes#api-rest-api-3-config-fieldschemes-id-get
+     * @param params
+     */
+    getFieldAssociationSchemeById: ({ id }: {
+        /** The scheme id to fetch */
+        id: number;
+    }) => Promise<GetFieldAssociationSchemeByIdResponse>;
+    /**
+     * Retrieve field association parameters on a field association scheme
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the parameters fetched were successful.
+     *
+     * example:
+     * ```
+     * {
+     *   "fieldId": "customfield_10000",
+     *   "parameters": {
+     *     "description": "Teams field",
+     *     "isRequired": true
+     *   },
+     *   "workTypeParameters": [
+     *     {
+     *       "description": "Teams field",
+     *       "isRequired": false,
+     *       "workTypeId": 10010
+     *     }
+     *   ]
+     * }
+     * ```
+     * @path GET `/rest/api/3/config/fieldschemes/{id}/fields/{fieldId}/parameters`
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:field-configuration:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes#api-rest-api-3-config-fieldschemes-id-fields-fieldid-parameters-get
+     * @param params
+     */
+    getFieldAssociationSchemeItemParameters: ({ id, fieldId }: {
+        /** the ID of the field association scheme to retrieve parameters for */
+        id: number;
+        /** the ID of the field */
+        fieldId: string;
+    }) => Promise<GetFieldAssociationParametersResponse>;
+    /**
+     * REST endpoint for retrieving a paginated list of field association schemes with
+     * optional filtering.
+     *
+     * This endpoint allows clients to fetch field association schemes with optional
+     * filtering by project IDs and text queries. The response includes scheme details
+     * with navigation links and filter metadata when applicable.
+     *
+     * Filtering Behavior:
+     *
+     *  *  When projectId or query parameters are provided, the response includes
+     * matchedFilters metadata showing which filters were applied.
+     *  *  When no filters are applied, matchedFilters is omitted from individual
+     * scheme objects
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Pagianted list of field association schemes
+     *
+     * example:
+     * ```
+     * {
+     *   "description": "Field Association Scheme test description",
+     *   "id": 1000,
+     *   "isDefault": false,
+     *   "links": {
+     *     "associations": "rest/api/3/config/fieldschemes/10000/associations",
+     *     "projects": "rest/api/3/config/fieldschemes/10000/projects"
+     *   },
+     *   "matchedFilters": {
+     *     "projectIds": [
+     *       10001,
+     *       10002
+     *     ],
+     *     "query": "query"
+     *   },
+     *   "name": "Field Association Scheme test name"
+     * }
+     * ```
+     * @path GET `/rest/api/3/config/fieldschemes`
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:field-configuration-scheme:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes#api-rest-api-3-config-fieldschemes-get
+     * @param params
+     */
+    getFieldAssociationSchemes: ({ projectId, query, startAt, maxResults }?: {
+        /**
+         * (optional) List of project IDs to filter schemes by. If not provided, schemes
+         * from all projects are returned.
+         */
+        projectId?: number[] | undefined;
+        /**
+         * (optional) Text filter for scheme name or description matching
+         * (case-insensitive). If not provided, no text filtering is applied.
+         */
+        query?: string | undefined;
+        /** Zero-based index of the first item to return (default: 0) */
+        startAt?: number | undefined;
+        /** Maximum number of items to return per page (default: 50, max: 100) */
+        maxResults?: number | undefined;
+    }) => Promise<PageBean2GetFieldAssociationSchemeResponse>;
+    /**
+     * Get projects with field association schemes. This will be a temporary API but
+     * useful when transitioning from the legacy field configuration APIs to the new
+     * ones.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returns the list of project with field association schemes.
+     *
+     * example:
+     * ```
+     * {
+     *   "isLast": true,
+     *   "maxResults": 3,
+     *   "startAt": 0,
+     *   "total": 3,
+     *   "values": [
+     *     {
+     *       "projectId": 10000,
+     *       "schemeId": 1
+     *     },
+     *     {
+     *       "projectId": 10001,
+     *       "schemeId": 1
+     *     },
+     *     {
+     *       "projectId": 10002,
+     *       "schemeId": 2
+     *     }
+     *   ]
+     * }
+     * ```
+     * @path GET `/rest/api/3/config/fieldschemes/projects`
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:field-configuration-scheme:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes#api-rest-api-3-config-fieldschemes-projects-get
+     * @param params
+     */
+    getProjectsWithFieldSchemes: ({ startAt, maxResults, projectId }: {
+        /** The starting index of the returned projects. Base index: 0. */
+        startAt?: number | undefined;
+        /** The maximum number of projects to return per page, maximum allowed value is 100. */
+        maxResults?: number | undefined;
+        /** List of project ids to filter the results by. */
+        projectId: number[];
+    }) => Promise<PageBean2GetProjectsWithFieldSchemesResponse>;
+    /**
+     * Remove field association parameters overrides for work types.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns
+     *  * status: 204, mediaType: application/json
+     *
+     *    The request completed successfully. No additional content will be sent in the response.
+     *
+     *  * status: 207, mediaType: application/json
+     *
+     *    Returned if the removal was partially successful.
+     *
+     *    example:
+     *    ```
+     * {
+     *      "results": [
+     *        {
+     *          "error": {
+     *            "code": "FIELD_IS_NOT_ASSOCIATED",
+     *            "message": "The field 'customfield_10000' is not associated with the scheme '10000'."
+     *          },
+     *          "fieldId": "customfield_10000",
+     *          "schemeId": 10000,
+     *          "success": false,
+     *          "workTypeIds": [
+     *            1,
+     *            2
+     *          ]
+     *        },
+     *        {
+     *          "fieldId": "description",
+     *          "schemeId": 10001,
+     *          "success": true,
+     *          "workTypeIds": [
+     *            3
+     *          ]
+     *        }
+     *      ]
+     *    }
+     *    ```
+     * @path DELETE `/rest/api/3/config/fieldschemes/fields/parameters`
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:field-configuration:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes#api-rest-api-3-config-fieldschemes-fields-parameters-delete
+     * @param params
+     */
+    removeFieldAssociationSchemeItemParameters: ({ requestBody }: {
+        /**
+         * @example
+         * ```
+         * {
+         * "customfield_10000": [
+         *     {
+         *       "parameters": [
+         *         "description",
+         *         "isRequired"
+         *       ],
+         *       "schemeId": 10000,
+         *       "workTypeIds": [
+         *         1,
+         *         2
+         *       ]
+         *     }
+         *   ],
+         *   "description": [
+         *     {
+         *       "parameters": [
+         *         "description"
+         *       ],
+         *       "schemeId": 10001,
+         *       "workTypeIds": [
+         *         3
+         *       ]
+         *     }
+         *   ]
+         * }
+         * ```
+         */
+        requestBody: {
+            [key: string]: ParameterRemovalDetails[];
+        };
+    }) => Promise<commonHttpClient.WithResponse<{
+        status: 204;
+        mediaType: "application/json";
+        body: void;
+    } | {
+        status: 207;
+        mediaType: "application/json";
+        body: RemoveFieldParametersResult;
+    }>>;
+    /**
+     * Remove fields associated with field association schemes.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns
+     *  * status: 200, mediaType: application/json
+     *
+     *    Returned if the field association update was successful.
+     *
+     *    example:
+     *    ```
+     * {
+     *      "results": [
+     *        {
+     *          "fieldId": "customfield_10000",
+     *          "schemeId": 10000,
+     *          "success": true
+     *        },
+     *        {
+     *          "fieldId": "customfield_10001",
+     *          "schemeId": 10002,
+     *          "success": true
+     *        }
+     *      ]
+     *    }
+     *    ```
+     *
+     *  * status: 204, mediaType: application/json
+     *
+     *    The request completed successfully. No additional content will be sent in the response.
+     *
+     *  * status: 207, mediaType: application/json
+     *
+     *    Returned if the field association update was partially successful.
+     *
+     *    example:
+     *    ```
+     * {
+     *      "results": [
+     *        {
+     *          "fieldId": "customfield_10000",
+     *          "schemeId": 10000,
+     *          "success": true
+     *        },
+     *        {
+     *          "error": "Scheme 10001 doesn't exist",
+     *          "fieldId": "customfield_10001",
+     *          "schemeId": 10001,
+     *          "success": false
+     *        }
+     *      ]
+     *    }
+     *    ```
+     * @path DELETE `/rest/api/3/config/fieldschemes/fields`
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:field-configuration:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes#api-rest-api-3-config-fieldschemes-fields-delete
+     * @param params
+     */
+    removeFieldsAssociatedWithSchemes: ({ requestBody }: {
+        /**
+         * The request containing the schemes and fields to be removed.
+         *
+         * @example
+         * ```
+         * {
+         * "customfield_10000": {
+         *     "schemeIds": [
+         *       10000,
+         *       10001
+         *     ]
+         *   },
+         *   "customfield_10001": {
+         *     "schemeIds": [
+         *       10002
+         *     ]
+         *   }
+         * }
+         * ```
+         */
+        requestBody: {
+            [key: string]: RemoveFieldAssociationsRequestItem;
+        };
+    }) => Promise<commonHttpClient.WithResponse<{
+        status: 200 | 207;
+        mediaType: "application/json";
+        body: MinimalFieldSchemeToFieldsResponse;
+    } | {
+        status: 204;
+        mediaType: "application/json";
+        body: void;
+    }>>;
+    /**
+     * Search for fields belonging to a given field association scheme.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returns the matching fields, at the specified page of the results.
+     *
+     * example:
+     * ```
+     * {
+     *   "allowedOperations": [
+     *     "REMOVE",
+     *     "CHANGE_REQUIRED",
+     *     "CHANGE_DESCRIPTION"
+     *   ],
+     *   "fieldId": "customfield_10000",
+     *   "parameters": {
+     *     "description": "text",
+     *     "isRequired": true
+     *   },
+     *   "restrictedToWorkTypes": [
+     *     "1",
+     *     "2"
+     *   ],
+     *   "workTypeParameters": [
+     *     {
+     *       "description": "text",
+     *       "isRequired": true,
+     *       "workTypeId": "1"
+     *     },
+     *     {
+     *       "description": "textarea",
+     *       "isRequired": false,
+     *       "workTypeId": "2"
+     *     }
+     *   ]
+     * }
+     * ```
+     * @path GET `/rest/api/3/config/fieldschemes/{id}/fields`
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:field-configuration:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes#api-rest-api-3-config-fieldschemes-id-fields-get
+     * @param params
+     */
+    searchFieldAssociationSchemeFields: ({ id, startAt, maxResults, fieldId }: {
+        /** The scheme ID to search for child fields */
+        id: number;
+        /** The starting index of the returned fields. Base index: 0. */
+        startAt?: number | undefined;
+        /** The maximum number of fields to return per page, maximum allowed value is 100. */
+        maxResults?: number | undefined;
+        /**
+         * The field IDs to filter by, if empty then all fields belonging to a field
+         * association scheme will be returned
+         */
+        fieldId?: string[] | undefined;
+    }) => Promise<PageBean2FieldAssociationSchemeFieldSearchResult>;
+    /**
+     * REST Endpoint for searching for projects belonging to a given field association
+     * scheme
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returns a paginated list of projects associated with the field association scheme, matching the specified filter criteria.
+     * @path GET `/rest/api/3/config/fieldschemes/{id}/projects`
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta read:field-configuration:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes#api-rest-api-3-config-fieldschemes-id-projects-get
+     * @param params
+     */
+    searchFieldAssociationSchemeProjects: ({ id, startAt, maxResults, projectId }: {
+        /** The scheme id to search for associated projects */
+        id: number;
+        /** The starting index of the returned projects. Base index: 0. */
+        startAt?: number | undefined;
+        /** The maximum number of projects to return per page, maximum allowed value is 100. */
+        maxResults?: number | undefined;
+        /**
+         * The project Ids to filter by, if empty then all projects belonging to a field
+         * association scheme will be returned
+         */
+        projectId?: number[] | undefined;
+    }) => Promise<PageBean2FieldAssociationSchemeProjectSearchResult>;
+    /**
+     * Endpoint for updating an existing field association scheme.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns Returned if the update was successful.
+     *
+     * example:
+     * ```
+     * {
+     *   "description": "Field association scheme description",
+     *   "id": 10000,
+     *   "links": {
+     *     "associations": "{BASE_API_URL}/rest/api/2/config/fieldschemes/9/associations",
+     *     "projects": "{BASE_API_URL}/rest/api/2/config/fieldschemes/9/projects"
+     *   },
+     *   "name": "Field association scheme name"
+     * }
+     * ```
+     * @path PUT `/rest/api/3/config/fieldschemes/{id}`
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:field-configuration-scheme:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes#api-rest-api-3-config-fieldschemes-id-put
+     * @param params
+     */
+    updateFieldAssociationScheme: ({ id, updateFieldAssociationSchemeRequest }: {
+        id: number;
+        /**
+         * The request containing the desired updates to the field association scheme
+         *
+         * @example
+         * ```
+         * {
+         * "description": "Field association scheme description",
+         *   "name": "Field association scheme name"
+         * }
+         * ```
+         */
+        updateFieldAssociationSchemeRequest: UpdateFieldAssociationSchemeRequest;
+    }) => Promise<UpdateFieldAssociationSchemeResponse>;
+    /**
+     * Update field association item parameters in field association schemes.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns
+     *  * status: 200, mediaType: application/json
+     *
+     *    Returned if the field parameter update was successful.
+     *
+     *    example:
+     *    ```
+     * {
+     *      "results": [
+     *        {
+     *          "fieldId": "customfield_10000",
+     *          "schemeId": 10000,
+     *          "success": true
+     *        },
+     *        {
+     *          "fieldId": "customfield_10001",
+     *          "schemeId": 10002,
+     *          "success": true,
+     *          "workTypeId": 10001
+     *        }
+     *      ]
+     *    }
+     *    ```
+     *
+     *  * status: 204, mediaType: application/json
+     *
+     *    The request completed successfully. No additional content will be sent in the response.
+     *
+     *  * status: 207, mediaType: application/json
+     *
+     *    Returned if the field parameter update was partially successful.
+     *
+     *    example:
+     *    ```
+     * {
+     *      "results": [
+     *        {
+     *          "fieldId": "customfield_10000",
+     *          "schemeId": 10000,
+     *          "success": true
+     *        },
+     *        {
+     *          "error": "Scheme 10001 doesn't exist",
+     *          "fieldId": "customfield_10001",
+     *          "schemeId": 10001,
+     *          "success": false,
+     *          "workTypeId": 10001
+     *        }
+     *      ]
+     *    }
+     *    ```
+     * @path PUT `/rest/api/3/config/fieldschemes/fields/parameters`
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:field-configuration:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes#api-rest-api-3-config-fieldschemes-fields-parameters-put
+     * @param params
+     */
+    updateFieldAssociationSchemeItemParameters: ({ requestBody }: {
+        /**
+         * The request containing the field association scheme id and the parameters to
+         * update.
+         *
+         * @example
+         * ```
+         * {
+         * "customfield_10000": [
+         *     {
+         *       "parameters": {
+         *         "description": "Field description",
+         *         "isRequired": true
+         *       },
+         *       "schemeIds": [
+         *         10000,
+         *         10001
+         *       ],
+         *       "workTypeParameters": [
+         *         {
+         *           "description": "Description for Bug",
+         *           "isRequired": false,
+         *           "workTypeId": 10002
+         *         }
+         *       ]
+         *     }
+         *   ],
+         *   "customfield_10001": [
+         *     {
+         *       "schemeIds": [
+         *         10001
+         *       ],
+         *       "workTypeParameters": [
+         *         {
+         *           "description": "Description for Bug",
+         *           "isRequired": false,
+         *           "workTypeId": 10002
+         *         },
+         *         {
+         *           "description": "Description for Task",
+         *           "isRequired": true,
+         *           "workTypeId": 10003
+         *         }
+         *       ]
+         *     }
+         *   ]
+         * }
+         * ```
+         */
+        requestBody: {
+            [key: string]: UpdateFieldSchemeParametersRequest[];
+        };
+    }) => Promise<commonHttpClient.WithResponse<{
+        status: 200 | 207;
+        mediaType: "application/json";
+        body: UpdateFieldSchemeParametersResponse;
+    } | {
+        status: 204;
+        mediaType: "application/json";
+        body: void;
+    }>>;
+    /**
+     * Update fields associated with field association schemes.
+     *
+     * **[Permissions](#permissions) required:** *Administer Jira* [global
+     * permission](https://confluence.atlassian.com/x/x4dKLg).
+     *
+     * @returns
+     *  * status: 200, mediaType: application/json
+     *
+     *    Returned if the field association update was successful.
+     *
+     *    example:
+     *    ```
+     * {
+     *      "results": [
+     *        {
+     *          "fieldId": "customfield_10000",
+     *          "schemeId": 10000,
+     *          "success": true,
+     *          "workTypeIds": [
+     *            1,
+     *            2
+     *          ]
+     *        },
+     *        {
+     *          "fieldId": "customfield_10001",
+     *          "schemeId": 10002,
+     *          "success": true,
+     *          "workTypeIds": []
+     *        }
+     *      ]
+     *    }
+     *    ```
+     *
+     *  * status: 204, mediaType: application/json
+     *
+     *    The request completed successfully. No additional content will be sent in the response.
+     *
+     *  * status: 207, mediaType: application/json
+     *
+     *    Returned if the field association update was partially successful.
+     *
+     *    example:
+     *    ```
+     * {
+     *      "results": [
+     *        {
+     *          "fieldId": "customfield_10000",
+     *          "schemeId": 10000,
+     *          "success": true,
+     *          "workTypeIds": [
+     *            1
+     *          ]
+     *        },
+     *        {
+     *          "error": "Scheme 10001 doesn't exist",
+     *          "fieldId": "customfield_10001",
+     *          "schemeId": 10001,
+     *          "success": false,
+     *          "workTypeIds": [
+     *            2
+     *          ]
+     *        }
+     *      ]
+     *    }
+     *    ```
+     * @path PUT `/rest/api/3/config/fieldschemes/fields`
+     * @scopes-current manage:jira-configuration
+     * @scopes-beta write:field-configuration:jira
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes#api-rest-api-3-config-fieldschemes-fields-put
+     * @param params
+     */
+    updateFieldsAssociatedWithSchemes: ({ requestBody }: {
+        /**
+         * The request containing the schemes and work types to associate each field with.
+         *
+         * @example
+         * ```
+         * {
+         * "customfield_10000": [
+         *     {
+         *       "restrictedToWorkTypes": [
+         *         1,
+         *         2
+         *       ],
+         *       "schemeIds": [
+         *         10000,
+         *         10001
+         *       ]
+         *     }
+         *   ],
+         *   "customfield_10001": [
+         *     {
+         *       "schemeIds": [
+         *         10002
+         *       ]
+         *     }
+         *   ]
+         * }
+         * ```
+         */
+        requestBody: {
+            [key: string]: UpdateFieldAssociationsRequestItem[];
+        };
+    }) => Promise<commonHttpClient.WithResponse<{
+        status: 200 | 207;
+        mediaType: "application/json";
+        body: FieldSchemeToFieldsResponse;
+    } | {
+        status: 204;
+        mediaType: "application/json";
+        body: void;
+    }>>;
+    protected static initialize(): void;
+}