@devrev/typescript-sdk 1.1.51 → 1.1.53
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 +346 -89
- package/dist/auto-generated/beta/beta-devrev-sdk.js +109 -51
- package/dist/auto-generated/public-devrev-sdk.d.ts +2504 -126
- package/dist/auto-generated/public-devrev-sdk.js +546 -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,334 @@ 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 frozen. */
|
|
1630
|
+
is_frozen?: boolean;
|
|
1631
|
+
/** Filters for conversations that are spam. */
|
|
1632
|
+
is_spam?: boolean;
|
|
1633
|
+
/**
|
|
1634
|
+
* The maximum number of conversations to return. The default is '50'.
|
|
1635
|
+
* @format int32
|
|
1636
|
+
*/
|
|
1637
|
+
limit?: number;
|
|
1638
|
+
/**
|
|
1639
|
+
* Filters for conversations where these users are participants.
|
|
1640
|
+
* @example ["DEVU-12345"]
|
|
1641
|
+
*/
|
|
1642
|
+
members?: string[];
|
|
1643
|
+
/**
|
|
1644
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1645
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1646
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1647
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1648
|
+
* always be returned in the specified sort-by order.
|
|
1649
|
+
*/
|
|
1650
|
+
mode?: ListMode;
|
|
1651
|
+
modified_date?: DateTimeFilter;
|
|
1652
|
+
/**
|
|
1653
|
+
* Filters for conversations owned by any of these users.
|
|
1654
|
+
* @example ["DEVU-12345"]
|
|
1655
|
+
*/
|
|
1656
|
+
owned_by?: string[];
|
|
1657
|
+
/**
|
|
1658
|
+
* Filters for conversations that are associated with any of the
|
|
1659
|
+
* provided Rev organizations.
|
|
1660
|
+
* @deprecated
|
|
1661
|
+
* @example ["REV-AbCdEfGh"]
|
|
1662
|
+
*/
|
|
1663
|
+
rev_org?: string[];
|
|
1664
|
+
/**
|
|
1665
|
+
* Filters for conversations that are associated with any of the
|
|
1666
|
+
* provided Rev organizations.
|
|
1667
|
+
* @example ["REV-AbCdEfGh"]
|
|
1668
|
+
*/
|
|
1669
|
+
rev_orgs?: string[];
|
|
1670
|
+
/** The filter for SLA summary. */
|
|
1671
|
+
sla_summary?: SlaSummaryFilter;
|
|
1672
|
+
/** Filters for conversations with any of the provided source channels. */
|
|
1673
|
+
source_channel?: string[];
|
|
1674
|
+
/**
|
|
1675
|
+
* Filters for conversations with any of the provided source channels.
|
|
1676
|
+
* @deprecated
|
|
1677
|
+
*/
|
|
1678
|
+
source_channels?: string[];
|
|
1679
|
+
/** The filter for stages. */
|
|
1680
|
+
stage?: StageFilter;
|
|
1681
|
+
/**
|
|
1682
|
+
* Filters for conversations with any of the provided tags.
|
|
1683
|
+
* @deprecated
|
|
1684
|
+
* @example ["TAG-12345"]
|
|
1685
|
+
*/
|
|
1686
|
+
tags?: string[];
|
|
1687
|
+
/** Filters for conversations with any of the provided tags with value. */
|
|
1688
|
+
tags_v2?: TagWithValueFilter[];
|
|
1689
|
+
}
|
|
1690
|
+
/**
|
|
1691
|
+
* conversations-list-response
|
|
1692
|
+
* The response to listing the conversations.
|
|
1693
|
+
*/
|
|
1694
|
+
export interface ConversationsListResponse {
|
|
1695
|
+
/** The list of conversations. */
|
|
1696
|
+
conversations: Conversation[];
|
|
1697
|
+
/**
|
|
1698
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
1699
|
+
* sort order. If not set, then no later elements exist.
|
|
1700
|
+
*/
|
|
1701
|
+
next_cursor?: string;
|
|
1702
|
+
/**
|
|
1703
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
1704
|
+
* sort order. If not set, then no prior elements exist.
|
|
1705
|
+
*/
|
|
1706
|
+
prev_cursor?: string;
|
|
1707
|
+
}
|
|
1708
|
+
/**
|
|
1709
|
+
* conversations-update-request
|
|
1710
|
+
* The request to update a conversation.
|
|
1711
|
+
*/
|
|
1712
|
+
export interface ConversationsUpdateRequest {
|
|
1713
|
+
applies_to_parts?: ConversationsUpdateRequestAppliesToParts;
|
|
1714
|
+
/** Application-defined custom fields. */
|
|
1715
|
+
custom_fields?: object;
|
|
1716
|
+
/**
|
|
1717
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
1718
|
+
* custom field must be specified, otherwise a bad request error is
|
|
1719
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
1720
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
1721
|
+
* specifier, it remains unmodified.
|
|
1722
|
+
*/
|
|
1723
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
1724
|
+
/** The updated description for the conversation. */
|
|
1725
|
+
description?: string;
|
|
1726
|
+
/** The group that the conversation is associated with. */
|
|
1727
|
+
group?: string;
|
|
1728
|
+
/** The ID of the conversation to update. */
|
|
1729
|
+
id: string;
|
|
1730
|
+
/** Whether the conversation is frozen. */
|
|
1731
|
+
is_frozen?: boolean;
|
|
1732
|
+
/** Whether the conversation is spam. */
|
|
1733
|
+
is_spam?: boolean;
|
|
1734
|
+
members?: ConversationsUpdateRequestMembers;
|
|
1735
|
+
metadata?: ConversationsUpdateRequestMetadata;
|
|
1736
|
+
owned_by?: ConversationsUpdateRequestOwnedBy;
|
|
1737
|
+
/** Updates an object's stage. */
|
|
1738
|
+
stage?: StageUpdate;
|
|
1739
|
+
/** The updated status of the conversation. */
|
|
1740
|
+
status?: string;
|
|
1741
|
+
tags?: ConversationsUpdateRequestTags;
|
|
1742
|
+
/** The updated title of the conversation. */
|
|
1743
|
+
title?: string;
|
|
1744
|
+
user_sessions?: ConversationsUpdateRequestUserSessions;
|
|
1745
|
+
}
|
|
1746
|
+
/** conversations-update-request-applies-to-parts */
|
|
1747
|
+
export interface ConversationsUpdateRequestAppliesToParts {
|
|
1748
|
+
/**
|
|
1749
|
+
* Updates the parts that the conversation applies to.
|
|
1750
|
+
* @example ["PROD-12345"]
|
|
1751
|
+
*/
|
|
1752
|
+
set?: string[];
|
|
1753
|
+
}
|
|
1754
|
+
/** conversations-update-request-members */
|
|
1755
|
+
export interface ConversationsUpdateRequestMembers {
|
|
1756
|
+
/**
|
|
1757
|
+
* Sets the member IDs to the provided user IDs.
|
|
1758
|
+
* @example ["DEVU-12345"]
|
|
1759
|
+
*/
|
|
1760
|
+
set?: string[];
|
|
1761
|
+
}
|
|
1762
|
+
/** conversations-update-request-metadata */
|
|
1763
|
+
export interface ConversationsUpdateRequestMetadata {
|
|
1764
|
+
url_context?: string;
|
|
1765
|
+
}
|
|
1766
|
+
/** conversations-update-request-owned-by */
|
|
1767
|
+
export interface ConversationsUpdateRequestOwnedBy {
|
|
1768
|
+
/**
|
|
1769
|
+
* Sets the owner IDs to the provided user IDs. This must not be
|
|
1770
|
+
* empty.
|
|
1771
|
+
* @minItems 1
|
|
1772
|
+
* @example ["DEVU-12345"]
|
|
1773
|
+
*/
|
|
1774
|
+
set?: string[];
|
|
1775
|
+
}
|
|
1776
|
+
/** conversations-update-request-tags */
|
|
1777
|
+
export interface ConversationsUpdateRequestTags {
|
|
1778
|
+
/** Adds the provided tags on the conversation. */
|
|
1779
|
+
add?: AddTagWithValue[];
|
|
1780
|
+
/** Removes the provided tags on the conversation. */
|
|
1781
|
+
remove?: RemoveTagWithValue[];
|
|
1782
|
+
/** Sets the tag IDs to the provided tags. */
|
|
1783
|
+
set?: SetTagWithValue[];
|
|
1784
|
+
}
|
|
1785
|
+
/** conversations-update-request-user-sessions */
|
|
1786
|
+
export interface ConversationsUpdateRequestUserSessions {
|
|
1787
|
+
/** The updated user sessions that the conversation is associated with. */
|
|
1788
|
+
set?: string[];
|
|
1789
|
+
}
|
|
1790
|
+
/**
|
|
1791
|
+
* conversations-update-response
|
|
1792
|
+
* The response for updating a conversation.
|
|
1793
|
+
*/
|
|
1794
|
+
export interface ConversationsUpdateResponse {
|
|
1795
|
+
conversation: Conversation;
|
|
1796
|
+
}
|
|
1797
|
+
/**
|
|
1798
|
+
* custom-schema-spec
|
|
1799
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
1800
|
+
* custom field must be specified, otherwise a bad request error is
|
|
1801
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
1802
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
1803
|
+
* specifier, it remains unmodified.
|
|
1804
|
+
*/
|
|
1805
|
+
export interface CustomSchemaSpec {
|
|
1806
|
+
/** List of apps that are requested. */
|
|
1807
|
+
apps?: string[];
|
|
1808
|
+
/** Name of the subtype requested. */
|
|
1809
|
+
subtype?: string;
|
|
1810
|
+
/** Whether the tenant schema is requested. */
|
|
1811
|
+
tenant_fragment?: boolean;
|
|
1812
|
+
/** Whether to enforce required fields validation. */
|
|
1813
|
+
validate_required_fields?: boolean;
|
|
1814
|
+
}
|
|
1815
|
+
/**
|
|
1816
|
+
* date-filter
|
|
1817
|
+
* Provides ways to specify date ranges on objects.
|
|
1818
|
+
*/
|
|
1819
|
+
export type DateFilter = (DateTimeFilter | DateTimePreset) & {
|
|
1820
|
+
/** Type of date filter. */
|
|
1821
|
+
type: DateFilterType;
|
|
1822
|
+
};
|
|
1823
|
+
/** Type of date filter. */
|
|
1824
|
+
export declare enum DateFilterType {
|
|
1825
|
+
Preset = "preset",
|
|
1826
|
+
Range = "range"
|
|
1827
|
+
}
|
|
1828
|
+
/** date-time-filter */
|
|
1829
|
+
export interface DateTimeFilter {
|
|
1830
|
+
/**
|
|
1831
|
+
* Filters for objects created after the provided timestamp
|
|
1832
|
+
* (inclusive).
|
|
1833
|
+
* @format date-time
|
|
1834
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1835
|
+
*/
|
|
1836
|
+
after?: string;
|
|
1837
|
+
/**
|
|
1838
|
+
* Filters for objects created before the provided timestamp
|
|
1839
|
+
* (inclusive).
|
|
1840
|
+
* @format date-time
|
|
1841
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
1842
|
+
*/
|
|
1843
|
+
before?: string;
|
|
1070
1844
|
}
|
|
1071
1845
|
/**
|
|
1072
1846
|
* date-time-preset
|
|
@@ -1407,6 +2181,21 @@ export interface DevUserExternalIdentityFilter {
|
|
|
1407
2181
|
/** Issuer of the external identity of the user. */
|
|
1408
2182
|
issuer?: string;
|
|
1409
2183
|
}
|
|
2184
|
+
/** Job title of the Dev User. */
|
|
2185
|
+
export declare enum DevUserJobTitle {
|
|
2186
|
+
CustomerSuccessManager = "customer_success_manager",
|
|
2187
|
+
Cxo = "cxo",
|
|
2188
|
+
Designer = "designer",
|
|
2189
|
+
Developer = "developer",
|
|
2190
|
+
HeadOfSupport = "head_of_support",
|
|
2191
|
+
Operations = "operations",
|
|
2192
|
+
Others = "others",
|
|
2193
|
+
ProductManager = "product_manager",
|
|
2194
|
+
Qa = "qa",
|
|
2195
|
+
RevenueLeader = "revenue_leader",
|
|
2196
|
+
Support = "support",
|
|
2197
|
+
TechLead = "tech_lead"
|
|
2198
|
+
}
|
|
1410
2199
|
/** dev-user-summary */
|
|
1411
2200
|
export type DevUserSummary = UserBaseSummary;
|
|
1412
2201
|
/**
|
|
@@ -1490,6 +2279,110 @@ export type DevUsersSelfRequest = object;
|
|
|
1490
2279
|
export interface DevUsersSelfResponse {
|
|
1491
2280
|
dev_user: DevUser;
|
|
1492
2281
|
}
|
|
2282
|
+
/**
|
|
2283
|
+
* dev-users-self-update-request
|
|
2284
|
+
* A request to update the user's information for the authenticated Dev
|
|
2285
|
+
* user.
|
|
2286
|
+
*/
|
|
2287
|
+
export interface DevUsersSelfUpdateRequest {
|
|
2288
|
+
/** Application-defined custom fields. */
|
|
2289
|
+
custom_fields?: object;
|
|
2290
|
+
/**
|
|
2291
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
2292
|
+
* custom field must be specified, otherwise a bad request error is
|
|
2293
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
2294
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
2295
|
+
* specifier, it remains unmodified.
|
|
2296
|
+
*/
|
|
2297
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
2298
|
+
/** The updated display name of the Dev user. */
|
|
2299
|
+
display_name?: string;
|
|
2300
|
+
/**
|
|
2301
|
+
* Start date of Dev user's experience.
|
|
2302
|
+
* @format date-time
|
|
2303
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2304
|
+
*/
|
|
2305
|
+
experience_start_date?: string;
|
|
2306
|
+
/** The updated full name of the Dev user. */
|
|
2307
|
+
full_name?: string;
|
|
2308
|
+
/** Job history of the Dev user. */
|
|
2309
|
+
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
2310
|
+
/** Job title of the Dev User. */
|
|
2311
|
+
job_title?: DevUserJobTitle;
|
|
2312
|
+
}
|
|
2313
|
+
/** dev-users-update-job-history-item */
|
|
2314
|
+
export interface DevUsersUpdateJobHistoryItem {
|
|
2315
|
+
/**
|
|
2316
|
+
* Enum for the employment status of the user.
|
|
2317
|
+
* @format int64
|
|
2318
|
+
*/
|
|
2319
|
+
employment_status?: number;
|
|
2320
|
+
/**
|
|
2321
|
+
* End date of the job.
|
|
2322
|
+
* @format date-time
|
|
2323
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2324
|
+
*/
|
|
2325
|
+
end_date?: string;
|
|
2326
|
+
/** Is this the current active job for the user. */
|
|
2327
|
+
is_current?: boolean;
|
|
2328
|
+
/** The job location for the user. */
|
|
2329
|
+
location?: string;
|
|
2330
|
+
/**
|
|
2331
|
+
* Start date of the job.
|
|
2332
|
+
* @format date-time
|
|
2333
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2334
|
+
*/
|
|
2335
|
+
start_date?: string;
|
|
2336
|
+
/** The job title for the user. */
|
|
2337
|
+
title?: string;
|
|
2338
|
+
}
|
|
2339
|
+
/**
|
|
2340
|
+
* dev-users-update-request
|
|
2341
|
+
* A request to update the user's information corresponding to the
|
|
2342
|
+
* provided Dev user.
|
|
2343
|
+
*/
|
|
2344
|
+
export interface DevUsersUpdateRequest {
|
|
2345
|
+
/** Application-defined custom fields. */
|
|
2346
|
+
custom_fields?: object;
|
|
2347
|
+
/**
|
|
2348
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
2349
|
+
* custom field must be specified, otherwise a bad request error is
|
|
2350
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
2351
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
2352
|
+
* specifier, it remains unmodified.
|
|
2353
|
+
*/
|
|
2354
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
2355
|
+
/** The updated display name of the Dev user. */
|
|
2356
|
+
display_name?: string;
|
|
2357
|
+
/**
|
|
2358
|
+
* Start date of Dev user's experience.
|
|
2359
|
+
* @format date-time
|
|
2360
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2361
|
+
*/
|
|
2362
|
+
experience_start_date?: string;
|
|
2363
|
+
/** The updated full name of the Dev user. */
|
|
2364
|
+
full_name?: string;
|
|
2365
|
+
/** The ID for the Dev user to be updated. */
|
|
2366
|
+
id: string;
|
|
2367
|
+
/** Job history of the Dev user. */
|
|
2368
|
+
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
2369
|
+
/** Job title of the Dev User. */
|
|
2370
|
+
job_title?: DevUserJobTitle;
|
|
2371
|
+
}
|
|
2372
|
+
/**
|
|
2373
|
+
* dev-users-update-response
|
|
2374
|
+
* The response to update a Dev user.
|
|
2375
|
+
*/
|
|
2376
|
+
export interface DevUsersUpdateResponse {
|
|
2377
|
+
dev_user: DevUser;
|
|
2378
|
+
}
|
|
2379
|
+
/** directory-summary */
|
|
2380
|
+
export type DirectorySummary = AtomBaseSummary;
|
|
2381
|
+
/**
|
|
2382
|
+
* dynamic-group-info
|
|
2383
|
+
* Information to define dynamic groups.
|
|
2384
|
+
*/
|
|
2385
|
+
export type DynamicGroupInfo = object;
|
|
1493
2386
|
/** empty */
|
|
1494
2387
|
export type Empty = object;
|
|
1495
2388
|
/** enhancement */
|
|
@@ -2173,24 +3066,240 @@ export type Feature = PartBase;
|
|
|
2173
3066
|
export type FeatureSummary = PartBaseSummary;
|
|
2174
3067
|
/** group */
|
|
2175
3068
|
export type Group = AtomBase;
|
|
2176
|
-
/** group
|
|
2177
|
-
export
|
|
3069
|
+
/** Creation source of the group. */
|
|
3070
|
+
export declare enum GroupIngestionSource {
|
|
3071
|
+
Airdrop = "airdrop",
|
|
3072
|
+
Scim = "scim"
|
|
3073
|
+
}
|
|
3074
|
+
/** Type of the members in the group. */
|
|
3075
|
+
export declare enum GroupMemberType {
|
|
3076
|
+
DevUser = "dev_user",
|
|
3077
|
+
RevUser = "rev_user"
|
|
3078
|
+
}
|
|
2178
3079
|
/**
|
|
2179
|
-
*
|
|
2180
|
-
*
|
|
3080
|
+
* group-members-add-request
|
|
3081
|
+
* A request to add a new member to a group.
|
|
2181
3082
|
*/
|
|
2182
|
-
export interface
|
|
2183
|
-
/**
|
|
2184
|
-
|
|
2185
|
-
/**
|
|
2186
|
-
|
|
3083
|
+
export interface GroupMembersAddRequest {
|
|
3084
|
+
/** ID of the group where the member is being added. */
|
|
3085
|
+
group: string;
|
|
3086
|
+
/**
|
|
3087
|
+
* ID of the member to be added.
|
|
3088
|
+
* @example "DEVU-12345"
|
|
3089
|
+
*/
|
|
3090
|
+
member: string;
|
|
2187
3091
|
}
|
|
2188
|
-
/**
|
|
2189
|
-
export type
|
|
3092
|
+
/** group-members-add-response */
|
|
3093
|
+
export type GroupMembersAddResponse = object;
|
|
3094
|
+
/**
|
|
3095
|
+
* group-members-list-request
|
|
3096
|
+
* A request to list group members.
|
|
3097
|
+
*/
|
|
3098
|
+
export interface GroupMembersListRequest {
|
|
2190
3099
|
/**
|
|
2191
|
-
*
|
|
2192
|
-
*
|
|
2193
|
-
|
|
3100
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3101
|
+
* iteration starts from the beginning.
|
|
3102
|
+
*/
|
|
3103
|
+
cursor?: string;
|
|
3104
|
+
/** ID of the group for which to list members. */
|
|
3105
|
+
group: string;
|
|
3106
|
+
/**
|
|
3107
|
+
* The maximum number of members to return. If not set, then the
|
|
3108
|
+
* default is '50'.
|
|
3109
|
+
* @format int32
|
|
3110
|
+
*/
|
|
3111
|
+
limit?: number;
|
|
3112
|
+
/**
|
|
3113
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3114
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3115
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3116
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3117
|
+
* always be returned in the specified sort-by order.
|
|
3118
|
+
*/
|
|
3119
|
+
mode?: ListMode;
|
|
3120
|
+
}
|
|
3121
|
+
/**
|
|
3122
|
+
* group-members-list-response
|
|
3123
|
+
* List of group members.
|
|
3124
|
+
*/
|
|
3125
|
+
export interface GroupMembersListResponse {
|
|
3126
|
+
/** List of members. */
|
|
3127
|
+
members: GroupMembersListResponseMember[];
|
|
3128
|
+
/**
|
|
3129
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
3130
|
+
* sort order. If not set, then no later elements exist.
|
|
3131
|
+
*/
|
|
3132
|
+
next_cursor?: string;
|
|
3133
|
+
/**
|
|
3134
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
3135
|
+
* sort order. If not set, then no prior elements exist.
|
|
3136
|
+
*/
|
|
3137
|
+
prev_cursor?: string;
|
|
3138
|
+
}
|
|
3139
|
+
/**
|
|
3140
|
+
* group-members-list-response-member
|
|
3141
|
+
* A group member.
|
|
3142
|
+
*/
|
|
3143
|
+
export interface GroupMembersListResponseMember {
|
|
3144
|
+
member: MemberSummary;
|
|
3145
|
+
}
|
|
3146
|
+
/**
|
|
3147
|
+
* group-members-remove-request
|
|
3148
|
+
* A request to remove a group member.
|
|
3149
|
+
*/
|
|
3150
|
+
export interface GroupMembersRemoveRequest {
|
|
3151
|
+
/** ID of the group where the member is being removed. */
|
|
3152
|
+
group: string;
|
|
3153
|
+
/**
|
|
3154
|
+
* ID of the member to be removed.
|
|
3155
|
+
* @example "DEVU-12345"
|
|
3156
|
+
*/
|
|
3157
|
+
member: string;
|
|
3158
|
+
}
|
|
3159
|
+
/** group-members-remove-response */
|
|
3160
|
+
export type GroupMembersRemoveResponse = object;
|
|
3161
|
+
/** group-summary */
|
|
3162
|
+
export type GroupSummary = AtomBaseSummary;
|
|
3163
|
+
/** Type of the group. */
|
|
3164
|
+
export declare enum GroupType {
|
|
3165
|
+
Dynamic = "dynamic",
|
|
3166
|
+
Static = "static"
|
|
3167
|
+
}
|
|
3168
|
+
/**
|
|
3169
|
+
* groups-create-request
|
|
3170
|
+
* A request to create a new group.
|
|
3171
|
+
*/
|
|
3172
|
+
export interface GroupsCreateRequest {
|
|
3173
|
+
/** Type of the group. */
|
|
3174
|
+
type?: GroupType;
|
|
3175
|
+
/** Description of the group. */
|
|
3176
|
+
description: string;
|
|
3177
|
+
/** Information to define dynamic groups. */
|
|
3178
|
+
dynamic_group_info?: DynamicGroupInfo;
|
|
3179
|
+
/** Type of the members in the group. */
|
|
3180
|
+
member_type?: GroupMemberType;
|
|
3181
|
+
/** Unique name of the group. */
|
|
3182
|
+
name: string;
|
|
3183
|
+
/** Owner of the group. */
|
|
3184
|
+
owner?: string;
|
|
3185
|
+
}
|
|
3186
|
+
/**
|
|
3187
|
+
* groups-create-response
|
|
3188
|
+
* The response to group creation.
|
|
3189
|
+
*/
|
|
3190
|
+
export interface GroupsCreateResponse {
|
|
3191
|
+
group: Group;
|
|
3192
|
+
}
|
|
3193
|
+
/**
|
|
3194
|
+
* groups-get-request
|
|
3195
|
+
* A request to get information about a group.
|
|
3196
|
+
*/
|
|
3197
|
+
export interface GroupsGetRequest {
|
|
3198
|
+
/** The ID of the group to get. */
|
|
3199
|
+
id: string;
|
|
3200
|
+
}
|
|
3201
|
+
/**
|
|
3202
|
+
* groups-get-response
|
|
3203
|
+
* The response to getting the group.
|
|
3204
|
+
*/
|
|
3205
|
+
export interface GroupsGetResponse {
|
|
3206
|
+
group: Group;
|
|
3207
|
+
}
|
|
3208
|
+
/**
|
|
3209
|
+
* groups-list-request
|
|
3210
|
+
* A request to get information about a list of groups.
|
|
3211
|
+
*/
|
|
3212
|
+
export interface GroupsListRequest {
|
|
3213
|
+
/**
|
|
3214
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3215
|
+
* iteration starts from the beginning.
|
|
3216
|
+
*/
|
|
3217
|
+
cursor?: string;
|
|
3218
|
+
/** Filters the groups based on the group type. */
|
|
3219
|
+
group_type?: GroupType[];
|
|
3220
|
+
/** Filter groups by ingestion source(s). */
|
|
3221
|
+
ingestion_source?: GroupIngestionSource[];
|
|
3222
|
+
/** Whether to fetch default or custom groups. */
|
|
3223
|
+
is_default?: boolean;
|
|
3224
|
+
/**
|
|
3225
|
+
* The maximum number of groups to return. The default is '50'.
|
|
3226
|
+
* @format int32
|
|
3227
|
+
*/
|
|
3228
|
+
limit?: number;
|
|
3229
|
+
/** Filters the groups on basis of member type. */
|
|
3230
|
+
member_type?: GroupMemberType[];
|
|
3231
|
+
/**
|
|
3232
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3233
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3234
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3235
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3236
|
+
* always be returned in the specified sort-by order.
|
|
3237
|
+
*/
|
|
3238
|
+
mode?: ListMode;
|
|
3239
|
+
/** Comma-separated fields to sort the groups by. */
|
|
3240
|
+
sort_by?: string[];
|
|
3241
|
+
}
|
|
3242
|
+
/**
|
|
3243
|
+
* groups-list-response
|
|
3244
|
+
* The response to listing the groups.
|
|
3245
|
+
*/
|
|
3246
|
+
export interface GroupsListResponse {
|
|
3247
|
+
/** The list of groups. */
|
|
3248
|
+
groups: Group[];
|
|
3249
|
+
/**
|
|
3250
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
3251
|
+
* sort order. If not set, then no later elements exist.
|
|
3252
|
+
*/
|
|
3253
|
+
next_cursor?: string;
|
|
3254
|
+
/**
|
|
3255
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
3256
|
+
* sort order. If not set, then no prior elements exist.
|
|
3257
|
+
*/
|
|
3258
|
+
prev_cursor?: string;
|
|
3259
|
+
}
|
|
3260
|
+
/**
|
|
3261
|
+
* groups-update-request
|
|
3262
|
+
* A request to update a group.
|
|
3263
|
+
*/
|
|
3264
|
+
export interface GroupsUpdateRequest {
|
|
3265
|
+
/** The updated group's description. */
|
|
3266
|
+
description?: string;
|
|
3267
|
+
dynamic_group_info?: GroupsUpdateRequestDynamicGroupInfo;
|
|
3268
|
+
/** The ID of the group to update. */
|
|
3269
|
+
id: string;
|
|
3270
|
+
/** The updated group's name. */
|
|
3271
|
+
name?: string;
|
|
3272
|
+
/** The updated group's owner. */
|
|
3273
|
+
owner?: string;
|
|
3274
|
+
}
|
|
3275
|
+
/** groups-update-request-dynamic-group-info */
|
|
3276
|
+
export interface GroupsUpdateRequestDynamicGroupInfo {
|
|
3277
|
+
/** Boolean expression. */
|
|
3278
|
+
membership_expression: BooleanExpression;
|
|
3279
|
+
}
|
|
3280
|
+
/**
|
|
3281
|
+
* groups-update-response
|
|
3282
|
+
* The response to group update.
|
|
3283
|
+
*/
|
|
3284
|
+
export interface GroupsUpdateResponse {
|
|
3285
|
+
group: Group;
|
|
3286
|
+
}
|
|
3287
|
+
/**
|
|
3288
|
+
* impacted-customer-details
|
|
3289
|
+
* Details of the impact due to the incident.
|
|
3290
|
+
*/
|
|
3291
|
+
export interface ImpactedCustomerDetails {
|
|
3292
|
+
/** The properties of an enum value. */
|
|
3293
|
+
count?: EnumValue;
|
|
3294
|
+
/** List of customers impacted due to the incident. */
|
|
3295
|
+
customer_ids?: AccountSummary[];
|
|
3296
|
+
}
|
|
3297
|
+
/** incident */
|
|
3298
|
+
export type Incident = AtomBase & {
|
|
3299
|
+
/**
|
|
3300
|
+
* Timestamp when the incident was acknowledged.
|
|
3301
|
+
* @format date-time
|
|
3302
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2194
3303
|
*/
|
|
2195
3304
|
acknowledged_date?: string;
|
|
2196
3305
|
/** Parts to which the incident is applicable to. */
|
|
@@ -2207,8 +3316,6 @@ export type Incident = AtomBase & {
|
|
|
2207
3316
|
identified_date?: string;
|
|
2208
3317
|
/** Details of the impact due to the incident. */
|
|
2209
3318
|
impact?: ImpactedCustomerDetails;
|
|
2210
|
-
/** List of customers impacted due to the incident. */
|
|
2211
|
-
impacted_customers?: AccountSummary[];
|
|
2212
3319
|
/**
|
|
2213
3320
|
* Timestamp when the incident was mitigated.
|
|
2214
3321
|
* @format date-time
|
|
@@ -2225,11 +3332,6 @@ export type Incident = AtomBase & {
|
|
|
2225
3332
|
source?: EnumValue;
|
|
2226
3333
|
/** Describes the current stage of a object. */
|
|
2227
3334
|
stage?: Stage;
|
|
2228
|
-
/**
|
|
2229
|
-
* Users, along with the incident commander, involved in resolving
|
|
2230
|
-
* incidents and handling communication.
|
|
2231
|
-
*/
|
|
2232
|
-
stakeholders?: UserSummary[];
|
|
2233
3335
|
/** Tags associated with the object. */
|
|
2234
3336
|
tags?: TagWithValue[];
|
|
2235
3337
|
/**
|
|
@@ -2365,6 +3467,129 @@ export declare enum LinkType {
|
|
|
2365
3467
|
IsRelatedTo = "is_related_to",
|
|
2366
3468
|
Serves = "serves"
|
|
2367
3469
|
}
|
|
3470
|
+
/**
|
|
3471
|
+
* links-create-request
|
|
3472
|
+
* The request to create a new link.
|
|
3473
|
+
*/
|
|
3474
|
+
export interface LinksCreateRequest {
|
|
3475
|
+
/** Type of link used to define the relationship. */
|
|
3476
|
+
link_type: LinkType;
|
|
3477
|
+
/** The ID of the source object. */
|
|
3478
|
+
source: string;
|
|
3479
|
+
/** The ID of the target object. */
|
|
3480
|
+
target: string;
|
|
3481
|
+
}
|
|
3482
|
+
/**
|
|
3483
|
+
* links-create-response
|
|
3484
|
+
* The response to creating a new link.
|
|
3485
|
+
*/
|
|
3486
|
+
export interface LinksCreateResponse {
|
|
3487
|
+
link: Link;
|
|
3488
|
+
}
|
|
3489
|
+
/**
|
|
3490
|
+
* links-delete-request
|
|
3491
|
+
* The request to delete a link.
|
|
3492
|
+
*/
|
|
3493
|
+
export interface LinksDeleteRequest {
|
|
3494
|
+
/** The ID of the link to delete. */
|
|
3495
|
+
id: string;
|
|
3496
|
+
}
|
|
3497
|
+
/**
|
|
3498
|
+
* links-delete-response
|
|
3499
|
+
* The response for deleting a link.
|
|
3500
|
+
*/
|
|
3501
|
+
export type LinksDeleteResponse = object;
|
|
3502
|
+
/**
|
|
3503
|
+
* The direction of link, which can either be outbound such that the
|
|
3504
|
+
* object is the source of the link, otherwise inbound where the object is
|
|
3505
|
+
* the target of the link.
|
|
3506
|
+
*/
|
|
3507
|
+
export declare enum LinksDirection {
|
|
3508
|
+
IsSource = "is_source",
|
|
3509
|
+
IsTarget = "is_target"
|
|
3510
|
+
}
|
|
3511
|
+
/**
|
|
3512
|
+
* links-get-request
|
|
3513
|
+
* The request to get a link's information.
|
|
3514
|
+
*/
|
|
3515
|
+
export interface LinksGetRequest {
|
|
3516
|
+
/** The requested link's ID. */
|
|
3517
|
+
id: string;
|
|
3518
|
+
}
|
|
3519
|
+
/**
|
|
3520
|
+
* links-get-response
|
|
3521
|
+
* The response to getting a link's information.
|
|
3522
|
+
*/
|
|
3523
|
+
export interface LinksGetResponse {
|
|
3524
|
+
link: Link;
|
|
3525
|
+
}
|
|
3526
|
+
/**
|
|
3527
|
+
* links-list-request
|
|
3528
|
+
* The request to get information about a list of links.
|
|
3529
|
+
*/
|
|
3530
|
+
export interface LinksListRequest {
|
|
3531
|
+
/**
|
|
3532
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3533
|
+
* iteration starts from the beginning.
|
|
3534
|
+
*/
|
|
3535
|
+
cursor?: string;
|
|
3536
|
+
/**
|
|
3537
|
+
* The direction of link, which can either be outbound such that the
|
|
3538
|
+
* object is the source of the link, otherwise inbound where the object is
|
|
3539
|
+
* the target of the link.
|
|
3540
|
+
*/
|
|
3541
|
+
direction?: LinksDirection;
|
|
3542
|
+
/**
|
|
3543
|
+
* The maximum number of links to return. If not set, then the default
|
|
3544
|
+
* is '50'.
|
|
3545
|
+
* @format int32
|
|
3546
|
+
*/
|
|
3547
|
+
limit?: number;
|
|
3548
|
+
/**
|
|
3549
|
+
* The link type(s) to filter for, otherwise if not present, all link
|
|
3550
|
+
* types are included.
|
|
3551
|
+
*/
|
|
3552
|
+
link_type?: LinkType[];
|
|
3553
|
+
/**
|
|
3554
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3555
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3556
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3557
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3558
|
+
* always be returned in the specified sort-by order.
|
|
3559
|
+
*/
|
|
3560
|
+
mode?: ListMode;
|
|
3561
|
+
/** The ID of the object to list the links for. */
|
|
3562
|
+
object: string;
|
|
3563
|
+
/**
|
|
3564
|
+
* The object types to filter for, otherwise if not present, all
|
|
3565
|
+
* object types are included.
|
|
3566
|
+
*/
|
|
3567
|
+
object_types?: LinkEndpointType[];
|
|
3568
|
+
/**
|
|
3569
|
+
* The link types to filter for, otherwise if not present, all link
|
|
3570
|
+
* types are included.
|
|
3571
|
+
* @deprecated
|
|
3572
|
+
*/
|
|
3573
|
+
types?: LinkType[];
|
|
3574
|
+
}
|
|
3575
|
+
/**
|
|
3576
|
+
* links-list-response
|
|
3577
|
+
* The response to listing the links.
|
|
3578
|
+
*/
|
|
3579
|
+
export interface LinksListResponse {
|
|
3580
|
+
/** The list of links. */
|
|
3581
|
+
links: Link[];
|
|
3582
|
+
/**
|
|
3583
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
3584
|
+
* sort order. If not set, then no later elements exist.
|
|
3585
|
+
*/
|
|
3586
|
+
next_cursor?: string;
|
|
3587
|
+
/**
|
|
3588
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
3589
|
+
* sort order. If not set, then no prior elements exist.
|
|
3590
|
+
*/
|
|
3591
|
+
prev_cursor?: string;
|
|
3592
|
+
}
|
|
2368
3593
|
/**
|
|
2369
3594
|
* The iteration mode to use. If "after", then entries after the provided
|
|
2370
3595
|
* cursor will be returned, or if no cursor is provided, then from the
|
|
@@ -2376,6 +3601,15 @@ export declare enum ListMode {
|
|
|
2376
3601
|
After = "after",
|
|
2377
3602
|
Before = "before"
|
|
2378
3603
|
}
|
|
3604
|
+
/** member-summary */
|
|
3605
|
+
export type MemberSummary = (DevUserSummary | RevUserSummary | SysUserSummary) & {
|
|
3606
|
+
type: MemberType;
|
|
3607
|
+
};
|
|
3608
|
+
export declare enum MemberType {
|
|
3609
|
+
DevUser = "dev_user",
|
|
3610
|
+
RevUser = "rev_user",
|
|
3611
|
+
SysUser = "sys_user"
|
|
3612
|
+
}
|
|
2379
3613
|
/** metric-definition */
|
|
2380
3614
|
export type MetricDefinition = AtomBase & {
|
|
2381
3615
|
/** Human readable name of the metric. */
|
|
@@ -2775,8 +4009,12 @@ export type ProductSummary = PartBaseSummary;
|
|
|
2775
4009
|
export type QuestionAnswer = AtomBase & {
|
|
2776
4010
|
/** The Answer. */
|
|
2777
4011
|
answer?: string;
|
|
4012
|
+
/** Details of the parts relevant to the question_answer. */
|
|
4013
|
+
applies_to_parts?: PartSummary[];
|
|
2778
4014
|
/** The Question. */
|
|
2779
4015
|
question?: string;
|
|
4016
|
+
/** Status of the question answer. */
|
|
4017
|
+
status?: QuestionAnswerStatus;
|
|
2780
4018
|
/** An alternative answer suggested by the Q/A generation algorithm. */
|
|
2781
4019
|
suggested_answer?: string;
|
|
2782
4020
|
/**
|
|
@@ -2789,11 +4027,37 @@ export type QuestionAnswer = AtomBase & {
|
|
|
2789
4027
|
/** Whether the Q/A was verified. */
|
|
2790
4028
|
verified?: boolean;
|
|
2791
4029
|
};
|
|
4030
|
+
/** Status of the question answer. */
|
|
4031
|
+
export declare enum QuestionAnswerStatus {
|
|
4032
|
+
Archived = "archived",
|
|
4033
|
+
Discarded = "discarded",
|
|
4034
|
+
Draft = "draft",
|
|
4035
|
+
Published = "published",
|
|
4036
|
+
ReviewNeeded = "review_needed"
|
|
4037
|
+
}
|
|
4038
|
+
/** remove-tag-with-value */
|
|
4039
|
+
export interface RemoveTagWithValue {
|
|
4040
|
+
/**
|
|
4041
|
+
* The ID of the tag.
|
|
4042
|
+
* @example "TAG-12345"
|
|
4043
|
+
*/
|
|
4044
|
+
id: string;
|
|
4045
|
+
}
|
|
2792
4046
|
/**
|
|
2793
4047
|
* removed-sla-metric-history
|
|
2794
4048
|
* User, timestamp and metric id of removed metrics.
|
|
2795
4049
|
*/
|
|
2796
4050
|
export type RemovedSlaMetricHistory = object;
|
|
4051
|
+
/**
|
|
4052
|
+
* resource
|
|
4053
|
+
* Resource details.
|
|
4054
|
+
*/
|
|
4055
|
+
export interface Resource {
|
|
4056
|
+
/** Artifacts of the resource (relevant only for type artifact). */
|
|
4057
|
+
artifacts?: ArtifactSummary[];
|
|
4058
|
+
/** URL of the resource (relevant only for type url). */
|
|
4059
|
+
url?: string;
|
|
4060
|
+
}
|
|
2797
4061
|
/** rev-org */
|
|
2798
4062
|
export type RevOrg = OrgBase & {
|
|
2799
4063
|
/** Description of the Rev organization. */
|
|
@@ -3002,56 +4266,254 @@ export type RevUserSummary = UserBaseSummary & {
|
|
|
3002
4266
|
external_ref?: string;
|
|
3003
4267
|
rev_org?: OrgSummary;
|
|
3004
4268
|
};
|
|
3005
|
-
/**
|
|
3006
|
-
|
|
4269
|
+
/**
|
|
4270
|
+
* rev-users-create-request
|
|
4271
|
+
* Request object to create a new Rev user for a Rev organization.
|
|
4272
|
+
*/
|
|
4273
|
+
export interface RevUsersCreateRequest {
|
|
3007
4274
|
/**
|
|
3008
|
-
*
|
|
3009
|
-
*
|
|
4275
|
+
* The schema fragment IDs associated with the Rev user.
|
|
4276
|
+
* @deprecated
|
|
4277
|
+
* @example ["don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"]
|
|
3010
4278
|
*/
|
|
3011
|
-
|
|
4279
|
+
custom_schema_fragments?: string[];
|
|
3012
4280
|
/**
|
|
3013
|
-
*
|
|
3014
|
-
*
|
|
4281
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
4282
|
+
* custom field must be specified, otherwise a bad request error is
|
|
4283
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
4284
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
4285
|
+
* specifier, it remains unmodified.
|
|
3015
4286
|
*/
|
|
3016
|
-
|
|
3017
|
-
|
|
3018
|
-
|
|
3019
|
-
|
|
3020
|
-
|
|
3021
|
-
default_value?: boolean;
|
|
3022
|
-
};
|
|
3023
|
-
/** schema-bool-list-field-descriptor */
|
|
3024
|
-
export type SchemaBoolListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3025
|
-
/** Default value. */
|
|
3026
|
-
default_value?: boolean[];
|
|
3027
|
-
};
|
|
3028
|
-
/** schema-composite-field-descriptor */
|
|
3029
|
-
export type SchemaCompositeFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3030
|
-
/** Composite type. Required when field type is composite. */
|
|
3031
|
-
composite_type?: string;
|
|
3032
|
-
};
|
|
3033
|
-
/** schema-composite-list-field-descriptor */
|
|
3034
|
-
export type SchemaCompositeListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3035
|
-
/** Composite type. Required when field type is composite. */
|
|
3036
|
-
composite_type?: string;
|
|
3037
|
-
};
|
|
3038
|
-
/** schema-date-field-descriptor */
|
|
3039
|
-
export type SchemaDateFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3040
|
-
/** Default value. */
|
|
3041
|
-
default_value?: string;
|
|
3042
|
-
};
|
|
3043
|
-
/** schema-date-list-field-descriptor */
|
|
3044
|
-
export type SchemaDateListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3045
|
-
/** Default value. */
|
|
3046
|
-
default_value?: string[];
|
|
3047
|
-
};
|
|
3048
|
-
/** schema-double-field-descriptor */
|
|
3049
|
-
export type SchemaDoubleFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4287
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
4288
|
+
/** Description of the Rev user. */
|
|
4289
|
+
description?: string;
|
|
4290
|
+
/** The user's display name. The name is non-unique and mutable. */
|
|
4291
|
+
display_name?: string;
|
|
3050
4292
|
/**
|
|
3051
|
-
*
|
|
3052
|
-
* @
|
|
4293
|
+
* Artifact ID of a Rev user's display picture.
|
|
4294
|
+
* @example "ARTIFACT-12345"
|
|
3053
4295
|
*/
|
|
3054
|
-
|
|
4296
|
+
display_picture?: string;
|
|
4297
|
+
/** Email address of the Rev user. */
|
|
4298
|
+
email?: string;
|
|
4299
|
+
/**
|
|
4300
|
+
* External ref is a mutable unique identifier for a user within the
|
|
4301
|
+
* Dev organization from your primary customer record. If none is
|
|
4302
|
+
* available, a good alternative is the email address/phone number
|
|
4303
|
+
* which could uniquely identify the user. If none is specified, a
|
|
4304
|
+
* system-generated identifier will be assigned to the user.
|
|
4305
|
+
*/
|
|
4306
|
+
external_ref?: string;
|
|
4307
|
+
/** Phone numbers, in E.164 format, of the Rev user. */
|
|
4308
|
+
phone_numbers?: string[];
|
|
4309
|
+
/**
|
|
4310
|
+
* The ID of the Rev organization to which the created Rev user is
|
|
4311
|
+
* associated.
|
|
4312
|
+
* @example "REV-AbCdEfGh"
|
|
4313
|
+
*/
|
|
4314
|
+
rev_org?: string;
|
|
4315
|
+
}
|
|
4316
|
+
/**
|
|
4317
|
+
* rev-users-create-response
|
|
4318
|
+
* Response object for creating a new Rev user for Rev organization.
|
|
4319
|
+
*/
|
|
4320
|
+
export interface RevUsersCreateResponse {
|
|
4321
|
+
rev_user: RevUser;
|
|
4322
|
+
}
|
|
4323
|
+
/**
|
|
4324
|
+
* rev-users-delete-request
|
|
4325
|
+
* Request object to delete a Rev user.
|
|
4326
|
+
*/
|
|
4327
|
+
export interface RevUsersDeleteRequest {
|
|
4328
|
+
/** The ID of Rev user to delete. */
|
|
4329
|
+
id: string;
|
|
4330
|
+
}
|
|
4331
|
+
/**
|
|
4332
|
+
* rev-users-delete-response
|
|
4333
|
+
* The response to deleting a Rev user of a Rev organization.
|
|
4334
|
+
*/
|
|
4335
|
+
export type RevUsersDeleteResponse = object;
|
|
4336
|
+
/**
|
|
4337
|
+
* rev-users-get-request
|
|
4338
|
+
* Request object to get a Rev user.
|
|
4339
|
+
*/
|
|
4340
|
+
export interface RevUsersGetRequest {
|
|
4341
|
+
/** The ID of Rev user to be retrieved. */
|
|
4342
|
+
id: string;
|
|
4343
|
+
}
|
|
4344
|
+
/**
|
|
4345
|
+
* rev-users-get-response
|
|
4346
|
+
* The returned Rev user.
|
|
4347
|
+
*/
|
|
4348
|
+
export interface RevUsersGetResponse {
|
|
4349
|
+
rev_user: RevUser;
|
|
4350
|
+
}
|
|
4351
|
+
/**
|
|
4352
|
+
* rev-users-list-request
|
|
4353
|
+
* Gets the list of Rev users belonging to the authenticated user's Dev
|
|
4354
|
+
* organization which the user is also authorized to access.
|
|
4355
|
+
*/
|
|
4356
|
+
export interface RevUsersListRequest {
|
|
4357
|
+
/**
|
|
4358
|
+
* Filters for Rev users with specified associations
|
|
4359
|
+
* (account/workspace).
|
|
4360
|
+
*/
|
|
4361
|
+
associations?: string[];
|
|
4362
|
+
/** Filters for Rev users that were created by the specified user(s). */
|
|
4363
|
+
created_by?: string[];
|
|
4364
|
+
created_date?: DateTimeFilter;
|
|
4365
|
+
/**
|
|
4366
|
+
* The cursor to resume iteration from. If not provided, then
|
|
4367
|
+
* iteration starts from the beginning.
|
|
4368
|
+
*/
|
|
4369
|
+
cursor?: string;
|
|
4370
|
+
/** List of emails of Rev users to be filtered. */
|
|
4371
|
+
email?: string[];
|
|
4372
|
+
/** List of external refs to filter Rev users for. */
|
|
4373
|
+
external_ref?: string[];
|
|
4374
|
+
/** Value of is_verified field to filter the Rev users. */
|
|
4375
|
+
is_verified?: boolean;
|
|
4376
|
+
/**
|
|
4377
|
+
* The maximum number of Rev users to return. The default is '50'.
|
|
4378
|
+
* @format int32
|
|
4379
|
+
*/
|
|
4380
|
+
limit?: number;
|
|
4381
|
+
/**
|
|
4382
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
4383
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
4384
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
4385
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
4386
|
+
* always be returned in the specified sort-by order.
|
|
4387
|
+
*/
|
|
4388
|
+
mode?: ListMode;
|
|
4389
|
+
modified_date?: DateTimeFilter;
|
|
4390
|
+
/** List of phone numbers, in E.164 format, to filter Rev users on. */
|
|
4391
|
+
phone_numbers?: string[];
|
|
4392
|
+
/**
|
|
4393
|
+
* List of IDs of Rev organizations to be filtered.
|
|
4394
|
+
* @example ["REV-AbCdEfGh"]
|
|
4395
|
+
*/
|
|
4396
|
+
rev_org?: string[];
|
|
4397
|
+
/** Fields to sort the Rev users by and the direction to sort them. */
|
|
4398
|
+
sort_by?: string[];
|
|
4399
|
+
}
|
|
4400
|
+
/**
|
|
4401
|
+
* rev-users-list-response
|
|
4402
|
+
* The response to listing all Rev users matching the filter criteria.
|
|
4403
|
+
*/
|
|
4404
|
+
export interface RevUsersListResponse {
|
|
4405
|
+
/**
|
|
4406
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
4407
|
+
* sort order. If not set, then no later elements exist.
|
|
4408
|
+
*/
|
|
4409
|
+
next_cursor?: string;
|
|
4410
|
+
/**
|
|
4411
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
4412
|
+
* sort order. If not set, then no prior elements exist.
|
|
4413
|
+
*/
|
|
4414
|
+
prev_cursor?: string;
|
|
4415
|
+
/** List containing all the Rev users. */
|
|
4416
|
+
rev_users: RevUser[];
|
|
4417
|
+
}
|
|
4418
|
+
/**
|
|
4419
|
+
* rev-users-update-request
|
|
4420
|
+
* Request to update details of a Rev user.
|
|
4421
|
+
*/
|
|
4422
|
+
export interface RevUsersUpdateRequest {
|
|
4423
|
+
/** Application-defined custom fields. */
|
|
4424
|
+
custom_fields?: object;
|
|
4425
|
+
custom_schema_fragments?: RevUsersUpdateRequestCustomSchemaFragments;
|
|
4426
|
+
/**
|
|
4427
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
4428
|
+
* custom field must be specified, otherwise a bad request error is
|
|
4429
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
4430
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
4431
|
+
* specifier, it remains unmodified.
|
|
4432
|
+
*/
|
|
4433
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
4434
|
+
/** Updated description of the Rev user. */
|
|
4435
|
+
description?: string;
|
|
4436
|
+
/** Updated display name of the Rev user. */
|
|
4437
|
+
display_name?: string;
|
|
4438
|
+
/**
|
|
4439
|
+
* Artifact ID of a Rev user's updated display picture.
|
|
4440
|
+
* @example "ARTIFACT-12345"
|
|
4441
|
+
*/
|
|
4442
|
+
display_picture?: string | null;
|
|
4443
|
+
/** Updated email address of the Rev user. */
|
|
4444
|
+
email?: string;
|
|
4445
|
+
/** Updated external ref value of the Rev user. */
|
|
4446
|
+
external_ref?: string;
|
|
4447
|
+
/** The ID of Rev user to update. */
|
|
4448
|
+
id: string;
|
|
4449
|
+
/** The phone numbers, in E.164 format, of the Rev user. */
|
|
4450
|
+
phone_numbers?: string[];
|
|
4451
|
+
}
|
|
4452
|
+
/** rev-users-update-request-custom-schema-fragments */
|
|
4453
|
+
export interface RevUsersUpdateRequestCustomSchemaFragments {
|
|
4454
|
+
/**
|
|
4455
|
+
* Sets the IDs to the provided schema fragment IDs.
|
|
4456
|
+
* @example ["don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"]
|
|
4457
|
+
*/
|
|
4458
|
+
set?: string[];
|
|
4459
|
+
}
|
|
4460
|
+
/**
|
|
4461
|
+
* rev-users-update-response
|
|
4462
|
+
* Updated Rev user object.
|
|
4463
|
+
*/
|
|
4464
|
+
export interface RevUsersUpdateResponse {
|
|
4465
|
+
rev_user: RevUser;
|
|
4466
|
+
}
|
|
4467
|
+
/** saml-connection-fields-map */
|
|
4468
|
+
export interface SamlConnectionFieldsMap {
|
|
4469
|
+
/**
|
|
4470
|
+
* Claims in the SAML assertion returned by the identity provider that
|
|
4471
|
+
* map to the email address of the user.
|
|
4472
|
+
*/
|
|
4473
|
+
email?: string;
|
|
4474
|
+
/**
|
|
4475
|
+
* Claims in the SAML assertion returned by the identity provider that
|
|
4476
|
+
* map to the user ID of the user.
|
|
4477
|
+
*/
|
|
4478
|
+
user_id?: string;
|
|
4479
|
+
}
|
|
4480
|
+
/** schema-bool-field-descriptor */
|
|
4481
|
+
export type SchemaBoolFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4482
|
+
/** Default value. */
|
|
4483
|
+
default_value?: boolean;
|
|
4484
|
+
};
|
|
4485
|
+
/** schema-bool-list-field-descriptor */
|
|
4486
|
+
export type SchemaBoolListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4487
|
+
/** Default value. */
|
|
4488
|
+
default_value?: boolean[];
|
|
4489
|
+
};
|
|
4490
|
+
/** schema-composite-field-descriptor */
|
|
4491
|
+
export type SchemaCompositeFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4492
|
+
/** Composite type. Required when field type is composite. */
|
|
4493
|
+
composite_type?: string;
|
|
4494
|
+
};
|
|
4495
|
+
/** schema-composite-list-field-descriptor */
|
|
4496
|
+
export type SchemaCompositeListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4497
|
+
/** Composite type. Required when field type is composite. */
|
|
4498
|
+
composite_type?: string;
|
|
4499
|
+
};
|
|
4500
|
+
/** schema-date-field-descriptor */
|
|
4501
|
+
export type SchemaDateFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4502
|
+
/** Default value. */
|
|
4503
|
+
default_value?: string;
|
|
4504
|
+
};
|
|
4505
|
+
/** schema-date-list-field-descriptor */
|
|
4506
|
+
export type SchemaDateListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4507
|
+
/** Default value. */
|
|
4508
|
+
default_value?: string[];
|
|
4509
|
+
};
|
|
4510
|
+
/** schema-double-field-descriptor */
|
|
4511
|
+
export type SchemaDoubleFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4512
|
+
/**
|
|
4513
|
+
* Default value.
|
|
4514
|
+
* @format double
|
|
4515
|
+
*/
|
|
4516
|
+
default_value?: number;
|
|
3055
4517
|
};
|
|
3056
4518
|
/** schema-double-list-field-descriptor */
|
|
3057
4519
|
export type SchemaDoubleListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
@@ -3080,11 +4542,11 @@ export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
3080
4542
|
* schema-field-descriptor
|
|
3081
4543
|
* Set of field attributes.
|
|
3082
4544
|
*/
|
|
3083
|
-
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaStructFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
|
|
4545
|
+
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaJsonValueFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaStructFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
|
|
3084
4546
|
field_type: SchemaFieldDescriptorFieldType;
|
|
3085
4547
|
};
|
|
3086
4548
|
/** schema-field-descriptor-array-type */
|
|
3087
|
-
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaStructListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
|
|
4549
|
+
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaJsonValueListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaStructListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
|
|
3088
4550
|
base_type: SchemaFieldDescriptorArrayTypeBaseType;
|
|
3089
4551
|
/**
|
|
3090
4552
|
* The exact array length.
|
|
@@ -3110,6 +4572,7 @@ export declare enum SchemaFieldDescriptorArrayTypeBaseType {
|
|
|
3110
4572
|
Enum = "enum",
|
|
3111
4573
|
Id = "id",
|
|
3112
4574
|
Int = "int",
|
|
4575
|
+
JsonValue = "json_value",
|
|
3113
4576
|
RichText = "rich_text",
|
|
3114
4577
|
Struct = "struct",
|
|
3115
4578
|
Text = "text",
|
|
@@ -3152,6 +4615,7 @@ export declare enum SchemaFieldDescriptorFieldType {
|
|
|
3152
4615
|
Enum = "enum",
|
|
3153
4616
|
Id = "id",
|
|
3154
4617
|
Int = "int",
|
|
4618
|
+
JsonValue = "json_value",
|
|
3155
4619
|
RichText = "rich_text",
|
|
3156
4620
|
Struct = "struct",
|
|
3157
4621
|
Text = "text",
|
|
@@ -3247,6 +4711,16 @@ export type SchemaIntListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
3247
4711
|
*/
|
|
3248
4712
|
lte?: number;
|
|
3249
4713
|
};
|
|
4714
|
+
/** schema-json-value-field-descriptor */
|
|
4715
|
+
export type SchemaJsonValueFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4716
|
+
/** Default value. */
|
|
4717
|
+
default_value?: any;
|
|
4718
|
+
};
|
|
4719
|
+
/** schema-json-value-list-field-descriptor */
|
|
4720
|
+
export type SchemaJsonValueListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
4721
|
+
/** Default value. */
|
|
4722
|
+
default_value?: any[];
|
|
4723
|
+
};
|
|
3250
4724
|
/** schema-rich-text-field-descriptor */
|
|
3251
4725
|
export type SchemaRichTextFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3252
4726
|
/** The contained substring. */
|
|
@@ -3454,6 +4928,24 @@ export type SchemaUenumListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
3454
4928
|
};
|
|
3455
4929
|
/** schema-unknown-field-descriptor */
|
|
3456
4930
|
export type SchemaUnknownFieldDescriptor = SchemaFieldDescriptorBase;
|
|
4931
|
+
/** service-account */
|
|
4932
|
+
export type ServiceAccount = UserBase;
|
|
4933
|
+
/**
|
|
4934
|
+
* service-accounts-get-request
|
|
4935
|
+
* The request object to get a service account's information.
|
|
4936
|
+
*/
|
|
4937
|
+
export interface ServiceAccountsGetRequest {
|
|
4938
|
+
/** The ID of the requested service account. */
|
|
4939
|
+
id: string;
|
|
4940
|
+
}
|
|
4941
|
+
/**
|
|
4942
|
+
* service-accounts-get-response
|
|
4943
|
+
* The response object that carries the service account's information
|
|
4944
|
+
* corresponding to the request.
|
|
4945
|
+
*/
|
|
4946
|
+
export interface ServiceAccountsGetResponse {
|
|
4947
|
+
service_account: ServiceAccount;
|
|
4948
|
+
}
|
|
3457
4949
|
/** set-issue-selector */
|
|
3458
4950
|
export interface SetIssueSelector {
|
|
3459
4951
|
/**
|
|
@@ -3486,6 +4978,19 @@ export interface SetIssueSelector {
|
|
|
3486
4978
|
*/
|
|
3487
4979
|
tags?: string[];
|
|
3488
4980
|
}
|
|
4981
|
+
/**
|
|
4982
|
+
* set-shared-with-membership
|
|
4983
|
+
* Information about the role the member receives due to the share.
|
|
4984
|
+
*/
|
|
4985
|
+
export interface SetSharedWithMembership {
|
|
4986
|
+
/** ID of the member the object is shared with. */
|
|
4987
|
+
member?: string;
|
|
4988
|
+
/**
|
|
4989
|
+
* ID of the role that describes what privileges the membership
|
|
4990
|
+
* entails.
|
|
4991
|
+
*/
|
|
4992
|
+
role?: string;
|
|
4993
|
+
}
|
|
3489
4994
|
/** set-sla-policy */
|
|
3490
4995
|
export interface SetSlaPolicy {
|
|
3491
4996
|
/** Metrics to apply to the selected items. */
|
|
@@ -3580,6 +5085,16 @@ export interface SetTagWithValue {
|
|
|
3580
5085
|
*/
|
|
3581
5086
|
value?: string;
|
|
3582
5087
|
}
|
|
5088
|
+
/**
|
|
5089
|
+
* shared-with-membership-filter
|
|
5090
|
+
* Filter on target item based on intended audience.
|
|
5091
|
+
*/
|
|
5092
|
+
export interface SharedWithMembershipFilter {
|
|
5093
|
+
/** ID of the group/member with whom the item is shared. */
|
|
5094
|
+
member?: string;
|
|
5095
|
+
/** Role ID of the group/member with whom the item is shared. */
|
|
5096
|
+
role?: string;
|
|
5097
|
+
}
|
|
3583
5098
|
/** sla */
|
|
3584
5099
|
export type Sla = AtomBase & {
|
|
3585
5100
|
/**
|
|
@@ -4181,6 +5696,75 @@ export declare enum SyncRunMode {
|
|
|
4181
5696
|
export type SysUser = UserBase;
|
|
4182
5697
|
/** sys-user-summary */
|
|
4183
5698
|
export type SysUserSummary = UserBaseSummary;
|
|
5699
|
+
/**
|
|
5700
|
+
* sys-users-list-request
|
|
5701
|
+
* A request to get the list of system user's information.
|
|
5702
|
+
*/
|
|
5703
|
+
export interface SysUsersListRequest {
|
|
5704
|
+
/**
|
|
5705
|
+
* The cursor to resume iteration from. If not provided, then
|
|
5706
|
+
* iteration starts from the beginning.
|
|
5707
|
+
*/
|
|
5708
|
+
cursor?: string;
|
|
5709
|
+
/**
|
|
5710
|
+
* The maximum number of system users to return. Value can range from
|
|
5711
|
+
* '1' to '100', with a default of '50'.
|
|
5712
|
+
* @format int32
|
|
5713
|
+
*/
|
|
5714
|
+
limit?: number;
|
|
5715
|
+
/**
|
|
5716
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
5717
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
5718
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
5719
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
5720
|
+
* always be returned in the specified sort-by order.
|
|
5721
|
+
*/
|
|
5722
|
+
mode?: ListMode;
|
|
5723
|
+
/** Fields to sort the system users by and the direction to sort them. */
|
|
5724
|
+
sort_by?: string[];
|
|
5725
|
+
}
|
|
5726
|
+
/**
|
|
5727
|
+
* sys-users-list-response
|
|
5728
|
+
* The response to listing the system users.
|
|
5729
|
+
*/
|
|
5730
|
+
export interface SysUsersListResponse {
|
|
5731
|
+
/**
|
|
5732
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
5733
|
+
* sort order. If not set, then no later elements exist.
|
|
5734
|
+
*/
|
|
5735
|
+
next_cursor?: string;
|
|
5736
|
+
/**
|
|
5737
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
5738
|
+
* sort order. If not set, then no prior elements exist.
|
|
5739
|
+
*/
|
|
5740
|
+
prev_cursor?: string;
|
|
5741
|
+
/** The list of system users. */
|
|
5742
|
+
sys_users: SysUser[];
|
|
5743
|
+
}
|
|
5744
|
+
/**
|
|
5745
|
+
* sys-users-update-request
|
|
5746
|
+
* Request to update information of the system user.
|
|
5747
|
+
*/
|
|
5748
|
+
export interface SysUsersUpdateRequest {
|
|
5749
|
+
/** Updated display name for the system user. */
|
|
5750
|
+
display_name?: string;
|
|
5751
|
+
/**
|
|
5752
|
+
* Artifact ID of the system user's new display picture.
|
|
5753
|
+
* @example "ARTIFACT-12345"
|
|
5754
|
+
*/
|
|
5755
|
+
display_picture?: string | null;
|
|
5756
|
+
/** Updated full name for the system user. */
|
|
5757
|
+
full_name?: string;
|
|
5758
|
+
/** The ID of system user to update. */
|
|
5759
|
+
id: string;
|
|
5760
|
+
}
|
|
5761
|
+
/**
|
|
5762
|
+
* sys-users-update-response
|
|
5763
|
+
* Updated Sys user object.
|
|
5764
|
+
*/
|
|
5765
|
+
export interface SysUsersUpdateResponse {
|
|
5766
|
+
sys_user: SysUser;
|
|
5767
|
+
}
|
|
4184
5768
|
/** tag */
|
|
4185
5769
|
export type Tag = AtomBase & {
|
|
4186
5770
|
/**
|
|
@@ -4216,6 +5800,19 @@ export interface TagWithValue {
|
|
|
4216
5800
|
/** The value for the object's association with the tag. */
|
|
4217
5801
|
value?: string;
|
|
4218
5802
|
}
|
|
5803
|
+
/** tag-with-value-filter */
|
|
5804
|
+
export interface TagWithValueFilter {
|
|
5805
|
+
/**
|
|
5806
|
+
* The ID of the tag.
|
|
5807
|
+
* @example "TAG-12345"
|
|
5808
|
+
*/
|
|
5809
|
+
id?: string;
|
|
5810
|
+
/**
|
|
5811
|
+
* The value for the object's association with the tag. If specified,
|
|
5812
|
+
* the value must be one that's specified in the tag's allowed values.
|
|
5813
|
+
*/
|
|
5814
|
+
value?: string;
|
|
5815
|
+
}
|
|
4219
5816
|
/**
|
|
4220
5817
|
* tags-create-request
|
|
4221
5818
|
* The request to create a new tag.
|
|
@@ -4378,6 +5975,8 @@ export type Ticket = WorkBase & {
|
|
|
4378
5975
|
sla_tracker?: SlaTrackerSummary;
|
|
4379
5976
|
/** Source channel of the ticket. */
|
|
4380
5977
|
source_channel?: string;
|
|
5978
|
+
/** The properties of an enum value. */
|
|
5979
|
+
visibility?: EnumValue;
|
|
4381
5980
|
};
|
|
4382
5981
|
/** Channels of the ticket. */
|
|
4383
5982
|
export declare enum TicketChannels {
|
|
@@ -5156,7 +6755,10 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestTi
|
|
|
5156
6755
|
* @example ["ARTIFACT-12345"]
|
|
5157
6756
|
*/
|
|
5158
6757
|
artifacts?: string[];
|
|
5159
|
-
/**
|
|
6758
|
+
/**
|
|
6759
|
+
* Body of the work object.
|
|
6760
|
+
* @maxLength 65536
|
|
6761
|
+
*/
|
|
5160
6762
|
body?: string;
|
|
5161
6763
|
/**
|
|
5162
6764
|
* The users that own the work.
|
|
@@ -5454,7 +7056,10 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
5454
7056
|
*/
|
|
5455
7057
|
applies_to_part?: string;
|
|
5456
7058
|
artifacts?: WorksUpdateRequestArtifacts;
|
|
5457
|
-
/**
|
|
7059
|
+
/**
|
|
7060
|
+
* Updated body of the work object, or unchanged if not provided.
|
|
7061
|
+
* @maxLength 65536
|
|
7062
|
+
*/
|
|
5458
7063
|
body?: string;
|
|
5459
7064
|
/**
|
|
5460
7065
|
* The work's ID.
|
|
@@ -5864,37 +7469,165 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5864
7469
|
*/
|
|
5865
7470
|
accountsUpdate: (data: AccountsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsUpdateResponse, any>>;
|
|
5866
7471
|
/**
|
|
5867
|
-
* @description
|
|
7472
|
+
* @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.
|
|
5868
7473
|
*
|
|
5869
|
-
* @tags
|
|
5870
|
-
* @name
|
|
5871
|
-
* @summary
|
|
5872
|
-
* @request
|
|
7474
|
+
* @tags articles
|
|
7475
|
+
* @name CreateArticle
|
|
7476
|
+
* @summary Create Article
|
|
7477
|
+
* @request POST:/articles.create
|
|
5873
7478
|
* @secure
|
|
5874
7479
|
*/
|
|
5875
|
-
|
|
5876
|
-
/**
|
|
5877
|
-
* The requested artifact's ID.
|
|
5878
|
-
* @example "ARTIFACT-12345"
|
|
5879
|
-
*/
|
|
5880
|
-
id: string;
|
|
5881
|
-
/** The version of the artifact that needs to be fetched. */
|
|
5882
|
-
version?: string;
|
|
5883
|
-
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any>>;
|
|
7480
|
+
createArticle: (data: ArticlesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesCreateResponse, any>>;
|
|
5884
7481
|
/**
|
|
5885
|
-
* @description
|
|
7482
|
+
* @description Deletes an article.
|
|
5886
7483
|
*
|
|
5887
|
-
* @tags
|
|
5888
|
-
* @name
|
|
5889
|
-
* @summary
|
|
5890
|
-
* @request POST:/
|
|
7484
|
+
* @tags articles
|
|
7485
|
+
* @name DeleteArticle
|
|
7486
|
+
* @summary Delete Article
|
|
7487
|
+
* @request POST:/articles.delete
|
|
5891
7488
|
* @secure
|
|
5892
7489
|
*/
|
|
5893
|
-
|
|
7490
|
+
deleteArticle: (data: ArticlesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
5894
7491
|
/**
|
|
5895
|
-
* @description
|
|
7492
|
+
* @description Gets an article.
|
|
5896
7493
|
*
|
|
5897
|
-
* @tags
|
|
7494
|
+
* @tags articles
|
|
7495
|
+
* @name GetArticle
|
|
7496
|
+
* @summary Get Article
|
|
7497
|
+
* @request GET:/articles.get
|
|
7498
|
+
* @secure
|
|
7499
|
+
*/
|
|
7500
|
+
getArticle: (query: {
|
|
7501
|
+
/**
|
|
7502
|
+
* The ID of the required article.
|
|
7503
|
+
* @example "ARTICLE-12345"
|
|
7504
|
+
*/
|
|
7505
|
+
id: string;
|
|
7506
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
|
|
7507
|
+
/**
|
|
7508
|
+
* @description Gets an article.
|
|
7509
|
+
*
|
|
7510
|
+
* @tags articles
|
|
7511
|
+
* @name GetArticlePost
|
|
7512
|
+
* @summary Get Article (POST)
|
|
7513
|
+
* @request POST:/articles.get
|
|
7514
|
+
* @secure
|
|
7515
|
+
*/
|
|
7516
|
+
getArticlePost: (data: ArticlesGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
|
|
7517
|
+
/**
|
|
7518
|
+
* @description Lists a collection of articles.
|
|
7519
|
+
*
|
|
7520
|
+
* @tags articles
|
|
7521
|
+
* @name ListArticles
|
|
7522
|
+
* @summary List Articles
|
|
7523
|
+
* @request GET:/articles.list
|
|
7524
|
+
* @secure
|
|
7525
|
+
*/
|
|
7526
|
+
listArticles: (query?: {
|
|
7527
|
+
/**
|
|
7528
|
+
* Filters for articles belonging to any of the provided parts.
|
|
7529
|
+
* @example ["PROD-12345"]
|
|
7530
|
+
*/
|
|
7531
|
+
applies_to_parts?: string[];
|
|
7532
|
+
/**
|
|
7533
|
+
* Filter for the type of articles. If this is not provided, then
|
|
7534
|
+
* articles that are not content blocks are returned.
|
|
7535
|
+
*/
|
|
7536
|
+
article_type?: ArticleType[];
|
|
7537
|
+
/**
|
|
7538
|
+
* Filters for articles authored by any of the provided users.
|
|
7539
|
+
* @example ["DEVU-12345"]
|
|
7540
|
+
*/
|
|
7541
|
+
authored_by?: string[];
|
|
7542
|
+
/**
|
|
7543
|
+
* Filters for articles created by any of the provided users.
|
|
7544
|
+
* @example ["DEVU-12345"]
|
|
7545
|
+
*/
|
|
7546
|
+
created_by?: string[];
|
|
7547
|
+
/**
|
|
7548
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
7549
|
+
* starts from the beginning.
|
|
7550
|
+
*/
|
|
7551
|
+
cursor?: string;
|
|
7552
|
+
/**
|
|
7553
|
+
* The maximum number of articles to return. The default is '50'.
|
|
7554
|
+
* @format int32
|
|
7555
|
+
*/
|
|
7556
|
+
limit?: number;
|
|
7557
|
+
/**
|
|
7558
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
7559
|
+
* used.
|
|
7560
|
+
*/
|
|
7561
|
+
mode?: ListMode;
|
|
7562
|
+
/**
|
|
7563
|
+
* Filters for articles modified by any of the provided users.
|
|
7564
|
+
* @example ["DEVU-12345"]
|
|
7565
|
+
*/
|
|
7566
|
+
modified_by?: string[];
|
|
7567
|
+
/**
|
|
7568
|
+
* Filters for articles owned by any of the provided users.
|
|
7569
|
+
* @example ["DEVU-12345"]
|
|
7570
|
+
*/
|
|
7571
|
+
owned_by?: string[];
|
|
7572
|
+
/** Filter for the scope of the articles. */
|
|
7573
|
+
scope?: number[];
|
|
7574
|
+
/** ID of the group/member with whom the item is shared. */
|
|
7575
|
+
'shared_with.member'?: string;
|
|
7576
|
+
/** Role ID of the group/member with whom the item is shared. */
|
|
7577
|
+
'shared_with.role'?: string;
|
|
7578
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
|
|
7579
|
+
/**
|
|
7580
|
+
* @description Lists a collection of articles.
|
|
7581
|
+
*
|
|
7582
|
+
* @tags articles
|
|
7583
|
+
* @name ListArticlesPost
|
|
7584
|
+
* @summary List Articles (POST)
|
|
7585
|
+
* @request POST:/articles.list
|
|
7586
|
+
* @secure
|
|
7587
|
+
*/
|
|
7588
|
+
listArticlesPost: (data: ArticlesListRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
|
|
7589
|
+
/**
|
|
7590
|
+
* @description Updates an article.
|
|
7591
|
+
*
|
|
7592
|
+
* @tags articles
|
|
7593
|
+
* @name UpdateArticle
|
|
7594
|
+
* @summary Update Article
|
|
7595
|
+
* @request POST:/articles.update
|
|
7596
|
+
* @secure
|
|
7597
|
+
*/
|
|
7598
|
+
updateArticle: (data: ArticlesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesUpdateResponse, any>>;
|
|
7599
|
+
/**
|
|
7600
|
+
* @description Gets the requested artifact's information.
|
|
7601
|
+
*
|
|
7602
|
+
* @tags artifacts
|
|
7603
|
+
* @name ArtifactsGet
|
|
7604
|
+
* @summary Get Artifact
|
|
7605
|
+
* @request GET:/artifacts.get
|
|
7606
|
+
* @secure
|
|
7607
|
+
*/
|
|
7608
|
+
artifactsGet: (query: {
|
|
7609
|
+
/**
|
|
7610
|
+
* The requested artifact's ID.
|
|
7611
|
+
* @example "ARTIFACT-12345"
|
|
7612
|
+
*/
|
|
7613
|
+
id: string;
|
|
7614
|
+
/** The version of the artifact that needs to be fetched. */
|
|
7615
|
+
version?: string;
|
|
7616
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any>>;
|
|
7617
|
+
/**
|
|
7618
|
+
* @description Gets the requested artifact's information.
|
|
7619
|
+
*
|
|
7620
|
+
* @tags artifacts
|
|
7621
|
+
* @name ArtifactsGetPost
|
|
7622
|
+
* @summary Get Artifact (POST)
|
|
7623
|
+
* @request POST:/artifacts.get
|
|
7624
|
+
* @secure
|
|
7625
|
+
*/
|
|
7626
|
+
artifactsGetPost: (data: ArtifactsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any>>;
|
|
7627
|
+
/**
|
|
7628
|
+
* @description List the artifacts attached to an object.
|
|
7629
|
+
*
|
|
7630
|
+
* @tags artifacts
|
|
5898
7631
|
* @name ArtifactsList
|
|
5899
7632
|
* @summary List Artifacts
|
|
5900
7633
|
* @request GET:/artifacts.list
|
|
@@ -6075,10 +7808,175 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6075
7808
|
* @secure
|
|
6076
7809
|
*/
|
|
6077
7810
|
authTokensUpdate: (data: AuthTokensUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensUpdateResponse, any>>;
|
|
7811
|
+
/**
|
|
7812
|
+
* @description Creates a conversation.
|
|
7813
|
+
*
|
|
7814
|
+
* @tags conversations
|
|
7815
|
+
* @name ConversationsCreate
|
|
7816
|
+
* @summary Create Conversation
|
|
7817
|
+
* @request POST:/conversations.create
|
|
7818
|
+
* @secure
|
|
7819
|
+
*/
|
|
7820
|
+
conversationsCreate: (data: ConversationsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsCreateResponse, any>>;
|
|
7821
|
+
/**
|
|
7822
|
+
* @description Deletes the requested conversation.
|
|
7823
|
+
*
|
|
7824
|
+
* @tags conversations
|
|
7825
|
+
* @name ConversationsDelete
|
|
7826
|
+
* @summary Delete Conversation
|
|
7827
|
+
* @request POST:/conversations.delete
|
|
7828
|
+
* @secure
|
|
7829
|
+
*/
|
|
7830
|
+
conversationsDelete: (data: ConversationsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
7831
|
+
/**
|
|
7832
|
+
* @description Gets the requested conversation's information.
|
|
7833
|
+
*
|
|
7834
|
+
* @tags conversations
|
|
7835
|
+
* @name ConversationsGet
|
|
7836
|
+
* @summary Get Conversation
|
|
7837
|
+
* @request GET:/conversations.get
|
|
7838
|
+
* @secure
|
|
7839
|
+
*/
|
|
7840
|
+
conversationsGet: (query: {
|
|
7841
|
+
/** The requested conversation's ID. */
|
|
7842
|
+
id: string;
|
|
7843
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any>>;
|
|
7844
|
+
/**
|
|
7845
|
+
* @description Gets the requested conversation's information.
|
|
7846
|
+
*
|
|
7847
|
+
* @tags conversations
|
|
7848
|
+
* @name ConversationsGetPost
|
|
7849
|
+
* @summary Get Conversation (POST)
|
|
7850
|
+
* @request POST:/conversations.get
|
|
7851
|
+
* @secure
|
|
7852
|
+
*/
|
|
7853
|
+
conversationsGetPost: (data: ConversationsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any>>;
|
|
7854
|
+
/**
|
|
7855
|
+
* @description Lists the available conversations.
|
|
7856
|
+
*
|
|
7857
|
+
* @tags conversations
|
|
7858
|
+
* @name ConversationsList
|
|
7859
|
+
* @summary List Conversations
|
|
7860
|
+
* @request GET:/conversations.list
|
|
7861
|
+
* @secure
|
|
7862
|
+
*/
|
|
7863
|
+
conversationsList: (query?: {
|
|
7864
|
+
/**
|
|
7865
|
+
* Filters for conversations belonging to any of the provided parts.
|
|
7866
|
+
* @example ["PROD-12345"]
|
|
7867
|
+
*/
|
|
7868
|
+
applies_to_parts?: string[];
|
|
7869
|
+
/**
|
|
7870
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
7871
|
+
* starts from the beginning.
|
|
7872
|
+
*/
|
|
7873
|
+
cursor?: string;
|
|
7874
|
+
/** Filters for conversation that belong to the given groups. */
|
|
7875
|
+
group?: string[];
|
|
7876
|
+
/** Filters for conversations that are created by verified users. */
|
|
7877
|
+
is_creator_verified?: boolean;
|
|
7878
|
+
/** Filters for conversations that are frozen. */
|
|
7879
|
+
is_frozen?: boolean;
|
|
7880
|
+
/** Filters for conversations that are spam. */
|
|
7881
|
+
is_spam?: boolean;
|
|
7882
|
+
/**
|
|
7883
|
+
* The maximum number of conversations to return. The default is '50'.
|
|
7884
|
+
* @format int32
|
|
7885
|
+
*/
|
|
7886
|
+
limit?: number;
|
|
7887
|
+
/**
|
|
7888
|
+
* Filters for conversations where these users are participants.
|
|
7889
|
+
* @example ["DEVU-12345"]
|
|
7890
|
+
*/
|
|
7891
|
+
members?: string[];
|
|
7892
|
+
/**
|
|
7893
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
7894
|
+
* used.
|
|
7895
|
+
*/
|
|
7896
|
+
mode?: ListMode;
|
|
7897
|
+
/**
|
|
7898
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
7899
|
+
* @format date-time
|
|
7900
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
7901
|
+
*/
|
|
7902
|
+
'modified_date.after'?: string;
|
|
7903
|
+
/**
|
|
7904
|
+
* Filters for objects created before the provided timestamp
|
|
7905
|
+
* (inclusive).
|
|
7906
|
+
* @format date-time
|
|
7907
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
7908
|
+
*/
|
|
7909
|
+
'modified_date.before'?: string;
|
|
7910
|
+
/**
|
|
7911
|
+
* Filters for conversations owned by any of these users.
|
|
7912
|
+
* @example ["DEVU-12345"]
|
|
7913
|
+
*/
|
|
7914
|
+
owned_by?: string[];
|
|
7915
|
+
/**
|
|
7916
|
+
* Filters for conversations that are associated with any of the
|
|
7917
|
+
* provided Rev organizations.
|
|
7918
|
+
* @deprecated
|
|
7919
|
+
* @example ["REV-AbCdEfGh"]
|
|
7920
|
+
*/
|
|
7921
|
+
rev_org?: string[];
|
|
7922
|
+
/**
|
|
7923
|
+
* Filters for conversations that are associated with any of the
|
|
7924
|
+
* provided Rev organizations.
|
|
7925
|
+
* @example ["REV-AbCdEfGh"]
|
|
7926
|
+
*/
|
|
7927
|
+
rev_orgs?: string[];
|
|
7928
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
7929
|
+
'sla_summary.stage'?: SlaSummaryStage[];
|
|
7930
|
+
/** Filters for conversations with any of the provided source channels. */
|
|
7931
|
+
source_channel?: string[];
|
|
7932
|
+
/**
|
|
7933
|
+
* Filters for conversations with any of the provided source channels.
|
|
7934
|
+
* @deprecated
|
|
7935
|
+
*/
|
|
7936
|
+
source_channels?: string[];
|
|
7937
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
7938
|
+
'stage.name'?: string[];
|
|
7939
|
+
/**
|
|
7940
|
+
* Filters for conversations with any of the provided tags.
|
|
7941
|
+
* @deprecated
|
|
7942
|
+
* @example ["TAG-12345"]
|
|
7943
|
+
*/
|
|
7944
|
+
tags?: string[];
|
|
7945
|
+
/**
|
|
7946
|
+
* The ID of the tag.
|
|
7947
|
+
* @example "TAG-12345"
|
|
7948
|
+
*/
|
|
7949
|
+
'tags_v2.id'?: string;
|
|
7950
|
+
/**
|
|
7951
|
+
* The value for the object's association with the tag. If specified,
|
|
7952
|
+
* the value must be one that's specified in the tag's allowed values.
|
|
7953
|
+
*/
|
|
7954
|
+
'tags_v2.value'?: string;
|
|
7955
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
|
|
7956
|
+
/**
|
|
7957
|
+
* @description Lists the available conversations.
|
|
7958
|
+
*
|
|
7959
|
+
* @tags conversations
|
|
7960
|
+
* @name ConversationsListPost
|
|
7961
|
+
* @summary List Conversations (POST)
|
|
7962
|
+
* @request POST:/conversations.list
|
|
7963
|
+
* @secure
|
|
7964
|
+
*/
|
|
7965
|
+
conversationsListPost: (data: ConversationsListRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
|
|
7966
|
+
/**
|
|
7967
|
+
* @description Updates the requested conversation.
|
|
7968
|
+
*
|
|
7969
|
+
* @tags conversations
|
|
7970
|
+
* @name ConversationsUpdate
|
|
7971
|
+
* @summary Update Conversation
|
|
7972
|
+
* @request POST:/conversations.update
|
|
7973
|
+
* @secure
|
|
7974
|
+
*/
|
|
7975
|
+
conversationsUpdate: (data: ConversationsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsUpdateResponse, any>>;
|
|
6078
7976
|
/**
|
|
6079
7977
|
* @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.
|
|
6080
7978
|
*
|
|
6081
|
-
* @tags auth-
|
|
7979
|
+
* @tags auth-connections, dev-orgs
|
|
6082
7980
|
* @name DevOrgAuthConnectionsCreate
|
|
6083
7981
|
* @summary Create Dev Orgs Auth Connection
|
|
6084
7982
|
* @request POST:/dev-orgs.auth-connections.create
|
|
@@ -6088,7 +7986,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6088
7986
|
/**
|
|
6089
7987
|
* @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.
|
|
6090
7988
|
*
|
|
6091
|
-
* @tags auth-
|
|
7989
|
+
* @tags auth-connections, dev-orgs
|
|
6092
7990
|
* @name DevOrgAuthConnectionsDelete
|
|
6093
7991
|
* @summary Delete Dev Orgs Auth Connection
|
|
6094
7992
|
* @request POST:/dev-orgs.auth-connections.delete
|
|
@@ -6098,7 +7996,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6098
7996
|
/**
|
|
6099
7997
|
* @description Retrieves the details for an authentication connection.
|
|
6100
7998
|
*
|
|
6101
|
-
* @tags auth-
|
|
7999
|
+
* @tags auth-connections, dev-orgs
|
|
6102
8000
|
* @name DevOrgAuthConnectionsGet
|
|
6103
8001
|
* @summary Get Dev Orgs Auth Connection
|
|
6104
8002
|
* @request GET:/dev-orgs.auth-connections.get
|
|
@@ -6111,7 +8009,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6111
8009
|
/**
|
|
6112
8010
|
* @description Retrieves the details for an authentication connection.
|
|
6113
8011
|
*
|
|
6114
|
-
* @tags auth-
|
|
8012
|
+
* @tags auth-connections, dev-orgs
|
|
6115
8013
|
* @name DevOrgAuthConnectionsGetPost
|
|
6116
8014
|
* @summary Get Dev Orgs Auth Connection (POST)
|
|
6117
8015
|
* @request POST:/dev-orgs.auth-connections.get
|
|
@@ -6121,7 +8019,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6121
8019
|
/**
|
|
6122
8020
|
* @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.
|
|
6123
8021
|
*
|
|
6124
|
-
* @tags auth-
|
|
8022
|
+
* @tags auth-connections, dev-orgs
|
|
6125
8023
|
* @name DevOrgAuthConnectionsList
|
|
6126
8024
|
* @summary List Dev Orgs Auth Connections
|
|
6127
8025
|
* @request GET:/dev-orgs.auth-connections.list
|
|
@@ -6131,7 +8029,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6131
8029
|
/**
|
|
6132
8030
|
* @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.
|
|
6133
8031
|
*
|
|
6134
|
-
* @tags auth-
|
|
8032
|
+
* @tags auth-connections, dev-orgs
|
|
6135
8033
|
* @name DevOrgAuthConnectionsListPost
|
|
6136
8034
|
* @summary List Dev Orgs Auth Connections (POST)
|
|
6137
8035
|
* @request POST:/dev-orgs.auth-connections.list
|
|
@@ -6141,7 +8039,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6141
8039
|
/**
|
|
6142
8040
|
* @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.
|
|
6143
8041
|
*
|
|
6144
|
-
* @tags auth-
|
|
8042
|
+
* @tags auth-connections, dev-orgs
|
|
6145
8043
|
* @name DevOrgAuthConnectionsToggle
|
|
6146
8044
|
* @summary Toggle Dev Orgs Auth Connections
|
|
6147
8045
|
* @request POST:/dev-orgs.auth-connections.toggle
|
|
@@ -6151,7 +8049,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6151
8049
|
/**
|
|
6152
8050
|
* @description Updates an authentication connection.
|
|
6153
8051
|
*
|
|
6154
|
-
* @tags auth-
|
|
8052
|
+
* @tags auth-connections, dev-orgs
|
|
6155
8053
|
* @name DevOrgAuthConnectionsUpdate
|
|
6156
8054
|
* @summary Update Dev Orgs Auth Connection
|
|
6157
8055
|
* @request POST:/dev-orgs.auth-connections.update
|
|
@@ -6247,10 +8145,178 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6247
8145
|
* @secure
|
|
6248
8146
|
*/
|
|
6249
8147
|
devUsersSelfPost: (data: DevUsersSelfRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any>>;
|
|
8148
|
+
/**
|
|
8149
|
+
* @description Updates the authenticated user.
|
|
8150
|
+
*
|
|
8151
|
+
* @tags dev-users
|
|
8152
|
+
* @name DevUsersSelfUpdate
|
|
8153
|
+
* @summary Update Dev Users Self
|
|
8154
|
+
* @request POST:/dev-users.self.update
|
|
8155
|
+
* @secure
|
|
8156
|
+
*/
|
|
8157
|
+
devUsersSelfUpdate: (data: DevUsersSelfUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any>>;
|
|
8158
|
+
/**
|
|
8159
|
+
* @description Updates the user corresponding to the input Id.
|
|
8160
|
+
*
|
|
8161
|
+
* @tags dev-users
|
|
8162
|
+
* @name DevUsersUpdate
|
|
8163
|
+
* @summary Update Dev User
|
|
8164
|
+
* @request POST:/dev-users.update
|
|
8165
|
+
* @secure
|
|
8166
|
+
*/
|
|
8167
|
+
devUsersUpdate: (data: DevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any>>;
|
|
8168
|
+
/**
|
|
8169
|
+
* @description Creates a new group. A group is a collection of users.
|
|
8170
|
+
*
|
|
8171
|
+
* @tags groups
|
|
8172
|
+
* @name GroupsCreate
|
|
8173
|
+
* @summary Create Group
|
|
8174
|
+
* @request POST:/groups.create
|
|
8175
|
+
* @secure
|
|
8176
|
+
*/
|
|
8177
|
+
groupsCreate: (data: GroupsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsCreateResponse, any>>;
|
|
8178
|
+
/**
|
|
8179
|
+
* @description Gets the requested group.
|
|
8180
|
+
*
|
|
8181
|
+
* @tags groups
|
|
8182
|
+
* @name GroupsGet
|
|
8183
|
+
* @summary Get Group
|
|
8184
|
+
* @request GET:/groups.get
|
|
8185
|
+
* @secure
|
|
8186
|
+
*/
|
|
8187
|
+
groupsGet: (query: {
|
|
8188
|
+
/** The ID of the group to get. */
|
|
8189
|
+
id: string;
|
|
8190
|
+
}, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any>>;
|
|
8191
|
+
/**
|
|
8192
|
+
* @description Gets the requested group.
|
|
8193
|
+
*
|
|
8194
|
+
* @tags groups
|
|
8195
|
+
* @name GroupsGetPost
|
|
8196
|
+
* @summary Get Group (POST)
|
|
8197
|
+
* @request POST:/groups.get
|
|
8198
|
+
* @secure
|
|
8199
|
+
*/
|
|
8200
|
+
groupsGetPost: (data: GroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any>>;
|
|
8201
|
+
/**
|
|
8202
|
+
* @description Lists the available groups.
|
|
8203
|
+
*
|
|
8204
|
+
* @tags groups
|
|
8205
|
+
* @name GroupsList
|
|
8206
|
+
* @summary List Groups
|
|
8207
|
+
* @request GET:/groups.list
|
|
8208
|
+
* @secure
|
|
8209
|
+
*/
|
|
8210
|
+
groupsList: (query?: {
|
|
8211
|
+
/**
|
|
8212
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
8213
|
+
* starts from the beginning.
|
|
8214
|
+
*/
|
|
8215
|
+
cursor?: string;
|
|
8216
|
+
/** Filters the groups based on the group type. */
|
|
8217
|
+
group_type?: GroupType[];
|
|
8218
|
+
/** Filter groups by ingestion source(s). */
|
|
8219
|
+
ingestion_source?: GroupIngestionSource[];
|
|
8220
|
+
/** Whether to fetch default or custom groups. */
|
|
8221
|
+
is_default?: boolean;
|
|
8222
|
+
/**
|
|
8223
|
+
* The maximum number of groups to return. The default is '50'.
|
|
8224
|
+
* @format int32
|
|
8225
|
+
*/
|
|
8226
|
+
limit?: number;
|
|
8227
|
+
/** Filters the groups on basis of member type. */
|
|
8228
|
+
member_type?: GroupMemberType[];
|
|
8229
|
+
/**
|
|
8230
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
8231
|
+
* used.
|
|
8232
|
+
*/
|
|
8233
|
+
mode?: ListMode;
|
|
8234
|
+
/** Comma-separated fields to sort the groups by. */
|
|
8235
|
+
sort_by?: string[];
|
|
8236
|
+
}, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any>>;
|
|
8237
|
+
/**
|
|
8238
|
+
* @description Lists the available groups.
|
|
8239
|
+
*
|
|
8240
|
+
* @tags groups
|
|
8241
|
+
* @name GroupsListPost
|
|
8242
|
+
* @summary List Groups (POST)
|
|
8243
|
+
* @request POST:/groups.list
|
|
8244
|
+
* @secure
|
|
8245
|
+
*/
|
|
8246
|
+
groupsListPost: (data: GroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any>>;
|
|
8247
|
+
/**
|
|
8248
|
+
* @description Adds a member to a group.
|
|
8249
|
+
*
|
|
8250
|
+
* @tags groups
|
|
8251
|
+
* @name GroupMembersAdd
|
|
8252
|
+
* @summary Add Groups Members
|
|
8253
|
+
* @request POST:/groups.members.add
|
|
8254
|
+
* @secure
|
|
8255
|
+
*/
|
|
8256
|
+
groupMembersAdd: (data: GroupMembersAddRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
8257
|
+
/**
|
|
8258
|
+
* @description Lists the members in a group.
|
|
8259
|
+
*
|
|
8260
|
+
* @tags groups
|
|
8261
|
+
* @name GroupMembersList
|
|
8262
|
+
* @summary List Groups Members
|
|
8263
|
+
* @request GET:/groups.members.list
|
|
8264
|
+
* @secure
|
|
8265
|
+
*/
|
|
8266
|
+
groupMembersList: (query: {
|
|
8267
|
+
/** ID of the group for which to list members. */
|
|
8268
|
+
group: string;
|
|
8269
|
+
/**
|
|
8270
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
8271
|
+
* starts from the beginning.
|
|
8272
|
+
*/
|
|
8273
|
+
cursor?: string;
|
|
8274
|
+
/**
|
|
8275
|
+
* The maximum number of members to return. If not set, then the default
|
|
8276
|
+
* is '50'.
|
|
8277
|
+
* @format int32
|
|
8278
|
+
*/
|
|
8279
|
+
limit?: number;
|
|
8280
|
+
/**
|
|
8281
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
8282
|
+
* used.
|
|
8283
|
+
*/
|
|
8284
|
+
mode?: ListMode;
|
|
8285
|
+
}, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any>>;
|
|
8286
|
+
/**
|
|
8287
|
+
* @description Lists the members in a group.
|
|
8288
|
+
*
|
|
8289
|
+
* @tags groups
|
|
8290
|
+
* @name GroupMembersListPost
|
|
8291
|
+
* @summary List Groups Members (POST)
|
|
8292
|
+
* @request POST:/groups.members.list
|
|
8293
|
+
* @secure
|
|
8294
|
+
*/
|
|
8295
|
+
groupMembersListPost: (data: GroupMembersListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any>>;
|
|
8296
|
+
/**
|
|
8297
|
+
* @description Removes a member from a group.
|
|
8298
|
+
*
|
|
8299
|
+
* @tags groups
|
|
8300
|
+
* @name GroupMembersRemove
|
|
8301
|
+
* @summary Remove Groups Members
|
|
8302
|
+
* @request POST:/groups.members.remove
|
|
8303
|
+
* @secure
|
|
8304
|
+
*/
|
|
8305
|
+
groupMembersRemove: (data: GroupMembersRemoveRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
8306
|
+
/**
|
|
8307
|
+
* @description Updates the requested group.
|
|
8308
|
+
*
|
|
8309
|
+
* @tags groups
|
|
8310
|
+
* @name GroupsUpdate
|
|
8311
|
+
* @summary Update Group
|
|
8312
|
+
* @request POST:/groups.update
|
|
8313
|
+
* @secure
|
|
8314
|
+
*/
|
|
8315
|
+
groupsUpdate: (data: GroupsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsUpdateResponse, any>>;
|
|
6250
8316
|
/**
|
|
6251
8317
|
* @description OAuth2 authorization callback.
|
|
6252
8318
|
*
|
|
6253
|
-
* @tags
|
|
8319
|
+
* @tags keyrings
|
|
6254
8320
|
* @name KeyringsCreateCallback
|
|
6255
8321
|
* @summary Authorize Keyrings
|
|
6256
8322
|
* @request GET:/keyrings.authorize
|
|
@@ -6264,13 +8330,116 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6264
8330
|
/**
|
|
6265
8331
|
* @description OAuth2 authorization callback.
|
|
6266
8332
|
*
|
|
6267
|
-
* @tags
|
|
8333
|
+
* @tags keyrings
|
|
6268
8334
|
* @name KeyringsCreateCallbackPost
|
|
6269
8335
|
* @summary Authorize Keyrings (POST)
|
|
6270
8336
|
* @request POST:/keyrings.authorize
|
|
6271
8337
|
* @secure
|
|
6272
8338
|
*/
|
|
6273
8339
|
keyringsCreateCallbackPost: (data: KeyringsCreateCallbackRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
8340
|
+
/**
|
|
8341
|
+
* @description Creates a link between two objects to indicate a relationship.
|
|
8342
|
+
*
|
|
8343
|
+
* @tags links
|
|
8344
|
+
* @name LinksCreate
|
|
8345
|
+
* @summary Create Link
|
|
8346
|
+
* @request POST:/links.create
|
|
8347
|
+
* @secure
|
|
8348
|
+
*/
|
|
8349
|
+
linksCreate: (data: LinksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<LinksCreateResponse, any>>;
|
|
8350
|
+
/**
|
|
8351
|
+
* @description Deletes a link.
|
|
8352
|
+
*
|
|
8353
|
+
* @tags links
|
|
8354
|
+
* @name LinksDelete
|
|
8355
|
+
* @summary Delete Link
|
|
8356
|
+
* @request POST:/links.delete
|
|
8357
|
+
* @secure
|
|
8358
|
+
*/
|
|
8359
|
+
linksDelete: (data: LinksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
8360
|
+
/**
|
|
8361
|
+
* @description Gets the requested link's information.
|
|
8362
|
+
*
|
|
8363
|
+
* @tags links
|
|
8364
|
+
* @name LinksGet
|
|
8365
|
+
* @summary Get Link
|
|
8366
|
+
* @request GET:/links.get
|
|
8367
|
+
* @secure
|
|
8368
|
+
*/
|
|
8369
|
+
linksGet: (query: {
|
|
8370
|
+
/** The requested link's ID. */
|
|
8371
|
+
id: string;
|
|
8372
|
+
}, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any>>;
|
|
8373
|
+
/**
|
|
8374
|
+
* @description Gets the requested link's information.
|
|
8375
|
+
*
|
|
8376
|
+
* @tags links
|
|
8377
|
+
* @name LinksGetPost
|
|
8378
|
+
* @summary Get Link (POST)
|
|
8379
|
+
* @request POST:/links.get
|
|
8380
|
+
* @secure
|
|
8381
|
+
*/
|
|
8382
|
+
linksGetPost: (data: LinksGetRequest, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any>>;
|
|
8383
|
+
/**
|
|
8384
|
+
* @description Lists the available links.
|
|
8385
|
+
*
|
|
8386
|
+
* @tags links
|
|
8387
|
+
* @name LinksList
|
|
8388
|
+
* @summary List Links
|
|
8389
|
+
* @request GET:/links.list
|
|
8390
|
+
* @secure
|
|
8391
|
+
*/
|
|
8392
|
+
linksList: (query: {
|
|
8393
|
+
/** The ID of the object to list the links for. */
|
|
8394
|
+
object: string;
|
|
8395
|
+
/**
|
|
8396
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
8397
|
+
* starts from the beginning.
|
|
8398
|
+
*/
|
|
8399
|
+
cursor?: string;
|
|
8400
|
+
/**
|
|
8401
|
+
* The direction of the links to list, otherwise if not present, then
|
|
8402
|
+
* links in both directions (source and target) are included.
|
|
8403
|
+
*/
|
|
8404
|
+
direction?: LinksDirection;
|
|
8405
|
+
/**
|
|
8406
|
+
* The maximum number of links to return. If not set, then the default
|
|
8407
|
+
* is '50'.
|
|
8408
|
+
* @format int32
|
|
8409
|
+
*/
|
|
8410
|
+
limit?: number;
|
|
8411
|
+
/**
|
|
8412
|
+
* The link type(s) to filter for, otherwise if not present, all link
|
|
8413
|
+
* types are included.
|
|
8414
|
+
*/
|
|
8415
|
+
link_type?: LinkType[];
|
|
8416
|
+
/**
|
|
8417
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
8418
|
+
* used.
|
|
8419
|
+
*/
|
|
8420
|
+
mode?: ListMode;
|
|
8421
|
+
/**
|
|
8422
|
+
* The object types to filter for, otherwise if not present, all object
|
|
8423
|
+
* types are included.
|
|
8424
|
+
*/
|
|
8425
|
+
object_types?: LinkEndpointType[];
|
|
8426
|
+
/**
|
|
8427
|
+
* The link types to filter for, otherwise if not present, all link
|
|
8428
|
+
* types are included.
|
|
8429
|
+
* @deprecated
|
|
8430
|
+
*/
|
|
8431
|
+
types?: LinkType[];
|
|
8432
|
+
}, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
|
|
8433
|
+
/**
|
|
8434
|
+
* @description Lists the available links.
|
|
8435
|
+
*
|
|
8436
|
+
* @tags links
|
|
8437
|
+
* @name LinksListPost
|
|
8438
|
+
* @summary List Links (POST)
|
|
8439
|
+
* @request POST:/links.list
|
|
8440
|
+
* @secure
|
|
8441
|
+
*/
|
|
8442
|
+
linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
|
|
6274
8443
|
/**
|
|
6275
8444
|
* @description Lists metric definitions matching a filter.
|
|
6276
8445
|
*
|
|
@@ -6574,6 +8743,166 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6574
8743
|
* @secure
|
|
6575
8744
|
*/
|
|
6576
8745
|
revOrgsUpdate: (data: RevOrgsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsUpdateResponse, any>>;
|
|
8746
|
+
/**
|
|
8747
|
+
* @description Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization.
|
|
8748
|
+
*
|
|
8749
|
+
* @tags rev-users
|
|
8750
|
+
* @name RevUsersCreate
|
|
8751
|
+
* @summary Create Rev User
|
|
8752
|
+
* @request POST:/rev-users.create
|
|
8753
|
+
* @secure
|
|
8754
|
+
*/
|
|
8755
|
+
revUsersCreate: (data: RevUsersCreateRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersCreateResponse, any>>;
|
|
8756
|
+
/**
|
|
8757
|
+
* @description Deletes a Rev user.
|
|
8758
|
+
*
|
|
8759
|
+
* @tags rev-users
|
|
8760
|
+
* @name RevUsersDelete
|
|
8761
|
+
* @summary Delete Rev User
|
|
8762
|
+
* @request POST:/rev-users.delete
|
|
8763
|
+
* @secure
|
|
8764
|
+
*/
|
|
8765
|
+
revUsersDelete: (data: RevUsersDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
8766
|
+
/**
|
|
8767
|
+
* @description Returns the Rev user of a Rev organization by its ID.
|
|
8768
|
+
*
|
|
8769
|
+
* @tags rev-users
|
|
8770
|
+
* @name RevUsersGet
|
|
8771
|
+
* @summary Get Rev User
|
|
8772
|
+
* @request GET:/rev-users.get
|
|
8773
|
+
* @secure
|
|
8774
|
+
*/
|
|
8775
|
+
revUsersGet: (query: {
|
|
8776
|
+
/** The ID of Rev user to be retrieved. */
|
|
8777
|
+
id: string;
|
|
8778
|
+
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any>>;
|
|
8779
|
+
/**
|
|
8780
|
+
* @description Returns the Rev user of a Rev organization by its ID.
|
|
8781
|
+
*
|
|
8782
|
+
* @tags rev-users
|
|
8783
|
+
* @name RevUsersGetPost
|
|
8784
|
+
* @summary Get Rev User (POST)
|
|
8785
|
+
* @request POST:/rev-users.get
|
|
8786
|
+
* @secure
|
|
8787
|
+
*/
|
|
8788
|
+
revUsersGetPost: (data: RevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any>>;
|
|
8789
|
+
/**
|
|
8790
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization.
|
|
8791
|
+
*
|
|
8792
|
+
* @tags rev-users
|
|
8793
|
+
* @name RevUsersList
|
|
8794
|
+
* @summary List Rev Users
|
|
8795
|
+
* @request GET:/rev-users.list
|
|
8796
|
+
* @secure
|
|
8797
|
+
*/
|
|
8798
|
+
revUsersList: (query?: {
|
|
8799
|
+
/**
|
|
8800
|
+
* Filters for Rev users with specified associations
|
|
8801
|
+
* (account/workspace).
|
|
8802
|
+
*/
|
|
8803
|
+
associations?: string[];
|
|
8804
|
+
/** Filters for Rev users that were created by the specified user(s). */
|
|
8805
|
+
created_by?: string[];
|
|
8806
|
+
/**
|
|
8807
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
8808
|
+
* @format date-time
|
|
8809
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8810
|
+
*/
|
|
8811
|
+
'created_date.after'?: string;
|
|
8812
|
+
/**
|
|
8813
|
+
* Filters for objects created before the provided timestamp
|
|
8814
|
+
* (inclusive).
|
|
8815
|
+
* @format date-time
|
|
8816
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8817
|
+
*/
|
|
8818
|
+
'created_date.before'?: string;
|
|
8819
|
+
/**
|
|
8820
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
8821
|
+
* starts from the beginning.
|
|
8822
|
+
*/
|
|
8823
|
+
cursor?: string;
|
|
8824
|
+
/** List of emails of Rev users to be filtered. */
|
|
8825
|
+
email?: string[];
|
|
8826
|
+
/** List of external refs to filter Rev users for. */
|
|
8827
|
+
external_ref?: string[];
|
|
8828
|
+
/** Value of is_verified field to filter the Rev users. */
|
|
8829
|
+
is_verified?: boolean;
|
|
8830
|
+
/**
|
|
8831
|
+
* The maximum number of Rev users to return. The default is '50'.
|
|
8832
|
+
* @format int32
|
|
8833
|
+
*/
|
|
8834
|
+
limit?: number;
|
|
8835
|
+
/**
|
|
8836
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
8837
|
+
* used.
|
|
8838
|
+
*/
|
|
8839
|
+
mode?: ListMode;
|
|
8840
|
+
/**
|
|
8841
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
8842
|
+
* @format date-time
|
|
8843
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8844
|
+
*/
|
|
8845
|
+
'modified_date.after'?: string;
|
|
8846
|
+
/**
|
|
8847
|
+
* Filters for objects created before the provided timestamp
|
|
8848
|
+
* (inclusive).
|
|
8849
|
+
* @format date-time
|
|
8850
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8851
|
+
*/
|
|
8852
|
+
'modified_date.before'?: string;
|
|
8853
|
+
/** List of phone numbers, in E.164 format, to filter Rev users on. */
|
|
8854
|
+
phone_numbers?: string[];
|
|
8855
|
+
/**
|
|
8856
|
+
* List of IDs of Rev organizations to be filtered.
|
|
8857
|
+
* @example ["REV-AbCdEfGh"]
|
|
8858
|
+
*/
|
|
8859
|
+
rev_org?: string[];
|
|
8860
|
+
/** Fields to sort the Rev users by and the direction to sort them. */
|
|
8861
|
+
sort_by?: string[];
|
|
8862
|
+
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
|
|
8863
|
+
/**
|
|
8864
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization.
|
|
8865
|
+
*
|
|
8866
|
+
* @tags rev-users
|
|
8867
|
+
* @name RevUsersListPost
|
|
8868
|
+
* @summary List Rev Users (POST)
|
|
8869
|
+
* @request POST:/rev-users.list
|
|
8870
|
+
* @secure
|
|
8871
|
+
*/
|
|
8872
|
+
revUsersListPost: (data: RevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
|
|
8873
|
+
/**
|
|
8874
|
+
* @description Updates a Rev user.
|
|
8875
|
+
*
|
|
8876
|
+
* @tags rev-users
|
|
8877
|
+
* @name RevUsersUpdate
|
|
8878
|
+
* @summary Update Rev User
|
|
8879
|
+
* @request POST:/rev-users.update
|
|
8880
|
+
* @secure
|
|
8881
|
+
*/
|
|
8882
|
+
revUsersUpdate: (data: RevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersUpdateResponse, any>>;
|
|
8883
|
+
/**
|
|
8884
|
+
* @description Gets a service account.
|
|
8885
|
+
*
|
|
8886
|
+
* @tags service-accounts
|
|
8887
|
+
* @name ServiceAccountsGet
|
|
8888
|
+
* @summary Get Service Account
|
|
8889
|
+
* @request GET:/service-accounts.get
|
|
8890
|
+
* @secure
|
|
8891
|
+
*/
|
|
8892
|
+
serviceAccountsGet: (query: {
|
|
8893
|
+
/** The ID of the requested service account. */
|
|
8894
|
+
id: string;
|
|
8895
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any>>;
|
|
8896
|
+
/**
|
|
8897
|
+
* @description Gets a service account.
|
|
8898
|
+
*
|
|
8899
|
+
* @tags service-accounts
|
|
8900
|
+
* @name ServiceAccountsGetPost
|
|
8901
|
+
* @summary Get Service Account (POST)
|
|
8902
|
+
* @request POST:/service-accounts.get
|
|
8903
|
+
* @secure
|
|
8904
|
+
*/
|
|
8905
|
+
serviceAccountsGetPost: (data: ServiceAccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any>>;
|
|
6577
8906
|
/**
|
|
6578
8907
|
* @description Gets an SLA tracker.
|
|
6579
8908
|
*
|
|
@@ -6777,6 +9106,55 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6777
9106
|
* @secure
|
|
6778
9107
|
*/
|
|
6779
9108
|
slasUpdate: (data: SlasUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SlasUpdateResponse, any>>;
|
|
9109
|
+
/**
|
|
9110
|
+
* @description Lists system users within your organization.
|
|
9111
|
+
*
|
|
9112
|
+
* @tags sys-users
|
|
9113
|
+
* @name SysUsersList
|
|
9114
|
+
* @summary List Sys Users
|
|
9115
|
+
* @request GET:/sys-users.list
|
|
9116
|
+
* @secure
|
|
9117
|
+
*/
|
|
9118
|
+
sysUsersList: (query?: {
|
|
9119
|
+
/**
|
|
9120
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
9121
|
+
* starts from the beginning.
|
|
9122
|
+
*/
|
|
9123
|
+
cursor?: string;
|
|
9124
|
+
/**
|
|
9125
|
+
* The maximum number of system users to return. Value can range from
|
|
9126
|
+
* '1' to '100', with a default of '50'.
|
|
9127
|
+
* @format int32
|
|
9128
|
+
*/
|
|
9129
|
+
limit?: number;
|
|
9130
|
+
/**
|
|
9131
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
9132
|
+
* used.
|
|
9133
|
+
*/
|
|
9134
|
+
mode?: ListMode;
|
|
9135
|
+
/** Fields to sort the system users by and the direction to sort them. */
|
|
9136
|
+
sort_by?: string[];
|
|
9137
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any>>;
|
|
9138
|
+
/**
|
|
9139
|
+
* @description Lists system users within your organization.
|
|
9140
|
+
*
|
|
9141
|
+
* @tags sys-users
|
|
9142
|
+
* @name SysUsersListPost
|
|
9143
|
+
* @summary List Sys Users (POST)
|
|
9144
|
+
* @request POST:/sys-users.list
|
|
9145
|
+
* @secure
|
|
9146
|
+
*/
|
|
9147
|
+
sysUsersListPost: (data: SysUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any>>;
|
|
9148
|
+
/**
|
|
9149
|
+
* @description Updates the system user.
|
|
9150
|
+
*
|
|
9151
|
+
* @tags sys-users
|
|
9152
|
+
* @name SysUsersUpdate
|
|
9153
|
+
* @summary Update Sys User
|
|
9154
|
+
* @request POST:/sys-users.update
|
|
9155
|
+
* @secure
|
|
9156
|
+
*/
|
|
9157
|
+
sysUsersUpdate: (data: SysUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersUpdateResponse, any>>;
|
|
6780
9158
|
/**
|
|
6781
9159
|
* @description Creates a new tag, which is used to create associations between objects and a logical concept denoted by the tag's name.
|
|
6782
9160
|
*
|