@devrev/typescript-sdk 1.1.16 → 1.1.17

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
  }
@@ -142,7 +142,7 @@ export interface AccountsExportResponse {
142
142
  export interface AccountsGetRequest {
143
143
  /**
144
144
  * The ID of the account to be retrieved.
145
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
145
+ * @example "ACC-12345"
146
146
  */
147
147
  id: string;
148
148
  }
@@ -233,7 +233,7 @@ export interface AccountsUpdateRequest {
233
233
  external_refs?: string[];
234
234
  /**
235
235
  * The ID of account to update.
236
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
236
+ * @example "ACC-12345"
237
237
  */
238
238
  id: string;
239
239
  /** Updated list of the users owning this account. */
@@ -252,7 +252,7 @@ export interface AccountsUpdateRequest {
252
252
  export interface AccountsUpdateRequestArtifacts {
253
253
  /**
254
254
  * Sets the IDs to the provided artifact IDs.
255
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
255
+ * @example ["ARTIFACT-12345"]
256
256
  */
257
257
  set?: string[];
258
258
  }
@@ -282,6 +282,72 @@ export interface AggregatedSchemaGetResponse {
282
282
  /** List of custom fields from multiple source fragments. */
283
283
  schema: AggregatedSchema;
284
284
  }
285
+ /**
286
+ * aggregation-detail
287
+ * Stores aggregation type and dimension information.
288
+ */
289
+ export interface AggregationDetail {
290
+ /**
291
+ * Aggregation type to be used while aggregating the metering data for the
292
+ * UOM. 1] Sum - sum of all the values for the meter in a given period Ex.
293
+ * { M1:2, M1:4 } => {M1:6} 2] Minimum - min of all the values for the
294
+ * meter in a given period Ex. { M1:2, M1:4 } => {M1:2} 3] Maximum - max
295
+ * of all the values for the meter in a given period Ex. { M1:2, M1:4 } =>
296
+ * {M1:4} 4] Unique Count - Sum of distinct unique dimension observed for
297
+ * the meter in the given period (not considering the data from the
298
+ * previous billing period) Ex. January {M1:{VM:VM0}}, February
299
+ * {M1:{VM:VM1}, M1:{VM:VM2}, M1:{VM:VM1}} => {M1:2} 5] Running Total -
300
+ * Sum of distinct active unique dimension observed for a meter in the
301
+ * given period, taking into consideration the active data from the
302
+ * previous billing cycle Ex. January {M1:{VM:VM0,on}, {M1:{VM:VM1,off}
303
+ * February {M1:{VM:VM2, on}, M1:{VM:VM2, off}, M1:{VM:VM3, on}} => {M1:3}
304
+ * 6] Duration - Sum of distinct active unique dimension duration for a
305
+ * meter in the given period, taking into consideration the active data
306
+ * from the previous month Ex. January15 {M1:{VM:VM0,on, 4}} February15
307
+ * {M1:{VM:VM0,off}, February18 {M1:{VM:VM1,on,5} => M1->
308
+ * 30*4*charge_per_day + 10*5*charge_per_day 7] Latest - consider the
309
+ * latest/last meter in the given period 8] Oldest - consider the
310
+ * oldest/first record in the given period.
311
+ */
312
+ aggregation_type: AggregationDetailAggregationType;
313
+ /**
314
+ * Unique dimension if provided to be considered for grouping metering
315
+ * data for the UOM.
316
+ */
317
+ unique_dimension?: string;
318
+ }
319
+ /**
320
+ * Aggregation type to be used while aggregating the metering data for the
321
+ * UOM. 1] Sum - sum of all the values for the meter in a given period Ex.
322
+ * { M1:2, M1:4 } => {M1:6} 2] Minimum - min of all the values for the
323
+ * meter in a given period Ex. { M1:2, M1:4 } => {M1:2} 3] Maximum - max
324
+ * of all the values for the meter in a given period Ex. { M1:2, M1:4 } =>
325
+ * {M1:4} 4] Unique Count - Sum of distinct unique dimension observed for
326
+ * the meter in the given period (not considering the data from the
327
+ * previous billing period) Ex. January {M1:{VM:VM0}}, February
328
+ * {M1:{VM:VM1}, M1:{VM:VM2}, M1:{VM:VM1}} => {M1:2} 5] Running Total -
329
+ * Sum of distinct active unique dimension observed for a meter in the
330
+ * given period, taking into consideration the active data from the
331
+ * previous billing cycle Ex. January {M1:{VM:VM0,on}, {M1:{VM:VM1,off}
332
+ * February {M1:{VM:VM2, on}, M1:{VM:VM2, off}, M1:{VM:VM3, on}} => {M1:3}
333
+ * 6] Duration - Sum of distinct active unique dimension duration for a
334
+ * meter in the given period, taking into consideration the active data
335
+ * from the previous month Ex. January15 {M1:{VM:VM0,on, 4}} February15
336
+ * {M1:{VM:VM0,off}, February18 {M1:{VM:VM1,on,5} => M1->
337
+ * 30*4*charge_per_day + 10*5*charge_per_day 7] Latest - consider the
338
+ * latest/last meter in the given period 8] Oldest - consider the
339
+ * oldest/first record in the given period.
340
+ */
341
+ export declare enum AggregationDetailAggregationType {
342
+ Duration = "duration",
343
+ Latest = "latest",
344
+ Maximum = "maximum",
345
+ Minimum = "minimum",
346
+ Oldest = "oldest",
347
+ RunningTotal = "running_total",
348
+ Sum = "sum",
349
+ UniqueCount = "unique_count"
350
+ }
285
351
  /** app-fragment */
286
352
  export type AppFragment = CustomSchemaFragmentBase;
287
353
  /** article */
@@ -308,22 +374,22 @@ export declare enum ArticleStatus {
308
374
  export interface ArticlesCountRequest {
309
375
  /**
310
376
  * Filters for articles belonging to any of the provided parts.
311
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
377
+ * @example ["PROD-12345"]
312
378
  */
313
379
  applies_to_parts?: string[];
314
380
  /**
315
381
  * Filters for articles authored by any of the provided users.
316
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
382
+ * @example ["DEVU-12345"]
317
383
  */
318
384
  authored_by?: string[];
319
385
  /**
320
386
  * Filters for articles created by any of the provided users.
321
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
387
+ * @example ["DEVU-12345"]
322
388
  */
323
389
  created_by?: string[];
324
390
  /**
325
391
  * Filters for articles owned by any of the provided users.
326
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
392
+ * @example ["DEVU-12345"]
327
393
  */
328
394
  owned_by?: string[];
329
395
  }
@@ -344,31 +410,32 @@ export interface ArticlesCreateRequest {
344
410
  /**
345
411
  * The parts that the article applies to.
346
412
  * @minItems 1
347
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
413
+ * @example ["PROD-12345"]
348
414
  */
349
415
  applies_to_parts: string[];
350
416
  /**
351
417
  * The authors of the article.
352
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
418
+ * @example ["DEVU-12345"]
353
419
  */
354
420
  authored_by?: string[];
355
421
  /** Description for the article. */
356
422
  description?: string;
357
423
  /**
358
424
  * ID of the extracted content artifact.
359
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
425
+ * @example ["ARTIFACT-12345"]
360
426
  */
361
427
  extracted_content?: string[];
362
428
  /** Language of the article. */
363
429
  language?: string;
364
430
  /**
365
431
  * The users that own the article.
366
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
432
+ * @example ["DEVU-12345"]
367
433
  */
368
434
  owned_by?: string[];
369
435
  /**
370
436
  * The published date of the article.
371
437
  * @format date-time
438
+ * @example "2023-01-01T12:00:00.000Z"
372
439
  */
373
440
  published_at?: string;
374
441
  resource: ArticlesCreateRequestResource;
@@ -383,9 +450,11 @@ export interface ArticlesCreateRequest {
383
450
  export interface ArticlesCreateRequestResource {
384
451
  /**
385
452
  * IDs of the artifacts.
386
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
453
+ * @example ["ARTIFACT-12345"]
387
454
  */
388
455
  artifacts?: string[];
456
+ /** The latest published version. */
457
+ published_version?: string;
389
458
  /** URL of the external article. */
390
459
  url?: string;
391
460
  }
@@ -403,7 +472,7 @@ export interface ArticlesCreateResponse {
403
472
  export interface ArticlesDeleteRequest {
404
473
  /**
405
474
  * The ID of the article to delete.
406
- * @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
475
+ * @example "ARTICLE-12345"
407
476
  */
408
477
  id: string;
409
478
  }
@@ -416,7 +485,7 @@ export type ArticlesDeleteResponse = object;
416
485
  export interface ArticlesGetRequest {
417
486
  /**
418
487
  * The ID of the required article.
419
- * @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
488
+ * @example "ARTICLE-12345"
420
489
  */
421
490
  id: string;
422
491
  }
@@ -434,17 +503,17 @@ export interface ArticlesGetResponse {
434
503
  export interface ArticlesListRequest {
435
504
  /**
436
505
  * Filters for articles belonging to any of the provided parts.
437
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
506
+ * @example ["PROD-12345"]
438
507
  */
439
508
  applies_to_parts?: string[];
440
509
  /**
441
510
  * Filters for articles authored by any of the provided users.
442
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
511
+ * @example ["DEVU-12345"]
443
512
  */
444
513
  authored_by?: string[];
445
514
  /**
446
515
  * Filters for articles created by any of the provided users.
447
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
516
+ * @example ["DEVU-12345"]
448
517
  */
449
518
  created_by?: string[];
450
519
  /**
@@ -467,7 +536,7 @@ export interface ArticlesListRequest {
467
536
  mode?: ListMode;
468
537
  /**
469
538
  * Filters for articles owned by any of the provided users.
470
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
539
+ * @example ["DEVU-12345"]
471
540
  */
472
541
  owned_by?: string[];
473
542
  }
@@ -511,12 +580,14 @@ export interface ArticlesUpdateRequest {
511
580
  extracted_content?: ArticlesUpdateRequestExtractedContent;
512
581
  /**
513
582
  * The article's ID.
514
- * @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
583
+ * @example "ARTICLE-12345"
515
584
  */
516
585
  id: string;
517
586
  /** Updates the language of the article. */
518
587
  language?: string;
519
588
  owned_by?: ArticlesUpdateRequestOwnedBy;
589
+ /** Updates the the latest published version. */
590
+ published_version?: string;
520
591
  /** Status of the article. */
521
592
  status?: ArticleStatus;
522
593
  tags?: ArticlesUpdateRequestTags;
@@ -529,7 +600,7 @@ export interface ArticlesUpdateRequest {
529
600
  export interface ArticlesUpdateRequestAppliesToParts {
530
601
  /**
531
602
  * Updates the parts that the article applies to.
532
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
603
+ * @example ["PROD-12345"]
533
604
  */
534
605
  set?: string[];
535
606
  }
@@ -537,7 +608,7 @@ export interface ArticlesUpdateRequestAppliesToParts {
537
608
  export interface ArticlesUpdateRequestArtifacts {
538
609
  /**
539
610
  * Updates IDs of the artifacts.
540
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
611
+ * @example ["ARTIFACT-12345"]
541
612
  */
542
613
  set?: string[];
543
614
  }
@@ -545,7 +616,7 @@ export interface ArticlesUpdateRequestArtifacts {
545
616
  export interface ArticlesUpdateRequestAuthoredBy {
546
617
  /**
547
618
  * Sets the users that authored the article.
548
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
619
+ * @example ["DEVU-12345"]
549
620
  */
550
621
  set?: string[];
551
622
  }
@@ -553,7 +624,7 @@ export interface ArticlesUpdateRequestAuthoredBy {
553
624
  export interface ArticlesUpdateRequestExtractedContent {
554
625
  /**
555
626
  * Update the ID of the extracted content.
556
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
627
+ * @example ["ARTIFACT-12345"]
557
628
  */
558
629
  set?: string[];
559
630
  }
@@ -562,7 +633,7 @@ export interface ArticlesUpdateRequestOwnedBy {
562
633
  /**
563
634
  * Sets the owner IDs to the provided user IDs. This must not be
564
635
  * empty.
565
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
636
+ * @example ["DEVU-12345"]
566
637
  */
567
638
  set?: string[];
568
639
  }
@@ -596,7 +667,7 @@ export interface ArtifactsPrepareResponse {
596
667
  form_data: ArtifactsPrepareResponseFormData[];
597
668
  /**
598
669
  * The generated artifact's ID.
599
- * @example "don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"
670
+ * @example "ARTIFACT-12345"
600
671
  */
601
672
  id: string;
602
673
  /** The URL that the file's data should be uploaded to. */
@@ -616,7 +687,7 @@ export interface ArtifactsPrepareResponseFormData {
616
687
  export interface ArtifactsVersionsPrepareRequest {
617
688
  /**
618
689
  * The ID of the artifact to prepare a new version for.
619
- * @example "don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"
690
+ * @example "ARTIFACT-12345"
620
691
  */
621
692
  id: string;
622
693
  }
@@ -643,6 +714,7 @@ export interface AtomBase {
643
714
  /**
644
715
  * Timestamp when the object was created.
645
716
  * @format date-time
717
+ * @example "2023-01-01T12:00:00.000Z"
646
718
  */
647
719
  created_date?: string;
648
720
  /** Human-readable object ID unique to the Dev organization. */
@@ -653,6 +725,7 @@ export interface AtomBase {
653
725
  /**
654
726
  * Timestamp when the object was last modified.
655
727
  * @format date-time
728
+ * @example "2023-01-01T12:00:00.000Z"
656
729
  */
657
730
  modified_date?: string;
658
731
  }
@@ -714,7 +787,7 @@ export interface ConversationsCreateRequest {
714
787
  is_spam?: boolean;
715
788
  /**
716
789
  * The users in the conversation.
717
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
790
+ * @example ["DEVU-12345"]
718
791
  */
719
792
  members?: string[];
720
793
  /** Initial messages on the conversation. */
@@ -736,7 +809,7 @@ export interface ConversationsCreateRequest {
736
809
  export interface ConversationsCreateRequestMessage {
737
810
  /**
738
811
  * The IDs of the artifacts to the message.
739
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
812
+ * @example ["ARTIFACT-12345"]
740
813
  */
741
814
  artifacts?: string[];
742
815
  /** The message's body. */
@@ -773,7 +846,7 @@ export type ConversationsDeleteResponse = object;
773
846
  export interface ConversationsExportRequest {
774
847
  /**
775
848
  * Filters for conversations belonging to any of the provided parts.
776
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
849
+ * @example ["PROD-12345"]
777
850
  */
778
851
  applies_to_parts?: string[];
779
852
  /**
@@ -790,18 +863,18 @@ export interface ConversationsExportRequest {
790
863
  is_spam?: boolean;
791
864
  /**
792
865
  * Filters for conversations where these users are participants.
793
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
866
+ * @example ["DEVU-12345"]
794
867
  */
795
868
  members?: string[];
796
869
  /**
797
870
  * Filters for conversations owned by any of these users.
798
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
871
+ * @example ["DEVU-12345"]
799
872
  */
800
873
  owned_by?: string[];
801
874
  /**
802
875
  * Filters for conversations that are associated with any of the
803
876
  * provided Rev organizations.
804
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
877
+ * @example ["REV-AbCdEfGh"]
805
878
  */
806
879
  rev_org?: string[];
807
880
  /** The filter for SLA summary. */
@@ -813,7 +886,7 @@ export interface ConversationsExportRequest {
813
886
  /**
814
887
  * Filters for conversations with any of the provided tags.
815
888
  * @deprecated
816
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
889
+ * @example ["TAG-12345"]
817
890
  */
818
891
  tags?: string[];
819
892
  /** Filters for conversations with any of the provided tags with value. */
@@ -846,7 +919,7 @@ export interface ConversationsGetResponse {
846
919
  export interface ConversationsListRequest {
847
920
  /**
848
921
  * Filters for conversations belonging to any of the provided parts.
849
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
922
+ * @example ["PROD-12345"]
850
923
  */
851
924
  applies_to_parts?: string[];
852
925
  /**
@@ -867,7 +940,7 @@ export interface ConversationsListRequest {
867
940
  limit?: number;
868
941
  /**
869
942
  * Filters for conversations where these users are participants.
870
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
943
+ * @example ["DEVU-12345"]
871
944
  */
872
945
  members?: string[];
873
946
  /**
@@ -880,13 +953,13 @@ export interface ConversationsListRequest {
880
953
  mode?: ListMode;
881
954
  /**
882
955
  * Filters for conversations owned by any of these users.
883
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
956
+ * @example ["DEVU-12345"]
884
957
  */
885
958
  owned_by?: string[];
886
959
  /**
887
960
  * Filters for conversations that are associated with any of the
888
961
  * provided Rev organizations.
889
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
962
+ * @example ["REV-AbCdEfGh"]
890
963
  */
891
964
  rev_org?: string[];
892
965
  /** The filter for SLA summary. */
@@ -898,7 +971,7 @@ export interface ConversationsListRequest {
898
971
  /**
899
972
  * Filters for conversations with any of the provided tags.
900
973
  * @deprecated
901
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
974
+ * @example ["TAG-12345"]
902
975
  */
903
976
  tags?: string[];
904
977
  /** Filters for conversations with any of the provided tags with value. */
@@ -950,7 +1023,7 @@ export interface ConversationsUpdateRequest {
950
1023
  export interface ConversationsUpdateRequestAppliesToParts {
951
1024
  /**
952
1025
  * Updates the parts that the conversation applies to.
953
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
1026
+ * @example ["PROD-12345"]
954
1027
  */
955
1028
  set?: string[];
956
1029
  }
@@ -980,6 +1053,7 @@ export interface CreateOrgScheduleInterval {
980
1053
  /**
981
1054
  * Date (inclusive) on which the interval begins.
982
1055
  * @format date-time
1056
+ * @example "2023-01-01T12:00:00.000Z"
983
1057
  */
984
1058
  from: string;
985
1059
  /**
@@ -996,6 +1070,7 @@ export interface CreateOrgScheduleInterval {
996
1070
  * Date (exclusive) on which the interval ends. If omitted, it is a
997
1071
  * single day interval.
998
1072
  * @format date-time
1073
+ * @example "2023-01-01T12:00:00.000Z"
999
1074
  */
1000
1075
  to?: string;
1001
1076
  }
@@ -1148,12 +1223,14 @@ export interface DateTimeFilter {
1148
1223
  * Filters for objects created after the provided timestamp
1149
1224
  * (inclusive).
1150
1225
  * @format date-time
1226
+ * @example "2023-01-01T12:00:00.000Z"
1151
1227
  */
1152
1228
  after?: string;
1153
1229
  /**
1154
1230
  * Filters for objects created before the provided timestamp
1155
1231
  * (inclusive).
1156
1232
  * @format date-time
1233
+ * @example "2023-01-01T12:00:00.000Z"
1157
1234
  */
1158
1235
  before?: string;
1159
1236
  }
@@ -1215,12 +1292,12 @@ export interface EngagementsCountRequest {
1215
1292
  external_ref?: string[];
1216
1293
  /**
1217
1294
  * Filters for engagement of the provided members.
1218
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
1295
+ * @example ["DEVU-12345"]
1219
1296
  */
1220
1297
  members?: string[];
1221
1298
  /**
1222
1299
  * Filters for engagements with the provided parent.
1223
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
1300
+ * @example ["ACC-12345"]
1224
1301
  */
1225
1302
  parent?: string[];
1226
1303
  /** Filters for engagement of the provided types. */
@@ -1238,7 +1315,7 @@ export interface EngagementsCountResponse {
1238
1315
  export interface EngagementsCreateRequest {
1239
1316
  /**
1240
1317
  * The IDs of the artifacts to associate with the engagement.
1241
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
1318
+ * @example ["ARTIFACT-12345"]
1242
1319
  */
1243
1320
  artifacts?: string[];
1244
1321
  /** The description of the engagement. */
@@ -1252,18 +1329,19 @@ export interface EngagementsCreateRequest {
1252
1329
  /**
1253
1330
  * IDs of the users that were part of the engagement.
1254
1331
  * @maxItems 50
1255
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
1332
+ * @example ["DEVU-12345"]
1256
1333
  */
1257
1334
  members?: string[];
1258
1335
  /**
1259
1336
  * The parent object ID in which the engagement was created.
1260
1337
  * Currently, only accounts and opportunities are supported.
1261
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
1338
+ * @example "ACC-12345"
1262
1339
  */
1263
1340
  parent: string;
1264
1341
  /**
1265
1342
  * The date and time when the engagement was scheduled.
1266
1343
  * @format date-time
1344
+ * @example "2023-01-01T12:00:00.000Z"
1267
1345
  */
1268
1346
  scheduled_date?: string;
1269
1347
  /** Tags associated with the engagement. */
@@ -1315,7 +1393,7 @@ export interface EngagementsListRequest {
1315
1393
  limit?: number;
1316
1394
  /**
1317
1395
  * Filters for engagement of the provided members.
1318
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
1396
+ * @example ["DEVU-12345"]
1319
1397
  */
1320
1398
  members?: string[];
1321
1399
  /**
@@ -1328,7 +1406,7 @@ export interface EngagementsListRequest {
1328
1406
  mode?: ListMode;
1329
1407
  /**
1330
1408
  * Filters for engagements with the provided parent.
1331
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
1409
+ * @example ["ACC-12345"]
1332
1410
  */
1333
1411
  parent?: string[];
1334
1412
  /** Fields to sort the engagements by and the direction to sort them. */
@@ -1366,6 +1444,7 @@ export interface EngagementsUpdateRequest {
1366
1444
  /**
1367
1445
  * Updates the date and time when the engagement was scheduled.
1368
1446
  * @format date-time
1447
+ * @example "2023-01-01T12:00:00.000Z"
1369
1448
  */
1370
1449
  scheduled_date?: string | null;
1371
1450
  tags?: EngagementsUpdateRequestTags;
@@ -1376,7 +1455,7 @@ export interface EngagementsUpdateRequest {
1376
1455
  export interface EngagementsUpdateRequestArtifactIds {
1377
1456
  /**
1378
1457
  * Sets the IDs to the provided artifact IDs.
1379
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
1458
+ * @example ["ARTIFACT-12345"]
1380
1459
  */
1381
1460
  set?: string[];
1382
1461
  }
@@ -1386,7 +1465,7 @@ export interface EngagementsUpdateRequestMembers {
1386
1465
  * Sets the members to the provided user IDs. If specified, this must
1387
1466
  * not be empty.
1388
1467
  * @maxItems 50
1389
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
1468
+ * @example ["DEVU-12345"]
1390
1469
  */
1391
1470
  set?: string[];
1392
1471
  }
@@ -1400,13 +1479,7 @@ export interface EngagementsUpdateResponse {
1400
1479
  engagement: Engagement;
1401
1480
  }
1402
1481
  /** 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
- };
1482
+ export type Enhancement = PartBase;
1410
1483
  /** enhancement-summary */
1411
1484
  export type EnhancementSummary = PartBaseSummary;
1412
1485
  /** error */
@@ -1422,7 +1495,7 @@ export interface Error {
1422
1495
  type?: string;
1423
1496
  }
1424
1497
  /** error-bad-request */
1425
- export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestValueNotPermitted) & {
1498
+ export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestValueNotPermitted) & {
1426
1499
  type: ErrorBadRequestType;
1427
1500
  };
1428
1501
  /** error-bad-request-bad-request */
@@ -1441,6 +1514,17 @@ export interface ErrorBadRequestInvalidField {
1441
1514
  /** The field name that's invalid. */
1442
1515
  field_name: string;
1443
1516
  }
1517
+ /** error-bad-request-missing-dependency */
1518
+ export interface ErrorBadRequestMissingDependency {
1519
+ /** The field on which the value depends. */
1520
+ dependent_field_name?: string;
1521
+ /** The value which needs to be set of the dependent field. */
1522
+ dependent_field_value?: string;
1523
+ /** The field whose value was received. */
1524
+ provided_field_name?: string;
1525
+ /** The value that was received. */
1526
+ provided_field_value?: string;
1527
+ }
1444
1528
  /** error-bad-request-missing-required-field */
1445
1529
  export interface ErrorBadRequestMissingRequiredField {
1446
1530
  /** The missing field's name. */
@@ -1452,6 +1536,7 @@ export declare enum ErrorBadRequestType {
1452
1536
  BadRequest = "bad_request",
1453
1537
  InvalidEnumValue = "invalid_enum_value",
1454
1538
  InvalidField = "invalid_field",
1539
+ MissingDependency = "missing_dependency",
1455
1540
  MissingRequiredField = "missing_required_field",
1456
1541
  ParseError = "parse_error",
1457
1542
  ValueNotPermitted = "value_not_permitted"
@@ -1555,7 +1640,7 @@ export interface EventPartCreated {
1555
1640
  export interface EventPartDeleted {
1556
1641
  /**
1557
1642
  * The ID of the part that was deleted.
1558
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
1643
+ * @example "PROD-12345"
1559
1644
  */
1560
1645
  id: string;
1561
1646
  }
@@ -1571,7 +1656,7 @@ export interface EventRevOrgCreated {
1571
1656
  export interface EventRevOrgDeleted {
1572
1657
  /**
1573
1658
  * The ID of the Rev organization that was deleted.
1574
- * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
1659
+ * @example "REV-AbCdEfGh"
1575
1660
  */
1576
1661
  id: string;
1577
1662
  }
@@ -1668,6 +1753,7 @@ export interface EventSourcesScheduleEventRequest {
1668
1753
  * guaranteed to be published after this. If omitted, the event is
1669
1754
  * published immediately.
1670
1755
  * @format date-time
1756
+ * @example "2023-01-01T12:00:00.000Z"
1671
1757
  */
1672
1758
  publish_at?: string;
1673
1759
  /**
@@ -1694,7 +1780,7 @@ export interface EventTagCreated {
1694
1780
  export interface EventTagDeleted {
1695
1781
  /**
1696
1782
  * The ID of the tag that was deleted.
1697
- * @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
1783
+ * @example "TAG-12345"
1698
1784
  */
1699
1785
  id: string;
1700
1786
  }
@@ -1742,7 +1828,7 @@ export interface EventWorkCreated {
1742
1828
  export interface EventWorkDeleted {
1743
1829
  /**
1744
1830
  * The ID of the work that was deleted.
1745
- * @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
1831
+ * @example "ISS-12345"
1746
1832
  */
1747
1833
  id: string;
1748
1834
  }
@@ -1930,7 +2016,7 @@ export declare enum LinkEndpointType {
1930
2016
  export interface LinkRevUserToRevOrgRequest {
1931
2017
  /**
1932
2018
  * 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>"
2019
+ * @example "REV-AbCdEfGh"
1934
2020
  */
1935
2021
  rev_org_don: string;
1936
2022
  /** The don of the rev user to link. */
@@ -2090,9 +2176,17 @@ export interface MetricDataPoint {
2090
2176
  * @maxItems 10
2091
2177
  */
2092
2178
  dimensions?: MetricDataPointDimension[];
2179
+ /**
2180
+ * An ID that uniquely identifies the metric data point. This ID will
2181
+ * be used for deduplication. Clients can generate its own ID and send
2182
+ * it in the request. If not provided, DevRev will perform
2183
+ * content-based deduplication.
2184
+ */
2185
+ id?: string;
2093
2186
  /**
2094
2187
  * Timestamp when metric value is captured.
2095
2188
  * @format date-time
2189
+ * @example "2023-01-01T12:00:00.000Z"
2096
2190
  */
2097
2191
  timestamp: string;
2098
2192
  /**
@@ -2287,6 +2381,7 @@ export type OrgSchedule = AtomBase & {
2287
2381
  * for all its schedule fragments, and if it has a schedule fragment
2288
2382
  * for the time period in question.
2289
2383
  * @format date-time
2384
+ * @example "2023-01-01T12:00:00.000Z"
2290
2385
  */
2291
2386
  valid_until?: string;
2292
2387
  /**
@@ -2302,6 +2397,7 @@ export type OrgScheduleFragment = AtomBase & {
2302
2397
  * The date (inclusive) on which the organization schedule fragment
2303
2398
  * begins.
2304
2399
  * @format date-time
2400
+ * @example "2023-01-01T12:00:00.000Z"
2305
2401
  */
2306
2402
  from?: string;
2307
2403
  /**
@@ -2327,6 +2423,7 @@ export type OrgScheduleFragment = AtomBase & {
2327
2423
  * The date (exclusive) on which the organization schedule fragment's
2328
2424
  * validity ends.
2329
2425
  * @format date-time
2426
+ * @example "2023-01-01T12:00:00.000Z"
2330
2427
  */
2331
2428
  to?: string;
2332
2429
  };
@@ -2353,6 +2450,7 @@ export interface OrgScheduleFragmentsCreateRequest {
2353
2450
  * Date (inclusive) on which the organization schedule fragment
2354
2451
  * begins.
2355
2452
  * @format date-time
2453
+ * @example "2023-01-01T12:00:00.000Z"
2356
2454
  */
2357
2455
  from: string;
2358
2456
  /** The intervals that comprise the schedule fragment. */
@@ -2369,6 +2467,7 @@ export interface OrgScheduleFragmentsCreateRequest {
2369
2467
  * Date (exclusive) on which the organization schedule fragment's
2370
2468
  * validity ends.
2371
2469
  * @format date-time
2470
+ * @example "2023-01-01T12:00:00.000Z"
2372
2471
  */
2373
2472
  to: string;
2374
2473
  }
@@ -2563,6 +2662,24 @@ export declare enum OrgType {
2563
2662
  Account = "account",
2564
2663
  RevOrg = "rev_org"
2565
2664
  }
2665
+ /**
2666
+ * parent-part-filter
2667
+ * The filter for specifying parent part.
2668
+ */
2669
+ export interface ParentPartFilter {
2670
+ /**
2671
+ * Number of levels to fetch the part hierarchy up to.
2672
+ * @format int32
2673
+ * @min 1
2674
+ */
2675
+ level?: number;
2676
+ /**
2677
+ * Part IDs to fetch the hierarchy for.
2678
+ * @minItems 1
2679
+ * @example ["PROD-12345"]
2680
+ */
2681
+ parts: string[];
2682
+ }
2566
2683
  /** part */
2567
2684
  export type Part = (Capability | Enhancement | Feature | Product) & {
2568
2685
  type: PartType;
@@ -2611,7 +2728,7 @@ export declare enum PartType {
2611
2728
  export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequestEnhancement | PartsCreateRequestFeature | PartsCreateRequestProduct) & {
2612
2729
  /**
2613
2730
  * The IDs of the artifacts.
2614
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
2731
+ * @example ["ARTIFACT-12345"]
2615
2732
  */
2616
2733
  artifacts?: string[];
2617
2734
  /** Custom fields. */
@@ -2627,7 +2744,7 @@ export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequ
2627
2744
  name: string;
2628
2745
  /**
2629
2746
  * The users that own the part.
2630
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
2747
+ * @example ["DEVU-12345"]
2631
2748
  */
2632
2749
  owned_by: string[];
2633
2750
  type: PartType;
@@ -2637,7 +2754,7 @@ export interface PartsCreateRequestCapability {
2637
2754
  /**
2638
2755
  * ID of the parent product for the capability.
2639
2756
  * @maxItems 1
2640
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
2757
+ * @example ["PROD-12345"]
2641
2758
  */
2642
2759
  parent_part: string[];
2643
2760
  }
@@ -2646,21 +2763,29 @@ export interface PartsCreateRequestEnhancement {
2646
2763
  /**
2647
2764
  * ID of the parent part on which the enhancement is to be created.
2648
2765
  * @maxItems 1
2649
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
2766
+ * @example ["PROD-12345"]
2650
2767
  */
2651
2768
  parent_part: string[];
2652
2769
  /**
2653
2770
  * Target close date by which enhancement is expected to be closed.
2654
2771
  * @format date-time
2772
+ * @example "2023-01-01T12:00:00.000Z"
2655
2773
  */
2656
2774
  target_close_date?: string;
2775
+ /**
2776
+ * Target start date by which enhancement is expected to be started.
2777
+ * Example Date Format: 2000-11-01T01:01:01Z
2778
+ * @format date-time
2779
+ * @example "2023-01-01T12:00:00.000Z"
2780
+ */
2781
+ target_start_date?: string;
2657
2782
  }
2658
2783
  /** parts-create-request-feature */
2659
2784
  export interface PartsCreateRequestFeature {
2660
2785
  /**
2661
2786
  * ID of the parent capability/feature for the feature.
2662
2787
  * @maxItems 1
2663
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
2788
+ * @example ["PROD-12345"]
2664
2789
  */
2665
2790
  parent_part: string[];
2666
2791
  }
@@ -2674,7 +2799,7 @@ export interface PartsCreateResponse {
2674
2799
  export interface PartsDeleteRequest {
2675
2800
  /**
2676
2801
  * The ID of the part to delete.
2677
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
2802
+ * @example "PROD-12345"
2678
2803
  */
2679
2804
  id: string;
2680
2805
  }
@@ -2684,7 +2809,7 @@ export type PartsDeleteResponse = object;
2684
2809
  export interface PartsGetRequest {
2685
2810
  /**
2686
2811
  * The ID of the part to retrieve.
2687
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
2812
+ * @example "PROD-12345"
2688
2813
  */
2689
2814
  id: string;
2690
2815
  }
@@ -2696,7 +2821,7 @@ export interface PartsGetResponse {
2696
2821
  export interface PartsListRequest {
2697
2822
  /**
2698
2823
  * Filters for parts created by any of these users.
2699
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
2824
+ * @example ["DEVU-12345"]
2700
2825
  */
2701
2826
  created_by?: string[];
2702
2827
  /**
@@ -2721,9 +2846,11 @@ export interface PartsListRequest {
2721
2846
  name?: string[];
2722
2847
  /**
2723
2848
  * Filters for parts owned by any of these users.
2724
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
2849
+ * @example ["DEVU-12345"]
2725
2850
  */
2726
2851
  owned_by?: string[];
2852
+ /** The filter for specifying parent part. */
2853
+ parent_part?: ParentPartFilter;
2727
2854
  /** Filters for parts of the provided type(s). */
2728
2855
  type?: PartType[];
2729
2856
  }
@@ -2756,7 +2883,7 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
2756
2883
  description?: string;
2757
2884
  /**
2758
2885
  * The ID of the part to update.
2759
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
2886
+ * @example "PROD-12345"
2760
2887
  */
2761
2888
  id: string;
2762
2889
  /** The updated name of the part. */
@@ -2768,7 +2895,7 @@ export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUp
2768
2895
  export interface PartsUpdateRequestArtifacts {
2769
2896
  /**
2770
2897
  * Sets the artifacts to the provided IDs.
2771
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
2898
+ * @example ["ARTIFACT-12345"]
2772
2899
  */
2773
2900
  set?: string[];
2774
2901
  }
@@ -2779,8 +2906,16 @@ export interface PartsUpdateRequestEnhancement {
2779
2906
  /**
2780
2907
  * Updates the target close date of the enhancement.
2781
2908
  * @format date-time
2909
+ * @example "2023-01-01T12:00:00.000Z"
2782
2910
  */
2783
2911
  target_close_date?: string;
2912
+ /**
2913
+ * Updates the target start date of the enhancement. Example Date
2914
+ * Format: 2000-11-01T01:01:01Z
2915
+ * @format date-time
2916
+ * @example "2023-01-01T12:00:00.000Z"
2917
+ */
2918
+ target_start_date?: string;
2784
2919
  }
2785
2920
  /** parts-update-request-feature */
2786
2921
  export type PartsUpdateRequestFeature = object;
@@ -2789,7 +2924,7 @@ export interface PartsUpdateRequestOwnedBy {
2789
2924
  /**
2790
2925
  * Sets the owner IDs to the provided user IDs. This must not be
2791
2926
  * empty.
2792
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
2927
+ * @example ["DEVU-12345"]
2793
2928
  */
2794
2929
  set?: string[];
2795
2930
  }
@@ -2852,12 +2987,12 @@ export type RevOrgSummary = OrgBaseSummary;
2852
2987
  export interface RevOrgsCreateRequest {
2853
2988
  /**
2854
2989
  * Account Id to associate with this Rev organization.
2855
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
2990
+ * @example "ACC-12345"
2856
2991
  */
2857
2992
  account?: string;
2858
2993
  /**
2859
2994
  * The IDs of the artifacts to associate with the Rev organization.
2860
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
2995
+ * @example ["ARTIFACT-12345"]
2861
2996
  */
2862
2997
  artifacts?: string[];
2863
2998
  /** Application-defined custom fields. */
@@ -2899,12 +3034,12 @@ export interface RevOrgsGetRequest {
2899
3034
  /**
2900
3035
  * The ID of account for which default Rev organization is to be
2901
3036
  * fetched.
2902
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
3037
+ * @example "ACC-12345"
2903
3038
  */
2904
3039
  account?: string;
2905
3040
  /**
2906
3041
  * The ID of the required Rev organization.
2907
- * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
3042
+ * @example "REV-AbCdEfGh"
2908
3043
  */
2909
3044
  id?: string;
2910
3045
  }
@@ -2923,7 +3058,7 @@ export interface RevOrgsGetResponse {
2923
3058
  export interface RevOrgsListRequest {
2924
3059
  /**
2925
3060
  * Filters by account.
2926
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
3061
+ * @example ["ACC-12345"]
2927
3062
  */
2928
3063
  account?: string[];
2929
3064
  /** Filters by creator. */
@@ -2986,7 +3121,7 @@ export interface RevOrgsListResponse {
2986
3121
  export interface RevOrgsUpdateRequest {
2987
3122
  /**
2988
3123
  * New account ID to associate with this Rev organization.
2989
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
3124
+ * @example "ACC-12345"
2990
3125
  */
2991
3126
  account?: string;
2992
3127
  artifacts?: RevOrgsUpdateRequestArtifacts;
@@ -3011,7 +3146,7 @@ export interface RevOrgsUpdateRequest {
3011
3146
  external_ref?: string;
3012
3147
  /**
3013
3148
  * The ID of Rev organization to update.
3014
- * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
3149
+ * @example "REV-AbCdEfGh"
3015
3150
  */
3016
3151
  id: string;
3017
3152
  /** The tier of the RevOrg. */
@@ -3021,7 +3156,7 @@ export interface RevOrgsUpdateRequest {
3021
3156
  export interface RevOrgsUpdateRequestArtifacts {
3022
3157
  /**
3023
3158
  * Sets the IDs to the provided artifact IDs.
3024
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
3159
+ * @example ["ARTIFACT-12345"]
3025
3160
  */
3026
3161
  set?: string[];
3027
3162
  }
@@ -3081,7 +3216,7 @@ export type RevUserSummary = UserBaseSummary & {
3081
3216
  export interface RevUsersCreateRequest {
3082
3217
  /**
3083
3218
  * The IDs of the artifacts to associate with the Rev user.
3084
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
3219
+ * @example ["ARTIFACT-12345"]
3085
3220
  */
3086
3221
  artifacts?: string[];
3087
3222
  /** Application-defined custom fields. */
@@ -3109,7 +3244,7 @@ export interface RevUsersCreateRequest {
3109
3244
  phone_numbers?: string[];
3110
3245
  /**
3111
3246
  * 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>"
3247
+ * @example "REV-AbCdEfGh"
3113
3248
  */
3114
3249
  rev_org?: string;
3115
3250
  }
@@ -3186,7 +3321,7 @@ export interface RevUsersListRequest {
3186
3321
  phone_numbers?: string[];
3187
3322
  /**
3188
3323
  * List of IDs of Rev organizations to be filtered.
3189
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
3324
+ * @example ["REV-AbCdEfGh"]
3190
3325
  */
3191
3326
  rev_org?: string[];
3192
3327
  /** Fields to sort the Rev users by and the direction to sort them. */
@@ -3234,7 +3369,7 @@ export interface RevUsersUpdateRequest {
3234
3369
  export interface RevUsersUpdateRequestArtifacts {
3235
3370
  /**
3236
3371
  * Sets the IDs to the provided artifact IDs.
3237
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
3372
+ * @example ["ARTIFACT-12345"]
3238
3373
  */
3239
3374
  set?: string[];
3240
3375
  }
@@ -3684,7 +3819,7 @@ export interface SetSlaSelector {
3684
3819
  custom_fields?: object;
3685
3820
  /**
3686
3821
  * The SLA policy applies to the tickets of these parts.
3687
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
3822
+ * @example ["PROD-12345"]
3688
3823
  */
3689
3824
  parts?: string[];
3690
3825
  /** The SLA policy applies to conversations with these priorities. */
@@ -3695,7 +3830,7 @@ export interface SetSlaSelector {
3695
3830
  source_channel?: string[];
3696
3831
  /**
3697
3832
  * The SLA policy applies to items with these tags.
3698
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
3833
+ * @example ["TAG-12345"]
3699
3834
  */
3700
3835
  tags?: string[];
3701
3836
  }
@@ -3733,7 +3868,7 @@ export interface SetSupportMetricTarget {
3733
3868
  export interface SetTagWithValue {
3734
3869
  /**
3735
3870
  * The ID of the tag.
3736
- * @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
3871
+ * @example "TAG-12345"
3737
3872
  */
3738
3873
  id: string;
3739
3874
  /**
@@ -3861,7 +3996,7 @@ export interface SlasAssignRequest {
3861
3996
  id?: string;
3862
3997
  /**
3863
3998
  * The Rev organizations to apply the SLA to.
3864
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
3999
+ * @example ["REV-AbCdEfGh"]
3865
4000
  */
3866
4001
  rev_orgs: string[];
3867
4002
  }
@@ -4111,7 +4246,7 @@ export interface SysUsersUpdateRequest {
4111
4246
  display_name?: string;
4112
4247
  /**
4113
4248
  * Artifact ID of the system user's new display picture.
4114
- * @example "don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"
4249
+ * @example "ARTIFACT-12345"
4115
4250
  */
4116
4251
  display_picture?: string | null;
4117
4252
  /** Updated full name for the system user. */
@@ -4165,7 +4300,7 @@ export interface TagWithValue {
4165
4300
  export interface TagWithValueFilter {
4166
4301
  /**
4167
4302
  * The ID of the tag.
4168
- * @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
4303
+ * @example "TAG-12345"
4169
4304
  */
4170
4305
  id?: string;
4171
4306
  /**
@@ -4246,6 +4381,7 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
4246
4381
  * provided time. The minimum value should be at least a minute more
4247
4382
  * than the current timestamp.
4248
4383
  * @format date-time
4384
+ * @example "2023-01-01T12:00:00.000Z"
4249
4385
  */
4250
4386
  expires_at?: string;
4251
4387
  /**
@@ -4257,14 +4393,14 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
4257
4393
  labels?: string[];
4258
4394
  /**
4259
4395
  * The ID of the object to create the timeline entry for.
4260
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
4396
+ * @example "PROD-12345"
4261
4397
  */
4262
4398
  object: string;
4263
4399
  /**
4264
4400
  * If the visibility of the entry is private, this specifies the users
4265
4401
  * that the entry is private to. Note the creator is always implicitly
4266
4402
  * included in this list.
4267
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4403
+ * @example ["DEVU-12345"]
4268
4404
  */
4269
4405
  private_to?: string[];
4270
4406
  type: TimelineEntriesCreateRequestType;
@@ -4281,7 +4417,7 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
4281
4417
  export interface TimelineEntriesCreateRequestTimelineComment {
4282
4418
  /**
4283
4419
  * The IDs of the artifacts attached to the comment.
4284
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
4420
+ * @example ["ARTIFACT-12345"]
4285
4421
  */
4286
4422
  artifacts?: string[];
4287
4423
  /** The comment's body. */
@@ -4345,7 +4481,7 @@ export interface TimelineEntriesListRequest {
4345
4481
  mode?: ListMode;
4346
4482
  /**
4347
4483
  * The ID of the object to list timeline entries for.
4348
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
4484
+ * @example "PROD-12345"
4349
4485
  */
4350
4486
  object: string;
4351
4487
  /**
@@ -4402,18 +4538,18 @@ export interface TimelineEntriesUpdateRequestTimelineCommentArtifacts {
4402
4538
  * Adds the provided artifacts to the comment. An artifact cannot be
4403
4539
  * added more than once, i.e. nothing is done if the artifact is
4404
4540
  * already attached. Mutually exclusive with `set`.
4405
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
4541
+ * @example ["ARTIFACT-12345"]
4406
4542
  */
4407
4543
  add?: string[];
4408
4544
  /**
4409
4545
  * Removes the provided artifacts from the comment. If an artifact is
4410
4546
  * not present, then it's ignored. Mututally exclusive with `set`.
4411
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
4547
+ * @example ["ARTIFACT-12345"]
4412
4548
  */
4413
4549
  remove?: string[];
4414
4550
  /**
4415
4551
  * Sets the field to the provided artifacts.
4416
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
4552
+ * @example ["ARTIFACT-12345"]
4417
4553
  */
4418
4554
  set?: string[];
4419
4555
  }
@@ -4551,6 +4687,32 @@ export interface TimelineThread {
4551
4687
  */
4552
4688
  total_replies?: number;
4553
4689
  }
4690
+ /**
4691
+ * unit
4692
+ * Unit encapsulates the name of the unit and the type of the unit. For
4693
+ * example, '#Number of API calls' where name is 'number_of_api_calls' and
4694
+ * type is 'number'.
4695
+ */
4696
+ export interface Unit {
4697
+ /**
4698
+ * This represents human readable unit name of the UOM For example,
4699
+ * number of API calls.
4700
+ */
4701
+ name: string;
4702
+ /**
4703
+ * This defines the UOM unit type. For example, for 'number of video
4704
+ * calls', unit type will be a number.
4705
+ */
4706
+ type: UnitType;
4707
+ }
4708
+ /**
4709
+ * This defines the UOM unit type. For example, for 'number of video
4710
+ * calls', unit type will be a number.
4711
+ */
4712
+ export declare enum UnitType {
4713
+ Boolean = "boolean",
4714
+ Number = "number"
4715
+ }
4554
4716
  /**
4555
4717
  * unlink-rev-user-from-rev-org-request
4556
4718
  * A request to unlink a rev user from a rev org.
@@ -4558,7 +4720,7 @@ export interface TimelineThread {
4558
4720
  export interface UnlinkRevUserFromRevOrgRequest {
4559
4721
  /**
4560
4722
  * 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>"
4723
+ * @example "REV-AbCdEfGh"
4562
4724
  */
4563
4725
  rev_org_don: string;
4564
4726
  /** The don of the rev user to unlink. */
@@ -4571,6 +4733,242 @@ export interface UnlinkRevUserFromRevOrgRequest {
4571
4733
  export interface UnlinkRevUserFromRevOrgResponse {
4572
4734
  rev_user: RevUser;
4573
4735
  }
4736
+ /** uom */
4737
+ export type Uom = AtomBase & {
4738
+ /** Stores aggregation type and dimension information. */
4739
+ aggregation_details: AggregationDetail;
4740
+ /** Description of the UOM. */
4741
+ description?: string;
4742
+ /**
4743
+ * The list of dimensions that can be emitted along with the metering
4744
+ * data.
4745
+ */
4746
+ dimensions?: string[];
4747
+ /**
4748
+ * If set to true, then the UOM can be configured as part of
4749
+ * entitlements in skus and metering data only for the enabled uoms
4750
+ * will be passed through the metering pipeline.
4751
+ */
4752
+ is_enabled: boolean;
4753
+ /** Human readable metric name of the UOM. */
4754
+ metric_name: string;
4755
+ /**
4756
+ * The granularity at which the metrics ingestion data is to be emitted
4757
+ * for the UOM.
4758
+ */
4759
+ metric_scope: UomMetricScope;
4760
+ /** Human readable name of the UOM. */
4761
+ name: string;
4762
+ part?: PartSummary;
4763
+ product: PartSummary;
4764
+ /**
4765
+ * Unit encapsulates the name of the unit and the type of the unit. For
4766
+ * example, '#Number of API calls' where name is 'number_of_api_calls' and
4767
+ * type is 'number'.
4768
+ */
4769
+ unit: Unit;
4770
+ };
4771
+ /**
4772
+ * The granularity at which the metrics ingestion data is to be emitted
4773
+ * for the UOM.
4774
+ */
4775
+ export declare enum UomMetricScope {
4776
+ Org = "org",
4777
+ User = "user"
4778
+ }
4779
+ /** uoms-create-request */
4780
+ export interface UomsCreateRequest {
4781
+ /** Stores aggregation type and dimension information. */
4782
+ aggregation_detail: AggregationDetail;
4783
+ /** Description of the Unit of Measurement (UOM). */
4784
+ description?: string;
4785
+ /**
4786
+ * The list of dimensions that can be emitted as part of metrics data.
4787
+ * Dimensions consist of list of key-value pairs. For example, if the
4788
+ * UOM is 'number_of_api_calls', then dimensions can be ['api_name',
4789
+ * 'api_version'].Dimension keys can only contain alphanumeric
4790
+ * characters (A-Z, a-z, and 0-9) and underscores (_). Dimension keys
4791
+ * cannot start with a number and is case-insensitive.Dimension keys
4792
+ * must be unique and it is not allowed to have more than one value
4793
+ * with the same key.Metrics data ingested in DevRev metrics format
4794
+ * will be grouped and aggregated based on the dimensions specified in
4795
+ * UOM.
4796
+ * @minLength 1
4797
+ * @maxLength 64
4798
+ * @maxItems 10
4799
+ */
4800
+ dimensions?: string[];
4801
+ /**
4802
+ * Name of the Unit of Measurement (UOM). Unit of Measurement is a
4803
+ * unit of measure defined over a part offered by a Dev Org. A single
4804
+ * part can have multiple unit of measurements defined over it. For
4805
+ * example, a part can be 'video call', one UOM defined on this can be
4806
+ * 'number_of_calls', other UOM can be 'call_duration' etc.Metric name
4807
+ * should be unique across all UOMs in a Dev Org.Metric name can only
4808
+ * contain alphanumeric characters (A-Z, a-z, and 0-9) and underscores
4809
+ * (_). Metric name cannot start with a number and is
4810
+ * case-insensitive.
4811
+ * @minLength 1
4812
+ * @maxLength 64
4813
+ */
4814
+ metric_name: string;
4815
+ /** Human readable name of the Unit of Measurement (UOM). */
4816
+ name: string;
4817
+ /**
4818
+ * The part ID for which the Unit of Measurement (UOM) is defined.
4819
+ * When defined, ingested metrics data will be associated with part
4820
+ * and product specified in UOM.
4821
+ * @example "PROD-12345"
4822
+ */
4823
+ part_id?: string;
4824
+ /**
4825
+ * The product ID for which the Unit of Measurement (UOM) is defined.
4826
+ * @example "PROD-12345"
4827
+ */
4828
+ product_id: string;
4829
+ /**
4830
+ * Unit encapsulates the name of the unit and the type of the unit. For
4831
+ * example, '#Number of API calls' where name is 'number_of_api_calls' and
4832
+ * type is 'number'.
4833
+ */
4834
+ unit: Unit;
4835
+ }
4836
+ /** uoms-create-response */
4837
+ export interface UomsCreateResponse {
4838
+ uom: Uom;
4839
+ }
4840
+ /** uoms-delete-request */
4841
+ export interface UomsDeleteRequest {
4842
+ /** The Unit of Measurement (UOM)'s DON. */
4843
+ id: string;
4844
+ }
4845
+ /** uoms-get-request */
4846
+ export interface UomsGetRequest {
4847
+ /** The Unit of Measurement (UOM)'s DON. */
4848
+ id: string;
4849
+ }
4850
+ /** uoms-get-response */
4851
+ export interface UomsGetResponse {
4852
+ uom: Uom;
4853
+ }
4854
+ /** uoms-list-request */
4855
+ export interface UomsListRequest {
4856
+ /** List of aggregation types for filtering list of UOMs. */
4857
+ aggregation_types?: AggregationDetailAggregationType[];
4858
+ /**
4859
+ * The cursor to resume iteration from. If not provided, then
4860
+ * iteration starts from the beginning.
4861
+ */
4862
+ cursor?: string;
4863
+ /**
4864
+ * List of Unit of Measurement (UOM) DONs to be used in filtering
4865
+ * complete list of UOMs defined in a Dev Org.
4866
+ */
4867
+ ids?: string[];
4868
+ /**
4869
+ * The maximum number of UOMs to be returned in a response. The
4870
+ * default is '50'.
4871
+ * @format int32
4872
+ */
4873
+ limit?: number;
4874
+ /** List of metric names for filtering list of UOMs. */
4875
+ metric_names?: string[];
4876
+ /**
4877
+ * The iteration mode to use. If "after", then entries after the provided
4878
+ * cursor will be returned, or if no cursor is provided, then from the
4879
+ * beginning. If "before", then entries before the provided cursor will be
4880
+ * returned, or if no cursor is provided, then from the end. Entries will
4881
+ * always be returned in the specified sort-by order.
4882
+ */
4883
+ mode?: ListMode;
4884
+ /**
4885
+ * List of part IDs for filtering list of UOMs.
4886
+ * @example ["PROD-12345"]
4887
+ */
4888
+ part_ids?: string[];
4889
+ /**
4890
+ * List of product IDs for filtering list of UOMs.
4891
+ * @example ["PROD-12345"]
4892
+ */
4893
+ product_ids?: string[];
4894
+ /**
4895
+ * Fields to sort the Unit Of Measuments (UOMs) by and the direction
4896
+ * to sort them.
4897
+ */
4898
+ sort_by?: string[];
4899
+ /** List of unit types for filtering list of UOMs. */
4900
+ unit_types?: UnitType[];
4901
+ }
4902
+ /** uoms-list-response */
4903
+ export interface UomsListResponse {
4904
+ /**
4905
+ * The cursor used to iterate subsequent results in accordance to the
4906
+ * sort order. If not set, then no later elements exist.
4907
+ */
4908
+ next_cursor?: string;
4909
+ /**
4910
+ * The cursor used to iterate preceding results in accordance to the
4911
+ * sort order. If not set, then no prior elements exist.
4912
+ */
4913
+ prev_cursor?: string;
4914
+ /** The list of Unit of Measurement (UOM) objects. */
4915
+ uoms: Uom[];
4916
+ }
4917
+ /** uoms-update-request */
4918
+ export interface UomsUpdateRequest {
4919
+ /**
4920
+ * Aggregation type to be used while aggregating the metering data for the
4921
+ * UOM. 1] Sum - sum of all the values for the meter in a given period Ex.
4922
+ * { M1:2, M1:4 } => {M1:6} 2] Minimum - min of all the values for the
4923
+ * meter in a given period Ex. { M1:2, M1:4 } => {M1:2} 3] Maximum - max
4924
+ * of all the values for the meter in a given period Ex. { M1:2, M1:4 } =>
4925
+ * {M1:4} 4] Unique Count - Sum of distinct unique dimension observed for
4926
+ * the meter in the given period (not considering the data from the
4927
+ * previous billing period) Ex. January {M1:{VM:VM0}}, February
4928
+ * {M1:{VM:VM1}, M1:{VM:VM2}, M1:{VM:VM1}} => {M1:2} 5] Running Total -
4929
+ * Sum of distinct active unique dimension observed for a meter in the
4930
+ * given period, taking into consideration the active data from the
4931
+ * previous billing cycle Ex. January {M1:{VM:VM0,on}, {M1:{VM:VM1,off}
4932
+ * February {M1:{VM:VM2, on}, M1:{VM:VM2, off}, M1:{VM:VM3, on}} => {M1:3}
4933
+ * 6] Duration - Sum of distinct active unique dimension duration for a
4934
+ * meter in the given period, taking into consideration the active data
4935
+ * from the previous month Ex. January15 {M1:{VM:VM0,on, 4}} February15
4936
+ * {M1:{VM:VM0,off}, February18 {M1:{VM:VM1,on,5} => M1->
4937
+ * 30*4*charge_per_day + 10*5*charge_per_day 7] Latest - consider the
4938
+ * latest/last meter in the given period 8] Oldest - consider the
4939
+ * oldest/first record in the given period.
4940
+ */
4941
+ aggregation_type?: AggregationDetailAggregationType;
4942
+ /** Description of the Unit of Measurement (UOM). */
4943
+ description?: string;
4944
+ /** The Unit of Measurement (UOM)'s DON. */
4945
+ id: string;
4946
+ /**
4947
+ * Flag used to enable/disable the Unit of Measurement (UOM). When
4948
+ * disabled, any metricsrecords ingested against this UOM will be
4949
+ * dropped.
4950
+ */
4951
+ is_enabled?: boolean;
4952
+ /** Human readable name of the Unit of Measurement (UOM). */
4953
+ name?: string;
4954
+ /**
4955
+ * The part ID such as feature or capability for which the Unit of
4956
+ * Measurement (UOM) is defined.
4957
+ * @example "PROD-12345"
4958
+ */
4959
+ part_id?: string;
4960
+ /**
4961
+ * The product ID for which the Unit of Measurement (UOM) is defined.
4962
+ * @example "PROD-12345"
4963
+ */
4964
+ product_id?: string;
4965
+ /** Unit name of the Unit of Measurement (UOM). */
4966
+ unit?: string;
4967
+ }
4968
+ /** uoms-update-response */
4969
+ export interface UomsUpdateResponse {
4970
+ uom: Uom;
4971
+ }
4574
4972
  /** user-base */
4575
4973
  export type UserBase = AtomBase & {
4576
4974
  /** The user's display name. The name is non-unique and mutable. */
@@ -4658,6 +5056,7 @@ export interface WebhookEventRequest {
4658
5056
  * should only be processed if the timestamp isn't stale by several
4659
5057
  * seconds.
4660
5058
  * @format date-time
5059
+ * @example "2023-01-01T12:00:00.000Z"
4661
5060
  */
4662
5061
  timestamp?: string;
4663
5062
  /** The event types that the webhook will receive. */
@@ -4762,6 +5161,7 @@ export type WorkBase = AtomBase & {
4762
5161
  /**
4763
5162
  * Timestamp when the work is expected to be complete.
4764
5163
  * @format date-time
5164
+ * @example "2023-01-01T12:00:00.000Z"
4765
5165
  */
4766
5166
  target_close_date?: string;
4767
5167
  /** Title of the work object. */
@@ -4784,12 +5184,12 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
4784
5184
  * The [part](https://devrev.ai/docs/product/parts) that the work
4785
5185
  * applies to. Specifying a part is required when creating tickets and
4786
5186
  * issues.
4787
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
5187
+ * @example "PROD-12345"
4788
5188
  */
4789
5189
  applies_to_part: string;
4790
5190
  /**
4791
5191
  * The IDs of the artifacts to associate with the work item.
4792
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
5192
+ * @example ["ARTIFACT-12345"]
4793
5193
  */
4794
5194
  artifacts?: string[];
4795
5195
  /** Body of the work object. */
@@ -4803,12 +5203,12 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
4803
5203
  custom_schema_fragments?: string[];
4804
5204
  /**
4805
5205
  * The users that own the work.
4806
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5206
+ * @example ["DEVU-12345"]
4807
5207
  */
4808
5208
  owned_by: string[];
4809
5209
  /**
4810
5210
  * The users that reported the work.
4811
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5211
+ * @example ["DEVU-12345"]
4812
5212
  */
4813
5213
  reported_by?: string[];
4814
5214
  /** Sets an object's initial stage. */
@@ -4818,6 +5218,7 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
4818
5218
  /**
4819
5219
  * Timestamp for when the work is expected to be complete.
4820
5220
  * @format date-time
5221
+ * @example "2023-01-01T12:00:00.000Z"
4821
5222
  */
4822
5223
  target_close_date?: string;
4823
5224
  /** Title of the work object. */
@@ -4835,7 +5236,7 @@ export interface WorksCreateRequestIssue {
4835
5236
  export interface WorksCreateRequestOpportunity {
4836
5237
  /**
4837
5238
  * The ID of the account that the opportunity is associated with.
4838
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
5239
+ * @example "ACC-12345"
4839
5240
  */
4840
5241
  account: string;
4841
5242
  /**
@@ -4869,6 +5270,7 @@ export interface WorksCreateRequestTask {
4869
5270
  /**
4870
5271
  * Timestamp when the task was started.
4871
5272
  * @format date-time
5273
+ * @example "2023-01-01T12:00:00.000Z"
4872
5274
  */
4873
5275
  start_date?: string;
4874
5276
  }
@@ -4880,7 +5282,7 @@ export interface WorksCreateRequestTicket {
4880
5282
  is_spam?: boolean;
4881
5283
  /**
4882
5284
  * The Rev organization that the ticket is associated with.
4883
- * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
5285
+ * @example "REV-AbCdEfGh"
4884
5286
  */
4885
5287
  rev_org?: string;
4886
5288
  /** Severity of the ticket. */
@@ -4896,7 +5298,7 @@ export interface WorksCreateResponse {
4896
5298
  export interface WorksDeleteRequest {
4897
5299
  /**
4898
5300
  * The work's ID.
4899
- * @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
5301
+ * @example "ISS-12345"
4900
5302
  */
4901
5303
  id: string;
4902
5304
  }
@@ -4908,12 +5310,12 @@ export interface WorksExportRequest {
4908
5310
  actual_close_date?: DateFilter;
4909
5311
  /**
4910
5312
  * Filters for work belonging to any of the provided parts.
4911
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
5313
+ * @example ["PROD-12345"]
4912
5314
  */
4913
5315
  applies_to_part?: string[];
4914
5316
  /**
4915
5317
  * Filters for work created by any of these users.
4916
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5318
+ * @example ["DEVU-12345"]
4917
5319
  */
4918
5320
  created_by?: string[];
4919
5321
  /** Provides ways to specify date ranges on objects. */
@@ -4932,7 +5334,7 @@ export interface WorksExportRequest {
4932
5334
  opportunity?: WorksFilterOpportunity;
4933
5335
  /**
4934
5336
  * Filters for work owned by any of these users.
4935
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5337
+ * @example ["DEVU-12345"]
4936
5338
  */
4937
5339
  owned_by?: string[];
4938
5340
  /** Fields to sort the work items by and the direction to sort them. */
@@ -4941,7 +5343,7 @@ export interface WorksExportRequest {
4941
5343
  stage?: StageFilter;
4942
5344
  /**
4943
5345
  * Filters for work with any of the provided tags.
4944
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
5346
+ * @example ["TAG-12345"]
4945
5347
  */
4946
5348
  tags?: string[];
4947
5349
  /** Provides ways to specify date ranges on objects. */
@@ -4961,7 +5363,7 @@ export interface WorksFilterIssue {
4961
5363
  priority?: IssuePriority[];
4962
5364
  /**
4963
5365
  * Filters for issues with any of the provided Rev organizations.
4964
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
5366
+ * @example ["REV-AbCdEfGh"]
4965
5367
  */
4966
5368
  rev_orgs?: string[];
4967
5369
  }
@@ -4970,7 +5372,7 @@ export interface WorksFilterOpportunity {
4970
5372
  /**
4971
5373
  * Filters for opportunities belonging to any of the provided
4972
5374
  * accounts.
4973
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
5375
+ * @example ["ACC-12345"]
4974
5376
  */
4975
5377
  account?: string[];
4976
5378
  /** Filters for opportunities with any of the provided contacts. */
@@ -4987,7 +5389,7 @@ export interface WorksFilterTicket {
4987
5389
  /**
4988
5390
  * Filters for tickets that are associated with any of the provided
4989
5391
  * Rev organizations.
4990
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
5392
+ * @example ["REV-AbCdEfGh"]
4991
5393
  */
4992
5394
  rev_org?: string[];
4993
5395
  /** Filters for tickets with any of the provided severities. */
@@ -5003,7 +5405,7 @@ export interface WorksFilterTicket {
5003
5405
  export interface WorksGetRequest {
5004
5406
  /**
5005
5407
  * The work's ID.
5006
- * @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
5408
+ * @example "ISS-12345"
5007
5409
  */
5008
5410
  id: string;
5009
5411
  }
@@ -5017,12 +5419,12 @@ export interface WorksListRequest {
5017
5419
  actual_close_date?: DateFilter;
5018
5420
  /**
5019
5421
  * Filters for work belonging to any of the provided parts.
5020
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
5422
+ * @example ["PROD-12345"]
5021
5423
  */
5022
5424
  applies_to_part?: string[];
5023
5425
  /**
5024
5426
  * Filters for work created by any of these users.
5025
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5427
+ * @example ["DEVU-12345"]
5026
5428
  */
5027
5429
  created_by?: string[];
5028
5430
  /** Provides ways to specify date ranges on objects. */
@@ -5053,7 +5455,7 @@ export interface WorksListRequest {
5053
5455
  opportunity?: WorksFilterOpportunity;
5054
5456
  /**
5055
5457
  * Filters for work owned by any of these users.
5056
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5458
+ * @example ["DEVU-12345"]
5057
5459
  */
5058
5460
  owned_by?: string[];
5059
5461
  /** Fields to sort the works by and the direction to sort them. */
@@ -5062,7 +5464,7 @@ export interface WorksListRequest {
5062
5464
  stage?: StageFilter;
5063
5465
  /**
5064
5466
  * Filters for work with any of the provided tags.
5065
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
5467
+ * @example ["TAG-12345"]
5066
5468
  */
5067
5469
  tags?: string[];
5068
5470
  /** Provides ways to specify date ranges on objects. */
@@ -5090,7 +5492,7 @@ export interface WorksListResponse {
5090
5492
  export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateRequestOpportunity | WorksUpdateRequestTask | WorksUpdateRequestTicket) & {
5091
5493
  /**
5092
5494
  * Updates the part that the work item applies to.
5093
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
5495
+ * @example "PROD-12345"
5094
5496
  */
5095
5497
  applies_to_part?: string;
5096
5498
  artifacts?: WorksUpdateRequestArtifactIds;
@@ -5105,7 +5507,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
5105
5507
  custom_schema_fragments?: string[];
5106
5508
  /**
5107
5509
  * The work's ID.
5108
- * @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
5510
+ * @example "ISS-12345"
5109
5511
  */
5110
5512
  id: string;
5111
5513
  owned_by?: WorksUpdateRequestOwnedBy;
@@ -5116,6 +5518,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
5116
5518
  /**
5117
5519
  * Updates the timestamp for when the work is expected to be complete.
5118
5520
  * @format date-time
5521
+ * @example "2023-01-01T12:00:00.000Z"
5119
5522
  */
5120
5523
  target_close_date?: string | null;
5121
5524
  /** Updated title of the work object, or unchanged if not provided. */
@@ -5126,7 +5529,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
5126
5529
  export interface WorksUpdateRequestArtifactIds {
5127
5530
  /**
5128
5531
  * Sets the IDs to the provided artifact IDs.
5129
- * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
5532
+ * @example ["ARTIFACT-12345"]
5130
5533
  */
5131
5534
  set?: string[];
5132
5535
  }
@@ -5141,7 +5544,7 @@ export interface WorksUpdateRequestIssue {
5141
5544
  export interface WorksUpdateRequestOpportunity {
5142
5545
  /**
5143
5546
  * Updates the account that the opportunity is associated with.
5144
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
5547
+ * @example "ACC-12345"
5145
5548
  */
5146
5549
  account?: string;
5147
5550
  /**
@@ -5172,7 +5575,7 @@ export interface WorksUpdateRequestOwnedBy {
5172
5575
  /**
5173
5576
  * Sets the owner IDs to the provided user IDs. This must not be
5174
5577
  * empty.
5175
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5578
+ * @example ["DEVU-12345"]
5176
5579
  */
5177
5580
  set?: string[];
5178
5581
  }
@@ -5180,7 +5583,7 @@ export interface WorksUpdateRequestOwnedBy {
5180
5583
  export interface WorksUpdateRequestReportedBy {
5181
5584
  /**
5182
5585
  * 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>"]
5586
+ * @example ["DEVU-12345"]
5184
5587
  */
5185
5588
  set?: string[];
5186
5589
  }
@@ -5198,6 +5601,7 @@ export interface WorksUpdateRequestTask {
5198
5601
  /**
5199
5602
  * Timestamp when the task was started.
5200
5603
  * @format date-time
5604
+ * @example "2023-01-01T12:00:00.000Z"
5201
5605
  */
5202
5606
  start_date?: string;
5203
5607
  }
@@ -5209,7 +5613,7 @@ export interface WorksUpdateRequestTicket {
5209
5613
  is_spam?: boolean;
5210
5614
  /**
5211
5615
  * Updates the Rev organization that the ticket is associated with.
5212
- * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
5616
+ * @example "REV-AbCdEfGh"
5213
5617
  */
5214
5618
  rev_org?: string | null;
5215
5619
  /** Severity of the ticket. */
@@ -5300,12 +5704,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5300
5704
  /**
5301
5705
  * Filters for objects created after the provided timestamp (inclusive).
5302
5706
  * @format date-time
5707
+ * @example "2023-01-01T12:00:00.000Z"
5303
5708
  */
5304
5709
  'created_date.after'?: string;
5305
5710
  /**
5306
5711
  * Filters for objects created before the provided timestamp
5307
5712
  * (inclusive).
5308
5713
  * @format date-time
5714
+ * @example "2023-01-01T12:00:00.000Z"
5309
5715
  */
5310
5716
  'created_date.before'?: string;
5311
5717
  /** Domains for accounts to be filtered. */
@@ -5322,12 +5728,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5322
5728
  /**
5323
5729
  * Filters for objects created after the provided timestamp (inclusive).
5324
5730
  * @format date-time
5731
+ * @example "2023-01-01T12:00:00.000Z"
5325
5732
  */
5326
5733
  'modified_date.after'?: string;
5327
5734
  /**
5328
5735
  * Filters for objects created before the provided timestamp
5329
5736
  * (inclusive).
5330
5737
  * @format date-time
5738
+ * @example "2023-01-01T12:00:00.000Z"
5331
5739
  */
5332
5740
  'modified_date.before'?: string;
5333
5741
  /** Filters for accounts owned by the specified user(s). */
@@ -5359,7 +5767,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5359
5767
  accountsGet: (query: {
5360
5768
  /**
5361
5769
  * The ID of the account to be retrieved.
5362
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
5770
+ * @example "ACC-12345"
5363
5771
  */
5364
5772
  id: string;
5365
5773
  }, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any>>;
@@ -5386,12 +5794,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5386
5794
  /**
5387
5795
  * Filters for objects created after the provided timestamp (inclusive).
5388
5796
  * @format date-time
5797
+ * @example "2023-01-01T12:00:00.000Z"
5389
5798
  */
5390
5799
  'created_date.after'?: string;
5391
5800
  /**
5392
5801
  * Filters for objects created before the provided timestamp
5393
5802
  * (inclusive).
5394
5803
  * @format date-time
5804
+ * @example "2023-01-01T12:00:00.000Z"
5395
5805
  */
5396
5806
  'created_date.before'?: string;
5397
5807
  /**
@@ -5417,12 +5827,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5417
5827
  /**
5418
5828
  * Filters for objects created after the provided timestamp (inclusive).
5419
5829
  * @format date-time
5830
+ * @example "2023-01-01T12:00:00.000Z"
5420
5831
  */
5421
5832
  'modified_date.after'?: string;
5422
5833
  /**
5423
5834
  * Filters for objects created before the provided timestamp
5424
5835
  * (inclusive).
5425
5836
  * @format date-time
5837
+ * @example "2023-01-01T12:00:00.000Z"
5426
5838
  */
5427
5839
  'modified_date.before'?: string;
5428
5840
  /** Filters for accounts owned by the specified user(s). */
@@ -5434,6 +5846,71 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5434
5846
  /** List of tags to be filtered. */
5435
5847
  tags?: string[];
5436
5848
  }, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
5849
+ /**
5850
+ * @description Gets a list of accounts.
5851
+ *
5852
+ * @tags accounts
5853
+ * @name AccountsList
5854
+ * @request GET:/accounts.list
5855
+ * @secure */
5856
+ accountsListPaginator(query?: {
5857
+ /** Filters for accounts created by the specified user(s). */
5858
+ created_by?: string[];
5859
+ /**
5860
+ * Filters for objects created after the provided timestamp (inclusive).
5861
+ * @format date-time
5862
+ * @example "2023-01-01T12:00:00.000Z"
5863
+ */
5864
+ 'created_date.after'?: string;
5865
+ /**
5866
+ * Filters for objects created before the provided timestamp
5867
+ * (inclusive).
5868
+ * @format date-time
5869
+ * @example "2023-01-01T12:00:00.000Z"
5870
+ */
5871
+ 'created_date.before'?: string;
5872
+ /**
5873
+ * The cursor to resume iteration from. If not provided, then iteration
5874
+ * starts from the beginning.
5875
+ */
5876
+ cursor?: string;
5877
+ /** Domains for accounts to be filtered. */
5878
+ domains?: string[];
5879
+ /** Array of references of accounts to be filtered. */
5880
+ external_refs?: string[];
5881
+ /**
5882
+ * The maximum number of accounts to return per page. The default is
5883
+ * '50'.
5884
+ * @format int32
5885
+ */
5886
+ limit?: number;
5887
+ /**
5888
+ * The iteration mode to use, otherwise if not set, then "after" is
5889
+ * used.
5890
+ */
5891
+ mode?: ListMode;
5892
+ /**
5893
+ * Filters for objects created after the provided timestamp (inclusive).
5894
+ * @format date-time
5895
+ * @example "2023-01-01T12:00:00.000Z"
5896
+ */
5897
+ 'modified_date.after'?: string;
5898
+ /**
5899
+ * Filters for objects created before the provided timestamp
5900
+ * (inclusive).
5901
+ * @format date-time
5902
+ * @example "2023-01-01T12:00:00.000Z"
5903
+ */
5904
+ 'modified_date.before'?: string;
5905
+ /** Filters for accounts owned by the specified user(s). */
5906
+ owned_by?: string[];
5907
+ /** Fields to sort the accounts by and the direction to sort them in. */
5908
+ sort_by?: string[];
5909
+ /** Filters for accounts on specified stages. */
5910
+ stage?: string[];
5911
+ /** List of tags to be filtered. */
5912
+ tags?: string[];
5913
+ }, params?: RequestParams): AsyncGenerator<AccountsListResponse, void, unknown>;
5437
5914
  /**
5438
5915
  * @description Gets a list of accounts.
5439
5916
  *
@@ -5463,22 +5940,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5463
5940
  articlesCount: (query?: {
5464
5941
  /**
5465
5942
  * Filters for articles belonging to any of the provided parts.
5466
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
5943
+ * @example ["PROD-12345"]
5467
5944
  */
5468
5945
  applies_to_parts?: string[];
5469
5946
  /**
5470
5947
  * Filters for articles authored by any of the provided users.
5471
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5948
+ * @example ["DEVU-12345"]
5472
5949
  */
5473
5950
  authored_by?: string[];
5474
5951
  /**
5475
5952
  * Filters for articles created by any of the provided users.
5476
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5953
+ * @example ["DEVU-12345"]
5477
5954
  */
5478
5955
  created_by?: string[];
5479
5956
  /**
5480
5957
  * Filters for articles owned by any of the provided users.
5481
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
5958
+ * @example ["DEVU-12345"]
5482
5959
  */
5483
5960
  owned_by?: string[];
5484
5961
  }, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any>>;
@@ -5520,7 +5997,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5520
5997
  getArticle: (query: {
5521
5998
  /**
5522
5999
  * The ID of the required article.
5523
- * @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
6000
+ * @example "ARTICLE-12345"
5524
6001
  */
5525
6002
  id: string;
5526
6003
  }, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
@@ -5544,17 +6021,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5544
6021
  listArticles: (query?: {
5545
6022
  /**
5546
6023
  * Filters for articles belonging to any of the provided parts.
5547
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
6024
+ * @example ["PROD-12345"]
5548
6025
  */
5549
6026
  applies_to_parts?: string[];
5550
6027
  /**
5551
6028
  * Filters for articles authored by any of the provided users.
5552
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6029
+ * @example ["DEVU-12345"]
5553
6030
  */
5554
6031
  authored_by?: string[];
5555
6032
  /**
5556
6033
  * Filters for articles created by any of the provided users.
5557
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6034
+ * @example ["DEVU-12345"]
5558
6035
  */
5559
6036
  created_by?: string[];
5560
6037
  /**
@@ -5574,10 +6051,54 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5574
6051
  mode?: ListMode;
5575
6052
  /**
5576
6053
  * Filters for articles owned by any of the provided users.
5577
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6054
+ * @example ["DEVU-12345"]
5578
6055
  */
5579
6056
  owned_by?: string[];
5580
6057
  }, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
6058
+ /**
6059
+ * @description Lists a collection of articles.
6060
+ *
6061
+ * @tags articles
6062
+ * @name ListArticles
6063
+ * @request GET:/articles.list
6064
+ * @secure */
6065
+ listArticlesPaginator(query?: {
6066
+ /**
6067
+ * Filters for articles belonging to any of the provided parts.
6068
+ * @example ["PROD-12345"]
6069
+ */
6070
+ applies_to_parts?: string[];
6071
+ /**
6072
+ * Filters for articles authored by any of the provided users.
6073
+ * @example ["DEVU-12345"]
6074
+ */
6075
+ authored_by?: string[];
6076
+ /**
6077
+ * Filters for articles created by any of the provided users.
6078
+ * @example ["DEVU-12345"]
6079
+ */
6080
+ created_by?: string[];
6081
+ /**
6082
+ * The cursor to resume iteration from. If not provided, then iteration
6083
+ * starts from the beginning.
6084
+ */
6085
+ cursor?: string;
6086
+ /**
6087
+ * The maximum number of articles to return. The default is '50'.
6088
+ * @format int32
6089
+ */
6090
+ limit?: number;
6091
+ /**
6092
+ * The iteration mode to use, otherwise if not set, then "after" is
6093
+ * used.
6094
+ */
6095
+ mode?: ListMode;
6096
+ /**
6097
+ * Filters for articles owned by any of the provided users.
6098
+ * @example ["DEVU-12345"]
6099
+ */
6100
+ owned_by?: string[];
6101
+ }, params?: RequestParams): AsyncGenerator<ArticlesListResponse, void, unknown>;
5581
6102
  /**
5582
6103
  * @description Lists a collection of articles.
5583
6104
  *
@@ -5643,7 +6164,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5643
6164
  conversationsExport: (query?: {
5644
6165
  /**
5645
6166
  * Filters for conversations belonging to any of the provided parts.
5646
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
6167
+ * @example ["PROD-12345"]
5647
6168
  */
5648
6169
  applies_to_parts?: string[];
5649
6170
  /**
@@ -5660,18 +6181,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5660
6181
  is_spam?: boolean;
5661
6182
  /**
5662
6183
  * Filters for conversations where these users are participants.
5663
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6184
+ * @example ["DEVU-12345"]
5664
6185
  */
5665
6186
  members?: string[];
5666
6187
  /**
5667
6188
  * Filters for conversations owned by any of these users.
5668
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6189
+ * @example ["DEVU-12345"]
5669
6190
  */
5670
6191
  owned_by?: string[];
5671
6192
  /**
5672
6193
  * Filters for conversations that are associated with any of the
5673
6194
  * provided Rev organizations.
5674
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
6195
+ * @example ["REV-AbCdEfGh"]
5675
6196
  */
5676
6197
  rev_org?: string[];
5677
6198
  /** Filters for conversations with any of the provided source channels. */
@@ -5681,12 +6202,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5681
6202
  /**
5682
6203
  * Filters for conversations with any of the provided tags.
5683
6204
  * @deprecated
5684
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
6205
+ * @example ["TAG-12345"]
5685
6206
  */
5686
6207
  tags?: string[];
5687
6208
  /**
5688
6209
  * The ID of the tag.
5689
- * @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
6210
+ * @example "TAG-12345"
5690
6211
  */
5691
6212
  'tags_v2.id'?: string;
5692
6213
  /**
@@ -5736,7 +6257,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5736
6257
  conversationsList: (query?: {
5737
6258
  /**
5738
6259
  * Filters for conversations belonging to any of the provided parts.
5739
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
6260
+ * @example ["PROD-12345"]
5740
6261
  */
5741
6262
  applies_to_parts?: string[];
5742
6263
  /**
@@ -5757,7 +6278,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5757
6278
  limit?: number;
5758
6279
  /**
5759
6280
  * Filters for conversations where these users are participants.
5760
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6281
+ * @example ["DEVU-12345"]
5761
6282
  */
5762
6283
  members?: string[];
5763
6284
  /**
@@ -5767,13 +6288,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5767
6288
  mode?: ListMode;
5768
6289
  /**
5769
6290
  * Filters for conversations owned by any of these users.
5770
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6291
+ * @example ["DEVU-12345"]
5771
6292
  */
5772
6293
  owned_by?: string[];
5773
6294
  /**
5774
6295
  * Filters for conversations that are associated with any of the
5775
6296
  * provided Rev organizations.
5776
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
6297
+ * @example ["REV-AbCdEfGh"]
5777
6298
  */
5778
6299
  rev_org?: string[];
5779
6300
  /** Filters for conversations with any of the provided source channels. */
@@ -5783,12 +6304,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5783
6304
  /**
5784
6305
  * Filters for conversations with any of the provided tags.
5785
6306
  * @deprecated
5786
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
6307
+ * @example ["TAG-12345"]
5787
6308
  */
5788
6309
  tags?: string[];
5789
6310
  /**
5790
6311
  * The ID of the tag.
5791
- * @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
6312
+ * @example "TAG-12345"
5792
6313
  */
5793
6314
  'tags_v2.id'?: string;
5794
6315
  /**
@@ -5801,39 +6322,110 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5801
6322
  * @description Lists the available conversations.
5802
6323
  *
5803
6324
  * @tags conversations
5804
- * @name ConversationsListPost
5805
- * @request POST:/conversations.list
5806
- * @secure
5807
- */
5808
- conversationsListPost: (data: ConversationsListRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
5809
- /**
5810
- * @description Updates the requested conversation.
5811
- *
5812
- * @tags conversations
5813
- * @name ConversationsUpdate
5814
- * @request POST:/conversations.update
5815
- * @secure
5816
- */
5817
- conversationsUpdate: (data: ConversationsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsUpdateResponse, any>>;
5818
- /**
5819
- * @description Counts the engagement records.
5820
- *
5821
- * @tags engagements
5822
- * @name EngagementsCount
5823
- * @request GET:/engagements.count
5824
- * @secure
5825
- */
5826
- engagementsCount: (query?: {
5827
- /** Filters for meetings with the provided external_refs. */
5828
- external_ref?: string[];
6325
+ * @name ConversationsList
6326
+ * @request GET:/conversations.list
6327
+ * @secure */
6328
+ conversationsListPaginator(query?: {
5829
6329
  /**
5830
- * Filters for engagement of the provided members.
5831
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6330
+ * Filters for conversations belonging to any of the provided parts.
6331
+ * @example ["PROD-12345"]
5832
6332
  */
5833
- members?: string[];
6333
+ applies_to_parts?: string[];
5834
6334
  /**
5835
- * Filters for engagements with the provided parent.
5836
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
6335
+ * The cursor to resume iteration from. If not provided, then iteration
6336
+ * starts from the beginning.
6337
+ */
6338
+ cursor?: string;
6339
+ /** Filters for conversation that belong to the given groups. */
6340
+ group?: string[];
6341
+ /** Filters for conversations that are created by verified users. */
6342
+ is_creator_verified?: boolean;
6343
+ /** Filters for conversations that are spam. */
6344
+ is_spam?: boolean;
6345
+ /**
6346
+ * The maximum number of conversations to return. The default is '50'.
6347
+ * @format int32
6348
+ */
6349
+ limit?: number;
6350
+ /**
6351
+ * Filters for conversations where these users are participants.
6352
+ * @example ["DEVU-12345"]
6353
+ */
6354
+ members?: string[];
6355
+ /**
6356
+ * The iteration mode to use, otherwise if not set, then "after" is
6357
+ * used.
6358
+ */
6359
+ mode?: ListMode;
6360
+ /**
6361
+ * Filters for conversations owned by any of these users.
6362
+ * @example ["DEVU-12345"]
6363
+ */
6364
+ owned_by?: string[];
6365
+ /**
6366
+ * Filters for conversations that are associated with any of the
6367
+ * provided Rev organizations.
6368
+ * @example ["REV-AbCdEfGh"]
6369
+ */
6370
+ rev_org?: string[];
6371
+ /** Filters for conversations with any of the provided source channels. */
6372
+ source_channels?: string[];
6373
+ /** Filters for records in the provided stage(s) by name. */
6374
+ 'stage.name'?: string[];
6375
+ /**
6376
+ * Filters for conversations with any of the provided tags.
6377
+ * @deprecated
6378
+ * @example ["TAG-12345"]
6379
+ */
6380
+ tags?: string[];
6381
+ /**
6382
+ * The ID of the tag.
6383
+ * @example "TAG-12345"
6384
+ */
6385
+ 'tags_v2.id'?: string;
6386
+ /**
6387
+ * The value for the object's association with the tag. If specified,
6388
+ * the value must be one that's specified in the tag's allowed values.
6389
+ */
6390
+ 'tags_v2.value'?: string;
6391
+ }, params?: RequestParams): AsyncGenerator<ConversationsListResponse, void, unknown>;
6392
+ /**
6393
+ * @description Lists the available conversations.
6394
+ *
6395
+ * @tags conversations
6396
+ * @name ConversationsListPost
6397
+ * @request POST:/conversations.list
6398
+ * @secure
6399
+ */
6400
+ conversationsListPost: (data: ConversationsListRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
6401
+ /**
6402
+ * @description Updates the requested conversation.
6403
+ *
6404
+ * @tags conversations
6405
+ * @name ConversationsUpdate
6406
+ * @request POST:/conversations.update
6407
+ * @secure
6408
+ */
6409
+ conversationsUpdate: (data: ConversationsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsUpdateResponse, any>>;
6410
+ /**
6411
+ * @description Counts the engagement records.
6412
+ *
6413
+ * @tags engagements
6414
+ * @name EngagementsCount
6415
+ * @request GET:/engagements.count
6416
+ * @secure
6417
+ */
6418
+ engagementsCount: (query?: {
6419
+ /** Filters for meetings with the provided external_refs. */
6420
+ external_ref?: string[];
6421
+ /**
6422
+ * Filters for engagement of the provided members.
6423
+ * @example ["DEVU-12345"]
6424
+ */
6425
+ members?: string[];
6426
+ /**
6427
+ * Filters for engagements with the provided parent.
6428
+ * @example ["ACC-12345"]
5837
6429
  */
5838
6430
  parent?: string[];
5839
6431
  /** Filters for engagement of the provided types. */
@@ -5910,7 +6502,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5910
6502
  limit?: number;
5911
6503
  /**
5912
6504
  * Filters for engagement of the provided members.
5913
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
6505
+ * @example ["DEVU-12345"]
5914
6506
  */
5915
6507
  members?: string[];
5916
6508
  /**
@@ -5920,7 +6512,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5920
6512
  mode?: ListMode;
5921
6513
  /**
5922
6514
  * Filters for engagements with the provided parent.
5923
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
6515
+ * @example ["ACC-12345"]
5924
6516
  */
5925
6517
  parent?: string[];
5926
6518
  /** Fields to sort the engagements by and the direction to sort them. */
@@ -5928,6 +6520,46 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5928
6520
  /** Filters for engagement of the provided types. */
5929
6521
  type?: EngagementType[];
5930
6522
  }, params?: RequestParams) => Promise<AxiosResponse<EngagementsListResponse, any>>;
6523
+ /**
6524
+ * @description Lists the engagement records.
6525
+ *
6526
+ * @tags engagements
6527
+ * @name EngagementsList
6528
+ * @request GET:/engagements.list
6529
+ * @secure */
6530
+ engagementsListPaginator(query?: {
6531
+ /**
6532
+ * The cursor to resume iteration from. If not provided, then iteration
6533
+ * starts from the beginning.
6534
+ */
6535
+ cursor?: string;
6536
+ /** Filters for meetings with the provided external_refs. */
6537
+ external_ref?: string[];
6538
+ /**
6539
+ * The maximum number of engagements to return.
6540
+ * @format int32
6541
+ */
6542
+ limit?: number;
6543
+ /**
6544
+ * Filters for engagement of the provided members.
6545
+ * @example ["DEVU-12345"]
6546
+ */
6547
+ members?: string[];
6548
+ /**
6549
+ * The iteration mode to use, otherwise if not set, then "after" is
6550
+ * used.
6551
+ */
6552
+ mode?: ListMode;
6553
+ /**
6554
+ * Filters for engagements with the provided parent.
6555
+ * @example ["ACC-12345"]
6556
+ */
6557
+ parent?: string[];
6558
+ /** Fields to sort the engagements by and the direction to sort them. */
6559
+ sort_by?: string[];
6560
+ /** Filters for engagement of the provided types. */
6561
+ type?: EngagementType[];
6562
+ }, params?: RequestParams): AsyncGenerator<EngagementsListResponse, void, unknown>;
5931
6563
  /**
5932
6564
  * @description Lists the engagement records.
5933
6565
  *
@@ -6044,6 +6676,34 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6044
6676
  /** Comma-separated fields to sort the groups by. */
6045
6677
  sort_by?: string[];
6046
6678
  }, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any>>;
6679
+ /**
6680
+ * @description Lists the available groups.
6681
+ *
6682
+ * @tags groups
6683
+ * @name GroupsList
6684
+ * @request GET:/groups.list
6685
+ * @secure */
6686
+ groupsListPaginator(query?: {
6687
+ /**
6688
+ * The cursor to resume iteration from. If not provided, then iteration
6689
+ * starts from the beginning.
6690
+ */
6691
+ cursor?: string;
6692
+ /**
6693
+ * The maximum number of groups to return. The default is '50'.
6694
+ * @format int32
6695
+ */
6696
+ limit?: number;
6697
+ /** Filters the groups on basis of member type. */
6698
+ member_type?: GroupMemberType[];
6699
+ /**
6700
+ * The iteration mode to use, otherwise if not set, then "after" is
6701
+ * used.
6702
+ */
6703
+ mode?: ListMode;
6704
+ /** Comma-separated fields to sort the groups by. */
6705
+ sort_by?: string[];
6706
+ }, params?: RequestParams): AsyncGenerator<GroupsListResponse, void, unknown>;
6047
6707
  /**
6048
6708
  * @description Lists the available groups.
6049
6709
  *
@@ -6145,6 +6805,49 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6145
6805
  */
6146
6806
  types?: LinkType[];
6147
6807
  }, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
6808
+ /**
6809
+ * @description Lists the available links.
6810
+ *
6811
+ * @tags links
6812
+ * @name LinksList
6813
+ * @request GET:/links.list
6814
+ * @secure */
6815
+ linksListPaginator(query: {
6816
+ /** The ID of the object to list the links for. */
6817
+ object: string;
6818
+ /**
6819
+ * The cursor to resume iteration from. If not provided, then iteration
6820
+ * starts from the beginning.
6821
+ */
6822
+ cursor?: string;
6823
+ /**
6824
+ * The direction of the links to list, otherwise if not present, then
6825
+ * links in both directions (source and target) are included.
6826
+ */
6827
+ direction?: LinksDirection;
6828
+ /**
6829
+ * The maximum number of links to return. If not set, then the default
6830
+ * is '50'.
6831
+ * @format int32
6832
+ */
6833
+ limit?: number;
6834
+ /**
6835
+ * The link type(s) to filter for, otherwise if not present, all link
6836
+ * types are included.
6837
+ */
6838
+ link_type?: LinkType[];
6839
+ /**
6840
+ * The iteration mode to use, otherwise if not set, then "after" is
6841
+ * used.
6842
+ */
6843
+ mode?: ListMode;
6844
+ /**
6845
+ * The link types to filter for, otherwise if not present, all link
6846
+ * types are included.
6847
+ * @deprecated
6848
+ */
6849
+ types?: LinkType[];
6850
+ }, params?: RequestParams): AsyncGenerator<LinksListResponse, void, unknown>;
6148
6851
  /**
6149
6852
  * @description Lists the available links.
6150
6853
  *
@@ -6183,6 +6886,34 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6183
6886
  /** The type of metric definitions sought. */
6184
6887
  type?: MetricDefinitionMetricType[];
6185
6888
  }, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
6889
+ /**
6890
+ * @description Lists metric definitions matching a filter.
6891
+ *
6892
+ * @tags slas
6893
+ * @name MetricDefinitionsList
6894
+ * @request GET:/metric-definitions.list
6895
+ * @secure */
6896
+ metricDefinitionsListPaginator(query?: {
6897
+ /** The type of objects the metric definition applies to. */
6898
+ applies_to_type?: MetricDefinitionAppliesTo[];
6899
+ /**
6900
+ * The cursor to resume iteration from. If not provided, then iteration
6901
+ * starts from the beginning.
6902
+ */
6903
+ cursor?: string;
6904
+ /**
6905
+ * The maximum number of records to return. The default is '50'.
6906
+ * @format int32
6907
+ */
6908
+ limit?: number;
6909
+ /**
6910
+ * The iteration mode to use, otherwise if not set, then "after" is
6911
+ * used.
6912
+ */
6913
+ mode?: ListMode;
6914
+ /** The type of metric definitions sought. */
6915
+ type?: MetricDefinitionMetricType[];
6916
+ }, params?: RequestParams): AsyncGenerator<MetricDefinitionsListResponse, void, unknown>;
6186
6917
  /**
6187
6918
  * @description Lists metric definitions matching a filter.
6188
6919
  *
@@ -6300,6 +7031,35 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6300
7031
  /** The organization schedule statuses the filter matches. */
6301
7032
  status?: OrgScheduleStatus[];
6302
7033
  }, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesListResponse, any>>;
7034
+ /**
7035
+ * @description Gets list of organization schedules.
7036
+ *
7037
+ * @tags schedules
7038
+ * @name OrgSchedulesList
7039
+ * @request GET:/org-schedules.list
7040
+ * @secure */
7041
+ orgSchedulesListPaginator(query?: {
7042
+ /** Creator ID the filter matches. */
7043
+ created_by_id?: string[];
7044
+ /**
7045
+ * The cursor to resume iteration from. If not provided, then iteration
7046
+ * starts from the beginning.
7047
+ */
7048
+ cursor?: string;
7049
+ /**
7050
+ * Max number of organization schedules returned in a page. Default is
7051
+ * 50.
7052
+ * @format int32
7053
+ */
7054
+ limit?: number;
7055
+ /**
7056
+ * The iteration mode to use, otherwise if not set, then "after" is
7057
+ * used.
7058
+ */
7059
+ mode?: ListMode;
7060
+ /** The organization schedule statuses the filter matches. */
7061
+ status?: OrgScheduleStatus[];
7062
+ }, params?: RequestParams): AsyncGenerator<OrgSchedulesListResponse, void, unknown>;
6303
7063
  /**
6304
7064
  * @description Gets list of organization schedules.
6305
7065
  *
@@ -6365,7 +7125,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6365
7125
  partsGet: (query: {
6366
7126
  /**
6367
7127
  * The ID of the part to retrieve.
6368
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
7128
+ * @example "PROD-12345"
6369
7129
  */
6370
7130
  id: string;
6371
7131
  }, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any>>;
@@ -6389,7 +7149,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6389
7149
  partsList: (query?: {
6390
7150
  /**
6391
7151
  * Filters for parts created by any of these users.
6392
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
7152
+ * @example ["DEVU-12345"]
6393
7153
  */
6394
7154
  created_by?: string[];
6395
7155
  /**
@@ -6411,9 +7171,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6411
7171
  name?: string[];
6412
7172
  /**
6413
7173
  * Filters for parts owned by any of these users.
6414
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
7174
+ * @example ["DEVU-12345"]
6415
7175
  */
6416
7176
  owned_by?: string[];
7177
+ /**
7178
+ * Number of levels to fetch the part hierarchy up to.
7179
+ * @format int32
7180
+ * @min 1
7181
+ */
7182
+ 'parent_part.level'?: number;
7183
+ /**
7184
+ * Part IDs to fetch the hierarchy for. Required if any parent_part.*
7185
+ * fields are provided.
7186
+ * @minItems 1
7187
+ * @example ["PROD-12345"]
7188
+ */
7189
+ 'parent_part.parts'?: string[];
6417
7190
  /** Filters for parts of the provided type(s). */
6418
7191
  type?: PartType[];
6419
7192
  }, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
@@ -6421,19 +7194,70 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6421
7194
  * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
6422
7195
  *
6423
7196
  * @tags parts
6424
- * @name PartsListPost
6425
- * @request POST:/parts.list
6426
- * @secure
6427
- */
6428
- partsListPost: (data: PartsListRequest, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
6429
- /**
6430
- * @description Updates a [part's](https://devrev.ai/docs/product/parts) information.
6431
- *
6432
- * @tags parts
6433
- * @name PartsUpdate
6434
- * @request POST:/parts.update
6435
- * @secure
6436
- */
7197
+ * @name PartsList
7198
+ * @request GET:/parts.list
7199
+ * @secure */
7200
+ partsListPaginator(query?: {
7201
+ /**
7202
+ * Filters for parts created by any of these users.
7203
+ * @example ["DEVU-12345"]
7204
+ */
7205
+ created_by?: string[];
7206
+ /**
7207
+ * The cursor to resume iteration from. If not provided, then iteration
7208
+ * starts from the beginning.
7209
+ */
7210
+ cursor?: string;
7211
+ /**
7212
+ * The maximum number of parts to return. The default is '50'.
7213
+ * @format int32
7214
+ */
7215
+ limit?: number;
7216
+ /**
7217
+ * The iteration mode to use, otherwise if not set, then "after" is
7218
+ * used.
7219
+ */
7220
+ mode?: ListMode;
7221
+ /** Filters for parts of the provided name(s). */
7222
+ name?: string[];
7223
+ /**
7224
+ * Filters for parts owned by any of these users.
7225
+ * @example ["DEVU-12345"]
7226
+ */
7227
+ owned_by?: string[];
7228
+ /**
7229
+ * Number of levels to fetch the part hierarchy up to.
7230
+ * @format int32
7231
+ * @min 1
7232
+ */
7233
+ 'parent_part.level'?: number;
7234
+ /**
7235
+ * Part IDs to fetch the hierarchy for. Required if any parent_part.*
7236
+ * fields are provided.
7237
+ * @minItems 1
7238
+ * @example ["PROD-12345"]
7239
+ */
7240
+ 'parent_part.parts'?: string[];
7241
+ /** Filters for parts of the provided type(s). */
7242
+ type?: PartType[];
7243
+ }, params?: RequestParams): AsyncGenerator<PartsListResponse, void, unknown>;
7244
+ /**
7245
+ * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
7246
+ *
7247
+ * @tags parts
7248
+ * @name PartsListPost
7249
+ * @request POST:/parts.list
7250
+ * @secure
7251
+ */
7252
+ partsListPost: (data: PartsListRequest, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
7253
+ /**
7254
+ * @description Updates a [part's](https://devrev.ai/docs/product/parts) information.
7255
+ *
7256
+ * @tags parts
7257
+ * @name PartsUpdate
7258
+ * @request POST:/parts.update
7259
+ * @secure
7260
+ */
6437
7261
  partsUpdate: (data: PartsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsUpdateResponse, any>>;
6438
7262
  /**
6439
7263
  * @description Creates a Rev organization in the authenticated user's Dev organization.
@@ -6456,12 +7280,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6456
7280
  /**
6457
7281
  * The ID of account for which default Rev organization is to be
6458
7282
  * fetched.
6459
- * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
7283
+ * @example "ACC-12345"
6460
7284
  */
6461
7285
  account?: string;
6462
7286
  /**
6463
7287
  * The ID of the required Rev organization.
6464
- * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
7288
+ * @example "REV-AbCdEfGh"
6465
7289
  */
6466
7290
  id?: string;
6467
7291
  }, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
@@ -6485,7 +7309,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6485
7309
  revOrgsList: (query?: {
6486
7310
  /**
6487
7311
  * Filters by account.
6488
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
7312
+ * @example ["ACC-12345"]
6489
7313
  */
6490
7314
  account?: string[];
6491
7315
  /** Filters by creator. */
@@ -6493,12 +7317,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6493
7317
  /**
6494
7318
  * Filters for objects created after the provided timestamp (inclusive).
6495
7319
  * @format date-time
7320
+ * @example "2023-01-01T12:00:00.000Z"
6496
7321
  */
6497
7322
  'created_date.after'?: string;
6498
7323
  /**
6499
7324
  * Filters for objects created before the provided timestamp
6500
7325
  * (inclusive).
6501
7326
  * @format date-time
7327
+ * @example "2023-01-01T12:00:00.000Z"
6502
7328
  */
6503
7329
  'created_date.before'?: string;
6504
7330
  /**
@@ -6526,12 +7352,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6526
7352
  /**
6527
7353
  * Filters for objects created after the provided timestamp (inclusive).
6528
7354
  * @format date-time
7355
+ * @example "2023-01-01T12:00:00.000Z"
6529
7356
  */
6530
7357
  'modified_date.after'?: string;
6531
7358
  /**
6532
7359
  * Filters for objects created before the provided timestamp
6533
7360
  * (inclusive).
6534
7361
  * @format date-time
7362
+ * @example "2023-01-01T12:00:00.000Z"
6535
7363
  */
6536
7364
  'modified_date.before'?: string;
6537
7365
  /**
@@ -6540,6 +7368,75 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6540
7368
  */
6541
7369
  sort_by?: string[];
6542
7370
  }, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any>>;
7371
+ /**
7372
+ * @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
7373
+ *
7374
+ * @tags rev-orgs
7375
+ * @name RevOrgsList
7376
+ * @request GET:/rev-orgs.list
7377
+ * @secure */
7378
+ revOrgsListPaginator(query?: {
7379
+ /**
7380
+ * Filters by account.
7381
+ * @example ["ACC-12345"]
7382
+ */
7383
+ account?: string[];
7384
+ /** Filters by creator. */
7385
+ created_by?: string[];
7386
+ /**
7387
+ * Filters for objects created after the provided timestamp (inclusive).
7388
+ * @format date-time
7389
+ * @example "2023-01-01T12:00:00.000Z"
7390
+ */
7391
+ 'created_date.after'?: string;
7392
+ /**
7393
+ * Filters for objects created before the provided timestamp
7394
+ * (inclusive).
7395
+ * @format date-time
7396
+ * @example "2023-01-01T12:00:00.000Z"
7397
+ */
7398
+ 'created_date.before'?: string;
7399
+ /**
7400
+ * The cursor to resume iteration from. If not provided, then iteration
7401
+ * starts from the beginning.
7402
+ */
7403
+ cursor?: string;
7404
+ /**
7405
+ * Filters on custom fields. Input will be of the format
7406
+ * (custom_field_filter=field_name1:val1,val2,val3&custom_field_filter=field_name2:val1,val2).
7407
+ */
7408
+ custom_field_filter?: string[];
7409
+ /** List of external refs to filter Rev organizations for. */
7410
+ external_ref?: string[];
7411
+ /**
7412
+ * The maximum number of Rev organizations to be retrieved per page.
7413
+ * @format int32
7414
+ */
7415
+ limit?: number;
7416
+ /**
7417
+ * The iteration mode to use, otherwise if not set, then "after" is
7418
+ * used.
7419
+ */
7420
+ mode?: ListMode;
7421
+ /**
7422
+ * Filters for objects created after the provided timestamp (inclusive).
7423
+ * @format date-time
7424
+ * @example "2023-01-01T12:00:00.000Z"
7425
+ */
7426
+ 'modified_date.after'?: string;
7427
+ /**
7428
+ * Filters for objects created before the provided timestamp
7429
+ * (inclusive).
7430
+ * @format date-time
7431
+ * @example "2023-01-01T12:00:00.000Z"
7432
+ */
7433
+ 'modified_date.before'?: string;
7434
+ /**
7435
+ * Fields to sort the Rev organizations by and the direction to sort
7436
+ * them.
7437
+ */
7438
+ sort_by?: string[];
7439
+ }, params?: RequestParams): AsyncGenerator<RevOrgsListResponse, void, unknown>;
6543
7440
  /**
6544
7441
  * @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
6545
7442
  *
@@ -6620,12 +7517,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6620
7517
  /**
6621
7518
  * Filters for objects created after the provided timestamp (inclusive).
6622
7519
  * @format date-time
7520
+ * @example "2023-01-01T12:00:00.000Z"
6623
7521
  */
6624
7522
  'created_date.after'?: string;
6625
7523
  /**
6626
7524
  * Filters for objects created before the provided timestamp
6627
7525
  * (inclusive).
6628
7526
  * @format date-time
7527
+ * @example "2023-01-01T12:00:00.000Z"
6629
7528
  */
6630
7529
  'created_date.before'?: string;
6631
7530
  /**
@@ -6652,24 +7551,93 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6652
7551
  /**
6653
7552
  * Filters for objects created after the provided timestamp (inclusive).
6654
7553
  * @format date-time
7554
+ * @example "2023-01-01T12:00:00.000Z"
6655
7555
  */
6656
7556
  'modified_date.after'?: string;
6657
7557
  /**
6658
7558
  * Filters for objects created before the provided timestamp
6659
7559
  * (inclusive).
6660
7560
  * @format date-time
7561
+ * @example "2023-01-01T12:00:00.000Z"
6661
7562
  */
6662
7563
  'modified_date.before'?: string;
6663
7564
  /** List of phone numbers to filter Rev users on. */
6664
7565
  phone_numbers?: string[];
6665
7566
  /**
6666
7567
  * List of IDs of Rev organizations to be filtered.
6667
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
7568
+ * @example ["REV-AbCdEfGh"]
6668
7569
  */
6669
7570
  rev_org?: string[];
6670
7571
  /** Fields to sort the Rev users by and the direction to sort them. */
6671
7572
  sort_by?: string[];
6672
7573
  }, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
7574
+ /**
7575
+ * @description Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.
7576
+ *
7577
+ * @tags rev-users
7578
+ * @name RevUsersList
7579
+ * @request GET:/rev-users.list
7580
+ * @secure */
7581
+ revUsersListPaginator(query?: {
7582
+ /** Filters for Rev users that were created by the specified user(s). */
7583
+ created_by?: string[];
7584
+ /**
7585
+ * Filters for objects created after the provided timestamp (inclusive).
7586
+ * @format date-time
7587
+ * @example "2023-01-01T12:00:00.000Z"
7588
+ */
7589
+ 'created_date.after'?: string;
7590
+ /**
7591
+ * Filters for objects created before the provided timestamp
7592
+ * (inclusive).
7593
+ * @format date-time
7594
+ * @example "2023-01-01T12:00:00.000Z"
7595
+ */
7596
+ 'created_date.before'?: string;
7597
+ /**
7598
+ * The cursor to resume iteration from. If not provided, then iteration
7599
+ * starts from the beginning.
7600
+ */
7601
+ cursor?: string;
7602
+ /** List of emails of Rev users to be filtered. */
7603
+ email?: string[];
7604
+ /** List of external refs to filter Rev users for. */
7605
+ external_ref?: string[];
7606
+ /** Value of is_verified field to filter the Rev users. */
7607
+ is_verified?: boolean;
7608
+ /**
7609
+ * The maximum number of Rev users to return. The default is '50'.
7610
+ * @format int32
7611
+ */
7612
+ limit?: number;
7613
+ /**
7614
+ * The iteration mode to use, otherwise if not set, then "after" is
7615
+ * used.
7616
+ */
7617
+ mode?: ListMode;
7618
+ /**
7619
+ * Filters for objects created after the provided timestamp (inclusive).
7620
+ * @format date-time
7621
+ * @example "2023-01-01T12:00:00.000Z"
7622
+ */
7623
+ 'modified_date.after'?: string;
7624
+ /**
7625
+ * Filters for objects created before the provided timestamp
7626
+ * (inclusive).
7627
+ * @format date-time
7628
+ * @example "2023-01-01T12:00:00.000Z"
7629
+ */
7630
+ 'modified_date.before'?: string;
7631
+ /** List of phone numbers to filter Rev users on. */
7632
+ phone_numbers?: string[];
7633
+ /**
7634
+ * List of IDs of Rev organizations to be filtered.
7635
+ * @example ["REV-AbCdEfGh"]
7636
+ */
7637
+ rev_org?: string[];
7638
+ /** Fields to sort the Rev users by and the direction to sort them. */
7639
+ sort_by?: string[];
7640
+ }, params?: RequestParams): AsyncGenerator<RevUsersListResponse, void, unknown>;
6673
7641
  /**
6674
7642
  * @description Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.
6675
7643
  *
@@ -6771,6 +7739,35 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6771
7739
  /** Filters for custom schema fragment of the provided types. */
6772
7740
  types?: CustomSchemaFragmentType[];
6773
7741
  }, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any>>;
7742
+ /**
7743
+ * @description Lists custom schema fragments.
7744
+ *
7745
+ * @tags customization
7746
+ * @name CustomSchemaFragmentsList
7747
+ * @request GET:/schemas.custom.list
7748
+ * @secure */
7749
+ customSchemaFragmentsListPaginator(query?: {
7750
+ /** The list of app names. */
7751
+ app?: string[];
7752
+ /**
7753
+ * The cursor to resume iteration from, otherwise if not provided, then
7754
+ * iteration starts from the beginning.
7755
+ */
7756
+ cursor?: string;
7757
+ /** The list of leaf types. */
7758
+ leaf_type?: string[];
7759
+ /**
7760
+ * The maximum number of items.
7761
+ * @format int32
7762
+ */
7763
+ limit?: number;
7764
+ /** The list of fields to sort the items by and how to sort them. */
7765
+ sort_by?: string[];
7766
+ /** The list of subtypes. */
7767
+ subtype?: string[];
7768
+ /** Filters for custom schema fragment of the provided types. */
7769
+ types?: CustomSchemaFragmentType[];
7770
+ }, params?: RequestParams): AsyncGenerator<CustomSchemaFragmentsListResponse, void, unknown>;
6774
7771
  /**
6775
7772
  * @description Lists custom schema fragments.
6776
7773
  *
@@ -6902,6 +7899,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6902
7899
  /** The SLA statuses the filter matches. */
6903
7900
  status?: SlaStatus[];
6904
7901
  }, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any>>;
7902
+ /**
7903
+ * @description Lists SLAs matching a filter.
7904
+ *
7905
+ * @tags slas
7906
+ * @name SlasList
7907
+ * @request GET:/slas.list
7908
+ * @secure */
7909
+ slasListPaginator(query?: {
7910
+ /**
7911
+ * The cursor to resume iteration from. If not provided, then iteration
7912
+ * starts from the beginning.
7913
+ */
7914
+ cursor?: string;
7915
+ /**
7916
+ * The maximum number of SLAs to return. The default is '50'.
7917
+ * @format int32
7918
+ */
7919
+ limit?: number;
7920
+ /**
7921
+ * The iteration mode to use, otherwise if not set, then "after" is
7922
+ * used.
7923
+ */
7924
+ mode?: ListMode;
7925
+ /** The SLA statuses the filter matches. */
7926
+ status?: SlaStatus[];
7927
+ }, params?: RequestParams): AsyncGenerator<SlasListResponse, void, unknown>;
6905
7928
  /**
6906
7929
  * @description Lists SLAs matching a filter.
6907
7930
  *
@@ -6957,6 +7980,33 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6957
7980
  /** Fields to sort the system users by and the direction to sort them. */
6958
7981
  sort_by?: string[];
6959
7982
  }, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any>>;
7983
+ /**
7984
+ * @description Lists system users within your organization.
7985
+ *
7986
+ * @tags sys-users
7987
+ * @name SysUsersList
7988
+ * @request GET:/sys-users.list
7989
+ * @secure */
7990
+ sysUsersListPaginator(query?: {
7991
+ /**
7992
+ * The cursor to resume iteration from. If not provided, then iteration
7993
+ * starts from the beginning.
7994
+ */
7995
+ cursor?: string;
7996
+ /**
7997
+ * The maximum number of system users to return. Value can range from
7998
+ * '1' to '100', with a default of '50'.
7999
+ * @format int32
8000
+ */
8001
+ limit?: number;
8002
+ /**
8003
+ * The iteration mode to use, otherwise if not set, then "after" is
8004
+ * used.
8005
+ */
8006
+ mode?: ListMode;
8007
+ /** Fields to sort the system users by and the direction to sort them. */
8008
+ sort_by?: string[];
8009
+ }, params?: RequestParams): AsyncGenerator<SysUsersListResponse, void, unknown>;
6960
8010
  /**
6961
8011
  * @description Lists system users within your organization.
6962
8012
  *
@@ -6995,7 +8045,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6995
8045
  timelineEntriesList: (query: {
6996
8046
  /**
6997
8047
  * The ID of the object to list timeline entries for.
6998
- * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
8048
+ * @example "PROD-12345"
6999
8049
  */
7000
8050
  object: string;
7001
8051
  /**
@@ -7033,6 +8083,54 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7033
8083
  */
7034
8084
  visibility?: TimelineEntryVisibility[];
7035
8085
  }, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
8086
+ /**
8087
+ * @description Lists the timeline entries for an object.
8088
+ *
8089
+ * @tags timeline-entries
8090
+ * @name TimelineEntriesList
8091
+ * @request GET:/timeline-entries.list
8092
+ * @secure */
8093
+ timelineEntriesListPaginator(query: {
8094
+ /**
8095
+ * The ID of the object to list timeline entries for.
8096
+ * @example "PROD-12345"
8097
+ */
8098
+ object: string;
8099
+ /**
8100
+ * The collection(s) to list entries from, otherwise if not provided,
8101
+ * all entries are returned.
8102
+ */
8103
+ collections?: TimelineEntriesCollection[];
8104
+ /**
8105
+ * The cursor to resume iteration from. If not provided, then iteration
8106
+ * starts from the beginning.
8107
+ */
8108
+ cursor?: string;
8109
+ /**
8110
+ * Filters for entries containing at least one of the provided labels,
8111
+ * otherwise if no labels are provided, then no label filtering is done.
8112
+ * @minLength 1
8113
+ * @maxLength 64
8114
+ */
8115
+ labels?: string[];
8116
+ /**
8117
+ * The maximum number of entries to return. If not set, then this
8118
+ * defaults to `50`.
8119
+ * @format int32
8120
+ */
8121
+ limit?: number;
8122
+ /**
8123
+ * The iteration mode to use, otherwise if not set, then "after" is
8124
+ * used.
8125
+ */
8126
+ mode?: ListMode;
8127
+ /**
8128
+ * The visibility of the timeline entries to filter for. Note this is a
8129
+ * strict filter, such that only entries with the exact visibilities
8130
+ * specified will be returned.
8131
+ */
8132
+ visibility?: TimelineEntryVisibility[];
8133
+ }, params?: RequestParams): AsyncGenerator<TimelineEntriesListResponse, void, unknown>;
7036
8134
  /**
7037
8135
  * @description Lists the timeline entries for an object.
7038
8136
  *
@@ -7051,6 +8149,166 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7051
8149
  * @secure
7052
8150
  */
7053
8151
  timelineEntriesUpdate: (data: TimelineEntriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesUpdateResponse, any>>;
8152
+ /**
8153
+ * @description Creates a Unit of Measurement on a part.
8154
+ *
8155
+ * @tags commerce
8156
+ * @name UomsCreate
8157
+ * @request POST:/uoms.create
8158
+ * @secure
8159
+ */
8160
+ uomsCreate: (data: UomsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<UomsCreateResponse, any>>;
8161
+ /**
8162
+ * @description Deletes a Unit of Measurement.
8163
+ *
8164
+ * @tags commerce
8165
+ * @name UomsDelete
8166
+ * @request POST:/uoms.delete
8167
+ * @secure
8168
+ */
8169
+ uomsDelete: (data: UomsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
8170
+ /**
8171
+ * @description Gets a Unit of Measurement.
8172
+ *
8173
+ * @tags commerce
8174
+ * @name UomsGet
8175
+ * @request GET:/uoms.get
8176
+ * @secure
8177
+ */
8178
+ uomsGet: (query: {
8179
+ /** The Unit of Measurement (UOM)'s DON. */
8180
+ id: string;
8181
+ }, params?: RequestParams) => Promise<AxiosResponse<UomsGetResponse, any>>;
8182
+ /**
8183
+ * @description Gets a Unit of Measurement.
8184
+ *
8185
+ * @tags commerce
8186
+ * @name UomsGetPost
8187
+ * @request POST:/uoms.get
8188
+ * @secure
8189
+ */
8190
+ uomsGetPost: (data: UomsGetRequest, params?: RequestParams) => Promise<AxiosResponse<UomsGetResponse, any>>;
8191
+ /**
8192
+ * @description Gets the Unit of Measurements based on the given filters.
8193
+ *
8194
+ * @tags commerce
8195
+ * @name UomsList
8196
+ * @request GET:/uoms.list
8197
+ * @secure
8198
+ */
8199
+ uomsList: (query?: {
8200
+ /** List of aggregation types for filtering list of UOMs. */
8201
+ aggregation_types?: AggregationDetailAggregationType[];
8202
+ /**
8203
+ * The cursor to resume iteration from. If not provided, then iteration
8204
+ * starts from the beginning.
8205
+ */
8206
+ cursor?: string;
8207
+ /**
8208
+ * List of Unit of Measurement (UOM) DONs to be used in filtering
8209
+ * complete list of UOMs defined in a Dev Org.
8210
+ */
8211
+ ids?: string[];
8212
+ /**
8213
+ * The maximum number of UOMs to be returned in a response. The default
8214
+ * is '50'.
8215
+ * @format int32
8216
+ */
8217
+ limit?: number;
8218
+ /** List of metric names for filtering list of UOMs. */
8219
+ metric_names?: string[];
8220
+ /**
8221
+ * The iteration mode to use, otherwise if not set, then "after" is
8222
+ * used.
8223
+ */
8224
+ mode?: ListMode;
8225
+ /**
8226
+ * List of part IDs for filtering list of UOMs.
8227
+ * @example ["PROD-12345"]
8228
+ */
8229
+ part_ids?: string[];
8230
+ /**
8231
+ * List of product IDs for filtering list of UOMs.
8232
+ * @example ["PROD-12345"]
8233
+ */
8234
+ product_ids?: string[];
8235
+ /**
8236
+ * Fields to sort the Unit Of Measuments (UOMs) by and the direction to
8237
+ * sort them.
8238
+ */
8239
+ sort_by?: string[];
8240
+ /** List of unit types for filtering list of UOMs. */
8241
+ unit_types?: UnitType[];
8242
+ }, params?: RequestParams) => Promise<AxiosResponse<UomsListResponse, any>>;
8243
+ /**
8244
+ * @description Gets the Unit of Measurements based on the given filters.
8245
+ *
8246
+ * @tags commerce
8247
+ * @name UomsList
8248
+ * @request GET:/uoms.list
8249
+ * @secure */
8250
+ uomsListPaginator(query?: {
8251
+ /** List of aggregation types for filtering list of UOMs. */
8252
+ aggregation_types?: AggregationDetailAggregationType[];
8253
+ /**
8254
+ * The cursor to resume iteration from. If not provided, then iteration
8255
+ * starts from the beginning.
8256
+ */
8257
+ cursor?: string;
8258
+ /**
8259
+ * List of Unit of Measurement (UOM) DONs to be used in filtering
8260
+ * complete list of UOMs defined in a Dev Org.
8261
+ */
8262
+ ids?: string[];
8263
+ /**
8264
+ * The maximum number of UOMs to be returned in a response. The default
8265
+ * is '50'.
8266
+ * @format int32
8267
+ */
8268
+ limit?: number;
8269
+ /** List of metric names for filtering list of UOMs. */
8270
+ metric_names?: string[];
8271
+ /**
8272
+ * The iteration mode to use, otherwise if not set, then "after" is
8273
+ * used.
8274
+ */
8275
+ mode?: ListMode;
8276
+ /**
8277
+ * List of part IDs for filtering list of UOMs.
8278
+ * @example ["PROD-12345"]
8279
+ */
8280
+ part_ids?: string[];
8281
+ /**
8282
+ * List of product IDs for filtering list of UOMs.
8283
+ * @example ["PROD-12345"]
8284
+ */
8285
+ product_ids?: string[];
8286
+ /**
8287
+ * Fields to sort the Unit Of Measuments (UOMs) by and the direction to
8288
+ * sort them.
8289
+ */
8290
+ sort_by?: string[];
8291
+ /** List of unit types for filtering list of UOMs. */
8292
+ unit_types?: UnitType[];
8293
+ }, params?: RequestParams): AsyncGenerator<UomsListResponse, void, unknown>;
8294
+ /**
8295
+ * @description Gets the Unit of Measurements based on the given filters.
8296
+ *
8297
+ * @tags commerce
8298
+ * @name UomsListPost
8299
+ * @request POST:/uoms.list
8300
+ * @secure
8301
+ */
8302
+ uomsListPost: (data: UomsListRequest, params?: RequestParams) => Promise<AxiosResponse<UomsListResponse, any>>;
8303
+ /**
8304
+ * @description Updates a Unit of Measurement.
8305
+ *
8306
+ * @tags commerce
8307
+ * @name UomsUpdate
8308
+ * @request POST:/uoms.update
8309
+ * @secure
8310
+ */
8311
+ uomsUpdate: (data: UomsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<UomsUpdateResponse, any>>;
7054
8312
  /**
7055
8313
  * @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
8314
  *
@@ -7080,12 +8338,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7080
8338
  worksExport: (query?: {
7081
8339
  /**
7082
8340
  * Filters for work belonging to any of the provided parts.
7083
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
8341
+ * @example ["PROD-12345"]
7084
8342
  */
7085
8343
  applies_to_part?: string[];
7086
8344
  /**
7087
8345
  * Filters for work created by any of these users.
7088
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
8346
+ * @example ["DEVU-12345"]
7089
8347
  */
7090
8348
  created_by?: string[];
7091
8349
  /** Filters for custom fields. */
@@ -7100,19 +8358,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7100
8358
  'issue.priority'?: IssuePriority[];
7101
8359
  /**
7102
8360
  * Filters for issues with any of the provided Rev organizations.
7103
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
8361
+ * @example ["REV-AbCdEfGh"]
7104
8362
  */
7105
8363
  'issue.rev_orgs'?: string[];
7106
8364
  /**
7107
8365
  * Filters for opportunities belonging to any of the provided accounts.
7108
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
8366
+ * @example ["ACC-12345"]
7109
8367
  */
7110
8368
  'opportunity.account'?: string[];
7111
8369
  /** Filters for opportunities with any of the provided contacts. */
7112
8370
  'opportunity.contacts'?: string[];
7113
8371
  /**
7114
8372
  * Filters for work owned by any of these users.
7115
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
8373
+ * @example ["DEVU-12345"]
7116
8374
  */
7117
8375
  owned_by?: string[];
7118
8376
  /** Fields to sort the work items by and the direction to sort them. */
@@ -7121,7 +8379,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7121
8379
  'stage.name'?: string[];
7122
8380
  /**
7123
8381
  * Filters for work with any of the provided tags.
7124
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
8382
+ * @example ["TAG-12345"]
7125
8383
  */
7126
8384
  tags?: string[];
7127
8385
  /** Filters for tickets belonging to specific groups. */
@@ -7133,7 +8391,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7133
8391
  /**
7134
8392
  * Filters for tickets that are associated with any of the provided Rev
7135
8393
  * organizations.
7136
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
8394
+ * @example ["REV-AbCdEfGh"]
7137
8395
  */
7138
8396
  'ticket.rev_org'?: string[];
7139
8397
  /** Filters for tickets with any of the provided severities. */
@@ -7163,7 +8421,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7163
8421
  worksGet: (query: {
7164
8422
  /**
7165
8423
  * The work's ID.
7166
- * @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
8424
+ * @example "ISS-12345"
7167
8425
  */
7168
8426
  id: string;
7169
8427
  }, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any>>;
@@ -7187,12 +8445,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7187
8445
  worksList: (query?: {
7188
8446
  /**
7189
8447
  * Filters for work belonging to any of the provided parts.
7190
- * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
8448
+ * @example ["PROD-12345"]
7191
8449
  */
7192
8450
  applies_to_part?: string[];
7193
8451
  /**
7194
8452
  * Filters for work created by any of these users.
7195
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
8453
+ * @example ["DEVU-12345"]
7196
8454
  */
7197
8455
  created_by?: string[];
7198
8456
  /**
@@ -7206,7 +8464,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7206
8464
  'issue.priority'?: IssuePriority[];
7207
8465
  /**
7208
8466
  * Filters for issues with any of the provided Rev organizations.
7209
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
8467
+ * @example ["REV-AbCdEfGh"]
7210
8468
  */
7211
8469
  'issue.rev_orgs'?: string[];
7212
8470
  /**
@@ -7221,14 +8479,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7221
8479
  mode?: ListMode;
7222
8480
  /**
7223
8481
  * Filters for opportunities belonging to any of the provided accounts.
7224
- * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
8482
+ * @example ["ACC-12345"]
7225
8483
  */
7226
8484
  'opportunity.account'?: string[];
7227
8485
  /** Filters for opportunities with any of the provided contacts. */
7228
8486
  'opportunity.contacts'?: string[];
7229
8487
  /**
7230
8488
  * Filters for work owned by any of these users.
7231
- * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
8489
+ * @example ["DEVU-12345"]
7232
8490
  */
7233
8491
  owned_by?: string[];
7234
8492
  /** Fields to sort the works by and the direction to sort them. */
@@ -7237,7 +8495,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7237
8495
  'stage.name'?: string[];
7238
8496
  /**
7239
8497
  * Filters for work with any of the provided tags.
7240
- * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
8498
+ * @example ["TAG-12345"]
7241
8499
  */
7242
8500
  tags?: string[];
7243
8501
  /** Filters for tickets belonging to specific groups. */
@@ -7249,7 +8507,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7249
8507
  /**
7250
8508
  * Filters for tickets that are associated with any of the provided Rev
7251
8509
  * organizations.
7252
- * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
8510
+ * @example ["REV-AbCdEfGh"]
7253
8511
  */
7254
8512
  'ticket.rev_org'?: string[];
7255
8513
  /** Filters for tickets with any of the provided severities. */
@@ -7259,6 +8517,88 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7259
8517
  /** Filters for work of the provided types. */
7260
8518
  type?: WorkType[];
7261
8519
  }, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
8520
+ /**
8521
+ * @description Lists a collection of work items.
8522
+ *
8523
+ * @tags works
8524
+ * @name WorksList
8525
+ * @request GET:/works.list
8526
+ * @secure */
8527
+ worksListPaginator(query?: {
8528
+ /**
8529
+ * Filters for work belonging to any of the provided parts.
8530
+ * @example ["PROD-12345"]
8531
+ */
8532
+ applies_to_part?: string[];
8533
+ /**
8534
+ * Filters for work created by any of these users.
8535
+ * @example ["DEVU-12345"]
8536
+ */
8537
+ created_by?: string[];
8538
+ /**
8539
+ * The cursor to resume iteration from. If not provided, then iteration
8540
+ * starts from the beginning.
8541
+ */
8542
+ cursor?: string;
8543
+ /** Filters for custom fields. */
8544
+ custom_fields?: object;
8545
+ /** Filters for issues with any of the provided priorities. */
8546
+ 'issue.priority'?: IssuePriority[];
8547
+ /**
8548
+ * Filters for issues with any of the provided Rev organizations.
8549
+ * @example ["REV-AbCdEfGh"]
8550
+ */
8551
+ 'issue.rev_orgs'?: string[];
8552
+ /**
8553
+ * The maximum number of works to return. The default is '50'.
8554
+ * @format int32
8555
+ */
8556
+ limit?: number;
8557
+ /**
8558
+ * The iteration mode to use, otherwise if not set, then "after" is
8559
+ * used.
8560
+ */
8561
+ mode?: ListMode;
8562
+ /**
8563
+ * Filters for opportunities belonging to any of the provided accounts.
8564
+ * @example ["ACC-12345"]
8565
+ */
8566
+ 'opportunity.account'?: string[];
8567
+ /** Filters for opportunities with any of the provided contacts. */
8568
+ 'opportunity.contacts'?: string[];
8569
+ /**
8570
+ * Filters for work owned by any of these users.
8571
+ * @example ["DEVU-12345"]
8572
+ */
8573
+ owned_by?: string[];
8574
+ /** Fields to sort the works by and the direction to sort them. */
8575
+ sort_by?: string[];
8576
+ /** Filters for records in the provided stage(s) by name. */
8577
+ 'stage.name'?: string[];
8578
+ /**
8579
+ * Filters for work with any of the provided tags.
8580
+ * @example ["TAG-12345"]
8581
+ */
8582
+ tags?: string[];
8583
+ /** Filters for tickets belonging to specific groups. */
8584
+ 'ticket.group'?: string[];
8585
+ /** Filters for tickets that are spam. */
8586
+ 'ticket.is_spam'?: boolean;
8587
+ /** Filters for tickets that need response. */
8588
+ 'ticket.needs_response'?: boolean;
8589
+ /**
8590
+ * Filters for tickets that are associated with any of the provided Rev
8591
+ * organizations.
8592
+ * @example ["REV-AbCdEfGh"]
8593
+ */
8594
+ 'ticket.rev_org'?: string[];
8595
+ /** Filters for tickets with any of the provided severities. */
8596
+ 'ticket.severity'?: TicketSeverity[];
8597
+ /** Filters for tickets with any of the provided source channels. */
8598
+ 'ticket.source_channel'?: string[];
8599
+ /** Filters for work of the provided types. */
8600
+ type?: WorkType[];
8601
+ }, params?: RequestParams): AsyncGenerator<WorksListResponse, void, unknown>;
7262
8602
  /**
7263
8603
  * @description Lists a collection of work items.
7264
8604
  *