@devrev/typescript-sdk 1.1.55 → 1.1.59
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.
|
@@ -179,8 +179,12 @@ export interface AccountsExportRequest {
|
|
|
179
179
|
sort_by?: string[];
|
|
180
180
|
/** Filters for accounts on specified stages. */
|
|
181
181
|
stage?: string[];
|
|
182
|
+
/** Subtypes of the accounts to be filtered. */
|
|
183
|
+
subtype?: string[];
|
|
182
184
|
/** List of tags to be filtered. */
|
|
183
185
|
tags?: string[];
|
|
186
|
+
/** Tier of the accounts to be filtered. */
|
|
187
|
+
tier?: string[];
|
|
184
188
|
/** Array of websites of accounts to be filtered. */
|
|
185
189
|
websites?: string[];
|
|
186
190
|
}
|
|
@@ -210,8 +214,12 @@ export interface AccountsFilters {
|
|
|
210
214
|
owned_by?: string[];
|
|
211
215
|
/** Filters for accounts on specified stages. */
|
|
212
216
|
stage?: string[];
|
|
217
|
+
/** Subtypes of the accounts to be filtered. */
|
|
218
|
+
subtype?: string[];
|
|
213
219
|
/** List of tags to be filtered. */
|
|
214
220
|
tags?: string[];
|
|
221
|
+
/** Tier of the accounts to be filtered. */
|
|
222
|
+
tier?: string[];
|
|
215
223
|
/** Array of websites of accounts to be filtered. */
|
|
216
224
|
websites?: string[];
|
|
217
225
|
}
|
|
@@ -277,8 +285,12 @@ export interface AccountsListRequest {
|
|
|
277
285
|
sort_by?: string[];
|
|
278
286
|
/** Filters for accounts on specified stages. */
|
|
279
287
|
stage?: string[];
|
|
288
|
+
/** Subtypes of the accounts to be filtered. */
|
|
289
|
+
subtype?: string[];
|
|
280
290
|
/** List of tags to be filtered. */
|
|
281
291
|
tags?: string[];
|
|
292
|
+
/** Tier of the accounts to be filtered. */
|
|
293
|
+
tier?: string[];
|
|
282
294
|
/** Array of websites of accounts to be filtered. */
|
|
283
295
|
websites?: string[];
|
|
284
296
|
}
|
|
@@ -966,6 +978,33 @@ export type Article = AtomBase & {
|
|
|
966
978
|
*/
|
|
967
979
|
title?: string;
|
|
968
980
|
};
|
|
981
|
+
/** Content format of the article. */
|
|
982
|
+
export declare enum ArticleContentFormat {
|
|
983
|
+
Drdfv2 = "drdfv2",
|
|
984
|
+
Rt = "rt"
|
|
985
|
+
}
|
|
986
|
+
/** article-data-source-create */
|
|
987
|
+
export interface ArticleDataSourceCreate {
|
|
988
|
+
/** Indicates if the leaf type is custom. */
|
|
989
|
+
is_custom_leaf_type: boolean;
|
|
990
|
+
/** Indicates if the data source is default. */
|
|
991
|
+
is_default: boolean;
|
|
992
|
+
/**
|
|
993
|
+
* The object's type.
|
|
994
|
+
* @format text
|
|
995
|
+
*/
|
|
996
|
+
leaf_type: string;
|
|
997
|
+
/**
|
|
998
|
+
* The ID of the object powering article.
|
|
999
|
+
* @format id
|
|
1000
|
+
*/
|
|
1001
|
+
object: string;
|
|
1002
|
+
/**
|
|
1003
|
+
* The reference ID of the data source.
|
|
1004
|
+
* @format text
|
|
1005
|
+
*/
|
|
1006
|
+
reference_id: string;
|
|
1007
|
+
}
|
|
969
1008
|
/** article-search-summary */
|
|
970
1009
|
export type ArticleSearchSummary = SearchSummaryBase & {
|
|
971
1010
|
article: ArticleSummary;
|
|
@@ -1062,10 +1101,9 @@ export interface ArticlesCreateRequest {
|
|
|
1062
1101
|
aliases?: string[];
|
|
1063
1102
|
/**
|
|
1064
1103
|
* The parts that the article applies to.
|
|
1065
|
-
* @minItems 1
|
|
1066
1104
|
* @example ["PROD-12345"]
|
|
1067
1105
|
*/
|
|
1068
|
-
applies_to_parts
|
|
1106
|
+
applies_to_parts?: string[];
|
|
1069
1107
|
/** Type of the article. */
|
|
1070
1108
|
article_type?: ArticleType;
|
|
1071
1109
|
/**
|
|
@@ -1073,6 +1111,8 @@ export interface ArticlesCreateRequest {
|
|
|
1073
1111
|
* @example ["DEVU-12345"]
|
|
1074
1112
|
*/
|
|
1075
1113
|
authored_by?: string[];
|
|
1114
|
+
/** Content format of the article. */
|
|
1115
|
+
content_format?: ArticleContentFormat;
|
|
1076
1116
|
/** Application-defined custom fields. */
|
|
1077
1117
|
custom_fields?: object;
|
|
1078
1118
|
/**
|
|
@@ -1084,6 +1124,8 @@ export interface ArticlesCreateRequest {
|
|
|
1084
1124
|
* validate_required_fields: true.
|
|
1085
1125
|
*/
|
|
1086
1126
|
custom_schema_spec?: CustomSchemaSpec;
|
|
1127
|
+
/** Data sources provide the backing data for the article. */
|
|
1128
|
+
data_sources?: ArticleDataSourceCreate[];
|
|
1087
1129
|
/**
|
|
1088
1130
|
* Description for the article.
|
|
1089
1131
|
* @format text
|
|
@@ -1303,6 +1345,8 @@ export interface ArticlesUpdateRequest {
|
|
|
1303
1345
|
artifacts?: ArticlesUpdateRequestArtifacts;
|
|
1304
1346
|
authored_by?: ArticlesUpdateRequestAuthoredBy;
|
|
1305
1347
|
content_blocks?: ArticlesUpdateRequestContentBlocks;
|
|
1348
|
+
/** Content format of the article. */
|
|
1349
|
+
content_format?: ArticleContentFormat;
|
|
1306
1350
|
/** Application-defined custom fields. */
|
|
1307
1351
|
custom_fields?: object;
|
|
1308
1352
|
/**
|
|
@@ -1314,6 +1358,7 @@ export interface ArticlesUpdateRequest {
|
|
|
1314
1358
|
* validate_required_fields: true.
|
|
1315
1359
|
*/
|
|
1316
1360
|
custom_schema_spec?: CustomSchemaSpec;
|
|
1361
|
+
data_sources?: ArticlesUpdateRequestArticleDataSourceUpdate;
|
|
1317
1362
|
/**
|
|
1318
1363
|
* Updated description of the article object, or unchanged if not
|
|
1319
1364
|
* provided.
|
|
@@ -1382,6 +1427,11 @@ export interface ArticlesUpdateRequestAppliesToParts {
|
|
|
1382
1427
|
*/
|
|
1383
1428
|
set?: string[];
|
|
1384
1429
|
}
|
|
1430
|
+
/** articles-update-request-article-data-source-update */
|
|
1431
|
+
export interface ArticlesUpdateRequestArticleDataSourceUpdate {
|
|
1432
|
+
/** Updates data sources provide the backing data for the article. */
|
|
1433
|
+
set?: ArticleDataSourceCreate[];
|
|
1434
|
+
}
|
|
1385
1435
|
/** articles-update-request-artifacts */
|
|
1386
1436
|
export interface ArticlesUpdateRequestArtifacts {
|
|
1387
1437
|
/**
|
|
@@ -1552,6 +1602,25 @@ export interface ArtifactsGetResponse {
|
|
|
1552
1602
|
/** The version of the artifact. */
|
|
1553
1603
|
version: ArtifactVersion;
|
|
1554
1604
|
}
|
|
1605
|
+
/**
|
|
1606
|
+
* artifacts-hard-delete-version-request
|
|
1607
|
+
* The request to permnanently delete an artifact's version.
|
|
1608
|
+
*/
|
|
1609
|
+
export interface ArtifactsHardDeleteVersionRequest {
|
|
1610
|
+
/**
|
|
1611
|
+
* The ID of the artifact to delete the version for.
|
|
1612
|
+
* @format id
|
|
1613
|
+
* @example "ARTIFACT-12345"
|
|
1614
|
+
*/
|
|
1615
|
+
id: string;
|
|
1616
|
+
/**
|
|
1617
|
+
* The version of the artifact that needs to be deleted.
|
|
1618
|
+
* @format text
|
|
1619
|
+
*/
|
|
1620
|
+
version?: string;
|
|
1621
|
+
}
|
|
1622
|
+
/** artifacts-hard-delete-version-response */
|
|
1623
|
+
export type ArtifactsHardDeleteVersionResponse = object;
|
|
1555
1624
|
/**
|
|
1556
1625
|
* artifacts-list-request
|
|
1557
1626
|
* The request to list artifacts attached to an object.
|
|
@@ -1700,7 +1769,7 @@ export declare enum AssociatedToType {
|
|
|
1700
1769
|
RevOrg = "rev_org"
|
|
1701
1770
|
}
|
|
1702
1771
|
/** atom */
|
|
1703
|
-
export type Atom = (Account | AppFragment | AuthToken | Capability | CodeChange | Command | Conversation | CustomObject | CustomTypeFragment | DevOrg | DevUser | Dm | Engagement | Enhancement | Feature | Group | Incident | Issue | Link | Meeting | ObjectMember | Opportunity | Product | QuestionAnswer | RevOrg | RevUser | ServiceAccount | Sla | SlaTracker | SnapIn | SnapInVersion | SysUser | Tag | Task | TenantFragment | Ticket | TimelineChangeEvent | TimelineComment | Uom | UserPreferences | Webhook | Widget) & {
|
|
1772
|
+
export type Atom = (Account | AppFragment | AuthToken | Capability | CodeChange | Command | Conversation | CustomObject | CustomTypeFragment | DevOrg | DevUser | Dm | Engagement | Enhancement | Feature | Group | Incident | Issue | Link | Linkable | Meeting | ObjectMember | Opportunity | Product | QuestionAnswer | RevOrg | RevUser | Runnable | ServiceAccount | Sla | SlaTracker | SnapIn | SnapInVersion | SysUser | Tag | Task | TenantFragment | Ticket | TimelineChangeEvent | TimelineComment | Uom | UserPreferences | Webhook | Widget) & {
|
|
1704
1773
|
type: AtomType;
|
|
1705
1774
|
};
|
|
1706
1775
|
/** atom-base */
|
|
@@ -1744,7 +1813,7 @@ export interface AtomBaseSummary {
|
|
|
1744
1813
|
id: string;
|
|
1745
1814
|
}
|
|
1746
1815
|
/** atom-summary */
|
|
1747
|
-
export type AtomSummary = (AccountSummary | AppFragmentSummary | AuthTokenSummary | CapabilitySummary | CodeChangeSummary | CommandSummary | ConversationSummary | CustomObjectSummary | CustomTypeFragmentSummary | DevOrgSummary | DevUserSummary | DmSummary | EngagementSummary | EnhancementSummary | FeatureSummary | GroupSummary | IncidentSummary | IssueSummary | LinkSummary | MeetingSummary | ObjectMemberSummary | OpportunitySummary | ProductSummary | QuestionAnswerSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SlaSummary | SlaTrackerSummary | SnapInSummary | SnapInVersionSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineChangeEventSummary | TimelineCommentSummary | UomSummary | UserPreferencesSummary | WebhookSummary | WidgetSummary) & {
|
|
1816
|
+
export type AtomSummary = (AccountSummary | AppFragmentSummary | AuthTokenSummary | CapabilitySummary | CodeChangeSummary | CommandSummary | ConversationSummary | CustomObjectSummary | CustomTypeFragmentSummary | DevOrgSummary | DevUserSummary | DmSummary | EngagementSummary | EnhancementSummary | FeatureSummary | GroupSummary | IncidentSummary | IssueSummary | LinkSummary | LinkableSummary | MeetingSummary | ObjectMemberSummary | OpportunitySummary | ProductSummary | QuestionAnswerSummary | RevOrgSummary | RevUserSummary | RunnableSummary | ServiceAccountSummary | SlaSummary | SlaTrackerSummary | SnapInSummary | SnapInVersionSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineChangeEventSummary | TimelineCommentSummary | UomSummary | UserPreferencesSummary | WebhookSummary | WidgetSummary) & {
|
|
1748
1817
|
type: AtomType;
|
|
1749
1818
|
};
|
|
1750
1819
|
export declare enum AtomType {
|
|
@@ -1767,6 +1836,7 @@ export declare enum AtomType {
|
|
|
1767
1836
|
Incident = "incident",
|
|
1768
1837
|
Issue = "issue",
|
|
1769
1838
|
Link = "link",
|
|
1839
|
+
Linkable = "linkable",
|
|
1770
1840
|
Meeting = "meeting",
|
|
1771
1841
|
ObjectMember = "object_member",
|
|
1772
1842
|
Opportunity = "opportunity",
|
|
@@ -1774,6 +1844,7 @@ export declare enum AtomType {
|
|
|
1774
1844
|
QuestionAnswer = "question_answer",
|
|
1775
1845
|
RevOrg = "rev_org",
|
|
1776
1846
|
RevUser = "rev_user",
|
|
1847
|
+
Runnable = "runnable",
|
|
1777
1848
|
ServiceAccount = "service_account",
|
|
1778
1849
|
Sla = "sla",
|
|
1779
1850
|
SlaTracker = "sla_tracker",
|
|
@@ -2447,6 +2518,67 @@ export interface AvailabilityPreferencesGroup {
|
|
|
2447
2518
|
/** Manually set presence to away. */
|
|
2448
2519
|
manual_away?: boolean;
|
|
2449
2520
|
}
|
|
2521
|
+
/**
|
|
2522
|
+
* bar-visualization-x-axis
|
|
2523
|
+
* The X-axis for a bar visualization.
|
|
2524
|
+
*/
|
|
2525
|
+
export interface BarVisualizationXAxis {
|
|
2526
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
2527
|
+
color?: VisualizationAxisColor;
|
|
2528
|
+
/** The drill through configurations for the axis. */
|
|
2529
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
2530
|
+
/** Whether the axis should be hidden. */
|
|
2531
|
+
is_hidden?: boolean;
|
|
2532
|
+
/**
|
|
2533
|
+
* The label for the axis.
|
|
2534
|
+
* @format text
|
|
2535
|
+
*/
|
|
2536
|
+
label?: string;
|
|
2537
|
+
/**
|
|
2538
|
+
* The reference name of the axis.
|
|
2539
|
+
* @format text
|
|
2540
|
+
*/
|
|
2541
|
+
reference_name: string;
|
|
2542
|
+
}
|
|
2543
|
+
/**
|
|
2544
|
+
* bar-visualization-y-axis
|
|
2545
|
+
* The Y-axis for a bar visualization.
|
|
2546
|
+
*/
|
|
2547
|
+
export interface BarVisualizationYAxis {
|
|
2548
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
2549
|
+
color?: VisualizationAxisColor;
|
|
2550
|
+
/** The drill through configurations for the axis. */
|
|
2551
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
2552
|
+
/** Whether the axis should be hidden. */
|
|
2553
|
+
is_hidden?: boolean;
|
|
2554
|
+
/**
|
|
2555
|
+
* The label for the axis.
|
|
2556
|
+
* @format text
|
|
2557
|
+
*/
|
|
2558
|
+
label?: string;
|
|
2559
|
+
/**
|
|
2560
|
+
* The reference name of the axis.
|
|
2561
|
+
* @format text
|
|
2562
|
+
*/
|
|
2563
|
+
reference_name: string;
|
|
2564
|
+
}
|
|
2565
|
+
/**
|
|
2566
|
+
* bar-widget-visualization
|
|
2567
|
+
* A bar chart visualization configuration. Includes metadata specific to
|
|
2568
|
+
* bar charts.
|
|
2569
|
+
*/
|
|
2570
|
+
export interface BarWidgetVisualization {
|
|
2571
|
+
/** Whether the bar should be stacked. */
|
|
2572
|
+
is_stacked?: boolean;
|
|
2573
|
+
/** The scrollbar configuration for chart. */
|
|
2574
|
+
scrollbar?: VisualizationScrollbar;
|
|
2575
|
+
/** Whether to show data labels. */
|
|
2576
|
+
show_data_labels?: boolean;
|
|
2577
|
+
/** The configuration for the X-axis. */
|
|
2578
|
+
x: BarVisualizationXAxis[];
|
|
2579
|
+
/** The configuration for the Y-axes. */
|
|
2580
|
+
y: BarVisualizationYAxis[];
|
|
2581
|
+
}
|
|
2450
2582
|
/**
|
|
2451
2583
|
* boolean-expression
|
|
2452
2584
|
* Boolean expression.
|
|
@@ -2487,6 +2619,139 @@ export declare enum BooleanExpressionType {
|
|
|
2487
2619
|
Or = "or",
|
|
2488
2620
|
Primitive = "primitive"
|
|
2489
2621
|
}
|
|
2622
|
+
/** brand */
|
|
2623
|
+
export type Brand = AtomBase & {
|
|
2624
|
+
/**
|
|
2625
|
+
* The description of the brand.
|
|
2626
|
+
* @format text
|
|
2627
|
+
*/
|
|
2628
|
+
description?: string;
|
|
2629
|
+
/**
|
|
2630
|
+
* The name of the brand.
|
|
2631
|
+
* @format text
|
|
2632
|
+
*/
|
|
2633
|
+
name?: string;
|
|
2634
|
+
};
|
|
2635
|
+
/**
|
|
2636
|
+
* brands-create-request
|
|
2637
|
+
* Request object to create a new brand.
|
|
2638
|
+
*/
|
|
2639
|
+
export interface BrandsCreateRequest {
|
|
2640
|
+
/**
|
|
2641
|
+
* Description of the brand to be created.
|
|
2642
|
+
* @format text
|
|
2643
|
+
* @maxLength 65536
|
|
2644
|
+
*/
|
|
2645
|
+
description?: string;
|
|
2646
|
+
/**
|
|
2647
|
+
* Name of the brand to be created.
|
|
2648
|
+
* @format text
|
|
2649
|
+
* @minLength 1
|
|
2650
|
+
* @maxLength 50
|
|
2651
|
+
*/
|
|
2652
|
+
name: string;
|
|
2653
|
+
}
|
|
2654
|
+
/**
|
|
2655
|
+
* brands-create-response
|
|
2656
|
+
* Response object for creating a new brand.
|
|
2657
|
+
*/
|
|
2658
|
+
export interface BrandsCreateResponse {
|
|
2659
|
+
brand: Brand;
|
|
2660
|
+
}
|
|
2661
|
+
/**
|
|
2662
|
+
* brands-delete-request
|
|
2663
|
+
* Request object to delete a brand.
|
|
2664
|
+
*/
|
|
2665
|
+
export interface BrandsDeleteRequest {
|
|
2666
|
+
/**
|
|
2667
|
+
* The ID of the brand to be deleted.
|
|
2668
|
+
* @format id
|
|
2669
|
+
*/
|
|
2670
|
+
id: string;
|
|
2671
|
+
}
|
|
2672
|
+
/** brands-delete-response */
|
|
2673
|
+
export type BrandsDeleteResponse = object;
|
|
2674
|
+
/**
|
|
2675
|
+
* brands-get-request
|
|
2676
|
+
* Request object to get a brands information.
|
|
2677
|
+
*/
|
|
2678
|
+
export interface BrandsGetRequest {
|
|
2679
|
+
/**
|
|
2680
|
+
* The ID of the brand to be retrieved.
|
|
2681
|
+
* @format id
|
|
2682
|
+
*/
|
|
2683
|
+
id: string;
|
|
2684
|
+
}
|
|
2685
|
+
/**
|
|
2686
|
+
* brands-get-response
|
|
2687
|
+
* Response object for getting a brand.
|
|
2688
|
+
*/
|
|
2689
|
+
export interface BrandsGetResponse {
|
|
2690
|
+
brand: Brand;
|
|
2691
|
+
}
|
|
2692
|
+
/**
|
|
2693
|
+
* brands-list-request
|
|
2694
|
+
* Request object to list brands.
|
|
2695
|
+
*/
|
|
2696
|
+
export interface BrandsListRequest {
|
|
2697
|
+
/**
|
|
2698
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2699
|
+
* iteration starts from the beginning.
|
|
2700
|
+
* @format text
|
|
2701
|
+
*/
|
|
2702
|
+
cursor?: string;
|
|
2703
|
+
}
|
|
2704
|
+
/**
|
|
2705
|
+
* brands-list-response
|
|
2706
|
+
* Response object for listing all brands.
|
|
2707
|
+
*/
|
|
2708
|
+
export interface BrandsListResponse {
|
|
2709
|
+
/** List of brands. */
|
|
2710
|
+
brands: Brand[];
|
|
2711
|
+
/**
|
|
2712
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
2713
|
+
* sort order. If not set, then no later elements exist.
|
|
2714
|
+
* @format text
|
|
2715
|
+
*/
|
|
2716
|
+
next_cursor?: string;
|
|
2717
|
+
/**
|
|
2718
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
2719
|
+
* sort order. If not set, then no prior elements exist.
|
|
2720
|
+
* @format text
|
|
2721
|
+
*/
|
|
2722
|
+
prev_cursor?: string;
|
|
2723
|
+
}
|
|
2724
|
+
/**
|
|
2725
|
+
* brands-update-request
|
|
2726
|
+
* Request object to update a brand.
|
|
2727
|
+
*/
|
|
2728
|
+
export interface BrandsUpdateRequest {
|
|
2729
|
+
/**
|
|
2730
|
+
* Description of the brand to be updated.
|
|
2731
|
+
* @format text
|
|
2732
|
+
* @maxLength 65536
|
|
2733
|
+
*/
|
|
2734
|
+
description?: string;
|
|
2735
|
+
/**
|
|
2736
|
+
* The ID of the brand to be updated.
|
|
2737
|
+
* @format id
|
|
2738
|
+
*/
|
|
2739
|
+
id: string;
|
|
2740
|
+
/**
|
|
2741
|
+
* Name of the brand to be updated.
|
|
2742
|
+
* @format text
|
|
2743
|
+
* @minLength 1
|
|
2744
|
+
* @maxLength 255
|
|
2745
|
+
*/
|
|
2746
|
+
name?: string;
|
|
2747
|
+
}
|
|
2748
|
+
/**
|
|
2749
|
+
* brands-update-response
|
|
2750
|
+
* Response object for updating a brand.
|
|
2751
|
+
*/
|
|
2752
|
+
export interface BrandsUpdateResponse {
|
|
2753
|
+
brand: Brand;
|
|
2754
|
+
}
|
|
2490
2755
|
/** capability */
|
|
2491
2756
|
export type Capability = PartBase;
|
|
2492
2757
|
/** capability-summary */
|
|
@@ -3016,6 +3281,67 @@ export interface CodeChangesUpdateRequest {
|
|
|
3016
3281
|
export interface CodeChangesUpdateResponse {
|
|
3017
3282
|
code_change: CodeChange;
|
|
3018
3283
|
}
|
|
3284
|
+
/**
|
|
3285
|
+
* column-visualization-x-axis
|
|
3286
|
+
* The X-axis for a column visualization.
|
|
3287
|
+
*/
|
|
3288
|
+
export interface ColumnVisualizationXAxis {
|
|
3289
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
3290
|
+
color?: VisualizationAxisColor;
|
|
3291
|
+
/** The drill through configurations for the axis. */
|
|
3292
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
3293
|
+
/** Whether the axis should be hidden. */
|
|
3294
|
+
is_hidden?: boolean;
|
|
3295
|
+
/**
|
|
3296
|
+
* The label for the axis.
|
|
3297
|
+
* @format text
|
|
3298
|
+
*/
|
|
3299
|
+
label?: string;
|
|
3300
|
+
/**
|
|
3301
|
+
* The reference name of the axis.
|
|
3302
|
+
* @format text
|
|
3303
|
+
*/
|
|
3304
|
+
reference_name: string;
|
|
3305
|
+
}
|
|
3306
|
+
/**
|
|
3307
|
+
* column-visualization-y-axis
|
|
3308
|
+
* The Y-axis for a column visualization.
|
|
3309
|
+
*/
|
|
3310
|
+
export interface ColumnVisualizationYAxis {
|
|
3311
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
3312
|
+
color?: VisualizationAxisColor;
|
|
3313
|
+
/** The drill through configurations for the axis. */
|
|
3314
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
3315
|
+
/** Whether the axis should be hidden. */
|
|
3316
|
+
is_hidden?: boolean;
|
|
3317
|
+
/**
|
|
3318
|
+
* The label for the axis.
|
|
3319
|
+
* @format text
|
|
3320
|
+
*/
|
|
3321
|
+
label?: string;
|
|
3322
|
+
/**
|
|
3323
|
+
* The reference name of the axis.
|
|
3324
|
+
* @format text
|
|
3325
|
+
*/
|
|
3326
|
+
reference_name: string;
|
|
3327
|
+
}
|
|
3328
|
+
/**
|
|
3329
|
+
* column-widget-visualization
|
|
3330
|
+
* A column chart visualization configuration. Includes metadata specific
|
|
3331
|
+
* to column charts.
|
|
3332
|
+
*/
|
|
3333
|
+
export interface ColumnWidgetVisualization {
|
|
3334
|
+
/** Whether the columns should be stacked. */
|
|
3335
|
+
is_stacked?: boolean;
|
|
3336
|
+
/** The scrollbar configuration for chart. */
|
|
3337
|
+
scrollbar?: VisualizationScrollbar;
|
|
3338
|
+
/** Whether to show data labels. */
|
|
3339
|
+
show_data_labels?: boolean;
|
|
3340
|
+
/** The configuration for the X-axis. */
|
|
3341
|
+
x: ColumnVisualizationXAxis[];
|
|
3342
|
+
/** The configuration for the Y-axes. */
|
|
3343
|
+
y: ColumnVisualizationYAxis[];
|
|
3344
|
+
}
|
|
3019
3345
|
/** command */
|
|
3020
3346
|
export type Command = AtomBase & {
|
|
3021
3347
|
/**
|
|
@@ -3156,9 +3482,11 @@ export interface CommandSurface {
|
|
|
3156
3482
|
/** Objects types on which a command can be invoked. */
|
|
3157
3483
|
export declare enum CommandSurfaceObjectTypes {
|
|
3158
3484
|
Account = "account",
|
|
3485
|
+
AiAssistantChat = "ai_assistant_chat",
|
|
3159
3486
|
Article = "article",
|
|
3160
3487
|
Conversation = "conversation",
|
|
3161
3488
|
CustomObject = "custom_object",
|
|
3489
|
+
Dm = "dm",
|
|
3162
3490
|
Engagement = "engagement",
|
|
3163
3491
|
Flow = "flow",
|
|
3164
3492
|
Incident = "incident",
|
|
@@ -3632,6 +3960,8 @@ export interface ConversationsDeleteRequest {
|
|
|
3632
3960
|
export type ConversationsDeleteResponse = object;
|
|
3633
3961
|
/** conversations-export-request */
|
|
3634
3962
|
export interface ConversationsExportRequest {
|
|
3963
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3964
|
+
actual_close_date?: DateFilter;
|
|
3635
3965
|
/**
|
|
3636
3966
|
* Filters for conversations belonging to any of the provided parts.
|
|
3637
3967
|
* @example ["PROD-12345"]
|
|
@@ -3693,6 +4023,8 @@ export interface ConversationsExportRequest {
|
|
|
3693
4023
|
source_channels?: string[];
|
|
3694
4024
|
/** The filter for stages. */
|
|
3695
4025
|
stage?: StageFilter;
|
|
4026
|
+
/** Filters for conversations with any of the provided states. */
|
|
4027
|
+
state?: string[];
|
|
3696
4028
|
/** Filters for conversation with any of the provided subtypes. */
|
|
3697
4029
|
subtype?: string[];
|
|
3698
4030
|
/**
|
|
@@ -3732,6 +4064,8 @@ export interface ConversationsGetResponse {
|
|
|
3732
4064
|
* The request to get information about a list of conversations.
|
|
3733
4065
|
*/
|
|
3734
4066
|
export interface ConversationsListRequest {
|
|
4067
|
+
/** Provides ways to specify date ranges on objects. */
|
|
4068
|
+
actual_close_date?: DateFilter;
|
|
3735
4069
|
/**
|
|
3736
4070
|
* Filters for conversations belonging to any of the provided parts.
|
|
3737
4071
|
* @example ["PROD-12345"]
|
|
@@ -3806,6 +4140,8 @@ export interface ConversationsListRequest {
|
|
|
3806
4140
|
source_channels?: string[];
|
|
3807
4141
|
/** The filter for stages. */
|
|
3808
4142
|
stage?: StageFilter;
|
|
4143
|
+
/** Filters for conversations with any of the provided states. */
|
|
4144
|
+
state?: string[];
|
|
3809
4145
|
/** Filters for conversation with any of the provided subtypes. */
|
|
3810
4146
|
subtype?: string[];
|
|
3811
4147
|
/**
|
|
@@ -3921,9 +4257,7 @@ export interface ConversationsUpdateRequestMetadata {
|
|
|
3921
4257
|
/** conversations-update-request-owned-by */
|
|
3922
4258
|
export interface ConversationsUpdateRequestOwnedBy {
|
|
3923
4259
|
/**
|
|
3924
|
-
* Sets the owner IDs to the provided user IDs.
|
|
3925
|
-
* empty.
|
|
3926
|
-
* @minItems 1
|
|
4260
|
+
* Sets the owner IDs to the provided user IDs.
|
|
3927
4261
|
* @example ["DEVU-12345"]
|
|
3928
4262
|
*/
|
|
3929
4263
|
set?: string[];
|
|
@@ -4358,6 +4692,27 @@ export interface CreateWeeklyOrgScheduleInterval {
|
|
|
4358
4692
|
* Static collection of Devrev objects.
|
|
4359
4693
|
*/
|
|
4360
4694
|
export type CuratedVistaSummary = VistaBaseSummary;
|
|
4695
|
+
/**
|
|
4696
|
+
* custom-field-widget-column-projection
|
|
4697
|
+
* A custom field widget column projection.
|
|
4698
|
+
*/
|
|
4699
|
+
export interface CustomFieldWidgetColumnProjection {
|
|
4700
|
+
/**
|
|
4701
|
+
* The leaf type of the custom field.
|
|
4702
|
+
* @format text
|
|
4703
|
+
*/
|
|
4704
|
+
leaf_type: string;
|
|
4705
|
+
/**
|
|
4706
|
+
* The name of the custom field.
|
|
4707
|
+
* @format text
|
|
4708
|
+
*/
|
|
4709
|
+
name: string;
|
|
4710
|
+
/**
|
|
4711
|
+
* The subtype of the custom field.
|
|
4712
|
+
* @format text
|
|
4713
|
+
*/
|
|
4714
|
+
subtype?: string;
|
|
4715
|
+
}
|
|
4361
4716
|
/** custom-link-type */
|
|
4362
4717
|
export type CustomLinkType = AtomBase & {
|
|
4363
4718
|
/**
|
|
@@ -4489,6 +4844,8 @@ export interface CustomLinkTypeListResponse {
|
|
|
4489
4844
|
/** The custom link types. */
|
|
4490
4845
|
result: CustomLinkType[];
|
|
4491
4846
|
}
|
|
4847
|
+
/** custom-link-type-summary */
|
|
4848
|
+
export type CustomLinkTypeSummary = AtomBaseSummary;
|
|
4492
4849
|
/** custom-link-type-update-request */
|
|
4493
4850
|
export interface CustomLinkTypeUpdateRequest {
|
|
4494
4851
|
/**
|
|
@@ -5006,6 +5363,7 @@ export interface CustomSchemaFragmentsSetResponse {
|
|
|
5006
5363
|
export interface CustomSchemaSpec {
|
|
5007
5364
|
/** List of apps. */
|
|
5008
5365
|
apps?: string[];
|
|
5366
|
+
drop?: CustomSchemaSpecDrop;
|
|
5009
5367
|
/**
|
|
5010
5368
|
* Name of the subtype.
|
|
5011
5369
|
* @format text
|
|
@@ -5016,6 +5374,19 @@ export interface CustomSchemaSpec {
|
|
|
5016
5374
|
/** Whether to enforce required fields validation. */
|
|
5017
5375
|
validate_required_fields?: boolean;
|
|
5018
5376
|
}
|
|
5377
|
+
/** custom-schema-spec-drop */
|
|
5378
|
+
export interface CustomSchemaSpecDrop {
|
|
5379
|
+
/**
|
|
5380
|
+
* List of apps to be dropped from the object. Note: The apps field in
|
|
5381
|
+
* the custom schema specifier should not contain any of these apps.
|
|
5382
|
+
*/
|
|
5383
|
+
apps?: string[];
|
|
5384
|
+
/**
|
|
5385
|
+
* Whether the subtype is to be dropped. Note: If set, the subtype
|
|
5386
|
+
* field in the custom schema specifier should be nil
|
|
5387
|
+
*/
|
|
5388
|
+
subtype?: boolean;
|
|
5389
|
+
}
|
|
5019
5390
|
/** custom-stage */
|
|
5020
5391
|
export type CustomStage = AtomBase & {
|
|
5021
5392
|
/**
|
|
@@ -5280,12 +5651,24 @@ export type CustomTypeFragmentSummary = CustomSchemaFragmentBaseSummary;
|
|
|
5280
5651
|
export type CustomTypePathComponent = object;
|
|
5281
5652
|
/** dashboard */
|
|
5282
5653
|
export type Dashboard = AtomBase;
|
|
5654
|
+
/**
|
|
5655
|
+
* dashboard-filter
|
|
5656
|
+
* A dashboard filter is a filter that can be applied to tabs, sections,
|
|
5657
|
+
* and widgets.
|
|
5658
|
+
*/
|
|
5659
|
+
export type DashboardFilter = object;
|
|
5283
5660
|
/** dashboard-search-summary */
|
|
5284
5661
|
export type DashboardSearchSummary = SearchSummaryBase & {
|
|
5285
5662
|
dashboard: DashboardSummary;
|
|
5286
5663
|
};
|
|
5287
5664
|
/** dashboard-summary */
|
|
5288
5665
|
export type DashboardSummary = AtomBaseSummary;
|
|
5666
|
+
/**
|
|
5667
|
+
* data-source-join
|
|
5668
|
+
* A list of possible joins for the data source. Follows foreign key
|
|
5669
|
+
* semantics.
|
|
5670
|
+
*/
|
|
5671
|
+
export type DataSourceJoin = object;
|
|
5289
5672
|
/**
|
|
5290
5673
|
* date-filter
|
|
5291
5674
|
* Provides ways to specify date ranges on objects.
|
|
@@ -6489,6 +6872,61 @@ export type DmSummary = ChatBaseSummary & {
|
|
|
6489
6872
|
*/
|
|
6490
6873
|
users: AtomSummary[];
|
|
6491
6874
|
};
|
|
6875
|
+
/**
|
|
6876
|
+
* donut-visualization-x-axis
|
|
6877
|
+
* The X-axis for a donut visualization.
|
|
6878
|
+
*/
|
|
6879
|
+
export interface DonutVisualizationXAxis {
|
|
6880
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
6881
|
+
color?: VisualizationAxisColor;
|
|
6882
|
+
/** The drill through configurations for the axis. */
|
|
6883
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
6884
|
+
/** Whether the axis should be hidden. */
|
|
6885
|
+
is_hidden?: boolean;
|
|
6886
|
+
/**
|
|
6887
|
+
* The label for the axis.
|
|
6888
|
+
* @format text
|
|
6889
|
+
*/
|
|
6890
|
+
label?: string;
|
|
6891
|
+
/**
|
|
6892
|
+
* The reference name of the axis.
|
|
6893
|
+
* @format text
|
|
6894
|
+
*/
|
|
6895
|
+
reference_name: string;
|
|
6896
|
+
}
|
|
6897
|
+
/**
|
|
6898
|
+
* donut-visualization-y-axis
|
|
6899
|
+
* The Y-axis for a donut visualization.
|
|
6900
|
+
*/
|
|
6901
|
+
export interface DonutVisualizationYAxis {
|
|
6902
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
6903
|
+
color?: VisualizationAxisColor;
|
|
6904
|
+
/** The drill through configurations for the axis. */
|
|
6905
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
6906
|
+
/** Whether the axis should be hidden. */
|
|
6907
|
+
is_hidden?: boolean;
|
|
6908
|
+
/**
|
|
6909
|
+
* The label for the axis.
|
|
6910
|
+
* @format text
|
|
6911
|
+
*/
|
|
6912
|
+
label?: string;
|
|
6913
|
+
/**
|
|
6914
|
+
* The reference name of the axis.
|
|
6915
|
+
* @format text
|
|
6916
|
+
*/
|
|
6917
|
+
reference_name: string;
|
|
6918
|
+
}
|
|
6919
|
+
/**
|
|
6920
|
+
* donut-widget-visualization
|
|
6921
|
+
* A donut chart visualization configuration. Includes metadata specific
|
|
6922
|
+
* to donut charts.
|
|
6923
|
+
*/
|
|
6924
|
+
export interface DonutWidgetVisualization {
|
|
6925
|
+
/** The configuration for the X-axis. */
|
|
6926
|
+
x: DonutVisualizationXAxis[];
|
|
6927
|
+
/** The Y-axis for a donut visualization. */
|
|
6928
|
+
y: DonutVisualizationYAxis;
|
|
6929
|
+
}
|
|
6492
6930
|
/**
|
|
6493
6931
|
* dynamic-group-info
|
|
6494
6932
|
* Information to define dynamic groups.
|
|
@@ -7729,6 +8167,19 @@ export interface EventSlaTrackerDeleted {
|
|
|
7729
8167
|
id: string;
|
|
7730
8168
|
old_sla_tracker?: SlaTracker;
|
|
7731
8169
|
}
|
|
8170
|
+
/** event-sla-tracker-fetched */
|
|
8171
|
+
export type EventSlaTrackerFetched = (Empty | EventSlaTrackerFetchedOk) & {
|
|
8172
|
+
/**
|
|
8173
|
+
* The ID of the SLA tracker that was fetched.
|
|
8174
|
+
* @format id
|
|
8175
|
+
*/
|
|
8176
|
+
id: string;
|
|
8177
|
+
result: EventFetchedResult;
|
|
8178
|
+
};
|
|
8179
|
+
/** event-sla-tracker-fetched-ok */
|
|
8180
|
+
export interface EventSlaTrackerFetchedOk {
|
|
8181
|
+
sla_tracker?: SlaTracker;
|
|
8182
|
+
}
|
|
7732
8183
|
/** event-sla-tracker-updated */
|
|
7733
8184
|
export interface EventSlaTrackerUpdated {
|
|
7734
8185
|
old_sla_tracker?: SlaTracker;
|
|
@@ -8306,6 +8757,55 @@ export interface GetRevUsersPersonalDataRequest {
|
|
|
8306
8757
|
* notified.
|
|
8307
8758
|
*/
|
|
8308
8759
|
export type GetRevUsersPersonalDataResponse = object;
|
|
8760
|
+
/**
|
|
8761
|
+
* grid-layout
|
|
8762
|
+
* Grid layout represents the organization of the elements within a
|
|
8763
|
+
* layout.
|
|
8764
|
+
*/
|
|
8765
|
+
export interface GridLayout {
|
|
8766
|
+
/** Layout of the elements within the current element. */
|
|
8767
|
+
layout?: GridLayout[];
|
|
8768
|
+
/**
|
|
8769
|
+
* A grid position represents the location and size of a widget or section
|
|
8770
|
+
* within its container (dashboard, tab, or section).
|
|
8771
|
+
*/
|
|
8772
|
+
position?: GridPosition;
|
|
8773
|
+
/**
|
|
8774
|
+
* The reference ID for the element to be laid out. It should be an ID
|
|
8775
|
+
* of a tab, section, or widget.
|
|
8776
|
+
* @format text
|
|
8777
|
+
*/
|
|
8778
|
+
reference_id: string;
|
|
8779
|
+
}
|
|
8780
|
+
/**
|
|
8781
|
+
* grid-position
|
|
8782
|
+
* A grid position represents the location and size of a widget or section
|
|
8783
|
+
* within its container (dashboard, tab, or section).
|
|
8784
|
+
*/
|
|
8785
|
+
export interface GridPosition {
|
|
8786
|
+
/**
|
|
8787
|
+
* The height of the widget or section, in grid units.
|
|
8788
|
+
* @format int32
|
|
8789
|
+
*/
|
|
8790
|
+
height: number;
|
|
8791
|
+
/**
|
|
8792
|
+
* The width of the widget or section, in grid units.
|
|
8793
|
+
* @format int32
|
|
8794
|
+
*/
|
|
8795
|
+
width: number;
|
|
8796
|
+
/**
|
|
8797
|
+
* The x-coordinate of the top-left corner of the widget or section,
|
|
8798
|
+
* based on a grid system.
|
|
8799
|
+
* @format int32
|
|
8800
|
+
*/
|
|
8801
|
+
x: number;
|
|
8802
|
+
/**
|
|
8803
|
+
* The y-coordinate of the top-left corner of the widget or section,
|
|
8804
|
+
* based on a grid system.
|
|
8805
|
+
* @format int32
|
|
8806
|
+
*/
|
|
8807
|
+
y: number;
|
|
8808
|
+
}
|
|
8309
8809
|
/** group */
|
|
8310
8810
|
export type Group = AtomBase & {
|
|
8311
8811
|
/**
|
|
@@ -8539,6 +9039,8 @@ export interface GroupsGetResponse {
|
|
|
8539
9039
|
* A request to get information about a list of groups.
|
|
8540
9040
|
*/
|
|
8541
9041
|
export interface GroupsListRequest {
|
|
9042
|
+
/** Filters the groups on the basis of creator. */
|
|
9043
|
+
created_by?: string[];
|
|
8542
9044
|
/**
|
|
8543
9045
|
* The cursor to resume iteration from. If not provided, then
|
|
8544
9046
|
* iteration starts from the beginning.
|
|
@@ -8566,8 +9068,11 @@ export interface GroupsListRequest {
|
|
|
8566
9068
|
* always be returned in the specified sort-by order.
|
|
8567
9069
|
*/
|
|
8568
9070
|
mode?: ListMode;
|
|
9071
|
+
/** Filters the groups on the basis of group name. */
|
|
9072
|
+
name?: string[];
|
|
8569
9073
|
/** Comma-separated fields to sort the groups by. */
|
|
8570
9074
|
sort_by?: string[];
|
|
9075
|
+
sync_metadata?: SyncMetadataFilter;
|
|
8571
9076
|
}
|
|
8572
9077
|
/**
|
|
8573
9078
|
* groups-list-response
|
|
@@ -8628,6 +9133,90 @@ export interface GroupsUpdateRequestDynamicGroupInfo {
|
|
|
8628
9133
|
export interface GroupsUpdateResponse {
|
|
8629
9134
|
group: Group;
|
|
8630
9135
|
}
|
|
9136
|
+
/**
|
|
9137
|
+
* heatmap-visualization-x-axis
|
|
9138
|
+
* The X-axis for a heatmap visualization.
|
|
9139
|
+
*/
|
|
9140
|
+
export interface HeatmapVisualizationXAxis {
|
|
9141
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
9142
|
+
color?: VisualizationAxisColor;
|
|
9143
|
+
/** The drill through configurations for the axis. */
|
|
9144
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
9145
|
+
/** Whether the axis should be hidden. */
|
|
9146
|
+
is_hidden?: boolean;
|
|
9147
|
+
/**
|
|
9148
|
+
* The label for the axis.
|
|
9149
|
+
* @format text
|
|
9150
|
+
*/
|
|
9151
|
+
label?: string;
|
|
9152
|
+
/**
|
|
9153
|
+
* The reference name of the axis.
|
|
9154
|
+
* @format text
|
|
9155
|
+
*/
|
|
9156
|
+
reference_name: string;
|
|
9157
|
+
}
|
|
9158
|
+
/**
|
|
9159
|
+
* heatmap-visualization-y-axis
|
|
9160
|
+
* The Y-axis for a heatmap visualization.
|
|
9161
|
+
*/
|
|
9162
|
+
export interface HeatmapVisualizationYAxis {
|
|
9163
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
9164
|
+
color?: VisualizationAxisColor;
|
|
9165
|
+
/** The drill through configurations for the axis. */
|
|
9166
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
9167
|
+
/** Whether the axis should be hidden. */
|
|
9168
|
+
is_hidden?: boolean;
|
|
9169
|
+
/**
|
|
9170
|
+
* The label for the axis.
|
|
9171
|
+
* @format text
|
|
9172
|
+
*/
|
|
9173
|
+
label?: string;
|
|
9174
|
+
/**
|
|
9175
|
+
* The reference name of the axis.
|
|
9176
|
+
* @format text
|
|
9177
|
+
*/
|
|
9178
|
+
reference_name: string;
|
|
9179
|
+
}
|
|
9180
|
+
/**
|
|
9181
|
+
* heatmap-visualization-z-axis
|
|
9182
|
+
* The Z-axis for a heatmap visualization.
|
|
9183
|
+
*/
|
|
9184
|
+
export interface HeatmapVisualizationZAxis {
|
|
9185
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
9186
|
+
color?: VisualizationAxisColor;
|
|
9187
|
+
/** The drill through configurations for the axis. */
|
|
9188
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
9189
|
+
/** Whether the axis should be hidden. */
|
|
9190
|
+
is_hidden?: boolean;
|
|
9191
|
+
/**
|
|
9192
|
+
* The label for the axis.
|
|
9193
|
+
* @format text
|
|
9194
|
+
*/
|
|
9195
|
+
label?: string;
|
|
9196
|
+
/**
|
|
9197
|
+
* The reference name of the axis.
|
|
9198
|
+
* @format text
|
|
9199
|
+
*/
|
|
9200
|
+
reference_name: string;
|
|
9201
|
+
}
|
|
9202
|
+
/**
|
|
9203
|
+
* heatmap-widget-visualization
|
|
9204
|
+
* A heatmap chart visualization configuration. Includes metadata specific
|
|
9205
|
+
* to heatmap charts.
|
|
9206
|
+
*/
|
|
9207
|
+
export interface HeatmapWidgetVisualization {
|
|
9208
|
+
/**
|
|
9209
|
+
* Color for heatmap.
|
|
9210
|
+
* @format text
|
|
9211
|
+
*/
|
|
9212
|
+
color?: string;
|
|
9213
|
+
/** The X-axis for a heatmap visualization. */
|
|
9214
|
+
x: HeatmapVisualizationXAxis;
|
|
9215
|
+
/** The Y-axis for a heatmap visualization. */
|
|
9216
|
+
y: HeatmapVisualizationYAxis;
|
|
9217
|
+
/** The Z-axis for a heatmap visualization. */
|
|
9218
|
+
z: HeatmapVisualizationZAxis;
|
|
9219
|
+
}
|
|
8631
9220
|
/**
|
|
8632
9221
|
* impacted-customer-details
|
|
8633
9222
|
* Details of the impact due to the incident.
|
|
@@ -9281,6 +9870,57 @@ export interface JobHistoryItem {
|
|
|
9281
9870
|
*/
|
|
9282
9871
|
title?: string;
|
|
9283
9872
|
}
|
|
9873
|
+
/**
|
|
9874
|
+
* kanban-visualization-card-attribute
|
|
9875
|
+
* A card attribute in a kanban visualization.
|
|
9876
|
+
*/
|
|
9877
|
+
export interface KanbanVisualizationCardAttribute {
|
|
9878
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
9879
|
+
color?: VisualizationAxisColor;
|
|
9880
|
+
/** The drill through configurations for the axis. */
|
|
9881
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
9882
|
+
/** Whether the axis should be hidden. */
|
|
9883
|
+
is_hidden?: boolean;
|
|
9884
|
+
/**
|
|
9885
|
+
* The label for the axis.
|
|
9886
|
+
* @format text
|
|
9887
|
+
*/
|
|
9888
|
+
label?: string;
|
|
9889
|
+
/**
|
|
9890
|
+
* The order in which the attribute should be displayed in a card.
|
|
9891
|
+
* @format int32
|
|
9892
|
+
*/
|
|
9893
|
+
order?: number;
|
|
9894
|
+
/**
|
|
9895
|
+
* Whether the attribute should be placed in the body or footer of the
|
|
9896
|
+
* kanban.
|
|
9897
|
+
*/
|
|
9898
|
+
position?: KanbanVisualizationCardAttributePosition;
|
|
9899
|
+
/**
|
|
9900
|
+
* The reference name of the axis.
|
|
9901
|
+
* @format text
|
|
9902
|
+
*/
|
|
9903
|
+
reference_name: string;
|
|
9904
|
+
}
|
|
9905
|
+
/**
|
|
9906
|
+
* Whether the attribute should be placed in the body or footer of the
|
|
9907
|
+
* kanban.
|
|
9908
|
+
*/
|
|
9909
|
+
export declare enum KanbanVisualizationCardAttributePosition {
|
|
9910
|
+
Body = "body",
|
|
9911
|
+
Footer = "footer"
|
|
9912
|
+
}
|
|
9913
|
+
/**
|
|
9914
|
+
* kanban-widget-visualization
|
|
9915
|
+
* A kanban visualization configuration. Includes metadata specific to
|
|
9916
|
+
* kanban.
|
|
9917
|
+
*/
|
|
9918
|
+
export interface KanbanWidgetVisualization {
|
|
9919
|
+
/** The configuration for the card in the kanban. */
|
|
9920
|
+
card_attributes: KanbanVisualizationCardAttribute[];
|
|
9921
|
+
/** The group_by configuration in the kanban. */
|
|
9922
|
+
group_by: WidgetGroupByConfig[];
|
|
9923
|
+
}
|
|
9284
9924
|
/** keyrings-create-callback-request */
|
|
9285
9925
|
export interface KeyringsCreateCallbackRequest {
|
|
9286
9926
|
/**
|
|
@@ -9329,6 +9969,71 @@ export interface LegacyStageSummary {
|
|
|
9329
9969
|
name: string;
|
|
9330
9970
|
stage?: CustomStageSummary;
|
|
9331
9971
|
}
|
|
9972
|
+
/**
|
|
9973
|
+
* line-visualization-x-axis
|
|
9974
|
+
* The X-axis for a line visualization.
|
|
9975
|
+
*/
|
|
9976
|
+
export interface LineVisualizationXAxis {
|
|
9977
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
9978
|
+
color?: VisualizationAxisColor;
|
|
9979
|
+
/** The drill through configurations for the axis. */
|
|
9980
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
9981
|
+
/** Whether the axis should be hidden. */
|
|
9982
|
+
is_hidden?: boolean;
|
|
9983
|
+
/**
|
|
9984
|
+
* The label for the axis.
|
|
9985
|
+
* @format text
|
|
9986
|
+
*/
|
|
9987
|
+
label?: string;
|
|
9988
|
+
/**
|
|
9989
|
+
* The reference name of the axis.
|
|
9990
|
+
* @format text
|
|
9991
|
+
*/
|
|
9992
|
+
reference_name: string;
|
|
9993
|
+
}
|
|
9994
|
+
/**
|
|
9995
|
+
* line-visualization-y-axis
|
|
9996
|
+
* The Y-axis for a line visualization.
|
|
9997
|
+
*/
|
|
9998
|
+
export interface LineVisualizationYAxis {
|
|
9999
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
10000
|
+
color?: VisualizationAxisColor;
|
|
10001
|
+
/** The drill through configurations for the axis. */
|
|
10002
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
10003
|
+
/** Whether the area under the line should be filled. */
|
|
10004
|
+
is_area_filled?: boolean;
|
|
10005
|
+
/** Whether the axis should be hidden. */
|
|
10006
|
+
is_hidden?: boolean;
|
|
10007
|
+
/** Whether the line should be a spline. */
|
|
10008
|
+
is_spline?: boolean;
|
|
10009
|
+
/**
|
|
10010
|
+
* The label for the axis.
|
|
10011
|
+
* @format text
|
|
10012
|
+
*/
|
|
10013
|
+
label?: string;
|
|
10014
|
+
/** Whether the line have circular marker. */
|
|
10015
|
+
marker?: boolean;
|
|
10016
|
+
/**
|
|
10017
|
+
* The reference name of the axis.
|
|
10018
|
+
* @format text
|
|
10019
|
+
*/
|
|
10020
|
+
reference_name: string;
|
|
10021
|
+
}
|
|
10022
|
+
/**
|
|
10023
|
+
* line-widget-visualization
|
|
10024
|
+
* A line chart visualization configuration. Includes metadata specific to
|
|
10025
|
+
* line charts.
|
|
10026
|
+
*/
|
|
10027
|
+
export interface LineWidgetVisualization {
|
|
10028
|
+
/** Whether the line should be stacked. */
|
|
10029
|
+
is_stacked?: boolean;
|
|
10030
|
+
/** Whether to show data labels. */
|
|
10031
|
+
show_data_labels?: boolean;
|
|
10032
|
+
/** The configuration for the X-axes. */
|
|
10033
|
+
x: LineVisualizationXAxis[];
|
|
10034
|
+
/** The configuration for the Y-axes. */
|
|
10035
|
+
y: LineVisualizationYAxis[];
|
|
10036
|
+
}
|
|
9332
10037
|
/**
|
|
9333
10038
|
* lines-of-code
|
|
9334
10039
|
* Details of lines of code in this code change.
|
|
@@ -9357,6 +10062,7 @@ export interface LinesOfCode {
|
|
|
9357
10062
|
}
|
|
9358
10063
|
/** link */
|
|
9359
10064
|
export type Link = AtomBase & {
|
|
10065
|
+
custom_link_type?: CustomLinkTypeSummary;
|
|
9360
10066
|
/** Type of link used to define the relationship. */
|
|
9361
10067
|
link_type: LinkType;
|
|
9362
10068
|
source: LinkEndpointSummary;
|
|
@@ -9368,7 +10074,7 @@ export interface LinkDescriptorFilter {
|
|
|
9368
10074
|
link_descriptors: LinkTargetDescriptor[];
|
|
9369
10075
|
}
|
|
9370
10076
|
/** link-endpoint-summary */
|
|
9371
|
-
export type LinkEndpointSummary = (AccountSummary | CapabilitySummary | CodeChangeSummary | ConversationSummary | CustomObjectSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IncidentSummary | IssueSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | TaskSummary | TicketSummary | WidgetSummary) & {
|
|
10077
|
+
export type LinkEndpointSummary = (AccountSummary | CapabilitySummary | CodeChangeSummary | ConversationSummary | CustomObjectSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IncidentSummary | IssueSummary | LinkableSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | RunnableSummary | TaskSummary | TicketSummary | WidgetSummary) & {
|
|
9372
10078
|
type: LinkEndpointType;
|
|
9373
10079
|
};
|
|
9374
10080
|
export declare enum LinkEndpointType {
|
|
@@ -9382,11 +10088,13 @@ export declare enum LinkEndpointType {
|
|
|
9382
10088
|
Feature = "feature",
|
|
9383
10089
|
Incident = "incident",
|
|
9384
10090
|
Issue = "issue",
|
|
10091
|
+
Linkable = "linkable",
|
|
9385
10092
|
Meeting = "meeting",
|
|
9386
10093
|
Opportunity = "opportunity",
|
|
9387
10094
|
Product = "product",
|
|
9388
10095
|
RevOrg = "rev_org",
|
|
9389
10096
|
RevUser = "rev_user",
|
|
10097
|
+
Runnable = "runnable",
|
|
9390
10098
|
Task = "task",
|
|
9391
10099
|
Ticket = "ticket",
|
|
9392
10100
|
Widget = "widget"
|
|
@@ -9480,11 +10188,20 @@ export declare enum LinkType {
|
|
|
9480
10188
|
IsRelatedTo = "is_related_to",
|
|
9481
10189
|
Serves = "serves"
|
|
9482
10190
|
}
|
|
10191
|
+
/** linkable */
|
|
10192
|
+
export type Linkable = PartBase;
|
|
10193
|
+
/** linkable-summary */
|
|
10194
|
+
export type LinkableSummary = PartBaseSummary;
|
|
9483
10195
|
/**
|
|
9484
10196
|
* links-create-request
|
|
9485
10197
|
* The request to create a new link.
|
|
9486
10198
|
*/
|
|
9487
10199
|
export interface LinksCreateRequest {
|
|
10200
|
+
/**
|
|
10201
|
+
* The ID of the custom link type.
|
|
10202
|
+
* @format id
|
|
10203
|
+
*/
|
|
10204
|
+
custom_link_type?: string;
|
|
9488
10205
|
/** Type of link used to define the relationship. */
|
|
9489
10206
|
link_type: LinkType;
|
|
9490
10207
|
/**
|
|
@@ -9621,6 +10338,36 @@ export interface LinksListResponse {
|
|
|
9621
10338
|
*/
|
|
9622
10339
|
prev_cursor?: string;
|
|
9623
10340
|
}
|
|
10341
|
+
/**
|
|
10342
|
+
* links-replace-request
|
|
10343
|
+
* The request to replace a link.
|
|
10344
|
+
*/
|
|
10345
|
+
export interface LinksReplaceRequest {
|
|
10346
|
+
/**
|
|
10347
|
+
* The ID of the link to be replaced.
|
|
10348
|
+
* @format id
|
|
10349
|
+
*/
|
|
10350
|
+
id: string;
|
|
10351
|
+
/** Type of link used to define the relationship. */
|
|
10352
|
+
link_type: LinkType;
|
|
10353
|
+
/**
|
|
10354
|
+
* The ID of the source object.
|
|
10355
|
+
* @format id
|
|
10356
|
+
*/
|
|
10357
|
+
source: string;
|
|
10358
|
+
/**
|
|
10359
|
+
* The ID of the target object.
|
|
10360
|
+
* @format id
|
|
10361
|
+
*/
|
|
10362
|
+
target: string;
|
|
10363
|
+
}
|
|
10364
|
+
/**
|
|
10365
|
+
* links-replace-response
|
|
10366
|
+
* The response to replacing a link.
|
|
10367
|
+
*/
|
|
10368
|
+
export interface LinksReplaceResponse {
|
|
10369
|
+
link: Link;
|
|
10370
|
+
}
|
|
9624
10371
|
/**
|
|
9625
10372
|
* The iteration mode to use. If "after", then entries after the provided
|
|
9626
10373
|
* cursor will be returned, or if no cursor is provided, then from the
|
|
@@ -9632,6 +10379,59 @@ export declare enum ListMode {
|
|
|
9632
10379
|
After = "after",
|
|
9633
10380
|
Before = "before"
|
|
9634
10381
|
}
|
|
10382
|
+
/**
|
|
10383
|
+
* meerkat-widget-column-function
|
|
10384
|
+
* A meerkat specific column function.
|
|
10385
|
+
*/
|
|
10386
|
+
export interface MeerkatWidgetColumnFunction {
|
|
10387
|
+
/** The type of the function. */
|
|
10388
|
+
type: MeerkatWidgetColumnFunctionType;
|
|
10389
|
+
}
|
|
10390
|
+
/** The type of the function. */
|
|
10391
|
+
export declare enum MeerkatWidgetColumnFunctionType {
|
|
10392
|
+
Avg = "avg",
|
|
10393
|
+
Count = "count",
|
|
10394
|
+
CountDistinct = "count_distinct",
|
|
10395
|
+
Max = "max",
|
|
10396
|
+
Median = "median",
|
|
10397
|
+
Min = "min",
|
|
10398
|
+
Sum = "sum"
|
|
10399
|
+
}
|
|
10400
|
+
/**
|
|
10401
|
+
* meerkat-widget-column-projection
|
|
10402
|
+
* A meerkat specific column projection.
|
|
10403
|
+
*/
|
|
10404
|
+
export interface MeerkatWidgetColumnProjection {
|
|
10405
|
+
/** The data type of the column generated by the SQL expression. */
|
|
10406
|
+
type: MeerkatWidgetColumnProjectionType;
|
|
10407
|
+
/** A meerkat specific column function. */
|
|
10408
|
+
function?: MeerkatWidgetColumnFunction;
|
|
10409
|
+
/**
|
|
10410
|
+
* The SQL expression used to extract or transform the column from the
|
|
10411
|
+
* data source.
|
|
10412
|
+
* @format text
|
|
10413
|
+
*/
|
|
10414
|
+
sql_expression: string;
|
|
10415
|
+
/** The rollup granularity for the timestamp. */
|
|
10416
|
+
timestamp_rollup?: MeerkatWidgetColumnProjectionTimestampRollup;
|
|
10417
|
+
}
|
|
10418
|
+
/** The rollup granularity for the timestamp. */
|
|
10419
|
+
export declare enum MeerkatWidgetColumnProjectionTimestampRollup {
|
|
10420
|
+
Day = "day",
|
|
10421
|
+
Hour = "hour",
|
|
10422
|
+
Month = "month",
|
|
10423
|
+
Week = "week",
|
|
10424
|
+
Year = "year"
|
|
10425
|
+
}
|
|
10426
|
+
/** The data type of the column generated by the SQL expression. */
|
|
10427
|
+
export declare enum MeerkatWidgetColumnProjectionType {
|
|
10428
|
+
Boolean = "boolean",
|
|
10429
|
+
Number = "number",
|
|
10430
|
+
NumberArray = "number_array",
|
|
10431
|
+
String = "string",
|
|
10432
|
+
StringArray = "string_array",
|
|
10433
|
+
Time = "time"
|
|
10434
|
+
}
|
|
9635
10435
|
/** meeting */
|
|
9636
10436
|
export type Meeting = AtomBase & {
|
|
9637
10437
|
/** The artifacts attached to the meeting. */
|
|
@@ -9696,6 +10496,8 @@ export type Meeting = AtomBase & {
|
|
|
9696
10496
|
* @format text
|
|
9697
10497
|
*/
|
|
9698
10498
|
subtype?: string;
|
|
10499
|
+
/** Sync information for records synced into/from DevRev. */
|
|
10500
|
+
sync_metadata?: SyncMetadata;
|
|
9699
10501
|
/** Tags associated with the meeting. */
|
|
9700
10502
|
tags?: TagWithValue[];
|
|
9701
10503
|
/**
|
|
@@ -9726,7 +10528,10 @@ export declare enum MeetingState {
|
|
|
9726
10528
|
Waiting = "waiting"
|
|
9727
10529
|
}
|
|
9728
10530
|
/** meeting-summary */
|
|
9729
|
-
export type MeetingSummary = AtomBaseSummary
|
|
10531
|
+
export type MeetingSummary = AtomBaseSummary & {
|
|
10532
|
+
/** Sync information for records synced into/from DevRev. */
|
|
10533
|
+
sync_metadata?: SyncMetadataSummary;
|
|
10534
|
+
};
|
|
9730
10535
|
/** meetings-count-request */
|
|
9731
10536
|
export interface MeetingsCountRequest {
|
|
9732
10537
|
/** Filters for meeting on specified channels. */
|
|
@@ -10343,6 +11148,65 @@ export interface MetricDefinitionsUpdateRequest {
|
|
|
10343
11148
|
export interface MetricDefinitionsUpdateResponse {
|
|
10344
11149
|
metric_definition: MetricDefinition;
|
|
10345
11150
|
}
|
|
11151
|
+
/** metric-tracker */
|
|
11152
|
+
export interface MetricTracker {
|
|
11153
|
+
type: MetricTrackerType;
|
|
11154
|
+
}
|
|
11155
|
+
export type MetricTrackerType = string;
|
|
11156
|
+
/** metric-trackers-get-request */
|
|
11157
|
+
export interface MetricTrackersGetRequest {
|
|
11158
|
+
/**
|
|
11159
|
+
* The ID of the metric that is being tracked.
|
|
11160
|
+
* @format id
|
|
11161
|
+
*/
|
|
11162
|
+
metric: string;
|
|
11163
|
+
/**
|
|
11164
|
+
* The ID of the underlying object on which the metric is being
|
|
11165
|
+
* tracked.
|
|
11166
|
+
* @format id
|
|
11167
|
+
*/
|
|
11168
|
+
object: string;
|
|
11169
|
+
}
|
|
11170
|
+
/** metric-trackers-get-response */
|
|
11171
|
+
export interface MetricTrackersGetResponse {
|
|
11172
|
+
metric_tracker: MetricTracker;
|
|
11173
|
+
}
|
|
11174
|
+
/**
|
|
11175
|
+
* metric-visualization-y-axis
|
|
11176
|
+
* The y axis for a metric visualization.
|
|
11177
|
+
*/
|
|
11178
|
+
export interface MetricVisualizationYAxis {
|
|
11179
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
11180
|
+
color?: VisualizationAxisColor;
|
|
11181
|
+
/** The drill through configurations for the axis. */
|
|
11182
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
11183
|
+
/** Whether the axis should be hidden. */
|
|
11184
|
+
is_hidden?: boolean;
|
|
11185
|
+
/**
|
|
11186
|
+
* The label for the axis.
|
|
11187
|
+
* @format text
|
|
11188
|
+
*/
|
|
11189
|
+
label?: string;
|
|
11190
|
+
/**
|
|
11191
|
+
* The reference name of the axis.
|
|
11192
|
+
* @format text
|
|
11193
|
+
*/
|
|
11194
|
+
reference_name: string;
|
|
11195
|
+
}
|
|
11196
|
+
/**
|
|
11197
|
+
* metric-widget-visualization
|
|
11198
|
+
* A metric visualization configuration. Includes metadata specific to
|
|
11199
|
+
* metrics.
|
|
11200
|
+
*/
|
|
11201
|
+
export interface MetricWidgetVisualization {
|
|
11202
|
+
/**
|
|
11203
|
+
* Configuration settings for enabling and customizing PVP (past vs.
|
|
11204
|
+
* present) value in widgets.
|
|
11205
|
+
*/
|
|
11206
|
+
pvp?: WidgetPvpConfig;
|
|
11207
|
+
/** The configuration for the Y-axis. */
|
|
11208
|
+
y: MetricVisualizationYAxis[];
|
|
11209
|
+
}
|
|
10346
11210
|
/** metrics-data */
|
|
10347
11211
|
export interface MetricsData {
|
|
10348
11212
|
/**
|
|
@@ -10448,6 +11312,8 @@ export type Opportunity = WorkBase & {
|
|
|
10448
11312
|
account?: AccountSummary;
|
|
10449
11313
|
/** Money. */
|
|
10450
11314
|
annual_contract_value?: Money;
|
|
11315
|
+
/** Contacts involved in the opportunity. */
|
|
11316
|
+
contacts?: UserSummary[];
|
|
10451
11317
|
/** The properties of an enum value. */
|
|
10452
11318
|
forecast_category_v2?: EnumValue;
|
|
10453
11319
|
/** Money. */
|
|
@@ -10910,6 +11776,61 @@ export declare enum OrgType {
|
|
|
10910
11776
|
DevOrg = "dev_org",
|
|
10911
11777
|
RevOrg = "rev_org"
|
|
10912
11778
|
}
|
|
11779
|
+
/**
|
|
11780
|
+
* packed-bubble-visualization-x-axis
|
|
11781
|
+
* The X-axis for a packed bubble visualization.
|
|
11782
|
+
*/
|
|
11783
|
+
export interface PackedBubbleVisualizationXAxis {
|
|
11784
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
11785
|
+
color?: VisualizationAxisColor;
|
|
11786
|
+
/** The drill through configurations for the axis. */
|
|
11787
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
11788
|
+
/** Whether the axis should be hidden. */
|
|
11789
|
+
is_hidden?: boolean;
|
|
11790
|
+
/**
|
|
11791
|
+
* The label for the axis.
|
|
11792
|
+
* @format text
|
|
11793
|
+
*/
|
|
11794
|
+
label?: string;
|
|
11795
|
+
/**
|
|
11796
|
+
* The reference name of the axis.
|
|
11797
|
+
* @format text
|
|
11798
|
+
*/
|
|
11799
|
+
reference_name: string;
|
|
11800
|
+
}
|
|
11801
|
+
/**
|
|
11802
|
+
* packed-bubble-visualization-y-axis
|
|
11803
|
+
* The Y-axis for a packed bubble visualization.
|
|
11804
|
+
*/
|
|
11805
|
+
export interface PackedBubbleVisualizationYAxis {
|
|
11806
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
11807
|
+
color?: VisualizationAxisColor;
|
|
11808
|
+
/** The drill through configurations for the axis. */
|
|
11809
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
11810
|
+
/** Whether the axis should be hidden. */
|
|
11811
|
+
is_hidden?: boolean;
|
|
11812
|
+
/**
|
|
11813
|
+
* The label for the axis.
|
|
11814
|
+
* @format text
|
|
11815
|
+
*/
|
|
11816
|
+
label?: string;
|
|
11817
|
+
/**
|
|
11818
|
+
* The reference name of the axis.
|
|
11819
|
+
* @format text
|
|
11820
|
+
*/
|
|
11821
|
+
reference_name: string;
|
|
11822
|
+
}
|
|
11823
|
+
/**
|
|
11824
|
+
* packed-bubble-widget-visualization
|
|
11825
|
+
* A Packed Bubble chart visualization configuration. Includes metadata
|
|
11826
|
+
* specific to packed bubble charts.
|
|
11827
|
+
*/
|
|
11828
|
+
export interface PackedBubbleWidgetVisualization {
|
|
11829
|
+
/** The configuration for the X-axis. */
|
|
11830
|
+
x: PackedBubbleVisualizationXAxis[];
|
|
11831
|
+
/** The configuration for the Y-axes. */
|
|
11832
|
+
y: PackedBubbleVisualizationYAxis[];
|
|
11833
|
+
}
|
|
10913
11834
|
/**
|
|
10914
11835
|
* parent-part-filter
|
|
10915
11836
|
* The filter for specifying parent part.
|
|
@@ -10929,7 +11850,7 @@ export interface ParentPartFilter {
|
|
|
10929
11850
|
parts: string[];
|
|
10930
11851
|
}
|
|
10931
11852
|
/** part */
|
|
10932
|
-
export type Part = (Capability | Enhancement | Feature | Product) & {
|
|
11853
|
+
export type Part = (Capability | Enhancement | Feature | Linkable | Product | Runnable) & {
|
|
10933
11854
|
type: PartType;
|
|
10934
11855
|
};
|
|
10935
11856
|
/** part-base */
|
|
@@ -10993,14 +11914,16 @@ export type PartSearchSummary = SearchSummaryBase & {
|
|
|
10993
11914
|
part: PartSummary;
|
|
10994
11915
|
};
|
|
10995
11916
|
/** part-summary */
|
|
10996
|
-
export type PartSummary = (CapabilitySummary | EnhancementSummary | FeatureSummary | ProductSummary) & {
|
|
11917
|
+
export type PartSummary = (CapabilitySummary | EnhancementSummary | FeatureSummary | LinkableSummary | ProductSummary | RunnableSummary) & {
|
|
10997
11918
|
type: PartType;
|
|
10998
11919
|
};
|
|
10999
11920
|
export declare enum PartType {
|
|
11000
11921
|
Capability = "capability",
|
|
11001
11922
|
Enhancement = "enhancement",
|
|
11002
11923
|
Feature = "feature",
|
|
11003
|
-
|
|
11924
|
+
Linkable = "linkable",
|
|
11925
|
+
Product = "product",
|
|
11926
|
+
Runnable = "runnable"
|
|
11004
11927
|
}
|
|
11005
11928
|
/** parts-create-request */
|
|
11006
11929
|
export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequestEnhancement | PartsCreateRequestFeature | PartsCreateRequestLinkable | PartsCreateRequestProduct | PartsCreateRequestRunnable) & {
|
|
@@ -11376,6 +12299,61 @@ export interface PartsUpdateRequestTags {
|
|
|
11376
12299
|
export interface PartsUpdateResponse {
|
|
11377
12300
|
part: Part;
|
|
11378
12301
|
}
|
|
12302
|
+
/**
|
|
12303
|
+
* pie-visualization-x-axis
|
|
12304
|
+
* The X-axis for a pie visualization.
|
|
12305
|
+
*/
|
|
12306
|
+
export interface PieVisualizationXAxis {
|
|
12307
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
12308
|
+
color?: VisualizationAxisColor;
|
|
12309
|
+
/** The drill through configurations for the axis. */
|
|
12310
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
12311
|
+
/** Whether the axis should be hidden. */
|
|
12312
|
+
is_hidden?: boolean;
|
|
12313
|
+
/**
|
|
12314
|
+
* The label for the axis.
|
|
12315
|
+
* @format text
|
|
12316
|
+
*/
|
|
12317
|
+
label?: string;
|
|
12318
|
+
/**
|
|
12319
|
+
* The reference name of the axis.
|
|
12320
|
+
* @format text
|
|
12321
|
+
*/
|
|
12322
|
+
reference_name: string;
|
|
12323
|
+
}
|
|
12324
|
+
/**
|
|
12325
|
+
* pie-visualization-y-axis
|
|
12326
|
+
* The Y-axis for a pie visualization.
|
|
12327
|
+
*/
|
|
12328
|
+
export interface PieVisualizationYAxis {
|
|
12329
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
12330
|
+
color?: VisualizationAxisColor;
|
|
12331
|
+
/** The drill through configurations for the axis. */
|
|
12332
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
12333
|
+
/** Whether the axis should be hidden. */
|
|
12334
|
+
is_hidden?: boolean;
|
|
12335
|
+
/**
|
|
12336
|
+
* The label for the axis.
|
|
12337
|
+
* @format text
|
|
12338
|
+
*/
|
|
12339
|
+
label?: string;
|
|
12340
|
+
/**
|
|
12341
|
+
* The reference name of the axis.
|
|
12342
|
+
* @format text
|
|
12343
|
+
*/
|
|
12344
|
+
reference_name: string;
|
|
12345
|
+
}
|
|
12346
|
+
/**
|
|
12347
|
+
* pie-widget-visualization
|
|
12348
|
+
* A pie chart visualization configuration. Includes metadata specific to
|
|
12349
|
+
* pie charts.
|
|
12350
|
+
*/
|
|
12351
|
+
export interface PieWidgetVisualization {
|
|
12352
|
+
/** The configuration for the X-axis. */
|
|
12353
|
+
x: PieVisualizationXAxis[];
|
|
12354
|
+
/** The Y-axis for a pie visualization. */
|
|
12355
|
+
y: PieVisualizationYAxis;
|
|
12356
|
+
}
|
|
11379
12357
|
/** preferences */
|
|
11380
12358
|
export type Preferences = UserPreferences & {
|
|
11381
12359
|
type: PreferencesType;
|
|
@@ -11387,6 +12365,11 @@ export type PreferencesBaseSummary = AtomBaseSummary;
|
|
|
11387
12365
|
/** preferences-get-request */
|
|
11388
12366
|
export interface PreferencesGetRequest {
|
|
11389
12367
|
type: PreferencesType;
|
|
12368
|
+
/**
|
|
12369
|
+
* Language code for which to get the preferences for.
|
|
12370
|
+
* @format text
|
|
12371
|
+
*/
|
|
12372
|
+
language_code?: string;
|
|
11390
12373
|
/**
|
|
11391
12374
|
* The ID of the target object for which preferences object is to be
|
|
11392
12375
|
* fetched.
|
|
@@ -11405,6 +12388,11 @@ export declare enum PreferencesType {
|
|
|
11405
12388
|
/** preferences-update-request */
|
|
11406
12389
|
export type PreferencesUpdateRequest = UpdateUserPreferences & {
|
|
11407
12390
|
type: PreferencesType;
|
|
12391
|
+
/**
|
|
12392
|
+
* Language code for which to update the preferences for.
|
|
12393
|
+
* @format text
|
|
12394
|
+
*/
|
|
12395
|
+
language_code?: string;
|
|
11408
12396
|
/**
|
|
11409
12397
|
* The ID of the object for which the preferences are to be updated.
|
|
11410
12398
|
* @format id
|
|
@@ -11812,6 +12800,84 @@ export declare enum ReactionsUpdateRequestAction {
|
|
|
11812
12800
|
}
|
|
11813
12801
|
/** reactions-update-response */
|
|
11814
12802
|
export type ReactionsUpdateResponse = object;
|
|
12803
|
+
/** record-template */
|
|
12804
|
+
export type RecordTemplate = AtomBase & {
|
|
12805
|
+
/**
|
|
12806
|
+
* Custom Fields of the object that the record template is associated
|
|
12807
|
+
* with.
|
|
12808
|
+
*/
|
|
12809
|
+
custom_fields?: RecordTemplateFieldValues[];
|
|
12810
|
+
/**
|
|
12811
|
+
* Description of the record template.
|
|
12812
|
+
* @format text
|
|
12813
|
+
*/
|
|
12814
|
+
description?: string;
|
|
12815
|
+
/**
|
|
12816
|
+
* Type of object that the record template is associated with.
|
|
12817
|
+
* @format text
|
|
12818
|
+
*/
|
|
12819
|
+
leaf_type?: string;
|
|
12820
|
+
/**
|
|
12821
|
+
* Name of the record template.
|
|
12822
|
+
* @format text
|
|
12823
|
+
*/
|
|
12824
|
+
name?: string;
|
|
12825
|
+
/** Shared with membership. */
|
|
12826
|
+
shared_with?: SharedWithMembership[];
|
|
12827
|
+
/** State of the record template. */
|
|
12828
|
+
state?: RecordTemplateState;
|
|
12829
|
+
/**
|
|
12830
|
+
* Stock Fields of the object that the record template is associated
|
|
12831
|
+
* with.
|
|
12832
|
+
*/
|
|
12833
|
+
stock_fields?: RecordTemplateFieldValues[];
|
|
12834
|
+
/**
|
|
12835
|
+
* Subtype of the object that the record template is associated with.
|
|
12836
|
+
* @format text
|
|
12837
|
+
*/
|
|
12838
|
+
subtype?: string;
|
|
12839
|
+
};
|
|
12840
|
+
/**
|
|
12841
|
+
* record-template-field-values
|
|
12842
|
+
* Information about the field values.
|
|
12843
|
+
*/
|
|
12844
|
+
export interface RecordTemplateFieldValues {
|
|
12845
|
+
/**
|
|
12846
|
+
* The field's name.
|
|
12847
|
+
* @format text
|
|
12848
|
+
*/
|
|
12849
|
+
field_name?: string;
|
|
12850
|
+
/** Value of the given field. */
|
|
12851
|
+
field_value?: any;
|
|
12852
|
+
}
|
|
12853
|
+
/** record-template-get-request */
|
|
12854
|
+
export interface RecordTemplateGetRequest {
|
|
12855
|
+
/**
|
|
12856
|
+
* The ID of the record template.
|
|
12857
|
+
* @format id
|
|
12858
|
+
*/
|
|
12859
|
+
id: string;
|
|
12860
|
+
}
|
|
12861
|
+
/** record-template-get-response */
|
|
12862
|
+
export interface RecordTemplateGetResponse {
|
|
12863
|
+
record_template_info: RecordTemplateInfo;
|
|
12864
|
+
}
|
|
12865
|
+
/** record-template-info */
|
|
12866
|
+
export interface RecordTemplateInfo {
|
|
12867
|
+
record_template: RecordTemplate;
|
|
12868
|
+
/**
|
|
12869
|
+
* List of fields that do not conform to the expected schema of the
|
|
12870
|
+
* underlying leaf type of the template object.
|
|
12871
|
+
*/
|
|
12872
|
+
stale_fields?: RecordTemplateFieldValues[];
|
|
12873
|
+
}
|
|
12874
|
+
/** State of the record template. */
|
|
12875
|
+
export declare enum RecordTemplateState {
|
|
12876
|
+
Active = "active",
|
|
12877
|
+
Draft = "draft",
|
|
12878
|
+
Inactive = "inactive",
|
|
12879
|
+
NeedsAttention = "needs_attention"
|
|
12880
|
+
}
|
|
11815
12881
|
/** remove-tag-with-value */
|
|
11816
12882
|
export interface RemoveTagWithValue {
|
|
11817
12883
|
/**
|
|
@@ -12095,6 +13161,7 @@ export interface RevOrgsListResponse {
|
|
|
12095
13161
|
export interface RevOrgsUpdateRequest {
|
|
12096
13162
|
/**
|
|
12097
13163
|
* New account ID to associate with this Rev organization.
|
|
13164
|
+
* @deprecated
|
|
12098
13165
|
* @format id
|
|
12099
13166
|
* @example "ACC-12345"
|
|
12100
13167
|
*/
|
|
@@ -12699,6 +13766,14 @@ export interface RevUsersUpdateRequestCustomSchemaFragments {
|
|
|
12699
13766
|
export interface RevUsersUpdateResponse {
|
|
12700
13767
|
rev_user: RevUser;
|
|
12701
13768
|
}
|
|
13769
|
+
/**
|
|
13770
|
+
* rich-text-widget-visualization
|
|
13771
|
+
* The configuration for a rich text visualization.
|
|
13772
|
+
*/
|
|
13773
|
+
export interface RichTextWidgetVisualization {
|
|
13774
|
+
/** The content of the rich text. */
|
|
13775
|
+
content?: object;
|
|
13776
|
+
}
|
|
12702
13777
|
/** role */
|
|
12703
13778
|
export type Role = AtomBase & {
|
|
12704
13779
|
/** Sync information for records synced into/from DevRev. */
|
|
@@ -12794,6 +13869,10 @@ export interface RolesCreateRequest {
|
|
|
12794
13869
|
export interface RolesCreateResponse {
|
|
12795
13870
|
role: Role;
|
|
12796
13871
|
}
|
|
13872
|
+
/** runnable */
|
|
13873
|
+
export type Runnable = PartBase;
|
|
13874
|
+
/** runnable-summary */
|
|
13875
|
+
export type RunnableSummary = PartBaseSummary;
|
|
12797
13876
|
/** saml-connection-fields-map */
|
|
12798
13877
|
export interface SamlConnectionFieldsMap {
|
|
12799
13878
|
/**
|
|
@@ -12809,6 +13888,61 @@ export interface SamlConnectionFieldsMap {
|
|
|
12809
13888
|
*/
|
|
12810
13889
|
user_id?: string;
|
|
12811
13890
|
}
|
|
13891
|
+
/**
|
|
13892
|
+
* scatter-visualization-x-axis
|
|
13893
|
+
* The X-axis for a scatter visualization.
|
|
13894
|
+
*/
|
|
13895
|
+
export interface ScatterVisualizationXAxis {
|
|
13896
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
13897
|
+
color?: VisualizationAxisColor;
|
|
13898
|
+
/** The drill through configurations for the axis. */
|
|
13899
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
13900
|
+
/** Whether the axis should be hidden. */
|
|
13901
|
+
is_hidden?: boolean;
|
|
13902
|
+
/**
|
|
13903
|
+
* The label for the axis.
|
|
13904
|
+
* @format text
|
|
13905
|
+
*/
|
|
13906
|
+
label?: string;
|
|
13907
|
+
/**
|
|
13908
|
+
* The reference name of the axis.
|
|
13909
|
+
* @format text
|
|
13910
|
+
*/
|
|
13911
|
+
reference_name: string;
|
|
13912
|
+
}
|
|
13913
|
+
/**
|
|
13914
|
+
* scatter-visualization-y-axis
|
|
13915
|
+
* The Y-axis for a scatter visualization.
|
|
13916
|
+
*/
|
|
13917
|
+
export interface ScatterVisualizationYAxis {
|
|
13918
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
13919
|
+
color?: VisualizationAxisColor;
|
|
13920
|
+
/** The drill through configurations for the axis. */
|
|
13921
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
13922
|
+
/** Whether the axis should be hidden. */
|
|
13923
|
+
is_hidden?: boolean;
|
|
13924
|
+
/**
|
|
13925
|
+
* The label for the axis.
|
|
13926
|
+
* @format text
|
|
13927
|
+
*/
|
|
13928
|
+
label?: string;
|
|
13929
|
+
/**
|
|
13930
|
+
* The reference name of the axis.
|
|
13931
|
+
* @format text
|
|
13932
|
+
*/
|
|
13933
|
+
reference_name: string;
|
|
13934
|
+
}
|
|
13935
|
+
/**
|
|
13936
|
+
* scatter-widget-visualization
|
|
13937
|
+
* A Scatter chart visualization configuration. Includes metadata specific
|
|
13938
|
+
* to scatter charts.
|
|
13939
|
+
*/
|
|
13940
|
+
export interface ScatterWidgetVisualization {
|
|
13941
|
+
/** The configuration for the X-axis. */
|
|
13942
|
+
x: ScatterVisualizationXAxis[];
|
|
13943
|
+
/** The configuration for the Y-axes. */
|
|
13944
|
+
y: ScatterVisualizationYAxis[];
|
|
13945
|
+
}
|
|
12812
13946
|
/** schema-bool-field-descriptor */
|
|
12813
13947
|
export type SchemaBoolFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
12814
13948
|
/** Default value. */
|
|
@@ -13859,6 +14993,31 @@ export declare enum SendNotificationType {
|
|
|
13859
14993
|
export type ServiceAccount = UserBase;
|
|
13860
14994
|
/** service-account-summary */
|
|
13861
14995
|
export type ServiceAccountSummary = UserBaseSummary;
|
|
14996
|
+
/**
|
|
14997
|
+
* service-accounts-create-request
|
|
14998
|
+
* The request object to create a new service account.
|
|
14999
|
+
*/
|
|
15000
|
+
export interface ServiceAccountsCreateRequest {
|
|
15001
|
+
/**
|
|
15002
|
+
* The service account's display name. A unique, human readable name
|
|
15003
|
+
* to identify a service account.
|
|
15004
|
+
* @format text
|
|
15005
|
+
*/
|
|
15006
|
+
display_name: string;
|
|
15007
|
+
/**
|
|
15008
|
+
* Indicates whether to generate a keyring along with the new service
|
|
15009
|
+
* account. The default is false.
|
|
15010
|
+
*/
|
|
15011
|
+
gen_keyring?: boolean;
|
|
15012
|
+
}
|
|
15013
|
+
/**
|
|
15014
|
+
* service-accounts-create-response
|
|
15015
|
+
* The response object to the corresponding create service account
|
|
15016
|
+
* request.
|
|
15017
|
+
*/
|
|
15018
|
+
export interface ServiceAccountsCreateResponse {
|
|
15019
|
+
service_account: ServiceAccount;
|
|
15020
|
+
}
|
|
13862
15021
|
/**
|
|
13863
15022
|
* service-accounts-get-request
|
|
13864
15023
|
* The request object to get a service account's information.
|
|
@@ -15131,6 +16290,86 @@ export interface StockSchemaFragmentsListResponse {
|
|
|
15131
16290
|
/** The stock schema fragments. */
|
|
15132
16291
|
result: StockSchemaFragment[];
|
|
15133
16292
|
}
|
|
16293
|
+
/**
|
|
16294
|
+
* sub-widget
|
|
16295
|
+
* A sub-widget represents a data visualization unit contained within a
|
|
16296
|
+
* widget.
|
|
16297
|
+
*/
|
|
16298
|
+
export interface SubWidget {
|
|
16299
|
+
/**
|
|
16300
|
+
* The query for a widget. This includes measures and dimensions to be
|
|
16301
|
+
* visualized.
|
|
16302
|
+
*/
|
|
16303
|
+
query?: WidgetQuery;
|
|
16304
|
+
/**
|
|
16305
|
+
* A reference ID for the sub-widget. It should be unique within the
|
|
16306
|
+
* widget.
|
|
16307
|
+
* @format text
|
|
16308
|
+
*/
|
|
16309
|
+
reference_id: string;
|
|
16310
|
+
/**
|
|
16311
|
+
* The visualization for a widget. This includes the type of visualization
|
|
16312
|
+
* and any configuration specific to that type.
|
|
16313
|
+
*/
|
|
16314
|
+
visualization: WidgetVisualization;
|
|
16315
|
+
}
|
|
16316
|
+
/** subscribers-list-request */
|
|
16317
|
+
export interface SubscribersListRequest {
|
|
16318
|
+
/**
|
|
16319
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
16320
|
+
* then iteration starts from the beginning.
|
|
16321
|
+
* @format text
|
|
16322
|
+
*/
|
|
16323
|
+
cursor?: string;
|
|
16324
|
+
/**
|
|
16325
|
+
* The object's ID.
|
|
16326
|
+
* @format id
|
|
16327
|
+
* @example "ISS-12345"
|
|
16328
|
+
*/
|
|
16329
|
+
id: string;
|
|
16330
|
+
/**
|
|
16331
|
+
* The maximum number of subscribers to return. If not set or `<= 0`,
|
|
16332
|
+
* then this defaults to `50`.
|
|
16333
|
+
* @format int32
|
|
16334
|
+
*/
|
|
16335
|
+
limit?: number;
|
|
16336
|
+
}
|
|
16337
|
+
/** subscribers-list-response */
|
|
16338
|
+
export interface SubscribersListResponse {
|
|
16339
|
+
/**
|
|
16340
|
+
* The cursor that should be used to iterate the next sequence of
|
|
16341
|
+
* results, otherwise if not set, then no elements exist after.
|
|
16342
|
+
* @format text
|
|
16343
|
+
*/
|
|
16344
|
+
next_cursor?: string;
|
|
16345
|
+
/** The list of subscribers on the object. */
|
|
16346
|
+
users: UserSummary[];
|
|
16347
|
+
}
|
|
16348
|
+
/** subscribers-update-request */
|
|
16349
|
+
export interface SubscribersUpdateRequest {
|
|
16350
|
+
/**
|
|
16351
|
+
* The object's ID.
|
|
16352
|
+
* @format id
|
|
16353
|
+
* @example "ISS-12345"
|
|
16354
|
+
*/
|
|
16355
|
+
id: string;
|
|
16356
|
+
subscribers?: SubscribersUpdateRequestSubscribers;
|
|
16357
|
+
}
|
|
16358
|
+
/** subscribers-update-request-subscribers */
|
|
16359
|
+
export interface SubscribersUpdateRequestSubscribers {
|
|
16360
|
+
/**
|
|
16361
|
+
* The list of users to add as subscribers on the object.
|
|
16362
|
+
* @example ["DEVU-12345"]
|
|
16363
|
+
*/
|
|
16364
|
+
add?: string[];
|
|
16365
|
+
/**
|
|
16366
|
+
* The list of users to remove as subscribers on the object.
|
|
16367
|
+
* @example ["DEVU-12345"]
|
|
16368
|
+
*/
|
|
16369
|
+
remove?: string[];
|
|
16370
|
+
}
|
|
16371
|
+
/** subscribers-update-response */
|
|
16372
|
+
export type SubscribersUpdateResponse = object;
|
|
15134
16373
|
/** subtype */
|
|
15135
16374
|
export interface Subtype {
|
|
15136
16375
|
/**
|
|
@@ -15693,6 +16932,8 @@ export interface SyncMetadataFilterSyncInFilter {
|
|
|
15693
16932
|
status?: SyncMetadataFilterSyncInFilterStatus[];
|
|
15694
16933
|
/** Provides ways to specify date ranges on objects. */
|
|
15695
16934
|
sync_date?: DateFilter;
|
|
16935
|
+
/** Filters for works modified with selected sync history. */
|
|
16936
|
+
sync_history?: string[];
|
|
15696
16937
|
/** Filters for works modified with selected sync units. */
|
|
15697
16938
|
sync_unit?: string[];
|
|
15698
16939
|
}
|
|
@@ -15708,6 +16949,8 @@ export interface SyncMetadataFilterSyncOutFilter {
|
|
|
15708
16949
|
status?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
15709
16950
|
/** Provides ways to specify date ranges on objects. */
|
|
15710
16951
|
sync_date?: DateFilter;
|
|
16952
|
+
/** Filters for works modified with selected sync history. */
|
|
16953
|
+
sync_history?: string[];
|
|
15711
16954
|
/** Filters for works modified with selected sync units. */
|
|
15712
16955
|
sync_unit?: string[];
|
|
15713
16956
|
}
|
|
@@ -15964,6 +17207,95 @@ export interface SysUsersUpdateRequest {
|
|
|
15964
17207
|
export interface SysUsersUpdateResponse {
|
|
15965
17208
|
sys_user: SysUser;
|
|
15966
17209
|
}
|
|
17210
|
+
/**
|
|
17211
|
+
* table-visualization-column
|
|
17212
|
+
* A column in a table visualization.
|
|
17213
|
+
*/
|
|
17214
|
+
export interface TableVisualizationColumn {
|
|
17215
|
+
/** The color for an axis. This can be a single color or a gradient. */
|
|
17216
|
+
color?: VisualizationAxisColor;
|
|
17217
|
+
/** The drill through configurations for the axis. */
|
|
17218
|
+
drill_throughs?: VisualizationAxisDrillThrough[];
|
|
17219
|
+
/** Whether the axis should be hidden. */
|
|
17220
|
+
is_hidden?: boolean;
|
|
17221
|
+
/** Whether the column should be movable. */
|
|
17222
|
+
is_movable?: boolean;
|
|
17223
|
+
/** Whether the column should be pinned, by default set to false. */
|
|
17224
|
+
is_pinned?: boolean;
|
|
17225
|
+
/** Whether the column should be resizable. */
|
|
17226
|
+
is_resizable?: boolean;
|
|
17227
|
+
/** Whether the column should be sortable. */
|
|
17228
|
+
is_sortable?: boolean;
|
|
17229
|
+
/** Whether the column visibility can be toggled. */
|
|
17230
|
+
is_visibility_togglable?: boolean;
|
|
17231
|
+
/**
|
|
17232
|
+
* The label for the axis.
|
|
17233
|
+
* @format text
|
|
17234
|
+
*/
|
|
17235
|
+
label?: string;
|
|
17236
|
+
/**
|
|
17237
|
+
* Whether the column should be locked to the left or right side of the
|
|
17238
|
+
* table.
|
|
17239
|
+
*/
|
|
17240
|
+
lock_position?: TableVisualizationColumnLockPosition;
|
|
17241
|
+
/**
|
|
17242
|
+
* The maximum width of the column.
|
|
17243
|
+
* @format int32
|
|
17244
|
+
*/
|
|
17245
|
+
max_width?: number;
|
|
17246
|
+
/**
|
|
17247
|
+
* The minimum width of the column.
|
|
17248
|
+
* @format int32
|
|
17249
|
+
*/
|
|
17250
|
+
min_width?: number;
|
|
17251
|
+
/**
|
|
17252
|
+
* The order in which the column should be displayed.
|
|
17253
|
+
* @format int32
|
|
17254
|
+
*/
|
|
17255
|
+
order?: number;
|
|
17256
|
+
/**
|
|
17257
|
+
* Whether the column should be pinned to the left or right side of the
|
|
17258
|
+
* table.
|
|
17259
|
+
*/
|
|
17260
|
+
pin_position?: TableVisualizationColumnPinPosition;
|
|
17261
|
+
/**
|
|
17262
|
+
* The reference name of the axis.
|
|
17263
|
+
* @format text
|
|
17264
|
+
*/
|
|
17265
|
+
reference_name: string;
|
|
17266
|
+
/**
|
|
17267
|
+
* The width of the column in pixel.
|
|
17268
|
+
* @format int32
|
|
17269
|
+
*/
|
|
17270
|
+
width?: number;
|
|
17271
|
+
}
|
|
17272
|
+
/**
|
|
17273
|
+
* Whether the column should be locked to the left or right side of the
|
|
17274
|
+
* table.
|
|
17275
|
+
*/
|
|
17276
|
+
export declare enum TableVisualizationColumnLockPosition {
|
|
17277
|
+
Left = "left",
|
|
17278
|
+
Right = "right"
|
|
17279
|
+
}
|
|
17280
|
+
/**
|
|
17281
|
+
* Whether the column should be pinned to the left or right side of the
|
|
17282
|
+
* table.
|
|
17283
|
+
*/
|
|
17284
|
+
export declare enum TableVisualizationColumnPinPosition {
|
|
17285
|
+
Left = "left",
|
|
17286
|
+
Right = "right"
|
|
17287
|
+
}
|
|
17288
|
+
/**
|
|
17289
|
+
* table-widget-visualization
|
|
17290
|
+
* A table visualization configuration. Includes metadata specific to
|
|
17291
|
+
* tables.
|
|
17292
|
+
*/
|
|
17293
|
+
export interface TableWidgetVisualization {
|
|
17294
|
+
/** The configuration for the columns in the table. */
|
|
17295
|
+
columns: TableVisualizationColumn[];
|
|
17296
|
+
/** The group_by configuration in the table. */
|
|
17297
|
+
group_by?: WidgetGroupByConfig[];
|
|
17298
|
+
}
|
|
15967
17299
|
/** tag */
|
|
15968
17300
|
export type Tag = AtomBase & {
|
|
15969
17301
|
/**
|
|
@@ -16742,11 +18074,13 @@ export declare enum TimelineEntryObjectType {
|
|
|
16742
18074
|
Feature = "feature",
|
|
16743
18075
|
Incident = "incident",
|
|
16744
18076
|
Issue = "issue",
|
|
18077
|
+
Linkable = "linkable",
|
|
16745
18078
|
Meeting = "meeting",
|
|
16746
18079
|
Opportunity = "opportunity",
|
|
16747
18080
|
Product = "product",
|
|
16748
18081
|
RevOrg = "rev_org",
|
|
16749
18082
|
RevUser = "rev_user",
|
|
18083
|
+
Runnable = "runnable",
|
|
16750
18084
|
SnapIn = "snap_in",
|
|
16751
18085
|
Task = "task",
|
|
16752
18086
|
Ticket = "ticket",
|
|
@@ -17805,6 +19139,53 @@ export declare enum VistaType {
|
|
|
17805
19139
|
Dynamic = "dynamic",
|
|
17806
19140
|
Grouped = "grouped"
|
|
17807
19141
|
}
|
|
19142
|
+
/**
|
|
19143
|
+
* visualization-axis-color
|
|
19144
|
+
* The color for an axis. This can be a single color or a gradient.
|
|
19145
|
+
*/
|
|
19146
|
+
export interface VisualizationAxisColor {
|
|
19147
|
+
/** The type of the color. */
|
|
19148
|
+
type: VisualizationAxisColorType;
|
|
19149
|
+
/** The key lookup color. */
|
|
19150
|
+
key_lookup?: VisualizationAxisColorKeyLookup[];
|
|
19151
|
+
/**
|
|
19152
|
+
* The static color.
|
|
19153
|
+
* @format text
|
|
19154
|
+
*/
|
|
19155
|
+
static?: string;
|
|
19156
|
+
}
|
|
19157
|
+
/**
|
|
19158
|
+
* visualization-axis-color-key-lookup
|
|
19159
|
+
* The key lookup color for an axis. This is used to map a value to a
|
|
19160
|
+
* color.
|
|
19161
|
+
*/
|
|
19162
|
+
export interface VisualizationAxisColorKeyLookup {
|
|
19163
|
+
/**
|
|
19164
|
+
* The key to map to a color.
|
|
19165
|
+
* @format text
|
|
19166
|
+
*/
|
|
19167
|
+
key: string;
|
|
19168
|
+
/**
|
|
19169
|
+
* The color value.
|
|
19170
|
+
* @format text
|
|
19171
|
+
*/
|
|
19172
|
+
value: string;
|
|
19173
|
+
}
|
|
19174
|
+
/** The type of the color. */
|
|
19175
|
+
export declare enum VisualizationAxisColorType {
|
|
19176
|
+
KeyLookup = "key_lookup",
|
|
19177
|
+
Static = "static"
|
|
19178
|
+
}
|
|
19179
|
+
/**
|
|
19180
|
+
* visualization-axis-drill-through
|
|
19181
|
+
* The drill through configuration for an axis.
|
|
19182
|
+
*/
|
|
19183
|
+
export type VisualizationAxisDrillThrough = object;
|
|
19184
|
+
/**
|
|
19185
|
+
* visualization-scrollbar
|
|
19186
|
+
* The scrollbar configuration for chart.
|
|
19187
|
+
*/
|
|
19188
|
+
export type VisualizationScrollbar = object;
|
|
17808
19189
|
/** web-crawler-job */
|
|
17809
19190
|
export type WebCrawlerJob = AtomBase & {
|
|
17810
19191
|
/**
|
|
@@ -18120,6 +19501,7 @@ export interface WebhookEventRequest {
|
|
|
18120
19501
|
rev_user_updated?: EventRevUserUpdated;
|
|
18121
19502
|
sla_tracker_created?: EventSlaTrackerCreated;
|
|
18122
19503
|
sla_tracker_deleted?: EventSlaTrackerDeleted;
|
|
19504
|
+
sla_tracker_fetched?: EventSlaTrackerFetched;
|
|
18123
19505
|
sla_tracker_updated?: EventSlaTrackerUpdated;
|
|
18124
19506
|
survey_created?: EventSurveyCreated;
|
|
18125
19507
|
survey_deleted?: EventSurveyDeleted;
|
|
@@ -18215,6 +19597,7 @@ export declare enum WebhookEventType {
|
|
|
18215
19597
|
RevUserUpdated = "rev_user_updated",
|
|
18216
19598
|
SlaTrackerCreated = "sla_tracker_created",
|
|
18217
19599
|
SlaTrackerDeleted = "sla_tracker_deleted",
|
|
19600
|
+
SlaTrackerFetched = "sla_tracker_fetched",
|
|
18218
19601
|
SlaTrackerUpdated = "sla_tracker_updated",
|
|
18219
19602
|
SurveyCreated = "survey_created",
|
|
18220
19603
|
SurveyDeleted = "survey_deleted",
|
|
@@ -18363,120 +19746,505 @@ export interface WebhooksGetRequest {
|
|
|
18363
19746
|
id: string;
|
|
18364
19747
|
}
|
|
18365
19748
|
/**
|
|
18366
|
-
* webhooks-get-response
|
|
18367
|
-
* The response to getting the information for the webhook.
|
|
19749
|
+
* webhooks-get-response
|
|
19750
|
+
* The response to getting the information for the webhook.
|
|
19751
|
+
*/
|
|
19752
|
+
export interface WebhooksGetResponse {
|
|
19753
|
+
webhook: Webhook;
|
|
19754
|
+
}
|
|
19755
|
+
/**
|
|
19756
|
+
* webhooks-list-request
|
|
19757
|
+
* The request to list the webhooks.
|
|
19758
|
+
*/
|
|
19759
|
+
export type WebhooksListRequest = object;
|
|
19760
|
+
/**
|
|
19761
|
+
* webhooks-list-response
|
|
19762
|
+
* The response to listing the webhooks.
|
|
19763
|
+
*/
|
|
19764
|
+
export interface WebhooksListResponse {
|
|
19765
|
+
/** The list of webhooks. */
|
|
19766
|
+
webhooks: Webhook[];
|
|
19767
|
+
}
|
|
19768
|
+
/** The action to update the webhook's status. */
|
|
19769
|
+
export declare enum WebhooksUpdateAction {
|
|
19770
|
+
Activate = "activate",
|
|
19771
|
+
Deactivate = "deactivate"
|
|
19772
|
+
}
|
|
19773
|
+
/**
|
|
19774
|
+
* webhooks-update-request
|
|
19775
|
+
* The request to update a webhook.
|
|
19776
|
+
*/
|
|
19777
|
+
export interface WebhooksUpdateRequest {
|
|
19778
|
+
/** The action to update the webhook's status. */
|
|
19779
|
+
action?: WebhooksUpdateAction;
|
|
19780
|
+
event_types?: WebhooksUpdateRequestEventTypes;
|
|
19781
|
+
headers?: WebhooksUpdateRequestHeaders;
|
|
19782
|
+
/**
|
|
19783
|
+
* ID for the webhook.
|
|
19784
|
+
* @format id
|
|
19785
|
+
* @example "don:integration:dvrv-us-1:devo/example:webhook/webhook-id"
|
|
19786
|
+
*/
|
|
19787
|
+
id: string;
|
|
19788
|
+
/**
|
|
19789
|
+
* If provided, updates the secret that's used when verifying webhook
|
|
19790
|
+
* events, which must be between 8 and 32 bytes (inclusive). Otherwise
|
|
19791
|
+
* if empty, then a new secret is generated. If the webhook is active,
|
|
19792
|
+
* then its status will transition to the 'unverified' state and it
|
|
19793
|
+
* won't receive any object events until successfully verified.
|
|
19794
|
+
* @format byte
|
|
19795
|
+
*/
|
|
19796
|
+
secret?: string;
|
|
19797
|
+
/**
|
|
19798
|
+
* The webhook's updated URL. If the webhook is active, then the
|
|
19799
|
+
* webhook's status will transition to the 'unverified' state and it
|
|
19800
|
+
* won't receive any object events until successfully verified.
|
|
19801
|
+
* @format text
|
|
19802
|
+
*/
|
|
19803
|
+
url?: string;
|
|
19804
|
+
}
|
|
19805
|
+
/** webhooks-update-request-event-types */
|
|
19806
|
+
export interface WebhooksUpdateRequestEventTypes {
|
|
19807
|
+
/**
|
|
19808
|
+
* The event types to add. If a provided event type is already set for
|
|
19809
|
+
* the webhook, then nothing is done. Note this is mutually exclusive
|
|
19810
|
+
* with 'set'.
|
|
19811
|
+
*/
|
|
19812
|
+
add?: WebhookEventType[];
|
|
19813
|
+
/**
|
|
19814
|
+
* The event types to remove. If a provided event type isn't set for
|
|
19815
|
+
* the webhook, then nothing is done. Note this is mutually exclusive
|
|
19816
|
+
* with 'set'.
|
|
19817
|
+
*/
|
|
19818
|
+
remove?: WebhookEventType[];
|
|
19819
|
+
/**
|
|
19820
|
+
* The updated event types, which will replace the webhook's current
|
|
19821
|
+
* event types. Note this is mutually exclusive with 'add' and
|
|
19822
|
+
* 'remove'.
|
|
19823
|
+
*/
|
|
19824
|
+
set?: WebhookEventType[];
|
|
19825
|
+
}
|
|
19826
|
+
/** webhooks-update-request-headers */
|
|
19827
|
+
export interface WebhooksUpdateRequestHeaders {
|
|
19828
|
+
/**
|
|
19829
|
+
* The headers to be added to every webhook invocation. If a provided
|
|
19830
|
+
* header is already specified for the webhook, its value is replaced.
|
|
19831
|
+
* @maxItems 8
|
|
19832
|
+
*/
|
|
19833
|
+
add?: WebhookHeader[];
|
|
19834
|
+
/**
|
|
19835
|
+
* The headers to be removed from every webhook invocation. If a
|
|
19836
|
+
* provided header is not specified for the webhook, then it's
|
|
19837
|
+
* ignored.
|
|
19838
|
+
* @maxItems 8
|
|
19839
|
+
*/
|
|
19840
|
+
remove?: string[];
|
|
19841
|
+
/**
|
|
19842
|
+
* Sets the headers to include in every webhook invocation.
|
|
19843
|
+
* @maxItems 8
|
|
19844
|
+
*/
|
|
19845
|
+
set?: WebhookHeader[];
|
|
19846
|
+
}
|
|
19847
|
+
/**
|
|
19848
|
+
* webhooks-update-response
|
|
19849
|
+
* The response to updating the webhook.
|
|
19850
|
+
*/
|
|
19851
|
+
export interface WebhooksUpdateResponse {
|
|
19852
|
+
webhook: Webhook;
|
|
19853
|
+
}
|
|
19854
|
+
/**
|
|
19855
|
+
* weekly-org-schedule
|
|
19856
|
+
* The schedule for each week.
|
|
19857
|
+
*/
|
|
19858
|
+
export type WeeklyOrgSchedule = object;
|
|
19859
|
+
/** widget */
|
|
19860
|
+
export type Widget = AtomBase & {
|
|
19861
|
+
/** Data sources provide the backing data tables for the widget. */
|
|
19862
|
+
data_sources?: WidgetDataSource[];
|
|
19863
|
+
/**
|
|
19864
|
+
* A brief summary of what the widget displays or represents.
|
|
19865
|
+
* @format text
|
|
19866
|
+
*/
|
|
19867
|
+
description: string;
|
|
19868
|
+
/** Whether the widget is a draft widget. */
|
|
19869
|
+
is_draft?: boolean;
|
|
19870
|
+
/** Whether the widget is a system widget. */
|
|
19871
|
+
is_system?: boolean;
|
|
19872
|
+
/**
|
|
19873
|
+
* Layout of the widget. It determines the organization of the sub
|
|
19874
|
+
* widgets.
|
|
19875
|
+
*/
|
|
19876
|
+
layout: GridLayout[];
|
|
19877
|
+
/**
|
|
19878
|
+
* A unique identifying name for the widget (optional).
|
|
19879
|
+
* @format text
|
|
19880
|
+
*/
|
|
19881
|
+
name?: string;
|
|
19882
|
+
/**
|
|
19883
|
+
* A list of sub-widgets that the widget contains. Each widget can
|
|
19884
|
+
* contain multiple sub-widgets.
|
|
19885
|
+
*/
|
|
19886
|
+
sub_widgets: SubWidget[];
|
|
19887
|
+
/**
|
|
19888
|
+
* The title of the widget.
|
|
19889
|
+
* @format text
|
|
19890
|
+
*/
|
|
19891
|
+
title: string;
|
|
19892
|
+
};
|
|
19893
|
+
/**
|
|
19894
|
+
* widget-api-data-source
|
|
19895
|
+
* An API-backed data source.
|
|
19896
|
+
*/
|
|
19897
|
+
export interface WidgetApiDataSource {
|
|
19898
|
+
/** Object IDs to include in the data source. */
|
|
19899
|
+
include?: WorkSummary[];
|
|
19900
|
+
/** Indicates if the leaf type is custom. */
|
|
19901
|
+
is_custom_leaf_type?: boolean;
|
|
19902
|
+
/**
|
|
19903
|
+
* The object's type.
|
|
19904
|
+
* @format text
|
|
19905
|
+
*/
|
|
19906
|
+
leaf_type?: string;
|
|
19907
|
+
/** The subtypes of the object. */
|
|
19908
|
+
subtypes?: string[];
|
|
19909
|
+
}
|
|
19910
|
+
/**
|
|
19911
|
+
* widget-column-projection
|
|
19912
|
+
* A widget column projection.
|
|
19913
|
+
*/
|
|
19914
|
+
export interface WidgetColumnProjection {
|
|
19915
|
+
/** The type of the column. */
|
|
19916
|
+
type?: WidgetColumnProjectionType;
|
|
19917
|
+
/** A custom field widget column projection. */
|
|
19918
|
+
custom_field?: CustomFieldWidgetColumnProjection;
|
|
19919
|
+
/** Set of field attributes. */
|
|
19920
|
+
devrev_schema: SchemaFieldDescriptor;
|
|
19921
|
+
/** Whether the column has a custom expression. */
|
|
19922
|
+
has_custom_expression?: boolean;
|
|
19923
|
+
/** Whether the column is derived. */
|
|
19924
|
+
is_derived?: boolean;
|
|
19925
|
+
/** A meerkat specific column projection. */
|
|
19926
|
+
meerkat_schema?: MeerkatWidgetColumnProjection;
|
|
19927
|
+
/**
|
|
19928
|
+
* The reference name of the column.
|
|
19929
|
+
* @format text
|
|
19930
|
+
*/
|
|
19931
|
+
reference_name: string;
|
|
19932
|
+
}
|
|
19933
|
+
/** The type of the column. */
|
|
19934
|
+
export declare enum WidgetColumnProjectionType {
|
|
19935
|
+
CustomField = "custom_field",
|
|
19936
|
+
Native = "native"
|
|
19937
|
+
}
|
|
19938
|
+
/**
|
|
19939
|
+
* widget-data-source
|
|
19940
|
+
* A data source for a widget.
|
|
19941
|
+
*/
|
|
19942
|
+
export interface WidgetDataSource {
|
|
19943
|
+
/** The type of the data source. */
|
|
19944
|
+
type: WidgetDataSourceType;
|
|
19945
|
+
/** An API-backed data source. */
|
|
19946
|
+
api?: WidgetApiDataSource;
|
|
19947
|
+
/**
|
|
19948
|
+
* The ID of the data source. Meant to be set when the type is
|
|
19949
|
+
* data_source.
|
|
19950
|
+
* @format text
|
|
19951
|
+
*/
|
|
19952
|
+
data_source?: string;
|
|
19953
|
+
/**
|
|
19954
|
+
* The dimensions (or the extended dimensions) provided by the data
|
|
19955
|
+
* source. These are the categories that can be used to group or
|
|
19956
|
+
* segment the measures.
|
|
19957
|
+
*/
|
|
19958
|
+
dimensions?: WidgetColumnProjection[];
|
|
19959
|
+
/** An referenced data source for a widget. */
|
|
19960
|
+
external_data_source?: WidgetDataSourceReference;
|
|
19961
|
+
/**
|
|
19962
|
+
* A list of possible joins for the data source. Follows foreign key
|
|
19963
|
+
* semantics.
|
|
19964
|
+
*/
|
|
19965
|
+
joins?: DataSourceJoin[];
|
|
19966
|
+
/**
|
|
19967
|
+
* The measures (or the extended measures) provided by the data
|
|
19968
|
+
* source. These are the numerical values that can be analyzed.
|
|
19969
|
+
*/
|
|
19970
|
+
measures?: WidgetColumnProjection[];
|
|
19971
|
+
/** An oasis backed data source. */
|
|
19972
|
+
oasis?: WidgetOasisDataSource;
|
|
19973
|
+
/**
|
|
19974
|
+
* The reference name of the data source.
|
|
19975
|
+
* @format text
|
|
19976
|
+
*/
|
|
19977
|
+
reference_name: string;
|
|
19978
|
+
}
|
|
19979
|
+
/**
|
|
19980
|
+
* widget-data-source-reference
|
|
19981
|
+
* An referenced data source for a widget.
|
|
19982
|
+
*/
|
|
19983
|
+
export interface WidgetDataSourceReference {
|
|
19984
|
+
/**
|
|
19985
|
+
* The column projections for the data source. These are the columns
|
|
19986
|
+
* that are projected from the datasets.
|
|
19987
|
+
*/
|
|
19988
|
+
dataset_projections?: WidgetOasisDatasetColumnProjection[];
|
|
19989
|
+
/**
|
|
19990
|
+
* The id of the data source.
|
|
19991
|
+
* @format text
|
|
19992
|
+
*/
|
|
19993
|
+
id: string;
|
|
19994
|
+
}
|
|
19995
|
+
/** The type of the data source. */
|
|
19996
|
+
export declare enum WidgetDataSourceType {
|
|
19997
|
+
Api = "api",
|
|
19998
|
+
DataSource = "data_source",
|
|
19999
|
+
DataView = "data_view",
|
|
20000
|
+
ExternalDataSource = "external_data_source",
|
|
20001
|
+
Oasis = "oasis"
|
|
20002
|
+
}
|
|
20003
|
+
/**
|
|
20004
|
+
* widget-group-by-config
|
|
20005
|
+
* The configuration for group_by operation.
|
|
20006
|
+
*/
|
|
20007
|
+
export interface WidgetGroupByConfig {
|
|
20008
|
+
/**
|
|
20009
|
+
* The key on which group_by is applied.
|
|
20010
|
+
* @format text
|
|
20011
|
+
*/
|
|
20012
|
+
key?: string;
|
|
20013
|
+
/**
|
|
20014
|
+
* The maximum number of unique values that can be returned for the
|
|
20015
|
+
* key.
|
|
20016
|
+
* @format int32
|
|
20017
|
+
*/
|
|
20018
|
+
limit?: number;
|
|
20019
|
+
}
|
|
20020
|
+
/**
|
|
20021
|
+
* widget-oasis-data-source
|
|
20022
|
+
* An oasis backed data source.
|
|
20023
|
+
*/
|
|
20024
|
+
export interface WidgetOasisDataSource {
|
|
20025
|
+
/** List of datasets used by the data source. */
|
|
20026
|
+
datasets?: string[];
|
|
20027
|
+
/**
|
|
20028
|
+
* The column projections for the data source. These are the columns
|
|
20029
|
+
* that are projected from the datasets.
|
|
20030
|
+
*/
|
|
20031
|
+
projections?: WidgetOasisDatasetColumnProjection[];
|
|
20032
|
+
/**
|
|
20033
|
+
* The base SQL query that constructs the view for the data source.
|
|
20034
|
+
* The SQL can reference the datasets using their aliases.
|
|
20035
|
+
* @format text
|
|
20036
|
+
*/
|
|
20037
|
+
sql_query: string;
|
|
20038
|
+
}
|
|
20039
|
+
/**
|
|
20040
|
+
* widget-oasis-dataset-column
|
|
20041
|
+
* An oasis dataset column.
|
|
20042
|
+
*/
|
|
20043
|
+
export interface WidgetOasisDatasetColumn {
|
|
20044
|
+
/** A custom field widget column projection. */
|
|
20045
|
+
custom_field?: CustomFieldWidgetColumnProjection;
|
|
20046
|
+
/**
|
|
20047
|
+
* The name of the column.
|
|
20048
|
+
* @format text
|
|
20049
|
+
*/
|
|
20050
|
+
name: string;
|
|
20051
|
+
}
|
|
20052
|
+
/**
|
|
20053
|
+
* widget-oasis-dataset-column-projection
|
|
20054
|
+
* An oasis dataset column projection.
|
|
20055
|
+
*/
|
|
20056
|
+
export interface WidgetOasisDatasetColumnProjection {
|
|
20057
|
+
/** The column name. */
|
|
20058
|
+
columns: WidgetOasisDatasetColumn[];
|
|
20059
|
+
/**
|
|
20060
|
+
* The dataset ID.
|
|
20061
|
+
* @format text
|
|
20062
|
+
*/
|
|
20063
|
+
dataset: string;
|
|
20064
|
+
}
|
|
20065
|
+
/**
|
|
20066
|
+
* widget-pvp-config
|
|
20067
|
+
* Configuration settings for enabling and customizing PVP (past vs.
|
|
20068
|
+
* present) value in widgets.
|
|
20069
|
+
*/
|
|
20070
|
+
export interface WidgetPvpConfig {
|
|
20071
|
+
/** Indicates whether PVP is enabled. */
|
|
20072
|
+
enabled?: boolean;
|
|
20073
|
+
/** Specifies whether the color scheme for PVP is inverted. */
|
|
20074
|
+
invert_correlation_color?: boolean;
|
|
20075
|
+
}
|
|
20076
|
+
/**
|
|
20077
|
+
* widget-query
|
|
20078
|
+
* The query for a widget. This includes measures and dimensions to be
|
|
20079
|
+
* visualized.
|
|
18368
20080
|
*/
|
|
18369
|
-
export interface
|
|
18370
|
-
|
|
20081
|
+
export interface WidgetQuery {
|
|
20082
|
+
/**
|
|
20083
|
+
* The dimensions for the query, which are the categories to group or
|
|
20084
|
+
* segment the measures. Usually these are the X-axis values in a
|
|
20085
|
+
* visualization.
|
|
20086
|
+
*/
|
|
20087
|
+
dimensions?: string[];
|
|
20088
|
+
/**
|
|
20089
|
+
* Set of filters to apply on the widgets. These filters are applied
|
|
20090
|
+
* on top of the dashboard level filters.
|
|
20091
|
+
*/
|
|
20092
|
+
filters?: DashboardFilter[];
|
|
20093
|
+
/** Join paths to use for the query. */
|
|
20094
|
+
joins?: WidgetQueryJoins[];
|
|
20095
|
+
/**
|
|
20096
|
+
* The maximum number of records to return. This is used to limit the
|
|
20097
|
+
* amount of data returned by the query.
|
|
20098
|
+
* @format int32
|
|
20099
|
+
*/
|
|
20100
|
+
limit?: number;
|
|
20101
|
+
/**
|
|
20102
|
+
* The measures for the query, which are the numerical values to be
|
|
20103
|
+
* analyzed. Usually these are the Y-axis values in a visualization.
|
|
20104
|
+
*/
|
|
20105
|
+
measures?: string[];
|
|
20106
|
+
/**
|
|
20107
|
+
* The order in which the data should be returned. This is used to
|
|
20108
|
+
* sort the data returned by the query.
|
|
20109
|
+
*/
|
|
20110
|
+
order_by?: WidgetQueryOrderBy[];
|
|
18371
20111
|
}
|
|
18372
20112
|
/**
|
|
18373
|
-
*
|
|
18374
|
-
*
|
|
20113
|
+
* widget-query-joins
|
|
20114
|
+
* A list of possible joins for the data source. Follows foreign key
|
|
20115
|
+
* semantics.
|
|
18375
20116
|
*/
|
|
18376
|
-
export
|
|
20117
|
+
export interface WidgetQueryJoins {
|
|
20118
|
+
/** A list of joins. */
|
|
20119
|
+
path: string[];
|
|
20120
|
+
}
|
|
18377
20121
|
/**
|
|
18378
|
-
*
|
|
18379
|
-
* The
|
|
20122
|
+
* widget-query-order-by
|
|
20123
|
+
* The order in which the data should be returned. This is used to sort
|
|
20124
|
+
* the data returned by the query.
|
|
18380
20125
|
*/
|
|
18381
|
-
export interface
|
|
18382
|
-
/** The
|
|
18383
|
-
|
|
20126
|
+
export interface WidgetQueryOrderBy {
|
|
20127
|
+
/** The direction of the sort. */
|
|
20128
|
+
direction: WidgetQueryOrderByDirection;
|
|
20129
|
+
/**
|
|
20130
|
+
* The column to sort by.
|
|
20131
|
+
* @format text
|
|
20132
|
+
*/
|
|
20133
|
+
reference_name: string;
|
|
18384
20134
|
}
|
|
18385
|
-
/** The
|
|
18386
|
-
export declare enum
|
|
18387
|
-
|
|
18388
|
-
|
|
20135
|
+
/** The direction of the sort. */
|
|
20136
|
+
export declare enum WidgetQueryOrderByDirection {
|
|
20137
|
+
Ascending = "ascending",
|
|
20138
|
+
Descending = "descending"
|
|
18389
20139
|
}
|
|
20140
|
+
/** widget-summary */
|
|
20141
|
+
export type WidgetSummary = AtomBaseSummary & {
|
|
20142
|
+
/**
|
|
20143
|
+
* The title of the widget.
|
|
20144
|
+
* @format text
|
|
20145
|
+
*/
|
|
20146
|
+
title: string;
|
|
20147
|
+
};
|
|
18390
20148
|
/**
|
|
18391
|
-
*
|
|
18392
|
-
* The
|
|
20149
|
+
* widget-visualization
|
|
20150
|
+
* The visualization for a widget. This includes the type of visualization
|
|
20151
|
+
* and any configuration specific to that type.
|
|
18393
20152
|
*/
|
|
18394
|
-
export interface
|
|
18395
|
-
/** The
|
|
18396
|
-
|
|
18397
|
-
event_types?: WebhooksUpdateRequestEventTypes;
|
|
18398
|
-
headers?: WebhooksUpdateRequestHeaders;
|
|
20153
|
+
export interface WidgetVisualization {
|
|
20154
|
+
/** The type of the visualization, such as line, bar, pie, etc. */
|
|
20155
|
+
type: WidgetVisualizationType;
|
|
18399
20156
|
/**
|
|
18400
|
-
*
|
|
18401
|
-
*
|
|
18402
|
-
* @example "don:integration:dvrv-us-1:devo/example:webhook/webhook-id"
|
|
20157
|
+
* A bar chart visualization configuration. Includes metadata specific to
|
|
20158
|
+
* bar charts.
|
|
18403
20159
|
*/
|
|
18404
|
-
|
|
20160
|
+
bar?: BarWidgetVisualization;
|
|
18405
20161
|
/**
|
|
18406
|
-
*
|
|
18407
|
-
*
|
|
18408
|
-
* if empty, then a new secret is generated. If the webhook is active,
|
|
18409
|
-
* then its status will transition to the 'unverified' state and it
|
|
18410
|
-
* won't receive any object events until successfully verified.
|
|
18411
|
-
* @format byte
|
|
20162
|
+
* A column chart visualization configuration. Includes metadata specific
|
|
20163
|
+
* to column charts.
|
|
18412
20164
|
*/
|
|
18413
|
-
|
|
20165
|
+
column?: ColumnWidgetVisualization;
|
|
18414
20166
|
/**
|
|
18415
|
-
*
|
|
18416
|
-
*
|
|
18417
|
-
* won't receive any object events until successfully verified.
|
|
18418
|
-
* @format text
|
|
20167
|
+
* A donut chart visualization configuration. Includes metadata specific
|
|
20168
|
+
* to donut charts.
|
|
18419
20169
|
*/
|
|
18420
|
-
|
|
18421
|
-
}
|
|
18422
|
-
/** webhooks-update-request-event-types */
|
|
18423
|
-
export interface WebhooksUpdateRequestEventTypes {
|
|
20170
|
+
donut?: DonutWidgetVisualization;
|
|
18424
20171
|
/**
|
|
18425
|
-
*
|
|
18426
|
-
*
|
|
18427
|
-
* with 'set'.
|
|
20172
|
+
* A heatmap chart visualization configuration. Includes metadata specific
|
|
20173
|
+
* to heatmap charts.
|
|
18428
20174
|
*/
|
|
18429
|
-
|
|
20175
|
+
heatmap?: HeatmapWidgetVisualization;
|
|
18430
20176
|
/**
|
|
18431
|
-
*
|
|
18432
|
-
*
|
|
18433
|
-
* with 'set'.
|
|
20177
|
+
* A kanban visualization configuration. Includes metadata specific to
|
|
20178
|
+
* kanban.
|
|
18434
20179
|
*/
|
|
18435
|
-
|
|
20180
|
+
kanban?: KanbanWidgetVisualization;
|
|
18436
20181
|
/**
|
|
18437
|
-
*
|
|
18438
|
-
*
|
|
18439
|
-
* 'remove'.
|
|
20182
|
+
* A line chart visualization configuration. Includes metadata specific to
|
|
20183
|
+
* line charts.
|
|
18440
20184
|
*/
|
|
18441
|
-
|
|
18442
|
-
}
|
|
18443
|
-
/** webhooks-update-request-headers */
|
|
18444
|
-
export interface WebhooksUpdateRequestHeaders {
|
|
20185
|
+
line?: LineWidgetVisualization;
|
|
18445
20186
|
/**
|
|
18446
|
-
*
|
|
18447
|
-
*
|
|
18448
|
-
* @maxItems 8
|
|
20187
|
+
* A metric visualization configuration. Includes metadata specific to
|
|
20188
|
+
* metrics.
|
|
18449
20189
|
*/
|
|
18450
|
-
|
|
20190
|
+
metric?: MetricWidgetVisualization;
|
|
18451
20191
|
/**
|
|
18452
|
-
*
|
|
18453
|
-
*
|
|
18454
|
-
* ignored.
|
|
18455
|
-
* @maxItems 8
|
|
20192
|
+
* A Packed Bubble chart visualization configuration. Includes metadata
|
|
20193
|
+
* specific to packed bubble charts.
|
|
18456
20194
|
*/
|
|
18457
|
-
|
|
20195
|
+
packed_bubble?: PackedBubbleWidgetVisualization;
|
|
18458
20196
|
/**
|
|
18459
|
-
*
|
|
18460
|
-
*
|
|
20197
|
+
* A pie chart visualization configuration. Includes metadata specific to
|
|
20198
|
+
* pie charts.
|
|
18461
20199
|
*/
|
|
18462
|
-
|
|
20200
|
+
pie?: PieWidgetVisualization;
|
|
20201
|
+
/** The configuration for a rich text visualization. */
|
|
20202
|
+
rich_text?: RichTextWidgetVisualization;
|
|
20203
|
+
/**
|
|
20204
|
+
* A Scatter chart visualization configuration. Includes metadata specific
|
|
20205
|
+
* to scatter charts.
|
|
20206
|
+
*/
|
|
20207
|
+
scatter?: ScatterWidgetVisualization;
|
|
20208
|
+
/**
|
|
20209
|
+
* A table visualization configuration. Includes metadata specific to
|
|
20210
|
+
* tables.
|
|
20211
|
+
*/
|
|
20212
|
+
table?: TableWidgetVisualization;
|
|
20213
|
+
}
|
|
20214
|
+
/** The type of the visualization, such as line, bar, pie, etc. */
|
|
20215
|
+
export declare enum WidgetVisualizationType {
|
|
20216
|
+
Bar = "bar",
|
|
20217
|
+
Column = "column",
|
|
20218
|
+
Combination = "combination",
|
|
20219
|
+
Donut = "donut",
|
|
20220
|
+
Heatmap = "heatmap",
|
|
20221
|
+
Kanban = "kanban",
|
|
20222
|
+
Line = "line",
|
|
20223
|
+
Metric = "metric",
|
|
20224
|
+
PackedBubble = "packed_bubble",
|
|
20225
|
+
Pie = "pie",
|
|
20226
|
+
RichText = "rich_text",
|
|
20227
|
+
Scatter = "scatter",
|
|
20228
|
+
Table = "table"
|
|
18463
20229
|
}
|
|
18464
20230
|
/**
|
|
18465
|
-
*
|
|
18466
|
-
* The
|
|
20231
|
+
* widgets-get-request
|
|
20232
|
+
* The request to get a widget.
|
|
18467
20233
|
*/
|
|
18468
|
-
export interface
|
|
18469
|
-
|
|
20234
|
+
export interface WidgetsGetRequest {
|
|
20235
|
+
/**
|
|
20236
|
+
* The requested widget's ID.
|
|
20237
|
+
* @format text
|
|
20238
|
+
*/
|
|
20239
|
+
id: string;
|
|
18470
20240
|
}
|
|
18471
20241
|
/**
|
|
18472
|
-
*
|
|
18473
|
-
* The
|
|
20242
|
+
* widgets-get-response
|
|
20243
|
+
* The response to a widget get request.
|
|
18474
20244
|
*/
|
|
18475
|
-
export
|
|
18476
|
-
|
|
18477
|
-
|
|
18478
|
-
/** widget-summary */
|
|
18479
|
-
export type WidgetSummary = AtomBaseSummary;
|
|
20245
|
+
export interface WidgetsGetResponse {
|
|
20246
|
+
widget: Widget;
|
|
20247
|
+
}
|
|
18480
20248
|
/** work */
|
|
18481
20249
|
export type Work = (Issue | Opportunity | Task | Ticket) & {
|
|
18482
20250
|
type: WorkType;
|
|
@@ -19585,8 +21353,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19585
21353
|
sort_by?: string[];
|
|
19586
21354
|
/** Filters for accounts on specified stages. */
|
|
19587
21355
|
stage?: string[];
|
|
21356
|
+
/** Subtypes of the accounts to be filtered. */
|
|
21357
|
+
subtype?: string[];
|
|
19588
21358
|
/** List of tags to be filtered. */
|
|
19589
21359
|
tags?: string[];
|
|
21360
|
+
/** Tier of the accounts to be filtered. */
|
|
21361
|
+
tier?: string[];
|
|
19590
21362
|
/** Array of websites of accounts to be filtered. */
|
|
19591
21363
|
websites?: string[];
|
|
19592
21364
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
|
|
@@ -19696,8 +21468,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19696
21468
|
sort_by?: string[];
|
|
19697
21469
|
/** Filters for accounts on specified stages. */
|
|
19698
21470
|
stage?: string[];
|
|
21471
|
+
/** Subtypes of the accounts to be filtered. */
|
|
21472
|
+
subtype?: string[];
|
|
19699
21473
|
/** List of tags to be filtered. */
|
|
19700
21474
|
tags?: string[];
|
|
21475
|
+
/** Tier of the accounts to be filtered. */
|
|
21476
|
+
tier?: string[];
|
|
19701
21477
|
/** Array of websites of accounts to be filtered. */
|
|
19702
21478
|
websites?: string[];
|
|
19703
21479
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
@@ -20131,6 +21907,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
20131
21907
|
* @secure
|
|
20132
21908
|
*/
|
|
20133
21909
|
artifactsPrepare: (data: ArtifactsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsPrepareResponse, any>>;
|
|
21910
|
+
/**
|
|
21911
|
+
* @description Permanently deletes a version of an artifact.
|
|
21912
|
+
*
|
|
21913
|
+
* @tags artifacts
|
|
21914
|
+
* @name ArtifactsHardDeleteVersion
|
|
21915
|
+
* @summary Delete Artifacts Version
|
|
21916
|
+
* @request POST:/artifacts.versions.delete
|
|
21917
|
+
* @secure
|
|
21918
|
+
*/
|
|
21919
|
+
artifactsHardDeleteVersion: (data: ArtifactsHardDeleteVersionRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
20134
21920
|
/**
|
|
20135
21921
|
* @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file.
|
|
20136
21922
|
*
|
|
@@ -20302,6 +22088,89 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
20302
22088
|
* @secure
|
|
20303
22089
|
*/
|
|
20304
22090
|
authTokensUpdate: (data: AuthTokensUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensUpdateResponse, any>>;
|
|
22091
|
+
/**
|
|
22092
|
+
* @description Creates a new brand.
|
|
22093
|
+
*
|
|
22094
|
+
* @tags brands
|
|
22095
|
+
* @name BrandsCreate
|
|
22096
|
+
* @summary Create Brand
|
|
22097
|
+
* @request POST:/brands.create
|
|
22098
|
+
* @secure
|
|
22099
|
+
*/
|
|
22100
|
+
brandsCreate: (data: BrandsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<BrandsCreateResponse, any>>;
|
|
22101
|
+
/**
|
|
22102
|
+
* @description Deletes a brand by its ID.
|
|
22103
|
+
*
|
|
22104
|
+
* @tags brands
|
|
22105
|
+
* @name BrandsDelete
|
|
22106
|
+
* @summary Delete Brand
|
|
22107
|
+
* @request POST:/brands.delete
|
|
22108
|
+
* @secure
|
|
22109
|
+
*/
|
|
22110
|
+
brandsDelete: (data: BrandsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
22111
|
+
/**
|
|
22112
|
+
* @description Gets a brand by its ID.
|
|
22113
|
+
*
|
|
22114
|
+
* @tags brands
|
|
22115
|
+
* @name BrandsGet
|
|
22116
|
+
* @summary Get Brand
|
|
22117
|
+
* @request GET:/brands.get
|
|
22118
|
+
* @secure
|
|
22119
|
+
*/
|
|
22120
|
+
brandsGet: (query: {
|
|
22121
|
+
/**
|
|
22122
|
+
* The ID of the brand to be retrieved.
|
|
22123
|
+
* @format id
|
|
22124
|
+
*/
|
|
22125
|
+
id: string;
|
|
22126
|
+
}, params?: RequestParams) => Promise<AxiosResponse<BrandsGetResponse, any>>;
|
|
22127
|
+
/**
|
|
22128
|
+
* @description Gets a brand by its ID.
|
|
22129
|
+
*
|
|
22130
|
+
* @tags brands
|
|
22131
|
+
* @name BrandsGetPost
|
|
22132
|
+
* @summary Get Brand (POST)
|
|
22133
|
+
* @request POST:/brands.get
|
|
22134
|
+
* @secure
|
|
22135
|
+
*/
|
|
22136
|
+
brandsGetPost: (data: BrandsGetRequest, params?: RequestParams) => Promise<AxiosResponse<BrandsGetResponse, any>>;
|
|
22137
|
+
/**
|
|
22138
|
+
* @description Lists all brands.
|
|
22139
|
+
*
|
|
22140
|
+
* @tags brands
|
|
22141
|
+
* @name BrandsList
|
|
22142
|
+
* @summary List Brands
|
|
22143
|
+
* @request GET:/brands.list
|
|
22144
|
+
* @secure
|
|
22145
|
+
*/
|
|
22146
|
+
brandsList: (query?: {
|
|
22147
|
+
/**
|
|
22148
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
22149
|
+
* starts from the beginning.
|
|
22150
|
+
* @format text
|
|
22151
|
+
*/
|
|
22152
|
+
cursor?: string;
|
|
22153
|
+
}, params?: RequestParams) => Promise<AxiosResponse<BrandsListResponse, any>>;
|
|
22154
|
+
/**
|
|
22155
|
+
* @description Lists all brands.
|
|
22156
|
+
*
|
|
22157
|
+
* @tags brands
|
|
22158
|
+
* @name BrandsListPost
|
|
22159
|
+
* @summary List Brands (POST)
|
|
22160
|
+
* @request POST:/brands.list
|
|
22161
|
+
* @secure
|
|
22162
|
+
*/
|
|
22163
|
+
brandsListPost: (data: BrandsListRequest, params?: RequestParams) => Promise<AxiosResponse<BrandsListResponse, any>>;
|
|
22164
|
+
/**
|
|
22165
|
+
* @description Updates a brand by its ID.
|
|
22166
|
+
*
|
|
22167
|
+
* @tags brands
|
|
22168
|
+
* @name BrandsUpdate
|
|
22169
|
+
* @summary Update Brand
|
|
22170
|
+
* @request POST:/brands.update
|
|
22171
|
+
* @secure
|
|
22172
|
+
*/
|
|
22173
|
+
brandsUpdate: (data: BrandsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<BrandsUpdateResponse, any>>;
|
|
20305
22174
|
/**
|
|
20306
22175
|
* @description Creates a new chat, or optionally opens an existing one.
|
|
20307
22176
|
*
|
|
@@ -20721,6 +22590,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
20721
22590
|
source_channels?: string[];
|
|
20722
22591
|
/** Filters for records in the provided stage(s) by name. */
|
|
20723
22592
|
'stage.name'?: string[];
|
|
22593
|
+
/** Filters for conversations with any of the provided states. */
|
|
22594
|
+
state?: string[];
|
|
20724
22595
|
/** Filters for conversation with any of the provided subtypes. */
|
|
20725
22596
|
subtype?: string[];
|
|
20726
22597
|
/**
|
|
@@ -20871,6 +22742,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
20871
22742
|
source_channels?: string[];
|
|
20872
22743
|
/** Filters for records in the provided stage(s) by name. */
|
|
20873
22744
|
'stage.name'?: string[];
|
|
22745
|
+
/** Filters for conversations with any of the provided states. */
|
|
22746
|
+
state?: string[];
|
|
20874
22747
|
/** Filters for conversation with any of the provided subtypes. */
|
|
20875
22748
|
subtype?: string[];
|
|
20876
22749
|
/**
|
|
@@ -21699,6 +23572,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21699
23572
|
* @secure
|
|
21700
23573
|
*/
|
|
21701
23574
|
groupsList: (query?: {
|
|
23575
|
+
/** Filters the groups on the basis of creator. */
|
|
23576
|
+
created_by?: string[];
|
|
21702
23577
|
/**
|
|
21703
23578
|
* The cursor to resume iteration from. If not provided, then iteration
|
|
21704
23579
|
* starts from the beginning.
|
|
@@ -21723,8 +23598,26 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21723
23598
|
* used.
|
|
21724
23599
|
*/
|
|
21725
23600
|
mode?: ListMode;
|
|
23601
|
+
/** Filters the groups on the basis of group name. */
|
|
23602
|
+
name?: string[];
|
|
21726
23603
|
/** Comma-separated fields to sort the groups by. */
|
|
21727
23604
|
sort_by?: string[];
|
|
23605
|
+
/** Filters for issues with this specific external reference. */
|
|
23606
|
+
'sync_metadata.external_reference'?: string[];
|
|
23607
|
+
/** Filters for works with selected sync statuses. */
|
|
23608
|
+
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
23609
|
+
/** Filters for works modified with selected sync history. */
|
|
23610
|
+
'sync_metadata.last_sync_in.sync_history'?: string[];
|
|
23611
|
+
/** Filters for works modified with selected sync units. */
|
|
23612
|
+
'sync_metadata.last_sync_in.sync_unit'?: string[];
|
|
23613
|
+
/** Filters for works with selected sync statuses. */
|
|
23614
|
+
'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
23615
|
+
/** Filters for works modified with selected sync history. */
|
|
23616
|
+
'sync_metadata.last_sync_out.sync_history'?: string[];
|
|
23617
|
+
/** Filters for works modified with selected sync units. */
|
|
23618
|
+
'sync_metadata.last_sync_out.sync_unit'?: string[];
|
|
23619
|
+
/** Filters for issues synced from this specific origin system. */
|
|
23620
|
+
'sync_metadata.origin_system'?: string[];
|
|
21728
23621
|
}, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any>>;
|
|
21729
23622
|
/**
|
|
21730
23623
|
* @description Lists the available groups.
|
|
@@ -21940,10 +23833,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21940
23833
|
'sync_metadata.external_reference'?: string[];
|
|
21941
23834
|
/** Filters for works with selected sync statuses. */
|
|
21942
23835
|
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
23836
|
+
/** Filters for works modified with selected sync history. */
|
|
23837
|
+
'sync_metadata.last_sync_in.sync_history'?: string[];
|
|
21943
23838
|
/** Filters for works modified with selected sync units. */
|
|
21944
23839
|
'sync_metadata.last_sync_in.sync_unit'?: string[];
|
|
21945
23840
|
/** Filters for works with selected sync statuses. */
|
|
21946
23841
|
'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
23842
|
+
/** Filters for works modified with selected sync history. */
|
|
23843
|
+
'sync_metadata.last_sync_out.sync_history'?: string[];
|
|
21947
23844
|
/** Filters for works modified with selected sync units. */
|
|
21948
23845
|
'sync_metadata.last_sync_out.sync_unit'?: string[];
|
|
21949
23846
|
/** Filters for issues synced from this specific origin system. */
|
|
@@ -22034,10 +23931,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22034
23931
|
'sync_metadata.external_reference'?: string[];
|
|
22035
23932
|
/** Filters for works with selected sync statuses. */
|
|
22036
23933
|
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
23934
|
+
/** Filters for works modified with selected sync history. */
|
|
23935
|
+
'sync_metadata.last_sync_in.sync_history'?: string[];
|
|
22037
23936
|
/** Filters for works modified with selected sync units. */
|
|
22038
23937
|
'sync_metadata.last_sync_in.sync_unit'?: string[];
|
|
22039
23938
|
/** Filters for works with selected sync statuses. */
|
|
22040
23939
|
'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
23940
|
+
/** Filters for works modified with selected sync history. */
|
|
23941
|
+
'sync_metadata.last_sync_out.sync_history'?: string[];
|
|
22041
23942
|
/** Filters for works modified with selected sync units. */
|
|
22042
23943
|
'sync_metadata.last_sync_out.sync_unit'?: string[];
|
|
22043
23944
|
/** Filters for issues synced from this specific origin system. */
|
|
@@ -22328,6 +24229,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22328
24229
|
* @secure
|
|
22329
24230
|
*/
|
|
22330
24231
|
linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
|
|
24232
|
+
/**
|
|
24233
|
+
* @description Replaces a link.
|
|
24234
|
+
*
|
|
24235
|
+
* @tags links
|
|
24236
|
+
* @name LinksReplace
|
|
24237
|
+
* @summary Replace Links
|
|
24238
|
+
* @request POST:/links.replace
|
|
24239
|
+
* @secure
|
|
24240
|
+
*/
|
|
24241
|
+
linksReplace: (data: LinksReplaceRequest, params?: RequestParams) => Promise<AxiosResponse<LinksReplaceResponse, any>>;
|
|
22331
24242
|
/**
|
|
22332
24243
|
* @description Counts the meeting records.
|
|
22333
24244
|
*
|
|
@@ -22641,6 +24552,37 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22641
24552
|
* @secure
|
|
22642
24553
|
*/
|
|
22643
24554
|
metricDefinitionsUpdate: (data: MetricDefinitionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsUpdateResponse, any>>;
|
|
24555
|
+
/**
|
|
24556
|
+
* @description Gets a metric tracker.
|
|
24557
|
+
*
|
|
24558
|
+
* @tags slas
|
|
24559
|
+
* @name MetricTrackersGet
|
|
24560
|
+
* @summary Get Metric Tracker
|
|
24561
|
+
* @request GET:/metric-trackers.get
|
|
24562
|
+
* @secure
|
|
24563
|
+
*/
|
|
24564
|
+
metricTrackersGet: (query: {
|
|
24565
|
+
/**
|
|
24566
|
+
* The ID of the metric that is being tracked.
|
|
24567
|
+
* @format id
|
|
24568
|
+
*/
|
|
24569
|
+
metric: string;
|
|
24570
|
+
/**
|
|
24571
|
+
* The ID of the underlying object on which the metric is being tracked.
|
|
24572
|
+
* @format id
|
|
24573
|
+
*/
|
|
24574
|
+
object: string;
|
|
24575
|
+
}, params?: RequestParams) => Promise<AxiosResponse<MetricTrackersGetResponse, any>>;
|
|
24576
|
+
/**
|
|
24577
|
+
* @description Gets a metric tracker.
|
|
24578
|
+
*
|
|
24579
|
+
* @tags slas
|
|
24580
|
+
* @name MetricTrackersGetPost
|
|
24581
|
+
* @summary Get Metric Tracker (POST)
|
|
24582
|
+
* @request POST:/metric-trackers.get
|
|
24583
|
+
* @secure
|
|
24584
|
+
*/
|
|
24585
|
+
metricTrackersGetPost: (data: MetricTrackersGetRequest, params?: RequestParams) => Promise<AxiosResponse<MetricTrackersGetResponse, any>>;
|
|
22644
24586
|
/**
|
|
22645
24587
|
* @description Ingest endpoint for DevRev metrics data from clients.
|
|
22646
24588
|
*
|
|
@@ -23064,6 +25006,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23064
25006
|
object: string;
|
|
23065
25007
|
/** Type of the preference object to be fetched. */
|
|
23066
25008
|
type: PreferencesType;
|
|
25009
|
+
/**
|
|
25010
|
+
* Language code for which to get the preferences for.
|
|
25011
|
+
* @format text
|
|
25012
|
+
*/
|
|
25013
|
+
language_code?: string;
|
|
23067
25014
|
}, params?: RequestParams) => Promise<AxiosResponse<PreferencesGetResponse, any>>;
|
|
23068
25015
|
/**
|
|
23069
25016
|
* @description Get the preferences object.
|
|
@@ -23274,6 +25221,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23274
25221
|
* @secure
|
|
23275
25222
|
*/
|
|
23276
25223
|
getReply: (data: GetReplyRequest, params?: RequestParams) => Promise<AxiosResponse<GetReplyResponse, any>>;
|
|
25224
|
+
/**
|
|
25225
|
+
* @description Gets a record template object.
|
|
25226
|
+
*
|
|
25227
|
+
* @tags record-templates
|
|
25228
|
+
* @name RecordTemplateGet
|
|
25229
|
+
* @summary Get Record Template
|
|
25230
|
+
* @request GET:/record-templates.get
|
|
25231
|
+
* @secure
|
|
25232
|
+
*/
|
|
25233
|
+
recordTemplateGet: (query: {
|
|
25234
|
+
/**
|
|
25235
|
+
* The ID of the record template.
|
|
25236
|
+
* @format id
|
|
25237
|
+
*/
|
|
25238
|
+
id: string;
|
|
25239
|
+
}, params?: RequestParams) => Promise<AxiosResponse<RecordTemplateGetResponse, any>>;
|
|
25240
|
+
/**
|
|
25241
|
+
* @description Gets a record template object.
|
|
25242
|
+
*
|
|
25243
|
+
* @tags record-templates
|
|
25244
|
+
* @name RecordTemplateGetPost
|
|
25245
|
+
* @summary Get Record Template (POST)
|
|
25246
|
+
* @request POST:/record-templates.get
|
|
25247
|
+
* @secure
|
|
25248
|
+
*/
|
|
25249
|
+
recordTemplateGetPost: (data: RecordTemplateGetRequest, params?: RequestParams) => Promise<AxiosResponse<RecordTemplateGetResponse, any>>;
|
|
23277
25250
|
/**
|
|
23278
25251
|
* @description Creates a Rev organization in the authenticated user's Dev organization.
|
|
23279
25252
|
*
|
|
@@ -24133,6 +26106,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24133
26106
|
* @secure
|
|
24134
26107
|
*/
|
|
24135
26108
|
searchHybridPost: (data: SearchHybridRequest, params?: RequestParams) => Promise<AxiosResponse<SearchHybridResponse, any>>;
|
|
26109
|
+
/**
|
|
26110
|
+
* @description Creates a service account.
|
|
26111
|
+
*
|
|
26112
|
+
* @tags service-accounts
|
|
26113
|
+
* @name ServiceAccountsCreate
|
|
26114
|
+
* @summary Create Service Account
|
|
26115
|
+
* @request POST:/service-accounts.create
|
|
26116
|
+
* @secure
|
|
26117
|
+
*/
|
|
26118
|
+
serviceAccountsCreate: (data: ServiceAccountsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsCreateResponse, any>>;
|
|
24136
26119
|
/**
|
|
24137
26120
|
* @description Gets a service account.
|
|
24138
26121
|
*
|
|
@@ -24708,6 +26691,55 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24708
26691
|
* @secure
|
|
24709
26692
|
*/
|
|
24710
26693
|
customStatesUpdate: (data: CustomStatesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesUpdateResponse, any>>;
|
|
26694
|
+
/**
|
|
26695
|
+
* @description Lists subscribers of an object.
|
|
26696
|
+
*
|
|
26697
|
+
* @tags subscribers
|
|
26698
|
+
* @name SubscribersList
|
|
26699
|
+
* @summary List Subscribers
|
|
26700
|
+
* @request GET:/subscribers.list
|
|
26701
|
+
* @secure
|
|
26702
|
+
*/
|
|
26703
|
+
subscribersList: (query: {
|
|
26704
|
+
/**
|
|
26705
|
+
* The object's ID.
|
|
26706
|
+
* @format id
|
|
26707
|
+
* @example "ISS-12345"
|
|
26708
|
+
*/
|
|
26709
|
+
id: string;
|
|
26710
|
+
/**
|
|
26711
|
+
* The cursor to resume iteration from, otherwise if not provided, then
|
|
26712
|
+
* iteration starts from the beginning.
|
|
26713
|
+
* @format text
|
|
26714
|
+
*/
|
|
26715
|
+
cursor?: string;
|
|
26716
|
+
/**
|
|
26717
|
+
* The maximum number of subscribers to return. If not set or `<= 0`,
|
|
26718
|
+
* then this defaults to `50`.
|
|
26719
|
+
* @format int32
|
|
26720
|
+
*/
|
|
26721
|
+
limit?: number;
|
|
26722
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SubscribersListResponse, any>>;
|
|
26723
|
+
/**
|
|
26724
|
+
* @description Lists subscribers of an object.
|
|
26725
|
+
*
|
|
26726
|
+
* @tags subscribers
|
|
26727
|
+
* @name SubscribersListPost
|
|
26728
|
+
* @summary List Subscribers (POST)
|
|
26729
|
+
* @request POST:/subscribers.list
|
|
26730
|
+
* @secure
|
|
26731
|
+
*/
|
|
26732
|
+
subscribersListPost: (data: SubscribersListRequest, params?: RequestParams) => Promise<AxiosResponse<SubscribersListResponse, any>>;
|
|
26733
|
+
/**
|
|
26734
|
+
* @description Updates subscribers on the object.
|
|
26735
|
+
*
|
|
26736
|
+
* @tags subscribers
|
|
26737
|
+
* @name SubscribersUpdate
|
|
26738
|
+
* @summary Update Subscriber
|
|
26739
|
+
* @request POST:/subscribers.update
|
|
26740
|
+
* @secure
|
|
26741
|
+
*/
|
|
26742
|
+
subscribersUpdate: (data: SubscribersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
24711
26743
|
/**
|
|
24712
26744
|
* @description Creates a schema for survey, which includes name and description of schema.
|
|
24713
26745
|
*
|
|
@@ -25512,6 +27544,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25512
27544
|
* @secure
|
|
25513
27545
|
*/
|
|
25514
27546
|
webhooksUpdate: (data: WebhooksUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksUpdateResponse, any>>;
|
|
27547
|
+
/**
|
|
27548
|
+
* @description Returns the requested widget.
|
|
27549
|
+
*
|
|
27550
|
+
* @tags widgets
|
|
27551
|
+
* @name WidgetsGet
|
|
27552
|
+
* @summary Get Widget
|
|
27553
|
+
* @request GET:/widgets.get
|
|
27554
|
+
* @secure
|
|
27555
|
+
*/
|
|
27556
|
+
widgetsGet: (query: {
|
|
27557
|
+
/**
|
|
27558
|
+
* The requested widget's ID.
|
|
27559
|
+
* @format text
|
|
27560
|
+
*/
|
|
27561
|
+
id: string;
|
|
27562
|
+
}, params?: RequestParams) => Promise<AxiosResponse<WidgetsGetResponse, any>>;
|
|
27563
|
+
/**
|
|
27564
|
+
* @description Returns the requested widget.
|
|
27565
|
+
*
|
|
27566
|
+
* @tags widgets
|
|
27567
|
+
* @name WidgetsGetPost
|
|
27568
|
+
* @summary Get Widget (POST)
|
|
27569
|
+
* @request POST:/widgets.get
|
|
27570
|
+
* @secure
|
|
27571
|
+
*/
|
|
27572
|
+
widgetsGetPost: (data: WidgetsGetRequest, params?: RequestParams) => Promise<AxiosResponse<WidgetsGetResponse, any>>;
|
|
25515
27573
|
/**
|
|
25516
27574
|
* @description Creates new work ([issue](https://devrev.ai/docs/product/build), [ticket](https://devrev.ai/docs/product/support)) item. [task](https://devrev.ai/docs/product/tasks) and opportunity work types are supported in the beta version.
|
|
25517
27575
|
*
|
|
@@ -25616,10 +27674,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25616
27674
|
'sync_metadata.external_reference'?: string[];
|
|
25617
27675
|
/** Filters for works with selected sync statuses. */
|
|
25618
27676
|
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
27677
|
+
/** Filters for works modified with selected sync history. */
|
|
27678
|
+
'sync_metadata.last_sync_in.sync_history'?: string[];
|
|
25619
27679
|
/** Filters for works modified with selected sync units. */
|
|
25620
27680
|
'sync_metadata.last_sync_in.sync_unit'?: string[];
|
|
25621
27681
|
/** Filters for works with selected sync statuses. */
|
|
25622
27682
|
'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
27683
|
+
/** Filters for works modified with selected sync history. */
|
|
27684
|
+
'sync_metadata.last_sync_out.sync_history'?: string[];
|
|
25623
27685
|
/** Filters for works modified with selected sync units. */
|
|
25624
27686
|
'sync_metadata.last_sync_out.sync_unit'?: string[];
|
|
25625
27687
|
/** Filters for issues synced from this specific origin system. */
|
|
@@ -25789,10 +27851,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25789
27851
|
'sync_metadata.external_reference'?: string[];
|
|
25790
27852
|
/** Filters for works with selected sync statuses. */
|
|
25791
27853
|
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
27854
|
+
/** Filters for works modified with selected sync history. */
|
|
27855
|
+
'sync_metadata.last_sync_in.sync_history'?: string[];
|
|
25792
27856
|
/** Filters for works modified with selected sync units. */
|
|
25793
27857
|
'sync_metadata.last_sync_in.sync_unit'?: string[];
|
|
25794
27858
|
/** Filters for works with selected sync statuses. */
|
|
25795
27859
|
'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
27860
|
+
/** Filters for works modified with selected sync history. */
|
|
27861
|
+
'sync_metadata.last_sync_out.sync_history'?: string[];
|
|
25796
27862
|
/** Filters for works modified with selected sync units. */
|
|
25797
27863
|
'sync_metadata.last_sync_out.sync_unit'?: string[];
|
|
25798
27864
|
/** Filters for issues synced from this specific origin system. */
|