@resolution/jira-api-client 0.1.0

package/src/openapi/platform/services/issue-field-configurations-service.ts

@@ -0,0 +1,1294 @@
+// DO NOT EDIT!
+// This file is generated by "api-typescript-generator".
+// To update this file run "yarn build:openapi".
+import { z } from "zod";
+
+import * as commonHttpClient from "../core/common-http-client";
+import { CommonHttpService } from "../core/common-http-service";
+import {
+  type AssociateFieldConfigurationsWithIssueTypesRequest,
+  type FieldConfiguration,
+  type FieldConfigurationDetails,
+  type FieldConfigurationItemsDetails,
+  type FieldConfigurationScheme,
+  type FieldConfigurationSchemeProjectAssociation,
+  type IssueTypeIdsToRemove,
+  type PageBeanFieldConfigurationDetails,
+  type PageBeanFieldConfigurationIssueTypeItem,
+  type PageBeanFieldConfigurationItem,
+  type PageBeanFieldConfigurationScheme,
+  type PageBeanFieldConfigurationSchemeProjects,
+  registerIssueFieldConfigurationsValidationSchemas,
+  type UpdateFieldConfigurationSchemeDetails,
+} from "../models/issue-field-configurations";
+import { validationSchemaStorage } from "../validation-schema-storage";
+/**
+ * This resource represents issue field configurations. Use it to get, set, and
+ * delete field configurations and field configuration schemes.
+ */
+export class IssueFieldConfigurationsService extends CommonHttpService {
+  /**
+   * Assigns a field configuration scheme to a project. If the field configuration
+   * scheme ID is `null`, the operation assigns the default field configuration
+   * scheme.
+   *
+   * Field configuration schemes can only be assigned to classic projects.
+   *
+   * **[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/fieldconfigurationscheme/project
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:field-configuration-scheme:jira
+   */
+  assignFieldConfigurationSchemeToProject({
+    fieldConfigurationSchemeProjectAssociation,
+  }: {
+    /**
+     * @example {
+     *     "fieldConfigurationSchemeId": "10000",
+     *     "projectId": "10000"
+     * }
+     */
+    fieldConfigurationSchemeProjectAssociation: FieldConfigurationSchemeProjectAssociation;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/fieldconfigurationscheme/project",
+        method: "PUT",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: fieldConfigurationSchemeProjectAssociation,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          204: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 204;
+          mediaType: "application/json";
+          body: void;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueFieldConfigurationsService.assignFieldConfigurationSchemeToProject.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Creates a field configuration. The field configuration is created with the same
+   * field properties as the default configuration, with all the fields being
+   * optional.
+   *
+   * This operation can only create configurations for use in company-managed
+   * (classic) projects.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "description": "My field configuration description",
+   *   "id": 10001,
+   *   "name": "My Field Configuration"
+   * }
+   * @path {POST} /rest/api/3/fieldconfiguration
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta read:field-configuration:jira, write:field-configuration:jira
+   */
+  createFieldConfiguration({
+    fieldConfigurationDetails,
+  }: {
+    /**
+     * @example {
+     *     "description": "My field configuration description",
+     *     "name": "My Field Configuration"
+     * }
+     */
+    fieldConfigurationDetails: FieldConfigurationDetails;
+  }): Promise<FieldConfiguration> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/fieldconfiguration",
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: fieldConfigurationDetails,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: FieldConfiguration;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueFieldConfigurationsService.createFieldConfiguration.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Creates a field configuration scheme.
+   *
+   * This operation can only create field configuration schemes used in
+   * company-managed (classic) projects.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "id": "10002",
+   *   "name": "Field Configuration Scheme for software related projects",
+   *   "description": "We can use this one for software projects."
+   * }
+   * @path {POST} /rest/api/3/fieldconfigurationscheme
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:field-configuration-scheme:jira, read:field-configuration-scheme:jira
+   */
+  createFieldConfigurationScheme({
+    updateFieldConfigurationSchemeDetails,
+  }: {
+    /**
+     * The details of the field configuration scheme.
+     *
+     * @example {
+     *     "description": "We can use this one for software projects.",
+     *     "name": "Field Configuration Scheme for software related projects"
+     * }
+     */
+    updateFieldConfigurationSchemeDetails: UpdateFieldConfigurationSchemeDetails;
+  }): Promise<FieldConfigurationScheme> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/fieldconfigurationscheme",
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: updateFieldConfigurationSchemeDetails,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          201: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 201;
+          mediaType: "application/json";
+          body: FieldConfigurationScheme;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueFieldConfigurationsService.createFieldConfigurationScheme.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Deletes a field configuration.
+   *
+   * This operation can only delete configurations used in company-managed (classic)
+   * projects.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   * @path {DELETE} /rest/api/3/fieldconfiguration/{id}
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta delete:field-configuration:jira
+   */
+  deleteFieldConfiguration({
+    id,
+  }: {
+    /** The ID of the field configuration. */
+    id: number;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/fieldconfiguration/{id}",
+        method: "DELETE",
+        pathParams: {
+          id,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          204: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 204;
+          mediaType: "application/json";
+          body: void;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueFieldConfigurationsService.deleteFieldConfiguration.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Deletes a field configuration scheme.
+   *
+   * This operation can only delete field configuration schemes used in
+   * company-managed (classic) projects.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   * @path {DELETE} /rest/api/3/fieldconfigurationscheme/{id}
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta delete:field-configuration-scheme:jira
+   */
+  deleteFieldConfigurationScheme({
+    id,
+  }: {
+    /** The ID of the field configuration scheme. */
+    id: number;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/fieldconfigurationscheme/{id}",
+        method: "DELETE",
+        pathParams: {
+          id,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          204: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 204;
+          mediaType: "application/json";
+          body: void;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueFieldConfigurationsService.deleteFieldConfigurationScheme.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns a [paginated](#pagination) list of field configurations. The list can
+   * be for all field configurations or a subset determined by any combination of
+   * these criteria:
+   *
+   *  *  a list of field configuration item IDs.
+   *  *  whether the field configuration is a default.
+   *  *  whether the field configuration name or description contains a query string.
+   *
+   * Only field configurations used in company-managed (classic) projects are
+   * returned.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "isLast": true,
+   *   "maxResults": 50,
+   *   "startAt": 0,
+   *   "total": 2,
+   *   "values": [
+   *     {
+   *       "id": 10000,
+   *       "name": "Default Field Configuration",
+   *       "description": "The default field configuration description",
+   *       "isDefault": true
+   *     },
+   *     {
+   *       "id": 10001,
+   *       "name": "My Field Configuration",
+   *       "description": "My field configuration description"
+   *     }
+   *   ]
+   * }
+   * @path {GET} /rest/api/3/fieldconfiguration
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta read:field-configuration:jira
+   */
+  getAllFieldConfigurations({
+    startAt,
+    maxResults,
+    id,
+    isDefault,
+    query,
+  }: {
+    /** The index of the first item to return in a page of results (page offset). */
+    startAt?: number;
+    /** The maximum number of items to return per page. */
+    maxResults?: number;
+    /**
+     * The list of field configuration IDs. To include multiple IDs, provide an
+     * ampersand-separated list. For example, `id=10000&id=10001`.
+     */
+    id?: number[];
+    /** If *true* returns default field configurations only. */
+    isDefault?: boolean;
+    /**
+     * The query string used to match against field configuration names and
+     * descriptions.
+     */
+    query?: string;
+  }): Promise<PageBeanFieldConfigurationDetails> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/fieldconfiguration",
+        method: "GET",
+        query: {
+          startAt,
+          maxResults,
+          id,
+          isDefault,
+          query,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: PageBeanFieldConfigurationDetails;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueFieldConfigurationsService.getAllFieldConfigurations.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns a [paginated](#pagination) list of field configuration schemes.
+   *
+   * Only field configuration schemes used in classic projects are returned.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "isLast": true,
+   *   "maxResults": 10,
+   *   "startAt": 0,
+   *   "total": 3,
+   *   "values": [
+   *     {
+   *       "id": "10000",
+   *       "name": "Field Configuration Scheme for Bugs",
+   *       "description": "This field configuration scheme is for bugs only."
+   *     },
+   *     {
+   *       "id": "10001",
+   *       "name": "Field Configuration Scheme for software related projects",
+   *       "description": "We can use this one for software projects."
+   *     },
+   *     {
+   *       "id": "10002",
+   *       "name": "Field Configuration Scheme for Epics",
+   *       "description": "Use this one for Epic issue type."
+   *     }
+   *   ]
+   * }
+   * @path {GET} /rest/api/3/fieldconfigurationscheme
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta read:field-configuration-scheme:jira
+   */
+  getAllFieldConfigurationSchemes({
+    startAt,
+    maxResults,
+    id,
+  }: {
+    /** The index of the first item to return in a page of results (page offset). */
+    startAt?: number;
+    /** The maximum number of items to return per page. */
+    maxResults?: number;
+    /**
+     * The list of field configuration scheme IDs. To include multiple IDs, provide an
+     * ampersand-separated list. For example, `id=10000&id=10001`.
+     */
+    id?: number[];
+  }): Promise<PageBeanFieldConfigurationScheme> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/fieldconfigurationscheme",
+        method: "GET",
+        query: {
+          startAt,
+          maxResults,
+          id,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: PageBeanFieldConfigurationScheme;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueFieldConfigurationsService.getAllFieldConfigurationSchemes.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns a [paginated](#pagination) list of all fields for a configuration.
+   *
+   * Only the fields from configurations used in company-managed (classic) projects
+   * are returned.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "isLast": true,
+   *   "maxResults": 50,
+   *   "startAt": 0,
+   *   "total": 2,
+   *   "values": [
+   *     {
+   *       "description": "For example operating system, software platform and/or
+   * hardware specifications (include as appropriate for the issue).",
+   *       "id": "environment",
+   *       "isHidden": false,
+   *       "isRequired": false
+   *     },
+   *     {
+   *       "id": "description",
+   *       "isHidden": false,
+   *       "isRequired": false
+   *     }
+   *   ]
+   * }
+   * @path {GET} /rest/api/3/fieldconfiguration/{id}/fields
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta read:field-configuration:jira
+   */
+  getFieldConfigurationItems({
+    id,
+    startAt,
+    maxResults,
+  }: {
+    /** The ID of the field configuration. */
+    id: number;
+    /** The index of the first item to return in a page of results (page offset). */
+    startAt?: number;
+    /** The maximum number of items to return per page. */
+    maxResults?: number;
+  }): Promise<PageBeanFieldConfigurationItem> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/fieldconfiguration/{id}/fields",
+        method: "GET",
+        pathParams: {
+          id,
+        },
+        query: {
+          startAt,
+          maxResults,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: PageBeanFieldConfigurationItem;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueFieldConfigurationsService.getFieldConfigurationItems.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns a [paginated](#pagination) list of field configuration issue type items.
+   *
+   * Only items used in classic projects are returned.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "isLast": true,
+   *   "maxResults": 100,
+   *   "startAt": 0,
+   *   "total": 5,
+   *   "values": [
+   *     {
+   *       "fieldConfigurationSchemeId": "10020",
+   *       "issueTypeId": "10000",
+   *       "fieldConfigurationId": "10010"
+   *     },
+   *     {
+   *       "fieldConfigurationSchemeId": "10020",
+   *       "issueTypeId": "10001",
+   *       "fieldConfigurationId": "10010"
+   *     },
+   *     {
+   *       "fieldConfigurationSchemeId": "10021",
+   *       "issueTypeId": "10002",
+   *       "fieldConfigurationId": "10000"
+   *     },
+   *     {
+   *       "fieldConfigurationSchemeId": "10022",
+   *       "issueTypeId": "default",
+   *       "fieldConfigurationId": "10011"
+   *     },
+   *     {
+   *       "fieldConfigurationSchemeId": "10023",
+   *       "issueTypeId": "default",
+   *       "fieldConfigurationId": "10000"
+   *     }
+   *   ]
+   * }
+   * @path {GET} /rest/api/3/fieldconfigurationscheme/mapping
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta read:field-configuration-scheme:jira
+   */
+  getFieldConfigurationSchemeMappings({
+    startAt,
+    maxResults,
+    fieldConfigurationSchemeId,
+  }: {
+    /** The index of the first item to return in a page of results (page offset). */
+    startAt?: number;
+    /** The maximum number of items to return per page. */
+    maxResults?: number;
+    /**
+     * The list of field configuration scheme IDs. To include multiple field
+     * configuration schemes separate IDs with ampersand:
+     * `fieldConfigurationSchemeId=10000&fieldConfigurationSchemeId=10001`.
+     */
+    fieldConfigurationSchemeId?: number[];
+  }): Promise<PageBeanFieldConfigurationIssueTypeItem> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/fieldconfigurationscheme/mapping",
+        method: "GET",
+        query: {
+          startAt,
+          maxResults,
+          fieldConfigurationSchemeId,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: PageBeanFieldConfigurationIssueTypeItem;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueFieldConfigurationsService.getFieldConfigurationSchemeMappings.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Returns a [paginated](#pagination) list of field configuration schemes and, for
+   * each scheme, a list of the projects that use it.
+   *
+   * The list is sorted by field configuration scheme ID. The first item contains
+   * the list of project IDs assigned to the default field configuration scheme.
+   *
+   * Only field configuration schemes used in classic projects are returned.
+   *
+   * **[Permissions](#permissions) required:** *Administer Jira* [global
+   * permission](https://confluence.atlassian.com/x/x4dKLg).
+   *
+   * @returns Returned if the request is successful.
+   *
+   * example: {
+   *   "isLast": true,
+   *   "maxResults": 50,
+   *   "startAt": 0,
+   *   "total": 5,
+   *   "values": [
+   *     {
+   *       "projectIds": [
+   *         "10",
+   *         "11"
+   *       ]
+   *     },
+   *     {
+   *       "fieldConfigurationScheme": {
+   *         "id": "10002",
+   *         "name": "Field Configuration Scheme for software related projects",
+   *         "description": "We can use this one for software projects."
+   *       },
+   *       "projectIds": [
+   *         "12",
+   *         "13",
+   *         "14"
+   *       ]
+   *     }
+   *   ]
+   * }
+   * @path {GET} /rest/api/3/fieldconfigurationscheme/project
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta read:field-configuration-scheme:jira
+   */
+  getFieldConfigurationSchemeProjectMapping({
+    startAt,
+    maxResults,
+    projectId,
+  }: {
+    /** The index of the first item to return in a page of results (page offset). */
+    startAt?: number;
+    /** The maximum number of items to return per page. */
+    maxResults?: number;
+    /**
+     * The list of project IDs. To include multiple projects, separate IDs with
+     * ampersand: `projectId=10000&projectId=10001`.
+     */
+    projectId: number[];
+  }): Promise<PageBeanFieldConfigurationSchemeProjects> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/fieldconfigurationscheme/project",
+        method: "GET",
+        query: {
+          startAt,
+          maxResults,
+          projectId,
+        },
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          200: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 200;
+          mediaType: "application/json";
+          body: PageBeanFieldConfigurationSchemeProjects;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueFieldConfigurationsService.getFieldConfigurationSchemeProjectMapping.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Removes issue types from the field configuration scheme.
+   *
+   * This operation can only modify field configuration schemes used in
+   * company-managed (classic) projects.
+   *
+   * **[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/fieldconfigurationscheme/{id}/mapping/delete
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:field-configuration-scheme:jira
+   */
+  removeIssueTypesFromGlobalFieldConfigurationScheme({
+    id,
+    issueTypeIdsToRemove,
+  }: {
+    /** The ID of the field configuration scheme. */
+    id: number;
+    /**
+     * The issue type IDs to remove.
+     *
+     * @example {
+     *     "issueTypeIds": [
+     *         "10000",
+     *         "10001",
+     *         "10002"
+     *     ]
+     * }
+     */
+    issueTypeIdsToRemove: IssueTypeIdsToRemove;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/fieldconfigurationscheme/{id}/mapping/delete",
+        method: "POST",
+        pathParams: {
+          id,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: issueTypeIdsToRemove,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          204: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 204;
+          mediaType: "application/json";
+          body: void;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueFieldConfigurationsService.removeIssueTypesFromGlobalFieldConfigurationScheme.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Assigns issue types to field configurations on field configuration scheme.
+   *
+   * This operation can only modify field configuration schemes used in
+   * company-managed (classic) projects.
+   *
+   * **[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/fieldconfigurationscheme/{id}/mapping
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:field-configuration-scheme:jira, read:field-configuration-scheme:jira
+   */
+  setFieldConfigurationSchemeMapping({
+    id,
+    associateFieldConfigurationsWithIssueTypesRequest,
+  }: {
+    /** The ID of the field configuration scheme. */
+    id: number;
+    /**
+     * @example {
+     *     "mappings": [
+     *         {
+     *             "fieldConfigurationId": "10000",
+     *             "issueTypeId": "default"
+     *         },
+     *         {
+     *             "fieldConfigurationId": "10002",
+     *             "issueTypeId": "10001"
+     *         },
+     *         {
+     *             "fieldConfigurationId": "10001",
+     *             "issueTypeId": "10002"
+     *         }
+     *     ]
+     * }
+     */
+    associateFieldConfigurationsWithIssueTypesRequest: AssociateFieldConfigurationsWithIssueTypesRequest;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/fieldconfigurationscheme/{id}/mapping",
+        method: "PUT",
+        pathParams: {
+          id,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: associateFieldConfigurationsWithIssueTypesRequest,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          204: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 204;
+          mediaType: "application/json";
+          body: void;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueFieldConfigurationsService.setFieldConfigurationSchemeMapping.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Updates a field configuration. The name and the description provided in the
+   * request override the existing values.
+   *
+   * This operation can only update configurations used in company-managed (classic)
+   * projects.
+   *
+   * **[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/fieldconfiguration/{id}
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:field-configuration:jira
+   */
+  updateFieldConfiguration({
+    id,
+    fieldConfigurationDetails,
+  }: {
+    /** The ID of the field configuration. */
+    id: number;
+    /**
+     * @example {
+     *     "description": "A brand new description",
+     *     "name": "My Modified Field Configuration"
+     * }
+     */
+    fieldConfigurationDetails: FieldConfigurationDetails;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/fieldconfiguration/{id}",
+        method: "PUT",
+        pathParams: {
+          id,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: fieldConfigurationDetails,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          204: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 204;
+          mediaType: "application/json";
+          body: void;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueFieldConfigurationsService.updateFieldConfiguration.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Updates fields in a field configuration. The properties of the field
+   * configuration fields provided override the existing values.
+   *
+   * This operation can only update field configurations used in company-managed
+   * (classic) projects.
+   *
+   * The operation can set the renderer for text fields to the default text renderer
+   * (`text-renderer`) or wiki style renderer (`wiki-renderer`). However, the
+   * renderer cannot be updated for fields using the autocomplete renderer
+   * (`autocomplete-renderer`).
+   *
+   * **[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/fieldconfiguration/{id}/fields
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:field-configuration:jira
+   */
+  updateFieldConfigurationItems({
+    id,
+    fieldConfigurationItemsDetails,
+  }: {
+    /** The ID of the field configuration. */
+    id: number;
+    /**
+     * @example {
+     *     "fieldConfigurationItems": [
+     *         {
+     *             "description": "The new description of this item.",
+     *             "id": "customfield_10012",
+     *             "isHidden": false
+     *         },
+     *         {
+     *             "id": "customfield_10011",
+     *             "isRequired": true
+     *         },
+     *         {
+     *             "description": "Another new description.",
+     *             "id": "customfield_10010",
+     *             "isHidden": false,
+     *             "isRequired": false,
+     *             "renderer": "wiki-renderer"
+     *         }
+     *     ]
+     * }
+     */
+    fieldConfigurationItemsDetails: FieldConfigurationItemsDetails;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/fieldconfiguration/{id}/fields",
+        method: "PUT",
+        pathParams: {
+          id,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: fieldConfigurationItemsDetails,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          204: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 204;
+          mediaType: "application/json";
+          body: void;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueFieldConfigurationsService.updateFieldConfigurationItems.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  /**
+   * Updates a field configuration scheme.
+   *
+   * This operation can only update field configuration schemes used in
+   * company-managed (classic) projects.
+   *
+   * **[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/fieldconfigurationscheme/{id}
+   * @scopes-current manage:jira-configuration
+   * @scopes-beta write:field-configuration-scheme:jira
+   */
+  updateFieldConfigurationScheme({
+    id,
+    updateFieldConfigurationSchemeDetails,
+  }: {
+    /** The ID of the field configuration scheme. */
+    id: number;
+    /**
+     * The details of the field configuration scheme.
+     *
+     * @example {
+     *     "description": "We can use this one for software projects.",
+     *     "name": "Field Configuration Scheme for software related projects"
+     * }
+     */
+    updateFieldConfigurationSchemeDetails: UpdateFieldConfigurationSchemeDetails;
+  }): Promise<void> {
+    return this.getClientInstance()
+      .request({
+        path: "/rest/api/3/fieldconfigurationscheme/{id}",
+        method: "PUT",
+        pathParams: {
+          id,
+        },
+        headers: {
+          "Content-Type": "application/json",
+        },
+        body: updateFieldConfigurationSchemeDetails,
+      })
+      .then(
+        this.getClientInstance().responseHandler({
+          204: {
+            "application/json": "json",
+          },
+        }),
+      )
+      .then(
+        commonHttpClient.castResponse<{
+          status: 204;
+          mediaType: "application/json";
+          body: void;
+        }>(),
+      )
+      .then(
+        validationSchemaStorage.validator(
+          "IssueFieldConfigurationsService.updateFieldConfigurationScheme.response",
+        ),
+      )
+      .then(commonHttpClient.getBody);
+  }
+  static initialize() {
+    validationSchemaStorage.registerExtensible(
+      "IssueFieldConfigurationsService.getAllFieldConfigurations.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy(
+            "PageBeanFieldConfigurationDetails",
+          ),
+        })
+        .describe(
+          "IssueFieldConfigurationsService.getAllFieldConfigurations.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueFieldConfigurationsService.createFieldConfiguration.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("FieldConfiguration"),
+        })
+        .describe(
+          "IssueFieldConfigurationsService.createFieldConfiguration.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueFieldConfigurationsService.updateFieldConfiguration.response",
+      z
+        .object({
+          status: z.literal(204),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe(
+          "IssueFieldConfigurationsService.updateFieldConfiguration.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueFieldConfigurationsService.deleteFieldConfiguration.response",
+      z
+        .object({
+          status: z.literal(204),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe(
+          "IssueFieldConfigurationsService.deleteFieldConfiguration.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueFieldConfigurationsService.getFieldConfigurationItems.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("PageBeanFieldConfigurationItem"),
+        })
+        .describe(
+          "IssueFieldConfigurationsService.getFieldConfigurationItems.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueFieldConfigurationsService.updateFieldConfigurationItems.response",
+      z
+        .object({
+          status: z.literal(204),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe(
+          "IssueFieldConfigurationsService.updateFieldConfigurationItems.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueFieldConfigurationsService.getAllFieldConfigurationSchemes.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy(
+            "PageBeanFieldConfigurationScheme",
+          ),
+        })
+        .describe(
+          "IssueFieldConfigurationsService.getAllFieldConfigurationSchemes.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueFieldConfigurationsService.createFieldConfigurationScheme.response",
+      z
+        .object({
+          status: z.literal(201),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy("FieldConfigurationScheme"),
+        })
+        .describe(
+          "IssueFieldConfigurationsService.createFieldConfigurationScheme.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueFieldConfigurationsService.updateFieldConfigurationScheme.response",
+      z
+        .object({
+          status: z.literal(204),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe(
+          "IssueFieldConfigurationsService.updateFieldConfigurationScheme.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueFieldConfigurationsService.deleteFieldConfigurationScheme.response",
+      z
+        .object({
+          status: z.literal(204),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe(
+          "IssueFieldConfigurationsService.deleteFieldConfigurationScheme.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueFieldConfigurationsService.setFieldConfigurationSchemeMapping.response",
+      z
+        .object({
+          status: z.literal(204),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe(
+          "IssueFieldConfigurationsService.setFieldConfigurationSchemeMapping.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueFieldConfigurationsService.removeIssueTypesFromGlobalFieldConfigurationScheme.response",
+      z
+        .object({
+          status: z.literal(204),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe(
+          "IssueFieldConfigurationsService.removeIssueTypesFromGlobalFieldConfigurationScheme.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueFieldConfigurationsService.getFieldConfigurationSchemeMappings.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy(
+            "PageBeanFieldConfigurationIssueTypeItem",
+          ),
+        })
+        .describe(
+          "IssueFieldConfigurationsService.getFieldConfigurationSchemeMappings.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueFieldConfigurationsService.getFieldConfigurationSchemeProjectMapping.response",
+      z
+        .object({
+          status: z.literal(200),
+          mediaType: z.literal("application/json"),
+          body: validationSchemaStorage.lazy(
+            "PageBeanFieldConfigurationSchemeProjects",
+          ),
+        })
+        .describe(
+          "IssueFieldConfigurationsService.getFieldConfigurationSchemeProjectMapping.response",
+        ),
+    );
+    validationSchemaStorage.registerExtensible(
+      "IssueFieldConfigurationsService.assignFieldConfigurationSchemeToProject.response",
+      z
+        .object({
+          status: z.literal(204),
+          mediaType: z.literal("application/json"),
+          body: z.unknown(),
+        })
+        .describe(
+          "IssueFieldConfigurationsService.assignFieldConfigurationSchemeToProject.response",
+        ),
+    );
+    validationSchemaStorage.registerOnce([
+      registerIssueFieldConfigurationsValidationSchemas,
+    ]);
+  }
+}