@devrev/typescript-sdk 1.1.16 → 1.1.18

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.
@@ -46,7 +46,7 @@ export type AccountSummary = OrgBaseSummary;
46
46
  export interface AccountsCreateRequest {
47
47
  /**
48
48
  * The IDs of the artifacts to associate with the account.
49
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
49
+ * @example ["ARTIFACT-12345"]
50
50
  */
51
51
  artifacts?: string[];
52
52
  /** Application-defined custom fields. */
@@ -89,7 +89,7 @@ export interface AccountsCreateResponse {
89
89
  export interface AccountsDeleteRequest {
90
90
  /**
91
91
  * The ID of account to delete.
92
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
92
+ * @example "ACC-12345"
93
93
  */
94
94
  id: string;
95
95
  }
@@ -106,6 +106,8 @@ export interface AccountsExportRequest {
106
106
  /** Filters for accounts created by the specified user(s). */
107
107
  created_by?: string[];
108
108
  created_date?: DateTimeFilter;
109
+ /** Filters for custom fields. */
110
+ custom_fields?: object;
109
111
  /** Domains for accounts to be filtered. */
110
112
  domains?: string[];
111
113
  /** Array of references of accounts to be filtered. */
@@ -142,7 +144,7 @@ export interface AccountsExportResponse {
142
144
  export interface AccountsGetRequest {
143
145
  /**
144
146
  * The ID of the account to be retrieved.
145
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
147
+ * @example "ACC-12345"
146
148
  */
147
149
  id: string;
148
150
  }
@@ -166,6 +168,8 @@ export interface AccountsListRequest {
166
168
  * iteration starts from the beginning.
167
169
  */
168
170
  cursor?: string;
171
+ /** Filters for custom fields. */
172
+ custom_fields?: object;
169
173
  /** Domains for accounts to be filtered. */
170
174
  domains?: string[];
171
175
  /** Array of references of accounts to be filtered. */
@@ -233,7 +237,7 @@ export interface AccountsUpdateRequest {
233
237
  external_refs?: string[];
234
238
  /**
235
239
  * The ID of account to update.
236
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
240
+ * @example "ACC-12345"
237
241
  */
238
242
  id: string;
239
243
  /** Updated list of the users owning this account. */
@@ -252,7 +256,7 @@ export interface AccountsUpdateRequest {
252
256
  export interface AccountsUpdateRequestArtifacts {
253
257
  /**
254
258
  * Sets the IDs to the provided artifact IDs.
255
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
259
+ * @example ["ARTIFACT-12345"]
256
260
  */
257
261
  set?: string[];
258
262
  }
@@ -282,6 +286,72 @@ export interface AggregatedSchemaGetResponse {
282
286
  /** List of custom fields from multiple source fragments. */
283
287
  schema: AggregatedSchema;
284
288
  }
289
+ /**
290
+ * aggregation-detail
291
+ * Stores aggregation type and dimension information.
292
+ */
293
+ export interface AggregationDetail {
294
+ /**
295
+ * Aggregation type to be used while aggregating the metering data for the
296
+ * UOM. 1] Sum - sum of all the values for the meter in a given period Ex.
297
+ * { M1:2, M1:4 } => {M1:6} 2] Minimum - min of all the values for the
298
+ * meter in a given period Ex. { M1:2, M1:4 } => {M1:2} 3] Maximum - max
299
+ * of all the values for the meter in a given period Ex. { M1:2, M1:4 } =>
300
+ * {M1:4} 4] Unique Count - Sum of distinct unique dimension observed for
301
+ * the meter in the given period (not considering the data from the
302
+ * previous billing period) Ex. January {M1:{VM:VM0}}, February
303
+ * {M1:{VM:VM1}, M1:{VM:VM2}, M1:{VM:VM1}} => {M1:2} 5] Running Total -
304
+ * Sum of distinct active unique dimension observed for a meter in the
305
+ * given period, taking into consideration the active data from the
306
+ * previous billing cycle Ex. January {M1:{VM:VM0,on}, {M1:{VM:VM1,off}
307
+ * February {M1:{VM:VM2, on}, M1:{VM:VM2, off}, M1:{VM:VM3, on}} => {M1:3}
308
+ * 6] Duration - Sum of distinct active unique dimension duration for a
309
+ * meter in the given period, taking into consideration the active data
310
+ * from the previous month Ex. January15 {M1:{VM:VM0,on, 4}} February15
311
+ * {M1:{VM:VM0,off}, February18 {M1:{VM:VM1,on,5} => M1->
312
+ * 30*4*charge_per_day + 10*5*charge_per_day 7] Latest - consider the
313
+ * latest/last meter in the given period 8] Oldest - consider the
314
+ * oldest/first record in the given period.
315
+ */
316
+ aggregation_type: AggregationDetailAggregationType;
317
+ /**
318
+ * Unique dimension if provided to be considered for grouping metering
319
+ * data for the UOM.
320
+ */
321
+ unique_dimension?: string;
322
+ }
323
+ /**
324
+ * Aggregation type to be used while aggregating the metering data for the
325
+ * UOM. 1] Sum - sum of all the values for the meter in a given period Ex.
326
+ * { M1:2, M1:4 } => {M1:6} 2] Minimum - min of all the values for the
327
+ * meter in a given period Ex. { M1:2, M1:4 } => {M1:2} 3] Maximum - max
328
+ * of all the values for the meter in a given period Ex. { M1:2, M1:4 } =>
329
+ * {M1:4} 4] Unique Count - Sum of distinct unique dimension observed for
330
+ * the meter in the given period (not considering the data from the
331
+ * previous billing period) Ex. January {M1:{VM:VM0}}, February
332
+ * {M1:{VM:VM1}, M1:{VM:VM2}, M1:{VM:VM1}} => {M1:2} 5] Running Total -
333
+ * Sum of distinct active unique dimension observed for a meter in the
334
+ * given period, taking into consideration the active data from the
335
+ * previous billing cycle Ex. January {M1:{VM:VM0,on}, {M1:{VM:VM1,off}
336
+ * February {M1:{VM:VM2, on}, M1:{VM:VM2, off}, M1:{VM:VM3, on}} => {M1:3}
337
+ * 6] Duration - Sum of distinct active unique dimension duration for a
338
+ * meter in the given period, taking into consideration the active data
339
+ * from the previous month Ex. January15 {M1:{VM:VM0,on, 4}} February15
340
+ * {M1:{VM:VM0,off}, February18 {M1:{VM:VM1,on,5} => M1->
341
+ * 30*4*charge_per_day + 10*5*charge_per_day 7] Latest - consider the
342
+ * latest/last meter in the given period 8] Oldest - consider the
343
+ * oldest/first record in the given period.
344
+ */
345
+ export declare enum AggregationDetailAggregationType {
346
+ Duration = "duration",
347
+ Latest = "latest",
348
+ Maximum = "maximum",
349
+ Minimum = "minimum",
350
+ Oldest = "oldest",
351
+ RunningTotal = "running_total",
352
+ Sum = "sum",
353
+ UniqueCount = "unique_count"
354
+ }
285
355
  /** app-fragment */
286
356
  export type AppFragment = CustomSchemaFragmentBase;
287
357
  /** article */
@@ -308,22 +378,22 @@ export declare enum ArticleStatus {
308
378
  export interface ArticlesCountRequest {
309
379
  /**
310
380
  * Filters for articles belonging to any of the provided parts.
311
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
381
+ * @example ["PROD-12345"]
312
382
  */
313
383
  applies_to_parts?: string[];
314
384
  /**
315
385
  * Filters for articles authored by any of the provided users.
316
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
386
+ * @example ["DEVU-12345"]
317
387
  */
318
388
  authored_by?: string[];
319
389
  /**
320
390
  * Filters for articles created by any of the provided users.
321
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
391
+ * @example ["DEVU-12345"]
322
392
  */
323
393
  created_by?: string[];
324
394
  /**
325
395
  * Filters for articles owned by any of the provided users.
326
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
396
+ * @example ["DEVU-12345"]
327
397
  */
328
398
  owned_by?: string[];
329
399
  }
@@ -344,31 +414,32 @@ export interface ArticlesCreateRequest {
344
414
  /**
345
415
  * The parts that the article applies to.
346
416
  * @minItems 1
347
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
417
+ * @example ["PROD-12345"]
348
418
  */
349
419
  applies_to_parts: string[];
350
420
  /**
351
421
  * The authors of the article.
352
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
422
+ * @example ["DEVU-12345"]
353
423
  */
354
424
  authored_by?: string[];
355
425
  /** Description for the article. */
356
426
  description?: string;
357
427
  /**
358
428
  * ID of the extracted content artifact.
359
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
429
+ * @example ["ARTIFACT-12345"]
360
430
  */
361
431
  extracted_content?: string[];
362
432
  /** Language of the article. */
363
433
  language?: string;
364
434
  /**
365
435
  * The users that own the article.
366
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
436
+ * @example ["DEVU-12345"]
367
437
  */
368
- owned_by?: string[];
438
+ owned_by: string[];
369
439
  /**
370
440
  * The published date of the article.
371
441
  * @format date-time
442
+ * @example "2023-01-01T12:00:00.000Z"
372
443
  */
373
444
  published_at?: string;
374
445
  resource: ArticlesCreateRequestResource;
@@ -383,9 +454,11 @@ export interface ArticlesCreateRequest {
383
454
  export interface ArticlesCreateRequestResource {
384
455
  /**
385
456
  * IDs of the artifacts.
386
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
457
+ * @example ["ARTIFACT-12345"]
387
458
  */
388
459
  artifacts?: string[];
460
+ /** The latest published version. */
461
+ published_version?: string;
389
462
  /** URL of the external article. */
390
463
  url?: string;
391
464
  }
@@ -403,7 +476,7 @@ export interface ArticlesCreateResponse {
403
476
  export interface ArticlesDeleteRequest {
404
477
  /**
405
478
  * The ID of the article to delete.
406
- * @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
479
+ * @example "ARTICLE-12345"
407
480
  */
408
481
  id: string;
409
482
  }
@@ -416,7 +489,7 @@ export type ArticlesDeleteResponse = object;
416
489
  export interface ArticlesGetRequest {
417
490
  /**
418
491
  * The ID of the required article.
419
- * @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
492
+ * @example "ARTICLE-12345"
420
493
  */
421
494
  id: string;
422
495
  }
@@ -434,17 +507,17 @@ export interface ArticlesGetResponse {
434
507
  export interface ArticlesListRequest {
435
508
  /**
436
509
  * Filters for articles belonging to any of the provided parts.
437
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
510
+ * @example ["PROD-12345"]
438
511
  */
439
512
  applies_to_parts?: string[];
440
513
  /**
441
514
  * Filters for articles authored by any of the provided users.
442
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
515
+ * @example ["DEVU-12345"]
443
516
  */
444
517
  authored_by?: string[];
445
518
  /**
446
519
  * Filters for articles created by any of the provided users.
447
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
520
+ * @example ["DEVU-12345"]
448
521
  */
449
522
  created_by?: string[];
450
523
  /**
@@ -467,7 +540,7 @@ export interface ArticlesListRequest {
467
540
  mode?: ListMode;
468
541
  /**
469
542
  * Filters for articles owned by any of the provided users.
470
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
543
+ * @example ["DEVU-12345"]
471
544
  */
472
545
  owned_by?: string[];
473
546
  }
@@ -511,12 +584,14 @@ export interface ArticlesUpdateRequest {
511
584
  extracted_content?: ArticlesUpdateRequestExtractedContent;
512
585
  /**
513
586
  * The article's ID.
514
- * @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
587
+ * @example "ARTICLE-12345"
515
588
  */
516
589
  id: string;
517
590
  /** Updates the language of the article. */
518
591
  language?: string;
519
592
  owned_by?: ArticlesUpdateRequestOwnedBy;
593
+ /** Updates the the latest published version. */
594
+ published_version?: string;
520
595
  /** Status of the article. */
521
596
  status?: ArticleStatus;
522
597
  tags?: ArticlesUpdateRequestTags;
@@ -529,7 +604,7 @@ export interface ArticlesUpdateRequest {
529
604
  export interface ArticlesUpdateRequestAppliesToParts {
530
605
  /**
531
606
  * Updates the parts that the article applies to.
532
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
607
+ * @example ["PROD-12345"]
533
608
  */
534
609
  set?: string[];
535
610
  }
@@ -537,7 +612,7 @@ export interface ArticlesUpdateRequestAppliesToParts {
537
612
  export interface ArticlesUpdateRequestArtifacts {
538
613
  /**
539
614
  * Updates IDs of the artifacts.
540
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
615
+ * @example ["ARTIFACT-12345"]
541
616
  */
542
617
  set?: string[];
543
618
  }
@@ -545,7 +620,7 @@ export interface ArticlesUpdateRequestArtifacts {
545
620
  export interface ArticlesUpdateRequestAuthoredBy {
546
621
  /**
547
622
  * Sets the users that authored the article.
548
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
623
+ * @example ["DEVU-12345"]
549
624
  */
550
625
  set?: string[];
551
626
  }
@@ -553,7 +628,7 @@ export interface ArticlesUpdateRequestAuthoredBy {
553
628
  export interface ArticlesUpdateRequestExtractedContent {
554
629
  /**
555
630
  * Update the ID of the extracted content.
556
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
631
+ * @example ["ARTIFACT-12345"]
557
632
  */
558
633
  set?: string[];
559
634
  }
@@ -562,7 +637,7 @@ export interface ArticlesUpdateRequestOwnedBy {
562
637
  /**
563
638
  * Sets the owner IDs to the provided user IDs. This must not be
564
639
  * empty.
565
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
640
+ * @example ["DEVU-12345"]
566
641
  */
567
642
  set?: string[];
568
643
  }
@@ -596,7 +671,7 @@ export interface ArtifactsPrepareResponse {
596
671
  form_data: ArtifactsPrepareResponseFormData[];
597
672
  /**
598
673
  * The generated artifact's ID.
599
- * @example "don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"
674
+ * @example "ARTIFACT-12345"
600
675
  */
601
676
  id: string;
602
677
  /** The URL that the file's data should be uploaded to. */
@@ -616,7 +691,7 @@ export interface ArtifactsPrepareResponseFormData {
616
691
  export interface ArtifactsVersionsPrepareRequest {
617
692
  /**
618
693
  * The ID of the artifact to prepare a new version for.
619
- * @example "don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"
694
+ * @example "ARTIFACT-12345"
620
695
  */
621
696
  id: string;
622
697
  }
@@ -643,6 +718,7 @@ export interface AtomBase {
643
718
  /**
644
719
  * Timestamp when the object was created.
645
720
  * @format date-time
721
+ * @example "2023-01-01T12:00:00.000Z"
646
722
  */
647
723
  created_date?: string;
648
724
  /** Human-readable object ID unique to the Dev organization. */
@@ -653,6 +729,7 @@ export interface AtomBase {
653
729
  /**
654
730
  * Timestamp when the object was last modified.
655
731
  * @format date-time
732
+ * @example "2023-01-01T12:00:00.000Z"
656
733
  */
657
734
  modified_date?: string;
658
735
  }
@@ -681,7 +758,9 @@ export type Conversation = AtomBase & {
681
758
  /** Owner IDs for the conversation. */
682
759
  owned_by?: UserSummary[];
683
760
  /** Describes the current stage of a work item. */
684
- stage?: Stage;
761
+ stage?: LegacyStage;
762
+ /** Tags associated with the object. */
763
+ tags?: TagWithValue[];
685
764
  /** Title of the conversation object. */
686
765
  title?: string;
687
766
  };
@@ -714,7 +793,7 @@ export interface ConversationsCreateRequest {
714
793
  is_spam?: boolean;
715
794
  /**
716
795
  * The users in the conversation.
717
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
796
+ * @example ["DEVU-12345"]
718
797
  */
719
798
  members?: string[];
720
799
  /** Initial messages on the conversation. */
@@ -736,7 +815,7 @@ export interface ConversationsCreateRequest {
736
815
  export interface ConversationsCreateRequestMessage {
737
816
  /**
738
817
  * The IDs of the artifacts to the message.
739
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
818
+ * @example ["ARTIFACT-12345"]
740
819
  */
741
820
  artifacts?: string[];
742
821
  /** The message's body. */
@@ -773,7 +852,7 @@ export type ConversationsDeleteResponse = object;
773
852
  export interface ConversationsExportRequest {
774
853
  /**
775
854
  * Filters for conversations belonging to any of the provided parts.
776
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
855
+ * @example ["PROD-12345"]
777
856
  */
778
857
  applies_to_parts?: string[];
779
858
  /**
@@ -790,18 +869,18 @@ export interface ConversationsExportRequest {
790
869
  is_spam?: boolean;
791
870
  /**
792
871
  * Filters for conversations where these users are participants.
793
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
872
+ * @example ["DEVU-12345"]
794
873
  */
795
874
  members?: string[];
796
875
  /**
797
876
  * Filters for conversations owned by any of these users.
798
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
877
+ * @example ["DEVU-12345"]
799
878
  */
800
879
  owned_by?: string[];
801
880
  /**
802
881
  * Filters for conversations that are associated with any of the
803
882
  * provided Rev organizations.
804
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
883
+ * @example ["REV-AbCdEfGh"]
805
884
  */
806
885
  rev_org?: string[];
807
886
  /** The filter for SLA summary. */
@@ -813,7 +892,7 @@ export interface ConversationsExportRequest {
813
892
  /**
814
893
  * Filters for conversations with any of the provided tags.
815
894
  * @deprecated
816
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
895
+ * @example ["TAG-12345"]
817
896
  */
818
897
  tags?: string[];
819
898
  /** Filters for conversations with any of the provided tags with value. */
@@ -846,7 +925,7 @@ export interface ConversationsGetResponse {
846
925
  export interface ConversationsListRequest {
847
926
  /**
848
927
  * Filters for conversations belonging to any of the provided parts.
849
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
928
+ * @example ["PROD-12345"]
850
929
  */
851
930
  applies_to_parts?: string[];
852
931
  /**
@@ -867,7 +946,7 @@ export interface ConversationsListRequest {
867
946
  limit?: number;
868
947
  /**
869
948
  * Filters for conversations where these users are participants.
870
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
949
+ * @example ["DEVU-12345"]
871
950
  */
872
951
  members?: string[];
873
952
  /**
@@ -880,13 +959,13 @@ export interface ConversationsListRequest {
880
959
  mode?: ListMode;
881
960
  /**
882
961
  * Filters for conversations owned by any of these users.
883
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
962
+ * @example ["DEVU-12345"]
884
963
  */
885
964
  owned_by?: string[];
886
965
  /**
887
966
  * Filters for conversations that are associated with any of the
888
967
  * provided Rev organizations.
889
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
968
+ * @example ["REV-AbCdEfGh"]
890
969
  */
891
970
  rev_org?: string[];
892
971
  /** The filter for SLA summary. */
@@ -898,7 +977,7 @@ export interface ConversationsListRequest {
898
977
  /**
899
978
  * Filters for conversations with any of the provided tags.
900
979
  * @deprecated
901
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
980
+ * @example ["TAG-12345"]
902
981
  */
903
982
  tags?: string[];
904
983
  /** Filters for conversations with any of the provided tags with value. */
@@ -950,7 +1029,7 @@ export interface ConversationsUpdateRequest {
950
1029
  export interface ConversationsUpdateRequestAppliesToParts {
951
1030
  /**
952
1031
  * Updates the parts that the conversation applies to.
953
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
1032
+ * @example ["PROD-12345"]
954
1033
  */
955
1034
  set?: string[];
956
1035
  }
@@ -980,6 +1059,7 @@ export interface CreateOrgScheduleInterval {
980
1059
  /**
981
1060
  * Date (inclusive) on which the interval begins.
982
1061
  * @format date-time
1062
+ * @example "2023-01-01T12:00:00.000Z"
983
1063
  */
984
1064
  from: string;
985
1065
  /**
@@ -996,6 +1076,7 @@ export interface CreateOrgScheduleInterval {
996
1076
  * Date (exclusive) on which the interval ends. If omitted, it is a
997
1077
  * single day interval.
998
1078
  * @format date-time
1079
+ * @example "2023-01-01T12:00:00.000Z"
999
1080
  */
1000
1081
  to?: string;
1001
1082
  }
@@ -1049,6 +1130,8 @@ export interface CustomSchemaFragmentsListRequest {
1049
1130
  * then iteration starts from the beginning.
1050
1131
  */
1051
1132
  cursor?: string;
1133
+ /** Whether only deprecated fragments should be filtered. */
1134
+ deprecated?: boolean;
1052
1135
  /** The list of leaf types. */
1053
1136
  leaf_type?: string[];
1054
1137
  /**
@@ -1148,12 +1231,14 @@ export interface DateTimeFilter {
1148
1231
  * Filters for objects created after the provided timestamp
1149
1232
  * (inclusive).
1150
1233
  * @format date-time
1234
+ * @example "2023-01-01T12:00:00.000Z"
1151
1235
  */
1152
1236
  after?: string;
1153
1237
  /**
1154
1238
  * Filters for objects created before the provided timestamp
1155
1239
  * (inclusive).
1156
1240
  * @format date-time
1241
+ * @example "2023-01-01T12:00:00.000Z"
1157
1242
  */
1158
1243
  before?: string;
1159
1244
  }
@@ -1215,12 +1300,12 @@ export interface EngagementsCountRequest {
1215
1300
  external_ref?: string[];
1216
1301
  /**
1217
1302
  * Filters for engagement of the provided members.
1218
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
1303
+ * @example ["DEVU-12345"]
1219
1304
  */
1220
1305
  members?: string[];
1221
1306
  /**
1222
1307
  * Filters for engagements with the provided parent.
1223
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
1308
+ * @example ["ACC-12345"]
1224
1309
  */
1225
1310
  parent?: string[];
1226
1311
  /** Filters for engagement of the provided types. */
@@ -1238,7 +1323,7 @@ export interface EngagementsCountResponse {
1238
1323
  export interface EngagementsCreateRequest {
1239
1324
  /**
1240
1325
  * The IDs of the artifacts to associate with the engagement.
1241
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
1326
+ * @example ["ARTIFACT-12345"]
1242
1327
  */
1243
1328
  artifacts?: string[];
1244
1329
  /** The description of the engagement. */
@@ -1252,18 +1337,19 @@ export interface EngagementsCreateRequest {
1252
1337
  /**
1253
1338
  * IDs of the users that were part of the engagement.
1254
1339
  * @maxItems 50
1255
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
1340
+ * @example ["DEVU-12345"]
1256
1341
  */
1257
1342
  members?: string[];
1258
1343
  /**
1259
1344
  * The parent object ID in which the engagement was created.
1260
1345
  * Currently, only accounts and opportunities are supported.
1261
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
1346
+ * @example "ACC-12345"
1262
1347
  */
1263
1348
  parent: string;
1264
1349
  /**
1265
1350
  * The date and time when the engagement was scheduled.
1266
1351
  * @format date-time
1352
+ * @example "2023-01-01T12:00:00.000Z"
1267
1353
  */
1268
1354
  scheduled_date?: string;
1269
1355
  /** Tags associated with the engagement. */
@@ -1315,7 +1401,7 @@ export interface EngagementsListRequest {
1315
1401
  limit?: number;
1316
1402
  /**
1317
1403
  * Filters for engagement of the provided members.
1318
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
1404
+ * @example ["DEVU-12345"]
1319
1405
  */
1320
1406
  members?: string[];
1321
1407
  /**
@@ -1328,7 +1414,7 @@ export interface EngagementsListRequest {
1328
1414
  mode?: ListMode;
1329
1415
  /**
1330
1416
  * Filters for engagements with the provided parent.
1331
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
1417
+ * @example ["ACC-12345"]
1332
1418
  */
1333
1419
  parent?: string[];
1334
1420
  /** Fields to sort the engagements by and the direction to sort them. */
@@ -1366,6 +1452,7 @@ export interface EngagementsUpdateRequest {
1366
1452
  /**
1367
1453
  * Updates the date and time when the engagement was scheduled.
1368
1454
  * @format date-time
1455
+ * @example "2023-01-01T12:00:00.000Z"
1369
1456
  */
1370
1457
  scheduled_date?: string | null;
1371
1458
  tags?: EngagementsUpdateRequestTags;
@@ -1376,7 +1463,7 @@ export interface EngagementsUpdateRequest {
1376
1463
  export interface EngagementsUpdateRequestArtifactIds {
1377
1464
  /**
1378
1465
  * Sets the IDs to the provided artifact IDs.
1379
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
1466
+ * @example ["ARTIFACT-12345"]
1380
1467
  */
1381
1468
  set?: string[];
1382
1469
  }
@@ -1386,7 +1473,7 @@ export interface EngagementsUpdateRequestMembers {
1386
1473
  * Sets the members to the provided user IDs. If specified, this must
1387
1474
  * not be empty.
1388
1475
  * @maxItems 50
1389
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
1476
+ * @example ["DEVU-12345"]
1390
1477
  */
1391
1478
  set?: string[];
1392
1479
  }
@@ -1400,13 +1487,7 @@ export interface EngagementsUpdateResponse {
1400
1487
  engagement: Engagement;
1401
1488
  }
1402
1489
  /** enhancement */
1403
- export type Enhancement = PartBase & {
1404
- /**
1405
- * Timestamp when the enhancement is expected to be closed.
1406
- * @format date-time
1407
- */
1408
- target_close_date?: string;
1409
- };
1490
+ export type Enhancement = PartBase;
1410
1491
  /** enhancement-summary */
1411
1492
  export type EnhancementSummary = PartBaseSummary;
1412
1493
  /** error */
@@ -1422,7 +1503,7 @@ export interface Error {
1422
1503
  type?: string;
1423
1504
  }
1424
1505
  /** error-bad-request */
1425
- export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestValueNotPermitted) & {
1506
+ export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestValueNotPermitted) & {
1426
1507
  type: ErrorBadRequestType;
1427
1508
  };
1428
1509
  /** error-bad-request-bad-request */
@@ -1441,6 +1522,17 @@ export interface ErrorBadRequestInvalidField {
1441
1522
  /** The field name that's invalid. */
1442
1523
  field_name: string;
1443
1524
  }
1525
+ /** error-bad-request-missing-dependency */
1526
+ export interface ErrorBadRequestMissingDependency {
1527
+ /** The field on which the value depends. */
1528
+ dependent_field_name?: string;
1529
+ /** The value which needs to be set of the dependent field. */
1530
+ dependent_field_value?: string;
1531
+ /** The field whose value was received. */
1532
+ provided_field_name?: string;
1533
+ /** The value that was received. */
1534
+ provided_field_value?: string;
1535
+ }
1444
1536
  /** error-bad-request-missing-required-field */
1445
1537
  export interface ErrorBadRequestMissingRequiredField {
1446
1538
  /** The missing field's name. */
@@ -1452,6 +1544,7 @@ export declare enum ErrorBadRequestType {
1452
1544
  BadRequest = "bad_request",
1453
1545
  InvalidEnumValue = "invalid_enum_value",
1454
1546
  InvalidField = "invalid_field",
1547
+ MissingDependency = "missing_dependency",
1455
1548
  MissingRequiredField = "missing_required_field",
1456
1549
  ParseError = "parse_error",
1457
1550
  ValueNotPermitted = "value_not_permitted"
@@ -1555,7 +1648,7 @@ export interface EventPartCreated {
1555
1648
  export interface EventPartDeleted {
1556
1649
  /**
1557
1650
  * The ID of the part that was deleted.
1558
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
1651
+ * @example "PROD-12345"
1559
1652
  */
1560
1653
  id: string;
1561
1654
  }
@@ -1571,7 +1664,7 @@ export interface EventRevOrgCreated {
1571
1664
  export interface EventRevOrgDeleted {
1572
1665
  /**
1573
1666
  * The ID of the Rev organization that was deleted.
1574
- * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
1667
+ * @example "REV-AbCdEfGh"
1575
1668
  */
1576
1669
  id: string;
1577
1670
  }
@@ -1592,6 +1685,19 @@ export interface EventRevUserDeleted {
1592
1685
  export interface EventRevUserUpdated {
1593
1686
  rev_user: RevUser;
1594
1687
  }
1688
+ /** event-sla-tracker-created */
1689
+ export interface EventSlaTrackerCreated {
1690
+ sla_tracker: SlaTracker;
1691
+ }
1692
+ /** event-sla-tracker-deleted */
1693
+ export interface EventSlaTrackerDeleted {
1694
+ /** The ID of the SLA tracker that was deleted. */
1695
+ id: string;
1696
+ }
1697
+ /** event-sla-tracker-updated */
1698
+ export interface EventSlaTrackerUpdated {
1699
+ sla_tracker: SlaTracker;
1700
+ }
1595
1701
  /** event-source */
1596
1702
  export type EventSource = AtomBase & {
1597
1703
  /**
@@ -1668,6 +1774,7 @@ export interface EventSourcesScheduleEventRequest {
1668
1774
  * guaranteed to be published after this. If omitted, the event is
1669
1775
  * published immediately.
1670
1776
  * @format date-time
1777
+ * @example "2023-01-01T12:00:00.000Z"
1671
1778
  */
1672
1779
  publish_at?: string;
1673
1780
  /**
@@ -1694,7 +1801,7 @@ export interface EventTagCreated {
1694
1801
  export interface EventTagDeleted {
1695
1802
  /**
1696
1803
  * The ID of the tag that was deleted.
1697
- * @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
1804
+ * @example "TAG-12345"
1698
1805
  */
1699
1806
  id: string;
1700
1807
  }
@@ -1742,7 +1849,7 @@ export interface EventWorkCreated {
1742
1849
  export interface EventWorkDeleted {
1743
1850
  /**
1744
1851
  * The ID of the work that was deleted.
1745
- * @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
1852
+ * @example "ISS-12345"
1746
1853
  */
1747
1854
  id: string;
1748
1855
  }
@@ -1901,6 +2008,14 @@ export type IssueSummary = WorkBaseSummary & {
1901
2008
  /** Priority of the work based upon impact and criticality. */
1902
2009
  priority?: IssuePriority;
1903
2010
  };
2011
+ /**
2012
+ * legacy-stage
2013
+ * Describes the current stage of a work item.
2014
+ */
2015
+ export interface LegacyStage {
2016
+ /** Current stage name of the work item. */
2017
+ name: string;
2018
+ }
1904
2019
  /** link */
1905
2020
  export type Link = AtomBase & {
1906
2021
  /** Type of link used to define the relationship. */
@@ -1930,7 +2045,7 @@ export declare enum LinkEndpointType {
1930
2045
  export interface LinkRevUserToRevOrgRequest {
1931
2046
  /**
1932
2047
  * The don of the rev org to link the rev user to.
1933
- * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
2048
+ * @example "REV-AbCdEfGh"
1934
2049
  */
1935
2050
  rev_org_don: string;
1936
2051
  /** The don of the rev user to link. */
@@ -2090,9 +2205,17 @@ export interface MetricDataPoint {
2090
2205
  * @maxItems 10
2091
2206
  */
2092
2207
  dimensions?: MetricDataPointDimension[];
2208
+ /**
2209
+ * An ID that uniquely identifies the metric data point. This ID will
2210
+ * be used for deduplication. Clients can generate its own ID and send
2211
+ * it in the request. If not provided, DevRev will perform
2212
+ * content-based deduplication.
2213
+ */
2214
+ id?: string;
2093
2215
  /**
2094
2216
  * Timestamp when metric value is captured.
2095
2217
  * @format date-time
2218
+ * @example "2023-01-01T12:00:00.000Z"
2096
2219
  */
2097
2220
  timestamp: string;
2098
2221
  /**
@@ -2201,7 +2324,7 @@ export interface MetricsData {
2201
2324
  * external_ref=org_customer_1 may resolve to
2202
2325
  * don:identity:dvrv-us-1:devo/0:revo/155.
2203
2326
  */
2204
- org_ref?: string;
2327
+ org_ref: string;
2205
2328
  /** Rev User ID or user ref for which metric is being published. */
2206
2329
  user_ref?: string;
2207
2330
  }
@@ -2287,6 +2410,7 @@ export type OrgSchedule = AtomBase & {
2287
2410
  * for all its schedule fragments, and if it has a schedule fragment
2288
2411
  * for the time period in question.
2289
2412
  * @format date-time
2413
+ * @example "2023-01-01T12:00:00.000Z"
2290
2414
  */
2291
2415
  valid_until?: string;
2292
2416
  /**
@@ -2302,6 +2426,7 @@ export type OrgScheduleFragment = AtomBase & {
2302
2426
  * The date (inclusive) on which the organization schedule fragment
2303
2427
  * begins.
2304
2428
  * @format date-time
2429
+ * @example "2023-01-01T12:00:00.000Z"
2305
2430
  */
2306
2431
  from?: string;
2307
2432
  /**
@@ -2327,6 +2452,7 @@ export type OrgScheduleFragment = AtomBase & {
2327
2452
  * The date (exclusive) on which the organization schedule fragment's
2328
2453
  * validity ends.
2329
2454
  * @format date-time
2455
+ * @example "2023-01-01T12:00:00.000Z"
2330
2456
  */
2331
2457
  to?: string;
2332
2458
  };
@@ -2353,6 +2479,7 @@ export interface OrgScheduleFragmentsCreateRequest {
2353
2479
  * Date (inclusive) on which the organization schedule fragment
2354
2480
  * begins.
2355
2481
  * @format date-time
2482
+ * @example "2023-01-01T12:00:00.000Z"
2356
2483
  */
2357
2484
  from: string;
2358
2485
  /** The intervals that comprise the schedule fragment. */
@@ -2369,6 +2496,7 @@ export interface OrgScheduleFragmentsCreateRequest {
2369
2496
  * Date (exclusive) on which the organization schedule fragment's
2370
2497
  * validity ends.
2371
2498
  * @format date-time
2499
+ * @example "2023-01-01T12:00:00.000Z"
2372
2500
  */
2373
2501
  to: string;
2374
2502
  }
@@ -2563,6 +2691,24 @@ export declare enum OrgType {
2563
2691
  Account = "account",
2564
2692
  RevOrg = "rev_org"
2565
2693
  }
2694
+ /**
2695
+ * parent-part-filter
2696
+ * The filter for specifying parent part.
2697
+ */
2698
+ export interface ParentPartFilter {
2699
+ /**
2700
+ * Number of levels to fetch the part hierarchy up to.
2701
+ * @format int32
2702
+ * @min 1
2703
+ */
2704
+ level?: number;
2705
+ /**
2706
+ * Part IDs to fetch the hierarchy for.
2707
+ * @minItems 1
2708
+ * @example ["PROD-12345"]
2709
+ */
2710
+ parts: string[];
2711
+ }
2566
2712
  /** part */
2567
2713
  export type Part = (Capability | Enhancement | Feature | Product) & {
2568
2714
  type: PartType;
@@ -2611,7 +2757,7 @@ export declare enum PartType {
2611
2757
  export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequestEnhancement | PartsCreateRequestFeature | PartsCreateRequestProduct) & {
2612
2758
  /**
2613
2759
  * The IDs of the artifacts.
2614
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
2760
+ * @example ["ARTIFACT-12345"]
2615
2761
  */
2616
2762
  artifacts?: string[];
2617
2763
  /** Custom fields. */
@@ -2627,7 +2773,7 @@ export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequ
2627
2773
  name: string;
2628
2774
  /**
2629
2775
  * The users that own the part.
2630
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
2776
+ * @example ["DEVU-12345"]
2631
2777
  */
2632
2778
  owned_by: string[];
2633
2779
  type: PartType;
@@ -2637,7 +2783,7 @@ export interface PartsCreateRequestCapability {
2637
2783
  /**
2638
2784
  * ID of the parent product for the capability.
2639
2785
  * @maxItems 1
2640
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
2786
+ * @example ["PROD-12345"]
2641
2787
  */
2642
2788
  parent_part: string[];
2643
2789
  }
@@ -2646,21 +2792,29 @@ export interface PartsCreateRequestEnhancement {
2646
2792
  /**
2647
2793
  * ID of the parent part on which the enhancement is to be created.
2648
2794
  * @maxItems 1
2649
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
2795
+ * @example ["PROD-12345"]
2650
2796
  */
2651
2797
  parent_part: string[];
2652
2798
  /**
2653
2799
  * Target close date by which enhancement is expected to be closed.
2654
2800
  * @format date-time
2801
+ * @example "2023-01-01T12:00:00.000Z"
2655
2802
  */
2656
2803
  target_close_date?: string;
2804
+ /**
2805
+ * Target start date by which enhancement is expected to be started.
2806
+ * Example Date Format: 2000-11-01T01:01:01Z
2807
+ * @format date-time
2808
+ * @example "2023-01-01T12:00:00.000Z"
2809
+ */
2810
+ target_start_date?: string;
2657
2811
  }
2658
2812
  /** parts-create-request-feature */
2659
2813
  export interface PartsCreateRequestFeature {
2660
2814
  /**
2661
2815
  * ID of the parent capability/feature for the feature.
2662
2816
  * @maxItems 1
2663
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
2817
+ * @example ["PROD-12345"]
2664
2818
  */
2665
2819
  parent_part: string[];
2666
2820
  }
@@ -2674,7 +2828,7 @@ export interface PartsCreateResponse {
2674
2828
  export interface PartsDeleteRequest {
2675
2829
  /**
2676
2830
  * The ID of the part to delete.
2677
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
2831
+ * @example "PROD-12345"
2678
2832
  */
2679
2833
  id: string;
2680
2834
  }
@@ -2684,7 +2838,7 @@ export type PartsDeleteResponse = object;
2684
2838
  export interface PartsGetRequest {
2685
2839
  /**
2686
2840
  * The ID of the part to retrieve.
2687
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
2841
+ * @example "PROD-12345"
2688
2842
  */
2689
2843
  id: string;
2690
2844
  }
@@ -2696,7 +2850,7 @@ export interface PartsGetResponse {
2696
2850
  export interface PartsListRequest {
2697
2851
  /**
2698
2852
  * Filters for parts created by any of these users.
2699
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
2853
+ * @example ["DEVU-12345"]
2700
2854
  */
2701
2855
  created_by?: string[];
2702
2856
  /**
@@ -2721,9 +2875,11 @@ export interface PartsListRequest {
2721
2875
  name?: string[];
2722
2876
  /**
2723
2877
  * Filters for parts owned by any of these users.
2724
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
2878
+ * @example ["DEVU-12345"]
2725
2879
  */
2726
2880
  owned_by?: string[];
2881
+ /** The filter for specifying parent part. */
2882
+ parent_part?: ParentPartFilter;
2727
2883
  /** Filters for parts of the provided type(s). */
2728
2884
  type?: PartType[];
2729
2885
  }
@@ -2756,7 +2912,7 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
2756
2912
  description?: string;
2757
2913
  /**
2758
2914
  * The ID of the part to update.
2759
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
2915
+ * @example "PROD-12345"
2760
2916
  */
2761
2917
  id: string;
2762
2918
  /** The updated name of the part. */
@@ -2768,7 +2924,7 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
2768
2924
  export interface PartsUpdateRequestArtifacts {
2769
2925
  /**
2770
2926
  * Sets the artifacts to the provided IDs.
2771
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
2927
+ * @example ["ARTIFACT-12345"]
2772
2928
  */
2773
2929
  set?: string[];
2774
2930
  }
@@ -2779,8 +2935,16 @@ export interface PartsUpdateRequestEnhancement {
2779
2935
  /**
2780
2936
  * Updates the target close date of the enhancement.
2781
2937
  * @format date-time
2938
+ * @example "2023-01-01T12:00:00.000Z"
2782
2939
  */
2783
2940
  target_close_date?: string;
2941
+ /**
2942
+ * Updates the target start date of the enhancement. Example Date
2943
+ * Format: 2000-11-01T01:01:01Z
2944
+ * @format date-time
2945
+ * @example "2023-01-01T12:00:00.000Z"
2946
+ */
2947
+ target_start_date?: string;
2784
2948
  }
2785
2949
  /** parts-update-request-feature */
2786
2950
  export type PartsUpdateRequestFeature = object;
@@ -2789,7 +2953,7 @@ export interface PartsUpdateRequestOwnedBy {
2789
2953
  /**
2790
2954
  * Sets the owner IDs to the provided user IDs. This must not be
2791
2955
  * empty.
2792
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
2956
+ * @example ["DEVU-12345"]
2793
2957
  */
2794
2958
  set?: string[];
2795
2959
  }
@@ -2841,6 +3005,8 @@ export type RevOrg = OrgBase & {
2841
3005
  * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
2842
3006
  */
2843
3007
  stock_schema_fragment?: string;
3008
+ /** Tags associated with an object. */
3009
+ tags?: TagWithValue[];
2844
3010
  };
2845
3011
  /** rev-org-summary */
2846
3012
  export type RevOrgSummary = OrgBaseSummary;
@@ -2852,12 +3018,12 @@ export type RevOrgSummary = OrgBaseSummary;
2852
3018
  export interface RevOrgsCreateRequest {
2853
3019
  /**
2854
3020
  * Account Id to associate with this Rev organization.
2855
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
3021
+ * @example "ACC-12345"
2856
3022
  */
2857
3023
  account?: string;
2858
3024
  /**
2859
3025
  * The IDs of the artifacts to associate with the Rev organization.
2860
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
3026
+ * @example ["ARTIFACT-12345"]
2861
3027
  */
2862
3028
  artifacts?: string[];
2863
3029
  /** Application-defined custom fields. */
@@ -2881,6 +3047,8 @@ export interface RevOrgsCreateRequest {
2881
3047
  * records.
2882
3048
  */
2883
3049
  external_ref?: string;
3050
+ /** Tags associated with the Rev organization. */
3051
+ tags?: SetTagWithValue[];
2884
3052
  /** The tier of the RevOrg. */
2885
3053
  tier?: string;
2886
3054
  }
@@ -2899,12 +3067,12 @@ export interface RevOrgsGetRequest {
2899
3067
  /**
2900
3068
  * The ID of account for which default Rev organization is to be
2901
3069
  * fetched.
2902
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
3070
+ * @example "ACC-12345"
2903
3071
  */
2904
3072
  account?: string;
2905
3073
  /**
2906
3074
  * The ID of the required Rev organization.
2907
- * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
3075
+ * @example "REV-AbCdEfGh"
2908
3076
  */
2909
3077
  id?: string;
2910
3078
  }
@@ -2923,7 +3091,7 @@ export interface RevOrgsGetResponse {
2923
3091
  export interface RevOrgsListRequest {
2924
3092
  /**
2925
3093
  * Filters by account.
2926
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
3094
+ * @example ["ACC-12345"]
2927
3095
  */
2928
3096
  account?: string[];
2929
3097
  /** Filters by creator. */
@@ -2939,6 +3107,8 @@ export interface RevOrgsListRequest {
2939
3107
  * (custom_field_filter=field_name1:val1,val2,val3&custom_field_filter=field_name2:val1,val2).
2940
3108
  */
2941
3109
  custom_field_filter?: string[];
3110
+ /** Filters for custom fields. */
3111
+ custom_fields?: object;
2942
3112
  /** List of external refs to filter Rev organizations for. */
2943
3113
  external_ref?: string[];
2944
3114
  /**
@@ -2960,6 +3130,8 @@ export interface RevOrgsListRequest {
2960
3130
  * them.
2961
3131
  */
2962
3132
  sort_by?: string[];
3133
+ /** List of tags to be filtered. */
3134
+ tags?: string[];
2963
3135
  }
2964
3136
  /**
2965
3137
  * rev-orgs-list-response
@@ -2986,7 +3158,7 @@ export interface RevOrgsListResponse {
2986
3158
  export interface RevOrgsUpdateRequest {
2987
3159
  /**
2988
3160
  * New account ID to associate with this Rev organization.
2989
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
3161
+ * @example "ACC-12345"
2990
3162
  */
2991
3163
  account?: string;
2992
3164
  artifacts?: RevOrgsUpdateRequestArtifacts;
@@ -3011,9 +3183,11 @@ export interface RevOrgsUpdateRequest {
3011
3183
  external_ref?: string;
3012
3184
  /**
3013
3185
  * The ID of Rev organization to update.
3014
- * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
3186
+ * @example "REV-AbCdEfGh"
3015
3187
  */
3016
3188
  id: string;
3189
+ /** Tags associated with the Rev organization. */
3190
+ tags?: SetTagWithValue[];
3017
3191
  /** The tier of the RevOrg. */
3018
3192
  tier?: string;
3019
3193
  }
@@ -3021,7 +3195,7 @@ export interface RevOrgsUpdateRequest {
3021
3195
  export interface RevOrgsUpdateRequestArtifacts {
3022
3196
  /**
3023
3197
  * Sets the IDs to the provided artifact IDs.
3024
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
3198
+ * @example ["ARTIFACT-12345"]
3025
3199
  */
3026
3200
  set?: string[];
3027
3201
  }
@@ -3061,6 +3235,8 @@ export type RevUser = UserBase & {
3061
3235
  * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
3062
3236
  */
3063
3237
  stock_schema_fragment?: string;
3238
+ /** Tags associated with the object. */
3239
+ tags?: TagWithValue[];
3064
3240
  };
3065
3241
  /** rev-user-summary */
3066
3242
  export type RevUserSummary = UserBaseSummary & {
@@ -3081,7 +3257,7 @@ export type RevUserSummary = UserBaseSummary & {
3081
3257
  export interface RevUsersCreateRequest {
3082
3258
  /**
3083
3259
  * The IDs of the artifacts to associate with the Rev user.
3084
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
3260
+ * @example ["ARTIFACT-12345"]
3085
3261
  */
3086
3262
  artifacts?: string[];
3087
3263
  /** Application-defined custom fields. */
@@ -3109,9 +3285,11 @@ export interface RevUsersCreateRequest {
3109
3285
  phone_numbers?: string[];
3110
3286
  /**
3111
3287
  * The ID of Rev organization for which a Rev user is to be created.
3112
- * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
3288
+ * @example "REV-AbCdEfGh"
3113
3289
  */
3114
3290
  rev_org?: string;
3291
+ /** Tags associated with the Rev user. */
3292
+ tags?: SetTagWithValue[];
3115
3293
  }
3116
3294
  /**
3117
3295
  * rev-users-create-response
@@ -3162,6 +3340,8 @@ export interface RevUsersListRequest {
3162
3340
  * iteration starts from the beginning.
3163
3341
  */
3164
3342
  cursor?: string;
3343
+ /** Filters for custom fields. */
3344
+ custom_fields?: object;
3165
3345
  /** List of emails of Rev users to be filtered. */
3166
3346
  email?: string[];
3167
3347
  /** List of external refs to filter Rev users for. */
@@ -3186,11 +3366,13 @@ export interface RevUsersListRequest {
3186
3366
  phone_numbers?: string[];
3187
3367
  /**
3188
3368
  * List of IDs of Rev organizations to be filtered.
3189
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
3369
+ * @example ["REV-AbCdEfGh"]
3190
3370
  */
3191
3371
  rev_org?: string[];
3192
3372
  /** Fields to sort the Rev users by and the direction to sort them. */
3193
3373
  sort_by?: string[];
3374
+ /** List of tags to be filtered. */
3375
+ tags?: string[];
3194
3376
  }
3195
3377
  /**
3196
3378
  * rev-users-list-response
@@ -3229,12 +3411,14 @@ export interface RevUsersUpdateRequest {
3229
3411
  external_ref?: string;
3230
3412
  /** The ID of Rev user to update. */
3231
3413
  id: string;
3414
+ /** Tags associated with the Rev user. */
3415
+ tags?: SetTagWithValue[];
3232
3416
  }
3233
3417
  /** rev-users-update-request-artifacts */
3234
3418
  export interface RevUsersUpdateRequestArtifacts {
3235
3419
  /**
3236
3420
  * Sets the IDs to the provided artifact IDs.
3237
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
3421
+ * @example ["ARTIFACT-12345"]
3238
3422
  */
3239
3423
  set?: string[];
3240
3424
  }
@@ -3314,11 +3498,11 @@ export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
3314
3498
  * schema-field-descriptor
3315
3499
  * Set of field attributes.
3316
3500
  */
3317
- export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor) & {
3501
+ export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
3318
3502
  field_type: SchemaFieldDescriptorFieldType;
3319
3503
  };
3320
3504
  /** schema-field-descriptor-array-type */
3321
- export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor) & {
3505
+ export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
3322
3506
  base_type: SchemaFieldDescriptorArrayTypeBaseType;
3323
3507
  /**
3324
3508
  * The maximum array length.
@@ -3342,7 +3526,8 @@ export declare enum SchemaFieldDescriptorArrayTypeBaseType {
3342
3526
  RichText = "rich_text",
3343
3527
  Text = "text",
3344
3528
  Timestamp = "timestamp",
3345
- Tokens = "tokens"
3529
+ Tokens = "tokens",
3530
+ Uenum = "uenum"
3346
3531
  }
3347
3532
  /** schema-field-descriptor-base */
3348
3533
  export interface SchemaFieldDescriptorBase {
@@ -3378,7 +3563,9 @@ export declare enum SchemaFieldDescriptorFieldType {
3378
3563
  RichText = "rich_text",
3379
3564
  Text = "text",
3380
3565
  Timestamp = "timestamp",
3381
- Tokens = "tokens"
3566
+ Tokens = "tokens",
3567
+ Uenum = "uenum",
3568
+ Unknown = "unknown"
3382
3569
  }
3383
3570
  /**
3384
3571
  * schema-field-mfz-metadata
@@ -3638,6 +3825,25 @@ export type SchemaTokensListFieldDescriptor = SchemaFieldDescriptorBase & {
3638
3825
  /** The string suffix. */
3639
3826
  suffix?: string;
3640
3827
  };
3828
+ /** schema-uenum-field-descriptor */
3829
+ export type SchemaUenumFieldDescriptor = SchemaFieldDescriptorBase & {
3830
+ /** Allowed values for the field. */
3831
+ allowed_values: UenumValue[];
3832
+ /**
3833
+ * Default value.
3834
+ * @format int64
3835
+ */
3836
+ default_value?: number;
3837
+ };
3838
+ /** schema-uenum-list-field-descriptor */
3839
+ export type SchemaUenumListFieldDescriptor = SchemaFieldDescriptorBase & {
3840
+ /** Allowed values for the field. */
3841
+ allowed_values: UenumValue[];
3842
+ /** Default value. */
3843
+ default_value?: number[];
3844
+ };
3845
+ /** schema-unknown-field-descriptor */
3846
+ export type SchemaUnknownFieldDescriptor = SchemaFieldDescriptorBase;
3641
3847
  /** service-account */
3642
3848
  export type ServiceAccount = UserBase;
3643
3849
  /** service-account-summary */
@@ -3684,7 +3890,7 @@ export interface SetSlaSelector {
3684
3890
  custom_fields?: object;
3685
3891
  /**
3686
3892
  * The SLA policy applies to the tickets of these parts.
3687
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
3893
+ * @example ["PROD-12345"]
3688
3894
  */
3689
3895
  parts?: string[];
3690
3896
  /** The SLA policy applies to conversations with these priorities. */
@@ -3695,7 +3901,7 @@ export interface SetSlaSelector {
3695
3901
  source_channel?: string[];
3696
3902
  /**
3697
3903
  * The SLA policy applies to items with these tags.
3698
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
3904
+ * @example ["TAG-12345"]
3699
3905
  */
3700
3906
  tags?: string[];
3701
3907
  }
@@ -3733,7 +3939,7 @@ export interface SetSupportMetricTarget {
3733
3939
  export interface SetTagWithValue {
3734
3940
  /**
3735
3941
  * The ID of the tag.
3736
- * @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
3942
+ * @example "TAG-12345"
3737
3943
  */
3738
3944
  id: string;
3739
3945
  /**
@@ -3850,7 +4056,23 @@ export declare enum SlaStatus {
3850
4056
  * sla-summary-filter
3851
4057
  * The filter for SLA summary.
3852
4058
  */
3853
- export type SlaSummaryFilter = object;
4059
+ export interface SlaSummaryFilter {
4060
+ /** Filters for records with any of the provided SLA stages. */
4061
+ stage?: SlaSummaryStage[];
4062
+ }
4063
+ /**
4064
+ * The stage of the SLA. This is the metric stage which is closest to
4065
+ * breach.
4066
+ */
4067
+ export declare enum SlaSummaryStage {
4068
+ Breached = "breached",
4069
+ Completed = "completed",
4070
+ Paused = "paused",
4071
+ Running = "running",
4072
+ Warning = "warning"
4073
+ }
4074
+ /** sla-tracker */
4075
+ export type SlaTracker = AtomBase;
3854
4076
  /** slas-assign-request */
3855
4077
  export interface SlasAssignRequest {
3856
4078
  /**
@@ -3861,7 +4083,7 @@ export interface SlasAssignRequest {
3861
4083
  id?: string;
3862
4084
  /**
3863
4085
  * The Rev organizations to apply the SLA to.
3864
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
4086
+ * @example ["REV-AbCdEfGh"]
3865
4087
  */
3866
4088
  rev_orgs: string[];
3867
4089
  }
@@ -3985,14 +4207,6 @@ export interface SlasUpdateRequest {
3985
4207
  export interface SlasUpdateResponse {
3986
4208
  sla: Sla;
3987
4209
  }
3988
- /**
3989
- * stage
3990
- * Describes the current stage of a work item.
3991
- */
3992
- export interface Stage {
3993
- /** Current stage name of the work item. */
3994
- name: string;
3995
- }
3996
4210
  /**
3997
4211
  * stage-filter
3998
4212
  * The filter for stages.
@@ -4111,7 +4325,7 @@ export interface SysUsersUpdateRequest {
4111
4325
  display_name?: string;
4112
4326
  /**
4113
4327
  * Artifact ID of the system user's new display picture.
4114
- * @example "don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"
4328
+ * @example "ARTIFACT-12345"
4115
4329
  */
4116
4330
  display_picture?: string | null;
4117
4331
  /** Updated full name for the system user. */
@@ -4165,7 +4379,7 @@ export interface TagWithValue {
4165
4379
  export interface TagWithValueFilter {
4166
4380
  /**
4167
4381
  * The ID of the tag.
4168
- * @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
4382
+ * @example "TAG-12345"
4169
4383
  */
4170
4384
  id?: string;
4171
4385
  /**
@@ -4246,6 +4460,7 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
4246
4460
  * provided time. The minimum value should be at least a minute more
4247
4461
  * than the current timestamp.
4248
4462
  * @format date-time
4463
+ * @example "2023-01-01T12:00:00.000Z"
4249
4464
  */
4250
4465
  expires_at?: string;
4251
4466
  /**
@@ -4257,14 +4472,14 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
4257
4472
  labels?: string[];
4258
4473
  /**
4259
4474
  * The ID of the object to create the timeline entry for.
4260
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
4475
+ * @example "PROD-12345"
4261
4476
  */
4262
4477
  object: string;
4263
4478
  /**
4264
4479
  * If the visibility of the entry is private, this specifies the users
4265
4480
  * that the entry is private to. Note the creator is always implicitly
4266
4481
  * included in this list.
4267
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4482
+ * @example ["DEVU-12345"]
4268
4483
  */
4269
4484
  private_to?: string[];
4270
4485
  type: TimelineEntriesCreateRequestType;
@@ -4281,7 +4496,8 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
4281
4496
  export interface TimelineEntriesCreateRequestTimelineComment {
4282
4497
  /**
4283
4498
  * The IDs of the artifacts attached to the comment.
4284
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
4499
+ * @maxItems 10
4500
+ * @example ["ARTIFACT-12345"]
4285
4501
  */
4286
4502
  artifacts?: string[];
4287
4503
  /** The comment's body. */
@@ -4345,7 +4561,7 @@ export interface TimelineEntriesListRequest {
4345
4561
  mode?: ListMode;
4346
4562
  /**
4347
4563
  * The ID of the object to list timeline entries for.
4348
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
4564
+ * @example "PROD-12345"
4349
4565
  */
4350
4566
  object: string;
4351
4567
  /**
@@ -4402,18 +4618,21 @@ export interface TimelineEntriesUpdateRequestTimelineCommentArtifacts {
4402
4618
  * Adds the provided artifacts to the comment. An artifact cannot be
4403
4619
  * added more than once, i.e. nothing is done if the artifact is
4404
4620
  * already attached. Mutually exclusive with `set`.
4405
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
4621
+ * @maxItems 10
4622
+ * @example ["ARTIFACT-12345"]
4406
4623
  */
4407
4624
  add?: string[];
4408
4625
  /**
4409
4626
  * Removes the provided artifacts from the comment. If an artifact is
4410
4627
  * not present, then it's ignored. Mututally exclusive with `set`.
4411
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
4628
+ * @maxItems 10
4629
+ * @example ["ARTIFACT-12345"]
4412
4630
  */
4413
4631
  remove?: string[];
4414
4632
  /**
4415
4633
  * Sets the field to the provided artifacts.
4416
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
4634
+ * @maxItems 10
4635
+ * @example ["ARTIFACT-12345"]
4417
4636
  */
4418
4637
  set?: string[];
4419
4638
  }
@@ -4551,6 +4770,51 @@ export interface TimelineThread {
4551
4770
  */
4552
4771
  total_replies?: number;
4553
4772
  }
4773
+ /** uenum-value */
4774
+ export interface UenumValue {
4775
+ /**
4776
+ * The ID of the enum value.
4777
+ * @format int64
4778
+ */
4779
+ id: number;
4780
+ /** Whether the enum value is deprecated. */
4781
+ is_deprecated?: boolean;
4782
+ /** The label of the enum value. */
4783
+ label: string;
4784
+ /**
4785
+ * The ordinal of the enum value.
4786
+ * @format int64
4787
+ */
4788
+ ordinal: number;
4789
+ /** The tooltip of the enum value. */
4790
+ tooltip?: string;
4791
+ }
4792
+ /**
4793
+ * unit
4794
+ * Unit encapsulates the name of the unit and the type of the unit. For
4795
+ * example, '#Number of API calls' where name is 'number_of_api_calls' and
4796
+ * type is 'number'.
4797
+ */
4798
+ export interface Unit {
4799
+ /**
4800
+ * This represents human readable unit name of the UOM For example,
4801
+ * number of API calls.
4802
+ */
4803
+ name: string;
4804
+ /**
4805
+ * This defines the UOM unit type. For example, for 'number of video
4806
+ * calls', unit type will be a number.
4807
+ */
4808
+ type: UnitType;
4809
+ }
4810
+ /**
4811
+ * This defines the UOM unit type. For example, for 'number of video
4812
+ * calls', unit type will be a number.
4813
+ */
4814
+ export declare enum UnitType {
4815
+ Boolean = "boolean",
4816
+ Number = "number"
4817
+ }
4554
4818
  /**
4555
4819
  * unlink-rev-user-from-rev-org-request
4556
4820
  * A request to unlink a rev user from a rev org.
@@ -4558,7 +4822,7 @@ export interface TimelineThread {
4558
4822
  export interface UnlinkRevUserFromRevOrgRequest {
4559
4823
  /**
4560
4824
  * The don of the rev org to unlink the rev user from.
4561
- * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
4825
+ * @example "REV-AbCdEfGh"
4562
4826
  */
4563
4827
  rev_org_don: string;
4564
4828
  /** The don of the rev user to unlink. */
@@ -4571,6 +4835,242 @@ export interface UnlinkRevUserFromRevOrgRequest {
4571
4835
  export interface UnlinkRevUserFromRevOrgResponse {
4572
4836
  rev_user: RevUser;
4573
4837
  }
4838
+ /** uom */
4839
+ export type Uom = AtomBase & {
4840
+ /** Stores aggregation type and dimension information. */
4841
+ aggregation_details: AggregationDetail;
4842
+ /** Description of the UOM. */
4843
+ description?: string;
4844
+ /**
4845
+ * The list of dimensions that can be emitted along with the metering
4846
+ * data.
4847
+ */
4848
+ dimensions?: string[];
4849
+ /**
4850
+ * If set to true, then the UOM can be configured as part of
4851
+ * entitlements in skus and metering data only for the enabled uoms
4852
+ * will be passed through the metering pipeline.
4853
+ */
4854
+ is_enabled: boolean;
4855
+ /** Human readable metric name of the UOM. */
4856
+ metric_name: string;
4857
+ /**
4858
+ * The granularity at which the metrics ingestion data is to be emitted
4859
+ * for the UOM.
4860
+ */
4861
+ metric_scope: UomMetricScope;
4862
+ /** Human readable name of the UOM. */
4863
+ name: string;
4864
+ part?: PartSummary;
4865
+ product: PartSummary;
4866
+ /**
4867
+ * Unit encapsulates the name of the unit and the type of the unit. For
4868
+ * example, '#Number of API calls' where name is 'number_of_api_calls' and
4869
+ * type is 'number'.
4870
+ */
4871
+ unit: Unit;
4872
+ };
4873
+ /**
4874
+ * The granularity at which the metrics ingestion data is to be emitted
4875
+ * for the UOM.
4876
+ */
4877
+ export declare enum UomMetricScope {
4878
+ Org = "org",
4879
+ User = "user"
4880
+ }
4881
+ /** uoms-create-request */
4882
+ export interface UomsCreateRequest {
4883
+ /** Stores aggregation type and dimension information. */
4884
+ aggregation_detail: AggregationDetail;
4885
+ /** Description of the Unit of Measurement (UOM). */
4886
+ description?: string;
4887
+ /**
4888
+ * The list of dimensions that can be emitted as part of metrics data.
4889
+ * Dimensions consist of list of key-value pairs. For example, if the
4890
+ * UOM is 'number_of_api_calls', then dimensions can be ['api_name',
4891
+ * 'api_version'].Dimension keys can only contain alphanumeric
4892
+ * characters (A-Z, a-z, and 0-9) and underscores (_). Dimension keys
4893
+ * cannot start with a number and is case-insensitive.Dimension keys
4894
+ * must be unique and it is not allowed to have more than one value
4895
+ * with the same key.Metrics data ingested in DevRev metrics format
4896
+ * will be grouped and aggregated based on the dimensions specified in
4897
+ * UOM.
4898
+ * @minLength 1
4899
+ * @maxLength 64
4900
+ * @maxItems 12
4901
+ */
4902
+ dimensions?: string[];
4903
+ /**
4904
+ * Name of the Unit of Measurement (UOM). Unit of Measurement is a
4905
+ * unit of measure defined over a part offered by a Dev Org. A single
4906
+ * part can have multiple unit of measurements defined over it. For
4907
+ * example, a part can be 'video call', one UOM defined on this can be
4908
+ * 'number_of_calls', other UOM can be 'call_duration' etc.Metric name
4909
+ * should be unique across all UOMs in a Dev Org.Metric name can only
4910
+ * contain alphanumeric characters (A-Z, a-z, and 0-9) and underscores
4911
+ * (_). Metric name cannot start with a number and is
4912
+ * case-insensitive.
4913
+ * @minLength 1
4914
+ * @maxLength 64
4915
+ */
4916
+ metric_name: string;
4917
+ /** Human readable name of the Unit of Measurement (UOM). */
4918
+ name: string;
4919
+ /**
4920
+ * The part ID for which the Unit of Measurement (UOM) is defined.
4921
+ * When defined, ingested metrics data will be associated with part
4922
+ * and product specified in UOM.
4923
+ * @example "PROD-12345"
4924
+ */
4925
+ part_id?: string;
4926
+ /**
4927
+ * The product ID for which the Unit of Measurement (UOM) is defined.
4928
+ * @example "PROD-12345"
4929
+ */
4930
+ product_id: string;
4931
+ /**
4932
+ * Unit encapsulates the name of the unit and the type of the unit. For
4933
+ * example, '#Number of API calls' where name is 'number_of_api_calls' and
4934
+ * type is 'number'.
4935
+ */
4936
+ unit: Unit;
4937
+ }
4938
+ /** uoms-create-response */
4939
+ export interface UomsCreateResponse {
4940
+ uom: Uom;
4941
+ }
4942
+ /** uoms-delete-request */
4943
+ export interface UomsDeleteRequest {
4944
+ /** The Unit of Measurement (UOM)'s DON. */
4945
+ id: string;
4946
+ }
4947
+ /** uoms-get-request */
4948
+ export interface UomsGetRequest {
4949
+ /** The Unit of Measurement (UOM)'s DON. */
4950
+ id: string;
4951
+ }
4952
+ /** uoms-get-response */
4953
+ export interface UomsGetResponse {
4954
+ uom: Uom;
4955
+ }
4956
+ /** uoms-list-request */
4957
+ export interface UomsListRequest {
4958
+ /** List of aggregation types for filtering list of UOMs. */
4959
+ aggregation_types?: AggregationDetailAggregationType[];
4960
+ /**
4961
+ * The cursor to resume iteration from. If not provided, then
4962
+ * iteration starts from the beginning.
4963
+ */
4964
+ cursor?: string;
4965
+ /**
4966
+ * List of Unit of Measurement (UOM) DONs to be used in filtering
4967
+ * complete list of UOMs defined in a Dev Org.
4968
+ */
4969
+ ids?: string[];
4970
+ /**
4971
+ * The maximum number of UOMs to be returned in a response. The
4972
+ * default is '50'.
4973
+ * @format int32
4974
+ */
4975
+ limit?: number;
4976
+ /** List of metric names for filtering list of UOMs. */
4977
+ metric_names?: string[];
4978
+ /**
4979
+ * The iteration mode to use. If "after", then entries after the provided
4980
+ * cursor will be returned, or if no cursor is provided, then from the
4981
+ * beginning. If "before", then entries before the provided cursor will be
4982
+ * returned, or if no cursor is provided, then from the end. Entries will
4983
+ * always be returned in the specified sort-by order.
4984
+ */
4985
+ mode?: ListMode;
4986
+ /**
4987
+ * List of part IDs for filtering list of UOMs.
4988
+ * @example ["PROD-12345"]
4989
+ */
4990
+ part_ids?: string[];
4991
+ /**
4992
+ * List of product IDs for filtering list of UOMs.
4993
+ * @example ["PROD-12345"]
4994
+ */
4995
+ product_ids?: string[];
4996
+ /**
4997
+ * Fields to sort the Unit Of Measuments (UOMs) by and the direction
4998
+ * to sort them.
4999
+ */
5000
+ sort_by?: string[];
5001
+ /** List of unit types for filtering list of UOMs. */
5002
+ unit_types?: UnitType[];
5003
+ }
5004
+ /** uoms-list-response */
5005
+ export interface UomsListResponse {
5006
+ /**
5007
+ * The cursor used to iterate subsequent results in accordance to the
5008
+ * sort order. If not set, then no later elements exist.
5009
+ */
5010
+ next_cursor?: string;
5011
+ /**
5012
+ * The cursor used to iterate preceding results in accordance to the
5013
+ * sort order. If not set, then no prior elements exist.
5014
+ */
5015
+ prev_cursor?: string;
5016
+ /** The list of Unit of Measurement (UOM) objects. */
5017
+ uoms: Uom[];
5018
+ }
5019
+ /** uoms-update-request */
5020
+ export interface UomsUpdateRequest {
5021
+ /**
5022
+ * Aggregation type to be used while aggregating the metering data for the
5023
+ * UOM. 1] Sum - sum of all the values for the meter in a given period Ex.
5024
+ * { M1:2, M1:4 } => {M1:6} 2] Minimum - min of all the values for the
5025
+ * meter in a given period Ex. { M1:2, M1:4 } => {M1:2} 3] Maximum - max
5026
+ * of all the values for the meter in a given period Ex. { M1:2, M1:4 } =>
5027
+ * {M1:4} 4] Unique Count - Sum of distinct unique dimension observed for
5028
+ * the meter in the given period (not considering the data from the
5029
+ * previous billing period) Ex. January {M1:{VM:VM0}}, February
5030
+ * {M1:{VM:VM1}, M1:{VM:VM2}, M1:{VM:VM1}} => {M1:2} 5] Running Total -
5031
+ * Sum of distinct active unique dimension observed for a meter in the
5032
+ * given period, taking into consideration the active data from the
5033
+ * previous billing cycle Ex. January {M1:{VM:VM0,on}, {M1:{VM:VM1,off}
5034
+ * February {M1:{VM:VM2, on}, M1:{VM:VM2, off}, M1:{VM:VM3, on}} => {M1:3}
5035
+ * 6] Duration - Sum of distinct active unique dimension duration for a
5036
+ * meter in the given period, taking into consideration the active data
5037
+ * from the previous month Ex. January15 {M1:{VM:VM0,on, 4}} February15
5038
+ * {M1:{VM:VM0,off}, February18 {M1:{VM:VM1,on,5} => M1->
5039
+ * 30*4*charge_per_day + 10*5*charge_per_day 7] Latest - consider the
5040
+ * latest/last meter in the given period 8] Oldest - consider the
5041
+ * oldest/first record in the given period.
5042
+ */
5043
+ aggregation_type?: AggregationDetailAggregationType;
5044
+ /** Description of the Unit of Measurement (UOM). */
5045
+ description?: string;
5046
+ /** The Unit of Measurement (UOM)'s DON. */
5047
+ id: string;
5048
+ /**
5049
+ * Flag used to enable/disable the Unit of Measurement (UOM). When
5050
+ * disabled, any metricsrecords ingested against this UOM will be
5051
+ * dropped.
5052
+ */
5053
+ is_enabled?: boolean;
5054
+ /** Human readable name of the Unit of Measurement (UOM). */
5055
+ name?: string;
5056
+ /**
5057
+ * The part ID such as feature or capability for which the Unit of
5058
+ * Measurement (UOM) is defined.
5059
+ * @example "PROD-12345"
5060
+ */
5061
+ part_id?: string;
5062
+ /**
5063
+ * The product ID for which the Unit of Measurement (UOM) is defined.
5064
+ * @example "PROD-12345"
5065
+ */
5066
+ product_id?: string;
5067
+ /** Unit name of the Unit of Measurement (UOM). */
5068
+ unit?: string;
5069
+ }
5070
+ /** uoms-update-response */
5071
+ export interface UomsUpdateResponse {
5072
+ uom: Uom;
5073
+ }
4574
5074
  /** user-base */
4575
5075
  export type UserBase = AtomBase & {
4576
5076
  /** The user's display name. The name is non-unique and mutable. */
@@ -4646,6 +5146,9 @@ export interface WebhookEventRequest {
4646
5146
  rev_user_created?: EventRevUserCreated;
4647
5147
  rev_user_deleted?: EventRevUserDeleted;
4648
5148
  rev_user_updated?: EventRevUserUpdated;
5149
+ sla_tracker_created?: EventSlaTrackerCreated;
5150
+ sla_tracker_deleted?: EventSlaTrackerDeleted;
5151
+ sla_tracker_updated?: EventSlaTrackerUpdated;
4649
5152
  tag_created?: EventTagCreated;
4650
5153
  tag_deleted?: EventTagDeleted;
4651
5154
  tag_updated?: EventTagUpdated;
@@ -4658,6 +5161,7 @@ export interface WebhookEventRequest {
4658
5161
  * should only be processed if the timestamp isn't stale by several
4659
5162
  * seconds.
4660
5163
  * @format date-time
5164
+ * @example "2023-01-01T12:00:00.000Z"
4661
5165
  */
4662
5166
  timestamp?: string;
4663
5167
  /** The event types that the webhook will receive. */
@@ -4751,7 +5255,7 @@ export type WorkBase = AtomBase & {
4751
5255
  /** Users that reported the work. */
4752
5256
  reported_by?: UserSummary[];
4753
5257
  /** Describes the current stage of a work item. */
4754
- stage?: Stage;
5258
+ stage?: LegacyStage;
4755
5259
  /**
4756
5260
  * Stock schema fragment.
4757
5261
  * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
@@ -4762,6 +5266,7 @@ export type WorkBase = AtomBase & {
4762
5266
  /**
4763
5267
  * Timestamp when the work is expected to be complete.
4764
5268
  * @format date-time
5269
+ * @example "2023-01-01T12:00:00.000Z"
4765
5270
  */
4766
5271
  target_close_date?: string;
4767
5272
  /** Title of the work object. */
@@ -4784,12 +5289,12 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
4784
5289
  * The [part](https://devrev.ai/docs/product/parts) that the work
4785
5290
  * applies to. Specifying a part is required when creating tickets and
4786
5291
  * issues.
4787
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
5292
+ * @example "PROD-12345"
4788
5293
  */
4789
5294
  applies_to_part: string;
4790
5295
  /**
4791
5296
  * The IDs of the artifacts to associate with the work item.
4792
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
5297
+ * @example ["ARTIFACT-12345"]
4793
5298
  */
4794
5299
  artifacts?: string[];
4795
5300
  /** Body of the work object. */
@@ -4803,12 +5308,12 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
4803
5308
  custom_schema_fragments?: string[];
4804
5309
  /**
4805
5310
  * The users that own the work.
4806
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5311
+ * @example ["DEVU-12345"]
4807
5312
  */
4808
5313
  owned_by: string[];
4809
5314
  /**
4810
5315
  * The users that reported the work.
4811
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5316
+ * @example ["DEVU-12345"]
4812
5317
  */
4813
5318
  reported_by?: string[];
4814
5319
  /** Sets an object's initial stage. */
@@ -4818,6 +5323,7 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
4818
5323
  /**
4819
5324
  * Timestamp for when the work is expected to be complete.
4820
5325
  * @format date-time
5326
+ * @example "2023-01-01T12:00:00.000Z"
4821
5327
  */
4822
5328
  target_close_date?: string;
4823
5329
  /** Title of the work object. */
@@ -4826,6 +5332,12 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
4826
5332
  };
4827
5333
  /** works-create-request-issue */
4828
5334
  export interface WorksCreateRequestIssue {
5335
+ /**
5336
+ * The IDs of the parts associated with issue.
5337
+ * @maxItems 8
5338
+ * @example ["PROD-12345"]
5339
+ */
5340
+ developed_with?: string[];
4829
5341
  /** Priority of the work based upon impact and criticality. */
4830
5342
  priority?: IssuePriority;
4831
5343
  /** The sprint that the issue belongs to. */
@@ -4835,7 +5347,7 @@ export interface WorksCreateRequestIssue {
4835
5347
  export interface WorksCreateRequestOpportunity {
4836
5348
  /**
4837
5349
  * The ID of the account that the opportunity is associated with.
4838
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
5350
+ * @example "ACC-12345"
4839
5351
  */
4840
5352
  account: string;
4841
5353
  /**
@@ -4869,6 +5381,7 @@ export interface WorksCreateRequestTask {
4869
5381
  /**
4870
5382
  * Timestamp when the task was started.
4871
5383
  * @format date-time
5384
+ * @example "2023-01-01T12:00:00.000Z"
4872
5385
  */
4873
5386
  start_date?: string;
4874
5387
  }
@@ -4880,7 +5393,7 @@ export interface WorksCreateRequestTicket {
4880
5393
  is_spam?: boolean;
4881
5394
  /**
4882
5395
  * The Rev organization that the ticket is associated with.
4883
- * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
5396
+ * @example "REV-AbCdEfGh"
4884
5397
  */
4885
5398
  rev_org?: string;
4886
5399
  /** Severity of the ticket. */
@@ -4896,7 +5409,7 @@ export interface WorksCreateResponse {
4896
5409
  export interface WorksDeleteRequest {
4897
5410
  /**
4898
5411
  * The work's ID.
4899
- * @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
5412
+ * @example "ISS-12345"
4900
5413
  */
4901
5414
  id: string;
4902
5415
  }
@@ -4908,12 +5421,12 @@ export interface WorksExportRequest {
4908
5421
  actual_close_date?: DateFilter;
4909
5422
  /**
4910
5423
  * Filters for work belonging to any of the provided parts.
4911
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
5424
+ * @example ["PROD-12345"]
4912
5425
  */
4913
5426
  applies_to_part?: string[];
4914
5427
  /**
4915
5428
  * Filters for work created by any of these users.
4916
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5429
+ * @example ["DEVU-12345"]
4917
5430
  */
4918
5431
  created_by?: string[];
4919
5432
  /** Provides ways to specify date ranges on objects. */
@@ -4932,7 +5445,7 @@ export interface WorksExportRequest {
4932
5445
  opportunity?: WorksFilterOpportunity;
4933
5446
  /**
4934
5447
  * Filters for work owned by any of these users.
4935
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5448
+ * @example ["DEVU-12345"]
4936
5449
  */
4937
5450
  owned_by?: string[];
4938
5451
  /** Fields to sort the work items by and the direction to sort them. */
@@ -4941,7 +5454,7 @@ export interface WorksExportRequest {
4941
5454
  stage?: StageFilter;
4942
5455
  /**
4943
5456
  * Filters for work with any of the provided tags.
4944
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
5457
+ * @example ["TAG-12345"]
4945
5458
  */
4946
5459
  tags?: string[];
4947
5460
  /** Provides ways to specify date ranges on objects. */
@@ -4961,7 +5474,7 @@ export interface WorksFilterIssue {
4961
5474
  priority?: IssuePriority[];
4962
5475
  /**
4963
5476
  * Filters for issues with any of the provided Rev organizations.
4964
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
5477
+ * @example ["REV-AbCdEfGh"]
4965
5478
  */
4966
5479
  rev_orgs?: string[];
4967
5480
  }
@@ -4970,7 +5483,7 @@ export interface WorksFilterOpportunity {
4970
5483
  /**
4971
5484
  * Filters for opportunities belonging to any of the provided
4972
5485
  * accounts.
4973
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
5486
+ * @example ["ACC-12345"]
4974
5487
  */
4975
5488
  account?: string[];
4976
5489
  /** Filters for opportunities with any of the provided contacts. */
@@ -4987,7 +5500,7 @@ export interface WorksFilterTicket {
4987
5500
  /**
4988
5501
  * Filters for tickets that are associated with any of the provided
4989
5502
  * Rev organizations.
4990
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
5503
+ * @example ["REV-AbCdEfGh"]
4991
5504
  */
4992
5505
  rev_org?: string[];
4993
5506
  /** Filters for tickets with any of the provided severities. */
@@ -5003,7 +5516,7 @@ export interface WorksFilterTicket {
5003
5516
  export interface WorksGetRequest {
5004
5517
  /**
5005
5518
  * The work's ID.
5006
- * @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
5519
+ * @example "ISS-12345"
5007
5520
  */
5008
5521
  id: string;
5009
5522
  }
@@ -5017,12 +5530,12 @@ export interface WorksListRequest {
5017
5530
  actual_close_date?: DateFilter;
5018
5531
  /**
5019
5532
  * Filters for work belonging to any of the provided parts.
5020
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
5533
+ * @example ["PROD-12345"]
5021
5534
  */
5022
5535
  applies_to_part?: string[];
5023
5536
  /**
5024
5537
  * Filters for work created by any of these users.
5025
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5538
+ * @example ["DEVU-12345"]
5026
5539
  */
5027
5540
  created_by?: string[];
5028
5541
  /** Provides ways to specify date ranges on objects. */
@@ -5053,7 +5566,7 @@ export interface WorksListRequest {
5053
5566
  opportunity?: WorksFilterOpportunity;
5054
5567
  /**
5055
5568
  * Filters for work owned by any of these users.
5056
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5569
+ * @example ["DEVU-12345"]
5057
5570
  */
5058
5571
  owned_by?: string[];
5059
5572
  /** Fields to sort the works by and the direction to sort them. */
@@ -5062,7 +5575,7 @@ export interface WorksListRequest {
5062
5575
  stage?: StageFilter;
5063
5576
  /**
5064
5577
  * Filters for work with any of the provided tags.
5065
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
5578
+ * @example ["TAG-12345"]
5066
5579
  */
5067
5580
  tags?: string[];
5068
5581
  /** Provides ways to specify date ranges on objects. */
@@ -5090,7 +5603,7 @@ export interface WorksListResponse {
5090
5603
  export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateRequestOpportunity | WorksUpdateRequestTask | WorksUpdateRequestTicket) & {
5091
5604
  /**
5092
5605
  * Updates the part that the work item applies to.
5093
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
5606
+ * @example "PROD-12345"
5094
5607
  */
5095
5608
  applies_to_part?: string;
5096
5609
  artifacts?: WorksUpdateRequestArtifactIds;
@@ -5105,7 +5618,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
5105
5618
  custom_schema_fragments?: string[];
5106
5619
  /**
5107
5620
  * The work's ID.
5108
- * @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
5621
+ * @example "ISS-12345"
5109
5622
  */
5110
5623
  id: string;
5111
5624
  owned_by?: WorksUpdateRequestOwnedBy;
@@ -5116,6 +5629,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
5116
5629
  /**
5117
5630
  * Updates the timestamp for when the work is expected to be complete.
5118
5631
  * @format date-time
5632
+ * @example "2023-01-01T12:00:00.000Z"
5119
5633
  */
5120
5634
  target_close_date?: string | null;
5121
5635
  /** Updated title of the work object, or unchanged if not provided. */
@@ -5126,22 +5640,32 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
5126
5640
  export interface WorksUpdateRequestArtifactIds {
5127
5641
  /**
5128
5642
  * Sets the IDs to the provided artifact IDs.
5129
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
5643
+ * @example ["ARTIFACT-12345"]
5130
5644
  */
5131
5645
  set?: string[];
5132
5646
  }
5133
5647
  /** works-update-request-issue */
5134
5648
  export interface WorksUpdateRequestIssue {
5649
+ developed_with?: WorksUpdateRequestIssueDevelopedWith;
5135
5650
  /** Priority of the work based upon impact and criticality. */
5136
5651
  priority?: IssuePriority;
5137
5652
  /** Updates the sprint that the issue belongs to. */
5138
5653
  sprint?: string | null;
5139
5654
  }
5655
+ /** works-update-request-issue-developed-with */
5656
+ export interface WorksUpdateRequestIssueDevelopedWith {
5657
+ /**
5658
+ * Sets the IDs of the parts associated with issue.
5659
+ * @maxItems 8
5660
+ * @example ["PROD-12345"]
5661
+ */
5662
+ set?: string[];
5663
+ }
5140
5664
  /** works-update-request-opportunity */
5141
5665
  export interface WorksUpdateRequestOpportunity {
5142
5666
  /**
5143
5667
  * Updates the account that the opportunity is associated with.
5144
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
5668
+ * @example "ACC-12345"
5145
5669
  */
5146
5670
  account?: string;
5147
5671
  /**
@@ -5172,7 +5696,7 @@ export interface WorksUpdateRequestOwnedBy {
5172
5696
  /**
5173
5697
  * Sets the owner IDs to the provided user IDs. This must not be
5174
5698
  * empty.
5175
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5699
+ * @example ["DEVU-12345"]
5176
5700
  */
5177
5701
  set?: string[];
5178
5702
  }
@@ -5180,7 +5704,7 @@ export interface WorksUpdateRequestOwnedBy {
5180
5704
  export interface WorksUpdateRequestReportedBy {
5181
5705
  /**
5182
5706
  * Sets the users that reported the work to the provided user IDs.
5183
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5707
+ * @example ["DEVU-12345"]
5184
5708
  */
5185
5709
  set?: string[];
5186
5710
  }
@@ -5198,6 +5722,7 @@ export interface WorksUpdateRequestTask {
5198
5722
  /**
5199
5723
  * Timestamp when the task was started.
5200
5724
  * @format date-time
5725
+ * @example "2023-01-01T12:00:00.000Z"
5201
5726
  */
5202
5727
  start_date?: string;
5203
5728
  }
@@ -5209,7 +5734,7 @@ export interface WorksUpdateRequestTicket {
5209
5734
  is_spam?: boolean;
5210
5735
  /**
5211
5736
  * Updates the Rev organization that the ticket is associated with.
5212
- * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
5737
+ * @example "REV-AbCdEfGh"
5213
5738
  */
5214
5739
  rev_org?: string | null;
5215
5740
  /** Severity of the ticket. */
@@ -5300,14 +5825,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5300
5825
  /**
5301
5826
  * Filters for objects created after the provided timestamp (inclusive).
5302
5827
  * @format date-time
5828
+ * @example "2023-01-01T12:00:00.000Z"
5303
5829
  */
5304
5830
  'created_date.after'?: string;
5305
5831
  /**
5306
5832
  * Filters for objects created before the provided timestamp
5307
5833
  * (inclusive).
5308
5834
  * @format date-time
5835
+ * @example "2023-01-01T12:00:00.000Z"
5309
5836
  */
5310
5837
  'created_date.before'?: string;
5838
+ /** Filters for custom fields. */
5839
+ custom_fields?: object;
5311
5840
  /** Domains for accounts to be filtered. */
5312
5841
  domains?: string[];
5313
5842
  /** Array of references of accounts to be filtered. */
@@ -5322,12 +5851,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5322
5851
  /**
5323
5852
  * Filters for objects created after the provided timestamp (inclusive).
5324
5853
  * @format date-time
5854
+ * @example "2023-01-01T12:00:00.000Z"
5325
5855
  */
5326
5856
  'modified_date.after'?: string;
5327
5857
  /**
5328
5858
  * Filters for objects created before the provided timestamp
5329
5859
  * (inclusive).
5330
5860
  * @format date-time
5861
+ * @example "2023-01-01T12:00:00.000Z"
5331
5862
  */
5332
5863
  'modified_date.before'?: string;
5333
5864
  /** Filters for accounts owned by the specified user(s). */
@@ -5359,7 +5890,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5359
5890
  accountsGet: (query: {
5360
5891
  /**
5361
5892
  * The ID of the account to be retrieved.
5362
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
5893
+ * @example "ACC-12345"
5363
5894
  */
5364
5895
  id: string;
5365
5896
  }, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any>>;
@@ -5386,12 +5917,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5386
5917
  /**
5387
5918
  * Filters for objects created after the provided timestamp (inclusive).
5388
5919
  * @format date-time
5920
+ * @example "2023-01-01T12:00:00.000Z"
5389
5921
  */
5390
5922
  'created_date.after'?: string;
5391
5923
  /**
5392
5924
  * Filters for objects created before the provided timestamp
5393
5925
  * (inclusive).
5394
5926
  * @format date-time
5927
+ * @example "2023-01-01T12:00:00.000Z"
5395
5928
  */
5396
5929
  'created_date.before'?: string;
5397
5930
  /**
@@ -5399,6 +5932,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5399
5932
  * starts from the beginning.
5400
5933
  */
5401
5934
  cursor?: string;
5935
+ /** Filters for custom fields. */
5936
+ custom_fields?: object;
5402
5937
  /** Domains for accounts to be filtered. */
5403
5938
  domains?: string[];
5404
5939
  /** Array of references of accounts to be filtered. */
@@ -5417,12 +5952,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5417
5952
  /**
5418
5953
  * Filters for objects created after the provided timestamp (inclusive).
5419
5954
  * @format date-time
5955
+ * @example "2023-01-01T12:00:00.000Z"
5420
5956
  */
5421
5957
  'modified_date.after'?: string;
5422
5958
  /**
5423
5959
  * Filters for objects created before the provided timestamp
5424
5960
  * (inclusive).
5425
5961
  * @format date-time
5962
+ * @example "2023-01-01T12:00:00.000Z"
5426
5963
  */
5427
5964
  'modified_date.before'?: string;
5428
5965
  /** Filters for accounts owned by the specified user(s). */
@@ -5463,22 +6000,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5463
6000
  articlesCount: (query?: {
5464
6001
  /**
5465
6002
  * Filters for articles belonging to any of the provided parts.
5466
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
6003
+ * @example ["PROD-12345"]
5467
6004
  */
5468
6005
  applies_to_parts?: string[];
5469
6006
  /**
5470
6007
  * Filters for articles authored by any of the provided users.
5471
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6008
+ * @example ["DEVU-12345"]
5472
6009
  */
5473
6010
  authored_by?: string[];
5474
6011
  /**
5475
6012
  * Filters for articles created by any of the provided users.
5476
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6013
+ * @example ["DEVU-12345"]
5477
6014
  */
5478
6015
  created_by?: string[];
5479
6016
  /**
5480
6017
  * Filters for articles owned by any of the provided users.
5481
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6018
+ * @example ["DEVU-12345"]
5482
6019
  */
5483
6020
  owned_by?: string[];
5484
6021
  }, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any>>;
@@ -5520,7 +6057,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5520
6057
  getArticle: (query: {
5521
6058
  /**
5522
6059
  * The ID of the required article.
5523
- * @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
6060
+ * @example "ARTICLE-12345"
5524
6061
  */
5525
6062
  id: string;
5526
6063
  }, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
@@ -5544,17 +6081,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5544
6081
  listArticles: (query?: {
5545
6082
  /**
5546
6083
  * Filters for articles belonging to any of the provided parts.
5547
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
6084
+ * @example ["PROD-12345"]
5548
6085
  */
5549
6086
  applies_to_parts?: string[];
5550
6087
  /**
5551
6088
  * Filters for articles authored by any of the provided users.
5552
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6089
+ * @example ["DEVU-12345"]
5553
6090
  */
5554
6091
  authored_by?: string[];
5555
6092
  /**
5556
6093
  * Filters for articles created by any of the provided users.
5557
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6094
+ * @example ["DEVU-12345"]
5558
6095
  */
5559
6096
  created_by?: string[];
5560
6097
  /**
@@ -5574,7 +6111,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5574
6111
  mode?: ListMode;
5575
6112
  /**
5576
6113
  * Filters for articles owned by any of the provided users.
5577
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6114
+ * @example ["DEVU-12345"]
5578
6115
  */
5579
6116
  owned_by?: string[];
5580
6117
  }, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
@@ -5643,7 +6180,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5643
6180
  conversationsExport: (query?: {
5644
6181
  /**
5645
6182
  * Filters for conversations belonging to any of the provided parts.
5646
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
6183
+ * @example ["PROD-12345"]
5647
6184
  */
5648
6185
  applies_to_parts?: string[];
5649
6186
  /**
@@ -5660,20 +6197,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5660
6197
  is_spam?: boolean;
5661
6198
  /**
5662
6199
  * Filters for conversations where these users are participants.
5663
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6200
+ * @example ["DEVU-12345"]
5664
6201
  */
5665
6202
  members?: string[];
5666
6203
  /**
5667
6204
  * Filters for conversations owned by any of these users.
5668
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6205
+ * @example ["DEVU-12345"]
5669
6206
  */
5670
6207
  owned_by?: string[];
5671
6208
  /**
5672
6209
  * Filters for conversations that are associated with any of the
5673
6210
  * provided Rev organizations.
5674
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
6211
+ * @example ["REV-AbCdEfGh"]
5675
6212
  */
5676
6213
  rev_org?: string[];
6214
+ /** Filters for records with any of the provided SLA stages. */
6215
+ 'sla_summary.stage'?: SlaSummaryStage[];
5677
6216
  /** Filters for conversations with any of the provided source channels. */
5678
6217
  source_channels?: string[];
5679
6218
  /** Filters for records in the provided stage(s) by name. */
@@ -5681,12 +6220,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5681
6220
  /**
5682
6221
  * Filters for conversations with any of the provided tags.
5683
6222
  * @deprecated
5684
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
6223
+ * @example ["TAG-12345"]
5685
6224
  */
5686
6225
  tags?: string[];
5687
6226
  /**
5688
6227
  * The ID of the tag.
5689
- * @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
6228
+ * @example "TAG-12345"
5690
6229
  */
5691
6230
  'tags_v2.id'?: string;
5692
6231
  /**
@@ -5736,7 +6275,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5736
6275
  conversationsList: (query?: {
5737
6276
  /**
5738
6277
  * Filters for conversations belonging to any of the provided parts.
5739
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
6278
+ * @example ["PROD-12345"]
5740
6279
  */
5741
6280
  applies_to_parts?: string[];
5742
6281
  /**
@@ -5757,7 +6296,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5757
6296
  limit?: number;
5758
6297
  /**
5759
6298
  * Filters for conversations where these users are participants.
5760
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6299
+ * @example ["DEVU-12345"]
5761
6300
  */
5762
6301
  members?: string[];
5763
6302
  /**
@@ -5767,15 +6306,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5767
6306
  mode?: ListMode;
5768
6307
  /**
5769
6308
  * Filters for conversations owned by any of these users.
5770
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6309
+ * @example ["DEVU-12345"]
5771
6310
  */
5772
6311
  owned_by?: string[];
5773
6312
  /**
5774
6313
  * Filters for conversations that are associated with any of the
5775
6314
  * provided Rev organizations.
5776
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
6315
+ * @example ["REV-AbCdEfGh"]
5777
6316
  */
5778
6317
  rev_org?: string[];
6318
+ /** Filters for records with any of the provided SLA stages. */
6319
+ 'sla_summary.stage'?: SlaSummaryStage[];
5779
6320
  /** Filters for conversations with any of the provided source channels. */
5780
6321
  source_channels?: string[];
5781
6322
  /** Filters for records in the provided stage(s) by name. */
@@ -5783,12 +6324,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5783
6324
  /**
5784
6325
  * Filters for conversations with any of the provided tags.
5785
6326
  * @deprecated
5786
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
6327
+ * @example ["TAG-12345"]
5787
6328
  */
5788
6329
  tags?: string[];
5789
6330
  /**
5790
6331
  * The ID of the tag.
5791
- * @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
6332
+ * @example "TAG-12345"
5792
6333
  */
5793
6334
  'tags_v2.id'?: string;
5794
6335
  /**
@@ -5828,12 +6369,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5828
6369
  external_ref?: string[];
5829
6370
  /**
5830
6371
  * Filters for engagement of the provided members.
5831
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6372
+ * @example ["DEVU-12345"]
5832
6373
  */
5833
6374
  members?: string[];
5834
6375
  /**
5835
6376
  * Filters for engagements with the provided parent.
5836
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
6377
+ * @example ["ACC-12345"]
5837
6378
  */
5838
6379
  parent?: string[];
5839
6380
  /** Filters for engagement of the provided types. */
@@ -5910,7 +6451,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5910
6451
  limit?: number;
5911
6452
  /**
5912
6453
  * Filters for engagement of the provided members.
5913
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6454
+ * @example ["DEVU-12345"]
5914
6455
  */
5915
6456
  members?: string[];
5916
6457
  /**
@@ -5920,7 +6461,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5920
6461
  mode?: ListMode;
5921
6462
  /**
5922
6463
  * Filters for engagements with the provided parent.
5923
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
6464
+ * @example ["ACC-12345"]
5924
6465
  */
5925
6466
  parent?: string[];
5926
6467
  /** Fields to sort the engagements by and the direction to sort them. */
@@ -6195,7 +6736,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6195
6736
  /**
6196
6737
  * @description Ingest endpoint for DevRev metrics data from clients.
6197
6738
  *
6198
- * @tags telemetry
6739
+ * @tags product-usage
6199
6740
  * @name MetricsDevrevIngest
6200
6741
  * @request POST:/metrics.devrev.ingest
6201
6742
  * @secure
@@ -6365,7 +6906,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6365
6906
  partsGet: (query: {
6366
6907
  /**
6367
6908
  * The ID of the part to retrieve.
6368
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
6909
+ * @example "PROD-12345"
6369
6910
  */
6370
6911
  id: string;
6371
6912
  }, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any>>;
@@ -6389,7 +6930,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6389
6930
  partsList: (query?: {
6390
6931
  /**
6391
6932
  * Filters for parts created by any of these users.
6392
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6933
+ * @example ["DEVU-12345"]
6393
6934
  */
6394
6935
  created_by?: string[];
6395
6936
  /**
@@ -6411,9 +6952,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6411
6952
  name?: string[];
6412
6953
  /**
6413
6954
  * Filters for parts owned by any of these users.
6414
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6955
+ * @example ["DEVU-12345"]
6415
6956
  */
6416
6957
  owned_by?: string[];
6958
+ /**
6959
+ * Number of levels to fetch the part hierarchy up to.
6960
+ * @format int32
6961
+ * @min 1
6962
+ */
6963
+ 'parent_part.level'?: number;
6964
+ /**
6965
+ * Part IDs to fetch the hierarchy for. Required if any parent_part.*
6966
+ * fields are provided.
6967
+ * @minItems 1
6968
+ * @example ["PROD-12345"]
6969
+ */
6970
+ 'parent_part.parts'?: string[];
6417
6971
  /** Filters for parts of the provided type(s). */
6418
6972
  type?: PartType[];
6419
6973
  }, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
@@ -6456,12 +7010,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6456
7010
  /**
6457
7011
  * The ID of account for which default Rev organization is to be
6458
7012
  * fetched.
6459
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
7013
+ * @example "ACC-12345"
6460
7014
  */
6461
7015
  account?: string;
6462
7016
  /**
6463
7017
  * The ID of the required Rev organization.
6464
- * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
7018
+ * @example "REV-AbCdEfGh"
6465
7019
  */
6466
7020
  id?: string;
6467
7021
  }, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
@@ -6485,7 +7039,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6485
7039
  revOrgsList: (query?: {
6486
7040
  /**
6487
7041
  * Filters by account.
6488
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
7042
+ * @example ["ACC-12345"]
6489
7043
  */
6490
7044
  account?: string[];
6491
7045
  /** Filters by creator. */
@@ -6493,12 +7047,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6493
7047
  /**
6494
7048
  * Filters for objects created after the provided timestamp (inclusive).
6495
7049
  * @format date-time
7050
+ * @example "2023-01-01T12:00:00.000Z"
6496
7051
  */
6497
7052
  'created_date.after'?: string;
6498
7053
  /**
6499
7054
  * Filters for objects created before the provided timestamp
6500
7055
  * (inclusive).
6501
7056
  * @format date-time
7057
+ * @example "2023-01-01T12:00:00.000Z"
6502
7058
  */
6503
7059
  'created_date.before'?: string;
6504
7060
  /**
@@ -6511,6 +7067,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6511
7067
  * (custom_field_filter=field_name1:val1,val2,val3&custom_field_filter=field_name2:val1,val2).
6512
7068
  */
6513
7069
  custom_field_filter?: string[];
7070
+ /** Filters for custom fields. */
7071
+ custom_fields?: object;
6514
7072
  /** List of external refs to filter Rev organizations for. */
6515
7073
  external_ref?: string[];
6516
7074
  /**
@@ -6526,12 +7084,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6526
7084
  /**
6527
7085
  * Filters for objects created after the provided timestamp (inclusive).
6528
7086
  * @format date-time
7087
+ * @example "2023-01-01T12:00:00.000Z"
6529
7088
  */
6530
7089
  'modified_date.after'?: string;
6531
7090
  /**
6532
7091
  * Filters for objects created before the provided timestamp
6533
7092
  * (inclusive).
6534
7093
  * @format date-time
7094
+ * @example "2023-01-01T12:00:00.000Z"
6535
7095
  */
6536
7096
  'modified_date.before'?: string;
6537
7097
  /**
@@ -6539,6 +7099,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6539
7099
  * them.
6540
7100
  */
6541
7101
  sort_by?: string[];
7102
+ /** List of tags to be filtered. */
7103
+ tags?: string[];
6542
7104
  }, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any>>;
6543
7105
  /**
6544
7106
  * @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
@@ -6620,12 +7182,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6620
7182
  /**
6621
7183
  * Filters for objects created after the provided timestamp (inclusive).
6622
7184
  * @format date-time
7185
+ * @example "2023-01-01T12:00:00.000Z"
6623
7186
  */
6624
7187
  'created_date.after'?: string;
6625
7188
  /**
6626
7189
  * Filters for objects created before the provided timestamp
6627
7190
  * (inclusive).
6628
7191
  * @format date-time
7192
+ * @example "2023-01-01T12:00:00.000Z"
6629
7193
  */
6630
7194
  'created_date.before'?: string;
6631
7195
  /**
@@ -6633,6 +7197,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6633
7197
  * starts from the beginning.
6634
7198
  */
6635
7199
  cursor?: string;
7200
+ /** Filters for custom fields. */
7201
+ custom_fields?: object;
6636
7202
  /** List of emails of Rev users to be filtered. */
6637
7203
  email?: string[];
6638
7204
  /** List of external refs to filter Rev users for. */
@@ -6652,23 +7218,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6652
7218
  /**
6653
7219
  * Filters for objects created after the provided timestamp (inclusive).
6654
7220
  * @format date-time
7221
+ * @example "2023-01-01T12:00:00.000Z"
6655
7222
  */
6656
7223
  'modified_date.after'?: string;
6657
7224
  /**
6658
7225
  * Filters for objects created before the provided timestamp
6659
7226
  * (inclusive).
6660
7227
  * @format date-time
7228
+ * @example "2023-01-01T12:00:00.000Z"
6661
7229
  */
6662
7230
  'modified_date.before'?: string;
6663
7231
  /** List of phone numbers to filter Rev users on. */
6664
7232
  phone_numbers?: string[];
6665
7233
  /**
6666
7234
  * List of IDs of Rev organizations to be filtered.
6667
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
7235
+ * @example ["REV-AbCdEfGh"]
6668
7236
  */
6669
7237
  rev_org?: string[];
6670
7238
  /** Fields to sort the Rev users by and the direction to sort them. */
6671
7239
  sort_by?: string[];
7240
+ /** List of tags to be filtered. */
7241
+ tags?: string[];
6672
7242
  }, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
6673
7243
  /**
6674
7244
  * @description Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.
@@ -6757,6 +7327,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6757
7327
  * iteration starts from the beginning.
6758
7328
  */
6759
7329
  cursor?: string;
7330
+ /** Whether only deprecated fragments should be filtered. */
7331
+ deprecated?: boolean;
6760
7332
  /** The list of leaf types. */
6761
7333
  leaf_type?: string[];
6762
7334
  /**
@@ -6995,7 +7567,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6995
7567
  timelineEntriesList: (query: {
6996
7568
  /**
6997
7569
  * The ID of the object to list timeline entries for.
6998
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
7570
+ * @example "PROD-12345"
6999
7571
  */
7000
7572
  object: string;
7001
7573
  /**
@@ -7051,6 +7623,115 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7051
7623
  * @secure
7052
7624
  */
7053
7625
  timelineEntriesUpdate: (data: TimelineEntriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesUpdateResponse, any>>;
7626
+ /**
7627
+ * @description Creates a Unit of Measurement on a part.
7628
+ *
7629
+ * @tags product-usage
7630
+ * @name UomsCreate
7631
+ * @request POST:/uoms.create
7632
+ * @secure
7633
+ */
7634
+ uomsCreate: (data: UomsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<UomsCreateResponse, any>>;
7635
+ /**
7636
+ * @description Deletes a Unit of Measurement.
7637
+ *
7638
+ * @tags product-usage
7639
+ * @name UomsDelete
7640
+ * @request POST:/uoms.delete
7641
+ * @secure
7642
+ */
7643
+ uomsDelete: (data: UomsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
7644
+ /**
7645
+ * @description Gets a Unit of Measurement.
7646
+ *
7647
+ * @tags product-usage
7648
+ * @name UomsGet
7649
+ * @request GET:/uoms.get
7650
+ * @secure
7651
+ */
7652
+ uomsGet: (query: {
7653
+ /** The Unit of Measurement (UOM)'s DON. */
7654
+ id: string;
7655
+ }, params?: RequestParams) => Promise<AxiosResponse<UomsGetResponse, any>>;
7656
+ /**
7657
+ * @description Gets a Unit of Measurement.
7658
+ *
7659
+ * @tags product-usage
7660
+ * @name UomsGetPost
7661
+ * @request POST:/uoms.get
7662
+ * @secure
7663
+ */
7664
+ uomsGetPost: (data: UomsGetRequest, params?: RequestParams) => Promise<AxiosResponse<UomsGetResponse, any>>;
7665
+ /**
7666
+ * @description Gets the Unit of Measurements based on the given filters.
7667
+ *
7668
+ * @tags product-usage
7669
+ * @name UomsList
7670
+ * @request GET:/uoms.list
7671
+ * @secure
7672
+ */
7673
+ uomsList: (query?: {
7674
+ /** List of aggregation types for filtering list of UOMs. */
7675
+ aggregation_types?: AggregationDetailAggregationType[];
7676
+ /**
7677
+ * The cursor to resume iteration from. If not provided, then iteration
7678
+ * starts from the beginning.
7679
+ */
7680
+ cursor?: string;
7681
+ /**
7682
+ * List of Unit of Measurement (UOM) DONs to be used in filtering
7683
+ * complete list of UOMs defined in a Dev Org.
7684
+ */
7685
+ ids?: string[];
7686
+ /**
7687
+ * The maximum number of UOMs to be returned in a response. The default
7688
+ * is '50'.
7689
+ * @format int32
7690
+ */
7691
+ limit?: number;
7692
+ /** List of metric names for filtering list of UOMs. */
7693
+ metric_names?: string[];
7694
+ /**
7695
+ * The iteration mode to use, otherwise if not set, then "after" is
7696
+ * used.
7697
+ */
7698
+ mode?: ListMode;
7699
+ /**
7700
+ * List of part IDs for filtering list of UOMs.
7701
+ * @example ["PROD-12345"]
7702
+ */
7703
+ part_ids?: string[];
7704
+ /**
7705
+ * List of product IDs for filtering list of UOMs.
7706
+ * @example ["PROD-12345"]
7707
+ */
7708
+ product_ids?: string[];
7709
+ /**
7710
+ * Fields to sort the Unit Of Measuments (UOMs) by and the direction to
7711
+ * sort them.
7712
+ */
7713
+ sort_by?: string[];
7714
+ /** List of unit types for filtering list of UOMs. */
7715
+ unit_types?: UnitType[];
7716
+ }, params?: RequestParams) => Promise<AxiosResponse<UomsListResponse, any>>;
7717
+ /**
7718
+ * @description Gets the Unit of Measurements based on the given filters.
7719
+ *
7720
+ * @tags product-usage
7721
+ * @name UomsListPost
7722
+ * @request POST:/uoms.list
7723
+ * @secure
7724
+ */
7725
+ uomsListPost: (data: UomsListRequest, params?: RequestParams) => Promise<AxiosResponse<UomsListResponse, any>>;
7726
+ /**
7727
+ * @description Updates a Unit of Measurement.
7728
+ *
7729
+ * @tags product-usage
7730
+ * @name UomsUpdate
7731
+ * @request POST:/uoms.update
7732
+ * @secure
7733
+ */
7734
+ uomsUpdate: (data: UomsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<UomsUpdateResponse, any>>;
7054
7735
  /**
7055
7736
  * @description Creates new work ([issue](https://devrev.ai/docs/product/build), [ticket](https://devrev.ai/docs/product/support)) item. [task](https://docs.devrev.ai/product/tasks) and opportunity work types are supported in the beta version.
7056
7737
  *
@@ -7080,12 +7761,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7080
7761
  worksExport: (query?: {
7081
7762
  /**
7082
7763
  * Filters for work belonging to any of the provided parts.
7083
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
7764
+ * @example ["PROD-12345"]
7084
7765
  */
7085
7766
  applies_to_part?: string[];
7086
7767
  /**
7087
7768
  * Filters for work created by any of these users.
7088
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
7769
+ * @example ["DEVU-12345"]
7089
7770
  */
7090
7771
  created_by?: string[];
7091
7772
  /** Filters for custom fields. */
@@ -7100,19 +7781,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7100
7781
  'issue.priority'?: IssuePriority[];
7101
7782
  /**
7102
7783
  * Filters for issues with any of the provided Rev organizations.
7103
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
7784
+ * @example ["REV-AbCdEfGh"]
7104
7785
  */
7105
7786
  'issue.rev_orgs'?: string[];
7106
7787
  /**
7107
7788
  * Filters for opportunities belonging to any of the provided accounts.
7108
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
7789
+ * @example ["ACC-12345"]
7109
7790
  */
7110
7791
  'opportunity.account'?: string[];
7111
7792
  /** Filters for opportunities with any of the provided contacts. */
7112
7793
  'opportunity.contacts'?: string[];
7113
7794
  /**
7114
7795
  * Filters for work owned by any of these users.
7115
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
7796
+ * @example ["DEVU-12345"]
7116
7797
  */
7117
7798
  owned_by?: string[];
7118
7799
  /** Fields to sort the work items by and the direction to sort them. */
@@ -7121,7 +7802,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7121
7802
  'stage.name'?: string[];
7122
7803
  /**
7123
7804
  * Filters for work with any of the provided tags.
7124
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
7805
+ * @example ["TAG-12345"]
7125
7806
  */
7126
7807
  tags?: string[];
7127
7808
  /** Filters for tickets belonging to specific groups. */
@@ -7133,11 +7814,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7133
7814
  /**
7134
7815
  * Filters for tickets that are associated with any of the provided Rev
7135
7816
  * organizations.
7136
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
7817
+ * @example ["REV-AbCdEfGh"]
7137
7818
  */
7138
7819
  'ticket.rev_org'?: string[];
7139
7820
  /** Filters for tickets with any of the provided severities. */
7140
7821
  'ticket.severity'?: TicketSeverity[];
7822
+ /** Filters for records with any of the provided SLA stages. */
7823
+ 'ticket.sla_summary.stage'?: SlaSummaryStage[];
7141
7824
  /** Filters for tickets with any of the provided source channels. */
7142
7825
  'ticket.source_channel'?: string[];
7143
7826
  /** Filters for work of the provided types. */
@@ -7163,7 +7846,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7163
7846
  worksGet: (query: {
7164
7847
  /**
7165
7848
  * The work's ID.
7166
- * @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
7849
+ * @example "ISS-12345"
7167
7850
  */
7168
7851
  id: string;
7169
7852
  }, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any>>;
@@ -7187,12 +7870,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7187
7870
  worksList: (query?: {
7188
7871
  /**
7189
7872
  * Filters for work belonging to any of the provided parts.
7190
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
7873
+ * @example ["PROD-12345"]
7191
7874
  */
7192
7875
  applies_to_part?: string[];
7193
7876
  /**
7194
7877
  * Filters for work created by any of these users.
7195
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
7878
+ * @example ["DEVU-12345"]
7196
7879
  */
7197
7880
  created_by?: string[];
7198
7881
  /**
@@ -7206,7 +7889,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7206
7889
  'issue.priority'?: IssuePriority[];
7207
7890
  /**
7208
7891
  * Filters for issues with any of the provided Rev organizations.
7209
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
7892
+ * @example ["REV-AbCdEfGh"]
7210
7893
  */
7211
7894
  'issue.rev_orgs'?: string[];
7212
7895
  /**
@@ -7221,14 +7904,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7221
7904
  mode?: ListMode;
7222
7905
  /**
7223
7906
  * Filters for opportunities belonging to any of the provided accounts.
7224
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
7907
+ * @example ["ACC-12345"]
7225
7908
  */
7226
7909
  'opportunity.account'?: string[];
7227
7910
  /** Filters for opportunities with any of the provided contacts. */
7228
7911
  'opportunity.contacts'?: string[];
7229
7912
  /**
7230
7913
  * Filters for work owned by any of these users.
7231
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
7914
+ * @example ["DEVU-12345"]
7232
7915
  */
7233
7916
  owned_by?: string[];
7234
7917
  /** Fields to sort the works by and the direction to sort them. */
@@ -7237,7 +7920,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7237
7920
  'stage.name'?: string[];
7238
7921
  /**
7239
7922
  * Filters for work with any of the provided tags.
7240
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
7923
+ * @example ["TAG-12345"]
7241
7924
  */
7242
7925
  tags?: string[];
7243
7926
  /** Filters for tickets belonging to specific groups. */
@@ -7249,11 +7932,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7249
7932
  /**
7250
7933
  * Filters for tickets that are associated with any of the provided Rev
7251
7934
  * organizations.
7252
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
7935
+ * @example ["REV-AbCdEfGh"]
7253
7936
  */
7254
7937
  'ticket.rev_org'?: string[];
7255
7938
  /** Filters for tickets with any of the provided severities. */
7256
7939
  'ticket.severity'?: TicketSeverity[];
7940
+ /** Filters for records with any of the provided SLA stages. */
7941
+ 'ticket.sla_summary.stage'?: SlaSummaryStage[];
7257
7942
  /** Filters for tickets with any of the provided source channels. */
7258
7943
  'ticket.source_channel'?: string[];
7259
7944
  /** Filters for work of the provided types. */