diff --git a/src/version2/avatars.ts b/src/version2/avatars.ts index 40011ccc3..621d4474a 100644 --- a/src/version2/avatars.ts +++ b/src/version2/avatars.ts @@ -160,11 +160,16 @@ export class Avatars { const config: RequestConfig = { url: `/rest/api/2/universal_avatar/type/${parameters.type}/owner/${parameters.entityId}`, method: 'POST', + headers: { + 'X-Atlassian-Token': 'no-check', + 'Content-Type': parameters.mimeType, + }, params: { x: parameters.x, y: parameters.y, - size: parameters.size, + size: parameters.size ?? 0, }, + data: parameters.avatar, }; return this.client.sendRequest(config, callback); diff --git a/src/version2/dashboards.ts b/src/version2/dashboards.ts index 66f03ca4d..d1618c419 100644 --- a/src/version2/dashboards.ts +++ b/src/version2/dashboards.ts @@ -197,7 +197,6 @@ export class Dashboards { params: { dashboardName: parameters?.dashboardName, accountId: parameters?.accountId, - owner: parameters?.owner, groupname: parameters?.groupname, groupId: parameters?.groupId, projectId: parameters?.projectId, diff --git a/src/version2/filters.ts b/src/version2/filters.ts index 97df20fbf..8e4c9f28d 100644 --- a/src/version2/filters.ts +++ b/src/version2/filters.ts @@ -227,7 +227,6 @@ export class Filters { params: { filterName: parameters?.filterName, accountId: parameters?.accountId, - owner: parameters?.owner, groupname: parameters?.groupname, groupId: parameters?.groupId, projectId: parameters?.projectId, @@ -312,7 +311,13 @@ export class Filters { expand: parameters.expand, overrideSharePermissions: parameters.overrideSharePermissions, }, - data: parameters.body, + data: { + name: parameters.name, + description: parameters.description, + jql: parameters.jql, + favourite: parameters.favourite, + sharePermissions: parameters.sharePermissions, + }, }; return this.client.sendRequest(config, callback); diff --git a/src/version2/groups.ts b/src/version2/groups.ts index 57a4ad3f9..21c994b6c 100644 --- a/src/version2/groups.ts +++ b/src/version2/groups.ts @@ -178,7 +178,7 @@ export class Groups { url: '/rest/api/2/group/user', method: 'POST', params: { - groupname: parameters?.groupname, + groupname: parameters?.groupName, groupId: parameters?.groupId, }, data: { @@ -276,13 +276,11 @@ export class Groups { url: '/rest/api/2/groups/picker', method: 'GET', params: { - accountId: parameters?.accountId, query: parameters?.query, exclude: parameters?.exclude, excludeId: parameters?.excludeId, maxResults: parameters?.maxResults, caseInsensitive: parameters?.caseInsensitive, - userName: parameters?.userName, }, }; diff --git a/src/version2/index.ts b/src/version2/index.ts index d185ac596..d177fc664 100644 --- a/src/version2/index.ts +++ b/src/version2/index.ts @@ -90,3 +90,7 @@ export * from './workflowStatuses'; export * from './workflowTransitionProperties'; export * from './workflowTransitionRules'; export * from './workflows'; + +export * from './client'; +export * as Version2Models from './models'; +export * as Version2Parameters from './parameters'; diff --git a/src/version2/issueComments.ts b/src/version2/issueComments.ts index d484f265e..00e6e2429 100644 --- a/src/version2/issueComments.ts +++ b/src/version2/issueComments.ts @@ -147,18 +147,18 @@ export class IssueComments { expand: parameters.expand, }, data: { - author: parameters.author, - body: parameters.body, - created: parameters.created, + self: parameters.self, id: parameters.id, - jsdAuthorCanSeeRequest: parameters.jsdAuthorCanSeeRequest, - jsdPublic: parameters.jsdPublic, - properties: parameters.properties, + author: parameters.author, + body: parameters.comment, renderedBody: parameters.renderedBody, - self: parameters.self, updateAuthor: parameters.updateAuthor, + created: parameters.created, updated: parameters.updated, visibility: parameters.visibility, + jsdPublic: parameters.jsdPublic, + jsdAuthorCanSeeRequest: parameters.jsdAuthorCanSeeRequest, + properties: parameters.properties, }, }; @@ -251,7 +251,11 @@ export class IssueComments { overrideEditableFlag: parameters.overrideEditableFlag, expand: parameters.expand, }, - data: parameters.body, + data: { + body: parameters.comment, + visibility: parameters.visibility, + properties: parameters.properties, + }, }; return this.client.sendRequest(config, callback); diff --git a/src/version2/issuePriorities.ts b/src/version2/issuePriorities.ts index 2b7daf992..455330544 100644 --- a/src/version2/issuePriorities.ts +++ b/src/version2/issuePriorities.ts @@ -52,18 +52,18 @@ export class IssuePriorities { */ async createPriority(parameters?: Parameters.CreatePriority, callback?: never): Promise; async createPriority( - parameters?: Parameters.CreatePriority, + parameters: Parameters.CreatePriority, callback?: Callback, ): Promise { const config: RequestConfig = { url: '/rest/api/2/priority', method: 'POST', data: { - avatarId: parameters?.avatarId, - description: parameters?.description, - iconUrl: parameters?.iconUrl, - name: parameters?.name, - statusColor: parameters?.statusColor, + avatarId: parameters.avatarId, + description: parameters.description, + iconUrl: parameters.iconUrl, + name: parameters.name, + statusColor: parameters.statusColor, }, }; diff --git a/src/version2/issueSearch.ts b/src/version2/issueSearch.ts index a95567164..d6b9175aa 100644 --- a/src/version2/issueSearch.ts +++ b/src/version2/issueSearch.ts @@ -74,10 +74,7 @@ export class IssueSearch { * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. */ - async matchIssues( - parameters: Parameters.MatchIssues | undefined, - callback: Callback, - ): Promise; + async matchIssues(parameters: Parameters.MatchIssues, callback: Callback): Promise; /** * Checks whether one or more issues would be returned by one or more JQL queries. * @@ -89,17 +86,17 @@ export class IssueSearch { * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. */ - async matchIssues(parameters?: Parameters.MatchIssues, callback?: never): Promise; + async matchIssues(parameters: Parameters.MatchIssues, callback?: never): Promise; async matchIssues( - parameters?: Parameters.MatchIssues, + parameters: Parameters.MatchIssues, callback?: Callback, ): Promise { const config: RequestConfig = { url: '/rest/api/2/jql/match', method: 'POST', data: { - issueIds: parameters?.issueIds, - jqls: parameters?.jqls, + issueIds: parameters.issueIds, + jqls: parameters.jqls, }, }; @@ -122,7 +119,7 @@ export class IssueSearch { * to view the issue. */ async searchForIssuesUsingJql( - parameters: Parameters.SearchForIssuesUsingJql | undefined, + parameters: Parameters.SearchForIssuesUsingJql, callback: Callback, ): Promise; /** @@ -142,26 +139,26 @@ export class IssueSearch { * to view the issue. */ async searchForIssuesUsingJql( - parameters?: Parameters.SearchForIssuesUsingJql, + parameters: Parameters.SearchForIssuesUsingJql, callback?: never, ): Promise; async searchForIssuesUsingJql( - parameters?: Parameters.SearchForIssuesUsingJql, + parameters: Parameters.SearchForIssuesUsingJql, callback?: Callback, ): Promise { const config: RequestConfig = { url: '/rest/api/2/search', method: 'GET', params: { - jql: parameters?.jql, - startAt: parameters?.startAt, - maxResults: parameters?.maxResults, - validateQuery: parameters?.validateQuery, - fields: parameters?.fields, - expand: parameters?.expand, - properties: parameters?.properties, - fieldsByKeys: parameters?.fieldsByKeys, - failFast: parameters?.failFast, + jql: parameters.jql, + startAt: parameters.startAt, + maxResults: parameters.maxResults, + validateQuery: parameters.validateQuery, + fields: parameters.fields, + expand: parameters.expand, + properties: parameters.properties, + fieldsByKeys: parameters.fieldsByKeys, + failFast: parameters.failFast, }, }; @@ -242,10 +239,7 @@ export class IssueSearch { * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. */ - async countIssues( - parameters: Parameters.CountIssues | undefined, - callback: Callback, - ): Promise; + async countIssues(parameters: Parameters.CountIssues, callback: Callback): Promise; /** * Provide an estimated count of the issues that match the [JQL](https://confluence.atlassian.com/x/egORLQ). Recent * updates might not be immediately visible in the returned output. This endpoint requires JQL to be bounded. @@ -260,16 +254,16 @@ export class IssueSearch { * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. */ - async countIssues(parameters?: Parameters.CountIssues, callback?: never): Promise; + async countIssues(parameters: Parameters.CountIssues, callback?: never): Promise; async countIssues( - parameters?: Parameters.CountIssues, + parameters: Parameters.CountIssues, callback?: Callback, ): Promise { const config: RequestConfig = { url: '/rest/api/2/search/approximate-count', method: 'POST', data: { - jql: parameters?.jql, + jql: parameters.jql, }, }; @@ -294,7 +288,7 @@ export class IssueSearch { * to view the issue. */ async searchForIssuesIds( - parameters: Parameters.SearchForIssuesIds | undefined, + parameters: Parameters.SearchForIssuesIds, callback: Callback, ): Promise; /** @@ -316,20 +310,20 @@ export class IssueSearch { * to view the issue. */ async searchForIssuesIds( - parameters?: Parameters.SearchForIssuesIds, + parameters: Parameters.SearchForIssuesIds, callback?: never, ): Promise; async searchForIssuesIds( - parameters?: Parameters.SearchForIssuesIds, + parameters: Parameters.SearchForIssuesIds, callback?: Callback, ): Promise { const config: RequestConfig = { url: '/rest/api/2/search/id', method: 'POST', data: { - jql: parameters?.jql, - maxResults: parameters?.maxResults, - nextPageToken: parameters?.nextPageToken, + jql: parameters.jql, + maxResults: parameters.maxResults, + nextPageToken: parameters.nextPageToken, }, }; @@ -353,8 +347,8 @@ export class IssueSearch { * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. */ - async searchAndReconsileIssuesUsingJql( - parameters: Parameters.SearchAndReconsileIssuesUsingJql | undefined, + async searchForIssuesUsingJqlEnhancedSearch( + parameters: Parameters.SearchForIssuesUsingJqlEnhancedSearch | undefined, callback: Callback, ): Promise; /** @@ -375,27 +369,27 @@ export class IssueSearch { * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. */ - async searchAndReconsileIssuesUsingJql( - parameters?: Parameters.SearchAndReconsileIssuesUsingJql, + async searchForIssuesUsingJqlEnhancedSearch( + parameters: Parameters.SearchForIssuesUsingJqlEnhancedSearch, callback?: never, ): Promise; - async searchAndReconsileIssuesUsingJql( - parameters?: Parameters.SearchAndReconsileIssuesUsingJql, + async searchForIssuesUsingJqlEnhancedSearch( + parameters: Parameters.SearchForIssuesUsingJqlEnhancedSearch, callback?: Callback, ): Promise { const config: RequestConfig = { url: '/rest/api/2/search/jql', method: 'GET', params: { - jql: parameters?.jql, - nextPageToken: parameters?.nextPageToken, - maxResults: parameters?.maxResults, - fields: parameters?.fields, - expand: parameters?.expand, - properties: parameters?.properties, - fieldsByKeys: parameters?.fieldsByKeys, - failFast: parameters?.failFast, - reconcileIssues: parameters?.reconcileIssues, + jql: parameters.jql, + nextPageToken: parameters.nextPageToken, + maxResults: parameters.maxResults, + fields: parameters.fields, + expand: parameters.expand, + properties: parameters.properties, + fieldsByKeys: parameters.fieldsByKeys, + failFast: parameters.failFast, + reconcileIssues: parameters.reconcileIssues, }, }; @@ -416,8 +410,8 @@ export class IssueSearch { * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. */ - async searchAndReconsileIssuesUsingJqlPost( - parameters: Parameters.SearchAndReconsileIssuesUsingJqlPost | undefined, + async searchForIssuesUsingJqlEnhancedSearchPost( + parameters: Parameters.SearchForIssuesUsingJqlEnhancedSearchPost, callback: Callback, ): Promise; /** @@ -435,26 +429,27 @@ export class IssueSearch { * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission * to view the issue. */ - async searchAndReconsileIssuesUsingJqlPost( - parameters?: Parameters.SearchAndReconsileIssuesUsingJqlPost, + async searchForIssuesUsingJqlEnhancedSearchPost( + parameters: Parameters.SearchForIssuesUsingJqlEnhancedSearchPost, callback?: never, ): Promise; - async searchAndReconsileIssuesUsingJqlPost( - parameters?: Parameters.SearchAndReconsileIssuesUsingJqlPost, + async searchForIssuesUsingJqlEnhancedSearchPost( + parameters: Parameters.SearchForIssuesUsingJqlEnhancedSearchPost, callback?: Callback, ): Promise { const config: RequestConfig = { url: '/rest/api/2/search/jql', method: 'POST', data: { - expand: parameters?.expand, - fields: parameters?.fields, - fieldsByKeys: parameters?.fieldsByKeys, - jql: parameters?.jql, - maxResults: parameters?.maxResults, - nextPageToken: parameters?.nextPageToken, - properties: parameters?.properties, - reconcileIssues: parameters?.reconcileIssues, + jql: parameters.jql, + nextPageToken: parameters.nextPageToken, + maxResults: parameters.maxResults, + fields: parameters.fields, + expand: parameters.expand, + properties: parameters.properties, + fieldsByKeys: parameters.fieldsByKeys, + failFast: parameters.failFast, + reconcileIssues: parameters.reconcileIssues, }, }; diff --git a/src/version2/issueTypes.ts b/src/version2/issueTypes.ts index e230440c5..67da4e4b7 100644 --- a/src/version2/issueTypes.ts +++ b/src/version2/issueTypes.ts @@ -73,7 +73,6 @@ export class IssueTypes { description: parameters?.description, hierarchyLevel: parameters?.hierarchyLevel, name: parameters?.name, - type: parameters?.type, }, }; @@ -319,11 +318,16 @@ export class IssueTypes { const config: RequestConfig = { url: `/rest/api/2/issuetype/${parameters.id}/avatar2`, method: 'POST', + headers: { + 'X-Atlassian-Token': 'no-check', + 'Content-Type': parameters.mimeType, + }, params: { x: parameters.x, y: parameters.y, - size: parameters.size, + size: parameters.size ?? 0, }, + data: parameters.avatar, }; return this.client.sendRequest(config, callback); diff --git a/src/version2/issueWorklogs.ts b/src/version2/issueWorklogs.ts index e73c433a8..6b63e6a34 100644 --- a/src/version2/issueWorklogs.ts +++ b/src/version2/issueWorklogs.ts @@ -243,7 +243,7 @@ export class IssueWorklogs { adjustEstimate: parameters.adjustEstimate, overrideEditableFlag: parameters.overrideEditableFlag, }, - data: parameters.body, + data: parameters.worklogs, }; return this.client.sendRequest(config, callback); @@ -345,7 +345,14 @@ export class IssueWorklogs { expand: parameters.expand, overrideEditableFlag: parameters.overrideEditableFlag, }, - data: parameters.body, + data: { + comment: parameters.comment, + visibility: parameters.visibility, + started: parameters.started, + timeSpent: parameters.timeSpent, + timeSpentSeconds: parameters.timeSpentSeconds, + properties: parameters.properties, + }, }; return this.client.sendRequest(config, callback); diff --git a/src/version2/issues.ts b/src/version2/issues.ts index 4c4d8045d..28f14adee 100644 --- a/src/version2/issues.ts +++ b/src/version2/issues.ts @@ -154,9 +154,9 @@ export class Issues { * of the submitted request. * * You can use the [get - * task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get) + * task](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-tasks/#api-rest-api-2-task-taskid-get) * and [cancel - * task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-cancel-post) + * task](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-tasks/#api-rest-api-2-task-taskid-cancel-post) * APIs to manage the request. * * **Note that:** @@ -173,7 +173,7 @@ export class Issues { * * **Rate limiting:** Only a single request per jira instance can be active at any given time. */ - async archiveIssuesAsync( + async archiveIssuesAsync( parameters: Parameters.ArchiveIssuesAsync | undefined, callback: Callback, ): Promise; @@ -182,9 +182,9 @@ export class Issues { * of the submitted request. * * You can use the [get - * task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get) + * task](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-tasks/#api-rest-api-2-task-taskid-get) * and [cancel - * task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-cancel-post) + * task](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-tasks/#api-rest-api-2-task-taskid-cancel-post) * APIs to manage the request. * * **Note that:** @@ -201,8 +201,8 @@ export class Issues { * * **Rate limiting:** Only a single request per jira instance can be active at any given time. */ - async archiveIssuesAsync(parameters?: Parameters.ArchiveIssuesAsync, callback?: never): Promise; - async archiveIssuesAsync( + async archiveIssuesAsync(parameters?: Parameters.ArchiveIssuesAsync, callback?: never): Promise; + async archiveIssuesAsync( parameters?: Parameters.ArchiveIssuesAsync, callback?: Callback, ): Promise { @@ -327,70 +327,9 @@ export class Issues { return this.client.sendRequest(config, callback); } - /** - * Returns the details for a set of requested issues. You can request up to 100 issues. - * - * Each issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive - * search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or - * other redirect is **not** returned. - * - * Issues will be returned in ascending `id` order. If there are errors, Jira will return a list of issues which - * couldn't be fetched along with error messages. - * - * This operation can be accessed anonymously. - * - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** Issues - * are included in the response where the user has: - * - * - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is - * in. - * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission - * to view the issue. - */ - async bulkFetchIssues( - parameters: Parameters.BulkFetchIssues | undefined, - callback: Callback, - ): Promise; - /** - * Returns the details for a set of requested issues. You can request up to 100 issues. - * - * Each issue is identified by its ID or key, however, if the identifier doesn't match an issue, a case-insensitive - * search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or - * other redirect is **not** returned. - * - * Issues will be returned in ascending `id` order. If there are errors, Jira will return a list of issues which - * couldn't be fetched along with error messages. - * - * This operation can be accessed anonymously. - * - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** Issues - * are included in the response where the user has: - * - * - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is - * in. - * - If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission - * to view the issue. - */ - async bulkFetchIssues(parameters?: Parameters.BulkFetchIssues, callback?: never): Promise; - async bulkFetchIssues( - parameters?: Parameters.BulkFetchIssues, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: '/rest/api/2/issue/bulkfetch', - method: 'POST', - data: { - expand: parameters?.expand, - fields: parameters?.fields, - fieldsByKeys: parameters?.fieldsByKeys, - issueIdsOrKeys: parameters?.issueIdsOrKeys, - properties: parameters?.properties, - }, - }; - return this.client.sendRequest(config, callback); - } /** + * @deprecated * Returns details of projects, issue types within projects, and, when requested, the create screen fields for each * issue type for the user. Use the information to populate the requests in [ Create * issue](#api-rest-api-2-issue-post) and [Create issues](#api-rest-api-2-issue-bulk-post). @@ -412,6 +351,7 @@ export class Issues { callback: Callback, ): Promise; /** + * @deprecated * Returns details of projects, issue types within projects, and, when requested, the create screen fields for each * issue type for the user. Use the information to populate the requests in [ Create * issue](#api-rest-api-2-issue-post) and [Create issues](#api-rest-api-2-issue-bulk-post). diff --git a/src/version2/jQL.ts b/src/version2/jQL.ts index 4b0ce522c..54f434391 100644 --- a/src/version2/jQL.ts +++ b/src/version2/jQL.ts @@ -261,7 +261,7 @@ export class JQL { * Note that sanitization doesn't make the queries GDPR-compliant, because it doesn't remove user identifiers * (username or user key). If you need to make queries GDPR-compliant, use [Convert user identifiers to account IDs in * JQL - * queries](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql/#api-rest-api-3-jql-sanitize-post). + * queries](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-jql/#api-rest-api-2-jql-sanitize-post). * * Before sanitization each JQL query is parsed. The queries are returned in the same order that they were passed. * @@ -284,7 +284,7 @@ export class JQL { * Note that sanitization doesn't make the queries GDPR-compliant, because it doesn't remove user identifiers * (username or user key). If you need to make queries GDPR-compliant, use [Convert user identifiers to account IDs in * JQL - * queries](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-jql/#api-rest-api-3-jql-sanitize-post). + * queries](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-jql/#api-rest-api-2-jql-sanitize-post). * * Before sanitization each JQL query is parsed. The queries are returned in the same order that they were passed. * diff --git a/src/version2/jiraExpressions.ts b/src/version2/jiraExpressions.ts index 0d4172996..6b15a0593 100644 --- a/src/version2/jiraExpressions.ts +++ b/src/version2/jiraExpressions.ts @@ -109,7 +109,7 @@ export class JiraExpressions { * fields (for example, `issue.sprint`). */ async evaluateJiraExpression( - parameters: Parameters.EvaluateJiraExpression | undefined, + parameters: Parameters.EvaluateJiraExpression, callback: Callback, ): Promise; /** @@ -169,22 +169,22 @@ export class JiraExpressions { * fields (for example, `issue.sprint`). */ async evaluateJiraExpression( - parameters?: Parameters.EvaluateJiraExpression, + parameters: Parameters.EvaluateJiraExpression, callback?: never, ): Promise; async evaluateJiraExpression( - parameters?: Parameters.EvaluateJiraExpression, + parameters: Parameters.EvaluateJiraExpression, callback?: Callback, ): Promise { const config: RequestConfig = { url: '/rest/api/2/expression/eval', method: 'POST', params: { - expand: parameters?.expand, + expand: parameters.expand, }, data: { - context: parameters?.context, - expression: parameters?.expression, + context: parameters.context, + expression: parameters.expression, }, }; @@ -250,8 +250,8 @@ export class JiraExpressions { * Permission to access Jira Software is required to access Jira Software context variables (`board` and `sprint`) or * fields (for example, `issue.sprint`). */ - async evaluateJSISJiraExpression( - parameters: Parameters.EvaluateJSISJiraExpression | undefined, + async evaluateJiraExpressionUsingEnhancedSearch( + parameters: Parameters.EvaluateJiraExpressionUsingEnhancedSearch, callback: Callback, ): Promise; /** @@ -314,23 +314,23 @@ export class JiraExpressions { * Permission to access Jira Software is required to access Jira Software context variables (`board` and `sprint`) or * fields (for example, `issue.sprint`). */ - async evaluateJSISJiraExpression( - parameters?: Parameters.EvaluateJSISJiraExpression, + async evaluateJiraExpressionUsingEnhancedSearch( + parameters: Parameters.EvaluateJiraExpressionUsingEnhancedSearch, callback?: never, ): Promise; - async evaluateJSISJiraExpression( - parameters?: Parameters.EvaluateJSISJiraExpression, + async evaluateJiraExpressionUsingEnhancedSearch( + parameters: Parameters.EvaluateJiraExpressionUsingEnhancedSearch, callback?: Callback, ): Promise { const config: RequestConfig = { url: '/rest/api/2/expression/evaluate', method: 'POST', params: { - expand: parameters?.expand, + expand: parameters.expand, }, data: { - context: parameters?.context, - expression: parameters?.expression, + expression: parameters.expression, + context: parameters.context, }, }; diff --git a/src/version2/models/addSecuritySchemeLevelsRequestBean.ts b/src/version2/models/addSecuritySchemeLevelsRequestBean.ts deleted file mode 100644 index 02ddf9eee..000000000 --- a/src/version2/models/addSecuritySchemeLevelsRequestBean.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { SecuritySchemeLevelBean } from './securitySchemeLevelBean'; - -export interface AddSecuritySchemeLevelsRequestBean { - /** The list of scheme levels which should be added to the security scheme. */ - levels?: SecuritySchemeLevelBean[]; -} diff --git a/src/version2/models/bulkIssue.ts b/src/version2/models/bulkIssue.ts deleted file mode 100644 index 43ffd9897..000000000 --- a/src/version2/models/bulkIssue.ts +++ /dev/null @@ -1,14 +0,0 @@ -import { IssueError } from './issueError'; -import { IssueBean } from './issueBean'; - -/** The list of requested issues & fields. */ -export interface BulkIssue { - /** - * When Jira can't return an issue enumerated in a request due to a retriable error or payload constraint, we'll - * return the respective issue ID with a corresponding error message. This list is empty when there are no errors - * Issues which aren't found or that the user doesn't have permission to view won't be returned in this list. - */ - issueErrors?: IssueError[]; - /** The list of issues. */ - issues?: IssueBean[]; -} diff --git a/src/version2/models/createPriorityDetails.ts b/src/version2/models/createPriorityDetails.ts index 363c7a275..934f9993b 100644 --- a/src/version2/models/createPriorityDetails.ts +++ b/src/version2/models/createPriorityDetails.ts @@ -1,9 +1,40 @@ /** Details of an issue priority. */ export interface CreatePriorityDetails { + /** + * The ID for the avatar for the priority. Either the iconUrl or avatarId must be defined, but not both. This + * parameter is nullable and will become mandatory once the iconUrl parameter is deprecated. + */ + avatarId?: number; /** The description of the priority. */ description?: string; - /** The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used. */ - iconUrl?: string; + /** + * The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used. Either + * the iconUrl or avatarId must be defined, but not both. + * + * @deprecated This property is deprecated and will be removed in a future version. Use `avatarId` instead. + */ + iconUrl?: + | '/images/icons/priorities/blocker.png' + | '/images/icons/priorities/critical.png' + | '/images/icons/priorities/high.png' + | '/images/icons/priorities/highest.png' + | '/images/icons/priorities/low.png' + | '/images/icons/priorities/lowest.png' + | '/images/icons/priorities/major.png' + | '/images/icons/priorities/medium.png' + | '/images/icons/priorities/minor.png' + | '/images/icons/priorities/trivial.png' + | '/images/icons/priorities/blocker_new.png' + | '/images/icons/priorities/critical_new.png' + | '/images/icons/priorities/high_new.png' + | '/images/icons/priorities/highest_new.png' + | '/images/icons/priorities/low_new.png' + | '/images/icons/priorities/lowest_new.png' + | '/images/icons/priorities/major_new.png' + | '/images/icons/priorities/medium_new.png' + | '/images/icons/priorities/minor_new.png' + | '/images/icons/priorities/trivial_new.png' + | string; /** The name of the priority. Must be unique. */ name: string; /** The status color of the priority in 3-digit or 6-digit hexadecimal format. */ diff --git a/src/version2/models/dataClassificationLevels.ts b/src/version2/models/dataClassificationLevels.ts index d921e5983..8358ceb24 100644 --- a/src/version2/models/dataClassificationLevels.ts +++ b/src/version2/models/dataClassificationLevels.ts @@ -1,7 +1,7 @@ -import { DataClassificationTagBean } from './dataClassificationTagBean'; +import { DataClassificationTag } from './dataClassificationTag'; /** The data classification. */ export interface DataClassificationLevels { /** The data classifications. */ - classifications?: DataClassificationTagBean[]; + classifications?: DataClassificationTag[]; } diff --git a/src/version2/models/evaluateMetaData.ts b/src/version2/models/evaluateMetaData.ts index c636542ad..827c47dad 100644 --- a/src/version2/models/evaluateMetaData.ts +++ b/src/version2/models/evaluateMetaData.ts @@ -1,11 +1,11 @@ -import { JiraExpressionsComplexityBean } from './jiraExpressionsComplexityBean'; -import { JExpEvaluateIssuesMetaBean } from './jExpEvaluateIssuesMetaBean'; +import { JiraExpressionsComplexity } from './jiraExpressionsComplexity'; +import { JExpEvaluateIssuesMeta } from './jExpEvaluateIssuesMeta'; /** * Contains information about the expression evaluation. This bean will be replacing * `JiraExpressionEvaluationMetaDataBean` bean as part of new `evaluate` endpoint */ export interface EvaluateMetaData { - complexity?: JiraExpressionsComplexityBean; - issues?: JExpEvaluateIssuesMetaBean; + complexity?: JiraExpressionsComplexity; + issues?: JExpEvaluateIssuesMeta; } diff --git a/src/version2/models/evaluatedJiraExpression.ts b/src/version2/models/evaluatedJiraExpression.ts index 3c4ce1a64..beb9f0a72 100644 --- a/src/version2/models/evaluatedJiraExpression.ts +++ b/src/version2/models/evaluatedJiraExpression.ts @@ -1,11 +1,11 @@ -import { JExpEvaluateMetaDataBean } from './jExpEvaluateMetaDataBean'; +import { JExpEvaluateMetaData } from './jExpEvaluateMetaData'; /** * The result of evaluating a Jira expression.This bean will be replacing `JiraExpressionResultBean` bean as part of new * evaluate endpoint */ export interface EvaluatedJiraExpression { - meta?: JExpEvaluateMetaDataBean; + meta?: JExpEvaluateMetaData; /** * The value of the evaluated expression. It may be a primitive JSON value or a Jira REST API object. (Some * expressions do not produce any meaningful results—for example, an expression that returns a lambda function—if diff --git a/src/version2/models/fieldCreateMetadata.ts b/src/version2/models/fieldCreateMetadata.ts index 93e6db0c1..462e2c172 100644 --- a/src/version2/models/fieldCreateMetadata.ts +++ b/src/version2/models/fieldCreateMetadata.ts @@ -1,4 +1,4 @@ -import { JsonTypeBean } from './jsonTypeBean'; +import { JsonType } from './jsonType'; /** The metadata describing an issue field for createmeta. */ export interface FieldCreateMetadata { @@ -22,5 +22,5 @@ export interface FieldCreateMetadata { operations: string[]; /** Whether the field is required. */ required: boolean; - schema?: JsonTypeBean; + schema?: JsonType; } diff --git a/src/version2/models/filter.ts b/src/version2/models/filter.ts index ac37b1db2..84c57805b 100644 --- a/src/version2/models/filter.ts +++ b/src/version2/models/filter.ts @@ -5,6 +5,12 @@ import { UserList } from './userList'; /** Details about a filter. */ export interface Filter { + /** + * @experimental [Experimental] Approximate last used time. Returns the date and time when the filter was last used. Returns `null` + * if the filter hasn't been used after tracking was enabled. For performance reasons, timestamps aren't updated in + * real time and therefore may not be exactly accurate. + */ + approximateLastUsed?: string; /** A description of the filter. */ description?: string; /** The groups and projects that can edit the filter. */ diff --git a/src/version2/models/filterDetails.ts b/src/version2/models/filterDetails.ts index d4b8b3d62..a44d9ea59 100644 --- a/src/version2/models/filterDetails.ts +++ b/src/version2/models/filterDetails.ts @@ -4,6 +4,12 @@ import { User } from './user'; /** Details of a filter. */ export interface FilterDetails { + /** + * @experimental [Experimental] Approximate last used time. Returns the date and time when the filter was last used. Returns `null` + * if the filter hasn't been used after tracking was enabled. For performance reasons, timestamps aren't updated in + * real time and therefore may not be exactly accurate. + */ + approximateLastUsed?: string; /** The description of the filter. */ description?: string; /** diff --git a/src/version2/models/index.ts b/src/version2/models/index.ts index e4f98681c..ba7bff308 100644 --- a/src/version2/models/index.ts +++ b/src/version2/models/index.ts @@ -1,13 +1,16 @@ export * from './actorInput'; export * from './actorsMap'; +export * from './addAtlassianTeamRequest'; export * from './addField'; export * from './addGroup'; +export * from './addNotificationsDetails'; export * from './addSecuritySchemeLevelsRequest'; export * from './announcementBannerConfiguration'; export * from './announcementBannerConfigurationUpdate'; export * from './application'; export * from './applicationProperty'; export * from './applicationRole'; +export * from './archiveIssueAsyncRequest'; export * from './associatedItem'; export * from './associateFieldConfigurationsWithIssueTypesRequest'; export * from './attachment'; @@ -32,10 +35,13 @@ export * from './avatar'; export * from './avatars'; export * from './avatarUrls'; export * from './avatarWithDetails'; +export * from './bulkChangelog'; +export * from './bulkChangelogRequest'; export * from './bulkChangeOwnerDetails'; export * from './bulkCustomFieldOptionCreateRequest'; export * from './bulkCustomFieldOptionUpdateRequest'; export * from './bulkEditShareableEntity'; +export * from './bulkFetchIssueRequest'; export * from './bulkIssueIsWatching'; export * from './bulkIssuePropertyUpdateRequest'; export * from './bulkOperationErrorResult'; @@ -50,11 +56,13 @@ export * from './changedWorklogs'; export * from './changelog'; export * from './columnItem'; export * from './comment'; +export * from './component'; export * from './componentIssuesCount'; export * from './componentWithIssueCount'; export * from './conditionGroupConfiguration'; export * from './conditionGroupUpdate'; export * from './configuration'; +export * from './configurationsListParameters'; export * from './connectCustomFieldValue'; export * from './connectCustomFieldValues'; export * from './connectModule'; @@ -67,14 +75,23 @@ export * from './containerOfWorkflowSchemeAssociations'; export * from './contextForProjectAndIssueType'; export * from './contextualConfiguration'; export * from './convertedJQLQueries'; +export * from './createCrossProjectReleaseRequest'; export * from './createCustomFieldContext'; +export * from './createCustomFieldRequest'; export * from './createdIssue'; export * from './createdIssues'; +export * from './createExclusionRulesRequest'; export * from './createIssueSecuritySchemeDetails'; +export * from './createIssueSourceRequest'; export * from './createNotificationSchemeDetails'; +export * from './createPermissionRequest'; +export * from './createPlanOnlyTeamRequest'; +export * from './createPlanRequest'; export * from './createPriorityDetails'; +export * from './createPrioritySchemeDetails'; export * from './createProjectDetails'; export * from './createResolutionDetails'; +export * from './createSchedulingRequest'; export * from './createUiModificationDetails'; export * from './createUpdateRoleRequest'; export * from './createWorkflowCondition'; @@ -109,19 +126,24 @@ export * from './dashboardGadgetResponse'; export * from './dashboardGadgetSettings'; export * from './dashboardGadgetUpdateRequest'; export * from './dashboardUser'; +export * from './dataClassificationLevels'; export * from './dateRangeFilter'; export * from './defaultLevelValue'; export * from './defaultShareScope'; export * from './defaultWorkflow'; +export * from './deleteAndReplaceVersion'; export * from './documentVersion'; +export * from './duplicatePlanRequest'; export * from './enhancedSearchRequest'; export * from './entityProperty'; export * from './entityPropertyDetails'; export * from './error'; export * from './errorCollection'; export * from './errors'; +export * from './evaluatedJiraExpression'; export * from './eventNotification'; export * from './exportArchivedIssuesTaskProgress'; +export * from './exportArchivedIssuesTaskProgressResponse'; export * from './failedWebhook'; export * from './failedWebhooks'; export * from './field'; @@ -149,6 +171,8 @@ export * from './foundGroups'; export * from './foundUsers'; export * from './foundUsersAndGroups'; export * from './functionReferenceData'; +export * from './getAtlassianTeamResponse'; +export * from './getPlanOnlyTeamResponse'; export * from './globalScope'; export * from './group'; export * from './groupDetails'; @@ -161,9 +185,12 @@ export * from './historyMetadataParticipant'; export * from './icon'; export * from './id'; export * from './idOrKey'; +export * from './idSearchRequest'; +export * from './idSearchResults'; export * from './includedFields'; export * from './issue'; export * from './issueArchivalSync'; +export * from './issueArchivalSyncRequest'; export * from './issueChangelogIds'; export * from './issueCommentListRequest'; export * from './issueContextVariable'; @@ -177,6 +204,8 @@ export * from './issueFieldOptionCreate'; export * from './issueFieldOptionScope'; export * from './issueFilterForBulkPropertyDelete'; export * from './issueFilterForBulkPropertySet'; +export * from './issueLimitReport'; +export * from './issueLimitReportRequest'; export * from './issueLink'; export * from './issueLinkType'; export * from './issueLinkTypes'; @@ -227,13 +256,14 @@ export * from './jExpEvaluateIssuesJqlMetaData'; export * from './jExpEvaluateIssuesMeta'; export * from './jExpEvaluateJiraExpressionResult'; export * from './jExpEvaluateMetaData'; -export * from './jiraExpressionEvaluateContext'; export * from './jexpIssues'; export * from './jexpJqlIssues'; export * from './jiraExpressionAnalysis'; export * from './jiraExpressionComplexity'; export * from './jiraExpressionEvalContext'; export * from './jiraExpressionEvalRequest'; +export * from './jiraExpressionEvaluateContext'; +export * from './jiraExpressionEvaluateRequest'; export * from './jiraExpressionEvaluationMetaData'; export * from './jiraExpressionEvalUsingEnhancedSearchRequest'; export * from './jiraExpressionForAnalysis'; @@ -243,9 +273,11 @@ export * from './jiraExpressionsComplexity'; export * from './jiraExpressionsComplexityValue'; export * from './jiraExpressionValidationError'; export * from './jiraStatus'; -export * from './jiraWorkflow'; -export * from './jiraWorkflowStatus'; +export * from './jQLCount'; +export * from './jQLCountRequest'; export * from './jqlFunctionPrecomputation'; +export * from './jqlFunctionPrecomputationGetByIdRequest'; +export * from './jqlFunctionPrecomputationGetByIdResponse'; export * from './jqlFunctionPrecomputationUpdate'; export * from './jqlFunctionPrecomputationUpdateRequest'; export * from './jQLPersonalDataMigrationRequest'; @@ -271,6 +303,8 @@ export * from './linkIssueRequestJson'; export * from './listWrapperCallbackApplicationRole'; export * from './listWrapperCallbackGroupName'; export * from './locale'; +export * from './mappingsByIssueTypeOverride'; +export * from './mappingsByWorkflow'; export * from './moveField'; export * from './multiIssueEntityProperties'; export * from './multipleCustomFieldValuesUpdate'; @@ -294,9 +328,14 @@ export * from './operationMessage'; export * from './operations'; export * from './orderOfCustomFieldOptions'; export * from './orderOfIssueTypes'; +export * from './pageBeanFieldConfigurationDetails'; +export * from './pageBeanPrioritySchemeWithPaginatedPrioritiesAndProjects'; +export * from './pageBeanPriorityWithSequence'; +export * from './pageBulkContextualConfiguration'; export * from './pageChangelog'; export * from './pageComment'; export * from './pageComponentWithIssueCount'; +export * from './pageContext'; export * from './pageContextForProjectAndIssueType'; export * from './pageContextualConfiguration'; export * from './pageCustomFieldContext'; @@ -327,6 +366,8 @@ export * from './pageJqlFunctionPrecomputation'; export * from './pageNotificationScheme'; export * from './pageOfChangelogs'; export * from './pageOfComments'; +export * from './pageOfCreateMetaIssueTypes'; +export * from './pageOfCreateMetaIssueTypeWithField'; export * from './pageOfDashboards'; export * from './pageOfStatuses'; export * from './pageOfWorklogs'; @@ -347,6 +388,8 @@ export * from './pageUserDetails'; export * from './pageUserKey'; export * from './pageVersion'; export * from './pageWebhook'; +export * from './pageWithCursorGetPlanResponseForPage'; +export * from './pageWithCursorGetTeamResponseForPage'; export * from './pageWorkflow'; export * from './pageWorkflowScheme'; export * from './pageWorkflowTransitionRules'; @@ -361,13 +404,19 @@ export * from './permissionScheme'; export * from './permissionSchemes'; export * from './permissionsKeys'; export * from './permittedProjects'; +export * from './plan'; export * from './priority'; export * from './priorityId'; +export * from './priorityMapping'; +export * from './prioritySchemeId'; +export * from './prioritySchemeWithPaginatedPrioritiesAndProjects'; +export * from './priorityWithSequence'; export * from './project'; export * from './projectAndIssueTypePair'; export * from './projectAvatars'; export * from './projectCategory'; export * from './projectComponent'; +export * from './projectDataPolicies'; export * from './projectDetails'; export * from './projectEmailAddress'; export * from './projectFeature'; @@ -401,6 +450,7 @@ export * from './remoteIssueLink'; export * from './remoteIssueLinkIdentifies'; export * from './remoteIssueLinkRequest'; export * from './remoteObject'; +export * from './removeOptionFromIssuesResult'; export * from './reorderIssuePriorities'; export * from './reorderIssueResolutionsRequest'; export * from './resolution'; @@ -421,8 +471,10 @@ export * from './screenSchemeDetails'; export * from './screenSchemeId'; export * from './screenTypes'; export * from './screenWithTab'; +export * from './searchAndReconcileRequest'; export * from './searchAndReconcileResults'; export * from './searchAutoComplete'; +export * from './searchAutoCompleteFilter'; export * from './searchRequest'; export * from './searchResults'; export * from './securityLevel'; @@ -435,12 +487,14 @@ export * from './securitySchemeMembersRequest'; export * from './securitySchemes'; export * from './securitySchemeWithProjects'; export * from './serverInformation'; +export * from './serviceRegistry'; export * from './setDefaultLevelsRequest'; export * from './setDefaultPriorityRequest'; export * from './setDefaultResolutionRequest'; export * from './sharePermission'; export * from './sharePermissionInput'; export * from './simpleApplicationProperty'; +export * from './simpleErrorCollection'; export * from './simpleLink'; export * from './simpleListWrapperApplicationRole'; export * from './simpleListWrapperGroupName'; @@ -453,14 +507,20 @@ export * from './statusLayoutUpdate'; export * from './statusMapping'; export * from './statusMappingDTO'; export * from './statusMigration'; +export * from './statusProjectIssueTypeUsageDTO'; +export * from './statusProjectUsageDTO'; export * from './statusReferenceAndPort'; export * from './statusScope'; export * from './statusUpdate'; export * from './statusUpdateRequest'; +export * from './statusWorkflowUsageDTO'; +export * from './streamingResponseBody'; export * from './suggestedIssue'; +export * from './suggestedMappingsRequest'; export * from './systemAvatars'; export * from './tabMetadata'; export * from './taskProgressObject'; +export * from './taskProgressRemoveOptionFromIssuesResult'; export * from './timeTrackingConfiguration'; export * from './timeTrackingDetails'; export * from './timeTrackingProvider'; @@ -473,12 +533,15 @@ export * from './uiModificationDetails'; export * from './uiModificationIdentifiers'; export * from './unrestrictedUserEmail'; export * from './updateCustomFieldDetails'; +export * from './updateDefaultProjectClassification'; export * from './updatedProjectCategory'; export * from './updateFieldConfigurationSchemeDetails'; export * from './updateIssueSecurityLevelDetails'; export * from './updateIssueSecuritySchemeRequest'; export * from './updateNotificationSchemeDetails'; export * from './updatePriorityDetails'; +export * from './updatePrioritySchemeRequest'; +export * from './updatePrioritySchemeResponse'; export * from './updateProjectDetails'; export * from './updateResolutionDetails'; export * from './updateScreenDetails'; @@ -500,6 +563,7 @@ export * from './version'; export * from './versionIssueCounts'; export * from './versionIssuesStatus'; export * from './versionMove'; +export * from './versionRelatedWork'; export * from './versionUnresolvedIssuesCount'; export * from './versionUsageInCustomField'; export * from './visibility'; @@ -520,6 +584,8 @@ export * from './workflowElementReference'; export * from './workflowId'; export * from './workflowLayout'; export * from './workflowOperations'; +export * from './workflowProjectIssueTypeUsageDTO'; +export * from './workflowProjectUsageDTO'; export * from './workflowRead'; export * from './workflowReferenceStatus'; export * from './workflowRuleConfiguration'; @@ -527,10 +593,19 @@ export * from './workflowRules'; export * from './workflowRulesSearch'; export * from './workflowRulesSearchDetails'; export * from './workflowScheme'; +export * from './workflowSchemeAssociation'; export * from './workflowSchemeAssociations'; export * from './workflowSchemeIdName'; export * from './workflowSchemeProjectAssociation'; +export * from './workflowSchemeProjectUsageDTO'; +export * from './workflowSchemeReadRequest'; +export * from './workflowSchemeReadResponse'; +export * from './workflowSchemeUpdateRequest'; +export * from './workflowSchemeUpdateRequiredMappingsRequest'; +export * from './workflowSchemeUpdateRequiredMappingsResponse'; +export * from './workflowSchemeUsageDTO'; export * from './workflowScope'; +export * from './workflowSearchResponse'; export * from './workflowStatus'; export * from './workflowStatusAndPort'; export * from './workflowStatusLayout'; @@ -550,7 +625,10 @@ export * from './workflowTrigger'; export * from './workflowUpdate'; export * from './workflowUpdateRequest'; export * from './workflowUpdateResponse'; +export * from './workflowUpdateValidateRequest'; export * from './workflowValidationError'; export * from './workflowValidationErrorList'; export * from './worklog'; export * from './worklogIdsRequest'; +export * from './worklogsMoveRequest'; +export * from './workspaceDataPolicy'; diff --git a/src/version2/models/jiraExpressionEvaluateRequest.ts b/src/version2/models/jiraExpressionEvaluateRequest.ts index 420c82624..d4a546566 100644 --- a/src/version2/models/jiraExpressionEvaluateRequest.ts +++ b/src/version2/models/jiraExpressionEvaluateRequest.ts @@ -1,11 +1,11 @@ -import { JiraExpressionEvaluateContextBean } from './jiraExpressionEvaluateContextBean'; +import { JiraExpressionEvaluateContext } from './jiraExpressionEvaluateContext'; /** * The request to evaluate a Jira expression. This bean will be replacing `JiraExpressionEvaluateRequest` as part of new * `evaluate` endpoint */ export interface JiraExpressionEvaluateRequest { - context?: JiraExpressionEvaluateContextBean; + context?: JiraExpressionEvaluateContext; /** The Jira expression to evaluate. */ expression: string; } diff --git a/src/version2/models/jiraTimeTrackingField.ts b/src/version2/models/jiraTimeTrackingField.ts new file mode 100644 index 000000000..1f4a46620 --- /dev/null +++ b/src/version2/models/jiraTimeTrackingField.ts @@ -0,0 +1,3 @@ +export interface JiraTimeTrackingField { + timeRemaining: string; +} diff --git a/src/version2/models/jqlFunctionPrecomputationGetByIdResponse.ts b/src/version2/models/jqlFunctionPrecomputationGetByIdResponse.ts index e74d35e28..391c1f866 100644 --- a/src/version2/models/jqlFunctionPrecomputationGetByIdResponse.ts +++ b/src/version2/models/jqlFunctionPrecomputationGetByIdResponse.ts @@ -1,9 +1,9 @@ -import { JqlFunctionPrecomputationBean } from './jqlFunctionPrecomputationBean'; +import { JqlFunctionPrecomputation } from './jqlFunctionPrecomputation'; /** Get precomputations by ID response. */ export interface JqlFunctionPrecomputationGetByIdResponse { /** List of precomputations that were not found. */ notFoundPrecomputationIDs?: string[]; /** The list of precomputations. */ - precomputations?: JqlFunctionPrecomputationBean[]; + precomputations?: JqlFunctionPrecomputation[]; } diff --git a/src/version2/models/pageBeanFieldConfigurationDetails.ts b/src/version2/models/pageBeanFieldConfigurationDetails.ts index 874778303..5917529a6 100644 --- a/src/version2/models/pageBeanFieldConfigurationDetails.ts +++ b/src/version2/models/pageBeanFieldConfigurationDetails.ts @@ -1,6 +1,12 @@ import { FieldConfigurationDetails } from './fieldConfigurationDetails'; -/** A page of items. */ +/** + * Represents a page of items, typically used for paginated responses. + * + * @deprecated This interface is deprecated and will be removed in a future version. Use + * `Paginated` instead, which is the preferred way to handle paginated responses for field + * configuration details. + */ export interface PageBeanFieldConfigurationDetails { /** Whether this is the last page. */ isLast?: boolean; diff --git a/src/version2/models/prioritySchemeId.ts b/src/version2/models/prioritySchemeId.ts index 7438ba3bd..7e349f2e2 100644 --- a/src/version2/models/prioritySchemeId.ts +++ b/src/version2/models/prioritySchemeId.ts @@ -1,8 +1,8 @@ -import { TaskProgressBeanJsonNode } from './taskProgressBeanJsonNode'; +import { TaskProgressNode } from './taskProgressNode'; /** The ID of a priority scheme. */ export interface PrioritySchemeId { /** The ID of the priority scheme. */ id?: string; - task?: TaskProgressBeanJsonNode; + task?: TaskProgressNode; } diff --git a/src/version2/models/prioritySchemeWithPaginatedPrioritiesAndProjects.ts b/src/version2/models/prioritySchemeWithPaginatedPrioritiesAndProjects.ts index 3ec69d654..9dc5ed1bc 100644 --- a/src/version2/models/prioritySchemeWithPaginatedPrioritiesAndProjects.ts +++ b/src/version2/models/prioritySchemeWithPaginatedPrioritiesAndProjects.ts @@ -1,5 +1,6 @@ -import { PageBeanPriorityWithSequence } from './pageBeanPriorityWithSequence'; -import { PageBeanProjectDetails } from './pageBeanProjectDetails'; +import { Paginated } from '../../paginated'; +import { ProjectDetails } from './projectDetails'; +import { PriorityWithSequence } from './priorityWithSequence'; /** A priority scheme with paginated priorities and projects. */ export interface PrioritySchemeWithPaginatedPrioritiesAndProjects { @@ -13,8 +14,8 @@ export interface PrioritySchemeWithPaginatedPrioritiesAndProjects { isDefault?: boolean; /** The name of the priority scheme */ name: string; - priorities?: PageBeanPriorityWithSequence; - projects?: PageBeanProjectDetails; + priorities?: Paginated; + projects?: Paginated; /** The URL of the priority scheme. */ self?: string; } diff --git a/src/version2/models/projectComponent.ts b/src/version2/models/projectComponent.ts index 6703ca07d..2ab158527 100644 --- a/src/version2/models/projectComponent.ts +++ b/src/version2/models/projectComponent.ts @@ -2,6 +2,8 @@ import { User } from './user'; /** Details about a project component. */ export interface ProjectComponent { + /** Compass component's ID. Can't be updated. Not required for creating a Project Component. */ + ari?: string; assignee?: User; /** * The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` @@ -39,6 +41,8 @@ export interface ProjectComponent { * for details. */ leadUserName?: string; + /** Compass component's metadata. Can't be updated. Not required for creating a Project Component. */ + metadata?: {}; /** * The unique name for the component in the project. Required when creating a component. Optional when updating a * component. The maximum length is 255 characters. diff --git a/src/version2/models/ruleConfiguration.ts b/src/version2/models/ruleConfiguration.ts index bcd3aefc4..4acde2729 100644 --- a/src/version2/models/ruleConfiguration.ts +++ b/src/version2/models/ruleConfiguration.ts @@ -4,7 +4,7 @@ export interface RuleConfiguration { disabled?: boolean; /** * EXPERIMENTAL: A tag used to filter rules in [Get workflow transition rule - * configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules/#api-rest-api-3-workflow-rule-config-get). + * configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-workflow-transition-rules/#api-rest-api-2-workflow-rule-config-get). */ tag?: string; /** Configuration of the rule, as it is stored by the Connect or the Forge app on the rule configuration page. */ diff --git a/src/version2/models/searchAndReconcileRequest.ts b/src/version2/models/searchAndReconcileRequest.ts index e4aeb1e63..de835be04 100644 --- a/src/version2/models/searchAndReconcileRequest.ts +++ b/src/version2/models/searchAndReconcileRequest.ts @@ -60,4 +60,6 @@ export interface SearchAndReconcileRequest { properties?: string[]; /** Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids. All issues must exist. */ reconcileIssues?: number[]; + /** Fail this request early if we can't retrieve all field data. The default is `false`. */ + failFast?: boolean; } diff --git a/src/version2/models/updatePriorityDetails.ts b/src/version2/models/updatePriorityDetails.ts index ab3ed530a..5d61df8da 100644 --- a/src/version2/models/updatePriorityDetails.ts +++ b/src/version2/models/updatePriorityDetails.ts @@ -1,9 +1,37 @@ /** Details of an issue priority. */ export interface UpdatePriorityDetails { + /** The ID for the avatar for the priority. This parameter is nullable and both iconUrl and avatarId cannot be defined. */ + avatarId?: number; /** The description of the priority. */ description?: string; - /** The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used. */ - iconUrl?: string; + /** + * The URL of an icon for the priority. Accepted protocols are HTTP and HTTPS. Built in icons can also be used. Both + * iconUrl and avatarId cannot be defined. + * + * @deprecated This property is deprecated and will be removed in a future version. Use `avatarId` instead. + */ + iconUrl?: + | '/images/icons/priorities/blocker.png' + | '/images/icons/priorities/critical.png' + | '/images/icons/priorities/high.png' + | '/images/icons/priorities/highest.png' + | '/images/icons/priorities/low.png' + | '/images/icons/priorities/lowest.png' + | '/images/icons/priorities/major.png' + | '/images/icons/priorities/medium.png' + | '/images/icons/priorities/minor.png' + | '/images/icons/priorities/trivial.png' + | '/images/icons/priorities/blocker_new.png' + | '/images/icons/priorities/critical_new.png' + | '/images/icons/priorities/high_new.png' + | '/images/icons/priorities/highest_new.png' + | '/images/icons/priorities/low_new.png' + | '/images/icons/priorities/lowest_new.png' + | '/images/icons/priorities/major_new.png' + | '/images/icons/priorities/medium_new.png' + | '/images/icons/priorities/minor_new.png' + | '/images/icons/priorities/trivial_new.png' + | string; /** The name of the priority. Must be unique. */ name?: string; /** The status color of the priority in 3-digit or 6-digit hexadecimal format. */ diff --git a/src/version2/models/updatePrioritySchemeRequest.ts b/src/version2/models/updatePrioritySchemeRequest.ts index 6ec61d28c..95ecc0e93 100644 --- a/src/version2/models/updatePrioritySchemeRequest.ts +++ b/src/version2/models/updatePrioritySchemeRequest.ts @@ -1,6 +1,6 @@ import { PriorityMapping } from './priorityMapping'; -import { UpdatePrioritiesInSchemeRequestBean } from './updatePrioritiesInSchemeRequestBean'; -import { UpdateProjectsInSchemeRequestBean } from './updateProjectsInSchemeRequestBean'; +import { UpdatePrioritiesInSchemeRequest } from './updatePrioritiesInSchemeRequest'; +import { UpdateProjectsInSchemeRequest } from './updateProjectsInSchemeRequest'; /** Details of a priority scheme. */ export interface UpdatePrioritySchemeRequest { @@ -11,6 +11,6 @@ export interface UpdatePrioritySchemeRequest { mappings?: PriorityMapping; /** The name of the priority scheme. Must be unique. */ name?: string; - priorities?: UpdatePrioritiesInSchemeRequestBean; - projects?: UpdateProjectsInSchemeRequestBean; + priorities?: UpdatePrioritiesInSchemeRequest; + projects?: UpdateProjectsInSchemeRequest; } diff --git a/src/version2/models/updatePrioritySchemeResponse.ts b/src/version2/models/updatePrioritySchemeResponse.ts index 51f1d1b97..236481e5b 100644 --- a/src/version2/models/updatePrioritySchemeResponse.ts +++ b/src/version2/models/updatePrioritySchemeResponse.ts @@ -1,8 +1,8 @@ import { PrioritySchemeWithPaginatedPrioritiesAndProjects } from './prioritySchemeWithPaginatedPrioritiesAndProjects'; -import { TaskProgressBeanJsonNode } from './taskProgressBeanJsonNode'; +import { TaskProgressNode } from './taskProgressNode'; /** Details of the updated priority scheme. */ export interface UpdatePrioritySchemeResponse { priorityScheme?: PrioritySchemeWithPaginatedPrioritiesAndProjects; - task?: TaskProgressBeanJsonNode; + task?: TaskProgressNode; } diff --git a/src/version2/models/updateProjectDetails.ts b/src/version2/models/updateProjectDetails.ts index c042c8d57..6fc4a5130 100644 --- a/src/version2/models/updateProjectDetails.ts +++ b/src/version2/models/updateProjectDetails.ts @@ -1,17 +1,22 @@ /** Details about the project. */ export interface UpdateProjectDetails { - /** The default assignee when creating issues for this project. */ - assigneeType?: string; - /** An integer value for the project's avatar. */ - avatarId?: number; /** - * The ID of the project's category. A complete list of category IDs is found using the [Get all project - * categories](#api-rest-api-2-projectCategory-get) operation. To remove the project category from the project, set - * the value to `-1.` + * Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric + * characters. The maximum length is 10 characters. */ - categoryId?: number; + key?: string; + /** The name of the project. */ + name?: string; /** A brief description of the project. */ description?: string; + /** The account ID of the project lead. Cannot be provided with `lead`. */ + leadAccountId: string; + /** A link to information about this project, such as project documentation */ + url?: string; + /** The default assignee when creating issues for this project. */ + assigneeType?: string; + /** An integer value for the project's avatar. */ + avatarId?: number; /** * The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. * Use the [Get issue security schemes](#api-rest-api-2-issuesecurityschemes-get) resource to get all issue security @@ -19,24 +24,24 @@ export interface UpdateProjectDetails { */ issueSecurityScheme?: number; /** - * Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric - * characters. The maximum length is 10 characters. + * The ID of the permission scheme for the project. Use the [Get all permission + * schemes](#api-rest-api-2-permissionscheme-get) resource to see a list of all permission scheme IDs. */ - key?: string; - /** The account ID of the project lead. Cannot be provided with `lead`. */ - leadAccountId: string; - /** The name of the project. */ - name?: string; + permissionScheme?: number; /** * The ID of the notification scheme for the project. Use the [Get notification * schemes](#api-rest-api-2-notificationscheme-get) resource to get a list of notification scheme IDs. */ notificationScheme?: number; /** - * The ID of the permission scheme for the project. Use the [Get all permission - * schemes](#api-rest-api-2-permissionscheme-get) resource to see a list of all permission scheme IDs. + * The ID of the project's category. A complete list of category IDs is found using the [Get all project + * categories](#api-rest-api-2-projectCategory-get) operation. To remove the project category from the project, set + * the value to `-1.` */ - permissionScheme?: number; - /** A link to information about this project, such as project documentation */ - url?: string; + categoryId?: number; + /** + * Previous project keys to be released from the current project. Released keys must belong to the current project and + * not contain the current project key + */ + releasedProjectKeys?: string[]; } diff --git a/src/version2/models/version.ts b/src/version2/models/version.ts index 5c2cd8491..d656976ce 100644 --- a/src/version2/models/version.ts +++ b/src/version2/models/version.ts @@ -1,8 +1,17 @@ -import { SimpleLink } from './simpleLink'; +import { VersionApprover } from './versionApprover'; import { VersionIssuesStatus } from './versionIssuesStatus'; +import { SimpleLink } from './simpleLink'; /** Details about a project version. */ export interface Version { + /** If the expand option `approvers` is used, returns a list containing the approvers for this version. */ + approvers?: VersionApprover[]; + /** Indicates that the version is archived. Optional when creating or updating a version. */ + archived?: boolean; + /** The description of the version. Optional when creating or updating a version. The maximum size is 16,384 bytes. */ + description?: string; + /** If the expand option `driver` is used, returns the Atlassian account ID of the driver. */ + driver?: string; /** * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#expansion) to include additional * information about version in the response. This parameter accepts a comma-separated list. Expand options include: @@ -19,15 +28,11 @@ export interface Version { self?: string; /** The ID of the version. */ id?: string; - /** The description of the version. Optional when creating or updating a version. */ - description?: string; /** * The unique name of the version. Required when creating a version. Optional when updating a version. The maximum * length is 255 characters. */ name?: string; - /** Indicates that the version is archived. Optional when creating or updating a version. */ - archived?: boolean; /** * Indicates that the version is released. If the version is released a request to release again is ignored. Not * applicable when creating a version. Optional when updating a version. diff --git a/src/version2/models/webhook.ts b/src/version2/models/webhook.ts index 7886ad727..e9e804f18 100644 --- a/src/version2/models/webhook.ts +++ b/src/version2/models/webhook.ts @@ -4,7 +4,7 @@ export interface Webhook { events: string[]; /** * The date after which the webhook is no longer sent. Use [Extend webhook - * life](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-webhooks/#api-rest-api-3-webhook-refresh-put) + * life](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-webhooks/#api-rest-api-2-webhook-refresh-put) * to extend the date. */ expirationDate?: number; diff --git a/src/version2/myself.ts b/src/version2/myself.ts index 7876132dc..c0692b4c2 100644 --- a/src/version2/myself.ts +++ b/src/version2/myself.ts @@ -31,7 +31,7 @@ export class Myself { * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** * Permission to access Jira. */ - async getPreference(parameters: Parameters.GetPreference, callback: Callback): Promise; + async getPreference(parameters: Parameters.GetPreference, callback: Callback): Promise; /** * Returns the value of a preference of the current user. * @@ -57,8 +57,8 @@ export class Myself { * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** * Permission to access Jira. */ - async getPreference(parameters: Parameters.GetPreference, callback?: never): Promise; - async getPreference( + async getPreference(parameters: Parameters.GetPreference, callback?: never): Promise; + async getPreference( parameters: Parameters.GetPreference, callback?: Callback, ): Promise { diff --git a/src/version2/parameters/bulkDeleteWorklogs.ts b/src/version2/parameters/bulkDeleteWorklogs.ts index ef7dcab89..1358266f7 100644 --- a/src/version2/parameters/bulkDeleteWorklogs.ts +++ b/src/version2/parameters/bulkDeleteWorklogs.ts @@ -1,6 +1,6 @@ -import { WorklogIdsRequestBean } from '../models'; +import { WorklogIdsRequest } from '../models'; -export interface BulkDeleteWorklogs extends WorklogIdsRequestBean { +export interface BulkDeleteWorklogs extends WorklogIdsRequest { /** The ID or key of the issue. */ issueIdOrKey: string; /** diff --git a/src/version2/parameters/bulkFetchIssues.ts b/src/version2/parameters/bulkFetchIssues.ts index c9c19ef59..ac8d5b91a 100644 --- a/src/version2/parameters/bulkFetchIssues.ts +++ b/src/version2/parameters/bulkFetchIssues.ts @@ -1,3 +1,3 @@ -import { BulkFetchIssueRequestBean } from '../models'; +import { BulkFetchIssueRequest } from '../models'; -export interface BulkFetchIssues extends BulkFetchIssueRequestBean {} +export interface BulkFetchIssues extends BulkFetchIssueRequest {} diff --git a/src/version2/parameters/bulkMoveWorklogs.ts b/src/version2/parameters/bulkMoveWorklogs.ts index 7d34cefb2..6e87b7d39 100644 --- a/src/version2/parameters/bulkMoveWorklogs.ts +++ b/src/version2/parameters/bulkMoveWorklogs.ts @@ -1,12 +1,13 @@ -import { WorklogsMoveRequestBean } from '../models'; +import { WorklogsMoveRequest } from '../models'; -export interface BulkMoveWorklogs extends WorklogsMoveRequestBean { +export interface BulkMoveWorklogs { issueIdOrKey: string; /** * Defines how to update the issues' time estimate, the options are: * - * `leave` Leaves the estimate unchanged. `auto` Reduces the estimate by the aggregate value of `timeSpent` across - * all worklogs being moved in the source issue, and increases it in the destination issue. + * - `leave` Leaves the estimate unchanged. + * - `auto` Reduces the estimate by the aggregate value of `timeSpent` across all worklogs being moved in the source + * issue, and increases it in the destination issue. */ adjustEstimate?: 'leave' | 'auto' | string; /** @@ -15,4 +16,5 @@ export interface BulkMoveWorklogs extends WorklogsMoveRequestBean { * admin permission can use this flag. */ overrideEditableFlag?: boolean; + worklogs: WorklogsMoveRequest; } diff --git a/src/version2/parameters/copyDashboard.ts b/src/version2/parameters/copyDashboard.ts index 1e157d012..905415da2 100644 --- a/src/version2/parameters/copyDashboard.ts +++ b/src/version2/parameters/copyDashboard.ts @@ -2,4 +2,9 @@ import { DashboardDetails } from '../models'; export interface CopyDashboard extends DashboardDetails { id: string; + /** + * Whether admin level permissions are used. It should only be true if the user has _Administer Jira_ [global + * permission](https://confluence.atlassian.com/x/x4dKLg) + */ + extendAdminPermissions?: boolean; } diff --git a/src/version2/parameters/countIssues.ts b/src/version2/parameters/countIssues.ts index 8652b1c26..527120f2a 100644 --- a/src/version2/parameters/countIssues.ts +++ b/src/version2/parameters/countIssues.ts @@ -1,3 +1,3 @@ -import { JQLCountRequestBean } from '../models'; +import { JQLCountRequest } from '../models'; -export interface CountIssues extends JQLCountRequestBean {} +export interface CountIssues extends JQLCountRequest {} diff --git a/src/version2/parameters/createDashboard.ts b/src/version2/parameters/createDashboard.ts index eb78135c4..372243bba 100644 --- a/src/version2/parameters/createDashboard.ts +++ b/src/version2/parameters/createDashboard.ts @@ -3,4 +3,9 @@ import { DashboardDetails, SharePermission } from '../models'; export interface CreateDashboard extends Omit { /** The edit permissions for the dashboard. */ editPermissions?: SharePermission[]; + /** + * Whether admin level permissions are used. It should only be true if the user has _Administer Jira_ [global + * permission](https://confluence.atlassian.com/x/x4dKLg) + */ + extendAdminPermissions?: boolean; } diff --git a/src/version2/parameters/deleteComment.ts b/src/version2/parameters/deleteComment.ts index a06ad01e8..5050950ed 100644 --- a/src/version2/parameters/deleteComment.ts +++ b/src/version2/parameters/deleteComment.ts @@ -3,4 +3,5 @@ export interface DeleteComment { issueIdOrKey: string; /** The ID of the comment. */ id: string; + parentId?: string; } diff --git a/src/version2/parameters/editIssue.ts b/src/version2/parameters/editIssue.ts index 1be9cc59a..f5ad5596d 100644 --- a/src/version2/parameters/editIssue.ts +++ b/src/version2/parameters/editIssue.ts @@ -23,7 +23,7 @@ export interface EditIssue extends IssueUpdateDetails { overrideEditableFlag?: boolean; /** * Whether the response should contain the issue with fields edited in this request. The returned issue will have the - * same format as in the [Get issue API](#api-rest-api-3-issue-issueidorkey-get). + * same format as in the [Get issue API](#api-rest-api-2-issue-issueidorkey-get). */ returnIssue?: boolean; /** The Get issue API expand parameter to use in the response if the `returnIssue` parameter is `true`. */ diff --git a/src/version2/parameters/evaluateJSISJiraExpression.ts b/src/version2/parameters/evaluateJSISJiraExpression.ts deleted file mode 100644 index 3dc1122bb..000000000 --- a/src/version2/parameters/evaluateJSISJiraExpression.ts +++ /dev/null @@ -1,13 +0,0 @@ -import { JiraExpressionEvaluateRequestBean } from '../models'; - -export interface EvaluateJSISJiraExpression extends JiraExpressionEvaluateRequestBean { - /** - * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#expansion) to include additional - * information in the response. This parameter accepts `meta.complexity` that returns information about the - * expression complexity. For example, the number of expensive operations used by the expression and how close the - * expression is to reaching the [complexity - * limit](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#restrictions). Useful when designing - * and debugging your expressions. - */ - expand?: string; -} diff --git a/src/version2/parameters/findAssignableUsers.ts b/src/version2/parameters/findAssignableUsers.ts index 54f9e3a09..78bb7397f 100644 --- a/src/version2/parameters/findAssignableUsers.ts +++ b/src/version2/parameters/findAssignableUsers.ts @@ -20,6 +20,8 @@ export interface FindAssignableUsers { project?: string; /** The key of the issue. Required, unless `project` is specified. */ issueKey?: string; + /** The ID of the issue. Required, unless `issueKey` or `project` is specified. */ + issueId?: string; /** The index of the first item to return in a page of results (page offset). */ startAt?: number; /** diff --git a/src/version2/parameters/getAvailablePrioritiesByPriorityScheme.ts b/src/version2/parameters/getAvailablePrioritiesByPriorityScheme.ts index e576614d0..da7ba318f 100644 --- a/src/version2/parameters/getAvailablePrioritiesByPriorityScheme.ts +++ b/src/version2/parameters/getAvailablePrioritiesByPriorityScheme.ts @@ -1,8 +1,8 @@ export interface GetAvailablePrioritiesByPriorityScheme { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** The string to query priorities on by name. */ query?: string; /** The priority scheme ID. */ diff --git a/src/version2/parameters/getAvailableTransitions.ts b/src/version2/parameters/getAvailableTransitions.ts new file mode 100644 index 000000000..77684c788 --- /dev/null +++ b/src/version2/parameters/getAvailableTransitions.ts @@ -0,0 +1,8 @@ +export interface GetAvailableTransitions { + /** Ids or keys of the issues to get transitions available for them. */ + issueIdsOrKeys: (number | string)[]; + /** The end cursor for use in pagination. */ + endingBefore?: string; + /** The start cursor for use in pagination. */ + startingAfter?: string; +} diff --git a/src/version2/parameters/getBulkChangelogs.ts b/src/version2/parameters/getBulkChangelogs.ts index 662e69d8d..fefc8eb77 100644 --- a/src/version2/parameters/getBulkChangelogs.ts +++ b/src/version2/parameters/getBulkChangelogs.ts @@ -1,3 +1,3 @@ -import { BulkChangelogRequestBean } from '../models'; +import { BulkChangelogRequest } from '../models'; -export interface GetBulkChangelogs extends BulkChangelogRequestBean {} +export interface GetBulkChangelogs extends BulkChangelogRequest {} diff --git a/src/version2/parameters/getBulkEditableFields.ts b/src/version2/parameters/getBulkEditableFields.ts new file mode 100644 index 000000000..148a44d41 --- /dev/null +++ b/src/version2/parameters/getBulkEditableFields.ts @@ -0,0 +1,10 @@ +export interface GetBulkEditableFields { + /** The IDs or keys of the issues to get editable fields from. */ + issueIdsOrKeys: number | string; + /** (Optional)The text to search for in the editable fields. */ + searchText?: string; + /** (Optional)The end cursor for use in pagination. */ + endingBefore?: string; + /** (Optional)The start cursor for use in pagination. */ + startingAfter?: string; +} diff --git a/src/version2/parameters/getBulkOperationProgress.ts b/src/version2/parameters/getBulkOperationProgress.ts new file mode 100644 index 000000000..976c68799 --- /dev/null +++ b/src/version2/parameters/getBulkOperationProgress.ts @@ -0,0 +1,4 @@ +export interface GetBulkOperationProgress { + /** The ID of the task. */ + taskId: string; +} diff --git a/src/version2/parameters/getFiltersPaginated.ts b/src/version2/parameters/getFiltersPaginated.ts index 8dbaac430..ea3bf9520 100644 --- a/src/version2/parameters/getFiltersPaginated.ts +++ b/src/version2/parameters/getFiltersPaginated.ts @@ -112,4 +112,10 @@ export interface GetFiltersPaginated { * Available to users with _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ overrideSharePermissions?: boolean; + /** + * When `true` this will perform a case-insensitive substring match for the provided `filterName`. When `false` the + * filter name will be searched using [full text search + * syntax](https://support.atlassian.com/jira-software-cloud/docs/search-for-issues-using-the-text-field/). + */ + isSubstringMatch?: boolean; } diff --git a/src/version2/parameters/getIssue.ts b/src/version2/parameters/getIssue.ts index 683b42939..5fb680239 100644 --- a/src/version2/parameters/getIssue.ts +++ b/src/version2/parameters/getIssue.ts @@ -67,4 +67,10 @@ export interface GetIssue { * field. */ updateHistory?: boolean; + /** + * Whether to fail the request quickly in case of an error while loading fields for an issue. For `failFast=true`, if + * one field fails, the entire operation fails. For `failFast=false`, the operation will continue even if a field + * fails. It will return a valid response, but without values for the failed field(s). + */ + failFast?: boolean; } diff --git a/src/version2/parameters/getNotificationSchemeToProjectMappings.ts b/src/version2/parameters/getNotificationSchemeToProjectMappings.ts index 34cfec0e7..bfb504e6e 100644 --- a/src/version2/parameters/getNotificationSchemeToProjectMappings.ts +++ b/src/version2/parameters/getNotificationSchemeToProjectMappings.ts @@ -1,8 +1,8 @@ export interface GetNotificationSchemeToProjectMappings { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** The list of notifications scheme IDs to be filtered out */ notificationSchemeId?: string[]; /** The list of project IDs to be filtered out */ diff --git a/src/version2/parameters/getPrioritiesByPriorityScheme.ts b/src/version2/parameters/getPrioritiesByPriorityScheme.ts index 76d7512d9..6cd7fceda 100644 --- a/src/version2/parameters/getPrioritiesByPriorityScheme.ts +++ b/src/version2/parameters/getPrioritiesByPriorityScheme.ts @@ -1,8 +1,8 @@ export interface GetPrioritiesByPriorityScheme { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** The priority scheme ID. */ schemeId: string; } diff --git a/src/version2/parameters/getPrioritySchemes.ts b/src/version2/parameters/getPrioritySchemes.ts index 9ea7155e7..0b592bd02 100644 --- a/src/version2/parameters/getPrioritySchemes.ts +++ b/src/version2/parameters/getPrioritySchemes.ts @@ -1,8 +1,8 @@ export interface GetPrioritySchemes { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** * A set of priority IDs to filter by. To include multiple IDs, provide an ampersand-separated list. For example, * `priorityId=10000&priorityId=10001`. diff --git a/src/version2/parameters/getProjectComponents.ts b/src/version2/parameters/getProjectComponents.ts index 4bdde93bb..5c47fd94d 100644 --- a/src/version2/parameters/getProjectComponents.ts +++ b/src/version2/parameters/getProjectComponents.ts @@ -1,4 +1,12 @@ export interface GetProjectComponents { /** The project ID or project key (case sensitive). */ projectIdOrKey: string; + /** + * The source of the components to return. Can be `jira` (default), `compass` or `auto`. When `auto` is specified, the + * API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira + * components. Defaults to `jira`. + * + * @default jira + */ + componentSource?: 'jira' | 'compass' | 'auto' | string; } diff --git a/src/version2/parameters/getProjectComponentsPaginated.ts b/src/version2/parameters/getProjectComponentsPaginated.ts index 5625e9ee3..0deb60f1e 100644 --- a/src/version2/parameters/getProjectComponentsPaginated.ts +++ b/src/version2/parameters/getProjectComponentsPaginated.ts @@ -32,4 +32,12 @@ export interface GetProjectComponentsPaginated { * insensitive). */ query?: string; + /** + * The source of the components to return. Can be `jira` (default), `compass` or `auto`. When `auto` is specified, the + * API will return connected Compass components if the project is opted into Compass, otherwise it will return Jira + * components. Defaults to `jira`. + * + * @default jira + */ + componentSource?: 'jira' | 'compass' | 'auto' | string; } diff --git a/src/version2/parameters/getProjectsByPriorityScheme.ts b/src/version2/parameters/getProjectsByPriorityScheme.ts index 6bbbf10e4..607505f6d 100644 --- a/src/version2/parameters/getProjectsByPriorityScheme.ts +++ b/src/version2/parameters/getProjectsByPriorityScheme.ts @@ -1,8 +1,8 @@ export interface GetProjectsByPriorityScheme { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** The project IDs to filter by. For example, `projectId=10000&projectId=10001`. */ projectId?: number[]; /** The priority scheme ID. */ diff --git a/src/version2/parameters/getSecurityLevelMembers.ts b/src/version2/parameters/getSecurityLevelMembers.ts index 1c16a7eaa..ceb2e31ef 100644 --- a/src/version2/parameters/getSecurityLevelMembers.ts +++ b/src/version2/parameters/getSecurityLevelMembers.ts @@ -1,8 +1,8 @@ export interface GetSecurityLevelMembers { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** * The list of issue security level member IDs. To include multiple issue security level members separate IDs with an * ampersand: `id=10000&id=10001`. diff --git a/src/version2/parameters/getSecurityLevels.ts b/src/version2/parameters/getSecurityLevels.ts index 7b2fccad0..cd8503604 100644 --- a/src/version2/parameters/getSecurityLevels.ts +++ b/src/version2/parameters/getSecurityLevels.ts @@ -1,8 +1,8 @@ export interface GetSecurityLevels { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** * The list of issue security scheme level IDs. To include multiple issue security levels, separate IDs with an * ampersand: `id=10000&id=10001`. diff --git a/src/version2/parameters/index.ts b/src/version2/parameters/index.ts index cb9dbe024..e5450596e 100644 --- a/src/version2/parameters/index.ts +++ b/src/version2/parameters/index.ts @@ -1,10 +1,12 @@ export * from './addActorUsers'; +export * from './addAtlassianTeam'; export * from './addAttachment'; export * from './addComment'; export * from './addFieldToDefaultScreen'; export * from './addGadget'; export * from './addIssueTypesToContext'; export * from './addIssueTypesToIssueTypeScheme'; +export * from './addNotifications'; export * from './addProjectRoleActorsToRole'; export * from './addScreenTab'; export * from './addScreenTabField'; @@ -19,6 +21,7 @@ export * from './analyseExpression'; export * from './appendMappingsForIssueTypeScreenScheme'; export * from './archiveIssues'; export * from './archiveIssuesAsync'; +export * from './archivePlan'; export * from './archiveProject'; export * from './assignFieldConfigurationSchemeToProject'; export * from './assignIssue'; @@ -29,16 +32,20 @@ export * from './assignProjectsToCustomFieldContext'; export * from './assignSchemeToProject'; export * from './associateSchemesToProjects'; export * from './bulkDeleteIssueProperty'; +export * from './bulkDeleteWorklogs'; export * from './bulkEditDashboards'; +export * from './bulkFetchIssues'; export * from './bulkGetGroups'; export * from './bulkGetUsers'; export * from './bulkGetUsersMigration'; +export * from './bulkMoveWorklogs'; export * from './bulkSetIssuePropertiesByIssue'; export * from './bulkSetIssueProperty'; export * from './bulkSetIssuesProperties'; export * from './cancelTask'; export * from './changeFilterOwner'; export * from './copyDashboard'; +export * from './countIssues'; export * from './createComponent'; export * from './createCustomField'; export * from './createCustomFieldContext'; @@ -61,11 +68,15 @@ export * from './createNotificationScheme'; export * from './createOrUpdateRemoteIssueLink'; export * from './createPermissionGrant'; export * from './createPermissionScheme'; +export * from './createPlan'; +export * from './createPlanOnlyTeam'; export * from './createPriority'; +export * from './createPriorityScheme'; export * from './createProject'; export * from './createProjectAvatar'; export * from './createProjectCategory'; export * from './createProjectRole'; +export * from './createRelatedWork'; export * from './createResolution'; export * from './createScreen'; export * from './createScreenScheme'; @@ -111,12 +122,16 @@ export * from './deleteIssueTypeScreenScheme'; export * from './deleteNotificationScheme'; export * from './deletePermissionScheme'; export * from './deletePermissionSchemeEntity'; +export * from './deletePlanOnlyTeam'; +export * from './deletePriority'; +export * from './deletePriorityScheme'; export * from './deleteProject'; export * from './deleteProjectAsynchronously'; export * from './deleteProjectAvatar'; export * from './deleteProjectProperty'; export * from './deleteProjectRole'; export * from './deleteProjectRoleActorsFromRole'; +export * from './deleteRelatedWork'; export * from './deleteRemoteIssueLinkByGlobalId'; export * from './deleteRemoteIssueLinkById'; export * from './deleteResolution'; @@ -128,6 +143,7 @@ export * from './deleteSharePermission'; export * from './deleteStatusesById'; export * from './deleteUiModification'; export * from './deleteUserProperty'; +export * from './deleteVersion'; export * from './deleteWebhookById'; export * from './deleteWorkflowMapping'; export * from './deleteWorkflowScheme'; @@ -139,6 +155,7 @@ export * from './deleteWorkflowTransitionRuleConfigurations'; export * from './deleteWorklog'; export * from './deleteWorklogProperty'; export * from './doTransition'; +export * from './duplicatePlan'; export * from './editIssue'; export * from './evaluateJiraExpression'; export * from './evaluateJiraExpressionUsingEnhancedSearch'; @@ -147,6 +164,7 @@ export * from './expandAttachmentForMachines'; export * from './exportArchivedIssues'; export * from './findAssignableUsers'; export * from './findBulkAssignableUsers'; +export * from './findComponentsForProjects'; export * from './findGroups'; export * from './findUserKeysByQuery'; export * from './findUsers'; @@ -168,10 +186,12 @@ export * from './getAllIssueTypeSchemes'; export * from './getAllLabels'; export * from './getAllPermissionSchemes'; export * from './getAllProjectAvatars'; +export * from './getAllProjects'; export * from './getAllScreenTabFields'; export * from './getAllScreenTabs'; export * from './getAllStatuses'; export * from './getAllSystemAvatars'; +export * from './getAllUserDataClassificationLevels'; export * from './getAllUsers'; export * from './getAllUsersDefault'; export * from './getAllWorkflowSchemes'; @@ -179,17 +199,24 @@ export * from './getAlternativeIssueTypes'; export * from './getApplicationProperty'; export * from './getApplicationRole'; export * from './getAssignedPermissionScheme'; +export * from './getAtlassianTeam'; export * from './getAttachment'; export * from './getAttachmentContent'; export * from './getAttachmentThumbnail'; export * from './getAuditRecords'; export * from './getAutoCompletePost'; +export * from './getAvailablePrioritiesByPriorityScheme'; export * from './getAvailableScreenFields'; +export * from './getAvailableTransitions'; export * from './getAvatarImageByID'; export * from './getAvatarImageByOwner'; export * from './getAvatarImageByType'; export * from './getAvatars'; +export * from './getBulkChangelogs'; +export * from './getBulkEditableFields'; +export * from './getBulkOperationProgress'; export * from './getBulkPermissions'; +export * from './getBulkScreenTabs'; export * from './getChangeLogs'; export * from './getChangeLogsByIds'; export * from './getColumns'; @@ -201,15 +228,20 @@ export * from './getCommentsByIds'; export * from './getComponent'; export * from './getComponentRelatedIssues'; export * from './getContextsForField'; +export * from './getContextsForFieldDeprecated'; export * from './getCreateIssueMeta'; +export * from './getCreateIssueMetaIssueTypeId'; +export * from './getCreateIssueMetaIssueTypes'; export * from './getCurrentUser'; export * from './getCustomFieldConfiguration'; export * from './getCustomFieldContextsForProjectsAndIssueTypes'; export * from './getCustomFieldOption'; +export * from './getCustomFieldsConfigurations'; export * from './getDashboard'; export * from './getDashboardItemProperty'; export * from './getDashboardItemPropertyKeys'; export * from './getDashboardsPaginated'; +export * from './getDefaultProjectClassification'; export * from './getDefaultValues'; export * from './getDefaultWorkflow'; export * from './getDraftDefaultWorkflow'; @@ -231,6 +263,7 @@ export * from './getIdsOfWorklogsDeletedSince'; export * from './getIdsOfWorklogsModifiedSince'; export * from './getIssue'; export * from './getIssueFieldOption'; +export * from './getIssueLimitReport'; export * from './getIssueLink'; export * from './getIssueLinkType'; export * from './getIssuePickerResource'; @@ -263,9 +296,16 @@ export * from './getPermissionScheme'; export * from './getPermissionSchemeGrant'; export * from './getPermissionSchemeGrants'; export * from './getPermittedProjects'; +export * from './getPlan'; +export * from './getPlanOnlyTeam'; +export * from './getPlans'; +export * from './getPolicies'; export * from './getPrecomputations'; +export * from './getPrecomputationsByID'; export * from './getPreference'; +export * from './getPrioritiesByPriorityScheme'; export * from './getPriority'; +export * from './getPrioritySchemes'; export * from './getProject'; export * from './getProjectCategoryById'; export * from './getProjectComponents'; @@ -273,6 +313,7 @@ export * from './getProjectComponentsPaginated'; export * from './getProjectContextMapping'; export * from './getProjectEmail'; export * from './getProjectIssueSecurityScheme'; +export * from './getProjectIssueTypeUsagesForStatus'; export * from './getProjectProperty'; export * from './getProjectPropertyKeys'; export * from './getProjectRole'; @@ -280,13 +321,19 @@ export * from './getProjectRoleActorsForRole'; export * from './getProjectRoleById'; export * from './getProjectRoleDetails'; export * from './getProjectRoles'; +export * from './getProjectsByPriorityScheme'; export * from './getProjectsForIssueTypeScreenScheme'; export * from './getProjectTypeByKey'; +export * from './getProjectUsagesForStatus'; +export * from './getProjectUsagesForWorkflow'; +export * from './getProjectUsagesForWorkflowScheme'; export * from './getProjectVersions'; export * from './getProjectVersionsPaginated'; export * from './getRecent'; +export * from './getRelatedWork'; export * from './getRemoteIssueLinkById'; export * from './getRemoteIssueLinks'; +export * from './getResolution'; export * from './getScreens'; export * from './getScreenSchemes'; export * from './getScreensForField'; @@ -300,6 +347,7 @@ export * from './getStatus'; export * from './getStatusCategory'; export * from './getStatusesById'; export * from './getTask'; +export * from './getTeams'; export * from './getTransitions'; export * from './getTrashedFieldsPaginated'; export * from './getUiModifications'; @@ -319,14 +367,17 @@ export * from './getVersionUnresolvedIssues'; export * from './getVisibleIssueFieldOptions'; export * from './getVotes'; export * from './getWorkflow'; +export * from './getWorkflowProjectIssueTypeUsages'; export * from './getWorkflowScheme'; export * from './getWorkflowSchemeDraft'; export * from './getWorkflowSchemeDraftIssueType'; export * from './getWorkflowSchemeIssueType'; export * from './getWorkflowSchemeProjectAssociations'; +export * from './getWorkflowSchemeUsagesForWorkflow'; export * from './getWorkflowsPaginated'; export * from './getWorkflowTransitionProperties'; export * from './getWorkflowTransitionRuleConfigurations'; +export * from './getWorkflowUsagesForStatus'; export * from './getWorklog'; export * from './getWorklogProperty'; export * from './getWorklogPropertyKeys'; @@ -347,11 +398,14 @@ export * from './publishDraftWorkflowScheme'; export * from './putAddonProperty'; export * from './putAppProperty'; export * from './readWorkflows'; +export * from './readWorkflowSchemes'; export * from './refreshWebhooks'; export * from './registerDynamicWebhooks'; export * from './registerModules'; +export * from './removeAtlassianTeam'; export * from './removeAttachment'; export * from './removeCustomFieldContextFromProjects'; +export * from './removeDefaultProjectClassification'; export * from './removeGadget'; export * from './removeGroup'; export * from './removeIssueTypeFromIssueTypeScheme'; @@ -372,6 +426,7 @@ export * from './removeWatcher'; export * from './renameScreenTab'; export * from './reorderCustomFieldOptions'; export * from './reorderIssueTypesInIssueTypeScheme'; +export * from './replaceCustomFieldOption'; export * from './replaceIssueFieldOption'; export * from './resetColumns'; export * from './resetUserColumns'; @@ -379,6 +434,7 @@ export * from './restore'; export * from './restoreCustomField'; export * from './sanitiseJqlQueries'; export * from './search'; +export * from './searchForIssuesIds'; export * from './searchForIssuesUsingJql'; export * from './searchForIssuesUsingJqlEnhancedSearch'; export * from './searchForIssuesUsingJqlEnhancedSearchPost'; @@ -388,7 +444,9 @@ export * from './searchProjects'; export * from './searchProjectsUsingSecuritySchemes'; export * from './searchResolutions'; export * from './searchSecuritySchemes'; +export * from './searchWorkflows'; export * from './selectTimeTrackingImplementation'; +export * from './services'; export * from './setActors'; export * from './setApplicationProperty'; export * from './setBanner'; @@ -404,6 +462,7 @@ export * from './setFavouriteForFilter'; export * from './setFieldConfigurationSchemeMapping'; export * from './setIssueProperty'; export * from './setIssueTypeProperty'; +export * from './setLocale'; export * from './setPreference'; export * from './setProjectProperty'; export * from './setSharedTimeTrackingConfiguration'; @@ -413,9 +472,12 @@ export * from './setWorkflowSchemeDraftIssueType'; export * from './setWorkflowSchemeIssueType'; export * from './setWorklogProperty'; export * from './storeAvatar'; +export * from './suggestedPrioritiesForMappings'; export * from './toggleFeatureForProject'; export * from './trashCustomField'; +export * from './trashPlan'; export * from './unarchiveIssues'; +export * from './updateAtlassianTeam'; export * from './updateComment'; export * from './updateComponent'; export * from './updateCustomField'; @@ -424,6 +486,7 @@ export * from './updateCustomFieldContext'; export * from './updateCustomFieldOption'; export * from './updateCustomFieldValue'; export * from './updateDashboard'; +export * from './updateDefaultProjectClassification'; export * from './updateDefaultScreenScheme'; export * from './updateDefaultWorkflow'; export * from './updateDraftDefaultWorkflow'; @@ -444,14 +507,19 @@ export * from './updateIssueTypeScreenScheme'; export * from './updateMultipleCustomFieldValues'; export * from './updateNotificationScheme'; export * from './updatePermissionScheme'; +export * from './updatePlan'; +export * from './updatePlanOnlyTeam'; export * from './updatePrecomputations'; export * from './updatePriority'; +export * from './updatePriorityScheme'; export * from './updateProject'; export * from './updateProjectAvatar'; export * from './updateProjectCategory'; export * from './updateProjectEmail'; +export * from './updateRelatedWork'; export * from './updateRemoteIssueLink'; export * from './updateResolution'; +export * from './updateSchemes'; export * from './updateScreen'; export * from './updateScreenScheme'; export * from './updateSecurityLevel'; @@ -462,6 +530,7 @@ export * from './updateWorkflowMapping'; export * from './updateWorkflows'; export * from './updateWorkflowScheme'; export * from './updateWorkflowSchemeDraft'; +export * from './updateWorkflowSchemeMappings'; export * from './updateWorkflowTransitionProperty'; export * from './updateWorkflowTransitionRuleConfigurations'; export * from './updateWorklog'; diff --git a/src/version2/parameters/readWorkflows.ts b/src/version2/parameters/readWorkflows.ts index c1248108f..cc844a538 100644 --- a/src/version2/parameters/readWorkflows.ts +++ b/src/version2/parameters/readWorkflows.ts @@ -1,18 +1,20 @@ import { ProjectAndIssueTypePair } from '../models'; export interface ReadWorkflows { + /** + * Return the new fields (`toStatusReference`/`links`) instead of the deprecated fields (`to`/`from`) for workflow + * transition port mappings. + */ + useTransitionLinksFormat?: boolean; + /** + * Return the new field `approvalConfiguration` instead of the deprecated status properties for approval + * configuration. + */ + useApprovalConfiguration?: boolean; /** The list of projects and issue types to query. */ projectAndIssueTypes?: ProjectAndIssueTypePair[]; /** The list of workflow IDs to query. */ workflowIds?: string[]; /** The list of workflow names to query. */ workflowNames?: string[]; - /** - * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#expansion) to include additional - * information in the response. This parameter accepts a comma-separated list. Expand options include: - * - * `workflows.usages` Returns the project and issue types that each workflow is associated with. `statuses.usages` - * Returns the project and issue types that each status is associated with. - */ - expand?: string; } diff --git a/src/version2/parameters/searchAndReconsileIssuesUsingJql.ts b/src/version2/parameters/searchAndReconsileIssuesUsingJql.ts deleted file mode 100644 index 730c48f43..000000000 --- a/src/version2/parameters/searchAndReconsileIssuesUsingJql.ts +++ /dev/null @@ -1,65 +0,0 @@ -export interface SearchAndReconsileIssuesUsingJql { - /** - * A [JQL](https://confluence.atlassian.com/x/egORLQ) expression. For performance reasons, this parameter requires a - * bounded query. A bounded query is a query with a search restriction. - * - * Example of an unbounded query: `order by key desc`. Example of a bounded query: `assignee = currentUser() order - * by key`. - * - * Additionally, `orderBy` clause can contain a maximum of 7 fields. - */ - jql?: string; - /** - * The token for a page to fetch that is not the first page. The first page has a `nextPageToken` of `null`. Use the - * `nextPageToken` to fetch the next page of issues. - */ - nextPageToken?: string; - /** - * The maximum number of items to return per page. To manage page size, API may return fewer items per page where a - * large number of fields are requested. The greatest number of items returned per page is achieved when requesting - * `id` or `key` only. It returns max 5000 issues. - */ - maxResults?: number; - /** - * A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a - * comma-separated list. Expand options include: - * - * `*all` Returns all fields. `*navigable` Returns navigable fields. `id` Returns only issue IDs. Any issue field, - * prefixed with a minus to exclude. - * - * The default is `id`. - * - * Examples: - * - * `summary,comment` Returns only the summary and comments fields only. `-description` Returns all navigable - * (default) fields except description. `*all,-comment` Returns all fields except comments. - * - * Multiple `fields` parameters can be included in a request. - * - * Note: By default, this resource returns IDs only. This differs from [GET issue](#api-rest-api-2-issue-issueIdOrKey-get) where the default is all fields. - */ - fields?: string[]; - /** - * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#expansion) to include additional - * information about issues in the response. Note that, unlike the majority of instances where `expand` is - * specified, `expand` is defined as a comma-delimited string of values. The expand options are: - * - * `renderedFields` Returns field values rendered in HTML format. `names` Returns the display name of each field. - * `schema` Returns the schema describing a field type. `transitions` Returns all possible transitions for the - * issue. `operations` Returns all possible operations for the issue. `editmeta` Returns information about how each - * field can be edited. `changelog` Returns a list of recent updates to an issue, sorted by date, starting from the - * most recent. `versionedRepresentations` Instead of `fields`, returns `versionedRepresentations` a JSON array - * containing each version of a field's value, with the highest numbered item representing the most recent version. - * - * Examples: `"names,changelog"` Returns the display name of each field as well as a list of recent updates to an issue. - */ - expand?: string; - /** A list of up to 5 issue properties to include in the results. This parameter accepts a comma-separated list. */ - properties?: string[]; - /** Reference fields by their key (rather than ID). The default is `false`. */ - fieldsByKeys?: boolean; - /** Fail this request early if we can't retrieve all field data. */ - failFast?: boolean; - /** Strong consistency issue ids to be reconciled with search results. Accepts max 50 ids. All issues must exist. */ - reconcileIssues?: number[]; -} diff --git a/src/version2/parameters/searchAndReconsileIssuesUsingJqlPost.ts b/src/version2/parameters/searchAndReconsileIssuesUsingJqlPost.ts deleted file mode 100644 index f839145d6..000000000 --- a/src/version2/parameters/searchAndReconsileIssuesUsingJqlPost.ts +++ /dev/null @@ -1,3 +0,0 @@ -import { SearchAndReconcileRequestBean } from '../models'; - -export interface SearchAndReconsileIssuesUsingJqlPost extends SearchAndReconcileRequestBean {} diff --git a/src/version2/parameters/searchForIssuesIds.ts b/src/version2/parameters/searchForIssuesIds.ts index 9127fa13c..3c6179bc0 100644 --- a/src/version2/parameters/searchForIssuesIds.ts +++ b/src/version2/parameters/searchForIssuesIds.ts @@ -1,3 +1,3 @@ -import { IdSearchRequestBean } from '../models'; +import { IdSearchRequest } from '../models'; -export interface SearchForIssuesIds extends IdSearchRequestBean {} +export interface SearchForIssuesIds extends IdSearchRequest {} diff --git a/src/version2/parameters/searchForIssuesUsingJql.ts b/src/version2/parameters/searchForIssuesUsingJql.ts index bb85f45ae..8e1a025a0 100644 --- a/src/version2/parameters/searchForIssuesUsingJql.ts +++ b/src/version2/parameters/searchForIssuesUsingJql.ts @@ -76,4 +76,10 @@ export interface SearchForIssuesUsingJql { properties?: string[]; /** Reference fields by their key (rather than ID). */ fieldsByKeys?: boolean; + /** + * Whether to fail the request quickly in case of an error while loading fields for an issue. For `failFast=true`, if + * one field fails, the entire operation fails. For `failFast=false`, the operation will continue even if a field + * fails. It will return a valid response, but without values for the failed field(s). + */ + failFast?: boolean; } diff --git a/src/version2/parameters/searchPriorities.ts b/src/version2/parameters/searchPriorities.ts index 8e1dae180..7ad7be970 100644 --- a/src/version2/parameters/searchPriorities.ts +++ b/src/version2/parameters/searchPriorities.ts @@ -10,6 +10,13 @@ export interface SearchPriorities { * `projectId=10010&projectId=10111`. */ projectId?: string[]; + /** The name of priority to search for. */ + priorityName?: string; /** Whether only the default priority is returned. */ onlyDefault?: boolean; + /** + * Use `schemes` to return the associated priority schemes for each priority. Limited to returning first 15 priority + * schemes per priority. + */ + expand?: 'schemes' | string; } diff --git a/src/version2/parameters/searchProjectsUsingSecuritySchemes.ts b/src/version2/parameters/searchProjectsUsingSecuritySchemes.ts index 6e2ee0702..ba08b5778 100644 --- a/src/version2/parameters/searchProjectsUsingSecuritySchemes.ts +++ b/src/version2/parameters/searchProjectsUsingSecuritySchemes.ts @@ -1,8 +1,8 @@ export interface SearchProjectsUsingSecuritySchemes { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** The list of security scheme IDs to be filtered out. */ issueSecuritySchemeId?: string[]; /** The list of project IDs to be filtered out. */ diff --git a/src/version2/parameters/searchSecuritySchemes.ts b/src/version2/parameters/searchSecuritySchemes.ts index 21e4af570..150e06463 100644 --- a/src/version2/parameters/searchSecuritySchemes.ts +++ b/src/version2/parameters/searchSecuritySchemes.ts @@ -1,8 +1,8 @@ export interface SearchSecuritySchemes { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** * The list of issue security scheme IDs. To include multiple issue security scheme IDs, separate IDs with an * ampersand: `id=10000&id=10001`. diff --git a/src/version2/parameters/suggestedPrioritiesForMappings.ts b/src/version2/parameters/suggestedPrioritiesForMappings.ts index d24049c5c..ed706bf98 100644 --- a/src/version2/parameters/suggestedPrioritiesForMappings.ts +++ b/src/version2/parameters/suggestedPrioritiesForMappings.ts @@ -1,3 +1,3 @@ -import { SuggestedMappingsRequestBean } from '../models'; +import { SuggestedMappingsRequest } from '../models'; -export interface SuggestedPrioritiesForMappings extends SuggestedMappingsRequestBean {} +export interface SuggestedPrioritiesForMappings extends SuggestedMappingsRequest {} diff --git a/src/version2/parameters/updateDashboard.ts b/src/version2/parameters/updateDashboard.ts index 3b01c0c2d..7144648aa 100644 --- a/src/version2/parameters/updateDashboard.ts +++ b/src/version2/parameters/updateDashboard.ts @@ -3,4 +3,9 @@ import { DashboardDetails } from '../models'; export interface UpdateDashboard extends DashboardDetails { /** The ID of the dashboard to update. */ id: string; + /** + * Whether admin level permissions are used. It should only be true if the user has _Administer Jira_ [global + * permission](https://confluence.atlassian.com/x/x4dKLg) + */ + extendAdminPermissions?: boolean; } diff --git a/src/version2/parameters/updateDefaultProjectClassification.ts b/src/version2/parameters/updateDefaultProjectClassification.ts index dc4ae8e91..01b6cb1eb 100644 --- a/src/version2/parameters/updateDefaultProjectClassification.ts +++ b/src/version2/parameters/updateDefaultProjectClassification.ts @@ -1,6 +1,6 @@ -import { UpdateDefaultProjectClassificationBean } from '../models'; +import { UpdateDefaultProjectClassification as UpdateDefaultProjectClassificationModel } from '../models'; -export interface UpdateDefaultProjectClassification extends UpdateDefaultProjectClassificationBean { +export interface UpdateDefaultProjectClassification extends UpdateDefaultProjectClassificationModel { /** The project ID or project key (case-sensitive). */ projectIdOrKey: string; } diff --git a/src/version2/parameters/updatePrecomputations.ts b/src/version2/parameters/updatePrecomputations.ts index ecf83b9aa..737190038 100644 --- a/src/version2/parameters/updatePrecomputations.ts +++ b/src/version2/parameters/updatePrecomputations.ts @@ -1,3 +1,5 @@ import { JqlFunctionPrecomputationUpdateRequest } from '../models'; -export interface UpdatePrecomputations extends JqlFunctionPrecomputationUpdateRequest {} +export interface UpdatePrecomputations extends JqlFunctionPrecomputationUpdateRequest { + skipNotFoundPrecomputations?: boolean; +} diff --git a/src/version2/parameters/updatePriorityScheme.ts b/src/version2/parameters/updatePriorityScheme.ts index a43e200c2..bbd7a2f66 100644 --- a/src/version2/parameters/updatePriorityScheme.ts +++ b/src/version2/parameters/updatePriorityScheme.ts @@ -1,6 +1,6 @@ -import { UpdatePrioritySchemeRequestBean } from '../models'; +import { UpdatePrioritySchemeRequest } from '../models'; -export interface UpdatePriorityScheme extends UpdatePrioritySchemeRequestBean { +export interface UpdatePriorityScheme extends UpdatePrioritySchemeRequest { /** The ID of the priority scheme. */ schemeId: number; } diff --git a/src/version2/permissionSchemes.ts b/src/version2/permissionSchemes.ts index 23d978d49..b81c1d514 100644 --- a/src/version2/permissionSchemes.ts +++ b/src/version2/permissionSchemes.ts @@ -274,7 +274,10 @@ export class PermissionSchemes { params: { expand: parameters?.expand, }, - data: parameters?.body, + data: { + ...parameters, + expand: undefined, + }, }; return this.client.sendRequest(config, callback); @@ -367,7 +370,11 @@ export class PermissionSchemes { params: { expand: parameters.expand, }, - data: parameters.body, + data: { + ...parameters, + schemeId: undefined, + expand: undefined, + }, }; return this.client.sendRequest(config, callback); diff --git a/src/version2/prioritySchemes.ts b/src/version2/prioritySchemes.ts index 643bdf5ee..a36cbcfe9 100644 --- a/src/version2/prioritySchemes.ts +++ b/src/version2/prioritySchemes.ts @@ -3,6 +3,8 @@ import * as Parameters from './parameters'; import { Client } from '../clients'; import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; +import { paramSerializer } from '../paramSerializer'; +import { Paginated } from '../paginated'; export class PrioritySchemes { constructor(private client: Client) {} @@ -13,7 +15,7 @@ export class PrioritySchemes { * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** * Permission to access Jira. */ - async getPrioritySchemes( + async getPrioritySchemes>( parameters: Parameters.GetPrioritySchemes | undefined, callback: Callback, ): Promise; @@ -24,11 +26,11 @@ export class PrioritySchemes { * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** * Permission to access Jira. */ - async getPrioritySchemes( + async getPrioritySchemes>( parameters?: Parameters.GetPrioritySchemes, callback?: never, ): Promise; - async getPrioritySchemes( + async getPrioritySchemes>( parameters?: Parameters.GetPrioritySchemes, callback?: Callback, ): Promise { @@ -38,8 +40,8 @@ export class PrioritySchemes { params: { startAt: parameters?.startAt, maxResults: parameters?.maxResults, - priorityId: parameters?.priorityId, - schemeId: parameters?.schemeId, + priorityId: paramSerializer('priorityId', parameters?.priorityId), + schemeId: paramSerializer('schemeId', parameters?.schemeId), schemeName: parameters?.schemeName, onlyDefault: parameters?.onlyDefault, orderBy: parameters?.orderBy, @@ -56,7 +58,7 @@ export class PrioritySchemes { * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async createPriorityScheme( - parameters: Parameters.CreatePriorityScheme | undefined, + parameters: Parameters.CreatePriorityScheme, callback: Callback, ): Promise; /** @@ -66,23 +68,23 @@ export class PrioritySchemes { * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ async createPriorityScheme( - parameters?: Parameters.CreatePriorityScheme, + parameters: Parameters.CreatePriorityScheme, callback?: never, ): Promise; async createPriorityScheme( - parameters?: Parameters.CreatePriorityScheme, + parameters: Parameters.CreatePriorityScheme, callback?: Callback, ): Promise { const config: RequestConfig = { url: '/rest/api/2/priorityscheme', method: 'POST', data: { - defaultPriorityId: parameters?.defaultPriorityId, - description: parameters?.description, - mappings: parameters?.mappings, - name: parameters?.name, - priorityIds: parameters?.priorityIds, - projectIds: parameters?.projectIds, + defaultPriorityId: parameters.defaultPriorityId, + description: parameters.description, + mappings: parameters.mappings, + name: parameters.name, + priorityIds: parameters.priorityIds, + projectIds: parameters.projectIds, }, }; @@ -95,7 +97,7 @@ export class PrioritySchemes { * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** * Permission to access Jira. */ - async suggestedPrioritiesForMappings( + async suggestedPrioritiesForMappings>( parameters: Parameters.SuggestedPrioritiesForMappings | undefined, callback: Callback, ): Promise; @@ -106,11 +108,11 @@ export class PrioritySchemes { * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** * Permission to access Jira. */ - async suggestedPrioritiesForMappings( + async suggestedPrioritiesForMappings>( parameters?: Parameters.SuggestedPrioritiesForMappings, callback?: never, ): Promise; - async suggestedPrioritiesForMappings( + async suggestedPrioritiesForMappings>( parameters?: Parameters.SuggestedPrioritiesForMappings, callback?: Callback, ): Promise { @@ -135,7 +137,7 @@ export class PrioritySchemes { * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** * Permission to access Jira. */ - async getAvailablePrioritiesByPriorityScheme( + async getAvailablePrioritiesByPriorityScheme>( parameters: Parameters.GetAvailablePrioritiesByPriorityScheme, callback: Callback, ): Promise; @@ -146,11 +148,11 @@ export class PrioritySchemes { * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** * Permission to access Jira. */ - async getAvailablePrioritiesByPriorityScheme( + async getAvailablePrioritiesByPriorityScheme>( parameters: Parameters.GetAvailablePrioritiesByPriorityScheme, callback?: never, ): Promise; - async getAvailablePrioritiesByPriorityScheme( + async getAvailablePrioritiesByPriorityScheme>( parameters: Parameters.GetAvailablePrioritiesByPriorityScheme, callback?: Callback, ): Promise { @@ -248,7 +250,7 @@ export class PrioritySchemes { * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** * Permission to access Jira. */ - async getPrioritiesByPriorityScheme( + async getPrioritiesByPriorityScheme>( parameters: Parameters.GetPrioritiesByPriorityScheme, callback: Callback, ): Promise; @@ -259,11 +261,11 @@ export class PrioritySchemes { * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** * Permission to access Jira. */ - async getPrioritiesByPriorityScheme( + async getPrioritiesByPriorityScheme>( parameters: Parameters.GetPrioritiesByPriorityScheme, callback?: never, ): Promise; - async getPrioritiesByPriorityScheme( + async getPrioritiesByPriorityScheme>( parameters: Parameters.GetPrioritiesByPriorityScheme, callback?: Callback, ): Promise { @@ -310,7 +312,7 @@ export class PrioritySchemes { params: { startAt: parameters.startAt, maxResults: parameters.maxResults, - projectId: parameters.projectId, + projectId: paramSerializer('projectId', parameters.projectId), query: parameters.query, }, }; diff --git a/src/version2/projectClassificationLevels.ts b/src/version2/projectClassificationLevels.ts index 1b2fb798c..0083f8d19 100644 --- a/src/version2/projectClassificationLevels.ts +++ b/src/version2/projectClassificationLevels.ts @@ -1,4 +1,3 @@ -import * as Models from './models'; import * as Parameters from './parameters'; import { Client } from '../clients'; import { Callback } from '../callback'; diff --git a/src/version2/projectComponents.ts b/src/version2/projectComponents.ts index 6aac6dad1..6fade9f35 100644 --- a/src/version2/projectComponents.ts +++ b/src/version2/projectComponents.ts @@ -3,6 +3,7 @@ import * as Parameters from './parameters'; import { Client } from '../clients'; import { Callback } from '../callback'; import { RequestConfig } from '../requestConfig'; +import { Paginated } from '../paginated'; export class ProjectComponents { constructor(private client: Client) {} @@ -15,7 +16,7 @@ export class ProjectComponents { * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** _Browse * Projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. */ - async findComponentsForProjects( + async findComponentsForProjects>( parameters: Parameters.FindComponentsForProjects | undefined, callback: Callback, ): Promise; @@ -28,11 +29,11 @@ export class ProjectComponents { * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** _Browse * Projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. */ - async findComponentsForProjects( + async findComponentsForProjects>( parameters?: Parameters.FindComponentsForProjects, callback?: never, ): Promise; - async findComponentsForProjects( + async findComponentsForProjects>( parameters?: Parameters.FindComponentsForProjects, callback?: Callback, ): Promise { @@ -174,7 +175,14 @@ export class ProjectComponents { const config: RequestConfig = { url: `/rest/api/2/component/${parameters.id}`, method: 'PUT', - data: parameters.body, + data: { + name: parameters.name, + description: parameters.description, + leadUserName: parameters.leadUserName, + leadAccountId: parameters.leadAccountId, + assigneeType: parameters.assigneeType, + project: parameters.project, + }, }; return this.client.sendRequest(config, callback); diff --git a/src/version2/projectKeyAndNameValidation.ts b/src/version2/projectKeyAndNameValidation.ts index 96a0f9134..6b08bb39b 100644 --- a/src/version2/projectKeyAndNameValidation.ts +++ b/src/version2/projectKeyAndNameValidation.ts @@ -47,7 +47,7 @@ export class ProjectKeyAndNameValidation { * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** None. */ - async getValidProjectKey( + async getValidProjectKey( parameters: Parameters.GetValidProjectKey | string | undefined, callback: Callback, ): Promise; @@ -56,11 +56,11 @@ export class ProjectKeyAndNameValidation { * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** None. */ - async getValidProjectKey( + async getValidProjectKey( parameters?: Parameters.GetValidProjectKey | string, callback?: never, ): Promise; - async getValidProjectKey( + async getValidProjectKey( parameters?: Parameters.GetValidProjectKey | string, callback?: Callback, ): Promise { diff --git a/src/version2/projectVersions.ts b/src/version2/projectVersions.ts index 60532214c..8a5f97297 100644 --- a/src/version2/projectVersions.ts +++ b/src/version2/projectVersions.ts @@ -137,7 +137,6 @@ export class ProjectVersions { name: parameters?.name, operations: parameters?.operations, overdue: parameters?.overdue, - project: parameters?.project, projectId: parameters?.projectId, releaseDate: parameters?.releaseDate, released: parameters?.released, @@ -206,7 +205,19 @@ export class ProjectVersions { const config: RequestConfig = { url: `/rest/api/2/version/${parameters.id}`, method: 'PUT', - data: parameters.body, + data: { + approvers: parameters.approvers, + driver: parameters.driver, + expand: parameters.expand, + description: parameters.description, + name: parameters.name, + archived: parameters.archived, + released: parameters.released, + startDate: parameters.startDate, + releaseDate: parameters.releaseDate, + projectId: parameters.projectId, + moveUnfixedIssuesTo: parameters.moveUnfixedIssuesTo, + }, }; return this.client.sendRequest(config, callback); diff --git a/src/version2/projects.ts b/src/version2/projects.ts index acc991379..c149da858 100644 --- a/src/version2/projects.ts +++ b/src/version2/projects.ts @@ -118,7 +118,6 @@ export class Projects { issueTypeScheme: parameters?.issueTypeScheme, issueTypeScreenScheme: parameters?.issueTypeScreenScheme, key: parameters?.key, - lead: parameters?.lead, leadAccountId: parameters?.leadAccountId, name: parameters?.name, notificationScheme: parameters?.notificationScheme, @@ -301,7 +300,6 @@ export class Projects { description: parameters.description, issueSecurityScheme: parameters.issueSecurityScheme, key: parameters.key, - lead: parameters.lead, leadAccountId: parameters.leadAccountId, name: parameters.name, notificationScheme: parameters.notificationScheme, diff --git a/src/version2/status.ts b/src/version2/status.ts index ed8652323..abeba72f2 100644 --- a/src/version2/status.ts +++ b/src/version2/status.ts @@ -155,7 +155,7 @@ export class Status { } /** - * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of + * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#pagination) list of * statuses that match a search on name or project. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** @@ -168,7 +168,7 @@ export class Status { callback: Callback, ): Promise; /** - * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) list of + * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#pagination) list of * statuses that match a search on name or project. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** diff --git a/src/version2/workflowSchemes.ts b/src/version2/workflowSchemes.ts index b4aa75124..edee135db 100644 --- a/src/version2/workflowSchemes.ts +++ b/src/version2/workflowSchemes.ts @@ -164,14 +164,14 @@ export class WorkflowSchemes { url: '/rest/api/2/workflowscheme/update', method: 'POST', data: { - defaultWorkflowId: parameters?.defaultWorkflowId, - description: parameters?.description, - id: parameters?.id, - name: parameters?.name, - statusMappingsByIssueTypeOverride: parameters?.statusMappingsByIssueTypeOverride, - statusMappingsByWorkflows: parameters?.statusMappingsByWorkflows, - version: parameters?.version, - workflowsForIssueTypes: parameters?.workflowsForIssueTypes, + defaultWorkflowId: parameters.defaultWorkflowId, + description: parameters.description, + id: parameters.id, + name: parameters.name, + statusMappingsByIssueTypeOverride: parameters.statusMappingsByIssueTypeOverride, + statusMappingsByWorkflows: parameters.statusMappingsByWorkflows, + version: parameters.version, + workflowsForIssueTypes: parameters.workflowsForIssueTypes, }, }; @@ -214,9 +214,9 @@ export class WorkflowSchemes { url: '/rest/api/2/workflowscheme/update/mappings', method: 'POST', data: { - defaultWorkflowId: parameters?.defaultWorkflowId, - id: parameters?.id, - workflowsForIssueTypes: parameters?.workflowsForIssueTypes, + defaultWorkflowId: parameters.defaultWorkflowId, + id: parameters.id, + workflowsForIssueTypes: parameters.workflowsForIssueTypes, }, }; diff --git a/src/version2/workflowTransitionRules.ts b/src/version2/workflowTransitionRules.ts index efda85c0b..85874662e 100644 --- a/src/version2/workflowTransitionRules.ts +++ b/src/version2/workflowTransitionRules.ts @@ -92,7 +92,7 @@ export class WorkflowTransitionRules { * * - Disable a rule. * - Add a `tag`. Use this to filter rules in the [Get workflow transition rule - * configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules/#api-rest-api-3-workflow-rule-config-get). + * configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-workflow-transition-rules/#api-rest-api-2-workflow-rule-config-get). * * Rules are enabled if the `disabled` parameter is not provided. * @@ -119,7 +119,7 @@ export class WorkflowTransitionRules { * * - Disable a rule. * - Add a `tag`. Use this to filter rules in the [Get workflow transition rule - * configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-rules/#api-rest-api-3-workflow-rule-config-get). + * configurations](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-workflow-transition-rules/#api-rest-api-2-workflow-rule-config-get). * * Rules are enabled if the `disabled` parameter is not provided. * diff --git a/src/version2/workflows.ts b/src/version2/workflows.ts index 73c043b11..20b0c9c92 100644 --- a/src/version2/workflows.ts +++ b/src/version2/workflows.ts @@ -12,7 +12,7 @@ export class Workflows { * Creates a workflow. You can define transition rules using the shapes detailed in the following sections. If no * transitional rules are specified the default system transition rules are used. Note: This only applies to * company-managed scoped workflows. Use [bulk create - * workflows](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/#api-rest-api-3-workflows-create-post) + * workflows](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-workflows/#api-rest-api-2-workflows-create-post) * to create both team and company-managed scoped workflows. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** @@ -26,7 +26,7 @@ export class Workflows { * Creates a workflow. You can define transition rules using the shapes detailed in the following sections. If no * transitional rules are specified the default system transition rules are used. Note: This only applies to * company-managed scoped workflows. Use [bulk create - * workflows](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows/#api-rest-api-3-workflows-create-post) + * workflows](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-workflows/#api-rest-api-2-workflows-create-post) * to create both team and company-managed scoped workflows. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** @@ -259,7 +259,6 @@ export class Workflows { url: '/rest/api/2/workflows', method: 'POST', params: { - expand: parameters.expand, useTransitionLinksFormat: parameters.useTransitionLinksFormat, useApprovalConfiguration: parameters.useApprovalConfiguration, }, diff --git a/src/version3/models/index.ts b/src/version3/models/index.ts index 25a6121df..3cfce66b3 100644 --- a/src/version3/models/index.ts +++ b/src/version3/models/index.ts @@ -1,72 +1,3 @@ -export * from './workflowSchemeProjectUsage'; -export * from './updateDefaultProjectClassification'; -export * from './workflowUpdateRequest'; -export * from './mappingsByIssueTypeOverride'; -export * from './createCrossProjectReleaseRequest'; -export * from './validationOptionsForCreate'; -export * from './createCustomFieldRequest'; -export * from './createExclusionRulesRequest'; -export * from './createIssueSourceRequest'; -export * from './createPermissionRequest'; -export * from './createSchedulingRequest'; -export * from './priorityMapping'; -export * from './getPlanOnlyTeamResponse'; -export * from './getAtlassianTeamResponse'; -export * from './pageWithCursorGetTeamResponseForPage'; -export * from './serviceRegistry'; -export * from './updatePrioritySchemeRequest'; -export * from './updatePrioritySchemeResponse'; -export * from './suggestedMappingsRequest'; -export * from './priorityWithSequence'; -export * from './prioritySchemeWithPaginatedPrioritiesAndProjects'; -export * from './prioritySchemeId'; -export * from './plan'; -export * from './pageWithCursorGetPlanResponseForPage'; -export * from './versionRelatedWork'; -export * from './component'; -export * from './worklogsMoveRequest'; -export * from './searchAndReconcileResults'; -export * from './projectAndIssueTypePair'; -export * from './idSearchRequest'; -export * from './idSearchResults'; -export * from './jqlCountRequest'; -export * from './jqlCount'; -export * from './pageOfCreateMetaIssueTypeWithField'; -export * from './issueLimitReport'; -export * from './pageOfCreateMetaIssueTypes'; -export * from './bulkIssue'; -export * from './bulkChangelogRequest'; -export * from './bulkChangelog'; -export * from './workflowUpdateValidateRequest'; -export * from './workflowUpdate'; -export * from './workflowValidationErrorList'; -export * from './workflowCreateRequest'; -export * from './workflowCreate'; -export * from './workflowCapabilities'; -export * from './workflowRead'; -export * from './jqlFunctionPrecomputationGetByIdRequest'; -export * from './jqlFunctionPrecomputationGetByIdResponse'; -export * from './bulkOperationProgress'; -export * from './issueBulkTransitionPayload'; -export * from './bulkTransitionGetAvailableTransitions'; -export * from './issueBulkMovePayload'; -export * from './issueBulkEditPayload'; -export * from './bulkEditGetFields'; -export * from './issueBulkDeletePayload'; -export * from './submittedBulkOperation'; -export * from './dataClassificationLevels'; -export * from './workflowSchemeUpdateRequiredMappingsResponse'; -export * from './workflowSchemeReadRequest'; -export * from './mappingsByWorkflow'; -export * from './documentVersion'; -export * from './workflowSchemeAssociation'; -export * from './workflowSchemeReadResponse'; -export * from './jiraExpressionEvaluateContext'; -export * from './evaluatedJiraExpression'; -export * from './configurationsListParameters'; -export * from './pageBulkContextualConfiguration'; -export * from './workspaceDataPolicy'; -export * from './projectDataPolicies'; export * from './actorInput'; export * from './actorsMap'; export * from './addField'; @@ -97,17 +28,23 @@ export * from './avatar'; export * from './avatars'; export * from './avatarUrls'; export * from './avatarWithDetails'; +export * from './bulkChangelog'; +export * from './bulkChangelogRequest'; export * from './bulkChangeOwnerDetails'; export * from './bulkCustomFieldOptionCreateRequest'; export * from './bulkCustomFieldOptionUpdateRequest'; +export * from './bulkEditGetFields'; export * from './bulkEditShareableEntity'; +export * from './bulkIssue'; export * from './bulkIssueIsWatching'; export * from './bulkIssuePropertyUpdateRequest'; export * from './bulkOperationErrorResult'; +export * from './bulkOperationProgress'; export * from './bulkPermissionGrants'; export * from './bulkPermissionsRequest'; export * from './bulkProjectPermissionGrants'; export * from './bulkProjectPermissions'; +export * from './bulkTransitionGetAvailableTransitions'; export * from './changeDetails'; export * from './changedValue'; export * from './changedWorklog'; @@ -115,9 +52,11 @@ export * from './changedWorklogs'; export * from './changelog'; export * from './columnItem'; export * from './comment'; +export * from './component'; export * from './componentIssuesCount'; export * from './componentWithIssueCount'; export * from './configuration'; +export * from './configurationsListParameters'; export * from './connectCustomFieldValue'; export * from './connectCustomFieldValues'; export * from './connectModule'; @@ -130,14 +69,20 @@ export * from './containerOfWorkflowSchemeAssociations'; export * from './contextForProjectAndIssueType'; export * from './contextualConfiguration'; export * from './convertedJQLQueries'; +export * from './createCrossProjectReleaseRequest'; export * from './createCustomFieldContext'; +export * from './createCustomFieldRequest'; export * from './createdIssue'; export * from './createdIssues'; +export * from './createExclusionRulesRequest'; export * from './createIssueSecuritySchemeDetails'; +export * from './createIssueSourceRequest'; export * from './createNotificationSchemeDetails'; +export * from './createPermissionRequest'; export * from './createPriorityDetails'; export * from './createProjectDetails'; export * from './createResolutionDetails'; +export * from './createSchedulingRequest'; export * from './createUiModificationDetails'; export * from './createUpdateRoleRequest'; export * from './createWorkflowCondition'; @@ -172,18 +117,21 @@ export * from './dashboardGadgetResponse'; export * from './dashboardGadgetSettings'; export * from './dashboardGadgetUpdateRequest'; export * from './dashboardUser'; +export * from './dataClassificationLevels'; export * from './dateRangeFilter'; export * from './defaultLevelValue'; export * from './defaultShareScope'; export * from './defaultWorkflow'; export * from './deleteAndReplaceVersion'; export * from './document'; +export * from './documentVersion'; export * from './enhancedSearchRequest'; export * from './entityProperty'; export * from './entityPropertyDetails'; export * from './error'; export * from './errorCollection'; export * from './errors'; +export * from './evaluatedJiraExpression'; export * from './eventNotification'; export * from './exportArchivedIssuesTaskProgress'; export * from './failedWebhook'; @@ -212,6 +160,8 @@ export * from './foundGroups'; export * from './foundUsers'; export * from './foundUsersAndGroups'; export * from './functionReferenceData'; +export * from './getAtlassianTeamResponse'; +export * from './getPlanOnlyTeamResponse'; export * from './globalScope'; export * from './group'; export * from './groupDetails'; @@ -224,10 +174,16 @@ export * from './historyMetadataParticipant'; export * from './icon'; export * from './id'; export * from './idOrKey'; +export * from './idSearchRequest'; +export * from './idSearchResults'; export * from './includedFields'; export * from './issue'; export * from './issueArchivalSync'; export * from './issueArchivalSyncRequest'; +export * from './issueBulkDeletePayload'; +export * from './issueBulkEditPayload'; +export * from './issueBulkMovePayload'; +export * from './issueBulkTransitionPayload'; export * from './issueChangelogIds'; export * from './issueCommentListRequest'; export * from './issueContextVariable'; @@ -241,6 +197,7 @@ export * from './issueFieldOptionCreate'; export * from './issueFieldOptionScope'; export * from './issueFilterForBulkPropertyDelete'; export * from './issueFilterForBulkPropertySet'; +export * from './issueLimitReport'; export * from './issueLink'; export * from './issueLinkType'; export * from './issueLinkTypes'; @@ -291,13 +248,13 @@ export * from './jExpEvaluateIssuesJqlMetaData'; export * from './jExpEvaluateIssuesMeta'; export * from './jExpEvaluateJiraExpressionResult'; export * from './jExpEvaluateMetaData'; -export * from './jiraExpressionEvaluateContext'; export * from './jexpIssues'; export * from './jexpJqlIssues'; export * from './jiraExpressionAnalysis'; export * from './jiraExpressionComplexity'; export * from './jiraExpressionEvalContext'; export * from './jiraExpressionEvalRequest'; +export * from './jiraExpressionEvaluateContext'; export * from './jiraExpressionEvaluationMetaData'; export * from './jiraExpressionEvalUsingEnhancedSearchRequest'; export * from './jiraExpressionForAnalysis'; @@ -307,7 +264,11 @@ export * from './jiraExpressionsComplexity'; export * from './jiraExpressionsComplexityValue'; export * from './jiraExpressionValidationError'; export * from './jiraStatus'; +export * from './jqlCount'; +export * from './jqlCountRequest'; export * from './jqlFunctionPrecomputation'; +export * from './jqlFunctionPrecomputationGetByIdRequest'; +export * from './jqlFunctionPrecomputationGetByIdResponse'; export * from './jqlFunctionPrecomputationUpdate'; export * from './jqlFunctionPrecomputationUpdateRequest'; export * from './jQLPersonalDataMigrationRequest'; @@ -333,6 +294,8 @@ export * from './linkIssueRequestJson'; export * from './listWrapperCallbackApplicationRole'; export * from './listWrapperCallbackGroupName'; export * from './locale'; +export * from './mappingsByIssueTypeOverride'; +export * from './mappingsByWorkflow'; export * from './mark'; export * from './moveField'; export * from './multiIssueEntityProperties'; @@ -358,6 +321,7 @@ export * from './operations'; export * from './orderOfCustomFieldOptions'; export * from './orderOfIssueTypes'; export * from './pageBeanFieldConfigurationDetails'; +export * from './pageBulkContextualConfiguration'; export * from './pageChangelog'; export * from './pageComment'; export * from './pageComponentWithIssueCount'; @@ -390,6 +354,8 @@ export * from './pageJqlFunctionPrecomputation'; export * from './pageNotificationScheme'; export * from './pageOfChangelogs'; export * from './pageOfComments'; +export * from './pageOfCreateMetaIssueTypes'; +export * from './pageOfCreateMetaIssueTypeWithField'; export * from './pageOfDashboards'; export * from './pageOfStatuses'; export * from './pageOfWorklogs'; @@ -410,6 +376,8 @@ export * from './pageUserDetails'; export * from './pageUserKey'; export * from './pageVersion'; export * from './pageWebhook'; +export * from './pageWithCursorGetPlanResponseForPage'; +export * from './pageWithCursorGetTeamResponseForPage'; export * from './pageWorkflow'; export * from './pageWorkflowScheme'; export * from './pageWorkflowTransitionRules'; @@ -424,12 +392,19 @@ export * from './permissionScheme'; export * from './permissionSchemes'; export * from './permissionsKeys'; export * from './permittedProjects'; +export * from './plan'; export * from './priority'; export * from './priorityId'; +export * from './priorityMapping'; +export * from './prioritySchemeId'; +export * from './prioritySchemeWithPaginatedPrioritiesAndProjects'; +export * from './priorityWithSequence'; export * from './project'; +export * from './projectAndIssueTypePair'; export * from './projectAvatars'; export * from './projectCategory'; export * from './projectComponent'; +export * from './projectDataPolicies'; export * from './projectDetails'; export * from './projectEmailAddress'; export * from './projectFeature'; @@ -486,6 +461,7 @@ export * from './screenSchemeId'; export * from './screenTypes'; export * from './screenWithTab'; export * from './searchAndReconcileResults'; +export * from './searchAndReconcileResults'; export * from './searchAutoCompleteFilter'; export * from './searchRequest'; export * from './searchResults'; @@ -499,6 +475,7 @@ export * from './securitySchemeMembersRequest'; export * from './securitySchemes'; export * from './securitySchemeWithProjects'; export * from './serverInformation'; +export * from './serviceRegistry'; export * from './setDefaultLevelsRequest'; export * from './setDefaultPriorityRequest'; export * from './setDefaultResolutionRequest'; @@ -515,10 +492,15 @@ export * from './statusCreate'; export * from './statusCreateRequest'; export * from './statusDetails'; export * from './statusMapping'; +export * from './statusProjectIssueTypeUsage'; +export * from './statusProjectUsage'; export * from './statusScope'; export * from './statusUpdate'; export * from './statusUpdateRequest'; +export * from './statusWorkflowUsage'; +export * from './submittedBulkOperation'; export * from './suggestedIssue'; +export * from './suggestedMappingsRequest'; export * from './systemAvatars'; export * from './taskProgressObject'; export * from './taskProgressRemoveOptionFromIssuesResult'; @@ -532,12 +514,15 @@ export * from './uiModificationDetails'; export * from './uiModificationIdentifiers'; export * from './unrestrictedUserEmail'; export * from './updateCustomFieldDetails'; +export * from './updateDefaultProjectClassification'; export * from './updatedProjectCategory'; export * from './updateFieldConfigurationSchemeDetails'; export * from './updateIssueSecurityLevelDetails'; export * from './updateIssueSecuritySchemeRequest'; export * from './updateNotificationSchemeDetails'; export * from './updatePriorityDetails'; +export * from './updatePrioritySchemeRequest'; +export * from './updatePrioritySchemeResponse'; export * from './updateProjectDetails'; export * from './updateResolutionDetails'; export * from './updateScreenDetails'; @@ -553,10 +538,12 @@ export * from './userKey'; export * from './userList'; export * from './userMigration'; export * from './userPickerUser'; +export * from './validationOptionsForCreate'; export * from './version'; export * from './versionIssueCounts'; export * from './versionIssuesStatus'; export * from './versionMove'; +export * from './versionRelatedWork'; export * from './versionUnresolvedIssuesCount'; export * from './versionUsageInCustomField'; export * from './visibility'; @@ -567,16 +554,29 @@ export * from './webhookDetails'; export * from './webhookRegistrationDetails'; export * from './webhooksExpirationDate'; export * from './workflow'; +export * from './workflowCapabilities'; export * from './workflowCondition'; +export * from './workflowCreate'; +export * from './workflowCreateRequest'; export * from './workflowId'; export * from './workflowOperations'; +export * from './workflowProjectIssueTypeUsage'; +export * from './workflowProjectUsage'; +export * from './workflowRead'; export * from './workflowRules'; export * from './workflowRulesSearch'; export * from './workflowRulesSearchDetails'; export * from './workflowScheme'; +export * from './workflowSchemeAssociation'; export * from './workflowSchemeAssociations'; export * from './workflowSchemeIdName'; export * from './workflowSchemeProjectAssociation'; +export * from './workflowSchemeProjectUsage'; +export * from './workflowSchemeReadRequest'; +export * from './workflowSchemeReadResponse'; +export * from './workflowSchemeUpdateRequiredMappingsResponse'; +export * from './workflowSchemeUsage'; +export * from './workflowSearchResponse'; export * from './workflowStatus'; export * from './workflowStatusProperties'; export * from './workflowsWithTransitionRulesDetails'; @@ -588,5 +588,11 @@ export * from './workflowTransitionRulesDetails'; export * from './workflowTransitionRulesUpdate'; export * from './workflowTransitionRulesUpdateErrorDetails'; export * from './workflowTransitionRulesUpdateErrors'; +export * from './workflowUpdate'; +export * from './workflowUpdateRequest'; +export * from './workflowUpdateValidateRequest'; +export * from './workflowValidationErrorList'; export * from './worklog'; export * from './worklogIdsRequest'; +export * from './worklogsMoveRequest'; +export * from './workspaceDataPolicy'; diff --git a/src/version3/models/statusProjectIssueTypeUsage.ts b/src/version3/models/statusProjectIssueTypeUsage.ts new file mode 100644 index 000000000..a6e133af1 --- /dev/null +++ b/src/version3/models/statusProjectIssueTypeUsage.ts @@ -0,0 +1,10 @@ +import { StatusProjectIssueTypeUsagePage } from './statusProjectIssueTypeUsagePage'; + +/** The issue types using this status in a project. */ +export interface StatusProjectIssueTypeUsage { + issueTypes?: StatusProjectIssueTypeUsagePage; + /** The project ID. */ + projectId?: string; + /** The status ID. */ + statusId?: string; +} diff --git a/src/version3/models/statusProjectIssueTypeUsagePage.ts b/src/version3/models/statusProjectIssueTypeUsagePage.ts new file mode 100644 index 000000000..b273c4e6c --- /dev/null +++ b/src/version3/models/statusProjectIssueTypeUsagePage.ts @@ -0,0 +1,9 @@ +import { StatusProjectIssueTypeUsage } from './statusProjectIssueTypeUsage'; + +/** A page of issue types. */ +export interface StatusProjectIssueTypeUsagePage { + /** Page token for the next page of issue type usages. */ + nextPageToken?: string; + /** The list of issue types. */ + values?: StatusProjectIssueTypeUsage[]; +} diff --git a/src/version3/models/statusProjectUsage.ts b/src/version3/models/statusProjectUsage.ts new file mode 100644 index 000000000..c1390878c --- /dev/null +++ b/src/version3/models/statusProjectUsage.ts @@ -0,0 +1,8 @@ +import { StatusProjectUsagePage } from './statusProjectUsagePage'; + +/** The projects using this status. */ +export interface StatusProjectUsage { + projects?: StatusProjectUsagePage; + /** The status ID. */ + statusId?: string; +} diff --git a/src/version3/models/statusProjectUsagePage.ts b/src/version3/models/statusProjectUsagePage.ts new file mode 100644 index 000000000..5a9583f81 --- /dev/null +++ b/src/version3/models/statusProjectUsagePage.ts @@ -0,0 +1,9 @@ +import { StatusProjectUsage } from './statusProjectUsage'; + +/** A page of projects. */ +export interface StatusProjectUsagePage { + /** Page token for the next page of issue type usages. */ + nextPageToken?: string; + /** The list of projects. */ + values?: StatusProjectUsage[]; +} diff --git a/src/version3/models/statusWorkflowUsage.ts b/src/version3/models/statusWorkflowUsage.ts new file mode 100644 index 000000000..53780c802 --- /dev/null +++ b/src/version3/models/statusWorkflowUsage.ts @@ -0,0 +1,8 @@ +import { StatusWorkflowUsagePage } from './statusWorkflowUsagePage'; + +/** Workflows using the status. */ +export interface StatusWorkflowUsage { + /** The status ID. */ + statusId?: string; + workflows?: StatusWorkflowUsagePage; +} diff --git a/src/version3/models/statusWorkflowUsagePage.ts b/src/version3/models/statusWorkflowUsagePage.ts new file mode 100644 index 000000000..6d358d851 --- /dev/null +++ b/src/version3/models/statusWorkflowUsagePage.ts @@ -0,0 +1,9 @@ +import { StatusWorkflowUsageWorkflow } from './statusWorkflowUsageWorkflow'; + +/** A page of workflows. */ +export interface StatusWorkflowUsagePage { + /** Page token for the next page of issue type usages. */ + nextPageToken?: string; + /** The list of statuses. */ + values?: StatusWorkflowUsageWorkflow[]; +} diff --git a/src/version3/models/statusWorkflowUsageWorkflow.ts b/src/version3/models/statusWorkflowUsageWorkflow.ts new file mode 100644 index 000000000..3e860725b --- /dev/null +++ b/src/version3/models/statusWorkflowUsageWorkflow.ts @@ -0,0 +1,5 @@ +/** The worflow. */ +export interface StatusWorkflowUsageWorkflow { + /** The workflow ID. */ + id?: string; +} diff --git a/src/version3/models/workflowProjectIssueTypeUsage.ts b/src/version3/models/workflowProjectIssueTypeUsage.ts new file mode 100644 index 000000000..9545964f0 --- /dev/null +++ b/src/version3/models/workflowProjectIssueTypeUsage.ts @@ -0,0 +1,10 @@ +import { WorkflowProjectIssueTypeUsagePage } from './workflowProjectIssueTypeUsagePage'; + +/** Issue types associated with the workflow for a project. */ +export interface WorkflowProjectIssueTypeUsage { + issueTypes?: WorkflowProjectIssueTypeUsagePage; + /** The ID of the project. */ + projectId?: string; + /** The ID of the workflow. */ + workflowId?: string; +} diff --git a/src/version3/models/workflowProjectIssueTypeUsagePage.ts b/src/version3/models/workflowProjectIssueTypeUsagePage.ts new file mode 100644 index 000000000..33efc451d --- /dev/null +++ b/src/version3/models/workflowProjectIssueTypeUsagePage.ts @@ -0,0 +1,9 @@ +import { WorkflowProjectIssueTypeUsage } from './workflowProjectIssueTypeUsage'; + +/** A page of issue types. */ +export interface WorkflowProjectIssueTypeUsagePage { + /** Token for the next page of issue type usages. */ + nextPageToken?: string; + /** The list of issue types. */ + values?: WorkflowProjectIssueTypeUsage[]; +} diff --git a/src/version3/models/workflowProjectUsage.ts b/src/version3/models/workflowProjectUsage.ts new file mode 100644 index 000000000..6276eb98c --- /dev/null +++ b/src/version3/models/workflowProjectUsage.ts @@ -0,0 +1,8 @@ +import { ProjectUsagePage } from './projectUsagePage'; + +/** Projects using the workflow. */ +export interface WorkflowProjectUsage { + projects?: ProjectUsagePage; + /** The workflow ID. */ + workflowId?: string; +} diff --git a/src/version3/models/workflowSchemeUsage.ts b/src/version3/models/workflowSchemeUsage.ts new file mode 100644 index 000000000..0c2852209 --- /dev/null +++ b/src/version3/models/workflowSchemeUsage.ts @@ -0,0 +1,8 @@ +import { WorkflowSchemeUsagePage } from './workflowSchemeUsagePage'; + +/** Workflow schemes using the workflow. */ +export interface WorkflowSchemeUsage { + /** The workflow ID. */ + workflowId?: string; + workflowSchemes?: WorkflowSchemeUsagePage; +} diff --git a/src/version3/models/workflowSchemeUsagePage.ts b/src/version3/models/workflowSchemeUsagePage.ts new file mode 100644 index 000000000..5b883978f --- /dev/null +++ b/src/version3/models/workflowSchemeUsagePage.ts @@ -0,0 +1,9 @@ +import { WorkflowSchemeUsage } from './workflowSchemeUsage'; + +/** A page of workflow schemes. */ +export interface WorkflowSchemeUsagePage { + /** Token for the next page of issue type usages. */ + nextPageToken?: string; + /** The list of workflow schemes. */ + values?: WorkflowSchemeUsage[]; +} diff --git a/src/version2/models/pageBean2ComponentJsonBean.ts b/src/version3/models/workflowSearchResponse.ts similarity index 55% rename from src/version2/models/pageBean2ComponentJsonBean.ts rename to src/version3/models/workflowSearchResponse.ts index 02483674b..966016a32 100644 --- a/src/version2/models/pageBean2ComponentJsonBean.ts +++ b/src/version3/models/workflowSearchResponse.ts @@ -1,7 +1,8 @@ -import { ComponentJsonBean } from './componentJsonBean'; +import { JiraWorkflowStatus } from './jiraWorkflowStatus'; +import { JiraWorkflow } from './jiraWorkflow'; -/** A page of items. */ -export interface PageBean2ComponentJsonBean { +/** Page of items, including workflows and related statuses. */ +export interface WorkflowSearchResponse { /** Whether this is the last page. */ isLast?: boolean; /** The maximum number of items that could be returned. */ @@ -12,8 +13,10 @@ export interface PageBean2ComponentJsonBean { self?: string; /** The index of the first item returned. */ startAt?: number; + /** List of statuses. */ + statuses?: JiraWorkflowStatus[]; /** The number of items returned. */ total?: number; - /** The list of items. */ - values?: ComponentJsonBean[]; + /** List of workflows. */ + values?: JiraWorkflow[]; } diff --git a/src/version3/parameters/getAvailablePrioritiesByPriorityScheme.ts b/src/version3/parameters/getAvailablePrioritiesByPriorityScheme.ts index e576614d0..da7ba318f 100644 --- a/src/version3/parameters/getAvailablePrioritiesByPriorityScheme.ts +++ b/src/version3/parameters/getAvailablePrioritiesByPriorityScheme.ts @@ -1,8 +1,8 @@ export interface GetAvailablePrioritiesByPriorityScheme { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** The string to query priorities on by name. */ query?: string; /** The priority scheme ID. */ diff --git a/src/version3/parameters/getNotificationSchemeToProjectMappings.ts b/src/version3/parameters/getNotificationSchemeToProjectMappings.ts index 34cfec0e7..bfb504e6e 100644 --- a/src/version3/parameters/getNotificationSchemeToProjectMappings.ts +++ b/src/version3/parameters/getNotificationSchemeToProjectMappings.ts @@ -1,8 +1,8 @@ export interface GetNotificationSchemeToProjectMappings { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** The list of notifications scheme IDs to be filtered out */ notificationSchemeId?: string[]; /** The list of project IDs to be filtered out */ diff --git a/src/version3/parameters/getPrioritiesByPriorityScheme.ts b/src/version3/parameters/getPrioritiesByPriorityScheme.ts index 76d7512d9..6cd7fceda 100644 --- a/src/version3/parameters/getPrioritiesByPriorityScheme.ts +++ b/src/version3/parameters/getPrioritiesByPriorityScheme.ts @@ -1,8 +1,8 @@ export interface GetPrioritiesByPriorityScheme { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** The priority scheme ID. */ schemeId: string; } diff --git a/src/version3/parameters/getPrioritySchemes.ts b/src/version3/parameters/getPrioritySchemes.ts index 0ce9f0840..bb8715103 100644 --- a/src/version3/parameters/getPrioritySchemes.ts +++ b/src/version3/parameters/getPrioritySchemes.ts @@ -1,8 +1,8 @@ export interface GetPrioritySchemes { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** * A set of priority IDs to filter by. To include multiple IDs, provide an ampersand-separated list. For example, * `priorityId=10000&priorityId=10001`. diff --git a/src/version3/parameters/getProjectIssueTypeUsagesForStatus.ts b/src/version3/parameters/getProjectIssueTypeUsagesForStatus.ts new file mode 100644 index 000000000..80deab4e9 --- /dev/null +++ b/src/version3/parameters/getProjectIssueTypeUsagesForStatus.ts @@ -0,0 +1,10 @@ +export interface GetProjectIssueTypeUsagesForStatus { + /** The statusId to fetch issue type usages for */ + statusId: string; + /** The projectId to fetch issue type usages for */ + projectId: string; + /** The cursor for pagination */ + nextPageToken?: string; + /** The maximum number of results to return. Must be an integer between 1 and 200. */ + maxResults?: number; +} diff --git a/src/version3/parameters/getProjectUsagesForStatus.ts b/src/version3/parameters/getProjectUsagesForStatus.ts new file mode 100644 index 000000000..0e8913c90 --- /dev/null +++ b/src/version3/parameters/getProjectUsagesForStatus.ts @@ -0,0 +1,8 @@ +export interface GetProjectUsagesForStatus { + /** The statusId to fetch project usages for */ + statusId: string; + /** The cursor for pagination */ + nextPageToken?: string; + /** The maximum number of results to return. Must be an integer between 1 and 200. */ + maxResults?: number; +} diff --git a/src/version3/parameters/getProjectUsagesForWorkflow.ts b/src/version3/parameters/getProjectUsagesForWorkflow.ts new file mode 100644 index 000000000..e70544f1f --- /dev/null +++ b/src/version3/parameters/getProjectUsagesForWorkflow.ts @@ -0,0 +1,8 @@ +export interface GetProjectUsagesForWorkflow { + /** The workflow ID */ + workflowId: string; + /** The cursor for pagination */ + nextPageToken?: string; + /** The maximum number of results to return. Must be an integer between 1 and 200. */ + maxResults?: number; +} diff --git a/src/version3/parameters/getProjectsByPriorityScheme.ts b/src/version3/parameters/getProjectsByPriorityScheme.ts index 6bbbf10e4..607505f6d 100644 --- a/src/version3/parameters/getProjectsByPriorityScheme.ts +++ b/src/version3/parameters/getProjectsByPriorityScheme.ts @@ -1,8 +1,8 @@ export interface GetProjectsByPriorityScheme { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** The project IDs to filter by. For example, `projectId=10000&projectId=10001`. */ projectId?: number[]; /** The priority scheme ID. */ diff --git a/src/version3/parameters/getSecurityLevelMembers.ts b/src/version3/parameters/getSecurityLevelMembers.ts index ca3cfe5b2..d1ed167d6 100644 --- a/src/version3/parameters/getSecurityLevelMembers.ts +++ b/src/version3/parameters/getSecurityLevelMembers.ts @@ -1,8 +1,8 @@ export interface GetSecurityLevelMembers { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** * The list of issue security level member IDs. To include multiple issue security level members separate IDs with an * ampersand: `id=10000&id=10001`. diff --git a/src/version3/parameters/getSecurityLevels.ts b/src/version3/parameters/getSecurityLevels.ts index 05024f88e..4c49f9375 100644 --- a/src/version3/parameters/getSecurityLevels.ts +++ b/src/version3/parameters/getSecurityLevels.ts @@ -1,8 +1,8 @@ export interface GetSecurityLevels { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** * The list of issue security scheme level IDs. To include multiple issue security levels, separate IDs with an * ampersand: `id=10000&id=10001`. diff --git a/src/version3/parameters/getWorkflowProjectIssueTypeUsages.ts b/src/version3/parameters/getWorkflowProjectIssueTypeUsages.ts new file mode 100644 index 000000000..42ce81e47 --- /dev/null +++ b/src/version3/parameters/getWorkflowProjectIssueTypeUsages.ts @@ -0,0 +1,10 @@ +export interface GetWorkflowProjectIssueTypeUsages { + /** The workflow ID */ + workflowId: string; + /** The project ID */ + projectId: number; + /** The cursor for pagination */ + nextPageToken?: string; + /** The maximum number of results to return. Must be an integer between 1 and 200. */ + maxResults?: number; +} diff --git a/src/version3/parameters/getWorkflowSchemeUsagesForWorkflow.ts b/src/version3/parameters/getWorkflowSchemeUsagesForWorkflow.ts new file mode 100644 index 000000000..dae488d33 --- /dev/null +++ b/src/version3/parameters/getWorkflowSchemeUsagesForWorkflow.ts @@ -0,0 +1,8 @@ +export interface GetWorkflowSchemeUsagesForWorkflow { + /** The workflow ID */ + workflowId: string; + /** The cursor for pagination */ + nextPageToken?: string; + /** The maximum number of results to return. Must be an integer between 1 and 200. */ + maxResults?: number; +} diff --git a/src/version3/parameters/getWorkflowUsagesForStatus.ts b/src/version3/parameters/getWorkflowUsagesForStatus.ts new file mode 100644 index 000000000..cdfb21d97 --- /dev/null +++ b/src/version3/parameters/getWorkflowUsagesForStatus.ts @@ -0,0 +1,8 @@ +export interface GetWorkflowUsagesForStatus { + /** The statusId to fetch workflow usages for */ + statusId: string; + /** The cursor for pagination */ + nextPageToken?: string; + /** The maximum number of results to return. Must be an integer between 1 and 200. */ + maxResults?: number; +} diff --git a/src/version3/parameters/index.ts b/src/version3/parameters/index.ts index 18217f0a0..2661ee7e9 100644 --- a/src/version3/parameters/index.ts +++ b/src/version3/parameters/index.ts @@ -1,73 +1,5 @@ -export * from './getProjectUsagesForWorkflowScheme'; -export * from './deletePlanOnlyTeam'; -export * from './updatePlanOnlyTeam'; -export * from './getPlanOnlyTeam'; -export * from './createPlanOnlyTeam'; -export * from './removeAtlassianTeam'; -export * from './updateAtlassianTeam'; -export * from './getAtlassianTeam'; -export * from './addAtlassianTeam'; -export * from './getTeams'; -export * from './services'; -export * from './removeDefaultProjectClassification'; -export * from './updateDefaultProjectClassification'; -export * from './getDefaultProjectClassification'; -export * from './getProjectsByPriorityScheme'; -export * from './getPrioritiesByPriorityScheme'; -export * from './deletePriorityScheme'; -export * from './updatePriorityScheme'; -export * from './getAvailablePrioritiesByPriorityScheme'; -export * from './suggestedPrioritiesForMappings'; -export * from './createPriorityScheme'; -export * from './getPrioritySchemes'; -export * from './trashPlan'; -export * from './duplicatePlan'; -export * from './archivePlan'; -export * from './updatePlan'; -export * from './getPlan'; -export * from './createPlan'; -export * from './getPlans'; -export * from './deleteRelatedWork'; -export * from './updateRelatedWork'; -export * from './createRelatedWork'; -export * from './getRelatedWork'; -export * from './findComponentsForProjects'; -export * from './bulkMoveWorklogs'; -export * from './bulkDeleteWorklogs'; -export * from './searchAndReconsileIssuesUsingJqlPost'; -export * from './searchForIssuesIds'; -export * from './countIssues'; -export * from './getCreateIssueMetaIssueTypeId'; -export * from './getIssueLimitReport'; -export * from './getCreateIssueMetaIssueTypes'; -export * from './bulkFetchIssues'; -export * from './getBulkChangelogs'; -export * from './validateUpdateWorkflows'; -export * from './updateWorkflows'; -export * from './validateCreateWorkflows'; -export * from './createWorkflows'; -export * from './workflowCapabilities'; -export * from './readWorkflows'; -export * from './getPrecomputationsByID'; -export * from './getBulkOperationProgress'; -export * from './submitBulkTransition'; -export * from './getAvailableTransitions'; -export * from './submitBulkMove'; -export * from './submitBulkEdit'; -export * from './getBulkEditableFields'; -export * from './submitBulkDelete'; -export * from './getAllUserDataClassificationLevels'; -export * from './getResolution'; -export * from './deletePriority'; -export * from './getBulkScreenTabs'; -export * from './getNotificationSchemeForProject'; -export * from './updateWorkflowSchemeMappings'; -export * from './updateSchemes'; -export * from './readWorkflowSchemes'; -export * from './replaceCustomFieldOption'; -export * from './getCustomFieldsConfigurations'; -export * from './getPolicies'; export * from './addActorUsers'; +export * from './addAtlassianTeam'; export * from './addAttachment'; export * from './addComment'; export * from './addFieldToDefaultScreen'; @@ -88,6 +20,7 @@ export * from './analyseExpression'; export * from './appendMappingsForIssueTypeScreenScheme'; export * from './archiveIssues'; export * from './archiveIssuesAsync'; +export * from './archivePlan'; export * from './archiveProject'; export * from './assignFieldConfigurationSchemeToProject'; export * from './assignIssue'; @@ -98,16 +31,20 @@ export * from './assignProjectsToCustomFieldContext'; export * from './assignSchemeToProject'; export * from './associateSchemesToProjects'; export * from './bulkDeleteIssueProperty'; +export * from './bulkDeleteWorklogs'; export * from './bulkEditDashboards'; +export * from './bulkFetchIssues'; export * from './bulkGetGroups'; export * from './bulkGetUsers'; export * from './bulkGetUsersMigration'; +export * from './bulkMoveWorklogs'; export * from './bulkSetIssuePropertiesByIssue'; export * from './bulkSetIssueProperty'; export * from './bulkSetIssuesProperties'; export * from './cancelTask'; export * from './changeFilterOwner'; export * from './copyDashboard'; +export * from './countIssues'; export * from './createComponent'; export * from './createCustomField'; export * from './createCustomFieldContext'; @@ -130,11 +67,15 @@ export * from './createNotificationScheme'; export * from './createOrUpdateRemoteIssueLink'; export * from './createPermissionGrant'; export * from './createPermissionScheme'; +export * from './createPlan'; +export * from './createPlanOnlyTeam'; export * from './createPriority'; +export * from './createPriorityScheme'; export * from './createProject'; export * from './createProjectAvatar'; export * from './createProjectCategory'; export * from './createProjectRole'; +export * from './createRelatedWork'; export * from './createResolution'; export * from './createScreen'; export * from './createScreenScheme'; @@ -143,6 +84,7 @@ export * from './createUiModification'; export * from './createUser'; export * from './createVersion'; export * from './createWorkflow'; +export * from './createWorkflows'; export * from './createWorkflowScheme'; export * from './createWorkflowSchemeDraftFromParent'; export * from './createWorkflowTransitionProperty'; @@ -179,12 +121,16 @@ export * from './deleteIssueTypeScreenScheme'; export * from './deleteNotificationScheme'; export * from './deletePermissionScheme'; export * from './deletePermissionSchemeEntity'; +export * from './deletePlanOnlyTeam'; +export * from './deletePriority'; +export * from './deletePriorityScheme'; export * from './deleteProject'; export * from './deleteProjectAsynchronously'; export * from './deleteProjectAvatar'; export * from './deleteProjectProperty'; export * from './deleteProjectRole'; export * from './deleteProjectRoleActorsFromRole'; +export * from './deleteRelatedWork'; export * from './deleteRemoteIssueLinkByGlobalId'; export * from './deleteRemoteIssueLinkById'; export * from './deleteResolution'; @@ -207,6 +153,7 @@ export * from './deleteWorkflowTransitionRuleConfigurations'; export * from './deleteWorklog'; export * from './deleteWorklogProperty'; export * from './doTransition'; +export * from './duplicatePlan'; export * from './editIssue'; export * from './evaluateJiraExpression'; export * from './evaluateJiraExpressionUsingEnhancedSearch'; @@ -215,6 +162,7 @@ export * from './expandAttachmentForMachines'; export * from './exportArchivedIssues'; export * from './findAssignableUsers'; export * from './findBulkAssignableUsers'; +export * from './findComponentsForProjects'; export * from './findGroups'; export * from './findUserKeysByQuery'; export * from './findUsers'; @@ -240,6 +188,7 @@ export * from './getAllScreenTabFields'; export * from './getAllScreenTabs'; export * from './getAllStatuses'; export * from './getAllSystemAvatars'; +export * from './getAllUserDataClassificationLevels'; export * from './getAllUsers'; export * from './getAllUsersDefault'; export * from './getAllWorkflowSchemes'; @@ -247,17 +196,24 @@ export * from './getAlternativeIssueTypes'; export * from './getApplicationProperty'; export * from './getApplicationRole'; export * from './getAssignedPermissionScheme'; +export * from './getAtlassianTeam'; export * from './getAttachment'; export * from './getAttachmentContent'; export * from './getAttachmentThumbnail'; export * from './getAuditRecords'; export * from './getAutoCompletePost'; +export * from './getAvailablePrioritiesByPriorityScheme'; export * from './getAvailableScreenFields'; +export * from './getAvailableTransitions'; export * from './getAvatarImageByID'; export * from './getAvatarImageByOwner'; export * from './getAvatarImageByType'; export * from './getAvatars'; +export * from './getBulkChangelogs'; +export * from './getBulkEditableFields'; +export * from './getBulkOperationProgress'; export * from './getBulkPermissions'; +export * from './getBulkScreenTabs'; export * from './getChangeLogs'; export * from './getChangeLogsByIds'; export * from './getColumns'; @@ -270,14 +226,18 @@ export * from './getComponent'; export * from './getComponentRelatedIssues'; export * from './getContextsForField'; export * from './getCreateIssueMeta'; +export * from './getCreateIssueMetaIssueTypeId'; +export * from './getCreateIssueMetaIssueTypes'; export * from './getCurrentUser'; export * from './getCustomFieldConfiguration'; export * from './getCustomFieldContextsForProjectsAndIssueTypes'; export * from './getCustomFieldOption'; +export * from './getCustomFieldsConfigurations'; export * from './getDashboard'; export * from './getDashboardItemProperty'; export * from './getDashboardItemPropertyKeys'; export * from './getDashboardsPaginated'; +export * from './getDefaultProjectClassification'; export * from './getDefaultValues'; export * from './getDefaultWorkflow'; export * from './getDraftDefaultWorkflow'; @@ -299,6 +259,7 @@ export * from './getIdsOfWorklogsDeletedSince'; export * from './getIdsOfWorklogsModifiedSince'; export * from './getIssue'; export * from './getIssueFieldOption'; +export * from './getIssueLimitReport'; export * from './getIssueLink'; export * from './getIssueLinkType'; export * from './getIssuePickerResource'; @@ -323,6 +284,7 @@ export * from './getIsWatchingIssueBulk'; export * from './getMyFilters'; export * from './getMyPermissions'; export * from './getNotificationScheme'; +export * from './getNotificationSchemeForProject'; export * from './getNotificationSchemes'; export * from './getNotificationSchemeToProjectMappings'; export * from './getOptionsForContext'; @@ -330,9 +292,16 @@ export * from './getPermissionScheme'; export * from './getPermissionSchemeGrant'; export * from './getPermissionSchemeGrants'; export * from './getPermittedProjects'; +export * from './getPlan'; +export * from './getPlanOnlyTeam'; +export * from './getPlans'; +export * from './getPolicies'; export * from './getPrecomputations'; +export * from './getPrecomputationsByID'; export * from './getPreference'; +export * from './getPrioritiesByPriorityScheme'; export * from './getPriority'; +export * from './getPrioritySchemes'; export * from './getProject'; export * from './getProjectCategoryById'; export * from './getProjectComponents'; @@ -340,6 +309,7 @@ export * from './getProjectComponentsPaginated'; export * from './getProjectContextMapping'; export * from './getProjectEmail'; export * from './getProjectIssueSecurityScheme'; +export * from './getProjectIssueTypeUsagesForStatus'; export * from './getProjectProperty'; export * from './getProjectPropertyKeys'; export * from './getProjectRole'; @@ -347,13 +317,19 @@ export * from './getProjectRoleActorsForRole'; export * from './getProjectRoleById'; export * from './getProjectRoleDetails'; export * from './getProjectRoles'; +export * from './getProjectsByPriorityScheme'; export * from './getProjectsForIssueTypeScreenScheme'; export * from './getProjectTypeByKey'; +export * from './getProjectUsagesForStatus'; +export * from './getProjectUsagesForWorkflow'; +export * from './getProjectUsagesForWorkflowScheme'; export * from './getProjectVersions'; export * from './getProjectVersionsPaginated'; export * from './getRecent'; +export * from './getRelatedWork'; export * from './getRemoteIssueLinkById'; export * from './getRemoteIssueLinks'; +export * from './getResolution'; export * from './getScreens'; export * from './getScreenSchemes'; export * from './getScreensForField'; @@ -367,6 +343,7 @@ export * from './getStatus'; export * from './getStatusCategory'; export * from './getStatusesById'; export * from './getTask'; +export * from './getTeams'; export * from './getTransitions'; export * from './getTrashedFieldsPaginated'; export * from './getUiModifications'; @@ -386,14 +363,17 @@ export * from './getVersionUnresolvedIssues'; export * from './getVisibleIssueFieldOptions'; export * from './getVotes'; export * from './getWorkflow'; +export * from './getWorkflowProjectIssueTypeUsages'; export * from './getWorkflowScheme'; export * from './getWorkflowSchemeDraft'; export * from './getWorkflowSchemeDraftIssueType'; export * from './getWorkflowSchemeIssueType'; export * from './getWorkflowSchemeProjectAssociations'; +export * from './getWorkflowSchemeUsagesForWorkflow'; export * from './getWorkflowsPaginated'; export * from './getWorkflowTransitionProperties'; export * from './getWorkflowTransitionRuleConfigurations'; +export * from './getWorkflowUsagesForStatus'; export * from './getWorklog'; export * from './getWorklogProperty'; export * from './getWorklogPropertyKeys'; @@ -413,11 +393,15 @@ export * from './partialUpdateProjectRole'; export * from './publishDraftWorkflowScheme'; export * from './putAddonProperty'; export * from './putAppProperty'; +export * from './readWorkflows'; +export * from './readWorkflowSchemes'; export * from './refreshWebhooks'; export * from './registerDynamicWebhooks'; export * from './registerModules'; +export * from './removeAtlassianTeam'; export * from './removeAttachment'; export * from './removeCustomFieldContextFromProjects'; +export * from './removeDefaultProjectClassification'; export * from './removeGadget'; export * from './removeGroup'; export * from './removeIssueTypeFromIssueTypeScheme'; @@ -438,6 +422,7 @@ export * from './removeWatcher'; export * from './renameScreenTab'; export * from './reorderCustomFieldOptions'; export * from './reorderIssueTypesInIssueTypeScheme'; +export * from './replaceCustomFieldOption'; export * from './replaceIssueFieldOption'; export * from './resetColumns'; export * from './resetUserColumns'; @@ -445,16 +430,20 @@ export * from './restore'; export * from './restoreCustomField'; export * from './sanitiseJqlQueries'; export * from './search'; +export * from './searchAndReconsileIssuesUsingJqlPost'; +export * from './searchForIssuesIds'; export * from './searchForIssuesUsingJql'; export * from './searchForIssuesUsingJqlEnhancedSearch'; -export * from './searchForIssuesUsingJqlPost'; export * from './searchForIssuesUsingJqlEnhancedSearchPost'; +export * from './searchForIssuesUsingJqlPost'; export * from './searchPriorities'; export * from './searchProjects'; export * from './searchProjectsUsingSecuritySchemes'; export * from './searchResolutions'; export * from './searchSecuritySchemes'; +export * from './searchWorkflows'; export * from './selectTimeTrackingImplementation'; +export * from './services'; export * from './setActors'; export * from './setApplicationProperty'; export * from './setBanner'; @@ -479,9 +468,16 @@ export * from './setWorkflowSchemeDraftIssueType'; export * from './setWorkflowSchemeIssueType'; export * from './setWorklogProperty'; export * from './storeAvatar'; +export * from './submitBulkDelete'; +export * from './submitBulkEdit'; +export * from './submitBulkMove'; +export * from './submitBulkTransition'; +export * from './suggestedPrioritiesForMappings'; export * from './toggleFeatureForProject'; export * from './trashCustomField'; +export * from './trashPlan'; export * from './unarchiveIssues'; +export * from './updateAtlassianTeam'; export * from './updateComment'; export * from './updateComponent'; export * from './updateCustomField'; @@ -490,6 +486,7 @@ export * from './updateCustomFieldContext'; export * from './updateCustomFieldOption'; export * from './updateCustomFieldValue'; export * from './updateDashboard'; +export * from './updateDefaultProjectClassification'; export * from './updateDefaultScreenScheme'; export * from './updateDefaultWorkflow'; export * from './updateDraftDefaultWorkflow'; @@ -510,14 +507,19 @@ export * from './updateIssueTypeScreenScheme'; export * from './updateMultipleCustomFieldValues'; export * from './updateNotificationScheme'; export * from './updatePermissionScheme'; +export * from './updatePlan'; +export * from './updatePlanOnlyTeam'; export * from './updatePrecomputations'; export * from './updatePriority'; +export * from './updatePriorityScheme'; export * from './updateProject'; export * from './updateProjectAvatar'; export * from './updateProjectCategory'; export * from './updateProjectEmail'; +export * from './updateRelatedWork'; export * from './updateRemoteIssueLink'; export * from './updateResolution'; +export * from './updateSchemes'; export * from './updateScreen'; export * from './updateScreenScheme'; export * from './updateSecurityLevel'; @@ -525,10 +527,15 @@ export * from './updateStatuses'; export * from './updateUiModification'; export * from './updateVersion'; export * from './updateWorkflowMapping'; +export * from './updateWorkflows'; export * from './updateWorkflowScheme'; export * from './updateWorkflowSchemeDraft'; +export * from './updateWorkflowSchemeMappings'; export * from './updateWorkflowTransitionProperty'; export * from './updateWorkflowTransitionRuleConfigurations'; export * from './updateWorklog'; +export * from './validateCreateWorkflows'; export * from './validateProjectKey'; +export * from './validateUpdateWorkflows'; +export * from './workflowCapabilities'; export * from './workflowRuleSearch'; diff --git a/src/version3/parameters/searchPriorities.ts b/src/version3/parameters/searchPriorities.ts index 64c81ab36..7ad7be970 100644 --- a/src/version3/parameters/searchPriorities.ts +++ b/src/version3/parameters/searchPriorities.ts @@ -1,8 +1,8 @@ export interface SearchPriorities { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** The list of priority IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=2&id=3`. */ id?: string[]; /** diff --git a/src/version3/parameters/searchProjectsUsingSecuritySchemes.ts b/src/version3/parameters/searchProjectsUsingSecuritySchemes.ts index 6e2ee0702..ba08b5778 100644 --- a/src/version3/parameters/searchProjectsUsingSecuritySchemes.ts +++ b/src/version3/parameters/searchProjectsUsingSecuritySchemes.ts @@ -1,8 +1,8 @@ export interface SearchProjectsUsingSecuritySchemes { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** The list of security scheme IDs to be filtered out. */ issueSecuritySchemeId?: string[]; /** The list of project IDs to be filtered out. */ diff --git a/src/version3/parameters/searchSecuritySchemes.ts b/src/version3/parameters/searchSecuritySchemes.ts index eb6b6edc6..df7dae957 100644 --- a/src/version3/parameters/searchSecuritySchemes.ts +++ b/src/version3/parameters/searchSecuritySchemes.ts @@ -1,8 +1,8 @@ export interface SearchSecuritySchemes { /** The index of the first item to return in a page of results (page offset). */ - startAt?: string; + startAt?: number; /** The maximum number of items to return per page. */ - maxResults?: string; + maxResults?: number; /** * The list of issue security scheme IDs. To include multiple issue security scheme IDs, separate IDs with an * ampersand: `id=10000&id=10001`. diff --git a/src/version3/parameters/searchWorkflows.ts b/src/version3/parameters/searchWorkflows.ts new file mode 100644 index 000000000..c05a64172 --- /dev/null +++ b/src/version3/parameters/searchWorkflows.ts @@ -0,0 +1,27 @@ +export interface SearchWorkflows { + /** The index of the first item to return in a page of results (page offset). */ + startAt?: number; + /** The maximum number of items to return per page. */ + maxResults?: number; + /** + * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#expansion) to include additional + * information in the response. This parameter accepts a comma-separated list. Expand options include: + * + * - `values.transitions` Returns the transitions that each workflow is associated with. + */ + expand?: 'values.transitions' | string; + /** String used to perform a case-insensitive partial match with workflow name. */ + queryString?: string; + /** + * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#ordering) the results by a field: + * + * - `name` Sorts by workflow name. + * - `created` Sorts by create time. + * - `updated` Sorts by update time. + */ + orderBy?: 'name' | 'created' | 'updated' | '+name' | '+created' | '+updated' | '-name' | '-created' | '-updated' | string; + /** The scope of the workflow. Global for company-managed projects and Project for team-managed projects. */ + scope?: string; + /** Filters active and inactive workflows. */ + isActive?: boolean; +} diff --git a/src/version3/status.ts b/src/version3/status.ts index c19760775..6cf82f415 100644 --- a/src/version3/status.ts +++ b/src/version3/status.ts @@ -182,16 +182,16 @@ export class Status { return this.client.sendRequest(config, callback); } /** Returns a page of issue types in a project using a given status. */ - async getProjectIssueTypeUsagesForStatus( + async getProjectIssueTypeUsagesForStatus( parameters: Parameters.GetProjectIssueTypeUsagesForStatus, callback: Callback, ): Promise; /** Returns a page of issue types in a project using a given status. */ - async getProjectIssueTypeUsagesForStatus( + async getProjectIssueTypeUsagesForStatus( parameters: Parameters.GetProjectIssueTypeUsagesForStatus, callback?: never, ): Promise; - async getProjectIssueTypeUsagesForStatus( + async getProjectIssueTypeUsagesForStatus( parameters: Parameters.GetProjectIssueTypeUsagesForStatus, callback?: Callback, ): Promise { @@ -208,16 +208,16 @@ export class Status { } /** Returns a page of projects using a given status. */ - async getProjectUsagesForStatus( + async getProjectUsagesForStatus( parameters: Parameters.GetProjectUsagesForStatus, callback: Callback, ): Promise; /** Returns a page of projects using a given status. */ - async getProjectUsagesForStatus( + async getProjectUsagesForStatus( parameters: Parameters.GetProjectUsagesForStatus, callback?: never, ): Promise; - async getProjectUsagesForStatus( + async getProjectUsagesForStatus( parameters: Parameters.GetProjectUsagesForStatus, callback?: Callback, ): Promise { @@ -234,16 +234,16 @@ export class Status { } /** Returns a page of workflows using a given status. */ - async getWorkflowUsagesForStatus( + async getWorkflowUsagesForStatus( parameters: Parameters.GetWorkflowUsagesForStatus, callback: Callback, ): Promise; /** Returns a page of workflows using a given status. */ - async getWorkflowUsagesForStatus( + async getWorkflowUsagesForStatus( parameters: Parameters.GetWorkflowUsagesForStatus, callback?: never, ): Promise; - async getWorkflowUsagesForStatus( + async getWorkflowUsagesForStatus( parameters: Parameters.GetWorkflowUsagesForStatus, callback?: Callback, ): Promise { diff --git a/src/version3/workflows.ts b/src/version3/workflows.ts index 61b157800..eaccfee54 100644 --- a/src/version3/workflows.ts +++ b/src/version3/workflows.ts @@ -145,16 +145,16 @@ export class Workflows { } /** Returns a page of issue types using a given workflow within a project. */ - async getWorkflowProjectIssueTypeUsages( + async getWorkflowProjectIssueTypeUsages( parameters: Parameters.GetWorkflowProjectIssueTypeUsages, callback: Callback, ): Promise; /** Returns a page of issue types using a given workflow within a project. */ - async getWorkflowProjectIssueTypeUsages( + async getWorkflowProjectIssueTypeUsages( parameters: Parameters.GetWorkflowProjectIssueTypeUsages, callback?: never, ): Promise; - async getWorkflowProjectIssueTypeUsages( + async getWorkflowProjectIssueTypeUsages( parameters: Parameters.GetWorkflowProjectIssueTypeUsages, callback?: Callback, ): Promise { @@ -171,16 +171,16 @@ export class Workflows { } /** Returns a page of projects using a given workflow. */ - async getProjectUsagesForWorkflow( + async getProjectUsagesForWorkflow( parameters: Parameters.GetProjectUsagesForWorkflow, callback: Callback, ): Promise; /** Returns a page of projects using a given workflow. */ - async getProjectUsagesForWorkflow( + async getProjectUsagesForWorkflow( parameters: Parameters.GetProjectUsagesForWorkflow, callback?: never, ): Promise; - async getProjectUsagesForWorkflow( + async getProjectUsagesForWorkflow( parameters: Parameters.GetProjectUsagesForWorkflow, callback?: Callback, ): Promise { @@ -197,16 +197,16 @@ export class Workflows { } /** Returns a page of workflow schemes using a given workflow. */ - async getWorkflowSchemeUsagesForWorkflow( + async getWorkflowSchemeUsagesForWorkflow( parameters: Parameters.GetWorkflowSchemeUsagesForWorkflow, callback: Callback, ): Promise; /** Returns a page of workflow schemes using a given workflow. */ - async getWorkflowSchemeUsagesForWorkflow( + async getWorkflowSchemeUsagesForWorkflow( parameters: Parameters.GetWorkflowSchemeUsagesForWorkflow, callback?: never, ): Promise; - async getWorkflowSchemeUsagesForWorkflow( + async getWorkflowSchemeUsagesForWorkflow( parameters: Parameters.GetWorkflowSchemeUsagesForWorkflow, callback?: Callback, ): Promise { diff --git a/tests/unit/version2/issueSearch.test.ts b/tests/unit/version2/issueSearch.test.ts index 840cadbfb..7ff24a817 100644 --- a/tests/unit/version2/issueSearch.test.ts +++ b/tests/unit/version2/issueSearch.test.ts @@ -12,7 +12,9 @@ test('searchForIssuesUsingJql should calls without parameters', ({ expect }) => const client = new Version2Client(config); const sendRequestStub = sinon.stub(client, 'sendRequest'); - client.issueSearch.searchForIssuesUsingJql(); + client.issueSearch.searchForIssuesUsingJql({ + jql: '', + }); expect(sendRequestStub.calledOnce).toBeTruthy(); }); @@ -33,6 +35,7 @@ test('searchForIssuesUsingJql should accept follow parameters', ({ expect }) => expect(callArgument.params).toStrictEqual({ expand: undefined, + failFast: undefined, fields: ['key', 'summary'], fieldsByKeys: undefined, jql: 'id IN (TICKET_ID) ORDER BY key ASC', @@ -72,7 +75,7 @@ test('searchForIssuesUsingJqlEnhancedSearch should calls without parameters', ({ const client = new Version2Client(config); const sendRequestStub = sinon.stub(client, 'sendRequest'); - client.issueSearch.searchForIssuesUsingJqlEnhancedSearch(); + client.issueSearch.searchForIssuesUsingJqlEnhancedSearch({}); expect(sendRequestStub.calledOnce).toBeTruthy(); }); diff --git a/tests/unit/version2/jiraExpressions.test.ts b/tests/unit/version2/jiraExpressions.test.ts index a4e0f3ae5..94a374c2a 100644 --- a/tests/unit/version2/jiraExpressions.test.ts +++ b/tests/unit/version2/jiraExpressions.test.ts @@ -12,7 +12,9 @@ test('evaluateJiraExpressionUsingEnhancedSearch should calls without parameters' const client = new Version2Client(config); const sendRequestStub = sinon.stub(client, 'sendRequest'); - client.jiraExpressions.evaluateJiraExpressionUsingEnhancedSearch(); + client.jiraExpressions.evaluateJiraExpressionUsingEnhancedSearch({ + expression: '', + }); expect(sendRequestStub.calledOnce).toBeTruthy(); }); diff --git a/tests/unit/version2/projectVersions.test.ts b/tests/unit/version2/projectVersions.test.ts index b60f9201e..1d3caf552 100644 --- a/tests/unit/version2/projectVersions.test.ts +++ b/tests/unit/version2/projectVersions.test.ts @@ -73,8 +73,10 @@ test('createVersion should accept follow parameters', ({ expect }) => { const callArgument = sendRequestStub.getCall(0).args[0]; expect(callArgument.data).toStrictEqual({ + approvers: undefined, archived: undefined, description: undefined, + driver: undefined, expand: undefined, id: undefined, issuesStatusForFixVersion: undefined, diff --git a/tests/unit/version3/issueSearch.test.ts b/tests/unit/version3/issueSearch.test.ts index 78d40e979..28b582c3e 100644 --- a/tests/unit/version3/issueSearch.test.ts +++ b/tests/unit/version3/issueSearch.test.ts @@ -35,8 +35,8 @@ test('searchForIssuesUsingJql should accept follow parameters', ({ expect }) => expect(callArgument.params).toStrictEqual({ expand: undefined, - fields: ['key', 'summary'], failFast: undefined, + fields: ['key', 'summary'], fieldsByKeys: undefined, jql: 'id IN (TICKET_ID) ORDER BY key ASC', maxResults: 10,