From 7d8bffb71f1b1f6f2dce0f5877e28aca9cab5c4a Mon Sep 17 00:00:00 2001 From: Vladislav Tupikin Date: Sun, 15 Oct 2023 19:35:26 +0300 Subject: [PATCH] V3.0.0 (#285) * [#271]: Update `getAvatarImageByID` to include `contentType` in return type (#281) * [#271]: initial template added * [#271]: lint fix * [#271]: fixes added * [#271]: getAvatarImageByID updated for version2 * [#271]: test project name updated * NodeJS 10 version life was ended * JWT and OAuth auths removed (#284) * JWT and OAuth auths removed * XOR3 added * unit tests fixed * build fixed * Deprecation stuff removed (#283) * agile deprecation stuff removed * version2 deprecation stuff removed * test fixes * version3 deprecated properties removed * no-namespaces rule applied * integration tests fixes * old stuff removed * newErrorHandling removed * avatar api updates (#286) * parameters types improvements * parameters types improvements * build fix * parameters types improvements * CHANGELOG.md updated --- .github/workflows/ci.yaml | 8 +- .github/workflows/publish.yml | 15 +- CHANGELOG.md | 17 + README.md | 94 +- examples/package-lock.json | 25 +- examples/package.json | 2 +- examples/src/addFixVersion.ts | 11 +- examples/src/addWorklog.ts | 9 +- examples/src/basic.ts | 9 +- examples/src/getAllWorklogs.ts | 9 +- examples/src/utils/addWorklog.ts | 4 +- examples/src/utils/createIssue.ts | 6 +- package-lock.json | 815 +++++++----------- package.json | 33 +- src/agile/builds.ts | 4 +- src/agile/client/agileClient.ts | 2 - src/agile/deployments.ts | 4 +- src/agile/developmentInformation.ts | 8 +- src/agile/featureFlags.ts | 4 +- src/agile/index.ts | 1 - src/agile/models/basicUser.ts | 46 - src/agile/models/board.ts | 15 - src/agile/models/boardAdmins.ts | 45 - src/agile/models/boardConfig.ts | 42 - src/agile/models/boardCreate.ts | 12 - src/agile/models/boardFeature.ts | 14 - src/agile/models/boardFeatureResponse.ts | 16 - src/agile/models/boardFeatureToggleRequest.ts | 9 - src/agile/models/boardFilter.ts | 8 - src/agile/models/boardLocation.ts | 15 - src/agile/models/changeHistory.ts | 136 --- src/agile/models/changeItem.ts | 19 - src/agile/models/changelog.ts | 290 ------- src/agile/models/color.ts | 6 - src/agile/models/column.ts | 12 - src/agile/models/columnConfig.ts | 15 - src/agile/models/createBoard.ts | 12 - src/agile/models/editMeta.ts | 7 - src/agile/models/entry.ts | 6 - src/agile/models/epicRankRequest.ts | 8 - src/agile/models/epicUpdate.ts | 11 - src/agile/models/estimationConfig.ts | 10 - src/agile/models/estimationField.ts | 7 - src/agile/models/feature.ts | 19 - src/agile/models/featureResponse.ts | 21 - src/agile/models/featureToggleRequest.ts | 5 - src/agile/models/fieldEdit.ts | 6 - src/agile/models/fieldMeta.ts | 39 - src/agile/models/getAllBoards.ts | 75 +- src/agile/models/getBoard.ts | 12 - src/agile/models/getDeploymentByKey.ts | 7 +- src/agile/models/getFeaturesForProject.ts | 12 - src/agile/models/getRepository.ts | 43 - src/agile/models/group.ts | 3 - src/agile/models/historyMetadata.ts | 64 -- .../models/historyMetadataParticipant.ts | 15 - src/agile/models/index.ts | 51 -- src/agile/models/issue.ts | 17 - src/agile/models/issueAssignRequest.ts | 6 - src/agile/models/issueRankRequest.ts | 9 - src/agile/models/issueTransition.ts | 3 - src/agile/models/jsonType.ts | 3 - src/agile/models/linkGroup.ts | 3 - src/agile/models/location.ts | 7 - src/agile/models/moveIssuesToBoard.ts | 8 - src/agile/models/opsbar.ts | 9 - src/agile/models/page.ts | 10 - src/agile/models/pageBoard.ts | 81 -- src/agile/models/pageBoardFilter.ts | 14 - src/agile/models/pageQuickFilter.ts | 17 - src/agile/models/partialSuccess.ts | 11 - src/agile/models/quickFilter.ts | 11 - src/agile/models/rankingConfig.ts | 6 - src/agile/models/relation.ts | 7 - src/agile/models/report.ts | 4 - src/agile/models/reportsResponse.ts | 6 - src/agile/models/searchResults.ts | 3 - src/agile/models/simpleLink.ts | 13 - src/agile/models/sprint.ts | 13 +- src/agile/models/sprintCreate.ts | 10 - src/agile/models/sprintSwap.ts | 6 - src/agile/models/statusCategoryJson.ts | 15 - src/agile/models/statusJson.ts | 30 - src/agile/models/subquery.ts | 6 - src/agile/models/user.ts | 17 - src/agile/models/userAvatarUrls.ts | 11 - src/agile/parameters/createBoard.ts | 4 +- src/agile/parameters/createSprint.ts | 2 +- src/agile/parameters/deleteBuildByKey.ts | 2 - .../parameters/deleteBuildsByProperty.ts | 2 - src/agile/parameters/deleteByProperties.ts | 2 - src/agile/parameters/deleteDeploymentByKey.ts | 2 - .../parameters/deleteDeploymentsByProperty.ts | 2 - src/agile/parameters/deleteEntity.ts | 4 +- src/agile/parameters/deleteFeatureFlagById.ts | 2 - .../deleteFeatureFlagsByProperty.ts | 2 - src/agile/parameters/deleteRemoteLinkById.ts | 2 - .../parameters/deleteRemoteLinksByProperty.ts | 2 - src/agile/parameters/deleteRepository.ts | 2 - src/agile/parameters/existsByProperties.ts | 2 - src/agile/parameters/getAllBoards.ts | 2 +- src/agile/parameters/getBoardByFilterId.ts | 4 +- src/agile/parameters/getFeaturesForProject.ts | 3 - src/agile/parameters/index.ts | 1 - src/agile/parameters/partiallyUpdateEpic.ts | 17 +- src/agile/parameters/partiallyUpdateSprint.ts | 4 +- .../parameters/storeDevelopmentInformation.ts | 64 +- src/agile/parameters/submitBuilds.ts | 4 +- src/agile/parameters/submitDeployments.ts | 18 +- src/agile/parameters/submitFeatureFlags.ts | 4 +- src/agile/parameters/submitRemoteLinks.ts | 16 +- src/agile/parameters/submitVulnerabilities.ts | 41 +- src/agile/parameters/submitWorkspaces.ts | 5 +- src/agile/parameters/updateSprint.ts | 2 +- src/agile/project.ts | 32 - src/agile/remoteLinks.ts | 4 +- src/clients/baseClient.ts | 69 +- src/clients/client.ts | 5 + src/config.ts | 20 +- src/serviceDesk/models/changeDetails.ts | 17 - src/serviceDesk/models/changelog.ts | 15 - src/serviceDesk/models/errorResponse.ts | 6 - src/serviceDesk/models/expandable.ts | 3 - src/serviceDesk/models/fieldMetadata.ts | 24 - src/serviceDesk/models/historyMetadata.ts | 24 - .../models/historyMetadataParticipant.ts | 15 - src/serviceDesk/models/i18nErrorMessage.ts | 4 - src/serviceDesk/models/includedFields.ts | 5 - src/serviceDesk/models/index.ts | 18 - src/serviceDesk/models/issueUpdateMetadata.ts | 4 - src/serviceDesk/models/linkGroup.ts | 11 - src/serviceDesk/models/linkable.ts | 5 - .../models/linkableAttachmentLink.ts | 5 - .../models/linkableCustomerRequestLink.ts | 5 - src/serviceDesk/models/linkableUserLink.ts | 5 - src/serviceDesk/models/operations.ts | 7 - src/serviceDesk/models/pageOfChangelogs.ts | 13 - src/serviceDesk/models/simpleLink.ts | 10 - src/serviceDesk/models/user.ts | 7 - src/serviceDesk/models/userLink.ts | 5 - .../parameters/attachTemporaryFile.ts | 14 +- .../parameters/getCustomerRequests.ts | 14 - src/serviceDesk/request.ts | 1 - .../authenticationService.ts | 45 - .../createJWTAuthentication.ts | 27 - .../createOAuthAuthenticationToken.ts | 27 - .../authentications/index.ts | 2 - .../getAuthenticationToken.ts | 28 + src/services/authenticationService/index.ts | 2 +- src/utilityTypes.ts | 3 + src/version2/appMigration.ts | 2 +- src/version2/appProperties.ts | 2 +- src/version2/avatars.ts | 55 +- src/version2/client/version2Client.ts | 4 - src/version2/dashboards.ts | 3 +- src/version2/filters.ts | 44 - src/version2/groups.ts | 43 +- src/version2/index.ts | 2 - src/version2/instanceInformation.ts | 30 - src/version2/issueAdjustmentsApps.ts | 158 ---- src/version2/issueComments.ts | 4 +- .../issueCustomFieldConfigurationApps.ts | 1 - src/version2/issueCustomFieldOptions.ts | 154 ---- src/version2/issueFields.ts | 38 - src/version2/issueNotificationSchemes.ts | 32 - src/version2/issuePriorities.ts | 43 - src/version2/issueResolutions.ts | 53 -- src/version2/issueTypeProperties.ts | 2 +- src/version2/issueTypes.ts | 1 - src/version2/issueWatchers.ts | 1 - src/version2/jQL.ts | 51 -- src/version2/models/actorInput.ts | 3 - src/version2/models/addField.ts | 3 - src/version2/models/addGroup.ts | 3 - .../models/addNotificationsDetails.ts | 7 - src/version2/models/applicationRole.ts | 2 - src/version2/models/associatedItem.ts | 3 - src/version2/models/attachment.ts | 2 +- src/version2/models/attachmentArchive.ts | 8 - src/version2/models/auditRecord.ts | 5 - src/version2/models/avatarUrls.ts | 3 - src/version2/models/avatarWithDetails.ts | 6 + .../bulkCreateCustomFieldOptionRequest.ts | 7 - src/version2/models/bulkPermissionsRequest.ts | 3 - src/version2/models/changedValue.ts | 3 - src/version2/models/comment.ts | 2 +- src/version2/models/component.ts | 65 -- src/version2/models/compoundClause.ts | 14 - src/version2/models/configuration.ts | 2 - src/version2/models/context.ts | 10 - .../models/contextualConfiguration.ts | 2 - .../models/crateWorkflowStatusDetails.ts | 5 - .../models/createIssueAdjustmentDetails.ts | 13 - src/version2/models/createProjectDetails.ts | 10 +- .../models/createUpdateRoleRequest.ts | 3 - ...FieldContextDefaultValueCascadingOption.ts | 10 - ...mFieldContextDefaultValueMultipleOption.ts | 8 - ...tomFieldContextDefaultValueSingleOption.ts | 8 - .../models/customFieldDefinitionJson.ts | 3 - .../models/customFieldOptionDetails.ts | 9 - src/version2/models/customFieldOptionValue.ts | 7 - .../models/customFieldValueUpdateRequest.ts | 7 - src/version2/models/dashboardUser.ts | 15 - .../models/deleteAndReplaceVersion.ts | 16 - src/version2/models/deprecatedWorkflow.ts | 23 - src/version2/models/errorMessage.ts | 4 - src/version2/models/fieldChangedClause.ts | 15 - src/version2/models/fieldUpdateOperation.ts | 11 - src/version2/models/fieldValueClause.ts | 10 - src/version2/models/fieldWasClause.ts | 17 - src/version2/models/functionOperand.ts | 12 - src/version2/models/globalScope.ts | 3 - src/version2/models/healthCheckResult.ts | 9 - src/version2/models/hierarchy.ts | 6 - src/version2/models/hierarchyLevel.ts | 30 - src/version2/models/icon.ts | 3 - src/version2/models/id.ts | 3 - src/version2/models/idOrKey.ts | 3 - src/version2/models/index.ts | 52 +- src/version2/models/issue.ts | 3 - .../models/issueAdjustmentContextDetails.ts | 13 - src/version2/models/issueAdjustmentDetails.ts | 17 - .../models/issueAdjustmentIdentifiers.ts | 7 - .../models/issueCommentListRequest.ts | 3 - .../models/issueFieldOptionConfiguration.ts | 2 - src/version2/models/issueFieldOptionCreate.ts | 3 - src/version2/models/issueFieldOptionScope.ts | 5 - src/version2/models/issueTypeCreate.ts | 9 - src/version2/models/issueTypeUpdate.ts | 3 - src/version2/models/issuesJqlMetaData.ts | 3 - src/version2/models/issuesMeta.ts | 3 - src/version2/models/issuesUpdate.ts | 3 - .../models/jiraExpressionEvalContext.ts | 3 - .../models/jiraExpressionEvalRequest.ts | 3 - .../jiraExpressionEvaluationMetaData.ts | 3 - .../models/jiraExpressionsComplexity.ts | 3 - .../models/jiraExpressionsComplexityValue.ts | 3 - src/version2/models/jqlQueryClauseOperand.ts | 2 - .../models/jqlQueryClauseTimePredicate.ts | 8 - src/version2/models/jqlQueryUnitaryOperand.ts | 2 - src/version2/models/jsonNode.ts | 38 - src/version2/models/jsonType.ts | 3 - src/version2/models/keywordOperand.ts | 9 - src/version2/models/linkIssueRequestJson.ts | 3 - src/version2/models/listOperand.ts | 9 - src/version2/models/moveField.ts | 3 - src/version2/models/newUserDetails.ts | 7 - src/version2/models/pageChangelog.ts | 3 - src/version2/models/pageComment.ts | 3 - .../models/pageComponentWithIssueCount.ts | 3 - src/version2/models/pageContext.ts | 22 - .../pageContextForProjectAndIssueType.ts | 3 - src/version2/models/pageCustomFieldContext.ts | 3 - .../pageCustomFieldContextDefaultValue.ts | 3 - .../models/pageCustomFieldContextOption.ts | 3 - .../pageCustomFieldContextProjectMapping.ts | 3 - .../models/pageCustomFieldOptionDetails.ts | 22 - src/version2/models/pageDashboard.ts | 3 - src/version2/models/pageField.ts | 3 - src/version2/models/pageFieldConfiguration.ts | 3 - .../pageFieldConfigurationIssueTypeItem.ts | 3 - .../models/pageFieldConfigurationItem.ts | 3 - .../models/pageFieldConfigurationScheme.ts | 3 - .../pageFieldConfigurationSchemeProjects.ts | 3 - src/version2/models/pageFilterDetails.ts | 3 - src/version2/models/pageGroupDetails.ts | 3 - .../models/pageIssueAdjustmentDetails.ts | 19 - src/version2/models/pageIssueFieldOption.ts | 3 - .../models/pageIssueSecurityLevelMember.ts | 3 - src/version2/models/pageIssueTypeScheme.ts | 3 - .../models/pageIssueTypeSchemeMapping.ts | 3 - .../models/pageIssueTypeSchemeProjects.ts | 3 - .../models/pageIssueTypeScreenScheme.ts | 3 - .../models/pageIssueTypeScreenSchemeItem.ts | 3 - .../pageIssueTypeScreenSchemesProjects.ts | 3 - .../models/pageIssueTypeToContextMapping.ts | 3 - src/version2/models/pageNotificationScheme.ts | 3 - src/version2/models/pageProject.ts | 5 +- src/version2/models/pageScreen.ts | 3 - src/version2/models/pageScreenScheme.ts | 3 - src/version2/models/pageScreenWithTab.ts | 3 - src/version2/models/pageString.ts | 3 - src/version2/models/pageUser.ts | 3 - src/version2/models/pageUserDetails.ts | 3 - src/version2/models/pageUserKey.ts | 3 - src/version2/models/pageVersion.ts | 3 - src/version2/models/pageWebhook.ts | 3 - src/version2/models/pageWorkflow.ts | 3 - src/version2/models/pageWorkflowScheme.ts | 3 - .../models/pageWorkflowTransitionRules.ts | 3 - .../models/paginatedResponseComment.ts | 8 - src/version2/models/permissionsKeys.ts | 3 - src/version2/models/projectFeatures.ts | 7 - .../models/projectFeaturesResponse.ts | 7 - src/version2/models/projectForScope.ts | 24 - src/version2/models/projectIdentifier.ts | 3 - src/version2/models/projectInput.ts | 67 -- .../models/projectIssueTypesHierarchyLevel.ts | 6 - .../models/projectRoleActorsUpdate.ts | 3 - src/version2/models/projectScope.ts | 3 - .../models/publishDraftWorkflowScheme.ts | 7 - .../models/removeOptionFromIssuesResult.ts | 9 - src/version2/models/renamedCascadingOption.ts | 7 - src/version2/models/renamedOption.ts | 11 - src/version2/models/screenID.ts | 5 - .../models/searchAutoCompleteFilter.ts | 7 - src/version2/models/searchRequest.ts | 3 - src/version2/models/serverInformation.ts | 4 - .../models/simpleApplicationProperty.ts | 3 - src/version2/models/simpleErrorCollection.ts | 10 - src/version2/models/stringList.ts | 1 - src/version2/models/taskProgressObject.ts | 3 - ...askProgressRemoveOptionFromIssuesResult.ts | 33 - .../models/updateCustomFieldOption.ts | 7 - .../models/updateDefaultScreenScheme.ts | 5 - .../models/updateIssueAdjustmentDetails.ts | 16 - src/version2/models/updateProjectDetails.ts | 8 +- src/version2/models/updateUserToGroup.ts | 3 - src/version2/models/userAvatarUrls.ts | 3 - src/version2/models/userFilter.ts | 15 - src/version2/models/userMigration.ts | 3 - src/version2/models/userPermission.ts | 26 - src/version2/models/userWrite.ts | 36 - src/version2/models/valueOperand.ts | 7 - src/version2/models/version.ts | 4 +- src/version2/models/versionMove.ts | 3 - .../models/workflowCompoundCondition.ts | 10 - src/version2/models/workflowRules.ts | 5 - .../models/workflowSimpleCondition.ts | 8 - src/version2/models/worklogIdsRequest.ts | 3 - src/version2/myself.ts | 53 -- src/version2/parameters/addAttachment.ts | 14 +- src/version2/parameters/addNotifications.ts | 6 - src/version2/parameters/addUserToGroup.ts | 10 +- src/version2/parameters/addWorklog.ts | 13 +- src/version2/parameters/analyseExpression.ts | 17 +- .../parameters/assignPermissionScheme.ts | 20 +- .../parameters/associateSchemeWithProject.ts | 3 - src/version2/parameters/bulkGetUsers.ts | 14 - .../parameters/createCustomFieldOptions.ts | 9 - .../parameters/createIssueAdjustment.ts | 3 - .../createWorkflowTransitionProperty.ts | 2 +- src/version2/parameters/deleteAvatar.ts | 2 +- src/version2/parameters/deleteIssue.ts | 2 +- .../parameters/deleteIssueAdjustment.ts | 4 - src/version2/parameters/deletePriority.ts | 8 - src/version2/parameters/deleteStatusesById.ts | 2 +- src/version2/parameters/deleteVersion.ts | 14 - .../deleteWorkflowTransitionProperty.ts | 2 +- src/version2/parameters/deleteWorklog.ts | 13 +- src/version2/parameters/findGroups.ts | 13 +- src/version2/parameters/findUsers.ts | 2 +- src/version2/parameters/findUsersAndGroups.ts | 24 +- src/version2/parameters/findUsersForPicker.ts | 6 - .../getAccessibleProjectTypeByKey.ts | 2 +- src/version2/parameters/getAllDashboards.ts | 5 +- .../parameters/getAllIssueTypeSchemes.ts | 4 +- src/version2/parameters/getAllProjects.ts | 18 - .../parameters/getAllSystemAvatars.ts | 2 +- src/version2/parameters/getAllWorkflows.ts | 4 - src/version2/parameters/getAvatarImageByID.ts | 8 +- .../parameters/getAvatarImageByOwner.ts | 6 +- .../parameters/getAvatarImageByType.ts | 6 +- src/version2/parameters/getAvatars.ts | 2 +- src/version2/parameters/getComments.ts | 2 +- .../getContextsForFieldDeprecated.ts | 8 - src/version2/parameters/getCurrentUser.ts | 22 +- .../parameters/getCustomFieldConfiguration.ts | 8 +- .../parameters/getDashboardsPaginated.ts | 31 +- src/version2/parameters/getFieldsPaginated.ts | 39 +- src/version2/parameters/getFilters.ts | 16 - .../parameters/getFiltersPaginated.ts | 68 +- src/version2/parameters/getGroup.ts | 11 - src/version2/parameters/getIssue.ts | 24 +- .../parameters/getIssueAdjustments.ts | 14 - .../parameters/getIssueTypeScreenSchemes.ts | 2 +- .../getNotificationSchemeForProject.ts | 23 +- src/version2/parameters/getOptionsForField.ts | 11 - src/version2/parameters/getPrecomputations.ts | 31 +- .../getProjectComponentsPaginated.ts | 20 +- .../parameters/getProjectTypeByKey.ts | 2 +- .../parameters/getProjectVersionsPaginated.ts | 31 +- src/version2/parameters/getRecent.ts | 25 +- src/version2/parameters/getResolution.ts | 4 - src/version2/parameters/getScreenSchemes.ts | 2 +- src/version2/parameters/getScreens.ts | 7 +- src/version2/parameters/getStatusesById.ts | 17 +- .../parameters/getTrashedFieldsPaginated.ts | 13 +- src/version2/parameters/getUser.ts | 23 +- src/version2/parameters/getVersion.ts | 11 +- .../getWorkflowTransitionProperties.ts | 2 +- ...getWorkflowTransitionRuleConfigurations.ts | 15 +- .../parameters/getWorkflowsPaginated.ts | 18 +- src/version2/parameters/index.ts | 21 - src/version2/parameters/parseJqlQueries.ts | 9 +- src/version2/parameters/putAddonProperty.ts | 3 - src/version2/parameters/removeGroup.ts | 5 +- src/version2/parameters/removeWatcher.ts | 6 - .../parameters/replaceIssueFieldOption.ts | 8 +- src/version2/parameters/search.ts | 5 +- .../parameters/searchForIssuesUsingJql.ts | 35 +- src/version2/parameters/searchPriorities.ts | 2 +- src/version2/parameters/searchProjects.ts | 40 +- .../parameters/setDashboardItemProperty.ts | 8 +- .../parameters/setIssueTypeProperty.ts | 2 +- src/version2/parameters/setLocale.ts | 3 - src/version2/parameters/setProjectProperty.ts | 4 +- src/version2/parameters/setUserProperty.ts | 14 - .../setWorkflowSchemeDraftIssueType.ts | 2 +- .../parameters/setWorkflowSchemeIssueType.ts | 2 +- src/version2/parameters/storeAvatar.ts | 3 +- src/version2/parameters/updateComment.ts | 6 +- .../parameters/updateCustomFieldOptions.ts | 9 - .../parameters/updateEntityPropertiesValue.ts | 15 +- .../parameters/updateIssueAdjustment.ts | 6 - src/version2/parameters/updateProject.ts | 2 +- src/version2/parameters/updateProjectType.ts | 6 - src/version2/parameters/updateWorklog.ts | 13 +- src/version2/projectProperties.ts | 2 +- src/version2/projectVersions.ts | 41 - src/version2/projects.ts | 73 -- src/version2/userProperties.ts | 2 - src/version2/userSearch.ts | 1 - src/version2/users.ts | 6 - src/version2/workflowSchemeDrafts.ts | 2 +- .../workflowSchemeProjectAssociations.ts | 28 - src/version2/workflowSchemes.ts | 2 +- src/version2/workflows.ts | 39 - src/version3/appMigration.ts | 2 +- src/version3/appProperties.ts | 2 +- src/version3/avatars.ts | 55 +- src/version3/client/version3Client.ts | 2 - src/version3/dashboards.ts | 3 +- src/version3/filters.ts | 44 - src/version3/groups.ts | 28 - src/version3/index.ts | 1 - src/version3/issueAdjustmentsApps.ts | 158 ---- src/version3/issueComments.ts | 6 +- .../issueCustomFieldConfigurationApps.ts | 1 - src/version3/issueCustomFieldOptions.ts | 156 ---- src/version3/issueFields.ts | 38 - src/version3/issueNotificationSchemes.ts | 28 - src/version3/issuePriorities.ts | 33 - src/version3/issueResolutions.ts | 48 -- src/version3/issueTypes.ts | 1 - src/version3/jQL.ts | 51 -- src/version3/models/addField.ts | 3 - src/version3/models/addGroup.ts | 3 - .../models/addNotificationsDetails.ts | 7 - src/version3/models/applicationRole.ts | 2 - src/version3/models/associatedItem.ts | 3 - src/version3/models/attachmentArchive.ts | 8 - src/version3/models/auditRecord.ts | 5 - src/version3/models/avatarUrls.ts | 3 - src/version3/models/avatarWithDetails.ts | 6 + .../bulkCreateCustomFieldOptionRequest.ts | 7 - src/version3/models/bulkPermissionsRequest.ts | 3 - src/version3/models/changedValue.ts | 3 - src/version3/models/component.ts | 71 -- src/version3/models/compoundClause.ts | 14 - src/version3/models/configuration.ts | 2 - src/version3/models/context.ts | 10 - .../models/contextualConfiguration.ts | 2 - .../models/crateWorkflowStatusDetails.ts | 5 - .../models/createIssueAdjustmentDetails.ts | 13 - src/version3/models/createProjectDetails.ts | 10 +- .../models/createUpdateRoleRequest.ts | 3 - ...FieldContextDefaultValueCascadingOption.ts | 10 - ...mFieldContextDefaultValueMultipleOption.ts | 8 - ...tomFieldContextDefaultValueSingleOption.ts | 8 - .../models/customFieldDefinitionJson.ts | 3 - .../models/customFieldOptionDetails.ts | 9 - src/version3/models/customFieldOptionValue.ts | 7 - src/version3/models/dashboardUser.ts | 15 - .../models/deleteAndReplaceVersion.ts | 3 - src/version3/models/deprecatedWorkflow.ts | 23 - src/version3/models/errorMessage.ts | 4 - src/version3/models/fieldChangedClause.ts | 15 - src/version3/models/fieldMetadata.ts | 24 - src/version3/models/fieldUpdateOperation.ts | 13 - src/version3/models/fieldValueClause.ts | 10 - src/version3/models/fieldWasClause.ts | 17 - src/version3/models/functionOperand.ts | 10 - src/version3/models/globalScope.ts | 3 - src/version3/models/healthCheckResult.ts | 9 - src/version3/models/hierarchy.ts | 6 - src/version3/models/hierarchyLevel.ts | 30 - src/version3/models/id.ts | 3 - src/version3/models/idOrKey.ts | 3 - src/version3/models/index.ts | 55 +- src/version3/models/issue.ts | 3 - .../models/issueAdjustmentContextDetails.ts | 13 - src/version3/models/issueAdjustmentDetails.ts | 17 - .../models/issueAdjustmentIdentifiers.ts | 7 - .../models/issueCommentListRequest.ts | 3 - .../models/issueFieldOptionConfiguration.ts | 2 - src/version3/models/issueFieldOptionCreate.ts | 3 - src/version3/models/issueFieldOptionScope.ts | 5 - src/version3/models/issueTypeCreate.ts | 6 - src/version3/models/issueTypeUpdate.ts | 3 - src/version3/models/issuesJqlMetaData.ts | 3 - src/version3/models/issuesMeta.ts | 3 - src/version3/models/issuesUpdate.ts | 3 - .../models/jiraExpressionEvalContext.ts | 3 - .../models/jiraExpressionEvalRequest.ts | 3 - .../jiraExpressionEvaluationMetaData.ts | 3 - .../models/jiraExpressionsComplexity.ts | 3 - .../models/jiraExpressionsComplexityValue.ts | 3 - .../models/jqlFunctionPrecomputationPage.ts | 19 - src/version3/models/jqlQueryClauseOperand.ts | 2 - .../models/jqlQueryClauseTimePredicate.ts | 8 - src/version3/models/jqlQueryUnitaryOperand.ts | 2 - src/version3/models/jsonNode.ts | 38 - src/version3/models/jsonType.ts | 3 - src/version3/models/keywordOperand.ts | 9 - src/version3/models/linkIssueRequestJson.ts | 3 - src/version3/models/listOperand.ts | 7 - src/version3/models/moveField.ts | 3 - src/version3/models/newUserDetails.ts | 24 - src/version3/models/pageChangelog.ts | 3 - src/version3/models/pageComment.ts | 3 - .../models/pageComponentWithIssueCount.ts | 3 - src/version3/models/pageContext.ts | 22 - .../pageContextForProjectAndIssueType.ts | 3 - src/version3/models/pageCustomFieldContext.ts | 3 - .../pageCustomFieldContextDefaultValue.ts | 3 - .../models/pageCustomFieldContextOption.ts | 3 - .../pageCustomFieldContextProjectMapping.ts | 3 - .../models/pageCustomFieldOptionDetails.ts | 22 - src/version3/models/pageDashboard.ts | 3 - src/version3/models/pageField.ts | 3 - src/version3/models/pageFieldConfiguration.ts | 22 - .../pageFieldConfigurationIssueTypeItem.ts | 3 - .../models/pageFieldConfigurationItem.ts | 3 - .../models/pageFieldConfigurationScheme.ts | 3 - .../pageFieldConfigurationSchemeProjects.ts | 3 - src/version3/models/pageFilterDetails.ts | 3 - src/version3/models/pageGroupDetails.ts | 3 - .../models/pageIssueAdjustmentDetails.ts | 19 - src/version3/models/pageIssueFieldOption.ts | 3 - .../models/pageIssueSecurityLevelMember.ts | 3 - src/version3/models/pageIssueTypeScheme.ts | 3 - .../models/pageIssueTypeSchemeMapping.ts | 3 - .../models/pageIssueTypeSchemeProjects.ts | 3 - .../models/pageIssueTypeScreenScheme.ts | 3 - .../models/pageIssueTypeScreenSchemeItem.ts | 3 - .../pageIssueTypeScreenSchemesProjects.ts | 3 - .../models/pageIssueTypeToContextMapping.ts | 3 - src/version3/models/pageNotificationScheme.ts | 3 - src/version3/models/pageProject.ts | 3 - src/version3/models/pageScreen.ts | 3 - src/version3/models/pageScreenScheme.ts | 3 - src/version3/models/pageScreenWithTab.ts | 3 - src/version3/models/pageString.ts | 3 - src/version3/models/pageUser.ts | 3 - src/version3/models/pageUserDetails.ts | 3 - src/version3/models/pageUserKey.ts | 3 - src/version3/models/pageVersion.ts | 3 - src/version3/models/pageWebhook.ts | 3 - src/version3/models/pageWorkflow.ts | 3 - src/version3/models/pageWorkflowScheme.ts | 3 - .../models/pageWorkflowTransitionRules.ts | 3 - .../models/paginatedResponseComment.ts | 8 - src/version3/models/permissionsKeys.ts | 3 - src/version3/models/project.ts | 10 - src/version3/models/projectFeatures.ts | 7 - .../models/projectFeaturesResponse.ts | 7 - src/version3/models/projectForScope.ts | 24 - src/version3/models/projectIdentifier.ts | 3 - src/version3/models/projectInput.ts | 67 -- .../models/projectIssueTypesHierarchyLevel.ts | 6 - .../models/projectRoleActorsUpdate.ts | 3 - src/version3/models/projectScope.ts | 3 - .../models/publishDraftWorkflowScheme.ts | 7 - src/version3/models/renamedCascadingOption.ts | 7 - src/version3/models/renamedOption.ts | 11 - src/version3/models/searchAutoComplete.ts | 4 - src/version3/models/searchRequest.ts | 3 - src/version3/models/serverInformation.ts | 4 - .../models/simpleApplicationProperty.ts | 3 - src/version3/models/stringList.ts | 1 - src/version3/models/taskProgressObject.ts | 3 - ...askProgressRemoveOptionFromIssuesResult.ts | 3 - .../models/updateCustomFieldOption.ts | 7 - .../models/updateDefaultScreenScheme.ts | 5 - .../models/updateIssueAdjustmentDetails.ts | 16 - src/version3/models/updateProjectDetails.ts | 8 +- src/version3/models/updateUserToGroup.ts | 3 - src/version3/models/userAvatarUrls.ts | 3 - src/version3/models/userMigration.ts | 3 - src/version3/models/userPermission.ts | 26 - src/version3/models/userWrite.ts | 37 - src/version3/models/valueOperand.ts | 5 - src/version3/models/version.ts | 2 - src/version3/models/versionMove.ts | 3 - .../models/workflowCompoundCondition.ts | 10 - src/version3/models/workflowRules.ts | 5 - .../models/workflowSimpleCondition.ts | 8 - src/version3/models/worklogIdsRequest.ts | 3 - src/version3/myself.ts | 53 -- src/version3/parameters/addActorUsers.ts | 2 +- src/version3/parameters/addAttachment.ts | 14 +- src/version3/parameters/addComment.ts | 2 +- src/version3/parameters/addNotifications.ts | 6 - src/version3/parameters/addWorklog.ts | 15 +- src/version3/parameters/analyseExpression.ts | 17 +- .../parameters/assignPermissionScheme.ts | 21 +- .../parameters/associateSchemeWithProject.ts | 3 - src/version3/parameters/bulkGetUsers.ts | 14 - .../parameters/createCustomFieldOptions.ts | 9 - src/version3/parameters/createIssue.ts | 10 +- .../parameters/createIssueAdjustment.ts | 3 - .../createWorkflowTransitionProperty.ts | 2 +- src/version3/parameters/deleteActor.ts | 2 +- src/version3/parameters/deleteAvatar.ts | 2 +- src/version3/parameters/deleteIssue.ts | 2 +- .../parameters/deleteIssueAdjustment.ts | 4 - src/version3/parameters/deletePriority.ts | 8 - src/version3/parameters/deleteStatusesById.ts | 2 +- src/version3/parameters/deleteVersion.ts | 14 - .../deleteWorkflowTransitionProperty.ts | 2 +- src/version3/parameters/deleteWorklog.ts | 13 +- src/version3/parameters/findGroups.ts | 11 - src/version3/parameters/findUsers.ts | 2 +- src/version3/parameters/findUsersAndGroups.ts | 24 +- src/version3/parameters/findUsersForPicker.ts | 6 - .../getAccessibleProjectTypeByKey.ts | 2 +- src/version3/parameters/getAllDashboards.ts | 5 +- .../parameters/getAllIssueTypeSchemes.ts | 12 +- src/version3/parameters/getAllProjects.ts | 18 - .../parameters/getAllSystemAvatars.ts | 2 +- src/version3/parameters/getAllWorkflows.ts | 4 - src/version3/parameters/getAvatarImageByID.ts | 8 +- .../parameters/getAvatarImageByOwner.ts | 6 +- .../parameters/getAvatarImageByType.ts | 6 +- src/version3/parameters/getAvatars.ts | 2 +- src/version3/parameters/getComments.ts | 2 +- src/version3/parameters/getCommentsByIds.ts | 5 +- .../getContextsForFieldDeprecated.ts | 8 - src/version3/parameters/getCurrentUser.ts | 18 +- .../parameters/getCustomFieldConfiguration.ts | 8 +- .../parameters/getDashboardsPaginated.ts | 35 +- src/version3/parameters/getFieldsPaginated.ts | 47 +- src/version3/parameters/getFilters.ts | 16 - .../parameters/getFiltersPaginated.ts | 92 +- src/version3/parameters/getGroup.ts | 11 - src/version3/parameters/getIssue.ts | 26 +- .../parameters/getIssueAdjustments.ts | 14 - .../parameters/getIssueTypeScreenSchemes.ts | 5 +- .../parameters/getNotificationScheme.ts | 23 +- .../getNotificationSchemeForProject.ts | 15 - src/version3/parameters/getOptionsForField.ts | 11 - src/version3/parameters/getPrecomputations.ts | 31 +- .../getProjectComponentsPaginated.ts | 21 +- src/version3/parameters/getProjectRole.ts | 2 +- .../parameters/getProjectTypeByKey.ts | 2 +- .../parameters/getProjectVersionsPaginated.ts | 37 +- src/version3/parameters/getRecent.ts | 25 +- src/version3/parameters/getResolution.ts | 4 - src/version3/parameters/getScreenSchemes.ts | 5 +- src/version3/parameters/getScreens.ts | 7 +- .../parameters/getSecurityLevelMembers.ts | 10 +- src/version3/parameters/getStatusesById.ts | 5 +- .../parameters/getTrashedFieldsPaginated.ts | 25 +- src/version3/parameters/getUser.ts | 18 +- .../parameters/getUserDefaultColumns.ts | 6 - src/version3/parameters/getUserGroups.ts | 12 - src/version3/parameters/getVersion.ts | 18 +- .../getWorkflowTransitionProperties.ts | 2 +- ...getWorkflowTransitionRuleConfigurations.ts | 15 +- .../parameters/getWorkflowsPaginated.ts | 18 +- src/version3/parameters/index.ts | 29 - src/version3/parameters/parseJqlQueries.ts | 9 +- src/version3/parameters/putAddonProperty.ts | 2 - .../parameters/replaceIssueFieldOption.ts | 8 +- src/version3/parameters/search.ts | 3 +- .../parameters/searchForIssuesUsingJql.ts | 8 +- src/version3/parameters/searchPriorities.ts | 2 +- src/version3/parameters/searchProjects.ts | 40 +- src/version3/parameters/searchResolutions.ts | 2 +- .../parameters/setDashboardItemProperty.ts | 8 +- src/version3/parameters/setLocale.ts | 3 - src/version3/parameters/setProjectProperty.ts | 4 +- src/version3/parameters/setUserProperty.ts | 14 - .../setWorkflowSchemeDraftIssueType.ts | 2 +- .../parameters/setWorkflowSchemeIssueType.ts | 2 +- src/version3/parameters/storeAvatar.ts | 3 +- src/version3/parameters/updateComment.ts | 4 +- .../parameters/updateCustomFieldOptions.ts | 9 - .../parameters/updateEntityPropertiesValue.ts | 14 +- .../parameters/updateIssueAdjustment.ts | 6 - src/version3/parameters/updateProjectType.ts | 6 - src/version3/parameters/updateWorklog.ts | 13 +- src/version3/projectProperties.ts | 2 +- src/version3/projectVersions.ts | 43 - src/version3/projects.ts | 114 --- src/version3/userProperties.ts | 2 - src/version3/userSearch.ts | 1 - src/version3/users.ts | 10 - src/version3/workflowSchemeDrafts.ts | 2 +- .../workflowSchemeProjectAssociations.ts | 28 - src/version3/workflowSchemes.ts | 2 +- src/version3/workflows.ts | 37 - tests/integration/agile/sprint.test.ts | 6 +- tests/integration/constants.ts | 20 +- tests/integration/utils/getClient.ts | 1 - tests/integration/version2/avatars.test.ts | 22 + .../version2/issueComments.test.ts | 6 +- tests/integration/version3/avatars.test.ts | 22 + .../version3/issueComments.test.ts | 4 +- tests/unit/agile/board.test.ts | 2 +- tests/unit/agile/issue.test.ts | 2 +- tests/unit/agile/sprint.test.ts | 2 +- tests/unit/clients/baseClient.test.ts | 3 - tests/unit/createClient.test.ts | 2 +- .../services/authenticationService.test.ts | 60 +- tests/unit/version2/appMigration.test.ts | 23 +- tests/unit/version2/issueComments.test.ts | 4 +- tests/unit/version2/issueFields.test.ts | 2 +- tests/unit/version2/issueLinks.test.ts | 14 +- tests/unit/version2/issuePriorities.test.ts | 2 +- tests/unit/version2/issueRemoteLinks.test.ts | 2 +- tests/unit/version2/issueResolutions.test.ts | 13 - tests/unit/version2/issueSearch.test.ts | 2 +- tests/unit/version2/issueVotes.test.ts | 2 +- tests/unit/version2/issueWatcher.test.ts | 2 +- tests/unit/version2/issues.test.ts | 2 +- tests/unit/version2/myself.test.ts | 2 +- tests/unit/version2/projectVersions.test.ts | 20 +- tests/unit/version2/projects.test.ts | 23 - tests/unit/version2/workflowStatuses.test.ts | 2 +- tests/unit/version3/appMigration.test.ts | 22 - tests/unit/version3/issueComments.test.ts | 7 +- tests/unit/version3/issueFields.test.ts | 2 +- tests/unit/version3/issueLinks.test.ts | 2 +- tests/unit/version3/issuePriorities.test.ts | 2 +- tests/unit/version3/issueRemoteLinks.test.ts | 2 +- tests/unit/version3/issueResolutions.test.ts | 13 - tests/unit/version3/issueSearch.test.ts | 2 +- tests/unit/version3/issueVotes.test.ts | 2 +- tests/unit/version3/issueWatcher.test.ts | 2 +- tests/unit/version3/issues.test.ts | 2 +- tests/unit/version3/myself.test.ts | 2 +- tests/unit/version3/projectVersions.test.ts | 20 +- tests/unit/version3/projects.test.ts | 23 - tests/unit/version3/workflowStatuses.test.ts | 2 +- tsconfig.lint.json | 1 + 747 files changed, 1728 insertions(+), 8339 deletions(-) delete mode 100644 src/agile/models/basicUser.ts delete mode 100644 src/agile/models/boardAdmins.ts delete mode 100644 src/agile/models/boardConfig.ts delete mode 100644 src/agile/models/boardCreate.ts delete mode 100644 src/agile/models/boardFeature.ts delete mode 100644 src/agile/models/boardFeatureResponse.ts delete mode 100644 src/agile/models/boardFeatureToggleRequest.ts delete mode 100644 src/agile/models/boardFilter.ts delete mode 100644 src/agile/models/boardLocation.ts delete mode 100644 src/agile/models/changeHistory.ts delete mode 100644 src/agile/models/changeItem.ts delete mode 100644 src/agile/models/changelog.ts delete mode 100644 src/agile/models/color.ts delete mode 100644 src/agile/models/column.ts delete mode 100644 src/agile/models/columnConfig.ts delete mode 100644 src/agile/models/editMeta.ts delete mode 100644 src/agile/models/entry.ts delete mode 100644 src/agile/models/epicRankRequest.ts delete mode 100644 src/agile/models/epicUpdate.ts delete mode 100644 src/agile/models/estimationConfig.ts delete mode 100644 src/agile/models/estimationField.ts delete mode 100644 src/agile/models/feature.ts delete mode 100644 src/agile/models/featureResponse.ts delete mode 100644 src/agile/models/featureToggleRequest.ts delete mode 100644 src/agile/models/fieldEdit.ts delete mode 100644 src/agile/models/fieldMeta.ts delete mode 100644 src/agile/models/getFeaturesForProject.ts delete mode 100644 src/agile/models/historyMetadata.ts delete mode 100644 src/agile/models/historyMetadataParticipant.ts delete mode 100644 src/agile/models/issueAssignRequest.ts delete mode 100644 src/agile/models/issueRankRequest.ts delete mode 100644 src/agile/models/location.ts delete mode 100644 src/agile/models/moveIssuesToBoard.ts delete mode 100644 src/agile/models/opsbar.ts delete mode 100644 src/agile/models/page.ts delete mode 100644 src/agile/models/pageBoard.ts delete mode 100644 src/agile/models/pageBoardFilter.ts delete mode 100644 src/agile/models/pageQuickFilter.ts delete mode 100644 src/agile/models/partialSuccess.ts delete mode 100644 src/agile/models/quickFilter.ts delete mode 100644 src/agile/models/rankingConfig.ts delete mode 100644 src/agile/models/relation.ts delete mode 100644 src/agile/models/report.ts delete mode 100644 src/agile/models/reportsResponse.ts delete mode 100644 src/agile/models/simpleLink.ts delete mode 100644 src/agile/models/sprintCreate.ts delete mode 100644 src/agile/models/sprintSwap.ts delete mode 100644 src/agile/models/statusCategoryJson.ts delete mode 100644 src/agile/models/statusJson.ts delete mode 100644 src/agile/models/subquery.ts delete mode 100644 src/agile/models/userAvatarUrls.ts delete mode 100644 src/agile/parameters/getFeaturesForProject.ts delete mode 100644 src/agile/project.ts delete mode 100644 src/serviceDesk/models/changeDetails.ts delete mode 100644 src/serviceDesk/models/changelog.ts delete mode 100644 src/serviceDesk/models/errorResponse.ts delete mode 100644 src/serviceDesk/models/expandable.ts delete mode 100644 src/serviceDesk/models/fieldMetadata.ts delete mode 100644 src/serviceDesk/models/historyMetadata.ts delete mode 100644 src/serviceDesk/models/historyMetadataParticipant.ts delete mode 100644 src/serviceDesk/models/i18nErrorMessage.ts delete mode 100644 src/serviceDesk/models/includedFields.ts delete mode 100644 src/serviceDesk/models/issueUpdateMetadata.ts delete mode 100644 src/serviceDesk/models/linkGroup.ts delete mode 100644 src/serviceDesk/models/linkable.ts delete mode 100644 src/serviceDesk/models/linkableAttachmentLink.ts delete mode 100644 src/serviceDesk/models/linkableCustomerRequestLink.ts delete mode 100644 src/serviceDesk/models/linkableUserLink.ts delete mode 100644 src/serviceDesk/models/operations.ts delete mode 100644 src/serviceDesk/models/pageOfChangelogs.ts delete mode 100644 src/serviceDesk/models/simpleLink.ts delete mode 100644 src/services/authenticationService/authenticationService.ts delete mode 100644 src/services/authenticationService/authentications/createJWTAuthentication.ts delete mode 100644 src/services/authenticationService/authentications/createOAuthAuthenticationToken.ts create mode 100644 src/services/authenticationService/getAuthenticationToken.ts delete mode 100644 src/version2/instanceInformation.ts delete mode 100644 src/version2/issueAdjustmentsApps.ts delete mode 100644 src/version2/models/addNotificationsDetails.ts delete mode 100644 src/version2/models/attachmentArchive.ts create mode 100644 src/version2/models/avatarWithDetails.ts delete mode 100644 src/version2/models/bulkCreateCustomFieldOptionRequest.ts delete mode 100644 src/version2/models/component.ts delete mode 100644 src/version2/models/compoundClause.ts delete mode 100644 src/version2/models/context.ts delete mode 100644 src/version2/models/crateWorkflowStatusDetails.ts delete mode 100644 src/version2/models/createIssueAdjustmentDetails.ts delete mode 100644 src/version2/models/customFieldContextDefaultValueCascadingOption.ts delete mode 100644 src/version2/models/customFieldContextDefaultValueMultipleOption.ts delete mode 100644 src/version2/models/customFieldContextDefaultValueSingleOption.ts delete mode 100644 src/version2/models/customFieldOptionDetails.ts delete mode 100644 src/version2/models/customFieldOptionValue.ts delete mode 100644 src/version2/models/customFieldValueUpdateRequest.ts delete mode 100644 src/version2/models/deleteAndReplaceVersion.ts delete mode 100644 src/version2/models/deprecatedWorkflow.ts delete mode 100644 src/version2/models/errorMessage.ts delete mode 100644 src/version2/models/fieldChangedClause.ts delete mode 100644 src/version2/models/fieldUpdateOperation.ts delete mode 100644 src/version2/models/fieldValueClause.ts delete mode 100644 src/version2/models/fieldWasClause.ts delete mode 100644 src/version2/models/functionOperand.ts delete mode 100644 src/version2/models/healthCheckResult.ts delete mode 100644 src/version2/models/issueAdjustmentContextDetails.ts delete mode 100644 src/version2/models/issueAdjustmentDetails.ts delete mode 100644 src/version2/models/issueAdjustmentIdentifiers.ts delete mode 100644 src/version2/models/jqlQueryClauseOperand.ts delete mode 100644 src/version2/models/jqlQueryClauseTimePredicate.ts delete mode 100644 src/version2/models/jqlQueryUnitaryOperand.ts delete mode 100644 src/version2/models/jsonNode.ts delete mode 100644 src/version2/models/keywordOperand.ts delete mode 100644 src/version2/models/listOperand.ts delete mode 100644 src/version2/models/pageContext.ts delete mode 100644 src/version2/models/pageCustomFieldOptionDetails.ts delete mode 100644 src/version2/models/pageIssueAdjustmentDetails.ts delete mode 100644 src/version2/models/paginatedResponseComment.ts delete mode 100644 src/version2/models/projectFeatures.ts delete mode 100644 src/version2/models/projectFeaturesResponse.ts delete mode 100644 src/version2/models/projectForScope.ts delete mode 100644 src/version2/models/projectInput.ts delete mode 100644 src/version2/models/publishDraftWorkflowScheme.ts delete mode 100644 src/version2/models/removeOptionFromIssuesResult.ts delete mode 100644 src/version2/models/renamedCascadingOption.ts delete mode 100644 src/version2/models/renamedOption.ts delete mode 100644 src/version2/models/screenID.ts delete mode 100644 src/version2/models/searchAutoCompleteFilter.ts delete mode 100644 src/version2/models/simpleErrorCollection.ts delete mode 100644 src/version2/models/stringList.ts delete mode 100644 src/version2/models/taskProgressRemoveOptionFromIssuesResult.ts delete mode 100644 src/version2/models/updateCustomFieldOption.ts delete mode 100644 src/version2/models/updateDefaultScreenScheme.ts delete mode 100644 src/version2/models/updateIssueAdjustmentDetails.ts delete mode 100644 src/version2/models/userFilter.ts delete mode 100644 src/version2/models/userPermission.ts delete mode 100644 src/version2/models/userWrite.ts delete mode 100644 src/version2/models/valueOperand.ts delete mode 100644 src/version2/models/workflowCompoundCondition.ts delete mode 100644 src/version2/models/workflowSimpleCondition.ts delete mode 100644 src/version2/parameters/addNotifications.ts delete mode 100644 src/version2/parameters/associateSchemeWithProject.ts delete mode 100644 src/version2/parameters/createCustomFieldOptions.ts delete mode 100644 src/version2/parameters/createIssueAdjustment.ts delete mode 100644 src/version2/parameters/deleteIssueAdjustment.ts delete mode 100644 src/version2/parameters/deletePriority.ts delete mode 100644 src/version2/parameters/deleteVersion.ts delete mode 100644 src/version2/parameters/getAllProjects.ts delete mode 100644 src/version2/parameters/getAllWorkflows.ts delete mode 100644 src/version2/parameters/getContextsForFieldDeprecated.ts delete mode 100644 src/version2/parameters/getFilters.ts delete mode 100644 src/version2/parameters/getGroup.ts delete mode 100644 src/version2/parameters/getIssueAdjustments.ts delete mode 100644 src/version2/parameters/getOptionsForField.ts delete mode 100644 src/version2/parameters/getResolution.ts delete mode 100644 src/version2/parameters/setLocale.ts delete mode 100644 src/version2/parameters/updateCustomFieldOptions.ts delete mode 100644 src/version2/parameters/updateIssueAdjustment.ts delete mode 100644 src/version2/parameters/updateProjectType.ts delete mode 100644 src/version3/issueAdjustmentsApps.ts delete mode 100644 src/version3/models/addNotificationsDetails.ts delete mode 100644 src/version3/models/attachmentArchive.ts create mode 100644 src/version3/models/avatarWithDetails.ts delete mode 100644 src/version3/models/bulkCreateCustomFieldOptionRequest.ts delete mode 100644 src/version3/models/component.ts delete mode 100644 src/version3/models/compoundClause.ts delete mode 100644 src/version3/models/context.ts delete mode 100644 src/version3/models/crateWorkflowStatusDetails.ts delete mode 100644 src/version3/models/createIssueAdjustmentDetails.ts delete mode 100644 src/version3/models/customFieldContextDefaultValueCascadingOption.ts delete mode 100644 src/version3/models/customFieldContextDefaultValueMultipleOption.ts delete mode 100644 src/version3/models/customFieldContextDefaultValueSingleOption.ts delete mode 100644 src/version3/models/customFieldOptionDetails.ts delete mode 100644 src/version3/models/customFieldOptionValue.ts delete mode 100644 src/version3/models/deprecatedWorkflow.ts delete mode 100644 src/version3/models/errorMessage.ts delete mode 100644 src/version3/models/fieldChangedClause.ts delete mode 100644 src/version3/models/fieldMetadata.ts delete mode 100644 src/version3/models/fieldUpdateOperation.ts delete mode 100644 src/version3/models/fieldValueClause.ts delete mode 100644 src/version3/models/fieldWasClause.ts delete mode 100644 src/version3/models/functionOperand.ts delete mode 100644 src/version3/models/healthCheckResult.ts delete mode 100644 src/version3/models/issueAdjustmentContextDetails.ts delete mode 100644 src/version3/models/issueAdjustmentDetails.ts delete mode 100644 src/version3/models/issueAdjustmentIdentifiers.ts delete mode 100644 src/version3/models/jqlFunctionPrecomputationPage.ts delete mode 100644 src/version3/models/jqlQueryClauseOperand.ts delete mode 100644 src/version3/models/jqlQueryClauseTimePredicate.ts delete mode 100644 src/version3/models/jqlQueryUnitaryOperand.ts delete mode 100644 src/version3/models/jsonNode.ts delete mode 100644 src/version3/models/keywordOperand.ts delete mode 100644 src/version3/models/listOperand.ts delete mode 100644 src/version3/models/pageContext.ts delete mode 100644 src/version3/models/pageCustomFieldOptionDetails.ts delete mode 100644 src/version3/models/pageFieldConfiguration.ts delete mode 100644 src/version3/models/pageIssueAdjustmentDetails.ts delete mode 100644 src/version3/models/paginatedResponseComment.ts delete mode 100644 src/version3/models/projectFeatures.ts delete mode 100644 src/version3/models/projectFeaturesResponse.ts delete mode 100644 src/version3/models/projectForScope.ts delete mode 100644 src/version3/models/projectInput.ts delete mode 100644 src/version3/models/publishDraftWorkflowScheme.ts delete mode 100644 src/version3/models/renamedCascadingOption.ts delete mode 100644 src/version3/models/renamedOption.ts delete mode 100644 src/version3/models/searchAutoComplete.ts delete mode 100644 src/version3/models/stringList.ts delete mode 100644 src/version3/models/updateCustomFieldOption.ts delete mode 100644 src/version3/models/updateDefaultScreenScheme.ts delete mode 100644 src/version3/models/updateIssueAdjustmentDetails.ts delete mode 100644 src/version3/models/userPermission.ts delete mode 100644 src/version3/models/userWrite.ts delete mode 100644 src/version3/models/valueOperand.ts delete mode 100644 src/version3/models/workflowCompoundCondition.ts delete mode 100644 src/version3/models/workflowSimpleCondition.ts delete mode 100644 src/version3/parameters/addNotifications.ts delete mode 100644 src/version3/parameters/associateSchemeWithProject.ts delete mode 100644 src/version3/parameters/createCustomFieldOptions.ts delete mode 100644 src/version3/parameters/createIssueAdjustment.ts delete mode 100644 src/version3/parameters/deleteIssueAdjustment.ts delete mode 100644 src/version3/parameters/deletePriority.ts delete mode 100644 src/version3/parameters/deleteVersion.ts delete mode 100644 src/version3/parameters/getAllProjects.ts delete mode 100644 src/version3/parameters/getAllWorkflows.ts delete mode 100644 src/version3/parameters/getContextsForFieldDeprecated.ts delete mode 100644 src/version3/parameters/getFilters.ts delete mode 100644 src/version3/parameters/getGroup.ts delete mode 100644 src/version3/parameters/getIssueAdjustments.ts delete mode 100644 src/version3/parameters/getNotificationSchemeForProject.ts delete mode 100644 src/version3/parameters/getOptionsForField.ts delete mode 100644 src/version3/parameters/getResolution.ts delete mode 100644 src/version3/parameters/setLocale.ts delete mode 100644 src/version3/parameters/updateCustomFieldOptions.ts delete mode 100644 src/version3/parameters/updateIssueAdjustment.ts delete mode 100644 src/version3/parameters/updateProjectType.ts create mode 100644 tests/integration/version2/avatars.test.ts create mode 100644 tests/integration/version3/avatars.test.ts delete mode 100644 tests/unit/version2/issueResolutions.test.ts delete mode 100644 tests/unit/version2/projects.test.ts delete mode 100644 tests/unit/version3/issueResolutions.test.ts delete mode 100644 tests/unit/version3/projects.test.ts diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index c242d53887..4d57ef13ce 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -7,7 +7,7 @@ jobs: runs-on: self-hosted strategy: matrix: - node-version: [16.x, 18.x] + node-version: [18.x, 20.x] steps: - name: Checkout sources uses: actions/checkout@v4 @@ -26,7 +26,7 @@ jobs: runs-on: self-hosted strategy: matrix: - node-version: [16.x, 18.x] + node-version: [18.x, 20.x] steps: - name: Linting run: npm run lint @@ -39,7 +39,7 @@ jobs: runs-on: self-hosted strategy: matrix: - node-version: [16.x, 18.x] + node-version: [18.x, 20.x] steps: - name: Running unit tests run: npm run test:unit @@ -53,7 +53,7 @@ jobs: strategy: max-parallel: 1 matrix: - node-version: [16.x, 18.x] + node-version: [18.x, 20.x] steps: - name: Creating `.env` file run: | diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index a1c1999347..f712277f12 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -8,7 +8,7 @@ jobs: steps: - name: Checkout sources uses: actions/checkout@v4 - - name: Use Node.js 16.x.x + - name: Use Node.js 18.x.x uses: actions/setup-node@v3 with: node-version: 18 @@ -52,11 +52,8 @@ jobs: run: npm run test:integration publish: - name: Publish + name: Package publish needs: - - build - - lint - - test_unit - test_integration runs-on: self-hosted steps: @@ -67,6 +64,8 @@ jobs: publish-docs: name: Docs publish + needs: + - test_integration runs-on: self-hosted steps: - name: Checkout code @@ -85,6 +84,10 @@ jobs: - name: Generate docs run: npm run doc + - name: Extract version + id: pkg + run: echo "::set-output name=version::$(node -p "require('./package.json').version")" + - name: Checkout docs branch uses: actions/checkout@v4 with: @@ -100,5 +103,5 @@ jobs: git config user.name "GitHub Actions" git config user.email "actions@github.com" git add . - git commit -m "Update documentation" + git commit -m "Update documentation for version v${{ steps.pkg.outputs.version }}" git push diff --git a/CHANGELOG.md b/CHANGELOG.md index 76635fc731..cb783aac9d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,22 @@ # Jira.js changelog +### 3.0.0 + +#### **Breaking Changes:** +- **Avatar Endpoints Updates:** + - Methods `avatar.getAvatarImageByID`, `getAvatarImageByType`, and `getAvatarImageByOwner` have an updated return type. Avatars will now be returned as binary data. + - `storeAvatar` endpoint has been fixed. It now both accepts and sends the `avatar` property. + +- **Authentication Changes:** + - Removed OAuth and JWT authentication. This might be reintroduced with proper testing support in the future. + +- **API Clean-Up:** + - Deprecated and unused components from Agile, ServiceDesk, Version2, and Version3 APIs have been removed. + +#### **Enhancements:** + - Improved browser capability. + - Enhanced parameter typings. + ### 2.20.1 - [#277](https://github.com/MrRefactoring/jira.js/issues/277) newErrorHandling provides additional error codes. diff --git a/README.md b/README.md index 38eb28f764..851c00efac 100644 --- a/README.md +++ b/README.md @@ -19,13 +19,10 @@ Usability, consistency, and performance are key focuses of jira.js, and it also - [Installation](#installation) - [Documentation](#documentation) -- [Deprecation warnings](#deprecation-warnings) - [Usage](#usage) - [Authentication](#authentication) - [Basic](#basic-authentication) - - [OAuth](#oauth) - [OAuth 2.0](#oauth-20) - - [JWT](#jwt) - [Personal access token](#personal-access-token) - [Example and using algorithm](#example-and-using-algorithm) - [Decreasing Webpack bundle size](#decreasing-webpack-bundle-size) @@ -34,7 +31,7 @@ Usability, consistency, and performance are key focuses of jira.js, and it also ## Installation -**Node.js 10.0.0 or newer is required.** +**Node.js 18.0.0 or newer is required.** Install with the npm: @@ -52,56 +49,6 @@ yarn add jira.js You can find the documentation [here](https://mrrefactoring.github.io/jira.js/). -## Deprecation warnings - -1. Deprecation warning: New error handling mechanism added. Please use `newErrorHandling: true` in config -> We are using a new error handling mechanism (instead throwing raw axios error will be showed API response). For enable it, make following changes in your config: -> ```ts -> const client = new Version3Client({ -> host: '...', -> newErrorHandling: true, // This flag enable new error handling. -> }); -> -> // Examples -> -> /** Old error handling **/ -> -> const client = new Version3Client({ host: '...' }); -> -> client.issues.createIssue(); -> -> // Output: -> // { -> // code: 'ERR_BAD_REQUEST', -> // config: { a lot of stuff here }, -> // request: { a lot of stuff here }, -> // response: { -> // a lot of stuff here -> // data: { -> // errorMessages: [], -> // errors: { project: 'Specify a valid project ID or key' } -> // }, -> // a lot of stuff here -> // }, -> // a lot of stuff here -> // } -> -> /** New error handling **/ -> -> const client = new Version3Client({ host: '...', newErrorHandling: true }); -> -> client.issues.createIssue(); -> -> // Output: -> // { -> // code: 'ERR_BAD_REQUEST', -> // status: 400, -> // errorMessages: [], -> // errors: { project: 'Specify a valid project ID or key' } -> // } -> ``` - - ## Usage #### Authentication @@ -144,24 +91,6 @@ const client = new Version3Client({ }); ``` -##### [OAuth](https://developer.atlassian.com/cloud/jira/platform/jira-rest-api-oauth-authentication/) - -```typescript -import { Version3Client } from 'jira.js'; - -const client = new Version3Client({ - host: 'https://your-domain.atlassian.net', - authentication: { - oauth: { - consumerKey: 'your consumer key', - consumerSecret: '-----BEGIN RSA PRIVATE KEY-----\n" + "some private key\n" + "-----END RSA PRIVATE KEY-----', - accessToken: 'your access token', - tokenSecret: 'your token secret', - }, - }, -}); -``` - ##### [OAuth 2.0](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/) Only the authorization token is currently supported. To release it, you need to read the [documentation](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/) and write your own code to get the token. @@ -181,23 +110,6 @@ const client = new Version3Client({ }); ``` -##### [JWT](https://developer.atlassian.com/cloud/jira/platform/understanding-jwt-for-connect-apps/) - -```typescript -import { Version3Client } from 'jira.js'; - -const client = new Version3Client({ - host: 'https://your-domain.atlassian.net', - authentication: { - jwt: { - issuer: 'ISSUER', - secret: 'shhhh', - expiryTimeSeconds: 180, - }, - }, -}); -``` - ##### [Personal access token](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html) ```typescript @@ -231,7 +143,6 @@ const client = new Version3Client({ apiToken, }, }, - newErrorHandling: true, }); async function main() { @@ -310,9 +221,7 @@ Available groups: - [filterSharing](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-filter-sharing/#api-group-filter-sharing) - [groupAndUserPicker](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-group-and-user-picker/#api-group-group-and-user-picker) - [groups](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-groups/#api-group-groups) - - [instanceInformation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-instance-information/#api-group-instance-information) - [issues](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issues/#api-group-issues) - - [issueAdjustmentsApps](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-adjustments--apps-/#api-group-issue-adjustments--apps-) - [issueAttachments](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-attachments/#api-group-issue-attachments) - [issueComments](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-comments/#api-group-issue-comments) - [issueCustomFieldConfigurationApps](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-issue-custom-field-configuration--apps-/#api-group-issue-custom-field-configuration--apps-) @@ -403,7 +312,6 @@ Available groups: - [groups](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/#api-group-groups) - [instanceInformation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-instance-information/#api-group-instance-information) - [issues](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-group-issues) - - [issueAdjustmentsApps](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-adjustments--apps-/#api-group-issue-adjustments--apps-) - [issueAttachments](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-attachments/#api-group-issue-attachments) - [issueComments](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments/#api-group-issue-comments) - [issueCustomFieldConfigurationApps](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-configuration--apps-/#api-group-issue-custom-field-configuration--apps-) diff --git a/examples/package-lock.json b/examples/package-lock.json index 6adf38abaa..5acff2fb39 100644 --- a/examples/package-lock.json +++ b/examples/package-lock.json @@ -12,7 +12,7 @@ "jira.js": "latest" }, "devDependencies": { - "@types/node": "^20.8.2", + "@types/node": "^20.8.6", "ts-node": "^10.9.1", "typescript": "^5.2.2" } @@ -79,10 +79,13 @@ "dev": true }, "node_modules/@types/node": { - "version": "20.8.2", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.8.2.tgz", - "integrity": "sha512-Vvycsc9FQdwhxE3y3DzeIxuEJbWGDsnrxvMADzTDF/lcdR9/K+AQIeAghTQsHtotg/q0j3WEOYS/jQgSdWue3w==", - "dev": true + "version": "20.8.6", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.8.6.tgz", + "integrity": "sha512-eWO4K2Ji70QzKUqRy6oyJWUeB7+g2cRagT3T/nxYibYcT4y2BDL8lqolRXjTHmkZCdJfIPaY73KbJAZmcryxTQ==", + "dev": true, + "dependencies": { + "undici-types": "~5.25.1" + } }, "node_modules/acorn": { "version": "8.10.0", @@ -205,9 +208,9 @@ } }, "node_modules/jira.js": { - "version": "2.20.0", - "resolved": "https://registry.npmjs.org/jira.js/-/jira.js-2.20.0.tgz", - "integrity": "sha512-CjfmK7TJVf/ZKN+dXQPZzNxvrWsTzBrQ6ALAVtEV2+sJGANkkA3OWPmAgg4Pwq9Xi88PhKz1fNXemNRm8lGH9w==", + "version": "2.20.1", + "resolved": "https://registry.npmjs.org/jira.js/-/jira.js-2.20.1.tgz", + "integrity": "sha512-ZFlFAVTEaw86OemQ8BVyVSV0YDZqMI6WVc08Th5GgqVEODW4gmhXLOxqSmCasRJMMVAtI1LrFlFFTf9GnFaUhg==", "dependencies": { "atlassian-jwt": "^2.0.2", "axios": "^1.5.1", @@ -325,6 +328,12 @@ "node": ">=14.17" } }, + "node_modules/undici-types": { + "version": "5.25.3", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.25.3.tgz", + "integrity": "sha512-Ga1jfYwRn7+cP9v8auvEXN1rX3sWqlayd4HP7OKk4mZWylEmu3KzXDUGrQUN6Ol7qo1gPvB2e5gX6udnyEPgdA==", + "dev": true + }, "node_modules/v8-compile-cache-lib": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", diff --git a/examples/package.json b/examples/package.json index 77c882adb7..01fa1c0f29 100644 --- a/examples/package.json +++ b/examples/package.json @@ -12,7 +12,7 @@ }, "license": "MIT", "devDependencies": { - "@types/node": "^20.8.2", + "@types/node": "^20.8.6", "ts-node": "^10.9.1", "typescript": "^5.2.2" }, diff --git a/examples/src/addFixVersion.ts b/examples/src/addFixVersion.ts index 4404758aa2..f100fcce27 100644 --- a/examples/src/addFixVersion.ts +++ b/examples/src/addFixVersion.ts @@ -1,6 +1,6 @@ -import {Version3Client} from "jira.js"; -import { apiToken, email, host } from "./credentials"; -import {createIssue} from "./utils"; +import { createIssue } from './utils'; +import { Version3Client } from 'jira.js'; +import { apiToken, email, host } from './credentials'; async function addFixVersion() { const client = new Version3Client({ @@ -8,16 +8,15 @@ async function addFixVersion() { authentication: { basic: { email, apiToken }, }, - newErrorHandling: true, }); const { id: issueIdOrKey } = await createIssue(client); const fix = await client.issueProperties.setIssueProperty({ issueIdOrKey, - propertyKey: "fixVersion", + propertyKey: 'fixVersion', // @ts-ignore - propertyValue: "N/a", + propertyValue: 'N/a', }); console.log(fix); diff --git a/examples/src/addWorklog.ts b/examples/src/addWorklog.ts index e5b0cab685..a7631bf6a0 100644 --- a/examples/src/addWorklog.ts +++ b/examples/src/addWorklog.ts @@ -1,6 +1,6 @@ -import { createIssue } from "./utils"; -import { Version3Client } from "jira.js"; -import { apiToken, email, host } from "./credentials"; +import { createIssue } from './utils'; +import { Version3Client } from 'jira.js'; +import { apiToken, email, host } from './credentials'; async function addWorklog() { const client = new Version3Client({ @@ -8,7 +8,6 @@ async function addWorklog() { authentication: { basic: { email, apiToken }, }, - newErrorHandling: true, }); // Used to reduce the amount of code that is not directly related to creating a worklog @@ -21,7 +20,7 @@ async function addWorklog() { timeSpentSeconds: 60, // Required one of `timeSpentSeconds` or `timeSpent` }); - console.log(`Worklog successfully added for Issue Id: ${worklog.issueId}`) + console.log(`Worklog successfully added for Issue Id: ${worklog.issueId}`); } addWorklog().catch(e => { diff --git a/examples/src/basic.ts b/examples/src/basic.ts index de432bdcb2..735f9c05d9 100644 --- a/examples/src/basic.ts +++ b/examples/src/basic.ts @@ -1,12 +1,11 @@ import { Version3Client } from 'jira.js'; -import { host, email, apiToken } from './credentials'; +import { apiToken, email, host } from './credentials'; const client = new Version3Client({ host, authentication: { basic: { email, apiToken }, }, - newErrorHandling: true, }); async function main() { @@ -19,12 +18,12 @@ async function main() { fields: { summary: 'My first issue', issuetype: { - name: 'Task' + name: 'Task', }, project: { key: project.key, }, - } + }, }); const issue = await client.issues.getIssue({ issueIdOrKey: id }); @@ -35,7 +34,7 @@ async function main() { const { id } = await client.projects.createProject({ key: 'PROJECT', - name: "My Project", + name: 'My Project', leadAccountId: myself.accountId, projectTypeKey: 'software', }); diff --git a/examples/src/getAllWorklogs.ts b/examples/src/getAllWorklogs.ts index ccf77ac9e0..04d4bc49d8 100644 --- a/examples/src/getAllWorklogs.ts +++ b/examples/src/getAllWorklogs.ts @@ -1,14 +1,13 @@ -import { Version3Client } from "jira.js"; -import { addWorklog, createIssue } from "./utils"; -import { apiToken, email, host } from "./credentials"; +import { Version3Client } from 'jira.js'; +import { addWorklog, createIssue } from './utils'; +import { apiToken, email, host } from './credentials'; async function getAllWorklogs() { const client = new Version3Client({ host, authentication: { - basic: { email, apiToken } + basic: { email, apiToken }, }, - newErrorHandling: true, }); // Used to reduce the amount of code that is not directly related to getting a worklogs diff --git a/examples/src/utils/addWorklog.ts b/examples/src/utils/addWorklog.ts index 245991d3ff..fb0bae502f 100644 --- a/examples/src/utils/addWorklog.ts +++ b/examples/src/utils/addWorklog.ts @@ -1,9 +1,9 @@ -import { Version3Client, Version3Models } from "jira.js"; +import { Version3Client, Version3Models } from 'jira.js'; export const addWorklog = async (client: Version3Client, issue: Version3Models.Issue) => { await client.issueWorklogs.addWorklog({ issueIdOrKey: issue.id, comment: 'My first worklog', timeSpentSeconds: 60, - }) + }); }; diff --git a/examples/src/utils/createIssue.ts b/examples/src/utils/createIssue.ts index aef86cb5e1..b44b7fb0d1 100644 --- a/examples/src/utils/createIssue.ts +++ b/examples/src/utils/createIssue.ts @@ -1,4 +1,4 @@ -import { Version3Client } from "jira.js"; +import { Version3Client } from 'jira.js'; export const createIssue = async (client: Version3Client) => { const projects = await client.projects.getAllProjects(); @@ -10,12 +10,12 @@ export const createIssue = async (client: Version3Client) => { fields: { summary: 'My first issue', issuetype: { - name: 'Task' + name: 'Task', }, project: { key, }, - } + }, }); return client.issues.getIssue({ issueIdOrKey: id }); diff --git a/package-lock.json b/package-lock.json index 78947e2315..785d6a4656 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,41 +1,37 @@ { "name": "jira.js", - "version": "2.20.1", + "version": "3.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "jira.js", - "version": "2.20.1", + "version": "3.0.0", "license": "MIT", "dependencies": { - "atlassian-jwt": "^2.0.2", "axios": "^1.5.1", "form-data": "^4.0.0", - "oauth": "^0.10.0", "tslib": "^2.6.2" }, "devDependencies": { "@swc-node/register": "^1.6.8", - "@swc/helpers": "^0.5.2", - "@types/express": "^4.17.18", - "@types/node": "^20.8.2", - "@types/oauth": "^0.9.2", - "@types/sinon": "^10.0.18", - "@typescript-eslint/eslint-plugin": "^6.7.4", - "@typescript-eslint/parser": "^6.7.4", + "@swc/helpers": "^0.5.3", + "@types/node": "^18.18.5", + "@types/sinon": "^10.0.19", + "@typescript-eslint/eslint-plugin": "^6.7.5", + "@typescript-eslint/parser": "^6.7.5", "ava": "^5.3.1", "dotenv": "^16.3.1", - "eslint": "^8.50.0", + "eslint": "^8.51.0", "eslint-config-airbnb": "^19.0.4", "eslint-config-airbnb-typescript": "^17.1.0", "eslint-import-resolver-typescript": "^3.6.1", "eslint-plugin-import": "^2.28.1", "prettier": "^3.0.3", - "prettier-plugin-jsdoc": "1.0.2", - "sinon": "^16.0.0", + "prettier-plugin-jsdoc": "^1.1.1", + "sinon": "^16.1.0", "ts-node": "^10.9.1", - "typedoc": "^0.25.1", + "typedoc": "^0.25.2", "typedoc-plugin-extras": "^3.0.0", "typescript": "^5.2.2" } @@ -50,9 +46,9 @@ } }, "node_modules/@babel/runtime": { - "version": "7.23.1", - "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.23.1.tgz", - "integrity": "sha512-hC2v6p8ZSI/W0HUzh3V8C5g+NwSKzKPtJwSpTjwl0o297GP9+ZLQSkdvHz46CM3LqyoXxq+5G9komY+eSqSO0g==", + "version": "7.23.2", + "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.23.2.tgz", + "integrity": "sha512-mM8eg4yl5D6i3lu2QKPuPH4FArvJ8KhTofbE7jwMUv9KX5mBvwPAqnV3MlyBNqdp9RyRKP6Yck8TrfYrPvX3bg==", "dev": true, "peer": true, "dependencies": { @@ -122,9 +118,9 @@ } }, "node_modules/@eslint/js": { - "version": "8.50.0", - "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.50.0.tgz", - "integrity": "sha512-NCC3zz2+nvYd+Ckfh87rA47zfu2QsQpvc6k1yzTk+b9KzRj0wkGa8LSoGOXN6Zv4lRf/EIoZ80biDh9HOI+RNQ==", + "version": "8.51.0", + "resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.51.0.tgz", + "integrity": "sha512-HxjQ8Qn+4SI3/AFv6sOrDB+g6PpUTDwSJiQqOrnneEk8L71161srI9gjzzZvYVbzHiVg/BvcH95+cK/zfIt4pg==", "dev": true, "engines": { "node": "^12.22.0 || ^14.17.0 || >=16.0.0" @@ -316,9 +312,9 @@ } }, "node_modules/@swc/core": { - "version": "1.3.92", - "resolved": "https://registry.npmjs.org/@swc/core/-/core-1.3.92.tgz", - "integrity": "sha512-vx0vUrf4YTEw59njOJ46Ha5i0cZTMYdRHQ7KXU29efN1MxcmJH2RajWLPlvQarOP1ab9iv9cApD7SMchDyx2vA==", + "version": "1.3.93", + "resolved": "https://registry.npmjs.org/@swc/core/-/core-1.3.93.tgz", + "integrity": "sha512-690GRr1wUGmGYZHk7fUduX/JUwViMF2o74mnZYIWEcJaCcd9MQfkhsxPBtjeg6tF+h266/Cf3RPYhsFBzzxXcA==", "dev": true, "hasInstallScript": true, "peer": true, @@ -334,16 +330,16 @@ "url": "https://opencollective.com/swc" }, "optionalDependencies": { - "@swc/core-darwin-arm64": "1.3.92", - "@swc/core-darwin-x64": "1.3.92", - "@swc/core-linux-arm-gnueabihf": "1.3.92", - "@swc/core-linux-arm64-gnu": "1.3.92", - "@swc/core-linux-arm64-musl": "1.3.92", - "@swc/core-linux-x64-gnu": "1.3.92", - "@swc/core-linux-x64-musl": "1.3.92", - "@swc/core-win32-arm64-msvc": "1.3.92", - "@swc/core-win32-ia32-msvc": "1.3.92", - "@swc/core-win32-x64-msvc": "1.3.92" + "@swc/core-darwin-arm64": "1.3.93", + "@swc/core-darwin-x64": "1.3.93", + "@swc/core-linux-arm-gnueabihf": "1.3.93", + "@swc/core-linux-arm64-gnu": "1.3.93", + "@swc/core-linux-arm64-musl": "1.3.93", + "@swc/core-linux-x64-gnu": "1.3.93", + "@swc/core-linux-x64-musl": "1.3.93", + "@swc/core-win32-arm64-msvc": "1.3.93", + "@swc/core-win32-ia32-msvc": "1.3.93", + "@swc/core-win32-x64-msvc": "1.3.93" }, "peerDependencies": { "@swc/helpers": "^0.5.0" @@ -355,9 +351,9 @@ } }, "node_modules/@swc/core-darwin-arm64": { - "version": "1.3.92", - "resolved": "https://registry.npmjs.org/@swc/core-darwin-arm64/-/core-darwin-arm64-1.3.92.tgz", - "integrity": "sha512-v7PqZUBtIF6Q5Cp48gqUiG8zQQnEICpnfNdoiY3xjQAglCGIQCjJIDjreZBoeZQZspB27lQN4eZ43CX18+2SnA==", + "version": "1.3.93", + "resolved": "https://registry.npmjs.org/@swc/core-darwin-arm64/-/core-darwin-arm64-1.3.93.tgz", + "integrity": "sha512-gEKgk7FVIgltnIfDO6GntyuQBBlAYg5imHpRgLxB1zSI27ijVVkksc6QwISzFZAhKYaBWIsFSVeL9AYSziAF7A==", "cpu": [ "arm64" ], @@ -372,9 +368,9 @@ } }, "node_modules/@swc/core-darwin-x64": { - "version": "1.3.92", - "resolved": "https://registry.npmjs.org/@swc/core-darwin-x64/-/core-darwin-x64-1.3.92.tgz", - "integrity": "sha512-Q3XIgQfXyxxxms3bPN+xGgvwk0TtG9l89IomApu+yTKzaIIlf051mS+lGngjnh9L0aUiCp6ICyjDLtutWP54fw==", + "version": "1.3.93", + "resolved": "https://registry.npmjs.org/@swc/core-darwin-x64/-/core-darwin-x64-1.3.93.tgz", + "integrity": "sha512-ZQPxm/fXdDQtn3yrYSL/gFfA8OfZ5jTi33yFQq6vcg/Y8talpZ+MgdSlYM0FkLrZdMTYYTNFiuBQuuvkA+av+Q==", "cpu": [ "x64" ], @@ -389,9 +385,9 @@ } }, "node_modules/@swc/core-linux-arm-gnueabihf": { - "version": "1.3.92", - "resolved": "https://registry.npmjs.org/@swc/core-linux-arm-gnueabihf/-/core-linux-arm-gnueabihf-1.3.92.tgz", - "integrity": "sha512-tnOCoCpNVXC+0FCfG84PBZJyLlz0Vfj9MQhyhCvlJz9hQmvpf8nTdKH7RHrOn8VfxtUBLdVi80dXgIFgbvl7qA==", + "version": "1.3.93", + "resolved": "https://registry.npmjs.org/@swc/core-linux-arm-gnueabihf/-/core-linux-arm-gnueabihf-1.3.93.tgz", + "integrity": "sha512-OYFMMI2yV+aNe3wMgYhODxHdqUB/jrK0SEMHHS44GZpk8MuBXEF+Mcz4qjkY5Q1EH7KVQqXb/gVWwdgTHpjM2A==", "cpu": [ "arm" ], @@ -406,9 +402,9 @@ } }, "node_modules/@swc/core-linux-arm64-gnu": { - "version": "1.3.92", - "resolved": "https://registry.npmjs.org/@swc/core-linux-arm64-gnu/-/core-linux-arm64-gnu-1.3.92.tgz", - "integrity": "sha512-lFfGhX32w8h1j74Iyz0Wv7JByXIwX11OE9UxG+oT7lG0RyXkF4zKyxP8EoxfLrDXse4Oop434p95e3UNC3IfCw==", + "version": "1.3.93", + "resolved": "https://registry.npmjs.org/@swc/core-linux-arm64-gnu/-/core-linux-arm64-gnu-1.3.93.tgz", + "integrity": "sha512-BT4dT78odKnJMNiq5HdjBsv29CiIdcCcImAPxeFqAeFw1LL6gh9nzI8E96oWc+0lVT5lfhoesCk4Qm7J6bty8w==", "cpu": [ "arm64" ], @@ -423,9 +419,9 @@ } }, "node_modules/@swc/core-linux-arm64-musl": { - "version": "1.3.92", - "resolved": "https://registry.npmjs.org/@swc/core-linux-arm64-musl/-/core-linux-arm64-musl-1.3.92.tgz", - "integrity": "sha512-rOZtRcLj57MSAbiecMsqjzBcZDuaCZ8F6l6JDwGkQ7u1NYR57cqF0QDyU7RKS1Jq27Z/Vg21z5cwqoH5fLN+Sg==", + "version": "1.3.93", + "resolved": "https://registry.npmjs.org/@swc/core-linux-arm64-musl/-/core-linux-arm64-musl-1.3.93.tgz", + "integrity": "sha512-yH5fWEl1bktouC0mhh0Chuxp7HEO4uCtS/ly1Vmf18gs6wZ8DOOkgAEVv2dNKIryy+Na++ljx4Ym7C8tSJTrLw==", "cpu": [ "arm64" ], @@ -440,9 +436,9 @@ } }, "node_modules/@swc/core-linux-x64-gnu": { - "version": "1.3.92", - "resolved": "https://registry.npmjs.org/@swc/core-linux-x64-gnu/-/core-linux-x64-gnu-1.3.92.tgz", - "integrity": "sha512-qptoMGnBL6v89x/Qpn+l1TH1Y0ed+v0qhNfAEVzZvCvzEMTFXphhlhYbDdpxbzRmCjH6GOGq7Y+xrWt9T1/ARg==", + "version": "1.3.93", + "resolved": "https://registry.npmjs.org/@swc/core-linux-x64-gnu/-/core-linux-x64-gnu-1.3.93.tgz", + "integrity": "sha512-OFUdx64qvrGJhXKEyxosHxgoUVgba2ztYh7BnMiU5hP8lbI8G13W40J0SN3CmFQwPP30+3oEbW7LWzhKEaYjlg==", "cpu": [ "x64" ], @@ -457,9 +453,9 @@ } }, "node_modules/@swc/core-linux-x64-musl": { - "version": "1.3.92", - "resolved": "https://registry.npmjs.org/@swc/core-linux-x64-musl/-/core-linux-x64-musl-1.3.92.tgz", - "integrity": "sha512-g2KrJ43bZkCZHH4zsIV5ErojuV1OIpUHaEyW1gf7JWKaFBpWYVyubzFPvPkjcxHGLbMsEzO7w/NVfxtGMlFH/Q==", + "version": "1.3.93", + "resolved": "https://registry.npmjs.org/@swc/core-linux-x64-musl/-/core-linux-x64-musl-1.3.93.tgz", + "integrity": "sha512-4B8lSRwEq1XYm6xhxHhvHmKAS7pUp1Q7E33NQ2TlmFhfKvCOh86qvThcjAOo57x8DRwmpvEVrqvpXtYagMN6Ig==", "cpu": [ "x64" ], @@ -474,9 +470,9 @@ } }, "node_modules/@swc/core-win32-arm64-msvc": { - "version": "1.3.92", - "resolved": "https://registry.npmjs.org/@swc/core-win32-arm64-msvc/-/core-win32-arm64-msvc-1.3.92.tgz", - "integrity": "sha512-3MCRGPAYDoQ8Yyd3WsCMc8eFSyKXY5kQLyg/R5zEqA0uthomo0m0F5/fxAJMZGaSdYkU1DgF73ctOWOf+Z/EzQ==", + "version": "1.3.93", + "resolved": "https://registry.npmjs.org/@swc/core-win32-arm64-msvc/-/core-win32-arm64-msvc-1.3.93.tgz", + "integrity": "sha512-BHShlxtkven8ZjjvZ5QR6sC5fZCJ9bMujEkiha6W4cBUTY7ce7qGFyHmQd+iPC85d9kD/0cCiX/Xez8u0BhO7w==", "cpu": [ "arm64" ], @@ -491,9 +487,9 @@ } }, "node_modules/@swc/core-win32-ia32-msvc": { - "version": "1.3.92", - "resolved": "https://registry.npmjs.org/@swc/core-win32-ia32-msvc/-/core-win32-ia32-msvc-1.3.92.tgz", - "integrity": "sha512-zqTBKQhgfWm73SVGS8FKhFYDovyRl1f5dTX1IwSKynO0qHkRCqJwauFJv/yevkpJWsI2pFh03xsRs9HncTQKSA==", + "version": "1.3.93", + "resolved": "https://registry.npmjs.org/@swc/core-win32-ia32-msvc/-/core-win32-ia32-msvc-1.3.93.tgz", + "integrity": "sha512-nEwNWnz4JzYAK6asVvb92yeylfxMYih7eMQOnT7ZVlZN5ba9WF29xJ6kcQKs9HRH6MvWhz9+wRgv3FcjlU6HYA==", "cpu": [ "ia32" ], @@ -508,9 +504,9 @@ } }, "node_modules/@swc/core-win32-x64-msvc": { - "version": "1.3.92", - "resolved": "https://registry.npmjs.org/@swc/core-win32-x64-msvc/-/core-win32-x64-msvc-1.3.92.tgz", - "integrity": "sha512-41bE66ddr9o/Fi1FBh0sHdaKdENPTuDpv1IFHxSg0dJyM/jX8LbkjnpdInYXHBxhcLVAPraVRrNsC4SaoPw2Pg==", + "version": "1.3.93", + "resolved": "https://registry.npmjs.org/@swc/core-win32-x64-msvc/-/core-win32-x64-msvc-1.3.93.tgz", + "integrity": "sha512-jibQ0zUr4kwJaQVwgmH+svS04bYTPnPw/ZkNInzxS+wFAtzINBYcU8s2PMWbDb2NGYiRSEeoSGyAvS9H+24JFA==", "cpu": [ "x64" ], @@ -532,9 +528,9 @@ "peer": true }, "node_modules/@swc/helpers": { - "version": "0.5.2", - "resolved": "https://registry.npmjs.org/@swc/helpers/-/helpers-0.5.2.tgz", - "integrity": "sha512-E4KcWTpoLHqwPHLxidpOqQbcrZVgi0rsmmZXUle1jXmJfuIf/UWpczUJ7MZZ5tlxytgJXyp0w4PGkkeLiuIdZw==", + "version": "0.5.3", + "resolved": "https://registry.npmjs.org/@swc/helpers/-/helpers-0.5.3.tgz", + "integrity": "sha512-FaruWX6KdudYloq1AHD/4nU+UsMTdNE8CKyrseXWEcgjDAbvkwJg2QGPAnfIJLIWsjZOSPLOAykK6fuYp4vp4A==", "dev": true, "dependencies": { "tslib": "^2.4.0" @@ -571,25 +567,6 @@ "integrity": "sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==", "dev": true }, - "node_modules/@types/body-parser": { - "version": "1.19.3", - "resolved": "https://registry.npmjs.org/@types/body-parser/-/body-parser-1.19.3.tgz", - "integrity": "sha512-oyl4jvAfTGX9Bt6Or4H9ni1Z447/tQuxnZsytsCaExKlmJiU8sFgnIBRzJUpKwB5eWn9HuBYlUlVA74q/yN0eQ==", - "dev": true, - "dependencies": { - "@types/connect": "*", - "@types/node": "*" - } - }, - "node_modules/@types/connect": { - "version": "3.4.36", - "resolved": "https://registry.npmjs.org/@types/connect/-/connect-3.4.36.tgz", - "integrity": "sha512-P63Zd/JUGq+PdrM1lv0Wv5SBYeA2+CORvbrXbngriYY0jzLUWfQMQQxOhjONEz/wlHOAxOdY7CY65rgQdTjq2w==", - "dev": true, - "dependencies": { - "@types/node": "*" - } - }, "node_modules/@types/debug": { "version": "4.1.9", "resolved": "https://registry.npmjs.org/@types/debug/-/debug-4.1.9.tgz", @@ -599,36 +576,6 @@ "@types/ms": "*" } }, - "node_modules/@types/express": { - "version": "4.17.18", - "resolved": "https://registry.npmjs.org/@types/express/-/express-4.17.18.tgz", - "integrity": "sha512-Sxv8BSLLgsBYmcnGdGjjEjqET2U+AKAdCRODmMiq02FgjwuV75Ut85DRpvFjyw/Mk0vgUOliGRU0UUmuuZHByQ==", - "dev": true, - "dependencies": { - "@types/body-parser": "*", - "@types/express-serve-static-core": "^4.17.33", - "@types/qs": "*", - "@types/serve-static": "*" - } - }, - "node_modules/@types/express-serve-static-core": { - "version": "4.17.37", - "resolved": "https://registry.npmjs.org/@types/express-serve-static-core/-/express-serve-static-core-4.17.37.tgz", - "integrity": "sha512-ZohaCYTgGFcOP7u6aJOhY9uIZQgZ2vxC2yWoArY+FeDXlqeH66ZVBjgvg+RLVAS/DWNq4Ap9ZXu1+SUQiiWYMg==", - "dev": true, - "dependencies": { - "@types/node": "*", - "@types/qs": "*", - "@types/range-parser": "*", - "@types/send": "*" - } - }, - "node_modules/@types/http-errors": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/@types/http-errors/-/http-errors-2.0.2.tgz", - "integrity": "sha512-lPG6KlZs88gef6aD85z3HNkztpj7w2R7HmR3gygjfXCQmsLloWNARFkMuzKiiY8FGdh1XDpgBdrSf4aKDiA7Kg==", - "dev": true - }, "node_modules/@types/json-schema": { "version": "7.0.13", "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.13.tgz", @@ -642,20 +589,14 @@ "dev": true }, "node_modules/@types/mdast": { - "version": "3.0.13", - "resolved": "https://registry.npmjs.org/@types/mdast/-/mdast-3.0.13.tgz", - "integrity": "sha512-HjiGiWedR0DVFkeNljpa6Lv4/IZU1+30VY5d747K7lBudFc3R0Ibr6yJ9lN3BE28VnZyDfLF/VB1Ql1ZIbKrmg==", + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/@types/mdast/-/mdast-4.0.1.tgz", + "integrity": "sha512-IlKct1rUTJ1T81d8OHzyop15kGv9A/ff7Gz7IJgrk6jDb4Udw77pCJ+vq8oxZf4Ghpm+616+i1s/LNg/Vh7d+g==", "dev": true, "dependencies": { - "@types/unist": "^2" + "@types/unist": "*" } }, - "node_modules/@types/mime": { - "version": "1.3.3", - "resolved": "https://registry.npmjs.org/@types/mime/-/mime-1.3.3.tgz", - "integrity": "sha512-Ys+/St+2VF4+xuY6+kDIXGxbNRO0mesVg0bbxEfB97Od1Vjpjx9KD1qxs64Gcb3CWPirk9Xe+PT4YiiHQ9T+eg==", - "dev": true - }, "node_modules/@types/ms": { "version": "0.7.32", "resolved": "https://registry.npmjs.org/@types/ms/-/ms-0.7.32.tgz", @@ -663,30 +604,9 @@ "dev": true }, "node_modules/@types/node": { - "version": "20.8.2", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.8.2.tgz", - "integrity": "sha512-Vvycsc9FQdwhxE3y3DzeIxuEJbWGDsnrxvMADzTDF/lcdR9/K+AQIeAghTQsHtotg/q0j3WEOYS/jQgSdWue3w==", - "dev": true - }, - "node_modules/@types/oauth": { - "version": "0.9.2", - "resolved": "https://registry.npmjs.org/@types/oauth/-/oauth-0.9.2.tgz", - "integrity": "sha512-Nu3/abQ6yR9VlsCdX3aiGsWFkj6OJvJqDvg/36t8Gwf2mFXdBZXPDN3K+2yfeA6Lo2m1Q12F8Qil9TZ48nWhOQ==", - "dev": true, - "dependencies": { - "@types/node": "*" - } - }, - "node_modules/@types/qs": { - "version": "6.9.8", - "resolved": "https://registry.npmjs.org/@types/qs/-/qs-6.9.8.tgz", - "integrity": "sha512-u95svzDlTysU5xecFNTgfFG5RUWu1A9P0VzgpcIiGZA9iraHOdSzcxMxQ55DyeRaGCSxQi7LxXDI4rzq/MYfdg==", - "dev": true - }, - "node_modules/@types/range-parser": { - "version": "1.2.5", - "resolved": "https://registry.npmjs.org/@types/range-parser/-/range-parser-1.2.5.tgz", - "integrity": "sha512-xrO9OoVPqFuYyR/loIHjnbvvyRZREYKLjxV4+dY6v3FQR3stQ9ZxIGkaclF7YhI9hfjpuTbu14hZEy94qKLtOA==", + "version": "18.18.5", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.5.tgz", + "integrity": "sha512-4slmbtwV59ZxitY4ixUZdy1uRLf9eSIvBWPQxNjhHYWEtn0FryfKpyS2cvADYXTayWdKEIsJengncrVvkI4I6A==", "dev": true }, "node_modules/@types/semver": { @@ -695,31 +615,10 @@ "integrity": "sha512-OxepLK9EuNEIPxWNME+C6WwbRAOOI2o2BaQEGzz5Lu2e4Z5eDnEo+/aVEDMIXywoJitJ7xWd641wrGLZdtwRyw==", "dev": true }, - "node_modules/@types/send": { - "version": "0.17.2", - "resolved": "https://registry.npmjs.org/@types/send/-/send-0.17.2.tgz", - "integrity": "sha512-aAG6yRf6r0wQ29bkS+x97BIs64ZLxeE/ARwyS6wrldMm3C1MdKwCcnnEwMC1slI8wuxJOpiUH9MioC0A0i+GJw==", - "dev": true, - "dependencies": { - "@types/mime": "^1", - "@types/node": "*" - } - }, - "node_modules/@types/serve-static": { - "version": "1.15.3", - "resolved": "https://registry.npmjs.org/@types/serve-static/-/serve-static-1.15.3.tgz", - "integrity": "sha512-yVRvFsEMrv7s0lGhzrggJjNOSmZCdgCjw9xWrPr/kNNLp6FaDfMC1KaYl3TSJ0c58bECwNBMoQrZJ8hA8E1eFg==", - "dev": true, - "dependencies": { - "@types/http-errors": "*", - "@types/mime": "*", - "@types/node": "*" - } - }, "node_modules/@types/sinon": { - "version": "10.0.18", - "resolved": "https://registry.npmjs.org/@types/sinon/-/sinon-10.0.18.tgz", - "integrity": "sha512-OpQC9ug8BcnNxue2WF5aTruMaDRFn6NyfaE4DmAKOlQMn54b7CnCvDFV3wj5fk/HbSSTYmOYs2bTb5ShANjyQg==", + "version": "10.0.19", + "resolved": "https://registry.npmjs.org/@types/sinon/-/sinon-10.0.19.tgz", + "integrity": "sha512-MWZNGPSchIdDfb5FL+VFi4zHsHbNOTQEgjqFQk7HazXSXwUU9PAX3z9XBqb3AJGYr9YwrtCtaSMsT3brYsN/jQ==", "dev": true, "dependencies": { "@types/sinonjs__fake-timers": "*" @@ -732,22 +631,22 @@ "dev": true }, "node_modules/@types/unist": { - "version": "2.0.8", - "resolved": "https://registry.npmjs.org/@types/unist/-/unist-2.0.8.tgz", - "integrity": "sha512-d0XxK3YTObnWVp6rZuev3c49+j4Lo8g4L1ZRm9z5L0xpoZycUPshHgczK5gsUMaZOstjVYYi09p5gYvUtfChYw==", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.0.tgz", + "integrity": "sha512-MFETx3tbTjE7Uk6vvnWINA/1iJ7LuMdO4fcq8UfF0pRbj01aGLduVvQcRyswuACJdpnHgg8E3rQLhaRdNEJS0w==", "dev": true }, "node_modules/@typescript-eslint/eslint-plugin": { - "version": "6.7.4", - "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-6.7.4.tgz", - "integrity": "sha512-DAbgDXwtX+pDkAHwiGhqP3zWUGpW49B7eqmgpPtg+BKJXwdct79ut9+ifqOFPJGClGKSHXn2PTBatCnldJRUoA==", + "version": "6.7.5", + "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-6.7.5.tgz", + "integrity": "sha512-JhtAwTRhOUcP96D0Y6KYnwig/MRQbOoLGXTON2+LlyB/N35SP9j1boai2zzwXb7ypKELXMx3DVk9UTaEq1vHEw==", "dev": true, "dependencies": { "@eslint-community/regexpp": "^4.5.1", - "@typescript-eslint/scope-manager": "6.7.4", - "@typescript-eslint/type-utils": "6.7.4", - "@typescript-eslint/utils": "6.7.4", - "@typescript-eslint/visitor-keys": "6.7.4", + "@typescript-eslint/scope-manager": "6.7.5", + "@typescript-eslint/type-utils": "6.7.5", + "@typescript-eslint/utils": "6.7.5", + "@typescript-eslint/visitor-keys": "6.7.5", "debug": "^4.3.4", "graphemer": "^1.4.0", "ignore": "^5.2.4", @@ -773,15 +672,15 @@ } }, "node_modules/@typescript-eslint/parser": { - "version": "6.7.4", - "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-6.7.4.tgz", - "integrity": "sha512-I5zVZFY+cw4IMZUeNCU7Sh2PO5O57F7Lr0uyhgCJmhN/BuTlnc55KxPonR4+EM3GBdfiCyGZye6DgMjtubQkmA==", + "version": "6.7.5", + "resolved": "https://registry.npmjs.org/@typescript-eslint/parser/-/parser-6.7.5.tgz", + "integrity": "sha512-bIZVSGx2UME/lmhLcjdVc7ePBwn7CLqKarUBL4me1C5feOd663liTGjMBGVcGr+BhnSLeP4SgwdvNnnkbIdkCw==", "dev": true, "dependencies": { - "@typescript-eslint/scope-manager": "6.7.4", - "@typescript-eslint/types": "6.7.4", - "@typescript-eslint/typescript-estree": "6.7.4", - "@typescript-eslint/visitor-keys": "6.7.4", + "@typescript-eslint/scope-manager": "6.7.5", + "@typescript-eslint/types": "6.7.5", + "@typescript-eslint/typescript-estree": "6.7.5", + "@typescript-eslint/visitor-keys": "6.7.5", "debug": "^4.3.4" }, "engines": { @@ -801,13 +700,13 @@ } }, "node_modules/@typescript-eslint/scope-manager": { - "version": "6.7.4", - "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-6.7.4.tgz", - "integrity": "sha512-SdGqSLUPTXAXi7c3Ob7peAGVnmMoGzZ361VswK2Mqf8UOYcODiYvs8rs5ILqEdfvX1lE7wEZbLyELCW+Yrql1A==", + "version": "6.7.5", + "resolved": "https://registry.npmjs.org/@typescript-eslint/scope-manager/-/scope-manager-6.7.5.tgz", + "integrity": "sha512-GAlk3eQIwWOJeb9F7MKQ6Jbah/vx1zETSDw8likab/eFcqkjSD7BI75SDAeC5N2L0MmConMoPvTsmkrg71+B1A==", "dev": true, "dependencies": { - "@typescript-eslint/types": "6.7.4", - "@typescript-eslint/visitor-keys": "6.7.4" + "@typescript-eslint/types": "6.7.5", + "@typescript-eslint/visitor-keys": "6.7.5" }, "engines": { "node": "^16.0.0 || >=18.0.0" @@ -818,13 +717,13 @@ } }, "node_modules/@typescript-eslint/type-utils": { - "version": "6.7.4", - "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-6.7.4.tgz", - "integrity": "sha512-n+g3zi1QzpcAdHFP9KQF+rEFxMb2KxtnJGID3teA/nxKHOVi3ylKovaqEzGBbVY2pBttU6z85gp0D00ufLzViQ==", + "version": "6.7.5", + "resolved": "https://registry.npmjs.org/@typescript-eslint/type-utils/-/type-utils-6.7.5.tgz", + "integrity": "sha512-Gs0qos5wqxnQrvpYv+pf3XfcRXW6jiAn9zE/K+DlmYf6FcpxeNYN0AIETaPR7rHO4K2UY+D0CIbDP9Ut0U4m1g==", "dev": true, "dependencies": { - "@typescript-eslint/typescript-estree": "6.7.4", - "@typescript-eslint/utils": "6.7.4", + "@typescript-eslint/typescript-estree": "6.7.5", + "@typescript-eslint/utils": "6.7.5", "debug": "^4.3.4", "ts-api-utils": "^1.0.1" }, @@ -845,9 +744,9 @@ } }, "node_modules/@typescript-eslint/types": { - "version": "6.7.4", - "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-6.7.4.tgz", - "integrity": "sha512-o9XWK2FLW6eSS/0r/tgjAGsYasLAnOWg7hvZ/dGYSSNjCh+49k5ocPN8OmG5aZcSJ8pclSOyVKP2x03Sj+RrCA==", + "version": "6.7.5", + "resolved": "https://registry.npmjs.org/@typescript-eslint/types/-/types-6.7.5.tgz", + "integrity": "sha512-WboQBlOXtdj1tDFPyIthpKrUb+kZf2VroLZhxKa/VlwLlLyqv/PwUNgL30BlTVZV1Wu4Asu2mMYPqarSO4L5ZQ==", "dev": true, "engines": { "node": "^16.0.0 || >=18.0.0" @@ -858,13 +757,13 @@ } }, "node_modules/@typescript-eslint/typescript-estree": { - "version": "6.7.4", - "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-6.7.4.tgz", - "integrity": "sha512-ty8b5qHKatlNYd9vmpHooQz3Vki3gG+3PchmtsA4TgrZBKWHNjWfkQid7K7xQogBqqc7/BhGazxMD5vr6Ha+iQ==", + "version": "6.7.5", + "resolved": "https://registry.npmjs.org/@typescript-eslint/typescript-estree/-/typescript-estree-6.7.5.tgz", + "integrity": "sha512-NhJiJ4KdtwBIxrKl0BqG1Ur+uw7FiOnOThcYx9DpOGJ/Abc9z2xNzLeirCG02Ig3vkvrc2qFLmYSSsaITbKjlg==", "dev": true, "dependencies": { - "@typescript-eslint/types": "6.7.4", - "@typescript-eslint/visitor-keys": "6.7.4", + "@typescript-eslint/types": "6.7.5", + "@typescript-eslint/visitor-keys": "6.7.5", "debug": "^4.3.4", "globby": "^11.1.0", "is-glob": "^4.0.3", @@ -885,17 +784,17 @@ } }, "node_modules/@typescript-eslint/utils": { - "version": "6.7.4", - "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-6.7.4.tgz", - "integrity": "sha512-PRQAs+HUn85Qdk+khAxsVV+oULy3VkbH3hQ8hxLRJXWBEd7iI+GbQxH5SEUSH7kbEoTp6oT1bOwyga24ELALTA==", + "version": "6.7.5", + "resolved": "https://registry.npmjs.org/@typescript-eslint/utils/-/utils-6.7.5.tgz", + "integrity": "sha512-pfRRrH20thJbzPPlPc4j0UNGvH1PjPlhlCMq4Yx7EGjV7lvEeGX0U6MJYe8+SyFutWgSHsdbJ3BXzZccYggezA==", "dev": true, "dependencies": { "@eslint-community/eslint-utils": "^4.4.0", "@types/json-schema": "^7.0.12", "@types/semver": "^7.5.0", - "@typescript-eslint/scope-manager": "6.7.4", - "@typescript-eslint/types": "6.7.4", - "@typescript-eslint/typescript-estree": "6.7.4", + "@typescript-eslint/scope-manager": "6.7.5", + "@typescript-eslint/types": "6.7.5", + "@typescript-eslint/typescript-estree": "6.7.5", "semver": "^7.5.4" }, "engines": { @@ -910,12 +809,12 @@ } }, "node_modules/@typescript-eslint/visitor-keys": { - "version": "6.7.4", - "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-6.7.4.tgz", - "integrity": "sha512-pOW37DUhlTZbvph50x5zZCkFn3xzwkGtNoJHzIM3svpiSkJzwOYr/kVBaXmf+RAQiUDs1AHEZVNPg6UJCJpwRA==", + "version": "6.7.5", + "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-6.7.5.tgz", + "integrity": "sha512-3MaWdDZtLlsexZzDSdQWsFQ9l9nL8B80Z4fImSpyllFC/KLqWQRdEcB+gGGO+N3Q2uL40EsG66wZLsohPxNXvg==", "dev": true, "dependencies": { - "@typescript-eslint/types": "6.7.4", + "@typescript-eslint/types": "6.7.5", "eslint-visitor-keys": "^3.4.1" }, "engines": { @@ -1236,18 +1135,6 @@ "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==" }, - "node_modules/atlassian-jwt": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/atlassian-jwt/-/atlassian-jwt-2.0.2.tgz", - "integrity": "sha512-HgG2p+gJeEqKREnPynEDy76UoShF01jTYMSe0NlRL2rEqXBNDzJiiCyUP7P2cbxcRmI4OC8g40zJjqftFNJ/4A==", - "dependencies": { - "jsuri": "^1.3.1", - "lodash": "^4.17.21" - }, - "engines": { - "node": ">= 0.4.0" - } - }, "node_modules/ava": { "version": "5.3.1", "resolved": "https://registry.npmjs.org/ava/-/ava-5.3.1.tgz", @@ -1866,9 +1753,9 @@ "dev": true }, "node_modules/define-data-property": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.0.tgz", - "integrity": "sha512-UzGwzcjyv3OtAvolTj1GoyNYzfFR+iqbGjcnBEENZVCpM4/Ng1yhGNvS3lR/xDS74Tb2wGG9WzNSNIOS9UVb2g==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.1.tgz", + "integrity": "sha512-E7uGkTzkk1d0ByLeSc6ZsFS79Axg+m1P/VsgYsxHgiuc3tFSj+MjMIwe90FC4lOAZzNBdY7kkO2P2wKdsQ1vgQ==", "dev": true, "dependencies": { "get-intrinsic": "^1.2.1", @@ -1913,6 +1800,19 @@ "node": ">=6" } }, + "node_modules/devlop": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/devlop/-/devlop-1.1.0.tgz", + "integrity": "sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==", + "dev": true, + "dependencies": { + "dequal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, "node_modules/diff": { "version": "5.1.0", "resolved": "https://registry.npmjs.org/diff/-/diff-5.1.0.tgz", @@ -2133,15 +2033,15 @@ } }, "node_modules/eslint": { - "version": "8.50.0", - "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.50.0.tgz", - "integrity": "sha512-FOnOGSuFuFLv/Sa+FDVRZl4GGVAAFFi8LecRsI5a1tMO5HIE8nCm4ivAlzt4dT3ol/PaaGC0rJEEXQmHJBGoOg==", + "version": "8.51.0", + "resolved": "https://registry.npmjs.org/eslint/-/eslint-8.51.0.tgz", + "integrity": "sha512-2WuxRZBrlwnXi+/vFSJyjMqrNjtJqiasMzehF0shoLaW7DzS3/9Yvrmq5JiT66+pNjiX4UBnLDiKHcWAr/OInA==", "dev": true, "dependencies": { "@eslint-community/eslint-utils": "^4.2.0", "@eslint-community/regexpp": "^4.6.1", "@eslint/eslintrc": "^2.1.2", - "@eslint/js": "8.50.0", + "@eslint/js": "8.51.0", "@humanwhocodes/config-array": "^0.11.11", "@humanwhocodes/module-importer": "^1.0.1", "@nodelib/fs.walk": "^1.2.8", @@ -2481,13 +2381,13 @@ } }, "node_modules/eslint-plugin-react/node_modules/resolve": { - "version": "2.0.0-next.4", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.4.tgz", - "integrity": "sha512-iMDbmAWtfU+MHpxt/I5iWI7cY6YVEZUQ3MBgPQ++XD1PELuJHIl82xBmObyP2KyQmkNB2dsqF7seoQQiAn5yDQ==", + "version": "2.0.0-next.5", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-2.0.0-next.5.tgz", + "integrity": "sha512-U7WjGVG9sH8tvjW5SmGbQuui75FiyjAX72HX15DwBBwF9dNiQZRQAg9nnPhYy+TUnE0+VcrttuvNI8oSxZcocA==", "dev": true, "peer": true, "dependencies": { - "is-core-module": "^2.9.0", + "is-core-module": "^2.13.0", "path-parse": "^1.0.7", "supports-preserve-symlinks-flag": "^1.0.0" }, @@ -2790,12 +2690,12 @@ } }, "node_modules/flat-cache": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.1.0.tgz", - "integrity": "sha512-OHx4Qwrrt0E4jEIcI5/Xb+f+QmJYNj2rrK8wiIdQOIrB9WrrJL8cjZvXdXuBTkkEwEqLycb5BeZDV1o2i9bTew==", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/flat-cache/-/flat-cache-3.1.1.tgz", + "integrity": "sha512-/qM2b3LUIaIgviBQovTLvijfyOQXPtSRnRK26ksj2J7rzPIecePUIpJsZ4T02Qg+xiAEKIs5K8dsHEd+VaKa/Q==", "dev": true, "dependencies": { - "flatted": "^3.2.7", + "flatted": "^3.2.9", "keyv": "^4.5.3", "rimraf": "^3.0.2" }, @@ -2871,10 +2771,13 @@ } }, "node_modules/function-bind": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", - "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", - "dev": true + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } }, "node_modules/function.prototype.name": { "version": "1.1.6", @@ -2988,9 +2891,9 @@ } }, "node_modules/globals": { - "version": "13.22.0", - "resolved": "https://registry.npmjs.org/globals/-/globals-13.22.0.tgz", - "integrity": "sha512-H1Ddc/PbZHTDVJSnj8kWptIRSD6AM3pK+mKytuIVF4uoBV7rshFlhhvA58ceJ5wp3Er58w6zj7bykMpYXt3ETw==", + "version": "13.23.0", + "resolved": "https://registry.npmjs.org/globals/-/globals-13.23.0.tgz", + "integrity": "sha512-XAmF0RjlrjY23MA51q3HltdlGxUpXPvg0GioKiD9X6HD28iMjo2dKC8Vqwm7lne4GNr78+RHTfliktR6ZH09wA==", "dev": true, "dependencies": { "type-fest": "^0.20.2" @@ -3701,14 +3604,6 @@ "integrity": "sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w==", "dev": true }, - "node_modules/jsuri": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/jsuri/-/jsuri-1.3.1.tgz", - "integrity": "sha512-LLdAeqOf88/X0hylAI7oSir6QUsz/8kOW0FcJzzu/SJRfORA/oPHycAOthkNp7eLPlTAbqVDFbqNRHkRVzEA3g==", - "engines": { - "node": "*" - } - }, "node_modules/jsx-ast-utils": { "version": "3.3.5", "resolved": "https://registry.npmjs.org/jsx-ast-utils/-/jsx-ast-utils-3.3.5.tgz", @@ -3732,23 +3627,14 @@ "dev": true }, "node_modules/keyv": { - "version": "4.5.3", - "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.3.tgz", - "integrity": "sha512-QCiSav9WaX1PgETJ+SpNnx2PRRapJ/oRSXM4VO5OGYGSjrxbKPVFVhB3l2OCbLCk329N8qyAtsJjSjvVBWzEug==", + "version": "4.5.4", + "resolved": "https://registry.npmjs.org/keyv/-/keyv-4.5.4.tgz", + "integrity": "sha512-oxVHkHR/EJf2CNXnWxRLW6mg7JyCCUcG0DtEGmL2ctUo1PNTin1PUil+r/+4r5MpVgC/fn1kjsx7mjSujKqIpw==", "dev": true, "dependencies": { "json-buffer": "3.0.1" } }, - "node_modules/kleur": { - "version": "4.1.5", - "resolved": "https://registry.npmjs.org/kleur/-/kleur-4.1.5.tgz", - "integrity": "sha512-o+NO+8WrRiQEE4/7nwRJhN1HWpVmJm511pBHUxPLtp0BUISzlBplORYSmTclCnJvQq2tKu/sgl3xVpkc7ZWuQQ==", - "dev": true, - "engines": { - "node": ">=6" - } - }, "node_modules/language-subtag-registry": { "version": "0.3.22", "resolved": "https://registry.npmjs.org/language-subtag-registry/-/language-subtag-registry-0.3.22.tgz", @@ -3809,7 +3695,8 @@ "node_modules/lodash": { "version": "4.17.21", "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", - "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==" + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", + "dev": true }, "node_modules/lodash.get": { "version": "4.4.2", @@ -3924,23 +3811,23 @@ } }, "node_modules/mdast-util-from-markdown": { - "version": "1.3.1", - "resolved": "https://registry.npmjs.org/mdast-util-from-markdown/-/mdast-util-from-markdown-1.3.1.tgz", - "integrity": "sha512-4xTO/M8c82qBcnQc1tgpNtubGUW/Y1tBQ1B0i5CtSoelOLKFYlElIr3bvgREYYO5iRqbMY1YuqZng0GVOI8Qww==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-from-markdown/-/mdast-util-from-markdown-2.0.0.tgz", + "integrity": "sha512-n7MTOr/z+8NAX/wmhhDji8O3bRvPTV/U0oTCaZJkjhPSKTPhS3xufVhKGF8s1pJ7Ox4QgoIU7KHseh09S+9rTA==", "dev": true, "dependencies": { - "@types/mdast": "^3.0.0", - "@types/unist": "^2.0.0", + "@types/mdast": "^4.0.0", + "@types/unist": "^3.0.0", "decode-named-character-reference": "^1.0.0", - "mdast-util-to-string": "^3.1.0", - "micromark": "^3.0.0", - "micromark-util-decode-numeric-character-reference": "^1.0.0", - "micromark-util-decode-string": "^1.0.0", - "micromark-util-normalize-identifier": "^1.0.0", - "micromark-util-symbol": "^1.0.0", - "micromark-util-types": "^1.0.0", - "unist-util-stringify-position": "^3.0.0", - "uvu": "^0.5.0" + "devlop": "^1.0.0", + "mdast-util-to-string": "^4.0.0", + "micromark": "^4.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-decode-string": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0", + "unist-util-stringify-position": "^4.0.0" }, "funding": { "type": "opencollective", @@ -3948,12 +3835,12 @@ } }, "node_modules/mdast-util-to-string": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/mdast-util-to-string/-/mdast-util-to-string-3.2.0.tgz", - "integrity": "sha512-V4Zn/ncyN1QNSqSBxTrMOLpjr+IKdHl2v3KVLoWmDPscP4r9GcCi71gjgvUV1SFSKh92AjAG4peFuBl2/YgCJg==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/mdast-util-to-string/-/mdast-util-to-string-4.0.0.tgz", + "integrity": "sha512-0H44vDimn51F0YwvxSJSm0eCDOJTRlmN0R1yBh4HLj9wiV1Dn0QoXGbvFAWj2hSItVTlCmBF1hqKlIyUBVFLPg==", "dev": true, "dependencies": { - "@types/mdast": "^3.0.0" + "@types/mdast": "^4.0.0" }, "funding": { "type": "opencollective", @@ -3986,9 +3873,9 @@ } }, "node_modules/micromark": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/micromark/-/micromark-3.2.0.tgz", - "integrity": "sha512-uD66tJj54JLYq0De10AhWycZWGQNUvDI55xPgk2sQM5kn1JYlhbCMTtEeT27+vAhW2FBQxLlOmS3pmA7/2z4aA==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/micromark/-/micromark-4.0.0.tgz", + "integrity": "sha512-o/sd0nMof8kYff+TqcDx3VSrgBTcZpSvYcAHIfHhv5VAuNmisCxjhx6YmxS8PFEpb9z5WKWKPdzf0jM23ro3RQ==", "dev": true, "funding": [ { @@ -4004,26 +3891,26 @@ "@types/debug": "^4.0.0", "debug": "^4.0.0", "decode-named-character-reference": "^1.0.0", - "micromark-core-commonmark": "^1.0.1", - "micromark-factory-space": "^1.0.0", - "micromark-util-character": "^1.0.0", - "micromark-util-chunked": "^1.0.0", - "micromark-util-combine-extensions": "^1.0.0", - "micromark-util-decode-numeric-character-reference": "^1.0.0", - "micromark-util-encode": "^1.0.0", - "micromark-util-normalize-identifier": "^1.0.0", - "micromark-util-resolve-all": "^1.0.0", - "micromark-util-sanitize-uri": "^1.0.0", - "micromark-util-subtokenize": "^1.0.0", - "micromark-util-symbol": "^1.0.0", - "micromark-util-types": "^1.0.1", - "uvu": "^0.5.0" + "devlop": "^1.0.0", + "micromark-core-commonmark": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-combine-extensions": "^2.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "micromark-util-subtokenize": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" } }, "node_modules/micromark-core-commonmark": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-core-commonmark/-/micromark-core-commonmark-1.1.0.tgz", - "integrity": "sha512-BgHO1aRbolh2hcrzL2d1La37V0Aoz73ymF8rAcKnohLy93titmv62E0gP8Hrx9PKcKrqCZ1BbLGbP3bEhoXYlw==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-core-commonmark/-/micromark-core-commonmark-2.0.0.tgz", + "integrity": "sha512-jThOz/pVmAYUtkroV3D5c1osFXAMv9e0ypGDOIZuCeAe91/sD6BoE2Sjzt30yuXtwOYUmySOhMas/PVyh02itA==", "dev": true, "funding": [ { @@ -4037,27 +3924,27 @@ ], "dependencies": { "decode-named-character-reference": "^1.0.0", - "micromark-factory-destination": "^1.0.0", - "micromark-factory-label": "^1.0.0", - "micromark-factory-space": "^1.0.0", - "micromark-factory-title": "^1.0.0", - "micromark-factory-whitespace": "^1.0.0", - "micromark-util-character": "^1.0.0", - "micromark-util-chunked": "^1.0.0", - "micromark-util-classify-character": "^1.0.0", - "micromark-util-html-tag-name": "^1.0.0", - "micromark-util-normalize-identifier": "^1.0.0", - "micromark-util-resolve-all": "^1.0.0", - "micromark-util-subtokenize": "^1.0.0", - "micromark-util-symbol": "^1.0.0", - "micromark-util-types": "^1.0.1", - "uvu": "^0.5.0" + "devlop": "^1.0.0", + "micromark-factory-destination": "^2.0.0", + "micromark-factory-label": "^2.0.0", + "micromark-factory-space": "^2.0.0", + "micromark-factory-title": "^2.0.0", + "micromark-factory-whitespace": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-classify-character": "^2.0.0", + "micromark-util-html-tag-name": "^2.0.0", + "micromark-util-normalize-identifier": "^2.0.0", + "micromark-util-resolve-all": "^2.0.0", + "micromark-util-subtokenize": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" } }, "node_modules/micromark-factory-destination": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-factory-destination/-/micromark-factory-destination-1.1.0.tgz", - "integrity": "sha512-XaNDROBgx9SgSChd69pjiGKbV+nfHGDPVYFs5dOoDd7ZnMAE+Cuu91BCpsY8RT2NP9vo/B8pds2VQNCLiu0zhg==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-destination/-/micromark-factory-destination-2.0.0.tgz", + "integrity": "sha512-j9DGrQLm/Uhl2tCzcbLhy5kXsgkHUrjJHg4fFAeoMRwJmJerT9aw4FEhIbZStWN8A3qMwOp1uzHr4UL8AInxtA==", "dev": true, "funding": [ { @@ -4070,15 +3957,15 @@ } ], "dependencies": { - "micromark-util-character": "^1.0.0", - "micromark-util-symbol": "^1.0.0", - "micromark-util-types": "^1.0.0" + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" } }, "node_modules/micromark-factory-label": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-factory-label/-/micromark-factory-label-1.1.0.tgz", - "integrity": "sha512-OLtyez4vZo/1NjxGhcpDSbHQ+m0IIGnT8BoPamh+7jVlzLJBH98zzuCoUeMxvM6WsNeh8wx8cKvqLiPHEACn0w==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-label/-/micromark-factory-label-2.0.0.tgz", + "integrity": "sha512-RR3i96ohZGde//4WSe/dJsxOX6vxIg9TimLAS3i4EhBAFx8Sm5SmqVfR8E87DPSR31nEAjZfbt91OMZWcNgdZw==", "dev": true, "funding": [ { @@ -4091,16 +3978,16 @@ } ], "dependencies": { - "micromark-util-character": "^1.0.0", - "micromark-util-symbol": "^1.0.0", - "micromark-util-types": "^1.0.0", - "uvu": "^0.5.0" + "devlop": "^1.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" } }, "node_modules/micromark-factory-space": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-1.1.0.tgz", - "integrity": "sha512-cRzEj7c0OL4Mw2v6nwzttyOZe8XY/Z8G0rzmWQZTBi/jjwyw/U4uqKtUORXQrR5bAZZnbTI/feRV/R7hc4jQYQ==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-space/-/micromark-factory-space-2.0.0.tgz", + "integrity": "sha512-TKr+LIDX2pkBJXFLzpyPyljzYK3MtmllMUMODTQJIUfDGncESaqB90db9IAUcz4AZAJFdd8U9zOp9ty1458rxg==", "dev": true, "funding": [ { @@ -4113,14 +4000,14 @@ } ], "dependencies": { - "micromark-util-character": "^1.0.0", - "micromark-util-types": "^1.0.0" + "micromark-util-character": "^2.0.0", + "micromark-util-types": "^2.0.0" } }, "node_modules/micromark-factory-title": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-factory-title/-/micromark-factory-title-1.1.0.tgz", - "integrity": "sha512-J7n9R3vMmgjDOCY8NPw55jiyaQnH5kBdV2/UXCtZIpnHH3P6nHUKaH7XXEYuWwx/xUJcawa8plLBEjMPU24HzQ==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-title/-/micromark-factory-title-2.0.0.tgz", + "integrity": "sha512-jY8CSxmpWLOxS+t8W+FG3Xigc0RDQA9bKMY/EwILvsesiRniiVMejYTE4wumNc2f4UbAa4WsHqe3J1QS1sli+A==", "dev": true, "funding": [ { @@ -4133,16 +4020,16 @@ } ], "dependencies": { - "micromark-factory-space": "^1.0.0", - "micromark-util-character": "^1.0.0", - "micromark-util-symbol": "^1.0.0", - "micromark-util-types": "^1.0.0" + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" } }, "node_modules/micromark-factory-whitespace": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-factory-whitespace/-/micromark-factory-whitespace-1.1.0.tgz", - "integrity": "sha512-v2WlmiymVSp5oMg+1Q0N1Lxmt6pMhIHD457whWM7/GUlEks1hI9xj5w3zbc4uuMKXGisksZk8DzP2UyGbGqNsQ==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-factory-whitespace/-/micromark-factory-whitespace-2.0.0.tgz", + "integrity": "sha512-28kbwaBjc5yAI1XadbdPYHX/eDnqaUFVikLwrO7FDnKG7lpgxnvk/XGRhX/PN0mOZ+dBSZ+LgunHS+6tYQAzhA==", "dev": true, "funding": [ { @@ -4155,16 +4042,16 @@ } ], "dependencies": { - "micromark-factory-space": "^1.0.0", - "micromark-util-character": "^1.0.0", - "micromark-util-symbol": "^1.0.0", - "micromark-util-types": "^1.0.0" + "micromark-factory-space": "^2.0.0", + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" } }, "node_modules/micromark-util-character": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-1.2.0.tgz", - "integrity": "sha512-lXraTwcX3yH/vMDaFWCQJP1uIszLVebzUa3ZHdrgxr7KEU/9mL4mVgCpGbyhvNLNlauROiNUq7WN5u7ndbY6xg==", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.0.1.tgz", + "integrity": "sha512-3wgnrmEAJ4T+mGXAUfMvMAbxU9RDG43XmGce4j6CwPtVxB3vfwXSZ6KhFwDzZ3mZHhmPimMAXg71veiBGzeAZw==", "dev": true, "funding": [ { @@ -4177,14 +4064,14 @@ } ], "dependencies": { - "micromark-util-symbol": "^1.0.0", - "micromark-util-types": "^1.0.0" + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" } }, "node_modules/micromark-util-chunked": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-chunked/-/micromark-util-chunked-1.1.0.tgz", - "integrity": "sha512-Ye01HXpkZPNcV6FiyoW2fGZDUw4Yc7vT0E9Sad83+bEDiCJ1uXu0S3mr8WLpsz3HaG3x2q0HM6CTuPdcZcluFQ==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-chunked/-/micromark-util-chunked-2.0.0.tgz", + "integrity": "sha512-anK8SWmNphkXdaKgz5hJvGa7l00qmcaUQoMYsBwDlSKFKjc6gjGXPDw3FNL3Nbwq5L8gE+RCbGqTw49FK5Qyvg==", "dev": true, "funding": [ { @@ -4197,13 +4084,13 @@ } ], "dependencies": { - "micromark-util-symbol": "^1.0.0" + "micromark-util-symbol": "^2.0.0" } }, "node_modules/micromark-util-classify-character": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-classify-character/-/micromark-util-classify-character-1.1.0.tgz", - "integrity": "sha512-SL0wLxtKSnklKSUplok1WQFoGhUdWYKggKUiqhX+Swala+BtptGCu5iPRc+xvzJ4PXE/hwM3FNXsfEVgoZsWbw==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-classify-character/-/micromark-util-classify-character-2.0.0.tgz", + "integrity": "sha512-S0ze2R9GH+fu41FA7pbSqNWObo/kzwf8rN/+IGlW/4tC6oACOs8B++bh+i9bVyNnwCcuksbFwsBme5OCKXCwIw==", "dev": true, "funding": [ { @@ -4216,15 +4103,15 @@ } ], "dependencies": { - "micromark-util-character": "^1.0.0", - "micromark-util-symbol": "^1.0.0", - "micromark-util-types": "^1.0.0" + "micromark-util-character": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" } }, "node_modules/micromark-util-combine-extensions": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-combine-extensions/-/micromark-util-combine-extensions-1.1.0.tgz", - "integrity": "sha512-Q20sp4mfNf9yEqDL50WwuWZHUrCO4fEyeDCnMGmG5Pr0Cz15Uo7KBs6jq+dq0EgX4DPwwrh9m0X+zPV1ypFvUA==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-combine-extensions/-/micromark-util-combine-extensions-2.0.0.tgz", + "integrity": "sha512-vZZio48k7ON0fVS3CUgFatWHoKbbLTK/rT7pzpJ4Bjp5JjkZeasRfrS9wsBdDJK2cJLHMckXZdzPSSr1B8a4oQ==", "dev": true, "funding": [ { @@ -4237,14 +4124,14 @@ } ], "dependencies": { - "micromark-util-chunked": "^1.0.0", - "micromark-util-types": "^1.0.0" + "micromark-util-chunked": "^2.0.0", + "micromark-util-types": "^2.0.0" } }, "node_modules/micromark-util-decode-numeric-character-reference": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-decode-numeric-character-reference/-/micromark-util-decode-numeric-character-reference-1.1.0.tgz", - "integrity": "sha512-m9V0ExGv0jB1OT21mrWcuf4QhP46pH1KkfWy9ZEezqHKAxkj4mPCy3nIH1rkbdMlChLHX531eOrymlwyZIf2iw==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-decode-numeric-character-reference/-/micromark-util-decode-numeric-character-reference-2.0.0.tgz", + "integrity": "sha512-pIgcsGxpHEtTG/rPJRz/HOLSqp5VTuIIjXlPI+6JSDlK2oljApusG6KzpS8AF0ENUMCHlC/IBb5B9xdFiVlm5Q==", "dev": true, "funding": [ { @@ -4257,13 +4144,13 @@ } ], "dependencies": { - "micromark-util-symbol": "^1.0.0" + "micromark-util-symbol": "^2.0.0" } }, "node_modules/micromark-util-decode-string": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-decode-string/-/micromark-util-decode-string-1.1.0.tgz", - "integrity": "sha512-YphLGCK8gM1tG1bd54azwyrQRjCFcmgj2S2GoJDNnh4vYtnL38JS8M4gpxzOPNyHdNEpheyWXCTnnTDY3N+NVQ==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-decode-string/-/micromark-util-decode-string-2.0.0.tgz", + "integrity": "sha512-r4Sc6leeUTn3P6gk20aFMj2ntPwn6qpDZqWvYmAG6NgvFTIlj4WtrAudLi65qYoaGdXYViXYw2pkmn7QnIFasA==", "dev": true, "funding": [ { @@ -4277,15 +4164,15 @@ ], "dependencies": { "decode-named-character-reference": "^1.0.0", - "micromark-util-character": "^1.0.0", - "micromark-util-decode-numeric-character-reference": "^1.0.0", - "micromark-util-symbol": "^1.0.0" + "micromark-util-character": "^2.0.0", + "micromark-util-decode-numeric-character-reference": "^2.0.0", + "micromark-util-symbol": "^2.0.0" } }, "node_modules/micromark-util-encode": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-encode/-/micromark-util-encode-1.1.0.tgz", - "integrity": "sha512-EuEzTWSTAj9PA5GOAs992GzNh2dGQO52UvAbtSOMvXTxv3Criqb6IOzJUBCmEqrrXSblJIJBbFFv6zPxpreiJw==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-encode/-/micromark-util-encode-2.0.0.tgz", + "integrity": "sha512-pS+ROfCXAGLWCOc8egcBvT0kf27GoWMqtdarNfDcjb6YLuV5cM3ioG45Ys2qOVqeqSbjaKg72vU+Wby3eddPsA==", "dev": true, "funding": [ { @@ -4299,9 +4186,9 @@ ] }, "node_modules/micromark-util-html-tag-name": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/micromark-util-html-tag-name/-/micromark-util-html-tag-name-1.2.0.tgz", - "integrity": "sha512-VTQzcuQgFUD7yYztuQFKXT49KghjtETQ+Wv/zUjGSGBioZnkA4P1XXZPT1FHeJA6RwRXSF47yvJ1tsJdoxwO+Q==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-html-tag-name/-/micromark-util-html-tag-name-2.0.0.tgz", + "integrity": "sha512-xNn4Pqkj2puRhKdKTm8t1YHC/BAjx6CEwRFXntTaRf/x16aqka6ouVoutm+QdkISTlT7e2zU7U4ZdlDLJd2Mcw==", "dev": true, "funding": [ { @@ -4315,9 +4202,9 @@ ] }, "node_modules/micromark-util-normalize-identifier": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-normalize-identifier/-/micromark-util-normalize-identifier-1.1.0.tgz", - "integrity": "sha512-N+w5vhqrBihhjdpM8+5Xsxy71QWqGn7HYNUvch71iV2PM7+E3uWGox1Qp90loa1ephtCxG2ftRV/Conitc6P2Q==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-normalize-identifier/-/micromark-util-normalize-identifier-2.0.0.tgz", + "integrity": "sha512-2xhYT0sfo85FMrUPtHcPo2rrp1lwbDEEzpx7jiH2xXJLqBuy4H0GgXk5ToU8IEwoROtXuL8ND0ttVa4rNqYK3w==", "dev": true, "funding": [ { @@ -4330,13 +4217,13 @@ } ], "dependencies": { - "micromark-util-symbol": "^1.0.0" + "micromark-util-symbol": "^2.0.0" } }, "node_modules/micromark-util-resolve-all": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-resolve-all/-/micromark-util-resolve-all-1.1.0.tgz", - "integrity": "sha512-b/G6BTMSg+bX+xVCshPTPyAu2tmA0E4X98NSR7eIbeC6ycCqCeE7wjfDIgzEbkzdEVJXRtOG4FbEm/uGbCRouA==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-resolve-all/-/micromark-util-resolve-all-2.0.0.tgz", + "integrity": "sha512-6KU6qO7DZ7GJkaCgwBNtplXCvGkJToU86ybBAUdavvgsCiG8lSSvYxr9MhwmQ+udpzywHsl4RpGJsYWG1pDOcA==", "dev": true, "funding": [ { @@ -4349,13 +4236,13 @@ } ], "dependencies": { - "micromark-util-types": "^1.0.0" + "micromark-util-types": "^2.0.0" } }, "node_modules/micromark-util-sanitize-uri": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-1.2.0.tgz", - "integrity": "sha512-QO4GXv0XZfWey4pYFndLUKEAktKkG5kZTdUNaTAkzbuJxn2tNBOr+QtxR2XpWaMhbImT2dPzyLrPXLlPhph34A==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-2.0.0.tgz", + "integrity": "sha512-WhYv5UEcZrbAtlsnPuChHUAsu/iBPOVaEVsntLBIdpibO0ddy8OzavZz3iL2xVvBZOpolujSliP65Kq0/7KIYw==", "dev": true, "funding": [ { @@ -4368,15 +4255,15 @@ } ], "dependencies": { - "micromark-util-character": "^1.0.0", - "micromark-util-encode": "^1.0.0", - "micromark-util-symbol": "^1.0.0" + "micromark-util-character": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-symbol": "^2.0.0" } }, "node_modules/micromark-util-subtokenize": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-subtokenize/-/micromark-util-subtokenize-1.1.0.tgz", - "integrity": "sha512-kUQHyzRoxvZO2PuLzMt2P/dwVsTiivCK8icYTeR+3WgbuPqfHgPPy7nFKbeqRivBvn/3N3GBiNC+JRTMSxEC7A==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-subtokenize/-/micromark-util-subtokenize-2.0.0.tgz", + "integrity": "sha512-vc93L1t+gpR3p8jxeVdaYlbV2jTYteDje19rNSS/H5dlhxUYll5Fy6vJ2cDwP8RnsXi818yGty1ayP55y3W6fg==", "dev": true, "funding": [ { @@ -4389,16 +4276,16 @@ } ], "dependencies": { - "micromark-util-chunked": "^1.0.0", - "micromark-util-symbol": "^1.0.0", - "micromark-util-types": "^1.0.0", - "uvu": "^0.5.0" + "devlop": "^1.0.0", + "micromark-util-chunked": "^2.0.0", + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" } }, "node_modules/micromark-util-symbol": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-1.1.0.tgz", - "integrity": "sha512-uEjpEYY6KMs1g7QfJ2eX1SQEV+ZT4rUD3UcF6l57acZvLNK7PBZL+ty82Z1qhK1/yXIY4bdx04FKMgR0g4IAag==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.0.tgz", + "integrity": "sha512-8JZt9ElZ5kyTnO94muPxIGS8oyElRJaiJO8EzV6ZSyGQ1Is8xwl4Q45qU5UOg+bGH4AikWziz0iN4sFLWs8PGw==", "dev": true, "funding": [ { @@ -4412,9 +4299,9 @@ ] }, "node_modules/micromark-util-types": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-1.1.0.tgz", - "integrity": "sha512-ukRBgie8TIAcacscVHSiddHjO4k/q3pnedmzMQ4iwDcK0FtFCohKOlFbaOL/mPgfnPsL3C1ZyxJa4sbWrBl3jg==", + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-2.0.0.tgz", + "integrity": "sha512-oNh6S2WMHWRZrmutsRmDDfkzKtxF+bc2VxLC9dvtrDIRFln627VsFP6fLMgTryGDljgLPjkrzQSDcPrjPyDJ5w==", "dev": true, "funding": [ { @@ -4492,15 +4379,6 @@ "url": "https://github.com/sponsors/ljharb" } }, - "node_modules/mri": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/mri/-/mri-1.2.0.tgz", - "integrity": "sha512-tzzskb3bG8LvYGFF/mDTpq3jpI6Q9wc3LEmBaghu+DdCssd1FakN7Bc0hVNmEyGq1bq3RgfkCb3cmQLpNPOroA==", - "dev": true, - "engines": { - "node": ">=4" - } - }, "node_modules/ms": { "version": "2.1.3", "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", @@ -4553,11 +4431,6 @@ "node": ">=0.10.0" } }, - "node_modules/oauth": { - "version": "0.10.0", - "resolved": "https://registry.npmjs.org/oauth/-/oauth-0.10.0.tgz", - "integrity": "sha512-1orQ9MT1vHFGQxhuy7E/0gECD3fd2fCC+PIX+/jgmU/gI3EpRocXtmtvxCO5x3WZ443FLTLFWNDjl5MPJf9u+Q==" - }, "node_modules/object-assign": { "version": "4.1.1", "resolved": "https://registry.npmjs.org/object-assign/-/object-assign-4.1.1.tgz", @@ -5034,14 +4907,14 @@ } }, "node_modules/prettier-plugin-jsdoc": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/prettier-plugin-jsdoc/-/prettier-plugin-jsdoc-1.0.2.tgz", - "integrity": "sha512-mhLT3qiSmfzjOEDvgLntX3XmSJaiDrgoN7WmOp4IH2mZ6LhbvZAnPDJH3Rs0k1O6WR7HcmM92fU1ArB0ALLG+A==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/prettier-plugin-jsdoc/-/prettier-plugin-jsdoc-1.1.1.tgz", + "integrity": "sha512-yA13k0StQ+g0RJBrmo2IldVSp3ANXlJdsNzQNhGtQ0LY7JFC+u01No/1Z9xp0ZhT4u98BXlPAc4SC0iambqy5A==", "dev": true, "dependencies": { "binary-searching": "^2.0.5", "comment-parser": "^1.4.0", - "mdast-util-from-markdown": "^1.2.0" + "mdast-util-from-markdown": "^2.0.0" }, "engines": { "node": ">=14.13.1 || >=16.0.0" @@ -5185,9 +5058,9 @@ } }, "node_modules/resolve": { - "version": "1.22.6", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.6.tgz", - "integrity": "sha512-njhxM7mV12JfufShqGy3Rz8j11RPdLy4xi15UurGJeoHLfJpVXKdh3ueuOqbYUcDZnffr6X739JBo5LzyahEsw==", + "version": "1.22.8", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.22.8.tgz", + "integrity": "sha512-oKWePCxqpd6FlLvGV1VU0x7bkPmmCNolxzjMf4NczoDnQcIWrAF+cPtZn5i6n+RfD2d9i0tzpKnG6Yk168yIyw==", "dev": true, "dependencies": { "is-core-module": "^2.13.0", @@ -5288,18 +5161,6 @@ "queue-microtask": "^1.2.2" } }, - "node_modules/sade": { - "version": "1.8.1", - "resolved": "https://registry.npmjs.org/sade/-/sade-1.8.1.tgz", - "integrity": "sha512-xal3CZX1Xlo/k4ApwCFrHVACi9fBqJ7V+mwhBsuf/1IOKbBy098Fex+Wa/5QMubw09pSZ/u8EY8PWgevJsXp1A==", - "dev": true, - "dependencies": { - "mri": "^1.1.0" - }, - "engines": { - "node": ">=6" - } - }, "node_modules/safe-array-concat": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/safe-array-concat/-/safe-array-concat-1.0.1.tgz", @@ -5410,9 +5271,9 @@ } }, "node_modules/shiki": { - "version": "0.14.4", - "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.4.tgz", - "integrity": "sha512-IXCRip2IQzKwxArNNq1S+On4KPML3Yyn8Zzs/xRgcgOWIr8ntIK3IKzjFPfjy/7kt9ZMjc+FItfqHRBg8b6tNQ==", + "version": "0.14.5", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-0.14.5.tgz", + "integrity": "sha512-1gCAYOcmCFONmErGTrS1fjzJLA7MGZmKzrBNX7apqSwhyITJg2O102uFzXUeBxNnEkDA9vHIKLyeKq0V083vIw==", "dev": true, "dependencies": { "ansi-sequence-parser": "^1.1.0", @@ -5448,9 +5309,9 @@ } }, "node_modules/sinon": { - "version": "16.0.0", - "resolved": "https://registry.npmjs.org/sinon/-/sinon-16.0.0.tgz", - "integrity": "sha512-B8AaZZm9CT5pqe4l4uWJztfD/mOTa7dL8Qo0W4+s+t74xECOgSZDDQCBjNgIK3+n4kyxQrSTv2V5ul8K25qkiQ==", + "version": "16.1.0", + "resolved": "https://registry.npmjs.org/sinon/-/sinon-16.1.0.tgz", + "integrity": "sha512-ZSgzF0vwmoa8pq0GEynqfdnpEDyP1PkYmEChnkjW0Vyh8IDlyFEJ+fkMhCP0il6d5cJjPl2PUsnUSAuP5sttOQ==", "dev": true, "dependencies": { "@sinonjs/commons": "^3.0.0", @@ -5941,9 +5802,9 @@ } }, "node_modules/typedoc": { - "version": "0.25.1", - "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.1.tgz", - "integrity": "sha512-c2ye3YUtGIadxN2O6YwPEXgrZcvhlZ6HlhWZ8jQRNzwLPn2ylhdGqdR8HbyDRyALP8J6lmSANILCkkIdNPFxqA==", + "version": "0.25.2", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.25.2.tgz", + "integrity": "sha512-286F7BeATBiWe/qC4PCOCKlSTwfnsLbC/4cZ68oGBbvAqb9vV33quEOXx7q176OXotD+JdEerdQ1OZGJ818lnA==", "dev": true, "dependencies": { "lunr": "^2.3.9", @@ -6023,12 +5884,12 @@ } }, "node_modules/unist-util-stringify-position": { - "version": "3.0.3", - "resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-3.0.3.tgz", - "integrity": "sha512-k5GzIBZ/QatR8N5X2y+drfpWG8IDBzdnVj6OInRNWm1oXrzydiaAT2OQiA8DPRRZyAKb9b6I2a6PxYklZD0gKg==", + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-4.0.0.tgz", + "integrity": "sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==", "dev": true, "dependencies": { - "@types/unist": "^2.0.0" + "@types/unist": "^3.0.0" }, "funding": { "type": "opencollective", @@ -6044,24 +5905,6 @@ "punycode": "^2.1.0" } }, - "node_modules/uvu": { - "version": "0.5.6", - "resolved": "https://registry.npmjs.org/uvu/-/uvu-0.5.6.tgz", - "integrity": "sha512-+g8ENReyr8YsOc6fv/NVJs2vFdHBnBNdfE49rshrTzDWOlUx4Gq7KOS2GD8eqhy2j+Ejq29+SbKH8yjkAqXqoA==", - "dev": true, - "dependencies": { - "dequal": "^2.0.0", - "diff": "^5.0.0", - "kleur": "^4.0.3", - "sade": "^1.7.3" - }, - "bin": { - "uvu": "bin.js" - }, - "engines": { - "node": ">=8" - } - }, "node_modules/v8-compile-cache-lib": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", diff --git a/package.json b/package.json index 1a03563f76..44882945df 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "jira.js", - "version": "2.20.1", + "version": "3.0.0", "description": "A comprehensive JavaScript/TypeScript library designed for both Node.JS and browsers, facilitating seamless interaction with the Atlassian Jira API.", "main": "out/index.js", "types": "out/index.d.ts", @@ -21,8 +21,9 @@ "scripts": { "build": "tsc", "prettier": "prettier --write src", - "lint": "npm run lint:tests && npm run lint:src:agile && npm run lint:src:clients && npm run lint:src:services && npm run lint:src:version2 && npm run lint:src:version3 && npm run lint:src:files", + "lint": "npm run lint:tests && npm run lint:examples && npm run lint:src:agile && npm run lint:src:clients && npm run lint:src:services && npm run lint:src:version2 && npm run lint:src:version3 && npm run lint:src:files", "lint:tests": "npm run lint:base -- tests", + "lint:examples": "npm run lint:base -- examples", "lint:src:agile": "npm run lint:base -- src/agile", "lint:src:clients": "npm run lint:base -- src/clients", "lint:src:services": "npm run lint:base -- src/services", @@ -31,12 +32,12 @@ "lint:src:serviceDesk": "npm run lint:base -- src/serviceDesk", "lint:src:files": "npm run lint:base -- src/*.ts", "lint:base": "eslint --ext .ts", - "lint:fix": "npm run lint:tests -- --fix && npm run lint:src:agile -- --fix && npm run lint:src:clients -- --fix && npm run lint:src:services -- --fix && npm run lint:src:version2 -- --fix && npm run lint:src:version3 -- --fix && npm run lint:src:serviceDesk -- --fix && npm run lint:src:files -- --fix", + "lint:fix": "npm run lint:tests -- --fix && npm run lint:examples -- --fix && npm run lint:src:agile -- --fix && npm run lint:src:clients -- --fix && npm run lint:src:services -- --fix && npm run lint:src:version2 -- --fix && npm run lint:src:version3 -- --fix && npm run lint:src:serviceDesk -- --fix && npm run lint:src:files -- --fix", "doc": "typedoc --name \"Jira.js - Jira Cloud API library\" --out docs ./src/index.ts --plugin typedoc-plugin-extras --footerDate --footerTime --footerTypedocVersion --favicon https://svgshare.com/i/bHF.svg", "test": "npm run test:unit && npm run test:integration", "test:unit": "ava tests/unit --timeout=2m -с 8", "test:integration": "ava --timeout=2m --fail-fast --no-worker-threads -c 1 -s tests/integration/**/*.test.ts", - "replace:all": "npm run replace:permissions:version2 && npm run replace:permissions:version3 && npm run replace:pagination:version2 && npm run replace:pagination:version3 && npm run replace:async:version2 && npm run replace:async:version3 && npm run replace:expansion:version2 && npm run replace:expansion:version3 && npm run replace:groupMember:version2 && npm run replace:workflowPaginated:version2", + "replace:all": "npm run replace:permissions:version2 && npm run replace:permissions:version3 && npm run replace:pagination:version2 && npm run replace:pagination:version3 && npm run replace:async:version2 && npm run replace:async:version3 && npm run replace:expansion:version2 && npm run replace:expansion:version3 && npm run replace:ordering:version2 && npm run replace:ordering:version3 && npm run replace:groupMember:version2 && npm run replace:workflowPaginated:version2", "replace:permissions:version2": "grep -rl \"(#permissions)\" ./src/version2 | xargs sed -i '' 's/(#permissions)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v2\\/intro\\/#permissions)/g'", "replace:permissions:version3": "grep -rl \"(#permissions)\" ./src/version3 | xargs sed -i '' 's/(#permissions)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v3\\/intro\\/#permissions)/g'", "replace:pagination:version2": "grep -rl \"(#pagination)\" ./src/version2 | xargs sed -i '' 's/(#pagination)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v2\\/intro\\/#pagination)/g'", @@ -45,6 +46,8 @@ "replace:async:version3": "grep -rl \"(#async)\" ./src/version3 | xargs sed -i '' 's/(#async)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v3\\/intro\\/#async-operations)/g'", "replace:expansion:version2": "grep -rl \"(#expansion)\" ./src/version2 | xargs sed -i '' 's/(#expansion)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v2\\/intro\\/#expansion)/g'", "replace:expansion:version3": "grep -rl \"(#expansion)\" ./src/version3 | xargs sed -i '' 's/(#expansion)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v3\\/intro\\/#expansion)/g'", + "replace:ordering:version2": "grep -rl \"(#ordering)\" ./src/version2 | xargs sed -i '' 's/(#ordering)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v2\\/intro\\/#ordering)/g'", + "replace:ordering:version3": "grep -rl \"(#ordering)\" ./src/version3 | xargs sed -i '' 's/(#ordering)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v3\\/intro\\/#ordering)/g'", "replace:groupMember:version2": "grep -rl \"(#api-rest-api-2-group-member-get)\" ./src/version2 | xargs sed -i '' 's/(#api-rest-api-2-group-member-get)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v2\\/api-group-groups\\/#api-rest-api-2-group-member-get)/g'", "replace:workflowPaginated:version2": "grep -rl \"(#api-rest-api-2-workflow-search-get)\" ./src/version2 | xargs sed -i '' 's/(#api-rest-api-2-workflow-search-get)/(https:\\/\\/developer.atlassian.com\\/cloud\\/jira\\/platform\\/rest\\/v2\\/api-group-workflows\\/#api-rest-api-2-workflow-search-get)/g'", "code:formatting": "npm run replace:all && npm run prettier && npm run lint:fix" @@ -63,33 +66,29 @@ }, "devDependencies": { "@swc-node/register": "^1.6.8", - "@swc/helpers": "^0.5.2", - "@types/express": "^4.17.18", - "@types/node": "^20.8.2", - "@types/oauth": "^0.9.2", - "@types/sinon": "^10.0.18", - "@typescript-eslint/eslint-plugin": "^6.7.4", - "@typescript-eslint/parser": "^6.7.4", + "@swc/helpers": "^0.5.3", + "@types/node": "^18.18.5", + "@types/sinon": "^10.0.19", + "@typescript-eslint/eslint-plugin": "^6.7.5", + "@typescript-eslint/parser": "^6.7.5", "ava": "^5.3.1", "dotenv": "^16.3.1", - "eslint": "^8.50.0", + "eslint": "^8.51.0", "eslint-config-airbnb": "^19.0.4", "eslint-config-airbnb-typescript": "^17.1.0", "eslint-import-resolver-typescript": "^3.6.1", "eslint-plugin-import": "^2.28.1", "prettier": "^3.0.3", - "prettier-plugin-jsdoc": "1.0.2", - "sinon": "^16.0.0", + "prettier-plugin-jsdoc": "^1.1.1", + "sinon": "^16.1.0", "ts-node": "^10.9.1", - "typedoc": "^0.25.1", + "typedoc": "^0.25.2", "typedoc-plugin-extras": "^3.0.0", "typescript": "^5.2.2" }, "dependencies": { - "atlassian-jwt": "^2.0.2", "axios": "^1.5.1", "form-data": "^4.0.0", - "oauth": "^0.10.0", "tslib": "^2.6.2" } } diff --git a/src/agile/builds.ts b/src/agile/builds.ts index df0d0ceaa4..1e55fc1fa0 100644 --- a/src/agile/builds.ts +++ b/src/agile/builds.ts @@ -113,7 +113,7 @@ export class Builds { url: '/rest/builds/0.1/bulkByProperties', method: 'DELETE', params: { - _updateSequenceNumber: parameters._updateSequenceNumber || parameters.updateSequenceNumber, + _updateSequenceNumber: parameters.updateSequenceNumber, }, }; @@ -181,7 +181,7 @@ export class Builds { url: `/rest/builds/0.1/pipelines/${parameters.pipelineId}/builds/${parameters.buildNumber}`, method: 'DELETE', params: { - _updateSequenceNumber: parameters._updateSequenceNumber || parameters.updateSequenceNumber, + _updateSequenceNumber: parameters.updateSequenceNumber, }, }; diff --git a/src/agile/client/agileClient.ts b/src/agile/client/agileClient.ts index ffd6556dd9..fc073b481a 100644 --- a/src/agile/client/agileClient.ts +++ b/src/agile/client/agileClient.ts @@ -8,7 +8,6 @@ import { Epic, FeatureFlags, Issue, - Project, RemoteLinks, SecurityInformation, Sprint, @@ -23,7 +22,6 @@ export class AgileClient extends BaseClient { epic = new Epic(this); featureFlags = new FeatureFlags(this); issue = new Issue(this); - project = new Project(this); remoteLinks = new RemoteLinks(this); securityInformation = new SecurityInformation(this); sprint = new Sprint(this); diff --git a/src/agile/deployments.ts b/src/agile/deployments.ts index 358645e30c..0ef2a56683 100644 --- a/src/agile/deployments.ts +++ b/src/agile/deployments.ts @@ -114,7 +114,7 @@ export class Deployments { url: '/rest/deployments/0.1/bulkByProperties', method: 'DELETE', params: { - _updateSequenceNumber: parameters._updateSequenceNumber || parameters.updateSequenceNumber, + _updateSequenceNumber: parameters.updateSequenceNumber, }, }; @@ -192,7 +192,7 @@ export class Deployments { url: `/rest/deployments/0.1/pipelines/${parameters.pipelineId}/environments/${parameters.environmentId}/deployments/${parameters.deploymentSequenceNumber}`, method: 'DELETE', params: { - _updateSequenceNumber: parameters._updateSequenceNumber || parameters.updateSequenceNumber, + _updateSequenceNumber: parameters.updateSequenceNumber, }, }; diff --git a/src/agile/developmentInformation.ts b/src/agile/developmentInformation.ts index 13ddba0660..84f3abd848 100644 --- a/src/agile/developmentInformation.ts +++ b/src/agile/developmentInformation.ts @@ -91,7 +91,7 @@ export class DevelopmentInformation { url: `/rest/devinfo/0.10/repository/${parameters.repositoryId}`, method: 'DELETE', params: { - _updateSequenceId: parameters._updateSequenceId || parameters.updateSequenceId, + _updateSequenceId: parameters.updateSequenceId, }, }; @@ -129,7 +129,7 @@ export class DevelopmentInformation { url: '/rest/devinfo/0.10/bulkByProperties', method: 'DELETE', params: { - _updateSequenceId: parameters._updateSequenceId || parameters.updateSequenceId, + _updateSequenceId: parameters.updateSequenceId, }, }; @@ -166,7 +166,7 @@ export class DevelopmentInformation { url: '/rest/devinfo/0.10/existsByProperties', method: 'GET', params: { - _updateSequenceId: parameters._updateSequenceId || parameters.updateSequenceId, + _updateSequenceId: parameters.updateSequenceId, }, }; @@ -182,7 +182,7 @@ export class DevelopmentInformation { url: `/rest/devinfo/0.10/repository/${parameters.repositoryId}/${parameters.entityType}/${parameters.entityId}`, method: 'DELETE', params: { - _updateSequenceId: parameters._updateSequenceId || parameters.updateSequenceId, + _updateSequenceId: parameters.updateSequenceId, }, }; diff --git a/src/agile/featureFlags.ts b/src/agile/featureFlags.ts index 972a788dd2..cec77ba7d1 100644 --- a/src/agile/featureFlags.ts +++ b/src/agile/featureFlags.ts @@ -110,7 +110,7 @@ export class FeatureFlags { url: '/rest/featureflags/0.1/bulkByProperties', method: 'DELETE', params: { - _updateSequenceId: parameters?._updateSequenceId || parameters?.updateSequenceId, + _updateSequenceId: parameters?.updateSequenceId, }, }; @@ -184,7 +184,7 @@ export class FeatureFlags { url: `/rest/featureflags/0.1/flag/${parameters.featureFlagId}`, method: 'DELETE', params: { - _updateSequenceId: parameters._updateSequenceId || parameters.updateSequenceId, + _updateSequenceId: parameters.updateSequenceId, }, }; diff --git a/src/agile/index.ts b/src/agile/index.ts index 672e097ab0..998d88ae3f 100644 --- a/src/agile/index.ts +++ b/src/agile/index.ts @@ -6,7 +6,6 @@ export * from './developmentInformation'; export * from './epic'; export * from './featureFlags'; export * from './issue'; -export * from './project'; export * from './remoteLinks'; export * from './securityInformation'; export * from './sprint'; diff --git a/src/agile/models/basicUser.ts b/src/agile/models/basicUser.ts deleted file mode 100644 index 7e52a662f6..0000000000 --- a/src/agile/models/basicUser.ts +++ /dev/null @@ -1,46 +0,0 @@ -/** - * Details of a user's active status, identifiers, name, and avatars as permitted by the user's Atlassian Account - * privacy settings. However, be aware of these exceptions: - */ -export interface BasicUser { - /** - * @deprecated This property is deprecated in favor of accountId because of privacy changes. See the migration - * guide for details.
The key of the user. - */ - key?: string; - /** The URL of the user. */ - self?: string; - /** - * @deprecated This property is deprecated in favor of accountId because of privacy changes. See the migration - * guide for details.
The username of the user. - */ - name?: string; - /** The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */ - displayName?: string; - /** Whether the user is active. */ - active?: boolean; - /** - * The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, - * 5b10ac8d82e05b22cc7d4ef5. - */ - accountId?: string; - /** Details of a user's avatars. */ - avatarUrls?: { - /** The URL of the user's 24x24 pixel avatar. */ - '24x24'?: string; - /** The URL of the user's 16x16 pixel avatar. */ - '16x16'?: string; - /** The URL of the user's 32x32 pixel avatar. */ - '32x32'?: string; - /** The URL of the user's 48x48 pixel avatar. */ - '48x48'?: string; - }; -} diff --git a/src/agile/models/board.ts b/src/agile/models/board.ts index 0fa8c172b2..a7d91c6d77 100644 --- a/src/agile/models/board.ts +++ b/src/agile/models/board.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link Board} instead. */ -export type BoardBean = Board; - /** Details about a board. */ export interface Board { /** The ID of the board. */ @@ -14,20 +11,8 @@ export interface Board { /** The users and groups who own the board. */ admins?: { users?: { - /** - * @deprecated This property is deprecated in favor of `accountId` because of privacy changes. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The key of the user. - */ - key?: string; /** The URL of the user. */ self?: string; - /** - * @deprecated This property is deprecated in favor of `accountId` because of privacy changes. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The username of the user. - */ - name?: string; /** The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */ displayName?: string; /** Whether the user is active. */ diff --git a/src/agile/models/boardAdmins.ts b/src/agile/models/boardAdmins.ts deleted file mode 100644 index 9864e1ea55..0000000000 --- a/src/agile/models/boardAdmins.ts +++ /dev/null @@ -1,45 +0,0 @@ -/** @deprecated Use {@link BoardAdmins} instead. */ -export type BoardAdminsBean = BoardAdmins; - -/** The users and groups who own the board. */ -export interface BoardAdmins { - users?: { - /** - * @deprecated This property is deprecated in favor of `accountId` because of privacy changes. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The key of the user. - */ - key?: string; - /** The URL of the user. */ - self?: string; - /** - * @deprecated This property is deprecated in favor of `accountId` because of privacy changes. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The username of the user. - */ - name?: string; - /** The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */ - displayName?: string; - /** Whether the user is active. */ - active?: boolean; - /** - * The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, - * _5b10ac8d82e05b22cc7d4ef5_. - */ - accountId?: string; - avatarUrls?: { - /** The URL of the user's 24x24 pixel avatar. */ - '24x24'?: string; - /** The URL of the user's 32x32 pixel avatar. */ - '32x32'?: string; - /** The URL of the user's 48x48 pixel avatar. */ - '48x48'?: string; - /** The URL of the user's 16x16 pixel avatar. */ - '16x16'?: string; - }; - }[]; - groups?: { - name?: string; - self?: string; - }[]; -} diff --git a/src/agile/models/boardConfig.ts b/src/agile/models/boardConfig.ts deleted file mode 100644 index ea77b3feb5..0000000000 --- a/src/agile/models/boardConfig.ts +++ /dev/null @@ -1,42 +0,0 @@ -/** @deprecated Use {@link BoardConfig} instead. */ -export type BoardConfigBean = BoardConfig; - -export interface BoardConfig { - id?: number; - name?: string; - type?: string; - self?: string; - location?: { - type?: string; - projectKeyOrId?: string; - }; - filter?: { - id?: string; - self?: string; - }; - subQuery?: { - query?: string; - }; - columnConfig?: { - columns?: { - name?: string; - statuses?: { - id?: string; - self?: string; - }[]; - min?: number; - max?: number; - }[]; - constraintType?: string; - }; - estimation?: { - type?: string; - field?: { - fieldId?: string; - displayName?: string; - }; - }; - ranking?: { - rankCustomFieldId?: number; - }; -} diff --git a/src/agile/models/boardCreate.ts b/src/agile/models/boardCreate.ts deleted file mode 100644 index af2f10f162..0000000000 --- a/src/agile/models/boardCreate.ts +++ /dev/null @@ -1,12 +0,0 @@ -/** @deprecated Use {@link BoardCreate} instead. */ -export type BoardCreateBean = BoardCreate; - -export interface BoardCreate { - name?: string; - type?: string; - filterId?: number; - location?: { - type?: string; - projectKeyOrId?: string; - }; -} diff --git a/src/agile/models/boardFeature.ts b/src/agile/models/boardFeature.ts deleted file mode 100644 index 7480b4ce22..0000000000 --- a/src/agile/models/boardFeature.ts +++ /dev/null @@ -1,14 +0,0 @@ -/** @deprecated Use BoardFeature instead. */ -export type BoardFeatureBean = BoardFeature; - -/** @deprecated Use _Feature_ model instead. */ -export interface BoardFeature { - boardFeature?: string; - boardId?: number; - state?: string; - localisedName?: string; - localisedDescription?: string; - learnMoreLink?: string; - imageUri?: string; - toggleLocked?: boolean; -} diff --git a/src/agile/models/boardFeatureResponse.ts b/src/agile/models/boardFeatureResponse.ts deleted file mode 100644 index f515b4e4f1..0000000000 --- a/src/agile/models/boardFeatureResponse.ts +++ /dev/null @@ -1,16 +0,0 @@ -/** @deprecated Use BoardFeatureResponse instead. */ -export type BoardFeatureResponseBean = BoardFeatureResponse; - -/** @deprecated Use _FeatureResponse_ model instead. */ -export interface BoardFeatureResponse { - features?: { - boardFeature?: string; - boardId?: number; - state?: string; - localisedName?: string; - localisedDescription?: string; - learnMoreLink?: string; - imageUri?: string; - toggleLocked?: boolean; - }[]; -} diff --git a/src/agile/models/boardFeatureToggleRequest.ts b/src/agile/models/boardFeatureToggleRequest.ts deleted file mode 100644 index cfd431be92..0000000000 --- a/src/agile/models/boardFeatureToggleRequest.ts +++ /dev/null @@ -1,9 +0,0 @@ -/** @deprecated Use BoardFeatureToggleRequest instead. */ -export type BoardFeatureToggleRequestBean = BoardFeatureToggleRequest; - -/** @deprecated Use _FeatureToggleRequest_ model instead. */ -export interface BoardFeatureToggleRequest { - boardId?: number; - feature?: string; - enabling?: boolean; -} diff --git a/src/agile/models/boardFilter.ts b/src/agile/models/boardFilter.ts deleted file mode 100644 index 9a16db5f74..0000000000 --- a/src/agile/models/boardFilter.ts +++ /dev/null @@ -1,8 +0,0 @@ -/** @deprecated Use {@link BoardFilter} instead. */ -export type BoardFilterBean = BoardFilter; - -export interface BoardFilter { - id?: number; - self?: string; - name?: string; -} diff --git a/src/agile/models/boardLocation.ts b/src/agile/models/boardLocation.ts deleted file mode 100644 index 86b9805fda..0000000000 --- a/src/agile/models/boardLocation.ts +++ /dev/null @@ -1,15 +0,0 @@ -/** @deprecated Use {@link BoardLocation} instead. */ -export type BoardLocationBean = BoardLocation; - -/** The container that the board is located in. */ -export interface BoardLocation { - projectId?: number; - userId?: number; - userAccountId?: string; - displayName?: string; - projectName?: string; - projectKey?: string; - projectTypeKey?: string; - avatarURI?: string; - name?: string; -} diff --git a/src/agile/models/changeHistory.ts b/src/agile/models/changeHistory.ts deleted file mode 100644 index 0e6ff46cc9..0000000000 --- a/src/agile/models/changeHistory.ts +++ /dev/null @@ -1,136 +0,0 @@ -/** @deprecated Use ChangeHistory instead. */ -export type ChangeHistoryBean = ChangeHistory; - -export interface ChangeHistory { - /** The ID of the changelog. */ - id?: string; - author?: { - /** The URL of the user. */ - self?: string; - /** - * @deprecated This property is no longer available and will be removed from the documentation soon. See the deprecation - * notice for details. - */ - name?: string; - /** - * @deprecated This property is no longer available and will be removed from the documentation soon. See the deprecation - * notice for details. - */ - key?: string; - /** - * The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, - * 5b10ac8d82e05b22cc7d4ef5. - */ - accountId?: string; - /** The email address of the user. Depending on the user’s privacy settings, this may be returned as null. */ - emailAddress?: string; - /** Details about the avatars for an item. */ - avatarUrls?: { - /** The URL of the item's 16x16 pixel avatar. */ - '16x16'?: string; - /** The URL of the item's 24x24 pixel avatar. */ - '24x24'?: string; - /** The URL of the item's 32x32 pixel avatar. */ - '32x32'?: string; - /** The URL of the item's 48x48 pixel avatar. */ - '48x48'?: string; - }; - /** The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. */ - displayName?: string; - /** Whether the user is active. */ - active?: boolean; - /** - * The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as - * null. - */ - timeZone?: string; - /** - * The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application - * user) or 'customer' (Jira Service Desk customer user) - */ - accountType?: string; - }; - /** The date on which the change took place. */ - created?: string; - /** The list of items changed. */ - items?: { - /** The name of the field changed. */ - field?: string; - /** The type of the field changed. */ - fieldtype?: string; - /** The ID of the field changed. */ - fieldId?: string; - /** The details of the original value. */ - from?: string; - /** The details of the original value as a string. */ - fromString?: string; - /** The details of the new value. */ - to?: string; - /** The details of the new value as a string. */ - toString?: string; - }[]; - /** Details of issue history metadata. */ - historyMetadata?: { - /** The type of the history record. */ - type?: string; - /** The description of the history record. */ - description?: string; - /** The activity described in the history record. */ - activityDescription?: string; - /** The key of the activity described in the history record. */ - activityDescriptionKey?: string; - /** The description of the email address associated the history record. */ - emailDescription?: string; - /** The description key of the email address associated the history record. */ - emailDescriptionKey?: string; - /** Details of user or system associated with a issue history metadata item. */ - actor?: { - /** The ID of the user or system associated with a history record. */ - id?: string; - /** The display name of the user or system associated with a history record. */ - displayName?: string; - /** The key of the display name of the user or system associated with a history record. */ - displayNameKey?: string; - /** The type of the user or system associated with a history record. */ - type?: string; - /** The URL to an avatar for the user or system associated with a history record. */ - avatarUrl?: string; - /** The URL of the user or system associated with a history record. */ - url?: string; - }; - /** Details of user or system associated with a issue history metadata item. */ - generator?: { - /** The ID of the user or system associated with a history record. */ - id?: string; - /** The display name of the user or system associated with a history record. */ - displayName?: string; - /** The key of the display name of the user or system associated with a history record. */ - displayNameKey?: string; - /** The type of the user or system associated with a history record. */ - type?: string; - /** The URL to an avatar for the user or system associated with a history record. */ - avatarUrl?: string; - /** The URL of the user or system associated with a history record. */ - url?: string; - }; - /** Details of user or system associated with a issue history metadata item. */ - cause?: { - /** The ID of the user or system associated with a history record. */ - id?: string; - /** The display name of the user or system associated with a history record. */ - displayName?: string; - /** The key of the display name of the user or system associated with a history record. */ - displayNameKey?: string; - /** The type of the user or system associated with a history record. */ - type?: string; - /** The URL to an avatar for the user or system associated with a history record. */ - avatarUrl?: string; - /** The URL of the user or system associated with a history record. */ - url?: string; - }; - /** Additional arbitrary information about the history record. */ - extraData?: {}; - }; -} diff --git a/src/agile/models/changeItem.ts b/src/agile/models/changeItem.ts deleted file mode 100644 index 860fdf0260..0000000000 --- a/src/agile/models/changeItem.ts +++ /dev/null @@ -1,19 +0,0 @@ -/** @deprecated Use ChangeItem instead. */ -export type ChangeItemBean = ChangeItem; - -export interface ChangeItem { - /** The name of the field changed. */ - field?: string; - /** The type of the field changed. */ - fieldtype?: string; - /** The ID of the field changed. */ - fieldId?: string; - /** The details of the original value. */ - from?: string; - /** The details of the original value as a string. */ - fromString?: string; - /** The details of the new value. */ - to?: string; - /** The details of the new value as a string. */ - toString?: string; -} diff --git a/src/agile/models/changelog.ts b/src/agile/models/changelog.ts deleted file mode 100644 index 6b95c6a411..0000000000 --- a/src/agile/models/changelog.ts +++ /dev/null @@ -1,290 +0,0 @@ -/** @deprecated Use {@link Changelog} instead. */ -export type ChangelogBean = Changelog; - -/** A changelog. */ -export interface Changelog { - /** The index of the first item returned on the page. */ - startAt?: number; - /** The maximum number of results that could be on the page. */ - maxResults?: number; - /** The number of results on the page. */ - total?: number; - /** The list of changelogs. */ - histories?: { - /** The ID of the changelog. */ - id?: string; - author?: { - /** The URL of the user. */ - self?: string; - /** - * @deprecated This property is no longer available and will be removed from the documentation soon. See the deprecation - * notice for details. - */ - name?: string; - /** - * @deprecated This property is no longer available and will be removed from the documentation soon. See the deprecation - * notice for details. - */ - key?: string; - /** - * The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, - * 5b10ac8d82e05b22cc7d4ef5. - */ - accountId?: string; - /** The email address of the user. Depending on the user’s privacy settings, this may be returned as null. */ - emailAddress?: string; - /** Details about the avatars for an item. */ - avatarUrls?: { - /** The URL of the item's 16x16 pixel avatar. */ - '16x16'?: string; - /** The URL of the item's 24x24 pixel avatar. */ - '24x24'?: string; - /** The URL of the item's 32x32 pixel avatar. */ - '32x32'?: string; - /** The URL of the item's 48x48 pixel avatar. */ - '48x48'?: string; - }; - /** The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. */ - displayName?: string; - /** Whether the user is active. */ - active?: boolean; - /** - * The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned - * as null. - */ - timeZone?: string; - /** - * The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' - * (application user) or 'customer' (Jira Service Desk customer user) - */ - accountType?: string; - }; - /** The date on which the change took place. */ - created?: string; - /** The list of items changed. */ - items?: { - /** The name of the field changed. */ - field?: string; - /** The type of the field changed. */ - fieldtype?: string; - /** The ID of the field changed. */ - fieldId?: string; - /** The details of the original value. */ - from?: string; - /** The details of the original value as a string. */ - fromString?: string; - /** The details of the new value. */ - to?: string; - /** The details of the new value as a string. */ - toString?: string; - }[]; - /** Details of issue history metadata. */ - historyMetadata?: { - /** The type of the history record. */ - type?: string; - /** The description of the history record. */ - description?: string; - /** The activity described in the history record. */ - activityDescription?: string; - /** The key of the activity described in the history record. */ - activityDescriptionKey?: string; - /** The description of the email address associated the history record. */ - emailDescription?: string; - /** The description key of the email address associated the history record. */ - emailDescriptionKey?: string; - /** Details of user or system associated with a issue history metadata item. */ - actor?: { - /** The ID of the user or system associated with a history record. */ - id?: string; - /** The display name of the user or system associated with a history record. */ - displayName?: string; - /** The key of the display name of the user or system associated with a history record. */ - displayNameKey?: string; - /** The type of the user or system associated with a history record. */ - type?: string; - /** The URL to an avatar for the user or system associated with a history record. */ - avatarUrl?: string; - /** The URL of the user or system associated with a history record. */ - url?: string; - }; - /** Details of user or system associated with a issue history metadata item. */ - generator?: { - /** The ID of the user or system associated with a history record. */ - id?: string; - /** The display name of the user or system associated with a history record. */ - displayName?: string; - /** The key of the display name of the user or system associated with a history record. */ - displayNameKey?: string; - /** The type of the user or system associated with a history record. */ - type?: string; - /** The URL to an avatar for the user or system associated with a history record. */ - avatarUrl?: string; - /** The URL of the user or system associated with a history record. */ - url?: string; - }; - /** Details of user or system associated with a issue history metadata item. */ - cause?: { - /** The ID of the user or system associated with a history record. */ - id?: string; - /** The display name of the user or system associated with a history record. */ - displayName?: string; - /** The key of the display name of the user or system associated with a history record. */ - displayNameKey?: string; - /** The type of the user or system associated with a history record. */ - type?: string; - /** The URL to an avatar for the user or system associated with a history record. */ - avatarUrl?: string; - /** The URL of the user or system associated with a history record. */ - url?: string; - }; - /** Additional arbitrary information about the history record. */ - extraData?: {}; - }; - }[]; - /** The ID of the changelog. */ - id?: string; - /** - * User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions: - * - * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, - * `displayName` provides an indication and other parameters have default values or are blank (for example, email is - * blank). User record corrupted: This occurs as a results of events such as a server import and can only happen to - * deleted users. In this case, `accountId` returns _unknown_ and all other parameters have fallback values. User - * record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have - * fallback values. - */ - author?: { - /** The URL of the user. */ - self?: string; - /** - * @deprecated This property is no longer available and will be removed from the documentation soon. See the - * [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - name?: string; - /** - * @deprecated This property is no longer available and will be removed from the documentation soon. See the - * [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - key?: string; - /** - * The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, - * _5b10ac8d82e05b22cc7d4ef5_. - */ - accountId?: string; - /** The email address of the user. Depending on the user’s privacy settings, this may be returned as null. */ - emailAddress?: string; - avatarUrls?: { - /** The URL of the item's 16x16 pixel avatar. */ - '16x16'?: string; - /** The URL of the item's 24x24 pixel avatar. */ - '24x24'?: string; - /** The URL of the item's 32x32 pixel avatar. */ - '32x32'?: string; - /** The URL of the item's 48x48 pixel avatar. */ - '48x48'?: string; - }; - /** The display name of the user. Depending on the user’s privacy settings, this may return an alternative value. */ - displayName?: string; - /** Whether the user is active. */ - active?: boolean; - /** - * The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as - * null. - */ - timeZone?: string; - /** - * The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application - * user) or 'customer' (Jira Service Desk customer user) - */ - accountType?: string; - }; - /** The date on which the change took place. */ - created?: string; - /** The list of items changed. */ - items?: { - /** The name of the field changed. */ - field?: string; - /** The type of the field changed. */ - fieldtype?: string; - /** The ID of the field changed. */ - fieldId?: string; - /** The details of the original value. */ - from?: string; - /** The details of the original value as a string. */ - fromString?: string; - /** The details of the new value. */ - to?: string; - /** The details of the new value as a string. */ - toString?: string; - }[]; - /** Details of issue history metadata. */ - historyMetadata?: { - /** The type of the history record. */ - type?: string; - /** The description of the history record. */ - description?: string; - /** The description key of the history record. */ - descriptionKey?: string; - /** The activity described in the history record. */ - activityDescription?: string; - /** The key of the activity described in the history record. */ - activityDescriptionKey?: string; - /** The description of the email address associated the history record. */ - emailDescription?: string; - /** The description key of the email address associated the history record. */ - emailDescriptionKey?: string; - /** Details of user or system associated with a issue history metadata item. */ - actor?: { - /** The ID of the user or system associated with a history record. */ - id?: string; - /** The display name of the user or system associated with a history record. */ - displayName?: string; - /** The key of the display name of the user or system associated with a history record. */ - displayNameKey?: string; - /** The type of the user or system associated with a history record. */ - type?: string; - /** The URL to an avatar for the user or system associated with a history record. */ - avatarUrl?: string; - /** The URL of the user or system associated with a history record. */ - url?: string; - }; - /** Details of user or system associated with a issue history metadata item. */ - generator?: { - /** The ID of the user or system associated with a history record. */ - id?: string; - /** The display name of the user or system associated with a history record. */ - displayName?: string; - /** The key of the display name of the user or system associated with a history record. */ - displayNameKey?: string; - /** The type of the user or system associated with a history record. */ - type?: string; - /** The URL to an avatar for the user or system associated with a history record. */ - avatarUrl?: string; - /** The URL of the user or system associated with a history record. */ - url?: string; - }; - /** Details of user or system associated with a issue history metadata item. */ - cause?: { - /** The ID of the user or system associated with a history record. */ - id?: string; - /** The display name of the user or system associated with a history record. */ - displayName?: string; - /** The key of the display name of the user or system associated with a history record. */ - displayNameKey?: string; - /** The type of the user or system associated with a history record. */ - type?: string; - /** The URL to an avatar for the user or system associated with a history record. */ - avatarUrl?: string; - /** The URL of the user or system associated with a history record. */ - url?: string; - }; - /** Additional arbitrary information about the history record. */ - extraData?: {}; - }; -} diff --git a/src/agile/models/color.ts b/src/agile/models/color.ts deleted file mode 100644 index c2c77c2a85..0000000000 --- a/src/agile/models/color.ts +++ /dev/null @@ -1,6 +0,0 @@ -/** @deprecated Use {@link Color} instead. */ -export type ColorBean = Color; - -export interface Color { - key?: string; -} diff --git a/src/agile/models/column.ts b/src/agile/models/column.ts deleted file mode 100644 index 8af650c5de..0000000000 --- a/src/agile/models/column.ts +++ /dev/null @@ -1,12 +0,0 @@ -/** @deprecated Use {@link Column} instead. */ -export type ColumnBean = Column; - -export interface Column { - name?: string; - statuses?: { - id?: string; - self?: string; - }[]; - min?: number; - max?: number; -} diff --git a/src/agile/models/columnConfig.ts b/src/agile/models/columnConfig.ts deleted file mode 100644 index 1d47d73c55..0000000000 --- a/src/agile/models/columnConfig.ts +++ /dev/null @@ -1,15 +0,0 @@ -/** @deprecated Use {@link ColumnConfig} instead. */ -export type ColumnConfigBean = ColumnConfig; - -export interface ColumnConfig { - columns?: { - name?: string; - statuses?: { - id?: string; - self?: string; - }[]; - min?: number; - max?: number; - }[]; - constraintType?: string; -} diff --git a/src/agile/models/createBoard.ts b/src/agile/models/createBoard.ts index 8c843ce978..c0f01da7a5 100644 --- a/src/agile/models/createBoard.ts +++ b/src/agile/models/createBoard.ts @@ -11,20 +11,8 @@ export interface CreateBoard { /** The users and groups who own the board. */ admins?: { users?: { - /** - * @deprecated This property is deprecated in favor of `accountId` because of privacy changes. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The key of the user. - */ - key?: string; /** The URL of the user. */ self?: string; - /** - * @deprecated This property is deprecated in favor of `accountId` because of privacy changes. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The username of the user. - */ - name?: string; /** The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */ displayName?: string; /** Whether the user is active. */ diff --git a/src/agile/models/editMeta.ts b/src/agile/models/editMeta.ts deleted file mode 100644 index ad78676a7b..0000000000 --- a/src/agile/models/editMeta.ts +++ /dev/null @@ -1,7 +0,0 @@ -/** @deprecated Use EditMeta instead. */ -export type EditMetaBean = EditMeta; - -export interface EditMeta { - /** A list of editable field details. */ - fields?: {}; -} diff --git a/src/agile/models/entry.ts b/src/agile/models/entry.ts deleted file mode 100644 index 6faac8e573..0000000000 --- a/src/agile/models/entry.ts +++ /dev/null @@ -1,6 +0,0 @@ -export interface Entry { - issueId?: number; - issueKey?: string; - status?: number; - errors?: string[]; -} diff --git a/src/agile/models/epicRankRequest.ts b/src/agile/models/epicRankRequest.ts deleted file mode 100644 index b0f7eb81f5..0000000000 --- a/src/agile/models/epicRankRequest.ts +++ /dev/null @@ -1,8 +0,0 @@ -/** @deprecated Use {@link EpicRankRequest} instead. */ -export type EpicRankRequestBean = EpicRankRequest; - -export interface EpicRankRequest { - rankBeforeEpic?: string; - rankAfterEpic?: string; - rankCustomFieldId?: number; -} diff --git a/src/agile/models/epicUpdate.ts b/src/agile/models/epicUpdate.ts deleted file mode 100644 index ff95530455..0000000000 --- a/src/agile/models/epicUpdate.ts +++ /dev/null @@ -1,11 +0,0 @@ -/** @deprecated Use {@link EpicUpdate} instead. */ -export type EpicUpdateBean = EpicUpdate; - -export interface EpicUpdate { - name?: string; - summary?: string; - color?: { - key?: string; - }; - done?: boolean; -} diff --git a/src/agile/models/estimationConfig.ts b/src/agile/models/estimationConfig.ts deleted file mode 100644 index cd9e3b780f..0000000000 --- a/src/agile/models/estimationConfig.ts +++ /dev/null @@ -1,10 +0,0 @@ -/** @deprecated Use {@link EstimationConfig} instead. */ -export type EstimationConfigBean = EstimationConfig; - -export interface EstimationConfig { - type?: string; - field?: { - fieldId?: string; - displayName?: string; - }; -} diff --git a/src/agile/models/estimationField.ts b/src/agile/models/estimationField.ts deleted file mode 100644 index 7594827910..0000000000 --- a/src/agile/models/estimationField.ts +++ /dev/null @@ -1,7 +0,0 @@ -/** @deprecated Use {@link EstimationField} instead. */ -export type EstimationFieldBean = EstimationField; - -export interface EstimationField { - fieldId?: string; - displayName?: string; -} diff --git a/src/agile/models/feature.ts b/src/agile/models/feature.ts deleted file mode 100644 index a83fc4cdc8..0000000000 --- a/src/agile/models/feature.ts +++ /dev/null @@ -1,19 +0,0 @@ -export interface Feature { - boardFeature?: string; - boardId?: number; - state?: string; - localisedName?: string; - localisedDescription?: string; - learnMoreLink?: string; - imageUri?: string; - featureType?: string; - localisedGroup?: string; - permissibleEstimationTypes?: { - value?: string; - localisedName?: string; - localisedDescription?: string; - }[]; - featureId?: string; - learnMoreArticleId?: string; - toggleLocked?: boolean; -} diff --git a/src/agile/models/featureResponse.ts b/src/agile/models/featureResponse.ts deleted file mode 100644 index 8a782a8b83..0000000000 --- a/src/agile/models/featureResponse.ts +++ /dev/null @@ -1,21 +0,0 @@ -export interface FeatureResponse { - features?: { - boardFeature?: string; - boardId?: number; - state?: string; - localisedName?: string; - localisedDescription?: string; - learnMoreLink?: string; - imageUri?: string; - featureType?: string; - localisedGroup?: string; - permissibleEstimationTypes?: { - value?: string; - localisedName?: string; - localisedDescription?: string; - }[]; - featureId?: string; - learnMoreArticleId?: string; - toggleLocked?: boolean; - }[]; -} diff --git a/src/agile/models/featureToggleRequest.ts b/src/agile/models/featureToggleRequest.ts deleted file mode 100644 index 53a51f0f64..0000000000 --- a/src/agile/models/featureToggleRequest.ts +++ /dev/null @@ -1,5 +0,0 @@ -export interface FeatureToggleRequest { - boardId?: number; - feature?: string; - enabling?: boolean; -} diff --git a/src/agile/models/fieldEdit.ts b/src/agile/models/fieldEdit.ts deleted file mode 100644 index b295e3c613..0000000000 --- a/src/agile/models/fieldEdit.ts +++ /dev/null @@ -1,6 +0,0 @@ -/** @deprecated Use {@link FieldEdit} instead. */ -export type FieldEditBean = FieldEdit; - -export interface FieldEdit { - value?: string; -} diff --git a/src/agile/models/fieldMeta.ts b/src/agile/models/fieldMeta.ts deleted file mode 100644 index 4eb89ea745..0000000000 --- a/src/agile/models/fieldMeta.ts +++ /dev/null @@ -1,39 +0,0 @@ -/** @deprecated Use {@link FieldMeta} instead. */ -export type FieldMetaBean = FieldMeta; - -/** The metadata describing an issue field. */ -export interface FieldMeta { - /** Whether the field is required. */ - required: boolean; - /** The schema of a field. */ - schema?: { - /** The data type of the field. */ - type: string; - /** When the data type is an array, the name of the field items within the array. */ - items?: string; - /** If the field is a system field, the name of the field. */ - system?: string; - /** If the field is a custom field, the URI of the field. */ - custom?: string; - /** If the field is a custom field, the custom ID of the field. */ - customId?: number; - /** If the field is a custom field, the configuration of the field. */ - configuration?: {}; - }; - /** The name of the field. */ - name: string; - /** The key of the field. */ - key: string; - /** The URL that can be used to automatically complete the field. */ - autoCompleteUrl?: string; - /** Whether the field has a default value. */ - hasDefaultValue?: boolean; - /** The list of operations that can be performed on the field. */ - operations: string[]; - /** The list of values allowed in the field. */ - allowedValues?: any[]; - /** The default value of the field. */ - defaultValue?: any; - /** The configuration properties. */ - configuration?: any; -} diff --git a/src/agile/models/getAllBoards.ts b/src/agile/models/getAllBoards.ts index 23dad106d5..88ae94b38e 100644 --- a/src/agile/models/getAllBoards.ts +++ b/src/agile/models/getAllBoards.ts @@ -1,78 +1,9 @@ +import { Board } from './board'; + export interface GetAllBoards { maxResults?: number; startAt?: number; total?: number; isLast?: boolean; - values: { - /** The ID of the board. */ - id: number; - /** The URL of the board. */ - self?: string; - /** The name of the board. */ - name?: string; - /** The type the board. */ - type?: string; - /** The users and groups who own the board. */ - admins?: { - users?: { - /** - * @deprecated This property is deprecated in favor of `accountId` because of privacy changes. See the - * [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The key of the user. - */ - key?: string; - /** The URL of the user. */ - self?: string; - /** - * @deprecated This property is deprecated in favor of `accountId` because of privacy changes. See the - * [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The username of the user. - */ - name?: string; - /** The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */ - displayName?: string; - /** Whether the user is active. */ - active?: boolean; - /** - * The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, - * _5b10ac8d82e05b22cc7d4ef5_. - */ - accountId?: string; - avatarUrls?: { - /** The URL of the user's 24x24 pixel avatar. */ - '24x24'?: string; - /** The URL of the user's 32x32 pixel avatar. */ - '32x32'?: string; - /** The URL of the user's 48x48 pixel avatar. */ - '48x48'?: string; - /** The URL of the user's 16x16 pixel avatar. */ - '16x16'?: string; - }; - }[]; - groups?: { - name?: string; - self?: string; - }[]; - }; - /** The container that the board is located in. */ - location?: { - projectId?: number; - userId?: number; - userAccountId?: string; - displayName?: string; - projectName?: string; - projectKey?: string; - projectTypeKey?: string; - avatarURI?: string; - name?: string; - }; - /** Whether the board can be edited. */ - canEdit?: boolean; - /** Whether the board is private. */ - isPrivate?: boolean; - /** Whether the board is selected as a favorite. */ - favourite?: boolean; - }[]; + values: Board[]; } diff --git a/src/agile/models/getBoard.ts b/src/agile/models/getBoard.ts index f69b93f03a..97fcc7a68e 100644 --- a/src/agile/models/getBoard.ts +++ b/src/agile/models/getBoard.ts @@ -11,20 +11,8 @@ export interface GetBoard { /** The users and groups who own the board. */ admins?: { users?: { - /** - * @deprecated This property is deprecated in favor of `accountId` because of privacy changes. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The key of the user. - */ - key?: string; /** The URL of the user. */ self?: string; - /** - * @deprecated This property is deprecated in favor of `accountId` because of privacy changes. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The username of the user. - */ - name?: string; /** The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */ displayName?: string; /** Whether the user is active. */ diff --git a/src/agile/models/getDeploymentByKey.ts b/src/agile/models/getDeploymentByKey.ts index 8a6a1ca46c..34097b386f 100644 --- a/src/agile/models/getDeploymentByKey.ts +++ b/src/agile/models/getDeploymentByKey.ts @@ -14,16 +14,11 @@ export interface GetDeploymentByKey { * epoch time could be one way to generate the updateSequenceNumber. */ updateSequenceNumber: number; - /** - * Deprecated. The Jira issue keys to associate the Deployment information with. Should replace this field with the - * "associations" field to associate Deployment information with issueKeys or other types of associations. - */ - issueKeys?: string[]; /** * The entities to associate the Deployment information with. It must contain at least one of IssueIdOrKeysAssociation * or ServiceIdOrKeysAssociation. */ - associations?: any[]; + associations: any[]; /** The human-readable name for the deployment. Will be shown in the UI. */ displayName: string; /** A URL users can use to link to this deployment, in this environment. */ diff --git a/src/agile/models/getFeaturesForProject.ts b/src/agile/models/getFeaturesForProject.ts deleted file mode 100644 index 5dec1b8880..0000000000 --- a/src/agile/models/getFeaturesForProject.ts +++ /dev/null @@ -1,12 +0,0 @@ -export interface GetFeaturesForProject { - features?: { - boardFeature?: string; - boardId?: number; - state?: string; - localisedName?: string; - localisedDescription?: string; - learnMoreLink?: string; - imageUri?: string; - toggleLocked?: boolean; - }[]; -} diff --git a/src/agile/models/getRepository.ts b/src/agile/models/getRepository.ts index 5fc0c7fef8..bdfcc04426 100644 --- a/src/agile/models/getRepository.ts +++ b/src/agile/models/getRepository.ts @@ -30,8 +30,6 @@ export interface GetRepository { * lower than what is currently stored will be ignored. */ updateSequenceId: number; - /** @deprecated Deprecated. Use the id field instead. */ - hash?: string; /** The set of flags for this commit */ flags?: string[]; /** @@ -41,19 +39,8 @@ export interface GetRepository { message: string; /** Describes the author of a particular entity */ author: { - /** @deprecated Deprecated. The name of this user in a format suitable for display. Max length is 255 characters. */ - name?: string; /** The email address of the user. Used to associate the user with a Jira user. Max length is 255 characters. */ email?: string; - /** - * @deprecated Deprecated. The username of the user. Used to associate the user with a Jira user if there are - * multiple users for a given email. Max length is 255 characters. - */ - username?: string; - /** @deprecated Deprecated. The URL of the profile for this user. Max length is 2000 characters. */ - url?: string; - /** @deprecated Deprecated. The URL of the avatar for this user. Max length is 2000 characters. */ - avatar?: string; }; /** The total number of files added, removed, or modified by this commit */ fileCount: number; @@ -122,8 +109,6 @@ export interface GetRepository { * updateSqeuenceId lower than what is currently stored will be ignored. */ updateSequenceId: number; - /** @deprecated Deprecated. Use the id field instead. */ - hash?: string; /** The set of flags for this commit */ flags?: string[]; /** @@ -133,19 +118,8 @@ export interface GetRepository { message: string; /** Describes the author of a particular entity */ author: { - /** @deprecated Deprecated. The name of this user in a format suitable for display. Max length is 255 characters. */ - name?: string; /** The email address of the user. Used to associate the user with a Jira user. Max length is 255 characters. */ email?: string; - /** - * @deprecated Deprecated. The username of the user. Used to associate the user with a Jira user if there are - * multiple users for a given email. Max length is 255 characters. - */ - username?: string; - /** @deprecated Deprecated. The URL of the profile for this user. Max length is 2000 characters. */ - url?: string; - /** @deprecated Deprecated. The URL of the avatar for this user. Max length is 2000 characters. */ - avatar?: string; }; /** The total number of files added, removed, or modified by this commit */ fileCount: number; @@ -207,19 +181,8 @@ export interface GetRepository { title: string; /** Describes the author of a particular entity */ author: { - /** @deprecated Deprecated. The name of this user in a format suitable for display. Max length is 255 characters. */ - name?: string; /** The email address of the user. Used to associate the user with a Jira user. Max length is 255 characters. */ email?: string; - /** - * @deprecated Deprecated. The username of the user. Used to associate the user with a Jira user if there are - * multiple users for a given email. Max length is 255 characters. - */ - username?: string; - /** @deprecated Deprecated. The URL of the profile for this user. Max length is 2000 characters. */ - url?: string; - /** @deprecated Deprecated. The URL of the avatar for this user. Max length is 2000 characters. */ - avatar?: string; }; /** The number of comments on the pull request */ commentCount: number; @@ -238,14 +201,8 @@ export interface GetRepository { destinationBranchUrl?: string; /** The list of reviewers of this pull request */ reviewers?: { - /** @deprecated Deprecated. The name of this reviewer. Max length is 255 characters. */ - name?: string; /** The approval status of this reviewer, default is UNAPPROVED. */ approvalStatus?: string; - /** @deprecated Deprecated. The URL of the profile for this reviewer. Max length is 2000 characters. */ - url?: string; - /** @deprecated Deprecated. The URL of the avatar for this reviewer. Max length is 2000 characters. */ - avatar?: string; /** The email address of this reviewer. Max length is 254 characters. */ email?: string; /** The Atlassian Account ID (AAID) of this reviewer. Max length is 128 characters. */ diff --git a/src/agile/models/group.ts b/src/agile/models/group.ts index 2b2539798f..db5773db8d 100644 --- a/src/agile/models/group.ts +++ b/src/agile/models/group.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link Group} instead. */ -export type GroupBean = Group; - export interface Group { name?: string; self?: string; diff --git a/src/agile/models/historyMetadata.ts b/src/agile/models/historyMetadata.ts deleted file mode 100644 index ada34f17a3..0000000000 --- a/src/agile/models/historyMetadata.ts +++ /dev/null @@ -1,64 +0,0 @@ -/** Details of issue history metadata. */ -export interface HistoryMetadata { - /** The type of the history record. */ - type?: string; - /** The description of the history record. */ - description?: string; - /** The description key of the history record. */ - descriptionKey?: string; - /** The activity described in the history record. */ - activityDescription?: string; - /** The key of the activity described in the history record. */ - activityDescriptionKey?: string; - /** The description of the email address associated the history record. */ - emailDescription?: string; - /** The description key of the email address associated the history record. */ - emailDescriptionKey?: string; - /** Details of user or system associated with a issue history metadata item. */ - actor?: { - /** The ID of the user or system associated with a history record. */ - id?: string; - /** The display name of the user or system associated with a history record. */ - displayName?: string; - /** The key of the display name of the user or system associated with a history record. */ - displayNameKey?: string; - /** The type of the user or system associated with a history record. */ - type?: string; - /** The URL to an avatar for the user or system associated with a history record. */ - avatarUrl?: string; - /** The URL of the user or system associated with a history record. */ - url?: string; - }; - /** Details of user or system associated with a issue history metadata item. */ - generator?: { - /** The ID of the user or system associated with a history record. */ - id?: string; - /** The display name of the user or system associated with a history record. */ - displayName?: string; - /** The key of the display name of the user or system associated with a history record. */ - displayNameKey?: string; - /** The type of the user or system associated with a history record. */ - type?: string; - /** The URL to an avatar for the user or system associated with a history record. */ - avatarUrl?: string; - /** The URL of the user or system associated with a history record. */ - url?: string; - }; - /** Details of user or system associated with a issue history metadata item. */ - cause?: { - /** The ID of the user or system associated with a history record. */ - id?: string; - /** The display name of the user or system associated with a history record. */ - displayName?: string; - /** The key of the display name of the user or system associated with a history record. */ - displayNameKey?: string; - /** The type of the user or system associated with a history record. */ - type?: string; - /** The URL to an avatar for the user or system associated with a history record. */ - avatarUrl?: string; - /** The URL of the user or system associated with a history record. */ - url?: string; - }; - /** Additional arbitrary information about the history record. */ - extraData?: {}; -} diff --git a/src/agile/models/historyMetadataParticipant.ts b/src/agile/models/historyMetadataParticipant.ts deleted file mode 100644 index b87417b933..0000000000 --- a/src/agile/models/historyMetadataParticipant.ts +++ /dev/null @@ -1,15 +0,0 @@ -/** Details of user or system associated with a issue history metadata item. */ -export interface HistoryMetadataParticipant { - /** The ID of the user or system associated with a history record. */ - id?: string; - /** The display name of the user or system associated with a history record. */ - displayName?: string; - /** The key of the display name of the user or system associated with a history record. */ - displayNameKey?: string; - /** The type of the user or system associated with a history record. */ - type?: string; - /** The URL to an avatar for the user or system associated with a history record. */ - avatarUrl?: string; - /** The URL of the user or system associated with a history record. */ - url?: string; -} diff --git a/src/agile/models/index.ts b/src/agile/models/index.ts index e8851ddf87..ce8d4fcaec 100644 --- a/src/agile/models/index.ts +++ b/src/agile/models/index.ts @@ -1,34 +1,8 @@ export * from './avatarUrls'; -export * from './basicUser'; export * from './board'; -export * from './boardAdmins'; -export * from './boardConfig'; -export * from './boardCreate'; -export * from './boardFeature'; -export * from './boardFeatureResponse'; -export * from './boardFeatureToggleRequest'; -export * from './boardFilter'; -export * from './boardLocation'; -export * from './changeHistory'; -export * from './changeItem'; -export * from './changelog'; -export * from './color'; -export * from './column'; -export * from './columnConfig'; export * from './createBoard'; -export * from './editMeta'; -export * from './entry'; export * from './epic'; -export * from './epicRankRequest'; -export * from './epicUpdate'; -export * from './estimationConfig'; -export * from './estimationField'; export * from './existsByProperties'; -export * from './feature'; -export * from './featureResponse'; -export * from './featureToggleRequest'; -export * from './fieldEdit'; -export * from './fieldMeta'; export * from './fields'; export * from './fixVersion'; export * from './getAllBoards'; @@ -41,58 +15,33 @@ export * from './getDeploymentByKey'; export * from './getDeploymentGatingStatusByKey'; export * from './getFeatureFlagById'; export * from './getFeaturesForBoard'; -export * from './getFeaturesForProject'; export * from './getQuickFilter'; export * from './getRemoteLinkById'; export * from './getReportsForBoard'; export * from './getRepository'; export * from './group'; -export * from './historyMetadata'; -export * from './historyMetadataParticipant'; export * from './issue'; -export * from './issueAssignRequest'; -export * from './issueRankRequest'; export * from './issueTransition'; export * from './issueType'; export * from './jsonType'; export * from './linkedSecurityWorkspaceIds'; export * from './linkedWorkspace'; export * from './linkGroup'; -export * from './location'; -export * from './moveIssuesToBoard'; export * from './operations'; -export * from './opsbar'; -export * from './page'; -export * from './pageBoard'; -export * from './pageBoardFilter'; -export * from './pageQuickFilter'; -export * from './partialSuccess'; export * from './progress'; export * from './project'; export * from './projects'; -export * from './quickFilter'; -export * from './rankingConfig'; -export * from './relation'; -export * from './report'; -export * from './reportsResponse'; export * from './searchResults'; -export * from './simpleLink'; export * from './sprint'; -export * from './sprintCreate'; -export * from './sprintSwap'; export * from './status'; export * from './statusCategory'; -export * from './statusCategoryJson'; -export * from './statusJson'; export * from './storeDevelopmentInformation'; export * from './submitBuilds'; export * from './submitDeployments'; export * from './submitFeatureFlags'; export * from './submitRemoteLinks'; export * from './submittedVulnerabilitiesResult'; -export * from './subquery'; export * from './toggleFeatures'; export * from './user'; -export * from './userAvatarUrls'; export * from './version'; export * from './vulnerability'; diff --git a/src/agile/models/issue.ts b/src/agile/models/issue.ts index a43880ad3f..88498d6f54 100644 --- a/src/agile/models/issue.ts +++ b/src/agile/models/issue.ts @@ -1,9 +1,6 @@ import { Fields } from './fields'; import { Operations } from './operations'; -/** @deprecated Use {@link Issue} instead. */ -export type IssueBean = Issue; - /** Details about an issue. */ export interface Issue { /** Expand options that include additional issue details in the response. */ @@ -105,20 +102,6 @@ export interface Issue { author?: { /** The URL of the user. */ self?: string; - /** - * @deprecated This property is no longer available and will be removed from the documentation soon. See the - * [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - name?: string; - /** - * @deprecated This property is no longer available and will be removed from the documentation soon. See the - * [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - key?: string; /** * The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, * _5b10ac8d82e05b22cc7d4ef5_. diff --git a/src/agile/models/issueAssignRequest.ts b/src/agile/models/issueAssignRequest.ts deleted file mode 100644 index bbd34b03af..0000000000 --- a/src/agile/models/issueAssignRequest.ts +++ /dev/null @@ -1,6 +0,0 @@ -/** @deprecated Use {@link IssueAssignRequest} instead. */ -export type IssueAssignRequestBean = IssueAssignRequest; - -export interface IssueAssignRequest { - issues?: string[]; -} diff --git a/src/agile/models/issueRankRequest.ts b/src/agile/models/issueRankRequest.ts deleted file mode 100644 index 50037f819e..0000000000 --- a/src/agile/models/issueRankRequest.ts +++ /dev/null @@ -1,9 +0,0 @@ -/** @deprecated Use {@link IssueRankRequest} instead. */ -export type IssueRankRequestBean = IssueRankRequest; - -export interface IssueRankRequest { - issues?: string[]; - rankBeforeIssue?: string; - rankAfterIssue?: string; - rankCustomFieldId?: number; -} diff --git a/src/agile/models/issueTransition.ts b/src/agile/models/issueTransition.ts index ab0cb34739..8f645db08a 100644 --- a/src/agile/models/issueTransition.ts +++ b/src/agile/models/issueTransition.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link IssueTransition} instead. */ -export type IssueTransitionBean = IssueTransition; - /** Details of an issue transition. */ export interface IssueTransition { /** The ID of the issue transition. Required when specifying a transition to undertake. */ diff --git a/src/agile/models/jsonType.ts b/src/agile/models/jsonType.ts index 835c797ba8..2b50ec5e12 100644 --- a/src/agile/models/jsonType.ts +++ b/src/agile/models/jsonType.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link JsonType} instead. */ -export type JsonTypeBean = JsonType; - /** The schema of a field. */ export interface JsonType { /** The data type of the field. */ diff --git a/src/agile/models/linkGroup.ts b/src/agile/models/linkGroup.ts index 996a02771d..cd6b15c95b 100644 --- a/src/agile/models/linkGroup.ts +++ b/src/agile/models/linkGroup.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link LinkGroup} instead. */ -export type LinkGroupBean = LinkGroup; - /** Details a link group, which defines issue operations. */ export interface LinkGroup { id?: string; diff --git a/src/agile/models/location.ts b/src/agile/models/location.ts deleted file mode 100644 index 2d91e6915d..0000000000 --- a/src/agile/models/location.ts +++ /dev/null @@ -1,7 +0,0 @@ -/** @deprecated Use {@link Location} instead. */ -export type LocationBean = Location; - -export interface Location { - type?: string; - projectKeyOrId?: string; -} diff --git a/src/agile/models/moveIssuesToBoard.ts b/src/agile/models/moveIssuesToBoard.ts deleted file mode 100644 index 6094f30d24..0000000000 --- a/src/agile/models/moveIssuesToBoard.ts +++ /dev/null @@ -1,8 +0,0 @@ -export interface MoveIssuesToBoard { - entries?: { - issueId?: number; - issueKey?: string; - status?: number; - errors?: string[]; - }[]; -} diff --git a/src/agile/models/opsbar.ts b/src/agile/models/opsbar.ts deleted file mode 100644 index ca0e3a5e07..0000000000 --- a/src/agile/models/opsbar.ts +++ /dev/null @@ -1,9 +0,0 @@ -import { LinkGroup } from './linkGroup'; - -/** @deprecated Use Opsbar instead. */ -export type OpsbarBean = Opsbar; - -export interface Opsbar { - /** Details of the link groups defining issue operations. */ - linkGroups?: LinkGroup[]; -} diff --git a/src/agile/models/page.ts b/src/agile/models/page.ts deleted file mode 100644 index 1d57833411..0000000000 --- a/src/agile/models/page.ts +++ /dev/null @@ -1,10 +0,0 @@ -/** @deprecated Use Page instead. */ -export type PageBean = Page; - -export interface Page { - maxResults?: number; - startAt?: number; - total?: number; - isLast?: boolean; - values?: any[]; -} diff --git a/src/agile/models/pageBoard.ts b/src/agile/models/pageBoard.ts deleted file mode 100644 index 309ff603cb..0000000000 --- a/src/agile/models/pageBoard.ts +++ /dev/null @@ -1,81 +0,0 @@ -/** @deprecated Use {@link PageBoard} instead. */ -export type PageBeanBoardBean = PageBoard; - -export interface PageBoard { - maxResults?: number; - startAt?: number; - total?: number; - isLast?: boolean; - values?: { - /** The ID of the board. */ - id?: number; - /** The URL of the board. */ - self?: string; - /** The name of the board. */ - name?: string; - /** The type the board. */ - type?: string; - /** The users and groups who own the board. */ - admins?: { - users?: { - /** - * @deprecated This property is deprecated in favor of `accountId` because of privacy changes. See the - * [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The key of the user. - */ - key?: string; - /** The URL of the user. */ - self?: string; - /** - * @deprecated This property is deprecated in favor of `accountId` because of privacy changes. See the - * [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The username of the user. - */ - name?: string; - /** The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */ - displayName?: string; - /** Whether the user is active. */ - active?: boolean; - /** - * The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, - * _5b10ac8d82e05b22cc7d4ef5_. - */ - accountId?: string; - avatarUrls?: { - /** The URL of the user's 24x24 pixel avatar. */ - '24x24'?: string; - /** The URL of the user's 32x32 pixel avatar. */ - '32x32'?: string; - /** The URL of the user's 48x48 pixel avatar. */ - '48x48'?: string; - /** The URL of the user's 16x16 pixel avatar. */ - '16x16'?: string; - }; - }[]; - groups?: { - name?: string; - self?: string; - }[]; - }; - /** The container that the board is located in. */ - location?: { - projectId?: number; - userId?: number; - userAccountId?: string; - displayName?: string; - projectName?: string; - projectKey?: string; - projectTypeKey?: string; - avatarURI?: string; - name?: string; - }; - /** Whether the board can be edited. */ - canEdit?: boolean; - /** Whether the board is private. */ - isPrivate?: boolean; - /** Whether the board is selected as a favorite. */ - favourite?: boolean; - }[]; -} diff --git a/src/agile/models/pageBoardFilter.ts b/src/agile/models/pageBoardFilter.ts deleted file mode 100644 index 82a2407f6b..0000000000 --- a/src/agile/models/pageBoardFilter.ts +++ /dev/null @@ -1,14 +0,0 @@ -/** @deprecated Use {@link PageBoardFilter} instead. */ -export type PageBeanBoardFilterBean = PageBoardFilter; - -export interface PageBoardFilter { - maxResults?: number; - startAt?: number; - total?: number; - isLast?: boolean; - values?: { - id?: number; - self?: string; - name?: string; - }[]; -} diff --git a/src/agile/models/pageQuickFilter.ts b/src/agile/models/pageQuickFilter.ts deleted file mode 100644 index e15e3ec39b..0000000000 --- a/src/agile/models/pageQuickFilter.ts +++ /dev/null @@ -1,17 +0,0 @@ -/** @deprecated Use PageQuickFilter instead. */ -export type PageBeanQuickFilterBean = PageQuickFilter; - -export interface PageQuickFilter { - maxResults?: number; - startAt?: number; - total?: number; - isLast?: boolean; - values?: { - id?: number; - boardId?: number; - name?: string; - jql?: string; - description?: string; - position?: number; - }[]; -} diff --git a/src/agile/models/partialSuccess.ts b/src/agile/models/partialSuccess.ts deleted file mode 100644 index d0833025ee..0000000000 --- a/src/agile/models/partialSuccess.ts +++ /dev/null @@ -1,11 +0,0 @@ -/** @deprecated Use {@link PartialSuccess} instead. */ -export type PartialSuccessBean = PartialSuccess; - -export interface PartialSuccess { - entries?: { - issueId?: number; - issueKey?: string; - status?: number; - errors?: string[]; - }[]; -} diff --git a/src/agile/models/quickFilter.ts b/src/agile/models/quickFilter.ts deleted file mode 100644 index 507a9268b6..0000000000 --- a/src/agile/models/quickFilter.ts +++ /dev/null @@ -1,11 +0,0 @@ -/** @deprecated Use {@link QuickFilter} instead. */ -export type QuickFilterBean = QuickFilter; - -export interface QuickFilter { - id?: number; - boardId?: number; - name?: string; - jql?: string; - description?: string; - position?: number; -} diff --git a/src/agile/models/rankingConfig.ts b/src/agile/models/rankingConfig.ts deleted file mode 100644 index 7d0f4ebe80..0000000000 --- a/src/agile/models/rankingConfig.ts +++ /dev/null @@ -1,6 +0,0 @@ -/** @deprecated Use {@link RankingConfig} instead. */ -export type RankingConfigBean = RankingConfig; - -export interface RankingConfig { - rankCustomFieldId?: number; -} diff --git a/src/agile/models/relation.ts b/src/agile/models/relation.ts deleted file mode 100644 index 11e94b15d8..0000000000 --- a/src/agile/models/relation.ts +++ /dev/null @@ -1,7 +0,0 @@ -/** @deprecated Use {@link Relation} instead. */ -export type RelationBean = Relation; - -export interface Relation { - id?: string; - self?: string; -} diff --git a/src/agile/models/report.ts b/src/agile/models/report.ts deleted file mode 100644 index 029cd0af0c..0000000000 --- a/src/agile/models/report.ts +++ /dev/null @@ -1,4 +0,0 @@ -/** @deprecated Use {@link Report} instead. */ -export type ReportBean = Report; - -export interface Report {} diff --git a/src/agile/models/reportsResponse.ts b/src/agile/models/reportsResponse.ts deleted file mode 100644 index 69a7ba42eb..0000000000 --- a/src/agile/models/reportsResponse.ts +++ /dev/null @@ -1,6 +0,0 @@ -/** @deprecated Use {@link ReportsResponse} instead. */ -export type ReportsResponseBean = ReportsResponse; - -export interface ReportsResponse { - reports?: {}[]; -} diff --git a/src/agile/models/searchResults.ts b/src/agile/models/searchResults.ts index 37bcb84830..985bb2b51a 100644 --- a/src/agile/models/searchResults.ts +++ b/src/agile/models/searchResults.ts @@ -1,8 +1,5 @@ import { Issue } from './issue'; -/** @deprecated Use {@link SearchResults} instead. */ -export type SearchResultsBean = SearchResults; - /** The result of a JQL search. */ export interface SearchResults { /** Expand options that include additional search result details in the response. */ diff --git a/src/agile/models/simpleLink.ts b/src/agile/models/simpleLink.ts deleted file mode 100644 index cf7599c7f6..0000000000 --- a/src/agile/models/simpleLink.ts +++ /dev/null @@ -1,13 +0,0 @@ -/** @deprecated Use {@link SimpleLink} instead. */ -export type SimpleLinkBean = SimpleLink; - -/** Details about the operations available in this version. */ -export interface SimpleLink { - id?: string; - styleClass?: string; - iconClass?: string; - label?: string; - title?: string; - href?: string; - weight?: number; -} diff --git a/src/agile/models/sprint.ts b/src/agile/models/sprint.ts index cfde9e8995..b4471455a2 100644 --- a/src/agile/models/sprint.ts +++ b/src/agile/models/sprint.ts @@ -1,10 +1,7 @@ -/** @deprecated Use {@link Sprint} instead. */ -export type SprintBean = Sprint; - export interface Sprint { id: number; self?: string; - state: 'future' | 'active' | 'closed' | string | Sprint.State; + state: 'future' | 'active' | 'closed' | string; name: string; startDate?: string; endDate?: string; @@ -13,11 +10,3 @@ export interface Sprint { originBoardId?: number; goal?: string; } - -export namespace Sprint { - export enum State { - Future = 'future', - Active = 'active', - Closed = 'closed', - } -} diff --git a/src/agile/models/sprintCreate.ts b/src/agile/models/sprintCreate.ts deleted file mode 100644 index b12a60104d..0000000000 --- a/src/agile/models/sprintCreate.ts +++ /dev/null @@ -1,10 +0,0 @@ -/** @deprecated Use {@link SprintCreate} instead. */ -export type SprintCreateBean = SprintCreate; - -export interface SprintCreate { - name?: string; - startDate?: string; - endDate?: string; - originBoardId?: number; - goal?: string; -} diff --git a/src/agile/models/sprintSwap.ts b/src/agile/models/sprintSwap.ts deleted file mode 100644 index dd13de7e43..0000000000 --- a/src/agile/models/sprintSwap.ts +++ /dev/null @@ -1,6 +0,0 @@ -/** @deprecated Use {@link SprintSwap} instead. */ -export type SprintSwapBean = SprintSwap; - -export interface SprintSwap { - sprintToSwapWith?: number; -} diff --git a/src/agile/models/statusCategoryJson.ts b/src/agile/models/statusCategoryJson.ts deleted file mode 100644 index 65b5841c44..0000000000 --- a/src/agile/models/statusCategoryJson.ts +++ /dev/null @@ -1,15 +0,0 @@ -/** @deprecated Use {@link StatusCategoryJson} instead. */ -export type StatusCategoryJsonBean = StatusCategoryJson; - -export interface StatusCategoryJson { - /** The URL of the status category. */ - self?: string; - /** The ID of the status category. */ - id?: number; - /** The key of the status category. */ - key?: string; - /** The name of the color used to represent the status category. */ - colorName?: string; - /** The name of the status category. */ - name?: string; -} diff --git a/src/agile/models/statusJson.ts b/src/agile/models/statusJson.ts deleted file mode 100644 index a809b9d941..0000000000 --- a/src/agile/models/statusJson.ts +++ /dev/null @@ -1,30 +0,0 @@ -/** @deprecated Use {@link StatusJson} instead. */ -export type StatusJsonBean = StatusJson; - -/** A status. */ -export interface StatusJson { - /** The URL of the status. */ - self?: string; - statusColor?: string; - /** The description of the status. */ - description?: string; - /** The URL of the icon used to represent the status. */ - iconUrl?: string; - /** The name of the status. */ - name?: string; - /** The ID of the status. */ - id?: string; - /** A status category. */ - statusCategory?: { - /** The URL of the status category. */ - self?: string; - /** The ID of the status category. */ - id?: number; - /** The key of the status category. */ - key?: string; - /** The name of the color used to represent the status category. */ - colorName?: string; - /** The name of the status category. */ - name?: string; - }; -} diff --git a/src/agile/models/subquery.ts b/src/agile/models/subquery.ts deleted file mode 100644 index 48f31594e8..0000000000 --- a/src/agile/models/subquery.ts +++ /dev/null @@ -1,6 +0,0 @@ -/** @deprecated Use {@link Subquery} instead. */ -export type SubqueryBean = Subquery; - -export interface Subquery { - query?: string; -} diff --git a/src/agile/models/user.ts b/src/agile/models/user.ts index 7c1ade31f7..28fea25b86 100644 --- a/src/agile/models/user.ts +++ b/src/agile/models/user.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link User} instead. */ -export type UserJsonBean = User; - /** * User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:* * @@ -15,20 +12,6 @@ export type UserJsonBean = User; export interface User { /** The URL of the user. */ self: string; - /** - * @deprecated This property is no longer available and will be removed from the documentation soon. See the - * [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - name: string; - /** - * @deprecated This property is no longer available and will be removed from the documentation soon. See the - * [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - key?: string; /** * The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, * _5b10ac8d82e05b22cc7d4ef5_. diff --git a/src/agile/models/userAvatarUrls.ts b/src/agile/models/userAvatarUrls.ts deleted file mode 100644 index 0daf370fbd..0000000000 --- a/src/agile/models/userAvatarUrls.ts +++ /dev/null @@ -1,11 +0,0 @@ -/** Details of a user's avatars. */ -export interface UserAvatarUrls { - /** The URL of the user's 24x24 pixel avatar. */ - '24x24'?: string; - /** The URL of the user's 16x16 pixel avatar. */ - '16x16'?: string; - /** The URL of the user's 32x32 pixel avatar. */ - '32x32'?: string; - /** The URL of the user's 48x48 pixel avatar. */ - '48x48'?: string; -} diff --git a/src/agile/parameters/createBoard.ts b/src/agile/parameters/createBoard.ts index a687a6b07e..3cd31794da 100644 --- a/src/agile/parameters/createBoard.ts +++ b/src/agile/parameters/createBoard.ts @@ -1,9 +1,9 @@ export interface CreateBoard { name: string; - type: 'scrum' | 'kanban' | string; + type: 'kanban' | 'scrum' | 'agility' | string; filterId: number; location?: { - type?: string; + type?: 'project' | 'user' | string; projectKeyOrId?: string; }; } diff --git a/src/agile/parameters/createSprint.ts b/src/agile/parameters/createSprint.ts index e879d63b2c..69c8acbf70 100644 --- a/src/agile/parameters/createSprint.ts +++ b/src/agile/parameters/createSprint.ts @@ -1,7 +1,7 @@ export interface CreateSprint { name: string; - originBoardId: number; startDate?: string; endDate?: string; + originBoardId: number; goal?: string; } diff --git a/src/agile/parameters/deleteBuildByKey.ts b/src/agile/parameters/deleteBuildByKey.ts index 9f08ba52b8..503b5dd7e4 100644 --- a/src/agile/parameters/deleteBuildByKey.ts +++ b/src/agile/parameters/deleteBuildByKey.ts @@ -3,8 +3,6 @@ export interface DeleteBuildByKey { pipelineId: string; /** The `buildNumber` of the build to delete. */ buildNumber: number; - /** @deprecated */ - _updateSequenceNumber?: number; /** * Only stored data with an `updateSequenceNumber` less than or equal to that provided will be deleted. This can be * used help ensure submit/delete requests are applied correctly if issued close together. diff --git a/src/agile/parameters/deleteBuildsByProperty.ts b/src/agile/parameters/deleteBuildsByProperty.ts index 99d96b696e..75f230d6b5 100644 --- a/src/agile/parameters/deleteBuildsByProperty.ts +++ b/src/agile/parameters/deleteBuildsByProperty.ts @@ -1,6 +1,4 @@ export interface DeleteBuildsByProperty { - /** @deprecated */ - _updateSequenceNumber?: number; /** * Only stored data with an `updateSequenceNumber` less than or equal to that provided will be deleted. This can be * used help ensure submit/delete requests are applied correctly if issued close together. diff --git a/src/agile/parameters/deleteByProperties.ts b/src/agile/parameters/deleteByProperties.ts index 3debc3b760..6c61385566 100644 --- a/src/agile/parameters/deleteByProperties.ts +++ b/src/agile/parameters/deleteByProperties.ts @@ -1,6 +1,4 @@ export interface DeleteByProperties { - /** @deprecated */ - _updateSequenceId?: number; /** * An optional property to use to control deletion. Only stored data with an updateSequenceId less than or equal to * that provided will be deleted. This can be used to help ensure submit/delete requests are applied correctly if they diff --git a/src/agile/parameters/deleteDeploymentByKey.ts b/src/agile/parameters/deleteDeploymentByKey.ts index c2cc8adbf8..4e2b45d8ff 100644 --- a/src/agile/parameters/deleteDeploymentByKey.ts +++ b/src/agile/parameters/deleteDeploymentByKey.ts @@ -5,8 +5,6 @@ export interface DeleteDeploymentByKey { environmentId: string; /** The deployment's deploymentSequenceNumber. */ deploymentSequenceNumber: number; - /** @deprecated */ - _updateSequenceNumber?: number; /** * Only stored data with an `updateSequenceNumber` less than or equal to that provided will be deleted. This can be * used help ensure submit/delete requests are applied correctly if issued close together. diff --git a/src/agile/parameters/deleteDeploymentsByProperty.ts b/src/agile/parameters/deleteDeploymentsByProperty.ts index fa8b5f4b14..07c02ebe69 100644 --- a/src/agile/parameters/deleteDeploymentsByProperty.ts +++ b/src/agile/parameters/deleteDeploymentsByProperty.ts @@ -1,6 +1,4 @@ export interface DeleteDeploymentsByProperty { - /** @deprecated */ - _updateSequenceNumber?: number; /** * Only stored data with an `updateSequenceNumber` less than or equal to that provided will be deleted. This can be * used help ensure submit/delete requests are applied correctly if issued close together. diff --git a/src/agile/parameters/deleteEntity.ts b/src/agile/parameters/deleteEntity.ts index e8b2560a0b..0f1c947a33 100644 --- a/src/agile/parameters/deleteEntity.ts +++ b/src/agile/parameters/deleteEntity.ts @@ -1,9 +1,7 @@ export interface DeleteEntity { repositoryId: string; - entityType: string; + entityType: 'commit' | 'branch' | 'pull_request' | string; entityId: string; - /** @deprecated */ - _updateSequenceId?: number; /** * An optional property to use to control deletion. Only stored data with an updateSequenceId less than or equal to * that provided will be deleted. This can be used to help ensure submit/delete requests are applied correctly if they diff --git a/src/agile/parameters/deleteFeatureFlagById.ts b/src/agile/parameters/deleteFeatureFlagById.ts index 85fe73e3c8..4f0731f145 100644 --- a/src/agile/parameters/deleteFeatureFlagById.ts +++ b/src/agile/parameters/deleteFeatureFlagById.ts @@ -1,8 +1,6 @@ export interface DeleteFeatureFlagById { /** The ID of the Feature Flag to delete. */ featureFlagId: string; - /** @deprecated */ - _updateSequenceId?: number; /** * Only stored data with an `updateSequenceId` less than or equal to that provided will be deleted. This can be used * help ensure submit/delete requests are applied correctly if issued close together. diff --git a/src/agile/parameters/deleteFeatureFlagsByProperty.ts b/src/agile/parameters/deleteFeatureFlagsByProperty.ts index 02503d81c3..6f565ff366 100644 --- a/src/agile/parameters/deleteFeatureFlagsByProperty.ts +++ b/src/agile/parameters/deleteFeatureFlagsByProperty.ts @@ -1,6 +1,4 @@ export interface DeleteFeatureFlagsByProperty { - /** @deprecated */ - _updateSequenceId?: number; /** * Only stored data with an `updateSequenceId` less than or equal to that provided will be deleted. This can be used * help ensure submit/delete requests are applied correctly if issued close together. diff --git a/src/agile/parameters/deleteRemoteLinkById.ts b/src/agile/parameters/deleteRemoteLinkById.ts index 003066fd94..627e2d5455 100644 --- a/src/agile/parameters/deleteRemoteLinkById.ts +++ b/src/agile/parameters/deleteRemoteLinkById.ts @@ -1,8 +1,6 @@ export interface DeleteRemoteLinkById { /** The ID of the Remote Link to fetch. */ remoteLinkId: string; - /** @deprecated */ - _updateSequenceNumber?: number; /** * Only stored data with an `updateSequenceNumber` less than or equal to that provided will be deleted. This can be * used help ensure submit/delete requests are applied correctly if issued close together. diff --git a/src/agile/parameters/deleteRemoteLinksByProperty.ts b/src/agile/parameters/deleteRemoteLinksByProperty.ts index 5f30eb1abe..1cff3c1efa 100644 --- a/src/agile/parameters/deleteRemoteLinksByProperty.ts +++ b/src/agile/parameters/deleteRemoteLinksByProperty.ts @@ -1,6 +1,4 @@ export interface DeleteRemoteLinksByProperty { - /** @deprecated */ - _updateSequenceNumber?: number; /** * Only stored data with an `updateSequenceNumber` less than or equal to that provided will be deleted. This can be * used help ensure submit/delete requests are applied correctly if issued close together. diff --git a/src/agile/parameters/deleteRepository.ts b/src/agile/parameters/deleteRepository.ts index 33fcba6d32..e6fb8f1276 100644 --- a/src/agile/parameters/deleteRepository.ts +++ b/src/agile/parameters/deleteRepository.ts @@ -1,8 +1,6 @@ export interface DeleteRepository { /** The ID of repository to delete */ repositoryId: string; - /** @deprecated */ - _updateSequenceId?: number; /** * An optional property to use to control deletion. Only stored data with an updateSequenceId less than or equal to * that provided will be deleted. This can be used to help ensure submit/delete requests are applied correctly if they diff --git a/src/agile/parameters/existsByProperties.ts b/src/agile/parameters/existsByProperties.ts index ea29c18b37..f8bc133ab3 100644 --- a/src/agile/parameters/existsByProperties.ts +++ b/src/agile/parameters/existsByProperties.ts @@ -1,6 +1,4 @@ export interface ExistsByProperties { - /** @deprecated */ - _updateSequenceId?: number; /** An optional property. Filters out entities and repositories which have updateSequenceId greater than specified. */ updateSequenceId?: number; } diff --git a/src/agile/parameters/getAllBoards.ts b/src/agile/parameters/getAllBoards.ts index 7d7183b384..c3c386f68d 100644 --- a/src/agile/parameters/getAllBoards.ts +++ b/src/agile/parameters/getAllBoards.ts @@ -25,7 +25,7 @@ export interface GetAllBoards { /** If set to true, negate filters used for querying by location. By default false. */ negateLocationFiltering?: boolean; /** Ordering of the results by a given field. If not provided, values will not be sorted. Valid values: name. */ - orderBy?: string; + orderBy?: 'name' | '-name' | '+name' | string; /** List of fields to expand for each board. Valid values: admins, permissions. */ expand?: string; /** Filters results to boards that are relevant to a filter. Not supported for next-gen boards. */ diff --git a/src/agile/parameters/getBoardByFilterId.ts b/src/agile/parameters/getBoardByFilterId.ts index 70ba4a961d..19fab29b0f 100644 --- a/src/agile/parameters/getBoardByFilterId.ts +++ b/src/agile/parameters/getBoardByFilterId.ts @@ -1,6 +1,4 @@ export interface GetBoardByFilterId { - /** Filters results to boards that are relevant to a filter. Not supported for next-gen boards. */ - filterId: number; /** * The starting index of the returned boards. Base index: 0. See the 'Pagination' section at the top of this page for * more details. @@ -11,4 +9,6 @@ export interface GetBoardByFilterId { * for more details. */ maxResults?: number; + /** Filters results to boards that are relevant to a filter. Not supported for next-gen boards. */ + filterId: number; } diff --git a/src/agile/parameters/getFeaturesForProject.ts b/src/agile/parameters/getFeaturesForProject.ts deleted file mode 100644 index 16e36eb759..0000000000 --- a/src/agile/parameters/getFeaturesForProject.ts +++ /dev/null @@ -1,3 +0,0 @@ -export interface GetFeaturesForProject { - projectIdOrKey: string; -} diff --git a/src/agile/parameters/index.ts b/src/agile/parameters/index.ts index a2257b1ab4..f7a9ac6ac2 100644 --- a/src/agile/parameters/index.ts +++ b/src/agile/parameters/index.ts @@ -38,7 +38,6 @@ export * from './getEpic'; export * from './getEpics'; export * from './getFeatureFlagById'; export * from './getFeaturesForBoard'; -export * from './getFeaturesForProject'; export * from './getIssue'; export * from './getIssueEstimationForBoard'; export * from './getIssuesForBacklog'; diff --git a/src/agile/parameters/partiallyUpdateEpic.ts b/src/agile/parameters/partiallyUpdateEpic.ts index 19254f310e..d949f309df 100644 --- a/src/agile/parameters/partiallyUpdateEpic.ts +++ b/src/agile/parameters/partiallyUpdateEpic.ts @@ -4,7 +4,22 @@ export interface PartiallyUpdateEpic { name?: string; summary?: string; color?: { - key?: string; + key?: + | 'color_1' + | 'color_2' + | 'color_3' + | 'color_4' + | 'color_5' + | 'color_6' + | 'color_7' + | 'color_8' + | 'color_9' + | 'color_10' + | 'color_11' + | 'color_12' + | 'color_13' + | 'color_14' + | string; }; done?: boolean; } diff --git a/src/agile/parameters/partiallyUpdateSprint.ts b/src/agile/parameters/partiallyUpdateSprint.ts index 6409306af0..9a55e2c37e 100644 --- a/src/agile/parameters/partiallyUpdateSprint.ts +++ b/src/agile/parameters/partiallyUpdateSprint.ts @@ -1,11 +1,9 @@ -import { Sprint } from '../models'; - export interface PartiallyUpdateSprint { /** The ID of the sprint to update. */ sprintId: number; id?: number; self?: string; - state?: string | Sprint.State; + state?: string; name?: string; startDate?: string | Date; endDate?: string | Date; diff --git a/src/agile/parameters/storeDevelopmentInformation.ts b/src/agile/parameters/storeDevelopmentInformation.ts index 571aca729b..b2cdaf8aec 100644 --- a/src/agile/parameters/storeDevelopmentInformation.ts +++ b/src/agile/parameters/storeDevelopmentInformation.ts @@ -34,10 +34,8 @@ export interface StoreDevelopmentInformation { * updateSqeuenceId lower than what is currently stored will be ignored. */ updateSequenceId: number; - /** @deprecated Deprecated. Use the id field instead. */ - hash?: string; /** The set of flags for this commit */ - flags?: string[]; + flags?: ('MERGE_COMMIT' | string)[]; /** * The commit message. Max length is 1024 characters. If anything longer is supplied, it will be truncated down to * 1024 characters. @@ -45,19 +43,8 @@ export interface StoreDevelopmentInformation { message: string; /** Describes the author of a particular entity */ author: { - /** @deprecated Deprecated. The name of this user in a format suitable for display. Max length is 255 characters. */ - name?: string; /** The email address of the user. Used to associate the user with a Jira user. Max length is 255 characters. */ email?: string; - /** - * @deprecated Deprecated. The username of the user. Used to associate the user with a Jira user if there are - * multiple users for a given email. Max length is 255 characters. - */ - username?: string; - /** @deprecated Deprecated. The URL of the profile for this user. Max length is 2000 characters. */ - url?: string; - /** @deprecated Deprecated. The URL of the avatar for this user. Max length is 2000 characters. */ - avatar?: string; }; /** The total number of files added, removed, or modified by this commit */ fileCount: number; @@ -73,7 +60,7 @@ export interface StoreDevelopmentInformation { /** The URL of this file. Max length is 2000 characters. */ url: string; /** The operation performed on this file */ - changeType: string; + changeType: 'ADDED' | 'COPIED' | 'DELETED' | 'MODIFIED' | 'MOVED' | 'UNKNOWN' | string; /** Number of lines added to the file */ linesAdded: number; /** Number of lines removed from the file */ @@ -127,10 +114,8 @@ export interface StoreDevelopmentInformation { * updateSqeuenceId lower than what is currently stored will be ignored. */ updateSequenceId: number; - /** @deprecated Deprecated. Use the id field instead. */ - hash?: string; /** The set of flags for this commit */ - flags?: string[]; + flags?: ('MERGE_COMMIT' | string)[]; /** * The commit message. Max length is 1024 characters. If anything longer is supplied, it will be truncated down * to 1024 characters. @@ -138,22 +123,8 @@ export interface StoreDevelopmentInformation { message: string; /** Describes the author of a particular entity */ author: { - /** - * @deprecated Deprecated. The name of this user in a format suitable for display. Max length is 255 - * characters. - */ - name?: string; /** The email address of the user. Used to associate the user with a Jira user. Max length is 255 characters. */ email?: string; - /** - * @deprecated Deprecated. The username of the user. Used to associate the user with a Jira user if there are - * multiple users for a given email. Max length is 255 characters. - */ - username?: string; - /** @deprecated Deprecated. The URL of the profile for this user. Max length is 2000 characters. */ - url?: string; - /** @deprecated Deprecated. The URL of the avatar for this user. Max length is 2000 characters. */ - avatar?: string; }; /** The total number of files added, removed, or modified by this commit */ fileCount: number; @@ -169,7 +140,7 @@ export interface StoreDevelopmentInformation { /** The URL of this file. Max length is 2000 characters. */ url: string; /** The operation performed on this file */ - changeType: string; + changeType: 'ADDED' | 'COPIED' | 'DELETED' | 'MODIFIED' | 'MOVED' | 'UNKNOWN' | string; /** Number of lines added to the file */ linesAdded: number; /** Number of lines removed from the file */ @@ -209,26 +180,15 @@ export interface StoreDevelopmentInformation { updateSequenceId: number; /** * The status of the pull request. In the case of concurrent updates, priority is given in the order OPEN, MERGED, - * DECLINED, UNKNOWN + * DECLINED, DRAFT, UNKNOWN */ - status: string; + status: 'OPEN' | 'MERGED' | 'DECLINED' | 'DRAFT' | 'UNKNOWN' | string; /** Title of the pull request. Max length is 1024 characters. */ title: string; /** Describes the author of a particular entity */ author: { - /** @deprecated Deprecated. The name of this user in a format suitable for display. Max length is 255 characters. */ - name?: string; /** The email address of the user. Used to associate the user with a Jira user. Max length is 255 characters. */ email?: string; - /** - * @deprecated Deprecated. The username of the user. Used to associate the user with a Jira user if there are - * multiple users for a given email. Max length is 255 characters. - */ - username?: string; - /** @deprecated Deprecated. The URL of the profile for this user. Max length is 2000 characters. */ - url?: string; - /** @deprecated Deprecated. The URL of the avatar for this user. Max length is 2000 characters. */ - avatar?: string; }; /** The number of comments on the pull request */ commentCount: number; @@ -247,14 +207,8 @@ export interface StoreDevelopmentInformation { destinationBranchUrl?: string; /** The list of reviewers of this pull request */ reviewers?: { - /** @deprecated Deprecated. The name of this reviewer. Max length is 255 characters. */ - name?: string; /** The approval status of this reviewer, default is UNAPPROVED. */ - approvalStatus?: string; - /** @deprecated Deprecated. The URL of the profile for this reviewer. Max length is 2000 characters. */ - url?: string; - /** @deprecated Deprecated. The URL of the avatar for this reviewer. Max length is 2000 characters. */ - avatar?: string; + approvalStatus?: 'APPROVED' | 'NEEDSWORK' | 'UNAPPROVED' | string; /** The email address of this reviewer. Max length is 254 characters. */ email?: string; /** The Atlassian Account ID (AAID) of this reviewer. Max length is 128 characters. */ @@ -264,6 +218,8 @@ export interface StoreDevelopmentInformation { url: string; /** Shortened identifier for this pull request, used for display. Max length is 255 characters. */ displayId: string; + /** The number of tasks on the pull request */ + taskCount?: number; }[]; /** The URL of the avatar for this repository. Max length is 2000 characters. */ avatar?: string; @@ -292,7 +248,7 @@ export interface StoreDevelopmentInformation { * (e.g. indexing a newly connected account). Default is "NORMAL". Please note that "BACKFILL" operations have a much * higher rate-limiting threshold but are also processed slower in comparison to "NORMAL" operations. */ - operationType?: string; + operationType?: 'NORMAL' | 'BACKFILL' | string; /** * Arbitrary properties to tag the submitted repositories with. These properties can be used for delete operations to * e.g. clean up all development information associated with an account in the event that the account is removed from diff --git a/src/agile/parameters/submitBuilds.ts b/src/agile/parameters/submitBuilds.ts index 634908352f..052fe4280d 100644 --- a/src/agile/parameters/submitBuilds.ts +++ b/src/agile/parameters/submitBuilds.ts @@ -25,7 +25,7 @@ export interface SubmitBuilds { * * Placeholder to support potential schema changes in the future. */ - schemaVersion?: string; + schemaVersion?: '1.0' | string; /** * An ID that relates a sequence of builds. Depending on your use case this might be a project ID, pipeline ID, plan * key etc. - whatever logical unit you use to group a sequence of builds. @@ -75,7 +75,7 @@ export interface SubmitBuilds { * running. `successful` - The build completed successfully. `failed` - The build failed. `cancelled` - The build * has been cancelled or stopped. `unknown` - The build is in an unknown state. */ - state: string; + state: 'pending' | 'in_progress' | 'successful' | 'failed' | 'cancelled' | 'unknown' | string; /** The last-updated timestamp to present to the user as a summary of the state of the build. */ lastUpdated: string; /** diff --git a/src/agile/parameters/submitDeployments.ts b/src/agile/parameters/submitDeployments.ts index 58f359ba37..97ed88f596 100644 --- a/src/agile/parameters/submitDeployments.ts +++ b/src/agile/parameters/submitDeployments.ts @@ -27,16 +27,11 @@ export interface SubmitDeployments { * example, epoch time could be one way to generate the updateSequenceNumber. */ updateSequenceNumber: number; - /** - * Deprecated. The Jira issue keys to associate the Deployment information with. Should replace this field with the - * "associations" field to associate Deployment information with issueKeys or other types of associations. - */ - issueKeys?: string[]; /** * The entities to associate the Deployment information with. It must contain at least one of * IssueIdOrKeysAssociation or ServiceIdOrKeysAssociation. */ - associations?: {}[]; + associations: any[]; /** The human-readable name for the deployment. Will be shown in the UI. */ displayName: string; /** A URL users can use to link to this deployment, in this environment. */ @@ -51,7 +46,7 @@ export interface SubmitDeployments { */ label?: string; /** The state of the deployment */ - state: string; + state: 'unknown' | 'pending' | 'in_progress' | 'cancelled' | 'failed' | 'rolled_back' | 'successful' | string; /** * This object models the Continuous Delivery (CD) Pipeline concept, an automated process (usually comprised of * multiple stages) for getting software from version control right through to the production environment. @@ -71,7 +66,7 @@ export interface SubmitDeployments { /** The name of the environment to present to the user. */ displayName: string; /** The type of the environment. */ - type: string; + type: 'unmapped' | 'development' | 'testing' | 'staging' | 'production' | string; }; /** A list of commands to be actioned for this Deployment */ commands?: { @@ -83,7 +78,12 @@ export interface SubmitDeployments { * * Placeholder to support potential schema changes in the future. */ - schemaVersion?: string; + schemaVersion?: '1.0' | string; + /** Describes the user who triggered the deployment */ + triggeredBy?: { + /** The email address of the user. Used to associate the user with a Jira user. Max length is 255 characters. */ + email?: string; + }; }[]; /** * Information about the provider. This is useful for auditing, logging, debugging, and other internal uses. It is not diff --git a/src/agile/parameters/submitFeatureFlags.ts b/src/agile/parameters/submitFeatureFlags.ts index 8672826960..5cf1f9a00a 100644 --- a/src/agile/parameters/submitFeatureFlags.ts +++ b/src/agile/parameters/submitFeatureFlags.ts @@ -25,7 +25,7 @@ export interface SubmitFeatureFlags { * * Placeholder to support potential schema changes in the future. */ - schemaVersion?: string; + schemaVersion?: '1.0' | string; /** The identifier for the Feature Flag. Must be unique for a given Provider. */ id: string; /** @@ -139,7 +139,7 @@ export interface SubmitFeatureFlags { /** The name of the environment. */ name: string; /** The 'type' or 'category' of environment this environment belongs to. */ - type?: string; + type?: 'development' | 'testing' | 'staging' | 'production' | string; }; /** Status information about a single Feature Flag. */ status: { diff --git a/src/agile/parameters/submitRemoteLinks.ts b/src/agile/parameters/submitRemoteLinks.ts index 711fd33aa2..1c69f05591 100644 --- a/src/agile/parameters/submitRemoteLinks.ts +++ b/src/agile/parameters/submitRemoteLinks.ts @@ -21,7 +21,7 @@ export interface SubmitRemoteLinks { * * Placeholder to support potential schema changes in the future. */ - schemaVersion?: string; + schemaVersion?: '1.0' | string; /** The identifier for the Remote Link. Must be unique for a given Provider. */ id: string; /** @@ -47,7 +47,17 @@ export interface SubmitRemoteLinks { * The type of the Remote Link. The current supported types are 'document', 'alert', 'test', 'security', 'logFile', * 'prototype', 'coverage', 'bugReport' and 'other' */ - type: string; + type: + | 'document' + | 'alert' + | 'test' + | 'security' + | 'logFile' + | 'prototype' + | 'coverage' + | 'bugReport' + | 'other' + | string; /** * An optional description to attach to this Remote Link. * @@ -65,7 +75,7 @@ export interface SubmitRemoteLinks { * they correspond to are equivalent to atlaskit's [Lozenge](https://atlaskit.atlassian.com/packages/core/lozenge) * component. */ - appearance: string; + appearance: 'default' | 'inprogress' | 'moved' | 'new' | 'removed' | 'prototype' | 'success' | string; /** * The human-readable description for the Remote Link status. * diff --git a/src/agile/parameters/submitVulnerabilities.ts b/src/agile/parameters/submitVulnerabilities.ts index f95baa9e23..d7ee227193 100644 --- a/src/agile/parameters/submitVulnerabilities.ts +++ b/src/agile/parameters/submitVulnerabilities.ts @@ -1,4 +1,13 @@ export interface SubmitVulnerabilities { + /** + * Indicates the operation being performed by the provider system when sending this data. "NORMAL" - Data received + * during real-time, user-triggered actions (e.g. user closed or updated a vulnerability). "SCAN" - Data sent through + * some automated process (e.g. some periodically scheduled repository scan). "BACKFILL" - Data received while + * backfilling existing data (e.g. pushing historical vulnerabilities when re-connect a workspace). Default is + * "NORMAL". "NORMAL" traffic has higher priority but tighter rate limits, "SCAN" traffic has medium priority and + * looser limits, "BACKFILL" has lower priority and much looser limits + */ + operationType?: 'NORMAL' | 'SCAN' | 'BACKFILL' | string; /** * Properties assigned to vulnerability data that can then be used for delete / query operations. * @@ -15,7 +24,7 @@ export interface SubmitVulnerabilities { * * Placeholder to support potential schema changes in the future. */ - schemaVersion: string; + schemaVersion: '1.0' | string; /** The identifier for the Vulnerability. Must be unique for a given Provider. */ id: string; /** @@ -26,11 +35,14 @@ export interface SubmitVulnerabilities { * Provider system, but other alternatives are valid (e.g. a Provider could store a counter against each * Vulnerability and increment that on each update to Jira). * - * Updates for a Vulnerability that are received with an updateSqeuenceId lower than what is currently stored will + * Updates for a Vulnerability that are received with an updateSequenceId lower than what is currently stored will * be ignored. */ updateSequenceNumber: number; - /** The identifier of the Container where this Vulnerability was found. Must be unique for a given Provider. */ + /** + * The identifier of the Container where this Vulnerability was found. Must be unique for a given Provider. This + * must follow this regex pattern: `[a-zA-Z0-9\\-_.~@:{}=]+(/[a-zA-Z0-9\\-_.~@:{}=]+)*` + */ containerId: string; /** * The human-readable name for the Vulnerability. Will be shown in the UI. @@ -38,7 +50,12 @@ export interface SubmitVulnerabilities { * If not provided, will use the ID for display. */ displayName: string; - /** A description of the issue in Markdown format. Will be shown in the UI and used when creating Jira Issues. */ + /** + * A description of the issue in markdown format that will be shown in the UI and used when creating Jira Issues. + * HTML tags are not supported in the markdown format. For creating a new line `\n` can be used. Read more about the + * accepted markdown transformations + * [here](https://atlaskit.atlassian.com/packages/editor/editor-markdown-transformer). + */ description: string; /** * A URL users can use to link to a summary view of this vulnerability, if appropriate. @@ -48,7 +65,7 @@ export interface SubmitVulnerabilities { */ url: string; /** The type of Vulnerability detected. */ - type: string; + type: 'sca' | 'sast' | 'dast' | 'unknown' | string; /** * The timestamp to present to the user that shows when the Vulnerability was introduced. * @@ -68,7 +85,7 @@ export interface SubmitVulnerabilities { */ severity: { /** The severity level of the Vulnerability. */ - level: string; + level: 'critical' | 'high' | 'medium' | 'low' | 'unknown' | string; }; /** The identifying information for the Vulnerability. */ identifiers?: { @@ -78,7 +95,17 @@ export interface SubmitVulnerabilities { url: string; }[]; /** The current status of the Vulnerability. */ - status: string; + status: 'open' | 'closed' | 'ignored' | 'unknown' | string; + /** + * Extra information (optional). This data will be shown in the security feature under the vulnerability + * displayName. + */ + additionalInfo?: { + /** The content of the additionalInfo. */ + content: string; + /** Optional URL linking to the information */ + url?: string; + }; /** The entities to associate the Security Vulnerability information with. */ associations?: {}[]; }[]; diff --git a/src/agile/parameters/submitWorkspaces.ts b/src/agile/parameters/submitWorkspaces.ts index 0dc3139c65..e1cd8890ce 100644 --- a/src/agile/parameters/submitWorkspaces.ts +++ b/src/agile/parameters/submitWorkspaces.ts @@ -1,4 +1,7 @@ export interface SubmitWorkspaces { - /** The IDs of Security Workspaces to link to this Jira site. */ + /** + * The IDs of Security Workspaces to link to this Jira site. These must follow this regex pattern: + * `[a-zA-Z0-9\\-_.~@:{}=]+(\/[a-zA-Z0-9\\-_.~@:{}=]+)*` + */ workspaceIds: string[]; } diff --git a/src/agile/parameters/updateSprint.ts b/src/agile/parameters/updateSprint.ts index 92bff27a7e..9bdcff8a3f 100644 --- a/src/agile/parameters/updateSprint.ts +++ b/src/agile/parameters/updateSprint.ts @@ -8,7 +8,7 @@ export interface UpdateSprint { startDate?: string; endDate?: string; completeDate?: string; - originBoardId?: number; createdDate?: string; + originBoardId?: number; goal?: string; } diff --git a/src/agile/project.ts b/src/agile/project.ts deleted file mode 100644 index eaaa2f30a7..0000000000 --- a/src/agile/project.ts +++ /dev/null @@ -1,32 +0,0 @@ -import * as Models from './models'; -import * as Parameters from './parameters'; -import { Callback } from '../callback'; -import { Client } from '../clients'; -import { RequestConfig } from '../requestConfig'; - -/** @deprecated Will be removed in the next major version. */ -export class Project { - constructor(private client: Client) {} - - /** @deprecated Will be removed in the next major version. */ - async getFeaturesForProject( - parameters: Parameters.GetFeaturesForProject, - callback: Callback, - ): Promise; - /** @deprecated Will be removed in the next major version. */ - async getFeaturesForProject( - parameters: Parameters.GetFeaturesForProject, - callback?: never, - ): Promise; - async getFeaturesForProject( - parameters: Parameters.GetFeaturesForProject, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: `/rest/agile/1.0/project/${parameters.projectIdOrKey}/features`, - method: 'GET', - }; - - return this.client.sendRequest(config, callback); - } -} diff --git a/src/agile/remoteLinks.ts b/src/agile/remoteLinks.ts index dec12fa081..0da91b9725 100644 --- a/src/agile/remoteLinks.ts +++ b/src/agile/remoteLinks.ts @@ -114,7 +114,7 @@ export class RemoteLinks { url: '/rest/remotelinks/1.0/bulkByProperties', method: 'DELETE', params: { - _updateSequenceNumber: parameters._updateSequenceNumber || parameters.updateSequenceNumber, + _updateSequenceNumber: parameters.updateSequenceNumber, params: parameters.params, }, }; @@ -189,7 +189,7 @@ export class RemoteLinks { url: `/rest/remotelinks/1.0/remotelink/${parameters.remoteLinkId}`, method: 'DELETE', params: { - _updateSequenceNumber: parameters._updateSequenceNumber || parameters.updateSequenceNumber, + _updateSequenceNumber: parameters.updateSequenceNumber, }, }; diff --git a/src/clients/baseClient.ts b/src/clients/baseClient.ts index b4f5599454..c3354b5ba1 100644 --- a/src/clients/baseClient.ts +++ b/src/clients/baseClient.ts @@ -1,9 +1,9 @@ -import { AuthenticationService } from '../services/authenticationService'; import type { Callback } from '../callback'; import type { Client } from './client'; import type { Config } from '../config'; +import { getAuthenticationToken } from '../services/authenticationService'; import type { RequestConfig } from '../requestConfig'; -import axios, { AxiosError, AxiosInstance } from 'axios'; +import axios, { AxiosError, AxiosInstance, AxiosResponse } from 'axios'; const STRICT_GDPR_FLAG = 'x-atlassian-force-account-id'; const ATLASSIAN_TOKEN_CHECK_FLAG = 'X-Atlassian-Token'; @@ -86,46 +86,53 @@ export class BaseClient implements Client { async sendRequest(requestConfig: RequestConfig, callback: Callback, telemetryData?: any): Promise; async sendRequest(requestConfig: RequestConfig, callback: Callback | never): Promise { try { - const modifiedRequestConfig = { - ...requestConfig, - headers: this.removeUndefinedProperties({ - Authorization: await AuthenticationService.getAuthenticationToken(this.config.authentication, { - baseURL: this.config.host, - url: this.instance.getUri(requestConfig), - method: requestConfig.method!, - }), - ...requestConfig.headers, - }), - }; + const response = await this.sendRequestFullResponse(requestConfig); - const response = await this.instance.request(modifiedRequestConfig); + return this.handleSuccessResponse(response.data, callback); + } catch (e: any) { + return this.handleFailedResponse(e, callback); + } + } + + async sendRequestFullResponse(requestConfig: RequestConfig): Promise> { + const modifiedRequestConfig = { + ...requestConfig, + headers: this.removeUndefinedProperties({ + Authorization: await getAuthenticationToken(this.config.authentication), + ...requestConfig.headers, + }), + }; - const callbackResponseHandler = callback && ((data: T): void => callback(null, data)); - const defaultResponseHandler = (data: T): T => data; + return this.instance.request(modifiedRequestConfig); + } - const responseHandler = callbackResponseHandler ?? defaultResponseHandler; + handleSuccessResponse(response: any, callback?: Callback | never): T | void { + const callbackResponseHandler = callback && ((data: T): void => callback(null, data)); + const defaultResponseHandler = (data: T): T => data; - this.config.middlewares?.onResponse?.(response.data); + const responseHandler = callbackResponseHandler ?? defaultResponseHandler; - return responseHandler(response.data); - } catch (e: any) { - const err = - this.config.newErrorHandling && axios.isAxiosError(e) && e.response ? this.buildNewErrorHandlingResponse(e) : e; + this.config.middlewares?.onResponse?.(response.data); - const callbackErrorHandler = callback && ((error: Config.Error) => callback(error)); - const defaultErrorHandler = (error: Error) => { - throw error; - }; + return responseHandler(response); + } - const errorHandler = callbackErrorHandler ?? defaultErrorHandler; + handleFailedResponse(e: Error, callback?: Callback | never): void { + const err = axios.isAxiosError(e) && e.response ? this.buildErrorHandlingResponse(e) : e; - this.config.middlewares?.onError?.(err); + const callbackErrorHandler = callback && ((error: Config.Error) => callback(error)); + const defaultErrorHandler = (error: Error) => { + throw error; + }; - return errorHandler(err); - } + const errorHandler = callbackErrorHandler ?? defaultErrorHandler; + + this.config.middlewares?.onError?.(err); + + return errorHandler(err); } - private buildNewErrorHandlingResponse(error: AxiosError) { + private buildErrorHandlingResponse(error: AxiosError) { return { code: error.code, status: error.response?.status, diff --git a/src/clients/client.ts b/src/clients/client.ts index dd2d9ee363..2f697f1f6f 100644 --- a/src/clients/client.ts +++ b/src/clients/client.ts @@ -1,7 +1,12 @@ +import type { AxiosResponse } from 'axios'; import type { Callback } from '../callback'; import type { RequestConfig } from '../requestConfig'; export interface Client { sendRequest(requestConfig: RequestConfig, callback?: never, telemetryData?: any): Promise; sendRequest(requestConfig: RequestConfig, callback?: Callback, telemetryData?: any): Promise; + + sendRequestFullResponse(requestConfig: RequestConfig): Promise>; + handleSuccessResponse(response: any, callback?: Callback | undefined | never): T | void; + handleFailedResponse(e: Error, callback?: Callback | never): void; } diff --git a/src/config.ts b/src/config.ts index 22c2817e6a..f17ffb161d 100644 --- a/src/config.ts +++ b/src/config.ts @@ -10,40 +10,22 @@ export interface Config { baseRequestConfig?: Config.BaseRequestConfig; authentication?: Config.Authentication; middlewares?: Config.Middlewares; - /** @deprecated Disabled. Will be removed in the next major version */ - telemetry?: Config.Telemetry; - /** Enable new API error handling. `false` by default. */ - newErrorHandling?: boolean; } export namespace Config { export type BaseRequestConfig = RequestConfig; export type Error = AxiosError; - /** @deprecated Disabled. Will be removed in the next major version */ - export type Telemetry = boolean | any; - export type Authentication = UtilityTypes.XOR< - { - jwt: Authentication.JWT; - }, - UtilityTypes.XOR< - { - oauth: Authentication.OAuth; - }, - UtilityTypes.XOR< + export type Authentication = UtilityTypes.XOR3< { personalAccessToken: Authentication.PersonalAccessToken; }, - UtilityTypes.XOR< { basic: Authentication.Basic; }, { oauth2: Authentication.OAuth2; } - > - > - > >; export interface Middlewares { diff --git a/src/serviceDesk/models/changeDetails.ts b/src/serviceDesk/models/changeDetails.ts deleted file mode 100644 index 5540c682fe..0000000000 --- a/src/serviceDesk/models/changeDetails.ts +++ /dev/null @@ -1,17 +0,0 @@ -/** A change item. */ -export interface ChangeDetails { - /** The name of the field changed. */ - field?: string; - /** The type of the field changed. */ - fieldtype?: string; - /** The ID of the field changed. */ - fieldId?: string; - /** The details of the original value. */ - from?: string; - /** The details of the original value as a string. */ - fromString?: string; - /** The details of the new value. */ - to?: string; - /** The details of the new value as a string. */ - toString?: string; -} diff --git a/src/serviceDesk/models/changelog.ts b/src/serviceDesk/models/changelog.ts deleted file mode 100644 index d5a5ea1006..0000000000 --- a/src/serviceDesk/models/changelog.ts +++ /dev/null @@ -1,15 +0,0 @@ -import { ChangeDetails } from './changeDetails'; -import { HistoryMetadata } from './historyMetadata'; -import { UserDetails } from './userDetails'; - -/** A changelog. */ -export interface Changelog { - /** The ID of the changelog. */ - id?: string; - author?: UserDetails; - /** The date on which the change took place. */ - created?: string; - /** The list of items changed. */ - items?: ChangeDetails[]; - historyMetadata?: HistoryMetadata; -} diff --git a/src/serviceDesk/models/errorResponse.ts b/src/serviceDesk/models/errorResponse.ts deleted file mode 100644 index f63ea56b38..0000000000 --- a/src/serviceDesk/models/errorResponse.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { I18nErrorMessage } from './i18nErrorMessage'; - -export interface ErrorResponse { - errorMessage?: string; - i18nErrorMessage?: I18nErrorMessage; -} diff --git a/src/serviceDesk/models/expandable.ts b/src/serviceDesk/models/expandable.ts deleted file mode 100644 index 617b979232..0000000000 --- a/src/serviceDesk/models/expandable.ts +++ /dev/null @@ -1,3 +0,0 @@ -export interface Expandable { - Expands?: string[]; -} diff --git a/src/serviceDesk/models/fieldMetadata.ts b/src/serviceDesk/models/fieldMetadata.ts deleted file mode 100644 index 170d38f391..0000000000 --- a/src/serviceDesk/models/fieldMetadata.ts +++ /dev/null @@ -1,24 +0,0 @@ -import { JsonType } from './jsonType'; - -/** The metadata describing an issue field. */ -export interface FieldMetadata { - /** Whether the field is required. */ - required: boolean; - schema?: JsonType; - /** The name of the field. */ - name: string; - /** The key of the field. */ - key: string; - /** The URL that can be used to automatically complete the field. */ - autoCompleteUrl?: string; - /** Whether the field has a default value. */ - hasDefaultValue?: boolean; - /** The list of operations that can be performed on the field. */ - operations: string[]; - /** The list of values allowed in the field. */ - allowedValues?: {}[]; - /** The default value of the field. */ - defaultValue?: {}; - /** The configuration properties. */ - configuration?: {}; -} diff --git a/src/serviceDesk/models/historyMetadata.ts b/src/serviceDesk/models/historyMetadata.ts deleted file mode 100644 index ff27d2ce33..0000000000 --- a/src/serviceDesk/models/historyMetadata.ts +++ /dev/null @@ -1,24 +0,0 @@ -import { HistoryMetadataParticipant } from './historyMetadataParticipant'; - -/** Details of issue history metadata. */ -export interface HistoryMetadata { - /** The type of the history record. */ - type?: string; - /** The description of the history record. */ - description?: string; - /** The description key of the history record. */ - descriptionKey?: string; - /** The activity described in the history record. */ - activityDescription?: string; - /** The key of the activity described in the history record. */ - activityDescriptionKey?: string; - /** The description of the email address associated the history record. */ - emailDescription?: string; - /** The description key of the email address associated the history record. */ - emailDescriptionKey?: string; - actor?: HistoryMetadataParticipant; - generator?: HistoryMetadataParticipant; - cause?: HistoryMetadataParticipant; - /** Additional arbitrary information about the history record. */ - extraData?: {}; -} diff --git a/src/serviceDesk/models/historyMetadataParticipant.ts b/src/serviceDesk/models/historyMetadataParticipant.ts deleted file mode 100644 index b87417b933..0000000000 --- a/src/serviceDesk/models/historyMetadataParticipant.ts +++ /dev/null @@ -1,15 +0,0 @@ -/** Details of user or system associated with a issue history metadata item. */ -export interface HistoryMetadataParticipant { - /** The ID of the user or system associated with a history record. */ - id?: string; - /** The display name of the user or system associated with a history record. */ - displayName?: string; - /** The key of the display name of the user or system associated with a history record. */ - displayNameKey?: string; - /** The type of the user or system associated with a history record. */ - type?: string; - /** The URL to an avatar for the user or system associated with a history record. */ - avatarUrl?: string; - /** The URL of the user or system associated with a history record. */ - url?: string; -} diff --git a/src/serviceDesk/models/i18nErrorMessage.ts b/src/serviceDesk/models/i18nErrorMessage.ts deleted file mode 100644 index 2fbc49273b..0000000000 --- a/src/serviceDesk/models/i18nErrorMessage.ts +++ /dev/null @@ -1,4 +0,0 @@ -export interface I18nErrorMessage { - i18nKey?: string; - parameters?: string[]; -} diff --git a/src/serviceDesk/models/includedFields.ts b/src/serviceDesk/models/includedFields.ts deleted file mode 100644 index 0e57bbe17b..0000000000 --- a/src/serviceDesk/models/includedFields.ts +++ /dev/null @@ -1,5 +0,0 @@ -export interface IncludedFields { - included?: string[]; - actuallyIncluded?: string[]; - excluded?: string[]; -} diff --git a/src/serviceDesk/models/index.ts b/src/serviceDesk/models/index.ts index 004c9c9185..3d5914ce1d 100644 --- a/src/serviceDesk/models/index.ts +++ b/src/serviceDesk/models/index.ts @@ -8,8 +8,6 @@ export * from './attachmentCreate'; export * from './attachmentCreateResult'; export * from './attachmentLink'; export * from './avatarUrls'; -export * from './changeDetails'; -export * from './changelog'; export * from './comment'; export * from './commentCreate'; export * from './content'; @@ -27,24 +25,10 @@ export * from './customerTransitionExecution'; export * from './date'; export * from './duration'; export * from './entityProperty'; -export * from './errorResponse'; -export * from './expandable'; -export * from './fieldMetadata'; -export * from './historyMetadata'; -export * from './historyMetadataParticipant'; -export * from './i18nErrorMessage'; -export * from './includedFields'; export * from './insightWorkspace'; export * from './issue'; export * from './issueTransition'; -export * from './issueUpdateMetadata'; export * from './jsonType'; -export * from './linkable'; -export * from './linkableAttachmentLink'; -export * from './linkableCustomerRequestLink'; -export * from './linkableUserLink'; -export * from './linkGroup'; -export * from './operations'; export * from './organization'; export * from './organizationCreate'; export * from './organizationServiceDeskUpdate'; @@ -65,7 +49,6 @@ export * from './pagedRequestTypeGroup'; export * from './pagedServiceDesk'; export * from './pagedSlaInformation'; export * from './pagedUser'; -export * from './pageOfChangelogs'; export * from './propertyKey'; export * from './propertyKeys'; export * from './queue'; @@ -83,7 +66,6 @@ export * from './requestTypeIconLink'; export * from './selfLink'; export * from './serviceDesk'; export * from './serviceDeskCustomer'; -export * from './simpleLink'; export * from './slaInformation'; export * from './slaInformationCompletedCycle'; export * from './slaInformationOngoingCycle'; diff --git a/src/serviceDesk/models/issueUpdateMetadata.ts b/src/serviceDesk/models/issueUpdateMetadata.ts deleted file mode 100644 index 1310374474..0000000000 --- a/src/serviceDesk/models/issueUpdateMetadata.ts +++ /dev/null @@ -1,4 +0,0 @@ -/** A list of editable field details. */ -export interface IssueUpdateMetadata { - fields?: {}; -} diff --git a/src/serviceDesk/models/linkGroup.ts b/src/serviceDesk/models/linkGroup.ts deleted file mode 100644 index 3450796946..0000000000 --- a/src/serviceDesk/models/linkGroup.ts +++ /dev/null @@ -1,11 +0,0 @@ -import { SimpleLink } from './simpleLink'; - -/** Details a link group, which defines issue operations. */ -export interface LinkGroup { - id?: string; - styleClass?: string; - header?: SimpleLink; - weight?: number; - links?: SimpleLink[]; - groups?: LinkGroup[]; -} diff --git a/src/serviceDesk/models/linkable.ts b/src/serviceDesk/models/linkable.ts deleted file mode 100644 index 81ad9348d5..0000000000 --- a/src/serviceDesk/models/linkable.ts +++ /dev/null @@ -1,5 +0,0 @@ -import { SelfLink } from './selfLink'; - -export interface Linkable { - Links?: SelfLink; -} diff --git a/src/serviceDesk/models/linkableAttachmentLink.ts b/src/serviceDesk/models/linkableAttachmentLink.ts deleted file mode 100644 index 0e2b563b92..0000000000 --- a/src/serviceDesk/models/linkableAttachmentLink.ts +++ /dev/null @@ -1,5 +0,0 @@ -import { AttachmentLink } from './attachmentLink'; - -export interface LinkableAttachmentLink { - Links?: AttachmentLink; -} diff --git a/src/serviceDesk/models/linkableCustomerRequestLink.ts b/src/serviceDesk/models/linkableCustomerRequestLink.ts deleted file mode 100644 index 44ea310c43..0000000000 --- a/src/serviceDesk/models/linkableCustomerRequestLink.ts +++ /dev/null @@ -1,5 +0,0 @@ -import { CustomerRequestLink } from './customerRequestLink'; - -export interface LinkableCustomerRequestLink { - Links?: CustomerRequestLink; -} diff --git a/src/serviceDesk/models/linkableUserLink.ts b/src/serviceDesk/models/linkableUserLink.ts deleted file mode 100644 index 47d8c43ee5..0000000000 --- a/src/serviceDesk/models/linkableUserLink.ts +++ /dev/null @@ -1,5 +0,0 @@ -import { UserLink } from './userLink'; - -export interface LinkableUserLink { - Links?: UserLink; -} diff --git a/src/serviceDesk/models/operations.ts b/src/serviceDesk/models/operations.ts deleted file mode 100644 index 11702d0336..0000000000 --- a/src/serviceDesk/models/operations.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { LinkGroup } from './linkGroup'; - -/** Details of the operations that can be performed on the issue. */ -export interface Operations { - /** Details of the link groups defining issue operations. */ - linkGroups?: LinkGroup[]; -} diff --git a/src/serviceDesk/models/pageOfChangelogs.ts b/src/serviceDesk/models/pageOfChangelogs.ts deleted file mode 100644 index d9a89272b2..0000000000 --- a/src/serviceDesk/models/pageOfChangelogs.ts +++ /dev/null @@ -1,13 +0,0 @@ -import { Changelog } from './changelog'; - -/** A page of changelogs. */ -export interface PageOfChangelogs { - /** The index of the first item returned on the page. */ - startAt?: number; - /** The maximum number of results that could be on the page. */ - maxResults?: number; - /** The number of results on the page. */ - total?: number; - /** The list of changelogs. */ - histories?: Changelog[]; -} diff --git a/src/serviceDesk/models/simpleLink.ts b/src/serviceDesk/models/simpleLink.ts deleted file mode 100644 index 8a208f78bf..0000000000 --- a/src/serviceDesk/models/simpleLink.ts +++ /dev/null @@ -1,10 +0,0 @@ -/** Details about the operations available in this version. */ -export interface SimpleLink { - id?: string; - styleClass?: string; - iconClass?: string; - label?: string; - title?: string; - href?: string; - weight?: number; -} diff --git a/src/serviceDesk/models/user.ts b/src/serviceDesk/models/user.ts index 1775c2b8cb..5c2079efff 100644 --- a/src/serviceDesk/models/user.ts +++ b/src/serviceDesk/models/user.ts @@ -6,13 +6,6 @@ export interface User { * _5b10ac8d82e05b22cc7d4ef5_. */ accountId?: string; - /** - * @deprecated This property is no longer available and will be removed from the documentation soon. See the - * [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - name?: string; /** Customer's email address. Depending on the customer’s privacy settings, this may be returned as null. */ emailAddress?: string; /** diff --git a/src/serviceDesk/models/userLink.ts b/src/serviceDesk/models/userLink.ts index 52410efd8e..9e49765e26 100644 --- a/src/serviceDesk/models/userLink.ts +++ b/src/serviceDesk/models/userLink.ts @@ -2,9 +2,4 @@ export interface UserLink { self?: string; /** REST API URL for the customer. */ jiraRest?: string; - /** - * Links to the various sizes of the customer's avatar. Note that this property is deprecated, and will be removed in - * future versions. - */ - avatarUrls?: {}; } diff --git a/src/serviceDesk/parameters/attachTemporaryFile.ts b/src/serviceDesk/parameters/attachTemporaryFile.ts index 8e96c8b793..803ffa0322 100644 --- a/src/serviceDesk/parameters/attachTemporaryFile.ts +++ b/src/serviceDesk/parameters/attachTemporaryFile.ts @@ -1,15 +1,13 @@ +interface Attachment { + filename: string; + file: Buffer | ReadableStream | string | Blob | File; +} + export interface AttachTemporaryFile { /** * The ID of the Service Desk to which the file will be attached. This can alternatively be a [project * identifier.](#project-identifiers) */ serviceDeskId: string; - attachment: AttachTemporaryFile.Attachment | AttachTemporaryFile.Attachment[]; -} - -export namespace AttachTemporaryFile { - export interface Attachment { - filename: string; - file: Buffer | ReadableStream | string | Blob | File; - } + attachment: Attachment | Attachment[]; } diff --git a/src/serviceDesk/parameters/getCustomerRequests.ts b/src/serviceDesk/parameters/getCustomerRequests.ts index 912402c660..7764b61ea5 100644 --- a/src/serviceDesk/parameters/getCustomerRequests.ts +++ b/src/serviceDesk/parameters/getCustomerRequests.ts @@ -5,20 +5,6 @@ export interface GetCustomerRequests { * the `searchTerm` parameter. */ searchTerm?: string; - /** - * Filters customer requests using the following values: - * - * `OWNED_REQUESTS` returns customer requests where the user is the creator. `PARTICIPATED_REQUESTS` returns customer - * requests where the user is a participant. `ORGANIZATION` returns customer requests for an organization of which the - * user is a member when used in conjunction with `organizationId`. `ALL_ORGANIZATIONS` returns customer requests that - * belong to all organizations of which the user is a member. `APPROVER` returns customer requests where the user is - * an approver. Can be used in conjunction with `approvalStatus` to filter pending or complete approvals. - * `ALL_REQUESTS` returns all customer requests. **Deprecated and will be removed, as the returned requests may change - * if more values are added in the future. Instead, explicitly list the desired filtering strategies.** - * - * Multiple values of the query parameter are supported. For example, `requestOwnership=OWNED_REQUESTS&requestOwnership=PARTICIPATED_REQUESTS` will only return customer requests where the user is the creator or a participant. If not specified, filtering defaults to `OWNED_REQUESTS`, `PARTICIPATED_REQUESTS`, and `ALL_ORGANIZATIONS`. - */ - requestOwnership?: string[]; /** * Filters customer requests where the request is closed, open, or either of the two where: * diff --git a/src/serviceDesk/request.ts b/src/serviceDesk/request.ts index b19f2d1c3a..0370bd7dac 100644 --- a/src/serviceDesk/request.ts +++ b/src/serviceDesk/request.ts @@ -48,7 +48,6 @@ export class Request { method: 'GET', params: { searchTerm: parameters?.searchTerm, - requestOwnership: parameters?.requestOwnership, requestStatus: parameters?.requestStatus, approvalStatus: parameters?.approvalStatus, organizationId: parameters?.organizationId, diff --git a/src/services/authenticationService/authenticationService.ts b/src/services/authenticationService/authenticationService.ts deleted file mode 100644 index e238d0177e..0000000000 --- a/src/services/authenticationService/authenticationService.ts +++ /dev/null @@ -1,45 +0,0 @@ -import { Config } from '../../config'; -import { - createBasicAuthenticationToken, - createJWTAuthentication, - createOAuth2AuthenticationToken, - createOAuthAuthenticationToken, - createPATAuthentication, -} from './authentications'; - -export namespace AuthenticationService { - export async function getAuthenticationToken( - authentication: Config.Authentication | undefined, - requestData?: { - baseURL: string; - url: string; - method: string; - }, - ): Promise { - if (!authentication) { - return undefined; - } - - if (authentication.basic) { - return createBasicAuthenticationToken(authentication.basic); - } - - if (authentication.oauth) { - return createOAuthAuthenticationToken(authentication.oauth, requestData!); - } - - if (authentication.oauth2) { - return createOAuth2AuthenticationToken(authentication.oauth2); - } - - if (authentication.jwt) { - return createJWTAuthentication(authentication.jwt, requestData!); - } - - if (authentication.personalAccessToken) { - return createPATAuthentication(authentication.personalAccessToken); - } - - return undefined; - } -} diff --git a/src/services/authenticationService/authentications/createJWTAuthentication.ts b/src/services/authenticationService/authentications/createJWTAuthentication.ts deleted file mode 100644 index 43f0fa83ed..0000000000 --- a/src/services/authenticationService/authentications/createJWTAuthentication.ts +++ /dev/null @@ -1,27 +0,0 @@ -import * as jwt from 'atlassian-jwt'; -import { Config } from '../../../config'; - -export function createJWTAuthentication( - authenticationData: Config.Authentication.JWT, - requestData: { - method: string; - url: string; - }, -) { - const { method, url } = requestData; - - const now = Math.floor(Date.now() / 1000); - const expire = now + (authenticationData.expiryTimeSeconds ?? 180); - - const request = jwt.fromMethodAndUrl(method, url); - const tokenData = { - iss: authenticationData.issuer, - qsh: jwt.createQueryStringHash(request), - iat: now, - exp: expire, - }; - - const token = jwt.encodeSymmetric(tokenData, authenticationData.secret); - - return `JWT ${token}`; -} diff --git a/src/services/authenticationService/authentications/createOAuthAuthenticationToken.ts b/src/services/authenticationService/authentications/createOAuthAuthenticationToken.ts deleted file mode 100644 index a6d070f478..0000000000 --- a/src/services/authenticationService/authentications/createOAuthAuthenticationToken.ts +++ /dev/null @@ -1,27 +0,0 @@ -import { Config } from '../../../config'; -import { OAuth } from 'oauth'; - -export function createOAuthAuthenticationToken( - authenticationData: Config.Authentication.OAuth, - requestData: { baseURL: string; url: string; method: string }, -) { - const { baseURL, url, method } = requestData; - - const oauthUrl = `${baseURL}/plugins/servlet/oauth/`; - const oauth = new OAuth( - `${oauthUrl}request-token`, - `${oauthUrl}access-token`, - authenticationData.consumerKey, - authenticationData.consumerSecret, - '1.0', - null, - 'RSA-SHA1', - ); - - return oauth.authHeader( - new URL(url, baseURL).toString(), - authenticationData.accessToken, - authenticationData.tokenSecret, - method, - ); -} diff --git a/src/services/authenticationService/authentications/index.ts b/src/services/authenticationService/authentications/index.ts index f5dd777111..0ae8863d09 100644 --- a/src/services/authenticationService/authentications/index.ts +++ b/src/services/authenticationService/authentications/index.ts @@ -1,5 +1,3 @@ export * from './createBasicAuthenticationToken'; -export * from './createJWTAuthentication'; export * from './createOAuth2AuthenticationToken'; -export * from './createOAuthAuthenticationToken'; export * from './createPATAuthentication'; diff --git a/src/services/authenticationService/getAuthenticationToken.ts b/src/services/authenticationService/getAuthenticationToken.ts new file mode 100644 index 0000000000..85e0ef8ddb --- /dev/null +++ b/src/services/authenticationService/getAuthenticationToken.ts @@ -0,0 +1,28 @@ +import { Config } from '../../config'; +import { + createBasicAuthenticationToken, + createOAuth2AuthenticationToken, + createPATAuthentication, +} from './authentications'; + +export async function getAuthenticationToken( + authentication: Config.Authentication | undefined, +): Promise { + if (!authentication) { + return undefined; + } + + if (authentication.basic) { + return createBasicAuthenticationToken(authentication.basic); + } + + if (authentication.oauth2) { + return createOAuth2AuthenticationToken(authentication.oauth2); + } + + if (authentication.personalAccessToken) { + return createPATAuthentication(authentication.personalAccessToken); + } + + return undefined; +} diff --git a/src/services/authenticationService/index.ts b/src/services/authenticationService/index.ts index 920abd0611..3d87b165cb 100644 --- a/src/services/authenticationService/index.ts +++ b/src/services/authenticationService/index.ts @@ -1 +1 @@ -export * from './authenticationService'; +export * from './getAuthenticationToken'; diff --git a/src/utilityTypes.ts b/src/utilityTypes.ts index 413c0a5643..55915460e0 100644 --- a/src/utilityTypes.ts +++ b/src/utilityTypes.ts @@ -4,4 +4,7 @@ export namespace UtilityTypes { /** Get the XOR type which could make 2 types exclude each other */ export type XOR = T | U extends object ? (Without & U) | (Without & T) : T | U; + + /** Get the XOR type for 3 types */ + export type XOR3 = XOR, V>; } diff --git a/src/version2/appMigration.ts b/src/version2/appMigration.ts index 25edb50caa..d199d8bd9c 100644 --- a/src/version2/appMigration.ts +++ b/src/version2/appMigration.ts @@ -70,7 +70,7 @@ export class AppMigration { 'Atlassian-Transfer-Id': parameters.transferId, 'Content-Type': 'application/json', }, - data: parameters.body ?? parameters.entities, + data: parameters.entities, }; return this.client.sendRequest(config, callback); diff --git a/src/version2/appProperties.ts b/src/version2/appProperties.ts index c53038539a..75471109a2 100644 --- a/src/version2/appProperties.ts +++ b/src/version2/appProperties.ts @@ -114,7 +114,7 @@ export class AppProperties { const config: RequestConfig = { url: `/rest/atlassian-connect/1/addons/${parameters.addonKey}/properties/${parameters.propertyKey}`, method: 'PUT', - data: parameters.propertyValue ?? parameters.property, + data: parameters.propertyValue, }; return this.client.sendRequest(config, callback); diff --git a/src/version2/avatars.ts b/src/version2/avatars.ts index 8d0d69a668..799b5fbd64 100644 --- a/src/version2/avatars.ts +++ b/src/version2/avatars.ts @@ -137,6 +137,7 @@ export class Avatars { y: parameters.y, size: parameters.size, }, + data: parameters.avatar, }; return this.client.sendRequest(config, callback); @@ -172,7 +173,7 @@ export class Avatars { * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** None. */ - async getAvatarImageByType( + async getAvatarImageByType( parameters: Parameters.GetAvatarImageByType | string, callback: Callback, ): Promise; @@ -183,11 +184,11 @@ export class Avatars { * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** None. */ - async getAvatarImageByType( + async getAvatarImageByType( parameters: Parameters.GetAvatarImageByType | string, callback?: never, ): Promise; - async getAvatarImageByType( + async getAvatarImageByType( parameters: Parameters.GetAvatarImageByType | string, callback?: Callback, ): Promise { @@ -196,13 +197,21 @@ export class Avatars { const config: RequestConfig = { url: `/rest/api/2/universal_avatar/view/type/${type}`, method: 'GET', + responseType: 'arraybuffer', params: { size: typeof parameters !== 'string' && parameters.size, format: typeof parameters !== 'string' && parameters.format, }, }; - return this.client.sendRequest(config, callback); + const { + data: avatar, + headers: { 'content-type': contentTypeWithEncoding }, + } = await this.client.sendRequestFullResponse(config); + + const contentType = contentTypeWithEncoding.split(';')[0].trim(); + + return this.client.handleSuccessResponse({ contentType, avatar }, callback); } /** @@ -218,7 +227,7 @@ export class Avatars { * - For custom issue type avatars, _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) * for at least one project the issue type is used in. */ - async getAvatarImageByID( + async getAvatarImageByID( parameters: Parameters.GetAvatarImageByID, callback: Callback, ): Promise; @@ -235,21 +244,32 @@ export class Avatars { * - For custom issue type avatars, _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) * for at least one project the issue type is used in. */ - async getAvatarImageByID(parameters: Parameters.GetAvatarImageByID, callback?: never): Promise; - async getAvatarImageByID( + async getAvatarImageByID( + parameters: Parameters.GetAvatarImageByID, + callback?: never, + ): Promise; + async getAvatarImageByID( parameters: Parameters.GetAvatarImageByID, callback?: Callback, ): Promise { const config: RequestConfig = { url: `/rest/api/2/universal_avatar/view/type/${parameters.type}/avatar/${parameters.id}`, method: 'GET', + responseType: 'arraybuffer', params: { size: parameters.size, format: parameters.format, }, }; - return this.client.sendRequest(config, callback); + const { + data: avatar, + headers: { 'content-type': contentTypeWithEncoding }, + } = await this.client.sendRequestFullResponse(config); + + const contentType = contentTypeWithEncoding.split(';')[0].trim(); + + return this.client.handleSuccessResponse({ contentType, avatar }, callback); } /** @@ -265,7 +285,7 @@ export class Avatars { * - For custom issue type avatars, _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) * for at least one project the issue type is used in. */ - async getAvatarImageByOwner( + async getAvatarImageByOwner( parameters: Parameters.GetAvatarImageByOwner, callback: Callback, ): Promise; @@ -282,20 +302,31 @@ export class Avatars { * - For custom issue type avatars, _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) * for at least one project the issue type is used in. */ - async getAvatarImageByOwner(parameters: Parameters.GetAvatarImageByOwner, callback?: never): Promise; - async getAvatarImageByOwner( + async getAvatarImageByOwner( + parameters: Parameters.GetAvatarImageByOwner, + callback?: never, + ): Promise; + async getAvatarImageByOwner( parameters: Parameters.GetAvatarImageByOwner, callback?: Callback, ): Promise { const config: RequestConfig = { url: `/rest/api/2/universal_avatar/view/type/${parameters.type}/owner/${parameters.entityId}`, method: 'GET', + responseType: 'arraybuffer', params: { size: parameters.size, format: parameters.format, }, }; - return this.client.sendRequest(config, callback); + const { + data: avatar, + headers: { 'content-type': contentTypeWithEncoding }, + } = await this.client.sendRequestFullResponse(config); + + const contentType = contentTypeWithEncoding.split(';')[0].trim(); + + return this.client.handleSuccessResponse({ contentType, avatar }, callback); } } diff --git a/src/version2/client/version2Client.ts b/src/version2/client/version2Client.ts index 7a65408615..f2fe264178 100644 --- a/src/version2/client/version2Client.ts +++ b/src/version2/client/version2Client.ts @@ -12,8 +12,6 @@ import { FilterSharing, GroupAndUserPicker, Groups, - InstanceInformation, - IssueAdjustmentsApps, IssueAttachments, IssueCommentProperties, IssueComments, @@ -102,8 +100,6 @@ export class Version2Client extends BaseClient { filterSharing = new FilterSharing(this); groupAndUserPicker = new GroupAndUserPicker(this); groups = new Groups(this); - instanceInformation = new InstanceInformation(this); - issueAdjustmentsApps = new IssueAdjustmentsApps(this); issueAttachments = new IssueAttachments(this); issueCommentProperties = new IssueCommentProperties(this); issueComments = new IssueComments(this); diff --git a/src/version2/dashboards.ts b/src/version2/dashboards.ts index ef9e70fbf3..965ae75baf 100644 --- a/src/version2/dashboards.ts +++ b/src/version2/dashboards.ts @@ -200,7 +200,6 @@ export class Dashboards { params: { dashboardName: parameters?.dashboardName, accountId: parameters?.accountId, - owner: parameters?.owner, groupname: parameters?.groupname, groupId: parameters?.groupId, projectId: parameters?.projectId, @@ -537,7 +536,7 @@ export class Dashboards { headers: { 'Content-Type': 'application/json', }, - data: parameters.body, + data: parameters.propertyValue, }; return this.client.sendRequest(config, callback); diff --git a/src/version2/filters.ts b/src/version2/filters.ts index 1ecd242c6f..65e0895154 100644 --- a/src/version2/filters.ts +++ b/src/version2/filters.ts @@ -7,49 +7,6 @@ import { RequestConfig } from '../requestConfig'; export class Filters { constructor(private client: Client) {} - /** - * @deprecated Returns all filters. Deprecated, use [Search for filters](#api-rest-api-2-filter-search-get) that - * supports search and pagination. This operation can be accessed anonymously. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** None, - * however, only the following filters are returned: - * - * - Filters owned by the user. - * - Filters shared with a group that the user is a member of. - * - Filters shared with a private project that the user has _Browse projects_ [project - * permission](https://confluence.atlassian.com/x/yodKLg) for. - * - Filters shared with a public project. - * - Filters shared with the public. - */ - async getFilters( - parameters: Parameters.GetFilters | undefined, - callback: Callback, - ): Promise; - /** - * @deprecated Returns all filters. Deprecated, use [ Search for filters](#api-rest-api-2-filter-search-get) that - * supports search and pagination. This operation can be accessed anonymously. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** None, - * however, only the following filters are returned: - * - * - Filters owned by the user. - * - Filters shared with a group that the user is a member of. - * - Filters shared with a private project that the user has _Browse projects_ [project - * permission](https://confluence.atlassian.com/x/yodKLg) for. - * - Filters shared with a public project. - * - Filters shared with the public. - */ - async getFilters(parameters?: Parameters.GetFilters, callback?: never): Promise; - async getFilters(parameters?: Parameters.GetFilters, callback?: Callback): Promise { - const config: RequestConfig = { - url: '/rest/api/2/filter', - method: 'GET', - params: { - expand: parameters?.expand, - }, - }; - - return this.client.sendRequest(config, callback); - } - /** * Creates a filter. The filter is shared according to the [default share scope](#api-rest-api-2-filter-post). The * filter is not selected as a favorite. @@ -270,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, diff --git a/src/version2/groups.ts b/src/version2/groups.ts index 17e481c8c1..2aeba04980 100644 --- a/src/version2/groups.ts +++ b/src/version2/groups.ts @@ -7,54 +7,21 @@ import { RequestConfig } from '../requestConfig'; export class Groups { constructor(private client: Client) {} - /** - * @deprecated This operation is deprecated, use - * [`group/member`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-groups/#api-rest-api-2-group-member-get). - * Returns all users in a group. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async getGroup(parameters: Parameters.GetGroup, callback: Callback): Promise; - /** - * @deprecated This operation is deprecated, use - * [`group/member`](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-groups/#api-rest-api-2-group-member-get). - * Returns all users in a group. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async getGroup(parameters: Parameters.GetGroup, callback?: never): Promise; - async getGroup(parameters: Parameters.GetGroup, callback?: Callback): Promise { - const config: RequestConfig = { - url: '/rest/api/2/group', - method: 'GET', - params: { - groupname: parameters?.groupname, - groupId: parameters?.groupId, - expand: parameters?.expand, - }, - }; - - return this.client.sendRequest(config, callback); - } - /** * Creates a group. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** Site * administration (that is, member of the _site-admin_ [group](https://confluence.atlassian.com/x/24xjL)). */ - async createGroup( - parameters: Parameters.CreateGroup | undefined, - callback: Callback, - ): Promise; + async createGroup(parameters: Parameters.CreateGroup, callback: Callback): Promise; /** * Creates a group. * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** Site * administration (that is, member of the _site-admin_ [group](https://confluence.atlassian.com/x/24xjL)). */ - async createGroup(parameters?: Parameters.CreateGroup, callback?: never): Promise; - async createGroup(parameters?: Parameters.CreateGroup, callback?: Callback): Promise { + async createGroup(parameters: Parameters.CreateGroup, callback?: never): Promise; + async createGroup(parameters: Parameters.CreateGroup, callback?: Callback): Promise { const config: RequestConfig = { url: '/rest/api/2/group', method: 'POST', @@ -201,7 +168,7 @@ export class Groups { url: '/rest/api/2/group/user', method: 'POST', params: { - groupname: parameters.groupname, + groupname: parameters.groupName, groupId: parameters.groupId, }, data: { @@ -301,13 +268,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 ea350b692a..f44c40620e 100644 --- a/src/version2/index.ts +++ b/src/version2/index.ts @@ -10,8 +10,6 @@ export * from './filters'; export * from './filterSharing'; export * from './groupAndUserPicker'; export * from './groups'; -export * from './instanceInformation'; -export * from './issueAdjustmentsApps'; export * from './issueAttachments'; export * from './issueCommentProperties'; export * from './issueComments'; diff --git a/src/version2/instanceInformation.ts b/src/version2/instanceInformation.ts deleted file mode 100644 index f9ab9e0fb4..0000000000 --- a/src/version2/instanceInformation.ts +++ /dev/null @@ -1,30 +0,0 @@ -import * as Models from './models'; -import { Callback } from '../callback'; -import { Client } from '../clients'; -import { RequestConfig } from '../requestConfig'; - -/** @deprecated Use {@link LicenseMetrics} */ -export class InstanceInformation { - constructor(private client: Client) {} - - /** - * @deprecated Use {@link LicenseMetrics.getLicense}. Returns licensing information about the Jira instance. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * None. - */ - async getLicense(callback: Callback): Promise; - /** - * @deprecated Use {@link LicenseMetrics.getLicense}. Returns licensing information about the Jira instance. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * None. - */ - async getLicense(callback?: never): Promise; - async getLicense(callback?: Callback): Promise { - const config: RequestConfig = { - url: '/rest/api/2/instance/license', - method: 'GET', - }; - - return this.client.sendRequest(config, callback); - } -} diff --git a/src/version2/issueAdjustmentsApps.ts b/src/version2/issueAdjustmentsApps.ts deleted file mode 100644 index 01b912f0d5..0000000000 --- a/src/version2/issueAdjustmentsApps.ts +++ /dev/null @@ -1,158 +0,0 @@ -import * as Models from './models'; -import * as Parameters from './parameters'; -import { Callback } from '../callback'; -import { Client } from '../clients'; -import { RequestConfig } from '../requestConfig'; - -export class IssueAdjustmentsApps { - constructor(private client: Client) {} - - /** - * @deprecated Gets issue adjustments. Issue adjustments can only be retrieved by Forge apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * None. - */ - async getIssueAdjustments( - parameters: Parameters.GetIssueAdjustments | undefined, - callback: Callback, - ): Promise; - /** - * @deprecated Gets issue adjustments. Issue adjustments can only be retrieved by Forge apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * None. - */ - async getIssueAdjustments( - parameters?: Parameters.GetIssueAdjustments, - callback?: never, - ): Promise; - async getIssueAdjustments( - parameters?: Parameters.GetIssueAdjustments, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: '/rest/api/2/issueAdjustments', - method: 'GET', - params: { - startAt: parameters?.startAt, - maxResults: parameters?.maxResults, - expand: parameters?.expand, - }, - }; - - return this.client.sendRequest(config, callback); - } - - /** - * @deprecated Creates an issue adjustment. Issue adjustment can only be created by Forge apps. Each app can define up - * to 100 issue adjustments. Each issue adjustment can define up to 1000 contexts. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * - * - _None_ if the issue adjustment is created without contexts. - * - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the - * issue adjustment is created with contexts. - */ - async createIssueAdjustment( - parameters: Parameters.CreateIssueAdjustment | undefined, - callback: Callback, - ): Promise; - /** - * @deprecated Creates an issue adjustment. Issue adjustment can only be created by Forge apps. Each app can define up - * to 100 issue adjustments. Each issue adjustment can define up to 1000 contexts. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * - * - _None_ if the issue adjustment is created without contexts. - * - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the - * issue adjustment is created with contexts. - */ - async createIssueAdjustment( - parameters?: Parameters.CreateIssueAdjustment, - callback?: never, - ): Promise; - async createIssueAdjustment( - parameters?: Parameters.CreateIssueAdjustment, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: '/rest/api/2/issueAdjustments', - method: 'POST', - data: { - name: parameters?.name, - description: parameters?.description, - data: parameters?.data, - contexts: parameters?.contexts, - }, - }; - - return this.client.sendRequest(config, callback); - } - - /** - * @deprecated Updates an issue adjustment. Issue adjustment can only be updated by Forge apps. Each issue adjustment - * can define up to 1000 contexts. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * - * - _None_ if the issue adjustment is created without contexts. - * - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the - * issue adjustment is created with contexts. - */ - async updateIssueAdjustment( - parameters: Parameters.UpdateIssueAdjustment, - callback: Callback, - ): Promise; - /** - * @deprecated Updates an issue adjustment. Issue adjustment can only be updated by Forge apps. Each issue adjustment - * can define up to 1000 contexts. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * - * - _None_ if the issue adjustment is created without contexts. - * - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the - * issue adjustment is created with contexts. - */ - async updateIssueAdjustment(parameters: Parameters.UpdateIssueAdjustment, callback?: never): Promise; - async updateIssueAdjustment( - parameters: Parameters.UpdateIssueAdjustment, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: `/rest/api/2/issueAdjustments/${parameters.issueAdjustmentId}`, - method: 'PUT', - data: { - name: parameters.name, - description: parameters.description, - data: parameters.data, - contexts: parameters.contexts, - }, - }; - - return this.client.sendRequest(config, callback); - } - - /** - * @deprecated Deletes an issue adjustment. All the contexts that belong to the issue adjustment are deleted too. - * Issue adjustment can only be deleted by Forge apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * None. - */ - async deleteIssueAdjustment( - parameters: Parameters.DeleteIssueAdjustment, - callback: Callback, - ): Promise; - /** - * @deprecated Deletes an issue adjustment. All the contexts that belong to the issue adjustment are deleted too. - * Issue adjustment can only be deleted by Forge apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * None. - */ - async deleteIssueAdjustment(parameters: Parameters.DeleteIssueAdjustment, callback?: never): Promise; - async deleteIssueAdjustment( - parameters: Parameters.DeleteIssueAdjustment, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: `/rest/api/2/issueAdjustments/${parameters.issueAdjustmentId}`, - method: 'DELETE', - }; - - return this.client.sendRequest(config, callback); - } -} diff --git a/src/version2/issueComments.ts b/src/version2/issueComments.ts index bdb053da2e..8f45ac0ae6 100644 --- a/src/version2/issueComments.ts +++ b/src/version2/issueComments.ts @@ -155,7 +155,7 @@ export class IssueComments { self: parameters.self, id: parameters.id, author: parameters.author, - body: parameters.body, + body: parameters.comment, renderedBody: parameters.renderedBody, updateAuthor: parameters.updateAuthor, created: parameters.created, @@ -259,7 +259,7 @@ export class IssueComments { expand: parameters.expand, }, data: { - body: parameters.body, + body: parameters.comment, visibility: parameters.visibility, properties: parameters.properties, }, diff --git a/src/version2/issueCustomFieldConfigurationApps.ts b/src/version2/issueCustomFieldConfigurationApps.ts index 156ed3b6e3..9fd1d66810 100644 --- a/src/version2/issueCustomFieldConfigurationApps.ts +++ b/src/version2/issueCustomFieldConfigurationApps.ts @@ -58,7 +58,6 @@ export class IssueCustomFieldConfigurationApps { method: 'GET', params: { id: parameters.id, - contextId: parameters.contextId, fieldContextId: parameters.fieldContextId, issueId: parameters.issueId, projectKeyOrId: parameters.projectKeyOrId, diff --git a/src/version2/issueCustomFieldOptions.ts b/src/version2/issueCustomFieldOptions.ts index 494ac1789f..4f7cb8ff63 100644 --- a/src/version2/issueCustomFieldOptions.ts +++ b/src/version2/issueCustomFieldOptions.ts @@ -7,160 +7,6 @@ import { RequestConfig } from '../requestConfig'; export class IssueCustomFieldOptions { constructor(private client: Client) {} - /** - * @deprecated This operation is deprecated and becomes unavailable on 8 May 2021. Use [Get custom field options - * (context)](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-get) - * instead. See [Deprecation of custom field - * options](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-removal-of-custom-field-options-operations/) - * for details. Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#pagination) - * list of options and, where the custom select field is of the type _Select List (cascading)_, cascading options - * for custom select fields. Cascading options are included in the item count when determining pagination. Only - * options from the global context are returned. Note that this operation **only works for issue field select list - * options created in Jira or using operations from the [Issue custom field - * options](#api-group-Issue-custom-field-options) resource**, it cannot be used with issue field select list - * options created by Connect apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async getOptionsForField( - parameters: Parameters.GetOptionsForField, - callback: Callback, - ): Promise; - /** - * @deprecated This operation is deprecated and becomes unavailable on 8 May 2021. Use [Get custom field options - * (context)](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-get) - * instead. See [Deprecation of custom field - * options](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-removal-of-custom-field-options-operations/) - * for details. Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#pagination) - * list of options and, where the custom select field is of the type _Select List (cascading)_, cascading options - * for custom select fields. Cascading options are included in the item count when determining pagination. Only - * options from the global context are returned. Note that this operation **only works for issue field select list - * options created in Jira or using operations from the [Issue custom field - * options](#api-group-Issue-custom-field-options) resource**, it cannot be used with issue field select list - * options created by Connect apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async getOptionsForField( - parameters: Parameters.GetOptionsForField, - callback?: never, - ): Promise; - async getOptionsForField( - parameters: Parameters.GetOptionsForField, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: `/rest/api/2/customField/${parameters.fieldId}/option`, - method: 'GET', - params: { - startAt: parameters.startAt, - maxResults: parameters.maxResults, - }, - }; - - return this.client.sendRequest(config, callback); - } - - /** - * @deprecated This operation is deprecated and becomes unavailable on 8 May 2021. Use [Create custom field options - * (context)](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-post) - * instead. See [Deprecation of custom field - * options](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-removal-of-custom-field-options-operations/) - * for details. Creates options and, where the custom select field is of the type _Select List (cascading)_, - * cascading options for a custom select field. The options are added to the global context of the field. Note that - * this operation **only works for issue field select list options created in Jira or using operations from the - * [Issue custom field options](#api-group-Issue-custom-field-options) resource**, it cannot be used with issue - * field select list options created by Connect apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async createCustomFieldOptions( - parameters: Parameters.CreateCustomFieldOptions, - callback: Callback, - ): Promise; - /** - * @deprecated This operation is deprecated and becomes unavailable on 8 May 2021. Use [Create custom field options - * (context)](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-post) - * instead. See [Deprecation of custom field - * options](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-removal-of-custom-field-options-operations/) - * for details. Creates options and, where the custom select field is of the type _Select List (cascading)_, - * cascading options for a custom select field. The options are added to the global context of the field. Note that - * this operation **only works for issue field select list options created in Jira or using operations from the - * [Issue custom field options](#api-group-Issue-custom-field-options) resource**, it cannot be used with issue - * field select list options created by Connect apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async createCustomFieldOptions( - parameters: Parameters.CreateCustomFieldOptions, - callback?: never, - ): Promise; - async createCustomFieldOptions( - parameters: Parameters.CreateCustomFieldOptions, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: `/rest/api/2/customField/${parameters.fieldId}/option`, - method: 'POST', - data: { - options: parameters.options, - }, - }; - - return this.client.sendRequest(config, callback); - } - - /** - * @deprecated This operation is deprecated and becomes unavailable on 8 May 2021. Use [Update custom field options - * (context)](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-put) - * instead. See [Deprecation of custom field - * options](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-removal-of-custom-field-options-operations/) - * for details. Updates the options on a custom select field. Where an updated option is in use on an issue, the - * value on the issue is also updated. Options that are not found are ignored. A maximum of 1000 options, including - * sub-options of _Select List (cascading)_ fields, can be updated per request. The options are updated on the - * global context of the field. Note that this operation **only works for issue field select list options created in - * Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource**, - * it cannot be used with issue field select list options created by Connect apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async updateCustomFieldOptions( - parameters: Parameters.UpdateCustomFieldOptions, - callback: Callback, - ): Promise; - /** - * @deprecated This operation is deprecated and becomes unavailable on 8 May 2021. Use [Update custom field options - * (context)](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-put) - * instead. See [Deprecation of custom field - * options](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-removal-of-custom-field-options-operations/) - * for details. Updates the options on a custom select field. Where an updated option is in use on an issue, the - * value on the issue is also updated. Options that are not found are ignored. A maximum of 1000 options, including - * sub-options of _Select List (cascading)_ fields, can be updated per request. The options are updated on the - * global context of the field. Note that this operation **only works for issue field select list options created in - * Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource**, - * it cannot be used with issue field select list options created by Connect apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async updateCustomFieldOptions( - parameters: Parameters.UpdateCustomFieldOptions, - callback?: never, - ): Promise; - async updateCustomFieldOptions( - parameters: Parameters.UpdateCustomFieldOptions, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: `/rest/api/2/customField/${parameters.fieldId}/option`, - method: 'PUT', - data: { - options: parameters.options, - }, - }; - - return this.client.sendRequest(config, callback); - } - /** * Returns a custom field option. For example, an option in a select list. * diff --git a/src/version2/issueFields.ts b/src/version2/issueFields.ts index 50284bed91..4873583e65 100644 --- a/src/version2/issueFields.ts +++ b/src/version2/issueFields.ts @@ -220,44 +220,6 @@ export class IssueFields { return this.client.sendRequest(config, callback); } - /** - * @deprecated Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#pagination) - * list of the contexts a field is used in. Deprecated, use [ Get custom field - * contexts](#api-rest-api-2-field-fieldId-context-get). - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async getContextsForFieldDeprecated( - parameters: Parameters.GetContextsForFieldDeprecated, - callback: Callback, - ): Promise; - /** - * @deprecated Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#pagination) - * list of the contexts a field is used in. Deprecated, use [ Get custom field - * contexts](#api-rest-api-2-field-fieldId-context-get). - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async getContextsForFieldDeprecated( - parameters: Parameters.GetContextsForFieldDeprecated, - callback?: never, - ): Promise; - async getContextsForFieldDeprecated( - parameters: Parameters.GetContextsForFieldDeprecated, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: `/rest/api/2/field/${parameters.fieldId}/contexts`, - method: 'GET', - params: { - startAt: parameters.startAt, - maxResults: parameters.maxResults, - }, - }; - - return this.client.sendRequest(config, callback); - } - /** * Deletes a custom field. The custom field is deleted whether it is in the trash or not. See [Edit or delete a custom * field](https://confluence.atlassian.com/x/Z44fOw) for more information on trashing and deleting custom fields. diff --git a/src/version2/issueNotificationSchemes.ts b/src/version2/issueNotificationSchemes.ts index 0621f57a3c..9c75917276 100644 --- a/src/version2/issueNotificationSchemes.ts +++ b/src/version2/issueNotificationSchemes.ts @@ -215,38 +215,6 @@ export class IssueNotificationSchemes { return this.client.sendRequest(config, callback); } - /** - * Adds notifications to a notification scheme. You can add up to 1000 notifications per request. - * - * @deprecated: The notification type `EmailAddress` is no longer supported in Cloud. Refer to the - * [changelog](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-1031) for more details._ - * - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async addNotifications(parameters: Parameters.AddNotifications, callback: Callback): Promise; - /** - * Adds notifications to a notification scheme. You can add up to 1000 notifications per request. - * - * @deprecated: The notification type `EmailAddress` is no longer supported in Cloud. Refer to the - * [changelog](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-1031) for more details._ - * - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async addNotifications(parameters: Parameters.AddNotifications, callback?: never): Promise; - async addNotifications(parameters: Parameters.AddNotifications, callback?: Callback): Promise { - const config: RequestConfig = { - url: `/rest/api/2/notificationscheme/${parameters.id}/notification`, - method: 'PUT', - data: { - notificationSchemeEvents: parameters.notificationSchemeEvents, - }, - }; - - return this.client.sendRequest(config, callback); - } - /** * Deletes a notification scheme. * diff --git a/src/version2/issuePriorities.ts b/src/version2/issuePriorities.ts index fc98e5afea..04f82b2efa 100644 --- a/src/version2/issuePriorities.ts +++ b/src/version2/issuePriorities.ts @@ -238,47 +238,4 @@ export class IssuePriorities { return this.client.sendRequest(config, callback); } - - /** - * @deprecated: please refer to the_ [changelog](https://developer.atlassian.com/changelog/#CHANGE-1066) _for more - * details._ - * - * Deletes an issue priority. - * - * This operation is - * [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#async-operations). Follow the - * `location` link in the response to determine the status of the task and use [Get - * task](#api-rest-api-2-task-taskId-get) to obtain subsequent updates. - * - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async deletePriority(parameters: Parameters.DeletePriority, callback: Callback): Promise; - /** - * @deprecated: please refer to the_ [changelog](https://developer.atlassian.com/changelog/#CHANGE-1066) _for more - * details._ - * - * Deletes an issue priority. - * - * This operation is - * [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#async-operations). Follow the - * `location` link in the response to determine the status of the task and use [Get - * task](#api-rest-api-2-task-taskId-get) to obtain subsequent updates. - * - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async deletePriority(parameters: Parameters.DeletePriority, callback?: never): Promise; - async deletePriority(parameters: Parameters.DeletePriority, callback?: Callback): Promise { - const config: RequestConfig = { - url: `/rest/api/2/priority/${parameters.id}`, - method: 'DELETE', - params: { - newPriority: parameters.newPriority, - replaceWith: parameters.replaceWith, - }, - }; - - return this.client.sendRequest(config, callback); - } } diff --git a/src/version2/issueResolutions.ts b/src/version2/issueResolutions.ts index 45ca52eb38..10922ceae9 100644 --- a/src/version2/issueResolutions.ts +++ b/src/version2/issueResolutions.ts @@ -7,27 +7,6 @@ import { RequestConfig } from '../requestConfig'; export class IssueResolutions { constructor(private client: Client) {} - /** - * @deprecated Returns a list of all issue resolution values. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * Permission to access Jira. - */ - async getResolutions(callback: Callback): Promise; - /** - * @deprecated Returns a list of all issue resolution values. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * Permission to access Jira. - */ - async getResolutions(callback?: never): Promise; - async getResolutions(callback?: Callback): Promise { - const config: RequestConfig = { - url: '/rest/api/2/resolution', - method: 'GET', - }; - - return this.client.sendRequest(config, callback); - } - /** * Creates an issue resolution. * @@ -169,38 +148,6 @@ export class IssueResolutions { return this.client.sendRequest(config, callback); } - /** - * @deprecated Returns an issue resolution value. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * Permission to access Jira. - */ - async getResolution( - parameters: Parameters.GetResolution | string, - callback: Callback, - ): Promise; - /** - * @deprecated Returns an issue resolution value. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * Permission to access Jira. - */ - async getResolution( - parameters: Parameters.GetResolution | string, - callback?: never, - ): Promise; - async getResolution( - parameters: Parameters.GetResolution | string, - callback?: Callback, - ): Promise { - const id = typeof parameters === 'string' ? parameters : parameters.id; - - const config: RequestConfig = { - url: `/rest/api/2/resolution/${id}`, - method: 'GET', - }; - - return this.client.sendRequest(config, callback); - } - /** * Updates an issue resolution. * diff --git a/src/version2/issueTypeProperties.ts b/src/version2/issueTypeProperties.ts index bbd0a71284..cb3dd26eb3 100644 --- a/src/version2/issueTypeProperties.ts +++ b/src/version2/issueTypeProperties.ts @@ -137,7 +137,7 @@ export class IssueTypeProperties { const config: RequestConfig = { url: `/rest/api/2/issuetype/${parameters.issueTypeId}/properties/${parameters.propertyKey}`, method: 'PUT', - data: parameters.body, + data: parameters.propertyValue, }; return this.client.sendRequest(config, callback); diff --git a/src/version2/issueTypes.ts b/src/version2/issueTypes.ts index e5e99e0765..84721d580e 100644 --- a/src/version2/issueTypes.ts +++ b/src/version2/issueTypes.ts @@ -74,7 +74,6 @@ export class IssueTypes { data: { name: parameters?.name, description: parameters?.description, - type: parameters?.type, hierarchyLevel: parameters?.hierarchyLevel, }, }; diff --git a/src/version2/issueWatchers.ts b/src/version2/issueWatchers.ts index 2029f20b31..43144b8aba 100644 --- a/src/version2/issueWatchers.ts +++ b/src/version2/issueWatchers.ts @@ -206,7 +206,6 @@ export class IssueWatchers { url: `/rest/api/2/issue/${parameters.issueIdOrKey}/watchers`, method: 'DELETE', params: { - username: parameters.username, accountId: parameters.accountId, }, }; diff --git a/src/version2/jQL.ts b/src/version2/jQL.ts index 26d6b94118..a5dd54bb97 100644 --- a/src/version2/jQL.ts +++ b/src/version2/jQL.ts @@ -309,55 +309,4 @@ export class JQL { return this.client.sendRequest(config, callback); } - - /** @deprecated Use jqlFunctionApps.getPrecomputations */ - async getPrecomputations( - parameters: Parameters.GetPrecomputations | undefined, - callback: Callback, - ): Promise; - /** @deprecated Use jqlFunctionApps.getPrecomputations */ - async getPrecomputations( - parameters?: Parameters.GetPrecomputations, - callback?: never, - ): Promise; - async getPrecomputations( - parameters?: Parameters.GetPrecomputations, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: '/rest/api/2/jql/function/computation', - method: 'GET', - params: { - functionKey: parameters?.functionKey, - startAt: parameters?.startAt, - maxResults: parameters?.maxResults, - orderBy: parameters?.orderBy, - filter: parameters?.filter, - }, - }; - - return this.client.sendRequest(config, callback); - } - - /** @deprecated Use jqlFunctionApps.updatePrecomputations */ - async updatePrecomputations( - parameters: Parameters.UpdatePrecomputations, - callback: Callback, - ): Promise; - /** @deprecated Use jqlFunctionApps.updatePrecomputations */ - async updatePrecomputations(parameters: Parameters.UpdatePrecomputations, callback?: never): Promise; - async updatePrecomputations( - parameters: Parameters.UpdatePrecomputations, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: '/rest/api/2/jql/function/computation', - method: 'POST', - data: { - values: parameters.values, - }, - }; - - return this.client.sendRequest(config, callback); - } } diff --git a/src/version2/models/actorInput.ts b/src/version2/models/actorInput.ts index 74a607b0ca..8a28e8b5a9 100644 --- a/src/version2/models/actorInput.ts +++ b/src/version2/models/actorInput.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link ActorInput} instead. */ -export type ActorInputBean = ActorInput; - export interface ActorInput { /** * The name of the group to add as a default actor. This parameter cannot be used with the `groupId` parameter. As a diff --git a/src/version2/models/addField.ts b/src/version2/models/addField.ts index 50f14f5188..09d70ed44f 100644 --- a/src/version2/models/addField.ts +++ b/src/version2/models/addField.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link AddField} instead. */ -export type AddFieldBean = AddField; - export interface AddField { /** The ID of the field to add. */ fieldId: string; diff --git a/src/version2/models/addGroup.ts b/src/version2/models/addGroup.ts index 445e1b4645..261837d95e 100644 --- a/src/version2/models/addGroup.ts +++ b/src/version2/models/addGroup.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link AddGroup} instead. */ -export type AddGroupBean = AddGroup; - export interface AddGroup { /** The name of the group. */ name: string; diff --git a/src/version2/models/addNotificationsDetails.ts b/src/version2/models/addNotificationsDetails.ts deleted file mode 100644 index 388d257615..0000000000 --- a/src/version2/models/addNotificationsDetails.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { NotificationSchemeEventDetails } from './notificationSchemeEventDetails'; - -/** Details of notifications which should be added to the notification scheme. */ -export interface AddNotificationsDetails { - /** The list of notifications which should be added to the notification scheme. */ - notificationSchemeEvents: NotificationSchemeEventDetails[]; -} diff --git a/src/version2/models/applicationRole.ts b/src/version2/models/applicationRole.ts index 35b6905047..3180a57459 100644 --- a/src/version2/models/applicationRole.ts +++ b/src/version2/models/applicationRole.ts @@ -9,8 +9,6 @@ export interface ApplicationRole { defaultGroups?: string[]; /** The groups that are granted default access for this application role. */ defaultGroupsDetails?: GroupName[]; - /** Deprecated. */ - defined?: boolean; /** The groups associated with the application role. */ groupDetails?: GroupName[]; /** diff --git a/src/version2/models/associatedItem.ts b/src/version2/models/associatedItem.ts index e4c9a40396..99eb05db78 100644 --- a/src/version2/models/associatedItem.ts +++ b/src/version2/models/associatedItem.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link AssociatedItem} instead. */ -export type AssociatedItemBean = AssociatedItem; - /** Details of an item associated with the changed record. */ export interface AssociatedItem { /** The ID of the associated record. */ diff --git a/src/version2/models/attachment.ts b/src/version2/models/attachment.ts index bf9edc2486..ce08248aca 100644 --- a/src/version2/models/attachment.ts +++ b/src/version2/models/attachment.ts @@ -10,7 +10,7 @@ export interface Attachment { /** The file name of the attachment. */ filename?: string; /** The ID of the attachment. */ - id?: string; + id: string; /** The MIME type of the attachment. */ mimeType?: string; /** The URL of the attachment details response. */ diff --git a/src/version2/models/attachmentArchive.ts b/src/version2/models/attachmentArchive.ts deleted file mode 100644 index 16593d530a..0000000000 --- a/src/version2/models/attachmentArchive.ts +++ /dev/null @@ -1,8 +0,0 @@ -import { AttachmentArchiveEntry } from './attachmentArchiveEntry'; - -export interface AttachmentArchive { - entries?: AttachmentArchiveEntry[]; - moreAvailable?: boolean; - totalEntryCount?: number; - totalNumberOfEntriesAvailable?: number; -} diff --git a/src/version2/models/auditRecord.ts b/src/version2/models/auditRecord.ts index 91eb3303d0..5b294091e0 100644 --- a/src/version2/models/auditRecord.ts +++ b/src/version2/models/auditRecord.ts @@ -1,9 +1,6 @@ import { AssociatedItem } from './associatedItem'; import { ChangedValue } from './changedValue'; -/** @deprecated Use {@link AuditRecord} instead. */ -export type AuditRecordBean = AuditRecord; - /** An audit record. */ export interface AuditRecord { /** The ID of the audit record. */ @@ -12,8 +9,6 @@ export interface AuditRecord { summary?: string; /** The URL of the computer where the creation of the audit record was initiated. */ remoteAddress?: string; - /** Deprecated, use `authorAccountId` instead. The key of the user who created the audit record. */ - authorKey?: string; /** The date and time on which the audit record was created. */ created?: string; /** diff --git a/src/version2/models/avatarUrls.ts b/src/version2/models/avatarUrls.ts index d4342033e3..cda993d7f3 100644 --- a/src/version2/models/avatarUrls.ts +++ b/src/version2/models/avatarUrls.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link ActorInput} instead. */ -export type AvatarUrlsBean = AvatarUrls; - export interface AvatarUrls { /** The URL of the item's 16x16 pixel avatar. */ '16x16'?: string; diff --git a/src/version2/models/avatarWithDetails.ts b/src/version2/models/avatarWithDetails.ts new file mode 100644 index 0000000000..15f5f99071 --- /dev/null +++ b/src/version2/models/avatarWithDetails.ts @@ -0,0 +1,6 @@ +export interface AvatarWithDetails { + /** The content type of the avatar. Expected values include 'image/png', 'image/svg+xml', or any other valid MIME type. */ + contentType: 'image/png' | 'image/svg+xml' | string; + /** The binary representation of the avatar image. */ + avatar: ArrayBuffer; +} diff --git a/src/version2/models/bulkCreateCustomFieldOptionRequest.ts b/src/version2/models/bulkCreateCustomFieldOptionRequest.ts deleted file mode 100644 index 0cb53ca116..0000000000 --- a/src/version2/models/bulkCreateCustomFieldOptionRequest.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { CustomFieldOptionValue } from './customFieldOptionValue'; - -/** Details of options to create for a custom field. */ -export interface BulkCreateCustomFieldOptionRequest { - /** Details of options to create. */ - options?: CustomFieldOptionValue[]; -} diff --git a/src/version2/models/bulkPermissionsRequest.ts b/src/version2/models/bulkPermissionsRequest.ts index 742cd1c93e..69185f5e0d 100644 --- a/src/version2/models/bulkPermissionsRequest.ts +++ b/src/version2/models/bulkPermissionsRequest.ts @@ -1,8 +1,5 @@ import { BulkProjectPermissions } from './bulkProjectPermissions'; -/** @deprecated Use {@link BulkPermissionsRequest} instead. */ -export type BulkPermissionsRequestBean = BulkPermissionsRequest; - /** Details of global permissions to look up and project permissions with associated projects and issues to look up. */ export interface BulkPermissionsRequest { /** The account ID of a user. */ diff --git a/src/version2/models/changedValue.ts b/src/version2/models/changedValue.ts index 11925e3764..54733bdf6d 100644 --- a/src/version2/models/changedValue.ts +++ b/src/version2/models/changedValue.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link ChangedValue} instead. */ -export type ChangedValueBean = ChangedValue; - /** Details of names changed in the record event. */ export interface ChangedValue { /** The value of the field before the change. */ diff --git a/src/version2/models/comment.ts b/src/version2/models/comment.ts index 7183606daa..b86ec65039 100644 --- a/src/version2/models/comment.ts +++ b/src/version2/models/comment.ts @@ -6,7 +6,7 @@ import { Visibility } from './visibility'; export interface Comment { author?: UserDetails; /** The comment text. */ - body?: string; + comment?: string; /** The date and time at which the comment was created. */ created?: string; /** The ID of the comment. */ diff --git a/src/version2/models/component.ts b/src/version2/models/component.ts deleted file mode 100644 index b2e1052d2e..0000000000 --- a/src/version2/models/component.ts +++ /dev/null @@ -1,65 +0,0 @@ -import { User } from './user'; - -/** @deprecated Use {@link ProjectComponent}. Details about a project component. */ -export interface Component { - assignee?: User; - /** - * The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` - * for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the - * following values: - * - * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the - * component is in. `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for - * the component. `UNASSIGNED` an assignee is not set for issues created with this component. `PROJECT_DEFAULT` the - * assignee to any issues created with this component is nominally the default assignee for the project that the - * component is in. - * - * Default value: `PROJECT_DEFAULT`. Optional when creating or updating a component. - */ - assigneeType?: string; - /** The description for the component. Optional when creating or updating a component. */ - description?: string; - /** The unique identifier for the component. */ - id?: string; - /** - * Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but - * the component lead is not set, then `false` is returned. - */ - isAssigneeTypeValid?: boolean; - lead?: User; - /** - * The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian - * products. For example, _5b10ac8d82e05b22cc7d4ef5_. - */ - leadAccountId?: string; - /** - * This property is no longer available and will be removed from the documentation soon. See the [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - leadUserName?: string; - /** - * 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. - */ - name?: string; - /** The key of the project the component is assigned to. Required when creating a component. Can't be updated. */ - project?: string; - /** The ID of the project the component is assigned to. */ - projectId?: number; - realAssignee?: User; - /** - * The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set - * from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This - * property is set to one of the following values: - * - * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in - * the project that the component is in. `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component - * lead has permission to be assigned issues in the project that the component is in. `UNASSIGNED` when `assigneeType` - * is `UNASSIGNED` and Jira is configured to allow unassigned issues. `PROJECT_DEFAULT` when none of the preceding - * cases are true. - */ - realAssigneeType?: string; - /** The URL of the component. */ - self?: string; -} diff --git a/src/version2/models/compoundClause.ts b/src/version2/models/compoundClause.ts deleted file mode 100644 index fa8b495139..0000000000 --- a/src/version2/models/compoundClause.ts +++ /dev/null @@ -1,14 +0,0 @@ -import { JqlQueryClause } from './jqlQueryClause'; - -/** - * A JQL query clause that consists of nested clauses. For example, `(labels in (urgent, blocker) OR lastCommentedBy = - * currentUser()). Note that, where nesting is not defined, the parser nests JQL clauses based on the operator - * precedence. For example, "A OR B AND C" is parsed as "(A OR B) AND C". See Setting the precedence of operators for - * more information about precedence in JQL queries.` - */ -export interface CompoundClause { - /** The list of nested clauses. */ - clauses: JqlQueryClause[]; - /** The operator between the clauses. */ - operator: string; -} diff --git a/src/version2/models/configuration.ts b/src/version2/models/configuration.ts index bdb4bb7226..1cfaf774aa 100644 --- a/src/version2/models/configuration.ts +++ b/src/version2/models/configuration.ts @@ -9,8 +9,6 @@ export interface Configuration { /** Whether the ability to create subtasks for issues is enabled. */ subTasksEnabled?: boolean; timeTrackingConfiguration?: TimeTrackingConfiguration; - /** Whether the ability to track time is enabled. This property is deprecated. */ - timeTrackingEnabled?: boolean; /** * Whether the ability to create unassigned issues is enabled. See [Configuring Jira application * options](https://confluence.atlassian.com/x/uYXKM) for details. diff --git a/src/version2/models/context.ts b/src/version2/models/context.ts deleted file mode 100644 index 638cbfe41c..0000000000 --- a/src/version2/models/context.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { Scope } from './scope'; - -/** A context. */ -export interface Context { - /** The ID of the context. */ - id?: number; - /** The name of the context. */ - name?: string; - scope?: Scope; -} diff --git a/src/version2/models/contextualConfiguration.ts b/src/version2/models/contextualConfiguration.ts index 0369ffa385..c0ddb38796 100644 --- a/src/version2/models/contextualConfiguration.ts +++ b/src/version2/models/contextualConfiguration.ts @@ -2,8 +2,6 @@ export interface ContextualConfiguration { /** The ID of the configuration. */ id: string; - /** @deprecated Deprecated, do not use. */ - contextId?: number; /** The ID of the field context the configuration is associated with. */ fieldContextId: string; /** The field configuration. */ diff --git a/src/version2/models/crateWorkflowStatusDetails.ts b/src/version2/models/crateWorkflowStatusDetails.ts deleted file mode 100644 index 99bbc7de80..0000000000 --- a/src/version2/models/crateWorkflowStatusDetails.ts +++ /dev/null @@ -1,5 +0,0 @@ -/** The details of a transition status. */ -export interface CrateWorkflowStatusDetails { - /** The ID of the status. */ - id: string; -} diff --git a/src/version2/models/createIssueAdjustmentDetails.ts b/src/version2/models/createIssueAdjustmentDetails.ts deleted file mode 100644 index 35e23b8dad..0000000000 --- a/src/version2/models/createIssueAdjustmentDetails.ts +++ /dev/null @@ -1,13 +0,0 @@ -import { IssueAdjustmentContextDetails } from './issueAdjustmentContextDetails'; - -/** The details of an issue adjustment. */ -export interface CreateIssueAdjustmentDetails { - /** The name of the issue adjustment. The maximum length is 255 characters. */ - name: string; - /** The description of the issue adjustment. The maximum length is 255 characters. */ - description?: string; - /** The data of the issue adjustment. The maximum size of the data is 50000 characters. */ - data?: string; - /** List of contexts of the issue adjustment. The maximum number of contexts is 1000. */ - contexts?: IssueAdjustmentContextDetails[]; -} diff --git a/src/version2/models/createProjectDetails.ts b/src/version2/models/createProjectDetails.ts index 0762088f1c..ce2f9af361 100644 --- a/src/version2/models/createProjectDetails.ts +++ b/src/version2/models/createProjectDetails.ts @@ -9,19 +9,11 @@ export interface CreateProjectDetails { name: string; /** A brief description of the project. */ description?: string; - /** - * @deprecated This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the - * [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The user name of the project lead. Either `lead` or `leadAccountId` must be set when creating a - * project. Cannot be provided with `leadAccountId`. - */ - lead?: string; /** * The account ID of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Cannot be * provided with `lead`. */ - leadAccountId?: string; + leadAccountId: string; /** A link to information about this project, such as project documentation */ url?: string; /** The default assignee when creating issues for this project. */ diff --git a/src/version2/models/createUpdateRoleRequest.ts b/src/version2/models/createUpdateRoleRequest.ts index ff1f82ad27..2c1e6e6beb 100644 --- a/src/version2/models/createUpdateRoleRequest.ts +++ b/src/version2/models/createUpdateRoleRequest.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link CreateUpdateRoleRequest} instead. */ -export type CreateUpdateRoleRequestBean = CreateUpdateRoleRequest; - export interface CreateUpdateRoleRequest { /** * A description of the project role. Required when fully updating a project role. Optional when creating or partially diff --git a/src/version2/models/customFieldContextDefaultValueCascadingOption.ts b/src/version2/models/customFieldContextDefaultValueCascadingOption.ts deleted file mode 100644 index d3e7b9987e..0000000000 --- a/src/version2/models/customFieldContextDefaultValueCascadingOption.ts +++ /dev/null @@ -1,10 +0,0 @@ -/** The default value for a cascading select custom field. */ -export interface CustomFieldContextDefaultValueCascadingOption { - /** The ID of the default cascading option. */ - cascadingOptionId?: string; - /** The ID of the context. */ - contextId: string; - /** The ID of the default option. */ - optionId: string; - type: string; -} diff --git a/src/version2/models/customFieldContextDefaultValueMultipleOption.ts b/src/version2/models/customFieldContextDefaultValueMultipleOption.ts deleted file mode 100644 index 7bbaeb6385..0000000000 --- a/src/version2/models/customFieldContextDefaultValueMultipleOption.ts +++ /dev/null @@ -1,8 +0,0 @@ -/** The default value for a multi-select custom field. */ -export interface CustomFieldContextDefaultValueMultipleOption { - /** The ID of the context. */ - contextId: string; - /** The list of IDs of the default options. */ - optionIds: string[]; - type: string; -} diff --git a/src/version2/models/customFieldContextDefaultValueSingleOption.ts b/src/version2/models/customFieldContextDefaultValueSingleOption.ts deleted file mode 100644 index 63d25b6e77..0000000000 --- a/src/version2/models/customFieldContextDefaultValueSingleOption.ts +++ /dev/null @@ -1,8 +0,0 @@ -/** The default value for a single select custom field. */ -export interface CustomFieldContextDefaultValueSingleOption { - /** The ID of the context. */ - contextId: string; - /** The ID of the default option. */ - optionId: string; - type: string; -} diff --git a/src/version2/models/customFieldDefinitionJson.ts b/src/version2/models/customFieldDefinitionJson.ts index 80f7eb5e84..b55d9a816e 100644 --- a/src/version2/models/customFieldDefinitionJson.ts +++ b/src/version2/models/customFieldDefinitionJson.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link CustomFieldDefinitionJson} instead. */ -export type CustomFieldDefinitionJsonBean = CustomFieldDefinitionJson; - export interface CustomFieldDefinitionJson { /** The name of the custom field, which is displayed in Jira. This is not the unique identifier. */ name: string; diff --git a/src/version2/models/customFieldOptionDetails.ts b/src/version2/models/customFieldOptionDetails.ts deleted file mode 100644 index 9edb4bf7b0..0000000000 --- a/src/version2/models/customFieldOptionDetails.ts +++ /dev/null @@ -1,9 +0,0 @@ -/** Details of a custom field option and its cascading options. */ -export interface CustomFieldOptionDetails { - /** The ID of the custom field option. */ - id?: number; - /** The value of the custom field option. */ - value?: string; - /** The cascading options. */ - cascadingOptions?: string[]; -} diff --git a/src/version2/models/customFieldOptionValue.ts b/src/version2/models/customFieldOptionValue.ts deleted file mode 100644 index 3b2b9918d3..0000000000 --- a/src/version2/models/customFieldOptionValue.ts +++ /dev/null @@ -1,7 +0,0 @@ -/** Value of a custom field option and the values of its cascading options. */ -export interface CustomFieldOptionValue { - /** The value of the custom field option. */ - value: string; - /** The cascading options. */ - cascadingOptions?: string[]; -} diff --git a/src/version2/models/customFieldValueUpdateRequest.ts b/src/version2/models/customFieldValueUpdateRequest.ts deleted file mode 100644 index 4f2e7c9009..0000000000 --- a/src/version2/models/customFieldValueUpdateRequest.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { CustomFieldValueUpdate } from './customFieldValueUpdate'; - -/** @deprecated Details of updates for a custom field. */ -export interface CustomFieldValueUpdateRequest { - /** The list of custom field update details. */ - updates?: CustomFieldValueUpdate[]; -} diff --git a/src/version2/models/dashboardUser.ts b/src/version2/models/dashboardUser.ts index 831fbf72ec..8907f7d266 100644 --- a/src/version2/models/dashboardUser.ts +++ b/src/version2/models/dashboardUser.ts @@ -1,23 +1,8 @@ import { UserAvatarUrls } from './userAvatarUrls'; -/** @deprecated Use {@link DashboardUser} instead. */ -export type UserBean = DashboardUser; - export interface DashboardUser { - /** - * This property is deprecated in favor of `accountId` because of privacy changes. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The key of the user. - */ - key?: string; /** The URL of the user. */ self?: string; - /** - * This property is deprecated in favor of `accountId` because of privacy changes. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The username of the user. - */ - name?: string; /** The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */ displayName?: string; /** Whether the user is active. */ diff --git a/src/version2/models/deleteAndReplaceVersion.ts b/src/version2/models/deleteAndReplaceVersion.ts deleted file mode 100644 index 320a7d4ce6..0000000000 --- a/src/version2/models/deleteAndReplaceVersion.ts +++ /dev/null @@ -1,16 +0,0 @@ -import { CustomFieldReplacement } from './customFieldReplacement'; - -/** @deprecated Use {@link DeleteAndReplaceVersion} instead. */ -export type DeleteAndReplaceVersionBean = DeleteAndReplaceVersion; - -export interface DeleteAndReplaceVersion { - /** - * An array of custom field IDs (`customFieldId`) and version IDs (`moveTo`) to update when the fields contain the - * deleted version. - */ - customFieldReplacementList?: CustomFieldReplacement[]; - /** The ID of the version to update `affectedVersion` to when the field contains the deleted version. */ - moveAffectedIssuesTo?: number; - /** The ID of the version to update `fixVersion` to when the field contains the deleted version. */ - moveFixIssuesTo?: number; -} diff --git a/src/version2/models/deprecatedWorkflow.ts b/src/version2/models/deprecatedWorkflow.ts deleted file mode 100644 index 21f2dcd556..0000000000 --- a/src/version2/models/deprecatedWorkflow.ts +++ /dev/null @@ -1,23 +0,0 @@ -import { Scope } from './scope'; - -/** Details about a workflow. */ -export interface DeprecatedWorkflow { - default?: boolean; - /** The description of the workflow. */ - description?: string; - /** The datetime the workflow was last modified. */ - lastModifiedDate?: string; - /** - * This property is no longer available and will be removed from the documentation soon. See the [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - lastModifiedUser?: string; - /** The account ID of the user that last modified the workflow. */ - lastModifiedUserAccountId?: string; - /** The name of the workflow. */ - name?: string; - scope?: Scope; - /** The number of steps included in the workflow. */ - steps?: number; -} diff --git a/src/version2/models/errorMessage.ts b/src/version2/models/errorMessage.ts deleted file mode 100644 index 45c1efb997..0000000000 --- a/src/version2/models/errorMessage.ts +++ /dev/null @@ -1,4 +0,0 @@ -export interface ErrorMessage { - /** The error message. */ - message: string; -} diff --git a/src/version2/models/fieldChangedClause.ts b/src/version2/models/fieldChangedClause.ts deleted file mode 100644 index 65702c8ff5..0000000000 --- a/src/version2/models/fieldChangedClause.ts +++ /dev/null @@ -1,15 +0,0 @@ -import { JqlQueryClauseTimePredicate } from './jqlQueryClauseTimePredicate'; -import { JqlQueryField } from './jqlQueryField'; - -/** - * A clause that asserts whether a field was changed. For example, `status CHANGED AFTER startOfMonth(-1M)`.See - * [CHANGED](https://confluence.atlassian.com/x/dgiiLQ#Advancedsearching-operatorsreference-CHANGEDCHANGED) for more - * information about the CHANGED operator. - */ -export interface FieldChangedClause { - field: JqlQueryField; - /** The operator applied to the field. */ - operator: string; - /** The list of time predicates. */ - predicates: JqlQueryClauseTimePredicate[]; -} diff --git a/src/version2/models/fieldUpdateOperation.ts b/src/version2/models/fieldUpdateOperation.ts deleted file mode 100644 index 26de5cc66f..0000000000 --- a/src/version2/models/fieldUpdateOperation.ts +++ /dev/null @@ -1,11 +0,0 @@ -/** Details of an operation to perform on a field. */ -export interface FieldUpdateOperation { - /** The value to add to the field. */ - add?: any; - /** The value to set in the field. */ - set?: any; - /** The value to removed from the field. */ - remove?: any; - /** The value to edit in the field. */ - edit?: any; -} diff --git a/src/version2/models/fieldValueClause.ts b/src/version2/models/fieldValueClause.ts deleted file mode 100644 index e204ff0cc3..0000000000 --- a/src/version2/models/fieldValueClause.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { JqlQueryClauseOperand } from './jqlQueryClauseOperand'; -import { JqlQueryField } from './jqlQueryField'; - -/** A clause that asserts the current value of a field. For example, `summary ~ test`. */ -export interface FieldValueClause { - field: JqlQueryField; - operand: JqlQueryClauseOperand; - /** The operator between the field and operand. */ - operator: string; -} diff --git a/src/version2/models/fieldWasClause.ts b/src/version2/models/fieldWasClause.ts deleted file mode 100644 index 8fbc02379b..0000000000 --- a/src/version2/models/fieldWasClause.ts +++ /dev/null @@ -1,17 +0,0 @@ -import { JqlQueryClauseOperand } from './jqlQueryClauseOperand'; -import { JqlQueryClauseTimePredicate } from './jqlQueryClauseTimePredicate'; -import { JqlQueryField } from './jqlQueryField'; - -/** - * A clause that asserts a previous value of a field. For example, `status WAS "Resolved" BY currentUser() BEFORE - * "2019/02/02"`. See [WAS](https://confluence.atlassian.com/x/dgiiLQ#Advancedsearching-operatorsreference-WASWAS) for - * more information about the WAS operator. - */ -export interface FieldWasClause { - field: JqlQueryField; - operand: JqlQueryClauseOperand; - /** The operator between the field and operand. */ - operator: string; - /** The list of time predicates. */ - predicates: JqlQueryClauseTimePredicate[]; -} diff --git a/src/version2/models/functionOperand.ts b/src/version2/models/functionOperand.ts deleted file mode 100644 index 9110746b76..0000000000 --- a/src/version2/models/functionOperand.ts +++ /dev/null @@ -1,12 +0,0 @@ -/** - * An operand that is a function. See [Advanced searching - functions - * reference](https://confluence.atlassian.com/x/dwiiLQ) for more information about JQL functions. - */ -export interface FunctionOperand { - /** The list of function arguments. */ - arguments: string[]; - /** Encoded operand, which can be used directly in a JQL query. */ - encodedOperand?: string; - /** The name of the function. */ - function: string; -} diff --git a/src/version2/models/globalScope.ts b/src/version2/models/globalScope.ts index 20b0c607d3..6f3e1c1fbe 100644 --- a/src/version2/models/globalScope.ts +++ b/src/version2/models/globalScope.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link GlobalScope} instead. */ -export type GlobalScopeBean = GlobalScope; - export interface GlobalScope { /** * Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the diff --git a/src/version2/models/healthCheckResult.ts b/src/version2/models/healthCheckResult.ts deleted file mode 100644 index cf96a3c898..0000000000 --- a/src/version2/models/healthCheckResult.ts +++ /dev/null @@ -1,9 +0,0 @@ -/** @deprecated Jira instance health check results. Deprecated and no longer returned. */ -export interface HealthCheckResult { - /** The description of the Jira health check item. */ - description?: string; - /** The name of the Jira health check item. */ - name?: string; - /** Whether the Jira health check item passed or failed. */ - passed?: boolean; -} diff --git a/src/version2/models/hierarchy.ts b/src/version2/models/hierarchy.ts index 52abd63451..96fa6cdd4f 100644 --- a/src/version2/models/hierarchy.ts +++ b/src/version2/models/hierarchy.ts @@ -2,12 +2,6 @@ import { HierarchyLevel } from './hierarchyLevel'; /** The project issue type hierarchy. */ export interface Hierarchy { - /** - * The ID of the base level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from - * next-gen - * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - */ - baseLevelId?: number; /** Details about the hierarchy level. */ levels?: HierarchyLevel[]; } diff --git a/src/version2/models/hierarchyLevel.ts b/src/version2/models/hierarchyLevel.ts index e988df4515..2eb191fb3d 100644 --- a/src/version2/models/hierarchyLevel.ts +++ b/src/version2/models/hierarchyLevel.ts @@ -1,39 +1,9 @@ export interface HierarchyLevel { - /** - * The ID of the hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from - * next-gen - * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - */ - id?: number; /** The name of this hierarchy level. */ name?: string; - /** - * The ID of the level above this one in the hierarchy. This property is deprecated, see [Change notice: Removing - * hierarchy level IDs from next-gen - * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - */ - aboveLevelId?: number; - /** - * The ID of the level below this one in the hierarchy. This property is deprecated, see [Change notice: Removing - * hierarchy level IDs from next-gen - * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - */ - belowLevelId?: number; - /** - * The ID of the project configuration. This property is deprecated, see [Change oticen: Removing hierarchy level IDs - * from next-gen - * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - */ - projectConfigurationId?: number; /** The level of this item in the hierarchy. */ level?: number; /** The issue types available in this hierarchy level. */ issueTypeIds?: number[]; - /** - * The external UUID of the hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level - * IDs from next-gen - * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - */ - externalUuid?: string; globalHierarchyLevel?: string; } diff --git a/src/version2/models/icon.ts b/src/version2/models/icon.ts index b565585e37..1968bf19ca 100644 --- a/src/version2/models/icon.ts +++ b/src/version2/models/icon.ts @@ -1,6 +1,3 @@ -/** @deprecated Please use {@link Icon} type. */ -export type IconBean = Icon; - /** * An icon. If no icon is defined: * diff --git a/src/version2/models/id.ts b/src/version2/models/id.ts index 42330309af..3507d539c1 100644 --- a/src/version2/models/id.ts +++ b/src/version2/models/id.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link Id} instead. */ -export type IdBean = Id; - export interface Id { /** * The ID of the permission scheme to associate with the project. Use the [Get all permission diff --git a/src/version2/models/idOrKey.ts b/src/version2/models/idOrKey.ts index be73fcba06..1d5fc03ee9 100644 --- a/src/version2/models/idOrKey.ts +++ b/src/version2/models/idOrKey.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link IdOrKey} instead. */ -export type IdOrKeyBean = IdOrKey; - export interface IdOrKey { /** The ID of the referenced item. */ id?: number; diff --git a/src/version2/models/index.ts b/src/version2/models/index.ts index f919287b7a..63f87a2208 100644 --- a/src/version2/models/index.ts +++ b/src/version2/models/index.ts @@ -2,7 +2,6 @@ export * from './actorInput'; export * from './actorsMap'; export * from './addField'; export * from './addGroup'; -export * from './addNotificationsDetails'; export * from './addSecuritySchemeLevelsRequest'; export * from './announcementBannerConfiguration'; export * from './announcementBannerConfigurationUpdate'; @@ -12,7 +11,6 @@ export * from './applicationRole'; export * from './associatedItem'; export * from './associateFieldConfigurationsWithIssueTypesRequest'; export * from './attachment'; -export * from './attachmentArchive'; export * from './attachmentArchiveEntry'; export * from './attachmentArchiveImpl'; export * from './attachmentArchiveItemReadable'; @@ -33,8 +31,8 @@ export * from './availableWorkflowTriggerTypes'; export * from './avatar'; export * from './avatars'; export * from './avatarUrls'; +export * from './avatarWithDetails'; export * from './bulkChangeOwnerDetails'; -export * from './bulkCreateCustomFieldOptionRequest'; export * from './bulkCustomFieldOptionCreateRequest'; export * from './bulkCustomFieldOptionUpdateRequest'; export * from './bulkEditShareableEntity'; @@ -52,10 +50,8 @@ export * from './changedWorklogs'; export * from './changelog'; export * from './columnItem'; export * from './comment'; -export * from './component'; export * from './componentIssuesCount'; export * from './componentWithIssueCount'; -export * from './compoundClause'; export * from './conditionGroupConfiguration'; export * from './conditionGroupUpdate'; export * from './configuration'; @@ -68,14 +64,12 @@ export * from './containerForProjectFeatures'; export * from './containerForRegisteredWebhooks'; export * from './containerForWebhookIDs'; export * from './containerOfWorkflowSchemeAssociations'; -export * from './context'; export * from './contextForProjectAndIssueType'; export * from './contextualConfiguration'; export * from './convertedJQLQueries'; export * from './createCustomFieldContext'; export * from './createdIssue'; export * from './createdIssues'; -export * from './createIssueAdjustmentDetails'; export * from './createIssueSecuritySchemeDetails'; export * from './createNotificationSchemeDetails'; export * from './createPriorityDetails'; @@ -94,9 +88,6 @@ export * from './customContextVariable'; export * from './customFieldConfigurations'; export * from './customFieldContext'; export * from './customFieldContextDefaultValue'; -export * from './customFieldContextDefaultValueCascadingOption'; -export * from './customFieldContextDefaultValueMultipleOption'; -export * from './customFieldContextDefaultValueSingleOption'; export * from './customFieldContextDefaultValueUpdate'; export * from './customFieldContextOption'; export * from './customFieldContextProjectMapping'; @@ -105,9 +96,7 @@ export * from './customFieldCreatedContextOptionsList'; export * from './customFieldDefinitionJson'; export * from './customFieldOption'; export * from './customFieldOptionCreate'; -export * from './customFieldOptionDetails'; export * from './customFieldOptionUpdate'; -export * from './customFieldOptionValue'; export * from './customFieldReplacement'; export * from './customFieldUpdatedContextOptionsList'; export * from './customFieldValueUpdate'; @@ -124,21 +113,17 @@ export * from './dateRangeFilter'; export * from './defaultLevelValue'; export * from './defaultShareScope'; export * from './defaultWorkflow'; -export * from './deleteAndReplaceVersion'; -export * from './deprecatedWorkflow'; export * from './documentVersion'; export * from './entityProperty'; export * from './entityPropertyDetails'; export * from './error'; export * from './errorCollection'; -export * from './errorMessage'; export * from './errors'; export * from './eventNotification'; export * from './exportArchivedIssuesTaskProgress'; export * from './failedWebhook'; export * from './failedWebhooks'; export * from './field'; -export * from './fieldChangedClause'; export * from './fieldConfiguration'; export * from './fieldConfigurationDetails'; export * from './fieldConfigurationIssueTypeItem'; @@ -153,9 +138,6 @@ export * from './fieldLastUsed'; export * from './fieldMetadata'; export * from './fieldReferenceData'; export * from './fields'; -export * from './fieldUpdateOperation'; -export * from './fieldValueClause'; -export * from './fieldWasClause'; export * from './filter'; export * from './filterDetails'; export * from './filterSubscription'; @@ -165,14 +147,12 @@ export * from './foundGroup'; export * from './foundGroups'; export * from './foundUsers'; export * from './foundUsersAndGroups'; -export * from './functionOperand'; export * from './functionReferenceData'; export * from './globalScope'; export * from './group'; export * from './groupDetails'; export * from './groupLabel'; export * from './groupName'; -export * from './healthCheckResult'; export * from './hierarchy'; export * from './hierarchyLevel'; export * from './historyMetadata'; @@ -182,9 +162,6 @@ export * from './id'; export * from './idOrKey'; export * from './includedFields'; export * from './issue'; -export * from './issueAdjustmentContextDetails'; -export * from './issueAdjustmentDetails'; -export * from './issueAdjustmentIdentifiers'; export * from './issueArchivalSync'; export * from './issueChangelogIds'; export * from './issueCommentListRequest'; @@ -266,26 +243,20 @@ export * from './jqlQueriesToParse'; export * from './jqlQueriesToSanitize'; export * from './jqlQuery'; export * from './jqlQueryClause'; -export * from './jqlQueryClauseOperand'; -export * from './jqlQueryClauseTimePredicate'; export * from './jqlQueryField'; export * from './jqlQueryFieldEntityProperty'; export * from './jqlQueryOrderByClause'; export * from './jqlQueryOrderByClauseElement'; export * from './jqlQueryToSanitize'; -export * from './jqlQueryUnitaryOperand'; export * from './jQLQueryWithUnknownUsers'; export * from './jQLReferenceData'; -export * from './jsonNode'; export * from './jsonType'; -export * from './keywordOperand'; export * from './license'; export * from './licensedApplication'; export * from './licenseMetric'; export * from './linkedIssue'; export * from './linkGroup'; export * from './linkIssueRequestJson'; -export * from './listOperand'; export * from './listWrapperCallbackApplicationRole'; export * from './listWrapperCallbackGroupName'; export * from './locale'; @@ -315,14 +286,12 @@ export * from './orderOfIssueTypes'; export * from './pageChangelog'; export * from './pageComment'; export * from './pageComponentWithIssueCount'; -export * from './pageContext'; export * from './pageContextForProjectAndIssueType'; export * from './pageContextualConfiguration'; export * from './pageCustomFieldContext'; export * from './pageCustomFieldContextDefaultValue'; export * from './pageCustomFieldContextOption'; export * from './pageCustomFieldContextProjectMapping'; -export * from './pageCustomFieldOptionDetails'; export * from './pageDashboard'; export * from './pagedListUserDetailsApplicationUser'; export * from './pageField'; @@ -333,7 +302,6 @@ export * from './pageFieldConfigurationScheme'; export * from './pageFieldConfigurationSchemeProjects'; export * from './pageFilterDetails'; export * from './pageGroupDetails'; -export * from './pageIssueAdjustmentDetails'; export * from './pageIssueFieldOption'; export * from './pageIssueSecurityLevelMember'; export * from './pageIssueSecuritySchemeToProjectMapping'; @@ -371,7 +339,6 @@ export * from './pageWebhook'; export * from './pageWorkflow'; export * from './pageWorkflowScheme'; export * from './pageWorkflowTransitionRules'; -export * from './paginatedResponseComment'; export * from './parsedJqlQueries'; export * from './parsedJqlQuery'; export * from './permissionDetails'; @@ -393,7 +360,6 @@ export * from './projectComponent'; export * from './projectDetails'; export * from './projectEmailAddress'; export * from './projectFeature'; -export * from './projectFeatures'; export * from './projectFeatureToggleRequest'; export * from './projectId'; export * from './projectIdentifier'; @@ -418,16 +384,12 @@ export * from './projectScope'; export * from './projectType'; export * from './propertyKey'; export * from './propertyKeys'; -export * from './publishDraftWorkflowScheme'; export * from './publishedWorkflowId'; export * from './registeredWebhook'; export * from './remoteIssueLink'; export * from './remoteIssueLinkIdentifies'; export * from './remoteIssueLinkRequest'; export * from './remoteObject'; -export * from './removeOptionFromIssuesResult'; -export * from './renamedCascadingOption'; -export * from './renamedOption'; export * from './reorderIssuePriorities'; export * from './reorderIssueResolutionsRequest'; export * from './resolution'; @@ -449,7 +411,6 @@ export * from './screenSchemeId'; export * from './screenTypes'; export * from './screenWithTab'; export * from './searchAutoComplete'; -export * from './searchAutoCompleteFilter'; export * from './searchRequest'; export * from './searchResults'; export * from './securityLevel'; @@ -468,7 +429,6 @@ export * from './setDefaultResolutionRequest'; export * from './sharePermission'; export * from './sharePermissionInput'; export * from './simpleApplicationProperty'; -export * from './simpleErrorCollection'; export * from './simpleLink'; export * from './simpleListWrapperApplicationRole'; export * from './simpleListWrapperGroupName'; @@ -485,12 +445,10 @@ export * from './statusReferenceAndPort'; export * from './statusScope'; export * from './statusUpdate'; export * from './statusUpdateRequest'; -export * from './stringList'; export * from './suggestedIssue'; export * from './systemAvatars'; export * from './tabMetadata'; export * from './taskProgressObject'; -export * from './taskProgressRemoveOptionFromIssuesResult'; export * from './timeTrackingConfiguration'; export * from './timeTrackingDetails'; export * from './timeTrackingProvider'; @@ -503,11 +461,8 @@ export * from './uiModificationDetails'; export * from './uiModificationIdentifiers'; export * from './unrestrictedUserEmail'; export * from './updateCustomFieldDetails'; -export * from './updateCustomFieldOption'; -export * from './updateDefaultScreenScheme'; export * from './updatedProjectCategory'; export * from './updateFieldConfigurationSchemeDetails'; -export * from './updateIssueAdjustmentDetails'; export * from './updateIssueSecurityLevelDetails'; export * from './updateIssueSecuritySchemeRequest'; export * from './updateNotificationSchemeDetails'; @@ -522,15 +477,12 @@ export * from './updateUserToGroup'; export * from './user'; export * from './userAvatarUrls'; export * from './userDetails'; -export * from './userFilter'; export * from './userKey'; export * from './userList'; export * from './userMigration'; -export * from './userPermission'; export * from './userPickerUser'; export * from './validationOptionsForCreate'; export * from './validationOptionsForUpdate'; -export * from './valueOperand'; export * from './version'; export * from './versionIssueCounts'; export * from './versionIssuesStatus'; @@ -547,7 +499,6 @@ export * from './webhookRegistrationDetails'; export * from './webhooksExpirationDate'; export * from './workflow'; export * from './workflowCapabilities'; -export * from './workflowCompoundCondition'; export * from './workflowCondition'; export * from './workflowCreate'; export * from './workflowCreateRequest'; @@ -567,7 +518,6 @@ export * from './workflowSchemeAssociations'; export * from './workflowSchemeIdName'; export * from './workflowSchemeProjectAssociation'; export * from './workflowScope'; -export * from './workflowSimpleCondition'; export * from './workflowStatus'; export * from './workflowStatusAndPort'; export * from './workflowStatusLayout'; diff --git a/src/version2/models/issue.ts b/src/version2/models/issue.ts index f62866c9f5..0841e19347 100644 --- a/src/version2/models/issue.ts +++ b/src/version2/models/issue.ts @@ -5,9 +5,6 @@ import { IssueUpdateMetadata } from './issueUpdateMetadata'; import { Operations } from './operations'; import { PageOfChangelogs } from './pageOfChangelogs'; -/** @deprecated Use {@link Issue} instead. */ -export type IssueBean = Issue; - /** Details about an issue. */ export interface Issue { /** Expand options that include additional issue details in the response. */ diff --git a/src/version2/models/issueAdjustmentContextDetails.ts b/src/version2/models/issueAdjustmentContextDetails.ts deleted file mode 100644 index a2e2898b85..0000000000 --- a/src/version2/models/issueAdjustmentContextDetails.ts +++ /dev/null @@ -1,13 +0,0 @@ -/** The details of an issue adjustment's context, which define where to activate the issue adjustment. */ -export interface IssueAdjustmentContextDetails { - /** The ID of the issue adjustment context. */ - id?: string; - /** The project ID of the context. */ - projectId: string; - /** The issue type ID of the context. */ - issueTypeId: string; - /** The view type of the context. Only `GIC` (Global Issue Create) is supported. */ - viewType: string; - /** Whether a context is available. For example, when a project is deleted the context becomes unavailable. */ - isAvailable?: boolean; -} diff --git a/src/version2/models/issueAdjustmentDetails.ts b/src/version2/models/issueAdjustmentDetails.ts deleted file mode 100644 index b70c9fbfd6..0000000000 --- a/src/version2/models/issueAdjustmentDetails.ts +++ /dev/null @@ -1,17 +0,0 @@ -import { IssueAdjustmentContextDetails } from './issueAdjustmentContextDetails'; - -/** The details of an issue adjustment. */ -export interface IssueAdjustmentDetails { - /** The ID of the issue adjustment. */ - id: string; - /** The name of the issue adjustment. The maximum length is 255 characters. */ - name: string; - /** The description of the issue adjustment. The maximum length is 255 characters. */ - description?: string; - /** The URL of the issue adjustment. */ - self: string; - /** The data of the issue adjustment. The maximum size of the data is 50000 characters. */ - data?: string; - /** List of contexts of the issue adjustment. The maximum number of contexts is 1000. */ - contexts?: IssueAdjustmentContextDetails[]; -} diff --git a/src/version2/models/issueAdjustmentIdentifiers.ts b/src/version2/models/issueAdjustmentIdentifiers.ts deleted file mode 100644 index c64c2e0c0c..0000000000 --- a/src/version2/models/issueAdjustmentIdentifiers.ts +++ /dev/null @@ -1,7 +0,0 @@ -/** Identifiers for an issue adjustment. */ -export interface IssueAdjustmentIdentifiers { - /** The ID of the issue adjustment. */ - id: string; - /** The URL of the issue adjustment. */ - self: string; -} diff --git a/src/version2/models/issueCommentListRequest.ts b/src/version2/models/issueCommentListRequest.ts index 10dd330212..3a3aae0cd3 100644 --- a/src/version2/models/issueCommentListRequest.ts +++ b/src/version2/models/issueCommentListRequest.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link IssueCommentListRequest} instead. */ -export type IssueCommentListRequestBean = IssueCommentListRequest; - export interface IssueCommentListRequest { /** The list of comment IDs. A maximum of 1000 IDs can be specified. */ ids: number[]; diff --git a/src/version2/models/issueFieldOptionConfiguration.ts b/src/version2/models/issueFieldOptionConfiguration.ts index 0c5ccb00a1..c1c8dfbbb6 100644 --- a/src/version2/models/issueFieldOptionConfiguration.ts +++ b/src/version2/models/issueFieldOptionConfiguration.ts @@ -2,7 +2,5 @@ import { IssueFieldOptionScope } from './issueFieldOptionScope'; /** Details of the projects the option is available in. */ export interface IssueFieldOptionConfiguration { - /** @deprecated */ - attributes?: string[]; scope?: IssueFieldOptionScope; } diff --git a/src/version2/models/issueFieldOptionCreate.ts b/src/version2/models/issueFieldOptionCreate.ts index 5a02dba496..3bbcfb9f90 100644 --- a/src/version2/models/issueFieldOptionCreate.ts +++ b/src/version2/models/issueFieldOptionCreate.ts @@ -1,8 +1,5 @@ import { IssueFieldOptionConfiguration } from './issueFieldOptionConfiguration'; -/** @deprecated Use {@link IssueFieldOptionCreate} instead. */ -export type IssueFieldOptionCreateBean = IssueFieldOptionCreate; - export interface IssueFieldOptionCreate { config?: IssueFieldOptionConfiguration; /** diff --git a/src/version2/models/issueFieldOptionScope.ts b/src/version2/models/issueFieldOptionScope.ts index d28691d5ad..176147201c 100644 --- a/src/version2/models/issueFieldOptionScope.ts +++ b/src/version2/models/issueFieldOptionScope.ts @@ -1,13 +1,8 @@ import { GlobalScope } from './globalScope'; import { ProjectScope } from './projectScope'; -/** @deprecated Use {@link IssueFieldOptionScope} instead. */ -export type IssueFieldOptionScopeBean = IssueFieldOptionScope; - export interface IssueFieldOptionScope { global?: GlobalScope; - /** @deprecated */ - projects?: number[]; /** * Defines the projects in which the option is available and the behavior of the option within each project. Specify * one object per project. The behavior of the option in a project context overrides the behavior in the global diff --git a/src/version2/models/issueTypeCreate.ts b/src/version2/models/issueTypeCreate.ts index 522ea65141..46e78dee25 100644 --- a/src/version2/models/issueTypeCreate.ts +++ b/src/version2/models/issueTypeCreate.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link IssueTypeCreate} instead. */ -export type IssueTypeCreateBean = IssueTypeCreate; - export interface IssueTypeCreate { /** The description of the issue type. */ description?: string; @@ -14,10 +11,4 @@ export interface IssueTypeCreate { hierarchyLevel?: number; /** The unique name for the issue type. The maximum length is 60 characters. */ name: string; - /** - * @deprecated Use `hierarchyLevel` instead. See the [deprecation - * notice](https://community.developer.atlassian.com/t/deprecation-of-the-epic-link-parent-link-and-other-related-fields-in-rest-apis-and-webhooks/54048) - * for details. Whether the issue type is `subtype` or `standard`. Defaults to `standard`. - */ - type?: 'subtype' | 'standard' | string; } diff --git a/src/version2/models/issueTypeUpdate.ts b/src/version2/models/issueTypeUpdate.ts index b5d877cf84..989759bb78 100644 --- a/src/version2/models/issueTypeUpdate.ts +++ b/src/version2/models/issueTypeUpdate.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link IssueTypeUpdate} instead. */ -export type IssueTypeUpdateBean = IssueTypeUpdate; - export interface IssueTypeUpdate { /** The ID of an issue type avatar. */ avatarId?: number; diff --git a/src/version2/models/issuesJqlMetaData.ts b/src/version2/models/issuesJqlMetaData.ts index 7626d4bbed..35e4987b75 100644 --- a/src/version2/models/issuesJqlMetaData.ts +++ b/src/version2/models/issuesJqlMetaData.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link IssuesJqlMetaData} instead. */ -export type IssuesJqlMetaDataBean = IssuesJqlMetaData; - /** The description of the page of issues loaded by the provided JQL query. */ export interface IssuesJqlMetaData { /** The number of issues that were loaded in this evaluation. */ diff --git a/src/version2/models/issuesMeta.ts b/src/version2/models/issuesMeta.ts index d5c2bffd0f..6158728196 100644 --- a/src/version2/models/issuesMeta.ts +++ b/src/version2/models/issuesMeta.ts @@ -1,8 +1,5 @@ import { IssuesJqlMetaData } from './issuesJqlMetaData'; -/** @deprecated Use {@link IssuesMeta} instead. */ -export type IssuesMetaBean = IssuesMeta; - /** Meta data describing the `issues` context variable. */ export interface IssuesMeta { jql?: IssuesJqlMetaData; diff --git a/src/version2/models/issuesUpdate.ts b/src/version2/models/issuesUpdate.ts index 1f878f4dcc..57cb9b2bf8 100644 --- a/src/version2/models/issuesUpdate.ts +++ b/src/version2/models/issuesUpdate.ts @@ -1,8 +1,5 @@ import { IssueUpdateDetails } from './issueUpdateDetails'; -/** @deprecated Use {@link IssuesUpdate} instead. */ -export type IssuesUpdateBean = IssuesUpdate; - export interface IssuesUpdate { issueUpdates?: IssueUpdateDetails[]; } diff --git a/src/version2/models/jiraExpressionEvalContext.ts b/src/version2/models/jiraExpressionEvalContext.ts index 5f80713a95..8d044506c0 100644 --- a/src/version2/models/jiraExpressionEvalContext.ts +++ b/src/version2/models/jiraExpressionEvalContext.ts @@ -2,9 +2,6 @@ import { CustomContextVariable } from './customContextVariable'; import { IdOrKey } from './idOrKey'; import { JexpIssues } from './jexpIssues'; -/** @deprecated Use {@link JiraExpressionEvalContext} instead. */ -export type JiraExpressionEvalContextBean = JiraExpressionEvalContext; - export interface JiraExpressionEvalContext { /** The ID of the board that is available under the `board` variable when evaluating the expression. */ board?: number; diff --git a/src/version2/models/jiraExpressionEvalRequest.ts b/src/version2/models/jiraExpressionEvalRequest.ts index a5828e67b8..b6aedff147 100644 --- a/src/version2/models/jiraExpressionEvalRequest.ts +++ b/src/version2/models/jiraExpressionEvalRequest.ts @@ -1,8 +1,5 @@ import { JiraExpressionEvalContext } from './jiraExpressionEvalContext'; -/** @deprecated Use {@link JiraExpressionEvalRequest} instead. */ -export type JiraExpressionEvalRequestBean = JiraExpressionEvalRequest; - export interface JiraExpressionEvalRequest { context?: JiraExpressionEvalContext; /** The Jira expression to evaluate. */ diff --git a/src/version2/models/jiraExpressionEvaluationMetaData.ts b/src/version2/models/jiraExpressionEvaluationMetaData.ts index f4706ef69f..aba849f5d7 100644 --- a/src/version2/models/jiraExpressionEvaluationMetaData.ts +++ b/src/version2/models/jiraExpressionEvaluationMetaData.ts @@ -1,9 +1,6 @@ import { IssuesMeta } from './issuesMeta'; import { JiraExpressionsComplexity } from './jiraExpressionsComplexity'; -/** @deprecated Use {@link JiraExpressionEvaluationMetaData} instead. */ -export type JiraExpressionEvaluationMetaDataBean = JiraExpressionEvaluationMetaData; - export interface JiraExpressionEvaluationMetaData { complexity?: JiraExpressionsComplexity; issues?: IssuesMeta; diff --git a/src/version2/models/jiraExpressionsComplexity.ts b/src/version2/models/jiraExpressionsComplexity.ts index e17e7b6ebf..3dfc524719 100644 --- a/src/version2/models/jiraExpressionsComplexity.ts +++ b/src/version2/models/jiraExpressionsComplexity.ts @@ -1,8 +1,5 @@ import { JiraExpressionsComplexityValue } from './jiraExpressionsComplexityValue'; -/** @deprecated Use {@link JiraExpressionsComplexity} instead. */ -export type JiraExpressionsComplexityBean = JiraExpressionsComplexity; - export interface JiraExpressionsComplexity { steps?: JiraExpressionsComplexityValue; expensiveOperations?: JiraExpressionsComplexityValue; diff --git a/src/version2/models/jiraExpressionsComplexityValue.ts b/src/version2/models/jiraExpressionsComplexityValue.ts index 70f69c7941..3157f941b0 100644 --- a/src/version2/models/jiraExpressionsComplexityValue.ts +++ b/src/version2/models/jiraExpressionsComplexityValue.ts @@ -1,6 +1,3 @@ -/** @deprecated Use JiraExpressionsComplexityValue instead. */ -export type JiraExpressionsComplexityValueBean = JiraExpressionsComplexityValue; - export interface JiraExpressionsComplexityValue { /** The maximum allowed complexity. The evaluation will fail if this value is exceeded. */ limit: number; diff --git a/src/version2/models/jqlQueryClauseOperand.ts b/src/version2/models/jqlQueryClauseOperand.ts deleted file mode 100644 index a36b3d3711..0000000000 --- a/src/version2/models/jqlQueryClauseOperand.ts +++ /dev/null @@ -1,2 +0,0 @@ -/** Details of an operand in a JQL clause. */ -export interface JqlQueryClauseOperand {} diff --git a/src/version2/models/jqlQueryClauseTimePredicate.ts b/src/version2/models/jqlQueryClauseTimePredicate.ts deleted file mode 100644 index 2ca8750c69..0000000000 --- a/src/version2/models/jqlQueryClauseTimePredicate.ts +++ /dev/null @@ -1,8 +0,0 @@ -import { JqlQueryClauseOperand } from './jqlQueryClauseOperand'; - -/** A time predicate for a temporal JQL clause. */ -export interface JqlQueryClauseTimePredicate { - operand: JqlQueryClauseOperand; - /** The operator between the field and the operand. */ - operator: string; -} diff --git a/src/version2/models/jqlQueryUnitaryOperand.ts b/src/version2/models/jqlQueryUnitaryOperand.ts deleted file mode 100644 index 1812693776..0000000000 --- a/src/version2/models/jqlQueryUnitaryOperand.ts +++ /dev/null @@ -1,2 +0,0 @@ -/** An operand that can be part of a list operand. */ -export interface JqlQueryUnitaryOperand {} diff --git a/src/version2/models/jsonNode.ts b/src/version2/models/jsonNode.ts deleted file mode 100644 index 089c7cc100..0000000000 --- a/src/version2/models/jsonNode.ts +++ /dev/null @@ -1,38 +0,0 @@ -export interface JsonNode { - array?: boolean; - bigDecimal?: boolean; - bigInteger?: boolean; - bigIntegerValue?: number; - binary?: boolean; - binaryValue?: string[]; - boolean?: boolean; - booleanValue?: boolean; - containerNode?: boolean; - decimalValue?: number; - double?: boolean; - doubleValue?: number; - elements?: {}; - fieldNames?: {}; - fields?: {}; - floatingPointNumber?: boolean; - int?: boolean; - intValue?: number; - integralNumber?: boolean; - long?: boolean; - longValue?: number; - missingNode?: boolean; - null?: boolean; - number?: boolean; - numberType?: string; - numberValue?: number; - object?: boolean; - pojo?: boolean; - textValue?: string; - textual?: boolean; - valueAsBoolean?: boolean; - valueAsDouble?: number; - valueAsInt?: number; - valueAsLong?: number; - valueAsText?: string; - valueNode?: boolean; -} diff --git a/src/version2/models/jsonType.ts b/src/version2/models/jsonType.ts index 5c8d983892..2ab70a13fc 100644 --- a/src/version2/models/jsonType.ts +++ b/src/version2/models/jsonType.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link JsonType} instead. */ -export type JsonTypeBean = JsonType; - /** The schema of a field. */ export interface JsonType { /** If the field is a custom field, the configuration of the field. */ diff --git a/src/version2/models/keywordOperand.ts b/src/version2/models/keywordOperand.ts deleted file mode 100644 index 8262c240b0..0000000000 --- a/src/version2/models/keywordOperand.ts +++ /dev/null @@ -1,9 +0,0 @@ -/** - * An operand that is a JQL keyword. See [Advanced searching - keywords - * reference](https://confluence.atlassian.com/jiracorecloud/advanced-searching-keywords-reference-765593717.html#Advancedsearching-keywordsreference-EMPTYEMPTY) - * for more information about operand keywords. - */ -export interface KeywordOperand { - /** The keyword that is the operand value. */ - keyword: string; -} diff --git a/src/version2/models/linkIssueRequestJson.ts b/src/version2/models/linkIssueRequestJson.ts index c3c887f29a..d2f8c731e3 100644 --- a/src/version2/models/linkIssueRequestJson.ts +++ b/src/version2/models/linkIssueRequestJson.ts @@ -2,9 +2,6 @@ import { Comment } from './comment'; import { IssueLinkType } from './issueLinkType'; import { LinkedIssue } from './linkedIssue'; -/** @deprecated Use {@link LinkIssueRequestJson} instead. */ -export type LinkIssueRequestJsonBean = LinkIssueRequestJson; - export interface LinkIssueRequestJson { comment?: Comment; inwardIssue: LinkedIssue; diff --git a/src/version2/models/listOperand.ts b/src/version2/models/listOperand.ts deleted file mode 100644 index 5006ebb59b..0000000000 --- a/src/version2/models/listOperand.ts +++ /dev/null @@ -1,9 +0,0 @@ -import { JqlQueryUnitaryOperand } from './jqlQueryUnitaryOperand'; - -/** An operand that is a list of values. */ -export interface ListOperand { - /** Encoded operand, which can be used directly in a JQL query. */ - encodedOperand?: string; - /** The list of operand values. */ - values: JqlQueryUnitaryOperand[]; -} diff --git a/src/version2/models/moveField.ts b/src/version2/models/moveField.ts index b2867250d9..2402f43f45 100644 --- a/src/version2/models/moveField.ts +++ b/src/version2/models/moveField.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link MoveField} instead. */ -export type MoveFieldBean = MoveField; - export interface MoveField { /** * The ID of the screen tab field after which to place the moved screen tab field. Required if `position` isn't diff --git a/src/version2/models/newUserDetails.ts b/src/version2/models/newUserDetails.ts index 8b8b071d36..a6908343c8 100644 --- a/src/version2/models/newUserDetails.ts +++ b/src/version2/models/newUserDetails.ts @@ -1,12 +1,5 @@ /** The user details. */ export interface NewUserDetails { - /** @deprecated Do not use. */ - applicationKeys?: string[]; - /** - * @deprecated This property is no longer available. If the user has an Atlassian account, their display name is not - * changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account. - */ - displayName?: string; /** The email address for the user. */ emailAddress: string; /** diff --git a/src/version2/models/pageChangelog.ts b/src/version2/models/pageChangelog.ts index 1f014659e1..a753d1a8af 100644 --- a/src/version2/models/pageChangelog.ts +++ b/src/version2/models/pageChangelog.ts @@ -1,8 +1,5 @@ import { Changelog } from './changelog'; -/** @deprecated Use {@link PageChangelog} instead. */ -export type PageBeanChangelog = PageChangelog; - /** A page of items. */ export interface PageChangelog { /** Whether this is the last page. */ diff --git a/src/version2/models/pageComment.ts b/src/version2/models/pageComment.ts index 8a50a13c7c..23f429ea60 100644 --- a/src/version2/models/pageComment.ts +++ b/src/version2/models/pageComment.ts @@ -1,8 +1,5 @@ import { Comment } from './comment'; -/** @deprecated Use {@link PageComment} instead. */ -export type PageBeanComment = PageComment; - /** A page of items. */ export interface PageComment { /** Whether this is the last page. */ diff --git a/src/version2/models/pageComponentWithIssueCount.ts b/src/version2/models/pageComponentWithIssueCount.ts index f697e332c5..ef5d0ac564 100644 --- a/src/version2/models/pageComponentWithIssueCount.ts +++ b/src/version2/models/pageComponentWithIssueCount.ts @@ -1,8 +1,5 @@ import { ComponentWithIssueCount } from './componentWithIssueCount'; -/** @deprecated Use {@link PageComponentWithIssueCount} instead. */ -export type PageBeanComponentWithIssueCount = PageComponentWithIssueCount; - /** A page of items. */ export interface PageComponentWithIssueCount { /** Whether this is the last page. */ diff --git a/src/version2/models/pageContext.ts b/src/version2/models/pageContext.ts deleted file mode 100644 index 97d7cc3da1..0000000000 --- a/src/version2/models/pageContext.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { Context } from './context'; - -/** @deprecated Use {@link PageContext} instead. */ -export type PageBeanContext = PageContext; - -/** A page of items. */ -export interface PageContext { - /** Whether this is the last page. */ - isLast?: boolean; - /** The maximum number of items that could be returned. */ - maxResults?: number; - /** If there is another page of results, the URL of the next page. */ - nextPage?: string; - /** The URL of the page. */ - self?: string; - /** The index of the first item returned. */ - startAt?: number; - /** The number of items returned. */ - total?: number; - /** The list of items. */ - values?: Context[]; -} diff --git a/src/version2/models/pageContextForProjectAndIssueType.ts b/src/version2/models/pageContextForProjectAndIssueType.ts index 342552b3eb..055630fbac 100644 --- a/src/version2/models/pageContextForProjectAndIssueType.ts +++ b/src/version2/models/pageContextForProjectAndIssueType.ts @@ -1,8 +1,5 @@ import { ContextForProjectAndIssueType } from './contextForProjectAndIssueType'; -/** @deprecated Use {@link PageContextForProjectAndIssueType} instead. */ -export type PageBeanContextForProjectAndIssueType = PageContextForProjectAndIssueType; - /** A page of items. */ export interface PageContextForProjectAndIssueType { /** Whether this is the last page. */ diff --git a/src/version2/models/pageCustomFieldContext.ts b/src/version2/models/pageCustomFieldContext.ts index 3ed98987fd..e4499fb059 100644 --- a/src/version2/models/pageCustomFieldContext.ts +++ b/src/version2/models/pageCustomFieldContext.ts @@ -1,8 +1,5 @@ import { CustomFieldContext } from './customFieldContext'; -/** @deprecated Use {@link PageCustomFieldContext} instead. */ -export type PageBeanCustomFieldContext = PageCustomFieldContext; - /** A page of items. */ export interface PageCustomFieldContext { /** Whether this is the last page. */ diff --git a/src/version2/models/pageCustomFieldContextDefaultValue.ts b/src/version2/models/pageCustomFieldContextDefaultValue.ts index afebf7853a..86eb403dbb 100644 --- a/src/version2/models/pageCustomFieldContextDefaultValue.ts +++ b/src/version2/models/pageCustomFieldContextDefaultValue.ts @@ -1,8 +1,5 @@ import { CustomFieldContextDefaultValue } from './customFieldContextDefaultValue'; -/** @deprecated Use {@link PageCustomFieldContextDefaultValue} instead. */ -export type PageBeanCustomFieldContextDefaultValue = PageCustomFieldContextDefaultValue; - /** A page of items. */ export interface PageCustomFieldContextDefaultValue { /** Whether this is the last page. */ diff --git a/src/version2/models/pageCustomFieldContextOption.ts b/src/version2/models/pageCustomFieldContextOption.ts index e0dbcc24a8..ad5700b73b 100644 --- a/src/version2/models/pageCustomFieldContextOption.ts +++ b/src/version2/models/pageCustomFieldContextOption.ts @@ -1,8 +1,5 @@ import { CustomFieldContextOption } from './customFieldContextOption'; -/** @deprecated Use {@link PageCustomFieldContextOption} instead. */ -export type PageBeanCustomFieldContextOption = PageCustomFieldContextOption; - /** A page of items. */ export interface PageCustomFieldContextOption { /** Whether this is the last page. */ diff --git a/src/version2/models/pageCustomFieldContextProjectMapping.ts b/src/version2/models/pageCustomFieldContextProjectMapping.ts index 31cf150c46..2047e82c7d 100644 --- a/src/version2/models/pageCustomFieldContextProjectMapping.ts +++ b/src/version2/models/pageCustomFieldContextProjectMapping.ts @@ -1,8 +1,5 @@ import { CustomFieldContextProjectMapping } from './customFieldContextProjectMapping'; -/** @deprecated Use {@link PageCustomFieldContextProjectMapping} instead. */ -export type PageBeanCustomFieldContextProjectMapping = PageCustomFieldContextProjectMapping; - /** A page of items. */ export interface PageCustomFieldContextProjectMapping { /** Whether this is the last page. */ diff --git a/src/version2/models/pageCustomFieldOptionDetails.ts b/src/version2/models/pageCustomFieldOptionDetails.ts deleted file mode 100644 index c91ddf1d3d..0000000000 --- a/src/version2/models/pageCustomFieldOptionDetails.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { CustomFieldOptionDetails } from './customFieldOptionDetails'; - -/** @deprecated Use {@link PageCustomFieldOptionDetails} instead. */ -export type PageBeanCustomFieldOptionDetails = PageCustomFieldOptionDetails; - -/** A page of items. */ -export interface PageCustomFieldOptionDetails { - /** The URL of the page. */ - self?: string; - /** If there is another page of results, the URL of the next page. */ - nextPage?: string; - /** The maximum number of items that could be returned. */ - maxResults?: number; - /** The index of the first item returned. */ - startAt?: number; - /** The number of items returned. */ - total?: number; - /** Whether this is the last page. */ - isLast?: boolean; - /** The list of items. */ - values?: CustomFieldOptionDetails[]; -} diff --git a/src/version2/models/pageDashboard.ts b/src/version2/models/pageDashboard.ts index 02d457a369..29308bef79 100644 --- a/src/version2/models/pageDashboard.ts +++ b/src/version2/models/pageDashboard.ts @@ -1,8 +1,5 @@ import { Dashboard } from './dashboard'; -/** @deprecated Use {@link PageDashboard} instead. */ -export type PageBeanDashboard = PageDashboard; - /** A page of items. */ export interface PageDashboard { /** Whether this is the last page. */ diff --git a/src/version2/models/pageField.ts b/src/version2/models/pageField.ts index 5a06986b19..ef8afebc7a 100644 --- a/src/version2/models/pageField.ts +++ b/src/version2/models/pageField.ts @@ -1,8 +1,5 @@ import { Field } from './field'; -/** @deprecated Use {@link PageField} instead. */ -export type PageBeanField = PageField; - /** A page of items. */ export interface PageField { /** Whether this is the last page. */ diff --git a/src/version2/models/pageFieldConfiguration.ts b/src/version2/models/pageFieldConfiguration.ts index 5e225f316b..4bac790f8e 100644 --- a/src/version2/models/pageFieldConfiguration.ts +++ b/src/version2/models/pageFieldConfiguration.ts @@ -1,8 +1,5 @@ import { FieldConfiguration } from './fieldConfiguration'; -/** @deprecated Use {@link PageFieldConfiguration} instead. */ -export type PageBeanFieldConfiguration = PageFieldConfiguration; - /** A page of items. */ export interface PageFieldConfiguration { /** The URL of the page. */ diff --git a/src/version2/models/pageFieldConfigurationIssueTypeItem.ts b/src/version2/models/pageFieldConfigurationIssueTypeItem.ts index b9a16782b5..5ef3234475 100644 --- a/src/version2/models/pageFieldConfigurationIssueTypeItem.ts +++ b/src/version2/models/pageFieldConfigurationIssueTypeItem.ts @@ -1,8 +1,5 @@ import { FieldConfigurationIssueTypeItem } from './fieldConfigurationIssueTypeItem'; -/** @deprecated Use {@link PageFieldConfigurationIssueTypeItem} instead. */ -export type PageBeanFieldConfigurationIssueTypeItem = PageFieldConfigurationIssueTypeItem; - /** A page of items. */ export interface PageFieldConfigurationIssueTypeItem { /** Whether this is the last page. */ diff --git a/src/version2/models/pageFieldConfigurationItem.ts b/src/version2/models/pageFieldConfigurationItem.ts index 90b3b0e5c4..ab15f465c8 100644 --- a/src/version2/models/pageFieldConfigurationItem.ts +++ b/src/version2/models/pageFieldConfigurationItem.ts @@ -1,8 +1,5 @@ import { FieldConfigurationItem } from './fieldConfigurationItem'; -/** @deprecated Use {@link PageFieldConfigurationItem} instead. */ -export type PageBeanFieldConfigurationItem = PageFieldConfigurationItem; - /** A page of items. */ export interface PageFieldConfigurationItem { /** Whether this is the last page. */ diff --git a/src/version2/models/pageFieldConfigurationScheme.ts b/src/version2/models/pageFieldConfigurationScheme.ts index 10327b6996..6f102460d3 100644 --- a/src/version2/models/pageFieldConfigurationScheme.ts +++ b/src/version2/models/pageFieldConfigurationScheme.ts @@ -1,8 +1,5 @@ import { FieldConfigurationScheme } from './fieldConfigurationScheme'; -/** @deprecated Use {@link PageFieldConfigurationScheme} instead. */ -export type PageBeanFieldConfigurationScheme = PageFieldConfigurationScheme; - /** A page of items. */ export interface PageFieldConfigurationScheme { /** Whether this is the last page. */ diff --git a/src/version2/models/pageFieldConfigurationSchemeProjects.ts b/src/version2/models/pageFieldConfigurationSchemeProjects.ts index 785a31e631..689efe9304 100644 --- a/src/version2/models/pageFieldConfigurationSchemeProjects.ts +++ b/src/version2/models/pageFieldConfigurationSchemeProjects.ts @@ -1,8 +1,5 @@ import { FieldConfigurationSchemeProjects } from './fieldConfigurationSchemeProjects'; -/** @deprecated Use {@link PageFieldConfigurationSchemeProjects} instead. */ -export type PageBeanFieldConfigurationSchemeProjects = PageFieldConfigurationSchemeProjects; - /** A page of items. */ export interface PageFieldConfigurationSchemeProjects { /** Whether this is the last page. */ diff --git a/src/version2/models/pageFilterDetails.ts b/src/version2/models/pageFilterDetails.ts index f4b5d25a70..a076d86c88 100644 --- a/src/version2/models/pageFilterDetails.ts +++ b/src/version2/models/pageFilterDetails.ts @@ -1,8 +1,5 @@ import { FilterDetails } from './filterDetails'; -/** @deprecated Use {@link PageFilterDetails} instead. */ -export type PageBeanFilterDetails = PageFilterDetails; - /** A page of items. */ export interface PageFilterDetails { /** Whether this is the last page. */ diff --git a/src/version2/models/pageGroupDetails.ts b/src/version2/models/pageGroupDetails.ts index a834f44a2e..0acf0eca07 100644 --- a/src/version2/models/pageGroupDetails.ts +++ b/src/version2/models/pageGroupDetails.ts @@ -1,8 +1,5 @@ import { GroupDetails } from './groupDetails'; -/** @deprecated Use {@link PageGroupDetails} instead. */ -export type PageBeanGroupDetails = PageGroupDetails; - /** A page of items. */ export interface PageGroupDetails { /** Whether this is the last page. */ diff --git a/src/version2/models/pageIssueAdjustmentDetails.ts b/src/version2/models/pageIssueAdjustmentDetails.ts deleted file mode 100644 index fc23aeeaea..0000000000 --- a/src/version2/models/pageIssueAdjustmentDetails.ts +++ /dev/null @@ -1,19 +0,0 @@ -import { IssueAdjustmentDetails } from './issueAdjustmentDetails'; - -/** A page of items. */ -export interface PageIssueAdjustmentDetails { - /** The URL of the page. */ - self?: string; - /** If there is another page of results, the URL of the next page. */ - nextPage?: string; - /** The maximum number of items that could be returned. */ - maxResults?: number; - /** The index of the first item returned. */ - startAt?: number; - /** The number of items returned. */ - total?: number; - /** Whether this is the last page. */ - isLast?: boolean; - /** The list of items. */ - values?: IssueAdjustmentDetails[]; -} diff --git a/src/version2/models/pageIssueFieldOption.ts b/src/version2/models/pageIssueFieldOption.ts index 1b746c3d0a..21e3c95558 100644 --- a/src/version2/models/pageIssueFieldOption.ts +++ b/src/version2/models/pageIssueFieldOption.ts @@ -1,8 +1,5 @@ import { IssueFieldOption } from './issueFieldOption'; -/** @deprecated Use {@link PageIssueFieldOption} instead. */ -export type PageBeanIssueFieldOption = PageIssueFieldOption; - /** A page of items. */ export interface PageIssueFieldOption { /** Whether this is the last page. */ diff --git a/src/version2/models/pageIssueSecurityLevelMember.ts b/src/version2/models/pageIssueSecurityLevelMember.ts index cd0b69a692..5c4bcae18e 100644 --- a/src/version2/models/pageIssueSecurityLevelMember.ts +++ b/src/version2/models/pageIssueSecurityLevelMember.ts @@ -1,8 +1,5 @@ import { IssueSecurityLevelMember } from './issueSecurityLevelMember'; -/** @deprecated Use {@link PageIssueSecurityLevelMember} instead. */ -export type PageBeanIssueSecurityLevelMember = PageIssueSecurityLevelMember; - /** A page of items. */ export interface PageIssueSecurityLevelMember { /** Whether this is the last page. */ diff --git a/src/version2/models/pageIssueTypeScheme.ts b/src/version2/models/pageIssueTypeScheme.ts index 9c5b04595d..c5278a5d8c 100644 --- a/src/version2/models/pageIssueTypeScheme.ts +++ b/src/version2/models/pageIssueTypeScheme.ts @@ -1,8 +1,5 @@ import { IssueTypeScheme } from './issueTypeScheme'; -/** @deprecated Use {@link PageIssueTypeScheme} instead. */ -export type PageBeanIssueTypeScheme = PageIssueTypeScheme; - /** A page of items. */ export interface PageIssueTypeScheme { /** Whether this is the last page. */ diff --git a/src/version2/models/pageIssueTypeSchemeMapping.ts b/src/version2/models/pageIssueTypeSchemeMapping.ts index a145c8d546..98bd0b065f 100644 --- a/src/version2/models/pageIssueTypeSchemeMapping.ts +++ b/src/version2/models/pageIssueTypeSchemeMapping.ts @@ -1,8 +1,5 @@ import { IssueTypeSchemeMapping } from './issueTypeSchemeMapping'; -/** @deprecated Use {@link PageIssueTypeSchemeMapping} instead. */ -export type PageBeanIssueTypeSchemeMapping = PageIssueTypeSchemeMapping; - /** A page of items. */ export interface PageIssueTypeSchemeMapping { /** Whether this is the last page. */ diff --git a/src/version2/models/pageIssueTypeSchemeProjects.ts b/src/version2/models/pageIssueTypeSchemeProjects.ts index 54589aed5f..04193eb916 100644 --- a/src/version2/models/pageIssueTypeSchemeProjects.ts +++ b/src/version2/models/pageIssueTypeSchemeProjects.ts @@ -1,8 +1,5 @@ import { IssueTypeSchemeProjects } from './issueTypeSchemeProjects'; -/** @deprecated Use {@link PageIssueTypeSchemeProjects} instead. */ -export type PageBeanIssueTypeSchemeProjects = PageIssueTypeSchemeProjects; - /** A page of items. */ export interface PageIssueTypeSchemeProjects { /** Whether this is the last page. */ diff --git a/src/version2/models/pageIssueTypeScreenScheme.ts b/src/version2/models/pageIssueTypeScreenScheme.ts index 1ca132bad0..efceb76530 100644 --- a/src/version2/models/pageIssueTypeScreenScheme.ts +++ b/src/version2/models/pageIssueTypeScreenScheme.ts @@ -1,8 +1,5 @@ import { IssueTypeScreenScheme } from './issueTypeScreenScheme'; -/** @deprecated Use {@link PageIssueTypeScreenScheme} instead. */ -export type PageBeanIssueTypeScreenScheme = PageIssueTypeScreenScheme; - /** A page of items. */ export interface PageIssueTypeScreenScheme { /** Whether this is the last page. */ diff --git a/src/version2/models/pageIssueTypeScreenSchemeItem.ts b/src/version2/models/pageIssueTypeScreenSchemeItem.ts index 34163ed2cd..bca94e0421 100644 --- a/src/version2/models/pageIssueTypeScreenSchemeItem.ts +++ b/src/version2/models/pageIssueTypeScreenSchemeItem.ts @@ -1,8 +1,5 @@ import { IssueTypeScreenSchemeItem } from './issueTypeScreenSchemeItem'; -/** @deprecated Use {@link PageIssueTypeScreenSchemeItem} instead. */ -export type PageBeanIssueTypeScreenSchemeItem = PageIssueTypeScreenSchemeItem; - /** A page of items. */ export interface PageIssueTypeScreenSchemeItem { /** Whether this is the last page. */ diff --git a/src/version2/models/pageIssueTypeScreenSchemesProjects.ts b/src/version2/models/pageIssueTypeScreenSchemesProjects.ts index 241dd77acb..b610f12b7f 100644 --- a/src/version2/models/pageIssueTypeScreenSchemesProjects.ts +++ b/src/version2/models/pageIssueTypeScreenSchemesProjects.ts @@ -1,8 +1,5 @@ import { IssueTypeScreenSchemesProjects } from './issueTypeScreenSchemesProjects'; -/** @deprecated Use {@link PageIssueTypeScreenSchemesProjects} instead. */ -export type PageBeanIssueTypeScreenSchemesProjects = PageIssueTypeScreenSchemesProjects; - /** A page of items. */ export interface PageIssueTypeScreenSchemesProjects { /** Whether this is the last page. */ diff --git a/src/version2/models/pageIssueTypeToContextMapping.ts b/src/version2/models/pageIssueTypeToContextMapping.ts index 0ce3e233e7..dba1d84f5a 100644 --- a/src/version2/models/pageIssueTypeToContextMapping.ts +++ b/src/version2/models/pageIssueTypeToContextMapping.ts @@ -1,8 +1,5 @@ import { IssueTypeToContextMapping } from './issueTypeToContextMapping'; -/** @deprecated Use {@link PageIssueTypeToContextMapping} instead. */ -export type PageBeanIssueTypeToContextMapping = PageIssueTypeToContextMapping; - /** A page of items. */ export interface PageIssueTypeToContextMapping { /** Whether this is the last page. */ diff --git a/src/version2/models/pageNotificationScheme.ts b/src/version2/models/pageNotificationScheme.ts index 02c248a3f8..e8cbb5c1e5 100644 --- a/src/version2/models/pageNotificationScheme.ts +++ b/src/version2/models/pageNotificationScheme.ts @@ -1,8 +1,5 @@ import { NotificationScheme } from './notificationScheme'; -/** @deprecated Use {@link PageNotificationScheme} instead. */ -export type PageBeanNotificationScheme = PageNotificationScheme; - /** A page of items. */ export interface PageNotificationScheme { /** Whether this is the last page. */ diff --git a/src/version2/models/pageProject.ts b/src/version2/models/pageProject.ts index 74b05c5bde..e9327c76b2 100644 --- a/src/version2/models/pageProject.ts +++ b/src/version2/models/pageProject.ts @@ -1,8 +1,5 @@ import { Project } from './project'; -/** @deprecated Use {@link PageProject} instead. */ -export type PageBeanProject = PageProject; - /** A page of items. */ export interface PageProject { /** Whether this is the last page. */ @@ -18,5 +15,5 @@ export interface PageProject { /** The number of items returned. */ total?: number; /** The list of items. */ - values?: Project[]; + values: Project[]; } diff --git a/src/version2/models/pageScreen.ts b/src/version2/models/pageScreen.ts index ea221db8b8..d1e381cd8b 100644 --- a/src/version2/models/pageScreen.ts +++ b/src/version2/models/pageScreen.ts @@ -1,8 +1,5 @@ import { Screen } from './screen'; -/** @deprecated Use {@link PageScreen} instead. */ -export type PageBeanScreen = PageScreen; - /** A page of items. */ export interface PageScreen { /** Whether this is the last page. */ diff --git a/src/version2/models/pageScreenScheme.ts b/src/version2/models/pageScreenScheme.ts index ad18d0645c..924af96948 100644 --- a/src/version2/models/pageScreenScheme.ts +++ b/src/version2/models/pageScreenScheme.ts @@ -1,8 +1,5 @@ import { ScreenScheme } from './screenScheme'; -/** @deprecated Use {@link PageScreenScheme} instead. */ -export type PageBeanScreenScheme = PageScreenScheme; - /** A page of items. */ export interface PageScreenScheme { /** Whether this is the last page. */ diff --git a/src/version2/models/pageScreenWithTab.ts b/src/version2/models/pageScreenWithTab.ts index 7dafc9f8ea..8d9c234746 100644 --- a/src/version2/models/pageScreenWithTab.ts +++ b/src/version2/models/pageScreenWithTab.ts @@ -1,8 +1,5 @@ import { ScreenWithTab } from './screenWithTab'; -/** @deprecated Use {@link PageScreenWithTab} instead. */ -export type PageBeanScreenWithTab = PageScreenWithTab; - /** A page of items. */ export interface PageScreenWithTab { /** Whether this is the last page. */ diff --git a/src/version2/models/pageString.ts b/src/version2/models/pageString.ts index 7b28a2fac9..f4ec2eca43 100644 --- a/src/version2/models/pageString.ts +++ b/src/version2/models/pageString.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link PageString} instead. */ -export type PageBeanString = PageString; - /** A page of items. */ export interface PageString { /** Whether this is the last page. */ diff --git a/src/version2/models/pageUser.ts b/src/version2/models/pageUser.ts index 8fa816e1f2..0486b7ed1d 100644 --- a/src/version2/models/pageUser.ts +++ b/src/version2/models/pageUser.ts @@ -1,8 +1,5 @@ import { User } from './user'; -/** @deprecated Use {@link PageUser} instead. */ -export type PageBeanUser = PageUser; - /** A page of items. */ export interface PageUser { /** Whether this is the last page. */ diff --git a/src/version2/models/pageUserDetails.ts b/src/version2/models/pageUserDetails.ts index 59b7665301..e6456227e1 100644 --- a/src/version2/models/pageUserDetails.ts +++ b/src/version2/models/pageUserDetails.ts @@ -1,8 +1,5 @@ import { UserDetails } from './userDetails'; -/** @deprecated Use {@link PageUserDetails} instead. */ -export type PageBeanUserDetails = PageUserDetails; - /** A page of items. */ export interface PageUserDetails { /** Whether this is the last page. */ diff --git a/src/version2/models/pageUserKey.ts b/src/version2/models/pageUserKey.ts index 3bfb7745fa..d591323570 100644 --- a/src/version2/models/pageUserKey.ts +++ b/src/version2/models/pageUserKey.ts @@ -1,8 +1,5 @@ import { UserKey } from './userKey'; -/** @deprecated Use {@link PageUserKey} instead. */ -export type PageBeanUserKey = PageUserKey; - /** A page of items. */ export interface PageUserKey { /** Whether this is the last page. */ diff --git a/src/version2/models/pageVersion.ts b/src/version2/models/pageVersion.ts index ce94f25211..2226565274 100644 --- a/src/version2/models/pageVersion.ts +++ b/src/version2/models/pageVersion.ts @@ -1,8 +1,5 @@ import { Version } from './version'; -/** @deprecated Use {@link PageVersion} instead. */ -export type PageBeanVersion = PageVersion; - /** A page of items. */ export interface PageVersion { /** Whether this is the last page. */ diff --git a/src/version2/models/pageWebhook.ts b/src/version2/models/pageWebhook.ts index 46ae217010..7a77edfb67 100644 --- a/src/version2/models/pageWebhook.ts +++ b/src/version2/models/pageWebhook.ts @@ -1,8 +1,5 @@ import { Webhook } from './webhook'; -/** @deprecated Use {@link PageWebhook} instead. */ -export type PageBeanWebhook = PageWebhook; - /** A page of items. */ export interface PageWebhook { /** Whether this is the last page. */ diff --git a/src/version2/models/pageWorkflow.ts b/src/version2/models/pageWorkflow.ts index 79f27f9325..60ab409322 100644 --- a/src/version2/models/pageWorkflow.ts +++ b/src/version2/models/pageWorkflow.ts @@ -1,8 +1,5 @@ import { Workflow } from './workflow'; -/** @deprecated Use {@link PageWorkflow} instead. */ -export type PageBeanWorkflow = PageWorkflow; - /** A page of items. */ export interface PageWorkflow { /** Whether this is the last page. */ diff --git a/src/version2/models/pageWorkflowScheme.ts b/src/version2/models/pageWorkflowScheme.ts index 288f823b08..44431297bc 100644 --- a/src/version2/models/pageWorkflowScheme.ts +++ b/src/version2/models/pageWorkflowScheme.ts @@ -1,8 +1,5 @@ import { WorkflowScheme } from './workflowScheme'; -/** @deprecated Use {@link PageWorkflowScheme} instead. */ -export type PageBeanWorkflowScheme = PageWorkflowScheme; - /** A page of items. */ export interface PageWorkflowScheme { /** Whether this is the last page. */ diff --git a/src/version2/models/pageWorkflowTransitionRules.ts b/src/version2/models/pageWorkflowTransitionRules.ts index 31590a613a..4daab20c37 100644 --- a/src/version2/models/pageWorkflowTransitionRules.ts +++ b/src/version2/models/pageWorkflowTransitionRules.ts @@ -1,8 +1,5 @@ import { WorkflowTransitionRules } from './workflowTransitionRules'; -/** @deprecated Use {@link PageWorkflowTransitionRules} instead. */ -export type PageBeanWorkflowTransitionRules = PageWorkflowTransitionRules; - /** A page of items. */ export interface PageWorkflowTransitionRules { /** Whether this is the last page. */ diff --git a/src/version2/models/paginatedResponseComment.ts b/src/version2/models/paginatedResponseComment.ts deleted file mode 100644 index f8aba6db01..0000000000 --- a/src/version2/models/paginatedResponseComment.ts +++ /dev/null @@ -1,8 +0,0 @@ -import { Comment } from './comment'; - -export interface PaginatedResponseComment { - maxResults?: number; - results?: Comment[]; - startAt?: number; - total?: number; -} diff --git a/src/version2/models/permissionsKeys.ts b/src/version2/models/permissionsKeys.ts index 116846fcbc..3fc65387c3 100644 --- a/src/version2/models/permissionsKeys.ts +++ b/src/version2/models/permissionsKeys.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link PermissionsKeys} instead. */ -export type PermissionsKeysBean = PermissionsKeys; - export interface PermissionsKeys { /** A list of permission keys. */ permissions: string[]; diff --git a/src/version2/models/projectFeatures.ts b/src/version2/models/projectFeatures.ts deleted file mode 100644 index 943a2e74c4..0000000000 --- a/src/version2/models/projectFeatures.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { ProjectFeature } from './projectFeature'; - -/** @deprecated Use {@link ContainerForProjectFeatures}. Container for the list of features on the project. */ -export interface ProjectFeatures { - /** The list of features on the project. */ - features?: ProjectFeature[]; -} diff --git a/src/version2/models/projectFeaturesResponse.ts b/src/version2/models/projectFeaturesResponse.ts deleted file mode 100644 index 8c94a18469..0000000000 --- a/src/version2/models/projectFeaturesResponse.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { ProjectFeature } from './projectFeature'; - -/** Container for the list of features on the project. */ -export interface ProjectFeaturesResponse { - /** The list of features on the project. */ - features?: ProjectFeature[]; -} diff --git a/src/version2/models/projectForScope.ts b/src/version2/models/projectForScope.ts deleted file mode 100644 index 72ed182897..0000000000 --- a/src/version2/models/projectForScope.ts +++ /dev/null @@ -1,24 +0,0 @@ -import { AvatarUrls } from './avatarUrls'; -import { UpdatedProjectCategory } from './updatedProjectCategory'; - -/** Details about a next-gen project. */ -export interface ProjectForScope { - /** The URL of the project details. */ - self?: string; - /** The ID of the project. */ - id?: string; - /** The key of the project. */ - key?: string; - /** The name of the project. */ - name?: string; - /** - * The [project - * type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the - * project. - */ - projectTypeKey?: string; - /** Whether or not the project is simplified. */ - simplified?: boolean; - avatarUrls?: AvatarUrls; - projectCategory?: UpdatedProjectCategory; -} diff --git a/src/version2/models/projectIdentifier.ts b/src/version2/models/projectIdentifier.ts index 69a532fd3c..1a0c6852a1 100644 --- a/src/version2/models/projectIdentifier.ts +++ b/src/version2/models/projectIdentifier.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link ProjectIdentifier} instead. */ -export type ProjectIdentifierBean = ProjectIdentifier; - /** The identifiers for a project. */ export interface ProjectIdentifier { /** The ID of the project. */ diff --git a/src/version2/models/projectInput.ts b/src/version2/models/projectInput.ts deleted file mode 100644 index a46d822491..0000000000 --- a/src/version2/models/projectInput.ts +++ /dev/null @@ -1,67 +0,0 @@ -/** @deprecated Use {@link ProjectInput} instead. */ -export type ProjectInputBean = ProjectInput; - -/** @deprecated This model divided to {@link UpdateProjectDetails} and {@link CreateProjectDetails}. */ -export interface ProjectInput { - /** - * 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. Required when creating a project. Optional when updating a - * project. - */ - key?: string; - /** The name of the project. Required when creating a project. Optional when updating a project. */ - name?: string; - /** - * The [project - * type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes), which - * dictates the application-specific feature set. Required when creating a project. Not applicable for the Update - * project resource. - */ - projectTypeKey?: string; - /** - * A prebuilt configuration for a project. The type of the `projectTemplateKey` must match with the type of the - * `projectTypeKey`. Required when creating a project. Not applicable for the Update project resource. - */ - projectTemplateKey?: string; - /** A brief description of the project. */ - description?: string; - /** - * This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The user name of the project lead. Either `lead` or `leadAccountId` must be set when creating a - * project. Optional when updating a project. Cannot be provided with `leadAccountId`. - */ - lead?: string; - /** - * The account ID of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Optional - * when updating a project. 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 - * scheme IDs. - */ - issueSecurityScheme?: 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. - */ - 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 project's category. A complete list of category IDs is found using the [Get all project - * categories](#api-rest-api-2-projectCategory-get) operation. - */ - categoryId?: number; -} diff --git a/src/version2/models/projectIssueTypesHierarchyLevel.ts b/src/version2/models/projectIssueTypesHierarchyLevel.ts index c3e693bb55..b1d1aef657 100644 --- a/src/version2/models/projectIssueTypesHierarchyLevel.ts +++ b/src/version2/models/projectIssueTypesHierarchyLevel.ts @@ -2,12 +2,6 @@ import { IssueTypeInfo } from './issueTypeInfo'; /** Details of an issue type hierarchy level. */ export interface ProjectIssueTypesHierarchyLevel { - /** - * @deprecated The ID of the issue type hierarchy level. This property is deprecated, see [Change notice: Removing - * hierarchy level IDs from next-gen - * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - */ - entityId?: string; /** The list of issue types in the hierarchy level. */ issueTypes?: IssueTypeInfo[]; /** The level of the issue type hierarchy level. */ diff --git a/src/version2/models/projectRoleActorsUpdate.ts b/src/version2/models/projectRoleActorsUpdate.ts index e96aa1ec18..5e3b9ca632 100644 --- a/src/version2/models/projectRoleActorsUpdate.ts +++ b/src/version2/models/projectRoleActorsUpdate.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link ProjectRoleActorsUpdate} instead. */ -export type ProjectRoleActorsUpdateBean = ProjectRoleActorsUpdate; - export interface ProjectRoleActorsUpdate { /** * The ID of the project role. Use [Get all project roles](#api-rest-api-2-role-get) to get a list of project role diff --git a/src/version2/models/projectScope.ts b/src/version2/models/projectScope.ts index e7e4b43969..cd4f9d4140 100644 --- a/src/version2/models/projectScope.ts +++ b/src/version2/models/projectScope.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link ProjectScope} instead. */ -export type ProjectScopeBean = ProjectScope; - export interface ProjectScope { /** * Defines the behavior of the option in the project.If notSelectable is set, the option cannot be set as the field's diff --git a/src/version2/models/publishDraftWorkflowScheme.ts b/src/version2/models/publishDraftWorkflowScheme.ts deleted file mode 100644 index 13a785c311..0000000000 --- a/src/version2/models/publishDraftWorkflowScheme.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { StatusMapping } from './statusMapping'; - -/** Details about the status mappings for publishing a draft workflow scheme. */ -export interface PublishDraftWorkflowScheme { - /** Mappings of statuses to new statuses for issue types. */ - statusMappings?: StatusMapping[]; -} diff --git a/src/version2/models/removeOptionFromIssuesResult.ts b/src/version2/models/removeOptionFromIssuesResult.ts deleted file mode 100644 index cf18ad7c2f..0000000000 --- a/src/version2/models/removeOptionFromIssuesResult.ts +++ /dev/null @@ -1,9 +0,0 @@ -import { SimpleErrorCollection } from './simpleErrorCollection'; - -export interface RemoveOptionFromIssuesResult { - errors?: SimpleErrorCollection; - /** The IDs of the modified issues. */ - modifiedIssues?: number[]; - /** The IDs of the unchanged issues, those issues where errors prevent modification. */ - unmodifiedIssues?: number[]; -} diff --git a/src/version2/models/renamedCascadingOption.ts b/src/version2/models/renamedCascadingOption.ts deleted file mode 100644 index 31d76a3223..0000000000 --- a/src/version2/models/renamedCascadingOption.ts +++ /dev/null @@ -1,7 +0,0 @@ -/** Details of a custom field cascading option to rename. */ -export interface RenamedCascadingOption { - /** The value of the cascading option. */ - value: string; - /** The new value of the cascading option. */ - newValue: string; -} diff --git a/src/version2/models/renamedOption.ts b/src/version2/models/renamedOption.ts deleted file mode 100644 index 0e415d653d..0000000000 --- a/src/version2/models/renamedOption.ts +++ /dev/null @@ -1,11 +0,0 @@ -import { RenamedCascadingOption } from './renamedCascadingOption'; - -/** Details of a custom field option to rename. */ -export interface RenamedOption { - /** The current option value. */ - value: string; - /** The new value of the option. */ - newValue: string; - /** The new values for the cascading options of this option. Only used for Select List (cascading) fields. */ - cascadingOptions?: RenamedCascadingOption[]; -} diff --git a/src/version2/models/screenID.ts b/src/version2/models/screenID.ts deleted file mode 100644 index 4e8aa99bc3..0000000000 --- a/src/version2/models/screenID.ts +++ /dev/null @@ -1,5 +0,0 @@ -/** @deprecated ID of a screen. */ -export interface ScreenID { - /** The ID of the screen. */ - id: string; -} diff --git a/src/version2/models/searchAutoCompleteFilter.ts b/src/version2/models/searchAutoCompleteFilter.ts deleted file mode 100644 index 05f16e5b6b..0000000000 --- a/src/version2/models/searchAutoCompleteFilter.ts +++ /dev/null @@ -1,7 +0,0 @@ -/** Details of how to filter and list search auto complete information. */ -export interface SearchAutoCompleteFilter { - /** Include collapsed fields for fields that have non-unique names. */ - includeCollapsedFields?: boolean; - /** List of project IDs used to filter the visible field details returned. */ - projectIds?: number[]; -} diff --git a/src/version2/models/searchRequest.ts b/src/version2/models/searchRequest.ts index cb4bb1e104..7385840872 100644 --- a/src/version2/models/searchRequest.ts +++ b/src/version2/models/searchRequest.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link SearchRequest} instead. */ -export type SearchRequestBean = SearchRequest; - export interface SearchRequest { /** A [JQL](https://confluence.atlassian.com/x/egORLQ) expression. */ jql?: string; diff --git a/src/version2/models/serverInformation.ts b/src/version2/models/serverInformation.ts index bd7c3bb1c5..4dd6bd88fa 100644 --- a/src/version2/models/serverInformation.ts +++ b/src/version2/models/serverInformation.ts @@ -1,5 +1,3 @@ -import { HealthCheckResult } from './healthCheckResult'; - /** Details about the Jira instance. */ export interface ServerInformation { /** The base URL of the Jira instance. */ @@ -10,8 +8,6 @@ export interface ServerInformation { buildNumber?: number; /** The type of server deployment. This is always returned as _Cloud_. */ deploymentType?: string; - /** Jira instance health check results. Deprecated and no longer returned. */ - healthChecks?: HealthCheckResult[]; /** The unique identifier of the Jira version. */ scmInfo?: string; /** The time in Jira when this request was responded to. */ diff --git a/src/version2/models/simpleApplicationProperty.ts b/src/version2/models/simpleApplicationProperty.ts index 7ad028ec04..98827ffd3b 100644 --- a/src/version2/models/simpleApplicationProperty.ts +++ b/src/version2/models/simpleApplicationProperty.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link SimpleApplicationProperty} instead. */ -export type SimpleApplicationPropertyBean = SimpleApplicationProperty; - export interface SimpleApplicationProperty { /** The ID of the application property. */ id?: string; diff --git a/src/version2/models/simpleErrorCollection.ts b/src/version2/models/simpleErrorCollection.ts deleted file mode 100644 index d3920e1594..0000000000 --- a/src/version2/models/simpleErrorCollection.ts +++ /dev/null @@ -1,10 +0,0 @@ -export interface SimpleErrorCollection { - /** The list of error messages produced by this operation. For example, "input parameter 'key' must be provided" */ - errorMessages?: string[]; - /** - * The list of errors by parameter returned by the operation. For example,"projectKey": "Project keys must start with - * an uppercase letter, followed by one or more uppercase alphanumeric characters." - */ - errors?: {}; - httpStatusCode?: number; -} diff --git a/src/version2/models/stringList.ts b/src/version2/models/stringList.ts deleted file mode 100644 index 1a49a7f9a1..0000000000 --- a/src/version2/models/stringList.ts +++ /dev/null @@ -1 +0,0 @@ -export interface StringList {} diff --git a/src/version2/models/taskProgressObject.ts b/src/version2/models/taskProgressObject.ts index 06eeda38e2..944caffe8d 100644 --- a/src/version2/models/taskProgressObject.ts +++ b/src/version2/models/taskProgressObject.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link TaskProgressObject} instead. */ -export type TaskProgressBeanObject = TaskProgressObject; - /** Details about a task. */ export interface TaskProgressObject { /** The description of the task. */ diff --git a/src/version2/models/taskProgressRemoveOptionFromIssuesResult.ts b/src/version2/models/taskProgressRemoveOptionFromIssuesResult.ts deleted file mode 100644 index 41e9ad8c16..0000000000 --- a/src/version2/models/taskProgressRemoveOptionFromIssuesResult.ts +++ /dev/null @@ -1,33 +0,0 @@ -import { RemoveOptionFromIssuesResult } from './removeOptionFromIssuesResult'; - -/** @deprecated Use {@link TaskProgressRemoveOptionFromIssuesResult} instead. */ -export type TaskProgressBeanRemoveOptionFromIssuesResult = TaskProgressRemoveOptionFromIssuesResult; - -/** Details about a task. */ -export interface TaskProgressRemoveOptionFromIssuesResult { - /** The description of the task. */ - description?: string; - /** The execution time of the task, in milliseconds. */ - elapsedRuntime: number; - /** A timestamp recording when the task was finished. */ - finished?: number; - /** The ID of the task. */ - id: string; - /** A timestamp recording when the task progress was last updated. */ - lastUpdate: number; - /** Information about the progress of the task. */ - message?: string; - /** The progress of the task, as a percentage complete. */ - progress: number; - result?: RemoveOptionFromIssuesResult; - /** The URL of the task. */ - self: string; - /** A timestamp recording when the task was started. */ - started?: number; - /** The status of the task. */ - status: string; - /** A timestamp recording when the task was submitted. */ - submitted: number; - /** The ID of the user who submitted the task. */ - submittedBy: number; -} diff --git a/src/version2/models/updateCustomFieldOption.ts b/src/version2/models/updateCustomFieldOption.ts deleted file mode 100644 index 3f69a0d102..0000000000 --- a/src/version2/models/updateCustomFieldOption.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { RenamedOption } from './renamedOption'; - -/** Details of the options to update for a custom field. */ -export interface UpdateCustomFieldOption { - /** Details of the options to update. */ - options?: RenamedOption[]; -} diff --git a/src/version2/models/updateDefaultScreenScheme.ts b/src/version2/models/updateDefaultScreenScheme.ts deleted file mode 100644 index fb40becb7d..0000000000 --- a/src/version2/models/updateDefaultScreenScheme.ts +++ /dev/null @@ -1,5 +0,0 @@ -/** The ID of a screen scheme. */ -export interface UpdateDefaultScreenScheme { - /** The ID of the screen scheme. */ - screenSchemeId: string; -} diff --git a/src/version2/models/updateIssueAdjustmentDetails.ts b/src/version2/models/updateIssueAdjustmentDetails.ts deleted file mode 100644 index 52f5d26942..0000000000 --- a/src/version2/models/updateIssueAdjustmentDetails.ts +++ /dev/null @@ -1,16 +0,0 @@ -import { IssueAdjustmentContextDetails } from './issueAdjustmentContextDetails'; - -/** The details of an issue adjustment. */ -export interface UpdateIssueAdjustmentDetails { - /** The name of the issue adjustment. The maximum length is 255 characters. */ - name?: string; - /** The description of the issue adjustment. The maximum length is 255 characters. */ - description?: string; - /** The data of the issue adjustment. The maximum size of the data is 50000 characters. */ - data?: string; - /** - * List of contexts of the issue adjustment. The maximum number of contexts is 1000. If provided, replaces all - * existing contexts. - */ - contexts?: IssueAdjustmentContextDetails[]; -} diff --git a/src/version2/models/updateProjectDetails.ts b/src/version2/models/updateProjectDetails.ts index 285d417df6..c042c8d57a 100644 --- a/src/version2/models/updateProjectDetails.ts +++ b/src/version2/models/updateProjectDetails.ts @@ -23,14 +23,8 @@ export interface UpdateProjectDetails { * characters. The maximum length is 10 characters. */ key?: string; - /** - * This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The user name of the project lead. Cannot be provided with `leadAccountId`. - */ - lead?: string; /** The account ID of the project lead. Cannot be provided with `lead`. */ - leadAccountId?: string; + leadAccountId: string; /** The name of the project. */ name?: string; /** diff --git a/src/version2/models/updateUserToGroup.ts b/src/version2/models/updateUserToGroup.ts index 7f0a8bded2..3d52246c60 100644 --- a/src/version2/models/updateUserToGroup.ts +++ b/src/version2/models/updateUserToGroup.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link UpdateUserToGroup} instead. */ -export type UpdateUserToGroupBean = UpdateUserToGroup; - export interface UpdateUserToGroup { /** * The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, diff --git a/src/version2/models/userAvatarUrls.ts b/src/version2/models/userAvatarUrls.ts index 501874002f..e59b51f113 100644 --- a/src/version2/models/userAvatarUrls.ts +++ b/src/version2/models/userAvatarUrls.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link UserAvatarUrls} instead. */ -export type UserBeanAvatarUrls = UserAvatarUrls; - export interface UserAvatarUrls { /** The URL of the user's 16x16 pixel avatar. */ '16x16'?: string; diff --git a/src/version2/models/userFilter.ts b/src/version2/models/userFilter.ts deleted file mode 100644 index c03f5f8336..0000000000 --- a/src/version2/models/userFilter.ts +++ /dev/null @@ -1,15 +0,0 @@ -/** Filter for a User Picker (single) custom field. */ -export interface UserFilter { - /** Whether the filter is enabled. */ - enabled: boolean; - /** - * User groups autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum - * of 10 groups can be provided. - */ - groups?: string[]; - /** - * Roles that autocomplete suggestion users must belong to. If not provided, the default values are used. A maximum of - * 10 roles can be provided. - */ - roleIds?: number[]; -} diff --git a/src/version2/models/userMigration.ts b/src/version2/models/userMigration.ts index ca864fa95c..3797c69592 100644 --- a/src/version2/models/userMigration.ts +++ b/src/version2/models/userMigration.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link UserMigration} instead. */ -export type UserMigrationBean = UserMigration; - export interface UserMigration { accountId?: string; key?: string; diff --git a/src/version2/models/userPermission.ts b/src/version2/models/userPermission.ts deleted file mode 100644 index 2080cee4d8..0000000000 --- a/src/version2/models/userPermission.ts +++ /dev/null @@ -1,26 +0,0 @@ -/** Details of a permission and its availability to a user. */ -export interface UserPermission { - /** - * Indicate whether the permission key is deprecated. Note that deprecated keys cannot be used in the `permissions - * parameter of Get my permissions. Deprecated keys are not returned by Get all permissions.` - */ - deprecatedKey?: boolean; - /** The description of the permission. */ - description?: string; - /** Whether the permission is available to the user in the queried context. */ - havePermission?: boolean; - /** - * The ID of the permission. Either `id` or `key` must be specified. Use [Get all - * permissions](#api-rest-api-2-permissions-get) to get the list of permissions. - */ - id?: string; - /** - * The key of the permission. Either `id` or `key` must be specified. Use [Get all - * permissions](#api-rest-api-2-permissions-get) to get the list of permissions. - */ - key?: string; - /** The name of the permission. */ - name?: string; - /** The type of the permission. */ - type?: string; -} diff --git a/src/version2/models/userWrite.ts b/src/version2/models/userWrite.ts deleted file mode 100644 index 6f97914cd5..0000000000 --- a/src/version2/models/userWrite.ts +++ /dev/null @@ -1,36 +0,0 @@ -/** @deprecated Use {@link UserWrite} instead. */ -export type UserWriteBean = UserWrite; - -export interface UserWrite { - /** The URL of the user. */ - self?: string; - /** - * @deprecated This parameter is no longer available. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - key?: string; - /** - * @deprecated This parameter is no longer available. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - name?: string; - /** - * @deprecated This parameter is no longer available. If the user has an Atlassian account, their password is not - * changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account. - */ - password?: string; - /** The email address for the user. */ - emailAddress: string; - /** - * A suggested display name for the user. If the user has an Atlassian account, their display name is not changed. If - * the user does not have an Atlassian account, this display name is used as a suggestion for creating an account. The - * user is sent an email asking them to set their display name and privacy preferences. - */ - displayName: string; - /** Sends the user an email confirmation that they have been added to Jira. Default is `false`. */ - notification?: string; - /** Deprecated, do not use. */ - applicationKeys?: string[]; -} diff --git a/src/version2/models/valueOperand.ts b/src/version2/models/valueOperand.ts deleted file mode 100644 index 1858981057..0000000000 --- a/src/version2/models/valueOperand.ts +++ /dev/null @@ -1,7 +0,0 @@ -/** An operand that is a user-provided value. */ -export interface ValueOperand { - /** Encoded value, which can be used directly in a JQL query. */ - encodedValue?: string; - /** The operand value. */ - value: string; -} diff --git a/src/version2/models/version.ts b/src/version2/models/version.ts index aa29e348c9..5c2cd84911 100644 --- a/src/version2/models/version.ts +++ b/src/version2/models/version.ts @@ -55,13 +55,11 @@ export interface Version { * date format. */ userReleaseDate?: string; - /** Deprecated. Use `projectId`. */ - project?: string; /** * The ID of the project to which this version is attached. Required when creating a version. Not applicable when * updating a version. */ - projectId?: number; + projectId: number; /** * The URL of the self link to the version to which all unfixed issues are moved when a version is released. Not * applicable when creating a version. Optional when updating a version. diff --git a/src/version2/models/versionMove.ts b/src/version2/models/versionMove.ts index 486d3e2109..413ca61218 100644 --- a/src/version2/models/versionMove.ts +++ b/src/version2/models/versionMove.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link VersionMove} instead. */ -export type VersionMoveBean = VersionMove; - export interface VersionMove { /** The URL (self link) of the version after which to place the moved version. Cannot be used with `position`. */ after?: string; diff --git a/src/version2/models/workflowCompoundCondition.ts b/src/version2/models/workflowCompoundCondition.ts deleted file mode 100644 index 3c8787d804..0000000000 --- a/src/version2/models/workflowCompoundCondition.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { WorkflowCondition } from './workflowCondition'; - -/** A compound workflow transition rule condition. This object returns `nodeType` as `compound`. */ -export interface WorkflowCompoundCondition { - /** The list of workflow conditions. */ - conditions: WorkflowCondition[]; - nodeType: string; - /** The compound condition operator. */ - operator: string; -} diff --git a/src/version2/models/workflowRules.ts b/src/version2/models/workflowRules.ts index 2ce45fba7b..0f04cb9d05 100644 --- a/src/version2/models/workflowRules.ts +++ b/src/version2/models/workflowRules.ts @@ -3,11 +3,6 @@ import { WorkflowTransitionRule } from './workflowTransitionRule'; /** A collection of transition rules. */ export interface WorkflowRules { - /** - * @deprecated The workflow conditions. - * ([Deprecated](https://community.developer.atlassian.com/t/deprecation-of-conditions-body-param/48884)) - */ - conditions?: WorkflowTransitionRule[]; conditionsTree?: WorkflowCondition; /** The workflow post functions. */ postFunctions?: WorkflowTransitionRule[]; diff --git a/src/version2/models/workflowSimpleCondition.ts b/src/version2/models/workflowSimpleCondition.ts deleted file mode 100644 index 1a36a97ca0..0000000000 --- a/src/version2/models/workflowSimpleCondition.ts +++ /dev/null @@ -1,8 +0,0 @@ -/** A workflow transition rule condition. This object returns `nodeType` as `simple`. */ -export interface WorkflowSimpleCondition { - /** EXPERIMENTAL. The configuration of the transition rule. */ - configuration?: {}; - nodeType: string; - /** The type of the transition rule. */ - type: string; -} diff --git a/src/version2/models/worklogIdsRequest.ts b/src/version2/models/worklogIdsRequest.ts index 0377169072..aa20d7e6ad 100644 --- a/src/version2/models/worklogIdsRequest.ts +++ b/src/version2/models/worklogIdsRequest.ts @@ -1,6 +1,3 @@ -/** @deprecated Use {@link WorklogIdsRequest} instead. */ -export type WorklogIdsRequestBean = WorklogIdsRequest; - export interface WorklogIdsRequest { /** A list of worklog IDs. */ ids: number[]; diff --git a/src/version2/myself.ts b/src/version2/myself.ts index e9a44b7a70..2930c9de48 100644 --- a/src/version2/myself.ts +++ b/src/version2/myself.ts @@ -200,59 +200,6 @@ export class Myself { return this.client.sendRequest(config, callback); } - /** - * @deprecated Deprecated, use [Update a user - * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) - * from the user management REST API instead. Sets the locale of the user. The locale must be one supported by the - * instance of Jira. **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) - * required:** Permission to access Jira. - */ - async setLocale(parameters: Parameters.SetLocale | undefined, callback: Callback): Promise; - /** - * @deprecated Deprecated, use [Update a user - * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) - * from the user management REST API instead. Sets the locale of the user. The locale must be one supported by the - * instance of Jira. **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) - * required:** Permission to access Jira. - */ - async setLocale(parameters?: Parameters.SetLocale, callback?: never): Promise; - async setLocale(parameters?: Parameters.SetLocale, callback?: Callback): Promise { - const config: RequestConfig = { - url: '/rest/api/2/mypreferences/locale', - method: 'PUT', - data: { - locale: parameters?.locale, - }, - }; - - return this.client.sendRequest(config, callback); - } - - /** - * @deprecated Deprecated, use [Update a user - * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) - * from the user management REST API instead. Deletes the locale of the user, which restores the default setting. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * Permission to access Jira. - */ - async deleteLocale(callback: Callback): Promise; - /** - * @deprecated Deprecated, use [Update a user - * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) - * from the user management REST API instead. Deletes the locale of the user, which restores the default setting. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * Permission to access Jira. - */ - async deleteLocale(callback?: never): Promise; - async deleteLocale(callback?: Callback): Promise { - const config: RequestConfig = { - url: '/rest/api/2/mypreferences/locale', - method: 'DELETE', - }; - - return this.client.sendRequest(config, callback); - } - /** * Returns details for the current user. * diff --git a/src/version2/parameters/addAttachment.ts b/src/version2/parameters/addAttachment.ts index 932ca54a3a..76f7c09f1a 100644 --- a/src/version2/parameters/addAttachment.ts +++ b/src/version2/parameters/addAttachment.ts @@ -1,13 +1,11 @@ +interface Attachment { + filename: string; + file: Buffer | ReadableStream | string | Blob | File; +} + export interface AddAttachment { /** The ID or key of the issue that attachments are added to. */ issueIdOrKey: string; - attachment: AddAttachment.Attachment | AddAttachment.Attachment[]; -} - -export namespace AddAttachment { - export interface Attachment { - filename: string; - file: Buffer | ReadableStream | string | Blob | File; - } + attachment: Attachment | Attachment[]; } diff --git a/src/version2/parameters/addNotifications.ts b/src/version2/parameters/addNotifications.ts deleted file mode 100644 index 2678cd06c1..0000000000 --- a/src/version2/parameters/addNotifications.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { AddNotificationsDetails } from '../models'; - -export interface AddNotifications extends AddNotificationsDetails { - /** The ID of the notification scheme. */ - id: string; -} diff --git a/src/version2/parameters/addUserToGroup.ts b/src/version2/parameters/addUserToGroup.ts index 9e9025d1a4..ec3c98798b 100644 --- a/src/version2/parameters/addUserToGroup.ts +++ b/src/version2/parameters/addUserToGroup.ts @@ -1,7 +1,11 @@ import { UpdateUserToGroup } from '../models'; export interface AddUserToGroup extends UpdateUserToGroup { - /** The name of the group (case-sensitive). */ - groupname: string; - groupId: string; + /** + * As a group's name can change, use of `groupId` is recommended to identify a group. The name of the group. This + * parameter cannot be used with the `groupId` parameter. + */ + groupName?: string; + /** The ID of the group. This parameter cannot be used with the `groupName` parameter. */ + groupId?: string; } diff --git a/src/version2/parameters/addWorklog.ts b/src/version2/parameters/addWorklog.ts index 2775c2e121..6bd51e1bce 100644 --- a/src/version2/parameters/addWorklog.ts +++ b/src/version2/parameters/addWorklog.ts @@ -8,11 +8,12 @@ export interface AddWorklog extends Worklog { /** * Defines how to update the issue's time estimate, the options are: * - * `new` Sets the estimate to a specific value, defined in `newEstimate`. `leave` Leaves the estimate unchanged. - * `manual` Reduces the estimate by amount specified in `reduceBy`. `auto` Reduces the estimate by the value of - * `timeSpent` in the worklog. + * - `new` Sets the estimate to a specific value, defined in `newEstimate`. + * - `leave` Leaves the estimate unchanged. + * - `manual` Reduces the estimate by amount specified in `reduceBy`. + * - `auto` Reduces the estimate by the value of `timeSpent` in the worklog. */ - adjustEstimate?: string; + adjustEstimate?: 'new' | 'leave' | 'manual' | 'auto' | string; /** * The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For * example, _2d_. Required when `adjustEstimate` is `new`. @@ -31,8 +32,8 @@ export interface AddWorklog extends Worklog { expand?: string; /** * Whether the worklog entry should be added to the issue even if the issue is not editable, because - * jira.issue.editable set to false or missing. For example, the issue is closed. Connect app users with admin - * permission and Forge app users with the `manage:jira-configuration` scope can use this flag. + * jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with + * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag. */ overrideEditableFlag?: boolean; } diff --git a/src/version2/parameters/analyseExpression.ts b/src/version2/parameters/analyseExpression.ts index cf67bc87ae..46d7696d48 100644 --- a/src/version2/parameters/analyseExpression.ts +++ b/src/version2/parameters/analyseExpression.ts @@ -4,13 +4,14 @@ export interface AnalyseExpression extends JiraExpressionForAnalysis { /** * The check to perform: * - * `syntax` Each expression's syntax is checked to ensure the expression can be parsed. Also, syntactic limits are - * validated. For example, the expression's length. `type` EXPERIMENTAL. Each expression is type checked and the final - * type of the expression inferred. Any type errors that would result in the expression failure at runtime are - * reported. For example, accessing properties that don't exist or passing the wrong number of arguments to functions. - * Also performs the syntax check. `complexity` EXPERIMENTAL. Determines the formulae for how many [expensive - * operations](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#expensive-operations) each - * expression may execute. + * - `syntax` Each expression's syntax is checked to ensure the expression can be parsed. Also, syntactic limits are + * validated. For example, the expression's length. + * - `type` EXPERIMENTAL. Each expression is type checked and the final type of the expression inferred. Any type errors + * that would result in the expression failure at runtime are reported. For example, accessing properties that don't + * exist or passing the wrong number of arguments to functions. Also performs the syntax check. + * - `complexity` EXPERIMENTAL. Determines the formulae for how many [expensive + * operations](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#expensive-operations) each + * expression may execute. */ - check?: string; + check?: 'syntax' | 'type' | 'complexity' | string; } diff --git a/src/version2/parameters/assignPermissionScheme.ts b/src/version2/parameters/assignPermissionScheme.ts index ad071a5bba..ea7af75f0c 100644 --- a/src/version2/parameters/assignPermissionScheme.ts +++ b/src/version2/parameters/assignPermissionScheme.ts @@ -8,10 +8,20 @@ export interface AssignPermissionScheme extends Id { * information in the response. This parameter accepts a comma-separated list. Note that permissions are included when * you specify any value. Expand options include: * - * `all` Returns all expandable information. `field` Returns information about the custom field granted the - * permission. `group` Returns information about the group that is granted the permission. `permissions` Returns all - * permission grants for each permission scheme. `projectRole` Returns information about the project role granted the - * permission. `user` Returns information about the user who is granted the permission. + * - `all` Returns all expandable information. + * - `field` Returns information about the custom field granted the permission. + * - `group` Returns information about the group that is granted the permission. + * - `permissions` Returns all permission grants for each permission scheme. + * - `projectRole` Returns information about the project role granted the permission. + * - `user` Returns information about the user who is granted the permission. */ - expand?: string; + expand?: + | 'all' + | 'field' + | 'group' + | 'permissions' + | 'projectRole' + | 'user' + | ('all' | 'field' | 'group' | 'permissions' | 'projectRole' | 'user')[] + | string; } diff --git a/src/version2/parameters/associateSchemeWithProject.ts b/src/version2/parameters/associateSchemeWithProject.ts deleted file mode 100644 index 0fd52170c1..0000000000 --- a/src/version2/parameters/associateSchemeWithProject.ts +++ /dev/null @@ -1,3 +0,0 @@ -import { WorkflowSchemeProjectAssociation } from '../models'; - -export interface AssociateSchemeWithProject extends WorkflowSchemeProjectAssociation {} diff --git a/src/version2/parameters/bulkGetUsers.ts b/src/version2/parameters/bulkGetUsers.ts index 67607c637a..ed71bb1261 100644 --- a/src/version2/parameters/bulkGetUsers.ts +++ b/src/version2/parameters/bulkGetUsers.ts @@ -3,20 +3,6 @@ export interface BulkGetUsers { startAt?: number; /** The maximum number of items to return per page. */ maxResults?: number; - /** - * @deprecated This parameter is no longer available and will be removed from the documentation soon. See the - * [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - username?: string[]; - /** - * @deprecated This parameter is no longer available and will be removed from the documentation soon. See the - * [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - key?: string[]; /** * The account ID of a user. To specify multiple users, pass multiple `accountId` parameters. For example, * `accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5`. diff --git a/src/version2/parameters/createCustomFieldOptions.ts b/src/version2/parameters/createCustomFieldOptions.ts deleted file mode 100644 index 9c1e859cf5..0000000000 --- a/src/version2/parameters/createCustomFieldOptions.ts +++ /dev/null @@ -1,9 +0,0 @@ -import { BulkCreateCustomFieldOptionRequest } from '../models'; - -export interface CreateCustomFieldOptions extends BulkCreateCustomFieldOptionRequest { - /** - * The ID of the custom field. Note: This is the numeric part of the of the field ID. For example, for a field with - * the ID _customfield_10075_ use _10075_. - */ - fieldId: number; -} diff --git a/src/version2/parameters/createIssueAdjustment.ts b/src/version2/parameters/createIssueAdjustment.ts deleted file mode 100644 index 8ce6025846..0000000000 --- a/src/version2/parameters/createIssueAdjustment.ts +++ /dev/null @@ -1,3 +0,0 @@ -import { CreateIssueAdjustmentDetails } from '../models'; - -export interface CreateIssueAdjustment extends CreateIssueAdjustmentDetails {} diff --git a/src/version2/parameters/createWorkflowTransitionProperty.ts b/src/version2/parameters/createWorkflowTransitionProperty.ts index 289d987cc2..8aeea6ad06 100644 --- a/src/version2/parameters/createWorkflowTransitionProperty.ts +++ b/src/version2/parameters/createWorkflowTransitionProperty.ts @@ -17,5 +17,5 @@ export interface CreateWorkflowTransitionProperty extends WorkflowTransitionProp * The workflow status. Set to _live_ for inactive workflows or _draft_ for draft workflows. Active workflows cannot * be edited. */ - workflowMode?: string; + workflowMode?: 'live' | 'draft' | string; } diff --git a/src/version2/parameters/deleteAvatar.ts b/src/version2/parameters/deleteAvatar.ts index 5736f3c460..bdbdffd6a8 100644 --- a/src/version2/parameters/deleteAvatar.ts +++ b/src/version2/parameters/deleteAvatar.ts @@ -1,6 +1,6 @@ export interface DeleteAvatar { /** The avatar type. */ - type: string; + type: 'project' | 'issuetype' | string; /** The ID of the item the avatar is associated with. */ owningObjectId: string; /** The ID of the avatar. */ diff --git a/src/version2/parameters/deleteIssue.ts b/src/version2/parameters/deleteIssue.ts index 457aa97ca0..643ebff999 100644 --- a/src/version2/parameters/deleteIssue.ts +++ b/src/version2/parameters/deleteIssue.ts @@ -2,5 +2,5 @@ export interface DeleteIssue { /** The ID or key of the issue. */ issueIdOrKey: string; /** Whether the issue's subtasks are deleted when the issue is deleted. */ - deleteSubtasks?: string; + deleteSubtasks?: boolean; } diff --git a/src/version2/parameters/deleteIssueAdjustment.ts b/src/version2/parameters/deleteIssueAdjustment.ts deleted file mode 100644 index 9ed77ffcda..0000000000 --- a/src/version2/parameters/deleteIssueAdjustment.ts +++ /dev/null @@ -1,4 +0,0 @@ -export interface DeleteIssueAdjustment { - /** The ID of the issue adjustment. */ - issueAdjustmentId: string; -} diff --git a/src/version2/parameters/deletePriority.ts b/src/version2/parameters/deletePriority.ts deleted file mode 100644 index 8fe14bdb47..0000000000 --- a/src/version2/parameters/deletePriority.ts +++ /dev/null @@ -1,8 +0,0 @@ -export interface DeletePriority { - /** The ID of the issue priority. */ - id: string; - /** The ID of the issue priority for replacement. */ - newPriority?: string; - /** The ID of the issue priority that will replace the currently selected resolution. */ - replaceWith: string; -} diff --git a/src/version2/parameters/deleteStatusesById.ts b/src/version2/parameters/deleteStatusesById.ts index 687cfb45ad..7e46e04d3d 100644 --- a/src/version2/parameters/deleteStatusesById.ts +++ b/src/version2/parameters/deleteStatusesById.ts @@ -3,7 +3,7 @@ export interface DeleteStatusesById { * The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, * id=10000&id=10001. * - * Min items `1`, Max items `50` + * Min items `1`, Max items `50` */ id?: string[]; } diff --git a/src/version2/parameters/deleteVersion.ts b/src/version2/parameters/deleteVersion.ts deleted file mode 100644 index 823015b79b..0000000000 --- a/src/version2/parameters/deleteVersion.ts +++ /dev/null @@ -1,14 +0,0 @@ -export interface DeleteVersion { - /** The ID of the version. */ - id: string; - /** - * The ID of the version to update `fixVersion` to when the field contains the deleted version. The replacement - * version must be in the same project as the version being deleted and cannot be the version being deleted. - */ - moveFixIssuesTo?: string; - /** - * The ID of the version to update `affectedVersion` to when the field contains the deleted version. The replacement - * version must be in the same project as the version being deleted and cannot be the version being deleted. - */ - moveAffectedIssuesTo?: string; -} diff --git a/src/version2/parameters/deleteWorkflowTransitionProperty.ts b/src/version2/parameters/deleteWorkflowTransitionProperty.ts index 95fbac1dac..c54f5a4082 100644 --- a/src/version2/parameters/deleteWorkflowTransitionProperty.ts +++ b/src/version2/parameters/deleteWorkflowTransitionProperty.ts @@ -12,5 +12,5 @@ export interface DeleteWorkflowTransitionProperty { * The workflow status. Set to `live` for inactive workflows or `draft` for draft workflows. Active workflows cannot * be edited. */ - workflowMode?: string; + workflowMode?: 'live' | 'draft' | string; } diff --git a/src/version2/parameters/deleteWorklog.ts b/src/version2/parameters/deleteWorklog.ts index 6d223a3d0c..cfdfb5186e 100644 --- a/src/version2/parameters/deleteWorklog.ts +++ b/src/version2/parameters/deleteWorklog.ts @@ -8,11 +8,12 @@ export interface DeleteWorklog { /** * Defines how to update the issue's time estimate, the options are: * - * `new` Sets the estimate to a specific value, defined in `newEstimate`. `leave` Leaves the estimate unchanged. - * `manual` Increases the estimate by amount specified in `increaseBy`. `auto` Reduces the estimate by the value of - * `timeSpent` in the worklog. + * - `new` Sets the estimate to a specific value, defined in `newEstimate`. + * - `leave` Leaves the estimate unchanged. + * - `manual` Increases the estimate by amount specified in `increaseBy`. + * - `auto` Reduces the estimate by the value of `timeSpent` in the worklog. */ - adjustEstimate?: string; + adjustEstimate?: 'new' | 'leave' | 'manual' | 'auto' | string; /** * The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For * example, _2d_. Required when `adjustEstimate` is `new`. @@ -25,8 +26,8 @@ export interface DeleteWorklog { increaseBy?: string; /** * Whether the work log entry should be added to the issue even if the issue is not editable, because - * jira.issue.editable set to false or missing. For example, the issue is closed. Connect app users with admin - * permission and Forge app users with the `manage:jira-configuration` scope can use this flag. + * jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with + * admin permission can use this flag. */ overrideEditableFlag?: boolean; } diff --git a/src/version2/parameters/findGroups.ts b/src/version2/parameters/findGroups.ts index fdc856e7d9..af6e2ff3eb 100644 --- a/src/version2/parameters/findGroups.ts +++ b/src/version2/parameters/findGroups.ts @@ -1,9 +1,4 @@ export interface FindGroups { - /** - * @deprecated This parameter is deprecated, setting it does not affect the results. To find groups containing a - * particular user, use [Get user groups](#api-rest-api-2-user-groups-get). - */ - accountId?: string; /** The string to find in group names. */ query?: string; /** @@ -23,12 +18,6 @@ export interface FindGroups { * property `jira.ajax.autocomplete.limit`. */ maxResults?: number; - /** Whether the search for groups should be case-insensitive. */ + /** Whether the search for groups should be case insensitive. */ caseInsensitive?: boolean; - /** - * @deprecated This parameter is no longer available. See the [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - userName?: string; } diff --git a/src/version2/parameters/findUsers.ts b/src/version2/parameters/findUsers.ts index 16293887c9..e2a8a40ac2 100644 --- a/src/version2/parameters/findUsers.ts +++ b/src/version2/parameters/findUsers.ts @@ -12,7 +12,7 @@ export interface FindUsers { * specified. */ accountId?: string; - /** The index of the first item to return in a page of results (page offset). */ + /** The index of the first item to return in a page of filtered results (page offset). */ startAt?: number; /** The maximum number of items to return per page. */ maxResults?: number; diff --git a/src/version2/parameters/findUsersAndGroups.ts b/src/version2/parameters/findUsersAndGroups.ts index 268e9ac3e5..5ec5bc4b01 100644 --- a/src/version2/parameters/findUsersAndGroups.ts +++ b/src/version2/parameters/findUsersAndGroups.ts @@ -21,7 +21,29 @@ export interface FindUsersAndGroups { */ issueTypeId?: string[]; /** The size of the avatar to return. If an invalid value is provided, the default value is used. */ - avatarSize?: string; + avatarSize?: + | 'xsmall' + | 'xsmall@2x' + | 'xsmall@3x' + | 'small' + | 'small@2x' + | 'small@3x' + | 'medium' + | 'medium@2x' + | 'medium@3x' + | 'large' + | 'large@2x' + | 'large@3x' + | 'xlarge' + | 'xlarge@2x' + | 'xlarge@3x' + | 'xxlarge' + | 'xxlarge@2x' + | 'xxlarge@3x' + | 'xxxlarge' + | 'xxxlarge@2x' + | 'xxxlarge@3x' + | string; /** Whether the search for groups should be case insensitive. */ caseInsensitive?: boolean; /** diff --git a/src/version2/parameters/findUsersForPicker.ts b/src/version2/parameters/findUsersForPicker.ts index f5f6e18849..b5eb7749a2 100644 --- a/src/version2/parameters/findUsersForPicker.ts +++ b/src/version2/parameters/findUsersForPicker.ts @@ -9,12 +9,6 @@ export interface FindUsersForPicker { maxResults?: number; /** Include the URI to the user's avatar. */ showAvatar?: boolean; - /** - * @deprecated This parameter is no longer available. See the [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - exclude?: string[]; /** * A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple * account IDs can also be provided using an ampersand-separated list. For example, diff --git a/src/version2/parameters/getAccessibleProjectTypeByKey.ts b/src/version2/parameters/getAccessibleProjectTypeByKey.ts index d52fbee198..b0b2a0c8bb 100644 --- a/src/version2/parameters/getAccessibleProjectTypeByKey.ts +++ b/src/version2/parameters/getAccessibleProjectTypeByKey.ts @@ -1,4 +1,4 @@ export interface GetAccessibleProjectTypeByKey { /** The key of the project type. */ - projectTypeKey: string; + projectTypeKey: 'software' | 'service_desk' | 'business' | 'product_discovery' | string; } diff --git a/src/version2/parameters/getAllDashboards.ts b/src/version2/parameters/getAllDashboards.ts index a611c612bc..00cdb506bc 100644 --- a/src/version2/parameters/getAllDashboards.ts +++ b/src/version2/parameters/getAllDashboards.ts @@ -2,9 +2,10 @@ export interface GetAllDashboards { /** * The filter applied to the list of dashboards. Valid values are: * - * `favourite` Returns dashboards the user has marked as favorite. `my` Returns dashboards owned by the user. + * - `favourite` Returns dashboards the user has marked as favorite. + * - `my` Returns dashboards owned by the user. */ - filter?: string; + filter?: 'my' | 'favourite' | string; /** 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. */ diff --git a/src/version2/parameters/getAllIssueTypeSchemes.ts b/src/version2/parameters/getAllIssueTypeSchemes.ts index 447988ffb1..9c030524e2 100644 --- a/src/version2/parameters/getAllIssueTypeSchemes.ts +++ b/src/version2/parameters/getAllIssueTypeSchemes.ts @@ -14,7 +14,7 @@ export interface GetAllIssueTypeSchemes { * - `name` Sorts by issue type scheme name. * - `id` Sorts by issue type scheme ID. */ - orderBy?: 'name' | 'id' | string; + orderBy?: 'name' | '-name' | '+name' | 'id' | '-id' | '+id' | 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: @@ -23,7 +23,7 @@ export interface GetAllIssueTypeSchemes { * to. * - `issueTypes` For each issue type schemes, returns information about the issueTypes the issue type scheme have. */ - expand?: 'projects' | 'issueTypes' | string; + expand?: 'projects' | 'issueTypes' | ('projects' | 'issueTypes')[] | string | string[]; /** String used to perform a case-insensitive partial match with issue type scheme name. */ queryString?: string; } diff --git a/src/version2/parameters/getAllProjects.ts b/src/version2/parameters/getAllProjects.ts deleted file mode 100644 index fab813e801..0000000000 --- a/src/version2/parameters/getAllProjects.ts +++ /dev/null @@ -1,18 +0,0 @@ -export interface GetAllProjects { - /** - * 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. Expanded options include: - * - * `description` Returns the project description. `issueTypes` Returns all issue types associated with the project. - * `lead` Returns information about the project lead. `projectKeys` Returns all project keys associated with the - * project. - */ - expand?: string; - /** - * Returns the user's most recently accessed projects. You may specify the number of results to return up to a maximum - * of 20. If access is anonymous, then the recently accessed projects are based on the current HTTP session. - */ - recent?: number; - /** A list of project properties to return for the project. This parameter accepts a comma-separated list. */ - properties?: string[]; -} diff --git a/src/version2/parameters/getAllSystemAvatars.ts b/src/version2/parameters/getAllSystemAvatars.ts index 8283ea14a3..c1d371e2df 100644 --- a/src/version2/parameters/getAllSystemAvatars.ts +++ b/src/version2/parameters/getAllSystemAvatars.ts @@ -1,4 +1,4 @@ export interface GetAllSystemAvatars { /** The avatar type. */ - type: string; + type: 'issuetype' | 'project' | 'user' | string; } diff --git a/src/version2/parameters/getAllWorkflows.ts b/src/version2/parameters/getAllWorkflows.ts deleted file mode 100644 index 17dd630238..0000000000 --- a/src/version2/parameters/getAllWorkflows.ts +++ /dev/null @@ -1,4 +0,0 @@ -export interface GetAllWorkflows { - /** The name of the workflow to be returned. Only one workflow can be specified. */ - workflowName?: string; -} diff --git a/src/version2/parameters/getAvatarImageByID.ts b/src/version2/parameters/getAvatarImageByID.ts index 12d9ad0164..c8556f01dd 100644 --- a/src/version2/parameters/getAvatarImageByID.ts +++ b/src/version2/parameters/getAvatarImageByID.ts @@ -1,10 +1,10 @@ export interface GetAvatarImageByID { /** The icon type of the avatar. */ - type: string; + type: 'issuetype' | 'project' | string; /** The ID of the avatar. */ - id: number; + id: number | string; /** The size of the avatar image. If not provided the default size is returned. */ - size?: string | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge'; + size?: 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | string; /** The format to return the avatar image in. If not provided the original content format is returned. */ - format?: string; + format?: 'png' | 'svg' | string; } diff --git a/src/version2/parameters/getAvatarImageByOwner.ts b/src/version2/parameters/getAvatarImageByOwner.ts index 7a8318150b..0726f004d3 100644 --- a/src/version2/parameters/getAvatarImageByOwner.ts +++ b/src/version2/parameters/getAvatarImageByOwner.ts @@ -1,10 +1,10 @@ export interface GetAvatarImageByOwner { /** The icon type of the avatar. */ - type: string; + type: 'issuetype' | 'project' | string; /** The ID of the project or issue type the avatar belongs to. */ entityId: string; /** The size of the avatar image. If not provided the default size is returned. */ - size?: string | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge'; + size?: 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | string; /** The format to return the avatar image in. If not provided the original content format is returned. */ - format?: string; + format?: 'png' | 'svg' | string; } diff --git a/src/version2/parameters/getAvatarImageByType.ts b/src/version2/parameters/getAvatarImageByType.ts index 3a329f71d6..de3317275d 100644 --- a/src/version2/parameters/getAvatarImageByType.ts +++ b/src/version2/parameters/getAvatarImageByType.ts @@ -1,8 +1,8 @@ export interface GetAvatarImageByType { /** The icon type of the avatar. */ - type: string; + type: 'issuetype' | 'project' | string; /** The size of the avatar image. If not provided the default size is returned. */ - size?: string | 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge'; + size?: 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | string; /** The format to return the avatar image in. If not provided the original content format is returned. */ - format?: string; + format?: 'png' | 'svg' | string; } diff --git a/src/version2/parameters/getAvatars.ts b/src/version2/parameters/getAvatars.ts index b20b97669a..94f9acecf2 100644 --- a/src/version2/parameters/getAvatars.ts +++ b/src/version2/parameters/getAvatars.ts @@ -1,6 +1,6 @@ export interface GetAvatars { /** The avatar type. */ - type: string; + type: 'project' | 'issuetype' | string; /** The ID of the item the avatar is associated with. */ entityId: string; } diff --git a/src/version2/parameters/getComments.ts b/src/version2/parameters/getComments.ts index 9d0fb28474..5ddcbdec60 100644 --- a/src/version2/parameters/getComments.ts +++ b/src/version2/parameters/getComments.ts @@ -9,7 +9,7 @@ export interface GetComments { * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#ordering) the results by a field. * Accepts _created_ to sort comments by their created date. */ - orderBy?: string; + orderBy?: 'created' | '-created' | '+created' | string; /** * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#expansion) to include additional * information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body diff --git a/src/version2/parameters/getContextsForFieldDeprecated.ts b/src/version2/parameters/getContextsForFieldDeprecated.ts deleted file mode 100644 index dd7bb2e45c..0000000000 --- a/src/version2/parameters/getContextsForFieldDeprecated.ts +++ /dev/null @@ -1,8 +0,0 @@ -export interface GetContextsForFieldDeprecated { - /** The ID of the field to return contexts for. */ - fieldId: string; - /** 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; -} diff --git a/src/version2/parameters/getCurrentUser.ts b/src/version2/parameters/getCurrentUser.ts index 974c45a5b4..fd7e039e8c 100644 --- a/src/version2/parameters/getCurrentUser.ts +++ b/src/version2/parameters/getCurrentUser.ts @@ -3,24 +3,8 @@ export interface GetCurrentUser { * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#expansion) to include additional * information about user in the response. This parameter accepts a comma-separated list. Expand options include: * - * `groups` Returns all groups, including nested groups, the user belongs to. `applicationRoles` Returns the - * application roles the user is assigned to. + * - `groups` Returns all groups, including nested groups, the user belongs to. + * - `applicationRoles` Returns the application roles the user is assigned to. */ - expand?: - | 'groups' - | 'applicationRoles' - | ('groups' | 'applicationRoles')[] - | string - | string[] - | GetCurrentUser.Expand - | GetCurrentUser.Expand[]; -} - -export namespace GetCurrentUser { - export enum Expand { - /** Returns all groups, including nested groups, the user belongs to. */ - Groups = 'groups', - /** Returns the application roles the user is assigned to. */ - ApplicationRoles = 'applicationRoles', - } + expand?: 'groups' | 'applicationRoles' | ('groups' | 'applicationRoles')[] | string | string[]; } diff --git a/src/version2/parameters/getCustomFieldConfiguration.ts b/src/version2/parameters/getCustomFieldConfiguration.ts index 73a18d995a..b6d4fdd269 100644 --- a/src/version2/parameters/getCustomFieldConfiguration.ts +++ b/src/version2/parameters/getCustomFieldConfiguration.ts @@ -6,8 +6,6 @@ export interface GetCustomFieldConfiguration { * `id=10000&id=10001`. Can't be provided with `fieldContextId`, `issueId`, `projectKeyOrId`, or `issueTypeId`. */ id?: number[]; - /** DEPRECATED. Do not use. */ - contextId?: number[]; /** * The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: * `fieldContextId=10000&fieldContextId=10001`. Can't be provided with `id`, `issueId`, `projectKeyOrId`, or @@ -16,17 +14,17 @@ export interface GetCustomFieldConfiguration { fieldContextId?: number[]; /** * The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided - * with `contextIds`, `projectKeyOrId`, or `issueTypeId`. + * with `projectKeyOrId`, or `issueTypeId`. */ issueId?: number; /** * The ID or key of the project to filter results by. Must be provided with `issueTypeId`. Can't be provided with - * `contextIds` or `issueId`. + * `issueId`. */ projectKeyOrId?: string; /** * The ID of the issue type to filter results by. Must be provided with `projectKeyOrId`. Can't be provided with - * `contextIds` or `issueId`. + * `issueId`. */ issueTypeId?: string; /** The index of the first item to return in a page of results (page offset). */ diff --git a/src/version2/parameters/getDashboardsPaginated.ts b/src/version2/parameters/getDashboardsPaginated.ts index 3886527b37..b9a2b41cff 100644 --- a/src/version2/parameters/getDashboardsPaginated.ts +++ b/src/version2/parameters/getDashboardsPaginated.ts @@ -6,13 +6,6 @@ export interface GetDashboardsPaginated { * the `owner` parameter. */ accountId?: string; - /** - * @deprecated This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. User name used to return dashboards with the matching `owner.name`. This parameter cannot be used - * with the `accountId` parameter. - */ - owner?: string; /** * As a group's name can change, use of `groupId` is recommended. Group name used to return dashboards that are shared * with a group that matches `sharePermissions.group.name`. This parameter cannot be used with the `groupId` @@ -39,22 +32,22 @@ export interface GetDashboardsPaginated { */ orderBy?: | 'description' - | 'favourite_count' - | 'id' - | 'is_favourite' - | 'name' - | 'owner' | '-description' - | '-favourite_count' - | '-id' - | '-is_favourite' - | '-name' - | '-owner' | '+description' - | '+favourite_count' + | 'favorite_count' + | '-favorite_count' + | '+favorite_count' + | 'id' + | '-id' | '+id' - | '+is_favourite' + | 'is_favorite' + | '-is_favorite' + | '+is_favorite' + | 'name' + | '-name' | '+name' + | 'owner' + | '-owner' | '+owner' | string; /** The index of the first item to return in a page of results (page offset). */ diff --git a/src/version2/parameters/getFieldsPaginated.ts b/src/version2/parameters/getFieldsPaginated.ts index ddf9debc70..d37ff871f2 100644 --- a/src/version2/parameters/getFieldsPaginated.ts +++ b/src/version2/parameters/getFieldsPaginated.ts @@ -4,7 +4,7 @@ export interface GetFieldsPaginated { /** The maximum number of items to return per page. */ maxResults?: number; /** The type of fields to search. */ - type?: string[]; + type?: ('custom' | 'system' | string)[]; /** The IDs of the custom fields to return or, where `query` is specified, filter. */ id?: string[]; /** String used to perform a case-insensitive partial match with field names or descriptions. */ @@ -12,35 +12,38 @@ export interface GetFieldsPaginated { /** * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#ordering) the results by a field: * - * - `contextsCount` Sorts by the number of contexts related to a field. - * - `lastUsed` Sorts by the date when the value of the field last changed. - * - `name` Sorts by the field name. - * - `screensCount` Sorts by the number of screens related to a field. + * - `contextsCount` sorts by the number of contexts related to a field + * - `lastUsed` sorts by the date when the value of the field last changed + * - `name` sorts by the field name + * - `screensCount` sorts by the number of screens related to a field */ orderBy?: | 'contextsCount' - | 'lastUsed' - | 'name' - | 'screensCount' - | '+contextsCount' - | '+lastUsed' - | '+name' - | '+screensCount' | '-contextsCount' + | '+contextsCount' + | 'lastUsed' | '-lastUsed' + | '+lastUsed' + | 'name' | '-name' + | '+name' + | 'screensCount' | '-screensCount' + | '+screensCount' + | 'projectsCount' + | '-projectsCount' + | '+projectsCount' | 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: * - * - `key` Returns the key for each field. - * - `lastUsed` Returns the date when the value of the field last changed. - * - `screensCount` Returns the number of screens related to a field. - * - `contextsCount` Returns the number of contexts related to a field. - * - `isLocked` Returns information about whether the field is [locked](https://confluence.atlassian.com/x/ZSN7Og). - * - `searcherKey` Returns the searcher key for each custom field. + * - `key` returns the key for each field + * - `lastUsed` returns the date when the value of the field last changed + * - `screensCount` returns the number of screens related to a field + * - `contextsCount` returns the number of contexts related to a field + * - `isLocked` returns information about whether the field is [locked](https://confluence.atlassian.com/x/ZSN7Og) + * - `searcherKey` returns the searcher key for each custom field */ expand?: | 'key' diff --git a/src/version2/parameters/getFilters.ts b/src/version2/parameters/getFilters.ts deleted file mode 100644 index b7791b8d76..0000000000 --- a/src/version2/parameters/getFilters.ts +++ /dev/null @@ -1,16 +0,0 @@ -export interface GetFilters { - /** - * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#expansion) to include additional - * information about filter in the response. This parameter accepts a comma-separated list. Expand options include: - * - * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that - * the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it - * doesn't list any users. The list of users returned is limited to 1000, to access additional users append - * `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use - * `?expand=sharedUsers[1001:2000]`. `subscriptions` Returns the users that are subscribed to the filter. If you don't - * specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of - * subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to - * the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`. - */ - expand?: string; -} diff --git a/src/version2/parameters/getFiltersPaginated.ts b/src/version2/parameters/getFiltersPaginated.ts index 26bf40c69c..6d1e13a09b 100644 --- a/src/version2/parameters/getFiltersPaginated.ts +++ b/src/version2/parameters/getFiltersPaginated.ts @@ -6,13 +6,6 @@ export interface GetFiltersPaginated { * `owner`. */ accountId?: string; - /** - * @deprecated This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. User name used to return filters with the matching `owner.name`. This parameter cannot be used with - * `accountId`. - */ - owner?: string; /** * As a group's name can change, use of `groupId` is recommended to identify a group. Group name used to returns * filters that are shared with a group that matches `sharePermissions.group.groupname`. This parameter cannot be used @@ -28,11 +21,11 @@ export interface GetFiltersPaginated { projectId?: number; /** * The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example, - * `id=10000&id=10001`. + * `id=10000&id=10001`. Do not exceed 200 filter IDs. */ id?: number[]; /** - * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#ordering) the results by a field: + * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#ordering) the results by a field: * * - `description` Sorts by filter description. Note that this sorting works independently of whether the expand to * display the description field is in use. @@ -45,26 +38,26 @@ export interface GetFiltersPaginated { */ orderBy?: | 'description' - | 'favourite_count' - | 'is_favourite' - | 'id' - | 'name' - | 'owner' - | 'is_shared' + | '-description' | '+description' + | 'favourite_count' + | '-favourite_count' | '+favourite_count' - | '+is_favourite' + | 'id' + | '-id' | '+id' - | '+name' - | '+owner' - | '+is_shared' - | '-description' - | '-favourite_count' + | 'is_favourite' | '-is_favourite' - | '-id' + | '+is_favourite' + | 'name' | '-name' + | '+name' + | 'owner' | '-owner' + | '+owner' + | 'is_shared' | '-is_shared' + | '+is_shared' | string; /** The index of the first item to return in a page of results (page offset). */ startAt?: number; @@ -112,9 +105,7 @@ export interface GetFiltersPaginated { | 'viewUrl' )[] | string - | string[] - | GetFiltersPaginated.Expand - | GetFiltersPaginated.Expand[]; + | string[]; /** * EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. @@ -122,30 +113,3 @@ export interface GetFiltersPaginated { */ overrideSharePermissions?: boolean; } - -export namespace GetFiltersPaginated { - export enum Expand { - /** Returns the description of the filter. */ - Description = 'description', - /** Returns an indicator of whether the user has set the filter as a favorite. */ - Favourite = 'favourite', - /** Returns a count of how many users have set this filter as a favorite. */ - FavouritedCount = 'favouritedCount', - /** Returns the JQL query that the filter uses. */ - JQL = 'jql', - /** Returns the owner of the filter. */ - Owner = 'owner', - /** Returns a URL to perform the filter's JQL query. */ - SearchUrl = 'searchUrl', - /** Returns the share permissions defined for the filter. */ - SharePermissions = 'sharePermissions', - /** Returns the edit permissions defined for the filter. */ - EditPermissions = 'editPermissions', - /** Returns whether the current user has permission to edit the filter. */ - IsWritable = 'isWritable', - /** Returns the users that are subscribed to the filter. */ - Subscriptions = 'subscriptions', - /** Returns a URL to view the filter. */ - ViewUrl = 'viewUrl', - } -} diff --git a/src/version2/parameters/getGroup.ts b/src/version2/parameters/getGroup.ts deleted file mode 100644 index e34e5efada..0000000000 --- a/src/version2/parameters/getGroup.ts +++ /dev/null @@ -1,11 +0,0 @@ -export interface GetGroup { - /** - * As a group's name can change, use of `groupId` is recommended to identify a group. The name of the group. This - * parameter cannot be used with the `groupId` parameter. - */ - groupname?: string; - /** The ID of the group. This parameter cannot be used with the `groupName` parameter. */ - groupId?: string; - /** List of fields to expand. */ - expand?: string; -} diff --git a/src/version2/parameters/getIssue.ts b/src/version2/parameters/getIssue.ts index b4c92346f7..990fea2fbc 100644 --- a/src/version2/parameters/getIssue.ts +++ b/src/version2/parameters/getIssue.ts @@ -47,9 +47,7 @@ export interface GetIssue { | 'versionedRepresentations' | ('renderedFields' | 'names' | 'transitions' | 'editmeta' | 'changelog' | 'versionedRepresentations')[] | string - | string[] - | GetIssue.Expand - | GetIssue.Expand[]; + | string[]; /** * A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: * @@ -70,23 +68,3 @@ export interface GetIssue { */ updateHistory?: boolean; } - -export namespace GetIssue { - export enum Expand { - /** Returns field values rendered in HTML format. */ - RenderedFields = 'renderedFields', - /** Returns the display name of each field. -`schema` Returns the schema describing a field type. */ - Names = 'names', - /** Returns all possible transitions for the issue. */ - Transitions = 'transitions', - /** Returns information about how each field can be edited. */ - EditMeta = 'editmeta', - /** Returns a list of recent updates to an issue, sorted by date, starting from the most recent. */ - Changelog = 'changelog', - /** - * Returns a JSON array for each version of a field's value, with the highest number representing the most recent - * version. Note: When included in the request, the `fields` parameter is ignored. - */ - VersionedRepresentations = 'versionedRepresentations', - } -} diff --git a/src/version2/parameters/getIssueAdjustments.ts b/src/version2/parameters/getIssueAdjustments.ts deleted file mode 100644 index 6901f1b753..0000000000 --- a/src/version2/parameters/getIssueAdjustments.ts +++ /dev/null @@ -1,14 +0,0 @@ -export interface GetIssueAdjustments { - /** 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 to include additional information in the response. This parameter accepts a comma-separated list. Expand - * options include: - * - * - `data` Returns issue adjustment data. - * - `contexts` Returns issue adjustment contexts. - */ - expand?: 'data' | 'contexts' | ('data' | 'contexts')[] | string | string[]; -} diff --git a/src/version2/parameters/getIssueTypeScreenSchemes.ts b/src/version2/parameters/getIssueTypeScreenSchemes.ts index 9710d19103..e53b313eda 100644 --- a/src/version2/parameters/getIssueTypeScreenSchemes.ts +++ b/src/version2/parameters/getIssueTypeScreenSchemes.ts @@ -16,7 +16,7 @@ export interface GetIssueTypeScreenSchemes { * - `name` Sorts by issue type screen scheme name. * - `id` Sorts by issue type screen scheme ID. */ - orderBy?: 'name' | 'id' | '+name' | '+id' | '-name' | '-id' | string; + orderBy?: 'name' | '-name' | '+name' | 'id' | '-id' | '+id' | string; /** * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#expansion) to include additional * information in the response. This parameter accepts `projects` that, for each issue type screen schemes, returns diff --git a/src/version2/parameters/getNotificationSchemeForProject.ts b/src/version2/parameters/getNotificationSchemeForProject.ts index 73d4684b27..78bb978db8 100644 --- a/src/version2/parameters/getNotificationSchemeForProject.ts +++ b/src/version2/parameters/getNotificationSchemeForProject.ts @@ -5,11 +5,22 @@ export interface GetNotificationSchemeForProject { * 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: * - * `all` Returns all expandable information. `field` Returns information about any custom fields assigned to receive - * an event. `group` Returns information about any groups assigned to receive an event. `notificationSchemeEvents` - * Returns a list of event associations. This list is returned for all expandable information. `projectRole` Returns - * information about any project roles assigned to receive an event. `user` Returns information about any users - * assigned to receive an event. + * - `all` Returns all expandable information + * - `field` Returns information about any custom fields assigned to receive an event + * - `group` Returns information about any groups assigned to receive an event + * - `notificationSchemeEvents` Returns a list of event associations. This list is returned for all expandable + * information + * - `projectRole` Returns information about any project roles assigned to receive an event + * - `user` Returns information about any users assigned to receive an event */ - expand?: string; + expand?: + | 'all' + | 'field' + | 'group' + | 'notificationSchemeEvents' + | 'projectRole' + | 'user' + | ('all' | 'field' | 'group' | 'notificationSchemeEvents' | 'projectRole' | 'user')[] + | string + | string[]; } diff --git a/src/version2/parameters/getOptionsForField.ts b/src/version2/parameters/getOptionsForField.ts deleted file mode 100644 index 68206af359..0000000000 --- a/src/version2/parameters/getOptionsForField.ts +++ /dev/null @@ -1,11 +0,0 @@ -export interface GetOptionsForField { - /** - * The ID of the custom field. Note: This is the numeric part of the of the field ID. For example, for a field with - * the ID _customfield_10075_ use _10075_. - */ - fieldId: number; - /** 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; -} diff --git a/src/version2/parameters/getPrecomputations.ts b/src/version2/parameters/getPrecomputations.ts index 44a3e8275f..e38404f018 100644 --- a/src/version2/parameters/getPrecomputations.ts +++ b/src/version2/parameters/getPrecomputations.ts @@ -1,7 +1,36 @@ export interface GetPrecomputations { + /** + * The function key in format: + * + * Forge: `ari:cloud:ecosystem::extension/[App ID]/[Environment ID]/static/[Function key from manifest]` Connect: + * `[App key]__[Module key]` + */ functionKey?: string[]; + /** 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; - orderBy?: string; + /** + * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#ordering) the results by a field: + * + * - `functionKey` Sorts by the functionKey. + * - `used` Sorts by the used timestamp. + * - `created` Sorts by the created timestamp. + * - `updated` Sorts by the updated timestamp. + */ filter?: string; + orderBy?: + | 'functionKey' + | 'used' + | 'created' + | 'updated' + | '+functionKey' + | '+used' + | '+created' + | '+updated' + | '-functionKey' + | '-used' + | '-created' + | '-updated' + | string; } diff --git a/src/version2/parameters/getProjectComponentsPaginated.ts b/src/version2/parameters/getProjectComponentsPaginated.ts index 9d583bf0dd..ca47b8d01a 100644 --- a/src/version2/parameters/getProjectComponentsPaginated.ts +++ b/src/version2/parameters/getProjectComponentsPaginated.ts @@ -1,5 +1,5 @@ export interface GetProjectComponentsPaginated { - /** The project ID or project key (case-sensitive). */ + /** The project ID or project key (case sensitive). */ projectIdOrKey: string; /** The index of the first item to return in a page of results (page offset). */ startAt?: number; @@ -15,21 +15,21 @@ export interface GetProjectComponentsPaginated { */ orderBy?: | 'description' - | 'issueCount' - | 'lead' - | 'name' - | '+description' - | '+issueCount' - | '+lead' - | '+name' | '-description' + | '+description' + | 'issueCount' | '-issueCount' + | '+issueCount' + | 'lead' | '-lead' + | '+lead' + | 'name' | '-name' + | '+name' | string; /** - * Filter the results using a literal string. Components with a matching `name` or `description` are returned - * (case-insensitive). + * Filter the results using a literal string. Components with a matching `name` or `description` are returned (case + * insensitive). */ query?: string; } diff --git a/src/version2/parameters/getProjectTypeByKey.ts b/src/version2/parameters/getProjectTypeByKey.ts index 009f7af376..d371bfda66 100644 --- a/src/version2/parameters/getProjectTypeByKey.ts +++ b/src/version2/parameters/getProjectTypeByKey.ts @@ -1,4 +1,4 @@ export interface GetProjectTypeByKey { /** The key of the project type. */ - projectTypeKey: string; + projectTypeKey: 'software' | 'service_desk' | 'business' | 'product_discovery' | string; } diff --git a/src/version2/parameters/getProjectVersionsPaginated.ts b/src/version2/parameters/getProjectVersionsPaginated.ts index be610f4347..0d2d9139fe 100644 --- a/src/version2/parameters/getProjectVersionsPaginated.ts +++ b/src/version2/parameters/getProjectVersionsPaginated.ts @@ -1,5 +1,5 @@ export interface GetProjectVersionsPaginated { - /** The project ID or project key (case-sensitive). */ + /** The project ID or project key (case sensitive). */ projectIdOrKey: string; /** The index of the first item to return in a page of results (page offset). */ startAt?: number; @@ -16,20 +16,20 @@ export interface GetProjectVersionsPaginated { */ orderBy?: | 'description' - | 'name' - | 'releaseDate' - | 'sequence' - | 'startDate' - | '+description' - | '+name' - | '+releaseDate' - | '+sequence' - | '+startDate' | '-description' + | '+description' + | 'name' | '-name' + | '+name' + | 'releaseDate' | '-releaseDate' + | '+releaseDate' + | 'sequence' | '-sequence' + | '+sequence' + | 'startDate' | '-startDate' + | '+startDate' | string; /** * Filter the results using a literal string. Versions with matching `name` or `description` are returned (case @@ -47,6 +47,15 @@ export interface GetProjectVersionsPaginated { * * - `issuesstatus` Returns the number of issues in each status category for each version. * - `operations` Returns actions that can be performed on the specified version. + * - `driver` Returns the Atlassian account ID of the version driver. + * - `approvers` Returns a list containing the approvers for this version. */ - expand?: 'issuesstatus' | 'operations' | string; + expand?: + | 'issuesstatus' + | 'operations' + | 'driver' + | 'approvers' + | ('issuesstatus' | 'operations' | 'driver' | 'approvers')[] + | string + | string[]; } diff --git a/src/version2/parameters/getRecent.ts b/src/version2/parameters/getRecent.ts index 77ab2dd8e9..3a8640371a 100644 --- a/src/version2/parameters/getRecent.ts +++ b/src/version2/parameters/getRecent.ts @@ -24,33 +24,10 @@ export interface GetRecent { | '*' | ('description' | 'projectKeys' | 'lead' | 'issueTypes' | 'url' | 'permissions' | 'insight')[] | string - | string[] - | GetRecent.Expand - | GetRecent.Expand[]; + | string[]; /** * EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated * list. Invalid property names are ignored. */ properties?: string[]; } - -export namespace GetRecent { - export enum Expand { - /** Returns the project description. */ - Description = 'description', - /** Returns all project keys associated with a project. */ - ProjectKeys = 'projectKeys', - /** Returns information about the project lead. */ - Lead = 'lead', - /** Returns all issue types associated with the project. */ - IssueTypes = 'issueTypes', - /** Returns the URL associated with the project. */ - Url = 'url', - /** Returns the permissions associated with the project. */ - Permissions = 'permissions', - /** EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project. */ - Insight = 'insight', - /** Returns the project with all available expand options. */ - All = '*', - } -} diff --git a/src/version2/parameters/getResolution.ts b/src/version2/parameters/getResolution.ts deleted file mode 100644 index 13eba23264..0000000000 --- a/src/version2/parameters/getResolution.ts +++ /dev/null @@ -1,4 +0,0 @@ -export interface GetResolution { - /** The ID of the issue resolution value. */ - id: string; -} diff --git a/src/version2/parameters/getScreenSchemes.ts b/src/version2/parameters/getScreenSchemes.ts index 05333c7a2b..a83d0eedf5 100644 --- a/src/version2/parameters/getScreenSchemes.ts +++ b/src/version2/parameters/getScreenSchemes.ts @@ -22,5 +22,5 @@ export interface GetScreenSchemes { * - `id` Sorts by screen scheme ID. * - `name` Sorts by screen scheme name. */ - orderBy?: 'id' | 'name' | '+id' | '+name' | '-id' | '-name' | string; + orderBy?: 'name' | '-name' | '+name' | 'id' | '-id' | '+id' | string; } diff --git a/src/version2/parameters/getScreens.ts b/src/version2/parameters/getScreens.ts index 3274f18961..97e04a52ee 100644 --- a/src/version2/parameters/getScreens.ts +++ b/src/version2/parameters/getScreens.ts @@ -14,11 +14,12 @@ export interface GetScreens { * The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example, * `scope=GLOBAL&scope=PROJECT`. */ - scope?: string[]; + scope?: ('GLOBAL' | 'TEMPLATE' | 'PROJECT' | string)[]; /** * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#ordering) the results by a field: * - * `id` Sorts by screen ID. `name` Sorts by screen name. + * - `id` Sorts by screen ID. + * - `name` Sorts by screen name. */ - orderBy?: 'id' | 'name' | '+id' | '+name' | '-id' | '-name' | string; + orderBy?: 'name' | '-name' | '+name' | 'id' | '-id' | '+id' | string; } diff --git a/src/version2/parameters/getStatusesById.ts b/src/version2/parameters/getStatusesById.ts index 6af4358f28..2e1fd4d629 100644 --- a/src/version2/parameters/getStatusesById.ts +++ b/src/version2/parameters/getStatusesById.ts @@ -1,16 +1,17 @@ export interface GetStatusesById { /** - * The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, - * id=10000&id=10001. + * 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: * - * Min items `1`, Max items `50` + * - `usages` Returns the project and issue types that use the status in their workflow. + * - `workflowUsages` Returns the workflows that use the status. */ - id: string[]; + expand?: 'usages' | 'workflowUsages' | ('usages' | 'workflowUsages')[] | string | 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: + * The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, + * id=10000&id=10001. * - * `usages` Returns the project and issue types that use the status in their workflow. + * Min items `1`, Max items `50` */ - expand?: 'usages' | 'usages'[] | string | string[]; + id: string[]; } diff --git a/src/version2/parameters/getTrashedFieldsPaginated.ts b/src/version2/parameters/getTrashedFieldsPaginated.ts index eda7a2c0d8..a1efe766b7 100644 --- a/src/version2/parameters/getTrashedFieldsPaginated.ts +++ b/src/version2/parameters/getTrashedFieldsPaginated.ts @@ -16,13 +16,16 @@ export interface GetTrashedFieldsPaginated { */ orderBy?: | 'name' - | 'trashDate' - | 'plannedDeletionDate' - | '+name' - | '+trashDate' - | '+plannedDeletionDate' | '-name' + | '+name' + | 'trashDate' | '-trashDate' + | '+trashDate' + | 'plannedDeletionDate' | '-plannedDeletionDate' + | '+plannedDeletionDate' + | 'projectsCount' + | '-projectsCount' + | '+projectsCount' | string; } diff --git a/src/version2/parameters/getUser.ts b/src/version2/parameters/getUser.ts index 62e4cff3e1..f5435dab67 100644 --- a/src/version2/parameters/getUser.ts +++ b/src/version2/parameters/getUser.ts @@ -4,18 +4,6 @@ export interface GetUser { * _5b10ac8d82e05b22cc7d4ef5_. Required. */ accountId?: string; - /** - * This parameter is no longer available. See the [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide) - * for details. - */ - username?: string; - /** - * This parameter is no longer available. See the [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide) - * for details. - */ - key?: string; /** * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#expansion) to include additional * information about users in the response. This parameter accepts a comma-separated list. Expand options include: @@ -23,14 +11,5 @@ export interface GetUser { * - `groups` includes all groups and nested groups to which the user belongs. * - `applicationRoles` includes details of all the applications to which the user has access. */ - expand?: 'groups' | 'applicationRoles' | string | string[] | GetUser.Expand | GetUser.Expand[]; -} - -export namespace GetUser { - export enum Expand { - /** Includes all groups and nested groups to which the user belongs. */ - Groups = 'groups', - /** Includes details of all the applications to which the user has access. */ - ApplicationRoles = 'applicationRoles', - } + expand?: 'groups' | 'applicationRoles' | ('groups' | 'applicationRoles')[] | string | string[]; } diff --git a/src/version2/parameters/getVersion.ts b/src/version2/parameters/getVersion.ts index 2057c4f7b4..de8614e157 100644 --- a/src/version2/parameters/getVersion.ts +++ b/src/version2/parameters/getVersion.ts @@ -9,6 +9,15 @@ export interface GetVersion { * - `issuesstatus` Returns the count of issues in this version for each of the status categories _to do_, _in * progress_, _done_, and _unmapped_. The _unmapped_ property represents the number of issues with a status other * than _to do_, _in progress_, and _done_. + * - `driver` Returns the Atlassian account ID of the version driver. + * - `approvers` Returns a list containing the Atlassian account IDs of approvers for this version. */ - expand?: 'operations' | 'issuesstatus' | ('operations' | 'issuesstatus')[] | string | string[]; + expand?: + | 'operations' + | 'issuesstatus' + | 'driver' + | 'approvers' + | ('operations' | 'issuesstatus' | 'driver' | 'approvers')[] + | string + | string[]; } diff --git a/src/version2/parameters/getWorkflowTransitionProperties.ts b/src/version2/parameters/getWorkflowTransitionProperties.ts index 1a4290c635..fbfb681220 100644 --- a/src/version2/parameters/getWorkflowTransitionProperties.ts +++ b/src/version2/parameters/getWorkflowTransitionProperties.ts @@ -17,5 +17,5 @@ export interface GetWorkflowTransitionProperties { /** The name of the workflow that the transition belongs to. */ workflowName: string; /** The workflow status. Set to _live_ for active and inactive workflows, or _draft_ for draft workflows. */ - workflowMode?: string; + workflowMode?: 'live' | 'draft' | string; } diff --git a/src/version2/parameters/getWorkflowTransitionRuleConfigurations.ts b/src/version2/parameters/getWorkflowTransitionRuleConfigurations.ts index 3a02fc3bff..8b4780f059 100644 --- a/src/version2/parameters/getWorkflowTransitionRuleConfigurations.ts +++ b/src/version2/parameters/getWorkflowTransitionRuleConfigurations.ts @@ -4,19 +4,22 @@ export interface GetWorkflowTransitionRuleConfigurations { /** The maximum number of items to return per page. */ maxResults?: number; /** The types of the transition rules to return. */ - types: string[]; - /** The transition rule class keys, as defined in the Connect app descriptor, of the transition rules to return. */ + types: ('postfunction' | 'condition' | 'validator' | string)[]; + /** + * The transition rule class keys, as defined in the Connect or the Forge app descriptor, of the transition rules to + * return. + */ keys?: string[]; - /** EXPERIMENTAL: The list of workflow names to filter by. */ + /** The list of workflow names to filter by. */ workflowNames?: string[]; - /** EXPERIMENTAL: The list of `tags` to filter by. */ + /** The list of `tags` to filter by. */ withTags?: string[]; - /** EXPERIMENTAL: Whether draft or published workflows are returned. If not provided, both workflow types are returned. */ + /** Whether draft or published workflows are returned. If not provided, both workflow types are returned. */ draft?: boolean; /** * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#expansion) to include additional * information in the response. This parameter accepts `transition`, which, for each rule, returns information about * the transition the rule is assigned to. */ - expand?: string; + expand?: 'transition' | string; } diff --git a/src/version2/parameters/getWorkflowsPaginated.ts b/src/version2/parameters/getWorkflowsPaginated.ts index e07b012d88..bf65a2fde8 100644 --- a/src/version2/parameters/getWorkflowsPaginated.ts +++ b/src/version2/parameters/getWorkflowsPaginated.ts @@ -22,6 +22,10 @@ export interface GetWorkflowsPaginated { * automatically if this expand is requested. * - `default` For each workflow, returns information about whether this is the default workflow. * - `schemes` For each workflow, returns information about the workflow schemes the workflow is assigned to. + * - `projects` For each workflow, returns information about the projects the workflow is assigned to, through workflow + * schemes. + * - `hasDraftWorkflow` For each workflow, returns information about whether the workflow has a draft version. + * - `operations` For each workflow, returns information about the actions that can be undertaken on the workflow. */ expand?: | 'transitions' @@ -31,6 +35,9 @@ export interface GetWorkflowsPaginated { | 'statuses.properties' | 'default' | 'schemes' + | 'projects' + | 'hasDraftWorkflow' + | 'operations' | ( | 'transitions' | 'transitions.rules' @@ -39,6 +46,9 @@ export interface GetWorkflowsPaginated { | 'statuses.properties' | 'default' | 'schemes' + | 'projects' + | 'hasDraftWorkflow' + | 'operations' )[] | string | string[]; @@ -53,13 +63,13 @@ export interface GetWorkflowsPaginated { */ orderBy?: | 'name' - | 'created' - | 'updated' + | '-name' | '+name' + | 'created' + | '-created' | '+created' + | 'updated' | '+updated' - | '-name' - | '-created' | '-updated' | string; /** Filters active and inactive workflows. */ diff --git a/src/version2/parameters/index.ts b/src/version2/parameters/index.ts index 8e4ef6ec6f..a008d2208b 100644 --- a/src/version2/parameters/index.ts +++ b/src/version2/parameters/index.ts @@ -5,7 +5,6 @@ export * from './addFieldToDefaultScreen'; export * from './addGadget'; export * from './addIssueTypesToContext'; export * from './addIssueTypesToIssueTypeScheme'; -export * from './addNotifications'; export * from './addProjectRoleActorsToRole'; export * from './addScreenTab'; export * from './addScreenTabField'; @@ -29,7 +28,6 @@ export * from './assignPermissionScheme'; export * from './assignProjectsToCustomFieldContext'; export * from './assignSchemeToProject'; export * from './associateSchemesToProjects'; -export * from './associateSchemeWithProject'; export * from './bulkDeleteIssueProperty'; export * from './bulkEditDashboards'; export * from './bulkGetGroups'; @@ -45,14 +43,12 @@ export * from './createComponent'; export * from './createCustomField'; export * from './createCustomFieldContext'; export * from './createCustomFieldOption'; -export * from './createCustomFieldOptions'; export * from './createDashboard'; export * from './createFieldConfiguration'; export * from './createFieldConfigurationScheme'; export * from './createFilter'; export * from './createGroup'; export * from './createIssue'; -export * from './createIssueAdjustment'; export * from './createIssueFieldOption'; export * from './createIssueLinkType'; export * from './createIssues'; @@ -104,7 +100,6 @@ export * from './deleteFieldConfigurationScheme'; export * from './deleteFilter'; export * from './deleteInactiveWorkflow'; export * from './deleteIssue'; -export * from './deleteIssueAdjustment'; export * from './deleteIssueFieldOption'; export * from './deleteIssueLink'; export * from './deleteIssueLinkType'; @@ -116,7 +111,6 @@ export * from './deleteIssueTypeScreenScheme'; export * from './deleteNotificationScheme'; export * from './deletePermissionScheme'; export * from './deletePermissionSchemeEntity'; -export * from './deletePriority'; export * from './deleteProject'; export * from './deleteProjectAsynchronously'; export * from './deleteProjectAvatar'; @@ -134,7 +128,6 @@ export * from './deleteSharePermission'; export * from './deleteStatusesById'; export * from './deleteUiModification'; export * from './deleteUserProperty'; -export * from './deleteVersion'; export * from './deleteWebhookById'; export * from './deleteWorkflowMapping'; export * from './deleteWorkflowScheme'; @@ -174,14 +167,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 './getAllUsers'; export * from './getAllUsersDefault'; -export * from './getAllWorkflows'; export * from './getAllWorkflowSchemes'; export * from './getAlternativeIssueTypes'; export * from './getApplicationProperty'; @@ -209,7 +200,6 @@ export * from './getCommentsByIds'; export * from './getComponent'; export * from './getComponentRelatedIssues'; export * from './getContextsForField'; -export * from './getContextsForFieldDeprecated'; export * from './getCreateIssueMeta'; export * from './getCurrentUser'; export * from './getCustomFieldConfiguration'; @@ -234,14 +224,11 @@ export * from './getFieldConfigurationSchemeMappings'; export * from './getFieldConfigurationSchemeProjectMapping'; export * from './getFieldsPaginated'; export * from './getFilter'; -export * from './getFilters'; export * from './getFiltersPaginated'; -export * from './getGroup'; export * from './getHierarchy'; export * from './getIdsOfWorklogsDeletedSince'; export * from './getIdsOfWorklogsModifiedSince'; export * from './getIssue'; -export * from './getIssueAdjustments'; export * from './getIssueFieldOption'; export * from './getIssueLink'; export * from './getIssueLinkType'; @@ -271,7 +258,6 @@ export * from './getNotificationSchemeForProject'; export * from './getNotificationSchemes'; export * from './getNotificationSchemeToProjectMappings'; export * from './getOptionsForContext'; -export * from './getOptionsForField'; export * from './getPermissionScheme'; export * from './getPermissionSchemeGrant'; export * from './getPermissionSchemeGrants'; @@ -300,7 +286,6 @@ export * from './getProjectVersionsPaginated'; export * from './getRecent'; export * from './getRemoteIssueLinkById'; export * from './getRemoteIssueLinks'; -export * from './getResolution'; export * from './getScreens'; export * from './getScreenSchemes'; export * from './getScreensForField'; @@ -316,7 +301,6 @@ export * from './getStatusesById'; export * from './getTask'; export * from './getTransitions'; export * from './getTrashedFieldsPaginated'; -export * from './getTrashedFieldsPaginated'; export * from './getUiModifications'; export * from './getUser'; export * from './getUserDefaultColumns'; @@ -417,7 +401,6 @@ export * from './setFavouriteForFilter'; export * from './setFieldConfigurationSchemeMapping'; export * from './setIssueProperty'; export * from './setIssueTypeProperty'; -export * from './setLocale'; export * from './setPreference'; export * from './setProjectProperty'; export * from './setSharedTimeTrackingConfiguration'; @@ -432,12 +415,10 @@ export * from './trashCustomField'; export * from './unarchiveIssues'; export * from './updateComment'; export * from './updateComponent'; -export * from './updateComponent'; export * from './updateCustomField'; export * from './updateCustomFieldConfiguration'; export * from './updateCustomFieldContext'; export * from './updateCustomFieldOption'; -export * from './updateCustomFieldOptions'; export * from './updateCustomFieldValue'; export * from './updateDashboard'; export * from './updateDefaultScreenScheme'; @@ -450,7 +431,6 @@ export * from './updateFieldConfigurationItems'; export * from './updateFieldConfigurationScheme'; export * from './updateFilter'; export * from './updateGadget'; -export * from './updateIssueAdjustment'; export * from './updateIssueFieldOption'; export * from './updateIssueFields'; export * from './updateIssueLinkType'; @@ -467,7 +447,6 @@ export * from './updateProject'; export * from './updateProjectAvatar'; export * from './updateProjectCategory'; export * from './updateProjectEmail'; -export * from './updateProjectType'; export * from './updateRemoteIssueLink'; export * from './updateResolution'; export * from './updateScreen'; diff --git a/src/version2/parameters/parseJqlQueries.ts b/src/version2/parameters/parseJqlQueries.ts index 7ad538c5ae..13445147e3 100644 --- a/src/version2/parameters/parseJqlQueries.ts +++ b/src/version2/parameters/parseJqlQueries.ts @@ -4,9 +4,10 @@ export interface ParseJqlQueries extends JqlQueriesToParse { /** * How to validate the JQL query and treat the validation results. Validation options include: * - * `strict` Returns all errors. If validation fails, the query structure is not returned. `warn` Returns all errors. - * If validation fails but the JQL query is correctly formed, the query structure is returned. `none` No validation is - * performed. If JQL query is correctly formed, the query structure is returned. + * - `strict` Returns all errors. If validation fails, the query structure is not returned. + * - `warn` Returns all errors. If validation fails but the JQL query is correctly formed, the query structure is + * returned. + * - `none` No validation is performed. If JQL query is correctly formed, the query structure is returned. */ - validation?: string; + validation?: 'strict' | 'warn' | 'none' | string; } diff --git a/src/version2/parameters/putAddonProperty.ts b/src/version2/parameters/putAddonProperty.ts index b0028afd94..f1be24ac61 100644 --- a/src/version2/parameters/putAddonProperty.ts +++ b/src/version2/parameters/putAddonProperty.ts @@ -4,7 +4,4 @@ export interface PutAddonProperty { /** The key of the property. */ propertyKey: string; propertyValue: any; - - /** @deprecated */ - property: any; } diff --git a/src/version2/parameters/removeGroup.ts b/src/version2/parameters/removeGroup.ts index a4da4bd249..a33bfbc5cf 100644 --- a/src/version2/parameters/removeGroup.ts +++ b/src/version2/parameters/removeGroup.ts @@ -4,10 +4,7 @@ export interface RemoveGroup { * parameter cannot be used with the `groupId` parameter. */ groupname?: string; - /** - * The ID of the group. This parameter cannot be used with the `groupId` parameter. This parameter cannot be used with - * the `groupName` parameter. - */ + /** The ID of the group. This parameter cannot be used with the `groupname` parameter. */ groupId?: string; /** * As a group's name can change, use of `swapGroupId` is recommended to identify a group. The group to transfer diff --git a/src/version2/parameters/removeWatcher.ts b/src/version2/parameters/removeWatcher.ts index 41ef5c5b07..ed174aef02 100644 --- a/src/version2/parameters/removeWatcher.ts +++ b/src/version2/parameters/removeWatcher.ts @@ -1,12 +1,6 @@ export interface RemoveWatcher { /** The ID or key of the issue. */ issueIdOrKey: string; - /** - * @deprecated This parameter is no longer available. See the [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - username?: string; /** * The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, * _5b10ac8d82e05b22cc7d4ef5_. Required. diff --git a/src/version2/parameters/replaceIssueFieldOption.ts b/src/version2/parameters/replaceIssueFieldOption.ts index 8488c1014a..f184891952 100644 --- a/src/version2/parameters/replaceIssueFieldOption.ts +++ b/src/version2/parameters/replaceIssueFieldOption.ts @@ -4,13 +4,13 @@ export interface ReplaceIssueFieldOption { /** A JQL query that specifies the issues to be updated. For example, _project=10000_. */ jql?: string; /** - * Whether screen security is overridden to enable hidden fields to be edited. Available to Connect app users with - * admin permission and Forge app users with the `manage:jira-configuration` scope. + * Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app + * users with admin permission. */ overrideScreenSecurity?: boolean; /** - * Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with - * admin permission and Forge app users with the `manage:jira-configuration` scope. + * Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app + * users with _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ overrideEditableFlag?: boolean; /** diff --git a/src/version2/parameters/search.ts b/src/version2/parameters/search.ts index 34af4bd037..d704f138de 100644 --- a/src/version2/parameters/search.ts +++ b/src/version2/parameters/search.ts @@ -3,9 +3,10 @@ export interface Search { * 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: * - * `usages` Returns the project and issue types that use the status in their workflow. + * - `usages` Returns the project and issue types that use the status in their workflow. + * - `workflowUsages` Returns the workflows that use the status. */ - expand?: 'usages' | 'usages'[] | string | string[]; + expand?: 'usages' | 'workflowUsages' | ('usages' | 'workflowUsages')[] | string | string[]; /** The project the status is part of or null for global statuses. */ projectId?: string; /** The index of the first item to return in a page of results (page offset). */ diff --git a/src/version2/parameters/searchForIssuesUsingJql.ts b/src/version2/parameters/searchForIssuesUsingJql.ts index 07a87443f9..9670c1d437 100644 --- a/src/version2/parameters/searchForIssuesUsingJql.ts +++ b/src/version2/parameters/searchForIssuesUsingJql.ts @@ -18,13 +18,13 @@ export interface SearchForIssuesUsingJql { /** * Determines how to validate the JQL query and treat the validation results. Supported values are: * - * `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings). - * `warn` Returns all errors as warnings. `none` No validation is performed. `true` _Deprecated_ A legacy synonym for - * `strict`. `false` _Deprecated_ A legacy synonym for `warn`. + * - `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings). + * - `warn` Returns all errors as warnings. `none` No validation is performed. `true` _Deprecated_ A legacy synonym for + * - `strict`. `false` _Deprecated_ A legacy synonym for `warn`. * * Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value. */ - validateQuery?: string; + validateQuery?: 'strict' | 'warn' | 'none' | string; /** * 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: @@ -47,14 +47,27 @@ export interface SearchForIssuesUsingJql { * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#expansion) to include additional * information about issues in the response. This parameter accepts a comma-separated list. Expand options include: * - * `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. + * - `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. */ - expand?: string; + expand?: + | 'renderedFields' + | 'names' + | 'schema' + | 'transitions' + | 'operations' + | 'editmeta' + | 'changelog' + | 'versionedRepresentations' + | string + | string[]; /** * A list of issue property keys for issue properties to include in the results. This parameter accepts a * comma-separated list. Multiple properties can also be provided using an ampersand separated list. For example, diff --git a/src/version2/parameters/searchPriorities.ts b/src/version2/parameters/searchPriorities.ts index 58ab0a017c..8e1dae180c 100644 --- a/src/version2/parameters/searchPriorities.ts +++ b/src/version2/parameters/searchPriorities.ts @@ -7,7 +7,7 @@ export interface SearchPriorities { id?: string[]; /** * The list of projects IDs. To include multiple IDs, provide an ampersand-separated list. For example, - * `projectid=10010&projectid=10111`. + * `projectId=10010&projectId=10111`. */ projectId?: string[]; /** Whether only the default priority is returned. */ diff --git a/src/version2/parameters/searchProjects.ts b/src/version2/parameters/searchProjects.ts index 1565749fe4..f807c8c1ed 100644 --- a/src/version2/parameters/searchProjects.ts +++ b/src/version2/parameters/searchProjects.ts @@ -16,7 +16,32 @@ export interface SearchProjects { * - `archivedDate` EXPERIMENTAL. Sorts by project archived date. * - `deletedDate` EXPERIMENTAL. Sorts by project deleted date. */ - orderBy?: string; + orderBy?: + | 'category' + | '-category' + | '+category' + | 'key' + | '-key' + | '+key' + | 'name' + | '-name' + | '+name' + | 'owner' + | '-owner' + | '+owner' + | 'issueCount' + | '-issueCount' + | '+issueCount' + | 'lastIssueUpdatedDate' + | '-lastIssueUpdatedDate' + | '+lastIssueUpdatedDate' + | 'archivedDate' + | '+archivedDate' + | '-archivedDate' + | 'deletedDate' + | '+deletedDate' + | '-deletedDate' + | string; /** * The project IDs to filter the results by. To include multiple IDs, provide an ampersand-separated list. For * example, `id=10000&id=10001`. Up to 50 project IDs can be provided. @@ -55,9 +80,11 @@ export interface SearchProjects { * project, meaning that they have one of the following permissions: * * _Administer projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. _Administer - * Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). + * Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). `create` the project, meaning that they have + * the _Create issues_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the + * issue is created. */ - action?: string; + action?: 'view' | 'browse' | 'edit' | 'create' | 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. Expanded options include: @@ -83,10 +110,11 @@ export interface SearchProjects { /** * EXPERIMENTAL. Filter results by project status: * - * `live` Search live projects. `archived` Search archived projects. `deleted` Search deleted projects, those in the - * recycle bin. + * - `live` Search live projects. + * - `archived` Search archived projects. + * - `deleted` Search deleted projects, those in the recycle bin. */ - status?: string[]; + status?: ('live' | 'archived' | 'deleted' | string)[]; /** * EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated * list. diff --git a/src/version2/parameters/setDashboardItemProperty.ts b/src/version2/parameters/setDashboardItemProperty.ts index 7bf80be519..74623a28f4 100644 --- a/src/version2/parameters/setDashboardItemProperty.ts +++ b/src/version2/parameters/setDashboardItemProperty.ts @@ -3,7 +3,11 @@ export interface SetDashboardItemProperty { dashboardId: string; /** The ID of the dashboard item. */ itemId: string; - /** The key of the dashboard item property. The maximum length is 255 characters. */ + /** + * The key of the dashboard item property. The maximum length is 255 characters. For dashboard items with a spec URI + * and no complete module key, if the provided propertyKey is equal to "config", the request body's JSON must be an + * object with all keys and values as strings. + */ propertyKey: string; - body?: any; + propertyValue: any; } diff --git a/src/version2/parameters/setIssueTypeProperty.ts b/src/version2/parameters/setIssueTypeProperty.ts index c934c63133..23290f43a6 100644 --- a/src/version2/parameters/setIssueTypeProperty.ts +++ b/src/version2/parameters/setIssueTypeProperty.ts @@ -3,5 +3,5 @@ export interface SetIssueTypeProperty { issueTypeId: string; /** The key of the issue type property. The maximum length is 255 characters. */ propertyKey: string; - body: any; + propertyValue: any; } diff --git a/src/version2/parameters/setLocale.ts b/src/version2/parameters/setLocale.ts deleted file mode 100644 index b4a9b9c8b2..0000000000 --- a/src/version2/parameters/setLocale.ts +++ /dev/null @@ -1,3 +0,0 @@ -import { Locale } from '../models'; - -export interface SetLocale extends Locale {} diff --git a/src/version2/parameters/setProjectProperty.ts b/src/version2/parameters/setProjectProperty.ts index 19b2e74f86..518b1d3e9e 100644 --- a/src/version2/parameters/setProjectProperty.ts +++ b/src/version2/parameters/setProjectProperty.ts @@ -1,7 +1,7 @@ export interface SetProjectProperty { - /** The project ID or project key (case-sensitive). */ + /** The project ID or project key (case sensitive). */ projectIdOrKey: string; /** The key of the project property. The maximum length is 255 characters. */ propertyKey: string; - property: any; + propertyValue: any; } diff --git a/src/version2/parameters/setUserProperty.ts b/src/version2/parameters/setUserProperty.ts index 2bd7348395..38ad1931f4 100644 --- a/src/version2/parameters/setUserProperty.ts +++ b/src/version2/parameters/setUserProperty.ts @@ -4,20 +4,6 @@ export interface SetUserProperty { * _5b10ac8d82e05b22cc7d4ef5_. */ accountId?: string; - /** - * @deprecated This parameter is no longer available and will be removed from the documentation soon. See the - * [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - userKey?: string; - /** - * @deprecated This parameter is no longer available and will be removed from the documentation soon. See the - * [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - username?: string; /** The key of the user's property. The maximum length is 255 characters. */ propertyKey: string; propertyValue: any; diff --git a/src/version2/parameters/setWorkflowSchemeDraftIssueType.ts b/src/version2/parameters/setWorkflowSchemeDraftIssueType.ts index 8eda013e4f..37f76bf01a 100644 --- a/src/version2/parameters/setWorkflowSchemeDraftIssueType.ts +++ b/src/version2/parameters/setWorkflowSchemeDraftIssueType.ts @@ -7,7 +7,7 @@ export interface SetWorkflowSchemeDraftIssueType extends IssueTypeWorkflowMappin issueType: string; /** Details about the mapping between an issue type and a workflow. */ - body?: { + details: { /** The ID of the issue type. Not required if updating the issue type-workflow mapping. */ issueType?: string; /** The name of the workflow. */ diff --git a/src/version2/parameters/setWorkflowSchemeIssueType.ts b/src/version2/parameters/setWorkflowSchemeIssueType.ts index 6a2200df02..a0896d190c 100644 --- a/src/version2/parameters/setWorkflowSchemeIssueType.ts +++ b/src/version2/parameters/setWorkflowSchemeIssueType.ts @@ -7,7 +7,7 @@ export interface SetWorkflowSchemeIssueType extends IssueTypeWorkflowMapping { issueType: string; /** Details about the mapping between an issue type and a workflow. */ - body?: { + details: { /** The ID of the issue type. Not required if updating the issue type-workflow mapping. */ issueType?: string; diff --git a/src/version2/parameters/storeAvatar.ts b/src/version2/parameters/storeAvatar.ts index 7bbf800cef..b9f98e0b99 100644 --- a/src/version2/parameters/storeAvatar.ts +++ b/src/version2/parameters/storeAvatar.ts @@ -1,6 +1,6 @@ export interface StoreAvatar { /** The avatar type. */ - type: string; + type: 'project' | 'issuetype' | string; /** The ID of the item the avatar is associated with. */ entityId: string; /** The X coordinate of the top-left corner of the crop region. */ @@ -9,4 +9,5 @@ export interface StoreAvatar { y?: number; /** The length of each side of the crop region. */ size: number; + avatar: any; } diff --git a/src/version2/parameters/updateComment.ts b/src/version2/parameters/updateComment.ts index e25b957276..ab97803431 100644 --- a/src/version2/parameters/updateComment.ts +++ b/src/version2/parameters/updateComment.ts @@ -5,12 +5,12 @@ export interface UpdateComment extends Comment { issueIdOrKey: string; /** The ID of the comment. */ id: string; - /** Set to false to stop users being notified that a comment is updated */ + /** Whether users are notified when a comment is updated. */ notifyUsers?: boolean; /** * Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with - * the Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global - * permission. + * the _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on + * behalf of users with _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ overrideEditableFlag?: boolean; /** diff --git a/src/version2/parameters/updateCustomFieldOptions.ts b/src/version2/parameters/updateCustomFieldOptions.ts deleted file mode 100644 index 88969780f0..0000000000 --- a/src/version2/parameters/updateCustomFieldOptions.ts +++ /dev/null @@ -1,9 +0,0 @@ -import { UpdateCustomFieldOption } from '../models'; - -export interface UpdateCustomFieldOptions extends UpdateCustomFieldOption { - /** - * The ID of the custom field. Note: This is the numeric part of the of the field ID. For example, for a field with - * the ID _customfield_10075_ use _10075_. - */ - fieldId: number; -} diff --git a/src/version2/parameters/updateEntityPropertiesValue.ts b/src/version2/parameters/updateEntityPropertiesValue.ts index 6617855ed6..7bcf23f921 100644 --- a/src/version2/parameters/updateEntityPropertiesValue.ts +++ b/src/version2/parameters/updateEntityPropertiesValue.ts @@ -6,10 +6,17 @@ export interface UpdateEntityPropertiesValue { /** The Atlassian account ID of the impersonated user. This user must be a member of the site admin group. */ accountId: string; /** The type indicating the object that contains the entity properties. */ - entityType: string; - - /** @deprecated Use `entities` instead. */ - body?: Array; + entityType: + | 'IssueProperty' + | 'CommentProperty' + | 'DashboardItemProperty' + | 'IssueTypeProperty' + | 'ProjectProperty' + | 'UserProperty' + | 'WorklogProperty' + | 'BoardProperty' + | 'SprintProperty' + | string; entities?: Array; } diff --git a/src/version2/parameters/updateIssueAdjustment.ts b/src/version2/parameters/updateIssueAdjustment.ts deleted file mode 100644 index 753794d35d..0000000000 --- a/src/version2/parameters/updateIssueAdjustment.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { UpdateIssueAdjustmentDetails } from '../models'; - -export interface UpdateIssueAdjustment extends UpdateIssueAdjustmentDetails { - /** The ID of the issue adjustment. */ - issueAdjustmentId: string; -} diff --git a/src/version2/parameters/updateProject.ts b/src/version2/parameters/updateProject.ts index 0e0fc26159..71b7c0de4a 100644 --- a/src/version2/parameters/updateProject.ts +++ b/src/version2/parameters/updateProject.ts @@ -1,7 +1,7 @@ import { UpdateProjectDetails } from '../models'; export interface UpdateProject extends UpdateProjectDetails { - /** The project ID or project key (case-sensitive). */ + /** The project ID or project key (case sensitive). */ projectIdOrKey: string; /** * The [project diff --git a/src/version2/parameters/updateProjectType.ts b/src/version2/parameters/updateProjectType.ts deleted file mode 100644 index 918f1985bd..0000000000 --- a/src/version2/parameters/updateProjectType.ts +++ /dev/null @@ -1,6 +0,0 @@ -export interface UpdateProjectType { - /** The project ID or project key (case sensitive). */ - projectIdOrKey: string; - /** The key of the new project type. */ - newProjectTypeKey: string; -} diff --git a/src/version2/parameters/updateWorklog.ts b/src/version2/parameters/updateWorklog.ts index 3abc6d8457..aa231369bd 100644 --- a/src/version2/parameters/updateWorklog.ts +++ b/src/version2/parameters/updateWorklog.ts @@ -10,11 +10,12 @@ export interface UpdateWorklog extends Worklog { /** * Defines how to update the issue's time estimate, the options are: * - * `new` Sets the estimate to a specific value, defined in `newEstimate`. `leave` Leaves the estimate unchanged. - * `auto` Updates the estimate by the difference between the original and updated value of `timeSpent` or - * `timeSpentSeconds`. + * - `new` Sets the estimate to a specific value, defined in `newEstimate`. + * - `leave` Leaves the estimate unchanged. + * - `auto` Updates the estimate by the difference between the original and updated value of `timeSpent` or + * `timeSpentSeconds`. */ - adjustEstimate?: string; + adjustEstimate?: 'new' | 'leave' | 'manual' | 'auto' | string; /** * The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For * example, _2d_. Required when `adjustEstimate` is `new`. @@ -27,8 +28,8 @@ export interface UpdateWorklog extends Worklog { expand?: string; /** * Whether the worklog should be added to the issue even if the issue is not editable. For example, because the issue - * is closed. Connect app users with admin permission and Forge app users with the `manage:jira-configuration` scope - * can use this flag. + * is closed. Connect and Forge app users with _Administer Jira_ [global + * permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag. */ overrideEditableFlag?: boolean; } diff --git a/src/version2/projectProperties.ts b/src/version2/projectProperties.ts index 0972a7ee9a..d5bba9ec15 100644 --- a/src/version2/projectProperties.ts +++ b/src/version2/projectProperties.ts @@ -127,7 +127,7 @@ export class ProjectProperties { const config: RequestConfig = { url: `/rest/api/2/project/${parameters.projectIdOrKey}/properties/${parameters.propertyKey}`, method: 'PUT', - data: parameters.property, + data: parameters.propertyValue, }; return this.client.sendRequest(config, callback); diff --git a/src/version2/projectVersions.ts b/src/version2/projectVersions.ts index f8a2421536..4db643ba64 100644 --- a/src/version2/projectVersions.ts +++ b/src/version2/projectVersions.ts @@ -142,7 +142,6 @@ export class ProjectVersions { overdue: parameters.overdue, userStartDate: parameters.userStartDate, userReleaseDate: parameters.userReleaseDate, - project: parameters.project, projectId: parameters.projectId, moveUnfixedIssuesTo: parameters.moveUnfixedIssuesTo, operations: parameters.operations, @@ -226,7 +225,6 @@ export class ProjectVersions { released: parameters.released, startDate: parameters.startDate, releaseDate: parameters.releaseDate, - project: parameters.project, projectId: parameters.projectId, moveUnfixedIssuesTo: parameters.moveUnfixedIssuesTo, }, @@ -235,45 +233,6 @@ export class ProjectVersions { return this.client.sendRequest(config, callback); } - /** - * Deletes a project version. - * - * @deprecated Use [Delete and replace version](#api-rest-api-2-version-id-removeAndSwap-post) that supports swapping - * version values in custom fields, in addition to the swapping for `fixVersion` and `affectedVersion` provided in - * this resource. Alternative versions can be provided to update issues that use the deleted version in `fixVersion` - * or `affectedVersion`. If alternatives are not provided, occurrences of `fixVersion` and `affectedVersion` that - * contain the deleted version are cleared. This operation can be accessed anonymously. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ - * [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version. - */ - async deleteVersion(parameters: Parameters.DeleteVersion, callback: Callback): Promise; - /** - * Deletes a project version. - * - * @deprecated Use [Delete and replace version](#api-rest-api-2-version-id-removeAndSwap-post) that supports swapping - * version values in custom fields, in addition to the swapping for `fixVersion` and `affectedVersion` provided in - * this resource. Alternative versions can be provided to update issues that use the deleted version in `fixVersion` - * or `affectedVersion`. If alternatives are not provided, occurrences of `fixVersion` and `affectedVersion` that - * contain the deleted version are cleared. This operation can be accessed anonymously. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ - * [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the version. - */ - async deleteVersion(parameters: Parameters.DeleteVersion, callback?: never): Promise; - async deleteVersion(parameters: Parameters.DeleteVersion, callback?: Callback): Promise { - const config: RequestConfig = { - url: `/rest/api/2/version/${parameters.id}`, - method: 'DELETE', - params: { - moveFixIssuesTo: parameters.moveFixIssuesTo, - moveAffectedIssuesTo: parameters.moveAffectedIssuesTo, - }, - }; - - return this.client.sendRequest(config, callback); - } - /** * Merges two project versions. The merge is completed by deleting the version specified in `id` and replacing any * occurrences of its ID in `fixVersion` with the version ID specified in `moveIssuesTo`. diff --git a/src/version2/projects.ts b/src/version2/projects.ts index 2ad2d092b7..0ad37105c4 100644 --- a/src/version2/projects.ts +++ b/src/version2/projects.ts @@ -7,44 +7,6 @@ import { RequestConfig } from '../requestConfig'; export class Projects { constructor(private client: Client) {} - /** - * @deprecated Returns all projects visible to the user. Deprecated, use [ Get projects - * paginated](#api-rest-api-2-project-search-get) that supports search and pagination. This operation can be - * accessed anonymously. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * Projects are returned only where the user has _Browse Projects_ or _Administer projects_ [project - * permission](https://confluence.atlassian.com/x/yodKLg) for the project. - */ - async getAllProjects( - parameters: Parameters.GetAllProjects | undefined, - callback: Callback, - ): Promise; - /** - * @deprecated Returns all projects visible to the user. Deprecated, use [ Get projects - * paginated](#api-rest-api-2-project-search-get) that supports search and pagination. This operation can be - * accessed anonymously. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * Projects are returned only where the user has _Browse Projects_ or _Administer projects_ [project - * permission](https://confluence.atlassian.com/x/yodKLg) for the project. - */ - async getAllProjects(parameters?: Parameters.GetAllProjects, callback?: never): Promise; - async getAllProjects( - parameters?: Parameters.GetAllProjects, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: '/rest/api/2/project', - method: 'GET', - params: { - expand: parameters?.expand, - recent: parameters?.recent, - properties: parameters?.properties, - }, - }; - - return this.client.sendRequest(config, callback); - } - /** * Creates a project based on a project type template, as shown in the following table: * @@ -116,7 +78,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, @@ -311,7 +272,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, @@ -514,39 +474,6 @@ export class Projects { return this.client.sendRequest(config, callback); } - /** - * @deprecated This feature is no longer supported and no alternatives are available, see [Convert project to a - * different template or type](https://confluence.atlassian.com/x/yEKeOQ). Updates a [project - * type](https://confluence.atlassian.com/x/GwiiLQ). The project type can be updated for classic projects only, - * project type cannot be updated for next-gen projects. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async updateProjectType( - parameters: Parameters.UpdateProjectType, - callback: Callback, - ): Promise; - /** - * @deprecated This feature is no longer supported and no alternatives are available, see [Convert project to a - * different template or type](https://confluence.atlassian.com/x/yEKeOQ). Updates a [project - * type](https://confluence.atlassian.com/x/GwiiLQ). The project type can be updated for classic projects only, - * project type cannot be updated for next-gen projects. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async updateProjectType(parameters: Parameters.UpdateProjectType, callback?: never): Promise; - async updateProjectType( - parameters: Parameters.UpdateProjectType, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: `/rest/api/2/project/${parameters.projectIdOrKey}/type/${parameters.newProjectTypeKey}`, - method: 'PUT', - }; - - return this.client.sendRequest(config, callback); - } - /** * Get the issue type hierarchy for a next-gen project. * diff --git a/src/version2/userProperties.ts b/src/version2/userProperties.ts index b87f6dddbc..c4a1b1f94c 100644 --- a/src/version2/userProperties.ts +++ b/src/version2/userProperties.ts @@ -138,8 +138,6 @@ export class UserProperties { method: 'PUT', params: { accountId: parameters.accountId, - userKey: parameters.userKey, - username: parameters.username, }, data: parameters.propertyValue, }; diff --git a/src/version2/userSearch.ts b/src/version2/userSearch.ts index d668071d93..9d7a4ca6dc 100644 --- a/src/version2/userSearch.ts +++ b/src/version2/userSearch.ts @@ -293,7 +293,6 @@ export class UserSearch { query: parameters.query, maxResults: parameters.maxResults, showAvatar: parameters.showAvatar, - exclude: parameters.exclude, excludeAccountIds: paramSerializer('excludeAccountIds', parameters.excludeAccountIds), avatarSize: parameters.avatarSize, excludeConnectUsers: parameters.excludeConnectUsers, diff --git a/src/version2/users.ts b/src/version2/users.ts index 773b829ce1..623d7be9b0 100644 --- a/src/version2/users.ts +++ b/src/version2/users.ts @@ -36,8 +36,6 @@ export class Users { method: 'GET', params: { accountId: parameters?.accountId, - username: parameters?.username, - key: parameters?.key, expand: parameters?.expand, }, }; @@ -72,8 +70,6 @@ export class Users { url: '/rest/api/2/user', method: 'POST', data: { - applicationKeys: parameters.applicationKeys, - displayName: parameters.displayName, emailAddress: parameters.emailAddress, key: parameters.key, name: parameters.name, @@ -142,8 +138,6 @@ export class Users { params: { startAt: parameters.startAt, maxResults: parameters.maxResults, - username: parameters.username, - key: parameters.key, accountId: paramSerializer('accountId', parameters.accountId), }, }; diff --git a/src/version2/workflowSchemeDrafts.ts b/src/version2/workflowSchemeDrafts.ts index 536ca984a0..2a6a38cb1b 100644 --- a/src/version2/workflowSchemeDrafts.ts +++ b/src/version2/workflowSchemeDrafts.ts @@ -333,7 +333,7 @@ export class WorkflowSchemeDrafts { const config: RequestConfig = { url: `/rest/api/2/workflowscheme/${parameters.id}/draft/issuetype/${parameters.issueType}`, method: 'PUT', - data: parameters.body, + data: parameters.details, }; return this.client.sendRequest(config, callback); diff --git a/src/version2/workflowSchemeProjectAssociations.ts b/src/version2/workflowSchemeProjectAssociations.ts index e59a472fad..cda7595756 100644 --- a/src/version2/workflowSchemeProjectAssociations.ts +++ b/src/version2/workflowSchemeProjectAssociations.ts @@ -52,34 +52,6 @@ export class WorkflowSchemeProjectAssociations { return this.client.sendRequest(config, callback); } - /** - * @deprecated Assigns a workflow scheme to a project. This operation is performed only when there are no issues in - * the project. Workflow schemes can only be assigned to classic projects. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async associateSchemeWithProject( - parameters: Parameters.AssociateSchemeWithProject | undefined, - callback: Callback, - ): Promise; - /** - * @deprecated Assigns a workflow scheme to a project. This operation is performed only when there are no issues in - * the project. Workflow schemes can only be assigned to classic projects. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async associateSchemeWithProject( - parameters?: Parameters.AssociateSchemeWithProject, - callback?: never, - ): Promise; - async associateSchemeWithProject( - parameters?: Parameters.AssociateSchemeWithProject, - callback?: Callback, - ): Promise { - // @ts-ignore - return this.assignSchemeToProject(parameters, callback); - } - /** * Assigns a workflow scheme to a project. This operation is performed only when there are no issues in the project. * diff --git a/src/version2/workflowSchemes.ts b/src/version2/workflowSchemes.ts index 864986a5cd..fa846e60fa 100644 --- a/src/version2/workflowSchemes.ts +++ b/src/version2/workflowSchemes.ts @@ -410,7 +410,7 @@ export class WorkflowSchemes { const config: RequestConfig = { url: `/rest/api/2/workflowscheme/${parameters.id}/issuetype/${parameters.issueType}`, method: 'PUT', - data: parameters.body, + data: parameters.details, }; return this.client.sendRequest(config, callback); diff --git a/src/version2/workflows.ts b/src/version2/workflows.ts index 10b5be68b8..8b2729c337 100644 --- a/src/version2/workflows.ts +++ b/src/version2/workflows.ts @@ -8,45 +8,6 @@ import { RequestConfig } from '../requestConfig'; export class Workflows { constructor(private client: Client) {} - /** - * @deprecated Returns all workflows in Jira or a workflow. Deprecated, use [Get workflows - * paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-workflows/#api-rest-api-2-workflow-search-get). - * If the `workflowName` parameter is specified, the workflow is returned as an object (not in an array). Otherwise, - * an array of workflow objects is returned. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) - * required:** _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async getAllWorkflows( - parameters: Parameters.GetAllWorkflows | undefined, - callback: Callback, - ): Promise; - /** - * @deprecated Returns all workflows in Jira or a workflow. Deprecated, use [Get workflows - * paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-workflows/#api-rest-api-2-workflow-search-get). - * If the `workflowName` parameter is specified, the workflow is returned as an object (not in an array). Otherwise, - * an array of workflow objects is returned. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async getAllWorkflows( - parameters?: Parameters.GetAllWorkflows, - callback?: never, - ): Promise; - async getAllWorkflows( - parameters?: Parameters.GetAllWorkflows, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: '/rest/api/2/workflow', - method: 'GET', - params: { - workflowName: parameters?.workflowName, - }, - }; - - return this.client.sendRequest(config, callback); - } - /** * Creates a workflow. Workflow transitions are created with the default system transition rules. * diff --git a/src/version3/appMigration.ts b/src/version3/appMigration.ts index b4a67f58ca..cbea50328c 100644 --- a/src/version3/appMigration.ts +++ b/src/version3/appMigration.ts @@ -70,7 +70,7 @@ export class AppMigration { 'Atlassian-Transfer-Id': parameters.transferId, 'Content-Type': 'application/json', }, - data: parameters.body ?? parameters.entities, + data: parameters.entities, }; return this.client.sendRequest(config, callback); diff --git a/src/version3/appProperties.ts b/src/version3/appProperties.ts index ba01d71635..9dd3e5722f 100644 --- a/src/version3/appProperties.ts +++ b/src/version3/appProperties.ts @@ -114,7 +114,7 @@ export class AppProperties { const config: RequestConfig = { url: `/rest/atlassian-connect/1/addons/${parameters.addonKey}/properties/${parameters.propertyKey}`, method: 'PUT', - data: parameters.propertyValue ?? parameters.property, + data: parameters.propertyValue, }; return this.client.sendRequest(config, callback); diff --git a/src/version3/avatars.ts b/src/version3/avatars.ts index 85926c85e1..849e211659 100644 --- a/src/version3/avatars.ts +++ b/src/version3/avatars.ts @@ -137,6 +137,7 @@ export class Avatars { y: parameters.y, size: parameters.size, }, + data: parameters.avatar, }; return this.client.sendRequest(config, callback); @@ -172,7 +173,7 @@ export class Avatars { * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** None. */ - async getAvatarImageByType( + async getAvatarImageByType( parameters: Parameters.GetAvatarImageByType | string, callback: Callback, ): Promise; @@ -183,11 +184,11 @@ export class Avatars { * * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** None. */ - async getAvatarImageByType( + async getAvatarImageByType( parameters: Parameters.GetAvatarImageByType | string, callback?: never, ): Promise; - async getAvatarImageByType( + async getAvatarImageByType( parameters: Parameters.GetAvatarImageByType | string, callback?: Callback, ): Promise { @@ -196,13 +197,21 @@ export class Avatars { const config: RequestConfig = { url: `/rest/api/3/universal_avatar/view/type/${type}`, method: 'GET', + responseType: 'arraybuffer', params: { size: typeof parameters !== 'string' && parameters.size, format: typeof parameters !== 'string' && parameters.format, }, }; - return this.client.sendRequest(config, callback); + const { + data: avatar, + headers: { 'content-type': contentTypeWithEncoding }, + } = await this.client.sendRequestFullResponse(config); + + const contentType = contentTypeWithEncoding.split(';')[0].trim(); + + return this.client.handleSuccessResponse({ contentType, avatar }, callback); } /** @@ -218,7 +227,7 @@ export class Avatars { * - For custom issue type avatars, _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) * for at least one project the issue type is used in. */ - async getAvatarImageByID( + async getAvatarImageByID( parameters: Parameters.GetAvatarImageByID, callback: Callback, ): Promise; @@ -235,21 +244,32 @@ export class Avatars { * - For custom issue type avatars, _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) * for at least one project the issue type is used in. */ - async getAvatarImageByID(parameters: Parameters.GetAvatarImageByID, callback?: never): Promise; - async getAvatarImageByID( + async getAvatarImageByID( + parameters: Parameters.GetAvatarImageByID, + callback?: never, + ): Promise; + async getAvatarImageByID( parameters: Parameters.GetAvatarImageByID, callback?: Callback, ): Promise { const config: RequestConfig = { url: `/rest/api/3/universal_avatar/view/type/${parameters.type}/avatar/${parameters.id}`, method: 'GET', + responseType: 'arraybuffer', params: { size: parameters.size, format: parameters.format, }, }; - return this.client.sendRequest(config, callback); + const { + data: avatar, + headers: { 'content-type': contentTypeWithEncoding }, + } = await this.client.sendRequestFullResponse(config); + + const contentType = contentTypeWithEncoding.split(';')[0].trim(); + + return this.client.handleSuccessResponse({ contentType, avatar }, callback); } /** @@ -265,7 +285,7 @@ export class Avatars { * - For custom issue type avatars, _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) * for at least one project the issue type is used in. */ - async getAvatarImageByOwner( + async getAvatarImageByOwner( parameters: Parameters.GetAvatarImageByOwner, callback: Callback, ): Promise; @@ -282,20 +302,31 @@ export class Avatars { * - For custom issue type avatars, _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) * for at least one project the issue type is used in. */ - async getAvatarImageByOwner(parameters: Parameters.GetAvatarImageByOwner, callback?: never): Promise; - async getAvatarImageByOwner( + async getAvatarImageByOwner( + parameters: Parameters.GetAvatarImageByOwner, + callback?: never, + ): Promise; + async getAvatarImageByOwner( parameters: Parameters.GetAvatarImageByOwner, callback?: Callback, ): Promise { const config: RequestConfig = { url: `/rest/api/3/universal_avatar/view/type/${parameters.type}/owner/${parameters.entityId}`, method: 'GET', + responseType: 'arraybuffer', params: { size: parameters.size, format: parameters.format, }, }; - return this.client.sendRequest(config, callback); + const { + data: avatar, + headers: { 'content-type': contentTypeWithEncoding }, + } = await this.client.sendRequestFullResponse(config); + + const contentType = contentTypeWithEncoding.split(';')[0].trim(); + + return this.client.handleSuccessResponse({ contentType, avatar }, callback); } } diff --git a/src/version3/client/version3Client.ts b/src/version3/client/version3Client.ts index e9e54b7500..e991ff1cc6 100644 --- a/src/version3/client/version3Client.ts +++ b/src/version3/client/version3Client.ts @@ -13,7 +13,6 @@ import { GroupAndUserPicker, Groups, InstanceInformation, - IssueAdjustmentsApps, IssueAttachments, IssueCommentProperties, IssueComments, @@ -103,7 +102,6 @@ export class Version3Client extends BaseClient { groupAndUserPicker = new GroupAndUserPicker(this); groups = new Groups(this); instanceInformation = new InstanceInformation(this); - issueAdjustmentsApps = new IssueAdjustmentsApps(this); issueAttachments = new IssueAttachments(this); issueCommentProperties = new IssueCommentProperties(this); issueComments = new IssueComments(this); diff --git a/src/version3/dashboards.ts b/src/version3/dashboards.ts index 4ae1955b4b..cbec827763 100644 --- a/src/version3/dashboards.ts +++ b/src/version3/dashboards.ts @@ -199,7 +199,6 @@ export class Dashboards { params: { dashboardName: parameters?.dashboardName, accountId: parameters?.accountId, - owner: parameters?.owner, groupname: parameters?.groupname, groupId: parameters?.groupId, projectId: parameters?.projectId, @@ -538,7 +537,7 @@ export class Dashboards { headers: { 'Content-Type': 'application/json', }, - data: parameters.body, + data: parameters.propertyValue, }; return this.client.sendRequest(config, callback); diff --git a/src/version3/filters.ts b/src/version3/filters.ts index 2e2fb2cdb7..af84c7be04 100644 --- a/src/version3/filters.ts +++ b/src/version3/filters.ts @@ -7,49 +7,6 @@ import { RequestConfig } from '../requestConfig'; export class Filters { constructor(private client: Client) {} - /** - * @deprecated Returns all filters. Deprecated, use [ Search for filters](#api-rest-api-3-filter-search-get) that - * supports search and pagination. This operation can be accessed anonymously. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** None, - * however, only the following filters are returned: - * - * - Filters owned by the user. - * - Filters shared with a group that the user is a member of. - * - Filters shared with a private project that the user has _Browse projects_ [project - * permission](https://confluence.atlassian.com/x/yodKLg) for. - * - Filters shared with a public project. - * - Filters shared with the public. - */ - async getFilters( - parameters: Parameters.GetFilters | undefined, - callback: Callback, - ): Promise; - /** - * @deprecated Returns all filters. Deprecated, use [ Search for filters](#api-rest-api-3-filter-search-get) that - * supports search and pagination. This operation can be accessed anonymously. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** None, - * however, only the following filters are returned: - * - * - Filters owned by the user. - * - Filters shared with a group that the user is a member of. - * - Filters shared with a private project that the user has _Browse projects_ [project - * permission](https://confluence.atlassian.com/x/yodKLg) for. - * - Filters shared with a public project. - * - Filters shared with the public. - */ - async getFilters(parameters?: Parameters.GetFilters, callback?: never): Promise; - async getFilters(parameters?: Parameters.GetFilters, callback?: Callback): Promise { - const config: RequestConfig = { - url: '/rest/api/3/filter', - method: 'GET', - params: { - expand: parameters?.expand, - }, - }; - - return this.client.sendRequest(config, callback); - } - /** * Creates a filter. The filter is shared according to the [default share scope](#api-rest-api-3-filter-post). The * filter is not selected as a favorite. @@ -270,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, diff --git a/src/version3/groups.ts b/src/version3/groups.ts index bd1f5475a1..1b30b6cd9e 100644 --- a/src/version3/groups.ts +++ b/src/version3/groups.ts @@ -7,32 +7,6 @@ import { RequestConfig } from '../requestConfig'; export class Groups { constructor(private client: Client) {} - /** - * @deprecated This operation is deprecated, use [`group/member`](#api-rest-api-3-group-member-get). Returns all users - * in a group. **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) - * required:** _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async getGroup(parameters: Parameters.GetGroup, callback: Callback): Promise; - /** - * @deprecated This operation is deprecated, use [`group/member`](#api-rest-api-3-group-member-get). Returns all users - * in a group. **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) - * required:** _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async getGroup(parameters: Parameters.GetGroup, callback?: never): Promise; - async getGroup(parameters: Parameters.GetGroup, callback?: Callback): Promise { - const config: RequestConfig = { - url: '/rest/api/3/group', - method: 'GET', - params: { - groupname: parameters.groupname, - groupId: parameters.groupId, - expand: parameters.expand, - }, - }; - - return this.client.sendRequest(config, callback); - } - /** * Creates a group. * @@ -294,13 +268,11 @@ export class Groups { url: '/rest/api/3/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/version3/index.ts b/src/version3/index.ts index c771572d6e..86cbc71d60 100644 --- a/src/version3/index.ts +++ b/src/version3/index.ts @@ -11,7 +11,6 @@ export * from './filterSharing'; export * from './groupAndUserPicker'; export * from './groups'; export * from './instanceInformation'; -export * from './issueAdjustmentsApps'; export * from './issueAttachments'; export * from './issueCommentProperties'; export * from './issueComments'; diff --git a/src/version3/issueAdjustmentsApps.ts b/src/version3/issueAdjustmentsApps.ts deleted file mode 100644 index 458ff9aa4a..0000000000 --- a/src/version3/issueAdjustmentsApps.ts +++ /dev/null @@ -1,158 +0,0 @@ -import * as Models from './models'; -import * as Parameters from './parameters'; -import { Callback } from '../callback'; -import { Client } from '../clients'; -import { RequestConfig } from '../requestConfig'; - -export class IssueAdjustmentsApps { - constructor(private client: Client) {} - - /** - * @deprecated Gets issue adjustments. Issue adjustments can only be retrieved by Forge apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * None. - */ - async getIssueAdjustments( - parameters: Parameters.GetIssueAdjustments | undefined, - callback: Callback, - ): Promise; - /** - * @deprecated Gets issue adjustments. Issue adjustments can only be retrieved by Forge apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * None. - */ - async getIssueAdjustments( - parameters?: Parameters.GetIssueAdjustments, - callback?: never, - ): Promise; - async getIssueAdjustments( - parameters?: Parameters.GetIssueAdjustments, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: '/rest/api/3/issueAdjustments', - method: 'GET', - params: { - startAt: parameters?.startAt, - maxResults: parameters?.maxResults, - expand: parameters?.expand, - }, - }; - - return this.client.sendRequest(config, callback); - } - - /** - * @deprecated Creates an issue adjustment. Issue adjustment can only be created by Forge apps. Each app can define up - * to 100 issue adjustments. Each issue adjustment can define up to 1000 contexts. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * - * - _None_ if the issue adjustment is created without contexts. - * - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the - * issue adjustment is created with contexts. - */ - async createIssueAdjustment( - parameters: Parameters.CreateIssueAdjustment | undefined, - callback: Callback, - ): Promise; - /** - * @deprecated Creates an issue adjustment. Issue adjustment can only be created by Forge apps. Each app can define up - * to 100 issue adjustments. Each issue adjustment can define up to 1000 contexts. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * - * - _None_ if the issue adjustment is created without contexts. - * - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the - * issue adjustment is created with contexts. - */ - async createIssueAdjustment( - parameters?: Parameters.CreateIssueAdjustment, - callback?: never, - ): Promise; - async createIssueAdjustment( - parameters?: Parameters.CreateIssueAdjustment, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: '/rest/api/3/issueAdjustments', - method: 'POST', - data: { - name: parameters?.name, - description: parameters?.description, - data: parameters?.data, - contexts: parameters?.contexts, - }, - }; - - return this.client.sendRequest(config, callback); - } - - /** - * @deprecated Updates an issue adjustment. Issue adjustment can only be updated by Forge apps. Each issue adjustment - * can define up to 1000 contexts. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * - * - _None_ if the issue adjustment is created without contexts. - * - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the - * issue adjustment is created with contexts. - */ - async updateIssueAdjustment( - parameters: Parameters.UpdateIssueAdjustment, - callback: Callback, - ): Promise; - /** - * @deprecated Updates an issue adjustment. Issue adjustment can only be updated by Forge apps. Each issue adjustment - * can define up to 1000 contexts. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * - * - _None_ if the issue adjustment is created without contexts. - * - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the - * issue adjustment is created with contexts. - */ - async updateIssueAdjustment(parameters: Parameters.UpdateIssueAdjustment, callback?: never): Promise; - async updateIssueAdjustment( - parameters: Parameters.UpdateIssueAdjustment, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: `/rest/api/3/issueAdjustments/${parameters.issueAdjustmentId}`, - method: 'PUT', - data: { - name: parameters.name, - description: parameters.description, - data: parameters.data, - contexts: parameters.contexts, - }, - }; - - return this.client.sendRequest(config, callback); - } - - /** - * @deprecated Deletes an issue adjustment. All the contexts that belong to the issue adjustment are deleted too. - * Issue adjustment can only be deleted by Forge apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * None. - */ - async deleteIssueAdjustment( - parameters: Parameters.DeleteIssueAdjustment, - callback: Callback, - ): Promise; - /** - * @deprecated Deletes an issue adjustment. All the contexts that belong to the issue adjustment are deleted too. - * Issue adjustment can only be deleted by Forge apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * None. - */ - async deleteIssueAdjustment(parameters: Parameters.DeleteIssueAdjustment, callback?: never): Promise; - async deleteIssueAdjustment( - parameters: Parameters.DeleteIssueAdjustment, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: `/rest/api/3/issueAdjustments/${parameters.issueAdjustmentId}`, - method: 'DELETE', - }; - - return this.client.sendRequest(config, callback); - } -} diff --git a/src/version3/issueComments.ts b/src/version3/issueComments.ts index b63c1c9e34..f0f6a3587d 100644 --- a/src/version3/issueComments.ts +++ b/src/version3/issueComments.ts @@ -146,18 +146,18 @@ export class IssueComments { async addComment(parameters: Parameters.AddComment, callback?: never): Promise; async addComment(parameters: Parameters.AddComment, callback?: Callback): Promise { const body = - typeof parameters.body === 'string' + typeof parameters.comment === 'string' ? { type: 'doc', version: 1, content: [ { type: 'paragraph', - content: [{ type: 'text', text: parameters.body }], + content: [{ type: 'text', text: parameters.comment }], }, ], } - : parameters.body; + : parameters.comment; const config: RequestConfig = { url: `/rest/api/3/issue/${parameters.issueIdOrKey}/comment`, diff --git a/src/version3/issueCustomFieldConfigurationApps.ts b/src/version3/issueCustomFieldConfigurationApps.ts index 581ac88e66..662e4fca60 100644 --- a/src/version3/issueCustomFieldConfigurationApps.ts +++ b/src/version3/issueCustomFieldConfigurationApps.ts @@ -60,7 +60,6 @@ export class IssueCustomFieldConfigurationApps { method: 'GET', params: { id: typeof parameters !== 'string' && parameters.id, - contextId: typeof parameters !== 'string' && parameters.contextId, fieldContextId: typeof parameters !== 'string' && parameters.fieldContextId, issueId: typeof parameters !== 'string' && parameters.issueId, projectKeyOrId: typeof parameters !== 'string' && parameters.projectKeyOrId, diff --git a/src/version3/issueCustomFieldOptions.ts b/src/version3/issueCustomFieldOptions.ts index 44e17f9984..bddd413e0c 100644 --- a/src/version3/issueCustomFieldOptions.ts +++ b/src/version3/issueCustomFieldOptions.ts @@ -7,162 +7,6 @@ import { RequestConfig } from '../requestConfig'; export class IssueCustomFieldOptions { constructor(private client: Client) {} - /** - * @deprecated This operation is deprecated and becomes unavailable on 8 May 2021. Use [Get custom field options - * (context)](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-get) - * instead. See [Deprecation of custom field - * options](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-removal-of-custom-field-options-operations/) - * for details. Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) - * list of options and, where the custom select field is of the type _Select List (cascading)_, cascading options - * for custom select fields. Cascading options are included in the item count when determining pagination. Only - * options from the global context are returned. Note that this operation **only works for issue field select list - * options created in Jira or using operations from the [Issue custom field - * options](#api-group-Issue-custom-field-options) resource**, it cannot be used with issue field select list - * options created by Connect apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async getOptionsForField( - parameters: Parameters.GetOptionsForField | string, - callback: Callback, - ): Promise; - /** - * @deprecated This operation is deprecated and becomes unavailable on 8 May 2021. Use [Get custom field options - * (context)](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-get) - * instead. See [Deprecation of custom field - * options](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-removal-of-custom-field-options-operations/) - * for details. Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) - * list of options and, where the custom select field is of the type _Select List (cascading)_, cascading options - * for custom select fields. Cascading options are included in the item count when determining pagination. Only - * options from the global context are returned. Note that this operation **only works for issue field select list - * options created in Jira or using operations from the [Issue custom field - * options](#api-group-Issue-custom-field-options) resource**, it cannot be used with issue field select list - * options created by Connect apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async getOptionsForField( - parameters: Parameters.GetOptionsForField | string, - callback?: never, - ): Promise; - async getOptionsForField( - parameters: Parameters.GetOptionsForField | string, - callback?: Callback, - ): Promise { - const fieldId = typeof parameters === 'string' ? parameters : parameters.fieldId; - - const config: RequestConfig = { - url: `/rest/api/3/customField/${fieldId}/option`, - method: 'GET', - params: { - startAt: typeof parameters !== 'string' && parameters.startAt, - maxResults: typeof parameters !== 'string' && parameters.maxResults, - }, - }; - - return this.client.sendRequest(config, callback); - } - - /** - * @deprecated This operation is deprecated and becomes unavailable on 8 May 2021. Use [Create custom field options - * (context)](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-post) - * instead. See [Deprecation of custom field - * options](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-removal-of-custom-field-options-operations/) - * for details. Creates options and, where the custom select field is of the type _Select List (cascading)_, - * cascading options for a custom select field. The options are added to the global context of the field. Note that - * this operation **only works for issue field select list options created in Jira or using operations from the - * [Issue custom field options](#api-group-Issue-custom-field-options) resource**, it cannot be used with issue - * field select list options created by Connect apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async createCustomFieldOptions( - parameters: Parameters.CreateCustomFieldOptions, - callback: Callback, - ): Promise; - /** - * @deprecated This operation is deprecated and becomes unavailable on 8 May 2021. Use [Create custom field options - * (context)](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-post) - * instead. See [Deprecation of custom field - * options](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-removal-of-custom-field-options-operations/) - * for details. Creates options and, where the custom select field is of the type _Select List (cascading)_, - * cascading options for a custom select field. The options are added to the global context of the field. Note that - * this operation **only works for issue field select list options created in Jira or using operations from the - * [Issue custom field options](#api-group-Issue-custom-field-options) resource**, it cannot be used with issue - * field select list options created by Connect apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async createCustomFieldOptions( - parameters: Parameters.CreateCustomFieldOptions, - callback?: never, - ): Promise; - async createCustomFieldOptions( - parameters: Parameters.CreateCustomFieldOptions, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: `/rest/api/3/customField/${parameters.fieldId}/option`, - method: 'POST', - data: { - options: parameters.options, - }, - }; - - return this.client.sendRequest(config, callback); - } - - /** - * @deprecated This operation is deprecated and becomes unavailable on 8 May 2021. Use [Update custom field options - * (context)](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-put) - * instead. See [Deprecation of custom field - * options](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-removal-of-custom-field-options-operations/) - * for details. Updates the options on a custom select field. Where an updated option is in use on an issue, the - * value on the issue is also updated. Options that are not found are ignored. A maximum of 1000 options, including - * sub-options of _Select List (cascading)_ fields, can be updated per request. The options are updated on the - * global context of the field. Note that this operation **only works for issue field select list options created in - * Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource**, - * it cannot be used with issue field select list options created by Connect apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async updateCustomFieldOptions( - parameters: Parameters.UpdateCustomFieldOptions, - callback: Callback, - ): Promise; - /** - * @deprecated This operation is deprecated and becomes unavailable on 8 May 2021. Use [Update custom field options - * (context)](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-custom-field-options/#api-rest-api-3-field-fieldid-context-contextid-option-put) - * instead. See [Deprecation of custom field - * options](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-removal-of-custom-field-options-operations/) - * for details. Updates the options on a custom select field. Where an updated option is in use on an issue, the - * value on the issue is also updated. Options that are not found are ignored. A maximum of 1000 options, including - * sub-options of _Select List (cascading)_ fields, can be updated per request. The options are updated on the - * global context of the field. Note that this operation **only works for issue field select list options created in - * Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource**, - * it cannot be used with issue field select list options created by Connect apps. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async updateCustomFieldOptions( - parameters: Parameters.UpdateCustomFieldOptions, - callback?: never, - ): Promise; - async updateCustomFieldOptions( - parameters: Parameters.UpdateCustomFieldOptions, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: `/rest/api/3/customField/${parameters.fieldId}/option`, - method: 'PUT', - data: { - options: parameters.options, - }, - }; - - return this.client.sendRequest(config, callback); - } - /** * Returns a custom field option. For example, an option in a select list. * diff --git a/src/version3/issueFields.ts b/src/version3/issueFields.ts index 0592b6130c..b29356e6bd 100644 --- a/src/version3/issueFields.ts +++ b/src/version3/issueFields.ts @@ -220,44 +220,6 @@ export class IssueFields { return this.client.sendRequest(config, callback); } - /** - * @deprecated Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) - * list of the contexts a field is used in. Deprecated, use [ Get custom field - * contexts](#api-rest-api-3-field-fieldId-context-get). - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async getContextsForFieldDeprecated( - parameters: Parameters.GetContextsForFieldDeprecated, - callback: Callback, - ): Promise; - /** - * @deprecated Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#pagination) - * list of the contexts a field is used in. Deprecated, use [ Get custom field - * contexts](#api-rest-api-3-field-fieldId-context-get). - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async getContextsForFieldDeprecated( - parameters: Parameters.GetContextsForFieldDeprecated, - callback?: never, - ): Promise; - async getContextsForFieldDeprecated( - parameters: Parameters.GetContextsForFieldDeprecated, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: `/rest/api/3/field/${parameters.fieldId}/contexts`, - method: 'GET', - params: { - startAt: parameters.startAt, - maxResults: parameters.maxResults, - }, - }; - - return this.client.sendRequest(config, callback); - } - /** * Deletes a custom field. The custom field is deleted whether it is in the trash or not. See [Edit or delete a custom * field](https://confluence.atlassian.com/x/Z44fOw) for more information on trashing and deleting custom fields. diff --git a/src/version3/issueNotificationSchemes.ts b/src/version3/issueNotificationSchemes.ts index 60683be695..2392ff3b88 100644 --- a/src/version3/issueNotificationSchemes.ts +++ b/src/version3/issueNotificationSchemes.ts @@ -215,34 +215,6 @@ export class IssueNotificationSchemes { return this.client.sendRequest(config, callback); } - /** - * @deprecated Adds notifications to a notification scheme. You can add up to 1000 notifications per request. - * _Deprecated: The notification type `EmailAddress` is no longer supported in Cloud. Refer to the - * [changelog](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-1031) for more details._ - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async addNotifications(parameters: Parameters.AddNotifications, callback: Callback): Promise; - /** - * @deprecated Adds notifications to a notification scheme. You can add up to 1000 notifications per request. - * _Deprecated: The notification type `EmailAddress` is no longer supported in Cloud. Refer to the - * [changelog](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-1031) for more details._ - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async addNotifications(parameters: Parameters.AddNotifications, callback?: never): Promise; - async addNotifications(parameters: Parameters.AddNotifications, callback?: Callback): Promise { - const config: RequestConfig = { - url: `/rest/api/3/notificationscheme/${parameters.id}/notification`, - method: 'PUT', - data: { - notificationSchemeEvents: parameters.notificationSchemeEvents, - }, - }; - - return this.client.sendRequest(config, callback); - } - /** * Deletes a notification scheme. * diff --git a/src/version3/issuePriorities.ts b/src/version3/issuePriorities.ts index 3d3cfc7af2..4df878f737 100644 --- a/src/version3/issuePriorities.ts +++ b/src/version3/issuePriorities.ts @@ -233,37 +233,4 @@ export class IssuePriorities { return this.client.sendRequest(config, callback); } - - /** - * @deprecated _Deprecated: please refer to the_ [changelog](https://developer.atlassian.com/changelog/#CHANGE-1066) - * _for more details._ Deletes an issue priority. This operation is - * [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). Follow the - * `location` link in the response to determine the status of the task and use [Get - * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async deletePriority(parameters: Parameters.DeletePriority, callback: Callback): Promise; - /** - * @deprecated _Deprecated: please refer to the_ [changelog](https://developer.atlassian.com/changelog/#CHANGE-1066) - * _for more details._ Deletes an issue priority. This operation is - * [asynchronous](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#async-operations). Follow the - * `location` link in the response to determine the status of the task and use [Get - * task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async deletePriority(parameters: Parameters.DeletePriority, callback?: never): Promise; - async deletePriority(parameters: Parameters.DeletePriority, callback?: Callback): Promise { - const config: RequestConfig = { - url: `/rest/api/3/priority/${parameters.id}`, - method: 'DELETE', - params: { - newPriority: parameters.newPriority, - replaceWith: parameters.replaceWith, - }, - }; - - return this.client.sendRequest(config, callback); - } } diff --git a/src/version3/issueResolutions.ts b/src/version3/issueResolutions.ts index 93327ccc11..09298953f1 100644 --- a/src/version3/issueResolutions.ts +++ b/src/version3/issueResolutions.ts @@ -7,27 +7,6 @@ import { RequestConfig } from '../requestConfig'; export class IssueResolutions { constructor(private client: Client) {} - /** - * @deprecated Returns a list of all issue resolution values. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * Permission to access Jira. - */ - async getResolutions(callback: Callback): Promise; - /** - * @deprecated Returns a list of all issue resolution values. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * Permission to access Jira. - */ - async getResolutions(callback?: never): Promise; - async getResolutions(callback?: Callback): Promise { - const config: RequestConfig = { - url: '/rest/api/3/resolution', - method: 'GET', - }; - - return this.client.sendRequest(config, callback); - } - /** * Creates an issue resolution. * @@ -169,33 +148,6 @@ export class IssueResolutions { return this.client.sendRequest(config, callback); } - /** - * @deprecated Returns an issue resolution value. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * Permission to access Jira. - */ - async getResolution( - parameters: Parameters.GetResolution, - callback: Callback, - ): Promise; - /** - * @deprecated Returns an issue resolution value. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * Permission to access Jira. - */ - async getResolution(parameters: Parameters.GetResolution, callback?: never): Promise; - async getResolution( - parameters: Parameters.GetResolution, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: `/rest/api/3/resolution/${parameters.id}`, - method: 'GET', - }; - - return this.client.sendRequest(config, callback); - } - /** * Updates an issue resolution. * diff --git a/src/version3/issueTypes.ts b/src/version3/issueTypes.ts index e767e994ab..a91e4834ec 100644 --- a/src/version3/issueTypes.ts +++ b/src/version3/issueTypes.ts @@ -74,7 +74,6 @@ export class IssueTypes { data: { name: parameters?.name, description: parameters?.description, - type: parameters?.type, hierarchyLevel: parameters?.hierarchyLevel, }, }; diff --git a/src/version3/jQL.ts b/src/version3/jQL.ts index 20acb211b0..e630da739d 100644 --- a/src/version3/jQL.ts +++ b/src/version3/jQL.ts @@ -309,55 +309,4 @@ export class JQL { return this.client.sendRequest(config, callback); } - - /** @deprecated */ - async getPrecomputations( - parameters: Parameters.GetPrecomputations | undefined, - callback: Callback, - ): Promise; - /** @deprecated */ - async getPrecomputations( - parameters?: Parameters.GetPrecomputations, - callback?: never, - ): Promise; - async getPrecomputations( - parameters?: Parameters.GetPrecomputations, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: '/rest/api/3/jql/function/computation', - method: 'GET', - params: { - functionKey: parameters?.functionKey, - startAt: parameters?.startAt, - maxResults: parameters?.maxResults, - orderBy: parameters?.orderBy, - filter: parameters?.filter, - }, - }; - - return this.client.sendRequest(config, callback); - } - - /** @deprecated */ - async updatePrecomputations( - parameters: Parameters.UpdatePrecomputations, - callback: Callback, - ): Promise; - /** @deprecated */ - async updatePrecomputations(parameters: Parameters.UpdatePrecomputations, callback?: never): Promise; - async updatePrecomputations( - parameters: Parameters.UpdatePrecomputations, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: '/rest/api/3/jql/function/computation', - method: 'POST', - data: { - values: parameters.values, - }, - }; - - return this.client.sendRequest(config, callback); - } } diff --git a/src/version3/models/addField.ts b/src/version3/models/addField.ts index 07eb9370b6..09d70ed44f 100644 --- a/src/version3/models/addField.ts +++ b/src/version3/models/addField.ts @@ -1,6 +1,3 @@ -/** @deprecated Use AddField instead. */ -export type AddFieldBean = AddField; - export interface AddField { /** The ID of the field to add. */ fieldId: string; diff --git a/src/version3/models/addGroup.ts b/src/version3/models/addGroup.ts index 0af23c703e..261837d95e 100644 --- a/src/version3/models/addGroup.ts +++ b/src/version3/models/addGroup.ts @@ -1,6 +1,3 @@ -/** @deprecated Use AddGroup instead. */ -export type AddGroupBean = AddGroup; - export interface AddGroup { /** The name of the group. */ name: string; diff --git a/src/version3/models/addNotificationsDetails.ts b/src/version3/models/addNotificationsDetails.ts deleted file mode 100644 index 388d257615..0000000000 --- a/src/version3/models/addNotificationsDetails.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { NotificationSchemeEventDetails } from './notificationSchemeEventDetails'; - -/** Details of notifications which should be added to the notification scheme. */ -export interface AddNotificationsDetails { - /** The list of notifications which should be added to the notification scheme. */ - notificationSchemeEvents: NotificationSchemeEventDetails[]; -} diff --git a/src/version3/models/applicationRole.ts b/src/version3/models/applicationRole.ts index 00678634e2..ebdbb7cc4f 100644 --- a/src/version3/models/applicationRole.ts +++ b/src/version3/models/applicationRole.ts @@ -22,8 +22,6 @@ export interface ApplicationRole { defaultGroupsDetails?: GroupName[]; /** Determines whether this application role should be selected by default on user creation. */ selectedByDefault?: boolean; - /** Deprecated. */ - defined?: boolean; /** The maximum count of users on your license. */ numberOfSeats?: number; /** The count of users remaining on your license. */ diff --git a/src/version3/models/associatedItem.ts b/src/version3/models/associatedItem.ts index 942aea4db4..f4d2d4535b 100644 --- a/src/version3/models/associatedItem.ts +++ b/src/version3/models/associatedItem.ts @@ -1,6 +1,3 @@ -/** @deprecated Use AssociatedItem instead. */ -export type AssociatedItemBean = AssociatedItem; - /** Details of an item associated with the changed record. */ export interface AssociatedItem { /** The ID of the associated record. */ diff --git a/src/version3/models/attachmentArchive.ts b/src/version3/models/attachmentArchive.ts deleted file mode 100644 index ec157dd206..0000000000 --- a/src/version3/models/attachmentArchive.ts +++ /dev/null @@ -1,8 +0,0 @@ -import { AttachmentArchiveEntry } from './attachmentArchiveEntry'; - -export interface AttachmentArchive { - totalNumberOfEntriesAvailable?: number; - totalEntryCount?: number; - moreAvailable?: boolean; - entries?: AttachmentArchiveEntry[]; -} diff --git a/src/version3/models/auditRecord.ts b/src/version3/models/auditRecord.ts index cabec09fa7..5b294091e0 100644 --- a/src/version3/models/auditRecord.ts +++ b/src/version3/models/auditRecord.ts @@ -1,9 +1,6 @@ import { AssociatedItem } from './associatedItem'; import { ChangedValue } from './changedValue'; -/** @deprecated Use AuditRecord instead. */ -export type AuditRecordBean = AuditRecord; - /** An audit record. */ export interface AuditRecord { /** The ID of the audit record. */ @@ -12,8 +9,6 @@ export interface AuditRecord { summary?: string; /** The URL of the computer where the creation of the audit record was initiated. */ remoteAddress?: string; - /** Deprecated, use `authorAccountId` instead. The key of the user who created the audit record. */ - authorKey?: string; /** The date and time on which the audit record was created. */ created?: string; /** diff --git a/src/version3/models/avatarUrls.ts b/src/version3/models/avatarUrls.ts index dfb273869a..cda993d7f3 100644 --- a/src/version3/models/avatarUrls.ts +++ b/src/version3/models/avatarUrls.ts @@ -1,6 +1,3 @@ -/** @deprecated Use AvatarUrls instead. */ -export type AvatarUrlsBean = AvatarUrls; - export interface AvatarUrls { /** The URL of the item's 16x16 pixel avatar. */ '16x16'?: string; diff --git a/src/version3/models/avatarWithDetails.ts b/src/version3/models/avatarWithDetails.ts new file mode 100644 index 0000000000..15f5f99071 --- /dev/null +++ b/src/version3/models/avatarWithDetails.ts @@ -0,0 +1,6 @@ +export interface AvatarWithDetails { + /** The content type of the avatar. Expected values include 'image/png', 'image/svg+xml', or any other valid MIME type. */ + contentType: 'image/png' | 'image/svg+xml' | string; + /** The binary representation of the avatar image. */ + avatar: ArrayBuffer; +} diff --git a/src/version3/models/bulkCreateCustomFieldOptionRequest.ts b/src/version3/models/bulkCreateCustomFieldOptionRequest.ts deleted file mode 100644 index ed12cded8d..0000000000 --- a/src/version3/models/bulkCreateCustomFieldOptionRequest.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { CustomFieldOptionValue } from './customFieldOptionValue'; - -/** Details of options to create for a custom field. */ -export interface BulkCreateCustomFieldOptionRequest { - /** Details of options to create. */ - options: CustomFieldOptionValue[]; -} diff --git a/src/version3/models/bulkPermissionsRequest.ts b/src/version3/models/bulkPermissionsRequest.ts index 9815eaedd2..5e2a3400c7 100644 --- a/src/version3/models/bulkPermissionsRequest.ts +++ b/src/version3/models/bulkPermissionsRequest.ts @@ -1,8 +1,5 @@ import { BulkProjectPermissions } from './bulkProjectPermissions'; -/** @deprecated Use BulkPermissionsRequest instead. */ -export type BulkPermissionsRequestBean = BulkPermissionsRequest; - /** Details of global permissions to look up and project permissions with associated projects and issues to look up. */ export interface BulkPermissionsRequest { /** Project permissions with associated projects and issues to look up. */ diff --git a/src/version3/models/changedValue.ts b/src/version3/models/changedValue.ts index ece5e05503..1f080f4821 100644 --- a/src/version3/models/changedValue.ts +++ b/src/version3/models/changedValue.ts @@ -1,6 +1,3 @@ -/** @deprecated Use ChangedValue instead. */ -export type ChangedValueBean = ChangedValue; - /** Details of names changed in the record event. */ export interface ChangedValue { /** The name of the field changed. */ diff --git a/src/version3/models/component.ts b/src/version3/models/component.ts deleted file mode 100644 index 3f7e30cf35..0000000000 --- a/src/version3/models/component.ts +++ /dev/null @@ -1,71 +0,0 @@ -import { User } from './user'; - -/** @deprecated Use {@link ProjectComponent}. Details about a project component. */ -export interface Component { - /** The URL of the component. */ - self?: string; - /** The unique identifier for the component. */ - id?: string; - /** - * 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. - */ - name?: string; - /** The description for the component. Optional when creating or updating a component. */ - description?: string; - /** The user details for the component's lead user. */ - lead?: User[]; - /** - * This property is no longer available and will be removed from the documentation soon. See the [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - leadUserName?: string; - /** - * The accountId of the component's lead user. The accountId uniquely identifies the user across all Atlassian - * products. For example, _5b10ac8d82e05b22cc7d4ef5_. - */ - leadAccountId?: string; - /** - * The nominal user type used to determine the assignee for issues created with this component. See `realAssigneeType` - * for details on how the type of the user, and hence the user, assigned to issues is determined. Can take the - * following values: - * - * `PROJECT_LEAD` the assignee to any issues created with this component is nominally the lead for the project the - * component is in. `COMPONENT_LEAD` the assignee to any issues created with this component is nominally the lead for - * the component. `UNASSIGNED` an assignee is not set for issues created with this component. `PROJECT_DEFAULT` the - * assignee to any issues created with this component is nominally the default assignee for the project that the - * component is in. - * - * Default value: `PROJECT_DEFAULT`. Optional when creating or updating a component. - */ - assigneeType?: string; - /** - * The details of the user associated with `assigneeType`, if any. See `realAssignee` for details of the user assigned - * to issues created with this component. - */ - assignee?: User[]; - /** - * The type of the assignee that is assigned to issues created with this component, when an assignee cannot be set - * from the `assigneeType`. For example, `assigneeType` is set to `COMPONENT_LEAD` but no component lead is set. This - * property is set to one of the following values: - * - * `PROJECT_LEAD` when `assigneeType` is `PROJECT_LEAD` and the project lead has permission to be assigned issues in - * the project that the component is in. `COMPONENT_LEAD` when `assignee`Type is `COMPONENT_LEAD` and the component - * lead has permission to be assigned issues in the project that the component is in. `UNASSIGNED` when `assigneeType` - * is `UNASSIGNED` and Jira is configured to allow unassigned issues. `PROJECT_DEFAULT` when none of the preceding - * cases are true. - */ - realAssigneeType?: string; - /** The user assigned to issues created with this component, when `assigneeType` does not identify a valid assignee. */ - realAssignee?: User[]; - /** - * Whether a user is associated with `assigneeType`. For example, if the `assigneeType` is set to `COMPONENT_LEAD` but - * the component lead is not set, then `false` is returned. - */ - isAssigneeTypeValid?: boolean; - /** The key of the project the component is assigned to. Required when creating a component. Can't be updated. */ - project?: string; - /** The ID of the project the component is assigned to. */ - projectId?: number; -} diff --git a/src/version3/models/compoundClause.ts b/src/version3/models/compoundClause.ts deleted file mode 100644 index fa8b495139..0000000000 --- a/src/version3/models/compoundClause.ts +++ /dev/null @@ -1,14 +0,0 @@ -import { JqlQueryClause } from './jqlQueryClause'; - -/** - * A JQL query clause that consists of nested clauses. For example, `(labels in (urgent, blocker) OR lastCommentedBy = - * currentUser()). Note that, where nesting is not defined, the parser nests JQL clauses based on the operator - * precedence. For example, "A OR B AND C" is parsed as "(A OR B) AND C". See Setting the precedence of operators for - * more information about precedence in JQL queries.` - */ -export interface CompoundClause { - /** The list of nested clauses. */ - clauses: JqlQueryClause[]; - /** The operator between the clauses. */ - operator: string; -} diff --git a/src/version3/models/configuration.ts b/src/version3/models/configuration.ts index 404cd9a0d7..45b8225c64 100644 --- a/src/version3/models/configuration.ts +++ b/src/version3/models/configuration.ts @@ -21,8 +21,6 @@ export interface Configuration { subTasksEnabled?: boolean; /** Whether the ability to link issues is enabled. */ issueLinkingEnabled?: boolean; - /** Whether the ability to track time is enabled. This property is deprecated. */ - timeTrackingEnabled?: boolean; /** Whether the ability to add attachments to issues is enabled. */ attachmentsEnabled?: boolean; timeTrackingConfiguration?: TimeTrackingConfiguration; diff --git a/src/version3/models/context.ts b/src/version3/models/context.ts deleted file mode 100644 index 638cbfe41c..0000000000 --- a/src/version3/models/context.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { Scope } from './scope'; - -/** A context. */ -export interface Context { - /** The ID of the context. */ - id?: number; - /** The name of the context. */ - name?: string; - scope?: Scope; -} diff --git a/src/version3/models/contextualConfiguration.ts b/src/version3/models/contextualConfiguration.ts index e114ba0e04..c0ddb38796 100644 --- a/src/version3/models/contextualConfiguration.ts +++ b/src/version3/models/contextualConfiguration.ts @@ -2,8 +2,6 @@ export interface ContextualConfiguration { /** The ID of the configuration. */ id: string; - /** Deprecated, do not use. */ - contextId?: number; /** The ID of the field context the configuration is associated with. */ fieldContextId: string; /** The field configuration. */ diff --git a/src/version3/models/crateWorkflowStatusDetails.ts b/src/version3/models/crateWorkflowStatusDetails.ts deleted file mode 100644 index 99bbc7de80..0000000000 --- a/src/version3/models/crateWorkflowStatusDetails.ts +++ /dev/null @@ -1,5 +0,0 @@ -/** The details of a transition status. */ -export interface CrateWorkflowStatusDetails { - /** The ID of the status. */ - id: string; -} diff --git a/src/version3/models/createIssueAdjustmentDetails.ts b/src/version3/models/createIssueAdjustmentDetails.ts deleted file mode 100644 index 35e23b8dad..0000000000 --- a/src/version3/models/createIssueAdjustmentDetails.ts +++ /dev/null @@ -1,13 +0,0 @@ -import { IssueAdjustmentContextDetails } from './issueAdjustmentContextDetails'; - -/** The details of an issue adjustment. */ -export interface CreateIssueAdjustmentDetails { - /** The name of the issue adjustment. The maximum length is 255 characters. */ - name: string; - /** The description of the issue adjustment. The maximum length is 255 characters. */ - description?: string; - /** The data of the issue adjustment. The maximum size of the data is 50000 characters. */ - data?: string; - /** List of contexts of the issue adjustment. The maximum number of contexts is 1000. */ - contexts?: IssueAdjustmentContextDetails[]; -} diff --git a/src/version3/models/createProjectDetails.ts b/src/version3/models/createProjectDetails.ts index c192a2c89a..0f17fb0d06 100644 --- a/src/version3/models/createProjectDetails.ts +++ b/src/version3/models/createProjectDetails.ts @@ -9,19 +9,11 @@ export interface CreateProjectDetails { name: string; /** A brief description of the project. */ description?: string; - /** - * @deprecated This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the - * [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The user name of the project lead. Either `lead` or `leadAccountId` must be set when creating a - * project. Cannot be provided with `leadAccountId`. - */ - lead?: string; /** * The account ID of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Cannot be * provided with `lead`. */ - leadAccountId?: string; + leadAccountId: string; /** A link to information about this project, such as project documentation */ url?: string; /** The default assignee when creating issues for this project. */ diff --git a/src/version3/models/createUpdateRoleRequest.ts b/src/version3/models/createUpdateRoleRequest.ts index 154b04dd63..777276f95f 100644 --- a/src/version3/models/createUpdateRoleRequest.ts +++ b/src/version3/models/createUpdateRoleRequest.ts @@ -1,6 +1,3 @@ -/** @deprecated Use CreateUpdateRoleRequest instead. */ -export type CreateUpdateRoleRequestBean = CreateUpdateRoleRequest; - export interface CreateUpdateRoleRequest { /** * The name of the project role. Must be unique. Cannot begin or end with whitespace. The maximum length is 255 diff --git a/src/version3/models/customFieldContextDefaultValueCascadingOption.ts b/src/version3/models/customFieldContextDefaultValueCascadingOption.ts deleted file mode 100644 index 197d79fc43..0000000000 --- a/src/version3/models/customFieldContextDefaultValueCascadingOption.ts +++ /dev/null @@ -1,10 +0,0 @@ -/** The default value for a cascading select custom field. */ -export interface CustomFieldContextDefaultValueCascadingOption { - /** The ID of the context. */ - contextId: string; - /** The ID of the default option. */ - optionId: string; - /** The ID of the default cascading option. */ - cascadingOptionId?: string; - type: string; -} diff --git a/src/version3/models/customFieldContextDefaultValueMultipleOption.ts b/src/version3/models/customFieldContextDefaultValueMultipleOption.ts deleted file mode 100644 index 7bbaeb6385..0000000000 --- a/src/version3/models/customFieldContextDefaultValueMultipleOption.ts +++ /dev/null @@ -1,8 +0,0 @@ -/** The default value for a multi-select custom field. */ -export interface CustomFieldContextDefaultValueMultipleOption { - /** The ID of the context. */ - contextId: string; - /** The list of IDs of the default options. */ - optionIds: string[]; - type: string; -} diff --git a/src/version3/models/customFieldContextDefaultValueSingleOption.ts b/src/version3/models/customFieldContextDefaultValueSingleOption.ts deleted file mode 100644 index 63d25b6e77..0000000000 --- a/src/version3/models/customFieldContextDefaultValueSingleOption.ts +++ /dev/null @@ -1,8 +0,0 @@ -/** The default value for a single select custom field. */ -export interface CustomFieldContextDefaultValueSingleOption { - /** The ID of the context. */ - contextId: string; - /** The ID of the default option. */ - optionId: string; - type: string; -} diff --git a/src/version3/models/customFieldDefinitionJson.ts b/src/version3/models/customFieldDefinitionJson.ts index 11f7fe857c..b55d9a816e 100644 --- a/src/version3/models/customFieldDefinitionJson.ts +++ b/src/version3/models/customFieldDefinitionJson.ts @@ -1,6 +1,3 @@ -/** @deprecated Use CustomFieldDefinitionJson instead. */ -export type CustomFieldDefinitionJsonBean = CustomFieldDefinitionJson; - export interface CustomFieldDefinitionJson { /** The name of the custom field, which is displayed in Jira. This is not the unique identifier. */ name: string; diff --git a/src/version3/models/customFieldOptionDetails.ts b/src/version3/models/customFieldOptionDetails.ts deleted file mode 100644 index 9edb4bf7b0..0000000000 --- a/src/version3/models/customFieldOptionDetails.ts +++ /dev/null @@ -1,9 +0,0 @@ -/** Details of a custom field option and its cascading options. */ -export interface CustomFieldOptionDetails { - /** The ID of the custom field option. */ - id?: number; - /** The value of the custom field option. */ - value?: string; - /** The cascading options. */ - cascadingOptions?: string[]; -} diff --git a/src/version3/models/customFieldOptionValue.ts b/src/version3/models/customFieldOptionValue.ts deleted file mode 100644 index 3b2b9918d3..0000000000 --- a/src/version3/models/customFieldOptionValue.ts +++ /dev/null @@ -1,7 +0,0 @@ -/** Value of a custom field option and the values of its cascading options. */ -export interface CustomFieldOptionValue { - /** The value of the custom field option. */ - value: string; - /** The cascading options. */ - cascadingOptions?: string[]; -} diff --git a/src/version3/models/dashboardUser.ts b/src/version3/models/dashboardUser.ts index a07bf47e83..8907f7d266 100644 --- a/src/version3/models/dashboardUser.ts +++ b/src/version3/models/dashboardUser.ts @@ -1,23 +1,8 @@ import { UserAvatarUrls } from './userAvatarUrls'; -/** @deprecated Use DashboardUser instead. */ -export type UserBean = DashboardUser; - export interface DashboardUser { - /** - * This property is deprecated in favor of `accountId` because of privacy changes. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The key of the user. - */ - key?: string; /** The URL of the user. */ self?: string; - /** - * This property is deprecated in favor of `accountId` because of privacy changes. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The username of the user. - */ - name?: string; /** The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */ displayName?: string; /** Whether the user is active. */ diff --git a/src/version3/models/deleteAndReplaceVersion.ts b/src/version3/models/deleteAndReplaceVersion.ts index 1a5ab00dcd..53b597f3ce 100644 --- a/src/version3/models/deleteAndReplaceVersion.ts +++ b/src/version3/models/deleteAndReplaceVersion.ts @@ -1,8 +1,5 @@ import { CustomFieldReplacement } from './customFieldReplacement'; -/** @deprecated Use DeleteAndReplaceVersion instead. */ -export type DeleteAndReplaceVersionBean = DeleteAndReplaceVersion; - export interface DeleteAndReplaceVersion { /** The ID of the version to update `fixVersion` to when the field contains the deleted version. */ moveFixIssuesTo?: number; diff --git a/src/version3/models/deprecatedWorkflow.ts b/src/version3/models/deprecatedWorkflow.ts deleted file mode 100644 index cdd7155bc4..0000000000 --- a/src/version3/models/deprecatedWorkflow.ts +++ /dev/null @@ -1,23 +0,0 @@ -import { Scope } from './scope'; - -/** Details about a workflow. */ -export interface DeprecatedWorkflow { - /** The name of the workflow. */ - name?: string; - /** The description of the workflow. */ - description?: string; - /** The datetime the workflow was last modified. */ - lastModifiedDate?: string; - /** - * This property is no longer available and will be removed from the documentation soon. See the [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - lastModifiedUser?: string; - /** The account ID of the user that last modified the workflow. */ - lastModifiedUserAccountId?: string; - /** The number of steps included in the workflow. */ - steps?: number; - scope?: Scope; - default?: boolean; -} diff --git a/src/version3/models/errorMessage.ts b/src/version3/models/errorMessage.ts deleted file mode 100644 index 45c1efb997..0000000000 --- a/src/version3/models/errorMessage.ts +++ /dev/null @@ -1,4 +0,0 @@ -export interface ErrorMessage { - /** The error message. */ - message: string; -} diff --git a/src/version3/models/fieldChangedClause.ts b/src/version3/models/fieldChangedClause.ts deleted file mode 100644 index 65702c8ff5..0000000000 --- a/src/version3/models/fieldChangedClause.ts +++ /dev/null @@ -1,15 +0,0 @@ -import { JqlQueryClauseTimePredicate } from './jqlQueryClauseTimePredicate'; -import { JqlQueryField } from './jqlQueryField'; - -/** - * A clause that asserts whether a field was changed. For example, `status CHANGED AFTER startOfMonth(-1M)`.See - * [CHANGED](https://confluence.atlassian.com/x/dgiiLQ#Advancedsearching-operatorsreference-CHANGEDCHANGED) for more - * information about the CHANGED operator. - */ -export interface FieldChangedClause { - field: JqlQueryField; - /** The operator applied to the field. */ - operator: string; - /** The list of time predicates. */ - predicates: JqlQueryClauseTimePredicate[]; -} diff --git a/src/version3/models/fieldMetadata.ts b/src/version3/models/fieldMetadata.ts deleted file mode 100644 index 8955f21bc6..0000000000 --- a/src/version3/models/fieldMetadata.ts +++ /dev/null @@ -1,24 +0,0 @@ -import { JsonType } from './jsonType'; - -/** The metadata describing an issue field. */ -export interface FieldMetadata { - /** Whether the field is required. */ - required: boolean; - schema?: JsonType; - /** The name of the field. */ - name: string; - /** The key of the field. */ - key: string; - /** The URL that can be used to automatically complete the field. */ - autoCompleteUrl?: string; - /** Whether the field has a default value. */ - hasDefaultValue?: boolean; - /** The list of operations that can be performed on the field. */ - operations: string[]; - /** The list of values allowed in the field. */ - allowedValues?: any[]; - /** The default value of the field. */ - defaultValue?: any; - /** The configuration properties. */ - configuration?: any; -} diff --git a/src/version3/models/fieldUpdateOperation.ts b/src/version3/models/fieldUpdateOperation.ts deleted file mode 100644 index 16b36f1364..0000000000 --- a/src/version3/models/fieldUpdateOperation.ts +++ /dev/null @@ -1,13 +0,0 @@ -/** Details of an operation to perform on a field. */ -export interface FieldUpdateOperation { - /** The value to add to the field. */ - add?: any; - /** The value to set in the field. */ - set?: any; - /** The value to removed from the field. */ - remove?: any; - /** The value to edit in the field. */ - edit?: any; - /** The field value to copy from another issue. */ - copy?: any; -} diff --git a/src/version3/models/fieldValueClause.ts b/src/version3/models/fieldValueClause.ts deleted file mode 100644 index b9b9272676..0000000000 --- a/src/version3/models/fieldValueClause.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { JqlQueryClauseOperand } from './jqlQueryClauseOperand'; -import { JqlQueryField } from './jqlQueryField'; - -/** A clause that asserts the current value of a field. For example, `summary ~ test`. */ -export interface FieldValueClause { - field: JqlQueryField; - /** The operator between the field and operand. */ - operator: string; - operand: JqlQueryClauseOperand; -} diff --git a/src/version3/models/fieldWasClause.ts b/src/version3/models/fieldWasClause.ts deleted file mode 100644 index 3aadeec93b..0000000000 --- a/src/version3/models/fieldWasClause.ts +++ /dev/null @@ -1,17 +0,0 @@ -import { JqlQueryClauseOperand } from './jqlQueryClauseOperand'; -import { JqlQueryClauseTimePredicate } from './jqlQueryClauseTimePredicate'; -import { JqlQueryField } from './jqlQueryField'; - -/** - * A clause that asserts a previous value of a field. For example, `status WAS "Resolved" BY currentUser() BEFORE - * "2019/02/02"`. See [WAS](https://confluence.atlassian.com/x/dgiiLQ#Advancedsearching-operatorsreference-WASWAS) for - * more information about the WAS operator. - */ -export interface FieldWasClause { - field: JqlQueryField; - /** The operator between the field and operand. */ - operator: string; - operand: JqlQueryClauseOperand; - /** The list of time predicates. */ - predicates: JqlQueryClauseTimePredicate[]; -} diff --git a/src/version3/models/functionOperand.ts b/src/version3/models/functionOperand.ts deleted file mode 100644 index ecb42aafdf..0000000000 --- a/src/version3/models/functionOperand.ts +++ /dev/null @@ -1,10 +0,0 @@ -/** - * An operand that is a function. See [Advanced searching - functions - * reference](https://confluence.atlassian.com/x/dwiiLQ) for more information about JQL functions. - */ -export interface FunctionOperand { - /** The name of the function. */ - function: string; - /** The list of function arguments. */ - arguments: string[]; -} diff --git a/src/version3/models/globalScope.ts b/src/version3/models/globalScope.ts index e87af77eb0..6f3e1c1fbe 100644 --- a/src/version3/models/globalScope.ts +++ b/src/version3/models/globalScope.ts @@ -1,6 +1,3 @@ -/** @deprecated Use GlobalScope instead. */ -export type GlobalScopeBean = GlobalScope; - export interface GlobalScope { /** * Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the diff --git a/src/version3/models/healthCheckResult.ts b/src/version3/models/healthCheckResult.ts deleted file mode 100644 index 105d7c17d1..0000000000 --- a/src/version3/models/healthCheckResult.ts +++ /dev/null @@ -1,9 +0,0 @@ -/** Jira instance health check results. Deprecated and no longer returned. */ -export interface HealthCheckResult { - /** The name of the Jira health check item. */ - name?: string; - /** The description of the Jira health check item. */ - description?: string; - /** Whether the Jira health check item passed or failed. */ - passed?: boolean; -} diff --git a/src/version3/models/hierarchy.ts b/src/version3/models/hierarchy.ts index 52abd63451..96fa6cdd4f 100644 --- a/src/version3/models/hierarchy.ts +++ b/src/version3/models/hierarchy.ts @@ -2,12 +2,6 @@ import { HierarchyLevel } from './hierarchyLevel'; /** The project issue type hierarchy. */ export interface Hierarchy { - /** - * The ID of the base level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from - * next-gen - * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - */ - baseLevelId?: number; /** Details about the hierarchy level. */ levels?: HierarchyLevel[]; } diff --git a/src/version3/models/hierarchyLevel.ts b/src/version3/models/hierarchyLevel.ts index e988df4515..2eb191fb3d 100644 --- a/src/version3/models/hierarchyLevel.ts +++ b/src/version3/models/hierarchyLevel.ts @@ -1,39 +1,9 @@ export interface HierarchyLevel { - /** - * The ID of the hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from - * next-gen - * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - */ - id?: number; /** The name of this hierarchy level. */ name?: string; - /** - * The ID of the level above this one in the hierarchy. This property is deprecated, see [Change notice: Removing - * hierarchy level IDs from next-gen - * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - */ - aboveLevelId?: number; - /** - * The ID of the level below this one in the hierarchy. This property is deprecated, see [Change notice: Removing - * hierarchy level IDs from next-gen - * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - */ - belowLevelId?: number; - /** - * The ID of the project configuration. This property is deprecated, see [Change oticen: Removing hierarchy level IDs - * from next-gen - * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - */ - projectConfigurationId?: number; /** The level of this item in the hierarchy. */ level?: number; /** The issue types available in this hierarchy level. */ issueTypeIds?: number[]; - /** - * The external UUID of the hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level - * IDs from next-gen - * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - */ - externalUuid?: string; globalHierarchyLevel?: string; } diff --git a/src/version3/models/id.ts b/src/version3/models/id.ts index 1647d553fe..c36c59265f 100644 --- a/src/version3/models/id.ts +++ b/src/version3/models/id.ts @@ -1,6 +1,3 @@ -/** @deprecated Use Id instead. */ -export type IdBean = Id; - export interface Id { /** * The ID of the permission scheme to associate with the project. Use the [Get all permission diff --git a/src/version3/models/idOrKey.ts b/src/version3/models/idOrKey.ts index f66cc7953d..1d5fc03ee9 100644 --- a/src/version3/models/idOrKey.ts +++ b/src/version3/models/idOrKey.ts @@ -1,6 +1,3 @@ -/** @deprecated Use IdOrKey instead. */ -export type IdOrKeyBean = IdOrKey; - export interface IdOrKey { /** The ID of the referenced item. */ id?: number; diff --git a/src/version3/models/index.ts b/src/version3/models/index.ts index 075dbd0258..45c21ade21 100644 --- a/src/version3/models/index.ts +++ b/src/version3/models/index.ts @@ -2,7 +2,6 @@ export * from './actorInput'; export * from './actorsMap'; export * from './addField'; export * from './addGroup'; -export * from './addNotificationsDetails'; export * from './addSecuritySchemeLevelsRequest'; export * from './announcementBannerConfiguration'; export * from './announcementBannerConfigurationUpdate'; @@ -13,7 +12,6 @@ export * from './archiveIssueAsyncRequest'; export * from './associatedItem'; export * from './associateFieldConfigurationsWithIssueTypesRequest'; export * from './attachment'; -export * from './attachmentArchive'; export * from './attachmentArchiveEntry'; export * from './attachmentArchiveImpl'; export * from './attachmentArchiveItemReadable'; @@ -29,8 +27,8 @@ export * from './availableDashboardGadgetsResponse'; export * from './avatar'; export * from './avatars'; export * from './avatarUrls'; +export * from './avatarWithDetails'; export * from './bulkChangeOwnerDetails'; -export * from './bulkCreateCustomFieldOptionRequest'; export * from './bulkCustomFieldOptionCreateRequest'; export * from './bulkCustomFieldOptionUpdateRequest'; export * from './bulkEditShareableEntity'; @@ -48,10 +46,8 @@ export * from './changedWorklogs'; export * from './changelog'; export * from './columnItem'; export * from './comment'; -export * from './component'; export * from './componentIssuesCount'; export * from './componentWithIssueCount'; -export * from './compoundClause'; export * from './configuration'; export * from './connectCustomFieldValue'; export * from './connectCustomFieldValues'; @@ -62,15 +58,12 @@ export * from './containerForProjectFeatures'; export * from './containerForRegisteredWebhooks'; export * from './containerForWebhookIDs'; export * from './containerOfWorkflowSchemeAssociations'; -export * from './context'; export * from './contextForProjectAndIssueType'; export * from './contextualConfiguration'; export * from './convertedJQLQueries'; -export * from './crateWorkflowStatusDetails'; export * from './createCustomFieldContext'; export * from './createdIssue'; export * from './createdIssues'; -export * from './createIssueAdjustmentDetails'; export * from './createIssueSecuritySchemeDetails'; export * from './createNotificationSchemeDetails'; export * from './createPriorityDetails'; @@ -89,9 +82,6 @@ export * from './customContextVariable'; export * from './customFieldConfigurations'; export * from './customFieldContext'; export * from './customFieldContextDefaultValue'; -export * from './customFieldContextDefaultValueCascadingOption'; -export * from './customFieldContextDefaultValueMultipleOption'; -export * from './customFieldContextDefaultValueSingleOption'; export * from './customFieldContextDefaultValueUpdate'; export * from './customFieldContextOption'; export * from './customFieldContextProjectMapping'; @@ -100,9 +90,7 @@ export * from './customFieldCreatedContextOptionsList'; export * from './customFieldDefinitionJson'; export * from './customFieldOption'; export * from './customFieldOptionCreate'; -export * from './customFieldOptionDetails'; export * from './customFieldOptionUpdate'; -export * from './customFieldOptionValue'; export * from './customFieldReplacement'; export * from './customFieldUpdatedContextOptionsList'; export * from './customFieldValueUpdate'; @@ -120,20 +108,17 @@ export * from './defaultLevelValue'; export * from './defaultShareScope'; export * from './defaultWorkflow'; export * from './deleteAndReplaceVersion'; -export * from './deprecatedWorkflow'; export * from './document'; export * from './entityProperty'; export * from './entityPropertyDetails'; export * from './error'; export * from './errorCollection'; -export * from './errorMessage'; export * from './errors'; export * from './eventNotification'; export * from './exportArchivedIssuesTaskProgress'; export * from './failedWebhook'; export * from './failedWebhooks'; export * from './field'; -export * from './fieldChangedClause'; export * from './fieldConfiguration'; export * from './fieldConfigurationDetails'; export * from './fieldConfigurationIssueTypeItem'; @@ -145,12 +130,8 @@ export * from './fieldConfigurationSchemeProjects'; export * from './fieldConfigurationToIssueTypeMapping'; export * from './fieldDetails'; export * from './fieldLastUsed'; -export * from './fieldMetadata'; export * from './fieldReferenceData'; export * from './fields'; -export * from './fieldUpdateOperation'; -export * from './fieldValueClause'; -export * from './fieldWasClause'; export * from './filter'; export * from './filterDetails'; export * from './filterSubscription'; @@ -160,14 +141,12 @@ export * from './foundGroup'; export * from './foundGroups'; export * from './foundUsers'; export * from './foundUsersAndGroups'; -export * from './functionOperand'; export * from './functionReferenceData'; export * from './globalScope'; export * from './group'; export * from './groupDetails'; export * from './groupLabel'; export * from './groupName'; -export * from './healthCheckResult'; export * from './hierarchy'; export * from './hierarchyLevel'; export * from './historyMetadata'; @@ -178,9 +157,6 @@ export * from './idOrKey'; export * from './includedFields'; export * from './index'; export * from './issue'; -export * from './issueAdjustmentContextDetails'; -export * from './issueAdjustmentDetails'; -export * from './issueAdjustmentIdentifiers'; export * from './issueArchivalSync'; export * from './issueArchivalSyncRequest'; export * from './issueChangelogIds'; @@ -254,7 +230,6 @@ export * from './jiraExpressionsComplexityValue'; export * from './jiraExpressionValidationError'; export * from './jiraStatus'; export * from './jqlFunctionPrecomputation'; -export * from './jqlFunctionPrecomputationPage'; export * from './jqlFunctionPrecomputationUpdate'; export * from './jqlFunctionPrecomputationUpdateRequest'; export * from './jQLPersonalDataMigrationRequest'; @@ -262,26 +237,20 @@ export * from './jqlQueriesToParse'; export * from './jqlQueriesToSanitize'; export * from './jqlQuery'; export * from './jqlQueryClause'; -export * from './jqlQueryClauseOperand'; -export * from './jqlQueryClauseTimePredicate'; export * from './jqlQueryField'; export * from './jqlQueryFieldEntityProperty'; export * from './jqlQueryOrderByClause'; export * from './jqlQueryOrderByClauseElement'; export * from './jqlQueryToSanitize'; -export * from './jqlQueryUnitaryOperand'; export * from './jQLQueryWithUnknownUsers'; export * from './jQLReferenceData'; -export * from './jsonNode'; export * from './jsonType'; -export * from './keywordOperand'; export * from './license'; export * from './licensedApplication'; export * from './licenseMetric'; export * from './linkedIssue'; export * from './linkGroup'; export * from './linkIssueRequestJson'; -export * from './listOperand'; export * from './listWrapperCallbackApplicationRole'; export * from './listWrapperCallbackGroupName'; export * from './locale'; @@ -313,25 +282,21 @@ export * from './pageBeanFieldConfigurationDetails'; export * from './pageChangelog'; export * from './pageComment'; export * from './pageComponentWithIssueCount'; -export * from './pageContext'; export * from './pageContextForProjectAndIssueType'; export * from './pageContextualConfiguration'; export * from './pageCustomFieldContext'; export * from './pageCustomFieldContextDefaultValue'; export * from './pageCustomFieldContextOption'; export * from './pageCustomFieldContextProjectMapping'; -export * from './pageCustomFieldOptionDetails'; export * from './pageDashboard'; export * from './pagedListUserDetailsApplicationUser'; export * from './pageField'; -export * from './pageFieldConfiguration'; export * from './pageFieldConfigurationIssueTypeItem'; export * from './pageFieldConfigurationItem'; export * from './pageFieldConfigurationScheme'; export * from './pageFieldConfigurationSchemeProjects'; export * from './pageFilterDetails'; export * from './pageGroupDetails'; -export * from './pageIssueAdjustmentDetails'; export * from './pageIssueFieldOption'; export * from './pageIssueSecurityLevelMember'; export * from './pageIssueSecuritySchemeToProjectMapping'; @@ -369,7 +334,6 @@ export * from './pageWebhook'; export * from './pageWorkflow'; export * from './pageWorkflowScheme'; export * from './pageWorkflowTransitionRules'; -export * from './paginatedResponseComment'; export * from './parsedJqlQueries'; export * from './parsedJqlQuery'; export * from './permissionDetails'; @@ -390,15 +354,11 @@ export * from './projectComponent'; export * from './projectDetails'; export * from './projectEmailAddress'; export * from './projectFeature'; -export * from './projectFeatures'; -export * from './projectFeaturesResponse'; export * from './projectFeatureToggleRequest'; -export * from './projectForScope'; export * from './projectId'; export * from './projectIdentifier'; export * from './projectIdentifiers'; export * from './projectIds'; -export * from './projectInput'; export * from './projectInsight'; export * from './projectIssueCreateMetadata'; export * from './projectIssueSecurityLevels'; @@ -418,7 +378,6 @@ export * from './projectScope'; export * from './projectType'; export * from './propertyKey'; export * from './propertyKeys'; -export * from './publishDraftWorkflowScheme'; export * from './publishedWorkflowId'; export * from './registeredWebhook'; export * from './remoteIssueLink'; @@ -426,8 +385,6 @@ export * from './remoteIssueLinkIdentifies'; export * from './remoteIssueLinkRequest'; export * from './remoteObject'; export * from './removeOptionFromIssuesResult'; -export * from './renamedCascadingOption'; -export * from './renamedOption'; export * from './reorderIssuePriorities'; export * from './reorderIssueResolutionsRequest'; export * from './resolution'; @@ -449,7 +406,6 @@ export * from './screenSchemeDetails'; export * from './screenSchemeId'; export * from './screenTypes'; export * from './screenWithTab'; -export * from './searchAutoComplete'; export * from './searchAutoCompleteFilter'; export * from './searchRequest'; export * from './searchResults'; @@ -482,7 +438,6 @@ export * from './statusMapping'; export * from './statusScope'; export * from './statusUpdate'; export * from './statusUpdateRequest'; -export * from './stringList'; export * from './suggestedIssue'; export * from './systemAvatars'; export * from './taskProgressObject'; @@ -497,11 +452,8 @@ export * from './uiModificationDetails'; export * from './uiModificationIdentifiers'; export * from './unrestrictedUserEmail'; export * from './updateCustomFieldDetails'; -export * from './updateCustomFieldOption'; -export * from './updateDefaultScreenScheme'; export * from './updatedProjectCategory'; export * from './updateFieldConfigurationSchemeDetails'; -export * from './updateIssueAdjustmentDetails'; export * from './updateIssueSecurityLevelDetails'; export * from './updateIssueSecuritySchemeRequest'; export * from './updateNotificationSchemeDetails'; @@ -519,10 +471,7 @@ export * from './userDetails'; export * from './userKey'; export * from './userList'; export * from './userMigration'; -export * from './userPermission'; export * from './userPickerUser'; -export * from './userWrite'; -export * from './valueOperand'; export * from './version'; export * from './versionIssueCounts'; export * from './versionIssuesStatus'; @@ -537,7 +486,6 @@ export * from './webhookDetails'; export * from './webhookRegistrationDetails'; export * from './webhooksExpirationDate'; export * from './workflow'; -export * from './workflowCompoundCondition'; export * from './workflowCondition'; export * from './workflowId'; export * from './workflowOperations'; @@ -548,7 +496,6 @@ export * from './workflowScheme'; export * from './workflowSchemeAssociations'; export * from './workflowSchemeIdName'; export * from './workflowSchemeProjectAssociation'; -export * from './workflowSimpleCondition'; export * from './workflowStatus'; export * from './workflowStatusProperties'; export * from './workflowsWithTransitionRulesDetails'; diff --git a/src/version3/models/issue.ts b/src/version3/models/issue.ts index e25b552a87..16051659c7 100644 --- a/src/version3/models/issue.ts +++ b/src/version3/models/issue.ts @@ -5,9 +5,6 @@ import { IssueUpdateMetadata } from './issueUpdateMetadata'; import { Operations } from './operations'; import { PageOfChangelogs } from './pageOfChangelogs'; -/** @deprecated Use {@link Issue} instead. */ -export type IssueBean = Issue; - /** Details about an issue. */ export interface Issue { /** Expand options that include additional issue details in the response. */ diff --git a/src/version3/models/issueAdjustmentContextDetails.ts b/src/version3/models/issueAdjustmentContextDetails.ts deleted file mode 100644 index a2e2898b85..0000000000 --- a/src/version3/models/issueAdjustmentContextDetails.ts +++ /dev/null @@ -1,13 +0,0 @@ -/** The details of an issue adjustment's context, which define where to activate the issue adjustment. */ -export interface IssueAdjustmentContextDetails { - /** The ID of the issue adjustment context. */ - id?: string; - /** The project ID of the context. */ - projectId: string; - /** The issue type ID of the context. */ - issueTypeId: string; - /** The view type of the context. Only `GIC` (Global Issue Create) is supported. */ - viewType: string; - /** Whether a context is available. For example, when a project is deleted the context becomes unavailable. */ - isAvailable?: boolean; -} diff --git a/src/version3/models/issueAdjustmentDetails.ts b/src/version3/models/issueAdjustmentDetails.ts deleted file mode 100644 index b70c9fbfd6..0000000000 --- a/src/version3/models/issueAdjustmentDetails.ts +++ /dev/null @@ -1,17 +0,0 @@ -import { IssueAdjustmentContextDetails } from './issueAdjustmentContextDetails'; - -/** The details of an issue adjustment. */ -export interface IssueAdjustmentDetails { - /** The ID of the issue adjustment. */ - id: string; - /** The name of the issue adjustment. The maximum length is 255 characters. */ - name: string; - /** The description of the issue adjustment. The maximum length is 255 characters. */ - description?: string; - /** The URL of the issue adjustment. */ - self: string; - /** The data of the issue adjustment. The maximum size of the data is 50000 characters. */ - data?: string; - /** List of contexts of the issue adjustment. The maximum number of contexts is 1000. */ - contexts?: IssueAdjustmentContextDetails[]; -} diff --git a/src/version3/models/issueAdjustmentIdentifiers.ts b/src/version3/models/issueAdjustmentIdentifiers.ts deleted file mode 100644 index c64c2e0c0c..0000000000 --- a/src/version3/models/issueAdjustmentIdentifiers.ts +++ /dev/null @@ -1,7 +0,0 @@ -/** Identifiers for an issue adjustment. */ -export interface IssueAdjustmentIdentifiers { - /** The ID of the issue adjustment. */ - id: string; - /** The URL of the issue adjustment. */ - self: string; -} diff --git a/src/version3/models/issueCommentListRequest.ts b/src/version3/models/issueCommentListRequest.ts index 4fca548ca3..3a3aae0cd3 100644 --- a/src/version3/models/issueCommentListRequest.ts +++ b/src/version3/models/issueCommentListRequest.ts @@ -1,6 +1,3 @@ -/** @deprecated Use IssueCommentListRequest instead. */ -export type IssueCommentListRequestBean = IssueCommentListRequest; - export interface IssueCommentListRequest { /** The list of comment IDs. A maximum of 1000 IDs can be specified. */ ids: number[]; diff --git a/src/version3/models/issueFieldOptionConfiguration.ts b/src/version3/models/issueFieldOptionConfiguration.ts index 039c2014b5..c1c8dfbbb6 100644 --- a/src/version3/models/issueFieldOptionConfiguration.ts +++ b/src/version3/models/issueFieldOptionConfiguration.ts @@ -3,6 +3,4 @@ import { IssueFieldOptionScope } from './issueFieldOptionScope'; /** Details of the projects the option is available in. */ export interface IssueFieldOptionConfiguration { scope?: IssueFieldOptionScope; - /** DEPRECATED */ - attributes?: string[]; } diff --git a/src/version3/models/issueFieldOptionCreate.ts b/src/version3/models/issueFieldOptionCreate.ts index 3694bd81e9..7a095d6826 100644 --- a/src/version3/models/issueFieldOptionCreate.ts +++ b/src/version3/models/issueFieldOptionCreate.ts @@ -1,8 +1,5 @@ import { IssueFieldOptionConfiguration } from './issueFieldOptionConfiguration'; -/** @deprecated Use IssueFieldOptionCreate instead. */ -export type IssueFieldOptionCreateBean = IssueFieldOptionCreate; - export interface IssueFieldOptionCreate { /** The option's name, which is displayed in Jira. */ value: string; diff --git a/src/version3/models/issueFieldOptionScope.ts b/src/version3/models/issueFieldOptionScope.ts index 86bde5cc89..1d2018c87f 100644 --- a/src/version3/models/issueFieldOptionScope.ts +++ b/src/version3/models/issueFieldOptionScope.ts @@ -1,12 +1,7 @@ import { GlobalScope } from './globalScope'; import { ProjectScope } from './projectScope'; -/** @deprecated Use IssueFieldOptionScope instead. */ -export type IssueFieldOptionScopeBean = IssueFieldOptionScope; - export interface IssueFieldOptionScope { - /** @deprecated DEPRECATED */ - projects?: number[]; /** * Defines the projects in which the option is available and the behavior of the option within each project. Specify * one object per project. The behavior of the option in a project context overrides the behavior in the global diff --git a/src/version3/models/issueTypeCreate.ts b/src/version3/models/issueTypeCreate.ts index 23c08be3e3..07a31fd581 100644 --- a/src/version3/models/issueTypeCreate.ts +++ b/src/version3/models/issueTypeCreate.ts @@ -3,12 +3,6 @@ export interface IssueTypeCreate { name: string; /** The description of the issue type. */ description?: string; - /** - * @deprecated Deprecated. Use `hierarchyLevel` instead. See the [deprecation - * notice](https://community.developer.atlassian.com/t/deprecation-of-the-epic-link-parent-link-and-other-related-fields-in-rest-apis-and-webhooks/54048) - * for details. Whether the issue type is `subtype` or `standard`. Defaults to `standard`. - */ - type?: string; /** * The hierarchy level of the issue type. Use: * diff --git a/src/version3/models/issueTypeUpdate.ts b/src/version3/models/issueTypeUpdate.ts index c9097e43c0..6cfafdc8f0 100644 --- a/src/version3/models/issueTypeUpdate.ts +++ b/src/version3/models/issueTypeUpdate.ts @@ -1,6 +1,3 @@ -/** @deprecated Use IssueTypeUpdate instead. */ -export type IssueTypeUpdateBean = IssueTypeUpdate; - export interface IssueTypeUpdate { /** The unique name for the issue type. The maximum length is 60 characters. */ name?: string; diff --git a/src/version3/models/issuesJqlMetaData.ts b/src/version3/models/issuesJqlMetaData.ts index 57484d3f46..ee3e5827e2 100644 --- a/src/version3/models/issuesJqlMetaData.ts +++ b/src/version3/models/issuesJqlMetaData.ts @@ -1,6 +1,3 @@ -/** @deprecated Use IssuesJqlMetaData instead. */ -export type IssuesJqlMetaDataBean = IssuesJqlMetaData; - /** The description of the page of issues loaded by the provided JQL query. */ export interface IssuesJqlMetaData { /** The index of the first issue. */ diff --git a/src/version3/models/issuesMeta.ts b/src/version3/models/issuesMeta.ts index a4f1d4bb73..6158728196 100644 --- a/src/version3/models/issuesMeta.ts +++ b/src/version3/models/issuesMeta.ts @@ -1,8 +1,5 @@ import { IssuesJqlMetaData } from './issuesJqlMetaData'; -/** @deprecated Use IssuesMeta instead. */ -export type IssuesMetaBean = IssuesMeta; - /** Meta data describing the `issues` context variable. */ export interface IssuesMeta { jql?: IssuesJqlMetaData; diff --git a/src/version3/models/issuesUpdate.ts b/src/version3/models/issuesUpdate.ts index 1a8da3eb11..57cb9b2bf8 100644 --- a/src/version3/models/issuesUpdate.ts +++ b/src/version3/models/issuesUpdate.ts @@ -1,8 +1,5 @@ import { IssueUpdateDetails } from './issueUpdateDetails'; -/** @deprecated Use IssuesUpdate instead. */ -export type IssuesUpdateBean = IssuesUpdate; - export interface IssuesUpdate { issueUpdates?: IssueUpdateDetails[]; } diff --git a/src/version3/models/jiraExpressionEvalContext.ts b/src/version3/models/jiraExpressionEvalContext.ts index 2e39e0e259..83ea9fffb3 100644 --- a/src/version3/models/jiraExpressionEvalContext.ts +++ b/src/version3/models/jiraExpressionEvalContext.ts @@ -2,9 +2,6 @@ import { CustomContextVariable } from './customContextVariable'; import { IdOrKey } from './idOrKey'; import { JexpIssues } from './jexpIssues'; -/** @deprecated Use JiraExpressionEvalContext instead. */ -export type JiraExpressionEvalContextBean = JiraExpressionEvalContext; - export interface JiraExpressionEvalContext { issue?: IdOrKey; issues?: JexpIssues; diff --git a/src/version3/models/jiraExpressionEvalRequest.ts b/src/version3/models/jiraExpressionEvalRequest.ts index 3d600fc397..cc768d239b 100644 --- a/src/version3/models/jiraExpressionEvalRequest.ts +++ b/src/version3/models/jiraExpressionEvalRequest.ts @@ -1,8 +1,5 @@ import { JiraExpressionEvalContext } from './jiraExpressionEvalContext'; -/** @deprecated Use JiraExpressionEvalRequest instead. */ -export type JiraExpressionEvalRequestBean = JiraExpressionEvalRequest; - export interface JiraExpressionEvalRequest { /** The Jira expression to evaluate. */ expression: string; diff --git a/src/version3/models/jiraExpressionEvaluationMetaData.ts b/src/version3/models/jiraExpressionEvaluationMetaData.ts index 668d0682c8..aba849f5d7 100644 --- a/src/version3/models/jiraExpressionEvaluationMetaData.ts +++ b/src/version3/models/jiraExpressionEvaluationMetaData.ts @@ -1,9 +1,6 @@ import { IssuesMeta } from './issuesMeta'; import { JiraExpressionsComplexity } from './jiraExpressionsComplexity'; -/** @deprecated Use JiraExpressionEvaluationMetaData instead. */ -export type JiraExpressionEvaluationMetaDataBean = JiraExpressionEvaluationMetaData; - export interface JiraExpressionEvaluationMetaData { complexity?: JiraExpressionsComplexity; issues?: IssuesMeta; diff --git a/src/version3/models/jiraExpressionsComplexity.ts b/src/version3/models/jiraExpressionsComplexity.ts index 2a7a29ca2b..3dfc524719 100644 --- a/src/version3/models/jiraExpressionsComplexity.ts +++ b/src/version3/models/jiraExpressionsComplexity.ts @@ -1,8 +1,5 @@ import { JiraExpressionsComplexityValue } from './jiraExpressionsComplexityValue'; -/** @deprecated Use JiraExpressionsComplexity instead. */ -export type JiraExpressionsComplexityBean = JiraExpressionsComplexity; - export interface JiraExpressionsComplexity { steps?: JiraExpressionsComplexityValue; expensiveOperations?: JiraExpressionsComplexityValue; diff --git a/src/version3/models/jiraExpressionsComplexityValue.ts b/src/version3/models/jiraExpressionsComplexityValue.ts index 9418d75ed6..57d0ac3dbe 100644 --- a/src/version3/models/jiraExpressionsComplexityValue.ts +++ b/src/version3/models/jiraExpressionsComplexityValue.ts @@ -1,6 +1,3 @@ -/** @deprecated Use JiraExpressionsComplexityValue instead. */ -export type JiraExpressionsComplexityValueBean = JiraExpressionsComplexityValue; - export interface JiraExpressionsComplexityValue { /** The complexity value of the current expression. */ value: number; diff --git a/src/version3/models/jqlFunctionPrecomputationPage.ts b/src/version3/models/jqlFunctionPrecomputationPage.ts deleted file mode 100644 index 793be4959b..0000000000 --- a/src/version3/models/jqlFunctionPrecomputationPage.ts +++ /dev/null @@ -1,19 +0,0 @@ -import { JqlFunctionPrecomputation } from './jqlFunctionPrecomputation'; - -/** A page of items. */ -export interface JqlFunctionPrecomputationPage { - /** Whether this is the last page. */ - isLast?: boolean; - /** The maximum number of items that could be returned. */ - maxResults?: number; - /** If there is another page of results, the URL of the next page. */ - nextPage?: string; - /** The URL of the page. */ - self?: string; - /** The index of the first item returned. */ - startAt?: number; - /** The number of items returned. */ - total?: number; - /** The list of items. */ - values?: JqlFunctionPrecomputation[]; -} diff --git a/src/version3/models/jqlQueryClauseOperand.ts b/src/version3/models/jqlQueryClauseOperand.ts deleted file mode 100644 index a36b3d3711..0000000000 --- a/src/version3/models/jqlQueryClauseOperand.ts +++ /dev/null @@ -1,2 +0,0 @@ -/** Details of an operand in a JQL clause. */ -export interface JqlQueryClauseOperand {} diff --git a/src/version3/models/jqlQueryClauseTimePredicate.ts b/src/version3/models/jqlQueryClauseTimePredicate.ts deleted file mode 100644 index 28472f63c3..0000000000 --- a/src/version3/models/jqlQueryClauseTimePredicate.ts +++ /dev/null @@ -1,8 +0,0 @@ -import { JqlQueryClauseOperand } from './jqlQueryClauseOperand'; - -/** A time predicate for a temporal JQL clause. */ -export interface JqlQueryClauseTimePredicate { - /** The operator between the field and the operand. */ - operator: string; - operand: JqlQueryClauseOperand; -} diff --git a/src/version3/models/jqlQueryUnitaryOperand.ts b/src/version3/models/jqlQueryUnitaryOperand.ts deleted file mode 100644 index 1812693776..0000000000 --- a/src/version3/models/jqlQueryUnitaryOperand.ts +++ /dev/null @@ -1,2 +0,0 @@ -/** An operand that can be part of a list operand. */ -export interface JqlQueryUnitaryOperand {} diff --git a/src/version3/models/jsonNode.ts b/src/version3/models/jsonNode.ts deleted file mode 100644 index 35e5541f77..0000000000 --- a/src/version3/models/jsonNode.ts +++ /dev/null @@ -1,38 +0,0 @@ -export interface JsonNode { - floatingPointNumber?: boolean; - elements?: {}; - pojo?: boolean; - number?: boolean; - integralNumber?: boolean; - int?: boolean; - long?: boolean; - double?: boolean; - bigDecimal?: boolean; - bigInteger?: boolean; - textual?: boolean; - boolean?: boolean; - binary?: boolean; - containerNode?: boolean; - missingNode?: boolean; - object?: boolean; - valueNode?: boolean; - numberValue?: number; - numberType?: string; - intValue?: number; - longValue?: number; - bigIntegerValue?: number; - doubleValue?: number; - decimalValue?: number; - booleanValue?: boolean; - binaryValue?: string[]; - valueAsInt?: number; - valueAsLong?: number; - valueAsDouble?: number; - valueAsBoolean?: boolean; - textValue?: string; - valueAsText?: string; - fieldNames?: {}; - array?: boolean; - fields?: {}; - null?: boolean; -} diff --git a/src/version3/models/jsonType.ts b/src/version3/models/jsonType.ts index 9a7a7f3542..2b50ec5e12 100644 --- a/src/version3/models/jsonType.ts +++ b/src/version3/models/jsonType.ts @@ -1,6 +1,3 @@ -/** @deprecated Use JsonType instead. */ -export type JsonTypeBean = JsonType; - /** The schema of a field. */ export interface JsonType { /** The data type of the field. */ diff --git a/src/version3/models/keywordOperand.ts b/src/version3/models/keywordOperand.ts deleted file mode 100644 index 8262c240b0..0000000000 --- a/src/version3/models/keywordOperand.ts +++ /dev/null @@ -1,9 +0,0 @@ -/** - * An operand that is a JQL keyword. See [Advanced searching - keywords - * reference](https://confluence.atlassian.com/jiracorecloud/advanced-searching-keywords-reference-765593717.html#Advancedsearching-keywordsreference-EMPTYEMPTY) - * for more information about operand keywords. - */ -export interface KeywordOperand { - /** The keyword that is the operand value. */ - keyword: string; -} diff --git a/src/version3/models/linkIssueRequestJson.ts b/src/version3/models/linkIssueRequestJson.ts index 9b36972e91..9445d9845a 100644 --- a/src/version3/models/linkIssueRequestJson.ts +++ b/src/version3/models/linkIssueRequestJson.ts @@ -2,9 +2,6 @@ import { Comment } from './comment'; import { IssueLinkType } from './issueLinkType'; import { LinkedIssue } from './linkedIssue'; -/** @deprecated Use LinkIssueRequestJson instead. */ -export type LinkIssueRequestJsonBean = LinkIssueRequestJson; - export interface LinkIssueRequestJson { type: IssueLinkType; inwardIssue: LinkedIssue; diff --git a/src/version3/models/listOperand.ts b/src/version3/models/listOperand.ts deleted file mode 100644 index e937ef7453..0000000000 --- a/src/version3/models/listOperand.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { JqlQueryUnitaryOperand } from './jqlQueryUnitaryOperand'; - -/** An operand that is a list of values. */ -export interface ListOperand { - /** The list of operand values. */ - values: JqlQueryUnitaryOperand[]; -} diff --git a/src/version3/models/moveField.ts b/src/version3/models/moveField.ts index 6982207c8c..2402f43f45 100644 --- a/src/version3/models/moveField.ts +++ b/src/version3/models/moveField.ts @@ -1,6 +1,3 @@ -/** @deprecated Use MoveField instead. */ -export type MoveFieldBean = MoveField; - export interface MoveField { /** * The ID of the screen tab field after which to place the moved screen tab field. Required if `position` isn't diff --git a/src/version3/models/newUserDetails.ts b/src/version3/models/newUserDetails.ts index 9d1387e68c..e4579ffe63 100644 --- a/src/version3/models/newUserDetails.ts +++ b/src/version3/models/newUserDetails.ts @@ -2,30 +2,6 @@ export interface NewUserDetails { /** The URL of the user. */ self?: string; - /** - * This property is no longer available. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - key?: string; - /** - * This property is no longer available. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - name?: string; - /** - * This property is no longer available. If the user has an Atlassian account, their password is not changed. If the - * user does not have an Atlassian account, they are sent an email asking them set up an account. - */ - password?: string; /** The email address for the user. */ emailAddress: string; - /** - * @deprecated This property is no longer available. If the user has an Atlassian account, their display name is not - * changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account. - */ - displayName?: string; - /** Deprecated, do not use. */ - applicationKeys?: string[]; } diff --git a/src/version3/models/pageChangelog.ts b/src/version3/models/pageChangelog.ts index d9377cb9ed..2d8414d867 100644 --- a/src/version3/models/pageChangelog.ts +++ b/src/version3/models/pageChangelog.ts @@ -1,8 +1,5 @@ import { Changelog } from './changelog'; -/** @deprecated Use PageChangelog instead. */ -export type PageBeanChangelog = PageChangelog; - /** A page of items. */ export interface PageChangelog { /** The URL of the page. */ diff --git a/src/version3/models/pageComment.ts b/src/version3/models/pageComment.ts index ff119f3f45..cfe680d593 100644 --- a/src/version3/models/pageComment.ts +++ b/src/version3/models/pageComment.ts @@ -1,8 +1,5 @@ import { Comment } from './comment'; -/** @deprecated Use PageComment instead. */ -export type PageBeanComment = PageComment; - /** A page of items. */ export interface PageComment { /** The URL of the page. */ diff --git a/src/version3/models/pageComponentWithIssueCount.ts b/src/version3/models/pageComponentWithIssueCount.ts index 0ad7ad262a..6d7c829514 100644 --- a/src/version3/models/pageComponentWithIssueCount.ts +++ b/src/version3/models/pageComponentWithIssueCount.ts @@ -1,8 +1,5 @@ import { ComponentWithIssueCount } from './componentWithIssueCount'; -/** @deprecated Use PageComponentWithIssueCount instead. */ -export type PageBeanComponentWithIssueCount = PageComponentWithIssueCount; - /** A page of items. */ export interface PageComponentWithIssueCount { /** The URL of the page. */ diff --git a/src/version3/models/pageContext.ts b/src/version3/models/pageContext.ts deleted file mode 100644 index a2865c6844..0000000000 --- a/src/version3/models/pageContext.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { Context } from './context'; - -/** @deprecated Use PageContext instead. */ -export type PageBeanContext = PageContext; - -/** A page of items. */ -export interface PageContext { - /** The URL of the page. */ - self?: string; - /** If there is another page of results, the URL of the next page. */ - nextPage?: string; - /** The maximum number of items that could be returned. */ - maxResults?: number; - /** The index of the first item returned. */ - startAt?: number; - /** The number of items returned. */ - total?: number; - /** Whether this is the last page. */ - isLast?: boolean; - /** The list of items. */ - values?: Context[]; -} diff --git a/src/version3/models/pageContextForProjectAndIssueType.ts b/src/version3/models/pageContextForProjectAndIssueType.ts index e5f7945537..2c6e95e799 100644 --- a/src/version3/models/pageContextForProjectAndIssueType.ts +++ b/src/version3/models/pageContextForProjectAndIssueType.ts @@ -1,8 +1,5 @@ import { ContextForProjectAndIssueType } from './contextForProjectAndIssueType'; -/** @deprecated Use PageContextForProjectAndIssueType instead. */ -export type PageBeanContextForProjectAndIssueType = PageContextForProjectAndIssueType; - /** A page of items. */ export interface PageContextForProjectAndIssueType { /** The URL of the page. */ diff --git a/src/version3/models/pageCustomFieldContext.ts b/src/version3/models/pageCustomFieldContext.ts index 0e77dd0299..3b69305aa9 100644 --- a/src/version3/models/pageCustomFieldContext.ts +++ b/src/version3/models/pageCustomFieldContext.ts @@ -1,8 +1,5 @@ import { CustomFieldContext } from './customFieldContext'; -/** @deprecated Use PageCustomFieldContext instead. */ -export type PageBeanCustomFieldContext = PageCustomFieldContext; - /** A page of items. */ export interface PageCustomFieldContext { /** The URL of the page. */ diff --git a/src/version3/models/pageCustomFieldContextDefaultValue.ts b/src/version3/models/pageCustomFieldContextDefaultValue.ts index d003b30a68..3023fd50ed 100644 --- a/src/version3/models/pageCustomFieldContextDefaultValue.ts +++ b/src/version3/models/pageCustomFieldContextDefaultValue.ts @@ -1,8 +1,5 @@ import { CustomFieldContextDefaultValue } from './customFieldContextDefaultValue'; -/** @deprecated Use PageCustomFieldContextDefaultValue instead. */ -export type PageBeanCustomFieldContextDefaultValue = PageCustomFieldContextDefaultValue; - /** A page of items. */ export interface PageCustomFieldContextDefaultValue { /** The URL of the page. */ diff --git a/src/version3/models/pageCustomFieldContextOption.ts b/src/version3/models/pageCustomFieldContextOption.ts index e4163b9b50..d3c8f21fb2 100644 --- a/src/version3/models/pageCustomFieldContextOption.ts +++ b/src/version3/models/pageCustomFieldContextOption.ts @@ -1,8 +1,5 @@ import { CustomFieldContextOption } from './customFieldContextOption'; -/** @deprecated Use PageCustomFieldContextOption instead. */ -export type PageBeanCustomFieldContextOption = PageCustomFieldContextOption; - /** A page of items. */ export interface PageCustomFieldContextOption { /** The URL of the page. */ diff --git a/src/version3/models/pageCustomFieldContextProjectMapping.ts b/src/version3/models/pageCustomFieldContextProjectMapping.ts index 54edf906c3..df43b2affd 100644 --- a/src/version3/models/pageCustomFieldContextProjectMapping.ts +++ b/src/version3/models/pageCustomFieldContextProjectMapping.ts @@ -1,8 +1,5 @@ import { CustomFieldContextProjectMapping } from './customFieldContextProjectMapping'; -/** @deprecated Use PageCustomFieldContextProjectMapping instead. */ -export type PageBeanCustomFieldContextProjectMapping = PageCustomFieldContextProjectMapping; - /** A page of items. */ export interface PageCustomFieldContextProjectMapping { /** The URL of the page. */ diff --git a/src/version3/models/pageCustomFieldOptionDetails.ts b/src/version3/models/pageCustomFieldOptionDetails.ts deleted file mode 100644 index 7a3dd916ad..0000000000 --- a/src/version3/models/pageCustomFieldOptionDetails.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { CustomFieldOptionDetails } from './customFieldOptionDetails'; - -/** @deprecated Use PageCustomFieldOptionDetails instead. */ -export type PageBeanCustomFieldOptionDetails = PageCustomFieldOptionDetails; - -/** A page of items. */ -export interface PageCustomFieldOptionDetails { - /** The URL of the page. */ - self?: string; - /** If there is another page of results, the URL of the next page. */ - nextPage?: string; - /** The maximum number of items that could be returned. */ - maxResults?: number; - /** The index of the first item returned. */ - startAt?: number; - /** The number of items returned. */ - total?: number; - /** Whether this is the last page. */ - isLast?: boolean; - /** The list of items. */ - values?: CustomFieldOptionDetails[]; -} diff --git a/src/version3/models/pageDashboard.ts b/src/version3/models/pageDashboard.ts index 233ba8c2ad..70159b5973 100644 --- a/src/version3/models/pageDashboard.ts +++ b/src/version3/models/pageDashboard.ts @@ -1,8 +1,5 @@ import { Dashboard } from './dashboard'; -/** @deprecated Use PageDashboard instead. */ -export type PageBeanDashboard = PageDashboard; - /** A page of items. */ export interface PageDashboard { /** The URL of the page. */ diff --git a/src/version3/models/pageField.ts b/src/version3/models/pageField.ts index be484f3495..77637f8b3d 100644 --- a/src/version3/models/pageField.ts +++ b/src/version3/models/pageField.ts @@ -1,8 +1,5 @@ import { Field } from './field'; -/** @deprecated Use PageField instead. */ -export type PageBeanField = PageField; - /** A page of items. */ export interface PageField { /** The URL of the page. */ diff --git a/src/version3/models/pageFieldConfiguration.ts b/src/version3/models/pageFieldConfiguration.ts deleted file mode 100644 index 263fcee3d3..0000000000 --- a/src/version3/models/pageFieldConfiguration.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { FieldConfiguration } from './fieldConfiguration'; - -/** @deprecated Use PageFieldConfiguration instead. */ -export type PageBeanFieldConfiguration = PageFieldConfiguration; - -/** A page of items. */ -export interface PageFieldConfiguration { - /** The URL of the page. */ - self?: string; - /** If there is another page of results, the URL of the next page. */ - nextPage?: string; - /** The maximum number of items that could be returned. */ - maxResults?: number; - /** The index of the first item returned. */ - startAt?: number; - /** The number of items returned. */ - total?: number; - /** Whether this is the last page. */ - isLast?: boolean; - /** The list of items. */ - values?: FieldConfiguration[]; -} diff --git a/src/version3/models/pageFieldConfigurationIssueTypeItem.ts b/src/version3/models/pageFieldConfigurationIssueTypeItem.ts index 5c4f4021ad..f20e3d1251 100644 --- a/src/version3/models/pageFieldConfigurationIssueTypeItem.ts +++ b/src/version3/models/pageFieldConfigurationIssueTypeItem.ts @@ -1,8 +1,5 @@ import { FieldConfigurationIssueTypeItem } from './fieldConfigurationIssueTypeItem'; -/** @deprecated Use PageFieldConfigurationIssueTypeItem instead. */ -export type PageBeanFieldConfigurationIssueTypeItem = PageFieldConfigurationIssueTypeItem; - /** A page of items. */ export interface PageFieldConfigurationIssueTypeItem { /** The URL of the page. */ diff --git a/src/version3/models/pageFieldConfigurationItem.ts b/src/version3/models/pageFieldConfigurationItem.ts index 98a7241e28..eb3e38ecbf 100644 --- a/src/version3/models/pageFieldConfigurationItem.ts +++ b/src/version3/models/pageFieldConfigurationItem.ts @@ -1,8 +1,5 @@ import { FieldConfigurationItem } from './fieldConfigurationItem'; -/** @deprecated Use PageFieldConfigurationItem instead. */ -export type PageBeanFieldConfigurationItem = PageFieldConfigurationItem; - /** A page of items. */ export interface PageFieldConfigurationItem { /** The URL of the page. */ diff --git a/src/version3/models/pageFieldConfigurationScheme.ts b/src/version3/models/pageFieldConfigurationScheme.ts index bd6c0adaf9..93c9b24632 100644 --- a/src/version3/models/pageFieldConfigurationScheme.ts +++ b/src/version3/models/pageFieldConfigurationScheme.ts @@ -1,8 +1,5 @@ import { FieldConfigurationScheme } from './fieldConfigurationScheme'; -/** @deprecated Use PageFieldConfigurationScheme instead. */ -export type PageBeanFieldConfigurationScheme = PageFieldConfigurationScheme; - /** A page of items. */ export interface PageFieldConfigurationScheme { /** The URL of the page. */ diff --git a/src/version3/models/pageFieldConfigurationSchemeProjects.ts b/src/version3/models/pageFieldConfigurationSchemeProjects.ts index f6ec78566e..c5256eda52 100644 --- a/src/version3/models/pageFieldConfigurationSchemeProjects.ts +++ b/src/version3/models/pageFieldConfigurationSchemeProjects.ts @@ -1,8 +1,5 @@ import { FieldConfigurationSchemeProjects } from './fieldConfigurationSchemeProjects'; -/** @deprecated Use PageFieldConfigurationSchemeProjects instead. */ -export type PageBeanFieldConfigurationSchemeProjects = PageFieldConfigurationSchemeProjects; - /** A page of items. */ export interface PageFieldConfigurationSchemeProjects { /** The URL of the page. */ diff --git a/src/version3/models/pageFilterDetails.ts b/src/version3/models/pageFilterDetails.ts index fd0dd3993e..bdf8189142 100644 --- a/src/version3/models/pageFilterDetails.ts +++ b/src/version3/models/pageFilterDetails.ts @@ -1,8 +1,5 @@ import { FilterDetails } from './filterDetails'; -/** @deprecated Use PageFilterDetails instead. */ -export type PageBeanFilterDetails = PageFilterDetails; - /** A page of items. */ export interface PageFilterDetails { /** The URL of the page. */ diff --git a/src/version3/models/pageGroupDetails.ts b/src/version3/models/pageGroupDetails.ts index 3a7d84eb8b..0d56bb97b1 100644 --- a/src/version3/models/pageGroupDetails.ts +++ b/src/version3/models/pageGroupDetails.ts @@ -1,8 +1,5 @@ import { GroupDetails } from './groupDetails'; -/** @deprecated Use PageGroupDetails instead. */ -export type PageBeanGroupDetails = PageGroupDetails; - /** A page of items. */ export interface PageGroupDetails { /** The URL of the page. */ diff --git a/src/version3/models/pageIssueAdjustmentDetails.ts b/src/version3/models/pageIssueAdjustmentDetails.ts deleted file mode 100644 index fc23aeeaea..0000000000 --- a/src/version3/models/pageIssueAdjustmentDetails.ts +++ /dev/null @@ -1,19 +0,0 @@ -import { IssueAdjustmentDetails } from './issueAdjustmentDetails'; - -/** A page of items. */ -export interface PageIssueAdjustmentDetails { - /** The URL of the page. */ - self?: string; - /** If there is another page of results, the URL of the next page. */ - nextPage?: string; - /** The maximum number of items that could be returned. */ - maxResults?: number; - /** The index of the first item returned. */ - startAt?: number; - /** The number of items returned. */ - total?: number; - /** Whether this is the last page. */ - isLast?: boolean; - /** The list of items. */ - values?: IssueAdjustmentDetails[]; -} diff --git a/src/version3/models/pageIssueFieldOption.ts b/src/version3/models/pageIssueFieldOption.ts index c2727b0dec..ff8ce09258 100644 --- a/src/version3/models/pageIssueFieldOption.ts +++ b/src/version3/models/pageIssueFieldOption.ts @@ -1,8 +1,5 @@ import { IssueFieldOption } from './issueFieldOption'; -/** @deprecated Use PageIssueFieldOption instead. */ -export type PageBeanIssueFieldOption = PageIssueFieldOption; - /** A page of items. */ export interface PageIssueFieldOption { /** The URL of the page. */ diff --git a/src/version3/models/pageIssueSecurityLevelMember.ts b/src/version3/models/pageIssueSecurityLevelMember.ts index 8d9cccd407..38f807591b 100644 --- a/src/version3/models/pageIssueSecurityLevelMember.ts +++ b/src/version3/models/pageIssueSecurityLevelMember.ts @@ -1,8 +1,5 @@ import { IssueSecurityLevelMember } from './issueSecurityLevelMember'; -/** @deprecated Use PageIssueSecurityLevelMember instead. */ -export type PageBeanIssueSecurityLevelMember = PageIssueSecurityLevelMember; - /** A page of items. */ export interface PageIssueSecurityLevelMember { /** The URL of the page. */ diff --git a/src/version3/models/pageIssueTypeScheme.ts b/src/version3/models/pageIssueTypeScheme.ts index 3809a3e3e1..ea905ca776 100644 --- a/src/version3/models/pageIssueTypeScheme.ts +++ b/src/version3/models/pageIssueTypeScheme.ts @@ -1,8 +1,5 @@ import { IssueTypeScheme } from './issueTypeScheme'; -/** @deprecated Use PageIssueTypeScheme instead. */ -export type PageBeanIssueTypeScheme = PageIssueTypeScheme; - /** A page of items. */ export interface PageIssueTypeScheme { /** The URL of the page. */ diff --git a/src/version3/models/pageIssueTypeSchemeMapping.ts b/src/version3/models/pageIssueTypeSchemeMapping.ts index 7e74eca688..958ef53482 100644 --- a/src/version3/models/pageIssueTypeSchemeMapping.ts +++ b/src/version3/models/pageIssueTypeSchemeMapping.ts @@ -1,8 +1,5 @@ import { IssueTypeSchemeMapping } from './issueTypeSchemeMapping'; -/** @deprecated Use PageIssueTypeSchemeMapping instead. */ -export type PageBeanIssueTypeSchemeMapping = PageIssueTypeSchemeMapping; - /** A page of items. */ export interface PageIssueTypeSchemeMapping { /** The URL of the page. */ diff --git a/src/version3/models/pageIssueTypeSchemeProjects.ts b/src/version3/models/pageIssueTypeSchemeProjects.ts index 6d90730298..d0d7557155 100644 --- a/src/version3/models/pageIssueTypeSchemeProjects.ts +++ b/src/version3/models/pageIssueTypeSchemeProjects.ts @@ -1,8 +1,5 @@ import { IssueTypeSchemeProjects } from './issueTypeSchemeProjects'; -/** @deprecated Use PageIssueTypeSchemeProjects instead. */ -export type PageBeanIssueTypeSchemeProjects = PageIssueTypeSchemeProjects; - /** A page of items. */ export interface PageIssueTypeSchemeProjects { /** The URL of the page. */ diff --git a/src/version3/models/pageIssueTypeScreenScheme.ts b/src/version3/models/pageIssueTypeScreenScheme.ts index b59432dd25..f48851d10f 100644 --- a/src/version3/models/pageIssueTypeScreenScheme.ts +++ b/src/version3/models/pageIssueTypeScreenScheme.ts @@ -1,8 +1,5 @@ import { IssueTypeScreenScheme } from './issueTypeScreenScheme'; -/** @deprecated Use PageIssueTypeScreenScheme instead. */ -export type PageBeanIssueTypeScreenScheme = PageIssueTypeScreenScheme; - /** A page of items. */ export interface PageIssueTypeScreenScheme { /** The URL of the page. */ diff --git a/src/version3/models/pageIssueTypeScreenSchemeItem.ts b/src/version3/models/pageIssueTypeScreenSchemeItem.ts index 7f24cc5e8c..dfd4137ed6 100644 --- a/src/version3/models/pageIssueTypeScreenSchemeItem.ts +++ b/src/version3/models/pageIssueTypeScreenSchemeItem.ts @@ -1,8 +1,5 @@ import { IssueTypeScreenSchemeItem } from './issueTypeScreenSchemeItem'; -/** @deprecated Use PageIssueTypeScreenSchemeItem instead. */ -export type PageBeanIssueTypeScreenSchemeItem = PageIssueTypeScreenSchemeItem; - /** A page of items. */ export interface PageIssueTypeScreenSchemeItem { /** The URL of the page. */ diff --git a/src/version3/models/pageIssueTypeScreenSchemesProjects.ts b/src/version3/models/pageIssueTypeScreenSchemesProjects.ts index b944e7beba..5cde072119 100644 --- a/src/version3/models/pageIssueTypeScreenSchemesProjects.ts +++ b/src/version3/models/pageIssueTypeScreenSchemesProjects.ts @@ -1,8 +1,5 @@ import { IssueTypeScreenSchemesProjects } from './issueTypeScreenSchemesProjects'; -/** @deprecated Use PageIssueTypeScreenSchemesProjects instead. */ -export type PageBeanIssueTypeScreenSchemesProjects = PageIssueTypeScreenSchemesProjects; - /** A page of items. */ export interface PageIssueTypeScreenSchemesProjects { /** The URL of the page. */ diff --git a/src/version3/models/pageIssueTypeToContextMapping.ts b/src/version3/models/pageIssueTypeToContextMapping.ts index 92f04015c2..044f3813d7 100644 --- a/src/version3/models/pageIssueTypeToContextMapping.ts +++ b/src/version3/models/pageIssueTypeToContextMapping.ts @@ -1,8 +1,5 @@ import { IssueTypeToContextMapping } from './issueTypeToContextMapping'; -/** @deprecated Use PageIssueTypeToContextMapping instead. */ -export type PageBeanIssueTypeToContextMapping = PageIssueTypeToContextMapping; - /** A page of items. */ export interface PageIssueTypeToContextMapping { /** The URL of the page. */ diff --git a/src/version3/models/pageNotificationScheme.ts b/src/version3/models/pageNotificationScheme.ts index 0fb10079d5..5afbda2546 100644 --- a/src/version3/models/pageNotificationScheme.ts +++ b/src/version3/models/pageNotificationScheme.ts @@ -1,8 +1,5 @@ import { NotificationScheme } from './notificationScheme'; -/** @deprecated Use PageNotificationScheme instead. */ -export type PageBeanNotificationScheme = PageNotificationScheme; - /** A page of items. */ export interface PageNotificationScheme { /** The URL of the page. */ diff --git a/src/version3/models/pageProject.ts b/src/version3/models/pageProject.ts index 7ae8dd3397..2da9654a91 100644 --- a/src/version3/models/pageProject.ts +++ b/src/version3/models/pageProject.ts @@ -1,8 +1,5 @@ import { Project } from './project'; -/** @deprecated Use PageProject instead. */ -export type PageBeanProject = PageProject; - /** A page of items. */ export interface PageProject { /** The URL of the page. */ diff --git a/src/version3/models/pageScreen.ts b/src/version3/models/pageScreen.ts index 8f9c27b7f3..82435a4d0a 100644 --- a/src/version3/models/pageScreen.ts +++ b/src/version3/models/pageScreen.ts @@ -1,8 +1,5 @@ import { Screen } from './screen'; -/** @deprecated Use PageScreen instead. */ -export type PageBeanScreen = PageScreen; - /** A page of items. */ export interface PageScreen { /** The URL of the page. */ diff --git a/src/version3/models/pageScreenScheme.ts b/src/version3/models/pageScreenScheme.ts index ab10e1b7cf..a5023d3c76 100644 --- a/src/version3/models/pageScreenScheme.ts +++ b/src/version3/models/pageScreenScheme.ts @@ -1,8 +1,5 @@ import { ScreenScheme } from './screenScheme'; -/** @deprecated Use PageScreenScheme instead. */ -export type PageBeanScreenScheme = PageScreenScheme; - /** A page of items. */ export interface PageScreenScheme { /** The URL of the page. */ diff --git a/src/version3/models/pageScreenWithTab.ts b/src/version3/models/pageScreenWithTab.ts index 258b0fe854..df960a6bb3 100644 --- a/src/version3/models/pageScreenWithTab.ts +++ b/src/version3/models/pageScreenWithTab.ts @@ -1,8 +1,5 @@ import { ScreenWithTab } from './screenWithTab'; -/** @deprecated Use PageScreenWithTab instead. */ -export type PageBeanScreenWithTab = PageScreenWithTab; - /** A page of items. */ export interface PageScreenWithTab { /** The URL of the page. */ diff --git a/src/version3/models/pageString.ts b/src/version3/models/pageString.ts index d6390d068d..a17fa1b729 100644 --- a/src/version3/models/pageString.ts +++ b/src/version3/models/pageString.ts @@ -1,6 +1,3 @@ -/** @deprecated Use PageString instead. */ -export type PageBeanString = PageString; - /** A page of items. */ export interface PageString { /** The URL of the page. */ diff --git a/src/version3/models/pageUser.ts b/src/version3/models/pageUser.ts index 353c94cd21..34572905e2 100644 --- a/src/version3/models/pageUser.ts +++ b/src/version3/models/pageUser.ts @@ -1,8 +1,5 @@ import { User } from './user'; -/** @deprecated Use PageUser instead. */ -export type PageBeanUser = PageUser; - /** A page of items. */ export interface PageUser { /** The URL of the page. */ diff --git a/src/version3/models/pageUserDetails.ts b/src/version3/models/pageUserDetails.ts index f408506f89..e6811dd394 100644 --- a/src/version3/models/pageUserDetails.ts +++ b/src/version3/models/pageUserDetails.ts @@ -1,8 +1,5 @@ import { UserDetails } from './userDetails'; -/** @deprecated Use PageUserDetails instead. */ -export type PageBeanUserDetails = PageUserDetails; - /** A page of items. */ export interface PageUserDetails { /** The URL of the page. */ diff --git a/src/version3/models/pageUserKey.ts b/src/version3/models/pageUserKey.ts index 298c8c9238..015d8a4d22 100644 --- a/src/version3/models/pageUserKey.ts +++ b/src/version3/models/pageUserKey.ts @@ -1,8 +1,5 @@ import { UserKey } from './userKey'; -/** @deprecated Use PageUserKey instead. */ -export type PageBeanUserKey = PageUserKey; - /** A page of items. */ export interface PageUserKey { /** The URL of the page. */ diff --git a/src/version3/models/pageVersion.ts b/src/version3/models/pageVersion.ts index 84bb492548..32cd68c57f 100644 --- a/src/version3/models/pageVersion.ts +++ b/src/version3/models/pageVersion.ts @@ -1,8 +1,5 @@ import { Version } from './version'; -/** @deprecated Use PageVersion instead. */ -export type PageBeanVersion = PageVersion; - /** A page of items. */ export interface PageVersion { /** The URL of the page. */ diff --git a/src/version3/models/pageWebhook.ts b/src/version3/models/pageWebhook.ts index 4a6b923b08..0af6a7d896 100644 --- a/src/version3/models/pageWebhook.ts +++ b/src/version3/models/pageWebhook.ts @@ -1,8 +1,5 @@ import { Webhook } from './webhook'; -/** @deprecated Use PageWebhook instead. */ -export type PageBeanWebhook = PageWebhook; - /** A page of items. */ export interface PageWebhook { /** The URL of the page. */ diff --git a/src/version3/models/pageWorkflow.ts b/src/version3/models/pageWorkflow.ts index bb3c572bfe..838f83cbe4 100644 --- a/src/version3/models/pageWorkflow.ts +++ b/src/version3/models/pageWorkflow.ts @@ -1,8 +1,5 @@ import { Workflow } from './workflow'; -/** @deprecated Use PageWorkflow instead. */ -export type PageBeanWorkflow = PageWorkflow; - /** A page of items. */ export interface PageWorkflow { /** The URL of the page. */ diff --git a/src/version3/models/pageWorkflowScheme.ts b/src/version3/models/pageWorkflowScheme.ts index e4223b5d87..5f13702201 100644 --- a/src/version3/models/pageWorkflowScheme.ts +++ b/src/version3/models/pageWorkflowScheme.ts @@ -1,8 +1,5 @@ import { WorkflowScheme } from './workflowScheme'; -/** @deprecated Use PageWorkflowScheme instead. */ -export type PageBeanWorkflowScheme = PageWorkflowScheme; - /** A page of items. */ export interface PageWorkflowScheme { /** The URL of the page. */ diff --git a/src/version3/models/pageWorkflowTransitionRules.ts b/src/version3/models/pageWorkflowTransitionRules.ts index fd7be11672..2502898916 100644 --- a/src/version3/models/pageWorkflowTransitionRules.ts +++ b/src/version3/models/pageWorkflowTransitionRules.ts @@ -1,8 +1,5 @@ import { WorkflowTransitionRules } from './workflowTransitionRules'; -/** @deprecated Use PageWorkflowTransitionRules instead. */ -export type PageBeanWorkflowTransitionRules = PageWorkflowTransitionRules; - /** A page of items. */ export interface PageWorkflowTransitionRules { /** The URL of the page. */ diff --git a/src/version3/models/paginatedResponseComment.ts b/src/version3/models/paginatedResponseComment.ts deleted file mode 100644 index 8d48300af2..0000000000 --- a/src/version3/models/paginatedResponseComment.ts +++ /dev/null @@ -1,8 +0,0 @@ -import { Comment } from './comment'; - -export interface PaginatedResponseComment { - total?: number; - startAt?: number; - maxResults?: number; - results?: Comment[]; -} diff --git a/src/version3/models/permissionsKeys.ts b/src/version3/models/permissionsKeys.ts index 5a6463bf84..3fc65387c3 100644 --- a/src/version3/models/permissionsKeys.ts +++ b/src/version3/models/permissionsKeys.ts @@ -1,6 +1,3 @@ -/** @deprecated Use PermissionsKeys instead. */ -export type PermissionsKeysBean = PermissionsKeys; - export interface PermissionsKeys { /** A list of permission keys. */ permissions: string[]; diff --git a/src/version3/models/project.ts b/src/version3/models/project.ts index b3cc4bf714..de75e7ed69 100644 --- a/src/version3/models/project.ts +++ b/src/version3/models/project.ts @@ -86,13 +86,3 @@ export interface Project { archivedBy?: User; landingPageInfo?: ProjectLandingPageInfo; } - -export namespace Project { - export enum Expand { - Description = 'description', - IssueTypes = 'issueTypes', - Lead = 'lead', - ProjectKeys = 'projectKeys', - IssueTypeHierarchy = 'issueTypeHierarchy', - } -} diff --git a/src/version3/models/projectFeatures.ts b/src/version3/models/projectFeatures.ts deleted file mode 100644 index 943a2e74c4..0000000000 --- a/src/version3/models/projectFeatures.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { ProjectFeature } from './projectFeature'; - -/** @deprecated Use {@link ContainerForProjectFeatures}. Container for the list of features on the project. */ -export interface ProjectFeatures { - /** The list of features on the project. */ - features?: ProjectFeature[]; -} diff --git a/src/version3/models/projectFeaturesResponse.ts b/src/version3/models/projectFeaturesResponse.ts deleted file mode 100644 index 8c94a18469..0000000000 --- a/src/version3/models/projectFeaturesResponse.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { ProjectFeature } from './projectFeature'; - -/** Container for the list of features on the project. */ -export interface ProjectFeaturesResponse { - /** The list of features on the project. */ - features?: ProjectFeature[]; -} diff --git a/src/version3/models/projectForScope.ts b/src/version3/models/projectForScope.ts deleted file mode 100644 index 72ed182897..0000000000 --- a/src/version3/models/projectForScope.ts +++ /dev/null @@ -1,24 +0,0 @@ -import { AvatarUrls } from './avatarUrls'; -import { UpdatedProjectCategory } from './updatedProjectCategory'; - -/** Details about a next-gen project. */ -export interface ProjectForScope { - /** The URL of the project details. */ - self?: string; - /** The ID of the project. */ - id?: string; - /** The key of the project. */ - key?: string; - /** The name of the project. */ - name?: string; - /** - * The [project - * type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the - * project. - */ - projectTypeKey?: string; - /** Whether or not the project is simplified. */ - simplified?: boolean; - avatarUrls?: AvatarUrls; - projectCategory?: UpdatedProjectCategory; -} diff --git a/src/version3/models/projectIdentifier.ts b/src/version3/models/projectIdentifier.ts index 8ab84bf05d..1a0c6852a1 100644 --- a/src/version3/models/projectIdentifier.ts +++ b/src/version3/models/projectIdentifier.ts @@ -1,6 +1,3 @@ -/** @deprecated Use ProjectIdentifier instead. */ -export type ProjectIdentifierBean = ProjectIdentifier; - /** The identifiers for a project. */ export interface ProjectIdentifier { /** The ID of the project. */ diff --git a/src/version3/models/projectInput.ts b/src/version3/models/projectInput.ts deleted file mode 100644 index dff4ec083c..0000000000 --- a/src/version3/models/projectInput.ts +++ /dev/null @@ -1,67 +0,0 @@ -/** @deprecated Use ProjectInput instead. */ -export type ProjectInputBean = ProjectInput; - -/** @deprecated This model divided to `UpdateProjectDetails` and `CreateProjectDetails`. */ -export interface ProjectInput { - /** - * 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. Required when creating a project. Optional when updating a - * project. - */ - key?: string; - /** The name of the project. Required when creating a project. Optional when updating a project. */ - name?: string; - /** - * The [project - * type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes), which - * dictates the application-specific feature set. Required when creating a project. Not applicable for the Update - * project resource. - */ - projectTypeKey?: string; - /** - * A prebuilt configuration for a project. The type of the `projectTemplateKey` must match with the type of the - * `projectTypeKey`. Required when creating a project. Not applicable for the Update project resource. - */ - projectTemplateKey?: string; - /** A brief description of the project. */ - description?: string; - /** - * This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The user name of the project lead. Either `lead` or `leadAccountId` must be set when creating a - * project. Optional when updating a project. Cannot be provided with `leadAccountId`. - */ - lead?: string; - /** - * The account ID of the project lead. Either `lead` or `leadAccountId` must be set when creating a project. Optional - * when updating a project. 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-3-issuesecurityschemes-get) resource to get all issue security - * scheme IDs. - */ - issueSecurityScheme?: number; - /** - * The ID of the permission scheme for the project. Use the [Get all permission - * schemes](#api-rest-api-3-permissionscheme-get) resource to see a list of all permission scheme IDs. - */ - permissionScheme?: number; - /** - * The ID of the notification scheme for the project. Use the [Get notification - * schemes](#api-rest-api-3-notificationscheme-get) resource to get a list of notification scheme IDs. - */ - notificationScheme?: 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-3-projectCategory-get) operation. - */ - categoryId?: number; -} diff --git a/src/version3/models/projectIssueTypesHierarchyLevel.ts b/src/version3/models/projectIssueTypesHierarchyLevel.ts index fc19c54c23..b4d9b2bc88 100644 --- a/src/version3/models/projectIssueTypesHierarchyLevel.ts +++ b/src/version3/models/projectIssueTypesHierarchyLevel.ts @@ -2,12 +2,6 @@ import { IssueTypeInfo } from './issueTypeInfo'; /** Details of an issue type hierarchy level. */ export interface ProjectIssueTypesHierarchyLevel { - /** - * @deprecated The ID of the issue type hierarchy level. This property is deprecated, see [Change notice: Removing - * hierarchy level IDs from next-gen - * APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). - */ - entityId?: string; /** The level of the issue type hierarchy level. */ level?: number; /** The name of the issue type hierarchy level. */ diff --git a/src/version3/models/projectRoleActorsUpdate.ts b/src/version3/models/projectRoleActorsUpdate.ts index baaf6a8053..687796ad50 100644 --- a/src/version3/models/projectRoleActorsUpdate.ts +++ b/src/version3/models/projectRoleActorsUpdate.ts @@ -1,6 +1,3 @@ -/** @deprecated Use ProjectRoleActorsUpdate instead. */ -export type ProjectRoleActorsUpdateBean = ProjectRoleActorsUpdate; - export interface ProjectRoleActorsUpdate { /** * The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role diff --git a/src/version3/models/projectScope.ts b/src/version3/models/projectScope.ts index 30569429de..4865575af3 100644 --- a/src/version3/models/projectScope.ts +++ b/src/version3/models/projectScope.ts @@ -1,6 +1,3 @@ -/** @deprecated Use ProjectScope instead. */ -export type ProjectScopeBean = ProjectScope; - export interface ProjectScope { /** The ID of the project that the option's behavior applies to. */ id?: number; diff --git a/src/version3/models/publishDraftWorkflowScheme.ts b/src/version3/models/publishDraftWorkflowScheme.ts deleted file mode 100644 index 13a785c311..0000000000 --- a/src/version3/models/publishDraftWorkflowScheme.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { StatusMapping } from './statusMapping'; - -/** Details about the status mappings for publishing a draft workflow scheme. */ -export interface PublishDraftWorkflowScheme { - /** Mappings of statuses to new statuses for issue types. */ - statusMappings?: StatusMapping[]; -} diff --git a/src/version3/models/renamedCascadingOption.ts b/src/version3/models/renamedCascadingOption.ts deleted file mode 100644 index 31d76a3223..0000000000 --- a/src/version3/models/renamedCascadingOption.ts +++ /dev/null @@ -1,7 +0,0 @@ -/** Details of a custom field cascading option to rename. */ -export interface RenamedCascadingOption { - /** The value of the cascading option. */ - value: string; - /** The new value of the cascading option. */ - newValue: string; -} diff --git a/src/version3/models/renamedOption.ts b/src/version3/models/renamedOption.ts deleted file mode 100644 index 0e415d653d..0000000000 --- a/src/version3/models/renamedOption.ts +++ /dev/null @@ -1,11 +0,0 @@ -import { RenamedCascadingOption } from './renamedCascadingOption'; - -/** Details of a custom field option to rename. */ -export interface RenamedOption { - /** The current option value. */ - value: string; - /** The new value of the option. */ - newValue: string; - /** The new values for the cascading options of this option. Only used for Select List (cascading) fields. */ - cascadingOptions?: RenamedCascadingOption[]; -} diff --git a/src/version3/models/searchAutoComplete.ts b/src/version3/models/searchAutoComplete.ts deleted file mode 100644 index 435ed235e9..0000000000 --- a/src/version3/models/searchAutoComplete.ts +++ /dev/null @@ -1,4 +0,0 @@ -import { SearchAutoCompleteFilter } from './searchAutoCompleteFilter'; - -/** @deprecated */ -export type SearchAutoComplete = SearchAutoCompleteFilter; diff --git a/src/version3/models/searchRequest.ts b/src/version3/models/searchRequest.ts index 00de612413..e81a416e07 100644 --- a/src/version3/models/searchRequest.ts +++ b/src/version3/models/searchRequest.ts @@ -1,6 +1,3 @@ -/** @deprecated Use SearchRequest instead. */ -export type SearchRequestBean = SearchRequest; - export interface SearchRequest { /** A [JQL](https://confluence.atlassian.com/x/egORLQ) expression. */ jql?: string; diff --git a/src/version3/models/serverInformation.ts b/src/version3/models/serverInformation.ts index 988341d007..b00a4f7b0d 100644 --- a/src/version3/models/serverInformation.ts +++ b/src/version3/models/serverInformation.ts @@ -1,5 +1,3 @@ -import { HealthCheckResult } from './healthCheckResult'; - /** Details about the Jira instance. */ export interface ServerInformation { /** The base URL of the Jira instance. */ @@ -20,6 +18,4 @@ export interface ServerInformation { scmInfo?: string; /** The name of the Jira instance. */ serverTitle?: string; - /** Jira instance health check results. Deprecated and no longer returned. */ - healthChecks?: HealthCheckResult[]; } diff --git a/src/version3/models/simpleApplicationProperty.ts b/src/version3/models/simpleApplicationProperty.ts index a5a507ead3..98827ffd3b 100644 --- a/src/version3/models/simpleApplicationProperty.ts +++ b/src/version3/models/simpleApplicationProperty.ts @@ -1,6 +1,3 @@ -/** @deprecated Use SimpleApplicationProperty instead. */ -export type SimpleApplicationPropertyBean = SimpleApplicationProperty; - export interface SimpleApplicationProperty { /** The ID of the application property. */ id?: string; diff --git a/src/version3/models/stringList.ts b/src/version3/models/stringList.ts deleted file mode 100644 index 1a49a7f9a1..0000000000 --- a/src/version3/models/stringList.ts +++ /dev/null @@ -1 +0,0 @@ -export interface StringList {} diff --git a/src/version3/models/taskProgressObject.ts b/src/version3/models/taskProgressObject.ts index f63e15f894..44df841ab5 100644 --- a/src/version3/models/taskProgressObject.ts +++ b/src/version3/models/taskProgressObject.ts @@ -1,6 +1,3 @@ -/** @deprecated Use TaskProgressObject instead. */ -export type TaskProgressBeanObject = TaskProgressObject; - /** Details about a task. */ export interface TaskProgressObject { /** The URL of the task. */ diff --git a/src/version3/models/taskProgressRemoveOptionFromIssuesResult.ts b/src/version3/models/taskProgressRemoveOptionFromIssuesResult.ts index 2f948473b1..a154fb2629 100644 --- a/src/version3/models/taskProgressRemoveOptionFromIssuesResult.ts +++ b/src/version3/models/taskProgressRemoveOptionFromIssuesResult.ts @@ -1,8 +1,5 @@ import { RemoveOptionFromIssuesResult } from './removeOptionFromIssuesResult'; -/** @deprecated Use TaskProgressRemoveOptionFromIssuesResult instead. */ -export type TaskProgressBeanRemoveOptionFromIssuesResult = TaskProgressRemoveOptionFromIssuesResult; - /** Details about a task. */ export interface TaskProgressRemoveOptionFromIssuesResult { /** The URL of the task. */ diff --git a/src/version3/models/updateCustomFieldOption.ts b/src/version3/models/updateCustomFieldOption.ts deleted file mode 100644 index 3f69a0d102..0000000000 --- a/src/version3/models/updateCustomFieldOption.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { RenamedOption } from './renamedOption'; - -/** Details of the options to update for a custom field. */ -export interface UpdateCustomFieldOption { - /** Details of the options to update. */ - options?: RenamedOption[]; -} diff --git a/src/version3/models/updateDefaultScreenScheme.ts b/src/version3/models/updateDefaultScreenScheme.ts deleted file mode 100644 index fb40becb7d..0000000000 --- a/src/version3/models/updateDefaultScreenScheme.ts +++ /dev/null @@ -1,5 +0,0 @@ -/** The ID of a screen scheme. */ -export interface UpdateDefaultScreenScheme { - /** The ID of the screen scheme. */ - screenSchemeId: string; -} diff --git a/src/version3/models/updateIssueAdjustmentDetails.ts b/src/version3/models/updateIssueAdjustmentDetails.ts deleted file mode 100644 index 52f5d26942..0000000000 --- a/src/version3/models/updateIssueAdjustmentDetails.ts +++ /dev/null @@ -1,16 +0,0 @@ -import { IssueAdjustmentContextDetails } from './issueAdjustmentContextDetails'; - -/** The details of an issue adjustment. */ -export interface UpdateIssueAdjustmentDetails { - /** The name of the issue adjustment. The maximum length is 255 characters. */ - name?: string; - /** The description of the issue adjustment. The maximum length is 255 characters. */ - description?: string; - /** The data of the issue adjustment. The maximum size of the data is 50000 characters. */ - data?: string; - /** - * List of contexts of the issue adjustment. The maximum number of contexts is 1000. If provided, replaces all - * existing contexts. - */ - contexts?: IssueAdjustmentContextDetails[]; -} diff --git a/src/version3/models/updateProjectDetails.ts b/src/version3/models/updateProjectDetails.ts index d46d504775..662e8afbdd 100644 --- a/src/version3/models/updateProjectDetails.ts +++ b/src/version3/models/updateProjectDetails.ts @@ -9,14 +9,8 @@ export interface UpdateProjectDetails { name?: string; /** A brief description of the project. */ description?: string; - /** - * This parameter is deprecated because of privacy changes. Use `leadAccountId` instead. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. The user name of the project lead. Cannot be provided with `leadAccountId`. - */ - lead?: string; /** The account ID of the project lead. Cannot be provided with `lead`. */ - leadAccountId?: string; + leadAccountId: string; /** A link to information about this project, such as project documentation */ url?: string; /** The default assignee when creating issues for this project. */ diff --git a/src/version3/models/updateUserToGroup.ts b/src/version3/models/updateUserToGroup.ts index 1e4ce5b3e0..7d8d712f24 100644 --- a/src/version3/models/updateUserToGroup.ts +++ b/src/version3/models/updateUserToGroup.ts @@ -1,6 +1,3 @@ -/** @deprecated Use UpdateUserToGroup instead. */ -export type UpdateUserToGroupBean = UpdateUserToGroup; - export interface UpdateUserToGroup { /** * This property is no longer available. See the [deprecation diff --git a/src/version3/models/userAvatarUrls.ts b/src/version3/models/userAvatarUrls.ts index 635b21a333..e59b51f113 100644 --- a/src/version3/models/userAvatarUrls.ts +++ b/src/version3/models/userAvatarUrls.ts @@ -1,6 +1,3 @@ -/** @deprecated Use UserAvatarUrls instead. */ -export type UserBeanAvatarUrls = UserAvatarUrls; - export interface UserAvatarUrls { /** The URL of the user's 16x16 pixel avatar. */ '16x16'?: string; diff --git a/src/version3/models/userMigration.ts b/src/version3/models/userMigration.ts index 9a84c6d0bb..569283191b 100644 --- a/src/version3/models/userMigration.ts +++ b/src/version3/models/userMigration.ts @@ -1,6 +1,3 @@ -/** @deprecated Use UserMigration instead. */ -export type UserMigrationBean = UserMigration; - export interface UserMigration { key?: string; username?: string; diff --git a/src/version3/models/userPermission.ts b/src/version3/models/userPermission.ts deleted file mode 100644 index 12f39e8f63..0000000000 --- a/src/version3/models/userPermission.ts +++ /dev/null @@ -1,26 +0,0 @@ -/** Details of a permission and its availability to a user. */ -export interface UserPermission { - /** - * The ID of the permission. Either `id` or `key` must be specified. Use [Get all - * permissions](#api-rest-api-3-permissions-get) to get the list of permissions. - */ - id?: string; - /** - * The key of the permission. Either `id` or `key` must be specified. Use [Get all - * permissions](#api-rest-api-3-permissions-get) to get the list of permissions. - */ - key?: string; - /** The name of the permission. */ - name?: string; - /** The type of the permission. */ - type?: string; - /** The description of the permission. */ - description?: string; - /** Whether the permission is available to the user in the queried context. */ - havePermission?: boolean; - /** - * Indicate whether the permission key is deprecated. Note that deprecated keys cannot be used in the `permissions - * parameter of Get my permissions. Deprecated keys are not returned by Get all permissions.` - */ - deprecatedKey?: boolean; -} diff --git a/src/version3/models/userWrite.ts b/src/version3/models/userWrite.ts deleted file mode 100644 index e59b2cc0e1..0000000000 --- a/src/version3/models/userWrite.ts +++ /dev/null @@ -1,37 +0,0 @@ -/** @deprecated Use UserWrite instead. */ -export type UserWriteBean = UserWrite; - -/** @deprecated Use `NewUserDetails` instead. */ -export interface UserWrite { - /** The URL of the user. */ - self?: string; - /** - * @deprecated This parameter is no longer available. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - key?: string; - /** - * @deprecated This parameter is no longer available. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - name?: string; - /** - * @deprecated This parameter is no longer available. If the user has an Atlassian account, their password is not - * changed. If the user does not have an Atlassian account, they are sent an email asking them set up an account. - */ - password?: string; - /** The email address for the user. */ - emailAddress: string; - /** - * A suggested display name for the user. If the user has an Atlassian account, their display name is not changed. If - * the user does not have an Atlassian account, this display name is used as a suggestion for creating an account. The - * user is sent an email asking them to set their display name and privacy preferences. - */ - displayName: string; - /** Sends the user an email confirmation that they have been added to Jira. Default is `false`. */ - notification?: string; - /** Deprecated, do not use. */ - applicationKeys?: string[]; -} diff --git a/src/version3/models/valueOperand.ts b/src/version3/models/valueOperand.ts deleted file mode 100644 index 533f8a5838..0000000000 --- a/src/version3/models/valueOperand.ts +++ /dev/null @@ -1,5 +0,0 @@ -/** An operand that is a user-provided value. */ -export interface ValueOperand { - /** The operand value. */ - value: string; -} diff --git a/src/version3/models/version.ts b/src/version3/models/version.ts index 8460030f8f..fd618aefd7 100644 --- a/src/version3/models/version.ts +++ b/src/version3/models/version.ts @@ -54,8 +54,6 @@ export interface Version { * date format. */ userReleaseDate?: string; - /** Deprecated. Use `projectId`. */ - project?: string; /** * The ID of the project to which this version is attached. Required when creating a version. Not applicable when * updating a version. diff --git a/src/version3/models/versionMove.ts b/src/version3/models/versionMove.ts index ccc05a39d1..413ca61218 100644 --- a/src/version3/models/versionMove.ts +++ b/src/version3/models/versionMove.ts @@ -1,6 +1,3 @@ -/** @deprecated Use VersionMove instead. */ -export type VersionMoveBean = VersionMove; - export interface VersionMove { /** The URL (self link) of the version after which to place the moved version. Cannot be used with `position`. */ after?: string; diff --git a/src/version3/models/workflowCompoundCondition.ts b/src/version3/models/workflowCompoundCondition.ts deleted file mode 100644 index 9e789d57fa..0000000000 --- a/src/version3/models/workflowCompoundCondition.ts +++ /dev/null @@ -1,10 +0,0 @@ -import { WorkflowCondition } from './workflowCondition'; - -/** A compound workflow transition rule condition. This object returns `nodeType` as `compound`. */ -export interface WorkflowCompoundCondition { - /** The compound condition operator. */ - operator: string; - /** The list of workflow conditions. */ - conditions: WorkflowCondition[]; - nodeType: string; -} diff --git a/src/version3/models/workflowRules.ts b/src/version3/models/workflowRules.ts index 6556c77ed7..8aab255146 100644 --- a/src/version3/models/workflowRules.ts +++ b/src/version3/models/workflowRules.ts @@ -3,11 +3,6 @@ import { WorkflowTransitionRule } from './workflowTransitionRule'; /** A collection of transition rules. */ export interface WorkflowRules { - /** - * @deprecated The workflow conditions. - * ([Deprecated](https://community.developer.atlassian.com/t/deprecation-of-conditions-body-param/48884)) - */ - conditions?: WorkflowTransitionRule[]; conditionsTree?: WorkflowCondition; /** The workflow validators. */ validators?: WorkflowTransitionRule[]; diff --git a/src/version3/models/workflowSimpleCondition.ts b/src/version3/models/workflowSimpleCondition.ts deleted file mode 100644 index 7a0910b057..0000000000 --- a/src/version3/models/workflowSimpleCondition.ts +++ /dev/null @@ -1,8 +0,0 @@ -/** A workflow transition rule condition. This object returns `nodeType` as `simple`. */ -export interface WorkflowSimpleCondition { - /** The type of the transition rule. */ - type: string; - /** EXPERIMENTAL. The configuration of the transition rule. */ - configuration?: {}; - nodeType: string; -} diff --git a/src/version3/models/worklogIdsRequest.ts b/src/version3/models/worklogIdsRequest.ts index a5ef51f5b6..aa20d7e6ad 100644 --- a/src/version3/models/worklogIdsRequest.ts +++ b/src/version3/models/worklogIdsRequest.ts @@ -1,6 +1,3 @@ -/** @deprecated Use WorklogIdsRequest instead. */ -export type WorklogIdsRequestBean = WorklogIdsRequest; - export interface WorklogIdsRequest { /** A list of worklog IDs. */ ids: number[]; diff --git a/src/version3/myself.ts b/src/version3/myself.ts index a372b9072e..c7b333331f 100644 --- a/src/version3/myself.ts +++ b/src/version3/myself.ts @@ -196,59 +196,6 @@ export class Myself { return this.client.sendRequest(config, callback); } - /** - * @deprecated Deprecated, use [ Update a user - * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) - * from the user management REST API instead. Sets the locale of the user. The locale must be one supported by the - * instance of Jira. **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) - * required:** Permission to access Jira. - */ - async setLocale(parameters: Parameters.SetLocale | undefined, callback: Callback): Promise; - /** - * @deprecated Deprecated, use [ Update a user - * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) - * from the user management REST API instead. Sets the locale of the user. The locale must be one supported by the - * instance of Jira. **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) - * required:** Permission to access Jira. - */ - async setLocale(parameters?: Parameters.SetLocale, callback?: never): Promise; - async setLocale(parameters?: Parameters.SetLocale, callback?: Callback): Promise { - const config: RequestConfig = { - url: '/rest/api/3/mypreferences/locale', - method: 'PUT', - data: { - locale: parameters?.locale, - }, - }; - - return this.client.sendRequest(config, callback); - } - - /** - * @deprecated Deprecated, use [ Update a user - * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) - * from the user management REST API instead. Deletes the locale of the user, which restores the default setting. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * Permission to access Jira. - */ - async deleteLocale(callback: Callback): Promise; - /** - * @deprecated Deprecated, use [ Update a user - * profile](https://developer.atlassian.com/cloud/admin/user-management/rest/#api-users-account-id-manage-profile-patch) - * from the user management REST API instead. Deletes the locale of the user, which restores the default setting. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * Permission to access Jira. - */ - async deleteLocale(callback?: never): Promise; - async deleteLocale(callback?: Callback): Promise { - const config: RequestConfig = { - url: '/rest/api/3/mypreferences/locale', - method: 'DELETE', - }; - - return this.client.sendRequest(config, callback); - } - /** * Returns details for the current user. * diff --git a/src/version3/parameters/addActorUsers.ts b/src/version3/parameters/addActorUsers.ts index 162dc9ec32..7126621c61 100644 --- a/src/version3/parameters/addActorUsers.ts +++ b/src/version3/parameters/addActorUsers.ts @@ -1,7 +1,7 @@ import { ActorsMap } from '../models'; export interface AddActorUsers extends ActorsMap { - /** The project ID or project key (case-sensitive). */ + /** The project ID or project key (case sensitive). */ projectIdOrKey: string; /** * The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role diff --git a/src/version3/parameters/addAttachment.ts b/src/version3/parameters/addAttachment.ts index 932ca54a3a..76f7c09f1a 100644 --- a/src/version3/parameters/addAttachment.ts +++ b/src/version3/parameters/addAttachment.ts @@ -1,13 +1,11 @@ +interface Attachment { + filename: string; + file: Buffer | ReadableStream | string | Blob | File; +} + export interface AddAttachment { /** The ID or key of the issue that attachments are added to. */ issueIdOrKey: string; - attachment: AddAttachment.Attachment | AddAttachment.Attachment[]; -} - -export namespace AddAttachment { - export interface Attachment { - filename: string; - file: Buffer | ReadableStream | string | Blob | File; - } + attachment: Attachment | Attachment[]; } diff --git a/src/version3/parameters/addComment.ts b/src/version3/parameters/addComment.ts index cda4b7d549..2aadf316e7 100644 --- a/src/version3/parameters/addComment.ts +++ b/src/version3/parameters/addComment.ts @@ -13,5 +13,5 @@ export interface AddComment extends Omit { * The comment text in [Atlassian Document * Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). */ - body?: string | Document; + comment?: string | Document; } diff --git a/src/version3/parameters/addNotifications.ts b/src/version3/parameters/addNotifications.ts deleted file mode 100644 index 2678cd06c1..0000000000 --- a/src/version3/parameters/addNotifications.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { AddNotificationsDetails } from '../models'; - -export interface AddNotifications extends AddNotificationsDetails { - /** The ID of the notification scheme. */ - id: string; -} diff --git a/src/version3/parameters/addWorklog.ts b/src/version3/parameters/addWorklog.ts index df50aefb5a..c3970695c1 100644 --- a/src/version3/parameters/addWorklog.ts +++ b/src/version3/parameters/addWorklog.ts @@ -8,11 +8,12 @@ export interface AddWorklog extends Omit { /** * Defines how to update the issue's time estimate, the options are: * - * `new` Sets the estimate to a specific value, defined in `newEstimate`. `leave` Leaves the estimate unchanged. - * `manual` Reduces the estimate by amount specified in `reduceBy`. `auto` Reduces the estimate by the value of - * `timeSpent` in the worklog. + * - `new` Sets the estimate to a specific value, defined in `newEstimate`. + * - `leave` Leaves the estimate unchanged. + * - `manual` Reduces the estimate by amount specified in `reduceBy`. + * - `auto` Reduces the estimate by the value of `timeSpent` in the worklog. */ - adjustEstimate?: string; + adjustEstimate?: 'new' | 'leave' | 'manual' | 'auto' | string; /** * A comment about the worklog in [Atlassian Document * Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or @@ -34,11 +35,11 @@ export interface AddWorklog extends Omit { * information about work logs in the response. This parameter accepts `properties`, which returns worklog * properties. */ - expand?: string | string[]; + expand?: 'properties' | 'properties'[] | string | string[]; /** * Whether the worklog entry should be added to the issue even if the issue is not editable, because - * jira.issue.editable set to false or missing. For example, the issue is closed. Connect app users with admin - * permission and Forge app users with the `manage:jira-configuration` scope can use this flag. + * jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with + * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag. */ overrideEditableFlag?: boolean; } diff --git a/src/version3/parameters/analyseExpression.ts b/src/version3/parameters/analyseExpression.ts index cf67bc87ae..46d7696d48 100644 --- a/src/version3/parameters/analyseExpression.ts +++ b/src/version3/parameters/analyseExpression.ts @@ -4,13 +4,14 @@ export interface AnalyseExpression extends JiraExpressionForAnalysis { /** * The check to perform: * - * `syntax` Each expression's syntax is checked to ensure the expression can be parsed. Also, syntactic limits are - * validated. For example, the expression's length. `type` EXPERIMENTAL. Each expression is type checked and the final - * type of the expression inferred. Any type errors that would result in the expression failure at runtime are - * reported. For example, accessing properties that don't exist or passing the wrong number of arguments to functions. - * Also performs the syntax check. `complexity` EXPERIMENTAL. Determines the formulae for how many [expensive - * operations](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#expensive-operations) each - * expression may execute. + * - `syntax` Each expression's syntax is checked to ensure the expression can be parsed. Also, syntactic limits are + * validated. For example, the expression's length. + * - `type` EXPERIMENTAL. Each expression is type checked and the final type of the expression inferred. Any type errors + * that would result in the expression failure at runtime are reported. For example, accessing properties that don't + * exist or passing the wrong number of arguments to functions. Also performs the syntax check. + * - `complexity` EXPERIMENTAL. Determines the formulae for how many [expensive + * operations](https://developer.atlassian.com/cloud/jira/platform/jira-expressions/#expensive-operations) each + * expression may execute. */ - check?: string; + check?: 'syntax' | 'type' | 'complexity' | string; } diff --git a/src/version3/parameters/assignPermissionScheme.ts b/src/version3/parameters/assignPermissionScheme.ts index ffd1c40ef7..909be5c162 100644 --- a/src/version3/parameters/assignPermissionScheme.ts +++ b/src/version3/parameters/assignPermissionScheme.ts @@ -8,10 +8,21 @@ export interface AssignPermissionScheme extends Id { * information in the response. This parameter accepts a comma-separated list. Note that permissions are included when * you specify any value. Expand options include: * - * `all` Returns all expandable information. `field` Returns information about the custom field granted the - * permission. `group` Returns information about the group that is granted the permission. `permissions` Returns all - * permission grants for each permission scheme. `projectRole` Returns information about the project role granted the - * permission. `user` Returns information about the user who is granted the permission. + * - `all` Returns all expandable information. + * - `field` Returns information about the custom field granted the permission. + * - `group` Returns information about the group that is granted the permission. + * - `permissions` Returns all permission grants for each permission scheme. + * - `projectRole` Returns information about the project role granted the permission. + * - `user` Returns information about the user who is granted the permission. */ - expand?: string; + expand?: + | 'all' + | 'field' + | 'group' + | 'permissions' + | 'projectRole' + | 'user' + | ('all' | 'field' | 'group' | 'permissions' | 'projectRole' | 'user')[] + | string + | string[]; } diff --git a/src/version3/parameters/associateSchemeWithProject.ts b/src/version3/parameters/associateSchemeWithProject.ts deleted file mode 100644 index 0fd52170c1..0000000000 --- a/src/version3/parameters/associateSchemeWithProject.ts +++ /dev/null @@ -1,3 +0,0 @@ -import { WorkflowSchemeProjectAssociation } from '../models'; - -export interface AssociateSchemeWithProject extends WorkflowSchemeProjectAssociation {} diff --git a/src/version3/parameters/bulkGetUsers.ts b/src/version3/parameters/bulkGetUsers.ts index 67607c637a..ed71bb1261 100644 --- a/src/version3/parameters/bulkGetUsers.ts +++ b/src/version3/parameters/bulkGetUsers.ts @@ -3,20 +3,6 @@ export interface BulkGetUsers { startAt?: number; /** The maximum number of items to return per page. */ maxResults?: number; - /** - * @deprecated This parameter is no longer available and will be removed from the documentation soon. See the - * [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - username?: string[]; - /** - * @deprecated This parameter is no longer available and will be removed from the documentation soon. See the - * [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - key?: string[]; /** * The account ID of a user. To specify multiple users, pass multiple `accountId` parameters. For example, * `accountId=5b10a2844c20165700ede21g&accountId=5b10ac8d82e05b22cc7d4ef5`. diff --git a/src/version3/parameters/createCustomFieldOptions.ts b/src/version3/parameters/createCustomFieldOptions.ts deleted file mode 100644 index 9c1e859cf5..0000000000 --- a/src/version3/parameters/createCustomFieldOptions.ts +++ /dev/null @@ -1,9 +0,0 @@ -import { BulkCreateCustomFieldOptionRequest } from '../models'; - -export interface CreateCustomFieldOptions extends BulkCreateCustomFieldOptionRequest { - /** - * The ID of the custom field. Note: This is the numeric part of the of the field ID. For example, for a field with - * the ID _customfield_10075_ use _10075_. - */ - fieldId: number; -} diff --git a/src/version3/parameters/createIssue.ts b/src/version3/parameters/createIssue.ts index 2db92b2ad3..f48eb69403 100644 --- a/src/version3/parameters/createIssue.ts +++ b/src/version3/parameters/createIssue.ts @@ -1,16 +1,10 @@ import { Document, IssueUpdateDetails, Project, TimeTrackingDetails } from '../models'; -/** @deprecated Use {@link Document} instead. */ -export interface CreateIssueDescriptionContent { - type: string; - text?: string; - content?: Array; -} - export interface CreateIssue extends Omit { /** * Whether the project in which the issue is created is added to the user's **Recently viewed** project list, as shown - * under **Projects** in Jira. + * under **Projects** in Jira. When provided, the issue type and request type are added to the user's history for a + * project. These values are then used to provide defaults on the issue create screen. */ updateHistory?: boolean; diff --git a/src/version3/parameters/createIssueAdjustment.ts b/src/version3/parameters/createIssueAdjustment.ts deleted file mode 100644 index 8ce6025846..0000000000 --- a/src/version3/parameters/createIssueAdjustment.ts +++ /dev/null @@ -1,3 +0,0 @@ -import { CreateIssueAdjustmentDetails } from '../models'; - -export interface CreateIssueAdjustment extends CreateIssueAdjustmentDetails {} diff --git a/src/version3/parameters/createWorkflowTransitionProperty.ts b/src/version3/parameters/createWorkflowTransitionProperty.ts index 289d987cc2..8aeea6ad06 100644 --- a/src/version3/parameters/createWorkflowTransitionProperty.ts +++ b/src/version3/parameters/createWorkflowTransitionProperty.ts @@ -17,5 +17,5 @@ export interface CreateWorkflowTransitionProperty extends WorkflowTransitionProp * The workflow status. Set to _live_ for inactive workflows or _draft_ for draft workflows. Active workflows cannot * be edited. */ - workflowMode?: string; + workflowMode?: 'live' | 'draft' | string; } diff --git a/src/version3/parameters/deleteActor.ts b/src/version3/parameters/deleteActor.ts index e1af09cb3a..bf6b85f5e5 100644 --- a/src/version3/parameters/deleteActor.ts +++ b/src/version3/parameters/deleteActor.ts @@ -1,5 +1,5 @@ export interface DeleteActor { - /** The project ID or project key (case-sensitive). */ + /** The project ID or project key (case sensitive). */ projectIdOrKey: string; /** * The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role diff --git a/src/version3/parameters/deleteAvatar.ts b/src/version3/parameters/deleteAvatar.ts index 5736f3c460..bdbdffd6a8 100644 --- a/src/version3/parameters/deleteAvatar.ts +++ b/src/version3/parameters/deleteAvatar.ts @@ -1,6 +1,6 @@ export interface DeleteAvatar { /** The avatar type. */ - type: string; + type: 'project' | 'issuetype' | string; /** The ID of the item the avatar is associated with. */ owningObjectId: string; /** The ID of the avatar. */ diff --git a/src/version3/parameters/deleteIssue.ts b/src/version3/parameters/deleteIssue.ts index 457aa97ca0..643ebff999 100644 --- a/src/version3/parameters/deleteIssue.ts +++ b/src/version3/parameters/deleteIssue.ts @@ -2,5 +2,5 @@ export interface DeleteIssue { /** The ID or key of the issue. */ issueIdOrKey: string; /** Whether the issue's subtasks are deleted when the issue is deleted. */ - deleteSubtasks?: string; + deleteSubtasks?: boolean; } diff --git a/src/version3/parameters/deleteIssueAdjustment.ts b/src/version3/parameters/deleteIssueAdjustment.ts deleted file mode 100644 index 9ed77ffcda..0000000000 --- a/src/version3/parameters/deleteIssueAdjustment.ts +++ /dev/null @@ -1,4 +0,0 @@ -export interface DeleteIssueAdjustment { - /** The ID of the issue adjustment. */ - issueAdjustmentId: string; -} diff --git a/src/version3/parameters/deletePriority.ts b/src/version3/parameters/deletePriority.ts deleted file mode 100644 index 8fe14bdb47..0000000000 --- a/src/version3/parameters/deletePriority.ts +++ /dev/null @@ -1,8 +0,0 @@ -export interface DeletePriority { - /** The ID of the issue priority. */ - id: string; - /** The ID of the issue priority for replacement. */ - newPriority?: string; - /** The ID of the issue priority that will replace the currently selected resolution. */ - replaceWith: string; -} diff --git a/src/version3/parameters/deleteStatusesById.ts b/src/version3/parameters/deleteStatusesById.ts index 687cfb45ad..7e46e04d3d 100644 --- a/src/version3/parameters/deleteStatusesById.ts +++ b/src/version3/parameters/deleteStatusesById.ts @@ -3,7 +3,7 @@ export interface DeleteStatusesById { * The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, * id=10000&id=10001. * - * Min items `1`, Max items `50` + * Min items `1`, Max items `50` */ id?: string[]; } diff --git a/src/version3/parameters/deleteVersion.ts b/src/version3/parameters/deleteVersion.ts deleted file mode 100644 index 823015b79b..0000000000 --- a/src/version3/parameters/deleteVersion.ts +++ /dev/null @@ -1,14 +0,0 @@ -export interface DeleteVersion { - /** The ID of the version. */ - id: string; - /** - * The ID of the version to update `fixVersion` to when the field contains the deleted version. The replacement - * version must be in the same project as the version being deleted and cannot be the version being deleted. - */ - moveFixIssuesTo?: string; - /** - * The ID of the version to update `affectedVersion` to when the field contains the deleted version. The replacement - * version must be in the same project as the version being deleted and cannot be the version being deleted. - */ - moveAffectedIssuesTo?: string; -} diff --git a/src/version3/parameters/deleteWorkflowTransitionProperty.ts b/src/version3/parameters/deleteWorkflowTransitionProperty.ts index 95fbac1dac..c54f5a4082 100644 --- a/src/version3/parameters/deleteWorkflowTransitionProperty.ts +++ b/src/version3/parameters/deleteWorkflowTransitionProperty.ts @@ -12,5 +12,5 @@ export interface DeleteWorkflowTransitionProperty { * The workflow status. Set to `live` for inactive workflows or `draft` for draft workflows. Active workflows cannot * be edited. */ - workflowMode?: string; + workflowMode?: 'live' | 'draft' | string; } diff --git a/src/version3/parameters/deleteWorklog.ts b/src/version3/parameters/deleteWorklog.ts index 6d223a3d0c..cfdfb5186e 100644 --- a/src/version3/parameters/deleteWorklog.ts +++ b/src/version3/parameters/deleteWorklog.ts @@ -8,11 +8,12 @@ export interface DeleteWorklog { /** * Defines how to update the issue's time estimate, the options are: * - * `new` Sets the estimate to a specific value, defined in `newEstimate`. `leave` Leaves the estimate unchanged. - * `manual` Increases the estimate by amount specified in `increaseBy`. `auto` Reduces the estimate by the value of - * `timeSpent` in the worklog. + * - `new` Sets the estimate to a specific value, defined in `newEstimate`. + * - `leave` Leaves the estimate unchanged. + * - `manual` Increases the estimate by amount specified in `increaseBy`. + * - `auto` Reduces the estimate by the value of `timeSpent` in the worklog. */ - adjustEstimate?: string; + adjustEstimate?: 'new' | 'leave' | 'manual' | 'auto' | string; /** * The value to set as the issue's remaining time estimate, as days (#d), hours (#h), or minutes (#m or #). For * example, _2d_. Required when `adjustEstimate` is `new`. @@ -25,8 +26,8 @@ export interface DeleteWorklog { increaseBy?: string; /** * Whether the work log entry should be added to the issue even if the issue is not editable, because - * jira.issue.editable set to false or missing. For example, the issue is closed. Connect app users with admin - * permission and Forge app users with the `manage:jira-configuration` scope can use this flag. + * jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with + * admin permission can use this flag. */ overrideEditableFlag?: boolean; } diff --git a/src/version3/parameters/findGroups.ts b/src/version3/parameters/findGroups.ts index 7715074930..1df24ebf81 100644 --- a/src/version3/parameters/findGroups.ts +++ b/src/version3/parameters/findGroups.ts @@ -1,9 +1,4 @@ export interface FindGroups { - /** - * @deprecated This parameter is deprecated, setting it does not affect the results. To find groups containing a - * particular user, use [Get user groups](#api-rest-api-3-user-groups-get). - */ - accountId?: string; /** Whether the search for groups should be case-insensitive. */ caseInsensitive?: boolean; /** @@ -25,10 +20,4 @@ export interface FindGroups { maxResults?: number; /** The string to find in group names. */ query?: string; - /** - * @deprecated This parameter is no longer available. See the [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - userName?: string; } diff --git a/src/version3/parameters/findUsers.ts b/src/version3/parameters/findUsers.ts index 16293887c9..e2a8a40ac2 100644 --- a/src/version3/parameters/findUsers.ts +++ b/src/version3/parameters/findUsers.ts @@ -12,7 +12,7 @@ export interface FindUsers { * specified. */ accountId?: string; - /** The index of the first item to return in a page of results (page offset). */ + /** The index of the first item to return in a page of filtered results (page offset). */ startAt?: number; /** The maximum number of items to return per page. */ maxResults?: number; diff --git a/src/version3/parameters/findUsersAndGroups.ts b/src/version3/parameters/findUsersAndGroups.ts index 268e9ac3e5..5ec5bc4b01 100644 --- a/src/version3/parameters/findUsersAndGroups.ts +++ b/src/version3/parameters/findUsersAndGroups.ts @@ -21,7 +21,29 @@ export interface FindUsersAndGroups { */ issueTypeId?: string[]; /** The size of the avatar to return. If an invalid value is provided, the default value is used. */ - avatarSize?: string; + avatarSize?: + | 'xsmall' + | 'xsmall@2x' + | 'xsmall@3x' + | 'small' + | 'small@2x' + | 'small@3x' + | 'medium' + | 'medium@2x' + | 'medium@3x' + | 'large' + | 'large@2x' + | 'large@3x' + | 'xlarge' + | 'xlarge@2x' + | 'xlarge@3x' + | 'xxlarge' + | 'xxlarge@2x' + | 'xxlarge@3x' + | 'xxxlarge' + | 'xxxlarge@2x' + | 'xxxlarge@3x' + | string; /** Whether the search for groups should be case insensitive. */ caseInsensitive?: boolean; /** diff --git a/src/version3/parameters/findUsersForPicker.ts b/src/version3/parameters/findUsersForPicker.ts index f5f6e18849..b5eb7749a2 100644 --- a/src/version3/parameters/findUsersForPicker.ts +++ b/src/version3/parameters/findUsersForPicker.ts @@ -9,12 +9,6 @@ export interface FindUsersForPicker { maxResults?: number; /** Include the URI to the user's avatar. */ showAvatar?: boolean; - /** - * @deprecated This parameter is no longer available. See the [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - exclude?: string[]; /** * A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple * account IDs can also be provided using an ampersand-separated list. For example, diff --git a/src/version3/parameters/getAccessibleProjectTypeByKey.ts b/src/version3/parameters/getAccessibleProjectTypeByKey.ts index d52fbee198..b0b2a0c8bb 100644 --- a/src/version3/parameters/getAccessibleProjectTypeByKey.ts +++ b/src/version3/parameters/getAccessibleProjectTypeByKey.ts @@ -1,4 +1,4 @@ export interface GetAccessibleProjectTypeByKey { /** The key of the project type. */ - projectTypeKey: string; + projectTypeKey: 'software' | 'service_desk' | 'business' | 'product_discovery' | string; } diff --git a/src/version3/parameters/getAllDashboards.ts b/src/version3/parameters/getAllDashboards.ts index a611c612bc..00cdb506bc 100644 --- a/src/version3/parameters/getAllDashboards.ts +++ b/src/version3/parameters/getAllDashboards.ts @@ -2,9 +2,10 @@ export interface GetAllDashboards { /** * The filter applied to the list of dashboards. Valid values are: * - * `favourite` Returns dashboards the user has marked as favorite. `my` Returns dashboards owned by the user. + * - `favourite` Returns dashboards the user has marked as favorite. + * - `my` Returns dashboards owned by the user. */ - filter?: string; + filter?: 'my' | 'favourite' | string; /** 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. */ diff --git a/src/version3/parameters/getAllIssueTypeSchemes.ts b/src/version3/parameters/getAllIssueTypeSchemes.ts index 1a03759467..585c5175d0 100644 --- a/src/version3/parameters/getAllIssueTypeSchemes.ts +++ b/src/version3/parameters/getAllIssueTypeSchemes.ts @@ -11,17 +11,19 @@ export interface GetAllIssueTypeSchemes { /** * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#ordering) the results by a field: * - * `name` Sorts by issue type scheme name. `id` Sorts by issue type scheme ID. + * - `name` Sorts by issue type scheme name. + * - `id` Sorts by issue type scheme ID. */ - orderBy?: string; + orderBy?: 'name' | '-name' | '+name' | 'id' | '-id' | '+id' | string; /** * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional * information in the response. This parameter accepts a comma-separated list. Expand options include: * - * `projects` For each issue type schemes, returns information about the projects the issue type scheme is assigned - * to. `issueTypes` For each issue type schemes, returns information about the issueTypes the issue type scheme have. + * - `projects` For each issue type schemes, returns information about the projects the issue type scheme is assigned + * to. -`issueTypes` For each issue type schemes, returns information about the issueTypes the issue type scheme + * have. */ - expand?: string; + expand?: 'projects' | 'issueTypes' | ('projects' | 'issueTypes')[] | string | string[]; /** String used to perform a case-insensitive partial match with issue type scheme name. */ queryString?: string; } diff --git a/src/version3/parameters/getAllProjects.ts b/src/version3/parameters/getAllProjects.ts deleted file mode 100644 index d750535bfb..0000000000 --- a/src/version3/parameters/getAllProjects.ts +++ /dev/null @@ -1,18 +0,0 @@ -export interface GetAllProjects { - /** - * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional - * information in the response. This parameter accepts a comma-separated list. Expanded options include: - * - * `description` Returns the project description. `issueTypes` Returns all issue types associated with the project. - * `lead` Returns information about the project lead. `projectKeys` Returns all project keys associated with the - * project. - */ - expand?: string; - /** - * Returns the user's most recently accessed projects. You may specify the number of results to return up to a maximum - * of 20. If access is anonymous, then the recently accessed projects are based on the current HTTP session. - */ - recent?: number; - /** A list of project properties to return for the project. This parameter accepts a comma-separated list. */ - properties?: string[]; -} diff --git a/src/version3/parameters/getAllSystemAvatars.ts b/src/version3/parameters/getAllSystemAvatars.ts index 8283ea14a3..c1d371e2df 100644 --- a/src/version3/parameters/getAllSystemAvatars.ts +++ b/src/version3/parameters/getAllSystemAvatars.ts @@ -1,4 +1,4 @@ export interface GetAllSystemAvatars { /** The avatar type. */ - type: string; + type: 'issuetype' | 'project' | 'user' | string; } diff --git a/src/version3/parameters/getAllWorkflows.ts b/src/version3/parameters/getAllWorkflows.ts deleted file mode 100644 index 17dd630238..0000000000 --- a/src/version3/parameters/getAllWorkflows.ts +++ /dev/null @@ -1,4 +0,0 @@ -export interface GetAllWorkflows { - /** The name of the workflow to be returned. Only one workflow can be specified. */ - workflowName?: string; -} diff --git a/src/version3/parameters/getAvatarImageByID.ts b/src/version3/parameters/getAvatarImageByID.ts index f4dae48ca5..c8556f01dd 100644 --- a/src/version3/parameters/getAvatarImageByID.ts +++ b/src/version3/parameters/getAvatarImageByID.ts @@ -1,10 +1,10 @@ export interface GetAvatarImageByID { /** The icon type of the avatar. */ - type: string; + type: 'issuetype' | 'project' | string; /** The ID of the avatar. */ - id: number; + id: number | string; /** The size of the avatar image. If not provided the default size is returned. */ - size?: string; + size?: 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | string; /** The format to return the avatar image in. If not provided the original content format is returned. */ - format?: string; + format?: 'png' | 'svg' | string; } diff --git a/src/version3/parameters/getAvatarImageByOwner.ts b/src/version3/parameters/getAvatarImageByOwner.ts index 7398885f04..0726f004d3 100644 --- a/src/version3/parameters/getAvatarImageByOwner.ts +++ b/src/version3/parameters/getAvatarImageByOwner.ts @@ -1,10 +1,10 @@ export interface GetAvatarImageByOwner { /** The icon type of the avatar. */ - type: string; + type: 'issuetype' | 'project' | string; /** The ID of the project or issue type the avatar belongs to. */ entityId: string; /** The size of the avatar image. If not provided the default size is returned. */ - size?: string; + size?: 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | string; /** The format to return the avatar image in. If not provided the original content format is returned. */ - format?: string; + format?: 'png' | 'svg' | string; } diff --git a/src/version3/parameters/getAvatarImageByType.ts b/src/version3/parameters/getAvatarImageByType.ts index 1f04771f9c..de3317275d 100644 --- a/src/version3/parameters/getAvatarImageByType.ts +++ b/src/version3/parameters/getAvatarImageByType.ts @@ -1,8 +1,8 @@ export interface GetAvatarImageByType { /** The icon type of the avatar. */ - type: string; + type: 'issuetype' | 'project' | string; /** The size of the avatar image. If not provided the default size is returned. */ - size?: string; + size?: 'xsmall' | 'small' | 'medium' | 'large' | 'xlarge' | string; /** The format to return the avatar image in. If not provided the original content format is returned. */ - format?: string; + format?: 'png' | 'svg' | string; } diff --git a/src/version3/parameters/getAvatars.ts b/src/version3/parameters/getAvatars.ts index b20b97669a..94f9acecf2 100644 --- a/src/version3/parameters/getAvatars.ts +++ b/src/version3/parameters/getAvatars.ts @@ -1,6 +1,6 @@ export interface GetAvatars { /** The avatar type. */ - type: string; + type: 'project' | 'issuetype' | string; /** The ID of the item the avatar is associated with. */ entityId: string; } diff --git a/src/version3/parameters/getComments.ts b/src/version3/parameters/getComments.ts index 9f2b798236..635ae68550 100644 --- a/src/version3/parameters/getComments.ts +++ b/src/version3/parameters/getComments.ts @@ -9,7 +9,7 @@ export interface GetComments { * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#ordering) the results by a field. * Accepts _created_ to sort comments by their created date. */ - orderBy?: string; + orderBy?: 'created' | '-created' | '+created' | string; /** * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional * information about comments in the response. This parameter accepts `renderedBody`, which returns the comment body diff --git a/src/version3/parameters/getCommentsByIds.ts b/src/version3/parameters/getCommentsByIds.ts index 9659ac1704..eb60bc65b0 100644 --- a/src/version3/parameters/getCommentsByIds.ts +++ b/src/version3/parameters/getCommentsByIds.ts @@ -5,7 +5,8 @@ export interface GetCommentsByIds extends IssueCommentListRequest { * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional * information about comments in the response. This parameter accepts a comma-separated list. Expand options include: * - * `renderedBody` Returns the comment body rendered in HTML. `properties` Returns the comment's properties. + * - `renderedBody` Returns the comment body rendered in HTML. + * - `properties` Returns the comment's properties. */ - expand?: string; + expand?: 'renderedBody' | 'properties' | string | string[]; } diff --git a/src/version3/parameters/getContextsForFieldDeprecated.ts b/src/version3/parameters/getContextsForFieldDeprecated.ts deleted file mode 100644 index dd7bb2e45c..0000000000 --- a/src/version3/parameters/getContextsForFieldDeprecated.ts +++ /dev/null @@ -1,8 +0,0 @@ -export interface GetContextsForFieldDeprecated { - /** The ID of the field to return contexts for. */ - fieldId: string; - /** 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; -} diff --git a/src/version3/parameters/getCurrentUser.ts b/src/version3/parameters/getCurrentUser.ts index cd8fff5309..59e8ea582e 100644 --- a/src/version3/parameters/getCurrentUser.ts +++ b/src/version3/parameters/getCurrentUser.ts @@ -6,21 +6,5 @@ export interface GetCurrentUser { * - `groups` Returns all groups, including nested groups, the user belongs to. * - `applicationRoles` Returns the application roles the user is assigned to. */ - expand?: - | 'groups' - | 'applicationRoles' - | ('groups' | 'applicationRoles')[] - | string - | string[] - | GetCurrentUser.Expand - | GetCurrentUser.Expand[]; -} - -export namespace GetCurrentUser { - export enum Expand { - /** Returns all groups, including nested groups, the user belongs to. */ - Groups = 'groups', - /** Returns the application roles the user is assigned to. */ - ApplicationRoles = 'applicationRoles', - } + expand?: 'groups' | 'applicationRoles' | ('groups' | 'applicationRoles')[] | string | string[]; } diff --git a/src/version3/parameters/getCustomFieldConfiguration.ts b/src/version3/parameters/getCustomFieldConfiguration.ts index d78b7e9fa7..b6d4fdd269 100644 --- a/src/version3/parameters/getCustomFieldConfiguration.ts +++ b/src/version3/parameters/getCustomFieldConfiguration.ts @@ -6,8 +6,6 @@ export interface GetCustomFieldConfiguration { * `id=10000&id=10001`. Can't be provided with `fieldContextId`, `issueId`, `projectKeyOrId`, or `issueTypeId`. */ id?: number[]; - /** @deprecated DEPRECATED. Do not use. */ - contextId?: number[]; /** * The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: * `fieldContextId=10000&fieldContextId=10001`. Can't be provided with `id`, `issueId`, `projectKeyOrId`, or @@ -16,17 +14,17 @@ export interface GetCustomFieldConfiguration { fieldContextId?: number[]; /** * The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided - * with `contextIds`, `projectKeyOrId`, or `issueTypeId`. + * with `projectKeyOrId`, or `issueTypeId`. */ issueId?: number; /** * The ID or key of the project to filter results by. Must be provided with `issueTypeId`. Can't be provided with - * `contextIds` or `issueId`. + * `issueId`. */ projectKeyOrId?: string; /** * The ID of the issue type to filter results by. Must be provided with `projectKeyOrId`. Can't be provided with - * `contextIds` or `issueId`. + * `issueId`. */ issueTypeId?: string; /** The index of the first item to return in a page of results (page offset). */ diff --git a/src/version3/parameters/getDashboardsPaginated.ts b/src/version3/parameters/getDashboardsPaginated.ts index e9b76e65a8..c664a40079 100644 --- a/src/version3/parameters/getDashboardsPaginated.ts +++ b/src/version3/parameters/getDashboardsPaginated.ts @@ -6,13 +6,6 @@ export interface GetDashboardsPaginated { * the `owner` parameter. */ accountId?: string; - /** - * @deprecated This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. User name used to return dashboards with the matching `owner.name`. This parameter cannot be used - * with the `accountId` parameter. - */ - owner?: string; /** * As a group's name can change, use of `groupId` is recommended. Group name used to return dashboards that are shared * with a group that matches `sharePermissions.group.name`. This parameter cannot be used with the `groupId` @@ -39,30 +32,30 @@ export interface GetDashboardsPaginated { */ orderBy?: | 'description' - | 'favourite_count' - | 'id' - | 'is_favourite' - | 'name' - | 'owner' - | '+description' - | '+favourite_count' - | '+id' - | '+is_favourite' - | '+name' - | '+owner' | '-description' - | '-favourite_count' + | '+description' + | 'favorite_count' + | '-favorite_count' + | '+favorite_count' + | 'id' | '-id' - | '-is_favourite' + | '+id' + | 'is_favorite' + | '-is_favorite' + | '+is_favorite' + | 'name' | '-name' + | '+name' + | 'owner' | '-owner' + | '+owner' | string; /** 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; /** The status to filter by. It may be active, archived or deleted. */ - status?: string; + status?: 'active' | 'archived' | 'deleted' | string; /** * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional * information about dashboard in the response. This parameter accepts a comma-separated list. Expand options diff --git a/src/version3/parameters/getFieldsPaginated.ts b/src/version3/parameters/getFieldsPaginated.ts index 7979cf1bf7..47272cebaa 100644 --- a/src/version3/parameters/getFieldsPaginated.ts +++ b/src/version3/parameters/getFieldsPaginated.ts @@ -4,7 +4,7 @@ export interface GetFieldsPaginated { /** The maximum number of items to return per page. */ maxResults?: number; /** The type of fields to search. */ - type?: string[]; + type?: ('custom' | 'system' | string)[]; /** The IDs of the custom fields to return or, where `query` is specified, filter. */ id?: string[]; /** String used to perform a case-insensitive partial match with field names or descriptions. */ @@ -12,19 +12,46 @@ export interface GetFieldsPaginated { /** * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#ordering) the results by a field: * - * `contextsCount` Sorts by the number of contexts related to a field. `lastUsed` Sorts by the date when the value of - * the field last changed. `name` Sorts by the field name. `screensCount` Sorts by the number of screens related to a - * field. + * - `contextsCount` sorts by the number of contexts related to a field + * - `lastUsed` sorts by the date when the value of the field last changed + * - `name` sorts by the field name + * - `screensCount` sorts by the number of screens related to a field */ - orderBy?: string; + orderBy?: + | 'contextsCount' + | '-contextsCount' + | '+contextsCount' + | 'lastUsed' + | '-lastUsed' + | '+lastUsed' + | 'name' + | '-name' + | '+name' + | 'screensCount' + | '-screensCount' + | '+screensCount' + | 'projectsCount' + | '-projectsCount' + | '+projectsCount' + | string; /** * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional * information in the response. This parameter accepts a comma-separated list. Expand options include: * - * `key` Returns the key for each field. `lastUsed` Returns the date when the value of the field last changed. - * `screensCount` Returns the number of screens related to a field. `contextsCount` Returns the number of contexts - * related to a field. `isLocked` Returns information about whether the field is - * [locked](https://confluence.atlassian.com/x/ZSN7Og). `searcherKey` Returns the searcher key for each custom field. + * - `key` returns the key for each field + * - `lastUsed` returns the date when the value of the field last changed + * - `screensCount` returns the number of screens related to a field `contextsCount` returns the number of contexts + * related to a field + * - `isLocked` returns information about whether the field is [locked](https://confluence.atlassian.com/x/ZSN7Og) + * - `searcherKey` returns the searcher key for each custom field */ - expand?: string; + expand?: + | 'key' + | 'lastUsed' + | 'screensCount' + | 'isLocked' + | 'searcherKey' + | ('key' | 'lastUsed' | 'screensCount' | 'isLocked' | 'searcherKey')[] + | string + | string[]; } diff --git a/src/version3/parameters/getFilters.ts b/src/version3/parameters/getFilters.ts deleted file mode 100644 index 47b366891f..0000000000 --- a/src/version3/parameters/getFilters.ts +++ /dev/null @@ -1,16 +0,0 @@ -export interface GetFilters { - /** - * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional - * information about filter in the response. This parameter accepts a comma-separated list. Expand options include: - * - * `sharedUsers` Returns the users that the filter is shared with. This includes users that can browse projects that - * the filter is shared with. If you don't specify `sharedUsers`, then the `sharedUsers` object is returned but it - * doesn't list any users. The list of users returned is limited to 1000, to access additional users append - * `[start-index:end-index]` to the expand request. For example, to access the next 1000 users, use - * `?expand=sharedUsers[1001:2000]`. `subscriptions` Returns the users that are subscribed to the filter. If you don't - * specify `subscriptions`, the `subscriptions` object is returned but it doesn't list any subscriptions. The list of - * subscriptions returned is limited to 1000, to access additional subscriptions append `[start-index:end-index]` to - * the expand request. For example, to access the next 1000 subscriptions, use `?expand=subscriptions[1001:2000]`. - */ - expand?: string; -} diff --git a/src/version3/parameters/getFiltersPaginated.ts b/src/version3/parameters/getFiltersPaginated.ts index 040a7844b1..1c7e2863f3 100644 --- a/src/version3/parameters/getFiltersPaginated.ts +++ b/src/version3/parameters/getFiltersPaginated.ts @@ -6,13 +6,6 @@ export interface GetFiltersPaginated { * `owner`. */ accountId?: string; - /** - * This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration - * guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. User name used to return filters with the matching `owner.name`. This parameter cannot be used with - * `accountId`. - */ - owner?: string; /** * As a group's name can change, use of `groupId` is recommended to identify a group. Group name used to returns * filters that are shared with a group that matches `sharePermissions.group.groupname`. This parameter cannot be used @@ -28,19 +21,44 @@ export interface GetFiltersPaginated { projectId?: number; /** * The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example, - * `id=10000&id=10001`. + * `id=10000&id=10001`. Do not exceed 200 filter IDs. */ id?: number[]; /** * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#ordering) the results by a field: * - * `description` Sorts by filter description. Note that this sorting works independently of whether the expand to - * display the description field is in use. `favourite_count` Sorts by the count of how many users have this filter as - * a favorite. `is_favourite` Sorts by whether the filter is marked as a favorite. `id` Sorts by filter ID. `name` - * Sorts by filter name. `owner` Sorts by the ID of the filter owner. `is_shared` Sorts by whether the filter is - * shared. + * - `description` Sorts by filter description. Note that this sorting works independently of whether the expand to + * display the description field is in use. + * - `favourite_count` Sorts by the count of how many users have this filter as a favorite. + * - `is_favourite` Sorts by whether the filter is marked as a favorite. + * - `id` Sorts by filter ID. + * - `name` Sorts by filter name. + * - `owner` Sorts by the ID of the filter owner. + * - `is_shared` Sorts by whether the filter is shared. */ - orderBy?: string; + orderBy?: + | 'description' + | '-description' + | '+description' + | 'favourite_count' + | '-favourite_count' + | '+favourite_count' + | 'id' + | '-id' + | '+id' + | 'is_favourite' + | '-is_favourite' + | '+is_favourite' + | 'name' + | '-name' + | '+name' + | 'owner' + | '-owner' + | '+owner' + | 'is_shared' + | '-is_shared' + | '+is_shared' + | string; /** 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. */ @@ -49,15 +67,45 @@ export interface GetFiltersPaginated { * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional * information about filter in the response. This parameter accepts a comma-separated list. Expand options include: * - * `description` Returns the description of the filter. `favourite` Returns an indicator of whether the user has set - * the filter as a favorite. `favouritedCount` Returns a count of how many users have set this filter as a favorite. - * `jql` Returns the JQL query that the filter uses. `owner` Returns the owner of the filter. `searchUrl` Returns a - * URL to perform the filter's JQL query. `sharePermissions` Returns the share permissions defined for the filter. - * `editPermissions` Returns the edit permissions defined for the filter. `isWritable` Returns whether the current - * user has permission to edit the filter. `subscriptions` Returns the users that are subscribed to the filter. - * `viewUrl` Returns a URL to view the filter. + * - `description` Returns the description of the filter. + * - `favourite` Returns an indicator of whether the user has set the filter as a favorite. + * - `favouritedCount` Returns a count of how many users have set this filter as a favorite. + * - `jql` Returns the JQL query that the filter uses. + * - `owner` Returns the owner of the filter. + * - `searchUrl` Returns a URL to perform the filter's JQL query. + * - `sharePermissions` Returns the share permissions defined for the filter. + * - `editPermissions` Returns the edit permissions defined for the filter. + * - `isWritable` Returns whether the current user has permission to edit the filter. + * - `subscriptions` Returns the users that are subscribed to the filter. + * - `viewUrl` Returns a URL to view the filter. */ - expand?: string; + expand?: + | 'description' + | 'favourite' + | 'favouritedCount' + | 'jql' + | 'owner' + | 'searchUrl' + | 'sharePermissions' + | 'editPermissions' + | 'isWritable' + | 'subscriptions' + | 'viewUrl' + | ( + | 'description' + | 'favourite' + | 'favouritedCount' + | 'jql' + | 'owner' + | 'searchUrl' + | 'sharePermissions' + | 'editPermissions' + | 'isWritable' + | 'subscriptions' + | 'viewUrl' + )[] + | string + | string[]; /** * EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. * Available to users with _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). diff --git a/src/version3/parameters/getGroup.ts b/src/version3/parameters/getGroup.ts deleted file mode 100644 index e34e5efada..0000000000 --- a/src/version3/parameters/getGroup.ts +++ /dev/null @@ -1,11 +0,0 @@ -export interface GetGroup { - /** - * As a group's name can change, use of `groupId` is recommended to identify a group. The name of the group. This - * parameter cannot be used with the `groupId` parameter. - */ - groupname?: string; - /** The ID of the group. This parameter cannot be used with the `groupName` parameter. */ - groupId?: string; - /** List of fields to expand. */ - expand?: string; -} diff --git a/src/version3/parameters/getIssue.ts b/src/version3/parameters/getIssue.ts index 84221e813f..9962e650b8 100644 --- a/src/version3/parameters/getIssue.ts +++ b/src/version3/parameters/getIssue.ts @@ -49,9 +49,7 @@ export interface GetIssue { | 'versionedRepresentations' | ('renderedFields' | 'name' | 'schema' | 'transitions' | 'editmeta' | 'changelog' | 'versionedRepresentations')[] | string - | string[] - | GetIssue.Expand - | GetIssue.Expand[]; + | string[]; /** * A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values: * @@ -72,25 +70,3 @@ export interface GetIssue { */ updateHistory?: boolean; } - -export namespace GetIssue { - export enum Expand { - /** Returns field values rendered in HTML format. */ - RenderedFields = 'renderedFields', - /** Returns the display name of each field. */ - Names = 'names', - /** Returns the schema describing a field type. */ - Schema = 'schema', - /** Returns all possible transitions for the issue. */ - Transitions = 'transitions', - /** Returns information about how each field can be edited. */ - EditMeta = 'editmeta', - /** Returns a list of recent updates to an issue, sorted by date, starting from the most recent. */ - Changelog = 'changelog', - /** - * Returns a JSON array for each version of a field's value, with the highest number representing the most recent - * version. Note: When included in the request, the `fields` parameter is ignored. - */ - VersionedRepresentations = 'versionedRepresentations', - } -} diff --git a/src/version3/parameters/getIssueAdjustments.ts b/src/version3/parameters/getIssueAdjustments.ts deleted file mode 100644 index 6901f1b753..0000000000 --- a/src/version3/parameters/getIssueAdjustments.ts +++ /dev/null @@ -1,14 +0,0 @@ -export interface GetIssueAdjustments { - /** 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 to include additional information in the response. This parameter accepts a comma-separated list. Expand - * options include: - * - * - `data` Returns issue adjustment data. - * - `contexts` Returns issue adjustment contexts. - */ - expand?: 'data' | 'contexts' | ('data' | 'contexts')[] | string | string[]; -} diff --git a/src/version3/parameters/getIssueTypeScreenSchemes.ts b/src/version3/parameters/getIssueTypeScreenSchemes.ts index 9aa8736109..3884e2a924 100644 --- a/src/version3/parameters/getIssueTypeScreenSchemes.ts +++ b/src/version3/parameters/getIssueTypeScreenSchemes.ts @@ -13,9 +13,10 @@ export interface GetIssueTypeScreenSchemes { /** * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#ordering) the results by a field: * - * `name` Sorts by issue type screen scheme name. `id` Sorts by issue type screen scheme ID. + * - `name` Sorts by issue type screen scheme name. + * - `id` Sorts by issue type screen scheme ID. */ - orderBy?: string; + orderBy?: 'name' | '-name' | '+name' | 'id' | '-id' | '+id' | string; /** * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional * information in the response. This parameter accepts `projects` that, for each issue type screen schemes, returns diff --git a/src/version3/parameters/getNotificationScheme.ts b/src/version3/parameters/getNotificationScheme.ts index 6d745e7766..6b13d76597 100644 --- a/src/version3/parameters/getNotificationScheme.ts +++ b/src/version3/parameters/getNotificationScheme.ts @@ -8,11 +8,22 @@ export interface GetNotificationScheme { * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional * information in the response. This parameter accepts a comma-separated list. Expand options include: * - * `all` Returns all expandable information. `field` Returns information about any custom fields assigned to receive - * an event. `group` Returns information about any groups assigned to receive an event. `notificationSchemeEvents` - * Returns a list of event associations. This list is returned for all expandable information. `projectRole` Returns - * information about any project roles assigned to receive an event. `user` Returns information about any users - * assigned to receive an event. + * - `all` Returns all expandable information + * - `field` Returns information about any custom fields assigned to receive an event + * - `group` Returns information about any groups assigned to receive an event + * - `notificationSchemeEvents` Returns a list of event associations. This list is returned for all expandable + * information + * - `projectRole` Returns information about any project roles assigned to receive an event + * - `user` Returns information about any users assigned to receive an event */ - expand?: string; + expand?: + | 'all' + | 'field' + | 'group' + | 'notificationSchemeEvents' + | 'projectRole' + | 'user' + | ('all' | 'field' | 'group' | 'notificationSchemeEvents' | 'projectRole' | 'user')[] + | string + | string[]; } diff --git a/src/version3/parameters/getNotificationSchemeForProject.ts b/src/version3/parameters/getNotificationSchemeForProject.ts deleted file mode 100644 index f94c777ad5..0000000000 --- a/src/version3/parameters/getNotificationSchemeForProject.ts +++ /dev/null @@ -1,15 +0,0 @@ -export interface GetNotificationSchemeForProject { - /** The project ID or project key (case sensitive). */ - projectKeyOrId: string; - /** - * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional - * information in the response. This parameter accepts a comma-separated list. Expand options include: - * - * `all` Returns all expandable information. `field` Returns information about any custom fields assigned to receive - * an event. `group` Returns information about any groups assigned to receive an event. `notificationSchemeEvents` - * Returns a list of event associations. This list is returned for all expandable information. `projectRole` Returns - * information about any project roles assigned to receive an event. `user` Returns information about any users - * assigned to receive an event. - */ - expand?: string; -} diff --git a/src/version3/parameters/getOptionsForField.ts b/src/version3/parameters/getOptionsForField.ts deleted file mode 100644 index 68206af359..0000000000 --- a/src/version3/parameters/getOptionsForField.ts +++ /dev/null @@ -1,11 +0,0 @@ -export interface GetOptionsForField { - /** - * The ID of the custom field. Note: This is the numeric part of the of the field ID. For example, for a field with - * the ID _customfield_10075_ use _10075_. - */ - fieldId: number; - /** 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; -} diff --git a/src/version3/parameters/getPrecomputations.ts b/src/version3/parameters/getPrecomputations.ts index 44a3e8275f..26b642d990 100644 --- a/src/version3/parameters/getPrecomputations.ts +++ b/src/version3/parameters/getPrecomputations.ts @@ -1,7 +1,36 @@ export interface GetPrecomputations { + /** + * The function key in format: + * + * Forge: `ari:cloud:ecosystem::extension/[App ID]/[Environment ID]/static/[Function key from manifest]` Connect: + * `[App key]__[Module key]` + */ functionKey?: string[]; + /** 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; - orderBy?: string; + /** + * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#ordering) the results by a field: + * + * - `functionKey` Sorts by the functionKey. + * - `used` Sorts by the used timestamp. + * - `created` Sorts by the created timestamp. + * - `updated` Sorts by the updated timestamp. + */ + orderBy?: + | 'functionKey' + | 'used' + | 'created' + | 'updated' + | '+functionKey' + | '+used' + | '+created' + | '+updated' + | '-functionKey' + | '-used' + | '-created' + | '-updated' + | string; filter?: string; } diff --git a/src/version3/parameters/getProjectComponentsPaginated.ts b/src/version3/parameters/getProjectComponentsPaginated.ts index f6bd7f0c14..2c7a2c8f6a 100644 --- a/src/version3/parameters/getProjectComponentsPaginated.ts +++ b/src/version3/parameters/getProjectComponentsPaginated.ts @@ -8,10 +8,25 @@ export interface GetProjectComponentsPaginated { /** * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#ordering) the results by a field: * - * `description` Sorts by the component description. `issueCount` Sorts by the count of issues associated with the - * component. `lead` Sorts by the user key of the component's project lead. `name` Sorts by component name. + * - `description` Sorts by the component description. + * - `issueCount` Sorts by the count of issues associated with the component. + * - `lead` Sorts by the user key of the component's project lead. + * - `name` Sorts by component name. */ - orderBy?: string; + orderBy?: + | 'description' + | '-description' + | '+description' + | 'issueCount' + | '-issueCount' + | '+issueCount' + | 'lead' + | '-lead' + | '+lead' + | 'name' + | '-name' + | '+name' + | string; /** * Filter the results using a literal string. Components with a matching `name` or `description` are returned (case * insensitive). diff --git a/src/version3/parameters/getProjectRole.ts b/src/version3/parameters/getProjectRole.ts index e52131c8c6..0107933ff3 100644 --- a/src/version3/parameters/getProjectRole.ts +++ b/src/version3/parameters/getProjectRole.ts @@ -1,5 +1,5 @@ export interface GetProjectRole { - /** The project ID or project key (case-sensitive). */ + /** The project ID or project key (case sensitive). */ projectIdOrKey: string; /** * The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role diff --git a/src/version3/parameters/getProjectTypeByKey.ts b/src/version3/parameters/getProjectTypeByKey.ts index 009f7af376..d371bfda66 100644 --- a/src/version3/parameters/getProjectTypeByKey.ts +++ b/src/version3/parameters/getProjectTypeByKey.ts @@ -1,4 +1,4 @@ export interface GetProjectTypeByKey { /** The key of the project type. */ - projectTypeKey: string; + projectTypeKey: 'software' | 'service_desk' | 'business' | 'product_discovery' | string; } diff --git a/src/version3/parameters/getProjectVersionsPaginated.ts b/src/version3/parameters/getProjectVersionsPaginated.ts index c24a0f1a0b..485550e3b9 100644 --- a/src/version3/parameters/getProjectVersionsPaginated.ts +++ b/src/version3/parameters/getProjectVersionsPaginated.ts @@ -8,12 +8,29 @@ export interface GetProjectVersionsPaginated { /** * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#ordering) the results by a field: * - * `description` Sorts by version description. `name` Sorts by version name. `releaseDate` Sorts by release date, - * starting with the oldest date. Versions with no release date are listed last. `sequence` Sorts by the order of - * appearance in the user interface. `startDate` Sorts by start date, starting with the oldest date. Versions with no - * start date are listed last. + * - `description` Sorts by version description. + * - `name` Sorts by version name. + * - `releaseDate` Sorts by release date, starting with the oldest date. Versions with no release date are listed last. + * - `sequence` Sorts by the order of appearance in the user interface. + * - `startDate` Sorts by start date, starting with the oldest date. Versions with no start date are listed last. */ - orderBy?: string; + orderBy?: + | 'description' + | '-description' + | '+description' + | 'name' + | '-name' + | '+name' + | 'releaseDate' + | '-releaseDate' + | '+releaseDate' + | 'sequence' + | '-sequence' + | '+sequence' + | 'startDate' + | '-startDate' + | '+startDate' + | string; /** * Filter the results using a literal string. Versions with matching `name` or `description` are returned (case * insensitive). @@ -23,13 +40,15 @@ export interface GetProjectVersionsPaginated { * A list of status values used to filter the results by version status. This parameter accepts a comma-separated * list. The status values are `released`, `unreleased`, and `archived`. */ - status?: string; + status?: 'released' | 'unreleased' | 'archived' | string; /** * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional * information in the response. This parameter accepts a comma-separated list. Expand options include: * - * `issuesstatus` Returns the number of issues in each status category for each version. `operations` Returns actions - * that can be performed on the specified version. + * - `issuesstatus` Returns the number of issues in each status category for each version. + * - `operations` Returns actions that can be performed on the specified version. + * - `driver` Returns the Atlassian account ID of the version driver. + * - `approvers` Returns a list containing the approvers for this version. */ - expand?: string; + expand?: 'issuesstatus' | 'operations' | 'driver' | 'approvers' | string | string[]; } diff --git a/src/version3/parameters/getRecent.ts b/src/version3/parameters/getRecent.ts index 3dbb92f147..2d6e771fab 100644 --- a/src/version3/parameters/getRecent.ts +++ b/src/version3/parameters/getRecent.ts @@ -24,33 +24,10 @@ export interface GetRecent { | '*' | ('description' | 'projectKeys' | 'lead' | 'issueTypes' | 'url' | 'permissions' | 'insight' | '*')[] | string - | string[] - | GetRecent.Expand - | GetRecent.Expand[]; + | string[]; /** * EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated * list. Invalid property names are ignored. */ properties?: string[]; } - -export namespace GetRecent { - export enum Expand { - /** Returns the project description. */ - Description = 'description', - /** Returns all project keys associated with a project. */ - ProjectKeys = 'projectKeys', - /** Returns information about the project lead. */ - Lead = 'lead', - /** Returns all issue types associated with the project. */ - IssueTypes = 'issueTypes', - /** Returns the URL associated with the project. */ - Url = 'url', - /** Returns the permissions associated with the project. */ - Permissions = 'permissions', - /** EXPERIMENTAL. Returns the insight details of total issue count and last issue update time for the project. */ - Insight = 'insight', - /** Returns the project with all available expand options. */ - All = '*', - } -} diff --git a/src/version3/parameters/getResolution.ts b/src/version3/parameters/getResolution.ts deleted file mode 100644 index 13eba23264..0000000000 --- a/src/version3/parameters/getResolution.ts +++ /dev/null @@ -1,4 +0,0 @@ -export interface GetResolution { - /** The ID of the issue resolution value. */ - id: string; -} diff --git a/src/version3/parameters/getScreenSchemes.ts b/src/version3/parameters/getScreenSchemes.ts index c47f7e289e..72d85eb05b 100644 --- a/src/version3/parameters/getScreenSchemes.ts +++ b/src/version3/parameters/getScreenSchemes.ts @@ -19,7 +19,8 @@ export interface GetScreenSchemes { /** * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#ordering) the results by a field: * - * `id` Sorts by screen scheme ID. `name` Sorts by screen scheme name. + * - `id` Sorts by screen scheme ID. + * - `name` Sorts by screen scheme name. */ - orderBy?: string; + orderBy?: 'name' | '-name' | '+name' | 'id' | '-id' | '+id' | string; } diff --git a/src/version3/parameters/getScreens.ts b/src/version3/parameters/getScreens.ts index 0d94f8d764..e1da8ce0aa 100644 --- a/src/version3/parameters/getScreens.ts +++ b/src/version3/parameters/getScreens.ts @@ -14,11 +14,12 @@ export interface GetScreens { * The scope filter string. To filter by multiple scope, provide an ampersand-separated list. For example, * `scope=GLOBAL&scope=PROJECT`. */ - scope?: string[]; + scope?: ('GLOBAL' | 'TEMPLATE' | 'PROJECT' | string)[]; /** * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#ordering) the results by a field: * - * `id` Sorts by screen ID. `name` Sorts by screen name. + * - `id` Sorts by screen ID. + * - `name` Sorts by screen name. */ - orderBy?: string; + orderBy?: 'name' | '-name' | '+name' | 'id' | '-id' | '+id' | string; } diff --git a/src/version3/parameters/getSecurityLevelMembers.ts b/src/version3/parameters/getSecurityLevelMembers.ts index cf72d40bda..76cc5349f5 100644 --- a/src/version3/parameters/getSecurityLevelMembers.ts +++ b/src/version3/parameters/getSecurityLevelMembers.ts @@ -28,5 +28,13 @@ export interface GetSecurityLevelMembers { * - `projectRole` Returns information about the project role granted the permission * - `user` Returns information about the user who is granted the permission */ - expand?: string | string[]; + expand?: + | 'all' + | 'field' + | 'group' + | 'projectRole' + | 'user' + | ('all' | 'field' | 'group' | 'projectRole' | 'user')[] + | string + | string[]; } diff --git a/src/version3/parameters/getStatusesById.ts b/src/version3/parameters/getStatusesById.ts index 1d60da4ed0..e710dfecc6 100644 --- a/src/version3/parameters/getStatusesById.ts +++ b/src/version3/parameters/getStatusesById.ts @@ -4,13 +4,14 @@ export interface GetStatusesById { * information in the response. This parameter accepts a comma-separated list. Expand options include: * * - `usages` Returns the project and issue types that use the status in their workflow. + * - `workflowUsages` Returns the workflows that use the status. */ - expand?: 'usages' | 'usages'[] | string | string[]; + expand?: 'usages' | 'workflowUsages' | ('usages' | 'workflowUsages')[] | string | string[]; /** * The list of status IDs. To include multiple IDs, provide an ampersand-separated list. For example, * id=10000&id=10001. * - * Min items `1`, Max items `50` + * Min items `1`, Max items `50` */ id: string[]; } diff --git a/src/version3/parameters/getTrashedFieldsPaginated.ts b/src/version3/parameters/getTrashedFieldsPaginated.ts index a38535c138..26b4119a14 100644 --- a/src/version3/parameters/getTrashedFieldsPaginated.ts +++ b/src/version3/parameters/getTrashedFieldsPaginated.ts @@ -1,8 +1,12 @@ export interface GetTrashedFieldsPaginated { - expand?: string | string[]; - id?: string[]; + /** 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; + id?: string[]; + /** String used to perform a case-insensitive partial match with field names or descriptions. */ + query?: string; + expand?: string | string[]; /** * [Order](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#ordering) the results by a field: * @@ -12,17 +16,16 @@ export interface GetTrashedFieldsPaginated { */ orderBy?: | 'name' - | 'trashDate' - | 'plannedDeletionDate' - | '+name' - | '+trashDate' - | '+plannedDeletionDate' | '-name' + | '+name' + | 'trashDate' | '-trashDate' + | '+trashDate' + | 'plannedDeletionDate' | '-plannedDeletionDate' + | '+plannedDeletionDate' + | 'projectsCount' + | '-projectsCount' + | '+projectsCount' | string; - /** String used to perform a case-insensitive partial match with field names or descriptions. */ - query?: string; - /** The index of the first item to return in a page of results (page offset). */ - startAt?: number; } diff --git a/src/version3/parameters/getUser.ts b/src/version3/parameters/getUser.ts index 9f120985c5..6d17d114ed 100644 --- a/src/version3/parameters/getUser.ts +++ b/src/version3/parameters/getUser.ts @@ -23,21 +23,5 @@ export interface GetUser { * - `groups` includes all groups and nested groups to which the user belongs. * - `applicationRoles` includes details of all the applications to which the user has access. */ - expand?: - | 'groups' - | 'applicationRoles' - | ('groups' | 'applicationRoles')[] - | string - | string[] - | GetUser.Expand - | GetUser.Expand[]; -} - -export namespace GetUser { - export enum Expand { - /** Includes all groups and nested groups to which the user belongs. */ - Groups = 'groups', - /** Includes details of all the applications to which the user has access. */ - ApplicationRoles = 'applicationRoles', - } + expand?: 'groups' | 'applicationRoles' | ('groups' | 'applicationRoles')[] | string | string[]; } diff --git a/src/version3/parameters/getUserDefaultColumns.ts b/src/version3/parameters/getUserDefaultColumns.ts index 33abc5626b..b98bf15517 100644 --- a/src/version3/parameters/getUserDefaultColumns.ts +++ b/src/version3/parameters/getUserDefaultColumns.ts @@ -4,10 +4,4 @@ export interface GetUserDefaultColumns { * _5b10ac8d82e05b22cc7d4ef5_. */ accountId?: string; - /** - * @deprecated This parameter is no longer available See the [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - username?: string; } diff --git a/src/version3/parameters/getUserGroups.ts b/src/version3/parameters/getUserGroups.ts index e71383bc45..f7bfa475d8 100644 --- a/src/version3/parameters/getUserGroups.ts +++ b/src/version3/parameters/getUserGroups.ts @@ -4,16 +4,4 @@ export interface GetUserGroups { * _5b10ac8d82e05b22cc7d4ef5_. */ accountId: string; - /** - * @deprecated This parameter is no longer available. See the [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - username?: string; - /** - * @deprecated This parameter is no longer available. See the [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - key?: string; } diff --git a/src/version3/parameters/getVersion.ts b/src/version3/parameters/getVersion.ts index b91eb50f18..651e02895c 100644 --- a/src/version3/parameters/getVersion.ts +++ b/src/version3/parameters/getVersion.ts @@ -5,9 +5,19 @@ export interface GetVersion { * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional * information about version in the response. This parameter accepts a comma-separated list. Expand options include: * - * `operations` Returns the list of operations available for this version. `issuesstatus` Returns the count of issues - * in this version for each of the status categories _to do_, _in progress_, _done_, and _unmapped_. The _unmapped_ - * property represents the number of issues with a status other than _to do_, _in progress_, and _done_. + * - `operations` Returns the list of operations available for this version. + * - `issuesstatus` Returns the count of issues in this version for each of the status categories _to do_, _in + * progress_, _done_, and _unmapped_. The _unmapped_ property represents the number of issues with a status other + * than _to do_, _in progress_, and _done_. + * - `driver` Returns the Atlassian account ID of the version driver. + * - `approvers` Returns a list containing the Atlassian account IDs of approvers for this version. */ - expand?: string; + expand?: + | 'operations' + | 'issuesstatus' + | 'driver' + | 'approvers' + | ('operations' | 'issuesstatus' | 'driver' | 'approvers')[] + | string + | string[]; } diff --git a/src/version3/parameters/getWorkflowTransitionProperties.ts b/src/version3/parameters/getWorkflowTransitionProperties.ts index 1a4290c635..fbfb681220 100644 --- a/src/version3/parameters/getWorkflowTransitionProperties.ts +++ b/src/version3/parameters/getWorkflowTransitionProperties.ts @@ -17,5 +17,5 @@ export interface GetWorkflowTransitionProperties { /** The name of the workflow that the transition belongs to. */ workflowName: string; /** The workflow status. Set to _live_ for active and inactive workflows, or _draft_ for draft workflows. */ - workflowMode?: string; + workflowMode?: 'live' | 'draft' | string; } diff --git a/src/version3/parameters/getWorkflowTransitionRuleConfigurations.ts b/src/version3/parameters/getWorkflowTransitionRuleConfigurations.ts index b179eae855..9f5a6b5377 100644 --- a/src/version3/parameters/getWorkflowTransitionRuleConfigurations.ts +++ b/src/version3/parameters/getWorkflowTransitionRuleConfigurations.ts @@ -4,19 +4,22 @@ export interface GetWorkflowTransitionRuleConfigurations { /** The maximum number of items to return per page. */ maxResults?: number; /** The types of the transition rules to return. */ - types: string[]; - /** The transition rule class keys, as defined in the Connect app descriptor, of the transition rules to return. */ + types: ('postfunction' | 'condition' | 'validator' | string)[]; + /** + * The transition rule class keys, as defined in the Connect or the Forge app descriptor, of the transition rules to + * return. + */ keys?: string[]; - /** EXPERIMENTAL: The list of workflow names to filter by. */ + /** The list of workflow names to filter by. */ workflowNames?: string[]; - /** EXPERIMENTAL: The list of `tags` to filter by. */ + /** The list of `tags` to filter by. */ withTags?: string[]; - /** EXPERIMENTAL: Whether draft or published workflows are returned. If not provided, both workflow types are returned. */ + /** Whether draft or published workflows are returned. If not provided, both workflow types are returned. */ draft?: boolean; /** * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional * information in the response. This parameter accepts `transition`, which, for each rule, returns information about * the transition the rule is assigned to. */ - expand?: string; + expand?: 'transition' | string; } diff --git a/src/version3/parameters/getWorkflowsPaginated.ts b/src/version3/parameters/getWorkflowsPaginated.ts index bb88623502..a8fd7f7827 100644 --- a/src/version3/parameters/getWorkflowsPaginated.ts +++ b/src/version3/parameters/getWorkflowsPaginated.ts @@ -22,6 +22,10 @@ export interface GetWorkflowsPaginated { * automatically if this expand is requested. * - `default` For each workflow, returns information about whether this is the default workflow. * - `schemes` For each workflow, returns information about the workflow schemes the workflow is assigned to. + * - `projects` For each workflow, returns information about the projects the workflow is assigned to, through workflow + * schemes. + * - `hasDraftWorkflow` For each workflow, returns information about whether the workflow has a draft version. + * - `operations` For each workflow, returns information about the actions that can be undertaken on the workflow. */ expand?: | 'transitions' @@ -31,6 +35,9 @@ export interface GetWorkflowsPaginated { | 'statuses.properties' | 'default' | 'schemes' + | 'projects' + | 'hasDraftWorkflow' + | 'operations' | ( | 'transitions' | 'transitions.rules' @@ -39,6 +46,9 @@ export interface GetWorkflowsPaginated { | 'statuses.properties' | 'default' | 'schemes' + | 'projects' + | 'hasDraftWorkflow' + | 'operations' )[] | string | string[]; @@ -53,13 +63,13 @@ export interface GetWorkflowsPaginated { */ orderBy?: | 'name' - | 'created' - | 'updated' + | '-name' | '+name' + | 'created' + | '-created' | '+created' + | 'updated' | '+updated' - | '-name' - | '-created' | '-updated' | string; /** Filters active and inactive workflows. */ diff --git a/src/version3/parameters/index.ts b/src/version3/parameters/index.ts index 122627e328..862d5d6655 100644 --- a/src/version3/parameters/index.ts +++ b/src/version3/parameters/index.ts @@ -5,7 +5,6 @@ export * from './addFieldToDefaultScreen'; export * from './addGadget'; export * from './addIssueTypesToContext'; export * from './addIssueTypesToIssueTypeScheme'; -export * from './addNotifications'; export * from './addProjectRoleActorsToRole'; export * from './addScreenTab'; export * from './addScreenTabField'; @@ -29,15 +28,12 @@ export * from './assignPermissionScheme'; export * from './assignProjectsToCustomFieldContext'; export * from './assignSchemeToProject'; export * from './associateSchemesToProjects'; -export * from './associateSchemeWithProject'; -export * from './associateSchemeWithProject'; export * from './bulkDeleteIssueProperty'; export * from './bulkEditDashboards'; export * from './bulkGetGroups'; export * from './bulkGetUsers'; export * from './bulkGetUsersMigration'; export * from './bulkSetIssuePropertiesByIssue'; -export * from './bulkSetIssuePropertiesByIssue'; export * from './bulkSetIssueProperty'; export * from './bulkSetIssuesProperties'; export * from './cancelTask'; @@ -47,15 +43,12 @@ export * from './createComponent'; export * from './createCustomField'; export * from './createCustomFieldContext'; export * from './createCustomFieldOption'; -export * from './createCustomFieldOptions'; export * from './createDashboard'; export * from './createFieldConfiguration'; export * from './createFieldConfigurationScheme'; -export * from './createFieldConfigurationScheme'; export * from './createFilter'; export * from './createGroup'; export * from './createIssue'; -export * from './createIssueAdjustment'; export * from './createIssueFieldOption'; export * from './createIssueLinkType'; export * from './createIssues'; @@ -103,11 +96,9 @@ export * from './deleteDraftWorkflowMapping'; export * from './deleteFavouriteForFilter'; export * from './deleteFieldConfiguration'; export * from './deleteFieldConfigurationScheme'; -export * from './deleteFieldConfigurationScheme'; export * from './deleteFilter'; export * from './deleteInactiveWorkflow'; export * from './deleteIssue'; -export * from './deleteIssueAdjustment'; export * from './deleteIssueFieldOption'; export * from './deleteIssueLink'; export * from './deleteIssueLinkType'; @@ -119,7 +110,6 @@ export * from './deleteIssueTypeScreenScheme'; export * from './deleteNotificationScheme'; export * from './deletePermissionScheme'; export * from './deletePermissionSchemeEntity'; -export * from './deletePriority'; export * from './deleteProject'; export * from './deleteProjectAsynchronously'; export * from './deleteProjectAvatar'; @@ -137,7 +127,6 @@ export * from './deleteSharePermission'; export * from './deleteStatusesById'; export * from './deleteUiModification'; export * from './deleteUserProperty'; -export * from './deleteVersion'; export * from './deleteWebhookById'; export * from './deleteWorkflowMapping'; export * from './deleteWorkflowScheme'; @@ -177,14 +166,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 './getAllUsers'; export * from './getAllUsersDefault'; -export * from './getAllWorkflows'; export * from './getAllWorkflowSchemes'; export * from './getAlternativeIssueTypes'; export * from './getApplicationProperty'; @@ -212,7 +199,6 @@ export * from './getCommentsByIds'; export * from './getComponent'; export * from './getComponentRelatedIssues'; export * from './getContextsForField'; -export * from './getContextsForFieldDeprecated'; export * from './getCreateIssueMeta'; export * from './getCurrentUser'; export * from './getCustomFieldConfiguration'; @@ -237,14 +223,11 @@ export * from './getFieldConfigurationSchemeMappings'; export * from './getFieldConfigurationSchemeProjectMapping'; export * from './getFieldsPaginated'; export * from './getFilter'; -export * from './getFilters'; export * from './getFiltersPaginated'; -export * from './getGroup'; export * from './getHierarchy'; export * from './getIdsOfWorklogsDeletedSince'; export * from './getIdsOfWorklogsModifiedSince'; export * from './getIssue'; -export * from './getIssueAdjustments'; export * from './getIssueFieldOption'; export * from './getIssueLink'; export * from './getIssueLinkType'; @@ -267,15 +250,12 @@ export * from './getIssueTypesForProject'; export * from './getIssueWatchers'; export * from './getIssueWorklog'; export * from './getIsWatchingIssueBulk'; -export * from './getIsWatchingIssueBulk'; export * from './getMyFilters'; export * from './getMyPermissions'; export * from './getNotificationScheme'; -export * from './getNotificationSchemeForProject'; export * from './getNotificationSchemes'; export * from './getNotificationSchemeToProjectMappings'; export * from './getOptionsForContext'; -export * from './getOptionsForField'; export * from './getPermissionScheme'; export * from './getPermissionSchemeGrant'; export * from './getPermissionSchemeGrants'; @@ -304,7 +284,6 @@ export * from './getProjectVersionsPaginated'; export * from './getRecent'; export * from './getRemoteIssueLinkById'; export * from './getRemoteIssueLinks'; -export * from './getResolution'; export * from './getScreens'; export * from './getScreenSchemes'; export * from './getScreensForField'; @@ -374,7 +353,6 @@ export * from './removeGroup'; export * from './removeIssueTypeFromIssueTypeScheme'; export * from './removeIssueTypesFromContext'; export * from './removeIssueTypesFromGlobalFieldConfigurationScheme'; -export * from './removeIssueTypesFromGlobalFieldConfigurationScheme'; export * from './removeLevel'; export * from './removeMappingsFromIssueTypeScreenScheme'; export * from './removeMemberFromSecurityLevel'; @@ -418,10 +396,8 @@ export * from './setDefaultShareScope'; export * from './setDefaultValues'; export * from './setFavouriteForFilter'; export * from './setFieldConfigurationSchemeMapping'; -export * from './setFieldConfigurationSchemeMapping'; export * from './setIssueProperty'; export * from './setIssueTypeProperty'; -export * from './setLocale'; export * from './setPreference'; export * from './setProjectProperty'; export * from './setSharedTimeTrackingConfiguration'; @@ -440,7 +416,6 @@ export * from './updateCustomField'; export * from './updateCustomFieldConfiguration'; export * from './updateCustomFieldContext'; export * from './updateCustomFieldOption'; -export * from './updateCustomFieldOptions'; export * from './updateCustomFieldValue'; export * from './updateDashboard'; export * from './updateDefaultScreenScheme'; @@ -450,12 +425,9 @@ export * from './updateDraftWorkflowMapping'; export * from './updateEntityPropertiesValue'; export * from './updateFieldConfiguration'; export * from './updateFieldConfigurationItems'; -export * from './updateFieldConfigurationItems'; -export * from './updateFieldConfigurationScheme'; export * from './updateFieldConfigurationScheme'; export * from './updateFilter'; export * from './updateGadget'; -export * from './updateIssueAdjustment'; export * from './updateIssueFieldOption'; export * from './updateIssueFields'; export * from './updateIssueLinkType'; @@ -472,7 +444,6 @@ export * from './updateProject'; export * from './updateProjectAvatar'; export * from './updateProjectCategory'; export * from './updateProjectEmail'; -export * from './updateProjectType'; export * from './updateRemoteIssueLink'; export * from './updateResolution'; export * from './updateScreen'; diff --git a/src/version3/parameters/parseJqlQueries.ts b/src/version3/parameters/parseJqlQueries.ts index 7ad538c5ae..13445147e3 100644 --- a/src/version3/parameters/parseJqlQueries.ts +++ b/src/version3/parameters/parseJqlQueries.ts @@ -4,9 +4,10 @@ export interface ParseJqlQueries extends JqlQueriesToParse { /** * How to validate the JQL query and treat the validation results. Validation options include: * - * `strict` Returns all errors. If validation fails, the query structure is not returned. `warn` Returns all errors. - * If validation fails but the JQL query is correctly formed, the query structure is returned. `none` No validation is - * performed. If JQL query is correctly formed, the query structure is returned. + * - `strict` Returns all errors. If validation fails, the query structure is not returned. + * - `warn` Returns all errors. If validation fails but the JQL query is correctly formed, the query structure is + * returned. + * - `none` No validation is performed. If JQL query is correctly formed, the query structure is returned. */ - validation?: string; + validation?: 'strict' | 'warn' | 'none' | string; } diff --git a/src/version3/parameters/putAddonProperty.ts b/src/version3/parameters/putAddonProperty.ts index e55c600f54..f1be24ac61 100644 --- a/src/version3/parameters/putAddonProperty.ts +++ b/src/version3/parameters/putAddonProperty.ts @@ -3,7 +3,5 @@ export interface PutAddonProperty { addonKey: string; /** The key of the property. */ propertyKey: string; - /** @deprecated */ - property: any; propertyValue: any; } diff --git a/src/version3/parameters/replaceIssueFieldOption.ts b/src/version3/parameters/replaceIssueFieldOption.ts index ec5f51886a..fd536f3d28 100644 --- a/src/version3/parameters/replaceIssueFieldOption.ts +++ b/src/version3/parameters/replaceIssueFieldOption.ts @@ -4,13 +4,13 @@ export interface ReplaceIssueFieldOption { /** A JQL query that specifies the issues to be updated. For example, _project=10000_. */ jql?: string; /** - * Whether screen security is overridden to enable hidden fields to be edited. Available to Connect app users with - * admin permission and Forge app users with the `manage:jira-configuration` scope. + * Whether screen security is overridden to enable hidden fields to be edited. Available to Connect and Forge app + * users with admin permission. */ overrideScreenSecurity?: boolean; /** - * Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with - * admin permission and Forge app users with the `manage:jira-configuration` scope. + * Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect and Forge app + * users with _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ overrideEditableFlag?: boolean; /** diff --git a/src/version3/parameters/search.ts b/src/version3/parameters/search.ts index 07cfd8e417..12e70ef240 100644 --- a/src/version3/parameters/search.ts +++ b/src/version3/parameters/search.ts @@ -4,8 +4,9 @@ export interface Search { * information in the response. This parameter accepts a comma-separated list. Expand options include: * * - `usages` Returns the project and issue types that use the status in their workflow. + * - `workflowUsages` Returns the workflows that use the status. */ - expand?: 'usages' | 'usages'[] | string | string[]; + expand?: 'usages' | 'workflowUsages' | ('usages' | 'workflowUsages')[] | string | string[]; /** The project the status is part of or null for global statuses. */ projectId?: string; /** The index of the first item to return in a page of results (page offset). */ diff --git a/src/version3/parameters/searchForIssuesUsingJql.ts b/src/version3/parameters/searchForIssuesUsingJql.ts index db44aa4cff..c47b71a6c1 100644 --- a/src/version3/parameters/searchForIssuesUsingJql.ts +++ b/src/version3/parameters/searchForIssuesUsingJql.ts @@ -18,13 +18,13 @@ export interface SearchForIssuesUsingJql { /** * Determines how to validate the JQL query and treat the validation results. Supported values are: * - * `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings). - * `warn` Returns all errors as warnings. `none` No validation is performed. `true` _Deprecated_ A legacy synonym for - * `strict`. `false` _Deprecated_ A legacy synonym for `warn`. + * - `strict` Returns a 400 response code if any errors are found, along with a list of all errors (and warnings). + * - `warn` Returns all errors as warnings. `none` No validation is performed. `true` _Deprecated_ A legacy synonym for + * - `strict`. `false` _Deprecated_ A legacy synonym for `warn`. * * Note: If the JQL is not correctly formed a 400 response code is returned, regardless of the `validateQuery` value. */ - validateQuery?: string; + validateQuery?: 'strict' | 'warn' | 'none' | string; /** * 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: diff --git a/src/version3/parameters/searchPriorities.ts b/src/version3/parameters/searchPriorities.ts index bf52a7800a..2d704bbb30 100644 --- a/src/version3/parameters/searchPriorities.ts +++ b/src/version3/parameters/searchPriorities.ts @@ -7,7 +7,7 @@ export interface SearchPriorities { id?: string[]; /** * The list of projects IDs. To include multiple IDs, provide an ampersand-separated list. For example, - * `projectid=10010&projectid=10111`. + * `projectId=10010&projectId=10111`. */ projectId?: string[]; /** Whether only the default priority is returned. */ diff --git a/src/version3/parameters/searchProjects.ts b/src/version3/parameters/searchProjects.ts index 843e723c00..7332016028 100644 --- a/src/version3/parameters/searchProjects.ts +++ b/src/version3/parameters/searchProjects.ts @@ -18,28 +18,28 @@ export interface SearchProjects { */ orderBy?: | 'category' - | 'issueCount' - | 'key' - | 'lastIssueUpdatedTime' - | 'name' - | 'owner' - | 'archivedDate' - | 'deletedDate' + | '-category' | '+category' - | '+issueCount' + | 'key' + | '-key' | '+key' - | '+lastIssueUpdatedTime' + | 'name' + | '-name' | '+name' + | 'owner' + | '-owner' | '+owner' - | '+archivedDate' - | '+deletedDate' - | '-category' + | 'issueCount' | '-issueCount' - | '-key' - | '-lastIssueUpdatedTime' - | '-name' - | '-owner' + | '+issueCount' + | 'lastIssueUpdatedDate' + | '-lastIssueUpdatedDate' + | '+lastIssueUpdatedDate' + | 'archivedDate' + | '+archivedDate' | '-archivedDate' + | 'deletedDate' + | '+deletedDate' | '-deletedDate' | string; /** @@ -80,9 +80,11 @@ export interface SearchProjects { * project, meaning that they have one of the following permissions: * * _Administer projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project. _Administer - * Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). + * Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). `create` the project, meaning that they have + * the _Create issues_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the + * issue is created. */ - action?: string; + action?: 'view' | 'browse' | 'edit' | 'create' | string; /** * Use [expand](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#expansion) to include additional * information in the response. This parameter accepts a comma-separated list. Expanded options include: @@ -111,7 +113,7 @@ export interface SearchProjects { * `live` Search live projects. `archived` Search archived projects. `deleted` Search deleted projects, those in the * recycle bin. */ - status?: string[]; + status?: ('live' | 'archived' | 'deleted' | string)[]; /** * EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated * list. diff --git a/src/version3/parameters/searchResolutions.ts b/src/version3/parameters/searchResolutions.ts index d41dc361ba..c20be824e6 100644 --- a/src/version3/parameters/searchResolutions.ts +++ b/src/version3/parameters/searchResolutions.ts @@ -6,7 +6,7 @@ export interface SearchResolutions { /** The list of resolutions IDs to be filtered out */ id?: string[]; /** - * When set to true, return default only,when IDs provided, if none of them is default, return empty page. Default + * When set to true, return default only, when IDs provided, if none of them is default, return empty page. Default * value is false */ onlyDefault?: boolean; diff --git a/src/version3/parameters/setDashboardItemProperty.ts b/src/version3/parameters/setDashboardItemProperty.ts index 7bf80be519..74623a28f4 100644 --- a/src/version3/parameters/setDashboardItemProperty.ts +++ b/src/version3/parameters/setDashboardItemProperty.ts @@ -3,7 +3,11 @@ export interface SetDashboardItemProperty { dashboardId: string; /** The ID of the dashboard item. */ itemId: string; - /** The key of the dashboard item property. The maximum length is 255 characters. */ + /** + * The key of the dashboard item property. The maximum length is 255 characters. For dashboard items with a spec URI + * and no complete module key, if the provided propertyKey is equal to "config", the request body's JSON must be an + * object with all keys and values as strings. + */ propertyKey: string; - body?: any; + propertyValue: any; } diff --git a/src/version3/parameters/setLocale.ts b/src/version3/parameters/setLocale.ts deleted file mode 100644 index b4a9b9c8b2..0000000000 --- a/src/version3/parameters/setLocale.ts +++ /dev/null @@ -1,3 +0,0 @@ -import { Locale } from '../models'; - -export interface SetLocale extends Locale {} diff --git a/src/version3/parameters/setProjectProperty.ts b/src/version3/parameters/setProjectProperty.ts index 19b2e74f86..518b1d3e9e 100644 --- a/src/version3/parameters/setProjectProperty.ts +++ b/src/version3/parameters/setProjectProperty.ts @@ -1,7 +1,7 @@ export interface SetProjectProperty { - /** The project ID or project key (case-sensitive). */ + /** The project ID or project key (case sensitive). */ projectIdOrKey: string; /** The key of the project property. The maximum length is 255 characters. */ propertyKey: string; - property: any; + propertyValue: any; } diff --git a/src/version3/parameters/setUserProperty.ts b/src/version3/parameters/setUserProperty.ts index 2bd7348395..38ad1931f4 100644 --- a/src/version3/parameters/setUserProperty.ts +++ b/src/version3/parameters/setUserProperty.ts @@ -4,20 +4,6 @@ export interface SetUserProperty { * _5b10ac8d82e05b22cc7d4ef5_. */ accountId?: string; - /** - * @deprecated This parameter is no longer available and will be removed from the documentation soon. See the - * [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - userKey?: string; - /** - * @deprecated This parameter is no longer available and will be removed from the documentation soon. See the - * [deprecation - * notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) - * for details. - */ - username?: string; /** The key of the user's property. The maximum length is 255 characters. */ propertyKey: string; propertyValue: any; diff --git a/src/version3/parameters/setWorkflowSchemeDraftIssueType.ts b/src/version3/parameters/setWorkflowSchemeDraftIssueType.ts index 1720d847a3..0c0eed3dde 100644 --- a/src/version3/parameters/setWorkflowSchemeDraftIssueType.ts +++ b/src/version3/parameters/setWorkflowSchemeDraftIssueType.ts @@ -7,7 +7,7 @@ export interface SetWorkflowSchemeDraftIssueType extends IssueTypeWorkflowMappin issueType: string; /** Details about the mapping between an issue type and a workflow. */ - body?: { + details?: { /** The ID of the issue type. Not required if updating the issue type-workflow mapping. */ issueType?: string; diff --git a/src/version3/parameters/setWorkflowSchemeIssueType.ts b/src/version3/parameters/setWorkflowSchemeIssueType.ts index 6a2200df02..3195286a36 100644 --- a/src/version3/parameters/setWorkflowSchemeIssueType.ts +++ b/src/version3/parameters/setWorkflowSchemeIssueType.ts @@ -7,7 +7,7 @@ export interface SetWorkflowSchemeIssueType extends IssueTypeWorkflowMapping { issueType: string; /** Details about the mapping between an issue type and a workflow. */ - body?: { + details?: { /** The ID of the issue type. Not required if updating the issue type-workflow mapping. */ issueType?: string; diff --git a/src/version3/parameters/storeAvatar.ts b/src/version3/parameters/storeAvatar.ts index 7bbf800cef..b9f98e0b99 100644 --- a/src/version3/parameters/storeAvatar.ts +++ b/src/version3/parameters/storeAvatar.ts @@ -1,6 +1,6 @@ export interface StoreAvatar { /** The avatar type. */ - type: string; + type: 'project' | 'issuetype' | string; /** The ID of the item the avatar is associated with. */ entityId: string; /** The X coordinate of the top-left corner of the crop region. */ @@ -9,4 +9,5 @@ export interface StoreAvatar { y?: number; /** The length of each side of the crop region. */ size: number; + avatar: any; } diff --git a/src/version3/parameters/updateComment.ts b/src/version3/parameters/updateComment.ts index 4fbb1fc8a8..3fe24754b9 100644 --- a/src/version3/parameters/updateComment.ts +++ b/src/version3/parameters/updateComment.ts @@ -9,8 +9,8 @@ export interface UpdateComment extends Comment { notifyUsers?: boolean; /** * Whether screen security is overridden to enable uneditable fields to be edited. Available to Connect app users with - * the Administer Jira global permission and Forge apps acting on behalf of users with Administer Jira global - * permission. + * the _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on + * behalf of users with _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). */ overrideEditableFlag?: boolean; /** diff --git a/src/version3/parameters/updateCustomFieldOptions.ts b/src/version3/parameters/updateCustomFieldOptions.ts deleted file mode 100644 index 88969780f0..0000000000 --- a/src/version3/parameters/updateCustomFieldOptions.ts +++ /dev/null @@ -1,9 +0,0 @@ -import { UpdateCustomFieldOption } from '../models'; - -export interface UpdateCustomFieldOptions extends UpdateCustomFieldOption { - /** - * The ID of the custom field. Note: This is the numeric part of the of the field ID. For example, for a field with - * the ID _customfield_10075_ use _10075_. - */ - fieldId: number; -} diff --git a/src/version3/parameters/updateEntityPropertiesValue.ts b/src/version3/parameters/updateEntityPropertiesValue.ts index 0f18c9f400..7bcf23f921 100644 --- a/src/version3/parameters/updateEntityPropertiesValue.ts +++ b/src/version3/parameters/updateEntityPropertiesValue.ts @@ -6,9 +6,17 @@ export interface UpdateEntityPropertiesValue { /** The Atlassian account ID of the impersonated user. This user must be a member of the site admin group. */ accountId: string; /** The type indicating the object that contains the entity properties. */ - entityType: string; - /** @deprecated Use `entities` instead. */ - body?: Array; + entityType: + | 'IssueProperty' + | 'CommentProperty' + | 'DashboardItemProperty' + | 'IssueTypeProperty' + | 'ProjectProperty' + | 'UserProperty' + | 'WorklogProperty' + | 'BoardProperty' + | 'SprintProperty' + | string; entities?: Array; } diff --git a/src/version3/parameters/updateIssueAdjustment.ts b/src/version3/parameters/updateIssueAdjustment.ts deleted file mode 100644 index 753794d35d..0000000000 --- a/src/version3/parameters/updateIssueAdjustment.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { UpdateIssueAdjustmentDetails } from '../models'; - -export interface UpdateIssueAdjustment extends UpdateIssueAdjustmentDetails { - /** The ID of the issue adjustment. */ - issueAdjustmentId: string; -} diff --git a/src/version3/parameters/updateProjectType.ts b/src/version3/parameters/updateProjectType.ts deleted file mode 100644 index 918f1985bd..0000000000 --- a/src/version3/parameters/updateProjectType.ts +++ /dev/null @@ -1,6 +0,0 @@ -export interface UpdateProjectType { - /** The project ID or project key (case sensitive). */ - projectIdOrKey: string; - /** The key of the new project type. */ - newProjectTypeKey: string; -} diff --git a/src/version3/parameters/updateWorklog.ts b/src/version3/parameters/updateWorklog.ts index 6dce8d81b2..747e4ca0be 100644 --- a/src/version3/parameters/updateWorklog.ts +++ b/src/version3/parameters/updateWorklog.ts @@ -10,11 +10,12 @@ export interface UpdateWorklog extends Omit { /** * Defines how to update the issue's time estimate, the options are: * - * `new` Sets the estimate to a specific value, defined in `newEstimate`. `leave` Leaves the estimate unchanged. - * `auto` Updates the estimate by the difference between the original and updated value of `timeSpent` or - * `timeSpentSeconds`. + * - `new` Sets the estimate to a specific value, defined in `newEstimate`. + * - `leave` Leaves the estimate unchanged. + * - `auto` Updates the estimate by the difference between the original and updated value of `timeSpent` or + * `timeSpentSeconds`. */ - adjustEstimate?: string; + adjustEstimate?: 'new' | 'leave' | 'manual' | 'auto' | string; /** * A comment about the worklog in [Atlassian Document * Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or @@ -33,8 +34,8 @@ export interface UpdateWorklog extends Omit { expand?: string; /** * Whether the worklog should be added to the issue even if the issue is not editable. For example, because the issue - * is closed. Connect app users with admin permission and Forge app users with the `manage:jira-configuration` scope - * can use this flag. + * is closed. Connect and Forge app users with _Administer Jira_ [global + * permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag. */ overrideEditableFlag?: boolean; } diff --git a/src/version3/projectProperties.ts b/src/version3/projectProperties.ts index 18c0aa7851..9c80b3a9ee 100644 --- a/src/version3/projectProperties.ts +++ b/src/version3/projectProperties.ts @@ -127,7 +127,7 @@ export class ProjectProperties { const config: RequestConfig = { url: `/rest/api/3/project/${parameters.projectIdOrKey}/properties/${parameters.propertyKey}`, method: 'PUT', - data: parameters.property, + data: parameters.propertyValue, }; return this.client.sendRequest(config, callback); diff --git a/src/version3/projectVersions.ts b/src/version3/projectVersions.ts index 1f6b11b967..5a53a87d9c 100644 --- a/src/version3/projectVersions.ts +++ b/src/version3/projectVersions.ts @@ -142,7 +142,6 @@ export class ProjectVersions { overdue: parameters.overdue, userStartDate: parameters.userStartDate, userReleaseDate: parameters.userReleaseDate, - project: parameters.project, projectId: parameters.projectId, moveUnfixedIssuesTo: parameters.moveUnfixedIssuesTo, operations: parameters.operations, @@ -226,7 +225,6 @@ export class ProjectVersions { released: parameters.released, startDate: parameters.startDate, releaseDate: parameters.releaseDate, - project: parameters.project, projectId: parameters.projectId, moveUnfixedIssuesTo: parameters.moveUnfixedIssuesTo, }, @@ -235,47 +233,6 @@ export class ProjectVersions { return this.client.sendRequest(config, callback); } - /** - * Deletes a project version. - * - * @deprecated Deprecated, use [ Delete and replace version](#api-rest-api-3-version-id-removeAndSwap-post) that - * supports swapping version values in custom fields, in addition to the swapping for `fixVersion` and - * `affectedVersion` provided in this resource. Alternative versions can be provided to update issues that use the - * deleted version in `fixVersion` or `affectedVersion`. If alternatives are not provided, occurrences of - * `fixVersion` and `affectedVersion` that contain the deleted version are cleared. This operation can be accessed - * anonymously. **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) - * required:** _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer - * Projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the - * version. - */ - async deleteVersion(parameters: Parameters.DeleteVersion, callback: Callback): Promise; - /** - * Deletes a project version. - * - * @deprecated Deprecated, use [ Delete and replace version](#api-rest-api-3-version-id-removeAndSwap-post) that - * supports swapping version values in custom fields, in addition to the swapping for `fixVersion` and - * `affectedVersion` provided in this resource. Alternative versions can be provided to update issues that use the - * deleted version in `fixVersion` or `affectedVersion`. If alternatives are not provided, occurrences of - * `fixVersion` and `affectedVersion` that contain the deleted version are cleared. This operation can be accessed - * anonymously. **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) - * required:** _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer - * Projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that contains the - * version. - */ - async deleteVersion(parameters: Parameters.DeleteVersion, callback?: never): Promise; - async deleteVersion(parameters: Parameters.DeleteVersion, callback?: Callback): Promise { - const config: RequestConfig = { - url: `/rest/api/3/version/${parameters.id}`, - method: 'DELETE', - params: { - moveFixIssuesTo: parameters.moveFixIssuesTo, - moveAffectedIssuesTo: parameters.moveAffectedIssuesTo, - }, - }; - - return this.client.sendRequest(config, callback); - } - /** * Merges two project versions. The merge is completed by deleting the version specified in `id` and replacing any * occurrences of its ID in `fixVersion` with the version ID specified in `moveIssuesTo`. diff --git a/src/version3/projects.ts b/src/version3/projects.ts index b690689f46..1272ee5e71 100644 --- a/src/version3/projects.ts +++ b/src/version3/projects.ts @@ -7,44 +7,6 @@ import { RequestConfig } from '../requestConfig'; export class Projects { constructor(private client: Client) {} - /** - * @deprecated Returns all projects visible to the user. Deprecated, use [ Get projects - * paginated](#api-rest-api-3-project-search-get) that supports search and pagination. This operation can be - * accessed anonymously. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * Projects are returned only where the user has _Browse Projects_ or _Administer projects_ [project - * permission](https://confluence.atlassian.com/x/yodKLg) for the project. - */ - async getAllProjects( - parameters: Parameters.GetAllProjects | undefined, - callback: Callback, - ): Promise; - /** - * @deprecated Returns all projects visible to the user. Deprecated, use [ Get projects - * paginated](#api-rest-api-3-project-search-get) that supports search and pagination. This operation can be - * accessed anonymously. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * Projects are returned only where the user has _Browse Projects_ or _Administer projects_ [project - * permission](https://confluence.atlassian.com/x/yodKLg) for the project. - */ - async getAllProjects(parameters?: Parameters.GetAllProjects, callback?: never): Promise; - async getAllProjects( - parameters?: Parameters.GetAllProjects, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: '/rest/api/3/project', - method: 'GET', - params: { - expand: parameters?.expand, - properties: parameters?.properties, - recent: parameters?.recent, - }, - }; - - return this.client.sendRequest(config, callback); - } - /** * Creates a project based on a project type template, as shown in the following table: * @@ -116,7 +78,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, @@ -305,7 +266,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, @@ -502,39 +462,6 @@ export class Projects { return this.client.sendRequest(config, callback); } - /** - * @deprecated Deprecated, this feature is no longer supported and no alternatives are available, see [Convert project - * to a different template or type](https://confluence.atlassian.com/x/yEKeOQ). Updates a [project - * type](https://confluence.atlassian.com/x/GwiiLQ). The project type can be updated for classic projects only, - * project type cannot be updated for next-gen projects. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async updateProjectType( - parameters: Parameters.UpdateProjectType, - callback: Callback, - ): Promise; - /** - * @deprecated Deprecated, this feature is no longer supported and no alternatives are available, see [Convert project - * to a different template or type](https://confluence.atlassian.com/x/yEKeOQ). Updates a [project - * type](https://confluence.atlassian.com/x/GwiiLQ). The project type can be updated for classic projects only, - * project type cannot be updated for next-gen projects. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async updateProjectType(parameters: Parameters.UpdateProjectType, callback?: never): Promise; - async updateProjectType( - parameters: Parameters.UpdateProjectType, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: `/rest/api/3/project/${parameters.projectIdOrKey}/type/${parameters.newProjectTypeKey}`, - method: 'PUT', - }; - - return this.client.sendRequest(config, callback); - } - /** * Get the issue type hierarchy for a next-gen project. * @@ -584,45 +511,4 @@ export class Projects { return this.client.sendRequest(config, callback); } - - /** - * Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project. Deprecated, - * use [Get notification schemes paginated](#api-rest-api-3-notificationscheme-get) supporting search and pagination. - * - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project - * permission](https://confluence.atlassian.com/x/yodKLg). - */ - async getNotificationSchemeForProject( - parameters: Parameters.GetNotificationSchemeForProject | string, - callback: Callback, - ): Promise; - /** - * Gets a [notification scheme](https://confluence.atlassian.com/x/8YdKLg) associated with the project. Deprecated, - * use [Get notification schemes paginated](#api-rest-api-3-notificationscheme-get) supporting search and pagination. - * - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg) or _Administer Projects_ [project - * permission](https://confluence.atlassian.com/x/yodKLg). - */ - async getNotificationSchemeForProject( - parameters: Parameters.GetNotificationSchemeForProject | string, - callback?: never, - ): Promise; - async getNotificationSchemeForProject( - parameters: Parameters.GetNotificationSchemeForProject | string, - callback?: Callback, - ): Promise { - const projectKeyOrId = typeof parameters === 'string' ? parameters : parameters.projectKeyOrId; - - const config: RequestConfig = { - url: `/rest/api/3/project/${projectKeyOrId}/notificationscheme`, - method: 'GET', - params: { - expand: typeof parameters !== 'string' && parameters.expand, - }, - }; - - return this.client.sendRequest(config, callback); - } } diff --git a/src/version3/userProperties.ts b/src/version3/userProperties.ts index 866b0f712e..a65acc1c60 100644 --- a/src/version3/userProperties.ts +++ b/src/version3/userProperties.ts @@ -138,8 +138,6 @@ export class UserProperties { method: 'PUT', params: { accountId: parameters.accountId, - userKey: parameters.userKey, - username: parameters.username, }, data: parameters.propertyValue, }; diff --git a/src/version3/userSearch.ts b/src/version3/userSearch.ts index 6eb498382b..3c0088dee1 100644 --- a/src/version3/userSearch.ts +++ b/src/version3/userSearch.ts @@ -293,7 +293,6 @@ export class UserSearch { query: parameters.query, maxResults: parameters.maxResults, showAvatar: parameters.showAvatar, - exclude: parameters.exclude, excludeAccountIds: paramSerializer('excludeAccountIds', parameters.excludeAccountIds), avatarSize: parameters.avatarSize, excludeConnectUsers: parameters.excludeConnectUsers, diff --git a/src/version3/users.ts b/src/version3/users.ts index f5c1840b4b..e0e0bb33c1 100644 --- a/src/version3/users.ts +++ b/src/version3/users.ts @@ -72,12 +72,7 @@ export class Users { url: '/rest/api/3/user', method: 'POST', data: { - applicationKeys: parameters.applicationKeys, - displayName: parameters.displayName, emailAddress: parameters.emailAddress, - key: parameters.key, - name: parameters.name, - password: parameters.password, self: parameters.self, }, }; @@ -140,10 +135,8 @@ export class Users { method: 'GET', params: { accountId: paramSerializer('accountId', parameters.accountId), - key: parameters.key, maxResults: parameters.maxResults, startAt: parameters.startAt, - username: parameters.username, }, }; @@ -227,7 +220,6 @@ export class Users { method: 'GET', params: { accountId: parameters?.accountId, - username: parameters?.username, }, }; @@ -407,8 +399,6 @@ export class Users { method: 'GET', params: { accountId: parameters.accountId, - key: parameters.key, - username: parameters.username, }, }; diff --git a/src/version3/workflowSchemeDrafts.ts b/src/version3/workflowSchemeDrafts.ts index b8367ea99f..9472a21faa 100644 --- a/src/version3/workflowSchemeDrafts.ts +++ b/src/version3/workflowSchemeDrafts.ts @@ -333,7 +333,7 @@ export class WorkflowSchemeDrafts { const config: RequestConfig = { url: `/rest/api/3/workflowscheme/${parameters.id}/draft/issuetype/${parameters.issueType}`, method: 'PUT', - data: parameters.body, + data: parameters.details, }; return this.client.sendRequest(config, callback); diff --git a/src/version3/workflowSchemeProjectAssociations.ts b/src/version3/workflowSchemeProjectAssociations.ts index d365b67591..8c1596f10f 100644 --- a/src/version3/workflowSchemeProjectAssociations.ts +++ b/src/version3/workflowSchemeProjectAssociations.ts @@ -52,34 +52,6 @@ export class WorkflowSchemeProjectAssociations { return this.client.sendRequest(config, callback); } - /** - * @deprecated Use 'assignSchemeToProject' Assigns a workflow scheme to a project. This operation is performed only - * when there are no issues in the project. Workflow schemes can only be assigned to classic projects. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async associateSchemeWithProject( - parameters: Parameters.AssociateSchemeWithProject | undefined, - callback: Callback, - ): Promise; - /** - * @deprecated Use 'assignSchemeToProject' Assigns a workflow scheme to a project. This operation is performed only - * when there are no issues in the project. Workflow schemes can only be assigned to classic projects. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async associateSchemeWithProject( - parameters?: Parameters.AssociateSchemeWithProject, - callback?: never, - ): Promise; - async associateSchemeWithProject( - parameters?: Parameters.AssociateSchemeWithProject, - callback?: Callback, - ): Promise { - // @ts-ignore - return this.assignSchemeToProject(parameters, callback); - } - /** * Assigns a workflow scheme to a project. This operation is performed only when there are no issues in the project. * diff --git a/src/version3/workflowSchemes.ts b/src/version3/workflowSchemes.ts index 0e53222f2b..d5d083cd1d 100644 --- a/src/version3/workflowSchemes.ts +++ b/src/version3/workflowSchemes.ts @@ -410,7 +410,7 @@ export class WorkflowSchemes { const config: RequestConfig = { url: `/rest/api/3/workflowscheme/${parameters.id}/issuetype/${parameters.issueType}`, method: 'PUT', - data: parameters.body, + data: parameters.details, }; return this.client.sendRequest(config, callback); diff --git a/src/version3/workflows.ts b/src/version3/workflows.ts index c84b16218f..d6785fe38c 100644 --- a/src/version3/workflows.ts +++ b/src/version3/workflows.ts @@ -8,43 +8,6 @@ import { RequestConfig } from '../requestConfig'; export class Workflows { constructor(private client: Client) {} - /** - * @deprecated Returns all workflows in Jira or a workflow. Deprecated, use [Get workflows - * paginated](#api-rest-api-3-workflow-search-get). If the `workflowName` parameter is specified, the workflow is - * returned as an object (not in an array). Otherwise, an array of workflow objects is returned. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async getAllWorkflows( - parameters: Parameters.GetAllWorkflows | undefined, - callback: Callback, - ): Promise; - /** - * @deprecated Returns all workflows in Jira or a workflow. Deprecated, use [Get workflows - * paginated](#api-rest-api-3-workflow-search-get). If the `workflowName` parameter is specified, the workflow is - * returned as an object (not in an array). Otherwise, an array of workflow objects is returned. - * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#permissions) required:** - * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg). - */ - async getAllWorkflows( - parameters?: Parameters.GetAllWorkflows, - callback?: never, - ): Promise; - async getAllWorkflows( - parameters?: Parameters.GetAllWorkflows, - callback?: Callback, - ): Promise { - const config: RequestConfig = { - url: '/rest/api/3/workflow', - method: 'GET', - params: { - workflowName: parameters?.workflowName, - }, - }; - - return this.client.sendRequest(config, callback); - } - /** * Creates a workflow. Workflow transitions are created with the default system transition rules. * diff --git a/tests/integration/agile/sprint.test.ts b/tests/integration/agile/sprint.test.ts index 617f7ecb33..f8e7185a5a 100644 --- a/tests/integration/agile/sprint.test.ts +++ b/tests/integration/agile/sprint.test.ts @@ -30,7 +30,7 @@ test.serial('should create new sprint', async t => { t.truthy(!!sprint); t.is(sprint.name, 'New sprint'); - t.is(sprint.state, AgileModels.Sprint.State.Future); + t.is(sprint.state, 'future'); }); test.serial('should create and move task to sprint', async t => { @@ -70,12 +70,12 @@ test.serial('should return issues for sprint', async t => { test.serial('should partially update sprint', async t => { const newSprint = await client.sprint.partiallyUpdateSprint({ sprintId: sprint.id, - state: AgileModels.Sprint.State.Active, + state: 'active', startDate: new Date(), endDate: new Date(Date.now() + 1000), }); - t.is(newSprint.state, AgileModels.Sprint.State.Active); + t.is(newSprint.state, 'active'); }); test.serial('should remove sprint', async t => { diff --git a/tests/integration/constants.ts b/tests/integration/constants.ts index 3f92b1f6ce..b870b3018a 100644 --- a/tests/integration/constants.ts +++ b/tests/integration/constants.ts @@ -1,11 +1,11 @@ -export namespace Constants { - export const testAgileProjectKey = 'TAP'; - export const testAgileProjectName = 'Test Agile Project'; +export const Constants = { + testAgileProjectKey: 'TAP', + testAgileProjectName: 'Test Agile Project', - export const testDashboardName = 'Automated dashboard name'; - export const testGroupName = 'Automated tests group name'; - export const testIssueDescription = 'Test description'; - export const testIssueSummary = 'Test issue summary'; - export const testProjectKey = 'AUTOTEST'; - export const testProjectName = 'Jira.js project for lib automatic1 tests'; -} + testDashboardName: 'Automated dashboard name', + testGroupName: 'Automated tests group name', + testIssueDescription: 'Test description', + testIssueSummary: 'Test issue summary', + testProjectKey: 'AUTOTEST', + testProjectName: 'Jira.js project for lib automatic tests', +}; diff --git a/tests/integration/utils/getClient.ts b/tests/integration/utils/getClient.ts index 2a2e832398..570c62f2c5 100644 --- a/tests/integration/utils/getClient.ts +++ b/tests/integration/utils/getClient.ts @@ -2,7 +2,6 @@ import { ClientType, Config, createClient } from '../../../src'; const config = { host: process.env.HOST!, - newErrorHandling: true, authentication: { basic: { email: process.env.EMAIL!, diff --git a/tests/integration/version2/avatars.test.ts b/tests/integration/version2/avatars.test.ts new file mode 100644 index 0000000000..6cecbfa04f --- /dev/null +++ b/tests/integration/version2/avatars.test.ts @@ -0,0 +1,22 @@ +import { Avatar } from '../../../src/version3/models'; +import { getVersion2Client } from '../utils'; +import test from 'ava'; + +const client = getVersion2Client(); + +let avatar: Avatar | undefined; + +test.serial('should get all system avatars', async t => { + const systemAvatars = await client.avatars.getAllSystemAvatars({ type: 'project' }); + + avatar = systemAvatars.system?.[0]; + + t.truthy(!!avatar); +}); + +test.serial('should return avatar image with contentType', async t => { + const avatarWithDetails = await client.avatars.getAvatarImageByID({ id: avatar!.id, type: 'project' }); + + t.is(avatarWithDetails.contentType, 'image/svg+xml'); + t.truthy(avatarWithDetails.avatar instanceof Uint8Array); +}); diff --git a/tests/integration/version2/issueComments.test.ts b/tests/integration/version2/issueComments.test.ts index 1d6cda2e90..59cc612f4a 100644 --- a/tests/integration/version2/issueComments.test.ts +++ b/tests/integration/version2/issueComments.test.ts @@ -31,7 +31,7 @@ test.serial('should update comment', async t => { const comment = await client.issueComments .addComment({ issueIdOrKey: issue.key, - body: 'this is a comment', + comment: 'this is a comment', }) .catch((error: AxiosError) => { console.error(error.response?.data ?? error); @@ -43,8 +43,8 @@ test.serial('should update comment', async t => { const updatedComment = await client.issueComments.updateComment({ issueIdOrKey: issue.key, - id: comment.id!, // TODO - body: 'updated comment', + id: comment.id, + comment: 'updated comment', }); t.truthy(!!updatedComment); diff --git a/tests/integration/version3/avatars.test.ts b/tests/integration/version3/avatars.test.ts new file mode 100644 index 0000000000..3a3b4b8101 --- /dev/null +++ b/tests/integration/version3/avatars.test.ts @@ -0,0 +1,22 @@ +import { Avatar } from '../../../src/version3/models'; +import { getVersion3Client } from '../utils'; +import test from 'ava'; + +const client = getVersion3Client(); + +let avatar: Avatar | undefined; + +test.serial('should get all system avatars', async t => { + const systemAvatars = await client.avatars.getAllSystemAvatars({ type: 'project' }); + + avatar = systemAvatars.system?.[0]; + + t.truthy(!!avatar); +}); + +test.serial('should return avatar image with contentType', async t => { + const avatarWithDetails = await client.avatars.getAvatarImageByID({ id: avatar!.id, type: 'project' }); + + t.is(avatarWithDetails.contentType, 'image/svg+xml'); + t.truthy(avatarWithDetails.avatar instanceof Uint8Array); +}); diff --git a/tests/integration/version3/issueComments.test.ts b/tests/integration/version3/issueComments.test.ts index 2e7bc1f053..d3c7c501ff 100644 --- a/tests/integration/version3/issueComments.test.ts +++ b/tests/integration/version3/issueComments.test.ts @@ -29,7 +29,7 @@ test.serial('should update comment', async t => { const comment = await client.issueComments.addComment({ issueIdOrKey: issue.key, - body: { + comment: { type: 'doc', version: 1, content: [ @@ -50,7 +50,7 @@ test.serial('should update comment', async t => { const updatedComment = await client.issueComments.updateComment({ issueIdOrKey: issue.key, - id: comment.id!, // TODO + id: comment.id, body: { type: 'doc', version: 1, diff --git a/tests/unit/agile/board.test.ts b/tests/unit/agile/board.test.ts index acb95e2c55..cfa08b55cc 100644 --- a/tests/unit/agile/board.test.ts +++ b/tests/unit/agile/board.test.ts @@ -2,7 +2,7 @@ import * as sinon from 'sinon'; import { AgileClient } from '../../../src'; import test from 'ava'; -const config = { host: 'http://localhost', newErrorHandling: true }; +const config = { host: 'http://localhost' }; test('getBoard should accept following parameters', t => { const client = new AgileClient(config); diff --git a/tests/unit/agile/issue.test.ts b/tests/unit/agile/issue.test.ts index 7ae34ee7fd..5f0a967f7a 100644 --- a/tests/unit/agile/issue.test.ts +++ b/tests/unit/agile/issue.test.ts @@ -3,7 +3,7 @@ import { AgileClient } from '../../../src'; import test from 'ava'; test('getIssue should accept follow parameters', t => { - const client = new AgileClient({ host: 'http://localhost', newErrorHandling: true }); + const client = new AgileClient({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); client.issue.getIssue({ issueIdOrKey: 'key' }); diff --git a/tests/unit/agile/sprint.test.ts b/tests/unit/agile/sprint.test.ts index 178eb78181..63c8251973 100644 --- a/tests/unit/agile/sprint.test.ts +++ b/tests/unit/agile/sprint.test.ts @@ -3,7 +3,7 @@ import { AgileClient } from '../../../src'; import test from 'ava'; test('moveIssuesToSprintAndRank should accept follow parameters', t => { - const client = new AgileClient({ host: 'http://localhost', newErrorHandling: true }); + const client = new AgileClient({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); client.sprint.moveIssuesToSprintAndRank({ diff --git a/tests/unit/clients/baseClient.test.ts b/tests/unit/clients/baseClient.test.ts index 45b80b11d5..0763a28a01 100644 --- a/tests/unit/clients/baseClient.test.ts +++ b/tests/unit/clients/baseClient.test.ts @@ -8,7 +8,6 @@ test('should create X-Atlassian-Token: no-check header in requests', t => { const client = new BaseClient({ host: 'http://localhost', noCheckAtlassianToken: true, - newErrorHandling: true, }); // @ts-ignore @@ -32,7 +31,6 @@ test('should not create X-Atlassian-Token: no-check header in requests case 1', const client = new BaseClient({ host: 'http://localhost', noCheckAtlassianToken: false, - newErrorHandling: true, }); // @ts-ignore @@ -55,7 +53,6 @@ test('should not create X-Atlassian-Token: no-check header in requests case 1', test('should create X-Atlassian-Token: no-check header in requests case 2', t => { const client = new BaseClient({ host: 'http://localhost', - newErrorHandling: true, }); // @ts-ignore diff --git a/tests/unit/createClient.test.ts b/tests/unit/createClient.test.ts index 59df14e1ed..320c1cfe87 100644 --- a/tests/unit/createClient.test.ts +++ b/tests/unit/createClient.test.ts @@ -1,7 +1,7 @@ import test from 'ava'; import { AgileClient, BaseClient, ClientType, createClient, Version2Client, Version3Client } from '../../src'; -const defaultConfig = { host: 'http://localhost', newErrorHandling: true }; +const defaultConfig = { host: 'http://localhost' }; test('should create Agile client', t => { const client = createClient(ClientType.Agile, defaultConfig); diff --git a/tests/unit/services/authenticationService.test.ts b/tests/unit/services/authenticationService.test.ts index 4aa5d92cd1..99d42f47c5 100644 --- a/tests/unit/services/authenticationService.test.ts +++ b/tests/unit/services/authenticationService.test.ts @@ -1,13 +1,11 @@ -import * as sinon from 'sinon'; -import { AuthenticationService } from '../../../src/services/authenticationService'; import { Config } from '../../../src'; -import { OAuth } from 'oauth'; +import { getAuthenticationToken } from '../../../src/services/authenticationService'; import test from 'ava'; test('should return undefined when authentication does not used', async t => { const authentication = undefined; - const token = await AuthenticationService.getAuthenticationToken(authentication); + const token = await getAuthenticationToken(authentication); t.is(token, undefined); }); @@ -20,7 +18,7 @@ test('should return Basic authentication token for password case', async t => { }, }; - const token = await AuthenticationService.getAuthenticationToken(authentication); + const token = await getAuthenticationToken(authentication); t.is(token, 'Basic dGVzdF91c2VybmFtZTp0ZXN0X3Bhc3N3b3Jk'); }); @@ -33,65 +31,17 @@ test('should return Basic authentication token for apiToken case', async t => { }, }; - const token = await AuthenticationService.getAuthenticationToken(authentication); + const token = await getAuthenticationToken(authentication); t.is(token, 'Basic dGVzdF9lbWFpbEB0ZXN0LnF3ZTp0ZXN0X2FwaVRva2Vu'); }); -// Valid RSA keypair used to test RSA-SHA1 signature method -const RsaPrivateKey = - '-----BEGIN RSA PRIVATE KEY-----\n' + - 'MIICXQIBAAKBgQDizE4gQP5nPQhzof/Vp2U2DDY3UY/Gxha2CwKW0URe7McxtnmE\n' + - 'CrZnT1n/YtfrrCNxY5KMP4o8hMrxsYEe05+1ZGFT68ztms3puUxilU5E3BQMhz1t\n' + - 'JMJEGcTt8nZUlM4utli7fHgDtWbhvqvYjRMGn3AjyLOfY8XZvnFkGjipvQIDAQAB\n' + - 'AoGAKgk6FcpWHOZ4EY6eL4iGPt1Gkzw/zNTcUsN5qGCDLqDuTq2Gmk2t/zn68VXt\n' + - 'tVXDf/m3qN0CDzOBtghzaTZKLGhnSewQ98obMWgPcvAsb4adEEeW1/xigbMiaW2X\n' + - 'cu6GhZxY16edbuQ40LRrPoVK94nXQpj8p7w4IQ301Sm8PSECQQD1ZlOj4ugvfhEt\n' + - 'exi4WyAaM45fylmN290UXYqZ8SYPI/VliDytIlMfyq5Rv+l+dud1XDPrWOQ0ImgV\n' + - 'HJn7uvoZAkEA7JhHNmHF9dbdF9Koj86K2Cl6c8KUu7U7d2BAuB6pPkt8+D8+y4St\n' + - 'PaCmN4oP4X+sf5rqBYoXywHlqEei2BdpRQJBAMYgR4cZu7wcXGIL8HlnmROObHSK\n' + - 'OqN9z5CRtUV0nPW8YnQG+nYOMG6KhRMbjri750OpnYF100kEPmRNI0VKQIECQE8R\n' + - 'fQsRleTYz768ahTVQ9WF1ySErMwmfx8gDcD6jjkBZVxZVpURXAwyehopi7Eix/VF\n' + - 'QlxjkBwKIEQi3Ks297kCQQCL9by1bueKDMJO2YX1Brm767pkDKkWtGfPS+d3xMtC\n' + - 'KJHHCqrS1V+D5Q89x5wIRHKxE5UMTc0JNa554OxwFORX\n' + - '-----END RSA PRIVATE KEY-----'; - -const RsaPublicKey = - '-----BEGIN PUBLIC KEY-----\n' + - 'MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDizE4gQP5nPQhzof/Vp2U2DDY3\n' + - 'UY/Gxha2CwKW0URe7McxtnmECrZnT1n/YtfrrCNxY5KMP4o8hMrxsYEe05+1ZGFT\n' + - '68ztms3puUxilU5E3BQMhz1tJMJEGcTt8nZUlM4utli7fHgDtWbhvqvYjRMGn3Aj\n' + - 'yLOfY8XZvnFkGjipvQIDAQAB\n' + - '-----END PUBLIC KEY-----'; - -test('OAuth 1.0 authentication', async t => { - const authentication: Config.Authentication = { - oauth: { - accessToken: 'accessToken', - tokenSecret: 'tokenSecret', - consumerKey: RsaPublicKey, - consumerSecret: RsaPrivateKey, - }, - }; - - const stub = sinon.stub(OAuth.prototype, 'authHeader'); - - await AuthenticationService.getAuthenticationToken(authentication, { - baseURL: 'http://localhost', - method: 'POST', - url: '/rest/agile/1.0/board', - }); - - t.truthy(stub.calledOnce); - stub.restore(); -}); - test('should generate Bearer Header correctly for Personal Access Token', async t => { const authentication: Config.Authentication = { personalAccessToken: 'secretPAT', }; - const token = await AuthenticationService.getAuthenticationToken(authentication); + const token = await getAuthenticationToken(authentication); t.is(token, 'Bearer secretPAT'); }); diff --git a/tests/unit/version2/appMigration.test.ts b/tests/unit/version2/appMigration.test.ts index ed58a78a6b..65642c0134 100644 --- a/tests/unit/version2/appMigration.test.ts +++ b/tests/unit/version2/appMigration.test.ts @@ -8,28 +8,7 @@ const entity = { value: 'v', }; -const config = { host: 'http://localhost', newErrorHandling: true }; - -test('updateEntityPropertiesValue should accept deprecated parameters', t => { - const client = new Version2Client(config); - const sendRequestStub = sinon.stub(client, 'sendRequest'); - - client.appMigration.updateEntityPropertiesValue({ - entityType: '1', - transferId: '2', - accountId: '3', - body: [entity], - }); - - const callArgument = sendRequestStub.getCall(0).args[0]; - - t.truthy(sendRequestStub.calledOnce); - t.truthy(callArgument.url!.endsWith('1')); - t.is(callArgument.headers!['Atlassian-Transfer-Id'], '2'); - t.is(callArgument.headers!['Atlassian-Account-Id'], '3'); - t.is(callArgument.headers!['Content-Type'], 'application/json'); - t.deepEqual(callArgument.data, [entity]); -}); +const config = { host: 'http://localhost' }; test('updateEntityPropertiesValue should accept actual parameters', t => { const client = new Version2Client(config); diff --git a/tests/unit/version2/issueComments.test.ts b/tests/unit/version2/issueComments.test.ts index 6676d871cb..e28b01f5be 100644 --- a/tests/unit/version2/issueComments.test.ts +++ b/tests/unit/version2/issueComments.test.ts @@ -2,14 +2,14 @@ import * as sinon from 'sinon'; import test from 'ava'; import { IssueComments, Version2Client } from '../../../src/version2'; -const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true }); +const client = new Version2Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); const issueComments = new IssueComments(client); test('addComment should accept follow parameters', t => { issueComments.addComment({ issueIdOrKey: 'key', - body: 'test comment', + comment: 'test comment', }); t.truthy(sendRequestStub.calledOnce); diff --git a/tests/unit/version2/issueFields.test.ts b/tests/unit/version2/issueFields.test.ts index 963bcaffc6..9d3b264cc0 100644 --- a/tests/unit/version2/issueFields.test.ts +++ b/tests/unit/version2/issueFields.test.ts @@ -3,7 +3,7 @@ import test from 'ava'; import { Version2Client } from '../../../src'; test('getFields should calls without parameters', t => { - const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true }); + const client = new Version2Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); client.issueFields.getFields(); diff --git a/tests/unit/version2/issueLinks.test.ts b/tests/unit/version2/issueLinks.test.ts index 57b1210b29..949a1b6e53 100644 --- a/tests/unit/version2/issueLinks.test.ts +++ b/tests/unit/version2/issueLinks.test.ts @@ -2,15 +2,15 @@ import * as sinon from 'sinon'; import test from 'ava'; import { IssueLinks, Version2Client } from '../../../src/version2'; -const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true }); +const client = new Version2Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); let issueLinks = new IssueLinks(client); test('linkIssues should calls without parameters', t => { issueLinks.linkIssues({ - type: undefined, - inwardIssue: undefined, - outwardIssue: undefined, + type: {}, + inwardIssue: {}, + outwardIssue: {}, }); t.truthy(sendRequestStub.calledOnce); @@ -19,8 +19,8 @@ test('linkIssues should calls without parameters', t => { t.deepEqual(callArgument.data, { comment: undefined, - inwardIssue: undefined, - outwardIssue: undefined, - type: undefined, + inwardIssue: {}, + outwardIssue: {}, + type: {}, }); }); diff --git a/tests/unit/version2/issuePriorities.test.ts b/tests/unit/version2/issuePriorities.test.ts index e22f8c6347..6322b75de2 100644 --- a/tests/unit/version2/issuePriorities.test.ts +++ b/tests/unit/version2/issuePriorities.test.ts @@ -2,7 +2,7 @@ import * as sinon from 'sinon'; import test from 'ava'; import { IssuePriorities, Version2Client } from '../../../src/version2'; -const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true }); +const client = new Version2Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); const issuePriorities = new IssuePriorities(client); diff --git a/tests/unit/version2/issueRemoteLinks.test.ts b/tests/unit/version2/issueRemoteLinks.test.ts index 8d4e2328a6..8111d8e81e 100644 --- a/tests/unit/version2/issueRemoteLinks.test.ts +++ b/tests/unit/version2/issueRemoteLinks.test.ts @@ -2,7 +2,7 @@ import * as sinon from 'sinon'; import test from 'ava'; import { IssueRemoteLinks, Version2Client } from '../../../src/version2'; -const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true }); +const client = new Version2Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); const issueRemoteLinks = new IssueRemoteLinks(client); diff --git a/tests/unit/version2/issueResolutions.test.ts b/tests/unit/version2/issueResolutions.test.ts deleted file mode 100644 index 6fc99770a1..0000000000 --- a/tests/unit/version2/issueResolutions.test.ts +++ /dev/null @@ -1,13 +0,0 @@ -import * as sinon from 'sinon'; -import test from 'ava'; -import { IssueResolutions, Version2Client } from '../../../src/version2'; - -const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true }); -const sendRequestStub = sinon.stub(client, 'sendRequest'); -let issueResolutions = new IssueResolutions(client); - -test('getResolutions should calls without parameters', t => { - issueResolutions.getResolutions(); - - t.truthy(sendRequestStub.calledOnce); -}); diff --git a/tests/unit/version2/issueSearch.test.ts b/tests/unit/version2/issueSearch.test.ts index 3559e9bf57..4b85503a53 100644 --- a/tests/unit/version2/issueSearch.test.ts +++ b/tests/unit/version2/issueSearch.test.ts @@ -2,7 +2,7 @@ import * as sinon from 'sinon'; import test from 'ava'; import { IssueSearch, Version2Client } from '../../../src/version2'; -const config = { host: 'http://localhost', newErrorHandling: true }; +const config = { host: 'http://localhost' }; test('should be defined', t => { t.truthy(!!IssueSearch); diff --git a/tests/unit/version2/issueVotes.test.ts b/tests/unit/version2/issueVotes.test.ts index 588b28df3f..b7c1110e2b 100644 --- a/tests/unit/version2/issueVotes.test.ts +++ b/tests/unit/version2/issueVotes.test.ts @@ -3,7 +3,7 @@ import { IssueVotes } from '../../../src/version2'; import test from 'ava'; import { Version2Client } from '../../../src'; -const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true }); +const client = new Version2Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); const issueVote = new IssueVotes(client); diff --git a/tests/unit/version2/issueWatcher.test.ts b/tests/unit/version2/issueWatcher.test.ts index a67d9982cb..a6111c524e 100644 --- a/tests/unit/version2/issueWatcher.test.ts +++ b/tests/unit/version2/issueWatcher.test.ts @@ -3,7 +3,7 @@ import test from 'ava'; import { Version2Client } from '../../../src'; test('addWatcher should accept accountId', t => { - const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true }); + const client = new Version2Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); client.issueWatchers.addWatcher({ issueIdOrKey: '', accountId: '101010' }); diff --git a/tests/unit/version2/issues.test.ts b/tests/unit/version2/issues.test.ts index cdd4d4eb4c..1c6d075351 100644 --- a/tests/unit/version2/issues.test.ts +++ b/tests/unit/version2/issues.test.ts @@ -2,7 +2,7 @@ import * as sinon from 'sinon'; import test from 'ava'; import { Version2Client } from '../../../src'; -const config = { host: 'http://localhost', newErrorHandling: true }; +const config = { host: 'http://localhost' }; test('createIssue should accept follow parameters', t => { const client = new Version2Client(config); diff --git a/tests/unit/version2/myself.test.ts b/tests/unit/version2/myself.test.ts index fcb8f649d8..127796600a 100644 --- a/tests/unit/version2/myself.test.ts +++ b/tests/unit/version2/myself.test.ts @@ -2,7 +2,7 @@ import * as sinon from 'sinon'; import test from 'ava'; import { Myself, Version2Client } from '../../../src/version2'; -const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true }); +const client = new Version2Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); const myself = new Myself(client); diff --git a/tests/unit/version2/projectVersions.test.ts b/tests/unit/version2/projectVersions.test.ts index 8a12c72b8f..fe897d41ed 100644 --- a/tests/unit/version2/projectVersions.test.ts +++ b/tests/unit/version2/projectVersions.test.ts @@ -2,7 +2,7 @@ import * as sinon from 'sinon'; import test from 'ava'; import { ProjectVersions, Version2Client } from '../../../src/version2'; -const config = { host: 'http://localhost', newErrorHandling: true }; +const config = { host: 'http://localhost' }; test('should be defined', t => { t.truthy(!!ProjectVersions); @@ -64,7 +64,7 @@ test('createVersion should accept follow parameters', t => { const sendRequestStub = sinon.stub(client, 'sendRequest'); client.projectVersions.createVersion({ - project: 'testProject', + projectId: 1455, name: 'testName', }); @@ -82,8 +82,7 @@ test('createVersion should accept follow parameters', t => { name: 'testName', operations: undefined, overdue: undefined, - project: 'testProject', - projectId: undefined, + projectId: 1455, releaseDate: undefined, released: undefined, self: undefined, @@ -92,16 +91,3 @@ test('createVersion should accept follow parameters', t => { userStartDate: undefined, }); }); - -test('deleteVersion should accept follow parameters', t => { - const client = new Version2Client(config); - const sendRequestStub = sinon.stub(client, 'sendRequest'); - - client.projectVersions.deleteVersion({ id: 'versionId' }); - - t.truthy(sendRequestStub.calledOnce); - - const callArgument = sendRequestStub.getCall(0).args[0]; - - t.is(callArgument.url, '/rest/api/2/version/versionId'); -}); diff --git a/tests/unit/version2/projects.test.ts b/tests/unit/version2/projects.test.ts deleted file mode 100644 index e471e1e53e..0000000000 --- a/tests/unit/version2/projects.test.ts +++ /dev/null @@ -1,23 +0,0 @@ -import * as sinon from 'sinon'; -import { Projects } from '../../../src/version2'; -import test from 'ava'; -import { Version2Client } from '../../../src'; - -const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true }); -const sendRequestStub = sinon.stub(client, 'sendRequest'); - -test('getAllProjects should calls without parameters', t => { - const projects = new Projects(client); - - projects.getAllProjects(); - - t.truthy(sendRequestStub.calledOnce); - - const callArgument = sendRequestStub.getCall(0).args[0]; - - t.deepEqual(callArgument.params, { - expand: undefined, - properties: undefined, - recent: undefined, - }); -}); diff --git a/tests/unit/version2/workflowStatuses.test.ts b/tests/unit/version2/workflowStatuses.test.ts index eb7511930e..12a14299a3 100644 --- a/tests/unit/version2/workflowStatuses.test.ts +++ b/tests/unit/version2/workflowStatuses.test.ts @@ -2,7 +2,7 @@ import * as sinon from 'sinon'; import test from 'ava'; import { Version2Client, WorkflowStatuses } from '../../../src/version2'; -const client = new Version2Client({ host: 'http://localhost', newErrorHandling: true }); +const client = new Version2Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); const workflowStatuses = new WorkflowStatuses(client); diff --git a/tests/unit/version3/appMigration.test.ts b/tests/unit/version3/appMigration.test.ts index 4a7128f809..0d3a860ec6 100644 --- a/tests/unit/version3/appMigration.test.ts +++ b/tests/unit/version3/appMigration.test.ts @@ -10,30 +10,8 @@ const entity = { const config = { host: 'http://localhost', - newErrorHandling: true, }; -test('updateEntityPropertiesValue should accept deprecated parameters', t => { - const client = new Version3Client(config); - const sendRequestStub = sinon.stub(client, 'sendRequest'); - - client.appMigration.updateEntityPropertiesValue({ - entityType: '1', - transferId: '2', - accountId: '3', - body: [entity], - }); - - const callArgument = sendRequestStub.getCall(0).args[0]; - - t.truthy(sendRequestStub.calledOnce); - t.truthy(callArgument.url!.endsWith('1')); - t.is(callArgument.headers!['Atlassian-Transfer-Id'], '2'); - t.is(callArgument.headers!['Atlassian-Account-Id'], '3'); - t.is(callArgument.headers!['Content-Type'], 'application/json'); - t.deepEqual(callArgument.data, [entity]); -}); - test('updateEntityPropertiesValue should accept actual parameters', t => { const client = new Version3Client(config); const sendRequestStub = sinon.stub(client, 'sendRequest'); diff --git a/tests/unit/version3/issueComments.test.ts b/tests/unit/version3/issueComments.test.ts index e0996dbbc3..d8d9b2440a 100644 --- a/tests/unit/version3/issueComments.test.ts +++ b/tests/unit/version3/issueComments.test.ts @@ -3,12 +3,12 @@ import test from 'ava'; import { Version3Client } from '../../../src'; test('addComment should accept follow parameters', t => { - const client = new Version3Client({ host: 'http://localhost', newErrorHandling: true }); + const client = new Version3Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); client.issueComments.addComment({ issueIdOrKey: 'key', - body: { + comment: { type: 'doc', version: 1, text: 'Comment', @@ -43,13 +43,12 @@ test('addComment should accept follow parameters', t => { test('addComment should accept body string and convert to simple Document', t => { const client = new Version3Client({ host: 'http://localhost', - newErrorHandling: true, }); const sendRequestStub = sinon.stub(client, 'sendRequest'); client.issueComments.addComment({ issueIdOrKey: 'key', - body: 'Comment', + comment: 'Comment', }); t.truthy(sendRequestStub.calledOnce); diff --git a/tests/unit/version3/issueFields.test.ts b/tests/unit/version3/issueFields.test.ts index 641a0383ff..40bbff28bd 100644 --- a/tests/unit/version3/issueFields.test.ts +++ b/tests/unit/version3/issueFields.test.ts @@ -3,7 +3,7 @@ import test from 'ava'; import { Version3Client } from '../../../src'; test('getFields should calls without parameters', t => { - const client = new Version3Client({ host: 'http://localhost', newErrorHandling: true }); + const client = new Version3Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); client.issueFields.getFields(); diff --git a/tests/unit/version3/issueLinks.test.ts b/tests/unit/version3/issueLinks.test.ts index df5bb35a02..0da9540a19 100644 --- a/tests/unit/version3/issueLinks.test.ts +++ b/tests/unit/version3/issueLinks.test.ts @@ -3,7 +3,7 @@ import test from 'ava'; import { Version3Client } from '../../../src'; test('linkIssues should calls without parameters', t => { - const client = new Version3Client({ host: 'http://localhost', newErrorHandling: true }); + const client = new Version3Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); client.issueLinks.linkIssues(); diff --git a/tests/unit/version3/issuePriorities.test.ts b/tests/unit/version3/issuePriorities.test.ts index 68ec2d2c90..96d4f72461 100644 --- a/tests/unit/version3/issuePriorities.test.ts +++ b/tests/unit/version3/issuePriorities.test.ts @@ -2,7 +2,7 @@ import * as sinon from 'sinon'; import test from 'ava'; import { IssuePriorities, Version3Client } from '../../../src/version3'; -const client = new Version3Client({ host: 'http://localhost', newErrorHandling: true }); +const client = new Version3Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); const issuePriorities = new IssuePriorities(client); diff --git a/tests/unit/version3/issueRemoteLinks.test.ts b/tests/unit/version3/issueRemoteLinks.test.ts index 567d9f4295..98c22fe563 100644 --- a/tests/unit/version3/issueRemoteLinks.test.ts +++ b/tests/unit/version3/issueRemoteLinks.test.ts @@ -2,7 +2,7 @@ import * as sinon from 'sinon'; import test from 'ava'; import { IssueRemoteLinks, Version3Client } from '../../../src/version3'; -const client = new Version3Client({ host: 'http://localhost', newErrorHandling: true }); +const client = new Version3Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); const issueRemoteLinks = new IssueRemoteLinks(client); diff --git a/tests/unit/version3/issueResolutions.test.ts b/tests/unit/version3/issueResolutions.test.ts deleted file mode 100644 index fee754067f..0000000000 --- a/tests/unit/version3/issueResolutions.test.ts +++ /dev/null @@ -1,13 +0,0 @@ -import * as sinon from 'sinon'; -import test from 'ava'; -import { IssueResolutions, Version3Client } from '../../../src/version3'; - -const client = new Version3Client({ host: 'http://localhost', newErrorHandling: true }); -const sendRequestStub = sinon.stub(client, 'sendRequest'); -const issueResolutions = new IssueResolutions(client); - -test('getResolutions should calls without parameters', t => { - issueResolutions.getResolutions(); - - t.truthy(sendRequestStub.calledOnce); -}); diff --git a/tests/unit/version3/issueSearch.test.ts b/tests/unit/version3/issueSearch.test.ts index ee2397b48d..8cbd794724 100644 --- a/tests/unit/version3/issueSearch.test.ts +++ b/tests/unit/version3/issueSearch.test.ts @@ -2,7 +2,7 @@ import * as sinon from 'sinon'; import test from 'ava'; import { IssueSearch, Version3Client } from '../../../src/version3'; -const config = { host: 'http://localhost', newErrorHandling: true }; +const config = { host: 'http://localhost' }; test('should be defined', t => { t.truthy(!!IssueSearch); diff --git a/tests/unit/version3/issueVotes.test.ts b/tests/unit/version3/issueVotes.test.ts index d87b01e1dd..63af1dd9a6 100644 --- a/tests/unit/version3/issueVotes.test.ts +++ b/tests/unit/version3/issueVotes.test.ts @@ -3,7 +3,7 @@ import { IssueVotes } from '../../../src/version3'; import test from 'ava'; import { Version3Client } from '../../../src'; -const client = new Version3Client({ host: 'http://localhost', newErrorHandling: true }); +const client = new Version3Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); const issueVote = new IssueVotes(client); diff --git a/tests/unit/version3/issueWatcher.test.ts b/tests/unit/version3/issueWatcher.test.ts index ef3d1197e5..3dec7113c2 100644 --- a/tests/unit/version3/issueWatcher.test.ts +++ b/tests/unit/version3/issueWatcher.test.ts @@ -3,7 +3,7 @@ import test from 'ava'; import { Version3Client } from '../../../src'; test('addWatcher should accept accountId', t => { - const client = new Version3Client({ host: 'http://localhost', newErrorHandling: true }); + const client = new Version3Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); client.issueWatchers.addWatcher({ issueIdOrKey: '', accountId: '101010' }); diff --git a/tests/unit/version3/issues.test.ts b/tests/unit/version3/issues.test.ts index ffb9341faa..1852d8c871 100644 --- a/tests/unit/version3/issues.test.ts +++ b/tests/unit/version3/issues.test.ts @@ -2,7 +2,7 @@ import * as sinon from 'sinon'; import test from 'ava'; import { Version3Client } from '../../../src'; -const config = { host: 'http://localhost', newErrorHandling: true }; +const config = { host: 'http://localhost' }; test('createIssue should accept follow parameters', t => { const client = new Version3Client(config); diff --git a/tests/unit/version3/myself.test.ts b/tests/unit/version3/myself.test.ts index f8bee8b509..fefe00df19 100644 --- a/tests/unit/version3/myself.test.ts +++ b/tests/unit/version3/myself.test.ts @@ -2,7 +2,7 @@ import * as sinon from 'sinon'; import test from 'ava'; import { Myself, Version3Client } from '../../../src/version3'; -const client = new Version3Client({ host: 'http://localhost', newErrorHandling: true }); +const client = new Version3Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); const myself = new Myself(client); diff --git a/tests/unit/version3/projectVersions.test.ts b/tests/unit/version3/projectVersions.test.ts index 7df1512b3c..b74cde6022 100644 --- a/tests/unit/version3/projectVersions.test.ts +++ b/tests/unit/version3/projectVersions.test.ts @@ -2,7 +2,7 @@ import * as sinon from 'sinon'; import test from 'ava'; import { ProjectVersions, Version3Client } from '../../../src/version3'; -const config = { host: 'http://localhost', newErrorHandling: true }; +const config = { host: 'http://localhost' }; test('should be defined', t => { t.truthy(!!ProjectVersions); @@ -66,7 +66,7 @@ test('createVersion should accept follow parameters', t => { const sendRequestStub = sinon.stub(client, 'sendRequest'); client.projectVersions.createVersion({ - project: 'testProject', + projectId: 1455, name: 'testName', }); @@ -84,8 +84,7 @@ test('createVersion should accept follow parameters', t => { name: 'testName', operations: undefined, overdue: undefined, - project: 'testProject', - projectId: undefined, + projectId: 1455, releaseDate: undefined, released: undefined, self: undefined, @@ -94,16 +93,3 @@ test('createVersion should accept follow parameters', t => { userStartDate: undefined, }); }); - -test('deleteVersion should accept follow parameters', t => { - const client = new Version3Client(config); - const sendRequestStub = sinon.stub(client, 'sendRequest'); - - client.projectVersions.deleteVersion({ id: 'versionId' }); - - t.truthy(sendRequestStub.calledOnce); - - const callArgument = sendRequestStub.getCall(0).args[0]; - - t.is(callArgument.url, '/rest/api/3/version/versionId'); -}); diff --git a/tests/unit/version3/projects.test.ts b/tests/unit/version3/projects.test.ts deleted file mode 100644 index cf248fccdd..0000000000 --- a/tests/unit/version3/projects.test.ts +++ /dev/null @@ -1,23 +0,0 @@ -import * as sinon from 'sinon'; -import { Projects } from '../../../src/version3'; -import test from 'ava'; -import { Version3Client } from '../../../src'; - -const client = new Version3Client({ host: 'http://localhost', newErrorHandling: true }); -const sendRequestStub = sinon.stub(client, 'sendRequest'); - -test('getAllProjects should calls without parameters', t => { - const projects = new Projects(client); - - projects.getAllProjects(); - - t.truthy(sendRequestStub.calledOnce); - - const callArgument = sendRequestStub.getCall(0).args[0]; - - t.deepEqual(callArgument.params, { - expand: undefined, - properties: undefined, - recent: undefined, - }); -}); diff --git a/tests/unit/version3/workflowStatuses.test.ts b/tests/unit/version3/workflowStatuses.test.ts index 7781c1a830..3e9a8ea727 100644 --- a/tests/unit/version3/workflowStatuses.test.ts +++ b/tests/unit/version3/workflowStatuses.test.ts @@ -2,7 +2,7 @@ import * as sinon from 'sinon'; import test from 'ava'; import { Version3Client, WorkflowStatuses } from '../../../src/version3'; -const client = new Version3Client({ host: 'http://localhost', newErrorHandling: true }); +const client = new Version3Client({ host: 'http://localhost' }); const sendRequestStub = sinon.stub(client, 'sendRequest'); const workflowStatuses = new WorkflowStatuses(client); diff --git a/tsconfig.lint.json b/tsconfig.lint.json index 4ff5a42bc7..b957adc7dc 100644 --- a/tsconfig.lint.json +++ b/tsconfig.lint.json @@ -1,6 +1,7 @@ { "extends": "./tsconfig.json", "include": [ + "examples", "src", "tests" ]