@devrev/typescript-sdk 1.1.30 → 1.1.32
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.
|
@@ -204,6 +204,20 @@ export interface AccountsUpdateResponse {
|
|
|
204
204
|
* Metric with corresponding target values.
|
|
205
205
|
*/
|
|
206
206
|
export interface ArchetypeMetricTarget {
|
|
207
|
+
/**
|
|
208
|
+
* For breached metrics the time they entered into breach. This is the
|
|
209
|
+
* same as what the target date was, unless the breach happened due to
|
|
210
|
+
* a different policy starting to apply.
|
|
211
|
+
* @format date-time
|
|
212
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
213
|
+
*/
|
|
214
|
+
breached_at?: string;
|
|
215
|
+
/**
|
|
216
|
+
* For completed metrics the time (in minutes) it took to complete
|
|
217
|
+
* them. (Taking into account the schedule if any).
|
|
218
|
+
* @format int32
|
|
219
|
+
*/
|
|
220
|
+
completed_in?: number;
|
|
207
221
|
/**
|
|
208
222
|
* If true, the schedule attached to this metric is out of schedule at
|
|
209
223
|
* the time of the query. It is not set for metrics in *completed*
|
|
@@ -211,12 +225,26 @@ export interface ArchetypeMetricTarget {
|
|
|
211
225
|
*/
|
|
212
226
|
is_out_of_schedule?: boolean;
|
|
213
227
|
metric_definition: MetricDefinitionSummary;
|
|
228
|
+
/**
|
|
229
|
+
* The next time the schedule will change its state, if such is known.
|
|
230
|
+
* @format date-time
|
|
231
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
232
|
+
*/
|
|
233
|
+
next_schedule_transition?: string;
|
|
214
234
|
org_schedule?: OrgScheduleSummary;
|
|
215
235
|
/**
|
|
216
236
|
* Time in minutes that remains on a paused metric.
|
|
217
237
|
* @format int32
|
|
218
238
|
*/
|
|
219
239
|
remaining_time?: number;
|
|
240
|
+
/** Metric stage corresponding to the applicable SLA. */
|
|
241
|
+
stage: string;
|
|
242
|
+
/**
|
|
243
|
+
* It is an indicator of whether the metric has ever been breached
|
|
244
|
+
* (missed). If not, it shows whether the metric is completed, in
|
|
245
|
+
* progress, or not part of the applied policy.
|
|
246
|
+
*/
|
|
247
|
+
status?: string;
|
|
220
248
|
/**
|
|
221
249
|
* Time at which the metric would breach SLA if no action taken.
|
|
222
250
|
* @format date-time
|
|
@@ -1218,7 +1246,8 @@ export interface ErrorBadRequestMergeWorksErrorError {
|
|
|
1218
1246
|
different_workspace?: ErrorBadRequestMergeWorksErrorErrorDifferentWorkspace;
|
|
1219
1247
|
invalid_stage_transition?: ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition;
|
|
1220
1248
|
locked?: ErrorBadRequestMergeWorksErrorErrorLocked;
|
|
1221
|
-
|
|
1249
|
+
stage_not_found_for_subtype?: ErrorBadRequestMergeWorksErrorErrorStageNotFoundForSubtype;
|
|
1250
|
+
subtype?: 'already_merged' | 'closed' | 'different_reporters' | 'different_workspace' | 'invalid_stage_transition' | 'locked' | 'stage_not_found_for_subtype';
|
|
1222
1251
|
/** The ID of the work which failed the validation. */
|
|
1223
1252
|
work: string;
|
|
1224
1253
|
}
|
|
@@ -1252,6 +1281,11 @@ export interface ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition {
|
|
|
1252
1281
|
}
|
|
1253
1282
|
/** error-bad-request-merge-works-error-error-locked */
|
|
1254
1283
|
export type ErrorBadRequestMergeWorksErrorErrorLocked = object;
|
|
1284
|
+
/** error-bad-request-merge-works-error-error-stage-not-found-for-subtype */
|
|
1285
|
+
export interface ErrorBadRequestMergeWorksErrorErrorStageNotFoundForSubtype {
|
|
1286
|
+
/** The subtype of the work for which stage is not configured. */
|
|
1287
|
+
subtype?: string;
|
|
1288
|
+
}
|
|
1255
1289
|
/** error-bad-request-missing-dependency */
|
|
1256
1290
|
export interface ErrorBadRequestMissingDependency {
|
|
1257
1291
|
/** The dependent fields. */
|
|
@@ -1459,6 +1493,11 @@ export interface EventDevUserUpdated {
|
|
|
1459
1493
|
dev_user: DevUser;
|
|
1460
1494
|
old_dev_user?: DevUser;
|
|
1461
1495
|
}
|
|
1496
|
+
export declare enum EventFetchedResult {
|
|
1497
|
+
Forbidden = "forbidden",
|
|
1498
|
+
NotFound = "not_found",
|
|
1499
|
+
Ok = "ok"
|
|
1500
|
+
}
|
|
1462
1501
|
/** event-group-created */
|
|
1463
1502
|
export interface EventGroupCreated {
|
|
1464
1503
|
group: Group;
|
|
@@ -1562,6 +1601,16 @@ export interface EventSlaTrackerDeleted {
|
|
|
1562
1601
|
export interface EventSlaTrackerUpdated {
|
|
1563
1602
|
sla_tracker: SlaTracker;
|
|
1564
1603
|
}
|
|
1604
|
+
/** event-survey-created */
|
|
1605
|
+
export interface EventSurveyCreated {
|
|
1606
|
+
survey: Survey;
|
|
1607
|
+
}
|
|
1608
|
+
/** event-survey-deleted */
|
|
1609
|
+
export interface EventSurveyDeleted {
|
|
1610
|
+
/** The ID of the survey that was deleted. */
|
|
1611
|
+
id: string;
|
|
1612
|
+
old_survey?: Survey;
|
|
1613
|
+
}
|
|
1565
1614
|
/** event-survey-response-created */
|
|
1566
1615
|
export interface EventSurveyResponseCreated {
|
|
1567
1616
|
survey_response: SurveyResponse;
|
|
@@ -1570,11 +1619,18 @@ export interface EventSurveyResponseCreated {
|
|
|
1570
1619
|
export interface EventSurveyResponseDeleted {
|
|
1571
1620
|
/** The ID of the survey response that was deleted. */
|
|
1572
1621
|
id: string;
|
|
1622
|
+
old_survey_response?: SurveyResponse;
|
|
1573
1623
|
}
|
|
1574
1624
|
/** event-survey-response-updated */
|
|
1575
1625
|
export interface EventSurveyResponseUpdated {
|
|
1626
|
+
old_survey_response?: SurveyResponse;
|
|
1576
1627
|
survey_response: SurveyResponse;
|
|
1577
1628
|
}
|
|
1629
|
+
/** event-survey-updated */
|
|
1630
|
+
export interface EventSurveyUpdated {
|
|
1631
|
+
old_survey?: Survey;
|
|
1632
|
+
survey: Survey;
|
|
1633
|
+
}
|
|
1578
1634
|
/** event-tag-created */
|
|
1579
1635
|
export interface EventTagCreated {
|
|
1580
1636
|
tag: Tag;
|
|
@@ -1636,6 +1692,19 @@ export interface EventWorkDeleted {
|
|
|
1636
1692
|
id: string;
|
|
1637
1693
|
old_work?: Work;
|
|
1638
1694
|
}
|
|
1695
|
+
/** event-work-fetched */
|
|
1696
|
+
export type EventWorkFetched = (Empty | EventWorkFetchedOk) & {
|
|
1697
|
+
/**
|
|
1698
|
+
* The ID of the work that was fetched.
|
|
1699
|
+
* @example "ISS-12345"
|
|
1700
|
+
*/
|
|
1701
|
+
id: string;
|
|
1702
|
+
result: EventFetchedResult;
|
|
1703
|
+
};
|
|
1704
|
+
/** event-work-fetched-ok */
|
|
1705
|
+
export interface EventWorkFetchedOk {
|
|
1706
|
+
work?: Work;
|
|
1707
|
+
}
|
|
1639
1708
|
/** event-work-updated */
|
|
1640
1709
|
export interface EventWorkUpdated {
|
|
1641
1710
|
old_work?: Work;
|
|
@@ -2317,6 +2386,441 @@ export type RevUserSummary = UserBaseSummary & {
|
|
|
2317
2386
|
external_ref?: string;
|
|
2318
2387
|
rev_org?: OrgSummary;
|
|
2319
2388
|
};
|
|
2389
|
+
/** schema-bool-field-descriptor */
|
|
2390
|
+
export type SchemaBoolFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2391
|
+
/** Default value. */
|
|
2392
|
+
default_value?: boolean;
|
|
2393
|
+
};
|
|
2394
|
+
/** schema-bool-list-field-descriptor */
|
|
2395
|
+
export type SchemaBoolListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2396
|
+
/** Default value. */
|
|
2397
|
+
default_value?: boolean[];
|
|
2398
|
+
};
|
|
2399
|
+
/** schema-composite-field-descriptor */
|
|
2400
|
+
export type SchemaCompositeFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2401
|
+
/** Composite type. Required when field type is composite. */
|
|
2402
|
+
composite_type?: string;
|
|
2403
|
+
};
|
|
2404
|
+
/** schema-composite-list-field-descriptor */
|
|
2405
|
+
export type SchemaCompositeListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2406
|
+
/** Composite type. Required when field type is composite. */
|
|
2407
|
+
composite_type?: string;
|
|
2408
|
+
};
|
|
2409
|
+
/** schema-date-field-descriptor */
|
|
2410
|
+
export type SchemaDateFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2411
|
+
/** Default value. */
|
|
2412
|
+
default_value?: string;
|
|
2413
|
+
};
|
|
2414
|
+
/** schema-date-list-field-descriptor */
|
|
2415
|
+
export type SchemaDateListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2416
|
+
/** Default value. */
|
|
2417
|
+
default_value?: string[];
|
|
2418
|
+
};
|
|
2419
|
+
/** schema-double-field-descriptor */
|
|
2420
|
+
export type SchemaDoubleFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2421
|
+
/**
|
|
2422
|
+
* Default value.
|
|
2423
|
+
* @format double
|
|
2424
|
+
*/
|
|
2425
|
+
default_value?: number;
|
|
2426
|
+
};
|
|
2427
|
+
/** schema-double-list-field-descriptor */
|
|
2428
|
+
export type SchemaDoubleListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2429
|
+
/** Default value. */
|
|
2430
|
+
default_value?: number[];
|
|
2431
|
+
};
|
|
2432
|
+
/** schema-enum-field-descriptor */
|
|
2433
|
+
export type SchemaEnumFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2434
|
+
/** Allowed values for the field. */
|
|
2435
|
+
allowed_values: string[];
|
|
2436
|
+
/** Default value. */
|
|
2437
|
+
default_value?: string;
|
|
2438
|
+
};
|
|
2439
|
+
/** schema-enum-list-field-descriptor */
|
|
2440
|
+
export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2441
|
+
/** Allowed values for the field. */
|
|
2442
|
+
allowed_values: string[];
|
|
2443
|
+
/** Default value. */
|
|
2444
|
+
default_value?: string[];
|
|
2445
|
+
};
|
|
2446
|
+
/**
|
|
2447
|
+
* schema-field-descriptor
|
|
2448
|
+
* Set of field attributes.
|
|
2449
|
+
*/
|
|
2450
|
+
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaStructFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
|
|
2451
|
+
field_type: SchemaFieldDescriptorFieldType;
|
|
2452
|
+
};
|
|
2453
|
+
/** schema-field-descriptor-array-type */
|
|
2454
|
+
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaStructListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
|
|
2455
|
+
base_type: SchemaFieldDescriptorArrayTypeBaseType;
|
|
2456
|
+
/**
|
|
2457
|
+
* The exact array length.
|
|
2458
|
+
* @format int64
|
|
2459
|
+
*/
|
|
2460
|
+
eq_items?: number;
|
|
2461
|
+
/**
|
|
2462
|
+
* The maximum array length.
|
|
2463
|
+
* @format int64
|
|
2464
|
+
*/
|
|
2465
|
+
max_items?: number;
|
|
2466
|
+
/**
|
|
2467
|
+
* The minimum array length.
|
|
2468
|
+
* @format int64
|
|
2469
|
+
*/
|
|
2470
|
+
min_items?: number;
|
|
2471
|
+
};
|
|
2472
|
+
export declare enum SchemaFieldDescriptorArrayTypeBaseType {
|
|
2473
|
+
Bool = "bool",
|
|
2474
|
+
Composite = "composite",
|
|
2475
|
+
Date = "date",
|
|
2476
|
+
Double = "double",
|
|
2477
|
+
Enum = "enum",
|
|
2478
|
+
Id = "id",
|
|
2479
|
+
Int = "int",
|
|
2480
|
+
RichText = "rich_text",
|
|
2481
|
+
Struct = "struct",
|
|
2482
|
+
Text = "text",
|
|
2483
|
+
Timestamp = "timestamp",
|
|
2484
|
+
Tokens = "tokens",
|
|
2485
|
+
Uenum = "uenum"
|
|
2486
|
+
}
|
|
2487
|
+
/** schema-field-descriptor-base */
|
|
2488
|
+
export interface SchemaFieldDescriptorBase {
|
|
2489
|
+
/** Description of the field. */
|
|
2490
|
+
description?: string;
|
|
2491
|
+
/** Whether this field is filterable, groupable and sortable. */
|
|
2492
|
+
is_filterable?: boolean;
|
|
2493
|
+
/** Whether this field is immutable or not. */
|
|
2494
|
+
is_immutable?: boolean;
|
|
2495
|
+
/**
|
|
2496
|
+
* Whether this field can hold Personally Identifiable Information
|
|
2497
|
+
* (PII).
|
|
2498
|
+
*/
|
|
2499
|
+
is_pii?: boolean;
|
|
2500
|
+
/** Whether this field is required or not. */
|
|
2501
|
+
is_required?: boolean;
|
|
2502
|
+
/** The schema of MFZ specific fields. */
|
|
2503
|
+
mfz?: SchemaFieldMfzMetadata;
|
|
2504
|
+
/** Name of the field. */
|
|
2505
|
+
name: string;
|
|
2506
|
+
/** The schema of oasis specific fields. */
|
|
2507
|
+
oasis?: SchemaFieldOasisMetadata;
|
|
2508
|
+
/** Type this field is from. */
|
|
2509
|
+
origin?: string;
|
|
2510
|
+
/** The schema of ui specific fields. */
|
|
2511
|
+
ui?: SchemaFieldUiMetadata;
|
|
2512
|
+
}
|
|
2513
|
+
export declare enum SchemaFieldDescriptorFieldType {
|
|
2514
|
+
Array = "array",
|
|
2515
|
+
Bool = "bool",
|
|
2516
|
+
Composite = "composite",
|
|
2517
|
+
Date = "date",
|
|
2518
|
+
Double = "double",
|
|
2519
|
+
Enum = "enum",
|
|
2520
|
+
Id = "id",
|
|
2521
|
+
Int = "int",
|
|
2522
|
+
RichText = "rich_text",
|
|
2523
|
+
Struct = "struct",
|
|
2524
|
+
Text = "text",
|
|
2525
|
+
Timestamp = "timestamp",
|
|
2526
|
+
Tokens = "tokens",
|
|
2527
|
+
Uenum = "uenum",
|
|
2528
|
+
Unknown = "unknown"
|
|
2529
|
+
}
|
|
2530
|
+
/**
|
|
2531
|
+
* schema-field-mfz-metadata
|
|
2532
|
+
* The schema of MFZ specific fields.
|
|
2533
|
+
*/
|
|
2534
|
+
export type SchemaFieldMfzMetadata = object;
|
|
2535
|
+
/**
|
|
2536
|
+
* schema-field-oasis-metadata
|
|
2537
|
+
* The schema of oasis specific fields.
|
|
2538
|
+
*/
|
|
2539
|
+
export type SchemaFieldOasisMetadata = object;
|
|
2540
|
+
/**
|
|
2541
|
+
* schema-field-uenum-value
|
|
2542
|
+
* A unified enum value.
|
|
2543
|
+
*/
|
|
2544
|
+
export type SchemaFieldUenumValue = object;
|
|
2545
|
+
/**
|
|
2546
|
+
* schema-field-ui-metadata
|
|
2547
|
+
* The schema of ui specific fields.
|
|
2548
|
+
*/
|
|
2549
|
+
export type SchemaFieldUiMetadata = object;
|
|
2550
|
+
/** schema-id-field-descriptor */
|
|
2551
|
+
export type SchemaIdFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2552
|
+
/** Default value. */
|
|
2553
|
+
default_value?: string;
|
|
2554
|
+
/** Object ID types. Required when field type is ID. */
|
|
2555
|
+
id_type?: string[];
|
|
2556
|
+
};
|
|
2557
|
+
/** schema-id-list-field-descriptor */
|
|
2558
|
+
export type SchemaIdListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2559
|
+
/** Default value. */
|
|
2560
|
+
default_value?: string[];
|
|
2561
|
+
/** Object ID types. Required when field type is ID. */
|
|
2562
|
+
id_type?: string[];
|
|
2563
|
+
};
|
|
2564
|
+
/** schema-int-field-descriptor */
|
|
2565
|
+
export type SchemaIntFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2566
|
+
/**
|
|
2567
|
+
* Default value.
|
|
2568
|
+
* @format int64
|
|
2569
|
+
*/
|
|
2570
|
+
default_value?: number;
|
|
2571
|
+
/**
|
|
2572
|
+
* The minimum value for the integer (exclusive).
|
|
2573
|
+
* @format int64
|
|
2574
|
+
*/
|
|
2575
|
+
gt?: number;
|
|
2576
|
+
/**
|
|
2577
|
+
* The minimum value for the integer (inclusive).
|
|
2578
|
+
* @format int64
|
|
2579
|
+
*/
|
|
2580
|
+
gte?: number;
|
|
2581
|
+
/**
|
|
2582
|
+
* The maximum value for the integer (exclusive).
|
|
2583
|
+
* @format int64
|
|
2584
|
+
*/
|
|
2585
|
+
lt?: number;
|
|
2586
|
+
/**
|
|
2587
|
+
* The maximum value for the integer (inclusive).
|
|
2588
|
+
* @format int64
|
|
2589
|
+
*/
|
|
2590
|
+
lte?: number;
|
|
2591
|
+
};
|
|
2592
|
+
/** schema-int-list-field-descriptor */
|
|
2593
|
+
export type SchemaIntListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2594
|
+
/** Default value. */
|
|
2595
|
+
default_value?: number[];
|
|
2596
|
+
/**
|
|
2597
|
+
* The minimum value for the integer (exclusive).
|
|
2598
|
+
* @format int64
|
|
2599
|
+
*/
|
|
2600
|
+
gt?: number;
|
|
2601
|
+
/**
|
|
2602
|
+
* The minimum value for the integer (inclusive).
|
|
2603
|
+
* @format int64
|
|
2604
|
+
*/
|
|
2605
|
+
gte?: number;
|
|
2606
|
+
/**
|
|
2607
|
+
* The maximum value for the integer (exclusive).
|
|
2608
|
+
* @format int64
|
|
2609
|
+
*/
|
|
2610
|
+
lt?: number;
|
|
2611
|
+
/**
|
|
2612
|
+
* The maximum value for the integer (inclusive).
|
|
2613
|
+
* @format int64
|
|
2614
|
+
*/
|
|
2615
|
+
lte?: number;
|
|
2616
|
+
};
|
|
2617
|
+
/** schema-rich-text-field-descriptor */
|
|
2618
|
+
export type SchemaRichTextFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2619
|
+
/** The contained substring. */
|
|
2620
|
+
contains?: string;
|
|
2621
|
+
/** Default value. */
|
|
2622
|
+
default_value?: string;
|
|
2623
|
+
/**
|
|
2624
|
+
* The exact string length.
|
|
2625
|
+
* @format int64
|
|
2626
|
+
*/
|
|
2627
|
+
eq_len?: number;
|
|
2628
|
+
/**
|
|
2629
|
+
* The maximum string length.
|
|
2630
|
+
* @format int64
|
|
2631
|
+
*/
|
|
2632
|
+
max_len?: number;
|
|
2633
|
+
/**
|
|
2634
|
+
* The minimum string length.
|
|
2635
|
+
* @format int64
|
|
2636
|
+
*/
|
|
2637
|
+
min_len?: number;
|
|
2638
|
+
/** The string pattern (regular expression). */
|
|
2639
|
+
pattern?: string;
|
|
2640
|
+
/** The string prefix. */
|
|
2641
|
+
prefix?: string;
|
|
2642
|
+
/** The string suffix. */
|
|
2643
|
+
suffix?: string;
|
|
2644
|
+
};
|
|
2645
|
+
/** schema-rich-text-list-field-descriptor */
|
|
2646
|
+
export type SchemaRichTextListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2647
|
+
/** The contained substring. */
|
|
2648
|
+
contains?: string;
|
|
2649
|
+
/** Default value. */
|
|
2650
|
+
default_value?: string[];
|
|
2651
|
+
/**
|
|
2652
|
+
* The exact string length.
|
|
2653
|
+
* @format int64
|
|
2654
|
+
*/
|
|
2655
|
+
eq_len?: number;
|
|
2656
|
+
/**
|
|
2657
|
+
* The maximum string length.
|
|
2658
|
+
* @format int64
|
|
2659
|
+
*/
|
|
2660
|
+
max_len?: number;
|
|
2661
|
+
/**
|
|
2662
|
+
* The minimum string length.
|
|
2663
|
+
* @format int64
|
|
2664
|
+
*/
|
|
2665
|
+
min_len?: number;
|
|
2666
|
+
/** The string pattern (regular expression). */
|
|
2667
|
+
pattern?: string;
|
|
2668
|
+
/** The string prefix. */
|
|
2669
|
+
prefix?: string;
|
|
2670
|
+
/** The string suffix. */
|
|
2671
|
+
suffix?: string;
|
|
2672
|
+
};
|
|
2673
|
+
/** schema-struct-field-descriptor */
|
|
2674
|
+
export type SchemaStructFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2675
|
+
/** Default value. */
|
|
2676
|
+
default_value?: object;
|
|
2677
|
+
};
|
|
2678
|
+
/** schema-struct-list-field-descriptor */
|
|
2679
|
+
export type SchemaStructListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2680
|
+
/** Default value. */
|
|
2681
|
+
default_value?: object[];
|
|
2682
|
+
};
|
|
2683
|
+
/** schema-text-field-descriptor */
|
|
2684
|
+
export type SchemaTextFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2685
|
+
/** The contained substring. */
|
|
2686
|
+
contains?: string;
|
|
2687
|
+
/** Default value. */
|
|
2688
|
+
default_value?: string;
|
|
2689
|
+
/**
|
|
2690
|
+
* The exact string length.
|
|
2691
|
+
* @format int64
|
|
2692
|
+
*/
|
|
2693
|
+
eq_len?: number;
|
|
2694
|
+
/**
|
|
2695
|
+
* The maximum string length.
|
|
2696
|
+
* @format int64
|
|
2697
|
+
*/
|
|
2698
|
+
max_len?: number;
|
|
2699
|
+
/**
|
|
2700
|
+
* The minimum string length.
|
|
2701
|
+
* @format int64
|
|
2702
|
+
*/
|
|
2703
|
+
min_len?: number;
|
|
2704
|
+
/** The string pattern (regular expression). */
|
|
2705
|
+
pattern?: string;
|
|
2706
|
+
/** The string prefix. */
|
|
2707
|
+
prefix?: string;
|
|
2708
|
+
/** The string suffix. */
|
|
2709
|
+
suffix?: string;
|
|
2710
|
+
};
|
|
2711
|
+
/** schema-text-list-field-descriptor */
|
|
2712
|
+
export type SchemaTextListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2713
|
+
/** The contained substring. */
|
|
2714
|
+
contains?: string;
|
|
2715
|
+
/** Default value. */
|
|
2716
|
+
default_value?: string[];
|
|
2717
|
+
/**
|
|
2718
|
+
* The exact string length.
|
|
2719
|
+
* @format int64
|
|
2720
|
+
*/
|
|
2721
|
+
eq_len?: number;
|
|
2722
|
+
/**
|
|
2723
|
+
* The maximum string length.
|
|
2724
|
+
* @format int64
|
|
2725
|
+
*/
|
|
2726
|
+
max_len?: number;
|
|
2727
|
+
/**
|
|
2728
|
+
* The minimum string length.
|
|
2729
|
+
* @format int64
|
|
2730
|
+
*/
|
|
2731
|
+
min_len?: number;
|
|
2732
|
+
/** The string pattern (regular expression). */
|
|
2733
|
+
pattern?: string;
|
|
2734
|
+
/** The string prefix. */
|
|
2735
|
+
prefix?: string;
|
|
2736
|
+
/** The string suffix. */
|
|
2737
|
+
suffix?: string;
|
|
2738
|
+
};
|
|
2739
|
+
/** schema-timestamp-field-descriptor */
|
|
2740
|
+
export type SchemaTimestampFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2741
|
+
/** Default value. */
|
|
2742
|
+
default_value?: string;
|
|
2743
|
+
};
|
|
2744
|
+
/** schema-timestamp-list-field-descriptor */
|
|
2745
|
+
export type SchemaTimestampListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2746
|
+
/** Default value. */
|
|
2747
|
+
default_value?: string[];
|
|
2748
|
+
};
|
|
2749
|
+
/** schema-tokens-field-descriptor */
|
|
2750
|
+
export type SchemaTokensFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2751
|
+
/** The contained substring. */
|
|
2752
|
+
contains?: string;
|
|
2753
|
+
/** Default value. */
|
|
2754
|
+
default_value?: string;
|
|
2755
|
+
/**
|
|
2756
|
+
* The exact string length.
|
|
2757
|
+
* @format int64
|
|
2758
|
+
*/
|
|
2759
|
+
eq_len?: number;
|
|
2760
|
+
/**
|
|
2761
|
+
* The maximum string length.
|
|
2762
|
+
* @format int64
|
|
2763
|
+
*/
|
|
2764
|
+
max_len?: number;
|
|
2765
|
+
/**
|
|
2766
|
+
* The minimum string length.
|
|
2767
|
+
* @format int64
|
|
2768
|
+
*/
|
|
2769
|
+
min_len?: number;
|
|
2770
|
+
/** The string pattern (regular expression). */
|
|
2771
|
+
pattern?: string;
|
|
2772
|
+
/** The string prefix. */
|
|
2773
|
+
prefix?: string;
|
|
2774
|
+
/** The string suffix. */
|
|
2775
|
+
suffix?: string;
|
|
2776
|
+
};
|
|
2777
|
+
/** schema-tokens-list-field-descriptor */
|
|
2778
|
+
export type SchemaTokensListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2779
|
+
/** The contained substring. */
|
|
2780
|
+
contains?: string;
|
|
2781
|
+
/** Default value. */
|
|
2782
|
+
default_value?: string[];
|
|
2783
|
+
/**
|
|
2784
|
+
* The exact string length.
|
|
2785
|
+
* @format int64
|
|
2786
|
+
*/
|
|
2787
|
+
eq_len?: number;
|
|
2788
|
+
/**
|
|
2789
|
+
* The maximum string length.
|
|
2790
|
+
* @format int64
|
|
2791
|
+
*/
|
|
2792
|
+
max_len?: number;
|
|
2793
|
+
/**
|
|
2794
|
+
* The minimum string length.
|
|
2795
|
+
* @format int64
|
|
2796
|
+
*/
|
|
2797
|
+
min_len?: number;
|
|
2798
|
+
/** The string pattern (regular expression). */
|
|
2799
|
+
pattern?: string;
|
|
2800
|
+
/** The string prefix. */
|
|
2801
|
+
prefix?: string;
|
|
2802
|
+
/** The string suffix. */
|
|
2803
|
+
suffix?: string;
|
|
2804
|
+
};
|
|
2805
|
+
/** schema-uenum-field-descriptor */
|
|
2806
|
+
export type SchemaUenumFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2807
|
+
/** Allowed values for the field. */
|
|
2808
|
+
allowed_values: SchemaFieldUenumValue[];
|
|
2809
|
+
/**
|
|
2810
|
+
* Default value.
|
|
2811
|
+
* @format int64
|
|
2812
|
+
*/
|
|
2813
|
+
default_value?: number;
|
|
2814
|
+
};
|
|
2815
|
+
/** schema-uenum-list-field-descriptor */
|
|
2816
|
+
export type SchemaUenumListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2817
|
+
/** Allowed values for the field. */
|
|
2818
|
+
allowed_values: SchemaFieldUenumValue[];
|
|
2819
|
+
/** Default value. */
|
|
2820
|
+
default_value?: number[];
|
|
2821
|
+
};
|
|
2822
|
+
/** schema-unknown-field-descriptor */
|
|
2823
|
+
export type SchemaUnknownFieldDescriptor = SchemaFieldDescriptorBase;
|
|
2320
2824
|
/** set-tag-with-value */
|
|
2321
2825
|
export interface SetTagWithValue {
|
|
2322
2826
|
/**
|
|
@@ -2455,11 +2959,45 @@ export interface StagedInfoFilter {
|
|
|
2455
2959
|
/** Filters for issues that are staged. */
|
|
2456
2960
|
is_staged?: boolean;
|
|
2457
2961
|
}
|
|
2962
|
+
/** survey */
|
|
2963
|
+
export type Survey = AtomBase & {
|
|
2964
|
+
/** Description of the survey. */
|
|
2965
|
+
description?: string;
|
|
2966
|
+
/** Header of the survey. */
|
|
2967
|
+
header?: string;
|
|
2968
|
+
/** Text posted when introducing the survey to the responder. */
|
|
2969
|
+
introductory_text?: string;
|
|
2970
|
+
/**
|
|
2971
|
+
* Survey name associated with schema. This name would be unique per
|
|
2972
|
+
* dev org.
|
|
2973
|
+
*/
|
|
2974
|
+
name?: string;
|
|
2975
|
+
/** Text posted after the response is collected. */
|
|
2976
|
+
response_text?: string;
|
|
2977
|
+
/** List of all fields in the schema. */
|
|
2978
|
+
schema?: SchemaFieldDescriptor[];
|
|
2979
|
+
/** List of all the fields and their respective metadata in the schema. */
|
|
2980
|
+
schema_with_metadata?: SurveyFieldWithMetadata[];
|
|
2981
|
+
/** Title of the survey. */
|
|
2982
|
+
title?: string;
|
|
2983
|
+
};
|
|
2458
2984
|
/**
|
|
2459
2985
|
* survey-aggregation-filter
|
|
2460
2986
|
* The filter for survey aggregation.
|
|
2461
2987
|
*/
|
|
2462
2988
|
export type SurveyAggregationFilter = object;
|
|
2989
|
+
/**
|
|
2990
|
+
* survey-field-with-metadata
|
|
2991
|
+
* Field descriptors with additional metadata for surveys.
|
|
2992
|
+
*/
|
|
2993
|
+
export interface SurveyFieldWithMetadata {
|
|
2994
|
+
/** Set of field attributes. */
|
|
2995
|
+
field?: SchemaFieldDescriptor;
|
|
2996
|
+
/** Additional metadata for the input field. */
|
|
2997
|
+
metadata?: object;
|
|
2998
|
+
/** The question linked to the input field. */
|
|
2999
|
+
question?: string;
|
|
3000
|
+
}
|
|
2463
3001
|
/** survey-response */
|
|
2464
3002
|
export type SurveyResponse = AtomBase & {
|
|
2465
3003
|
/** The unique ID associated with the dispatched survey. */
|
|
@@ -2480,6 +3018,8 @@ export type SurveyResponse = AtomBase & {
|
|
|
2480
3018
|
};
|
|
2481
3019
|
/** sync-metadata-filter */
|
|
2482
3020
|
export interface SyncMetadataFilter {
|
|
3021
|
+
/** Filters for issues with this specific external reference. */
|
|
3022
|
+
external_reference?: string[];
|
|
2483
3023
|
last_sync_in?: SyncMetadataFilterSyncInFilter;
|
|
2484
3024
|
last_sync_out?: SyncMetadataFilterSyncOutFilter;
|
|
2485
3025
|
/** Filters for issues synced from this specific origin system. */
|
|
@@ -2697,6 +3237,14 @@ export type Ticket = WorkBase & {
|
|
|
2697
3237
|
rev_org?: OrgSummary;
|
|
2698
3238
|
/** The properties of an enum value. */
|
|
2699
3239
|
sentiment?: EnumValue;
|
|
3240
|
+
/**
|
|
3241
|
+
* Timestamp when the sentiment was last modified.
|
|
3242
|
+
* @format date-time
|
|
3243
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3244
|
+
*/
|
|
3245
|
+
sentiment_modified_date?: string;
|
|
3246
|
+
/** Summary justifying the sentiment. */
|
|
3247
|
+
sentiment_summary?: string;
|
|
2700
3248
|
/** Severity of the ticket. */
|
|
2701
3249
|
severity?: TicketSeverity;
|
|
2702
3250
|
sla_tracker?: SlaTrackerSummary;
|
|
@@ -2742,6 +3290,7 @@ export type TimelineComment = TimelineEntryBase & {
|
|
|
2742
3290
|
};
|
|
2743
3291
|
/** The type of the body to use for the comment. */
|
|
2744
3292
|
export declare enum TimelineCommentBodyType {
|
|
3293
|
+
Data = "data",
|
|
2745
3294
|
SnapKit = "snap_kit",
|
|
2746
3295
|
SnapWidget = "snap_widget",
|
|
2747
3296
|
Text = "text"
|
|
@@ -3155,9 +3704,12 @@ export interface WebhookEventRequest {
|
|
|
3155
3704
|
sla_tracker_created?: EventSlaTrackerCreated;
|
|
3156
3705
|
sla_tracker_deleted?: EventSlaTrackerDeleted;
|
|
3157
3706
|
sla_tracker_updated?: EventSlaTrackerUpdated;
|
|
3707
|
+
survey_created?: EventSurveyCreated;
|
|
3708
|
+
survey_deleted?: EventSurveyDeleted;
|
|
3158
3709
|
survey_response_created?: EventSurveyResponseCreated;
|
|
3159
3710
|
survey_response_deleted?: EventSurveyResponseDeleted;
|
|
3160
3711
|
survey_response_updated?: EventSurveyResponseUpdated;
|
|
3712
|
+
survey_updated?: EventSurveyUpdated;
|
|
3161
3713
|
tag_created?: EventTagCreated;
|
|
3162
3714
|
tag_deleted?: EventTagDeleted;
|
|
3163
3715
|
tag_updated?: EventTagUpdated;
|
|
@@ -3184,6 +3736,7 @@ export interface WebhookEventRequest {
|
|
|
3184
3736
|
webhook_updated?: EventWebhookUpdated;
|
|
3185
3737
|
work_created?: EventWorkCreated;
|
|
3186
3738
|
work_deleted?: EventWorkDeleted;
|
|
3739
|
+
work_fetched?: EventWorkFetched;
|
|
3187
3740
|
work_updated?: EventWorkUpdated;
|
|
3188
3741
|
}
|
|
3189
3742
|
/** webhook-event-response */
|
|
@@ -3226,6 +3779,12 @@ export declare enum WebhookEventType {
|
|
|
3226
3779
|
SlaTrackerCreated = "sla_tracker_created",
|
|
3227
3780
|
SlaTrackerDeleted = "sla_tracker_deleted",
|
|
3228
3781
|
SlaTrackerUpdated = "sla_tracker_updated",
|
|
3782
|
+
SurveyCreated = "survey_created",
|
|
3783
|
+
SurveyDeleted = "survey_deleted",
|
|
3784
|
+
SurveyResponseCreated = "survey_response_created",
|
|
3785
|
+
SurveyResponseDeleted = "survey_response_deleted",
|
|
3786
|
+
SurveyResponseUpdated = "survey_response_updated",
|
|
3787
|
+
SurveyUpdated = "survey_updated",
|
|
3229
3788
|
TagCreated = "tag_created",
|
|
3230
3789
|
TagDeleted = "tag_deleted",
|
|
3231
3790
|
TagUpdated = "tag_updated",
|
|
@@ -3238,6 +3797,7 @@ export declare enum WebhookEventType {
|
|
|
3238
3797
|
WebhookUpdated = "webhook_updated",
|
|
3239
3798
|
WorkCreated = "work_created",
|
|
3240
3799
|
WorkDeleted = "work_deleted",
|
|
3800
|
+
WorkFetched = "work_fetched",
|
|
3241
3801
|
WorkUpdated = "work_updated"
|
|
3242
3802
|
}
|
|
3243
3803
|
/** webhook-event-verify */
|
|
@@ -3854,6 +4414,14 @@ export interface WorksUpdateRequestTicket {
|
|
|
3854
4414
|
* @format int64
|
|
3855
4415
|
*/
|
|
3856
4416
|
sentiment?: number;
|
|
4417
|
+
/**
|
|
4418
|
+
* Timestamp at which sentiment was last modified.
|
|
4419
|
+
* @format date-time
|
|
4420
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4421
|
+
*/
|
|
4422
|
+
sentiment_modified_date?: string;
|
|
4423
|
+
/** Summary justifying the current sentiment. */
|
|
4424
|
+
sentiment_summary?: string;
|
|
3857
4425
|
/** Severity of the ticket. */
|
|
3858
4426
|
severity?: TicketSeverity;
|
|
3859
4427
|
}
|
|
@@ -5044,6 +5612,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5044
5612
|
'stage.name'?: string[];
|
|
5045
5613
|
/** Filters for issues that are staged. */
|
|
5046
5614
|
'staged_info.is_staged'?: boolean;
|
|
5615
|
+
/** Filters for issues with this specific external reference. */
|
|
5616
|
+
'sync_metadata.external_reference'?: string[];
|
|
5047
5617
|
/** Filters for works with selected sync statuses. */
|
|
5048
5618
|
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
5049
5619
|
/** Filters for works modified with selected sync units. */
|
|
@@ -5181,6 +5751,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5181
5751
|
'stage.name'?: string[];
|
|
5182
5752
|
/** Filters for issues that are staged. */
|
|
5183
5753
|
'staged_info.is_staged'?: boolean;
|
|
5754
|
+
/** Filters for issues with this specific external reference. */
|
|
5755
|
+
'sync_metadata.external_reference'?: string[];
|
|
5184
5756
|
/** Filters for works with selected sync statuses. */
|
|
5185
5757
|
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
5186
5758
|
/** Filters for works modified with selected sync units. */
|