@devrev/typescript-sdk 1.1.31 → 1.1.33
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,9 +33,9 @@ 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.
|
|
37
|
-
exports.
|
|
38
|
-
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = void 0;
|
|
36
|
+
exports.MemberType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupType = exports.GroupMemberType = exports.GroupIngestionSource = exports.GenericNotificationEventType = exports.GeneralPreferencesGroupPreferredLocale = exports.FieldValueType = exports.EventSourceStatus = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsCreateRequestTypeValue = exports.CodeChangeSource = exports.BooleanExpressionType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.ArticleType = exports.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
|
|
37
|
+
exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TimelineChangeEventEventType = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.SyncOutStatus = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.SyncInStatus = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SlasFilterAppliesToOperatorType = exports.SlaType = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SlaAppliesTo = exports.SendNotificationType = exports.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SearchHybridNamespace = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.QuestionAnswerStatus = exports.PreferencesType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MetricActionExecuteRequestAction = void 0;
|
|
38
|
+
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryPanel = exports.TimelineEntryObjectType = void 0;
|
|
39
39
|
var AccessLevel;
|
|
40
40
|
(function (AccessLevel) {
|
|
41
41
|
AccessLevel["External"] = "external";
|
|
@@ -357,6 +357,12 @@ var ErrorUnauthorizedType;
|
|
|
357
357
|
(function (ErrorUnauthorizedType) {
|
|
358
358
|
ErrorUnauthorizedType["Unauthenticated"] = "unauthenticated";
|
|
359
359
|
})(ErrorUnauthorizedType = exports.ErrorUnauthorizedType || (exports.ErrorUnauthorizedType = {}));
|
|
360
|
+
var EventFetchedResult;
|
|
361
|
+
(function (EventFetchedResult) {
|
|
362
|
+
EventFetchedResult["Forbidden"] = "forbidden";
|
|
363
|
+
EventFetchedResult["NotFound"] = "not_found";
|
|
364
|
+
EventFetchedResult["Ok"] = "ok";
|
|
365
|
+
})(EventFetchedResult = exports.EventFetchedResult || (exports.EventFetchedResult = {}));
|
|
360
366
|
/**
|
|
361
367
|
* Status of the event source. Note that paused/blocked event sources
|
|
362
368
|
* return NotFound error on triggering.
|
|
@@ -393,7 +399,10 @@ var FieldValueType;
|
|
|
393
399
|
var GeneralPreferencesGroupPreferredLocale;
|
|
394
400
|
(function (GeneralPreferencesGroupPreferredLocale) {
|
|
395
401
|
GeneralPreferencesGroupPreferredLocale["EnUs"] = "en_us";
|
|
402
|
+
GeneralPreferencesGroupPreferredLocale["EsAr"] = "es_ar";
|
|
396
403
|
GeneralPreferencesGroupPreferredLocale["JaJp"] = "ja_jp";
|
|
404
|
+
GeneralPreferencesGroupPreferredLocale["NlAw"] = "nl_aw";
|
|
405
|
+
GeneralPreferencesGroupPreferredLocale["NlSx"] = "nl_sx";
|
|
397
406
|
})(GeneralPreferencesGroupPreferredLocale = exports.GeneralPreferencesGroupPreferredLocale || (exports.GeneralPreferencesGroupPreferredLocale = {}));
|
|
398
407
|
/** Event type of the notification. */
|
|
399
408
|
var GenericNotificationEventType;
|
|
@@ -459,6 +468,7 @@ var LinkType;
|
|
|
459
468
|
LinkType["IsConvertedTo"] = "is_converted_to";
|
|
460
469
|
LinkType["IsDependentOn"] = "is_dependent_on";
|
|
461
470
|
LinkType["IsDuplicateOf"] = "is_duplicate_of";
|
|
471
|
+
LinkType["IsFollowUpOf"] = "is_follow_up_of";
|
|
462
472
|
LinkType["IsMergedInto"] = "is_merged_into";
|
|
463
473
|
LinkType["IsParentOf"] = "is_parent_of";
|
|
464
474
|
LinkType["IsPartOf"] = "is_part_of";
|
|
@@ -493,6 +503,14 @@ var MemberType;
|
|
|
493
503
|
MemberType["RevUser"] = "rev_user";
|
|
494
504
|
MemberType["SysUser"] = "sys_user";
|
|
495
505
|
})(MemberType = exports.MemberType || (exports.MemberType = {}));
|
|
506
|
+
var MetricActionExecuteRequestAction;
|
|
507
|
+
(function (MetricActionExecuteRequestAction) {
|
|
508
|
+
MetricActionExecuteRequestAction["Complete"] = "complete";
|
|
509
|
+
MetricActionExecuteRequestAction["Pause"] = "pause";
|
|
510
|
+
MetricActionExecuteRequestAction["Restart"] = "restart";
|
|
511
|
+
MetricActionExecuteRequestAction["Resume"] = "resume";
|
|
512
|
+
MetricActionExecuteRequestAction["Start"] = "start";
|
|
513
|
+
})(MetricActionExecuteRequestAction = exports.MetricActionExecuteRequestAction || (exports.MetricActionExecuteRequestAction = {}));
|
|
496
514
|
/** The list of item types on which the metric might be applied. */
|
|
497
515
|
var MetricDefinitionAppliesTo;
|
|
498
516
|
(function (MetricDefinitionAppliesTo) {
|
|
@@ -836,6 +854,14 @@ var StockSchemaFragmentsListRequestPrune;
|
|
|
836
854
|
StockSchemaFragmentsListRequestPrune["CompositeSchemas"] = "composite_schemas";
|
|
837
855
|
StockSchemaFragmentsListRequestPrune["Fields"] = "fields";
|
|
838
856
|
})(StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestPrune || (exports.StockSchemaFragmentsListRequestPrune = {}));
|
|
857
|
+
/** Status of the sync for the object. */
|
|
858
|
+
var SyncInStatus;
|
|
859
|
+
(function (SyncInStatus) {
|
|
860
|
+
SyncInStatus["Failed"] = "failed";
|
|
861
|
+
SyncInStatus["Modified"] = "modified";
|
|
862
|
+
SyncInStatus["Staged"] = "staged";
|
|
863
|
+
SyncInStatus["Succeeded"] = "succeeded";
|
|
864
|
+
})(SyncInStatus = exports.SyncInStatus || (exports.SyncInStatus = {}));
|
|
839
865
|
var SyncMetadataFilterSyncInFilterStatus;
|
|
840
866
|
(function (SyncMetadataFilterSyncInFilterStatus) {
|
|
841
867
|
SyncMetadataFilterSyncInFilterStatus["Failed"] = "failed";
|
|
@@ -848,6 +874,13 @@ var SyncMetadataFilterSyncOutFilterStatus;
|
|
|
848
874
|
SyncMetadataFilterSyncOutFilterStatus["Failed"] = "failed";
|
|
849
875
|
SyncMetadataFilterSyncOutFilterStatus["Succeeded"] = "succeeded";
|
|
850
876
|
})(SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncOutFilterStatus || (exports.SyncMetadataFilterSyncOutFilterStatus = {}));
|
|
877
|
+
/** Status of the sync for the object. */
|
|
878
|
+
var SyncOutStatus;
|
|
879
|
+
(function (SyncOutStatus) {
|
|
880
|
+
SyncOutStatus["Failed"] = "failed";
|
|
881
|
+
SyncOutStatus["Modified"] = "modified";
|
|
882
|
+
SyncOutStatus["Succeeded"] = "succeeded";
|
|
883
|
+
})(SyncOutStatus = exports.SyncOutStatus || (exports.SyncOutStatus = {}));
|
|
851
884
|
/** Priority of the work based upon impact and criticality. */
|
|
852
885
|
var TaskPriority;
|
|
853
886
|
(function (TaskPriority) {
|
|
@@ -885,6 +918,7 @@ var TimelineChangeEventEventType;
|
|
|
885
918
|
/** The type of the body to use for the comment. */
|
|
886
919
|
var TimelineCommentBodyType;
|
|
887
920
|
(function (TimelineCommentBodyType) {
|
|
921
|
+
TimelineCommentBodyType["Data"] = "data";
|
|
888
922
|
TimelineCommentBodyType["SnapKit"] = "snap_kit";
|
|
889
923
|
TimelineCommentBodyType["SnapWidget"] = "snap_widget";
|
|
890
924
|
TimelineCommentBodyType["Text"] = "text";
|
|
@@ -926,6 +960,8 @@ var TimelineEntryObjectType;
|
|
|
926
960
|
/** Display panels for the Timeline entry. */
|
|
927
961
|
var TimelineEntryPanel;
|
|
928
962
|
(function (TimelineEntryPanel) {
|
|
963
|
+
TimelineEntryPanel["Alerts"] = "alerts";
|
|
964
|
+
TimelineEntryPanel["Broadcasts"] = "broadcasts";
|
|
929
965
|
TimelineEntryPanel["CustomerChat"] = "customer_chat";
|
|
930
966
|
TimelineEntryPanel["Discussions"] = "discussions";
|
|
931
967
|
TimelineEntryPanel["Events"] = "events";
|
|
@@ -1054,6 +1090,7 @@ var WebhookEventType;
|
|
|
1054
1090
|
WebhookEventType["WebhookUpdated"] = "webhook_updated";
|
|
1055
1091
|
WebhookEventType["WorkCreated"] = "work_created";
|
|
1056
1092
|
WebhookEventType["WorkDeleted"] = "work_deleted";
|
|
1093
|
+
WebhookEventType["WorkFetched"] = "work_fetched";
|
|
1057
1094
|
WebhookEventType["WorkUpdated"] = "work_updated";
|
|
1058
1095
|
})(WebhookEventType = exports.WebhookEventType || (exports.WebhookEventType = {}));
|
|
1059
1096
|
/** The status of the webhook. */
|
|
@@ -1391,6 +1428,15 @@ class Api extends HttpClient {
|
|
|
1391
1428
|
* @secure
|
|
1392
1429
|
*/
|
|
1393
1430
|
this.artifactsVersionsPrepare = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.versions.prepare`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1431
|
+
/**
|
|
1432
|
+
* @description Retrieves audit logs.
|
|
1433
|
+
*
|
|
1434
|
+
* @tags compliance
|
|
1435
|
+
* @name ExportAuditLogs
|
|
1436
|
+
* @request POST:/audit-logs.fetch
|
|
1437
|
+
* @secure
|
|
1438
|
+
*/
|
|
1439
|
+
this.exportAuditLogs = (data, params = {}) => this.request(Object.assign({ path: `/audit-logs.fetch`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1394
1440
|
/**
|
|
1395
1441
|
* @description Creates a JWT corresponding to the requested token type for the authenticated user.
|
|
1396
1442
|
*
|
|
@@ -1652,6 +1698,87 @@ class Api extends HttpClient {
|
|
|
1652
1698
|
* @secure
|
|
1653
1699
|
*/
|
|
1654
1700
|
this.conversationsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/conversations.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1701
|
+
/**
|
|
1702
|
+
* @description Counts custom objects.
|
|
1703
|
+
*
|
|
1704
|
+
* @tags customization
|
|
1705
|
+
* @name CustomObjectsCount
|
|
1706
|
+
* @request GET:/custom-objects.count
|
|
1707
|
+
* @secure
|
|
1708
|
+
*/
|
|
1709
|
+
this.customObjectsCount = (query, params = {}) => this.request(Object.assign({ path: `/custom-objects.count`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1710
|
+
/**
|
|
1711
|
+
* @description Counts custom objects.
|
|
1712
|
+
*
|
|
1713
|
+
* @tags customization
|
|
1714
|
+
* @name CustomObjectsCountPost
|
|
1715
|
+
* @request POST:/custom-objects.count
|
|
1716
|
+
* @secure
|
|
1717
|
+
*/
|
|
1718
|
+
this.customObjectsCountPost = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1719
|
+
/**
|
|
1720
|
+
* @description Creates a custom object.
|
|
1721
|
+
*
|
|
1722
|
+
* @tags customization
|
|
1723
|
+
* @name CustomObjectsCreate
|
|
1724
|
+
* @request POST:/custom-objects.create
|
|
1725
|
+
* @secure
|
|
1726
|
+
*/
|
|
1727
|
+
this.customObjectsCreate = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1728
|
+
/**
|
|
1729
|
+
* @description Deletes a custom object.
|
|
1730
|
+
*
|
|
1731
|
+
* @tags customization
|
|
1732
|
+
* @name CustomObjectsDelete
|
|
1733
|
+
* @request POST:/custom-objects.delete
|
|
1734
|
+
* @secure
|
|
1735
|
+
*/
|
|
1736
|
+
this.customObjectsDelete = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1737
|
+
/**
|
|
1738
|
+
* @description Gets a custom object.
|
|
1739
|
+
*
|
|
1740
|
+
* @tags customization
|
|
1741
|
+
* @name CustomObjectsGet
|
|
1742
|
+
* @request GET:/custom-objects.get
|
|
1743
|
+
* @secure
|
|
1744
|
+
*/
|
|
1745
|
+
this.customObjectsGet = (query, params = {}) => this.request(Object.assign({ path: `/custom-objects.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1746
|
+
/**
|
|
1747
|
+
* @description Gets a custom object.
|
|
1748
|
+
*
|
|
1749
|
+
* @tags customization
|
|
1750
|
+
* @name CustomObjectsGetPost
|
|
1751
|
+
* @request POST:/custom-objects.get
|
|
1752
|
+
* @secure
|
|
1753
|
+
*/
|
|
1754
|
+
this.customObjectsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1755
|
+
/**
|
|
1756
|
+
* @description Lists custom objects.
|
|
1757
|
+
*
|
|
1758
|
+
* @tags customization
|
|
1759
|
+
* @name CustomObjectsList
|
|
1760
|
+
* @request GET:/custom-objects.list
|
|
1761
|
+
* @secure
|
|
1762
|
+
*/
|
|
1763
|
+
this.customObjectsList = (query, params = {}) => this.request(Object.assign({ path: `/custom-objects.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1764
|
+
/**
|
|
1765
|
+
* @description Lists custom objects.
|
|
1766
|
+
*
|
|
1767
|
+
* @tags customization
|
|
1768
|
+
* @name CustomObjectsListPost
|
|
1769
|
+
* @request POST:/custom-objects.list
|
|
1770
|
+
* @secure
|
|
1771
|
+
*/
|
|
1772
|
+
this.customObjectsListPost = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1773
|
+
/**
|
|
1774
|
+
* @description Updates a custom object.
|
|
1775
|
+
*
|
|
1776
|
+
* @tags customization
|
|
1777
|
+
* @name CustomObjectsUpdate
|
|
1778
|
+
* @request POST:/custom-objects.update
|
|
1779
|
+
* @secure
|
|
1780
|
+
*/
|
|
1781
|
+
this.customObjectsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1655
1782
|
/**
|
|
1656
1783
|
* @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.
|
|
1657
1784
|
*
|
|
@@ -1814,6 +1941,87 @@ class Api extends HttpClient {
|
|
|
1814
1941
|
* @secure
|
|
1815
1942
|
*/
|
|
1816
1943
|
this.devUsersUpdate = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1944
|
+
/**
|
|
1945
|
+
* @description Get count of directories matching given filter.
|
|
1946
|
+
*
|
|
1947
|
+
* @tags directory
|
|
1948
|
+
* @name DirectoriesCount
|
|
1949
|
+
* @request GET:/directories.count
|
|
1950
|
+
* @secure
|
|
1951
|
+
*/
|
|
1952
|
+
this.directoriesCount = (query, params = {}) => this.request(Object.assign({ path: `/directories.count`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1953
|
+
/**
|
|
1954
|
+
* @description Get count of directories matching given filter.
|
|
1955
|
+
*
|
|
1956
|
+
* @tags directory
|
|
1957
|
+
* @name DirectoriesCountPost
|
|
1958
|
+
* @request POST:/directories.count
|
|
1959
|
+
* @secure
|
|
1960
|
+
*/
|
|
1961
|
+
this.directoriesCountPost = (data, params = {}) => this.request(Object.assign({ path: `/directories.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1962
|
+
/**
|
|
1963
|
+
* @description Creates a directory for the specified inputs.
|
|
1964
|
+
*
|
|
1965
|
+
* @tags directory
|
|
1966
|
+
* @name DirectoriesCreate
|
|
1967
|
+
* @request POST:/directories.create
|
|
1968
|
+
* @secure
|
|
1969
|
+
*/
|
|
1970
|
+
this.directoriesCreate = (data, params = {}) => this.request(Object.assign({ path: `/directories.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1971
|
+
/**
|
|
1972
|
+
* @description Delete the specified directory.
|
|
1973
|
+
*
|
|
1974
|
+
* @tags directory
|
|
1975
|
+
* @name DirectoriesDelete
|
|
1976
|
+
* @request POST:/directories.delete
|
|
1977
|
+
* @secure
|
|
1978
|
+
*/
|
|
1979
|
+
this.directoriesDelete = (data, params = {}) => this.request(Object.assign({ path: `/directories.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1980
|
+
/**
|
|
1981
|
+
* @description Gets the specified directory.
|
|
1982
|
+
*
|
|
1983
|
+
* @tags directory
|
|
1984
|
+
* @name DirectoriesGet
|
|
1985
|
+
* @request GET:/directories.get
|
|
1986
|
+
* @secure
|
|
1987
|
+
*/
|
|
1988
|
+
this.directoriesGet = (query, params = {}) => this.request(Object.assign({ path: `/directories.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1989
|
+
/**
|
|
1990
|
+
* @description Gets the specified directory.
|
|
1991
|
+
*
|
|
1992
|
+
* @tags directory
|
|
1993
|
+
* @name DirectoriesGetPost
|
|
1994
|
+
* @request POST:/directories.get
|
|
1995
|
+
* @secure
|
|
1996
|
+
*/
|
|
1997
|
+
this.directoriesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/directories.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1998
|
+
/**
|
|
1999
|
+
* @description Lists directories matching the request.
|
|
2000
|
+
*
|
|
2001
|
+
* @tags directory
|
|
2002
|
+
* @name DirectoriesList
|
|
2003
|
+
* @request GET:/directories.list
|
|
2004
|
+
* @secure
|
|
2005
|
+
*/
|
|
2006
|
+
this.directoriesList = (query, params = {}) => this.request(Object.assign({ path: `/directories.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
2007
|
+
/**
|
|
2008
|
+
* @description Lists directories matching the request.
|
|
2009
|
+
*
|
|
2010
|
+
* @tags directory
|
|
2011
|
+
* @name DirectoriesListPost
|
|
2012
|
+
* @request POST:/directories.list
|
|
2013
|
+
* @secure
|
|
2014
|
+
*/
|
|
2015
|
+
this.directoriesListPost = (data, params = {}) => this.request(Object.assign({ path: `/directories.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2016
|
+
/**
|
|
2017
|
+
* @description Updates the specified directory.
|
|
2018
|
+
*
|
|
2019
|
+
* @tags directory
|
|
2020
|
+
* @name DirectoriesUpdate
|
|
2021
|
+
* @request POST:/directories.update
|
|
2022
|
+
* @secure
|
|
2023
|
+
*/
|
|
2024
|
+
this.directoriesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/directories.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1817
2025
|
/**
|
|
1818
2026
|
* @description Counts the engagement records.
|
|
1819
2027
|
*
|
|
@@ -2119,6 +2327,60 @@ class Api extends HttpClient {
|
|
|
2119
2327
|
* @secure
|
|
2120
2328
|
*/
|
|
2121
2329
|
this.keyringsCreateCallbackPost = (data, params = {}) => this.request(Object.assign({ path: `/keyrings.authorize`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
|
|
2330
|
+
/**
|
|
2331
|
+
* @description Creates a custom link type.
|
|
2332
|
+
*
|
|
2333
|
+
* @tags customization
|
|
2334
|
+
* @name CustomLinkTypeCreate
|
|
2335
|
+
* @request POST:/link-types.custom.create
|
|
2336
|
+
* @secure
|
|
2337
|
+
*/
|
|
2338
|
+
this.customLinkTypeCreate = (data, params = {}) => this.request(Object.assign({ path: `/link-types.custom.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2339
|
+
/**
|
|
2340
|
+
* @description Gets a custom link type.
|
|
2341
|
+
*
|
|
2342
|
+
* @tags customization
|
|
2343
|
+
* @name CustomLinkTypeGet
|
|
2344
|
+
* @request GET:/link-types.custom.get
|
|
2345
|
+
* @secure
|
|
2346
|
+
*/
|
|
2347
|
+
this.customLinkTypeGet = (query, params = {}) => this.request(Object.assign({ path: `/link-types.custom.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
2348
|
+
/**
|
|
2349
|
+
* @description Gets a custom link type.
|
|
2350
|
+
*
|
|
2351
|
+
* @tags customization
|
|
2352
|
+
* @name CustomLinkTypeGetPost
|
|
2353
|
+
* @request POST:/link-types.custom.get
|
|
2354
|
+
* @secure
|
|
2355
|
+
*/
|
|
2356
|
+
this.customLinkTypeGetPost = (data, params = {}) => this.request(Object.assign({ path: `/link-types.custom.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2357
|
+
/**
|
|
2358
|
+
* @description Lists custom link types.
|
|
2359
|
+
*
|
|
2360
|
+
* @tags customization
|
|
2361
|
+
* @name CustomLinkTypeList
|
|
2362
|
+
* @request GET:/link-types.custom.list
|
|
2363
|
+
* @secure
|
|
2364
|
+
*/
|
|
2365
|
+
this.customLinkTypeList = (query, params = {}) => this.request(Object.assign({ path: `/link-types.custom.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
2366
|
+
/**
|
|
2367
|
+
* @description Lists custom link types.
|
|
2368
|
+
*
|
|
2369
|
+
* @tags customization
|
|
2370
|
+
* @name CustomLinkTypeListPost
|
|
2371
|
+
* @request POST:/link-types.custom.list
|
|
2372
|
+
* @secure
|
|
2373
|
+
*/
|
|
2374
|
+
this.customLinkTypeListPost = (data, params = {}) => this.request(Object.assign({ path: `/link-types.custom.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2375
|
+
/**
|
|
2376
|
+
* @description Updates a custom link type.
|
|
2377
|
+
*
|
|
2378
|
+
* @tags customization
|
|
2379
|
+
* @name CustomLinkTypeUpdate
|
|
2380
|
+
* @request POST:/link-types.custom.update
|
|
2381
|
+
* @secure
|
|
2382
|
+
*/
|
|
2383
|
+
this.customLinkTypeUpdate = (data, params = {}) => this.request(Object.assign({ path: `/link-types.custom.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2122
2384
|
/**
|
|
2123
2385
|
* @description Creates a link between two objects to indicate a relationship.
|
|
2124
2386
|
*
|
|
@@ -2173,6 +2435,51 @@ class Api extends HttpClient {
|
|
|
2173
2435
|
* @secure
|
|
2174
2436
|
*/
|
|
2175
2437
|
this.linksListPost = (data, params = {}) => this.request(Object.assign({ path: `/links.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2438
|
+
/**
|
|
2439
|
+
* @description Executes the metric action on the given object.
|
|
2440
|
+
*
|
|
2441
|
+
* @tags slas
|
|
2442
|
+
* @name MetricActionExecute
|
|
2443
|
+
* @request POST:/metric-action.execute
|
|
2444
|
+
* @secure
|
|
2445
|
+
*/
|
|
2446
|
+
this.metricActionExecute = (data, params = {}) => this.request(Object.assign({ path: `/metric-action.execute`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2447
|
+
/**
|
|
2448
|
+
* @description Creates a custom metric definition
|
|
2449
|
+
*
|
|
2450
|
+
* @tags slas
|
|
2451
|
+
* @name MetricDefinitionsCreate
|
|
2452
|
+
* @request POST:/metric-definitions.create
|
|
2453
|
+
* @secure
|
|
2454
|
+
*/
|
|
2455
|
+
this.metricDefinitionsCreate = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2456
|
+
/**
|
|
2457
|
+
* @description Deletes a custom metric definition
|
|
2458
|
+
*
|
|
2459
|
+
* @tags slas
|
|
2460
|
+
* @name MetricDefinitionsDelete
|
|
2461
|
+
* @request POST:/metric-definitions.delete
|
|
2462
|
+
* @secure
|
|
2463
|
+
*/
|
|
2464
|
+
this.metricDefinitionsDelete = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2465
|
+
/**
|
|
2466
|
+
* @description Gets a custom metric definition
|
|
2467
|
+
*
|
|
2468
|
+
* @tags slas
|
|
2469
|
+
* @name MetricDefinitionsGet
|
|
2470
|
+
* @request GET:/metric-definitions.get
|
|
2471
|
+
* @secure
|
|
2472
|
+
*/
|
|
2473
|
+
this.metricDefinitionsGet = (query, params = {}) => this.request(Object.assign({ path: `/metric-definitions.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
2474
|
+
/**
|
|
2475
|
+
* @description Gets a custom metric definition
|
|
2476
|
+
*
|
|
2477
|
+
* @tags slas
|
|
2478
|
+
* @name MetricDefinitionsGetPost
|
|
2479
|
+
* @request POST:/metric-definitions.get
|
|
2480
|
+
* @secure
|
|
2481
|
+
*/
|
|
2482
|
+
this.metricDefinitionsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2176
2483
|
/**
|
|
2177
2484
|
* @description Lists metric definitions matching a filter.
|
|
2178
2485
|
*
|
|
@@ -2191,6 +2498,15 @@ class Api extends HttpClient {
|
|
|
2191
2498
|
* @secure
|
|
2192
2499
|
*/
|
|
2193
2500
|
this.metricDefinitionsListPost = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2501
|
+
/**
|
|
2502
|
+
* @description Updates a custom metric definition
|
|
2503
|
+
*
|
|
2504
|
+
* @tags slas
|
|
2505
|
+
* @name MetricDefinitionsUpdate
|
|
2506
|
+
* @request POST:/metric-definitions.update
|
|
2507
|
+
* @secure
|
|
2508
|
+
*/
|
|
2509
|
+
this.metricDefinitionsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2194
2510
|
/**
|
|
2195
2511
|
* @description Ingest endpoint for DevRev metrics data from clients.
|
|
2196
2512
|
*
|
|
@@ -2542,6 +2858,15 @@ class Api extends HttpClient {
|
|
|
2542
2858
|
* @secure
|
|
2543
2859
|
*/
|
|
2544
2860
|
this.revUsersDelete = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2861
|
+
/**
|
|
2862
|
+
* @description Deletes data of a contact.
|
|
2863
|
+
*
|
|
2864
|
+
* @tags compliance
|
|
2865
|
+
* @name DeleteRevUsersPersonalData
|
|
2866
|
+
* @request POST:/rev-users.delete-personal-data
|
|
2867
|
+
* @secure
|
|
2868
|
+
*/
|
|
2869
|
+
this.deleteRevUsersPersonalData = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.delete-personal-data`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2545
2870
|
/**
|
|
2546
2871
|
* @description Returns the Rev user of a Rev organization by its ID.
|
|
2547
2872
|
*
|
|
@@ -2587,6 +2912,24 @@ class Api extends HttpClient {
|
|
|
2587
2912
|
* @secure
|
|
2588
2913
|
*/
|
|
2589
2914
|
this.revUsersListPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2915
|
+
/**
|
|
2916
|
+
* @description Merges the secondary Rev user into the primary Rev user.
|
|
2917
|
+
*
|
|
2918
|
+
* @tags rev-users
|
|
2919
|
+
* @name RevUsersMerge
|
|
2920
|
+
* @request POST:/rev-users.merge
|
|
2921
|
+
* @secure
|
|
2922
|
+
*/
|
|
2923
|
+
this.revUsersMerge = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.merge`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2924
|
+
/**
|
|
2925
|
+
* @description Retrieves data of a contact.
|
|
2926
|
+
*
|
|
2927
|
+
* @tags compliance
|
|
2928
|
+
* @name GetRevUsersPersonalData
|
|
2929
|
+
* @request POST:/rev-users.personal-data
|
|
2930
|
+
* @secure
|
|
2931
|
+
*/
|
|
2932
|
+
this.getRevUsersPersonalData = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.personal-data`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2590
2933
|
/**
|
|
2591
2934
|
* @description Scans through all Rev users.
|
|
2592
2935
|
*
|
|
@@ -2812,6 +3155,24 @@ class Api extends HttpClient {
|
|
|
2812
3155
|
* @secure
|
|
2813
3156
|
*/
|
|
2814
3157
|
this.slaTrackersGetPost = (data, params = {}) => this.request(Object.assign({ path: `/sla-trackers.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3158
|
+
/**
|
|
3159
|
+
* @description Lists SLA trackers matching a filter.
|
|
3160
|
+
*
|
|
3161
|
+
* @tags slas
|
|
3162
|
+
* @name SlaTrackersList
|
|
3163
|
+
* @request GET:/sla-trackers.list
|
|
3164
|
+
* @secure
|
|
3165
|
+
*/
|
|
3166
|
+
this.slaTrackersList = (query, params = {}) => this.request(Object.assign({ path: `/sla-trackers.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
3167
|
+
/**
|
|
3168
|
+
* @description Lists SLA trackers matching a filter.
|
|
3169
|
+
*
|
|
3170
|
+
* @tags slas
|
|
3171
|
+
* @name SlaTrackersListPost
|
|
3172
|
+
* @request POST:/sla-trackers.list
|
|
3173
|
+
* @secure
|
|
3174
|
+
*/
|
|
3175
|
+
this.slaTrackersListPost = (data, params = {}) => this.request(Object.assign({ path: `/sla-trackers.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2815
3176
|
/**
|
|
2816
3177
|
* @description Assigns the SLA to a set of Rev organizations.
|
|
2817
3178
|
*
|
|
@@ -3361,6 +3722,15 @@ class Api extends HttpClient {
|
|
|
3361
3722
|
* @secure
|
|
3362
3723
|
*/
|
|
3363
3724
|
this.webhooksDelete = (data, params = {}) => this.request(Object.assign({ path: `/webhooks.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3725
|
+
/**
|
|
3726
|
+
* @description Fetches an object via webhook.
|
|
3727
|
+
*
|
|
3728
|
+
* @tags webhooks
|
|
3729
|
+
* @name WebhooksFetch
|
|
3730
|
+
* @request POST:/webhooks.fetch
|
|
3731
|
+
* @secure
|
|
3732
|
+
*/
|
|
3733
|
+
this.webhooksFetch = (data, params = {}) => this.request(Object.assign({ path: `/webhooks.fetch`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3364
3734
|
/**
|
|
3365
3735
|
* @description Gets the requested webhook's information.
|
|
3366
3736
|
*
|