@resolution/jira-api-client 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintrc.js +3 -0
- package/CHANGELOG.md +11 -0
- package/LICENSE.md +19 -0
- package/README.md +12 -0
- package/config/api-typescript-generator.config.ts +91 -0
- package/config/compare-schemas.ts +307 -0
- package/lib/index.d.ts +15 -0
- package/lib/index.js +25 -0
- package/lib/index.js.map +1 -0
- package/lib/openapi/platform/base-jira-platform-api-client.d.ts +868 -0
- package/lib/openapi/platform/base-jira-platform-api-client.js +808 -0
- package/lib/openapi/platform/base-jira-platform-api-client.js.map +1 -0
- package/lib/openapi/platform/core/common-http-client.d.ts +196 -0
- package/lib/openapi/platform/core/common-http-client.js +390 -0
- package/lib/openapi/platform/core/common-http-client.js.map +1 -0
- package/lib/openapi/platform/core/common-http-service.d.ts +7 -0
- package/lib/openapi/platform/core/common-http-service.js +20 -0
- package/lib/openapi/platform/core/common-http-service.js.map +1 -0
- package/lib/openapi/platform/core/common-validation-schema-storage.d.ts +35 -0
- package/lib/openapi/platform/core/common-validation-schema-storage.js +65 -0
- package/lib/openapi/platform/core/common-validation-schema-storage.js.map +1 -0
- package/lib/openapi/platform/models/announcement-banner.d.ts +27 -0
- package/lib/openapi/platform/models/announcement-banner.js +30 -0
- package/lib/openapi/platform/models/announcement-banner.js.map +1 -0
- package/lib/openapi/platform/models/app-data-policies.d.ts +31 -0
- package/lib/openapi/platform/models/app-data-policies.js +40 -0
- package/lib/openapi/platform/models/app-data-policies.js.map +1 -0
- package/lib/openapi/platform/models/app-migration.d.ts +86 -0
- package/lib/openapi/platform/models/app-migration.js +67 -0
- package/lib/openapi/platform/models/app-migration.js.map +1 -0
- package/lib/openapi/platform/models/app-properties.d.ts +15 -0
- package/lib/openapi/platform/models/app-properties.js +18 -0
- package/lib/openapi/platform/models/app-properties.js.map +1 -0
- package/lib/openapi/platform/models/audit-records.d.ts +70 -0
- package/lib/openapi/platform/models/audit-records.js +62 -0
- package/lib/openapi/platform/models/audit-records.js.map +1 -0
- package/lib/openapi/platform/models/avatars.d.ts +18 -0
- package/lib/openapi/platform/models/avatars.js +27 -0
- package/lib/openapi/platform/models/avatars.js.map +1 -0
- package/lib/openapi/platform/models/classification-levels.d.ts +25 -0
- package/lib/openapi/platform/models/classification-levels.js +31 -0
- package/lib/openapi/platform/models/classification-levels.js.map +1 -0
- package/lib/openapi/platform/models/common.d.ts +1490 -0
- package/lib/openapi/platform/models/common.js +937 -0
- package/lib/openapi/platform/models/common.js.map +1 -0
- package/lib/openapi/platform/models/dashboards.d.ts +414 -0
- package/lib/openapi/platform/models/dashboards.js +325 -0
- package/lib/openapi/platform/models/dashboards.js.map +1 -0
- package/lib/openapi/platform/models/dynamic-modules.d.ts +92 -0
- package/lib/openapi/platform/models/dynamic-modules.js +24 -0
- package/lib/openapi/platform/models/dynamic-modules.js.map +1 -0
- package/lib/openapi/platform/models/filter-sharing.d.ts +59 -0
- package/lib/openapi/platform/models/filter-sharing.js +36 -0
- package/lib/openapi/platform/models/filter-sharing.js.map +1 -0
- package/lib/openapi/platform/models/filters.d.ts +183 -0
- package/lib/openapi/platform/models/filters.js +115 -0
- package/lib/openapi/platform/models/filters.js.map +1 -0
- package/lib/openapi/platform/models/group-and-user-picker.d.ts +49 -0
- package/lib/openapi/platform/models/group-and-user-picker.js +31 -0
- package/lib/openapi/platform/models/group-and-user-picker.js.map +1 -0
- package/lib/openapi/platform/models/groups.d.ts +127 -0
- package/lib/openapi/platform/models/groups.js +98 -0
- package/lib/openapi/platform/models/groups.js.map +1 -0
- package/lib/openapi/platform/models/issue-attachments.d.ts +124 -0
- package/lib/openapi/platform/models/issue-attachments.js +129 -0
- package/lib/openapi/platform/models/issue-attachments.js.map +1 -0
- package/lib/openapi/platform/models/issue-comment-properties.d.ts +10 -0
- package/lib/openapi/platform/models/issue-comment-properties.js +18 -0
- package/lib/openapi/platform/models/issue-comment-properties.js.map +1 -0
- package/lib/openapi/platform/models/issue-comments.d.ts +36 -0
- package/lib/openapi/platform/models/issue-comments.js +49 -0
- package/lib/openapi/platform/models/issue-comments.js.map +1 -0
- package/lib/openapi/platform/models/issue-custom-field-configuration-apps.d.ts +36 -0
- package/lib/openapi/platform/models/issue-custom-field-configuration-apps.js +53 -0
- package/lib/openapi/platform/models/issue-custom-field-configuration-apps.js.map +1 -0
- package/lib/openapi/platform/models/issue-custom-field-contexts.d.ts +417 -0
- package/lib/openapi/platform/models/issue-custom-field-contexts.js +458 -0
- package/lib/openapi/platform/models/issue-custom-field-contexts.js.map +1 -0
- package/lib/openapi/platform/models/issue-custom-field-options-apps.d.ts +119 -0
- package/lib/openapi/platform/models/issue-custom-field-options-apps.js +133 -0
- package/lib/openapi/platform/models/issue-custom-field-options-apps.js.map +1 -0
- package/lib/openapi/platform/models/issue-custom-field-options.d.ts +136 -0
- package/lib/openapi/platform/models/issue-custom-field-options.js +115 -0
- package/lib/openapi/platform/models/issue-custom-field-options.js.map +1 -0
- package/lib/openapi/platform/models/issue-custom-field-values-apps.d.ts +66 -0
- package/lib/openapi/platform/models/issue-custom-field-values-apps.js +42 -0
- package/lib/openapi/platform/models/issue-custom-field-values-apps.js.map +1 -0
- package/lib/openapi/platform/models/issue-field-configurations.d.ts +194 -0
- package/lib/openapi/platform/models/issue-field-configurations.js +182 -0
- package/lib/openapi/platform/models/issue-field-configurations.js.map +1 -0
- package/lib/openapi/platform/models/issue-fields.d.ts +227 -0
- package/lib/openapi/platform/models/issue-fields.js +119 -0
- package/lib/openapi/platform/models/issue-fields.js.map +1 -0
- package/lib/openapi/platform/models/issue-link-types.d.ts +9 -0
- package/lib/openapi/platform/models/issue-link-types.js +21 -0
- package/lib/openapi/platform/models/issue-link-types.js.map +1 -0
- package/lib/openapi/platform/models/issue-links.d.ts +90 -0
- package/lib/openapi/platform/models/issue-links.js +74 -0
- package/lib/openapi/platform/models/issue-links.js.map +1 -0
- package/lib/openapi/platform/models/issue-notification-schemes.d.ts +158 -0
- package/lib/openapi/platform/models/issue-notification-schemes.js +147 -0
- package/lib/openapi/platform/models/issue-notification-schemes.js.map +1 -0
- package/lib/openapi/platform/models/issue-priorities.d.ts +74 -0
- package/lib/openapi/platform/models/issue-priorities.js +89 -0
- package/lib/openapi/platform/models/issue-priorities.js.map +1 -0
- package/lib/openapi/platform/models/issue-properties.d.ts +80 -0
- package/lib/openapi/platform/models/issue-properties.js +158 -0
- package/lib/openapi/platform/models/issue-properties.js.map +1 -0
- package/lib/openapi/platform/models/issue-remote-links.d.ts +120 -0
- package/lib/openapi/platform/models/issue-remote-links.js +70 -0
- package/lib/openapi/platform/models/issue-remote-links.js.map +1 -0
- package/lib/openapi/platform/models/issue-resolutions.d.ts +81 -0
- package/lib/openapi/platform/models/issue-resolutions.js +79 -0
- package/lib/openapi/platform/models/issue-resolutions.js.map +1 -0
- package/lib/openapi/platform/models/issue-search.d.ts +196 -0
- package/lib/openapi/platform/models/issue-search.js +136 -0
- package/lib/openapi/platform/models/issue-search.js.map +1 -0
- package/lib/openapi/platform/models/issue-security-level.d.ts +36 -0
- package/lib/openapi/platform/models/issue-security-level.js +36 -0
- package/lib/openapi/platform/models/issue-security-level.js.map +1 -0
- package/lib/openapi/platform/models/issue-security-schemes.d.ts +214 -0
- package/lib/openapi/platform/models/issue-security-schemes.js +211 -0
- package/lib/openapi/platform/models/issue-security-schemes.js.map +1 -0
- package/lib/openapi/platform/models/issue-type-schemes.d.ts +146 -0
- package/lib/openapi/platform/models/issue-type-schemes.js +115 -0
- package/lib/openapi/platform/models/issue-type-schemes.js.map +1 -0
- package/lib/openapi/platform/models/issue-type-screen-schemes.d.ts +139 -0
- package/lib/openapi/platform/models/issue-type-screen-schemes.js +109 -0
- package/lib/openapi/platform/models/issue-type-screen-schemes.js.map +1 -0
- package/lib/openapi/platform/models/issue-types.d.ts +36 -0
- package/lib/openapi/platform/models/issue-types.js +28 -0
- package/lib/openapi/platform/models/issue-types.js.map +1 -0
- package/lib/openapi/platform/models/issue-votes.d.ts +18 -0
- package/lib/openapi/platform/models/issue-votes.js +22 -0
- package/lib/openapi/platform/models/issue-votes.js.map +1 -0
- package/lib/openapi/platform/models/issue-watchers.d.ts +27 -0
- package/lib/openapi/platform/models/issue-watchers.js +36 -0
- package/lib/openapi/platform/models/issue-watchers.js.map +1 -0
- package/lib/openapi/platform/models/issue-worklogs.d.ts +93 -0
- package/lib/openapi/platform/models/issue-worklogs.js +80 -0
- package/lib/openapi/platform/models/issue-worklogs.js.map +1 -0
- package/lib/openapi/platform/models/issues.d.ts +583 -0
- package/lib/openapi/platform/models/issues.js +545 -0
- package/lib/openapi/platform/models/issues.js.map +1 -0
- package/lib/openapi/platform/models/jira-expressions.d.ts +329 -0
- package/lib/openapi/platform/models/jira-expressions.js +180 -0
- package/lib/openapi/platform/models/jira-expressions.js.map +1 -0
- package/lib/openapi/platform/models/jira-settings.d.ts +62 -0
- package/lib/openapi/platform/models/jira-settings.js +49 -0
- package/lib/openapi/platform/models/jira-settings.js.map +1 -0
- package/lib/openapi/platform/models/jql-functions-apps.d.ts +61 -0
- package/lib/openapi/platform/models/jql-functions-apps.js +57 -0
- package/lib/openapi/platform/models/jql-functions-apps.js.map +1 -0
- package/lib/openapi/platform/models/jql.d.ts +348 -0
- package/lib/openapi/platform/models/jql.js +309 -0
- package/lib/openapi/platform/models/jql.js.map +1 -0
- package/lib/openapi/platform/models/labels.d.ts +20 -0
- package/lib/openapi/platform/models/labels.js +23 -0
- package/lib/openapi/platform/models/labels.js.map +1 -0
- package/lib/openapi/platform/models/license-metrics.d.ts +27 -0
- package/lib/openapi/platform/models/license-metrics.js +32 -0
- package/lib/openapi/platform/models/license-metrics.js.map +1 -0
- package/lib/openapi/platform/models/myself.d.ts +13 -0
- package/lib/openapi/platform/models/myself.js +17 -0
- package/lib/openapi/platform/models/myself.js.map +1 -0
- package/lib/openapi/platform/models/permission-schemes.d.ts +42 -0
- package/lib/openapi/platform/models/permission-schemes.js +39 -0
- package/lib/openapi/platform/models/permission-schemes.js.map +1 -0
- package/lib/openapi/platform/models/permissions.d.ts +97 -0
- package/lib/openapi/platform/models/permissions.js +176 -0
- package/lib/openapi/platform/models/permissions.js.map +1 -0
- package/lib/openapi/platform/models/priority-schemes.d.ts +233 -0
- package/lib/openapi/platform/models/priority-schemes.js +227 -0
- package/lib/openapi/platform/models/priority-schemes.js.map +1 -0
- package/lib/openapi/platform/models/project-avatars.d.ts +11 -0
- package/lib/openapi/platform/models/project-avatars.js +20 -0
- package/lib/openapi/platform/models/project-avatars.js.map +1 -0
- package/lib/openapi/platform/models/project-classification-levels.d.ts +8 -0
- package/lib/openapi/platform/models/project-classification-levels.js +17 -0
- package/lib/openapi/platform/models/project-classification-levels.js.map +1 -0
- package/lib/openapi/platform/models/project-components.d.ts +122 -0
- package/lib/openapi/platform/models/project-components.js +91 -0
- package/lib/openapi/platform/models/project-components.js.map +1 -0
- package/lib/openapi/platform/models/project-email.d.ts +10 -0
- package/lib/openapi/platform/models/project-email.js +18 -0
- package/lib/openapi/platform/models/project-email.js.map +1 -0
- package/lib/openapi/platform/models/project-features.d.ts +35 -0
- package/lib/openapi/platform/models/project-features.js +38 -0
- package/lib/openapi/platform/models/project-features.js.map +1 -0
- package/lib/openapi/platform/models/project-permission-schemes.d.ts +17 -0
- package/lib/openapi/platform/models/project-permission-schemes.js +25 -0
- package/lib/openapi/platform/models/project-permission-schemes.js.map +1 -0
- package/lib/openapi/platform/models/project-role-actors.d.ts +65 -0
- package/lib/openapi/platform/models/project-role-actors.js +37 -0
- package/lib/openapi/platform/models/project-role-actors.js.map +1 -0
- package/lib/openapi/platform/models/project-roles.d.ts +41 -0
- package/lib/openapi/platform/models/project-roles.js +34 -0
- package/lib/openapi/platform/models/project-roles.js.map +1 -0
- package/lib/openapi/platform/models/project-types.d.ts +16 -0
- package/lib/openapi/platform/models/project-types.js +21 -0
- package/lib/openapi/platform/models/project-types.js.map +1 -0
- package/lib/openapi/platform/models/project-versions.d.ts +110 -0
- package/lib/openapi/platform/models/project-versions.js +87 -0
- package/lib/openapi/platform/models/project-versions.js.map +1 -0
- package/lib/openapi/platform/models/projects.d.ts +216 -0
- package/lib/openapi/platform/models/projects.js +149 -0
- package/lib/openapi/platform/models/projects.js.map +1 -0
- package/lib/openapi/platform/models/screen-schemes.d.ts +94 -0
- package/lib/openapi/platform/models/screen-schemes.js +79 -0
- package/lib/openapi/platform/models/screen-schemes.js.map +1 -0
- package/lib/openapi/platform/models/screen-tab-fields.d.ts +19 -0
- package/lib/openapi/platform/models/screen-tab-fields.js +24 -0
- package/lib/openapi/platform/models/screen-tab-fields.js.map +1 -0
- package/lib/openapi/platform/models/screens.d.ts +82 -0
- package/lib/openapi/platform/models/screens.js +72 -0
- package/lib/openapi/platform/models/screens.js.map +1 -0
- package/lib/openapi/platform/models/server-info.d.ts +51 -0
- package/lib/openapi/platform/models/server-info.js +47 -0
- package/lib/openapi/platform/models/server-info.js.map +1 -0
- package/lib/openapi/platform/models/service-registry.d.ts +32 -0
- package/lib/openapi/platform/models/service-registry.js +34 -0
- package/lib/openapi/platform/models/service-registry.js.map +1 -0
- package/lib/openapi/platform/models/status.d.ts +95 -0
- package/lib/openapi/platform/models/status.js +107 -0
- package/lib/openapi/platform/models/status.js.map +1 -0
- package/lib/openapi/platform/models/time-tracking.d.ts +20 -0
- package/lib/openapi/platform/models/time-tracking.js +19 -0
- package/lib/openapi/platform/models/time-tracking.js.map +1 -0
- package/lib/openapi/platform/models/ui-modifications-apps.d.ts +127 -0
- package/lib/openapi/platform/models/ui-modifications-apps.js +85 -0
- package/lib/openapi/platform/models/ui-modifications-apps.js.map +1 -0
- package/lib/openapi/platform/models/user-search.d.ts +37 -0
- package/lib/openapi/platform/models/user-search.js +30 -0
- package/lib/openapi/platform/models/user-search.js.map +1 -0
- package/lib/openapi/platform/models/users.d.ts +60 -0
- package/lib/openapi/platform/models/users.js +53 -0
- package/lib/openapi/platform/models/users.js.map +1 -0
- package/lib/openapi/platform/models/webhooks.d.ts +147 -0
- package/lib/openapi/platform/models/webhooks.js +112 -0
- package/lib/openapi/platform/models/webhooks.js.map +1 -0
- package/lib/openapi/platform/models/workflow-scheme-drafts.d.ts +17 -0
- package/lib/openapi/platform/models/workflow-scheme-drafts.js +37 -0
- package/lib/openapi/platform/models/workflow-scheme-drafts.js.map +1 -0
- package/lib/openapi/platform/models/workflow-scheme-project-associations.d.ts +29 -0
- package/lib/openapi/platform/models/workflow-scheme-project-associations.js +33 -0
- package/lib/openapi/platform/models/workflow-scheme-project-associations.js.map +1 -0
- package/lib/openapi/platform/models/workflow-schemes.d.ts +217 -0
- package/lib/openapi/platform/models/workflow-schemes.js +261 -0
- package/lib/openapi/platform/models/workflow-schemes.js.map +1 -0
- package/lib/openapi/platform/models/workflow-transition-properties.d.ts +15 -0
- package/lib/openapi/platform/models/workflow-transition-properties.js +19 -0
- package/lib/openapi/platform/models/workflow-transition-properties.js.map +1 -0
- package/lib/openapi/platform/models/workflow-transition-rules.d.ts +106 -0
- package/lib/openapi/platform/models/workflow-transition-rules.js +117 -0
- package/lib/openapi/platform/models/workflow-transition-rules.js.map +1 -0
- package/lib/openapi/platform/models/workflows.d.ts +848 -0
- package/lib/openapi/platform/models/workflows.js +824 -0
- package/lib/openapi/platform/models/workflows.js.map +1 -0
- package/lib/openapi/platform/services/announcement-banner-service.d.ts +49 -0
- package/lib/openapi/platform/services/announcement-banner-service.js +99 -0
- package/lib/openapi/platform/services/announcement-banner-service.js.map +1 -0
- package/lib/openapi/platform/services/app-data-policies-service.d.ts +44 -0
- package/lib/openapi/platform/services/app-data-policies-service.js +101 -0
- package/lib/openapi/platform/services/app-data-policies-service.js.map +1 -0
- package/lib/openapi/platform/services/app-migration-service.d.ts +152 -0
- package/lib/openapi/platform/services/app-migration-service.js +178 -0
- package/lib/openapi/platform/services/app-migration-service.js.map +1 -0
- package/lib/openapi/platform/services/app-properties-service.d.ts +184 -0
- package/lib/openapi/platform/services/app-properties-service.js +325 -0
- package/lib/openapi/platform/services/app-properties-service.js.map +1 -0
- package/lib/openapi/platform/services/application-roles-service.d.ts +158 -0
- package/lib/openapi/platform/services/application-roles-service.js +209 -0
- package/lib/openapi/platform/services/application-roles-service.js.map +1 -0
- package/lib/openapi/platform/services/audit-records-service.d.ts +101 -0
- package/lib/openapi/platform/services/audit-records-service.js +125 -0
- package/lib/openapi/platform/services/audit-records-service.js.map +1 -0
- package/lib/openapi/platform/services/avatars-service.d.ts +363 -0
- package/lib/openapi/platform/services/avatars-service.js +523 -0
- package/lib/openapi/platform/services/avatars-service.js.map +1 -0
- package/lib/openapi/platform/services/classification-levels-service.d.ts +72 -0
- package/lib/openapi/platform/services/classification-levels-service.js +104 -0
- package/lib/openapi/platform/services/classification-levels-service.js.map +1 -0
- package/lib/openapi/platform/services/dashboards-service.d.ts +918 -0
- package/lib/openapi/platform/services/dashboards-service.js +1109 -0
- package/lib/openapi/platform/services/dashboards-service.js.map +1 -0
- package/lib/openapi/platform/services/dynamic-modules-service.d.ts +50 -0
- package/lib/openapi/platform/services/dynamic-modules-service.js +96 -0
- package/lib/openapi/platform/services/dynamic-modules-service.js.map +1 -0
- package/lib/openapi/platform/services/filter-sharing-service.d.ts +446 -0
- package/lib/openapi/platform/services/filter-sharing-service.js +565 -0
- package/lib/openapi/platform/services/filter-sharing-service.js.map +1 -0
- package/lib/openapi/platform/services/filters-service.d.ts +1320 -0
- package/lib/openapi/platform/services/filters-service.js +1351 -0
- package/lib/openapi/platform/services/filters-service.js.map +1 -0
- package/lib/openapi/platform/services/group-and-user-picker-service.d.ts +132 -0
- package/lib/openapi/platform/services/group-and-user-picker-service.js +140 -0
- package/lib/openapi/platform/services/group-and-user-picker-service.js.map +1 -0
- package/lib/openapi/platform/services/groups-service.d.ts +411 -0
- package/lib/openapi/platform/services/groups-service.js +448 -0
- package/lib/openapi/platform/services/groups-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-attachments-service.d.ts +549 -0
- package/lib/openapi/platform/services/issue-attachments-service.js +724 -0
- package/lib/openapi/platform/services/issue-attachments-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-comment-properties-service.d.ts +149 -0
- package/lib/openapi/platform/services/issue-comment-properties-service.js +239 -0
- package/lib/openapi/platform/services/issue-comment-properties-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-comments-service.d.ts +528 -0
- package/lib/openapi/platform/services/issue-comments-service.js +563 -0
- package/lib/openapi/platform/services/issue-comments-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-custom-field-configuration-apps-service.d.ts +155 -0
- package/lib/openapi/platform/services/issue-custom-field-configuration-apps-service.js +163 -0
- package/lib/openapi/platform/services/issue-custom-field-configuration-apps-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-custom-field-contexts-service.d.ts +659 -0
- package/lib/openapi/platform/services/issue-custom-field-contexts-service.js +854 -0
- package/lib/openapi/platform/services/issue-custom-field-contexts-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-custom-field-options-apps-service.d.ts +615 -0
- package/lib/openapi/platform/services/issue-custom-field-options-apps-service.js +605 -0
- package/lib/openapi/platform/services/issue-custom-field-options-apps-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-custom-field-options-service.d.ts +339 -0
- package/lib/openapi/platform/services/issue-custom-field-options-service.js +420 -0
- package/lib/openapi/platform/services/issue-custom-field-options-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-custom-field-values-apps-service.d.ts +90 -0
- package/lib/openapi/platform/services/issue-custom-field-values-apps-service.js +117 -0
- package/lib/openapi/platform/services/issue-custom-field-values-apps-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-field-configurations-service.d.ts +561 -0
- package/lib/openapi/platform/services/issue-field-configurations-service.js +801 -0
- package/lib/openapi/platform/services/issue-field-configurations-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-fields-service.d.ts +420 -0
- package/lib/openapi/platform/services/issue-fields-service.js +555 -0
- package/lib/openapi/platform/services/issue-fields-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-link-types-service.d.ts +165 -0
- package/lib/openapi/platform/services/issue-link-types-service.js +263 -0
- package/lib/openapi/platform/services/issue-link-types-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-links-service.d.ts +237 -0
- package/lib/openapi/platform/services/issue-links-service.js +264 -0
- package/lib/openapi/platform/services/issue-links-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-navigator-settings-service.d.ts +55 -0
- package/lib/openapi/platform/services/issue-navigator-settings-service.js +97 -0
- package/lib/openapi/platform/services/issue-navigator-settings-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-notification-schemes-service.d.ts +809 -0
- package/lib/openapi/platform/services/issue-notification-schemes-service.js +917 -0
- package/lib/openapi/platform/services/issue-notification-schemes-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-priorities-service.d.ts +238 -0
- package/lib/openapi/platform/services/issue-priorities-service.js +372 -0
- package/lib/openapi/platform/services/issue-priorities-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-properties-service.d.ts +368 -0
- package/lib/openapi/platform/services/issue-properties-service.js +439 -0
- package/lib/openapi/platform/services/issue-properties-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-remote-links-service.d.ts +351 -0
- package/lib/openapi/platform/services/issue-remote-links-service.js +429 -0
- package/lib/openapi/platform/services/issue-remote-links-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-resolutions-service.d.ts +202 -0
- package/lib/openapi/platform/services/issue-resolutions-service.js +346 -0
- package/lib/openapi/platform/services/issue-resolutions-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-search-service.d.ts +887 -0
- package/lib/openapi/platform/services/issue-search-service.js +878 -0
- package/lib/openapi/platform/services/issue-search-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-security-level-service.d.ts +136 -0
- package/lib/openapi/platform/services/issue-security-level-service.js +174 -0
- package/lib/openapi/platform/services/issue-security-level-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-security-schemes-service.d.ts +530 -0
- package/lib/openapi/platform/services/issue-security-schemes-service.js +721 -0
- package/lib/openapi/platform/services/issue-security-schemes-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-type-properties-service.d.ts +150 -0
- package/lib/openapi/platform/services/issue-type-properties-service.js +227 -0
- package/lib/openapi/platform/services/issue-type-properties-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-type-schemes-service.d.ts +460 -0
- package/lib/openapi/platform/services/issue-type-schemes-service.js +615 -0
- package/lib/openapi/platform/services/issue-type-schemes-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-type-screen-schemes-service.d.ts +442 -0
- package/lib/openapi/platform/services/issue-type-screen-schemes-service.js +606 -0
- package/lib/openapi/platform/services/issue-type-screen-schemes-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-types-service.d.ts +343 -0
- package/lib/openapi/platform/services/issue-types-service.js +495 -0
- package/lib/openapi/platform/services/issue-types-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-votes-service.d.ts +117 -0
- package/lib/openapi/platform/services/issue-votes-service.js +179 -0
- package/lib/openapi/platform/services/issue-votes-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-watchers-service.d.ts +168 -0
- package/lib/openapi/platform/services/issue-watchers-service.js +236 -0
- package/lib/openapi/platform/services/issue-watchers-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-worklog-properties-service.d.ts +165 -0
- package/lib/openapi/platform/services/issue-worklog-properties-service.js +251 -0
- package/lib/openapi/platform/services/issue-worklog-properties-service.js.map +1 -0
- package/lib/openapi/platform/services/issue-worklogs-service.d.ts +694 -0
- package/lib/openapi/platform/services/issue-worklogs-service.js +701 -0
- package/lib/openapi/platform/services/issue-worklogs-service.js.map +1 -0
- package/lib/openapi/platform/services/issues-service.d.ts +2356 -0
- package/lib/openapi/platform/services/issues-service.js +2022 -0
- package/lib/openapi/platform/services/issues-service.js.map +1 -0
- package/lib/openapi/platform/services/jira-expressions-service.d.ts +298 -0
- package/lib/openapi/platform/services/jira-expressions-service.js +272 -0
- package/lib/openapi/platform/services/jira-expressions-service.js.map +1 -0
- package/lib/openapi/platform/services/jira-settings-service.d.ts +236 -0
- package/lib/openapi/platform/services/jira-settings-service.js +325 -0
- package/lib/openapi/platform/services/jira-settings-service.js.map +1 -0
- package/lib/openapi/platform/services/jql-functions-apps-service.d.ts +113 -0
- package/lib/openapi/platform/services/jql-functions-apps-service.js +142 -0
- package/lib/openapi/platform/services/jql-functions-apps-service.js.map +1 -0
- package/lib/openapi/platform/services/jql-service.d.ts +623 -0
- package/lib/openapi/platform/services/jql-service.js +697 -0
- package/lib/openapi/platform/services/jql-service.js.map +1 -0
- package/lib/openapi/platform/services/labels-service.d.ts +34 -0
- package/lib/openapi/platform/services/labels-service.js +67 -0
- package/lib/openapi/platform/services/labels-service.js.map +1 -0
- package/lib/openapi/platform/services/license-metrics-service.d.ts +82 -0
- package/lib/openapi/platform/services/license-metrics-service.js +160 -0
- package/lib/openapi/platform/services/license-metrics-service.js.map +1 -0
- package/lib/openapi/platform/services/myself-service.d.ts +254 -0
- package/lib/openapi/platform/services/myself-service.js +382 -0
- package/lib/openapi/platform/services/myself-service.js.map +1 -0
- package/lib/openapi/platform/services/permission-schemes-service.d.ts +554 -0
- package/lib/openapi/platform/services/permission-schemes-service.js +613 -0
- package/lib/openapi/platform/services/permission-schemes-service.js.map +1 -0
- package/lib/openapi/platform/services/permissions-service.d.ts +214 -0
- package/lib/openapi/platform/services/permissions-service.js +281 -0
- package/lib/openapi/platform/services/permissions-service.js.map +1 -0
- package/lib/openapi/platform/services/priority-schemes-service.d.ts +578 -0
- package/lib/openapi/platform/services/priority-schemes-service.js +655 -0
- package/lib/openapi/platform/services/priority-schemes-service.js.map +1 -0
- package/lib/openapi/platform/services/project-avatars-service.d.ts +170 -0
- package/lib/openapi/platform/services/project-avatars-service.js +254 -0
- package/lib/openapi/platform/services/project-avatars-service.js.map +1 -0
- package/lib/openapi/platform/services/project-categories-service.d.ts +128 -0
- package/lib/openapi/platform/services/project-categories-service.js +226 -0
- package/lib/openapi/platform/services/project-categories-service.js.map +1 -0
- package/lib/openapi/platform/services/project-classification-levels-service.d.ts +90 -0
- package/lib/openapi/platform/services/project-classification-levels-service.js +161 -0
- package/lib/openapi/platform/services/project-classification-levels-service.js.map +1 -0
- package/lib/openapi/platform/services/project-components-service.d.ts +955 -0
- package/lib/openapi/platform/services/project-components-service.js +1075 -0
- package/lib/openapi/platform/services/project-components-service.js.map +1 -0
- package/lib/openapi/platform/services/project-email-service.d.ts +60 -0
- package/lib/openapi/platform/services/project-email-service.js +113 -0
- package/lib/openapi/platform/services/project-email-service.js.map +1 -0
- package/lib/openapi/platform/services/project-features-service.d.ts +103 -0
- package/lib/openapi/platform/services/project-features-service.js +155 -0
- package/lib/openapi/platform/services/project-features-service.js.map +1 -0
- package/lib/openapi/platform/services/project-key-and-name-validation-service.d.ts +59 -0
- package/lib/openapi/platform/services/project-key-and-name-validation-service.js +135 -0
- package/lib/openapi/platform/services/project-key-and-name-validation-service.js.map +1 -0
- package/lib/openapi/platform/services/project-permission-schemes-service.d.ts +179 -0
- package/lib/openapi/platform/services/project-permission-schemes-service.js +255 -0
- package/lib/openapi/platform/services/project-permission-schemes-service.js.map +1 -0
- package/lib/openapi/platform/services/project-properties-service.d.ts +147 -0
- package/lib/openapi/platform/services/project-properties-service.js +224 -0
- package/lib/openapi/platform/services/project-properties-service.js.map +1 -0
- package/lib/openapi/platform/services/project-role-actors-service.d.ts +351 -0
- package/lib/openapi/platform/services/project-role-actors-service.js +413 -0
- package/lib/openapi/platform/services/project-role-actors-service.js.map +1 -0
- package/lib/openapi/platform/services/project-roles-service.d.ts +484 -0
- package/lib/openapi/platform/services/project-roles-service.js +647 -0
- package/lib/openapi/platform/services/project-roles-service.js.map +1 -0
- package/lib/openapi/platform/services/project-types-service.d.ts +121 -0
- package/lib/openapi/platform/services/project-types-service.js +220 -0
- package/lib/openapi/platform/services/project-types-service.js.map +1 -0
- package/lib/openapi/platform/services/project-versions-service.d.ts +632 -0
- package/lib/openapi/platform/services/project-versions-service.js +852 -0
- package/lib/openapi/platform/services/project-versions-service.js.map +1 -0
- package/lib/openapi/platform/services/projects-service.d.ts +1622 -0
- package/lib/openapi/platform/services/projects-service.js +1686 -0
- package/lib/openapi/platform/services/projects-service.js.map +1 -0
- package/lib/openapi/platform/services/screen-schemes-service.d.ts +166 -0
- package/lib/openapi/platform/services/screen-schemes-service.js +216 -0
- package/lib/openapi/platform/services/screen-schemes-service.js.map +1 -0
- package/lib/openapi/platform/services/screen-tab-fields-service.d.ts +103 -0
- package/lib/openapi/platform/services/screen-tab-fields-service.js +181 -0
- package/lib/openapi/platform/services/screen-tab-fields-service.js.map +1 -0
- package/lib/openapi/platform/services/screen-tabs-service.d.ts +164 -0
- package/lib/openapi/platform/services/screen-tabs-service.js +278 -0
- package/lib/openapi/platform/services/screen-tabs-service.js.map +1 -0
- package/lib/openapi/platform/services/screens-service.d.ts +226 -0
- package/lib/openapi/platform/services/screens-service.js +346 -0
- package/lib/openapi/platform/services/screens-service.js.map +1 -0
- package/lib/openapi/platform/services/server-info-service.d.ts +40 -0
- package/lib/openapi/platform/services/server-info-service.js +74 -0
- package/lib/openapi/platform/services/server-info-service.js.map +1 -0
- package/lib/openapi/platform/services/service-registry-service.d.ts +32 -0
- package/lib/openapi/platform/services/service-registry-service.js +60 -0
- package/lib/openapi/platform/services/service-registry-service.js.map +1 -0
- package/lib/openapi/platform/services/status-service.d.ts +268 -0
- package/lib/openapi/platform/services/status-service.js +321 -0
- package/lib/openapi/platform/services/status-service.js.map +1 -0
- package/lib/openapi/platform/services/tasks-service.d.ts +71 -0
- package/lib/openapi/platform/services/tasks-service.js +126 -0
- package/lib/openapi/platform/services/tasks-service.js.map +1 -0
- package/lib/openapi/platform/services/time-tracking-service.d.ts +140 -0
- package/lib/openapi/platform/services/time-tracking-service.js +260 -0
- package/lib/openapi/platform/services/time-tracking-service.js.map +1 -0
- package/lib/openapi/platform/services/ui-modifications-apps-service.d.ts +212 -0
- package/lib/openapi/platform/services/ui-modifications-apps-service.js +262 -0
- package/lib/openapi/platform/services/ui-modifications-apps-service.js.map +1 -0
- package/lib/openapi/platform/services/user-properties-service.d.ts +218 -0
- package/lib/openapi/platform/services/user-properties-service.js +254 -0
- package/lib/openapi/platform/services/user-properties-service.js.map +1 -0
- package/lib/openapi/platform/services/user-search-service.d.ts +782 -0
- package/lib/openapi/platform/services/user-search-service.js +784 -0
- package/lib/openapi/platform/services/user-search-service.js.map +1 -0
- package/lib/openapi/platform/services/users-service.d.ts +579 -0
- package/lib/openapi/platform/services/users-service.js +729 -0
- package/lib/openapi/platform/services/users-service.js.map +1 -0
- package/lib/openapi/platform/services/webhooks-service.d.ts +258 -0
- package/lib/openapi/platform/services/webhooks-service.js +307 -0
- package/lib/openapi/platform/services/webhooks-service.js.map +1 -0
- package/lib/openapi/platform/services/workflow-scheme-drafts-service.d.ts +744 -0
- package/lib/openapi/platform/services/workflow-scheme-drafts-service.js +956 -0
- package/lib/openapi/platform/services/workflow-scheme-drafts-service.js.map +1 -0
- package/lib/openapi/platform/services/workflow-scheme-project-associations-service.d.ts +85 -0
- package/lib/openapi/platform/services/workflow-scheme-project-associations-service.js +134 -0
- package/lib/openapi/platform/services/workflow-scheme-project-associations-service.js.map +1 -0
- package/lib/openapi/platform/services/workflow-schemes-service.d.ts +843 -0
- package/lib/openapi/platform/services/workflow-schemes-service.js +1030 -0
- package/lib/openapi/platform/services/workflow-schemes-service.js.map +1 -0
- package/lib/openapi/platform/services/workflow-status-categories-service.d.ts +60 -0
- package/lib/openapi/platform/services/workflow-status-categories-service.js +115 -0
- package/lib/openapi/platform/services/workflow-status-categories-service.js.map +1 -0
- package/lib/openapi/platform/services/workflow-statuses-service.d.ts +87 -0
- package/lib/openapi/platform/services/workflow-statuses-service.js +142 -0
- package/lib/openapi/platform/services/workflow-statuses-service.js.map +1 -0
- package/lib/openapi/platform/services/workflow-transition-properties-service.d.ts +189 -0
- package/lib/openapi/platform/services/workflow-transition-properties-service.js +224 -0
- package/lib/openapi/platform/services/workflow-transition-properties-service.js.map +1 -0
- package/lib/openapi/platform/services/workflow-transition-rules-service.d.ts +319 -0
- package/lib/openapi/platform/services/workflow-transition-rules-service.js +326 -0
- package/lib/openapi/platform/services/workflow-transition-rules-service.js.map +1 -0
- package/lib/openapi/platform/services/workflows-service.d.ts +3032 -0
- package/lib/openapi/platform/services/workflows-service.js +2529 -0
- package/lib/openapi/platform/services/workflows-service.js.map +1 -0
- package/lib/openapi/platform/validation-schema-storage.d.ts +3 -0
- package/lib/openapi/platform/validation-schema-storage.js +144 -0
- package/lib/openapi/platform/validation-schema-storage.js.map +1 -0
- package/lib/openapi/software/base-jira-software-api-client.d.ts +426 -0
- package/lib/openapi/software/base-jira-software-api-client.js +444 -0
- package/lib/openapi/software/base-jira-software-api-client.js.map +1 -0
- package/lib/openapi/software/core/common-http-client.d.ts +196 -0
- package/lib/openapi/software/core/common-http-client.js +390 -0
- package/lib/openapi/software/core/common-http-client.js.map +1 -0
- package/lib/openapi/software/core/common-http-service.d.ts +7 -0
- package/lib/openapi/software/core/common-http-service.js +20 -0
- package/lib/openapi/software/core/common-http-service.js.map +1 -0
- package/lib/openapi/software/core/common-validation-schema-storage.d.ts +35 -0
- package/lib/openapi/software/core/common-validation-schema-storage.js +65 -0
- package/lib/openapi/software/core/common-validation-schema-storage.js.map +1 -0
- package/lib/openapi/software/models/board.d.ts +505 -0
- package/lib/openapi/software/models/board.js +389 -0
- package/lib/openapi/software/models/board.js.map +1 -0
- package/lib/openapi/software/services/backlog-service.d.ts +81 -0
- package/lib/openapi/software/services/backlog-service.js +113 -0
- package/lib/openapi/software/services/backlog-service.js.map +1 -0
- package/lib/openapi/software/services/board-service.d.ts +2254 -0
- package/lib/openapi/software/services/board-service.js +2653 -0
- package/lib/openapi/software/services/board-service.js.map +1 -0
- package/lib/openapi/software/services/builds-service.d.ts +368 -0
- package/lib/openapi/software/services/builds-service.js +230 -0
- package/lib/openapi/software/services/builds-service.js.map +1 -0
- package/lib/openapi/software/services/deployments-service.d.ts +217 -0
- package/lib/openapi/software/services/deployments-service.js +232 -0
- package/lib/openapi/software/services/deployments-service.js.map +1 -0
- package/lib/openapi/software/services/dev-ops-components-service.d.ts +246 -0
- package/lib/openapi/software/services/dev-ops-components-service.js +280 -0
- package/lib/openapi/software/services/dev-ops-components-service.js.map +1 -0
- package/lib/openapi/software/services/development-information-service.d.ts +1641 -0
- package/lib/openapi/software/services/development-information-service.js +474 -0
- package/lib/openapi/software/services/development-information-service.js.map +1 -0
- package/lib/openapi/software/services/epic-service.d.ts +596 -0
- package/lib/openapi/software/services/epic-service.js +633 -0
- package/lib/openapi/software/services/epic-service.js.map +1 -0
- package/lib/openapi/software/services/feature-flags-service.d.ts +170 -0
- package/lib/openapi/software/services/feature-flags-service.js +182 -0
- package/lib/openapi/software/services/feature-flags-service.js.map +1 -0
- package/lib/openapi/software/services/issue-service.d.ts +329 -0
- package/lib/openapi/software/services/issue-service.js +410 -0
- package/lib/openapi/software/services/issue-service.js.map +1 -0
- package/lib/openapi/software/services/operations-service.d.ts +456 -0
- package/lib/openapi/software/services/operations-service.js +444 -0
- package/lib/openapi/software/services/operations-service.js.map +1 -0
- package/lib/openapi/software/services/remote-links-service.d.ts +445 -0
- package/lib/openapi/software/services/remote-links-service.js +327 -0
- package/lib/openapi/software/services/remote-links-service.js.map +1 -0
- package/lib/openapi/software/services/security-information-service.d.ts +257 -0
- package/lib/openapi/software/services/security-information-service.js +310 -0
- package/lib/openapi/software/services/security-information-service.js.map +1 -0
- package/lib/openapi/software/services/sprint-service.d.ts +531 -0
- package/lib/openapi/software/services/sprint-service.js +665 -0
- package/lib/openapi/software/services/sprint-service.js.map +1 -0
- package/lib/openapi/software/validation-schema-storage.d.ts +3 -0
- package/lib/openapi/software/validation-schema-storage.js +144 -0
- package/lib/openapi/software/validation-schema-storage.js.map +1 -0
- package/package.json +37 -0
- package/src/index.ts +47 -0
- package/src/openapi/platform/base-jira-platform-api-client.ts +2298 -0
- package/src/openapi/platform/core/common-http-client.ts +723 -0
- package/src/openapi/platform/core/common-http-service.ts +22 -0
- package/src/openapi/platform/core/common-validation-schema-storage.ts +105 -0
- package/src/openapi/platform/models/announcement-banner.ts +59 -0
- package/src/openapi/platform/models/app-data-policies.ts +79 -0
- package/src/openapi/platform/models/app-migration.ts +172 -0
- package/src/openapi/platform/models/app-properties.ts +32 -0
- package/src/openapi/platform/models/audit-records.ts +140 -0
- package/src/openapi/platform/models/avatars.ts +48 -0
- package/src/openapi/platform/models/classification-levels.ts +58 -0
- package/src/openapi/platform/models/common.ts +2669 -0
- package/src/openapi/platform/models/dashboards.ts +849 -0
- package/src/openapi/platform/models/dynamic-modules.ts +121 -0
- package/src/openapi/platform/models/filter-sharing.ts +103 -0
- package/src/openapi/platform/models/filters.ts +319 -0
- package/src/openapi/platform/models/group-and-user-picker.ts +85 -0
- package/src/openapi/platform/models/groups.ts +247 -0
- package/src/openapi/platform/models/issue-attachments.ts +290 -0
- package/src/openapi/platform/models/issue-comment-properties.ts +27 -0
- package/src/openapi/platform/models/issue-comments.ts +91 -0
- package/src/openapi/platform/models/issue-custom-field-configuration-apps.ts +96 -0
- package/src/openapi/platform/models/issue-custom-field-contexts.ts +1072 -0
- package/src/openapi/platform/models/issue-custom-field-options-apps.ts +273 -0
- package/src/openapi/platform/models/issue-custom-field-options.ts +283 -0
- package/src/openapi/platform/models/issue-custom-field-values-apps.ts +118 -0
- package/src/openapi/platform/models/issue-field-configurations.ts +435 -0
- package/src/openapi/platform/models/issue-fields.ts +392 -0
- package/src/openapi/platform/models/issue-link-types.ts +28 -0
- package/src/openapi/platform/models/issue-links.ts +185 -0
- package/src/openapi/platform/models/issue-notification-schemes.ts +370 -0
- package/src/openapi/platform/models/issue-priorities.ts +196 -0
- package/src/openapi/platform/models/issue-properties.ts +259 -0
- package/src/openapi/platform/models/issue-remote-links.ts +207 -0
- package/src/openapi/platform/models/issue-resolutions.ts +180 -0
- package/src/openapi/platform/models/issue-search.ts +367 -0
- package/src/openapi/platform/models/issue-security-level.ts +76 -0
- package/src/openapi/platform/models/issue-security-schemes.ts +496 -0
- package/src/openapi/platform/models/issue-type-schemes.ts +290 -0
- package/src/openapi/platform/models/issue-type-screen-schemes.ts +286 -0
- package/src/openapi/platform/models/issue-types.ts +66 -0
- package/src/openapi/platform/models/issue-votes.ts +38 -0
- package/src/openapi/platform/models/issue-watchers.ts +67 -0
- package/src/openapi/platform/models/issue-worklogs.ts +190 -0
- package/src/openapi/platform/models/issues.ts +1268 -0
- package/src/openapi/platform/models/jira-expressions.ts +578 -0
- package/src/openapi/platform/models/jira-settings.ts +118 -0
- package/src/openapi/platform/models/jql-functions-apps.ts +128 -0
- package/src/openapi/platform/models/jql.ts +783 -0
- package/src/openapi/platform/models/labels.ts +42 -0
- package/src/openapi/platform/models/license-metrics.ts +68 -0
- package/src/openapi/platform/models/myself.ts +29 -0
- package/src/openapi/platform/models/permission-schemes.ts +89 -0
- package/src/openapi/platform/models/permissions.ts +308 -0
- package/src/openapi/platform/models/priority-schemes.ts +527 -0
- package/src/openapi/platform/models/project-avatars.ts +29 -0
- package/src/openapi/platform/models/project-classification-levels.ts +24 -0
- package/src/openapi/platform/models/project-components.ts +231 -0
- package/src/openapi/platform/models/project-email.ts +27 -0
- package/src/openapi/platform/models/project-features.ts +78 -0
- package/src/openapi/platform/models/project-permission-schemes.ts +43 -0
- package/src/openapi/platform/models/project-role-actors.ts +107 -0
- package/src/openapi/platform/models/project-roles.ts +76 -0
- package/src/openapi/platform/models/project-types.ts +36 -0
- package/src/openapi/platform/models/project-versions.ts +216 -0
- package/src/openapi/platform/models/projects.ts +429 -0
- package/src/openapi/platform/models/screen-schemes.ts +192 -0
- package/src/openapi/platform/models/screen-tab-fields.ts +45 -0
- package/src/openapi/platform/models/screens.ts +171 -0
- package/src/openapi/platform/models/server-info.ts +100 -0
- package/src/openapi/platform/models/service-registry.ts +68 -0
- package/src/openapi/platform/models/status.ts +229 -0
- package/src/openapi/platform/models/time-tracking.ts +38 -0
- package/src/openapi/platform/models/ui-modifications-apps.ts +229 -0
- package/src/openapi/platform/models/user-search.ts +69 -0
- package/src/openapi/platform/models/users.ts +121 -0
- package/src/openapi/platform/models/webhooks.ts +307 -0
- package/src/openapi/platform/models/workflow-scheme-drafts.ts +58 -0
- package/src/openapi/platform/models/workflow-scheme-project-associations.ts +68 -0
- package/src/openapi/platform/models/workflow-schemes.ts +545 -0
- package/src/openapi/platform/models/workflow-transition-properties.ts +33 -0
- package/src/openapi/platform/models/workflow-transition-rules.ts +261 -0
- package/src/openapi/platform/models/workflows.ts +1943 -0
- package/src/openapi/platform/services/announcement-banner-service.ts +142 -0
- package/src/openapi/platform/services/app-data-policies-service.ts +136 -0
- package/src/openapi/platform/services/app-migration-service.ts +289 -0
- package/src/openapi/platform/services/app-properties-service.ts +441 -0
- package/src/openapi/platform/services/application-roles-service.ts +247 -0
- package/src/openapi/platform/services/audit-records-service.ts +164 -0
- package/src/openapi/platform/services/avatars-service.ts +769 -0
- package/src/openapi/platform/services/classification-levels-service.ts +131 -0
- package/src/openapi/platform/services/dashboards-service.ts +1721 -0
- package/src/openapi/platform/services/dynamic-modules-service.ts +127 -0
- package/src/openapi/platform/services/filter-sharing-service.ts +687 -0
- package/src/openapi/platform/services/filters-service.ts +1901 -0
- package/src/openapi/platform/services/group-and-user-picker-service.ts +224 -0
- package/src/openapi/platform/services/groups-service.ts +751 -0
- package/src/openapi/platform/services/issue-attachments-service.ts +900 -0
- package/src/openapi/platform/services/issue-comment-properties-service.ts +324 -0
- package/src/openapi/platform/services/issue-comments-service.ts +812 -0
- package/src/openapi/platform/services/issue-custom-field-configuration-apps-service.ts +277 -0
- package/src/openapi/platform/services/issue-custom-field-contexts-service.ts +1339 -0
- package/src/openapi/platform/services/issue-custom-field-options-apps-service.ts +994 -0
- package/src/openapi/platform/services/issue-custom-field-options-service.ts +651 -0
- package/src/openapi/platform/services/issue-custom-field-values-apps-service.ts +201 -0
- package/src/openapi/platform/services/issue-field-configurations-service.ts +1294 -0
- package/src/openapi/platform/services/issue-fields-service.ts +837 -0
- package/src/openapi/platform/services/issue-link-types-service.ts +360 -0
- package/src/openapi/platform/services/issue-links-service.ts +345 -0
- package/src/openapi/platform/services/issue-navigator-settings-service.ts +119 -0
- package/src/openapi/platform/services/issue-notification-schemes-service.ts +1209 -0
- package/src/openapi/platform/services/issue-priorities-service.ts +575 -0
- package/src/openapi/platform/services/issue-properties-service.ts +606 -0
- package/src/openapi/platform/services/issue-remote-links-service.ts +597 -0
- package/src/openapi/platform/services/issue-resolutions-service.ts +534 -0
- package/src/openapi/platform/services/issue-search-service.ts +1139 -0
- package/src/openapi/platform/services/issue-security-level-service.ts +250 -0
- package/src/openapi/platform/services/issue-security-schemes-service.ts +1240 -0
- package/src/openapi/platform/services/issue-type-properties-service.ts +325 -0
- package/src/openapi/platform/services/issue-type-schemes-service.ts +940 -0
- package/src/openapi/platform/services/issue-type-screen-schemes-service.ts +994 -0
- package/src/openapi/platform/services/issue-types-service.ts +679 -0
- package/src/openapi/platform/services/issue-votes-service.ts +221 -0
- package/src/openapi/platform/services/issue-watchers-service.ts +331 -0
- package/src/openapi/platform/services/issue-worklog-properties-service.ts +348 -0
- package/src/openapi/platform/services/issue-worklogs-service.ts +1089 -0
- package/src/openapi/platform/services/issues-service.ts +3346 -0
- package/src/openapi/platform/services/jira-expressions-service.ts +407 -0
- package/src/openapi/platform/services/jira-settings-service.ts +415 -0
- package/src/openapi/platform/services/jql-functions-apps-service.ts +219 -0
- package/src/openapi/platform/services/jql-service.ts +896 -0
- package/src/openapi/platform/services/labels-service.ts +89 -0
- package/src/openapi/platform/services/license-metrics-service.ts +216 -0
- package/src/openapi/platform/services/myself-service.ts +520 -0
- package/src/openapi/platform/services/permission-schemes-service.ts +926 -0
- package/src/openapi/platform/services/permissions-service.ts +407 -0
- package/src/openapi/platform/services/priority-schemes-service.ts +1001 -0
- package/src/openapi/platform/services/project-avatars-service.ts +341 -0
- package/src/openapi/platform/services/project-categories-service.ts +318 -0
- package/src/openapi/platform/services/project-classification-levels-service.ts +232 -0
- package/src/openapi/platform/services/project-components-service.ts +1332 -0
- package/src/openapi/platform/services/project-email-service.ts +161 -0
- package/src/openapi/platform/services/project-features-service.ts +207 -0
- package/src/openapi/platform/services/project-key-and-name-validation-service.ts +200 -0
- package/src/openapi/platform/services/project-permission-schemes-service.ts +384 -0
- package/src/openapi/platform/services/project-properties-service.ts +320 -0
- package/src/openapi/platform/services/project-role-actors-service.ts +627 -0
- package/src/openapi/platform/services/project-roles-service.ts +867 -0
- package/src/openapi/platform/services/project-types-service.ts +297 -0
- package/src/openapi/platform/services/project-versions-service.ts +1287 -0
- package/src/openapi/platform/services/projects-service.ts +2196 -0
- package/src/openapi/platform/services/screen-schemes-service.ts +334 -0
- package/src/openapi/platform/services/screen-tab-fields-service.ts +276 -0
- package/src/openapi/platform/services/screen-tabs-service.ts +421 -0
- package/src/openapi/platform/services/screens-service.ts +528 -0
- package/src/openapi/platform/services/server-info-service.ts +88 -0
- package/src/openapi/platform/services/service-registry-service.ts +89 -0
- package/src/openapi/platform/services/status-service.ts +498 -0
- package/src/openapi/platform/services/tasks-service.ts +159 -0
- package/src/openapi/platform/services/time-tracking-service.ts +386 -0
- package/src/openapi/platform/services/ui-modifications-apps-service.ts +403 -0
- package/src/openapi/platform/services/user-properties-service.ts +413 -0
- package/src/openapi/platform/services/user-search-service.ts +1214 -0
- package/src/openapi/platform/services/users-service.ts +1108 -0
- package/src/openapi/platform/services/webhooks-service.ts +458 -0
- package/src/openapi/platform/services/workflow-scheme-drafts-service.ts +1313 -0
- package/src/openapi/platform/services/workflow-scheme-project-associations-service.ts +189 -0
- package/src/openapi/platform/services/workflow-schemes-service.ts +1617 -0
- package/src/openapi/platform/services/workflow-status-categories-service.ts +151 -0
- package/src/openapi/platform/services/workflow-statuses-service.ts +176 -0
- package/src/openapi/platform/services/workflow-transition-properties-service.ts +388 -0
- package/src/openapi/platform/services/workflow-transition-rules-service.ts +485 -0
- package/src/openapi/platform/services/workflows-service.ts +3477 -0
- package/src/openapi/platform/validation-schema-storage.ts +186 -0
- package/src/openapi/software/base-jira-software-api-client.ts +447 -0
- package/src/openapi/software/core/common-http-client.ts +723 -0
- package/src/openapi/software/core/common-http-service.ts +22 -0
- package/src/openapi/software/core/common-validation-schema-storage.ts +105 -0
- package/src/openapi/software/models/board.ts +918 -0
- package/src/openapi/software/services/backlog-service.ts +160 -0
- package/src/openapi/software/services/board-service.ts +4189 -0
- package/src/openapi/software/services/builds-service.ts +571 -0
- package/src/openapi/software/services/deployments-service.ts +403 -0
- package/src/openapi/software/services/dev-ops-components-service.ts +371 -0
- package/src/openapi/software/services/development-information-service.ts +2357 -0
- package/src/openapi/software/services/epic-service.ts +854 -0
- package/src/openapi/software/services/feature-flags-service.ts +303 -0
- package/src/openapi/software/services/issue-service.ts +529 -0
- package/src/openapi/software/services/operations-service.ts +741 -0
- package/src/openapi/software/services/remote-links-service.ts +653 -0
- package/src/openapi/software/services/security-information-service.ts +495 -0
- package/src/openapi/software/services/sprint-service.ts +969 -0
- package/src/openapi/software/validation-schema-storage.ts +186 -0
- package/tsconfig.build.json +7 -0
- package/tsconfig.json +4 -0
|
@@ -0,0 +1,3346 @@
|
|
|
1
|
+
// DO NOT EDIT!
|
|
2
|
+
// This file is generated by "api-typescript-generator".
|
|
3
|
+
// To update this file run "yarn build:openapi".
|
|
4
|
+
import { z } from "zod";
|
|
5
|
+
|
|
6
|
+
import * as commonHttpClient from "../core/common-http-client";
|
|
7
|
+
import { CommonHttpService } from "../core/common-http-service";
|
|
8
|
+
import {
|
|
9
|
+
type IssueBean,
|
|
10
|
+
registerCommonValidationSchemas,
|
|
11
|
+
type User,
|
|
12
|
+
} from "../models/common";
|
|
13
|
+
import {
|
|
14
|
+
type ArchivedIssuesFilterRequest,
|
|
15
|
+
type ArchiveIssueAsyncRequest,
|
|
16
|
+
type CreatedIssue,
|
|
17
|
+
type CreatedIssues,
|
|
18
|
+
type ExportArchivedIssuesTaskProgressResponse,
|
|
19
|
+
type IssueArchivalSyncRequest,
|
|
20
|
+
type IssueArchivalSyncResponse,
|
|
21
|
+
type IssueChangelogIds,
|
|
22
|
+
type IssueCreateMetadata,
|
|
23
|
+
type IssueEvent,
|
|
24
|
+
type IssueLimitReportRequest,
|
|
25
|
+
type IssueLimitReportResponseBean,
|
|
26
|
+
type IssuesUpdateBean,
|
|
27
|
+
type IssueUpdateDetails,
|
|
28
|
+
type IssueUpdateMetadata,
|
|
29
|
+
type Notification,
|
|
30
|
+
type PageBeanChangelog,
|
|
31
|
+
type PageOfChangelogs,
|
|
32
|
+
type PageOfCreateMetaIssueTypes,
|
|
33
|
+
type PageOfCreateMetaIssueTypeWithField,
|
|
34
|
+
registerIssuesValidationSchemas,
|
|
35
|
+
type Transitions,
|
|
36
|
+
} from "../models/issues";
|
|
37
|
+
import { validationSchemaStorage } from "../validation-schema-storage";
|
|
38
|
+
/**
|
|
39
|
+
* This resource represents Jira issues. Use it to:
|
|
40
|
+
*
|
|
41
|
+
* * create or edit issues, individually or in bulk.
|
|
42
|
+
* * retrieve metadata about the options for creating or editing issues.
|
|
43
|
+
* * delete an issue.
|
|
44
|
+
* * assign a user to an issue.
|
|
45
|
+
* * get issue changelogs.
|
|
46
|
+
* * send notifications about an issue.
|
|
47
|
+
* * get details of the transitions available for an issue.
|
|
48
|
+
* * transition an issue.
|
|
49
|
+
* * Archive issues.
|
|
50
|
+
* * Unarchive issues.
|
|
51
|
+
* * Export archived issues.
|
|
52
|
+
*/
|
|
53
|
+
export class IssuesService extends CommonHttpService {
|
|
54
|
+
/**
|
|
55
|
+
* Enables admins to archive up to 1000 issues in a single request using issue
|
|
56
|
+
* ID/key, returning details of the issue(s) archived in the process and the
|
|
57
|
+
* errors encountered, if any.
|
|
58
|
+
*
|
|
59
|
+
* **Note that:**
|
|
60
|
+
*
|
|
61
|
+
* * you can't archive subtasks directly, only through their parent issues
|
|
62
|
+
* * you can only archive issues from software, service management, and business
|
|
63
|
+
* projects
|
|
64
|
+
*
|
|
65
|
+
* **[Permissions](#permissions) required:** Jira admin or site admin: [global
|
|
66
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg)
|
|
67
|
+
*
|
|
68
|
+
* **License required:** Premium or Enterprise
|
|
69
|
+
*
|
|
70
|
+
* **Signed-in users only:** This API can't be accessed anonymously.
|
|
71
|
+
*
|
|
72
|
+
* @returns Returned if there is at least one valid issue to archive in the request. The
|
|
73
|
+
* return message will include the count of archived issues and subtasks, as well
|
|
74
|
+
* as error details for issues which failed to get archived.
|
|
75
|
+
*
|
|
76
|
+
* example: {
|
|
77
|
+
* "errors": {
|
|
78
|
+
* "issueIsSubtask": {
|
|
79
|
+
* "count": 3,
|
|
80
|
+
* "issueIdsOrKeys": [
|
|
81
|
+
* "ST-1",
|
|
82
|
+
* "ST-2",
|
|
83
|
+
* "ST-3"
|
|
84
|
+
* ],
|
|
85
|
+
* "message": "Issue is subtask."
|
|
86
|
+
* },
|
|
87
|
+
* "issuesInArchivedProjects": {
|
|
88
|
+
* "count": 2,
|
|
89
|
+
* "issueIdsOrKeys": [
|
|
90
|
+
* "AR-1",
|
|
91
|
+
* "AR-2"
|
|
92
|
+
* ],
|
|
93
|
+
* "message": "Issue exists in archived project."
|
|
94
|
+
* },
|
|
95
|
+
* "issuesInUnlicensedProjects": {
|
|
96
|
+
* "count": 3,
|
|
97
|
+
* "issueIdsOrKeys": [
|
|
98
|
+
* "UL-1",
|
|
99
|
+
* "UL-2",
|
|
100
|
+
* "UL-3"
|
|
101
|
+
* ],
|
|
102
|
+
* "message": "Issues with these IDs are in unlicensed projects."
|
|
103
|
+
* },
|
|
104
|
+
* "issuesNotFound": {
|
|
105
|
+
* "count": 3,
|
|
106
|
+
* "issueIdsOrKeys": [
|
|
107
|
+
* "PR-1",
|
|
108
|
+
* "PR-2",
|
|
109
|
+
* "PR-3"
|
|
110
|
+
* ],
|
|
111
|
+
* "message": "Issue not found."
|
|
112
|
+
* }
|
|
113
|
+
* },
|
|
114
|
+
* "numberOfIssuesUpdated": 10
|
|
115
|
+
* }
|
|
116
|
+
* @path {PUT} /rest/api/3/issue/archive
|
|
117
|
+
* @scopes-current write:jira-work
|
|
118
|
+
* @scopes-beta write:issue:jira
|
|
119
|
+
*/
|
|
120
|
+
archiveIssues({
|
|
121
|
+
issueArchivalSyncRequest,
|
|
122
|
+
}: {
|
|
123
|
+
/**
|
|
124
|
+
* Contains a list of issue keys or IDs to be archived.
|
|
125
|
+
*
|
|
126
|
+
* @example {
|
|
127
|
+
* "issueIdsOrKeys": [
|
|
128
|
+
* "PR-1",
|
|
129
|
+
* "1001",
|
|
130
|
+
* "PROJECT-2"
|
|
131
|
+
* ]
|
|
132
|
+
* }
|
|
133
|
+
*/
|
|
134
|
+
issueArchivalSyncRequest: IssueArchivalSyncRequest;
|
|
135
|
+
}): Promise<IssueArchivalSyncResponse> {
|
|
136
|
+
return this.getClientInstance()
|
|
137
|
+
.request({
|
|
138
|
+
path: "/rest/api/3/issue/archive",
|
|
139
|
+
method: "PUT",
|
|
140
|
+
headers: {
|
|
141
|
+
"Content-Type": "application/json",
|
|
142
|
+
},
|
|
143
|
+
body: issueArchivalSyncRequest,
|
|
144
|
+
})
|
|
145
|
+
.then(
|
|
146
|
+
this.getClientInstance().responseHandler({
|
|
147
|
+
200: {
|
|
148
|
+
"application/json": "json",
|
|
149
|
+
},
|
|
150
|
+
}),
|
|
151
|
+
)
|
|
152
|
+
.then(
|
|
153
|
+
commonHttpClient.castResponse<{
|
|
154
|
+
status: 200;
|
|
155
|
+
mediaType: "application/json";
|
|
156
|
+
body: IssueArchivalSyncResponse;
|
|
157
|
+
}>(),
|
|
158
|
+
)
|
|
159
|
+
.then(
|
|
160
|
+
validationSchemaStorage.validator(
|
|
161
|
+
"IssuesService.archiveIssues.response",
|
|
162
|
+
),
|
|
163
|
+
)
|
|
164
|
+
.then(commonHttpClient.getBody);
|
|
165
|
+
}
|
|
166
|
+
/**
|
|
167
|
+
* Enables admins to archive up to 100,000 issues in a single request using JQL,
|
|
168
|
+
* returning the URL to check the status of the submitted request.
|
|
169
|
+
*
|
|
170
|
+
* You can use the [get
|
|
171
|
+
* task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get)
|
|
172
|
+
* and [cancel
|
|
173
|
+
* task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-cancel-post)
|
|
174
|
+
* APIs to manage the request.
|
|
175
|
+
*
|
|
176
|
+
* **Note that:**
|
|
177
|
+
*
|
|
178
|
+
* * you can't archive subtasks directly, only through their parent issues
|
|
179
|
+
* * you can only archive issues from software, service management, and business
|
|
180
|
+
* projects
|
|
181
|
+
*
|
|
182
|
+
* **[Permissions](#permissions) required:** Jira admin or site admin: [global
|
|
183
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg)
|
|
184
|
+
*
|
|
185
|
+
* **License required:** Premium or Enterprise
|
|
186
|
+
*
|
|
187
|
+
* **Signed-in users only:** This API can't be accessed anonymously.
|
|
188
|
+
*
|
|
189
|
+
* **Rate limiting:** Only a single request per jira instance can be active at any
|
|
190
|
+
* given time.
|
|
191
|
+
*
|
|
192
|
+
* @returns Returns the URL to check the status of the submitted request.
|
|
193
|
+
*
|
|
194
|
+
* example: "https://your-domain.atlassian.net/rest/api/3/task/1010"
|
|
195
|
+
* @path {POST} /rest/api/3/issue/archive
|
|
196
|
+
* @scopes-current write:jira-work
|
|
197
|
+
* @scopes-beta write:issue:jira
|
|
198
|
+
*/
|
|
199
|
+
archiveIssuesAsync({
|
|
200
|
+
archiveIssueAsyncRequest,
|
|
201
|
+
}: {
|
|
202
|
+
/**
|
|
203
|
+
* A JQL query specifying the issues to archive. Note that subtasks can only be
|
|
204
|
+
* archived through their parent issues.
|
|
205
|
+
*
|
|
206
|
+
* @example {
|
|
207
|
+
* "jql": "project = FOO AND updated < -2y"
|
|
208
|
+
* }
|
|
209
|
+
*/
|
|
210
|
+
archiveIssueAsyncRequest: ArchiveIssueAsyncRequest;
|
|
211
|
+
}): Promise<string> {
|
|
212
|
+
return this.getClientInstance()
|
|
213
|
+
.request({
|
|
214
|
+
path: "/rest/api/3/issue/archive",
|
|
215
|
+
method: "POST",
|
|
216
|
+
headers: {
|
|
217
|
+
"Content-Type": "application/json",
|
|
218
|
+
},
|
|
219
|
+
body: archiveIssueAsyncRequest,
|
|
220
|
+
})
|
|
221
|
+
.then(
|
|
222
|
+
this.getClientInstance().responseHandler({
|
|
223
|
+
202: {
|
|
224
|
+
"application/json": "json",
|
|
225
|
+
},
|
|
226
|
+
}),
|
|
227
|
+
)
|
|
228
|
+
.then(
|
|
229
|
+
commonHttpClient.castResponse<{
|
|
230
|
+
status: 202;
|
|
231
|
+
mediaType: "application/json";
|
|
232
|
+
body: string;
|
|
233
|
+
}>(),
|
|
234
|
+
)
|
|
235
|
+
.then(
|
|
236
|
+
validationSchemaStorage.validator(
|
|
237
|
+
"IssuesService.archiveIssuesAsync.response",
|
|
238
|
+
),
|
|
239
|
+
)
|
|
240
|
+
.then(commonHttpClient.getBody);
|
|
241
|
+
}
|
|
242
|
+
/**
|
|
243
|
+
* Assigns an issue to a user. Use this operation when the calling user does not
|
|
244
|
+
* have the *Edit Issues* permission but has the *Assign issue* permission for the
|
|
245
|
+
* project that the issue is in.
|
|
246
|
+
*
|
|
247
|
+
* If `name` or `accountId` is set to:
|
|
248
|
+
*
|
|
249
|
+
* * `"-1"`, the issue is assigned to the default assignee for the project.
|
|
250
|
+
* * `null`, the issue is set to unassigned.
|
|
251
|
+
*
|
|
252
|
+
* This operation can be accessed anonymously.
|
|
253
|
+
*
|
|
254
|
+
* **[Permissions](#permissions) required:**
|
|
255
|
+
*
|
|
256
|
+
* * *Browse Projects* and *Assign Issues* [ project
|
|
257
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
|
|
258
|
+
* issue is in.
|
|
259
|
+
* * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
|
|
260
|
+
* configured, issue-level security permission to view the issue.
|
|
261
|
+
*
|
|
262
|
+
* @returns Returned if the request is successful.
|
|
263
|
+
* @path {PUT} /rest/api/3/issue/{issueIdOrKey}/assignee
|
|
264
|
+
* @scopes-current write:jira-work
|
|
265
|
+
* @scopes-beta write:issue:jira
|
|
266
|
+
*/
|
|
267
|
+
assignIssue({
|
|
268
|
+
issueIdOrKey,
|
|
269
|
+
user,
|
|
270
|
+
}: {
|
|
271
|
+
/** The ID or key of the issue to be assigned. */
|
|
272
|
+
issueIdOrKey: string;
|
|
273
|
+
/**
|
|
274
|
+
* The request object with the user that the issue is assigned to.
|
|
275
|
+
*
|
|
276
|
+
* @example {
|
|
277
|
+
* "accountId": "5b10ac8d82e05b22cc7d4ef5"
|
|
278
|
+
* }
|
|
279
|
+
*/
|
|
280
|
+
user: User;
|
|
281
|
+
}): Promise<void> {
|
|
282
|
+
return this.getClientInstance()
|
|
283
|
+
.request({
|
|
284
|
+
path: "/rest/api/3/issue/{issueIdOrKey}/assignee",
|
|
285
|
+
method: "PUT",
|
|
286
|
+
pathParams: {
|
|
287
|
+
issueIdOrKey,
|
|
288
|
+
},
|
|
289
|
+
headers: {
|
|
290
|
+
"Content-Type": "application/json",
|
|
291
|
+
},
|
|
292
|
+
body: user,
|
|
293
|
+
})
|
|
294
|
+
.then(
|
|
295
|
+
this.getClientInstance().responseHandler({
|
|
296
|
+
204: {
|
|
297
|
+
"application/json": "json",
|
|
298
|
+
},
|
|
299
|
+
}),
|
|
300
|
+
)
|
|
301
|
+
.then(
|
|
302
|
+
commonHttpClient.castResponse<{
|
|
303
|
+
status: 204;
|
|
304
|
+
mediaType: "application/json";
|
|
305
|
+
body: void;
|
|
306
|
+
}>(),
|
|
307
|
+
)
|
|
308
|
+
.then(
|
|
309
|
+
validationSchemaStorage.validator("IssuesService.assignIssue.response"),
|
|
310
|
+
)
|
|
311
|
+
.then(commonHttpClient.getBody);
|
|
312
|
+
}
|
|
313
|
+
/**
|
|
314
|
+
* Creates an issue or, where the option to create subtasks is enabled in Jira, a
|
|
315
|
+
* subtask. A transition may be applied, to move the issue or subtask to a
|
|
316
|
+
* workflow step other than the default start step, and issue properties set.
|
|
317
|
+
*
|
|
318
|
+
* The content of the issue or subtask is defined using `update` and `fields`. The
|
|
319
|
+
* fields that can be set in the issue or subtask are determined using the [ Get
|
|
320
|
+
* create issue metadata](#api-rest-api-3-issue-createmeta-get). These are the
|
|
321
|
+
* same fields that appear on the issue's create screen. Note that the
|
|
322
|
+
* `description`, `environment`, and any `textarea` type custom fields (multi-line
|
|
323
|
+
* text fields) take Atlassian Document Format content. Single line custom fields
|
|
324
|
+
* (`textfield`) accept a string and don't handle Atlassian Document Format
|
|
325
|
+
* content.
|
|
326
|
+
*
|
|
327
|
+
* Creating a subtask differs from creating an issue as follows:
|
|
328
|
+
*
|
|
329
|
+
* * `issueType` must be set to a subtask issue type (use [ Get create issue
|
|
330
|
+
* metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types).
|
|
331
|
+
* * `parent` must contain the ID or key of the parent issue.
|
|
332
|
+
*
|
|
333
|
+
* In a next-gen project any issue may be made a child providing that the parent
|
|
334
|
+
* and child are members of the same project.
|
|
335
|
+
*
|
|
336
|
+
* **[Permissions](#permissions) required:** *Browse projects* and *Create issues*
|
|
337
|
+
* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the
|
|
338
|
+
* project in which the issue or subtask is created.
|
|
339
|
+
*
|
|
340
|
+
* @returns Returned if the request is successful.
|
|
341
|
+
*
|
|
342
|
+
* example: {
|
|
343
|
+
* "id": "10000",
|
|
344
|
+
* "key": "ED-24",
|
|
345
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10000",
|
|
346
|
+
* "transition": {
|
|
347
|
+
* "status": 200,
|
|
348
|
+
* "errorCollection": {
|
|
349
|
+
* "errorMessages": [],
|
|
350
|
+
* "errors": {}
|
|
351
|
+
* }
|
|
352
|
+
* }
|
|
353
|
+
* }
|
|
354
|
+
* @path {POST} /rest/api/3/issue
|
|
355
|
+
* @scopes-current write:jira-work
|
|
356
|
+
* @scopes-beta write:issue:jira, write:comment:jira, write:comment.property:jira,
|
|
357
|
+
* write:attachment:jira, read:issue:jira
|
|
358
|
+
*/
|
|
359
|
+
createIssue({
|
|
360
|
+
updateHistory,
|
|
361
|
+
issueUpdateDetails,
|
|
362
|
+
}: {
|
|
363
|
+
/**
|
|
364
|
+
* Whether the project in which the issue is created is added to the user's
|
|
365
|
+
* **Recently viewed** project list, as shown under **Projects** in Jira. When
|
|
366
|
+
* provided, the issue type and request type are added to the user's history for a
|
|
367
|
+
* project. These values are then used to provide defaults on the issue create
|
|
368
|
+
* screen.
|
|
369
|
+
*/
|
|
370
|
+
updateHistory?: boolean;
|
|
371
|
+
/**
|
|
372
|
+
* @example {
|
|
373
|
+
* "fields": {
|
|
374
|
+
* "assignee": {
|
|
375
|
+
* "id": "5b109f2e9729b51b54dc274d"
|
|
376
|
+
* },
|
|
377
|
+
* "components": [
|
|
378
|
+
* {
|
|
379
|
+
* "id": "10000"
|
|
380
|
+
* }
|
|
381
|
+
* ],
|
|
382
|
+
* "customfield_10000": "09/Jun/19",
|
|
383
|
+
* "customfield_20000": "06/Jul/19 3:25 PM",
|
|
384
|
+
* "customfield_30000": [
|
|
385
|
+
* "10000",
|
|
386
|
+
* "10002"
|
|
387
|
+
* ],
|
|
388
|
+
* "customfield_40000": {
|
|
389
|
+
* "content": [
|
|
390
|
+
* {
|
|
391
|
+
* "content": [
|
|
392
|
+
* {
|
|
393
|
+
* "text": "Occurs on all orders",
|
|
394
|
+
* "type": "text"
|
|
395
|
+
* }
|
|
396
|
+
* ],
|
|
397
|
+
* "type": "paragraph"
|
|
398
|
+
* }
|
|
399
|
+
* ],
|
|
400
|
+
* "type": "doc",
|
|
401
|
+
* "version": 1
|
|
402
|
+
* },
|
|
403
|
+
* "customfield_50000": {
|
|
404
|
+
* "content": [
|
|
405
|
+
* {
|
|
406
|
+
* "content": [
|
|
407
|
+
* {
|
|
408
|
+
* "text": "Could impact day-to-day work.",
|
|
409
|
+
* "type": "text"
|
|
410
|
+
* }
|
|
411
|
+
* ],
|
|
412
|
+
* "type": "paragraph"
|
|
413
|
+
* }
|
|
414
|
+
* ],
|
|
415
|
+
* "type": "doc",
|
|
416
|
+
* "version": 1
|
|
417
|
+
* },
|
|
418
|
+
* "customfield_60000": "jira-software-users",
|
|
419
|
+
* "customfield_70000": [
|
|
420
|
+
* "jira-administrators",
|
|
421
|
+
* "jira-software-users"
|
|
422
|
+
* ],
|
|
423
|
+
* "customfield_80000": {
|
|
424
|
+
* "value": "red"
|
|
425
|
+
* },
|
|
426
|
+
* "description": {
|
|
427
|
+
* "content": [
|
|
428
|
+
* {
|
|
429
|
+
* "content": [
|
|
430
|
+
* {
|
|
431
|
+
* "text": "Order entry fails when selecting
|
|
432
|
+
* supplier.",
|
|
433
|
+
* "type": "text"
|
|
434
|
+
* }
|
|
435
|
+
* ],
|
|
436
|
+
* "type": "paragraph"
|
|
437
|
+
* }
|
|
438
|
+
* ],
|
|
439
|
+
* "type": "doc",
|
|
440
|
+
* "version": 1
|
|
441
|
+
* },
|
|
442
|
+
* "duedate": "2019-05-11",
|
|
443
|
+
* "environment": {
|
|
444
|
+
* "content": [
|
|
445
|
+
* {
|
|
446
|
+
* "content": [
|
|
447
|
+
* {
|
|
448
|
+
* "text": "UAT",
|
|
449
|
+
* "type": "text"
|
|
450
|
+
* }
|
|
451
|
+
* ],
|
|
452
|
+
* "type": "paragraph"
|
|
453
|
+
* }
|
|
454
|
+
* ],
|
|
455
|
+
* "type": "doc",
|
|
456
|
+
* "version": 1
|
|
457
|
+
* },
|
|
458
|
+
* "fixVersions": [
|
|
459
|
+
* {
|
|
460
|
+
* "id": "10001"
|
|
461
|
+
* }
|
|
462
|
+
* ],
|
|
463
|
+
* "issuetype": {
|
|
464
|
+
* "id": "10000"
|
|
465
|
+
* },
|
|
466
|
+
* "labels": [
|
|
467
|
+
* "bugfix",
|
|
468
|
+
* "blitz_test"
|
|
469
|
+
* ],
|
|
470
|
+
* "parent": {
|
|
471
|
+
* "key": "PROJ-123"
|
|
472
|
+
* },
|
|
473
|
+
* "priority": {
|
|
474
|
+
* "id": "20000"
|
|
475
|
+
* },
|
|
476
|
+
* "project": {
|
|
477
|
+
* "id": "10000"
|
|
478
|
+
* },
|
|
479
|
+
* "reporter": {
|
|
480
|
+
* "id": "5b10a2844c20165700ede21g"
|
|
481
|
+
* },
|
|
482
|
+
* "security": {
|
|
483
|
+
* "id": "10000"
|
|
484
|
+
* },
|
|
485
|
+
* "summary": "Main order flow broken",
|
|
486
|
+
* "timetracking": {
|
|
487
|
+
* "originalEstimate": "10",
|
|
488
|
+
* "remainingEstimate": "5"
|
|
489
|
+
* },
|
|
490
|
+
* "versions": [
|
|
491
|
+
* {
|
|
492
|
+
* "id": "10000"
|
|
493
|
+
* }
|
|
494
|
+
* ]
|
|
495
|
+
* },
|
|
496
|
+
* "update": {}
|
|
497
|
+
* }
|
|
498
|
+
*/
|
|
499
|
+
issueUpdateDetails: IssueUpdateDetails;
|
|
500
|
+
}): Promise<CreatedIssue> {
|
|
501
|
+
return this.getClientInstance()
|
|
502
|
+
.request({
|
|
503
|
+
path: "/rest/api/3/issue",
|
|
504
|
+
method: "POST",
|
|
505
|
+
query: {
|
|
506
|
+
updateHistory,
|
|
507
|
+
},
|
|
508
|
+
headers: {
|
|
509
|
+
"Content-Type": "application/json",
|
|
510
|
+
},
|
|
511
|
+
body: issueUpdateDetails,
|
|
512
|
+
})
|
|
513
|
+
.then(
|
|
514
|
+
this.getClientInstance().responseHandler({
|
|
515
|
+
201: {
|
|
516
|
+
"application/json": "json",
|
|
517
|
+
},
|
|
518
|
+
}),
|
|
519
|
+
)
|
|
520
|
+
.then(
|
|
521
|
+
commonHttpClient.castResponse<{
|
|
522
|
+
status: 201;
|
|
523
|
+
mediaType: "application/json";
|
|
524
|
+
body: CreatedIssue;
|
|
525
|
+
}>(),
|
|
526
|
+
)
|
|
527
|
+
.then(
|
|
528
|
+
validationSchemaStorage.validator("IssuesService.createIssue.response"),
|
|
529
|
+
)
|
|
530
|
+
.then(commonHttpClient.getBody);
|
|
531
|
+
}
|
|
532
|
+
/**
|
|
533
|
+
* Creates upto **50** issues and, where the option to create subtasks is enabled
|
|
534
|
+
* in Jira, subtasks. Transitions may be applied, to move the issues or subtasks
|
|
535
|
+
* to a workflow step other than the default start step, and issue properties set.
|
|
536
|
+
*
|
|
537
|
+
* The content of each issue or subtask is defined using `update` and `fields`.
|
|
538
|
+
* The fields that can be set in the issue or subtask are determined using the [
|
|
539
|
+
* Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These are the
|
|
540
|
+
* same fields that appear on the issues' create screens. Note that the
|
|
541
|
+
* `description`, `environment`, and any `textarea` type custom fields (multi-line
|
|
542
|
+
* text fields) take Atlassian Document Format content. Single line custom fields
|
|
543
|
+
* (`textfield`) accept a string and don't handle Atlassian Document Format
|
|
544
|
+
* content.
|
|
545
|
+
*
|
|
546
|
+
* Creating a subtask differs from creating an issue as follows:
|
|
547
|
+
*
|
|
548
|
+
* * `issueType` must be set to a subtask issue type (use [ Get create issue
|
|
549
|
+
* metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types).
|
|
550
|
+
* * `parent` the must contain the ID or key of the parent issue.
|
|
551
|
+
*
|
|
552
|
+
* **[Permissions](#permissions) required:** *Browse projects* and *Create issues*
|
|
553
|
+
* [project permissions](https://confluence.atlassian.com/x/yodKLg) for the
|
|
554
|
+
* project in which each issue or subtask is created.
|
|
555
|
+
*
|
|
556
|
+
* @returns Returned if any of the issue or subtask creation requests were successful. A
|
|
557
|
+
* request may be unsuccessful when it:
|
|
558
|
+
*
|
|
559
|
+
* * is missing required fields.
|
|
560
|
+
* * contains invalid field values.
|
|
561
|
+
* * contains fields that cannot be set for the issue type.
|
|
562
|
+
* * is by a user who does not have the necessary permission.
|
|
563
|
+
* * is to create a subtype in a project different that of the parent issue.
|
|
564
|
+
* * is for a subtask when the option to create subtasks is disabled.
|
|
565
|
+
* * is invalid for any other reason.
|
|
566
|
+
*
|
|
567
|
+
* example: {
|
|
568
|
+
* "issues": [
|
|
569
|
+
* {
|
|
570
|
+
* "id": "10000",
|
|
571
|
+
* "key": "ED-24",
|
|
572
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10000",
|
|
573
|
+
* "transition": {
|
|
574
|
+
* "status": 200,
|
|
575
|
+
* "errorCollection": {
|
|
576
|
+
* "errorMessages": [],
|
|
577
|
+
* "errors": {}
|
|
578
|
+
* }
|
|
579
|
+
* }
|
|
580
|
+
* },
|
|
581
|
+
* {
|
|
582
|
+
* "id": "10001",
|
|
583
|
+
* "key": "ED-25",
|
|
584
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001"
|
|
585
|
+
* }
|
|
586
|
+
* ],
|
|
587
|
+
* "errors": []
|
|
588
|
+
* }
|
|
589
|
+
* @path {POST} /rest/api/3/issue/bulk
|
|
590
|
+
* @scopes-current write:jira-work
|
|
591
|
+
* @scopes-beta write:issue:jira, write:comment:jira, write:comment.property:jira,
|
|
592
|
+
* write:attachment:jira, read:issue:jira
|
|
593
|
+
*/
|
|
594
|
+
createIssues({
|
|
595
|
+
issuesUpdateBean,
|
|
596
|
+
}: {
|
|
597
|
+
/**
|
|
598
|
+
* @example {
|
|
599
|
+
* "issueUpdates": [
|
|
600
|
+
* {
|
|
601
|
+
* "fields": {
|
|
602
|
+
* "assignee": {
|
|
603
|
+
* "id": "5b109f2e9729b51b54dc274d"
|
|
604
|
+
* },
|
|
605
|
+
* "components": [
|
|
606
|
+
* {
|
|
607
|
+
* "id": "10000"
|
|
608
|
+
* }
|
|
609
|
+
* ],
|
|
610
|
+
* "customfield_10000": "09/Jun/19",
|
|
611
|
+
* "customfield_20000": "06/Jul/19 3:25 PM",
|
|
612
|
+
* "customfield_30000": [
|
|
613
|
+
* "10000",
|
|
614
|
+
* "10002"
|
|
615
|
+
* ],
|
|
616
|
+
* "customfield_40000": {
|
|
617
|
+
* "content": [
|
|
618
|
+
* {
|
|
619
|
+
* "content": [
|
|
620
|
+
* {
|
|
621
|
+
* "text": "Occurs on all orders",
|
|
622
|
+
* "type": "text"
|
|
623
|
+
* }
|
|
624
|
+
* ],
|
|
625
|
+
* "type": "paragraph"
|
|
626
|
+
* }
|
|
627
|
+
* ],
|
|
628
|
+
* "type": "doc",
|
|
629
|
+
* "version": 1
|
|
630
|
+
* },
|
|
631
|
+
* "customfield_50000": {
|
|
632
|
+
* "content": [
|
|
633
|
+
* {
|
|
634
|
+
* "content": [
|
|
635
|
+
* {
|
|
636
|
+
* "text": "Could impact day-to-day work.",
|
|
637
|
+
* "type": "text"
|
|
638
|
+
* }
|
|
639
|
+
* ],
|
|
640
|
+
* "type": "paragraph"
|
|
641
|
+
* }
|
|
642
|
+
* ],
|
|
643
|
+
* "type": "doc",
|
|
644
|
+
* "version": 1
|
|
645
|
+
* },
|
|
646
|
+
* "customfield_60000": "jira-software-users",
|
|
647
|
+
* "customfield_70000": [
|
|
648
|
+
* "jira-administrators",
|
|
649
|
+
* "jira-software-users"
|
|
650
|
+
* ],
|
|
651
|
+
* "customfield_80000": {
|
|
652
|
+
* "value": "red"
|
|
653
|
+
* },
|
|
654
|
+
* "description": {
|
|
655
|
+
* "content": [
|
|
656
|
+
* {
|
|
657
|
+
* "content": [
|
|
658
|
+
* {
|
|
659
|
+
* "text": "Order entry fails when selecting
|
|
660
|
+
* supplier.",
|
|
661
|
+
* "type": "text"
|
|
662
|
+
* }
|
|
663
|
+
* ],
|
|
664
|
+
* "type": "paragraph"
|
|
665
|
+
* }
|
|
666
|
+
* ],
|
|
667
|
+
* "type": "doc",
|
|
668
|
+
* "version": 1
|
|
669
|
+
* },
|
|
670
|
+
* "duedate": "2011-03-11",
|
|
671
|
+
* "environment": {
|
|
672
|
+
* "content": [
|
|
673
|
+
* {
|
|
674
|
+
* "content": [
|
|
675
|
+
* {
|
|
676
|
+
* "text": "UAT",
|
|
677
|
+
* "type": "text"
|
|
678
|
+
* }
|
|
679
|
+
* ],
|
|
680
|
+
* "type": "paragraph"
|
|
681
|
+
* }
|
|
682
|
+
* ],
|
|
683
|
+
* "type": "doc",
|
|
684
|
+
* "version": 1
|
|
685
|
+
* },
|
|
686
|
+
* "fixVersions": [
|
|
687
|
+
* {
|
|
688
|
+
* "id": "10001"
|
|
689
|
+
* }
|
|
690
|
+
* ],
|
|
691
|
+
* "issuetype": {
|
|
692
|
+
* "id": "10000"
|
|
693
|
+
* },
|
|
694
|
+
* "labels": [
|
|
695
|
+
* "bugfix",
|
|
696
|
+
* "blitz_test"
|
|
697
|
+
* ],
|
|
698
|
+
* "priority": {
|
|
699
|
+
* "id": "20000"
|
|
700
|
+
* },
|
|
701
|
+
* "project": {
|
|
702
|
+
* "id": "10000"
|
|
703
|
+
* },
|
|
704
|
+
* "reporter": {
|
|
705
|
+
* "id": "5b10a2844c20165700ede21g"
|
|
706
|
+
* },
|
|
707
|
+
* "security": {
|
|
708
|
+
* "id": "10000"
|
|
709
|
+
* },
|
|
710
|
+
* "summary": "Main order flow broken",
|
|
711
|
+
* "timetracking": {
|
|
712
|
+
* "originalEstimate": "10",
|
|
713
|
+
* "remainingEstimate": "5"
|
|
714
|
+
* },
|
|
715
|
+
* "versions": [
|
|
716
|
+
* {
|
|
717
|
+
* "id": "10000"
|
|
718
|
+
* }
|
|
719
|
+
* ]
|
|
720
|
+
* },
|
|
721
|
+
* "update": {
|
|
722
|
+
* "worklog": [
|
|
723
|
+
* {
|
|
724
|
+
* "add": {
|
|
725
|
+
* "started": "2019-07-05T11:05:00.000+0000",
|
|
726
|
+
* "timeSpent": "60m"
|
|
727
|
+
* }
|
|
728
|
+
* }
|
|
729
|
+
* ]
|
|
730
|
+
* }
|
|
731
|
+
* },
|
|
732
|
+
* {
|
|
733
|
+
* "fields": {
|
|
734
|
+
* "assignee": {
|
|
735
|
+
* "id": "5b109f2e9729b51b54dc274d"
|
|
736
|
+
* },
|
|
737
|
+
* "components": [
|
|
738
|
+
* {
|
|
739
|
+
* "id": "10000"
|
|
740
|
+
* }
|
|
741
|
+
* ],
|
|
742
|
+
* "customfield_10000": "09/Jun/19",
|
|
743
|
+
* "customfield_20000": "06/Jul/19 3:25 PM",
|
|
744
|
+
* "customfield_30000": [
|
|
745
|
+
* "10000",
|
|
746
|
+
* "10002"
|
|
747
|
+
* ],
|
|
748
|
+
* "customfield_40000": {
|
|
749
|
+
* "content": [
|
|
750
|
+
* {
|
|
751
|
+
* "content": [
|
|
752
|
+
* {
|
|
753
|
+
* "text": "Occurs on all orders",
|
|
754
|
+
* "type": "text"
|
|
755
|
+
* }
|
|
756
|
+
* ],
|
|
757
|
+
* "type": "paragraph"
|
|
758
|
+
* }
|
|
759
|
+
* ],
|
|
760
|
+
* "type": "doc",
|
|
761
|
+
* "version": 1
|
|
762
|
+
* },
|
|
763
|
+
* "customfield_50000": {
|
|
764
|
+
* "content": [
|
|
765
|
+
* {
|
|
766
|
+
* "content": [
|
|
767
|
+
* {
|
|
768
|
+
* "text": "Could impact day-to-day work.",
|
|
769
|
+
* "type": "text"
|
|
770
|
+
* }
|
|
771
|
+
* ],
|
|
772
|
+
* "type": "paragraph"
|
|
773
|
+
* }
|
|
774
|
+
* ],
|
|
775
|
+
* "type": "doc",
|
|
776
|
+
* "version": 1
|
|
777
|
+
* },
|
|
778
|
+
* "customfield_60000": "jira-software-users",
|
|
779
|
+
* "customfield_70000": [
|
|
780
|
+
* "jira-administrators",
|
|
781
|
+
* "jira-software-users"
|
|
782
|
+
* ],
|
|
783
|
+
* "customfield_80000": {
|
|
784
|
+
* "value": "red"
|
|
785
|
+
* },
|
|
786
|
+
* "description": {
|
|
787
|
+
* "content": [
|
|
788
|
+
* {
|
|
789
|
+
* "content": [
|
|
790
|
+
* {
|
|
791
|
+
* "text": "Order remains pending after
|
|
792
|
+
* approved.",
|
|
793
|
+
* "type": "text"
|
|
794
|
+
* }
|
|
795
|
+
* ],
|
|
796
|
+
* "type": "paragraph"
|
|
797
|
+
* }
|
|
798
|
+
* ],
|
|
799
|
+
* "type": "doc",
|
|
800
|
+
* "version": 1
|
|
801
|
+
* },
|
|
802
|
+
* "duedate": "2019-04-16",
|
|
803
|
+
* "environment": {
|
|
804
|
+
* "content": [
|
|
805
|
+
* {
|
|
806
|
+
* "content": [
|
|
807
|
+
* {
|
|
808
|
+
* "text": "UAT",
|
|
809
|
+
* "type": "text"
|
|
810
|
+
* }
|
|
811
|
+
* ],
|
|
812
|
+
* "type": "paragraph"
|
|
813
|
+
* }
|
|
814
|
+
* ],
|
|
815
|
+
* "type": "doc",
|
|
816
|
+
* "version": 1
|
|
817
|
+
* },
|
|
818
|
+
* "fixVersions": [
|
|
819
|
+
* {
|
|
820
|
+
* "id": "10001"
|
|
821
|
+
* }
|
|
822
|
+
* ],
|
|
823
|
+
* "issuetype": {
|
|
824
|
+
* "id": "10000"
|
|
825
|
+
* },
|
|
826
|
+
* "labels": [
|
|
827
|
+
* "new_release"
|
|
828
|
+
* ],
|
|
829
|
+
* "priority": {
|
|
830
|
+
* "id": "20000"
|
|
831
|
+
* },
|
|
832
|
+
* "project": {
|
|
833
|
+
* "id": "1000"
|
|
834
|
+
* },
|
|
835
|
+
* "reporter": {
|
|
836
|
+
* "id": "5b10a2844c20165700ede21g"
|
|
837
|
+
* },
|
|
838
|
+
* "security": {
|
|
839
|
+
* "id": "10000"
|
|
840
|
+
* },
|
|
841
|
+
* "summary": "Order stuck in pending",
|
|
842
|
+
* "timetracking": {
|
|
843
|
+
* "originalEstimate": "15",
|
|
844
|
+
* "remainingEstimate": "5"
|
|
845
|
+
* },
|
|
846
|
+
* "versions": [
|
|
847
|
+
* {
|
|
848
|
+
* "id": "10000"
|
|
849
|
+
* }
|
|
850
|
+
* ]
|
|
851
|
+
* },
|
|
852
|
+
* "update": {}
|
|
853
|
+
* }
|
|
854
|
+
* ]
|
|
855
|
+
* }
|
|
856
|
+
*/
|
|
857
|
+
issuesUpdateBean: IssuesUpdateBean;
|
|
858
|
+
}): Promise<CreatedIssues> {
|
|
859
|
+
return this.getClientInstance()
|
|
860
|
+
.request({
|
|
861
|
+
path: "/rest/api/3/issue/bulk",
|
|
862
|
+
method: "POST",
|
|
863
|
+
headers: {
|
|
864
|
+
"Content-Type": "application/json",
|
|
865
|
+
},
|
|
866
|
+
body: issuesUpdateBean,
|
|
867
|
+
})
|
|
868
|
+
.then(
|
|
869
|
+
this.getClientInstance().responseHandler({
|
|
870
|
+
201: {
|
|
871
|
+
"application/json": "json",
|
|
872
|
+
},
|
|
873
|
+
}),
|
|
874
|
+
)
|
|
875
|
+
.then(
|
|
876
|
+
commonHttpClient.castResponse<{
|
|
877
|
+
status: 201;
|
|
878
|
+
mediaType: "application/json";
|
|
879
|
+
body: CreatedIssues;
|
|
880
|
+
}>(),
|
|
881
|
+
)
|
|
882
|
+
.then(
|
|
883
|
+
validationSchemaStorage.validator(
|
|
884
|
+
"IssuesService.createIssues.response",
|
|
885
|
+
),
|
|
886
|
+
)
|
|
887
|
+
.then(commonHttpClient.getBody);
|
|
888
|
+
}
|
|
889
|
+
/**
|
|
890
|
+
* Deletes an issue.
|
|
891
|
+
*
|
|
892
|
+
* An issue cannot be deleted if it has one or more subtasks. To delete an issue
|
|
893
|
+
* with subtasks, set `deleteSubtasks`. This causes the issue's subtasks to be
|
|
894
|
+
* deleted with the issue.
|
|
895
|
+
*
|
|
896
|
+
* This operation can be accessed anonymously.
|
|
897
|
+
*
|
|
898
|
+
* **[Permissions](#permissions) required:**
|
|
899
|
+
*
|
|
900
|
+
* * *Browse projects* and *Delete issues* [project
|
|
901
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) for the project
|
|
902
|
+
* containing the issue.
|
|
903
|
+
* * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
|
|
904
|
+
* configured, issue-level security permission to view the issue.
|
|
905
|
+
*
|
|
906
|
+
* @path {DELETE} /rest/api/3/issue/{issueIdOrKey}
|
|
907
|
+
* @scopes-current write:jira-work
|
|
908
|
+
* @scopes-beta delete:issue:jira
|
|
909
|
+
*/
|
|
910
|
+
deleteIssue({
|
|
911
|
+
issueIdOrKey,
|
|
912
|
+
deleteSubtasks,
|
|
913
|
+
}: {
|
|
914
|
+
/** The ID or key of the issue. */
|
|
915
|
+
issueIdOrKey: string;
|
|
916
|
+
/** Whether the issue's subtasks are deleted when the issue is deleted. */
|
|
917
|
+
deleteSubtasks?: "true" | "false";
|
|
918
|
+
}): Promise<void> {
|
|
919
|
+
return this.getClientInstance()
|
|
920
|
+
.request({
|
|
921
|
+
path: "/rest/api/3/issue/{issueIdOrKey}",
|
|
922
|
+
method: "DELETE",
|
|
923
|
+
pathParams: {
|
|
924
|
+
issueIdOrKey,
|
|
925
|
+
},
|
|
926
|
+
query: {
|
|
927
|
+
deleteSubtasks,
|
|
928
|
+
},
|
|
929
|
+
})
|
|
930
|
+
.then(commonHttpClient.discardResult);
|
|
931
|
+
}
|
|
932
|
+
/**
|
|
933
|
+
* Performs an issue transition and, if the transition has a screen, updates the
|
|
934
|
+
* fields from the transition screen.
|
|
935
|
+
*
|
|
936
|
+
* sortByCategory To update the fields on the transition screen, specify the
|
|
937
|
+
* fields in the `fields` or `update` parameters in the request body. Get details
|
|
938
|
+
* about the fields using [ Get
|
|
939
|
+
* transitions](#api-rest-api-3-issue-issueIdOrKey-transitions-get) with the
|
|
940
|
+
* `transitions.fields` expand.
|
|
941
|
+
*
|
|
942
|
+
* This operation can be accessed anonymously.
|
|
943
|
+
*
|
|
944
|
+
* **[Permissions](#permissions) required:**
|
|
945
|
+
*
|
|
946
|
+
* * *Browse projects* and *Transition issues* [project
|
|
947
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
|
|
948
|
+
* issue is in.
|
|
949
|
+
* * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
|
|
950
|
+
* configured, issue-level security permission to view the issue.
|
|
951
|
+
*
|
|
952
|
+
* @returns Returned if the request is successful.
|
|
953
|
+
* @path {POST} /rest/api/3/issue/{issueIdOrKey}/transitions
|
|
954
|
+
* @scopes-current write:jira-work
|
|
955
|
+
* @scopes-beta write:issue:jira, write:issue.property:jira
|
|
956
|
+
*/
|
|
957
|
+
doTransition({
|
|
958
|
+
issueIdOrKey,
|
|
959
|
+
issueUpdateDetails,
|
|
960
|
+
}: {
|
|
961
|
+
/** The ID or key of the issue. */
|
|
962
|
+
issueIdOrKey: string;
|
|
963
|
+
/**
|
|
964
|
+
* @example {
|
|
965
|
+
* "fields": {
|
|
966
|
+
* "assignee": {
|
|
967
|
+
* "name": "bob"
|
|
968
|
+
* },
|
|
969
|
+
* "resolution": {
|
|
970
|
+
* "name": "Fixed"
|
|
971
|
+
* }
|
|
972
|
+
* },
|
|
973
|
+
* "historyMetadata": {
|
|
974
|
+
* "activityDescription": "Complete order processing",
|
|
975
|
+
* "actor": {
|
|
976
|
+
* "avatarUrl": "http://mysystem/avatar/tony.jpg",
|
|
977
|
+
* "displayName": "Tony",
|
|
978
|
+
* "id": "tony",
|
|
979
|
+
* "type": "mysystem-user",
|
|
980
|
+
* "url": "http://mysystem/users/tony"
|
|
981
|
+
* },
|
|
982
|
+
* "cause": {
|
|
983
|
+
* "id": "myevent",
|
|
984
|
+
* "type": "mysystem-event"
|
|
985
|
+
* },
|
|
986
|
+
* "description": "From the order testing process",
|
|
987
|
+
* "extraData": {
|
|
988
|
+
* "Iteration": "10a",
|
|
989
|
+
* "Step": "4"
|
|
990
|
+
* },
|
|
991
|
+
* "generator": {
|
|
992
|
+
* "id": "mysystem-1",
|
|
993
|
+
* "type": "mysystem-application"
|
|
994
|
+
* },
|
|
995
|
+
* "type": "myplugin:type"
|
|
996
|
+
* },
|
|
997
|
+
* "transition": {
|
|
998
|
+
* "id": "5"
|
|
999
|
+
* },
|
|
1000
|
+
* "update": {
|
|
1001
|
+
* "comment": [
|
|
1002
|
+
* {
|
|
1003
|
+
* "add": {
|
|
1004
|
+
* "body": {
|
|
1005
|
+
* "content": [
|
|
1006
|
+
* {
|
|
1007
|
+
* "content": [
|
|
1008
|
+
* {
|
|
1009
|
+
* "text": "Bug has been fixed",
|
|
1010
|
+
* "type": "text"
|
|
1011
|
+
* }
|
|
1012
|
+
* ],
|
|
1013
|
+
* "type": "paragraph"
|
|
1014
|
+
* }
|
|
1015
|
+
* ],
|
|
1016
|
+
* "type": "doc",
|
|
1017
|
+
* "version": 1
|
|
1018
|
+
* }
|
|
1019
|
+
* }
|
|
1020
|
+
* }
|
|
1021
|
+
* ]
|
|
1022
|
+
* }
|
|
1023
|
+
* }
|
|
1024
|
+
*/
|
|
1025
|
+
issueUpdateDetails: IssueUpdateDetails;
|
|
1026
|
+
}): Promise<void> {
|
|
1027
|
+
return this.getClientInstance()
|
|
1028
|
+
.request({
|
|
1029
|
+
path: "/rest/api/3/issue/{issueIdOrKey}/transitions",
|
|
1030
|
+
method: "POST",
|
|
1031
|
+
pathParams: {
|
|
1032
|
+
issueIdOrKey,
|
|
1033
|
+
},
|
|
1034
|
+
headers: {
|
|
1035
|
+
"Content-Type": "application/json",
|
|
1036
|
+
},
|
|
1037
|
+
body: issueUpdateDetails,
|
|
1038
|
+
})
|
|
1039
|
+
.then(
|
|
1040
|
+
this.getClientInstance().responseHandler({
|
|
1041
|
+
204: {
|
|
1042
|
+
"application/json": "json",
|
|
1043
|
+
},
|
|
1044
|
+
}),
|
|
1045
|
+
)
|
|
1046
|
+
.then(
|
|
1047
|
+
commonHttpClient.castResponse<{
|
|
1048
|
+
status: 204;
|
|
1049
|
+
mediaType: "application/json";
|
|
1050
|
+
body: void;
|
|
1051
|
+
}>(),
|
|
1052
|
+
)
|
|
1053
|
+
.then(
|
|
1054
|
+
validationSchemaStorage.validator(
|
|
1055
|
+
"IssuesService.doTransition.response",
|
|
1056
|
+
),
|
|
1057
|
+
)
|
|
1058
|
+
.then(commonHttpClient.getBody);
|
|
1059
|
+
}
|
|
1060
|
+
/**
|
|
1061
|
+
* Edits an issue. Issue properties may be updated as part of the edit. Please
|
|
1062
|
+
* note that issue transition will be ignored as it is not supported yet.
|
|
1063
|
+
*
|
|
1064
|
+
* The edits to the issue's fields are defined using `update` and `fields`. The
|
|
1065
|
+
* fields that can be edited are determined using [ Get edit issue
|
|
1066
|
+
* metadata](#api-rest-api-3-issue-issueIdOrKey-editmeta-get).
|
|
1067
|
+
*
|
|
1068
|
+
* The parent field may be set by key or ID. For standard issue types, the parent
|
|
1069
|
+
* may be removed by setting `update.parent.set.none` to *true*. Note that the
|
|
1070
|
+
* `description`, `environment`, and any `textarea` type custom fields (multi-line
|
|
1071
|
+
* text fields) take Atlassian Document Format content. Single line custom fields
|
|
1072
|
+
* (`textfield`) accept a string and don't handle Atlassian Document Format
|
|
1073
|
+
* content.
|
|
1074
|
+
*
|
|
1075
|
+
* Connect apps having an app user with *Administer Jira* [global
|
|
1076
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting
|
|
1077
|
+
* on behalf of users with *Administer Jira* [global
|
|
1078
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg), can override the screen
|
|
1079
|
+
* security configuration using `overrideScreenSecurity` and
|
|
1080
|
+
* `overrideEditableFlag`.
|
|
1081
|
+
*
|
|
1082
|
+
* This operation can be accessed anonymously.
|
|
1083
|
+
*
|
|
1084
|
+
* **[Permissions](#permissions) required:**
|
|
1085
|
+
*
|
|
1086
|
+
* * *Browse projects* and *Edit issues* [project
|
|
1087
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
|
|
1088
|
+
* issue is in.
|
|
1089
|
+
* * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
|
|
1090
|
+
* configured, issue-level security permission to view the issue.
|
|
1091
|
+
*
|
|
1092
|
+
* @returns * status: 200, mediaType: application/json
|
|
1093
|
+
*
|
|
1094
|
+
* Returned if the request is successful and the `returnIssue` parameter is
|
|
1095
|
+
* `true`
|
|
1096
|
+
*
|
|
1097
|
+
* * status: 204, mediaType: application/json
|
|
1098
|
+
*
|
|
1099
|
+
* Returned if the request is successful.
|
|
1100
|
+
* @path {PUT} /rest/api/3/issue/{issueIdOrKey}
|
|
1101
|
+
* @scopes-current write:jira-work
|
|
1102
|
+
* @scopes-beta write:issue:jira
|
|
1103
|
+
*/
|
|
1104
|
+
editIssue({
|
|
1105
|
+
issueIdOrKey,
|
|
1106
|
+
notifyUsers,
|
|
1107
|
+
overrideScreenSecurity,
|
|
1108
|
+
overrideEditableFlag,
|
|
1109
|
+
returnIssue,
|
|
1110
|
+
expand,
|
|
1111
|
+
issueUpdateDetails,
|
|
1112
|
+
}: {
|
|
1113
|
+
/** The ID or key of the issue. */
|
|
1114
|
+
issueIdOrKey: string;
|
|
1115
|
+
/**
|
|
1116
|
+
* Whether a notification email about the issue update is sent to all watchers. To
|
|
1117
|
+
* disable the notification, administer Jira or administer project permissions are
|
|
1118
|
+
* required. If the user doesn't have the necessary permission the request is
|
|
1119
|
+
* ignored.
|
|
1120
|
+
*/
|
|
1121
|
+
notifyUsers?: boolean;
|
|
1122
|
+
/**
|
|
1123
|
+
* Whether screen security is overridden to enable hidden fields to be edited.
|
|
1124
|
+
* Available to Connect app users with *Administer Jira* [global
|
|
1125
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on
|
|
1126
|
+
* behalf of users with *Administer Jira* [global
|
|
1127
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
1128
|
+
*/
|
|
1129
|
+
overrideScreenSecurity?: boolean;
|
|
1130
|
+
/**
|
|
1131
|
+
* Whether screen security is overridden to enable uneditable fields to be edited.
|
|
1132
|
+
* Available to Connect app users with *Administer Jira* [global
|
|
1133
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on
|
|
1134
|
+
* behalf of users with *Administer Jira* [global
|
|
1135
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
1136
|
+
*/
|
|
1137
|
+
overrideEditableFlag?: boolean;
|
|
1138
|
+
/**
|
|
1139
|
+
* Whether the response should contain the issue with fields edited in this
|
|
1140
|
+
* request. The returned issue will have the same format as in the [Get issue
|
|
1141
|
+
* API](#api-rest-api-3-issue-issueidorkey-get).
|
|
1142
|
+
*/
|
|
1143
|
+
returnIssue?: boolean;
|
|
1144
|
+
/**
|
|
1145
|
+
* The Get issue API expand parameter to use in the response if the `returnIssue`
|
|
1146
|
+
* parameter is `true`.
|
|
1147
|
+
*/
|
|
1148
|
+
expand?: string;
|
|
1149
|
+
/**
|
|
1150
|
+
* @example {
|
|
1151
|
+
* "fields": {
|
|
1152
|
+
* "customfield_10000": {
|
|
1153
|
+
* "content": [
|
|
1154
|
+
* {
|
|
1155
|
+
* "content": [
|
|
1156
|
+
* {
|
|
1157
|
+
* "text": "Investigation underway",
|
|
1158
|
+
* "type": "text"
|
|
1159
|
+
* }
|
|
1160
|
+
* ],
|
|
1161
|
+
* "type": "paragraph"
|
|
1162
|
+
* }
|
|
1163
|
+
* ],
|
|
1164
|
+
* "type": "doc",
|
|
1165
|
+
* "version": 1
|
|
1166
|
+
* },
|
|
1167
|
+
* "customfield_10010": 1,
|
|
1168
|
+
* "summary": "Completed orders still displaying in pending"
|
|
1169
|
+
* },
|
|
1170
|
+
* "historyMetadata": {
|
|
1171
|
+
* "activityDescription": "Complete order processing",
|
|
1172
|
+
* "actor": {
|
|
1173
|
+
* "avatarUrl": "http://mysystem/avatar/tony.jpg",
|
|
1174
|
+
* "displayName": "Tony",
|
|
1175
|
+
* "id": "tony",
|
|
1176
|
+
* "type": "mysystem-user",
|
|
1177
|
+
* "url": "http://mysystem/users/tony"
|
|
1178
|
+
* },
|
|
1179
|
+
* "cause": {
|
|
1180
|
+
* "id": "myevent",
|
|
1181
|
+
* "type": "mysystem-event"
|
|
1182
|
+
* },
|
|
1183
|
+
* "description": "From the order testing process",
|
|
1184
|
+
* "extraData": {
|
|
1185
|
+
* "Iteration": "10a",
|
|
1186
|
+
* "Step": "4"
|
|
1187
|
+
* },
|
|
1188
|
+
* "generator": {
|
|
1189
|
+
* "id": "mysystem-1",
|
|
1190
|
+
* "type": "mysystem-application"
|
|
1191
|
+
* },
|
|
1192
|
+
* "type": "myplugin:type"
|
|
1193
|
+
* },
|
|
1194
|
+
* "properties": [
|
|
1195
|
+
* {
|
|
1196
|
+
* "key": "key1",
|
|
1197
|
+
* "value": "Order number 10784"
|
|
1198
|
+
* },
|
|
1199
|
+
* {
|
|
1200
|
+
* "key": "key2",
|
|
1201
|
+
* "value": "Order number 10923"
|
|
1202
|
+
* }
|
|
1203
|
+
* ],
|
|
1204
|
+
* "update": {
|
|
1205
|
+
* "components": [
|
|
1206
|
+
* {
|
|
1207
|
+
* "set": ""
|
|
1208
|
+
* }
|
|
1209
|
+
* ],
|
|
1210
|
+
* "labels": [
|
|
1211
|
+
* {
|
|
1212
|
+
* "add": "triaged"
|
|
1213
|
+
* },
|
|
1214
|
+
* {
|
|
1215
|
+
* "remove": "blocker"
|
|
1216
|
+
* }
|
|
1217
|
+
* ],
|
|
1218
|
+
* "summary": [
|
|
1219
|
+
* {
|
|
1220
|
+
* "set": "Bug in business logic"
|
|
1221
|
+
* }
|
|
1222
|
+
* ],
|
|
1223
|
+
* "timetracking": [
|
|
1224
|
+
* {
|
|
1225
|
+
* "edit": {
|
|
1226
|
+
* "originalEstimate": "1w 1d",
|
|
1227
|
+
* "remainingEstimate": "4d"
|
|
1228
|
+
* }
|
|
1229
|
+
* }
|
|
1230
|
+
* ]
|
|
1231
|
+
* }
|
|
1232
|
+
* }
|
|
1233
|
+
*/
|
|
1234
|
+
issueUpdateDetails: IssueUpdateDetails;
|
|
1235
|
+
}): Promise<
|
|
1236
|
+
commonHttpClient.WithResponse<
|
|
1237
|
+
| {
|
|
1238
|
+
status: 200;
|
|
1239
|
+
mediaType: "application/json";
|
|
1240
|
+
body: unknown;
|
|
1241
|
+
}
|
|
1242
|
+
| {
|
|
1243
|
+
status: 204;
|
|
1244
|
+
mediaType: "application/json";
|
|
1245
|
+
body: void;
|
|
1246
|
+
}
|
|
1247
|
+
>
|
|
1248
|
+
> {
|
|
1249
|
+
return this.getClientInstance()
|
|
1250
|
+
.request({
|
|
1251
|
+
path: "/rest/api/3/issue/{issueIdOrKey}",
|
|
1252
|
+
method: "PUT",
|
|
1253
|
+
pathParams: {
|
|
1254
|
+
issueIdOrKey,
|
|
1255
|
+
},
|
|
1256
|
+
query: {
|
|
1257
|
+
notifyUsers,
|
|
1258
|
+
overrideScreenSecurity,
|
|
1259
|
+
overrideEditableFlag,
|
|
1260
|
+
returnIssue,
|
|
1261
|
+
expand,
|
|
1262
|
+
},
|
|
1263
|
+
headers: {
|
|
1264
|
+
"Content-Type": "application/json",
|
|
1265
|
+
},
|
|
1266
|
+
body: issueUpdateDetails,
|
|
1267
|
+
})
|
|
1268
|
+
.then(
|
|
1269
|
+
this.getClientInstance().responseHandler({
|
|
1270
|
+
200: {
|
|
1271
|
+
"application/json": "json",
|
|
1272
|
+
},
|
|
1273
|
+
204: {
|
|
1274
|
+
"application/json": "json",
|
|
1275
|
+
},
|
|
1276
|
+
}),
|
|
1277
|
+
)
|
|
1278
|
+
.then(
|
|
1279
|
+
commonHttpClient.castResponse<
|
|
1280
|
+
| {
|
|
1281
|
+
status: 200;
|
|
1282
|
+
mediaType: "application/json";
|
|
1283
|
+
body: unknown;
|
|
1284
|
+
}
|
|
1285
|
+
| {
|
|
1286
|
+
status: 204;
|
|
1287
|
+
mediaType: "application/json";
|
|
1288
|
+
body: void;
|
|
1289
|
+
}
|
|
1290
|
+
>(),
|
|
1291
|
+
)
|
|
1292
|
+
.then(
|
|
1293
|
+
validationSchemaStorage.validator("IssuesService.editIssue.response"),
|
|
1294
|
+
);
|
|
1295
|
+
}
|
|
1296
|
+
/**
|
|
1297
|
+
* Enables admins to retrieve details of all archived issues. Upon a successful
|
|
1298
|
+
* request, the admin who submitted it will receive an email with a link to
|
|
1299
|
+
* download a CSV file with the issue details.
|
|
1300
|
+
*
|
|
1301
|
+
* Note that this API only exports the values of system fields and
|
|
1302
|
+
* archival-specific fields (`ArchivedBy` and `ArchivedDate`). Custom fields
|
|
1303
|
+
* aren't supported.
|
|
1304
|
+
*
|
|
1305
|
+
* **[Permissions](#permissions) required:** Jira admin or site admin: [global
|
|
1306
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg)
|
|
1307
|
+
*
|
|
1308
|
+
* **License required:** Premium or Enterprise
|
|
1309
|
+
*
|
|
1310
|
+
* **Signed-in users only:** This API can't be accessed anonymously.
|
|
1311
|
+
*
|
|
1312
|
+
* **Rate limiting:** Only a single request can be active at any given time.
|
|
1313
|
+
*
|
|
1314
|
+
* @returns Returns the details of your export task. You can use the [get
|
|
1315
|
+
* task](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-rest-api-3-task-taskid-get)
|
|
1316
|
+
* API to view the progress of your request.
|
|
1317
|
+
*
|
|
1318
|
+
* example: {
|
|
1319
|
+
* "payload": "{projects=[FOO, BAR], reporters=[uuid-rep-001, uuid-rep-002],
|
|
1320
|
+
* issueTypes=[10001, 10002], archivedDate={dateAfterInstant=2023-01-01,
|
|
1321
|
+
* dateBeforeInstant=2023-01-12}, archivedBy=[uuid-rep-001, uuid-rep-002]}",
|
|
1322
|
+
* "progress": 0,
|
|
1323
|
+
* "status": "ENQUEUED",
|
|
1324
|
+
* "submittedTime": 1623230887000,
|
|
1325
|
+
* "taskId": "10990"
|
|
1326
|
+
* }
|
|
1327
|
+
* @path {PUT} /rest/api/3/issues/archive/export
|
|
1328
|
+
* @scopes-current read:jira-work
|
|
1329
|
+
* @scopes-beta read:issue:jira
|
|
1330
|
+
*/
|
|
1331
|
+
exportArchivedIssues({
|
|
1332
|
+
archivedIssuesFilterRequest,
|
|
1333
|
+
}: {
|
|
1334
|
+
/**
|
|
1335
|
+
* You can filter the issues in your request by the `projects`, `archivedBy`,
|
|
1336
|
+
* `archivedDate`, `issueTypes`, and `reporters` fields. All filters are optional.
|
|
1337
|
+
* If you don't provide any filters, you'll get a list of up to one million
|
|
1338
|
+
* archived issues.
|
|
1339
|
+
*
|
|
1340
|
+
* @example {
|
|
1341
|
+
* "archivedBy": [
|
|
1342
|
+
* "uuid-rep-001",
|
|
1343
|
+
* "uuid-rep-002"
|
|
1344
|
+
* ],
|
|
1345
|
+
* "archivedDate": {
|
|
1346
|
+
* "dateAfter": "2023-01-01",
|
|
1347
|
+
* "dateBefore": "2023-01-12"
|
|
1348
|
+
* },
|
|
1349
|
+
* "archivedDateRange": {
|
|
1350
|
+
* "dateAfter": "2023-01-01",
|
|
1351
|
+
* "dateBefore": "2023-01-12"
|
|
1352
|
+
* },
|
|
1353
|
+
* "issueTypes": [
|
|
1354
|
+
* "10001",
|
|
1355
|
+
* "10002"
|
|
1356
|
+
* ],
|
|
1357
|
+
* "projects": [
|
|
1358
|
+
* "FOO",
|
|
1359
|
+
* "BAR"
|
|
1360
|
+
* ],
|
|
1361
|
+
* "reporters": [
|
|
1362
|
+
* "uuid-rep-001",
|
|
1363
|
+
* "uuid-rep-002"
|
|
1364
|
+
* ]
|
|
1365
|
+
* }
|
|
1366
|
+
*/
|
|
1367
|
+
archivedIssuesFilterRequest: ArchivedIssuesFilterRequest;
|
|
1368
|
+
}): Promise<ExportArchivedIssuesTaskProgressResponse> {
|
|
1369
|
+
return this.getClientInstance()
|
|
1370
|
+
.request({
|
|
1371
|
+
path: "/rest/api/3/issues/archive/export",
|
|
1372
|
+
method: "PUT",
|
|
1373
|
+
headers: {
|
|
1374
|
+
"Content-Type": "application/json",
|
|
1375
|
+
},
|
|
1376
|
+
body: archivedIssuesFilterRequest,
|
|
1377
|
+
})
|
|
1378
|
+
.then(
|
|
1379
|
+
this.getClientInstance().responseHandler({
|
|
1380
|
+
202: {
|
|
1381
|
+
"application/json": "json",
|
|
1382
|
+
},
|
|
1383
|
+
}),
|
|
1384
|
+
)
|
|
1385
|
+
.then(
|
|
1386
|
+
commonHttpClient.castResponse<{
|
|
1387
|
+
status: 202;
|
|
1388
|
+
mediaType: "application/json";
|
|
1389
|
+
body: ExportArchivedIssuesTaskProgressResponse;
|
|
1390
|
+
}>(),
|
|
1391
|
+
)
|
|
1392
|
+
.then(
|
|
1393
|
+
validationSchemaStorage.validator(
|
|
1394
|
+
"IssuesService.exportArchivedIssues.response",
|
|
1395
|
+
),
|
|
1396
|
+
)
|
|
1397
|
+
.then(commonHttpClient.getBody);
|
|
1398
|
+
}
|
|
1399
|
+
/**
|
|
1400
|
+
* Returns a [paginated](#pagination) list of all changelogs for an issue sorted
|
|
1401
|
+
* by date, starting from the oldest.
|
|
1402
|
+
*
|
|
1403
|
+
* This operation can be accessed anonymously.
|
|
1404
|
+
*
|
|
1405
|
+
* **[Permissions](#permissions) required:**
|
|
1406
|
+
*
|
|
1407
|
+
* * *Browse projects* [project
|
|
1408
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
|
|
1409
|
+
* issue is in.
|
|
1410
|
+
* * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
|
|
1411
|
+
* configured, issue-level security permission to view the issue.
|
|
1412
|
+
*
|
|
1413
|
+
* @returns Returned if the request is successful.
|
|
1414
|
+
*
|
|
1415
|
+
* example: {
|
|
1416
|
+
* "isLast": false,
|
|
1417
|
+
* "maxResults": 2,
|
|
1418
|
+
* "nextPage":
|
|
1419
|
+
* "https://your-domain.atlassian.net/rest/api/3/issue/TT-1/changelog?&startAt=4&maxResults=2",
|
|
1420
|
+
* "self":
|
|
1421
|
+
* "https://your-domain.atlassian.net/rest/api/3/issue/TT-1/changelog?startAt=2&maxResults=2",
|
|
1422
|
+
* "startAt": 2,
|
|
1423
|
+
* "total": 5,
|
|
1424
|
+
* "values": [
|
|
1425
|
+
* {
|
|
1426
|
+
* "author": {
|
|
1427
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
1428
|
+
* "active": true,
|
|
1429
|
+
* "avatarUrls": {
|
|
1430
|
+
* "16x16":
|
|
1431
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
|
|
1432
|
+
* "24x24":
|
|
1433
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
|
|
1434
|
+
* "32x32":
|
|
1435
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
|
|
1436
|
+
* "48x48":
|
|
1437
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
|
|
1438
|
+
* },
|
|
1439
|
+
* "displayName": "Mia Krystof",
|
|
1440
|
+
* "emailAddress": "mia@example.com",
|
|
1441
|
+
* "self":
|
|
1442
|
+
* "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
|
|
1443
|
+
* "timeZone": "Australia/Sydney"
|
|
1444
|
+
* },
|
|
1445
|
+
* "created": "1970-01-18T06:27:50.429+0000",
|
|
1446
|
+
* "id": "10001",
|
|
1447
|
+
* "items": [
|
|
1448
|
+
* {
|
|
1449
|
+
* "field": "fields",
|
|
1450
|
+
* "fieldtype": "jira",
|
|
1451
|
+
* "fieldId": "fieldId",
|
|
1452
|
+
* "from": null,
|
|
1453
|
+
* "fromString": "",
|
|
1454
|
+
* "to": null,
|
|
1455
|
+
* "toString": "label-1"
|
|
1456
|
+
* }
|
|
1457
|
+
* ]
|
|
1458
|
+
* },
|
|
1459
|
+
* {
|
|
1460
|
+
* "author": {
|
|
1461
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
1462
|
+
* "active": true,
|
|
1463
|
+
* "avatarUrls": {
|
|
1464
|
+
* "16x16":
|
|
1465
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
|
|
1466
|
+
* "24x24":
|
|
1467
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
|
|
1468
|
+
* "32x32":
|
|
1469
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
|
|
1470
|
+
* "48x48":
|
|
1471
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
|
|
1472
|
+
* },
|
|
1473
|
+
* "displayName": "Mia Krystof",
|
|
1474
|
+
* "emailAddress": "mia@example.com",
|
|
1475
|
+
* "self":
|
|
1476
|
+
* "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
|
|
1477
|
+
* "timeZone": "Australia/Sydney"
|
|
1478
|
+
* },
|
|
1479
|
+
* "created": "1970-01-18T06:27:51.429+0000",
|
|
1480
|
+
* "id": "10002",
|
|
1481
|
+
* "items": [
|
|
1482
|
+
* {
|
|
1483
|
+
* "field": "fields",
|
|
1484
|
+
* "fieldtype": "jira",
|
|
1485
|
+
* "fieldId": "fieldId",
|
|
1486
|
+
* "from": null,
|
|
1487
|
+
* "fromString": "label-1",
|
|
1488
|
+
* "to": null,
|
|
1489
|
+
* "toString": "label-1 label-2"
|
|
1490
|
+
* }
|
|
1491
|
+
* ]
|
|
1492
|
+
* }
|
|
1493
|
+
* ]
|
|
1494
|
+
* }
|
|
1495
|
+
* @path {GET} /rest/api/3/issue/{issueIdOrKey}/changelog
|
|
1496
|
+
* @scopes-current read:jira-work
|
|
1497
|
+
* @scopes-beta read:issue-meta:jira, read:avatar:jira, read:issue.changelog:jira
|
|
1498
|
+
*/
|
|
1499
|
+
getChangeLogs({
|
|
1500
|
+
issueIdOrKey,
|
|
1501
|
+
startAt,
|
|
1502
|
+
maxResults,
|
|
1503
|
+
}: {
|
|
1504
|
+
/** The ID or key of the issue. */
|
|
1505
|
+
issueIdOrKey: string;
|
|
1506
|
+
/** The index of the first item to return in a page of results (page offset). */
|
|
1507
|
+
startAt?: number;
|
|
1508
|
+
/** The maximum number of items to return per page. */
|
|
1509
|
+
maxResults?: number;
|
|
1510
|
+
}): Promise<PageBeanChangelog> {
|
|
1511
|
+
return this.getClientInstance()
|
|
1512
|
+
.request({
|
|
1513
|
+
path: "/rest/api/3/issue/{issueIdOrKey}/changelog",
|
|
1514
|
+
method: "GET",
|
|
1515
|
+
pathParams: {
|
|
1516
|
+
issueIdOrKey,
|
|
1517
|
+
},
|
|
1518
|
+
query: {
|
|
1519
|
+
startAt,
|
|
1520
|
+
maxResults,
|
|
1521
|
+
},
|
|
1522
|
+
})
|
|
1523
|
+
.then(
|
|
1524
|
+
this.getClientInstance().responseHandler({
|
|
1525
|
+
200: {
|
|
1526
|
+
"application/json": "json",
|
|
1527
|
+
},
|
|
1528
|
+
}),
|
|
1529
|
+
)
|
|
1530
|
+
.then(
|
|
1531
|
+
commonHttpClient.castResponse<{
|
|
1532
|
+
status: 200;
|
|
1533
|
+
mediaType: "application/json";
|
|
1534
|
+
body: PageBeanChangelog;
|
|
1535
|
+
}>(),
|
|
1536
|
+
)
|
|
1537
|
+
.then(
|
|
1538
|
+
validationSchemaStorage.validator(
|
|
1539
|
+
"IssuesService.getChangeLogs.response",
|
|
1540
|
+
),
|
|
1541
|
+
)
|
|
1542
|
+
.then(commonHttpClient.getBody);
|
|
1543
|
+
}
|
|
1544
|
+
/**
|
|
1545
|
+
* Returns changelogs for an issue specified by a list of changelog IDs.
|
|
1546
|
+
*
|
|
1547
|
+
* This operation can be accessed anonymously.
|
|
1548
|
+
*
|
|
1549
|
+
* **[Permissions](#permissions) required:**
|
|
1550
|
+
*
|
|
1551
|
+
* * *Browse projects* [project
|
|
1552
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
|
|
1553
|
+
* issue is in.
|
|
1554
|
+
* * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
|
|
1555
|
+
* configured, issue-level security permission to view the issue.
|
|
1556
|
+
*
|
|
1557
|
+
* @returns Returned if the request is successful.
|
|
1558
|
+
*
|
|
1559
|
+
* example: {
|
|
1560
|
+
* "histories": [
|
|
1561
|
+
* {
|
|
1562
|
+
* "author": {
|
|
1563
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
1564
|
+
* "active": true,
|
|
1565
|
+
* "avatarUrls": {
|
|
1566
|
+
* "16x16":
|
|
1567
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
|
|
1568
|
+
* "24x24":
|
|
1569
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
|
|
1570
|
+
* "32x32":
|
|
1571
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
|
|
1572
|
+
* "48x48":
|
|
1573
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
|
|
1574
|
+
* },
|
|
1575
|
+
* "displayName": "Mia Krystof",
|
|
1576
|
+
* "emailAddress": "mia@example.com",
|
|
1577
|
+
* "self":
|
|
1578
|
+
* "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
|
|
1579
|
+
* "timeZone": "Australia/Sydney"
|
|
1580
|
+
* },
|
|
1581
|
+
* "created": "1970-01-18T06:27:50.429+0000",
|
|
1582
|
+
* "id": "10001",
|
|
1583
|
+
* "items": [
|
|
1584
|
+
* {
|
|
1585
|
+
* "field": "fields",
|
|
1586
|
+
* "fieldtype": "jira",
|
|
1587
|
+
* "fieldId": "fieldId",
|
|
1588
|
+
* "from": null,
|
|
1589
|
+
* "fromString": "",
|
|
1590
|
+
* "to": null,
|
|
1591
|
+
* "toString": "label-1"
|
|
1592
|
+
* }
|
|
1593
|
+
* ]
|
|
1594
|
+
* },
|
|
1595
|
+
* {
|
|
1596
|
+
* "author": {
|
|
1597
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
1598
|
+
* "active": true,
|
|
1599
|
+
* "avatarUrls": {
|
|
1600
|
+
* "16x16":
|
|
1601
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
|
|
1602
|
+
* "24x24":
|
|
1603
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
|
|
1604
|
+
* "32x32":
|
|
1605
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
|
|
1606
|
+
* "48x48":
|
|
1607
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
|
|
1608
|
+
* },
|
|
1609
|
+
* "displayName": "Mia Krystof",
|
|
1610
|
+
* "emailAddress": "mia@example.com",
|
|
1611
|
+
* "self":
|
|
1612
|
+
* "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
|
|
1613
|
+
* "timeZone": "Australia/Sydney"
|
|
1614
|
+
* },
|
|
1615
|
+
* "created": "1970-01-18T06:27:51.429+0000",
|
|
1616
|
+
* "id": "10002",
|
|
1617
|
+
* "items": [
|
|
1618
|
+
* {
|
|
1619
|
+
* "field": "fields",
|
|
1620
|
+
* "fieldtype": "jira",
|
|
1621
|
+
* "fieldId": "fieldId",
|
|
1622
|
+
* "from": null,
|
|
1623
|
+
* "fromString": "label-1",
|
|
1624
|
+
* "to": null,
|
|
1625
|
+
* "toString": "label-1 label-2"
|
|
1626
|
+
* }
|
|
1627
|
+
* ]
|
|
1628
|
+
* }
|
|
1629
|
+
* ],
|
|
1630
|
+
* "maxResults": 2,
|
|
1631
|
+
* "startAt": 0,
|
|
1632
|
+
* "total": 2
|
|
1633
|
+
* }
|
|
1634
|
+
* @path {POST} /rest/api/3/issue/{issueIdOrKey}/changelog/list
|
|
1635
|
+
* @scopes-current read:jira-work
|
|
1636
|
+
* @scopes-beta read:issue-meta:jira, read:avatar:jira, read:issue.changelog:jira
|
|
1637
|
+
*/
|
|
1638
|
+
getChangeLogsByIds({
|
|
1639
|
+
issueIdOrKey,
|
|
1640
|
+
issueChangelogIds,
|
|
1641
|
+
}: {
|
|
1642
|
+
/** The ID or key of the issue. */
|
|
1643
|
+
issueIdOrKey: string;
|
|
1644
|
+
/**
|
|
1645
|
+
* @example {
|
|
1646
|
+
* "changelogIds": [
|
|
1647
|
+
* 10001,
|
|
1648
|
+
* 10002
|
|
1649
|
+
* ]
|
|
1650
|
+
* }
|
|
1651
|
+
*/
|
|
1652
|
+
issueChangelogIds: IssueChangelogIds;
|
|
1653
|
+
}): Promise<PageOfChangelogs> {
|
|
1654
|
+
return this.getClientInstance()
|
|
1655
|
+
.request({
|
|
1656
|
+
path: "/rest/api/3/issue/{issueIdOrKey}/changelog/list",
|
|
1657
|
+
method: "POST",
|
|
1658
|
+
pathParams: {
|
|
1659
|
+
issueIdOrKey,
|
|
1660
|
+
},
|
|
1661
|
+
headers: {
|
|
1662
|
+
"Content-Type": "application/json",
|
|
1663
|
+
},
|
|
1664
|
+
body: issueChangelogIds,
|
|
1665
|
+
})
|
|
1666
|
+
.then(
|
|
1667
|
+
this.getClientInstance().responseHandler({
|
|
1668
|
+
200: {
|
|
1669
|
+
"application/json": "json",
|
|
1670
|
+
},
|
|
1671
|
+
}),
|
|
1672
|
+
)
|
|
1673
|
+
.then(
|
|
1674
|
+
commonHttpClient.castResponse<{
|
|
1675
|
+
status: 200;
|
|
1676
|
+
mediaType: "application/json";
|
|
1677
|
+
body: PageOfChangelogs;
|
|
1678
|
+
}>(),
|
|
1679
|
+
)
|
|
1680
|
+
.then(
|
|
1681
|
+
validationSchemaStorage.validator(
|
|
1682
|
+
"IssuesService.getChangeLogsByIds.response",
|
|
1683
|
+
),
|
|
1684
|
+
)
|
|
1685
|
+
.then(commonHttpClient.getBody);
|
|
1686
|
+
}
|
|
1687
|
+
/**
|
|
1688
|
+
* Returns details of projects, issue types within projects, and, when requested,
|
|
1689
|
+
* the create screen fields for each issue type for the user. Use the information
|
|
1690
|
+
* to populate the requests in [ Create issue](#api-rest-api-3-issue-post) and
|
|
1691
|
+
* [Create issues](#api-rest-api-3-issue-bulk-post).
|
|
1692
|
+
*
|
|
1693
|
+
* Deprecated, see [Create Issue Meta Endpoint Deprecation
|
|
1694
|
+
* Notice](https://developer.atlassian.com/cloud/jira/platform/changelog/#CHANGE-1304).
|
|
1695
|
+
*
|
|
1696
|
+
* The request can be restricted to specific projects or issue types using the
|
|
1697
|
+
* query parameters. The response will contain information for the valid projects,
|
|
1698
|
+
* issue types, or project and issue type combinations requested. Note that
|
|
1699
|
+
* invalid project, issue type, or project and issue type combinations do not
|
|
1700
|
+
* generate errors.
|
|
1701
|
+
*
|
|
1702
|
+
* This operation can be accessed anonymously.
|
|
1703
|
+
*
|
|
1704
|
+
* **[Permissions](#permissions) required:** *Create issues* [project
|
|
1705
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) in the requested
|
|
1706
|
+
* projects.
|
|
1707
|
+
*
|
|
1708
|
+
* @deprecated
|
|
1709
|
+
* @returns Returned if the request is successful.
|
|
1710
|
+
*
|
|
1711
|
+
* example: {
|
|
1712
|
+
* "projects": [
|
|
1713
|
+
* {
|
|
1714
|
+
* "avatarUrls": {
|
|
1715
|
+
* "16x16":
|
|
1716
|
+
* "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011",
|
|
1717
|
+
* "24x24":
|
|
1718
|
+
* "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011",
|
|
1719
|
+
* "32x32":
|
|
1720
|
+
* "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011",
|
|
1721
|
+
* "48x48":
|
|
1722
|
+
* "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011"
|
|
1723
|
+
* },
|
|
1724
|
+
* "id": "10000",
|
|
1725
|
+
* "issuetypes": [
|
|
1726
|
+
* {
|
|
1727
|
+
* "description": "An error in the code",
|
|
1728
|
+
* "fields": {
|
|
1729
|
+
* "issuetype": {
|
|
1730
|
+
* "allowedValues": [
|
|
1731
|
+
* "set"
|
|
1732
|
+
* ],
|
|
1733
|
+
* "autoCompleteUrl": "issuetype",
|
|
1734
|
+
* "hasDefaultValue": false,
|
|
1735
|
+
* "key": "issuetype",
|
|
1736
|
+
* "name": "Issue Type",
|
|
1737
|
+
* "required": true
|
|
1738
|
+
* }
|
|
1739
|
+
* },
|
|
1740
|
+
* "iconUrl":
|
|
1741
|
+
* "https://your-domain.atlassian.net/images/icons/issuetypes/bug.png",
|
|
1742
|
+
* "id": "1",
|
|
1743
|
+
* "name": "Bug",
|
|
1744
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
|
|
1745
|
+
* "subtask": false
|
|
1746
|
+
* }
|
|
1747
|
+
* ],
|
|
1748
|
+
* "key": "ED",
|
|
1749
|
+
* "name": "Edison Project",
|
|
1750
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/project/ED"
|
|
1751
|
+
* }
|
|
1752
|
+
* ]
|
|
1753
|
+
* }
|
|
1754
|
+
* @path {GET} /rest/api/3/issue/createmeta
|
|
1755
|
+
* @scopes-current read:jira-work
|
|
1756
|
+
* @scopes-beta read:issue-meta:jira, read:avatar:jira, read:field-configuration:jira
|
|
1757
|
+
*/
|
|
1758
|
+
getCreateIssueMeta({
|
|
1759
|
+
projectIds,
|
|
1760
|
+
projectKeys,
|
|
1761
|
+
issuetypeIds,
|
|
1762
|
+
issuetypeNames,
|
|
1763
|
+
expand,
|
|
1764
|
+
}: {
|
|
1765
|
+
/**
|
|
1766
|
+
* List of project IDs. This parameter accepts a comma-separated list. Multiple
|
|
1767
|
+
* project IDs can also be provided using an ampersand-separated list. For
|
|
1768
|
+
* example, `projectIds=10000,10001&projectIds=10020,10021`. This parameter may be
|
|
1769
|
+
* provided with `projectKeys`.
|
|
1770
|
+
*/
|
|
1771
|
+
projectIds?: string[];
|
|
1772
|
+
/**
|
|
1773
|
+
* List of project keys. This parameter accepts a comma-separated list. Multiple
|
|
1774
|
+
* project keys can also be provided using an ampersand-separated list. For
|
|
1775
|
+
* example, `projectKeys=proj1,proj2&projectKeys=proj3`. This parameter may be
|
|
1776
|
+
* provided with `projectIds`.
|
|
1777
|
+
*/
|
|
1778
|
+
projectKeys?: string[];
|
|
1779
|
+
/**
|
|
1780
|
+
* List of issue type IDs. This parameter accepts a comma-separated list. Multiple
|
|
1781
|
+
* issue type IDs can also be provided using an ampersand-separated list. For
|
|
1782
|
+
* example, `issuetypeIds=10000,10001&issuetypeIds=10020,10021`. This parameter
|
|
1783
|
+
* may be provided with `issuetypeNames`.
|
|
1784
|
+
*/
|
|
1785
|
+
issuetypeIds?: string[];
|
|
1786
|
+
/**
|
|
1787
|
+
* List of issue type names. This parameter accepts a comma-separated list.
|
|
1788
|
+
* Multiple issue type names can also be provided using an ampersand-separated
|
|
1789
|
+
* list. For example, `issuetypeNames=name1,name2&issuetypeNames=name3`. This
|
|
1790
|
+
* parameter may be provided with `issuetypeIds`.
|
|
1791
|
+
*/
|
|
1792
|
+
issuetypeNames?: string[];
|
|
1793
|
+
/**
|
|
1794
|
+
* Use [expand](#expansion) to include additional information about issue metadata
|
|
1795
|
+
* in the response. This parameter accepts `projects.issuetypes.fields`, which
|
|
1796
|
+
* returns information about the fields in the issue creation screen for each
|
|
1797
|
+
* issue type. Fields hidden from the screen are not returned. Use the information
|
|
1798
|
+
* to populate the `fields` and `update` fields in [Create
|
|
1799
|
+
* issue](#api-rest-api-3-issue-post) and [Create
|
|
1800
|
+
* issues](#api-rest-api-3-issue-bulk-post).
|
|
1801
|
+
*/
|
|
1802
|
+
expand?: string;
|
|
1803
|
+
}): Promise<IssueCreateMetadata> {
|
|
1804
|
+
return this.getClientInstance()
|
|
1805
|
+
.request({
|
|
1806
|
+
path: "/rest/api/3/issue/createmeta",
|
|
1807
|
+
method: "GET",
|
|
1808
|
+
query: {
|
|
1809
|
+
projectIds,
|
|
1810
|
+
projectKeys,
|
|
1811
|
+
issuetypeIds,
|
|
1812
|
+
issuetypeNames,
|
|
1813
|
+
expand,
|
|
1814
|
+
},
|
|
1815
|
+
})
|
|
1816
|
+
.then(
|
|
1817
|
+
this.getClientInstance().responseHandler({
|
|
1818
|
+
200: {
|
|
1819
|
+
"application/json": "json",
|
|
1820
|
+
},
|
|
1821
|
+
}),
|
|
1822
|
+
)
|
|
1823
|
+
.then(
|
|
1824
|
+
commonHttpClient.castResponse<{
|
|
1825
|
+
status: 200;
|
|
1826
|
+
mediaType: "application/json";
|
|
1827
|
+
body: IssueCreateMetadata;
|
|
1828
|
+
}>(),
|
|
1829
|
+
)
|
|
1830
|
+
.then(
|
|
1831
|
+
validationSchemaStorage.validator(
|
|
1832
|
+
"IssuesService.getCreateIssueMeta.response",
|
|
1833
|
+
),
|
|
1834
|
+
)
|
|
1835
|
+
.then(commonHttpClient.getBody);
|
|
1836
|
+
}
|
|
1837
|
+
/**
|
|
1838
|
+
* Returns a page of field metadata for a specified project and issuetype id. Use
|
|
1839
|
+
* the information to populate the requests in [ Create
|
|
1840
|
+
* issue](#api-rest-api-3-issue-post) and [Create
|
|
1841
|
+
* issues](#api-rest-api-3-issue-bulk-post).
|
|
1842
|
+
*
|
|
1843
|
+
* This operation can be accessed anonymously.
|
|
1844
|
+
*
|
|
1845
|
+
* **[Permissions](#permissions) required:** *Create issues* [project
|
|
1846
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) in the requested
|
|
1847
|
+
* projects.
|
|
1848
|
+
*
|
|
1849
|
+
* @returns Returned if the request is successful.
|
|
1850
|
+
*
|
|
1851
|
+
* example: {
|
|
1852
|
+
* "fields": [
|
|
1853
|
+
* {
|
|
1854
|
+
* "fieldId": "assignee",
|
|
1855
|
+
* "hasDefaultValue": false,
|
|
1856
|
+
* "key": "assignee",
|
|
1857
|
+
* "name": "Assignee",
|
|
1858
|
+
* "operations": [
|
|
1859
|
+
* "set"
|
|
1860
|
+
* ],
|
|
1861
|
+
* "required": true
|
|
1862
|
+
* }
|
|
1863
|
+
* ],
|
|
1864
|
+
* "maxResults": 1,
|
|
1865
|
+
* "startAt": 0,
|
|
1866
|
+
* "total": 1
|
|
1867
|
+
* }
|
|
1868
|
+
* @path {GET} /rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}
|
|
1869
|
+
* @scopes-current read:jira-work
|
|
1870
|
+
* @scopes-beta read:issue-meta:jira, read:avatar:jira, read:field-configuration:jira
|
|
1871
|
+
*/
|
|
1872
|
+
getCreateIssueMetaIssueTypeId({
|
|
1873
|
+
projectIdOrKey,
|
|
1874
|
+
issueTypeId,
|
|
1875
|
+
startAt,
|
|
1876
|
+
maxResults,
|
|
1877
|
+
}: {
|
|
1878
|
+
/** The ID or key of the project. */
|
|
1879
|
+
projectIdOrKey: string;
|
|
1880
|
+
/** The issuetype ID. */
|
|
1881
|
+
issueTypeId: string;
|
|
1882
|
+
/** The index of the first item to return in a page of results (page offset). */
|
|
1883
|
+
startAt?: number;
|
|
1884
|
+
/** The maximum number of items to return per page. */
|
|
1885
|
+
maxResults?: number;
|
|
1886
|
+
}): Promise<PageOfCreateMetaIssueTypeWithField> {
|
|
1887
|
+
return this.getClientInstance()
|
|
1888
|
+
.request({
|
|
1889
|
+
path: "/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes/{issueTypeId}",
|
|
1890
|
+
method: "GET",
|
|
1891
|
+
pathParams: {
|
|
1892
|
+
projectIdOrKey,
|
|
1893
|
+
issueTypeId,
|
|
1894
|
+
},
|
|
1895
|
+
query: {
|
|
1896
|
+
startAt,
|
|
1897
|
+
maxResults,
|
|
1898
|
+
},
|
|
1899
|
+
})
|
|
1900
|
+
.then(
|
|
1901
|
+
this.getClientInstance().responseHandler({
|
|
1902
|
+
200: {
|
|
1903
|
+
"application/json": "json",
|
|
1904
|
+
},
|
|
1905
|
+
}),
|
|
1906
|
+
)
|
|
1907
|
+
.then(
|
|
1908
|
+
commonHttpClient.castResponse<{
|
|
1909
|
+
status: 200;
|
|
1910
|
+
mediaType: "application/json";
|
|
1911
|
+
body: PageOfCreateMetaIssueTypeWithField;
|
|
1912
|
+
}>(),
|
|
1913
|
+
)
|
|
1914
|
+
.then(
|
|
1915
|
+
validationSchemaStorage.validator(
|
|
1916
|
+
"IssuesService.getCreateIssueMetaIssueTypeId.response",
|
|
1917
|
+
),
|
|
1918
|
+
)
|
|
1919
|
+
.then(commonHttpClient.getBody);
|
|
1920
|
+
}
|
|
1921
|
+
/**
|
|
1922
|
+
* Returns a page of issue type metadata for a specified project. Use the
|
|
1923
|
+
* information to populate the requests in [ Create
|
|
1924
|
+
* issue](#api-rest-api-3-issue-post) and [Create
|
|
1925
|
+
* issues](#api-rest-api-3-issue-bulk-post).
|
|
1926
|
+
*
|
|
1927
|
+
* This operation can be accessed anonymously.
|
|
1928
|
+
*
|
|
1929
|
+
* **[Permissions](#permissions) required:** *Create issues* [project
|
|
1930
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) in the requested
|
|
1931
|
+
* projects.
|
|
1932
|
+
*
|
|
1933
|
+
* @returns Returned if the request is successful.
|
|
1934
|
+
*
|
|
1935
|
+
* example: {
|
|
1936
|
+
* "issueTypes": [
|
|
1937
|
+
* {
|
|
1938
|
+
* "description": "An error in the code",
|
|
1939
|
+
* "iconUrl":
|
|
1940
|
+
* "https://your-domain.atlassian.net/images/icons/issuetypes/bug.png",
|
|
1941
|
+
* "id": "1",
|
|
1942
|
+
* "name": "Bug",
|
|
1943
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issueType/1",
|
|
1944
|
+
* "subtask": false
|
|
1945
|
+
* }
|
|
1946
|
+
* ],
|
|
1947
|
+
* "maxResults": 1,
|
|
1948
|
+
* "startAt": 0,
|
|
1949
|
+
* "total": 1
|
|
1950
|
+
* }
|
|
1951
|
+
* @path {GET} /rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes
|
|
1952
|
+
* @scopes-current read:jira-work
|
|
1953
|
+
* @scopes-beta read:issue-meta:jira, read:avatar:jira, read:field-configuration:jira
|
|
1954
|
+
*/
|
|
1955
|
+
getCreateIssueMetaIssueTypes({
|
|
1956
|
+
projectIdOrKey,
|
|
1957
|
+
startAt,
|
|
1958
|
+
maxResults,
|
|
1959
|
+
}: {
|
|
1960
|
+
/** The ID or key of the project. */
|
|
1961
|
+
projectIdOrKey: string;
|
|
1962
|
+
/** The index of the first item to return in a page of results (page offset). */
|
|
1963
|
+
startAt?: number;
|
|
1964
|
+
/** The maximum number of items to return per page. */
|
|
1965
|
+
maxResults?: number;
|
|
1966
|
+
}): Promise<PageOfCreateMetaIssueTypes> {
|
|
1967
|
+
return this.getClientInstance()
|
|
1968
|
+
.request({
|
|
1969
|
+
path: "/rest/api/3/issue/createmeta/{projectIdOrKey}/issuetypes",
|
|
1970
|
+
method: "GET",
|
|
1971
|
+
pathParams: {
|
|
1972
|
+
projectIdOrKey,
|
|
1973
|
+
},
|
|
1974
|
+
query: {
|
|
1975
|
+
startAt,
|
|
1976
|
+
maxResults,
|
|
1977
|
+
},
|
|
1978
|
+
})
|
|
1979
|
+
.then(
|
|
1980
|
+
this.getClientInstance().responseHandler({
|
|
1981
|
+
200: {
|
|
1982
|
+
"application/json": "json",
|
|
1983
|
+
},
|
|
1984
|
+
}),
|
|
1985
|
+
)
|
|
1986
|
+
.then(
|
|
1987
|
+
commonHttpClient.castResponse<{
|
|
1988
|
+
status: 200;
|
|
1989
|
+
mediaType: "application/json";
|
|
1990
|
+
body: PageOfCreateMetaIssueTypes;
|
|
1991
|
+
}>(),
|
|
1992
|
+
)
|
|
1993
|
+
.then(
|
|
1994
|
+
validationSchemaStorage.validator(
|
|
1995
|
+
"IssuesService.getCreateIssueMetaIssueTypes.response",
|
|
1996
|
+
),
|
|
1997
|
+
)
|
|
1998
|
+
.then(commonHttpClient.getBody);
|
|
1999
|
+
}
|
|
2000
|
+
/**
|
|
2001
|
+
* Returns the edit screen fields for an issue that are visible to and editable by
|
|
2002
|
+
* the user. Use the information to populate the requests in [Edit
|
|
2003
|
+
* issue](#api-rest-api-3-issue-issueIdOrKey-put).
|
|
2004
|
+
*
|
|
2005
|
+
* This endpoint will check for these conditions:
|
|
2006
|
+
*
|
|
2007
|
+
* 1. Field is available on a field screen - through screen, screen scheme, issue
|
|
2008
|
+
* type screen scheme, and issue type scheme configuration.
|
|
2009
|
+
* `overrideScreenSecurity=true` skips this condition.
|
|
2010
|
+
* 2. Field is visible in the [field
|
|
2011
|
+
* configuration](https://support.atlassian.com/jira-cloud-administration/docs/change-a-field-configuration/).
|
|
2012
|
+
* `overrideScreenSecurity=true` skips this condition.
|
|
2013
|
+
* 3. Field is shown on the issue: each field has different conditions here. For
|
|
2014
|
+
* example: Attachment field only shows if attachments are enabled. Assignee only
|
|
2015
|
+
* shows if user has permissions to assign the issue.
|
|
2016
|
+
* 4. If a field is custom then it must have valid custom field context,
|
|
2017
|
+
* applicable for its project and issue type. All system fields are assumed to
|
|
2018
|
+
* have context in all projects and all issue types.
|
|
2019
|
+
* 5. Issue has a project, issue type, and status defined.
|
|
2020
|
+
* 6. Issue is assigned to a valid workflow, and the current status has assigned
|
|
2021
|
+
* a workflow step. `overrideEditableFlag=true` skips this condition.
|
|
2022
|
+
* 7. The current workflow step is editable. This is true by default, but [can be
|
|
2023
|
+
* disabled by
|
|
2024
|
+
* setting](https://support.atlassian.com/jira-cloud-administration/docs/use-workflow-properties/)
|
|
2025
|
+
* the `jira.issue.editable` property to `false`. `overrideEditableFlag=true`
|
|
2026
|
+
* skips this condition.
|
|
2027
|
+
* 8. User has [Edit issues
|
|
2028
|
+
* permission](https://support.atlassian.com/jira-cloud-administration/docs/permissions-for-company-managed-projects/).
|
|
2029
|
+
* 9. Workflow permissions allow editing a field. This is true by default but
|
|
2030
|
+
* [can be
|
|
2031
|
+
* modified](https://support.atlassian.com/jira-cloud-administration/docs/use-workflow-properties/)
|
|
2032
|
+
* using `jira.permission.*` workflow properties.
|
|
2033
|
+
*
|
|
2034
|
+
* Fields hidden using [Issue layout settings
|
|
2035
|
+
* page](https://support.atlassian.com/jira-software-cloud/docs/configure-field-layout-in-the-issue-view/)
|
|
2036
|
+
* remain editable.
|
|
2037
|
+
*
|
|
2038
|
+
* Connect apps having an app user with *Administer Jira* [global
|
|
2039
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg), and Forge apps acting
|
|
2040
|
+
* on behalf of users with *Administer Jira* [global
|
|
2041
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg), can return additional
|
|
2042
|
+
* details using:
|
|
2043
|
+
*
|
|
2044
|
+
* * `overrideScreenSecurity` When this flag is `true`, then this endpoint skips
|
|
2045
|
+
* checking if fields are available through screens, and field configuration
|
|
2046
|
+
* (conditions 1. and 2. from the list above).
|
|
2047
|
+
* * `overrideEditableFlag` When this flag is `true`, then this endpoint skips
|
|
2048
|
+
* checking if workflow is present and if the current step is editable (conditions
|
|
2049
|
+
* 6. and 7. from the list above).
|
|
2050
|
+
*
|
|
2051
|
+
* This operation can be accessed anonymously.
|
|
2052
|
+
*
|
|
2053
|
+
* **[Permissions](#permissions) required:**
|
|
2054
|
+
*
|
|
2055
|
+
* * *Browse projects* [project
|
|
2056
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
|
|
2057
|
+
* issue is in.
|
|
2058
|
+
* * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
|
|
2059
|
+
* configured, issue-level security permission to view the issue.
|
|
2060
|
+
*
|
|
2061
|
+
* Note: For any fields to be editable the user must have the *Edit issues*
|
|
2062
|
+
* [project permission](https://confluence.atlassian.com/x/yodKLg) for the issue.
|
|
2063
|
+
*
|
|
2064
|
+
* @returns Returned if the request is successful.
|
|
2065
|
+
*
|
|
2066
|
+
* example: {
|
|
2067
|
+
* "fields": {
|
|
2068
|
+
* "summary": {
|
|
2069
|
+
* "allowedValues": [
|
|
2070
|
+
* "red",
|
|
2071
|
+
* "blue"
|
|
2072
|
+
* ],
|
|
2073
|
+
* "defaultValue": "red",
|
|
2074
|
+
* "hasDefaultValue": false,
|
|
2075
|
+
* "key": "field_key",
|
|
2076
|
+
* "name": "My Multi Select",
|
|
2077
|
+
* "operations": [
|
|
2078
|
+
* "set",
|
|
2079
|
+
* "add"
|
|
2080
|
+
* ],
|
|
2081
|
+
* "required": false,
|
|
2082
|
+
* "schema": {
|
|
2083
|
+
* "custom":
|
|
2084
|
+
* "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
|
|
2085
|
+
* "customId": 10001,
|
|
2086
|
+
* "items": "option",
|
|
2087
|
+
* "type": "array"
|
|
2088
|
+
* }
|
|
2089
|
+
* }
|
|
2090
|
+
* }
|
|
2091
|
+
* }
|
|
2092
|
+
* @path {GET} /rest/api/3/issue/{issueIdOrKey}/editmeta
|
|
2093
|
+
* @scopes-current read:jira-work
|
|
2094
|
+
* @scopes-beta read:issue-meta:jira, read:field-configuration:jira
|
|
2095
|
+
*/
|
|
2096
|
+
getEditIssueMeta({
|
|
2097
|
+
issueIdOrKey,
|
|
2098
|
+
overrideScreenSecurity,
|
|
2099
|
+
overrideEditableFlag,
|
|
2100
|
+
}: {
|
|
2101
|
+
/** The ID or key of the issue. */
|
|
2102
|
+
issueIdOrKey: string;
|
|
2103
|
+
/**
|
|
2104
|
+
* Whether hidden fields are returned. Available to Connect app users with
|
|
2105
|
+
* *Administer Jira* [global
|
|
2106
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on
|
|
2107
|
+
* behalf of users with *Administer Jira* [global
|
|
2108
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
2109
|
+
*/
|
|
2110
|
+
overrideScreenSecurity?: boolean;
|
|
2111
|
+
/**
|
|
2112
|
+
* Whether non-editable fields are returned. Available to Connect app users with
|
|
2113
|
+
* *Administer Jira* [global
|
|
2114
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg) and Forge apps acting on
|
|
2115
|
+
* behalf of users with *Administer Jira* [global
|
|
2116
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
2117
|
+
*/
|
|
2118
|
+
overrideEditableFlag?: boolean;
|
|
2119
|
+
}): Promise<IssueUpdateMetadata> {
|
|
2120
|
+
return this.getClientInstance()
|
|
2121
|
+
.request({
|
|
2122
|
+
path: "/rest/api/3/issue/{issueIdOrKey}/editmeta",
|
|
2123
|
+
method: "GET",
|
|
2124
|
+
pathParams: {
|
|
2125
|
+
issueIdOrKey,
|
|
2126
|
+
},
|
|
2127
|
+
query: {
|
|
2128
|
+
overrideScreenSecurity,
|
|
2129
|
+
overrideEditableFlag,
|
|
2130
|
+
},
|
|
2131
|
+
})
|
|
2132
|
+
.then(
|
|
2133
|
+
this.getClientInstance().responseHandler({
|
|
2134
|
+
200: {
|
|
2135
|
+
"application/json": "json",
|
|
2136
|
+
},
|
|
2137
|
+
}),
|
|
2138
|
+
)
|
|
2139
|
+
.then(
|
|
2140
|
+
commonHttpClient.castResponse<{
|
|
2141
|
+
status: 200;
|
|
2142
|
+
mediaType: "application/json";
|
|
2143
|
+
body: IssueUpdateMetadata;
|
|
2144
|
+
}>(),
|
|
2145
|
+
)
|
|
2146
|
+
.then(
|
|
2147
|
+
validationSchemaStorage.validator(
|
|
2148
|
+
"IssuesService.getEditIssueMeta.response",
|
|
2149
|
+
),
|
|
2150
|
+
)
|
|
2151
|
+
.then(commonHttpClient.getBody);
|
|
2152
|
+
}
|
|
2153
|
+
/**
|
|
2154
|
+
* Returns all issue events.
|
|
2155
|
+
*
|
|
2156
|
+
* **[Permissions](#permissions) required:** *Administer Jira* [global
|
|
2157
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
2158
|
+
*
|
|
2159
|
+
* @returns Returned if the request is successful.
|
|
2160
|
+
*
|
|
2161
|
+
* example: [
|
|
2162
|
+
* {
|
|
2163
|
+
* "id": 1,
|
|
2164
|
+
* "name": "Issue Created"
|
|
2165
|
+
* },
|
|
2166
|
+
* {
|
|
2167
|
+
* "id": 2,
|
|
2168
|
+
* "name": "Issue Updated"
|
|
2169
|
+
* }
|
|
2170
|
+
* ]
|
|
2171
|
+
* @path {GET} /rest/api/3/events
|
|
2172
|
+
* @scopes-current manage:jira-configuration
|
|
2173
|
+
* @scopes-beta read:issue-event:jira
|
|
2174
|
+
*/
|
|
2175
|
+
getEvents(): Promise<IssueEvent[]> {
|
|
2176
|
+
return this.getClientInstance()
|
|
2177
|
+
.request({
|
|
2178
|
+
path: "/rest/api/3/events",
|
|
2179
|
+
method: "GET",
|
|
2180
|
+
})
|
|
2181
|
+
.then(
|
|
2182
|
+
this.getClientInstance().responseHandler({
|
|
2183
|
+
200: {
|
|
2184
|
+
"application/json": "json",
|
|
2185
|
+
},
|
|
2186
|
+
}),
|
|
2187
|
+
)
|
|
2188
|
+
.then(
|
|
2189
|
+
commonHttpClient.castResponse<{
|
|
2190
|
+
status: 200;
|
|
2191
|
+
mediaType: "application/json";
|
|
2192
|
+
body: IssueEvent[];
|
|
2193
|
+
}>(),
|
|
2194
|
+
)
|
|
2195
|
+
.then(
|
|
2196
|
+
validationSchemaStorage.validator("IssuesService.getEvents.response"),
|
|
2197
|
+
)
|
|
2198
|
+
.then(commonHttpClient.getBody);
|
|
2199
|
+
}
|
|
2200
|
+
/**
|
|
2201
|
+
* Returns the details for an issue.
|
|
2202
|
+
*
|
|
2203
|
+
* The issue is identified by its ID or key, however, if the identifier doesn't
|
|
2204
|
+
* match an issue, a case-insensitive search and check for moved issues is
|
|
2205
|
+
* performed. If a matching issue is found its details are returned, a 302 or
|
|
2206
|
+
* other redirect is **not** returned. The issue key returned in the response is
|
|
2207
|
+
* the key of the issue found.
|
|
2208
|
+
*
|
|
2209
|
+
* This operation can be accessed anonymously.
|
|
2210
|
+
*
|
|
2211
|
+
* **[Permissions](#permissions) required:**
|
|
2212
|
+
*
|
|
2213
|
+
* * *Browse projects* [project
|
|
2214
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
|
|
2215
|
+
* issue is in.
|
|
2216
|
+
* * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
|
|
2217
|
+
* configured, issue-level security permission to view the issue.
|
|
2218
|
+
*
|
|
2219
|
+
* @returns Returned if the request is successful.
|
|
2220
|
+
*
|
|
2221
|
+
* example: {
|
|
2222
|
+
* "fields": {
|
|
2223
|
+
* "watcher": {
|
|
2224
|
+
* "isWatching": false,
|
|
2225
|
+
* "self":
|
|
2226
|
+
* "https://your-domain.atlassian.net/rest/api/3/issue/EX-1/watchers",
|
|
2227
|
+
* "watchCount": 1,
|
|
2228
|
+
* "watchers": [
|
|
2229
|
+
* {
|
|
2230
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
2231
|
+
* "active": false,
|
|
2232
|
+
* "displayName": "Mia Krystof",
|
|
2233
|
+
* "self":
|
|
2234
|
+
* "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
2235
|
+
* }
|
|
2236
|
+
* ]
|
|
2237
|
+
* },
|
|
2238
|
+
* "attachment": [
|
|
2239
|
+
* {
|
|
2240
|
+
* "author": {
|
|
2241
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
2242
|
+
* "accountType": "atlassian",
|
|
2243
|
+
* "active": false,
|
|
2244
|
+
* "avatarUrls": {
|
|
2245
|
+
* "16x16":
|
|
2246
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
|
|
2247
|
+
* "24x24":
|
|
2248
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
|
|
2249
|
+
* "32x32":
|
|
2250
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32",
|
|
2251
|
+
* "48x48":
|
|
2252
|
+
* "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48"
|
|
2253
|
+
* },
|
|
2254
|
+
* "displayName": "Mia Krystof",
|
|
2255
|
+
* "key": "",
|
|
2256
|
+
* "name": "",
|
|
2257
|
+
* "self":
|
|
2258
|
+
* "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
2259
|
+
* },
|
|
2260
|
+
* "content":
|
|
2261
|
+
* "https://your-domain.atlassian.net/jira/rest/api/3/attachment/content/10000",
|
|
2262
|
+
* "created": "2022-10-06T07:32:47.000+0000",
|
|
2263
|
+
* "filename": "picture.jpg",
|
|
2264
|
+
* "id": 10000,
|
|
2265
|
+
* "mimeType": "image/jpeg",
|
|
2266
|
+
* "self":
|
|
2267
|
+
* "https://your-domain.atlassian.net/rest/api/3/attachments/10000",
|
|
2268
|
+
* "size": 23123,
|
|
2269
|
+
* "thumbnail":
|
|
2270
|
+
* "https://your-domain.atlassian.net/jira/rest/api/3/attachment/thumbnail/10000"
|
|
2271
|
+
* }
|
|
2272
|
+
* ],
|
|
2273
|
+
* "sub-tasks": [
|
|
2274
|
+
* {
|
|
2275
|
+
* "id": "10000",
|
|
2276
|
+
* "outwardIssue": {
|
|
2277
|
+
* "fields": {
|
|
2278
|
+
* "status": {
|
|
2279
|
+
* "iconUrl":
|
|
2280
|
+
* "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
2281
|
+
* "name": "Open"
|
|
2282
|
+
* }
|
|
2283
|
+
* },
|
|
2284
|
+
* "id": "10003",
|
|
2285
|
+
* "key": "ED-2",
|
|
2286
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/ED-2"
|
|
2287
|
+
* },
|
|
2288
|
+
* "type": {
|
|
2289
|
+
* "id": "10000",
|
|
2290
|
+
* "inward": "Parent",
|
|
2291
|
+
* "name": "",
|
|
2292
|
+
* "outward": "Sub-task"
|
|
2293
|
+
* }
|
|
2294
|
+
* }
|
|
2295
|
+
* ],
|
|
2296
|
+
* "description": {
|
|
2297
|
+
* "type": "doc",
|
|
2298
|
+
* "version": 1,
|
|
2299
|
+
* "content": [
|
|
2300
|
+
* {
|
|
2301
|
+
* "type": "paragraph",
|
|
2302
|
+
* "content": [
|
|
2303
|
+
* {
|
|
2304
|
+
* "type": "text",
|
|
2305
|
+
* "text": "Main order flow broken"
|
|
2306
|
+
* }
|
|
2307
|
+
* ]
|
|
2308
|
+
* }
|
|
2309
|
+
* ]
|
|
2310
|
+
* },
|
|
2311
|
+
* "project": {
|
|
2312
|
+
* "avatarUrls": {
|
|
2313
|
+
* "16x16":
|
|
2314
|
+
* "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000",
|
|
2315
|
+
* "24x24":
|
|
2316
|
+
* "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000",
|
|
2317
|
+
* "32x32":
|
|
2318
|
+
* "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000",
|
|
2319
|
+
* "48x48":
|
|
2320
|
+
* "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000"
|
|
2321
|
+
* },
|
|
2322
|
+
* "id": "10000",
|
|
2323
|
+
* "insight": {
|
|
2324
|
+
* "lastIssueUpdateTime": "2021-04-22T05:37:05.000+0000",
|
|
2325
|
+
* "totalIssueCount": 100
|
|
2326
|
+
* },
|
|
2327
|
+
* "key": "EX",
|
|
2328
|
+
* "name": "Example",
|
|
2329
|
+
* "projectCategory": {
|
|
2330
|
+
* "description": "First Project Category",
|
|
2331
|
+
* "id": "10000",
|
|
2332
|
+
* "name": "FIRST",
|
|
2333
|
+
* "self":
|
|
2334
|
+
* "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000"
|
|
2335
|
+
* },
|
|
2336
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/project/EX",
|
|
2337
|
+
* "simplified": false,
|
|
2338
|
+
* "style": "classic"
|
|
2339
|
+
* },
|
|
2340
|
+
* "comment": [
|
|
2341
|
+
* {
|
|
2342
|
+
* "author": {
|
|
2343
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
2344
|
+
* "active": false,
|
|
2345
|
+
* "displayName": "Mia Krystof",
|
|
2346
|
+
* "self":
|
|
2347
|
+
* "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
2348
|
+
* },
|
|
2349
|
+
* "body": {
|
|
2350
|
+
* "type": "doc",
|
|
2351
|
+
* "version": 1,
|
|
2352
|
+
* "content": [
|
|
2353
|
+
* {
|
|
2354
|
+
* "type": "paragraph",
|
|
2355
|
+
* "content": [
|
|
2356
|
+
* {
|
|
2357
|
+
* "type": "text",
|
|
2358
|
+
* "text": "Lorem ipsum dolor sit amet, consectetur adipiscing
|
|
2359
|
+
* elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis
|
|
2360
|
+
* fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper."
|
|
2361
|
+
* }
|
|
2362
|
+
* ]
|
|
2363
|
+
* }
|
|
2364
|
+
* ]
|
|
2365
|
+
* },
|
|
2366
|
+
* "created": "2021-01-17T12:34:00.000+0000",
|
|
2367
|
+
* "id": "10000",
|
|
2368
|
+
* "self":
|
|
2369
|
+
* "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000",
|
|
2370
|
+
* "updateAuthor": {
|
|
2371
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
2372
|
+
* "active": false,
|
|
2373
|
+
* "displayName": "Mia Krystof",
|
|
2374
|
+
* "self":
|
|
2375
|
+
* "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
2376
|
+
* },
|
|
2377
|
+
* "updated": "2021-01-18T23:45:00.000+0000",
|
|
2378
|
+
* "visibility": {
|
|
2379
|
+
* "identifier": "Administrators",
|
|
2380
|
+
* "type": "role",
|
|
2381
|
+
* "value": "Administrators"
|
|
2382
|
+
* }
|
|
2383
|
+
* }
|
|
2384
|
+
* ],
|
|
2385
|
+
* "issuelinks": [
|
|
2386
|
+
* {
|
|
2387
|
+
* "id": "10001",
|
|
2388
|
+
* "outwardIssue": {
|
|
2389
|
+
* "fields": {
|
|
2390
|
+
* "status": {
|
|
2391
|
+
* "iconUrl":
|
|
2392
|
+
* "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
2393
|
+
* "name": "Open"
|
|
2394
|
+
* }
|
|
2395
|
+
* },
|
|
2396
|
+
* "id": "10004L",
|
|
2397
|
+
* "key": "PR-2",
|
|
2398
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-2"
|
|
2399
|
+
* },
|
|
2400
|
+
* "type": {
|
|
2401
|
+
* "id": "10000",
|
|
2402
|
+
* "inward": "depends on",
|
|
2403
|
+
* "name": "Dependent",
|
|
2404
|
+
* "outward": "is depended by"
|
|
2405
|
+
* }
|
|
2406
|
+
* },
|
|
2407
|
+
* {
|
|
2408
|
+
* "id": "10002",
|
|
2409
|
+
* "inwardIssue": {
|
|
2410
|
+
* "fields": {
|
|
2411
|
+
* "status": {
|
|
2412
|
+
* "iconUrl":
|
|
2413
|
+
* "https://your-domain.atlassian.net/images/icons/statuses/open.png",
|
|
2414
|
+
* "name": "Open"
|
|
2415
|
+
* }
|
|
2416
|
+
* },
|
|
2417
|
+
* "id": "10004",
|
|
2418
|
+
* "key": "PR-3",
|
|
2419
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/PR-3"
|
|
2420
|
+
* },
|
|
2421
|
+
* "type": {
|
|
2422
|
+
* "id": "10000",
|
|
2423
|
+
* "inward": "depends on",
|
|
2424
|
+
* "name": "Dependent",
|
|
2425
|
+
* "outward": "is depended by"
|
|
2426
|
+
* }
|
|
2427
|
+
* }
|
|
2428
|
+
* ],
|
|
2429
|
+
* "worklog": [
|
|
2430
|
+
* {
|
|
2431
|
+
* "author": {
|
|
2432
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
2433
|
+
* "active": false,
|
|
2434
|
+
* "displayName": "Mia Krystof",
|
|
2435
|
+
* "self":
|
|
2436
|
+
* "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
2437
|
+
* },
|
|
2438
|
+
* "comment": {
|
|
2439
|
+
* "type": "doc",
|
|
2440
|
+
* "version": 1,
|
|
2441
|
+
* "content": [
|
|
2442
|
+
* {
|
|
2443
|
+
* "type": "paragraph",
|
|
2444
|
+
* "content": [
|
|
2445
|
+
* {
|
|
2446
|
+
* "type": "text",
|
|
2447
|
+
* "text": "I did some work here."
|
|
2448
|
+
* }
|
|
2449
|
+
* ]
|
|
2450
|
+
* }
|
|
2451
|
+
* ]
|
|
2452
|
+
* },
|
|
2453
|
+
* "id": "100028",
|
|
2454
|
+
* "issueId": "10002",
|
|
2455
|
+
* "self":
|
|
2456
|
+
* "https://your-domain.atlassian.net/rest/api/3/issue/10010/worklog/10000",
|
|
2457
|
+
* "started": "2021-01-17T12:34:00.000+0000",
|
|
2458
|
+
* "timeSpent": "3h 20m",
|
|
2459
|
+
* "timeSpentSeconds": 12000,
|
|
2460
|
+
* "updateAuthor": {
|
|
2461
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
2462
|
+
* "active": false,
|
|
2463
|
+
* "displayName": "Mia Krystof",
|
|
2464
|
+
* "self":
|
|
2465
|
+
* "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g"
|
|
2466
|
+
* },
|
|
2467
|
+
* "updated": "2021-01-18T23:45:00.000+0000",
|
|
2468
|
+
* "visibility": {
|
|
2469
|
+
* "identifier": "276f955c-63d7-42c8-9520-92d01dca0625",
|
|
2470
|
+
* "type": "group",
|
|
2471
|
+
* "value": "jira-developers"
|
|
2472
|
+
* }
|
|
2473
|
+
* }
|
|
2474
|
+
* ],
|
|
2475
|
+
* "updated": 1,
|
|
2476
|
+
* "timetracking": {
|
|
2477
|
+
* "originalEstimate": "10m",
|
|
2478
|
+
* "originalEstimateSeconds": 600,
|
|
2479
|
+
* "remainingEstimate": "3m",
|
|
2480
|
+
* "remainingEstimateSeconds": 200,
|
|
2481
|
+
* "timeSpent": "6m",
|
|
2482
|
+
* "timeSpentSeconds": 400
|
|
2483
|
+
* }
|
|
2484
|
+
* },
|
|
2485
|
+
* "id": "10002",
|
|
2486
|
+
* "key": "ED-1",
|
|
2487
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002"
|
|
2488
|
+
* }
|
|
2489
|
+
* @path {GET} /rest/api/3/issue/{issueIdOrKey}
|
|
2490
|
+
* @scopes-current read:jira-work
|
|
2491
|
+
* @scopes-beta read:issue-meta:jira, read:issue-security-level:jira, read:issue.vote:jira,
|
|
2492
|
+
* read:issue.changelog:jira, read:avatar:jira, read:issue:jira, read:status:jira,
|
|
2493
|
+
* read:user:jira, read:field-configuration:jira
|
|
2494
|
+
*/
|
|
2495
|
+
getIssue({
|
|
2496
|
+
issueIdOrKey,
|
|
2497
|
+
fields,
|
|
2498
|
+
fieldsByKeys,
|
|
2499
|
+
expand,
|
|
2500
|
+
properties,
|
|
2501
|
+
updateHistory,
|
|
2502
|
+
}: {
|
|
2503
|
+
/** The ID or key of the issue. */
|
|
2504
|
+
issueIdOrKey: string;
|
|
2505
|
+
/**
|
|
2506
|
+
* A list of fields to return for the issue. This parameter accepts a
|
|
2507
|
+
* comma-separated list. Use it to retrieve a subset of fields. Allowed values:
|
|
2508
|
+
*
|
|
2509
|
+
* * `*all` Returns all fields.
|
|
2510
|
+
* * `*navigable` Returns navigable fields.
|
|
2511
|
+
* * Any issue field, prefixed with a minus to exclude.
|
|
2512
|
+
*
|
|
2513
|
+
* Examples:
|
|
2514
|
+
*
|
|
2515
|
+
* * `summary,comment` Returns only the summary and comments fields.
|
|
2516
|
+
* * `-description` Returns all (default) fields except description.
|
|
2517
|
+
* * `*navigable,-comment` Returns all navigable fields except comment.
|
|
2518
|
+
*
|
|
2519
|
+
* This parameter may be specified multiple times. For example,
|
|
2520
|
+
* `fields=field1,field2& fields=field3`.
|
|
2521
|
+
*
|
|
2522
|
+
* Note: All fields are returned by default. This differs from [Search for issues
|
|
2523
|
+
* using JQL (GET)](#api-rest-api-3-search-get) and [Search for issues using JQL
|
|
2524
|
+
* (POST)](#api-rest-api-3-search-post) where the default is all navigable fields.
|
|
2525
|
+
*/
|
|
2526
|
+
fields?: string[];
|
|
2527
|
+
/**
|
|
2528
|
+
* Whether fields in `fields` are referenced by keys rather than IDs. This
|
|
2529
|
+
* parameter is useful where fields have been added by a connect app and a field's
|
|
2530
|
+
* key may differ from its ID.
|
|
2531
|
+
*/
|
|
2532
|
+
fieldsByKeys?: boolean;
|
|
2533
|
+
/**
|
|
2534
|
+
* Use [expand](#expansion) to include additional information about the issues in
|
|
2535
|
+
* the response. This parameter accepts a comma-separated list. Expand options
|
|
2536
|
+
* include:
|
|
2537
|
+
*
|
|
2538
|
+
* * `renderedFields` Returns field values rendered in HTML format.
|
|
2539
|
+
* * `names` Returns the display name of each field.
|
|
2540
|
+
* * `schema` Returns the schema describing a field type.
|
|
2541
|
+
* * `transitions` Returns all possible transitions for the issue.
|
|
2542
|
+
* * `editmeta` Returns information about how each field can be edited.
|
|
2543
|
+
* * `changelog` Returns a list of recent updates to an issue, sorted by date,
|
|
2544
|
+
* starting from the most recent.
|
|
2545
|
+
* * `versionedRepresentations` Returns a JSON array for each version of a
|
|
2546
|
+
* field's value, with the highest number representing the most recent version.
|
|
2547
|
+
* Note: When included in the request, the `fields` parameter is ignored.
|
|
2548
|
+
*/
|
|
2549
|
+
expand?: string;
|
|
2550
|
+
/**
|
|
2551
|
+
* A list of issue properties to return for the issue. This parameter accepts a
|
|
2552
|
+
* comma-separated list. Allowed values:
|
|
2553
|
+
*
|
|
2554
|
+
* * `*all` Returns all issue properties.
|
|
2555
|
+
* * Any issue property key, prefixed with a minus to exclude.
|
|
2556
|
+
*
|
|
2557
|
+
* Examples:
|
|
2558
|
+
*
|
|
2559
|
+
* * `*all` Returns all properties.
|
|
2560
|
+
* * `*all,-prop1` Returns all properties except `prop1`.
|
|
2561
|
+
* * `prop1,prop2` Returns `prop1` and `prop2` properties.
|
|
2562
|
+
*
|
|
2563
|
+
* This parameter may be specified multiple times. For example,
|
|
2564
|
+
* `properties=prop1,prop2& properties=prop3`.
|
|
2565
|
+
*/
|
|
2566
|
+
properties?: string[];
|
|
2567
|
+
/**
|
|
2568
|
+
* Whether the project in which the issue is created is added to the user's
|
|
2569
|
+
* **Recently viewed** project list, as shown under **Projects** in Jira. This
|
|
2570
|
+
* also populates the [JQL issues search](#api-rest-api-3-search-get) `lastViewed`
|
|
2571
|
+
* field.
|
|
2572
|
+
*/
|
|
2573
|
+
updateHistory?: boolean;
|
|
2574
|
+
}): Promise<IssueBean> {
|
|
2575
|
+
return this.getClientInstance()
|
|
2576
|
+
.request({
|
|
2577
|
+
path: "/rest/api/3/issue/{issueIdOrKey}",
|
|
2578
|
+
method: "GET",
|
|
2579
|
+
pathParams: {
|
|
2580
|
+
issueIdOrKey,
|
|
2581
|
+
},
|
|
2582
|
+
query: {
|
|
2583
|
+
fields,
|
|
2584
|
+
fieldsByKeys,
|
|
2585
|
+
expand,
|
|
2586
|
+
properties,
|
|
2587
|
+
updateHistory,
|
|
2588
|
+
},
|
|
2589
|
+
})
|
|
2590
|
+
.then(
|
|
2591
|
+
this.getClientInstance().responseHandler({
|
|
2592
|
+
200: {
|
|
2593
|
+
"application/json": "json",
|
|
2594
|
+
},
|
|
2595
|
+
}),
|
|
2596
|
+
)
|
|
2597
|
+
.then(
|
|
2598
|
+
commonHttpClient.castResponse<{
|
|
2599
|
+
status: 200;
|
|
2600
|
+
mediaType: "application/json";
|
|
2601
|
+
body: IssueBean;
|
|
2602
|
+
}>(),
|
|
2603
|
+
)
|
|
2604
|
+
.then(
|
|
2605
|
+
validationSchemaStorage.validator("IssuesService.getIssue.response"),
|
|
2606
|
+
)
|
|
2607
|
+
.then(commonHttpClient.getBody);
|
|
2608
|
+
}
|
|
2609
|
+
/**
|
|
2610
|
+
* Returns all issues breaching and approaching per-issue limits.
|
|
2611
|
+
*
|
|
2612
|
+
* **[Permissions](#permissions) required:**
|
|
2613
|
+
*
|
|
2614
|
+
* * *Browse projects* [project
|
|
2615
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) is required for the
|
|
2616
|
+
* project the issues are in. Results may be incomplete otherwise
|
|
2617
|
+
* * *Administer Jira* [global
|
|
2618
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg).
|
|
2619
|
+
*
|
|
2620
|
+
* @returns Returned if the request is successful.
|
|
2621
|
+
*
|
|
2622
|
+
* example: {
|
|
2623
|
+
* "issuesApproachingLimit": {
|
|
2624
|
+
* "attachment": {
|
|
2625
|
+
* "15070": 1822,
|
|
2626
|
+
* "15111": 1999
|
|
2627
|
+
* },
|
|
2628
|
+
* "comment": {
|
|
2629
|
+
* "10000": 4997,
|
|
2630
|
+
* "15073": 4999,
|
|
2631
|
+
* "15110": 5000
|
|
2632
|
+
* },
|
|
2633
|
+
* "remoteIssueLinks": {
|
|
2634
|
+
* "15107": 2000
|
|
2635
|
+
* },
|
|
2636
|
+
* "worklog": {
|
|
2637
|
+
* "15101": 4342
|
|
2638
|
+
* }
|
|
2639
|
+
* },
|
|
2640
|
+
* "issuesBreachingLimit": {
|
|
2641
|
+
* "attachment": {
|
|
2642
|
+
* "15057": 2005,
|
|
2643
|
+
* "15116": 2065,
|
|
2644
|
+
* "15117": 3005
|
|
2645
|
+
* },
|
|
2646
|
+
* "comment": {
|
|
2647
|
+
* "15055": 5202
|
|
2648
|
+
* },
|
|
2649
|
+
* "issuelinks": {
|
|
2650
|
+
* "15058": 2120
|
|
2651
|
+
* },
|
|
2652
|
+
* "remoteIssueLinks": {
|
|
2653
|
+
* "15059": 2094
|
|
2654
|
+
* },
|
|
2655
|
+
* "worklog": {
|
|
2656
|
+
* "15056": 5085,
|
|
2657
|
+
* "15169": 120864
|
|
2658
|
+
* }
|
|
2659
|
+
* },
|
|
2660
|
+
* "limits": {
|
|
2661
|
+
* "attachment": 2000,
|
|
2662
|
+
* "comment": 5000,
|
|
2663
|
+
* "issuelinks": 2000,
|
|
2664
|
+
* "remoteIssueLinks": 2000,
|
|
2665
|
+
* "worklog": 5000
|
|
2666
|
+
* }
|
|
2667
|
+
* }
|
|
2668
|
+
* @path {GET} /rest/api/3/issue/limit/report
|
|
2669
|
+
* @scopes-current read:jira-work
|
|
2670
|
+
* @scopes-beta read:project:jira, read:issue:jira
|
|
2671
|
+
*/
|
|
2672
|
+
getIssueLimitReport({
|
|
2673
|
+
issueLimitReportRequest,
|
|
2674
|
+
}: {
|
|
2675
|
+
issueLimitReportRequest: IssueLimitReportRequest;
|
|
2676
|
+
}): Promise<IssueLimitReportResponseBean> {
|
|
2677
|
+
return this.getClientInstance()
|
|
2678
|
+
.request({
|
|
2679
|
+
path: "/rest/api/3/issue/limit/report",
|
|
2680
|
+
method: "GET",
|
|
2681
|
+
headers: {
|
|
2682
|
+
"Content-Type": "application/json",
|
|
2683
|
+
},
|
|
2684
|
+
body: issueLimitReportRequest,
|
|
2685
|
+
})
|
|
2686
|
+
.then(
|
|
2687
|
+
this.getClientInstance().responseHandler({
|
|
2688
|
+
200: {
|
|
2689
|
+
"application/json": "json",
|
|
2690
|
+
},
|
|
2691
|
+
}),
|
|
2692
|
+
)
|
|
2693
|
+
.then(
|
|
2694
|
+
commonHttpClient.castResponse<{
|
|
2695
|
+
status: 200;
|
|
2696
|
+
mediaType: "application/json";
|
|
2697
|
+
body: IssueLimitReportResponseBean;
|
|
2698
|
+
}>(),
|
|
2699
|
+
)
|
|
2700
|
+
.then(
|
|
2701
|
+
validationSchemaStorage.validator(
|
|
2702
|
+
"IssuesService.getIssueLimitReport.response",
|
|
2703
|
+
),
|
|
2704
|
+
)
|
|
2705
|
+
.then(commonHttpClient.getBody);
|
|
2706
|
+
}
|
|
2707
|
+
/**
|
|
2708
|
+
* Returns either all transitions or a transition that can be performed by the
|
|
2709
|
+
* user on an issue, based on the issue's status.
|
|
2710
|
+
*
|
|
2711
|
+
* Note, if a request is made for a transition that does not exist or cannot be
|
|
2712
|
+
* performed on the issue, given its status, the response will return any empty
|
|
2713
|
+
* transitions list.
|
|
2714
|
+
*
|
|
2715
|
+
* This operation can be accessed anonymously.
|
|
2716
|
+
*
|
|
2717
|
+
* **[Permissions](#permissions) required: A list or transition is returned only
|
|
2718
|
+
* when the user has:**
|
|
2719
|
+
*
|
|
2720
|
+
* * *Browse projects* [project
|
|
2721
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
|
|
2722
|
+
* issue is in.
|
|
2723
|
+
* * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
|
|
2724
|
+
* configured, issue-level security permission to view the issue.
|
|
2725
|
+
*
|
|
2726
|
+
* However, if the user does not have the *Transition issues* [ project
|
|
2727
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) the response will not
|
|
2728
|
+
* list any transitions.
|
|
2729
|
+
*
|
|
2730
|
+
* @returns Returned if the request is successful.
|
|
2731
|
+
*
|
|
2732
|
+
* example: {
|
|
2733
|
+
* "transitions": [
|
|
2734
|
+
* {
|
|
2735
|
+
* "fields": {
|
|
2736
|
+
* "summary": {
|
|
2737
|
+
* "allowedValues": [
|
|
2738
|
+
* "red",
|
|
2739
|
+
* "blue"
|
|
2740
|
+
* ],
|
|
2741
|
+
* "defaultValue": "red",
|
|
2742
|
+
* "hasDefaultValue": false,
|
|
2743
|
+
* "key": "field_key",
|
|
2744
|
+
* "name": "My Multi Select",
|
|
2745
|
+
* "operations": [
|
|
2746
|
+
* "set",
|
|
2747
|
+
* "add"
|
|
2748
|
+
* ],
|
|
2749
|
+
* "required": false,
|
|
2750
|
+
* "schema": {
|
|
2751
|
+
* "custom":
|
|
2752
|
+
* "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
|
|
2753
|
+
* "customId": 10001,
|
|
2754
|
+
* "items": "option",
|
|
2755
|
+
* "type": "array"
|
|
2756
|
+
* }
|
|
2757
|
+
* }
|
|
2758
|
+
* },
|
|
2759
|
+
* "hasScreen": false,
|
|
2760
|
+
* "id": "2",
|
|
2761
|
+
* "isAvailable": true,
|
|
2762
|
+
* "isConditional": false,
|
|
2763
|
+
* "isGlobal": false,
|
|
2764
|
+
* "isInitial": false,
|
|
2765
|
+
* "name": "Close Issue",
|
|
2766
|
+
* "to": {
|
|
2767
|
+
* "description": "The issue is currently being worked on.",
|
|
2768
|
+
* "iconUrl":
|
|
2769
|
+
* "https://your-domain.atlassian.net/images/icons/progress.gif",
|
|
2770
|
+
* "id": "10000",
|
|
2771
|
+
* "name": "In Progress",
|
|
2772
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/status/10000",
|
|
2773
|
+
* "statusCategory": {
|
|
2774
|
+
* "colorName": "yellow",
|
|
2775
|
+
* "id": 1,
|
|
2776
|
+
* "key": "in-flight",
|
|
2777
|
+
* "name": "In Progress",
|
|
2778
|
+
* "self":
|
|
2779
|
+
* "https://your-domain.atlassian.net/rest/api/3/statuscategory/1"
|
|
2780
|
+
* }
|
|
2781
|
+
* }
|
|
2782
|
+
* },
|
|
2783
|
+
* {
|
|
2784
|
+
* "fields": {
|
|
2785
|
+
* "summary": {
|
|
2786
|
+
* "allowedValues": [
|
|
2787
|
+
* "red",
|
|
2788
|
+
* "blue"
|
|
2789
|
+
* ],
|
|
2790
|
+
* "defaultValue": "red",
|
|
2791
|
+
* "hasDefaultValue": false,
|
|
2792
|
+
* "key": "field_key",
|
|
2793
|
+
* "name": "My Multi Select",
|
|
2794
|
+
* "operations": [
|
|
2795
|
+
* "set",
|
|
2796
|
+
* "add"
|
|
2797
|
+
* ],
|
|
2798
|
+
* "required": false,
|
|
2799
|
+
* "schema": {
|
|
2800
|
+
* "custom":
|
|
2801
|
+
* "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
|
|
2802
|
+
* "customId": 10001,
|
|
2803
|
+
* "items": "option",
|
|
2804
|
+
* "type": "array"
|
|
2805
|
+
* }
|
|
2806
|
+
* },
|
|
2807
|
+
* "colour": {
|
|
2808
|
+
* "allowedValues": [
|
|
2809
|
+
* "red",
|
|
2810
|
+
* "blue"
|
|
2811
|
+
* ],
|
|
2812
|
+
* "defaultValue": "red",
|
|
2813
|
+
* "hasDefaultValue": false,
|
|
2814
|
+
* "key": "field_key",
|
|
2815
|
+
* "name": "My Multi Select",
|
|
2816
|
+
* "operations": [
|
|
2817
|
+
* "set",
|
|
2818
|
+
* "add"
|
|
2819
|
+
* ],
|
|
2820
|
+
* "required": false,
|
|
2821
|
+
* "schema": {
|
|
2822
|
+
* "custom":
|
|
2823
|
+
* "com.atlassian.jira.plugin.system.customfieldtypes:multiselect",
|
|
2824
|
+
* "customId": 10001,
|
|
2825
|
+
* "items": "option",
|
|
2826
|
+
* "type": "array"
|
|
2827
|
+
* }
|
|
2828
|
+
* }
|
|
2829
|
+
* },
|
|
2830
|
+
* "hasScreen": true,
|
|
2831
|
+
* "id": "711",
|
|
2832
|
+
* "name": "QA Review",
|
|
2833
|
+
* "to": {
|
|
2834
|
+
* "description": "The issue is closed.",
|
|
2835
|
+
* "iconUrl": "https://your-domain.atlassian.net/images/icons/closed.gif",
|
|
2836
|
+
* "id": "5",
|
|
2837
|
+
* "name": "Closed",
|
|
2838
|
+
* "self": "https://your-domain.atlassian.net/rest/api/3/status/5",
|
|
2839
|
+
* "statusCategory": {
|
|
2840
|
+
* "colorName": "green",
|
|
2841
|
+
* "id": 9,
|
|
2842
|
+
* "key": "completed",
|
|
2843
|
+
* "self":
|
|
2844
|
+
* "https://your-domain.atlassian.net/rest/api/3/statuscategory/9"
|
|
2845
|
+
* }
|
|
2846
|
+
* }
|
|
2847
|
+
* }
|
|
2848
|
+
* ]
|
|
2849
|
+
* }
|
|
2850
|
+
* @path {GET} /rest/api/3/issue/{issueIdOrKey}/transitions
|
|
2851
|
+
* @scopes-current read:jira-work
|
|
2852
|
+
* @scopes-beta read:issue.transition:jira, read:status:jira, read:field-configuration:jira
|
|
2853
|
+
*/
|
|
2854
|
+
getTransitions({
|
|
2855
|
+
issueIdOrKey,
|
|
2856
|
+
expand,
|
|
2857
|
+
transitionId,
|
|
2858
|
+
skipRemoteOnlyCondition,
|
|
2859
|
+
includeUnavailableTransitions,
|
|
2860
|
+
sortByOpsBarAndStatus,
|
|
2861
|
+
}: {
|
|
2862
|
+
/** The ID or key of the issue. */
|
|
2863
|
+
issueIdOrKey: string;
|
|
2864
|
+
/**
|
|
2865
|
+
* Use [expand](#expansion) to include additional information about transitions in
|
|
2866
|
+
* the response. This parameter accepts `transitions.fields`, which returns
|
|
2867
|
+
* information about the fields in the transition screen for each transition.
|
|
2868
|
+
* Fields hidden from the screen are not returned. Use this information to
|
|
2869
|
+
* populate the `fields` and `update` fields in [Transition
|
|
2870
|
+
* issue](#api-rest-api-3-issue-issueIdOrKey-transitions-post).
|
|
2871
|
+
*/
|
|
2872
|
+
expand?: string;
|
|
2873
|
+
/** The ID of the transition. */
|
|
2874
|
+
transitionId?: string;
|
|
2875
|
+
/**
|
|
2876
|
+
* Whether transitions with the condition *Hide From User Condition* are included
|
|
2877
|
+
* in the response.
|
|
2878
|
+
*/
|
|
2879
|
+
skipRemoteOnlyCondition?: boolean;
|
|
2880
|
+
/**
|
|
2881
|
+
* Whether details of transitions that fail a condition are included in the
|
|
2882
|
+
* response
|
|
2883
|
+
*/
|
|
2884
|
+
includeUnavailableTransitions?: boolean;
|
|
2885
|
+
/**
|
|
2886
|
+
* Whether the transitions are sorted by ops-bar sequence value first then
|
|
2887
|
+
* category order (Todo, In Progress, Done) or only by ops-bar sequence value.
|
|
2888
|
+
*/
|
|
2889
|
+
sortByOpsBarAndStatus?: boolean;
|
|
2890
|
+
}): Promise<Transitions> {
|
|
2891
|
+
return this.getClientInstance()
|
|
2892
|
+
.request({
|
|
2893
|
+
path: "/rest/api/3/issue/{issueIdOrKey}/transitions",
|
|
2894
|
+
method: "GET",
|
|
2895
|
+
pathParams: {
|
|
2896
|
+
issueIdOrKey,
|
|
2897
|
+
},
|
|
2898
|
+
query: {
|
|
2899
|
+
expand,
|
|
2900
|
+
transitionId,
|
|
2901
|
+
skipRemoteOnlyCondition,
|
|
2902
|
+
includeUnavailableTransitions,
|
|
2903
|
+
sortByOpsBarAndStatus,
|
|
2904
|
+
},
|
|
2905
|
+
})
|
|
2906
|
+
.then(
|
|
2907
|
+
this.getClientInstance().responseHandler({
|
|
2908
|
+
200: {
|
|
2909
|
+
"application/json": "json",
|
|
2910
|
+
},
|
|
2911
|
+
}),
|
|
2912
|
+
)
|
|
2913
|
+
.then(
|
|
2914
|
+
commonHttpClient.castResponse<{
|
|
2915
|
+
status: 200;
|
|
2916
|
+
mediaType: "application/json";
|
|
2917
|
+
body: Transitions;
|
|
2918
|
+
}>(),
|
|
2919
|
+
)
|
|
2920
|
+
.then(
|
|
2921
|
+
validationSchemaStorage.validator(
|
|
2922
|
+
"IssuesService.getTransitions.response",
|
|
2923
|
+
),
|
|
2924
|
+
)
|
|
2925
|
+
.then(commonHttpClient.getBody);
|
|
2926
|
+
}
|
|
2927
|
+
/**
|
|
2928
|
+
* Creates an email notification for an issue and adds it to the mail queue.
|
|
2929
|
+
*
|
|
2930
|
+
* **[Permissions](#permissions) required:**
|
|
2931
|
+
*
|
|
2932
|
+
* * *Browse Projects* [project
|
|
2933
|
+
* permission](https://confluence.atlassian.com/x/yodKLg) for the project that the
|
|
2934
|
+
* issue is in.
|
|
2935
|
+
* * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is
|
|
2936
|
+
* configured, issue-level security permission to view the issue.
|
|
2937
|
+
*
|
|
2938
|
+
* @returns Returned if the email is queued for sending.
|
|
2939
|
+
* @path {POST} /rest/api/3/issue/{issueIdOrKey}/notify
|
|
2940
|
+
* @scopes-current write:jira-work
|
|
2941
|
+
* @scopes-beta send:notification:jira
|
|
2942
|
+
*/
|
|
2943
|
+
notify({
|
|
2944
|
+
issueIdOrKey,
|
|
2945
|
+
notification,
|
|
2946
|
+
}: {
|
|
2947
|
+
/** ID or key of the issue that the notification is sent for. */
|
|
2948
|
+
issueIdOrKey: string;
|
|
2949
|
+
/**
|
|
2950
|
+
* The request object for the notification and recipients.
|
|
2951
|
+
*
|
|
2952
|
+
* @example {
|
|
2953
|
+
* "htmlBody": "The <strong>latest</strong> test results for this ticket are
|
|
2954
|
+
* now available.",
|
|
2955
|
+
* "restrict": {
|
|
2956
|
+
* "groupIds": [],
|
|
2957
|
+
* "groups": [
|
|
2958
|
+
* {
|
|
2959
|
+
* "name": "notification-group"
|
|
2960
|
+
* }
|
|
2961
|
+
* ],
|
|
2962
|
+
* "permissions": [
|
|
2963
|
+
* {
|
|
2964
|
+
* "key": "BROWSE"
|
|
2965
|
+
* }
|
|
2966
|
+
* ]
|
|
2967
|
+
* },
|
|
2968
|
+
* "subject": "Latest test results",
|
|
2969
|
+
* "textBody": "The latest test results for this ticket are now available.",
|
|
2970
|
+
* "to": {
|
|
2971
|
+
* "assignee": false,
|
|
2972
|
+
* "groupIds": [],
|
|
2973
|
+
* "groups": [
|
|
2974
|
+
* {
|
|
2975
|
+
* "name": "notification-group"
|
|
2976
|
+
* }
|
|
2977
|
+
* ],
|
|
2978
|
+
* "reporter": false,
|
|
2979
|
+
* "users": [
|
|
2980
|
+
* {
|
|
2981
|
+
* "accountId": "5b10a2844c20165700ede21g",
|
|
2982
|
+
* "active": false
|
|
2983
|
+
* }
|
|
2984
|
+
* ],
|
|
2985
|
+
* "voters": true,
|
|
2986
|
+
* "watchers": true
|
|
2987
|
+
* }
|
|
2988
|
+
* }
|
|
2989
|
+
*/
|
|
2990
|
+
notification: Notification;
|
|
2991
|
+
}): Promise<void> {
|
|
2992
|
+
return this.getClientInstance()
|
|
2993
|
+
.request({
|
|
2994
|
+
path: "/rest/api/3/issue/{issueIdOrKey}/notify",
|
|
2995
|
+
method: "POST",
|
|
2996
|
+
pathParams: {
|
|
2997
|
+
issueIdOrKey,
|
|
2998
|
+
},
|
|
2999
|
+
headers: {
|
|
3000
|
+
"Content-Type": "application/json",
|
|
3001
|
+
},
|
|
3002
|
+
body: notification,
|
|
3003
|
+
})
|
|
3004
|
+
.then(
|
|
3005
|
+
this.getClientInstance().responseHandler({
|
|
3006
|
+
204: {
|
|
3007
|
+
"application/json": "json",
|
|
3008
|
+
},
|
|
3009
|
+
}),
|
|
3010
|
+
)
|
|
3011
|
+
.then(
|
|
3012
|
+
commonHttpClient.castResponse<{
|
|
3013
|
+
status: 204;
|
|
3014
|
+
mediaType: "application/json";
|
|
3015
|
+
body: void;
|
|
3016
|
+
}>(),
|
|
3017
|
+
)
|
|
3018
|
+
.then(validationSchemaStorage.validator("IssuesService.notify.response"))
|
|
3019
|
+
.then(commonHttpClient.getBody);
|
|
3020
|
+
}
|
|
3021
|
+
/**
|
|
3022
|
+
* Enables admins to unarchive up to 1000 issues in a single request using issue
|
|
3023
|
+
* ID/key, returning details of the issue(s) unarchived in the process and the
|
|
3024
|
+
* errors encountered, if any.
|
|
3025
|
+
*
|
|
3026
|
+
* **Note that:**
|
|
3027
|
+
*
|
|
3028
|
+
* * you can't unarchive subtasks directly, only through their parent issues
|
|
3029
|
+
* * you can only unarchive issues from software, service management, and
|
|
3030
|
+
* business projects
|
|
3031
|
+
*
|
|
3032
|
+
* **[Permissions](#permissions) required:** Jira admin or site admin: [global
|
|
3033
|
+
* permission](https://confluence.atlassian.com/x/x4dKLg)
|
|
3034
|
+
*
|
|
3035
|
+
* **License required:** Premium or Enterprise
|
|
3036
|
+
*
|
|
3037
|
+
* **Signed-in users only:** This API can't be accessed anonymously.
|
|
3038
|
+
*
|
|
3039
|
+
* @returns Returned if there is at least one valid issue to unarchive in the request. It
|
|
3040
|
+
* will return the count of unarchived issues, which also includes the count of
|
|
3041
|
+
* the subtasks unarchived, and it will show the detailed errors for those issues
|
|
3042
|
+
* which are not unarchived.
|
|
3043
|
+
*
|
|
3044
|
+
* example: {
|
|
3045
|
+
* "errors": {
|
|
3046
|
+
* "issueIsSubtask": {
|
|
3047
|
+
* "count": 3,
|
|
3048
|
+
* "issueIdsOrKeys": [
|
|
3049
|
+
* "ST-1",
|
|
3050
|
+
* "ST-2",
|
|
3051
|
+
* "ST-3"
|
|
3052
|
+
* ],
|
|
3053
|
+
* "message": "Issue is subtask."
|
|
3054
|
+
* },
|
|
3055
|
+
* "issuesInArchivedProjects": {
|
|
3056
|
+
* "count": 2,
|
|
3057
|
+
* "issueIdsOrKeys": [
|
|
3058
|
+
* "AR-1",
|
|
3059
|
+
* "AR-2"
|
|
3060
|
+
* ],
|
|
3061
|
+
* "message": "Issue exists in archived project."
|
|
3062
|
+
* },
|
|
3063
|
+
* "issuesNotFound": {
|
|
3064
|
+
* "count": 3,
|
|
3065
|
+
* "issueIdsOrKeys": [
|
|
3066
|
+
* "PR-1",
|
|
3067
|
+
* "PR-2",
|
|
3068
|
+
* "PR-3"
|
|
3069
|
+
* ],
|
|
3070
|
+
* "message": "Issue not found."
|
|
3071
|
+
* }
|
|
3072
|
+
* },
|
|
3073
|
+
* "numberOfIssuesUpdated": 10
|
|
3074
|
+
* }
|
|
3075
|
+
* @path {PUT} /rest/api/3/issue/unarchive
|
|
3076
|
+
* @scopes-current write:jira-work
|
|
3077
|
+
* @scopes-beta write:issue:jira
|
|
3078
|
+
*/
|
|
3079
|
+
unarchiveIssues({
|
|
3080
|
+
issueArchivalSyncRequest,
|
|
3081
|
+
}: {
|
|
3082
|
+
/**
|
|
3083
|
+
* Contains a list of issue keys or IDs to be unarchived.
|
|
3084
|
+
*
|
|
3085
|
+
* @example {
|
|
3086
|
+
* "issueIdsOrKeys": [
|
|
3087
|
+
* "PR-1",
|
|
3088
|
+
* "1001",
|
|
3089
|
+
* "PROJECT-2"
|
|
3090
|
+
* ]
|
|
3091
|
+
* }
|
|
3092
|
+
*/
|
|
3093
|
+
issueArchivalSyncRequest: IssueArchivalSyncRequest;
|
|
3094
|
+
}): Promise<IssueArchivalSyncResponse> {
|
|
3095
|
+
return this.getClientInstance()
|
|
3096
|
+
.request({
|
|
3097
|
+
path: "/rest/api/3/issue/unarchive",
|
|
3098
|
+
method: "PUT",
|
|
3099
|
+
headers: {
|
|
3100
|
+
"Content-Type": "application/json",
|
|
3101
|
+
},
|
|
3102
|
+
body: issueArchivalSyncRequest,
|
|
3103
|
+
})
|
|
3104
|
+
.then(
|
|
3105
|
+
this.getClientInstance().responseHandler({
|
|
3106
|
+
200: {
|
|
3107
|
+
"application/json": "json",
|
|
3108
|
+
},
|
|
3109
|
+
}),
|
|
3110
|
+
)
|
|
3111
|
+
.then(
|
|
3112
|
+
commonHttpClient.castResponse<{
|
|
3113
|
+
status: 200;
|
|
3114
|
+
mediaType: "application/json";
|
|
3115
|
+
body: IssueArchivalSyncResponse;
|
|
3116
|
+
}>(),
|
|
3117
|
+
)
|
|
3118
|
+
.then(
|
|
3119
|
+
validationSchemaStorage.validator(
|
|
3120
|
+
"IssuesService.unarchiveIssues.response",
|
|
3121
|
+
),
|
|
3122
|
+
)
|
|
3123
|
+
.then(commonHttpClient.getBody);
|
|
3124
|
+
}
|
|
3125
|
+
static initialize() {
|
|
3126
|
+
validationSchemaStorage.registerExtensible(
|
|
3127
|
+
"IssuesService.getEvents.response",
|
|
3128
|
+
z
|
|
3129
|
+
.object({
|
|
3130
|
+
status: z.literal(200),
|
|
3131
|
+
mediaType: z.literal("application/json"),
|
|
3132
|
+
body: z.array(validationSchemaStorage.lazy("IssueEvent")),
|
|
3133
|
+
})
|
|
3134
|
+
.describe("IssuesService.getEvents.response"),
|
|
3135
|
+
);
|
|
3136
|
+
validationSchemaStorage.registerExtensible(
|
|
3137
|
+
"IssuesService.createIssue.response",
|
|
3138
|
+
z
|
|
3139
|
+
.object({
|
|
3140
|
+
status: z.literal(201),
|
|
3141
|
+
mediaType: z.literal("application/json"),
|
|
3142
|
+
body: validationSchemaStorage.lazy("CreatedIssue"),
|
|
3143
|
+
})
|
|
3144
|
+
.describe("IssuesService.createIssue.response"),
|
|
3145
|
+
);
|
|
3146
|
+
validationSchemaStorage.registerExtensible(
|
|
3147
|
+
"IssuesService.getIssue.response",
|
|
3148
|
+
z
|
|
3149
|
+
.object({
|
|
3150
|
+
status: z.literal(200),
|
|
3151
|
+
mediaType: z.literal("application/json"),
|
|
3152
|
+
body: validationSchemaStorage.lazy("IssueBean"),
|
|
3153
|
+
})
|
|
3154
|
+
.describe("IssuesService.getIssue.response"),
|
|
3155
|
+
);
|
|
3156
|
+
validationSchemaStorage.registerExtensible(
|
|
3157
|
+
"IssuesService.editIssue.response",
|
|
3158
|
+
z
|
|
3159
|
+
.object({
|
|
3160
|
+
status: z.number(),
|
|
3161
|
+
mediaType: z.string(),
|
|
3162
|
+
body: z.unknown(),
|
|
3163
|
+
})
|
|
3164
|
+
.superRefine(({ status: status, body: body }, ctx) => {
|
|
3165
|
+
if (status === 200 || status === 204) {
|
|
3166
|
+
z.unknown().parse(body);
|
|
3167
|
+
} else {
|
|
3168
|
+
ctx.addIssue({
|
|
3169
|
+
code: z.ZodIssueCode.custom,
|
|
3170
|
+
path: ["status"],
|
|
3171
|
+
message: `Unexpected status code: ${status}`,
|
|
3172
|
+
});
|
|
3173
|
+
}
|
|
3174
|
+
})
|
|
3175
|
+
.describe("IssuesService.editIssue.response"),
|
|
3176
|
+
);
|
|
3177
|
+
validationSchemaStorage.registerExtensible(
|
|
3178
|
+
"IssuesService.assignIssue.response",
|
|
3179
|
+
z
|
|
3180
|
+
.object({
|
|
3181
|
+
status: z.literal(204),
|
|
3182
|
+
mediaType: z.literal("application/json"),
|
|
3183
|
+
body: z.unknown(),
|
|
3184
|
+
})
|
|
3185
|
+
.describe("IssuesService.assignIssue.response"),
|
|
3186
|
+
);
|
|
3187
|
+
validationSchemaStorage.registerExtensible(
|
|
3188
|
+
"IssuesService.getChangeLogs.response",
|
|
3189
|
+
z
|
|
3190
|
+
.object({
|
|
3191
|
+
status: z.literal(200),
|
|
3192
|
+
mediaType: z.literal("application/json"),
|
|
3193
|
+
body: validationSchemaStorage.lazy("PageBeanChangelog"),
|
|
3194
|
+
})
|
|
3195
|
+
.describe("IssuesService.getChangeLogs.response"),
|
|
3196
|
+
);
|
|
3197
|
+
validationSchemaStorage.registerExtensible(
|
|
3198
|
+
"IssuesService.getChangeLogsByIds.response",
|
|
3199
|
+
z
|
|
3200
|
+
.object({
|
|
3201
|
+
status: z.literal(200),
|
|
3202
|
+
mediaType: z.literal("application/json"),
|
|
3203
|
+
body: validationSchemaStorage.lazy("PageOfChangelogs"),
|
|
3204
|
+
})
|
|
3205
|
+
.describe("IssuesService.getChangeLogsByIds.response"),
|
|
3206
|
+
);
|
|
3207
|
+
validationSchemaStorage.registerExtensible(
|
|
3208
|
+
"IssuesService.getEditIssueMeta.response",
|
|
3209
|
+
z
|
|
3210
|
+
.object({
|
|
3211
|
+
status: z.literal(200),
|
|
3212
|
+
mediaType: z.literal("application/json"),
|
|
3213
|
+
body: validationSchemaStorage.lazy("IssueUpdateMetadata"),
|
|
3214
|
+
})
|
|
3215
|
+
.describe("IssuesService.getEditIssueMeta.response"),
|
|
3216
|
+
);
|
|
3217
|
+
validationSchemaStorage.registerExtensible(
|
|
3218
|
+
"IssuesService.notify.response",
|
|
3219
|
+
z
|
|
3220
|
+
.object({
|
|
3221
|
+
status: z.literal(204),
|
|
3222
|
+
mediaType: z.literal("application/json"),
|
|
3223
|
+
body: z.unknown(),
|
|
3224
|
+
})
|
|
3225
|
+
.describe("IssuesService.notify.response"),
|
|
3226
|
+
);
|
|
3227
|
+
validationSchemaStorage.registerExtensible(
|
|
3228
|
+
"IssuesService.getTransitions.response",
|
|
3229
|
+
z
|
|
3230
|
+
.object({
|
|
3231
|
+
status: z.literal(200),
|
|
3232
|
+
mediaType: z.literal("application/json"),
|
|
3233
|
+
body: validationSchemaStorage.lazy("Transitions"),
|
|
3234
|
+
})
|
|
3235
|
+
.describe("IssuesService.getTransitions.response"),
|
|
3236
|
+
);
|
|
3237
|
+
validationSchemaStorage.registerExtensible(
|
|
3238
|
+
"IssuesService.doTransition.response",
|
|
3239
|
+
z
|
|
3240
|
+
.object({
|
|
3241
|
+
status: z.literal(204),
|
|
3242
|
+
mediaType: z.literal("application/json"),
|
|
3243
|
+
body: z.unknown(),
|
|
3244
|
+
})
|
|
3245
|
+
.describe("IssuesService.doTransition.response"),
|
|
3246
|
+
);
|
|
3247
|
+
validationSchemaStorage.registerExtensible(
|
|
3248
|
+
"IssuesService.archiveIssues.response",
|
|
3249
|
+
z
|
|
3250
|
+
.object({
|
|
3251
|
+
status: z.literal(200),
|
|
3252
|
+
mediaType: z.literal("application/json"),
|
|
3253
|
+
body: validationSchemaStorage.lazy("IssueArchivalSyncResponse"),
|
|
3254
|
+
})
|
|
3255
|
+
.describe("IssuesService.archiveIssues.response"),
|
|
3256
|
+
);
|
|
3257
|
+
validationSchemaStorage.registerExtensible(
|
|
3258
|
+
"IssuesService.archiveIssuesAsync.response",
|
|
3259
|
+
z
|
|
3260
|
+
.object({
|
|
3261
|
+
status: z.literal(202),
|
|
3262
|
+
mediaType: z.literal("application/json"),
|
|
3263
|
+
body: z.string(),
|
|
3264
|
+
})
|
|
3265
|
+
.describe("IssuesService.archiveIssuesAsync.response"),
|
|
3266
|
+
);
|
|
3267
|
+
validationSchemaStorage.registerExtensible(
|
|
3268
|
+
"IssuesService.createIssues.response",
|
|
3269
|
+
z
|
|
3270
|
+
.object({
|
|
3271
|
+
status: z.literal(201),
|
|
3272
|
+
mediaType: z.literal("application/json"),
|
|
3273
|
+
body: validationSchemaStorage.lazy("CreatedIssues"),
|
|
3274
|
+
})
|
|
3275
|
+
.describe("IssuesService.createIssues.response"),
|
|
3276
|
+
);
|
|
3277
|
+
validationSchemaStorage.registerExtensible(
|
|
3278
|
+
"IssuesService.getCreateIssueMeta.response",
|
|
3279
|
+
z
|
|
3280
|
+
.object({
|
|
3281
|
+
status: z.literal(200),
|
|
3282
|
+
mediaType: z.literal("application/json"),
|
|
3283
|
+
body: validationSchemaStorage.lazy("IssueCreateMetadata"),
|
|
3284
|
+
})
|
|
3285
|
+
.describe("IssuesService.getCreateIssueMeta.response"),
|
|
3286
|
+
);
|
|
3287
|
+
validationSchemaStorage.registerExtensible(
|
|
3288
|
+
"IssuesService.getCreateIssueMetaIssueTypes.response",
|
|
3289
|
+
z
|
|
3290
|
+
.object({
|
|
3291
|
+
status: z.literal(200),
|
|
3292
|
+
mediaType: z.literal("application/json"),
|
|
3293
|
+
body: validationSchemaStorage.lazy("PageOfCreateMetaIssueTypes"),
|
|
3294
|
+
})
|
|
3295
|
+
.describe("IssuesService.getCreateIssueMetaIssueTypes.response"),
|
|
3296
|
+
);
|
|
3297
|
+
validationSchemaStorage.registerExtensible(
|
|
3298
|
+
"IssuesService.getCreateIssueMetaIssueTypeId.response",
|
|
3299
|
+
z
|
|
3300
|
+
.object({
|
|
3301
|
+
status: z.literal(200),
|
|
3302
|
+
mediaType: z.literal("application/json"),
|
|
3303
|
+
body: validationSchemaStorage.lazy(
|
|
3304
|
+
"PageOfCreateMetaIssueTypeWithField",
|
|
3305
|
+
),
|
|
3306
|
+
})
|
|
3307
|
+
.describe("IssuesService.getCreateIssueMetaIssueTypeId.response"),
|
|
3308
|
+
);
|
|
3309
|
+
validationSchemaStorage.registerExtensible(
|
|
3310
|
+
"IssuesService.getIssueLimitReport.response",
|
|
3311
|
+
z
|
|
3312
|
+
.object({
|
|
3313
|
+
status: z.literal(200),
|
|
3314
|
+
mediaType: z.literal("application/json"),
|
|
3315
|
+
body: validationSchemaStorage.lazy("IssueLimitReportResponseBean"),
|
|
3316
|
+
})
|
|
3317
|
+
.describe("IssuesService.getIssueLimitReport.response"),
|
|
3318
|
+
);
|
|
3319
|
+
validationSchemaStorage.registerExtensible(
|
|
3320
|
+
"IssuesService.unarchiveIssues.response",
|
|
3321
|
+
z
|
|
3322
|
+
.object({
|
|
3323
|
+
status: z.literal(200),
|
|
3324
|
+
mediaType: z.literal("application/json"),
|
|
3325
|
+
body: validationSchemaStorage.lazy("IssueArchivalSyncResponse"),
|
|
3326
|
+
})
|
|
3327
|
+
.describe("IssuesService.unarchiveIssues.response"),
|
|
3328
|
+
);
|
|
3329
|
+
validationSchemaStorage.registerExtensible(
|
|
3330
|
+
"IssuesService.exportArchivedIssues.response",
|
|
3331
|
+
z
|
|
3332
|
+
.object({
|
|
3333
|
+
status: z.literal(202),
|
|
3334
|
+
mediaType: z.literal("application/json"),
|
|
3335
|
+
body: validationSchemaStorage.lazy(
|
|
3336
|
+
"ExportArchivedIssuesTaskProgressResponse",
|
|
3337
|
+
),
|
|
3338
|
+
})
|
|
3339
|
+
.describe("IssuesService.exportArchivedIssues.response"),
|
|
3340
|
+
);
|
|
3341
|
+
validationSchemaStorage.registerOnce([
|
|
3342
|
+
registerIssuesValidationSchemas,
|
|
3343
|
+
registerCommonValidationSchemas,
|
|
3344
|
+
]);
|
|
3345
|
+
}
|
|
3346
|
+
}
|