@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.
@@ -314,6 +314,85 @@ export interface AddTagWithValue {
314
314
  */
315
315
  value?: string;
316
316
  }
317
+ /**
318
+ * aggregated-schema
319
+ * List of custom fields from multiple source fragments.
320
+ */
321
+ export interface AggregatedSchema {
322
+ /**
323
+ * Apps corresponding to the app fragments used to populate the same
324
+ * in the object.
325
+ */
326
+ apps?: string[];
327
+ /** The conditions associated with the fields. */
328
+ conditions?: CustomSchemaFragmentCondition[];
329
+ /** List of all composite schemas used by custom fields. */
330
+ custom_composite_schemas: CompositeSchema[];
331
+ /** List of all custom fields in this schema. */
332
+ custom_fields: SchemaFieldDescriptor[];
333
+ /**
334
+ * Description of the schema.
335
+ * @format text
336
+ */
337
+ description?: string;
338
+ /**
339
+ * True when the fragments being aggregated correspond to a custom
340
+ * leaf type.
341
+ */
342
+ is_custom_leaf_type?: boolean;
343
+ /**
344
+ * Leaf type of the fragments being aggregated.
345
+ * @format text
346
+ */
347
+ leaf_type?: string;
348
+ stage_diagram_id?: StageDiagramSummary;
349
+ /** List of all composite schemas used by stock fields. */
350
+ stock_composite_schemas: CompositeSchema[];
351
+ /**
352
+ * Optional overrides for properties of stock fields. Overrides in the
353
+ * custom type fragment take precedence over those defined in the
354
+ * tenant fragment.
355
+ */
356
+ stock_field_overrides?: StockFieldOverride[];
357
+ /** List of all stock fields in this schema. */
358
+ stock_fields: SchemaFieldDescriptor[];
359
+ /**
360
+ * Subtype corresponding to the custom type fragment used to populate
361
+ * the same in the object.
362
+ * @format text
363
+ */
364
+ subtype?: string;
365
+ /**
366
+ * Display name of the subtype.
367
+ * @format text
368
+ */
369
+ subtype_display_name?: string;
370
+ }
371
+ /** aggregated-schema-get-request */
372
+ export interface AggregatedSchemaGetRequest {
373
+ /** The custom schema fragment IDs which are to be aggregated. */
374
+ custom_schema_fragments?: string[];
375
+ /** Custom schemas described using identifiers */
376
+ custom_schema_spec?: CustomSchemaSpecForRead;
377
+ /** Whether the leaf type corresponds to a custom object. */
378
+ is_custom_leaf_type?: boolean;
379
+ /**
380
+ * The leaf type. Used for inferring the default stage diagram and
381
+ * tenant fragment ID.
382
+ * @format text
383
+ */
384
+ leaf_type?: string;
385
+ /**
386
+ * The stock schema fragment which is to be aggregated.
387
+ * @format id
388
+ */
389
+ stock_schema_fragment?: string;
390
+ }
391
+ /** aggregated-schema-get-response */
392
+ export interface AggregatedSchemaGetResponse {
393
+ /** List of custom fields from multiple source fragments. */
394
+ schema: AggregatedSchema;
395
+ }
317
396
  /**
318
397
  * ai-agent-event-execute-error
319
398
  * An error object providing the error message for the AI agent event
@@ -421,6 +500,22 @@ export interface AiAgentSuggestion {
421
500
  */
422
501
  suggestion: string;
423
502
  }
503
+ /**
504
+ * applies-to-part-filter
505
+ * The filter for applies to part.
506
+ */
507
+ export interface AppliesToPartFilter {
508
+ /**
509
+ * Whether to include items belonging to children of any of the
510
+ * provided parts.
511
+ */
512
+ include_child_parts?: boolean;
513
+ /**
514
+ * Part IDs to filter on.
515
+ * @example ["PROD-12345"]
516
+ */
517
+ parts: string[];
518
+ }
424
519
  /**
425
520
  * archetype-metric-target
426
521
  * Metric with corresponding target values.
@@ -602,6 +697,18 @@ export declare enum ArticleStatus {
602
697
  Published = "published",
603
698
  ReviewNeeded = "review_needed"
604
699
  }
700
+ /** article-summary */
701
+ export type ArticleSummary = AtomBaseSummary & {
702
+ /** Type of the article. */
703
+ article_type?: ArticleType;
704
+ /** Resource details. */
705
+ resource?: ResourceSummary;
706
+ /**
707
+ * Title of the article.
708
+ * @format text
709
+ */
710
+ title?: string;
711
+ };
605
712
  /** Type of the article. */
606
713
  export declare enum ArticleType {
607
714
  Article = "article",
@@ -826,6 +933,8 @@ export interface ArticlesListRequest {
826
933
  * @example ["DEVU-12345"]
827
934
  */
828
935
  owned_by?: string[];
936
+ /** Filters for articles with the provided parent directories. */
937
+ parent?: string[];
829
938
  /** Filter for the scope of the articles. */
830
939
  scope?: number[];
831
940
  /** Filter for articles based on intended audience. */
@@ -1308,7 +1417,7 @@ export interface ArtifactsVersionsPrepareResponseFormData {
1308
1417
  value: string;
1309
1418
  }
1310
1419
  /** atom */
1311
- export type Atom = (AuthToken | Capability | Conversation | DevUser | Enhancement | Feature | Group | Issue | Link | Product | RevOrg | RevUser | ServiceAccount | Sla | SlaTracker | SysUser | Tag | Ticket | TimelineComment | Webhook) & {
1420
+ export type Atom = (Article | AuthToken | Capability | Conversation | DevUser | Enhancement | Feature | Group | Issue | Link | Product | RevOrg | RevUser | ServiceAccount | Sla | SlaTracker | SysUser | Tag | Ticket | TimelineComment | Webhook) & {
1312
1421
  type: AtomType;
1313
1422
  };
1314
1423
  /** atom-base */
@@ -1352,10 +1461,11 @@ export interface AtomBaseSummary {
1352
1461
  id: string;
1353
1462
  }
1354
1463
  /** atom-summary */
1355
- export type AtomSummary = (AuthTokenSummary | CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | GroupSummary | IssueSummary | LinkSummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SlaSummary | SlaTrackerSummary | SysUserSummary | TagSummary | TicketSummary | TimelineCommentSummary | WebhookSummary) & {
1464
+ export type AtomSummary = (ArticleSummary | AuthTokenSummary | CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | GroupSummary | IssueSummary | LinkSummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SlaSummary | SlaTrackerSummary | SysUserSummary | TagSummary | TicketSummary | TimelineCommentSummary | WebhookSummary) & {
1356
1465
  type: AtomType;
1357
1466
  };
1358
1467
  export declare enum AtomType {
1468
+ Article = "article",
1359
1469
  AuthToken = "auth_token",
1360
1470
  Capability = "capability",
1361
1471
  Conversation = "conversation",
@@ -2208,6 +2318,54 @@ export interface ChatsUpdateRequestDmUsers {
2208
2318
  export interface ChatsUpdateResponse {
2209
2319
  chat: Chat;
2210
2320
  }
2321
+ /**
2322
+ * client-override
2323
+ * UI hint overrides for a client.
2324
+ */
2325
+ export interface ClientOverride {
2326
+ /**
2327
+ * The name of the client.
2328
+ * @format text
2329
+ */
2330
+ client_name?: string;
2331
+ /**
2332
+ * Number of decimal places to show. Only applicable for number
2333
+ * fields.
2334
+ * @format int32
2335
+ */
2336
+ decimal_places?: number;
2337
+ /**
2338
+ * The display name of the field.
2339
+ * @format text
2340
+ */
2341
+ display_name?: string;
2342
+ /** Whether the field is groupable in the UI. */
2343
+ is_groupable?: boolean;
2344
+ /** Whether the field is hidden in the UI. */
2345
+ is_hidden?: boolean;
2346
+ /**
2347
+ * Relative order in which the field is shown.
2348
+ * @format int32
2349
+ */
2350
+ order?: number;
2351
+ /**
2352
+ * A placeholder for the field.
2353
+ * @format text
2354
+ */
2355
+ placeholder?: string;
2356
+ /**
2357
+ * Tooltip for the field.
2358
+ * @format text
2359
+ */
2360
+ tooltip?: string;
2361
+ /**
2362
+ * Whether to use shorthand notation. Example, 1K instead of 1000.
2363
+ * Only applicable for number fields.
2364
+ */
2365
+ use_shorthand_notation?: boolean;
2366
+ /** The view overrides for the client. */
2367
+ view_overrides?: ViewOverride[];
2368
+ }
2211
2369
  /** code-change */
2212
2370
  export type CodeChange = AtomBase & {
2213
2371
  /**
@@ -2636,6 +2794,24 @@ export interface CommandsListResponse {
2636
2794
  */
2637
2795
  prev_cursor?: string;
2638
2796
  }
2797
+ /**
2798
+ * composite-schema
2799
+ * The schema of a composite type.
2800
+ */
2801
+ export interface CompositeSchema {
2802
+ /**
2803
+ * Description of this composite type.
2804
+ * @format text
2805
+ */
2806
+ description?: string;
2807
+ /** List of all fields in this schema. */
2808
+ fields: SchemaFieldDescriptor[];
2809
+ /**
2810
+ * Name of this composite type.
2811
+ * @format text
2812
+ */
2813
+ name?: string;
2814
+ }
2639
2815
  /** conversation */
2640
2816
  export type Conversation = AtomBase & {
2641
2817
  /** Channel IDs of the conversation. */
@@ -2662,6 +2838,7 @@ export type Conversation = AtomBase & {
2662
2838
  * @format text
2663
2839
  */
2664
2840
  source_channel?: string;
2841
+ source_channel_v2?: ExternalCommunicationChannelSummary;
2665
2842
  /** Describes the current stage of a work item. */
2666
2843
  stage?: LegacyStage;
2667
2844
  /** Tags associated with the object. */
@@ -3145,6 +3322,34 @@ export interface CreateOrgScheduleInterval {
3145
3322
  */
3146
3323
  to?: string;
3147
3324
  }
3325
+ /** create-stage-node */
3326
+ export interface CreateStageNode {
3327
+ /** Whether this stage is deprecated. */
3328
+ is_deprecated?: boolean;
3329
+ /** Whether this is the start stage. */
3330
+ is_start?: boolean;
3331
+ /**
3332
+ * The ID of the stage.
3333
+ * @format id
3334
+ */
3335
+ stage_id: string;
3336
+ /** List of transitions from this stage. */
3337
+ transitions?: CreateStageTransition[];
3338
+ }
3339
+ /** create-stage-transition */
3340
+ export interface CreateStageTransition {
3341
+ /**
3342
+ * The ID of the target stage.
3343
+ * @format id
3344
+ */
3345
+ target_stage_id: string;
3346
+ ui?: CreateStageUiMetadata;
3347
+ }
3348
+ /** create-stage-ui-metadata */
3349
+ export interface CreateStageUiMetadata {
3350
+ /** Whether the stage is hidden. */
3351
+ is_hidden?: boolean;
3352
+ }
3148
3353
  /** create-weekly-org-schedule-interval */
3149
3354
  export interface CreateWeeklyOrgScheduleInterval {
3150
3355
  /**
@@ -3169,167 +3374,845 @@ export type CuratedVista = VistaBase & {
3169
3374
  /** Item list to store a curated list of DevRev objects. */
3170
3375
  items?: AtomSummary[];
3171
3376
  };
3172
- /**
3173
- * custom-schema-spec
3174
- * Custom schemas described using identifiers. Each custom field in the
3175
- * request must have the corresponding schema specified; omission results
3176
- * in a Bad Request error. If a custom schema is not included in the
3177
- * specifier, it remains unchanged. For surfaces with human interactors,
3178
- * it is recommended to provide tenant_fragment: true and
3179
- * validate_required_fields: true.
3180
- */
3181
- export interface CustomSchemaSpec {
3182
- /** List of apps. */
3183
- apps?: string[];
3377
+ /** custom-object */
3378
+ export type CustomObject = AtomBase & {
3184
3379
  /**
3185
- * Name of the subtype.
3380
+ * Type of the object.
3186
3381
  * @format text
3187
3382
  */
3188
- subtype?: string;
3189
- /** Whether the tenant schema is requested. */
3190
- tenant_fragment?: boolean;
3191
- /** Whether to enforce required fields validation. */
3192
- validate_required_fields?: boolean;
3193
- }
3194
- /** dashboard */
3195
- export type Dashboard = AtomBase;
3196
- /**
3197
- * date-filter
3198
- * Provides ways to specify date ranges on objects.
3199
- */
3200
- export type DateFilter = (DateTimeFilter | DateTimePreset) & {
3201
- /** Type of date filter. */
3202
- type: DateFilterType;
3203
- };
3204
- /** Type of date filter. */
3205
- export declare enum DateFilterType {
3206
- Preset = "preset",
3207
- Range = "range"
3208
- }
3209
- /** date-time-filter */
3210
- export interface DateTimeFilter {
3383
+ leaf_type?: string;
3384
+ /** Describes the current stage of a object. */
3385
+ stage?: Stage;
3211
3386
  /**
3212
- * Filters for objects created after the provided timestamp
3213
- * (inclusive).
3214
- * @format date-time
3215
- * @example "2023-01-01T12:00:00.000Z"
3387
+ * Title of the object.
3388
+ * @format text
3216
3389
  */
3217
- after?: string;
3390
+ title?: string;
3218
3391
  /**
3219
- * Filters for objects created before the provided timestamp
3220
- * (inclusive).
3221
- * @format date-time
3222
- * @example "2023-01-01T12:00:00.000Z"
3392
+ * A unique key that, if provided, ensures the combination of
3393
+ * {leaf_type, unique_key} is distinct across all objects in the
3394
+ * system.
3395
+ * @format text
3223
3396
  */
3224
- before?: string;
3225
- }
3226
- /**
3227
- * date-time-preset
3228
- * Provides preset types for date filter.
3229
- */
3230
- export type DateTimePreset = (DateTimePresetLastNDays | DateTimePresetNextNDays) & {
3231
- /** Type of date preset. */
3232
- preset_type: DateTimePresetType;
3397
+ unique_key?: string;
3233
3398
  };
3234
- /** date-time-preset-last-n-days */
3235
- export interface DateTimePresetLastNDays {
3399
+ /** custom-objects-count-request */
3400
+ export interface CustomObjectsCountRequest {
3401
+ /** List of filters to apply. */
3402
+ filters?: any[];
3236
3403
  /**
3237
- * The range starts from the current timestamp and continues for the
3238
- * past n days.
3239
- * @min 0
3240
- * @max 4294967295
3404
+ * Leaf type to filter.
3405
+ * @format text
3241
3406
  */
3242
- days: number;
3407
+ leaf_type: string;
3243
3408
  }
3244
- /** date-time-preset-next-n-days */
3245
- export interface DateTimePresetNextNDays {
3409
+ /** custom-objects-count-response */
3410
+ export interface CustomObjectsCountResponse {
3246
3411
  /**
3247
- * The range starts from the current timestamp and continues for the
3248
- * next n days.
3249
- * @min 0
3250
- * @max 4294967295
3412
+ * The count of custom objects.
3413
+ * @format int64
3251
3414
  */
3252
- days: number;
3253
- }
3254
- /** Type of date preset. */
3255
- export declare enum DateTimePresetType {
3256
- LastNDays = "last_n_days",
3257
- NextNDays = "next_n_days"
3258
- }
3259
- /** Indicates whether this evaluation can change in the future. */
3260
- export declare enum Definedness {
3261
- Immutable = "immutable",
3262
- Mutable = "mutable",
3263
- Undefined = "undefined"
3415
+ count: number;
3264
3416
  }
3265
- /** dev-org */
3266
- export type DevOrg = OrgBase;
3267
- /**
3268
- * dev-org-auth-connections-create-request
3269
- * Request to create a new enterprise authentication connection.
3270
- */
3271
- export type DevOrgAuthConnectionsCreateRequest = (DevOrgAuthConnectionsCreateRequestAzureAdOptions | DevOrgAuthConnectionsCreateRequestGoogleAppsOptions | DevOrgAuthConnectionsCreateRequestOidcOptions | DevOrgAuthConnectionsCreateRequestOktaOptions | DevOrgAuthConnectionsCreateRequestSamlOptions) & {
3417
+ /** custom-objects-create-request */
3418
+ export interface CustomObjectsCreateRequest {
3419
+ /** Custom fields of the custom object. */
3420
+ custom_fields?: object;
3272
3421
  /**
3273
- * Defines the type for the authentication connection. Different types of
3274
- * authentication connections have different configuration parameters.
3422
+ * Custom schemas described using identifiers. Each custom field in the
3423
+ * request must have the corresponding schema specified; omission results
3424
+ * in a Bad Request error. If a custom schema is not included in the
3425
+ * specifier, it remains unchanged. For surfaces with human interactors,
3426
+ * it is recommended to provide tenant_fragment: true and
3427
+ * validate_required_fields: true.
3275
3428
  */
3276
- type: DevOrgAuthConnectionsCreateRequestType;
3429
+ custom_schema_spec?: CustomSchemaSpec;
3277
3430
  /**
3278
- * Display name of the authentication connection. This name will be
3279
- * visible to all the users when they sign in to this Dev
3280
- * organization. For example, if the display_name is 'abclogin', then
3281
- * it would appear on the login button as 'Log in to abclogin'.
3431
+ * Leaf type of the custom object.
3282
3432
  * @format text
3283
- * @minLength 1
3284
- * @maxLength 128
3285
3433
  */
3286
- display_name?: string;
3287
- };
3288
- /**
3289
- * dev-org-auth-connections-create-request-azure-ad-options
3290
- * Object encapsulating the configuration parameters for an Azure AD
3291
- * authentication connection.
3292
- * @deprecated
3293
- */
3294
- export interface DevOrgAuthConnectionsCreateRequestAzureAdOptions {
3434
+ leaf_type: string;
3295
3435
  /**
3296
- * Client ID for the Azure authentication connection.
3297
- * @format text
3436
+ * The stage of the custom object.
3437
+ * @format id
3298
3438
  */
3299
- client_id: string;
3439
+ stage?: string;
3300
3440
  /**
3301
- * Client secret for the Azure authentication connection.
3302
- * @format text
3441
+ * The type of stage validations options when creating a custom
3442
+ * object.
3303
3443
  */
3304
- client_secret: string;
3444
+ stage_validation_options?: StageValidationOptionForCreate[];
3305
3445
  /**
3306
- * Domain URL of the Azure authentication connection.
3446
+ * Title of the custom object.
3307
3447
  * @format text
3308
3448
  */
3309
- domain: string;
3310
- }
3311
- /**
3312
- * dev-org-auth-connections-create-request-google-apps-options
3313
- * Object encapsulating the configuration parameters for a Google Apps
3314
- * authentication connection.
3315
- * @deprecated
3316
- */
3317
- export interface DevOrgAuthConnectionsCreateRequestGoogleAppsOptions {
3449
+ title?: string;
3318
3450
  /**
3319
- * Client ID for the Google Apps authentication connection.
3451
+ * The unique key of the custom object.This can be used to hold an
3452
+ * external reference to another object.
3320
3453
  * @format text
3321
3454
  */
3322
- client_id: string;
3455
+ unique_key?: string;
3456
+ }
3457
+ /** custom-objects-create-response */
3458
+ export interface CustomObjectsCreateResponse {
3459
+ custom_object: CustomObject;
3460
+ }
3461
+ /** custom-objects-delete-request */
3462
+ export interface CustomObjectsDeleteRequest {
3323
3463
  /**
3324
- * Client secret for the Google Apps authentication connection.
3325
- * @format text
3464
+ * The ID of the custom object to get.
3465
+ * @format id
3326
3466
  */
3327
- client_secret: string;
3467
+ id: string;
3468
+ }
3469
+ /** custom-objects-delete-response */
3470
+ export type CustomObjectsDeleteResponse = object;
3471
+ /** custom-objects-get-request */
3472
+ export interface CustomObjectsGetRequest {
3328
3473
  /**
3329
- * Tenant domain URL of the Google Apps authentication connection.
3330
- * @format text
3474
+ * The ID of the custom object to get.
3475
+ * @format id
3331
3476
  */
3332
- tenant_domain: string;
3477
+ id?: string;
3478
+ }
3479
+ /** custom-objects-get-response */
3480
+ export interface CustomObjectsGetResponse {
3481
+ custom_object: CustomObject;
3482
+ }
3483
+ /** custom-objects-list-request */
3484
+ export interface CustomObjectsListRequest {
3485
+ /**
3486
+ * The cursor to resume iteration from. If not provided, then
3487
+ * iteration starts from the beginning.
3488
+ * @format text
3489
+ */
3490
+ cursor?: string;
3491
+ /** List of filters to apply. */
3492
+ filter?: any[];
3493
+ /** List of filters to apply. */
3494
+ filters?: any[];
3495
+ /**
3496
+ * Leaf type to filter.
3497
+ * @format text
3498
+ */
3499
+ leaf_type: string;
3500
+ /**
3501
+ * The maximum number of items.
3502
+ * @format int32
3503
+ */
3504
+ limit?: number;
3505
+ /**
3506
+ * The iteration mode to use. If "after", then entries after the provided
3507
+ * cursor will be returned, or if no cursor is provided, then from the
3508
+ * beginning. If "before", then entries before the provided cursor will be
3509
+ * returned, or if no cursor is provided, then from the end. Entries will
3510
+ * always be returned in the specified sort-by order.
3511
+ */
3512
+ mode?: ListMode;
3513
+ /** The list of fields to sort the items by and how to sort them. */
3514
+ sort_by?: string[];
3515
+ }
3516
+ /**
3517
+ * custom-objects-list-response
3518
+ * The response to listing all custom objects matching the filter
3519
+ * criteria.
3520
+ */
3521
+ export interface CustomObjectsListResponse {
3522
+ /**
3523
+ * The cursor used to iterate subsequent results in accordance to the
3524
+ * sort order. If not set, then no later elements exist.
3525
+ * @format text
3526
+ */
3527
+ next_cursor?: string;
3528
+ /**
3529
+ * The cursor used to iterate preceding results in accordance to the
3530
+ * sort order. If not set, then no prior elements exist.
3531
+ * @format text
3532
+ */
3533
+ prev_cursor?: string;
3534
+ /** The custom objects. */
3535
+ result: CustomObject[];
3536
+ }
3537
+ /** custom-objects-update-request */
3538
+ export interface CustomObjectsUpdateRequest {
3539
+ /** Custom fields of the custom object. */
3540
+ custom_fields?: object;
3541
+ /**
3542
+ * Custom schemas described using identifiers. Each custom field in the
3543
+ * request must have the corresponding schema specified; omission results
3544
+ * in a Bad Request error. If a custom schema is not included in the
3545
+ * specifier, it remains unchanged. For surfaces with human interactors,
3546
+ * it is recommended to provide tenant_fragment: true and
3547
+ * validate_required_fields: true.
3548
+ */
3549
+ custom_schema_spec?: CustomSchemaSpec;
3550
+ /**
3551
+ * The ID of the custom object to update.
3552
+ * @format id
3553
+ */
3554
+ id: string;
3555
+ /**
3556
+ * Updates the stage of the custom object.
3557
+ * @format id
3558
+ */
3559
+ stage?: string | null;
3560
+ /**
3561
+ * The type of stage validations options when updating the stage or
3562
+ * the stage diagram of a custom object.
3563
+ */
3564
+ stage_validation_options?: StageValidationOptionForUpdate[];
3565
+ /**
3566
+ * Updates the title of the custom object.
3567
+ * @format text
3568
+ */
3569
+ title?: string | null;
3570
+ }
3571
+ /** custom-objects-update-response */
3572
+ export interface CustomObjectsUpdateResponse {
3573
+ custom_object: CustomObject;
3574
+ }
3575
+ /** custom-schema-fragment */
3576
+ export interface CustomSchemaFragment {
3577
+ type: CustomSchemaFragmentType;
3578
+ }
3579
+ /**
3580
+ * custom-schema-fragment-condition
3581
+ * The condition associated with a field.
3582
+ */
3583
+ export interface CustomSchemaFragmentCondition {
3584
+ /** The associated effects when the expression evaluates to true. */
3585
+ effects?: CustomSchemaFragmentEffect[];
3586
+ /**
3587
+ * The expression to evaluate.
3588
+ * @format text
3589
+ */
3590
+ expression?: string;
3591
+ }
3592
+ /**
3593
+ * custom-schema-fragment-effect
3594
+ * An effect associated with a condition.
3595
+ */
3596
+ export interface CustomSchemaFragmentEffect {
3597
+ /**
3598
+ * Allowed values for the fields based on the condition. This takes
3599
+ * precedence over allowed_values in field_descriptor.
3600
+ */
3601
+ allowed_values?: string[];
3602
+ /** The fields which are affected by the condition. */
3603
+ fields: string[];
3604
+ /**
3605
+ * Whether the fields should be made immutable or not based on the
3606
+ * condition.
3607
+ */
3608
+ immutable?: boolean;
3609
+ /**
3610
+ * Whether the fields are required or not based on the condition. This
3611
+ * takes precedence over is_required in field_descriptor.
3612
+ */
3613
+ require?: boolean;
3614
+ /** Whether the fields are shown or not based on the condition. */
3615
+ show?: boolean;
3616
+ }
3617
+ export type CustomSchemaFragmentType = string;
3618
+ /** custom-schema-fragments-get-request */
3619
+ export interface CustomSchemaFragmentsGetRequest {
3620
+ /**
3621
+ * The ID of the custom schema fragment.
3622
+ * @format id
3623
+ */
3624
+ id: string;
3625
+ }
3626
+ /** custom-schema-fragments-get-response */
3627
+ export interface CustomSchemaFragmentsGetResponse {
3628
+ fragment: CustomSchemaFragment;
3629
+ }
3630
+ /** custom-schema-fragments-list-request */
3631
+ export interface CustomSchemaFragmentsListRequest {
3632
+ /** The list of app names. */
3633
+ app?: string[];
3634
+ /**
3635
+ * The cursor to resume iteration from. If not provided, then
3636
+ * iteration starts from the beginning.
3637
+ * @format text
3638
+ */
3639
+ cursor?: string;
3640
+ /**
3641
+ * Whether only deprecated fragments should be filtered.
3642
+ * @deprecated
3643
+ */
3644
+ deprecated?: boolean;
3645
+ /** Whether the leaf type corresponds to a custom object */
3646
+ is_custom_leaf_type?: boolean;
3647
+ /** Whether the fragment has been deprecated. */
3648
+ is_deprecated?: boolean;
3649
+ /** The list of leaf types. */
3650
+ leaf_type?: string[];
3651
+ /**
3652
+ * The maximum number of items.
3653
+ * @format int32
3654
+ */
3655
+ limit?: number;
3656
+ /**
3657
+ * The iteration mode to use. If "after", then entries after the provided
3658
+ * cursor will be returned, or if no cursor is provided, then from the
3659
+ * beginning. If "before", then entries before the provided cursor will be
3660
+ * returned, or if no cursor is provided, then from the end. Entries will
3661
+ * always be returned in the specified sort-by order.
3662
+ */
3663
+ mode?: ListMode;
3664
+ /**
3665
+ * List of fields which are not required in the payload and can be
3666
+ * pruned away.
3667
+ */
3668
+ prune?: CustomSchemaFragmentsListRequestPrune[];
3669
+ /** The list of fields to sort the items by and how to sort them. */
3670
+ sort_by?: string[];
3671
+ /** The list of subtypes. */
3672
+ subtype?: string[];
3673
+ /** Filters for custom schema fragment of the provided types. */
3674
+ types?: CustomSchemaFragmentType[];
3675
+ }
3676
+ export declare enum CustomSchemaFragmentsListRequestPrune {
3677
+ Fields = "fields"
3678
+ }
3679
+ /** custom-schema-fragments-list-response */
3680
+ export interface CustomSchemaFragmentsListResponse {
3681
+ /**
3682
+ * The cursor used to iterate subsequent results in accordance to the
3683
+ * sort order. If not set, then no later elements exist.
3684
+ * @format text
3685
+ */
3686
+ next_cursor?: string;
3687
+ /**
3688
+ * The cursor used to iterate preceding results in accordance to the
3689
+ * sort order. If not set, then no prior elements exist.
3690
+ * @format text
3691
+ */
3692
+ prev_cursor?: string;
3693
+ /** The custom schema fragments. */
3694
+ result: CustomSchemaFragment[];
3695
+ }
3696
+ /** custom-schema-fragments-set-request */
3697
+ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAppFragment | CustomSchemaFragmentsSetRequestCustomTypeFragment | CustomSchemaFragmentsSetRequestTenantFragment) & {
3698
+ type: CustomSchemaFragmentsSetRequestType;
3699
+ /** List of all composite schemas used in this fragment. */
3700
+ composite_schemas?: CustomSchemaFragmentsSetRequestCompositeSchema[];
3701
+ /** List of conditions for this fragment. */
3702
+ conditions?: CustomSchemaFragmentCondition[];
3703
+ /** List of field names which are being dropped. */
3704
+ deleted_fields?: string[];
3705
+ /**
3706
+ * Whether this fragment has been deprecated.
3707
+ * @deprecated
3708
+ */
3709
+ deprecated?: boolean;
3710
+ /**
3711
+ * The description of the custom schema fragment.
3712
+ * @format text
3713
+ */
3714
+ description: string;
3715
+ /** List of all fields in this fragment. */
3716
+ fields?: SchemaFieldDescriptor[];
3717
+ /** Whether the leaf type corresponds to a custom object */
3718
+ is_custom_leaf_type?: boolean;
3719
+ /** Whether this fragment has been deprecated. */
3720
+ is_deprecated?: boolean;
3721
+ /**
3722
+ * The leaf type this fragment applies to.
3723
+ * @format text
3724
+ */
3725
+ leaf_type: string;
3726
+ };
3727
+ /** custom-schema-fragments-set-request-app-fragment */
3728
+ export interface CustomSchemaFragmentsSetRequestAppFragment {
3729
+ /**
3730
+ * The app this fragment applies to.
3731
+ * @format text
3732
+ */
3733
+ app: string;
3734
+ /**
3735
+ * The display name of the app.
3736
+ * @format text
3737
+ */
3738
+ app_display_name?: string;
3739
+ }
3740
+ /** custom-schema-fragments-set-request-composite-schema */
3741
+ export interface CustomSchemaFragmentsSetRequestCompositeSchema {
3742
+ /**
3743
+ * Description of this composite type.
3744
+ * @format text
3745
+ */
3746
+ description?: string;
3747
+ /** List of fields in this composite type. */
3748
+ fields: SchemaFieldDescriptor[];
3749
+ /**
3750
+ * The name of this composite type.
3751
+ * @format text
3752
+ */
3753
+ name?: string;
3754
+ }
3755
+ /** custom-schema-fragments-set-request-custom-type-fragment */
3756
+ export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
3757
+ /**
3758
+ * Path components used to display available custom types in tree
3759
+ * form.
3760
+ */
3761
+ path?: CustomTypePathComponent[];
3762
+ /**
3763
+ * The ID of the associated custom stage diagram.
3764
+ * @format id
3765
+ */
3766
+ stage_diagram?: string;
3767
+ /** List of Per-DevOrg stock field overrides. */
3768
+ stock_field_overrides?: StockFieldOverride[];
3769
+ /**
3770
+ * The string used to populate the subtype in the leaf type.
3771
+ * @format text
3772
+ */
3773
+ subtype: string;
3774
+ /**
3775
+ * The display name of the subtype.
3776
+ * @format text
3777
+ */
3778
+ subtype_display_name?: string;
3779
+ }
3780
+ /** custom-schema-fragments-set-request-tenant-fragment */
3781
+ export interface CustomSchemaFragmentsSetRequestTenantFragment {
3782
+ /**
3783
+ * The display ID prefix for the custom object.
3784
+ * @format text
3785
+ * @pattern ^[A-Z]{2,10}$
3786
+ */
3787
+ id_prefix?: string;
3788
+ /** List of Per-DevOrg stock field overrides. */
3789
+ stock_field_overrides?: StockFieldOverride[];
3790
+ }
3791
+ export declare enum CustomSchemaFragmentsSetRequestType {
3792
+ AppFragment = "app_fragment",
3793
+ CustomTypeFragment = "custom_type_fragment",
3794
+ TenantFragment = "tenant_fragment"
3795
+ }
3796
+ /** custom-schema-fragments-set-response */
3797
+ export interface CustomSchemaFragmentsSetResponse {
3798
+ /**
3799
+ * The ID of the custom schema fragment.
3800
+ * @format id
3801
+ */
3802
+ id: string;
3803
+ }
3804
+ /**
3805
+ * custom-schema-spec
3806
+ * Custom schemas described using identifiers. Each custom field in the
3807
+ * request must have the corresponding schema specified; omission results
3808
+ * in a Bad Request error. If a custom schema is not included in the
3809
+ * specifier, it remains unchanged. For surfaces with human interactors,
3810
+ * it is recommended to provide tenant_fragment: true and
3811
+ * validate_required_fields: true.
3812
+ */
3813
+ export interface CustomSchemaSpec {
3814
+ /** List of apps. */
3815
+ apps?: string[];
3816
+ /**
3817
+ * Name of the subtype.
3818
+ * @format text
3819
+ */
3820
+ subtype?: string;
3821
+ /** Whether the tenant schema is requested. */
3822
+ tenant_fragment?: boolean;
3823
+ /** Whether to enforce required fields validation. */
3824
+ validate_required_fields?: boolean;
3825
+ }
3826
+ /**
3827
+ * custom-schema-spec-for-read
3828
+ * Custom schemas described using identifiers
3829
+ */
3830
+ export interface CustomSchemaSpecForRead {
3831
+ /** List of apps. */
3832
+ apps?: string[];
3833
+ /**
3834
+ * Name of the subtype.
3835
+ * @format text
3836
+ */
3837
+ subtype?: string;
3838
+ }
3839
+ /** custom-stage */
3840
+ export type CustomStage = AtomBase & {
3841
+ /**
3842
+ * The human readable name of the stage.
3843
+ * @format text
3844
+ */
3845
+ name?: string;
3846
+ /**
3847
+ * Position of the stage in the global stage ordering.
3848
+ * @format int32
3849
+ */
3850
+ ordinal?: number;
3851
+ state?: CustomStateSummary;
3852
+ };
3853
+ /** custom-stage-summary */
3854
+ export type CustomStageSummary = AtomBaseSummary & {
3855
+ /**
3856
+ * The human readable name of the stage.
3857
+ * @format text
3858
+ */
3859
+ name?: string;
3860
+ };
3861
+ /** custom-stages-create-request */
3862
+ export interface CustomStagesCreateRequest {
3863
+ /**
3864
+ * A reference to the marketplace item from which this stage was
3865
+ * imported.
3866
+ * @format id
3867
+ */
3868
+ marketplace_ref?: string;
3869
+ /**
3870
+ * The name of the custom stage.
3871
+ * @format text
3872
+ */
3873
+ name: string;
3874
+ /**
3875
+ * The ordinal of the custom stage used for ordering.
3876
+ * @format int32
3877
+ */
3878
+ ordinal: number;
3879
+ /**
3880
+ * The state ID.
3881
+ * @format id
3882
+ */
3883
+ state: string;
3884
+ }
3885
+ /** custom-stages-create-response */
3886
+ export interface CustomStagesCreateResponse {
3887
+ custom_stage: CustomStage;
3888
+ }
3889
+ /** custom-stages-get-request */
3890
+ export interface CustomStagesGetRequest {
3891
+ /**
3892
+ * The ID of the custom stage to get.
3893
+ * @format id
3894
+ */
3895
+ id: string;
3896
+ }
3897
+ /** custom-stages-get-response */
3898
+ export interface CustomStagesGetResponse {
3899
+ custom_stage: CustomStage;
3900
+ }
3901
+ /** custom-stages-list-request */
3902
+ export interface CustomStagesListRequest {
3903
+ /**
3904
+ * The cursor to resume iteration from, otherwise if not provided,
3905
+ * then iteration starts from the beginning.
3906
+ * @format text
3907
+ */
3908
+ cursor?: string;
3909
+ /**
3910
+ * The maximum number of items.
3911
+ * @format int32
3912
+ */
3913
+ limit?: number;
3914
+ /** The list of stage names. */
3915
+ name?: string[];
3916
+ /** The list of stage ordinals. */
3917
+ ordinal?: number[];
3918
+ /** The list of fields to sort the items by and how to sort them. */
3919
+ sort_by?: string[];
3920
+ }
3921
+ /** custom-stages-list-response */
3922
+ export interface CustomStagesListResponse {
3923
+ /**
3924
+ * The cursor to resume iteration from, otherwise if not provided,
3925
+ * then iteration starts from the beginning.
3926
+ * @format text
3927
+ */
3928
+ cursor?: string;
3929
+ /** The custom stages. */
3930
+ result: CustomStage[];
3931
+ }
3932
+ /** custom-stages-update-request */
3933
+ export interface CustomStagesUpdateRequest {
3934
+ /**
3935
+ * The ID of the custom stage to update.
3936
+ * @format id
3937
+ */
3938
+ id: string;
3939
+ /**
3940
+ * The updated name of the custom stage.
3941
+ * @format text
3942
+ */
3943
+ name?: string;
3944
+ /**
3945
+ * The ordinal of the custom stage.
3946
+ * @format int32
3947
+ */
3948
+ ordinal?: number;
3949
+ /**
3950
+ * The state ID.
3951
+ * @format id
3952
+ */
3953
+ state_id?: string;
3954
+ }
3955
+ /** custom-stages-update-response */
3956
+ export interface CustomStagesUpdateResponse {
3957
+ custom_stage: CustomStage;
3958
+ }
3959
+ /** custom-state */
3960
+ export type CustomState = AtomBase & {
3961
+ /** True if this is a final state. */
3962
+ is_final?: boolean;
3963
+ /**
3964
+ * The human readable name of the state.
3965
+ * @format text
3966
+ */
3967
+ name?: string;
3968
+ /**
3969
+ * Position of the state in the global state ordering.
3970
+ * @format int32
3971
+ */
3972
+ ordinal?: number;
3973
+ };
3974
+ /** custom-state-summary */
3975
+ export type CustomStateSummary = AtomBaseSummary & {
3976
+ /** True if this is a final state. */
3977
+ is_final?: boolean;
3978
+ /**
3979
+ * The human readable name of the state.
3980
+ * @format text
3981
+ */
3982
+ name?: string;
3983
+ };
3984
+ /** custom-states-create-request */
3985
+ export interface CustomStatesCreateRequest {
3986
+ /** Whether this is a final state. */
3987
+ is_final?: boolean;
3988
+ /**
3989
+ * The name of the custom state.
3990
+ * @format text
3991
+ */
3992
+ name: string;
3993
+ /**
3994
+ * Ordinal of the custom state used to identify system states.
3995
+ * @format int32
3996
+ */
3997
+ ordinal: number;
3998
+ }
3999
+ /** custom-states-create-response */
4000
+ export interface CustomStatesCreateResponse {
4001
+ custom_state: CustomState;
4002
+ }
4003
+ /** custom-states-get-request */
4004
+ export interface CustomStatesGetRequest {
4005
+ /**
4006
+ * The ID of the custom state to get.
4007
+ * @format id
4008
+ */
4009
+ id: string;
4010
+ }
4011
+ /** custom-states-get-response */
4012
+ export interface CustomStatesGetResponse {
4013
+ custom_state: CustomState;
4014
+ }
4015
+ /** custom-states-list-request */
4016
+ export interface CustomStatesListRequest {
4017
+ /**
4018
+ * The cursor to resume iteration from, otherwise if not provided,
4019
+ * then iteration starts from the beginning.
4020
+ * @format text
4021
+ */
4022
+ cursor?: string;
4023
+ /** Whether only final states should be filtered. */
4024
+ is_final?: boolean;
4025
+ /**
4026
+ * The maximum number of items.
4027
+ * @format int32
4028
+ */
4029
+ limit?: number;
4030
+ /** The list of state names. */
4031
+ name?: string[];
4032
+ /** The list of state ordinals. */
4033
+ ordinal?: number[];
4034
+ /** The list of fields to sort the items by and how to sort them. */
4035
+ sort_by?: string[];
4036
+ }
4037
+ /** custom-states-list-response */
4038
+ export interface CustomStatesListResponse {
4039
+ /**
4040
+ * The cursor to resume iteration from, otherwise if not provided,
4041
+ * then iteration starts from the beginning.
4042
+ * @format text
4043
+ */
4044
+ cursor?: string;
4045
+ /** The custom states. */
4046
+ result: CustomState[];
4047
+ }
4048
+ /** custom-states-update-request */
4049
+ export interface CustomStatesUpdateRequest {
4050
+ /**
4051
+ * The ID of the custom state to update.
4052
+ * @format id
4053
+ */
4054
+ id: string;
4055
+ /** Whether this is a final state. */
4056
+ is_final?: boolean;
4057
+ /**
4058
+ * The name of the custom state.
4059
+ * @format text
4060
+ */
4061
+ name?: string;
4062
+ /**
4063
+ * Ordinal of the custom state used to identify system states.
4064
+ * @format int32
4065
+ */
4066
+ ordinal?: number;
4067
+ }
4068
+ /** custom-states-update-response */
4069
+ export interface CustomStatesUpdateResponse {
4070
+ custom_state: CustomState;
4071
+ }
4072
+ /**
4073
+ * custom-type-path-component
4074
+ * Path component for rendering custom type lists in tree form.
4075
+ */
4076
+ export type CustomTypePathComponent = object;
4077
+ /** dashboard */
4078
+ export type Dashboard = AtomBase;
4079
+ /**
4080
+ * date-filter
4081
+ * Provides ways to specify date ranges on objects.
4082
+ */
4083
+ export type DateFilter = (DateTimeFilter | DateTimePreset) & {
4084
+ /** Type of date filter. */
4085
+ type: DateFilterType;
4086
+ };
4087
+ /** Type of date filter. */
4088
+ export declare enum DateFilterType {
4089
+ Preset = "preset",
4090
+ Range = "range"
4091
+ }
4092
+ /** date-time-filter */
4093
+ export interface DateTimeFilter {
4094
+ /**
4095
+ * Filters for objects created after the provided timestamp
4096
+ * (inclusive).
4097
+ * @format date-time
4098
+ * @example "2023-01-01T12:00:00.000Z"
4099
+ */
4100
+ after?: string;
4101
+ /**
4102
+ * Filters for objects created before the provided timestamp
4103
+ * (inclusive).
4104
+ * @format date-time
4105
+ * @example "2023-01-01T12:00:00.000Z"
4106
+ */
4107
+ before?: string;
4108
+ }
4109
+ /**
4110
+ * date-time-preset
4111
+ * Provides preset types for date filter.
4112
+ */
4113
+ export type DateTimePreset = (DateTimePresetLastNDays | DateTimePresetNextNDays) & {
4114
+ /** Type of date preset. */
4115
+ preset_type: DateTimePresetType;
4116
+ };
4117
+ /** date-time-preset-last-n-days */
4118
+ export interface DateTimePresetLastNDays {
4119
+ /**
4120
+ * The range starts from the current timestamp and continues for the
4121
+ * past n days.
4122
+ * @min 0
4123
+ * @max 4294967295
4124
+ */
4125
+ days: number;
4126
+ }
4127
+ /** date-time-preset-next-n-days */
4128
+ export interface DateTimePresetNextNDays {
4129
+ /**
4130
+ * The range starts from the current timestamp and continues for the
4131
+ * next n days.
4132
+ * @min 0
4133
+ * @max 4294967295
4134
+ */
4135
+ days: number;
4136
+ }
4137
+ /** Type of date preset. */
4138
+ export declare enum DateTimePresetType {
4139
+ LastNDays = "last_n_days",
4140
+ NextNDays = "next_n_days"
4141
+ }
4142
+ /** Indicates whether this evaluation can change in the future. */
4143
+ export declare enum Definedness {
4144
+ Immutable = "immutable",
4145
+ Mutable = "mutable",
4146
+ Undefined = "undefined"
4147
+ }
4148
+ /** dev-org */
4149
+ export type DevOrg = OrgBase;
4150
+ /**
4151
+ * dev-org-auth-connections-create-request
4152
+ * Request to create a new enterprise authentication connection.
4153
+ */
4154
+ export type DevOrgAuthConnectionsCreateRequest = (DevOrgAuthConnectionsCreateRequestAzureAdOptions | DevOrgAuthConnectionsCreateRequestGoogleAppsOptions | DevOrgAuthConnectionsCreateRequestOidcOptions | DevOrgAuthConnectionsCreateRequestOktaOptions | DevOrgAuthConnectionsCreateRequestSamlOptions) & {
4155
+ /**
4156
+ * Defines the type for the authentication connection. Different types of
4157
+ * authentication connections have different configuration parameters.
4158
+ */
4159
+ type: DevOrgAuthConnectionsCreateRequestType;
4160
+ /**
4161
+ * Display name of the authentication connection. This name will be
4162
+ * visible to all the users when they sign in to this Dev
4163
+ * organization. For example, if the display_name is 'abclogin', then
4164
+ * it would appear on the login button as 'Log in to abclogin'.
4165
+ * @format text
4166
+ * @minLength 1
4167
+ * @maxLength 128
4168
+ */
4169
+ display_name?: string;
4170
+ };
4171
+ /**
4172
+ * dev-org-auth-connections-create-request-azure-ad-options
4173
+ * Object encapsulating the configuration parameters for an Azure AD
4174
+ * authentication connection.
4175
+ * @deprecated
4176
+ */
4177
+ export interface DevOrgAuthConnectionsCreateRequestAzureAdOptions {
4178
+ /**
4179
+ * Client ID for the Azure authentication connection.
4180
+ * @format text
4181
+ */
4182
+ client_id: string;
4183
+ /**
4184
+ * Client secret for the Azure authentication connection.
4185
+ * @format text
4186
+ */
4187
+ client_secret: string;
4188
+ /**
4189
+ * Domain URL of the Azure authentication connection.
4190
+ * @format text
4191
+ */
4192
+ domain: string;
4193
+ }
4194
+ /**
4195
+ * dev-org-auth-connections-create-request-google-apps-options
4196
+ * Object encapsulating the configuration parameters for a Google Apps
4197
+ * authentication connection.
4198
+ * @deprecated
4199
+ */
4200
+ export interface DevOrgAuthConnectionsCreateRequestGoogleAppsOptions {
4201
+ /**
4202
+ * Client ID for the Google Apps authentication connection.
4203
+ * @format text
4204
+ */
4205
+ client_id: string;
4206
+ /**
4207
+ * Client secret for the Google Apps authentication connection.
4208
+ * @format text
4209
+ */
4210
+ client_secret: string;
4211
+ /**
4212
+ * Tenant domain URL of the Google Apps authentication connection.
4213
+ * @format text
4214
+ */
4215
+ tenant_domain: string;
3333
4216
  }
3334
4217
  /**
3335
4218
  * dev-org-auth-connections-create-request-oidc-options
@@ -3987,6 +4870,11 @@ export interface DevUsersSelfUpdateRequest {
3987
4870
  job_history?: DevUsersUpdateJobHistoryItem[];
3988
4871
  /** Job title of the Dev User. */
3989
4872
  job_title?: DevUserJobTitle;
4873
+ /**
4874
+ * The ID of the Dev user that the user reports to.
4875
+ * @format id
4876
+ */
4877
+ reports_to?: string;
3990
4878
  }
3991
4879
  /** dev-users-update-job-history-item */
3992
4880
  export interface DevUsersUpdateJobHistoryItem {
@@ -4062,6 +4950,11 @@ export interface DevUsersUpdateRequest {
4062
4950
  job_history?: DevUsersUpdateJobHistoryItem[];
4063
4951
  /** Job title of the Dev User. */
4064
4952
  job_title?: DevUserJobTitle;
4953
+ /**
4954
+ * The ID of the Dev user that the user reports to.
4955
+ * @format id
4956
+ */
4957
+ reports_to?: string;
4065
4958
  }
4066
4959
  /**
4067
4960
  * dev-users-update-response
@@ -4333,7 +5226,7 @@ export type DynamicGroupInfo = object;
4333
5226
  * Dynamic collection of DevRev objects, all adhering to a specific
4334
5227
  * filter.
4335
5228
  */
4336
- export type DynamicVista = VistaBase & {
5229
+ export type DynamicVista = VistaBase & DynamicVistaMeetingsVista & {
4337
5230
  /** Type of DevRev object for which the vista is applicable. */
4338
5231
  filter_type: DynamicVistaFilterType;
4339
5232
  };
@@ -4354,6 +5247,16 @@ export declare enum DynamicVistaFilterType {
4354
5247
  RevUsers = "rev_users",
4355
5248
  Works = "works"
4356
5249
  }
5250
+ /** dynamic-vista-meetings-vista */
5251
+ export interface DynamicVistaMeetingsVista {
5252
+ filter: MeetingsVistaFilter;
5253
+ /** Pinned items associated with the vista. */
5254
+ items?: DynamicVistaMeetingsVistaItemValue[];
5255
+ }
5256
+ /** dynamic-vista-meetings-vista-item-value */
5257
+ export interface DynamicVistaMeetingsVistaItemValue {
5258
+ item: MeetingSummary;
5259
+ }
4357
5260
  /** empty */
4358
5261
  export type Empty = object;
4359
5262
  /** enhancement */
@@ -5009,6 +5912,25 @@ export interface EventAiAgentResponse {
5009
5912
  /** A list of suggestions generated for the AI agent event. */
5010
5913
  suggestions?: AiAgentEventSuggestions;
5011
5914
  }
5915
+ /** event-article-created */
5916
+ export interface EventArticleCreated {
5917
+ article: Article;
5918
+ }
5919
+ /** event-article-deleted */
5920
+ export interface EventArticleDeleted {
5921
+ /**
5922
+ * The ID of the article that was deleted.
5923
+ * @format id
5924
+ * @example "ARTICLE-12345"
5925
+ */
5926
+ id: string;
5927
+ old_article?: Article;
5928
+ }
5929
+ /** event-article-updated */
5930
+ export interface EventArticleUpdated {
5931
+ article: Article;
5932
+ old_article?: Article;
5933
+ }
5012
5934
  /** event-conversation-created */
5013
5935
  export interface EventConversationCreated {
5014
5936
  conversation: Conversation;
@@ -5388,66 +6310,178 @@ export interface EventWorkCreated {
5388
6310
  /** event-work-deleted */
5389
6311
  export interface EventWorkDeleted {
5390
6312
  /**
5391
- * The ID of the work that was deleted.
5392
- * @format id
5393
- * @example "ISS-12345"
6313
+ * The ID of the work that was deleted.
6314
+ * @format id
6315
+ * @example "ISS-12345"
6316
+ */
6317
+ id: string;
6318
+ old_work?: Work;
6319
+ }
6320
+ /** event-work-fetched */
6321
+ export type EventWorkFetched = (Empty | EventWorkFetchedOk) & {
6322
+ /**
6323
+ * The ID of the work that was fetched.
6324
+ * @format id
6325
+ * @example "ISS-12345"
6326
+ */
6327
+ id: string;
6328
+ result: EventFetchedResult;
6329
+ };
6330
+ /** event-work-fetched-ok */
6331
+ export interface EventWorkFetchedOk {
6332
+ work?: Work;
6333
+ }
6334
+ /** event-work-updated */
6335
+ export interface EventWorkUpdated {
6336
+ old_work?: Work;
6337
+ work: Work;
6338
+ }
6339
+ /** external-communication-channel-summary */
6340
+ export type ExternalCommunicationChannelSummary = AtomBaseSummary;
6341
+ /**
6342
+ * external-identity
6343
+ * External identity of a user.
6344
+ */
6345
+ export interface ExternalIdentity {
6346
+ /**
6347
+ * Display name of the user in the external source.
6348
+ * @format text
6349
+ */
6350
+ display_name?: string;
6351
+ /**
6352
+ * Unique ID of the user in the external source.
6353
+ * @format text
6354
+ */
6355
+ id?: string;
6356
+ /** Whether the external identity is verified or not. */
6357
+ is_verified?: boolean;
6358
+ /**
6359
+ * Issuer of the external identity of the user.
6360
+ * @format text
6361
+ */
6362
+ issuer?: string;
6363
+ }
6364
+ /** feature */
6365
+ export type Feature = PartBase;
6366
+ /** feature-summary */
6367
+ export type FeatureSummary = PartBaseSummary;
6368
+ /**
6369
+ * field-descriptor
6370
+ * Set of field attributes.
6371
+ */
6372
+ export interface FieldDescriptor {
6373
+ /** The default value for this field. */
6374
+ default_value?: object;
6375
+ /**
6376
+ * Description of the field.
6377
+ * @format text
6378
+ */
6379
+ description?: string;
6380
+ /** Whether this field is filterable, groupable and sortable. */
6381
+ is_filterable?: boolean;
6382
+ /** Whether this field is immutable or not. */
6383
+ is_immutable?: boolean;
6384
+ /** Whether a stock unified enum can be extended with new values. */
6385
+ is_overridable?: boolean;
6386
+ /** Whether this field is required or not. */
6387
+ is_required?: boolean;
6388
+ /**
6389
+ * Whether this field can hold PII or sensitive information that
6390
+ * should not be logged.
6391
+ */
6392
+ is_sensitive?: boolean;
6393
+ /** Whether this field is a system field or not. */
6394
+ is_system?: boolean;
6395
+ /**
6396
+ * Name of the field.
6397
+ * @format text
6398
+ */
6399
+ name?: string;
6400
+ /** Allowed values for a unified enum. */
6401
+ uenum_values?: SchemaFieldUenumValue[];
6402
+ /** The schema of ui specific fields. */
6403
+ ui?: SchemaFieldUiMetadata;
6404
+ /** Validation annotations. */
6405
+ validation?: FieldValidation;
6406
+ }
6407
+ /**
6408
+ * field-validation
6409
+ * Validation annotations.
6410
+ */
6411
+ export interface FieldValidation {
6412
+ /**
6413
+ * string contains.
6414
+ * @format text
6415
+ */
6416
+ contains?: string;
6417
+ /** disables validations for this field. */
6418
+ disabled?: boolean;
6419
+ /**
6420
+ * exact array length.
6421
+ * @format int32
6422
+ */
6423
+ eq_items?: number;
6424
+ /**
6425
+ * exact string length.
6426
+ * @format int32
6427
+ */
6428
+ eq_len?: number;
6429
+ /**
6430
+ * int must be greater than this.
6431
+ * @format int32
6432
+ */
6433
+ gt?: number;
6434
+ /**
6435
+ * int must be greater or equal than this.
6436
+ * @format int32
6437
+ */
6438
+ gte?: number;
6439
+ /**
6440
+ * int must be less than this.
6441
+ * @format int32
6442
+ */
6443
+ lt?: number;
6444
+ /**
6445
+ * int must be less or equal than this.
6446
+ * @format int32
6447
+ */
6448
+ lte?: number;
6449
+ /**
6450
+ * maximum array length.
6451
+ * @format int32
6452
+ */
6453
+ max_items?: number;
6454
+ /**
6455
+ * maximum string length.
6456
+ * @format int32
5394
6457
  */
5395
- id: string;
5396
- old_work?: Work;
5397
- }
5398
- /** event-work-fetched */
5399
- export type EventWorkFetched = (Empty | EventWorkFetchedOk) & {
6458
+ max_len?: number;
5400
6459
  /**
5401
- * The ID of the work that was fetched.
5402
- * @format id
5403
- * @example "ISS-12345"
6460
+ * minimum array length.
6461
+ * @format int32
5404
6462
  */
5405
- id: string;
5406
- result: EventFetchedResult;
5407
- };
5408
- /** event-work-fetched-ok */
5409
- export interface EventWorkFetchedOk {
5410
- work?: Work;
5411
- }
5412
- /** event-work-updated */
5413
- export interface EventWorkUpdated {
5414
- old_work?: Work;
5415
- work: Work;
5416
- }
5417
- /** external-communication-channel-summary */
5418
- export type ExternalCommunicationChannelSummary = AtomBaseSummary;
5419
- /**
5420
- * external-identity
5421
- * External identity of a user.
5422
- */
5423
- export interface ExternalIdentity {
6463
+ min_items?: number;
5424
6464
  /**
5425
- * Display name of the user in the external source.
6465
+ * minimum string length.
6466
+ * @format int32
6467
+ */
6468
+ min_len?: number;
6469
+ /**
6470
+ * string pattern (re).
5426
6471
  * @format text
5427
6472
  */
5428
- display_name?: string;
6473
+ pattern?: string;
5429
6474
  /**
5430
- * Unique ID of the user in the external source.
6475
+ * string prefix.
5431
6476
  * @format text
5432
6477
  */
5433
- id?: string;
5434
- /** Whether the external identity is verified or not. */
5435
- is_verified?: boolean;
6478
+ prefix?: string;
5436
6479
  /**
5437
- * Issuer of the external identity of the user.
6480
+ * string suffix.
5438
6481
  * @format text
5439
6482
  */
5440
- issuer?: string;
6483
+ suffix?: string;
5441
6484
  }
5442
- /** feature */
5443
- export type Feature = PartBase;
5444
- /** feature-summary */
5445
- export type FeatureSummary = PartBaseSummary;
5446
- /**
5447
- * field-descriptor
5448
- * Set of field attributes.
5449
- */
5450
- export type FieldDescriptor = object;
5451
6485
  /** group */
5452
6486
  export type Group = AtomBase;
5453
6487
  /** Creation source of the group. */
@@ -5979,10 +7013,11 @@ export type Link = AtomBase & {
5979
7013
  target: LinkEndpointSummary;
5980
7014
  };
5981
7015
  /** link-endpoint-summary */
5982
- export type LinkEndpointSummary = (CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IssueSummary | ProductSummary | RevOrgSummary | RevUserSummary | TicketSummary) & {
7016
+ export type LinkEndpointSummary = (ArticleSummary | CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IssueSummary | ProductSummary | RevOrgSummary | RevUserSummary | TicketSummary) & {
5983
7017
  type: LinkEndpointType;
5984
7018
  };
5985
7019
  export declare enum LinkEndpointType {
7020
+ Article = "article",
5986
7021
  Capability = "capability",
5987
7022
  Conversation = "conversation",
5988
7023
  DevUser = "dev_user",
@@ -6226,6 +7261,8 @@ export declare enum MeetingState {
6226
7261
  Scheduled = "scheduled",
6227
7262
  Waiting = "waiting"
6228
7263
  }
7264
+ /** meeting-summary */
7265
+ export type MeetingSummary = AtomBaseSummary;
6229
7266
  /** meetings-count-request */
6230
7267
  export interface MeetingsCountRequest {
6231
7268
  /** Filters for meeting on specified channels. */
@@ -6256,6 +7293,7 @@ export interface MeetingsCountRequest {
6256
7293
  scheduled_date?: DateFilter;
6257
7294
  /** Filters for meeting on specified state or outcomes. */
6258
7295
  state?: MeetingState[];
7296
+ sync_metadata?: SyncMetadataFilter;
6259
7297
  }
6260
7298
  /** meetings-count-response */
6261
7299
  export interface MeetingsCountResponse {
@@ -6442,6 +7480,7 @@ export interface MeetingsListRequest {
6442
7480
  sort_by?: string[];
6443
7481
  /** Filters for meeting on specified state or outcomes. */
6444
7482
  state?: MeetingState[];
7483
+ sync_metadata?: SyncMetadataFilter;
6445
7484
  }
6446
7485
  /** meetings-list-response */
6447
7486
  export interface MeetingsListResponse {
@@ -6557,6 +7596,45 @@ export interface MeetingsUpdateRequestTags {
6557
7596
  export interface MeetingsUpdateResponse {
6558
7597
  meeting: Meeting;
6559
7598
  }
7599
+ /** meetings-vista-filter */
7600
+ export interface MeetingsVistaFilter {
7601
+ /** Filters for meeting on specified channels. */
7602
+ channel?: MeetingChannel[];
7603
+ /** Filters for meetings created by the specified user(s). */
7604
+ created_by?: string[];
7605
+ /** Provides ways to specify date ranges on objects. */
7606
+ created_date?: DateFilter;
7607
+ /** Provides ways to specify date ranges on objects. */
7608
+ ended_date?: DateFilter;
7609
+ /** Filters for meetings with the provided external_ref(s). */
7610
+ external_ref?: string[];
7611
+ /**
7612
+ * The field to group the collection by.
7613
+ * @format text
7614
+ */
7615
+ group_by?: string;
7616
+ /** Filters for links associated with the meeting. */
7617
+ links?: MeetingsFilterLinkSummaryFilter[];
7618
+ /** Filter for meeting on specified Member Ids. */
7619
+ members?: string[];
7620
+ /** Provides ways to specify date ranges on objects. */
7621
+ modified_date?: DateFilter;
7622
+ /** Filter for meeting on specified organizers. */
7623
+ organizer?: string[];
7624
+ /**
7625
+ * Filters for meetings with the provided parent.
7626
+ * @deprecated
7627
+ * @example ["ACC-12345"]
7628
+ */
7629
+ parent?: string[];
7630
+ /** Provides ways to specify date ranges on objects. */
7631
+ scheduled_date?: DateFilter;
7632
+ /** Comma-separated fields to sort the objects by. */
7633
+ sort_by?: string[];
7634
+ /** Filters for meeting on specified state or outcomes. */
7635
+ state?: MeetingState[];
7636
+ sync_metadata?: SyncMetadataFilter;
7637
+ }
6560
7638
  /** member-summary */
6561
7639
  export type MemberSummary = (DevUserSummary | GroupSummary | RevUserSummary | SysUserSummary) & {
6562
7640
  type: MemberType;
@@ -7428,6 +8506,8 @@ export interface PartsListRequest {
7428
8506
  owned_by?: string[];
7429
8507
  /** The filter for specifying parent part. */
7430
8508
  parent_part?: ParentPartFilter;
8509
+ /** Fields to sort the parts by and the direction to sort them. */
8510
+ sort_by?: string[];
7431
8511
  /**
7432
8512
  * Filters for part with any of the provided tags.
7433
8513
  * @example ["TAG-12345"]
@@ -7672,6 +8752,19 @@ export interface Resource {
7672
8752
  */
7673
8753
  url?: string;
7674
8754
  }
8755
+ /**
8756
+ * resource-summary
8757
+ * Resource details.
8758
+ */
8759
+ export interface ResourceSummary {
8760
+ /** Artifacts of the resource (relevant only for type artifact). */
8761
+ artifacts?: ArtifactSummary[];
8762
+ /**
8763
+ * URL of the resource (relevant only for type url).
8764
+ * @format text
8765
+ */
8766
+ url?: string;
8767
+ }
7675
8768
  /** rev-org */
7676
8769
  export type RevOrg = OrgBase & {
7677
8770
  /**
@@ -8440,12 +9533,85 @@ export type SchemaFieldOasisMetadata = object;
8440
9533
  * schema-field-uenum-value
8441
9534
  * A unified enum value.
8442
9535
  */
8443
- export type SchemaFieldUenumValue = object;
9536
+ export interface SchemaFieldUenumValue {
9537
+ /**
9538
+ * The immutable id of the enum value.
9539
+ * @format int64
9540
+ */
9541
+ id: number;
9542
+ /** True if this value is deprecated. */
9543
+ is_deprecated?: boolean;
9544
+ /**
9545
+ * The human readable name of the enum value.
9546
+ * @format text
9547
+ */
9548
+ label: string;
9549
+ /**
9550
+ * The order value of the enum.
9551
+ * @format int64
9552
+ */
9553
+ ordinal: number;
9554
+ /**
9555
+ * Tooltip shown in the UI for this value.
9556
+ * @format text
9557
+ */
9558
+ tooltip?: string;
9559
+ }
8444
9560
  /**
8445
9561
  * schema-field-ui-metadata
8446
9562
  * The schema of ui specific fields.
8447
9563
  */
8448
- export type SchemaFieldUiMetadata = object;
9564
+ export interface SchemaFieldUiMetadata {
9565
+ /** The client overrides for the field. */
9566
+ client_overrides?: ClientOverride[];
9567
+ /**
9568
+ * Number of decimal places to show (only applicable for number
9569
+ * fields).
9570
+ * @format int32
9571
+ */
9572
+ decimal_places?: number;
9573
+ /**
9574
+ * The display name of the field.
9575
+ * @format text
9576
+ */
9577
+ display_name?: string;
9578
+ /**
9579
+ * An optional group name for the field.
9580
+ * @format text
9581
+ */
9582
+ group_name?: string;
9583
+ /** Whether the field is groupable in the UI. */
9584
+ is_groupable?: boolean;
9585
+ /** Whether the field is hidden in the UI. */
9586
+ is_hidden?: boolean;
9587
+ /** Whether the field is sortable in the UI. */
9588
+ is_sortable?: boolean;
9589
+ /**
9590
+ * Order in which field is shown.
9591
+ * @format int32
9592
+ */
9593
+ order?: number;
9594
+ /**
9595
+ * A placeholder for the field.
9596
+ * @format text
9597
+ */
9598
+ placeholder?: string;
9599
+ /**
9600
+ * Tooltip for the field.
9601
+ * @format text
9602
+ */
9603
+ tooltip?: string;
9604
+ /**
9605
+ * Unit of measurment.
9606
+ * @format text
9607
+ */
9608
+ unit?: string;
9609
+ /**
9610
+ * Whether to use shorthand notation (only applicable for number
9611
+ * fields).
9612
+ */
9613
+ use_shorthand_notation?: boolean;
9614
+ }
8449
9615
  /** schema-id-field-descriptor */
8450
9616
  export type SchemaIdFieldDescriptor = SchemaFieldDescriptorBase & {
8451
9617
  /**
@@ -8817,6 +9983,71 @@ export type SchemaUenumListFieldDescriptor = SchemaFieldDescriptorBase & {
8817
9983
  };
8818
9984
  /** schema-unknown-field-descriptor */
8819
9985
  export type SchemaUnknownFieldDescriptor = SchemaFieldDescriptorBase;
9986
+ /** schemas-subtype-prepare-update-get-request */
9987
+ export interface SchemasSubtypePrepareUpdateGetRequest {
9988
+ /** Whether the leaf type corresponds to a custom object. */
9989
+ is_custom_leaf_type?: boolean;
9990
+ /**
9991
+ * Leaf type of the object.
9992
+ * @format text
9993
+ */
9994
+ leaf_type: string;
9995
+ /**
9996
+ * Name of the new subtype for the object.
9997
+ * @format text
9998
+ */
9999
+ new_subtype?: string;
10000
+ /**
10001
+ * ID of the object of which subtype is to be changed. Used to fetch
10002
+ * the object's custom schema fragments and custom fields
10003
+ * @format id
10004
+ */
10005
+ object?: string;
10006
+ }
10007
+ /** schemas-subtype-prepare-update-get-response */
10008
+ export interface SchemasSubtypePrepareUpdateGetResponse {
10009
+ /** List of fields that have a default value and need to be set. */
10010
+ added_fields?: SchemasSubtypePrepareUpdateGetResponseAddedField[];
10011
+ /** List of fields that will be dropped from the object. */
10012
+ dropped_fields?: SchemasSubtypePrepareUpdateGetResponseDroppedField[];
10013
+ /** List of new custom schema fragment IDs of the object. */
10014
+ new_custom_schema_fragments?: string[];
10015
+ /**
10016
+ * ID of the start stage of the new diagram if the subtype change
10017
+ * results in a change in the stage diagram.
10018
+ * @format id
10019
+ */
10020
+ new_start_stage?: string;
10021
+ }
10022
+ /** schemas-subtype-prepare-update-get-response-added-field */
10023
+ export interface SchemasSubtypePrepareUpdateGetResponseAddedField {
10024
+ /** Default value of the added field. */
10025
+ default_value?: any;
10026
+ /**
10027
+ * API-compliant qualified name of the added field.
10028
+ * @format text
10029
+ */
10030
+ name: string;
10031
+ }
10032
+ export declare enum SchemasSubtypePrepareUpdateGetResponseConflictType {
10033
+ AbsentInNew = "absent_in_new",
10034
+ AbsentInOld = "absent_in_old",
10035
+ IncompatibleType = "incompatible_type"
10036
+ }
10037
+ /** schemas-subtype-prepare-update-get-response-dropped-field */
10038
+ export interface SchemasSubtypePrepareUpdateGetResponseDroppedField {
10039
+ conflict_type: SchemasSubtypePrepareUpdateGetResponseConflictType;
10040
+ /**
10041
+ * Conflict message for the field being dropped.
10042
+ * @format text
10043
+ */
10044
+ message: string;
10045
+ /**
10046
+ * API-compliant qualified name of the dropped field.
10047
+ * @format text
10048
+ */
10049
+ name: string;
10050
+ }
8820
10051
  /** service-account */
8821
10052
  export type ServiceAccount = UserBase;
8822
10053
  /** service-account-summary */
@@ -9539,49 +10770,179 @@ export type SnapKitActionRequest = (SnapKitActionRequestButton | SnapKitActionRe
9539
10770
  * @format date-time
9540
10771
  * @example "2023-01-01T12:00:00.000Z"
9541
10772
  */
9542
- timestamp: string;
9543
- };
9544
- /** snap-kit-action-request-button */
9545
- export interface SnapKitActionRequestButton {
10773
+ timestamp: string;
10774
+ };
10775
+ /** snap-kit-action-request-button */
10776
+ export interface SnapKitActionRequestButton {
10777
+ /**
10778
+ * Value for the button interactive element.
10779
+ * @format text
10780
+ */
10781
+ value: string;
10782
+ }
10783
+ export declare enum SnapKitActionRequestElementTypeValue {
10784
+ Button = "button",
10785
+ Form = "form"
10786
+ }
10787
+ /** snap-kit-action-request-form */
10788
+ export interface SnapKitActionRequestForm {
10789
+ /** Value for the form interactive element. */
10790
+ value: object;
10791
+ }
10792
+ /** snap-widget */
10793
+ export interface SnapWidget {
10794
+ type: SnapWidgetType;
10795
+ }
10796
+ export type SnapWidgetType = string;
10797
+ /** snap-widgets-create-request */
10798
+ export interface SnapWidgetsCreateRequest {
10799
+ type: SnapWidgetsCreateRequestType;
10800
+ /**
10801
+ * Sets the members that the snap widget is shared with.
10802
+ * @maxItems 8
10803
+ */
10804
+ shared_with?: SetSharedWithMembership[];
10805
+ }
10806
+ export type SnapWidgetsCreateRequestType = string;
10807
+ /** snap-widgets-create-response */
10808
+ export interface SnapWidgetsCreateResponse {
10809
+ snap_widget: SnapWidget;
10810
+ }
10811
+ /**
10812
+ * stage
10813
+ * Describes the current stage of a object.
10814
+ */
10815
+ export type Stage = object;
10816
+ /** stage-diagram */
10817
+ export type StageDiagram = AtomBase & {
10818
+ /** True if this stage diagram corresponds to a custom leaf type. */
10819
+ is_custom_leaf_type?: boolean;
10820
+ /** True if this stage diagram is the default for the leaf type. */
10821
+ is_default?: boolean;
10822
+ /**
10823
+ * The leaf type this stage diagram applies to.
10824
+ * @format text
10825
+ */
10826
+ leaf_type?: string;
10827
+ /**
10828
+ * The human readable name of the stage diagram.
10829
+ * @format text
10830
+ */
10831
+ name?: string;
10832
+ /**
10833
+ * List of stages with their allowed transitions in this stage
10834
+ * diagram.
10835
+ */
10836
+ stages: StageNode[];
10837
+ };
10838
+ /** stage-diagram-summary */
10839
+ export type StageDiagramSummary = AtomBaseSummary & {
10840
+ /**
10841
+ * The human readable name of the stage diagram.
10842
+ * @format text
10843
+ */
10844
+ name?: string;
10845
+ };
10846
+ /** stage-diagrams-create-request */
10847
+ export interface StageDiagramsCreateRequest {
10848
+ /** Whether the leaf type corresponds to a custom object. */
10849
+ is_custom_leaf_type?: boolean;
10850
+ /** Whether this is a default stage diagram. */
10851
+ is_default?: boolean;
10852
+ /**
10853
+ * The leaf type this stage diagram applies to.
10854
+ * @format text
10855
+ */
10856
+ leaf_type: string;
10857
+ /**
10858
+ * The name of the stage diagram. Stage diagram is used for defining
10859
+ * stage transitions.
10860
+ * @format text
10861
+ */
10862
+ name: string;
10863
+ /** List of stages in the diagram. */
10864
+ stages: CreateStageNode[];
10865
+ }
10866
+ /** stage-diagrams-create-response */
10867
+ export interface StageDiagramsCreateResponse {
10868
+ stage_diagram: StageDiagram;
10869
+ }
10870
+ /** stage-diagrams-get-request */
10871
+ export interface StageDiagramsGetRequest {
10872
+ /**
10873
+ * The ID of the stage diagram to get.
10874
+ * @format id
10875
+ */
10876
+ id?: string;
10877
+ /**
10878
+ * Whether the leaf type corresponds to a custom object. Specify this
10879
+ * along with leaf_type to get the default custom object stage
10880
+ * diagram.
10881
+ */
10882
+ is_custom_leaf_type?: boolean;
9546
10883
  /**
9547
- * Value for the button interactive element.
10884
+ * The leaf type. Should be specified to retrieve the default stage
10885
+ * diagram for the leaf type. If not provided, then id is used.
9548
10886
  * @format text
9549
10887
  */
9550
- value: string;
10888
+ leaf_type?: string;
9551
10889
  }
9552
- export declare enum SnapKitActionRequestElementTypeValue {
9553
- Button = "button",
9554
- Form = "form"
10890
+ /** stage-diagrams-get-response */
10891
+ export interface StageDiagramsGetResponse {
10892
+ stage_diagram: StageDiagram;
9555
10893
  }
9556
- /** snap-kit-action-request-form */
9557
- export interface SnapKitActionRequestForm {
9558
- /** Value for the form interactive element. */
9559
- value: object;
10894
+ /** stage-diagrams-list-request */
10895
+ export interface StageDiagramsListRequest {
10896
+ /**
10897
+ * The cursor to resume iteration from, otherwise if not provided,
10898
+ * then iteration starts from the beginning.
10899
+ * @format text
10900
+ */
10901
+ cursor?: string;
10902
+ /** Whether only custom object stage diagrams should be filtered. */
10903
+ is_custom_leaf_type?: boolean;
10904
+ /** The list of leaf types. */
10905
+ leaf_type?: string[];
10906
+ /**
10907
+ * The maximum number of items.
10908
+ * @format int32
10909
+ */
10910
+ limit?: number;
10911
+ /** The list of stage diagram names. */
10912
+ name?: string[];
10913
+ /** The list of fields to sort the items by and how to sort them. */
10914
+ sort_by?: string[];
9560
10915
  }
9561
- /** snap-widget */
9562
- export interface SnapWidget {
9563
- type: SnapWidgetType;
10916
+ /** stage-diagrams-list-response */
10917
+ export interface StageDiagramsListResponse {
10918
+ /**
10919
+ * The cursor to resume iteration from, otherwise if not provided,
10920
+ * then iteration starts from the beginning.
10921
+ * @format text
10922
+ */
10923
+ cursor?: string;
10924
+ /** The stage diagram. */
10925
+ result: StageDiagram[];
9564
10926
  }
9565
- export type SnapWidgetType = string;
9566
- /** snap-widgets-create-request */
9567
- export interface SnapWidgetsCreateRequest {
9568
- type: SnapWidgetsCreateRequestType;
10927
+ /** stage-diagrams-update-request */
10928
+ export interface StageDiagramsUpdateRequest {
9569
10929
  /**
9570
- * Sets the members that the snap widget is shared with.
9571
- * @maxItems 8
10930
+ * The ID of the stage diagram to update.
10931
+ * @format id
9572
10932
  */
9573
- shared_with?: SetSharedWithMembership[];
10933
+ id: string;
10934
+ /**
10935
+ * The updated name of the stage diagram.
10936
+ * @format text
10937
+ */
10938
+ name?: string;
10939
+ /** List of stages in the stage diagram. */
10940
+ stages?: UpdateStageNode[];
9574
10941
  }
9575
- export type SnapWidgetsCreateRequestType = string;
9576
- /** snap-widgets-create-response */
9577
- export interface SnapWidgetsCreateResponse {
9578
- snap_widget: SnapWidget;
10942
+ /** stage-diagrams-update-response */
10943
+ export interface StageDiagramsUpdateResponse {
10944
+ stage_diagram: StageDiagram;
9579
10945
  }
9580
- /**
9581
- * stage
9582
- * Describes the current stage of a object.
9583
- */
9584
- export type Stage = object;
9585
10946
  /**
9586
10947
  * stage-filter
9587
10948
  * The filter for stages.
@@ -9601,6 +10962,26 @@ export interface StageInit {
9601
10962
  */
9602
10963
  name?: string;
9603
10964
  }
10965
+ /**
10966
+ * stage-node
10967
+ * Diagram stage.
10968
+ */
10969
+ export interface StageNode {
10970
+ /** True if this stage has been deprecated. */
10971
+ is_deprecated?: boolean;
10972
+ /** True if this stage is the starting stage of the stage diagram. */
10973
+ is_start?: boolean;
10974
+ stage?: CustomStageSummary;
10975
+ /** List of allowed transitions from this stage. */
10976
+ transitions?: StageTransition[];
10977
+ }
10978
+ /**
10979
+ * stage-transition
10980
+ * Stage transition.
10981
+ */
10982
+ export interface StageTransition {
10983
+ target_stage?: CustomStageSummary;
10984
+ }
9604
10985
  /**
9605
10986
  * stage-update
9606
10987
  * Updates an object's stage.
@@ -9625,6 +11006,114 @@ export interface StagedInfoFilter {
9625
11006
  /** Filters for issues that are staged. */
9626
11007
  is_staged?: boolean;
9627
11008
  }
11009
+ /**
11010
+ * stock-field-override
11011
+ * A stock field override.
11012
+ */
11013
+ export interface StockFieldOverride {
11014
+ /** Whether the field is required. */
11015
+ is_required?: boolean;
11016
+ /**
11017
+ * Name of the stock field to be overridden.
11018
+ * @format text
11019
+ */
11020
+ name?: string;
11021
+ /** The schema of ui specific fields. */
11022
+ ui?: SchemaFieldUiMetadata;
11023
+ }
11024
+ /** stock-schema-fragment */
11025
+ export type StockSchemaFragment = AtomBase & {
11026
+ /** List of composite schemas. */
11027
+ composite_schemas: CompositeSchema[];
11028
+ /**
11029
+ * Description of the schema.
11030
+ * @format text
11031
+ */
11032
+ description?: string;
11033
+ /** List of all fields in this schema. */
11034
+ fields: SchemaFieldDescriptor[];
11035
+ /**
11036
+ * Leaf type this fragment applies to.
11037
+ * @format text
11038
+ */
11039
+ leaf_type?: string;
11040
+ new_fragment_ref?: AtomSummary;
11041
+ old_fragment_ref?: AtomSummary;
11042
+ };
11043
+ /** stock-schema-fragments-get-request */
11044
+ export interface StockSchemaFragmentsGetRequest {
11045
+ /**
11046
+ * The ID of the stock schema fragment.
11047
+ * @format id
11048
+ */
11049
+ id?: string;
11050
+ /**
11051
+ * The leaf type this fragment applies to.
11052
+ * @format text
11053
+ */
11054
+ leaf_type?: string;
11055
+ }
11056
+ /** stock-schema-fragments-get-response */
11057
+ export interface StockSchemaFragmentsGetResponse {
11058
+ fragment: StockSchemaFragment;
11059
+ }
11060
+ /** stock-schema-fragments-list-request */
11061
+ export interface StockSchemaFragmentsListRequest {
11062
+ /**
11063
+ * The cursor to resume iteration from. If not provided, then
11064
+ * iteration starts from the beginning.
11065
+ * @format text
11066
+ */
11067
+ cursor?: string;
11068
+ filter_preset?: StockSchemaFragmentsListRequestFilterPreset;
11069
+ /** The list of leaf types. */
11070
+ leaf_type?: string[];
11071
+ /**
11072
+ * The maximum number of items.
11073
+ * @format int32
11074
+ */
11075
+ limit?: number;
11076
+ /**
11077
+ * The iteration mode to use. If "after", then entries after the provided
11078
+ * cursor will be returned, or if no cursor is provided, then from the
11079
+ * beginning. If "before", then entries before the provided cursor will be
11080
+ * returned, or if no cursor is provided, then from the end. Entries will
11081
+ * always be returned in the specified sort-by order.
11082
+ */
11083
+ mode?: ListMode;
11084
+ /**
11085
+ * List of fields which are not required in the payload and can be
11086
+ * pruned away.
11087
+ */
11088
+ prune?: StockSchemaFragmentsListRequestPrune[];
11089
+ /** The list of fields to sort the items by and how to sort them. */
11090
+ sort_by?: string[];
11091
+ }
11092
+ export declare enum StockSchemaFragmentsListRequestFilterPreset {
11093
+ CustomizableTypesPreset = "customizable_types_preset",
11094
+ NoPreset = "no_preset"
11095
+ }
11096
+ export declare enum StockSchemaFragmentsListRequestPrune {
11097
+ CompositeSchemas = "composite_schemas",
11098
+ Fields = "fields"
11099
+ }
11100
+ /** stock-schema-fragments-list-response */
11101
+ export interface StockSchemaFragmentsListResponse {
11102
+ /**
11103
+ * The cursor used to iterate subsequent results in accordance to the
11104
+ * sort order. If not set, then no later elements exist.
11105
+ * @format text
11106
+ */
11107
+ next_cursor?: string;
11108
+ /**
11109
+ * The cursor used to iterate preceding results in accordance to the
11110
+ * sort order. If not set, then no prior elements exist.
11111
+ * @format text
11112
+ */
11113
+ prev_cursor?: string;
11114
+ /** The stock schema fragments. */
11115
+ result: StockSchemaFragment[];
11116
+ }
9628
11117
  /** survey */
9629
11118
  export type Survey = AtomBase & {
9630
11119
  /**
@@ -10837,6 +12326,7 @@ export type TimelineEntryBase = AtomBase & {
10837
12326
  export type TimelineEntryBaseSummary = AtomBaseSummary;
10838
12327
  /** The type of object that the Timeline entry belongs to. */
10839
12328
  export declare enum TimelineEntryObjectType {
12329
+ Article = "article",
10840
12330
  Capability = "capability",
10841
12331
  Conversation = "conversation",
10842
12332
  Enhancement = "enhancement",
@@ -10929,6 +12419,34 @@ export interface UpdateCommandSurface {
10929
12419
  /** Surfaces from where this command can be invoked. */
10930
12420
  surface?: CommandSurfaceSurface;
10931
12421
  }
12422
+ /** update-stage-node */
12423
+ export interface UpdateStageNode {
12424
+ /** Whether this stage is deprecated. */
12425
+ is_deprecated?: boolean;
12426
+ /** Whether this is the start stage. */
12427
+ is_start?: boolean;
12428
+ /**
12429
+ * The ID of the stage.
12430
+ * @format id
12431
+ */
12432
+ stage_id: string;
12433
+ /** List of transitions from this stage. */
12434
+ transitions?: UpdateStageTransition[];
12435
+ }
12436
+ /** update-stage-transition */
12437
+ export interface UpdateStageTransition {
12438
+ /**
12439
+ * The ID of the target stage.
12440
+ * @format id
12441
+ */
12442
+ target_stage_id: string;
12443
+ ui?: UpdateStageUiMetadata;
12444
+ }
12445
+ /** update-stage-ui-metadata */
12446
+ export interface UpdateStageUiMetadata {
12447
+ /** Whether the stage is hidden. */
12448
+ is_hidden?: boolean;
12449
+ }
10932
12450
  /** user-base */
10933
12451
  export type UserBase = AtomBase & {
10934
12452
  /**
@@ -11004,6 +12522,52 @@ export declare enum UserType {
11004
12522
  ServiceAccount = "service_account",
11005
12523
  SysUser = "sys_user"
11006
12524
  }
12525
+ /**
12526
+ * view-override
12527
+ * UI hint overrides for a view.
12528
+ */
12529
+ export interface ViewOverride {
12530
+ /**
12531
+ * Number of decimal places to show. Only applicable for number
12532
+ * fields.
12533
+ * @format int32
12534
+ */
12535
+ decimal_places?: number;
12536
+ /**
12537
+ * The display name of the field.
12538
+ * @format text
12539
+ */
12540
+ display_name?: string;
12541
+ /** Whether the field is groupable in the UI. */
12542
+ is_groupable?: boolean;
12543
+ /** Whether the field is hidden in the UI. */
12544
+ is_hidden?: boolean;
12545
+ /**
12546
+ * Relative order in which the field is shown.
12547
+ * @format int32
12548
+ */
12549
+ order?: number;
12550
+ /**
12551
+ * A placeholder for the field.
12552
+ * @format text
12553
+ */
12554
+ placeholder?: string;
12555
+ /**
12556
+ * Tooltip for the field.
12557
+ * @format text
12558
+ */
12559
+ tooltip?: string;
12560
+ /**
12561
+ * Whether to use shorthand notation. Example, 1K instead of 1000.
12562
+ * Only applicable for number fields.
12563
+ */
12564
+ use_shorthand_notation?: boolean;
12565
+ /**
12566
+ * The name of the view.
12567
+ * @format text
12568
+ */
12569
+ view_name?: string;
12570
+ }
11007
12571
  /**
11008
12572
  * vista
11009
12573
  * Represents a collection of DevRev objects.
@@ -11217,6 +12781,14 @@ export interface VistasGroupsGetResponse {
11217
12781
  export interface VistasGroupsListRequest {
11218
12782
  /** Filters for vista group items of the specific type. */
11219
12783
  type?: GroupItemType[];
12784
+ /**
12785
+ * Filters for vista group items which have one of the parts linked as
12786
+ * its ancestor part or primary part.
12787
+ * @example ["PROD-12345"]
12788
+ */
12789
+ ancestor_part?: string[];
12790
+ /** The filter for applies to part. */
12791
+ applies_to_part?: AppliesToPartFilter;
11220
12792
  /**
11221
12793
  * Filter for vistas group item created by any of these users.
11222
12794
  * @example ["DEVU-12345"]
@@ -11473,7 +13045,10 @@ export interface WebCrawlerJobsCreateRequest {
11473
13045
  * @format text
11474
13046
  */
11475
13047
  accept_regex?: string;
11476
- /** The list of regexes a URL must satisfy to be crawled. */
13048
+ /**
13049
+ * The list of regexes a URL must satisfy to be crawled.
13050
+ * @maxItems 100
13051
+ */
11477
13052
  accept_regexes?: string[];
11478
13053
  /**
11479
13054
  * The parts to which created webpage/articles during this crawler job
@@ -11518,13 +13093,23 @@ export interface WebCrawlerJobsCreateRequest {
11518
13093
  * The list of regexes which if satisfied by a URL results in
11519
13094
  * rejection of the URL. If a URL matches both accept and reject
11520
13095
  * regexes, it is rejected.
13096
+ * @maxItems 100
11521
13097
  */
11522
13098
  reject_regexes?: string[];
11523
- /** The list of sitemap index URLs to crawl. */
13099
+ /**
13100
+ * The list of sitemap index URLs to crawl.
13101
+ * @maxItems 2
13102
+ */
11524
13103
  sitemap_index_urls?: string[];
11525
- /** The list of sitemap URLs to crawl. */
13104
+ /**
13105
+ * The list of sitemap URLs to crawl.
13106
+ * @maxItems 2
13107
+ */
11526
13108
  sitemap_urls?: string[];
11527
- /** The list of URLs to crawl. */
13109
+ /**
13110
+ * The list of URLs to crawl.
13111
+ * @maxItems 50
13112
+ */
11528
13113
  urls?: string[];
11529
13114
  /**
11530
13115
  * User agent to use for crawling websites in this job.
@@ -11638,6 +13223,9 @@ export interface WebhookEventRequest {
11638
13223
  account_deleted?: EventAccountDeleted;
11639
13224
  account_updated?: EventAccountUpdated;
11640
13225
  ai_agent_response?: EventAiAgentResponse;
13226
+ article_created?: EventArticleCreated;
13227
+ article_deleted?: EventArticleDeleted;
13228
+ article_updated?: EventArticleUpdated;
11641
13229
  conversation_created?: EventConversationCreated;
11642
13230
  conversation_deleted?: EventConversationDeleted;
11643
13231
  conversation_updated?: EventConversationUpdated;
@@ -11736,6 +13324,9 @@ export declare enum WebhookEventType {
11736
13324
  AccountDeleted = "account_deleted",
11737
13325
  AccountUpdated = "account_updated",
11738
13326
  AiAgentResponse = "ai_agent_response",
13327
+ ArticleCreated = "article_created",
13328
+ ArticleDeleted = "article_deleted",
13329
+ ArticleUpdated = "article_updated",
11739
13330
  ConversationCreated = "conversation_created",
11740
13331
  ConversationDeleted = "conversation_deleted",
11741
13332
  ConversationUpdated = "conversation_updated",
@@ -13058,6 +14649,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
13058
14649
  * @example ["DEVU-12345"]
13059
14650
  */
13060
14651
  owned_by?: string[];
14652
+ /** Filters for articles with the provided parent directories. */
14653
+ parent?: string[];
13061
14654
  /** Filter for the scope of the articles. */
13062
14655
  scope?: number[];
13063
14656
  /**
@@ -13790,6 +15383,138 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
13790
15383
  * @secure
13791
15384
  */
13792
15385
  conversationsUpdate: (data: ConversationsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsUpdateResponse, any>>;
15386
+ /**
15387
+ * @description Counts custom objects.
15388
+ *
15389
+ * @tags customization
15390
+ * @name CustomObjectsCount
15391
+ * @summary Count Custom Objects
15392
+ * @request GET:/custom-objects.count
15393
+ * @secure
15394
+ */
15395
+ customObjectsCount: (query: {
15396
+ /**
15397
+ * Leaf type to filter.
15398
+ * @format text
15399
+ */
15400
+ leaf_type: string;
15401
+ /** List of filters to apply. */
15402
+ filters?: any[];
15403
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any>>;
15404
+ /**
15405
+ * @description Counts custom objects.
15406
+ *
15407
+ * @tags customization
15408
+ * @name CustomObjectsCountPost
15409
+ * @summary Count Custom Objects (POST)
15410
+ * @request POST:/custom-objects.count
15411
+ * @secure
15412
+ */
15413
+ customObjectsCountPost: (data: CustomObjectsCountRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any>>;
15414
+ /**
15415
+ * @description Creates a custom object.
15416
+ *
15417
+ * @tags customization
15418
+ * @name CustomObjectsCreate
15419
+ * @summary Create Custom Object
15420
+ * @request POST:/custom-objects.create
15421
+ * @secure
15422
+ */
15423
+ customObjectsCreate: (data: CustomObjectsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCreateResponse, any>>;
15424
+ /**
15425
+ * @description Deletes a custom object.
15426
+ *
15427
+ * @tags customization
15428
+ * @name CustomObjectsDelete
15429
+ * @summary Delete Custom Object
15430
+ * @request POST:/custom-objects.delete
15431
+ * @secure
15432
+ */
15433
+ customObjectsDelete: (data: CustomObjectsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
15434
+ /**
15435
+ * @description Gets a custom object.
15436
+ *
15437
+ * @tags customization
15438
+ * @name CustomObjectsGet
15439
+ * @summary Get Custom Object
15440
+ * @request GET:/custom-objects.get
15441
+ * @secure
15442
+ */
15443
+ customObjectsGet: (query?: {
15444
+ /**
15445
+ * The ID of the custom object to get.
15446
+ * @format id
15447
+ */
15448
+ id?: string;
15449
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsGetResponse, any>>;
15450
+ /**
15451
+ * @description Gets a custom object.
15452
+ *
15453
+ * @tags customization
15454
+ * @name CustomObjectsGetPost
15455
+ * @summary Get Custom Object (POST)
15456
+ * @request POST:/custom-objects.get
15457
+ * @secure
15458
+ */
15459
+ customObjectsGetPost: (data: CustomObjectsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsGetResponse, any>>;
15460
+ /**
15461
+ * @description Lists custom objects.
15462
+ *
15463
+ * @tags customization
15464
+ * @name CustomObjectsList
15465
+ * @summary List Custom Objects
15466
+ * @request GET:/custom-objects.list
15467
+ * @secure
15468
+ */
15469
+ customObjectsList: (query: {
15470
+ /**
15471
+ * Leaf type to filter.
15472
+ * @format text
15473
+ */
15474
+ leaf_type: string;
15475
+ /**
15476
+ * The cursor to resume iteration from. If not provided, then iteration
15477
+ * starts from the beginning.
15478
+ * @format text
15479
+ */
15480
+ cursor?: string;
15481
+ /** List of filters to apply. */
15482
+ filter?: any[];
15483
+ /** List of filters to apply. */
15484
+ filters?: any[];
15485
+ /**
15486
+ * The maximum number of items.
15487
+ * @format int32
15488
+ */
15489
+ limit?: number;
15490
+ /**
15491
+ * The iteration mode to use, otherwise if not set, then "after" is
15492
+ * used.
15493
+ */
15494
+ mode?: ListMode;
15495
+ /** The list of fields to sort the items by and how to sort them. */
15496
+ sort_by?: string[];
15497
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any>>;
15498
+ /**
15499
+ * @description Lists custom objects.
15500
+ *
15501
+ * @tags customization
15502
+ * @name CustomObjectsListPost
15503
+ * @summary List Custom Objects (POST)
15504
+ * @request POST:/custom-objects.list
15505
+ * @secure
15506
+ */
15507
+ customObjectsListPost: (data: CustomObjectsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any>>;
15508
+ /**
15509
+ * @description Updates a custom object.
15510
+ *
15511
+ * @tags customization
15512
+ * @name CustomObjectsUpdate
15513
+ * @summary Update Custom Object
15514
+ * @request POST:/custom-objects.update
15515
+ * @secure
15516
+ */
15517
+ customObjectsUpdate: (data: CustomObjectsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsUpdateResponse, any>>;
13793
15518
  /**
13794
15519
  * @description Creates a new enterprise authentication connection for a Dev organization. This authentication connection will not be enabled by default for the organization and the user will need to explicitly enable this. Only 5 authentication connections can be created by an organization.
13795
15520
  *
@@ -14578,6 +16303,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
14578
16303
  parent?: string[];
14579
16304
  /** Filters for meeting on specified state or outcomes. */
14580
16305
  state?: MeetingState[];
16306
+ /** Filters for issues with this specific external reference. */
16307
+ 'sync_metadata.external_reference'?: string[];
16308
+ /** Filters for works with selected sync statuses. */
16309
+ 'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
16310
+ /** Filters for works modified with selected sync history. */
16311
+ 'sync_metadata.last_sync_in.sync_history'?: string[];
16312
+ /** Filters for works modified with selected sync units. */
16313
+ 'sync_metadata.last_sync_in.sync_unit'?: string[];
16314
+ /** Filters for works with selected sync statuses. */
16315
+ 'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
16316
+ /** Filters for works modified with selected sync history. */
16317
+ 'sync_metadata.last_sync_out.sync_history'?: string[];
16318
+ /** Filters for works modified with selected sync units. */
16319
+ 'sync_metadata.last_sync_out.sync_unit'?: string[];
16320
+ /** Filters for issues synced from this specific origin system. */
16321
+ 'sync_metadata.origin_system'?: string[];
14581
16322
  }, params?: RequestParams) => Promise<AxiosResponse<MeetingsCountResponse, any>>;
14582
16323
  /**
14583
16324
  * @description Counts the meeting records.
@@ -14696,6 +16437,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
14696
16437
  sort_by?: string[];
14697
16438
  /** Filters for meeting on specified state or outcomes. */
14698
16439
  state?: MeetingState[];
16440
+ /** Filters for issues with this specific external reference. */
16441
+ 'sync_metadata.external_reference'?: string[];
16442
+ /** Filters for works with selected sync statuses. */
16443
+ 'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
16444
+ /** Filters for works modified with selected sync history. */
16445
+ 'sync_metadata.last_sync_in.sync_history'?: string[];
16446
+ /** Filters for works modified with selected sync units. */
16447
+ 'sync_metadata.last_sync_in.sync_unit'?: string[];
16448
+ /** Filters for works with selected sync statuses. */
16449
+ 'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
16450
+ /** Filters for works modified with selected sync history. */
16451
+ 'sync_metadata.last_sync_out.sync_history'?: string[];
16452
+ /** Filters for works modified with selected sync units. */
16453
+ 'sync_metadata.last_sync_out.sync_unit'?: string[];
16454
+ /** Filters for issues synced from this specific origin system. */
16455
+ 'sync_metadata.origin_system'?: string[];
14699
16456
  }, params?: RequestParams) => Promise<AxiosResponse<MeetingsListResponse, any>>;
14700
16457
  /**
14701
16458
  * @description Lists the meeting records.
@@ -15160,6 +16917,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
15160
16917
  * @example ["PROD-12345"]
15161
16918
  */
15162
16919
  'parent_part.parts'?: string[];
16920
+ /** Fields to sort the parts by and the direction to sort them. */
16921
+ sort_by?: string[];
15163
16922
  /**
15164
16923
  * Filters for part with any of the provided tags.
15165
16924
  * @example ["TAG-12345"]
@@ -15604,6 +17363,238 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
15604
17363
  * @secure
15605
17364
  */
15606
17365
  revUsersUpdate: (data: RevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersUpdateResponse, any>>;
17366
+ /**
17367
+ * @description Gets the aggregated schema.
17368
+ *
17369
+ * @tags customization
17370
+ * @name AggregatedSchemaGet
17371
+ * @summary Get Schemas Aggregated
17372
+ * @request GET:/schemas.aggregated.get
17373
+ * @secure
17374
+ */
17375
+ aggregatedSchemaGet: (query?: {
17376
+ /** The custom schema fragment IDs which are to be aggregated. */
17377
+ custom_schema_fragments?: string[];
17378
+ /** List of apps. */
17379
+ 'custom_schema_spec.apps'?: string[];
17380
+ /**
17381
+ * Name of the subtype.
17382
+ * @format text
17383
+ */
17384
+ 'custom_schema_spec.subtype'?: string;
17385
+ /** Whether the leaf type corresponds to a custom object. */
17386
+ is_custom_leaf_type?: boolean;
17387
+ /**
17388
+ * The leaf type. Used for inferring the default stage diagram and
17389
+ * tenant fragment ID.
17390
+ * @format text
17391
+ */
17392
+ leaf_type?: string;
17393
+ /**
17394
+ * The stock schema fragment which is to be aggregated.
17395
+ * @format id
17396
+ */
17397
+ stock_schema_fragment?: string;
17398
+ }, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
17399
+ /**
17400
+ * @description Gets the aggregated schema.
17401
+ *
17402
+ * @tags customization
17403
+ * @name AggregatedSchemaGetPost
17404
+ * @summary Get Schemas Aggregated (POST)
17405
+ * @request POST:/schemas.aggregated.get
17406
+ * @secure
17407
+ */
17408
+ aggregatedSchemaGetPost: (data: AggregatedSchemaGetRequest, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
17409
+ /**
17410
+ * @description Gets a custom schema fragment.
17411
+ *
17412
+ * @tags customization
17413
+ * @name CustomSchemaFragmentsGet
17414
+ * @summary Get Schemas Custom
17415
+ * @request GET:/schemas.custom.get
17416
+ * @secure
17417
+ */
17418
+ customSchemaFragmentsGet: (query: {
17419
+ /**
17420
+ * The ID of the custom schema fragment.
17421
+ * @format id
17422
+ */
17423
+ id: string;
17424
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any>>;
17425
+ /**
17426
+ * @description Gets a custom schema fragment.
17427
+ *
17428
+ * @tags customization
17429
+ * @name CustomSchemaFragmentsGetPost
17430
+ * @summary Get Schemas Custom (POST)
17431
+ * @request POST:/schemas.custom.get
17432
+ * @secure
17433
+ */
17434
+ customSchemaFragmentsGetPost: (data: CustomSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any>>;
17435
+ /**
17436
+ * @description Lists custom schema fragments.
17437
+ *
17438
+ * @tags customization
17439
+ * @name CustomSchemaFragmentsList
17440
+ * @summary List Schemas Custom
17441
+ * @request GET:/schemas.custom.list
17442
+ * @secure
17443
+ */
17444
+ customSchemaFragmentsList: (query?: {
17445
+ /** The list of app names. */
17446
+ app?: string[];
17447
+ /**
17448
+ * The cursor to resume iteration from. If not provided, then iteration
17449
+ * starts from the beginning.
17450
+ * @format text
17451
+ */
17452
+ cursor?: string;
17453
+ /**
17454
+ * Whether only deprecated fragments should be filtered.
17455
+ * @deprecated
17456
+ */
17457
+ deprecated?: boolean;
17458
+ /** Whether the leaf type corresponds to a custom object */
17459
+ is_custom_leaf_type?: boolean;
17460
+ /** Whether the fragment has been deprecated. */
17461
+ is_deprecated?: boolean;
17462
+ /** The list of leaf types. */
17463
+ leaf_type?: string[];
17464
+ /**
17465
+ * The maximum number of items.
17466
+ * @format int32
17467
+ */
17468
+ limit?: number;
17469
+ /**
17470
+ * The iteration mode to use, otherwise if not set, then "after" is
17471
+ * used.
17472
+ */
17473
+ mode?: ListMode;
17474
+ /**
17475
+ * List of fields which are not required in the payload and can be
17476
+ * pruned away.
17477
+ */
17478
+ prune?: CustomSchemaFragmentsListRequestPrune[];
17479
+ /** The list of fields to sort the items by and how to sort them. */
17480
+ sort_by?: string[];
17481
+ /** The list of subtypes. */
17482
+ subtype?: string[];
17483
+ /** Filters for custom schema fragment of the provided types. */
17484
+ types?: CustomSchemaFragmentType[];
17485
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any>>;
17486
+ /**
17487
+ * @description Lists custom schema fragments.
17488
+ *
17489
+ * @tags customization
17490
+ * @name CustomSchemaFragmentsListPost
17491
+ * @summary List Schemas Custom (POST)
17492
+ * @request POST:/schemas.custom.list
17493
+ * @secure
17494
+ */
17495
+ customSchemaFragmentsListPost: (data: CustomSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any>>;
17496
+ /**
17497
+ * @description Creates or updates a custom schema fragment.
17498
+ *
17499
+ * @tags customization
17500
+ * @name CustomSchemaFragmentsSet
17501
+ * @summary Set Schemas Custom
17502
+ * @request POST:/schemas.custom.set
17503
+ * @secure
17504
+ */
17505
+ customSchemaFragmentsSet: (data: CustomSchemaFragmentsSetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsSetResponse, any>>;
17506
+ /**
17507
+ * @description Gets a stock schema fragment.
17508
+ *
17509
+ * @tags customization
17510
+ * @name StockSchemaFragmentsGet
17511
+ * @summary Get Schemas Stock
17512
+ * @request GET:/schemas.stock.get
17513
+ * @secure
17514
+ */
17515
+ stockSchemaFragmentsGet: (query?: {
17516
+ /**
17517
+ * The ID of the stock schema fragment.
17518
+ * @format id
17519
+ */
17520
+ id?: string;
17521
+ /**
17522
+ * The leaf type this fragment applies to.
17523
+ * @format text
17524
+ */
17525
+ leaf_type?: string;
17526
+ }, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any>>;
17527
+ /**
17528
+ * @description Gets a stock schema fragment.
17529
+ *
17530
+ * @tags customization
17531
+ * @name StockSchemaFragmentsGetPost
17532
+ * @summary Get Schemas Stock (POST)
17533
+ * @request POST:/schemas.stock.get
17534
+ * @secure
17535
+ */
17536
+ stockSchemaFragmentsGetPost: (data: StockSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any>>;
17537
+ /**
17538
+ * @description Lists stock schema fragments.
17539
+ *
17540
+ * @tags customization
17541
+ * @name StockSchemaFragmentsList
17542
+ * @summary List Schemas Stock
17543
+ * @request GET:/schemas.stock.list
17544
+ * @secure
17545
+ */
17546
+ stockSchemaFragmentsList: (query?: {
17547
+ /**
17548
+ * The cursor to resume iteration from. If not provided, then iteration
17549
+ * starts from the beginning.
17550
+ * @format text
17551
+ */
17552
+ cursor?: string;
17553
+ /**
17554
+ * Filter preset to specify whether to filter only customization enabled
17555
+ * leaf types.
17556
+ */
17557
+ filter_preset?: StockSchemaFragmentsListRequestFilterPreset;
17558
+ /** The list of leaf types. */
17559
+ leaf_type?: string[];
17560
+ /**
17561
+ * The maximum number of items.
17562
+ * @format int32
17563
+ */
17564
+ limit?: number;
17565
+ /**
17566
+ * The iteration mode to use, otherwise if not set, then "after" is
17567
+ * used.
17568
+ */
17569
+ mode?: ListMode;
17570
+ /**
17571
+ * List of fields which are not required in the payload and can be
17572
+ * pruned away.
17573
+ */
17574
+ prune?: StockSchemaFragmentsListRequestPrune[];
17575
+ /** The list of fields to sort the items by and how to sort them. */
17576
+ sort_by?: string[];
17577
+ }, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any>>;
17578
+ /**
17579
+ * @description Lists stock schema fragments.
17580
+ *
17581
+ * @tags customization
17582
+ * @name StockSchemaFragmentsListPost
17583
+ * @summary List Schemas Stock (POST)
17584
+ * @request POST:/schemas.stock.list
17585
+ * @secure
17586
+ */
17587
+ stockSchemaFragmentsListPost: (data: StockSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any>>;
17588
+ /**
17589
+ * @description Gets the new fragment IDs and fields resulting from changing a subtype.
17590
+ *
17591
+ * @tags customization
17592
+ * @name SchemasSubtypePrepareUpdateGet
17593
+ * @summary Prepare-Update Schemas Subtypes
17594
+ * @request POST:/schemas.subtypes.prepare-update
17595
+ * @secure
17596
+ */
17597
+ schemasSubtypePrepareUpdateGet: (data: SchemasSubtypePrepareUpdateGetRequest, params?: RequestParams) => Promise<AxiosResponse<SchemasSubtypePrepareUpdateGetResponse, any>>;
15607
17598
  /**
15608
17599
  * @description Creates a service account.
15609
17600
  *
@@ -15871,6 +17862,273 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
15871
17862
  * @secure
15872
17863
  */
15873
17864
  snapWidgetsCreate: (data: SnapWidgetsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapWidgetsCreateResponse, any>>;
17865
+ /**
17866
+ * @description Creates a stage diagram.
17867
+ *
17868
+ * @tags customization
17869
+ * @name StageDiagramsCreate
17870
+ * @summary Create Stage Diagram
17871
+ * @request POST:/stage-diagrams.create
17872
+ * @secure
17873
+ */
17874
+ stageDiagramsCreate: (data: StageDiagramsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsCreateResponse, any>>;
17875
+ /**
17876
+ * @description Gets a stage diagram.
17877
+ *
17878
+ * @tags customization
17879
+ * @name StageDiagramsGet
17880
+ * @summary Get Stage Diagram
17881
+ * @request GET:/stage-diagrams.get
17882
+ * @secure
17883
+ */
17884
+ stageDiagramsGet: (query?: {
17885
+ /**
17886
+ * The ID of the stage diagram to get.
17887
+ * @format id
17888
+ */
17889
+ id?: string;
17890
+ /**
17891
+ * Whether the leaf type corresponds to a custom object. Specify this
17892
+ * along with leaf_type to get the default custom object stage diagram.
17893
+ */
17894
+ is_custom_leaf_type?: boolean;
17895
+ /**
17896
+ * The leaf type. Should be specified to retrieve the default stage
17897
+ * diagram for the leaf type. If not provided, then id is used.
17898
+ * @format text
17899
+ */
17900
+ leaf_type?: string;
17901
+ }, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsGetResponse, any>>;
17902
+ /**
17903
+ * @description Gets a stage diagram.
17904
+ *
17905
+ * @tags customization
17906
+ * @name StageDiagramsGetPost
17907
+ * @summary Get Stage Diagram (POST)
17908
+ * @request POST:/stage-diagrams.get
17909
+ * @secure
17910
+ */
17911
+ stageDiagramsGetPost: (data: StageDiagramsGetRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsGetResponse, any>>;
17912
+ /**
17913
+ * @description Lists stage diagrams.
17914
+ *
17915
+ * @tags customization
17916
+ * @name StageDiagramsList
17917
+ * @summary List Stage Diagrams
17918
+ * @request GET:/stage-diagrams.list
17919
+ * @secure
17920
+ */
17921
+ stageDiagramsList: (query?: {
17922
+ /**
17923
+ * The cursor to resume iteration from, otherwise if not provided, then
17924
+ * iteration starts from the beginning.
17925
+ * @format text
17926
+ */
17927
+ cursor?: string;
17928
+ /** Whether only custom object stage diagrams should be filtered. */
17929
+ is_custom_leaf_type?: boolean;
17930
+ /** The list of leaf types. */
17931
+ leaf_type?: string[];
17932
+ /**
17933
+ * The maximum number of items.
17934
+ * @format int32
17935
+ */
17936
+ limit?: number;
17937
+ /** The list of stage diagram names. */
17938
+ name?: string[];
17939
+ /** The list of fields to sort the items by and how to sort them. */
17940
+ sort_by?: string[];
17941
+ }, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsListResponse, any>>;
17942
+ /**
17943
+ * @description Lists stage diagrams.
17944
+ *
17945
+ * @tags customization
17946
+ * @name StageDiagramsListPost
17947
+ * @summary List Stage Diagrams (POST)
17948
+ * @request POST:/stage-diagrams.list
17949
+ * @secure
17950
+ */
17951
+ stageDiagramsListPost: (data: StageDiagramsListRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsListResponse, any>>;
17952
+ /**
17953
+ * @description Updates a stage diagram.
17954
+ *
17955
+ * @tags customization
17956
+ * @name StageDiagramsUpdate
17957
+ * @summary Update Stage Diagram
17958
+ * @request POST:/stage-diagrams.update
17959
+ * @secure
17960
+ */
17961
+ stageDiagramsUpdate: (data: StageDiagramsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsUpdateResponse, any>>;
17962
+ /**
17963
+ * @description Creates a custom stage.
17964
+ *
17965
+ * @tags customization
17966
+ * @name CustomStagesCreate
17967
+ * @summary Create Stages Custom
17968
+ * @request POST:/stages.custom.create
17969
+ * @secure
17970
+ */
17971
+ customStagesCreate: (data: CustomStagesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesCreateResponse, any>>;
17972
+ /**
17973
+ * @description Gets a custom stage.
17974
+ *
17975
+ * @tags customization
17976
+ * @name CustomStagesGet
17977
+ * @summary Get Stages Custom
17978
+ * @request GET:/stages.custom.get
17979
+ * @secure
17980
+ */
17981
+ customStagesGet: (query: {
17982
+ /**
17983
+ * The ID of the custom stage to get.
17984
+ * @format id
17985
+ */
17986
+ id: string;
17987
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any>>;
17988
+ /**
17989
+ * @description Gets a custom stage.
17990
+ *
17991
+ * @tags customization
17992
+ * @name CustomStagesGetPost
17993
+ * @summary Get Stages Custom (POST)
17994
+ * @request POST:/stages.custom.get
17995
+ * @secure
17996
+ */
17997
+ customStagesGetPost: (data: CustomStagesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any>>;
17998
+ /**
17999
+ * @description Lists custom stages.
18000
+ *
18001
+ * @tags customization
18002
+ * @name CustomStagesList
18003
+ * @summary List Stages Custom
18004
+ * @request GET:/stages.custom.list
18005
+ * @secure
18006
+ */
18007
+ customStagesList: (query?: {
18008
+ /**
18009
+ * The cursor to resume iteration from, otherwise if not provided, then
18010
+ * iteration starts from the beginning.
18011
+ * @format text
18012
+ */
18013
+ cursor?: string;
18014
+ /**
18015
+ * The maximum number of items.
18016
+ * @format int32
18017
+ */
18018
+ limit?: number;
18019
+ /** The list of stage names. */
18020
+ name?: string[];
18021
+ /** The list of stage ordinals. */
18022
+ ordinal?: number[];
18023
+ /** The list of fields to sort the items by and how to sort them. */
18024
+ sort_by?: string[];
18025
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any>>;
18026
+ /**
18027
+ * @description Lists custom stages.
18028
+ *
18029
+ * @tags customization
18030
+ * @name CustomStagesListPost
18031
+ * @summary List Stages Custom (POST)
18032
+ * @request POST:/stages.custom.list
18033
+ * @secure
18034
+ */
18035
+ customStagesListPost: (data: CustomStagesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any>>;
18036
+ /**
18037
+ * @description Updates a custom stage.
18038
+ *
18039
+ * @tags customization
18040
+ * @name CustomStagesUpdate
18041
+ * @summary Update Stages Custom
18042
+ * @request POST:/stages.custom.update
18043
+ * @secure
18044
+ */
18045
+ customStagesUpdate: (data: CustomStagesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesUpdateResponse, any>>;
18046
+ /**
18047
+ * @description Creates a custom state.
18048
+ *
18049
+ * @tags customization
18050
+ * @name CustomStatesCreate
18051
+ * @summary Create States Custom
18052
+ * @request POST:/states.custom.create
18053
+ * @secure
18054
+ */
18055
+ customStatesCreate: (data: CustomStatesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesCreateResponse, any>>;
18056
+ /**
18057
+ * @description Gets a custom state.
18058
+ *
18059
+ * @tags customization
18060
+ * @name CustomStatesGet
18061
+ * @summary Get States Custom
18062
+ * @request GET:/states.custom.get
18063
+ * @secure
18064
+ */
18065
+ customStatesGet: (query: {
18066
+ /**
18067
+ * The ID of the custom state to get.
18068
+ * @format id
18069
+ */
18070
+ id: string;
18071
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any>>;
18072
+ /**
18073
+ * @description Gets a custom state.
18074
+ *
18075
+ * @tags customization
18076
+ * @name CustomStatesGetPost
18077
+ * @summary Get States Custom (POST)
18078
+ * @request POST:/states.custom.get
18079
+ * @secure
18080
+ */
18081
+ customStatesGetPost: (data: CustomStatesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any>>;
18082
+ /**
18083
+ * @description Lists custom states.
18084
+ *
18085
+ * @tags customization
18086
+ * @name CustomStatesList
18087
+ * @summary List States Custom
18088
+ * @request GET:/states.custom.list
18089
+ * @secure
18090
+ */
18091
+ customStatesList: (query?: {
18092
+ /**
18093
+ * The cursor to resume iteration from, otherwise if not provided, then
18094
+ * iteration starts from the beginning.
18095
+ * @format text
18096
+ */
18097
+ cursor?: string;
18098
+ /** Whether only final states should be filtered. */
18099
+ is_final?: boolean;
18100
+ /**
18101
+ * The maximum number of items.
18102
+ * @format int32
18103
+ */
18104
+ limit?: number;
18105
+ /** The list of state names. */
18106
+ name?: string[];
18107
+ /** The list of state ordinals. */
18108
+ ordinal?: number[];
18109
+ /** The list of fields to sort the items by and how to sort them. */
18110
+ sort_by?: string[];
18111
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any>>;
18112
+ /**
18113
+ * @description Lists custom states.
18114
+ *
18115
+ * @tags customization
18116
+ * @name CustomStatesListPost
18117
+ * @summary List States Custom (POST)
18118
+ * @request POST:/states.custom.list
18119
+ * @secure
18120
+ */
18121
+ customStatesListPost: (data: CustomStatesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any>>;
18122
+ /**
18123
+ * @description Updates a custom state.
18124
+ *
18125
+ * @tags customization
18126
+ * @name CustomStatesUpdate
18127
+ * @summary Update States Custom
18128
+ * @request POST:/states.custom.update
18129
+ * @secure
18130
+ */
18131
+ customStatesUpdate: (data: CustomStatesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesUpdateResponse, any>>;
15874
18132
  /**
15875
18133
  * @description Creates a schema for survey, which includes name and description of schema.
15876
18134
  *
@@ -16406,6 +18664,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
16406
18664
  * @secure
16407
18665
  */
16408
18666
  vistasGroupsList: (query?: {
18667
+ /**
18668
+ * Filters for vista group items which have one of the parts linked as
18669
+ * its ancestor part or primary part.
18670
+ * @example ["PROD-12345"]
18671
+ */
18672
+ ancestor_part?: string[];
18673
+ /**
18674
+ * Whether to include items belonging to children of any of the provided
18675
+ * parts.
18676
+ */
18677
+ 'applies_to_part.include_child_parts'?: boolean;
18678
+ /**
18679
+ * Part IDs to filter on. Required if any applies_to_part.* fields are
18680
+ * provided.
18681
+ * @example ["PROD-12345"]
18682
+ */
18683
+ 'applies_to_part.parts'?: string[];
16409
18684
  /**
16410
18685
  * Filter for vistas group item created by any of these users.
16411
18686
  * @example ["DEVU-12345"]