@resolution/jira-api-client 0.5.2 → 0.5.3

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

@@ -36,13 +36,16 @@ class UiModificationsAppsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the UI modification is created.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "id": "d7dbda8a-6239-4b63-8e13-a5ef975c8e61",
-         *   "self":
-         * "https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/d7dbda8a-6239-4b63-8e13-a5ef975c8e61"
+         *   "self": "`https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/d7dbda8a-6239-4b63-8e13-a5ef975c8e61`"
          * }
-         * @path {POST} /rest/api/3/uiModifications
+         * ```
+         * @path POST `/rest/api/3/uiModifications`
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-ui-modifications-apps-#api-rest-api-3-uimodifications-post
+         * @param params
          */
         this.createUiModification = ({ createUiModificationDetails, }) => {
             return this.getClientInstance()
@@ -70,8 +73,9 @@ class UiModificationsAppsService extends CommonHttpService_1.CommonHttpService {
          * **[Permissions](#permissions) required:** None.
          *
          * @returns Returned if the UI modification is deleted.
-         * @path {DELETE} /rest/api/3/uiModifications/{uiModificationId}
+         * @path DELETE `/rest/api/3/uiModifications/{uiModificationId}`
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-ui-modifications-apps-#api-rest-api-3-uimodifications-uimodificationid-delete
+         * @param params
          */
         this.deleteUiModification = ({ uiModificationId, }) => {
             return this.getClientInstance()
@@ -98,7 +102,9 @@ class UiModificationsAppsService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "isLast": true,
          *   "maxResults": 100,
          *   "startAt": 0,
@@ -108,8 +114,7 @@ class UiModificationsAppsService extends CommonHttpService_1.CommonHttpService {
          *       "id": "d7dbda8a-6239-4b63-8e13-a5ef975c8e61",
          *       "name": "Reveal Story Points",
          *       "description": "Reveals Story Points field when any Sprint is selected.",
-         *       "self":
-         * "https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/d7dbda8a-6239-4b63-8e13-a5ef975c8e61",
+         *       "self": "`https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/d7dbda8a-6239-4b63-8e13-a5ef975c8e61`",
          *       "data": "{field: 'Story Points', config: {hidden: false}}",
          *       "contexts": [
          *         {
@@ -132,8 +137,7 @@ class UiModificationsAppsService extends CommonHttpService_1.CommonHttpService {
          *       "id": "e4fe8db5-f82f-416b-a3aa-b260b55da577",
          *       "name": "Set Assignee",
          *       "description": "Sets the Assignee field automatically.",
-         *       "self":
-         * "https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/e4fe8db5-f82f-416b-a3aa-b260b55da577",
+         *       "self": "`https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/e4fe8db5-f82f-416b-a3aa-b260b55da577`",
          *       "contexts": [
          *         {
          *           "id": "8b3740f9-8780-4958-8228-69dcfbda11d9",
@@ -148,16 +152,14 @@ class UiModificationsAppsService extends CommonHttpService_1.CommonHttpService {
          *       "id": "1453f993-79ce-4389-a36d-eb72d5c85dd6",
          *       "name": "Hide Labels",
          *       "description": "Hides Labels if any component is provided.",
-         *       "self":
-         * "https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/1453f993-79ce-4389-a36d-eb72d5c85dd6",
+         *       "self": "`https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/1453f993-79ce-4389-a36d-eb72d5c85dd6`",
          *       "contexts": []
          *     },
          *     {
          *       "id": "d3f4097e-8d8e-451e-9fb6-27c3c8c3bfff",
          *       "name": "Wildcard example",
          *       "description": "This context is applied to all issue types",
-         *       "self":
-         * "https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/d3f4097e-8d8e-451e-9fb6-27c3c8c3bfff",
+         *       "self": "`https://api.atlassian.com/ex/jira/{cloudid}/rest/api/2/uiModifications/d3f4097e-8d8e-451e-9fb6-27c3c8c3bfff`",
          *       "contexts": [
          *         {
          *           "id": "521f2181-5d5e-46ea-9fc9-871bbf245b8b",
@@ -170,8 +172,10 @@ class UiModificationsAppsService extends CommonHttpService_1.CommonHttpService {
          *     }
          *   ]
          * }
-         * @path {GET} /rest/api/3/uiModifications
+         * ```
+         * @path GET `/rest/api/3/uiModifications`
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-ui-modifications-apps-#api-rest-api-3-uimodifications-get
+         * @param params
          */
         this.getUiModifications = ({ startAt, maxResults, expand, } = {}) => {
             return this.getClientInstance()
@@ -207,8 +211,9 @@ class UiModificationsAppsService extends CommonHttpService_1.CommonHttpService {
          * projects, if the UI modification is created with contexts.
          *
          * @returns Returned if the UI modification is updated.
-         * @path {PUT} /rest/api/3/uiModifications/{uiModificationId}
+         * @path PUT `/rest/api/3/uiModifications/{uiModificationId}`
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-ui-modifications-apps-#api-rest-api-3-uimodifications-uimodificationid-put
+         * @param params
          */
         this.updateUiModification = ({ uiModificationId, updateUiModificationDetails, }) => {
             return this.getClientInstance()

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

@@ -1 +1 @@
-{"version":3,"file":"UiModificationsAppsService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/UiModificationsAppsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,uEAMuC;AACvC,wEAAqE;AACrE;;;;;;;GAOG;AACH,MAAa,0BAA2B,SAAQ,qCAAiB;IAAjE;;QACE;;;;;;;;;;;;;;;;;;;;;;;WAuBG;QACH,yBAAoB,GAAG,CAAC,EACtB,2BAA2B,GA6B5B,EAAsC,EAAE;YACvC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6BAA6B;gBACnC,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,2BAA2B;aAClC,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,0DAA0D,CAC3D,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;WASG;QACH,yBAAoB,GAAG,CAAC,EACtB,gBAAgB,GAIjB,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,gDAAgD;gBACtD,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,gBAAgB;iBACjB;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,0DAA0D,CAC3D,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAiFG;QACH,uBAAkB,GAAG,CAAC,EACpB,OAAO,EACP,UAAU,EACV,MAAM,MAcJ,EAAE,EAA0C,EAAE;YAChD,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6BAA6B;gBACnC,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,OAAO;oBACP,UAAU;oBACV,MAAM;iBACP;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,wDAAwD,CACzD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;WAgBG;QACH,yBAAoB,GAAG,CAAC,EACtB,gBAAgB,EAChB,2BAA2B,GAyB5B,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,gDAAgD;gBACtD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,gBAAgB;iBACjB;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,2BAA2B;aAClC,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,0DAA0D,CAC3D,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IA8CJ,CAAC;IA7CW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CACxC,wDAAwD,EACxD,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,CAAC,+BAA+B,CAAC;SACpE,CAAC;aACD,QAAQ,CAAC,wDAAwD,CAAC,CACtE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0DAA0D,EAC1D,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,CAAC,2BAA2B,CAAC;SAChE,CAAC;aACD,QAAQ,CAAC,0DAA0D,CAAC,CACxE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0DAA0D,EAC1D,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,CAAC,0DAA0D,CAAC,CACxE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0DAA0D,EAC1D,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,CAAC,0DAA0D,CAAC,CACxE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,kEAA4C;SAC7C,CAAC,CAAC;IACL,CAAC;CACF;AAjYD,gEAiYC"}
+{"version":3,"file":"UiModificationsAppsService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/UiModificationsAppsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,uEAMuC;AACvC,wEAAqE;AACrE;;;;;;;GAOG;AACH,MAAa,0BAA2B,SAAQ,qCAAiB;IAAjE;;QACE;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;QACH,yBAAoB,GAAG,CAAC,EACtB,2BAA2B,GA8B5B,EAAsC,EAAE;YACvC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6BAA6B;gBACnC,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,2BAA2B;aAClC,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,0DAA0D,CAC3D,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;WAUG;QACH,yBAAoB,GAAG,CAAC,EACtB,gBAAgB,GAIjB,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,gDAAgD;gBACtD,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,gBAAgB;iBACjB;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,0DAA0D,CAC3D,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAiFG;QACH,uBAAkB,GAAG,CAAC,EACpB,OAAO,EACP,UAAU,EACV,MAAM,MAcJ,EAAE,EAA0C,EAAE;YAChD,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6BAA6B;gBACnC,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,OAAO;oBACP,UAAU;oBACV,MAAM;iBACP;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,wDAAwD,CACzD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;WAiBG;QACH,yBAAoB,GAAG,CAAC,EACtB,gBAAgB,EAChB,2BAA2B,GA0B5B,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,gDAAgD;gBACtD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,gBAAgB;iBACjB;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,2BAA2B;aAClC,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,0DAA0D,CAC3D,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IA8CJ,CAAC;IA7CW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CACxC,wDAAwD,EACxD,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,CAAC,+BAA+B,CAAC;SACpE,CAAC;aACD,QAAQ,CAAC,wDAAwD,CAAC,CACtE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0DAA0D,EAC1D,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,CAAC,2BAA2B,CAAC;SAChE,CAAC;aACD,QAAQ,CAAC,0DAA0D,CAAC,CACxE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0DAA0D,EAC1D,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,CAAC,0DAA0D,CAAC,CACxE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0DAA0D,EAC1D,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,CAAC,0DAA0D,CAAC,CACxE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,kEAA4C;SAC7C,CAAC,CAAC;IACL,CAAC;CACF;AAxYD,gEAwYC"}

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

@@ -30,10 +30,11 @@ export declare class UserPropertiesService extends CommonHttpService {
      * from any user.
      *  *  Access to Jira, to delete a property from the calling user's record.
      *
-     * @path {DELETE} /rest/api/3/user/properties/{propertyKey}
+     * @path DELETE `/rest/api/3/user/properties/{propertyKey}`
      * @scopes-current write:jira-work
      * @scopes-beta delete:user.property:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-properties#api-rest-api-3-user-properties-propertykey-delete
+     * @param params
      */
     deleteUserProperty: ({ propertyKey, accountId, userKey, username, }: {
         /** The key of the user's property. */
@@ -75,17 +76,21 @@ export declare class UserPropertiesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "key": "issue.support",
      *   "value": {
      *     "system.conversation.id": "b1bf38be-5e94-4b40-a3b8-9278735ee1e6",
      *     "system.support.time": "1m"
      *   }
      * }
-     * @path {GET} /rest/api/3/user/properties/{propertyKey}
+     * ```
+     * @path GET `/rest/api/3/user/properties/{propertyKey}`
      * @scopes-current read:jira-user
      * @scopes-beta read:user.property:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-properties#api-rest-api-3-user-properties-propertykey-get
+     * @param params
      */
     getUserProperty: ({ propertyKey, accountId, userKey, username, }: {
         /** The key of the user's property. */
@@ -126,19 +131,22 @@ export declare class UserPropertiesService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "keys": [
      *     {
      *       "key": "issue.support",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support"
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support"
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/user/properties
+     * ```
+     * @path GET `/rest/api/3/user/properties`
      * @scopes-current read:jira-user
      * @scopes-beta read:user.property:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-properties#api-rest-api-3-user-properties-get
+     * @param params
      */
     getUserPropertyKeys: ({ accountId, userKey, username, }?: {
         /**
@@ -176,17 +184,19 @@ export declare class UserPropertiesService extends CommonHttpService {
      * any user.
      *  *  Access to Jira, to set a property on the calling user's record.
      *
-     * @returns * status: 200, mediaType: application/json
+     * @returns
+     *  * status: 200, mediaType: application/json
      *
      *    Returned if the user property is updated.
      *
      *  * status: 201, mediaType: application/json
      *
      *    Returned if the user property is created.
-     * @path {PUT} /rest/api/3/user/properties/{propertyKey}
+     * @path PUT `/rest/api/3/user/properties/{propertyKey}`
      * @scopes-current write:jira-work
      * @scopes-beta write:user.property:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-properties#api-rest-api-3-user-properties-propertykey-put
+     * @param params
      */
     setUserProperty: ({ propertyKey, accountId, userKey, username, requestBody, }: {
         /** The key of the user's property. The maximum length is 255 characters. */

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

@@ -41,10 +41,11 @@ class UserPropertiesService extends CommonHttpService_1.CommonHttpService {
          * from any user.
          *  *  Access to Jira, to delete a property from the calling user's record.
          *
-         * @path {DELETE} /rest/api/3/user/properties/{propertyKey}
+         * @path DELETE `/rest/api/3/user/properties/{propertyKey}`
          * @scopes-current write:jira-work
          * @scopes-beta delete:user.property:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-properties#api-rest-api-3-user-properties-propertykey-delete
+         * @param params
          */
         this.deleteUserProperty = ({ propertyKey, accountId, userKey, username, }) => {
             return this.getClientInstance()
@@ -79,17 +80,21 @@ class UserPropertiesService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "key": "issue.support",
          *   "value": {
          *     "system.conversation.id": "b1bf38be-5e94-4b40-a3b8-9278735ee1e6",
          *     "system.support.time": "1m"
          *   }
          * }
-         * @path {GET} /rest/api/3/user/properties/{propertyKey}
+         * ```
+         * @path GET `/rest/api/3/user/properties/{propertyKey}`
          * @scopes-current read:jira-user
          * @scopes-beta read:user.property:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-properties#api-rest-api-3-user-properties-propertykey-get
+         * @param params
          */
         this.getUserProperty = ({ propertyKey, accountId, userKey, username, }) => {
             return this.getClientInstance()
@@ -130,19 +135,22 @@ class UserPropertiesService extends CommonHttpService_1.CommonHttpService {
          *
          * @returns Returned if the request is successful.
          *
-         * example: {
+         * example:
+         * ```
+         * {
          *   "keys": [
          *     {
          *       "key": "issue.support",
-         *       "self":
-         * "https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support"
+         *       "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support"
          *     }
          *   ]
          * }
-         * @path {GET} /rest/api/3/user/properties
+         * ```
+         * @path GET `/rest/api/3/user/properties`
          * @scopes-current read:jira-user
          * @scopes-beta read:user.property:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-properties#api-rest-api-3-user-properties-get
+         * @param params
          */
         this.getUserPropertyKeys = ({ accountId, userKey, username, } = {}) => {
             return this.getClientInstance()
@@ -179,17 +187,19 @@ class UserPropertiesService extends CommonHttpService_1.CommonHttpService {
          * any user.
          *  *  Access to Jira, to set a property on the calling user's record.
          *
-         * @returns * status: 200, mediaType: application/json
+         * @returns
+         *  * status: 200, mediaType: application/json
          *
          *    Returned if the user property is updated.
          *
          *  * status: 201, mediaType: application/json
          *
          *    Returned if the user property is created.
-         * @path {PUT} /rest/api/3/user/properties/{propertyKey}
+         * @path PUT `/rest/api/3/user/properties/{propertyKey}`
          * @scopes-current write:jira-work
          * @scopes-beta write:user.property:jira
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-properties#api-rest-api-3-user-properties-propertykey-put
+         * @param params
          */
         this.setUserProperty = ({ propertyKey, accountId, userKey, username, requestBody, }) => {
             return this.getClientInstance()

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

@@ -1 +1 @@
-{"version":3,"file":"UserPropertiesService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/UserPropertiesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAC1B,wEAAqE;AACrE;;;;;;;;;;;;;;GAcG;AACH,MAAa,qBAAsB,SAAQ,qCAAiB;IAA5D;;QACE;;;;;;;;;;;;;;;;;;WAkBG;QACH,uBAAkB,GAAG,CAAC,EACpB,WAAW,EACX,SAAS,EACT,OAAO,EACP,QAAQ,GAuBT,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,2CAA2C;gBACjD,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,WAAW;iBACZ;gBACD,KAAK,EAAE;oBACL,SAAS;oBACT,OAAO;oBACP,QAAQ;iBACT;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA4BG;QACH,oBAAe,GAAG,CAAC,EACjB,WAAW,EACX,SAAS,EACT,OAAO,EACP,QAAQ,GAuBT,EAA2B,EAAE;YAC5B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,2CAA2C;gBACjD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,WAAW;iBACZ;gBACD,KAAK,EAAE;oBACL,SAAS;oBACT,OAAO;oBACP,QAAQ;iBACT;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,gDAAgD,CACjD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6BG;QACH,wBAAmB,GAAG,CAAC,EACrB,SAAS,EACT,OAAO,EACP,QAAQ,MAqBN,EAAE,EAAyB,EAAE;YAC/B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6BAA6B;gBACnC,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,SAAS;oBACT,OAAO;oBACP,QAAQ;iBACT;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,oDAAoD,CACrD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;WA0BG;QACH,oBAAe,GAAG,CAAC,EACjB,WAAW,EACX,SAAS,EACT,OAAO,EACP,QAAQ,EACR,WAAW,GA6BZ,EAGE,EAAE;YACH,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,2CAA2C;gBACjD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,WAAW;iBACZ;gBACD,KAAK,EAAE;oBACL,SAAS;oBACT,OAAO;oBACP,QAAQ;iBACT;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,WAAW;aAClB,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;gBACD,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,gDAAgD,CACjD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;QACtD,CAAC,CAAC;IA6CJ,CAAC;IA5CW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CACxC,oDAAoD,EACpD,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,CAAC,cAAc,CAAC;SACnD,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,gDAAgD,EAChD,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,CAAC,gBAAgB,CAAC;SACrD,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,gDAAgD,EAChD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;YAClB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;YACrB,IAAI,EAAE,OAAC,CAAC,OAAO,EAAE;SAClB,CAAC;aACD,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,EAAE;YACnD,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;gBACrC,OAAC,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,QAAQ,CAAC;oBACX,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,MAAM;oBAC3B,IAAI,EAAE,CAAC,QAAQ,CAAC;oBAChB,OAAO,EAAE,2BAA2B,MAAM,EAAE;iBAC7C,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAtYD,sDAsYC"}
+{"version":3,"file":"UserPropertiesService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/UserPropertiesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAC1B,wEAAqE;AACrE;;;;;;;;;;;;;;GAcG;AACH,MAAa,qBAAsB,SAAQ,qCAAiB;IAA5D;;QACE;;;;;;;;;;;;;;;;;;;WAmBG;QACH,uBAAkB,GAAG,CAAC,EACpB,WAAW,EACX,SAAS,EACT,OAAO,EACP,QAAQ,GAuBT,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,2CAA2C;gBACjD,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,WAAW;iBACZ;gBACD,KAAK,EAAE;oBACL,SAAS;oBACT,OAAO;oBACP,QAAQ;iBACT;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAgCG;QACH,oBAAe,GAAG,CAAC,EACjB,WAAW,EACX,SAAS,EACT,OAAO,EACP,QAAQ,GAuBT,EAA2B,EAAE;YAC5B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,2CAA2C;gBACjD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,WAAW;iBACZ;gBACD,KAAK,EAAE;oBACL,SAAS;oBACT,OAAO;oBACP,QAAQ;iBACT;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,gDAAgD,CACjD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAgCG;QACH,wBAAmB,GAAG,CAAC,EACrB,SAAS,EACT,OAAO,EACP,QAAQ,MAqBN,EAAE,EAAyB,EAAE;YAC/B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6BAA6B;gBACnC,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,SAAS;oBACT,OAAO;oBACP,QAAQ;iBACT;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,oDAAoD,CACrD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA4BG;QACH,oBAAe,GAAG,CAAC,EACjB,WAAW,EACX,SAAS,EACT,OAAO,EACP,QAAQ,EACR,WAAW,GA6BZ,EAGE,EAAE;YACH,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,2CAA2C;gBACjD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,WAAW;iBACZ;gBACD,KAAK,EAAE;oBACL,SAAS;oBACT,OAAO;oBACP,QAAQ;iBACT;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,WAAW;aAClB,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;gBACD,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,gDAAgD,CACjD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;QACtD,CAAC,CAAC;IA6CJ,CAAC;IA5CW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CACxC,oDAAoD,EACpD,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,CAAC,cAAc,CAAC;SACnD,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,gDAAgD,EAChD,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,CAAC,gBAAgB,CAAC;SACrD,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,gDAAgD,EAChD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;YAClB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;YACrB,IAAI,EAAE,OAAC,CAAC,OAAO,EAAE;SAClB,CAAC;aACD,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,EAAE;YACnD,IAAI,MAAM,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;gBACrC,OAAC,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,QAAQ,CAAC;oBACX,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,MAAM;oBAC3B,IAAI,EAAE,CAAC,QAAQ,CAAC;oBAChB,OAAO,EAAE,2BAA2B,MAAM,EAAE;iBAC7C,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAhZD,sDAgZC"}