@resolution/jira-api-client 0.5.2 → 0.5.4

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

@@ -1,4 +1,4 @@
-import { CommonHttpService } from "../core/CommonHttpService";
+import { CommonHttpService } from "../../core/CommonHttpService";
 import { type ChangedWorklogs, type PageOfWorklogs, type Worklog, type WorklogIdsRequestBean } from "../models/issueWorklogs";
 /**
  * This resource represents issue worklogs. Use it to:
@@ -27,12 +27,11 @@ export declare class IssueWorklogsService extends CommonHttpService {
      * configured, issue-level security permission to view the issue.
      *
      * @returns Returned if the request is successful.
-     * @path {POST} /rest/api/3/issue/{issueIdOrKey}/worklog
+     * @path POST `/rest/api/3/issue/{issueIdOrKey}/worklog`
      * @scopes-current write:jira-work
-     * @scopes-beta write:issue-worklog:jira, write:issue-worklog.property:jira, read:avatar:jira,
-     * read:group:jira, read:issue-worklog:jira, read:project-role:jira,
-     * read:user:jira, read:issue-worklog.property:jira
+     * @scopes-beta write:issue-worklog:jira, write:issue-worklog.property:jira, read:avatar:jira, read:group:jira, read:issue-worklog:jira, read:project-role:jira, read:user:jira, read:issue-worklog.property:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs#api-rest-api-3-issue-issueidorkey-worklog-post
+     * @param params
      */
     addWorklog: ({ issueIdOrKey, notifyUsers, adjustEstimate, newEstimate, reduceBy, expand, overrideEditableFlag, worklog, }: {
         /** The ID or key the issue. */
@@ -74,7 +73,8 @@ export declare class IssueWorklogsService extends CommonHttpService {
          */
         overrideEditableFlag?: boolean | undefined;
         /**
-         * @example {
+         * @example
+         * {
          *     "comment": {
          *         "content": [
          *             {
@@ -122,11 +122,11 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *  *  If the worklog has visibility restrictions, belongs to the group or has the
      * role visibility is restricted to.
      *
-     * @path {DELETE} /rest/api/3/issue/{issueIdOrKey}/worklog/{id}
+     * @path DELETE `/rest/api/3/issue/{issueIdOrKey}/worklog/{id}`
      * @scopes-current write:jira-work
-     * @scopes-beta delete:issue-worklog:jira, delete:issue-worklog.property:jira,
-     * write:issue.time-tracking:jira
+     * @scopes-beta delete:issue-worklog:jira, delete:issue-worklog.property:jira, write:issue.time-tracking:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs#api-rest-api-3-issue-issueidorkey-worklog-id-delete
+     * @param params
      */
     deleteWorklog: ({ issueIdOrKey, id, notifyUsers, adjustEstimate, newEstimate, increaseBy, overrideEditableFlag, }: {
         /** The ID or key of the issue. */
@@ -181,12 +181,12 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "lastPage": true,
-     *   "nextPage":
-     * "https://your-domain.atlassian.net/api/~ver~/worklog/deleted?since=1438013693136",
-     *   "self":
-     * "https://your-domain.atlassian.net/api/~ver~/worklog/deleted?since=1438013671562",
+     *   "nextPage": "https://your-domain.atlassian.net/api/~ver~/worklog/deleted?since=1438013693136",
+     *   "self": "https://your-domain.atlassian.net/api/~ver~/worklog/deleted?since=1438013671562",
      *   "since": 1438013671562,
      *   "until": 1438013693136,
      *   "values": [
@@ -207,10 +207,12 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/worklog/deleted
+     * ```
+     * @path GET `/rest/api/3/worklog/deleted`
      * @scopes-current read:jira-work
      * @scopes-beta read:issue-worklog:jira, read:issue-worklog.property:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs#api-rest-api-3-worklog-deleted-get
+     * @param params
      */
     getIdsOfWorklogsDeletedSince: ({ since, }?: {
         /**
@@ -241,12 +243,12 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "lastPage": true,
-     *   "nextPage":
-     * "https://your-domain.atlassian.net/api/~ver~/worklog/updated?since=1438013693136",
-     *   "self":
-     * "https://your-domain.atlassian.net/api/~ver~/worklog/updated?since=1438013671562",
+     *   "nextPage": "https://your-domain.atlassian.net/api/~ver~/worklog/updated?since=1438013693136",
+     *   "self": "https://your-domain.atlassian.net/api/~ver~/worklog/updated?since=1438013671562",
      *   "since": 1438013671562,
      *   "until": 1438013693136,
      *   "values": [
@@ -267,10 +269,12 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/worklog/updated
+     * ```
+     * @path GET `/rest/api/3/worklog/updated`
      * @scopes-current read:jira-work
      * @scopes-beta read:issue-worklog:jira, read:issue-worklog.property:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs#api-rest-api-3-worklog-updated-get
+     * @param params
      */
     getIdsOfWorklogsModifiedSince: ({ since, expand, }?: {
         /**
@@ -308,7 +312,9 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "maxResults": 1,
      *   "startAt": 0,
      *   "total": 1,
@@ -318,8 +324,7 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *         "accountId": "5b10a2844c20165700ede21g",
      *         "active": false,
      *         "displayName": "Mia Krystof",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *       },
      *       "comment": {
      *         "type": "doc",
@@ -338,8 +343,7 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *       },
      *       "id": "100028",
      *       "issueId": "10002",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
      *       "started": "2021-01-17T12:34:00.000+0000",
      *       "timeSpent": "3h 20m",
      *       "timeSpentSeconds": 12000,
@@ -347,8 +351,7 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *         "accountId": "5b10a2844c20165700ede21g",
      *         "active": false,
      *         "displayName": "Mia Krystof",
-     *         "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *         "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *       },
      *       "updated": "2021-01-18T23:45:00.000+0000",
      *       "visibility": {
@@ -359,11 +362,12 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *     }
      *   ]
      * }
-     * @path {GET} /rest/api/3/issue/{issueIdOrKey}/worklog
+     * ```
+     * @path GET `/rest/api/3/issue/{issueIdOrKey}/worklog`
      * @scopes-current read:jira-work
-     * @scopes-beta read:group:jira, read:issue-worklog:jira, read:issue-worklog.property:jira,
-     * read:project-role:jira, read:user:jira, read:avatar:jira
+     * @scopes-beta read:group:jira, read:issue-worklog:jira, read:issue-worklog.property:jira, read:project-role:jira, read:user:jira, read:avatar:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs#api-rest-api-3-issue-issueidorkey-worklog-get
+     * @param params
      */
     getIssueWorklog: ({ issueIdOrKey, startAt, maxResults, startedAfter, startedBefore, expand, }: {
         /** The ID or key of the issue. */
@@ -410,13 +414,14 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "author": {
      *     "accountId": "5b10a2844c20165700ede21g",
      *     "active": false,
      *     "displayName": "Mia Krystof",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *   },
      *   "comment": {
      *     "type": "doc",
@@ -435,8 +440,7 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *   },
      *   "id": "100028",
      *   "issueId": "10002",
-     *   "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
      *   "started": "2021-01-17T12:34:00.000+0000",
      *   "timeSpent": "3h 20m",
      *   "timeSpentSeconds": 12000,
@@ -444,8 +448,7 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *     "accountId": "5b10a2844c20165700ede21g",
      *     "active": false,
      *     "displayName": "Mia Krystof",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *   },
      *   "updated": "2021-01-18T23:45:00.000+0000",
      *   "visibility": {
@@ -454,12 +457,12 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *     "value": "jira-developers"
      *   }
      * }
-     * @path {GET} /rest/api/3/issue/{issueIdOrKey}/worklog/{id}
+     * ```
+     * @path GET `/rest/api/3/issue/{issueIdOrKey}/worklog/{id}`
      * @scopes-current read:jira-work
-     * @scopes-beta read:comment:jira, read:group:jira, read:issue-worklog:jira,
-     * read:issue-worklog.property:jira, read:project-role:jira, read:user:jira,
-     * read:avatar:jira
+     * @scopes-beta read:comment:jira, read:group:jira, read:issue-worklog:jira, read:issue-worklog.property:jira, read:project-role:jira, read:user:jira, read:avatar:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs#api-rest-api-3-issue-issueidorkey-worklog-id-get
+     * @param params
      */
     getWorklog: ({ issueIdOrKey, id, expand, }: {
         /** The ID or key of the issue. */
@@ -488,14 +491,15 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: [
+     * example:
+     * ```
+     * [
      *   {
      *     "author": {
      *       "accountId": "5b10a2844c20165700ede21g",
      *       "active": false,
      *       "displayName": "Mia Krystof",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *     },
      *     "comment": {
      *       "type": "doc",
@@ -514,8 +518,7 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *     },
      *     "id": "100028",
      *     "issueId": "10002",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
      *     "started": "2021-01-17T12:34:00.000+0000",
      *     "timeSpent": "3h 20m",
      *     "timeSpentSeconds": 12000,
@@ -523,8 +526,7 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *       "accountId": "5b10a2844c20165700ede21g",
      *       "active": false,
      *       "displayName": "Mia Krystof",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *     },
      *     "updated": "2021-01-18T23:45:00.000+0000",
      *     "visibility": {
@@ -534,12 +536,12 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *     }
      *   }
      * ]
-     * @path {POST} /rest/api/3/worklog/list
+     * ```
+     * @path POST `/rest/api/3/worklog/list`
      * @scopes-current read:jira-work
-     * @scopes-beta read:comment:jira, read:group:jira, read:issue-worklog:jira,
-     * read:issue-worklog.property:jira, read:project-role:jira, read:user:jira,
-     * read:avatar:jira
+     * @scopes-beta read:comment:jira, read:group:jira, read:issue-worklog:jira, read:issue-worklog.property:jira, read:project-role:jira, read:user:jira, read:avatar:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs#api-rest-api-3-worklog-list-post
+     * @param params
      */
     getWorklogsForIds: ({ expand, worklogIdsRequestBean, }: {
         /**
@@ -551,7 +553,8 @@ export declare class IssueWorklogsService extends CommonHttpService {
         /**
          * A JSON object containing a list of worklog IDs.
          *
-         * @example {
+         * @example
+         * {
          *     "ids": [
          *         1,
          *         2,
@@ -586,13 +589,14 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "author": {
      *     "accountId": "5b10a2844c20165700ede21g",
      *     "active": false,
      *     "displayName": "Mia Krystof",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *   },
      *   "comment": {
      *     "type": "doc",
@@ -611,8 +615,7 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *   },
      *   "id": "100028",
      *   "issueId": "10002",
-     *   "self":
-     * "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
+     *   "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
      *   "started": "2021-01-17T12:34:00.000+0000",
      *   "timeSpent": "3h 20m",
      *   "timeSpentSeconds": 12000,
@@ -620,8 +623,7 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *     "accountId": "5b10a2844c20165700ede21g",
      *     "active": false,
      *     "displayName": "Mia Krystof",
-     *     "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
+     *     "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
      *   },
      *   "updated": "2021-01-18T23:45:00.000+0000",
      *   "visibility": {
@@ -630,13 +632,12 @@ export declare class IssueWorklogsService extends CommonHttpService {
      *     "value": "jira-developers"
      *   }
      * }
-     * @path {PUT} /rest/api/3/issue/{issueIdOrKey}/worklog/{id}
+     * ```
+     * @path PUT `/rest/api/3/issue/{issueIdOrKey}/worklog/{id}`
      * @scopes-current write:jira-work
-     * @scopes-beta read:comment:jira, read:group:jira, read:issue-worklog:jira,
-     * read:issue-worklog.property:jira, read:project-role:jira, read:user:jira,
-     * write:comment:jira, write:issue-worklog:jira,
-     * write:issue-worklog.property:jira, read:avatar:jira
+     * @scopes-beta read:comment:jira, read:group:jira, read:issue-worklog:jira, read:issue-worklog.property:jira, read:project-role:jira, read:user:jira, write:comment:jira, write:issue-worklog:jira, write:issue-worklog.property:jira, read:avatar:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklogs#api-rest-api-3-issue-issueidorkey-worklog-id-put
+     * @param params
      */
     updateWorklog: ({ issueIdOrKey, id, notifyUsers, adjustEstimate, newEstimate, expand, overrideEditableFlag, worklog, }: {
         /** The ID or key the issue. */
@@ -674,7 +675,8 @@ export declare class IssueWorklogsService extends CommonHttpService {
          */
         overrideEditableFlag?: boolean | undefined;
         /**
-         * @example {
+         * @example
+         * {
          *     "comment": {
          *         "content": [
          *             {