@devrev/typescript-sdk 1.1.55 → 1.1.57

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: string[];
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. This must not be
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,6 +10188,10 @@ 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.
@@ -9621,6 +10333,36 @@ export interface LinksListResponse {
9621
10333
  */
9622
10334
  prev_cursor?: string;
9623
10335
  }
10336
+ /**
10337
+ * links-replace-request
10338
+ * The request to replace a link.
10339
+ */
10340
+ export interface LinksReplaceRequest {
10341
+ /**
10342
+ * The ID of the link to be replaced.
10343
+ * @format id
10344
+ */
10345
+ id: string;
10346
+ /** Type of link used to define the relationship. */
10347
+ link_type: LinkType;
10348
+ /**
10349
+ * The ID of the source object.
10350
+ * @format id
10351
+ */
10352
+ source: string;
10353
+ /**
10354
+ * The ID of the target object.
10355
+ * @format id
10356
+ */
10357
+ target: string;
10358
+ }
10359
+ /**
10360
+ * links-replace-response
10361
+ * The response to replacing a link.
10362
+ */
10363
+ export interface LinksReplaceResponse {
10364
+ link: Link;
10365
+ }
9624
10366
  /**
9625
10367
  * The iteration mode to use. If "after", then entries after the provided
9626
10368
  * cursor will be returned, or if no cursor is provided, then from the
@@ -9632,6 +10374,59 @@ export declare enum ListMode {
9632
10374
  After = "after",
9633
10375
  Before = "before"
9634
10376
  }
10377
+ /**
10378
+ * meerkat-widget-column-function
10379
+ * A meerkat specific column function.
10380
+ */
10381
+ export interface MeerkatWidgetColumnFunction {
10382
+ /** The type of the function. */
10383
+ type: MeerkatWidgetColumnFunctionType;
10384
+ }
10385
+ /** The type of the function. */
10386
+ export declare enum MeerkatWidgetColumnFunctionType {
10387
+ Avg = "avg",
10388
+ Count = "count",
10389
+ CountDistinct = "count_distinct",
10390
+ Max = "max",
10391
+ Median = "median",
10392
+ Min = "min",
10393
+ Sum = "sum"
10394
+ }
10395
+ /**
10396
+ * meerkat-widget-column-projection
10397
+ * A meerkat specific column projection.
10398
+ */
10399
+ export interface MeerkatWidgetColumnProjection {
10400
+ /** The data type of the column generated by the SQL expression. */
10401
+ type: MeerkatWidgetColumnProjectionType;
10402
+ /** A meerkat specific column function. */
10403
+ function?: MeerkatWidgetColumnFunction;
10404
+ /**
10405
+ * The SQL expression used to extract or transform the column from the
10406
+ * data source.
10407
+ * @format text
10408
+ */
10409
+ sql_expression: string;
10410
+ /** The rollup granularity for the timestamp. */
10411
+ timestamp_rollup?: MeerkatWidgetColumnProjectionTimestampRollup;
10412
+ }
10413
+ /** The rollup granularity for the timestamp. */
10414
+ export declare enum MeerkatWidgetColumnProjectionTimestampRollup {
10415
+ Day = "day",
10416
+ Hour = "hour",
10417
+ Month = "month",
10418
+ Week = "week",
10419
+ Year = "year"
10420
+ }
10421
+ /** The data type of the column generated by the SQL expression. */
10422
+ export declare enum MeerkatWidgetColumnProjectionType {
10423
+ Boolean = "boolean",
10424
+ Number = "number",
10425
+ NumberArray = "number_array",
10426
+ String = "string",
10427
+ StringArray = "string_array",
10428
+ Time = "time"
10429
+ }
9635
10430
  /** meeting */
9636
10431
  export type Meeting = AtomBase & {
9637
10432
  /** The artifacts attached to the meeting. */
@@ -9696,6 +10491,8 @@ export type Meeting = AtomBase & {
9696
10491
  * @format text
9697
10492
  */
9698
10493
  subtype?: string;
10494
+ /** Sync information for records synced into/from DevRev. */
10495
+ sync_metadata?: SyncMetadata;
9699
10496
  /** Tags associated with the meeting. */
9700
10497
  tags?: TagWithValue[];
9701
10498
  /**
@@ -9726,7 +10523,10 @@ export declare enum MeetingState {
9726
10523
  Waiting = "waiting"
9727
10524
  }
9728
10525
  /** meeting-summary */
9729
- export type MeetingSummary = AtomBaseSummary;
10526
+ export type MeetingSummary = AtomBaseSummary & {
10527
+ /** Sync information for records synced into/from DevRev. */
10528
+ sync_metadata?: SyncMetadataSummary;
10529
+ };
9730
10530
  /** meetings-count-request */
9731
10531
  export interface MeetingsCountRequest {
9732
10532
  /** Filters for meeting on specified channels. */
@@ -10343,6 +11143,65 @@ export interface MetricDefinitionsUpdateRequest {
10343
11143
  export interface MetricDefinitionsUpdateResponse {
10344
11144
  metric_definition: MetricDefinition;
10345
11145
  }
11146
+ /** metric-tracker */
11147
+ export interface MetricTracker {
11148
+ type: MetricTrackerType;
11149
+ }
11150
+ export type MetricTrackerType = string;
11151
+ /** metric-trackers-get-request */
11152
+ export interface MetricTrackersGetRequest {
11153
+ /**
11154
+ * The ID of the metric that is being tracked.
11155
+ * @format id
11156
+ */
11157
+ metric: string;
11158
+ /**
11159
+ * The ID of the underlying object on which the metric is being
11160
+ * tracked.
11161
+ * @format id
11162
+ */
11163
+ object: string;
11164
+ }
11165
+ /** metric-trackers-get-response */
11166
+ export interface MetricTrackersGetResponse {
11167
+ metric_tracker: MetricTracker;
11168
+ }
11169
+ /**
11170
+ * metric-visualization-y-axis
11171
+ * The y axis for a metric visualization.
11172
+ */
11173
+ export interface MetricVisualizationYAxis {
11174
+ /** The color for an axis. This can be a single color or a gradient. */
11175
+ color?: VisualizationAxisColor;
11176
+ /** The drill through configurations for the axis. */
11177
+ drill_throughs?: VisualizationAxisDrillThrough[];
11178
+ /** Whether the axis should be hidden. */
11179
+ is_hidden?: boolean;
11180
+ /**
11181
+ * The label for the axis.
11182
+ * @format text
11183
+ */
11184
+ label?: string;
11185
+ /**
11186
+ * The reference name of the axis.
11187
+ * @format text
11188
+ */
11189
+ reference_name: string;
11190
+ }
11191
+ /**
11192
+ * metric-widget-visualization
11193
+ * A metric visualization configuration. Includes metadata specific to
11194
+ * metrics.
11195
+ */
11196
+ export interface MetricWidgetVisualization {
11197
+ /**
11198
+ * Configuration settings for enabling and customizing PVP (past vs.
11199
+ * present) value in widgets.
11200
+ */
11201
+ pvp?: WidgetPvpConfig;
11202
+ /** The configuration for the Y-axis. */
11203
+ y: MetricVisualizationYAxis[];
11204
+ }
10346
11205
  /** metrics-data */
10347
11206
  export interface MetricsData {
10348
11207
  /**
@@ -10448,6 +11307,8 @@ export type Opportunity = WorkBase & {
10448
11307
  account?: AccountSummary;
10449
11308
  /** Money. */
10450
11309
  annual_contract_value?: Money;
11310
+ /** Contacts involved in the opportunity. */
11311
+ contacts?: UserSummary[];
10451
11312
  /** The properties of an enum value. */
10452
11313
  forecast_category_v2?: EnumValue;
10453
11314
  /** Money. */
@@ -10910,6 +11771,61 @@ export declare enum OrgType {
10910
11771
  DevOrg = "dev_org",
10911
11772
  RevOrg = "rev_org"
10912
11773
  }
11774
+ /**
11775
+ * packed-bubble-visualization-x-axis
11776
+ * The X-axis for a packed bubble visualization.
11777
+ */
11778
+ export interface PackedBubbleVisualizationXAxis {
11779
+ /** The color for an axis. This can be a single color or a gradient. */
11780
+ color?: VisualizationAxisColor;
11781
+ /** The drill through configurations for the axis. */
11782
+ drill_throughs?: VisualizationAxisDrillThrough[];
11783
+ /** Whether the axis should be hidden. */
11784
+ is_hidden?: boolean;
11785
+ /**
11786
+ * The label for the axis.
11787
+ * @format text
11788
+ */
11789
+ label?: string;
11790
+ /**
11791
+ * The reference name of the axis.
11792
+ * @format text
11793
+ */
11794
+ reference_name: string;
11795
+ }
11796
+ /**
11797
+ * packed-bubble-visualization-y-axis
11798
+ * The Y-axis for a packed bubble visualization.
11799
+ */
11800
+ export interface PackedBubbleVisualizationYAxis {
11801
+ /** The color for an axis. This can be a single color or a gradient. */
11802
+ color?: VisualizationAxisColor;
11803
+ /** The drill through configurations for the axis. */
11804
+ drill_throughs?: VisualizationAxisDrillThrough[];
11805
+ /** Whether the axis should be hidden. */
11806
+ is_hidden?: boolean;
11807
+ /**
11808
+ * The label for the axis.
11809
+ * @format text
11810
+ */
11811
+ label?: string;
11812
+ /**
11813
+ * The reference name of the axis.
11814
+ * @format text
11815
+ */
11816
+ reference_name: string;
11817
+ }
11818
+ /**
11819
+ * packed-bubble-widget-visualization
11820
+ * A Packed Bubble chart visualization configuration. Includes metadata
11821
+ * specific to packed bubble charts.
11822
+ */
11823
+ export interface PackedBubbleWidgetVisualization {
11824
+ /** The configuration for the X-axis. */
11825
+ x: PackedBubbleVisualizationXAxis[];
11826
+ /** The configuration for the Y-axes. */
11827
+ y: PackedBubbleVisualizationYAxis[];
11828
+ }
10913
11829
  /**
10914
11830
  * parent-part-filter
10915
11831
  * The filter for specifying parent part.
@@ -10929,7 +11845,7 @@ export interface ParentPartFilter {
10929
11845
  parts: string[];
10930
11846
  }
10931
11847
  /** part */
10932
- export type Part = (Capability | Enhancement | Feature | Product) & {
11848
+ export type Part = (Capability | Enhancement | Feature | Linkable | Product | Runnable) & {
10933
11849
  type: PartType;
10934
11850
  };
10935
11851
  /** part-base */
@@ -10993,14 +11909,16 @@ export type PartSearchSummary = SearchSummaryBase & {
10993
11909
  part: PartSummary;
10994
11910
  };
10995
11911
  /** part-summary */
10996
- export type PartSummary = (CapabilitySummary | EnhancementSummary | FeatureSummary | ProductSummary) & {
11912
+ export type PartSummary = (CapabilitySummary | EnhancementSummary | FeatureSummary | LinkableSummary | ProductSummary | RunnableSummary) & {
10997
11913
  type: PartType;
10998
11914
  };
10999
11915
  export declare enum PartType {
11000
11916
  Capability = "capability",
11001
11917
  Enhancement = "enhancement",
11002
11918
  Feature = "feature",
11003
- Product = "product"
11919
+ Linkable = "linkable",
11920
+ Product = "product",
11921
+ Runnable = "runnable"
11004
11922
  }
11005
11923
  /** parts-create-request */
11006
11924
  export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequestEnhancement | PartsCreateRequestFeature | PartsCreateRequestLinkable | PartsCreateRequestProduct | PartsCreateRequestRunnable) & {
@@ -11376,6 +12294,61 @@ export interface PartsUpdateRequestTags {
11376
12294
  export interface PartsUpdateResponse {
11377
12295
  part: Part;
11378
12296
  }
12297
+ /**
12298
+ * pie-visualization-x-axis
12299
+ * The X-axis for a pie visualization.
12300
+ */
12301
+ export interface PieVisualizationXAxis {
12302
+ /** The color for an axis. This can be a single color or a gradient. */
12303
+ color?: VisualizationAxisColor;
12304
+ /** The drill through configurations for the axis. */
12305
+ drill_throughs?: VisualizationAxisDrillThrough[];
12306
+ /** Whether the axis should be hidden. */
12307
+ is_hidden?: boolean;
12308
+ /**
12309
+ * The label for the axis.
12310
+ * @format text
12311
+ */
12312
+ label?: string;
12313
+ /**
12314
+ * The reference name of the axis.
12315
+ * @format text
12316
+ */
12317
+ reference_name: string;
12318
+ }
12319
+ /**
12320
+ * pie-visualization-y-axis
12321
+ * The Y-axis for a pie visualization.
12322
+ */
12323
+ export interface PieVisualizationYAxis {
12324
+ /** The color for an axis. This can be a single color or a gradient. */
12325
+ color?: VisualizationAxisColor;
12326
+ /** The drill through configurations for the axis. */
12327
+ drill_throughs?: VisualizationAxisDrillThrough[];
12328
+ /** Whether the axis should be hidden. */
12329
+ is_hidden?: boolean;
12330
+ /**
12331
+ * The label for the axis.
12332
+ * @format text
12333
+ */
12334
+ label?: string;
12335
+ /**
12336
+ * The reference name of the axis.
12337
+ * @format text
12338
+ */
12339
+ reference_name: string;
12340
+ }
12341
+ /**
12342
+ * pie-widget-visualization
12343
+ * A pie chart visualization configuration. Includes metadata specific to
12344
+ * pie charts.
12345
+ */
12346
+ export interface PieWidgetVisualization {
12347
+ /** The configuration for the X-axis. */
12348
+ x: PieVisualizationXAxis[];
12349
+ /** The Y-axis for a pie visualization. */
12350
+ y: PieVisualizationYAxis;
12351
+ }
11379
12352
  /** preferences */
11380
12353
  export type Preferences = UserPreferences & {
11381
12354
  type: PreferencesType;
@@ -11387,6 +12360,11 @@ export type PreferencesBaseSummary = AtomBaseSummary;
11387
12360
  /** preferences-get-request */
11388
12361
  export interface PreferencesGetRequest {
11389
12362
  type: PreferencesType;
12363
+ /**
12364
+ * Language code for which to get the preferences for.
12365
+ * @format text
12366
+ */
12367
+ language_code?: string;
11390
12368
  /**
11391
12369
  * The ID of the target object for which preferences object is to be
11392
12370
  * fetched.
@@ -11405,6 +12383,11 @@ export declare enum PreferencesType {
11405
12383
  /** preferences-update-request */
11406
12384
  export type PreferencesUpdateRequest = UpdateUserPreferences & {
11407
12385
  type: PreferencesType;
12386
+ /**
12387
+ * Language code for which to update the preferences for.
12388
+ * @format text
12389
+ */
12390
+ language_code?: string;
11408
12391
  /**
11409
12392
  * The ID of the object for which the preferences are to be updated.
11410
12393
  * @format id
@@ -12095,6 +13078,7 @@ export interface RevOrgsListResponse {
12095
13078
  export interface RevOrgsUpdateRequest {
12096
13079
  /**
12097
13080
  * New account ID to associate with this Rev organization.
13081
+ * @deprecated
12098
13082
  * @format id
12099
13083
  * @example "ACC-12345"
12100
13084
  */
@@ -12699,6 +13683,14 @@ export interface RevUsersUpdateRequestCustomSchemaFragments {
12699
13683
  export interface RevUsersUpdateResponse {
12700
13684
  rev_user: RevUser;
12701
13685
  }
13686
+ /**
13687
+ * rich-text-widget-visualization
13688
+ * The configuration for a rich text visualization.
13689
+ */
13690
+ export interface RichTextWidgetVisualization {
13691
+ /** The content of the rich text. */
13692
+ content?: object;
13693
+ }
12702
13694
  /** role */
12703
13695
  export type Role = AtomBase & {
12704
13696
  /** Sync information for records synced into/from DevRev. */
@@ -12794,6 +13786,10 @@ export interface RolesCreateRequest {
12794
13786
  export interface RolesCreateResponse {
12795
13787
  role: Role;
12796
13788
  }
13789
+ /** runnable */
13790
+ export type Runnable = PartBase;
13791
+ /** runnable-summary */
13792
+ export type RunnableSummary = PartBaseSummary;
12797
13793
  /** saml-connection-fields-map */
12798
13794
  export interface SamlConnectionFieldsMap {
12799
13795
  /**
@@ -12809,6 +13805,61 @@ export interface SamlConnectionFieldsMap {
12809
13805
  */
12810
13806
  user_id?: string;
12811
13807
  }
13808
+ /**
13809
+ * scatter-visualization-x-axis
13810
+ * The X-axis for a scatter visualization.
13811
+ */
13812
+ export interface ScatterVisualizationXAxis {
13813
+ /** The color for an axis. This can be a single color or a gradient. */
13814
+ color?: VisualizationAxisColor;
13815
+ /** The drill through configurations for the axis. */
13816
+ drill_throughs?: VisualizationAxisDrillThrough[];
13817
+ /** Whether the axis should be hidden. */
13818
+ is_hidden?: boolean;
13819
+ /**
13820
+ * The label for the axis.
13821
+ * @format text
13822
+ */
13823
+ label?: string;
13824
+ /**
13825
+ * The reference name of the axis.
13826
+ * @format text
13827
+ */
13828
+ reference_name: string;
13829
+ }
13830
+ /**
13831
+ * scatter-visualization-y-axis
13832
+ * The Y-axis for a scatter visualization.
13833
+ */
13834
+ export interface ScatterVisualizationYAxis {
13835
+ /** The color for an axis. This can be a single color or a gradient. */
13836
+ color?: VisualizationAxisColor;
13837
+ /** The drill through configurations for the axis. */
13838
+ drill_throughs?: VisualizationAxisDrillThrough[];
13839
+ /** Whether the axis should be hidden. */
13840
+ is_hidden?: boolean;
13841
+ /**
13842
+ * The label for the axis.
13843
+ * @format text
13844
+ */
13845
+ label?: string;
13846
+ /**
13847
+ * The reference name of the axis.
13848
+ * @format text
13849
+ */
13850
+ reference_name: string;
13851
+ }
13852
+ /**
13853
+ * scatter-widget-visualization
13854
+ * A Scatter chart visualization configuration. Includes metadata specific
13855
+ * to scatter charts.
13856
+ */
13857
+ export interface ScatterWidgetVisualization {
13858
+ /** The configuration for the X-axis. */
13859
+ x: ScatterVisualizationXAxis[];
13860
+ /** The configuration for the Y-axes. */
13861
+ y: ScatterVisualizationYAxis[];
13862
+ }
12812
13863
  /** schema-bool-field-descriptor */
12813
13864
  export type SchemaBoolFieldDescriptor = SchemaFieldDescriptorBase & {
12814
13865
  /** Default value. */
@@ -13859,6 +14910,31 @@ export declare enum SendNotificationType {
13859
14910
  export type ServiceAccount = UserBase;
13860
14911
  /** service-account-summary */
13861
14912
  export type ServiceAccountSummary = UserBaseSummary;
14913
+ /**
14914
+ * service-accounts-create-request
14915
+ * The request object to create a new service account.
14916
+ */
14917
+ export interface ServiceAccountsCreateRequest {
14918
+ /**
14919
+ * The service account's display name. A unique, human readable name
14920
+ * to identify a service account.
14921
+ * @format text
14922
+ */
14923
+ display_name: string;
14924
+ /**
14925
+ * Indicates whether to generate a keyring along with the new service
14926
+ * account. The default is false.
14927
+ */
14928
+ gen_keyring?: boolean;
14929
+ }
14930
+ /**
14931
+ * service-accounts-create-response
14932
+ * The response object to the corresponding create service account
14933
+ * request.
14934
+ */
14935
+ export interface ServiceAccountsCreateResponse {
14936
+ service_account: ServiceAccount;
14937
+ }
13862
14938
  /**
13863
14939
  * service-accounts-get-request
13864
14940
  * The request object to get a service account's information.
@@ -15131,10 +16207,33 @@ export interface StockSchemaFragmentsListResponse {
15131
16207
  /** The stock schema fragments. */
15132
16208
  result: StockSchemaFragment[];
15133
16209
  }
15134
- /** subtype */
15135
- export interface Subtype {
16210
+ /**
16211
+ * sub-widget
16212
+ * A sub-widget represents a data visualization unit contained within a
16213
+ * widget.
16214
+ */
16215
+ export interface SubWidget {
15136
16216
  /**
15137
- * Display name of the subtype.
16217
+ * The query for a widget. This includes measures and dimensions to be
16218
+ * visualized.
16219
+ */
16220
+ query?: WidgetQuery;
16221
+ /**
16222
+ * A reference ID for the sub-widget. It should be unique within the
16223
+ * widget.
16224
+ * @format text
16225
+ */
16226
+ reference_id: string;
16227
+ /**
16228
+ * The visualization for a widget. This includes the type of visualization
16229
+ * and any configuration specific to that type.
16230
+ */
16231
+ visualization: WidgetVisualization;
16232
+ }
16233
+ /** subtype */
16234
+ export interface Subtype {
16235
+ /**
16236
+ * Display name of the subtype.
15138
16237
  * @format text
15139
16238
  */
15140
16239
  display_name?: string;
@@ -15693,6 +16792,8 @@ export interface SyncMetadataFilterSyncInFilter {
15693
16792
  status?: SyncMetadataFilterSyncInFilterStatus[];
15694
16793
  /** Provides ways to specify date ranges on objects. */
15695
16794
  sync_date?: DateFilter;
16795
+ /** Filters for works modified with selected sync history. */
16796
+ sync_history?: string[];
15696
16797
  /** Filters for works modified with selected sync units. */
15697
16798
  sync_unit?: string[];
15698
16799
  }
@@ -15708,6 +16809,8 @@ export interface SyncMetadataFilterSyncOutFilter {
15708
16809
  status?: SyncMetadataFilterSyncOutFilterStatus[];
15709
16810
  /** Provides ways to specify date ranges on objects. */
15710
16811
  sync_date?: DateFilter;
16812
+ /** Filters for works modified with selected sync history. */
16813
+ sync_history?: string[];
15711
16814
  /** Filters for works modified with selected sync units. */
15712
16815
  sync_unit?: string[];
15713
16816
  }
@@ -15964,6 +17067,95 @@ export interface SysUsersUpdateRequest {
15964
17067
  export interface SysUsersUpdateResponse {
15965
17068
  sys_user: SysUser;
15966
17069
  }
17070
+ /**
17071
+ * table-visualization-column
17072
+ * A column in a table visualization.
17073
+ */
17074
+ export interface TableVisualizationColumn {
17075
+ /** The color for an axis. This can be a single color or a gradient. */
17076
+ color?: VisualizationAxisColor;
17077
+ /** The drill through configurations for the axis. */
17078
+ drill_throughs?: VisualizationAxisDrillThrough[];
17079
+ /** Whether the axis should be hidden. */
17080
+ is_hidden?: boolean;
17081
+ /** Whether the column should be movable. */
17082
+ is_movable?: boolean;
17083
+ /** Whether the column should be pinned, by default set to false. */
17084
+ is_pinned?: boolean;
17085
+ /** Whether the column should be resizable. */
17086
+ is_resizable?: boolean;
17087
+ /** Whether the column should be sortable. */
17088
+ is_sortable?: boolean;
17089
+ /** Whether the column visibility can be toggled. */
17090
+ is_visibility_togglable?: boolean;
17091
+ /**
17092
+ * The label for the axis.
17093
+ * @format text
17094
+ */
17095
+ label?: string;
17096
+ /**
17097
+ * Whether the column should be locked to the left or right side of the
17098
+ * table.
17099
+ */
17100
+ lock_position?: TableVisualizationColumnLockPosition;
17101
+ /**
17102
+ * The maximum width of the column.
17103
+ * @format int32
17104
+ */
17105
+ max_width?: number;
17106
+ /**
17107
+ * The minimum width of the column.
17108
+ * @format int32
17109
+ */
17110
+ min_width?: number;
17111
+ /**
17112
+ * The order in which the column should be displayed.
17113
+ * @format int32
17114
+ */
17115
+ order?: number;
17116
+ /**
17117
+ * Whether the column should be pinned to the left or right side of the
17118
+ * table.
17119
+ */
17120
+ pin_position?: TableVisualizationColumnPinPosition;
17121
+ /**
17122
+ * The reference name of the axis.
17123
+ * @format text
17124
+ */
17125
+ reference_name: string;
17126
+ /**
17127
+ * The width of the column in pixel.
17128
+ * @format int32
17129
+ */
17130
+ width?: number;
17131
+ }
17132
+ /**
17133
+ * Whether the column should be locked to the left or right side of the
17134
+ * table.
17135
+ */
17136
+ export declare enum TableVisualizationColumnLockPosition {
17137
+ Left = "left",
17138
+ Right = "right"
17139
+ }
17140
+ /**
17141
+ * Whether the column should be pinned to the left or right side of the
17142
+ * table.
17143
+ */
17144
+ export declare enum TableVisualizationColumnPinPosition {
17145
+ Left = "left",
17146
+ Right = "right"
17147
+ }
17148
+ /**
17149
+ * table-widget-visualization
17150
+ * A table visualization configuration. Includes metadata specific to
17151
+ * tables.
17152
+ */
17153
+ export interface TableWidgetVisualization {
17154
+ /** The configuration for the columns in the table. */
17155
+ columns: TableVisualizationColumn[];
17156
+ /** The group_by configuration in the table. */
17157
+ group_by?: WidgetGroupByConfig[];
17158
+ }
15967
17159
  /** tag */
15968
17160
  export type Tag = AtomBase & {
15969
17161
  /**
@@ -16742,11 +17934,13 @@ export declare enum TimelineEntryObjectType {
16742
17934
  Feature = "feature",
16743
17935
  Incident = "incident",
16744
17936
  Issue = "issue",
17937
+ Linkable = "linkable",
16745
17938
  Meeting = "meeting",
16746
17939
  Opportunity = "opportunity",
16747
17940
  Product = "product",
16748
17941
  RevOrg = "rev_org",
16749
17942
  RevUser = "rev_user",
17943
+ Runnable = "runnable",
16750
17944
  SnapIn = "snap_in",
16751
17945
  Task = "task",
16752
17946
  Ticket = "ticket",
@@ -17805,6 +18999,53 @@ export declare enum VistaType {
17805
18999
  Dynamic = "dynamic",
17806
19000
  Grouped = "grouped"
17807
19001
  }
19002
+ /**
19003
+ * visualization-axis-color
19004
+ * The color for an axis. This can be a single color or a gradient.
19005
+ */
19006
+ export interface VisualizationAxisColor {
19007
+ /** The type of the color. */
19008
+ type: VisualizationAxisColorType;
19009
+ /** The key lookup color. */
19010
+ key_lookup?: VisualizationAxisColorKeyLookup[];
19011
+ /**
19012
+ * The static color.
19013
+ * @format text
19014
+ */
19015
+ static?: string;
19016
+ }
19017
+ /**
19018
+ * visualization-axis-color-key-lookup
19019
+ * The key lookup color for an axis. This is used to map a value to a
19020
+ * color.
19021
+ */
19022
+ export interface VisualizationAxisColorKeyLookup {
19023
+ /**
19024
+ * The key to map to a color.
19025
+ * @format text
19026
+ */
19027
+ key: string;
19028
+ /**
19029
+ * The color value.
19030
+ * @format text
19031
+ */
19032
+ value: string;
19033
+ }
19034
+ /** The type of the color. */
19035
+ export declare enum VisualizationAxisColorType {
19036
+ KeyLookup = "key_lookup",
19037
+ Static = "static"
19038
+ }
19039
+ /**
19040
+ * visualization-axis-drill-through
19041
+ * The drill through configuration for an axis.
19042
+ */
19043
+ export type VisualizationAxisDrillThrough = object;
19044
+ /**
19045
+ * visualization-scrollbar
19046
+ * The scrollbar configuration for chart.
19047
+ */
19048
+ export type VisualizationScrollbar = object;
17808
19049
  /** web-crawler-job */
17809
19050
  export type WebCrawlerJob = AtomBase & {
17810
19051
  /**
@@ -18120,6 +19361,7 @@ export interface WebhookEventRequest {
18120
19361
  rev_user_updated?: EventRevUserUpdated;
18121
19362
  sla_tracker_created?: EventSlaTrackerCreated;
18122
19363
  sla_tracker_deleted?: EventSlaTrackerDeleted;
19364
+ sla_tracker_fetched?: EventSlaTrackerFetched;
18123
19365
  sla_tracker_updated?: EventSlaTrackerUpdated;
18124
19366
  survey_created?: EventSurveyCreated;
18125
19367
  survey_deleted?: EventSurveyDeleted;
@@ -18215,6 +19457,7 @@ export declare enum WebhookEventType {
18215
19457
  RevUserUpdated = "rev_user_updated",
18216
19458
  SlaTrackerCreated = "sla_tracker_created",
18217
19459
  SlaTrackerDeleted = "sla_tracker_deleted",
19460
+ SlaTrackerFetched = "sla_tracker_fetched",
18218
19461
  SlaTrackerUpdated = "sla_tracker_updated",
18219
19462
  SurveyCreated = "survey_created",
18220
19463
  SurveyDeleted = "survey_deleted",
@@ -18320,163 +19563,548 @@ export interface WebhooksDeleteRequest {
18320
19563
  * @format id
18321
19564
  * @example "don:integration:dvrv-us-1:devo/example:webhook/webhook-id"
18322
19565
  */
18323
- id: string;
19566
+ id: string;
19567
+ }
19568
+ /**
19569
+ * webhooks-delete-response
19570
+ * The response to deleting the webhook.
19571
+ */
19572
+ export type WebhooksDeleteResponse = object;
19573
+ /**
19574
+ * webhooks-fetch-request
19575
+ * The request to fetch an object for a webhook.
19576
+ */
19577
+ export interface WebhooksFetchRequest {
19578
+ /**
19579
+ * The ID of the webhook to fetch the object for.
19580
+ * @format id
19581
+ * @example "don:integration:dvrv-us-1:devo/example:webhook/webhook-id"
19582
+ */
19583
+ id: string;
19584
+ /**
19585
+ * The ID of the object to fetch for the webhook.
19586
+ * @format id
19587
+ * @example "ISS-12345"
19588
+ */
19589
+ object: string;
19590
+ }
19591
+ /**
19592
+ * webhooks-fetch-response
19593
+ * The response to fetching an object for a webhook.
19594
+ */
19595
+ export type WebhooksFetchResponse = object;
19596
+ /**
19597
+ * webhooks-get-request
19598
+ * The request to get a webhook's information.
19599
+ */
19600
+ export interface WebhooksGetRequest {
19601
+ /**
19602
+ * ID for the webhook.
19603
+ * @format id
19604
+ * @example "don:integration:dvrv-us-1:devo/example:webhook/webhook-id"
19605
+ */
19606
+ id: string;
19607
+ }
19608
+ /**
19609
+ * webhooks-get-response
19610
+ * The response to getting the information for the webhook.
19611
+ */
19612
+ export interface WebhooksGetResponse {
19613
+ webhook: Webhook;
19614
+ }
19615
+ /**
19616
+ * webhooks-list-request
19617
+ * The request to list the webhooks.
19618
+ */
19619
+ export type WebhooksListRequest = object;
19620
+ /**
19621
+ * webhooks-list-response
19622
+ * The response to listing the webhooks.
19623
+ */
19624
+ export interface WebhooksListResponse {
19625
+ /** The list of webhooks. */
19626
+ webhooks: Webhook[];
19627
+ }
19628
+ /** The action to update the webhook's status. */
19629
+ export declare enum WebhooksUpdateAction {
19630
+ Activate = "activate",
19631
+ Deactivate = "deactivate"
19632
+ }
19633
+ /**
19634
+ * webhooks-update-request
19635
+ * The request to update a webhook.
19636
+ */
19637
+ export interface WebhooksUpdateRequest {
19638
+ /** The action to update the webhook's status. */
19639
+ action?: WebhooksUpdateAction;
19640
+ event_types?: WebhooksUpdateRequestEventTypes;
19641
+ headers?: WebhooksUpdateRequestHeaders;
19642
+ /**
19643
+ * ID for the webhook.
19644
+ * @format id
19645
+ * @example "don:integration:dvrv-us-1:devo/example:webhook/webhook-id"
19646
+ */
19647
+ id: string;
19648
+ /**
19649
+ * If provided, updates the secret that's used when verifying webhook
19650
+ * events, which must be between 8 and 32 bytes (inclusive). Otherwise
19651
+ * if empty, then a new secret is generated. If the webhook is active,
19652
+ * then its status will transition to the 'unverified' state and it
19653
+ * won't receive any object events until successfully verified.
19654
+ * @format byte
19655
+ */
19656
+ secret?: string;
19657
+ /**
19658
+ * The webhook's updated URL. If the webhook is active, then the
19659
+ * webhook's status will transition to the 'unverified' state and it
19660
+ * won't receive any object events until successfully verified.
19661
+ * @format text
19662
+ */
19663
+ url?: string;
19664
+ }
19665
+ /** webhooks-update-request-event-types */
19666
+ export interface WebhooksUpdateRequestEventTypes {
19667
+ /**
19668
+ * The event types to add. If a provided event type is already set for
19669
+ * the webhook, then nothing is done. Note this is mutually exclusive
19670
+ * with 'set'.
19671
+ */
19672
+ add?: WebhookEventType[];
19673
+ /**
19674
+ * The event types to remove. If a provided event type isn't set for
19675
+ * the webhook, then nothing is done. Note this is mutually exclusive
19676
+ * with 'set'.
19677
+ */
19678
+ remove?: WebhookEventType[];
19679
+ /**
19680
+ * The updated event types, which will replace the webhook's current
19681
+ * event types. Note this is mutually exclusive with 'add' and
19682
+ * 'remove'.
19683
+ */
19684
+ set?: WebhookEventType[];
19685
+ }
19686
+ /** webhooks-update-request-headers */
19687
+ export interface WebhooksUpdateRequestHeaders {
19688
+ /**
19689
+ * The headers to be added to every webhook invocation. If a provided
19690
+ * header is already specified for the webhook, its value is replaced.
19691
+ * @maxItems 8
19692
+ */
19693
+ add?: WebhookHeader[];
19694
+ /**
19695
+ * The headers to be removed from every webhook invocation. If a
19696
+ * provided header is not specified for the webhook, then it's
19697
+ * ignored.
19698
+ * @maxItems 8
19699
+ */
19700
+ remove?: string[];
19701
+ /**
19702
+ * Sets the headers to include in every webhook invocation.
19703
+ * @maxItems 8
19704
+ */
19705
+ set?: WebhookHeader[];
19706
+ }
19707
+ /**
19708
+ * webhooks-update-response
19709
+ * The response to updating the webhook.
19710
+ */
19711
+ export interface WebhooksUpdateResponse {
19712
+ webhook: Webhook;
19713
+ }
19714
+ /**
19715
+ * weekly-org-schedule
19716
+ * The schedule for each week.
19717
+ */
19718
+ export type WeeklyOrgSchedule = object;
19719
+ /** widget */
19720
+ export type Widget = AtomBase & {
19721
+ /** Data sources provide the backing data tables for the widget. */
19722
+ data_sources?: WidgetDataSource[];
19723
+ /**
19724
+ * A brief summary of what the widget displays or represents.
19725
+ * @format text
19726
+ */
19727
+ description: string;
19728
+ /** Whether the widget is a draft widget. */
19729
+ is_draft?: boolean;
19730
+ /** Whether the widget is a system widget. */
19731
+ is_system?: boolean;
19732
+ /**
19733
+ * Layout of the widget. It determines the organization of the sub
19734
+ * widgets.
19735
+ */
19736
+ layout: GridLayout[];
19737
+ /**
19738
+ * A unique identifying name for the widget (optional).
19739
+ * @format text
19740
+ */
19741
+ name?: string;
19742
+ /**
19743
+ * A list of sub-widgets that the widget contains. Each widget can
19744
+ * contain multiple sub-widgets.
19745
+ */
19746
+ sub_widgets: SubWidget[];
19747
+ /**
19748
+ * The title of the widget.
19749
+ * @format text
19750
+ */
19751
+ title: string;
19752
+ };
19753
+ /**
19754
+ * widget-api-data-source
19755
+ * An API-backed data source.
19756
+ */
19757
+ export interface WidgetApiDataSource {
19758
+ /** Object IDs to include in the data source. */
19759
+ include?: WorkSummary[];
19760
+ /** Indicates if the leaf type is custom. */
19761
+ is_custom_leaf_type?: boolean;
19762
+ /**
19763
+ * The object's type.
19764
+ * @format text
19765
+ */
19766
+ leaf_type?: string;
19767
+ /** The subtypes of the object. */
19768
+ subtypes?: string[];
19769
+ }
19770
+ /**
19771
+ * widget-column-projection
19772
+ * A widget column projection.
19773
+ */
19774
+ export interface WidgetColumnProjection {
19775
+ /** The type of the column. */
19776
+ type?: WidgetColumnProjectionType;
19777
+ /** A custom field widget column projection. */
19778
+ custom_field?: CustomFieldWidgetColumnProjection;
19779
+ /** Set of field attributes. */
19780
+ devrev_schema: SchemaFieldDescriptor;
19781
+ /** Whether the column has a custom expression. */
19782
+ has_custom_expression?: boolean;
19783
+ /** Whether the column is derived. */
19784
+ is_derived?: boolean;
19785
+ /** A meerkat specific column projection. */
19786
+ meerkat_schema?: MeerkatWidgetColumnProjection;
19787
+ /**
19788
+ * The reference name of the column.
19789
+ * @format text
19790
+ */
19791
+ reference_name: string;
19792
+ }
19793
+ /** The type of the column. */
19794
+ export declare enum WidgetColumnProjectionType {
19795
+ CustomField = "custom_field",
19796
+ Native = "native"
19797
+ }
19798
+ /**
19799
+ * widget-data-source
19800
+ * A data source for a widget.
19801
+ */
19802
+ export interface WidgetDataSource {
19803
+ /** The type of the data source. */
19804
+ type: WidgetDataSourceType;
19805
+ /** An API-backed data source. */
19806
+ api?: WidgetApiDataSource;
19807
+ /**
19808
+ * The ID of the data source. Meant to be set when the type is
19809
+ * data_source.
19810
+ * @format text
19811
+ */
19812
+ data_source?: string;
19813
+ /**
19814
+ * The dimensions (or the extended dimensions) provided by the data
19815
+ * source. These are the categories that can be used to group or
19816
+ * segment the measures.
19817
+ */
19818
+ dimensions?: WidgetColumnProjection[];
19819
+ /** An referenced data source for a widget. */
19820
+ external_data_source?: WidgetDataSourceReference;
19821
+ /**
19822
+ * A list of possible joins for the data source. Follows foreign key
19823
+ * semantics.
19824
+ */
19825
+ joins?: DataSourceJoin[];
19826
+ /**
19827
+ * The measures (or the extended measures) provided by the data
19828
+ * source. These are the numerical values that can be analyzed.
19829
+ */
19830
+ measures?: WidgetColumnProjection[];
19831
+ /** An oasis backed data source. */
19832
+ oasis?: WidgetOasisDataSource;
19833
+ /**
19834
+ * The reference name of the data source.
19835
+ * @format text
19836
+ */
19837
+ reference_name: string;
19838
+ }
19839
+ /**
19840
+ * widget-data-source-reference
19841
+ * An referenced data source for a widget.
19842
+ */
19843
+ export interface WidgetDataSourceReference {
19844
+ /**
19845
+ * The column projections for the data source. These are the columns
19846
+ * that are projected from the datasets.
19847
+ */
19848
+ dataset_projections?: WidgetOasisDatasetColumnProjection[];
19849
+ /**
19850
+ * The id of the data source.
19851
+ * @format text
19852
+ */
19853
+ id: string;
19854
+ }
19855
+ /** The type of the data source. */
19856
+ export declare enum WidgetDataSourceType {
19857
+ Api = "api",
19858
+ DataSource = "data_source",
19859
+ DataView = "data_view",
19860
+ ExternalDataSource = "external_data_source",
19861
+ Oasis = "oasis"
19862
+ }
19863
+ /**
19864
+ * widget-group-by-config
19865
+ * The configuration for group_by operation.
19866
+ */
19867
+ export interface WidgetGroupByConfig {
19868
+ /**
19869
+ * The key on which group_by is applied.
19870
+ * @format text
19871
+ */
19872
+ key?: string;
19873
+ /**
19874
+ * The maximum number of unique values that can be returned for the
19875
+ * key.
19876
+ * @format int32
19877
+ */
19878
+ limit?: number;
18324
19879
  }
18325
19880
  /**
18326
- * webhooks-delete-response
18327
- * The response to deleting the webhook.
18328
- */
18329
- export type WebhooksDeleteResponse = object;
18330
- /**
18331
- * webhooks-fetch-request
18332
- * The request to fetch an object for a webhook.
19881
+ * widget-oasis-data-source
19882
+ * An oasis backed data source.
18333
19883
  */
18334
- export interface WebhooksFetchRequest {
19884
+ export interface WidgetOasisDataSource {
19885
+ /** List of datasets used by the data source. */
19886
+ datasets?: string[];
18335
19887
  /**
18336
- * The ID of the webhook to fetch the object for.
18337
- * @format id
18338
- * @example "don:integration:dvrv-us-1:devo/example:webhook/webhook-id"
19888
+ * The column projections for the data source. These are the columns
19889
+ * that are projected from the datasets.
18339
19890
  */
18340
- id: string;
19891
+ projections?: WidgetOasisDatasetColumnProjection[];
18341
19892
  /**
18342
- * The ID of the object to fetch for the webhook.
18343
- * @format id
18344
- * @example "ISS-12345"
19893
+ * The base SQL query that constructs the view for the data source.
19894
+ * The SQL can reference the datasets using their aliases.
19895
+ * @format text
18345
19896
  */
18346
- object: string;
19897
+ sql_query: string;
18347
19898
  }
18348
19899
  /**
18349
- * webhooks-fetch-response
18350
- * The response to fetching an object for a webhook.
19900
+ * widget-oasis-dataset-column
19901
+ * An oasis dataset column.
18351
19902
  */
18352
- export type WebhooksFetchResponse = object;
19903
+ export interface WidgetOasisDatasetColumn {
19904
+ /** A custom field widget column projection. */
19905
+ custom_field?: CustomFieldWidgetColumnProjection;
19906
+ /**
19907
+ * The name of the column.
19908
+ * @format text
19909
+ */
19910
+ name: string;
19911
+ }
18353
19912
  /**
18354
- * webhooks-get-request
18355
- * The request to get a webhook's information.
19913
+ * widget-oasis-dataset-column-projection
19914
+ * An oasis dataset column projection.
18356
19915
  */
18357
- export interface WebhooksGetRequest {
19916
+ export interface WidgetOasisDatasetColumnProjection {
19917
+ /** The column name. */
19918
+ columns: WidgetOasisDatasetColumn[];
18358
19919
  /**
18359
- * ID for the webhook.
18360
- * @format id
18361
- * @example "don:integration:dvrv-us-1:devo/example:webhook/webhook-id"
19920
+ * The dataset ID.
19921
+ * @format text
18362
19922
  */
18363
- id: string;
19923
+ dataset: string;
18364
19924
  }
18365
19925
  /**
18366
- * webhooks-get-response
18367
- * The response to getting the information for the webhook.
19926
+ * widget-pvp-config
19927
+ * Configuration settings for enabling and customizing PVP (past vs.
19928
+ * present) value in widgets.
18368
19929
  */
18369
- export interface WebhooksGetResponse {
18370
- webhook: Webhook;
19930
+ export interface WidgetPvpConfig {
19931
+ /** Indicates whether PVP is enabled. */
19932
+ enabled?: boolean;
19933
+ /** Specifies whether the color scheme for PVP is inverted. */
19934
+ invert_correlation_color?: boolean;
18371
19935
  }
18372
19936
  /**
18373
- * webhooks-list-request
18374
- * The request to list the webhooks.
19937
+ * widget-query
19938
+ * The query for a widget. This includes measures and dimensions to be
19939
+ * visualized.
18375
19940
  */
18376
- export type WebhooksListRequest = object;
19941
+ export interface WidgetQuery {
19942
+ /**
19943
+ * The dimensions for the query, which are the categories to group or
19944
+ * segment the measures. Usually these are the X-axis values in a
19945
+ * visualization.
19946
+ */
19947
+ dimensions?: string[];
19948
+ /**
19949
+ * Set of filters to apply on the widgets. These filters are applied
19950
+ * on top of the dashboard level filters.
19951
+ */
19952
+ filters?: DashboardFilter[];
19953
+ /** Join paths to use for the query. */
19954
+ joins?: WidgetQueryJoins[];
19955
+ /**
19956
+ * The maximum number of records to return. This is used to limit the
19957
+ * amount of data returned by the query.
19958
+ * @format int32
19959
+ */
19960
+ limit?: number;
19961
+ /**
19962
+ * The measures for the query, which are the numerical values to be
19963
+ * analyzed. Usually these are the Y-axis values in a visualization.
19964
+ */
19965
+ measures?: string[];
19966
+ /**
19967
+ * The order in which the data should be returned. This is used to
19968
+ * sort the data returned by the query.
19969
+ */
19970
+ order_by?: WidgetQueryOrderBy[];
19971
+ }
18377
19972
  /**
18378
- * webhooks-list-response
18379
- * The response to listing the webhooks.
19973
+ * widget-query-joins
19974
+ * A list of possible joins for the data source. Follows foreign key
19975
+ * semantics.
18380
19976
  */
18381
- export interface WebhooksListResponse {
18382
- /** The list of webhooks. */
18383
- webhooks: Webhook[];
19977
+ export interface WidgetQueryJoins {
19978
+ /** A list of joins. */
19979
+ path: string[];
18384
19980
  }
18385
- /** The action to update the webhook's status. */
18386
- export declare enum WebhooksUpdateAction {
18387
- Activate = "activate",
18388
- Deactivate = "deactivate"
19981
+ /**
19982
+ * widget-query-order-by
19983
+ * The order in which the data should be returned. This is used to sort
19984
+ * the data returned by the query.
19985
+ */
19986
+ export interface WidgetQueryOrderBy {
19987
+ /** The direction of the sort. */
19988
+ direction: WidgetQueryOrderByDirection;
19989
+ /**
19990
+ * The column to sort by.
19991
+ * @format text
19992
+ */
19993
+ reference_name: string;
18389
19994
  }
19995
+ /** The direction of the sort. */
19996
+ export declare enum WidgetQueryOrderByDirection {
19997
+ Ascending = "ascending",
19998
+ Descending = "descending"
19999
+ }
20000
+ /** widget-summary */
20001
+ export type WidgetSummary = AtomBaseSummary & {
20002
+ /**
20003
+ * The title of the widget.
20004
+ * @format text
20005
+ */
20006
+ title: string;
20007
+ };
18390
20008
  /**
18391
- * webhooks-update-request
18392
- * The request to update a webhook.
20009
+ * widget-visualization
20010
+ * The visualization for a widget. This includes the type of visualization
20011
+ * and any configuration specific to that type.
18393
20012
  */
18394
- export interface WebhooksUpdateRequest {
18395
- /** The action to update the webhook's status. */
18396
- action?: WebhooksUpdateAction;
18397
- event_types?: WebhooksUpdateRequestEventTypes;
18398
- headers?: WebhooksUpdateRequestHeaders;
20013
+ export interface WidgetVisualization {
20014
+ /** The type of the visualization, such as line, bar, pie, etc. */
20015
+ type: WidgetVisualizationType;
18399
20016
  /**
18400
- * ID for the webhook.
18401
- * @format id
18402
- * @example "don:integration:dvrv-us-1:devo/example:webhook/webhook-id"
20017
+ * A bar chart visualization configuration. Includes metadata specific to
20018
+ * bar charts.
18403
20019
  */
18404
- id: string;
20020
+ bar?: BarWidgetVisualization;
18405
20021
  /**
18406
- * If provided, updates the secret that's used when verifying webhook
18407
- * events, which must be between 8 and 32 bytes (inclusive). Otherwise
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
20022
+ * A column chart visualization configuration. Includes metadata specific
20023
+ * to column charts.
18412
20024
  */
18413
- secret?: string;
20025
+ column?: ColumnWidgetVisualization;
18414
20026
  /**
18415
- * The webhook's updated URL. If the webhook is active, then the
18416
- * webhook's status will transition to the 'unverified' state and it
18417
- * won't receive any object events until successfully verified.
18418
- * @format text
20027
+ * A donut chart visualization configuration. Includes metadata specific
20028
+ * to donut charts.
18419
20029
  */
18420
- url?: string;
18421
- }
18422
- /** webhooks-update-request-event-types */
18423
- export interface WebhooksUpdateRequestEventTypes {
20030
+ donut?: DonutWidgetVisualization;
18424
20031
  /**
18425
- * The event types to add. If a provided event type is already set for
18426
- * the webhook, then nothing is done. Note this is mutually exclusive
18427
- * with 'set'.
20032
+ * A heatmap chart visualization configuration. Includes metadata specific
20033
+ * to heatmap charts.
18428
20034
  */
18429
- add?: WebhookEventType[];
20035
+ heatmap?: HeatmapWidgetVisualization;
18430
20036
  /**
18431
- * The event types to remove. If a provided event type isn't set for
18432
- * the webhook, then nothing is done. Note this is mutually exclusive
18433
- * with 'set'.
20037
+ * A kanban visualization configuration. Includes metadata specific to
20038
+ * kanban.
18434
20039
  */
18435
- remove?: WebhookEventType[];
20040
+ kanban?: KanbanWidgetVisualization;
18436
20041
  /**
18437
- * The updated event types, which will replace the webhook's current
18438
- * event types. Note this is mutually exclusive with 'add' and
18439
- * 'remove'.
20042
+ * A line chart visualization configuration. Includes metadata specific to
20043
+ * line charts.
18440
20044
  */
18441
- set?: WebhookEventType[];
18442
- }
18443
- /** webhooks-update-request-headers */
18444
- export interface WebhooksUpdateRequestHeaders {
20045
+ line?: LineWidgetVisualization;
18445
20046
  /**
18446
- * The headers to be added to every webhook invocation. If a provided
18447
- * header is already specified for the webhook, its value is replaced.
18448
- * @maxItems 8
20047
+ * A metric visualization configuration. Includes metadata specific to
20048
+ * metrics.
18449
20049
  */
18450
- add?: WebhookHeader[];
20050
+ metric?: MetricWidgetVisualization;
18451
20051
  /**
18452
- * The headers to be removed from every webhook invocation. If a
18453
- * provided header is not specified for the webhook, then it's
18454
- * ignored.
18455
- * @maxItems 8
20052
+ * A Packed Bubble chart visualization configuration. Includes metadata
20053
+ * specific to packed bubble charts.
18456
20054
  */
18457
- remove?: string[];
20055
+ packed_bubble?: PackedBubbleWidgetVisualization;
18458
20056
  /**
18459
- * Sets the headers to include in every webhook invocation.
18460
- * @maxItems 8
20057
+ * A pie chart visualization configuration. Includes metadata specific to
20058
+ * pie charts.
18461
20059
  */
18462
- set?: WebhookHeader[];
20060
+ pie?: PieWidgetVisualization;
20061
+ /** The configuration for a rich text visualization. */
20062
+ rich_text?: RichTextWidgetVisualization;
20063
+ /**
20064
+ * A Scatter chart visualization configuration. Includes metadata specific
20065
+ * to scatter charts.
20066
+ */
20067
+ scatter?: ScatterWidgetVisualization;
20068
+ /**
20069
+ * A table visualization configuration. Includes metadata specific to
20070
+ * tables.
20071
+ */
20072
+ table?: TableWidgetVisualization;
20073
+ }
20074
+ /** The type of the visualization, such as line, bar, pie, etc. */
20075
+ export declare enum WidgetVisualizationType {
20076
+ Bar = "bar",
20077
+ Column = "column",
20078
+ Combination = "combination",
20079
+ Donut = "donut",
20080
+ Heatmap = "heatmap",
20081
+ Kanban = "kanban",
20082
+ Line = "line",
20083
+ Metric = "metric",
20084
+ PackedBubble = "packed_bubble",
20085
+ Pie = "pie",
20086
+ RichText = "rich_text",
20087
+ Scatter = "scatter",
20088
+ Table = "table"
18463
20089
  }
18464
20090
  /**
18465
- * webhooks-update-response
18466
- * The response to updating the webhook.
20091
+ * widgets-get-request
20092
+ * The request to get a widget.
18467
20093
  */
18468
- export interface WebhooksUpdateResponse {
18469
- webhook: Webhook;
20094
+ export interface WidgetsGetRequest {
20095
+ /**
20096
+ * The requested widget's ID.
20097
+ * @format text
20098
+ */
20099
+ id: string;
18470
20100
  }
18471
20101
  /**
18472
- * weekly-org-schedule
18473
- * The schedule for each week.
20102
+ * widgets-get-response
20103
+ * The response to a widget get request.
18474
20104
  */
18475
- export type WeeklyOrgSchedule = object;
18476
- /** widget */
18477
- export type Widget = AtomBase;
18478
- /** widget-summary */
18479
- export type WidgetSummary = AtomBaseSummary;
20105
+ export interface WidgetsGetResponse {
20106
+ widget: Widget;
20107
+ }
18480
20108
  /** work */
18481
20109
  export type Work = (Issue | Opportunity | Task | Ticket) & {
18482
20110
  type: WorkType;
@@ -19585,8 +21213,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
19585
21213
  sort_by?: string[];
19586
21214
  /** Filters for accounts on specified stages. */
19587
21215
  stage?: string[];
21216
+ /** Subtypes of the accounts to be filtered. */
21217
+ subtype?: string[];
19588
21218
  /** List of tags to be filtered. */
19589
21219
  tags?: string[];
21220
+ /** Tier of the accounts to be filtered. */
21221
+ tier?: string[];
19590
21222
  /** Array of websites of accounts to be filtered. */
19591
21223
  websites?: string[];
19592
21224
  }, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
@@ -19696,8 +21328,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
19696
21328
  sort_by?: string[];
19697
21329
  /** Filters for accounts on specified stages. */
19698
21330
  stage?: string[];
21331
+ /** Subtypes of the accounts to be filtered. */
21332
+ subtype?: string[];
19699
21333
  /** List of tags to be filtered. */
19700
21334
  tags?: string[];
21335
+ /** Tier of the accounts to be filtered. */
21336
+ tier?: string[];
19701
21337
  /** Array of websites of accounts to be filtered. */
19702
21338
  websites?: string[];
19703
21339
  }, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
@@ -20131,6 +21767,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
20131
21767
  * @secure
20132
21768
  */
20133
21769
  artifactsPrepare: (data: ArtifactsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsPrepareResponse, any>>;
21770
+ /**
21771
+ * @description Permanently deletes a version of an artifact.
21772
+ *
21773
+ * @tags artifacts
21774
+ * @name ArtifactsHardDeleteVersion
21775
+ * @summary Delete Artifacts Version
21776
+ * @request POST:/artifacts.versions.delete
21777
+ * @secure
21778
+ */
21779
+ artifactsHardDeleteVersion: (data: ArtifactsHardDeleteVersionRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
20134
21780
  /**
20135
21781
  * @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file.
20136
21782
  *
@@ -20302,6 +21948,89 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
20302
21948
  * @secure
20303
21949
  */
20304
21950
  authTokensUpdate: (data: AuthTokensUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensUpdateResponse, any>>;
21951
+ /**
21952
+ * @description Creates a new brand.
21953
+ *
21954
+ * @tags brands
21955
+ * @name BrandsCreate
21956
+ * @summary Create Brand
21957
+ * @request POST:/brands.create
21958
+ * @secure
21959
+ */
21960
+ brandsCreate: (data: BrandsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<BrandsCreateResponse, any>>;
21961
+ /**
21962
+ * @description Deletes a brand by its ID.
21963
+ *
21964
+ * @tags brands
21965
+ * @name BrandsDelete
21966
+ * @summary Delete Brand
21967
+ * @request POST:/brands.delete
21968
+ * @secure
21969
+ */
21970
+ brandsDelete: (data: BrandsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
21971
+ /**
21972
+ * @description Gets a brand by its ID.
21973
+ *
21974
+ * @tags brands
21975
+ * @name BrandsGet
21976
+ * @summary Get Brand
21977
+ * @request GET:/brands.get
21978
+ * @secure
21979
+ */
21980
+ brandsGet: (query: {
21981
+ /**
21982
+ * The ID of the brand to be retrieved.
21983
+ * @format id
21984
+ */
21985
+ id: string;
21986
+ }, params?: RequestParams) => Promise<AxiosResponse<BrandsGetResponse, any>>;
21987
+ /**
21988
+ * @description Gets a brand by its ID.
21989
+ *
21990
+ * @tags brands
21991
+ * @name BrandsGetPost
21992
+ * @summary Get Brand (POST)
21993
+ * @request POST:/brands.get
21994
+ * @secure
21995
+ */
21996
+ brandsGetPost: (data: BrandsGetRequest, params?: RequestParams) => Promise<AxiosResponse<BrandsGetResponse, any>>;
21997
+ /**
21998
+ * @description Lists all brands.
21999
+ *
22000
+ * @tags brands
22001
+ * @name BrandsList
22002
+ * @summary List Brands
22003
+ * @request GET:/brands.list
22004
+ * @secure
22005
+ */
22006
+ brandsList: (query?: {
22007
+ /**
22008
+ * The cursor to resume iteration from. If not provided, then iteration
22009
+ * starts from the beginning.
22010
+ * @format text
22011
+ */
22012
+ cursor?: string;
22013
+ }, params?: RequestParams) => Promise<AxiosResponse<BrandsListResponse, any>>;
22014
+ /**
22015
+ * @description Lists all brands.
22016
+ *
22017
+ * @tags brands
22018
+ * @name BrandsListPost
22019
+ * @summary List Brands (POST)
22020
+ * @request POST:/brands.list
22021
+ * @secure
22022
+ */
22023
+ brandsListPost: (data: BrandsListRequest, params?: RequestParams) => Promise<AxiosResponse<BrandsListResponse, any>>;
22024
+ /**
22025
+ * @description Updates a brand by its ID.
22026
+ *
22027
+ * @tags brands
22028
+ * @name BrandsUpdate
22029
+ * @summary Update Brand
22030
+ * @request POST:/brands.update
22031
+ * @secure
22032
+ */
22033
+ brandsUpdate: (data: BrandsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<BrandsUpdateResponse, any>>;
20305
22034
  /**
20306
22035
  * @description Creates a new chat, or optionally opens an existing one.
20307
22036
  *
@@ -20721,6 +22450,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
20721
22450
  source_channels?: string[];
20722
22451
  /** Filters for records in the provided stage(s) by name. */
20723
22452
  'stage.name'?: string[];
22453
+ /** Filters for conversations with any of the provided states. */
22454
+ state?: string[];
20724
22455
  /** Filters for conversation with any of the provided subtypes. */
20725
22456
  subtype?: string[];
20726
22457
  /**
@@ -20871,6 +22602,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
20871
22602
  source_channels?: string[];
20872
22603
  /** Filters for records in the provided stage(s) by name. */
20873
22604
  'stage.name'?: string[];
22605
+ /** Filters for conversations with any of the provided states. */
22606
+ state?: string[];
20874
22607
  /** Filters for conversation with any of the provided subtypes. */
20875
22608
  subtype?: string[];
20876
22609
  /**
@@ -21699,6 +23432,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
21699
23432
  * @secure
21700
23433
  */
21701
23434
  groupsList: (query?: {
23435
+ /** Filters the groups on the basis of creator. */
23436
+ created_by?: string[];
21702
23437
  /**
21703
23438
  * The cursor to resume iteration from. If not provided, then iteration
21704
23439
  * starts from the beginning.
@@ -21723,8 +23458,26 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
21723
23458
  * used.
21724
23459
  */
21725
23460
  mode?: ListMode;
23461
+ /** Filters the groups on the basis of group name. */
23462
+ name?: string[];
21726
23463
  /** Comma-separated fields to sort the groups by. */
21727
23464
  sort_by?: string[];
23465
+ /** Filters for issues with this specific external reference. */
23466
+ 'sync_metadata.external_reference'?: string[];
23467
+ /** Filters for works with selected sync statuses. */
23468
+ 'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
23469
+ /** Filters for works modified with selected sync history. */
23470
+ 'sync_metadata.last_sync_in.sync_history'?: string[];
23471
+ /** Filters for works modified with selected sync units. */
23472
+ 'sync_metadata.last_sync_in.sync_unit'?: string[];
23473
+ /** Filters for works with selected sync statuses. */
23474
+ 'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
23475
+ /** Filters for works modified with selected sync history. */
23476
+ 'sync_metadata.last_sync_out.sync_history'?: string[];
23477
+ /** Filters for works modified with selected sync units. */
23478
+ 'sync_metadata.last_sync_out.sync_unit'?: string[];
23479
+ /** Filters for issues synced from this specific origin system. */
23480
+ 'sync_metadata.origin_system'?: string[];
21728
23481
  }, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any>>;
21729
23482
  /**
21730
23483
  * @description Lists the available groups.
@@ -21940,10 +23693,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
21940
23693
  'sync_metadata.external_reference'?: string[];
21941
23694
  /** Filters for works with selected sync statuses. */
21942
23695
  'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
23696
+ /** Filters for works modified with selected sync history. */
23697
+ 'sync_metadata.last_sync_in.sync_history'?: string[];
21943
23698
  /** Filters for works modified with selected sync units. */
21944
23699
  'sync_metadata.last_sync_in.sync_unit'?: string[];
21945
23700
  /** Filters for works with selected sync statuses. */
21946
23701
  'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
23702
+ /** Filters for works modified with selected sync history. */
23703
+ 'sync_metadata.last_sync_out.sync_history'?: string[];
21947
23704
  /** Filters for works modified with selected sync units. */
21948
23705
  'sync_metadata.last_sync_out.sync_unit'?: string[];
21949
23706
  /** Filters for issues synced from this specific origin system. */
@@ -22034,10 +23791,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22034
23791
  'sync_metadata.external_reference'?: string[];
22035
23792
  /** Filters for works with selected sync statuses. */
22036
23793
  'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
23794
+ /** Filters for works modified with selected sync history. */
23795
+ 'sync_metadata.last_sync_in.sync_history'?: string[];
22037
23796
  /** Filters for works modified with selected sync units. */
22038
23797
  'sync_metadata.last_sync_in.sync_unit'?: string[];
22039
23798
  /** Filters for works with selected sync statuses. */
22040
23799
  'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
23800
+ /** Filters for works modified with selected sync history. */
23801
+ 'sync_metadata.last_sync_out.sync_history'?: string[];
22041
23802
  /** Filters for works modified with selected sync units. */
22042
23803
  'sync_metadata.last_sync_out.sync_unit'?: string[];
22043
23804
  /** Filters for issues synced from this specific origin system. */
@@ -22328,6 +24089,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22328
24089
  * @secure
22329
24090
  */
22330
24091
  linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
24092
+ /**
24093
+ * @description Replaces a link.
24094
+ *
24095
+ * @tags links
24096
+ * @name LinksReplace
24097
+ * @summary Replace Links
24098
+ * @request POST:/links.replace
24099
+ * @secure
24100
+ */
24101
+ linksReplace: (data: LinksReplaceRequest, params?: RequestParams) => Promise<AxiosResponse<LinksReplaceResponse, any>>;
22331
24102
  /**
22332
24103
  * @description Counts the meeting records.
22333
24104
  *
@@ -22641,6 +24412,37 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22641
24412
  * @secure
22642
24413
  */
22643
24414
  metricDefinitionsUpdate: (data: MetricDefinitionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsUpdateResponse, any>>;
24415
+ /**
24416
+ * @description Gets a metric tracker.
24417
+ *
24418
+ * @tags slas
24419
+ * @name MetricTrackersGet
24420
+ * @summary Get Metric Tracker
24421
+ * @request GET:/metric-trackers.get
24422
+ * @secure
24423
+ */
24424
+ metricTrackersGet: (query: {
24425
+ /**
24426
+ * The ID of the metric that is being tracked.
24427
+ * @format id
24428
+ */
24429
+ metric: string;
24430
+ /**
24431
+ * The ID of the underlying object on which the metric is being tracked.
24432
+ * @format id
24433
+ */
24434
+ object: string;
24435
+ }, params?: RequestParams) => Promise<AxiosResponse<MetricTrackersGetResponse, any>>;
24436
+ /**
24437
+ * @description Gets a metric tracker.
24438
+ *
24439
+ * @tags slas
24440
+ * @name MetricTrackersGetPost
24441
+ * @summary Get Metric Tracker (POST)
24442
+ * @request POST:/metric-trackers.get
24443
+ * @secure
24444
+ */
24445
+ metricTrackersGetPost: (data: MetricTrackersGetRequest, params?: RequestParams) => Promise<AxiosResponse<MetricTrackersGetResponse, any>>;
22644
24446
  /**
22645
24447
  * @description Ingest endpoint for DevRev metrics data from clients.
22646
24448
  *
@@ -23064,6 +24866,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23064
24866
  object: string;
23065
24867
  /** Type of the preference object to be fetched. */
23066
24868
  type: PreferencesType;
24869
+ /**
24870
+ * Language code for which to get the preferences for.
24871
+ * @format text
24872
+ */
24873
+ language_code?: string;
23067
24874
  }, params?: RequestParams) => Promise<AxiosResponse<PreferencesGetResponse, any>>;
23068
24875
  /**
23069
24876
  * @description Get the preferences object.
@@ -24133,6 +25940,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24133
25940
  * @secure
24134
25941
  */
24135
25942
  searchHybridPost: (data: SearchHybridRequest, params?: RequestParams) => Promise<AxiosResponse<SearchHybridResponse, any>>;
25943
+ /**
25944
+ * @description Creates a service account.
25945
+ *
25946
+ * @tags service-accounts
25947
+ * @name ServiceAccountsCreate
25948
+ * @summary Create Service Account
25949
+ * @request POST:/service-accounts.create
25950
+ * @secure
25951
+ */
25952
+ serviceAccountsCreate: (data: ServiceAccountsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsCreateResponse, any>>;
24136
25953
  /**
24137
25954
  * @description Gets a service account.
24138
25955
  *
@@ -25512,6 +27329,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25512
27329
  * @secure
25513
27330
  */
25514
27331
  webhooksUpdate: (data: WebhooksUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksUpdateResponse, any>>;
27332
+ /**
27333
+ * @description Returns the requested widget.
27334
+ *
27335
+ * @tags widgets
27336
+ * @name WidgetsGet
27337
+ * @summary Get Widget
27338
+ * @request GET:/widgets.get
27339
+ * @secure
27340
+ */
27341
+ widgetsGet: (query: {
27342
+ /**
27343
+ * The requested widget's ID.
27344
+ * @format text
27345
+ */
27346
+ id: string;
27347
+ }, params?: RequestParams) => Promise<AxiosResponse<WidgetsGetResponse, any>>;
27348
+ /**
27349
+ * @description Returns the requested widget.
27350
+ *
27351
+ * @tags widgets
27352
+ * @name WidgetsGetPost
27353
+ * @summary Get Widget (POST)
27354
+ * @request POST:/widgets.get
27355
+ * @secure
27356
+ */
27357
+ widgetsGetPost: (data: WidgetsGetRequest, params?: RequestParams) => Promise<AxiosResponse<WidgetsGetResponse, any>>;
25515
27358
  /**
25516
27359
  * @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
27360
  *
@@ -25616,10 +27459,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25616
27459
  'sync_metadata.external_reference'?: string[];
25617
27460
  /** Filters for works with selected sync statuses. */
25618
27461
  'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
27462
+ /** Filters for works modified with selected sync history. */
27463
+ 'sync_metadata.last_sync_in.sync_history'?: string[];
25619
27464
  /** Filters for works modified with selected sync units. */
25620
27465
  'sync_metadata.last_sync_in.sync_unit'?: string[];
25621
27466
  /** Filters for works with selected sync statuses. */
25622
27467
  'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
27468
+ /** Filters for works modified with selected sync history. */
27469
+ 'sync_metadata.last_sync_out.sync_history'?: string[];
25623
27470
  /** Filters for works modified with selected sync units. */
25624
27471
  'sync_metadata.last_sync_out.sync_unit'?: string[];
25625
27472
  /** Filters for issues synced from this specific origin system. */
@@ -25789,10 +27636,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25789
27636
  'sync_metadata.external_reference'?: string[];
25790
27637
  /** Filters for works with selected sync statuses. */
25791
27638
  'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
27639
+ /** Filters for works modified with selected sync history. */
27640
+ 'sync_metadata.last_sync_in.sync_history'?: string[];
25792
27641
  /** Filters for works modified with selected sync units. */
25793
27642
  'sync_metadata.last_sync_in.sync_unit'?: string[];
25794
27643
  /** Filters for works with selected sync statuses. */
25795
27644
  'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
27645
+ /** Filters for works modified with selected sync history. */
27646
+ 'sync_metadata.last_sync_out.sync_history'?: string[];
25796
27647
  /** Filters for works modified with selected sync units. */
25797
27648
  'sync_metadata.last_sync_out.sync_unit'?: string[];
25798
27649
  /** Filters for issues synced from this specific origin system. */