@devrev/typescript-sdk 1.1.15 → 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 ["
|
|
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 "
|
|
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 "
|
|
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 "
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
413
|
+
* @example ["PROD-12345"]
|
|
348
414
|
*/
|
|
349
415
|
applies_to_parts: string[];
|
|
350
416
|
/**
|
|
351
417
|
* The authors of the article.
|
|
352
|
-
* @example ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 "
|
|
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 "
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 "
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 "
|
|
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 "
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
1295
|
+
* @example ["DEVU-12345"]
|
|
1219
1296
|
*/
|
|
1220
1297
|
members?: string[];
|
|
1221
1298
|
/**
|
|
1222
1299
|
* Filters for engagements with the provided parent.
|
|
1223
|
-
* @example ["
|
|
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 ["
|
|
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 ["
|
|
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 "
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 ["
|
|
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 "
|
|
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 "
|
|
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 "
|
|
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 "
|
|
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 "
|
|
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;
|
|
@@ -2607,6 +2724,216 @@ export declare enum PartType {
|
|
|
2607
2724
|
Feature = "feature",
|
|
2608
2725
|
Product = "product"
|
|
2609
2726
|
}
|
|
2727
|
+
/** parts-create-request */
|
|
2728
|
+
export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequestEnhancement | PartsCreateRequestFeature | PartsCreateRequestProduct) & {
|
|
2729
|
+
/**
|
|
2730
|
+
* The IDs of the artifacts.
|
|
2731
|
+
* @example ["ARTIFACT-12345"]
|
|
2732
|
+
*/
|
|
2733
|
+
artifacts?: string[];
|
|
2734
|
+
/** Custom fields. */
|
|
2735
|
+
custom_fields?: object;
|
|
2736
|
+
/**
|
|
2737
|
+
* The custom schema fragments to use.
|
|
2738
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
2739
|
+
*/
|
|
2740
|
+
custom_schema_fragments?: string[];
|
|
2741
|
+
/** Description of the part. */
|
|
2742
|
+
description?: string;
|
|
2743
|
+
/** Name of the part. */
|
|
2744
|
+
name: string;
|
|
2745
|
+
/**
|
|
2746
|
+
* The users that own the part.
|
|
2747
|
+
* @example ["DEVU-12345"]
|
|
2748
|
+
*/
|
|
2749
|
+
owned_by: string[];
|
|
2750
|
+
type: PartType;
|
|
2751
|
+
};
|
|
2752
|
+
/** parts-create-request-capability */
|
|
2753
|
+
export interface PartsCreateRequestCapability {
|
|
2754
|
+
/**
|
|
2755
|
+
* ID of the parent product for the capability.
|
|
2756
|
+
* @maxItems 1
|
|
2757
|
+
* @example ["PROD-12345"]
|
|
2758
|
+
*/
|
|
2759
|
+
parent_part: string[];
|
|
2760
|
+
}
|
|
2761
|
+
/** parts-create-request-enhancement */
|
|
2762
|
+
export interface PartsCreateRequestEnhancement {
|
|
2763
|
+
/**
|
|
2764
|
+
* ID of the parent part on which the enhancement is to be created.
|
|
2765
|
+
* @maxItems 1
|
|
2766
|
+
* @example ["PROD-12345"]
|
|
2767
|
+
*/
|
|
2768
|
+
parent_part: string[];
|
|
2769
|
+
/**
|
|
2770
|
+
* Target close date by which enhancement is expected to be closed.
|
|
2771
|
+
* @format date-time
|
|
2772
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2773
|
+
*/
|
|
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;
|
|
2782
|
+
}
|
|
2783
|
+
/** parts-create-request-feature */
|
|
2784
|
+
export interface PartsCreateRequestFeature {
|
|
2785
|
+
/**
|
|
2786
|
+
* ID of the parent capability/feature for the feature.
|
|
2787
|
+
* @maxItems 1
|
|
2788
|
+
* @example ["PROD-12345"]
|
|
2789
|
+
*/
|
|
2790
|
+
parent_part: string[];
|
|
2791
|
+
}
|
|
2792
|
+
/** parts-create-request-product */
|
|
2793
|
+
export type PartsCreateRequestProduct = object;
|
|
2794
|
+
/** parts-create-response */
|
|
2795
|
+
export interface PartsCreateResponse {
|
|
2796
|
+
part: Part;
|
|
2797
|
+
}
|
|
2798
|
+
/** parts-delete-request */
|
|
2799
|
+
export interface PartsDeleteRequest {
|
|
2800
|
+
/**
|
|
2801
|
+
* The ID of the part to delete.
|
|
2802
|
+
* @example "PROD-12345"
|
|
2803
|
+
*/
|
|
2804
|
+
id: string;
|
|
2805
|
+
}
|
|
2806
|
+
/** parts-delete-response */
|
|
2807
|
+
export type PartsDeleteResponse = object;
|
|
2808
|
+
/** parts-get-request */
|
|
2809
|
+
export interface PartsGetRequest {
|
|
2810
|
+
/**
|
|
2811
|
+
* The ID of the part to retrieve.
|
|
2812
|
+
* @example "PROD-12345"
|
|
2813
|
+
*/
|
|
2814
|
+
id: string;
|
|
2815
|
+
}
|
|
2816
|
+
/** parts-get-response */
|
|
2817
|
+
export interface PartsGetResponse {
|
|
2818
|
+
part: Part;
|
|
2819
|
+
}
|
|
2820
|
+
/** parts-list-request */
|
|
2821
|
+
export interface PartsListRequest {
|
|
2822
|
+
/**
|
|
2823
|
+
* Filters for parts created by any of these users.
|
|
2824
|
+
* @example ["DEVU-12345"]
|
|
2825
|
+
*/
|
|
2826
|
+
created_by?: string[];
|
|
2827
|
+
/**
|
|
2828
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2829
|
+
* iteration starts from the beginning.
|
|
2830
|
+
*/
|
|
2831
|
+
cursor?: string;
|
|
2832
|
+
/**
|
|
2833
|
+
* The maximum number of parts to return. The default is '50'.
|
|
2834
|
+
* @format int32
|
|
2835
|
+
*/
|
|
2836
|
+
limit?: number;
|
|
2837
|
+
/**
|
|
2838
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2839
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2840
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2841
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2842
|
+
* always be returned in the specified sort-by order.
|
|
2843
|
+
*/
|
|
2844
|
+
mode?: ListMode;
|
|
2845
|
+
/** Filters for parts of the provided name(s). */
|
|
2846
|
+
name?: string[];
|
|
2847
|
+
/**
|
|
2848
|
+
* Filters for parts owned by any of these users.
|
|
2849
|
+
* @example ["DEVU-12345"]
|
|
2850
|
+
*/
|
|
2851
|
+
owned_by?: string[];
|
|
2852
|
+
/** The filter for specifying parent part. */
|
|
2853
|
+
parent_part?: ParentPartFilter;
|
|
2854
|
+
/** Filters for parts of the provided type(s). */
|
|
2855
|
+
type?: PartType[];
|
|
2856
|
+
}
|
|
2857
|
+
/** parts-list-response */
|
|
2858
|
+
export interface PartsListResponse {
|
|
2859
|
+
/**
|
|
2860
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
2861
|
+
* sort order. If not set, then no later elements exist.
|
|
2862
|
+
*/
|
|
2863
|
+
next_cursor?: string;
|
|
2864
|
+
/** The list of parts. */
|
|
2865
|
+
parts: Part[];
|
|
2866
|
+
/**
|
|
2867
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
2868
|
+
* sort order. If not set, then no prior elements exist.
|
|
2869
|
+
*/
|
|
2870
|
+
prev_cursor?: string;
|
|
2871
|
+
}
|
|
2872
|
+
/** parts-update-request */
|
|
2873
|
+
export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUpdateRequestEnhancement | PartsUpdateRequestFeature | PartsUpdateRequestProduct) & {
|
|
2874
|
+
artifacts?: PartsUpdateRequestArtifacts;
|
|
2875
|
+
/** Custom fields. */
|
|
2876
|
+
custom_fields?: object;
|
|
2877
|
+
/**
|
|
2878
|
+
* The custom schema fragments to use.
|
|
2879
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
2880
|
+
*/
|
|
2881
|
+
custom_schema_fragments?: string[];
|
|
2882
|
+
/** The updated description of the part. */
|
|
2883
|
+
description?: string;
|
|
2884
|
+
/**
|
|
2885
|
+
* The ID of the part to update.
|
|
2886
|
+
* @example "PROD-12345"
|
|
2887
|
+
*/
|
|
2888
|
+
id: string;
|
|
2889
|
+
/** The updated name of the part. */
|
|
2890
|
+
name?: string;
|
|
2891
|
+
owned_by?: PartsUpdateRequestOwnedBy;
|
|
2892
|
+
type?: PartType;
|
|
2893
|
+
};
|
|
2894
|
+
/** parts-update-request-artifacts */
|
|
2895
|
+
export interface PartsUpdateRequestArtifacts {
|
|
2896
|
+
/**
|
|
2897
|
+
* Sets the artifacts to the provided IDs.
|
|
2898
|
+
* @example ["ARTIFACT-12345"]
|
|
2899
|
+
*/
|
|
2900
|
+
set?: string[];
|
|
2901
|
+
}
|
|
2902
|
+
/** parts-update-request-capability */
|
|
2903
|
+
export type PartsUpdateRequestCapability = object;
|
|
2904
|
+
/** parts-update-request-enhancement */
|
|
2905
|
+
export interface PartsUpdateRequestEnhancement {
|
|
2906
|
+
/**
|
|
2907
|
+
* Updates the target close date of the enhancement.
|
|
2908
|
+
* @format date-time
|
|
2909
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2910
|
+
*/
|
|
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;
|
|
2919
|
+
}
|
|
2920
|
+
/** parts-update-request-feature */
|
|
2921
|
+
export type PartsUpdateRequestFeature = object;
|
|
2922
|
+
/** parts-update-request-owned-by */
|
|
2923
|
+
export interface PartsUpdateRequestOwnedBy {
|
|
2924
|
+
/**
|
|
2925
|
+
* Sets the owner IDs to the provided user IDs. This must not be
|
|
2926
|
+
* empty.
|
|
2927
|
+
* @example ["DEVU-12345"]
|
|
2928
|
+
*/
|
|
2929
|
+
set?: string[];
|
|
2930
|
+
}
|
|
2931
|
+
/** parts-update-request-product */
|
|
2932
|
+
export type PartsUpdateRequestProduct = object;
|
|
2933
|
+
/** parts-update-response */
|
|
2934
|
+
export interface PartsUpdateResponse {
|
|
2935
|
+
part: Part;
|
|
2936
|
+
}
|
|
2610
2937
|
/** product */
|
|
2611
2938
|
export type Product = PartBase;
|
|
2612
2939
|
/** product-summary */
|
|
@@ -2660,12 +2987,12 @@ export type RevOrgSummary = OrgBaseSummary;
|
|
|
2660
2987
|
export interface RevOrgsCreateRequest {
|
|
2661
2988
|
/**
|
|
2662
2989
|
* Account Id to associate with this Rev organization.
|
|
2663
|
-
* @example "
|
|
2990
|
+
* @example "ACC-12345"
|
|
2664
2991
|
*/
|
|
2665
2992
|
account?: string;
|
|
2666
2993
|
/**
|
|
2667
2994
|
* The IDs of the artifacts to associate with the Rev organization.
|
|
2668
|
-
* @example ["
|
|
2995
|
+
* @example ["ARTIFACT-12345"]
|
|
2669
2996
|
*/
|
|
2670
2997
|
artifacts?: string[];
|
|
2671
2998
|
/** Application-defined custom fields. */
|
|
@@ -2707,12 +3034,12 @@ export interface RevOrgsGetRequest {
|
|
|
2707
3034
|
/**
|
|
2708
3035
|
* The ID of account for which default Rev organization is to be
|
|
2709
3036
|
* fetched.
|
|
2710
|
-
* @example "
|
|
3037
|
+
* @example "ACC-12345"
|
|
2711
3038
|
*/
|
|
2712
3039
|
account?: string;
|
|
2713
3040
|
/**
|
|
2714
3041
|
* The ID of the required Rev organization.
|
|
2715
|
-
* @example "
|
|
3042
|
+
* @example "REV-AbCdEfGh"
|
|
2716
3043
|
*/
|
|
2717
3044
|
id?: string;
|
|
2718
3045
|
}
|
|
@@ -2731,7 +3058,7 @@ export interface RevOrgsGetResponse {
|
|
|
2731
3058
|
export interface RevOrgsListRequest {
|
|
2732
3059
|
/**
|
|
2733
3060
|
* Filters by account.
|
|
2734
|
-
* @example ["
|
|
3061
|
+
* @example ["ACC-12345"]
|
|
2735
3062
|
*/
|
|
2736
3063
|
account?: string[];
|
|
2737
3064
|
/** Filters by creator. */
|
|
@@ -2794,7 +3121,7 @@ export interface RevOrgsListResponse {
|
|
|
2794
3121
|
export interface RevOrgsUpdateRequest {
|
|
2795
3122
|
/**
|
|
2796
3123
|
* New account ID to associate with this Rev organization.
|
|
2797
|
-
* @example "
|
|
3124
|
+
* @example "ACC-12345"
|
|
2798
3125
|
*/
|
|
2799
3126
|
account?: string;
|
|
2800
3127
|
artifacts?: RevOrgsUpdateRequestArtifacts;
|
|
@@ -2819,7 +3146,7 @@ export interface RevOrgsUpdateRequest {
|
|
|
2819
3146
|
external_ref?: string;
|
|
2820
3147
|
/**
|
|
2821
3148
|
* The ID of Rev organization to update.
|
|
2822
|
-
* @example "
|
|
3149
|
+
* @example "REV-AbCdEfGh"
|
|
2823
3150
|
*/
|
|
2824
3151
|
id: string;
|
|
2825
3152
|
/** The tier of the RevOrg. */
|
|
@@ -2829,7 +3156,7 @@ export interface RevOrgsUpdateRequest {
|
|
|
2829
3156
|
export interface RevOrgsUpdateRequestArtifacts {
|
|
2830
3157
|
/**
|
|
2831
3158
|
* Sets the IDs to the provided artifact IDs.
|
|
2832
|
-
* @example ["
|
|
3159
|
+
* @example ["ARTIFACT-12345"]
|
|
2833
3160
|
*/
|
|
2834
3161
|
set?: string[];
|
|
2835
3162
|
}
|
|
@@ -2889,7 +3216,7 @@ export type RevUserSummary = UserBaseSummary & {
|
|
|
2889
3216
|
export interface RevUsersCreateRequest {
|
|
2890
3217
|
/**
|
|
2891
3218
|
* The IDs of the artifacts to associate with the Rev user.
|
|
2892
|
-
* @example ["
|
|
3219
|
+
* @example ["ARTIFACT-12345"]
|
|
2893
3220
|
*/
|
|
2894
3221
|
artifacts?: string[];
|
|
2895
3222
|
/** Application-defined custom fields. */
|
|
@@ -2917,7 +3244,7 @@ export interface RevUsersCreateRequest {
|
|
|
2917
3244
|
phone_numbers?: string[];
|
|
2918
3245
|
/**
|
|
2919
3246
|
* The ID of Rev organization for which a Rev user is to be created.
|
|
2920
|
-
* @example "
|
|
3247
|
+
* @example "REV-AbCdEfGh"
|
|
2921
3248
|
*/
|
|
2922
3249
|
rev_org?: string;
|
|
2923
3250
|
}
|
|
@@ -2994,7 +3321,7 @@ export interface RevUsersListRequest {
|
|
|
2994
3321
|
phone_numbers?: string[];
|
|
2995
3322
|
/**
|
|
2996
3323
|
* List of IDs of Rev organizations to be filtered.
|
|
2997
|
-
* @example ["
|
|
3324
|
+
* @example ["REV-AbCdEfGh"]
|
|
2998
3325
|
*/
|
|
2999
3326
|
rev_org?: string[];
|
|
3000
3327
|
/** Fields to sort the Rev users by and the direction to sort them. */
|
|
@@ -3042,7 +3369,7 @@ export interface RevUsersUpdateRequest {
|
|
|
3042
3369
|
export interface RevUsersUpdateRequestArtifacts {
|
|
3043
3370
|
/**
|
|
3044
3371
|
* Sets the IDs to the provided artifact IDs.
|
|
3045
|
-
* @example ["
|
|
3372
|
+
* @example ["ARTIFACT-12345"]
|
|
3046
3373
|
*/
|
|
3047
3374
|
set?: string[];
|
|
3048
3375
|
}
|
|
@@ -3492,7 +3819,7 @@ export interface SetSlaSelector {
|
|
|
3492
3819
|
custom_fields?: object;
|
|
3493
3820
|
/**
|
|
3494
3821
|
* The SLA policy applies to the tickets of these parts.
|
|
3495
|
-
* @example ["
|
|
3822
|
+
* @example ["PROD-12345"]
|
|
3496
3823
|
*/
|
|
3497
3824
|
parts?: string[];
|
|
3498
3825
|
/** The SLA policy applies to conversations with these priorities. */
|
|
@@ -3503,7 +3830,7 @@ export interface SetSlaSelector {
|
|
|
3503
3830
|
source_channel?: string[];
|
|
3504
3831
|
/**
|
|
3505
3832
|
* The SLA policy applies to items with these tags.
|
|
3506
|
-
* @example ["
|
|
3833
|
+
* @example ["TAG-12345"]
|
|
3507
3834
|
*/
|
|
3508
3835
|
tags?: string[];
|
|
3509
3836
|
}
|
|
@@ -3541,7 +3868,7 @@ export interface SetSupportMetricTarget {
|
|
|
3541
3868
|
export interface SetTagWithValue {
|
|
3542
3869
|
/**
|
|
3543
3870
|
* The ID of the tag.
|
|
3544
|
-
* @example "
|
|
3871
|
+
* @example "TAG-12345"
|
|
3545
3872
|
*/
|
|
3546
3873
|
id: string;
|
|
3547
3874
|
/**
|
|
@@ -3669,7 +3996,7 @@ export interface SlasAssignRequest {
|
|
|
3669
3996
|
id?: string;
|
|
3670
3997
|
/**
|
|
3671
3998
|
* The Rev organizations to apply the SLA to.
|
|
3672
|
-
* @example ["
|
|
3999
|
+
* @example ["REV-AbCdEfGh"]
|
|
3673
4000
|
*/
|
|
3674
4001
|
rev_orgs: string[];
|
|
3675
4002
|
}
|
|
@@ -3919,7 +4246,7 @@ export interface SysUsersUpdateRequest {
|
|
|
3919
4246
|
display_name?: string;
|
|
3920
4247
|
/**
|
|
3921
4248
|
* Artifact ID of the system user's new display picture.
|
|
3922
|
-
* @example "
|
|
4249
|
+
* @example "ARTIFACT-12345"
|
|
3923
4250
|
*/
|
|
3924
4251
|
display_picture?: string | null;
|
|
3925
4252
|
/** Updated full name for the system user. */
|
|
@@ -3973,7 +4300,7 @@ export interface TagWithValue {
|
|
|
3973
4300
|
export interface TagWithValueFilter {
|
|
3974
4301
|
/**
|
|
3975
4302
|
* The ID of the tag.
|
|
3976
|
-
* @example "
|
|
4303
|
+
* @example "TAG-12345"
|
|
3977
4304
|
*/
|
|
3978
4305
|
id?: string;
|
|
3979
4306
|
/**
|
|
@@ -4054,6 +4381,7 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
4054
4381
|
* provided time. The minimum value should be at least a minute more
|
|
4055
4382
|
* than the current timestamp.
|
|
4056
4383
|
* @format date-time
|
|
4384
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4057
4385
|
*/
|
|
4058
4386
|
expires_at?: string;
|
|
4059
4387
|
/**
|
|
@@ -4065,14 +4393,14 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
4065
4393
|
labels?: string[];
|
|
4066
4394
|
/**
|
|
4067
4395
|
* The ID of the object to create the timeline entry for.
|
|
4068
|
-
* @example "
|
|
4396
|
+
* @example "PROD-12345"
|
|
4069
4397
|
*/
|
|
4070
4398
|
object: string;
|
|
4071
4399
|
/**
|
|
4072
4400
|
* If the visibility of the entry is private, this specifies the users
|
|
4073
4401
|
* that the entry is private to. Note the creator is always implicitly
|
|
4074
4402
|
* included in this list.
|
|
4075
|
-
* @example ["
|
|
4403
|
+
* @example ["DEVU-12345"]
|
|
4076
4404
|
*/
|
|
4077
4405
|
private_to?: string[];
|
|
4078
4406
|
type: TimelineEntriesCreateRequestType;
|
|
@@ -4089,7 +4417,7 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
4089
4417
|
export interface TimelineEntriesCreateRequestTimelineComment {
|
|
4090
4418
|
/**
|
|
4091
4419
|
* The IDs of the artifacts attached to the comment.
|
|
4092
|
-
* @example ["
|
|
4420
|
+
* @example ["ARTIFACT-12345"]
|
|
4093
4421
|
*/
|
|
4094
4422
|
artifacts?: string[];
|
|
4095
4423
|
/** The comment's body. */
|
|
@@ -4153,7 +4481,7 @@ export interface TimelineEntriesListRequest {
|
|
|
4153
4481
|
mode?: ListMode;
|
|
4154
4482
|
/**
|
|
4155
4483
|
* The ID of the object to list timeline entries for.
|
|
4156
|
-
* @example "
|
|
4484
|
+
* @example "PROD-12345"
|
|
4157
4485
|
*/
|
|
4158
4486
|
object: string;
|
|
4159
4487
|
/**
|
|
@@ -4210,18 +4538,18 @@ export interface TimelineEntriesUpdateRequestTimelineCommentArtifacts {
|
|
|
4210
4538
|
* Adds the provided artifacts to the comment. An artifact cannot be
|
|
4211
4539
|
* added more than once, i.e. nothing is done if the artifact is
|
|
4212
4540
|
* already attached. Mutually exclusive with `set`.
|
|
4213
|
-
* @example ["
|
|
4541
|
+
* @example ["ARTIFACT-12345"]
|
|
4214
4542
|
*/
|
|
4215
4543
|
add?: string[];
|
|
4216
4544
|
/**
|
|
4217
4545
|
* Removes the provided artifacts from the comment. If an artifact is
|
|
4218
4546
|
* not present, then it's ignored. Mututally exclusive with `set`.
|
|
4219
|
-
* @example ["
|
|
4547
|
+
* @example ["ARTIFACT-12345"]
|
|
4220
4548
|
*/
|
|
4221
4549
|
remove?: string[];
|
|
4222
4550
|
/**
|
|
4223
4551
|
* Sets the field to the provided artifacts.
|
|
4224
|
-
* @example ["
|
|
4552
|
+
* @example ["ARTIFACT-12345"]
|
|
4225
4553
|
*/
|
|
4226
4554
|
set?: string[];
|
|
4227
4555
|
}
|
|
@@ -4359,6 +4687,32 @@ export interface TimelineThread {
|
|
|
4359
4687
|
*/
|
|
4360
4688
|
total_replies?: number;
|
|
4361
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
|
+
}
|
|
4362
4716
|
/**
|
|
4363
4717
|
* unlink-rev-user-from-rev-org-request
|
|
4364
4718
|
* A request to unlink a rev user from a rev org.
|
|
@@ -4366,7 +4720,7 @@ export interface TimelineThread {
|
|
|
4366
4720
|
export interface UnlinkRevUserFromRevOrgRequest {
|
|
4367
4721
|
/**
|
|
4368
4722
|
* The don of the rev org to unlink the rev user from.
|
|
4369
|
-
* @example "
|
|
4723
|
+
* @example "REV-AbCdEfGh"
|
|
4370
4724
|
*/
|
|
4371
4725
|
rev_org_don: string;
|
|
4372
4726
|
/** The don of the rev user to unlink. */
|
|
@@ -4379,6 +4733,242 @@ export interface UnlinkRevUserFromRevOrgRequest {
|
|
|
4379
4733
|
export interface UnlinkRevUserFromRevOrgResponse {
|
|
4380
4734
|
rev_user: RevUser;
|
|
4381
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
|
+
}
|
|
4382
4972
|
/** user-base */
|
|
4383
4973
|
export type UserBase = AtomBase & {
|
|
4384
4974
|
/** The user's display name. The name is non-unique and mutable. */
|
|
@@ -4466,6 +5056,7 @@ export interface WebhookEventRequest {
|
|
|
4466
5056
|
* should only be processed if the timestamp isn't stale by several
|
|
4467
5057
|
* seconds.
|
|
4468
5058
|
* @format date-time
|
|
5059
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4469
5060
|
*/
|
|
4470
5061
|
timestamp?: string;
|
|
4471
5062
|
/** The event types that the webhook will receive. */
|
|
@@ -4570,6 +5161,7 @@ export type WorkBase = AtomBase & {
|
|
|
4570
5161
|
/**
|
|
4571
5162
|
* Timestamp when the work is expected to be complete.
|
|
4572
5163
|
* @format date-time
|
|
5164
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4573
5165
|
*/
|
|
4574
5166
|
target_close_date?: string;
|
|
4575
5167
|
/** Title of the work object. */
|
|
@@ -4592,12 +5184,12 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
|
|
|
4592
5184
|
* The [part](https://devrev.ai/docs/product/parts) that the work
|
|
4593
5185
|
* applies to. Specifying a part is required when creating tickets and
|
|
4594
5186
|
* issues.
|
|
4595
|
-
* @example "
|
|
5187
|
+
* @example "PROD-12345"
|
|
4596
5188
|
*/
|
|
4597
5189
|
applies_to_part: string;
|
|
4598
5190
|
/**
|
|
4599
5191
|
* The IDs of the artifacts to associate with the work item.
|
|
4600
|
-
* @example ["
|
|
5192
|
+
* @example ["ARTIFACT-12345"]
|
|
4601
5193
|
*/
|
|
4602
5194
|
artifacts?: string[];
|
|
4603
5195
|
/** Body of the work object. */
|
|
@@ -4611,12 +5203,12 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
|
|
|
4611
5203
|
custom_schema_fragments?: string[];
|
|
4612
5204
|
/**
|
|
4613
5205
|
* The users that own the work.
|
|
4614
|
-
* @example ["
|
|
5206
|
+
* @example ["DEVU-12345"]
|
|
4615
5207
|
*/
|
|
4616
5208
|
owned_by: string[];
|
|
4617
5209
|
/**
|
|
4618
5210
|
* The users that reported the work.
|
|
4619
|
-
* @example ["
|
|
5211
|
+
* @example ["DEVU-12345"]
|
|
4620
5212
|
*/
|
|
4621
5213
|
reported_by?: string[];
|
|
4622
5214
|
/** Sets an object's initial stage. */
|
|
@@ -4626,6 +5218,7 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
|
|
|
4626
5218
|
/**
|
|
4627
5219
|
* Timestamp for when the work is expected to be complete.
|
|
4628
5220
|
* @format date-time
|
|
5221
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4629
5222
|
*/
|
|
4630
5223
|
target_close_date?: string;
|
|
4631
5224
|
/** Title of the work object. */
|
|
@@ -4643,7 +5236,7 @@ export interface WorksCreateRequestIssue {
|
|
|
4643
5236
|
export interface WorksCreateRequestOpportunity {
|
|
4644
5237
|
/**
|
|
4645
5238
|
* The ID of the account that the opportunity is associated with.
|
|
4646
|
-
* @example "
|
|
5239
|
+
* @example "ACC-12345"
|
|
4647
5240
|
*/
|
|
4648
5241
|
account: string;
|
|
4649
5242
|
/**
|
|
@@ -4677,6 +5270,7 @@ export interface WorksCreateRequestTask {
|
|
|
4677
5270
|
/**
|
|
4678
5271
|
* Timestamp when the task was started.
|
|
4679
5272
|
* @format date-time
|
|
5273
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4680
5274
|
*/
|
|
4681
5275
|
start_date?: string;
|
|
4682
5276
|
}
|
|
@@ -4688,7 +5282,7 @@ export interface WorksCreateRequestTicket {
|
|
|
4688
5282
|
is_spam?: boolean;
|
|
4689
5283
|
/**
|
|
4690
5284
|
* The Rev organization that the ticket is associated with.
|
|
4691
|
-
* @example "
|
|
5285
|
+
* @example "REV-AbCdEfGh"
|
|
4692
5286
|
*/
|
|
4693
5287
|
rev_org?: string;
|
|
4694
5288
|
/** Severity of the ticket. */
|
|
@@ -4704,7 +5298,7 @@ export interface WorksCreateResponse {
|
|
|
4704
5298
|
export interface WorksDeleteRequest {
|
|
4705
5299
|
/**
|
|
4706
5300
|
* The work's ID.
|
|
4707
|
-
* @example "
|
|
5301
|
+
* @example "ISS-12345"
|
|
4708
5302
|
*/
|
|
4709
5303
|
id: string;
|
|
4710
5304
|
}
|
|
@@ -4716,12 +5310,12 @@ export interface WorksExportRequest {
|
|
|
4716
5310
|
actual_close_date?: DateFilter;
|
|
4717
5311
|
/**
|
|
4718
5312
|
* Filters for work belonging to any of the provided parts.
|
|
4719
|
-
* @example ["
|
|
5313
|
+
* @example ["PROD-12345"]
|
|
4720
5314
|
*/
|
|
4721
5315
|
applies_to_part?: string[];
|
|
4722
5316
|
/**
|
|
4723
5317
|
* Filters for work created by any of these users.
|
|
4724
|
-
* @example ["
|
|
5318
|
+
* @example ["DEVU-12345"]
|
|
4725
5319
|
*/
|
|
4726
5320
|
created_by?: string[];
|
|
4727
5321
|
/** Provides ways to specify date ranges on objects. */
|
|
@@ -4740,7 +5334,7 @@ export interface WorksExportRequest {
|
|
|
4740
5334
|
opportunity?: WorksFilterOpportunity;
|
|
4741
5335
|
/**
|
|
4742
5336
|
* Filters for work owned by any of these users.
|
|
4743
|
-
* @example ["
|
|
5337
|
+
* @example ["DEVU-12345"]
|
|
4744
5338
|
*/
|
|
4745
5339
|
owned_by?: string[];
|
|
4746
5340
|
/** Fields to sort the work items by and the direction to sort them. */
|
|
@@ -4749,7 +5343,7 @@ export interface WorksExportRequest {
|
|
|
4749
5343
|
stage?: StageFilter;
|
|
4750
5344
|
/**
|
|
4751
5345
|
* Filters for work with any of the provided tags.
|
|
4752
|
-
* @example ["
|
|
5346
|
+
* @example ["TAG-12345"]
|
|
4753
5347
|
*/
|
|
4754
5348
|
tags?: string[];
|
|
4755
5349
|
/** Provides ways to specify date ranges on objects. */
|
|
@@ -4769,7 +5363,7 @@ export interface WorksFilterIssue {
|
|
|
4769
5363
|
priority?: IssuePriority[];
|
|
4770
5364
|
/**
|
|
4771
5365
|
* Filters for issues with any of the provided Rev organizations.
|
|
4772
|
-
* @example ["
|
|
5366
|
+
* @example ["REV-AbCdEfGh"]
|
|
4773
5367
|
*/
|
|
4774
5368
|
rev_orgs?: string[];
|
|
4775
5369
|
}
|
|
@@ -4778,7 +5372,7 @@ export interface WorksFilterOpportunity {
|
|
|
4778
5372
|
/**
|
|
4779
5373
|
* Filters for opportunities belonging to any of the provided
|
|
4780
5374
|
* accounts.
|
|
4781
|
-
* @example ["
|
|
5375
|
+
* @example ["ACC-12345"]
|
|
4782
5376
|
*/
|
|
4783
5377
|
account?: string[];
|
|
4784
5378
|
/** Filters for opportunities with any of the provided contacts. */
|
|
@@ -4795,7 +5389,7 @@ export interface WorksFilterTicket {
|
|
|
4795
5389
|
/**
|
|
4796
5390
|
* Filters for tickets that are associated with any of the provided
|
|
4797
5391
|
* Rev organizations.
|
|
4798
|
-
* @example ["
|
|
5392
|
+
* @example ["REV-AbCdEfGh"]
|
|
4799
5393
|
*/
|
|
4800
5394
|
rev_org?: string[];
|
|
4801
5395
|
/** Filters for tickets with any of the provided severities. */
|
|
@@ -4811,7 +5405,7 @@ export interface WorksFilterTicket {
|
|
|
4811
5405
|
export interface WorksGetRequest {
|
|
4812
5406
|
/**
|
|
4813
5407
|
* The work's ID.
|
|
4814
|
-
* @example "
|
|
5408
|
+
* @example "ISS-12345"
|
|
4815
5409
|
*/
|
|
4816
5410
|
id: string;
|
|
4817
5411
|
}
|
|
@@ -4825,12 +5419,12 @@ export interface WorksListRequest {
|
|
|
4825
5419
|
actual_close_date?: DateFilter;
|
|
4826
5420
|
/**
|
|
4827
5421
|
* Filters for work belonging to any of the provided parts.
|
|
4828
|
-
* @example ["
|
|
5422
|
+
* @example ["PROD-12345"]
|
|
4829
5423
|
*/
|
|
4830
5424
|
applies_to_part?: string[];
|
|
4831
5425
|
/**
|
|
4832
5426
|
* Filters for work created by any of these users.
|
|
4833
|
-
* @example ["
|
|
5427
|
+
* @example ["DEVU-12345"]
|
|
4834
5428
|
*/
|
|
4835
5429
|
created_by?: string[];
|
|
4836
5430
|
/** Provides ways to specify date ranges on objects. */
|
|
@@ -4861,7 +5455,7 @@ export interface WorksListRequest {
|
|
|
4861
5455
|
opportunity?: WorksFilterOpportunity;
|
|
4862
5456
|
/**
|
|
4863
5457
|
* Filters for work owned by any of these users.
|
|
4864
|
-
* @example ["
|
|
5458
|
+
* @example ["DEVU-12345"]
|
|
4865
5459
|
*/
|
|
4866
5460
|
owned_by?: string[];
|
|
4867
5461
|
/** Fields to sort the works by and the direction to sort them. */
|
|
@@ -4870,7 +5464,7 @@ export interface WorksListRequest {
|
|
|
4870
5464
|
stage?: StageFilter;
|
|
4871
5465
|
/**
|
|
4872
5466
|
* Filters for work with any of the provided tags.
|
|
4873
|
-
* @example ["
|
|
5467
|
+
* @example ["TAG-12345"]
|
|
4874
5468
|
*/
|
|
4875
5469
|
tags?: string[];
|
|
4876
5470
|
/** Provides ways to specify date ranges on objects. */
|
|
@@ -4898,7 +5492,7 @@ export interface WorksListResponse {
|
|
|
4898
5492
|
export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateRequestOpportunity | WorksUpdateRequestTask | WorksUpdateRequestTicket) & {
|
|
4899
5493
|
/**
|
|
4900
5494
|
* Updates the part that the work item applies to.
|
|
4901
|
-
* @example "
|
|
5495
|
+
* @example "PROD-12345"
|
|
4902
5496
|
*/
|
|
4903
5497
|
applies_to_part?: string;
|
|
4904
5498
|
artifacts?: WorksUpdateRequestArtifactIds;
|
|
@@ -4913,7 +5507,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
4913
5507
|
custom_schema_fragments?: string[];
|
|
4914
5508
|
/**
|
|
4915
5509
|
* The work's ID.
|
|
4916
|
-
* @example "
|
|
5510
|
+
* @example "ISS-12345"
|
|
4917
5511
|
*/
|
|
4918
5512
|
id: string;
|
|
4919
5513
|
owned_by?: WorksUpdateRequestOwnedBy;
|
|
@@ -4924,8 +5518,9 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
4924
5518
|
/**
|
|
4925
5519
|
* Updates the timestamp for when the work is expected to be complete.
|
|
4926
5520
|
* @format date-time
|
|
5521
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4927
5522
|
*/
|
|
4928
|
-
target_close_date?: string;
|
|
5523
|
+
target_close_date?: string | null;
|
|
4929
5524
|
/** Updated title of the work object, or unchanged if not provided. */
|
|
4930
5525
|
title?: string;
|
|
4931
5526
|
type?: WorkType;
|
|
@@ -4934,7 +5529,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
4934
5529
|
export interface WorksUpdateRequestArtifactIds {
|
|
4935
5530
|
/**
|
|
4936
5531
|
* Sets the IDs to the provided artifact IDs.
|
|
4937
|
-
* @example ["
|
|
5532
|
+
* @example ["ARTIFACT-12345"]
|
|
4938
5533
|
*/
|
|
4939
5534
|
set?: string[];
|
|
4940
5535
|
}
|
|
@@ -4949,7 +5544,7 @@ export interface WorksUpdateRequestIssue {
|
|
|
4949
5544
|
export interface WorksUpdateRequestOpportunity {
|
|
4950
5545
|
/**
|
|
4951
5546
|
* Updates the account that the opportunity is associated with.
|
|
4952
|
-
* @example "
|
|
5547
|
+
* @example "ACC-12345"
|
|
4953
5548
|
*/
|
|
4954
5549
|
account?: string;
|
|
4955
5550
|
/**
|
|
@@ -4980,7 +5575,7 @@ export interface WorksUpdateRequestOwnedBy {
|
|
|
4980
5575
|
/**
|
|
4981
5576
|
* Sets the owner IDs to the provided user IDs. This must not be
|
|
4982
5577
|
* empty.
|
|
4983
|
-
* @example ["
|
|
5578
|
+
* @example ["DEVU-12345"]
|
|
4984
5579
|
*/
|
|
4985
5580
|
set?: string[];
|
|
4986
5581
|
}
|
|
@@ -4988,7 +5583,7 @@ export interface WorksUpdateRequestOwnedBy {
|
|
|
4988
5583
|
export interface WorksUpdateRequestReportedBy {
|
|
4989
5584
|
/**
|
|
4990
5585
|
* Sets the users that reported the work to the provided user IDs.
|
|
4991
|
-
* @example ["
|
|
5586
|
+
* @example ["DEVU-12345"]
|
|
4992
5587
|
*/
|
|
4993
5588
|
set?: string[];
|
|
4994
5589
|
}
|
|
@@ -5006,6 +5601,7 @@ export interface WorksUpdateRequestTask {
|
|
|
5006
5601
|
/**
|
|
5007
5602
|
* Timestamp when the task was started.
|
|
5008
5603
|
* @format date-time
|
|
5604
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5009
5605
|
*/
|
|
5010
5606
|
start_date?: string;
|
|
5011
5607
|
}
|
|
@@ -5017,7 +5613,7 @@ export interface WorksUpdateRequestTicket {
|
|
|
5017
5613
|
is_spam?: boolean;
|
|
5018
5614
|
/**
|
|
5019
5615
|
* Updates the Rev organization that the ticket is associated with.
|
|
5020
|
-
* @example "
|
|
5616
|
+
* @example "REV-AbCdEfGh"
|
|
5021
5617
|
*/
|
|
5022
5618
|
rev_org?: string | null;
|
|
5023
5619
|
/** Severity of the ticket. */
|
|
@@ -5108,12 +5704,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5108
5704
|
/**
|
|
5109
5705
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
5110
5706
|
* @format date-time
|
|
5707
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5111
5708
|
*/
|
|
5112
5709
|
'created_date.after'?: string;
|
|
5113
5710
|
/**
|
|
5114
5711
|
* Filters for objects created before the provided timestamp
|
|
5115
5712
|
* (inclusive).
|
|
5116
5713
|
* @format date-time
|
|
5714
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5117
5715
|
*/
|
|
5118
5716
|
'created_date.before'?: string;
|
|
5119
5717
|
/** Domains for accounts to be filtered. */
|
|
@@ -5130,12 +5728,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5130
5728
|
/**
|
|
5131
5729
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
5132
5730
|
* @format date-time
|
|
5731
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5133
5732
|
*/
|
|
5134
5733
|
'modified_date.after'?: string;
|
|
5135
5734
|
/**
|
|
5136
5735
|
* Filters for objects created before the provided timestamp
|
|
5137
5736
|
* (inclusive).
|
|
5138
5737
|
* @format date-time
|
|
5738
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5139
5739
|
*/
|
|
5140
5740
|
'modified_date.before'?: string;
|
|
5141
5741
|
/** Filters for accounts owned by the specified user(s). */
|
|
@@ -5167,7 +5767,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5167
5767
|
accountsGet: (query: {
|
|
5168
5768
|
/**
|
|
5169
5769
|
* The ID of the account to be retrieved.
|
|
5170
|
-
* @example "
|
|
5770
|
+
* @example "ACC-12345"
|
|
5171
5771
|
*/
|
|
5172
5772
|
id: string;
|
|
5173
5773
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any>>;
|
|
@@ -5194,12 +5794,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5194
5794
|
/**
|
|
5195
5795
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
5196
5796
|
* @format date-time
|
|
5797
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5197
5798
|
*/
|
|
5198
5799
|
'created_date.after'?: string;
|
|
5199
5800
|
/**
|
|
5200
5801
|
* Filters for objects created before the provided timestamp
|
|
5201
5802
|
* (inclusive).
|
|
5202
5803
|
* @format date-time
|
|
5804
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5203
5805
|
*/
|
|
5204
5806
|
'created_date.before'?: string;
|
|
5205
5807
|
/**
|
|
@@ -5225,12 +5827,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5225
5827
|
/**
|
|
5226
5828
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
5227
5829
|
* @format date-time
|
|
5830
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5228
5831
|
*/
|
|
5229
5832
|
'modified_date.after'?: string;
|
|
5230
5833
|
/**
|
|
5231
5834
|
* Filters for objects created before the provided timestamp
|
|
5232
5835
|
* (inclusive).
|
|
5233
5836
|
* @format date-time
|
|
5837
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5234
5838
|
*/
|
|
5235
5839
|
'modified_date.before'?: string;
|
|
5236
5840
|
/** Filters for accounts owned by the specified user(s). */
|
|
@@ -5246,22 +5850,87 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5246
5850
|
* @description Gets a list of accounts.
|
|
5247
5851
|
*
|
|
5248
5852
|
* @tags accounts
|
|
5249
|
-
* @name
|
|
5250
|
-
* @request
|
|
5251
|
-
* @secure
|
|
5252
|
-
|
|
5253
|
-
|
|
5254
|
-
|
|
5255
|
-
|
|
5256
|
-
|
|
5257
|
-
|
|
5258
|
-
|
|
5259
|
-
|
|
5260
|
-
|
|
5261
|
-
|
|
5262
|
-
|
|
5263
|
-
|
|
5264
|
-
|
|
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>;
|
|
5914
|
+
/**
|
|
5915
|
+
* @description Gets a list of accounts.
|
|
5916
|
+
*
|
|
5917
|
+
* @tags accounts
|
|
5918
|
+
* @name AccountsListPost
|
|
5919
|
+
* @request POST:/accounts.list
|
|
5920
|
+
* @secure
|
|
5921
|
+
*/
|
|
5922
|
+
accountsListPost: (data: AccountsListRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
5923
|
+
/**
|
|
5924
|
+
* @description Updates an account's information.
|
|
5925
|
+
*
|
|
5926
|
+
* @tags accounts
|
|
5927
|
+
* @name AccountsUpdate
|
|
5928
|
+
* @request POST:/accounts.update
|
|
5929
|
+
* @secure
|
|
5930
|
+
*/
|
|
5931
|
+
accountsUpdate: (data: AccountsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsUpdateResponse, any>>;
|
|
5932
|
+
/**
|
|
5933
|
+
* @description Get count of articles matching given filter.
|
|
5265
5934
|
*
|
|
5266
5935
|
* @tags articles
|
|
5267
5936
|
* @name ArticlesCount
|
|
@@ -5271,22 +5940,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5271
5940
|
articlesCount: (query?: {
|
|
5272
5941
|
/**
|
|
5273
5942
|
* Filters for articles belonging to any of the provided parts.
|
|
5274
|
-
* @example ["
|
|
5943
|
+
* @example ["PROD-12345"]
|
|
5275
5944
|
*/
|
|
5276
5945
|
applies_to_parts?: string[];
|
|
5277
5946
|
/**
|
|
5278
5947
|
* Filters for articles authored by any of the provided users.
|
|
5279
|
-
* @example ["
|
|
5948
|
+
* @example ["DEVU-12345"]
|
|
5280
5949
|
*/
|
|
5281
5950
|
authored_by?: string[];
|
|
5282
5951
|
/**
|
|
5283
5952
|
* Filters for articles created by any of the provided users.
|
|
5284
|
-
* @example ["
|
|
5953
|
+
* @example ["DEVU-12345"]
|
|
5285
5954
|
*/
|
|
5286
5955
|
created_by?: string[];
|
|
5287
5956
|
/**
|
|
5288
5957
|
* Filters for articles owned by any of the provided users.
|
|
5289
|
-
* @example ["
|
|
5958
|
+
* @example ["DEVU-12345"]
|
|
5290
5959
|
*/
|
|
5291
5960
|
owned_by?: string[];
|
|
5292
5961
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any>>;
|
|
@@ -5328,7 +5997,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5328
5997
|
getArticle: (query: {
|
|
5329
5998
|
/**
|
|
5330
5999
|
* The ID of the required article.
|
|
5331
|
-
* @example "
|
|
6000
|
+
* @example "ARTICLE-12345"
|
|
5332
6001
|
*/
|
|
5333
6002
|
id: string;
|
|
5334
6003
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
|
|
@@ -5352,17 +6021,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5352
6021
|
listArticles: (query?: {
|
|
5353
6022
|
/**
|
|
5354
6023
|
* Filters for articles belonging to any of the provided parts.
|
|
5355
|
-
* @example ["
|
|
6024
|
+
* @example ["PROD-12345"]
|
|
5356
6025
|
*/
|
|
5357
6026
|
applies_to_parts?: string[];
|
|
5358
6027
|
/**
|
|
5359
6028
|
* Filters for articles authored by any of the provided users.
|
|
5360
|
-
* @example ["
|
|
6029
|
+
* @example ["DEVU-12345"]
|
|
5361
6030
|
*/
|
|
5362
6031
|
authored_by?: string[];
|
|
5363
6032
|
/**
|
|
5364
6033
|
* Filters for articles created by any of the provided users.
|
|
5365
|
-
* @example ["
|
|
6034
|
+
* @example ["DEVU-12345"]
|
|
5366
6035
|
*/
|
|
5367
6036
|
created_by?: string[];
|
|
5368
6037
|
/**
|
|
@@ -5382,10 +6051,54 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5382
6051
|
mode?: ListMode;
|
|
5383
6052
|
/**
|
|
5384
6053
|
* Filters for articles owned by any of the provided users.
|
|
5385
|
-
* @example ["
|
|
6054
|
+
* @example ["DEVU-12345"]
|
|
5386
6055
|
*/
|
|
5387
6056
|
owned_by?: string[];
|
|
5388
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>;
|
|
5389
6102
|
/**
|
|
5390
6103
|
* @description Lists a collection of articles.
|
|
5391
6104
|
*
|
|
@@ -5451,7 +6164,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5451
6164
|
conversationsExport: (query?: {
|
|
5452
6165
|
/**
|
|
5453
6166
|
* Filters for conversations belonging to any of the provided parts.
|
|
5454
|
-
* @example ["
|
|
6167
|
+
* @example ["PROD-12345"]
|
|
5455
6168
|
*/
|
|
5456
6169
|
applies_to_parts?: string[];
|
|
5457
6170
|
/**
|
|
@@ -5468,18 +6181,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5468
6181
|
is_spam?: boolean;
|
|
5469
6182
|
/**
|
|
5470
6183
|
* Filters for conversations where these users are participants.
|
|
5471
|
-
* @example ["
|
|
6184
|
+
* @example ["DEVU-12345"]
|
|
5472
6185
|
*/
|
|
5473
6186
|
members?: string[];
|
|
5474
6187
|
/**
|
|
5475
6188
|
* Filters for conversations owned by any of these users.
|
|
5476
|
-
* @example ["
|
|
6189
|
+
* @example ["DEVU-12345"]
|
|
5477
6190
|
*/
|
|
5478
6191
|
owned_by?: string[];
|
|
5479
6192
|
/**
|
|
5480
6193
|
* Filters for conversations that are associated with any of the
|
|
5481
6194
|
* provided Rev organizations.
|
|
5482
|
-
* @example ["
|
|
6195
|
+
* @example ["REV-AbCdEfGh"]
|
|
5483
6196
|
*/
|
|
5484
6197
|
rev_org?: string[];
|
|
5485
6198
|
/** Filters for conversations with any of the provided source channels. */
|
|
@@ -5489,12 +6202,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5489
6202
|
/**
|
|
5490
6203
|
* Filters for conversations with any of the provided tags.
|
|
5491
6204
|
* @deprecated
|
|
5492
|
-
* @example ["
|
|
6205
|
+
* @example ["TAG-12345"]
|
|
5493
6206
|
*/
|
|
5494
6207
|
tags?: string[];
|
|
5495
6208
|
/**
|
|
5496
6209
|
* The ID of the tag.
|
|
5497
|
-
* @example "
|
|
6210
|
+
* @example "TAG-12345"
|
|
5498
6211
|
*/
|
|
5499
6212
|
'tags_v2.id'?: string;
|
|
5500
6213
|
/**
|
|
@@ -5544,7 +6257,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5544
6257
|
conversationsList: (query?: {
|
|
5545
6258
|
/**
|
|
5546
6259
|
* Filters for conversations belonging to any of the provided parts.
|
|
5547
|
-
* @example ["
|
|
6260
|
+
* @example ["PROD-12345"]
|
|
5548
6261
|
*/
|
|
5549
6262
|
applies_to_parts?: string[];
|
|
5550
6263
|
/**
|
|
@@ -5565,7 +6278,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5565
6278
|
limit?: number;
|
|
5566
6279
|
/**
|
|
5567
6280
|
* Filters for conversations where these users are participants.
|
|
5568
|
-
* @example ["
|
|
6281
|
+
* @example ["DEVU-12345"]
|
|
5569
6282
|
*/
|
|
5570
6283
|
members?: string[];
|
|
5571
6284
|
/**
|
|
@@ -5575,13 +6288,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5575
6288
|
mode?: ListMode;
|
|
5576
6289
|
/**
|
|
5577
6290
|
* Filters for conversations owned by any of these users.
|
|
5578
|
-
* @example ["
|
|
6291
|
+
* @example ["DEVU-12345"]
|
|
5579
6292
|
*/
|
|
5580
6293
|
owned_by?: string[];
|
|
5581
6294
|
/**
|
|
5582
6295
|
* Filters for conversations that are associated with any of the
|
|
5583
6296
|
* provided Rev organizations.
|
|
5584
|
-
* @example ["
|
|
6297
|
+
* @example ["REV-AbCdEfGh"]
|
|
5585
6298
|
*/
|
|
5586
6299
|
rev_org?: string[];
|
|
5587
6300
|
/** Filters for conversations with any of the provided source channels. */
|
|
@@ -5591,12 +6304,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5591
6304
|
/**
|
|
5592
6305
|
* Filters for conversations with any of the provided tags.
|
|
5593
6306
|
* @deprecated
|
|
5594
|
-
* @example ["
|
|
6307
|
+
* @example ["TAG-12345"]
|
|
5595
6308
|
*/
|
|
5596
6309
|
tags?: string[];
|
|
5597
6310
|
/**
|
|
5598
6311
|
* The ID of the tag.
|
|
5599
|
-
* @example "
|
|
6312
|
+
* @example "TAG-12345"
|
|
5600
6313
|
*/
|
|
5601
6314
|
'tags_v2.id'?: string;
|
|
5602
6315
|
/**
|
|
@@ -5605,6 +6318,77 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5605
6318
|
*/
|
|
5606
6319
|
'tags_v2.value'?: string;
|
|
5607
6320
|
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
|
|
6321
|
+
/**
|
|
6322
|
+
* @description Lists the available conversations.
|
|
6323
|
+
*
|
|
6324
|
+
* @tags conversations
|
|
6325
|
+
* @name ConversationsList
|
|
6326
|
+
* @request GET:/conversations.list
|
|
6327
|
+
* @secure */
|
|
6328
|
+
conversationsListPaginator(query?: {
|
|
6329
|
+
/**
|
|
6330
|
+
* Filters for conversations belonging to any of the provided parts.
|
|
6331
|
+
* @example ["PROD-12345"]
|
|
6332
|
+
*/
|
|
6333
|
+
applies_to_parts?: string[];
|
|
6334
|
+
/**
|
|
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>;
|
|
5608
6392
|
/**
|
|
5609
6393
|
* @description Lists the available conversations.
|
|
5610
6394
|
*
|
|
@@ -5636,12 +6420,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5636
6420
|
external_ref?: string[];
|
|
5637
6421
|
/**
|
|
5638
6422
|
* Filters for engagement of the provided members.
|
|
5639
|
-
* @example ["
|
|
6423
|
+
* @example ["DEVU-12345"]
|
|
5640
6424
|
*/
|
|
5641
6425
|
members?: string[];
|
|
5642
6426
|
/**
|
|
5643
6427
|
* Filters for engagements with the provided parent.
|
|
5644
|
-
* @example ["
|
|
6428
|
+
* @example ["ACC-12345"]
|
|
5645
6429
|
*/
|
|
5646
6430
|
parent?: string[];
|
|
5647
6431
|
/** Filters for engagement of the provided types. */
|
|
@@ -5718,7 +6502,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5718
6502
|
limit?: number;
|
|
5719
6503
|
/**
|
|
5720
6504
|
* Filters for engagement of the provided members.
|
|
5721
|
-
* @example ["
|
|
6505
|
+
* @example ["DEVU-12345"]
|
|
5722
6506
|
*/
|
|
5723
6507
|
members?: string[];
|
|
5724
6508
|
/**
|
|
@@ -5728,7 +6512,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5728
6512
|
mode?: ListMode;
|
|
5729
6513
|
/**
|
|
5730
6514
|
* Filters for engagements with the provided parent.
|
|
5731
|
-
* @example ["
|
|
6515
|
+
* @example ["ACC-12345"]
|
|
5732
6516
|
*/
|
|
5733
6517
|
parent?: string[];
|
|
5734
6518
|
/** Fields to sort the engagements by and the direction to sort them. */
|
|
@@ -5736,6 +6520,46 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5736
6520
|
/** Filters for engagement of the provided types. */
|
|
5737
6521
|
type?: EngagementType[];
|
|
5738
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>;
|
|
5739
6563
|
/**
|
|
5740
6564
|
* @description Lists the engagement records.
|
|
5741
6565
|
*
|
|
@@ -5852,6 +6676,34 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5852
6676
|
/** Comma-separated fields to sort the groups by. */
|
|
5853
6677
|
sort_by?: string[];
|
|
5854
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>;
|
|
5855
6707
|
/**
|
|
5856
6708
|
* @description Lists the available groups.
|
|
5857
6709
|
*
|
|
@@ -5957,31 +6809,74 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5957
6809
|
* @description Lists the available links.
|
|
5958
6810
|
*
|
|
5959
6811
|
* @tags links
|
|
5960
|
-
* @name
|
|
5961
|
-
* @request
|
|
5962
|
-
* @secure
|
|
5963
|
-
|
|
5964
|
-
|
|
5965
|
-
|
|
5966
|
-
* @description Lists metric definitions matching a filter.
|
|
5967
|
-
*
|
|
5968
|
-
* @tags slas
|
|
5969
|
-
* @name MetricDefinitionsList
|
|
5970
|
-
* @request GET:/metric-definitions.list
|
|
5971
|
-
* @secure
|
|
5972
|
-
*/
|
|
5973
|
-
metricDefinitionsList: (query?: {
|
|
5974
|
-
/** The type of objects the metric definition applies to. */
|
|
5975
|
-
applies_to_type?: MetricDefinitionAppliesTo[];
|
|
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;
|
|
5976
6818
|
/**
|
|
5977
6819
|
* The cursor to resume iteration from. If not provided, then iteration
|
|
5978
6820
|
* starts from the beginning.
|
|
5979
6821
|
*/
|
|
5980
6822
|
cursor?: string;
|
|
5981
6823
|
/**
|
|
5982
|
-
* The
|
|
5983
|
-
*
|
|
5984
|
-
*/
|
|
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>;
|
|
6851
|
+
/**
|
|
6852
|
+
* @description Lists the available links.
|
|
6853
|
+
*
|
|
6854
|
+
* @tags links
|
|
6855
|
+
* @name LinksListPost
|
|
6856
|
+
* @request POST:/links.list
|
|
6857
|
+
* @secure
|
|
6858
|
+
*/
|
|
6859
|
+
linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
|
|
6860
|
+
/**
|
|
6861
|
+
* @description Lists metric definitions matching a filter.
|
|
6862
|
+
*
|
|
6863
|
+
* @tags slas
|
|
6864
|
+
* @name MetricDefinitionsList
|
|
6865
|
+
* @request GET:/metric-definitions.list
|
|
6866
|
+
* @secure
|
|
6867
|
+
*/
|
|
6868
|
+
metricDefinitionsList: (query?: {
|
|
6869
|
+
/** The type of objects the metric definition applies to. */
|
|
6870
|
+
applies_to_type?: MetricDefinitionAppliesTo[];
|
|
6871
|
+
/**
|
|
6872
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
6873
|
+
* starts from the beginning.
|
|
6874
|
+
*/
|
|
6875
|
+
cursor?: string;
|
|
6876
|
+
/**
|
|
6877
|
+
* The maximum number of records to return. The default is '50'.
|
|
6878
|
+
* @format int32
|
|
6879
|
+
*/
|
|
5985
6880
|
limit?: number;
|
|
5986
6881
|
/**
|
|
5987
6882
|
* The iteration mode to use, otherwise if not set, then "after" is
|
|
@@ -5991,6 +6886,34 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5991
6886
|
/** The type of metric definitions sought. */
|
|
5992
6887
|
type?: MetricDefinitionMetricType[];
|
|
5993
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>;
|
|
5994
6917
|
/**
|
|
5995
6918
|
* @description Lists metric definitions matching a filter.
|
|
5996
6919
|
*
|
|
@@ -6108,6 +7031,35 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6108
7031
|
/** The organization schedule statuses the filter matches. */
|
|
6109
7032
|
status?: OrgScheduleStatus[];
|
|
6110
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>;
|
|
6111
7063
|
/**
|
|
6112
7064
|
* @description Gets list of organization schedules.
|
|
6113
7065
|
*
|
|
@@ -6144,6 +7096,169 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6144
7096
|
* @secure
|
|
6145
7097
|
*/
|
|
6146
7098
|
orgSchedulesUpdate: (data: OrgSchedulesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesUpdateResponse, any>>;
|
|
7099
|
+
/**
|
|
7100
|
+
* @description Creates new [part](https://devrev.ai/docs/product/parts).
|
|
7101
|
+
*
|
|
7102
|
+
* @tags parts
|
|
7103
|
+
* @name PartsCreate
|
|
7104
|
+
* @request POST:/parts.create
|
|
7105
|
+
* @secure
|
|
7106
|
+
*/
|
|
7107
|
+
partsCreate: (data: PartsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsCreateResponse, any>>;
|
|
7108
|
+
/**
|
|
7109
|
+
* @description Deletes a [part](https://devrev.ai/docs/product/parts).
|
|
7110
|
+
*
|
|
7111
|
+
* @tags parts
|
|
7112
|
+
* @name PartsDelete
|
|
7113
|
+
* @request POST:/parts.delete
|
|
7114
|
+
* @secure
|
|
7115
|
+
*/
|
|
7116
|
+
partsDelete: (data: PartsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
7117
|
+
/**
|
|
7118
|
+
* @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
|
|
7119
|
+
*
|
|
7120
|
+
* @tags parts
|
|
7121
|
+
* @name PartsGet
|
|
7122
|
+
* @request GET:/parts.get
|
|
7123
|
+
* @secure
|
|
7124
|
+
*/
|
|
7125
|
+
partsGet: (query: {
|
|
7126
|
+
/**
|
|
7127
|
+
* The ID of the part to retrieve.
|
|
7128
|
+
* @example "PROD-12345"
|
|
7129
|
+
*/
|
|
7130
|
+
id: string;
|
|
7131
|
+
}, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any>>;
|
|
7132
|
+
/**
|
|
7133
|
+
* @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
|
|
7134
|
+
*
|
|
7135
|
+
* @tags parts
|
|
7136
|
+
* @name PartsGetPost
|
|
7137
|
+
* @request POST:/parts.get
|
|
7138
|
+
* @secure
|
|
7139
|
+
*/
|
|
7140
|
+
partsGetPost: (data: PartsGetRequest, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any>>;
|
|
7141
|
+
/**
|
|
7142
|
+
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
7143
|
+
*
|
|
7144
|
+
* @tags parts
|
|
7145
|
+
* @name PartsList
|
|
7146
|
+
* @request GET:/parts.list
|
|
7147
|
+
* @secure
|
|
7148
|
+
*/
|
|
7149
|
+
partsList: (query?: {
|
|
7150
|
+
/**
|
|
7151
|
+
* Filters for parts created by any of these users.
|
|
7152
|
+
* @example ["DEVU-12345"]
|
|
7153
|
+
*/
|
|
7154
|
+
created_by?: string[];
|
|
7155
|
+
/**
|
|
7156
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
7157
|
+
* starts from the beginning.
|
|
7158
|
+
*/
|
|
7159
|
+
cursor?: string;
|
|
7160
|
+
/**
|
|
7161
|
+
* The maximum number of parts to return. The default is '50'.
|
|
7162
|
+
* @format int32
|
|
7163
|
+
*/
|
|
7164
|
+
limit?: number;
|
|
7165
|
+
/**
|
|
7166
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
7167
|
+
* used.
|
|
7168
|
+
*/
|
|
7169
|
+
mode?: ListMode;
|
|
7170
|
+
/** Filters for parts of the provided name(s). */
|
|
7171
|
+
name?: string[];
|
|
7172
|
+
/**
|
|
7173
|
+
* Filters for parts owned by any of these users.
|
|
7174
|
+
* @example ["DEVU-12345"]
|
|
7175
|
+
*/
|
|
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[];
|
|
7190
|
+
/** Filters for parts of the provided type(s). */
|
|
7191
|
+
type?: PartType[];
|
|
7192
|
+
}, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
|
|
7193
|
+
/**
|
|
7194
|
+
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
7195
|
+
*
|
|
7196
|
+
* @tags parts
|
|
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
|
+
*/
|
|
7261
|
+
partsUpdate: (data: PartsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsUpdateResponse, any>>;
|
|
6147
7262
|
/**
|
|
6148
7263
|
* @description Creates a Rev organization in the authenticated user's Dev organization.
|
|
6149
7264
|
*
|
|
@@ -6165,12 +7280,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6165
7280
|
/**
|
|
6166
7281
|
* The ID of account for which default Rev organization is to be
|
|
6167
7282
|
* fetched.
|
|
6168
|
-
* @example "
|
|
7283
|
+
* @example "ACC-12345"
|
|
6169
7284
|
*/
|
|
6170
7285
|
account?: string;
|
|
6171
7286
|
/**
|
|
6172
7287
|
* The ID of the required Rev organization.
|
|
6173
|
-
* @example "
|
|
7288
|
+
* @example "REV-AbCdEfGh"
|
|
6174
7289
|
*/
|
|
6175
7290
|
id?: string;
|
|
6176
7291
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
|
|
@@ -6194,7 +7309,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6194
7309
|
revOrgsList: (query?: {
|
|
6195
7310
|
/**
|
|
6196
7311
|
* Filters by account.
|
|
6197
|
-
* @example ["
|
|
7312
|
+
* @example ["ACC-12345"]
|
|
6198
7313
|
*/
|
|
6199
7314
|
account?: string[];
|
|
6200
7315
|
/** Filters by creator. */
|
|
@@ -6202,12 +7317,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6202
7317
|
/**
|
|
6203
7318
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
6204
7319
|
* @format date-time
|
|
7320
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6205
7321
|
*/
|
|
6206
7322
|
'created_date.after'?: string;
|
|
6207
7323
|
/**
|
|
6208
7324
|
* Filters for objects created before the provided timestamp
|
|
6209
7325
|
* (inclusive).
|
|
6210
7326
|
* @format date-time
|
|
7327
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6211
7328
|
*/
|
|
6212
7329
|
'created_date.before'?: string;
|
|
6213
7330
|
/**
|
|
@@ -6235,12 +7352,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6235
7352
|
/**
|
|
6236
7353
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
6237
7354
|
* @format date-time
|
|
7355
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6238
7356
|
*/
|
|
6239
7357
|
'modified_date.after'?: string;
|
|
6240
7358
|
/**
|
|
6241
7359
|
* Filters for objects created before the provided timestamp
|
|
6242
7360
|
* (inclusive).
|
|
6243
7361
|
* @format date-time
|
|
7362
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6244
7363
|
*/
|
|
6245
7364
|
'modified_date.before'?: string;
|
|
6246
7365
|
/**
|
|
@@ -6249,6 +7368,75 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6249
7368
|
*/
|
|
6250
7369
|
sort_by?: string[];
|
|
6251
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>;
|
|
6252
7440
|
/**
|
|
6253
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.
|
|
6254
7442
|
*
|
|
@@ -6329,12 +7517,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6329
7517
|
/**
|
|
6330
7518
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
6331
7519
|
* @format date-time
|
|
7520
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6332
7521
|
*/
|
|
6333
7522
|
'created_date.after'?: string;
|
|
6334
7523
|
/**
|
|
6335
7524
|
* Filters for objects created before the provided timestamp
|
|
6336
7525
|
* (inclusive).
|
|
6337
7526
|
* @format date-time
|
|
7527
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6338
7528
|
*/
|
|
6339
7529
|
'created_date.before'?: string;
|
|
6340
7530
|
/**
|
|
@@ -6361,24 +7551,93 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6361
7551
|
/**
|
|
6362
7552
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
6363
7553
|
* @format date-time
|
|
7554
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6364
7555
|
*/
|
|
6365
7556
|
'modified_date.after'?: string;
|
|
6366
7557
|
/**
|
|
6367
7558
|
* Filters for objects created before the provided timestamp
|
|
6368
7559
|
* (inclusive).
|
|
6369
7560
|
* @format date-time
|
|
7561
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
6370
7562
|
*/
|
|
6371
7563
|
'modified_date.before'?: string;
|
|
6372
7564
|
/** List of phone numbers to filter Rev users on. */
|
|
6373
7565
|
phone_numbers?: string[];
|
|
6374
7566
|
/**
|
|
6375
7567
|
* List of IDs of Rev organizations to be filtered.
|
|
6376
|
-
* @example ["
|
|
7568
|
+
* @example ["REV-AbCdEfGh"]
|
|
6377
7569
|
*/
|
|
6378
7570
|
rev_org?: string[];
|
|
6379
7571
|
/** Fields to sort the Rev users by and the direction to sort them. */
|
|
6380
7572
|
sort_by?: string[];
|
|
6381
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>;
|
|
6382
7641
|
/**
|
|
6383
7642
|
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.
|
|
6384
7643
|
*
|
|
@@ -6456,9 +7715,38 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6456
7715
|
* @tags customization
|
|
6457
7716
|
* @name CustomSchemaFragmentsList
|
|
6458
7717
|
* @request GET:/schemas.custom.list
|
|
6459
|
-
* @secure
|
|
6460
|
-
*/
|
|
6461
|
-
customSchemaFragmentsList: (query?: {
|
|
7718
|
+
* @secure
|
|
7719
|
+
*/
|
|
7720
|
+
customSchemaFragmentsList: (query?: {
|
|
7721
|
+
/** The list of app names. */
|
|
7722
|
+
app?: string[];
|
|
7723
|
+
/**
|
|
7724
|
+
* The cursor to resume iteration from, otherwise if not provided, then
|
|
7725
|
+
* iteration starts from the beginning.
|
|
7726
|
+
*/
|
|
7727
|
+
cursor?: string;
|
|
7728
|
+
/** The list of leaf types. */
|
|
7729
|
+
leaf_type?: string[];
|
|
7730
|
+
/**
|
|
7731
|
+
* The maximum number of items.
|
|
7732
|
+
* @format int32
|
|
7733
|
+
*/
|
|
7734
|
+
limit?: number;
|
|
7735
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
7736
|
+
sort_by?: string[];
|
|
7737
|
+
/** The list of subtypes. */
|
|
7738
|
+
subtype?: string[];
|
|
7739
|
+
/** Filters for custom schema fragment of the provided types. */
|
|
7740
|
+
types?: CustomSchemaFragmentType[];
|
|
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?: {
|
|
6462
7750
|
/** The list of app names. */
|
|
6463
7751
|
app?: string[];
|
|
6464
7752
|
/**
|
|
@@ -6479,7 +7767,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6479
7767
|
subtype?: string[];
|
|
6480
7768
|
/** Filters for custom schema fragment of the provided types. */
|
|
6481
7769
|
types?: CustomSchemaFragmentType[];
|
|
6482
|
-
}, params?: RequestParams)
|
|
7770
|
+
}, params?: RequestParams): AsyncGenerator<CustomSchemaFragmentsListResponse, void, unknown>;
|
|
6483
7771
|
/**
|
|
6484
7772
|
* @description Lists custom schema fragments.
|
|
6485
7773
|
*
|
|
@@ -6611,6 +7899,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6611
7899
|
/** The SLA statuses the filter matches. */
|
|
6612
7900
|
status?: SlaStatus[];
|
|
6613
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>;
|
|
6614
7928
|
/**
|
|
6615
7929
|
* @description Lists SLAs matching a filter.
|
|
6616
7930
|
*
|
|
@@ -6666,6 +7980,33 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6666
7980
|
/** Fields to sort the system users by and the direction to sort them. */
|
|
6667
7981
|
sort_by?: string[];
|
|
6668
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>;
|
|
6669
8010
|
/**
|
|
6670
8011
|
* @description Lists system users within your organization.
|
|
6671
8012
|
*
|
|
@@ -6704,7 +8045,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6704
8045
|
timelineEntriesList: (query: {
|
|
6705
8046
|
/**
|
|
6706
8047
|
* The ID of the object to list timeline entries for.
|
|
6707
|
-
* @example "
|
|
8048
|
+
* @example "PROD-12345"
|
|
6708
8049
|
*/
|
|
6709
8050
|
object: string;
|
|
6710
8051
|
/**
|
|
@@ -6742,6 +8083,54 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6742
8083
|
*/
|
|
6743
8084
|
visibility?: TimelineEntryVisibility[];
|
|
6744
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>;
|
|
6745
8134
|
/**
|
|
6746
8135
|
* @description Lists the timeline entries for an object.
|
|
6747
8136
|
*
|
|
@@ -6760,6 +8149,166 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6760
8149
|
* @secure
|
|
6761
8150
|
*/
|
|
6762
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>>;
|
|
6763
8312
|
/**
|
|
6764
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.
|
|
6765
8314
|
*
|
|
@@ -6789,12 +8338,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6789
8338
|
worksExport: (query?: {
|
|
6790
8339
|
/**
|
|
6791
8340
|
* Filters for work belonging to any of the provided parts.
|
|
6792
|
-
* @example ["
|
|
8341
|
+
* @example ["PROD-12345"]
|
|
6793
8342
|
*/
|
|
6794
8343
|
applies_to_part?: string[];
|
|
6795
8344
|
/**
|
|
6796
8345
|
* Filters for work created by any of these users.
|
|
6797
|
-
* @example ["
|
|
8346
|
+
* @example ["DEVU-12345"]
|
|
6798
8347
|
*/
|
|
6799
8348
|
created_by?: string[];
|
|
6800
8349
|
/** Filters for custom fields. */
|
|
@@ -6809,19 +8358,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6809
8358
|
'issue.priority'?: IssuePriority[];
|
|
6810
8359
|
/**
|
|
6811
8360
|
* Filters for issues with any of the provided Rev organizations.
|
|
6812
|
-
* @example ["
|
|
8361
|
+
* @example ["REV-AbCdEfGh"]
|
|
6813
8362
|
*/
|
|
6814
8363
|
'issue.rev_orgs'?: string[];
|
|
6815
8364
|
/**
|
|
6816
8365
|
* Filters for opportunities belonging to any of the provided accounts.
|
|
6817
|
-
* @example ["
|
|
8366
|
+
* @example ["ACC-12345"]
|
|
6818
8367
|
*/
|
|
6819
8368
|
'opportunity.account'?: string[];
|
|
6820
8369
|
/** Filters for opportunities with any of the provided contacts. */
|
|
6821
8370
|
'opportunity.contacts'?: string[];
|
|
6822
8371
|
/**
|
|
6823
8372
|
* Filters for work owned by any of these users.
|
|
6824
|
-
* @example ["
|
|
8373
|
+
* @example ["DEVU-12345"]
|
|
6825
8374
|
*/
|
|
6826
8375
|
owned_by?: string[];
|
|
6827
8376
|
/** Fields to sort the work items by and the direction to sort them. */
|
|
@@ -6830,7 +8379,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6830
8379
|
'stage.name'?: string[];
|
|
6831
8380
|
/**
|
|
6832
8381
|
* Filters for work with any of the provided tags.
|
|
6833
|
-
* @example ["
|
|
8382
|
+
* @example ["TAG-12345"]
|
|
6834
8383
|
*/
|
|
6835
8384
|
tags?: string[];
|
|
6836
8385
|
/** Filters for tickets belonging to specific groups. */
|
|
@@ -6842,7 +8391,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6842
8391
|
/**
|
|
6843
8392
|
* Filters for tickets that are associated with any of the provided Rev
|
|
6844
8393
|
* organizations.
|
|
6845
|
-
* @example ["
|
|
8394
|
+
* @example ["REV-AbCdEfGh"]
|
|
6846
8395
|
*/
|
|
6847
8396
|
'ticket.rev_org'?: string[];
|
|
6848
8397
|
/** Filters for tickets with any of the provided severities. */
|
|
@@ -6872,7 +8421,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6872
8421
|
worksGet: (query: {
|
|
6873
8422
|
/**
|
|
6874
8423
|
* The work's ID.
|
|
6875
|
-
* @example "
|
|
8424
|
+
* @example "ISS-12345"
|
|
6876
8425
|
*/
|
|
6877
8426
|
id: string;
|
|
6878
8427
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any>>;
|
|
@@ -6896,12 +8445,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6896
8445
|
worksList: (query?: {
|
|
6897
8446
|
/**
|
|
6898
8447
|
* Filters for work belonging to any of the provided parts.
|
|
6899
|
-
* @example ["
|
|
8448
|
+
* @example ["PROD-12345"]
|
|
6900
8449
|
*/
|
|
6901
8450
|
applies_to_part?: string[];
|
|
6902
8451
|
/**
|
|
6903
8452
|
* Filters for work created by any of these users.
|
|
6904
|
-
* @example ["
|
|
8453
|
+
* @example ["DEVU-12345"]
|
|
6905
8454
|
*/
|
|
6906
8455
|
created_by?: string[];
|
|
6907
8456
|
/**
|
|
@@ -6915,7 +8464,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6915
8464
|
'issue.priority'?: IssuePriority[];
|
|
6916
8465
|
/**
|
|
6917
8466
|
* Filters for issues with any of the provided Rev organizations.
|
|
6918
|
-
* @example ["
|
|
8467
|
+
* @example ["REV-AbCdEfGh"]
|
|
6919
8468
|
*/
|
|
6920
8469
|
'issue.rev_orgs'?: string[];
|
|
6921
8470
|
/**
|
|
@@ -6930,14 +8479,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6930
8479
|
mode?: ListMode;
|
|
6931
8480
|
/**
|
|
6932
8481
|
* Filters for opportunities belonging to any of the provided accounts.
|
|
6933
|
-
* @example ["
|
|
8482
|
+
* @example ["ACC-12345"]
|
|
6934
8483
|
*/
|
|
6935
8484
|
'opportunity.account'?: string[];
|
|
6936
8485
|
/** Filters for opportunities with any of the provided contacts. */
|
|
6937
8486
|
'opportunity.contacts'?: string[];
|
|
6938
8487
|
/**
|
|
6939
8488
|
* Filters for work owned by any of these users.
|
|
6940
|
-
* @example ["
|
|
8489
|
+
* @example ["DEVU-12345"]
|
|
6941
8490
|
*/
|
|
6942
8491
|
owned_by?: string[];
|
|
6943
8492
|
/** Fields to sort the works by and the direction to sort them. */
|
|
@@ -6946,7 +8495,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6946
8495
|
'stage.name'?: string[];
|
|
6947
8496
|
/**
|
|
6948
8497
|
* Filters for work with any of the provided tags.
|
|
6949
|
-
* @example ["
|
|
8498
|
+
* @example ["TAG-12345"]
|
|
6950
8499
|
*/
|
|
6951
8500
|
tags?: string[];
|
|
6952
8501
|
/** Filters for tickets belonging to specific groups. */
|
|
@@ -6958,7 +8507,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6958
8507
|
/**
|
|
6959
8508
|
* Filters for tickets that are associated with any of the provided Rev
|
|
6960
8509
|
* organizations.
|
|
6961
|
-
* @example ["
|
|
8510
|
+
* @example ["REV-AbCdEfGh"]
|
|
6962
8511
|
*/
|
|
6963
8512
|
'ticket.rev_org'?: string[];
|
|
6964
8513
|
/** Filters for tickets with any of the provided severities. */
|
|
@@ -6968,6 +8517,88 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6968
8517
|
/** Filters for work of the provided types. */
|
|
6969
8518
|
type?: WorkType[];
|
|
6970
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>;
|
|
6971
8602
|
/**
|
|
6972
8603
|
* @description Lists a collection of work items.
|
|
6973
8604
|
*
|