@devrev/typescript-sdk 1.1.50 → 1.1.52
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.
- package/README.md +106 -0
- package/dist/auto-generated/beta/beta-devrev-sdk.d.ts +270 -56
- package/dist/auto-generated/beta/beta-devrev-sdk.js +108 -51
- package/dist/auto-generated/public-devrev-sdk.d.ts +2497 -113
- package/dist/auto-generated/public-devrev-sdk.js +535 -12
- package/dist/snap-ins/beta-devrev-sdk-util.d.ts +9 -0
- package/dist/snap-ins/beta-devrev-sdk-util.js +121 -0
- package/dist/snap-ins/constants/error.d.ts +5 -0
- package/dist/snap-ins/constants/error.js +8 -0
- package/dist/snap-ins/constants/util.d.ts +12 -0
- package/dist/snap-ins/constants/util.js +16 -0
- package/dist/snap-ins/error.d.ts +1 -0
- package/dist/snap-ins/error.js +41 -0
- package/dist/snap-ins/util-types.d.ts +13 -0
- package/dist/snap-ins/util-types.js +2 -0
- package/dist/tests/beta-devrev-sdk-util.test.d.ts +1 -0
- package/dist/tests/beta-devrev-sdk-util.test.js +211 -0
- package/dist/tests/error.test.d.ts +1 -0
- package/dist/tests/error.test.js +118 -0
- package/package.json +1 -1
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
export declare enum AccessLevel {
|
|
2
|
+
External = "external",
|
|
3
|
+
Internal = "internal",
|
|
4
|
+
Private = "private",
|
|
5
|
+
Public = "public",
|
|
6
|
+
Restricted = "restricted"
|
|
7
|
+
}
|
|
1
8
|
/** account */
|
|
2
9
|
export type Account = OrgBase & {
|
|
3
10
|
/** Description of the corresponding Account. */
|
|
@@ -231,6 +238,19 @@ export interface AccountsUpdateRequestWebsites {
|
|
|
231
238
|
export interface AccountsUpdateResponse {
|
|
232
239
|
account: Account;
|
|
233
240
|
}
|
|
241
|
+
/** add-tag-with-value */
|
|
242
|
+
export interface AddTagWithValue {
|
|
243
|
+
/**
|
|
244
|
+
* The ID of the tag.
|
|
245
|
+
* @example "TAG-12345"
|
|
246
|
+
*/
|
|
247
|
+
id: string;
|
|
248
|
+
/**
|
|
249
|
+
* The value for the object's association with the tag. If specified,
|
|
250
|
+
* the value must be one that's specified in the tag's allowed values.
|
|
251
|
+
*/
|
|
252
|
+
value?: string;
|
|
253
|
+
}
|
|
234
254
|
/**
|
|
235
255
|
* ai-agent-event-execute-error
|
|
236
256
|
* An error object providing the error message for the AI agent event
|
|
@@ -289,6 +309,8 @@ export interface AiAgentEventExecuteProgressSkillTriggered {
|
|
|
289
309
|
* @maxLength 512
|
|
290
310
|
*/
|
|
291
311
|
skill_name: string;
|
|
312
|
+
/** The thought explaining why the skill was called. */
|
|
313
|
+
thought?: string;
|
|
292
314
|
workflow?: WorkflowSummary;
|
|
293
315
|
workflow_run?: WorkflowRunSummary;
|
|
294
316
|
}
|
|
@@ -387,10 +409,422 @@ export interface ArchetypeSlaSummary {
|
|
|
387
409
|
*/
|
|
388
410
|
target_time?: string;
|
|
389
411
|
}
|
|
412
|
+
/** article */
|
|
413
|
+
export type Article = AtomBase & {
|
|
414
|
+
/** Parts relevant to the article. */
|
|
415
|
+
applies_to_parts: PartSummary[];
|
|
416
|
+
/** Type of the article. */
|
|
417
|
+
article_type?: ArticleType;
|
|
418
|
+
/** Users that authored the article. */
|
|
419
|
+
authored_by?: UserSummary[];
|
|
420
|
+
/** Description of the article. */
|
|
421
|
+
description?: string;
|
|
422
|
+
/** Extracted content of the article. */
|
|
423
|
+
extracted_content?: ArtifactSummary[];
|
|
424
|
+
/**
|
|
425
|
+
* Number of downvotes on the article.
|
|
426
|
+
* @format int32
|
|
427
|
+
*/
|
|
428
|
+
num_downvotes?: number;
|
|
429
|
+
/**
|
|
430
|
+
* Number of upvotes on the article.
|
|
431
|
+
* @format int32
|
|
432
|
+
*/
|
|
433
|
+
num_upvotes?: number;
|
|
434
|
+
/** Users that own the article. */
|
|
435
|
+
owned_by: UserSummary[];
|
|
436
|
+
parent?: DirectorySummary;
|
|
437
|
+
/** Rank of the article. */
|
|
438
|
+
rank?: string;
|
|
439
|
+
/** Resource details. */
|
|
440
|
+
resource?: Resource;
|
|
441
|
+
/** The properties of an enum value. */
|
|
442
|
+
scope?: EnumValue;
|
|
443
|
+
/** Title of the article. */
|
|
444
|
+
title?: string;
|
|
445
|
+
};
|
|
446
|
+
/** Status of the article. */
|
|
447
|
+
export declare enum ArticleStatus {
|
|
448
|
+
Archived = "archived",
|
|
449
|
+
Draft = "draft",
|
|
450
|
+
Published = "published",
|
|
451
|
+
ReviewNeeded = "review_needed"
|
|
452
|
+
}
|
|
453
|
+
/** Type of the article. */
|
|
454
|
+
export declare enum ArticleType {
|
|
455
|
+
Article = "article",
|
|
456
|
+
ContentBlock = "content_block"
|
|
457
|
+
}
|
|
458
|
+
/**
|
|
459
|
+
* articles-create-request
|
|
460
|
+
* The request to create an article.
|
|
461
|
+
*/
|
|
462
|
+
export interface ArticlesCreateRequest {
|
|
463
|
+
access_level?: AccessLevel;
|
|
464
|
+
/**
|
|
465
|
+
* The aliases of the article.
|
|
466
|
+
* @maxItems 5
|
|
467
|
+
*/
|
|
468
|
+
aliases?: string[];
|
|
469
|
+
/**
|
|
470
|
+
* The parts that the article applies to.
|
|
471
|
+
* @minItems 1
|
|
472
|
+
* @example ["PROD-12345"]
|
|
473
|
+
*/
|
|
474
|
+
applies_to_parts: string[];
|
|
475
|
+
/** Type of the article. */
|
|
476
|
+
article_type?: ArticleType;
|
|
477
|
+
/**
|
|
478
|
+
* The authors of the article.
|
|
479
|
+
* @example ["DEVU-12345"]
|
|
480
|
+
*/
|
|
481
|
+
authored_by?: string[];
|
|
482
|
+
/** Application-defined custom fields. */
|
|
483
|
+
custom_fields?: object;
|
|
484
|
+
/**
|
|
485
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
486
|
+
* custom field must be specified, otherwise a bad request error is
|
|
487
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
488
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
489
|
+
* specifier, it remains unmodified.
|
|
490
|
+
*/
|
|
491
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
492
|
+
/** Description for the article. */
|
|
493
|
+
description?: string;
|
|
494
|
+
/**
|
|
495
|
+
* ID of the extracted content artifact.
|
|
496
|
+
* @example ["ARTIFACT-12345"]
|
|
497
|
+
*/
|
|
498
|
+
extracted_content?: string[];
|
|
499
|
+
/** Language of the article. */
|
|
500
|
+
language?: string;
|
|
501
|
+
/**
|
|
502
|
+
* The users that own the article.
|
|
503
|
+
* @example ["DEVU-12345"]
|
|
504
|
+
*/
|
|
505
|
+
owned_by: string[];
|
|
506
|
+
/** The parent directory of the article. */
|
|
507
|
+
parent?: string;
|
|
508
|
+
/**
|
|
509
|
+
* The published date of the article.
|
|
510
|
+
* @format date-time
|
|
511
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
512
|
+
*/
|
|
513
|
+
published_at?: string;
|
|
514
|
+
resource: ArticlesCreateRequestResource;
|
|
515
|
+
/**
|
|
516
|
+
* The scope of the article.
|
|
517
|
+
* @format int64
|
|
518
|
+
*/
|
|
519
|
+
scope?: number;
|
|
520
|
+
/** Information about the role the member receives due to the share. */
|
|
521
|
+
shared_with?: SetSharedWithMembership[];
|
|
522
|
+
/** Status of the article. */
|
|
523
|
+
status?: ArticleStatus;
|
|
524
|
+
/** Tags associated with the article. */
|
|
525
|
+
tags?: SetTagWithValue[];
|
|
526
|
+
/** Name of the article. */
|
|
527
|
+
title: string;
|
|
528
|
+
}
|
|
529
|
+
/** articles-create-request-resource */
|
|
530
|
+
export interface ArticlesCreateRequestResource {
|
|
531
|
+
/**
|
|
532
|
+
* IDs of the artifacts.
|
|
533
|
+
* @example ["ARTIFACT-12345"]
|
|
534
|
+
*/
|
|
535
|
+
artifacts?: string[];
|
|
536
|
+
/**
|
|
537
|
+
* List of content blocks used in the article.
|
|
538
|
+
* @example ["ARTICLE-12345"]
|
|
539
|
+
*/
|
|
540
|
+
content_blocks?: string[];
|
|
541
|
+
/** The latest published version. */
|
|
542
|
+
published_version?: string;
|
|
543
|
+
/** URL of the external article. */
|
|
544
|
+
url?: string;
|
|
545
|
+
}
|
|
546
|
+
/**
|
|
547
|
+
* articles-create-response
|
|
548
|
+
* Create article response.
|
|
549
|
+
*/
|
|
550
|
+
export interface ArticlesCreateResponse {
|
|
551
|
+
article: Article;
|
|
552
|
+
}
|
|
553
|
+
/**
|
|
554
|
+
* articles-delete-request
|
|
555
|
+
* The request to delete an article.
|
|
556
|
+
*/
|
|
557
|
+
export interface ArticlesDeleteRequest {
|
|
558
|
+
/**
|
|
559
|
+
* The ID of the article to delete.
|
|
560
|
+
* @example "ARTICLE-12345"
|
|
561
|
+
*/
|
|
562
|
+
id: string;
|
|
563
|
+
}
|
|
564
|
+
/** articles-delete-response */
|
|
565
|
+
export type ArticlesDeleteResponse = object;
|
|
566
|
+
/**
|
|
567
|
+
* articles-get-request
|
|
568
|
+
* The request to get an article.
|
|
569
|
+
*/
|
|
570
|
+
export interface ArticlesGetRequest {
|
|
571
|
+
/**
|
|
572
|
+
* The ID of the required article.
|
|
573
|
+
* @example "ARTICLE-12345"
|
|
574
|
+
*/
|
|
575
|
+
id: string;
|
|
576
|
+
}
|
|
577
|
+
/**
|
|
578
|
+
* articles-get-response
|
|
579
|
+
* Get article response.
|
|
580
|
+
*/
|
|
581
|
+
export interface ArticlesGetResponse {
|
|
582
|
+
article: Article;
|
|
583
|
+
}
|
|
584
|
+
/**
|
|
585
|
+
* articles-list-request
|
|
586
|
+
* The request to list articles.
|
|
587
|
+
*/
|
|
588
|
+
export interface ArticlesListRequest {
|
|
589
|
+
/**
|
|
590
|
+
* Filters for articles belonging to any of the provided parts.
|
|
591
|
+
* @example ["PROD-12345"]
|
|
592
|
+
*/
|
|
593
|
+
applies_to_parts?: string[];
|
|
594
|
+
/**
|
|
595
|
+
* Filter for the type of articles. If this is not provided, then
|
|
596
|
+
* articles that are not content blocks are returned.
|
|
597
|
+
*/
|
|
598
|
+
article_type?: ArticleType[];
|
|
599
|
+
/**
|
|
600
|
+
* Filters for articles authored by any of the provided users.
|
|
601
|
+
* @example ["DEVU-12345"]
|
|
602
|
+
*/
|
|
603
|
+
authored_by?: string[];
|
|
604
|
+
/**
|
|
605
|
+
* Filters for articles created by any of the provided users.
|
|
606
|
+
* @example ["DEVU-12345"]
|
|
607
|
+
*/
|
|
608
|
+
created_by?: string[];
|
|
609
|
+
/**
|
|
610
|
+
* The cursor to resume iteration from. If not provided, then
|
|
611
|
+
* iteration starts from the beginning.
|
|
612
|
+
*/
|
|
613
|
+
cursor?: string;
|
|
614
|
+
/**
|
|
615
|
+
* The maximum number of articles to return. The default is '50'.
|
|
616
|
+
* @format int32
|
|
617
|
+
*/
|
|
618
|
+
limit?: number;
|
|
619
|
+
/**
|
|
620
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
621
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
622
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
623
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
624
|
+
* always be returned in the specified sort-by order.
|
|
625
|
+
*/
|
|
626
|
+
mode?: ListMode;
|
|
627
|
+
/**
|
|
628
|
+
* Filters for articles modified by any of the provided users.
|
|
629
|
+
* @example ["DEVU-12345"]
|
|
630
|
+
*/
|
|
631
|
+
modified_by?: string[];
|
|
632
|
+
/**
|
|
633
|
+
* Filters for articles owned by any of the provided users.
|
|
634
|
+
* @example ["DEVU-12345"]
|
|
635
|
+
*/
|
|
636
|
+
owned_by?: string[];
|
|
637
|
+
/** Filter for the scope of the articles. */
|
|
638
|
+
scope?: number[];
|
|
639
|
+
/** Filter for articles based on intended audience. */
|
|
640
|
+
shared_with?: SharedWithMembershipFilter[];
|
|
641
|
+
}
|
|
642
|
+
/**
|
|
643
|
+
* articles-list-response
|
|
644
|
+
* List articles response.
|
|
645
|
+
*/
|
|
646
|
+
export interface ArticlesListResponse {
|
|
647
|
+
/** The article entries matching the request. */
|
|
648
|
+
articles: Article[];
|
|
649
|
+
/**
|
|
650
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
651
|
+
* sort order. If not set, then no later elements exist.
|
|
652
|
+
*/
|
|
653
|
+
next_cursor?: string;
|
|
654
|
+
/**
|
|
655
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
656
|
+
* sort order. If not set, then no prior elements exist.
|
|
657
|
+
*/
|
|
658
|
+
prev_cursor?: string;
|
|
659
|
+
/**
|
|
660
|
+
* Total number of article items for the request.
|
|
661
|
+
* @format int32
|
|
662
|
+
*/
|
|
663
|
+
total: number;
|
|
664
|
+
}
|
|
665
|
+
/**
|
|
666
|
+
* articles-update-request
|
|
667
|
+
* The request to update an article.
|
|
668
|
+
*/
|
|
669
|
+
export interface ArticlesUpdateRequest {
|
|
670
|
+
access_level?: AccessLevel;
|
|
671
|
+
aliases?: ArticlesUpdateRequestAliases;
|
|
672
|
+
applies_to_parts?: ArticlesUpdateRequestAppliesToParts;
|
|
673
|
+
artifacts?: ArticlesUpdateRequestArtifacts;
|
|
674
|
+
authored_by?: ArticlesUpdateRequestAuthoredBy;
|
|
675
|
+
content_blocks?: ArticlesUpdateRequestContentBlocks;
|
|
676
|
+
/** Application-defined custom fields. */
|
|
677
|
+
custom_fields?: object;
|
|
678
|
+
/**
|
|
679
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
680
|
+
* custom field must be specified, otherwise a bad request error is
|
|
681
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
682
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
683
|
+
* specifier, it remains unmodified.
|
|
684
|
+
*/
|
|
685
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
686
|
+
/**
|
|
687
|
+
* Updated description of the article object, or unchanged if not
|
|
688
|
+
* provided.
|
|
689
|
+
*/
|
|
690
|
+
description?: string;
|
|
691
|
+
extracted_content?: ArticlesUpdateRequestExtractedContent;
|
|
692
|
+
/**
|
|
693
|
+
* The article's ID.
|
|
694
|
+
* @example "ARTICLE-12345"
|
|
695
|
+
*/
|
|
696
|
+
id: string;
|
|
697
|
+
/** Updates the language of the article. */
|
|
698
|
+
language?: string;
|
|
699
|
+
owned_by?: ArticlesUpdateRequestOwnedBy;
|
|
700
|
+
/** The updated parent directory for the article. */
|
|
701
|
+
parent?: string | null;
|
|
702
|
+
/** Updates the the latest published version. */
|
|
703
|
+
published_version?: string;
|
|
704
|
+
reorder?: ArticlesUpdateRequestReorder;
|
|
705
|
+
shared_with?: ArticlesUpdateRequestSharedWith;
|
|
706
|
+
/** Status of the article. */
|
|
707
|
+
status?: ArticleStatus;
|
|
708
|
+
tags?: ArticlesUpdateRequestTags;
|
|
709
|
+
/** Updated title of the article object, or unchanged if not provided. */
|
|
710
|
+
title?: string;
|
|
711
|
+
/** Updates the URL of the external article. */
|
|
712
|
+
url?: string;
|
|
713
|
+
}
|
|
714
|
+
/** articles-update-request-aliases */
|
|
715
|
+
export interface ArticlesUpdateRequestAliases {
|
|
716
|
+
/**
|
|
717
|
+
* Updates the aliases of the article.
|
|
718
|
+
* @maxItems 5
|
|
719
|
+
*/
|
|
720
|
+
set: string[];
|
|
721
|
+
}
|
|
722
|
+
/** articles-update-request-applies-to-parts */
|
|
723
|
+
export interface ArticlesUpdateRequestAppliesToParts {
|
|
724
|
+
/**
|
|
725
|
+
* Updates the parts that the article applies to.
|
|
726
|
+
* @example ["PROD-12345"]
|
|
727
|
+
*/
|
|
728
|
+
set?: string[];
|
|
729
|
+
}
|
|
730
|
+
/** articles-update-request-artifacts */
|
|
731
|
+
export interface ArticlesUpdateRequestArtifacts {
|
|
732
|
+
/**
|
|
733
|
+
* Updates IDs of the artifacts.
|
|
734
|
+
* @example ["ARTIFACT-12345"]
|
|
735
|
+
*/
|
|
736
|
+
set?: string[];
|
|
737
|
+
}
|
|
738
|
+
/** articles-update-request-authored-by */
|
|
739
|
+
export interface ArticlesUpdateRequestAuthoredBy {
|
|
740
|
+
/**
|
|
741
|
+
* Sets the users that authored the article.
|
|
742
|
+
* @example ["DEVU-12345"]
|
|
743
|
+
*/
|
|
744
|
+
set?: string[];
|
|
745
|
+
}
|
|
746
|
+
/** articles-update-request-content-blocks */
|
|
747
|
+
export interface ArticlesUpdateRequestContentBlocks {
|
|
748
|
+
/**
|
|
749
|
+
* Updates IDs of the content blocks.
|
|
750
|
+
* @example ["ARTICLE-12345"]
|
|
751
|
+
*/
|
|
752
|
+
set: string[];
|
|
753
|
+
}
|
|
754
|
+
/** articles-update-request-extracted-content */
|
|
755
|
+
export interface ArticlesUpdateRequestExtractedContent {
|
|
756
|
+
/**
|
|
757
|
+
* Update the ID of the extracted content.
|
|
758
|
+
* @example ["ARTIFACT-12345"]
|
|
759
|
+
*/
|
|
760
|
+
set?: string[];
|
|
761
|
+
}
|
|
762
|
+
/** articles-update-request-owned-by */
|
|
763
|
+
export interface ArticlesUpdateRequestOwnedBy {
|
|
764
|
+
/**
|
|
765
|
+
* Sets the owner IDs to the provided user IDs. This must not be
|
|
766
|
+
* empty.
|
|
767
|
+
* @example ["DEVU-12345"]
|
|
768
|
+
*/
|
|
769
|
+
set?: string[];
|
|
770
|
+
}
|
|
771
|
+
/** articles-update-request-reorder */
|
|
772
|
+
export interface ArticlesUpdateRequestReorder {
|
|
773
|
+
/**
|
|
774
|
+
* The article after which the reordered article is placed.
|
|
775
|
+
* @example "ARTICLE-12345"
|
|
776
|
+
*/
|
|
777
|
+
after?: string;
|
|
778
|
+
/**
|
|
779
|
+
* The article before which the reordered article is placed.
|
|
780
|
+
* @example "ARTICLE-12345"
|
|
781
|
+
*/
|
|
782
|
+
before?: string;
|
|
783
|
+
}
|
|
784
|
+
/** articles-update-request-shared-with */
|
|
785
|
+
export interface ArticlesUpdateRequestSharedWith {
|
|
786
|
+
/** Sets the field to the provided membership list. */
|
|
787
|
+
set?: SetSharedWithMembership[];
|
|
788
|
+
}
|
|
789
|
+
/** articles-update-request-tags */
|
|
790
|
+
export interface ArticlesUpdateRequestTags {
|
|
791
|
+
/** Sets the provided tags on the article. */
|
|
792
|
+
set?: SetTagWithValue[];
|
|
793
|
+
}
|
|
794
|
+
/** articles-update-response */
|
|
795
|
+
export interface ArticlesUpdateResponse {
|
|
796
|
+
article: Article;
|
|
797
|
+
}
|
|
390
798
|
/** artifact */
|
|
391
|
-
export type Artifact = AtomBase
|
|
799
|
+
export type Artifact = AtomBase & {
|
|
800
|
+
/** Defines a file object. */
|
|
801
|
+
file?: ArtifactFile;
|
|
802
|
+
};
|
|
803
|
+
/**
|
|
804
|
+
* artifact-file
|
|
805
|
+
* Defines a file object.
|
|
806
|
+
*/
|
|
807
|
+
export interface ArtifactFile {
|
|
808
|
+
/** Type of the file. */
|
|
809
|
+
type?: string;
|
|
810
|
+
/** Name of the file. */
|
|
811
|
+
name?: string;
|
|
812
|
+
}
|
|
813
|
+
/**
|
|
814
|
+
* artifact-file-summary
|
|
815
|
+
* Defines a file object.
|
|
816
|
+
*/
|
|
817
|
+
export interface ArtifactFileSummary {
|
|
818
|
+
/** Type of the file. */
|
|
819
|
+
type?: string;
|
|
820
|
+
/** Name of the file. */
|
|
821
|
+
name?: string;
|
|
822
|
+
}
|
|
392
823
|
/** artifact-summary */
|
|
393
|
-
export type ArtifactSummary = AtomBaseSummary
|
|
824
|
+
export type ArtifactSummary = AtomBaseSummary & {
|
|
825
|
+
/** Defines a file object. */
|
|
826
|
+
file?: ArtifactFileSummary;
|
|
827
|
+
};
|
|
394
828
|
/**
|
|
395
829
|
* artifact-version
|
|
396
830
|
* The version of the artifact.
|
|
@@ -995,6 +1429,46 @@ export interface AuthTokensUserTraits {
|
|
|
995
1429
|
/** Phone numbers of the Rev user. */
|
|
996
1430
|
phone_numbers?: string[];
|
|
997
1431
|
}
|
|
1432
|
+
/**
|
|
1433
|
+
* boolean-expression
|
|
1434
|
+
* Boolean expression.
|
|
1435
|
+
*/
|
|
1436
|
+
export type BooleanExpression = (BooleanExpressionAndExpression | BooleanExpressionNotExpression | BooleanExpressionOrExpression | BooleanExpressionPrimitiveExpression) & {
|
|
1437
|
+
type: BooleanExpressionType;
|
|
1438
|
+
};
|
|
1439
|
+
/**
|
|
1440
|
+
* boolean-expression-and-expression
|
|
1441
|
+
* All the expressions would be 'and'ed together.
|
|
1442
|
+
*/
|
|
1443
|
+
export interface BooleanExpressionAndExpression {
|
|
1444
|
+
expressions: BooleanExpression[];
|
|
1445
|
+
}
|
|
1446
|
+
/**
|
|
1447
|
+
* boolean-expression-not-expression
|
|
1448
|
+
* The expression would be negated.
|
|
1449
|
+
*/
|
|
1450
|
+
export interface BooleanExpressionNotExpression {
|
|
1451
|
+
/** Boolean expression. */
|
|
1452
|
+
expression: BooleanExpression;
|
|
1453
|
+
}
|
|
1454
|
+
/**
|
|
1455
|
+
* boolean-expression-or-expression
|
|
1456
|
+
* All the expressions would be 'or'ed together.
|
|
1457
|
+
*/
|
|
1458
|
+
export interface BooleanExpressionOrExpression {
|
|
1459
|
+
expressions: BooleanExpression[];
|
|
1460
|
+
}
|
|
1461
|
+
/**
|
|
1462
|
+
* boolean-expression-primitive-expression
|
|
1463
|
+
* The primitive expression type.
|
|
1464
|
+
*/
|
|
1465
|
+
export type BooleanExpressionPrimitiveExpression = object;
|
|
1466
|
+
export declare enum BooleanExpressionType {
|
|
1467
|
+
And = "and",
|
|
1468
|
+
Not = "not",
|
|
1469
|
+
Or = "or",
|
|
1470
|
+
Primitive = "primitive"
|
|
1471
|
+
}
|
|
998
1472
|
/** capability */
|
|
999
1473
|
export type Capability = PartBase;
|
|
1000
1474
|
/** capability-summary */
|
|
@@ -1039,34 +1513,330 @@ export type ConversationSummary = AtomBaseSummary & {
|
|
|
1039
1513
|
title?: string;
|
|
1040
1514
|
};
|
|
1041
1515
|
/**
|
|
1042
|
-
*
|
|
1043
|
-
*
|
|
1516
|
+
* conversations-create-request
|
|
1517
|
+
* The request to create a new conversation.
|
|
1044
1518
|
*/
|
|
1045
|
-
export
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
/** Type of date filter. */
|
|
1050
|
-
export declare enum DateFilterType {
|
|
1051
|
-
Preset = "preset",
|
|
1052
|
-
Range = "range"
|
|
1053
|
-
}
|
|
1054
|
-
/** date-time-filter */
|
|
1055
|
-
export interface DateTimeFilter {
|
|
1519
|
+
export interface ConversationsCreateRequest {
|
|
1520
|
+
type: ConversationsCreateRequestTypeValue;
|
|
1521
|
+
/** Application-defined custom fields. */
|
|
1522
|
+
custom_fields?: object;
|
|
1056
1523
|
/**
|
|
1057
|
-
*
|
|
1058
|
-
*
|
|
1059
|
-
*
|
|
1060
|
-
*
|
|
1524
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
1525
|
+
* custom field must be specified, otherwise a bad request error is
|
|
1526
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
1527
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
1528
|
+
* specifier, it remains unmodified.
|
|
1061
1529
|
*/
|
|
1062
|
-
|
|
1530
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
1531
|
+
/** Description for the conversation. */
|
|
1532
|
+
description?: string;
|
|
1533
|
+
/** The group that the conversation is associated with. */
|
|
1534
|
+
group?: string;
|
|
1535
|
+
/** Whether the conversation is spam. */
|
|
1536
|
+
is_spam?: boolean;
|
|
1063
1537
|
/**
|
|
1064
|
-
*
|
|
1065
|
-
*
|
|
1066
|
-
* @format date-time
|
|
1067
|
-
* @example "2023-01-01T12:00:00.000Z"
|
|
1538
|
+
* The users in the conversation.
|
|
1539
|
+
* @example ["DEVU-12345"]
|
|
1068
1540
|
*/
|
|
1069
|
-
|
|
1541
|
+
members?: string[];
|
|
1542
|
+
/** Initial messages on the conversation. */
|
|
1543
|
+
messages?: ConversationsCreateRequestMessage[];
|
|
1544
|
+
metadata?: ConversationsCreateRequestMetadata;
|
|
1545
|
+
/** The users that own the conversation. */
|
|
1546
|
+
owned_by?: string[];
|
|
1547
|
+
/** Whether the conversation is from a source channel. */
|
|
1548
|
+
source_channel?: string;
|
|
1549
|
+
/** Sets an object's initial stage. */
|
|
1550
|
+
stage?: StageInit;
|
|
1551
|
+
/** Tags associated with the conversation. */
|
|
1552
|
+
tags?: SetTagWithValue[];
|
|
1553
|
+
/** The title for the conversation. */
|
|
1554
|
+
title?: string;
|
|
1555
|
+
/** The IDs of user sessions associated with the conversation. */
|
|
1556
|
+
user_sessions?: string[];
|
|
1557
|
+
}
|
|
1558
|
+
/** conversations-create-request-message */
|
|
1559
|
+
export interface ConversationsCreateRequestMessage {
|
|
1560
|
+
/**
|
|
1561
|
+
* The IDs of the artifacts to the message.
|
|
1562
|
+
* @example ["ARTIFACT-12345"]
|
|
1563
|
+
*/
|
|
1564
|
+
artifacts?: string[];
|
|
1565
|
+
/** The message's body. */
|
|
1566
|
+
body?: string;
|
|
1567
|
+
}
|
|
1568
|
+
/** conversations-create-request-metadata */
|
|
1569
|
+
export interface ConversationsCreateRequestMetadata {
|
|
1570
|
+
url_context?: string;
|
|
1571
|
+
}
|
|
1572
|
+
export declare enum ConversationsCreateRequestTypeValue {
|
|
1573
|
+
Support = "support"
|
|
1574
|
+
}
|
|
1575
|
+
/**
|
|
1576
|
+
* conversations-create-response
|
|
1577
|
+
* The response to creating a new conversation.
|
|
1578
|
+
*/
|
|
1579
|
+
export interface ConversationsCreateResponse {
|
|
1580
|
+
conversation: Conversation;
|
|
1581
|
+
}
|
|
1582
|
+
/**
|
|
1583
|
+
* conversations-delete-request
|
|
1584
|
+
* The request to delete a conversation.
|
|
1585
|
+
*/
|
|
1586
|
+
export interface ConversationsDeleteRequest {
|
|
1587
|
+
/** The ID of the conversation to delete. */
|
|
1588
|
+
id: string;
|
|
1589
|
+
}
|
|
1590
|
+
/**
|
|
1591
|
+
* conversations-delete-response
|
|
1592
|
+
* The response for deleting a conversation.
|
|
1593
|
+
*/
|
|
1594
|
+
export type ConversationsDeleteResponse = object;
|
|
1595
|
+
/**
|
|
1596
|
+
* conversations-get-request
|
|
1597
|
+
* The request to get a conversation's information.
|
|
1598
|
+
*/
|
|
1599
|
+
export interface ConversationsGetRequest {
|
|
1600
|
+
/** The requested conversation's ID. */
|
|
1601
|
+
id: string;
|
|
1602
|
+
}
|
|
1603
|
+
/**
|
|
1604
|
+
* conversations-get-response
|
|
1605
|
+
* The response to getting a conversation's information.
|
|
1606
|
+
*/
|
|
1607
|
+
export interface ConversationsGetResponse {
|
|
1608
|
+
conversation: Conversation;
|
|
1609
|
+
}
|
|
1610
|
+
/**
|
|
1611
|
+
* conversations-list-request
|
|
1612
|
+
* The request to get information about a list of conversations.
|
|
1613
|
+
*/
|
|
1614
|
+
export interface ConversationsListRequest {
|
|
1615
|
+
/**
|
|
1616
|
+
* Filters for conversations belonging to any of the provided parts.
|
|
1617
|
+
* @example ["PROD-12345"]
|
|
1618
|
+
*/
|
|
1619
|
+
applies_to_parts?: string[];
|
|
1620
|
+
/**
|
|
1621
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1622
|
+
* iteration starts from the beginning.
|
|
1623
|
+
*/
|
|
1624
|
+
cursor?: string;
|
|
1625
|
+
/** Filters for conversation that belong to the given groups. */
|
|
1626
|
+
group?: string[];
|
|
1627
|
+
/** Filters for conversations that are created by verified users. */
|
|
1628
|
+
is_creator_verified?: boolean;
|
|
1629
|
+
/** Filters for conversations that are spam. */
|
|
1630
|
+
is_spam?: boolean;
|
|
1631
|
+
/**
|
|
1632
|
+
* The maximum number of conversations to return. The default is '50'.
|
|
1633
|
+
* @format int32
|
|
1634
|
+
*/
|
|
1635
|
+
limit?: number;
|
|
1636
|
+
/**
|
|
1637
|
+
* Filters for conversations where these users are participants.
|
|
1638
|
+
* @example ["DEVU-12345"]
|
|
1639
|
+
*/
|
|
1640
|
+
members?: string[];
|
|
1641
|
+
/**
|
|
1642
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1643
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1644
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1645
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1646
|
+
* always be returned in the specified sort-by order.
|
|
1647
|
+
*/
|
|
1648
|
+
mode?: ListMode;
|
|
1649
|
+
modified_date?: DateTimeFilter;
|
|
1650
|
+
/**
|
|
1651
|
+
* Filters for conversations owned by any of these users.
|
|
1652
|
+
* @example ["DEVU-12345"]
|
|
1653
|
+
*/
|
|
1654
|
+
owned_by?: string[];
|
|
1655
|
+
/**
|
|
1656
|
+
* Filters for conversations that are associated with any of the
|
|
1657
|
+
* provided Rev organizations.
|
|
1658
|
+
* @deprecated
|
|
1659
|
+
* @example ["REV-AbCdEfGh"]
|
|
1660
|
+
*/
|
|
1661
|
+
rev_org?: string[];
|
|
1662
|
+
/**
|
|
1663
|
+
* Filters for conversations that are associated with any of the
|
|
1664
|
+
* provided Rev organizations.
|
|
1665
|
+
* @example ["REV-AbCdEfGh"]
|
|
1666
|
+
*/
|
|
1667
|
+
rev_orgs?: string[];
|
|
1668
|
+
/** The filter for SLA summary. */
|
|
1669
|
+
sla_summary?: SlaSummaryFilter;
|
|
1670
|
+
/** Filters for conversations with any of the provided source channels. */
|
|
1671
|
+
source_channel?: string[];
|
|
1672
|
+
/**
|
|
1673
|
+
* Filters for conversations with any of the provided source channels.
|
|
1674
|
+
* @deprecated
|
|
1675
|
+
*/
|
|
1676
|
+
source_channels?: string[];
|
|
1677
|
+
/** The filter for stages. */
|
|
1678
|
+
stage?: StageFilter;
|
|
1679
|
+
/**
|
|
1680
|
+
* Filters for conversations with any of the provided tags.
|
|
1681
|
+
* @deprecated
|
|
1682
|
+
* @example ["TAG-12345"]
|
|
1683
|
+
*/
|
|
1684
|
+
tags?: string[];
|
|
1685
|
+
/** Filters for conversations with any of the provided tags with value. */
|
|
1686
|
+
tags_v2?: TagWithValueFilter[];
|
|
1687
|
+
}
|
|
1688
|
+
/**
|
|
1689
|
+
* conversations-list-response
|
|
1690
|
+
* The response to listing the conversations.
|
|
1691
|
+
*/
|
|
1692
|
+
export interface ConversationsListResponse {
|
|
1693
|
+
/** The list of conversations. */
|
|
1694
|
+
conversations: Conversation[];
|
|
1695
|
+
/**
|
|
1696
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
1697
|
+
* sort order. If not set, then no later elements exist.
|
|
1698
|
+
*/
|
|
1699
|
+
next_cursor?: string;
|
|
1700
|
+
/**
|
|
1701
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
1702
|
+
* sort order. If not set, then no prior elements exist.
|
|
1703
|
+
*/
|
|
1704
|
+
prev_cursor?: string;
|
|
1705
|
+
}
|
|
1706
|
+
/**
|
|
1707
|
+
* conversations-update-request
|
|
1708
|
+
* The request to update a conversation.
|
|
1709
|
+
*/
|
|
1710
|
+
export interface ConversationsUpdateRequest {
|
|
1711
|
+
applies_to_parts?: ConversationsUpdateRequestAppliesToParts;
|
|
1712
|
+
/** Application-defined custom fields. */
|
|
1713
|
+
custom_fields?: object;
|
|
1714
|
+
/**
|
|
1715
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
1716
|
+
* custom field must be specified, otherwise a bad request error is
|
|
1717
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
1718
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
1719
|
+
* specifier, it remains unmodified.
|
|
1720
|
+
*/
|
|
1721
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
1722
|
+
/** The updated description for the conversation. */
|
|
1723
|
+
description?: string;
|
|
1724
|
+
/** The group that the conversation is associated with. */
|
|
1725
|
+
group?: string;
|
|
1726
|
+
/** The ID of the conversation to update. */
|
|
1727
|
+
id: string;
|
|
1728
|
+
/** Whether the conversation is spam. */
|
|
1729
|
+
is_spam?: boolean;
|
|
1730
|
+
members?: ConversationsUpdateRequestMembers;
|
|
1731
|
+
metadata?: ConversationsUpdateRequestMetadata;
|
|
1732
|
+
owned_by?: ConversationsUpdateRequestOwnedBy;
|
|
1733
|
+
/** Updates an object's stage. */
|
|
1734
|
+
stage?: StageUpdate;
|
|
1735
|
+
/** The updated status of the conversation. */
|
|
1736
|
+
status?: string;
|
|
1737
|
+
tags?: ConversationsUpdateRequestTags;
|
|
1738
|
+
/** The updated title of the conversation. */
|
|
1739
|
+
title?: string;
|
|
1740
|
+
user_sessions?: ConversationsUpdateRequestUserSessions;
|
|
1741
|
+
}
|
|
1742
|
+
/** conversations-update-request-applies-to-parts */
|
|
1743
|
+
export interface ConversationsUpdateRequestAppliesToParts {
|
|
1744
|
+
/**
|
|
1745
|
+
* Updates the parts that the conversation applies to.
|
|
1746
|
+
* @example ["PROD-12345"]
|
|
1747
|
+
*/
|
|
1748
|
+
set?: string[];
|
|
1749
|
+
}
|
|
1750
|
+
/** conversations-update-request-members */
|
|
1751
|
+
export interface ConversationsUpdateRequestMembers {
|
|
1752
|
+
/**
|
|
1753
|
+
* Sets the member IDs to the provided user IDs.
|
|
1754
|
+
* @example ["DEVU-12345"]
|
|
1755
|
+
*/
|
|
1756
|
+
set?: string[];
|
|
1757
|
+
}
|
|
1758
|
+
/** conversations-update-request-metadata */
|
|
1759
|
+
export interface ConversationsUpdateRequestMetadata {
|
|
1760
|
+
url_context?: string;
|
|
1761
|
+
}
|
|
1762
|
+
/** conversations-update-request-owned-by */
|
|
1763
|
+
export interface ConversationsUpdateRequestOwnedBy {
|
|
1764
|
+
/**
|
|
1765
|
+
* Sets the owner IDs to the provided user IDs. This must not be
|
|
1766
|
+
* empty.
|
|
1767
|
+
* @minItems 1
|
|
1768
|
+
* @example ["DEVU-12345"]
|
|
1769
|
+
*/
|
|
1770
|
+
set?: string[];
|
|
1771
|
+
}
|
|
1772
|
+
/** conversations-update-request-tags */
|
|
1773
|
+
export interface ConversationsUpdateRequestTags {
|
|
1774
|
+
/** Adds the provided tags on the conversation. */
|
|
1775
|
+
add?: AddTagWithValue[];
|
|
1776
|
+
/** Removes the provided tags on the conversation. */
|
|
1777
|
+
remove?: RemoveTagWithValue[];
|
|
1778
|
+
/** Sets the tag IDs to the provided tags. */
|
|
1779
|
+
set?: SetTagWithValue[];
|
|
1780
|
+
}
|
|
1781
|
+
/** conversations-update-request-user-sessions */
|
|
1782
|
+
export interface ConversationsUpdateRequestUserSessions {
|
|
1783
|
+
/** The updated user sessions that the conversation is associated with. */
|
|
1784
|
+
set?: string[];
|
|
1785
|
+
}
|
|
1786
|
+
/**
|
|
1787
|
+
* conversations-update-response
|
|
1788
|
+
* The response for updating a conversation.
|
|
1789
|
+
*/
|
|
1790
|
+
export interface ConversationsUpdateResponse {
|
|
1791
|
+
conversation: Conversation;
|
|
1792
|
+
}
|
|
1793
|
+
/**
|
|
1794
|
+
* custom-schema-spec
|
|
1795
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
1796
|
+
* custom field must be specified, otherwise a bad request error is
|
|
1797
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
1798
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
1799
|
+
* specifier, it remains unmodified.
|
|
1800
|
+
*/
|
|
1801
|
+
export interface CustomSchemaSpec {
|
|
1802
|
+
/** List of apps that are requested. */
|
|
1803
|
+
apps?: string[];
|
|
1804
|
+
/** Name of the subtype requested. */
|
|
1805
|
+
subtype?: string;
|
|
1806
|
+
/** Whether the tenant schema is requested. */
|
|
1807
|
+
tenant_fragment?: boolean;
|
|
1808
|
+
/** Whether to enforce required fields validation. */
|
|
1809
|
+
validate_required_fields?: boolean;
|
|
1810
|
+
}
|
|
1811
|
+
/**
|
|
1812
|
+
* date-filter
|
|
1813
|
+
* Provides ways to specify date ranges on objects.
|
|
1814
|
+
*/
|
|
1815
|
+
export type DateFilter = (DateTimeFilter | DateTimePreset) & {
|
|
1816
|
+
/** Type of date filter. */
|
|
1817
|
+
type: DateFilterType;
|
|
1818
|
+
};
|
|
1819
|
+
/** Type of date filter. */
|
|
1820
|
+
export declare enum DateFilterType {
|
|
1821
|
+
Preset = "preset",
|
|
1822
|
+
Range = "range"
|
|
1823
|
+
}
|
|
1824
|
+
/** date-time-filter */
|
|
1825
|
+
export interface DateTimeFilter {
|
|
1826
|
+
/**
|
|
1827
|
+
* Filters for objects created after the provided timestamp
|
|
1828
|
+
* (inclusive).
|
|
1829
|
+
* @format date-time
|
|
1830
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1831
|
+
*/
|
|
1832
|
+
after?: string;
|
|
1833
|
+
/**
|
|
1834
|
+
* Filters for objects created before the provided timestamp
|
|
1835
|
+
* (inclusive).
|
|
1836
|
+
* @format date-time
|
|
1837
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1838
|
+
*/
|
|
1839
|
+
before?: string;
|
|
1070
1840
|
}
|
|
1071
1841
|
/**
|
|
1072
1842
|
* date-time-preset
|
|
@@ -1407,6 +2177,21 @@ export interface DevUserExternalIdentityFilter {
|
|
|
1407
2177
|
/** Issuer of the external identity of the user. */
|
|
1408
2178
|
issuer?: string;
|
|
1409
2179
|
}
|
|
2180
|
+
/** Job title of the Dev User. */
|
|
2181
|
+
export declare enum DevUserJobTitle {
|
|
2182
|
+
CustomerSuccessManager = "customer_success_manager",
|
|
2183
|
+
Cxo = "cxo",
|
|
2184
|
+
Designer = "designer",
|
|
2185
|
+
Developer = "developer",
|
|
2186
|
+
HeadOfSupport = "head_of_support",
|
|
2187
|
+
Operations = "operations",
|
|
2188
|
+
Others = "others",
|
|
2189
|
+
ProductManager = "product_manager",
|
|
2190
|
+
Qa = "qa",
|
|
2191
|
+
RevenueLeader = "revenue_leader",
|
|
2192
|
+
Support = "support",
|
|
2193
|
+
TechLead = "tech_lead"
|
|
2194
|
+
}
|
|
1410
2195
|
/** dev-user-summary */
|
|
1411
2196
|
export type DevUserSummary = UserBaseSummary;
|
|
1412
2197
|
/**
|
|
@@ -1490,10 +2275,139 @@ export type DevUsersSelfRequest = object;
|
|
|
1490
2275
|
export interface DevUsersSelfResponse {
|
|
1491
2276
|
dev_user: DevUser;
|
|
1492
2277
|
}
|
|
2278
|
+
/**
|
|
2279
|
+
* dev-users-self-update-request
|
|
2280
|
+
* A request to update the user's information for the authenticated Dev
|
|
2281
|
+
* user.
|
|
2282
|
+
*/
|
|
2283
|
+
export interface DevUsersSelfUpdateRequest {
|
|
2284
|
+
/** Application-defined custom fields. */
|
|
2285
|
+
custom_fields?: object;
|
|
2286
|
+
/**
|
|
2287
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
2288
|
+
* custom field must be specified, otherwise a bad request error is
|
|
2289
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
2290
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
2291
|
+
* specifier, it remains unmodified.
|
|
2292
|
+
*/
|
|
2293
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
2294
|
+
/** The updated display name of the Dev user. */
|
|
2295
|
+
display_name?: string;
|
|
2296
|
+
/**
|
|
2297
|
+
* Start date of Dev user's experience.
|
|
2298
|
+
* @format date-time
|
|
2299
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2300
|
+
*/
|
|
2301
|
+
experience_start_date?: string;
|
|
2302
|
+
/** The updated full name of the Dev user. */
|
|
2303
|
+
full_name?: string;
|
|
2304
|
+
/** Job history of the Dev user. */
|
|
2305
|
+
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
2306
|
+
/** Job title of the Dev User. */
|
|
2307
|
+
job_title?: DevUserJobTitle;
|
|
2308
|
+
}
|
|
2309
|
+
/** dev-users-update-job-history-item */
|
|
2310
|
+
export interface DevUsersUpdateJobHistoryItem {
|
|
2311
|
+
/**
|
|
2312
|
+
* Enum for the employment status of the user.
|
|
2313
|
+
* @format int64
|
|
2314
|
+
*/
|
|
2315
|
+
employment_status?: number;
|
|
2316
|
+
/**
|
|
2317
|
+
* End date of the job.
|
|
2318
|
+
* @format date-time
|
|
2319
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2320
|
+
*/
|
|
2321
|
+
end_date?: string;
|
|
2322
|
+
/** Is this the current active job for the user. */
|
|
2323
|
+
is_current?: boolean;
|
|
2324
|
+
/** The job location for the user. */
|
|
2325
|
+
location?: string;
|
|
2326
|
+
/**
|
|
2327
|
+
* Start date of the job.
|
|
2328
|
+
* @format date-time
|
|
2329
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2330
|
+
*/
|
|
2331
|
+
start_date?: string;
|
|
2332
|
+
/** The job title for the user. */
|
|
2333
|
+
title?: string;
|
|
2334
|
+
}
|
|
2335
|
+
/**
|
|
2336
|
+
* dev-users-update-request
|
|
2337
|
+
* A request to update the user's information corresponding to the
|
|
2338
|
+
* provided Dev user.
|
|
2339
|
+
*/
|
|
2340
|
+
export interface DevUsersUpdateRequest {
|
|
2341
|
+
/** Application-defined custom fields. */
|
|
2342
|
+
custom_fields?: object;
|
|
2343
|
+
/**
|
|
2344
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
2345
|
+
* custom field must be specified, otherwise a bad request error is
|
|
2346
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
2347
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
2348
|
+
* specifier, it remains unmodified.
|
|
2349
|
+
*/
|
|
2350
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
2351
|
+
/** The updated display name of the Dev user. */
|
|
2352
|
+
display_name?: string;
|
|
2353
|
+
/**
|
|
2354
|
+
* Start date of Dev user's experience.
|
|
2355
|
+
* @format date-time
|
|
2356
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2357
|
+
*/
|
|
2358
|
+
experience_start_date?: string;
|
|
2359
|
+
/** The updated full name of the Dev user. */
|
|
2360
|
+
full_name?: string;
|
|
2361
|
+
/** The ID for the Dev user to be updated. */
|
|
2362
|
+
id: string;
|
|
2363
|
+
/** Job history of the Dev user. */
|
|
2364
|
+
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
2365
|
+
/** Job title of the Dev User. */
|
|
2366
|
+
job_title?: DevUserJobTitle;
|
|
2367
|
+
}
|
|
2368
|
+
/**
|
|
2369
|
+
* dev-users-update-response
|
|
2370
|
+
* The response to update a Dev user.
|
|
2371
|
+
*/
|
|
2372
|
+
export interface DevUsersUpdateResponse {
|
|
2373
|
+
dev_user: DevUser;
|
|
2374
|
+
}
|
|
2375
|
+
/** directory-summary */
|
|
2376
|
+
export type DirectorySummary = AtomBaseSummary;
|
|
2377
|
+
/**
|
|
2378
|
+
* dynamic-group-info
|
|
2379
|
+
* Information to define dynamic groups.
|
|
2380
|
+
*/
|
|
2381
|
+
export type DynamicGroupInfo = object;
|
|
1493
2382
|
/** empty */
|
|
1494
2383
|
export type Empty = object;
|
|
1495
2384
|
/** enhancement */
|
|
1496
|
-
export type Enhancement = PartBase
|
|
2385
|
+
export type Enhancement = PartBase & {
|
|
2386
|
+
/**
|
|
2387
|
+
* Actual close date for the object.
|
|
2388
|
+
* @format date-time
|
|
2389
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2390
|
+
*/
|
|
2391
|
+
actual_close_date?: string;
|
|
2392
|
+
/**
|
|
2393
|
+
* Actual start date for the object.
|
|
2394
|
+
* @format date-time
|
|
2395
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2396
|
+
*/
|
|
2397
|
+
actual_start_date?: string;
|
|
2398
|
+
/**
|
|
2399
|
+
* Target close date for the object.
|
|
2400
|
+
* @format date-time
|
|
2401
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2402
|
+
*/
|
|
2403
|
+
target_close_date?: string;
|
|
2404
|
+
/**
|
|
2405
|
+
* Target start date for the object.
|
|
2406
|
+
* @format date-time
|
|
2407
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2408
|
+
*/
|
|
2409
|
+
target_start_date?: string;
|
|
2410
|
+
};
|
|
1497
2411
|
/** enhancement-summary */
|
|
1498
2412
|
export type EnhancementSummary = PartBaseSummary;
|
|
1499
2413
|
/**
|
|
@@ -2148,8 +3062,224 @@ export type Feature = PartBase;
|
|
|
2148
3062
|
export type FeatureSummary = PartBaseSummary;
|
|
2149
3063
|
/** group */
|
|
2150
3064
|
export type Group = AtomBase;
|
|
2151
|
-
/** group
|
|
2152
|
-
export
|
|
3065
|
+
/** Creation source of the group. */
|
|
3066
|
+
export declare enum GroupIngestionSource {
|
|
3067
|
+
Airdrop = "airdrop",
|
|
3068
|
+
Scim = "scim"
|
|
3069
|
+
}
|
|
3070
|
+
/** Type of the members in the group. */
|
|
3071
|
+
export declare enum GroupMemberType {
|
|
3072
|
+
DevUser = "dev_user",
|
|
3073
|
+
RevUser = "rev_user"
|
|
3074
|
+
}
|
|
3075
|
+
/**
|
|
3076
|
+
* group-members-add-request
|
|
3077
|
+
* A request to add a new member to a group.
|
|
3078
|
+
*/
|
|
3079
|
+
export interface GroupMembersAddRequest {
|
|
3080
|
+
/** ID of the group where the member is being added. */
|
|
3081
|
+
group: string;
|
|
3082
|
+
/**
|
|
3083
|
+
* ID of the member to be added.
|
|
3084
|
+
* @example "DEVU-12345"
|
|
3085
|
+
*/
|
|
3086
|
+
member: string;
|
|
3087
|
+
}
|
|
3088
|
+
/** group-members-add-response */
|
|
3089
|
+
export type GroupMembersAddResponse = object;
|
|
3090
|
+
/**
|
|
3091
|
+
* group-members-list-request
|
|
3092
|
+
* A request to list group members.
|
|
3093
|
+
*/
|
|
3094
|
+
export interface GroupMembersListRequest {
|
|
3095
|
+
/**
|
|
3096
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3097
|
+
* iteration starts from the beginning.
|
|
3098
|
+
*/
|
|
3099
|
+
cursor?: string;
|
|
3100
|
+
/** ID of the group for which to list members. */
|
|
3101
|
+
group: string;
|
|
3102
|
+
/**
|
|
3103
|
+
* The maximum number of members to return. If not set, then the
|
|
3104
|
+
* default is '50'.
|
|
3105
|
+
* @format int32
|
|
3106
|
+
*/
|
|
3107
|
+
limit?: number;
|
|
3108
|
+
/**
|
|
3109
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3110
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3111
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3112
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3113
|
+
* always be returned in the specified sort-by order.
|
|
3114
|
+
*/
|
|
3115
|
+
mode?: ListMode;
|
|
3116
|
+
}
|
|
3117
|
+
/**
|
|
3118
|
+
* group-members-list-response
|
|
3119
|
+
* List of group members.
|
|
3120
|
+
*/
|
|
3121
|
+
export interface GroupMembersListResponse {
|
|
3122
|
+
/** List of members. */
|
|
3123
|
+
members: GroupMembersListResponseMember[];
|
|
3124
|
+
/**
|
|
3125
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
3126
|
+
* sort order. If not set, then no later elements exist.
|
|
3127
|
+
*/
|
|
3128
|
+
next_cursor?: string;
|
|
3129
|
+
/**
|
|
3130
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
3131
|
+
* sort order. If not set, then no prior elements exist.
|
|
3132
|
+
*/
|
|
3133
|
+
prev_cursor?: string;
|
|
3134
|
+
}
|
|
3135
|
+
/**
|
|
3136
|
+
* group-members-list-response-member
|
|
3137
|
+
* A group member.
|
|
3138
|
+
*/
|
|
3139
|
+
export interface GroupMembersListResponseMember {
|
|
3140
|
+
member: MemberSummary;
|
|
3141
|
+
}
|
|
3142
|
+
/**
|
|
3143
|
+
* group-members-remove-request
|
|
3144
|
+
* A request to remove a group member.
|
|
3145
|
+
*/
|
|
3146
|
+
export interface GroupMembersRemoveRequest {
|
|
3147
|
+
/** ID of the group where the member is being removed. */
|
|
3148
|
+
group: string;
|
|
3149
|
+
/**
|
|
3150
|
+
* ID of the member to be removed.
|
|
3151
|
+
* @example "DEVU-12345"
|
|
3152
|
+
*/
|
|
3153
|
+
member: string;
|
|
3154
|
+
}
|
|
3155
|
+
/** group-members-remove-response */
|
|
3156
|
+
export type GroupMembersRemoveResponse = object;
|
|
3157
|
+
/** group-summary */
|
|
3158
|
+
export type GroupSummary = AtomBaseSummary;
|
|
3159
|
+
/** Type of the group. */
|
|
3160
|
+
export declare enum GroupType {
|
|
3161
|
+
Dynamic = "dynamic",
|
|
3162
|
+
Static = "static"
|
|
3163
|
+
}
|
|
3164
|
+
/**
|
|
3165
|
+
* groups-create-request
|
|
3166
|
+
* A request to create a new group.
|
|
3167
|
+
*/
|
|
3168
|
+
export interface GroupsCreateRequest {
|
|
3169
|
+
/** Type of the group. */
|
|
3170
|
+
type?: GroupType;
|
|
3171
|
+
/** Description of the group. */
|
|
3172
|
+
description: string;
|
|
3173
|
+
/** Information to define dynamic groups. */
|
|
3174
|
+
dynamic_group_info?: DynamicGroupInfo;
|
|
3175
|
+
/** Type of the members in the group. */
|
|
3176
|
+
member_type?: GroupMemberType;
|
|
3177
|
+
/** Unique name of the group. */
|
|
3178
|
+
name: string;
|
|
3179
|
+
/** Owner of the group. */
|
|
3180
|
+
owner?: string;
|
|
3181
|
+
}
|
|
3182
|
+
/**
|
|
3183
|
+
* groups-create-response
|
|
3184
|
+
* The response to group creation.
|
|
3185
|
+
*/
|
|
3186
|
+
export interface GroupsCreateResponse {
|
|
3187
|
+
group: Group;
|
|
3188
|
+
}
|
|
3189
|
+
/**
|
|
3190
|
+
* groups-get-request
|
|
3191
|
+
* A request to get information about a group.
|
|
3192
|
+
*/
|
|
3193
|
+
export interface GroupsGetRequest {
|
|
3194
|
+
/** The ID of the group to get. */
|
|
3195
|
+
id: string;
|
|
3196
|
+
}
|
|
3197
|
+
/**
|
|
3198
|
+
* groups-get-response
|
|
3199
|
+
* The response to getting the group.
|
|
3200
|
+
*/
|
|
3201
|
+
export interface GroupsGetResponse {
|
|
3202
|
+
group: Group;
|
|
3203
|
+
}
|
|
3204
|
+
/**
|
|
3205
|
+
* groups-list-request
|
|
3206
|
+
* A request to get information about a list of groups.
|
|
3207
|
+
*/
|
|
3208
|
+
export interface GroupsListRequest {
|
|
3209
|
+
/**
|
|
3210
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3211
|
+
* iteration starts from the beginning.
|
|
3212
|
+
*/
|
|
3213
|
+
cursor?: string;
|
|
3214
|
+
/** Filters the groups based on the group type. */
|
|
3215
|
+
group_type?: GroupType[];
|
|
3216
|
+
/** Filter groups by ingestion source(s). */
|
|
3217
|
+
ingestion_source?: GroupIngestionSource[];
|
|
3218
|
+
/** Whether to fetch default or custom groups. */
|
|
3219
|
+
is_default?: boolean;
|
|
3220
|
+
/**
|
|
3221
|
+
* The maximum number of groups to return. The default is '50'.
|
|
3222
|
+
* @format int32
|
|
3223
|
+
*/
|
|
3224
|
+
limit?: number;
|
|
3225
|
+
/** Filters the groups on basis of member type. */
|
|
3226
|
+
member_type?: GroupMemberType[];
|
|
3227
|
+
/**
|
|
3228
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3229
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3230
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3231
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3232
|
+
* always be returned in the specified sort-by order.
|
|
3233
|
+
*/
|
|
3234
|
+
mode?: ListMode;
|
|
3235
|
+
/** Comma-separated fields to sort the groups by. */
|
|
3236
|
+
sort_by?: string[];
|
|
3237
|
+
}
|
|
3238
|
+
/**
|
|
3239
|
+
* groups-list-response
|
|
3240
|
+
* The response to listing the groups.
|
|
3241
|
+
*/
|
|
3242
|
+
export interface GroupsListResponse {
|
|
3243
|
+
/** The list of groups. */
|
|
3244
|
+
groups: Group[];
|
|
3245
|
+
/**
|
|
3246
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
3247
|
+
* sort order. If not set, then no later elements exist.
|
|
3248
|
+
*/
|
|
3249
|
+
next_cursor?: string;
|
|
3250
|
+
/**
|
|
3251
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
3252
|
+
* sort order. If not set, then no prior elements exist.
|
|
3253
|
+
*/
|
|
3254
|
+
prev_cursor?: string;
|
|
3255
|
+
}
|
|
3256
|
+
/**
|
|
3257
|
+
* groups-update-request
|
|
3258
|
+
* A request to update a group.
|
|
3259
|
+
*/
|
|
3260
|
+
export interface GroupsUpdateRequest {
|
|
3261
|
+
/** The updated group's description. */
|
|
3262
|
+
description?: string;
|
|
3263
|
+
dynamic_group_info?: GroupsUpdateRequestDynamicGroupInfo;
|
|
3264
|
+
/** The ID of the group to update. */
|
|
3265
|
+
id: string;
|
|
3266
|
+
/** The updated group's name. */
|
|
3267
|
+
name?: string;
|
|
3268
|
+
/** The updated group's owner. */
|
|
3269
|
+
owner?: string;
|
|
3270
|
+
}
|
|
3271
|
+
/** groups-update-request-dynamic-group-info */
|
|
3272
|
+
export interface GroupsUpdateRequestDynamicGroupInfo {
|
|
3273
|
+
/** Boolean expression. */
|
|
3274
|
+
membership_expression: BooleanExpression;
|
|
3275
|
+
}
|
|
3276
|
+
/**
|
|
3277
|
+
* groups-update-response
|
|
3278
|
+
* The response to group update.
|
|
3279
|
+
*/
|
|
3280
|
+
export interface GroupsUpdateResponse {
|
|
3281
|
+
group: Group;
|
|
3282
|
+
}
|
|
2153
3283
|
/**
|
|
2154
3284
|
* impacted-customer-details
|
|
2155
3285
|
* Details of the impact due to the incident.
|
|
@@ -2340,6 +3470,129 @@ export declare enum LinkType {
|
|
|
2340
3470
|
IsRelatedTo = "is_related_to",
|
|
2341
3471
|
Serves = "serves"
|
|
2342
3472
|
}
|
|
3473
|
+
/**
|
|
3474
|
+
* links-create-request
|
|
3475
|
+
* The request to create a new link.
|
|
3476
|
+
*/
|
|
3477
|
+
export interface LinksCreateRequest {
|
|
3478
|
+
/** Type of link used to define the relationship. */
|
|
3479
|
+
link_type: LinkType;
|
|
3480
|
+
/** The ID of the source object. */
|
|
3481
|
+
source: string;
|
|
3482
|
+
/** The ID of the target object. */
|
|
3483
|
+
target: string;
|
|
3484
|
+
}
|
|
3485
|
+
/**
|
|
3486
|
+
* links-create-response
|
|
3487
|
+
* The response to creating a new link.
|
|
3488
|
+
*/
|
|
3489
|
+
export interface LinksCreateResponse {
|
|
3490
|
+
link: Link;
|
|
3491
|
+
}
|
|
3492
|
+
/**
|
|
3493
|
+
* links-delete-request
|
|
3494
|
+
* The request to delete a link.
|
|
3495
|
+
*/
|
|
3496
|
+
export interface LinksDeleteRequest {
|
|
3497
|
+
/** The ID of the link to delete. */
|
|
3498
|
+
id: string;
|
|
3499
|
+
}
|
|
3500
|
+
/**
|
|
3501
|
+
* links-delete-response
|
|
3502
|
+
* The response for deleting a link.
|
|
3503
|
+
*/
|
|
3504
|
+
export type LinksDeleteResponse = object;
|
|
3505
|
+
/**
|
|
3506
|
+
* The direction of link, which can either be outbound such that the
|
|
3507
|
+
* object is the source of the link, otherwise inbound where the object is
|
|
3508
|
+
* the target of the link.
|
|
3509
|
+
*/
|
|
3510
|
+
export declare enum LinksDirection {
|
|
3511
|
+
IsSource = "is_source",
|
|
3512
|
+
IsTarget = "is_target"
|
|
3513
|
+
}
|
|
3514
|
+
/**
|
|
3515
|
+
* links-get-request
|
|
3516
|
+
* The request to get a link's information.
|
|
3517
|
+
*/
|
|
3518
|
+
export interface LinksGetRequest {
|
|
3519
|
+
/** The requested link's ID. */
|
|
3520
|
+
id: string;
|
|
3521
|
+
}
|
|
3522
|
+
/**
|
|
3523
|
+
* links-get-response
|
|
3524
|
+
* The response to getting a link's information.
|
|
3525
|
+
*/
|
|
3526
|
+
export interface LinksGetResponse {
|
|
3527
|
+
link: Link;
|
|
3528
|
+
}
|
|
3529
|
+
/**
|
|
3530
|
+
* links-list-request
|
|
3531
|
+
* The request to get information about a list of links.
|
|
3532
|
+
*/
|
|
3533
|
+
export interface LinksListRequest {
|
|
3534
|
+
/**
|
|
3535
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3536
|
+
* iteration starts from the beginning.
|
|
3537
|
+
*/
|
|
3538
|
+
cursor?: string;
|
|
3539
|
+
/**
|
|
3540
|
+
* The direction of link, which can either be outbound such that the
|
|
3541
|
+
* object is the source of the link, otherwise inbound where the object is
|
|
3542
|
+
* the target of the link.
|
|
3543
|
+
*/
|
|
3544
|
+
direction?: LinksDirection;
|
|
3545
|
+
/**
|
|
3546
|
+
* The maximum number of links to return. If not set, then the default
|
|
3547
|
+
* is '50'.
|
|
3548
|
+
* @format int32
|
|
3549
|
+
*/
|
|
3550
|
+
limit?: number;
|
|
3551
|
+
/**
|
|
3552
|
+
* The link type(s) to filter for, otherwise if not present, all link
|
|
3553
|
+
* types are included.
|
|
3554
|
+
*/
|
|
3555
|
+
link_type?: LinkType[];
|
|
3556
|
+
/**
|
|
3557
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3558
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3559
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3560
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3561
|
+
* always be returned in the specified sort-by order.
|
|
3562
|
+
*/
|
|
3563
|
+
mode?: ListMode;
|
|
3564
|
+
/** The ID of the object to list the links for. */
|
|
3565
|
+
object: string;
|
|
3566
|
+
/**
|
|
3567
|
+
* The object types to filter for, otherwise if not present, all
|
|
3568
|
+
* object types are included.
|
|
3569
|
+
*/
|
|
3570
|
+
object_types?: LinkEndpointType[];
|
|
3571
|
+
/**
|
|
3572
|
+
* The link types to filter for, otherwise if not present, all link
|
|
3573
|
+
* types are included.
|
|
3574
|
+
* @deprecated
|
|
3575
|
+
*/
|
|
3576
|
+
types?: LinkType[];
|
|
3577
|
+
}
|
|
3578
|
+
/**
|
|
3579
|
+
* links-list-response
|
|
3580
|
+
* The response to listing the links.
|
|
3581
|
+
*/
|
|
3582
|
+
export interface LinksListResponse {
|
|
3583
|
+
/** The list of links. */
|
|
3584
|
+
links: Link[];
|
|
3585
|
+
/**
|
|
3586
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
3587
|
+
* sort order. If not set, then no later elements exist.
|
|
3588
|
+
*/
|
|
3589
|
+
next_cursor?: string;
|
|
3590
|
+
/**
|
|
3591
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
3592
|
+
* sort order. If not set, then no prior elements exist.
|
|
3593
|
+
*/
|
|
3594
|
+
prev_cursor?: string;
|
|
3595
|
+
}
|
|
2343
3596
|
/**
|
|
2344
3597
|
* The iteration mode to use. If "after", then entries after the provided
|
|
2345
3598
|
* cursor will be returned, or if no cursor is provided, then from the
|
|
@@ -2351,6 +3604,15 @@ export declare enum ListMode {
|
|
|
2351
3604
|
After = "after",
|
|
2352
3605
|
Before = "before"
|
|
2353
3606
|
}
|
|
3607
|
+
/** member-summary */
|
|
3608
|
+
export type MemberSummary = (DevUserSummary | RevUserSummary | SysUserSummary) & {
|
|
3609
|
+
type: MemberType;
|
|
3610
|
+
};
|
|
3611
|
+
export declare enum MemberType {
|
|
3612
|
+
DevUser = "dev_user",
|
|
3613
|
+
RevUser = "rev_user",
|
|
3614
|
+
SysUser = "sys_user"
|
|
3615
|
+
}
|
|
2354
3616
|
/** metric-definition */
|
|
2355
3617
|
export type MetricDefinition = AtomBase & {
|
|
2356
3618
|
/** Human readable name of the metric. */
|
|
@@ -2764,11 +4026,29 @@ export type QuestionAnswer = AtomBase & {
|
|
|
2764
4026
|
/** Whether the Q/A was verified. */
|
|
2765
4027
|
verified?: boolean;
|
|
2766
4028
|
};
|
|
4029
|
+
/** remove-tag-with-value */
|
|
4030
|
+
export interface RemoveTagWithValue {
|
|
4031
|
+
/**
|
|
4032
|
+
* The ID of the tag.
|
|
4033
|
+
* @example "TAG-12345"
|
|
4034
|
+
*/
|
|
4035
|
+
id: string;
|
|
4036
|
+
}
|
|
2767
4037
|
/**
|
|
2768
4038
|
* removed-sla-metric-history
|
|
2769
4039
|
* User, timestamp and metric id of removed metrics.
|
|
2770
4040
|
*/
|
|
2771
4041
|
export type RemovedSlaMetricHistory = object;
|
|
4042
|
+
/**
|
|
4043
|
+
* resource
|
|
4044
|
+
* Resource details.
|
|
4045
|
+
*/
|
|
4046
|
+
export interface Resource {
|
|
4047
|
+
/** Artifacts of the resource (relevant only for type artifact). */
|
|
4048
|
+
artifacts?: ArtifactSummary[];
|
|
4049
|
+
/** URL of the resource (relevant only for type url). */
|
|
4050
|
+
url?: string;
|
|
4051
|
+
}
|
|
2772
4052
|
/** rev-org */
|
|
2773
4053
|
export type RevOrg = OrgBase & {
|
|
2774
4054
|
/** Description of the Rev organization. */
|
|
@@ -2977,59 +4257,257 @@ export type RevUserSummary = UserBaseSummary & {
|
|
|
2977
4257
|
external_ref?: string;
|
|
2978
4258
|
rev_org?: OrgSummary;
|
|
2979
4259
|
};
|
|
2980
|
-
/**
|
|
2981
|
-
|
|
4260
|
+
/**
|
|
4261
|
+
* rev-users-create-request
|
|
4262
|
+
* Request object to create a new Rev user for a Rev organization.
|
|
4263
|
+
*/
|
|
4264
|
+
export interface RevUsersCreateRequest {
|
|
2982
4265
|
/**
|
|
2983
|
-
*
|
|
2984
|
-
*
|
|
4266
|
+
* The schema fragment IDs associated with the Rev user.
|
|
4267
|
+
* @deprecated
|
|
4268
|
+
* @example ["don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"]
|
|
4269
|
+
*/
|
|
4270
|
+
custom_schema_fragments?: string[];
|
|
4271
|
+
/**
|
|
4272
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
4273
|
+
* custom field must be specified, otherwise a bad request error is
|
|
4274
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
4275
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
4276
|
+
* specifier, it remains unmodified.
|
|
2985
4277
|
*/
|
|
4278
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
4279
|
+
/** Description of the Rev user. */
|
|
4280
|
+
description?: string;
|
|
4281
|
+
/** The user's display name. The name is non-unique and mutable. */
|
|
4282
|
+
display_name?: string;
|
|
4283
|
+
/**
|
|
4284
|
+
* Artifact ID of a Rev user's display picture.
|
|
4285
|
+
* @example "ARTIFACT-12345"
|
|
4286
|
+
*/
|
|
4287
|
+
display_picture?: string;
|
|
4288
|
+
/** Email address of the Rev user. */
|
|
2986
4289
|
email?: string;
|
|
2987
4290
|
/**
|
|
2988
|
-
*
|
|
2989
|
-
*
|
|
4291
|
+
* External ref is a mutable unique identifier for a user within the
|
|
4292
|
+
* Dev organization from your primary customer record. If none is
|
|
4293
|
+
* available, a good alternative is the email address/phone number
|
|
4294
|
+
* which could uniquely identify the user. If none is specified, a
|
|
4295
|
+
* system-generated identifier will be assigned to the user.
|
|
2990
4296
|
*/
|
|
2991
|
-
|
|
2992
|
-
|
|
2993
|
-
|
|
2994
|
-
export type SchemaBoolFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2995
|
-
/** Default value. */
|
|
2996
|
-
default_value?: boolean;
|
|
2997
|
-
};
|
|
2998
|
-
/** schema-bool-list-field-descriptor */
|
|
2999
|
-
export type SchemaBoolListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3000
|
-
/** Default value. */
|
|
3001
|
-
default_value?: boolean[];
|
|
3002
|
-
};
|
|
3003
|
-
/** schema-composite-field-descriptor */
|
|
3004
|
-
export type SchemaCompositeFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3005
|
-
/** Composite type. Required when field type is composite. */
|
|
3006
|
-
composite_type?: string;
|
|
3007
|
-
};
|
|
3008
|
-
/** schema-composite-list-field-descriptor */
|
|
3009
|
-
export type SchemaCompositeListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3010
|
-
/** Composite type. Required when field type is composite. */
|
|
3011
|
-
composite_type?: string;
|
|
3012
|
-
};
|
|
3013
|
-
/** schema-date-field-descriptor */
|
|
3014
|
-
export type SchemaDateFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3015
|
-
/** Default value. */
|
|
3016
|
-
default_value?: string;
|
|
3017
|
-
};
|
|
3018
|
-
/** schema-date-list-field-descriptor */
|
|
3019
|
-
export type SchemaDateListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3020
|
-
/** Default value. */
|
|
3021
|
-
default_value?: string[];
|
|
3022
|
-
};
|
|
3023
|
-
/** schema-double-field-descriptor */
|
|
3024
|
-
export type SchemaDoubleFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4297
|
+
external_ref?: string;
|
|
4298
|
+
/** Phone numbers, in E.164 format, of the Rev user. */
|
|
4299
|
+
phone_numbers?: string[];
|
|
3025
4300
|
/**
|
|
3026
|
-
*
|
|
3027
|
-
*
|
|
4301
|
+
* The ID of the Rev organization to which the created Rev user is
|
|
4302
|
+
* associated.
|
|
4303
|
+
* @example "REV-AbCdEfGh"
|
|
3028
4304
|
*/
|
|
3029
|
-
|
|
3030
|
-
}
|
|
3031
|
-
/**
|
|
3032
|
-
|
|
4305
|
+
rev_org?: string;
|
|
4306
|
+
}
|
|
4307
|
+
/**
|
|
4308
|
+
* rev-users-create-response
|
|
4309
|
+
* Response object for creating a new Rev user for Rev organization.
|
|
4310
|
+
*/
|
|
4311
|
+
export interface RevUsersCreateResponse {
|
|
4312
|
+
rev_user: RevUser;
|
|
4313
|
+
}
|
|
4314
|
+
/**
|
|
4315
|
+
* rev-users-delete-request
|
|
4316
|
+
* Request object to delete a Rev user.
|
|
4317
|
+
*/
|
|
4318
|
+
export interface RevUsersDeleteRequest {
|
|
4319
|
+
/** The ID of Rev user to delete. */
|
|
4320
|
+
id: string;
|
|
4321
|
+
}
|
|
4322
|
+
/**
|
|
4323
|
+
* rev-users-delete-response
|
|
4324
|
+
* The response to deleting a Rev user of a Rev organization.
|
|
4325
|
+
*/
|
|
4326
|
+
export type RevUsersDeleteResponse = object;
|
|
4327
|
+
/**
|
|
4328
|
+
* rev-users-get-request
|
|
4329
|
+
* Request object to get a Rev user.
|
|
4330
|
+
*/
|
|
4331
|
+
export interface RevUsersGetRequest {
|
|
4332
|
+
/** The ID of Rev user to be retrieved. */
|
|
4333
|
+
id: string;
|
|
4334
|
+
}
|
|
4335
|
+
/**
|
|
4336
|
+
* rev-users-get-response
|
|
4337
|
+
* The returned Rev user.
|
|
4338
|
+
*/
|
|
4339
|
+
export interface RevUsersGetResponse {
|
|
4340
|
+
rev_user: RevUser;
|
|
4341
|
+
}
|
|
4342
|
+
/**
|
|
4343
|
+
* rev-users-list-request
|
|
4344
|
+
* Gets the list of Rev users belonging to the authenticated user's Dev
|
|
4345
|
+
* organization which the user is also authorized to access.
|
|
4346
|
+
*/
|
|
4347
|
+
export interface RevUsersListRequest {
|
|
4348
|
+
/**
|
|
4349
|
+
* Filters for Rev users with specified associations
|
|
4350
|
+
* (account/workspace).
|
|
4351
|
+
*/
|
|
4352
|
+
associations?: string[];
|
|
4353
|
+
/** Filters for Rev users that were created by the specified user(s). */
|
|
4354
|
+
created_by?: string[];
|
|
4355
|
+
created_date?: DateTimeFilter;
|
|
4356
|
+
/**
|
|
4357
|
+
* The cursor to resume iteration from. If not provided, then
|
|
4358
|
+
* iteration starts from the beginning.
|
|
4359
|
+
*/
|
|
4360
|
+
cursor?: string;
|
|
4361
|
+
/** List of emails of Rev users to be filtered. */
|
|
4362
|
+
email?: string[];
|
|
4363
|
+
/** List of external refs to filter Rev users for. */
|
|
4364
|
+
external_ref?: string[];
|
|
4365
|
+
/** Value of is_verified field to filter the Rev users. */
|
|
4366
|
+
is_verified?: boolean;
|
|
4367
|
+
/**
|
|
4368
|
+
* The maximum number of Rev users to return. The default is '50'.
|
|
4369
|
+
* @format int32
|
|
4370
|
+
*/
|
|
4371
|
+
limit?: number;
|
|
4372
|
+
/**
|
|
4373
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
4374
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
4375
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
4376
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
4377
|
+
* always be returned in the specified sort-by order.
|
|
4378
|
+
*/
|
|
4379
|
+
mode?: ListMode;
|
|
4380
|
+
modified_date?: DateTimeFilter;
|
|
4381
|
+
/** List of phone numbers, in E.164 format, to filter Rev users on. */
|
|
4382
|
+
phone_numbers?: string[];
|
|
4383
|
+
/**
|
|
4384
|
+
* List of IDs of Rev organizations to be filtered.
|
|
4385
|
+
* @example ["REV-AbCdEfGh"]
|
|
4386
|
+
*/
|
|
4387
|
+
rev_org?: string[];
|
|
4388
|
+
/** Fields to sort the Rev users by and the direction to sort them. */
|
|
4389
|
+
sort_by?: string[];
|
|
4390
|
+
}
|
|
4391
|
+
/**
|
|
4392
|
+
* rev-users-list-response
|
|
4393
|
+
* The response to listing all Rev users matching the filter criteria.
|
|
4394
|
+
*/
|
|
4395
|
+
export interface RevUsersListResponse {
|
|
4396
|
+
/**
|
|
4397
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
4398
|
+
* sort order. If not set, then no later elements exist.
|
|
4399
|
+
*/
|
|
4400
|
+
next_cursor?: string;
|
|
4401
|
+
/**
|
|
4402
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
4403
|
+
* sort order. If not set, then no prior elements exist.
|
|
4404
|
+
*/
|
|
4405
|
+
prev_cursor?: string;
|
|
4406
|
+
/** List containing all the Rev users. */
|
|
4407
|
+
rev_users: RevUser[];
|
|
4408
|
+
}
|
|
4409
|
+
/**
|
|
4410
|
+
* rev-users-update-request
|
|
4411
|
+
* Request to update details of a Rev user.
|
|
4412
|
+
*/
|
|
4413
|
+
export interface RevUsersUpdateRequest {
|
|
4414
|
+
/** Application-defined custom fields. */
|
|
4415
|
+
custom_fields?: object;
|
|
4416
|
+
custom_schema_fragments?: RevUsersUpdateRequestCustomSchemaFragments;
|
|
4417
|
+
/**
|
|
4418
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
4419
|
+
* custom field must be specified, otherwise a bad request error is
|
|
4420
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
4421
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
4422
|
+
* specifier, it remains unmodified.
|
|
4423
|
+
*/
|
|
4424
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
4425
|
+
/** Updated description of the Rev user. */
|
|
4426
|
+
description?: string;
|
|
4427
|
+
/** Updated display name of the Rev user. */
|
|
4428
|
+
display_name?: string;
|
|
4429
|
+
/**
|
|
4430
|
+
* Artifact ID of a Rev user's updated display picture.
|
|
4431
|
+
* @example "ARTIFACT-12345"
|
|
4432
|
+
*/
|
|
4433
|
+
display_picture?: string | null;
|
|
4434
|
+
/** Updated email address of the Rev user. */
|
|
4435
|
+
email?: string;
|
|
4436
|
+
/** Updated external ref value of the Rev user. */
|
|
4437
|
+
external_ref?: string;
|
|
4438
|
+
/** The ID of Rev user to update. */
|
|
4439
|
+
id: string;
|
|
4440
|
+
/** The phone numbers, in E.164 format, of the Rev user. */
|
|
4441
|
+
phone_numbers?: string[];
|
|
4442
|
+
}
|
|
4443
|
+
/** rev-users-update-request-custom-schema-fragments */
|
|
4444
|
+
export interface RevUsersUpdateRequestCustomSchemaFragments {
|
|
4445
|
+
/**
|
|
4446
|
+
* Sets the IDs to the provided schema fragment IDs.
|
|
4447
|
+
* @example ["don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"]
|
|
4448
|
+
*/
|
|
4449
|
+
set?: string[];
|
|
4450
|
+
}
|
|
4451
|
+
/**
|
|
4452
|
+
* rev-users-update-response
|
|
4453
|
+
* Updated Rev user object.
|
|
4454
|
+
*/
|
|
4455
|
+
export interface RevUsersUpdateResponse {
|
|
4456
|
+
rev_user: RevUser;
|
|
4457
|
+
}
|
|
4458
|
+
/** saml-connection-fields-map */
|
|
4459
|
+
export interface SamlConnectionFieldsMap {
|
|
4460
|
+
/**
|
|
4461
|
+
* Claims in the SAML assertion returned by the identity provider that
|
|
4462
|
+
* map to the email address of the user.
|
|
4463
|
+
*/
|
|
4464
|
+
email?: string;
|
|
4465
|
+
/**
|
|
4466
|
+
* Claims in the SAML assertion returned by the identity provider that
|
|
4467
|
+
* map to the user ID of the user.
|
|
4468
|
+
*/
|
|
4469
|
+
user_id?: string;
|
|
4470
|
+
}
|
|
4471
|
+
/** schema-bool-field-descriptor */
|
|
4472
|
+
export type SchemaBoolFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4473
|
+
/** Default value. */
|
|
4474
|
+
default_value?: boolean;
|
|
4475
|
+
};
|
|
4476
|
+
/** schema-bool-list-field-descriptor */
|
|
4477
|
+
export type SchemaBoolListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4478
|
+
/** Default value. */
|
|
4479
|
+
default_value?: boolean[];
|
|
4480
|
+
};
|
|
4481
|
+
/** schema-composite-field-descriptor */
|
|
4482
|
+
export type SchemaCompositeFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4483
|
+
/** Composite type. Required when field type is composite. */
|
|
4484
|
+
composite_type?: string;
|
|
4485
|
+
};
|
|
4486
|
+
/** schema-composite-list-field-descriptor */
|
|
4487
|
+
export type SchemaCompositeListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4488
|
+
/** Composite type. Required when field type is composite. */
|
|
4489
|
+
composite_type?: string;
|
|
4490
|
+
};
|
|
4491
|
+
/** schema-date-field-descriptor */
|
|
4492
|
+
export type SchemaDateFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4493
|
+
/** Default value. */
|
|
4494
|
+
default_value?: string;
|
|
4495
|
+
};
|
|
4496
|
+
/** schema-date-list-field-descriptor */
|
|
4497
|
+
export type SchemaDateListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4498
|
+
/** Default value. */
|
|
4499
|
+
default_value?: string[];
|
|
4500
|
+
};
|
|
4501
|
+
/** schema-double-field-descriptor */
|
|
4502
|
+
export type SchemaDoubleFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4503
|
+
/**
|
|
4504
|
+
* Default value.
|
|
4505
|
+
* @format double
|
|
4506
|
+
*/
|
|
4507
|
+
default_value?: number;
|
|
4508
|
+
};
|
|
4509
|
+
/** schema-double-list-field-descriptor */
|
|
4510
|
+
export type SchemaDoubleListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3033
4511
|
/** Default value. */
|
|
3034
4512
|
default_value?: number[];
|
|
3035
4513
|
};
|
|
@@ -3429,6 +4907,24 @@ export type SchemaUenumListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
3429
4907
|
};
|
|
3430
4908
|
/** schema-unknown-field-descriptor */
|
|
3431
4909
|
export type SchemaUnknownFieldDescriptor = SchemaFieldDescriptorBase;
|
|
4910
|
+
/** service-account */
|
|
4911
|
+
export type ServiceAccount = UserBase;
|
|
4912
|
+
/**
|
|
4913
|
+
* service-accounts-get-request
|
|
4914
|
+
* The request object to get a service account's information.
|
|
4915
|
+
*/
|
|
4916
|
+
export interface ServiceAccountsGetRequest {
|
|
4917
|
+
/** The ID of the requested service account. */
|
|
4918
|
+
id: string;
|
|
4919
|
+
}
|
|
4920
|
+
/**
|
|
4921
|
+
* service-accounts-get-response
|
|
4922
|
+
* The response object that carries the service account's information
|
|
4923
|
+
* corresponding to the request.
|
|
4924
|
+
*/
|
|
4925
|
+
export interface ServiceAccountsGetResponse {
|
|
4926
|
+
service_account: ServiceAccount;
|
|
4927
|
+
}
|
|
3432
4928
|
/** set-issue-selector */
|
|
3433
4929
|
export interface SetIssueSelector {
|
|
3434
4930
|
/**
|
|
@@ -3461,6 +4957,19 @@ export interface SetIssueSelector {
|
|
|
3461
4957
|
*/
|
|
3462
4958
|
tags?: string[];
|
|
3463
4959
|
}
|
|
4960
|
+
/**
|
|
4961
|
+
* set-shared-with-membership
|
|
4962
|
+
* Information about the role the member receives due to the share.
|
|
4963
|
+
*/
|
|
4964
|
+
export interface SetSharedWithMembership {
|
|
4965
|
+
/** ID of the member the object is shared with. */
|
|
4966
|
+
member?: string;
|
|
4967
|
+
/**
|
|
4968
|
+
* ID of the role that describes what privileges the membership
|
|
4969
|
+
* entails.
|
|
4970
|
+
*/
|
|
4971
|
+
role?: string;
|
|
4972
|
+
}
|
|
3464
4973
|
/** set-sla-policy */
|
|
3465
4974
|
export interface SetSlaPolicy {
|
|
3466
4975
|
/** Metrics to apply to the selected items. */
|
|
@@ -3555,6 +5064,16 @@ export interface SetTagWithValue {
|
|
|
3555
5064
|
*/
|
|
3556
5065
|
value?: string;
|
|
3557
5066
|
}
|
|
5067
|
+
/**
|
|
5068
|
+
* shared-with-membership-filter
|
|
5069
|
+
* Filter on target item based on intended audience.
|
|
5070
|
+
*/
|
|
5071
|
+
export interface SharedWithMembershipFilter {
|
|
5072
|
+
/** ID of the group/member with whom the item is shared. */
|
|
5073
|
+
member?: string;
|
|
5074
|
+
/** Role ID of the group/member with whom the item is shared. */
|
|
5075
|
+
role?: string;
|
|
5076
|
+
}
|
|
3558
5077
|
/** sla */
|
|
3559
5078
|
export type Sla = AtomBase & {
|
|
3560
5079
|
/**
|
|
@@ -4156,6 +5675,75 @@ export declare enum SyncRunMode {
|
|
|
4156
5675
|
export type SysUser = UserBase;
|
|
4157
5676
|
/** sys-user-summary */
|
|
4158
5677
|
export type SysUserSummary = UserBaseSummary;
|
|
5678
|
+
/**
|
|
5679
|
+
* sys-users-list-request
|
|
5680
|
+
* A request to get the list of system user's information.
|
|
5681
|
+
*/
|
|
5682
|
+
export interface SysUsersListRequest {
|
|
5683
|
+
/**
|
|
5684
|
+
* The cursor to resume iteration from. If not provided, then
|
|
5685
|
+
* iteration starts from the beginning.
|
|
5686
|
+
*/
|
|
5687
|
+
cursor?: string;
|
|
5688
|
+
/**
|
|
5689
|
+
* The maximum number of system users to return. Value can range from
|
|
5690
|
+
* '1' to '100', with a default of '50'.
|
|
5691
|
+
* @format int32
|
|
5692
|
+
*/
|
|
5693
|
+
limit?: number;
|
|
5694
|
+
/**
|
|
5695
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
5696
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
5697
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
5698
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
5699
|
+
* always be returned in the specified sort-by order.
|
|
5700
|
+
*/
|
|
5701
|
+
mode?: ListMode;
|
|
5702
|
+
/** Fields to sort the system users by and the direction to sort them. */
|
|
5703
|
+
sort_by?: string[];
|
|
5704
|
+
}
|
|
5705
|
+
/**
|
|
5706
|
+
* sys-users-list-response
|
|
5707
|
+
* The response to listing the system users.
|
|
5708
|
+
*/
|
|
5709
|
+
export interface SysUsersListResponse {
|
|
5710
|
+
/**
|
|
5711
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
5712
|
+
* sort order. If not set, then no later elements exist.
|
|
5713
|
+
*/
|
|
5714
|
+
next_cursor?: string;
|
|
5715
|
+
/**
|
|
5716
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
5717
|
+
* sort order. If not set, then no prior elements exist.
|
|
5718
|
+
*/
|
|
5719
|
+
prev_cursor?: string;
|
|
5720
|
+
/** The list of system users. */
|
|
5721
|
+
sys_users: SysUser[];
|
|
5722
|
+
}
|
|
5723
|
+
/**
|
|
5724
|
+
* sys-users-update-request
|
|
5725
|
+
* Request to update information of the system user.
|
|
5726
|
+
*/
|
|
5727
|
+
export interface SysUsersUpdateRequest {
|
|
5728
|
+
/** Updated display name for the system user. */
|
|
5729
|
+
display_name?: string;
|
|
5730
|
+
/**
|
|
5731
|
+
* Artifact ID of the system user's new display picture.
|
|
5732
|
+
* @example "ARTIFACT-12345"
|
|
5733
|
+
*/
|
|
5734
|
+
display_picture?: string | null;
|
|
5735
|
+
/** Updated full name for the system user. */
|
|
5736
|
+
full_name?: string;
|
|
5737
|
+
/** The ID of system user to update. */
|
|
5738
|
+
id: string;
|
|
5739
|
+
}
|
|
5740
|
+
/**
|
|
5741
|
+
* sys-users-update-response
|
|
5742
|
+
* Updated Sys user object.
|
|
5743
|
+
*/
|
|
5744
|
+
export interface SysUsersUpdateResponse {
|
|
5745
|
+
sys_user: SysUser;
|
|
5746
|
+
}
|
|
4159
5747
|
/** tag */
|
|
4160
5748
|
export type Tag = AtomBase & {
|
|
4161
5749
|
/**
|
|
@@ -4191,6 +5779,19 @@ export interface TagWithValue {
|
|
|
4191
5779
|
/** The value for the object's association with the tag. */
|
|
4192
5780
|
value?: string;
|
|
4193
5781
|
}
|
|
5782
|
+
/** tag-with-value-filter */
|
|
5783
|
+
export interface TagWithValueFilter {
|
|
5784
|
+
/**
|
|
5785
|
+
* The ID of the tag.
|
|
5786
|
+
* @example "TAG-12345"
|
|
5787
|
+
*/
|
|
5788
|
+
id?: string;
|
|
5789
|
+
/**
|
|
5790
|
+
* The value for the object's association with the tag. If specified,
|
|
5791
|
+
* the value must be one that's specified in the tag's allowed values.
|
|
5792
|
+
*/
|
|
5793
|
+
value?: string;
|
|
5794
|
+
}
|
|
4194
5795
|
/**
|
|
4195
5796
|
* tags-create-request
|
|
4196
5797
|
* The request to create a new tag.
|
|
@@ -5131,7 +6732,10 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestTi
|
|
|
5131
6732
|
* @example ["ARTIFACT-12345"]
|
|
5132
6733
|
*/
|
|
5133
6734
|
artifacts?: string[];
|
|
5134
|
-
/**
|
|
6735
|
+
/**
|
|
6736
|
+
* Body of the work object.
|
|
6737
|
+
* @maxLength 65536
|
|
6738
|
+
*/
|
|
5135
6739
|
body?: string;
|
|
5136
6740
|
/**
|
|
5137
6741
|
* The users that own the work.
|
|
@@ -5308,6 +6912,8 @@ export interface WorksFilterTicket {
|
|
|
5308
6912
|
channels?: TicketChannels[];
|
|
5309
6913
|
/** Filters for tickets belonging to specific groups. */
|
|
5310
6914
|
group?: string[];
|
|
6915
|
+
/** Filters for frozen tickets. */
|
|
6916
|
+
is_frozen?: boolean;
|
|
5311
6917
|
/** Filters for tickets that are spam. */
|
|
5312
6918
|
is_spam?: boolean;
|
|
5313
6919
|
/** Filters for tickets that need response. */
|
|
@@ -5427,7 +7033,10 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
5427
7033
|
*/
|
|
5428
7034
|
applies_to_part?: string;
|
|
5429
7035
|
artifacts?: WorksUpdateRequestArtifacts;
|
|
5430
|
-
/**
|
|
7036
|
+
/**
|
|
7037
|
+
* Updated body of the work object, or unchanged if not provided.
|
|
7038
|
+
* @maxLength 65536
|
|
7039
|
+
*/
|
|
5431
7040
|
body?: string;
|
|
5432
7041
|
/**
|
|
5433
7042
|
* The work's ID.
|
|
@@ -5837,47 +7446,175 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5837
7446
|
*/
|
|
5838
7447
|
accountsUpdate: (data: AccountsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsUpdateResponse, any>>;
|
|
5839
7448
|
/**
|
|
5840
|
-
* @description
|
|
7449
|
+
* @description Article is an object which can contain a URL or artifacts in the resource. It also contains the data regarding the owner, author, status and published date of the object. This call creates an article.
|
|
5841
7450
|
*
|
|
5842
|
-
* @tags
|
|
5843
|
-
* @name
|
|
5844
|
-
* @summary
|
|
5845
|
-
* @request
|
|
7451
|
+
* @tags articles
|
|
7452
|
+
* @name CreateArticle
|
|
7453
|
+
* @summary Create Article
|
|
7454
|
+
* @request POST:/articles.create
|
|
5846
7455
|
* @secure
|
|
5847
7456
|
*/
|
|
5848
|
-
|
|
7457
|
+
createArticle: (data: ArticlesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesCreateResponse, any>>;
|
|
7458
|
+
/**
|
|
7459
|
+
* @description Deletes an article.
|
|
7460
|
+
*
|
|
7461
|
+
* @tags articles
|
|
7462
|
+
* @name DeleteArticle
|
|
7463
|
+
* @summary Delete Article
|
|
7464
|
+
* @request POST:/articles.delete
|
|
7465
|
+
* @secure
|
|
7466
|
+
*/
|
|
7467
|
+
deleteArticle: (data: ArticlesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
7468
|
+
/**
|
|
7469
|
+
* @description Gets an article.
|
|
7470
|
+
*
|
|
7471
|
+
* @tags articles
|
|
7472
|
+
* @name GetArticle
|
|
7473
|
+
* @summary Get Article
|
|
7474
|
+
* @request GET:/articles.get
|
|
7475
|
+
* @secure
|
|
7476
|
+
*/
|
|
7477
|
+
getArticle: (query: {
|
|
5849
7478
|
/**
|
|
5850
|
-
* The
|
|
5851
|
-
* @example "
|
|
7479
|
+
* The ID of the required article.
|
|
7480
|
+
* @example "ARTICLE-12345"
|
|
5852
7481
|
*/
|
|
5853
7482
|
id: string;
|
|
5854
|
-
|
|
5855
|
-
version?: string;
|
|
5856
|
-
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any>>;
|
|
7483
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
|
|
5857
7484
|
/**
|
|
5858
|
-
* @description Gets
|
|
7485
|
+
* @description Gets an article.
|
|
5859
7486
|
*
|
|
5860
|
-
* @tags
|
|
5861
|
-
* @name
|
|
5862
|
-
* @summary Get
|
|
5863
|
-
* @request POST:/
|
|
7487
|
+
* @tags articles
|
|
7488
|
+
* @name GetArticlePost
|
|
7489
|
+
* @summary Get Article (POST)
|
|
7490
|
+
* @request POST:/articles.get
|
|
5864
7491
|
* @secure
|
|
5865
7492
|
*/
|
|
5866
|
-
|
|
7493
|
+
getArticlePost: (data: ArticlesGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
|
|
5867
7494
|
/**
|
|
5868
|
-
* @description
|
|
7495
|
+
* @description Lists a collection of articles.
|
|
5869
7496
|
*
|
|
5870
|
-
* @tags
|
|
5871
|
-
* @name
|
|
5872
|
-
* @summary List
|
|
5873
|
-
* @request GET:/
|
|
7497
|
+
* @tags articles
|
|
7498
|
+
* @name ListArticles
|
|
7499
|
+
* @summary List Articles
|
|
7500
|
+
* @request GET:/articles.list
|
|
5874
7501
|
* @secure
|
|
5875
7502
|
*/
|
|
5876
|
-
|
|
5877
|
-
/**
|
|
5878
|
-
|
|
5879
|
-
|
|
5880
|
-
|
|
7503
|
+
listArticles: (query?: {
|
|
7504
|
+
/**
|
|
7505
|
+
* Filters for articles belonging to any of the provided parts.
|
|
7506
|
+
* @example ["PROD-12345"]
|
|
7507
|
+
*/
|
|
7508
|
+
applies_to_parts?: string[];
|
|
7509
|
+
/**
|
|
7510
|
+
* Filter for the type of articles. If this is not provided, then
|
|
7511
|
+
* articles that are not content blocks are returned.
|
|
7512
|
+
*/
|
|
7513
|
+
article_type?: ArticleType[];
|
|
7514
|
+
/**
|
|
7515
|
+
* Filters for articles authored by any of the provided users.
|
|
7516
|
+
* @example ["DEVU-12345"]
|
|
7517
|
+
*/
|
|
7518
|
+
authored_by?: string[];
|
|
7519
|
+
/**
|
|
7520
|
+
* Filters for articles created by any of the provided users.
|
|
7521
|
+
* @example ["DEVU-12345"]
|
|
7522
|
+
*/
|
|
7523
|
+
created_by?: string[];
|
|
7524
|
+
/**
|
|
7525
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
7526
|
+
* starts from the beginning.
|
|
7527
|
+
*/
|
|
7528
|
+
cursor?: string;
|
|
7529
|
+
/**
|
|
7530
|
+
* The maximum number of articles to return. The default is '50'.
|
|
7531
|
+
* @format int32
|
|
7532
|
+
*/
|
|
7533
|
+
limit?: number;
|
|
7534
|
+
/**
|
|
7535
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
7536
|
+
* used.
|
|
7537
|
+
*/
|
|
7538
|
+
mode?: ListMode;
|
|
7539
|
+
/**
|
|
7540
|
+
* Filters for articles modified by any of the provided users.
|
|
7541
|
+
* @example ["DEVU-12345"]
|
|
7542
|
+
*/
|
|
7543
|
+
modified_by?: string[];
|
|
7544
|
+
/**
|
|
7545
|
+
* Filters for articles owned by any of the provided users.
|
|
7546
|
+
* @example ["DEVU-12345"]
|
|
7547
|
+
*/
|
|
7548
|
+
owned_by?: string[];
|
|
7549
|
+
/** Filter for the scope of the articles. */
|
|
7550
|
+
scope?: number[];
|
|
7551
|
+
/** ID of the group/member with whom the item is shared. */
|
|
7552
|
+
'shared_with.member'?: string;
|
|
7553
|
+
/** Role ID of the group/member with whom the item is shared. */
|
|
7554
|
+
'shared_with.role'?: string;
|
|
7555
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
|
|
7556
|
+
/**
|
|
7557
|
+
* @description Lists a collection of articles.
|
|
7558
|
+
*
|
|
7559
|
+
* @tags articles
|
|
7560
|
+
* @name ListArticlesPost
|
|
7561
|
+
* @summary List Articles (POST)
|
|
7562
|
+
* @request POST:/articles.list
|
|
7563
|
+
* @secure
|
|
7564
|
+
*/
|
|
7565
|
+
listArticlesPost: (data: ArticlesListRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
|
|
7566
|
+
/**
|
|
7567
|
+
* @description Updates an article.
|
|
7568
|
+
*
|
|
7569
|
+
* @tags articles
|
|
7570
|
+
* @name UpdateArticle
|
|
7571
|
+
* @summary Update Article
|
|
7572
|
+
* @request POST:/articles.update
|
|
7573
|
+
* @secure
|
|
7574
|
+
*/
|
|
7575
|
+
updateArticle: (data: ArticlesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesUpdateResponse, any>>;
|
|
7576
|
+
/**
|
|
7577
|
+
* @description Gets the requested artifact's information.
|
|
7578
|
+
*
|
|
7579
|
+
* @tags artifacts
|
|
7580
|
+
* @name ArtifactsGet
|
|
7581
|
+
* @summary Get Artifact
|
|
7582
|
+
* @request GET:/artifacts.get
|
|
7583
|
+
* @secure
|
|
7584
|
+
*/
|
|
7585
|
+
artifactsGet: (query: {
|
|
7586
|
+
/**
|
|
7587
|
+
* The requested artifact's ID.
|
|
7588
|
+
* @example "ARTIFACT-12345"
|
|
7589
|
+
*/
|
|
7590
|
+
id: string;
|
|
7591
|
+
/** The version of the artifact that needs to be fetched. */
|
|
7592
|
+
version?: string;
|
|
7593
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any>>;
|
|
7594
|
+
/**
|
|
7595
|
+
* @description Gets the requested artifact's information.
|
|
7596
|
+
*
|
|
7597
|
+
* @tags artifacts
|
|
7598
|
+
* @name ArtifactsGetPost
|
|
7599
|
+
* @summary Get Artifact (POST)
|
|
7600
|
+
* @request POST:/artifacts.get
|
|
7601
|
+
* @secure
|
|
7602
|
+
*/
|
|
7603
|
+
artifactsGetPost: (data: ArtifactsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any>>;
|
|
7604
|
+
/**
|
|
7605
|
+
* @description List the artifacts attached to an object.
|
|
7606
|
+
*
|
|
7607
|
+
* @tags artifacts
|
|
7608
|
+
* @name ArtifactsList
|
|
7609
|
+
* @summary List Artifacts
|
|
7610
|
+
* @request GET:/artifacts.list
|
|
7611
|
+
* @secure
|
|
7612
|
+
*/
|
|
7613
|
+
artifactsList: (query?: {
|
|
7614
|
+
/** The ID of the object to filter artifacts. */
|
|
7615
|
+
parent_id?: string;
|
|
7616
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any>>;
|
|
7617
|
+
/**
|
|
5881
7618
|
* @description List the artifacts attached to an object.
|
|
5882
7619
|
*
|
|
5883
7620
|
* @tags artifacts
|
|
@@ -6048,10 +7785,173 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6048
7785
|
* @secure
|
|
6049
7786
|
*/
|
|
6050
7787
|
authTokensUpdate: (data: AuthTokensUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensUpdateResponse, any>>;
|
|
7788
|
+
/**
|
|
7789
|
+
* @description Creates a conversation.
|
|
7790
|
+
*
|
|
7791
|
+
* @tags conversations
|
|
7792
|
+
* @name ConversationsCreate
|
|
7793
|
+
* @summary Create Conversation
|
|
7794
|
+
* @request POST:/conversations.create
|
|
7795
|
+
* @secure
|
|
7796
|
+
*/
|
|
7797
|
+
conversationsCreate: (data: ConversationsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsCreateResponse, any>>;
|
|
7798
|
+
/**
|
|
7799
|
+
* @description Deletes the requested conversation.
|
|
7800
|
+
*
|
|
7801
|
+
* @tags conversations
|
|
7802
|
+
* @name ConversationsDelete
|
|
7803
|
+
* @summary Delete Conversation
|
|
7804
|
+
* @request POST:/conversations.delete
|
|
7805
|
+
* @secure
|
|
7806
|
+
*/
|
|
7807
|
+
conversationsDelete: (data: ConversationsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
7808
|
+
/**
|
|
7809
|
+
* @description Gets the requested conversation's information.
|
|
7810
|
+
*
|
|
7811
|
+
* @tags conversations
|
|
7812
|
+
* @name ConversationsGet
|
|
7813
|
+
* @summary Get Conversation
|
|
7814
|
+
* @request GET:/conversations.get
|
|
7815
|
+
* @secure
|
|
7816
|
+
*/
|
|
7817
|
+
conversationsGet: (query: {
|
|
7818
|
+
/** The requested conversation's ID. */
|
|
7819
|
+
id: string;
|
|
7820
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any>>;
|
|
7821
|
+
/**
|
|
7822
|
+
* @description Gets the requested conversation's information.
|
|
7823
|
+
*
|
|
7824
|
+
* @tags conversations
|
|
7825
|
+
* @name ConversationsGetPost
|
|
7826
|
+
* @summary Get Conversation (POST)
|
|
7827
|
+
* @request POST:/conversations.get
|
|
7828
|
+
* @secure
|
|
7829
|
+
*/
|
|
7830
|
+
conversationsGetPost: (data: ConversationsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any>>;
|
|
7831
|
+
/**
|
|
7832
|
+
* @description Lists the available conversations.
|
|
7833
|
+
*
|
|
7834
|
+
* @tags conversations
|
|
7835
|
+
* @name ConversationsList
|
|
7836
|
+
* @summary List Conversations
|
|
7837
|
+
* @request GET:/conversations.list
|
|
7838
|
+
* @secure
|
|
7839
|
+
*/
|
|
7840
|
+
conversationsList: (query?: {
|
|
7841
|
+
/**
|
|
7842
|
+
* Filters for conversations belonging to any of the provided parts.
|
|
7843
|
+
* @example ["PROD-12345"]
|
|
7844
|
+
*/
|
|
7845
|
+
applies_to_parts?: string[];
|
|
7846
|
+
/**
|
|
7847
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
7848
|
+
* starts from the beginning.
|
|
7849
|
+
*/
|
|
7850
|
+
cursor?: string;
|
|
7851
|
+
/** Filters for conversation that belong to the given groups. */
|
|
7852
|
+
group?: string[];
|
|
7853
|
+
/** Filters for conversations that are created by verified users. */
|
|
7854
|
+
is_creator_verified?: boolean;
|
|
7855
|
+
/** Filters for conversations that are spam. */
|
|
7856
|
+
is_spam?: boolean;
|
|
7857
|
+
/**
|
|
7858
|
+
* The maximum number of conversations to return. The default is '50'.
|
|
7859
|
+
* @format int32
|
|
7860
|
+
*/
|
|
7861
|
+
limit?: number;
|
|
7862
|
+
/**
|
|
7863
|
+
* Filters for conversations where these users are participants.
|
|
7864
|
+
* @example ["DEVU-12345"]
|
|
7865
|
+
*/
|
|
7866
|
+
members?: string[];
|
|
7867
|
+
/**
|
|
7868
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
7869
|
+
* used.
|
|
7870
|
+
*/
|
|
7871
|
+
mode?: ListMode;
|
|
7872
|
+
/**
|
|
7873
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
7874
|
+
* @format date-time
|
|
7875
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
7876
|
+
*/
|
|
7877
|
+
'modified_date.after'?: string;
|
|
7878
|
+
/**
|
|
7879
|
+
* Filters for objects created before the provided timestamp
|
|
7880
|
+
* (inclusive).
|
|
7881
|
+
* @format date-time
|
|
7882
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
7883
|
+
*/
|
|
7884
|
+
'modified_date.before'?: string;
|
|
7885
|
+
/**
|
|
7886
|
+
* Filters for conversations owned by any of these users.
|
|
7887
|
+
* @example ["DEVU-12345"]
|
|
7888
|
+
*/
|
|
7889
|
+
owned_by?: string[];
|
|
7890
|
+
/**
|
|
7891
|
+
* Filters for conversations that are associated with any of the
|
|
7892
|
+
* provided Rev organizations.
|
|
7893
|
+
* @deprecated
|
|
7894
|
+
* @example ["REV-AbCdEfGh"]
|
|
7895
|
+
*/
|
|
7896
|
+
rev_org?: string[];
|
|
7897
|
+
/**
|
|
7898
|
+
* Filters for conversations that are associated with any of the
|
|
7899
|
+
* provided Rev organizations.
|
|
7900
|
+
* @example ["REV-AbCdEfGh"]
|
|
7901
|
+
*/
|
|
7902
|
+
rev_orgs?: string[];
|
|
7903
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
7904
|
+
'sla_summary.stage'?: SlaSummaryStage[];
|
|
7905
|
+
/** Filters for conversations with any of the provided source channels. */
|
|
7906
|
+
source_channel?: string[];
|
|
7907
|
+
/**
|
|
7908
|
+
* Filters for conversations with any of the provided source channels.
|
|
7909
|
+
* @deprecated
|
|
7910
|
+
*/
|
|
7911
|
+
source_channels?: string[];
|
|
7912
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
7913
|
+
'stage.name'?: string[];
|
|
7914
|
+
/**
|
|
7915
|
+
* Filters for conversations with any of the provided tags.
|
|
7916
|
+
* @deprecated
|
|
7917
|
+
* @example ["TAG-12345"]
|
|
7918
|
+
*/
|
|
7919
|
+
tags?: string[];
|
|
7920
|
+
/**
|
|
7921
|
+
* The ID of the tag.
|
|
7922
|
+
* @example "TAG-12345"
|
|
7923
|
+
*/
|
|
7924
|
+
'tags_v2.id'?: string;
|
|
7925
|
+
/**
|
|
7926
|
+
* The value for the object's association with the tag. If specified,
|
|
7927
|
+
* the value must be one that's specified in the tag's allowed values.
|
|
7928
|
+
*/
|
|
7929
|
+
'tags_v2.value'?: string;
|
|
7930
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
|
|
7931
|
+
/**
|
|
7932
|
+
* @description Lists the available conversations.
|
|
7933
|
+
*
|
|
7934
|
+
* @tags conversations
|
|
7935
|
+
* @name ConversationsListPost
|
|
7936
|
+
* @summary List Conversations (POST)
|
|
7937
|
+
* @request POST:/conversations.list
|
|
7938
|
+
* @secure
|
|
7939
|
+
*/
|
|
7940
|
+
conversationsListPost: (data: ConversationsListRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
|
|
7941
|
+
/**
|
|
7942
|
+
* @description Updates the requested conversation.
|
|
7943
|
+
*
|
|
7944
|
+
* @tags conversations
|
|
7945
|
+
* @name ConversationsUpdate
|
|
7946
|
+
* @summary Update Conversation
|
|
7947
|
+
* @request POST:/conversations.update
|
|
7948
|
+
* @secure
|
|
7949
|
+
*/
|
|
7950
|
+
conversationsUpdate: (data: ConversationsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsUpdateResponse, any>>;
|
|
6051
7951
|
/**
|
|
6052
7952
|
* @description Creates a new enterprise authentication connection for a Dev organization. This authentication connection will not be enabled by default for the organization and the user will need to explicitly enable this. Keep in mind that at a time, only one authentication connection can be enabled for a Dev organization. At present, only 5 enterprise connections can be created by an organization.
|
|
6053
7953
|
*
|
|
6054
|
-
* @tags auth-
|
|
7954
|
+
* @tags auth-connections, dev-orgs
|
|
6055
7955
|
* @name DevOrgAuthConnectionsCreate
|
|
6056
7956
|
* @summary Create Dev Orgs Auth Connection
|
|
6057
7957
|
* @request POST:/dev-orgs.auth-connections.create
|
|
@@ -6061,7 +7961,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6061
7961
|
/**
|
|
6062
7962
|
* @description Deletes an authentication connection. Only enterprise connections which are explicitly set up for a Dev organization can be deleted. Default connections can not be deleted using this method.
|
|
6063
7963
|
*
|
|
6064
|
-
* @tags auth-
|
|
7964
|
+
* @tags auth-connections, dev-orgs
|
|
6065
7965
|
* @name DevOrgAuthConnectionsDelete
|
|
6066
7966
|
* @summary Delete Dev Orgs Auth Connection
|
|
6067
7967
|
* @request POST:/dev-orgs.auth-connections.delete
|
|
@@ -6071,7 +7971,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6071
7971
|
/**
|
|
6072
7972
|
* @description Retrieves the details for an authentication connection.
|
|
6073
7973
|
*
|
|
6074
|
-
* @tags auth-
|
|
7974
|
+
* @tags auth-connections, dev-orgs
|
|
6075
7975
|
* @name DevOrgAuthConnectionsGet
|
|
6076
7976
|
* @summary Get Dev Orgs Auth Connection
|
|
6077
7977
|
* @request GET:/dev-orgs.auth-connections.get
|
|
@@ -6084,7 +7984,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6084
7984
|
/**
|
|
6085
7985
|
* @description Retrieves the details for an authentication connection.
|
|
6086
7986
|
*
|
|
6087
|
-
* @tags auth-
|
|
7987
|
+
* @tags auth-connections, dev-orgs
|
|
6088
7988
|
* @name DevOrgAuthConnectionsGetPost
|
|
6089
7989
|
* @summary Get Dev Orgs Auth Connection (POST)
|
|
6090
7990
|
* @request POST:/dev-orgs.auth-connections.get
|
|
@@ -6094,7 +7994,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6094
7994
|
/**
|
|
6095
7995
|
* @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user.
|
|
6096
7996
|
*
|
|
6097
|
-
* @tags auth-
|
|
7997
|
+
* @tags auth-connections, dev-orgs
|
|
6098
7998
|
* @name DevOrgAuthConnectionsList
|
|
6099
7999
|
* @summary List Dev Orgs Auth Connections
|
|
6100
8000
|
* @request GET:/dev-orgs.auth-connections.list
|
|
@@ -6104,7 +8004,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6104
8004
|
/**
|
|
6105
8005
|
* @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user.
|
|
6106
8006
|
*
|
|
6107
|
-
* @tags auth-
|
|
8007
|
+
* @tags auth-connections, dev-orgs
|
|
6108
8008
|
* @name DevOrgAuthConnectionsListPost
|
|
6109
8009
|
* @summary List Dev Orgs Auth Connections (POST)
|
|
6110
8010
|
* @request POST:/dev-orgs.auth-connections.list
|
|
@@ -6114,7 +8014,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6114
8014
|
/**
|
|
6115
8015
|
* @description Enable or disable an authentication connection for a Dev organization. Currently, only 1 authentication connection can be enabled at a time. When a new authentication connection is enabled, the connection which is currently enabled for the Dev organization is automatically disabled.
|
|
6116
8016
|
*
|
|
6117
|
-
* @tags auth-
|
|
8017
|
+
* @tags auth-connections, dev-orgs
|
|
6118
8018
|
* @name DevOrgAuthConnectionsToggle
|
|
6119
8019
|
* @summary Toggle Dev Orgs Auth Connections
|
|
6120
8020
|
* @request POST:/dev-orgs.auth-connections.toggle
|
|
@@ -6124,7 +8024,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6124
8024
|
/**
|
|
6125
8025
|
* @description Updates an authentication connection.
|
|
6126
8026
|
*
|
|
6127
|
-
* @tags auth-
|
|
8027
|
+
* @tags auth-connections, dev-orgs
|
|
6128
8028
|
* @name DevOrgAuthConnectionsUpdate
|
|
6129
8029
|
* @summary Update Dev Orgs Auth Connection
|
|
6130
8030
|
* @request POST:/dev-orgs.auth-connections.update
|
|
@@ -6220,10 +8120,178 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6220
8120
|
* @secure
|
|
6221
8121
|
*/
|
|
6222
8122
|
devUsersSelfPost: (data: DevUsersSelfRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any>>;
|
|
8123
|
+
/**
|
|
8124
|
+
* @description Updates the authenticated user.
|
|
8125
|
+
*
|
|
8126
|
+
* @tags dev-users
|
|
8127
|
+
* @name DevUsersSelfUpdate
|
|
8128
|
+
* @summary Update Dev Users Self
|
|
8129
|
+
* @request POST:/dev-users.self.update
|
|
8130
|
+
* @secure
|
|
8131
|
+
*/
|
|
8132
|
+
devUsersSelfUpdate: (data: DevUsersSelfUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any>>;
|
|
8133
|
+
/**
|
|
8134
|
+
* @description Updates the user corresponding to the input Id.
|
|
8135
|
+
*
|
|
8136
|
+
* @tags dev-users
|
|
8137
|
+
* @name DevUsersUpdate
|
|
8138
|
+
* @summary Update Dev User
|
|
8139
|
+
* @request POST:/dev-users.update
|
|
8140
|
+
* @secure
|
|
8141
|
+
*/
|
|
8142
|
+
devUsersUpdate: (data: DevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any>>;
|
|
8143
|
+
/**
|
|
8144
|
+
* @description Creates a new group. A group is a collection of users.
|
|
8145
|
+
*
|
|
8146
|
+
* @tags groups
|
|
8147
|
+
* @name GroupsCreate
|
|
8148
|
+
* @summary Create Group
|
|
8149
|
+
* @request POST:/groups.create
|
|
8150
|
+
* @secure
|
|
8151
|
+
*/
|
|
8152
|
+
groupsCreate: (data: GroupsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsCreateResponse, any>>;
|
|
8153
|
+
/**
|
|
8154
|
+
* @description Gets the requested group.
|
|
8155
|
+
*
|
|
8156
|
+
* @tags groups
|
|
8157
|
+
* @name GroupsGet
|
|
8158
|
+
* @summary Get Group
|
|
8159
|
+
* @request GET:/groups.get
|
|
8160
|
+
* @secure
|
|
8161
|
+
*/
|
|
8162
|
+
groupsGet: (query: {
|
|
8163
|
+
/** The ID of the group to get. */
|
|
8164
|
+
id: string;
|
|
8165
|
+
}, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any>>;
|
|
8166
|
+
/**
|
|
8167
|
+
* @description Gets the requested group.
|
|
8168
|
+
*
|
|
8169
|
+
* @tags groups
|
|
8170
|
+
* @name GroupsGetPost
|
|
8171
|
+
* @summary Get Group (POST)
|
|
8172
|
+
* @request POST:/groups.get
|
|
8173
|
+
* @secure
|
|
8174
|
+
*/
|
|
8175
|
+
groupsGetPost: (data: GroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any>>;
|
|
8176
|
+
/**
|
|
8177
|
+
* @description Lists the available groups.
|
|
8178
|
+
*
|
|
8179
|
+
* @tags groups
|
|
8180
|
+
* @name GroupsList
|
|
8181
|
+
* @summary List Groups
|
|
8182
|
+
* @request GET:/groups.list
|
|
8183
|
+
* @secure
|
|
8184
|
+
*/
|
|
8185
|
+
groupsList: (query?: {
|
|
8186
|
+
/**
|
|
8187
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
8188
|
+
* starts from the beginning.
|
|
8189
|
+
*/
|
|
8190
|
+
cursor?: string;
|
|
8191
|
+
/** Filters the groups based on the group type. */
|
|
8192
|
+
group_type?: GroupType[];
|
|
8193
|
+
/** Filter groups by ingestion source(s). */
|
|
8194
|
+
ingestion_source?: GroupIngestionSource[];
|
|
8195
|
+
/** Whether to fetch default or custom groups. */
|
|
8196
|
+
is_default?: boolean;
|
|
8197
|
+
/**
|
|
8198
|
+
* The maximum number of groups to return. The default is '50'.
|
|
8199
|
+
* @format int32
|
|
8200
|
+
*/
|
|
8201
|
+
limit?: number;
|
|
8202
|
+
/** Filters the groups on basis of member type. */
|
|
8203
|
+
member_type?: GroupMemberType[];
|
|
8204
|
+
/**
|
|
8205
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
8206
|
+
* used.
|
|
8207
|
+
*/
|
|
8208
|
+
mode?: ListMode;
|
|
8209
|
+
/** Comma-separated fields to sort the groups by. */
|
|
8210
|
+
sort_by?: string[];
|
|
8211
|
+
}, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any>>;
|
|
8212
|
+
/**
|
|
8213
|
+
* @description Lists the available groups.
|
|
8214
|
+
*
|
|
8215
|
+
* @tags groups
|
|
8216
|
+
* @name GroupsListPost
|
|
8217
|
+
* @summary List Groups (POST)
|
|
8218
|
+
* @request POST:/groups.list
|
|
8219
|
+
* @secure
|
|
8220
|
+
*/
|
|
8221
|
+
groupsListPost: (data: GroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any>>;
|
|
8222
|
+
/**
|
|
8223
|
+
* @description Adds a member to a group.
|
|
8224
|
+
*
|
|
8225
|
+
* @tags groups
|
|
8226
|
+
* @name GroupMembersAdd
|
|
8227
|
+
* @summary Add Groups Members
|
|
8228
|
+
* @request POST:/groups.members.add
|
|
8229
|
+
* @secure
|
|
8230
|
+
*/
|
|
8231
|
+
groupMembersAdd: (data: GroupMembersAddRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
8232
|
+
/**
|
|
8233
|
+
* @description Lists the members in a group.
|
|
8234
|
+
*
|
|
8235
|
+
* @tags groups
|
|
8236
|
+
* @name GroupMembersList
|
|
8237
|
+
* @summary List Groups Members
|
|
8238
|
+
* @request GET:/groups.members.list
|
|
8239
|
+
* @secure
|
|
8240
|
+
*/
|
|
8241
|
+
groupMembersList: (query: {
|
|
8242
|
+
/** ID of the group for which to list members. */
|
|
8243
|
+
group: string;
|
|
8244
|
+
/**
|
|
8245
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
8246
|
+
* starts from the beginning.
|
|
8247
|
+
*/
|
|
8248
|
+
cursor?: string;
|
|
8249
|
+
/**
|
|
8250
|
+
* The maximum number of members to return. If not set, then the default
|
|
8251
|
+
* is '50'.
|
|
8252
|
+
* @format int32
|
|
8253
|
+
*/
|
|
8254
|
+
limit?: number;
|
|
8255
|
+
/**
|
|
8256
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
8257
|
+
* used.
|
|
8258
|
+
*/
|
|
8259
|
+
mode?: ListMode;
|
|
8260
|
+
}, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any>>;
|
|
8261
|
+
/**
|
|
8262
|
+
* @description Lists the members in a group.
|
|
8263
|
+
*
|
|
8264
|
+
* @tags groups
|
|
8265
|
+
* @name GroupMembersListPost
|
|
8266
|
+
* @summary List Groups Members (POST)
|
|
8267
|
+
* @request POST:/groups.members.list
|
|
8268
|
+
* @secure
|
|
8269
|
+
*/
|
|
8270
|
+
groupMembersListPost: (data: GroupMembersListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any>>;
|
|
8271
|
+
/**
|
|
8272
|
+
* @description Removes a member from a group.
|
|
8273
|
+
*
|
|
8274
|
+
* @tags groups
|
|
8275
|
+
* @name GroupMembersRemove
|
|
8276
|
+
* @summary Remove Groups Members
|
|
8277
|
+
* @request POST:/groups.members.remove
|
|
8278
|
+
* @secure
|
|
8279
|
+
*/
|
|
8280
|
+
groupMembersRemove: (data: GroupMembersRemoveRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
8281
|
+
/**
|
|
8282
|
+
* @description Updates the requested group.
|
|
8283
|
+
*
|
|
8284
|
+
* @tags groups
|
|
8285
|
+
* @name GroupsUpdate
|
|
8286
|
+
* @summary Update Group
|
|
8287
|
+
* @request POST:/groups.update
|
|
8288
|
+
* @secure
|
|
8289
|
+
*/
|
|
8290
|
+
groupsUpdate: (data: GroupsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsUpdateResponse, any>>;
|
|
6223
8291
|
/**
|
|
6224
8292
|
* @description OAuth2 authorization callback.
|
|
6225
8293
|
*
|
|
6226
|
-
* @tags
|
|
8294
|
+
* @tags keyrings
|
|
6227
8295
|
* @name KeyringsCreateCallback
|
|
6228
8296
|
* @summary Authorize Keyrings
|
|
6229
8297
|
* @request GET:/keyrings.authorize
|
|
@@ -6237,13 +8305,116 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6237
8305
|
/**
|
|
6238
8306
|
* @description OAuth2 authorization callback.
|
|
6239
8307
|
*
|
|
6240
|
-
* @tags
|
|
8308
|
+
* @tags keyrings
|
|
6241
8309
|
* @name KeyringsCreateCallbackPost
|
|
6242
8310
|
* @summary Authorize Keyrings (POST)
|
|
6243
8311
|
* @request POST:/keyrings.authorize
|
|
6244
8312
|
* @secure
|
|
6245
8313
|
*/
|
|
6246
8314
|
keyringsCreateCallbackPost: (data: KeyringsCreateCallbackRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
8315
|
+
/**
|
|
8316
|
+
* @description Creates a link between two objects to indicate a relationship.
|
|
8317
|
+
*
|
|
8318
|
+
* @tags links
|
|
8319
|
+
* @name LinksCreate
|
|
8320
|
+
* @summary Create Link
|
|
8321
|
+
* @request POST:/links.create
|
|
8322
|
+
* @secure
|
|
8323
|
+
*/
|
|
8324
|
+
linksCreate: (data: LinksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<LinksCreateResponse, any>>;
|
|
8325
|
+
/**
|
|
8326
|
+
* @description Deletes a link.
|
|
8327
|
+
*
|
|
8328
|
+
* @tags links
|
|
8329
|
+
* @name LinksDelete
|
|
8330
|
+
* @summary Delete Link
|
|
8331
|
+
* @request POST:/links.delete
|
|
8332
|
+
* @secure
|
|
8333
|
+
*/
|
|
8334
|
+
linksDelete: (data: LinksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
8335
|
+
/**
|
|
8336
|
+
* @description Gets the requested link's information.
|
|
8337
|
+
*
|
|
8338
|
+
* @tags links
|
|
8339
|
+
* @name LinksGet
|
|
8340
|
+
* @summary Get Link
|
|
8341
|
+
* @request GET:/links.get
|
|
8342
|
+
* @secure
|
|
8343
|
+
*/
|
|
8344
|
+
linksGet: (query: {
|
|
8345
|
+
/** The requested link's ID. */
|
|
8346
|
+
id: string;
|
|
8347
|
+
}, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any>>;
|
|
8348
|
+
/**
|
|
8349
|
+
* @description Gets the requested link's information.
|
|
8350
|
+
*
|
|
8351
|
+
* @tags links
|
|
8352
|
+
* @name LinksGetPost
|
|
8353
|
+
* @summary Get Link (POST)
|
|
8354
|
+
* @request POST:/links.get
|
|
8355
|
+
* @secure
|
|
8356
|
+
*/
|
|
8357
|
+
linksGetPost: (data: LinksGetRequest, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any>>;
|
|
8358
|
+
/**
|
|
8359
|
+
* @description Lists the available links.
|
|
8360
|
+
*
|
|
8361
|
+
* @tags links
|
|
8362
|
+
* @name LinksList
|
|
8363
|
+
* @summary List Links
|
|
8364
|
+
* @request GET:/links.list
|
|
8365
|
+
* @secure
|
|
8366
|
+
*/
|
|
8367
|
+
linksList: (query: {
|
|
8368
|
+
/** The ID of the object to list the links for. */
|
|
8369
|
+
object: string;
|
|
8370
|
+
/**
|
|
8371
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
8372
|
+
* starts from the beginning.
|
|
8373
|
+
*/
|
|
8374
|
+
cursor?: string;
|
|
8375
|
+
/**
|
|
8376
|
+
* The direction of the links to list, otherwise if not present, then
|
|
8377
|
+
* links in both directions (source and target) are included.
|
|
8378
|
+
*/
|
|
8379
|
+
direction?: LinksDirection;
|
|
8380
|
+
/**
|
|
8381
|
+
* The maximum number of links to return. If not set, then the default
|
|
8382
|
+
* is '50'.
|
|
8383
|
+
* @format int32
|
|
8384
|
+
*/
|
|
8385
|
+
limit?: number;
|
|
8386
|
+
/**
|
|
8387
|
+
* The link type(s) to filter for, otherwise if not present, all link
|
|
8388
|
+
* types are included.
|
|
8389
|
+
*/
|
|
8390
|
+
link_type?: LinkType[];
|
|
8391
|
+
/**
|
|
8392
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
8393
|
+
* used.
|
|
8394
|
+
*/
|
|
8395
|
+
mode?: ListMode;
|
|
8396
|
+
/**
|
|
8397
|
+
* The object types to filter for, otherwise if not present, all object
|
|
8398
|
+
* types are included.
|
|
8399
|
+
*/
|
|
8400
|
+
object_types?: LinkEndpointType[];
|
|
8401
|
+
/**
|
|
8402
|
+
* The link types to filter for, otherwise if not present, all link
|
|
8403
|
+
* types are included.
|
|
8404
|
+
* @deprecated
|
|
8405
|
+
*/
|
|
8406
|
+
types?: LinkType[];
|
|
8407
|
+
}, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
|
|
8408
|
+
/**
|
|
8409
|
+
* @description Lists the available links.
|
|
8410
|
+
*
|
|
8411
|
+
* @tags links
|
|
8412
|
+
* @name LinksListPost
|
|
8413
|
+
* @summary List Links (POST)
|
|
8414
|
+
* @request POST:/links.list
|
|
8415
|
+
* @secure
|
|
8416
|
+
*/
|
|
8417
|
+
linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
|
|
6247
8418
|
/**
|
|
6248
8419
|
* @description Lists metric definitions matching a filter.
|
|
6249
8420
|
*
|
|
@@ -6547,6 +8718,166 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6547
8718
|
* @secure
|
|
6548
8719
|
*/
|
|
6549
8720
|
revOrgsUpdate: (data: RevOrgsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsUpdateResponse, any>>;
|
|
8721
|
+
/**
|
|
8722
|
+
* @description Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization.
|
|
8723
|
+
*
|
|
8724
|
+
* @tags rev-users
|
|
8725
|
+
* @name RevUsersCreate
|
|
8726
|
+
* @summary Create Rev User
|
|
8727
|
+
* @request POST:/rev-users.create
|
|
8728
|
+
* @secure
|
|
8729
|
+
*/
|
|
8730
|
+
revUsersCreate: (data: RevUsersCreateRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersCreateResponse, any>>;
|
|
8731
|
+
/**
|
|
8732
|
+
* @description Deletes a Rev user.
|
|
8733
|
+
*
|
|
8734
|
+
* @tags rev-users
|
|
8735
|
+
* @name RevUsersDelete
|
|
8736
|
+
* @summary Delete Rev User
|
|
8737
|
+
* @request POST:/rev-users.delete
|
|
8738
|
+
* @secure
|
|
8739
|
+
*/
|
|
8740
|
+
revUsersDelete: (data: RevUsersDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
8741
|
+
/**
|
|
8742
|
+
* @description Returns the Rev user of a Rev organization by its ID.
|
|
8743
|
+
*
|
|
8744
|
+
* @tags rev-users
|
|
8745
|
+
* @name RevUsersGet
|
|
8746
|
+
* @summary Get Rev User
|
|
8747
|
+
* @request GET:/rev-users.get
|
|
8748
|
+
* @secure
|
|
8749
|
+
*/
|
|
8750
|
+
revUsersGet: (query: {
|
|
8751
|
+
/** The ID of Rev user to be retrieved. */
|
|
8752
|
+
id: string;
|
|
8753
|
+
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any>>;
|
|
8754
|
+
/**
|
|
8755
|
+
* @description Returns the Rev user of a Rev organization by its ID.
|
|
8756
|
+
*
|
|
8757
|
+
* @tags rev-users
|
|
8758
|
+
* @name RevUsersGetPost
|
|
8759
|
+
* @summary Get Rev User (POST)
|
|
8760
|
+
* @request POST:/rev-users.get
|
|
8761
|
+
* @secure
|
|
8762
|
+
*/
|
|
8763
|
+
revUsersGetPost: (data: RevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any>>;
|
|
8764
|
+
/**
|
|
8765
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization.
|
|
8766
|
+
*
|
|
8767
|
+
* @tags rev-users
|
|
8768
|
+
* @name RevUsersList
|
|
8769
|
+
* @summary List Rev Users
|
|
8770
|
+
* @request GET:/rev-users.list
|
|
8771
|
+
* @secure
|
|
8772
|
+
*/
|
|
8773
|
+
revUsersList: (query?: {
|
|
8774
|
+
/**
|
|
8775
|
+
* Filters for Rev users with specified associations
|
|
8776
|
+
* (account/workspace).
|
|
8777
|
+
*/
|
|
8778
|
+
associations?: string[];
|
|
8779
|
+
/** Filters for Rev users that were created by the specified user(s). */
|
|
8780
|
+
created_by?: string[];
|
|
8781
|
+
/**
|
|
8782
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
8783
|
+
* @format date-time
|
|
8784
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8785
|
+
*/
|
|
8786
|
+
'created_date.after'?: string;
|
|
8787
|
+
/**
|
|
8788
|
+
* Filters for objects created before the provided timestamp
|
|
8789
|
+
* (inclusive).
|
|
8790
|
+
* @format date-time
|
|
8791
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8792
|
+
*/
|
|
8793
|
+
'created_date.before'?: string;
|
|
8794
|
+
/**
|
|
8795
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
8796
|
+
* starts from the beginning.
|
|
8797
|
+
*/
|
|
8798
|
+
cursor?: string;
|
|
8799
|
+
/** List of emails of Rev users to be filtered. */
|
|
8800
|
+
email?: string[];
|
|
8801
|
+
/** List of external refs to filter Rev users for. */
|
|
8802
|
+
external_ref?: string[];
|
|
8803
|
+
/** Value of is_verified field to filter the Rev users. */
|
|
8804
|
+
is_verified?: boolean;
|
|
8805
|
+
/**
|
|
8806
|
+
* The maximum number of Rev users to return. The default is '50'.
|
|
8807
|
+
* @format int32
|
|
8808
|
+
*/
|
|
8809
|
+
limit?: number;
|
|
8810
|
+
/**
|
|
8811
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
8812
|
+
* used.
|
|
8813
|
+
*/
|
|
8814
|
+
mode?: ListMode;
|
|
8815
|
+
/**
|
|
8816
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
8817
|
+
* @format date-time
|
|
8818
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8819
|
+
*/
|
|
8820
|
+
'modified_date.after'?: string;
|
|
8821
|
+
/**
|
|
8822
|
+
* Filters for objects created before the provided timestamp
|
|
8823
|
+
* (inclusive).
|
|
8824
|
+
* @format date-time
|
|
8825
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8826
|
+
*/
|
|
8827
|
+
'modified_date.before'?: string;
|
|
8828
|
+
/** List of phone numbers, in E.164 format, to filter Rev users on. */
|
|
8829
|
+
phone_numbers?: string[];
|
|
8830
|
+
/**
|
|
8831
|
+
* List of IDs of Rev organizations to be filtered.
|
|
8832
|
+
* @example ["REV-AbCdEfGh"]
|
|
8833
|
+
*/
|
|
8834
|
+
rev_org?: string[];
|
|
8835
|
+
/** Fields to sort the Rev users by and the direction to sort them. */
|
|
8836
|
+
sort_by?: string[];
|
|
8837
|
+
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
|
|
8838
|
+
/**
|
|
8839
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization.
|
|
8840
|
+
*
|
|
8841
|
+
* @tags rev-users
|
|
8842
|
+
* @name RevUsersListPost
|
|
8843
|
+
* @summary List Rev Users (POST)
|
|
8844
|
+
* @request POST:/rev-users.list
|
|
8845
|
+
* @secure
|
|
8846
|
+
*/
|
|
8847
|
+
revUsersListPost: (data: RevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
|
|
8848
|
+
/**
|
|
8849
|
+
* @description Updates a Rev user.
|
|
8850
|
+
*
|
|
8851
|
+
* @tags rev-users
|
|
8852
|
+
* @name RevUsersUpdate
|
|
8853
|
+
* @summary Update Rev User
|
|
8854
|
+
* @request POST:/rev-users.update
|
|
8855
|
+
* @secure
|
|
8856
|
+
*/
|
|
8857
|
+
revUsersUpdate: (data: RevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersUpdateResponse, any>>;
|
|
8858
|
+
/**
|
|
8859
|
+
* @description Gets a service account.
|
|
8860
|
+
*
|
|
8861
|
+
* @tags service-accounts
|
|
8862
|
+
* @name ServiceAccountsGet
|
|
8863
|
+
* @summary Get Service Account
|
|
8864
|
+
* @request GET:/service-accounts.get
|
|
8865
|
+
* @secure
|
|
8866
|
+
*/
|
|
8867
|
+
serviceAccountsGet: (query: {
|
|
8868
|
+
/** The ID of the requested service account. */
|
|
8869
|
+
id: string;
|
|
8870
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any>>;
|
|
8871
|
+
/**
|
|
8872
|
+
* @description Gets a service account.
|
|
8873
|
+
*
|
|
8874
|
+
* @tags service-accounts
|
|
8875
|
+
* @name ServiceAccountsGetPost
|
|
8876
|
+
* @summary Get Service Account (POST)
|
|
8877
|
+
* @request POST:/service-accounts.get
|
|
8878
|
+
* @secure
|
|
8879
|
+
*/
|
|
8880
|
+
serviceAccountsGetPost: (data: ServiceAccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any>>;
|
|
6550
8881
|
/**
|
|
6551
8882
|
* @description Gets an SLA tracker.
|
|
6552
8883
|
*
|
|
@@ -6750,6 +9081,55 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6750
9081
|
* @secure
|
|
6751
9082
|
*/
|
|
6752
9083
|
slasUpdate: (data: SlasUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SlasUpdateResponse, any>>;
|
|
9084
|
+
/**
|
|
9085
|
+
* @description Lists system users within your organization.
|
|
9086
|
+
*
|
|
9087
|
+
* @tags sys-users
|
|
9088
|
+
* @name SysUsersList
|
|
9089
|
+
* @summary List Sys Users
|
|
9090
|
+
* @request GET:/sys-users.list
|
|
9091
|
+
* @secure
|
|
9092
|
+
*/
|
|
9093
|
+
sysUsersList: (query?: {
|
|
9094
|
+
/**
|
|
9095
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
9096
|
+
* starts from the beginning.
|
|
9097
|
+
*/
|
|
9098
|
+
cursor?: string;
|
|
9099
|
+
/**
|
|
9100
|
+
* The maximum number of system users to return. Value can range from
|
|
9101
|
+
* '1' to '100', with a default of '50'.
|
|
9102
|
+
* @format int32
|
|
9103
|
+
*/
|
|
9104
|
+
limit?: number;
|
|
9105
|
+
/**
|
|
9106
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
9107
|
+
* used.
|
|
9108
|
+
*/
|
|
9109
|
+
mode?: ListMode;
|
|
9110
|
+
/** Fields to sort the system users by and the direction to sort them. */
|
|
9111
|
+
sort_by?: string[];
|
|
9112
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any>>;
|
|
9113
|
+
/**
|
|
9114
|
+
* @description Lists system users within your organization.
|
|
9115
|
+
*
|
|
9116
|
+
* @tags sys-users
|
|
9117
|
+
* @name SysUsersListPost
|
|
9118
|
+
* @summary List Sys Users (POST)
|
|
9119
|
+
* @request POST:/sys-users.list
|
|
9120
|
+
* @secure
|
|
9121
|
+
*/
|
|
9122
|
+
sysUsersListPost: (data: SysUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any>>;
|
|
9123
|
+
/**
|
|
9124
|
+
* @description Updates the system user.
|
|
9125
|
+
*
|
|
9126
|
+
* @tags sys-users
|
|
9127
|
+
* @name SysUsersUpdate
|
|
9128
|
+
* @summary Update Sys User
|
|
9129
|
+
* @request POST:/sys-users.update
|
|
9130
|
+
* @secure
|
|
9131
|
+
*/
|
|
9132
|
+
sysUsersUpdate: (data: SysUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersUpdateResponse, any>>;
|
|
6753
9133
|
/**
|
|
6754
9134
|
* @description Creates a new tag, which is used to create associations between objects and a logical concept denoted by the tag's name.
|
|
6755
9135
|
*
|
|
@@ -7137,6 +9517,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7137
9517
|
'ticket.channels'?: TicketChannels[];
|
|
7138
9518
|
/** Filters for tickets belonging to specific groups. */
|
|
7139
9519
|
'ticket.group'?: string[];
|
|
9520
|
+
/** Filters for frozen tickets. */
|
|
9521
|
+
'ticket.is_frozen'?: boolean;
|
|
7140
9522
|
/** Filters for tickets that are spam. */
|
|
7141
9523
|
'ticket.is_spam'?: boolean;
|
|
7142
9524
|
/** Filters for tickets that need response. */
|
|
@@ -7282,6 +9664,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7282
9664
|
'ticket.channels'?: TicketChannels[];
|
|
7283
9665
|
/** Filters for tickets belonging to specific groups. */
|
|
7284
9666
|
'ticket.group'?: string[];
|
|
9667
|
+
/** Filters for frozen tickets. */
|
|
9668
|
+
'ticket.is_frozen'?: boolean;
|
|
7285
9669
|
/** Filters for tickets that are spam. */
|
|
7286
9670
|
'ticket.is_spam'?: boolean;
|
|
7287
9671
|
/** Filters for tickets that need response. */
|