@resolution/jira-api-client 0.5.2 → 0.5.3

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

@@ -19,14 +19,16 @@ export declare class WorkflowSchemeProjectAssociationsService extends CommonHttp
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
      * @returns Returned if the request is successful.
-     * @path {PUT} /rest/api/3/workflowscheme/project
+     * @path PUT `/rest/api/3/workflowscheme/project`
      * @scopes-current manage:jira-configuration
      * @scopes-beta write:workflow-scheme:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-project-associations#api-rest-api-3-workflowscheme-project-put
+     * @param params
      */
     assignSchemeToProject: ({ workflowSchemeProjectAssociation, }: {
         /**
-         * @example {
+         * @example
+         * {
          *     "projectId": "10001",
          *     "workflowSchemeId": "10032"
          * }
@@ -48,7 +50,9 @@ export declare class WorkflowSchemeProjectAssociationsService extends CommonHttp
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "values": [
      *     {
      *       "projectIds": [
@@ -64,18 +68,17 @@ export declare class WorkflowSchemeProjectAssociationsService extends CommonHttp
      *           "10001": "builds workflow"
      *         },
      *         "name": "Example workflow scheme",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
      *       }
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/workflowscheme/project
+     * ```
+     * @path GET `/rest/api/3/workflowscheme/project`
      * @scopes-current manage:jira-configuration
-     * @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:application-role:jira,
-     * read:avatar:jira, read:group:jira, read:issue-type:jira,
-     * read:project-category:jira, read:project:jira, read:user:jira
+     * @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-project-associations#api-rest-api-3-workflowscheme-project-get
+     * @param params
      */
     getWorkflowSchemeProjectAssociations: ({ projectId, }: {
         /**

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

@@ -30,10 +30,11 @@ class WorkflowSchemeProjectAssociationsService extends CommonHttpService_1.Commo
          * permission](https://confluence.atlassian.com/x/x4dKLg).
          *
          * @returns Returned if the request is successful.
-         * @path {PUT} /rest/api/3/workflowscheme/project
+         * @path PUT `/rest/api/3/workflowscheme/project`
          * @scopes-current manage:jira-configuration
          * @scopes-beta write:workflow-scheme:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-project-associations#api-rest-api-3-workflowscheme-project-put
+         * @param params
          */
         this.assignSchemeToProject = ({ workflowSchemeProjectAssociation, }) => {
             return this.getClientInstance()
@@ -69,7 +70,9 @@ class WorkflowSchemeProjectAssociationsService extends CommonHttpService_1.Commo
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "values": [
          *     {
          *       "projectIds": [
@@ -85,18 +88,17 @@ class WorkflowSchemeProjectAssociationsService extends CommonHttpService_1.Commo
          *           "10001": "builds workflow"
          *         },
          *         "name": "Example workflow scheme",
-         *         "self":
-         * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
+         *         "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
          *       }
          *     }
          *   ]
          * }
-         * @path {GET} /rest/api/3/workflowscheme/project
+         * ```
+         * @path GET `/rest/api/3/workflowscheme/project`
          * @scopes-current manage:jira-configuration
-         * @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:application-role:jira,
-         * read:avatar:jira, read:group:jira, read:issue-type:jira,
-         * read:project-category:jira, read:project:jira, read:user:jira
+         * @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-scheme-project-associations#api-rest-api-3-workflowscheme-project-get
+         * @param params
          */
         this.getWorkflowSchemeProjectAssociations = ({ projectId, }) => {
             return this.getClientInstance()

package/lib/openapi/platform/services/WorkflowSchemeProjectAssociationsService.js.map

@@ -1 +1 @@
-{"version":3,"file":"WorkflowSchemeProjectAssociationsService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/WorkflowSchemeProjectAssociationsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,mGAIqD;AACrD,wEAAqE;AACrE;;;;;;;GAOG;AACH,MAAa,wCAAyC,SAAQ,qCAAiB;IAA/E;;QACE;;;;;;;;;;;;;;WAcG;QACH,0BAAqB,GAAG,CAAC,EACvB,gCAAgC,GASjC,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,oCAAoC;gBAC1C,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,gCAAgC;aACvC,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,yEAAyE,CAC1E,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2CG;QACH,yCAAoC,GAAG,CAAC,EACtC,SAAS,GAQV,EAAkD,EAAE;YACnD,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,oCAAoC;gBAC1C,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,SAAS;iBACV;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,wFAAwF,CACzF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAgCJ,CAAC;IA/BW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CACxC,wFAAwF,EACxF,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAChC,uCAAuC,CACxC;SACF,CAAC;aACD,QAAQ,CACP,wFAAwF,CACzF,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yEAAyE,EACzE,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,OAAO,EAAE;SAClB,CAAC;aACD,QAAQ,CACP,yEAAyE,CAC1E,CACJ,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,8FAA0D;SAC3D,CAAC,CAAC;IACL,CAAC;CACF;AA3KD,4FA2KC"}
+{"version":3,"file":"WorkflowSchemeProjectAssociationsService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/WorkflowSchemeProjectAssociationsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,mGAIqD;AACrD,wEAAqE;AACrE;;;;;;;GAOG;AACH,MAAa,wCAAyC,SAAQ,qCAAiB;IAA/E;;QACE;;;;;;;;;;;;;;;WAeG;QACH,0BAAqB,GAAG,CAAC,EACvB,gCAAgC,GAUjC,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,oCAAoC;gBAC1C,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,gCAAgC;aACvC,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,yEAAyE,CAC1E,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA4CG;QACH,yCAAoC,GAAG,CAAC,EACtC,SAAS,GAQV,EAAkD,EAAE;YACnD,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,oCAAoC;gBAC1C,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,SAAS;iBACV;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,wFAAwF,CACzF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAgCJ,CAAC;IA/BW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CACxC,wFAAwF,EACxF,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAChC,uCAAuC,CACxC;SACF,CAAC;aACD,QAAQ,CACP,wFAAwF,CACzF,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yEAAyE,EACzE,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,OAAO,EAAE;SAClB,CAAC;aACD,QAAQ,CACP,yEAAyE,CAC1E,CACJ,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,8FAA0D;SAC3D,CAAC,CAAC;IACL,CAAC;CACF;AA9KD,4FA8KC"}

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

@@ -28,7 +28,9 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "defaultWorkflow": "jira",
      *   "description": "The description of the example workflow scheme.",
      *   "draft": false,
@@ -40,16 +42,17 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *   "name": "Example workflow scheme",
      *   "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
      * }
-     * @path {POST} /rest/api/3/workflowscheme
+     * ```
+     * @path POST `/rest/api/3/workflowscheme`
      * @scopes-current manage:jira-configuration
-     * @scopes-beta write:workflow-scheme:jira, read:application-role:jira, read:avatar:jira,
-     * read:group:jira, read:issue-type:jira, read:project-category:jira,
-     * read:project:jira, read:user:jira, read:workflow-scheme:jira
+     * @scopes-beta write:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira, read:workflow-scheme:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-post
+     * @param params
      */
     createWorkflowScheme: ({ workflowScheme, }: {
         /**
-         * @example {
+         * @example
+         * {
          *     "defaultWorkflow": "jira",
          *     "description": "The description of the example workflow scheme.",
          *     "issueTypeMappings": {
@@ -75,7 +78,9 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "defaultWorkflow": "jira",
      *   "description": "The description of the example workflow scheme.",
      *   "draft": false,
@@ -87,13 +92,12 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *   "name": "Example workflow scheme",
      *   "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
      * }
-     * @path {DELETE} /rest/api/3/workflowscheme/{id}/default
+     * ```
+     * @path DELETE `/rest/api/3/workflowscheme/{id}/default`
      * @scopes-current manage:jira-configuration
-     * @scopes-beta read:workflow-scheme:jira, write:workflow-scheme:jira,
-     * read:application-role:jira, read:avatar:jira, read:group:jira,
-     * read:issue-type:jira, read:project-category:jira, read:project:jira,
-     * read:user:jira
+     * @scopes-beta read:workflow-scheme:jira, write:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-default-delete
+     * @param params
      */
     deleteDefaultWorkflow: ({ id, updateDraftIfNeeded, }: {
         /** The ID of the workflow scheme. */
@@ -116,10 +120,11 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      * **[Permissions](#permissions) required:** *Administer Jira* [global
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
-     * @path {DELETE} /rest/api/3/workflowscheme/{id}/workflow
+     * @path DELETE `/rest/api/3/workflowscheme/{id}/workflow`
      * @scopes-current manage:jira-configuration
      * @scopes-beta delete:workflow-scheme:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-workflow-delete
+     * @param params
      */
     deleteWorkflowMapping: ({ id, workflowName, updateDraftIfNeeded, }: {
         /** The ID of the workflow scheme. */
@@ -141,10 +146,11 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      * permission](https://confluence.atlassian.com/x/x4dKLg).
      *
      * @returns Returned if the request is successful.
-     * @path {DELETE} /rest/api/3/workflowscheme/{id}
+     * @path DELETE `/rest/api/3/workflowscheme/{id}`
      * @scopes-current manage:jira-configuration
      * @scopes-beta delete:workflow-scheme:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-delete
+     * @param params
      */
     deleteWorkflowScheme: ({ id, }: {
         /**
@@ -167,7 +173,9 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "defaultWorkflow": "jira",
      *   "description": "The description of the example workflow scheme.",
      *   "draft": false,
@@ -179,12 +187,12 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *   "name": "Example workflow scheme",
      *   "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
      * }
-     * @path {DELETE} /rest/api/3/workflowscheme/{id}/issuetype/{issueType}
+     * ```
+     * @path DELETE `/rest/api/3/workflowscheme/{id}/issuetype/{issueType}`
      * @scopes-current manage:jira-configuration
-     * @scopes-beta delete:workflow-scheme:jira, read:application-role:jira, read:avatar:jira,
-     * read:group:jira, read:issue-type:jira, read:project-category:jira,
-     * read:project:jira, read:user:jira, read:workflow-scheme:jira, read:workflow:jira
+     * @scopes-beta delete:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira, read:workflow-scheme:jira, read:workflow:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-issuetype-issuetype-delete
+     * @param params
      */
     deleteWorkflowSchemeIssueType: ({ id, issueType, updateDraftIfNeeded, }: {
         /** The ID of the workflow scheme. */
@@ -207,7 +215,9 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": true,
      *   "maxResults": 50,
      *   "startAt": 0,
@@ -222,8 +232,7 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *         "10001": "builds workflow"
      *       },
      *       "name": "Example workflow scheme",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
      *     },
      *     {
      *       "defaultWorkflow": "jira",
@@ -234,17 +243,16 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *         "10001": "builds workflow"
      *       },
      *       "name": "Another example workflow scheme",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101011"
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101011"
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/workflowscheme
+     * ```
+     * @path GET `/rest/api/3/workflowscheme`
      * @scopes-current manage:jira-configuration
-     * @scopes-beta read:workflow-scheme:jira, read:application-role:jira, read:avatar:jira,
-     * read:group:jira, read:issue-type:jira, read:project-category:jira,
-     * read:project:jira, read:user:jira
+     * @scopes-beta read:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-get
+     * @param params
      */
     getAllWorkflowSchemes: ({ startAt, maxResults, }?: {
         /** The index of the first item to return in a page of results (page offset). */
@@ -263,13 +271,17 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "workflow": "jira"
      * }
-     * @path {GET} /rest/api/3/workflowscheme/{id}/default
+     * ```
+     * @path GET `/rest/api/3/workflowscheme/{id}/default`
      * @scopes-current manage:jira-configuration
      * @scopes-beta read:workflow-scheme:jira, read:workflow:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-default-get
+     * @param params
      */
     getDefaultWorkflow: ({ id, returnDraftIfExists, }: {
         /** The ID of the workflow scheme. */
@@ -289,7 +301,9 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "defaultMapping": false,
      *   "issueTypes": [
      *     "10000",
@@ -297,10 +311,12 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *   ],
      *   "workflow": "jira"
      * }
-     * @path {GET} /rest/api/3/workflowscheme/{id}/workflow
+     * ```
+     * @path GET `/rest/api/3/workflowscheme/{id}/workflow`
      * @scopes-current manage:jira-configuration
      * @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:issue-type:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-workflow-get
+     * @param params
      */
     getWorkflow: ({ id, workflowName, returnDraftIfExists, }: {
         /** The ID of the workflow scheme. */
@@ -325,7 +341,9 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "defaultWorkflow": "jira",
      *   "description": "The description of the example workflow scheme.",
      *   "draft": false,
@@ -337,12 +355,12 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *   "name": "Example workflow scheme",
      *   "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
      * }
-     * @path {GET} /rest/api/3/workflowscheme/{id}
+     * ```
+     * @path GET `/rest/api/3/workflowscheme/{id}`
      * @scopes-current manage:jira-configuration
-     * @scopes-beta read:workflow-scheme:jira, read:application-role:jira, read:avatar:jira,
-     * read:group:jira, read:issue-type:jira, read:project-category:jira,
-     * read:project:jira, read:user:jira
+     * @scopes-beta read:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-get
+     * @param params
      */
     getWorkflowScheme: ({ id, returnDraftIfExists, }: {
         /**
@@ -366,14 +384,18 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "issueType": "10000",
      *   "workflow": "jira"
      * }
-     * @path {GET} /rest/api/3/workflowscheme/{id}/issuetype/{issueType}
+     * ```
+     * @path GET `/rest/api/3/workflowscheme/{id}/issuetype/{issueType}`
      * @scopes-current manage:jira-configuration
      * @scopes-beta read:workflow-scheme:jira, read:workflow:jira, read:issue-type:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-issuetype-issuetype-get
+     * @param params
      */
     getWorkflowSchemeIssueType: ({ id, issueType, returnDraftIfExists, }: {
         /** The ID of the workflow scheme. */
@@ -400,11 +422,12 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: [
+     * example:
+     * ```
+     * [
      *   {
      *     "defaultWorkflow": {
-     *       "description": "This is the default workflow for Software Development
-     * projects.",
+     *       "description": "This is the default workflow for Software Development projects.",
      *       "id": "3e59db0f-ed6c-47ce-8d50-80c0c4572677",
      *       "name": "Default Software Development Workflow",
      *       "usage": [
@@ -418,8 +441,7 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *         "versionNumber": 1
      *       }
      *     },
-     *     "description": "This is the workflow scheme for the Software Development
-     * project type.",
+     *     "description": "This is the workflow scheme for the Software Development project type.",
      *     "id": "3g78dg2a-ns2n-56ab-9812-42h5j1464567",
      *     "name": "Software Developer Workflow Scheme",
      *     "projectIdsUsingScheme": [
@@ -442,8 +464,7 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *           "10013"
      *         ],
      *         "workflow": {
-     *           "description": "This is the workflow for the Software Development bug
-     * issue type.",
+     *           "description": "This is the workflow for the Software Development bug issue type.",
      *           "id": "5e79ae0f-ed6c-47ce-8d50-80c0c4572745",
      *           "name": "Software Development Bug Workflow",
      *           "usage": [
@@ -463,10 +484,12 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *     ]
      *   }
      * ]
-     * @path {POST} /rest/api/3/workflowscheme/read
+     * ```
+     * @path POST `/rest/api/3/workflowscheme/read`
      * @scopes-current manage:jira-configuration
      * @scopes-beta read:workflow-scheme:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-read-post
+     * @param params
      */
     readWorkflowSchemes: ({ expand, workflowSchemeReadRequest, }: {
         /**
@@ -478,7 +501,8 @@ export declare class WorkflowSchemesService extends CommonHttpService {
          */
         expand?: string | undefined;
         /**
-         * @example {
+         * @example
+         * {
          *     "projectIds": [
          *         "10047",
          *         "10048"
@@ -503,7 +527,9 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "defaultWorkflow": "jira",
      *   "description": "The description of the example workflow scheme.",
      *   "draft": false,
@@ -515,13 +541,12 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *   "name": "Example workflow scheme",
      *   "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
      * }
-     * @path {PUT} /rest/api/3/workflowscheme/{id}/issuetype/{issueType}
+     * ```
+     * @path PUT `/rest/api/3/workflowscheme/{id}/issuetype/{issueType}`
      * @scopes-current manage:jira-configuration
-     * @scopes-beta write:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira,
-     * read:application-role:jira, read:avatar:jira, read:group:jira,
-     * read:issue-type:jira, read:project-category:jira, read:project:jira,
-     * read:user:jira
+     * @scopes-beta write:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-issuetype-issuetype-put
+     * @param params
      */
     setWorkflowSchemeIssueType: ({ id, issueType, issueTypeWorkflowMapping, }: {
         /** The ID of the workflow scheme. */
@@ -531,7 +556,8 @@ export declare class WorkflowSchemesService extends CommonHttpService {
         /**
          * The issue type-project mapping.
          *
-         * @example {
+         * @example
+         * {
          *     "issueType": "10000",
          *     "updateDraftIfNeeded": false,
          *     "workflow": "jira"
@@ -552,7 +578,9 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "defaultWorkflow": "jira",
      *   "description": "The description of the example workflow scheme.",
      *   "draft": false,
@@ -564,13 +592,12 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *   "name": "Example workflow scheme",
      *   "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
      * }
-     * @path {PUT} /rest/api/3/workflowscheme/{id}/default
+     * ```
+     * @path PUT `/rest/api/3/workflowscheme/{id}/default`
      * @scopes-current manage:jira-configuration
-     * @scopes-beta read:workflow-scheme:jira, write:workflow-scheme:jira,
-     * read:application-role:jira, read:avatar:jira, read:group:jira,
-     * read:issue-type:jira, read:project-category:jira, read:project:jira,
-     * read:user:jira
+     * @scopes-beta read:workflow-scheme:jira, write:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-default-put
+     * @param params
      */
     updateDefaultWorkflow: ({ id, defaultWorkflow, }: {
         /** The ID of the workflow scheme. */
@@ -578,7 +605,8 @@ export declare class WorkflowSchemesService extends CommonHttpService {
         /**
          * The new default workflow.
          *
-         * @example {
+         * @example
+         * {
          *     "updateDraftIfNeeded": false,
          *     "workflow": "jira"
          * }
@@ -600,14 +628,16 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      * schemes.
      *
      * @returns Returned if the request is successful and there is no asynchronous task.
-     * @path {POST} /rest/api/3/workflowscheme/update
+     * @path POST `/rest/api/3/workflowscheme/update`
      * @scopes-current manage:jira-configuration
      * @scopes-beta write:workflow-scheme:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-update-post
+     * @param params
      */
     updateSchemes: ({ workflowSchemeUpdateRequest, }: {
         /**
-         * @example {
+         * @example
+         * {
          *     "defaultWorkflowId": "3e59db0f-ed6c-47ce-8d50-80c0c4572677",
          *     "description": "description",
          *     "id": "10000",
@@ -695,7 +725,9 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "defaultWorkflow": "jira",
      *   "description": "The description of the example workflow scheme.",
      *   "draft": false,
@@ -707,13 +739,12 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *   "name": "Example workflow scheme",
      *   "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
      * }
-     * @path {PUT} /rest/api/3/workflowscheme/{id}/workflow
+     * ```
+     * @path PUT `/rest/api/3/workflowscheme/{id}/workflow`
      * @scopes-current manage:jira-configuration
-     * @scopes-beta write:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira,
-     * read:application-role:jira, read:avatar:jira, read:group:jira,
-     * read:issue-type:jira, read:project-category:jira, read:project:jira,
-     * read:user:jira
+     * @scopes-beta write:workflow-scheme:jira, read:workflow-scheme:jira, read:workflow:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-workflow-put
+     * @param params
      */
     updateWorkflowMapping: ({ id, workflowName, issueTypesWorkflowMapping, }: {
         /** The ID of the workflow scheme. */
@@ -721,7 +752,8 @@ export declare class WorkflowSchemesService extends CommonHttpService {
         /** The name of the workflow. */
         workflowName: string;
         /**
-         * @example {
+         * @example
+         * {
          *     "issueTypes": [
          *         "10000"
          *     ],
@@ -743,7 +775,9 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "defaultWorkflow": "jira",
      *   "description": "The description of the example workflow scheme.",
      *   "draft": false,
@@ -755,13 +789,12 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *   "name": "Example workflow scheme",
      *   "self": "https://your-domain.atlassian.net/rest/api/3/workflowscheme/101010"
      * }
-     * @path {PUT} /rest/api/3/workflowscheme/{id}
+     * ```
+     * @path PUT `/rest/api/3/workflowscheme/{id}`
      * @scopes-current manage:jira-configuration
-     * @scopes-beta read:workflow-scheme:jira, write:workflow-scheme:jira,
-     * read:application-role:jira, read:avatar:jira, read:group:jira,
-     * read:issue-type:jira, read:project-category:jira, read:project:jira,
-     * read:user:jira
+     * @scopes-beta read:workflow-scheme:jira, write:workflow-scheme:jira, read:application-role:jira, read:avatar:jira, read:group:jira, read:issue-type:jira, read:project-category:jira, read:project:jira, read:user:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-id-put
+     * @param params
      */
     updateWorkflowScheme: ({ id, workflowScheme, }: {
         /**
@@ -771,7 +804,8 @@ export declare class WorkflowSchemesService extends CommonHttpService {
          */
         id: number;
         /**
-         * @example {
+         * @example
+         * {
          *     "defaultWorkflow": "jira",
          *     "description": "The description of the example workflow scheme.",
          *     "issueTypeMappings": {
@@ -797,7 +831,9 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "statusMappingsByIssueTypes": [
      *     {
      *       "issueTypeId": "10000",
@@ -835,14 +871,17 @@ export declare class WorkflowSchemesService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {POST} /rest/api/3/workflowscheme/update/mappings
+     * ```
+     * @path POST `/rest/api/3/workflowscheme/update/mappings`
      * @scopes-current manage:jira-configuration
      * @scopes-beta write:workflow-scheme:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-schemes#api-rest-api-3-workflowscheme-update-mappings-post
+     * @param params
      */
     updateWorkflowSchemeMappings: ({ workflowSchemeUpdateRequiredMappingsRequest, }: {
         /**
-         * @example {
+         * @example
+         * {
          *     "defaultWorkflowId": "10010",
          *     "id": "10001",
          *     "workflowsForIssueTypes": [