@devrev/typescript-sdk 1.1.5 → 1.1.6
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,7 +33,7 @@ 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.Api = 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.CustomSchemaFragmentsSetRequestType = exports.ConversationsCreateRequestTypeValue = void 0;
|
|
36
|
+
exports.Api = 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.ConversationsCreateRequestTypeValue = void 0;
|
|
37
37
|
var ConversationsCreateRequestTypeValue;
|
|
38
38
|
(function (ConversationsCreateRequestTypeValue) {
|
|
39
39
|
ConversationsCreateRequestTypeValue["Support"] = "support";
|
|
@@ -44,6 +44,18 @@ var CustomSchemaFragmentsSetRequestType;
|
|
|
44
44
|
CustomSchemaFragmentsSetRequestType["CustomTypeFragment"] = "custom_type_fragment";
|
|
45
45
|
CustomSchemaFragmentsSetRequestType["TenantFragment"] = "tenant_fragment";
|
|
46
46
|
})(CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsSetRequestType || (exports.CustomSchemaFragmentsSetRequestType = {}));
|
|
47
|
+
/** Type of date filter. */
|
|
48
|
+
var DateFilterType;
|
|
49
|
+
(function (DateFilterType) {
|
|
50
|
+
DateFilterType["Preset"] = "preset";
|
|
51
|
+
DateFilterType["Range"] = "range";
|
|
52
|
+
})(DateFilterType = exports.DateFilterType || (exports.DateFilterType = {}));
|
|
53
|
+
/** Type of date preset. */
|
|
54
|
+
var DateTimePresetType;
|
|
55
|
+
(function (DateTimePresetType) {
|
|
56
|
+
DateTimePresetType["LastNDays"] = "last_n_days";
|
|
57
|
+
DateTimePresetType["NextNDays"] = "next_n_days";
|
|
58
|
+
})(DateTimePresetType = exports.DateTimePresetType || (exports.DateTimePresetType = {}));
|
|
47
59
|
/** Type of engagement. */
|
|
48
60
|
var EngagementType;
|
|
49
61
|
(function (EngagementType) {
|
|
@@ -385,6 +397,7 @@ var UserType;
|
|
|
385
397
|
(function (UserType) {
|
|
386
398
|
UserType["DevUser"] = "dev_user";
|
|
387
399
|
UserType["RevUser"] = "rev_user";
|
|
400
|
+
UserType["ServiceAccount"] = "service_account";
|
|
388
401
|
UserType["SysUser"] = "sys_user";
|
|
389
402
|
})(UserType = exports.UserType || (exports.UserType = {}));
|
|
390
403
|
var WorkType;
|
|
@@ -502,6 +515,15 @@ class Api extends HttpClient {
|
|
|
502
515
|
* @secure
|
|
503
516
|
*/
|
|
504
517
|
this.accountsExport = (query, params = {}) => this.request(Object.assign({ path: `/accounts.export`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
518
|
+
/**
|
|
519
|
+
* @description Exports a collection of accounts.
|
|
520
|
+
*
|
|
521
|
+
* @tags accounts
|
|
522
|
+
* @name AccountsExportPost
|
|
523
|
+
* @request POST:/accounts.export
|
|
524
|
+
* @secure
|
|
525
|
+
*/
|
|
526
|
+
this.accountsExportPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.export`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
505
527
|
/**
|
|
506
528
|
* @description Retrieves an account's information.
|
|
507
529
|
*
|
|
@@ -511,6 +533,15 @@ class Api extends HttpClient {
|
|
|
511
533
|
* @secure
|
|
512
534
|
*/
|
|
513
535
|
this.accountsGet = (query, params = {}) => this.request(Object.assign({ path: `/accounts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
536
|
+
/**
|
|
537
|
+
* @description Retrieves an account's information.
|
|
538
|
+
*
|
|
539
|
+
* @tags accounts
|
|
540
|
+
* @name AccountsGetPost
|
|
541
|
+
* @request POST:/accounts.get
|
|
542
|
+
* @secure
|
|
543
|
+
*/
|
|
544
|
+
this.accountsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
514
545
|
/**
|
|
515
546
|
* @description Gets a list of accounts.
|
|
516
547
|
*
|
|
@@ -520,6 +551,15 @@ class Api extends HttpClient {
|
|
|
520
551
|
* @secure
|
|
521
552
|
*/
|
|
522
553
|
this.accountsList = (query, params = {}) => this.request(Object.assign({ path: `/accounts.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
554
|
+
/**
|
|
555
|
+
* @description Gets a list of accounts.
|
|
556
|
+
*
|
|
557
|
+
* @tags accounts
|
|
558
|
+
* @name AccountsListPost
|
|
559
|
+
* @request POST:/accounts.list
|
|
560
|
+
* @secure
|
|
561
|
+
*/
|
|
562
|
+
this.accountsListPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
523
563
|
/**
|
|
524
564
|
* @description Updates an account's information.
|
|
525
565
|
*
|
|
@@ -556,6 +596,15 @@ class Api extends HttpClient {
|
|
|
556
596
|
* @secure
|
|
557
597
|
*/
|
|
558
598
|
this.conversationsExport = (query, params = {}) => this.request(Object.assign({ path: `/conversations.export`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
599
|
+
/**
|
|
600
|
+
* @description Exports a collection of conversation items.
|
|
601
|
+
*
|
|
602
|
+
* @tags conversations
|
|
603
|
+
* @name ConversationsExportPost
|
|
604
|
+
* @request POST:/conversations.export
|
|
605
|
+
* @secure
|
|
606
|
+
*/
|
|
607
|
+
this.conversationsExportPost = (data, params = {}) => this.request(Object.assign({ path: `/conversations.export`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
559
608
|
/**
|
|
560
609
|
* @description Gets the requested conversation's information.
|
|
561
610
|
*
|
|
@@ -565,6 +614,15 @@ class Api extends HttpClient {
|
|
|
565
614
|
* @secure
|
|
566
615
|
*/
|
|
567
616
|
this.conversationsGet = (query, params = {}) => this.request(Object.assign({ path: `/conversations.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
617
|
+
/**
|
|
618
|
+
* @description Gets the requested conversation's information.
|
|
619
|
+
*
|
|
620
|
+
* @tags conversations
|
|
621
|
+
* @name ConversationsGetPost
|
|
622
|
+
* @request POST:/conversations.get
|
|
623
|
+
* @secure
|
|
624
|
+
*/
|
|
625
|
+
this.conversationsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/conversations.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
568
626
|
/**
|
|
569
627
|
* @description Lists the available conversations.
|
|
570
628
|
*
|
|
@@ -574,6 +632,15 @@ class Api extends HttpClient {
|
|
|
574
632
|
* @secure
|
|
575
633
|
*/
|
|
576
634
|
this.conversationsList = (query, params = {}) => this.request(Object.assign({ path: `/conversations.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
635
|
+
/**
|
|
636
|
+
* @description Lists the available conversations.
|
|
637
|
+
*
|
|
638
|
+
* @tags conversations
|
|
639
|
+
* @name ConversationsListPost
|
|
640
|
+
* @request POST:/conversations.list
|
|
641
|
+
* @secure
|
|
642
|
+
*/
|
|
643
|
+
this.conversationsListPost = (data, params = {}) => this.request(Object.assign({ path: `/conversations.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
577
644
|
/**
|
|
578
645
|
* @description Updates the requested conversation.
|
|
579
646
|
*
|
|
@@ -592,6 +659,15 @@ class Api extends HttpClient {
|
|
|
592
659
|
* @secure
|
|
593
660
|
*/
|
|
594
661
|
this.engagementsCount = (query, params = {}) => this.request(Object.assign({ path: `/engagements.count`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
662
|
+
/**
|
|
663
|
+
* @description Counts the engagement records.
|
|
664
|
+
*
|
|
665
|
+
* @tags engagements
|
|
666
|
+
* @name EngagementsCountPost
|
|
667
|
+
* @request POST:/engagements.count
|
|
668
|
+
* @secure
|
|
669
|
+
*/
|
|
670
|
+
this.engagementsCountPost = (data, params = {}) => this.request(Object.assign({ path: `/engagements.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
595
671
|
/**
|
|
596
672
|
* @description Creates a new engagement record.
|
|
597
673
|
*
|
|
@@ -619,6 +695,15 @@ class Api extends HttpClient {
|
|
|
619
695
|
* @secure
|
|
620
696
|
*/
|
|
621
697
|
this.engagementsGet = (query, params = {}) => this.request(Object.assign({ path: `/engagements.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
698
|
+
/**
|
|
699
|
+
* @description Gets the engagement record.
|
|
700
|
+
*
|
|
701
|
+
* @tags engagements
|
|
702
|
+
* @name EngagementsGetPost
|
|
703
|
+
* @request POST:/engagements.get
|
|
704
|
+
* @secure
|
|
705
|
+
*/
|
|
706
|
+
this.engagementsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/engagements.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
622
707
|
/**
|
|
623
708
|
* @description Lists the engagement records.
|
|
624
709
|
*
|
|
@@ -628,6 +713,15 @@ class Api extends HttpClient {
|
|
|
628
713
|
* @secure
|
|
629
714
|
*/
|
|
630
715
|
this.engagementsList = (query, params = {}) => this.request(Object.assign({ path: `/engagements.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
716
|
+
/**
|
|
717
|
+
* @description Lists the engagement records.
|
|
718
|
+
*
|
|
719
|
+
* @tags engagements
|
|
720
|
+
* @name EngagementsListPost
|
|
721
|
+
* @request POST:/engagements.list
|
|
722
|
+
* @secure
|
|
723
|
+
*/
|
|
724
|
+
this.engagementsListPost = (data, params = {}) => this.request(Object.assign({ path: `/engagements.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
631
725
|
/**
|
|
632
726
|
* @description Updates the engagement record.
|
|
633
727
|
*
|
|
@@ -682,6 +776,15 @@ class Api extends HttpClient {
|
|
|
682
776
|
* @secure
|
|
683
777
|
*/
|
|
684
778
|
this.linksGet = (query, params = {}) => this.request(Object.assign({ path: `/links.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
779
|
+
/**
|
|
780
|
+
* @description Gets the requested link's information.
|
|
781
|
+
*
|
|
782
|
+
* @tags links
|
|
783
|
+
* @name LinksGetPost
|
|
784
|
+
* @request POST:/links.get
|
|
785
|
+
* @secure
|
|
786
|
+
*/
|
|
787
|
+
this.linksGetPost = (data, params = {}) => this.request(Object.assign({ path: `/links.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
685
788
|
/**
|
|
686
789
|
* @description Lists the available links.
|
|
687
790
|
*
|
|
@@ -691,6 +794,15 @@ class Api extends HttpClient {
|
|
|
691
794
|
* @secure
|
|
692
795
|
*/
|
|
693
796
|
this.linksList = (query, params = {}) => this.request(Object.assign({ path: `/links.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
797
|
+
/**
|
|
798
|
+
* @description Lists the available links.
|
|
799
|
+
*
|
|
800
|
+
* @tags links
|
|
801
|
+
* @name LinksListPost
|
|
802
|
+
* @request POST:/links.list
|
|
803
|
+
* @secure
|
|
804
|
+
*/
|
|
805
|
+
this.linksListPost = (data, params = {}) => this.request(Object.assign({ path: `/links.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
694
806
|
/**
|
|
695
807
|
* @description Lists metric definitions matching a filter.
|
|
696
808
|
*
|
|
@@ -700,6 +812,15 @@ class Api extends HttpClient {
|
|
|
700
812
|
* @secure
|
|
701
813
|
*/
|
|
702
814
|
this.metricDefinitionsList = (query, params = {}) => this.request(Object.assign({ path: `/metric-definitions.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
815
|
+
/**
|
|
816
|
+
* @description Lists metric definitions matching a filter.
|
|
817
|
+
*
|
|
818
|
+
* @tags slas
|
|
819
|
+
* @name MetricDefinitionsListPost
|
|
820
|
+
* @request POST:/metric-definitions.list
|
|
821
|
+
* @secure
|
|
822
|
+
*/
|
|
823
|
+
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
824
|
/**
|
|
704
825
|
* @description Creates an organization schedule fragment.
|
|
705
826
|
*
|
|
@@ -718,6 +839,15 @@ class Api extends HttpClient {
|
|
|
718
839
|
* @secure
|
|
719
840
|
*/
|
|
720
841
|
this.orgScheduleFragmentsGet = (query, params = {}) => this.request(Object.assign({ path: `/org-schedule-fragments.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
842
|
+
/**
|
|
843
|
+
* @description Gets an organization schedule fragment.
|
|
844
|
+
*
|
|
845
|
+
* @tags schedules
|
|
846
|
+
* @name OrgScheduleFragmentsGetPost
|
|
847
|
+
* @request POST:/org-schedule-fragments.get
|
|
848
|
+
* @secure
|
|
849
|
+
*/
|
|
850
|
+
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
851
|
/**
|
|
722
852
|
* @description Changes stage of an organization schedule fragment.
|
|
723
853
|
*
|
|
@@ -745,6 +875,15 @@ class Api extends HttpClient {
|
|
|
745
875
|
* @secure
|
|
746
876
|
*/
|
|
747
877
|
this.orgSchedulesGet = (query, params = {}) => this.request(Object.assign({ path: `/org-schedules.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
878
|
+
/**
|
|
879
|
+
* @description Gets an organization schedule.
|
|
880
|
+
*
|
|
881
|
+
* @tags schedules
|
|
882
|
+
* @name OrgSchedulesGetPost
|
|
883
|
+
* @request POST:/org-schedules.get
|
|
884
|
+
* @secure
|
|
885
|
+
*/
|
|
886
|
+
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
887
|
/**
|
|
749
888
|
* @description Gets list of organization schedules.
|
|
750
889
|
*
|
|
@@ -754,6 +893,15 @@ class Api extends HttpClient {
|
|
|
754
893
|
* @secure
|
|
755
894
|
*/
|
|
756
895
|
this.orgSchedulesList = (query, params = {}) => this.request(Object.assign({ path: `/org-schedules.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
896
|
+
/**
|
|
897
|
+
* @description Gets list of organization schedules.
|
|
898
|
+
*
|
|
899
|
+
* @tags schedules
|
|
900
|
+
* @name OrgSchedulesListPost
|
|
901
|
+
* @request POST:/org-schedules.list
|
|
902
|
+
* @secure
|
|
903
|
+
*/
|
|
904
|
+
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
905
|
/**
|
|
758
906
|
* @description Sets next organization schedule fragment which must begin the day the last existing fragment ends.
|
|
759
907
|
*
|
|
@@ -799,6 +947,15 @@ class Api extends HttpClient {
|
|
|
799
947
|
* @secure
|
|
800
948
|
*/
|
|
801
949
|
this.revOrgsGet = (query, params = {}) => this.request(Object.assign({ path: `/rev-orgs.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
950
|
+
/**
|
|
951
|
+
* @description Retrieves the Rev organization's information.
|
|
952
|
+
*
|
|
953
|
+
* @tags rev-orgs
|
|
954
|
+
* @name RevOrgsGetPost
|
|
955
|
+
* @request POST:/rev-orgs.get
|
|
956
|
+
* @secure
|
|
957
|
+
*/
|
|
958
|
+
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
959
|
/**
|
|
803
960
|
* @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
961
|
*
|
|
@@ -808,6 +965,15 @@ class Api extends HttpClient {
|
|
|
808
965
|
* @secure
|
|
809
966
|
*/
|
|
810
967
|
this.revOrgsList = (query, params = {}) => this.request(Object.assign({ path: `/rev-orgs.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
968
|
+
/**
|
|
969
|
+
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
970
|
+
*
|
|
971
|
+
* @tags rev-orgs
|
|
972
|
+
* @name RevOrgsListPost
|
|
973
|
+
* @request POST:/rev-orgs.list
|
|
974
|
+
* @secure
|
|
975
|
+
*/
|
|
976
|
+
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
977
|
/**
|
|
812
978
|
* @description Updates the Rev organization's information.
|
|
813
979
|
*
|
|
@@ -844,6 +1010,15 @@ class Api extends HttpClient {
|
|
|
844
1010
|
* @secure
|
|
845
1011
|
*/
|
|
846
1012
|
this.revUsersGet = (query, params = {}) => this.request(Object.assign({ path: `/rev-users.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1013
|
+
/**
|
|
1014
|
+
* @description Returns the Rev user of a Rev organization by its ID.
|
|
1015
|
+
*
|
|
1016
|
+
* @tags rev-users
|
|
1017
|
+
* @name RevUsersGetPost
|
|
1018
|
+
* @request POST:/rev-users.get
|
|
1019
|
+
* @secure
|
|
1020
|
+
*/
|
|
1021
|
+
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
1022
|
/**
|
|
848
1023
|
* @description Links a rev user to a rev org.
|
|
849
1024
|
*
|
|
@@ -862,6 +1037,15 @@ class Api extends HttpClient {
|
|
|
862
1037
|
* @secure
|
|
863
1038
|
*/
|
|
864
1039
|
this.revUsersList = (query, params = {}) => this.request(Object.assign({ path: `/rev-users.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1040
|
+
/**
|
|
1041
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.
|
|
1042
|
+
*
|
|
1043
|
+
* @tags rev-users
|
|
1044
|
+
* @name RevUsersListPost
|
|
1045
|
+
* @request POST:/rev-users.list
|
|
1046
|
+
* @secure
|
|
1047
|
+
*/
|
|
1048
|
+
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
1049
|
/**
|
|
866
1050
|
* @description Unlinks a rev user from a rev org.
|
|
867
1051
|
*
|
|
@@ -889,6 +1073,15 @@ class Api extends HttpClient {
|
|
|
889
1073
|
* @secure
|
|
890
1074
|
*/
|
|
891
1075
|
this.aggregatedSchemaGet = (query, params = {}) => this.request(Object.assign({ path: `/schemas.aggregated.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1076
|
+
/**
|
|
1077
|
+
* @description Gets the aggregated schema.
|
|
1078
|
+
*
|
|
1079
|
+
* @tags customization
|
|
1080
|
+
* @name AggregatedSchemaGetPost
|
|
1081
|
+
* @request POST:/schemas.aggregated.get
|
|
1082
|
+
* @secure
|
|
1083
|
+
*/
|
|
1084
|
+
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
1085
|
/**
|
|
893
1086
|
* @description Gets a custom schema fragment.
|
|
894
1087
|
*
|
|
@@ -898,6 +1091,15 @@ class Api extends HttpClient {
|
|
|
898
1091
|
* @secure
|
|
899
1092
|
*/
|
|
900
1093
|
this.customSchemaFragmentsGet = (query, params = {}) => this.request(Object.assign({ path: `/schemas.custom.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1094
|
+
/**
|
|
1095
|
+
* @description Gets a custom schema fragment.
|
|
1096
|
+
*
|
|
1097
|
+
* @tags customization
|
|
1098
|
+
* @name CustomSchemaFragmentsGetPost
|
|
1099
|
+
* @request POST:/schemas.custom.get
|
|
1100
|
+
* @secure
|
|
1101
|
+
*/
|
|
1102
|
+
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
1103
|
/**
|
|
902
1104
|
* @description Lists custom schema fragments.
|
|
903
1105
|
*
|
|
@@ -907,6 +1109,15 @@ class Api extends HttpClient {
|
|
|
907
1109
|
* @secure
|
|
908
1110
|
*/
|
|
909
1111
|
this.customSchemaFragmentsList = (query, params = {}) => this.request(Object.assign({ path: `/schemas.custom.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1112
|
+
/**
|
|
1113
|
+
* @description Lists custom schema fragments.
|
|
1114
|
+
*
|
|
1115
|
+
* @tags customization
|
|
1116
|
+
* @name CustomSchemaFragmentsListPost
|
|
1117
|
+
* @request POST:/schemas.custom.list
|
|
1118
|
+
* @secure
|
|
1119
|
+
*/
|
|
1120
|
+
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
1121
|
/**
|
|
911
1122
|
* @description Creates or updates a custom schema fragment.
|
|
912
1123
|
*
|
|
@@ -925,6 +1136,33 @@ class Api extends HttpClient {
|
|
|
925
1136
|
* @secure
|
|
926
1137
|
*/
|
|
927
1138
|
this.subtypesList = (query, params = {}) => this.request(Object.assign({ path: `/schemas.subtypes.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1139
|
+
/**
|
|
1140
|
+
* @description Lists subtypes.
|
|
1141
|
+
*
|
|
1142
|
+
* @tags customization
|
|
1143
|
+
* @name SubtypesListPost
|
|
1144
|
+
* @request POST:/schemas.subtypes.list
|
|
1145
|
+
* @secure
|
|
1146
|
+
*/
|
|
1147
|
+
this.subtypesListPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.subtypes.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1148
|
+
/**
|
|
1149
|
+
* @description Gets a service account.
|
|
1150
|
+
*
|
|
1151
|
+
* @tags service-accounts
|
|
1152
|
+
* @name ServiceAccountsGet
|
|
1153
|
+
* @request GET:/service-accounts.get
|
|
1154
|
+
* @secure
|
|
1155
|
+
*/
|
|
1156
|
+
this.serviceAccountsGet = (query, params = {}) => this.request(Object.assign({ path: `/service-accounts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1157
|
+
/**
|
|
1158
|
+
* @description Gets a service account.
|
|
1159
|
+
*
|
|
1160
|
+
* @tags service-accounts
|
|
1161
|
+
* @name ServiceAccountsGetPost
|
|
1162
|
+
* @request POST:/service-accounts.get
|
|
1163
|
+
* @secure
|
|
1164
|
+
*/
|
|
1165
|
+
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
1166
|
/**
|
|
929
1167
|
* @description Assigns the SLA to a set of Rev organizations.
|
|
930
1168
|
*
|
|
@@ -952,6 +1190,15 @@ class Api extends HttpClient {
|
|
|
952
1190
|
* @secure
|
|
953
1191
|
*/
|
|
954
1192
|
this.slasGet = (query, params = {}) => this.request(Object.assign({ path: `/slas.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1193
|
+
/**
|
|
1194
|
+
* @description Gets an SLA.
|
|
1195
|
+
*
|
|
1196
|
+
* @tags slas
|
|
1197
|
+
* @name SlasGetPost
|
|
1198
|
+
* @request POST:/slas.get
|
|
1199
|
+
* @secure
|
|
1200
|
+
*/
|
|
1201
|
+
this.slasGetPost = (data, params = {}) => this.request(Object.assign({ path: `/slas.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
955
1202
|
/**
|
|
956
1203
|
* @description Lists SLAs matching a filter.
|
|
957
1204
|
*
|
|
@@ -961,6 +1208,15 @@ class Api extends HttpClient {
|
|
|
961
1208
|
* @secure
|
|
962
1209
|
*/
|
|
963
1210
|
this.slasList = (query, params = {}) => this.request(Object.assign({ path: `/slas.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1211
|
+
/**
|
|
1212
|
+
* @description Lists SLAs matching a filter.
|
|
1213
|
+
*
|
|
1214
|
+
* @tags slas
|
|
1215
|
+
* @name SlasListPost
|
|
1216
|
+
* @request POST:/slas.list
|
|
1217
|
+
* @secure
|
|
1218
|
+
*/
|
|
1219
|
+
this.slasListPost = (data, params = {}) => this.request(Object.assign({ path: `/slas.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
964
1220
|
/**
|
|
965
1221
|
* @description Changes the status of an SLA.
|
|
966
1222
|
*
|
|
@@ -988,6 +1244,15 @@ class Api extends HttpClient {
|
|
|
988
1244
|
* @secure
|
|
989
1245
|
*/
|
|
990
1246
|
this.sysUsersList = (query, params = {}) => this.request(Object.assign({ path: `/sys-users.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1247
|
+
/**
|
|
1248
|
+
* @description Lists system users within your organization.
|
|
1249
|
+
*
|
|
1250
|
+
* @tags sys-users
|
|
1251
|
+
* @name SysUsersListPost
|
|
1252
|
+
* @request POST:/sys-users.list
|
|
1253
|
+
* @secure
|
|
1254
|
+
*/
|
|
1255
|
+
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
1256
|
/**
|
|
992
1257
|
* @description Updates the system user.
|
|
993
1258
|
*
|
|
@@ -1015,6 +1280,15 @@ class Api extends HttpClient {
|
|
|
1015
1280
|
* @secure
|
|
1016
1281
|
*/
|
|
1017
1282
|
this.timelineEntriesList = (query, params = {}) => this.request(Object.assign({ path: `/timeline-entries.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1283
|
+
/**
|
|
1284
|
+
* @description Lists the timeline entries for an object.
|
|
1285
|
+
*
|
|
1286
|
+
* @tags timeline-entries
|
|
1287
|
+
* @name TimelineEntriesListPost
|
|
1288
|
+
* @request POST:/timeline-entries.list
|
|
1289
|
+
* @secure
|
|
1290
|
+
*/
|
|
1291
|
+
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
1292
|
/**
|
|
1019
1293
|
* @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
1294
|
*
|
|
@@ -1042,6 +1316,15 @@ class Api extends HttpClient {
|
|
|
1042
1316
|
* @secure
|
|
1043
1317
|
*/
|
|
1044
1318
|
this.worksExport = (query, params = {}) => this.request(Object.assign({ path: `/works.export`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1319
|
+
/**
|
|
1320
|
+
* @description Exports a collection of work items.
|
|
1321
|
+
*
|
|
1322
|
+
* @tags works
|
|
1323
|
+
* @name WorksExportPost
|
|
1324
|
+
* @request POST:/works.export
|
|
1325
|
+
* @secure
|
|
1326
|
+
*/
|
|
1327
|
+
this.worksExportPost = (data, params = {}) => this.request(Object.assign({ path: `/works.export`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1045
1328
|
/**
|
|
1046
1329
|
* @description Gets a work item's information.
|
|
1047
1330
|
*
|
|
@@ -1051,6 +1334,15 @@ class Api extends HttpClient {
|
|
|
1051
1334
|
* @secure
|
|
1052
1335
|
*/
|
|
1053
1336
|
this.worksGet = (query, params = {}) => this.request(Object.assign({ path: `/works.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1337
|
+
/**
|
|
1338
|
+
* @description Gets a work item's information.
|
|
1339
|
+
*
|
|
1340
|
+
* @tags works
|
|
1341
|
+
* @name WorksGetPost
|
|
1342
|
+
* @request POST:/works.get
|
|
1343
|
+
* @secure
|
|
1344
|
+
*/
|
|
1345
|
+
this.worksGetPost = (data, params = {}) => this.request(Object.assign({ path: `/works.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1054
1346
|
/**
|
|
1055
1347
|
* @description Lists a collection of work items.
|
|
1056
1348
|
*
|
|
@@ -1060,6 +1352,15 @@ class Api extends HttpClient {
|
|
|
1060
1352
|
* @secure
|
|
1061
1353
|
*/
|
|
1062
1354
|
this.worksList = (query, params = {}) => this.request(Object.assign({ path: `/works.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1355
|
+
/**
|
|
1356
|
+
* @description Lists a collection of work items.
|
|
1357
|
+
*
|
|
1358
|
+
* @tags works
|
|
1359
|
+
* @name WorksListPost
|
|
1360
|
+
* @request POST:/works.list
|
|
1361
|
+
* @secure
|
|
1362
|
+
*/
|
|
1363
|
+
this.worksListPost = (data, params = {}) => this.request(Object.assign({ path: `/works.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1063
1364
|
/**
|
|
1064
1365
|
* @description Updates a work item's information.
|
|
1065
1366
|
*
|
|
@@ -543,6 +543,13 @@ export type DevUser = UserBase & {
|
|
|
543
543
|
};
|
|
544
544
|
/** dev-user-summary */
|
|
545
545
|
export type DevUserSummary = UserBaseSummary;
|
|
546
|
+
/**
|
|
547
|
+
* dev-users-get-response
|
|
548
|
+
* The response to getting the information for the Dev user.
|
|
549
|
+
*/
|
|
550
|
+
export interface DevUsersGetResponse {
|
|
551
|
+
dev_user: DevUser;
|
|
552
|
+
}
|
|
546
553
|
/**
|
|
547
554
|
* dev-users-list-response
|
|
548
555
|
* The response to listing the Dev users.
|
|
@@ -1530,6 +1537,14 @@ export type TimelineEntryBase = AtomBase & {
|
|
|
1530
1537
|
object: string;
|
|
1531
1538
|
/** The type of object that the Timeline entry belongs to. */
|
|
1532
1539
|
object_type?: TimelineEntryObjectType;
|
|
1540
|
+
/**
|
|
1541
|
+
* The visibility of the entry. If 'private', then the entry is only
|
|
1542
|
+
* visible to the creator, 'internal' is visible with the Dev
|
|
1543
|
+
* organization, 'external' is visible to the Dev organzation and Rev
|
|
1544
|
+
* users, and 'public' is visible to all. If not set, then the default
|
|
1545
|
+
* visibility is 'external'.
|
|
1546
|
+
*/
|
|
1547
|
+
visibility?: TimelineEntryVisibility;
|
|
1533
1548
|
};
|
|
1534
1549
|
/** The type of object that the Timeline entry belongs to. */
|
|
1535
1550
|
export declare enum TimelineEntryObjectType {
|
|
@@ -2261,6 +2276,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2261
2276
|
* @secure
|
|
2262
2277
|
*/
|
|
2263
2278
|
devOrgAuthConnectionsUpdate: (data: DevOrgAuthConnectionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsUpdateResponse, any>>;
|
|
2279
|
+
/**
|
|
2280
|
+
* @description Gets the requested user's information.
|
|
2281
|
+
*
|
|
2282
|
+
* @tags dev-users
|
|
2283
|
+
* @name DevUsersGet
|
|
2284
|
+
* @request GET:/dev-users.get
|
|
2285
|
+
* @secure
|
|
2286
|
+
*/
|
|
2287
|
+
devUsersGet: (query: {
|
|
2288
|
+
/** User ID of the requested Dev user. */
|
|
2289
|
+
id: string;
|
|
2290
|
+
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any>>;
|
|
2264
2291
|
/**
|
|
2265
2292
|
* @description Lists users within your organization.
|
|
2266
2293
|
*
|
|
@@ -508,6 +508,15 @@ class Api extends HttpClient {
|
|
|
508
508
|
* @secure
|
|
509
509
|
*/
|
|
510
510
|
this.devOrgAuthConnectionsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
511
|
+
/**
|
|
512
|
+
* @description Gets the requested user's information.
|
|
513
|
+
*
|
|
514
|
+
* @tags dev-users
|
|
515
|
+
* @name DevUsersGet
|
|
516
|
+
* @request GET:/dev-users.get
|
|
517
|
+
* @secure
|
|
518
|
+
*/
|
|
519
|
+
this.devUsersGet = (query, params = {}) => this.request(Object.assign({ path: `/dev-users.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
511
520
|
/**
|
|
512
521
|
* @description Lists users within your organization.
|
|
513
522
|
*
|