@resolution/jira-api-client 0.5.2 → 0.5.3

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

@@ -24,142 +24,148 @@ export declare class IssueAttachmentsService extends CommonHttpService {
      * *TEST-123*:
      *
      * #### curl ####
-     *
-     *     curl --location --request POST
+     * ```
+     * curl --location --request POST
      * 'https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachments'
-     *      -u 'email@example.com:<api_token>'
-     *      -H 'X-Atlassian-Token: no-check'
-     *      --form 'file=@"myfile.txt"'
+     *  -u 'email@example.com:<api_token>'
+     *  -H 'X-Atlassian-Token: no-check'
+     *  --form 'file=@"myfile.txt"'
+     * ```
      *
      * #### Node.js ####
-     *
-     *     // This code sample uses the 'node-fetch' and 'form-data' libraries:
-     *      // https://www.npmjs.com/package/node-fetch
-     *      // https://www.npmjs.com/package/form-data
-     *      const fetch = require('node-fetch');
-     *      const FormData = require('form-data');
-     *      const fs = require('fs');
-     *
-     *      const filePath = 'myfile.txt';
-     *      const form = new FormData();
-     *      const stats = fs.statSync(filePath);
-     *      const fileSizeInBytes = stats.size;
-     *      const fileStream = fs.createReadStream(filePath);
-     *
-     *      form.append('file', fileStream, {knownLength: fileSizeInBytes});
-     *
-     *      fetch('https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachments',
+     * ```
+     * // This code sample uses the 'node-fetch' and 'form-data' libraries:
+     *  // https://www.npmjs.com/package/node-fetch
+     *  // https://www.npmjs.com/package/form-data
+     *  const fetch = require('node-fetch');
+     *  const FormData = require('form-data');
+     *  const fs = require('fs');
+     *
+     *  const filePath = 'myfile.txt';
+     *  const form = new FormData();
+     *  const stats = fs.statSync(filePath);
+     *  const fileSizeInBytes = stats.size;
+     *  const fileStream = fs.createReadStream(filePath);
+     *
+     *  form.append('file', fileStream, {knownLength: fileSizeInBytes});
+     *
+     *  fetch('https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachments',
      * {
-     *          method: 'POST',
-     *          body: form,
-     *          headers: {
-     *              'Authorization': `Basic ${Buffer.from(
-     *                  'email@example.com:'
-     *              ).toString('base64')}`,
-     *              'Accept': 'application/json',
-     *              'X-Atlassian-Token': 'no-check'
-     *          }
+     *      method: 'POST',
+     *      body: form,
+     *      headers: {
+     *          'Authorization': `Basic ${Buffer.from(
+     *              'email@example.com:'
+     *          ).toString('base64')}`,
+     *          'Accept': 'application/json',
+     *          'X-Atlassian-Token': 'no-check'
+     *      }
+     *  })
+     *      .then(response => {
+     *          console.log(
+     *              `Response: ${response.status} ${response.statusText}`
+     *          );
+     *          return response.text();
      *      })
-     *          .then(response => {
-     *              console.log(
-     *                  `Response: ${response.status} ${response.statusText}`
-     *              );
-     *              return response.text();
-     *          })
-     *          .then(text => console.log(text))
-     *          .catch(err => console.error(err));
+     *      .then(text => console.log(text))
+     *      .catch(err => console.error(err));
+     * ```
      *
      * #### Java ####
-     *
-     *     // This code sample uses the  'Unirest' library:
-     *      // http://unirest.io/java.html
-     *      HttpResponse response =
+     * ```
+     * // This code sample uses the  'Unirest' library:
+     *  // http://unirest.io/java.html
+     *  HttpResponse response =
      * Unirest.post("https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments")
-     *              .basicAuth("email@example.com", "")
-     *              .header("Accept", "application/json")
-     *              .header("X-Atlassian-Token", "no-check")
-     *              .field("file", new File("myfile.txt"))
-     *              .asJson();
+     *          .basicAuth("email@example.com", "")
+     *          .header("Accept", "application/json")
+     *          .header("X-Atlassian-Token", "no-check")
+     *          .field("file", new File("myfile.txt"))
+     *          .asJson();
      *
-     *              System.out.println(response.getBody());
+     *          System.out.println(response.getBody());
+     * ```
      *
      * #### Python ####
-     *
-     *     # This code sample uses the 'requests' library:
-     *      # http://docs.python-requests.org
-     *      import requests
-     *      from requests.auth import HTTPBasicAuth
-     *      import json
-     *
-     *      url =
+     * ```
+     * # This code sample uses the 'requests' library:
+     *  # http://docs.python-requests.org
+     *  import requests
+     *  from requests.auth import HTTPBasicAuth
+     *  import json
+     *
+     *  url =
      * "https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments"
      *
-     *      auth = HTTPBasicAuth("email@example.com", "")
+     *  auth = HTTPBasicAuth("email@example.com", "")
      *
-     *      headers = {
-     *         "Accept": "application/json",
-     *         "X-Atlassian-Token": "no-check"
-     *      }
+     *  headers = {
+     *     "Accept": "application/json",
+     *     "X-Atlassian-Token": "no-check"
+     *  }
      *
-     *      response = requests.request(
-     *         "POST",
-     *         url,
-     *         headers = headers,
-     *         auth = auth,
-     *         files = {
-     *              "file": ("myfile.txt", open("myfile.txt","rb"), "application-type")
-     *         }
-     *      )
-     *
-     *      print(json.dumps(json.loads(response.text), sort_keys=True, indent=4,
+     *  response = requests.request(
+     *     "POST",
+     *     url,
+     *     headers = headers,
+     *     auth = auth,
+     *     files = {
+     *          "file": ("myfile.txt", open("myfile.txt","rb"), "application-type")
+     *     }
+     *  )
+     *
+     *  print(json.dumps(json.loads(response.text), sort_keys=True, indent=4,
      * separators=(",", ": ")))
+     * ```
      *
      * #### PHP ####
+     * ```
+     * // This code sample uses the 'Unirest' library:
+     *  // http://unirest.io/php.html
+     *  Unirest\Request::auth('email@example.com', '');
      *
-     *     // This code sample uses the 'Unirest' library:
-     *      // http://unirest.io/php.html
-     *      Unirest\Request::auth('email@example.com', '');
-     *
-     *      $headers = array(
-     *        'Accept' => 'application/json',
-     *        'X-Atlassian-Token' => 'no-check'
-     *      );
+     *  $headers = array(
+     *    'Accept' => 'application/json',
+     *    'X-Atlassian-Token' => 'no-check'
+     *  );
      *
-     *      $parameters = array(
-     *        'file' => File::add('myfile.txt')
-     *      );
+     *  $parameters = array(
+     *    'file' => File::add('myfile.txt')
+     *  );
      *
-     *      $response = Unirest\Request::post(
-     *        'https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments',
-     *        $headers,
-     *        $parameters
-     *      );
+     *  $response = Unirest\Request::post(
+     *    'https://your-domain.atlassian.net/rest/api/2/issue/{issueIdOrKey}/attachments',
+     *    $headers,
+     *    $parameters
+     *  );
      *
-     *      var_dump($response)
+     *  var_dump($response)
+     * ```
      *
      * #### Forge ####
+     * ```
+     * // This sample uses Atlassian Forge and the `form-data` library.
+     *  // https://developer.atlassian.com/platform/forge/
+     *  // https://www.npmjs.com/package/form-data
+     *  import api from "@forge/api";
+     *  import FormData from "form-data";
      *
-     *     // This sample uses Atlassian Forge and the `form-data` library.
-     *      // https://developer.atlassian.com/platform/forge/
-     *      // https://www.npmjs.com/package/form-data
-     *      import api from "@forge/api";
-     *      import FormData from "form-data";
+     *  const form = new FormData();
+     *  form.append('file', fileStream, {knownLength: fileSizeInBytes});
      *
-     *      const form = new FormData();
-     *      form.append('file', fileStream, {knownLength: fileSizeInBytes});
-     *
-     *      const response = await
+     *  const response = await
      * api.asApp().requestJira('/rest/api/2/issue/{issueIdOrKey}/attachments', {
-     *          method: 'POST',
-     *          body: form,
-     *          headers: {
-     *              'Accept': 'application/json',
-     *              'X-Atlassian-Token': 'no-check'
-     *          }
-     *      });
+     *      method: 'POST',
+     *      body: form,
+     *      headers: {
+     *          'Accept': 'application/json',
+     *          'X-Atlassian-Token': 'no-check'
+     *      }
+     *  });
      *
-     *      console.log(`Response: ${response.status} ${response.statusText}`);
-     *      console.log(await response.json());
+     *  console.log(`Response: ${response.status} ${response.statusText}`);
+     *  console.log(await response.json());
+     * ```
      *
      * Tip: Use a client library. Many client libraries have classes for handling
      * multipart POST operations. For example, in Java, the Apache HTTP Components
@@ -179,60 +185,49 @@ export declare class IssueAttachmentsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: [
+     * example:
+     * ```
+     * [
      *   {
      *     "author": {
      *       "accountId": "5b10a2844c20165700ede21g",
      *       "active": true,
      *       "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",
      *       "emailAddress": "mia@example.com",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      *       "timeZone": "Australia/Sydney"
      *     },
-     *     "content":
-     * "https://your-domain.atlassian.net/rest/api/3/attachment/content/10000",
+     *     "content": "https://your-domain.atlassian.net/rest/api/3/attachment/content/10000",
      *     "created": 1651316514000,
      *     "filename": "picture.jpg",
      *     "id": "10001",
      *     "mimeType": "image/jpeg",
      *     "self": "https://your-domain.atlassian.net/rest/api/3/attachments/10000",
      *     "size": 23123,
-     *     "thumbnail":
-     * "https://your-domain.atlassian.net/rest/api/3/attachment/thumbnail/10000"
+     *     "thumbnail": "https://your-domain.atlassian.net/rest/api/3/attachment/thumbnail/10000"
      *   },
      *   {
      *     "author": {
      *       "accountId": "5b10a2844c20165700ede21g",
      *       "active": true,
      *       "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",
      *       "emailAddress": "mia@example.com",
-     *       "self":
-     * "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
+     *       "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
      *       "timeZone": "Australia/Sydney"
      *     },
-     *     "content":
-     * "https://your-domain.atlassian.net/rest/api/3/attachment/content/10001",
+     *     "content": "https://your-domain.atlassian.net/rest/api/3/attachment/content/10001",
      *     "created": 1658898511000,
      *     "filename": "dbeuglog.txt",
      *     "mimeType": "text/plain",
@@ -240,10 +235,12 @@ export declare class IssueAttachmentsService extends CommonHttpService {
      *     "size": 2460
      *   }
      * ]
-     * @path {POST} /rest/api/3/issue/{issueIdOrKey}/attachments
+     * ```
+     * @path POST `/rest/api/3/issue/{issueIdOrKey}/attachments`
      * @scopes-current write:jira-work
      * @scopes-beta read:user:jira, write:attachment:jira, read:attachment:jira, read:avatar:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments#api-rest-api-3-issue-issueidorkey-attachments-post
+     * @param params
      */
     addAttachment: ({ issueIdOrKey, requestBody, }: {
         /** The ID or key of the issue that attachments are added to. */
@@ -276,10 +273,11 @@ export declare class IssueAttachmentsService extends CommonHttpService {
      *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
      * configured, issue-level security permission to view the issue.
      *
-     * @returns Returned if the request is successful. If an empty list is returned in the
-     * response, the attachment is empty, corrupt, or not an archive.
+     * @returns Returned if the request is successful. If an empty list is returned in the response, the attachment is empty, corrupt, or not an archive.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "entries": [
      *     {
      *       "index": 0,
@@ -299,8 +297,7 @@ export declare class IssueAttachmentsService extends CommonHttpService {
      *       "index": 2,
      *       "label": "long/path/thanks/to/.../reach/the/leaf.txt",
      *       "mediaType": "text/plain",
-     *       "path":
-     * "long/path/thanks/to/lots/of/subdirectories/inside/making/it/quite/hard/to/reach/the/leaf.txt",
+     *       "path": "long/path/thanks/to/lots/of/subdirectories/inside/making/it/quite/hard/to/reach/the/leaf.txt",
      *       "size": "0.0 k"
      *     }
      *   ],
@@ -309,10 +306,12 @@ export declare class IssueAttachmentsService extends CommonHttpService {
      *   "name": "images.zip",
      *   "totalEntryCount": 39
      * }
-     * @path {GET} /rest/api/3/attachment/{id}/expand/human
+     * ```
+     * @path GET `/rest/api/3/attachment/{id}/expand/human`
      * @scopes-current read:jira-work
      * @scopes-beta read:attachment:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments#api-rest-api-3-attachment-id-expand-human-get
+     * @param params
      */
     expandAttachmentForHumans: ({ id, }: {
         /** The ID of the attachment. */
@@ -342,10 +341,11 @@ export declare class IssueAttachmentsService extends CommonHttpService {
      *  *  If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
      * configured, issue-level security permission to view the issue.
      *
-     * @returns Returned if the request is successful. If an empty list is returned in the
-     * response, the attachment is empty, corrupt, or not an archive.
+     * @returns Returned if the request is successful. If an empty list is returned in the response, the attachment is empty, corrupt, or not an archive.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "entries": [
      *     {
      *       "entryIndex": 0,
@@ -362,10 +362,12 @@ export declare class IssueAttachmentsService extends CommonHttpService {
      *   ],
      *   "totalEntryCount": 24
      * }
-     * @path {GET} /rest/api/3/attachment/{id}/expand/raw
+     * ```
+     * @path GET `/rest/api/3/attachment/{id}/expand/raw`
      * @scopes-current read:jira-work
      * @scopes-beta read:attachment:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments#api-rest-api-3-attachment-id-expand-raw-get
+     * @param params
      */
     expandAttachmentForMachines: ({ id, }: {
         /** The ID of the attachment. */
@@ -387,43 +389,39 @@ export declare class IssueAttachmentsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "author": {
      *     "accountId": "5b10a2844c20165700ede21g",
      *     "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"
      *   },
-     *   "content":
-     * "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10000",
+     *   "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10000",
      *   "created": "2022-10-06T07:32:47.000+0000",
      *   "filename": "picture.jpg",
      *   "id": 10000,
      *   "mimeType": "image/jpeg",
      *   "self": "https://your-domain.atlassian.net/rest/api/3/attachments/10000",
      *   "size": 23123,
-     *   "thumbnail":
-     * "https://your-domain.atlassian.net/jira/rest/api/3/attachment/thumbnail/10000"
+     *   "thumbnail": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/thumbnail/10000"
      * }
-     * @path {GET} /rest/api/3/attachment/{id}
+     * ```
+     * @path GET `/rest/api/3/attachment/{id}`
      * @scopes-current read:jira-work
-     * @scopes-beta read:attachment:jira, read:user:jira, read:application-role:jira,
-     * read:avatar:jira, read:group:jira
+     * @scopes-beta read:attachment:jira, read:user:jira, read:application-role:jira, read:avatar:jira, read:group:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments#api-rest-api-3-attachment-id-get
+     * @param params
      */
     getAttachment: ({ id, }: {
         /** The ID of the attachment. */
@@ -450,10 +448,11 @@ export declare class IssueAttachmentsService extends CommonHttpService {
      * configured, issue-level security permission to view the issue.
      *
      * @returns Returned if the request is successful when `redirect` is set to `false`.
-     * @path {GET} /rest/api/3/attachment/content/{id}
+     * @path GET `/rest/api/3/attachment/content/{id}`
      * @scopes-current read:jira-work
      * @scopes-beta read:attachment:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments#api-rest-api-3-attachment-content-id-get
+     * @param params
      */
     getAttachmentContent: ({ id, redirect, }: {
         /** The ID of the attachment. */
@@ -479,11 +478,14 @@ export declare class IssueAttachmentsService extends CommonHttpService {
      *
      * @returns Returned if the request is successful.
      *
-     * example: {
+     * example:
+     * ```
+     * {
      *   "enabled": true,
      *   "uploadLimit": 1000000
      * }
-     * @path {GET} /rest/api/3/attachment/meta
+     * ```
+     * @path GET `/rest/api/3/attachment/meta`
      * @scopes-current read:jira-work
      * @scopes-beta read:instance-configuration:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments#api-rest-api-3-attachment-meta-get
@@ -507,10 +509,11 @@ export declare class IssueAttachmentsService extends CommonHttpService {
      * configured, issue-level security permission to view the issue.
      *
      * @returns Returned if the request is successful when `redirect` is set to `false`.
-     * @path {GET} /rest/api/3/attachment/thumbnail/{id}
+     * @path GET `/rest/api/3/attachment/thumbnail/{id}`
      * @scopes-current read:jira-work
      * @scopes-beta read:attachment:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments#api-rest-api-3-attachment-thumbnail-id-get
+     * @param params
      */
     getAttachmentThumbnail: ({ id, redirect, fallbackToDefault, width, height, }: {
         /** The ID of the attachment. */
@@ -546,10 +549,11 @@ export declare class IssueAttachmentsService extends CommonHttpService {
      * permission](https://confluence.atlassian.com/x/yodKLg) to delete an attachment
      * created by any user.
      *
-     * @path {DELETE} /rest/api/3/attachment/{id}
+     * @path DELETE `/rest/api/3/attachment/{id}`
      * @scopes-current write:jira-work
      * @scopes-beta delete:attachment:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments#api-rest-api-3-attachment-id-delete
+     * @param params
      */
     removeAttachment: ({ id, }: {
         /** The ID of the attachment. */