@devrev/typescript-sdk 1.1.5 → 1.1.7
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.
|
@@ -33,17 +33,52 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
33
33
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
34
34
|
};
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.
|
|
36
|
+
exports.HttpClient = exports.ContentType = exports.WorkType = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TaskPriority = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentType = exports.ConversationsCreateRequestTypeValue = exports.ArticleStatus = exports.AccessLevel = void 0;
|
|
37
|
+
exports.Api = void 0;
|
|
38
|
+
var AccessLevel;
|
|
39
|
+
(function (AccessLevel) {
|
|
40
|
+
AccessLevel["External"] = "external";
|
|
41
|
+
AccessLevel["Internal"] = "internal";
|
|
42
|
+
AccessLevel["Private"] = "private";
|
|
43
|
+
AccessLevel["Public"] = "public";
|
|
44
|
+
AccessLevel["Restricted"] = "restricted";
|
|
45
|
+
})(AccessLevel = exports.AccessLevel || (exports.AccessLevel = {}));
|
|
46
|
+
/** Status of the article. */
|
|
47
|
+
var ArticleStatus;
|
|
48
|
+
(function (ArticleStatus) {
|
|
49
|
+
ArticleStatus["Archived"] = "archived";
|
|
50
|
+
ArticleStatus["Draft"] = "draft";
|
|
51
|
+
ArticleStatus["Published"] = "published";
|
|
52
|
+
ArticleStatus["ReviewNeeded"] = "review_needed";
|
|
53
|
+
})(ArticleStatus = exports.ArticleStatus || (exports.ArticleStatus = {}));
|
|
37
54
|
var ConversationsCreateRequestTypeValue;
|
|
38
55
|
(function (ConversationsCreateRequestTypeValue) {
|
|
39
56
|
ConversationsCreateRequestTypeValue["Support"] = "support";
|
|
40
57
|
})(ConversationsCreateRequestTypeValue = exports.ConversationsCreateRequestTypeValue || (exports.ConversationsCreateRequestTypeValue = {}));
|
|
58
|
+
var CustomSchemaFragmentType;
|
|
59
|
+
(function (CustomSchemaFragmentType) {
|
|
60
|
+
CustomSchemaFragmentType["AppFragment"] = "app_fragment";
|
|
61
|
+
CustomSchemaFragmentType["CustomTypeFragment"] = "custom_type_fragment";
|
|
62
|
+
CustomSchemaFragmentType["TenantFragment"] = "tenant_fragment";
|
|
63
|
+
})(CustomSchemaFragmentType = exports.CustomSchemaFragmentType || (exports.CustomSchemaFragmentType = {}));
|
|
41
64
|
var CustomSchemaFragmentsSetRequestType;
|
|
42
65
|
(function (CustomSchemaFragmentsSetRequestType) {
|
|
43
66
|
CustomSchemaFragmentsSetRequestType["AppFragment"] = "app_fragment";
|
|
44
67
|
CustomSchemaFragmentsSetRequestType["CustomTypeFragment"] = "custom_type_fragment";
|
|
45
68
|
CustomSchemaFragmentsSetRequestType["TenantFragment"] = "tenant_fragment";
|
|
46
69
|
})(CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsSetRequestType || (exports.CustomSchemaFragmentsSetRequestType = {}));
|
|
70
|
+
/** Type of date filter. */
|
|
71
|
+
var DateFilterType;
|
|
72
|
+
(function (DateFilterType) {
|
|
73
|
+
DateFilterType["Preset"] = "preset";
|
|
74
|
+
DateFilterType["Range"] = "range";
|
|
75
|
+
})(DateFilterType = exports.DateFilterType || (exports.DateFilterType = {}));
|
|
76
|
+
/** Type of date preset. */
|
|
77
|
+
var DateTimePresetType;
|
|
78
|
+
(function (DateTimePresetType) {
|
|
79
|
+
DateTimePresetType["LastNDays"] = "last_n_days";
|
|
80
|
+
DateTimePresetType["NextNDays"] = "next_n_days";
|
|
81
|
+
})(DateTimePresetType = exports.DateTimePresetType || (exports.DateTimePresetType = {}));
|
|
47
82
|
/** Type of engagement. */
|
|
48
83
|
var EngagementType;
|
|
49
84
|
(function (EngagementType) {
|
|
@@ -385,6 +420,7 @@ var UserType;
|
|
|
385
420
|
(function (UserType) {
|
|
386
421
|
UserType["DevUser"] = "dev_user";
|
|
387
422
|
UserType["RevUser"] = "rev_user";
|
|
423
|
+
UserType["ServiceAccount"] = "service_account";
|
|
388
424
|
UserType["SysUser"] = "sys_user";
|
|
389
425
|
})(UserType = exports.UserType || (exports.UserType = {}));
|
|
390
426
|
var WorkType;
|
|
@@ -502,6 +538,15 @@ class Api extends HttpClient {
|
|
|
502
538
|
* @secure
|
|
503
539
|
*/
|
|
504
540
|
this.accountsExport = (query, params = {}) => this.request(Object.assign({ path: `/accounts.export`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
541
|
+
/**
|
|
542
|
+
* @description Exports a collection of accounts.
|
|
543
|
+
*
|
|
544
|
+
* @tags accounts
|
|
545
|
+
* @name AccountsExportPost
|
|
546
|
+
* @request POST:/accounts.export
|
|
547
|
+
* @secure
|
|
548
|
+
*/
|
|
549
|
+
this.accountsExportPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.export`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
505
550
|
/**
|
|
506
551
|
* @description Retrieves an account's information.
|
|
507
552
|
*
|
|
@@ -511,6 +556,15 @@ class Api extends HttpClient {
|
|
|
511
556
|
* @secure
|
|
512
557
|
*/
|
|
513
558
|
this.accountsGet = (query, params = {}) => this.request(Object.assign({ path: `/accounts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
559
|
+
/**
|
|
560
|
+
* @description Retrieves an account's information.
|
|
561
|
+
*
|
|
562
|
+
* @tags accounts
|
|
563
|
+
* @name AccountsGetPost
|
|
564
|
+
* @request POST:/accounts.get
|
|
565
|
+
* @secure
|
|
566
|
+
*/
|
|
567
|
+
this.accountsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
514
568
|
/**
|
|
515
569
|
* @description Gets a list of accounts.
|
|
516
570
|
*
|
|
@@ -520,6 +574,15 @@ class Api extends HttpClient {
|
|
|
520
574
|
* @secure
|
|
521
575
|
*/
|
|
522
576
|
this.accountsList = (query, params = {}) => this.request(Object.assign({ path: `/accounts.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
577
|
+
/**
|
|
578
|
+
* @description Gets a list of accounts.
|
|
579
|
+
*
|
|
580
|
+
* @tags accounts
|
|
581
|
+
* @name AccountsListPost
|
|
582
|
+
* @request POST:/accounts.list
|
|
583
|
+
* @secure
|
|
584
|
+
*/
|
|
585
|
+
this.accountsListPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
523
586
|
/**
|
|
524
587
|
* @description Updates an account's information.
|
|
525
588
|
*
|
|
@@ -529,6 +592,87 @@ class Api extends HttpClient {
|
|
|
529
592
|
* @secure
|
|
530
593
|
*/
|
|
531
594
|
this.accountsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/accounts.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
595
|
+
/**
|
|
596
|
+
* @description Get count of articles matching given filter.
|
|
597
|
+
*
|
|
598
|
+
* @tags articles
|
|
599
|
+
* @name ArticlesCount
|
|
600
|
+
* @request GET:/articles.count
|
|
601
|
+
* @secure
|
|
602
|
+
*/
|
|
603
|
+
this.articlesCount = (query, params = {}) => this.request(Object.assign({ path: `/articles.count`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
604
|
+
/**
|
|
605
|
+
* @description Get count of articles matching given filter.
|
|
606
|
+
*
|
|
607
|
+
* @tags articles
|
|
608
|
+
* @name ArticlesCountPost
|
|
609
|
+
* @request POST:/articles.count
|
|
610
|
+
* @secure
|
|
611
|
+
*/
|
|
612
|
+
this.articlesCountPost = (data, params = {}) => this.request(Object.assign({ path: `/articles.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
613
|
+
/**
|
|
614
|
+
* @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.
|
|
615
|
+
*
|
|
616
|
+
* @tags articles
|
|
617
|
+
* @name CreateArticle
|
|
618
|
+
* @request POST:/articles.create
|
|
619
|
+
* @secure
|
|
620
|
+
*/
|
|
621
|
+
this.createArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
622
|
+
/**
|
|
623
|
+
* @description Deletes an article.
|
|
624
|
+
*
|
|
625
|
+
* @tags articles
|
|
626
|
+
* @name DeleteArticle
|
|
627
|
+
* @request POST:/articles.delete
|
|
628
|
+
* @secure
|
|
629
|
+
*/
|
|
630
|
+
this.deleteArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
|
|
631
|
+
/**
|
|
632
|
+
* @description Gets an article.
|
|
633
|
+
*
|
|
634
|
+
* @tags articles
|
|
635
|
+
* @name GetArticle
|
|
636
|
+
* @request GET:/articles.get
|
|
637
|
+
* @secure
|
|
638
|
+
*/
|
|
639
|
+
this.getArticle = (query, params = {}) => this.request(Object.assign({ path: `/articles.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
640
|
+
/**
|
|
641
|
+
* @description Gets an article.
|
|
642
|
+
*
|
|
643
|
+
* @tags articles
|
|
644
|
+
* @name GetArticlePost
|
|
645
|
+
* @request POST:/articles.get
|
|
646
|
+
* @secure
|
|
647
|
+
*/
|
|
648
|
+
this.getArticlePost = (data, params = {}) => this.request(Object.assign({ path: `/articles.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
649
|
+
/**
|
|
650
|
+
* @description Lists a collection of articles.
|
|
651
|
+
*
|
|
652
|
+
* @tags articles
|
|
653
|
+
* @name ListArticles
|
|
654
|
+
* @request GET:/articles.list
|
|
655
|
+
* @secure
|
|
656
|
+
*/
|
|
657
|
+
this.listArticles = (query, params = {}) => this.request(Object.assign({ path: `/articles.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
658
|
+
/**
|
|
659
|
+
* @description Lists a collection of articles.
|
|
660
|
+
*
|
|
661
|
+
* @tags articles
|
|
662
|
+
* @name ListArticlesPost
|
|
663
|
+
* @request POST:/articles.list
|
|
664
|
+
* @secure
|
|
665
|
+
*/
|
|
666
|
+
this.listArticlesPost = (data, params = {}) => this.request(Object.assign({ path: `/articles.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
667
|
+
/**
|
|
668
|
+
* @description Updates an article.
|
|
669
|
+
*
|
|
670
|
+
* @tags articles
|
|
671
|
+
* @name UpdateArticle
|
|
672
|
+
* @request POST:/articles.update
|
|
673
|
+
* @secure
|
|
674
|
+
*/
|
|
675
|
+
this.updateArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
532
676
|
/**
|
|
533
677
|
* @description Creates a conversation.
|
|
534
678
|
*
|
|
@@ -556,6 +700,15 @@ class Api extends HttpClient {
|
|
|
556
700
|
* @secure
|
|
557
701
|
*/
|
|
558
702
|
this.conversationsExport = (query, params = {}) => this.request(Object.assign({ path: `/conversations.export`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
703
|
+
/**
|
|
704
|
+
* @description Exports a collection of conversation items.
|
|
705
|
+
*
|
|
706
|
+
* @tags conversations
|
|
707
|
+
* @name ConversationsExportPost
|
|
708
|
+
* @request POST:/conversations.export
|
|
709
|
+
* @secure
|
|
710
|
+
*/
|
|
711
|
+
this.conversationsExportPost = (data, params = {}) => this.request(Object.assign({ path: `/conversations.export`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
559
712
|
/**
|
|
560
713
|
* @description Gets the requested conversation's information.
|
|
561
714
|
*
|
|
@@ -565,6 +718,15 @@ class Api extends HttpClient {
|
|
|
565
718
|
* @secure
|
|
566
719
|
*/
|
|
567
720
|
this.conversationsGet = (query, params = {}) => this.request(Object.assign({ path: `/conversations.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
721
|
+
/**
|
|
722
|
+
* @description Gets the requested conversation's information.
|
|
723
|
+
*
|
|
724
|
+
* @tags conversations
|
|
725
|
+
* @name ConversationsGetPost
|
|
726
|
+
* @request POST:/conversations.get
|
|
727
|
+
* @secure
|
|
728
|
+
*/
|
|
729
|
+
this.conversationsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/conversations.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
568
730
|
/**
|
|
569
731
|
* @description Lists the available conversations.
|
|
570
732
|
*
|
|
@@ -574,6 +736,15 @@ class Api extends HttpClient {
|
|
|
574
736
|
* @secure
|
|
575
737
|
*/
|
|
576
738
|
this.conversationsList = (query, params = {}) => this.request(Object.assign({ path: `/conversations.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
739
|
+
/**
|
|
740
|
+
* @description Lists the available conversations.
|
|
741
|
+
*
|
|
742
|
+
* @tags conversations
|
|
743
|
+
* @name ConversationsListPost
|
|
744
|
+
* @request POST:/conversations.list
|
|
745
|
+
* @secure
|
|
746
|
+
*/
|
|
747
|
+
this.conversationsListPost = (data, params = {}) => this.request(Object.assign({ path: `/conversations.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
577
748
|
/**
|
|
578
749
|
* @description Updates the requested conversation.
|
|
579
750
|
*
|
|
@@ -592,6 +763,15 @@ class Api extends HttpClient {
|
|
|
592
763
|
* @secure
|
|
593
764
|
*/
|
|
594
765
|
this.engagementsCount = (query, params = {}) => this.request(Object.assign({ path: `/engagements.count`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
766
|
+
/**
|
|
767
|
+
* @description Counts the engagement records.
|
|
768
|
+
*
|
|
769
|
+
* @tags engagements
|
|
770
|
+
* @name EngagementsCountPost
|
|
771
|
+
* @request POST:/engagements.count
|
|
772
|
+
* @secure
|
|
773
|
+
*/
|
|
774
|
+
this.engagementsCountPost = (data, params = {}) => this.request(Object.assign({ path: `/engagements.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
595
775
|
/**
|
|
596
776
|
* @description Creates a new engagement record.
|
|
597
777
|
*
|
|
@@ -619,6 +799,15 @@ class Api extends HttpClient {
|
|
|
619
799
|
* @secure
|
|
620
800
|
*/
|
|
621
801
|
this.engagementsGet = (query, params = {}) => this.request(Object.assign({ path: `/engagements.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
802
|
+
/**
|
|
803
|
+
* @description Gets the engagement record.
|
|
804
|
+
*
|
|
805
|
+
* @tags engagements
|
|
806
|
+
* @name EngagementsGetPost
|
|
807
|
+
* @request POST:/engagements.get
|
|
808
|
+
* @secure
|
|
809
|
+
*/
|
|
810
|
+
this.engagementsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/engagements.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
622
811
|
/**
|
|
623
812
|
* @description Lists the engagement records.
|
|
624
813
|
*
|
|
@@ -628,6 +817,15 @@ class Api extends HttpClient {
|
|
|
628
817
|
* @secure
|
|
629
818
|
*/
|
|
630
819
|
this.engagementsList = (query, params = {}) => this.request(Object.assign({ path: `/engagements.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
820
|
+
/**
|
|
821
|
+
* @description Lists the engagement records.
|
|
822
|
+
*
|
|
823
|
+
* @tags engagements
|
|
824
|
+
* @name EngagementsListPost
|
|
825
|
+
* @request POST:/engagements.list
|
|
826
|
+
* @secure
|
|
827
|
+
*/
|
|
828
|
+
this.engagementsListPost = (data, params = {}) => this.request(Object.assign({ path: `/engagements.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
631
829
|
/**
|
|
632
830
|
* @description Updates the engagement record.
|
|
633
831
|
*
|
|
@@ -682,6 +880,15 @@ class Api extends HttpClient {
|
|
|
682
880
|
* @secure
|
|
683
881
|
*/
|
|
684
882
|
this.linksGet = (query, params = {}) => this.request(Object.assign({ path: `/links.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
883
|
+
/**
|
|
884
|
+
* @description Gets the requested link's information.
|
|
885
|
+
*
|
|
886
|
+
* @tags links
|
|
887
|
+
* @name LinksGetPost
|
|
888
|
+
* @request POST:/links.get
|
|
889
|
+
* @secure
|
|
890
|
+
*/
|
|
891
|
+
this.linksGetPost = (data, params = {}) => this.request(Object.assign({ path: `/links.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
685
892
|
/**
|
|
686
893
|
* @description Lists the available links.
|
|
687
894
|
*
|
|
@@ -691,6 +898,15 @@ class Api extends HttpClient {
|
|
|
691
898
|
* @secure
|
|
692
899
|
*/
|
|
693
900
|
this.linksList = (query, params = {}) => this.request(Object.assign({ path: `/links.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
901
|
+
/**
|
|
902
|
+
* @description Lists the available links.
|
|
903
|
+
*
|
|
904
|
+
* @tags links
|
|
905
|
+
* @name LinksListPost
|
|
906
|
+
* @request POST:/links.list
|
|
907
|
+
* @secure
|
|
908
|
+
*/
|
|
909
|
+
this.linksListPost = (data, params = {}) => this.request(Object.assign({ path: `/links.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
694
910
|
/**
|
|
695
911
|
* @description Lists metric definitions matching a filter.
|
|
696
912
|
*
|
|
@@ -700,6 +916,15 @@ class Api extends HttpClient {
|
|
|
700
916
|
* @secure
|
|
701
917
|
*/
|
|
702
918
|
this.metricDefinitionsList = (query, params = {}) => this.request(Object.assign({ path: `/metric-definitions.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
919
|
+
/**
|
|
920
|
+
* @description Lists metric definitions matching a filter.
|
|
921
|
+
*
|
|
922
|
+
* @tags slas
|
|
923
|
+
* @name MetricDefinitionsListPost
|
|
924
|
+
* @request POST:/metric-definitions.list
|
|
925
|
+
* @secure
|
|
926
|
+
*/
|
|
927
|
+
this.metricDefinitionsListPost = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
703
928
|
/**
|
|
704
929
|
* @description Creates an organization schedule fragment.
|
|
705
930
|
*
|
|
@@ -718,6 +943,15 @@ class Api extends HttpClient {
|
|
|
718
943
|
* @secure
|
|
719
944
|
*/
|
|
720
945
|
this.orgScheduleFragmentsGet = (query, params = {}) => this.request(Object.assign({ path: `/org-schedule-fragments.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
946
|
+
/**
|
|
947
|
+
* @description Gets an organization schedule fragment.
|
|
948
|
+
*
|
|
949
|
+
* @tags schedules
|
|
950
|
+
* @name OrgScheduleFragmentsGetPost
|
|
951
|
+
* @request POST:/org-schedule-fragments.get
|
|
952
|
+
* @secure
|
|
953
|
+
*/
|
|
954
|
+
this.orgScheduleFragmentsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/org-schedule-fragments.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
721
955
|
/**
|
|
722
956
|
* @description Changes stage of an organization schedule fragment.
|
|
723
957
|
*
|
|
@@ -745,6 +979,15 @@ class Api extends HttpClient {
|
|
|
745
979
|
* @secure
|
|
746
980
|
*/
|
|
747
981
|
this.orgSchedulesGet = (query, params = {}) => this.request(Object.assign({ path: `/org-schedules.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
982
|
+
/**
|
|
983
|
+
* @description Gets an organization schedule.
|
|
984
|
+
*
|
|
985
|
+
* @tags schedules
|
|
986
|
+
* @name OrgSchedulesGetPost
|
|
987
|
+
* @request POST:/org-schedules.get
|
|
988
|
+
* @secure
|
|
989
|
+
*/
|
|
990
|
+
this.orgSchedulesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
748
991
|
/**
|
|
749
992
|
* @description Gets list of organization schedules.
|
|
750
993
|
*
|
|
@@ -754,6 +997,15 @@ class Api extends HttpClient {
|
|
|
754
997
|
* @secure
|
|
755
998
|
*/
|
|
756
999
|
this.orgSchedulesList = (query, params = {}) => this.request(Object.assign({ path: `/org-schedules.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1000
|
+
/**
|
|
1001
|
+
* @description Gets list of organization schedules.
|
|
1002
|
+
*
|
|
1003
|
+
* @tags schedules
|
|
1004
|
+
* @name OrgSchedulesListPost
|
|
1005
|
+
* @request POST:/org-schedules.list
|
|
1006
|
+
* @secure
|
|
1007
|
+
*/
|
|
1008
|
+
this.orgSchedulesListPost = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
757
1009
|
/**
|
|
758
1010
|
* @description Sets next organization schedule fragment which must begin the day the last existing fragment ends.
|
|
759
1011
|
*
|
|
@@ -799,6 +1051,15 @@ class Api extends HttpClient {
|
|
|
799
1051
|
* @secure
|
|
800
1052
|
*/
|
|
801
1053
|
this.revOrgsGet = (query, params = {}) => this.request(Object.assign({ path: `/rev-orgs.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1054
|
+
/**
|
|
1055
|
+
* @description Retrieves the Rev organization's information.
|
|
1056
|
+
*
|
|
1057
|
+
* @tags rev-orgs
|
|
1058
|
+
* @name RevOrgsGetPost
|
|
1059
|
+
* @request POST:/rev-orgs.get
|
|
1060
|
+
* @secure
|
|
1061
|
+
*/
|
|
1062
|
+
this.revOrgsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-orgs.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
802
1063
|
/**
|
|
803
1064
|
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
804
1065
|
*
|
|
@@ -808,6 +1069,15 @@ class Api extends HttpClient {
|
|
|
808
1069
|
* @secure
|
|
809
1070
|
*/
|
|
810
1071
|
this.revOrgsList = (query, params = {}) => this.request(Object.assign({ path: `/rev-orgs.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1072
|
+
/**
|
|
1073
|
+
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
1074
|
+
*
|
|
1075
|
+
* @tags rev-orgs
|
|
1076
|
+
* @name RevOrgsListPost
|
|
1077
|
+
* @request POST:/rev-orgs.list
|
|
1078
|
+
* @secure
|
|
1079
|
+
*/
|
|
1080
|
+
this.revOrgsListPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-orgs.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
811
1081
|
/**
|
|
812
1082
|
* @description Updates the Rev organization's information.
|
|
813
1083
|
*
|
|
@@ -844,6 +1114,15 @@ class Api extends HttpClient {
|
|
|
844
1114
|
* @secure
|
|
845
1115
|
*/
|
|
846
1116
|
this.revUsersGet = (query, params = {}) => this.request(Object.assign({ path: `/rev-users.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1117
|
+
/**
|
|
1118
|
+
* @description Returns the Rev user of a Rev organization by its ID.
|
|
1119
|
+
*
|
|
1120
|
+
* @tags rev-users
|
|
1121
|
+
* @name RevUsersGetPost
|
|
1122
|
+
* @request POST:/rev-users.get
|
|
1123
|
+
* @secure
|
|
1124
|
+
*/
|
|
1125
|
+
this.revUsersGetPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
847
1126
|
/**
|
|
848
1127
|
* @description Links a rev user to a rev org.
|
|
849
1128
|
*
|
|
@@ -862,6 +1141,15 @@ class Api extends HttpClient {
|
|
|
862
1141
|
* @secure
|
|
863
1142
|
*/
|
|
864
1143
|
this.revUsersList = (query, params = {}) => this.request(Object.assign({ path: `/rev-users.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1144
|
+
/**
|
|
1145
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.
|
|
1146
|
+
*
|
|
1147
|
+
* @tags rev-users
|
|
1148
|
+
* @name RevUsersListPost
|
|
1149
|
+
* @request POST:/rev-users.list
|
|
1150
|
+
* @secure
|
|
1151
|
+
*/
|
|
1152
|
+
this.revUsersListPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
865
1153
|
/**
|
|
866
1154
|
* @description Unlinks a rev user from a rev org.
|
|
867
1155
|
*
|
|
@@ -889,6 +1177,15 @@ class Api extends HttpClient {
|
|
|
889
1177
|
* @secure
|
|
890
1178
|
*/
|
|
891
1179
|
this.aggregatedSchemaGet = (query, params = {}) => this.request(Object.assign({ path: `/schemas.aggregated.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1180
|
+
/**
|
|
1181
|
+
* @description Gets the aggregated schema.
|
|
1182
|
+
*
|
|
1183
|
+
* @tags customization
|
|
1184
|
+
* @name AggregatedSchemaGetPost
|
|
1185
|
+
* @request POST:/schemas.aggregated.get
|
|
1186
|
+
* @secure
|
|
1187
|
+
*/
|
|
1188
|
+
this.aggregatedSchemaGetPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.aggregated.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
892
1189
|
/**
|
|
893
1190
|
* @description Gets a custom schema fragment.
|
|
894
1191
|
*
|
|
@@ -898,6 +1195,15 @@ class Api extends HttpClient {
|
|
|
898
1195
|
* @secure
|
|
899
1196
|
*/
|
|
900
1197
|
this.customSchemaFragmentsGet = (query, params = {}) => this.request(Object.assign({ path: `/schemas.custom.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1198
|
+
/**
|
|
1199
|
+
* @description Gets a custom schema fragment.
|
|
1200
|
+
*
|
|
1201
|
+
* @tags customization
|
|
1202
|
+
* @name CustomSchemaFragmentsGetPost
|
|
1203
|
+
* @request POST:/schemas.custom.get
|
|
1204
|
+
* @secure
|
|
1205
|
+
*/
|
|
1206
|
+
this.customSchemaFragmentsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.custom.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
901
1207
|
/**
|
|
902
1208
|
* @description Lists custom schema fragments.
|
|
903
1209
|
*
|
|
@@ -907,6 +1213,15 @@ class Api extends HttpClient {
|
|
|
907
1213
|
* @secure
|
|
908
1214
|
*/
|
|
909
1215
|
this.customSchemaFragmentsList = (query, params = {}) => this.request(Object.assign({ path: `/schemas.custom.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1216
|
+
/**
|
|
1217
|
+
* @description Lists custom schema fragments.
|
|
1218
|
+
*
|
|
1219
|
+
* @tags customization
|
|
1220
|
+
* @name CustomSchemaFragmentsListPost
|
|
1221
|
+
* @request POST:/schemas.custom.list
|
|
1222
|
+
* @secure
|
|
1223
|
+
*/
|
|
1224
|
+
this.customSchemaFragmentsListPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.custom.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
910
1225
|
/**
|
|
911
1226
|
* @description Creates or updates a custom schema fragment.
|
|
912
1227
|
*
|
|
@@ -925,6 +1240,33 @@ class Api extends HttpClient {
|
|
|
925
1240
|
* @secure
|
|
926
1241
|
*/
|
|
927
1242
|
this.subtypesList = (query, params = {}) => this.request(Object.assign({ path: `/schemas.subtypes.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1243
|
+
/**
|
|
1244
|
+
* @description Lists subtypes.
|
|
1245
|
+
*
|
|
1246
|
+
* @tags customization
|
|
1247
|
+
* @name SubtypesListPost
|
|
1248
|
+
* @request POST:/schemas.subtypes.list
|
|
1249
|
+
* @secure
|
|
1250
|
+
*/
|
|
1251
|
+
this.subtypesListPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.subtypes.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1252
|
+
/**
|
|
1253
|
+
* @description Gets a service account.
|
|
1254
|
+
*
|
|
1255
|
+
* @tags service-accounts
|
|
1256
|
+
* @name ServiceAccountsGet
|
|
1257
|
+
* @request GET:/service-accounts.get
|
|
1258
|
+
* @secure
|
|
1259
|
+
*/
|
|
1260
|
+
this.serviceAccountsGet = (query, params = {}) => this.request(Object.assign({ path: `/service-accounts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1261
|
+
/**
|
|
1262
|
+
* @description Gets a service account.
|
|
1263
|
+
*
|
|
1264
|
+
* @tags service-accounts
|
|
1265
|
+
* @name ServiceAccountsGetPost
|
|
1266
|
+
* @request POST:/service-accounts.get
|
|
1267
|
+
* @secure
|
|
1268
|
+
*/
|
|
1269
|
+
this.serviceAccountsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/service-accounts.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
928
1270
|
/**
|
|
929
1271
|
* @description Assigns the SLA to a set of Rev organizations.
|
|
930
1272
|
*
|
|
@@ -952,6 +1294,15 @@ class Api extends HttpClient {
|
|
|
952
1294
|
* @secure
|
|
953
1295
|
*/
|
|
954
1296
|
this.slasGet = (query, params = {}) => this.request(Object.assign({ path: `/slas.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1297
|
+
/**
|
|
1298
|
+
* @description Gets an SLA.
|
|
1299
|
+
*
|
|
1300
|
+
* @tags slas
|
|
1301
|
+
* @name SlasGetPost
|
|
1302
|
+
* @request POST:/slas.get
|
|
1303
|
+
* @secure
|
|
1304
|
+
*/
|
|
1305
|
+
this.slasGetPost = (data, params = {}) => this.request(Object.assign({ path: `/slas.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
955
1306
|
/**
|
|
956
1307
|
* @description Lists SLAs matching a filter.
|
|
957
1308
|
*
|
|
@@ -961,6 +1312,15 @@ class Api extends HttpClient {
|
|
|
961
1312
|
* @secure
|
|
962
1313
|
*/
|
|
963
1314
|
this.slasList = (query, params = {}) => this.request(Object.assign({ path: `/slas.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1315
|
+
/**
|
|
1316
|
+
* @description Lists SLAs matching a filter.
|
|
1317
|
+
*
|
|
1318
|
+
* @tags slas
|
|
1319
|
+
* @name SlasListPost
|
|
1320
|
+
* @request POST:/slas.list
|
|
1321
|
+
* @secure
|
|
1322
|
+
*/
|
|
1323
|
+
this.slasListPost = (data, params = {}) => this.request(Object.assign({ path: `/slas.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
964
1324
|
/**
|
|
965
1325
|
* @description Changes the status of an SLA.
|
|
966
1326
|
*
|
|
@@ -988,6 +1348,15 @@ class Api extends HttpClient {
|
|
|
988
1348
|
* @secure
|
|
989
1349
|
*/
|
|
990
1350
|
this.sysUsersList = (query, params = {}) => this.request(Object.assign({ path: `/sys-users.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1351
|
+
/**
|
|
1352
|
+
* @description Lists system users within your organization.
|
|
1353
|
+
*
|
|
1354
|
+
* @tags sys-users
|
|
1355
|
+
* @name SysUsersListPost
|
|
1356
|
+
* @request POST:/sys-users.list
|
|
1357
|
+
* @secure
|
|
1358
|
+
*/
|
|
1359
|
+
this.sysUsersListPost = (data, params = {}) => this.request(Object.assign({ path: `/sys-users.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
991
1360
|
/**
|
|
992
1361
|
* @description Updates the system user.
|
|
993
1362
|
*
|
|
@@ -1015,6 +1384,15 @@ class Api extends HttpClient {
|
|
|
1015
1384
|
* @secure
|
|
1016
1385
|
*/
|
|
1017
1386
|
this.timelineEntriesList = (query, params = {}) => this.request(Object.assign({ path: `/timeline-entries.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1387
|
+
/**
|
|
1388
|
+
* @description Lists the timeline entries for an object.
|
|
1389
|
+
*
|
|
1390
|
+
* @tags timeline-entries
|
|
1391
|
+
* @name TimelineEntriesListPost
|
|
1392
|
+
* @request POST:/timeline-entries.list
|
|
1393
|
+
* @secure
|
|
1394
|
+
*/
|
|
1395
|
+
this.timelineEntriesListPost = (data, params = {}) => this.request(Object.assign({ path: `/timeline-entries.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1018
1396
|
/**
|
|
1019
1397
|
* @description Creates new work ([issue](https://devrev.ai/docs/product/build), [ticket](https://devrev.ai/docs/product/support)) item. [task](https://docs.devrev.ai/product/tasks) and opportunity work types are supported in the beta version.
|
|
1020
1398
|
*
|
|
@@ -1042,6 +1420,15 @@ class Api extends HttpClient {
|
|
|
1042
1420
|
* @secure
|
|
1043
1421
|
*/
|
|
1044
1422
|
this.worksExport = (query, params = {}) => this.request(Object.assign({ path: `/works.export`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1423
|
+
/**
|
|
1424
|
+
* @description Exports a collection of work items.
|
|
1425
|
+
*
|
|
1426
|
+
* @tags works
|
|
1427
|
+
* @name WorksExportPost
|
|
1428
|
+
* @request POST:/works.export
|
|
1429
|
+
* @secure
|
|
1430
|
+
*/
|
|
1431
|
+
this.worksExportPost = (data, params = {}) => this.request(Object.assign({ path: `/works.export`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1045
1432
|
/**
|
|
1046
1433
|
* @description Gets a work item's information.
|
|
1047
1434
|
*
|
|
@@ -1051,6 +1438,15 @@ class Api extends HttpClient {
|
|
|
1051
1438
|
* @secure
|
|
1052
1439
|
*/
|
|
1053
1440
|
this.worksGet = (query, params = {}) => this.request(Object.assign({ path: `/works.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1441
|
+
/**
|
|
1442
|
+
* @description Gets a work item's information.
|
|
1443
|
+
*
|
|
1444
|
+
* @tags works
|
|
1445
|
+
* @name WorksGetPost
|
|
1446
|
+
* @request POST:/works.get
|
|
1447
|
+
* @secure
|
|
1448
|
+
*/
|
|
1449
|
+
this.worksGetPost = (data, params = {}) => this.request(Object.assign({ path: `/works.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1054
1450
|
/**
|
|
1055
1451
|
* @description Lists a collection of work items.
|
|
1056
1452
|
*
|
|
@@ -1060,6 +1456,15 @@ class Api extends HttpClient {
|
|
|
1060
1456
|
* @secure
|
|
1061
1457
|
*/
|
|
1062
1458
|
this.worksList = (query, params = {}) => this.request(Object.assign({ path: `/works.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1459
|
+
/**
|
|
1460
|
+
* @description Lists a collection of work items.
|
|
1461
|
+
*
|
|
1462
|
+
* @tags works
|
|
1463
|
+
* @name WorksListPost
|
|
1464
|
+
* @request POST:/works.list
|
|
1465
|
+
* @secure
|
|
1466
|
+
*/
|
|
1467
|
+
this.worksListPost = (data, params = {}) => this.request(Object.assign({ path: `/works.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1063
1468
|
/**
|
|
1064
1469
|
* @description Updates a work item's information.
|
|
1065
1470
|
*
|