@devrev/typescript-sdk 1.1.30 → 1.1.32

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.
@@ -420,6 +420,20 @@ export type AppFragmentSummary = CustomSchemaFragmentBaseSummary;
420
420
  * Metric with corresponding target values.
421
421
  */
422
422
  export interface ArchetypeMetricTarget {
423
+ /**
424
+ * For breached metrics the time they entered into breach. This is the
425
+ * same as what the target date was, unless the breach happened due to
426
+ * a different policy starting to apply.
427
+ * @format date-time
428
+ * @example "2023-01-01T12:00:00.000Z"
429
+ */
430
+ breached_at?: string;
431
+ /**
432
+ * For completed metrics the time (in minutes) it took to complete
433
+ * them. (Taking into account the schedule if any).
434
+ * @format int32
435
+ */
436
+ completed_in?: number;
423
437
  /**
424
438
  * If true, the schedule attached to this metric is out of schedule at
425
439
  * the time of the query. It is not set for metrics in *completed*
@@ -427,12 +441,26 @@ export interface ArchetypeMetricTarget {
427
441
  */
428
442
  is_out_of_schedule?: boolean;
429
443
  metric_definition: MetricDefinitionSummary;
444
+ /**
445
+ * The next time the schedule will change its state, if such is known.
446
+ * @format date-time
447
+ * @example "2023-01-01T12:00:00.000Z"
448
+ */
449
+ next_schedule_transition?: string;
430
450
  org_schedule?: OrgScheduleSummary;
431
451
  /**
432
452
  * Time in minutes that remains on a paused metric.
433
453
  * @format int32
434
454
  */
435
455
  remaining_time?: number;
456
+ /** Metric stage corresponding to the applicable SLA. */
457
+ stage: string;
458
+ /**
459
+ * It is an indicator of whether the metric has ever been breached
460
+ * (missed). If not, it shows whether the metric is completed, in
461
+ * progress, or not part of the applied policy.
462
+ */
463
+ status?: string;
436
464
  /**
437
465
  * Time at which the metric would breach SLA if no action taken.
438
466
  * @format date-time
@@ -1046,7 +1074,7 @@ export interface AtomBaseSummary {
1046
1074
  id: string;
1047
1075
  }
1048
1076
  /** atom-summary */
1049
- export type AtomSummary = (AccountSummary | AppFragmentSummary | CapabilitySummary | ConversationSummary | CustomTypeFragmentSummary | DevUserSummary | EngagementSummary | EnhancementSummary | FeatureSummary | IssueSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineChangeEventSummary | TimelineCommentSummary | WebhookSummary) & {
1077
+ export type AtomSummary = (AccountSummary | AppFragmentSummary | CapabilitySummary | ConversationSummary | CustomTypeFragmentSummary | DevUserSummary | EngagementSummary | EnhancementSummary | FeatureSummary | IssueSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineChangeEventSummary | TimelineCommentSummary | UserPreferencesSummary | WebhookSummary) & {
1050
1078
  type: AtomType;
1051
1079
  };
1052
1080
  export declare enum AtomType {
@@ -1073,6 +1101,7 @@ export declare enum AtomType {
1073
1101
  Ticket = "ticket",
1074
1102
  TimelineChangeEvent = "timeline_change_event",
1075
1103
  TimelineComment = "timeline_comment",
1104
+ UserPreferences = "user_preferences",
1076
1105
  Webhook = "webhook"
1077
1106
  }
1078
1107
  /**
@@ -1494,6 +1523,14 @@ export interface AuthTokensUserTraits {
1494
1523
  /** Phone numbers of the Rev user. */
1495
1524
  phone_numbers?: string[];
1496
1525
  }
1526
+ /**
1527
+ * availability-preferences-group
1528
+ * Preferences group for Availability.
1529
+ */
1530
+ export interface AvailabilityPreferencesGroup {
1531
+ /** Manually set presence to away. */
1532
+ manual_away?: boolean;
1533
+ }
1497
1534
  /**
1498
1535
  * boolean-expression
1499
1536
  * Boolean expression.
@@ -1666,6 +1703,7 @@ export type CodeChange = AtomBase & {
1666
1703
  };
1667
1704
  /** Source of the code change object. */
1668
1705
  export declare enum CodeChangeSource {
1706
+ AzureDevops = "azure_devops",
1669
1707
  Bitbucket = "bitbucket",
1670
1708
  Github = "github"
1671
1709
  }
@@ -2278,6 +2316,16 @@ export interface CreateEmailPreviewWidget {
2278
2316
  /** The list of to addresses. */
2279
2317
  to?: CreateEmailInfo[];
2280
2318
  }
2319
+ /** create-impacted-customer-details */
2320
+ export interface CreateImpactedCustomerDetails {
2321
+ /**
2322
+ * Count of customers impacted.
2323
+ * @format int64
2324
+ */
2325
+ count?: number;
2326
+ /** List of customers impacted due to the incident. */
2327
+ customer_ids?: string[];
2328
+ }
2281
2329
  /** create-org-schedule-interval */
2282
2330
  export interface CreateOrgScheduleInterval {
2283
2331
  /**
@@ -2348,6 +2396,103 @@ export interface CreateWeeklyOrgScheduleInterval {
2348
2396
  * Static collection of Devrev objects.
2349
2397
  */
2350
2398
  export type CuratedVistaSummary = VistaBaseSummary;
2399
+ /** custom-link-type */
2400
+ export type CustomLinkType = AtomBase;
2401
+ /** custom-link-type-create-request */
2402
+ export interface CustomLinkTypeCreateRequest {
2403
+ /** The name of the link in the backward direction. */
2404
+ backward_name: string;
2405
+ /** Whether the link type is deprecated. */
2406
+ deprecated?: boolean;
2407
+ /** The name of the link in the forward direction. */
2408
+ forward_name: string;
2409
+ /** The name of the custom link type. */
2410
+ name: string;
2411
+ /** Types from which the link can be made from. */
2412
+ source_types: LinkTargetDescriptor[];
2413
+ /** Types to which the link can be made to. */
2414
+ target_types: LinkTargetDescriptor[];
2415
+ /** The tooltip of the custom link type. */
2416
+ tooltip?: string;
2417
+ }
2418
+ /** custom-link-type-create-response */
2419
+ export interface CustomLinkTypeCreateResponse {
2420
+ custom_link_type: CustomLinkType;
2421
+ }
2422
+ /** custom-link-type-get-request */
2423
+ export interface CustomLinkTypeGetRequest {
2424
+ /** The ID of the custom link type to get. */
2425
+ id: string;
2426
+ }
2427
+ /** custom-link-type-get-response */
2428
+ export interface CustomLinkTypeGetResponse {
2429
+ custom_link_type: CustomLinkType;
2430
+ }
2431
+ /** custom-link-type-list-request */
2432
+ export interface CustomLinkTypeListRequest {
2433
+ /**
2434
+ * The cursor to resume iteration from. If not provided, then
2435
+ * iteration starts from the beginning.
2436
+ */
2437
+ cursor?: string;
2438
+ /** Whether only deprecated link types should be filtered. */
2439
+ deprecated?: boolean;
2440
+ /**
2441
+ * The maximum number of items.
2442
+ * @format int32
2443
+ */
2444
+ limit?: number;
2445
+ /**
2446
+ * The iteration mode to use. If "after", then entries after the provided
2447
+ * cursor will be returned, or if no cursor is provided, then from the
2448
+ * beginning. If "before", then entries before the provided cursor will be
2449
+ * returned, or if no cursor is provided, then from the end. Entries will
2450
+ * always be returned in the specified sort-by order.
2451
+ */
2452
+ mode?: ListMode;
2453
+ /** The list of link type names. */
2454
+ name?: string[];
2455
+ /** The list of fields to sort the items by and how to sort them. */
2456
+ sort_by?: string[];
2457
+ source_types?: LinkDescriptorFilter;
2458
+ target_types?: LinkDescriptorFilter;
2459
+ }
2460
+ /** custom-link-type-list-response */
2461
+ export interface CustomLinkTypeListResponse {
2462
+ /**
2463
+ * The cursor used to iterate subsequent results in accordance to the
2464
+ * sort order. If not set, then no later elements exist.
2465
+ */
2466
+ next_cursor?: string;
2467
+ /**
2468
+ * The cursor used to iterate preceding results in accordance to the
2469
+ * sort order. If not set, then no prior elements exist.
2470
+ */
2471
+ prev_cursor?: string;
2472
+ /** The custom link types. */
2473
+ result: CustomLinkType[];
2474
+ }
2475
+ /** custom-link-type-update-request */
2476
+ export interface CustomLinkTypeUpdateRequest {
2477
+ /** The updated name of the link in the backward direction. */
2478
+ backward_name?: string;
2479
+ /** Whether the link type is deprecated. */
2480
+ deprecated?: boolean;
2481
+ /** The updated name of the link in the forward direction. */
2482
+ forward_name?: string;
2483
+ /** The ID of the custom link type to update. */
2484
+ id: string;
2485
+ /** The updated name of the custom link type. */
2486
+ name?: string;
2487
+ source_types?: UpdateLinkTargetDescriptorList;
2488
+ target_types?: UpdateLinkTargetDescriptorList;
2489
+ /** The updated tooltip of the custom link type. */
2490
+ tooltip?: string;
2491
+ }
2492
+ /** custom-link-type-update-response */
2493
+ export interface CustomLinkTypeUpdateResponse {
2494
+ custom_link_type: CustomLinkType;
2495
+ }
2351
2496
  /** custom-object-search-summary */
2352
2497
  export type CustomObjectSearchSummary = SearchSummaryBase & {
2353
2498
  custom_object: CustomObjectSummary;
@@ -2952,6 +3097,13 @@ export interface DevOrgAuthConnectionsUpdateResponse {
2952
3097
  }
2953
3098
  /** dev-user */
2954
3099
  export type DevUser = UserBase & {
3100
+ /** Custom fields. */
3101
+ custom_fields?: object;
3102
+ /**
3103
+ * Custom schema fragments.
3104
+ * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
3105
+ */
3106
+ custom_schema_fragments?: string[];
2955
3107
  /**
2956
3108
  * Start date of the user's employment.
2957
3109
  * @format date-time
@@ -2964,6 +3116,13 @@ export type DevUser = UserBase & {
2964
3116
  job_history?: JobHistoryItem[];
2965
3117
  /** Array of skills of the user. */
2966
3118
  skills?: UserSkill[];
3119
+ /**
3120
+ * Stock schema fragment.
3121
+ * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
3122
+ */
3123
+ stock_schema_fragment?: string;
3124
+ /** Subtype corresponding to the custom type fragment. */
3125
+ subtype?: string;
2967
3126
  };
2968
3127
  /** dev-user-external-identity-filter */
2969
3128
  export interface DevUserExternalIdentityFilter {
@@ -3055,6 +3214,8 @@ export interface DevUsersListRequest {
3055
3214
  * iteration starts from the beginning.
3056
3215
  */
3057
3216
  cursor?: string;
3217
+ /** Filters for custom fields. */
3218
+ custom_fields?: object;
3058
3219
  /** Filters Dev users based on email addresses. */
3059
3220
  email?: string[];
3060
3221
  /** Filters Dev users based on external identity. */
@@ -3115,6 +3276,16 @@ export interface DevUsersSelfResponse {
3115
3276
  * user.
3116
3277
  */
3117
3278
  export interface DevUsersSelfUpdateRequest {
3279
+ /** Application-defined custom fields. */
3280
+ custom_fields?: object;
3281
+ /**
3282
+ * Requested custom schemas described abstractly. Every provided schema's
3283
+ * custom field must be specified, otherwise a bad request error is
3284
+ * returned. If a new custom schema specifier is provided, then it will be
3285
+ * added to the work, otherwise if a custom schema is omitted from the
3286
+ * specifier, it remains unmodified.
3287
+ */
3288
+ custom_schema_spec?: CustomSchemaSpec;
3118
3289
  /** The updated display name of the Dev user. */
3119
3290
  display_name?: string;
3120
3291
  /**
@@ -3162,6 +3333,16 @@ export interface DevUsersUpdateJobHistoryItem {
3162
3333
  * provided Dev user.
3163
3334
  */
3164
3335
  export interface DevUsersUpdateRequest {
3336
+ /** Application-defined custom fields. */
3337
+ custom_fields?: object;
3338
+ /**
3339
+ * Requested custom schemas described abstractly. Every provided schema's
3340
+ * custom field must be specified, otherwise a bad request error is
3341
+ * returned. If a new custom schema specifier is provided, then it will be
3342
+ * added to the work, otherwise if a custom schema is omitted from the
3343
+ * specifier, it remains unmodified.
3344
+ */
3345
+ custom_schema_spec?: CustomSchemaSpec;
3165
3346
  /** The updated display name of the Dev user. */
3166
3347
  display_name?: string;
3167
3348
  /**
@@ -3549,7 +3730,8 @@ export interface ErrorBadRequestMergeWorksErrorError {
3549
3730
  different_workspace?: ErrorBadRequestMergeWorksErrorErrorDifferentWorkspace;
3550
3731
  invalid_stage_transition?: ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition;
3551
3732
  locked?: ErrorBadRequestMergeWorksErrorErrorLocked;
3552
- subtype?: 'already_merged' | 'closed' | 'different_reporters' | 'different_workspace' | 'invalid_stage_transition' | 'locked';
3733
+ stage_not_found_for_subtype?: ErrorBadRequestMergeWorksErrorErrorStageNotFoundForSubtype;
3734
+ subtype?: 'already_merged' | 'closed' | 'different_reporters' | 'different_workspace' | 'invalid_stage_transition' | 'locked' | 'stage_not_found_for_subtype';
3553
3735
  /** The ID of the work which failed the validation. */
3554
3736
  work: string;
3555
3737
  }
@@ -3583,6 +3765,11 @@ export interface ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition {
3583
3765
  }
3584
3766
  /** error-bad-request-merge-works-error-error-locked */
3585
3767
  export type ErrorBadRequestMergeWorksErrorErrorLocked = object;
3768
+ /** error-bad-request-merge-works-error-error-stage-not-found-for-subtype */
3769
+ export interface ErrorBadRequestMergeWorksErrorErrorStageNotFoundForSubtype {
3770
+ /** The subtype of the work for which stage is not configured. */
3771
+ subtype?: string;
3772
+ }
3586
3773
  /** error-bad-request-missing-dependency */
3587
3774
  export interface ErrorBadRequestMissingDependency {
3588
3775
  /** The dependent fields. */
@@ -3790,6 +3977,11 @@ export interface EventDevUserUpdated {
3790
3977
  dev_user: DevUser;
3791
3978
  old_dev_user?: DevUser;
3792
3979
  }
3980
+ export declare enum EventFetchedResult {
3981
+ Forbidden = "forbidden",
3982
+ NotFound = "not_found",
3983
+ Ok = "ok"
3984
+ }
3793
3985
  /** event-group-created */
3794
3986
  export interface EventGroupCreated {
3795
3987
  group: Group;
@@ -3988,6 +4180,16 @@ export interface EventSourcesScheduleEventResponse {
3988
4180
  */
3989
4181
  event_key?: string;
3990
4182
  }
4183
+ /** event-survey-created */
4184
+ export interface EventSurveyCreated {
4185
+ survey: Survey;
4186
+ }
4187
+ /** event-survey-deleted */
4188
+ export interface EventSurveyDeleted {
4189
+ /** The ID of the survey that was deleted. */
4190
+ id: string;
4191
+ old_survey?: Survey;
4192
+ }
3991
4193
  /** event-survey-response-created */
3992
4194
  export interface EventSurveyResponseCreated {
3993
4195
  survey_response: SurveyResponse;
@@ -3996,11 +4198,18 @@ export interface EventSurveyResponseCreated {
3996
4198
  export interface EventSurveyResponseDeleted {
3997
4199
  /** The ID of the survey response that was deleted. */
3998
4200
  id: string;
4201
+ old_survey_response?: SurveyResponse;
3999
4202
  }
4000
4203
  /** event-survey-response-updated */
4001
4204
  export interface EventSurveyResponseUpdated {
4205
+ old_survey_response?: SurveyResponse;
4002
4206
  survey_response: SurveyResponse;
4003
4207
  }
4208
+ /** event-survey-updated */
4209
+ export interface EventSurveyUpdated {
4210
+ old_survey?: Survey;
4211
+ survey: Survey;
4212
+ }
4004
4213
  /** event-tag-created */
4005
4214
  export interface EventTagCreated {
4006
4215
  tag: Tag;
@@ -4062,6 +4271,19 @@ export interface EventWorkDeleted {
4062
4271
  id: string;
4063
4272
  old_work?: Work;
4064
4273
  }
4274
+ /** event-work-fetched */
4275
+ export type EventWorkFetched = (Empty | EventWorkFetchedOk) & {
4276
+ /**
4277
+ * The ID of the work that was fetched.
4278
+ * @example "ISS-12345"
4279
+ */
4280
+ id: string;
4281
+ result: EventFetchedResult;
4282
+ };
4283
+ /** event-work-fetched-ok */
4284
+ export interface EventWorkFetchedOk {
4285
+ work?: Work;
4286
+ }
4065
4287
  /** event-work-updated */
4066
4288
  export interface EventWorkUpdated {
4067
4289
  old_work?: Work;
@@ -4218,6 +4440,21 @@ export declare enum FieldValueType {
4218
4440
  TagSummary = "tag_summary",
4219
4441
  TagSummaryList = "tag_summary_list"
4220
4442
  }
4443
+ /**
4444
+ * general-preferences-group
4445
+ * Preferences group for General settings.
4446
+ */
4447
+ export interface GeneralPreferencesGroup {
4448
+ /** Preferences group for Availability. */
4449
+ availability?: AvailabilityPreferencesGroup;
4450
+ /** Preferred locale of the user. */
4451
+ preferred_locale?: GeneralPreferencesGroupPreferredLocale;
4452
+ }
4453
+ /** Preferred locale of the user. */
4454
+ export declare enum GeneralPreferencesGroupPreferredLocale {
4455
+ EnUs = "en_us",
4456
+ JaJp = "ja_jp"
4457
+ }
4221
4458
  /** Event type of the notification. */
4222
4459
  export declare enum GenericNotificationEventType {
4223
4460
  Alert = "alert",
@@ -4238,6 +4475,11 @@ export type Group = AtomBase & {
4238
4475
  name?: string;
4239
4476
  owner?: UserSummary;
4240
4477
  };
4478
+ /** Creation source of the group. */
4479
+ export declare enum GroupIngestionSource {
4480
+ Airdrop = "airdrop",
4481
+ Scim = "scim"
4482
+ }
4241
4483
  /** Type of the members in the group. */
4242
4484
  export declare enum GroupMemberType {
4243
4485
  DevUser = "dev_user",
@@ -4407,6 +4649,8 @@ export interface GroupsListRequest {
4407
4649
  cursor?: string;
4408
4650
  /** Filters the groups based on the group type. */
4409
4651
  group_type?: GroupType[];
4652
+ /** Filter groups by ingestion source(s). */
4653
+ ingestion_source?: GroupIngestionSource[];
4410
4654
  /** Whether to fetch default or custom groups. */
4411
4655
  is_default?: boolean;
4412
4656
  /**
@@ -4472,8 +4716,24 @@ export interface GroupsUpdateRequestDynamicGroupInfo {
4472
4716
  export interface GroupsUpdateResponse {
4473
4717
  group: Group;
4474
4718
  }
4719
+ /**
4720
+ * impacted-customer-details
4721
+ * Details of the impact due to the incident.
4722
+ */
4723
+ export interface ImpactedCustomerDetails {
4724
+ /** The properties of an enum value. */
4725
+ count?: EnumValue;
4726
+ /** List of customers impacted due to the incident. */
4727
+ customer_ids?: AccountSummary[];
4728
+ }
4475
4729
  /** incident */
4476
4730
  export type Incident = AtomBase & {
4731
+ /**
4732
+ * Timestamp when the incident was acknowledged.
4733
+ * @format date-time
4734
+ * @example "2023-01-01T12:00:00.000Z"
4735
+ */
4736
+ acknowledged_date?: string;
4477
4737
  /** Parts to which the incident is applicable to. */
4478
4738
  applies_to_parts?: PartSummary[];
4479
4739
  /** Artifacts attached to the incident. */
@@ -4493,6 +4753,8 @@ export type Incident = AtomBase & {
4493
4753
  * @example "2023-01-01T12:00:00.000Z"
4494
4754
  */
4495
4755
  identified_date?: string;
4756
+ /** Details of the impact due to the incident. */
4757
+ impact?: ImpactedCustomerDetails;
4496
4758
  /** List of customers impacted due to the incident. */
4497
4759
  impacted_customers?: AccountSummary[];
4498
4760
  /**
@@ -4504,7 +4766,11 @@ export type Incident = AtomBase & {
4504
4766
  /** The users that own the incident. */
4505
4767
  owned_by?: UserSummary[];
4506
4768
  /** The properties of an enum value. */
4769
+ reported_by?: EnumValue;
4770
+ /** The properties of an enum value. */
4507
4771
  severity?: EnumValue;
4772
+ /** The properties of an enum value. */
4773
+ source?: EnumValue;
4508
4774
  /** Describes the current stage of a object. */
4509
4775
  stage?: Stage;
4510
4776
  /**
@@ -4532,6 +4798,12 @@ export type Incident = AtomBase & {
4532
4798
  };
4533
4799
  /** incidents-create-request */
4534
4800
  export interface IncidentsCreateRequest {
4801
+ /**
4802
+ * Timestamp when the incident was acknowledged.
4803
+ * @format date-time
4804
+ * @example "2023-01-01T12:00:00.000Z"
4805
+ */
4806
+ acknowledged_date?: string;
4535
4807
  /** Parts to which the incident is applicable to. */
4536
4808
  applies_to_parts?: string[];
4537
4809
  /**
@@ -4557,6 +4829,7 @@ export interface IncidentsCreateRequest {
4557
4829
  * @example "2023-01-01T12:00:00.000Z"
4558
4830
  */
4559
4831
  identified_date?: string;
4832
+ impact?: CreateImpactedCustomerDetails;
4560
4833
  /** List of customers impacted due to the incident. */
4561
4834
  impacted_customers?: string[];
4562
4835
  /**
@@ -4567,11 +4840,28 @@ export interface IncidentsCreateRequest {
4567
4840
  mitigated_date?: string;
4568
4841
  /** User IDs of the users that own the incident. */
4569
4842
  owned_by?: string[];
4843
+ /** The article ids of the Post-Incident Analysis(PIA) of the incident. */
4844
+ pia?: string[];
4845
+ /** The article ids of the playbook(s) associated with the incident. */
4846
+ playbooks?: string[];
4847
+ /** The article ids of other documents associated with the incident. */
4848
+ related_docs?: string[];
4849
+ /**
4850
+ * The entity that first reported the incident.
4851
+ * @format int64
4852
+ */
4853
+ reported_by?: number;
4570
4854
  /**
4571
4855
  * Severity of the incident.
4572
4856
  * @format int64
4573
4857
  */
4574
4858
  severity?: number;
4859
+ /**
4860
+ * Source of where the incident was created. Only sys users and
4861
+ * service accounts are supposed to set this field.
4862
+ * @format int64
4863
+ */
4864
+ source?: number;
4575
4865
  /** Create object for stage. */
4576
4866
  stage?: CreateStage;
4577
4867
  /**
@@ -4620,8 +4910,7 @@ export interface IncidentsGetResponse {
4620
4910
  export interface IncidentsGroup {
4621
4911
  /** The group of incidents. */
4622
4912
  incidents: Incident[];
4623
- /** Unique key according to which the items are grouped. */
4624
- key: string;
4913
+ key: FieldValue;
4625
4914
  /**
4626
4915
  * The cursor used to iterate subsequent results in accordance to the
4627
4916
  * sort order. If not set, then no later elements exist.
@@ -4635,6 +4924,10 @@ export interface IncidentsGroup {
4635
4924
  }
4636
4925
  /** incidents-group-request */
4637
4926
  export interface IncidentsGroupRequest {
4927
+ /** Provides ways to specify date ranges on objects. */
4928
+ acknowledged_date?: DateFilter;
4929
+ /** Provides ways to specify date ranges on objects. */
4930
+ actual_close_date?: DateFilter;
4638
4931
  /** Filters for incidents that apply to any of the provided parts. */
4639
4932
  applies_to_parts?: string[];
4640
4933
  /**
@@ -4651,6 +4944,8 @@ export interface IncidentsGroupRequest {
4651
4944
  cursor?: string;
4652
4945
  /** The field to group the incidents by. */
4653
4946
  group_by: string;
4947
+ /** Provides ways to specify date ranges on objects. */
4948
+ identified_date?: DateFilter;
4654
4949
  /**
4655
4950
  * The maximum number of groups to return. If not set, then the
4656
4951
  * default is '10'.
@@ -4663,6 +4958,8 @@ export interface IncidentsGroupRequest {
4663
4958
  * @format int32
4664
4959
  */
4665
4960
  limit_per_group?: number;
4961
+ /** Provides ways to specify date ranges on objects. */
4962
+ mitigated_date?: DateFilter;
4666
4963
  /**
4667
4964
  * The iteration mode to use. If "after", then entries after the provided
4668
4965
  * cursor will be returned, or if no cursor is provided, then from the
@@ -4675,12 +4972,33 @@ export interface IncidentsGroupRequest {
4675
4972
  modified_date?: DateFilter;
4676
4973
  /** Filters for incidents owned by any of the provided users. */
4677
4974
  owned_by?: string[];
4975
+ /**
4976
+ * Filters for incidents with any of the provided PIAs.
4977
+ * @example ["ARTICLE-12345"]
4978
+ */
4979
+ pia?: string[];
4980
+ /**
4981
+ * Filters for incidents with any of the provided playbooks.
4982
+ * @example ["ARTICLE-12345"]
4983
+ */
4984
+ playbook?: string[];
4985
+ /**
4986
+ * Filters for incidents with any of the provided related docs.
4987
+ * @example ["ARTICLE-12345"]
4988
+ */
4989
+ related_docs?: string[];
4990
+ /** Filters for incidents with any of the provided reporters. */
4991
+ reported_by?: number[];
4678
4992
  /** Filters for incidents containing any of the provided severities. */
4679
4993
  severity?: number[];
4680
4994
  /** Comma-separated fields to sort the incidents by. */
4681
4995
  sort_by?: string[];
4996
+ /** Filters for incidents with any of the provided sources. */
4997
+ source?: number[];
4682
4998
  /** Filters for incidents in any of the provided stages. */
4683
4999
  stage?: string[];
5000
+ /** Provides ways to specify date ranges on objects. */
5001
+ target_close_date?: DateFilter;
4684
5002
  /** Filters for incidents by the provided titles. */
4685
5003
  title?: string[];
4686
5004
  }
@@ -4701,6 +5019,10 @@ export interface IncidentsGroupResponse {
4701
5019
  }
4702
5020
  /** incidents-list-request */
4703
5021
  export interface IncidentsListRequest {
5022
+ /** Provides ways to specify date ranges on objects. */
5023
+ acknowledged_date?: DateFilter;
5024
+ /** Provides ways to specify date ranges on objects. */
5025
+ actual_close_date?: DateFilter;
4704
5026
  /** Filters for incidents that apply to any of the provided parts. */
4705
5027
  applies_to_parts?: string[];
4706
5028
  /**
@@ -4715,11 +5037,15 @@ export interface IncidentsListRequest {
4715
5037
  * iteration starts from the beginning.
4716
5038
  */
4717
5039
  cursor?: string;
5040
+ /** Provides ways to specify date ranges on objects. */
5041
+ identified_date?: DateFilter;
4718
5042
  /**
4719
5043
  * The maximum number of items.
4720
5044
  * @format int32
4721
5045
  */
4722
5046
  limit?: number;
5047
+ /** Provides ways to specify date ranges on objects. */
5048
+ mitigated_date?: DateFilter;
4723
5049
  /**
4724
5050
  * The iteration mode to use. If "after", then entries after the provided
4725
5051
  * cursor will be returned, or if no cursor is provided, then from the
@@ -4732,12 +5058,33 @@ export interface IncidentsListRequest {
4732
5058
  modified_date?: DateFilter;
4733
5059
  /** Filters for incidents owned by any of the provided users. */
4734
5060
  owned_by?: string[];
5061
+ /**
5062
+ * Filters for incidents with any of the provided PIAs.
5063
+ * @example ["ARTICLE-12345"]
5064
+ */
5065
+ pia?: string[];
5066
+ /**
5067
+ * Filters for incidents with any of the provided playbooks.
5068
+ * @example ["ARTICLE-12345"]
5069
+ */
5070
+ playbook?: string[];
5071
+ /**
5072
+ * Filters for incidents with any of the provided related docs.
5073
+ * @example ["ARTICLE-12345"]
5074
+ */
5075
+ related_docs?: string[];
5076
+ /** Filters for incidents with any of the provided reporters. */
5077
+ reported_by?: number[];
4735
5078
  /** Filters for incidents containing any of the provided severities. */
4736
5079
  severity?: number[];
4737
5080
  /** The list of fields to sort the items by and how to sort them. */
4738
5081
  sort_by?: string[];
5082
+ /** Filters for incidents with any of the provided sources. */
5083
+ source?: number[];
4739
5084
  /** Filters for incidents in any of the provided stages. */
4740
5085
  stage?: string[];
5086
+ /** Provides ways to specify date ranges on objects. */
5087
+ target_close_date?: DateFilter;
4741
5088
  /** Filters for incidents by the provided titles. */
4742
5089
  title?: string[];
4743
5090
  }
@@ -4758,6 +5105,12 @@ export interface IncidentsListResponse {
4758
5105
  }
4759
5106
  /** incidents-update-request */
4760
5107
  export interface IncidentsUpdateRequest {
5108
+ /**
5109
+ * Timestamp when the incident was acknowledged.
5110
+ * @format date-time
5111
+ * @example "2023-01-01T12:00:00.000Z"
5112
+ */
5113
+ acknowledged_date?: string;
4761
5114
  applies_to_parts?: UpdateIncidentAppliesToParts;
4762
5115
  artifacts?: UpdateIncidentArtifacts;
4763
5116
  /** Body of the incident. */
@@ -4780,6 +5133,7 @@ export interface IncidentsUpdateRequest {
4780
5133
  * @example "2023-01-01T12:00:00.000Z"
4781
5134
  */
4782
5135
  identified_date?: string;
5136
+ impact?: UpdateImpactedCustomerDetails;
4783
5137
  impacted_customers?: UpdateIncidentImpactedCustomers;
4784
5138
  /**
4785
5139
  * Timestamp when the incident was mitigated.
@@ -4788,11 +5142,25 @@ export interface IncidentsUpdateRequest {
4788
5142
  */
4789
5143
  mitigated_date?: string;
4790
5144
  owned_by?: UpdateIncidentOwnedBy;
5145
+ pia?: UpdateIncidentPia;
5146
+ playbooks?: UpdateIncidentPlaybooks;
5147
+ related_docs?: UpdateIncidentRelatedDocs;
5148
+ /**
5149
+ * The entity that first reported the incident.
5150
+ * @format int64
5151
+ */
5152
+ reported_by?: number;
4791
5153
  /**
4792
5154
  * Severity of the incident.
4793
5155
  * @format int64
4794
5156
  */
4795
5157
  severity?: number;
5158
+ /**
5159
+ * Source of where the incident was created. Only sys users and
5160
+ * service accounts are supposed to set this field.
5161
+ * @format int64
5162
+ */
5163
+ source?: number;
4796
5164
  /** Update object for Stage. */
4797
5165
  stage?: UpdateStage;
4798
5166
  stakeholders?: UpdateIncidentStakeholders;
@@ -4938,6 +5306,11 @@ export type Link = AtomBase & {
4938
5306
  source: LinkEndpointSummary;
4939
5307
  target: LinkEndpointSummary;
4940
5308
  };
5309
+ /** link-descriptor-filter */
5310
+ export interface LinkDescriptorFilter {
5311
+ /** List of link descriptors. */
5312
+ link_descriptors: LinkTargetDescriptor[];
5313
+ }
4941
5314
  /** link-endpoint-summary */
4942
5315
  export type LinkEndpointSummary = (CapabilitySummary | ConversationSummary | EnhancementSummary | FeatureSummary | IssueSummary | OpportunitySummary | ProductSummary | TaskSummary | TicketSummary) & {
4943
5316
  type: LinkEndpointType;
@@ -4997,6 +5370,11 @@ export type LinkSummary = AtomBaseSummary & {
4997
5370
  source: LinkEndpointSummary;
4998
5371
  target: LinkEndpointSummary;
4999
5372
  };
5373
+ /**
5374
+ * link-target-descriptor
5375
+ * A link target descriptor.
5376
+ */
5377
+ export type LinkTargetDescriptor = object;
5000
5378
  /** Type of link used to define the relationship. */
5001
5379
  export declare enum LinkType {
5002
5380
  CustomLink = "custom_link",
@@ -6015,6 +6393,31 @@ export type PartsUpdateRequestProduct = object;
6015
6393
  export interface PartsUpdateResponse {
6016
6394
  part: Part;
6017
6395
  }
6396
+ /** preferences */
6397
+ export type Preferences = UserPreferences & {
6398
+ type: PreferencesType;
6399
+ };
6400
+ /** preferences-base */
6401
+ export type PreferencesBase = AtomBase;
6402
+ /** preferences-base-summary */
6403
+ export type PreferencesBaseSummary = AtomBaseSummary;
6404
+ /** preferences-get-request */
6405
+ export interface PreferencesGetRequest {
6406
+ type: PreferencesType;
6407
+ /**
6408
+ * The ID of the target object for which preferences object is to be
6409
+ * fetched.
6410
+ * @example "DEV-AbCdEfGh"
6411
+ */
6412
+ object: string;
6413
+ }
6414
+ /** preferences-get-response */
6415
+ export interface PreferencesGetResponse {
6416
+ preference: Preferences;
6417
+ }
6418
+ export declare enum PreferencesType {
6419
+ UserPreferences = "user_preferences"
6420
+ }
6018
6421
  /** product */
6019
6422
  export type Product = PartBase;
6020
6423
  /** product-summary */
@@ -6379,7 +6782,7 @@ export interface RevOrgsCreateRequest {
6379
6782
  * Account Id to associate with this Rev organization.
6380
6783
  * @example "ACC-12345"
6381
6784
  */
6382
- account?: string;
6785
+ account: string;
6383
6786
  /**
6384
6787
  * The IDs of the artifacts to associate with the Rev organization.
6385
6788
  * @example ["ARTIFACT-12345"]
@@ -8163,6 +8566,7 @@ export type SnapWidgetBase = AtomBase & {
8163
8566
  };
8164
8567
  /** Logical grouping of snap widgets. Useful for filtering. */
8165
8568
  export declare enum SnapWidgetNamespace {
8569
+ AiAssistantMessage = "ai_assistant_message",
8166
8570
  CommentSuggestionReplies = "comment_suggestion_replies",
8167
8571
  EmailPreview = "email_preview",
8168
8572
  LinkPreview = "link_preview",
@@ -8197,7 +8601,10 @@ export interface SnapWidgetsCreateResponse {
8197
8601
  * stage
8198
8602
  * Describes the current stage of a object.
8199
8603
  */
8200
- export type Stage = object;
8604
+ export interface Stage {
8605
+ stage?: CustomStageSummary;
8606
+ state?: CustomStateSummary;
8607
+ }
8201
8608
  /** stage-diagram-summary */
8202
8609
  export type StageDiagramSummary = AtomBaseSummary;
8203
8610
  /**
@@ -8360,6 +8767,8 @@ export interface SubtypesListResponse {
8360
8767
  export type Survey = AtomBase & {
8361
8768
  /** Description of the survey. */
8362
8769
  description?: string;
8770
+ /** Header of the survey. */
8771
+ header?: string;
8363
8772
  /** Text posted when introducing the survey to the responder. */
8364
8773
  introductory_text?: string;
8365
8774
  /**
@@ -8373,6 +8782,8 @@ export type Survey = AtomBase & {
8373
8782
  schema?: SchemaFieldDescriptor[];
8374
8783
  /** List of all the fields and their respective metadata in the schema. */
8375
8784
  schema_with_metadata?: SurveyFieldWithMetadata[];
8785
+ /** Title of the survey. */
8786
+ title?: string;
8376
8787
  };
8377
8788
  /**
8378
8789
  * survey-aggregation-filter
@@ -8413,6 +8824,8 @@ export type SurveyResponse = AtomBase & {
8413
8824
  export interface SurveysCreateRequest {
8414
8825
  /** Description about the survey. */
8415
8826
  description?: string;
8827
+ /** Header of the survey. */
8828
+ header?: string;
8416
8829
  /** Text posted when introducing the survey to the responder. */
8417
8830
  introductory_text?: string;
8418
8831
  /** The survey's name. */
@@ -8423,6 +8836,8 @@ export interface SurveysCreateRequest {
8423
8836
  schema?: FieldDescriptor[];
8424
8837
  /** The schema with metadata for the survey. */
8425
8838
  schema_with_metadata?: SurveyFieldWithMetadata[];
8839
+ /** Title of the survey. */
8840
+ title?: string;
8426
8841
  }
8427
8842
  /** surveys-create-response */
8428
8843
  export interface SurveysCreateResponse {
@@ -8606,6 +9021,8 @@ export interface SurveysSubmitRequest {
8606
9021
  export type SurveysSubmitResponse = object;
8607
9022
  /** sync-metadata-filter */
8608
9023
  export interface SyncMetadataFilter {
9024
+ /** Filters for issues with this specific external reference. */
9025
+ external_reference?: string[];
8609
9026
  last_sync_in?: SyncMetadataFilterSyncInFilter;
8610
9027
  last_sync_out?: SyncMetadataFilterSyncOutFilter;
8611
9028
  /** Filters for issues synced from this specific origin system. */
@@ -8926,6 +9343,14 @@ export type Ticket = WorkBase & {
8926
9343
  rev_org?: OrgSummary;
8927
9344
  /** The properties of an enum value. */
8928
9345
  sentiment?: EnumValue;
9346
+ /**
9347
+ * Timestamp when the sentiment was last modified.
9348
+ * @format date-time
9349
+ * @example "2023-01-01T12:00:00.000Z"
9350
+ */
9351
+ sentiment_modified_date?: string;
9352
+ /** Summary justifying the sentiment. */
9353
+ sentiment_summary?: string;
8929
9354
  /** Severity of the ticket. */
8930
9355
  severity?: TicketSeverity;
8931
9356
  sla_tracker?: SlaTrackerSummary;
@@ -9034,6 +9459,7 @@ export type TimelineComment = TimelineEntryBase & {
9034
9459
  };
9035
9460
  /** The type of the body to use for the comment. */
9036
9461
  export declare enum TimelineCommentBodyType {
9462
+ Data = "data",
9037
9463
  SnapKit = "snap_kit",
9038
9464
  SnapWidget = "snap_widget",
9039
9465
  Text = "text"
@@ -9107,6 +9533,8 @@ export interface TimelineEntriesCreateRequestTimelineComment {
9107
9533
  /**
9108
9534
  * The external reference for the comment. This must be unique within
9109
9535
  * the object's timeline.
9536
+ * @minLength 1
9537
+ * @maxLength 512
9110
9538
  */
9111
9539
  external_ref?: string;
9112
9540
  /**
@@ -9156,6 +9584,8 @@ export interface TimelineEntriesGetRequest {
9156
9584
  /**
9157
9585
  * If set, then gets the entry with the given external reference for
9158
9586
  * the provided entry ID's timeline.
9587
+ * @minLength 1
9588
+ * @maxLength 512
9159
9589
  */
9160
9590
  external_ref?: string;
9161
9591
  /**
@@ -9257,6 +9687,14 @@ export interface TimelineEntriesUpdateRequestTimelineComment {
9257
9687
  body?: string;
9258
9688
  /** The type of the body to use for the comment. */
9259
9689
  body_type?: TimelineCommentBodyType;
9690
+ /**
9691
+ * The updated external reference for the comment. If set, this must
9692
+ * be unique within the object's timeline, otherwise if null, then
9693
+ * clears the value.
9694
+ * @minLength 1
9695
+ * @maxLength 512
9696
+ */
9697
+ external_ref?: string | null;
9260
9698
  link_previews?: TimelineEntriesUpdateRequestTimelineCommentLinkPreviews;
9261
9699
  /** Snap Kit Body of the comment. */
9262
9700
  snap_kit_body?: TimelineSnapKitBody;
@@ -9372,6 +9810,8 @@ export declare enum TimelineEntryObjectType {
9372
9810
  }
9373
9811
  /** Display panels for the Timeline entry. */
9374
9812
  export declare enum TimelineEntryPanel {
9813
+ Alerts = "alerts",
9814
+ Broadcasts = "broadcasts",
9375
9815
  CustomerChat = "customer_chat",
9376
9816
  Discussions = "discussions",
9377
9817
  Events = "events"
@@ -9794,6 +10234,20 @@ export interface UomsUpdateRequestDimensions {
9794
10234
  export interface UomsUpdateResponse {
9795
10235
  uom: Uom;
9796
10236
  }
10237
+ /** update-impacted-customer-details */
10238
+ export interface UpdateImpactedCustomerDetails {
10239
+ /**
10240
+ * Count of customers impacted.
10241
+ * @format int64
10242
+ */
10243
+ count?: number;
10244
+ customer_ids?: UpdateImpactedCustomerDetailsCustomerIds;
10245
+ }
10246
+ /** update-impacted-customer-details-customer-ids */
10247
+ export interface UpdateImpactedCustomerDetailsCustomerIds {
10248
+ /** Sets the list of customers impacted due to the incident. */
10249
+ set?: string[];
10250
+ }
9797
10251
  /** update-incident-applies-to-parts */
9798
10252
  export interface UpdateIncidentAppliesToParts {
9799
10253
  /** Sets the parts to which the incident is applicable to. */
@@ -9817,6 +10271,30 @@ export interface UpdateIncidentOwnedBy {
9817
10271
  /** Sets the user IDs of the users that own the incident. */
9818
10272
  set?: string[];
9819
10273
  }
10274
+ /** update-incident-pia */
10275
+ export interface UpdateIncidentPia {
10276
+ /**
10277
+ * Sets the the article ids of the Post-Incident Analysis(PIA) of the
10278
+ * incident.
10279
+ */
10280
+ set?: string[];
10281
+ }
10282
+ /** update-incident-playbooks */
10283
+ export interface UpdateIncidentPlaybooks {
10284
+ /**
10285
+ * Sets the the article ids of the playbook(s) associated with the
10286
+ * incident.
10287
+ */
10288
+ set?: string[];
10289
+ }
10290
+ /** update-incident-related-docs */
10291
+ export interface UpdateIncidentRelatedDocs {
10292
+ /**
10293
+ * Sets the the article ids of other documents associated with the
10294
+ * incident.
10295
+ */
10296
+ set?: string[];
10297
+ }
9820
10298
  /** update-incident-stakeholders */
9821
10299
  export interface UpdateIncidentStakeholders {
9822
10300
  /**
@@ -9830,6 +10308,11 @@ export interface UpdateIncidentTags {
9830
10308
  /** Sets the tags associated with the object. */
9831
10309
  set?: UpdateTagWithValue[];
9832
10310
  }
10311
+ /** update-link-target-descriptor-list */
10312
+ export interface UpdateLinkTargetDescriptorList {
10313
+ /** List of link descriptors. */
10314
+ link_descriptors: LinkTargetDescriptor[];
10315
+ }
9833
10316
  /**
9834
10317
  * update-stage
9835
10318
  * Update object for Stage.
@@ -9879,6 +10362,13 @@ export type UserBaseSummary = AtomBaseSummary & {
9879
10362
  /** State of the user. */
9880
10363
  state?: UserState;
9881
10364
  };
10365
+ /** user-preferences */
10366
+ export type UserPreferences = PreferencesBase & {
10367
+ /** Preferences group for General settings. */
10368
+ general_preferences?: GeneralPreferencesGroup;
10369
+ };
10370
+ /** user-preferences-summary */
10371
+ export type UserPreferencesSummary = PreferencesBaseSummary;
9882
10372
  /** user-search-summary */
9883
10373
  export type UserSearchSummary = SearchSummaryBase & {
9884
10374
  /**
@@ -10027,9 +10517,12 @@ export interface WebhookEventRequest {
10027
10517
  sla_tracker_created?: EventSlaTrackerCreated;
10028
10518
  sla_tracker_deleted?: EventSlaTrackerDeleted;
10029
10519
  sla_tracker_updated?: EventSlaTrackerUpdated;
10520
+ survey_created?: EventSurveyCreated;
10521
+ survey_deleted?: EventSurveyDeleted;
10030
10522
  survey_response_created?: EventSurveyResponseCreated;
10031
10523
  survey_response_deleted?: EventSurveyResponseDeleted;
10032
10524
  survey_response_updated?: EventSurveyResponseUpdated;
10525
+ survey_updated?: EventSurveyUpdated;
10033
10526
  tag_created?: EventTagCreated;
10034
10527
  tag_deleted?: EventTagDeleted;
10035
10528
  tag_updated?: EventTagUpdated;
@@ -10056,6 +10549,7 @@ export interface WebhookEventRequest {
10056
10549
  webhook_updated?: EventWebhookUpdated;
10057
10550
  work_created?: EventWorkCreated;
10058
10551
  work_deleted?: EventWorkDeleted;
10552
+ work_fetched?: EventWorkFetched;
10059
10553
  work_updated?: EventWorkUpdated;
10060
10554
  }
10061
10555
  /** webhook-event-response */
@@ -10098,6 +10592,12 @@ export declare enum WebhookEventType {
10098
10592
  SlaTrackerCreated = "sla_tracker_created",
10099
10593
  SlaTrackerDeleted = "sla_tracker_deleted",
10100
10594
  SlaTrackerUpdated = "sla_tracker_updated",
10595
+ SurveyCreated = "survey_created",
10596
+ SurveyDeleted = "survey_deleted",
10597
+ SurveyResponseCreated = "survey_response_created",
10598
+ SurveyResponseDeleted = "survey_response_deleted",
10599
+ SurveyResponseUpdated = "survey_response_updated",
10600
+ SurveyUpdated = "survey_updated",
10101
10601
  TagCreated = "tag_created",
10102
10602
  TagDeleted = "tag_deleted",
10103
10603
  TagUpdated = "tag_updated",
@@ -10110,6 +10610,7 @@ export declare enum WebhookEventType {
10110
10610
  WebhookUpdated = "webhook_updated",
10111
10611
  WorkCreated = "work_created",
10112
10612
  WorkDeleted = "work_deleted",
10613
+ WorkFetched = "work_fetched",
10113
10614
  WorkUpdated = "work_updated"
10114
10615
  }
10115
10616
  /** webhook-event-verify */
@@ -10187,6 +10688,27 @@ export interface WebhooksDeleteRequest {
10187
10688
  * The response to deleting the webhook.
10188
10689
  */
10189
10690
  export type WebhooksDeleteResponse = object;
10691
+ /**
10692
+ * webhooks-fetch-request
10693
+ * The request to fetch an object for a webhook.
10694
+ */
10695
+ export interface WebhooksFetchRequest {
10696
+ /**
10697
+ * The ID of the webhook to fetch the object for.
10698
+ * @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
10699
+ */
10700
+ id: string;
10701
+ /**
10702
+ * The ID of the object to fetch for the webhook.
10703
+ * @example "ISS-12345"
10704
+ */
10705
+ object: string;
10706
+ }
10707
+ /**
10708
+ * webhooks-fetch-response
10709
+ * The response to fetching an object for a webhook.
10710
+ */
10711
+ export type WebhooksFetchResponse = object;
10190
10712
  /**
10191
10713
  * webhooks-get-request
10192
10714
  * The request to get a webhook's information.
@@ -10954,6 +11476,14 @@ export interface WorksUpdateRequestTicket {
10954
11476
  * @format int64
10955
11477
  */
10956
11478
  sentiment?: number;
11479
+ /**
11480
+ * Timestamp at which sentiment was last modified.
11481
+ * @format date-time
11482
+ * @example "2023-01-01T12:00:00.000Z"
11483
+ */
11484
+ sentiment_modified_date?: string;
11485
+ /** Summary justifying the current sentiment. */
11486
+ sentiment_summary?: string;
10957
11487
  /** Severity of the ticket. */
10958
11488
  severity?: TicketSeverity;
10959
11489
  }
@@ -12069,6 +12599,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12069
12599
  * starts from the beginning.
12070
12600
  */
12071
12601
  cursor?: string;
12602
+ /** Filters for custom fields. */
12603
+ custom_fields?: object;
12072
12604
  /** Filters Dev users based on email addresses. */
12073
12605
  email?: string[];
12074
12606
  /** Unique ID of the user in the external source. */
@@ -12351,6 +12883,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12351
12883
  cursor?: string;
12352
12884
  /** Filters the groups based on the group type. */
12353
12885
  group_type?: GroupType[];
12886
+ /** Filter groups by ingestion source(s). */
12887
+ ingestion_source?: GroupIngestionSource[];
12354
12888
  /** Whether to fetch default or custom groups. */
12355
12889
  is_default?: boolean;
12356
12890
  /**
@@ -12522,10 +13056,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12522
13056
  mode?: ListMode;
12523
13057
  /** Filters for incidents owned by any of the provided users. */
12524
13058
  owned_by?: string[];
13059
+ /**
13060
+ * Filters for incidents with any of the provided PIAs.
13061
+ * @example ["ARTICLE-12345"]
13062
+ */
13063
+ pia?: string[];
13064
+ /**
13065
+ * Filters for incidents with any of the provided playbooks.
13066
+ * @example ["ARTICLE-12345"]
13067
+ */
13068
+ playbook?: string[];
13069
+ /**
13070
+ * Filters for incidents with any of the provided related docs.
13071
+ * @example ["ARTICLE-12345"]
13072
+ */
13073
+ related_docs?: string[];
13074
+ /** Filters for incidents with any of the provided reporters. */
13075
+ reported_by?: number[];
12525
13076
  /** Filters for incidents containing any of the provided severities. */
12526
13077
  severity?: number[];
12527
13078
  /** Comma-separated fields to sort the incidents by. */
12528
13079
  sort_by?: string[];
13080
+ /** Filters for incidents with any of the provided sources. */
13081
+ source?: number[];
12529
13082
  /** Filters for incidents in any of the provided stages. */
12530
13083
  stage?: string[];
12531
13084
  /** Filters for incidents by the provided titles. */
@@ -12573,10 +13126,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12573
13126
  mode?: ListMode;
12574
13127
  /** Filters for incidents owned by any of the provided users. */
12575
13128
  owned_by?: string[];
13129
+ /**
13130
+ * Filters for incidents with any of the provided PIAs.
13131
+ * @example ["ARTICLE-12345"]
13132
+ */
13133
+ pia?: string[];
13134
+ /**
13135
+ * Filters for incidents with any of the provided playbooks.
13136
+ * @example ["ARTICLE-12345"]
13137
+ */
13138
+ playbook?: string[];
13139
+ /**
13140
+ * Filters for incidents with any of the provided related docs.
13141
+ * @example ["ARTICLE-12345"]
13142
+ */
13143
+ related_docs?: string[];
13144
+ /** Filters for incidents with any of the provided reporters. */
13145
+ reported_by?: number[];
12576
13146
  /** Filters for incidents containing any of the provided severities. */
12577
13147
  severity?: number[];
12578
13148
  /** The list of fields to sort the items by and how to sort them. */
12579
13149
  sort_by?: string[];
13150
+ /** Filters for incidents with any of the provided sources. */
13151
+ source?: number[];
12580
13152
  /** Filters for incidents in any of the provided stages. */
12581
13153
  stage?: string[];
12582
13154
  /** Filters for incidents by the provided titles. */
@@ -12622,6 +13194,85 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12622
13194
  * @secure
12623
13195
  */
12624
13196
  keyringsCreateCallbackPost: (data: KeyringsCreateCallbackRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
13197
+ /**
13198
+ * @description Creates a custom link type.
13199
+ *
13200
+ * @tags customization
13201
+ * @name CustomLinkTypeCreate
13202
+ * @request POST:/link-types.custom.create
13203
+ * @secure
13204
+ */
13205
+ customLinkTypeCreate: (data: CustomLinkTypeCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeCreateResponse, any>>;
13206
+ /**
13207
+ * @description Gets a custom link type.
13208
+ *
13209
+ * @tags customization
13210
+ * @name CustomLinkTypeGet
13211
+ * @request GET:/link-types.custom.get
13212
+ * @secure
13213
+ */
13214
+ customLinkTypeGet: (query: {
13215
+ /** The ID of the custom link type to get. */
13216
+ id: string;
13217
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeGetResponse, any>>;
13218
+ /**
13219
+ * @description Gets a custom link type.
13220
+ *
13221
+ * @tags customization
13222
+ * @name CustomLinkTypeGetPost
13223
+ * @request POST:/link-types.custom.get
13224
+ * @secure
13225
+ */
13226
+ customLinkTypeGetPost: (data: CustomLinkTypeGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeGetResponse, any>>;
13227
+ /**
13228
+ * @description Lists custom link types.
13229
+ *
13230
+ * @tags customization
13231
+ * @name CustomLinkTypeList
13232
+ * @request GET:/link-types.custom.list
13233
+ * @secure
13234
+ */
13235
+ customLinkTypeList: (query?: {
13236
+ /**
13237
+ * The cursor to resume iteration from. If not provided, then iteration
13238
+ * starts from the beginning.
13239
+ */
13240
+ cursor?: string;
13241
+ /** Whether only deprecated link types should be filtered. */
13242
+ deprecated?: boolean;
13243
+ /**
13244
+ * The maximum number of items.
13245
+ * @format int32
13246
+ */
13247
+ limit?: number;
13248
+ /**
13249
+ * The iteration mode to use, otherwise if not set, then "after" is
13250
+ * used.
13251
+ */
13252
+ mode?: ListMode;
13253
+ /** The list of link type names. */
13254
+ name?: string[];
13255
+ /** The list of fields to sort the items by and how to sort them. */
13256
+ sort_by?: string[];
13257
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeListResponse, any>>;
13258
+ /**
13259
+ * @description Lists custom link types.
13260
+ *
13261
+ * @tags customization
13262
+ * @name CustomLinkTypeListPost
13263
+ * @request POST:/link-types.custom.list
13264
+ * @secure
13265
+ */
13266
+ customLinkTypeListPost: (data: CustomLinkTypeListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeListResponse, any>>;
13267
+ /**
13268
+ * @description Updates a custom link type.
13269
+ *
13270
+ * @tags customization
13271
+ * @name CustomLinkTypeUpdate
13272
+ * @request POST:/link-types.custom.update
13273
+ * @secure
13274
+ */
13275
+ customLinkTypeUpdate: (data: CustomLinkTypeUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeUpdateResponse, any>>;
12625
13276
  /**
12626
13277
  * @description Creates a link between two objects to indicate a relationship.
12627
13278
  *
@@ -13029,6 +13680,33 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
13029
13680
  * @secure
13030
13681
  */
13031
13682
  partsUpdate: (data: PartsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsUpdateResponse, any>>;
13683
+ /**
13684
+ * @description Get the preferences object.
13685
+ *
13686
+ * @tags preferences
13687
+ * @name PreferencesGet
13688
+ * @request GET:/preferences.get
13689
+ * @secure
13690
+ */
13691
+ preferencesGet: (query: {
13692
+ /**
13693
+ * The ID of the target object for which preferences object is to be
13694
+ * fetched.
13695
+ * @example "DEV-AbCdEfGh"
13696
+ */
13697
+ object: string;
13698
+ /** Type of the preference object to be fetched. */
13699
+ type: PreferencesType;
13700
+ }, params?: RequestParams) => Promise<AxiosResponse<PreferencesGetResponse, any>>;
13701
+ /**
13702
+ * @description Get the preferences object.
13703
+ *
13704
+ * @tags preferences
13705
+ * @name PreferencesGetPost
13706
+ * @request POST:/preferences.get
13707
+ * @secure
13708
+ */
13709
+ preferencesGetPost: (data: PreferencesGetRequest, params?: RequestParams) => Promise<AxiosResponse<PreferencesGetResponse, any>>;
13032
13710
  /**
13033
13711
  * @description Creates a question-answer.
13034
13712
  *
@@ -14426,6 +15104,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
14426
15104
  /**
14427
15105
  * If set, then gets the entry with the given external reference for the
14428
15106
  * provided entry ID's timeline.
15107
+ * @minLength 1
15108
+ * @maxLength 512
14429
15109
  */
14430
15110
  external_ref?: string;
14431
15111
  }, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any>>;
@@ -14681,6 +15361,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
14681
15361
  * @secure
14682
15362
  */
14683
15363
  webhooksDelete: (data: WebhooksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
15364
+ /**
15365
+ * @description Fetches an object via webhook.
15366
+ *
15367
+ * @tags webhooks
15368
+ * @name WebhooksFetch
15369
+ * @request POST:/webhooks.fetch
15370
+ * @secure
15371
+ */
15372
+ webhooksFetch: (data: WebhooksFetchRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
14684
15373
  /**
14685
15374
  * @description Gets the requested webhook's information.
14686
15375
  *
@@ -14822,6 +15511,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
14822
15511
  'stage.name'?: string[];
14823
15512
  /** Filters for issues that are staged. */
14824
15513
  'staged_info.is_staged'?: boolean;
15514
+ /** Filters for issues with this specific external reference. */
15515
+ 'sync_metadata.external_reference'?: string[];
14825
15516
  /** Filters for works with selected sync statuses. */
14826
15517
  'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
14827
15518
  /** Filters for works modified with selected sync units. */
@@ -14976,6 +15667,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
14976
15667
  'stage.name'?: string[];
14977
15668
  /** Filters for issues that are staged. */
14978
15669
  'staged_info.is_staged'?: boolean;
15670
+ /** Filters for issues with this specific external reference. */
15671
+ 'sync_metadata.external_reference'?: string[];
14979
15672
  /** Filters for works with selected sync statuses. */
14980
15673
  'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
14981
15674
  /** Filters for works modified with selected sync units. */