@devrev/typescript-sdk 1.1.72 → 1.1.73
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,10 +33,11 @@ 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.
|
|
39
|
-
exports.
|
|
36
|
+
exports.ErrorConflictType = exports.ErrorBadRequestWorkflowComponentValidationErrorWorkflowComponentValidationLocationType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.ErrorBadRequestSpaceValidationErrorType = exports.ErrorBadRequestGroupHierarchyInvalidParentReason = exports.ErrorBadRequestCustomizationValidationErrorSubtype = exports.EnhancementRevScoreTier = exports.DynamicVistaFilterType = exports.DeviceType = exports.DevicePlatform = exports.DevUsersCreateRequestStateEnumValue = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.Definedness = exports.DateTimePresetType = exports.DateFilterType = exports.DataLabelConfigDisplayMode = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsVistaGroupItemType = exports.ConversationsCreateRequestTypeValue = exports.ConsoleLogType = exports.ConfigurationProrationBehavior = exports.ConfigurationCollectionMethod = exports.CommandSurfaceSurface = exports.CommandSurfaceObjectTypes = exports.CommandStatus = exports.CommandActionTemplateType = exports.CommandActionExecutorType = exports.CodeChangeSource = exports.ChatType = exports.BooleanExpressionType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.ArtifactConfigurationSet = exports.ArticleType = exports.ArticleStatus = exports.ArticleContentFormat = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
|
|
37
|
+
exports.ObservabilitySessionsAggregateRequestSchemaType = exports.ObservabilitySessionsAggregateRequestAggregationConfigType = exports.ObservabilitySessionType = exports.MobileRecordingRecordingEventsTimelineInputType = exports.MobileRecordingRecordingEventsTimelineEventType = exports.MobileRecordingRecordingEventsTimelineEventName = exports.MobileRecordingAppLaunchLaunchType = exports.MetricTrackerType = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MetricActionExecuteRequestAction = exports.MetadataType = exports.MemberType = exports.MeetingState = exports.MeetingDirection = exports.MeetingChannel = exports.MeerkatWidgetColumnProjectionType = exports.MeerkatWidgetColumnProjectionTimestampRollup = exports.MeerkatWidgetColumnFunctionType = exports.MarketplaceItemOperationFeatureOperationType = exports.MarketplaceItemMcpServerFeatureServerType = exports.MarketplaceItemItemType = exports.MarketplaceItemFeatureFeatureType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.KanbanVisualizationCardAttributePosition = exports.JobState = exports.JobCategory = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupedVistaFilterType = exports.GroupType = exports.GroupMemberType = exports.GroupItemType = exports.GroupIngestionSource = exports.FieldValueType = exports.ExternalSystemType = exports.EventTimelineEntryUpdatedReactionAction = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorSeeOtherType = exports.ErrorRequestEntityTooLargeType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = void 0;
|
|
38
|
+
exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StatusCodeClass = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SpaceFilterSpaceIdOperatorType = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SnapWidgetInteractionType = exports.SnapWidgetClickInteractionClickAction = exports.SnapKitBaseWidgetSnapKitExecution = exports.SnapKitActionRequestElementTypeValue = exports.SlasFilterAppliesToOperatorType = exports.SlaType = exports.SlaTrackerAppliesToType = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SlaAppliesTo = exports.SkuType = exports.SkuState = exports.SessionCustomAttributeFilterFilterType = exports.ServicePlanStatus = exports.ServicePlanBillingCycle = exports.SchemasSubtypePrepareUpdateGetResponseConflictType = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.ReactionsUpdateRequestAction = exports.QuestionAnswerStatus = exports.PricingBillingCycle = exports.PartsVistaGroupItemType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.ObservabilityTimelineEventType = exports.ObservabilitySessionsListRequestType = exports.ObservabilitySessionsDataGetResponseRecording = exports.ObservabilitySessionsAggregateResponseMetricResultMetricType = exports.ObservabilitySessionsAggregateResponseBucketItemBucketType = exports.ObservabilitySessionsAggregateResponseAggregationResultResultType = exports.ObservabilitySessionsAggregateRequestType = void 0;
|
|
39
|
+
exports.ContentType = exports.WorksVistaGroupItemType = exports.WorksFilterTicketGroupsOpOperatorType = exports.WorksFilterIssueSprintStateValue = exports.WorkType = exports.WidgetVisualizationType = exports.WidgetQueryOrderByDirection = exports.WidgetQueryColumnConfigType = exports.WidgetQueryColumnConfigTimeGranularity = exports.WidgetQueryColumnConfigAggregation = exports.WidgetDataSourceType = exports.WidgetColumnProjectionType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.WebCrawlerJobsControlRequestAction = exports.WebCrawlerJobState = exports.VisualizationAxisColorType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.VistaGroupItemGroupObjectType = exports.VistaFlavor = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryPanel = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesListRequestBias = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TimelineChangeEventEventType = exports.TimeMetricTrackerStatus = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.TableVisualizationColumnPinPosition = exports.TableVisualizationColumnLockPosition = exports.SyncUnitSyncType = exports.SyncRunMode = exports.SyncProgressState = exports.SyncOutStatus = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.SyncInStatus = void 0;
|
|
40
|
+
exports.Api = exports.HttpClient = void 0;
|
|
40
41
|
var AccessLevel;
|
|
41
42
|
(function (AccessLevel) {
|
|
42
43
|
AccessLevel["External"] = "external";
|
|
@@ -330,6 +331,13 @@ var ConfigurationProrationBehavior;
|
|
|
330
331
|
ConfigurationProrationBehavior["CreateProrations"] = "create_prorations";
|
|
331
332
|
ConfigurationProrationBehavior["None"] = "none";
|
|
332
333
|
})(ConfigurationProrationBehavior = exports.ConfigurationProrationBehavior || (exports.ConfigurationProrationBehavior = {}));
|
|
334
|
+
/** The type of console log. */
|
|
335
|
+
var ConsoleLogType;
|
|
336
|
+
(function (ConsoleLogType) {
|
|
337
|
+
ConsoleLogType["Error"] = "error";
|
|
338
|
+
ConsoleLogType["Log"] = "log";
|
|
339
|
+
ConsoleLogType["Warn"] = "warn";
|
|
340
|
+
})(ConsoleLogType = exports.ConsoleLogType || (exports.ConsoleLogType = {}));
|
|
333
341
|
var ConversationsCreateRequestTypeValue;
|
|
334
342
|
(function (ConversationsCreateRequestTypeValue) {
|
|
335
343
|
ConversationsCreateRequestTypeValue["Support"] = "support";
|
|
@@ -708,6 +716,7 @@ var JobCategory;
|
|
|
708
716
|
JobCategory["MergeRevorg"] = "merge_revorg";
|
|
709
717
|
JobCategory["MergeRevuser"] = "merge_revuser";
|
|
710
718
|
JobCategory["MergeTicket"] = "merge_ticket";
|
|
719
|
+
JobCategory["MigrateVistaReports"] = "migrate_vista_reports";
|
|
711
720
|
JobCategory["MoveRevorg"] = "move_revorg";
|
|
712
721
|
JobCategory["MoveRevuser"] = "move_revuser";
|
|
713
722
|
JobCategory["OasisDataExport"] = "oasis_data_export";
|
|
@@ -849,7 +858,11 @@ var MeerkatWidgetColumnFunctionType;
|
|
|
849
858
|
MeerkatWidgetColumnFunctionType["P99"] = "p99";
|
|
850
859
|
MeerkatWidgetColumnFunctionType["Sum"] = "sum";
|
|
851
860
|
})(MeerkatWidgetColumnFunctionType = exports.MeerkatWidgetColumnFunctionType || (exports.MeerkatWidgetColumnFunctionType = {}));
|
|
852
|
-
/**
|
|
861
|
+
/**
|
|
862
|
+
* Deprecated: Use widget_query_column_config with type=timestamp on
|
|
863
|
+
* widget_query.dimension_configs instead. The rollup granularity for the
|
|
864
|
+
* timestamp.
|
|
865
|
+
*/
|
|
853
866
|
var MeerkatWidgetColumnProjectionTimestampRollup;
|
|
854
867
|
(function (MeerkatWidgetColumnProjectionTimestampRollup) {
|
|
855
868
|
MeerkatWidgetColumnProjectionTimestampRollup["Day"] = "day";
|
|
@@ -1019,6 +1032,49 @@ var ObservabilitySessionType;
|
|
|
1019
1032
|
ObservabilitySessionType["Mobile"] = "mobile";
|
|
1020
1033
|
ObservabilitySessionType["Web"] = "web";
|
|
1021
1034
|
})(ObservabilitySessionType = exports.ObservabilitySessionType || (exports.ObservabilitySessionType = {}));
|
|
1035
|
+
var ObservabilitySessionsAggregateRequestAggregationConfigType;
|
|
1036
|
+
(function (ObservabilitySessionsAggregateRequestAggregationConfigType) {
|
|
1037
|
+
ObservabilitySessionsAggregateRequestAggregationConfigType["Avg"] = "avg";
|
|
1038
|
+
ObservabilitySessionsAggregateRequestAggregationConfigType["Count"] = "count";
|
|
1039
|
+
ObservabilitySessionsAggregateRequestAggregationConfigType["DateHistogram"] = "date_histogram";
|
|
1040
|
+
ObservabilitySessionsAggregateRequestAggregationConfigType["Max"] = "max";
|
|
1041
|
+
ObservabilitySessionsAggregateRequestAggregationConfigType["Min"] = "min";
|
|
1042
|
+
ObservabilitySessionsAggregateRequestAggregationConfigType["Percentiles"] = "percentiles";
|
|
1043
|
+
ObservabilitySessionsAggregateRequestAggregationConfigType["Sum"] = "sum";
|
|
1044
|
+
ObservabilitySessionsAggregateRequestAggregationConfigType["Terms"] = "terms";
|
|
1045
|
+
})(ObservabilitySessionsAggregateRequestAggregationConfigType = exports.ObservabilitySessionsAggregateRequestAggregationConfigType || (exports.ObservabilitySessionsAggregateRequestAggregationConfigType = {}));
|
|
1046
|
+
var ObservabilitySessionsAggregateRequestSchemaType;
|
|
1047
|
+
(function (ObservabilitySessionsAggregateRequestSchemaType) {
|
|
1048
|
+
ObservabilitySessionsAggregateRequestSchemaType["MobileCustomEvents"] = "mobile_custom_events";
|
|
1049
|
+
ObservabilitySessionsAggregateRequestSchemaType["MobileNetwork"] = "mobile_network";
|
|
1050
|
+
ObservabilitySessionsAggregateRequestSchemaType["WebConsole"] = "web_console";
|
|
1051
|
+
ObservabilitySessionsAggregateRequestSchemaType["WebCustomEvents"] = "web_custom_events";
|
|
1052
|
+
ObservabilitySessionsAggregateRequestSchemaType["WebEvent"] = "web_event";
|
|
1053
|
+
ObservabilitySessionsAggregateRequestSchemaType["WebNetwork"] = "web_network";
|
|
1054
|
+
})(ObservabilitySessionsAggregateRequestSchemaType = exports.ObservabilitySessionsAggregateRequestSchemaType || (exports.ObservabilitySessionsAggregateRequestSchemaType = {}));
|
|
1055
|
+
var ObservabilitySessionsAggregateRequestType;
|
|
1056
|
+
(function (ObservabilitySessionsAggregateRequestType) {
|
|
1057
|
+
ObservabilitySessionsAggregateRequestType["Mobile"] = "mobile";
|
|
1058
|
+
ObservabilitySessionsAggregateRequestType["Web"] = "web";
|
|
1059
|
+
})(ObservabilitySessionsAggregateRequestType = exports.ObservabilitySessionsAggregateRequestType || (exports.ObservabilitySessionsAggregateRequestType = {}));
|
|
1060
|
+
var ObservabilitySessionsAggregateResponseAggregationResultResultType;
|
|
1061
|
+
(function (ObservabilitySessionsAggregateResponseAggregationResultResultType) {
|
|
1062
|
+
ObservabilitySessionsAggregateResponseAggregationResultResultType["BucketResults"] = "bucket_results";
|
|
1063
|
+
ObservabilitySessionsAggregateResponseAggregationResultResultType["MetricResult"] = "metric_result";
|
|
1064
|
+
})(ObservabilitySessionsAggregateResponseAggregationResultResultType = exports.ObservabilitySessionsAggregateResponseAggregationResultResultType || (exports.ObservabilitySessionsAggregateResponseAggregationResultResultType = {}));
|
|
1065
|
+
var ObservabilitySessionsAggregateResponseBucketItemBucketType;
|
|
1066
|
+
(function (ObservabilitySessionsAggregateResponseBucketItemBucketType) {
|
|
1067
|
+
ObservabilitySessionsAggregateResponseBucketItemBucketType["Bucket"] = "bucket";
|
|
1068
|
+
})(ObservabilitySessionsAggregateResponseBucketItemBucketType = exports.ObservabilitySessionsAggregateResponseBucketItemBucketType || (exports.ObservabilitySessionsAggregateResponseBucketItemBucketType = {}));
|
|
1069
|
+
var ObservabilitySessionsAggregateResponseMetricResultMetricType;
|
|
1070
|
+
(function (ObservabilitySessionsAggregateResponseMetricResultMetricType) {
|
|
1071
|
+
ObservabilitySessionsAggregateResponseMetricResultMetricType["Avg"] = "avg";
|
|
1072
|
+
ObservabilitySessionsAggregateResponseMetricResultMetricType["Count"] = "count";
|
|
1073
|
+
ObservabilitySessionsAggregateResponseMetricResultMetricType["Max"] = "max";
|
|
1074
|
+
ObservabilitySessionsAggregateResponseMetricResultMetricType["Min"] = "min";
|
|
1075
|
+
ObservabilitySessionsAggregateResponseMetricResultMetricType["Percentiles"] = "percentiles";
|
|
1076
|
+
ObservabilitySessionsAggregateResponseMetricResultMetricType["Sum"] = "sum";
|
|
1077
|
+
})(ObservabilitySessionsAggregateResponseMetricResultMetricType = exports.ObservabilitySessionsAggregateResponseMetricResultMetricType || (exports.ObservabilitySessionsAggregateResponseMetricResultMetricType = {}));
|
|
1022
1078
|
var ObservabilitySessionsDataGetResponseRecording;
|
|
1023
1079
|
(function (ObservabilitySessionsDataGetResponseRecording) {
|
|
1024
1080
|
ObservabilitySessionsDataGetResponseRecording["MobileRecording"] = "mobile_recording";
|
|
@@ -1374,6 +1430,15 @@ var StageValidationOptionForUpdate;
|
|
|
1374
1430
|
(function (StageValidationOptionForUpdate) {
|
|
1375
1431
|
StageValidationOptionForUpdate["AllowInvalidTransition"] = "allow_invalid_transition";
|
|
1376
1432
|
})(StageValidationOptionForUpdate = exports.StageValidationOptionForUpdate || (exports.StageValidationOptionForUpdate = {}));
|
|
1433
|
+
/** HTTP response status code class. */
|
|
1434
|
+
var StatusCodeClass;
|
|
1435
|
+
(function (StatusCodeClass) {
|
|
1436
|
+
StatusCodeClass["Value1Xx"] = "1xx";
|
|
1437
|
+
StatusCodeClass["Value2Xx"] = "2xx";
|
|
1438
|
+
StatusCodeClass["Value3Xx"] = "3xx";
|
|
1439
|
+
StatusCodeClass["Value4Xx"] = "4xx";
|
|
1440
|
+
StatusCodeClass["Value5Xx"] = "5xx";
|
|
1441
|
+
})(StatusCodeClass = exports.StatusCodeClass || (exports.StatusCodeClass = {}));
|
|
1377
1442
|
var StockSchemaFragmentsListRequestFilterPreset;
|
|
1378
1443
|
(function (StockSchemaFragmentsListRequestFilterPreset) {
|
|
1379
1444
|
StockSchemaFragmentsListRequestFilterPreset["CustomizableTypesPreset"] = "customizable_types_preset";
|
|
@@ -1525,6 +1590,11 @@ var TimelineEntriesCreateRequestType;
|
|
|
1525
1590
|
(function (TimelineEntriesCreateRequestType) {
|
|
1526
1591
|
TimelineEntriesCreateRequestType["TimelineComment"] = "timeline_comment";
|
|
1527
1592
|
})(TimelineEntriesCreateRequestType = exports.TimelineEntriesCreateRequestType || (exports.TimelineEntriesCreateRequestType = {}));
|
|
1593
|
+
var TimelineEntriesListRequestBias;
|
|
1594
|
+
(function (TimelineEntriesListRequestBias) {
|
|
1595
|
+
TimelineEntriesListRequestBias["Quantity"] = "quantity";
|
|
1596
|
+
TimelineEntriesListRequestBias["Speed"] = "speed";
|
|
1597
|
+
})(TimelineEntriesListRequestBias = exports.TimelineEntriesListRequestBias || (exports.TimelineEntriesListRequestBias = {}));
|
|
1528
1598
|
var TimelineEntriesUpdateRequestType;
|
|
1529
1599
|
(function (TimelineEntriesUpdateRequestType) {
|
|
1530
1600
|
TimelineEntriesUpdateRequestType["TimelineComment"] = "timeline_comment";
|
|
@@ -1784,6 +1854,40 @@ var WidgetDataSourceType;
|
|
|
1784
1854
|
WidgetDataSourceType["ExternalDataSource"] = "external_data_source";
|
|
1785
1855
|
WidgetDataSourceType["Oasis"] = "oasis";
|
|
1786
1856
|
})(WidgetDataSourceType = exports.WidgetDataSourceType || (exports.WidgetDataSourceType = {}));
|
|
1857
|
+
/** The aggregation function type. Set when type is aggregation. */
|
|
1858
|
+
var WidgetQueryColumnConfigAggregation;
|
|
1859
|
+
(function (WidgetQueryColumnConfigAggregation) {
|
|
1860
|
+
WidgetQueryColumnConfigAggregation["Avg"] = "avg";
|
|
1861
|
+
WidgetQueryColumnConfigAggregation["Count"] = "count";
|
|
1862
|
+
WidgetQueryColumnConfigAggregation["CountDistinct"] = "count_distinct";
|
|
1863
|
+
WidgetQueryColumnConfigAggregation["Max"] = "max";
|
|
1864
|
+
WidgetQueryColumnConfigAggregation["Median"] = "median";
|
|
1865
|
+
WidgetQueryColumnConfigAggregation["Min"] = "min";
|
|
1866
|
+
WidgetQueryColumnConfigAggregation["P50"] = "p50";
|
|
1867
|
+
WidgetQueryColumnConfigAggregation["P90"] = "p90";
|
|
1868
|
+
WidgetQueryColumnConfigAggregation["P95"] = "p95";
|
|
1869
|
+
WidgetQueryColumnConfigAggregation["P99"] = "p99";
|
|
1870
|
+
WidgetQueryColumnConfigAggregation["Sum"] = "sum";
|
|
1871
|
+
})(WidgetQueryColumnConfigAggregation = exports.WidgetQueryColumnConfigAggregation || (exports.WidgetQueryColumnConfigAggregation = {}));
|
|
1872
|
+
/** The time granularity for bucketing. Set when type is time_granularity. */
|
|
1873
|
+
var WidgetQueryColumnConfigTimeGranularity;
|
|
1874
|
+
(function (WidgetQueryColumnConfigTimeGranularity) {
|
|
1875
|
+
WidgetQueryColumnConfigTimeGranularity["Day"] = "day";
|
|
1876
|
+
WidgetQueryColumnConfigTimeGranularity["Hour"] = "hour";
|
|
1877
|
+
WidgetQueryColumnConfigTimeGranularity["Month"] = "month";
|
|
1878
|
+
WidgetQueryColumnConfigTimeGranularity["Week"] = "week";
|
|
1879
|
+
WidgetQueryColumnConfigTimeGranularity["Year"] = "year";
|
|
1880
|
+
})(WidgetQueryColumnConfigTimeGranularity = exports.WidgetQueryColumnConfigTimeGranularity || (exports.WidgetQueryColumnConfigTimeGranularity = {}));
|
|
1881
|
+
/**
|
|
1882
|
+
* The category of the query-time operation. Time_granularity buckets
|
|
1883
|
+
* timestamp values by granularity. Aggregation applies an aggregate
|
|
1884
|
+
* function to the column. When omitted the column is a plain reference.
|
|
1885
|
+
*/
|
|
1886
|
+
var WidgetQueryColumnConfigType;
|
|
1887
|
+
(function (WidgetQueryColumnConfigType) {
|
|
1888
|
+
WidgetQueryColumnConfigType["Aggregation"] = "aggregation";
|
|
1889
|
+
WidgetQueryColumnConfigType["TimeGranularity"] = "time_granularity";
|
|
1890
|
+
})(WidgetQueryColumnConfigType = exports.WidgetQueryColumnConfigType || (exports.WidgetQueryColumnConfigType = {}));
|
|
1787
1891
|
/** The direction of the sort. */
|
|
1788
1892
|
var WidgetQueryOrderByDirection;
|
|
1789
1893
|
(function (WidgetQueryOrderByDirection) {
|
|
@@ -2198,7 +2302,7 @@ class Api extends HttpClient {
|
|
|
2198
2302
|
*/
|
|
2199
2303
|
this.artifactsVersionsPrepare = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.versions.prepare`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2200
2304
|
/**
|
|
2201
|
-
* @description Gets the specified object.
|
|
2305
|
+
* @description Gets the specified object. **Required scopes:** Depends on the object type identified by the `id` field. Pattern: `{object_type}:read` — e.g. `issue:read`, `ticket:read`.
|
|
2202
2306
|
*
|
|
2203
2307
|
* @tags atoms
|
|
2204
2308
|
* @name AtomsGet
|
|
@@ -2208,7 +2312,7 @@ class Api extends HttpClient {
|
|
|
2208
2312
|
*/
|
|
2209
2313
|
this.atomsGet = (query, params = {}) => this.request(Object.assign({ path: `/atoms.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
2210
2314
|
/**
|
|
2211
|
-
* @description Gets the specified object.
|
|
2315
|
+
* @description Gets the specified object. **Required scopes:** Depends on the object type identified by the `id` field. Pattern: `{object_type}:read` — e.g. `issue:read`, `ticket:read`.
|
|
2212
2316
|
*
|
|
2213
2317
|
* @tags atoms
|
|
2214
2318
|
* @name AtomsGetPost
|
|
@@ -2652,7 +2756,7 @@ class Api extends HttpClient {
|
|
|
2652
2756
|
*/
|
|
2653
2757
|
this.customObjectsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2654
2758
|
/**
|
|
2655
|
-
* @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. Only 5 authentication connections can be created by an organization.
|
|
2759
|
+
* @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. Only 5 authentication connections can be created by an organization. **Required scopes:** - `dev_org:write`
|
|
2656
2760
|
*
|
|
2657
2761
|
* @tags auth-connections, dev-orgs
|
|
2658
2762
|
* @name DevOrgAuthConnectionsCreate
|
|
@@ -2662,7 +2766,7 @@ class Api extends HttpClient {
|
|
|
2662
2766
|
*/
|
|
2663
2767
|
this.devOrgAuthConnectionsCreate = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2664
2768
|
/**
|
|
2665
|
-
* @description Deletes an authentication connection. Only enterprise connections which are explicitly set up for a Dev organization can be deleted. Default connections can not be deleted using this method.
|
|
2769
|
+
* @description Deletes an authentication connection. Only enterprise connections which are explicitly set up for a Dev organization can be deleted. Default connections can not be deleted using this method. **Required scopes:** - `dev_org:all`
|
|
2666
2770
|
*
|
|
2667
2771
|
* @tags auth-connections, dev-orgs
|
|
2668
2772
|
* @name DevOrgAuthConnectionsDelete
|
|
@@ -2672,7 +2776,7 @@ class Api extends HttpClient {
|
|
|
2672
2776
|
*/
|
|
2673
2777
|
this.devOrgAuthConnectionsDelete = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
|
|
2674
2778
|
/**
|
|
2675
|
-
* @description Retrieves the details for an authentication connection.
|
|
2779
|
+
* @description Retrieves the details for an authentication connection. **Required scopes:** - `dev_org:read`
|
|
2676
2780
|
*
|
|
2677
2781
|
* @tags auth-connections, dev-orgs
|
|
2678
2782
|
* @name DevOrgAuthConnectionsGet
|
|
@@ -2682,7 +2786,7 @@ class Api extends HttpClient {
|
|
|
2682
2786
|
*/
|
|
2683
2787
|
this.devOrgAuthConnectionsGet = (query, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
2684
2788
|
/**
|
|
2685
|
-
* @description Retrieves the details for an authentication connection.
|
|
2789
|
+
* @description Retrieves the details for an authentication connection. **Required scopes:** - `dev_org:read`
|
|
2686
2790
|
*
|
|
2687
2791
|
* @tags auth-connections, dev-orgs
|
|
2688
2792
|
* @name DevOrgAuthConnectionsGetPost
|
|
@@ -2692,7 +2796,7 @@ class Api extends HttpClient {
|
|
|
2692
2796
|
*/
|
|
2693
2797
|
this.devOrgAuthConnectionsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2694
2798
|
/**
|
|
2695
|
-
* @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user.
|
|
2799
|
+
* @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user. **Required scopes:** - `dev_org:read`
|
|
2696
2800
|
*
|
|
2697
2801
|
* @tags auth-connections, dev-orgs
|
|
2698
2802
|
* @name DevOrgAuthConnectionsList
|
|
@@ -2702,7 +2806,7 @@ class Api extends HttpClient {
|
|
|
2702
2806
|
*/
|
|
2703
2807
|
this.devOrgAuthConnectionsList = (params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.list`, method: 'GET', secure: true, format: 'json' }, params));
|
|
2704
2808
|
/**
|
|
2705
|
-
* @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user.
|
|
2809
|
+
* @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user. **Required scopes:** - `dev_org:read`
|
|
2706
2810
|
*
|
|
2707
2811
|
* @tags auth-connections, dev-orgs
|
|
2708
2812
|
* @name DevOrgAuthConnectionsListPost
|
|
@@ -2712,7 +2816,7 @@ class Api extends HttpClient {
|
|
|
2712
2816
|
*/
|
|
2713
2817
|
this.devOrgAuthConnectionsListPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2714
2818
|
/**
|
|
2715
|
-
* @description Enable or disable an authentication connection for a Dev organization. Atleast one authentication connection must be enabled for a Dev organization.
|
|
2819
|
+
* @description Enable or disable an authentication connection for a Dev organization. Atleast one authentication connection must be enabled for a Dev organization. **Required scopes:** - `dev_org:write`
|
|
2716
2820
|
*
|
|
2717
2821
|
* @tags auth-connections, dev-orgs
|
|
2718
2822
|
* @name DevOrgAuthConnectionsToggle
|
|
@@ -2722,7 +2826,7 @@ class Api extends HttpClient {
|
|
|
2722
2826
|
*/
|
|
2723
2827
|
this.devOrgAuthConnectionsToggle = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.toggle`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
|
|
2724
2828
|
/**
|
|
2725
|
-
* @description Updates an authentication connection.
|
|
2829
|
+
* @description Updates an authentication connection. **Required scopes:** - `dev_org:write`
|
|
2726
2830
|
*
|
|
2727
2831
|
* @tags auth-connections, dev-orgs
|
|
2728
2832
|
* @name DevOrgAuthConnectionsUpdate
|
|
@@ -2732,7 +2836,7 @@ class Api extends HttpClient {
|
|
|
2732
2836
|
*/
|
|
2733
2837
|
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));
|
|
2734
2838
|
/**
|
|
2735
|
-
* @description Gets the Dev organization's information of the authenticated user.
|
|
2839
|
+
* @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
|
|
2736
2840
|
*
|
|
2737
2841
|
* @tags dev-orgs
|
|
2738
2842
|
* @name DevOrgsGet
|
|
@@ -2742,7 +2846,7 @@ class Api extends HttpClient {
|
|
|
2742
2846
|
*/
|
|
2743
2847
|
this.devOrgsGet = (params = {}) => this.request(Object.assign({ path: `/dev-orgs.get`, method: 'GET', secure: true, format: 'json' }, params));
|
|
2744
2848
|
/**
|
|
2745
|
-
* @description Gets the Dev organization's information of the authenticated user.
|
|
2849
|
+
* @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
|
|
2746
2850
|
*
|
|
2747
2851
|
* @tags dev-orgs
|
|
2748
2852
|
* @name DevOrgsGetPost
|
|
@@ -2752,7 +2856,7 @@ class Api extends HttpClient {
|
|
|
2752
2856
|
*/
|
|
2753
2857
|
this.devOrgsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2754
2858
|
/**
|
|
2755
|
-
* @description Activates the requested user.
|
|
2859
|
+
* @description Activates the requested user. **Required scopes:** - `dev_user:write`
|
|
2756
2860
|
*
|
|
2757
2861
|
* @tags dev-users
|
|
2758
2862
|
* @name DevUsersActivate
|
|
@@ -2762,7 +2866,7 @@ class Api extends HttpClient {
|
|
|
2762
2866
|
*/
|
|
2763
2867
|
this.devUsersActivate = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.activate`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2764
2868
|
/**
|
|
2765
|
-
* @description Creates a Dev user for a Dev organization.
|
|
2869
|
+
* @description Creates a Dev user for a Dev organization. **Required scopes:** - `dev_user:write`
|
|
2766
2870
|
*
|
|
2767
2871
|
* @tags dev-users
|
|
2768
2872
|
* @name DevUsersCreate
|
|
@@ -2772,7 +2876,7 @@ class Api extends HttpClient {
|
|
|
2772
2876
|
*/
|
|
2773
2877
|
this.devUsersCreate = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2774
2878
|
/**
|
|
2775
|
-
* @description Deactivates the requested user.
|
|
2879
|
+
* @description Deactivates the requested user. **Required scopes:** - `dev_user:all`
|
|
2776
2880
|
*
|
|
2777
2881
|
* @tags dev-users
|
|
2778
2882
|
* @name DevUsersDeactivate
|
|
@@ -2782,7 +2886,7 @@ class Api extends HttpClient {
|
|
|
2782
2886
|
*/
|
|
2783
2887
|
this.devUsersDeactivate = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.deactivate`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2784
2888
|
/**
|
|
2785
|
-
* @description Gets the requested user's information.
|
|
2889
|
+
* @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
|
|
2786
2890
|
*
|
|
2787
2891
|
* @tags dev-users
|
|
2788
2892
|
* @name DevUsersGet
|
|
@@ -2792,7 +2896,7 @@ class Api extends HttpClient {
|
|
|
2792
2896
|
*/
|
|
2793
2897
|
this.devUsersGet = (query, params = {}) => this.request(Object.assign({ path: `/dev-users.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
2794
2898
|
/**
|
|
2795
|
-
* @description Gets the requested user's information.
|
|
2899
|
+
* @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
|
|
2796
2900
|
*
|
|
2797
2901
|
* @tags dev-users
|
|
2798
2902
|
* @name DevUsersGetPost
|
|
@@ -2802,7 +2906,7 @@ class Api extends HttpClient {
|
|
|
2802
2906
|
*/
|
|
2803
2907
|
this.devUsersGetPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2804
2908
|
/**
|
|
2805
|
-
* @description Links an external/secondary identity to the Dev user.
|
|
2909
|
+
* @description Links an external/secondary identity to the Dev user. **Required scopes:** - `dev_user:write`
|
|
2806
2910
|
*
|
|
2807
2911
|
* @tags dev-users
|
|
2808
2912
|
* @name DevUsersIdentitiesLink
|
|
@@ -2812,7 +2916,7 @@ class Api extends HttpClient {
|
|
|
2812
2916
|
*/
|
|
2813
2917
|
this.devUsersIdentitiesLink = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.identities.link`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2814
2918
|
/**
|
|
2815
|
-
* @description Unlinks an external/secondary identity from the Dev user.
|
|
2919
|
+
* @description Unlinks an external/secondary identity from the Dev user. **Required scopes:** - `dev_user:write`
|
|
2816
2920
|
*
|
|
2817
2921
|
* @tags dev-users
|
|
2818
2922
|
* @name DevUsersIdentitiesUnlink
|
|
@@ -2822,7 +2926,7 @@ class Api extends HttpClient {
|
|
|
2822
2926
|
*/
|
|
2823
2927
|
this.devUsersIdentitiesUnlink = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.identities.unlink`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2824
2928
|
/**
|
|
2825
|
-
* @description Lists users within your organization.
|
|
2929
|
+
* @description Lists users within your organization. **Required scopes:** - `dev_user:read`
|
|
2826
2930
|
*
|
|
2827
2931
|
* @tags dev-users
|
|
2828
2932
|
* @name DevUsersList
|
|
@@ -2832,7 +2936,7 @@ class Api extends HttpClient {
|
|
|
2832
2936
|
*/
|
|
2833
2937
|
this.devUsersList = (query, params = {}) => this.request(Object.assign({ path: `/dev-users.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
2834
2938
|
/**
|
|
2835
|
-
* @description Lists users within your organization.
|
|
2939
|
+
* @description Lists users within your organization. **Required scopes:** - `dev_user:read`
|
|
2836
2940
|
*
|
|
2837
2941
|
* @tags dev-users
|
|
2838
2942
|
* @name DevUsersListPost
|
|
@@ -2842,7 +2946,7 @@ class Api extends HttpClient {
|
|
|
2842
2946
|
*/
|
|
2843
2947
|
this.devUsersListPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2844
2948
|
/**
|
|
2845
|
-
* @description Merges the identity of a secondary Dev user with the primary Dev user. The account of the secondary Dev user will be deactivated and will no longer be able to log into DevRev. All objects - issues, tickets, parts etc. owned by the secondary Dev user will be transferred to the primary Dev user.
|
|
2949
|
+
* @description Merges the identity of a secondary Dev user with the primary Dev user. The account of the secondary Dev user will be deactivated and will no longer be able to log into DevRev. All objects - issues, tickets, parts etc. owned by the secondary Dev user will be transferred to the primary Dev user. **Required scopes:** - `dev_user:all`
|
|
2846
2950
|
*
|
|
2847
2951
|
* @tags dev-users
|
|
2848
2952
|
* @name DevUsersMerge
|
|
@@ -2852,7 +2956,7 @@ class Api extends HttpClient {
|
|
|
2852
2956
|
*/
|
|
2853
2957
|
this.devUsersMerge = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.merge`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2854
2958
|
/**
|
|
2855
|
-
* @description Gets the authenticated user's information.
|
|
2959
|
+
* @description Gets the authenticated user's information. **Required scopes:** No scopes required
|
|
2856
2960
|
*
|
|
2857
2961
|
* @tags dev-users
|
|
2858
2962
|
* @name DevUsersSelf
|
|
@@ -2862,7 +2966,7 @@ class Api extends HttpClient {
|
|
|
2862
2966
|
*/
|
|
2863
2967
|
this.devUsersSelf = (params = {}) => this.request(Object.assign({ path: `/dev-users.self`, method: 'GET', secure: true, format: 'json' }, params));
|
|
2864
2968
|
/**
|
|
2865
|
-
* @description Gets the authenticated user's information.
|
|
2969
|
+
* @description Gets the authenticated user's information. **Required scopes:** No scopes required
|
|
2866
2970
|
*
|
|
2867
2971
|
* @tags dev-users
|
|
2868
2972
|
* @name DevUsersSelfPost
|
|
@@ -2872,7 +2976,7 @@ class Api extends HttpClient {
|
|
|
2872
2976
|
*/
|
|
2873
2977
|
this.devUsersSelfPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.self`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2874
2978
|
/**
|
|
2875
|
-
* @description Updates the authenticated user.
|
|
2979
|
+
* @description Updates the authenticated user. **Required scopes:** No scopes required
|
|
2876
2980
|
*
|
|
2877
2981
|
* @tags dev-users
|
|
2878
2982
|
* @name DevUsersSelfUpdate
|
|
@@ -2882,7 +2986,7 @@ class Api extends HttpClient {
|
|
|
2882
2986
|
*/
|
|
2883
2987
|
this.devUsersSelfUpdate = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.self.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2884
2988
|
/**
|
|
2885
|
-
* @description Updates the user corresponding to the input Id.
|
|
2989
|
+
* @description Updates the user corresponding to the input Id. **Required scopes:** - `dev_user:write`
|
|
2886
2990
|
*
|
|
2887
2991
|
* @tags dev-users
|
|
2888
2992
|
* @name DevUsersUpdate
|
|
@@ -2982,7 +3086,7 @@ class Api extends HttpClient {
|
|
|
2982
3086
|
*/
|
|
2983
3087
|
this.directoriesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/directories.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2984
3088
|
/**
|
|
2985
|
-
* @description Creates a new group. A group is a collection of users.
|
|
3089
|
+
* @description Creates a new group. A group is a collection of users. **Required scopes:** - `group:write`
|
|
2986
3090
|
*
|
|
2987
3091
|
* @tags groups
|
|
2988
3092
|
* @name GroupsCreate
|
|
@@ -2992,7 +3096,7 @@ class Api extends HttpClient {
|
|
|
2992
3096
|
*/
|
|
2993
3097
|
this.groupsCreate = (data, params = {}) => this.request(Object.assign({ path: `/groups.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2994
3098
|
/**
|
|
2995
|
-
* @description Gets the requested group.
|
|
3099
|
+
* @description Gets the requested group. **Required scopes:** - `group:read`
|
|
2996
3100
|
*
|
|
2997
3101
|
* @tags groups
|
|
2998
3102
|
* @name GroupsGet
|
|
@@ -3002,7 +3106,7 @@ class Api extends HttpClient {
|
|
|
3002
3106
|
*/
|
|
3003
3107
|
this.groupsGet = (query, params = {}) => this.request(Object.assign({ path: `/groups.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
3004
3108
|
/**
|
|
3005
|
-
* @description Gets the requested group.
|
|
3109
|
+
* @description Gets the requested group. **Required scopes:** - `group:read`
|
|
3006
3110
|
*
|
|
3007
3111
|
* @tags groups
|
|
3008
3112
|
* @name GroupsGetPost
|
|
@@ -3012,7 +3116,7 @@ class Api extends HttpClient {
|
|
|
3012
3116
|
*/
|
|
3013
3117
|
this.groupsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/groups.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3014
3118
|
/**
|
|
3015
|
-
* @description Lists the available groups.
|
|
3119
|
+
* @description Lists the available groups. **Required scopes:** - `group:read`
|
|
3016
3120
|
*
|
|
3017
3121
|
* @tags groups
|
|
3018
3122
|
* @name GroupsList
|
|
@@ -3022,7 +3126,7 @@ class Api extends HttpClient {
|
|
|
3022
3126
|
*/
|
|
3023
3127
|
this.groupsList = (query, params = {}) => this.request(Object.assign({ path: `/groups.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
3024
3128
|
/**
|
|
3025
|
-
* @description Lists the available groups.
|
|
3129
|
+
* @description Lists the available groups. **Required scopes:** - `group:read`
|
|
3026
3130
|
*
|
|
3027
3131
|
* @tags groups
|
|
3028
3132
|
* @name GroupsListPost
|
|
@@ -3032,7 +3136,7 @@ class Api extends HttpClient {
|
|
|
3032
3136
|
*/
|
|
3033
3137
|
this.groupsListPost = (data, params = {}) => this.request(Object.assign({ path: `/groups.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3034
3138
|
/**
|
|
3035
|
-
* @description Adds a member to a group.
|
|
3139
|
+
* @description Adds a member to a group. **Required scopes:** - `group_membership:write`
|
|
3036
3140
|
*
|
|
3037
3141
|
* @tags groups
|
|
3038
3142
|
* @name GroupMembersAdd
|
|
@@ -3042,7 +3146,7 @@ class Api extends HttpClient {
|
|
|
3042
3146
|
*/
|
|
3043
3147
|
this.groupMembersAdd = (data, params = {}) => this.request(Object.assign({ path: `/groups.members.add`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3044
3148
|
/**
|
|
3045
|
-
* @description Lists the members in a group.
|
|
3149
|
+
* @description Lists the members in a group. **Required scopes:** - `group_membership:read`
|
|
3046
3150
|
*
|
|
3047
3151
|
* @tags groups
|
|
3048
3152
|
* @name GroupMembersList
|
|
@@ -3052,7 +3156,7 @@ class Api extends HttpClient {
|
|
|
3052
3156
|
*/
|
|
3053
3157
|
this.groupMembersList = (query, params = {}) => this.request(Object.assign({ path: `/groups.members.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
3054
3158
|
/**
|
|
3055
|
-
* @description Lists the members in a group.
|
|
3159
|
+
* @description Lists the members in a group. **Required scopes:** - `group_membership:read`
|
|
3056
3160
|
*
|
|
3057
3161
|
* @tags groups
|
|
3058
3162
|
* @name GroupMembersListPost
|
|
@@ -3062,7 +3166,7 @@ class Api extends HttpClient {
|
|
|
3062
3166
|
*/
|
|
3063
3167
|
this.groupMembersListPost = (data, params = {}) => this.request(Object.assign({ path: `/groups.members.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3064
3168
|
/**
|
|
3065
|
-
* @description Removes a member from a group.
|
|
3169
|
+
* @description Removes a member from a group. **Required scopes:** - `group_membership:write`
|
|
3066
3170
|
*
|
|
3067
3171
|
* @tags groups
|
|
3068
3172
|
* @name GroupMembersRemove
|
|
@@ -3072,7 +3176,7 @@ class Api extends HttpClient {
|
|
|
3072
3176
|
*/
|
|
3073
3177
|
this.groupMembersRemove = (data, params = {}) => this.request(Object.assign({ path: `/groups.members.remove`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3074
3178
|
/**
|
|
3075
|
-
* @description Updates the requested group.
|
|
3179
|
+
* @description Updates the requested group. **Required scopes:** - `group:write`
|
|
3076
3180
|
*
|
|
3077
3181
|
* @tags groups
|
|
3078
3182
|
* @name GroupsUpdate
|
|
@@ -3151,7 +3255,7 @@ class Api extends HttpClient {
|
|
|
3151
3255
|
*/
|
|
3152
3256
|
this.linksCreate = (data, params = {}) => this.request(Object.assign({ path: `/links.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3153
3257
|
/**
|
|
3154
|
-
* @description Deletes a link.
|
|
3258
|
+
* @description Deletes a link between two objects. Note that for part hierarchy links (e.g. enhancement to capability), deleting a link may leave an orphan object with no parent. If the intent is to re-parent an object rather than unlink it entirely, use `links.replace` instead, which atomically removes the old link and creates a new one in a single transaction.
|
|
3155
3259
|
*
|
|
3156
3260
|
* @tags links
|
|
3157
3261
|
* @name LinksDelete
|
|
@@ -3201,7 +3305,7 @@ class Api extends HttpClient {
|
|
|
3201
3305
|
*/
|
|
3202
3306
|
this.linksListPost = (data, params = {}) => this.request(Object.assign({ path: `/links.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3203
3307
|
/**
|
|
3204
|
-
* @description Replaces a link.
|
|
3308
|
+
* @description Replaces an existing link with a new one. This is useful when an object must always remain linked to a parent — for example, re-parenting an enhancement under a different capability or product part — because it avoids the intermediate unlinked (orphan) state that would otherwise occur if you deleted the old link and created a new one as two separate steps. The existing link identified by `id` is removed and a new link is created from `source` to `target`. Optionally, a different `link_type` or `custom_link_type` can be specified for the new link. For links between parts using a default (non-custom) link type, the replacement is performed atomically. For all other cases (custom link types or non-part endpoints), the replacement is performed as a non-atomic delete followed by a create; in these cases, the new link must have the same link type (or the same `custom_link_type` DON) as the existing link, and must share at least one of the source or target with the existing link, otherwise the request is rejected.
|
|
3205
3309
|
*
|
|
3206
3310
|
* @tags links
|
|
3207
3311
|
* @name LinksReplace
|
|
@@ -3400,6 +3504,16 @@ class Api extends HttpClient {
|
|
|
3400
3504
|
* @secure
|
|
3401
3505
|
*/
|
|
3402
3506
|
this.metricTrackersGetPost = (data, params = {}) => this.request(Object.assign({ path: `/metric-trackers.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3507
|
+
/**
|
|
3508
|
+
* @description Aggregates the sessions data.
|
|
3509
|
+
*
|
|
3510
|
+
* @tags observability
|
|
3511
|
+
* @name ObservabilitySessionsAggregate
|
|
3512
|
+
* @summary Aggregate Observability Sessions
|
|
3513
|
+
* @request POST:/observability.sessions.aggregate
|
|
3514
|
+
* @secure
|
|
3515
|
+
*/
|
|
3516
|
+
this.observabilitySessionsAggregate = (data, params = {}) => this.request(Object.assign({ path: `/observability.sessions.aggregate`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3403
3517
|
/**
|
|
3404
3518
|
* @description Retrieves the recording data for a specific session ID and recording ID. For mobile sessions, requires both session_id and recording_id. For web sessions, requires both session_id and tab_id.
|
|
3405
3519
|
*
|
|
@@ -3420,6 +3534,26 @@ class Api extends HttpClient {
|
|
|
3420
3534
|
* @secure
|
|
3421
3535
|
*/
|
|
3422
3536
|
this.observabilitySessionsDataGetPost = (data, params = {}) => this.request(Object.assign({ path: `/observability.sessions.data.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3537
|
+
/**
|
|
3538
|
+
* @description Retrieves detailed console and network data for debugging.
|
|
3539
|
+
*
|
|
3540
|
+
* @tags observability
|
|
3541
|
+
* @name ObservabilitySessionsDeveloperInfoGet
|
|
3542
|
+
* @summary Get Observability Sessions Developer Info
|
|
3543
|
+
* @request GET:/observability.sessions.developer-info.get
|
|
3544
|
+
* @secure
|
|
3545
|
+
*/
|
|
3546
|
+
this.observabilitySessionsDeveloperInfoGet = (query, params = {}) => this.request(Object.assign({ path: `/observability.sessions.developer-info.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
3547
|
+
/**
|
|
3548
|
+
* @description Retrieves detailed console and network data for debugging.
|
|
3549
|
+
*
|
|
3550
|
+
* @tags observability
|
|
3551
|
+
* @name ObservabilitySessionsDeveloperInfoGetPost
|
|
3552
|
+
* @summary Get Observability Sessions Developer Info (POST)
|
|
3553
|
+
* @request POST:/observability.sessions.developer-info.get
|
|
3554
|
+
* @secure
|
|
3555
|
+
*/
|
|
3556
|
+
this.observabilitySessionsDeveloperInfoGetPost = (data, params = {}) => this.request(Object.assign({ path: `/observability.sessions.developer-info.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3423
3557
|
/**
|
|
3424
3558
|
* @description Gets a specific session metadata by ID.
|
|
3425
3559
|
*
|
|
@@ -3671,7 +3805,7 @@ class Api extends HttpClient {
|
|
|
3671
3805
|
*/
|
|
3672
3806
|
this.partsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/parts.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3673
3807
|
/**
|
|
3674
|
-
* @description Pings the DevRev service.
|
|
3808
|
+
* @description Pings the DevRev service. **Required scopes:** No scopes required.
|
|
3675
3809
|
*
|
|
3676
3810
|
* @name Ping
|
|
3677
3811
|
* @summary Ping
|
|
@@ -3680,7 +3814,7 @@ class Api extends HttpClient {
|
|
|
3680
3814
|
*/
|
|
3681
3815
|
this.ping = (query, params = {}) => this.request(Object.assign({ path: `/ping`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
3682
3816
|
/**
|
|
3683
|
-
* @description Pings the DevRev service.
|
|
3817
|
+
* @description Pings the DevRev service. **Required scopes:** No scopes required.
|
|
3684
3818
|
*
|
|
3685
3819
|
* @name PingPost
|
|
3686
3820
|
* @summary Ping (POST)
|
|
@@ -3719,7 +3853,7 @@ class Api extends HttpClient {
|
|
|
3719
3853
|
*/
|
|
3720
3854
|
this.reactionsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/reactions.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3721
3855
|
/**
|
|
3722
|
-
* @description Creates a Rev organization in the authenticated user's Dev organization.
|
|
3856
|
+
* @description Creates a Rev organization in the authenticated user's Dev organization. **Required scopes:** - `rev_org:write`
|
|
3723
3857
|
*
|
|
3724
3858
|
* @tags rev-orgs
|
|
3725
3859
|
* @name RevOrgsCreate
|
|
@@ -3729,7 +3863,7 @@ class Api extends HttpClient {
|
|
|
3729
3863
|
*/
|
|
3730
3864
|
this.revOrgsCreate = (data, params = {}) => this.request(Object.assign({ path: `/rev-orgs.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3731
3865
|
/**
|
|
3732
|
-
* @description Deletes the Rev organization.
|
|
3866
|
+
* @description Deletes the Rev organization. **Required scopes:** - `rev_org:all`
|
|
3733
3867
|
*
|
|
3734
3868
|
* @tags rev-orgs
|
|
3735
3869
|
* @name RevOrgsDelete
|
|
@@ -3739,7 +3873,7 @@ class Api extends HttpClient {
|
|
|
3739
3873
|
*/
|
|
3740
3874
|
this.revOrgsDelete = (data, params = {}) => this.request(Object.assign({ path: `/rev-orgs.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3741
3875
|
/**
|
|
3742
|
-
* @description Retrieves the Rev organization's information.
|
|
3876
|
+
* @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
|
|
3743
3877
|
*
|
|
3744
3878
|
* @tags rev-orgs
|
|
3745
3879
|
* @name RevOrgsGet
|
|
@@ -3749,7 +3883,7 @@ class Api extends HttpClient {
|
|
|
3749
3883
|
*/
|
|
3750
3884
|
this.revOrgsGet = (query, params = {}) => this.request(Object.assign({ path: `/rev-orgs.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
3751
3885
|
/**
|
|
3752
|
-
* @description Retrieves the Rev organization's information.
|
|
3886
|
+
* @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
|
|
3753
3887
|
*
|
|
3754
3888
|
* @tags rev-orgs
|
|
3755
3889
|
* @name RevOrgsGetPost
|
|
@@ -3759,7 +3893,7 @@ class Api extends HttpClient {
|
|
|
3759
3893
|
*/
|
|
3760
3894
|
this.revOrgsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-orgs.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3761
3895
|
/**
|
|
3762
|
-
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
3896
|
+
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access. **Required scopes:** - `rev_org:read`
|
|
3763
3897
|
*
|
|
3764
3898
|
* @tags rev-orgs
|
|
3765
3899
|
* @name RevOrgsList
|
|
@@ -3769,7 +3903,7 @@ class Api extends HttpClient {
|
|
|
3769
3903
|
*/
|
|
3770
3904
|
this.revOrgsList = (query, params = {}) => this.request(Object.assign({ path: `/rev-orgs.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
3771
3905
|
/**
|
|
3772
|
-
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
3906
|
+
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access. **Required scopes:** - `rev_org:read`
|
|
3773
3907
|
*
|
|
3774
3908
|
* @tags rev-orgs
|
|
3775
3909
|
* @name RevOrgsListPost
|
|
@@ -3779,7 +3913,7 @@ class Api extends HttpClient {
|
|
|
3779
3913
|
*/
|
|
3780
3914
|
this.revOrgsListPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-orgs.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3781
3915
|
/**
|
|
3782
|
-
* @description Updates the Rev organization's information.
|
|
3916
|
+
* @description Updates the Rev organization's information. **Required scopes:** - `rev_org:write`
|
|
3783
3917
|
*
|
|
3784
3918
|
* @tags rev-orgs
|
|
3785
3919
|
* @name RevOrgsUpdate
|
|
@@ -3789,7 +3923,7 @@ class Api extends HttpClient {
|
|
|
3789
3923
|
*/
|
|
3790
3924
|
this.revOrgsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/rev-orgs.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3791
3925
|
/**
|
|
3792
|
-
* @description Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization.
|
|
3926
|
+
* @description Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization. **Required scopes:** - `rev_user:write`
|
|
3793
3927
|
*
|
|
3794
3928
|
* @tags rev-users
|
|
3795
3929
|
* @name RevUsersCreate
|
|
@@ -3799,7 +3933,7 @@ class Api extends HttpClient {
|
|
|
3799
3933
|
*/
|
|
3800
3934
|
this.revUsersCreate = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3801
3935
|
/**
|
|
3802
|
-
* @description Deletes a Rev user.
|
|
3936
|
+
* @description Deletes a Rev user. **Required scopes:** - `rev_user:all`
|
|
3803
3937
|
*
|
|
3804
3938
|
* @tags rev-users
|
|
3805
3939
|
* @name RevUsersDelete
|
|
@@ -3809,7 +3943,7 @@ class Api extends HttpClient {
|
|
|
3809
3943
|
*/
|
|
3810
3944
|
this.revUsersDelete = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3811
3945
|
/**
|
|
3812
|
-
* @description Returns the Rev user of a Rev organization by its ID.
|
|
3946
|
+
* @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
|
|
3813
3947
|
*
|
|
3814
3948
|
* @tags rev-users
|
|
3815
3949
|
* @name RevUsersGet
|
|
@@ -3819,7 +3953,7 @@ class Api extends HttpClient {
|
|
|
3819
3953
|
*/
|
|
3820
3954
|
this.revUsersGet = (query, params = {}) => this.request(Object.assign({ path: `/rev-users.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
3821
3955
|
/**
|
|
3822
|
-
* @description Returns the Rev user of a Rev organization by its ID.
|
|
3956
|
+
* @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
|
|
3823
3957
|
*
|
|
3824
3958
|
* @tags rev-users
|
|
3825
3959
|
* @name RevUsersGetPost
|
|
@@ -3829,7 +3963,7 @@ class Api extends HttpClient {
|
|
|
3829
3963
|
*/
|
|
3830
3964
|
this.revUsersGetPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3831
3965
|
/**
|
|
3832
|
-
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization.
|
|
3966
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
|
|
3833
3967
|
*
|
|
3834
3968
|
* @tags rev-users
|
|
3835
3969
|
* @name RevUsersList
|
|
@@ -3839,7 +3973,7 @@ class Api extends HttpClient {
|
|
|
3839
3973
|
*/
|
|
3840
3974
|
this.revUsersList = (query, params = {}) => this.request(Object.assign({ path: `/rev-users.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
3841
3975
|
/**
|
|
3842
|
-
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization.
|
|
3976
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
|
|
3843
3977
|
*
|
|
3844
3978
|
* @tags rev-users
|
|
3845
3979
|
* @name RevUsersListPost
|
|
@@ -3849,7 +3983,7 @@ class Api extends HttpClient {
|
|
|
3849
3983
|
*/
|
|
3850
3984
|
this.revUsersListPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3851
3985
|
/**
|
|
3852
|
-
* @description Merges the secondary Rev user into the primary Rev user.
|
|
3986
|
+
* @description Merges the secondary Rev user into the primary Rev user. **Required scopes:** - `rev_user:all`
|
|
3853
3987
|
*
|
|
3854
3988
|
* @tags rev-users
|
|
3855
3989
|
* @name RevUsersMerge
|
|
@@ -3859,7 +3993,7 @@ class Api extends HttpClient {
|
|
|
3859
3993
|
*/
|
|
3860
3994
|
this.revUsersMerge = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.merge`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3861
3995
|
/**
|
|
3862
|
-
* @description Scans through all Rev users.
|
|
3996
|
+
* @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
|
|
3863
3997
|
*
|
|
3864
3998
|
* @tags rev-users
|
|
3865
3999
|
* @name RevUsersScan
|
|
@@ -3869,7 +4003,7 @@ class Api extends HttpClient {
|
|
|
3869
4003
|
*/
|
|
3870
4004
|
this.revUsersScan = (query, params = {}) => this.request(Object.assign({ path: `/rev-users.scan`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
3871
4005
|
/**
|
|
3872
|
-
* @description Scans through all Rev users.
|
|
4006
|
+
* @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
|
|
3873
4007
|
*
|
|
3874
4008
|
* @tags rev-users
|
|
3875
4009
|
* @name RevUsersScanPost
|
|
@@ -3879,7 +4013,7 @@ class Api extends HttpClient {
|
|
|
3879
4013
|
*/
|
|
3880
4014
|
this.revUsersScanPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.scan`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3881
4015
|
/**
|
|
3882
|
-
* @description Updates a Rev user.
|
|
4016
|
+
* @description Updates a Rev user. **Required scopes:** - `rev_user:write`
|
|
3883
4017
|
*
|
|
3884
4018
|
* @tags rev-users
|
|
3885
4019
|
* @name RevUsersUpdate
|
|
@@ -4479,7 +4613,7 @@ class Api extends HttpClient {
|
|
|
4479
4613
|
*/
|
|
4480
4614
|
this.surveysUpdate = (data, params = {}) => this.request(Object.assign({ path: `/surveys.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
4481
4615
|
/**
|
|
4482
|
-
* @description Lists system users within your organization.
|
|
4616
|
+
* @description Lists system users within your organization. **Required scopes:** - `dev_user:read`
|
|
4483
4617
|
*
|
|
4484
4618
|
* @tags sys-users
|
|
4485
4619
|
* @name SysUsersList
|
|
@@ -4489,7 +4623,7 @@ class Api extends HttpClient {
|
|
|
4489
4623
|
*/
|
|
4490
4624
|
this.sysUsersList = (query, params = {}) => this.request(Object.assign({ path: `/sys-users.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
4491
4625
|
/**
|
|
4492
|
-
* @description Lists system users within your organization.
|
|
4626
|
+
* @description Lists system users within your organization. **Required scopes:** - `dev_user:read`
|
|
4493
4627
|
*
|
|
4494
4628
|
* @tags sys-users
|
|
4495
4629
|
* @name SysUsersListPost
|
|
@@ -4499,7 +4633,7 @@ class Api extends HttpClient {
|
|
|
4499
4633
|
*/
|
|
4500
4634
|
this.sysUsersListPost = (data, params = {}) => this.request(Object.assign({ path: `/sys-users.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
4501
4635
|
/**
|
|
4502
|
-
* @description Updates the system user.
|
|
4636
|
+
* @description Updates the system user. **Required scopes:** - `dev_user:write`
|
|
4503
4637
|
*
|
|
4504
4638
|
* @tags sys-users
|
|
4505
4639
|
* @name SysUsersUpdate
|