@resolution/jira-api-client 0.5.2 → 0.5.4

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

@@ -1,4 +1,4 @@
-import { CommonHttpService } from "../core/CommonHttpService";
+import { CommonHttpService } from "../../core/CommonHttpService";
 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, type UpdateFieldConfigurationSchemeDetails } from "../models/issueFieldConfigurations";
 /**
  * This resource represents issue field configurations. Use it to get, set, and
@@ -18,14 +18,16 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
      * @returns Returned if the request is successful.
-     * @path {PUT} /rest/api/3/fieldconfigurationscheme/project
+     * @path PUT `/rest/api/3/fieldconfigurationscheme/project`
      * @scopes-current manage:jira-configuration
      * @scopes-beta write:field-configuration-scheme:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-project-put
+     * @param params
      */
     assignFieldConfigurationSchemeToProject: ({ fieldConfigurationSchemeProjectAssociation, }: {
         /**
-         * @example {
+         * @example
+         * {
          *     "fieldConfigurationSchemeId": "10000",
          *     "projectId": "10000"
          * }
@@ -45,19 +47,24 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "description": "My field configuration description",
      *   "id": 10001,
      *   "name": "My Field Configuration"
      * }
-     * @path {POST} /rest/api/3/fieldconfiguration
+     * ```
+     * @path POST `/rest/api/3/fieldconfiguration`
      * @scopes-current manage:jira-configuration
      * @scopes-beta read:field-configuration:jira, write:field-configuration:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfiguration-post
+     * @param params
      */
     createFieldConfiguration: ({ fieldConfigurationDetails, }: {
         /**
-         * @example {
+         * @example
+         * {
          *     "description": "My field configuration description",
          *     "name": "My Field Configuration"
          * }
@@ -75,21 +82,26 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
+     *   "description": "We can use this one for software projects.",
      *   "id": "10002",
-     *   "name": "Field Configuration Scheme for software related projects",
-     *   "description": "We can use this one for software projects."
+     *   "name": "Field Configuration Scheme for software related projects"
      * }
-     * @path {POST} /rest/api/3/fieldconfigurationscheme
+     * ```
+     * @path POST `/rest/api/3/fieldconfigurationscheme`
      * @scopes-current manage:jira-configuration
      * @scopes-beta write:field-configuration-scheme:jira, read:field-configuration-scheme:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-post
+     * @param params
      */
     createFieldConfigurationScheme: ({ updateFieldConfigurationSchemeDetails, }: {
         /**
          * The details of the field configuration scheme.
          *
-         * @example {
+         * @example
+         * {
          *     "description": "We can use this one for software projects.",
          *     "name": "Field Configuration Scheme for software related projects"
          * }
@@ -106,10 +118,11 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
      * @returns Returned if the request is successful.
-     * @path {DELETE} /rest/api/3/fieldconfiguration/{id}
+     * @path DELETE `/rest/api/3/fieldconfiguration/{id}`
      * @scopes-current manage:jira-configuration
      * @scopes-beta delete:field-configuration:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfiguration-id-delete
+     * @param params
      */
     deleteFieldConfiguration: ({ id, }: {
         /** The ID of the field configuration. */
@@ -125,10 +138,11 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
      * @returns Returned if the request is successful.
-     * @path {DELETE} /rest/api/3/fieldconfigurationscheme/{id}
+     * @path DELETE `/rest/api/3/fieldconfigurationscheme/{id}`
      * @scopes-current manage:jira-configuration
      * @scopes-beta delete:field-configuration-scheme:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-id-delete
+     * @param params
      */
     deleteFieldConfigurationScheme: ({ id, }: {
         /** The ID of the field configuration scheme. */
@@ -151,7 +165,9 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": true,
      *   "maxResults": 50,
      *   "startAt": 0,
@@ -170,10 +186,12 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/fieldconfiguration
+     * ```
+     * @path GET `/rest/api/3/fieldconfiguration`
      * @scopes-current manage:jira-configuration
      * @scopes-beta read:field-configuration:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfiguration-get
+     * @param params
      */
     getAllFieldConfigurations: ({ startAt, maxResults, id, isDefault, query, }?: {
         /** The index of the first item to return in a page of results (page offset). */
@@ -203,7 +221,9 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": true,
      *   "maxResults": 10,
      *   "startAt": 0,
@@ -226,10 +246,12 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/fieldconfigurationscheme
+     * ```
+     * @path GET `/rest/api/3/fieldconfigurationscheme`
      * @scopes-current manage:jira-configuration
      * @scopes-beta read:field-configuration-scheme:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-get
+     * @param params
      */
     getAllFieldConfigurationSchemes: ({ startAt, maxResults, id, }?: {
         /** The index of the first item to return in a page of results (page offset). */
@@ -253,15 +275,16 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * 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).",
+     *       "description": "For example operating system, software platform and/or hardware specifications (include as appropriate for the issue).",
      *       "id": "environment",
      *       "isHidden": false,
      *       "isRequired": false
@@ -273,10 +296,12 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/fieldconfiguration/{id}/fields
+     * ```
+     * @path GET `/rest/api/3/fieldconfiguration/{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-issue-field-configurations#api-rest-api-3-fieldconfiguration-id-fields-get
+     * @param params
      */
     getFieldConfigurationItems: ({ id, startAt, maxResults, }: {
         /** The ID of the field configuration. */
@@ -296,7 +321,9 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": true,
      *   "maxResults": 100,
      *   "startAt": 0,
@@ -329,10 +356,12 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/fieldconfigurationscheme/mapping
+     * ```
+     * @path GET `/rest/api/3/fieldconfigurationscheme/mapping`
      * @scopes-current manage:jira-configuration
      * @scopes-beta read:field-configuration-scheme:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-mapping-get
+     * @param params
      */
     getFieldConfigurationSchemeMappings: ({ startAt, maxResults, fieldConfigurationSchemeId, }?: {
         /** The index of the first item to return in a page of results (page offset). */
@@ -360,7 +389,9 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": true,
      *   "maxResults": 50,
      *   "startAt": 0,
@@ -386,10 +417,12 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/fieldconfigurationscheme/project
+     * ```
+     * @path GET `/rest/api/3/fieldconfigurationscheme/project`
      * @scopes-current manage:jira-configuration
      * @scopes-beta read:field-configuration-scheme:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-project-get
+     * @param params
      */
     getFieldConfigurationSchemeProjectMapping: ({ startAt, maxResults, projectId, }: {
         /** The index of the first item to return in a page of results (page offset). */
@@ -412,10 +445,11 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
      * @returns Returned if the request is successful.
-     * @path {POST} /rest/api/3/fieldconfigurationscheme/{id}/mapping/delete
+     * @path POST `/rest/api/3/fieldconfigurationscheme/{id}/mapping/delete`
      * @scopes-current manage:jira-configuration
      * @scopes-beta write:field-configuration-scheme:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-id-mapping-delete-post
+     * @param params
      */
     removeIssueTypesFromGlobalFieldConfigurationScheme: ({ id, issueTypeIdsToRemove, }: {
         /** The ID of the field configuration scheme. */
@@ -423,7 +457,8 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
         /**
          * The issue type IDs to remove.
          *
-         * @example {
+         * @example
+         * {
          *     "issueTypeIds": [
          *         "10000",
          *         "10001",
@@ -443,16 +478,18 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
      * @returns Returned if the request is successful.
-     * @path {PUT} /rest/api/3/fieldconfigurationscheme/{id}/mapping
+     * @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
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-id-mapping-put
+     * @param params
      */
     setFieldConfigurationSchemeMapping: ({ id, associateFieldConfigurationsWithIssueTypesRequest, }: {
         /** The ID of the field configuration scheme. */
         id: number;
         /**
-         * @example {
+         * @example
+         * {
          *     "mappings": [
          *         {
          *             "fieldConfigurationId": "10000",
@@ -482,16 +519,18 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
      * @returns Returned if the request is successful.
-     * @path {PUT} /rest/api/3/fieldconfiguration/{id}
+     * @path PUT `/rest/api/3/fieldconfiguration/{id}`
      * @scopes-current manage:jira-configuration
      * @scopes-beta write:field-configuration:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfiguration-id-put
+     * @param params
      */
     updateFieldConfiguration: ({ id, fieldConfigurationDetails, }: {
         /** The ID of the field configuration. */
         id: number;
         /**
-         * @example {
+         * @example
+         * {
          *     "description": "A brand new description",
          *     "name": "My Modified Field Configuration"
          * }
@@ -514,16 +553,18 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
      * @returns Returned if the request is successful.
-     * @path {PUT} /rest/api/3/fieldconfiguration/{id}/fields
+     * @path PUT `/rest/api/3/fieldconfiguration/{id}/fields`
      * @scopes-current manage:jira-configuration
      * @scopes-beta write:field-configuration:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfiguration-id-fields-put
+     * @param params
      */
     updateFieldConfigurationItems: ({ id, fieldConfigurationItemsDetails, }: {
         /** The ID of the field configuration. */
         id: number;
         /**
-         * @example {
+         * @example
+         * {
          *     "fieldConfigurationItems": [
          *         {
          *             "description": "The new description of this item.",
@@ -556,10 +597,11 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
      * @returns Returned if the request is successful.
-     * @path {PUT} /rest/api/3/fieldconfigurationscheme/{id}
+     * @path PUT `/rest/api/3/fieldconfigurationscheme/{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-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-id-put
+     * @param params
      */
     updateFieldConfigurationScheme: ({ id, updateFieldConfigurationSchemeDetails, }: {
         /** The ID of the field configuration scheme. */
@@ -567,7 +609,8 @@ export declare class IssueFieldConfigurationsService extends CommonHttpService {
         /**
          * The details of the field configuration scheme.
          *
-         * @example {
+         * @example
+         * {
          *     "description": "We can use this one for software projects.",
          *     "name": "Field Configuration Scheme for software related projects"
          * }

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

@@ -5,8 +5,8 @@ exports.IssueFieldConfigurationsService = void 0;
 // This file is generated by "api-typescript-generator".
 // To update this file run "yarn build:openapi".
 const zod_1 = require("zod");
-const commonHttpClient = require("../core/CommonHttpClient");
-const CommonHttpService_1 = require("../core/CommonHttpService");
+const commonHttpClient = require("../../core/CommonHttpClient");
+const CommonHttpService_1 = require("../../core/CommonHttpService");
 const issueFieldConfigurations_1 = require("../models/issueFieldConfigurations");
 const validationSchemaStorage_1 = require("../validationSchemaStorage");
 /**
@@ -29,10 +29,11 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          * permission](https://confluence.atlassian.com/x/x4dKLg).
          *
          * @returns Returned if the request is successful.
-         * @path {PUT} /rest/api/3/fieldconfigurationscheme/project
+         * @path PUT `/rest/api/3/fieldconfigurationscheme/project`
          * @scopes-current manage:jira-configuration
          * @scopes-beta write:field-configuration-scheme:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-project-put
+         * @param params
          */
         this.assignFieldConfigurationSchemeToProject = ({ fieldConfigurationSchemeProjectAssociation, }) => {
             return this.getClientInstance()
@@ -66,15 +67,19 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "description": "My field configuration description",
          *   "id": 10001,
          *   "name": "My Field Configuration"
          * }
-         * @path {POST} /rest/api/3/fieldconfiguration
+         * ```
+         * @path POST `/rest/api/3/fieldconfiguration`
          * @scopes-current manage:jira-configuration
          * @scopes-beta read:field-configuration:jira, write:field-configuration:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfiguration-post
+         * @param params
          */
         this.createFieldConfiguration = ({ fieldConfigurationDetails, }) => {
             return this.getClientInstance()
@@ -106,15 +111,19 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
+         *   "description": "We can use this one for software projects.",
          *   "id": "10002",
-         *   "name": "Field Configuration Scheme for software related projects",
-         *   "description": "We can use this one for software projects."
+         *   "name": "Field Configuration Scheme for software related projects"
          * }
-         * @path {POST} /rest/api/3/fieldconfigurationscheme
+         * ```
+         * @path POST `/rest/api/3/fieldconfigurationscheme`
          * @scopes-current manage:jira-configuration
          * @scopes-beta write:field-configuration-scheme:jira, read:field-configuration-scheme:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-post
+         * @param params
          */
         this.createFieldConfigurationScheme = ({ updateFieldConfigurationSchemeDetails, }) => {
             return this.getClientInstance()
@@ -145,10 +154,11 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          * permission](https://confluence.atlassian.com/x/x4dKLg).
          *
          * @returns Returned if the request is successful.
-         * @path {DELETE} /rest/api/3/fieldconfiguration/{id}
+         * @path DELETE `/rest/api/3/fieldconfiguration/{id}`
          * @scopes-current manage:jira-configuration
          * @scopes-beta delete:field-configuration:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfiguration-id-delete
+         * @param params
          */
         this.deleteFieldConfiguration = ({ id, }) => {
             return this.getClientInstance()
@@ -178,10 +188,11 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          * permission](https://confluence.atlassian.com/x/x4dKLg).
          *
          * @returns Returned if the request is successful.
-         * @path {DELETE} /rest/api/3/fieldconfigurationscheme/{id}
+         * @path DELETE `/rest/api/3/fieldconfigurationscheme/{id}`
          * @scopes-current manage:jira-configuration
          * @scopes-beta delete:field-configuration-scheme:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-id-delete
+         * @param params
          */
         this.deleteFieldConfigurationScheme = ({ id, }) => {
             return this.getClientInstance()
@@ -218,7 +229,9 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "isLast": true,
          *   "maxResults": 50,
          *   "startAt": 0,
@@ -237,10 +250,12 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          *     }
          *   ]
          * }
-         * @path {GET} /rest/api/3/fieldconfiguration
+         * ```
+         * @path GET `/rest/api/3/fieldconfiguration`
          * @scopes-current manage:jira-configuration
          * @scopes-beta read:field-configuration:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfiguration-get
+         * @param params
          */
         this.getAllFieldConfigurations = ({ startAt, maxResults, id, isDefault, query, } = {}) => {
             return this.getClientInstance()
@@ -274,7 +289,9 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "isLast": true,
          *   "maxResults": 10,
          *   "startAt": 0,
@@ -297,10 +314,12 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          *     }
          *   ]
          * }
-         * @path {GET} /rest/api/3/fieldconfigurationscheme
+         * ```
+         * @path GET `/rest/api/3/fieldconfigurationscheme`
          * @scopes-current manage:jira-configuration
          * @scopes-beta read:field-configuration-scheme:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-get
+         * @param params
          */
         this.getAllFieldConfigurationSchemes = ({ startAt, maxResults, id, } = {}) => {
             return this.getClientInstance()
@@ -333,15 +352,16 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * 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).",
+         *       "description": "For example operating system, software platform and/or hardware specifications (include as appropriate for the issue).",
          *       "id": "environment",
          *       "isHidden": false,
          *       "isRequired": false
@@ -353,10 +373,12 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          *     }
          *   ]
          * }
-         * @path {GET} /rest/api/3/fieldconfiguration/{id}/fields
+         * ```
+         * @path GET `/rest/api/3/fieldconfiguration/{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-issue-field-configurations#api-rest-api-3-fieldconfiguration-id-fields-get
+         * @param params
          */
         this.getFieldConfigurationItems = ({ id, startAt, maxResults, }) => {
             return this.getClientInstance()
@@ -390,7 +412,9 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "isLast": true,
          *   "maxResults": 100,
          *   "startAt": 0,
@@ -423,10 +447,12 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          *     }
          *   ]
          * }
-         * @path {GET} /rest/api/3/fieldconfigurationscheme/mapping
+         * ```
+         * @path GET `/rest/api/3/fieldconfigurationscheme/mapping`
          * @scopes-current manage:jira-configuration
          * @scopes-beta read:field-configuration-scheme:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-mapping-get
+         * @param params
          */
         this.getFieldConfigurationSchemeMappings = ({ startAt, maxResults, fieldConfigurationSchemeId, } = {}) => {
             return this.getClientInstance()
@@ -462,7 +488,9 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "isLast": true,
          *   "maxResults": 50,
          *   "startAt": 0,
@@ -488,10 +516,12 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          *     }
          *   ]
          * }
-         * @path {GET} /rest/api/3/fieldconfigurationscheme/project
+         * ```
+         * @path GET `/rest/api/3/fieldconfigurationscheme/project`
          * @scopes-current manage:jira-configuration
          * @scopes-beta read:field-configuration-scheme:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-project-get
+         * @param params
          */
         this.getFieldConfigurationSchemeProjectMapping = ({ startAt, maxResults, projectId, }) => {
             return this.getClientInstance()
@@ -523,10 +553,11 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          * permission](https://confluence.atlassian.com/x/x4dKLg).
          *
          * @returns Returned if the request is successful.
-         * @path {POST} /rest/api/3/fieldconfigurationscheme/{id}/mapping/delete
+         * @path POST `/rest/api/3/fieldconfigurationscheme/{id}/mapping/delete`
          * @scopes-current manage:jira-configuration
          * @scopes-beta write:field-configuration-scheme:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-id-mapping-delete-post
+         * @param params
          */
         this.removeIssueTypesFromGlobalFieldConfigurationScheme = ({ id, issueTypeIdsToRemove, }) => {
             return this.getClientInstance()
@@ -560,10 +591,11 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          * permission](https://confluence.atlassian.com/x/x4dKLg).
          *
          * @returns Returned if the request is successful.
-         * @path {PUT} /rest/api/3/fieldconfigurationscheme/{id}/mapping
+         * @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
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-id-mapping-put
+         * @param params
          */
         this.setFieldConfigurationSchemeMapping = ({ id, associateFieldConfigurationsWithIssueTypesRequest, }) => {
             return this.getClientInstance()
@@ -598,10 +630,11 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          * permission](https://confluence.atlassian.com/x/x4dKLg).
          *
          * @returns Returned if the request is successful.
-         * @path {PUT} /rest/api/3/fieldconfiguration/{id}
+         * @path PUT `/rest/api/3/fieldconfiguration/{id}`
          * @scopes-current manage:jira-configuration
          * @scopes-beta write:field-configuration:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfiguration-id-put
+         * @param params
          */
         this.updateFieldConfiguration = ({ id, fieldConfigurationDetails, }) => {
             return this.getClientInstance()
@@ -641,10 +674,11 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          * permission](https://confluence.atlassian.com/x/x4dKLg).
          *
          * @returns Returned if the request is successful.
-         * @path {PUT} /rest/api/3/fieldconfiguration/{id}/fields
+         * @path PUT `/rest/api/3/fieldconfiguration/{id}/fields`
          * @scopes-current manage:jira-configuration
          * @scopes-beta write:field-configuration:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations#api-rest-api-3-fieldconfiguration-id-fields-put
+         * @param params
          */
         this.updateFieldConfigurationItems = ({ id, fieldConfigurationItemsDetails, }) => {
             return this.getClientInstance()
@@ -678,10 +712,11 @@ class IssueFieldConfigurationsService extends CommonHttpService_1.CommonHttpServ
          * permission](https://confluence.atlassian.com/x/x4dKLg).
          *
          * @returns Returned if the request is successful.
-         * @path {PUT} /rest/api/3/fieldconfigurationscheme/{id}
+         * @path PUT `/rest/api/3/fieldconfigurationscheme/{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-issue-field-configurations#api-rest-api-3-fieldconfigurationscheme-id-put
+         * @param params
          */
         this.updateFieldConfigurationScheme = ({ id, updateFieldConfigurationSchemeDetails, }) => {
             return this.getClientInstance()