@devrev/typescript-sdk 1.1.72 → 1.1.73
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -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. */
|
|
@@ -4500,6 +4508,52 @@ export declare enum ConfigurationProrationBehavior {
|
|
|
4500
4508
|
CreateProrations = "create_prorations",
|
|
4501
4509
|
None = "none"
|
|
4502
4510
|
}
|
|
4511
|
+
/** console-log-data */
|
|
4512
|
+
export interface ConsoleLogData {
|
|
4513
|
+
/** The type of console log. */
|
|
4514
|
+
type: ConsoleLogType;
|
|
4515
|
+
/**
|
|
4516
|
+
* Full URL of the console log.
|
|
4517
|
+
* @format text
|
|
4518
|
+
*/
|
|
4519
|
+
full_url: string;
|
|
4520
|
+
properties: ConsoleLogProperties;
|
|
4521
|
+
/**
|
|
4522
|
+
* Timestamp of the log entry.
|
|
4523
|
+
* @format date-time
|
|
4524
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4525
|
+
*/
|
|
4526
|
+
timestamp: string;
|
|
4527
|
+
/**
|
|
4528
|
+
* Value/content of the console log.
|
|
4529
|
+
* @format text
|
|
4530
|
+
*/
|
|
4531
|
+
value: string;
|
|
4532
|
+
}
|
|
4533
|
+
/** console-log-properties */
|
|
4534
|
+
export interface ConsoleLogProperties {
|
|
4535
|
+
/**
|
|
4536
|
+
* Normalized URL of the page.
|
|
4537
|
+
* @format text
|
|
4538
|
+
*/
|
|
4539
|
+
normalized_url: string;
|
|
4540
|
+
/**
|
|
4541
|
+
* Name of the page where the log occurred.
|
|
4542
|
+
* @format text
|
|
4543
|
+
*/
|
|
4544
|
+
page_name: string;
|
|
4545
|
+
/**
|
|
4546
|
+
* URL of the page where the log occurred.
|
|
4547
|
+
* @format text
|
|
4548
|
+
*/
|
|
4549
|
+
page_url: string;
|
|
4550
|
+
}
|
|
4551
|
+
/** The type of console log. */
|
|
4552
|
+
export declare enum ConsoleLogType {
|
|
4553
|
+
Error = "error",
|
|
4554
|
+
Log = "log",
|
|
4555
|
+
Warn = "warn"
|
|
4556
|
+
}
|
|
4503
4557
|
/** content-template */
|
|
4504
4558
|
export type ContentTemplate = NotificationContentTemplate & {
|
|
4505
4559
|
type: ContentTemplateType;
|
|
@@ -4755,6 +4809,24 @@ export type ConversationSummary = AtomBaseSummary & {
|
|
|
4755
4809
|
*/
|
|
4756
4810
|
title?: string;
|
|
4757
4811
|
};
|
|
4812
|
+
/** conversations-convert-request */
|
|
4813
|
+
export type ConversationsConvertRequest = ConversationsConvertRequestTicket & {
|
|
4814
|
+
convert_to: ConversationsConvertRequestConvertTo;
|
|
4815
|
+
/**
|
|
4816
|
+
* The ID of the conversation to convert.
|
|
4817
|
+
* @format id
|
|
4818
|
+
*/
|
|
4819
|
+
id: string;
|
|
4820
|
+
};
|
|
4821
|
+
export declare enum ConversationsConvertRequestConvertTo {
|
|
4822
|
+
Ticket = "ticket"
|
|
4823
|
+
}
|
|
4824
|
+
/** conversations-convert-request-ticket */
|
|
4825
|
+
export type ConversationsConvertRequestTicket = object;
|
|
4826
|
+
/** conversations-convert-response */
|
|
4827
|
+
export interface ConversationsConvertResponse {
|
|
4828
|
+
job: JobSummary;
|
|
4829
|
+
}
|
|
4758
4830
|
/**
|
|
4759
4831
|
* conversations-create-request
|
|
4760
4832
|
* The request to create a new conversation.
|
|
@@ -5328,6 +5400,183 @@ export interface CreateAssociation {
|
|
|
5328
5400
|
*/
|
|
5329
5401
|
associated_to?: string;
|
|
5330
5402
|
}
|
|
5403
|
+
/** create-bar-visualization-x-axis */
|
|
5404
|
+
export interface CreateBarVisualizationXAxis {
|
|
5405
|
+
/**
|
|
5406
|
+
* The label description for the axis.
|
|
5407
|
+
* @format text
|
|
5408
|
+
*/
|
|
5409
|
+
axis_label?: string;
|
|
5410
|
+
color?: CreateVisualizationAxisColor;
|
|
5411
|
+
/** The drill through configurations for the axis. */
|
|
5412
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5413
|
+
/** Whether the axis should be hidden. */
|
|
5414
|
+
is_hidden?: boolean;
|
|
5415
|
+
/**
|
|
5416
|
+
* The label for the axis.
|
|
5417
|
+
* @format text
|
|
5418
|
+
*/
|
|
5419
|
+
label?: string;
|
|
5420
|
+
/**
|
|
5421
|
+
* The reference name of the axis.
|
|
5422
|
+
* @format text
|
|
5423
|
+
*/
|
|
5424
|
+
reference_name: string;
|
|
5425
|
+
}
|
|
5426
|
+
/** create-bar-visualization-y-axis */
|
|
5427
|
+
export interface CreateBarVisualizationYAxis {
|
|
5428
|
+
/**
|
|
5429
|
+
* The label description for the axis.
|
|
5430
|
+
* @format text
|
|
5431
|
+
*/
|
|
5432
|
+
axis_label?: string;
|
|
5433
|
+
color?: CreateVisualizationAxisColor;
|
|
5434
|
+
/** The drill through configurations for the axis. */
|
|
5435
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5436
|
+
/** Whether the axis should be hidden. */
|
|
5437
|
+
is_hidden?: boolean;
|
|
5438
|
+
/**
|
|
5439
|
+
* The label for the axis.
|
|
5440
|
+
* @format text
|
|
5441
|
+
*/
|
|
5442
|
+
label?: string;
|
|
5443
|
+
/**
|
|
5444
|
+
* The reference name of the axis.
|
|
5445
|
+
* @format text
|
|
5446
|
+
*/
|
|
5447
|
+
reference_name: string;
|
|
5448
|
+
}
|
|
5449
|
+
/** create-bar-widget-visualization */
|
|
5450
|
+
export interface CreateBarWidgetVisualization {
|
|
5451
|
+
data_labels?: CreateDataLabelConfig;
|
|
5452
|
+
/** Whether the bar should be stacked. */
|
|
5453
|
+
is_stacked?: boolean;
|
|
5454
|
+
rollup?: CreateVisualizationRollup;
|
|
5455
|
+
scrollbar?: CreateVisualizationScrollbar;
|
|
5456
|
+
/** Whether to show data labels. */
|
|
5457
|
+
show_data_labels?: boolean;
|
|
5458
|
+
/** The configuration for the X-axis. */
|
|
5459
|
+
x: CreateBarVisualizationXAxis[];
|
|
5460
|
+
/** The configuration for the Y-axes. */
|
|
5461
|
+
y: CreateBarVisualizationYAxis[];
|
|
5462
|
+
}
|
|
5463
|
+
/** create-column-visualization-x-axis */
|
|
5464
|
+
export interface CreateColumnVisualizationXAxis {
|
|
5465
|
+
/**
|
|
5466
|
+
* The label description for the axis.
|
|
5467
|
+
* @format text
|
|
5468
|
+
*/
|
|
5469
|
+
axis_label?: string;
|
|
5470
|
+
color?: CreateVisualizationAxisColor;
|
|
5471
|
+
/** The drill through configurations for the axis. */
|
|
5472
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5473
|
+
/** Whether the axis should be hidden. */
|
|
5474
|
+
is_hidden?: boolean;
|
|
5475
|
+
/**
|
|
5476
|
+
* The label for the axis.
|
|
5477
|
+
* @format text
|
|
5478
|
+
*/
|
|
5479
|
+
label?: string;
|
|
5480
|
+
/**
|
|
5481
|
+
* The reference name of the axis.
|
|
5482
|
+
* @format text
|
|
5483
|
+
*/
|
|
5484
|
+
reference_name: string;
|
|
5485
|
+
}
|
|
5486
|
+
/** create-column-visualization-y-axis */
|
|
5487
|
+
export interface CreateColumnVisualizationYAxis {
|
|
5488
|
+
/**
|
|
5489
|
+
* The label description for the axis.
|
|
5490
|
+
* @format text
|
|
5491
|
+
*/
|
|
5492
|
+
axis_label?: string;
|
|
5493
|
+
color?: CreateVisualizationAxisColor;
|
|
5494
|
+
/** The drill through configurations for the axis. */
|
|
5495
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5496
|
+
/** Whether the axis should be hidden. */
|
|
5497
|
+
is_hidden?: boolean;
|
|
5498
|
+
/**
|
|
5499
|
+
* The label for the axis.
|
|
5500
|
+
* @format text
|
|
5501
|
+
*/
|
|
5502
|
+
label?: string;
|
|
5503
|
+
/**
|
|
5504
|
+
* The reference name of the axis.
|
|
5505
|
+
* @format text
|
|
5506
|
+
*/
|
|
5507
|
+
reference_name: string;
|
|
5508
|
+
}
|
|
5509
|
+
/** create-column-widget-visualization */
|
|
5510
|
+
export interface CreateColumnWidgetVisualization {
|
|
5511
|
+
data_labels?: CreateDataLabelConfig;
|
|
5512
|
+
/** Whether the columns should be stacked. */
|
|
5513
|
+
is_stacked?: boolean;
|
|
5514
|
+
rollup?: CreateVisualizationRollup;
|
|
5515
|
+
scrollbar?: CreateVisualizationScrollbar;
|
|
5516
|
+
/** Whether to show data labels. */
|
|
5517
|
+
show_data_labels?: boolean;
|
|
5518
|
+
/** The configuration for the X-axis. */
|
|
5519
|
+
x: CreateColumnVisualizationXAxis[];
|
|
5520
|
+
/** The configuration for the Y-axes. */
|
|
5521
|
+
y: CreateColumnVisualizationYAxis[];
|
|
5522
|
+
}
|
|
5523
|
+
/** create-combination-visualization-x-axis */
|
|
5524
|
+
export interface CreateCombinationVisualizationXAxis {
|
|
5525
|
+
/**
|
|
5526
|
+
* The label description for the axis.
|
|
5527
|
+
* @format text
|
|
5528
|
+
*/
|
|
5529
|
+
axis_label?: string;
|
|
5530
|
+
color?: CreateVisualizationAxisColor;
|
|
5531
|
+
/** The drill through configurations for the axis. */
|
|
5532
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5533
|
+
/** Whether the axis should be hidden. */
|
|
5534
|
+
is_hidden?: boolean;
|
|
5535
|
+
/**
|
|
5536
|
+
* The label for the axis.
|
|
5537
|
+
* @format text
|
|
5538
|
+
*/
|
|
5539
|
+
label?: string;
|
|
5540
|
+
/**
|
|
5541
|
+
* The reference name of the axis.
|
|
5542
|
+
* @format text
|
|
5543
|
+
*/
|
|
5544
|
+
reference_name: string;
|
|
5545
|
+
}
|
|
5546
|
+
/** create-combination-visualization-y-axis */
|
|
5547
|
+
export interface CreateCombinationVisualizationYAxis {
|
|
5548
|
+
/**
|
|
5549
|
+
* The label description for the axis.
|
|
5550
|
+
* @format text
|
|
5551
|
+
*/
|
|
5552
|
+
axis_label?: string;
|
|
5553
|
+
color?: CreateVisualizationAxisColor;
|
|
5554
|
+
/** The drill through configurations for the axis. */
|
|
5555
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5556
|
+
/** Whether the axis should be hidden. */
|
|
5557
|
+
is_hidden?: boolean;
|
|
5558
|
+
/**
|
|
5559
|
+
* The label for the axis.
|
|
5560
|
+
* @format text
|
|
5561
|
+
*/
|
|
5562
|
+
label?: string;
|
|
5563
|
+
/**
|
|
5564
|
+
* The reference name of the axis.
|
|
5565
|
+
* @format text
|
|
5566
|
+
*/
|
|
5567
|
+
reference_name: string;
|
|
5568
|
+
}
|
|
5569
|
+
/** create-combination-widget-visualization */
|
|
5570
|
+
export interface CreateCombinationWidgetVisualization {
|
|
5571
|
+
drill_through?: CreateVisualizationAxisDrillThrough;
|
|
5572
|
+
rollup?: CreateVisualizationRollup;
|
|
5573
|
+
/** The configuration for series. */
|
|
5574
|
+
series: CreateSeriesVisualization[];
|
|
5575
|
+
/** The configuration for the X-axes. */
|
|
5576
|
+
x_axis: CreateCombinationVisualizationXAxis[];
|
|
5577
|
+
/** The configuration for the Y-axes. */
|
|
5578
|
+
y_axis: CreateCombinationVisualizationYAxis[];
|
|
5579
|
+
}
|
|
5331
5580
|
/** create-command-action */
|
|
5332
5581
|
export interface CreateCommandAction {
|
|
5333
5582
|
action_details?: CreateCommandActionDetails;
|
|
@@ -5374,6 +5623,189 @@ export interface CreateCommandSurface {
|
|
|
5374
5623
|
/** Surfaces from where this command can be invoked. */
|
|
5375
5624
|
surface: CommandSurfaceSurface;
|
|
5376
5625
|
}
|
|
5626
|
+
/** create-custom-field-widget-column-projection */
|
|
5627
|
+
export interface CreateCustomFieldWidgetColumnProjection {
|
|
5628
|
+
/**
|
|
5629
|
+
* The leaf type of the custom field.
|
|
5630
|
+
* @format text
|
|
5631
|
+
*/
|
|
5632
|
+
leaf_type: string;
|
|
5633
|
+
/**
|
|
5634
|
+
* The name of the custom field.
|
|
5635
|
+
* @format text
|
|
5636
|
+
*/
|
|
5637
|
+
name: string;
|
|
5638
|
+
/**
|
|
5639
|
+
* The subtype of the custom field.
|
|
5640
|
+
* @format text
|
|
5641
|
+
*/
|
|
5642
|
+
subtype?: string;
|
|
5643
|
+
}
|
|
5644
|
+
/** create-dashboard-filter */
|
|
5645
|
+
export interface CreateDashboardFilter {
|
|
5646
|
+
expression: CreateDashboardFilterExpression;
|
|
5647
|
+
/**
|
|
5648
|
+
* The reference ID of the tab, section, or widget to which this
|
|
5649
|
+
* filter applies to.
|
|
5650
|
+
* @format text
|
|
5651
|
+
*/
|
|
5652
|
+
reference_id: string;
|
|
5653
|
+
}
|
|
5654
|
+
/** create-dashboard-filter-condition */
|
|
5655
|
+
export interface CreateDashboardFilterCondition {
|
|
5656
|
+
/** The value to be compared. */
|
|
5657
|
+
json_value?: any;
|
|
5658
|
+
/**
|
|
5659
|
+
* The key to be compared.
|
|
5660
|
+
* @format text
|
|
5661
|
+
*/
|
|
5662
|
+
key: string;
|
|
5663
|
+
/** The operator used to compare the key and value. */
|
|
5664
|
+
operator: DashboardFilterConditionOperator;
|
|
5665
|
+
part_value?: CreateDashboardFilterPartCondition;
|
|
5666
|
+
relative_date_value?: CreateDashboardFilterRelativeDateCondition;
|
|
5667
|
+
/** The operator used to compare the key and value. */
|
|
5668
|
+
value_type: DashboardFilterConditionValueType;
|
|
5669
|
+
}
|
|
5670
|
+
/** create-dashboard-filter-expression */
|
|
5671
|
+
export interface CreateDashboardFilterExpression {
|
|
5672
|
+
/**
|
|
5673
|
+
* The operands used for the logical operation. Each operand can be
|
|
5674
|
+
* either a filter expression or a filter condition.
|
|
5675
|
+
*/
|
|
5676
|
+
operands: CreateDashboardFilterOperand[];
|
|
5677
|
+
/** The logical operator that binds the filter conditions or expressions. */
|
|
5678
|
+
operator: DashboardFilterExpressionOperator;
|
|
5679
|
+
}
|
|
5680
|
+
/** create-dashboard-filter-operand */
|
|
5681
|
+
export interface CreateDashboardFilterOperand {
|
|
5682
|
+
/**
|
|
5683
|
+
* The type of the operand. It can be either a filter expression or a
|
|
5684
|
+
* filter condition.
|
|
5685
|
+
*/
|
|
5686
|
+
type: DashboardFilterOperandType;
|
|
5687
|
+
condition?: CreateDashboardFilterCondition;
|
|
5688
|
+
expression?: CreateDashboardFilterExpression;
|
|
5689
|
+
}
|
|
5690
|
+
/** create-dashboard-filter-part-condition */
|
|
5691
|
+
export interface CreateDashboardFilterPartCondition {
|
|
5692
|
+
/** Whether to include child parts. */
|
|
5693
|
+
include_child_parts?: boolean;
|
|
5694
|
+
/** The part ids to be compared. */
|
|
5695
|
+
part?: string[];
|
|
5696
|
+
}
|
|
5697
|
+
/** create-dashboard-filter-quarter-and-year-value */
|
|
5698
|
+
export interface CreateDashboardFilterQuarterAndYearValue {
|
|
5699
|
+
/**
|
|
5700
|
+
* The quarter of the fiscal year.
|
|
5701
|
+
* @format int64
|
|
5702
|
+
*/
|
|
5703
|
+
quarter: number;
|
|
5704
|
+
/**
|
|
5705
|
+
* The year of the fiscal quarter.
|
|
5706
|
+
* @format int64
|
|
5707
|
+
*/
|
|
5708
|
+
year: number;
|
|
5709
|
+
}
|
|
5710
|
+
/** create-dashboard-filter-relative-date-condition */
|
|
5711
|
+
export interface CreateDashboardFilterRelativeDateCondition {
|
|
5712
|
+
/** The type of the relative date condition. */
|
|
5713
|
+
type: DashboardFilterRelativeDateConditionType;
|
|
5714
|
+
/**
|
|
5715
|
+
* Type of current period (today, this week, this month, this quarter,
|
|
5716
|
+
* this year).
|
|
5717
|
+
*/
|
|
5718
|
+
current_period_type?: DashboardFilterRelativeDateConditionCurrentPeriodType;
|
|
5719
|
+
custom_quarter_year_value?: CreateDashboardFilterQuarterAndYearValue;
|
|
5720
|
+
/**
|
|
5721
|
+
* Type of date range from the start of a fiscal period to the current
|
|
5722
|
+
* date.
|
|
5723
|
+
*/
|
|
5724
|
+
period_type?: DashboardFilterRelativeDateConditionPeriodType;
|
|
5725
|
+
/**
|
|
5726
|
+
* The relative time value to be compared.
|
|
5727
|
+
* @format int64
|
|
5728
|
+
*/
|
|
5729
|
+
value?: number;
|
|
5730
|
+
}
|
|
5731
|
+
/** create-data-label-config */
|
|
5732
|
+
export interface CreateDataLabelConfig {
|
|
5733
|
+
/** The display mode for data labels. */
|
|
5734
|
+
display_mode?: DataLabelConfigDisplayMode;
|
|
5735
|
+
/** Whether data labels are enabled. */
|
|
5736
|
+
enable?: boolean;
|
|
5737
|
+
}
|
|
5738
|
+
/** create-data-source-join */
|
|
5739
|
+
export interface CreateDataSourceJoin {
|
|
5740
|
+
/**
|
|
5741
|
+
* A reference name for the join.
|
|
5742
|
+
* @format text
|
|
5743
|
+
*/
|
|
5744
|
+
reference_name: string;
|
|
5745
|
+
/**
|
|
5746
|
+
* The name of the column in the source data source.
|
|
5747
|
+
* @format text
|
|
5748
|
+
*/
|
|
5749
|
+
source_reference_name: string;
|
|
5750
|
+
/**
|
|
5751
|
+
* The name of the column in the target data source.
|
|
5752
|
+
* @format text
|
|
5753
|
+
*/
|
|
5754
|
+
target_reference_name: string;
|
|
5755
|
+
}
|
|
5756
|
+
/** create-donut-visualization-x-axis */
|
|
5757
|
+
export interface CreateDonutVisualizationXAxis {
|
|
5758
|
+
/**
|
|
5759
|
+
* The label description for the axis.
|
|
5760
|
+
* @format text
|
|
5761
|
+
*/
|
|
5762
|
+
axis_label?: string;
|
|
5763
|
+
color?: CreateVisualizationAxisColor;
|
|
5764
|
+
/** The drill through configurations for the axis. */
|
|
5765
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5766
|
+
/** Whether the axis should be hidden. */
|
|
5767
|
+
is_hidden?: boolean;
|
|
5768
|
+
/**
|
|
5769
|
+
* The label for the axis.
|
|
5770
|
+
* @format text
|
|
5771
|
+
*/
|
|
5772
|
+
label?: string;
|
|
5773
|
+
/**
|
|
5774
|
+
* The reference name of the axis.
|
|
5775
|
+
* @format text
|
|
5776
|
+
*/
|
|
5777
|
+
reference_name: string;
|
|
5778
|
+
}
|
|
5779
|
+
/** create-donut-visualization-y-axis */
|
|
5780
|
+
export interface CreateDonutVisualizationYAxis {
|
|
5781
|
+
/**
|
|
5782
|
+
* The label description for the axis.
|
|
5783
|
+
* @format text
|
|
5784
|
+
*/
|
|
5785
|
+
axis_label?: string;
|
|
5786
|
+
color?: CreateVisualizationAxisColor;
|
|
5787
|
+
/** The drill through configurations for the axis. */
|
|
5788
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5789
|
+
/** Whether the axis should be hidden. */
|
|
5790
|
+
is_hidden?: boolean;
|
|
5791
|
+
/**
|
|
5792
|
+
* The label for the axis.
|
|
5793
|
+
* @format text
|
|
5794
|
+
*/
|
|
5795
|
+
label?: string;
|
|
5796
|
+
/**
|
|
5797
|
+
* The reference name of the axis.
|
|
5798
|
+
* @format text
|
|
5799
|
+
*/
|
|
5800
|
+
reference_name: string;
|
|
5801
|
+
}
|
|
5802
|
+
/** create-donut-widget-visualization */
|
|
5803
|
+
export interface CreateDonutWidgetVisualization {
|
|
5804
|
+
rollup?: CreateVisualizationRollup;
|
|
5805
|
+
/** The configuration for the X-axis. */
|
|
5806
|
+
x: CreateDonutVisualizationXAxis[];
|
|
5807
|
+
y: CreateDonutVisualizationYAxis;
|
|
5808
|
+
}
|
|
5377
5809
|
/**
|
|
5378
5810
|
* create-email-info
|
|
5379
5811
|
* Information related to an email.
|
|
@@ -5486,7 +5918,7 @@ export interface CreateExternalSourceDataComp {
|
|
|
5486
5918
|
* ID of the user that created the object in the source system.
|
|
5487
5919
|
* @format id
|
|
5488
5920
|
*/
|
|
5489
|
-
|
|
5921
|
+
created_by_id?: string;
|
|
5490
5922
|
/**
|
|
5491
5923
|
* Timestamp when the object was created in the source system.
|
|
5492
5924
|
* @format date-time
|
|
@@ -5497,7 +5929,7 @@ export interface CreateExternalSourceDataComp {
|
|
|
5497
5929
|
* ID of the user that last modified the object in the source system.
|
|
5498
5930
|
* @format id
|
|
5499
5931
|
*/
|
|
5500
|
-
|
|
5932
|
+
modified_by_id?: string;
|
|
5501
5933
|
/**
|
|
5502
5934
|
* Timestamp when the object was modified in the source system.
|
|
5503
5935
|
* @format date-time
|
|
@@ -5505,6 +5937,212 @@ export interface CreateExternalSourceDataComp {
|
|
|
5505
5937
|
*/
|
|
5506
5938
|
modified_date?: string;
|
|
5507
5939
|
}
|
|
5940
|
+
/** create-flame-graph-visualization-x-axis */
|
|
5941
|
+
export interface CreateFlameGraphVisualizationXAxis {
|
|
5942
|
+
/**
|
|
5943
|
+
* The label description for the axis.
|
|
5944
|
+
* @format text
|
|
5945
|
+
*/
|
|
5946
|
+
axis_label?: string;
|
|
5947
|
+
color?: CreateVisualizationAxisColor;
|
|
5948
|
+
/** The drill through configurations for the axis. */
|
|
5949
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5950
|
+
/** Whether the axis should be hidden. */
|
|
5951
|
+
is_hidden?: boolean;
|
|
5952
|
+
/**
|
|
5953
|
+
* The label for the axis.
|
|
5954
|
+
* @format text
|
|
5955
|
+
*/
|
|
5956
|
+
label?: string;
|
|
5957
|
+
/**
|
|
5958
|
+
* The reference name of the axis.
|
|
5959
|
+
* @format text
|
|
5960
|
+
*/
|
|
5961
|
+
reference_name: string;
|
|
5962
|
+
}
|
|
5963
|
+
/** create-flame-graph-visualization-y-axis */
|
|
5964
|
+
export interface CreateFlameGraphVisualizationYAxis {
|
|
5965
|
+
/**
|
|
5966
|
+
* The label description for the axis.
|
|
5967
|
+
* @format text
|
|
5968
|
+
*/
|
|
5969
|
+
axis_label?: string;
|
|
5970
|
+
color?: CreateVisualizationAxisColor;
|
|
5971
|
+
/** The drill through configurations for the axis. */
|
|
5972
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
5973
|
+
/** Whether the axis should be hidden. */
|
|
5974
|
+
is_hidden?: boolean;
|
|
5975
|
+
/**
|
|
5976
|
+
* The label for the axis.
|
|
5977
|
+
* @format text
|
|
5978
|
+
*/
|
|
5979
|
+
label?: string;
|
|
5980
|
+
/**
|
|
5981
|
+
* The reference name of the axis.
|
|
5982
|
+
* @format text
|
|
5983
|
+
*/
|
|
5984
|
+
reference_name: string;
|
|
5985
|
+
}
|
|
5986
|
+
/** create-flame-graph-widget-visualization */
|
|
5987
|
+
export interface CreateFlameGraphWidgetVisualization {
|
|
5988
|
+
/** The configuration for the X-axis. */
|
|
5989
|
+
x: CreateFlameGraphVisualizationXAxis[];
|
|
5990
|
+
/** The configuration for the Y-axes. */
|
|
5991
|
+
y: CreateFlameGraphVisualizationYAxis[];
|
|
5992
|
+
}
|
|
5993
|
+
/** create-gantt-widget-visualization */
|
|
5994
|
+
export interface CreateGanttWidgetVisualization {
|
|
5995
|
+
/**
|
|
5996
|
+
* The actual end date for the gantt visualization.
|
|
5997
|
+
* @format text
|
|
5998
|
+
*/
|
|
5999
|
+
actual_end_date?: string;
|
|
6000
|
+
/**
|
|
6001
|
+
* The actual start date for the gantt visualization.
|
|
6002
|
+
* @format text
|
|
6003
|
+
*/
|
|
6004
|
+
actual_start_date?: string;
|
|
6005
|
+
/**
|
|
6006
|
+
* The maximum number of items that can be returned for each group.
|
|
6007
|
+
* @format int64
|
|
6008
|
+
*/
|
|
6009
|
+
limit_per_group?: number;
|
|
6010
|
+
/**
|
|
6011
|
+
* The planned end date for the gantt visualization.
|
|
6012
|
+
* @format text
|
|
6013
|
+
*/
|
|
6014
|
+
planned_end_date?: string;
|
|
6015
|
+
/**
|
|
6016
|
+
* The planned start date for the gantt visualization.
|
|
6017
|
+
* @format text
|
|
6018
|
+
*/
|
|
6019
|
+
planned_start_date?: string;
|
|
6020
|
+
/** The time scale for the gantt visualization. */
|
|
6021
|
+
time_scale: GanttWidgetVisualizationTimeScale;
|
|
6022
|
+
}
|
|
6023
|
+
/** create-grid-layout */
|
|
6024
|
+
export interface CreateGridLayout {
|
|
6025
|
+
/** Layout of the elements within the current element. */
|
|
6026
|
+
layout?: CreateGridLayout[];
|
|
6027
|
+
position?: CreateGridPosition;
|
|
6028
|
+
/**
|
|
6029
|
+
* The reference ID for the element to be laid out. It should be an ID
|
|
6030
|
+
* of a tab, section, or widget.
|
|
6031
|
+
* @format text
|
|
6032
|
+
*/
|
|
6033
|
+
reference_id: string;
|
|
6034
|
+
}
|
|
6035
|
+
/** create-grid-position */
|
|
6036
|
+
export interface CreateGridPosition {
|
|
6037
|
+
/**
|
|
6038
|
+
* The height of the widget or section, in grid units.
|
|
6039
|
+
* @format int64
|
|
6040
|
+
*/
|
|
6041
|
+
height: number;
|
|
6042
|
+
/**
|
|
6043
|
+
* The width of the widget or section, in grid units.
|
|
6044
|
+
* @format int64
|
|
6045
|
+
*/
|
|
6046
|
+
width: number;
|
|
6047
|
+
/**
|
|
6048
|
+
* The x-coordinate of the top-left corner of the widget or section,
|
|
6049
|
+
* based on a grid system.
|
|
6050
|
+
* @format int64
|
|
6051
|
+
*/
|
|
6052
|
+
x: number;
|
|
6053
|
+
/**
|
|
6054
|
+
* The y-coordinate of the top-left corner of the widget or section,
|
|
6055
|
+
* based on a grid system.
|
|
6056
|
+
* @format int64
|
|
6057
|
+
*/
|
|
6058
|
+
y: number;
|
|
6059
|
+
}
|
|
6060
|
+
/** create-heatmap-visualization-x-axis */
|
|
6061
|
+
export interface CreateHeatmapVisualizationXAxis {
|
|
6062
|
+
/**
|
|
6063
|
+
* The label description for the axis.
|
|
6064
|
+
* @format text
|
|
6065
|
+
*/
|
|
6066
|
+
axis_label?: string;
|
|
6067
|
+
color?: CreateVisualizationAxisColor;
|
|
6068
|
+
/** The drill through configurations for the axis. */
|
|
6069
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6070
|
+
/** Whether the axis should be hidden. */
|
|
6071
|
+
is_hidden?: boolean;
|
|
6072
|
+
/**
|
|
6073
|
+
* The label for the axis.
|
|
6074
|
+
* @format text
|
|
6075
|
+
*/
|
|
6076
|
+
label?: string;
|
|
6077
|
+
/**
|
|
6078
|
+
* The minimum width of the heatmap block.
|
|
6079
|
+
* @format int64
|
|
6080
|
+
*/
|
|
6081
|
+
min_width?: number;
|
|
6082
|
+
/**
|
|
6083
|
+
* The reference name of the axis.
|
|
6084
|
+
* @format text
|
|
6085
|
+
*/
|
|
6086
|
+
reference_name: string;
|
|
6087
|
+
}
|
|
6088
|
+
/** create-heatmap-visualization-y-axis */
|
|
6089
|
+
export interface CreateHeatmapVisualizationYAxis {
|
|
6090
|
+
/**
|
|
6091
|
+
* The label description for the axis.
|
|
6092
|
+
* @format text
|
|
6093
|
+
*/
|
|
6094
|
+
axis_label?: string;
|
|
6095
|
+
color?: CreateVisualizationAxisColor;
|
|
6096
|
+
/** The drill through configurations for the axis. */
|
|
6097
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6098
|
+
/** Whether the axis should be hidden. */
|
|
6099
|
+
is_hidden?: boolean;
|
|
6100
|
+
/**
|
|
6101
|
+
* The label for the axis.
|
|
6102
|
+
* @format text
|
|
6103
|
+
*/
|
|
6104
|
+
label?: string;
|
|
6105
|
+
/**
|
|
6106
|
+
* The reference name of the axis.
|
|
6107
|
+
* @format text
|
|
6108
|
+
*/
|
|
6109
|
+
reference_name: string;
|
|
6110
|
+
}
|
|
6111
|
+
/** create-heatmap-visualization-z-axis */
|
|
6112
|
+
export interface CreateHeatmapVisualizationZAxis {
|
|
6113
|
+
/**
|
|
6114
|
+
* The label description for the axis.
|
|
6115
|
+
* @format text
|
|
6116
|
+
*/
|
|
6117
|
+
axis_label?: string;
|
|
6118
|
+
color?: CreateVisualizationAxisColor;
|
|
6119
|
+
/** The drill through configurations for the axis. */
|
|
6120
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6121
|
+
/** Whether the axis should be hidden. */
|
|
6122
|
+
is_hidden?: boolean;
|
|
6123
|
+
/**
|
|
6124
|
+
* The label for the axis.
|
|
6125
|
+
* @format text
|
|
6126
|
+
*/
|
|
6127
|
+
label?: string;
|
|
6128
|
+
/**
|
|
6129
|
+
* The reference name of the axis.
|
|
6130
|
+
* @format text
|
|
6131
|
+
*/
|
|
6132
|
+
reference_name: string;
|
|
6133
|
+
}
|
|
6134
|
+
/** create-heatmap-widget-visualization */
|
|
6135
|
+
export interface CreateHeatmapWidgetVisualization {
|
|
6136
|
+
/**
|
|
6137
|
+
* Color for heatmap.
|
|
6138
|
+
* @format text
|
|
6139
|
+
*/
|
|
6140
|
+
color?: string;
|
|
6141
|
+
rollup?: CreateVisualizationRollup;
|
|
6142
|
+
x: CreateHeatmapVisualizationXAxis;
|
|
6143
|
+
y: CreateHeatmapVisualizationYAxis;
|
|
6144
|
+
z: CreateHeatmapVisualizationZAxis;
|
|
6145
|
+
}
|
|
5508
6146
|
/** create-impacted-customer-details */
|
|
5509
6147
|
export interface CreateImpactedCustomerDetails {
|
|
5510
6148
|
/**
|
|
@@ -5515,6 +6153,183 @@ export interface CreateImpactedCustomerDetails {
|
|
|
5515
6153
|
/** List of customers impacted due to the incident. */
|
|
5516
6154
|
customer_ids?: string[];
|
|
5517
6155
|
}
|
|
6156
|
+
/** create-kanban-visualization-card-attribute */
|
|
6157
|
+
export interface CreateKanbanVisualizationCardAttribute {
|
|
6158
|
+
/**
|
|
6159
|
+
* The label description for the axis.
|
|
6160
|
+
* @format text
|
|
6161
|
+
*/
|
|
6162
|
+
axis_label?: string;
|
|
6163
|
+
color?: CreateVisualizationAxisColor;
|
|
6164
|
+
/** The drill through configurations for the axis. */
|
|
6165
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6166
|
+
/** Whether the axis should be hidden. */
|
|
6167
|
+
is_hidden?: boolean;
|
|
6168
|
+
/**
|
|
6169
|
+
* The label for the axis.
|
|
6170
|
+
* @format text
|
|
6171
|
+
*/
|
|
6172
|
+
label?: string;
|
|
6173
|
+
/**
|
|
6174
|
+
* The order in which the attribute should be displayed in a card.
|
|
6175
|
+
* @format int64
|
|
6176
|
+
*/
|
|
6177
|
+
order?: number;
|
|
6178
|
+
/**
|
|
6179
|
+
* Whether the attribute should be placed in the body or footer of the
|
|
6180
|
+
* kanban.
|
|
6181
|
+
*/
|
|
6182
|
+
position?: KanbanVisualizationCardAttributePosition;
|
|
6183
|
+
/**
|
|
6184
|
+
* The reference name of the axis.
|
|
6185
|
+
* @format text
|
|
6186
|
+
*/
|
|
6187
|
+
reference_name: string;
|
|
6188
|
+
}
|
|
6189
|
+
/** create-kanban-widget-visualization */
|
|
6190
|
+
export interface CreateKanbanWidgetVisualization {
|
|
6191
|
+
/** The configuration for the card in the kanban. */
|
|
6192
|
+
card_attributes: CreateKanbanVisualizationCardAttribute[];
|
|
6193
|
+
/**
|
|
6194
|
+
* The card load limit for the kanban.
|
|
6195
|
+
* @format int64
|
|
6196
|
+
*/
|
|
6197
|
+
card_load_limit?: number;
|
|
6198
|
+
/**
|
|
6199
|
+
* The group_by configuration in the kanban.
|
|
6200
|
+
* @deprecated
|
|
6201
|
+
*/
|
|
6202
|
+
group_by?: CreateWidgetGroupByConfig[];
|
|
6203
|
+
/** The hidden columns for the kanban. */
|
|
6204
|
+
hidden_columns?: string[];
|
|
6205
|
+
/** The hidden rows for the kanban. */
|
|
6206
|
+
hidden_rows?: string[];
|
|
6207
|
+
/**
|
|
6208
|
+
* The maximum number of items that can be returned for each group.
|
|
6209
|
+
* @format int64
|
|
6210
|
+
*/
|
|
6211
|
+
limit_per_group?: number;
|
|
6212
|
+
}
|
|
6213
|
+
/** create-line-visualization-x-axis */
|
|
6214
|
+
export interface CreateLineVisualizationXAxis {
|
|
6215
|
+
/**
|
|
6216
|
+
* The label description for the axis.
|
|
6217
|
+
* @format text
|
|
6218
|
+
*/
|
|
6219
|
+
axis_label?: string;
|
|
6220
|
+
color?: CreateVisualizationAxisColor;
|
|
6221
|
+
/** The drill through configurations for the axis. */
|
|
6222
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6223
|
+
/** Whether the axis should be hidden. */
|
|
6224
|
+
is_hidden?: boolean;
|
|
6225
|
+
/**
|
|
6226
|
+
* The label for the axis.
|
|
6227
|
+
* @format text
|
|
6228
|
+
*/
|
|
6229
|
+
label?: string;
|
|
6230
|
+
/**
|
|
6231
|
+
* The reference name of the axis.
|
|
6232
|
+
* @format text
|
|
6233
|
+
*/
|
|
6234
|
+
reference_name: string;
|
|
6235
|
+
}
|
|
6236
|
+
/** create-line-visualization-y-axis */
|
|
6237
|
+
export interface CreateLineVisualizationYAxis {
|
|
6238
|
+
/**
|
|
6239
|
+
* The label description for the axis.
|
|
6240
|
+
* @format text
|
|
6241
|
+
*/
|
|
6242
|
+
axis_label?: string;
|
|
6243
|
+
color?: CreateVisualizationAxisColor;
|
|
6244
|
+
/** The drill through configurations for the axis. */
|
|
6245
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6246
|
+
/** Whether the area under the line should be filled. */
|
|
6247
|
+
is_area_filled?: boolean;
|
|
6248
|
+
/** Whether the axis should be hidden. */
|
|
6249
|
+
is_hidden?: boolean;
|
|
6250
|
+
/** Whether the line should be a spline. */
|
|
6251
|
+
is_spline?: boolean;
|
|
6252
|
+
/**
|
|
6253
|
+
* The label for the axis.
|
|
6254
|
+
* @format text
|
|
6255
|
+
*/
|
|
6256
|
+
label?: string;
|
|
6257
|
+
/** Whether the line have circular marker. */
|
|
6258
|
+
marker?: boolean;
|
|
6259
|
+
/**
|
|
6260
|
+
* The reference name of the axis.
|
|
6261
|
+
* @format text
|
|
6262
|
+
*/
|
|
6263
|
+
reference_name: string;
|
|
6264
|
+
/** The stroke style for the line. */
|
|
6265
|
+
stroke_style?: LineVisualizationYAxisStrokeStyle;
|
|
6266
|
+
}
|
|
6267
|
+
/** create-line-widget-visualization */
|
|
6268
|
+
export interface CreateLineWidgetVisualization {
|
|
6269
|
+
data_labels?: CreateDataLabelConfig;
|
|
6270
|
+
/** Whether the line should be stacked. */
|
|
6271
|
+
is_stacked?: boolean;
|
|
6272
|
+
rollup?: CreateVisualizationRollup;
|
|
6273
|
+
/** Whether to show data labels. */
|
|
6274
|
+
show_data_labels?: boolean;
|
|
6275
|
+
/** The configuration for the X-axes. */
|
|
6276
|
+
x: CreateLineVisualizationXAxis[];
|
|
6277
|
+
/** The configuration for the Y-axes. */
|
|
6278
|
+
y: CreateLineVisualizationYAxis[];
|
|
6279
|
+
}
|
|
6280
|
+
/** create-meerkat-widget-column-function */
|
|
6281
|
+
export interface CreateMeerkatWidgetColumnFunction {
|
|
6282
|
+
/** The type of the function. */
|
|
6283
|
+
type: MeerkatWidgetColumnFunctionType;
|
|
6284
|
+
}
|
|
6285
|
+
/** create-meerkat-widget-column-projection */
|
|
6286
|
+
export interface CreateMeerkatWidgetColumnProjection {
|
|
6287
|
+
/** The data type of the column generated by the SQL expression. */
|
|
6288
|
+
type: MeerkatWidgetColumnProjectionType;
|
|
6289
|
+
function?: CreateMeerkatWidgetColumnFunction;
|
|
6290
|
+
/**
|
|
6291
|
+
* The SQL expression used to extract or transform the column from the
|
|
6292
|
+
* data source.
|
|
6293
|
+
* @format text
|
|
6294
|
+
*/
|
|
6295
|
+
sql_expression: string;
|
|
6296
|
+
/**
|
|
6297
|
+
* Deprecated: Use widget_query_column_config with type=timestamp on
|
|
6298
|
+
* widget_query.dimension_configs instead. The rollup granularity for the
|
|
6299
|
+
* timestamp.
|
|
6300
|
+
*/
|
|
6301
|
+
timestamp_rollup?: MeerkatWidgetColumnProjectionTimestampRollup;
|
|
6302
|
+
}
|
|
6303
|
+
/** create-metric-visualization-y-axis */
|
|
6304
|
+
export interface CreateMetricVisualizationYAxis {
|
|
6305
|
+
/**
|
|
6306
|
+
* The label description for the axis.
|
|
6307
|
+
* @format text
|
|
6308
|
+
*/
|
|
6309
|
+
axis_label?: string;
|
|
6310
|
+
color?: CreateVisualizationAxisColor;
|
|
6311
|
+
/** The drill through configurations for the axis. */
|
|
6312
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6313
|
+
/** Whether the axis should be hidden. */
|
|
6314
|
+
is_hidden?: boolean;
|
|
6315
|
+
/**
|
|
6316
|
+
* The label for the axis.
|
|
6317
|
+
* @format text
|
|
6318
|
+
*/
|
|
6319
|
+
label?: string;
|
|
6320
|
+
/**
|
|
6321
|
+
* The reference name of the axis.
|
|
6322
|
+
* @format text
|
|
6323
|
+
*/
|
|
6324
|
+
reference_name: string;
|
|
6325
|
+
}
|
|
6326
|
+
/** create-metric-widget-visualization */
|
|
6327
|
+
export interface CreateMetricWidgetVisualization {
|
|
6328
|
+
pvp?: CreateWidgetPvpConfig;
|
|
6329
|
+
rollup?: CreateVisualizationRollup;
|
|
6330
|
+
/** The configuration for the Y-axis. */
|
|
6331
|
+
y: CreateMetricVisualizationYAxis[];
|
|
6332
|
+
}
|
|
5518
6333
|
/** create-org-schedule-interval */
|
|
5519
6334
|
export interface CreateOrgScheduleInterval {
|
|
5520
6335
|
/**
|
|
@@ -5542,6 +6357,231 @@ export interface CreateOrgScheduleInterval {
|
|
|
5542
6357
|
*/
|
|
5543
6358
|
to?: string;
|
|
5544
6359
|
}
|
|
6360
|
+
/** create-packed-bubble-visualization-x-axis */
|
|
6361
|
+
export interface CreatePackedBubbleVisualizationXAxis {
|
|
6362
|
+
/**
|
|
6363
|
+
* The label description for the axis.
|
|
6364
|
+
* @format text
|
|
6365
|
+
*/
|
|
6366
|
+
axis_label?: string;
|
|
6367
|
+
color?: CreateVisualizationAxisColor;
|
|
6368
|
+
/** The drill through configurations for the axis. */
|
|
6369
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6370
|
+
/** Whether the axis should be hidden. */
|
|
6371
|
+
is_hidden?: boolean;
|
|
6372
|
+
/**
|
|
6373
|
+
* The label for the axis.
|
|
6374
|
+
* @format text
|
|
6375
|
+
*/
|
|
6376
|
+
label?: string;
|
|
6377
|
+
/**
|
|
6378
|
+
* The reference name of the axis.
|
|
6379
|
+
* @format text
|
|
6380
|
+
*/
|
|
6381
|
+
reference_name: string;
|
|
6382
|
+
}
|
|
6383
|
+
/** create-packed-bubble-visualization-y-axis */
|
|
6384
|
+
export interface CreatePackedBubbleVisualizationYAxis {
|
|
6385
|
+
/**
|
|
6386
|
+
* The label description for the axis.
|
|
6387
|
+
* @format text
|
|
6388
|
+
*/
|
|
6389
|
+
axis_label?: string;
|
|
6390
|
+
color?: CreateVisualizationAxisColor;
|
|
6391
|
+
/** The drill through configurations for the axis. */
|
|
6392
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6393
|
+
/** Whether the axis should be hidden. */
|
|
6394
|
+
is_hidden?: boolean;
|
|
6395
|
+
/**
|
|
6396
|
+
* The label for the axis.
|
|
6397
|
+
* @format text
|
|
6398
|
+
*/
|
|
6399
|
+
label?: string;
|
|
6400
|
+
/**
|
|
6401
|
+
* The reference name of the axis.
|
|
6402
|
+
* @format text
|
|
6403
|
+
*/
|
|
6404
|
+
reference_name: string;
|
|
6405
|
+
}
|
|
6406
|
+
/** create-packed-bubble-widget-visualization */
|
|
6407
|
+
export interface CreatePackedBubbleWidgetVisualization {
|
|
6408
|
+
/** The configuration for the X-axis. */
|
|
6409
|
+
x: CreatePackedBubbleVisualizationXAxis[];
|
|
6410
|
+
/** The configuration for the Y-axes. */
|
|
6411
|
+
y: CreatePackedBubbleVisualizationYAxis[];
|
|
6412
|
+
}
|
|
6413
|
+
/** create-pie-visualization-x-axis */
|
|
6414
|
+
export interface CreatePieVisualizationXAxis {
|
|
6415
|
+
/**
|
|
6416
|
+
* The label description for the axis.
|
|
6417
|
+
* @format text
|
|
6418
|
+
*/
|
|
6419
|
+
axis_label?: string;
|
|
6420
|
+
color?: CreateVisualizationAxisColor;
|
|
6421
|
+
/** The drill through configurations for the axis. */
|
|
6422
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6423
|
+
/** Whether the axis should be hidden. */
|
|
6424
|
+
is_hidden?: boolean;
|
|
6425
|
+
/**
|
|
6426
|
+
* The label for the axis.
|
|
6427
|
+
* @format text
|
|
6428
|
+
*/
|
|
6429
|
+
label?: string;
|
|
6430
|
+
/**
|
|
6431
|
+
* The reference name of the axis.
|
|
6432
|
+
* @format text
|
|
6433
|
+
*/
|
|
6434
|
+
reference_name: string;
|
|
6435
|
+
}
|
|
6436
|
+
/** create-pie-visualization-y-axis */
|
|
6437
|
+
export interface CreatePieVisualizationYAxis {
|
|
6438
|
+
/**
|
|
6439
|
+
* The label description for the axis.
|
|
6440
|
+
* @format text
|
|
6441
|
+
*/
|
|
6442
|
+
axis_label?: string;
|
|
6443
|
+
color?: CreateVisualizationAxisColor;
|
|
6444
|
+
/** The drill through configurations for the axis. */
|
|
6445
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6446
|
+
/** Whether the axis should be hidden. */
|
|
6447
|
+
is_hidden?: boolean;
|
|
6448
|
+
/**
|
|
6449
|
+
* The label for the axis.
|
|
6450
|
+
* @format text
|
|
6451
|
+
*/
|
|
6452
|
+
label?: string;
|
|
6453
|
+
/**
|
|
6454
|
+
* The reference name of the axis.
|
|
6455
|
+
* @format text
|
|
6456
|
+
*/
|
|
6457
|
+
reference_name: string;
|
|
6458
|
+
}
|
|
6459
|
+
/** create-pie-widget-visualization */
|
|
6460
|
+
export interface CreatePieWidgetVisualization {
|
|
6461
|
+
rollup?: CreateVisualizationRollup;
|
|
6462
|
+
/** The configuration for the X-axis. */
|
|
6463
|
+
x: CreatePieVisualizationXAxis[];
|
|
6464
|
+
y: CreatePieVisualizationYAxis;
|
|
6465
|
+
}
|
|
6466
|
+
/** create-rich-text-widget-visualization */
|
|
6467
|
+
export interface CreateRichTextWidgetVisualization {
|
|
6468
|
+
/** The content of the rich text. */
|
|
6469
|
+
content: object;
|
|
6470
|
+
}
|
|
6471
|
+
/** create-scatter-visualization-x-axis */
|
|
6472
|
+
export interface CreateScatterVisualizationXAxis {
|
|
6473
|
+
/**
|
|
6474
|
+
* The label description for the axis.
|
|
6475
|
+
* @format text
|
|
6476
|
+
*/
|
|
6477
|
+
axis_label?: string;
|
|
6478
|
+
color?: CreateVisualizationAxisColor;
|
|
6479
|
+
/** The drill through configurations for the axis. */
|
|
6480
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6481
|
+
/** Whether the axis should be hidden. */
|
|
6482
|
+
is_hidden?: boolean;
|
|
6483
|
+
/**
|
|
6484
|
+
* The label for the axis.
|
|
6485
|
+
* @format text
|
|
6486
|
+
*/
|
|
6487
|
+
label?: string;
|
|
6488
|
+
/**
|
|
6489
|
+
* The reference name of the axis.
|
|
6490
|
+
* @format text
|
|
6491
|
+
*/
|
|
6492
|
+
reference_name: string;
|
|
6493
|
+
}
|
|
6494
|
+
/** create-scatter-visualization-y-axis */
|
|
6495
|
+
export interface CreateScatterVisualizationYAxis {
|
|
6496
|
+
/**
|
|
6497
|
+
* The label description for the axis.
|
|
6498
|
+
* @format text
|
|
6499
|
+
*/
|
|
6500
|
+
axis_label?: string;
|
|
6501
|
+
color?: CreateVisualizationAxisColor;
|
|
6502
|
+
/** The drill through configurations for the axis. */
|
|
6503
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6504
|
+
/** Whether the axis should be hidden. */
|
|
6505
|
+
is_hidden?: boolean;
|
|
6506
|
+
/**
|
|
6507
|
+
* The label for the axis.
|
|
6508
|
+
* @format text
|
|
6509
|
+
*/
|
|
6510
|
+
label?: string;
|
|
6511
|
+
/**
|
|
6512
|
+
* The reference name of the axis.
|
|
6513
|
+
* @format text
|
|
6514
|
+
*/
|
|
6515
|
+
reference_name: string;
|
|
6516
|
+
}
|
|
6517
|
+
/** create-scatter-widget-visualization */
|
|
6518
|
+
export interface CreateScatterWidgetVisualization {
|
|
6519
|
+
rollup?: CreateVisualizationRollup;
|
|
6520
|
+
/** The configuration for the X-axis. */
|
|
6521
|
+
x: CreateScatterVisualizationXAxis[];
|
|
6522
|
+
/** The configuration for the Y-axes. */
|
|
6523
|
+
y: CreateScatterVisualizationYAxis[];
|
|
6524
|
+
}
|
|
6525
|
+
/** create-series-visualization */
|
|
6526
|
+
export interface CreateSeriesVisualization {
|
|
6527
|
+
/** The type of the series. */
|
|
6528
|
+
type?: SeriesVisualizationType;
|
|
6529
|
+
/**
|
|
6530
|
+
* Color key for the series.
|
|
6531
|
+
* @format text
|
|
6532
|
+
*/
|
|
6533
|
+
color_key?: string;
|
|
6534
|
+
data_labels?: CreateDataLabelConfig;
|
|
6535
|
+
drill_through?: CreateVisualizationAxisDrillThrough;
|
|
6536
|
+
/** Whether the area under the line should be filled. */
|
|
6537
|
+
is_area_filled?: boolean;
|
|
6538
|
+
/** Whether the line should be a spline. */
|
|
6539
|
+
is_spline?: boolean;
|
|
6540
|
+
/** Whether the series should be visible. */
|
|
6541
|
+
is_visible?: boolean;
|
|
6542
|
+
/** Whether the line have circular marker. */
|
|
6543
|
+
marker?: boolean;
|
|
6544
|
+
/**
|
|
6545
|
+
* Name of the series.
|
|
6546
|
+
* @format text
|
|
6547
|
+
*/
|
|
6548
|
+
name?: string;
|
|
6549
|
+
/**
|
|
6550
|
+
* Name key for the series.
|
|
6551
|
+
* @format text
|
|
6552
|
+
*/
|
|
6553
|
+
name_key?: string;
|
|
6554
|
+
scrollbar?: CreateVisualizationScrollbar;
|
|
6555
|
+
/** Whether to show data labels. */
|
|
6556
|
+
show_data_labels?: boolean;
|
|
6557
|
+
/**
|
|
6558
|
+
* Stack for the series.
|
|
6559
|
+
* @format text
|
|
6560
|
+
*/
|
|
6561
|
+
stack?: string;
|
|
6562
|
+
/** The stroke style for the line. */
|
|
6563
|
+
stroke_style?: SeriesVisualizationStrokeStyle;
|
|
6564
|
+
/**
|
|
6565
|
+
* X axis data for the series.
|
|
6566
|
+
* @format text
|
|
6567
|
+
*/
|
|
6568
|
+
x?: string;
|
|
6569
|
+
/**
|
|
6570
|
+
* X axis for the series.
|
|
6571
|
+
* @format int64
|
|
6572
|
+
*/
|
|
6573
|
+
x_axis?: number;
|
|
6574
|
+
/**
|
|
6575
|
+
* Y axis data for the series.
|
|
6576
|
+
* @format text
|
|
6577
|
+
*/
|
|
6578
|
+
y?: string;
|
|
6579
|
+
/**
|
|
6580
|
+
* Y axis for the series.
|
|
6581
|
+
* @format int64
|
|
6582
|
+
*/
|
|
6583
|
+
y_axis?: number;
|
|
6584
|
+
}
|
|
5545
6585
|
/**
|
|
5546
6586
|
* create-stage
|
|
5547
6587
|
* Create object for stage.
|
|
@@ -5641,6 +6681,24 @@ export interface CreateStarterMessageNudgeWidget {
|
|
|
5641
6681
|
starter_message_nudge_type: CreateStarterMessageNudgeWidgetStarterMessageNudgeType;
|
|
5642
6682
|
}
|
|
5643
6683
|
export type CreateStarterMessageNudgeWidgetStarterMessageNudgeType = string;
|
|
6684
|
+
/** create-sub-widget */
|
|
6685
|
+
export interface CreateSubWidget {
|
|
6686
|
+
/** A unified query language for DevRev objects. */
|
|
6687
|
+
dql_query?: DevrevQuery;
|
|
6688
|
+
query?: CreateWidgetQuery;
|
|
6689
|
+
/**
|
|
6690
|
+
* A reference ID for the sub-widget. It should be unique within the
|
|
6691
|
+
* widget.
|
|
6692
|
+
* @format text
|
|
6693
|
+
*/
|
|
6694
|
+
reference_id: string;
|
|
6695
|
+
/**
|
|
6696
|
+
* The title of the sub widget.
|
|
6697
|
+
* @format text
|
|
6698
|
+
*/
|
|
6699
|
+
title?: string;
|
|
6700
|
+
visualization: CreateWidgetVisualization;
|
|
6701
|
+
}
|
|
5644
6702
|
/** create-sync-in */
|
|
5645
6703
|
export interface CreateSyncIn {
|
|
5646
6704
|
/** Status of the sync for the object. */
|
|
@@ -5802,6 +6860,99 @@ export interface CreateSyncUnitReconciliationScenario {
|
|
|
5802
6860
|
*/
|
|
5803
6861
|
extract_to_date: string;
|
|
5804
6862
|
}
|
|
6863
|
+
/** create-table-data-storage */
|
|
6864
|
+
export interface CreateTableDataStorage {
|
|
6865
|
+
/** The type of data storage. */
|
|
6866
|
+
type: TableDataStorageType;
|
|
6867
|
+
/**
|
|
6868
|
+
* The inline snapshot of the data. Set when type is inline.
|
|
6869
|
+
* @format text
|
|
6870
|
+
*/
|
|
6871
|
+
inline_data?: string;
|
|
6872
|
+
/**
|
|
6873
|
+
* The URL of the data. Set when data is stored externally.
|
|
6874
|
+
* @format text
|
|
6875
|
+
*/
|
|
6876
|
+
url?: string;
|
|
6877
|
+
}
|
|
6878
|
+
/** create-table-visualization-column */
|
|
6879
|
+
export interface CreateTableVisualizationColumn {
|
|
6880
|
+
/**
|
|
6881
|
+
* The label description for the axis.
|
|
6882
|
+
* @format text
|
|
6883
|
+
*/
|
|
6884
|
+
axis_label?: string;
|
|
6885
|
+
color?: CreateVisualizationAxisColor;
|
|
6886
|
+
/** The drill through configurations for the axis. */
|
|
6887
|
+
drill_throughs?: CreateVisualizationAxisDrillThrough[];
|
|
6888
|
+
/** Whether the axis should be hidden. */
|
|
6889
|
+
is_hidden?: boolean;
|
|
6890
|
+
/** Whether the column should be movable. */
|
|
6891
|
+
is_movable?: boolean;
|
|
6892
|
+
/** Whether the column should be pinned, by default set to false. */
|
|
6893
|
+
is_pinned?: boolean;
|
|
6894
|
+
/** Whether the column should be resizable. */
|
|
6895
|
+
is_resizable?: boolean;
|
|
6896
|
+
/** Whether the column should be sortable. */
|
|
6897
|
+
is_sortable?: boolean;
|
|
6898
|
+
/** Whether the column visibility can be toggled. */
|
|
6899
|
+
is_visibility_togglable?: boolean;
|
|
6900
|
+
/**
|
|
6901
|
+
* The label for the axis.
|
|
6902
|
+
* @format text
|
|
6903
|
+
*/
|
|
6904
|
+
label?: string;
|
|
6905
|
+
/**
|
|
6906
|
+
* Whether the column should be locked to the left or right side of the
|
|
6907
|
+
* table.
|
|
6908
|
+
*/
|
|
6909
|
+
lock_position?: TableVisualizationColumnLockPosition;
|
|
6910
|
+
/**
|
|
6911
|
+
* The maximum width of the column.
|
|
6912
|
+
* @format int64
|
|
6913
|
+
*/
|
|
6914
|
+
max_width?: number;
|
|
6915
|
+
/**
|
|
6916
|
+
* The minimum width of the column.
|
|
6917
|
+
* @format int64
|
|
6918
|
+
*/
|
|
6919
|
+
min_width?: number;
|
|
6920
|
+
/**
|
|
6921
|
+
* The order in which the column should be displayed.
|
|
6922
|
+
* @format int64
|
|
6923
|
+
*/
|
|
6924
|
+
order?: number;
|
|
6925
|
+
/**
|
|
6926
|
+
* Whether the column should be pinned to the left or right side of the
|
|
6927
|
+
* table.
|
|
6928
|
+
*/
|
|
6929
|
+
pin_position?: TableVisualizationColumnPinPosition;
|
|
6930
|
+
/**
|
|
6931
|
+
* The reference name of the axis.
|
|
6932
|
+
* @format text
|
|
6933
|
+
*/
|
|
6934
|
+
reference_name: string;
|
|
6935
|
+
/**
|
|
6936
|
+
* The width of the column in pixel.
|
|
6937
|
+
* @format int64
|
|
6938
|
+
*/
|
|
6939
|
+
width?: number;
|
|
6940
|
+
}
|
|
6941
|
+
/** create-table-widget-visualization */
|
|
6942
|
+
export interface CreateTableWidgetVisualization {
|
|
6943
|
+
/** The configuration for the columns in the table. */
|
|
6944
|
+
columns: CreateTableVisualizationColumn[];
|
|
6945
|
+
/** The group_by configuration in the table. */
|
|
6946
|
+
group_by?: CreateWidgetGroupByConfig[];
|
|
6947
|
+
/** Whether the table is static. */
|
|
6948
|
+
is_static?: boolean;
|
|
6949
|
+
/**
|
|
6950
|
+
* The maximum number of items that can be returned for each group.
|
|
6951
|
+
* @format int64
|
|
6952
|
+
*/
|
|
6953
|
+
limit_per_group?: number;
|
|
6954
|
+
rollup?: CreateVisualizationRollup;
|
|
6955
|
+
}
|
|
5805
6956
|
/**
|
|
5806
6957
|
* create-tag-with-value
|
|
5807
6958
|
* Create object for tag_summary.
|
|
@@ -5819,6 +6970,56 @@ export interface CreateTagWithValue {
|
|
|
5819
6970
|
*/
|
|
5820
6971
|
value?: string;
|
|
5821
6972
|
}
|
|
6973
|
+
/** create-visualization-axis-color */
|
|
6974
|
+
export interface CreateVisualizationAxisColor {
|
|
6975
|
+
/** The type of the color. */
|
|
6976
|
+
type: VisualizationAxisColorType;
|
|
6977
|
+
/** The key lookup color. */
|
|
6978
|
+
key_lookup?: CreateVisualizationAxisColorKeyLookup[];
|
|
6979
|
+
/**
|
|
6980
|
+
* The static color.
|
|
6981
|
+
* @format text
|
|
6982
|
+
*/
|
|
6983
|
+
static?: string;
|
|
6984
|
+
}
|
|
6985
|
+
/** create-visualization-axis-color-key-lookup */
|
|
6986
|
+
export interface CreateVisualizationAxisColorKeyLookup {
|
|
6987
|
+
/**
|
|
6988
|
+
* The key to map to a color.
|
|
6989
|
+
* @format text
|
|
6990
|
+
*/
|
|
6991
|
+
key: string;
|
|
6992
|
+
/**
|
|
6993
|
+
* The color value.
|
|
6994
|
+
* @format text
|
|
6995
|
+
*/
|
|
6996
|
+
value: string;
|
|
6997
|
+
}
|
|
6998
|
+
/** create-visualization-axis-drill-through */
|
|
6999
|
+
export interface CreateVisualizationAxisDrillThrough {
|
|
7000
|
+
/**
|
|
7001
|
+
* The ID of the dashboard to navigate to when the axis is clicked.
|
|
7002
|
+
* @format id
|
|
7003
|
+
*/
|
|
7004
|
+
dashboard: string;
|
|
7005
|
+
/**
|
|
7006
|
+
* The label for the drill through.
|
|
7007
|
+
* @format text
|
|
7008
|
+
*/
|
|
7009
|
+
label: string;
|
|
7010
|
+
}
|
|
7011
|
+
/** create-visualization-rollup */
|
|
7012
|
+
export interface CreateVisualizationRollup {
|
|
7013
|
+
/** Whether the visualization should be auto-rolled up. */
|
|
7014
|
+
auto_rollup?: boolean;
|
|
7015
|
+
/** The supported rollup types. */
|
|
7016
|
+
supported_rollups?: string[];
|
|
7017
|
+
}
|
|
7018
|
+
/** create-visualization-scrollbar */
|
|
7019
|
+
export interface CreateVisualizationScrollbar {
|
|
7020
|
+
/** Enable chart scrollbar. */
|
|
7021
|
+
enabled?: boolean;
|
|
7022
|
+
}
|
|
5822
7023
|
/** create-weekly-org-schedule-interval */
|
|
5823
7024
|
export interface CreateWeeklyOrgScheduleInterval {
|
|
5824
7025
|
/**
|
|
@@ -5835,6 +7036,269 @@ export interface CreateWeeklyOrgScheduleInterval {
|
|
|
5835
7036
|
*/
|
|
5836
7037
|
to: number;
|
|
5837
7038
|
}
|
|
7039
|
+
/** create-widget-api-data-source */
|
|
7040
|
+
export interface CreateWidgetApiDataSource {
|
|
7041
|
+
/** Object IDs to include in the data source. */
|
|
7042
|
+
include?: string[];
|
|
7043
|
+
/** Indicates if the leaf type is custom. */
|
|
7044
|
+
is_custom_leaf_type?: boolean;
|
|
7045
|
+
/**
|
|
7046
|
+
* The object's type.
|
|
7047
|
+
* @format text
|
|
7048
|
+
*/
|
|
7049
|
+
leaf_type?: string;
|
|
7050
|
+
/** The subtypes of the object. */
|
|
7051
|
+
subtypes?: string[];
|
|
7052
|
+
}
|
|
7053
|
+
/** create-widget-column-projection */
|
|
7054
|
+
export interface CreateWidgetColumnProjection {
|
|
7055
|
+
/** The type of the column. */
|
|
7056
|
+
type?: WidgetColumnProjectionType;
|
|
7057
|
+
custom_field?: CreateCustomFieldWidgetColumnProjection;
|
|
7058
|
+
/** Set of field attributes. */
|
|
7059
|
+
devrev_schema?: SchemaFieldDescriptor;
|
|
7060
|
+
/** Whether the column has a custom expression. */
|
|
7061
|
+
has_custom_expression?: boolean;
|
|
7062
|
+
/** Whether the column is derived. */
|
|
7063
|
+
is_derived?: boolean;
|
|
7064
|
+
meerkat_schema?: CreateMeerkatWidgetColumnProjection;
|
|
7065
|
+
/**
|
|
7066
|
+
* The reference name of the column.
|
|
7067
|
+
* @format text
|
|
7068
|
+
*/
|
|
7069
|
+
reference_name: string;
|
|
7070
|
+
}
|
|
7071
|
+
/** create-widget-data-source */
|
|
7072
|
+
export interface CreateWidgetDataSource {
|
|
7073
|
+
/** The type of the data source. */
|
|
7074
|
+
type: WidgetDataSourceType;
|
|
7075
|
+
api?: CreateWidgetApiDataSource;
|
|
7076
|
+
/**
|
|
7077
|
+
* The ID of the data source. Meant to be set when the type is
|
|
7078
|
+
* data_source.
|
|
7079
|
+
* @format text
|
|
7080
|
+
*/
|
|
7081
|
+
data_source?: string;
|
|
7082
|
+
/**
|
|
7083
|
+
* The ID of the data view. Meant to be set when the type is
|
|
7084
|
+
* data_view.
|
|
7085
|
+
* @format text
|
|
7086
|
+
*/
|
|
7087
|
+
data_view?: string;
|
|
7088
|
+
/**
|
|
7089
|
+
* The dimensions (or the extended dimensions) provided by the data
|
|
7090
|
+
* source. These are the categories that can be used to group or
|
|
7091
|
+
* segment the measures.
|
|
7092
|
+
*/
|
|
7093
|
+
dimensions?: CreateWidgetColumnProjection[];
|
|
7094
|
+
external_data_source?: CreateWidgetDataSourceReference;
|
|
7095
|
+
/** Whether the data source is a system data source. */
|
|
7096
|
+
is_system?: boolean;
|
|
7097
|
+
/**
|
|
7098
|
+
* A list of possible joins for the data source. Follows foreign key
|
|
7099
|
+
* semantics.
|
|
7100
|
+
*/
|
|
7101
|
+
joins?: CreateDataSourceJoin[];
|
|
7102
|
+
/**
|
|
7103
|
+
* The measures (or the extended measures) provided by the data
|
|
7104
|
+
* source. These are the numerical values that can be analyzed.
|
|
7105
|
+
*/
|
|
7106
|
+
measures?: CreateWidgetColumnProjection[];
|
|
7107
|
+
oasis?: CreateWidgetOasisDataSource;
|
|
7108
|
+
/**
|
|
7109
|
+
* The reference name of the data source.
|
|
7110
|
+
* @format text
|
|
7111
|
+
*/
|
|
7112
|
+
reference_name: string;
|
|
7113
|
+
}
|
|
7114
|
+
/** create-widget-data-source-reference */
|
|
7115
|
+
export interface CreateWidgetDataSourceReference {
|
|
7116
|
+
/**
|
|
7117
|
+
* The column projections for the data source. These are the columns
|
|
7118
|
+
* that are projected from the datasets.
|
|
7119
|
+
*/
|
|
7120
|
+
dataset_projections?: CreateWidgetOasisDatasetColumnProjection[];
|
|
7121
|
+
/**
|
|
7122
|
+
* The id of the data source.
|
|
7123
|
+
* @format text
|
|
7124
|
+
*/
|
|
7125
|
+
id: string;
|
|
7126
|
+
}
|
|
7127
|
+
/** create-widget-group-by-config */
|
|
7128
|
+
export interface CreateWidgetGroupByConfig {
|
|
7129
|
+
/**
|
|
7130
|
+
* The key on which group_by is applied.
|
|
7131
|
+
* @format text
|
|
7132
|
+
*/
|
|
7133
|
+
key: string;
|
|
7134
|
+
/**
|
|
7135
|
+
* The maximum number of unique values that can be returned for the
|
|
7136
|
+
* key.
|
|
7137
|
+
* @format int64
|
|
7138
|
+
*/
|
|
7139
|
+
limit?: number;
|
|
7140
|
+
}
|
|
7141
|
+
/** create-widget-oasis-data-source */
|
|
7142
|
+
export interface CreateWidgetOasisDataSource {
|
|
7143
|
+
/** List of datasets used by the data source. */
|
|
7144
|
+
datasets?: string[];
|
|
7145
|
+
/**
|
|
7146
|
+
* The column projections for the data source. These are the columns
|
|
7147
|
+
* that are projected from the datasets.
|
|
7148
|
+
*/
|
|
7149
|
+
projections?: CreateWidgetOasisDatasetColumnProjection[];
|
|
7150
|
+
/**
|
|
7151
|
+
* The base SQL query that constructs the view for the data source.
|
|
7152
|
+
* The SQL can reference the datasets using their aliases.
|
|
7153
|
+
* @format text
|
|
7154
|
+
*/
|
|
7155
|
+
sql_query: string;
|
|
7156
|
+
}
|
|
7157
|
+
/** create-widget-oasis-dataset-column */
|
|
7158
|
+
export interface CreateWidgetOasisDatasetColumn {
|
|
7159
|
+
custom_field?: CreateCustomFieldWidgetColumnProjection;
|
|
7160
|
+
/**
|
|
7161
|
+
* The name of the column.
|
|
7162
|
+
* @format text
|
|
7163
|
+
*/
|
|
7164
|
+
name: string;
|
|
7165
|
+
}
|
|
7166
|
+
/** create-widget-oasis-dataset-column-projection */
|
|
7167
|
+
export interface CreateWidgetOasisDatasetColumnProjection {
|
|
7168
|
+
/** The column name. */
|
|
7169
|
+
columns: CreateWidgetOasisDatasetColumn[];
|
|
7170
|
+
/**
|
|
7171
|
+
* The dataset ID.
|
|
7172
|
+
* @format text
|
|
7173
|
+
*/
|
|
7174
|
+
dataset: string;
|
|
7175
|
+
}
|
|
7176
|
+
/** create-widget-pvp-config */
|
|
7177
|
+
export interface CreateWidgetPvpConfig {
|
|
7178
|
+
/** Indicates whether PVP is enabled. */
|
|
7179
|
+
enabled?: boolean;
|
|
7180
|
+
/** Specifies whether the color scheme for PVP is inverted. */
|
|
7181
|
+
invert_correlation_color?: boolean;
|
|
7182
|
+
/**
|
|
7183
|
+
* Decimal precision for percentage.
|
|
7184
|
+
* @format int64
|
|
7185
|
+
*/
|
|
7186
|
+
percentage_precision?: number;
|
|
7187
|
+
}
|
|
7188
|
+
/** create-widget-query */
|
|
7189
|
+
export interface CreateWidgetQuery {
|
|
7190
|
+
/**
|
|
7191
|
+
* Extended dimension configurations that pair column references with
|
|
7192
|
+
* query-time operations like rollups and aggregation functions.
|
|
7193
|
+
*/
|
|
7194
|
+
dimension_configs?: CreateWidgetQueryColumnConfig[];
|
|
7195
|
+
/**
|
|
7196
|
+
* The dimensions for the query, which are the categories to group or
|
|
7197
|
+
* segment the measures. Usually these are the X-axis values in a
|
|
7198
|
+
* visualization.
|
|
7199
|
+
*/
|
|
7200
|
+
dimensions?: string[];
|
|
7201
|
+
/**
|
|
7202
|
+
* Set of filters to apply on the widgets. These filters are applied
|
|
7203
|
+
* on top of the dashboard level filters.
|
|
7204
|
+
*/
|
|
7205
|
+
filters?: CreateDashboardFilter[];
|
|
7206
|
+
/** Join paths to use for the query. */
|
|
7207
|
+
joins?: CreateWidgetQueryJoins[];
|
|
7208
|
+
/**
|
|
7209
|
+
* The maximum number of records to return. This is used to limit the
|
|
7210
|
+
* amount of data returned by the query.
|
|
7211
|
+
* @format int64
|
|
7212
|
+
*/
|
|
7213
|
+
limit?: number;
|
|
7214
|
+
/**
|
|
7215
|
+
* Extended measure configurations that pair column references with
|
|
7216
|
+
* query-time operations like aggregation functions and rollups.
|
|
7217
|
+
*/
|
|
7218
|
+
measure_configs?: CreateWidgetQueryColumnConfig[];
|
|
7219
|
+
/**
|
|
7220
|
+
* The measures for the query, which are the numerical values to be
|
|
7221
|
+
* analyzed. Usually these are the Y-axis values in a visualization.
|
|
7222
|
+
*/
|
|
7223
|
+
measures?: string[];
|
|
7224
|
+
/**
|
|
7225
|
+
* The order in which the data should be returned. This is used to
|
|
7226
|
+
* sort the data returned by the query.
|
|
7227
|
+
*/
|
|
7228
|
+
order_by?: CreateWidgetQueryOrderBy[];
|
|
7229
|
+
}
|
|
7230
|
+
/** create-widget-query-column-config */
|
|
7231
|
+
export interface CreateWidgetQueryColumnConfig {
|
|
7232
|
+
/**
|
|
7233
|
+
* The category of the query-time operation. Time_granularity buckets
|
|
7234
|
+
* timestamp values by granularity. Aggregation applies an aggregate
|
|
7235
|
+
* function to the column. When omitted the column is a plain reference.
|
|
7236
|
+
*/
|
|
7237
|
+
type?: WidgetQueryColumnConfigType;
|
|
7238
|
+
/** The aggregation function type. Set when type is aggregation. */
|
|
7239
|
+
aggregation?: WidgetQueryColumnConfigAggregation;
|
|
7240
|
+
/**
|
|
7241
|
+
* The name of the source column from the data source.
|
|
7242
|
+
* @format text
|
|
7243
|
+
*/
|
|
7244
|
+
column_name: string;
|
|
7245
|
+
/**
|
|
7246
|
+
* A deterministic unique identifier derived from column_name, type,
|
|
7247
|
+
* and the active value field. Used to reference this column+operation
|
|
7248
|
+
* in visualization axes, order_by, filters, and other downstream
|
|
7249
|
+
* configurations.
|
|
7250
|
+
* @format text
|
|
7251
|
+
*/
|
|
7252
|
+
reference_name: string;
|
|
7253
|
+
/** The time granularity for bucketing. Set when type is time_granularity. */
|
|
7254
|
+
time_granularity?: WidgetQueryColumnConfigTimeGranularity;
|
|
7255
|
+
}
|
|
7256
|
+
/** create-widget-query-joins */
|
|
7257
|
+
export interface CreateWidgetQueryJoins {
|
|
7258
|
+
/** A list of joins. */
|
|
7259
|
+
path: string[];
|
|
7260
|
+
}
|
|
7261
|
+
/** create-widget-query-order-by */
|
|
7262
|
+
export interface CreateWidgetQueryOrderBy {
|
|
7263
|
+
/** The direction of the sort. */
|
|
7264
|
+
direction: WidgetQueryOrderByDirection;
|
|
7265
|
+
/**
|
|
7266
|
+
* The column to sort by.
|
|
7267
|
+
* @format text
|
|
7268
|
+
*/
|
|
7269
|
+
reference_name: string;
|
|
7270
|
+
}
|
|
7271
|
+
/** create-widget-table-manifest */
|
|
7272
|
+
export interface CreateWidgetTableManifest {
|
|
7273
|
+
/** The columns projected for the widget. */
|
|
7274
|
+
columns: TableField[];
|
|
7275
|
+
data?: CreateTableDataStorage;
|
|
7276
|
+
/**
|
|
7277
|
+
* The sql query to be executed on the data.
|
|
7278
|
+
* @format text
|
|
7279
|
+
*/
|
|
7280
|
+
sql: string;
|
|
7281
|
+
}
|
|
7282
|
+
/** create-widget-visualization */
|
|
7283
|
+
export interface CreateWidgetVisualization {
|
|
7284
|
+
/** The type of the visualization, such as line, bar, pie, etc. */
|
|
7285
|
+
type: WidgetVisualizationType;
|
|
7286
|
+
bar?: CreateBarWidgetVisualization;
|
|
7287
|
+
column?: CreateColumnWidgetVisualization;
|
|
7288
|
+
combination?: CreateCombinationWidgetVisualization;
|
|
7289
|
+
donut?: CreateDonutWidgetVisualization;
|
|
7290
|
+
flame_graph?: CreateFlameGraphWidgetVisualization;
|
|
7291
|
+
gantt?: CreateGanttWidgetVisualization;
|
|
7292
|
+
heatmap?: CreateHeatmapWidgetVisualization;
|
|
7293
|
+
kanban?: CreateKanbanWidgetVisualization;
|
|
7294
|
+
line?: CreateLineWidgetVisualization;
|
|
7295
|
+
metric?: CreateMetricWidgetVisualization;
|
|
7296
|
+
packed_bubble?: CreatePackedBubbleWidgetVisualization;
|
|
7297
|
+
pie?: CreatePieWidgetVisualization;
|
|
7298
|
+
rich_text?: CreateRichTextWidgetVisualization;
|
|
7299
|
+
scatter?: CreateScatterWidgetVisualization;
|
|
7300
|
+
table?: CreateTableWidgetVisualization;
|
|
7301
|
+
}
|
|
5838
7302
|
/**
|
|
5839
7303
|
* curated-vista
|
|
5840
7304
|
* Static collection of DevRev objects.
|
|
@@ -5848,6 +7312,14 @@ export type CuratedVista = VistaBase & {
|
|
|
5848
7312
|
* Static collection of DevRev objects.
|
|
5849
7313
|
*/
|
|
5850
7314
|
export type CuratedVistaSummary = VistaBaseSummary;
|
|
7315
|
+
/** The period type for which to calculate current period range. */
|
|
7316
|
+
export declare enum CurrentPeriod {
|
|
7317
|
+
Day = "day",
|
|
7318
|
+
Month = "month",
|
|
7319
|
+
Quarter = "quarter",
|
|
7320
|
+
Week = "week",
|
|
7321
|
+
Year = "year"
|
|
7322
|
+
}
|
|
5851
7323
|
/**
|
|
5852
7324
|
* custom-field-widget-column-projection
|
|
5853
7325
|
* A custom field widget column projection.
|
|
@@ -5966,8 +7438,8 @@ export interface CustomLinkTypeListRequest {
|
|
|
5966
7438
|
/** Whether only deprecated link types should be filtered. */
|
|
5967
7439
|
is_deprecated?: boolean;
|
|
5968
7440
|
/**
|
|
5969
|
-
* The maximum number of items, for each result and
|
|
5970
|
-
*
|
|
7441
|
+
* The maximum number of items, for each result and reverse_result.
|
|
7442
|
+
* Default value is 50 for each.
|
|
5971
7443
|
* @format int32
|
|
5972
7444
|
*/
|
|
5973
7445
|
limit?: number;
|
|
@@ -6006,6 +7478,12 @@ export interface CustomLinkTypeListResponse {
|
|
|
6006
7478
|
prev_cursor?: string;
|
|
6007
7479
|
/** The custom link types. */
|
|
6008
7480
|
result: CustomLinkType[];
|
|
7481
|
+
/**
|
|
7482
|
+
* The custom link types matching the request filter in the backward
|
|
7483
|
+
* direction. Objects can be present in both result and
|
|
7484
|
+
* reverse_result.
|
|
7485
|
+
*/
|
|
7486
|
+
reverse_result: CustomLinkType[];
|
|
6009
7487
|
}
|
|
6010
7488
|
/** custom-link-type-summary */
|
|
6011
7489
|
export type CustomLinkTypeSummary = AtomBaseSummary & {
|
|
@@ -6958,6 +8436,69 @@ export type Dashboard = AtomBase;
|
|
|
6958
8436
|
* and widgets.
|
|
6959
8437
|
*/
|
|
6960
8438
|
export type DashboardFilter = object;
|
|
8439
|
+
/** The operator used to compare the key and value. */
|
|
8440
|
+
export declare enum DashboardFilterConditionOperator {
|
|
8441
|
+
Contains = "contains",
|
|
8442
|
+
Empty = "empty",
|
|
8443
|
+
Equals = "equals",
|
|
8444
|
+
NotEmpty = "not_empty",
|
|
8445
|
+
NotEquals = "not_equals",
|
|
8446
|
+
NotNull = "not_null",
|
|
8447
|
+
Null = "null",
|
|
8448
|
+
Range = "range"
|
|
8449
|
+
}
|
|
8450
|
+
/** The operator used to compare the key and value. */
|
|
8451
|
+
export declare enum DashboardFilterConditionValueType {
|
|
8452
|
+
JsonValue = "json_value",
|
|
8453
|
+
PartValue = "part_value",
|
|
8454
|
+
RelativeDateValue = "relative_date_value"
|
|
8455
|
+
}
|
|
8456
|
+
/** The logical operator that binds the filter conditions or expressions. */
|
|
8457
|
+
export declare enum DashboardFilterExpressionOperator {
|
|
8458
|
+
And = "and",
|
|
8459
|
+
Or = "or"
|
|
8460
|
+
}
|
|
8461
|
+
/**
|
|
8462
|
+
* The type of the operand. It can be either a filter expression or a
|
|
8463
|
+
* filter condition.
|
|
8464
|
+
*/
|
|
8465
|
+
export declare enum DashboardFilterOperandType {
|
|
8466
|
+
Condition = "condition",
|
|
8467
|
+
Expression = "expression"
|
|
8468
|
+
}
|
|
8469
|
+
/**
|
|
8470
|
+
* Type of current period (today, this week, this month, this quarter,
|
|
8471
|
+
* this year).
|
|
8472
|
+
*/
|
|
8473
|
+
export declare enum DashboardFilterRelativeDateConditionCurrentPeriodType {
|
|
8474
|
+
Day = "day",
|
|
8475
|
+
Month = "month",
|
|
8476
|
+
Quarter = "quarter",
|
|
8477
|
+
Week = "week",
|
|
8478
|
+
Year = "year"
|
|
8479
|
+
}
|
|
8480
|
+
/**
|
|
8481
|
+
* Type of date range from the start of a fiscal period to the current
|
|
8482
|
+
* date.
|
|
8483
|
+
*/
|
|
8484
|
+
export declare enum DashboardFilterRelativeDateConditionPeriodType {
|
|
8485
|
+
QuarterToDate = "quarter_to_date",
|
|
8486
|
+
YearToDate = "year_to_date"
|
|
8487
|
+
}
|
|
8488
|
+
/** The type of the relative date condition. */
|
|
8489
|
+
export declare enum DashboardFilterRelativeDateConditionType {
|
|
8490
|
+
CurrentPeriod = "current_period",
|
|
8491
|
+
CustomFiscalQuarter = "custom_fiscal_quarter",
|
|
8492
|
+
NextNDays = "next_n_days",
|
|
8493
|
+
NextNMonths = "next_n_months",
|
|
8494
|
+
NextNWeeks = "next_n_weeks",
|
|
8495
|
+
PeriodToDate = "period_to_date",
|
|
8496
|
+
PrevNDays = "prev_n_days",
|
|
8497
|
+
PrevNMonths = "prev_n_months",
|
|
8498
|
+
PrevNWeeks = "prev_n_weeks",
|
|
8499
|
+
RelativeFiscalQuarter = "relative_fiscal_quarter",
|
|
8500
|
+
RelativeFiscalYear = "relative_fiscal_year"
|
|
8501
|
+
}
|
|
6961
8502
|
/** dashboard-search-summary */
|
|
6962
8503
|
export type DashboardSearchSummary = SearchSummaryBase & {
|
|
6963
8504
|
dashboard: DashboardSummary;
|
|
@@ -7023,6 +8564,39 @@ export type DateTimePreset = (DateTimePresetLastNDays | DateTimePresetNextNDays)
|
|
|
7023
8564
|
/** Type of date preset. */
|
|
7024
8565
|
preset_type: DateTimePresetType;
|
|
7025
8566
|
};
|
|
8567
|
+
/** date-time-preset-current-period */
|
|
8568
|
+
export interface DateTimePresetCurrentPeriod {
|
|
8569
|
+
/**
|
|
8570
|
+
* IANA timezone name (e.g., 'America/New_York') to use for
|
|
8571
|
+
* calculating the period. If not specified, uses the default timezone
|
|
8572
|
+
* from the request context.
|
|
8573
|
+
* @format text
|
|
8574
|
+
*/
|
|
8575
|
+
location?: string;
|
|
8576
|
+
/**
|
|
8577
|
+
* Offset from the current period. 0: current period, -1: previous
|
|
8578
|
+
* period, 1: next period.
|
|
8579
|
+
* @format int32
|
|
8580
|
+
*/
|
|
8581
|
+
offset?: number;
|
|
8582
|
+
/** The period type for which to calculate current period range. */
|
|
8583
|
+
period: CurrentPeriod;
|
|
8584
|
+
}
|
|
8585
|
+
/** date-time-preset-custom-fiscal-quarter */
|
|
8586
|
+
export interface DateTimePresetCustomFiscalQuarter {
|
|
8587
|
+
/**
|
|
8588
|
+
* The fiscal quarter number (1-4) within the specified fiscal year.
|
|
8589
|
+
* @min 0
|
|
8590
|
+
* @max 4294967295
|
|
8591
|
+
*/
|
|
8592
|
+
quarter: number;
|
|
8593
|
+
/**
|
|
8594
|
+
* The fiscal year (e.g. 2024) for which to filter results.
|
|
8595
|
+
* @min 0
|
|
8596
|
+
* @max 4294967295
|
|
8597
|
+
*/
|
|
8598
|
+
year: number;
|
|
8599
|
+
}
|
|
7026
8600
|
/** date-time-preset-last-n-days */
|
|
7027
8601
|
export interface DateTimePresetLastNDays {
|
|
7028
8602
|
/**
|
|
@@ -7043,6 +8617,27 @@ export interface DateTimePresetNextNDays {
|
|
|
7043
8617
|
*/
|
|
7044
8618
|
days: number;
|
|
7045
8619
|
}
|
|
8620
|
+
/** date-time-preset-period-to-date */
|
|
8621
|
+
export interface DateTimePresetPeriodToDate {
|
|
8622
|
+
/** The period type for which to calculate period-to-date. */
|
|
8623
|
+
period_to_date: PeriodToDate;
|
|
8624
|
+
}
|
|
8625
|
+
/** date-time-preset-relative-fiscal-quarter */
|
|
8626
|
+
export interface DateTimePresetRelativeFiscalQuarter {
|
|
8627
|
+
/**
|
|
8628
|
+
* Relative offset from current fiscal quarter.
|
|
8629
|
+
* @format int32
|
|
8630
|
+
*/
|
|
8631
|
+
offset: number;
|
|
8632
|
+
}
|
|
8633
|
+
/** date-time-preset-relative-fiscal-year */
|
|
8634
|
+
export interface DateTimePresetRelativeFiscalYear {
|
|
8635
|
+
/**
|
|
8636
|
+
* Relative offset from current fiscal year.
|
|
8637
|
+
* @format int32
|
|
8638
|
+
*/
|
|
8639
|
+
offset: number;
|
|
8640
|
+
}
|
|
7046
8641
|
/** Type of date preset. */
|
|
7047
8642
|
export declare enum DateTimePresetType {
|
|
7048
8643
|
LastNDays = "last_n_days",
|
|
@@ -7962,146 +9557,156 @@ export interface DevUsersSelfUpdateRequest {
|
|
|
7962
9557
|
* @format text
|
|
7963
9558
|
*/
|
|
7964
9559
|
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
9560
|
/**
|
|
7970
|
-
* The
|
|
9561
|
+
* The job function of the Dev user.
|
|
9562
|
+
* @format text
|
|
9563
|
+
*/
|
|
9564
|
+
job_function?: string;
|
|
9565
|
+
/** Job history of the Dev user. */
|
|
9566
|
+
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
9567
|
+
/** Job title of the Dev User. */
|
|
9568
|
+
job_title?: DevUserJobTitle;
|
|
9569
|
+
/**
|
|
9570
|
+
* The ID of the Dev user that the user reports to.
|
|
9571
|
+
* @format id
|
|
9572
|
+
*/
|
|
9573
|
+
reports_to?: string;
|
|
9574
|
+
}
|
|
9575
|
+
/** dev-users-update-job-history-item */
|
|
9576
|
+
export interface DevUsersUpdateJobHistoryItem {
|
|
9577
|
+
/**
|
|
9578
|
+
* Enum for the employment status of the user.
|
|
9579
|
+
* @format int64
|
|
9580
|
+
*/
|
|
9581
|
+
employment_status?: number;
|
|
9582
|
+
/**
|
|
9583
|
+
* End date of the job.
|
|
9584
|
+
* @format date-time
|
|
9585
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
9586
|
+
*/
|
|
9587
|
+
end_date?: string;
|
|
9588
|
+
/** Is this the current active job for the user. */
|
|
9589
|
+
is_current?: boolean;
|
|
9590
|
+
/**
|
|
9591
|
+
* The job location for the user.
|
|
9592
|
+
* @format text
|
|
9593
|
+
*/
|
|
9594
|
+
location?: string;
|
|
9595
|
+
/**
|
|
9596
|
+
* Start date of the job.
|
|
9597
|
+
* @format date-time
|
|
9598
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
9599
|
+
*/
|
|
9600
|
+
start_date?: string;
|
|
9601
|
+
/**
|
|
9602
|
+
* The job title for the user.
|
|
9603
|
+
* @format text
|
|
9604
|
+
*/
|
|
9605
|
+
title?: string;
|
|
9606
|
+
}
|
|
9607
|
+
/**
|
|
9608
|
+
* dev-users-update-request
|
|
9609
|
+
* A request to update the user's information corresponding to the
|
|
9610
|
+
* provided Dev user.
|
|
9611
|
+
*/
|
|
9612
|
+
export interface DevUsersUpdateRequest {
|
|
9613
|
+
/**
|
|
9614
|
+
* Availability modes of the Dev user. Stock allowed values:
|
|
9615
|
+
* ```
|
|
9616
|
+
* {
|
|
9617
|
+
* "id": 1,
|
|
9618
|
+
* "label": "Ticket",
|
|
9619
|
+
* "ordinal": 1,
|
|
9620
|
+
* "overridable": false
|
|
9621
|
+
* },
|
|
9622
|
+
* {
|
|
9623
|
+
* "id": 2,
|
|
9624
|
+
* "label": "Conversation",
|
|
9625
|
+
* "ordinal": 2,
|
|
9626
|
+
* "overridable": false
|
|
9627
|
+
* },
|
|
9628
|
+
* {
|
|
9629
|
+
* "id": 3,
|
|
9630
|
+
* "label": "Issue",
|
|
9631
|
+
* "ordinal": 3,
|
|
9632
|
+
* "overridable": false
|
|
9633
|
+
* },
|
|
9634
|
+
* {
|
|
9635
|
+
* "id": 4,
|
|
9636
|
+
* "label": "Incident",
|
|
9637
|
+
* "ordinal": 4,
|
|
9638
|
+
* "overridable": false
|
|
9639
|
+
* },
|
|
9640
|
+
* {
|
|
9641
|
+
* "id": 5,
|
|
9642
|
+
* "label": "Away",
|
|
9643
|
+
* "ordinal": 5,
|
|
9644
|
+
* "overridable": false
|
|
9645
|
+
* },
|
|
9646
|
+
* {
|
|
9647
|
+
* "id": 6,
|
|
9648
|
+
* "label": "Sick",
|
|
9649
|
+
* "ordinal": 6,
|
|
9650
|
+
* "overridable": false
|
|
9651
|
+
* },
|
|
9652
|
+
* {
|
|
9653
|
+
* "id": 7,
|
|
9654
|
+
* "label": "Lunch",
|
|
9655
|
+
* "ordinal": 7,
|
|
9656
|
+
* "overridable": false
|
|
9657
|
+
* },
|
|
9658
|
+
* {
|
|
9659
|
+
* "id": 8,
|
|
9660
|
+
* "label": "Travel",
|
|
9661
|
+
* "ordinal": 8,
|
|
9662
|
+
* "overridable": false
|
|
9663
|
+
* },
|
|
9664
|
+
* {
|
|
9665
|
+
* "id": 9,
|
|
9666
|
+
* "label": "Vacation",
|
|
9667
|
+
* "ordinal": 9,
|
|
9668
|
+
* "overridable": false
|
|
9669
|
+
* }
|
|
9670
|
+
* ```
|
|
9671
|
+
*/
|
|
9672
|
+
availability_modes?: number[];
|
|
9673
|
+
/** Application-defined custom fields. */
|
|
9674
|
+
custom_fields?: object;
|
|
9675
|
+
/**
|
|
9676
|
+
* Custom schemas described using identifiers. Each custom field in the
|
|
9677
|
+
* request must have the corresponding schema specified; omission results
|
|
9678
|
+
* in a Bad Request error. If a custom schema is not included in the
|
|
9679
|
+
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
9680
|
+
* it is recommended to provide tenant_fragment: true and
|
|
9681
|
+
* validate_required_fields: true.
|
|
9682
|
+
*/
|
|
9683
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
9684
|
+
/**
|
|
9685
|
+
* The updated display name of the Dev user.
|
|
9686
|
+
* @format text
|
|
9687
|
+
*/
|
|
9688
|
+
display_name?: string;
|
|
9689
|
+
/**
|
|
9690
|
+
* Start date of Dev user's experience.
|
|
9691
|
+
* @format date-time
|
|
9692
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
9693
|
+
*/
|
|
9694
|
+
experience_start_date?: string;
|
|
9695
|
+
/**
|
|
9696
|
+
* The updated full name of the Dev user.
|
|
9697
|
+
* @format text
|
|
9698
|
+
*/
|
|
9699
|
+
full_name?: string;
|
|
9700
|
+
/**
|
|
9701
|
+
* The ID for the Dev user to be updated.
|
|
7971
9702
|
* @format id
|
|
7972
9703
|
*/
|
|
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;
|
|
9704
|
+
id: string;
|
|
8095
9705
|
/**
|
|
8096
|
-
* The
|
|
9706
|
+
* The job function of the Dev user.
|
|
8097
9707
|
* @format text
|
|
8098
9708
|
*/
|
|
8099
|
-
|
|
8100
|
-
/**
|
|
8101
|
-
* The ID for the Dev user to be updated.
|
|
8102
|
-
* @format id
|
|
8103
|
-
*/
|
|
8104
|
-
id: string;
|
|
9709
|
+
job_function?: string;
|
|
8105
9710
|
/** Job history of the Dev user. */
|
|
8106
9711
|
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
8107
9712
|
/** Job title of the Dev User. */
|
|
@@ -8206,6 +9811,281 @@ export declare enum DeviceType {
|
|
|
8206
9811
|
Desktop = "desktop",
|
|
8207
9812
|
Mobile = "mobile"
|
|
8208
9813
|
}
|
|
9814
|
+
/**
|
|
9815
|
+
* devrev-expression
|
|
9816
|
+
* Defines a DevRev Query Language (DQL) expression.
|
|
9817
|
+
*/
|
|
9818
|
+
export type DevrevExpression = (DevrevQueryComparisonOperator | DevrevQueryDateTimeOperator | DevrevQueryDateTimePresetOperator | DevrevQueryExistenceOperator | DevrevQueryLogicalOperator | DevrevQueryMembershipOperator) & {
|
|
9819
|
+
op: DevrevExpressionOp;
|
|
9820
|
+
};
|
|
9821
|
+
export declare enum DevrevExpressionOp {
|
|
9822
|
+
AllOf = "all_of",
|
|
9823
|
+
And = "and",
|
|
9824
|
+
DateTime = "date_time",
|
|
9825
|
+
DateTimePreset = "date_time_preset",
|
|
9826
|
+
Empty = "empty",
|
|
9827
|
+
Eq = "eq",
|
|
9828
|
+
Gt = "gt",
|
|
9829
|
+
Gte = "gte",
|
|
9830
|
+
In = "in",
|
|
9831
|
+
Lt = "lt",
|
|
9832
|
+
Lte = "lte",
|
|
9833
|
+
Ne = "ne",
|
|
9834
|
+
NotEmpty = "not_empty",
|
|
9835
|
+
NotIn = "not_in",
|
|
9836
|
+
Or = "or"
|
|
9837
|
+
}
|
|
9838
|
+
/**
|
|
9839
|
+
* devrev-query
|
|
9840
|
+
* A unified query language for DevRev objects.
|
|
9841
|
+
*/
|
|
9842
|
+
export interface DevrevQuery {
|
|
9843
|
+
/**
|
|
9844
|
+
* Opaque cursor token that represents a position in the result set.
|
|
9845
|
+
* Use the cursor from previous responses to fetch next/previous
|
|
9846
|
+
* iteration.
|
|
9847
|
+
* @format text
|
|
9848
|
+
*/
|
|
9849
|
+
cursor?: string;
|
|
9850
|
+
expression?: DevrevQuerySearchExpression;
|
|
9851
|
+
/** Defines a DevRev Query Language (DQL) expression. */
|
|
9852
|
+
filter?: DevrevExpression;
|
|
9853
|
+
/** Grouping configuration for query results. */
|
|
9854
|
+
group_by?: DevrevQueryGroupExpression[];
|
|
9855
|
+
/**
|
|
9856
|
+
* Maximum number of items to return per iteration. If not specified,
|
|
9857
|
+
* the service will use its default limit.
|
|
9858
|
+
* @format int32
|
|
9859
|
+
*/
|
|
9860
|
+
limit?: number;
|
|
9861
|
+
/**
|
|
9862
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
9863
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
9864
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
9865
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
9866
|
+
* always be returned in the specified sort-by order.
|
|
9867
|
+
*/
|
|
9868
|
+
mode?: ListMode;
|
|
9869
|
+
/**
|
|
9870
|
+
* The search query to filter the objects.
|
|
9871
|
+
* @deprecated
|
|
9872
|
+
* @format text
|
|
9873
|
+
*/
|
|
9874
|
+
search_query?: string;
|
|
9875
|
+
/** Fields to sort the records by and the direction to sort them. */
|
|
9876
|
+
sort_by?: string[];
|
|
9877
|
+
}
|
|
9878
|
+
/**
|
|
9879
|
+
* devrev-query-comparison-operator
|
|
9880
|
+
* Comparison operator that compares a field with a value.
|
|
9881
|
+
*/
|
|
9882
|
+
export type DevrevQueryComparisonOperator = (DevrevQueryJsonValue | DevrevQueryPartValue | DevrevQuerySpaceValue | DevrevQueryTemplateValue) & {
|
|
9883
|
+
/**
|
|
9884
|
+
* The field name to apply the comparison against.
|
|
9885
|
+
* @format text
|
|
9886
|
+
*/
|
|
9887
|
+
field: string;
|
|
9888
|
+
value_type: DevrevQueryComparisonOperatorValueType;
|
|
9889
|
+
};
|
|
9890
|
+
export declare enum DevrevQueryComparisonOperatorValueType {
|
|
9891
|
+
Json = "json",
|
|
9892
|
+
Part = "part",
|
|
9893
|
+
Space = "space",
|
|
9894
|
+
Template = "template"
|
|
9895
|
+
}
|
|
9896
|
+
/** devrev-query-date-range-value */
|
|
9897
|
+
export interface DevrevQueryDateRangeValue {
|
|
9898
|
+
/**
|
|
9899
|
+
* Start of the range
|
|
9900
|
+
* @format text
|
|
9901
|
+
*/
|
|
9902
|
+
after?: string;
|
|
9903
|
+
/**
|
|
9904
|
+
* End of the range
|
|
9905
|
+
* @format text
|
|
9906
|
+
*/
|
|
9907
|
+
before?: string;
|
|
9908
|
+
}
|
|
9909
|
+
/**
|
|
9910
|
+
* devrev-query-date-time-operator
|
|
9911
|
+
* DateTime operator for relative time windows and offsets.
|
|
9912
|
+
*/
|
|
9913
|
+
export type DevrevQueryDateTimeOperator = (DateTimePresetCurrentPeriod | DateTimePresetCustomFiscalQuarter | DateTimePresetPeriodToDate | DateTimePresetRelativeFiscalQuarter | DateTimePresetRelativeFiscalYear | DevrevQueryDateRangeValue | DevrevQueryInt) & {
|
|
9914
|
+
/**
|
|
9915
|
+
* The field to evaluate against the selected DateTime operator.
|
|
9916
|
+
* @format text
|
|
9917
|
+
*/
|
|
9918
|
+
field: string;
|
|
9919
|
+
value_type: DevrevQueryDateTimeOperatorValueType;
|
|
9920
|
+
};
|
|
9921
|
+
export declare enum DevrevQueryDateTimeOperatorValueType {
|
|
9922
|
+
AfterNDays = "after_n_days",
|
|
9923
|
+
AfterNHours = "after_n_hours",
|
|
9924
|
+
BeforeNDays = "before_n_days",
|
|
9925
|
+
BeforeNHours = "before_n_hours",
|
|
9926
|
+
CurrentPeriod = "current_period",
|
|
9927
|
+
CustomFiscalQuarter = "custom_fiscal_quarter",
|
|
9928
|
+
LastNDays = "last_n_days",
|
|
9929
|
+
LastNHours = "last_n_hours",
|
|
9930
|
+
NextNDays = "next_n_days",
|
|
9931
|
+
NextNHours = "next_n_hours",
|
|
9932
|
+
PeriodToDate = "period_to_date",
|
|
9933
|
+
Range = "range",
|
|
9934
|
+
RelativeFiscalQuarter = "relative_fiscal_quarter",
|
|
9935
|
+
RelativeFiscalYear = "relative_fiscal_year"
|
|
9936
|
+
}
|
|
9937
|
+
/**
|
|
9938
|
+
* devrev-query-date-time-preset-operator
|
|
9939
|
+
* DateTimePreset operator for relative time windows and offsets.
|
|
9940
|
+
*/
|
|
9941
|
+
export type DevrevQueryDateTimePresetOperator = (DateTimePresetCurrentPeriod | DateTimePresetCustomFiscalQuarter | DateTimePresetPeriodToDate | DateTimePresetRelativeFiscalQuarter | DateTimePresetRelativeFiscalYear | DevrevQueryInt) & {
|
|
9942
|
+
/**
|
|
9943
|
+
* The field to evaluate against the selected DateTimePreset operator.
|
|
9944
|
+
* @format text
|
|
9945
|
+
*/
|
|
9946
|
+
field: string;
|
|
9947
|
+
value_type: DevrevQueryDateTimePresetOperatorValueType;
|
|
9948
|
+
};
|
|
9949
|
+
export declare enum DevrevQueryDateTimePresetOperatorValueType {
|
|
9950
|
+
AfterNDays = "after_n_days",
|
|
9951
|
+
AfterNHours = "after_n_hours",
|
|
9952
|
+
BeforeNDays = "before_n_days",
|
|
9953
|
+
BeforeNHours = "before_n_hours",
|
|
9954
|
+
CurrentPeriod = "current_period",
|
|
9955
|
+
CustomFiscalQuarter = "custom_fiscal_quarter",
|
|
9956
|
+
LastNDays = "last_n_days",
|
|
9957
|
+
LastNHours = "last_n_hours",
|
|
9958
|
+
NextNDays = "next_n_days",
|
|
9959
|
+
NextNHours = "next_n_hours",
|
|
9960
|
+
PeriodToDate = "period_to_date",
|
|
9961
|
+
RelativeFiscalQuarter = "relative_fiscal_quarter",
|
|
9962
|
+
RelativeFiscalYear = "relative_fiscal_year"
|
|
9963
|
+
}
|
|
9964
|
+
/**
|
|
9965
|
+
* devrev-query-existence-operator
|
|
9966
|
+
* Existence operator that checks if a field is empty or not.
|
|
9967
|
+
*/
|
|
9968
|
+
export interface DevrevQueryExistenceOperator {
|
|
9969
|
+
/**
|
|
9970
|
+
* The field to evaluate against the existence operator.
|
|
9971
|
+
* @format text
|
|
9972
|
+
*/
|
|
9973
|
+
field: string;
|
|
9974
|
+
}
|
|
9975
|
+
/** devrev-query-group-expression */
|
|
9976
|
+
export interface DevrevQueryGroupExpression {
|
|
9977
|
+
/**
|
|
9978
|
+
* Field name to group results by.
|
|
9979
|
+
* @format text
|
|
9980
|
+
*/
|
|
9981
|
+
field: string;
|
|
9982
|
+
/** Ordering of group keys. */
|
|
9983
|
+
order?: DevrevQueryGroupExpressionOrder;
|
|
9984
|
+
/** Sort direction for group keys. */
|
|
9985
|
+
sort_direction?: DevrevQueryGroupExpressionSortDirection;
|
|
9986
|
+
}
|
|
9987
|
+
/** Ordering of group keys. */
|
|
9988
|
+
export declare enum DevrevQueryGroupExpressionOrder {
|
|
9989
|
+
Count = "count",
|
|
9990
|
+
Lexical = "lexical",
|
|
9991
|
+
Ordinal = "ordinal"
|
|
9992
|
+
}
|
|
9993
|
+
/** Sort direction for group keys. */
|
|
9994
|
+
export declare enum DevrevQueryGroupExpressionSortDirection {
|
|
9995
|
+
Asc = "asc",
|
|
9996
|
+
Desc = "desc"
|
|
9997
|
+
}
|
|
9998
|
+
/**
|
|
9999
|
+
* devrev-query-int
|
|
10000
|
+
* Represents a value of int type.
|
|
10001
|
+
*/
|
|
10002
|
+
export interface DevrevQueryInt {
|
|
10003
|
+
/**
|
|
10004
|
+
* The int32 value.
|
|
10005
|
+
* @format int32
|
|
10006
|
+
*/
|
|
10007
|
+
value: number;
|
|
10008
|
+
}
|
|
10009
|
+
/**
|
|
10010
|
+
* devrev-query-json-value
|
|
10011
|
+
* Represents a value of any JSON type.
|
|
10012
|
+
*/
|
|
10013
|
+
export interface DevrevQueryJsonValue {
|
|
10014
|
+
/** The JSON value. */
|
|
10015
|
+
value: any;
|
|
10016
|
+
}
|
|
10017
|
+
/**
|
|
10018
|
+
* devrev-query-logical-operator
|
|
10019
|
+
* Logical operator that combines multiple expressions using AND or OR
|
|
10020
|
+
* logic.
|
|
10021
|
+
*/
|
|
10022
|
+
export interface DevrevQueryLogicalOperator {
|
|
10023
|
+
/** List of expressions to be combined with the logical operator. */
|
|
10024
|
+
operands: DevrevExpression[];
|
|
10025
|
+
}
|
|
10026
|
+
/**
|
|
10027
|
+
* devrev-query-membership-operator
|
|
10028
|
+
* Membership operator that checks if a field is in a list of values.
|
|
10029
|
+
*/
|
|
10030
|
+
export type DevrevQueryMembershipOperator = (DevrevQueryJsonValue | DevrevQueryPartValue | DevrevQuerySpaceValue | DevrevQueryTemplateValue) & {
|
|
10031
|
+
/**
|
|
10032
|
+
* The field to evaluate against the membership operator.
|
|
10033
|
+
* @format text
|
|
10034
|
+
*/
|
|
10035
|
+
field: string;
|
|
10036
|
+
value_type: DevrevQueryMembershipOperatorValueType;
|
|
10037
|
+
};
|
|
10038
|
+
export declare enum DevrevQueryMembershipOperatorValueType {
|
|
10039
|
+
Json = "json",
|
|
10040
|
+
Part = "part",
|
|
10041
|
+
Space = "space",
|
|
10042
|
+
Template = "template"
|
|
10043
|
+
}
|
|
10044
|
+
/** devrev-query-part-value */
|
|
10045
|
+
export interface DevrevQueryPartValue {
|
|
10046
|
+
/** Whether to include child parts in the query. */
|
|
10047
|
+
include_child_parts?: boolean;
|
|
10048
|
+
/**
|
|
10049
|
+
* List of part identifiers as DONs.
|
|
10050
|
+
* @example ["PROD-12345"]
|
|
10051
|
+
*/
|
|
10052
|
+
value: string[];
|
|
10053
|
+
}
|
|
10054
|
+
/** devrev-query-search-expression */
|
|
10055
|
+
export interface DevrevQuerySearchExpression {
|
|
10056
|
+
/**
|
|
10057
|
+
* The search query to filter the objects.
|
|
10058
|
+
* @format text
|
|
10059
|
+
*/
|
|
10060
|
+
query: string;
|
|
10061
|
+
/** Fields on which the search query will be scoped on. */
|
|
10062
|
+
scope?: string[];
|
|
10063
|
+
}
|
|
10064
|
+
/** devrev-query-space-value */
|
|
10065
|
+
export interface DevrevQuerySpaceValue {
|
|
10066
|
+
/** Whether to include child spaces in the query. */
|
|
10067
|
+
include_child_spaces?: boolean;
|
|
10068
|
+
/** Whether to include parent spaces in the query. */
|
|
10069
|
+
include_parent_spaces?: boolean;
|
|
10070
|
+
/** List of space identifiers as DONs. */
|
|
10071
|
+
value: string[];
|
|
10072
|
+
}
|
|
10073
|
+
/**
|
|
10074
|
+
* devrev-query-template-value
|
|
10075
|
+
* Runtime-resolved variable placeholder for DQL queries.
|
|
10076
|
+
*/
|
|
10077
|
+
export type DevrevQueryTemplateValue = DevrevQueryTemplateValueMe & {
|
|
10078
|
+
value: DevrevQueryTemplateValueValue;
|
|
10079
|
+
};
|
|
10080
|
+
/**
|
|
10081
|
+
* devrev-query-template-value-me
|
|
10082
|
+
* Resolves to the identity of the currently authenticated user at query
|
|
10083
|
+
* execution time.
|
|
10084
|
+
*/
|
|
10085
|
+
export type DevrevQueryTemplateValueMe = object;
|
|
10086
|
+
export declare enum DevrevQueryTemplateValueValue {
|
|
10087
|
+
Me = "me"
|
|
10088
|
+
}
|
|
8209
10089
|
/** directories-count-request */
|
|
8210
10090
|
export interface DirectoriesCountRequest {
|
|
8211
10091
|
/**
|
|
@@ -10465,6 +12345,14 @@ export declare enum ExportAuditLogsRequestOperationType {
|
|
|
10465
12345
|
* process is asynchronous. Upon completion, the user will be notified.
|
|
10466
12346
|
*/
|
|
10467
12347
|
export type ExportAuditLogsResponse = object;
|
|
12348
|
+
export declare enum ExportCompression {
|
|
12349
|
+
Gzip = "gzip",
|
|
12350
|
+
None = "none"
|
|
12351
|
+
}
|
|
12352
|
+
export declare enum ExportFormatValue {
|
|
12353
|
+
Csv = "csv",
|
|
12354
|
+
Json = "json"
|
|
12355
|
+
}
|
|
10468
12356
|
/** external-communication-channel-summary */
|
|
10469
12357
|
export type ExternalCommunicationChannelSummary = AtomBaseSummary;
|
|
10470
12358
|
/**
|
|
@@ -10909,6 +12797,13 @@ export interface FlameGraphWidgetVisualization {
|
|
|
10909
12797
|
/** The configuration for the Y-axes. */
|
|
10910
12798
|
y: FlameGraphVisualizationYAxis[];
|
|
10911
12799
|
}
|
|
12800
|
+
/** The time scale for the gantt visualization. */
|
|
12801
|
+
export declare enum GanttWidgetVisualizationTimeScale {
|
|
12802
|
+
Day = "day",
|
|
12803
|
+
Month = "month",
|
|
12804
|
+
Week = "week",
|
|
12805
|
+
Year = "year"
|
|
12806
|
+
}
|
|
10912
12807
|
/**
|
|
10913
12808
|
* general-preferences-group
|
|
10914
12809
|
* Preferences group for General settings.
|
|
@@ -11302,22 +13197,6 @@ export interface GroupsCreateRequest {
|
|
|
11302
13197
|
export interface GroupsCreateResponse {
|
|
11303
13198
|
group: Group;
|
|
11304
13199
|
}
|
|
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
13200
|
/**
|
|
11322
13201
|
* groups-get-request
|
|
11323
13202
|
* A request to get information about a group.
|
|
@@ -12134,6 +14013,11 @@ export type Issue = WorkBase & {
|
|
|
12134
14013
|
actual_start_date?: string;
|
|
12135
14014
|
/** Parts associated based on git events. */
|
|
12136
14015
|
developed_with?: PartSummary[];
|
|
14016
|
+
/**
|
|
14017
|
+
* The space scoped display ID alias of the issue.
|
|
14018
|
+
* @format text
|
|
14019
|
+
*/
|
|
14020
|
+
display_id_alias?: string;
|
|
12137
14021
|
/**
|
|
12138
14022
|
* Estimated effort to complete the issue.
|
|
12139
14023
|
* @format double
|
|
@@ -12177,6 +14061,11 @@ export declare enum IssuePriority {
|
|
|
12177
14061
|
}
|
|
12178
14062
|
/** issue-summary */
|
|
12179
14063
|
export type IssueSummary = WorkBaseSummary & {
|
|
14064
|
+
/**
|
|
14065
|
+
* The space scoped display ID alias of the issue.
|
|
14066
|
+
* @format text
|
|
14067
|
+
*/
|
|
14068
|
+
display_id_alias?: string;
|
|
12180
14069
|
/** Priority of the work based upon impact and criticality. */
|
|
12181
14070
|
priority?: IssuePriority;
|
|
12182
14071
|
/** The properties of an enum value. */
|
|
@@ -12242,6 +14131,7 @@ export declare enum JobCategory {
|
|
|
12242
14131
|
MergeRevorg = "merge_revorg",
|
|
12243
14132
|
MergeRevuser = "merge_revuser",
|
|
12244
14133
|
MergeTicket = "merge_ticket",
|
|
14134
|
+
MigrateVistaReports = "migrate_vista_reports",
|
|
12245
14135
|
MoveRevorg = "move_revorg",
|
|
12246
14136
|
MoveRevuser = "move_revuser",
|
|
12247
14137
|
OasisDataExport = "oasis_data_export",
|
|
@@ -12287,6 +14177,8 @@ export declare enum JobState {
|
|
|
12287
14177
|
Queued = "queued",
|
|
12288
14178
|
Started = "started"
|
|
12289
14179
|
}
|
|
14180
|
+
/** job-summary */
|
|
14181
|
+
export type JobSummary = AtomBaseSummary;
|
|
12290
14182
|
/**
|
|
12291
14183
|
* jobs-get-request
|
|
12292
14184
|
* Request object to get a job's information.
|
|
@@ -12526,6 +14418,12 @@ export interface LineVisualizationYAxis {
|
|
|
12526
14418
|
*/
|
|
12527
14419
|
reference_name: string;
|
|
12528
14420
|
}
|
|
14421
|
+
/** The stroke style for the line. */
|
|
14422
|
+
export declare enum LineVisualizationYAxisStrokeStyle {
|
|
14423
|
+
Dashed = "dashed",
|
|
14424
|
+
Dotted = "dotted",
|
|
14425
|
+
Solid = "solid"
|
|
14426
|
+
}
|
|
12529
14427
|
/**
|
|
12530
14428
|
* line-widget-visualization
|
|
12531
14429
|
* A line chart visualization configuration. Includes metadata specific to
|
|
@@ -13096,6 +14994,14 @@ export type MarketplaceItemSummary = AtomBaseSummary & {
|
|
|
13096
14994
|
* (e.g. Jira AirSync).
|
|
13097
14995
|
*/
|
|
13098
14996
|
item_type?: MarketplaceItemItemType;
|
|
14997
|
+
/**
|
|
14998
|
+
* Meta score of the marketplace items. Its value must be in range
|
|
14999
|
+
* from 1 to 100000. It is used for ranking marketplace items on the
|
|
15000
|
+
* Marketplace home page. Items with higher meta_score will be placed
|
|
15001
|
+
* on the top of the list.
|
|
15002
|
+
* @format int64
|
|
15003
|
+
*/
|
|
15004
|
+
meta_score?: number;
|
|
13099
15005
|
/**
|
|
13100
15006
|
* Name of the marketplace listing. The value for a name can be any
|
|
13101
15007
|
* string with a minimum length of 3 and a maximum length of 128.
|
|
@@ -13136,7 +15042,9 @@ export interface MarketplaceItemsInstallResponse {
|
|
|
13136
15042
|
}
|
|
13137
15043
|
/**
|
|
13138
15044
|
* meerkat-widget-column-function
|
|
13139
|
-
*
|
|
15045
|
+
* Deprecated: Use widget_query_column_config with type=function on
|
|
15046
|
+
* widget_query.measure_configs or dimension_configs instead. A meerkat
|
|
15047
|
+
* specific column function.
|
|
13140
15048
|
*/
|
|
13141
15049
|
export interface MeerkatWidgetColumnFunction {
|
|
13142
15050
|
/** The type of the function. */
|
|
@@ -13163,7 +15071,11 @@ export declare enum MeerkatWidgetColumnFunctionType {
|
|
|
13163
15071
|
export interface MeerkatWidgetColumnProjection {
|
|
13164
15072
|
/** The data type of the column generated by the SQL expression. */
|
|
13165
15073
|
type: MeerkatWidgetColumnProjectionType;
|
|
13166
|
-
/**
|
|
15074
|
+
/**
|
|
15075
|
+
* Deprecated: Use widget_query_column_config with type=function on
|
|
15076
|
+
* widget_query.measure_configs or dimension_configs instead. A meerkat
|
|
15077
|
+
* specific column function.
|
|
15078
|
+
*/
|
|
13167
15079
|
function?: MeerkatWidgetColumnFunction;
|
|
13168
15080
|
/**
|
|
13169
15081
|
* The SQL expression used to extract or transform the column from the
|
|
@@ -13171,10 +15083,18 @@ export interface MeerkatWidgetColumnProjection {
|
|
|
13171
15083
|
* @format text
|
|
13172
15084
|
*/
|
|
13173
15085
|
sql_expression: string;
|
|
13174
|
-
/**
|
|
15086
|
+
/**
|
|
15087
|
+
* Deprecated: Use widget_query_column_config with type=timestamp on
|
|
15088
|
+
* widget_query.dimension_configs instead. The rollup granularity for the
|
|
15089
|
+
* timestamp.
|
|
15090
|
+
*/
|
|
13175
15091
|
timestamp_rollup?: MeerkatWidgetColumnProjectionTimestampRollup;
|
|
13176
15092
|
}
|
|
13177
|
-
/**
|
|
15093
|
+
/**
|
|
15094
|
+
* Deprecated: Use widget_query_column_config with type=timestamp on
|
|
15095
|
+
* widget_query.dimension_configs instead. The rollup granularity for the
|
|
15096
|
+
* timestamp.
|
|
15097
|
+
*/
|
|
13178
15098
|
export declare enum MeerkatWidgetColumnProjectionTimestampRollup {
|
|
13179
15099
|
Day = "day",
|
|
13180
15100
|
Hour = "hour",
|
|
@@ -13235,7 +15155,7 @@ export type Meeting = AtomBase & {
|
|
|
13235
15155
|
*/
|
|
13236
15156
|
external_url?: string;
|
|
13237
15157
|
/** The members in the meeting. */
|
|
13238
|
-
members
|
|
15158
|
+
members?: AtomSummary[];
|
|
13239
15159
|
organizer?: AtomSummary;
|
|
13240
15160
|
parent?: AtomSummary;
|
|
13241
15161
|
recording?: ArtifactSummary;
|
|
@@ -13423,7 +15343,7 @@ export interface MeetingsCreateRequest {
|
|
|
13423
15343
|
external_url?: string;
|
|
13424
15344
|
/**
|
|
13425
15345
|
* IDs of the users or groups that were part of the meeting.
|
|
13426
|
-
* @maxItems
|
|
15346
|
+
* @maxItems 2000
|
|
13427
15347
|
* @minItems 1
|
|
13428
15348
|
* @example ["DEVU-12345"]
|
|
13429
15349
|
*/
|
|
@@ -13495,6 +15415,76 @@ export interface MeetingsDeleteRequest {
|
|
|
13495
15415
|
}
|
|
13496
15416
|
/** meetings-delete-response */
|
|
13497
15417
|
export type MeetingsDeleteResponse = object;
|
|
15418
|
+
/**
|
|
15419
|
+
* meetings-export-async-request
|
|
15420
|
+
* Request object to start an asynchronous meeting export.
|
|
15421
|
+
*/
|
|
15422
|
+
export interface MeetingsExportAsyncRequest {
|
|
15423
|
+
/** Filters for meeting on specified channels. */
|
|
15424
|
+
channel?: MeetingChannel[];
|
|
15425
|
+
/**
|
|
15426
|
+
* The columns to include in the export along with their names in the
|
|
15427
|
+
* export file, e.g., "title=Title". If the list of columns is empty,
|
|
15428
|
+
* all the fields will be exported.
|
|
15429
|
+
*/
|
|
15430
|
+
columns?: string[];
|
|
15431
|
+
compression?: ExportCompression;
|
|
15432
|
+
/** Filters for meetings created by the specified user(s). */
|
|
15433
|
+
created_by?: string[];
|
|
15434
|
+
/** Provides ways to specify date ranges on objects. */
|
|
15435
|
+
created_date?: DateFilter;
|
|
15436
|
+
/** Filters for meeting on custom fields. */
|
|
15437
|
+
custom_fields?: object;
|
|
15438
|
+
/** Direction of the meetings to be fetched. */
|
|
15439
|
+
direction?: MeetingDirection[];
|
|
15440
|
+
/** Provides ways to specify date ranges on objects. */
|
|
15441
|
+
ended_date?: DateFilter;
|
|
15442
|
+
/** Filters for meetings with the provided external_ref(s). */
|
|
15443
|
+
external_ref?: string[];
|
|
15444
|
+
/**
|
|
15445
|
+
* The name of the file user wants to give to the exported file. If
|
|
15446
|
+
* not set, the file name will be the default name. If the file name
|
|
15447
|
+
* exceeds 128 bytes after sanitization, it will be truncated to 128
|
|
15448
|
+
* bytes.
|
|
15449
|
+
* @format text
|
|
15450
|
+
*/
|
|
15451
|
+
file_name?: string;
|
|
15452
|
+
format?: ExportFormatValue;
|
|
15453
|
+
/** Filters for links associated with the meeting. */
|
|
15454
|
+
links?: MeetingsFilterLinkSummaryFilter[];
|
|
15455
|
+
/** Filter for meeting on specified Member Ids. */
|
|
15456
|
+
members?: string[];
|
|
15457
|
+
/** Provides ways to specify date ranges on objects. */
|
|
15458
|
+
modified_date?: DateFilter;
|
|
15459
|
+
/** Filter for meeting on specified organizers. */
|
|
15460
|
+
organizer?: string[];
|
|
15461
|
+
/**
|
|
15462
|
+
* Filters for meetings with the provided parent.
|
|
15463
|
+
* @deprecated
|
|
15464
|
+
* @example ["ACC-12345"]
|
|
15465
|
+
*/
|
|
15466
|
+
parent?: string[];
|
|
15467
|
+
/** Provides ways to specify date ranges on objects. */
|
|
15468
|
+
scheduled_date?: DateFilter;
|
|
15469
|
+
/** Filters for meeting on specified state or outcomes. */
|
|
15470
|
+
state?: MeetingState[];
|
|
15471
|
+
/** Subtypes of meeting to be filtered. */
|
|
15472
|
+
subtype?: string[];
|
|
15473
|
+
sync_metadata?: SyncMetadataFilter;
|
|
15474
|
+
/** Filters for meeting by tags. */
|
|
15475
|
+
tags?: string[];
|
|
15476
|
+
}
|
|
15477
|
+
/**
|
|
15478
|
+
* meetings-export-async-response
|
|
15479
|
+
* The response of starting an asynchronous meeting export.
|
|
15480
|
+
*/
|
|
15481
|
+
export interface MeetingsExportAsyncResponse {
|
|
15482
|
+
/**
|
|
15483
|
+
* The ID of the export meeting job.
|
|
15484
|
+
* @format id
|
|
15485
|
+
*/
|
|
15486
|
+
id?: string;
|
|
15487
|
+
}
|
|
13498
15488
|
/**
|
|
13499
15489
|
* meetings-filter-link-summary-filter
|
|
13500
15490
|
* The filter for the link summary.
|
|
@@ -13852,7 +15842,6 @@ export declare enum MethodOptionsTagValue {
|
|
|
13852
15842
|
SnapIns = "snap_ins",
|
|
13853
15843
|
SnapKitExecution = "snap_kit_execution",
|
|
13854
15844
|
SnapWidgets = "snap_widgets",
|
|
13855
|
-
Spaces = "spaces",
|
|
13856
15845
|
Subscribers = "subscribers",
|
|
13857
15846
|
Surveys = "surveys",
|
|
13858
15847
|
SysUsers = "sys_users",
|
|
@@ -14582,6 +16571,16 @@ export interface Money {
|
|
|
14582
16571
|
*/
|
|
14583
16572
|
currency?: string;
|
|
14584
16573
|
}
|
|
16574
|
+
/** network-log */
|
|
16575
|
+
export interface NetworkLog {
|
|
16576
|
+
/**
|
|
16577
|
+
* Type of the network log.
|
|
16578
|
+
* @format text
|
|
16579
|
+
*/
|
|
16580
|
+
type: string;
|
|
16581
|
+
request: ObservabilityNetworkRequest;
|
|
16582
|
+
response: ObservabilityNetworkResponse;
|
|
16583
|
+
}
|
|
14585
16584
|
/** notification-content-template */
|
|
14586
16585
|
export type NotificationContentTemplate = ContentTemplateBase;
|
|
14587
16586
|
/** notification-content-template-summary */
|
|
@@ -14619,6 +16618,92 @@ export type ObjectMemberSummary = AtomBaseSummary & {
|
|
|
14619
16618
|
/** Sync information for records synced into/from DevRev. */
|
|
14620
16619
|
sync_metadata?: SyncMetadataSummary;
|
|
14621
16620
|
};
|
|
16621
|
+
/**
|
|
16622
|
+
* objects-list-request
|
|
16623
|
+
* Request for objects list.
|
|
16624
|
+
*/
|
|
16625
|
+
export interface ObjectsListRequest {
|
|
16626
|
+
/** A unified query language for DevRev objects. */
|
|
16627
|
+
dql_query?: DevrevQuery;
|
|
16628
|
+
}
|
|
16629
|
+
/**
|
|
16630
|
+
* objects-list-response
|
|
16631
|
+
* Response for objects list.
|
|
16632
|
+
*/
|
|
16633
|
+
export type ObjectsListResponse = (ObjectsListResponseArticlesList | ObjectsListResponseCustomObjectsList | ObjectsListResponseEnhancementsList | ObjectsListResponseIssuesList) & {
|
|
16634
|
+
type: ObjectsListResponseType;
|
|
16635
|
+
/**
|
|
16636
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
16637
|
+
* sort order. If not set, then no later elements exist.
|
|
16638
|
+
* @format text
|
|
16639
|
+
*/
|
|
16640
|
+
next_cursor?: string;
|
|
16641
|
+
/**
|
|
16642
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
16643
|
+
* sort order. If not set, then no prior elements exist.
|
|
16644
|
+
* @format text
|
|
16645
|
+
*/
|
|
16646
|
+
prev_cursor?: string;
|
|
16647
|
+
};
|
|
16648
|
+
/** objects-list-response-articles-list */
|
|
16649
|
+
export interface ObjectsListResponseArticlesList {
|
|
16650
|
+
/** The list of articles. */
|
|
16651
|
+
articles: Article[];
|
|
16652
|
+
}
|
|
16653
|
+
/** objects-list-response-custom-objects-list */
|
|
16654
|
+
export interface ObjectsListResponseCustomObjectsList {
|
|
16655
|
+
/** The list of custom objects. */
|
|
16656
|
+
custom_objects: CustomObject[];
|
|
16657
|
+
}
|
|
16658
|
+
/** objects-list-response-enhancements-list */
|
|
16659
|
+
export interface ObjectsListResponseEnhancementsList {
|
|
16660
|
+
/** The list of enhancements. */
|
|
16661
|
+
enhancements: Enhancement[];
|
|
16662
|
+
}
|
|
16663
|
+
/** objects-list-response-issues-list */
|
|
16664
|
+
export interface ObjectsListResponseIssuesList {
|
|
16665
|
+
/** The list of issues. */
|
|
16666
|
+
issues: Work[];
|
|
16667
|
+
}
|
|
16668
|
+
export declare enum ObjectsListResponseType {
|
|
16669
|
+
Articles = "articles",
|
|
16670
|
+
CustomObjects = "custom_objects",
|
|
16671
|
+
Enhancements = "enhancements",
|
|
16672
|
+
Issues = "issues"
|
|
16673
|
+
}
|
|
16674
|
+
/** observability-network-request */
|
|
16675
|
+
export interface ObservabilityNetworkRequest {
|
|
16676
|
+
/**
|
|
16677
|
+
* HTTP method of the request.
|
|
16678
|
+
* @format text
|
|
16679
|
+
*/
|
|
16680
|
+
method: string;
|
|
16681
|
+
/**
|
|
16682
|
+
* Start time of the request.
|
|
16683
|
+
* @format date-time
|
|
16684
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
16685
|
+
*/
|
|
16686
|
+
start_time: string;
|
|
16687
|
+
/**
|
|
16688
|
+
* URL of the network request.
|
|
16689
|
+
* @format text
|
|
16690
|
+
*/
|
|
16691
|
+
url: string;
|
|
16692
|
+
}
|
|
16693
|
+
/** observability-network-response */
|
|
16694
|
+
export interface ObservabilityNetworkResponse {
|
|
16695
|
+
/**
|
|
16696
|
+
* End time of the response.
|
|
16697
|
+
* @format date-time
|
|
16698
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
16699
|
+
*/
|
|
16700
|
+
end_time: string;
|
|
16701
|
+
/**
|
|
16702
|
+
* HTTP status code of the response.
|
|
16703
|
+
* @format int32
|
|
16704
|
+
*/
|
|
16705
|
+
status: number;
|
|
16706
|
+
}
|
|
14622
16707
|
/** observability-session */
|
|
14623
16708
|
export type ObservabilitySession = (UtilRequiredKeys<MobileSession, 'session_id'> | UtilRequiredKeys<WebSession, 'session_id'>) & {
|
|
14624
16709
|
type: ObservabilitySessionType;
|
|
@@ -14634,6 +16719,214 @@ export declare enum ObservabilitySessionType {
|
|
|
14634
16719
|
Mobile = "mobile",
|
|
14635
16720
|
Web = "web"
|
|
14636
16721
|
}
|
|
16722
|
+
/** observability-sessions-aggregate-request */
|
|
16723
|
+
export type ObservabilitySessionsAggregateRequest = (MobileSessionsFilter | WebSessionsFilter) & {
|
|
16724
|
+
type: ObservabilitySessionsAggregateRequestType;
|
|
16725
|
+
/**
|
|
16726
|
+
* List of aggregation configurations. Each aggregation has a key
|
|
16727
|
+
* field for identification.
|
|
16728
|
+
*/
|
|
16729
|
+
aggregations?: ObservabilitySessionsAggregateRequestAggregationConfig[];
|
|
16730
|
+
/** To filter indexes by partition fields. */
|
|
16731
|
+
partition_filters?: Record<string, string>;
|
|
16732
|
+
schema_type: ObservabilitySessionsAggregateRequestSchemaType;
|
|
16733
|
+
/** Provides ways to specify date ranges on objects. */
|
|
16734
|
+
time_range: DateFilter;
|
|
16735
|
+
/**
|
|
16736
|
+
* The unique app ID to which the session belongs.
|
|
16737
|
+
* @format text
|
|
16738
|
+
* @minLength 1
|
|
16739
|
+
*/
|
|
16740
|
+
version_key: string;
|
|
16741
|
+
};
|
|
16742
|
+
/** observability-sessions-aggregate-request-aggregation-config */
|
|
16743
|
+
export type ObservabilitySessionsAggregateRequestAggregationConfig = (ObservabilitySessionsAggregateRequestAvgAggregation | ObservabilitySessionsAggregateRequestCountAggregation | ObservabilitySessionsAggregateRequestDateHistogramAggregation | ObservabilitySessionsAggregateRequestMaxAggregation | ObservabilitySessionsAggregateRequestMinAggregation | ObservabilitySessionsAggregateRequestPercentilesAggregation | ObservabilitySessionsAggregateRequestSumAggregation | ObservabilitySessionsAggregateRequestTermsAggregation) & {
|
|
16744
|
+
type: ObservabilitySessionsAggregateRequestAggregationConfigType;
|
|
16745
|
+
/**
|
|
16746
|
+
* Unique identifier for this aggregation.
|
|
16747
|
+
* @format text
|
|
16748
|
+
*/
|
|
16749
|
+
key: string;
|
|
16750
|
+
/** Nested aggregations to perform within each bucket. */
|
|
16751
|
+
sub_aggregations?: ObservabilitySessionsAggregateRequestAggregationConfig[];
|
|
16752
|
+
};
|
|
16753
|
+
export declare enum ObservabilitySessionsAggregateRequestAggregationConfigType {
|
|
16754
|
+
Avg = "avg",
|
|
16755
|
+
Count = "count",
|
|
16756
|
+
DateHistogram = "date_histogram",
|
|
16757
|
+
Max = "max",
|
|
16758
|
+
Min = "min",
|
|
16759
|
+
Percentiles = "percentiles",
|
|
16760
|
+
Sum = "sum",
|
|
16761
|
+
Terms = "terms"
|
|
16762
|
+
}
|
|
16763
|
+
/** observability-sessions-aggregate-request-avg-aggregation */
|
|
16764
|
+
export interface ObservabilitySessionsAggregateRequestAvgAggregation {
|
|
16765
|
+
/**
|
|
16766
|
+
* Field to compute the average on.
|
|
16767
|
+
* @format text
|
|
16768
|
+
*/
|
|
16769
|
+
field: string;
|
|
16770
|
+
}
|
|
16771
|
+
/** observability-sessions-aggregate-request-count-aggregation */
|
|
16772
|
+
export interface ObservabilitySessionsAggregateRequestCountAggregation {
|
|
16773
|
+
/**
|
|
16774
|
+
* Field to count.
|
|
16775
|
+
* @format text
|
|
16776
|
+
*/
|
|
16777
|
+
field: string;
|
|
16778
|
+
}
|
|
16779
|
+
/** observability-sessions-aggregate-request-date-histogram-aggregation */
|
|
16780
|
+
export interface ObservabilitySessionsAggregateRequestDateHistogramAggregation {
|
|
16781
|
+
/**
|
|
16782
|
+
* Date field to aggregate on.
|
|
16783
|
+
* @format text
|
|
16784
|
+
*/
|
|
16785
|
+
field: string;
|
|
16786
|
+
/**
|
|
16787
|
+
* Time interval in milliseconds for histogram buckets.
|
|
16788
|
+
* @format int64
|
|
16789
|
+
*/
|
|
16790
|
+
interval_ms: number;
|
|
16791
|
+
}
|
|
16792
|
+
/** observability-sessions-aggregate-request-max-aggregation */
|
|
16793
|
+
export interface ObservabilitySessionsAggregateRequestMaxAggregation {
|
|
16794
|
+
/**
|
|
16795
|
+
* Field to compute the maximum on.
|
|
16796
|
+
* @format text
|
|
16797
|
+
*/
|
|
16798
|
+
field: string;
|
|
16799
|
+
}
|
|
16800
|
+
/** observability-sessions-aggregate-request-min-aggregation */
|
|
16801
|
+
export interface ObservabilitySessionsAggregateRequestMinAggregation {
|
|
16802
|
+
/**
|
|
16803
|
+
* Field to compute the minimum on.
|
|
16804
|
+
* @format text
|
|
16805
|
+
*/
|
|
16806
|
+
field: string;
|
|
16807
|
+
}
|
|
16808
|
+
/** observability-sessions-aggregate-request-percentiles-aggregation */
|
|
16809
|
+
export interface ObservabilitySessionsAggregateRequestPercentilesAggregation {
|
|
16810
|
+
/**
|
|
16811
|
+
* Field to compute percentiles on.
|
|
16812
|
+
* @format text
|
|
16813
|
+
*/
|
|
16814
|
+
field: string;
|
|
16815
|
+
/**
|
|
16816
|
+
* Percentile values to compute (e.g., [50.0, 90.0, 95.0, 99.0]).
|
|
16817
|
+
* @min 0
|
|
16818
|
+
* @max 100
|
|
16819
|
+
*/
|
|
16820
|
+
percents?: number[];
|
|
16821
|
+
}
|
|
16822
|
+
export declare enum ObservabilitySessionsAggregateRequestSchemaType {
|
|
16823
|
+
MobileCustomEvents = "mobile_custom_events",
|
|
16824
|
+
MobileNetwork = "mobile_network",
|
|
16825
|
+
WebConsole = "web_console",
|
|
16826
|
+
WebCustomEvents = "web_custom_events",
|
|
16827
|
+
WebEvent = "web_event",
|
|
16828
|
+
WebNetwork = "web_network"
|
|
16829
|
+
}
|
|
16830
|
+
/** observability-sessions-aggregate-request-sum-aggregation */
|
|
16831
|
+
export interface ObservabilitySessionsAggregateRequestSumAggregation {
|
|
16832
|
+
/**
|
|
16833
|
+
* Field to compute the sum on.
|
|
16834
|
+
* @format text
|
|
16835
|
+
*/
|
|
16836
|
+
field: string;
|
|
16837
|
+
}
|
|
16838
|
+
/** observability-sessions-aggregate-request-terms-aggregation */
|
|
16839
|
+
export interface ObservabilitySessionsAggregateRequestTermsAggregation {
|
|
16840
|
+
/**
|
|
16841
|
+
* Field to group by.
|
|
16842
|
+
* @format text
|
|
16843
|
+
*/
|
|
16844
|
+
field: string;
|
|
16845
|
+
/**
|
|
16846
|
+
* Maximum number of buckets to return.
|
|
16847
|
+
* @min 1
|
|
16848
|
+
* @max 5000
|
|
16849
|
+
*/
|
|
16850
|
+
size?: number;
|
|
16851
|
+
}
|
|
16852
|
+
export declare enum ObservabilitySessionsAggregateRequestType {
|
|
16853
|
+
Mobile = "mobile",
|
|
16854
|
+
Web = "web"
|
|
16855
|
+
}
|
|
16856
|
+
/** observability-sessions-aggregate-response */
|
|
16857
|
+
export interface ObservabilitySessionsAggregateResponse {
|
|
16858
|
+
/** List of aggregation results. */
|
|
16859
|
+
aggregations: ObservabilitySessionsAggregateResponseAggregationResult[];
|
|
16860
|
+
}
|
|
16861
|
+
/** observability-sessions-aggregate-response-aggregation-result */
|
|
16862
|
+
export type ObservabilitySessionsAggregateResponseAggregationResult = (ObservabilitySessionsAggregateResponseBucketResults | ObservabilitySessionsAggregateResponseMetricResult) & {
|
|
16863
|
+
/**
|
|
16864
|
+
* The key identifying this aggregation result.
|
|
16865
|
+
* @format text
|
|
16866
|
+
*/
|
|
16867
|
+
key: string;
|
|
16868
|
+
result_type: ObservabilitySessionsAggregateResponseAggregationResultResultType;
|
|
16869
|
+
};
|
|
16870
|
+
export declare enum ObservabilitySessionsAggregateResponseAggregationResultResultType {
|
|
16871
|
+
BucketResults = "bucket_results",
|
|
16872
|
+
MetricResult = "metric_result"
|
|
16873
|
+
}
|
|
16874
|
+
/** observability-sessions-aggregate-response-bucket */
|
|
16875
|
+
export interface ObservabilitySessionsAggregateResponseBucket {
|
|
16876
|
+
/**
|
|
16877
|
+
* Number of documents in this bucket.
|
|
16878
|
+
* @min 0
|
|
16879
|
+
* @max 18446744073709552000
|
|
16880
|
+
*/
|
|
16881
|
+
doc_count: number;
|
|
16882
|
+
/**
|
|
16883
|
+
* The bucket key (canonical value - can be string, number, bool,
|
|
16884
|
+
* etc.).
|
|
16885
|
+
*/
|
|
16886
|
+
key: any;
|
|
16887
|
+
/** Results of aggregations within this bucket. */
|
|
16888
|
+
sub_aggregations: ObservabilitySessionsAggregateResponseAggregationResult[];
|
|
16889
|
+
}
|
|
16890
|
+
/** observability-sessions-aggregate-response-bucket-item */
|
|
16891
|
+
export type ObservabilitySessionsAggregateResponseBucketItem = ObservabilitySessionsAggregateResponseBucket & {
|
|
16892
|
+
bucket_type: ObservabilitySessionsAggregateResponseBucketItemBucketType;
|
|
16893
|
+
};
|
|
16894
|
+
export declare enum ObservabilitySessionsAggregateResponseBucketItemBucketType {
|
|
16895
|
+
Bucket = "bucket"
|
|
16896
|
+
}
|
|
16897
|
+
/** observability-sessions-aggregate-response-bucket-results */
|
|
16898
|
+
export interface ObservabilitySessionsAggregateResponseBucketResults {
|
|
16899
|
+
/** List of buckets from the aggregation. */
|
|
16900
|
+
buckets: ObservabilitySessionsAggregateResponseBucketItem[];
|
|
16901
|
+
}
|
|
16902
|
+
/** observability-sessions-aggregate-response-metric-result */
|
|
16903
|
+
export type ObservabilitySessionsAggregateResponseMetricResult = (ObservabilitySessionsAggregateResponsePercentilesResult | ObservabilitySessionsAggregateResponseValueResult) & {
|
|
16904
|
+
metric_type: ObservabilitySessionsAggregateResponseMetricResultMetricType;
|
|
16905
|
+
};
|
|
16906
|
+
export declare enum ObservabilitySessionsAggregateResponseMetricResultMetricType {
|
|
16907
|
+
Avg = "avg",
|
|
16908
|
+
Count = "count",
|
|
16909
|
+
Max = "max",
|
|
16910
|
+
Min = "min",
|
|
16911
|
+
Percentiles = "percentiles",
|
|
16912
|
+
Sum = "sum"
|
|
16913
|
+
}
|
|
16914
|
+
/** observability-sessions-aggregate-response-percentiles-result */
|
|
16915
|
+
export interface ObservabilitySessionsAggregateResponsePercentilesResult {
|
|
16916
|
+
/**
|
|
16917
|
+
* Map of percentile to value (e.g., {'50.0': 123.45, '90.0':
|
|
16918
|
+
* 456.78}).
|
|
16919
|
+
*/
|
|
16920
|
+
values: Record<string, number>;
|
|
16921
|
+
}
|
|
16922
|
+
/** observability-sessions-aggregate-response-value-result */
|
|
16923
|
+
export interface ObservabilitySessionsAggregateResponseValueResult {
|
|
16924
|
+
/**
|
|
16925
|
+
* The computed metric value.
|
|
16926
|
+
* @format double
|
|
16927
|
+
*/
|
|
16928
|
+
value?: number;
|
|
16929
|
+
}
|
|
14637
16930
|
/** observability-sessions-data-get-request */
|
|
14638
16931
|
export interface ObservabilitySessionsDataGetRequest {
|
|
14639
16932
|
/** Whether to include replay data in the response. Defaults to true. */
|
|
@@ -14669,6 +16962,41 @@ export declare enum ObservabilitySessionsDataGetResponseRecording {
|
|
|
14669
16962
|
MobileRecording = "mobile_recording",
|
|
14670
16963
|
WebRecording = "web_recording"
|
|
14671
16964
|
}
|
|
16965
|
+
/** observability-sessions-developer-info-get-request */
|
|
16966
|
+
export interface ObservabilitySessionsDeveloperInfoGetRequest {
|
|
16967
|
+
/** Filter console logs by type. If empty, all types are returned. */
|
|
16968
|
+
console_log_types?: ConsoleLogType[];
|
|
16969
|
+
/**
|
|
16970
|
+
* The unique identifier of the session.
|
|
16971
|
+
* @format text
|
|
16972
|
+
* @minLength 1
|
|
16973
|
+
*/
|
|
16974
|
+
session_id: string;
|
|
16975
|
+
/**
|
|
16976
|
+
* Filter network logs by HTTP status code class. If empty, all
|
|
16977
|
+
* classes are returned.
|
|
16978
|
+
*/
|
|
16979
|
+
status_code_classes?: StatusCodeClass[];
|
|
16980
|
+
/**
|
|
16981
|
+
* unique tab id of the web session.
|
|
16982
|
+
* @format text
|
|
16983
|
+
* @minLength 1
|
|
16984
|
+
*/
|
|
16985
|
+
tab_id: string;
|
|
16986
|
+
/**
|
|
16987
|
+
* version key of the app.
|
|
16988
|
+
* @format text
|
|
16989
|
+
* @minLength 1
|
|
16990
|
+
*/
|
|
16991
|
+
version_key: string;
|
|
16992
|
+
}
|
|
16993
|
+
/** observability-sessions-developer-info-get-response */
|
|
16994
|
+
export interface ObservabilitySessionsDeveloperInfoGetResponse {
|
|
16995
|
+
/** Console data containing error logs and console information. */
|
|
16996
|
+
console_data?: ConsoleLogData[];
|
|
16997
|
+
/** Network data containing request/response information. */
|
|
16998
|
+
network_data?: NetworkLog[];
|
|
16999
|
+
}
|
|
14672
17000
|
/** observability-sessions-get-request */
|
|
14673
17001
|
export interface ObservabilitySessionsGetRequest {
|
|
14674
17002
|
/** The platform type for the device. */
|
|
@@ -15966,6 +18294,11 @@ export declare enum PartsVistaGroupItemType {
|
|
|
15966
18294
|
Curated = "curated",
|
|
15967
18295
|
Dynamic = "dynamic"
|
|
15968
18296
|
}
|
|
18297
|
+
/** The period type for which to calculate period-to-date. */
|
|
18298
|
+
export declare enum PeriodToDate {
|
|
18299
|
+
QuarterToDate = "quarter_to_date",
|
|
18300
|
+
YearToDate = "year_to_date"
|
|
18301
|
+
}
|
|
15969
18302
|
/**
|
|
15970
18303
|
* pie-visualization-x-axis
|
|
15971
18304
|
* The X-axis for a pie visualization.
|
|
@@ -18641,6 +20974,7 @@ export interface SearchCoreResponse {
|
|
|
18641
20974
|
/** The namespaces for hybrid search. */
|
|
18642
20975
|
export declare enum SearchHybridNamespace {
|
|
18643
20976
|
Account = "account",
|
|
20977
|
+
AiAgent = "ai_agent",
|
|
18644
20978
|
Article = "article",
|
|
18645
20979
|
Capability = "capability",
|
|
18646
20980
|
Component = "component",
|
|
@@ -18713,6 +21047,7 @@ export interface SearchHybridResponse {
|
|
|
18713
21047
|
/** The namespaces to search in. */
|
|
18714
21048
|
export declare enum SearchNamespace {
|
|
18715
21049
|
Account = "account",
|
|
21050
|
+
AiAgent = "ai_agent",
|
|
18716
21051
|
Article = "article",
|
|
18717
21052
|
Capability = "capability",
|
|
18718
21053
|
Component = "component",
|
|
@@ -18739,6 +21074,7 @@ export declare enum SearchNamespace {
|
|
|
18739
21074
|
RevUser = "rev_user",
|
|
18740
21075
|
Runnable = "runnable",
|
|
18741
21076
|
ServiceAccount = "service_account",
|
|
21077
|
+
Survey = "survey",
|
|
18742
21078
|
SysUser = "sys_user",
|
|
18743
21079
|
Tag = "tag",
|
|
18744
21080
|
Task = "task",
|
|
@@ -18747,11 +21083,12 @@ export declare enum SearchNamespace {
|
|
|
18747
21083
|
Workflow = "workflow"
|
|
18748
21084
|
}
|
|
18749
21085
|
/** 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) & {
|
|
21086
|
+
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
21087
|
type: SearchResultType;
|
|
18752
21088
|
};
|
|
18753
21089
|
export declare enum SearchResultType {
|
|
18754
21090
|
Account = "account",
|
|
21091
|
+
AiAgent = "ai_agent",
|
|
18755
21092
|
Article = "article",
|
|
18756
21093
|
Artifact = "artifact",
|
|
18757
21094
|
Conversation = "conversation",
|
|
@@ -18767,6 +21104,7 @@ export declare enum SearchResultType {
|
|
|
18767
21104
|
Org = "org",
|
|
18768
21105
|
Part = "part",
|
|
18769
21106
|
QuestionAnswer = "question_answer",
|
|
21107
|
+
Survey = "survey",
|
|
18770
21108
|
Tag = "tag",
|
|
18771
21109
|
User = "user",
|
|
18772
21110
|
Vista = "vista",
|
|
@@ -18885,6 +21223,19 @@ export interface SendNotificationGenericNotificationEntryNotificationActionClick
|
|
|
18885
21223
|
export declare enum SendNotificationType {
|
|
18886
21224
|
GenericNotification = "generic_notification"
|
|
18887
21225
|
}
|
|
21226
|
+
/** The stroke style for the line. */
|
|
21227
|
+
export declare enum SeriesVisualizationStrokeStyle {
|
|
21228
|
+
Dashed = "dashed",
|
|
21229
|
+
Dotted = "dotted",
|
|
21230
|
+
Solid = "solid"
|
|
21231
|
+
}
|
|
21232
|
+
/** The type of the series. */
|
|
21233
|
+
export declare enum SeriesVisualizationType {
|
|
21234
|
+
Bar = "bar",
|
|
21235
|
+
Column = "column",
|
|
21236
|
+
Line = "line",
|
|
21237
|
+
Scatter = "scatter"
|
|
21238
|
+
}
|
|
18888
21239
|
/** service-account */
|
|
18889
21240
|
export type ServiceAccount = UserBase;
|
|
18890
21241
|
/** service-account-summary */
|
|
@@ -19816,6 +22167,67 @@ export type SnapInSummary = AtomBaseSummary;
|
|
|
19816
22167
|
export type SnapInVersion = AtomBase;
|
|
19817
22168
|
/** snap-in-version-summary */
|
|
19818
22169
|
export type SnapInVersionSummary = AtomBaseSummary;
|
|
22170
|
+
/** snap-ins-list-request */
|
|
22171
|
+
export interface SnapInsListRequest {
|
|
22172
|
+
/**
|
|
22173
|
+
* The cursor to resume iteration from. If not provided, then
|
|
22174
|
+
* iteration starts from the beginning.
|
|
22175
|
+
* @format text
|
|
22176
|
+
*/
|
|
22177
|
+
cursor?: string;
|
|
22178
|
+
/**
|
|
22179
|
+
* The maximum number of snap-ins to return. The default is '50', the
|
|
22180
|
+
* maximum is '100'.
|
|
22181
|
+
* @format int32
|
|
22182
|
+
*/
|
|
22183
|
+
limit?: number;
|
|
22184
|
+
/** Filter for marketplace-item associated with snap-in. */
|
|
22185
|
+
marketplace_item?: SnapInsListRequestFilterMarketplaceItemFilter[];
|
|
22186
|
+
/**
|
|
22187
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
22188
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
22189
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
22190
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
22191
|
+
* always be returned in the specified sort-by order.
|
|
22192
|
+
*/
|
|
22193
|
+
mode?: ListMode;
|
|
22194
|
+
/** Filter for service account associated with snap-in. */
|
|
22195
|
+
service_account?: string[];
|
|
22196
|
+
/** Filter for snap-in version associated with snap-in. */
|
|
22197
|
+
snap_in_version?: string[];
|
|
22198
|
+
/** Fields to sort the snap-ins by and the direction to sort them. */
|
|
22199
|
+
sort_by?: string[];
|
|
22200
|
+
}
|
|
22201
|
+
/** snap-ins-list-request-filter-marketplace-item-filter */
|
|
22202
|
+
export interface SnapInsListRequestFilterMarketplaceItemFilter {
|
|
22203
|
+
/**
|
|
22204
|
+
* The marketplace to filter by.
|
|
22205
|
+
* @format id
|
|
22206
|
+
*/
|
|
22207
|
+
marketplace?: string;
|
|
22208
|
+
/**
|
|
22209
|
+
* The marketplace item slug to filter by.
|
|
22210
|
+
* @format text
|
|
22211
|
+
*/
|
|
22212
|
+
marketplace_item_slug?: string;
|
|
22213
|
+
}
|
|
22214
|
+
/** snap-ins-list-response */
|
|
22215
|
+
export interface SnapInsListResponse {
|
|
22216
|
+
/**
|
|
22217
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
22218
|
+
* sort order. If not set, then no later elements exist.
|
|
22219
|
+
* @format text
|
|
22220
|
+
*/
|
|
22221
|
+
next_cursor?: string;
|
|
22222
|
+
/**
|
|
22223
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
22224
|
+
* sort order. If not set, then no prior elements exist.
|
|
22225
|
+
* @format text
|
|
22226
|
+
*/
|
|
22227
|
+
prev_cursor?: string;
|
|
22228
|
+
/** List of snap-ins. */
|
|
22229
|
+
snap_ins: SnapIn[];
|
|
22230
|
+
}
|
|
19819
22231
|
/** snap-ins-resources-request */
|
|
19820
22232
|
export interface SnapInsResourcesRequest {
|
|
19821
22233
|
/**
|
|
@@ -19868,6 +22280,23 @@ export interface SnapInsUpdateRequest {
|
|
|
19868
22280
|
export interface SnapInsUpdateResponse {
|
|
19869
22281
|
snap_in: SnapIn;
|
|
19870
22282
|
}
|
|
22283
|
+
/**
|
|
22284
|
+
* snap-kit-action-execute-deferred-function-result
|
|
22285
|
+
* Result returned by the snap-in when handling a deferred snap-kit
|
|
22286
|
+
* action.
|
|
22287
|
+
*/
|
|
22288
|
+
export interface SnapKitActionExecuteDeferredFunctionResult {
|
|
22289
|
+
/**
|
|
22290
|
+
* Detail message from the snap-in function execution.
|
|
22291
|
+
* @format text
|
|
22292
|
+
*/
|
|
22293
|
+
detail?: string;
|
|
22294
|
+
/**
|
|
22295
|
+
* Status of the snap-in function execution (e.g. 'error', 'success').
|
|
22296
|
+
* @format text
|
|
22297
|
+
*/
|
|
22298
|
+
status?: string;
|
|
22299
|
+
}
|
|
19871
22300
|
/** snap-kit-action-execute-deferred-request */
|
|
19872
22301
|
export interface SnapKitActionExecuteDeferredRequest {
|
|
19873
22302
|
/**
|
|
@@ -19882,7 +22311,13 @@ export interface SnapKitActionExecuteDeferredRequest {
|
|
|
19882
22311
|
id: string;
|
|
19883
22312
|
}
|
|
19884
22313
|
/** snap-kit-action-execute-deferred-response */
|
|
19885
|
-
export
|
|
22314
|
+
export interface SnapKitActionExecuteDeferredResponse {
|
|
22315
|
+
/**
|
|
22316
|
+
* Result returned by the snap-in when handling a deferred snap-kit
|
|
22317
|
+
* action.
|
|
22318
|
+
*/
|
|
22319
|
+
function_result?: SnapKitActionExecuteDeferredFunctionResult;
|
|
22320
|
+
}
|
|
19886
22321
|
/** snap-kit-action-request */
|
|
19887
22322
|
export type SnapKitActionRequest = (SnapKitActionRequestButton | SnapKitActionRequestForm) & {
|
|
19888
22323
|
type: SnapKitActionRequestElementTypeValue;
|
|
@@ -19941,6 +22376,11 @@ export declare enum SnapKitBaseWidgetSnapKitExecution {
|
|
|
19941
22376
|
/** snap-widget */
|
|
19942
22377
|
export type SnapWidget = (EmailPreviewWidget | StarterMessageNudgeWidget) & {
|
|
19943
22378
|
type: SnapWidgetType;
|
|
22379
|
+
/**
|
|
22380
|
+
* The ID of the parent object associated with this widget.
|
|
22381
|
+
* @format id
|
|
22382
|
+
*/
|
|
22383
|
+
parent_id?: string;
|
|
19944
22384
|
};
|
|
19945
22385
|
/** snap-widget-base */
|
|
19946
22386
|
export type SnapWidgetBase = AtomBase & {
|
|
@@ -20078,16 +22518,6 @@ export declare enum SpaceFilterSpaceIdOperatorType {
|
|
|
20078
22518
|
NotNull = "not_null",
|
|
20079
22519
|
Null = "null"
|
|
20080
22520
|
}
|
|
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
22521
|
/**
|
|
20092
22522
|
* sprint-board-automation
|
|
20093
22523
|
* Automations specific to the Sprint Board vistas.
|
|
@@ -20353,6 +22783,14 @@ export interface StarterMessageNudgeWidget {
|
|
|
20353
22783
|
starter_message_nudge_type: StarterMessageNudgeWidgetStarterMessageNudgeType;
|
|
20354
22784
|
}
|
|
20355
22785
|
export type StarterMessageNudgeWidgetStarterMessageNudgeType = string;
|
|
22786
|
+
/** HTTP response status code class. */
|
|
22787
|
+
export declare enum StatusCodeClass {
|
|
22788
|
+
Value1Xx = "1xx",
|
|
22789
|
+
Value2Xx = "2xx",
|
|
22790
|
+
Value3Xx = "3xx",
|
|
22791
|
+
Value4Xx = "4xx",
|
|
22792
|
+
Value5Xx = "5xx"
|
|
22793
|
+
}
|
|
20356
22794
|
/**
|
|
20357
22795
|
* stock-field-override
|
|
20358
22796
|
* A stock field override.
|
|
@@ -20711,8 +23149,25 @@ export type SurveyResponse = AtomBase & {
|
|
|
20711
23149
|
*/
|
|
20712
23150
|
survey?: string;
|
|
20713
23151
|
};
|
|
23152
|
+
/** survey-search-summary */
|
|
23153
|
+
export type SurveySearchSummary = SearchSummaryBase & {
|
|
23154
|
+
survey: SurveySummary;
|
|
23155
|
+
};
|
|
23156
|
+
/** survey-summary */
|
|
23157
|
+
export type SurveySummary = AtomBaseSummary;
|
|
20714
23158
|
/** surveys-create-request */
|
|
20715
23159
|
export interface SurveysCreateRequest {
|
|
23160
|
+
/** Application-defined custom fields. */
|
|
23161
|
+
custom_fields?: object;
|
|
23162
|
+
/**
|
|
23163
|
+
* Custom schemas described using identifiers. Each custom field in the
|
|
23164
|
+
* request must have the corresponding schema specified; omission results
|
|
23165
|
+
* in a Bad Request error. If a custom schema is not included in the
|
|
23166
|
+
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
23167
|
+
* it is recommended to provide tenant_fragment: true and
|
|
23168
|
+
* validate_required_fields: true.
|
|
23169
|
+
*/
|
|
23170
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
20716
23171
|
/**
|
|
20717
23172
|
* Description about the survey.
|
|
20718
23173
|
* @format text
|
|
@@ -21010,6 +23465,17 @@ export interface SurveysSubmitRequest {
|
|
|
21010
23465
|
export type SurveysSubmitResponse = object;
|
|
21011
23466
|
/** surveys-update-request */
|
|
21012
23467
|
export interface SurveysUpdateRequest {
|
|
23468
|
+
/** Application-defined custom fields. */
|
|
23469
|
+
custom_fields?: object;
|
|
23470
|
+
/**
|
|
23471
|
+
* Custom schemas described using identifiers. Each custom field in the
|
|
23472
|
+
* request must have the corresponding schema specified; omission results
|
|
23473
|
+
* in a Bad Request error. If a custom schema is not included in the
|
|
23474
|
+
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
23475
|
+
* it is recommended to provide tenant_fragment: true and
|
|
23476
|
+
* validate_required_fields: true.
|
|
23477
|
+
*/
|
|
23478
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
21013
23479
|
/**
|
|
21014
23480
|
* The updated description about the survey.
|
|
21015
23481
|
* @format text
|
|
@@ -21495,6 +23961,16 @@ export interface SysUsersUpdateRequest {
|
|
|
21495
23961
|
export interface SysUsersUpdateResponse {
|
|
21496
23962
|
sys_user: SysUser;
|
|
21497
23963
|
}
|
|
23964
|
+
/** The type of data storage. */
|
|
23965
|
+
export declare enum TableDataStorageType {
|
|
23966
|
+
InlineData = "inline_data",
|
|
23967
|
+
Url = "url"
|
|
23968
|
+
}
|
|
23969
|
+
/**
|
|
23970
|
+
* table-field
|
|
23971
|
+
* A field definition within a table schema.
|
|
23972
|
+
*/
|
|
23973
|
+
export type TableField = object;
|
|
21498
23974
|
/**
|
|
21499
23975
|
* table-visualization-column
|
|
21500
23976
|
* A column in a table visualization.
|
|
@@ -22203,6 +24679,7 @@ export interface TimelineEntriesGetResponse {
|
|
|
22203
24679
|
* The request to list timeline entries for an object.
|
|
22204
24680
|
*/
|
|
22205
24681
|
export interface TimelineEntriesListRequest {
|
|
24682
|
+
bias?: TimelineEntriesListRequestBias;
|
|
22206
24683
|
/**
|
|
22207
24684
|
* The collection(s) to list entries from, otherwise if not provided,
|
|
22208
24685
|
* all entries are returned.
|
|
@@ -22253,6 +24730,10 @@ export interface TimelineEntriesListRequest {
|
|
|
22253
24730
|
*/
|
|
22254
24731
|
visibility?: TimelineEntryVisibility[];
|
|
22255
24732
|
}
|
|
24733
|
+
export declare enum TimelineEntriesListRequestBias {
|
|
24734
|
+
Quantity = "quantity",
|
|
24735
|
+
Speed = "speed"
|
|
24736
|
+
}
|
|
22256
24737
|
/**
|
|
22257
24738
|
* timeline-entries-list-response
|
|
22258
24739
|
* The response to listing timeline entries for an object.
|
|
@@ -23062,7 +25543,7 @@ export interface UpdateExternalSourceDataComp {
|
|
|
23062
25543
|
* ID of the user that created the object in the source system.
|
|
23063
25544
|
* @format id
|
|
23064
25545
|
*/
|
|
23065
|
-
|
|
25546
|
+
created_by_id?: string;
|
|
23066
25547
|
/**
|
|
23067
25548
|
* Timestamp when the object was created in the source system.
|
|
23068
25549
|
* @format date-time
|
|
@@ -23073,7 +25554,7 @@ export interface UpdateExternalSourceDataComp {
|
|
|
23073
25554
|
* ID of the user that last modified the object in the source system.
|
|
23074
25555
|
* @format id
|
|
23075
25556
|
*/
|
|
23076
|
-
|
|
25557
|
+
modified_by_id?: string;
|
|
23077
25558
|
/**
|
|
23078
25559
|
* Timestamp when the object was modified in the source system.
|
|
23079
25560
|
* @format date-time
|
|
@@ -25115,6 +27596,12 @@ export interface WidgetGroupByConfig {
|
|
|
25115
27596
|
*/
|
|
25116
27597
|
limit?: number;
|
|
25117
27598
|
}
|
|
27599
|
+
/** The identifier for the widget. */
|
|
27600
|
+
export declare enum WidgetIdentifier {
|
|
27601
|
+
AgentGenerated = "agent_generated",
|
|
27602
|
+
SpaceEnhancementDefault = "space_enhancement_default",
|
|
27603
|
+
SpaceIssueDefault = "space_issue_default"
|
|
27604
|
+
}
|
|
25118
27605
|
/**
|
|
25119
27606
|
* widget-oasis-data-source
|
|
25120
27607
|
* An oasis backed data source.
|
|
@@ -25177,6 +27664,11 @@ export interface WidgetPvpConfig {
|
|
|
25177
27664
|
* visualized.
|
|
25178
27665
|
*/
|
|
25179
27666
|
export interface WidgetQuery {
|
|
27667
|
+
/**
|
|
27668
|
+
* Extended dimension configurations that pair column references with
|
|
27669
|
+
* query-time operations like rollups and aggregation functions.
|
|
27670
|
+
*/
|
|
27671
|
+
dimension_configs?: WidgetQueryColumnConfig[];
|
|
25180
27672
|
/**
|
|
25181
27673
|
* The dimensions for the query, which are the categories to group or
|
|
25182
27674
|
* segment the measures. Usually these are the X-axis values in a
|
|
@@ -25196,6 +27688,11 @@ export interface WidgetQuery {
|
|
|
25196
27688
|
* @format int32
|
|
25197
27689
|
*/
|
|
25198
27690
|
limit?: number;
|
|
27691
|
+
/**
|
|
27692
|
+
* Extended measure configurations that pair column references with
|
|
27693
|
+
* query-time operations like aggregation functions and rollups.
|
|
27694
|
+
*/
|
|
27695
|
+
measure_configs?: WidgetQueryColumnConfig[];
|
|
25199
27696
|
/**
|
|
25200
27697
|
* The measures for the query, which are the numerical values to be
|
|
25201
27698
|
* analyzed. Usually these are the Y-axis values in a visualization.
|
|
@@ -25207,6 +27704,70 @@ export interface WidgetQuery {
|
|
|
25207
27704
|
*/
|
|
25208
27705
|
order_by?: WidgetQueryOrderBy[];
|
|
25209
27706
|
}
|
|
27707
|
+
/**
|
|
27708
|
+
* widget-query-column-config
|
|
27709
|
+
* Configuration for a column in a query. Combines a column reference with
|
|
27710
|
+
* a query-time operation (rollup or aggregation). The reference_name is a
|
|
27711
|
+
* deterministic hash of column_name + type + value, serving as a unique
|
|
27712
|
+
* identifier for downstream references (visualization axes, order_by,
|
|
27713
|
+
* filters).
|
|
27714
|
+
*/
|
|
27715
|
+
export interface WidgetQueryColumnConfig {
|
|
27716
|
+
/**
|
|
27717
|
+
* The category of the query-time operation. Time_granularity buckets
|
|
27718
|
+
* timestamp values by granularity. Aggregation applies an aggregate
|
|
27719
|
+
* function to the column. When omitted the column is a plain reference.
|
|
27720
|
+
*/
|
|
27721
|
+
type?: WidgetQueryColumnConfigType;
|
|
27722
|
+
/** The aggregation function type. Set when type is aggregation. */
|
|
27723
|
+
aggregation?: WidgetQueryColumnConfigAggregation;
|
|
27724
|
+
/**
|
|
27725
|
+
* The name of the source column from the data source.
|
|
27726
|
+
* @format text
|
|
27727
|
+
*/
|
|
27728
|
+
column_name: string;
|
|
27729
|
+
/**
|
|
27730
|
+
* A deterministic unique identifier derived from column_name, type,
|
|
27731
|
+
* and the active value field. Used to reference this column+operation
|
|
27732
|
+
* in visualization axes, order_by, filters, and other downstream
|
|
27733
|
+
* configurations.
|
|
27734
|
+
* @format text
|
|
27735
|
+
*/
|
|
27736
|
+
reference_name: string;
|
|
27737
|
+
/** The time granularity for bucketing. Set when type is time_granularity. */
|
|
27738
|
+
time_granularity?: WidgetQueryColumnConfigTimeGranularity;
|
|
27739
|
+
}
|
|
27740
|
+
/** The aggregation function type. Set when type is aggregation. */
|
|
27741
|
+
export declare enum WidgetQueryColumnConfigAggregation {
|
|
27742
|
+
Avg = "avg",
|
|
27743
|
+
Count = "count",
|
|
27744
|
+
CountDistinct = "count_distinct",
|
|
27745
|
+
Max = "max",
|
|
27746
|
+
Median = "median",
|
|
27747
|
+
Min = "min",
|
|
27748
|
+
P50 = "p50",
|
|
27749
|
+
P90 = "p90",
|
|
27750
|
+
P95 = "p95",
|
|
27751
|
+
P99 = "p99",
|
|
27752
|
+
Sum = "sum"
|
|
27753
|
+
}
|
|
27754
|
+
/** The time granularity for bucketing. Set when type is time_granularity. */
|
|
27755
|
+
export declare enum WidgetQueryColumnConfigTimeGranularity {
|
|
27756
|
+
Day = "day",
|
|
27757
|
+
Hour = "hour",
|
|
27758
|
+
Month = "month",
|
|
27759
|
+
Week = "week",
|
|
27760
|
+
Year = "year"
|
|
27761
|
+
}
|
|
27762
|
+
/**
|
|
27763
|
+
* The category of the query-time operation. Time_granularity buckets
|
|
27764
|
+
* timestamp values by granularity. Aggregation applies an aggregate
|
|
27765
|
+
* function to the column. When omitted the column is a plain reference.
|
|
27766
|
+
*/
|
|
27767
|
+
export declare enum WidgetQueryColumnConfigType {
|
|
27768
|
+
Aggregation = "aggregation",
|
|
27769
|
+
TimeGranularity = "time_granularity"
|
|
27770
|
+
}
|
|
25210
27771
|
/**
|
|
25211
27772
|
* widget-query-joins
|
|
25212
27773
|
* A list of possible joins for the data source. Follows foreign key
|
|
@@ -25250,6 +27811,12 @@ export type WidgetSummary = AtomBaseSummary & {
|
|
|
25250
27811
|
* The table manifest for the widget.
|
|
25251
27812
|
*/
|
|
25252
27813
|
export type WidgetTableManifest = object;
|
|
27814
|
+
/** The version of the widget. */
|
|
27815
|
+
export declare enum WidgetVersion {
|
|
27816
|
+
V0 = "v0",
|
|
27817
|
+
V1 = "v1",
|
|
27818
|
+
V2 = "v2"
|
|
27819
|
+
}
|
|
25253
27820
|
/**
|
|
25254
27821
|
* widget-visualization
|
|
25255
27822
|
* The visualization for a widget. This includes the type of visualization
|
|
@@ -25339,6 +27906,81 @@ export declare enum WidgetVisualizationType {
|
|
|
25339
27906
|
Scatter = "scatter",
|
|
25340
27907
|
Table = "table"
|
|
25341
27908
|
}
|
|
27909
|
+
/**
|
|
27910
|
+
* widgets-create-request
|
|
27911
|
+
* The request to create a widget.
|
|
27912
|
+
*/
|
|
27913
|
+
export interface WidgetsCreateRequest {
|
|
27914
|
+
/** The app fragment names installed by the widget. */
|
|
27915
|
+
apps?: string[];
|
|
27916
|
+
/** Data sources provide the backing data tables for the widget. */
|
|
27917
|
+
data_sources?: CreateWidgetDataSource[];
|
|
27918
|
+
/**
|
|
27919
|
+
* A brief summary of what the widget displays or represents.
|
|
27920
|
+
* @format text
|
|
27921
|
+
*/
|
|
27922
|
+
description?: string;
|
|
27923
|
+
/** The identifier for the widget. */
|
|
27924
|
+
identifier?: WidgetIdentifier;
|
|
27925
|
+
/**
|
|
27926
|
+
* The insights associated with the widget for agent generated
|
|
27927
|
+
* widgets.
|
|
27928
|
+
* @format text
|
|
27929
|
+
*/
|
|
27930
|
+
insights?: string;
|
|
27931
|
+
/** Whether the widget is a draft widget. */
|
|
27932
|
+
is_draft?: boolean;
|
|
27933
|
+
/** Whether the widget is a system widget. */
|
|
27934
|
+
is_system?: boolean;
|
|
27935
|
+
/**
|
|
27936
|
+
* Layout of the widget. It determines the organization of the sub
|
|
27937
|
+
* widgets.
|
|
27938
|
+
*/
|
|
27939
|
+
layout: CreateGridLayout[];
|
|
27940
|
+
/**
|
|
27941
|
+
* A unique identifying name for the widget (optional).
|
|
27942
|
+
* @format text
|
|
27943
|
+
*/
|
|
27944
|
+
name?: string;
|
|
27945
|
+
/**
|
|
27946
|
+
* The ID of the parent surface on which this widget is embedded.
|
|
27947
|
+
* Widget can be optionally part of a parent surface which can be
|
|
27948
|
+
* moved to another surface.
|
|
27949
|
+
* @format id
|
|
27950
|
+
* @example "VISTA-12345"
|
|
27951
|
+
*/
|
|
27952
|
+
parent_id?: string;
|
|
27953
|
+
/**
|
|
27954
|
+
* The list of users, groups and audiences with whom the widget is
|
|
27955
|
+
* shared and the corresponding roles.
|
|
27956
|
+
*/
|
|
27957
|
+
shared_with?: SetSharedWithMembership[];
|
|
27958
|
+
/**
|
|
27959
|
+
* The space associated with the object.
|
|
27960
|
+
* @format id
|
|
27961
|
+
*/
|
|
27962
|
+
space?: string;
|
|
27963
|
+
/**
|
|
27964
|
+
* A list of sub-widgets that the widget contains. Each widget can
|
|
27965
|
+
* contain multiple sub-widgets.
|
|
27966
|
+
*/
|
|
27967
|
+
sub_widgets: CreateSubWidget[];
|
|
27968
|
+
table_manifest?: CreateWidgetTableManifest;
|
|
27969
|
+
/**
|
|
27970
|
+
* The title of the widget.
|
|
27971
|
+
* @format text
|
|
27972
|
+
*/
|
|
27973
|
+
title: string;
|
|
27974
|
+
/** The version of the widget. */
|
|
27975
|
+
version?: WidgetVersion;
|
|
27976
|
+
}
|
|
27977
|
+
/**
|
|
27978
|
+
* widgets-create-response
|
|
27979
|
+
* The response to a widget create request.
|
|
27980
|
+
*/
|
|
27981
|
+
export interface WidgetsCreateResponse {
|
|
27982
|
+
widget: Widget;
|
|
27983
|
+
}
|
|
25342
27984
|
/**
|
|
25343
27985
|
* widgets-get-request
|
|
25344
27986
|
* The request to get a widget.
|
|
@@ -26237,6 +28879,13 @@ export interface WorksUpdateRequestArtifacts {
|
|
|
26237
28879
|
/** works-update-request-issue */
|
|
26238
28880
|
export interface WorksUpdateRequestIssue {
|
|
26239
28881
|
developed_with?: WorksUpdateRequestIssueDevelopedWith;
|
|
28882
|
+
/**
|
|
28883
|
+
* Updates the timestamp of the last code activity (e.g. latest commit
|
|
28884
|
+
* on all PRs with this issue).
|
|
28885
|
+
* @format date-time
|
|
28886
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
28887
|
+
*/
|
|
28888
|
+
last_code_activity?: string | null;
|
|
26240
28889
|
/** Priority of the work based upon impact and criticality. */
|
|
26241
28890
|
priority?: IssuePriority;
|
|
26242
28891
|
/**
|
|
@@ -27081,6 +29730,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27081
29730
|
* @format text
|
|
27082
29731
|
*/
|
|
27083
29732
|
cursor?: string;
|
|
29733
|
+
/** Filter for sync units that have an action required. */
|
|
29734
|
+
'filter.action_required'?: boolean;
|
|
27084
29735
|
/** Filters for sync units with the provided external system names. */
|
|
27085
29736
|
'filter.external_system_name'?: string[];
|
|
27086
29737
|
/** External system type. */
|
|
@@ -27570,7 +30221,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27570
30221
|
*/
|
|
27571
30222
|
artifactsVersionsPrepare: (data: ArtifactsVersionsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsVersionsPrepareResponse, any, {}>>;
|
|
27572
30223
|
/**
|
|
27573
|
-
* @description Gets the specified object.
|
|
30224
|
+
* @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
30225
|
*
|
|
27575
30226
|
* @tags atoms
|
|
27576
30227
|
* @name AtomsGet
|
|
@@ -27586,7 +30237,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27586
30237
|
id: string;
|
|
27587
30238
|
}, params?: RequestParams) => Promise<AxiosResponse<AtomsGetResponse, any, {}>>;
|
|
27588
30239
|
/**
|
|
27589
|
-
* @description Gets the specified object.
|
|
30240
|
+
* @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
30241
|
*
|
|
27591
30242
|
* @tags atoms
|
|
27592
30243
|
* @name AtomsGetPost
|
|
@@ -28139,6 +30790,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28139
30790
|
* @secure
|
|
28140
30791
|
*/
|
|
28141
30792
|
contentTemplateListPost: (data: ContentTemplateListRequest, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateListResponse, any, {}>>;
|
|
30793
|
+
/**
|
|
30794
|
+
* @description Converts a conversation into work.
|
|
30795
|
+
*
|
|
30796
|
+
* @tags conversations
|
|
30797
|
+
* @name ConversationsConvert
|
|
30798
|
+
* @summary Convert Conversations
|
|
30799
|
+
* @request POST:/conversations.convert
|
|
30800
|
+
* @secure
|
|
30801
|
+
*/
|
|
30802
|
+
conversationsConvert: (data: ConversationsConvertRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsConvertResponse, any, {}>>;
|
|
28142
30803
|
/**
|
|
28143
30804
|
* @description Creates a conversation.
|
|
28144
30805
|
*
|
|
@@ -28607,7 +31268,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28607
31268
|
*/
|
|
28608
31269
|
customObjectsUpdate: (data: CustomObjectsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsUpdateResponse, any, {}>>;
|
|
28609
31270
|
/**
|
|
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.
|
|
31271
|
+
* @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
31272
|
*
|
|
28612
31273
|
* @tags auth-connections, dev-orgs
|
|
28613
31274
|
* @name DevOrgAuthConnectionsCreate
|
|
@@ -28617,7 +31278,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28617
31278
|
*/
|
|
28618
31279
|
devOrgAuthConnectionsCreate: (data: DevOrgAuthConnectionsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsCreateResponse, any, {}>>;
|
|
28619
31280
|
/**
|
|
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.
|
|
31281
|
+
* @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
31282
|
*
|
|
28622
31283
|
* @tags auth-connections, dev-orgs
|
|
28623
31284
|
* @name DevOrgAuthConnectionsDelete
|
|
@@ -28627,7 +31288,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28627
31288
|
*/
|
|
28628
31289
|
devOrgAuthConnectionsDelete: (data: DevOrgAuthConnectionsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
28629
31290
|
/**
|
|
28630
|
-
* @description Retrieves the details for an authentication connection.
|
|
31291
|
+
* @description Retrieves the details for an authentication connection. **Required scopes:** - `dev_org:read`
|
|
28631
31292
|
*
|
|
28632
31293
|
* @tags auth-connections, dev-orgs
|
|
28633
31294
|
* @name DevOrgAuthConnectionsGet
|
|
@@ -28643,7 +31304,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28643
31304
|
id: string;
|
|
28644
31305
|
}, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any, {}>>;
|
|
28645
31306
|
/**
|
|
28646
|
-
* @description Retrieves the details for an authentication connection.
|
|
31307
|
+
* @description Retrieves the details for an authentication connection. **Required scopes:** - `dev_org:read`
|
|
28647
31308
|
*
|
|
28648
31309
|
* @tags auth-connections, dev-orgs
|
|
28649
31310
|
* @name DevOrgAuthConnectionsGetPost
|
|
@@ -28653,7 +31314,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28653
31314
|
*/
|
|
28654
31315
|
devOrgAuthConnectionsGetPost: (data: DevOrgAuthConnectionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any, {}>>;
|
|
28655
31316
|
/**
|
|
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.
|
|
31317
|
+
* @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
31318
|
*
|
|
28658
31319
|
* @tags auth-connections, dev-orgs
|
|
28659
31320
|
* @name DevOrgAuthConnectionsList
|
|
@@ -28663,7 +31324,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28663
31324
|
*/
|
|
28664
31325
|
devOrgAuthConnectionsList: (params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any, {}>>;
|
|
28665
31326
|
/**
|
|
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.
|
|
31327
|
+
* @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
31328
|
*
|
|
28668
31329
|
* @tags auth-connections, dev-orgs
|
|
28669
31330
|
* @name DevOrgAuthConnectionsListPost
|
|
@@ -28673,7 +31334,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28673
31334
|
*/
|
|
28674
31335
|
devOrgAuthConnectionsListPost: (data: Empty, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any, {}>>;
|
|
28675
31336
|
/**
|
|
28676
|
-
* @description Enable or disable an authentication connection for a Dev organization. Atleast one authentication connection must be enabled for a Dev organization.
|
|
31337
|
+
* @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
31338
|
*
|
|
28678
31339
|
* @tags auth-connections, dev-orgs
|
|
28679
31340
|
* @name DevOrgAuthConnectionsToggle
|
|
@@ -28683,7 +31344,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28683
31344
|
*/
|
|
28684
31345
|
devOrgAuthConnectionsToggle: (data: DevOrgAuthConnectionsToggleRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
28685
31346
|
/**
|
|
28686
|
-
* @description Updates an authentication connection.
|
|
31347
|
+
* @description Updates an authentication connection. **Required scopes:** - `dev_org:write`
|
|
28687
31348
|
*
|
|
28688
31349
|
* @tags auth-connections, dev-orgs
|
|
28689
31350
|
* @name DevOrgAuthConnectionsUpdate
|
|
@@ -28693,7 +31354,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28693
31354
|
*/
|
|
28694
31355
|
devOrgAuthConnectionsUpdate: (data: DevOrgAuthConnectionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsUpdateResponse, any, {}>>;
|
|
28695
31356
|
/**
|
|
28696
|
-
* @description Gets the Dev organization's information of the authenticated user.
|
|
31357
|
+
* @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
|
|
28697
31358
|
*
|
|
28698
31359
|
* @tags dev-orgs
|
|
28699
31360
|
* @name DevOrgsGet
|
|
@@ -28703,7 +31364,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28703
31364
|
*/
|
|
28704
31365
|
devOrgsGet: (params?: RequestParams) => Promise<AxiosResponse<DevOrgsGetResponse, any, {}>>;
|
|
28705
31366
|
/**
|
|
28706
|
-
* @description Gets the Dev organization's information of the authenticated user.
|
|
31367
|
+
* @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
|
|
28707
31368
|
*
|
|
28708
31369
|
* @tags dev-orgs
|
|
28709
31370
|
* @name DevOrgsGetPost
|
|
@@ -28713,7 +31374,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28713
31374
|
*/
|
|
28714
31375
|
devOrgsGetPost: (data: DevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgsGetResponse, any, {}>>;
|
|
28715
31376
|
/**
|
|
28716
|
-
* @description Activates the requested user.
|
|
31377
|
+
* @description Activates the requested user. **Required scopes:** - `dev_user:write`
|
|
28717
31378
|
*
|
|
28718
31379
|
* @tags dev-users
|
|
28719
31380
|
* @name DevUsersActivate
|
|
@@ -28723,7 +31384,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28723
31384
|
*/
|
|
28724
31385
|
devUsersActivate: (data: DevUsersActivateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersActivateResponse, any, {}>>;
|
|
28725
31386
|
/**
|
|
28726
|
-
* @description Creates a Dev user for a Dev organization.
|
|
31387
|
+
* @description Creates a Dev user for a Dev organization. **Required scopes:** - `dev_user:write`
|
|
28727
31388
|
*
|
|
28728
31389
|
* @tags dev-users
|
|
28729
31390
|
* @name DevUsersCreate
|
|
@@ -28733,7 +31394,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28733
31394
|
*/
|
|
28734
31395
|
devUsersCreate: (data: DevUsersCreateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersCreateResponse, any, {}>>;
|
|
28735
31396
|
/**
|
|
28736
|
-
* @description Deactivates the requested user.
|
|
31397
|
+
* @description Deactivates the requested user. **Required scopes:** - `dev_user:all`
|
|
28737
31398
|
*
|
|
28738
31399
|
* @tags dev-users
|
|
28739
31400
|
* @name DevUsersDeactivate
|
|
@@ -28743,7 +31404,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28743
31404
|
*/
|
|
28744
31405
|
devUsersDeactivate: (data: DevUsersDeactivateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
28745
31406
|
/**
|
|
28746
|
-
* @description Gets the requested user's information.
|
|
31407
|
+
* @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
|
|
28747
31408
|
*
|
|
28748
31409
|
* @tags dev-users
|
|
28749
31410
|
* @name DevUsersGet
|
|
@@ -28759,7 +31420,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28759
31420
|
id: string;
|
|
28760
31421
|
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any, {}>>;
|
|
28761
31422
|
/**
|
|
28762
|
-
* @description Gets the requested user's information.
|
|
31423
|
+
* @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
|
|
28763
31424
|
*
|
|
28764
31425
|
* @tags dev-users
|
|
28765
31426
|
* @name DevUsersGetPost
|
|
@@ -28769,7 +31430,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28769
31430
|
*/
|
|
28770
31431
|
devUsersGetPost: (data: DevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any, {}>>;
|
|
28771
31432
|
/**
|
|
28772
|
-
* @description Links an external/secondary identity to the Dev user.
|
|
31433
|
+
* @description Links an external/secondary identity to the Dev user. **Required scopes:** - `dev_user:write`
|
|
28773
31434
|
*
|
|
28774
31435
|
* @tags dev-users
|
|
28775
31436
|
* @name DevUsersIdentitiesLink
|
|
@@ -28779,7 +31440,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28779
31440
|
*/
|
|
28780
31441
|
devUsersIdentitiesLink: (data: DevUsersIdentitiesLinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesLinkResponse, any, {}>>;
|
|
28781
31442
|
/**
|
|
28782
|
-
* @description Unlinks an external/secondary identity from the Dev user.
|
|
31443
|
+
* @description Unlinks an external/secondary identity from the Dev user. **Required scopes:** - `dev_user:write`
|
|
28783
31444
|
*
|
|
28784
31445
|
* @tags dev-users
|
|
28785
31446
|
* @name DevUsersIdentitiesUnlink
|
|
@@ -28789,7 +31450,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28789
31450
|
*/
|
|
28790
31451
|
devUsersIdentitiesUnlink: (data: DevUsersIdentitiesUnlinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesUnlinkResponse, any, {}>>;
|
|
28791
31452
|
/**
|
|
28792
|
-
* @description Lists users within your organization.
|
|
31453
|
+
* @description Lists users within your organization. **Required scopes:** - `dev_user:read`
|
|
28793
31454
|
*
|
|
28794
31455
|
* @tags dev-users
|
|
28795
31456
|
* @name DevUsersList
|
|
@@ -28843,7 +31504,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28843
31504
|
timezone?: string[];
|
|
28844
31505
|
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any, {}>>;
|
|
28845
31506
|
/**
|
|
28846
|
-
* @description Lists users within your organization.
|
|
31507
|
+
* @description Lists users within your organization. **Required scopes:** - `dev_user:read`
|
|
28847
31508
|
*
|
|
28848
31509
|
* @tags dev-users
|
|
28849
31510
|
* @name DevUsersListPost
|
|
@@ -28853,7 +31514,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28853
31514
|
*/
|
|
28854
31515
|
devUsersListPost: (data: DevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any, {}>>;
|
|
28855
31516
|
/**
|
|
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.
|
|
31517
|
+
* @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
31518
|
*
|
|
28858
31519
|
* @tags dev-users
|
|
28859
31520
|
* @name DevUsersMerge
|
|
@@ -28863,7 +31524,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28863
31524
|
*/
|
|
28864
31525
|
devUsersMerge: (data: DevUsersMergeRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
28865
31526
|
/**
|
|
28866
|
-
* @description Gets the authenticated user's information.
|
|
31527
|
+
* @description Gets the authenticated user's information. **Required scopes:** No scopes required
|
|
28867
31528
|
*
|
|
28868
31529
|
* @tags dev-users
|
|
28869
31530
|
* @name DevUsersSelf
|
|
@@ -28873,7 +31534,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28873
31534
|
*/
|
|
28874
31535
|
devUsersSelf: (params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any, {}>>;
|
|
28875
31536
|
/**
|
|
28876
|
-
* @description Gets the authenticated user's information.
|
|
31537
|
+
* @description Gets the authenticated user's information. **Required scopes:** No scopes required
|
|
28877
31538
|
*
|
|
28878
31539
|
* @tags dev-users
|
|
28879
31540
|
* @name DevUsersSelfPost
|
|
@@ -28883,7 +31544,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28883
31544
|
*/
|
|
28884
31545
|
devUsersSelfPost: (data: DevUsersSelfRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any, {}>>;
|
|
28885
31546
|
/**
|
|
28886
|
-
* @description Updates the authenticated user.
|
|
31547
|
+
* @description Updates the authenticated user. **Required scopes:** No scopes required
|
|
28887
31548
|
*
|
|
28888
31549
|
* @tags dev-users
|
|
28889
31550
|
* @name DevUsersSelfUpdate
|
|
@@ -28893,7 +31554,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28893
31554
|
*/
|
|
28894
31555
|
devUsersSelfUpdate: (data: DevUsersSelfUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any, {}>>;
|
|
28895
31556
|
/**
|
|
28896
|
-
* @description Updates the user corresponding to the input Id.
|
|
31557
|
+
* @description Updates the user corresponding to the input Id. **Required scopes:** - `dev_user:write`
|
|
28897
31558
|
*
|
|
28898
31559
|
* @tags dev-users
|
|
28899
31560
|
* @name DevUsersUpdate
|
|
@@ -29227,7 +31888,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29227
31888
|
*/
|
|
29228
31889
|
eventSourcesDeleteScheduledEvent: (data: EventSourcesDeleteScheduledEventRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
29229
31890
|
/**
|
|
29230
|
-
* @description Creates a new group. A group is a collection of users.
|
|
31891
|
+
* @description Creates a new group. A group is a collection of users. **Required scopes:** - `group:write`
|
|
29231
31892
|
*
|
|
29232
31893
|
* @tags groups
|
|
29233
31894
|
* @name GroupsCreate
|
|
@@ -29237,17 +31898,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29237
31898
|
*/
|
|
29238
31899
|
groupsCreate: (data: GroupsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsCreateResponse, any, {}>>;
|
|
29239
31900
|
/**
|
|
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.
|
|
31901
|
+
* @description Gets the requested group. **Required scopes:** - `group:read`
|
|
29251
31902
|
*
|
|
29252
31903
|
* @tags groups
|
|
29253
31904
|
* @name GroupsGet
|
|
@@ -29263,7 +31914,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29263
31914
|
id: string;
|
|
29264
31915
|
}, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any, {}>>;
|
|
29265
31916
|
/**
|
|
29266
|
-
* @description Gets the requested group.
|
|
31917
|
+
* @description Gets the requested group. **Required scopes:** - `group:read`
|
|
29267
31918
|
*
|
|
29268
31919
|
* @tags groups
|
|
29269
31920
|
* @name GroupsGetPost
|
|
@@ -29273,7 +31924,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29273
31924
|
*/
|
|
29274
31925
|
groupsGetPost: (data: GroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any, {}>>;
|
|
29275
31926
|
/**
|
|
29276
|
-
* @description Lists the available groups.
|
|
31927
|
+
* @description Lists the available groups. **Required scopes:** - `group:read`
|
|
29277
31928
|
*
|
|
29278
31929
|
* @tags groups
|
|
29279
31930
|
* @name GroupsList
|
|
@@ -29344,7 +31995,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29344
31995
|
'sync_metadata.origin_system'?: string[];
|
|
29345
31996
|
}, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any, {}>>;
|
|
29346
31997
|
/**
|
|
29347
|
-
* @description Lists the available groups.
|
|
31998
|
+
* @description Lists the available groups. **Required scopes:** - `group:read`
|
|
29348
31999
|
*
|
|
29349
32000
|
* @tags groups
|
|
29350
32001
|
* @name GroupsListPost
|
|
@@ -29354,7 +32005,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29354
32005
|
*/
|
|
29355
32006
|
groupsListPost: (data: GroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any, {}>>;
|
|
29356
32007
|
/**
|
|
29357
|
-
* @description Adds a member to a group.
|
|
32008
|
+
* @description Adds a member to a group. **Required scopes:** - `group_membership:write`
|
|
29358
32009
|
*
|
|
29359
32010
|
* @tags groups
|
|
29360
32011
|
* @name GroupMembersAdd
|
|
@@ -29390,7 +32041,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29390
32041
|
*/
|
|
29391
32042
|
groupMembersCountPost: (data: GroupMembersCountRequest, params?: RequestParams) => Promise<AxiosResponse<GroupMembersCountResponse, any, {}>>;
|
|
29392
32043
|
/**
|
|
29393
|
-
* @description Lists the members in a group.
|
|
32044
|
+
* @description Lists the members in a group. **Required scopes:** - `group_membership:read`
|
|
29394
32045
|
*
|
|
29395
32046
|
* @tags groups
|
|
29396
32047
|
* @name GroupMembersList
|
|
@@ -29425,7 +32076,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29425
32076
|
sort_by?: string[];
|
|
29426
32077
|
}, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any, {}>>;
|
|
29427
32078
|
/**
|
|
29428
|
-
* @description Lists the members in a group.
|
|
32079
|
+
* @description Lists the members in a group. **Required scopes:** - `group_membership:read`
|
|
29429
32080
|
*
|
|
29430
32081
|
* @tags groups
|
|
29431
32082
|
* @name GroupMembersListPost
|
|
@@ -29435,7 +32086,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29435
32086
|
*/
|
|
29436
32087
|
groupMembersListPost: (data: GroupMembersListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any, {}>>;
|
|
29437
32088
|
/**
|
|
29438
|
-
* @description Removes a member from a group.
|
|
32089
|
+
* @description Removes a member from a group. **Required scopes:** - `group_membership:write`
|
|
29439
32090
|
*
|
|
29440
32091
|
* @tags groups
|
|
29441
32092
|
* @name GroupMembersRemove
|
|
@@ -29445,7 +32096,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29445
32096
|
*/
|
|
29446
32097
|
groupMembersRemove: (data: GroupMembersRemoveRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
29447
32098
|
/**
|
|
29448
|
-
* @description Updates the requested group.
|
|
32099
|
+
* @description Updates the requested group. **Required scopes:** - `group:write`
|
|
29449
32100
|
*
|
|
29450
32101
|
* @tags groups
|
|
29451
32102
|
* @name GroupsUpdate
|
|
@@ -29911,8 +32562,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29911
32562
|
/** Whether only deprecated link types should be filtered. */
|
|
29912
32563
|
is_deprecated?: boolean;
|
|
29913
32564
|
/**
|
|
29914
|
-
* The maximum number of items, for each result and
|
|
29915
|
-
*
|
|
32565
|
+
* The maximum number of items, for each result and reverse_result.
|
|
32566
|
+
* Default value is 50 for each.
|
|
29916
32567
|
* @format int32
|
|
29917
32568
|
*/
|
|
29918
32569
|
limit?: number;
|
|
@@ -30025,7 +32676,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30025
32676
|
*/
|
|
30026
32677
|
linksCreate: (data: LinksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<LinksCreateResponse, any, {}>>;
|
|
30027
32678
|
/**
|
|
30028
|
-
* @description Deletes a link.
|
|
32679
|
+
* @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
32680
|
*
|
|
30030
32681
|
* @tags links
|
|
30031
32682
|
* @name LinksDelete
|
|
@@ -30130,7 +32781,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30130
32781
|
*/
|
|
30131
32782
|
linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any, {}>>;
|
|
30132
32783
|
/**
|
|
30133
|
-
* @description Replaces a link.
|
|
32784
|
+
* @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
32785
|
*
|
|
30135
32786
|
* @tags links
|
|
30136
32787
|
* @name LinksReplace
|
|
@@ -30310,6 +32961,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30310
32961
|
* @secure
|
|
30311
32962
|
*/
|
|
30312
32963
|
meetingsDelete: (data: MeetingsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
32964
|
+
/**
|
|
32965
|
+
* @description Exports a list of meetings asynchronously.
|
|
32966
|
+
*
|
|
32967
|
+
* @tags meetings
|
|
32968
|
+
* @name MeetingsExportAsync
|
|
32969
|
+
* @summary Async Meetings Export
|
|
32970
|
+
* @request POST:/meetings.export.async
|
|
32971
|
+
* @secure
|
|
32972
|
+
*/
|
|
32973
|
+
meetingsExportAsync: (data: MeetingsExportAsyncRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsExportAsyncResponse, any, {}>>;
|
|
30313
32974
|
/**
|
|
30314
32975
|
* @description Gets the meeting record.
|
|
30315
32976
|
*
|
|
@@ -30621,6 +33282,80 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30621
33282
|
* @secure
|
|
30622
33283
|
*/
|
|
30623
33284
|
notificationsSend: (data: NotificationsSendRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
33285
|
+
/**
|
|
33286
|
+
* @description Get list of objects matching the given filter.
|
|
33287
|
+
*
|
|
33288
|
+
* @tags search
|
|
33289
|
+
* @name ObjectsList
|
|
33290
|
+
* @summary List Objects
|
|
33291
|
+
* @request GET:/objects.list
|
|
33292
|
+
* @secure
|
|
33293
|
+
*/
|
|
33294
|
+
objectsList: (query?: {
|
|
33295
|
+
/**
|
|
33296
|
+
* Opaque cursor token that represents a position in the result set. Use
|
|
33297
|
+
* the cursor from previous responses to fetch next/previous iteration.
|
|
33298
|
+
* @format text
|
|
33299
|
+
*/
|
|
33300
|
+
'dql_query.cursor'?: string;
|
|
33301
|
+
/**
|
|
33302
|
+
* The search query to filter the objects. Required if any
|
|
33303
|
+
* dql_query.expression.* fields are provided.
|
|
33304
|
+
* @format text
|
|
33305
|
+
*/
|
|
33306
|
+
'dql_query.expression.query'?: string;
|
|
33307
|
+
/** Fields on which the search query will be scoped on. */
|
|
33308
|
+
'dql_query.expression.scope'?: string[];
|
|
33309
|
+
/**
|
|
33310
|
+
* Field name to group results by. Required if any dql_query.group_by.*
|
|
33311
|
+
* fields are provided.
|
|
33312
|
+
* @format text
|
|
33313
|
+
*/
|
|
33314
|
+
'dql_query.group_by.field'?: string;
|
|
33315
|
+
/** Criterion used to order groups */
|
|
33316
|
+
'dql_query.group_by.order'?: DevrevQueryGroupExpressionOrder;
|
|
33317
|
+
/** Sorting direction to be applied on the ordered groups */
|
|
33318
|
+
'dql_query.group_by.sort_direction'?: DevrevQueryGroupExpressionSortDirection;
|
|
33319
|
+
/**
|
|
33320
|
+
* Maximum number of items to return per iteration. If not specified,
|
|
33321
|
+
* the service will use its default limit.
|
|
33322
|
+
* @format int32
|
|
33323
|
+
*/
|
|
33324
|
+
'dql_query.limit'?: number;
|
|
33325
|
+
/**
|
|
33326
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
33327
|
+
* used.
|
|
33328
|
+
*/
|
|
33329
|
+
'dql_query.mode'?: ListMode;
|
|
33330
|
+
/**
|
|
33331
|
+
* The search query to filter the objects.
|
|
33332
|
+
* @deprecated
|
|
33333
|
+
* @format text
|
|
33334
|
+
*/
|
|
33335
|
+
'dql_query.search_query'?: string;
|
|
33336
|
+
/** Fields to sort the records by and the direction to sort them. */
|
|
33337
|
+
'dql_query.sort_by'?: string[];
|
|
33338
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ObjectsListResponse, any, {}>>;
|
|
33339
|
+
/**
|
|
33340
|
+
* @description Get list of objects matching the given filter.
|
|
33341
|
+
*
|
|
33342
|
+
* @tags search
|
|
33343
|
+
* @name ObjectsListPost
|
|
33344
|
+
* @summary List Objects (POST)
|
|
33345
|
+
* @request POST:/objects.list
|
|
33346
|
+
* @secure
|
|
33347
|
+
*/
|
|
33348
|
+
objectsListPost: (data: ObjectsListRequest, params?: RequestParams) => Promise<AxiosResponse<ObjectsListResponse, any, {}>>;
|
|
33349
|
+
/**
|
|
33350
|
+
* @description Aggregates the sessions data.
|
|
33351
|
+
*
|
|
33352
|
+
* @tags observability
|
|
33353
|
+
* @name ObservabilitySessionsAggregate
|
|
33354
|
+
* @summary Aggregate Observability Sessions
|
|
33355
|
+
* @request POST:/observability.sessions.aggregate
|
|
33356
|
+
* @secure
|
|
33357
|
+
*/
|
|
33358
|
+
observabilitySessionsAggregate: (data: ObservabilitySessionsAggregateRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsAggregateResponse, any, {}>>;
|
|
30624
33359
|
/**
|
|
30625
33360
|
* @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
33361
|
*
|
|
@@ -30665,6 +33400,52 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30665
33400
|
* @secure
|
|
30666
33401
|
*/
|
|
30667
33402
|
observabilitySessionsDataGetPost: (data: ObservabilitySessionsDataGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDataGetResponse, any, {}>>;
|
|
33403
|
+
/**
|
|
33404
|
+
* @description Retrieves detailed console and network data for debugging.
|
|
33405
|
+
*
|
|
33406
|
+
* @tags observability
|
|
33407
|
+
* @name ObservabilitySessionsDeveloperInfoGet
|
|
33408
|
+
* @summary Get Observability Sessions Developer Info
|
|
33409
|
+
* @request GET:/observability.sessions.developer-info.get
|
|
33410
|
+
* @secure
|
|
33411
|
+
*/
|
|
33412
|
+
observabilitySessionsDeveloperInfoGet: (query: {
|
|
33413
|
+
/**
|
|
33414
|
+
* The unique identifier of the session.
|
|
33415
|
+
* @format text
|
|
33416
|
+
* @minLength 1
|
|
33417
|
+
*/
|
|
33418
|
+
session_id: string;
|
|
33419
|
+
/**
|
|
33420
|
+
* unique tab id of the web session.
|
|
33421
|
+
* @format text
|
|
33422
|
+
* @minLength 1
|
|
33423
|
+
*/
|
|
33424
|
+
tab_id: string;
|
|
33425
|
+
/**
|
|
33426
|
+
* version key of the app.
|
|
33427
|
+
* @format text
|
|
33428
|
+
* @minLength 1
|
|
33429
|
+
*/
|
|
33430
|
+
version_key: string;
|
|
33431
|
+
/** Filter console logs by type. If empty, all types are returned. */
|
|
33432
|
+
console_log_types?: ConsoleLogType[];
|
|
33433
|
+
/**
|
|
33434
|
+
* Filter network logs by HTTP status code class. If empty, all classes
|
|
33435
|
+
* are returned.
|
|
33436
|
+
*/
|
|
33437
|
+
status_code_classes?: StatusCodeClass[];
|
|
33438
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDeveloperInfoGetResponse, any, {}>>;
|
|
33439
|
+
/**
|
|
33440
|
+
* @description Retrieves detailed console and network data for debugging.
|
|
33441
|
+
*
|
|
33442
|
+
* @tags observability
|
|
33443
|
+
* @name ObservabilitySessionsDeveloperInfoGetPost
|
|
33444
|
+
* @summary Get Observability Sessions Developer Info (POST)
|
|
33445
|
+
* @request POST:/observability.sessions.developer-info.get
|
|
33446
|
+
* @secure
|
|
33447
|
+
*/
|
|
33448
|
+
observabilitySessionsDeveloperInfoGetPost: (data: ObservabilitySessionsDeveloperInfoGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDeveloperInfoGetResponse, any, {}>>;
|
|
30668
33449
|
/**
|
|
30669
33450
|
* @description Gets a specific session metadata by ID.
|
|
30670
33451
|
*
|
|
@@ -31188,7 +33969,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31188
33969
|
*/
|
|
31189
33970
|
partsUpdate: (data: PartsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsUpdateResponse, any, {}>>;
|
|
31190
33971
|
/**
|
|
31191
|
-
* @description Pings the DevRev service.
|
|
33972
|
+
* @description Pings the DevRev service. **Required scopes:** No scopes required.
|
|
31192
33973
|
*
|
|
31193
33974
|
* @name Ping
|
|
31194
33975
|
* @summary Ping
|
|
@@ -31203,7 +33984,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31203
33984
|
devrev_partition?: string;
|
|
31204
33985
|
}, params?: RequestParams) => Promise<AxiosResponse<PingResponse, any, {}>>;
|
|
31205
33986
|
/**
|
|
31206
|
-
* @description Pings the DevRev service.
|
|
33987
|
+
* @description Pings the DevRev service. **Required scopes:** No scopes required.
|
|
31207
33988
|
*
|
|
31208
33989
|
* @name PingPost
|
|
31209
33990
|
* @summary Ping (POST)
|
|
@@ -31473,7 +34254,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31473
34254
|
*/
|
|
31474
34255
|
recordTemplateGetPost: (data: RecordTemplateGetRequest, params?: RequestParams) => Promise<AxiosResponse<RecordTemplateGetResponse, any, {}>>;
|
|
31475
34256
|
/**
|
|
31476
|
-
* @description Creates a Rev organization in the authenticated user's Dev organization.
|
|
34257
|
+
* @description Creates a Rev organization in the authenticated user's Dev organization. **Required scopes:** - `rev_org:write`
|
|
31477
34258
|
*
|
|
31478
34259
|
* @tags rev-orgs
|
|
31479
34260
|
* @name RevOrgsCreate
|
|
@@ -31483,7 +34264,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31483
34264
|
*/
|
|
31484
34265
|
revOrgsCreate: (data: RevOrgsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsCreateResponse, any, {}>>;
|
|
31485
34266
|
/**
|
|
31486
|
-
* @description Deletes the Rev organization.
|
|
34267
|
+
* @description Deletes the Rev organization. **Required scopes:** - `rev_org:all`
|
|
31487
34268
|
*
|
|
31488
34269
|
* @tags rev-orgs
|
|
31489
34270
|
* @name RevOrgsDelete
|
|
@@ -31493,7 +34274,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31493
34274
|
*/
|
|
31494
34275
|
revOrgsDelete: (data: RevOrgsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
31495
34276
|
/**
|
|
31496
|
-
* @description Retrieves the Rev organization's information.
|
|
34277
|
+
* @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
|
|
31497
34278
|
*
|
|
31498
34279
|
* @tags rev-orgs
|
|
31499
34280
|
* @name RevOrgsGet
|
|
@@ -31517,7 +34298,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31517
34298
|
id?: string;
|
|
31518
34299
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any, {}>>;
|
|
31519
34300
|
/**
|
|
31520
|
-
* @description Retrieves the Rev organization's information.
|
|
34301
|
+
* @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
|
|
31521
34302
|
*
|
|
31522
34303
|
* @tags rev-orgs
|
|
31523
34304
|
* @name RevOrgsGetPost
|
|
@@ -31527,7 +34308,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31527
34308
|
*/
|
|
31528
34309
|
revOrgsGetPost: (data: RevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any, {}>>;
|
|
31529
34310
|
/**
|
|
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.
|
|
34311
|
+
* @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
34312
|
*
|
|
31532
34313
|
* @tags rev-orgs
|
|
31533
34314
|
* @name RevOrgsList
|
|
@@ -31605,7 +34386,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31605
34386
|
tags?: string[];
|
|
31606
34387
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any, {}>>;
|
|
31607
34388
|
/**
|
|
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.
|
|
34389
|
+
* @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
34390
|
*
|
|
31610
34391
|
* @tags rev-orgs
|
|
31611
34392
|
* @name RevOrgsListPost
|
|
@@ -31615,7 +34396,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31615
34396
|
*/
|
|
31616
34397
|
revOrgsListPost: (data: RevOrgsListRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any, {}>>;
|
|
31617
34398
|
/**
|
|
31618
|
-
* @description Updates the Rev organization's information.
|
|
34399
|
+
* @description Updates the Rev organization's information. **Required scopes:** - `rev_org:write`
|
|
31619
34400
|
*
|
|
31620
34401
|
* @tags rev-orgs
|
|
31621
34402
|
* @name RevOrgsUpdate
|
|
@@ -31688,7 +34469,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31688
34469
|
*/
|
|
31689
34470
|
revUsersAssociationsRemove: (data: RevUsersAssociationsRemoveRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
31690
34471
|
/**
|
|
31691
|
-
* @description Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization.
|
|
34472
|
+
* @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
34473
|
*
|
|
31693
34474
|
* @tags rev-users
|
|
31694
34475
|
* @name RevUsersCreate
|
|
@@ -31698,7 +34479,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31698
34479
|
*/
|
|
31699
34480
|
revUsersCreate: (data: RevUsersCreateRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersCreateResponse, any, {}>>;
|
|
31700
34481
|
/**
|
|
31701
|
-
* @description Deletes a Rev user.
|
|
34482
|
+
* @description Deletes a Rev user. **Required scopes:** - `rev_user:all`
|
|
31702
34483
|
*
|
|
31703
34484
|
* @tags rev-users
|
|
31704
34485
|
* @name RevUsersDelete
|
|
@@ -31718,7 +34499,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31718
34499
|
*/
|
|
31719
34500
|
deleteRevUsersPersonalData: (data: DeleteRevUsersPersonalDataRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
31720
34501
|
/**
|
|
31721
|
-
* @description Returns the Rev user of a Rev organization by its ID.
|
|
34502
|
+
* @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
|
|
31722
34503
|
*
|
|
31723
34504
|
* @tags rev-users
|
|
31724
34505
|
* @name RevUsersGet
|
|
@@ -31734,7 +34515,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31734
34515
|
id: string;
|
|
31735
34516
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any, {}>>;
|
|
31736
34517
|
/**
|
|
31737
|
-
* @description Returns the Rev user of a Rev organization by its ID.
|
|
34518
|
+
* @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
|
|
31738
34519
|
*
|
|
31739
34520
|
* @tags rev-users
|
|
31740
34521
|
* @name RevUsersGetPost
|
|
@@ -31755,7 +34536,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31755
34536
|
*/
|
|
31756
34537
|
linkRevUserToRevOrg: (data: LinkRevUserToRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<LinkRevUserToRevOrgResponse, any, {}>>;
|
|
31757
34538
|
/**
|
|
31758
|
-
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization.
|
|
34539
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
|
|
31759
34540
|
*
|
|
31760
34541
|
* @tags rev-users
|
|
31761
34542
|
* @name RevUsersList
|
|
@@ -31836,7 +34617,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31836
34617
|
tags?: string[];
|
|
31837
34618
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any, {}>>;
|
|
31838
34619
|
/**
|
|
31839
|
-
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization.
|
|
34620
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
|
|
31840
34621
|
*
|
|
31841
34622
|
* @tags rev-users
|
|
31842
34623
|
* @name RevUsersListPost
|
|
@@ -31846,7 +34627,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31846
34627
|
*/
|
|
31847
34628
|
revUsersListPost: (data: RevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any, {}>>;
|
|
31848
34629
|
/**
|
|
31849
|
-
* @description Merges the secondary Rev user into the primary Rev user.
|
|
34630
|
+
* @description Merges the secondary Rev user into the primary Rev user. **Required scopes:** - `rev_user:all`
|
|
31850
34631
|
*
|
|
31851
34632
|
* @tags rev-users
|
|
31852
34633
|
* @name RevUsersMerge
|
|
@@ -31866,7 +34647,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31866
34647
|
*/
|
|
31867
34648
|
getRevUsersPersonalData: (data: GetRevUsersPersonalDataRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
31868
34649
|
/**
|
|
31869
|
-
* @description Scans through all Rev users.
|
|
34650
|
+
* @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
|
|
31870
34651
|
*
|
|
31871
34652
|
* @tags rev-users
|
|
31872
34653
|
* @name RevUsersScan
|
|
@@ -31935,7 +34716,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31935
34716
|
tags?: string[];
|
|
31936
34717
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersScanResponse, any, {}>>;
|
|
31937
34718
|
/**
|
|
31938
|
-
* @description Scans through all Rev users.
|
|
34719
|
+
* @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
|
|
31939
34720
|
*
|
|
31940
34721
|
* @tags rev-users
|
|
31941
34722
|
* @name RevUsersScanPost
|
|
@@ -31956,7 +34737,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31956
34737
|
*/
|
|
31957
34738
|
unlinkRevUserFromRevOrg: (data: UnlinkRevUserFromRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<UnlinkRevUserFromRevOrgResponse, any, {}>>;
|
|
31958
34739
|
/**
|
|
31959
|
-
* @description Updates a Rev user.
|
|
34740
|
+
* @description Updates a Rev user. **Required scopes:** - `rev_user:write`
|
|
31960
34741
|
*
|
|
31961
34742
|
* @tags rev-users
|
|
31962
34743
|
* @name RevUsersUpdate
|
|
@@ -32620,6 +35401,60 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32620
35401
|
* @secure
|
|
32621
35402
|
*/
|
|
32622
35403
|
slasUpdate: (data: SlasUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SlasUpdateResponse, any, {}>>;
|
|
35404
|
+
/**
|
|
35405
|
+
* @description Lists snap-ins for a Dev organization.
|
|
35406
|
+
*
|
|
35407
|
+
* @tags snap-ins
|
|
35408
|
+
* @name SnapInsList
|
|
35409
|
+
* @summary List Snap Ins
|
|
35410
|
+
* @request GET:/snap-ins.list
|
|
35411
|
+
* @secure
|
|
35412
|
+
*/
|
|
35413
|
+
snapInsList: (query?: {
|
|
35414
|
+
/**
|
|
35415
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
35416
|
+
* starts from the beginning.
|
|
35417
|
+
* @format text
|
|
35418
|
+
*/
|
|
35419
|
+
cursor?: string;
|
|
35420
|
+
/**
|
|
35421
|
+
* The maximum number of snap-ins to return. The default is '50', the
|
|
35422
|
+
* maximum is '100'.
|
|
35423
|
+
* @format int32
|
|
35424
|
+
*/
|
|
35425
|
+
limit?: number;
|
|
35426
|
+
/**
|
|
35427
|
+
* The marketplace to filter by.
|
|
35428
|
+
* @format id
|
|
35429
|
+
*/
|
|
35430
|
+
'marketplace_item.marketplace'?: string;
|
|
35431
|
+
/**
|
|
35432
|
+
* The marketplace item slug to filter by.
|
|
35433
|
+
* @format text
|
|
35434
|
+
*/
|
|
35435
|
+
'marketplace_item.marketplace_item_slug'?: string;
|
|
35436
|
+
/**
|
|
35437
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
35438
|
+
* used.
|
|
35439
|
+
*/
|
|
35440
|
+
mode?: ListMode;
|
|
35441
|
+
/** Filter for service account associated with snap-in. */
|
|
35442
|
+
service_account?: string[];
|
|
35443
|
+
/** Filter for snap-in version associated with snap-in. */
|
|
35444
|
+
snap_in_version?: string[];
|
|
35445
|
+
/** Fields to sort the snap-ins by and the direction to sort them. */
|
|
35446
|
+
sort_by?: string[];
|
|
35447
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SnapInsListResponse, any, {}>>;
|
|
35448
|
+
/**
|
|
35449
|
+
* @description Lists snap-ins for a Dev organization.
|
|
35450
|
+
*
|
|
35451
|
+
* @tags snap-ins
|
|
35452
|
+
* @name SnapInsListPost
|
|
35453
|
+
* @summary List Snap Ins (POST)
|
|
35454
|
+
* @request POST:/snap-ins.list
|
|
35455
|
+
* @secure
|
|
35456
|
+
*/
|
|
35457
|
+
snapInsListPost: (data: SnapInsListRequest, params?: RequestParams) => Promise<AxiosResponse<SnapInsListResponse, any, {}>>;
|
|
32623
35458
|
/**
|
|
32624
35459
|
* @description Gets snap-in resources for a user in a snap-in.
|
|
32625
35460
|
*
|
|
@@ -32670,7 +35505,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32670
35505
|
* @request POST:/snap-kit-action.execute.deferred
|
|
32671
35506
|
* @secure
|
|
32672
35507
|
*/
|
|
32673
|
-
snapKitActionExecuteDeferred: (data: SnapKitActionExecuteDeferredRequest, params?: RequestParams) => Promise<AxiosResponse<
|
|
35508
|
+
snapKitActionExecuteDeferred: (data: SnapKitActionExecuteDeferredRequest, params?: RequestParams) => Promise<AxiosResponse<SnapKitActionExecuteDeferredResponse, any, {}>>;
|
|
32674
35509
|
/**
|
|
32675
35510
|
* @description Create a snap widget object.
|
|
32676
35511
|
*
|
|
@@ -32681,16 +35516,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32681
35516
|
* @secure
|
|
32682
35517
|
*/
|
|
32683
35518
|
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
35519
|
/**
|
|
32695
35520
|
* @description Creates a stage diagram.
|
|
32696
35521
|
*
|
|
@@ -33232,7 +36057,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33232
36057
|
*/
|
|
33233
36058
|
surveysUpdate: (data: SurveysUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysUpdateResponse, any, {}>>;
|
|
33234
36059
|
/**
|
|
33235
|
-
* @description Lists system users within your organization.
|
|
36060
|
+
* @description Lists system users within your organization. **Required scopes:** - `dev_user:read`
|
|
33236
36061
|
*
|
|
33237
36062
|
* @tags sys-users
|
|
33238
36063
|
* @name SysUsersList
|
|
@@ -33262,7 +36087,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33262
36087
|
sort_by?: string[];
|
|
33263
36088
|
}, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any, {}>>;
|
|
33264
36089
|
/**
|
|
33265
|
-
* @description Lists system users within your organization.
|
|
36090
|
+
* @description Lists system users within your organization. **Required scopes:** - `dev_user:read`
|
|
33266
36091
|
*
|
|
33267
36092
|
* @tags sys-users
|
|
33268
36093
|
* @name SysUsersListPost
|
|
@@ -33272,7 +36097,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33272
36097
|
*/
|
|
33273
36098
|
sysUsersListPost: (data: SysUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any, {}>>;
|
|
33274
36099
|
/**
|
|
33275
|
-
* @description Updates the system user.
|
|
36100
|
+
* @description Updates the system user. **Required scopes:** - `dev_user:write`
|
|
33276
36101
|
*
|
|
33277
36102
|
* @tags sys-users
|
|
33278
36103
|
* @name SysUsersUpdate
|
|
@@ -33450,6 +36275,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33450
36275
|
* @example "PROD-12345"
|
|
33451
36276
|
*/
|
|
33452
36277
|
object: string;
|
|
36278
|
+
/** The bias for request processing. The default is 'speed'. */
|
|
36279
|
+
bias?: TimelineEntriesListRequestBias;
|
|
33453
36280
|
/**
|
|
33454
36281
|
* The collection(s) to list entries from, otherwise if not provided,
|
|
33455
36282
|
* all entries are returned.
|
|
@@ -34110,6 +36937,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34110
36937
|
* @secure
|
|
34111
36938
|
*/
|
|
34112
36939
|
webhooksUpdate: (data: WebhooksUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksUpdateResponse, any, {}>>;
|
|
36940
|
+
/**
|
|
36941
|
+
* @description Creates a new widget.
|
|
36942
|
+
*
|
|
36943
|
+
* @tags widgets
|
|
36944
|
+
* @name WidgetsCreate
|
|
36945
|
+
* @summary Create Widget
|
|
36946
|
+
* @request POST:/widgets.create
|
|
36947
|
+
* @secure
|
|
36948
|
+
*/
|
|
36949
|
+
widgetsCreate: (data: WidgetsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<WidgetsCreateResponse, any, {}>>;
|
|
34113
36950
|
/**
|
|
34114
36951
|
* @description Returns the requested widget.
|
|
34115
36952
|
*
|