@resolution/jira-api-client 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/package.json +10 -3
- package/.eslintrc.js +0 -3
- package/config/api-typescript-generator.config.ts +0 -91
- package/config/compare-schemas.ts +0 -307
- package/src/index.ts +0 -47
- package/src/openapi/platform/base-jira-platform-api-client.ts +0 -2298
- package/src/openapi/platform/core/common-http-client.ts +0 -723
- package/src/openapi/platform/core/common-http-service.ts +0 -22
- package/src/openapi/platform/core/common-validation-schema-storage.ts +0 -105
- package/src/openapi/platform/models/announcement-banner.ts +0 -59
- package/src/openapi/platform/models/app-data-policies.ts +0 -79
- package/src/openapi/platform/models/app-migration.ts +0 -172
- package/src/openapi/platform/models/app-properties.ts +0 -32
- package/src/openapi/platform/models/audit-records.ts +0 -140
- package/src/openapi/platform/models/avatars.ts +0 -48
- package/src/openapi/platform/models/classification-levels.ts +0 -58
- package/src/openapi/platform/models/common.ts +0 -2669
- package/src/openapi/platform/models/dashboards.ts +0 -849
- package/src/openapi/platform/models/dynamic-modules.ts +0 -121
- package/src/openapi/platform/models/filter-sharing.ts +0 -103
- package/src/openapi/platform/models/filters.ts +0 -319
- package/src/openapi/platform/models/group-and-user-picker.ts +0 -85
- package/src/openapi/platform/models/groups.ts +0 -247
- package/src/openapi/platform/models/issue-attachments.ts +0 -290
- package/src/openapi/platform/models/issue-comment-properties.ts +0 -27
- package/src/openapi/platform/models/issue-comments.ts +0 -91
- package/src/openapi/platform/models/issue-custom-field-configuration-apps.ts +0 -96
- package/src/openapi/platform/models/issue-custom-field-contexts.ts +0 -1072
- package/src/openapi/platform/models/issue-custom-field-options-apps.ts +0 -273
- package/src/openapi/platform/models/issue-custom-field-options.ts +0 -283
- package/src/openapi/platform/models/issue-custom-field-values-apps.ts +0 -118
- package/src/openapi/platform/models/issue-field-configurations.ts +0 -435
- package/src/openapi/platform/models/issue-fields.ts +0 -392
- package/src/openapi/platform/models/issue-link-types.ts +0 -28
- package/src/openapi/platform/models/issue-links.ts +0 -185
- package/src/openapi/platform/models/issue-notification-schemes.ts +0 -370
- package/src/openapi/platform/models/issue-priorities.ts +0 -196
- package/src/openapi/platform/models/issue-properties.ts +0 -259
- package/src/openapi/platform/models/issue-remote-links.ts +0 -207
- package/src/openapi/platform/models/issue-resolutions.ts +0 -180
- package/src/openapi/platform/models/issue-search.ts +0 -367
- package/src/openapi/platform/models/issue-security-level.ts +0 -76
- package/src/openapi/platform/models/issue-security-schemes.ts +0 -496
- package/src/openapi/platform/models/issue-type-schemes.ts +0 -290
- package/src/openapi/platform/models/issue-type-screen-schemes.ts +0 -286
- package/src/openapi/platform/models/issue-types.ts +0 -66
- package/src/openapi/platform/models/issue-votes.ts +0 -38
- package/src/openapi/platform/models/issue-watchers.ts +0 -67
- package/src/openapi/platform/models/issue-worklogs.ts +0 -190
- package/src/openapi/platform/models/issues.ts +0 -1268
- package/src/openapi/platform/models/jira-expressions.ts +0 -578
- package/src/openapi/platform/models/jira-settings.ts +0 -118
- package/src/openapi/platform/models/jql-functions-apps.ts +0 -128
- package/src/openapi/platform/models/jql.ts +0 -783
- package/src/openapi/platform/models/labels.ts +0 -42
- package/src/openapi/platform/models/license-metrics.ts +0 -68
- package/src/openapi/platform/models/myself.ts +0 -29
- package/src/openapi/platform/models/permission-schemes.ts +0 -89
- package/src/openapi/platform/models/permissions.ts +0 -308
- package/src/openapi/platform/models/priority-schemes.ts +0 -527
- package/src/openapi/platform/models/project-avatars.ts +0 -29
- package/src/openapi/platform/models/project-classification-levels.ts +0 -24
- package/src/openapi/platform/models/project-components.ts +0 -231
- package/src/openapi/platform/models/project-email.ts +0 -27
- package/src/openapi/platform/models/project-features.ts +0 -78
- package/src/openapi/platform/models/project-permission-schemes.ts +0 -43
- package/src/openapi/platform/models/project-role-actors.ts +0 -107
- package/src/openapi/platform/models/project-roles.ts +0 -76
- package/src/openapi/platform/models/project-types.ts +0 -36
- package/src/openapi/platform/models/project-versions.ts +0 -216
- package/src/openapi/platform/models/projects.ts +0 -429
- package/src/openapi/platform/models/screen-schemes.ts +0 -192
- package/src/openapi/platform/models/screen-tab-fields.ts +0 -45
- package/src/openapi/platform/models/screens.ts +0 -171
- package/src/openapi/platform/models/server-info.ts +0 -100
- package/src/openapi/platform/models/service-registry.ts +0 -68
- package/src/openapi/platform/models/status.ts +0 -229
- package/src/openapi/platform/models/time-tracking.ts +0 -38
- package/src/openapi/platform/models/ui-modifications-apps.ts +0 -229
- package/src/openapi/platform/models/user-search.ts +0 -69
- package/src/openapi/platform/models/users.ts +0 -121
- package/src/openapi/platform/models/webhooks.ts +0 -307
- package/src/openapi/platform/models/workflow-scheme-drafts.ts +0 -58
- package/src/openapi/platform/models/workflow-scheme-project-associations.ts +0 -68
- package/src/openapi/platform/models/workflow-schemes.ts +0 -545
- package/src/openapi/platform/models/workflow-transition-properties.ts +0 -33
- package/src/openapi/platform/models/workflow-transition-rules.ts +0 -261
- package/src/openapi/platform/models/workflows.ts +0 -1943
- package/src/openapi/platform/services/announcement-banner-service.ts +0 -142
- package/src/openapi/platform/services/app-data-policies-service.ts +0 -136
- package/src/openapi/platform/services/app-migration-service.ts +0 -289
- package/src/openapi/platform/services/app-properties-service.ts +0 -441
- package/src/openapi/platform/services/application-roles-service.ts +0 -247
- package/src/openapi/platform/services/audit-records-service.ts +0 -164
- package/src/openapi/platform/services/avatars-service.ts +0 -769
- package/src/openapi/platform/services/classification-levels-service.ts +0 -131
- package/src/openapi/platform/services/dashboards-service.ts +0 -1721
- package/src/openapi/platform/services/dynamic-modules-service.ts +0 -127
- package/src/openapi/platform/services/filter-sharing-service.ts +0 -687
- package/src/openapi/platform/services/filters-service.ts +0 -1901
- package/src/openapi/platform/services/group-and-user-picker-service.ts +0 -224
- package/src/openapi/platform/services/groups-service.ts +0 -751
- package/src/openapi/platform/services/issue-attachments-service.ts +0 -900
- package/src/openapi/platform/services/issue-comment-properties-service.ts +0 -324
- package/src/openapi/platform/services/issue-comments-service.ts +0 -812
- package/src/openapi/platform/services/issue-custom-field-configuration-apps-service.ts +0 -277
- package/src/openapi/platform/services/issue-custom-field-contexts-service.ts +0 -1339
- package/src/openapi/platform/services/issue-custom-field-options-apps-service.ts +0 -994
- package/src/openapi/platform/services/issue-custom-field-options-service.ts +0 -651
- package/src/openapi/platform/services/issue-custom-field-values-apps-service.ts +0 -201
- package/src/openapi/platform/services/issue-field-configurations-service.ts +0 -1294
- package/src/openapi/platform/services/issue-fields-service.ts +0 -837
- package/src/openapi/platform/services/issue-link-types-service.ts +0 -360
- package/src/openapi/platform/services/issue-links-service.ts +0 -345
- package/src/openapi/platform/services/issue-navigator-settings-service.ts +0 -119
- package/src/openapi/platform/services/issue-notification-schemes-service.ts +0 -1209
- package/src/openapi/platform/services/issue-priorities-service.ts +0 -575
- package/src/openapi/platform/services/issue-properties-service.ts +0 -606
- package/src/openapi/platform/services/issue-remote-links-service.ts +0 -597
- package/src/openapi/platform/services/issue-resolutions-service.ts +0 -534
- package/src/openapi/platform/services/issue-search-service.ts +0 -1139
- package/src/openapi/platform/services/issue-security-level-service.ts +0 -250
- package/src/openapi/platform/services/issue-security-schemes-service.ts +0 -1240
- package/src/openapi/platform/services/issue-type-properties-service.ts +0 -325
- package/src/openapi/platform/services/issue-type-schemes-service.ts +0 -940
- package/src/openapi/platform/services/issue-type-screen-schemes-service.ts +0 -994
- package/src/openapi/platform/services/issue-types-service.ts +0 -679
- package/src/openapi/platform/services/issue-votes-service.ts +0 -221
- package/src/openapi/platform/services/issue-watchers-service.ts +0 -331
- package/src/openapi/platform/services/issue-worklog-properties-service.ts +0 -348
- package/src/openapi/platform/services/issue-worklogs-service.ts +0 -1089
- package/src/openapi/platform/services/issues-service.ts +0 -3346
- package/src/openapi/platform/services/jira-expressions-service.ts +0 -407
- package/src/openapi/platform/services/jira-settings-service.ts +0 -415
- package/src/openapi/platform/services/jql-functions-apps-service.ts +0 -219
- package/src/openapi/platform/services/jql-service.ts +0 -896
- package/src/openapi/platform/services/labels-service.ts +0 -89
- package/src/openapi/platform/services/license-metrics-service.ts +0 -216
- package/src/openapi/platform/services/myself-service.ts +0 -520
- package/src/openapi/platform/services/permission-schemes-service.ts +0 -926
- package/src/openapi/platform/services/permissions-service.ts +0 -407
- package/src/openapi/platform/services/priority-schemes-service.ts +0 -1001
- package/src/openapi/platform/services/project-avatars-service.ts +0 -341
- package/src/openapi/platform/services/project-categories-service.ts +0 -318
- package/src/openapi/platform/services/project-classification-levels-service.ts +0 -232
- package/src/openapi/platform/services/project-components-service.ts +0 -1332
- package/src/openapi/platform/services/project-email-service.ts +0 -161
- package/src/openapi/platform/services/project-features-service.ts +0 -207
- package/src/openapi/platform/services/project-key-and-name-validation-service.ts +0 -200
- package/src/openapi/platform/services/project-permission-schemes-service.ts +0 -384
- package/src/openapi/platform/services/project-properties-service.ts +0 -320
- package/src/openapi/platform/services/project-role-actors-service.ts +0 -627
- package/src/openapi/platform/services/project-roles-service.ts +0 -867
- package/src/openapi/platform/services/project-types-service.ts +0 -297
- package/src/openapi/platform/services/project-versions-service.ts +0 -1287
- package/src/openapi/platform/services/projects-service.ts +0 -2196
- package/src/openapi/platform/services/screen-schemes-service.ts +0 -334
- package/src/openapi/platform/services/screen-tab-fields-service.ts +0 -276
- package/src/openapi/platform/services/screen-tabs-service.ts +0 -421
- package/src/openapi/platform/services/screens-service.ts +0 -528
- package/src/openapi/platform/services/server-info-service.ts +0 -88
- package/src/openapi/platform/services/service-registry-service.ts +0 -89
- package/src/openapi/platform/services/status-service.ts +0 -498
- package/src/openapi/platform/services/tasks-service.ts +0 -159
- package/src/openapi/platform/services/time-tracking-service.ts +0 -386
- package/src/openapi/platform/services/ui-modifications-apps-service.ts +0 -403
- package/src/openapi/platform/services/user-properties-service.ts +0 -413
- package/src/openapi/platform/services/user-search-service.ts +0 -1214
- package/src/openapi/platform/services/users-service.ts +0 -1108
- package/src/openapi/platform/services/webhooks-service.ts +0 -458
- package/src/openapi/platform/services/workflow-scheme-drafts-service.ts +0 -1313
- package/src/openapi/platform/services/workflow-scheme-project-associations-service.ts +0 -189
- package/src/openapi/platform/services/workflow-schemes-service.ts +0 -1617
- package/src/openapi/platform/services/workflow-status-categories-service.ts +0 -151
- package/src/openapi/platform/services/workflow-statuses-service.ts +0 -176
- package/src/openapi/platform/services/workflow-transition-properties-service.ts +0 -388
- package/src/openapi/platform/services/workflow-transition-rules-service.ts +0 -485
- package/src/openapi/platform/services/workflows-service.ts +0 -3477
- package/src/openapi/platform/validation-schema-storage.ts +0 -186
- package/src/openapi/software/base-jira-software-api-client.ts +0 -447
- package/src/openapi/software/core/common-http-client.ts +0 -723
- package/src/openapi/software/core/common-http-service.ts +0 -22
- package/src/openapi/software/core/common-validation-schema-storage.ts +0 -105
- package/src/openapi/software/models/board.ts +0 -918
- package/src/openapi/software/services/backlog-service.ts +0 -160
- package/src/openapi/software/services/board-service.ts +0 -4189
- package/src/openapi/software/services/builds-service.ts +0 -571
- package/src/openapi/software/services/deployments-service.ts +0 -403
- package/src/openapi/software/services/dev-ops-components-service.ts +0 -371
- package/src/openapi/software/services/development-information-service.ts +0 -2357
- package/src/openapi/software/services/epic-service.ts +0 -854
- package/src/openapi/software/services/feature-flags-service.ts +0 -303
- package/src/openapi/software/services/issue-service.ts +0 -529
- package/src/openapi/software/services/operations-service.ts +0 -741
- package/src/openapi/software/services/remote-links-service.ts +0 -653
- package/src/openapi/software/services/security-information-service.ts +0 -495
- package/src/openapi/software/services/sprint-service.ts +0 -969
- package/src/openapi/software/validation-schema-storage.ts +0 -186
- package/tsconfig.build.json +0 -7
- package/tsconfig.json +0 -4
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
// DO NOT EDIT!
|
|
2
|
-
// This file is generated by "api-typescript-generator".
|
|
3
|
-
// To update this file run "yarn build:openapi".
|
|
4
|
-
import type * as commonHttpClient from "./common-http-client";
|
|
5
|
-
export class CommonHttpService {
|
|
6
|
-
protected getClientInstance: () => commonHttpClient.CommonHttpClient;
|
|
7
|
-
constructor(getClientInstance: () => commonHttpClient.CommonHttpClient) {
|
|
8
|
-
this.getClientInstance = () => {
|
|
9
|
-
const classInstance = this.constructor as typeof CommonHttpService;
|
|
10
|
-
if (classInstance.initialized !== true) {
|
|
11
|
-
classInstance.initialized = true;
|
|
12
|
-
if (classInstance.initialize !== undefined) {
|
|
13
|
-
classInstance.initialize();
|
|
14
|
-
}
|
|
15
|
-
}
|
|
16
|
-
this.getClientInstance = getClientInstance;
|
|
17
|
-
return getClientInstance();
|
|
18
|
-
};
|
|
19
|
-
}
|
|
20
|
-
protected static initialized: boolean | undefined;
|
|
21
|
-
protected static initialize: (() => void) | undefined;
|
|
22
|
-
}
|
|
@@ -1,105 +0,0 @@
|
|
|
1
|
-
// DO NOT EDIT!
|
|
2
|
-
// This file is generated by "api-typescript-generator".
|
|
3
|
-
// To update this file run "yarn build:openapi".
|
|
4
|
-
import {
|
|
5
|
-
CommonHttpClientError,
|
|
6
|
-
type CommonHttpClientFetchResponse,
|
|
7
|
-
type CommonHttpClientOptions,
|
|
8
|
-
isJsonMediaType,
|
|
9
|
-
} from "./common-http-client";
|
|
10
|
-
type CommonValidationSchemaStorageAssertDataShape<T> = <D>(
|
|
11
|
-
schema: T,
|
|
12
|
-
data: D,
|
|
13
|
-
) => void;
|
|
14
|
-
type RegisterOnceCallback<T> = (
|
|
15
|
-
validationSchemaStorage: CommonValidationSchemaStorage<T>,
|
|
16
|
-
) => void;
|
|
17
|
-
type CommonValidationSchemaStorageMakeExtensible<T> = (schema: T) => T;
|
|
18
|
-
type CommonValidationSchemaStorageFormatErrorMessage<T> = (
|
|
19
|
-
error: Error,
|
|
20
|
-
schema: T,
|
|
21
|
-
) => string;
|
|
22
|
-
type CommonValidationSchemaStorageLazyGetter<T> = (callback: () => T) => T;
|
|
23
|
-
export class CommonValidationSchemaStorage<T> {
|
|
24
|
-
protected assertDataShape: CommonValidationSchemaStorageAssertDataShape<T>;
|
|
25
|
-
protected makeExtensible: CommonValidationSchemaStorageMakeExtensible<T>;
|
|
26
|
-
protected schemas: Record<string, T> = {};
|
|
27
|
-
protected registeredCallbacks = new Set<RegisterOnceCallback<T>>();
|
|
28
|
-
protected errorClass: CommonHttpClientOptions["errorClass"] =
|
|
29
|
-
CommonHttpClientError;
|
|
30
|
-
protected formatErrorMessage: CommonValidationSchemaStorageFormatErrorMessage<T>;
|
|
31
|
-
protected lazyGetter: CommonValidationSchemaStorageLazyGetter<T>;
|
|
32
|
-
constructor({
|
|
33
|
-
assertDataShape,
|
|
34
|
-
makeExtensible,
|
|
35
|
-
formatErrorMessage,
|
|
36
|
-
lazyGetter,
|
|
37
|
-
}: {
|
|
38
|
-
assertDataShape: CommonValidationSchemaStorageAssertDataShape<T>;
|
|
39
|
-
makeExtensible: CommonValidationSchemaStorageMakeExtensible<T>;
|
|
40
|
-
formatErrorMessage: CommonValidationSchemaStorageFormatErrorMessage<T>;
|
|
41
|
-
lazyGetter: CommonValidationSchemaStorageLazyGetter<T>;
|
|
42
|
-
}) {
|
|
43
|
-
this.assertDataShape = assertDataShape;
|
|
44
|
-
this.makeExtensible = makeExtensible;
|
|
45
|
-
this.formatErrorMessage = formatErrorMessage;
|
|
46
|
-
this.lazyGetter = lazyGetter;
|
|
47
|
-
}
|
|
48
|
-
register(key: string, schema: T) {
|
|
49
|
-
this.schemas[key] = schema;
|
|
50
|
-
}
|
|
51
|
-
registerExtensible(key: string, schema: T) {
|
|
52
|
-
this.schemas[key] = this.makeExtensible(schema);
|
|
53
|
-
}
|
|
54
|
-
registerOnce(callbacks: RegisterOnceCallback<T>[]) {
|
|
55
|
-
for (const callback of callbacks) {
|
|
56
|
-
if (!this.registeredCallbacks.has(callback)) {
|
|
57
|
-
this.registeredCallbacks.add(callback);
|
|
58
|
-
callback(this);
|
|
59
|
-
}
|
|
60
|
-
}
|
|
61
|
-
}
|
|
62
|
-
get(key: string): T {
|
|
63
|
-
return this.schemas[key];
|
|
64
|
-
}
|
|
65
|
-
lazy(key: string): T {
|
|
66
|
-
return this.lazyGetter(() => this.schemas[key]);
|
|
67
|
-
}
|
|
68
|
-
validator<
|
|
69
|
-
D extends {
|
|
70
|
-
mediaType: string;
|
|
71
|
-
status: number;
|
|
72
|
-
body: unknown;
|
|
73
|
-
response: CommonHttpClientFetchResponse;
|
|
74
|
-
},
|
|
75
|
-
>(key: string): (data: D) => D {
|
|
76
|
-
return (data: D) => {
|
|
77
|
-
const schema = this.schemas[key];
|
|
78
|
-
if (schema === undefined) {
|
|
79
|
-
throw new Error(`Schema with key "${key}" not found`);
|
|
80
|
-
}
|
|
81
|
-
if (data.mediaType !== undefined && isJsonMediaType(data.mediaType)) {
|
|
82
|
-
try {
|
|
83
|
-
this.assertDataShape(schema, data);
|
|
84
|
-
} catch (error) {
|
|
85
|
-
throw new this.errorClass(
|
|
86
|
-
new URL(data.response.url),
|
|
87
|
-
undefined,
|
|
88
|
-
data.response,
|
|
89
|
-
undefined,
|
|
90
|
-
error instanceof Error
|
|
91
|
-
? this.formatErrorMessage(error, schema)
|
|
92
|
-
: String(error),
|
|
93
|
-
);
|
|
94
|
-
}
|
|
95
|
-
}
|
|
96
|
-
return data;
|
|
97
|
-
};
|
|
98
|
-
}
|
|
99
|
-
getErrorClass() {
|
|
100
|
-
return this.errorClass;
|
|
101
|
-
}
|
|
102
|
-
setErrorClass(errorClass: CommonHttpClientOptions["errorClass"]) {
|
|
103
|
-
this.errorClass = errorClass;
|
|
104
|
-
}
|
|
105
|
-
}
|
|
@@ -1,59 +0,0 @@
|
|
|
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, type ZodTypeAny } from "zod";
|
|
5
|
-
|
|
6
|
-
import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
|
|
7
|
-
/** Announcement banner configuration. */
|
|
8
|
-
export interface AnnouncementBannerConfiguration {
|
|
9
|
-
/** Hash of the banner data. The client detects updates by comparing hash IDs. */
|
|
10
|
-
hashId?: string;
|
|
11
|
-
/** Flag indicating if the announcement banner can be dismissed by the user. */
|
|
12
|
-
isDismissible?: boolean;
|
|
13
|
-
/** Flag indicating if the announcement banner is enabled or not. */
|
|
14
|
-
isEnabled?: boolean;
|
|
15
|
-
/** The text on the announcement banner. */
|
|
16
|
-
message?: string;
|
|
17
|
-
/** Visibility of the announcement banner. */
|
|
18
|
-
visibility?: "PUBLIC" | "PRIVATE";
|
|
19
|
-
}
|
|
20
|
-
/** Configuration of the announcement banner. */
|
|
21
|
-
export interface AnnouncementBannerConfigurationUpdate {
|
|
22
|
-
/** Flag indicating if the announcement banner can be dismissed by the user. */
|
|
23
|
-
isDismissible?: boolean;
|
|
24
|
-
/** Flag indicating if the announcement banner is enabled or not. */
|
|
25
|
-
isEnabled?: boolean;
|
|
26
|
-
/** The text on the announcement banner. */
|
|
27
|
-
message?: string;
|
|
28
|
-
/** Visibility of the announcement banner. Can be public or private. */
|
|
29
|
-
visibility?: string;
|
|
30
|
-
}
|
|
31
|
-
export function registerAnnouncementBannerValidationSchemas(
|
|
32
|
-
validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
|
|
33
|
-
) {
|
|
34
|
-
validationSchemaStorage.register(
|
|
35
|
-
"AnnouncementBannerConfiguration",
|
|
36
|
-
z
|
|
37
|
-
.object({
|
|
38
|
-
hashId: z.string().optional(),
|
|
39
|
-
isDismissible: z.boolean().optional(),
|
|
40
|
-
isEnabled: z.boolean().optional(),
|
|
41
|
-
message: z.string().optional(),
|
|
42
|
-
visibility: z.enum(["PUBLIC", "PRIVATE"]).optional(),
|
|
43
|
-
})
|
|
44
|
-
.strict()
|
|
45
|
-
.describe("AnnouncementBannerConfiguration"),
|
|
46
|
-
);
|
|
47
|
-
validationSchemaStorage.register(
|
|
48
|
-
"AnnouncementBannerConfigurationUpdate",
|
|
49
|
-
z
|
|
50
|
-
.object({
|
|
51
|
-
isDismissible: z.boolean().optional(),
|
|
52
|
-
isEnabled: z.boolean().optional(),
|
|
53
|
-
message: z.string().optional(),
|
|
54
|
-
visibility: z.string().optional(),
|
|
55
|
-
})
|
|
56
|
-
.strict()
|
|
57
|
-
.describe("AnnouncementBannerConfigurationUpdate"),
|
|
58
|
-
);
|
|
59
|
-
}
|
|
@@ -1,79 +0,0 @@
|
|
|
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, type ZodTypeAny } from "zod";
|
|
5
|
-
|
|
6
|
-
import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
|
|
7
|
-
/** Details about data policies for a list of projects. */
|
|
8
|
-
export interface ProjectDataPolicies {
|
|
9
|
-
/** List of projects with data policies. */
|
|
10
|
-
projectDataPolicies?: ProjectWithDataPolicy[];
|
|
11
|
-
}
|
|
12
|
-
/** Details about data policy. */
|
|
13
|
-
export interface ProjectDataPolicy {
|
|
14
|
-
/**
|
|
15
|
-
* Whether the project contains any content inaccessible to the requesting
|
|
16
|
-
* application.
|
|
17
|
-
*/
|
|
18
|
-
anyContentBlocked?: boolean;
|
|
19
|
-
}
|
|
20
|
-
/** Details about data policies for a project. */
|
|
21
|
-
export interface ProjectWithDataPolicy {
|
|
22
|
-
/** Data policy. */
|
|
23
|
-
dataPolicy?: ProjectDataPolicy;
|
|
24
|
-
/** The project ID. */
|
|
25
|
-
id?: number;
|
|
26
|
-
}
|
|
27
|
-
/** Details about data policy. */
|
|
28
|
-
export interface WorkspaceDataPolicy {
|
|
29
|
-
/**
|
|
30
|
-
* Whether the workspace contains any content inaccessible to the requesting
|
|
31
|
-
* application.
|
|
32
|
-
*/
|
|
33
|
-
anyContentBlocked?: boolean;
|
|
34
|
-
}
|
|
35
|
-
export function registerAppDataPoliciesValidationSchemas(
|
|
36
|
-
validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
|
|
37
|
-
) {
|
|
38
|
-
validationSchemaStorage.register(
|
|
39
|
-
"ProjectDataPolicies",
|
|
40
|
-
z
|
|
41
|
-
.object({
|
|
42
|
-
projectDataPolicies: z
|
|
43
|
-
.array(validationSchemaStorage.lazy("ProjectWithDataPolicy"))
|
|
44
|
-
.optional(),
|
|
45
|
-
})
|
|
46
|
-
.strict()
|
|
47
|
-
.describe("ProjectDataPolicies"),
|
|
48
|
-
);
|
|
49
|
-
validationSchemaStorage.register(
|
|
50
|
-
"ProjectDataPolicy",
|
|
51
|
-
z
|
|
52
|
-
.object({
|
|
53
|
-
anyContentBlocked: z.boolean().optional(),
|
|
54
|
-
})
|
|
55
|
-
.strict()
|
|
56
|
-
.describe("ProjectDataPolicy"),
|
|
57
|
-
);
|
|
58
|
-
validationSchemaStorage.register(
|
|
59
|
-
"ProjectWithDataPolicy",
|
|
60
|
-
z
|
|
61
|
-
.object({
|
|
62
|
-
dataPolicy: validationSchemaStorage
|
|
63
|
-
.lazy("ProjectDataPolicy")
|
|
64
|
-
.optional(),
|
|
65
|
-
id: z.number().int().optional(),
|
|
66
|
-
})
|
|
67
|
-
.strict()
|
|
68
|
-
.describe("ProjectWithDataPolicy"),
|
|
69
|
-
);
|
|
70
|
-
validationSchemaStorage.register(
|
|
71
|
-
"WorkspaceDataPolicy",
|
|
72
|
-
z
|
|
73
|
-
.object({
|
|
74
|
-
anyContentBlocked: z.boolean().optional(),
|
|
75
|
-
})
|
|
76
|
-
.strict()
|
|
77
|
-
.describe("WorkspaceDataPolicy"),
|
|
78
|
-
);
|
|
79
|
-
}
|
|
@@ -1,172 +0,0 @@
|
|
|
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, type ZodTypeAny } from "zod";
|
|
5
|
-
|
|
6
|
-
import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
|
|
7
|
-
import {
|
|
8
|
-
registerCommonValidationSchemas,
|
|
9
|
-
type WorkflowTransitionRules,
|
|
10
|
-
} from "./common";
|
|
11
|
-
/** A list of custom field details. */
|
|
12
|
-
export interface ConnectCustomFieldValue extends Record<string, unknown> {
|
|
13
|
-
/** The type of custom field. */
|
|
14
|
-
_type:
|
|
15
|
-
| "StringIssueField"
|
|
16
|
-
| "NumberIssueField"
|
|
17
|
-
| "RichTextIssueField"
|
|
18
|
-
| "SingleSelectIssueField"
|
|
19
|
-
| "MultiSelectIssueField"
|
|
20
|
-
| "TextIssueField";
|
|
21
|
-
/** The custom field ID. */
|
|
22
|
-
fieldID: number;
|
|
23
|
-
/** The issue ID. */
|
|
24
|
-
issueID: number;
|
|
25
|
-
/** The value of number type custom field when `_type` is `NumberIssueField`. */
|
|
26
|
-
number?: number;
|
|
27
|
-
/**
|
|
28
|
-
* The value of single select and multiselect custom field type when `_type` is
|
|
29
|
-
* `SingleSelectIssueField` or `MultiSelectIssueField`.
|
|
30
|
-
*/
|
|
31
|
-
optionID?: string;
|
|
32
|
-
/** The value of richText type custom field when `_type` is `RichTextIssueField`. */
|
|
33
|
-
richText?: string;
|
|
34
|
-
/** The value of string type custom field when `_type` is `StringIssueField`. */
|
|
35
|
-
string?: string;
|
|
36
|
-
/** The value of of text custom field type when `_type` is `TextIssueField`. */
|
|
37
|
-
text?: string;
|
|
38
|
-
}
|
|
39
|
-
/** Details of updates for a custom field. */
|
|
40
|
-
export interface ConnectCustomFieldValues {
|
|
41
|
-
/** The list of custom field update details. */
|
|
42
|
-
updateValueList?: ConnectCustomFieldValue[];
|
|
43
|
-
}
|
|
44
|
-
export interface EntityPropertyDetails extends Record<string, unknown> {
|
|
45
|
-
/**
|
|
46
|
-
* The entity property ID.
|
|
47
|
-
*
|
|
48
|
-
* @example 123
|
|
49
|
-
*/
|
|
50
|
-
entityId: number;
|
|
51
|
-
/**
|
|
52
|
-
* The entity property key.
|
|
53
|
-
*
|
|
54
|
-
* @example mykey
|
|
55
|
-
*/
|
|
56
|
-
key: string;
|
|
57
|
-
/**
|
|
58
|
-
* The new value of the entity property.
|
|
59
|
-
*
|
|
60
|
-
* @example newValue
|
|
61
|
-
*/
|
|
62
|
-
value: string;
|
|
63
|
-
}
|
|
64
|
-
/** Details of the workflow and its transition rules. */
|
|
65
|
-
export interface WorkflowRulesSearch extends Record<string, unknown> {
|
|
66
|
-
/**
|
|
67
|
-
* Use expand to include additional information in the response. This parameter
|
|
68
|
-
* accepts `transition` which, for each rule, returns information about the
|
|
69
|
-
* transition the rule is assigned to.
|
|
70
|
-
*
|
|
71
|
-
* @example transition
|
|
72
|
-
*/
|
|
73
|
-
expand?: string;
|
|
74
|
-
/** The list of workflow rule IDs. */
|
|
75
|
-
ruleIds: string[];
|
|
76
|
-
/**
|
|
77
|
-
* The workflow ID.
|
|
78
|
-
*
|
|
79
|
-
* @example a498d711-685d-428d-8c3e-bc03bb450ea7
|
|
80
|
-
*/
|
|
81
|
-
workflowEntityId: string;
|
|
82
|
-
}
|
|
83
|
-
/** Details of workflow transition rules. */
|
|
84
|
-
export interface WorkflowRulesSearchDetails extends Record<string, unknown> {
|
|
85
|
-
/**
|
|
86
|
-
* List of workflow rule IDs that do not belong to the workflow or can not be
|
|
87
|
-
* found.
|
|
88
|
-
*/
|
|
89
|
-
invalidRules?: string[];
|
|
90
|
-
/** List of valid workflow transition rules. */
|
|
91
|
-
validRules?: WorkflowTransitionRules[];
|
|
92
|
-
/**
|
|
93
|
-
* The workflow ID.
|
|
94
|
-
*
|
|
95
|
-
* @example a498d711-685d-428d-8c3e-bc03bb450ea7
|
|
96
|
-
*/
|
|
97
|
-
workflowEntityId?: string;
|
|
98
|
-
}
|
|
99
|
-
export function registerAppMigrationValidationSchemas(
|
|
100
|
-
validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
|
|
101
|
-
) {
|
|
102
|
-
validationSchemaStorage.register(
|
|
103
|
-
"ConnectCustomFieldValue",
|
|
104
|
-
z
|
|
105
|
-
.object({
|
|
106
|
-
_type: z.enum([
|
|
107
|
-
"StringIssueField",
|
|
108
|
-
"NumberIssueField",
|
|
109
|
-
"RichTextIssueField",
|
|
110
|
-
"SingleSelectIssueField",
|
|
111
|
-
"MultiSelectIssueField",
|
|
112
|
-
"TextIssueField",
|
|
113
|
-
]),
|
|
114
|
-
fieldID: z.number().int(),
|
|
115
|
-
issueID: z.number().int(),
|
|
116
|
-
number: z.number().optional(),
|
|
117
|
-
optionID: z.string().optional(),
|
|
118
|
-
richText: z.string().optional(),
|
|
119
|
-
string: z.string().optional(),
|
|
120
|
-
text: z.string().optional(),
|
|
121
|
-
})
|
|
122
|
-
.catchall(z.unknown())
|
|
123
|
-
.describe("ConnectCustomFieldValue"),
|
|
124
|
-
);
|
|
125
|
-
validationSchemaStorage.register(
|
|
126
|
-
"ConnectCustomFieldValues",
|
|
127
|
-
z
|
|
128
|
-
.object({
|
|
129
|
-
updateValueList: z
|
|
130
|
-
.array(validationSchemaStorage.lazy("ConnectCustomFieldValue"))
|
|
131
|
-
.optional(),
|
|
132
|
-
})
|
|
133
|
-
.strict()
|
|
134
|
-
.describe("ConnectCustomFieldValues"),
|
|
135
|
-
);
|
|
136
|
-
validationSchemaStorage.register(
|
|
137
|
-
"EntityPropertyDetails",
|
|
138
|
-
z
|
|
139
|
-
.object({
|
|
140
|
-
entityId: z.number(),
|
|
141
|
-
key: z.string(),
|
|
142
|
-
value: z.string(),
|
|
143
|
-
})
|
|
144
|
-
.catchall(z.unknown())
|
|
145
|
-
.describe("EntityPropertyDetails"),
|
|
146
|
-
);
|
|
147
|
-
validationSchemaStorage.register(
|
|
148
|
-
"WorkflowRulesSearch",
|
|
149
|
-
z
|
|
150
|
-
.object({
|
|
151
|
-
expand: z.string().optional(),
|
|
152
|
-
ruleIds: z.array(z.string()).min(1).max(10),
|
|
153
|
-
workflowEntityId: z.string(),
|
|
154
|
-
})
|
|
155
|
-
.catchall(z.unknown())
|
|
156
|
-
.describe("WorkflowRulesSearch"),
|
|
157
|
-
);
|
|
158
|
-
validationSchemaStorage.register(
|
|
159
|
-
"WorkflowRulesSearchDetails",
|
|
160
|
-
z
|
|
161
|
-
.object({
|
|
162
|
-
invalidRules: z.array(z.string()).optional(),
|
|
163
|
-
validRules: z
|
|
164
|
-
.array(validationSchemaStorage.lazy("WorkflowTransitionRules"))
|
|
165
|
-
.optional(),
|
|
166
|
-
workflowEntityId: z.string().optional(),
|
|
167
|
-
})
|
|
168
|
-
.catchall(z.unknown())
|
|
169
|
-
.describe("WorkflowRulesSearchDetails"),
|
|
170
|
-
);
|
|
171
|
-
validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
|
|
172
|
-
}
|
|
@@ -1,32 +0,0 @@
|
|
|
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, type ZodTypeAny } from "zod";
|
|
5
|
-
|
|
6
|
-
import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
|
|
7
|
-
/**
|
|
8
|
-
* @example {
|
|
9
|
-
* "message": "An example message.",
|
|
10
|
-
* "statusCode": 200
|
|
11
|
-
* }
|
|
12
|
-
*/
|
|
13
|
-
export interface OperationMessage {
|
|
14
|
-
/** The human-readable message that describes the result. */
|
|
15
|
-
message: string;
|
|
16
|
-
/** The status code of the response. */
|
|
17
|
-
statusCode: number;
|
|
18
|
-
}
|
|
19
|
-
export function registerAppPropertiesValidationSchemas(
|
|
20
|
-
validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
|
|
21
|
-
) {
|
|
22
|
-
validationSchemaStorage.register(
|
|
23
|
-
"OperationMessage",
|
|
24
|
-
z
|
|
25
|
-
.object({
|
|
26
|
-
message: z.string(),
|
|
27
|
-
statusCode: z.number().int(),
|
|
28
|
-
})
|
|
29
|
-
.strict()
|
|
30
|
-
.describe("OperationMessage"),
|
|
31
|
-
);
|
|
32
|
-
}
|
|
@@ -1,140 +0,0 @@
|
|
|
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, type ZodTypeAny } from "zod";
|
|
5
|
-
|
|
6
|
-
import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
|
|
7
|
-
/** Details of an item associated with the changed record. */
|
|
8
|
-
export interface AssociatedItemBean {
|
|
9
|
-
/** The ID of the associated record. */
|
|
10
|
-
id?: string;
|
|
11
|
-
/** The name of the associated record. */
|
|
12
|
-
name?: string;
|
|
13
|
-
/** The ID of the associated parent record. */
|
|
14
|
-
parentId?: string;
|
|
15
|
-
/** The name of the associated parent record. */
|
|
16
|
-
parentName?: string;
|
|
17
|
-
/** The type of the associated record. */
|
|
18
|
-
typeName?: string;
|
|
19
|
-
}
|
|
20
|
-
/** An audit record. */
|
|
21
|
-
export interface AuditRecordBean {
|
|
22
|
-
/** The list of items associated with the changed record. */
|
|
23
|
-
associatedItems?: AssociatedItemBean[];
|
|
24
|
-
/**
|
|
25
|
-
* Deprecated, use `authorAccountId` instead. The key of the user who created the
|
|
26
|
-
* audit record.
|
|
27
|
-
*
|
|
28
|
-
* @deprecated
|
|
29
|
-
*/
|
|
30
|
-
authorKey?: string;
|
|
31
|
-
/**
|
|
32
|
-
* The category of the audit record. For a list of these categories, see the help
|
|
33
|
-
* article [Auditing in Jira
|
|
34
|
-
* applications](https://confluence.atlassian.com/x/noXKM).
|
|
35
|
-
*/
|
|
36
|
-
category?: string;
|
|
37
|
-
/** The list of values changed in the record event. */
|
|
38
|
-
changedValues?: ChangedValueBean[];
|
|
39
|
-
/** The date and time on which the audit record was created. */
|
|
40
|
-
created?: string;
|
|
41
|
-
/** The description of the audit record. */
|
|
42
|
-
description?: string;
|
|
43
|
-
/** The event the audit record originated from. */
|
|
44
|
-
eventSource?: string;
|
|
45
|
-
/** The ID of the audit record. */
|
|
46
|
-
id?: number;
|
|
47
|
-
/** Details of an item associated with the changed record. */
|
|
48
|
-
objectItem?: AssociatedItemBean;
|
|
49
|
-
/** The URL of the computer where the creation of the audit record was initiated. */
|
|
50
|
-
remoteAddress?: string;
|
|
51
|
-
/** The summary of the audit record. */
|
|
52
|
-
summary?: string;
|
|
53
|
-
}
|
|
54
|
-
/** Container for a list of audit records. */
|
|
55
|
-
export interface AuditRecords {
|
|
56
|
-
/** The requested or default limit on the number of audit items to be returned. */
|
|
57
|
-
limit?: number;
|
|
58
|
-
/** The number of audit items skipped before the first item in this list. */
|
|
59
|
-
offset?: number;
|
|
60
|
-
/** The list of audit items. */
|
|
61
|
-
records?: AuditRecordBean[];
|
|
62
|
-
/** The total number of audit items returned. */
|
|
63
|
-
total?: number;
|
|
64
|
-
}
|
|
65
|
-
/** Details of names changed in the record event. */
|
|
66
|
-
export interface ChangedValueBean {
|
|
67
|
-
/** The value of the field before the change. */
|
|
68
|
-
changedFrom?: string;
|
|
69
|
-
/** The value of the field after the change. */
|
|
70
|
-
changedTo?: string;
|
|
71
|
-
/** The name of the field changed. */
|
|
72
|
-
fieldName?: string;
|
|
73
|
-
}
|
|
74
|
-
export function registerAuditRecordsValidationSchemas(
|
|
75
|
-
validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
|
|
76
|
-
) {
|
|
77
|
-
validationSchemaStorage.register(
|
|
78
|
-
"AssociatedItemBean",
|
|
79
|
-
z
|
|
80
|
-
.object({
|
|
81
|
-
id: z.string().optional(),
|
|
82
|
-
name: z.string().optional(),
|
|
83
|
-
parentId: z.string().optional(),
|
|
84
|
-
parentName: z.string().optional(),
|
|
85
|
-
typeName: z.string().optional(),
|
|
86
|
-
})
|
|
87
|
-
.strict()
|
|
88
|
-
.describe("AssociatedItemBean"),
|
|
89
|
-
);
|
|
90
|
-
validationSchemaStorage.register(
|
|
91
|
-
"AuditRecordBean",
|
|
92
|
-
z
|
|
93
|
-
.object({
|
|
94
|
-
associatedItems: z
|
|
95
|
-
.array(validationSchemaStorage.lazy("AssociatedItemBean"))
|
|
96
|
-
.optional(),
|
|
97
|
-
authorKey: z.string().optional(),
|
|
98
|
-
category: z.string().optional(),
|
|
99
|
-
changedValues: z
|
|
100
|
-
.array(validationSchemaStorage.lazy("ChangedValueBean"))
|
|
101
|
-
.optional(),
|
|
102
|
-
created: z.string().optional(),
|
|
103
|
-
description: z.string().optional(),
|
|
104
|
-
eventSource: z.string().optional(),
|
|
105
|
-
id: z.number().int().optional(),
|
|
106
|
-
objectItem: validationSchemaStorage
|
|
107
|
-
.lazy("AssociatedItemBean")
|
|
108
|
-
.optional(),
|
|
109
|
-
remoteAddress: z.string().optional(),
|
|
110
|
-
summary: z.string().optional(),
|
|
111
|
-
})
|
|
112
|
-
.strict()
|
|
113
|
-
.describe("AuditRecordBean"),
|
|
114
|
-
);
|
|
115
|
-
validationSchemaStorage.register(
|
|
116
|
-
"AuditRecords",
|
|
117
|
-
z
|
|
118
|
-
.object({
|
|
119
|
-
limit: z.number().int().optional(),
|
|
120
|
-
offset: z.number().int().optional(),
|
|
121
|
-
records: z
|
|
122
|
-
.array(validationSchemaStorage.lazy("AuditRecordBean"))
|
|
123
|
-
.optional(),
|
|
124
|
-
total: z.number().int().optional(),
|
|
125
|
-
})
|
|
126
|
-
.strict()
|
|
127
|
-
.describe("AuditRecords"),
|
|
128
|
-
);
|
|
129
|
-
validationSchemaStorage.register(
|
|
130
|
-
"ChangedValueBean",
|
|
131
|
-
z
|
|
132
|
-
.object({
|
|
133
|
-
changedFrom: z.string().optional(),
|
|
134
|
-
changedTo: z.string().optional(),
|
|
135
|
-
fieldName: z.string().optional(),
|
|
136
|
-
})
|
|
137
|
-
.strict()
|
|
138
|
-
.describe("ChangedValueBean"),
|
|
139
|
-
);
|
|
140
|
-
}
|
|
@@ -1,48 +0,0 @@
|
|
|
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, type ZodTypeAny } from "zod";
|
|
5
|
-
|
|
6
|
-
import type { CommonValidationSchemaStorage } from "../core/common-validation-schema-storage";
|
|
7
|
-
import { type Avatar, registerCommonValidationSchemas } from "./common";
|
|
8
|
-
/** Details about system and custom avatars. */
|
|
9
|
-
export interface Avatars {
|
|
10
|
-
/** Custom avatars list. */
|
|
11
|
-
custom?: Avatar[];
|
|
12
|
-
/** System avatars list. */
|
|
13
|
-
system?: Avatar[];
|
|
14
|
-
}
|
|
15
|
-
export interface StreamingResponseBody {}
|
|
16
|
-
/** List of system avatars. */
|
|
17
|
-
export interface SystemAvatars {
|
|
18
|
-
/** A list of avatar details. */
|
|
19
|
-
system?: Avatar[];
|
|
20
|
-
}
|
|
21
|
-
export function registerAvatarsValidationSchemas(
|
|
22
|
-
validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>,
|
|
23
|
-
) {
|
|
24
|
-
validationSchemaStorage.register(
|
|
25
|
-
"Avatars",
|
|
26
|
-
z
|
|
27
|
-
.object({
|
|
28
|
-
custom: z.array(validationSchemaStorage.lazy("Avatar")).optional(),
|
|
29
|
-
system: z.array(validationSchemaStorage.lazy("Avatar")).optional(),
|
|
30
|
-
})
|
|
31
|
-
.strict()
|
|
32
|
-
.describe("Avatars"),
|
|
33
|
-
);
|
|
34
|
-
validationSchemaStorage.register(
|
|
35
|
-
"StreamingResponseBody",
|
|
36
|
-
z.object({}).strict().describe("StreamingResponseBody"),
|
|
37
|
-
);
|
|
38
|
-
validationSchemaStorage.register(
|
|
39
|
-
"SystemAvatars",
|
|
40
|
-
z
|
|
41
|
-
.object({
|
|
42
|
-
system: z.array(validationSchemaStorage.lazy("Avatar")).optional(),
|
|
43
|
-
})
|
|
44
|
-
.strict()
|
|
45
|
-
.describe("SystemAvatars"),
|
|
46
|
-
);
|
|
47
|
-
validationSchemaStorage.registerOnce([registerCommonValidationSchemas]);
|
|
48
|
-
}
|