@devrev/typescript-sdk 1.1.72 → 1.1.74
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.
|
@@ -2608,6 +2608,14 @@ export declare enum BooleanExpressionType {
|
|
|
2608
2608
|
export type Capability = PartBase;
|
|
2609
2609
|
/** capability-summary */
|
|
2610
2610
|
export type CapabilitySummary = PartBaseSummary;
|
|
2611
|
+
/**
|
|
2612
|
+
* card-view-ui-metadata
|
|
2613
|
+
* Card view UI hint overrides.
|
|
2614
|
+
*/
|
|
2615
|
+
export interface CardViewUiMetadata {
|
|
2616
|
+
/** True if field is visible in card view. */
|
|
2617
|
+
is_visible?: boolean;
|
|
2618
|
+
}
|
|
2611
2619
|
/** chat */
|
|
2612
2620
|
export type Chat = Dm & {
|
|
2613
2621
|
type: ChatType;
|
|
@@ -3455,6 +3463,52 @@ export declare enum ConfigurationProrationBehavior {
|
|
|
3455
3463
|
CreateProrations = "create_prorations",
|
|
3456
3464
|
None = "none"
|
|
3457
3465
|
}
|
|
3466
|
+
/** console-log-data */
|
|
3467
|
+
export interface ConsoleLogData {
|
|
3468
|
+
/** The type of console log. */
|
|
3469
|
+
type: ConsoleLogType;
|
|
3470
|
+
/**
|
|
3471
|
+
* Full URL of the console log.
|
|
3472
|
+
* @format text
|
|
3473
|
+
*/
|
|
3474
|
+
full_url: string;
|
|
3475
|
+
properties: ConsoleLogProperties;
|
|
3476
|
+
/**
|
|
3477
|
+
* Timestamp of the log entry.
|
|
3478
|
+
* @format date-time
|
|
3479
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3480
|
+
*/
|
|
3481
|
+
timestamp: string;
|
|
3482
|
+
/**
|
|
3483
|
+
* Value/content of the console log.
|
|
3484
|
+
* @format text
|
|
3485
|
+
*/
|
|
3486
|
+
value: string;
|
|
3487
|
+
}
|
|
3488
|
+
/** console-log-properties */
|
|
3489
|
+
export interface ConsoleLogProperties {
|
|
3490
|
+
/**
|
|
3491
|
+
* Normalized URL of the page.
|
|
3492
|
+
* @format text
|
|
3493
|
+
*/
|
|
3494
|
+
normalized_url: string;
|
|
3495
|
+
/**
|
|
3496
|
+
* Name of the page where the log occurred.
|
|
3497
|
+
* @format text
|
|
3498
|
+
*/
|
|
3499
|
+
page_name: string;
|
|
3500
|
+
/**
|
|
3501
|
+
* URL of the page where the log occurred.
|
|
3502
|
+
* @format text
|
|
3503
|
+
*/
|
|
3504
|
+
page_url: string;
|
|
3505
|
+
}
|
|
3506
|
+
/** The type of console log. */
|
|
3507
|
+
export declare enum ConsoleLogType {
|
|
3508
|
+
Error = "error",
|
|
3509
|
+
Log = "log",
|
|
3510
|
+
Warn = "warn"
|
|
3511
|
+
}
|
|
3458
3512
|
/** content-template-base */
|
|
3459
3513
|
export type ContentTemplateBase = AtomBase;
|
|
3460
3514
|
/** content-template-base-summary */
|
|
@@ -6139,6 +6193,11 @@ export interface DevUsersSelfUpdateRequest {
|
|
|
6139
6193
|
* @format text
|
|
6140
6194
|
*/
|
|
6141
6195
|
full_name?: string;
|
|
6196
|
+
/**
|
|
6197
|
+
* The job function of the Dev user.
|
|
6198
|
+
* @format text
|
|
6199
|
+
*/
|
|
6200
|
+
job_function?: string;
|
|
6142
6201
|
/** Job history of the Dev user. */
|
|
6143
6202
|
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
6144
6203
|
/** Job title of the Dev User. */
|
|
@@ -6279,6 +6338,11 @@ export interface DevUsersUpdateRequest {
|
|
|
6279
6338
|
* @format id
|
|
6280
6339
|
*/
|
|
6281
6340
|
id: string;
|
|
6341
|
+
/**
|
|
6342
|
+
* The job function of the Dev user.
|
|
6343
|
+
* @format text
|
|
6344
|
+
*/
|
|
6345
|
+
job_function?: string;
|
|
6282
6346
|
/** Job history of the Dev user. */
|
|
6283
6347
|
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
6284
6348
|
/** Job title of the Dev User. */
|
|
@@ -7436,6 +7500,13 @@ export declare enum ErrorBadRequestUnexpectedJsonTypeType {
|
|
|
7436
7500
|
}
|
|
7437
7501
|
/** error-bad-request-value-not-permitted */
|
|
7438
7502
|
export interface ErrorBadRequestValueNotPermitted {
|
|
7503
|
+
/**
|
|
7504
|
+
* The actual value that was provided.
|
|
7505
|
+
* @format text
|
|
7506
|
+
*/
|
|
7507
|
+
actual_value?: string;
|
|
7508
|
+
/** The allowed object types for ID fields. */
|
|
7509
|
+
allowed_object_types?: string[];
|
|
7439
7510
|
/** The allowed values for the field. */
|
|
7440
7511
|
allowed_values?: string[];
|
|
7441
7512
|
/**
|
|
@@ -7443,6 +7514,16 @@ export interface ErrorBadRequestValueNotPermitted {
|
|
|
7443
7514
|
* @format text
|
|
7444
7515
|
*/
|
|
7445
7516
|
field_name: string;
|
|
7517
|
+
/**
|
|
7518
|
+
* The maximum allowed value or length.
|
|
7519
|
+
* @format text
|
|
7520
|
+
*/
|
|
7521
|
+
max_value?: string;
|
|
7522
|
+
/**
|
|
7523
|
+
* The minimum allowed value or length.
|
|
7524
|
+
* @format text
|
|
7525
|
+
*/
|
|
7526
|
+
min_value?: string;
|
|
7446
7527
|
/**
|
|
7447
7528
|
* The pattern the value must match.
|
|
7448
7529
|
* @format text
|
|
@@ -9224,6 +9305,11 @@ export type Issue = WorkBase & {
|
|
|
9224
9305
|
actual_start_date?: string;
|
|
9225
9306
|
/** Parts associated based on git events. */
|
|
9226
9307
|
developed_with?: PartSummary[];
|
|
9308
|
+
/**
|
|
9309
|
+
* The space scoped display ID alias of the issue.
|
|
9310
|
+
* @format text
|
|
9311
|
+
*/
|
|
9312
|
+
display_id_alias?: string;
|
|
9227
9313
|
/**
|
|
9228
9314
|
* Estimated effort to complete the issue.
|
|
9229
9315
|
* @format double
|
|
@@ -9267,6 +9353,11 @@ export declare enum IssuePriority {
|
|
|
9267
9353
|
}
|
|
9268
9354
|
/** issue-summary */
|
|
9269
9355
|
export type IssueSummary = WorkBaseSummary & {
|
|
9356
|
+
/**
|
|
9357
|
+
* The space scoped display ID alias of the issue.
|
|
9358
|
+
* @format text
|
|
9359
|
+
*/
|
|
9360
|
+
display_id_alias?: string;
|
|
9270
9361
|
/** Priority of the work based upon impact and criticality. */
|
|
9271
9362
|
priority?: IssuePriority;
|
|
9272
9363
|
/** The properties of an enum value. */
|
|
@@ -9332,6 +9423,7 @@ export declare enum JobCategory {
|
|
|
9332
9423
|
MergeRevorg = "merge_revorg",
|
|
9333
9424
|
MergeRevuser = "merge_revuser",
|
|
9334
9425
|
MergeTicket = "merge_ticket",
|
|
9426
|
+
MigrateVistaReports = "migrate_vista_reports",
|
|
9335
9427
|
MoveRevorg = "move_revorg",
|
|
9336
9428
|
MoveRevuser = "move_revuser",
|
|
9337
9429
|
OasisDataExport = "oasis_data_export",
|
|
@@ -10023,6 +10115,14 @@ export type MarketplaceItemSummary = AtomBaseSummary & {
|
|
|
10023
10115
|
* (e.g. Jira AirSync).
|
|
10024
10116
|
*/
|
|
10025
10117
|
item_type?: MarketplaceItemItemType;
|
|
10118
|
+
/**
|
|
10119
|
+
* Meta score of the marketplace items. Its value must be in range
|
|
10120
|
+
* from 1 to 100000. It is used for ranking marketplace items on the
|
|
10121
|
+
* Marketplace home page. Items with higher meta_score will be placed
|
|
10122
|
+
* on the top of the list.
|
|
10123
|
+
* @format int64
|
|
10124
|
+
*/
|
|
10125
|
+
meta_score?: number;
|
|
10026
10126
|
/**
|
|
10027
10127
|
* Name of the marketplace listing. The value for a name can be any
|
|
10028
10128
|
* string with a minimum length of 3 and a maximum length of 128.
|
|
@@ -10049,7 +10149,9 @@ export type MarketplaceItemSummary = AtomBaseSummary & {
|
|
|
10049
10149
|
};
|
|
10050
10150
|
/**
|
|
10051
10151
|
* meerkat-widget-column-function
|
|
10052
|
-
*
|
|
10152
|
+
* Deprecated: Use widget_query_column_config with type=function on
|
|
10153
|
+
* widget_query.measure_configs or dimension_configs instead. A meerkat
|
|
10154
|
+
* specific column function.
|
|
10053
10155
|
*/
|
|
10054
10156
|
export interface MeerkatWidgetColumnFunction {
|
|
10055
10157
|
/** The type of the function. */
|
|
@@ -10076,7 +10178,11 @@ export declare enum MeerkatWidgetColumnFunctionType {
|
|
|
10076
10178
|
export interface MeerkatWidgetColumnProjection {
|
|
10077
10179
|
/** The data type of the column generated by the SQL expression. */
|
|
10078
10180
|
type: MeerkatWidgetColumnProjectionType;
|
|
10079
|
-
/**
|
|
10181
|
+
/**
|
|
10182
|
+
* Deprecated: Use widget_query_column_config with type=function on
|
|
10183
|
+
* widget_query.measure_configs or dimension_configs instead. A meerkat
|
|
10184
|
+
* specific column function.
|
|
10185
|
+
*/
|
|
10080
10186
|
function?: MeerkatWidgetColumnFunction;
|
|
10081
10187
|
/**
|
|
10082
10188
|
* The SQL expression used to extract or transform the column from the
|
|
@@ -10084,10 +10190,18 @@ export interface MeerkatWidgetColumnProjection {
|
|
|
10084
10190
|
* @format text
|
|
10085
10191
|
*/
|
|
10086
10192
|
sql_expression: string;
|
|
10087
|
-
/**
|
|
10193
|
+
/**
|
|
10194
|
+
* Deprecated: Use widget_query_column_config with type=timestamp on
|
|
10195
|
+
* widget_query.dimension_configs instead. The rollup granularity for the
|
|
10196
|
+
* timestamp.
|
|
10197
|
+
*/
|
|
10088
10198
|
timestamp_rollup?: MeerkatWidgetColumnProjectionTimestampRollup;
|
|
10089
10199
|
}
|
|
10090
|
-
/**
|
|
10200
|
+
/**
|
|
10201
|
+
* Deprecated: Use widget_query_column_config with type=timestamp on
|
|
10202
|
+
* widget_query.dimension_configs instead. The rollup granularity for the
|
|
10203
|
+
* timestamp.
|
|
10204
|
+
*/
|
|
10091
10205
|
export declare enum MeerkatWidgetColumnProjectionTimestampRollup {
|
|
10092
10206
|
Day = "day",
|
|
10093
10207
|
Hour = "hour",
|
|
@@ -10148,7 +10262,7 @@ export type Meeting = AtomBase & {
|
|
|
10148
10262
|
*/
|
|
10149
10263
|
external_url?: string;
|
|
10150
10264
|
/** The members in the meeting. */
|
|
10151
|
-
members
|
|
10265
|
+
members?: AtomSummary[];
|
|
10152
10266
|
organizer?: AtomSummary;
|
|
10153
10267
|
parent?: AtomSummary;
|
|
10154
10268
|
recording?: ArtifactSummary;
|
|
@@ -10327,7 +10441,7 @@ export interface MeetingsCreateRequest {
|
|
|
10327
10441
|
external_url?: string;
|
|
10328
10442
|
/**
|
|
10329
10443
|
* IDs of the users or groups that were part of the meeting.
|
|
10330
|
-
* @maxItems
|
|
10444
|
+
* @maxItems 2000
|
|
10331
10445
|
* @minItems 1
|
|
10332
10446
|
* @example ["DEVU-12345"]
|
|
10333
10447
|
*/
|
|
@@ -11329,6 +11443,16 @@ export interface Money {
|
|
|
11329
11443
|
*/
|
|
11330
11444
|
currency?: string;
|
|
11331
11445
|
}
|
|
11446
|
+
/** network-log */
|
|
11447
|
+
export interface NetworkLog {
|
|
11448
|
+
/**
|
|
11449
|
+
* Type of the network log.
|
|
11450
|
+
* @format text
|
|
11451
|
+
*/
|
|
11452
|
+
type: string;
|
|
11453
|
+
request: ObservabilityNetworkRequest;
|
|
11454
|
+
response: ObservabilityNetworkResponse;
|
|
11455
|
+
}
|
|
11332
11456
|
/** notification-content-template */
|
|
11333
11457
|
export type NotificationContentTemplate = ContentTemplateBase;
|
|
11334
11458
|
/** notification-content-template-summary */
|
|
@@ -11345,6 +11469,39 @@ export type ObjectMemberSummary = AtomBaseSummary & {
|
|
|
11345
11469
|
/** Sync information for records synced into/from DevRev. */
|
|
11346
11470
|
sync_metadata?: SyncMetadataSummary;
|
|
11347
11471
|
};
|
|
11472
|
+
/** observability-network-request */
|
|
11473
|
+
export interface ObservabilityNetworkRequest {
|
|
11474
|
+
/**
|
|
11475
|
+
* HTTP method of the request.
|
|
11476
|
+
* @format text
|
|
11477
|
+
*/
|
|
11478
|
+
method: string;
|
|
11479
|
+
/**
|
|
11480
|
+
* Start time of the request.
|
|
11481
|
+
* @format date-time
|
|
11482
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
11483
|
+
*/
|
|
11484
|
+
start_time: string;
|
|
11485
|
+
/**
|
|
11486
|
+
* URL of the network request.
|
|
11487
|
+
* @format text
|
|
11488
|
+
*/
|
|
11489
|
+
url: string;
|
|
11490
|
+
}
|
|
11491
|
+
/** observability-network-response */
|
|
11492
|
+
export interface ObservabilityNetworkResponse {
|
|
11493
|
+
/**
|
|
11494
|
+
* End time of the response.
|
|
11495
|
+
* @format date-time
|
|
11496
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
11497
|
+
*/
|
|
11498
|
+
end_time: string;
|
|
11499
|
+
/**
|
|
11500
|
+
* HTTP status code of the response.
|
|
11501
|
+
* @format int32
|
|
11502
|
+
*/
|
|
11503
|
+
status: number;
|
|
11504
|
+
}
|
|
11348
11505
|
/** observability-session */
|
|
11349
11506
|
export type ObservabilitySession = (UtilRequiredKeys<MobileSession, 'session_id'> | UtilRequiredKeys<WebSession, 'session_id'>) & {
|
|
11350
11507
|
type: ObservabilitySessionType;
|
|
@@ -11360,6 +11517,214 @@ export declare enum ObservabilitySessionType {
|
|
|
11360
11517
|
Mobile = "mobile",
|
|
11361
11518
|
Web = "web"
|
|
11362
11519
|
}
|
|
11520
|
+
/** observability-sessions-aggregate-request */
|
|
11521
|
+
export type ObservabilitySessionsAggregateRequest = (MobileSessionsFilter | WebSessionsFilter) & {
|
|
11522
|
+
type: ObservabilitySessionsAggregateRequestType;
|
|
11523
|
+
/**
|
|
11524
|
+
* List of aggregation configurations. Each aggregation has a key
|
|
11525
|
+
* field for identification.
|
|
11526
|
+
*/
|
|
11527
|
+
aggregations?: ObservabilitySessionsAggregateRequestAggregationConfig[];
|
|
11528
|
+
/** To filter indexes by partition fields. */
|
|
11529
|
+
partition_filters?: Record<string, string>;
|
|
11530
|
+
schema_type: ObservabilitySessionsAggregateRequestSchemaType;
|
|
11531
|
+
/** Provides ways to specify date ranges on objects. */
|
|
11532
|
+
time_range: DateFilter;
|
|
11533
|
+
/**
|
|
11534
|
+
* The unique app ID to which the session belongs.
|
|
11535
|
+
* @format text
|
|
11536
|
+
* @minLength 1
|
|
11537
|
+
*/
|
|
11538
|
+
version_key: string;
|
|
11539
|
+
};
|
|
11540
|
+
/** observability-sessions-aggregate-request-aggregation-config */
|
|
11541
|
+
export type ObservabilitySessionsAggregateRequestAggregationConfig = (ObservabilitySessionsAggregateRequestAvgAggregation | ObservabilitySessionsAggregateRequestCountAggregation | ObservabilitySessionsAggregateRequestDateHistogramAggregation | ObservabilitySessionsAggregateRequestMaxAggregation | ObservabilitySessionsAggregateRequestMinAggregation | ObservabilitySessionsAggregateRequestPercentilesAggregation | ObservabilitySessionsAggregateRequestSumAggregation | ObservabilitySessionsAggregateRequestTermsAggregation) & {
|
|
11542
|
+
type: ObservabilitySessionsAggregateRequestAggregationConfigType;
|
|
11543
|
+
/**
|
|
11544
|
+
* Unique identifier for this aggregation.
|
|
11545
|
+
* @format text
|
|
11546
|
+
*/
|
|
11547
|
+
key: string;
|
|
11548
|
+
/** Nested aggregations to perform within each bucket. */
|
|
11549
|
+
sub_aggregations?: ObservabilitySessionsAggregateRequestAggregationConfig[];
|
|
11550
|
+
};
|
|
11551
|
+
export declare enum ObservabilitySessionsAggregateRequestAggregationConfigType {
|
|
11552
|
+
Avg = "avg",
|
|
11553
|
+
Count = "count",
|
|
11554
|
+
DateHistogram = "date_histogram",
|
|
11555
|
+
Max = "max",
|
|
11556
|
+
Min = "min",
|
|
11557
|
+
Percentiles = "percentiles",
|
|
11558
|
+
Sum = "sum",
|
|
11559
|
+
Terms = "terms"
|
|
11560
|
+
}
|
|
11561
|
+
/** observability-sessions-aggregate-request-avg-aggregation */
|
|
11562
|
+
export interface ObservabilitySessionsAggregateRequestAvgAggregation {
|
|
11563
|
+
/**
|
|
11564
|
+
* Field to compute the average on.
|
|
11565
|
+
* @format text
|
|
11566
|
+
*/
|
|
11567
|
+
field: string;
|
|
11568
|
+
}
|
|
11569
|
+
/** observability-sessions-aggregate-request-count-aggregation */
|
|
11570
|
+
export interface ObservabilitySessionsAggregateRequestCountAggregation {
|
|
11571
|
+
/**
|
|
11572
|
+
* Field to count.
|
|
11573
|
+
* @format text
|
|
11574
|
+
*/
|
|
11575
|
+
field: string;
|
|
11576
|
+
}
|
|
11577
|
+
/** observability-sessions-aggregate-request-date-histogram-aggregation */
|
|
11578
|
+
export interface ObservabilitySessionsAggregateRequestDateHistogramAggregation {
|
|
11579
|
+
/**
|
|
11580
|
+
* Date field to aggregate on.
|
|
11581
|
+
* @format text
|
|
11582
|
+
*/
|
|
11583
|
+
field: string;
|
|
11584
|
+
/**
|
|
11585
|
+
* Time interval in milliseconds for histogram buckets.
|
|
11586
|
+
* @format int64
|
|
11587
|
+
*/
|
|
11588
|
+
interval_ms: number;
|
|
11589
|
+
}
|
|
11590
|
+
/** observability-sessions-aggregate-request-max-aggregation */
|
|
11591
|
+
export interface ObservabilitySessionsAggregateRequestMaxAggregation {
|
|
11592
|
+
/**
|
|
11593
|
+
* Field to compute the maximum on.
|
|
11594
|
+
* @format text
|
|
11595
|
+
*/
|
|
11596
|
+
field: string;
|
|
11597
|
+
}
|
|
11598
|
+
/** observability-sessions-aggregate-request-min-aggregation */
|
|
11599
|
+
export interface ObservabilitySessionsAggregateRequestMinAggregation {
|
|
11600
|
+
/**
|
|
11601
|
+
* Field to compute the minimum on.
|
|
11602
|
+
* @format text
|
|
11603
|
+
*/
|
|
11604
|
+
field: string;
|
|
11605
|
+
}
|
|
11606
|
+
/** observability-sessions-aggregate-request-percentiles-aggregation */
|
|
11607
|
+
export interface ObservabilitySessionsAggregateRequestPercentilesAggregation {
|
|
11608
|
+
/**
|
|
11609
|
+
* Field to compute percentiles on.
|
|
11610
|
+
* @format text
|
|
11611
|
+
*/
|
|
11612
|
+
field: string;
|
|
11613
|
+
/**
|
|
11614
|
+
* Percentile values to compute (e.g., [50.0, 90.0, 95.0, 99.0]).
|
|
11615
|
+
* @min 0
|
|
11616
|
+
* @max 100
|
|
11617
|
+
*/
|
|
11618
|
+
percents?: number[];
|
|
11619
|
+
}
|
|
11620
|
+
export declare enum ObservabilitySessionsAggregateRequestSchemaType {
|
|
11621
|
+
MobileCustomEvents = "mobile_custom_events",
|
|
11622
|
+
MobileNetwork = "mobile_network",
|
|
11623
|
+
WebConsole = "web_console",
|
|
11624
|
+
WebCustomEvents = "web_custom_events",
|
|
11625
|
+
WebEvent = "web_event",
|
|
11626
|
+
WebNetwork = "web_network"
|
|
11627
|
+
}
|
|
11628
|
+
/** observability-sessions-aggregate-request-sum-aggregation */
|
|
11629
|
+
export interface ObservabilitySessionsAggregateRequestSumAggregation {
|
|
11630
|
+
/**
|
|
11631
|
+
* Field to compute the sum on.
|
|
11632
|
+
* @format text
|
|
11633
|
+
*/
|
|
11634
|
+
field: string;
|
|
11635
|
+
}
|
|
11636
|
+
/** observability-sessions-aggregate-request-terms-aggregation */
|
|
11637
|
+
export interface ObservabilitySessionsAggregateRequestTermsAggregation {
|
|
11638
|
+
/**
|
|
11639
|
+
* Field to group by.
|
|
11640
|
+
* @format text
|
|
11641
|
+
*/
|
|
11642
|
+
field: string;
|
|
11643
|
+
/**
|
|
11644
|
+
* Maximum number of buckets to return.
|
|
11645
|
+
* @min 1
|
|
11646
|
+
* @max 5000
|
|
11647
|
+
*/
|
|
11648
|
+
size?: number;
|
|
11649
|
+
}
|
|
11650
|
+
export declare enum ObservabilitySessionsAggregateRequestType {
|
|
11651
|
+
Mobile = "mobile",
|
|
11652
|
+
Web = "web"
|
|
11653
|
+
}
|
|
11654
|
+
/** observability-sessions-aggregate-response */
|
|
11655
|
+
export interface ObservabilitySessionsAggregateResponse {
|
|
11656
|
+
/** List of aggregation results. */
|
|
11657
|
+
aggregations: ObservabilitySessionsAggregateResponseAggregationResult[];
|
|
11658
|
+
}
|
|
11659
|
+
/** observability-sessions-aggregate-response-aggregation-result */
|
|
11660
|
+
export type ObservabilitySessionsAggregateResponseAggregationResult = (ObservabilitySessionsAggregateResponseBucketResults | ObservabilitySessionsAggregateResponseMetricResult) & {
|
|
11661
|
+
/**
|
|
11662
|
+
* The key identifying this aggregation result.
|
|
11663
|
+
* @format text
|
|
11664
|
+
*/
|
|
11665
|
+
key: string;
|
|
11666
|
+
result_type: ObservabilitySessionsAggregateResponseAggregationResultResultType;
|
|
11667
|
+
};
|
|
11668
|
+
export declare enum ObservabilitySessionsAggregateResponseAggregationResultResultType {
|
|
11669
|
+
BucketResults = "bucket_results",
|
|
11670
|
+
MetricResult = "metric_result"
|
|
11671
|
+
}
|
|
11672
|
+
/** observability-sessions-aggregate-response-bucket */
|
|
11673
|
+
export interface ObservabilitySessionsAggregateResponseBucket {
|
|
11674
|
+
/**
|
|
11675
|
+
* Number of documents in this bucket.
|
|
11676
|
+
* @min 0
|
|
11677
|
+
* @max 18446744073709552000
|
|
11678
|
+
*/
|
|
11679
|
+
doc_count: number;
|
|
11680
|
+
/**
|
|
11681
|
+
* The bucket key (canonical value - can be string, number, bool,
|
|
11682
|
+
* etc.).
|
|
11683
|
+
*/
|
|
11684
|
+
key: any;
|
|
11685
|
+
/** Results of aggregations within this bucket. */
|
|
11686
|
+
sub_aggregations: ObservabilitySessionsAggregateResponseAggregationResult[];
|
|
11687
|
+
}
|
|
11688
|
+
/** observability-sessions-aggregate-response-bucket-item */
|
|
11689
|
+
export type ObservabilitySessionsAggregateResponseBucketItem = ObservabilitySessionsAggregateResponseBucket & {
|
|
11690
|
+
bucket_type: ObservabilitySessionsAggregateResponseBucketItemBucketType;
|
|
11691
|
+
};
|
|
11692
|
+
export declare enum ObservabilitySessionsAggregateResponseBucketItemBucketType {
|
|
11693
|
+
Bucket = "bucket"
|
|
11694
|
+
}
|
|
11695
|
+
/** observability-sessions-aggregate-response-bucket-results */
|
|
11696
|
+
export interface ObservabilitySessionsAggregateResponseBucketResults {
|
|
11697
|
+
/** List of buckets from the aggregation. */
|
|
11698
|
+
buckets: ObservabilitySessionsAggregateResponseBucketItem[];
|
|
11699
|
+
}
|
|
11700
|
+
/** observability-sessions-aggregate-response-metric-result */
|
|
11701
|
+
export type ObservabilitySessionsAggregateResponseMetricResult = (ObservabilitySessionsAggregateResponsePercentilesResult | ObservabilitySessionsAggregateResponseValueResult) & {
|
|
11702
|
+
metric_type: ObservabilitySessionsAggregateResponseMetricResultMetricType;
|
|
11703
|
+
};
|
|
11704
|
+
export declare enum ObservabilitySessionsAggregateResponseMetricResultMetricType {
|
|
11705
|
+
Avg = "avg",
|
|
11706
|
+
Count = "count",
|
|
11707
|
+
Max = "max",
|
|
11708
|
+
Min = "min",
|
|
11709
|
+
Percentiles = "percentiles",
|
|
11710
|
+
Sum = "sum"
|
|
11711
|
+
}
|
|
11712
|
+
/** observability-sessions-aggregate-response-percentiles-result */
|
|
11713
|
+
export interface ObservabilitySessionsAggregateResponsePercentilesResult {
|
|
11714
|
+
/**
|
|
11715
|
+
* Map of percentile to value (e.g., {'50.0': 123.45, '90.0':
|
|
11716
|
+
* 456.78}).
|
|
11717
|
+
*/
|
|
11718
|
+
values: Record<string, number>;
|
|
11719
|
+
}
|
|
11720
|
+
/** observability-sessions-aggregate-response-value-result */
|
|
11721
|
+
export interface ObservabilitySessionsAggregateResponseValueResult {
|
|
11722
|
+
/**
|
|
11723
|
+
* The computed metric value.
|
|
11724
|
+
* @format double
|
|
11725
|
+
*/
|
|
11726
|
+
value?: number;
|
|
11727
|
+
}
|
|
11363
11728
|
/** observability-sessions-data-get-request */
|
|
11364
11729
|
export interface ObservabilitySessionsDataGetRequest {
|
|
11365
11730
|
/** Whether to include replay data in the response. Defaults to true. */
|
|
@@ -11395,6 +11760,41 @@ export declare enum ObservabilitySessionsDataGetResponseRecording {
|
|
|
11395
11760
|
MobileRecording = "mobile_recording",
|
|
11396
11761
|
WebRecording = "web_recording"
|
|
11397
11762
|
}
|
|
11763
|
+
/** observability-sessions-developer-info-get-request */
|
|
11764
|
+
export interface ObservabilitySessionsDeveloperInfoGetRequest {
|
|
11765
|
+
/** Filter console logs by type. If empty, all types are returned. */
|
|
11766
|
+
console_log_types?: ConsoleLogType[];
|
|
11767
|
+
/**
|
|
11768
|
+
* The unique identifier of the session.
|
|
11769
|
+
* @format text
|
|
11770
|
+
* @minLength 1
|
|
11771
|
+
*/
|
|
11772
|
+
session_id: string;
|
|
11773
|
+
/**
|
|
11774
|
+
* Filter network logs by HTTP status code class. If empty, all
|
|
11775
|
+
* classes are returned.
|
|
11776
|
+
*/
|
|
11777
|
+
status_code_classes?: StatusCodeClass[];
|
|
11778
|
+
/**
|
|
11779
|
+
* unique tab id of the web session.
|
|
11780
|
+
* @format text
|
|
11781
|
+
* @minLength 1
|
|
11782
|
+
*/
|
|
11783
|
+
tab_id: string;
|
|
11784
|
+
/**
|
|
11785
|
+
* version key of the app.
|
|
11786
|
+
* @format text
|
|
11787
|
+
* @minLength 1
|
|
11788
|
+
*/
|
|
11789
|
+
version_key: string;
|
|
11790
|
+
}
|
|
11791
|
+
/** observability-sessions-developer-info-get-response */
|
|
11792
|
+
export interface ObservabilitySessionsDeveloperInfoGetResponse {
|
|
11793
|
+
/** Console data containing error logs and console information. */
|
|
11794
|
+
console_data?: ConsoleLogData[];
|
|
11795
|
+
/** Network data containing request/response information. */
|
|
11796
|
+
network_data?: NetworkLog[];
|
|
11797
|
+
}
|
|
11398
11798
|
/** observability-sessions-get-request */
|
|
11399
11799
|
export interface ObservabilitySessionsGetRequest {
|
|
11400
11800
|
/** The platform type for the device. */
|
|
@@ -13973,6 +14373,11 @@ export interface SchemaFieldDescriptorBase {
|
|
|
13973
14373
|
* @format text
|
|
13974
14374
|
*/
|
|
13975
14375
|
description?: string;
|
|
14376
|
+
/**
|
|
14377
|
+
* Whether this field is derived (computed by the system and not
|
|
14378
|
+
* settable by users).
|
|
14379
|
+
*/
|
|
14380
|
+
is_derived?: boolean;
|
|
13976
14381
|
/** Whether this field is filterable, groupable and sortable. */
|
|
13977
14382
|
is_filterable?: boolean;
|
|
13978
14383
|
/** Whether this field is immutable or not. */
|
|
@@ -14094,6 +14499,8 @@ export interface SchemaFieldUenumValue {
|
|
|
14094
14499
|
* The schema of ui specific fields.
|
|
14095
14500
|
*/
|
|
14096
14501
|
export interface SchemaFieldUiMetadata {
|
|
14502
|
+
/** Card view UI hint overrides. */
|
|
14503
|
+
card_view?: CardViewUiMetadata;
|
|
14097
14504
|
/** The client overrides for the field. */
|
|
14098
14505
|
client_overrides?: ClientOverride[];
|
|
14099
14506
|
/** Create view UI hint overrides. */
|
|
@@ -15498,6 +15905,23 @@ export type SnapInSummary = AtomBaseSummary;
|
|
|
15498
15905
|
export type SnapInVersion = AtomBase;
|
|
15499
15906
|
/** snap-in-version-summary */
|
|
15500
15907
|
export type SnapInVersionSummary = AtomBaseSummary;
|
|
15908
|
+
/**
|
|
15909
|
+
* snap-kit-action-execute-deferred-function-result
|
|
15910
|
+
* Result returned by the snap-in when handling a deferred snap-kit
|
|
15911
|
+
* action.
|
|
15912
|
+
*/
|
|
15913
|
+
export interface SnapKitActionExecuteDeferredFunctionResult {
|
|
15914
|
+
/**
|
|
15915
|
+
* Detail message from the snap-in function execution.
|
|
15916
|
+
* @format text
|
|
15917
|
+
*/
|
|
15918
|
+
detail?: string;
|
|
15919
|
+
/**
|
|
15920
|
+
* Status of the snap-in function execution (e.g. 'error', 'success').
|
|
15921
|
+
* @format text
|
|
15922
|
+
*/
|
|
15923
|
+
status?: string;
|
|
15924
|
+
}
|
|
15501
15925
|
/** snap-kit-action-execute-deferred-request */
|
|
15502
15926
|
export interface SnapKitActionExecuteDeferredRequest {
|
|
15503
15927
|
/**
|
|
@@ -15512,7 +15936,13 @@ export interface SnapKitActionExecuteDeferredRequest {
|
|
|
15512
15936
|
id: string;
|
|
15513
15937
|
}
|
|
15514
15938
|
/** snap-kit-action-execute-deferred-response */
|
|
15515
|
-
export
|
|
15939
|
+
export interface SnapKitActionExecuteDeferredResponse {
|
|
15940
|
+
/**
|
|
15941
|
+
* Result returned by the snap-in when handling a deferred snap-kit
|
|
15942
|
+
* action.
|
|
15943
|
+
*/
|
|
15944
|
+
function_result?: SnapKitActionExecuteDeferredFunctionResult;
|
|
15945
|
+
}
|
|
15516
15946
|
/** snap-kit-action-request */
|
|
15517
15947
|
export type SnapKitActionRequest = (SnapKitActionRequestButton | SnapKitActionRequestForm) & {
|
|
15518
15948
|
type: SnapKitActionRequestElementTypeValue;
|
|
@@ -15571,6 +16001,11 @@ export declare enum SnapKitBaseWidgetSnapKitExecution {
|
|
|
15571
16001
|
/** snap-widget */
|
|
15572
16002
|
export type SnapWidget = (EmailPreviewWidget | StarterMessageNudgeWidget) & {
|
|
15573
16003
|
type: SnapWidgetType;
|
|
16004
|
+
/**
|
|
16005
|
+
* The ID of the parent object associated with this widget.
|
|
16006
|
+
* @format id
|
|
16007
|
+
*/
|
|
16008
|
+
parent_id?: string;
|
|
15574
16009
|
};
|
|
15575
16010
|
/** snap-widget-base */
|
|
15576
16011
|
export type SnapWidgetBase = AtomBase & {
|
|
@@ -15973,6 +16408,14 @@ export interface StarterMessageNudgeWidget {
|
|
|
15973
16408
|
starter_message_nudge_type: StarterMessageNudgeWidgetStarterMessageNudgeType;
|
|
15974
16409
|
}
|
|
15975
16410
|
export type StarterMessageNudgeWidgetStarterMessageNudgeType = string;
|
|
16411
|
+
/** HTTP response status code class. */
|
|
16412
|
+
export declare enum StatusCodeClass {
|
|
16413
|
+
Value1Xx = "1xx",
|
|
16414
|
+
Value2Xx = "2xx",
|
|
16415
|
+
Value3Xx = "3xx",
|
|
16416
|
+
Value4Xx = "4xx",
|
|
16417
|
+
Value5Xx = "5xx"
|
|
16418
|
+
}
|
|
15976
16419
|
/**
|
|
15977
16420
|
* stock-field-override
|
|
15978
16421
|
* A stock field override.
|
|
@@ -16226,6 +16669,17 @@ export type SurveyResponse = AtomBase & {
|
|
|
16226
16669
|
};
|
|
16227
16670
|
/** surveys-create-request */
|
|
16228
16671
|
export interface SurveysCreateRequest {
|
|
16672
|
+
/** Application-defined custom fields. */
|
|
16673
|
+
custom_fields?: object;
|
|
16674
|
+
/**
|
|
16675
|
+
* Custom schemas described using identifiers. Each custom field in the
|
|
16676
|
+
* request must have the corresponding schema specified; omission results
|
|
16677
|
+
* in a Bad Request error. If a custom schema is not included in the
|
|
16678
|
+
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
16679
|
+
* it is recommended to provide tenant_fragment: true and
|
|
16680
|
+
* validate_required_fields: true.
|
|
16681
|
+
*/
|
|
16682
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
16229
16683
|
/**
|
|
16230
16684
|
* Description about the survey.
|
|
16231
16685
|
* @format text
|
|
@@ -16523,6 +16977,17 @@ export interface SurveysSubmitRequest {
|
|
|
16523
16977
|
export type SurveysSubmitResponse = object;
|
|
16524
16978
|
/** surveys-update-request */
|
|
16525
16979
|
export interface SurveysUpdateRequest {
|
|
16980
|
+
/** Application-defined custom fields. */
|
|
16981
|
+
custom_fields?: object;
|
|
16982
|
+
/**
|
|
16983
|
+
* Custom schemas described using identifiers. Each custom field in the
|
|
16984
|
+
* request must have the corresponding schema specified; omission results
|
|
16985
|
+
* in a Bad Request error. If a custom schema is not included in the
|
|
16986
|
+
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
16987
|
+
* it is recommended to provide tenant_fragment: true and
|
|
16988
|
+
* validate_required_fields: true.
|
|
16989
|
+
*/
|
|
16990
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
16526
16991
|
/**
|
|
16527
16992
|
* The updated description about the survey.
|
|
16528
16993
|
* @format text
|
|
@@ -17649,6 +18114,7 @@ export interface TimelineEntriesGetResponse {
|
|
|
17649
18114
|
* The request to list timeline entries for an object.
|
|
17650
18115
|
*/
|
|
17651
18116
|
export interface TimelineEntriesListRequest {
|
|
18117
|
+
bias?: TimelineEntriesListRequestBias;
|
|
17652
18118
|
/**
|
|
17653
18119
|
* The collection(s) to list entries from, otherwise if not provided,
|
|
17654
18120
|
* all entries are returned.
|
|
@@ -17699,6 +18165,10 @@ export interface TimelineEntriesListRequest {
|
|
|
17699
18165
|
*/
|
|
17700
18166
|
visibility?: TimelineEntryVisibility[];
|
|
17701
18167
|
}
|
|
18168
|
+
export declare enum TimelineEntriesListRequestBias {
|
|
18169
|
+
Quantity = "quantity",
|
|
18170
|
+
Speed = "speed"
|
|
18171
|
+
}
|
|
17702
18172
|
/**
|
|
17703
18173
|
* timeline-entries-list-response
|
|
17704
18174
|
* The response to listing timeline entries for an object.
|
|
@@ -19903,6 +20373,11 @@ export interface WidgetPvpConfig {
|
|
|
19903
20373
|
* visualized.
|
|
19904
20374
|
*/
|
|
19905
20375
|
export interface WidgetQuery {
|
|
20376
|
+
/**
|
|
20377
|
+
* Extended dimension configurations that pair column references with
|
|
20378
|
+
* query-time operations like rollups and aggregation functions.
|
|
20379
|
+
*/
|
|
20380
|
+
dimension_configs?: WidgetQueryColumnConfig[];
|
|
19906
20381
|
/**
|
|
19907
20382
|
* The dimensions for the query, which are the categories to group or
|
|
19908
20383
|
* segment the measures. Usually these are the X-axis values in a
|
|
@@ -19922,6 +20397,11 @@ export interface WidgetQuery {
|
|
|
19922
20397
|
* @format int32
|
|
19923
20398
|
*/
|
|
19924
20399
|
limit?: number;
|
|
20400
|
+
/**
|
|
20401
|
+
* Extended measure configurations that pair column references with
|
|
20402
|
+
* query-time operations like aggregation functions and rollups.
|
|
20403
|
+
*/
|
|
20404
|
+
measure_configs?: WidgetQueryColumnConfig[];
|
|
19925
20405
|
/**
|
|
19926
20406
|
* The measures for the query, which are the numerical values to be
|
|
19927
20407
|
* analyzed. Usually these are the Y-axis values in a visualization.
|
|
@@ -19933,6 +20413,70 @@ export interface WidgetQuery {
|
|
|
19933
20413
|
*/
|
|
19934
20414
|
order_by?: WidgetQueryOrderBy[];
|
|
19935
20415
|
}
|
|
20416
|
+
/**
|
|
20417
|
+
* widget-query-column-config
|
|
20418
|
+
* Configuration for a column in a query. Combines a column reference with
|
|
20419
|
+
* a query-time operation (rollup or aggregation). The reference_name is a
|
|
20420
|
+
* deterministic hash of column_name + type + value, serving as a unique
|
|
20421
|
+
* identifier for downstream references (visualization axes, order_by,
|
|
20422
|
+
* filters).
|
|
20423
|
+
*/
|
|
20424
|
+
export interface WidgetQueryColumnConfig {
|
|
20425
|
+
/**
|
|
20426
|
+
* The category of the query-time operation. Time_granularity buckets
|
|
20427
|
+
* timestamp values by granularity. Aggregation applies an aggregate
|
|
20428
|
+
* function to the column. When omitted the column is a plain reference.
|
|
20429
|
+
*/
|
|
20430
|
+
type?: WidgetQueryColumnConfigType;
|
|
20431
|
+
/** The aggregation function type. Set when type is aggregation. */
|
|
20432
|
+
aggregation?: WidgetQueryColumnConfigAggregation;
|
|
20433
|
+
/**
|
|
20434
|
+
* The name of the source column from the data source.
|
|
20435
|
+
* @format text
|
|
20436
|
+
*/
|
|
20437
|
+
column_name: string;
|
|
20438
|
+
/**
|
|
20439
|
+
* A deterministic unique identifier derived from column_name, type,
|
|
20440
|
+
* and the active value field. Used to reference this column+operation
|
|
20441
|
+
* in visualization axes, order_by, filters, and other downstream
|
|
20442
|
+
* configurations.
|
|
20443
|
+
* @format text
|
|
20444
|
+
*/
|
|
20445
|
+
reference_name: string;
|
|
20446
|
+
/** The time granularity for bucketing. Set when type is time_granularity. */
|
|
20447
|
+
time_granularity?: WidgetQueryColumnConfigTimeGranularity;
|
|
20448
|
+
}
|
|
20449
|
+
/** The aggregation function type. Set when type is aggregation. */
|
|
20450
|
+
export declare enum WidgetQueryColumnConfigAggregation {
|
|
20451
|
+
Avg = "avg",
|
|
20452
|
+
Count = "count",
|
|
20453
|
+
CountDistinct = "count_distinct",
|
|
20454
|
+
Max = "max",
|
|
20455
|
+
Median = "median",
|
|
20456
|
+
Min = "min",
|
|
20457
|
+
P50 = "p50",
|
|
20458
|
+
P90 = "p90",
|
|
20459
|
+
P95 = "p95",
|
|
20460
|
+
P99 = "p99",
|
|
20461
|
+
Sum = "sum"
|
|
20462
|
+
}
|
|
20463
|
+
/** The time granularity for bucketing. Set when type is time_granularity. */
|
|
20464
|
+
export declare enum WidgetQueryColumnConfigTimeGranularity {
|
|
20465
|
+
Day = "day",
|
|
20466
|
+
Hour = "hour",
|
|
20467
|
+
Month = "month",
|
|
20468
|
+
Week = "week",
|
|
20469
|
+
Year = "year"
|
|
20470
|
+
}
|
|
20471
|
+
/**
|
|
20472
|
+
* The category of the query-time operation. Time_granularity buckets
|
|
20473
|
+
* timestamp values by granularity. Aggregation applies an aggregate
|
|
20474
|
+
* function to the column. When omitted the column is a plain reference.
|
|
20475
|
+
*/
|
|
20476
|
+
export declare enum WidgetQueryColumnConfigType {
|
|
20477
|
+
Aggregation = "aggregation",
|
|
20478
|
+
TimeGranularity = "time_granularity"
|
|
20479
|
+
}
|
|
19936
20480
|
/**
|
|
19937
20481
|
* widget-query-joins
|
|
19938
20482
|
* A list of possible joins for the data source. Follows foreign key
|
|
@@ -20932,6 +21476,13 @@ export interface WorksUpdateRequestArtifacts {
|
|
|
20932
21476
|
/** works-update-request-issue */
|
|
20933
21477
|
export interface WorksUpdateRequestIssue {
|
|
20934
21478
|
developed_with?: WorksUpdateRequestIssueDevelopedWith;
|
|
21479
|
+
/**
|
|
21480
|
+
* Updates the timestamp of the last code activity (e.g. latest commit
|
|
21481
|
+
* on all PRs with this issue).
|
|
21482
|
+
* @format date-time
|
|
21483
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
21484
|
+
*/
|
|
21485
|
+
last_code_activity?: string | null;
|
|
20935
21486
|
/** Priority of the work based upon impact and criticality. */
|
|
20936
21487
|
priority?: IssuePriority;
|
|
20937
21488
|
/**
|
|
@@ -21879,7 +22430,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21879
22430
|
*/
|
|
21880
22431
|
artifactsVersionsPrepare: (data: ArtifactsVersionsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsVersionsPrepareResponse, any, {}>>;
|
|
21881
22432
|
/**
|
|
21882
|
-
* @description Gets the specified object.
|
|
22433
|
+
* @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`.
|
|
21883
22434
|
*
|
|
21884
22435
|
* @tags atoms
|
|
21885
22436
|
* @name AtomsGet
|
|
@@ -21895,7 +22446,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21895
22446
|
id: string;
|
|
21896
22447
|
}, params?: RequestParams) => Promise<AxiosResponse<AtomsGetResponse, any, {}>>;
|
|
21897
22448
|
/**
|
|
21898
|
-
* @description Gets the specified object.
|
|
22449
|
+
* @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`.
|
|
21899
22450
|
*
|
|
21900
22451
|
* @tags atoms
|
|
21901
22452
|
* @name AtomsGetPost
|
|
@@ -22602,7 +23153,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22602
23153
|
*/
|
|
22603
23154
|
customObjectsUpdate: (data: CustomObjectsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsUpdateResponse, any, {}>>;
|
|
22604
23155
|
/**
|
|
22605
|
-
* @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.
|
|
23156
|
+
* @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`
|
|
22606
23157
|
*
|
|
22607
23158
|
* @tags auth-connections, dev-orgs
|
|
22608
23159
|
* @name DevOrgAuthConnectionsCreate
|
|
@@ -22612,7 +23163,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22612
23163
|
*/
|
|
22613
23164
|
devOrgAuthConnectionsCreate: (data: DevOrgAuthConnectionsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsCreateResponse, any, {}>>;
|
|
22614
23165
|
/**
|
|
22615
|
-
* @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.
|
|
23166
|
+
* @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`
|
|
22616
23167
|
*
|
|
22617
23168
|
* @tags auth-connections, dev-orgs
|
|
22618
23169
|
* @name DevOrgAuthConnectionsDelete
|
|
@@ -22622,7 +23173,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22622
23173
|
*/
|
|
22623
23174
|
devOrgAuthConnectionsDelete: (data: DevOrgAuthConnectionsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
22624
23175
|
/**
|
|
22625
|
-
* @description Retrieves the details for an authentication connection.
|
|
23176
|
+
* @description Retrieves the details for an authentication connection. **Required scopes:** - `dev_org:read`
|
|
22626
23177
|
*
|
|
22627
23178
|
* @tags auth-connections, dev-orgs
|
|
22628
23179
|
* @name DevOrgAuthConnectionsGet
|
|
@@ -22638,7 +23189,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22638
23189
|
id: string;
|
|
22639
23190
|
}, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any, {}>>;
|
|
22640
23191
|
/**
|
|
22641
|
-
* @description Retrieves the details for an authentication connection.
|
|
23192
|
+
* @description Retrieves the details for an authentication connection. **Required scopes:** - `dev_org:read`
|
|
22642
23193
|
*
|
|
22643
23194
|
* @tags auth-connections, dev-orgs
|
|
22644
23195
|
* @name DevOrgAuthConnectionsGetPost
|
|
@@ -22648,7 +23199,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22648
23199
|
*/
|
|
22649
23200
|
devOrgAuthConnectionsGetPost: (data: DevOrgAuthConnectionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any, {}>>;
|
|
22650
23201
|
/**
|
|
22651
|
-
* @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.
|
|
23202
|
+
* @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`
|
|
22652
23203
|
*
|
|
22653
23204
|
* @tags auth-connections, dev-orgs
|
|
22654
23205
|
* @name DevOrgAuthConnectionsList
|
|
@@ -22658,7 +23209,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22658
23209
|
*/
|
|
22659
23210
|
devOrgAuthConnectionsList: (params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any, {}>>;
|
|
22660
23211
|
/**
|
|
22661
|
-
* @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.
|
|
23212
|
+
* @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`
|
|
22662
23213
|
*
|
|
22663
23214
|
* @tags auth-connections, dev-orgs
|
|
22664
23215
|
* @name DevOrgAuthConnectionsListPost
|
|
@@ -22668,7 +23219,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22668
23219
|
*/
|
|
22669
23220
|
devOrgAuthConnectionsListPost: (data: Empty, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any, {}>>;
|
|
22670
23221
|
/**
|
|
22671
|
-
* @description Enable or disable an authentication connection for a Dev organization. Atleast one authentication connection must be enabled for a Dev organization.
|
|
23222
|
+
* @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`
|
|
22672
23223
|
*
|
|
22673
23224
|
* @tags auth-connections, dev-orgs
|
|
22674
23225
|
* @name DevOrgAuthConnectionsToggle
|
|
@@ -22678,7 +23229,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22678
23229
|
*/
|
|
22679
23230
|
devOrgAuthConnectionsToggle: (data: DevOrgAuthConnectionsToggleRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
22680
23231
|
/**
|
|
22681
|
-
* @description Updates an authentication connection.
|
|
23232
|
+
* @description Updates an authentication connection. **Required scopes:** - `dev_org:write`
|
|
22682
23233
|
*
|
|
22683
23234
|
* @tags auth-connections, dev-orgs
|
|
22684
23235
|
* @name DevOrgAuthConnectionsUpdate
|
|
@@ -22688,7 +23239,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22688
23239
|
*/
|
|
22689
23240
|
devOrgAuthConnectionsUpdate: (data: DevOrgAuthConnectionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsUpdateResponse, any, {}>>;
|
|
22690
23241
|
/**
|
|
22691
|
-
* @description Gets the Dev organization's information of the authenticated user.
|
|
23242
|
+
* @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
|
|
22692
23243
|
*
|
|
22693
23244
|
* @tags dev-orgs
|
|
22694
23245
|
* @name DevOrgsGet
|
|
@@ -22698,7 +23249,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22698
23249
|
*/
|
|
22699
23250
|
devOrgsGet: (params?: RequestParams) => Promise<AxiosResponse<DevOrgsGetResponse, any, {}>>;
|
|
22700
23251
|
/**
|
|
22701
|
-
* @description Gets the Dev organization's information of the authenticated user.
|
|
23252
|
+
* @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
|
|
22702
23253
|
*
|
|
22703
23254
|
* @tags dev-orgs
|
|
22704
23255
|
* @name DevOrgsGetPost
|
|
@@ -22708,7 +23259,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22708
23259
|
*/
|
|
22709
23260
|
devOrgsGetPost: (data: DevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgsGetResponse, any, {}>>;
|
|
22710
23261
|
/**
|
|
22711
|
-
* @description Activates the requested user.
|
|
23262
|
+
* @description Activates the requested user. **Required scopes:** - `dev_user:write`
|
|
22712
23263
|
*
|
|
22713
23264
|
* @tags dev-users
|
|
22714
23265
|
* @name DevUsersActivate
|
|
@@ -22718,7 +23269,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22718
23269
|
*/
|
|
22719
23270
|
devUsersActivate: (data: DevUsersActivateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersActivateResponse, any, {}>>;
|
|
22720
23271
|
/**
|
|
22721
|
-
* @description Creates a Dev user for a Dev organization.
|
|
23272
|
+
* @description Creates a Dev user for a Dev organization. **Required scopes:** - `dev_user:write`
|
|
22722
23273
|
*
|
|
22723
23274
|
* @tags dev-users
|
|
22724
23275
|
* @name DevUsersCreate
|
|
@@ -22728,7 +23279,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22728
23279
|
*/
|
|
22729
23280
|
devUsersCreate: (data: DevUsersCreateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersCreateResponse, any, {}>>;
|
|
22730
23281
|
/**
|
|
22731
|
-
* @description Deactivates the requested user.
|
|
23282
|
+
* @description Deactivates the requested user. **Required scopes:** - `dev_user:all`
|
|
22732
23283
|
*
|
|
22733
23284
|
* @tags dev-users
|
|
22734
23285
|
* @name DevUsersDeactivate
|
|
@@ -22738,7 +23289,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22738
23289
|
*/
|
|
22739
23290
|
devUsersDeactivate: (data: DevUsersDeactivateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
22740
23291
|
/**
|
|
22741
|
-
* @description Gets the requested user's information.
|
|
23292
|
+
* @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
|
|
22742
23293
|
*
|
|
22743
23294
|
* @tags dev-users
|
|
22744
23295
|
* @name DevUsersGet
|
|
@@ -22754,7 +23305,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22754
23305
|
id: string;
|
|
22755
23306
|
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any, {}>>;
|
|
22756
23307
|
/**
|
|
22757
|
-
* @description Gets the requested user's information.
|
|
23308
|
+
* @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
|
|
22758
23309
|
*
|
|
22759
23310
|
* @tags dev-users
|
|
22760
23311
|
* @name DevUsersGetPost
|
|
@@ -22764,7 +23315,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22764
23315
|
*/
|
|
22765
23316
|
devUsersGetPost: (data: DevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any, {}>>;
|
|
22766
23317
|
/**
|
|
22767
|
-
* @description Links an external/secondary identity to the Dev user.
|
|
23318
|
+
* @description Links an external/secondary identity to the Dev user. **Required scopes:** - `dev_user:write`
|
|
22768
23319
|
*
|
|
22769
23320
|
* @tags dev-users
|
|
22770
23321
|
* @name DevUsersIdentitiesLink
|
|
@@ -22774,7 +23325,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22774
23325
|
*/
|
|
22775
23326
|
devUsersIdentitiesLink: (data: DevUsersIdentitiesLinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesLinkResponse, any, {}>>;
|
|
22776
23327
|
/**
|
|
22777
|
-
* @description Unlinks an external/secondary identity from the Dev user.
|
|
23328
|
+
* @description Unlinks an external/secondary identity from the Dev user. **Required scopes:** - `dev_user:write`
|
|
22778
23329
|
*
|
|
22779
23330
|
* @tags dev-users
|
|
22780
23331
|
* @name DevUsersIdentitiesUnlink
|
|
@@ -22784,7 +23335,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22784
23335
|
*/
|
|
22785
23336
|
devUsersIdentitiesUnlink: (data: DevUsersIdentitiesUnlinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesUnlinkResponse, any, {}>>;
|
|
22786
23337
|
/**
|
|
22787
|
-
* @description Lists users within your organization.
|
|
23338
|
+
* @description Lists users within your organization. **Required scopes:** - `dev_user:read`
|
|
22788
23339
|
*
|
|
22789
23340
|
* @tags dev-users
|
|
22790
23341
|
* @name DevUsersList
|
|
@@ -22838,7 +23389,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22838
23389
|
timezone?: string[];
|
|
22839
23390
|
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any, {}>>;
|
|
22840
23391
|
/**
|
|
22841
|
-
* @description Lists users within your organization.
|
|
23392
|
+
* @description Lists users within your organization. **Required scopes:** - `dev_user:read`
|
|
22842
23393
|
*
|
|
22843
23394
|
* @tags dev-users
|
|
22844
23395
|
* @name DevUsersListPost
|
|
@@ -22848,7 +23399,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22848
23399
|
*/
|
|
22849
23400
|
devUsersListPost: (data: DevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any, {}>>;
|
|
22850
23401
|
/**
|
|
22851
|
-
* @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.
|
|
23402
|
+
* @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`
|
|
22852
23403
|
*
|
|
22853
23404
|
* @tags dev-users
|
|
22854
23405
|
* @name DevUsersMerge
|
|
@@ -22858,7 +23409,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22858
23409
|
*/
|
|
22859
23410
|
devUsersMerge: (data: DevUsersMergeRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
22860
23411
|
/**
|
|
22861
|
-
* @description Gets the authenticated user's information.
|
|
23412
|
+
* @description Gets the authenticated user's information. **Required scopes:** No scopes required
|
|
22862
23413
|
*
|
|
22863
23414
|
* @tags dev-users
|
|
22864
23415
|
* @name DevUsersSelf
|
|
@@ -22868,7 +23419,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22868
23419
|
*/
|
|
22869
23420
|
devUsersSelf: (params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any, {}>>;
|
|
22870
23421
|
/**
|
|
22871
|
-
* @description Gets the authenticated user's information.
|
|
23422
|
+
* @description Gets the authenticated user's information. **Required scopes:** No scopes required
|
|
22872
23423
|
*
|
|
22873
23424
|
* @tags dev-users
|
|
22874
23425
|
* @name DevUsersSelfPost
|
|
@@ -22878,7 +23429,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22878
23429
|
*/
|
|
22879
23430
|
devUsersSelfPost: (data: DevUsersSelfRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any, {}>>;
|
|
22880
23431
|
/**
|
|
22881
|
-
* @description Updates the authenticated user.
|
|
23432
|
+
* @description Updates the authenticated user. **Required scopes:** No scopes required
|
|
22882
23433
|
*
|
|
22883
23434
|
* @tags dev-users
|
|
22884
23435
|
* @name DevUsersSelfUpdate
|
|
@@ -22888,7 +23439,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22888
23439
|
*/
|
|
22889
23440
|
devUsersSelfUpdate: (data: DevUsersSelfUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any, {}>>;
|
|
22890
23441
|
/**
|
|
22891
|
-
* @description Updates the user corresponding to the input Id.
|
|
23442
|
+
* @description Updates the user corresponding to the input Id. **Required scopes:** - `dev_user:write`
|
|
22892
23443
|
*
|
|
22893
23444
|
* @tags dev-users
|
|
22894
23445
|
* @name DevUsersUpdate
|
|
@@ -23032,7 +23583,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23032
23583
|
*/
|
|
23033
23584
|
directoriesUpdate: (data: DirectoriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesUpdateResponse, any, {}>>;
|
|
23034
23585
|
/**
|
|
23035
|
-
* @description Creates a new group. A group is a collection of users.
|
|
23586
|
+
* @description Creates a new group. A group is a collection of users. **Required scopes:** - `group:write`
|
|
23036
23587
|
*
|
|
23037
23588
|
* @tags groups
|
|
23038
23589
|
* @name GroupsCreate
|
|
@@ -23042,7 +23593,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23042
23593
|
*/
|
|
23043
23594
|
groupsCreate: (data: GroupsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsCreateResponse, any, {}>>;
|
|
23044
23595
|
/**
|
|
23045
|
-
* @description Gets the requested group.
|
|
23596
|
+
* @description Gets the requested group. **Required scopes:** - `group:read`
|
|
23046
23597
|
*
|
|
23047
23598
|
* @tags groups
|
|
23048
23599
|
* @name GroupsGet
|
|
@@ -23058,7 +23609,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23058
23609
|
id: string;
|
|
23059
23610
|
}, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any, {}>>;
|
|
23060
23611
|
/**
|
|
23061
|
-
* @description Gets the requested group.
|
|
23612
|
+
* @description Gets the requested group. **Required scopes:** - `group:read`
|
|
23062
23613
|
*
|
|
23063
23614
|
* @tags groups
|
|
23064
23615
|
* @name GroupsGetPost
|
|
@@ -23068,7 +23619,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23068
23619
|
*/
|
|
23069
23620
|
groupsGetPost: (data: GroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any, {}>>;
|
|
23070
23621
|
/**
|
|
23071
|
-
* @description Lists the available groups.
|
|
23622
|
+
* @description Lists the available groups. **Required scopes:** - `group:read`
|
|
23072
23623
|
*
|
|
23073
23624
|
* @tags groups
|
|
23074
23625
|
* @name GroupsList
|
|
@@ -23139,7 +23690,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23139
23690
|
'sync_metadata.origin_system'?: string[];
|
|
23140
23691
|
}, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any, {}>>;
|
|
23141
23692
|
/**
|
|
23142
|
-
* @description Lists the available groups.
|
|
23693
|
+
* @description Lists the available groups. **Required scopes:** - `group:read`
|
|
23143
23694
|
*
|
|
23144
23695
|
* @tags groups
|
|
23145
23696
|
* @name GroupsListPost
|
|
@@ -23149,7 +23700,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23149
23700
|
*/
|
|
23150
23701
|
groupsListPost: (data: GroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any, {}>>;
|
|
23151
23702
|
/**
|
|
23152
|
-
* @description Adds a member to a group.
|
|
23703
|
+
* @description Adds a member to a group. **Required scopes:** - `group_membership:write`
|
|
23153
23704
|
*
|
|
23154
23705
|
* @tags groups
|
|
23155
23706
|
* @name GroupMembersAdd
|
|
@@ -23159,7 +23710,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23159
23710
|
*/
|
|
23160
23711
|
groupMembersAdd: (data: GroupMembersAddRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
23161
23712
|
/**
|
|
23162
|
-
* @description Lists the members in a group.
|
|
23713
|
+
* @description Lists the members in a group. **Required scopes:** - `group_membership:read`
|
|
23163
23714
|
*
|
|
23164
23715
|
* @tags groups
|
|
23165
23716
|
* @name GroupMembersList
|
|
@@ -23194,7 +23745,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23194
23745
|
sort_by?: string[];
|
|
23195
23746
|
}, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any, {}>>;
|
|
23196
23747
|
/**
|
|
23197
|
-
* @description Lists the members in a group.
|
|
23748
|
+
* @description Lists the members in a group. **Required scopes:** - `group_membership:read`
|
|
23198
23749
|
*
|
|
23199
23750
|
* @tags groups
|
|
23200
23751
|
* @name GroupMembersListPost
|
|
@@ -23204,7 +23755,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23204
23755
|
*/
|
|
23205
23756
|
groupMembersListPost: (data: GroupMembersListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any, {}>>;
|
|
23206
23757
|
/**
|
|
23207
|
-
* @description Removes a member from a group.
|
|
23758
|
+
* @description Removes a member from a group. **Required scopes:** - `group_membership:write`
|
|
23208
23759
|
*
|
|
23209
23760
|
* @tags groups
|
|
23210
23761
|
* @name GroupMembersRemove
|
|
@@ -23214,7 +23765,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23214
23765
|
*/
|
|
23215
23766
|
groupMembersRemove: (data: GroupMembersRemoveRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
23216
23767
|
/**
|
|
23217
|
-
* @description Updates the requested group.
|
|
23768
|
+
* @description Updates the requested group. **Required scopes:** - `group:write`
|
|
23218
23769
|
*
|
|
23219
23770
|
* @tags groups
|
|
23220
23771
|
* @name GroupsUpdate
|
|
@@ -23339,7 +23890,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23339
23890
|
*/
|
|
23340
23891
|
linksCreate: (data: LinksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<LinksCreateResponse, any, {}>>;
|
|
23341
23892
|
/**
|
|
23342
|
-
* @description Deletes a link.
|
|
23893
|
+
* @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.
|
|
23343
23894
|
*
|
|
23344
23895
|
* @tags links
|
|
23345
23896
|
* @name LinksDelete
|
|
@@ -23444,7 +23995,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23444
23995
|
*/
|
|
23445
23996
|
linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any, {}>>;
|
|
23446
23997
|
/**
|
|
23447
|
-
* @description Replaces a link.
|
|
23998
|
+
* @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.
|
|
23448
23999
|
*
|
|
23449
24000
|
* @tags links
|
|
23450
24001
|
* @name LinksReplace
|
|
@@ -23847,6 +24398,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23847
24398
|
* @secure
|
|
23848
24399
|
*/
|
|
23849
24400
|
metricTrackersGetPost: (data: MetricTrackersGetRequest, params?: RequestParams) => Promise<AxiosResponse<MetricTrackersGetResponse, any, {}>>;
|
|
24401
|
+
/**
|
|
24402
|
+
* @description Aggregates the sessions data.
|
|
24403
|
+
*
|
|
24404
|
+
* @tags observability
|
|
24405
|
+
* @name ObservabilitySessionsAggregate
|
|
24406
|
+
* @summary Aggregate Observability Sessions
|
|
24407
|
+
* @request POST:/observability.sessions.aggregate
|
|
24408
|
+
* @secure
|
|
24409
|
+
*/
|
|
24410
|
+
observabilitySessionsAggregate: (data: ObservabilitySessionsAggregateRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsAggregateResponse, any, {}>>;
|
|
23850
24411
|
/**
|
|
23851
24412
|
* @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.
|
|
23852
24413
|
*
|
|
@@ -23891,6 +24452,52 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23891
24452
|
* @secure
|
|
23892
24453
|
*/
|
|
23893
24454
|
observabilitySessionsDataGetPost: (data: ObservabilitySessionsDataGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDataGetResponse, any, {}>>;
|
|
24455
|
+
/**
|
|
24456
|
+
* @description Retrieves detailed console and network data for debugging.
|
|
24457
|
+
*
|
|
24458
|
+
* @tags observability
|
|
24459
|
+
* @name ObservabilitySessionsDeveloperInfoGet
|
|
24460
|
+
* @summary Get Observability Sessions Developer Info
|
|
24461
|
+
* @request GET:/observability.sessions.developer-info.get
|
|
24462
|
+
* @secure
|
|
24463
|
+
*/
|
|
24464
|
+
observabilitySessionsDeveloperInfoGet: (query: {
|
|
24465
|
+
/**
|
|
24466
|
+
* The unique identifier of the session.
|
|
24467
|
+
* @format text
|
|
24468
|
+
* @minLength 1
|
|
24469
|
+
*/
|
|
24470
|
+
session_id: string;
|
|
24471
|
+
/**
|
|
24472
|
+
* unique tab id of the web session.
|
|
24473
|
+
* @format text
|
|
24474
|
+
* @minLength 1
|
|
24475
|
+
*/
|
|
24476
|
+
tab_id: string;
|
|
24477
|
+
/**
|
|
24478
|
+
* version key of the app.
|
|
24479
|
+
* @format text
|
|
24480
|
+
* @minLength 1
|
|
24481
|
+
*/
|
|
24482
|
+
version_key: string;
|
|
24483
|
+
/** Filter console logs by type. If empty, all types are returned. */
|
|
24484
|
+
console_log_types?: ConsoleLogType[];
|
|
24485
|
+
/**
|
|
24486
|
+
* Filter network logs by HTTP status code class. If empty, all classes
|
|
24487
|
+
* are returned.
|
|
24488
|
+
*/
|
|
24489
|
+
status_code_classes?: StatusCodeClass[];
|
|
24490
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDeveloperInfoGetResponse, any, {}>>;
|
|
24491
|
+
/**
|
|
24492
|
+
* @description Retrieves detailed console and network data for debugging.
|
|
24493
|
+
*
|
|
24494
|
+
* @tags observability
|
|
24495
|
+
* @name ObservabilitySessionsDeveloperInfoGetPost
|
|
24496
|
+
* @summary Get Observability Sessions Developer Info (POST)
|
|
24497
|
+
* @request POST:/observability.sessions.developer-info.get
|
|
24498
|
+
* @secure
|
|
24499
|
+
*/
|
|
24500
|
+
observabilitySessionsDeveloperInfoGetPost: (data: ObservabilitySessionsDeveloperInfoGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDeveloperInfoGetResponse, any, {}>>;
|
|
23894
24501
|
/**
|
|
23895
24502
|
* @description Gets a specific session metadata by ID.
|
|
23896
24503
|
*
|
|
@@ -24414,7 +25021,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24414
25021
|
*/
|
|
24415
25022
|
partsUpdate: (data: PartsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsUpdateResponse, any, {}>>;
|
|
24416
25023
|
/**
|
|
24417
|
-
* @description Pings the DevRev service.
|
|
25024
|
+
* @description Pings the DevRev service. **Required scopes:** No scopes required.
|
|
24418
25025
|
*
|
|
24419
25026
|
* @name Ping
|
|
24420
25027
|
* @summary Ping
|
|
@@ -24429,7 +25036,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24429
25036
|
devrev_partition?: string;
|
|
24430
25037
|
}, params?: RequestParams) => Promise<AxiosResponse<PingResponse, any, {}>>;
|
|
24431
25038
|
/**
|
|
24432
|
-
* @description Pings the DevRev service.
|
|
25039
|
+
* @description Pings the DevRev service. **Required scopes:** No scopes required.
|
|
24433
25040
|
*
|
|
24434
25041
|
* @name PingPost
|
|
24435
25042
|
* @summary Ping (POST)
|
|
@@ -24493,7 +25100,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24493
25100
|
*/
|
|
24494
25101
|
reactionsUpdate: (data: ReactionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
24495
25102
|
/**
|
|
24496
|
-
* @description Creates a Rev organization in the authenticated user's Dev organization.
|
|
25103
|
+
* @description Creates a Rev organization in the authenticated user's Dev organization. **Required scopes:** - `rev_org:write`
|
|
24497
25104
|
*
|
|
24498
25105
|
* @tags rev-orgs
|
|
24499
25106
|
* @name RevOrgsCreate
|
|
@@ -24503,7 +25110,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24503
25110
|
*/
|
|
24504
25111
|
revOrgsCreate: (data: RevOrgsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsCreateResponse, any, {}>>;
|
|
24505
25112
|
/**
|
|
24506
|
-
* @description Deletes the Rev organization.
|
|
25113
|
+
* @description Deletes the Rev organization. **Required scopes:** - `rev_org:all`
|
|
24507
25114
|
*
|
|
24508
25115
|
* @tags rev-orgs
|
|
24509
25116
|
* @name RevOrgsDelete
|
|
@@ -24513,7 +25120,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24513
25120
|
*/
|
|
24514
25121
|
revOrgsDelete: (data: RevOrgsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
24515
25122
|
/**
|
|
24516
|
-
* @description Retrieves the Rev organization's information.
|
|
25123
|
+
* @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
|
|
24517
25124
|
*
|
|
24518
25125
|
* @tags rev-orgs
|
|
24519
25126
|
* @name RevOrgsGet
|
|
@@ -24537,7 +25144,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24537
25144
|
id?: string;
|
|
24538
25145
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any, {}>>;
|
|
24539
25146
|
/**
|
|
24540
|
-
* @description Retrieves the Rev organization's information.
|
|
25147
|
+
* @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
|
|
24541
25148
|
*
|
|
24542
25149
|
* @tags rev-orgs
|
|
24543
25150
|
* @name RevOrgsGetPost
|
|
@@ -24547,7 +25154,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24547
25154
|
*/
|
|
24548
25155
|
revOrgsGetPost: (data: RevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any, {}>>;
|
|
24549
25156
|
/**
|
|
24550
|
-
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
25157
|
+
* @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`
|
|
24551
25158
|
*
|
|
24552
25159
|
* @tags rev-orgs
|
|
24553
25160
|
* @name RevOrgsList
|
|
@@ -24625,7 +25232,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24625
25232
|
tags?: string[];
|
|
24626
25233
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any, {}>>;
|
|
24627
25234
|
/**
|
|
24628
|
-
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
25235
|
+
* @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`
|
|
24629
25236
|
*
|
|
24630
25237
|
* @tags rev-orgs
|
|
24631
25238
|
* @name RevOrgsListPost
|
|
@@ -24635,7 +25242,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24635
25242
|
*/
|
|
24636
25243
|
revOrgsListPost: (data: RevOrgsListRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any, {}>>;
|
|
24637
25244
|
/**
|
|
24638
|
-
* @description Updates the Rev organization's information.
|
|
25245
|
+
* @description Updates the Rev organization's information. **Required scopes:** - `rev_org:write`
|
|
24639
25246
|
*
|
|
24640
25247
|
* @tags rev-orgs
|
|
24641
25248
|
* @name RevOrgsUpdate
|
|
@@ -24645,7 +25252,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24645
25252
|
*/
|
|
24646
25253
|
revOrgsUpdate: (data: RevOrgsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsUpdateResponse, any, {}>>;
|
|
24647
25254
|
/**
|
|
24648
|
-
* @description Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization.
|
|
25255
|
+
* @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`
|
|
24649
25256
|
*
|
|
24650
25257
|
* @tags rev-users
|
|
24651
25258
|
* @name RevUsersCreate
|
|
@@ -24655,7 +25262,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24655
25262
|
*/
|
|
24656
25263
|
revUsersCreate: (data: RevUsersCreateRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersCreateResponse, any, {}>>;
|
|
24657
25264
|
/**
|
|
24658
|
-
* @description Deletes a Rev user.
|
|
25265
|
+
* @description Deletes a Rev user. **Required scopes:** - `rev_user:all`
|
|
24659
25266
|
*
|
|
24660
25267
|
* @tags rev-users
|
|
24661
25268
|
* @name RevUsersDelete
|
|
@@ -24665,7 +25272,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24665
25272
|
*/
|
|
24666
25273
|
revUsersDelete: (data: RevUsersDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
24667
25274
|
/**
|
|
24668
|
-
* @description Returns the Rev user of a Rev organization by its ID.
|
|
25275
|
+
* @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
|
|
24669
25276
|
*
|
|
24670
25277
|
* @tags rev-users
|
|
24671
25278
|
* @name RevUsersGet
|
|
@@ -24681,7 +25288,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24681
25288
|
id: string;
|
|
24682
25289
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any, {}>>;
|
|
24683
25290
|
/**
|
|
24684
|
-
* @description Returns the Rev user of a Rev organization by its ID.
|
|
25291
|
+
* @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
|
|
24685
25292
|
*
|
|
24686
25293
|
* @tags rev-users
|
|
24687
25294
|
* @name RevUsersGetPost
|
|
@@ -24691,7 +25298,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24691
25298
|
*/
|
|
24692
25299
|
revUsersGetPost: (data: RevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any, {}>>;
|
|
24693
25300
|
/**
|
|
24694
|
-
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization.
|
|
25301
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
|
|
24695
25302
|
*
|
|
24696
25303
|
* @tags rev-users
|
|
24697
25304
|
* @name RevUsersList
|
|
@@ -24772,7 +25379,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24772
25379
|
tags?: string[];
|
|
24773
25380
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any, {}>>;
|
|
24774
25381
|
/**
|
|
24775
|
-
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization.
|
|
25382
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
|
|
24776
25383
|
*
|
|
24777
25384
|
* @tags rev-users
|
|
24778
25385
|
* @name RevUsersListPost
|
|
@@ -24782,7 +25389,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24782
25389
|
*/
|
|
24783
25390
|
revUsersListPost: (data: RevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any, {}>>;
|
|
24784
25391
|
/**
|
|
24785
|
-
* @description Merges the secondary Rev user into the primary Rev user.
|
|
25392
|
+
* @description Merges the secondary Rev user into the primary Rev user. **Required scopes:** - `rev_user:all`
|
|
24786
25393
|
*
|
|
24787
25394
|
* @tags rev-users
|
|
24788
25395
|
* @name RevUsersMerge
|
|
@@ -24792,7 +25399,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24792
25399
|
*/
|
|
24793
25400
|
revUsersMerge: (data: RevUsersMergeRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
24794
25401
|
/**
|
|
24795
|
-
* @description Scans through all Rev users.
|
|
25402
|
+
* @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
|
|
24796
25403
|
*
|
|
24797
25404
|
* @tags rev-users
|
|
24798
25405
|
* @name RevUsersScan
|
|
@@ -24861,7 +25468,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24861
25468
|
tags?: string[];
|
|
24862
25469
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersScanResponse, any, {}>>;
|
|
24863
25470
|
/**
|
|
24864
|
-
* @description Scans through all Rev users.
|
|
25471
|
+
* @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
|
|
24865
25472
|
*
|
|
24866
25473
|
* @tags rev-users
|
|
24867
25474
|
* @name RevUsersScanPost
|
|
@@ -24871,7 +25478,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24871
25478
|
*/
|
|
24872
25479
|
revUsersScanPost: (data: RevUsersScanRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersScanResponse, any, {}>>;
|
|
24873
25480
|
/**
|
|
24874
|
-
* @description Updates a Rev user.
|
|
25481
|
+
* @description Updates a Rev user. **Required scopes:** - `rev_user:write`
|
|
24875
25482
|
*
|
|
24876
25483
|
* @tags rev-users
|
|
24877
25484
|
* @name RevUsersUpdate
|
|
@@ -25382,7 +25989,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25382
25989
|
* @request POST:/snap-kit-action.execute.deferred
|
|
25383
25990
|
* @secure
|
|
25384
25991
|
*/
|
|
25385
|
-
snapKitActionExecuteDeferred: (data: SnapKitActionExecuteDeferredRequest, params?: RequestParams) => Promise<AxiosResponse<
|
|
25992
|
+
snapKitActionExecuteDeferred: (data: SnapKitActionExecuteDeferredRequest, params?: RequestParams) => Promise<AxiosResponse<SnapKitActionExecuteDeferredResponse, any, {}>>;
|
|
25386
25993
|
/**
|
|
25387
25994
|
* @description Create a snap widget object.
|
|
25388
25995
|
*
|
|
@@ -25858,7 +26465,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25858
26465
|
*/
|
|
25859
26466
|
surveysUpdate: (data: SurveysUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysUpdateResponse, any, {}>>;
|
|
25860
26467
|
/**
|
|
25861
|
-
* @description Lists system users within your organization.
|
|
26468
|
+
* @description Lists system users within your organization. **Required scopes:** - `dev_user:read`
|
|
25862
26469
|
*
|
|
25863
26470
|
* @tags sys-users
|
|
25864
26471
|
* @name SysUsersList
|
|
@@ -25888,7 +26495,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25888
26495
|
sort_by?: string[];
|
|
25889
26496
|
}, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any, {}>>;
|
|
25890
26497
|
/**
|
|
25891
|
-
* @description Lists system users within your organization.
|
|
26498
|
+
* @description Lists system users within your organization. **Required scopes:** - `dev_user:read`
|
|
25892
26499
|
*
|
|
25893
26500
|
* @tags sys-users
|
|
25894
26501
|
* @name SysUsersListPost
|
|
@@ -25898,7 +26505,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25898
26505
|
*/
|
|
25899
26506
|
sysUsersListPost: (data: SysUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any, {}>>;
|
|
25900
26507
|
/**
|
|
25901
|
-
* @description Updates the system user.
|
|
26508
|
+
* @description Updates the system user. **Required scopes:** - `dev_user:write`
|
|
25902
26509
|
*
|
|
25903
26510
|
* @tags sys-users
|
|
25904
26511
|
* @name SysUsersUpdate
|
|
@@ -26076,6 +26683,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26076
26683
|
* @example "PROD-12345"
|
|
26077
26684
|
*/
|
|
26078
26685
|
object: string;
|
|
26686
|
+
/** The bias for request processing. The default is 'speed'. */
|
|
26687
|
+
bias?: TimelineEntriesListRequestBias;
|
|
26079
26688
|
/**
|
|
26080
26689
|
* The collection(s) to list entries from, otherwise if not provided,
|
|
26081
26690
|
* all entries are returned.
|