@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.
|
@@ -819,6 +819,10 @@ export interface AiAgentMessageGenerationStarted {
|
|
|
819
819
|
*/
|
|
820
820
|
request_id: string;
|
|
821
821
|
}
|
|
822
|
+
/** ai-agent-search-summary */
|
|
823
|
+
export type AiAgentSearchSummary = SearchSummaryBase & {
|
|
824
|
+
ai_agent: AiAgentSummary;
|
|
825
|
+
};
|
|
822
826
|
/** ai-agent-session-summary */
|
|
823
827
|
export type AiAgentSessionSummary = AtomBaseSummary;
|
|
824
828
|
/**
|
|
@@ -832,6 +836,8 @@ export interface AiAgentSuggestion {
|
|
|
832
836
|
*/
|
|
833
837
|
suggestion: string;
|
|
834
838
|
}
|
|
839
|
+
/** ai-agent-summary */
|
|
840
|
+
export type AiAgentSummary = AtomBaseSummary;
|
|
835
841
|
/**
|
|
836
842
|
* ai-agent-webhook-target
|
|
837
843
|
* The source of the event to send notifications to, of asynchronous
|
|
@@ -1114,6 +1120,8 @@ export interface AirdropSyncUnitsHistoryResponse {
|
|
|
1114
1120
|
}
|
|
1115
1121
|
/** airdrop-sync-units-list-filter */
|
|
1116
1122
|
export interface AirdropSyncUnitsListFilter {
|
|
1123
|
+
/** Filter for sync units that have an action required. */
|
|
1124
|
+
action_required?: boolean;
|
|
1117
1125
|
/** Filters for sync units with the provided external system names. */
|
|
1118
1126
|
external_system_name?: string[];
|
|
1119
1127
|
/** External system type. */
|
|
@@ -3374,6 +3382,14 @@ export interface BrandsUpdateResponse {
|
|
|
3374
3382
|
export type Capability = PartBase;
|
|
3375
3383
|
/** capability-summary */
|
|
3376
3384
|
export type CapabilitySummary = PartBaseSummary;
|
|
3385
|
+
/**
|
|
3386
|
+
* card-view-ui-metadata
|
|
3387
|
+
* Card view UI hint overrides.
|
|
3388
|
+
*/
|
|
3389
|
+
export interface CardViewUiMetadata {
|
|
3390
|
+
/** True if field is visible in card view. */
|
|
3391
|
+
is_visible?: boolean;
|
|
3392
|
+
}
|
|
3377
3393
|
/** The operator used to compare the key and the value. */
|
|
3378
3394
|
export declare enum CaveatOperator {
|
|
3379
3395
|
Eq = "eq",
|
|
@@ -4500,6 +4516,52 @@ export declare enum ConfigurationProrationBehavior {
|
|
|
4500
4516
|
CreateProrations = "create_prorations",
|
|
4501
4517
|
None = "none"
|
|
4502
4518
|
}
|
|
4519
|
+
/** console-log-data */
|
|
4520
|
+
export interface ConsoleLogData {
|
|
4521
|
+
/** The type of console log. */
|
|
4522
|
+
type: ConsoleLogType;
|
|
4523
|
+
/**
|
|
4524
|
+
* Full URL of the console log.
|
|
4525
|
+
* @format text
|
|
4526
|
+
*/
|
|
4527
|
+
full_url: string;
|
|
4528
|
+
properties: ConsoleLogProperties;
|
|
4529
|
+
/**
|
|
4530
|
+
* Timestamp of the log entry.
|
|
4531
|
+
* @format date-time
|
|
4532
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4533
|
+
*/
|
|
4534
|
+
timestamp: string;
|
|
4535
|
+
/**
|
|
4536
|
+
* Value/content of the console log.
|
|
4537
|
+
* @format text
|
|
4538
|
+
*/
|
|
4539
|
+
value: string;
|
|
4540
|
+
}
|
|
4541
|
+
/** console-log-properties */
|
|
4542
|
+
export interface ConsoleLogProperties {
|
|
4543
|
+
/**
|
|
4544
|
+
* Normalized URL of the page.
|
|
4545
|
+
* @format text
|
|
4546
|
+
*/
|
|
4547
|
+
normalized_url: string;
|
|
4548
|
+
/**
|
|
4549
|
+
* Name of the page where the log occurred.
|
|
4550
|
+
* @format text
|
|
4551
|
+
*/
|
|
4552
|
+
page_name: string;
|
|
4553
|
+
/**
|
|
4554
|
+
* URL of the page where the log occurred.
|
|
4555
|
+
* @format text
|
|
4556
|
+
*/
|
|
4557
|
+
page_url: string;
|
|
4558
|
+
}
|
|
4559
|
+
/** The type of console log. */
|
|
4560
|
+
export declare enum ConsoleLogType {
|
|
4561
|
+
Error = "error",
|
|
4562
|
+
Log = "log",
|
|
4563
|
+
Warn = "warn"
|
|
4564
|
+
}
|
|
4503
4565
|
/** content-template */
|
|
4504
4566
|
export type ContentTemplate = NotificationContentTemplate & {
|
|
4505
4567
|
type: ContentTemplateType;
|
|
@@ -4755,6 +4817,24 @@ export type ConversationSummary = AtomBaseSummary & {
|
|
|
4755
4817
|
*/
|
|
4756
4818
|
title?: string;
|
|
4757
4819
|
};
|
|
4820
|
+
/** conversations-convert-request */
|
|
4821
|
+
export type ConversationsConvertRequest = ConversationsConvertRequestTicket & {
|
|
4822
|
+
convert_to: ConversationsConvertRequestConvertTo;
|
|
4823
|
+
/**
|
|
4824
|
+
* The ID of the conversation to convert.
|
|
4825
|
+
* @format id
|
|
4826
|
+
*/
|
|
4827
|
+
id: string;
|
|
4828
|
+
};
|
|
4829
|
+
export declare enum ConversationsConvertRequestConvertTo {
|
|
4830
|
+
Ticket = "ticket"
|
|
4831
|
+
}
|
|
4832
|
+
/** conversations-convert-request-ticket */
|
|
4833
|
+
export type ConversationsConvertRequestTicket = object;
|
|
4834
|
+
/** conversations-convert-response */
|
|
4835
|
+
export interface ConversationsConvertResponse {
|
|
4836
|
+
job: JobSummary;
|
|
4837
|
+
}
|
|
4758
4838
|
/**
|
|
4759
4839
|
* conversations-create-request
|
|
4760
4840
|
* The request to create a new conversation.
|
|
@@ -5328,6 +5408,183 @@ export interface CreateAssociation {
|
|
|
5328
5408
|
*/
|
|
5329
5409
|
associated_to?: string;
|
|
5330
5410
|
}
|
|
5411
|
+
/** create-bar-visualization-x-axis */
|
|
5412
|
+
export interface CreateBarVisualizationXAxis {
|
|
5413
|
+
/**
|
|
5414
|
+
* The label description for the axis.
|
|
5415
|
+
* @format text
|
|
5416
|
+
*/
|
|
5417
|
+
axis_label?: string;
|
|
5418
|
+
color?: CreateVisualizationAxisColor;
|
|
5419
|
+
/** The drill through configurations for the axis. */
|
|
5420
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5421
|
+
/** Whether the axis should be hidden. */
|
|
5422
|
+
is_hidden?: boolean;
|
|
5423
|
+
/**
|
|
5424
|
+
* The label for the axis.
|
|
5425
|
+
* @format text
|
|
5426
|
+
*/
|
|
5427
|
+
label?: string;
|
|
5428
|
+
/**
|
|
5429
|
+
* The reference name of the axis.
|
|
5430
|
+
* @format text
|
|
5431
|
+
*/
|
|
5432
|
+
reference_name: string;
|
|
5433
|
+
}
|
|
5434
|
+
/** create-bar-visualization-y-axis */
|
|
5435
|
+
export interface CreateBarVisualizationYAxis {
|
|
5436
|
+
/**
|
|
5437
|
+
* The label description for the axis.
|
|
5438
|
+
* @format text
|
|
5439
|
+
*/
|
|
5440
|
+
axis_label?: string;
|
|
5441
|
+
color?: CreateVisualizationAxisColor;
|
|
5442
|
+
/** The drill through configurations for the axis. */
|
|
5443
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5444
|
+
/** Whether the axis should be hidden. */
|
|
5445
|
+
is_hidden?: boolean;
|
|
5446
|
+
/**
|
|
5447
|
+
* The label for the axis.
|
|
5448
|
+
* @format text
|
|
5449
|
+
*/
|
|
5450
|
+
label?: string;
|
|
5451
|
+
/**
|
|
5452
|
+
* The reference name of the axis.
|
|
5453
|
+
* @format text
|
|
5454
|
+
*/
|
|
5455
|
+
reference_name: string;
|
|
5456
|
+
}
|
|
5457
|
+
/** create-bar-widget-visualization */
|
|
5458
|
+
export interface CreateBarWidgetVisualization {
|
|
5459
|
+
data_labels?: CreateDataLabelConfig;
|
|
5460
|
+
/** Whether the bar should be stacked. */
|
|
5461
|
+
is_stacked?: boolean;
|
|
5462
|
+
rollup?: CreateVisualizationRollup;
|
|
5463
|
+
scrollbar?: CreateVisualizationScrollbar;
|
|
5464
|
+
/** Whether to show data labels. */
|
|
5465
|
+
show_data_labels?: boolean;
|
|
5466
|
+
/** The configuration for the X-axis. */
|
|
5467
|
+
x: CreateBarVisualizationXAxis[];
|
|
5468
|
+
/** The configuration for the Y-axes. */
|
|
5469
|
+
y: CreateBarVisualizationYAxis[];
|
|
5470
|
+
}
|
|
5471
|
+
/** create-column-visualization-x-axis */
|
|
5472
|
+
export interface CreateColumnVisualizationXAxis {
|
|
5473
|
+
/**
|
|
5474
|
+
* The label description for the axis.
|
|
5475
|
+
* @format text
|
|
5476
|
+
*/
|
|
5477
|
+
axis_label?: string;
|
|
5478
|
+
color?: CreateVisualizationAxisColor;
|
|
5479
|
+
/** The drill through configurations for the axis. */
|
|
5480
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5481
|
+
/** Whether the axis should be hidden. */
|
|
5482
|
+
is_hidden?: boolean;
|
|
5483
|
+
/**
|
|
5484
|
+
* The label for the axis.
|
|
5485
|
+
* @format text
|
|
5486
|
+
*/
|
|
5487
|
+
label?: string;
|
|
5488
|
+
/**
|
|
5489
|
+
* The reference name of the axis.
|
|
5490
|
+
* @format text
|
|
5491
|
+
*/
|
|
5492
|
+
reference_name: string;
|
|
5493
|
+
}
|
|
5494
|
+
/** create-column-visualization-y-axis */
|
|
5495
|
+
export interface CreateColumnVisualizationYAxis {
|
|
5496
|
+
/**
|
|
5497
|
+
* The label description for the axis.
|
|
5498
|
+
* @format text
|
|
5499
|
+
*/
|
|
5500
|
+
axis_label?: string;
|
|
5501
|
+
color?: CreateVisualizationAxisColor;
|
|
5502
|
+
/** The drill through configurations for the axis. */
|
|
5503
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5504
|
+
/** Whether the axis should be hidden. */
|
|
5505
|
+
is_hidden?: boolean;
|
|
5506
|
+
/**
|
|
5507
|
+
* The label for the axis.
|
|
5508
|
+
* @format text
|
|
5509
|
+
*/
|
|
5510
|
+
label?: string;
|
|
5511
|
+
/**
|
|
5512
|
+
* The reference name of the axis.
|
|
5513
|
+
* @format text
|
|
5514
|
+
*/
|
|
5515
|
+
reference_name: string;
|
|
5516
|
+
}
|
|
5517
|
+
/** create-column-widget-visualization */
|
|
5518
|
+
export interface CreateColumnWidgetVisualization {
|
|
5519
|
+
data_labels?: CreateDataLabelConfig;
|
|
5520
|
+
/** Whether the columns should be stacked. */
|
|
5521
|
+
is_stacked?: boolean;
|
|
5522
|
+
rollup?: CreateVisualizationRollup;
|
|
5523
|
+
scrollbar?: CreateVisualizationScrollbar;
|
|
5524
|
+
/** Whether to show data labels. */
|
|
5525
|
+
show_data_labels?: boolean;
|
|
5526
|
+
/** The configuration for the X-axis. */
|
|
5527
|
+
x: CreateColumnVisualizationXAxis[];
|
|
5528
|
+
/** The configuration for the Y-axes. */
|
|
5529
|
+
y: CreateColumnVisualizationYAxis[];
|
|
5530
|
+
}
|
|
5531
|
+
/** create-combination-visualization-x-axis */
|
|
5532
|
+
export interface CreateCombinationVisualizationXAxis {
|
|
5533
|
+
/**
|
|
5534
|
+
* The label description for the axis.
|
|
5535
|
+
* @format text
|
|
5536
|
+
*/
|
|
5537
|
+
axis_label?: string;
|
|
5538
|
+
color?: CreateVisualizationAxisColor;
|
|
5539
|
+
/** The drill through configurations for the axis. */
|
|
5540
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5541
|
+
/** Whether the axis should be hidden. */
|
|
5542
|
+
is_hidden?: boolean;
|
|
5543
|
+
/**
|
|
5544
|
+
* The label for the axis.
|
|
5545
|
+
* @format text
|
|
5546
|
+
*/
|
|
5547
|
+
label?: string;
|
|
5548
|
+
/**
|
|
5549
|
+
* The reference name of the axis.
|
|
5550
|
+
* @format text
|
|
5551
|
+
*/
|
|
5552
|
+
reference_name: string;
|
|
5553
|
+
}
|
|
5554
|
+
/** create-combination-visualization-y-axis */
|
|
5555
|
+
export interface CreateCombinationVisualizationYAxis {
|
|
5556
|
+
/**
|
|
5557
|
+
* The label description for the axis.
|
|
5558
|
+
* @format text
|
|
5559
|
+
*/
|
|
5560
|
+
axis_label?: string;
|
|
5561
|
+
color?: CreateVisualizationAxisColor;
|
|
5562
|
+
/** The drill through configurations for the axis. */
|
|
5563
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5564
|
+
/** Whether the axis should be hidden. */
|
|
5565
|
+
is_hidden?: boolean;
|
|
5566
|
+
/**
|
|
5567
|
+
* The label for the axis.
|
|
5568
|
+
* @format text
|
|
5569
|
+
*/
|
|
5570
|
+
label?: string;
|
|
5571
|
+
/**
|
|
5572
|
+
* The reference name of the axis.
|
|
5573
|
+
* @format text
|
|
5574
|
+
*/
|
|
5575
|
+
reference_name: string;
|
|
5576
|
+
}
|
|
5577
|
+
/** create-combination-widget-visualization */
|
|
5578
|
+
export interface CreateCombinationWidgetVisualization {
|
|
5579
|
+
drill_through?: CreateVisualizationAxisDrillThrough;
|
|
5580
|
+
rollup?: CreateVisualizationRollup;
|
|
5581
|
+
/** The configuration for series. */
|
|
5582
|
+
series: CreateSeriesVisualization[];
|
|
5583
|
+
/** The configuration for the X-axes. */
|
|
5584
|
+
x_axis: CreateCombinationVisualizationXAxis[];
|
|
5585
|
+
/** The configuration for the Y-axes. */
|
|
5586
|
+
y_axis: CreateCombinationVisualizationYAxis[];
|
|
5587
|
+
}
|
|
5331
5588
|
/** create-command-action */
|
|
5332
5589
|
export interface CreateCommandAction {
|
|
5333
5590
|
action_details?: CreateCommandActionDetails;
|
|
@@ -5374,6 +5631,189 @@ export interface CreateCommandSurface {
|
|
|
5374
5631
|
/** Surfaces from where this command can be invoked. */
|
|
5375
5632
|
surface: CommandSurfaceSurface;
|
|
5376
5633
|
}
|
|
5634
|
+
/** create-custom-field-widget-column-projection */
|
|
5635
|
+
export interface CreateCustomFieldWidgetColumnProjection {
|
|
5636
|
+
/**
|
|
5637
|
+
* The leaf type of the custom field.
|
|
5638
|
+
* @format text
|
|
5639
|
+
*/
|
|
5640
|
+
leaf_type: string;
|
|
5641
|
+
/**
|
|
5642
|
+
* The name of the custom field.
|
|
5643
|
+
* @format text
|
|
5644
|
+
*/
|
|
5645
|
+
name: string;
|
|
5646
|
+
/**
|
|
5647
|
+
* The subtype of the custom field.
|
|
5648
|
+
* @format text
|
|
5649
|
+
*/
|
|
5650
|
+
subtype?: string;
|
|
5651
|
+
}
|
|
5652
|
+
/** create-dashboard-filter */
|
|
5653
|
+
export interface CreateDashboardFilter {
|
|
5654
|
+
expression: CreateDashboardFilterExpression;
|
|
5655
|
+
/**
|
|
5656
|
+
* The reference ID of the tab, section, or widget to which this
|
|
5657
|
+
* filter applies to.
|
|
5658
|
+
* @format text
|
|
5659
|
+
*/
|
|
5660
|
+
reference_id: string;
|
|
5661
|
+
}
|
|
5662
|
+
/** create-dashboard-filter-condition */
|
|
5663
|
+
export interface CreateDashboardFilterCondition {
|
|
5664
|
+
/** The value to be compared. */
|
|
5665
|
+
json_value?: any;
|
|
5666
|
+
/**
|
|
5667
|
+
* The key to be compared.
|
|
5668
|
+
* @format text
|
|
5669
|
+
*/
|
|
5670
|
+
key: string;
|
|
5671
|
+
/** The operator used to compare the key and value. */
|
|
5672
|
+
operator: DashboardFilterConditionOperator;
|
|
5673
|
+
part_value?: CreateDashboardFilterPartCondition;
|
|
5674
|
+
relative_date_value?: CreateDashboardFilterRelativeDateCondition;
|
|
5675
|
+
/** The operator used to compare the key and value. */
|
|
5676
|
+
value_type: DashboardFilterConditionValueType;
|
|
5677
|
+
}
|
|
5678
|
+
/** create-dashboard-filter-expression */
|
|
5679
|
+
export interface CreateDashboardFilterExpression {
|
|
5680
|
+
/**
|
|
5681
|
+
* The operands used for the logical operation. Each operand can be
|
|
5682
|
+
* either a filter expression or a filter condition.
|
|
5683
|
+
*/
|
|
5684
|
+
operands: CreateDashboardFilterOperand[];
|
|
5685
|
+
/** The logical operator that binds the filter conditions or expressions. */
|
|
5686
|
+
operator: DashboardFilterExpressionOperator;
|
|
5687
|
+
}
|
|
5688
|
+
/** create-dashboard-filter-operand */
|
|
5689
|
+
export interface CreateDashboardFilterOperand {
|
|
5690
|
+
/**
|
|
5691
|
+
* The type of the operand. It can be either a filter expression or a
|
|
5692
|
+
* filter condition.
|
|
5693
|
+
*/
|
|
5694
|
+
type: DashboardFilterOperandType;
|
|
5695
|
+
condition?: CreateDashboardFilterCondition;
|
|
5696
|
+
expression?: CreateDashboardFilterExpression;
|
|
5697
|
+
}
|
|
5698
|
+
/** create-dashboard-filter-part-condition */
|
|
5699
|
+
export interface CreateDashboardFilterPartCondition {
|
|
5700
|
+
/** Whether to include child parts. */
|
|
5701
|
+
include_child_parts?: boolean;
|
|
5702
|
+
/** The part ids to be compared. */
|
|
5703
|
+
part?: string[];
|
|
5704
|
+
}
|
|
5705
|
+
/** create-dashboard-filter-quarter-and-year-value */
|
|
5706
|
+
export interface CreateDashboardFilterQuarterAndYearValue {
|
|
5707
|
+
/**
|
|
5708
|
+
* The quarter of the fiscal year.
|
|
5709
|
+
* @format int64
|
|
5710
|
+
*/
|
|
5711
|
+
quarter: number;
|
|
5712
|
+
/**
|
|
5713
|
+
* The year of the fiscal quarter.
|
|
5714
|
+
* @format int64
|
|
5715
|
+
*/
|
|
5716
|
+
year: number;
|
|
5717
|
+
}
|
|
5718
|
+
/** create-dashboard-filter-relative-date-condition */
|
|
5719
|
+
export interface CreateDashboardFilterRelativeDateCondition {
|
|
5720
|
+
/** The type of the relative date condition. */
|
|
5721
|
+
type: DashboardFilterRelativeDateConditionType;
|
|
5722
|
+
/**
|
|
5723
|
+
* Type of current period (today, this week, this month, this quarter,
|
|
5724
|
+
* this year).
|
|
5725
|
+
*/
|
|
5726
|
+
current_period_type?: DashboardFilterRelativeDateConditionCurrentPeriodType;
|
|
5727
|
+
custom_quarter_year_value?: CreateDashboardFilterQuarterAndYearValue;
|
|
5728
|
+
/**
|
|
5729
|
+
* Type of date range from the start of a fiscal period to the current
|
|
5730
|
+
* date.
|
|
5731
|
+
*/
|
|
5732
|
+
period_type?: DashboardFilterRelativeDateConditionPeriodType;
|
|
5733
|
+
/**
|
|
5734
|
+
* The relative time value to be compared.
|
|
5735
|
+
* @format int64
|
|
5736
|
+
*/
|
|
5737
|
+
value?: number;
|
|
5738
|
+
}
|
|
5739
|
+
/** create-data-label-config */
|
|
5740
|
+
export interface CreateDataLabelConfig {
|
|
5741
|
+
/** The display mode for data labels. */
|
|
5742
|
+
display_mode?: DataLabelConfigDisplayMode;
|
|
5743
|
+
/** Whether data labels are enabled. */
|
|
5744
|
+
enable?: boolean;
|
|
5745
|
+
}
|
|
5746
|
+
/** create-data-source-join */
|
|
5747
|
+
export interface CreateDataSourceJoin {
|
|
5748
|
+
/**
|
|
5749
|
+
* A reference name for the join.
|
|
5750
|
+
* @format text
|
|
5751
|
+
*/
|
|
5752
|
+
reference_name: string;
|
|
5753
|
+
/**
|
|
5754
|
+
* The name of the column in the source data source.
|
|
5755
|
+
* @format text
|
|
5756
|
+
*/
|
|
5757
|
+
source_reference_name: string;
|
|
5758
|
+
/**
|
|
5759
|
+
* The name of the column in the target data source.
|
|
5760
|
+
* @format text
|
|
5761
|
+
*/
|
|
5762
|
+
target_reference_name: string;
|
|
5763
|
+
}
|
|
5764
|
+
/** create-donut-visualization-x-axis */
|
|
5765
|
+
export interface CreateDonutVisualizationXAxis {
|
|
5766
|
+
/**
|
|
5767
|
+
* The label description for the axis.
|
|
5768
|
+
* @format text
|
|
5769
|
+
*/
|
|
5770
|
+
axis_label?: string;
|
|
5771
|
+
color?: CreateVisualizationAxisColor;
|
|
5772
|
+
/** The drill through configurations for the axis. */
|
|
5773
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5774
|
+
/** Whether the axis should be hidden. */
|
|
5775
|
+
is_hidden?: boolean;
|
|
5776
|
+
/**
|
|
5777
|
+
* The label for the axis.
|
|
5778
|
+
* @format text
|
|
5779
|
+
*/
|
|
5780
|
+
label?: string;
|
|
5781
|
+
/**
|
|
5782
|
+
* The reference name of the axis.
|
|
5783
|
+
* @format text
|
|
5784
|
+
*/
|
|
5785
|
+
reference_name: string;
|
|
5786
|
+
}
|
|
5787
|
+
/** create-donut-visualization-y-axis */
|
|
5788
|
+
export interface CreateDonutVisualizationYAxis {
|
|
5789
|
+
/**
|
|
5790
|
+
* The label description for the axis.
|
|
5791
|
+
* @format text
|
|
5792
|
+
*/
|
|
5793
|
+
axis_label?: string;
|
|
5794
|
+
color?: CreateVisualizationAxisColor;
|
|
5795
|
+
/** The drill through configurations for the axis. */
|
|
5796
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5797
|
+
/** Whether the axis should be hidden. */
|
|
5798
|
+
is_hidden?: boolean;
|
|
5799
|
+
/**
|
|
5800
|
+
* The label for the axis.
|
|
5801
|
+
* @format text
|
|
5802
|
+
*/
|
|
5803
|
+
label?: string;
|
|
5804
|
+
/**
|
|
5805
|
+
* The reference name of the axis.
|
|
5806
|
+
* @format text
|
|
5807
|
+
*/
|
|
5808
|
+
reference_name: string;
|
|
5809
|
+
}
|
|
5810
|
+
/** create-donut-widget-visualization */
|
|
5811
|
+
export interface CreateDonutWidgetVisualization {
|
|
5812
|
+
rollup?: CreateVisualizationRollup;
|
|
5813
|
+
/** The configuration for the X-axis. */
|
|
5814
|
+
x: CreateDonutVisualizationXAxis[];
|
|
5815
|
+
y: CreateDonutVisualizationYAxis;
|
|
5816
|
+
}
|
|
5377
5817
|
/**
|
|
5378
5818
|
* create-email-info
|
|
5379
5819
|
* Information related to an email.
|
|
@@ -5486,7 +5926,7 @@ export interface CreateExternalSourceDataComp {
|
|
|
5486
5926
|
* ID of the user that created the object in the source system.
|
|
5487
5927
|
* @format id
|
|
5488
5928
|
*/
|
|
5489
|
-
|
|
5929
|
+
created_by_id?: string;
|
|
5490
5930
|
/**
|
|
5491
5931
|
* Timestamp when the object was created in the source system.
|
|
5492
5932
|
* @format date-time
|
|
@@ -5497,7 +5937,7 @@ export interface CreateExternalSourceDataComp {
|
|
|
5497
5937
|
* ID of the user that last modified the object in the source system.
|
|
5498
5938
|
* @format id
|
|
5499
5939
|
*/
|
|
5500
|
-
|
|
5940
|
+
modified_by_id?: string;
|
|
5501
5941
|
/**
|
|
5502
5942
|
* Timestamp when the object was modified in the source system.
|
|
5503
5943
|
* @format date-time
|
|
@@ -5505,6 +5945,212 @@ export interface CreateExternalSourceDataComp {
|
|
|
5505
5945
|
*/
|
|
5506
5946
|
modified_date?: string;
|
|
5507
5947
|
}
|
|
5948
|
+
/** create-flame-graph-visualization-x-axis */
|
|
5949
|
+
export interface CreateFlameGraphVisualizationXAxis {
|
|
5950
|
+
/**
|
|
5951
|
+
* The label description for the axis.
|
|
5952
|
+
* @format text
|
|
5953
|
+
*/
|
|
5954
|
+
axis_label?: string;
|
|
5955
|
+
color?: CreateVisualizationAxisColor;
|
|
5956
|
+
/** The drill through configurations for the axis. */
|
|
5957
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5958
|
+
/** Whether the axis should be hidden. */
|
|
5959
|
+
is_hidden?: boolean;
|
|
5960
|
+
/**
|
|
5961
|
+
* The label for the axis.
|
|
5962
|
+
* @format text
|
|
5963
|
+
*/
|
|
5964
|
+
label?: string;
|
|
5965
|
+
/**
|
|
5966
|
+
* The reference name of the axis.
|
|
5967
|
+
* @format text
|
|
5968
|
+
*/
|
|
5969
|
+
reference_name: string;
|
|
5970
|
+
}
|
|
5971
|
+
/** create-flame-graph-visualization-y-axis */
|
|
5972
|
+
export interface CreateFlameGraphVisualizationYAxis {
|
|
5973
|
+
/**
|
|
5974
|
+
* The label description for the axis.
|
|
5975
|
+
* @format text
|
|
5976
|
+
*/
|
|
5977
|
+
axis_label?: string;
|
|
5978
|
+
color?: CreateVisualizationAxisColor;
|
|
5979
|
+
/** The drill through configurations for the axis. */
|
|
5980
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5981
|
+
/** Whether the axis should be hidden. */
|
|
5982
|
+
is_hidden?: boolean;
|
|
5983
|
+
/**
|
|
5984
|
+
* The label for the axis.
|
|
5985
|
+
* @format text
|
|
5986
|
+
*/
|
|
5987
|
+
label?: string;
|
|
5988
|
+
/**
|
|
5989
|
+
* The reference name of the axis.
|
|
5990
|
+
* @format text
|
|
5991
|
+
*/
|
|
5992
|
+
reference_name: string;
|
|
5993
|
+
}
|
|
5994
|
+
/** create-flame-graph-widget-visualization */
|
|
5995
|
+
export interface CreateFlameGraphWidgetVisualization {
|
|
5996
|
+
/** The configuration for the X-axis. */
|
|
5997
|
+
x: CreateFlameGraphVisualizationXAxis[];
|
|
5998
|
+
/** The configuration for the Y-axes. */
|
|
5999
|
+
y: CreateFlameGraphVisualizationYAxis[];
|
|
6000
|
+
}
|
|
6001
|
+
/** create-gantt-widget-visualization */
|
|
6002
|
+
export interface CreateGanttWidgetVisualization {
|
|
6003
|
+
/**
|
|
6004
|
+
* The actual end date for the gantt visualization.
|
|
6005
|
+
* @format text
|
|
6006
|
+
*/
|
|
6007
|
+
actual_end_date?: string;
|
|
6008
|
+
/**
|
|
6009
|
+
* The actual start date for the gantt visualization.
|
|
6010
|
+
* @format text
|
|
6011
|
+
*/
|
|
6012
|
+
actual_start_date?: string;
|
|
6013
|
+
/**
|
|
6014
|
+
* The maximum number of items that can be returned for each group.
|
|
6015
|
+
* @format int64
|
|
6016
|
+
*/
|
|
6017
|
+
limit_per_group?: number;
|
|
6018
|
+
/**
|
|
6019
|
+
* The planned end date for the gantt visualization.
|
|
6020
|
+
* @format text
|
|
6021
|
+
*/
|
|
6022
|
+
planned_end_date?: string;
|
|
6023
|
+
/**
|
|
6024
|
+
* The planned start date for the gantt visualization.
|
|
6025
|
+
* @format text
|
|
6026
|
+
*/
|
|
6027
|
+
planned_start_date?: string;
|
|
6028
|
+
/** The time scale for the gantt visualization. */
|
|
6029
|
+
time_scale: GanttWidgetVisualizationTimeScale;
|
|
6030
|
+
}
|
|
6031
|
+
/** create-grid-layout */
|
|
6032
|
+
export interface CreateGridLayout {
|
|
6033
|
+
/** Layout of the elements within the current element. */
|
|
6034
|
+
layout?: CreateGridLayout[];
|
|
6035
|
+
position?: CreateGridPosition;
|
|
6036
|
+
/**
|
|
6037
|
+
* The reference ID for the element to be laid out. It should be an ID
|
|
6038
|
+
* of a tab, section, or widget.
|
|
6039
|
+
* @format text
|
|
6040
|
+
*/
|
|
6041
|
+
reference_id: string;
|
|
6042
|
+
}
|
|
6043
|
+
/** create-grid-position */
|
|
6044
|
+
export interface CreateGridPosition {
|
|
6045
|
+
/**
|
|
6046
|
+
* The height of the widget or section, in grid units.
|
|
6047
|
+
* @format int64
|
|
6048
|
+
*/
|
|
6049
|
+
height: number;
|
|
6050
|
+
/**
|
|
6051
|
+
* The width of the widget or section, in grid units.
|
|
6052
|
+
* @format int64
|
|
6053
|
+
*/
|
|
6054
|
+
width: number;
|
|
6055
|
+
/**
|
|
6056
|
+
* The x-coordinate of the top-left corner of the widget or section,
|
|
6057
|
+
* based on a grid system.
|
|
6058
|
+
* @format int64
|
|
6059
|
+
*/
|
|
6060
|
+
x: number;
|
|
6061
|
+
/**
|
|
6062
|
+
* The y-coordinate of the top-left corner of the widget or section,
|
|
6063
|
+
* based on a grid system.
|
|
6064
|
+
* @format int64
|
|
6065
|
+
*/
|
|
6066
|
+
y: number;
|
|
6067
|
+
}
|
|
6068
|
+
/** create-heatmap-visualization-x-axis */
|
|
6069
|
+
export interface CreateHeatmapVisualizationXAxis {
|
|
6070
|
+
/**
|
|
6071
|
+
* The label description for the axis.
|
|
6072
|
+
* @format text
|
|
6073
|
+
*/
|
|
6074
|
+
axis_label?: string;
|
|
6075
|
+
color?: CreateVisualizationAxisColor;
|
|
6076
|
+
/** The drill through configurations for the axis. */
|
|
6077
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6078
|
+
/** Whether the axis should be hidden. */
|
|
6079
|
+
is_hidden?: boolean;
|
|
6080
|
+
/**
|
|
6081
|
+
* The label for the axis.
|
|
6082
|
+
* @format text
|
|
6083
|
+
*/
|
|
6084
|
+
label?: string;
|
|
6085
|
+
/**
|
|
6086
|
+
* The minimum width of the heatmap block.
|
|
6087
|
+
* @format int64
|
|
6088
|
+
*/
|
|
6089
|
+
min_width?: number;
|
|
6090
|
+
/**
|
|
6091
|
+
* The reference name of the axis.
|
|
6092
|
+
* @format text
|
|
6093
|
+
*/
|
|
6094
|
+
reference_name: string;
|
|
6095
|
+
}
|
|
6096
|
+
/** create-heatmap-visualization-y-axis */
|
|
6097
|
+
export interface CreateHeatmapVisualizationYAxis {
|
|
6098
|
+
/**
|
|
6099
|
+
* The label description for the axis.
|
|
6100
|
+
* @format text
|
|
6101
|
+
*/
|
|
6102
|
+
axis_label?: string;
|
|
6103
|
+
color?: CreateVisualizationAxisColor;
|
|
6104
|
+
/** The drill through configurations for the axis. */
|
|
6105
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6106
|
+
/** Whether the axis should be hidden. */
|
|
6107
|
+
is_hidden?: boolean;
|
|
6108
|
+
/**
|
|
6109
|
+
* The label for the axis.
|
|
6110
|
+
* @format text
|
|
6111
|
+
*/
|
|
6112
|
+
label?: string;
|
|
6113
|
+
/**
|
|
6114
|
+
* The reference name of the axis.
|
|
6115
|
+
* @format text
|
|
6116
|
+
*/
|
|
6117
|
+
reference_name: string;
|
|
6118
|
+
}
|
|
6119
|
+
/** create-heatmap-visualization-z-axis */
|
|
6120
|
+
export interface CreateHeatmapVisualizationZAxis {
|
|
6121
|
+
/**
|
|
6122
|
+
* The label description for the axis.
|
|
6123
|
+
* @format text
|
|
6124
|
+
*/
|
|
6125
|
+
axis_label?: string;
|
|
6126
|
+
color?: CreateVisualizationAxisColor;
|
|
6127
|
+
/** The drill through configurations for the axis. */
|
|
6128
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6129
|
+
/** Whether the axis should be hidden. */
|
|
6130
|
+
is_hidden?: boolean;
|
|
6131
|
+
/**
|
|
6132
|
+
* The label for the axis.
|
|
6133
|
+
* @format text
|
|
6134
|
+
*/
|
|
6135
|
+
label?: string;
|
|
6136
|
+
/**
|
|
6137
|
+
* The reference name of the axis.
|
|
6138
|
+
* @format text
|
|
6139
|
+
*/
|
|
6140
|
+
reference_name: string;
|
|
6141
|
+
}
|
|
6142
|
+
/** create-heatmap-widget-visualization */
|
|
6143
|
+
export interface CreateHeatmapWidgetVisualization {
|
|
6144
|
+
/**
|
|
6145
|
+
* Color for heatmap.
|
|
6146
|
+
* @format text
|
|
6147
|
+
*/
|
|
6148
|
+
color?: string;
|
|
6149
|
+
rollup?: CreateVisualizationRollup;
|
|
6150
|
+
x: CreateHeatmapVisualizationXAxis;
|
|
6151
|
+
y: CreateHeatmapVisualizationYAxis;
|
|
6152
|
+
z: CreateHeatmapVisualizationZAxis;
|
|
6153
|
+
}
|
|
5508
6154
|
/** create-impacted-customer-details */
|
|
5509
6155
|
export interface CreateImpactedCustomerDetails {
|
|
5510
6156
|
/**
|
|
@@ -5515,6 +6161,183 @@ export interface CreateImpactedCustomerDetails {
|
|
|
5515
6161
|
/** List of customers impacted due to the incident. */
|
|
5516
6162
|
customer_ids?: string[];
|
|
5517
6163
|
}
|
|
6164
|
+
/** create-kanban-visualization-card-attribute */
|
|
6165
|
+
export interface CreateKanbanVisualizationCardAttribute {
|
|
6166
|
+
/**
|
|
6167
|
+
* The label description for the axis.
|
|
6168
|
+
* @format text
|
|
6169
|
+
*/
|
|
6170
|
+
axis_label?: string;
|
|
6171
|
+
color?: CreateVisualizationAxisColor;
|
|
6172
|
+
/** The drill through configurations for the axis. */
|
|
6173
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6174
|
+
/** Whether the axis should be hidden. */
|
|
6175
|
+
is_hidden?: boolean;
|
|
6176
|
+
/**
|
|
6177
|
+
* The label for the axis.
|
|
6178
|
+
* @format text
|
|
6179
|
+
*/
|
|
6180
|
+
label?: string;
|
|
6181
|
+
/**
|
|
6182
|
+
* The order in which the attribute should be displayed in a card.
|
|
6183
|
+
* @format int64
|
|
6184
|
+
*/
|
|
6185
|
+
order?: number;
|
|
6186
|
+
/**
|
|
6187
|
+
* Whether the attribute should be placed in the body or footer of the
|
|
6188
|
+
* kanban.
|
|
6189
|
+
*/
|
|
6190
|
+
position?: KanbanVisualizationCardAttributePosition;
|
|
6191
|
+
/**
|
|
6192
|
+
* The reference name of the axis.
|
|
6193
|
+
* @format text
|
|
6194
|
+
*/
|
|
6195
|
+
reference_name: string;
|
|
6196
|
+
}
|
|
6197
|
+
/** create-kanban-widget-visualization */
|
|
6198
|
+
export interface CreateKanbanWidgetVisualization {
|
|
6199
|
+
/** The configuration for the card in the kanban. */
|
|
6200
|
+
card_attributes: CreateKanbanVisualizationCardAttribute[];
|
|
6201
|
+
/**
|
|
6202
|
+
* The card load limit for the kanban.
|
|
6203
|
+
* @format int64
|
|
6204
|
+
*/
|
|
6205
|
+
card_load_limit?: number;
|
|
6206
|
+
/**
|
|
6207
|
+
* The group_by configuration in the kanban.
|
|
6208
|
+
* @deprecated
|
|
6209
|
+
*/
|
|
6210
|
+
group_by?: CreateWidgetGroupByConfig[];
|
|
6211
|
+
/** The hidden columns for the kanban. */
|
|
6212
|
+
hidden_columns?: string[];
|
|
6213
|
+
/** The hidden rows for the kanban. */
|
|
6214
|
+
hidden_rows?: string[];
|
|
6215
|
+
/**
|
|
6216
|
+
* The maximum number of items that can be returned for each group.
|
|
6217
|
+
* @format int64
|
|
6218
|
+
*/
|
|
6219
|
+
limit_per_group?: number;
|
|
6220
|
+
}
|
|
6221
|
+
/** create-line-visualization-x-axis */
|
|
6222
|
+
export interface CreateLineVisualizationXAxis {
|
|
6223
|
+
/**
|
|
6224
|
+
* The label description for the axis.
|
|
6225
|
+
* @format text
|
|
6226
|
+
*/
|
|
6227
|
+
axis_label?: string;
|
|
6228
|
+
color?: CreateVisualizationAxisColor;
|
|
6229
|
+
/** The drill through configurations for the axis. */
|
|
6230
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6231
|
+
/** Whether the axis should be hidden. */
|
|
6232
|
+
is_hidden?: boolean;
|
|
6233
|
+
/**
|
|
6234
|
+
* The label for the axis.
|
|
6235
|
+
* @format text
|
|
6236
|
+
*/
|
|
6237
|
+
label?: string;
|
|
6238
|
+
/**
|
|
6239
|
+
* The reference name of the axis.
|
|
6240
|
+
* @format text
|
|
6241
|
+
*/
|
|
6242
|
+
reference_name: string;
|
|
6243
|
+
}
|
|
6244
|
+
/** create-line-visualization-y-axis */
|
|
6245
|
+
export interface CreateLineVisualizationYAxis {
|
|
6246
|
+
/**
|
|
6247
|
+
* The label description for the axis.
|
|
6248
|
+
* @format text
|
|
6249
|
+
*/
|
|
6250
|
+
axis_label?: string;
|
|
6251
|
+
color?: CreateVisualizationAxisColor;
|
|
6252
|
+
/** The drill through configurations for the axis. */
|
|
6253
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6254
|
+
/** Whether the area under the line should be filled. */
|
|
6255
|
+
is_area_filled?: boolean;
|
|
6256
|
+
/** Whether the axis should be hidden. */
|
|
6257
|
+
is_hidden?: boolean;
|
|
6258
|
+
/** Whether the line should be a spline. */
|
|
6259
|
+
is_spline?: boolean;
|
|
6260
|
+
/**
|
|
6261
|
+
* The label for the axis.
|
|
6262
|
+
* @format text
|
|
6263
|
+
*/
|
|
6264
|
+
label?: string;
|
|
6265
|
+
/** Whether the line have circular marker. */
|
|
6266
|
+
marker?: boolean;
|
|
6267
|
+
/**
|
|
6268
|
+
* The reference name of the axis.
|
|
6269
|
+
* @format text
|
|
6270
|
+
*/
|
|
6271
|
+
reference_name: string;
|
|
6272
|
+
/** The stroke style for the line. */
|
|
6273
|
+
stroke_style?: LineVisualizationYAxisStrokeStyle;
|
|
6274
|
+
}
|
|
6275
|
+
/** create-line-widget-visualization */
|
|
6276
|
+
export interface CreateLineWidgetVisualization {
|
|
6277
|
+
data_labels?: CreateDataLabelConfig;
|
|
6278
|
+
/** Whether the line should be stacked. */
|
|
6279
|
+
is_stacked?: boolean;
|
|
6280
|
+
rollup?: CreateVisualizationRollup;
|
|
6281
|
+
/** Whether to show data labels. */
|
|
6282
|
+
show_data_labels?: boolean;
|
|
6283
|
+
/** The configuration for the X-axes. */
|
|
6284
|
+
x: CreateLineVisualizationXAxis[];
|
|
6285
|
+
/** The configuration for the Y-axes. */
|
|
6286
|
+
y: CreateLineVisualizationYAxis[];
|
|
6287
|
+
}
|
|
6288
|
+
/** create-meerkat-widget-column-function */
|
|
6289
|
+
export interface CreateMeerkatWidgetColumnFunction {
|
|
6290
|
+
/** The type of the function. */
|
|
6291
|
+
type: MeerkatWidgetColumnFunctionType;
|
|
6292
|
+
}
|
|
6293
|
+
/** create-meerkat-widget-column-projection */
|
|
6294
|
+
export interface CreateMeerkatWidgetColumnProjection {
|
|
6295
|
+
/** The data type of the column generated by the SQL expression. */
|
|
6296
|
+
type: MeerkatWidgetColumnProjectionType;
|
|
6297
|
+
function?: CreateMeerkatWidgetColumnFunction;
|
|
6298
|
+
/**
|
|
6299
|
+
* The SQL expression used to extract or transform the column from the
|
|
6300
|
+
* data source.
|
|
6301
|
+
* @format text
|
|
6302
|
+
*/
|
|
6303
|
+
sql_expression: string;
|
|
6304
|
+
/**
|
|
6305
|
+
* Deprecated: Use widget_query_column_config with type=timestamp on
|
|
6306
|
+
* widget_query.dimension_configs instead. The rollup granularity for the
|
|
6307
|
+
* timestamp.
|
|
6308
|
+
*/
|
|
6309
|
+
timestamp_rollup?: MeerkatWidgetColumnProjectionTimestampRollup;
|
|
6310
|
+
}
|
|
6311
|
+
/** create-metric-visualization-y-axis */
|
|
6312
|
+
export interface CreateMetricVisualizationYAxis {
|
|
6313
|
+
/**
|
|
6314
|
+
* The label description for the axis.
|
|
6315
|
+
* @format text
|
|
6316
|
+
*/
|
|
6317
|
+
axis_label?: string;
|
|
6318
|
+
color?: CreateVisualizationAxisColor;
|
|
6319
|
+
/** The drill through configurations for the axis. */
|
|
6320
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6321
|
+
/** Whether the axis should be hidden. */
|
|
6322
|
+
is_hidden?: boolean;
|
|
6323
|
+
/**
|
|
6324
|
+
* The label for the axis.
|
|
6325
|
+
* @format text
|
|
6326
|
+
*/
|
|
6327
|
+
label?: string;
|
|
6328
|
+
/**
|
|
6329
|
+
* The reference name of the axis.
|
|
6330
|
+
* @format text
|
|
6331
|
+
*/
|
|
6332
|
+
reference_name: string;
|
|
6333
|
+
}
|
|
6334
|
+
/** create-metric-widget-visualization */
|
|
6335
|
+
export interface CreateMetricWidgetVisualization {
|
|
6336
|
+
pvp?: CreateWidgetPvpConfig;
|
|
6337
|
+
rollup?: CreateVisualizationRollup;
|
|
6338
|
+
/** The configuration for the Y-axis. */
|
|
6339
|
+
y: CreateMetricVisualizationYAxis[];
|
|
6340
|
+
}
|
|
5518
6341
|
/** create-org-schedule-interval */
|
|
5519
6342
|
export interface CreateOrgScheduleInterval {
|
|
5520
6343
|
/**
|
|
@@ -5542,6 +6365,231 @@ export interface CreateOrgScheduleInterval {
|
|
|
5542
6365
|
*/
|
|
5543
6366
|
to?: string;
|
|
5544
6367
|
}
|
|
6368
|
+
/** create-packed-bubble-visualization-x-axis */
|
|
6369
|
+
export interface CreatePackedBubbleVisualizationXAxis {
|
|
6370
|
+
/**
|
|
6371
|
+
* The label description for the axis.
|
|
6372
|
+
* @format text
|
|
6373
|
+
*/
|
|
6374
|
+
axis_label?: string;
|
|
6375
|
+
color?: CreateVisualizationAxisColor;
|
|
6376
|
+
/** The drill through configurations for the axis. */
|
|
6377
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6378
|
+
/** Whether the axis should be hidden. */
|
|
6379
|
+
is_hidden?: boolean;
|
|
6380
|
+
/**
|
|
6381
|
+
* The label for the axis.
|
|
6382
|
+
* @format text
|
|
6383
|
+
*/
|
|
6384
|
+
label?: string;
|
|
6385
|
+
/**
|
|
6386
|
+
* The reference name of the axis.
|
|
6387
|
+
* @format text
|
|
6388
|
+
*/
|
|
6389
|
+
reference_name: string;
|
|
6390
|
+
}
|
|
6391
|
+
/** create-packed-bubble-visualization-y-axis */
|
|
6392
|
+
export interface CreatePackedBubbleVisualizationYAxis {
|
|
6393
|
+
/**
|
|
6394
|
+
* The label description for the axis.
|
|
6395
|
+
* @format text
|
|
6396
|
+
*/
|
|
6397
|
+
axis_label?: string;
|
|
6398
|
+
color?: CreateVisualizationAxisColor;
|
|
6399
|
+
/** The drill through configurations for the axis. */
|
|
6400
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6401
|
+
/** Whether the axis should be hidden. */
|
|
6402
|
+
is_hidden?: boolean;
|
|
6403
|
+
/**
|
|
6404
|
+
* The label for the axis.
|
|
6405
|
+
* @format text
|
|
6406
|
+
*/
|
|
6407
|
+
label?: string;
|
|
6408
|
+
/**
|
|
6409
|
+
* The reference name of the axis.
|
|
6410
|
+
* @format text
|
|
6411
|
+
*/
|
|
6412
|
+
reference_name: string;
|
|
6413
|
+
}
|
|
6414
|
+
/** create-packed-bubble-widget-visualization */
|
|
6415
|
+
export interface CreatePackedBubbleWidgetVisualization {
|
|
6416
|
+
/** The configuration for the X-axis. */
|
|
6417
|
+
x: CreatePackedBubbleVisualizationXAxis[];
|
|
6418
|
+
/** The configuration for the Y-axes. */
|
|
6419
|
+
y: CreatePackedBubbleVisualizationYAxis[];
|
|
6420
|
+
}
|
|
6421
|
+
/** create-pie-visualization-x-axis */
|
|
6422
|
+
export interface CreatePieVisualizationXAxis {
|
|
6423
|
+
/**
|
|
6424
|
+
* The label description for the axis.
|
|
6425
|
+
* @format text
|
|
6426
|
+
*/
|
|
6427
|
+
axis_label?: string;
|
|
6428
|
+
color?: CreateVisualizationAxisColor;
|
|
6429
|
+
/** The drill through configurations for the axis. */
|
|
6430
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6431
|
+
/** Whether the axis should be hidden. */
|
|
6432
|
+
is_hidden?: boolean;
|
|
6433
|
+
/**
|
|
6434
|
+
* The label for the axis.
|
|
6435
|
+
* @format text
|
|
6436
|
+
*/
|
|
6437
|
+
label?: string;
|
|
6438
|
+
/**
|
|
6439
|
+
* The reference name of the axis.
|
|
6440
|
+
* @format text
|
|
6441
|
+
*/
|
|
6442
|
+
reference_name: string;
|
|
6443
|
+
}
|
|
6444
|
+
/** create-pie-visualization-y-axis */
|
|
6445
|
+
export interface CreatePieVisualizationYAxis {
|
|
6446
|
+
/**
|
|
6447
|
+
* The label description for the axis.
|
|
6448
|
+
* @format text
|
|
6449
|
+
*/
|
|
6450
|
+
axis_label?: string;
|
|
6451
|
+
color?: CreateVisualizationAxisColor;
|
|
6452
|
+
/** The drill through configurations for the axis. */
|
|
6453
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6454
|
+
/** Whether the axis should be hidden. */
|
|
6455
|
+
is_hidden?: boolean;
|
|
6456
|
+
/**
|
|
6457
|
+
* The label for the axis.
|
|
6458
|
+
* @format text
|
|
6459
|
+
*/
|
|
6460
|
+
label?: string;
|
|
6461
|
+
/**
|
|
6462
|
+
* The reference name of the axis.
|
|
6463
|
+
* @format text
|
|
6464
|
+
*/
|
|
6465
|
+
reference_name: string;
|
|
6466
|
+
}
|
|
6467
|
+
/** create-pie-widget-visualization */
|
|
6468
|
+
export interface CreatePieWidgetVisualization {
|
|
6469
|
+
rollup?: CreateVisualizationRollup;
|
|
6470
|
+
/** The configuration for the X-axis. */
|
|
6471
|
+
x: CreatePieVisualizationXAxis[];
|
|
6472
|
+
y: CreatePieVisualizationYAxis;
|
|
6473
|
+
}
|
|
6474
|
+
/** create-rich-text-widget-visualization */
|
|
6475
|
+
export interface CreateRichTextWidgetVisualization {
|
|
6476
|
+
/** The content of the rich text. */
|
|
6477
|
+
content: object;
|
|
6478
|
+
}
|
|
6479
|
+
/** create-scatter-visualization-x-axis */
|
|
6480
|
+
export interface CreateScatterVisualizationXAxis {
|
|
6481
|
+
/**
|
|
6482
|
+
* The label description for the axis.
|
|
6483
|
+
* @format text
|
|
6484
|
+
*/
|
|
6485
|
+
axis_label?: string;
|
|
6486
|
+
color?: CreateVisualizationAxisColor;
|
|
6487
|
+
/** The drill through configurations for the axis. */
|
|
6488
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6489
|
+
/** Whether the axis should be hidden. */
|
|
6490
|
+
is_hidden?: boolean;
|
|
6491
|
+
/**
|
|
6492
|
+
* The label for the axis.
|
|
6493
|
+
* @format text
|
|
6494
|
+
*/
|
|
6495
|
+
label?: string;
|
|
6496
|
+
/**
|
|
6497
|
+
* The reference name of the axis.
|
|
6498
|
+
* @format text
|
|
6499
|
+
*/
|
|
6500
|
+
reference_name: string;
|
|
6501
|
+
}
|
|
6502
|
+
/** create-scatter-visualization-y-axis */
|
|
6503
|
+
export interface CreateScatterVisualizationYAxis {
|
|
6504
|
+
/**
|
|
6505
|
+
* The label description for the axis.
|
|
6506
|
+
* @format text
|
|
6507
|
+
*/
|
|
6508
|
+
axis_label?: string;
|
|
6509
|
+
color?: CreateVisualizationAxisColor;
|
|
6510
|
+
/** The drill through configurations for the axis. */
|
|
6511
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6512
|
+
/** Whether the axis should be hidden. */
|
|
6513
|
+
is_hidden?: boolean;
|
|
6514
|
+
/**
|
|
6515
|
+
* The label for the axis.
|
|
6516
|
+
* @format text
|
|
6517
|
+
*/
|
|
6518
|
+
label?: string;
|
|
6519
|
+
/**
|
|
6520
|
+
* The reference name of the axis.
|
|
6521
|
+
* @format text
|
|
6522
|
+
*/
|
|
6523
|
+
reference_name: string;
|
|
6524
|
+
}
|
|
6525
|
+
/** create-scatter-widget-visualization */
|
|
6526
|
+
export interface CreateScatterWidgetVisualization {
|
|
6527
|
+
rollup?: CreateVisualizationRollup;
|
|
6528
|
+
/** The configuration for the X-axis. */
|
|
6529
|
+
x: CreateScatterVisualizationXAxis[];
|
|
6530
|
+
/** The configuration for the Y-axes. */
|
|
6531
|
+
y: CreateScatterVisualizationYAxis[];
|
|
6532
|
+
}
|
|
6533
|
+
/** create-series-visualization */
|
|
6534
|
+
export interface CreateSeriesVisualization {
|
|
6535
|
+
/** The type of the series. */
|
|
6536
|
+
type?: SeriesVisualizationType;
|
|
6537
|
+
/**
|
|
6538
|
+
* Color key for the series.
|
|
6539
|
+
* @format text
|
|
6540
|
+
*/
|
|
6541
|
+
color_key?: string;
|
|
6542
|
+
data_labels?: CreateDataLabelConfig;
|
|
6543
|
+
drill_through?: CreateVisualizationAxisDrillThrough;
|
|
6544
|
+
/** Whether the area under the line should be filled. */
|
|
6545
|
+
is_area_filled?: boolean;
|
|
6546
|
+
/** Whether the line should be a spline. */
|
|
6547
|
+
is_spline?: boolean;
|
|
6548
|
+
/** Whether the series should be visible. */
|
|
6549
|
+
is_visible?: boolean;
|
|
6550
|
+
/** Whether the line have circular marker. */
|
|
6551
|
+
marker?: boolean;
|
|
6552
|
+
/**
|
|
6553
|
+
* Name of the series.
|
|
6554
|
+
* @format text
|
|
6555
|
+
*/
|
|
6556
|
+
name?: string;
|
|
6557
|
+
/**
|
|
6558
|
+
* Name key for the series.
|
|
6559
|
+
* @format text
|
|
6560
|
+
*/
|
|
6561
|
+
name_key?: string;
|
|
6562
|
+
scrollbar?: CreateVisualizationScrollbar;
|
|
6563
|
+
/** Whether to show data labels. */
|
|
6564
|
+
show_data_labels?: boolean;
|
|
6565
|
+
/**
|
|
6566
|
+
* Stack for the series.
|
|
6567
|
+
* @format text
|
|
6568
|
+
*/
|
|
6569
|
+
stack?: string;
|
|
6570
|
+
/** The stroke style for the line. */
|
|
6571
|
+
stroke_style?: SeriesVisualizationStrokeStyle;
|
|
6572
|
+
/**
|
|
6573
|
+
* X axis data for the series.
|
|
6574
|
+
* @format text
|
|
6575
|
+
*/
|
|
6576
|
+
x?: string;
|
|
6577
|
+
/**
|
|
6578
|
+
* X axis for the series.
|
|
6579
|
+
* @format int64
|
|
6580
|
+
*/
|
|
6581
|
+
x_axis?: number;
|
|
6582
|
+
/**
|
|
6583
|
+
* Y axis data for the series.
|
|
6584
|
+
* @format text
|
|
6585
|
+
*/
|
|
6586
|
+
y?: string;
|
|
6587
|
+
/**
|
|
6588
|
+
* Y axis for the series.
|
|
6589
|
+
* @format int64
|
|
6590
|
+
*/
|
|
6591
|
+
y_axis?: number;
|
|
6592
|
+
}
|
|
5545
6593
|
/**
|
|
5546
6594
|
* create-stage
|
|
5547
6595
|
* Create object for stage.
|
|
@@ -5641,6 +6689,24 @@ export interface CreateStarterMessageNudgeWidget {
|
|
|
5641
6689
|
starter_message_nudge_type: CreateStarterMessageNudgeWidgetStarterMessageNudgeType;
|
|
5642
6690
|
}
|
|
5643
6691
|
export type CreateStarterMessageNudgeWidgetStarterMessageNudgeType = string;
|
|
6692
|
+
/** create-sub-widget */
|
|
6693
|
+
export interface CreateSubWidget {
|
|
6694
|
+
/** A unified query language for DevRev objects. */
|
|
6695
|
+
dql_query?: DevrevQuery;
|
|
6696
|
+
query?: CreateWidgetQuery;
|
|
6697
|
+
/**
|
|
6698
|
+
* A reference ID for the sub-widget. It should be unique within the
|
|
6699
|
+
* widget.
|
|
6700
|
+
* @format text
|
|
6701
|
+
*/
|
|
6702
|
+
reference_id: string;
|
|
6703
|
+
/**
|
|
6704
|
+
* The title of the sub widget.
|
|
6705
|
+
* @format text
|
|
6706
|
+
*/
|
|
6707
|
+
title?: string;
|
|
6708
|
+
visualization: CreateWidgetVisualization;
|
|
6709
|
+
}
|
|
5644
6710
|
/** create-sync-in */
|
|
5645
6711
|
export interface CreateSyncIn {
|
|
5646
6712
|
/** Status of the sync for the object. */
|
|
@@ -5802,6 +6868,99 @@ export interface CreateSyncUnitReconciliationScenario {
|
|
|
5802
6868
|
*/
|
|
5803
6869
|
extract_to_date: string;
|
|
5804
6870
|
}
|
|
6871
|
+
/** create-table-data-storage */
|
|
6872
|
+
export interface CreateTableDataStorage {
|
|
6873
|
+
/** The type of data storage. */
|
|
6874
|
+
type: TableDataStorageType;
|
|
6875
|
+
/**
|
|
6876
|
+
* The inline snapshot of the data. Set when type is inline.
|
|
6877
|
+
* @format text
|
|
6878
|
+
*/
|
|
6879
|
+
inline_data?: string;
|
|
6880
|
+
/**
|
|
6881
|
+
* The URL of the data. Set when data is stored externally.
|
|
6882
|
+
* @format text
|
|
6883
|
+
*/
|
|
6884
|
+
url?: string;
|
|
6885
|
+
}
|
|
6886
|
+
/** create-table-visualization-column */
|
|
6887
|
+
export interface CreateTableVisualizationColumn {
|
|
6888
|
+
/**
|
|
6889
|
+
* The label description for the axis.
|
|
6890
|
+
* @format text
|
|
6891
|
+
*/
|
|
6892
|
+
axis_label?: string;
|
|
6893
|
+
color?: CreateVisualizationAxisColor;
|
|
6894
|
+
/** The drill through configurations for the axis. */
|
|
6895
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6896
|
+
/** Whether the axis should be hidden. */
|
|
6897
|
+
is_hidden?: boolean;
|
|
6898
|
+
/** Whether the column should be movable. */
|
|
6899
|
+
is_movable?: boolean;
|
|
6900
|
+
/** Whether the column should be pinned, by default set to false. */
|
|
6901
|
+
is_pinned?: boolean;
|
|
6902
|
+
/** Whether the column should be resizable. */
|
|
6903
|
+
is_resizable?: boolean;
|
|
6904
|
+
/** Whether the column should be sortable. */
|
|
6905
|
+
is_sortable?: boolean;
|
|
6906
|
+
/** Whether the column visibility can be toggled. */
|
|
6907
|
+
is_visibility_togglable?: boolean;
|
|
6908
|
+
/**
|
|
6909
|
+
* The label for the axis.
|
|
6910
|
+
* @format text
|
|
6911
|
+
*/
|
|
6912
|
+
label?: string;
|
|
6913
|
+
/**
|
|
6914
|
+
* Whether the column should be locked to the left or right side of the
|
|
6915
|
+
* table.
|
|
6916
|
+
*/
|
|
6917
|
+
lock_position?: TableVisualizationColumnLockPosition;
|
|
6918
|
+
/**
|
|
6919
|
+
* The maximum width of the column.
|
|
6920
|
+
* @format int64
|
|
6921
|
+
*/
|
|
6922
|
+
max_width?: number;
|
|
6923
|
+
/**
|
|
6924
|
+
* The minimum width of the column.
|
|
6925
|
+
* @format int64
|
|
6926
|
+
*/
|
|
6927
|
+
min_width?: number;
|
|
6928
|
+
/**
|
|
6929
|
+
* The order in which the column should be displayed.
|
|
6930
|
+
* @format int64
|
|
6931
|
+
*/
|
|
6932
|
+
order?: number;
|
|
6933
|
+
/**
|
|
6934
|
+
* Whether the column should be pinned to the left or right side of the
|
|
6935
|
+
* table.
|
|
6936
|
+
*/
|
|
6937
|
+
pin_position?: TableVisualizationColumnPinPosition;
|
|
6938
|
+
/**
|
|
6939
|
+
* The reference name of the axis.
|
|
6940
|
+
* @format text
|
|
6941
|
+
*/
|
|
6942
|
+
reference_name: string;
|
|
6943
|
+
/**
|
|
6944
|
+
* The width of the column in pixel.
|
|
6945
|
+
* @format int64
|
|
6946
|
+
*/
|
|
6947
|
+
width?: number;
|
|
6948
|
+
}
|
|
6949
|
+
/** create-table-widget-visualization */
|
|
6950
|
+
export interface CreateTableWidgetVisualization {
|
|
6951
|
+
/** The configuration for the columns in the table. */
|
|
6952
|
+
columns: CreateTableVisualizationColumn[];
|
|
6953
|
+
/** The group_by configuration in the table. */
|
|
6954
|
+
group_by?: CreateWidgetGroupByConfig[];
|
|
6955
|
+
/** Whether the table is static. */
|
|
6956
|
+
is_static?: boolean;
|
|
6957
|
+
/**
|
|
6958
|
+
* The maximum number of items that can be returned for each group.
|
|
6959
|
+
* @format int64
|
|
6960
|
+
*/
|
|
6961
|
+
limit_per_group?: number;
|
|
6962
|
+
rollup?: CreateVisualizationRollup;
|
|
6963
|
+
}
|
|
5805
6964
|
/**
|
|
5806
6965
|
* create-tag-with-value
|
|
5807
6966
|
* Create object for tag_summary.
|
|
@@ -5819,6 +6978,56 @@ export interface CreateTagWithValue {
|
|
|
5819
6978
|
*/
|
|
5820
6979
|
value?: string;
|
|
5821
6980
|
}
|
|
6981
|
+
/** create-visualization-axis-color */
|
|
6982
|
+
export interface CreateVisualizationAxisColor {
|
|
6983
|
+
/** The type of the color. */
|
|
6984
|
+
type: VisualizationAxisColorType;
|
|
6985
|
+
/** The key lookup color. */
|
|
6986
|
+
key_lookup?: CreateVisualizationAxisColorKeyLookup[];
|
|
6987
|
+
/**
|
|
6988
|
+
* The static color.
|
|
6989
|
+
* @format text
|
|
6990
|
+
*/
|
|
6991
|
+
static?: string;
|
|
6992
|
+
}
|
|
6993
|
+
/** create-visualization-axis-color-key-lookup */
|
|
6994
|
+
export interface CreateVisualizationAxisColorKeyLookup {
|
|
6995
|
+
/**
|
|
6996
|
+
* The key to map to a color.
|
|
6997
|
+
* @format text
|
|
6998
|
+
*/
|
|
6999
|
+
key: string;
|
|
7000
|
+
/**
|
|
7001
|
+
* The color value.
|
|
7002
|
+
* @format text
|
|
7003
|
+
*/
|
|
7004
|
+
value: string;
|
|
7005
|
+
}
|
|
7006
|
+
/** create-visualization-axis-drill-through */
|
|
7007
|
+
export interface CreateVisualizationAxisDrillThrough {
|
|
7008
|
+
/**
|
|
7009
|
+
* The ID of the dashboard to navigate to when the axis is clicked.
|
|
7010
|
+
* @format id
|
|
7011
|
+
*/
|
|
7012
|
+
dashboard: string;
|
|
7013
|
+
/**
|
|
7014
|
+
* The label for the drill through.
|
|
7015
|
+
* @format text
|
|
7016
|
+
*/
|
|
7017
|
+
label: string;
|
|
7018
|
+
}
|
|
7019
|
+
/** create-visualization-rollup */
|
|
7020
|
+
export interface CreateVisualizationRollup {
|
|
7021
|
+
/** Whether the visualization should be auto-rolled up. */
|
|
7022
|
+
auto_rollup?: boolean;
|
|
7023
|
+
/** The supported rollup types. */
|
|
7024
|
+
supported_rollups?: string[];
|
|
7025
|
+
}
|
|
7026
|
+
/** create-visualization-scrollbar */
|
|
7027
|
+
export interface CreateVisualizationScrollbar {
|
|
7028
|
+
/** Enable chart scrollbar. */
|
|
7029
|
+
enabled?: boolean;
|
|
7030
|
+
}
|
|
5822
7031
|
/** create-weekly-org-schedule-interval */
|
|
5823
7032
|
export interface CreateWeeklyOrgScheduleInterval {
|
|
5824
7033
|
/**
|
|
@@ -5835,6 +7044,269 @@ export interface CreateWeeklyOrgScheduleInterval {
|
|
|
5835
7044
|
*/
|
|
5836
7045
|
to: number;
|
|
5837
7046
|
}
|
|
7047
|
+
/** create-widget-api-data-source */
|
|
7048
|
+
export interface CreateWidgetApiDataSource {
|
|
7049
|
+
/** Object IDs to include in the data source. */
|
|
7050
|
+
include?: string[];
|
|
7051
|
+
/** Indicates if the leaf type is custom. */
|
|
7052
|
+
is_custom_leaf_type?: boolean;
|
|
7053
|
+
/**
|
|
7054
|
+
* The object's type.
|
|
7055
|
+
* @format text
|
|
7056
|
+
*/
|
|
7057
|
+
leaf_type?: string;
|
|
7058
|
+
/** The subtypes of the object. */
|
|
7059
|
+
subtypes?: string[];
|
|
7060
|
+
}
|
|
7061
|
+
/** create-widget-column-projection */
|
|
7062
|
+
export interface CreateWidgetColumnProjection {
|
|
7063
|
+
/** The type of the column. */
|
|
7064
|
+
type?: WidgetColumnProjectionType;
|
|
7065
|
+
custom_field?: CreateCustomFieldWidgetColumnProjection;
|
|
7066
|
+
/** Set of field attributes. */
|
|
7067
|
+
devrev_schema?: SchemaFieldDescriptor;
|
|
7068
|
+
/** Whether the column has a custom expression. */
|
|
7069
|
+
has_custom_expression?: boolean;
|
|
7070
|
+
/** Whether the column is derived. */
|
|
7071
|
+
is_derived?: boolean;
|
|
7072
|
+
meerkat_schema?: CreateMeerkatWidgetColumnProjection;
|
|
7073
|
+
/**
|
|
7074
|
+
* The reference name of the column.
|
|
7075
|
+
* @format text
|
|
7076
|
+
*/
|
|
7077
|
+
reference_name: string;
|
|
7078
|
+
}
|
|
7079
|
+
/** create-widget-data-source */
|
|
7080
|
+
export interface CreateWidgetDataSource {
|
|
7081
|
+
/** The type of the data source. */
|
|
7082
|
+
type: WidgetDataSourceType;
|
|
7083
|
+
api?: CreateWidgetApiDataSource;
|
|
7084
|
+
/**
|
|
7085
|
+
* The ID of the data source. Meant to be set when the type is
|
|
7086
|
+
* data_source.
|
|
7087
|
+
* @format text
|
|
7088
|
+
*/
|
|
7089
|
+
data_source?: string;
|
|
7090
|
+
/**
|
|
7091
|
+
* The ID of the data view. Meant to be set when the type is
|
|
7092
|
+
* data_view.
|
|
7093
|
+
* @format text
|
|
7094
|
+
*/
|
|
7095
|
+
data_view?: string;
|
|
7096
|
+
/**
|
|
7097
|
+
* The dimensions (or the extended dimensions) provided by the data
|
|
7098
|
+
* source. These are the categories that can be used to group or
|
|
7099
|
+
* segment the measures.
|
|
7100
|
+
*/
|
|
7101
|
+
dimensions?: CreateWidgetColumnProjection[];
|
|
7102
|
+
external_data_source?: CreateWidgetDataSourceReference;
|
|
7103
|
+
/** Whether the data source is a system data source. */
|
|
7104
|
+
is_system?: boolean;
|
|
7105
|
+
/**
|
|
7106
|
+
* A list of possible joins for the data source. Follows foreign key
|
|
7107
|
+
* semantics.
|
|
7108
|
+
*/
|
|
7109
|
+
joins?: CreateDataSourceJoin[];
|
|
7110
|
+
/**
|
|
7111
|
+
* The measures (or the extended measures) provided by the data
|
|
7112
|
+
* source. These are the numerical values that can be analyzed.
|
|
7113
|
+
*/
|
|
7114
|
+
measures?: CreateWidgetColumnProjection[];
|
|
7115
|
+
oasis?: CreateWidgetOasisDataSource;
|
|
7116
|
+
/**
|
|
7117
|
+
* The reference name of the data source.
|
|
7118
|
+
* @format text
|
|
7119
|
+
*/
|
|
7120
|
+
reference_name: string;
|
|
7121
|
+
}
|
|
7122
|
+
/** create-widget-data-source-reference */
|
|
7123
|
+
export interface CreateWidgetDataSourceReference {
|
|
7124
|
+
/**
|
|
7125
|
+
* The column projections for the data source. These are the columns
|
|
7126
|
+
* that are projected from the datasets.
|
|
7127
|
+
*/
|
|
7128
|
+
dataset_projections?: CreateWidgetOasisDatasetColumnProjection[];
|
|
7129
|
+
/**
|
|
7130
|
+
* The id of the data source.
|
|
7131
|
+
* @format text
|
|
7132
|
+
*/
|
|
7133
|
+
id: string;
|
|
7134
|
+
}
|
|
7135
|
+
/** create-widget-group-by-config */
|
|
7136
|
+
export interface CreateWidgetGroupByConfig {
|
|
7137
|
+
/**
|
|
7138
|
+
* The key on which group_by is applied.
|
|
7139
|
+
* @format text
|
|
7140
|
+
*/
|
|
7141
|
+
key: string;
|
|
7142
|
+
/**
|
|
7143
|
+
* The maximum number of unique values that can be returned for the
|
|
7144
|
+
* key.
|
|
7145
|
+
* @format int64
|
|
7146
|
+
*/
|
|
7147
|
+
limit?: number;
|
|
7148
|
+
}
|
|
7149
|
+
/** create-widget-oasis-data-source */
|
|
7150
|
+
export interface CreateWidgetOasisDataSource {
|
|
7151
|
+
/** List of datasets used by the data source. */
|
|
7152
|
+
datasets?: string[];
|
|
7153
|
+
/**
|
|
7154
|
+
* The column projections for the data source. These are the columns
|
|
7155
|
+
* that are projected from the datasets.
|
|
7156
|
+
*/
|
|
7157
|
+
projections?: CreateWidgetOasisDatasetColumnProjection[];
|
|
7158
|
+
/**
|
|
7159
|
+
* The base SQL query that constructs the view for the data source.
|
|
7160
|
+
* The SQL can reference the datasets using their aliases.
|
|
7161
|
+
* @format text
|
|
7162
|
+
*/
|
|
7163
|
+
sql_query: string;
|
|
7164
|
+
}
|
|
7165
|
+
/** create-widget-oasis-dataset-column */
|
|
7166
|
+
export interface CreateWidgetOasisDatasetColumn {
|
|
7167
|
+
custom_field?: CreateCustomFieldWidgetColumnProjection;
|
|
7168
|
+
/**
|
|
7169
|
+
* The name of the column.
|
|
7170
|
+
* @format text
|
|
7171
|
+
*/
|
|
7172
|
+
name: string;
|
|
7173
|
+
}
|
|
7174
|
+
/** create-widget-oasis-dataset-column-projection */
|
|
7175
|
+
export interface CreateWidgetOasisDatasetColumnProjection {
|
|
7176
|
+
/** The column name. */
|
|
7177
|
+
columns: CreateWidgetOasisDatasetColumn[];
|
|
7178
|
+
/**
|
|
7179
|
+
* The dataset ID.
|
|
7180
|
+
* @format text
|
|
7181
|
+
*/
|
|
7182
|
+
dataset: string;
|
|
7183
|
+
}
|
|
7184
|
+
/** create-widget-pvp-config */
|
|
7185
|
+
export interface CreateWidgetPvpConfig {
|
|
7186
|
+
/** Indicates whether PVP is enabled. */
|
|
7187
|
+
enabled?: boolean;
|
|
7188
|
+
/** Specifies whether the color scheme for PVP is inverted. */
|
|
7189
|
+
invert_correlation_color?: boolean;
|
|
7190
|
+
/**
|
|
7191
|
+
* Decimal precision for percentage.
|
|
7192
|
+
* @format int64
|
|
7193
|
+
*/
|
|
7194
|
+
percentage_precision?: number;
|
|
7195
|
+
}
|
|
7196
|
+
/** create-widget-query */
|
|
7197
|
+
export interface CreateWidgetQuery {
|
|
7198
|
+
/**
|
|
7199
|
+
* Extended dimension configurations that pair column references with
|
|
7200
|
+
* query-time operations like rollups and aggregation functions.
|
|
7201
|
+
*/
|
|
7202
|
+
dimension_configs?: CreateWidgetQueryColumnConfig[];
|
|
7203
|
+
/**
|
|
7204
|
+
* The dimensions for the query, which are the categories to group or
|
|
7205
|
+
* segment the measures. Usually these are the X-axis values in a
|
|
7206
|
+
* visualization.
|
|
7207
|
+
*/
|
|
7208
|
+
dimensions?: string[];
|
|
7209
|
+
/**
|
|
7210
|
+
* Set of filters to apply on the widgets. These filters are applied
|
|
7211
|
+
* on top of the dashboard level filters.
|
|
7212
|
+
*/
|
|
7213
|
+
filters?: CreateDashboardFilter[];
|
|
7214
|
+
/** Join paths to use for the query. */
|
|
7215
|
+
joins?: CreateWidgetQueryJoins[];
|
|
7216
|
+
/**
|
|
7217
|
+
* The maximum number of records to return. This is used to limit the
|
|
7218
|
+
* amount of data returned by the query.
|
|
7219
|
+
* @format int64
|
|
7220
|
+
*/
|
|
7221
|
+
limit?: number;
|
|
7222
|
+
/**
|
|
7223
|
+
* Extended measure configurations that pair column references with
|
|
7224
|
+
* query-time operations like aggregation functions and rollups.
|
|
7225
|
+
*/
|
|
7226
|
+
measure_configs?: CreateWidgetQueryColumnConfig[];
|
|
7227
|
+
/**
|
|
7228
|
+
* The measures for the query, which are the numerical values to be
|
|
7229
|
+
* analyzed. Usually these are the Y-axis values in a visualization.
|
|
7230
|
+
*/
|
|
7231
|
+
measures?: string[];
|
|
7232
|
+
/**
|
|
7233
|
+
* The order in which the data should be returned. This is used to
|
|
7234
|
+
* sort the data returned by the query.
|
|
7235
|
+
*/
|
|
7236
|
+
order_by?: CreateWidgetQueryOrderBy[];
|
|
7237
|
+
}
|
|
7238
|
+
/** create-widget-query-column-config */
|
|
7239
|
+
export interface CreateWidgetQueryColumnConfig {
|
|
7240
|
+
/**
|
|
7241
|
+
* The category of the query-time operation. Time_granularity buckets
|
|
7242
|
+
* timestamp values by granularity. Aggregation applies an aggregate
|
|
7243
|
+
* function to the column. When omitted the column is a plain reference.
|
|
7244
|
+
*/
|
|
7245
|
+
type?: WidgetQueryColumnConfigType;
|
|
7246
|
+
/** The aggregation function type. Set when type is aggregation. */
|
|
7247
|
+
aggregation?: WidgetQueryColumnConfigAggregation;
|
|
7248
|
+
/**
|
|
7249
|
+
* The name of the source column from the data source.
|
|
7250
|
+
* @format text
|
|
7251
|
+
*/
|
|
7252
|
+
column_name: string;
|
|
7253
|
+
/**
|
|
7254
|
+
* A deterministic unique identifier derived from column_name, type,
|
|
7255
|
+
* and the active value field. Used to reference this column+operation
|
|
7256
|
+
* in visualization axes, order_by, filters, and other downstream
|
|
7257
|
+
* configurations.
|
|
7258
|
+
* @format text
|
|
7259
|
+
*/
|
|
7260
|
+
reference_name: string;
|
|
7261
|
+
/** The time granularity for bucketing. Set when type is time_granularity. */
|
|
7262
|
+
time_granularity?: WidgetQueryColumnConfigTimeGranularity;
|
|
7263
|
+
}
|
|
7264
|
+
/** create-widget-query-joins */
|
|
7265
|
+
export interface CreateWidgetQueryJoins {
|
|
7266
|
+
/** A list of joins. */
|
|
7267
|
+
path: string[];
|
|
7268
|
+
}
|
|
7269
|
+
/** create-widget-query-order-by */
|
|
7270
|
+
export interface CreateWidgetQueryOrderBy {
|
|
7271
|
+
/** The direction of the sort. */
|
|
7272
|
+
direction: WidgetQueryOrderByDirection;
|
|
7273
|
+
/**
|
|
7274
|
+
* The column to sort by.
|
|
7275
|
+
* @format text
|
|
7276
|
+
*/
|
|
7277
|
+
reference_name: string;
|
|
7278
|
+
}
|
|
7279
|
+
/** create-widget-table-manifest */
|
|
7280
|
+
export interface CreateWidgetTableManifest {
|
|
7281
|
+
/** The columns projected for the widget. */
|
|
7282
|
+
columns: TableField[];
|
|
7283
|
+
data?: CreateTableDataStorage;
|
|
7284
|
+
/**
|
|
7285
|
+
* The sql query to be executed on the data.
|
|
7286
|
+
* @format text
|
|
7287
|
+
*/
|
|
7288
|
+
sql: string;
|
|
7289
|
+
}
|
|
7290
|
+
/** create-widget-visualization */
|
|
7291
|
+
export interface CreateWidgetVisualization {
|
|
7292
|
+
/** The type of the visualization, such as line, bar, pie, etc. */
|
|
7293
|
+
type: WidgetVisualizationType;
|
|
7294
|
+
bar?: CreateBarWidgetVisualization;
|
|
7295
|
+
column?: CreateColumnWidgetVisualization;
|
|
7296
|
+
combination?: CreateCombinationWidgetVisualization;
|
|
7297
|
+
donut?: CreateDonutWidgetVisualization;
|
|
7298
|
+
flame_graph?: CreateFlameGraphWidgetVisualization;
|
|
7299
|
+
gantt?: CreateGanttWidgetVisualization;
|
|
7300
|
+
heatmap?: CreateHeatmapWidgetVisualization;
|
|
7301
|
+
kanban?: CreateKanbanWidgetVisualization;
|
|
7302
|
+
line?: CreateLineWidgetVisualization;
|
|
7303
|
+
metric?: CreateMetricWidgetVisualization;
|
|
7304
|
+
packed_bubble?: CreatePackedBubbleWidgetVisualization;
|
|
7305
|
+
pie?: CreatePieWidgetVisualization;
|
|
7306
|
+
rich_text?: CreateRichTextWidgetVisualization;
|
|
7307
|
+
scatter?: CreateScatterWidgetVisualization;
|
|
7308
|
+
table?: CreateTableWidgetVisualization;
|
|
7309
|
+
}
|
|
5838
7310
|
/**
|
|
5839
7311
|
* curated-vista
|
|
5840
7312
|
* Static collection of DevRev objects.
|
|
@@ -5848,6 +7320,14 @@ export type CuratedVista = VistaBase & {
|
|
|
5848
7320
|
* Static collection of DevRev objects.
|
|
5849
7321
|
*/
|
|
5850
7322
|
export type CuratedVistaSummary = VistaBaseSummary;
|
|
7323
|
+
/** The period type for which to calculate current period range. */
|
|
7324
|
+
export declare enum CurrentPeriod {
|
|
7325
|
+
Day = "day",
|
|
7326
|
+
Month = "month",
|
|
7327
|
+
Quarter = "quarter",
|
|
7328
|
+
Week = "week",
|
|
7329
|
+
Year = "year"
|
|
7330
|
+
}
|
|
5851
7331
|
/**
|
|
5852
7332
|
* custom-field-widget-column-projection
|
|
5853
7333
|
* A custom field widget column projection.
|
|
@@ -5966,8 +7446,8 @@ export interface CustomLinkTypeListRequest {
|
|
|
5966
7446
|
/** Whether only deprecated link types should be filtered. */
|
|
5967
7447
|
is_deprecated?: boolean;
|
|
5968
7448
|
/**
|
|
5969
|
-
* The maximum number of items, for each result and
|
|
5970
|
-
*
|
|
7449
|
+
* The maximum number of items, for each result and reverse_result.
|
|
7450
|
+
* Default value is 50 for each.
|
|
5971
7451
|
* @format int32
|
|
5972
7452
|
*/
|
|
5973
7453
|
limit?: number;
|
|
@@ -6006,6 +7486,12 @@ export interface CustomLinkTypeListResponse {
|
|
|
6006
7486
|
prev_cursor?: string;
|
|
6007
7487
|
/** The custom link types. */
|
|
6008
7488
|
result: CustomLinkType[];
|
|
7489
|
+
/**
|
|
7490
|
+
* The custom link types matching the request filter in the backward
|
|
7491
|
+
* direction. Objects can be present in both result and
|
|
7492
|
+
* reverse_result.
|
|
7493
|
+
*/
|
|
7494
|
+
reverse_result: CustomLinkType[];
|
|
6009
7495
|
}
|
|
6010
7496
|
/** custom-link-type-summary */
|
|
6011
7497
|
export type CustomLinkTypeSummary = AtomBaseSummary & {
|
|
@@ -6958,6 +8444,69 @@ export type Dashboard = AtomBase;
|
|
|
6958
8444
|
* and widgets.
|
|
6959
8445
|
*/
|
|
6960
8446
|
export type DashboardFilter = object;
|
|
8447
|
+
/** The operator used to compare the key and value. */
|
|
8448
|
+
export declare enum DashboardFilterConditionOperator {
|
|
8449
|
+
Contains = "contains",
|
|
8450
|
+
Empty = "empty",
|
|
8451
|
+
Equals = "equals",
|
|
8452
|
+
NotEmpty = "not_empty",
|
|
8453
|
+
NotEquals = "not_equals",
|
|
8454
|
+
NotNull = "not_null",
|
|
8455
|
+
Null = "null",
|
|
8456
|
+
Range = "range"
|
|
8457
|
+
}
|
|
8458
|
+
/** The operator used to compare the key and value. */
|
|
8459
|
+
export declare enum DashboardFilterConditionValueType {
|
|
8460
|
+
JsonValue = "json_value",
|
|
8461
|
+
PartValue = "part_value",
|
|
8462
|
+
RelativeDateValue = "relative_date_value"
|
|
8463
|
+
}
|
|
8464
|
+
/** The logical operator that binds the filter conditions or expressions. */
|
|
8465
|
+
export declare enum DashboardFilterExpressionOperator {
|
|
8466
|
+
And = "and",
|
|
8467
|
+
Or = "or"
|
|
8468
|
+
}
|
|
8469
|
+
/**
|
|
8470
|
+
* The type of the operand. It can be either a filter expression or a
|
|
8471
|
+
* filter condition.
|
|
8472
|
+
*/
|
|
8473
|
+
export declare enum DashboardFilterOperandType {
|
|
8474
|
+
Condition = "condition",
|
|
8475
|
+
Expression = "expression"
|
|
8476
|
+
}
|
|
8477
|
+
/**
|
|
8478
|
+
* Type of current period (today, this week, this month, this quarter,
|
|
8479
|
+
* this year).
|
|
8480
|
+
*/
|
|
8481
|
+
export declare enum DashboardFilterRelativeDateConditionCurrentPeriodType {
|
|
8482
|
+
Day = "day",
|
|
8483
|
+
Month = "month",
|
|
8484
|
+
Quarter = "quarter",
|
|
8485
|
+
Week = "week",
|
|
8486
|
+
Year = "year"
|
|
8487
|
+
}
|
|
8488
|
+
/**
|
|
8489
|
+
* Type of date range from the start of a fiscal period to the current
|
|
8490
|
+
* date.
|
|
8491
|
+
*/
|
|
8492
|
+
export declare enum DashboardFilterRelativeDateConditionPeriodType {
|
|
8493
|
+
QuarterToDate = "quarter_to_date",
|
|
8494
|
+
YearToDate = "year_to_date"
|
|
8495
|
+
}
|
|
8496
|
+
/** The type of the relative date condition. */
|
|
8497
|
+
export declare enum DashboardFilterRelativeDateConditionType {
|
|
8498
|
+
CurrentPeriod = "current_period",
|
|
8499
|
+
CustomFiscalQuarter = "custom_fiscal_quarter",
|
|
8500
|
+
NextNDays = "next_n_days",
|
|
8501
|
+
NextNMonths = "next_n_months",
|
|
8502
|
+
NextNWeeks = "next_n_weeks",
|
|
8503
|
+
PeriodToDate = "period_to_date",
|
|
8504
|
+
PrevNDays = "prev_n_days",
|
|
8505
|
+
PrevNMonths = "prev_n_months",
|
|
8506
|
+
PrevNWeeks = "prev_n_weeks",
|
|
8507
|
+
RelativeFiscalQuarter = "relative_fiscal_quarter",
|
|
8508
|
+
RelativeFiscalYear = "relative_fiscal_year"
|
|
8509
|
+
}
|
|
6961
8510
|
/** dashboard-search-summary */
|
|
6962
8511
|
export type DashboardSearchSummary = SearchSummaryBase & {
|
|
6963
8512
|
dashboard: DashboardSummary;
|
|
@@ -7023,6 +8572,39 @@ export type DateTimePreset = (DateTimePresetLastNDays | DateTimePresetNextNDays)
|
|
|
7023
8572
|
/** Type of date preset. */
|
|
7024
8573
|
preset_type: DateTimePresetType;
|
|
7025
8574
|
};
|
|
8575
|
+
/** date-time-preset-current-period */
|
|
8576
|
+
export interface DateTimePresetCurrentPeriod {
|
|
8577
|
+
/**
|
|
8578
|
+
* IANA timezone name (e.g., 'America/New_York') to use for
|
|
8579
|
+
* calculating the period. If not specified, uses the default timezone
|
|
8580
|
+
* from the request context.
|
|
8581
|
+
* @format text
|
|
8582
|
+
*/
|
|
8583
|
+
location?: string;
|
|
8584
|
+
/**
|
|
8585
|
+
* Offset from the current period. 0: current period, -1: previous
|
|
8586
|
+
* period, 1: next period.
|
|
8587
|
+
* @format int32
|
|
8588
|
+
*/
|
|
8589
|
+
offset?: number;
|
|
8590
|
+
/** The period type for which to calculate current period range. */
|
|
8591
|
+
period: CurrentPeriod;
|
|
8592
|
+
}
|
|
8593
|
+
/** date-time-preset-custom-fiscal-quarter */
|
|
8594
|
+
export interface DateTimePresetCustomFiscalQuarter {
|
|
8595
|
+
/**
|
|
8596
|
+
* The fiscal quarter number (1-4) within the specified fiscal year.
|
|
8597
|
+
* @min 0
|
|
8598
|
+
* @max 4294967295
|
|
8599
|
+
*/
|
|
8600
|
+
quarter: number;
|
|
8601
|
+
/**
|
|
8602
|
+
* The fiscal year (e.g. 2024) for which to filter results.
|
|
8603
|
+
* @min 0
|
|
8604
|
+
* @max 4294967295
|
|
8605
|
+
*/
|
|
8606
|
+
year: number;
|
|
8607
|
+
}
|
|
7026
8608
|
/** date-time-preset-last-n-days */
|
|
7027
8609
|
export interface DateTimePresetLastNDays {
|
|
7028
8610
|
/**
|
|
@@ -7043,6 +8625,27 @@ export interface DateTimePresetNextNDays {
|
|
|
7043
8625
|
*/
|
|
7044
8626
|
days: number;
|
|
7045
8627
|
}
|
|
8628
|
+
/** date-time-preset-period-to-date */
|
|
8629
|
+
export interface DateTimePresetPeriodToDate {
|
|
8630
|
+
/** The period type for which to calculate period-to-date. */
|
|
8631
|
+
period_to_date: PeriodToDate;
|
|
8632
|
+
}
|
|
8633
|
+
/** date-time-preset-relative-fiscal-quarter */
|
|
8634
|
+
export interface DateTimePresetRelativeFiscalQuarter {
|
|
8635
|
+
/**
|
|
8636
|
+
* Relative offset from current fiscal quarter.
|
|
8637
|
+
* @format int32
|
|
8638
|
+
*/
|
|
8639
|
+
offset: number;
|
|
8640
|
+
}
|
|
8641
|
+
/** date-time-preset-relative-fiscal-year */
|
|
8642
|
+
export interface DateTimePresetRelativeFiscalYear {
|
|
8643
|
+
/**
|
|
8644
|
+
* Relative offset from current fiscal year.
|
|
8645
|
+
* @format int32
|
|
8646
|
+
*/
|
|
8647
|
+
offset: number;
|
|
8648
|
+
}
|
|
7046
8649
|
/** Type of date preset. */
|
|
7047
8650
|
export declare enum DateTimePresetType {
|
|
7048
8651
|
LastNDays = "last_n_days",
|
|
@@ -7962,146 +9565,156 @@ export interface DevUsersSelfUpdateRequest {
|
|
|
7962
9565
|
* @format text
|
|
7963
9566
|
*/
|
|
7964
9567
|
full_name?: string;
|
|
7965
|
-
/** Job history of the Dev user. */
|
|
7966
|
-
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
7967
|
-
/** Job title of the Dev User. */
|
|
7968
|
-
job_title?: DevUserJobTitle;
|
|
7969
9568
|
/**
|
|
7970
|
-
* The
|
|
9569
|
+
* The job function of the Dev user.
|
|
9570
|
+
* @format text
|
|
9571
|
+
*/
|
|
9572
|
+
job_function?: string;
|
|
9573
|
+
/** Job history of the Dev user. */
|
|
9574
|
+
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
9575
|
+
/** Job title of the Dev User. */
|
|
9576
|
+
job_title?: DevUserJobTitle;
|
|
9577
|
+
/**
|
|
9578
|
+
* The ID of the Dev user that the user reports to.
|
|
9579
|
+
* @format id
|
|
9580
|
+
*/
|
|
9581
|
+
reports_to?: string;
|
|
9582
|
+
}
|
|
9583
|
+
/** dev-users-update-job-history-item */
|
|
9584
|
+
export interface DevUsersUpdateJobHistoryItem {
|
|
9585
|
+
/**
|
|
9586
|
+
* Enum for the employment status of the user.
|
|
9587
|
+
* @format int64
|
|
9588
|
+
*/
|
|
9589
|
+
employment_status?: number;
|
|
9590
|
+
/**
|
|
9591
|
+
* End date of the job.
|
|
9592
|
+
* @format date-time
|
|
9593
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
9594
|
+
*/
|
|
9595
|
+
end_date?: string;
|
|
9596
|
+
/** Is this the current active job for the user. */
|
|
9597
|
+
is_current?: boolean;
|
|
9598
|
+
/**
|
|
9599
|
+
* The job location for the user.
|
|
9600
|
+
* @format text
|
|
9601
|
+
*/
|
|
9602
|
+
location?: string;
|
|
9603
|
+
/**
|
|
9604
|
+
* Start date of the job.
|
|
9605
|
+
* @format date-time
|
|
9606
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
9607
|
+
*/
|
|
9608
|
+
start_date?: string;
|
|
9609
|
+
/**
|
|
9610
|
+
* The job title for the user.
|
|
9611
|
+
* @format text
|
|
9612
|
+
*/
|
|
9613
|
+
title?: string;
|
|
9614
|
+
}
|
|
9615
|
+
/**
|
|
9616
|
+
* dev-users-update-request
|
|
9617
|
+
* A request to update the user's information corresponding to the
|
|
9618
|
+
* provided Dev user.
|
|
9619
|
+
*/
|
|
9620
|
+
export interface DevUsersUpdateRequest {
|
|
9621
|
+
/**
|
|
9622
|
+
* Availability modes of the Dev user. Stock allowed values:
|
|
9623
|
+
* ```
|
|
9624
|
+
* {
|
|
9625
|
+
* "id": 1,
|
|
9626
|
+
* "label": "Ticket",
|
|
9627
|
+
* "ordinal": 1,
|
|
9628
|
+
* "overridable": false
|
|
9629
|
+
* },
|
|
9630
|
+
* {
|
|
9631
|
+
* "id": 2,
|
|
9632
|
+
* "label": "Conversation",
|
|
9633
|
+
* "ordinal": 2,
|
|
9634
|
+
* "overridable": false
|
|
9635
|
+
* },
|
|
9636
|
+
* {
|
|
9637
|
+
* "id": 3,
|
|
9638
|
+
* "label": "Issue",
|
|
9639
|
+
* "ordinal": 3,
|
|
9640
|
+
* "overridable": false
|
|
9641
|
+
* },
|
|
9642
|
+
* {
|
|
9643
|
+
* "id": 4,
|
|
9644
|
+
* "label": "Incident",
|
|
9645
|
+
* "ordinal": 4,
|
|
9646
|
+
* "overridable": false
|
|
9647
|
+
* },
|
|
9648
|
+
* {
|
|
9649
|
+
* "id": 5,
|
|
9650
|
+
* "label": "Away",
|
|
9651
|
+
* "ordinal": 5,
|
|
9652
|
+
* "overridable": false
|
|
9653
|
+
* },
|
|
9654
|
+
* {
|
|
9655
|
+
* "id": 6,
|
|
9656
|
+
* "label": "Sick",
|
|
9657
|
+
* "ordinal": 6,
|
|
9658
|
+
* "overridable": false
|
|
9659
|
+
* },
|
|
9660
|
+
* {
|
|
9661
|
+
* "id": 7,
|
|
9662
|
+
* "label": "Lunch",
|
|
9663
|
+
* "ordinal": 7,
|
|
9664
|
+
* "overridable": false
|
|
9665
|
+
* },
|
|
9666
|
+
* {
|
|
9667
|
+
* "id": 8,
|
|
9668
|
+
* "label": "Travel",
|
|
9669
|
+
* "ordinal": 8,
|
|
9670
|
+
* "overridable": false
|
|
9671
|
+
* },
|
|
9672
|
+
* {
|
|
9673
|
+
* "id": 9,
|
|
9674
|
+
* "label": "Vacation",
|
|
9675
|
+
* "ordinal": 9,
|
|
9676
|
+
* "overridable": false
|
|
9677
|
+
* }
|
|
9678
|
+
* ```
|
|
9679
|
+
*/
|
|
9680
|
+
availability_modes?: number[];
|
|
9681
|
+
/** Application-defined custom fields. */
|
|
9682
|
+
custom_fields?: object;
|
|
9683
|
+
/**
|
|
9684
|
+
* Custom schemas described using identifiers. Each custom field in the
|
|
9685
|
+
* request must have the corresponding schema specified; omission results
|
|
9686
|
+
* in a Bad Request error. If a custom schema is not included in the
|
|
9687
|
+
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
9688
|
+
* it is recommended to provide tenant_fragment: true and
|
|
9689
|
+
* validate_required_fields: true.
|
|
9690
|
+
*/
|
|
9691
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
9692
|
+
/**
|
|
9693
|
+
* The updated display name of the Dev user.
|
|
9694
|
+
* @format text
|
|
9695
|
+
*/
|
|
9696
|
+
display_name?: string;
|
|
9697
|
+
/**
|
|
9698
|
+
* Start date of Dev user's experience.
|
|
9699
|
+
* @format date-time
|
|
9700
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
9701
|
+
*/
|
|
9702
|
+
experience_start_date?: string;
|
|
9703
|
+
/**
|
|
9704
|
+
* The updated full name of the Dev user.
|
|
9705
|
+
* @format text
|
|
9706
|
+
*/
|
|
9707
|
+
full_name?: string;
|
|
9708
|
+
/**
|
|
9709
|
+
* The ID for the Dev user to be updated.
|
|
7971
9710
|
* @format id
|
|
7972
9711
|
*/
|
|
7973
|
-
|
|
7974
|
-
}
|
|
7975
|
-
/** dev-users-update-job-history-item */
|
|
7976
|
-
export interface DevUsersUpdateJobHistoryItem {
|
|
7977
|
-
/**
|
|
7978
|
-
* Enum for the employment status of the user.
|
|
7979
|
-
* @format int64
|
|
7980
|
-
*/
|
|
7981
|
-
employment_status?: number;
|
|
7982
|
-
/**
|
|
7983
|
-
* End date of the job.
|
|
7984
|
-
* @format date-time
|
|
7985
|
-
* @example "2023-01-01T12:00:00.000Z"
|
|
7986
|
-
*/
|
|
7987
|
-
end_date?: string;
|
|
7988
|
-
/** Is this the current active job for the user. */
|
|
7989
|
-
is_current?: boolean;
|
|
7990
|
-
/**
|
|
7991
|
-
* The job location for the user.
|
|
7992
|
-
* @format text
|
|
7993
|
-
*/
|
|
7994
|
-
location?: string;
|
|
7995
|
-
/**
|
|
7996
|
-
* Start date of the job.
|
|
7997
|
-
* @format date-time
|
|
7998
|
-
* @example "2023-01-01T12:00:00.000Z"
|
|
7999
|
-
*/
|
|
8000
|
-
start_date?: string;
|
|
8001
|
-
/**
|
|
8002
|
-
* The job title for the user.
|
|
8003
|
-
* @format text
|
|
8004
|
-
*/
|
|
8005
|
-
title?: string;
|
|
8006
|
-
}
|
|
8007
|
-
/**
|
|
8008
|
-
* dev-users-update-request
|
|
8009
|
-
* A request to update the user's information corresponding to the
|
|
8010
|
-
* provided Dev user.
|
|
8011
|
-
*/
|
|
8012
|
-
export interface DevUsersUpdateRequest {
|
|
8013
|
-
/**
|
|
8014
|
-
* Availability modes of the Dev user. Stock allowed values:
|
|
8015
|
-
* ```
|
|
8016
|
-
* {
|
|
8017
|
-
* "id": 1,
|
|
8018
|
-
* "label": "Ticket",
|
|
8019
|
-
* "ordinal": 1,
|
|
8020
|
-
* "overridable": false
|
|
8021
|
-
* },
|
|
8022
|
-
* {
|
|
8023
|
-
* "id": 2,
|
|
8024
|
-
* "label": "Conversation",
|
|
8025
|
-
* "ordinal": 2,
|
|
8026
|
-
* "overridable": false
|
|
8027
|
-
* },
|
|
8028
|
-
* {
|
|
8029
|
-
* "id": 3,
|
|
8030
|
-
* "label": "Issue",
|
|
8031
|
-
* "ordinal": 3,
|
|
8032
|
-
* "overridable": false
|
|
8033
|
-
* },
|
|
8034
|
-
* {
|
|
8035
|
-
* "id": 4,
|
|
8036
|
-
* "label": "Incident",
|
|
8037
|
-
* "ordinal": 4,
|
|
8038
|
-
* "overridable": false
|
|
8039
|
-
* },
|
|
8040
|
-
* {
|
|
8041
|
-
* "id": 5,
|
|
8042
|
-
* "label": "Away",
|
|
8043
|
-
* "ordinal": 5,
|
|
8044
|
-
* "overridable": false
|
|
8045
|
-
* },
|
|
8046
|
-
* {
|
|
8047
|
-
* "id": 6,
|
|
8048
|
-
* "label": "Sick",
|
|
8049
|
-
* "ordinal": 6,
|
|
8050
|
-
* "overridable": false
|
|
8051
|
-
* },
|
|
8052
|
-
* {
|
|
8053
|
-
* "id": 7,
|
|
8054
|
-
* "label": "Lunch",
|
|
8055
|
-
* "ordinal": 7,
|
|
8056
|
-
* "overridable": false
|
|
8057
|
-
* },
|
|
8058
|
-
* {
|
|
8059
|
-
* "id": 8,
|
|
8060
|
-
* "label": "Travel",
|
|
8061
|
-
* "ordinal": 8,
|
|
8062
|
-
* "overridable": false
|
|
8063
|
-
* },
|
|
8064
|
-
* {
|
|
8065
|
-
* "id": 9,
|
|
8066
|
-
* "label": "Vacation",
|
|
8067
|
-
* "ordinal": 9,
|
|
8068
|
-
* "overridable": false
|
|
8069
|
-
* }
|
|
8070
|
-
* ```
|
|
8071
|
-
*/
|
|
8072
|
-
availability_modes?: number[];
|
|
8073
|
-
/** Application-defined custom fields. */
|
|
8074
|
-
custom_fields?: object;
|
|
8075
|
-
/**
|
|
8076
|
-
* Custom schemas described using identifiers. Each custom field in the
|
|
8077
|
-
* request must have the corresponding schema specified; omission results
|
|
8078
|
-
* in a Bad Request error. If a custom schema is not included in the
|
|
8079
|
-
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
8080
|
-
* it is recommended to provide tenant_fragment: true and
|
|
8081
|
-
* validate_required_fields: true.
|
|
8082
|
-
*/
|
|
8083
|
-
custom_schema_spec?: CustomSchemaSpec;
|
|
8084
|
-
/**
|
|
8085
|
-
* The updated display name of the Dev user.
|
|
8086
|
-
* @format text
|
|
8087
|
-
*/
|
|
8088
|
-
display_name?: string;
|
|
8089
|
-
/**
|
|
8090
|
-
* Start date of Dev user's experience.
|
|
8091
|
-
* @format date-time
|
|
8092
|
-
* @example "2023-01-01T12:00:00.000Z"
|
|
8093
|
-
*/
|
|
8094
|
-
experience_start_date?: string;
|
|
9712
|
+
id: string;
|
|
8095
9713
|
/**
|
|
8096
|
-
* The
|
|
9714
|
+
* The job function of the Dev user.
|
|
8097
9715
|
* @format text
|
|
8098
9716
|
*/
|
|
8099
|
-
|
|
8100
|
-
/**
|
|
8101
|
-
* The ID for the Dev user to be updated.
|
|
8102
|
-
* @format id
|
|
8103
|
-
*/
|
|
8104
|
-
id: string;
|
|
9717
|
+
job_function?: string;
|
|
8105
9718
|
/** Job history of the Dev user. */
|
|
8106
9719
|
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
8107
9720
|
/** Job title of the Dev User. */
|
|
@@ -8206,6 +9819,281 @@ export declare enum DeviceType {
|
|
|
8206
9819
|
Desktop = "desktop",
|
|
8207
9820
|
Mobile = "mobile"
|
|
8208
9821
|
}
|
|
9822
|
+
/**
|
|
9823
|
+
* devrev-expression
|
|
9824
|
+
* Defines a DevRev Query Language (DQL) expression.
|
|
9825
|
+
*/
|
|
9826
|
+
export type DevrevExpression = (DevrevQueryComparisonOperator | DevrevQueryDateTimeOperator | DevrevQueryDateTimePresetOperator | DevrevQueryExistenceOperator | DevrevQueryLogicalOperator | DevrevQueryMembershipOperator) & {
|
|
9827
|
+
op: DevrevExpressionOp;
|
|
9828
|
+
};
|
|
9829
|
+
export declare enum DevrevExpressionOp {
|
|
9830
|
+
AllOf = "all_of",
|
|
9831
|
+
And = "and",
|
|
9832
|
+
DateTime = "date_time",
|
|
9833
|
+
DateTimePreset = "date_time_preset",
|
|
9834
|
+
Empty = "empty",
|
|
9835
|
+
Eq = "eq",
|
|
9836
|
+
Gt = "gt",
|
|
9837
|
+
Gte = "gte",
|
|
9838
|
+
In = "in",
|
|
9839
|
+
Lt = "lt",
|
|
9840
|
+
Lte = "lte",
|
|
9841
|
+
Ne = "ne",
|
|
9842
|
+
NotEmpty = "not_empty",
|
|
9843
|
+
NotIn = "not_in",
|
|
9844
|
+
Or = "or"
|
|
9845
|
+
}
|
|
9846
|
+
/**
|
|
9847
|
+
* devrev-query
|
|
9848
|
+
* A unified query language for DevRev objects.
|
|
9849
|
+
*/
|
|
9850
|
+
export interface DevrevQuery {
|
|
9851
|
+
/**
|
|
9852
|
+
* Opaque cursor token that represents a position in the result set.
|
|
9853
|
+
* Use the cursor from previous responses to fetch next/previous
|
|
9854
|
+
* iteration.
|
|
9855
|
+
* @format text
|
|
9856
|
+
*/
|
|
9857
|
+
cursor?: string;
|
|
9858
|
+
expression?: DevrevQuerySearchExpression;
|
|
9859
|
+
/** Defines a DevRev Query Language (DQL) expression. */
|
|
9860
|
+
filter?: DevrevExpression;
|
|
9861
|
+
/** Grouping configuration for query results. */
|
|
9862
|
+
group_by?: DevrevQueryGroupExpression[];
|
|
9863
|
+
/**
|
|
9864
|
+
* Maximum number of items to return per iteration. If not specified,
|
|
9865
|
+
* the service will use its default limit.
|
|
9866
|
+
* @format int32
|
|
9867
|
+
*/
|
|
9868
|
+
limit?: number;
|
|
9869
|
+
/**
|
|
9870
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
9871
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
9872
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
9873
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
9874
|
+
* always be returned in the specified sort-by order.
|
|
9875
|
+
*/
|
|
9876
|
+
mode?: ListMode;
|
|
9877
|
+
/**
|
|
9878
|
+
* The search query to filter the objects.
|
|
9879
|
+
* @deprecated
|
|
9880
|
+
* @format text
|
|
9881
|
+
*/
|
|
9882
|
+
search_query?: string;
|
|
9883
|
+
/** Fields to sort the records by and the direction to sort them. */
|
|
9884
|
+
sort_by?: string[];
|
|
9885
|
+
}
|
|
9886
|
+
/**
|
|
9887
|
+
* devrev-query-comparison-operator
|
|
9888
|
+
* Comparison operator that compares a field with a value.
|
|
9889
|
+
*/
|
|
9890
|
+
export type DevrevQueryComparisonOperator = (DevrevQueryJsonValue | DevrevQueryPartValue | DevrevQuerySpaceValue | DevrevQueryTemplateValue) & {
|
|
9891
|
+
/**
|
|
9892
|
+
* The field name to apply the comparison against.
|
|
9893
|
+
* @format text
|
|
9894
|
+
*/
|
|
9895
|
+
field: string;
|
|
9896
|
+
value_type: DevrevQueryComparisonOperatorValueType;
|
|
9897
|
+
};
|
|
9898
|
+
export declare enum DevrevQueryComparisonOperatorValueType {
|
|
9899
|
+
Json = "json",
|
|
9900
|
+
Part = "part",
|
|
9901
|
+
Space = "space",
|
|
9902
|
+
Template = "template"
|
|
9903
|
+
}
|
|
9904
|
+
/** devrev-query-date-range-value */
|
|
9905
|
+
export interface DevrevQueryDateRangeValue {
|
|
9906
|
+
/**
|
|
9907
|
+
* Start of the range
|
|
9908
|
+
* @format text
|
|
9909
|
+
*/
|
|
9910
|
+
after?: string;
|
|
9911
|
+
/**
|
|
9912
|
+
* End of the range
|
|
9913
|
+
* @format text
|
|
9914
|
+
*/
|
|
9915
|
+
before?: string;
|
|
9916
|
+
}
|
|
9917
|
+
/**
|
|
9918
|
+
* devrev-query-date-time-operator
|
|
9919
|
+
* DateTime operator for relative time windows and offsets.
|
|
9920
|
+
*/
|
|
9921
|
+
export type DevrevQueryDateTimeOperator = (DateTimePresetCurrentPeriod | DateTimePresetCustomFiscalQuarter | DateTimePresetPeriodToDate | DateTimePresetRelativeFiscalQuarter | DateTimePresetRelativeFiscalYear | DevrevQueryDateRangeValue | DevrevQueryInt) & {
|
|
9922
|
+
/**
|
|
9923
|
+
* The field to evaluate against the selected DateTime operator.
|
|
9924
|
+
* @format text
|
|
9925
|
+
*/
|
|
9926
|
+
field: string;
|
|
9927
|
+
value_type: DevrevQueryDateTimeOperatorValueType;
|
|
9928
|
+
};
|
|
9929
|
+
export declare enum DevrevQueryDateTimeOperatorValueType {
|
|
9930
|
+
AfterNDays = "after_n_days",
|
|
9931
|
+
AfterNHours = "after_n_hours",
|
|
9932
|
+
BeforeNDays = "before_n_days",
|
|
9933
|
+
BeforeNHours = "before_n_hours",
|
|
9934
|
+
CurrentPeriod = "current_period",
|
|
9935
|
+
CustomFiscalQuarter = "custom_fiscal_quarter",
|
|
9936
|
+
LastNDays = "last_n_days",
|
|
9937
|
+
LastNHours = "last_n_hours",
|
|
9938
|
+
NextNDays = "next_n_days",
|
|
9939
|
+
NextNHours = "next_n_hours",
|
|
9940
|
+
PeriodToDate = "period_to_date",
|
|
9941
|
+
Range = "range",
|
|
9942
|
+
RelativeFiscalQuarter = "relative_fiscal_quarter",
|
|
9943
|
+
RelativeFiscalYear = "relative_fiscal_year"
|
|
9944
|
+
}
|
|
9945
|
+
/**
|
|
9946
|
+
* devrev-query-date-time-preset-operator
|
|
9947
|
+
* DateTimePreset operator for relative time windows and offsets.
|
|
9948
|
+
*/
|
|
9949
|
+
export type DevrevQueryDateTimePresetOperator = (DateTimePresetCurrentPeriod | DateTimePresetCustomFiscalQuarter | DateTimePresetPeriodToDate | DateTimePresetRelativeFiscalQuarter | DateTimePresetRelativeFiscalYear | DevrevQueryInt) & {
|
|
9950
|
+
/**
|
|
9951
|
+
* The field to evaluate against the selected DateTimePreset operator.
|
|
9952
|
+
* @format text
|
|
9953
|
+
*/
|
|
9954
|
+
field: string;
|
|
9955
|
+
value_type: DevrevQueryDateTimePresetOperatorValueType;
|
|
9956
|
+
};
|
|
9957
|
+
export declare enum DevrevQueryDateTimePresetOperatorValueType {
|
|
9958
|
+
AfterNDays = "after_n_days",
|
|
9959
|
+
AfterNHours = "after_n_hours",
|
|
9960
|
+
BeforeNDays = "before_n_days",
|
|
9961
|
+
BeforeNHours = "before_n_hours",
|
|
9962
|
+
CurrentPeriod = "current_period",
|
|
9963
|
+
CustomFiscalQuarter = "custom_fiscal_quarter",
|
|
9964
|
+
LastNDays = "last_n_days",
|
|
9965
|
+
LastNHours = "last_n_hours",
|
|
9966
|
+
NextNDays = "next_n_days",
|
|
9967
|
+
NextNHours = "next_n_hours",
|
|
9968
|
+
PeriodToDate = "period_to_date",
|
|
9969
|
+
RelativeFiscalQuarter = "relative_fiscal_quarter",
|
|
9970
|
+
RelativeFiscalYear = "relative_fiscal_year"
|
|
9971
|
+
}
|
|
9972
|
+
/**
|
|
9973
|
+
* devrev-query-existence-operator
|
|
9974
|
+
* Existence operator that checks if a field is empty or not.
|
|
9975
|
+
*/
|
|
9976
|
+
export interface DevrevQueryExistenceOperator {
|
|
9977
|
+
/**
|
|
9978
|
+
* The field to evaluate against the existence operator.
|
|
9979
|
+
* @format text
|
|
9980
|
+
*/
|
|
9981
|
+
field: string;
|
|
9982
|
+
}
|
|
9983
|
+
/** devrev-query-group-expression */
|
|
9984
|
+
export interface DevrevQueryGroupExpression {
|
|
9985
|
+
/**
|
|
9986
|
+
* Field name to group results by.
|
|
9987
|
+
* @format text
|
|
9988
|
+
*/
|
|
9989
|
+
field: string;
|
|
9990
|
+
/** Ordering of group keys. */
|
|
9991
|
+
order?: DevrevQueryGroupExpressionOrder;
|
|
9992
|
+
/** Sort direction for group keys. */
|
|
9993
|
+
sort_direction?: DevrevQueryGroupExpressionSortDirection;
|
|
9994
|
+
}
|
|
9995
|
+
/** Ordering of group keys. */
|
|
9996
|
+
export declare enum DevrevQueryGroupExpressionOrder {
|
|
9997
|
+
Count = "count",
|
|
9998
|
+
Lexical = "lexical",
|
|
9999
|
+
Ordinal = "ordinal"
|
|
10000
|
+
}
|
|
10001
|
+
/** Sort direction for group keys. */
|
|
10002
|
+
export declare enum DevrevQueryGroupExpressionSortDirection {
|
|
10003
|
+
Asc = "asc",
|
|
10004
|
+
Desc = "desc"
|
|
10005
|
+
}
|
|
10006
|
+
/**
|
|
10007
|
+
* devrev-query-int
|
|
10008
|
+
* Represents a value of int type.
|
|
10009
|
+
*/
|
|
10010
|
+
export interface DevrevQueryInt {
|
|
10011
|
+
/**
|
|
10012
|
+
* The int32 value.
|
|
10013
|
+
* @format int32
|
|
10014
|
+
*/
|
|
10015
|
+
value: number;
|
|
10016
|
+
}
|
|
10017
|
+
/**
|
|
10018
|
+
* devrev-query-json-value
|
|
10019
|
+
* Represents a value of any JSON type.
|
|
10020
|
+
*/
|
|
10021
|
+
export interface DevrevQueryJsonValue {
|
|
10022
|
+
/** The JSON value. */
|
|
10023
|
+
value: any;
|
|
10024
|
+
}
|
|
10025
|
+
/**
|
|
10026
|
+
* devrev-query-logical-operator
|
|
10027
|
+
* Logical operator that combines multiple expressions using AND or OR
|
|
10028
|
+
* logic.
|
|
10029
|
+
*/
|
|
10030
|
+
export interface DevrevQueryLogicalOperator {
|
|
10031
|
+
/** List of expressions to be combined with the logical operator. */
|
|
10032
|
+
operands: DevrevExpression[];
|
|
10033
|
+
}
|
|
10034
|
+
/**
|
|
10035
|
+
* devrev-query-membership-operator
|
|
10036
|
+
* Membership operator that checks if a field is in a list of values.
|
|
10037
|
+
*/
|
|
10038
|
+
export type DevrevQueryMembershipOperator = (DevrevQueryJsonValue | DevrevQueryPartValue | DevrevQuerySpaceValue | DevrevQueryTemplateValue) & {
|
|
10039
|
+
/**
|
|
10040
|
+
* The field to evaluate against the membership operator.
|
|
10041
|
+
* @format text
|
|
10042
|
+
*/
|
|
10043
|
+
field: string;
|
|
10044
|
+
value_type: DevrevQueryMembershipOperatorValueType;
|
|
10045
|
+
};
|
|
10046
|
+
export declare enum DevrevQueryMembershipOperatorValueType {
|
|
10047
|
+
Json = "json",
|
|
10048
|
+
Part = "part",
|
|
10049
|
+
Space = "space",
|
|
10050
|
+
Template = "template"
|
|
10051
|
+
}
|
|
10052
|
+
/** devrev-query-part-value */
|
|
10053
|
+
export interface DevrevQueryPartValue {
|
|
10054
|
+
/** Whether to include child parts in the query. */
|
|
10055
|
+
include_child_parts?: boolean;
|
|
10056
|
+
/**
|
|
10057
|
+
* List of part identifiers as DONs.
|
|
10058
|
+
* @example ["PROD-12345"]
|
|
10059
|
+
*/
|
|
10060
|
+
value: string[];
|
|
10061
|
+
}
|
|
10062
|
+
/** devrev-query-search-expression */
|
|
10063
|
+
export interface DevrevQuerySearchExpression {
|
|
10064
|
+
/**
|
|
10065
|
+
* The search query to filter the objects.
|
|
10066
|
+
* @format text
|
|
10067
|
+
*/
|
|
10068
|
+
query: string;
|
|
10069
|
+
/** Fields on which the search query will be scoped on. */
|
|
10070
|
+
scope?: string[];
|
|
10071
|
+
}
|
|
10072
|
+
/** devrev-query-space-value */
|
|
10073
|
+
export interface DevrevQuerySpaceValue {
|
|
10074
|
+
/** Whether to include child spaces in the query. */
|
|
10075
|
+
include_child_spaces?: boolean;
|
|
10076
|
+
/** Whether to include parent spaces in the query. */
|
|
10077
|
+
include_parent_spaces?: boolean;
|
|
10078
|
+
/** List of space identifiers as DONs. */
|
|
10079
|
+
value: string[];
|
|
10080
|
+
}
|
|
10081
|
+
/**
|
|
10082
|
+
* devrev-query-template-value
|
|
10083
|
+
* Runtime-resolved variable placeholder for DQL queries.
|
|
10084
|
+
*/
|
|
10085
|
+
export type DevrevQueryTemplateValue = DevrevQueryTemplateValueMe & {
|
|
10086
|
+
value: DevrevQueryTemplateValueValue;
|
|
10087
|
+
};
|
|
10088
|
+
/**
|
|
10089
|
+
* devrev-query-template-value-me
|
|
10090
|
+
* Resolves to the identity of the currently authenticated user at query
|
|
10091
|
+
* execution time.
|
|
10092
|
+
*/
|
|
10093
|
+
export type DevrevQueryTemplateValueMe = object;
|
|
10094
|
+
export declare enum DevrevQueryTemplateValueValue {
|
|
10095
|
+
Me = "me"
|
|
10096
|
+
}
|
|
8209
10097
|
/** directories-count-request */
|
|
8210
10098
|
export interface DirectoriesCountRequest {
|
|
8211
10099
|
/**
|
|
@@ -9536,6 +11424,13 @@ export declare enum ErrorBadRequestUnexpectedJsonTypeType {
|
|
|
9536
11424
|
}
|
|
9537
11425
|
/** error-bad-request-value-not-permitted */
|
|
9538
11426
|
export interface ErrorBadRequestValueNotPermitted {
|
|
11427
|
+
/**
|
|
11428
|
+
* The actual value that was provided.
|
|
11429
|
+
* @format text
|
|
11430
|
+
*/
|
|
11431
|
+
actual_value?: string;
|
|
11432
|
+
/** The allowed object types for ID fields. */
|
|
11433
|
+
allowed_object_types?: string[];
|
|
9539
11434
|
/** The allowed values for the field. */
|
|
9540
11435
|
allowed_values?: string[];
|
|
9541
11436
|
/**
|
|
@@ -9543,6 +11438,16 @@ export interface ErrorBadRequestValueNotPermitted {
|
|
|
9543
11438
|
* @format text
|
|
9544
11439
|
*/
|
|
9545
11440
|
field_name: string;
|
|
11441
|
+
/**
|
|
11442
|
+
* The maximum allowed value or length.
|
|
11443
|
+
* @format text
|
|
11444
|
+
*/
|
|
11445
|
+
max_value?: string;
|
|
11446
|
+
/**
|
|
11447
|
+
* The minimum allowed value or length.
|
|
11448
|
+
* @format text
|
|
11449
|
+
*/
|
|
11450
|
+
min_value?: string;
|
|
9546
11451
|
/**
|
|
9547
11452
|
* The pattern the value must match.
|
|
9548
11453
|
* @format text
|
|
@@ -10465,6 +12370,14 @@ export declare enum ExportAuditLogsRequestOperationType {
|
|
|
10465
12370
|
* process is asynchronous. Upon completion, the user will be notified.
|
|
10466
12371
|
*/
|
|
10467
12372
|
export type ExportAuditLogsResponse = object;
|
|
12373
|
+
export declare enum ExportCompression {
|
|
12374
|
+
Gzip = "gzip",
|
|
12375
|
+
None = "none"
|
|
12376
|
+
}
|
|
12377
|
+
export declare enum ExportFormatValue {
|
|
12378
|
+
Csv = "csv",
|
|
12379
|
+
Json = "json"
|
|
12380
|
+
}
|
|
10468
12381
|
/** external-communication-channel-summary */
|
|
10469
12382
|
export type ExternalCommunicationChannelSummary = AtomBaseSummary;
|
|
10470
12383
|
/**
|
|
@@ -10909,6 +12822,13 @@ export interface FlameGraphWidgetVisualization {
|
|
|
10909
12822
|
/** The configuration for the Y-axes. */
|
|
10910
12823
|
y: FlameGraphVisualizationYAxis[];
|
|
10911
12824
|
}
|
|
12825
|
+
/** The time scale for the gantt visualization. */
|
|
12826
|
+
export declare enum GanttWidgetVisualizationTimeScale {
|
|
12827
|
+
Day = "day",
|
|
12828
|
+
Month = "month",
|
|
12829
|
+
Week = "week",
|
|
12830
|
+
Year = "year"
|
|
12831
|
+
}
|
|
10912
12832
|
/**
|
|
10913
12833
|
* general-preferences-group
|
|
10914
12834
|
* Preferences group for General settings.
|
|
@@ -11302,22 +13222,6 @@ export interface GroupsCreateRequest {
|
|
|
11302
13222
|
export interface GroupsCreateResponse {
|
|
11303
13223
|
group: Group;
|
|
11304
13224
|
}
|
|
11305
|
-
/**
|
|
11306
|
-
* groups-delete-request
|
|
11307
|
-
* A request to delete a group.
|
|
11308
|
-
*/
|
|
11309
|
-
export interface GroupsDeleteRequest {
|
|
11310
|
-
/**
|
|
11311
|
-
* The ID of the group to delete.
|
|
11312
|
-
* @format id
|
|
11313
|
-
*/
|
|
11314
|
-
id: string;
|
|
11315
|
-
}
|
|
11316
|
-
/**
|
|
11317
|
-
* groups-delete-response
|
|
11318
|
-
* The response to deleting a group.
|
|
11319
|
-
*/
|
|
11320
|
-
export type GroupsDeleteResponse = object;
|
|
11321
13225
|
/**
|
|
11322
13226
|
* groups-get-request
|
|
11323
13227
|
* A request to get information about a group.
|
|
@@ -12134,6 +14038,11 @@ export type Issue = WorkBase & {
|
|
|
12134
14038
|
actual_start_date?: string;
|
|
12135
14039
|
/** Parts associated based on git events. */
|
|
12136
14040
|
developed_with?: PartSummary[];
|
|
14041
|
+
/**
|
|
14042
|
+
* The space scoped display ID alias of the issue.
|
|
14043
|
+
* @format text
|
|
14044
|
+
*/
|
|
14045
|
+
display_id_alias?: string;
|
|
12137
14046
|
/**
|
|
12138
14047
|
* Estimated effort to complete the issue.
|
|
12139
14048
|
* @format double
|
|
@@ -12177,6 +14086,11 @@ export declare enum IssuePriority {
|
|
|
12177
14086
|
}
|
|
12178
14087
|
/** issue-summary */
|
|
12179
14088
|
export type IssueSummary = WorkBaseSummary & {
|
|
14089
|
+
/**
|
|
14090
|
+
* The space scoped display ID alias of the issue.
|
|
14091
|
+
* @format text
|
|
14092
|
+
*/
|
|
14093
|
+
display_id_alias?: string;
|
|
12180
14094
|
/** Priority of the work based upon impact and criticality. */
|
|
12181
14095
|
priority?: IssuePriority;
|
|
12182
14096
|
/** The properties of an enum value. */
|
|
@@ -12242,6 +14156,7 @@ export declare enum JobCategory {
|
|
|
12242
14156
|
MergeRevorg = "merge_revorg",
|
|
12243
14157
|
MergeRevuser = "merge_revuser",
|
|
12244
14158
|
MergeTicket = "merge_ticket",
|
|
14159
|
+
MigrateVistaReports = "migrate_vista_reports",
|
|
12245
14160
|
MoveRevorg = "move_revorg",
|
|
12246
14161
|
MoveRevuser = "move_revuser",
|
|
12247
14162
|
OasisDataExport = "oasis_data_export",
|
|
@@ -12287,6 +14202,8 @@ export declare enum JobState {
|
|
|
12287
14202
|
Queued = "queued",
|
|
12288
14203
|
Started = "started"
|
|
12289
14204
|
}
|
|
14205
|
+
/** job-summary */
|
|
14206
|
+
export type JobSummary = AtomBaseSummary;
|
|
12290
14207
|
/**
|
|
12291
14208
|
* jobs-get-request
|
|
12292
14209
|
* Request object to get a job's information.
|
|
@@ -12526,6 +14443,12 @@ export interface LineVisualizationYAxis {
|
|
|
12526
14443
|
*/
|
|
12527
14444
|
reference_name: string;
|
|
12528
14445
|
}
|
|
14446
|
+
/** The stroke style for the line. */
|
|
14447
|
+
export declare enum LineVisualizationYAxisStrokeStyle {
|
|
14448
|
+
Dashed = "dashed",
|
|
14449
|
+
Dotted = "dotted",
|
|
14450
|
+
Solid = "solid"
|
|
14451
|
+
}
|
|
12529
14452
|
/**
|
|
12530
14453
|
* line-widget-visualization
|
|
12531
14454
|
* A line chart visualization configuration. Includes metadata specific to
|
|
@@ -13096,6 +15019,14 @@ export type MarketplaceItemSummary = AtomBaseSummary & {
|
|
|
13096
15019
|
* (e.g. Jira AirSync).
|
|
13097
15020
|
*/
|
|
13098
15021
|
item_type?: MarketplaceItemItemType;
|
|
15022
|
+
/**
|
|
15023
|
+
* Meta score of the marketplace items. Its value must be in range
|
|
15024
|
+
* from 1 to 100000. It is used for ranking marketplace items on the
|
|
15025
|
+
* Marketplace home page. Items with higher meta_score will be placed
|
|
15026
|
+
* on the top of the list.
|
|
15027
|
+
* @format int64
|
|
15028
|
+
*/
|
|
15029
|
+
meta_score?: number;
|
|
13099
15030
|
/**
|
|
13100
15031
|
* Name of the marketplace listing. The value for a name can be any
|
|
13101
15032
|
* string with a minimum length of 3 and a maximum length of 128.
|
|
@@ -13136,7 +15067,9 @@ export interface MarketplaceItemsInstallResponse {
|
|
|
13136
15067
|
}
|
|
13137
15068
|
/**
|
|
13138
15069
|
* meerkat-widget-column-function
|
|
13139
|
-
*
|
|
15070
|
+
* Deprecated: Use widget_query_column_config with type=function on
|
|
15071
|
+
* widget_query.measure_configs or dimension_configs instead. A meerkat
|
|
15072
|
+
* specific column function.
|
|
13140
15073
|
*/
|
|
13141
15074
|
export interface MeerkatWidgetColumnFunction {
|
|
13142
15075
|
/** The type of the function. */
|
|
@@ -13163,7 +15096,11 @@ export declare enum MeerkatWidgetColumnFunctionType {
|
|
|
13163
15096
|
export interface MeerkatWidgetColumnProjection {
|
|
13164
15097
|
/** The data type of the column generated by the SQL expression. */
|
|
13165
15098
|
type: MeerkatWidgetColumnProjectionType;
|
|
13166
|
-
/**
|
|
15099
|
+
/**
|
|
15100
|
+
* Deprecated: Use widget_query_column_config with type=function on
|
|
15101
|
+
* widget_query.measure_configs or dimension_configs instead. A meerkat
|
|
15102
|
+
* specific column function.
|
|
15103
|
+
*/
|
|
13167
15104
|
function?: MeerkatWidgetColumnFunction;
|
|
13168
15105
|
/**
|
|
13169
15106
|
* The SQL expression used to extract or transform the column from the
|
|
@@ -13171,10 +15108,18 @@ export interface MeerkatWidgetColumnProjection {
|
|
|
13171
15108
|
* @format text
|
|
13172
15109
|
*/
|
|
13173
15110
|
sql_expression: string;
|
|
13174
|
-
/**
|
|
15111
|
+
/**
|
|
15112
|
+
* Deprecated: Use widget_query_column_config with type=timestamp on
|
|
15113
|
+
* widget_query.dimension_configs instead. The rollup granularity for the
|
|
15114
|
+
* timestamp.
|
|
15115
|
+
*/
|
|
13175
15116
|
timestamp_rollup?: MeerkatWidgetColumnProjectionTimestampRollup;
|
|
13176
15117
|
}
|
|
13177
|
-
/**
|
|
15118
|
+
/**
|
|
15119
|
+
* Deprecated: Use widget_query_column_config with type=timestamp on
|
|
15120
|
+
* widget_query.dimension_configs instead. The rollup granularity for the
|
|
15121
|
+
* timestamp.
|
|
15122
|
+
*/
|
|
13178
15123
|
export declare enum MeerkatWidgetColumnProjectionTimestampRollup {
|
|
13179
15124
|
Day = "day",
|
|
13180
15125
|
Hour = "hour",
|
|
@@ -13235,7 +15180,7 @@ export type Meeting = AtomBase & {
|
|
|
13235
15180
|
*/
|
|
13236
15181
|
external_url?: string;
|
|
13237
15182
|
/** The members in the meeting. */
|
|
13238
|
-
members
|
|
15183
|
+
members?: AtomSummary[];
|
|
13239
15184
|
organizer?: AtomSummary;
|
|
13240
15185
|
parent?: AtomSummary;
|
|
13241
15186
|
recording?: ArtifactSummary;
|
|
@@ -13423,7 +15368,7 @@ export interface MeetingsCreateRequest {
|
|
|
13423
15368
|
external_url?: string;
|
|
13424
15369
|
/**
|
|
13425
15370
|
* IDs of the users or groups that were part of the meeting.
|
|
13426
|
-
* @maxItems
|
|
15371
|
+
* @maxItems 2000
|
|
13427
15372
|
* @minItems 1
|
|
13428
15373
|
* @example ["DEVU-12345"]
|
|
13429
15374
|
*/
|
|
@@ -13495,6 +15440,76 @@ export interface MeetingsDeleteRequest {
|
|
|
13495
15440
|
}
|
|
13496
15441
|
/** meetings-delete-response */
|
|
13497
15442
|
export type MeetingsDeleteResponse = object;
|
|
15443
|
+
/**
|
|
15444
|
+
* meetings-export-async-request
|
|
15445
|
+
* Request object to start an asynchronous meeting export.
|
|
15446
|
+
*/
|
|
15447
|
+
export interface MeetingsExportAsyncRequest {
|
|
15448
|
+
/** Filters for meeting on specified channels. */
|
|
15449
|
+
channel?: MeetingChannel[];
|
|
15450
|
+
/**
|
|
15451
|
+
* The columns to include in the export along with their names in the
|
|
15452
|
+
* export file, e.g., "title=Title". If the list of columns is empty,
|
|
15453
|
+
* all the fields will be exported.
|
|
15454
|
+
*/
|
|
15455
|
+
columns?: string[];
|
|
15456
|
+
compression?: ExportCompression;
|
|
15457
|
+
/** Filters for meetings created by the specified user(s). */
|
|
15458
|
+
created_by?: string[];
|
|
15459
|
+
/** Provides ways to specify date ranges on objects. */
|
|
15460
|
+
created_date?: DateFilter;
|
|
15461
|
+
/** Filters for meeting on custom fields. */
|
|
15462
|
+
custom_fields?: object;
|
|
15463
|
+
/** Direction of the meetings to be fetched. */
|
|
15464
|
+
direction?: MeetingDirection[];
|
|
15465
|
+
/** Provides ways to specify date ranges on objects. */
|
|
15466
|
+
ended_date?: DateFilter;
|
|
15467
|
+
/** Filters for meetings with the provided external_ref(s). */
|
|
15468
|
+
external_ref?: string[];
|
|
15469
|
+
/**
|
|
15470
|
+
* The name of the file user wants to give to the exported file. If
|
|
15471
|
+
* not set, the file name will be the default name. If the file name
|
|
15472
|
+
* exceeds 128 bytes after sanitization, it will be truncated to 128
|
|
15473
|
+
* bytes.
|
|
15474
|
+
* @format text
|
|
15475
|
+
*/
|
|
15476
|
+
file_name?: string;
|
|
15477
|
+
format?: ExportFormatValue;
|
|
15478
|
+
/** Filters for links associated with the meeting. */
|
|
15479
|
+
links?: MeetingsFilterLinkSummaryFilter[];
|
|
15480
|
+
/** Filter for meeting on specified Member Ids. */
|
|
15481
|
+
members?: string[];
|
|
15482
|
+
/** Provides ways to specify date ranges on objects. */
|
|
15483
|
+
modified_date?: DateFilter;
|
|
15484
|
+
/** Filter for meeting on specified organizers. */
|
|
15485
|
+
organizer?: string[];
|
|
15486
|
+
/**
|
|
15487
|
+
* Filters for meetings with the provided parent.
|
|
15488
|
+
* @deprecated
|
|
15489
|
+
* @example ["ACC-12345"]
|
|
15490
|
+
*/
|
|
15491
|
+
parent?: string[];
|
|
15492
|
+
/** Provides ways to specify date ranges on objects. */
|
|
15493
|
+
scheduled_date?: DateFilter;
|
|
15494
|
+
/** Filters for meeting on specified state or outcomes. */
|
|
15495
|
+
state?: MeetingState[];
|
|
15496
|
+
/** Subtypes of meeting to be filtered. */
|
|
15497
|
+
subtype?: string[];
|
|
15498
|
+
sync_metadata?: SyncMetadataFilter;
|
|
15499
|
+
/** Filters for meeting by tags. */
|
|
15500
|
+
tags?: string[];
|
|
15501
|
+
}
|
|
15502
|
+
/**
|
|
15503
|
+
* meetings-export-async-response
|
|
15504
|
+
* The response of starting an asynchronous meeting export.
|
|
15505
|
+
*/
|
|
15506
|
+
export interface MeetingsExportAsyncResponse {
|
|
15507
|
+
/**
|
|
15508
|
+
* The ID of the export meeting job.
|
|
15509
|
+
* @format id
|
|
15510
|
+
*/
|
|
15511
|
+
id?: string;
|
|
15512
|
+
}
|
|
13498
15513
|
/**
|
|
13499
15514
|
* meetings-filter-link-summary-filter
|
|
13500
15515
|
* The filter for the link summary.
|
|
@@ -13852,7 +15867,6 @@ export declare enum MethodOptionsTagValue {
|
|
|
13852
15867
|
SnapIns = "snap_ins",
|
|
13853
15868
|
SnapKitExecution = "snap_kit_execution",
|
|
13854
15869
|
SnapWidgets = "snap_widgets",
|
|
13855
|
-
Spaces = "spaces",
|
|
13856
15870
|
Subscribers = "subscribers",
|
|
13857
15871
|
Surveys = "surveys",
|
|
13858
15872
|
SysUsers = "sys_users",
|
|
@@ -14582,6 +16596,16 @@ export interface Money {
|
|
|
14582
16596
|
*/
|
|
14583
16597
|
currency?: string;
|
|
14584
16598
|
}
|
|
16599
|
+
/** network-log */
|
|
16600
|
+
export interface NetworkLog {
|
|
16601
|
+
/**
|
|
16602
|
+
* Type of the network log.
|
|
16603
|
+
* @format text
|
|
16604
|
+
*/
|
|
16605
|
+
type: string;
|
|
16606
|
+
request: ObservabilityNetworkRequest;
|
|
16607
|
+
response: ObservabilityNetworkResponse;
|
|
16608
|
+
}
|
|
14585
16609
|
/** notification-content-template */
|
|
14586
16610
|
export type NotificationContentTemplate = ContentTemplateBase;
|
|
14587
16611
|
/** notification-content-template-summary */
|
|
@@ -14619,6 +16643,92 @@ export type ObjectMemberSummary = AtomBaseSummary & {
|
|
|
14619
16643
|
/** Sync information for records synced into/from DevRev. */
|
|
14620
16644
|
sync_metadata?: SyncMetadataSummary;
|
|
14621
16645
|
};
|
|
16646
|
+
/**
|
|
16647
|
+
* objects-list-request
|
|
16648
|
+
* Request for objects list.
|
|
16649
|
+
*/
|
|
16650
|
+
export interface ObjectsListRequest {
|
|
16651
|
+
/** A unified query language for DevRev objects. */
|
|
16652
|
+
dql_query?: DevrevQuery;
|
|
16653
|
+
}
|
|
16654
|
+
/**
|
|
16655
|
+
* objects-list-response
|
|
16656
|
+
* Response for objects list.
|
|
16657
|
+
*/
|
|
16658
|
+
export type ObjectsListResponse = (ObjectsListResponseArticlesList | ObjectsListResponseCustomObjectsList | ObjectsListResponseEnhancementsList | ObjectsListResponseIssuesList) & {
|
|
16659
|
+
type: ObjectsListResponseType;
|
|
16660
|
+
/**
|
|
16661
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
16662
|
+
* sort order. If not set, then no later elements exist.
|
|
16663
|
+
* @format text
|
|
16664
|
+
*/
|
|
16665
|
+
next_cursor?: string;
|
|
16666
|
+
/**
|
|
16667
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
16668
|
+
* sort order. If not set, then no prior elements exist.
|
|
16669
|
+
* @format text
|
|
16670
|
+
*/
|
|
16671
|
+
prev_cursor?: string;
|
|
16672
|
+
};
|
|
16673
|
+
/** objects-list-response-articles-list */
|
|
16674
|
+
export interface ObjectsListResponseArticlesList {
|
|
16675
|
+
/** The list of articles. */
|
|
16676
|
+
articles: Article[];
|
|
16677
|
+
}
|
|
16678
|
+
/** objects-list-response-custom-objects-list */
|
|
16679
|
+
export interface ObjectsListResponseCustomObjectsList {
|
|
16680
|
+
/** The list of custom objects. */
|
|
16681
|
+
custom_objects: CustomObject[];
|
|
16682
|
+
}
|
|
16683
|
+
/** objects-list-response-enhancements-list */
|
|
16684
|
+
export interface ObjectsListResponseEnhancementsList {
|
|
16685
|
+
/** The list of enhancements. */
|
|
16686
|
+
enhancements: Enhancement[];
|
|
16687
|
+
}
|
|
16688
|
+
/** objects-list-response-issues-list */
|
|
16689
|
+
export interface ObjectsListResponseIssuesList {
|
|
16690
|
+
/** The list of issues. */
|
|
16691
|
+
issues: Work[];
|
|
16692
|
+
}
|
|
16693
|
+
export declare enum ObjectsListResponseType {
|
|
16694
|
+
Articles = "articles",
|
|
16695
|
+
CustomObjects = "custom_objects",
|
|
16696
|
+
Enhancements = "enhancements",
|
|
16697
|
+
Issues = "issues"
|
|
16698
|
+
}
|
|
16699
|
+
/** observability-network-request */
|
|
16700
|
+
export interface ObservabilityNetworkRequest {
|
|
16701
|
+
/**
|
|
16702
|
+
* HTTP method of the request.
|
|
16703
|
+
* @format text
|
|
16704
|
+
*/
|
|
16705
|
+
method: string;
|
|
16706
|
+
/**
|
|
16707
|
+
* Start time of the request.
|
|
16708
|
+
* @format date-time
|
|
16709
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
16710
|
+
*/
|
|
16711
|
+
start_time: string;
|
|
16712
|
+
/**
|
|
16713
|
+
* URL of the network request.
|
|
16714
|
+
* @format text
|
|
16715
|
+
*/
|
|
16716
|
+
url: string;
|
|
16717
|
+
}
|
|
16718
|
+
/** observability-network-response */
|
|
16719
|
+
export interface ObservabilityNetworkResponse {
|
|
16720
|
+
/**
|
|
16721
|
+
* End time of the response.
|
|
16722
|
+
* @format date-time
|
|
16723
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
16724
|
+
*/
|
|
16725
|
+
end_time: string;
|
|
16726
|
+
/**
|
|
16727
|
+
* HTTP status code of the response.
|
|
16728
|
+
* @format int32
|
|
16729
|
+
*/
|
|
16730
|
+
status: number;
|
|
16731
|
+
}
|
|
14622
16732
|
/** observability-session */
|
|
14623
16733
|
export type ObservabilitySession = (UtilRequiredKeys<MobileSession, 'session_id'> | UtilRequiredKeys<WebSession, 'session_id'>) & {
|
|
14624
16734
|
type: ObservabilitySessionType;
|
|
@@ -14634,6 +16744,214 @@ export declare enum ObservabilitySessionType {
|
|
|
14634
16744
|
Mobile = "mobile",
|
|
14635
16745
|
Web = "web"
|
|
14636
16746
|
}
|
|
16747
|
+
/** observability-sessions-aggregate-request */
|
|
16748
|
+
export type ObservabilitySessionsAggregateRequest = (MobileSessionsFilter | WebSessionsFilter) & {
|
|
16749
|
+
type: ObservabilitySessionsAggregateRequestType;
|
|
16750
|
+
/**
|
|
16751
|
+
* List of aggregation configurations. Each aggregation has a key
|
|
16752
|
+
* field for identification.
|
|
16753
|
+
*/
|
|
16754
|
+
aggregations?: ObservabilitySessionsAggregateRequestAggregationConfig[];
|
|
16755
|
+
/** To filter indexes by partition fields. */
|
|
16756
|
+
partition_filters?: Record<string, string>;
|
|
16757
|
+
schema_type: ObservabilitySessionsAggregateRequestSchemaType;
|
|
16758
|
+
/** Provides ways to specify date ranges on objects. */
|
|
16759
|
+
time_range: DateFilter;
|
|
16760
|
+
/**
|
|
16761
|
+
* The unique app ID to which the session belongs.
|
|
16762
|
+
* @format text
|
|
16763
|
+
* @minLength 1
|
|
16764
|
+
*/
|
|
16765
|
+
version_key: string;
|
|
16766
|
+
};
|
|
16767
|
+
/** observability-sessions-aggregate-request-aggregation-config */
|
|
16768
|
+
export type ObservabilitySessionsAggregateRequestAggregationConfig = (ObservabilitySessionsAggregateRequestAvgAggregation | ObservabilitySessionsAggregateRequestCountAggregation | ObservabilitySessionsAggregateRequestDateHistogramAggregation | ObservabilitySessionsAggregateRequestMaxAggregation | ObservabilitySessionsAggregateRequestMinAggregation | ObservabilitySessionsAggregateRequestPercentilesAggregation | ObservabilitySessionsAggregateRequestSumAggregation | ObservabilitySessionsAggregateRequestTermsAggregation) & {
|
|
16769
|
+
type: ObservabilitySessionsAggregateRequestAggregationConfigType;
|
|
16770
|
+
/**
|
|
16771
|
+
* Unique identifier for this aggregation.
|
|
16772
|
+
* @format text
|
|
16773
|
+
*/
|
|
16774
|
+
key: string;
|
|
16775
|
+
/** Nested aggregations to perform within each bucket. */
|
|
16776
|
+
sub_aggregations?: ObservabilitySessionsAggregateRequestAggregationConfig[];
|
|
16777
|
+
};
|
|
16778
|
+
export declare enum ObservabilitySessionsAggregateRequestAggregationConfigType {
|
|
16779
|
+
Avg = "avg",
|
|
16780
|
+
Count = "count",
|
|
16781
|
+
DateHistogram = "date_histogram",
|
|
16782
|
+
Max = "max",
|
|
16783
|
+
Min = "min",
|
|
16784
|
+
Percentiles = "percentiles",
|
|
16785
|
+
Sum = "sum",
|
|
16786
|
+
Terms = "terms"
|
|
16787
|
+
}
|
|
16788
|
+
/** observability-sessions-aggregate-request-avg-aggregation */
|
|
16789
|
+
export interface ObservabilitySessionsAggregateRequestAvgAggregation {
|
|
16790
|
+
/**
|
|
16791
|
+
* Field to compute the average on.
|
|
16792
|
+
* @format text
|
|
16793
|
+
*/
|
|
16794
|
+
field: string;
|
|
16795
|
+
}
|
|
16796
|
+
/** observability-sessions-aggregate-request-count-aggregation */
|
|
16797
|
+
export interface ObservabilitySessionsAggregateRequestCountAggregation {
|
|
16798
|
+
/**
|
|
16799
|
+
* Field to count.
|
|
16800
|
+
* @format text
|
|
16801
|
+
*/
|
|
16802
|
+
field: string;
|
|
16803
|
+
}
|
|
16804
|
+
/** observability-sessions-aggregate-request-date-histogram-aggregation */
|
|
16805
|
+
export interface ObservabilitySessionsAggregateRequestDateHistogramAggregation {
|
|
16806
|
+
/**
|
|
16807
|
+
* Date field to aggregate on.
|
|
16808
|
+
* @format text
|
|
16809
|
+
*/
|
|
16810
|
+
field: string;
|
|
16811
|
+
/**
|
|
16812
|
+
* Time interval in milliseconds for histogram buckets.
|
|
16813
|
+
* @format int64
|
|
16814
|
+
*/
|
|
16815
|
+
interval_ms: number;
|
|
16816
|
+
}
|
|
16817
|
+
/** observability-sessions-aggregate-request-max-aggregation */
|
|
16818
|
+
export interface ObservabilitySessionsAggregateRequestMaxAggregation {
|
|
16819
|
+
/**
|
|
16820
|
+
* Field to compute the maximum on.
|
|
16821
|
+
* @format text
|
|
16822
|
+
*/
|
|
16823
|
+
field: string;
|
|
16824
|
+
}
|
|
16825
|
+
/** observability-sessions-aggregate-request-min-aggregation */
|
|
16826
|
+
export interface ObservabilitySessionsAggregateRequestMinAggregation {
|
|
16827
|
+
/**
|
|
16828
|
+
* Field to compute the minimum on.
|
|
16829
|
+
* @format text
|
|
16830
|
+
*/
|
|
16831
|
+
field: string;
|
|
16832
|
+
}
|
|
16833
|
+
/** observability-sessions-aggregate-request-percentiles-aggregation */
|
|
16834
|
+
export interface ObservabilitySessionsAggregateRequestPercentilesAggregation {
|
|
16835
|
+
/**
|
|
16836
|
+
* Field to compute percentiles on.
|
|
16837
|
+
* @format text
|
|
16838
|
+
*/
|
|
16839
|
+
field: string;
|
|
16840
|
+
/**
|
|
16841
|
+
* Percentile values to compute (e.g., [50.0, 90.0, 95.0, 99.0]).
|
|
16842
|
+
* @min 0
|
|
16843
|
+
* @max 100
|
|
16844
|
+
*/
|
|
16845
|
+
percents?: number[];
|
|
16846
|
+
}
|
|
16847
|
+
export declare enum ObservabilitySessionsAggregateRequestSchemaType {
|
|
16848
|
+
MobileCustomEvents = "mobile_custom_events",
|
|
16849
|
+
MobileNetwork = "mobile_network",
|
|
16850
|
+
WebConsole = "web_console",
|
|
16851
|
+
WebCustomEvents = "web_custom_events",
|
|
16852
|
+
WebEvent = "web_event",
|
|
16853
|
+
WebNetwork = "web_network"
|
|
16854
|
+
}
|
|
16855
|
+
/** observability-sessions-aggregate-request-sum-aggregation */
|
|
16856
|
+
export interface ObservabilitySessionsAggregateRequestSumAggregation {
|
|
16857
|
+
/**
|
|
16858
|
+
* Field to compute the sum on.
|
|
16859
|
+
* @format text
|
|
16860
|
+
*/
|
|
16861
|
+
field: string;
|
|
16862
|
+
}
|
|
16863
|
+
/** observability-sessions-aggregate-request-terms-aggregation */
|
|
16864
|
+
export interface ObservabilitySessionsAggregateRequestTermsAggregation {
|
|
16865
|
+
/**
|
|
16866
|
+
* Field to group by.
|
|
16867
|
+
* @format text
|
|
16868
|
+
*/
|
|
16869
|
+
field: string;
|
|
16870
|
+
/**
|
|
16871
|
+
* Maximum number of buckets to return.
|
|
16872
|
+
* @min 1
|
|
16873
|
+
* @max 5000
|
|
16874
|
+
*/
|
|
16875
|
+
size?: number;
|
|
16876
|
+
}
|
|
16877
|
+
export declare enum ObservabilitySessionsAggregateRequestType {
|
|
16878
|
+
Mobile = "mobile",
|
|
16879
|
+
Web = "web"
|
|
16880
|
+
}
|
|
16881
|
+
/** observability-sessions-aggregate-response */
|
|
16882
|
+
export interface ObservabilitySessionsAggregateResponse {
|
|
16883
|
+
/** List of aggregation results. */
|
|
16884
|
+
aggregations: ObservabilitySessionsAggregateResponseAggregationResult[];
|
|
16885
|
+
}
|
|
16886
|
+
/** observability-sessions-aggregate-response-aggregation-result */
|
|
16887
|
+
export type ObservabilitySessionsAggregateResponseAggregationResult = (ObservabilitySessionsAggregateResponseBucketResults | ObservabilitySessionsAggregateResponseMetricResult) & {
|
|
16888
|
+
/**
|
|
16889
|
+
* The key identifying this aggregation result.
|
|
16890
|
+
* @format text
|
|
16891
|
+
*/
|
|
16892
|
+
key: string;
|
|
16893
|
+
result_type: ObservabilitySessionsAggregateResponseAggregationResultResultType;
|
|
16894
|
+
};
|
|
16895
|
+
export declare enum ObservabilitySessionsAggregateResponseAggregationResultResultType {
|
|
16896
|
+
BucketResults = "bucket_results",
|
|
16897
|
+
MetricResult = "metric_result"
|
|
16898
|
+
}
|
|
16899
|
+
/** observability-sessions-aggregate-response-bucket */
|
|
16900
|
+
export interface ObservabilitySessionsAggregateResponseBucket {
|
|
16901
|
+
/**
|
|
16902
|
+
* Number of documents in this bucket.
|
|
16903
|
+
* @min 0
|
|
16904
|
+
* @max 18446744073709552000
|
|
16905
|
+
*/
|
|
16906
|
+
doc_count: number;
|
|
16907
|
+
/**
|
|
16908
|
+
* The bucket key (canonical value - can be string, number, bool,
|
|
16909
|
+
* etc.).
|
|
16910
|
+
*/
|
|
16911
|
+
key: any;
|
|
16912
|
+
/** Results of aggregations within this bucket. */
|
|
16913
|
+
sub_aggregations: ObservabilitySessionsAggregateResponseAggregationResult[];
|
|
16914
|
+
}
|
|
16915
|
+
/** observability-sessions-aggregate-response-bucket-item */
|
|
16916
|
+
export type ObservabilitySessionsAggregateResponseBucketItem = ObservabilitySessionsAggregateResponseBucket & {
|
|
16917
|
+
bucket_type: ObservabilitySessionsAggregateResponseBucketItemBucketType;
|
|
16918
|
+
};
|
|
16919
|
+
export declare enum ObservabilitySessionsAggregateResponseBucketItemBucketType {
|
|
16920
|
+
Bucket = "bucket"
|
|
16921
|
+
}
|
|
16922
|
+
/** observability-sessions-aggregate-response-bucket-results */
|
|
16923
|
+
export interface ObservabilitySessionsAggregateResponseBucketResults {
|
|
16924
|
+
/** List of buckets from the aggregation. */
|
|
16925
|
+
buckets: ObservabilitySessionsAggregateResponseBucketItem[];
|
|
16926
|
+
}
|
|
16927
|
+
/** observability-sessions-aggregate-response-metric-result */
|
|
16928
|
+
export type ObservabilitySessionsAggregateResponseMetricResult = (ObservabilitySessionsAggregateResponsePercentilesResult | ObservabilitySessionsAggregateResponseValueResult) & {
|
|
16929
|
+
metric_type: ObservabilitySessionsAggregateResponseMetricResultMetricType;
|
|
16930
|
+
};
|
|
16931
|
+
export declare enum ObservabilitySessionsAggregateResponseMetricResultMetricType {
|
|
16932
|
+
Avg = "avg",
|
|
16933
|
+
Count = "count",
|
|
16934
|
+
Max = "max",
|
|
16935
|
+
Min = "min",
|
|
16936
|
+
Percentiles = "percentiles",
|
|
16937
|
+
Sum = "sum"
|
|
16938
|
+
}
|
|
16939
|
+
/** observability-sessions-aggregate-response-percentiles-result */
|
|
16940
|
+
export interface ObservabilitySessionsAggregateResponsePercentilesResult {
|
|
16941
|
+
/**
|
|
16942
|
+
* Map of percentile to value (e.g., {'50.0': 123.45, '90.0':
|
|
16943
|
+
* 456.78}).
|
|
16944
|
+
*/
|
|
16945
|
+
values: Record<string, number>;
|
|
16946
|
+
}
|
|
16947
|
+
/** observability-sessions-aggregate-response-value-result */
|
|
16948
|
+
export interface ObservabilitySessionsAggregateResponseValueResult {
|
|
16949
|
+
/**
|
|
16950
|
+
* The computed metric value.
|
|
16951
|
+
* @format double
|
|
16952
|
+
*/
|
|
16953
|
+
value?: number;
|
|
16954
|
+
}
|
|
14637
16955
|
/** observability-sessions-data-get-request */
|
|
14638
16956
|
export interface ObservabilitySessionsDataGetRequest {
|
|
14639
16957
|
/** Whether to include replay data in the response. Defaults to true. */
|
|
@@ -14669,6 +16987,41 @@ export declare enum ObservabilitySessionsDataGetResponseRecording {
|
|
|
14669
16987
|
MobileRecording = "mobile_recording",
|
|
14670
16988
|
WebRecording = "web_recording"
|
|
14671
16989
|
}
|
|
16990
|
+
/** observability-sessions-developer-info-get-request */
|
|
16991
|
+
export interface ObservabilitySessionsDeveloperInfoGetRequest {
|
|
16992
|
+
/** Filter console logs by type. If empty, all types are returned. */
|
|
16993
|
+
console_log_types?: ConsoleLogType[];
|
|
16994
|
+
/**
|
|
16995
|
+
* The unique identifier of the session.
|
|
16996
|
+
* @format text
|
|
16997
|
+
* @minLength 1
|
|
16998
|
+
*/
|
|
16999
|
+
session_id: string;
|
|
17000
|
+
/**
|
|
17001
|
+
* Filter network logs by HTTP status code class. If empty, all
|
|
17002
|
+
* classes are returned.
|
|
17003
|
+
*/
|
|
17004
|
+
status_code_classes?: StatusCodeClass[];
|
|
17005
|
+
/**
|
|
17006
|
+
* unique tab id of the web session.
|
|
17007
|
+
* @format text
|
|
17008
|
+
* @minLength 1
|
|
17009
|
+
*/
|
|
17010
|
+
tab_id: string;
|
|
17011
|
+
/**
|
|
17012
|
+
* version key of the app.
|
|
17013
|
+
* @format text
|
|
17014
|
+
* @minLength 1
|
|
17015
|
+
*/
|
|
17016
|
+
version_key: string;
|
|
17017
|
+
}
|
|
17018
|
+
/** observability-sessions-developer-info-get-response */
|
|
17019
|
+
export interface ObservabilitySessionsDeveloperInfoGetResponse {
|
|
17020
|
+
/** Console data containing error logs and console information. */
|
|
17021
|
+
console_data?: ConsoleLogData[];
|
|
17022
|
+
/** Network data containing request/response information. */
|
|
17023
|
+
network_data?: NetworkLog[];
|
|
17024
|
+
}
|
|
14672
17025
|
/** observability-sessions-get-request */
|
|
14673
17026
|
export interface ObservabilitySessionsGetRequest {
|
|
14674
17027
|
/** The platform type for the device. */
|
|
@@ -15966,6 +18319,11 @@ export declare enum PartsVistaGroupItemType {
|
|
|
15966
18319
|
Curated = "curated",
|
|
15967
18320
|
Dynamic = "dynamic"
|
|
15968
18321
|
}
|
|
18322
|
+
/** The period type for which to calculate period-to-date. */
|
|
18323
|
+
export declare enum PeriodToDate {
|
|
18324
|
+
QuarterToDate = "quarter_to_date",
|
|
18325
|
+
YearToDate = "year_to_date"
|
|
18326
|
+
}
|
|
15969
18327
|
/**
|
|
15970
18328
|
* pie-visualization-x-axis
|
|
15971
18329
|
* The X-axis for a pie visualization.
|
|
@@ -17935,6 +20293,11 @@ export interface SchemaFieldDescriptorBase {
|
|
|
17935
20293
|
* @format text
|
|
17936
20294
|
*/
|
|
17937
20295
|
description?: string;
|
|
20296
|
+
/**
|
|
20297
|
+
* Whether this field is derived (computed by the system and not
|
|
20298
|
+
* settable by users).
|
|
20299
|
+
*/
|
|
20300
|
+
is_derived?: boolean;
|
|
17938
20301
|
/** Whether this field is filterable, groupable and sortable. */
|
|
17939
20302
|
is_filterable?: boolean;
|
|
17940
20303
|
/** Whether this field is immutable or not. */
|
|
@@ -18056,6 +20419,8 @@ export interface SchemaFieldUenumValue {
|
|
|
18056
20419
|
* The schema of ui specific fields.
|
|
18057
20420
|
*/
|
|
18058
20421
|
export interface SchemaFieldUiMetadata {
|
|
20422
|
+
/** Card view UI hint overrides. */
|
|
20423
|
+
card_view?: CardViewUiMetadata;
|
|
18059
20424
|
/** The client overrides for the field. */
|
|
18060
20425
|
client_overrides?: ClientOverride[];
|
|
18061
20426
|
/** Create view UI hint overrides. */
|
|
@@ -18641,6 +21006,7 @@ export interface SearchCoreResponse {
|
|
|
18641
21006
|
/** The namespaces for hybrid search. */
|
|
18642
21007
|
export declare enum SearchHybridNamespace {
|
|
18643
21008
|
Account = "account",
|
|
21009
|
+
AiAgent = "ai_agent",
|
|
18644
21010
|
Article = "article",
|
|
18645
21011
|
Capability = "capability",
|
|
18646
21012
|
Component = "component",
|
|
@@ -18713,6 +21079,7 @@ export interface SearchHybridResponse {
|
|
|
18713
21079
|
/** The namespaces to search in. */
|
|
18714
21080
|
export declare enum SearchNamespace {
|
|
18715
21081
|
Account = "account",
|
|
21082
|
+
AiAgent = "ai_agent",
|
|
18716
21083
|
Article = "article",
|
|
18717
21084
|
Capability = "capability",
|
|
18718
21085
|
Component = "component",
|
|
@@ -18739,6 +21106,7 @@ export declare enum SearchNamespace {
|
|
|
18739
21106
|
RevUser = "rev_user",
|
|
18740
21107
|
Runnable = "runnable",
|
|
18741
21108
|
ServiceAccount = "service_account",
|
|
21109
|
+
Survey = "survey",
|
|
18742
21110
|
SysUser = "sys_user",
|
|
18743
21111
|
Tag = "tag",
|
|
18744
21112
|
Task = "task",
|
|
@@ -18747,11 +21115,12 @@ export declare enum SearchNamespace {
|
|
|
18747
21115
|
Workflow = "workflow"
|
|
18748
21116
|
}
|
|
18749
21117
|
/** search-result */
|
|
18750
|
-
export type SearchResult = (AccountSearchSummary | ArticleSearchSummary | ArtifactSearchSummary | ConversationSearchSummary | CustomObjectSearchSummary | DashboardSearchSummary | DirectorySearchSummary | DmSearchSummary | GroupSearchSummary | LinkSearchSummary | MeetingSearchSummary | ObjectMemberSearchSummary | OperationSearchSummary | OrgSearchSummary | PartSearchSummary | QuestionAnswerSearchSummary | TagSearchSummary | UserSearchSummary | VistaSearchSummary | WorkSearchSummary | WorkflowSearchSummary) & {
|
|
21118
|
+
export type SearchResult = (AccountSearchSummary | AiAgentSearchSummary | ArticleSearchSummary | ArtifactSearchSummary | ConversationSearchSummary | CustomObjectSearchSummary | DashboardSearchSummary | DirectorySearchSummary | DmSearchSummary | GroupSearchSummary | LinkSearchSummary | MeetingSearchSummary | ObjectMemberSearchSummary | OperationSearchSummary | OrgSearchSummary | PartSearchSummary | QuestionAnswerSearchSummary | SurveySearchSummary | TagSearchSummary | UserSearchSummary | VistaSearchSummary | WorkSearchSummary | WorkflowSearchSummary) & {
|
|
18751
21119
|
type: SearchResultType;
|
|
18752
21120
|
};
|
|
18753
21121
|
export declare enum SearchResultType {
|
|
18754
21122
|
Account = "account",
|
|
21123
|
+
AiAgent = "ai_agent",
|
|
18755
21124
|
Article = "article",
|
|
18756
21125
|
Artifact = "artifact",
|
|
18757
21126
|
Conversation = "conversation",
|
|
@@ -18767,6 +21136,7 @@ export declare enum SearchResultType {
|
|
|
18767
21136
|
Org = "org",
|
|
18768
21137
|
Part = "part",
|
|
18769
21138
|
QuestionAnswer = "question_answer",
|
|
21139
|
+
Survey = "survey",
|
|
18770
21140
|
Tag = "tag",
|
|
18771
21141
|
User = "user",
|
|
18772
21142
|
Vista = "vista",
|
|
@@ -18885,6 +21255,19 @@ export interface SendNotificationGenericNotificationEntryNotificationActionClick
|
|
|
18885
21255
|
export declare enum SendNotificationType {
|
|
18886
21256
|
GenericNotification = "generic_notification"
|
|
18887
21257
|
}
|
|
21258
|
+
/** The stroke style for the line. */
|
|
21259
|
+
export declare enum SeriesVisualizationStrokeStyle {
|
|
21260
|
+
Dashed = "dashed",
|
|
21261
|
+
Dotted = "dotted",
|
|
21262
|
+
Solid = "solid"
|
|
21263
|
+
}
|
|
21264
|
+
/** The type of the series. */
|
|
21265
|
+
export declare enum SeriesVisualizationType {
|
|
21266
|
+
Bar = "bar",
|
|
21267
|
+
Column = "column",
|
|
21268
|
+
Line = "line",
|
|
21269
|
+
Scatter = "scatter"
|
|
21270
|
+
}
|
|
18888
21271
|
/** service-account */
|
|
18889
21272
|
export type ServiceAccount = UserBase;
|
|
18890
21273
|
/** service-account-summary */
|
|
@@ -19816,6 +22199,67 @@ export type SnapInSummary = AtomBaseSummary;
|
|
|
19816
22199
|
export type SnapInVersion = AtomBase;
|
|
19817
22200
|
/** snap-in-version-summary */
|
|
19818
22201
|
export type SnapInVersionSummary = AtomBaseSummary;
|
|
22202
|
+
/** snap-ins-list-request */
|
|
22203
|
+
export interface SnapInsListRequest {
|
|
22204
|
+
/**
|
|
22205
|
+
* The cursor to resume iteration from. If not provided, then
|
|
22206
|
+
* iteration starts from the beginning.
|
|
22207
|
+
* @format text
|
|
22208
|
+
*/
|
|
22209
|
+
cursor?: string;
|
|
22210
|
+
/**
|
|
22211
|
+
* The maximum number of snap-ins to return. The default is '50', the
|
|
22212
|
+
* maximum is '100'.
|
|
22213
|
+
* @format int32
|
|
22214
|
+
*/
|
|
22215
|
+
limit?: number;
|
|
22216
|
+
/** Filter for marketplace-item associated with snap-in. */
|
|
22217
|
+
marketplace_item?: SnapInsListRequestFilterMarketplaceItemFilter[];
|
|
22218
|
+
/**
|
|
22219
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
22220
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
22221
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
22222
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
22223
|
+
* always be returned in the specified sort-by order.
|
|
22224
|
+
*/
|
|
22225
|
+
mode?: ListMode;
|
|
22226
|
+
/** Filter for service account associated with snap-in. */
|
|
22227
|
+
service_account?: string[];
|
|
22228
|
+
/** Filter for snap-in version associated with snap-in. */
|
|
22229
|
+
snap_in_version?: string[];
|
|
22230
|
+
/** Fields to sort the snap-ins by and the direction to sort them. */
|
|
22231
|
+
sort_by?: string[];
|
|
22232
|
+
}
|
|
22233
|
+
/** snap-ins-list-request-filter-marketplace-item-filter */
|
|
22234
|
+
export interface SnapInsListRequestFilterMarketplaceItemFilter {
|
|
22235
|
+
/**
|
|
22236
|
+
* The marketplace to filter by.
|
|
22237
|
+
* @format id
|
|
22238
|
+
*/
|
|
22239
|
+
marketplace?: string;
|
|
22240
|
+
/**
|
|
22241
|
+
* The marketplace item slug to filter by.
|
|
22242
|
+
* @format text
|
|
22243
|
+
*/
|
|
22244
|
+
marketplace_item_slug?: string;
|
|
22245
|
+
}
|
|
22246
|
+
/** snap-ins-list-response */
|
|
22247
|
+
export interface SnapInsListResponse {
|
|
22248
|
+
/**
|
|
22249
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
22250
|
+
* sort order. If not set, then no later elements exist.
|
|
22251
|
+
* @format text
|
|
22252
|
+
*/
|
|
22253
|
+
next_cursor?: string;
|
|
22254
|
+
/**
|
|
22255
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
22256
|
+
* sort order. If not set, then no prior elements exist.
|
|
22257
|
+
* @format text
|
|
22258
|
+
*/
|
|
22259
|
+
prev_cursor?: string;
|
|
22260
|
+
/** List of snap-ins. */
|
|
22261
|
+
snap_ins: SnapIn[];
|
|
22262
|
+
}
|
|
19819
22263
|
/** snap-ins-resources-request */
|
|
19820
22264
|
export interface SnapInsResourcesRequest {
|
|
19821
22265
|
/**
|
|
@@ -19868,6 +22312,23 @@ export interface SnapInsUpdateRequest {
|
|
|
19868
22312
|
export interface SnapInsUpdateResponse {
|
|
19869
22313
|
snap_in: SnapIn;
|
|
19870
22314
|
}
|
|
22315
|
+
/**
|
|
22316
|
+
* snap-kit-action-execute-deferred-function-result
|
|
22317
|
+
* Result returned by the snap-in when handling a deferred snap-kit
|
|
22318
|
+
* action.
|
|
22319
|
+
*/
|
|
22320
|
+
export interface SnapKitActionExecuteDeferredFunctionResult {
|
|
22321
|
+
/**
|
|
22322
|
+
* Detail message from the snap-in function execution.
|
|
22323
|
+
* @format text
|
|
22324
|
+
*/
|
|
22325
|
+
detail?: string;
|
|
22326
|
+
/**
|
|
22327
|
+
* Status of the snap-in function execution (e.g. 'error', 'success').
|
|
22328
|
+
* @format text
|
|
22329
|
+
*/
|
|
22330
|
+
status?: string;
|
|
22331
|
+
}
|
|
19871
22332
|
/** snap-kit-action-execute-deferred-request */
|
|
19872
22333
|
export interface SnapKitActionExecuteDeferredRequest {
|
|
19873
22334
|
/**
|
|
@@ -19882,7 +22343,13 @@ export interface SnapKitActionExecuteDeferredRequest {
|
|
|
19882
22343
|
id: string;
|
|
19883
22344
|
}
|
|
19884
22345
|
/** snap-kit-action-execute-deferred-response */
|
|
19885
|
-
export
|
|
22346
|
+
export interface SnapKitActionExecuteDeferredResponse {
|
|
22347
|
+
/**
|
|
22348
|
+
* Result returned by the snap-in when handling a deferred snap-kit
|
|
22349
|
+
* action.
|
|
22350
|
+
*/
|
|
22351
|
+
function_result?: SnapKitActionExecuteDeferredFunctionResult;
|
|
22352
|
+
}
|
|
19886
22353
|
/** snap-kit-action-request */
|
|
19887
22354
|
export type SnapKitActionRequest = (SnapKitActionRequestButton | SnapKitActionRequestForm) & {
|
|
19888
22355
|
type: SnapKitActionRequestElementTypeValue;
|
|
@@ -19941,6 +22408,11 @@ export declare enum SnapKitBaseWidgetSnapKitExecution {
|
|
|
19941
22408
|
/** snap-widget */
|
|
19942
22409
|
export type SnapWidget = (EmailPreviewWidget | StarterMessageNudgeWidget) & {
|
|
19943
22410
|
type: SnapWidgetType;
|
|
22411
|
+
/**
|
|
22412
|
+
* The ID of the parent object associated with this widget.
|
|
22413
|
+
* @format id
|
|
22414
|
+
*/
|
|
22415
|
+
parent_id?: string;
|
|
19944
22416
|
};
|
|
19945
22417
|
/** snap-widget-base */
|
|
19946
22418
|
export type SnapWidgetBase = AtomBase & {
|
|
@@ -20078,16 +22550,6 @@ export declare enum SpaceFilterSpaceIdOperatorType {
|
|
|
20078
22550
|
NotNull = "not_null",
|
|
20079
22551
|
Null = "null"
|
|
20080
22552
|
}
|
|
20081
|
-
/**
|
|
20082
|
-
* spaces-create-request
|
|
20083
|
-
* Request object to create a new space.
|
|
20084
|
-
*/
|
|
20085
|
-
export type SpacesCreateRequest = object;
|
|
20086
|
-
/**
|
|
20087
|
-
* spaces-create-response
|
|
20088
|
-
* The response to space creation.
|
|
20089
|
-
*/
|
|
20090
|
-
export type SpacesCreateResponse = object;
|
|
20091
22553
|
/**
|
|
20092
22554
|
* sprint-board-automation
|
|
20093
22555
|
* Automations specific to the Sprint Board vistas.
|
|
@@ -20353,6 +22815,14 @@ export interface StarterMessageNudgeWidget {
|
|
|
20353
22815
|
starter_message_nudge_type: StarterMessageNudgeWidgetStarterMessageNudgeType;
|
|
20354
22816
|
}
|
|
20355
22817
|
export type StarterMessageNudgeWidgetStarterMessageNudgeType = string;
|
|
22818
|
+
/** HTTP response status code class. */
|
|
22819
|
+
export declare enum StatusCodeClass {
|
|
22820
|
+
Value1Xx = "1xx",
|
|
22821
|
+
Value2Xx = "2xx",
|
|
22822
|
+
Value3Xx = "3xx",
|
|
22823
|
+
Value4Xx = "4xx",
|
|
22824
|
+
Value5Xx = "5xx"
|
|
22825
|
+
}
|
|
20356
22826
|
/**
|
|
20357
22827
|
* stock-field-override
|
|
20358
22828
|
* A stock field override.
|
|
@@ -20711,8 +23181,25 @@ export type SurveyResponse = AtomBase & {
|
|
|
20711
23181
|
*/
|
|
20712
23182
|
survey?: string;
|
|
20713
23183
|
};
|
|
23184
|
+
/** survey-search-summary */
|
|
23185
|
+
export type SurveySearchSummary = SearchSummaryBase & {
|
|
23186
|
+
survey: SurveySummary;
|
|
23187
|
+
};
|
|
23188
|
+
/** survey-summary */
|
|
23189
|
+
export type SurveySummary = AtomBaseSummary;
|
|
20714
23190
|
/** surveys-create-request */
|
|
20715
23191
|
export interface SurveysCreateRequest {
|
|
23192
|
+
/** Application-defined custom fields. */
|
|
23193
|
+
custom_fields?: object;
|
|
23194
|
+
/**
|
|
23195
|
+
* Custom schemas described using identifiers. Each custom field in the
|
|
23196
|
+
* request must have the corresponding schema specified; omission results
|
|
23197
|
+
* in a Bad Request error. If a custom schema is not included in the
|
|
23198
|
+
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
23199
|
+
* it is recommended to provide tenant_fragment: true and
|
|
23200
|
+
* validate_required_fields: true.
|
|
23201
|
+
*/
|
|
23202
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
20716
23203
|
/**
|
|
20717
23204
|
* Description about the survey.
|
|
20718
23205
|
* @format text
|
|
@@ -21010,6 +23497,17 @@ export interface SurveysSubmitRequest {
|
|
|
21010
23497
|
export type SurveysSubmitResponse = object;
|
|
21011
23498
|
/** surveys-update-request */
|
|
21012
23499
|
export interface SurveysUpdateRequest {
|
|
23500
|
+
/** Application-defined custom fields. */
|
|
23501
|
+
custom_fields?: object;
|
|
23502
|
+
/**
|
|
23503
|
+
* Custom schemas described using identifiers. Each custom field in the
|
|
23504
|
+
* request must have the corresponding schema specified; omission results
|
|
23505
|
+
* in a Bad Request error. If a custom schema is not included in the
|
|
23506
|
+
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
23507
|
+
* it is recommended to provide tenant_fragment: true and
|
|
23508
|
+
* validate_required_fields: true.
|
|
23509
|
+
*/
|
|
23510
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
21013
23511
|
/**
|
|
21014
23512
|
* The updated description about the survey.
|
|
21015
23513
|
* @format text
|
|
@@ -21495,6 +23993,16 @@ export interface SysUsersUpdateRequest {
|
|
|
21495
23993
|
export interface SysUsersUpdateResponse {
|
|
21496
23994
|
sys_user: SysUser;
|
|
21497
23995
|
}
|
|
23996
|
+
/** The type of data storage. */
|
|
23997
|
+
export declare enum TableDataStorageType {
|
|
23998
|
+
InlineData = "inline_data",
|
|
23999
|
+
Url = "url"
|
|
24000
|
+
}
|
|
24001
|
+
/**
|
|
24002
|
+
* table-field
|
|
24003
|
+
* A field definition within a table schema.
|
|
24004
|
+
*/
|
|
24005
|
+
export type TableField = object;
|
|
21498
24006
|
/**
|
|
21499
24007
|
* table-visualization-column
|
|
21500
24008
|
* A column in a table visualization.
|
|
@@ -22203,6 +24711,7 @@ export interface TimelineEntriesGetResponse {
|
|
|
22203
24711
|
* The request to list timeline entries for an object.
|
|
22204
24712
|
*/
|
|
22205
24713
|
export interface TimelineEntriesListRequest {
|
|
24714
|
+
bias?: TimelineEntriesListRequestBias;
|
|
22206
24715
|
/**
|
|
22207
24716
|
* The collection(s) to list entries from, otherwise if not provided,
|
|
22208
24717
|
* all entries are returned.
|
|
@@ -22253,6 +24762,10 @@ export interface TimelineEntriesListRequest {
|
|
|
22253
24762
|
*/
|
|
22254
24763
|
visibility?: TimelineEntryVisibility[];
|
|
22255
24764
|
}
|
|
24765
|
+
export declare enum TimelineEntriesListRequestBias {
|
|
24766
|
+
Quantity = "quantity",
|
|
24767
|
+
Speed = "speed"
|
|
24768
|
+
}
|
|
22256
24769
|
/**
|
|
22257
24770
|
* timeline-entries-list-response
|
|
22258
24771
|
* The response to listing timeline entries for an object.
|
|
@@ -23062,7 +25575,7 @@ export interface UpdateExternalSourceDataComp {
|
|
|
23062
25575
|
* ID of the user that created the object in the source system.
|
|
23063
25576
|
* @format id
|
|
23064
25577
|
*/
|
|
23065
|
-
|
|
25578
|
+
created_by_id?: string;
|
|
23066
25579
|
/**
|
|
23067
25580
|
* Timestamp when the object was created in the source system.
|
|
23068
25581
|
* @format date-time
|
|
@@ -23073,7 +25586,7 @@ export interface UpdateExternalSourceDataComp {
|
|
|
23073
25586
|
* ID of the user that last modified the object in the source system.
|
|
23074
25587
|
* @format id
|
|
23075
25588
|
*/
|
|
23076
|
-
|
|
25589
|
+
modified_by_id?: string;
|
|
23077
25590
|
/**
|
|
23078
25591
|
* Timestamp when the object was modified in the source system.
|
|
23079
25592
|
* @format date-time
|
|
@@ -25115,6 +27628,12 @@ export interface WidgetGroupByConfig {
|
|
|
25115
27628
|
*/
|
|
25116
27629
|
limit?: number;
|
|
25117
27630
|
}
|
|
27631
|
+
/** The identifier for the widget. */
|
|
27632
|
+
export declare enum WidgetIdentifier {
|
|
27633
|
+
AgentGenerated = "agent_generated",
|
|
27634
|
+
SpaceEnhancementDefault = "space_enhancement_default",
|
|
27635
|
+
SpaceIssueDefault = "space_issue_default"
|
|
27636
|
+
}
|
|
25118
27637
|
/**
|
|
25119
27638
|
* widget-oasis-data-source
|
|
25120
27639
|
* An oasis backed data source.
|
|
@@ -25177,6 +27696,11 @@ export interface WidgetPvpConfig {
|
|
|
25177
27696
|
* visualized.
|
|
25178
27697
|
*/
|
|
25179
27698
|
export interface WidgetQuery {
|
|
27699
|
+
/**
|
|
27700
|
+
* Extended dimension configurations that pair column references with
|
|
27701
|
+
* query-time operations like rollups and aggregation functions.
|
|
27702
|
+
*/
|
|
27703
|
+
dimension_configs?: WidgetQueryColumnConfig[];
|
|
25180
27704
|
/**
|
|
25181
27705
|
* The dimensions for the query, which are the categories to group or
|
|
25182
27706
|
* segment the measures. Usually these are the X-axis values in a
|
|
@@ -25196,6 +27720,11 @@ export interface WidgetQuery {
|
|
|
25196
27720
|
* @format int32
|
|
25197
27721
|
*/
|
|
25198
27722
|
limit?: number;
|
|
27723
|
+
/**
|
|
27724
|
+
* Extended measure configurations that pair column references with
|
|
27725
|
+
* query-time operations like aggregation functions and rollups.
|
|
27726
|
+
*/
|
|
27727
|
+
measure_configs?: WidgetQueryColumnConfig[];
|
|
25199
27728
|
/**
|
|
25200
27729
|
* The measures for the query, which are the numerical values to be
|
|
25201
27730
|
* analyzed. Usually these are the Y-axis values in a visualization.
|
|
@@ -25207,6 +27736,70 @@ export interface WidgetQuery {
|
|
|
25207
27736
|
*/
|
|
25208
27737
|
order_by?: WidgetQueryOrderBy[];
|
|
25209
27738
|
}
|
|
27739
|
+
/**
|
|
27740
|
+
* widget-query-column-config
|
|
27741
|
+
* Configuration for a column in a query. Combines a column reference with
|
|
27742
|
+
* a query-time operation (rollup or aggregation). The reference_name is a
|
|
27743
|
+
* deterministic hash of column_name + type + value, serving as a unique
|
|
27744
|
+
* identifier for downstream references (visualization axes, order_by,
|
|
27745
|
+
* filters).
|
|
27746
|
+
*/
|
|
27747
|
+
export interface WidgetQueryColumnConfig {
|
|
27748
|
+
/**
|
|
27749
|
+
* The category of the query-time operation. Time_granularity buckets
|
|
27750
|
+
* timestamp values by granularity. Aggregation applies an aggregate
|
|
27751
|
+
* function to the column. When omitted the column is a plain reference.
|
|
27752
|
+
*/
|
|
27753
|
+
type?: WidgetQueryColumnConfigType;
|
|
27754
|
+
/** The aggregation function type. Set when type is aggregation. */
|
|
27755
|
+
aggregation?: WidgetQueryColumnConfigAggregation;
|
|
27756
|
+
/**
|
|
27757
|
+
* The name of the source column from the data source.
|
|
27758
|
+
* @format text
|
|
27759
|
+
*/
|
|
27760
|
+
column_name: string;
|
|
27761
|
+
/**
|
|
27762
|
+
* A deterministic unique identifier derived from column_name, type,
|
|
27763
|
+
* and the active value field. Used to reference this column+operation
|
|
27764
|
+
* in visualization axes, order_by, filters, and other downstream
|
|
27765
|
+
* configurations.
|
|
27766
|
+
* @format text
|
|
27767
|
+
*/
|
|
27768
|
+
reference_name: string;
|
|
27769
|
+
/** The time granularity for bucketing. Set when type is time_granularity. */
|
|
27770
|
+
time_granularity?: WidgetQueryColumnConfigTimeGranularity;
|
|
27771
|
+
}
|
|
27772
|
+
/** The aggregation function type. Set when type is aggregation. */
|
|
27773
|
+
export declare enum WidgetQueryColumnConfigAggregation {
|
|
27774
|
+
Avg = "avg",
|
|
27775
|
+
Count = "count",
|
|
27776
|
+
CountDistinct = "count_distinct",
|
|
27777
|
+
Max = "max",
|
|
27778
|
+
Median = "median",
|
|
27779
|
+
Min = "min",
|
|
27780
|
+
P50 = "p50",
|
|
27781
|
+
P90 = "p90",
|
|
27782
|
+
P95 = "p95",
|
|
27783
|
+
P99 = "p99",
|
|
27784
|
+
Sum = "sum"
|
|
27785
|
+
}
|
|
27786
|
+
/** The time granularity for bucketing. Set when type is time_granularity. */
|
|
27787
|
+
export declare enum WidgetQueryColumnConfigTimeGranularity {
|
|
27788
|
+
Day = "day",
|
|
27789
|
+
Hour = "hour",
|
|
27790
|
+
Month = "month",
|
|
27791
|
+
Week = "week",
|
|
27792
|
+
Year = "year"
|
|
27793
|
+
}
|
|
27794
|
+
/**
|
|
27795
|
+
* The category of the query-time operation. Time_granularity buckets
|
|
27796
|
+
* timestamp values by granularity. Aggregation applies an aggregate
|
|
27797
|
+
* function to the column. When omitted the column is a plain reference.
|
|
27798
|
+
*/
|
|
27799
|
+
export declare enum WidgetQueryColumnConfigType {
|
|
27800
|
+
Aggregation = "aggregation",
|
|
27801
|
+
TimeGranularity = "time_granularity"
|
|
27802
|
+
}
|
|
25210
27803
|
/**
|
|
25211
27804
|
* widget-query-joins
|
|
25212
27805
|
* A list of possible joins for the data source. Follows foreign key
|
|
@@ -25250,6 +27843,12 @@ export type WidgetSummary = AtomBaseSummary & {
|
|
|
25250
27843
|
* The table manifest for the widget.
|
|
25251
27844
|
*/
|
|
25252
27845
|
export type WidgetTableManifest = object;
|
|
27846
|
+
/** The version of the widget. */
|
|
27847
|
+
export declare enum WidgetVersion {
|
|
27848
|
+
V0 = "v0",
|
|
27849
|
+
V1 = "v1",
|
|
27850
|
+
V2 = "v2"
|
|
27851
|
+
}
|
|
25253
27852
|
/**
|
|
25254
27853
|
* widget-visualization
|
|
25255
27854
|
* The visualization for a widget. This includes the type of visualization
|
|
@@ -25339,6 +27938,81 @@ export declare enum WidgetVisualizationType {
|
|
|
25339
27938
|
Scatter = "scatter",
|
|
25340
27939
|
Table = "table"
|
|
25341
27940
|
}
|
|
27941
|
+
/**
|
|
27942
|
+
* widgets-create-request
|
|
27943
|
+
* The request to create a widget.
|
|
27944
|
+
*/
|
|
27945
|
+
export interface WidgetsCreateRequest {
|
|
27946
|
+
/** The app fragment names installed by the widget. */
|
|
27947
|
+
apps?: string[];
|
|
27948
|
+
/** Data sources provide the backing data tables for the widget. */
|
|
27949
|
+
data_sources?: CreateWidgetDataSource[];
|
|
27950
|
+
/**
|
|
27951
|
+
* A brief summary of what the widget displays or represents.
|
|
27952
|
+
* @format text
|
|
27953
|
+
*/
|
|
27954
|
+
description?: string;
|
|
27955
|
+
/** The identifier for the widget. */
|
|
27956
|
+
identifier?: WidgetIdentifier;
|
|
27957
|
+
/**
|
|
27958
|
+
* The insights associated with the widget for agent generated
|
|
27959
|
+
* widgets.
|
|
27960
|
+
* @format text
|
|
27961
|
+
*/
|
|
27962
|
+
insights?: string;
|
|
27963
|
+
/** Whether the widget is a draft widget. */
|
|
27964
|
+
is_draft?: boolean;
|
|
27965
|
+
/** Whether the widget is a system widget. */
|
|
27966
|
+
is_system?: boolean;
|
|
27967
|
+
/**
|
|
27968
|
+
* Layout of the widget. It determines the organization of the sub
|
|
27969
|
+
* widgets.
|
|
27970
|
+
*/
|
|
27971
|
+
layout: CreateGridLayout[];
|
|
27972
|
+
/**
|
|
27973
|
+
* A unique identifying name for the widget (optional).
|
|
27974
|
+
* @format text
|
|
27975
|
+
*/
|
|
27976
|
+
name?: string;
|
|
27977
|
+
/**
|
|
27978
|
+
* The ID of the parent surface on which this widget is embedded.
|
|
27979
|
+
* Widget can be optionally part of a parent surface which can be
|
|
27980
|
+
* moved to another surface.
|
|
27981
|
+
* @format id
|
|
27982
|
+
* @example "VISTA-12345"
|
|
27983
|
+
*/
|
|
27984
|
+
parent_id?: string;
|
|
27985
|
+
/**
|
|
27986
|
+
* The list of users, groups and audiences with whom the widget is
|
|
27987
|
+
* shared and the corresponding roles.
|
|
27988
|
+
*/
|
|
27989
|
+
shared_with?: SetSharedWithMembership[];
|
|
27990
|
+
/**
|
|
27991
|
+
* The space associated with the object.
|
|
27992
|
+
* @format id
|
|
27993
|
+
*/
|
|
27994
|
+
space?: string;
|
|
27995
|
+
/**
|
|
27996
|
+
* A list of sub-widgets that the widget contains. Each widget can
|
|
27997
|
+
* contain multiple sub-widgets.
|
|
27998
|
+
*/
|
|
27999
|
+
sub_widgets: CreateSubWidget[];
|
|
28000
|
+
table_manifest?: CreateWidgetTableManifest;
|
|
28001
|
+
/**
|
|
28002
|
+
* The title of the widget.
|
|
28003
|
+
* @format text
|
|
28004
|
+
*/
|
|
28005
|
+
title: string;
|
|
28006
|
+
/** The version of the widget. */
|
|
28007
|
+
version?: WidgetVersion;
|
|
28008
|
+
}
|
|
28009
|
+
/**
|
|
28010
|
+
* widgets-create-response
|
|
28011
|
+
* The response to a widget create request.
|
|
28012
|
+
*/
|
|
28013
|
+
export interface WidgetsCreateResponse {
|
|
28014
|
+
widget: Widget;
|
|
28015
|
+
}
|
|
25342
28016
|
/**
|
|
25343
28017
|
* widgets-get-request
|
|
25344
28018
|
* The request to get a widget.
|
|
@@ -26237,6 +28911,13 @@ export interface WorksUpdateRequestArtifacts {
|
|
|
26237
28911
|
/** works-update-request-issue */
|
|
26238
28912
|
export interface WorksUpdateRequestIssue {
|
|
26239
28913
|
developed_with?: WorksUpdateRequestIssueDevelopedWith;
|
|
28914
|
+
/**
|
|
28915
|
+
* Updates the timestamp of the last code activity (e.g. latest commit
|
|
28916
|
+
* on all PRs with this issue).
|
|
28917
|
+
* @format date-time
|
|
28918
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
28919
|
+
*/
|
|
28920
|
+
last_code_activity?: string | null;
|
|
26240
28921
|
/** Priority of the work based upon impact and criticality. */
|
|
26241
28922
|
priority?: IssuePriority;
|
|
26242
28923
|
/**
|
|
@@ -27081,6 +29762,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27081
29762
|
* @format text
|
|
27082
29763
|
*/
|
|
27083
29764
|
cursor?: string;
|
|
29765
|
+
/** Filter for sync units that have an action required. */
|
|
29766
|
+
'filter.action_required'?: boolean;
|
|
27084
29767
|
/** Filters for sync units with the provided external system names. */
|
|
27085
29768
|
'filter.external_system_name'?: string[];
|
|
27086
29769
|
/** External system type. */
|
|
@@ -27570,7 +30253,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27570
30253
|
*/
|
|
27571
30254
|
artifactsVersionsPrepare: (data: ArtifactsVersionsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsVersionsPrepareResponse, any, {}>>;
|
|
27572
30255
|
/**
|
|
27573
|
-
* @description Gets the specified object.
|
|
30256
|
+
* @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`.
|
|
27574
30257
|
*
|
|
27575
30258
|
* @tags atoms
|
|
27576
30259
|
* @name AtomsGet
|
|
@@ -27586,7 +30269,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27586
30269
|
id: string;
|
|
27587
30270
|
}, params?: RequestParams) => Promise<AxiosResponse<AtomsGetResponse, any, {}>>;
|
|
27588
30271
|
/**
|
|
27589
|
-
* @description Gets the specified object.
|
|
30272
|
+
* @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`.
|
|
27590
30273
|
*
|
|
27591
30274
|
* @tags atoms
|
|
27592
30275
|
* @name AtomsGetPost
|
|
@@ -28139,6 +30822,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28139
30822
|
* @secure
|
|
28140
30823
|
*/
|
|
28141
30824
|
contentTemplateListPost: (data: ContentTemplateListRequest, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateListResponse, any, {}>>;
|
|
30825
|
+
/**
|
|
30826
|
+
* @description Converts a conversation into work.
|
|
30827
|
+
*
|
|
30828
|
+
* @tags conversations
|
|
30829
|
+
* @name ConversationsConvert
|
|
30830
|
+
* @summary Convert Conversations
|
|
30831
|
+
* @request POST:/conversations.convert
|
|
30832
|
+
* @secure
|
|
30833
|
+
*/
|
|
30834
|
+
conversationsConvert: (data: ConversationsConvertRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsConvertResponse, any, {}>>;
|
|
28142
30835
|
/**
|
|
28143
30836
|
* @description Creates a conversation.
|
|
28144
30837
|
*
|
|
@@ -28607,7 +31300,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28607
31300
|
*/
|
|
28608
31301
|
customObjectsUpdate: (data: CustomObjectsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsUpdateResponse, any, {}>>;
|
|
28609
31302
|
/**
|
|
28610
|
-
* @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.
|
|
31303
|
+
* @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`
|
|
28611
31304
|
*
|
|
28612
31305
|
* @tags auth-connections, dev-orgs
|
|
28613
31306
|
* @name DevOrgAuthConnectionsCreate
|
|
@@ -28617,7 +31310,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28617
31310
|
*/
|
|
28618
31311
|
devOrgAuthConnectionsCreate: (data: DevOrgAuthConnectionsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsCreateResponse, any, {}>>;
|
|
28619
31312
|
/**
|
|
28620
|
-
* @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.
|
|
31313
|
+
* @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`
|
|
28621
31314
|
*
|
|
28622
31315
|
* @tags auth-connections, dev-orgs
|
|
28623
31316
|
* @name DevOrgAuthConnectionsDelete
|
|
@@ -28627,7 +31320,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28627
31320
|
*/
|
|
28628
31321
|
devOrgAuthConnectionsDelete: (data: DevOrgAuthConnectionsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
28629
31322
|
/**
|
|
28630
|
-
* @description Retrieves the details for an authentication connection.
|
|
31323
|
+
* @description Retrieves the details for an authentication connection. **Required scopes:** - `dev_org:read`
|
|
28631
31324
|
*
|
|
28632
31325
|
* @tags auth-connections, dev-orgs
|
|
28633
31326
|
* @name DevOrgAuthConnectionsGet
|
|
@@ -28643,7 +31336,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28643
31336
|
id: string;
|
|
28644
31337
|
}, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any, {}>>;
|
|
28645
31338
|
/**
|
|
28646
|
-
* @description Retrieves the details for an authentication connection.
|
|
31339
|
+
* @description Retrieves the details for an authentication connection. **Required scopes:** - `dev_org:read`
|
|
28647
31340
|
*
|
|
28648
31341
|
* @tags auth-connections, dev-orgs
|
|
28649
31342
|
* @name DevOrgAuthConnectionsGetPost
|
|
@@ -28653,7 +31346,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28653
31346
|
*/
|
|
28654
31347
|
devOrgAuthConnectionsGetPost: (data: DevOrgAuthConnectionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any, {}>>;
|
|
28655
31348
|
/**
|
|
28656
|
-
* @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.
|
|
31349
|
+
* @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`
|
|
28657
31350
|
*
|
|
28658
31351
|
* @tags auth-connections, dev-orgs
|
|
28659
31352
|
* @name DevOrgAuthConnectionsList
|
|
@@ -28663,7 +31356,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28663
31356
|
*/
|
|
28664
31357
|
devOrgAuthConnectionsList: (params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any, {}>>;
|
|
28665
31358
|
/**
|
|
28666
|
-
* @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.
|
|
31359
|
+
* @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`
|
|
28667
31360
|
*
|
|
28668
31361
|
* @tags auth-connections, dev-orgs
|
|
28669
31362
|
* @name DevOrgAuthConnectionsListPost
|
|
@@ -28673,7 +31366,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28673
31366
|
*/
|
|
28674
31367
|
devOrgAuthConnectionsListPost: (data: Empty, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any, {}>>;
|
|
28675
31368
|
/**
|
|
28676
|
-
* @description Enable or disable an authentication connection for a Dev organization. Atleast one authentication connection must be enabled for a Dev organization.
|
|
31369
|
+
* @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`
|
|
28677
31370
|
*
|
|
28678
31371
|
* @tags auth-connections, dev-orgs
|
|
28679
31372
|
* @name DevOrgAuthConnectionsToggle
|
|
@@ -28683,7 +31376,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28683
31376
|
*/
|
|
28684
31377
|
devOrgAuthConnectionsToggle: (data: DevOrgAuthConnectionsToggleRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
28685
31378
|
/**
|
|
28686
|
-
* @description Updates an authentication connection.
|
|
31379
|
+
* @description Updates an authentication connection. **Required scopes:** - `dev_org:write`
|
|
28687
31380
|
*
|
|
28688
31381
|
* @tags auth-connections, dev-orgs
|
|
28689
31382
|
* @name DevOrgAuthConnectionsUpdate
|
|
@@ -28693,7 +31386,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28693
31386
|
*/
|
|
28694
31387
|
devOrgAuthConnectionsUpdate: (data: DevOrgAuthConnectionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsUpdateResponse, any, {}>>;
|
|
28695
31388
|
/**
|
|
28696
|
-
* @description Gets the Dev organization's information of the authenticated user.
|
|
31389
|
+
* @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
|
|
28697
31390
|
*
|
|
28698
31391
|
* @tags dev-orgs
|
|
28699
31392
|
* @name DevOrgsGet
|
|
@@ -28703,7 +31396,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28703
31396
|
*/
|
|
28704
31397
|
devOrgsGet: (params?: RequestParams) => Promise<AxiosResponse<DevOrgsGetResponse, any, {}>>;
|
|
28705
31398
|
/**
|
|
28706
|
-
* @description Gets the Dev organization's information of the authenticated user.
|
|
31399
|
+
* @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
|
|
28707
31400
|
*
|
|
28708
31401
|
* @tags dev-orgs
|
|
28709
31402
|
* @name DevOrgsGetPost
|
|
@@ -28713,7 +31406,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28713
31406
|
*/
|
|
28714
31407
|
devOrgsGetPost: (data: DevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgsGetResponse, any, {}>>;
|
|
28715
31408
|
/**
|
|
28716
|
-
* @description Activates the requested user.
|
|
31409
|
+
* @description Activates the requested user. **Required scopes:** - `dev_user:write`
|
|
28717
31410
|
*
|
|
28718
31411
|
* @tags dev-users
|
|
28719
31412
|
* @name DevUsersActivate
|
|
@@ -28723,7 +31416,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28723
31416
|
*/
|
|
28724
31417
|
devUsersActivate: (data: DevUsersActivateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersActivateResponse, any, {}>>;
|
|
28725
31418
|
/**
|
|
28726
|
-
* @description Creates a Dev user for a Dev organization.
|
|
31419
|
+
* @description Creates a Dev user for a Dev organization. **Required scopes:** - `dev_user:write`
|
|
28727
31420
|
*
|
|
28728
31421
|
* @tags dev-users
|
|
28729
31422
|
* @name DevUsersCreate
|
|
@@ -28733,7 +31426,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28733
31426
|
*/
|
|
28734
31427
|
devUsersCreate: (data: DevUsersCreateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersCreateResponse, any, {}>>;
|
|
28735
31428
|
/**
|
|
28736
|
-
* @description Deactivates the requested user.
|
|
31429
|
+
* @description Deactivates the requested user. **Required scopes:** - `dev_user:all`
|
|
28737
31430
|
*
|
|
28738
31431
|
* @tags dev-users
|
|
28739
31432
|
* @name DevUsersDeactivate
|
|
@@ -28743,7 +31436,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28743
31436
|
*/
|
|
28744
31437
|
devUsersDeactivate: (data: DevUsersDeactivateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
28745
31438
|
/**
|
|
28746
|
-
* @description Gets the requested user's information.
|
|
31439
|
+
* @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
|
|
28747
31440
|
*
|
|
28748
31441
|
* @tags dev-users
|
|
28749
31442
|
* @name DevUsersGet
|
|
@@ -28759,7 +31452,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28759
31452
|
id: string;
|
|
28760
31453
|
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any, {}>>;
|
|
28761
31454
|
/**
|
|
28762
|
-
* @description Gets the requested user's information.
|
|
31455
|
+
* @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
|
|
28763
31456
|
*
|
|
28764
31457
|
* @tags dev-users
|
|
28765
31458
|
* @name DevUsersGetPost
|
|
@@ -28769,7 +31462,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28769
31462
|
*/
|
|
28770
31463
|
devUsersGetPost: (data: DevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any, {}>>;
|
|
28771
31464
|
/**
|
|
28772
|
-
* @description Links an external/secondary identity to the Dev user.
|
|
31465
|
+
* @description Links an external/secondary identity to the Dev user. **Required scopes:** - `dev_user:write`
|
|
28773
31466
|
*
|
|
28774
31467
|
* @tags dev-users
|
|
28775
31468
|
* @name DevUsersIdentitiesLink
|
|
@@ -28779,7 +31472,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28779
31472
|
*/
|
|
28780
31473
|
devUsersIdentitiesLink: (data: DevUsersIdentitiesLinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesLinkResponse, any, {}>>;
|
|
28781
31474
|
/**
|
|
28782
|
-
* @description Unlinks an external/secondary identity from the Dev user.
|
|
31475
|
+
* @description Unlinks an external/secondary identity from the Dev user. **Required scopes:** - `dev_user:write`
|
|
28783
31476
|
*
|
|
28784
31477
|
* @tags dev-users
|
|
28785
31478
|
* @name DevUsersIdentitiesUnlink
|
|
@@ -28789,7 +31482,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28789
31482
|
*/
|
|
28790
31483
|
devUsersIdentitiesUnlink: (data: DevUsersIdentitiesUnlinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesUnlinkResponse, any, {}>>;
|
|
28791
31484
|
/**
|
|
28792
|
-
* @description Lists users within your organization.
|
|
31485
|
+
* @description Lists users within your organization. **Required scopes:** - `dev_user:read`
|
|
28793
31486
|
*
|
|
28794
31487
|
* @tags dev-users
|
|
28795
31488
|
* @name DevUsersList
|
|
@@ -28843,7 +31536,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28843
31536
|
timezone?: string[];
|
|
28844
31537
|
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any, {}>>;
|
|
28845
31538
|
/**
|
|
28846
|
-
* @description Lists users within your organization.
|
|
31539
|
+
* @description Lists users within your organization. **Required scopes:** - `dev_user:read`
|
|
28847
31540
|
*
|
|
28848
31541
|
* @tags dev-users
|
|
28849
31542
|
* @name DevUsersListPost
|
|
@@ -28853,7 +31546,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28853
31546
|
*/
|
|
28854
31547
|
devUsersListPost: (data: DevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any, {}>>;
|
|
28855
31548
|
/**
|
|
28856
|
-
* @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.
|
|
31549
|
+
* @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`
|
|
28857
31550
|
*
|
|
28858
31551
|
* @tags dev-users
|
|
28859
31552
|
* @name DevUsersMerge
|
|
@@ -28863,7 +31556,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28863
31556
|
*/
|
|
28864
31557
|
devUsersMerge: (data: DevUsersMergeRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
28865
31558
|
/**
|
|
28866
|
-
* @description Gets the authenticated user's information.
|
|
31559
|
+
* @description Gets the authenticated user's information. **Required scopes:** No scopes required
|
|
28867
31560
|
*
|
|
28868
31561
|
* @tags dev-users
|
|
28869
31562
|
* @name DevUsersSelf
|
|
@@ -28873,7 +31566,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28873
31566
|
*/
|
|
28874
31567
|
devUsersSelf: (params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any, {}>>;
|
|
28875
31568
|
/**
|
|
28876
|
-
* @description Gets the authenticated user's information.
|
|
31569
|
+
* @description Gets the authenticated user's information. **Required scopes:** No scopes required
|
|
28877
31570
|
*
|
|
28878
31571
|
* @tags dev-users
|
|
28879
31572
|
* @name DevUsersSelfPost
|
|
@@ -28883,7 +31576,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28883
31576
|
*/
|
|
28884
31577
|
devUsersSelfPost: (data: DevUsersSelfRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any, {}>>;
|
|
28885
31578
|
/**
|
|
28886
|
-
* @description Updates the authenticated user.
|
|
31579
|
+
* @description Updates the authenticated user. **Required scopes:** No scopes required
|
|
28887
31580
|
*
|
|
28888
31581
|
* @tags dev-users
|
|
28889
31582
|
* @name DevUsersSelfUpdate
|
|
@@ -28893,7 +31586,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28893
31586
|
*/
|
|
28894
31587
|
devUsersSelfUpdate: (data: DevUsersSelfUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any, {}>>;
|
|
28895
31588
|
/**
|
|
28896
|
-
* @description Updates the user corresponding to the input Id.
|
|
31589
|
+
* @description Updates the user corresponding to the input Id. **Required scopes:** - `dev_user:write`
|
|
28897
31590
|
*
|
|
28898
31591
|
* @tags dev-users
|
|
28899
31592
|
* @name DevUsersUpdate
|
|
@@ -29227,7 +31920,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29227
31920
|
*/
|
|
29228
31921
|
eventSourcesDeleteScheduledEvent: (data: EventSourcesDeleteScheduledEventRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
29229
31922
|
/**
|
|
29230
|
-
* @description Creates a new group. A group is a collection of users.
|
|
31923
|
+
* @description Creates a new group. A group is a collection of users. **Required scopes:** - `group:write`
|
|
29231
31924
|
*
|
|
29232
31925
|
* @tags groups
|
|
29233
31926
|
* @name GroupsCreate
|
|
@@ -29237,17 +31930,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29237
31930
|
*/
|
|
29238
31931
|
groupsCreate: (data: GroupsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsCreateResponse, any, {}>>;
|
|
29239
31932
|
/**
|
|
29240
|
-
* @description
|
|
29241
|
-
*
|
|
29242
|
-
* @tags groups
|
|
29243
|
-
* @name GroupsDelete
|
|
29244
|
-
* @summary Delete Group
|
|
29245
|
-
* @request POST:/groups.delete
|
|
29246
|
-
* @secure
|
|
29247
|
-
*/
|
|
29248
|
-
groupsDelete: (data: GroupsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
29249
|
-
/**
|
|
29250
|
-
* @description Gets the requested group.
|
|
31933
|
+
* @description Gets the requested group. **Required scopes:** - `group:read`
|
|
29251
31934
|
*
|
|
29252
31935
|
* @tags groups
|
|
29253
31936
|
* @name GroupsGet
|
|
@@ -29263,7 +31946,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29263
31946
|
id: string;
|
|
29264
31947
|
}, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any, {}>>;
|
|
29265
31948
|
/**
|
|
29266
|
-
* @description Gets the requested group.
|
|
31949
|
+
* @description Gets the requested group. **Required scopes:** - `group:read`
|
|
29267
31950
|
*
|
|
29268
31951
|
* @tags groups
|
|
29269
31952
|
* @name GroupsGetPost
|
|
@@ -29273,7 +31956,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29273
31956
|
*/
|
|
29274
31957
|
groupsGetPost: (data: GroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any, {}>>;
|
|
29275
31958
|
/**
|
|
29276
|
-
* @description Lists the available groups.
|
|
31959
|
+
* @description Lists the available groups. **Required scopes:** - `group:read`
|
|
29277
31960
|
*
|
|
29278
31961
|
* @tags groups
|
|
29279
31962
|
* @name GroupsList
|
|
@@ -29344,7 +32027,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29344
32027
|
'sync_metadata.origin_system'?: string[];
|
|
29345
32028
|
}, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any, {}>>;
|
|
29346
32029
|
/**
|
|
29347
|
-
* @description Lists the available groups.
|
|
32030
|
+
* @description Lists the available groups. **Required scopes:** - `group:read`
|
|
29348
32031
|
*
|
|
29349
32032
|
* @tags groups
|
|
29350
32033
|
* @name GroupsListPost
|
|
@@ -29354,7 +32037,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29354
32037
|
*/
|
|
29355
32038
|
groupsListPost: (data: GroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any, {}>>;
|
|
29356
32039
|
/**
|
|
29357
|
-
* @description Adds a member to a group.
|
|
32040
|
+
* @description Adds a member to a group. **Required scopes:** - `group_membership:write`
|
|
29358
32041
|
*
|
|
29359
32042
|
* @tags groups
|
|
29360
32043
|
* @name GroupMembersAdd
|
|
@@ -29390,7 +32073,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29390
32073
|
*/
|
|
29391
32074
|
groupMembersCountPost: (data: GroupMembersCountRequest, params?: RequestParams) => Promise<AxiosResponse<GroupMembersCountResponse, any, {}>>;
|
|
29392
32075
|
/**
|
|
29393
|
-
* @description Lists the members in a group.
|
|
32076
|
+
* @description Lists the members in a group. **Required scopes:** - `group_membership:read`
|
|
29394
32077
|
*
|
|
29395
32078
|
* @tags groups
|
|
29396
32079
|
* @name GroupMembersList
|
|
@@ -29425,7 +32108,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29425
32108
|
sort_by?: string[];
|
|
29426
32109
|
}, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any, {}>>;
|
|
29427
32110
|
/**
|
|
29428
|
-
* @description Lists the members in a group.
|
|
32111
|
+
* @description Lists the members in a group. **Required scopes:** - `group_membership:read`
|
|
29429
32112
|
*
|
|
29430
32113
|
* @tags groups
|
|
29431
32114
|
* @name GroupMembersListPost
|
|
@@ -29435,7 +32118,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29435
32118
|
*/
|
|
29436
32119
|
groupMembersListPost: (data: GroupMembersListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any, {}>>;
|
|
29437
32120
|
/**
|
|
29438
|
-
* @description Removes a member from a group.
|
|
32121
|
+
* @description Removes a member from a group. **Required scopes:** - `group_membership:write`
|
|
29439
32122
|
*
|
|
29440
32123
|
* @tags groups
|
|
29441
32124
|
* @name GroupMembersRemove
|
|
@@ -29445,7 +32128,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29445
32128
|
*/
|
|
29446
32129
|
groupMembersRemove: (data: GroupMembersRemoveRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
29447
32130
|
/**
|
|
29448
|
-
* @description Updates the requested group.
|
|
32131
|
+
* @description Updates the requested group. **Required scopes:** - `group:write`
|
|
29449
32132
|
*
|
|
29450
32133
|
* @tags groups
|
|
29451
32134
|
* @name GroupsUpdate
|
|
@@ -29911,8 +32594,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29911
32594
|
/** Whether only deprecated link types should be filtered. */
|
|
29912
32595
|
is_deprecated?: boolean;
|
|
29913
32596
|
/**
|
|
29914
|
-
* The maximum number of items, for each result and
|
|
29915
|
-
*
|
|
32597
|
+
* The maximum number of items, for each result and reverse_result.
|
|
32598
|
+
* Default value is 50 for each.
|
|
29916
32599
|
* @format int32
|
|
29917
32600
|
*/
|
|
29918
32601
|
limit?: number;
|
|
@@ -30025,7 +32708,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30025
32708
|
*/
|
|
30026
32709
|
linksCreate: (data: LinksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<LinksCreateResponse, any, {}>>;
|
|
30027
32710
|
/**
|
|
30028
|
-
* @description Deletes a link.
|
|
32711
|
+
* @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.
|
|
30029
32712
|
*
|
|
30030
32713
|
* @tags links
|
|
30031
32714
|
* @name LinksDelete
|
|
@@ -30130,7 +32813,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30130
32813
|
*/
|
|
30131
32814
|
linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any, {}>>;
|
|
30132
32815
|
/**
|
|
30133
|
-
* @description Replaces a link.
|
|
32816
|
+
* @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.
|
|
30134
32817
|
*
|
|
30135
32818
|
* @tags links
|
|
30136
32819
|
* @name LinksReplace
|
|
@@ -30310,6 +32993,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30310
32993
|
* @secure
|
|
30311
32994
|
*/
|
|
30312
32995
|
meetingsDelete: (data: MeetingsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
32996
|
+
/**
|
|
32997
|
+
* @description Exports a list of meetings asynchronously.
|
|
32998
|
+
*
|
|
32999
|
+
* @tags meetings
|
|
33000
|
+
* @name MeetingsExportAsync
|
|
33001
|
+
* @summary Async Meetings Export
|
|
33002
|
+
* @request POST:/meetings.export.async
|
|
33003
|
+
* @secure
|
|
33004
|
+
*/
|
|
33005
|
+
meetingsExportAsync: (data: MeetingsExportAsyncRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsExportAsyncResponse, any, {}>>;
|
|
30313
33006
|
/**
|
|
30314
33007
|
* @description Gets the meeting record.
|
|
30315
33008
|
*
|
|
@@ -30621,6 +33314,80 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30621
33314
|
* @secure
|
|
30622
33315
|
*/
|
|
30623
33316
|
notificationsSend: (data: NotificationsSendRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
33317
|
+
/**
|
|
33318
|
+
* @description Get list of objects matching the given filter.
|
|
33319
|
+
*
|
|
33320
|
+
* @tags search
|
|
33321
|
+
* @name ObjectsList
|
|
33322
|
+
* @summary List Objects
|
|
33323
|
+
* @request GET:/objects.list
|
|
33324
|
+
* @secure
|
|
33325
|
+
*/
|
|
33326
|
+
objectsList: (query?: {
|
|
33327
|
+
/**
|
|
33328
|
+
* Opaque cursor token that represents a position in the result set. Use
|
|
33329
|
+
* the cursor from previous responses to fetch next/previous iteration.
|
|
33330
|
+
* @format text
|
|
33331
|
+
*/
|
|
33332
|
+
'dql_query.cursor'?: string;
|
|
33333
|
+
/**
|
|
33334
|
+
* The search query to filter the objects. Required if any
|
|
33335
|
+
* dql_query.expression.* fields are provided.
|
|
33336
|
+
* @format text
|
|
33337
|
+
*/
|
|
33338
|
+
'dql_query.expression.query'?: string;
|
|
33339
|
+
/** Fields on which the search query will be scoped on. */
|
|
33340
|
+
'dql_query.expression.scope'?: string[];
|
|
33341
|
+
/**
|
|
33342
|
+
* Field name to group results by. Required if any dql_query.group_by.*
|
|
33343
|
+
* fields are provided.
|
|
33344
|
+
* @format text
|
|
33345
|
+
*/
|
|
33346
|
+
'dql_query.group_by.field'?: string;
|
|
33347
|
+
/** Criterion used to order groups */
|
|
33348
|
+
'dql_query.group_by.order'?: DevrevQueryGroupExpressionOrder;
|
|
33349
|
+
/** Sorting direction to be applied on the ordered groups */
|
|
33350
|
+
'dql_query.group_by.sort_direction'?: DevrevQueryGroupExpressionSortDirection;
|
|
33351
|
+
/**
|
|
33352
|
+
* Maximum number of items to return per iteration. If not specified,
|
|
33353
|
+
* the service will use its default limit.
|
|
33354
|
+
* @format int32
|
|
33355
|
+
*/
|
|
33356
|
+
'dql_query.limit'?: number;
|
|
33357
|
+
/**
|
|
33358
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
33359
|
+
* used.
|
|
33360
|
+
*/
|
|
33361
|
+
'dql_query.mode'?: ListMode;
|
|
33362
|
+
/**
|
|
33363
|
+
* The search query to filter the objects.
|
|
33364
|
+
* @deprecated
|
|
33365
|
+
* @format text
|
|
33366
|
+
*/
|
|
33367
|
+
'dql_query.search_query'?: string;
|
|
33368
|
+
/** Fields to sort the records by and the direction to sort them. */
|
|
33369
|
+
'dql_query.sort_by'?: string[];
|
|
33370
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ObjectsListResponse, any, {}>>;
|
|
33371
|
+
/**
|
|
33372
|
+
* @description Get list of objects matching the given filter.
|
|
33373
|
+
*
|
|
33374
|
+
* @tags search
|
|
33375
|
+
* @name ObjectsListPost
|
|
33376
|
+
* @summary List Objects (POST)
|
|
33377
|
+
* @request POST:/objects.list
|
|
33378
|
+
* @secure
|
|
33379
|
+
*/
|
|
33380
|
+
objectsListPost: (data: ObjectsListRequest, params?: RequestParams) => Promise<AxiosResponse<ObjectsListResponse, any, {}>>;
|
|
33381
|
+
/**
|
|
33382
|
+
* @description Aggregates the sessions data.
|
|
33383
|
+
*
|
|
33384
|
+
* @tags observability
|
|
33385
|
+
* @name ObservabilitySessionsAggregate
|
|
33386
|
+
* @summary Aggregate Observability Sessions
|
|
33387
|
+
* @request POST:/observability.sessions.aggregate
|
|
33388
|
+
* @secure
|
|
33389
|
+
*/
|
|
33390
|
+
observabilitySessionsAggregate: (data: ObservabilitySessionsAggregateRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsAggregateResponse, any, {}>>;
|
|
30624
33391
|
/**
|
|
30625
33392
|
* @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.
|
|
30626
33393
|
*
|
|
@@ -30665,6 +33432,52 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30665
33432
|
* @secure
|
|
30666
33433
|
*/
|
|
30667
33434
|
observabilitySessionsDataGetPost: (data: ObservabilitySessionsDataGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDataGetResponse, any, {}>>;
|
|
33435
|
+
/**
|
|
33436
|
+
* @description Retrieves detailed console and network data for debugging.
|
|
33437
|
+
*
|
|
33438
|
+
* @tags observability
|
|
33439
|
+
* @name ObservabilitySessionsDeveloperInfoGet
|
|
33440
|
+
* @summary Get Observability Sessions Developer Info
|
|
33441
|
+
* @request GET:/observability.sessions.developer-info.get
|
|
33442
|
+
* @secure
|
|
33443
|
+
*/
|
|
33444
|
+
observabilitySessionsDeveloperInfoGet: (query: {
|
|
33445
|
+
/**
|
|
33446
|
+
* The unique identifier of the session.
|
|
33447
|
+
* @format text
|
|
33448
|
+
* @minLength 1
|
|
33449
|
+
*/
|
|
33450
|
+
session_id: string;
|
|
33451
|
+
/**
|
|
33452
|
+
* unique tab id of the web session.
|
|
33453
|
+
* @format text
|
|
33454
|
+
* @minLength 1
|
|
33455
|
+
*/
|
|
33456
|
+
tab_id: string;
|
|
33457
|
+
/**
|
|
33458
|
+
* version key of the app.
|
|
33459
|
+
* @format text
|
|
33460
|
+
* @minLength 1
|
|
33461
|
+
*/
|
|
33462
|
+
version_key: string;
|
|
33463
|
+
/** Filter console logs by type. If empty, all types are returned. */
|
|
33464
|
+
console_log_types?: ConsoleLogType[];
|
|
33465
|
+
/**
|
|
33466
|
+
* Filter network logs by HTTP status code class. If empty, all classes
|
|
33467
|
+
* are returned.
|
|
33468
|
+
*/
|
|
33469
|
+
status_code_classes?: StatusCodeClass[];
|
|
33470
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDeveloperInfoGetResponse, any, {}>>;
|
|
33471
|
+
/**
|
|
33472
|
+
* @description Retrieves detailed console and network data for debugging.
|
|
33473
|
+
*
|
|
33474
|
+
* @tags observability
|
|
33475
|
+
* @name ObservabilitySessionsDeveloperInfoGetPost
|
|
33476
|
+
* @summary Get Observability Sessions Developer Info (POST)
|
|
33477
|
+
* @request POST:/observability.sessions.developer-info.get
|
|
33478
|
+
* @secure
|
|
33479
|
+
*/
|
|
33480
|
+
observabilitySessionsDeveloperInfoGetPost: (data: ObservabilitySessionsDeveloperInfoGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDeveloperInfoGetResponse, any, {}>>;
|
|
30668
33481
|
/**
|
|
30669
33482
|
* @description Gets a specific session metadata by ID.
|
|
30670
33483
|
*
|
|
@@ -31188,7 +34001,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31188
34001
|
*/
|
|
31189
34002
|
partsUpdate: (data: PartsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsUpdateResponse, any, {}>>;
|
|
31190
34003
|
/**
|
|
31191
|
-
* @description Pings the DevRev service.
|
|
34004
|
+
* @description Pings the DevRev service. **Required scopes:** No scopes required.
|
|
31192
34005
|
*
|
|
31193
34006
|
* @name Ping
|
|
31194
34007
|
* @summary Ping
|
|
@@ -31203,7 +34016,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31203
34016
|
devrev_partition?: string;
|
|
31204
34017
|
}, params?: RequestParams) => Promise<AxiosResponse<PingResponse, any, {}>>;
|
|
31205
34018
|
/**
|
|
31206
|
-
* @description Pings the DevRev service.
|
|
34019
|
+
* @description Pings the DevRev service. **Required scopes:** No scopes required.
|
|
31207
34020
|
*
|
|
31208
34021
|
* @name PingPost
|
|
31209
34022
|
* @summary Ping (POST)
|
|
@@ -31473,7 +34286,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31473
34286
|
*/
|
|
31474
34287
|
recordTemplateGetPost: (data: RecordTemplateGetRequest, params?: RequestParams) => Promise<AxiosResponse<RecordTemplateGetResponse, any, {}>>;
|
|
31475
34288
|
/**
|
|
31476
|
-
* @description Creates a Rev organization in the authenticated user's Dev organization.
|
|
34289
|
+
* @description Creates a Rev organization in the authenticated user's Dev organization. **Required scopes:** - `rev_org:write`
|
|
31477
34290
|
*
|
|
31478
34291
|
* @tags rev-orgs
|
|
31479
34292
|
* @name RevOrgsCreate
|
|
@@ -31483,7 +34296,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31483
34296
|
*/
|
|
31484
34297
|
revOrgsCreate: (data: RevOrgsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsCreateResponse, any, {}>>;
|
|
31485
34298
|
/**
|
|
31486
|
-
* @description Deletes the Rev organization.
|
|
34299
|
+
* @description Deletes the Rev organization. **Required scopes:** - `rev_org:all`
|
|
31487
34300
|
*
|
|
31488
34301
|
* @tags rev-orgs
|
|
31489
34302
|
* @name RevOrgsDelete
|
|
@@ -31493,7 +34306,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31493
34306
|
*/
|
|
31494
34307
|
revOrgsDelete: (data: RevOrgsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
31495
34308
|
/**
|
|
31496
|
-
* @description Retrieves the Rev organization's information.
|
|
34309
|
+
* @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
|
|
31497
34310
|
*
|
|
31498
34311
|
* @tags rev-orgs
|
|
31499
34312
|
* @name RevOrgsGet
|
|
@@ -31517,7 +34330,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31517
34330
|
id?: string;
|
|
31518
34331
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any, {}>>;
|
|
31519
34332
|
/**
|
|
31520
|
-
* @description Retrieves the Rev organization's information.
|
|
34333
|
+
* @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
|
|
31521
34334
|
*
|
|
31522
34335
|
* @tags rev-orgs
|
|
31523
34336
|
* @name RevOrgsGetPost
|
|
@@ -31527,7 +34340,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31527
34340
|
*/
|
|
31528
34341
|
revOrgsGetPost: (data: RevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any, {}>>;
|
|
31529
34342
|
/**
|
|
31530
|
-
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
34343
|
+
* @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`
|
|
31531
34344
|
*
|
|
31532
34345
|
* @tags rev-orgs
|
|
31533
34346
|
* @name RevOrgsList
|
|
@@ -31605,7 +34418,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31605
34418
|
tags?: string[];
|
|
31606
34419
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any, {}>>;
|
|
31607
34420
|
/**
|
|
31608
|
-
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
34421
|
+
* @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`
|
|
31609
34422
|
*
|
|
31610
34423
|
* @tags rev-orgs
|
|
31611
34424
|
* @name RevOrgsListPost
|
|
@@ -31615,7 +34428,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31615
34428
|
*/
|
|
31616
34429
|
revOrgsListPost: (data: RevOrgsListRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any, {}>>;
|
|
31617
34430
|
/**
|
|
31618
|
-
* @description Updates the Rev organization's information.
|
|
34431
|
+
* @description Updates the Rev organization's information. **Required scopes:** - `rev_org:write`
|
|
31619
34432
|
*
|
|
31620
34433
|
* @tags rev-orgs
|
|
31621
34434
|
* @name RevOrgsUpdate
|
|
@@ -31688,7 +34501,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31688
34501
|
*/
|
|
31689
34502
|
revUsersAssociationsRemove: (data: RevUsersAssociationsRemoveRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
31690
34503
|
/**
|
|
31691
|
-
* @description Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization.
|
|
34504
|
+
* @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`
|
|
31692
34505
|
*
|
|
31693
34506
|
* @tags rev-users
|
|
31694
34507
|
* @name RevUsersCreate
|
|
@@ -31698,7 +34511,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31698
34511
|
*/
|
|
31699
34512
|
revUsersCreate: (data: RevUsersCreateRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersCreateResponse, any, {}>>;
|
|
31700
34513
|
/**
|
|
31701
|
-
* @description Deletes a Rev user.
|
|
34514
|
+
* @description Deletes a Rev user. **Required scopes:** - `rev_user:all`
|
|
31702
34515
|
*
|
|
31703
34516
|
* @tags rev-users
|
|
31704
34517
|
* @name RevUsersDelete
|
|
@@ -31718,7 +34531,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31718
34531
|
*/
|
|
31719
34532
|
deleteRevUsersPersonalData: (data: DeleteRevUsersPersonalDataRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
31720
34533
|
/**
|
|
31721
|
-
* @description Returns the Rev user of a Rev organization by its ID.
|
|
34534
|
+
* @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
|
|
31722
34535
|
*
|
|
31723
34536
|
* @tags rev-users
|
|
31724
34537
|
* @name RevUsersGet
|
|
@@ -31734,7 +34547,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31734
34547
|
id: string;
|
|
31735
34548
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any, {}>>;
|
|
31736
34549
|
/**
|
|
31737
|
-
* @description Returns the Rev user of a Rev organization by its ID.
|
|
34550
|
+
* @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
|
|
31738
34551
|
*
|
|
31739
34552
|
* @tags rev-users
|
|
31740
34553
|
* @name RevUsersGetPost
|
|
@@ -31755,7 +34568,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31755
34568
|
*/
|
|
31756
34569
|
linkRevUserToRevOrg: (data: LinkRevUserToRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<LinkRevUserToRevOrgResponse, any, {}>>;
|
|
31757
34570
|
/**
|
|
31758
|
-
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization.
|
|
34571
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
|
|
31759
34572
|
*
|
|
31760
34573
|
* @tags rev-users
|
|
31761
34574
|
* @name RevUsersList
|
|
@@ -31836,7 +34649,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31836
34649
|
tags?: string[];
|
|
31837
34650
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any, {}>>;
|
|
31838
34651
|
/**
|
|
31839
|
-
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization.
|
|
34652
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
|
|
31840
34653
|
*
|
|
31841
34654
|
* @tags rev-users
|
|
31842
34655
|
* @name RevUsersListPost
|
|
@@ -31846,7 +34659,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31846
34659
|
*/
|
|
31847
34660
|
revUsersListPost: (data: RevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any, {}>>;
|
|
31848
34661
|
/**
|
|
31849
|
-
* @description Merges the secondary Rev user into the primary Rev user.
|
|
34662
|
+
* @description Merges the secondary Rev user into the primary Rev user. **Required scopes:** - `rev_user:all`
|
|
31850
34663
|
*
|
|
31851
34664
|
* @tags rev-users
|
|
31852
34665
|
* @name RevUsersMerge
|
|
@@ -31866,7 +34679,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31866
34679
|
*/
|
|
31867
34680
|
getRevUsersPersonalData: (data: GetRevUsersPersonalDataRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
31868
34681
|
/**
|
|
31869
|
-
* @description Scans through all Rev users.
|
|
34682
|
+
* @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
|
|
31870
34683
|
*
|
|
31871
34684
|
* @tags rev-users
|
|
31872
34685
|
* @name RevUsersScan
|
|
@@ -31935,7 +34748,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31935
34748
|
tags?: string[];
|
|
31936
34749
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersScanResponse, any, {}>>;
|
|
31937
34750
|
/**
|
|
31938
|
-
* @description Scans through all Rev users.
|
|
34751
|
+
* @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
|
|
31939
34752
|
*
|
|
31940
34753
|
* @tags rev-users
|
|
31941
34754
|
* @name RevUsersScanPost
|
|
@@ -31956,7 +34769,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31956
34769
|
*/
|
|
31957
34770
|
unlinkRevUserFromRevOrg: (data: UnlinkRevUserFromRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<UnlinkRevUserFromRevOrgResponse, any, {}>>;
|
|
31958
34771
|
/**
|
|
31959
|
-
* @description Updates a Rev user.
|
|
34772
|
+
* @description Updates a Rev user. **Required scopes:** - `rev_user:write`
|
|
31960
34773
|
*
|
|
31961
34774
|
* @tags rev-users
|
|
31962
34775
|
* @name RevUsersUpdate
|
|
@@ -32620,6 +35433,60 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32620
35433
|
* @secure
|
|
32621
35434
|
*/
|
|
32622
35435
|
slasUpdate: (data: SlasUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SlasUpdateResponse, any, {}>>;
|
|
35436
|
+
/**
|
|
35437
|
+
* @description Lists snap-ins for a Dev organization.
|
|
35438
|
+
*
|
|
35439
|
+
* @tags snap-ins
|
|
35440
|
+
* @name SnapInsList
|
|
35441
|
+
* @summary List Snap Ins
|
|
35442
|
+
* @request GET:/snap-ins.list
|
|
35443
|
+
* @secure
|
|
35444
|
+
*/
|
|
35445
|
+
snapInsList: (query?: {
|
|
35446
|
+
/**
|
|
35447
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
35448
|
+
* starts from the beginning.
|
|
35449
|
+
* @format text
|
|
35450
|
+
*/
|
|
35451
|
+
cursor?: string;
|
|
35452
|
+
/**
|
|
35453
|
+
* The maximum number of snap-ins to return. The default is '50', the
|
|
35454
|
+
* maximum is '100'.
|
|
35455
|
+
* @format int32
|
|
35456
|
+
*/
|
|
35457
|
+
limit?: number;
|
|
35458
|
+
/**
|
|
35459
|
+
* The marketplace to filter by.
|
|
35460
|
+
* @format id
|
|
35461
|
+
*/
|
|
35462
|
+
'marketplace_item.marketplace'?: string;
|
|
35463
|
+
/**
|
|
35464
|
+
* The marketplace item slug to filter by.
|
|
35465
|
+
* @format text
|
|
35466
|
+
*/
|
|
35467
|
+
'marketplace_item.marketplace_item_slug'?: string;
|
|
35468
|
+
/**
|
|
35469
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
35470
|
+
* used.
|
|
35471
|
+
*/
|
|
35472
|
+
mode?: ListMode;
|
|
35473
|
+
/** Filter for service account associated with snap-in. */
|
|
35474
|
+
service_account?: string[];
|
|
35475
|
+
/** Filter for snap-in version associated with snap-in. */
|
|
35476
|
+
snap_in_version?: string[];
|
|
35477
|
+
/** Fields to sort the snap-ins by and the direction to sort them. */
|
|
35478
|
+
sort_by?: string[];
|
|
35479
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SnapInsListResponse, any, {}>>;
|
|
35480
|
+
/**
|
|
35481
|
+
* @description Lists snap-ins for a Dev organization.
|
|
35482
|
+
*
|
|
35483
|
+
* @tags snap-ins
|
|
35484
|
+
* @name SnapInsListPost
|
|
35485
|
+
* @summary List Snap Ins (POST)
|
|
35486
|
+
* @request POST:/snap-ins.list
|
|
35487
|
+
* @secure
|
|
35488
|
+
*/
|
|
35489
|
+
snapInsListPost: (data: SnapInsListRequest, params?: RequestParams) => Promise<AxiosResponse<SnapInsListResponse, any, {}>>;
|
|
32623
35490
|
/**
|
|
32624
35491
|
* @description Gets snap-in resources for a user in a snap-in.
|
|
32625
35492
|
*
|
|
@@ -32670,7 +35537,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32670
35537
|
* @request POST:/snap-kit-action.execute.deferred
|
|
32671
35538
|
* @secure
|
|
32672
35539
|
*/
|
|
32673
|
-
snapKitActionExecuteDeferred: (data: SnapKitActionExecuteDeferredRequest, params?: RequestParams) => Promise<AxiosResponse<
|
|
35540
|
+
snapKitActionExecuteDeferred: (data: SnapKitActionExecuteDeferredRequest, params?: RequestParams) => Promise<AxiosResponse<SnapKitActionExecuteDeferredResponse, any, {}>>;
|
|
32674
35541
|
/**
|
|
32675
35542
|
* @description Create a snap widget object.
|
|
32676
35543
|
*
|
|
@@ -32681,16 +35548,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32681
35548
|
* @secure
|
|
32682
35549
|
*/
|
|
32683
35550
|
snapWidgetsCreate: (data: SnapWidgetsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapWidgetsCreateResponse, any, {}>>;
|
|
32684
|
-
/**
|
|
32685
|
-
* @description Creates a new space.
|
|
32686
|
-
*
|
|
32687
|
-
* @tags spaces
|
|
32688
|
-
* @name SpacesCreate
|
|
32689
|
-
* @summary Create Space
|
|
32690
|
-
* @request POST:/spaces.create
|
|
32691
|
-
* @secure
|
|
32692
|
-
*/
|
|
32693
|
-
spacesCreate: (data: SpacesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
32694
35551
|
/**
|
|
32695
35552
|
* @description Creates a stage diagram.
|
|
32696
35553
|
*
|
|
@@ -33232,7 +36089,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33232
36089
|
*/
|
|
33233
36090
|
surveysUpdate: (data: SurveysUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysUpdateResponse, any, {}>>;
|
|
33234
36091
|
/**
|
|
33235
|
-
* @description Lists system users within your organization.
|
|
36092
|
+
* @description Lists system users within your organization. **Required scopes:** - `dev_user:read`
|
|
33236
36093
|
*
|
|
33237
36094
|
* @tags sys-users
|
|
33238
36095
|
* @name SysUsersList
|
|
@@ -33262,7 +36119,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33262
36119
|
sort_by?: string[];
|
|
33263
36120
|
}, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any, {}>>;
|
|
33264
36121
|
/**
|
|
33265
|
-
* @description Lists system users within your organization.
|
|
36122
|
+
* @description Lists system users within your organization. **Required scopes:** - `dev_user:read`
|
|
33266
36123
|
*
|
|
33267
36124
|
* @tags sys-users
|
|
33268
36125
|
* @name SysUsersListPost
|
|
@@ -33272,7 +36129,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33272
36129
|
*/
|
|
33273
36130
|
sysUsersListPost: (data: SysUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any, {}>>;
|
|
33274
36131
|
/**
|
|
33275
|
-
* @description Updates the system user.
|
|
36132
|
+
* @description Updates the system user. **Required scopes:** - `dev_user:write`
|
|
33276
36133
|
*
|
|
33277
36134
|
* @tags sys-users
|
|
33278
36135
|
* @name SysUsersUpdate
|
|
@@ -33450,6 +36307,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33450
36307
|
* @example "PROD-12345"
|
|
33451
36308
|
*/
|
|
33452
36309
|
object: string;
|
|
36310
|
+
/** The bias for request processing. The default is 'speed'. */
|
|
36311
|
+
bias?: TimelineEntriesListRequestBias;
|
|
33453
36312
|
/**
|
|
33454
36313
|
* The collection(s) to list entries from, otherwise if not provided,
|
|
33455
36314
|
* all entries are returned.
|
|
@@ -34110,6 +36969,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34110
36969
|
* @secure
|
|
34111
36970
|
*/
|
|
34112
36971
|
webhooksUpdate: (data: WebhooksUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksUpdateResponse, any, {}>>;
|
|
36972
|
+
/**
|
|
36973
|
+
* @description Creates a new widget.
|
|
36974
|
+
*
|
|
36975
|
+
* @tags widgets
|
|
36976
|
+
* @name WidgetsCreate
|
|
36977
|
+
* @summary Create Widget
|
|
36978
|
+
* @request POST:/widgets.create
|
|
36979
|
+
* @secure
|
|
36980
|
+
*/
|
|
36981
|
+
widgetsCreate: (data: WidgetsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<WidgetsCreateResponse, any, {}>>;
|
|
34113
36982
|
/**
|
|
34114
36983
|
* @description Returns the requested widget.
|
|
34115
36984
|
*
|