@devrev/typescript-sdk 1.1.63 → 1.1.65

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.
@@ -433,15 +433,64 @@ export interface AddTagWithValue {
433
433
  * List of custom fields from multiple source fragments.
434
434
  */
435
435
  export interface AggregatedSchema {
436
+ /**
437
+ * Apps corresponding to the app fragments used to populate the same
438
+ * in the object.
439
+ */
440
+ apps?: string[];
436
441
  /** The conditions associated with the fields. */
437
442
  conditions?: CustomSchemaFragmentCondition[];
438
- /** The stock field overrides. */
443
+ /** List of all composite schemas used by custom fields. */
444
+ custom_composite_schemas: CompositeSchema[];
445
+ /** List of all custom fields in this schema. */
446
+ custom_fields: SchemaFieldDescriptor[];
447
+ /**
448
+ * Description of the schema.
449
+ * @format text
450
+ */
451
+ description?: string;
452
+ /**
453
+ * True when the fragments being aggregated correspond to a custom
454
+ * leaf type.
455
+ */
456
+ is_custom_leaf_type?: boolean;
457
+ /**
458
+ * Leaf type of the fragments being aggregated.
459
+ * @format text
460
+ */
461
+ leaf_type?: string;
462
+ stage_diagram_id?: StageDiagramSummary;
463
+ /** List of all composite schemas used by stock fields. */
464
+ stock_composite_schemas: CompositeSchema[];
465
+ /**
466
+ * Optional overrides for properties of stock fields. Overrides in the
467
+ * custom type fragment take precedence over those defined in the
468
+ * tenant fragment.
469
+ */
439
470
  stock_field_overrides?: StockFieldOverride[];
471
+ /** List of all stock fields in this schema. */
472
+ stock_fields: SchemaFieldDescriptor[];
473
+ /**
474
+ * Subtype corresponding to the custom type fragment used to populate
475
+ * the same in the object.
476
+ * @format text
477
+ */
478
+ subtype?: string;
479
+ /**
480
+ * Display name of the subtype.
481
+ * @format text
482
+ */
483
+ subtype_display_name?: string;
484
+ /**
485
+ * Name of the schema.
486
+ * @format text
487
+ */
488
+ title?: string;
440
489
  }
441
490
  /** aggregated-schema-get-request */
442
491
  export interface AggregatedSchemaGetRequest {
443
- /** The list of custom schema fragment DONs which are to be aggregated. */
444
- custom_schema_fragment_ids?: string[];
492
+ /** The custom schema fragment IDs which are to be aggregated. */
493
+ custom_schema_fragments?: string[];
445
494
  /** Custom schemas described using identifiers */
446
495
  custom_schema_spec?: CustomSchemaSpecForRead;
447
496
  /** Whether the leaf type corresponds to a custom object. */
@@ -452,13 +501,11 @@ export interface AggregatedSchemaGetRequest {
452
501
  * @format text
453
502
  */
454
503
  leaf_type?: string;
455
- /** Per object schema, if associated with the leaf type. */
456
- per_object_schema?: FieldDescriptor[];
457
504
  /**
458
505
  * The stock schema fragment which is to be aggregated.
459
506
  * @format id
460
507
  */
461
- stock_schema_fragment_id?: string;
508
+ stock_schema_fragment?: string;
462
509
  }
463
510
  /** aggregated-schema-get-response */
464
511
  export interface AggregatedSchemaGetResponse {
@@ -856,6 +903,22 @@ export type AppFragment = CustomSchemaFragmentBase & {
856
903
  };
857
904
  /** app-fragment-summary */
858
905
  export type AppFragmentSummary = CustomSchemaFragmentBaseSummary;
906
+ /**
907
+ * applies-to-part-filter
908
+ * The filter for applies to part.
909
+ */
910
+ export interface AppliesToPartFilter {
911
+ /**
912
+ * Whether to include items belonging to children of any of the
913
+ * provided parts.
914
+ */
915
+ include_child_parts?: boolean;
916
+ /**
917
+ * Part IDs to filter on.
918
+ * @example ["PROD-12345"]
919
+ */
920
+ parts: string[];
921
+ }
859
922
  /**
860
923
  * archetype-metric-target
861
924
  * Metric with corresponding target values.
@@ -1102,6 +1165,8 @@ export interface ArticlesCountRequest {
1102
1165
  * @example ["DEVU-12345"]
1103
1166
  */
1104
1167
  owned_by?: string[];
1168
+ /** Filters for articles with the provided parent directories. */
1169
+ parent?: string[];
1105
1170
  /** Filter for the scope of the articles. */
1106
1171
  scope?: number[];
1107
1172
  /** Filter for articles based on intended audience. */
@@ -1338,6 +1403,8 @@ export interface ArticlesListRequest {
1338
1403
  * @example ["DEVU-12345"]
1339
1404
  */
1340
1405
  owned_by?: string[];
1406
+ /** Filters for articles with the provided parent directories. */
1407
+ parent?: string[];
1341
1408
  /** Filter for the scope of the articles. */
1342
1409
  scope?: number[];
1343
1410
  /** Filter for articles based on intended audience. */
@@ -1832,7 +1899,7 @@ export declare enum AssociatedToType {
1832
1899
  RevOrg = "rev_org"
1833
1900
  }
1834
1901
  /** atom */
1835
- 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) & {
1902
+ export type Atom = (Account | AppFragment | Article | AuthToken | Capability | CodeChange | Command | Conversation | CustomObject | CustomTypeFragment | DevOrg | DevUser | Dm | Engagement | Enhancement | Feature | Group | Incident | Issue | Link | Linkable | Meeting | NotificationContentTemplate | ObjectMember | Opportunity | Product | QuestionAnswer | RevOrg | RevUser | Runnable | ServiceAccount | Sla | SlaTracker | SnapIn | SnapInVersion | SysUser | Tag | Task | TenantFragment | Ticket | TimelineChangeEvent | TimelineComment | Uom | UserPreferences | Webhook | Widget) & {
1836
1903
  type: AtomType;
1837
1904
  };
1838
1905
  /** atom-base */
@@ -1876,12 +1943,13 @@ export interface AtomBaseSummary {
1876
1943
  id: string;
1877
1944
  }
1878
1945
  /** atom-summary */
1879
- 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) & {
1946
+ export type AtomSummary = (AccountSummary | AppFragmentSummary | ArticleSummary | AuthTokenSummary | CapabilitySummary | CodeChangeSummary | CommandSummary | ConversationSummary | CustomObjectSummary | CustomTypeFragmentSummary | DevOrgSummary | DevUserSummary | DmSummary | EngagementSummary | EnhancementSummary | FeatureSummary | GroupSummary | IncidentSummary | IssueSummary | LinkSummary | LinkableSummary | MeetingSummary | NotificationContentTemplateSummary | ObjectMemberSummary | OpportunitySummary | ProductSummary | QuestionAnswerSummary | RevOrgSummary | RevUserSummary | RunnableSummary | ServiceAccountSummary | SlaSummary | SlaTrackerSummary | SnapInSummary | SnapInVersionSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineChangeEventSummary | TimelineCommentSummary | UomSummary | UserPreferencesSummary | WebhookSummary | WidgetSummary) & {
1880
1947
  type: AtomType;
1881
1948
  };
1882
1949
  export declare enum AtomType {
1883
1950
  Account = "account",
1884
1951
  AppFragment = "app_fragment",
1952
+ Article = "article",
1885
1953
  AuthToken = "auth_token",
1886
1954
  Capability = "capability",
1887
1955
  CodeChange = "code_change",
@@ -1901,6 +1969,7 @@ export declare enum AtomType {
1901
1969
  Link = "link",
1902
1970
  Linkable = "linkable",
1903
1971
  Meeting = "meeting",
1972
+ NotificationContentTemplate = "notification_content_template",
1904
1973
  ObjectMember = "object_member",
1905
1974
  Opportunity = "opportunity",
1906
1975
  Product = "product",
@@ -2821,6 +2890,13 @@ export interface BrandsUpdateResponse {
2821
2890
  export type Capability = PartBase;
2822
2891
  /** capability-summary */
2823
2892
  export type CapabilitySummary = PartBaseSummary;
2893
+ /** The operator used to compare the key and the value. */
2894
+ export declare enum CaveatOperator {
2895
+ Eq = "eq",
2896
+ In = "in",
2897
+ Intersects = "intersects",
2898
+ NotEq = "not_eq"
2899
+ }
2824
2900
  /** chat */
2825
2901
  export type Chat = Dm & {
2826
2902
  type: ChatType;
@@ -3208,6 +3284,12 @@ export interface ClientOverride {
3208
3284
  * @format text
3209
3285
  */
3210
3286
  client_name?: string;
3287
+ /**
3288
+ * Number of decimal places to show. Only applicable for number
3289
+ * fields.
3290
+ * @format int32
3291
+ */
3292
+ decimal_places?: number;
3211
3293
  /**
3212
3294
  * The display name of the field.
3213
3295
  * @format text
@@ -3219,6 +3301,11 @@ export interface ClientOverride {
3219
3301
  is_hidden?: boolean;
3220
3302
  /** Whether the field is mandatory. */
3221
3303
  is_required?: boolean;
3304
+ /**
3305
+ * Relative order in which the field is shown.
3306
+ * @format int32
3307
+ */
3308
+ order?: number;
3222
3309
  /**
3223
3310
  * A placeholder for the field.
3224
3311
  * @format text
@@ -3229,6 +3316,11 @@ export interface ClientOverride {
3229
3316
  * @format text
3230
3317
  */
3231
3318
  tooltip?: string;
3319
+ /**
3320
+ * Whether to use shorthand notation. Example, 1K instead of 1000.
3321
+ * Only applicable for number fields.
3322
+ */
3323
+ use_shorthand_notation?: boolean;
3232
3324
  /** The view overrides for the client. */
3233
3325
  view_overrides?: ViewOverride[];
3234
3326
  }
@@ -3463,6 +3555,8 @@ export interface ColumnWidgetVisualization {
3463
3555
  }
3464
3556
  /** command */
3465
3557
  export type Command = AtomBase & {
3558
+ /** Action defines some logic to run. */
3559
+ action?: CommandAction;
3466
3560
  /**
3467
3561
  * Description of the command.
3468
3562
  * @format text
@@ -3488,6 +3582,7 @@ export type Command = AtomBase & {
3488
3582
  * shared.
3489
3583
  */
3490
3584
  shared_with?: SharedWithMembership[];
3585
+ source?: SnapInSummary;
3491
3586
  /** Status of the command. */
3492
3587
  status?: CommandStatus;
3493
3588
  /** Surfaces where this command can be invoked. */
@@ -3499,6 +3594,26 @@ export type Command = AtomBase & {
3499
3594
  */
3500
3595
  usage_hint?: string;
3501
3596
  };
3597
+ /**
3598
+ * command-action
3599
+ * Action defines some logic to run.
3600
+ */
3601
+ export interface CommandAction {
3602
+ /**
3603
+ * The raw code to execute, defined in the language specified by
3604
+ * executor.
3605
+ * @format text
3606
+ */
3607
+ code?: string;
3608
+ /** Specifies how the action is defined. */
3609
+ executor_type?: CommandActionExecutorType;
3610
+ /**
3611
+ * The message to populate in discussion box, when the command is
3612
+ * selected to execute.
3613
+ * @format text
3614
+ */
3615
+ message?: string;
3616
+ }
3502
3617
  /** Specifies how the action is defined. */
3503
3618
  export declare enum CommandActionExecutorType {
3504
3619
  Rego = "rego",
@@ -3756,10 +3871,32 @@ export interface CommentSearchSummary {
3756
3871
  */
3757
3872
  snippet?: string;
3758
3873
  }
3874
+ /**
3875
+ * composite-schema
3876
+ * The schema of a composite type.
3877
+ */
3878
+ export interface CompositeSchema {
3879
+ /**
3880
+ * Description of this composite type.
3881
+ * @format text
3882
+ */
3883
+ description?: string;
3884
+ /** List of all fields in this schema. */
3885
+ fields: SchemaFieldDescriptor[];
3886
+ /**
3887
+ * Name of this composite type.
3888
+ * @format text
3889
+ */
3890
+ name?: string;
3891
+ }
3759
3892
  /** content-template */
3760
- export interface ContentTemplate {
3893
+ export type ContentTemplate = NotificationContentTemplate & {
3761
3894
  type: ContentTemplateType;
3762
- }
3895
+ };
3896
+ /** content-template-base */
3897
+ export type ContentTemplateBase = AtomBase;
3898
+ /** content-template-base-summary */
3899
+ export type ContentTemplateBaseSummary = AtomBaseSummary;
3763
3900
  /**
3764
3901
  * content-template-create-request
3765
3902
  * The request to create a new content template.
@@ -3886,7 +4023,9 @@ export interface ContentTemplateListResponse {
3886
4023
  */
3887
4024
  prev_cursor?: string;
3888
4025
  }
3889
- export type ContentTemplateType = string;
4026
+ export declare enum ContentTemplateType {
4027
+ NotificationContentTemplate = "notification_content_template"
4028
+ }
3890
4029
  /** conversation */
3891
4030
  export type Conversation = AtomBase & {
3892
4031
  /**
@@ -3926,6 +4065,7 @@ export type Conversation = AtomBase & {
3926
4065
  * @format text
3927
4066
  */
3928
4067
  source_channel?: string;
4068
+ source_channel_v2?: ExternalCommunicationChannelSummary;
3929
4069
  /** Describes the current stage of a work item. */
3930
4070
  stage?: LegacyStage;
3931
4071
  /**
@@ -4045,8 +4185,6 @@ export interface ConversationsCreateRequest {
4045
4185
  * @format text
4046
4186
  */
4047
4187
  title?: string;
4048
- /** The IDs of user sessions associated with the conversation. */
4049
- user_sessions?: string[];
4050
4188
  }
4051
4189
  /** conversations-create-request-message */
4052
4190
  export interface ConversationsCreateRequestMessage {
@@ -4384,7 +4522,6 @@ export interface ConversationsUpdateRequest {
4384
4522
  * @format text
4385
4523
  */
4386
4524
  title?: string;
4387
- user_sessions?: ConversationsUpdateRequestUserSessions;
4388
4525
  }
4389
4526
  /** conversations-update-request-applies-to-parts */
4390
4527
  export interface ConversationsUpdateRequestAppliesToParts {
@@ -4429,11 +4566,6 @@ export interface ConversationsUpdateRequestTags {
4429
4566
  /** Sets the tag IDs to the provided tags. */
4430
4567
  set?: SetTagWithValue[];
4431
4568
  }
4432
- /** conversations-update-request-user-sessions */
4433
- export interface ConversationsUpdateRequestUserSessions {
4434
- /** The updated user sessions that the conversation is associated with. */
4435
- set?: string[];
4436
- }
4437
4569
  /**
4438
4570
  * conversations-update-response
4439
4571
  * The response for updating a conversation.
@@ -5093,6 +5225,13 @@ export type CustomObject = AtomBase & {
5093
5225
  * @example ["don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"]
5094
5226
  */
5095
5227
  custom_schema_fragments?: string[];
5228
+ /**
5229
+ * Type of the object.
5230
+ * @format text
5231
+ */
5232
+ leaf_type?: string;
5233
+ /** Describes the current stage of a object. */
5234
+ stage?: Stage;
5096
5235
  /**
5097
5236
  * Stock schema fragment.
5098
5237
  * @format id
@@ -5106,6 +5245,18 @@ export type CustomObject = AtomBase & {
5106
5245
  subtype?: string;
5107
5246
  /** Sync information for records synced into/from DevRev. */
5108
5247
  sync_metadata?: SyncMetadata;
5248
+ /**
5249
+ * Title of the object.
5250
+ * @format text
5251
+ */
5252
+ title?: string;
5253
+ /**
5254
+ * A unique key that, if provided, ensures the combination of
5255
+ * {leaf_type, unique_key} is distinct across all objects in the
5256
+ * system.
5257
+ * @format text
5258
+ */
5259
+ unique_key?: string;
5109
5260
  };
5110
5261
  /** custom-object-search-summary */
5111
5262
  export type CustomObjectSearchSummary = SearchSummaryBase & {
@@ -5115,6 +5266,11 @@ export type CustomObjectSearchSummary = SearchSummaryBase & {
5115
5266
  export type CustomObjectSummary = AtomBaseSummary & {
5116
5267
  /** Sync information for records synced into/from DevRev. */
5117
5268
  sync_metadata?: SyncMetadataSummary;
5269
+ /**
5270
+ * Title of the object.
5271
+ * @format text
5272
+ */
5273
+ title?: string;
5118
5274
  };
5119
5275
  /** custom-objects-count-request */
5120
5276
  export interface CustomObjectsCountRequest {
@@ -5172,7 +5328,7 @@ export interface CustomObjectsCreateRequest {
5172
5328
  * external reference to another object.
5173
5329
  * @format text
5174
5330
  */
5175
- unique_key: string;
5331
+ unique_key?: string;
5176
5332
  }
5177
5333
  /** custom-objects-create-response */
5178
5334
  export interface CustomObjectsCreateResponse {
@@ -5298,6 +5454,8 @@ export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFra
5298
5454
  };
5299
5455
  /** custom-schema-fragment-base */
5300
5456
  export type CustomSchemaFragmentBase = AtomBase & {
5457
+ /** List of composite schemas. */
5458
+ composite_schemas?: CompositeSchema[];
5301
5459
  /** The conditions associated with the fields. */
5302
5460
  conditions?: CustomSchemaFragmentCondition[];
5303
5461
  /**
@@ -5315,6 +5473,8 @@ export type CustomSchemaFragmentBase = AtomBase & {
5315
5473
  fields?: SchemaFieldDescriptor[];
5316
5474
  /** Type of the custom schema fragment. */
5317
5475
  fragment_type?: CustomSchemaFragmentFragmentType;
5476
+ /** Indicates if the leaf type corresponds to a custom object. */
5477
+ is_custom_leaf_type?: boolean;
5318
5478
  /**
5319
5479
  * Indicates if the fragment is deprecated. Modifications to this
5320
5480
  * field are done in-place and don't result in creation of a new
@@ -5336,7 +5496,7 @@ export type CustomSchemaFragmentBaseSummary = AtomBaseSummary;
5336
5496
  * The condition associated with a field.
5337
5497
  */
5338
5498
  export interface CustomSchemaFragmentCondition {
5339
- /** The linked effects when the expression evaluates to true. */
5499
+ /** The associated effects when the expression evaluates to true. */
5340
5500
  effects?: CustomSchemaFragmentEffect[];
5341
5501
  /**
5342
5502
  * The expression to evaluate.
@@ -5553,6 +5713,7 @@ export interface CustomSchemaFragmentsSetRequestTenantFragment {
5553
5713
  /**
5554
5714
  * The display ID prefix for the custom object.
5555
5715
  * @format text
5716
+ * @pattern ^[A-Z]{2,10}$
5556
5717
  */
5557
5718
  id_prefix?: string;
5558
5719
  /** List of Per-DevOrg stock field overrides. */
@@ -5628,7 +5789,7 @@ export type CustomStage = AtomBase & {
5628
5789
  */
5629
5790
  name?: string;
5630
5791
  /**
5631
- * Ordinal used to sort/group stages.
5792
+ * Position of the stage in the global stage ordering.
5632
5793
  * @format int32
5633
5794
  */
5634
5795
  ordinal?: number;
@@ -5750,7 +5911,7 @@ export type CustomState = AtomBase & {
5750
5911
  */
5751
5912
  name?: string;
5752
5913
  /**
5753
- * Ordinal used to identify system states.
5914
+ * Position of the state in the global state ordering.
5754
5915
  * @format int32
5755
5916
  */
5756
5917
  ordinal?: number;
@@ -5861,10 +6022,10 @@ export type CustomTypeFragment = CustomSchemaFragmentBase & {
5861
6022
  */
5862
6023
  path?: CustomTypePathComponent[];
5863
6024
  stage_diagram?: StageDiagramSummary;
5864
- /** The stock field overrides. */
6025
+ /** Optional overrides for properties of stock fields. */
5865
6026
  stock_field_overrides?: StockFieldOverride[];
5866
6027
  /**
5867
- * The string used to populate the subtype in the leaf type.
6028
+ * Subtype this fragment applies to.
5868
6029
  * @format text
5869
6030
  */
5870
6031
  subtype?: string;
@@ -5882,6 +6043,27 @@ export type CustomTypeFragmentSummary = CustomSchemaFragmentBaseSummary;
5882
6043
  * Path component for rendering custom type lists in tree form.
5883
6044
  */
5884
6045
  export type CustomTypePathComponent = object;
6046
+ /** custom-view */
6047
+ export interface CustomView {
6048
+ /** A list of vista's column preferences in order. */
6049
+ column_properties?: CustomViewColumnProperties[];
6050
+ /** Boolean to specify whether to show groups or not. */
6051
+ show_groups?: boolean;
6052
+ }
6053
+ /** custom-view-column-properties */
6054
+ export interface CustomViewColumnProperties {
6055
+ /**
6056
+ * Name of the column.
6057
+ * @format text
6058
+ */
6059
+ name: string;
6060
+ /**
6061
+ * Width of the column.
6062
+ * @format text
6063
+ * @maxLength 10
6064
+ */
6065
+ width?: string;
6066
+ }
5885
6067
  /** dashboard */
5886
6068
  export type Dashboard = AtomBase;
5887
6069
  /**
@@ -6748,6 +6930,11 @@ export interface DevUsersSelfUpdateRequest {
6748
6930
  job_history?: DevUsersUpdateJobHistoryItem[];
6749
6931
  /** Job title of the Dev User. */
6750
6932
  job_title?: DevUserJobTitle;
6933
+ /**
6934
+ * The ID of the Dev user that the user reports to.
6935
+ * @format id
6936
+ */
6937
+ reports_to?: string;
6751
6938
  }
6752
6939
  /** dev-users-update-job-history-item */
6753
6940
  export interface DevUsersUpdateJobHistoryItem {
@@ -6823,6 +7010,11 @@ export interface DevUsersUpdateRequest {
6823
7010
  job_history?: DevUsersUpdateJobHistoryItem[];
6824
7011
  /** Job title of the Dev User. */
6825
7012
  job_title?: DevUserJobTitle;
7013
+ /**
7014
+ * The ID of the Dev user that the user reports to.
7015
+ * @format id
7016
+ */
7017
+ reports_to?: string;
6826
7018
  }
6827
7019
  /**
6828
7020
  * dev-users-update-response
@@ -6862,11 +7054,6 @@ export interface DirectoriesCreateRequest {
6862
7054
  * @format text
6863
7055
  */
6864
7056
  description?: string;
6865
- /**
6866
- * Icon for the directory.
6867
- * @format text
6868
- */
6869
- icon?: string;
6870
7057
  /**
6871
7058
  * Language of the directory.
6872
7059
  * @format text
@@ -7092,18 +7279,28 @@ export type DirectorySummary = AtomBaseSummary & {
7092
7279
  /** dm */
7093
7280
  export type Dm = ChatBase & {
7094
7281
  /**
7095
- * The users in the direct message. Only these users have access the
7096
- * chat's history and can send new messages.
7282
+ * The groups in the direct message. Only these groups have access to
7283
+ * the chat's history and can send new messages.
7097
7284
  */
7098
- users: AtomSummary[];
7285
+ groups?: GroupSummary[];
7286
+ /**
7287
+ * The users in the direct message. Only these users have access to
7288
+ * the chat's history and can send new messages.
7289
+ */
7290
+ users: UserSummary[];
7099
7291
  };
7100
7292
  /** dm-summary */
7101
7293
  export type DmSummary = ChatBaseSummary & {
7102
7294
  /**
7103
- * The users in the direct message. Only these users have access the
7104
- * chat's history and can send new messages.
7295
+ * The groups in the direct message. Only these groups have access to
7296
+ * the chat's history and can send new messages.
7297
+ */
7298
+ groups?: GroupSummary[];
7299
+ /**
7300
+ * The users in the direct message. Only these users have access to
7301
+ * the chat's history and can send new messages.
7105
7302
  */
7106
- users: AtomSummary[];
7303
+ users: UserSummary[];
7107
7304
  };
7108
7305
  /**
7109
7306
  * donut-visualization-x-axis
@@ -7170,7 +7367,7 @@ export type DynamicGroupInfo = object;
7170
7367
  * Dynamic collection of DevRev objects, all adhering to a specific
7171
7368
  * filter.
7172
7369
  */
7173
- export type DynamicVista = VistaBase & {
7370
+ export type DynamicVista = VistaBase & DynamicVistaMeetingsVista & {
7174
7371
  /** Type of DevRev object for which the vista is applicable. */
7175
7372
  filter_type: DynamicVistaFilterType;
7176
7373
  };
@@ -7191,6 +7388,16 @@ export declare enum DynamicVistaFilterType {
7191
7388
  RevUsers = "rev_users",
7192
7389
  Works = "works"
7193
7390
  }
7391
+ /** dynamic-vista-meetings-vista */
7392
+ export interface DynamicVistaMeetingsVista {
7393
+ filter: MeetingsVistaFilter;
7394
+ /** Pinned items associated with the vista. */
7395
+ items?: DynamicVistaMeetingsVistaItemValue[];
7396
+ }
7397
+ /** dynamic-vista-meetings-vista-item-value */
7398
+ export interface DynamicVistaMeetingsVistaItemValue {
7399
+ item: MeetingSummary;
7400
+ }
7194
7401
  /**
7195
7402
  * dynamic-vista-summary
7196
7403
  * Dynamic collection of DevRev objects, all adhering to a specific
@@ -8219,6 +8426,25 @@ export interface EventAiAgentResponse {
8219
8426
  /** A list of suggestions generated for the AI agent event. */
8220
8427
  suggestions?: AiAgentEventSuggestions;
8221
8428
  }
8429
+ /** event-article-created */
8430
+ export interface EventArticleCreated {
8431
+ article: Article;
8432
+ }
8433
+ /** event-article-deleted */
8434
+ export interface EventArticleDeleted {
8435
+ /**
8436
+ * The ID of the article that was deleted.
8437
+ * @format id
8438
+ * @example "ARTICLE-12345"
8439
+ */
8440
+ id: string;
8441
+ old_article?: Article;
8442
+ }
8443
+ /** event-article-updated */
8444
+ export interface EventArticleUpdated {
8445
+ article: Article;
8446
+ old_article?: Article;
8447
+ }
8222
8448
  /** event-conversation-created */
8223
8449
  export interface EventConversationCreated {
8224
8450
  conversation: Conversation;
@@ -8748,12 +8974,16 @@ export interface EventWorkUpdated {
8748
8974
  * Request object to get a log's information.
8749
8975
  */
8750
8976
  export interface ExportAuditLogsRequest {
8977
+ /** Categories of the logs to filter by. */
8978
+ categories?: string[];
8751
8979
  /**
8752
8980
  * Time from which logs are to be retrieved.
8753
8981
  * @format date-time
8754
8982
  * @example "2023-01-01T12:00:00.000Z"
8755
8983
  */
8756
8984
  from: string;
8985
+ /** Operation type to filter the logs by. */
8986
+ operation_types?: ExportAuditLogsRequestOperationType[];
8757
8987
  /**
8758
8988
  * Time till which logs are to be retrieved.
8759
8989
  * @format date-time
@@ -8761,6 +8991,13 @@ export interface ExportAuditLogsRequest {
8761
8991
  */
8762
8992
  to: string;
8763
8993
  }
8994
+ export declare enum ExportAuditLogsRequestOperationType {
8995
+ Create = "create",
8996
+ Delete = "delete",
8997
+ Other = "other",
8998
+ Read = "read",
8999
+ Update = "update"
9000
+ }
8764
9001
  /**
8765
9002
  * export-audit-logs-response
8766
9003
  * Response for the audit logs export request. Response is empty as the
@@ -8828,7 +9065,133 @@ export interface FieldDelta {
8828
9065
  * field-descriptor
8829
9066
  * Set of field attributes.
8830
9067
  */
8831
- export type FieldDescriptor = object;
9068
+ export interface FieldDescriptor {
9069
+ /** The default value for this field. */
9070
+ default_value?: object;
9071
+ /**
9072
+ * Description of the field.
9073
+ * @format text
9074
+ */
9075
+ description?: string;
9076
+ /**
9077
+ * Composite type.
9078
+ * @format text
9079
+ */
9080
+ devrev_composite_type?: string;
9081
+ /** Allowed values for an enum field type. */
9082
+ devrev_enum?: string[];
9083
+ /**
9084
+ * DevRev field type.
9085
+ * @format text
9086
+ */
9087
+ devrev_field_type?: string;
9088
+ /** Object ID types. */
9089
+ devrev_id_type?: string[];
9090
+ /** Whether this field is filterable, groupable and sortable. */
9091
+ is_filterable?: boolean;
9092
+ /** Whether this field is immutable or not. */
9093
+ is_immutable?: boolean;
9094
+ /** Whether a stock unified enum can be extended with new values. */
9095
+ is_overridable?: boolean;
9096
+ /** Whether this field is required or not. */
9097
+ is_required?: boolean;
9098
+ /**
9099
+ * Whether this field can hold PII or sensitive information that
9100
+ * should not be logged.
9101
+ */
9102
+ is_sensitive?: boolean;
9103
+ /** Whether this field is a system field or not. */
9104
+ is_system?: boolean;
9105
+ /**
9106
+ * Name of the field.
9107
+ * @format text
9108
+ */
9109
+ name?: string;
9110
+ /** Allowed values for a unified enum. */
9111
+ uenum_values?: SchemaFieldUenumValue[];
9112
+ /** The schema of ui specific fields. */
9113
+ ui?: SchemaFieldUiMetadata;
9114
+ /** Validation annotations. */
9115
+ validation?: FieldValidation;
9116
+ }
9117
+ /**
9118
+ * field-validation
9119
+ * Validation annotations.
9120
+ */
9121
+ export interface FieldValidation {
9122
+ /**
9123
+ * string contains.
9124
+ * @format text
9125
+ */
9126
+ contains?: string;
9127
+ /** disables validations for this field. */
9128
+ disabled?: boolean;
9129
+ /**
9130
+ * exact array length.
9131
+ * @format int32
9132
+ */
9133
+ eq_items?: number;
9134
+ /**
9135
+ * exact string length.
9136
+ * @format int32
9137
+ */
9138
+ eq_len?: number;
9139
+ /**
9140
+ * int must be greater than this.
9141
+ * @format int32
9142
+ */
9143
+ gt?: number;
9144
+ /**
9145
+ * int must be greater or equal than this.
9146
+ * @format int32
9147
+ */
9148
+ gte?: number;
9149
+ /**
9150
+ * int must be less than this.
9151
+ * @format int32
9152
+ */
9153
+ lt?: number;
9154
+ /**
9155
+ * int must be less or equal than this.
9156
+ * @format int32
9157
+ */
9158
+ lte?: number;
9159
+ /**
9160
+ * maximum array length.
9161
+ * @format int32
9162
+ */
9163
+ max_items?: number;
9164
+ /**
9165
+ * maximum string length.
9166
+ * @format int32
9167
+ */
9168
+ max_len?: number;
9169
+ /**
9170
+ * minimum array length.
9171
+ * @format int32
9172
+ */
9173
+ min_items?: number;
9174
+ /**
9175
+ * minimum string length.
9176
+ * @format int32
9177
+ */
9178
+ min_len?: number;
9179
+ /**
9180
+ * string pattern (re).
9181
+ * @format text
9182
+ */
9183
+ pattern?: string;
9184
+ /**
9185
+ * string prefix.
9186
+ * @format text
9187
+ */
9188
+ prefix?: string;
9189
+ /**
9190
+ * string suffix.
9191
+ * @format text
9192
+ */
9193
+ suffix?: string;
9194
+ }
8832
9195
  /** field-value */
8833
9196
  export type FieldValue = (FieldValueBool | FieldValueBoolList | FieldValueComposite | FieldValueCompositeList | FieldValueDateList | FieldValueDateTimeList | FieldValueDateTimeValue | FieldValueDateValue | FieldValueDouble | FieldValueDoubleList | FieldValueId | FieldValueIdList | FieldValueInt64 | FieldValueInt64List | FieldValueStage | FieldValueString | FieldValueStringList | FieldValueTagSummary | FieldValueTagSummaryList) & {
8834
9197
  type: FieldValueType;
@@ -10088,6 +10451,11 @@ export type Issue = WorkBase & {
10088
10451
  actual_start_date?: string;
10089
10452
  /** Parts associated based on git events. */
10090
10453
  developed_with?: PartSummary[];
10454
+ /**
10455
+ * Estimated effort to complete the issue.
10456
+ * @format double
10457
+ */
10458
+ estimated_effort?: number;
10091
10459
  /** Priority of the work based upon impact and criticality. */
10092
10460
  priority?: IssuePriority;
10093
10461
  /** The properties of an enum value. */
@@ -10356,11 +10724,12 @@ export interface LinkDescriptorFilter {
10356
10724
  link_descriptors: LinkTargetDescriptor[];
10357
10725
  }
10358
10726
  /** link-endpoint-summary */
10359
- export type LinkEndpointSummary = (AccountSummary | CapabilitySummary | CodeChangeSummary | ConversationSummary | CustomObjectSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IncidentSummary | IssueSummary | LinkableSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | RunnableSummary | TaskSummary | TicketSummary | WidgetSummary) & {
10727
+ export type LinkEndpointSummary = (AccountSummary | ArticleSummary | CapabilitySummary | CodeChangeSummary | ConversationSummary | CustomObjectSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IncidentSummary | IssueSummary | LinkableSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | RunnableSummary | TaskSummary | TicketSummary | WidgetSummary) & {
10360
10728
  type: LinkEndpointType;
10361
10729
  };
10362
10730
  export declare enum LinkEndpointType {
10363
10731
  Account = "account",
10732
+ Article = "article",
10364
10733
  Capability = "capability",
10365
10734
  CodeChange = "code_change",
10366
10735
  Conversation = "conversation",
@@ -10732,6 +11101,12 @@ export type Meeting = AtomBase & {
10732
11101
  * @format text
10733
11102
  */
10734
11103
  description?: string;
11104
+ /**
11105
+ * Direction of meeting - meetings within an organization are internal.
11106
+ * Meetings with external customers can be incoming or outgoing depending
11107
+ * on who initiates them.
11108
+ */
11109
+ direction?: MeetingDirection;
10735
11110
  /**
10736
11111
  * Time at which meeting ended.
10737
11112
  * @format date-time
@@ -10798,6 +11173,16 @@ export declare enum MeetingChannel {
10798
11173
  Teams = "teams",
10799
11174
  Zoom = "zoom"
10800
11175
  }
11176
+ /**
11177
+ * Direction of meeting - meetings within an organization are internal.
11178
+ * Meetings with external customers can be incoming or outgoing depending
11179
+ * on who initiates them.
11180
+ */
11181
+ export declare enum MeetingDirection {
11182
+ Incoming = "incoming",
11183
+ Internal = "internal",
11184
+ Outgoing = "outgoing"
11185
+ }
10801
11186
  /** The state of meeting. */
10802
11187
  export declare enum MeetingState {
10803
11188
  Canceled = "canceled",
@@ -10846,6 +11231,9 @@ export interface MeetingsCountRequest {
10846
11231
  scheduled_date?: DateFilter;
10847
11232
  /** Filters for meeting on specified state or outcomes. */
10848
11233
  state?: MeetingState[];
11234
+ /** Subtypes of meeting to be filtered. */
11235
+ subtype?: string[];
11236
+ sync_metadata?: SyncMetadataFilter;
10849
11237
  /** Filters for meeting by tags. */
10850
11238
  tags?: string[];
10851
11239
  }
@@ -11048,6 +11436,9 @@ export interface MeetingsListRequest {
11048
11436
  sort_by?: string[];
11049
11437
  /** Filters for meeting on specified state or outcomes. */
11050
11438
  state?: MeetingState[];
11439
+ /** Subtypes of meeting to be filtered. */
11440
+ subtype?: string[];
11441
+ sync_metadata?: SyncMetadataFilter;
11051
11442
  /** Filters for meeting by tags. */
11052
11443
  tags?: string[];
11053
11444
  }
@@ -11165,6 +11556,51 @@ export interface MeetingsUpdateRequestTags {
11165
11556
  export interface MeetingsUpdateResponse {
11166
11557
  meeting: Meeting;
11167
11558
  }
11559
+ /** meetings-vista-filter */
11560
+ export interface MeetingsVistaFilter {
11561
+ /** Filters for meeting on specified channels. */
11562
+ channel?: MeetingChannel[];
11563
+ /** Filters for meetings created by the specified user(s). */
11564
+ created_by?: string[];
11565
+ /** Provides ways to specify date ranges on objects. */
11566
+ created_date?: DateFilter;
11567
+ /** Filters for meeting on custom fields. */
11568
+ custom_fields?: object;
11569
+ /** Provides ways to specify date ranges on objects. */
11570
+ ended_date?: DateFilter;
11571
+ /** Filters for meetings with the provided external_ref(s). */
11572
+ external_ref?: string[];
11573
+ /**
11574
+ * The field to group the collection by.
11575
+ * @format text
11576
+ */
11577
+ group_by?: string;
11578
+ /** Filters for links associated with the meeting. */
11579
+ links?: MeetingsFilterLinkSummaryFilter[];
11580
+ /** Filter for meeting on specified Member Ids. */
11581
+ members?: string[];
11582
+ /** Provides ways to specify date ranges on objects. */
11583
+ modified_date?: DateFilter;
11584
+ /** Filter for meeting on specified organizers. */
11585
+ organizer?: string[];
11586
+ /**
11587
+ * Filters for meetings with the provided parent.
11588
+ * @deprecated
11589
+ * @example ["ACC-12345"]
11590
+ */
11591
+ parent?: string[];
11592
+ /** Provides ways to specify date ranges on objects. */
11593
+ scheduled_date?: DateFilter;
11594
+ /** Comma-separated fields to sort the objects by. */
11595
+ sort_by?: string[];
11596
+ /** Filters for meeting on specified state or outcomes. */
11597
+ state?: MeetingState[];
11598
+ /** Subtypes of meeting to be filtered. */
11599
+ subtype?: string[];
11600
+ sync_metadata?: SyncMetadataFilter;
11601
+ /** Filters for meeting by tags. */
11602
+ tags?: string[];
11603
+ }
11168
11604
  /** member-summary */
11169
11605
  export type MemberSummary = (DevUserSummary | GroupSummary | RevUserSummary | SysUserSummary) & {
11170
11606
  type: MemberType;
@@ -11556,6 +11992,10 @@ export interface Money {
11556
11992
  */
11557
11993
  currency?: string;
11558
11994
  }
11995
+ /** notification-content-template */
11996
+ export type NotificationContentTemplate = ContentTemplateBase;
11997
+ /** notification-content-template-summary */
11998
+ export type NotificationContentTemplateSummary = ContentTemplateBaseSummary;
11559
11999
  /** notifications-send-request */
11560
12000
  export interface NotificationsSendRequest {
11561
12001
  /**
@@ -12436,6 +12876,8 @@ export interface PartsListRequest {
12436
12876
  owned_by?: string[];
12437
12877
  /** The filter for specifying parent part. */
12438
12878
  parent_part?: ParentPartFilter;
12879
+ /** Fields to sort the parts by and the direction to sort them. */
12880
+ sort_by?: string[];
12439
12881
  /** Filters for subtypes. */
12440
12882
  subtype?: string[];
12441
12883
  /**
@@ -12706,6 +13148,19 @@ export type PreferencesUpdateRequest = UpdateUserPreferences & {
12706
13148
  export interface PreferencesUpdateResponse {
12707
13149
  preferences: Preferences;
12708
13150
  }
13151
+ /** Type of the value. */
13152
+ export declare enum PrimitiveValueType {
13153
+ Attribute = "attribute",
13154
+ Bool = "bool",
13155
+ Id = "id",
13156
+ IdList = "id_list",
13157
+ Int = "int",
13158
+ IntList = "int_list",
13159
+ OverridableEnum = "overridable_enum",
13160
+ OverridableEnumList = "overridable_enum_list",
13161
+ String = "string",
13162
+ StringList = "string_list"
13163
+ }
12709
13164
  /** product */
12710
13165
  export type Product = PartBase;
12711
13166
  /** product-summary */
@@ -14137,6 +14592,8 @@ export type RolesApplyResponse = object;
14137
14592
  * A request to create a new role.
14138
14593
  */
14139
14594
  export interface RolesCreateRequest {
14595
+ /** The caveats on the role. */
14596
+ caveats?: RolesCreateRequestCaveat[];
14140
14597
  /**
14141
14598
  * The description of the role.
14142
14599
  * @format text
@@ -14165,6 +14622,51 @@ export interface RolesCreateRequest {
14165
14622
  */
14166
14623
  target_subtype?: string;
14167
14624
  }
14625
+ /**
14626
+ * roles-create-request-caveat
14627
+ * Caveat under which the role applies.
14628
+ */
14629
+ export interface RolesCreateRequestCaveat {
14630
+ /** Selector. */
14631
+ key: Selector;
14632
+ /** The operator used to compare the key and the value. */
14633
+ operator: CaveatOperator;
14634
+ /** Primitive Value. */
14635
+ value: RolesCreateRequestPrimitiveValue;
14636
+ }
14637
+ /**
14638
+ * roles-create-request-primitive-value
14639
+ * Primitive Value.
14640
+ */
14641
+ export interface RolesCreateRequestPrimitiveValue {
14642
+ /** Type of the value. */
14643
+ type: PrimitiveValueType;
14644
+ /** Selector. */
14645
+ attribute_value?: Selector;
14646
+ /** Boolean value. */
14647
+ bool_value?: boolean;
14648
+ /** List of ID values. */
14649
+ id_list_value?: string[];
14650
+ /**
14651
+ * ID value.
14652
+ * @format id
14653
+ */
14654
+ id_value?: string;
14655
+ /** List of integer values. */
14656
+ int_list_value?: number[];
14657
+ /**
14658
+ * Integer value.
14659
+ * @format int64
14660
+ */
14661
+ int_value?: number;
14662
+ /** List of string values. */
14663
+ string_list_value?: string[];
14664
+ /**
14665
+ * String value.
14666
+ * @format text
14667
+ */
14668
+ string_value?: string;
14669
+ }
14168
14670
  /**
14169
14671
  * roles-create-response
14170
14672
  * A response to a request to create a new role.
@@ -14505,6 +15007,12 @@ export interface SchemaFieldUiMetadata {
14505
15007
  client_overrides?: ClientOverride[];
14506
15008
  /** Create view UI hint overrides. */
14507
15009
  create_view?: SchemaFieldCreateViewUiMetadata;
15010
+ /**
15011
+ * Number of decimal places to show (only applicable for number
15012
+ * fields).
15013
+ * @format int32
15014
+ */
15015
+ decimal_places?: number;
14508
15016
  /** Detail view UI hint overrides. */
14509
15017
  detail_view?: SchemaFieldDetailViewUiMetadata;
14510
15018
  /**
@@ -14523,7 +15031,7 @@ export interface SchemaFieldUiMetadata {
14523
15031
  is_active_in_detail_view?: boolean;
14524
15032
  /** Whether the field supports bulk action. */
14525
15033
  is_bulk_action_enabled?: boolean;
14526
- /** Indicates if the field holds a currency value in USD. */
15034
+ /** Indicates if the field holds a currency value. */
14527
15035
  is_currency_field?: boolean;
14528
15036
  /** Whether the field is groupable in the UI. */
14529
15037
  is_groupable?: boolean;
@@ -14563,6 +15071,11 @@ export interface SchemaFieldUiMetadata {
14563
15071
  * @format text
14564
15072
  */
14565
15073
  unit?: string;
15074
+ /**
15075
+ * Whether to use shorthand notation (only applicable for number
15076
+ * fields).
15077
+ */
15078
+ use_shorthand_notation?: boolean;
14566
15079
  }
14567
15080
  /** schema-id-field-descriptor */
14568
15081
  export type SchemaIdFieldDescriptor = SchemaFieldDescriptorBase & {
@@ -15226,6 +15739,24 @@ export interface SearchSummaryBase {
15226
15739
  */
15227
15740
  snippet?: string;
15228
15741
  }
15742
+ /**
15743
+ * selector
15744
+ * Selector.
15745
+ */
15746
+ export interface Selector {
15747
+ /**
15748
+ * Attribute of the object.
15749
+ * @format text
15750
+ */
15751
+ attribute: string;
15752
+ /** The object. */
15753
+ object: SelectorObject;
15754
+ }
15755
+ /** The object. */
15756
+ export declare enum SelectorObject {
15757
+ Actor = "actor",
15758
+ Target = "target"
15759
+ }
15229
15760
  /** send-notification */
15230
15761
  export type SendNotification = SendNotificationGenericNotificationEntry & {
15231
15762
  type: SendNotificationType;
@@ -16293,9 +16824,9 @@ export interface Stage {
16293
16824
  }
16294
16825
  /** stage-diagram */
16295
16826
  export type StageDiagram = AtomBase & {
16296
- /** True if this diagram corresponds to a custom leaf type. */
16827
+ /** True if this stage diagram corresponds to a custom leaf type. */
16297
16828
  is_custom_leaf_type?: boolean;
16298
- /** True if this diagram is the default for the leaf type. */
16829
+ /** True if this stage diagram is the default for the leaf type. */
16299
16830
  is_default?: boolean;
16300
16831
  /**
16301
16832
  * The leaf type this stage diagram applies to.
@@ -16303,17 +16834,20 @@ export type StageDiagram = AtomBase & {
16303
16834
  */
16304
16835
  leaf_type?: string;
16305
16836
  /**
16306
- * The human readable name of the diagram.
16837
+ * The human readable name of the stage diagram.
16307
16838
  * @format text
16308
16839
  */
16309
16840
  name?: string;
16310
- /** Stage node. */
16841
+ /**
16842
+ * List of stages with their allowed transitions in this stage
16843
+ * diagram.
16844
+ */
16311
16845
  stages: StageNode[];
16312
16846
  };
16313
16847
  /** stage-diagram-summary */
16314
16848
  export type StageDiagramSummary = AtomBaseSummary & {
16315
16849
  /**
16316
- * The human readable name of the diagram.
16850
+ * The human readable name of the stage diagram.
16317
16851
  * @format text
16318
16852
  */
16319
16853
  name?: string;
@@ -16453,7 +16987,7 @@ export interface StageNode {
16453
16987
  /** True if this stage is the starting stage of the stage diagram. */
16454
16988
  is_start?: boolean;
16455
16989
  stage?: CustomStageSummary;
16456
- /** The list of stages that can be reached. */
16990
+ /** List of allowed transitions from this stage. */
16457
16991
  transitions?: StageTransition[];
16458
16992
  }
16459
16993
  /**
@@ -16524,6 +17058,8 @@ export interface StockFieldOverride {
16524
17058
  }
16525
17059
  /** stock-schema-fragment */
16526
17060
  export type StockSchemaFragment = AtomBase & {
17061
+ /** List of composite schemas. */
17062
+ composite_schemas: CompositeSchema[];
16527
17063
  /**
16528
17064
  * Description of the schema.
16529
17065
  * @format text
@@ -17882,7 +18418,17 @@ export declare enum TaskPriority {
17882
18418
  export type TaskSummary = WorkBaseSummary;
17883
18419
  /** tenant-fragment */
17884
18420
  export type TenantFragment = CustomSchemaFragmentBase & {
17885
- /** The stock field overrides. */
18421
+ /**
18422
+ * The display ID prefix. For custom leaf types only.
18423
+ * @format text
18424
+ */
18425
+ id_prefix?: string;
18426
+ /**
18427
+ * The display name of the leaf type. For custom leaf types only.
18428
+ * @format text
18429
+ */
18430
+ leaf_type_display_name?: string;
18431
+ /** Optional overrides for properties of stock fields. */
17886
18432
  stock_field_overrides?: StockFieldOverride[];
17887
18433
  };
17888
18434
  /** tenant-fragment-summary */
@@ -18404,6 +18950,7 @@ export type TimelineEntryBaseSummary = AtomBaseSummary & {
18404
18950
  /** The type of object that the Timeline entry belongs to. */
18405
18951
  export declare enum TimelineEntryObjectType {
18406
18952
  Account = "account",
18953
+ Article = "article",
18407
18954
  Capability = "capability",
18408
18955
  CodeChange = "code_change",
18409
18956
  Conversation = "conversation",
@@ -19383,6 +19930,12 @@ export declare enum UserType {
19383
19930
  * UI hint overrides for a view.
19384
19931
  */
19385
19932
  export interface ViewOverride {
19933
+ /**
19934
+ * Number of decimal places to show. Only applicable for number
19935
+ * fields.
19936
+ * @format int32
19937
+ */
19938
+ decimal_places?: number;
19386
19939
  /**
19387
19940
  * The display name of the field.
19388
19941
  * @format text
@@ -19394,6 +19947,11 @@ export interface ViewOverride {
19394
19947
  is_hidden?: boolean;
19395
19948
  /** Whether the field is mandatory. */
19396
19949
  is_required?: boolean;
19950
+ /**
19951
+ * Relative order in which the field is shown.
19952
+ * @format int32
19953
+ */
19954
+ order?: number;
19397
19955
  /**
19398
19956
  * A placeholder for the field.
19399
19957
  * @format text
@@ -19404,6 +19962,11 @@ export interface ViewOverride {
19404
19962
  * @format text
19405
19963
  */
19406
19964
  tooltip?: string;
19965
+ /**
19966
+ * Whether to use shorthand notation. Example, 1K instead of 1000.
19967
+ * Only applicable for number fields.
19968
+ */
19969
+ use_shorthand_notation?: boolean;
19407
19970
  /**
19408
19971
  * The name of the view.
19409
19972
  * @format text
@@ -19574,6 +20137,54 @@ export declare enum VistaType {
19574
20137
  Dynamic = "dynamic",
19575
20138
  Grouped = "grouped"
19576
20139
  }
20140
+ /**
20141
+ * vistas-create-request
20142
+ * The request to create new vista.
20143
+ */
20144
+ export type VistasCreateRequest = VistasCreateRequestDynamicVista & {
20145
+ /** Type of vista object. */
20146
+ type: VistaType;
20147
+ custom_view?: CustomView;
20148
+ /**
20149
+ * Description of the vista.
20150
+ * @format text
20151
+ */
20152
+ description?: string;
20153
+ /**
20154
+ * Name of the vista.
20155
+ * @format text
20156
+ */
20157
+ name: string;
20158
+ /** Users and groups associated with vista. */
20159
+ shared_with?: SetSharedWithMembership[];
20160
+ };
20161
+ /** vistas-create-request-dynamic-vista */
20162
+ export type VistasCreateRequestDynamicVista = VistasCreateRequestDynamicVistaMeetingsVista & {
20163
+ /** Type of DevRev object for which the vista is applicable. */
20164
+ filter_type: DynamicVistaFilterType;
20165
+ };
20166
+ /** vistas-create-request-dynamic-vista-meetings-vista */
20167
+ export interface VistasCreateRequestDynamicVistaMeetingsVista {
20168
+ filter: MeetingsVistaFilter;
20169
+ /** Pinned items associated with the vista. */
20170
+ items?: VistasCreateRequestDynamicVistaMeetingsVistaItemValue[];
20171
+ }
20172
+ /** vistas-create-request-dynamic-vista-meetings-vista-item-value */
20173
+ export interface VistasCreateRequestDynamicVistaMeetingsVistaItemValue {
20174
+ /**
20175
+ * The ID of the item.
20176
+ * @format id
20177
+ */
20178
+ id: string;
20179
+ }
20180
+ /**
20181
+ * vistas-create-response
20182
+ * The response to vista creation.
20183
+ */
20184
+ export interface VistasCreateResponse {
20185
+ /** Represents a collection of DevRev objects. */
20186
+ vista: Vista;
20187
+ }
19577
20188
  /**
19578
20189
  * vistas-delete-request
19579
20190
  * The request to delete a vista.
@@ -19644,6 +20255,14 @@ export interface VistasGroupsGetResponse {
19644
20255
  export interface VistasGroupsListRequest {
19645
20256
  /** Filters for vista group items of the specific type. */
19646
20257
  type?: GroupItemType[];
20258
+ /**
20259
+ * Filters for vista group items which have one of the parts linked as
20260
+ * its ancestor part or primary part.
20261
+ * @example ["PROD-12345"]
20262
+ */
20263
+ ancestor_part?: string[];
20264
+ /** The filter for applies to part. */
20265
+ applies_to_part?: AppliesToPartFilter;
19647
20266
  /**
19648
20267
  * Filter for vistas group item created by any of these users.
19649
20268
  * @example ["DEVU-12345"]
@@ -19947,7 +20566,10 @@ export interface WebCrawlerJobsCreateRequest {
19947
20566
  * @format text
19948
20567
  */
19949
20568
  accept_regex?: string;
19950
- /** The list of regexes a URL must satisfy to be crawled. */
20569
+ /**
20570
+ * The list of regexes a URL must satisfy to be crawled.
20571
+ * @maxItems 100
20572
+ */
19951
20573
  accept_regexes?: string[];
19952
20574
  /**
19953
20575
  * The parts to which created webpage/articles during this crawler job
@@ -19992,13 +20614,23 @@ export interface WebCrawlerJobsCreateRequest {
19992
20614
  * The list of regexes which if satisfied by a URL results in
19993
20615
  * rejection of the URL. If a URL matches both accept and reject
19994
20616
  * regexes, it is rejected.
20617
+ * @maxItems 100
19995
20618
  */
19996
20619
  reject_regexes?: string[];
19997
- /** The list of sitemap index URLs to crawl. */
20620
+ /**
20621
+ * The list of sitemap index URLs to crawl.
20622
+ * @maxItems 2
20623
+ */
19998
20624
  sitemap_index_urls?: string[];
19999
- /** The list of sitemap URLs to crawl. */
20625
+ /**
20626
+ * The list of sitemap URLs to crawl.
20627
+ * @maxItems 2
20628
+ */
20000
20629
  sitemap_urls?: string[];
20001
- /** The list of URLs to crawl. */
20630
+ /**
20631
+ * The list of URLs to crawl.
20632
+ * @maxItems 50
20633
+ */
20002
20634
  urls?: string[];
20003
20635
  /**
20004
20636
  * User agent to use for crawling websites in this job.
@@ -20114,6 +20746,9 @@ export interface WebhookEventRequest {
20114
20746
  account_deleted?: EventAccountDeleted;
20115
20747
  account_updated?: EventAccountUpdated;
20116
20748
  ai_agent_response?: EventAiAgentResponse;
20749
+ article_created?: EventArticleCreated;
20750
+ article_deleted?: EventArticleDeleted;
20751
+ article_updated?: EventArticleUpdated;
20117
20752
  conversation_created?: EventConversationCreated;
20118
20753
  conversation_deleted?: EventConversationDeleted;
20119
20754
  conversation_updated?: EventConversationUpdated;
@@ -20212,6 +20847,9 @@ export declare enum WebhookEventType {
20212
20847
  AccountDeleted = "account_deleted",
20213
20848
  AccountUpdated = "account_updated",
20214
20849
  AiAgentResponse = "ai_agent_response",
20850
+ ArticleCreated = "article_created",
20851
+ ArticleDeleted = "article_deleted",
20852
+ ArticleUpdated = "article_updated",
20215
20853
  ConversationCreated = "conversation_created",
20216
20854
  ConversationDeleted = "conversation_deleted",
20217
20855
  ConversationUpdated = "conversation_updated",
@@ -22332,6 +22970,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22332
22970
  * @example ["DEVU-12345"]
22333
22971
  */
22334
22972
  owned_by?: string[];
22973
+ /** Filters for articles with the provided parent directories. */
22974
+ parent?: string[];
22335
22975
  /** Filter for the scope of the articles. */
22336
22976
  scope?: number[];
22337
22977
  /**
@@ -22465,6 +23105,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22465
23105
  * @example ["DEVU-12345"]
22466
23106
  */
22467
23107
  owned_by?: string[];
23108
+ /** Filters for articles with the provided parent directories. */
23109
+ parent?: string[];
22468
23110
  /** Filter for the scope of the articles. */
22469
23111
  scope?: number[];
22470
23112
  /**
@@ -25045,6 +25687,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25045
25687
  parent?: string[];
25046
25688
  /** Filters for meeting on specified state or outcomes. */
25047
25689
  state?: MeetingState[];
25690
+ /** Subtypes of meeting to be filtered. */
25691
+ subtype?: string[];
25692
+ /** Filters for issues with this specific external reference. */
25693
+ 'sync_metadata.external_reference'?: string[];
25694
+ /** Filters for works with selected sync statuses. */
25695
+ 'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
25696
+ /** Filters for works modified with selected sync history. */
25697
+ 'sync_metadata.last_sync_in.sync_history'?: string[];
25698
+ /** Filters for works modified with selected sync units. */
25699
+ 'sync_metadata.last_sync_in.sync_unit'?: string[];
25700
+ /** Filters for works with selected sync statuses. */
25701
+ 'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
25702
+ /** Filters for works modified with selected sync history. */
25703
+ 'sync_metadata.last_sync_out.sync_history'?: string[];
25704
+ /** Filters for works modified with selected sync units. */
25705
+ 'sync_metadata.last_sync_out.sync_unit'?: string[];
25706
+ /** Filters for issues synced from this specific origin system. */
25707
+ 'sync_metadata.origin_system'?: string[];
25048
25708
  /** Filters for meeting by tags. */
25049
25709
  tags?: string[];
25050
25710
  }, params?: RequestParams) => Promise<AxiosResponse<MeetingsCountResponse, any>>;
@@ -25167,6 +25827,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25167
25827
  sort_by?: string[];
25168
25828
  /** Filters for meeting on specified state or outcomes. */
25169
25829
  state?: MeetingState[];
25830
+ /** Subtypes of meeting to be filtered. */
25831
+ subtype?: string[];
25832
+ /** Filters for issues with this specific external reference. */
25833
+ 'sync_metadata.external_reference'?: string[];
25834
+ /** Filters for works with selected sync statuses. */
25835
+ 'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
25836
+ /** Filters for works modified with selected sync history. */
25837
+ 'sync_metadata.last_sync_in.sync_history'?: string[];
25838
+ /** Filters for works modified with selected sync units. */
25839
+ 'sync_metadata.last_sync_in.sync_unit'?: string[];
25840
+ /** Filters for works with selected sync statuses. */
25841
+ 'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
25842
+ /** Filters for works modified with selected sync history. */
25843
+ 'sync_metadata.last_sync_out.sync_history'?: string[];
25844
+ /** Filters for works modified with selected sync units. */
25845
+ 'sync_metadata.last_sync_out.sync_unit'?: string[];
25846
+ /** Filters for issues synced from this specific origin system. */
25847
+ 'sync_metadata.origin_system'?: string[];
25170
25848
  /** Filters for meeting by tags. */
25171
25849
  tags?: string[];
25172
25850
  }, params?: RequestParams) => Promise<AxiosResponse<MeetingsListResponse, any>>;
@@ -25725,6 +26403,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25725
26403
  * @example ["PROD-12345"]
25726
26404
  */
25727
26405
  'parent_part.parts'?: string[];
26406
+ /** Fields to sort the parts by and the direction to sort them. */
26407
+ sort_by?: string[];
25728
26408
  /** Filters for subtypes. */
25729
26409
  subtype?: string[];
25730
26410
  /**
@@ -26538,8 +27218,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26538
27218
  * @secure
26539
27219
  */
26540
27220
  aggregatedSchemaGet: (query?: {
26541
- /** The list of custom schema fragment DONs which are to be aggregated. */
26542
- custom_schema_fragment_ids?: string[];
27221
+ /** The custom schema fragment IDs which are to be aggregated. */
27222
+ custom_schema_fragments?: string[];
26543
27223
  /** List of apps. */
26544
27224
  'custom_schema_spec.apps'?: string[];
26545
27225
  /**
@@ -26559,7 +27239,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26559
27239
  * The stock schema fragment which is to be aggregated.
26560
27240
  * @format id
26561
27241
  */
26562
- stock_schema_fragment_id?: string;
27242
+ stock_schema_fragment?: string;
26563
27243
  }, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
26564
27244
  /**
26565
27245
  * @description Gets the aggregated schema.
@@ -28174,6 +28854,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
28174
28854
  * @secure
28175
28855
  */
28176
28856
  uomsUpdate: (data: UomsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<UomsUpdateResponse, any>>;
28857
+ /**
28858
+ * @description Creates a vista.
28859
+ *
28860
+ * @tags vistas
28861
+ * @name VistasCreate
28862
+ * @summary Create Vista
28863
+ * @request POST:/vistas.create
28864
+ * @secure
28865
+ */
28866
+ vistasCreate: (data: VistasCreateRequest, params?: RequestParams) => Promise<AxiosResponse<VistasCreateResponse, any>>;
28177
28867
  /**
28178
28868
  * @description Deletes the requested vista.
28179
28869
  *
@@ -28257,6 +28947,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
28257
28947
  * @secure
28258
28948
  */
28259
28949
  vistasGroupsList: (query?: {
28950
+ /**
28951
+ * Filters for vista group items which have one of the parts linked as
28952
+ * its ancestor part or primary part.
28953
+ * @example ["PROD-12345"]
28954
+ */
28955
+ ancestor_part?: string[];
28956
+ /**
28957
+ * Whether to include items belonging to children of any of the provided
28958
+ * parts.
28959
+ */
28960
+ 'applies_to_part.include_child_parts'?: boolean;
28961
+ /**
28962
+ * Part IDs to filter on. Required if any applies_to_part.* fields are
28963
+ * provided.
28964
+ * @example ["PROD-12345"]
28965
+ */
28966
+ 'applies_to_part.parts'?: string[];
28260
28967
  /**
28261
28968
  * Filter for vistas group item created by any of these users.
28262
28969
  * @example ["DEVU-12345"]