@devrev/typescript-sdk 1.1.63 → 1.1.64

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
  /**
@@ -5093,6 +5233,13 @@ export type CustomObject = AtomBase & {
5093
5233
  * @example ["don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"]
5094
5234
  */
5095
5235
  custom_schema_fragments?: string[];
5236
+ /**
5237
+ * Type of the object.
5238
+ * @format text
5239
+ */
5240
+ leaf_type?: string;
5241
+ /** Describes the current stage of a object. */
5242
+ stage?: Stage;
5096
5243
  /**
5097
5244
  * Stock schema fragment.
5098
5245
  * @format id
@@ -5106,6 +5253,18 @@ export type CustomObject = AtomBase & {
5106
5253
  subtype?: string;
5107
5254
  /** Sync information for records synced into/from DevRev. */
5108
5255
  sync_metadata?: SyncMetadata;
5256
+ /**
5257
+ * Title of the object.
5258
+ * @format text
5259
+ */
5260
+ title?: string;
5261
+ /**
5262
+ * A unique key that, if provided, ensures the combination of
5263
+ * {leaf_type, unique_key} is distinct across all objects in the
5264
+ * system.
5265
+ * @format text
5266
+ */
5267
+ unique_key?: string;
5109
5268
  };
5110
5269
  /** custom-object-search-summary */
5111
5270
  export type CustomObjectSearchSummary = SearchSummaryBase & {
@@ -5115,6 +5274,11 @@ export type CustomObjectSearchSummary = SearchSummaryBase & {
5115
5274
  export type CustomObjectSummary = AtomBaseSummary & {
5116
5275
  /** Sync information for records synced into/from DevRev. */
5117
5276
  sync_metadata?: SyncMetadataSummary;
5277
+ /**
5278
+ * Title of the object.
5279
+ * @format text
5280
+ */
5281
+ title?: string;
5118
5282
  };
5119
5283
  /** custom-objects-count-request */
5120
5284
  export interface CustomObjectsCountRequest {
@@ -5172,7 +5336,7 @@ export interface CustomObjectsCreateRequest {
5172
5336
  * external reference to another object.
5173
5337
  * @format text
5174
5338
  */
5175
- unique_key: string;
5339
+ unique_key?: string;
5176
5340
  }
5177
5341
  /** custom-objects-create-response */
5178
5342
  export interface CustomObjectsCreateResponse {
@@ -5298,6 +5462,8 @@ export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFra
5298
5462
  };
5299
5463
  /** custom-schema-fragment-base */
5300
5464
  export type CustomSchemaFragmentBase = AtomBase & {
5465
+ /** List of composite schemas. */
5466
+ composite_schemas?: CompositeSchema[];
5301
5467
  /** The conditions associated with the fields. */
5302
5468
  conditions?: CustomSchemaFragmentCondition[];
5303
5469
  /**
@@ -5315,6 +5481,8 @@ export type CustomSchemaFragmentBase = AtomBase & {
5315
5481
  fields?: SchemaFieldDescriptor[];
5316
5482
  /** Type of the custom schema fragment. */
5317
5483
  fragment_type?: CustomSchemaFragmentFragmentType;
5484
+ /** Indicates if the leaf type corresponds to a custom object. */
5485
+ is_custom_leaf_type?: boolean;
5318
5486
  /**
5319
5487
  * Indicates if the fragment is deprecated. Modifications to this
5320
5488
  * field are done in-place and don't result in creation of a new
@@ -5336,7 +5504,7 @@ export type CustomSchemaFragmentBaseSummary = AtomBaseSummary;
5336
5504
  * The condition associated with a field.
5337
5505
  */
5338
5506
  export interface CustomSchemaFragmentCondition {
5339
- /** The linked effects when the expression evaluates to true. */
5507
+ /** The associated effects when the expression evaluates to true. */
5340
5508
  effects?: CustomSchemaFragmentEffect[];
5341
5509
  /**
5342
5510
  * The expression to evaluate.
@@ -5553,6 +5721,7 @@ export interface CustomSchemaFragmentsSetRequestTenantFragment {
5553
5721
  /**
5554
5722
  * The display ID prefix for the custom object.
5555
5723
  * @format text
5724
+ * @pattern ^[A-Z]{2,10}$
5556
5725
  */
5557
5726
  id_prefix?: string;
5558
5727
  /** List of Per-DevOrg stock field overrides. */
@@ -5628,7 +5797,7 @@ export type CustomStage = AtomBase & {
5628
5797
  */
5629
5798
  name?: string;
5630
5799
  /**
5631
- * Ordinal used to sort/group stages.
5800
+ * Position of the stage in the global stage ordering.
5632
5801
  * @format int32
5633
5802
  */
5634
5803
  ordinal?: number;
@@ -5750,7 +5919,7 @@ export type CustomState = AtomBase & {
5750
5919
  */
5751
5920
  name?: string;
5752
5921
  /**
5753
- * Ordinal used to identify system states.
5922
+ * Position of the state in the global state ordering.
5754
5923
  * @format int32
5755
5924
  */
5756
5925
  ordinal?: number;
@@ -5861,10 +6030,10 @@ export type CustomTypeFragment = CustomSchemaFragmentBase & {
5861
6030
  */
5862
6031
  path?: CustomTypePathComponent[];
5863
6032
  stage_diagram?: StageDiagramSummary;
5864
- /** The stock field overrides. */
6033
+ /** Optional overrides for properties of stock fields. */
5865
6034
  stock_field_overrides?: StockFieldOverride[];
5866
6035
  /**
5867
- * The string used to populate the subtype in the leaf type.
6036
+ * Subtype this fragment applies to.
5868
6037
  * @format text
5869
6038
  */
5870
6039
  subtype?: string;
@@ -5882,6 +6051,27 @@ export type CustomTypeFragmentSummary = CustomSchemaFragmentBaseSummary;
5882
6051
  * Path component for rendering custom type lists in tree form.
5883
6052
  */
5884
6053
  export type CustomTypePathComponent = object;
6054
+ /** custom-view */
6055
+ export interface CustomView {
6056
+ /** A list of vista's column preferences in order. */
6057
+ column_properties?: CustomViewColumnProperties[];
6058
+ /** Boolean to specify whether to show groups or not. */
6059
+ show_groups?: boolean;
6060
+ }
6061
+ /** custom-view-column-properties */
6062
+ export interface CustomViewColumnProperties {
6063
+ /**
6064
+ * Name of the column.
6065
+ * @format text
6066
+ */
6067
+ name: string;
6068
+ /**
6069
+ * Width of the column.
6070
+ * @format text
6071
+ * @maxLength 10
6072
+ */
6073
+ width?: string;
6074
+ }
5885
6075
  /** dashboard */
5886
6076
  export type Dashboard = AtomBase;
5887
6077
  /**
@@ -6748,6 +6938,11 @@ export interface DevUsersSelfUpdateRequest {
6748
6938
  job_history?: DevUsersUpdateJobHistoryItem[];
6749
6939
  /** Job title of the Dev User. */
6750
6940
  job_title?: DevUserJobTitle;
6941
+ /**
6942
+ * The ID of the Dev user that the user reports to.
6943
+ * @format id
6944
+ */
6945
+ reports_to?: string;
6751
6946
  }
6752
6947
  /** dev-users-update-job-history-item */
6753
6948
  export interface DevUsersUpdateJobHistoryItem {
@@ -6823,6 +7018,11 @@ export interface DevUsersUpdateRequest {
6823
7018
  job_history?: DevUsersUpdateJobHistoryItem[];
6824
7019
  /** Job title of the Dev User. */
6825
7020
  job_title?: DevUserJobTitle;
7021
+ /**
7022
+ * The ID of the Dev user that the user reports to.
7023
+ * @format id
7024
+ */
7025
+ reports_to?: string;
6826
7026
  }
6827
7027
  /**
6828
7028
  * dev-users-update-response
@@ -7170,7 +7370,7 @@ export type DynamicGroupInfo = object;
7170
7370
  * Dynamic collection of DevRev objects, all adhering to a specific
7171
7371
  * filter.
7172
7372
  */
7173
- export type DynamicVista = VistaBase & {
7373
+ export type DynamicVista = VistaBase & DynamicVistaMeetingsVista & {
7174
7374
  /** Type of DevRev object for which the vista is applicable. */
7175
7375
  filter_type: DynamicVistaFilterType;
7176
7376
  };
@@ -7191,6 +7391,16 @@ export declare enum DynamicVistaFilterType {
7191
7391
  RevUsers = "rev_users",
7192
7392
  Works = "works"
7193
7393
  }
7394
+ /** dynamic-vista-meetings-vista */
7395
+ export interface DynamicVistaMeetingsVista {
7396
+ filter: MeetingsVistaFilter;
7397
+ /** Pinned items associated with the vista. */
7398
+ items?: DynamicVistaMeetingsVistaItemValue[];
7399
+ }
7400
+ /** dynamic-vista-meetings-vista-item-value */
7401
+ export interface DynamicVistaMeetingsVistaItemValue {
7402
+ item: MeetingSummary;
7403
+ }
7194
7404
  /**
7195
7405
  * dynamic-vista-summary
7196
7406
  * Dynamic collection of DevRev objects, all adhering to a specific
@@ -8219,6 +8429,25 @@ export interface EventAiAgentResponse {
8219
8429
  /** A list of suggestions generated for the AI agent event. */
8220
8430
  suggestions?: AiAgentEventSuggestions;
8221
8431
  }
8432
+ /** event-article-created */
8433
+ export interface EventArticleCreated {
8434
+ article: Article;
8435
+ }
8436
+ /** event-article-deleted */
8437
+ export interface EventArticleDeleted {
8438
+ /**
8439
+ * The ID of the article that was deleted.
8440
+ * @format id
8441
+ * @example "ARTICLE-12345"
8442
+ */
8443
+ id: string;
8444
+ old_article?: Article;
8445
+ }
8446
+ /** event-article-updated */
8447
+ export interface EventArticleUpdated {
8448
+ article: Article;
8449
+ old_article?: Article;
8450
+ }
8222
8451
  /** event-conversation-created */
8223
8452
  export interface EventConversationCreated {
8224
8453
  conversation: Conversation;
@@ -8828,7 +9057,133 @@ export interface FieldDelta {
8828
9057
  * field-descriptor
8829
9058
  * Set of field attributes.
8830
9059
  */
8831
- export type FieldDescriptor = object;
9060
+ export interface FieldDescriptor {
9061
+ /** The default value for this field. */
9062
+ default_value?: object;
9063
+ /**
9064
+ * Description of the field.
9065
+ * @format text
9066
+ */
9067
+ description?: string;
9068
+ /**
9069
+ * Composite type.
9070
+ * @format text
9071
+ */
9072
+ devrev_composite_type?: string;
9073
+ /** Allowed values for an enum field type. */
9074
+ devrev_enum?: string[];
9075
+ /**
9076
+ * DevRev field type.
9077
+ * @format text
9078
+ */
9079
+ devrev_field_type?: string;
9080
+ /** Object ID types. */
9081
+ devrev_id_type?: string[];
9082
+ /** Whether this field is filterable, groupable and sortable. */
9083
+ is_filterable?: boolean;
9084
+ /** Whether this field is immutable or not. */
9085
+ is_immutable?: boolean;
9086
+ /** Whether a stock unified enum can be extended with new values. */
9087
+ is_overridable?: boolean;
9088
+ /** Whether this field is required or not. */
9089
+ is_required?: boolean;
9090
+ /**
9091
+ * Whether this field can hold PII or sensitive information that
9092
+ * should not be logged.
9093
+ */
9094
+ is_sensitive?: boolean;
9095
+ /** Whether this field is a system field or not. */
9096
+ is_system?: boolean;
9097
+ /**
9098
+ * Name of the field.
9099
+ * @format text
9100
+ */
9101
+ name?: string;
9102
+ /** Allowed values for a unified enum. */
9103
+ uenum_values?: SchemaFieldUenumValue[];
9104
+ /** The schema of ui specific fields. */
9105
+ ui?: SchemaFieldUiMetadata;
9106
+ /** Validation annotations. */
9107
+ validation?: FieldValidation;
9108
+ }
9109
+ /**
9110
+ * field-validation
9111
+ * Validation annotations.
9112
+ */
9113
+ export interface FieldValidation {
9114
+ /**
9115
+ * string contains.
9116
+ * @format text
9117
+ */
9118
+ contains?: string;
9119
+ /** disables validations for this field. */
9120
+ disabled?: boolean;
9121
+ /**
9122
+ * exact array length.
9123
+ * @format int32
9124
+ */
9125
+ eq_items?: number;
9126
+ /**
9127
+ * exact string length.
9128
+ * @format int32
9129
+ */
9130
+ eq_len?: number;
9131
+ /**
9132
+ * int must be greater than this.
9133
+ * @format int32
9134
+ */
9135
+ gt?: number;
9136
+ /**
9137
+ * int must be greater or equal than this.
9138
+ * @format int32
9139
+ */
9140
+ gte?: number;
9141
+ /**
9142
+ * int must be less than this.
9143
+ * @format int32
9144
+ */
9145
+ lt?: number;
9146
+ /**
9147
+ * int must be less or equal than this.
9148
+ * @format int32
9149
+ */
9150
+ lte?: number;
9151
+ /**
9152
+ * maximum array length.
9153
+ * @format int32
9154
+ */
9155
+ max_items?: number;
9156
+ /**
9157
+ * maximum string length.
9158
+ * @format int32
9159
+ */
9160
+ max_len?: number;
9161
+ /**
9162
+ * minimum array length.
9163
+ * @format int32
9164
+ */
9165
+ min_items?: number;
9166
+ /**
9167
+ * minimum string length.
9168
+ * @format int32
9169
+ */
9170
+ min_len?: number;
9171
+ /**
9172
+ * string pattern (re).
9173
+ * @format text
9174
+ */
9175
+ pattern?: string;
9176
+ /**
9177
+ * string prefix.
9178
+ * @format text
9179
+ */
9180
+ prefix?: string;
9181
+ /**
9182
+ * string suffix.
9183
+ * @format text
9184
+ */
9185
+ suffix?: string;
9186
+ }
8832
9187
  /** field-value */
8833
9188
  export type FieldValue = (FieldValueBool | FieldValueBoolList | FieldValueComposite | FieldValueCompositeList | FieldValueDateList | FieldValueDateTimeList | FieldValueDateTimeValue | FieldValueDateValue | FieldValueDouble | FieldValueDoubleList | FieldValueId | FieldValueIdList | FieldValueInt64 | FieldValueInt64List | FieldValueStage | FieldValueString | FieldValueStringList | FieldValueTagSummary | FieldValueTagSummaryList) & {
8834
9189
  type: FieldValueType;
@@ -10356,11 +10711,12 @@ export interface LinkDescriptorFilter {
10356
10711
  link_descriptors: LinkTargetDescriptor[];
10357
10712
  }
10358
10713
  /** 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) & {
10714
+ 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
10715
  type: LinkEndpointType;
10361
10716
  };
10362
10717
  export declare enum LinkEndpointType {
10363
10718
  Account = "account",
10719
+ Article = "article",
10364
10720
  Capability = "capability",
10365
10721
  CodeChange = "code_change",
10366
10722
  Conversation = "conversation",
@@ -10732,6 +11088,12 @@ export type Meeting = AtomBase & {
10732
11088
  * @format text
10733
11089
  */
10734
11090
  description?: string;
11091
+ /**
11092
+ * Direction of meeting - meetings within an organization are internal.
11093
+ * Meetings with external customers can be incoming or outgoing depending
11094
+ * on who initiates them.
11095
+ */
11096
+ direction?: MeetingDirection;
10735
11097
  /**
10736
11098
  * Time at which meeting ended.
10737
11099
  * @format date-time
@@ -10798,6 +11160,16 @@ export declare enum MeetingChannel {
10798
11160
  Teams = "teams",
10799
11161
  Zoom = "zoom"
10800
11162
  }
11163
+ /**
11164
+ * Direction of meeting - meetings within an organization are internal.
11165
+ * Meetings with external customers can be incoming or outgoing depending
11166
+ * on who initiates them.
11167
+ */
11168
+ export declare enum MeetingDirection {
11169
+ Incoming = "incoming",
11170
+ Internal = "internal",
11171
+ Outgoing = "outgoing"
11172
+ }
10801
11173
  /** The state of meeting. */
10802
11174
  export declare enum MeetingState {
10803
11175
  Canceled = "canceled",
@@ -10846,6 +11218,7 @@ export interface MeetingsCountRequest {
10846
11218
  scheduled_date?: DateFilter;
10847
11219
  /** Filters for meeting on specified state or outcomes. */
10848
11220
  state?: MeetingState[];
11221
+ sync_metadata?: SyncMetadataFilter;
10849
11222
  /** Filters for meeting by tags. */
10850
11223
  tags?: string[];
10851
11224
  }
@@ -11048,6 +11421,7 @@ export interface MeetingsListRequest {
11048
11421
  sort_by?: string[];
11049
11422
  /** Filters for meeting on specified state or outcomes. */
11050
11423
  state?: MeetingState[];
11424
+ sync_metadata?: SyncMetadataFilter;
11051
11425
  /** Filters for meeting by tags. */
11052
11426
  tags?: string[];
11053
11427
  }
@@ -11165,6 +11539,49 @@ export interface MeetingsUpdateRequestTags {
11165
11539
  export interface MeetingsUpdateResponse {
11166
11540
  meeting: Meeting;
11167
11541
  }
11542
+ /** meetings-vista-filter */
11543
+ export interface MeetingsVistaFilter {
11544
+ /** Filters for meeting on specified channels. */
11545
+ channel?: MeetingChannel[];
11546
+ /** Filters for meetings created by the specified user(s). */
11547
+ created_by?: string[];
11548
+ /** Provides ways to specify date ranges on objects. */
11549
+ created_date?: DateFilter;
11550
+ /** Filters for meeting on custom fields. */
11551
+ custom_fields?: object;
11552
+ /** Provides ways to specify date ranges on objects. */
11553
+ ended_date?: DateFilter;
11554
+ /** Filters for meetings with the provided external_ref(s). */
11555
+ external_ref?: string[];
11556
+ /**
11557
+ * The field to group the collection by.
11558
+ * @format text
11559
+ */
11560
+ group_by?: string;
11561
+ /** Filters for links associated with the meeting. */
11562
+ links?: MeetingsFilterLinkSummaryFilter[];
11563
+ /** Filter for meeting on specified Member Ids. */
11564
+ members?: string[];
11565
+ /** Provides ways to specify date ranges on objects. */
11566
+ modified_date?: DateFilter;
11567
+ /** Filter for meeting on specified organizers. */
11568
+ organizer?: string[];
11569
+ /**
11570
+ * Filters for meetings with the provided parent.
11571
+ * @deprecated
11572
+ * @example ["ACC-12345"]
11573
+ */
11574
+ parent?: string[];
11575
+ /** Provides ways to specify date ranges on objects. */
11576
+ scheduled_date?: DateFilter;
11577
+ /** Comma-separated fields to sort the objects by. */
11578
+ sort_by?: string[];
11579
+ /** Filters for meeting on specified state or outcomes. */
11580
+ state?: MeetingState[];
11581
+ sync_metadata?: SyncMetadataFilter;
11582
+ /** Filters for meeting by tags. */
11583
+ tags?: string[];
11584
+ }
11168
11585
  /** member-summary */
11169
11586
  export type MemberSummary = (DevUserSummary | GroupSummary | RevUserSummary | SysUserSummary) & {
11170
11587
  type: MemberType;
@@ -11556,6 +11973,10 @@ export interface Money {
11556
11973
  */
11557
11974
  currency?: string;
11558
11975
  }
11976
+ /** notification-content-template */
11977
+ export type NotificationContentTemplate = ContentTemplateBase;
11978
+ /** notification-content-template-summary */
11979
+ export type NotificationContentTemplateSummary = ContentTemplateBaseSummary;
11559
11980
  /** notifications-send-request */
11560
11981
  export interface NotificationsSendRequest {
11561
11982
  /**
@@ -12436,6 +12857,8 @@ export interface PartsListRequest {
12436
12857
  owned_by?: string[];
12437
12858
  /** The filter for specifying parent part. */
12438
12859
  parent_part?: ParentPartFilter;
12860
+ /** Fields to sort the parts by and the direction to sort them. */
12861
+ sort_by?: string[];
12439
12862
  /** Filters for subtypes. */
12440
12863
  subtype?: string[];
12441
12864
  /**
@@ -12706,6 +13129,19 @@ export type PreferencesUpdateRequest = UpdateUserPreferences & {
12706
13129
  export interface PreferencesUpdateResponse {
12707
13130
  preferences: Preferences;
12708
13131
  }
13132
+ /** Type of the value. */
13133
+ export declare enum PrimitiveValueType {
13134
+ Attribute = "attribute",
13135
+ Bool = "bool",
13136
+ Id = "id",
13137
+ IdList = "id_list",
13138
+ Int = "int",
13139
+ IntList = "int_list",
13140
+ OverridableEnum = "overridable_enum",
13141
+ OverridableEnumList = "overridable_enum_list",
13142
+ String = "string",
13143
+ StringList = "string_list"
13144
+ }
12709
13145
  /** product */
12710
13146
  export type Product = PartBase;
12711
13147
  /** product-summary */
@@ -14137,6 +14573,8 @@ export type RolesApplyResponse = object;
14137
14573
  * A request to create a new role.
14138
14574
  */
14139
14575
  export interface RolesCreateRequest {
14576
+ /** The caveats on the role. */
14577
+ caveats?: RolesCreateRequestCaveat[];
14140
14578
  /**
14141
14579
  * The description of the role.
14142
14580
  * @format text
@@ -14165,6 +14603,51 @@ export interface RolesCreateRequest {
14165
14603
  */
14166
14604
  target_subtype?: string;
14167
14605
  }
14606
+ /**
14607
+ * roles-create-request-caveat
14608
+ * Caveat under which the role applies.
14609
+ */
14610
+ export interface RolesCreateRequestCaveat {
14611
+ /** Selector. */
14612
+ key: Selector;
14613
+ /** The operator used to compare the key and the value. */
14614
+ operator: CaveatOperator;
14615
+ /** Primitive Value. */
14616
+ value: RolesCreateRequestPrimitiveValue;
14617
+ }
14618
+ /**
14619
+ * roles-create-request-primitive-value
14620
+ * Primitive Value.
14621
+ */
14622
+ export interface RolesCreateRequestPrimitiveValue {
14623
+ /** Type of the value. */
14624
+ type: PrimitiveValueType;
14625
+ /** Selector. */
14626
+ attribute_value?: Selector;
14627
+ /** Boolean value. */
14628
+ bool_value?: boolean;
14629
+ /** List of ID values. */
14630
+ id_list_value?: string[];
14631
+ /**
14632
+ * ID value.
14633
+ * @format id
14634
+ */
14635
+ id_value?: string;
14636
+ /** List of integer values. */
14637
+ int_list_value?: number[];
14638
+ /**
14639
+ * Integer value.
14640
+ * @format int64
14641
+ */
14642
+ int_value?: number;
14643
+ /** List of string values. */
14644
+ string_list_value?: string[];
14645
+ /**
14646
+ * String value.
14647
+ * @format text
14648
+ */
14649
+ string_value?: string;
14650
+ }
14168
14651
  /**
14169
14652
  * roles-create-response
14170
14653
  * A response to a request to create a new role.
@@ -14505,6 +14988,12 @@ export interface SchemaFieldUiMetadata {
14505
14988
  client_overrides?: ClientOverride[];
14506
14989
  /** Create view UI hint overrides. */
14507
14990
  create_view?: SchemaFieldCreateViewUiMetadata;
14991
+ /**
14992
+ * Number of decimal places to show (only applicable for number
14993
+ * fields).
14994
+ * @format int32
14995
+ */
14996
+ decimal_places?: number;
14508
14997
  /** Detail view UI hint overrides. */
14509
14998
  detail_view?: SchemaFieldDetailViewUiMetadata;
14510
14999
  /**
@@ -14523,7 +15012,7 @@ export interface SchemaFieldUiMetadata {
14523
15012
  is_active_in_detail_view?: boolean;
14524
15013
  /** Whether the field supports bulk action. */
14525
15014
  is_bulk_action_enabled?: boolean;
14526
- /** Indicates if the field holds a currency value in USD. */
15015
+ /** Indicates if the field holds a currency value. */
14527
15016
  is_currency_field?: boolean;
14528
15017
  /** Whether the field is groupable in the UI. */
14529
15018
  is_groupable?: boolean;
@@ -14563,6 +15052,11 @@ export interface SchemaFieldUiMetadata {
14563
15052
  * @format text
14564
15053
  */
14565
15054
  unit?: string;
15055
+ /**
15056
+ * Whether to use shorthand notation (only applicable for number
15057
+ * fields).
15058
+ */
15059
+ use_shorthand_notation?: boolean;
14566
15060
  }
14567
15061
  /** schema-id-field-descriptor */
14568
15062
  export type SchemaIdFieldDescriptor = SchemaFieldDescriptorBase & {
@@ -15226,6 +15720,24 @@ export interface SearchSummaryBase {
15226
15720
  */
15227
15721
  snippet?: string;
15228
15722
  }
15723
+ /**
15724
+ * selector
15725
+ * Selector.
15726
+ */
15727
+ export interface Selector {
15728
+ /**
15729
+ * Attribute of the object.
15730
+ * @format text
15731
+ */
15732
+ attribute: string;
15733
+ /** The object. */
15734
+ object: SelectorObject;
15735
+ }
15736
+ /** The object. */
15737
+ export declare enum SelectorObject {
15738
+ Actor = "actor",
15739
+ Target = "target"
15740
+ }
15229
15741
  /** send-notification */
15230
15742
  export type SendNotification = SendNotificationGenericNotificationEntry & {
15231
15743
  type: SendNotificationType;
@@ -16293,9 +16805,9 @@ export interface Stage {
16293
16805
  }
16294
16806
  /** stage-diagram */
16295
16807
  export type StageDiagram = AtomBase & {
16296
- /** True if this diagram corresponds to a custom leaf type. */
16808
+ /** True if this stage diagram corresponds to a custom leaf type. */
16297
16809
  is_custom_leaf_type?: boolean;
16298
- /** True if this diagram is the default for the leaf type. */
16810
+ /** True if this stage diagram is the default for the leaf type. */
16299
16811
  is_default?: boolean;
16300
16812
  /**
16301
16813
  * The leaf type this stage diagram applies to.
@@ -16303,17 +16815,20 @@ export type StageDiagram = AtomBase & {
16303
16815
  */
16304
16816
  leaf_type?: string;
16305
16817
  /**
16306
- * The human readable name of the diagram.
16818
+ * The human readable name of the stage diagram.
16307
16819
  * @format text
16308
16820
  */
16309
16821
  name?: string;
16310
- /** Stage node. */
16822
+ /**
16823
+ * List of stages with their allowed transitions in this stage
16824
+ * diagram.
16825
+ */
16311
16826
  stages: StageNode[];
16312
16827
  };
16313
16828
  /** stage-diagram-summary */
16314
16829
  export type StageDiagramSummary = AtomBaseSummary & {
16315
16830
  /**
16316
- * The human readable name of the diagram.
16831
+ * The human readable name of the stage diagram.
16317
16832
  * @format text
16318
16833
  */
16319
16834
  name?: string;
@@ -16453,7 +16968,7 @@ export interface StageNode {
16453
16968
  /** True if this stage is the starting stage of the stage diagram. */
16454
16969
  is_start?: boolean;
16455
16970
  stage?: CustomStageSummary;
16456
- /** The list of stages that can be reached. */
16971
+ /** List of allowed transitions from this stage. */
16457
16972
  transitions?: StageTransition[];
16458
16973
  }
16459
16974
  /**
@@ -16524,6 +17039,8 @@ export interface StockFieldOverride {
16524
17039
  }
16525
17040
  /** stock-schema-fragment */
16526
17041
  export type StockSchemaFragment = AtomBase & {
17042
+ /** List of composite schemas. */
17043
+ composite_schemas: CompositeSchema[];
16527
17044
  /**
16528
17045
  * Description of the schema.
16529
17046
  * @format text
@@ -17882,7 +18399,17 @@ export declare enum TaskPriority {
17882
18399
  export type TaskSummary = WorkBaseSummary;
17883
18400
  /** tenant-fragment */
17884
18401
  export type TenantFragment = CustomSchemaFragmentBase & {
17885
- /** The stock field overrides. */
18402
+ /**
18403
+ * The display ID prefix. For custom leaf types only.
18404
+ * @format text
18405
+ */
18406
+ id_prefix?: string;
18407
+ /**
18408
+ * The display name of the leaf type. For custom leaf types only.
18409
+ * @format text
18410
+ */
18411
+ leaf_type_display_name?: string;
18412
+ /** Optional overrides for properties of stock fields. */
17886
18413
  stock_field_overrides?: StockFieldOverride[];
17887
18414
  };
17888
18415
  /** tenant-fragment-summary */
@@ -18404,6 +18931,7 @@ export type TimelineEntryBaseSummary = AtomBaseSummary & {
18404
18931
  /** The type of object that the Timeline entry belongs to. */
18405
18932
  export declare enum TimelineEntryObjectType {
18406
18933
  Account = "account",
18934
+ Article = "article",
18407
18935
  Capability = "capability",
18408
18936
  CodeChange = "code_change",
18409
18937
  Conversation = "conversation",
@@ -19383,6 +19911,12 @@ export declare enum UserType {
19383
19911
  * UI hint overrides for a view.
19384
19912
  */
19385
19913
  export interface ViewOverride {
19914
+ /**
19915
+ * Number of decimal places to show. Only applicable for number
19916
+ * fields.
19917
+ * @format int32
19918
+ */
19919
+ decimal_places?: number;
19386
19920
  /**
19387
19921
  * The display name of the field.
19388
19922
  * @format text
@@ -19394,6 +19928,11 @@ export interface ViewOverride {
19394
19928
  is_hidden?: boolean;
19395
19929
  /** Whether the field is mandatory. */
19396
19930
  is_required?: boolean;
19931
+ /**
19932
+ * Relative order in which the field is shown.
19933
+ * @format int32
19934
+ */
19935
+ order?: number;
19397
19936
  /**
19398
19937
  * A placeholder for the field.
19399
19938
  * @format text
@@ -19404,6 +19943,11 @@ export interface ViewOverride {
19404
19943
  * @format text
19405
19944
  */
19406
19945
  tooltip?: string;
19946
+ /**
19947
+ * Whether to use shorthand notation. Example, 1K instead of 1000.
19948
+ * Only applicable for number fields.
19949
+ */
19950
+ use_shorthand_notation?: boolean;
19407
19951
  /**
19408
19952
  * The name of the view.
19409
19953
  * @format text
@@ -19574,6 +20118,54 @@ export declare enum VistaType {
19574
20118
  Dynamic = "dynamic",
19575
20119
  Grouped = "grouped"
19576
20120
  }
20121
+ /**
20122
+ * vistas-create-request
20123
+ * The request to create new vista.
20124
+ */
20125
+ export type VistasCreateRequest = VistasCreateRequestDynamicVista & {
20126
+ /** Type of vista object. */
20127
+ type: VistaType;
20128
+ custom_view?: CustomView;
20129
+ /**
20130
+ * Description of the vista.
20131
+ * @format text
20132
+ */
20133
+ description?: string;
20134
+ /**
20135
+ * Name of the vista.
20136
+ * @format text
20137
+ */
20138
+ name: string;
20139
+ /** Users and groups associated with vista. */
20140
+ shared_with?: SetSharedWithMembership[];
20141
+ };
20142
+ /** vistas-create-request-dynamic-vista */
20143
+ export type VistasCreateRequestDynamicVista = VistasCreateRequestDynamicVistaMeetingsVista & {
20144
+ /** Type of DevRev object for which the vista is applicable. */
20145
+ filter_type: DynamicVistaFilterType;
20146
+ };
20147
+ /** vistas-create-request-dynamic-vista-meetings-vista */
20148
+ export interface VistasCreateRequestDynamicVistaMeetingsVista {
20149
+ filter: MeetingsVistaFilter;
20150
+ /** Pinned items associated with the vista. */
20151
+ items?: VistasCreateRequestDynamicVistaMeetingsVistaItemValue[];
20152
+ }
20153
+ /** vistas-create-request-dynamic-vista-meetings-vista-item-value */
20154
+ export interface VistasCreateRequestDynamicVistaMeetingsVistaItemValue {
20155
+ /**
20156
+ * The ID of the item.
20157
+ * @format id
20158
+ */
20159
+ id: string;
20160
+ }
20161
+ /**
20162
+ * vistas-create-response
20163
+ * The response to vista creation.
20164
+ */
20165
+ export interface VistasCreateResponse {
20166
+ /** Represents a collection of DevRev objects. */
20167
+ vista: Vista;
20168
+ }
19577
20169
  /**
19578
20170
  * vistas-delete-request
19579
20171
  * The request to delete a vista.
@@ -19644,6 +20236,14 @@ export interface VistasGroupsGetResponse {
19644
20236
  export interface VistasGroupsListRequest {
19645
20237
  /** Filters for vista group items of the specific type. */
19646
20238
  type?: GroupItemType[];
20239
+ /**
20240
+ * Filters for vista group items which have one of the parts linked as
20241
+ * its ancestor part or primary part.
20242
+ * @example ["PROD-12345"]
20243
+ */
20244
+ ancestor_part?: string[];
20245
+ /** The filter for applies to part. */
20246
+ applies_to_part?: AppliesToPartFilter;
19647
20247
  /**
19648
20248
  * Filter for vistas group item created by any of these users.
19649
20249
  * @example ["DEVU-12345"]
@@ -19947,7 +20547,10 @@ export interface WebCrawlerJobsCreateRequest {
19947
20547
  * @format text
19948
20548
  */
19949
20549
  accept_regex?: string;
19950
- /** The list of regexes a URL must satisfy to be crawled. */
20550
+ /**
20551
+ * The list of regexes a URL must satisfy to be crawled.
20552
+ * @maxItems 100
20553
+ */
19951
20554
  accept_regexes?: string[];
19952
20555
  /**
19953
20556
  * The parts to which created webpage/articles during this crawler job
@@ -19992,13 +20595,23 @@ export interface WebCrawlerJobsCreateRequest {
19992
20595
  * The list of regexes which if satisfied by a URL results in
19993
20596
  * rejection of the URL. If a URL matches both accept and reject
19994
20597
  * regexes, it is rejected.
20598
+ * @maxItems 100
19995
20599
  */
19996
20600
  reject_regexes?: string[];
19997
- /** The list of sitemap index URLs to crawl. */
20601
+ /**
20602
+ * The list of sitemap index URLs to crawl.
20603
+ * @maxItems 2
20604
+ */
19998
20605
  sitemap_index_urls?: string[];
19999
- /** The list of sitemap URLs to crawl. */
20606
+ /**
20607
+ * The list of sitemap URLs to crawl.
20608
+ * @maxItems 2
20609
+ */
20000
20610
  sitemap_urls?: string[];
20001
- /** The list of URLs to crawl. */
20611
+ /**
20612
+ * The list of URLs to crawl.
20613
+ * @maxItems 50
20614
+ */
20002
20615
  urls?: string[];
20003
20616
  /**
20004
20617
  * User agent to use for crawling websites in this job.
@@ -20114,6 +20727,9 @@ export interface WebhookEventRequest {
20114
20727
  account_deleted?: EventAccountDeleted;
20115
20728
  account_updated?: EventAccountUpdated;
20116
20729
  ai_agent_response?: EventAiAgentResponse;
20730
+ article_created?: EventArticleCreated;
20731
+ article_deleted?: EventArticleDeleted;
20732
+ article_updated?: EventArticleUpdated;
20117
20733
  conversation_created?: EventConversationCreated;
20118
20734
  conversation_deleted?: EventConversationDeleted;
20119
20735
  conversation_updated?: EventConversationUpdated;
@@ -20212,6 +20828,9 @@ export declare enum WebhookEventType {
20212
20828
  AccountDeleted = "account_deleted",
20213
20829
  AccountUpdated = "account_updated",
20214
20830
  AiAgentResponse = "ai_agent_response",
20831
+ ArticleCreated = "article_created",
20832
+ ArticleDeleted = "article_deleted",
20833
+ ArticleUpdated = "article_updated",
20215
20834
  ConversationCreated = "conversation_created",
20216
20835
  ConversationDeleted = "conversation_deleted",
20217
20836
  ConversationUpdated = "conversation_updated",
@@ -22332,6 +22951,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22332
22951
  * @example ["DEVU-12345"]
22333
22952
  */
22334
22953
  owned_by?: string[];
22954
+ /** Filters for articles with the provided parent directories. */
22955
+ parent?: string[];
22335
22956
  /** Filter for the scope of the articles. */
22336
22957
  scope?: number[];
22337
22958
  /**
@@ -22465,6 +23086,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22465
23086
  * @example ["DEVU-12345"]
22466
23087
  */
22467
23088
  owned_by?: string[];
23089
+ /** Filters for articles with the provided parent directories. */
23090
+ parent?: string[];
22468
23091
  /** Filter for the scope of the articles. */
22469
23092
  scope?: number[];
22470
23093
  /**
@@ -25045,6 +25668,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25045
25668
  parent?: string[];
25046
25669
  /** Filters for meeting on specified state or outcomes. */
25047
25670
  state?: MeetingState[];
25671
+ /** Filters for issues with this specific external reference. */
25672
+ 'sync_metadata.external_reference'?: string[];
25673
+ /** Filters for works with selected sync statuses. */
25674
+ 'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
25675
+ /** Filters for works modified with selected sync history. */
25676
+ 'sync_metadata.last_sync_in.sync_history'?: string[];
25677
+ /** Filters for works modified with selected sync units. */
25678
+ 'sync_metadata.last_sync_in.sync_unit'?: string[];
25679
+ /** Filters for works with selected sync statuses. */
25680
+ 'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
25681
+ /** Filters for works modified with selected sync history. */
25682
+ 'sync_metadata.last_sync_out.sync_history'?: string[];
25683
+ /** Filters for works modified with selected sync units. */
25684
+ 'sync_metadata.last_sync_out.sync_unit'?: string[];
25685
+ /** Filters for issues synced from this specific origin system. */
25686
+ 'sync_metadata.origin_system'?: string[];
25048
25687
  /** Filters for meeting by tags. */
25049
25688
  tags?: string[];
25050
25689
  }, params?: RequestParams) => Promise<AxiosResponse<MeetingsCountResponse, any>>;
@@ -25167,6 +25806,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25167
25806
  sort_by?: string[];
25168
25807
  /** Filters for meeting on specified state or outcomes. */
25169
25808
  state?: MeetingState[];
25809
+ /** Filters for issues with this specific external reference. */
25810
+ 'sync_metadata.external_reference'?: string[];
25811
+ /** Filters for works with selected sync statuses. */
25812
+ 'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
25813
+ /** Filters for works modified with selected sync history. */
25814
+ 'sync_metadata.last_sync_in.sync_history'?: string[];
25815
+ /** Filters for works modified with selected sync units. */
25816
+ 'sync_metadata.last_sync_in.sync_unit'?: string[];
25817
+ /** Filters for works with selected sync statuses. */
25818
+ 'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
25819
+ /** Filters for works modified with selected sync history. */
25820
+ 'sync_metadata.last_sync_out.sync_history'?: string[];
25821
+ /** Filters for works modified with selected sync units. */
25822
+ 'sync_metadata.last_sync_out.sync_unit'?: string[];
25823
+ /** Filters for issues synced from this specific origin system. */
25824
+ 'sync_metadata.origin_system'?: string[];
25170
25825
  /** Filters for meeting by tags. */
25171
25826
  tags?: string[];
25172
25827
  }, params?: RequestParams) => Promise<AxiosResponse<MeetingsListResponse, any>>;
@@ -25725,6 +26380,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25725
26380
  * @example ["PROD-12345"]
25726
26381
  */
25727
26382
  'parent_part.parts'?: string[];
26383
+ /** Fields to sort the parts by and the direction to sort them. */
26384
+ sort_by?: string[];
25728
26385
  /** Filters for subtypes. */
25729
26386
  subtype?: string[];
25730
26387
  /**
@@ -26538,8 +27195,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26538
27195
  * @secure
26539
27196
  */
26540
27197
  aggregatedSchemaGet: (query?: {
26541
- /** The list of custom schema fragment DONs which are to be aggregated. */
26542
- custom_schema_fragment_ids?: string[];
27198
+ /** The custom schema fragment IDs which are to be aggregated. */
27199
+ custom_schema_fragments?: string[];
26543
27200
  /** List of apps. */
26544
27201
  'custom_schema_spec.apps'?: string[];
26545
27202
  /**
@@ -26559,7 +27216,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26559
27216
  * The stock schema fragment which is to be aggregated.
26560
27217
  * @format id
26561
27218
  */
26562
- stock_schema_fragment_id?: string;
27219
+ stock_schema_fragment?: string;
26563
27220
  }, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
26564
27221
  /**
26565
27222
  * @description Gets the aggregated schema.
@@ -28174,6 +28831,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
28174
28831
  * @secure
28175
28832
  */
28176
28833
  uomsUpdate: (data: UomsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<UomsUpdateResponse, any>>;
28834
+ /**
28835
+ * @description Creates a vista.
28836
+ *
28837
+ * @tags vistas
28838
+ * @name VistasCreate
28839
+ * @summary Create Vista
28840
+ * @request POST:/vistas.create
28841
+ * @secure
28842
+ */
28843
+ vistasCreate: (data: VistasCreateRequest, params?: RequestParams) => Promise<AxiosResponse<VistasCreateResponse, any>>;
28177
28844
  /**
28178
28845
  * @description Deletes the requested vista.
28179
28846
  *
@@ -28257,6 +28924,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
28257
28924
  * @secure
28258
28925
  */
28259
28926
  vistasGroupsList: (query?: {
28927
+ /**
28928
+ * Filters for vista group items which have one of the parts linked as
28929
+ * its ancestor part or primary part.
28930
+ * @example ["PROD-12345"]
28931
+ */
28932
+ ancestor_part?: string[];
28933
+ /**
28934
+ * Whether to include items belonging to children of any of the provided
28935
+ * parts.
28936
+ */
28937
+ 'applies_to_part.include_child_parts'?: boolean;
28938
+ /**
28939
+ * Part IDs to filter on. Required if any applies_to_part.* fields are
28940
+ * provided.
28941
+ * @example ["PROD-12345"]
28942
+ */
28943
+ 'applies_to_part.parts'?: string[];
28260
28944
  /**
28261
28945
  * Filter for vistas group item created by any of these users.
28262
28946
  * @example ["DEVU-12345"]