@resolution/jira-api-client 0.5.2 → 0.5.4

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

@@ -1,4 +1,4 @@
-import { CommonHttpService } from "../core/CommonHttpService";
+import { CommonHttpService } from "../../core/CommonHttpService";
 import { type Version } from "../models/common";
 import { type DeleteAndReplaceVersionBean, type PageBeanVersion, type VersionIssueCounts, type VersionMoveBean, type VersionRelatedWork, type VersionUnresolvedIssuesCount } from "../models/projectVersions";
 /**
@@ -23,21 +23,26 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "category": "Design",
      *   "relatedWorkId": "fabcdef6-7878-1234-beaf-43211234abcd",
      *   "title": "Design link",
      *   "url": "https://www.atlassian.com"
      * }
-     * @path {POST} /rest/api/3/version/{id}/relatedwork
+     * ```
+     * @path POST `/rest/api/3/version/{id}/relatedwork`
      * @scopes-current write:jira-work
      * @scopes-beta write:issue:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-relatedwork-post
+     * @param params
      */
     createRelatedWork: ({ id, versionRelatedWork, }: {
         id: string;
         /**
-         * @example {
+         * @example
+         * {
          *     "category": "Design",
          *     "title": "Design link",
          *     "url": "https://www.atlassian.com"
@@ -57,7 +62,9 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "archived": false,
      *   "description": "An excellent version",
      *   "id": "10000",
@@ -69,14 +76,17 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *   "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
      *   "userReleaseDate": "6/Jul/2010"
      * }
-     * @path {POST} /rest/api/3/version
+     * ```
+     * @path POST `/rest/api/3/version`
      * @scopes-current manage:jira-project
      * @scopes-beta write:project-version:jira, read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-post
+     * @param params
      */
     createVersion: ({ version, }: {
         /**
-         * @example {
+         * @example
+         * {
          *     "archived": false,
          *     "description": "An excellent version",
          *     "name": "New Version 1",
@@ -105,10 +115,11 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * that contains the version.
      *
      * @returns Returned if the version is deleted.
-     * @path {POST} /rest/api/3/version/{id}/removeAndSwap
+     * @path POST `/rest/api/3/version/{id}/removeAndSwap`
      * @scopes-current manage:jira-project
      * @scopes-beta delete:project-version:jira, write:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-removeandswap-post
+     * @param params
      */
     deleteAndReplaceVersion: ({ id, deleteAndReplaceVersionBean, }: {
         /** The ID of the version. */
@@ -125,10 +136,11 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * permissions](https://confluence.atlassian.com/adminjiraserver/managing-project-permissions-938847145.html)
      * for the project that contains the version.
      *
-     * @path {DELETE} /rest/api/3/version/{versionId}/relatedwork/{relatedWorkId}
+     * @path DELETE `/rest/api/3/version/{versionId}/relatedwork/{relatedWorkId}`
      * @scopes-current write:jira-work
      * @scopes-beta write:issue:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-versionid-relatedwork-relatedworkid-delete
+     * @param params
      */
     deleteRelatedWork: ({ versionId, relatedWorkId, }: {
         /** The ID of the version that the target related work belongs to. */
@@ -157,10 +169,11 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * that contains the version.
      *
      * @deprecated
-     * @path {DELETE} /rest/api/3/version/{id}
+     * @path DELETE `/rest/api/3/version/{id}`
      * @scopes-current manage:jira-project
      * @scopes-beta delete:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-delete
+     * @param params
      */
     deleteVersion: ({ id, moveFixIssuesTo, moveAffectedIssuesTo, }: {
         /** The ID of the version. */
@@ -190,7 +203,9 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: [
+     * example:
+     * ```
+     * [
      *   {
      *     "archived": false,
      *     "description": "An excellent version",
@@ -224,10 +239,12 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *     "startDateSet": false
      *   }
      * ]
-     * @path {GET} /rest/api/3/project/{projectIdOrKey}/versions
+     * ```
+     * @path GET `/rest/api/3/project/{projectIdOrKey}/versions`
      * @scopes-current read:jira-work
      * @scopes-beta read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-project-projectidorkey-versions-get
+     * @param params
      */
     getProjectVersions: ({ projectIdOrKey, expand, }: {
         /** The project ID or project key (case sensitive). */
@@ -251,13 +268,13 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "isLast": false,
      *   "maxResults": 2,
-     *   "nextPage":
-     * "https://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=2&maxResults=2",
-     *   "self":
-     * "https://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=0&maxResults=2",
+     *   "nextPage": "https://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=2&maxResults=2",
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=0&maxResults=2",
      *   "startAt": 0,
      *   "total": 7,
      *   "values": [
@@ -291,10 +308,12 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/project/{projectIdOrKey}/version
+     * ```
+     * @path GET `/rest/api/3/project/{projectIdOrKey}/version`
      * @scopes-current read:jira-work
      * @scopes-beta read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-project-projectidorkey-version-get
+     * @param params
      */
     getProjectVersionsPaginated: ({ projectIdOrKey, startAt, maxResults, orderBy, query, status, expand, }: {
         /** The project ID or project key (case sensitive). */
@@ -349,7 +368,9 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: [
+     * example:
+     * ```
+     * [
      *   {
      *     "category": "Design",
      *     "issueId": 10001,
@@ -370,10 +391,12 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *     "url": "https://www.atlassian.com"
      *   }
      * ]
-     * @path {GET} /rest/api/3/version/{id}/relatedwork
+     * ```
+     * @path GET `/rest/api/3/version/{id}/relatedwork`
      * @scopes-current read:jira-work
      * @scopes-beta read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-relatedwork-get
+     * @param params
      */
     getRelatedWork: ({ id, }: {
         /** The ID of the version. */
@@ -390,7 +413,9 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "archived": false,
      *   "description": "An excellent version",
      *   "id": "10000",
@@ -402,10 +427,12 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *   "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
      *   "userReleaseDate": "6/Jul/2010"
      * }
-     * @path {GET} /rest/api/3/version/{id}
+     * ```
+     * @path GET `/rest/api/3/version/{id}`
      * @scopes-current read:jira-work
      * @scopes-beta read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-get
+     * @param params
      */
     getVersion: ({ id, expand, }: {
         /** The ID of the version. */
@@ -439,7 +466,9 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "customFieldUsage": [
      *     {
      *       "customFieldId": 10000,
@@ -457,10 +486,12 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *   "issuesFixedCount": 23,
      *   "self": "https://your-domain.atlassian.net/rest/api/3/version/10000"
      * }
-     * @path {GET} /rest/api/3/version/{id}/relatedIssueCounts
+     * ```
+     * @path GET `/rest/api/3/version/{id}/relatedIssueCounts`
      * @scopes-current read:jira-work
      * @scopes-beta read:field:jira, read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-relatedissuecounts-get
+     * @param params
      */
     getVersionRelatedIssues: ({ id, }: {
         /** The ID of the version. */
@@ -476,15 +507,19 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "issuesCount": 30,
      *   "issuesUnresolvedCount": 23,
      *   "self": "https://your-domain.atlassian.net/rest/api/3/version/10000"
      * }
-     * @path {GET} /rest/api/3/version/{id}/unresolvedIssueCount
+     * ```
+     * @path GET `/rest/api/3/version/{id}/unresolvedIssueCount`
      * @scopes-current read:jira-work
      * @scopes-beta read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-unresolvedissuecount-get
+     * @param params
      */
     getVersionUnresolvedIssues: ({ id, }: {
         /** The ID of the version. */
@@ -508,10 +543,11 @@ export declare class ProjectVersionsService extends CommonHttpService {
      * that contains the version.
      *
      * @returns Returned if the version is deleted.
-     * @path {PUT} /rest/api/3/version/{id}/mergeto/{moveIssuesTo}
+     * @path PUT `/rest/api/3/version/{id}/mergeto/{moveIssuesTo}`
      * @scopes-current manage:jira-project
      * @scopes-beta delete:project-version:jira, write:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-mergeto-moveissuesto-put
+     * @param params
      */
     mergeVersions: ({ id, moveIssuesTo, }: {
         /** The ID of the version to delete. */
@@ -530,7 +566,9 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "archived": false,
      *   "description": "An excellent version",
      *   "id": "10000",
@@ -542,16 +580,19 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *   "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
      *   "userReleaseDate": "6/Jul/2010"
      * }
-     * @path {POST} /rest/api/3/version/{id}/move
+     * ```
+     * @path POST `/rest/api/3/version/{id}/move`
      * @scopes-current manage:jira-project
      * @scopes-beta write:project-version:jira, read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-move-post
+     * @param params
      */
     moveVersion: ({ id, versionMoveBean, }: {
         /** The ID of the version to be moved. */
         id: string;
         /**
-         * @example {
+         * @example
+         * {
          *     "after": "https://your-domain.atlassian.net/rest/api/~ver~/version/10000"
          * }
          */
@@ -570,16 +611,20 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful together with updated related work.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "category": "Design",
      *   "relatedWorkId": "fabcdef6-7878-1234-beaf-43211234abcd",
      *   "title": "Design link",
      *   "url": "https://www.atlassian.com"
      * }
-     * @path {PUT} /rest/api/3/version/{id}/relatedwork
+     * ```
+     * @path PUT `/rest/api/3/version/{id}/relatedwork`
      * @scopes-current write:jira-work
      * @scopes-beta write:issue:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-relatedwork-put
+     * @param params
      */
     updateRelatedWork: ({ id, versionRelatedWork, }: {
         /**
@@ -588,7 +633,8 @@ export declare class ProjectVersionsService extends CommonHttpService {
          */
         id: string;
         /**
-         * @example {
+         * @example
+         * {
          *     "category": "Design",
          *     "relatedWorkId": "fabcdef6-7878-1234-beaf-43211234abcd",
          *     "title": "Design link",
@@ -609,7 +655,9 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "archived": false,
      *   "description": "An excellent version",
      *   "id": "10000",
@@ -621,16 +669,19 @@ export declare class ProjectVersionsService extends CommonHttpService {
      *   "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
      *   "userReleaseDate": "6/Jul/2010"
      * }
-     * @path {PUT} /rest/api/3/version/{id}
+     * ```
+     * @path PUT `/rest/api/3/version/{id}`
      * @scopes-current manage:jira-project
      * @scopes-beta write:project-version:jira, read:project-version:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions#api-rest-api-3-version-id-put
+     * @param params
      */
     updateVersion: ({ id, version, }: {
         /** The ID of the version. */
         id: string;
         /**
-         * @example {
+         * @example
+         * {
          *     "archived": false,
          *     "description": "An excellent version",
          *     "id": "10000",