@resolution/jira-api-client 0.5.2 → 0.5.4

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

@@ -1,4 +1,4 @@
-import { CommonHttpService } from "../core/CommonHttpService";
+import { CommonHttpService } from "../../core/CommonHttpService";
 import { type ConnectModules } from "../models/dynamicModules";
 /**
  * This resource represents [modules registered
@@ -16,7 +16,7 @@ export declare class DynamicModulesService extends CommonHttpService {
      * request.
      *
      * @returns Returned if the request is successful.
-     * @path {GET} /rest/atlassian-connect/1/app/module/dynamic
+     * @path GET `/rest/atlassian-connect/1/app/module/dynamic`
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dynamic-modules#api-rest-atlassian-connect-1-app-module-dynamic-get
      */
     dynamicModulesResourceGetModulesGet: () => Promise<ConnectModules>;
@@ -26,8 +26,9 @@ export declare class DynamicModulesService extends CommonHttpService {
      * **[Permissions](#permissions) required:** Only Connect apps can make this
      * request.
      *
-     * @path {POST} /rest/atlassian-connect/1/app/module/dynamic
+     * @path POST `/rest/atlassian-connect/1/app/module/dynamic`
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dynamic-modules#api-rest-atlassian-connect-1-app-module-dynamic-post
+     * @param params
      */
     dynamicModulesResourceRegisterModulesPost: ({ connectModules, }: {
         connectModules: ConnectModules;
@@ -38,8 +39,9 @@ export declare class DynamicModulesService extends CommonHttpService {
      * **[Permissions](#permissions) required:** Only Connect apps can make this
      * request.
      *
-     * @path {DELETE} /rest/atlassian-connect/1/app/module/dynamic
+     * @path DELETE `/rest/atlassian-connect/1/app/module/dynamic`
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dynamic-modules#api-rest-atlassian-connect-1-app-module-dynamic-delete
+     * @param params
      */
     dynamicModulesResourceRemoveModulesDelete: ({ moduleKey, }?: {
         /**

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

@@ -5,8 +5,8 @@ exports.DynamicModulesService = 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 dynamicModules_1 = require("../models/dynamicModules");
 const validationSchemaStorage_1 = require("../validationSchemaStorage");
 /**
@@ -27,7 +27,7 @@ class DynamicModulesService extends CommonHttpService_1.CommonHttpService {
          * request.
          *
          * @returns Returned if the request is successful.
-         * @path {GET} /rest/atlassian-connect/1/app/module/dynamic
+         * @path GET `/rest/atlassian-connect/1/app/module/dynamic`
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dynamic-modules#api-rest-atlassian-connect-1-app-module-dynamic-get
          */
         this.dynamicModulesResourceGetModulesGet = () => {
@@ -51,8 +51,9 @@ class DynamicModulesService extends CommonHttpService_1.CommonHttpService {
          * **[Permissions](#permissions) required:** Only Connect apps can make this
          * request.
          *
-         * @path {POST} /rest/atlassian-connect/1/app/module/dynamic
+         * @path POST `/rest/atlassian-connect/1/app/module/dynamic`
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dynamic-modules#api-rest-atlassian-connect-1-app-module-dynamic-post
+         * @param params
          */
         this.dynamicModulesResourceRegisterModulesPost = ({ connectModules, }) => {
             return this.getClientInstance()
@@ -72,8 +73,9 @@ class DynamicModulesService extends CommonHttpService_1.CommonHttpService {
          * **[Permissions](#permissions) required:** Only Connect apps can make this
          * request.
          *
-         * @path {DELETE} /rest/atlassian-connect/1/app/module/dynamic
+         * @path DELETE `/rest/atlassian-connect/1/app/module/dynamic`
          * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dynamic-modules#api-rest-atlassian-connect-1-app-module-dynamic-delete
+         * @param params
          */
         this.dynamicModulesResourceRemoveModulesDelete = ({ moduleKey, } = {}) => {
             return this.getClientInstance()

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

@@ -1 +1 @@
-{"version":3,"file":"DynamicModulesService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/DynamicModulesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6DAGkC;AAClC,wEAAqE;AACrE;;;;;;;GAOG;AACH,MAAa,qBAAsB,SAAQ,qCAAiB;IAA5D;;QACE;;;;;;;;;WASG;QACH,wCAAmC,GAAG,GAA4B,EAAE;YAClE,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,8CAA8C;gBACpD,MAAM,EAAE,KAAK;aACd,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,sEAAsE,CACvE,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;WAQG;QACH,8CAAyC,GAAG,CAAC,EAC3C,cAAc,GAGf,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,8CAA8C;gBACpD,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,cAAc;aACrB,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;WAQG;QACH,8CAAyC,GAAG,CAAC,EAC3C,SAAS,MAUP,EAAE,EAAiB,EAAE;YACvB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,8CAA8C;gBACpD,MAAM,EAAE,QAAQ;gBAChB,KAAK,EAAE;oBACL,SAAS;iBACV;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;IAkBJ,CAAC;IAjBW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CACxC,sEAAsE,EACtE,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,CACP,sEAAsE,CACvE,CACJ,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,wDAAuC;SACxC,CAAC,CAAC;IACL,CAAC;CACF;AA/GD,sDA+GC"}
+{"version":3,"file":"DynamicModulesService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/DynamicModulesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,gEAAgE;AAChE,oEAAiE;AACjE,6DAGkC;AAClC,wEAAqE;AACrE;;;;;;;GAOG;AACH,MAAa,qBAAsB,SAAQ,qCAAiB;IAA5D;;QACE;;;;;;;;;WASG;QACH,wCAAmC,GAAG,GAA4B,EAAE;YAClE,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,8CAA8C;gBACpD,MAAM,EAAE,KAAK;aACd,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,sEAAsE,CACvE,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;WASG;QACH,8CAAyC,GAAG,CAAC,EAC3C,cAAc,GAGf,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,8CAA8C;gBACpD,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,cAAc;aACrB,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;WASG;QACH,8CAAyC,GAAG,CAAC,EAC3C,SAAS,MAUP,EAAE,EAAiB,EAAE;YACvB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,8CAA8C;gBACpD,MAAM,EAAE,QAAQ;gBAChB,KAAK,EAAE;oBACL,SAAS;iBACV;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;IAkBJ,CAAC;IAjBW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CACxC,sEAAsE,EACtE,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,CACP,sEAAsE,CACvE,CACJ,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,wDAAuC;SACxC,CAAC,CAAC;IACL,CAAC;CACF;AAjHD,sDAiHC"}

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

@@ -1,4 +1,4 @@
-import { CommonHttpService } from "../core/CommonHttpService";
+import { CommonHttpService } from "../../core/CommonHttpService";
 import { type SharePermission } from "../models/common";
 import { type DefaultShareScope, type SharePermissionInputBean } from "../models/filterSharing";
 /**
@@ -22,7 +22,9 @@ export declare class FilterSharingService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: [
+     * example:
+     * ```
+     * [
      *   {
      *     "id": 10000,
      *     "type": "global"
@@ -31,14 +33,10 @@ export declare class FilterSharingService extends CommonHttpService {
      *     "id": 10010,
      *     "project": {
      *       "avatarUrls": {
-     *         "16x16":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
-     *         "24x24":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
-     *         "32x32":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
-     *         "48x48":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+     *         "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+     *         "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+     *         "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+     *         "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
      *       },
      *       "id": "10000",
      *       "insight": {
@@ -51,8 +49,7 @@ export declare class FilterSharingService extends CommonHttpService {
      *         "description": "First Project Category",
      *         "id": "10000",
      *         "name": "FIRST",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
      *       },
      *       "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
      *       "simplified": false,
@@ -64,14 +61,10 @@ export declare class FilterSharingService extends CommonHttpService {
      *     "id": 10010,
      *     "project": {
      *       "avatarUrls": {
-     *         "16x16":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002",
-     *         "24x24":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002",
-     *         "32x32":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002",
-     *         "48x48":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002"
+     *         "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002",
+     *         "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002",
+     *         "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002",
+     *         "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002"
      *       },
      *       "deleted": true,
      *       "deletedBy": {
@@ -79,20 +72,15 @@ export declare class FilterSharingService extends CommonHttpService {
      *         "accountType": "atlassian",
      *         "active": false,
      *         "avatarUrls": {
-     *           "16x16":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-     *           "24x24":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-     *           "32x32":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-     *           "48x48":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
      *         },
      *         "displayName": "Mia Krystof",
      *         "key": "",
      *         "name": "",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *       },
      *       "deletedDate": "2022-11-11T13:35:29.000+0000",
      *       "id": "10002",
@@ -106,8 +94,7 @@ export declare class FilterSharingService extends CommonHttpService {
      *         "description": "First Project Category",
      *         "id": "10000",
      *         "name": "FIRST",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
      *       },
      *       "retentionTillDate": "2023-01-10T13:35:29.000+0000",
      *       "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY",
@@ -115,8 +102,7 @@ export declare class FilterSharingService extends CommonHttpService {
      *       "style": "classic"
      *     },
      *     "role": {
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
      *       "name": "Developers",
      *       "id": 10360,
      *       "description": "A project role that represents developers in a project",
@@ -156,27 +142,25 @@ export declare class FilterSharingService extends CommonHttpService {
      *     "group": {
      *       "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
      *       "name": "jira-administrators",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
      *     },
      *     "id": 10010,
      *     "type": "group"
      *   }
      * ]
-     * @path {POST} /rest/api/3/filter/{id}/permission
+     * ```
+     * @path POST `/rest/api/3/filter/{id}/permission`
      * @scopes-current write:jira-work
-     * @scopes-beta write:filter:jira, read:filter:jira, read:group:jira, read:project:jira,
-     * read:user:jira, read:application-role:jira, read:avatar:jira,
-     * read:issue-type-hierarchy:jira, read:issue-type:jira,
-     * read:project-category:jira, read:project-role:jira, read:project-version:jira,
-     * read:project.component:jira
+     * @scopes-beta write:filter:jira, read:filter:jira, read:group:jira, read:project:jira, read:user:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira, read:issue-type:jira, read:project-category:jira, read:project-role:jira, read:project-version:jira, read:project.component:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filter-sharing#api-rest-api-3-filter-id-permission-post
+     * @param params
      */
     addSharePermission: ({ id, sharePermissionInputBean, }: {
         /** The ID of the filter. */
         id: number;
         /**
-         * @example {
+         * @example
+         * {
          *     "groupname": "jira-administrators",
          *     "rights": 1,
          *     "type": "group"
@@ -190,10 +174,11 @@ export declare class FilterSharingService extends CommonHttpService {
      * **[Permissions](#permissions) required:** Permission to access Jira and the
      * user must own the filter.
      *
-     * @path {DELETE} /rest/api/3/filter/{id}/permission/{permissionId}
+     * @path DELETE `/rest/api/3/filter/{id}/permission/{permissionId}`
      * @scopes-current write:jira-work
      * @scopes-beta write:filter:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filter-sharing#api-rest-api-3-filter-id-permission-permissionid-delete
+     * @param params
      */
     deleteSharePermission: ({ id, permissionId, }: {
         /** The ID of the filter. */
@@ -208,10 +193,13 @@ export declare class FilterSharingService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "scope": "GLOBAL"
      * }
-     * @path {GET} /rest/api/3/filter/defaultShareScope
+     * ```
+     * @path GET `/rest/api/3/filter/defaultShareScope`
      * @scopes-current read:jira-work
      * @scopes-beta read:filter.default-share-scope:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filter-sharing#api-rest-api-3-filter-defaultsharescope-get
@@ -236,18 +224,18 @@ export declare class FilterSharingService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "id": 10000,
      *   "type": "global"
      * }
-     * @path {GET} /rest/api/3/filter/{id}/permission/{permissionId}
+     * ```
+     * @path GET `/rest/api/3/filter/{id}/permission/{permissionId}`
      * @scopes-current read:jira-work
-     * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira,
-     * read:user:jira, read:application-role:jira, read:avatar:jira,
-     * read:issue-type-hierarchy:jira, read:issue-type:jira,
-     * read:project-category:jira, read:project-version:jira,
-     * read:project.component:jira
+     * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:project-role:jira, read:user:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira, read:issue-type:jira, read:project-category:jira, read:project-version:jira, read:project.component:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filter-sharing#api-rest-api-3-filter-id-permission-permissionid-get
+     * @param params
      */
     getSharePermission: ({ id, permissionId, }: {
         /** The ID of the filter. */
@@ -274,7 +262,9 @@ export declare class FilterSharingService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: [
+     * example:
+     * ```
+     * [
      *   {
      *     "id": 10000,
      *     "type": "global"
@@ -283,14 +273,10 @@ export declare class FilterSharingService extends CommonHttpService {
      *     "id": 10010,
      *     "project": {
      *       "avatarUrls": {
-     *         "16x16":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
-     *         "24x24":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
-     *         "32x32":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
-     *         "48x48":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
+     *         "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
+     *         "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
+     *         "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
+     *         "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
      *       },
      *       "id": "10000",
      *       "insight": {
@@ -303,8 +289,7 @@ export declare class FilterSharingService extends CommonHttpService {
      *         "description": "First Project Category",
      *         "id": "10000",
      *         "name": "FIRST",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
      *       },
      *       "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
      *       "simplified": false,
@@ -316,14 +301,10 @@ export declare class FilterSharingService extends CommonHttpService {
      *     "id": 10010,
      *     "project": {
      *       "avatarUrls": {
-     *         "16x16":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002",
-     *         "24x24":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002",
-     *         "32x32":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002",
-     *         "48x48":
-     * "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002"
+     *         "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10002",
+     *         "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002",
+     *         "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10002",
+     *         "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10002"
      *       },
      *       "deleted": true,
      *       "deletedBy": {
@@ -331,20 +312,15 @@ export declare class FilterSharingService extends CommonHttpService {
      *         "accountType": "atlassian",
      *         "active": false,
      *         "avatarUrls": {
-     *           "16x16":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
-     *           "24x24":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
-     *           "32x32":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
-     *           "48x48":
-     * "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
+     *           "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
+     *           "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
+     *           "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
+     *           "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
      *         },
      *         "displayName": "Mia Krystof",
      *         "key": "",
      *         "name": "",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *       },
      *       "deletedDate": "2022-11-11T13:35:29.000+0000",
      *       "id": "10002",
@@ -358,8 +334,7 @@ export declare class FilterSharingService extends CommonHttpService {
      *         "description": "First Project Category",
      *         "id": "10000",
      *         "name": "FIRST",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
      *       },
      *       "retentionTillDate": "2023-01-10T13:35:29.000+0000",
      *       "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY",
@@ -367,8 +342,7 @@ export declare class FilterSharingService extends CommonHttpService {
      *       "style": "classic"
      *     },
      *     "role": {
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/project/MKY/role/10360",
      *       "name": "Developers",
      *       "id": 10360,
      *       "description": "A project role that represents developers in a project",
@@ -408,20 +382,18 @@ export declare class FilterSharingService extends CommonHttpService {
      *     "group": {
      *       "groupId": "276f955c-63d7-42c8-9520-92d01dca0625",
      *       "name": "jira-administrators",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/group?groupId=276f955c-63d7-42c8-9520-92d01dca0625"
      *     },
      *     "id": 10010,
      *     "type": "group"
      *   }
      * ]
-     * @path {GET} /rest/api/3/filter/{id}/permission
+     * ```
+     * @path GET `/rest/api/3/filter/{id}/permission`
      * @scopes-current read:jira-work
-     * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:user:jira,
-     * read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira,
-     * read:issue-type:jira, read:project-category:jira, read:project-role:jira,
-     * read:project-version:jira, read:project.component:jira
+     * @scopes-beta read:filter:jira, read:group:jira, read:project:jira, read:user:jira, read:application-role:jira, read:avatar:jira, read:issue-type-hierarchy:jira, read:issue-type:jira, read:project-category:jira, read:project-role:jira, read:project-version:jira, read:project.component:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filter-sharing#api-rest-api-3-filter-id-permission-get
+     * @param params
      */
     getSharePermissions: ({ id, }: {
         /** The ID of the filter. */
@@ -434,17 +406,22 @@ export declare class FilterSharingService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "scope": "GLOBAL"
      * }
-     * @path {PUT} /rest/api/3/filter/defaultShareScope
+     * ```
+     * @path PUT `/rest/api/3/filter/defaultShareScope`
      * @scopes-current write:jira-work
      * @scopes-beta write:filter.default-share-scope:jira, read:filter.default-share-scope:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-filter-sharing#api-rest-api-3-filter-defaultsharescope-put
+     * @param params
      */
     setDefaultShareScope: ({ defaultShareScope, }: {
         /**
-         * @example {
+         * @example
+         * {
          *     "scope": "GLOBAL"
          * }
          */