@devrev/typescript-sdk 1.1.29 → 1.1.31

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.
@@ -206,7 +206,8 @@ export interface AccountsUpdateResponse {
206
206
  export interface ArchetypeMetricTarget {
207
207
  /**
208
208
  * If true, the schedule attached to this metric is out of schedule at
209
- * the time of the query.
209
+ * the time of the query. It is not set for metrics in *completed*
210
+ * stage.
210
211
  */
211
212
  is_out_of_schedule?: boolean;
212
213
  metric_definition: MetricDefinitionSummary;
@@ -552,6 +553,11 @@ export declare enum AuthTokenTokenType {
552
553
  export interface AuthTokensAccountTraits {
553
554
  /** The display name of the account. */
554
555
  display_name?: string;
556
+ /**
557
+ * List of company's domain names on accounts. Example -
558
+ * ['devrev.ai'].
559
+ */
560
+ domains?: string[];
555
561
  }
556
562
  /**
557
563
  * auth-tokens-create-request
@@ -703,7 +709,10 @@ export interface AuthTokensOrgTraits {
703
709
  description?: string;
704
710
  /** The display name of the Rev org. */
705
711
  display_name?: string;
706
- /** The domain of the Rev org. */
712
+ /**
713
+ * The domain of the Rev org.
714
+ * @deprecated
715
+ */
707
716
  domain?: string;
708
717
  /** Phone numbers of the Rev org. */
709
718
  phone_numbers?: string[];
@@ -821,6 +830,11 @@ export interface ConversationMetadata {
821
830
  */
822
831
  url_context?: string;
823
832
  }
833
+ /** conversation-summary */
834
+ export type ConversationSummary = AtomBaseSummary & {
835
+ /** Title of the conversation object. */
836
+ title?: string;
837
+ };
824
838
  /**
825
839
  * date-filter
826
840
  * Provides ways to specify date ranges on objects.
@@ -1140,7 +1154,7 @@ export type EnhancementSummary = PartBaseSummary;
1140
1154
  */
1141
1155
  export interface EnumValue {
1142
1156
  /**
1143
- * The uiique ID of the enum value.
1157
+ * The unique ID of the enum value.
1144
1158
  * @format int64
1145
1159
  */
1146
1160
  id: number;
@@ -1200,9 +1214,12 @@ export interface ErrorBadRequestMergeWorksErrorError {
1200
1214
  closed?: ErrorBadRequestMergeWorksErrorErrorClosed;
1201
1215
  /** The details of the error. */
1202
1216
  details: string;
1217
+ different_reporters?: ErrorBadRequestMergeWorksErrorErrorDifferentReporters;
1203
1218
  different_workspace?: ErrorBadRequestMergeWorksErrorErrorDifferentWorkspace;
1204
1219
  invalid_stage_transition?: ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition;
1205
- subtype?: 'already_merged' | 'closed' | 'different_workspace' | 'invalid_stage_transition';
1220
+ locked?: ErrorBadRequestMergeWorksErrorErrorLocked;
1221
+ stage_not_found_for_subtype?: ErrorBadRequestMergeWorksErrorErrorStageNotFoundForSubtype;
1222
+ subtype?: 'already_merged' | 'closed' | 'different_reporters' | 'different_workspace' | 'invalid_stage_transition' | 'locked' | 'stage_not_found_for_subtype';
1206
1223
  /** The ID of the work which failed the validation. */
1207
1224
  work: string;
1208
1225
  }
@@ -1213,12 +1230,19 @@ export interface ErrorBadRequestMergeWorksErrorErrorAlreadyMerged {
1213
1230
  }
1214
1231
  /** error-bad-request-merge-works-error-error-closed */
1215
1232
  export type ErrorBadRequestMergeWorksErrorErrorClosed = object;
1233
+ /** error-bad-request-merge-works-error-error-different-reporters */
1234
+ export interface ErrorBadRequestMergeWorksErrorErrorDifferentReporters {
1235
+ /** The reporters of the primary work. */
1236
+ primary_reporters?: string[];
1237
+ /** The reporters of the secondary work. */
1238
+ secondary_reporters?: string[];
1239
+ }
1216
1240
  /** error-bad-request-merge-works-error-error-different-workspace */
1217
1241
  export interface ErrorBadRequestMergeWorksErrorErrorDifferentWorkspace {
1218
1242
  /** The workspace of the primary work. */
1219
- primary_workspace: string;
1243
+ primary_workspace?: string;
1220
1244
  /** The workspace of the secondary work. */
1221
- secondary_workspace: string;
1245
+ secondary_workspace?: string;
1222
1246
  }
1223
1247
  /** error-bad-request-merge-works-error-error-invalid-stage-transition */
1224
1248
  export interface ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition {
@@ -1227,6 +1251,13 @@ export interface ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition {
1227
1251
  /** The stage to which the transition isn't allowed. */
1228
1252
  requested_stage: string;
1229
1253
  }
1254
+ /** error-bad-request-merge-works-error-error-locked */
1255
+ export type ErrorBadRequestMergeWorksErrorErrorLocked = object;
1256
+ /** error-bad-request-merge-works-error-error-stage-not-found-for-subtype */
1257
+ export interface ErrorBadRequestMergeWorksErrorErrorStageNotFoundForSubtype {
1258
+ /** The subtype of the work for which stage is not configured. */
1259
+ subtype?: string;
1260
+ }
1230
1261
  /** error-bad-request-missing-dependency */
1231
1262
  export interface ErrorBadRequestMissingDependency {
1232
1263
  /** The dependent fields. */
@@ -1442,10 +1473,36 @@ export interface EventGroupCreated {
1442
1473
  export interface EventGroupDeleted {
1443
1474
  /** The ID of the group that was deleted. */
1444
1475
  id: string;
1476
+ old_group?: Group;
1477
+ }
1478
+ /** event-group-member-added */
1479
+ export interface EventGroupMemberAdded {
1480
+ group: GroupSummary;
1481
+ member: UserSummary;
1482
+ }
1483
+ /** event-group-member-removed */
1484
+ export interface EventGroupMemberRemoved {
1485
+ group: GroupSummary;
1486
+ member: UserSummary;
1445
1487
  }
1446
1488
  /** event-group-updated */
1447
1489
  export interface EventGroupUpdated {
1448
1490
  group: Group;
1491
+ old_group?: Group;
1492
+ }
1493
+ /** event-link-created */
1494
+ export interface EventLinkCreated {
1495
+ link: Link;
1496
+ }
1497
+ /** event-link-deleted */
1498
+ export interface EventLinkDeleted {
1499
+ /** The ID of the link that was deleted. */
1500
+ id: string;
1501
+ }
1502
+ /** event-link-updated */
1503
+ export interface EventLinkUpdated {
1504
+ link: Link;
1505
+ old_link?: Link;
1449
1506
  }
1450
1507
  /** event-part-created */
1451
1508
  export interface EventPartCreated {
@@ -1511,6 +1568,16 @@ export interface EventSlaTrackerDeleted {
1511
1568
  export interface EventSlaTrackerUpdated {
1512
1569
  sla_tracker: SlaTracker;
1513
1570
  }
1571
+ /** event-survey-created */
1572
+ export interface EventSurveyCreated {
1573
+ survey: Survey;
1574
+ }
1575
+ /** event-survey-deleted */
1576
+ export interface EventSurveyDeleted {
1577
+ /** The ID of the survey that was deleted. */
1578
+ id: string;
1579
+ old_survey?: Survey;
1580
+ }
1514
1581
  /** event-survey-response-created */
1515
1582
  export interface EventSurveyResponseCreated {
1516
1583
  survey_response: SurveyResponse;
@@ -1519,11 +1586,18 @@ export interface EventSurveyResponseCreated {
1519
1586
  export interface EventSurveyResponseDeleted {
1520
1587
  /** The ID of the survey response that was deleted. */
1521
1588
  id: string;
1589
+ old_survey_response?: SurveyResponse;
1522
1590
  }
1523
1591
  /** event-survey-response-updated */
1524
1592
  export interface EventSurveyResponseUpdated {
1593
+ old_survey_response?: SurveyResponse;
1525
1594
  survey_response: SurveyResponse;
1526
1595
  }
1596
+ /** event-survey-updated */
1597
+ export interface EventSurveyUpdated {
1598
+ old_survey?: Survey;
1599
+ survey: Survey;
1600
+ }
1527
1601
  /** event-tag-created */
1528
1602
  export interface EventTagCreated {
1529
1603
  tag: Tag;
@@ -1635,6 +1709,13 @@ export declare enum IssuePriority {
1635
1709
  P2 = "p2",
1636
1710
  P3 = "p3"
1637
1711
  }
1712
+ /** issue-summary */
1713
+ export type IssueSummary = WorkBaseSummary & {
1714
+ /** Priority of the work based upon impact and criticality. */
1715
+ priority?: IssuePriority;
1716
+ /** Vista group item. */
1717
+ sprint?: VistaGroupItemSummary;
1718
+ };
1638
1719
  /**
1639
1720
  * job-history-item
1640
1721
  * Defines a job history line item.
@@ -1676,6 +1757,49 @@ export interface LegacyStage {
1676
1757
  /** Current stage name of the work item. */
1677
1758
  name: string;
1678
1759
  }
1760
+ /**
1761
+ * legacy-stage-summary
1762
+ * Describes the current stage of a work item.
1763
+ */
1764
+ export interface LegacyStageSummary {
1765
+ /** Current stage name of the work item. */
1766
+ name: string;
1767
+ }
1768
+ /** link */
1769
+ export type Link = AtomBase & {
1770
+ /** Type of link used to define the relationship. */
1771
+ link_type: LinkType;
1772
+ source: LinkEndpointSummary;
1773
+ target: LinkEndpointSummary;
1774
+ };
1775
+ /** link-endpoint-summary */
1776
+ export type LinkEndpointSummary = (CapabilitySummary | ConversationSummary | EnhancementSummary | FeatureSummary | IssueSummary | ProductSummary | TicketSummary) & {
1777
+ type: LinkEndpointType;
1778
+ };
1779
+ export declare enum LinkEndpointType {
1780
+ Capability = "capability",
1781
+ Conversation = "conversation",
1782
+ Enhancement = "enhancement",
1783
+ Feature = "feature",
1784
+ Issue = "issue",
1785
+ Product = "product",
1786
+ Ticket = "ticket"
1787
+ }
1788
+ /** Type of link used to define the relationship. */
1789
+ export declare enum LinkType {
1790
+ CustomLink = "custom_link",
1791
+ DevelopedWith = "developed_with",
1792
+ Imports = "imports",
1793
+ IsAnalyzedBy = "is_analyzed_by",
1794
+ IsConvertedTo = "is_converted_to",
1795
+ IsDependentOn = "is_dependent_on",
1796
+ IsDuplicateOf = "is_duplicate_of",
1797
+ IsMergedInto = "is_merged_into",
1798
+ IsParentOf = "is_parent_of",
1799
+ IsPartOf = "is_part_of",
1800
+ IsRelatedTo = "is_related_to",
1801
+ Serves = "serves"
1802
+ }
1679
1803
  /**
1680
1804
  * The iteration mode to use. If "after", then entries after the provided
1681
1805
  * cursor will be returned, or if no cursor is provided, then from the
@@ -2003,6 +2127,11 @@ export interface PartsUpdateResponse {
2003
2127
  export type Product = PartBase;
2004
2128
  /** product-summary */
2005
2129
  export type ProductSummary = PartBaseSummary;
2130
+ /**
2131
+ * removed-sla-metric-history
2132
+ * User, timestamp and metric id of removed metrics.
2133
+ */
2134
+ export type RemovedSlaMetricHistory = object;
2006
2135
  /** rev-org */
2007
2136
  export type RevOrg = OrgBase & {
2008
2137
  /** Description of the Rev organization. */
@@ -2029,7 +2158,10 @@ export interface RevOrgsCreateRequest {
2029
2158
  description?: string;
2030
2159
  /** Name of the Rev organization. */
2031
2160
  display_name: string;
2032
- /** Company's domain name. Example - 'devrev.ai'. */
2161
+ /**
2162
+ * Company's domain name. Example - 'devrev.ai'.
2163
+ * @deprecated
2164
+ */
2033
2165
  domain?: string;
2034
2166
  /** The environment of the Org. Defaults to 'production' if not specified. */
2035
2167
  environment?: OrgEnvironment;
@@ -2154,7 +2286,10 @@ export interface RevOrgsUpdateRequest {
2154
2286
  description?: string;
2155
2287
  /** Customer chosen name for the Rev organization. */
2156
2288
  display_name?: string;
2157
- /** Company's domain name. Example - 'devrev.ai'. */
2289
+ /**
2290
+ * Company's domain name. Example - 'devrev.ai'.
2291
+ * @deprecated
2292
+ */
2158
2293
  domain?: string;
2159
2294
  /** The environment of the Org. Defaults to 'production' if not specified. */
2160
2295
  environment?: OrgEnvironment;
@@ -2205,6 +2340,441 @@ export type RevUserSummary = UserBaseSummary & {
2205
2340
  external_ref?: string;
2206
2341
  rev_org?: OrgSummary;
2207
2342
  };
2343
+ /** schema-bool-field-descriptor */
2344
+ export type SchemaBoolFieldDescriptor = SchemaFieldDescriptorBase & {
2345
+ /** Default value. */
2346
+ default_value?: boolean;
2347
+ };
2348
+ /** schema-bool-list-field-descriptor */
2349
+ export type SchemaBoolListFieldDescriptor = SchemaFieldDescriptorBase & {
2350
+ /** Default value. */
2351
+ default_value?: boolean[];
2352
+ };
2353
+ /** schema-composite-field-descriptor */
2354
+ export type SchemaCompositeFieldDescriptor = SchemaFieldDescriptorBase & {
2355
+ /** Composite type. Required when field type is composite. */
2356
+ composite_type?: string;
2357
+ };
2358
+ /** schema-composite-list-field-descriptor */
2359
+ export type SchemaCompositeListFieldDescriptor = SchemaFieldDescriptorBase & {
2360
+ /** Composite type. Required when field type is composite. */
2361
+ composite_type?: string;
2362
+ };
2363
+ /** schema-date-field-descriptor */
2364
+ export type SchemaDateFieldDescriptor = SchemaFieldDescriptorBase & {
2365
+ /** Default value. */
2366
+ default_value?: string;
2367
+ };
2368
+ /** schema-date-list-field-descriptor */
2369
+ export type SchemaDateListFieldDescriptor = SchemaFieldDescriptorBase & {
2370
+ /** Default value. */
2371
+ default_value?: string[];
2372
+ };
2373
+ /** schema-double-field-descriptor */
2374
+ export type SchemaDoubleFieldDescriptor = SchemaFieldDescriptorBase & {
2375
+ /**
2376
+ * Default value.
2377
+ * @format double
2378
+ */
2379
+ default_value?: number;
2380
+ };
2381
+ /** schema-double-list-field-descriptor */
2382
+ export type SchemaDoubleListFieldDescriptor = SchemaFieldDescriptorBase & {
2383
+ /** Default value. */
2384
+ default_value?: number[];
2385
+ };
2386
+ /** schema-enum-field-descriptor */
2387
+ export type SchemaEnumFieldDescriptor = SchemaFieldDescriptorBase & {
2388
+ /** Allowed values for the field. */
2389
+ allowed_values: string[];
2390
+ /** Default value. */
2391
+ default_value?: string;
2392
+ };
2393
+ /** schema-enum-list-field-descriptor */
2394
+ export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
2395
+ /** Allowed values for the field. */
2396
+ allowed_values: string[];
2397
+ /** Default value. */
2398
+ default_value?: string[];
2399
+ };
2400
+ /**
2401
+ * schema-field-descriptor
2402
+ * Set of field attributes.
2403
+ */
2404
+ export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaStructFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
2405
+ field_type: SchemaFieldDescriptorFieldType;
2406
+ };
2407
+ /** schema-field-descriptor-array-type */
2408
+ export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaStructListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
2409
+ base_type: SchemaFieldDescriptorArrayTypeBaseType;
2410
+ /**
2411
+ * The exact array length.
2412
+ * @format int64
2413
+ */
2414
+ eq_items?: number;
2415
+ /**
2416
+ * The maximum array length.
2417
+ * @format int64
2418
+ */
2419
+ max_items?: number;
2420
+ /**
2421
+ * The minimum array length.
2422
+ * @format int64
2423
+ */
2424
+ min_items?: number;
2425
+ };
2426
+ export declare enum SchemaFieldDescriptorArrayTypeBaseType {
2427
+ Bool = "bool",
2428
+ Composite = "composite",
2429
+ Date = "date",
2430
+ Double = "double",
2431
+ Enum = "enum",
2432
+ Id = "id",
2433
+ Int = "int",
2434
+ RichText = "rich_text",
2435
+ Struct = "struct",
2436
+ Text = "text",
2437
+ Timestamp = "timestamp",
2438
+ Tokens = "tokens",
2439
+ Uenum = "uenum"
2440
+ }
2441
+ /** schema-field-descriptor-base */
2442
+ export interface SchemaFieldDescriptorBase {
2443
+ /** Description of the field. */
2444
+ description?: string;
2445
+ /** Whether this field is filterable, groupable and sortable. */
2446
+ is_filterable?: boolean;
2447
+ /** Whether this field is immutable or not. */
2448
+ is_immutable?: boolean;
2449
+ /**
2450
+ * Whether this field can hold Personally Identifiable Information
2451
+ * (PII).
2452
+ */
2453
+ is_pii?: boolean;
2454
+ /** Whether this field is required or not. */
2455
+ is_required?: boolean;
2456
+ /** The schema of MFZ specific fields. */
2457
+ mfz?: SchemaFieldMfzMetadata;
2458
+ /** Name of the field. */
2459
+ name: string;
2460
+ /** The schema of oasis specific fields. */
2461
+ oasis?: SchemaFieldOasisMetadata;
2462
+ /** Type this field is from. */
2463
+ origin?: string;
2464
+ /** The schema of ui specific fields. */
2465
+ ui?: SchemaFieldUiMetadata;
2466
+ }
2467
+ export declare enum SchemaFieldDescriptorFieldType {
2468
+ Array = "array",
2469
+ Bool = "bool",
2470
+ Composite = "composite",
2471
+ Date = "date",
2472
+ Double = "double",
2473
+ Enum = "enum",
2474
+ Id = "id",
2475
+ Int = "int",
2476
+ RichText = "rich_text",
2477
+ Struct = "struct",
2478
+ Text = "text",
2479
+ Timestamp = "timestamp",
2480
+ Tokens = "tokens",
2481
+ Uenum = "uenum",
2482
+ Unknown = "unknown"
2483
+ }
2484
+ /**
2485
+ * schema-field-mfz-metadata
2486
+ * The schema of MFZ specific fields.
2487
+ */
2488
+ export type SchemaFieldMfzMetadata = object;
2489
+ /**
2490
+ * schema-field-oasis-metadata
2491
+ * The schema of oasis specific fields.
2492
+ */
2493
+ export type SchemaFieldOasisMetadata = object;
2494
+ /**
2495
+ * schema-field-uenum-value
2496
+ * A unified enum value.
2497
+ */
2498
+ export type SchemaFieldUenumValue = object;
2499
+ /**
2500
+ * schema-field-ui-metadata
2501
+ * The schema of ui specific fields.
2502
+ */
2503
+ export type SchemaFieldUiMetadata = object;
2504
+ /** schema-id-field-descriptor */
2505
+ export type SchemaIdFieldDescriptor = SchemaFieldDescriptorBase & {
2506
+ /** Default value. */
2507
+ default_value?: string;
2508
+ /** Object ID types. Required when field type is ID. */
2509
+ id_type?: string[];
2510
+ };
2511
+ /** schema-id-list-field-descriptor */
2512
+ export type SchemaIdListFieldDescriptor = SchemaFieldDescriptorBase & {
2513
+ /** Default value. */
2514
+ default_value?: string[];
2515
+ /** Object ID types. Required when field type is ID. */
2516
+ id_type?: string[];
2517
+ };
2518
+ /** schema-int-field-descriptor */
2519
+ export type SchemaIntFieldDescriptor = SchemaFieldDescriptorBase & {
2520
+ /**
2521
+ * Default value.
2522
+ * @format int64
2523
+ */
2524
+ default_value?: number;
2525
+ /**
2526
+ * The minimum value for the integer (exclusive).
2527
+ * @format int64
2528
+ */
2529
+ gt?: number;
2530
+ /**
2531
+ * The minimum value for the integer (inclusive).
2532
+ * @format int64
2533
+ */
2534
+ gte?: number;
2535
+ /**
2536
+ * The maximum value for the integer (exclusive).
2537
+ * @format int64
2538
+ */
2539
+ lt?: number;
2540
+ /**
2541
+ * The maximum value for the integer (inclusive).
2542
+ * @format int64
2543
+ */
2544
+ lte?: number;
2545
+ };
2546
+ /** schema-int-list-field-descriptor */
2547
+ export type SchemaIntListFieldDescriptor = SchemaFieldDescriptorBase & {
2548
+ /** Default value. */
2549
+ default_value?: number[];
2550
+ /**
2551
+ * The minimum value for the integer (exclusive).
2552
+ * @format int64
2553
+ */
2554
+ gt?: number;
2555
+ /**
2556
+ * The minimum value for the integer (inclusive).
2557
+ * @format int64
2558
+ */
2559
+ gte?: number;
2560
+ /**
2561
+ * The maximum value for the integer (exclusive).
2562
+ * @format int64
2563
+ */
2564
+ lt?: number;
2565
+ /**
2566
+ * The maximum value for the integer (inclusive).
2567
+ * @format int64
2568
+ */
2569
+ lte?: number;
2570
+ };
2571
+ /** schema-rich-text-field-descriptor */
2572
+ export type SchemaRichTextFieldDescriptor = SchemaFieldDescriptorBase & {
2573
+ /** The contained substring. */
2574
+ contains?: string;
2575
+ /** Default value. */
2576
+ default_value?: string;
2577
+ /**
2578
+ * The exact string length.
2579
+ * @format int64
2580
+ */
2581
+ eq_len?: number;
2582
+ /**
2583
+ * The maximum string length.
2584
+ * @format int64
2585
+ */
2586
+ max_len?: number;
2587
+ /**
2588
+ * The minimum string length.
2589
+ * @format int64
2590
+ */
2591
+ min_len?: number;
2592
+ /** The string pattern (regular expression). */
2593
+ pattern?: string;
2594
+ /** The string prefix. */
2595
+ prefix?: string;
2596
+ /** The string suffix. */
2597
+ suffix?: string;
2598
+ };
2599
+ /** schema-rich-text-list-field-descriptor */
2600
+ export type SchemaRichTextListFieldDescriptor = SchemaFieldDescriptorBase & {
2601
+ /** The contained substring. */
2602
+ contains?: string;
2603
+ /** Default value. */
2604
+ default_value?: string[];
2605
+ /**
2606
+ * The exact string length.
2607
+ * @format int64
2608
+ */
2609
+ eq_len?: number;
2610
+ /**
2611
+ * The maximum string length.
2612
+ * @format int64
2613
+ */
2614
+ max_len?: number;
2615
+ /**
2616
+ * The minimum string length.
2617
+ * @format int64
2618
+ */
2619
+ min_len?: number;
2620
+ /** The string pattern (regular expression). */
2621
+ pattern?: string;
2622
+ /** The string prefix. */
2623
+ prefix?: string;
2624
+ /** The string suffix. */
2625
+ suffix?: string;
2626
+ };
2627
+ /** schema-struct-field-descriptor */
2628
+ export type SchemaStructFieldDescriptor = SchemaFieldDescriptorBase & {
2629
+ /** Default value. */
2630
+ default_value?: object;
2631
+ };
2632
+ /** schema-struct-list-field-descriptor */
2633
+ export type SchemaStructListFieldDescriptor = SchemaFieldDescriptorBase & {
2634
+ /** Default value. */
2635
+ default_value?: object[];
2636
+ };
2637
+ /** schema-text-field-descriptor */
2638
+ export type SchemaTextFieldDescriptor = SchemaFieldDescriptorBase & {
2639
+ /** The contained substring. */
2640
+ contains?: string;
2641
+ /** Default value. */
2642
+ default_value?: string;
2643
+ /**
2644
+ * The exact string length.
2645
+ * @format int64
2646
+ */
2647
+ eq_len?: number;
2648
+ /**
2649
+ * The maximum string length.
2650
+ * @format int64
2651
+ */
2652
+ max_len?: number;
2653
+ /**
2654
+ * The minimum string length.
2655
+ * @format int64
2656
+ */
2657
+ min_len?: number;
2658
+ /** The string pattern (regular expression). */
2659
+ pattern?: string;
2660
+ /** The string prefix. */
2661
+ prefix?: string;
2662
+ /** The string suffix. */
2663
+ suffix?: string;
2664
+ };
2665
+ /** schema-text-list-field-descriptor */
2666
+ export type SchemaTextListFieldDescriptor = SchemaFieldDescriptorBase & {
2667
+ /** The contained substring. */
2668
+ contains?: string;
2669
+ /** Default value. */
2670
+ default_value?: string[];
2671
+ /**
2672
+ * The exact string length.
2673
+ * @format int64
2674
+ */
2675
+ eq_len?: number;
2676
+ /**
2677
+ * The maximum string length.
2678
+ * @format int64
2679
+ */
2680
+ max_len?: number;
2681
+ /**
2682
+ * The minimum string length.
2683
+ * @format int64
2684
+ */
2685
+ min_len?: number;
2686
+ /** The string pattern (regular expression). */
2687
+ pattern?: string;
2688
+ /** The string prefix. */
2689
+ prefix?: string;
2690
+ /** The string suffix. */
2691
+ suffix?: string;
2692
+ };
2693
+ /** schema-timestamp-field-descriptor */
2694
+ export type SchemaTimestampFieldDescriptor = SchemaFieldDescriptorBase & {
2695
+ /** Default value. */
2696
+ default_value?: string;
2697
+ };
2698
+ /** schema-timestamp-list-field-descriptor */
2699
+ export type SchemaTimestampListFieldDescriptor = SchemaFieldDescriptorBase & {
2700
+ /** Default value. */
2701
+ default_value?: string[];
2702
+ };
2703
+ /** schema-tokens-field-descriptor */
2704
+ export type SchemaTokensFieldDescriptor = SchemaFieldDescriptorBase & {
2705
+ /** The contained substring. */
2706
+ contains?: string;
2707
+ /** Default value. */
2708
+ default_value?: string;
2709
+ /**
2710
+ * The exact string length.
2711
+ * @format int64
2712
+ */
2713
+ eq_len?: number;
2714
+ /**
2715
+ * The maximum string length.
2716
+ * @format int64
2717
+ */
2718
+ max_len?: number;
2719
+ /**
2720
+ * The minimum string length.
2721
+ * @format int64
2722
+ */
2723
+ min_len?: number;
2724
+ /** The string pattern (regular expression). */
2725
+ pattern?: string;
2726
+ /** The string prefix. */
2727
+ prefix?: string;
2728
+ /** The string suffix. */
2729
+ suffix?: string;
2730
+ };
2731
+ /** schema-tokens-list-field-descriptor */
2732
+ export type SchemaTokensListFieldDescriptor = SchemaFieldDescriptorBase & {
2733
+ /** The contained substring. */
2734
+ contains?: string;
2735
+ /** Default value. */
2736
+ default_value?: string[];
2737
+ /**
2738
+ * The exact string length.
2739
+ * @format int64
2740
+ */
2741
+ eq_len?: number;
2742
+ /**
2743
+ * The maximum string length.
2744
+ * @format int64
2745
+ */
2746
+ max_len?: number;
2747
+ /**
2748
+ * The minimum string length.
2749
+ * @format int64
2750
+ */
2751
+ min_len?: number;
2752
+ /** The string pattern (regular expression). */
2753
+ pattern?: string;
2754
+ /** The string prefix. */
2755
+ prefix?: string;
2756
+ /** The string suffix. */
2757
+ suffix?: string;
2758
+ };
2759
+ /** schema-uenum-field-descriptor */
2760
+ export type SchemaUenumFieldDescriptor = SchemaFieldDescriptorBase & {
2761
+ /** Allowed values for the field. */
2762
+ allowed_values: SchemaFieldUenumValue[];
2763
+ /**
2764
+ * Default value.
2765
+ * @format int64
2766
+ */
2767
+ default_value?: number;
2768
+ };
2769
+ /** schema-uenum-list-field-descriptor */
2770
+ export type SchemaUenumListFieldDescriptor = SchemaFieldDescriptorBase & {
2771
+ /** Allowed values for the field. */
2772
+ allowed_values: SchemaFieldUenumValue[];
2773
+ /** Default value. */
2774
+ default_value?: number[];
2775
+ };
2776
+ /** schema-unknown-field-descriptor */
2777
+ export type SchemaUnknownFieldDescriptor = SchemaFieldDescriptorBase;
2208
2778
  /** set-tag-with-value */
2209
2779
  export interface SetTagWithValue {
2210
2780
  /**
@@ -2268,6 +2838,8 @@ export type SlaTracker = AtomBase & {
2268
2838
  applies_to_id?: string;
2269
2839
  /** Summary of the metrics target being tracked in the SLA tracker. */
2270
2840
  metric_target_summaries: ArchetypeMetricTarget[];
2841
+ /** User, timestamp and metric Id of removed metrics. */
2842
+ removed_sla_metric_history?: RemovedSlaMetricHistory[];
2271
2843
  sla?: SlaSummary;
2272
2844
  /**
2273
2845
  * Details of the applicable SLA policy. Can be omitted if no sla
@@ -2341,11 +2913,41 @@ export interface StagedInfoFilter {
2341
2913
  /** Filters for issues that are staged. */
2342
2914
  is_staged?: boolean;
2343
2915
  }
2916
+ /** survey */
2917
+ export type Survey = AtomBase & {
2918
+ /** Description of the survey. */
2919
+ description?: string;
2920
+ /** Text posted when introducing the survey to the responder. */
2921
+ introductory_text?: string;
2922
+ /**
2923
+ * Survey name associated with schema. This name would be unique per
2924
+ * dev org.
2925
+ */
2926
+ name?: string;
2927
+ /** Text posted after the response is collected. */
2928
+ response_text?: string;
2929
+ /** List of all fields in the schema. */
2930
+ schema?: SchemaFieldDescriptor[];
2931
+ /** List of all the fields and their respective metadata in the schema. */
2932
+ schema_with_metadata?: SurveyFieldWithMetadata[];
2933
+ };
2344
2934
  /**
2345
2935
  * survey-aggregation-filter
2346
2936
  * The filter for survey aggregation.
2347
2937
  */
2348
2938
  export type SurveyAggregationFilter = object;
2939
+ /**
2940
+ * survey-field-with-metadata
2941
+ * Field descriptors with additional metadata for surveys.
2942
+ */
2943
+ export interface SurveyFieldWithMetadata {
2944
+ /** Set of field attributes. */
2945
+ field?: SchemaFieldDescriptor;
2946
+ /** Additional metadata for the input field. */
2947
+ metadata?: object;
2948
+ /** The question linked to the input field. */
2949
+ question?: string;
2950
+ }
2349
2951
  /** survey-response */
2350
2952
  export type SurveyResponse = AtomBase & {
2351
2953
  /** The unique ID associated with the dispatched survey. */
@@ -2366,6 +2968,8 @@ export type SurveyResponse = AtomBase & {
2366
2968
  };
2367
2969
  /** sync-metadata-filter */
2368
2970
  export interface SyncMetadataFilter {
2971
+ /** Filters for issues with this specific external reference. */
2972
+ external_reference?: string[];
2369
2973
  last_sync_in?: SyncMetadataFilterSyncInFilter;
2370
2974
  last_sync_out?: SyncMetadataFilterSyncOutFilter;
2371
2975
  /** Filters for issues synced from this specific origin system. */
@@ -2594,7 +3198,8 @@ export declare enum TicketChannels {
2594
3198
  Email = "email",
2595
3199
  Plug = "plug",
2596
3200
  Slack = "slack",
2597
- Twilio = "twilio"
3201
+ Twilio = "twilio",
3202
+ TwilioSms = "twilio_sms"
2598
3203
  }
2599
3204
  /** Severity of the ticket. */
2600
3205
  export declare enum TicketSeverity {
@@ -2603,6 +3208,12 @@ export declare enum TicketSeverity {
2603
3208
  Low = "low",
2604
3209
  Medium = "medium"
2605
3210
  }
3211
+ /** ticket-summary */
3212
+ export type TicketSummary = WorkBaseSummary & {
3213
+ rev_org?: OrgSummary;
3214
+ /** Severity of the ticket. */
3215
+ severity?: TicketSeverity;
3216
+ };
2606
3217
  /** timeline-comment */
2607
3218
  export type TimelineComment = TimelineEntryBase & {
2608
3219
  /** The artifacts for the comment. */
@@ -3014,9 +3625,14 @@ export interface WebhookEventRequest {
3014
3625
  dev_user_updated?: EventDevUserUpdated;
3015
3626
  group_created?: EventGroupCreated;
3016
3627
  group_deleted?: EventGroupDeleted;
3628
+ group_member_added?: EventGroupMemberAdded;
3629
+ group_member_removed?: EventGroupMemberRemoved;
3017
3630
  group_updated?: EventGroupUpdated;
3018
3631
  /** The event's ID. */
3019
3632
  id: string;
3633
+ link_created?: EventLinkCreated;
3634
+ link_deleted?: EventLinkDeleted;
3635
+ link_updated?: EventLinkUpdated;
3020
3636
  part_created?: EventPartCreated;
3021
3637
  part_deleted?: EventPartDeleted;
3022
3638
  part_updated?: EventPartUpdated;
@@ -3029,9 +3645,12 @@ export interface WebhookEventRequest {
3029
3645
  sla_tracker_created?: EventSlaTrackerCreated;
3030
3646
  sla_tracker_deleted?: EventSlaTrackerDeleted;
3031
3647
  sla_tracker_updated?: EventSlaTrackerUpdated;
3648
+ survey_created?: EventSurveyCreated;
3649
+ survey_deleted?: EventSurveyDeleted;
3032
3650
  survey_response_created?: EventSurveyResponseCreated;
3033
3651
  survey_response_deleted?: EventSurveyResponseDeleted;
3034
3652
  survey_response_updated?: EventSurveyResponseUpdated;
3653
+ survey_updated?: EventSurveyUpdated;
3035
3654
  tag_created?: EventTagCreated;
3036
3655
  tag_deleted?: EventTagDeleted;
3037
3656
  tag_updated?: EventTagUpdated;
@@ -3082,7 +3701,12 @@ export declare enum WebhookEventType {
3082
3701
  DevUserUpdated = "dev_user_updated",
3083
3702
  GroupCreated = "group_created",
3084
3703
  GroupDeleted = "group_deleted",
3704
+ GroupMemberAdded = "group_member_added",
3705
+ GroupMemberRemoved = "group_member_removed",
3085
3706
  GroupUpdated = "group_updated",
3707
+ LinkCreated = "link_created",
3708
+ LinkDeleted = "link_deleted",
3709
+ LinkUpdated = "link_updated",
3086
3710
  PartCreated = "part_created",
3087
3711
  PartDeleted = "part_deleted",
3088
3712
  PartUpdated = "part_updated",
@@ -3095,6 +3719,12 @@ export declare enum WebhookEventType {
3095
3719
  SlaTrackerCreated = "sla_tracker_created",
3096
3720
  SlaTrackerDeleted = "sla_tracker_deleted",
3097
3721
  SlaTrackerUpdated = "sla_tracker_updated",
3722
+ SurveyCreated = "survey_created",
3723
+ SurveyDeleted = "survey_deleted",
3724
+ SurveyResponseCreated = "survey_response_created",
3725
+ SurveyResponseDeleted = "survey_response_deleted",
3726
+ SurveyResponseUpdated = "survey_response_updated",
3727
+ SurveyUpdated = "survey_updated",
3098
3728
  TagCreated = "tag_created",
3099
3729
  TagDeleted = "tag_deleted",
3100
3730
  TagUpdated = "tag_updated",
@@ -3285,6 +3915,15 @@ export type WorkBase = AtomBase & {
3285
3915
  /** Title of the work object. */
3286
3916
  title: string;
3287
3917
  };
3918
+ /** work-base-summary */
3919
+ export type WorkBaseSummary = AtomBaseSummary & {
3920
+ /** The users that own the work. */
3921
+ owned_by: UserSummary[];
3922
+ /** Describes the current stage of a work item. */
3923
+ stage?: LegacyStageSummary;
3924
+ /** Title of the work object. */
3925
+ title: string;
3926
+ };
3288
3927
  export declare enum WorkType {
3289
3928
  Issue = "issue",
3290
3929
  Ticket = "ticket"
@@ -3709,6 +4348,11 @@ export interface WorksUpdateRequestTicket {
3709
4348
  * @example "REV-AbCdEfGh"
3710
4349
  */
3711
4350
  rev_org?: string | null;
4351
+ /**
4352
+ * The enum ID for the sentiment of the ticket.
4353
+ * @format int64
4354
+ */
4355
+ sentiment?: number;
3712
4356
  /** Severity of the ticket. */
3713
4357
  severity?: TicketSeverity;
3714
4358
  }
@@ -4899,6 +5543,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4899
5543
  'stage.name'?: string[];
4900
5544
  /** Filters for issues that are staged. */
4901
5545
  'staged_info.is_staged'?: boolean;
5546
+ /** Filters for issues with this specific external reference. */
5547
+ 'sync_metadata.external_reference'?: string[];
4902
5548
  /** Filters for works with selected sync statuses. */
4903
5549
  'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
4904
5550
  /** Filters for works modified with selected sync units. */
@@ -5036,6 +5682,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5036
5682
  'stage.name'?: string[];
5037
5683
  /** Filters for issues that are staged. */
5038
5684
  'staged_info.is_staged'?: boolean;
5685
+ /** Filters for issues with this specific external reference. */
5686
+ 'sync_metadata.external_reference'?: string[];
5039
5687
  /** Filters for works with selected sync statuses. */
5040
5688
  'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
5041
5689
  /** Filters for works modified with selected sync units. */