@resolution/jira-api-client 0.6.0 → 0.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/lib/index.d.ts +1 -2
  3. package/lib/index.js.map +1 -1
  4. package/lib/openapi/platform/BaseJiraPlatformApiClient.d.ts +15 -15
  5. package/lib/openapi/platform/BaseJiraPlatformApiClient.js +8 -8
  6. package/lib/openapi/platform/BaseJiraPlatformApiClient.js.map +1 -1
  7. package/lib/openapi/platform/models/common.d.ts +0 -23
  8. package/lib/openapi/platform/models/common.js +0 -10
  9. package/lib/openapi/platform/models/common.js.map +1 -1
  10. package/lib/openapi/platform/models/issueLinks.d.ts +23 -0
  11. package/lib/openapi/platform/models/issueLinks.js +10 -0
  12. package/lib/openapi/platform/models/issueLinks.js.map +1 -1
  13. package/lib/openapi/platform/models/issueSearch.d.ts +104 -0
  14. package/lib/openapi/platform/models/issueSearch.js +37 -0
  15. package/lib/openapi/platform/models/issueSearch.js.map +1 -1
  16. package/lib/openapi/platform/models/issues.d.ts +117 -2
  17. package/lib/openapi/platform/models/issues.js +51 -1
  18. package/lib/openapi/platform/models/issues.js.map +1 -1
  19. package/lib/openapi/platform/models/jiraExpressions.d.ts +174 -0
  20. package/lib/openapi/platform/models/jiraExpressions.js +76 -0
  21. package/lib/openapi/platform/models/jiraExpressions.js.map +1 -1
  22. package/lib/openapi/platform/models/projects.d.ts +1 -1
  23. package/lib/openapi/platform/models/projects.js +1 -0
  24. package/lib/openapi/platform/models/projects.js.map +1 -1
  25. package/lib/openapi/platform/models/workflows.d.ts +47 -0
  26. package/lib/openapi/platform/models/workflows.js +19 -0
  27. package/lib/openapi/platform/models/workflows.js.map +1 -1
  28. package/lib/openapi/platform/services/IssueBulkOperationsService.d.ts +7 -7
  29. package/lib/openapi/platform/services/IssueBulkOperationsService.js +7 -7
  30. package/lib/openapi/platform/services/IssueLinksService.d.ts +1 -2
  31. package/lib/openapi/platform/services/IssueLinksService.js +2 -2
  32. package/lib/openapi/platform/services/IssueLinksService.js.map +1 -1
  33. package/lib/openapi/platform/services/IssueSearchService.d.ts +498 -1
  34. package/lib/openapi/platform/services/IssueSearchService.js +558 -0
  35. package/lib/openapi/platform/services/IssueSearchService.js.map +1 -1
  36. package/lib/openapi/platform/services/IssueWorklogsService.d.ts +12 -0
  37. package/lib/openapi/platform/services/IssueWorklogsService.js +1 -0
  38. package/lib/openapi/platform/services/IssueWorklogsService.js.map +1 -1
  39. package/lib/openapi/platform/services/IssuesService.d.ts +225 -1
  40. package/lib/openapi/platform/services/IssuesService.js +225 -0
  41. package/lib/openapi/platform/services/IssuesService.js.map +1 -1
  42. package/lib/openapi/platform/services/JiraExpressionsService.d.ts +189 -1
  43. package/lib/openapi/platform/services/JiraExpressionsService.js +153 -0
  44. package/lib/openapi/platform/services/JiraExpressionsService.js.map +1 -1
  45. package/lib/openapi/platform/services/LicenseMetricsService.d.ts +4 -4
  46. package/lib/openapi/platform/services/LicenseMetricsService.js +4 -4
  47. package/lib/openapi/platform/services/WorkflowsService.d.ts +6 -1
  48. package/lib/openapi/platform/services/WorkflowsService.js +2 -1
  49. package/lib/openapi/platform/services/WorkflowsService.js.map +1 -1
  50. package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.d.ts +1 -1
  51. package/lib/openapi/serviceManagement/BaseJiraServiceManagementApiClient.js +1 -1
  52. package/lib/openapi/serviceManagement/models/request.d.ts +4 -4
  53. package/lib/openapi/software/models/board.d.ts +39 -24
  54. package/lib/openapi/software/models/board.js +25 -11
  55. package/lib/openapi/software/models/board.js.map +1 -1
  56. package/package.json +3 -3
@@ -1,7 +1,7 @@
1
1
  import { CommonHttpService } from "../../core/CommonHttpService";
2
2
  import { type BulkEditGetFields, type BulkOperationProgress, type IssueBulkEditPayload, type IssueBulkMovePayload, type SubmittedBulkOperation } from "../models/issueBulkOperations";
3
3
  /**
4
- * This resource represents the Issue Bulk Operations. Use it to move multiple
4
+ * This resource represents the issue bulk operations. Use it to move multiple
5
5
  * issues from one project to another project or edit fields of multiple issues in
6
6
  * one go.
7
7
  *
@@ -13,15 +13,15 @@ import { type BulkEditGetFields, type BulkOperationProgress, type IssueBulkEditP
13
13
  *
14
14
  * ### Authentication ###
15
15
  *
16
- * Access to the Issue Bulk Operations requires authentication. For information on
17
- * how to authenticate API requests, refer to the [Basic Auth for REST APIs
16
+ * Access to the issue bulk operations requires authentication. For information on
17
+ * how to authenticate API requests, refer to the [Basic auth for REST APIs
18
18
  * documentation](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).
19
19
  *
20
- * ### Rate Limiting ###
20
+ * ### Rate limiting ###
21
21
  *
22
- * The Bulk Edit and Move APIs are subject to the usual rate limiting
23
- * infrastructure in Jira. For more information, please refer to [Rate
24
- * Limiting](https://developer.atlassian.com/cloud/jira/platform/rate-limiting/).
22
+ * The bulk edit and move APIs are subject to the usual rate limiting
23
+ * infrastructure in Jira. For more information, refer to [Rate
24
+ * limiting](https://developer.atlassian.com/cloud/jira/platform/rate-limiting/).
25
25
  * Additionally, at any given time, only 5 concurrent requests can be sent across
26
26
  * all users.
27
27
  *
@@ -10,7 +10,7 @@ const CommonHttpService_1 = require("../../core/CommonHttpService");
10
10
  const issueBulkOperations_1 = require("../models/issueBulkOperations");
11
11
  const validationSchemaStorage_1 = require("../validationSchemaStorage");
12
12
  /**
13
- * This resource represents the Issue Bulk Operations. Use it to move multiple
13
+ * This resource represents the issue bulk operations. Use it to move multiple
14
14
  * issues from one project to another project or edit fields of multiple issues in
15
15
  * one go.
16
16
  *
@@ -22,15 +22,15 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
22
22
  *
23
23
  * ### Authentication ###
24
24
  *
25
- * Access to the Issue Bulk Operations requires authentication. For information on
26
- * how to authenticate API requests, refer to the [Basic Auth for REST APIs
25
+ * Access to the issue bulk operations requires authentication. For information on
26
+ * how to authenticate API requests, refer to the [Basic auth for REST APIs
27
27
  * documentation](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/).
28
28
  *
29
- * ### Rate Limiting ###
29
+ * ### Rate limiting ###
30
30
  *
31
- * The Bulk Edit and Move APIs are subject to the usual rate limiting
32
- * infrastructure in Jira. For more information, please refer to [Rate
33
- * Limiting](https://developer.atlassian.com/cloud/jira/platform/rate-limiting/).
31
+ * The bulk edit and move APIs are subject to the usual rate limiting
32
+ * infrastructure in Jira. For more information, refer to [Rate
33
+ * limiting](https://developer.atlassian.com/cloud/jira/platform/rate-limiting/).
34
34
  * Additionally, at any given time, only 5 concurrent requests can be sent across
35
35
  * all users.
36
36
  *
@@ -1,6 +1,5 @@
1
1
  import { CommonHttpService } from "../../core/CommonHttpService";
2
- import { type IssueLink } from "../models/common";
3
- import type { LinkIssueRequestJsonBean } from "../models/issueLinks";
2
+ import { type IssueLink, type LinkIssueRequestJsonBean } from "../models/issueLinks";
4
3
  /**
5
4
  * This resource represents links between issues. Use it to get, create, and
6
5
  * delete links between issues.
@@ -7,7 +7,7 @@ exports.IssueLinksService = void 0;
7
7
  const zod_1 = require("zod");
8
8
  const commonHttpClient = require("../../core/CommonHttpClient");
9
9
  const CommonHttpService_1 = require("../../core/CommonHttpService");
10
- const common_1 = require("../models/common");
10
+ const issueLinks_1 = require("../models/issueLinks");
11
11
  const validationSchemaStorage_1 = require("../validationSchemaStorage");
12
12
  /**
13
13
  * This resource represents links between issues. Use it to get, create, and
@@ -262,7 +262,7 @@ class IssueLinksService extends CommonHttpService_1.CommonHttpService {
262
262
  body: validationSchemaStorage_1.validationSchemaStorage.lazy("IssueLink"),
263
263
  })
264
264
  .describe("IssueLinksService.getIssueLink.response"));
265
- validationSchemaStorage_1.validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
265
+ validationSchemaStorage_1.validationSchemaStorage.registerOnce([issueLinks_1.registerIssueLinksValidationSchemas]);
266
266
  }
267
267
  }
268
268
  exports.IssueLinksService = IssueLinksService;
@@ -1 +1 @@
1
- {"version":3,"file":"IssueLinksService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/IssueLinksService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,gEAAgE;AAChE,oEAAiE;AACjE,6CAG0B;AAE1B,wEAAqE;AACrE;;;;;;;;;GASG;AACH,MAAa,iBAAkB,SAAQ,qCAAiB;IAAxD;;QACE;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,oBAAe,GAAG,CAAC,EACjB,MAAM,GAIP,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,gCAAgC;gBACtC,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,MAAM;iBACP;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAqHG;QACH,iBAAY,GAAG,CAAC,EACd,MAAM,GAIP,EAAsB,EAAE;YACvB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,gCAAgC;gBACtC,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;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,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CACjC,iDAAuB,CAAC,SAAS,CAC/B,yCAAyC,CAC1C,CACF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmCG;QACH,eAAU,GAAG,CAAC,EACZ,wBAAwB,GAyCzB,EAAoB,EAAE;YACrB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,uBAAuB;gBAC7B,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,wBAAwB;aAC/B,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,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CACjC,iDAAuB,CAAC,SAAS,CAC/B,uCAAuC,CACxC,CACF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAwBJ,CAAC;IAvBW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CACxC,uCAAuC,EACvC,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,uCAAuC,CAAC,CACrD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yCAAyC,EACzC,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,WAAW,CAAC;SAChD,CAAC;aACD,QAAQ,CAAC,yCAAyC,CAAC,CACvD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAxUD,8CAwUC"}
1
+ {"version":3,"file":"IssueLinksService.js","sourceRoot":"","sources":["../../../../src/openapi/platform/services/IssueLinksService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,gEAAgE;AAChE,oEAAiE;AACjE,qDAI8B;AAC9B,wEAAqE;AACrE;;;;;;;;;GASG;AACH,MAAa,iBAAkB,SAAQ,qCAAiB;IAAxD;;QACE;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,oBAAe,GAAG,CAAC,EACjB,MAAM,GAIP,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,gCAAgC;gBACtC,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,MAAM;iBACP;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAqHG;QACH,iBAAY,GAAG,CAAC,EACd,MAAM,GAIP,EAAsB,EAAE;YACvB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,gCAAgC;gBACtC,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;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,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CACjC,iDAAuB,CAAC,SAAS,CAC/B,yCAAyC,CAC1C,CACF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAmCG;QACH,eAAU,GAAG,CAAC,EACZ,wBAAwB,GAyCzB,EAAoB,EAAE;YACrB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,uBAAuB;gBAC7B,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,wBAAwB;aAC/B,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,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CACjC,iDAAuB,CAAC,SAAS,CAC/B,uCAAuC,CACxC,CACF,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAwBJ,CAAC;IAvBW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CACxC,uCAAuC,EACvC,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,uCAAuC,CAAC,CACrD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yCAAyC,EACzC,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,WAAW,CAAC;SAChD,CAAC;aACD,QAAQ,CAAC,yCAAyC,CAAC,CACvD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,gDAAmC,CAAC,CAAC,CAAC;IAC9E,CAAC;CACF;AAxUD,8CAwUC"}
@@ -1,5 +1,5 @@
1
1
  import { CommonHttpService } from "../../core/CommonHttpService";
2
- import { type IdSearchRequestBean, type IdSearchResults, type IssueMatches, type IssuePickerSuggestions, type IssuesAndJqlQueries, type SearchRequestBean, type SearchResults } from "../models/issueSearch";
2
+ import { type IdSearchRequestBean, type IdSearchResults, type IssueMatches, type IssuePickerSuggestions, type IssuesAndJqlQueries, type JqlCountRequestBean, type JqlCountResultsBean, type SearchAndReconcileRequestBean, type SearchAndReconcileResults, type SearchRequestBean, type SearchResults } from "../models/issueSearch";
3
3
  /**
4
4
  * This resource represents various ways to search for issues. Use it to search
5
5
  * for issues with a JQL query and find issues to populate an issue picker.
@@ -8,6 +8,48 @@ import { type IdSearchRequestBean, type IdSearchResults, type IssueMatches, type
8
8
  * @category Services
9
9
  */
10
10
  export declare class IssueSearchService extends CommonHttpService {
11
+ /**
12
+ * Provide an estimated count of the issues that match the
13
+ * [JQL](https://confluence.atlassian.com/x/egORLQ). Recent updates might not be
14
+ * immediately visible in the returned output. This endpoint requires JQL to be
15
+ * bounded.
16
+ *
17
+ * This operation can be accessed anonymously.
18
+ *
19
+ * **[Permissions](#permissions) required:** Issues are included in the response
20
+ * where the user has:
21
+ *
22
+ * * *Browse projects* [project
23
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project
24
+ * containing the issue.
25
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
26
+ * configured, issue-level security permission to view the issue.
27
+ *
28
+ * @returns Returned if the request is successful.
29
+ *
30
+ * example:
31
+ * ```
32
+ * {
33
+ * "count": 153
34
+ * }
35
+ * ```
36
+ * @path POST `/rest/api/3/search/approximate-count`
37
+ * @scopes-current read:jira-work
38
+ * @scopes-beta read:issue-details:jira, read:field.default-value:jira, read:field.option:jira, read:field:jira, read:group:jira
39
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search#api-rest-api-3-search-approximate-count-post
40
+ * @param params
41
+ */
42
+ countIssues: ({ jqlCountRequestBean, }: {
43
+ /**
44
+ * A JSON object containing the search request.
45
+ *
46
+ * @example
47
+ * {
48
+ * "jql": "project = HSP"
49
+ * }
50
+ */
51
+ jqlCountRequestBean: JqlCountRequestBean;
52
+ }) => Promise<JqlCountResultsBean>;
11
53
  /**
12
54
  * Returns lists of issues matching a query string. Use this resource to provide
13
55
  * auto-completion suggestions when the user is looking for an issue using a word
@@ -128,6 +170,461 @@ export declare class IssueSearchService extends CommonHttpService {
128
170
  */
129
171
  issuesAndJqlQueries: IssuesAndJqlQueries;
130
172
  }) => Promise<IssueMatches>;
173
+ /**
174
+ * Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).
175
+ * Recent updates might not be immediately visible in the returned search results.
176
+ * If you need read-after-write consistency, you can utilize the `reconcileIssues`
177
+ * parameter to ensure stronger consistency assurances. This operation can be
178
+ * accessed anonymously.
179
+ *
180
+ * If the JQL query expression is too large to be encoded as a query parameter,
181
+ * use the [POST](#api-rest-api-3-search-post) version of this resource.
182
+ *
183
+ * **[Permissions](#permissions) required:** Issues are included in the response
184
+ * where the user has:
185
+ *
186
+ * * *Browse projects* [project
187
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project
188
+ * containing the issue.
189
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
190
+ * configured, issue-level security permission to view the issue.
191
+ *
192
+ * @returns Returned if the request is successful.
193
+ *
194
+ * example:
195
+ * ```
196
+ * {
197
+ * "issues": [
198
+ * {
199
+ * "expand": "",
200
+ * "fields": {
201
+ * "watcher": {
202
+ * "isWatching": false,
203
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
204
+ * "watchCount": 1
205
+ * },
206
+ * "attachment": [
207
+ * {
208
+ * "author": {
209
+ * "accountId": "5b10a2844c20165700ede21g",
210
+ * "accountType": "atlassian",
211
+ * "active": false,
212
+ * "avatarUrls": {
213
+ * "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
214
+ * "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
215
+ * "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
216
+ * "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
217
+ * },
218
+ * "displayName": "Mia Krystof",
219
+ * "key": "",
220
+ * "name": "",
221
+ * "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
222
+ * },
223
+ * "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10001",
224
+ * "created": "2023-06-24T19:24:50.000+0000",
225
+ * "filename": "debuglog.txt",
226
+ * "id": 10001,
227
+ * "mimeType": "text/plain",
228
+ * "self": "https://your-domain.atlassian.net/rest/api/2/attachments/10001",
229
+ * "size": 2460
230
+ * }
231
+ * ],
232
+ * "sub-tasks": [
233
+ * {
234
+ * "id": "10000",
235
+ * "outwardIssue": {
236
+ * "fields": {
237
+ * "status": {
238
+ * "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
239
+ * "name": "Open"
240
+ * }
241
+ * },
242
+ * "id": "10003",
243
+ * "key": "ED-2",
244
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
245
+ * },
246
+ * "type": {
247
+ * "id": "10000",
248
+ * "inward": "Parent",
249
+ * "name": "",
250
+ * "outward": "Sub-task"
251
+ * }
252
+ * }
253
+ * ],
254
+ * "description": "Main order flow broken",
255
+ * "project": {
256
+ * "avatarUrls": {
257
+ * "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
258
+ * "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
259
+ * "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
260
+ * "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
261
+ * },
262
+ * "id": "10000",
263
+ * "insight": {
264
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
265
+ * "totalIssueCount": 100
266
+ * },
267
+ * "key": "EX",
268
+ * "name": "Example",
269
+ * "projectCategory": {
270
+ * "description": "First Project Category",
271
+ * "id": "10000",
272
+ * "name": "FIRST",
273
+ * "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
274
+ * },
275
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
276
+ * "simplified": false,
277
+ * "style": "classic"
278
+ * },
279
+ * "comment": [
280
+ * {
281
+ * "author": {
282
+ * "accountId": "5b10a2844c20165700ede21g",
283
+ * "active": false,
284
+ * "displayName": "Mia Krystof",
285
+ * "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
286
+ * },
287
+ * "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
288
+ * "created": "2021-01-17T12:34:00.000+0000",
289
+ * "id": "10000",
290
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
291
+ * "updateAuthor": {
292
+ * "accountId": "5b10a2844c20165700ede21g",
293
+ * "active": false,
294
+ * "displayName": "Mia Krystof",
295
+ * "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
296
+ * },
297
+ * "updated": "2021-01-18T23:45:00.000+0000",
298
+ * "visibility": {
299
+ * "identifier": "Administrators",
300
+ * "type": "role",
301
+ * "value": "Administrators"
302
+ * }
303
+ * }
304
+ * ],
305
+ * "issuelinks": [
306
+ * {
307
+ * "id": "10001",
308
+ * "outwardIssue": {
309
+ * "fields": {
310
+ * "status": {
311
+ * "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
312
+ * "name": "Open"
313
+ * }
314
+ * },
315
+ * "id": "10004L",
316
+ * "key": "PR-2",
317
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
318
+ * },
319
+ * "type": {
320
+ * "id": "10000",
321
+ * "inward": "depends on",
322
+ * "name": "Dependent",
323
+ * "outward": "is depended by"
324
+ * }
325
+ * },
326
+ * {
327
+ * "id": "10002",
328
+ * "inwardIssue": {
329
+ * "fields": {
330
+ * "status": {
331
+ * "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
332
+ * "name": "Open"
333
+ * }
334
+ * },
335
+ * "id": "10004",
336
+ * "key": "PR-3",
337
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
338
+ * },
339
+ * "type": {
340
+ * "id": "10000",
341
+ * "inward": "depends on",
342
+ * "name": "Dependent",
343
+ * "outward": "is depended by"
344
+ * }
345
+ * }
346
+ * ],
347
+ * "worklog": [
348
+ * {
349
+ * "author": {
350
+ * "accountId": "5b10a2844c20165700ede21g",
351
+ * "active": false,
352
+ * "displayName": "Mia Krystof",
353
+ * "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
354
+ * },
355
+ * "comment": "I did some work here.",
356
+ * "id": "100028",
357
+ * "issueId": "10002",
358
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
359
+ * "started": "2021-01-17T12:34:00.000+0000",
360
+ * "timeSpent": "3h 20m",
361
+ * "timeSpentSeconds": 12000,
362
+ * "updateAuthor": {
363
+ * "accountId": "5b10a2844c20165700ede21g",
364
+ * "active": false,
365
+ * "displayName": "Mia Krystof",
366
+ * "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
367
+ * },
368
+ * "updated": "2021-01-18T23:45:00.000+0000",
369
+ * "visibility": {
370
+ * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
371
+ * "type": "group",
372
+ * "value": "jira-developers"
373
+ * }
374
+ * }
375
+ * ],
376
+ * "updated": 1,
377
+ * "timetracking": {
378
+ * "originalEstimate": "10m",
379
+ * "originalEstimateSeconds": 600,
380
+ * "remainingEstimate": "3m",
381
+ * "remainingEstimateSeconds": 200,
382
+ * "timeSpent": "6m",
383
+ * "timeSpentSeconds": 400
384
+ * }
385
+ * },
386
+ * "id": "10002",
387
+ * "key": "ED-1",
388
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
389
+ * }
390
+ * ]
391
+ * }
392
+ * ```
393
+ * @path GET `/rest/api/3/search/jql`
394
+ * @scopes-current read:jira-work
395
+ * @scopes-beta read:issue-details:jira, read:audit-log:jira, read:avatar:jira, read:field-configuration:jira, read:issue-meta:jira
396
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search#api-rest-api-3-search-jql-get
397
+ * @param params
398
+ */
399
+ searchAndReconsileIssuesUsingJql: ({ searchAndReconcileRequestBean, }: {
400
+ searchAndReconcileRequestBean: SearchAndReconcileRequestBean;
401
+ }) => Promise<SearchAndReconcileResults>;
402
+ /**
403
+ * Searches for issues using [JQL](https://confluence.atlassian.com/x/egORLQ).
404
+ * Recent updates might not be immediately visible in the returned search results.
405
+ * If you need read-after-write consistency, you can utilize the `reconcileIssues`
406
+ * parameter to ensure stronger consistency assurances. This operation can be
407
+ * accessed anonymously.
408
+ *
409
+ * **[Permissions](#permissions) required:** Issues are included in the response
410
+ * where the user has:
411
+ *
412
+ * * *Browse projects* [project
413
+ * permission](https://confluence.atlassian.com/x/yodKLg) for the project
414
+ * containing the issue.
415
+ * * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
416
+ * configured, issue-level security permission to view the issue.
417
+ *
418
+ * @returns Returned if the request is successful.
419
+ *
420
+ * example:
421
+ * ```
422
+ * {
423
+ * "issues": [
424
+ * {
425
+ * "expand": "",
426
+ * "fields": {
427
+ * "watcher": {
428
+ * "isWatching": false,
429
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
430
+ * "watchCount": 1
431
+ * },
432
+ * "attachment": [
433
+ * {
434
+ * "author": {
435
+ * "accountId": "5b10a2844c20165700ede21g",
436
+ * "accountType": "atlassian",
437
+ * "active": false,
438
+ * "avatarUrls": {
439
+ * "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
440
+ * "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
441
+ * "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
442
+ * "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
443
+ * },
444
+ * "displayName": "Mia Krystof",
445
+ * "key": "",
446
+ * "name": "",
447
+ * "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
448
+ * },
449
+ * "content": "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10001",
450
+ * "created": "2023-06-24T19:24:50.000+0000",
451
+ * "filename": "debuglog.txt",
452
+ * "id": 10001,
453
+ * "mimeType": "text/plain",
454
+ * "self": "https://your-domain.atlassian.net/rest/api/2/attachments/10001",
455
+ * "size": 2460
456
+ * }
457
+ * ],
458
+ * "sub-tasks": [
459
+ * {
460
+ * "id": "10000",
461
+ * "outwardIssue": {
462
+ * "fields": {
463
+ * "status": {
464
+ * "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
465
+ * "name": "Open"
466
+ * }
467
+ * },
468
+ * "id": "10003",
469
+ * "key": "ED-2",
470
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
471
+ * },
472
+ * "type": {
473
+ * "id": "10000",
474
+ * "inward": "Parent",
475
+ * "name": "",
476
+ * "outward": "Sub-task"
477
+ * }
478
+ * }
479
+ * ],
480
+ * "description": "Main order flow broken",
481
+ * "project": {
482
+ * "avatarUrls": {
483
+ * "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
484
+ * "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
485
+ * "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
486
+ * "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
487
+ * },
488
+ * "id": "10000",
489
+ * "insight": {
490
+ * "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
491
+ * "totalIssueCount": 100
492
+ * },
493
+ * "key": "EX",
494
+ * "name": "Example",
495
+ * "projectCategory": {
496
+ * "description": "First Project Category",
497
+ * "id": "10000",
498
+ * "name": "FIRST",
499
+ * "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
500
+ * },
501
+ * "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
502
+ * "simplified": false,
503
+ * "style": "classic"
504
+ * },
505
+ * "comment": [
506
+ * {
507
+ * "author": {
508
+ * "accountId": "5b10a2844c20165700ede21g",
509
+ * "active": false,
510
+ * "displayName": "Mia Krystof",
511
+ * "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
512
+ * },
513
+ * "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.",
514
+ * "created": "2021-01-17T12:34:00.000+0000",
515
+ * "id": "10000",
516
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
517
+ * "updateAuthor": {
518
+ * "accountId": "5b10a2844c20165700ede21g",
519
+ * "active": false,
520
+ * "displayName": "Mia Krystof",
521
+ * "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
522
+ * },
523
+ * "updated": "2021-01-18T23:45:00.000+0000",
524
+ * "visibility": {
525
+ * "identifier": "Administrators",
526
+ * "type": "role",
527
+ * "value": "Administrators"
528
+ * }
529
+ * }
530
+ * ],
531
+ * "issuelinks": [
532
+ * {
533
+ * "id": "10001",
534
+ * "outwardIssue": {
535
+ * "fields": {
536
+ * "status": {
537
+ * "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
538
+ * "name": "Open"
539
+ * }
540
+ * },
541
+ * "id": "10004L",
542
+ * "key": "PR-2",
543
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
544
+ * },
545
+ * "type": {
546
+ * "id": "10000",
547
+ * "inward": "depends on",
548
+ * "name": "Dependent",
549
+ * "outward": "is depended by"
550
+ * }
551
+ * },
552
+ * {
553
+ * "id": "10002",
554
+ * "inwardIssue": {
555
+ * "fields": {
556
+ * "status": {
557
+ * "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
558
+ * "name": "Open"
559
+ * }
560
+ * },
561
+ * "id": "10004",
562
+ * "key": "PR-3",
563
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
564
+ * },
565
+ * "type": {
566
+ * "id": "10000",
567
+ * "inward": "depends on",
568
+ * "name": "Dependent",
569
+ * "outward": "is depended by"
570
+ * }
571
+ * }
572
+ * ],
573
+ * "worklog": [
574
+ * {
575
+ * "author": {
576
+ * "accountId": "5b10a2844c20165700ede21g",
577
+ * "active": false,
578
+ * "displayName": "Mia Krystof",
579
+ * "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
580
+ * },
581
+ * "comment": "I did some work here.",
582
+ * "id": "100028",
583
+ * "issueId": "10002",
584
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
585
+ * "started": "2021-01-17T12:34:00.000+0000",
586
+ * "timeSpent": "3h 20m",
587
+ * "timeSpentSeconds": 12000,
588
+ * "updateAuthor": {
589
+ * "accountId": "5b10a2844c20165700ede21g",
590
+ * "active": false,
591
+ * "displayName": "Mia Krystof",
592
+ * "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
593
+ * },
594
+ * "updated": "2021-01-18T23:45:00.000+0000",
595
+ * "visibility": {
596
+ * "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
597
+ * "type": "group",
598
+ * "value": "jira-developers"
599
+ * }
600
+ * }
601
+ * ],
602
+ * "updated": 1,
603
+ * "timetracking": {
604
+ * "originalEstimate": "10m",
605
+ * "originalEstimateSeconds": 600,
606
+ * "remainingEstimate": "3m",
607
+ * "remainingEstimateSeconds": 200,
608
+ * "timeSpent": "6m",
609
+ * "timeSpentSeconds": 400
610
+ * }
611
+ * },
612
+ * "id": "10002",
613
+ * "key": "ED-1",
614
+ * "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
615
+ * }
616
+ * ]
617
+ * }
618
+ * ```
619
+ * @path POST `/rest/api/3/search/jql`
620
+ * @scopes-current read:jira-work
621
+ * @scopes-beta read:issue-details:jira, read:field.default-value:jira, read:field.option:jira, read:field:jira, read:group:jira
622
+ * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search#api-rest-api-3-search-jql-post
623
+ * @param params
624
+ */
625
+ searchAndReconsileIssuesUsingJqlPost: ({ searchAndReconcileRequestBean, }: {
626
+ searchAndReconcileRequestBean: SearchAndReconcileRequestBean;
627
+ }) => Promise<SearchAndReconcileResults>;
131
628
  /**
132
629
  * Searches for IDs of issues using
133
630
  * [JQL](https://confluence.atlassian.com/x/egORLQ).