@devrev/typescript-sdk 1.1.29 → 1.1.31

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.
@@ -305,6 +305,19 @@ export interface AccountsUpdateRequestArtifacts {
305
305
  export interface AccountsUpdateResponse {
306
306
  account: Account;
307
307
  }
308
+ /** add-tag-with-value */
309
+ export interface AddTagWithValue {
310
+ /**
311
+ * The ID of the tag.
312
+ * @example "TAG-12345"
313
+ */
314
+ id: string;
315
+ /**
316
+ * The value for the object's association with the tag. If specified,
317
+ * the value must be one that's specified in the tag's allowed values.
318
+ */
319
+ value?: string;
320
+ }
308
321
  /**
309
322
  * aggregated-schema
310
323
  * List of custom fields from multiple source fragments.
@@ -409,7 +422,8 @@ export type AppFragmentSummary = CustomSchemaFragmentBaseSummary;
409
422
  export interface ArchetypeMetricTarget {
410
423
  /**
411
424
  * If true, the schedule attached to this metric is out of schedule at
412
- * the time of the query.
425
+ * the time of the query. It is not set for metrics in *completed*
426
+ * stage.
413
427
  */
414
428
  is_out_of_schedule?: boolean;
415
429
  metric_definition: MetricDefinitionSummary;
@@ -559,6 +573,16 @@ export interface ArticlesCreateRequest {
559
573
  * @example ["DEVU-12345"]
560
574
  */
561
575
  authored_by?: string[];
576
+ /** Application-defined custom fields. */
577
+ custom_fields?: object;
578
+ /**
579
+ * Requested custom schemas described abstractly. Every provided schema's
580
+ * custom field must be specified, otherwise a bad request error is
581
+ * returned. If a new custom schema specifier is provided, then it will be
582
+ * added to the work, otherwise if a custom schema is omitted from the
583
+ * specifier, it remains unmodified.
584
+ */
585
+ custom_schema_spec?: CustomSchemaSpec;
562
586
  /** Description for the article. */
563
587
  description?: string;
564
588
  /**
@@ -739,6 +763,16 @@ export interface ArticlesUpdateRequest {
739
763
  applies_to_parts?: ArticlesUpdateRequestAppliesToParts;
740
764
  artifacts?: ArticlesUpdateRequestArtifacts;
741
765
  authored_by?: ArticlesUpdateRequestAuthoredBy;
766
+ /** Application-defined custom fields. */
767
+ custom_fields?: object;
768
+ /**
769
+ * Requested custom schemas described abstractly. Every provided schema's
770
+ * custom field must be specified, otherwise a bad request error is
771
+ * returned. If a new custom schema specifier is provided, then it will be
772
+ * added to the work, otherwise if a custom schema is omitted from the
773
+ * specifier, it remains unmodified.
774
+ */
775
+ custom_schema_spec?: CustomSchemaSpec;
742
776
  /**
743
777
  * Updated description of the article object, or unchanged if not
744
778
  * provided.
@@ -1012,7 +1046,7 @@ export interface AtomBaseSummary {
1012
1046
  id: string;
1013
1047
  }
1014
1048
  /** atom-summary */
1015
- export type AtomSummary = (AccountSummary | AppFragmentSummary | CapabilitySummary | ConversationSummary | CustomTypeFragmentSummary | DevUserSummary | EngagementSummary | EnhancementSummary | FeatureSummary | IssueSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineCommentSummary | WebhookSummary) & {
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 | UserPreferencesSummary | WebhookSummary) & {
1016
1050
  type: AtomType;
1017
1051
  };
1018
1052
  export declare enum AtomType {
@@ -1037,7 +1071,9 @@ export declare enum AtomType {
1037
1071
  Task = "task",
1038
1072
  TenantFragment = "tenant_fragment",
1039
1073
  Ticket = "ticket",
1074
+ TimelineChangeEvent = "timeline_change_event",
1040
1075
  TimelineComment = "timeline_comment",
1076
+ UserPreferences = "user_preferences",
1041
1077
  Webhook = "webhook"
1042
1078
  }
1043
1079
  /**
@@ -1218,6 +1254,11 @@ export declare enum AuthTokenTokenType {
1218
1254
  export interface AuthTokensAccountTraits {
1219
1255
  /** The display name of the account. */
1220
1256
  display_name?: string;
1257
+ /**
1258
+ * List of company's domain names on accounts. Example -
1259
+ * ['devrev.ai'].
1260
+ */
1261
+ domains?: string[];
1221
1262
  }
1222
1263
  /**
1223
1264
  * auth-tokens-create-request
@@ -1369,7 +1410,10 @@ export interface AuthTokensOrgTraits {
1369
1410
  description?: string;
1370
1411
  /** The display name of the Rev org. */
1371
1412
  display_name?: string;
1372
- /** The domain of the Rev org. */
1413
+ /**
1414
+ * The domain of the Rev org.
1415
+ * @deprecated
1416
+ */
1373
1417
  domain?: string;
1374
1418
  /** Phone numbers of the Rev org. */
1375
1419
  phone_numbers?: string[];
@@ -1451,6 +1495,14 @@ export interface AuthTokensUserTraits {
1451
1495
  /** Phone numbers of the Rev user. */
1452
1496
  phone_numbers?: string[];
1453
1497
  }
1498
+ /**
1499
+ * availability-preferences-group
1500
+ * Preferences group for Availability.
1501
+ */
1502
+ export interface AvailabilityPreferencesGroup {
1503
+ /** Manually set presence to away. */
1504
+ manual_away?: boolean;
1505
+ }
1454
1506
  /**
1455
1507
  * boolean-expression
1456
1508
  * Boolean expression.
@@ -1623,11 +1675,23 @@ export type CodeChange = AtomBase & {
1623
1675
  };
1624
1676
  /** Source of the code change object. */
1625
1677
  export declare enum CodeChangeSource {
1678
+ AzureDevops = "azure_devops",
1626
1679
  Bitbucket = "bitbucket",
1627
1680
  Github = "github"
1628
1681
  }
1629
1682
  /** code-changes-create-request */
1630
- export type CodeChangesCreateRequest = object;
1683
+ export interface CodeChangesCreateRequest {
1684
+ /** Application-defined custom fields. */
1685
+ custom_fields?: object;
1686
+ /**
1687
+ * Requested custom schemas described abstractly. Every provided schema's
1688
+ * custom field must be specified, otherwise a bad request error is
1689
+ * returned. If a new custom schema specifier is provided, then it will be
1690
+ * added to the work, otherwise if a custom schema is omitted from the
1691
+ * specifier, it remains unmodified.
1692
+ */
1693
+ custom_schema_spec?: CustomSchemaSpec;
1694
+ }
1631
1695
  /** code-changes-create-response */
1632
1696
  export interface CodeChangesCreateResponse {
1633
1697
  code_change: CodeChange;
@@ -1691,6 +1755,16 @@ export interface CodeChangesListResponse {
1691
1755
  }
1692
1756
  /** code-changes-update-request */
1693
1757
  export interface CodeChangesUpdateRequest {
1758
+ /** Application-defined custom fields. */
1759
+ custom_fields?: object;
1760
+ /**
1761
+ * Requested custom schemas described abstractly. Every provided schema's
1762
+ * custom field must be specified, otherwise a bad request error is
1763
+ * returned. If a new custom schema specifier is provided, then it will be
1764
+ * added to the work, otherwise if a custom schema is omitted from the
1765
+ * specifier, it remains unmodified.
1766
+ */
1767
+ custom_schema_spec?: CustomSchemaSpec;
1694
1768
  /** The ID of the code change object to be updated. */
1695
1769
  id: string;
1696
1770
  }
@@ -1717,6 +1791,115 @@ export interface CommentSearchSummary {
1717
1791
  /** Text snippet where the search hit occurred. */
1718
1792
  snippet?: string;
1719
1793
  }
1794
+ /** content-template */
1795
+ export interface ContentTemplate {
1796
+ type: ContentTemplateType;
1797
+ }
1798
+ /**
1799
+ * content-template-create-request
1800
+ * The request to create a new content template.
1801
+ */
1802
+ export type ContentTemplateCreateRequest = ContentTemplateCreateRequestNotificationContentTemplate & {
1803
+ type: ContentTemplateType;
1804
+ /**
1805
+ * Input fields schema. The fields will be used to replace variables
1806
+ * present in the content template.
1807
+ */
1808
+ input_fields_schema?: SchemaFieldDescriptor[];
1809
+ /**
1810
+ * The name of the content template. The name must be unique for each
1811
+ * creator of the content template.
1812
+ */
1813
+ name: string;
1814
+ };
1815
+ /** content-template-create-request-notification-content-template */
1816
+ export interface ContentTemplateCreateRequestNotificationContentTemplate {
1817
+ /**
1818
+ * Default notification template per language. Only one is permitted
1819
+ * per language. These will be used to replace the notification
1820
+ * content on basis of language preferences of the user. Default is
1821
+ * EN(US).
1822
+ */
1823
+ defaults: ContentTemplateCreateRequestNotificationContentTemplateDefaultNotificationContentTemplate[];
1824
+ }
1825
+ /** content-template-create-request-notification-content-template-default-notification-content-template */
1826
+ export interface ContentTemplateCreateRequestNotificationContentTemplateDefaultNotificationContentTemplate {
1827
+ /**
1828
+ * Body for the notification. In order to use fields from input fields
1829
+ * schema, use {field_name} in the body.
1830
+ */
1831
+ body: string;
1832
+ /**
1833
+ * Title for the notification. In order to use fields from input
1834
+ * fields schema, use {field_name} in the title.
1835
+ */
1836
+ title: string;
1837
+ }
1838
+ /** content-template-create-response */
1839
+ export interface ContentTemplateCreateResponse {
1840
+ content_template: ContentTemplate;
1841
+ }
1842
+ /** content-template-get-request */
1843
+ export interface ContentTemplateGetRequest {
1844
+ /** The content template's ID. */
1845
+ id: string;
1846
+ }
1847
+ /** content-template-get-response */
1848
+ export interface ContentTemplateGetResponse {
1849
+ content_template: ContentTemplate;
1850
+ }
1851
+ /** content-template-list-request */
1852
+ export interface ContentTemplateListRequest {
1853
+ /** Filters for content template of the provided types. */
1854
+ type?: ContentTemplateType[];
1855
+ /**
1856
+ * Filters for content template created by any of these users.
1857
+ * @example ["DEVU-12345"]
1858
+ */
1859
+ created_by?: string[];
1860
+ /**
1861
+ * The cursor to resume iteration from. If not provided, then
1862
+ * iteration starts from the beginning.
1863
+ */
1864
+ cursor?: string;
1865
+ /**
1866
+ * The maximum number of content template to return. The default is
1867
+ * '50'.
1868
+ * @format int32
1869
+ */
1870
+ limit?: number;
1871
+ /**
1872
+ * The iteration mode to use. If "after", then entries after the provided
1873
+ * cursor will be returned, or if no cursor is provided, then from the
1874
+ * beginning. If "before", then entries before the provided cursor will be
1875
+ * returned, or if no cursor is provided, then from the end. Entries will
1876
+ * always be returned in the specified sort-by order.
1877
+ */
1878
+ mode?: ListMode;
1879
+ /** Filters for content template based on name. */
1880
+ name?: string[];
1881
+ /**
1882
+ * Fields to sort the content template by and the direction to sort
1883
+ * them.
1884
+ */
1885
+ sort_by?: string[];
1886
+ }
1887
+ /** content-template-list-response */
1888
+ export interface ContentTemplateListResponse {
1889
+ /** The list of content templates. */
1890
+ content_template: ContentTemplate[];
1891
+ /**
1892
+ * The cursor used to iterate subsequent results in accordance to the
1893
+ * sort order. If not set, then no later elements exist.
1894
+ */
1895
+ next_cursor?: string;
1896
+ /**
1897
+ * The cursor used to iterate preceding results in accordance to the
1898
+ * sort order. If not set, then no prior elements exist.
1899
+ */
1900
+ prev_cursor?: string;
1901
+ }
1902
+ export type ContentTemplateType = string;
1720
1903
  /** conversation */
1721
1904
  export type Conversation = AtomBase & {
1722
1905
  /** Description of the conversation object. */
@@ -2105,6 +2288,16 @@ export interface CreateEmailPreviewWidget {
2105
2288
  /** The list of to addresses. */
2106
2289
  to?: CreateEmailInfo[];
2107
2290
  }
2291
+ /** create-impacted-customer-details */
2292
+ export interface CreateImpactedCustomerDetails {
2293
+ /**
2294
+ * Count of customers impacted.
2295
+ * @format int64
2296
+ */
2297
+ count?: number;
2298
+ /** List of customers impacted due to the incident. */
2299
+ customer_ids?: string[];
2300
+ }
2108
2301
  /** create-org-schedule-interval */
2109
2302
  export interface CreateOrgScheduleInterval {
2110
2303
  /**
@@ -2131,6 +2324,29 @@ export interface CreateOrgScheduleInterval {
2131
2324
  */
2132
2325
  to?: string;
2133
2326
  }
2327
+ /**
2328
+ * create-stage
2329
+ * Create object for stage.
2330
+ */
2331
+ export interface CreateStage {
2332
+ /** Notes relevant to the stage */
2333
+ notes?: string;
2334
+ /** DON of the stage. */
2335
+ stage: string;
2336
+ }
2337
+ /**
2338
+ * create-tag-with-value
2339
+ * Create object for tag_summary.
2340
+ */
2341
+ export interface CreateTagWithValue {
2342
+ /**
2343
+ * ID of the referenced tag
2344
+ * @example "TAG-12345"
2345
+ */
2346
+ tag_id: string;
2347
+ /** Value associated with the tag for the object. */
2348
+ value?: string;
2349
+ }
2134
2350
  /** create-weekly-org-schedule-interval */
2135
2351
  export interface CreateWeeklyOrgScheduleInterval {
2136
2352
  /**
@@ -2345,9 +2561,21 @@ export interface CustomSchemaSpec {
2345
2561
  validate_required_fields?: boolean;
2346
2562
  }
2347
2563
  /** custom-stage */
2348
- export type CustomStage = AtomBase;
2564
+ export type CustomStage = AtomBase & {
2565
+ /** The human readable name of the state. */
2566
+ name?: string;
2567
+ /**
2568
+ * Ordinal used to sort/group stages.
2569
+ * @format int32
2570
+ */
2571
+ ordinal?: number;
2572
+ state?: CustomStateSummary;
2573
+ };
2349
2574
  /** custom-stage-summary */
2350
- export type CustomStageSummary = AtomBaseSummary;
2575
+ export type CustomStageSummary = AtomBaseSummary & {
2576
+ /** The human readable name of the state. */
2577
+ name?: string;
2578
+ };
2351
2579
  /** custom-stages-create-request */
2352
2580
  export interface CustomStagesCreateRequest {
2353
2581
  /**
@@ -2426,7 +2654,22 @@ export interface CustomStagesUpdateResponse {
2426
2654
  custom_stage: CustomStage;
2427
2655
  }
2428
2656
  /** custom-state */
2429
- export type CustomState = AtomBase;
2657
+ export type CustomState = AtomBase & {
2658
+ /** True if this is a final state. */
2659
+ is_final?: boolean;
2660
+ /** The human readable name of the state. */
2661
+ name?: string;
2662
+ /**
2663
+ * Ordinal used to identify system states.
2664
+ * @format int32
2665
+ */
2666
+ ordinal?: number;
2667
+ };
2668
+ /** custom-state-summary */
2669
+ export type CustomStateSummary = AtomBaseSummary & {
2670
+ /** The human readable name of the state. */
2671
+ name?: string;
2672
+ };
2430
2673
  /** custom-states-create-request */
2431
2674
  export interface CustomStatesCreateRequest {
2432
2675
  /** Whether this is a final state. */
@@ -2894,11 +3137,45 @@ export interface DevUsersSelfResponse {
2894
3137
  export interface DevUsersSelfUpdateRequest {
2895
3138
  /** The updated display name of the Dev user. */
2896
3139
  display_name?: string;
3140
+ /**
3141
+ * Start date of Dev user's experience.
3142
+ * @format date-time
3143
+ * @example "2023-01-01T12:00:00.000Z"
3144
+ */
3145
+ experience_start_date?: string;
2897
3146
  /** The updated full name of the Dev user. */
2898
3147
  full_name?: string;
3148
+ /** Job history of the Dev user. */
3149
+ job_history?: DevUsersUpdateJobHistoryItem[];
2899
3150
  /** Job title of the Dev User. */
2900
3151
  job_title?: DevUserJobTitle;
2901
3152
  }
3153
+ /** dev-users-update-job-history-item */
3154
+ export interface DevUsersUpdateJobHistoryItem {
3155
+ /**
3156
+ * Enum for the employment status of the user.
3157
+ * @format int64
3158
+ */
3159
+ employment_status?: number;
3160
+ /**
3161
+ * End date of the job.
3162
+ * @format date-time
3163
+ * @example "2023-01-01T12:00:00.000Z"
3164
+ */
3165
+ end_date?: string;
3166
+ /** Is this the current active job for the user. */
3167
+ is_current?: boolean;
3168
+ /** The job location for the user. */
3169
+ location?: string;
3170
+ /**
3171
+ * Start date of the job.
3172
+ * @format date-time
3173
+ * @example "2023-01-01T12:00:00.000Z"
3174
+ */
3175
+ start_date?: string;
3176
+ /** The job title for the user. */
3177
+ title?: string;
3178
+ }
2902
3179
  /**
2903
3180
  * dev-users-update-request
2904
3181
  * A request to update the user's information corresponding to the
@@ -2907,10 +3184,18 @@ export interface DevUsersSelfUpdateRequest {
2907
3184
  export interface DevUsersUpdateRequest {
2908
3185
  /** The updated display name of the Dev user. */
2909
3186
  display_name?: string;
3187
+ /**
3188
+ * Start date of Dev user's experience.
3189
+ * @format date-time
3190
+ * @example "2023-01-01T12:00:00.000Z"
3191
+ */
3192
+ experience_start_date?: string;
2910
3193
  /** The updated full name of the Dev user. */
2911
3194
  full_name?: string;
2912
3195
  /** The ID for the Dev user to be updated. */
2913
3196
  id: string;
3197
+ /** Job history of the Dev user. */
3198
+ job_history?: DevUsersUpdateJobHistoryItem[];
2914
3199
  /** Job title of the Dev User. */
2915
3200
  job_title?: DevUserJobTitle;
2916
3201
  }
@@ -2996,6 +3281,8 @@ export type EngagementSummary = AtomBaseSummary;
2996
3281
  /** Type of engagement. */
2997
3282
  export declare enum EngagementType {
2998
3283
  Call = "call",
3284
+ Conversation = "conversation",
3285
+ Custom = "custom",
2999
3286
  Default = "default",
3000
3287
  Email = "email",
3001
3288
  LinkedIn = "linked_in",
@@ -3206,7 +3493,7 @@ export type EnhancementSummary = PartBaseSummary;
3206
3493
  */
3207
3494
  export interface EnumValue {
3208
3495
  /**
3209
- * The uiique ID of the enum value.
3496
+ * The unique ID of the enum value.
3210
3497
  * @format int64
3211
3498
  */
3212
3499
  id: number;
@@ -3278,9 +3565,12 @@ export interface ErrorBadRequestMergeWorksErrorError {
3278
3565
  closed?: ErrorBadRequestMergeWorksErrorErrorClosed;
3279
3566
  /** The details of the error. */
3280
3567
  details: string;
3568
+ different_reporters?: ErrorBadRequestMergeWorksErrorErrorDifferentReporters;
3281
3569
  different_workspace?: ErrorBadRequestMergeWorksErrorErrorDifferentWorkspace;
3282
3570
  invalid_stage_transition?: ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition;
3283
- subtype?: 'already_merged' | 'closed' | 'different_workspace' | 'invalid_stage_transition';
3571
+ locked?: ErrorBadRequestMergeWorksErrorErrorLocked;
3572
+ stage_not_found_for_subtype?: ErrorBadRequestMergeWorksErrorErrorStageNotFoundForSubtype;
3573
+ subtype?: 'already_merged' | 'closed' | 'different_reporters' | 'different_workspace' | 'invalid_stage_transition' | 'locked' | 'stage_not_found_for_subtype';
3284
3574
  /** The ID of the work which failed the validation. */
3285
3575
  work: string;
3286
3576
  }
@@ -3291,12 +3581,19 @@ export interface ErrorBadRequestMergeWorksErrorErrorAlreadyMerged {
3291
3581
  }
3292
3582
  /** error-bad-request-merge-works-error-error-closed */
3293
3583
  export type ErrorBadRequestMergeWorksErrorErrorClosed = object;
3584
+ /** error-bad-request-merge-works-error-error-different-reporters */
3585
+ export interface ErrorBadRequestMergeWorksErrorErrorDifferentReporters {
3586
+ /** The reporters of the primary work. */
3587
+ primary_reporters?: string[];
3588
+ /** The reporters of the secondary work. */
3589
+ secondary_reporters?: string[];
3590
+ }
3294
3591
  /** error-bad-request-merge-works-error-error-different-workspace */
3295
3592
  export interface ErrorBadRequestMergeWorksErrorErrorDifferentWorkspace {
3296
3593
  /** The workspace of the primary work. */
3297
- primary_workspace: string;
3594
+ primary_workspace?: string;
3298
3595
  /** The workspace of the secondary work. */
3299
- secondary_workspace: string;
3596
+ secondary_workspace?: string;
3300
3597
  }
3301
3598
  /** error-bad-request-merge-works-error-error-invalid-stage-transition */
3302
3599
  export interface ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition {
@@ -3305,6 +3602,13 @@ export interface ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition {
3305
3602
  /** The stage to which the transition isn't allowed. */
3306
3603
  requested_stage: string;
3307
3604
  }
3605
+ /** error-bad-request-merge-works-error-error-locked */
3606
+ export type ErrorBadRequestMergeWorksErrorErrorLocked = object;
3607
+ /** error-bad-request-merge-works-error-error-stage-not-found-for-subtype */
3608
+ export interface ErrorBadRequestMergeWorksErrorErrorStageNotFoundForSubtype {
3609
+ /** The subtype of the work for which stage is not configured. */
3610
+ subtype?: string;
3611
+ }
3308
3612
  /** error-bad-request-missing-dependency */
3309
3613
  export interface ErrorBadRequestMissingDependency {
3310
3614
  /** The dependent fields. */
@@ -3520,10 +3824,36 @@ export interface EventGroupCreated {
3520
3824
  export interface EventGroupDeleted {
3521
3825
  /** The ID of the group that was deleted. */
3522
3826
  id: string;
3827
+ old_group?: Group;
3828
+ }
3829
+ /** event-group-member-added */
3830
+ export interface EventGroupMemberAdded {
3831
+ group: GroupSummary;
3832
+ member: UserSummary;
3833
+ }
3834
+ /** event-group-member-removed */
3835
+ export interface EventGroupMemberRemoved {
3836
+ group: GroupSummary;
3837
+ member: UserSummary;
3523
3838
  }
3524
3839
  /** event-group-updated */
3525
3840
  export interface EventGroupUpdated {
3526
3841
  group: Group;
3842
+ old_group?: Group;
3843
+ }
3844
+ /** event-link-created */
3845
+ export interface EventLinkCreated {
3846
+ link: Link;
3847
+ }
3848
+ /** event-link-deleted */
3849
+ export interface EventLinkDeleted {
3850
+ /** The ID of the link that was deleted. */
3851
+ id: string;
3852
+ }
3853
+ /** event-link-updated */
3854
+ export interface EventLinkUpdated {
3855
+ link: Link;
3856
+ old_link?: Link;
3527
3857
  }
3528
3858
  /** event-part-created */
3529
3859
  export interface EventPartCreated {
@@ -3684,6 +4014,16 @@ export interface EventSourcesScheduleEventResponse {
3684
4014
  */
3685
4015
  event_key?: string;
3686
4016
  }
4017
+ /** event-survey-created */
4018
+ export interface EventSurveyCreated {
4019
+ survey: Survey;
4020
+ }
4021
+ /** event-survey-deleted */
4022
+ export interface EventSurveyDeleted {
4023
+ /** The ID of the survey that was deleted. */
4024
+ id: string;
4025
+ old_survey?: Survey;
4026
+ }
3687
4027
  /** event-survey-response-created */
3688
4028
  export interface EventSurveyResponseCreated {
3689
4029
  survey_response: SurveyResponse;
@@ -3692,11 +4032,18 @@ export interface EventSurveyResponseCreated {
3692
4032
  export interface EventSurveyResponseDeleted {
3693
4033
  /** The ID of the survey response that was deleted. */
3694
4034
  id: string;
4035
+ old_survey_response?: SurveyResponse;
3695
4036
  }
3696
4037
  /** event-survey-response-updated */
3697
4038
  export interface EventSurveyResponseUpdated {
4039
+ old_survey_response?: SurveyResponse;
3698
4040
  survey_response: SurveyResponse;
3699
4041
  }
4042
+ /** event-survey-updated */
4043
+ export interface EventSurveyUpdated {
4044
+ old_survey?: Survey;
4045
+ survey: Survey;
4046
+ }
3700
4047
  /** event-tag-created */
3701
4048
  export interface EventTagCreated {
3702
4049
  tag: Tag;
@@ -3781,11 +4128,154 @@ export interface ExternalIdentity {
3781
4128
  export type Feature = PartBase;
3782
4129
  /** feature-summary */
3783
4130
  export type FeatureSummary = PartBaseSummary;
4131
+ /**
4132
+ * field-delta
4133
+ * A field change.
4134
+ */
4135
+ export interface FieldDelta {
4136
+ /** Set of field attributes. */
4137
+ field_descriptor?: SchemaFieldDescriptor;
4138
+ /** The name of the field. */
4139
+ name?: string;
4140
+ new_value?: FieldValue;
4141
+ old_value?: FieldValue;
4142
+ }
3784
4143
  /**
3785
4144
  * field-descriptor
3786
4145
  * Set of field attributes.
3787
4146
  */
3788
4147
  export type FieldDescriptor = object;
4148
+ /** field-value */
4149
+ export type FieldValue = (FieldValueBool | FieldValueBoolList | FieldValueComposite | FieldValueCompositeList | FieldValueDateList | FieldValueDateTimeList | FieldValueDateTimeValue | FieldValueDateValue | FieldValueDouble | FieldValueDoubleList | FieldValueId | FieldValueIdList | FieldValueInt64 | FieldValueInt64List | FieldValueStage | FieldValueString | FieldValueStringList | FieldValueTagSummary | FieldValueTagSummaryList) & {
4150
+ type: FieldValueType;
4151
+ };
4152
+ /** field-value-bool */
4153
+ export interface FieldValueBool {
4154
+ value: boolean;
4155
+ }
4156
+ /** field-value-bool-list */
4157
+ export interface FieldValueBoolList {
4158
+ values: boolean[];
4159
+ }
4160
+ /** field-value-composite */
4161
+ export interface FieldValueComposite {
4162
+ fields: Record<string, FieldValue>;
4163
+ }
4164
+ /** field-value-composite-list */
4165
+ export interface FieldValueCompositeList {
4166
+ values: FieldValueComposite[];
4167
+ }
4168
+ /** field-value-date-list */
4169
+ export interface FieldValueDateList {
4170
+ /** @example ["2023-01-01"] */
4171
+ values: string[];
4172
+ }
4173
+ /** field-value-date-time-list */
4174
+ export interface FieldValueDateTimeList {
4175
+ /** @example ["2023-01-01T12:00:00.000Z"] */
4176
+ values: string[];
4177
+ }
4178
+ /** field-value-date-time-value */
4179
+ export interface FieldValueDateTimeValue {
4180
+ /**
4181
+ * @format date-time
4182
+ * @example "2023-01-01T12:00:00.000Z"
4183
+ */
4184
+ value: string;
4185
+ }
4186
+ /** field-value-date-value */
4187
+ export interface FieldValueDateValue {
4188
+ /**
4189
+ * @format date
4190
+ * @example "2023-01-01"
4191
+ */
4192
+ value: string;
4193
+ }
4194
+ /** field-value-double */
4195
+ export interface FieldValueDouble {
4196
+ /** @format double */
4197
+ value: number;
4198
+ }
4199
+ /** field-value-double-list */
4200
+ export interface FieldValueDoubleList {
4201
+ values: number[];
4202
+ }
4203
+ /** field-value-id */
4204
+ export interface FieldValueId {
4205
+ value: string;
4206
+ }
4207
+ /** field-value-id-list */
4208
+ export interface FieldValueIdList {
4209
+ values: string[];
4210
+ }
4211
+ /** field-value-int64 */
4212
+ export interface FieldValueInt64 {
4213
+ /** @format int64 */
4214
+ value: number;
4215
+ }
4216
+ /** field-value-int64-list */
4217
+ export interface FieldValueInt64List {
4218
+ values: number[];
4219
+ }
4220
+ /** field-value-stage */
4221
+ export interface FieldValueStage {
4222
+ name?: string;
4223
+ notes?: string;
4224
+ }
4225
+ /** field-value-string */
4226
+ export interface FieldValueString {
4227
+ value: string;
4228
+ }
4229
+ /** field-value-string-list */
4230
+ export interface FieldValueStringList {
4231
+ values: string[];
4232
+ }
4233
+ /** field-value-tag-summary */
4234
+ export interface FieldValueTagSummary {
4235
+ name?: string;
4236
+ style?: string;
4237
+ tag_id: string;
4238
+ }
4239
+ /** field-value-tag-summary-list */
4240
+ export interface FieldValueTagSummaryList {
4241
+ values: FieldValueTagSummary[];
4242
+ }
4243
+ export declare enum FieldValueType {
4244
+ Bool = "bool",
4245
+ BoolList = "bool_list",
4246
+ Composite = "composite",
4247
+ CompositeList = "composite_list",
4248
+ Date = "date",
4249
+ DateList = "date_list",
4250
+ DateTime = "date_time",
4251
+ DateTimeList = "date_time_list",
4252
+ Double = "double",
4253
+ DoubleList = "double_list",
4254
+ Id = "id",
4255
+ IdList = "id_list",
4256
+ Int = "int",
4257
+ IntList = "int_list",
4258
+ Stage = "stage",
4259
+ String = "string",
4260
+ StringList = "string_list",
4261
+ TagSummary = "tag_summary",
4262
+ TagSummaryList = "tag_summary_list"
4263
+ }
4264
+ /**
4265
+ * general-preferences-group
4266
+ * Preferences group for General settings.
4267
+ */
4268
+ export interface GeneralPreferencesGroup {
4269
+ /** Preferences group for Availability. */
4270
+ availability?: AvailabilityPreferencesGroup;
4271
+ /** Preferred locale of the user. */
4272
+ preferred_locale?: GeneralPreferencesGroupPreferredLocale;
4273
+ }
4274
+ /** Preferred locale of the user. */
4275
+ export declare enum GeneralPreferencesGroupPreferredLocale {
4276
+ EnUs = "en_us",
4277
+ JaJp = "ja_jp"
4278
+ }
3789
4279
  /** Event type of the notification. */
3790
4280
  export declare enum GenericNotificationEventType {
3791
4281
  Alert = "alert",
@@ -3806,6 +4296,11 @@ export type Group = AtomBase & {
3806
4296
  name?: string;
3807
4297
  owner?: UserSummary;
3808
4298
  };
4299
+ /** Creation source of the group. */
4300
+ export declare enum GroupIngestionSource {
4301
+ Airdrop = "airdrop",
4302
+ Scim = "scim"
4303
+ }
3809
4304
  /** Type of the members in the group. */
3810
4305
  export declare enum GroupMemberType {
3811
4306
  DevUser = "dev_user",
@@ -3975,6 +4470,8 @@ export interface GroupsListRequest {
3975
4470
  cursor?: string;
3976
4471
  /** Filters the groups based on the group type. */
3977
4472
  group_type?: GroupType[];
4473
+ /** Filter groups by ingestion source(s). */
4474
+ ingestion_source?: GroupIngestionSource[];
3978
4475
  /** Whether to fetch default or custom groups. */
3979
4476
  is_default?: boolean;
3980
4477
  /**
@@ -4040,11 +4537,27 @@ export interface GroupsUpdateRequestDynamicGroupInfo {
4040
4537
  export interface GroupsUpdateResponse {
4041
4538
  group: Group;
4042
4539
  }
4540
+ /**
4541
+ * impacted-customer-details
4542
+ * Details of the impact due to the incident.
4543
+ */
4544
+ export interface ImpactedCustomerDetails {
4545
+ /** The properties of an enum value. */
4546
+ count?: EnumValue;
4547
+ /** List of customers impacted due to the incident. */
4548
+ customer_ids?: AccountSummary[];
4549
+ }
4043
4550
  /** incident */
4044
4551
  export type Incident = AtomBase & {
4552
+ /**
4553
+ * Timestamp when the incident was acknowledged.
4554
+ * @format date-time
4555
+ * @example "2023-01-01T12:00:00.000Z"
4556
+ */
4557
+ acknowledged_date?: string;
4045
4558
  /** Parts to which the incident is applicable to. */
4046
4559
  applies_to_parts?: PartSummary[];
4047
- /** The artifacts attached to the incident. */
4560
+ /** Artifacts attached to the incident. */
4048
4561
  artifacts?: ArtifactSummary[];
4049
4562
  /** Body of the incident. */
4050
4563
  body?: string;
@@ -4060,19 +4573,25 @@ export type Incident = AtomBase & {
4060
4573
  * @format date-time
4061
4574
  * @example "2023-01-01T12:00:00.000Z"
4062
4575
  */
4063
- identified_at?: string;
4064
- /** List of customers impacted due to the Incident. */
4576
+ identified_date?: string;
4577
+ /** Details of the impact due to the incident. */
4578
+ impact?: ImpactedCustomerDetails;
4579
+ /** List of customers impacted due to the incident. */
4065
4580
  impacted_customers?: AccountSummary[];
4066
- /** The users that own the incident. */
4067
- owned_by?: UserSummary[];
4068
4581
  /**
4069
- * Timestamp when the incident was resolved.
4582
+ * Timestamp when the incident was mitigated.
4070
4583
  * @format date-time
4071
4584
  * @example "2023-01-01T12:00:00.000Z"
4072
4585
  */
4073
- resolved_at?: string;
4586
+ mitigated_date?: string;
4587
+ /** The users that own the incident. */
4588
+ owned_by?: UserSummary[];
4589
+ /** The properties of an enum value. */
4590
+ reported_by?: EnumValue;
4074
4591
  /** The properties of an enum value. */
4075
4592
  severity?: EnumValue;
4593
+ /** The properties of an enum value. */
4594
+ source?: EnumValue;
4076
4595
  /** Describes the current stage of a object. */
4077
4596
  stage?: Stage;
4078
4597
  /**
@@ -4098,6 +4617,101 @@ export type Incident = AtomBase & {
4098
4617
  /** Title of the incident. */
4099
4618
  title: string;
4100
4619
  };
4620
+ /** incidents-create-request */
4621
+ export interface IncidentsCreateRequest {
4622
+ /**
4623
+ * Timestamp when the incident was acknowledged.
4624
+ * @format date-time
4625
+ * @example "2023-01-01T12:00:00.000Z"
4626
+ */
4627
+ acknowledged_date?: string;
4628
+ /** Parts to which the incident is applicable to. */
4629
+ applies_to_parts?: string[];
4630
+ /**
4631
+ * Artifacts attached to the incident.
4632
+ * @example ["ARTIFACT-12345"]
4633
+ */
4634
+ artifacts?: string[];
4635
+ /** Body of the incident. */
4636
+ body?: string;
4637
+ /** Application-defined custom fields. */
4638
+ custom_fields?: object;
4639
+ /**
4640
+ * Requested custom schemas described abstractly. Every provided schema's
4641
+ * custom field must be specified, otherwise a bad request error is
4642
+ * returned. If a new custom schema specifier is provided, then it will be
4643
+ * added to the work, otherwise if a custom schema is omitted from the
4644
+ * specifier, it remains unmodified.
4645
+ */
4646
+ custom_schema_spec?: CustomSchemaSpec;
4647
+ /**
4648
+ * Time when the incident was identified/reported.
4649
+ * @format date-time
4650
+ * @example "2023-01-01T12:00:00.000Z"
4651
+ */
4652
+ identified_date?: string;
4653
+ impact?: CreateImpactedCustomerDetails;
4654
+ /** List of customers impacted due to the incident. */
4655
+ impacted_customers?: string[];
4656
+ /**
4657
+ * Timestamp when the incident was mitigated.
4658
+ * @format date-time
4659
+ * @example "2023-01-01T12:00:00.000Z"
4660
+ */
4661
+ mitigated_date?: string;
4662
+ /** User IDs of the users that own the incident. */
4663
+ owned_by?: string[];
4664
+ /**
4665
+ * The entity that first reported the incident.
4666
+ * @format int64
4667
+ */
4668
+ reported_by?: number;
4669
+ /**
4670
+ * Severity of the incident.
4671
+ * @format int64
4672
+ */
4673
+ severity?: number;
4674
+ /**
4675
+ * Source of where the incident was created. Only sys users and
4676
+ * service accounts are supposed to set this field.
4677
+ * @format int64
4678
+ */
4679
+ source?: number;
4680
+ /** Create object for stage. */
4681
+ stage?: CreateStage;
4682
+ /**
4683
+ * Users, along with the incident commander, involved in resolving
4684
+ * incidents and handling communication.
4685
+ */
4686
+ stakeholders?: string[];
4687
+ /** Tags associated with the object. */
4688
+ tags?: CreateTagWithValue[];
4689
+ /**
4690
+ * Timestamp when the incident is expected to be resolved.
4691
+ * @format date-time
4692
+ * @example "2023-01-01T12:00:00.000Z"
4693
+ */
4694
+ target_close_date?: string;
4695
+ /** Title of the incident. */
4696
+ title: string;
4697
+ }
4698
+ /** incidents-create-response */
4699
+ export interface IncidentsCreateResponse {
4700
+ incident: Incident;
4701
+ }
4702
+ /**
4703
+ * incidents-delete-request
4704
+ * A request to delete an incident.
4705
+ */
4706
+ export interface IncidentsDeleteRequest {
4707
+ /** ID for the incident. */
4708
+ id: string;
4709
+ }
4710
+ /**
4711
+ * incidents-delete-response
4712
+ * The response to deleting the incident.
4713
+ */
4714
+ export type IncidentsDeleteResponse = object;
4101
4715
  /** incidents-get-request */
4102
4716
  export interface IncidentsGetRequest {
4103
4717
  /** The ID of the incident to get. */
@@ -4126,6 +4740,10 @@ export interface IncidentsGroup {
4126
4740
  }
4127
4741
  /** incidents-group-request */
4128
4742
  export interface IncidentsGroupRequest {
4743
+ /** Provides ways to specify date ranges on objects. */
4744
+ acknowledged_date?: DateFilter;
4745
+ /** Provides ways to specify date ranges on objects. */
4746
+ actual_close_date?: DateFilter;
4129
4747
  /** Filters for incidents that apply to any of the provided parts. */
4130
4748
  applies_to_parts?: string[];
4131
4749
  /**
@@ -4142,6 +4760,8 @@ export interface IncidentsGroupRequest {
4142
4760
  cursor?: string;
4143
4761
  /** The field to group the incidents by. */
4144
4762
  group_by: string;
4763
+ /** Provides ways to specify date ranges on objects. */
4764
+ identified_date?: DateFilter;
4145
4765
  /**
4146
4766
  * The maximum number of groups to return. If not set, then the
4147
4767
  * default is '10'.
@@ -4154,6 +4774,8 @@ export interface IncidentsGroupRequest {
4154
4774
  * @format int32
4155
4775
  */
4156
4776
  limit_per_group?: number;
4777
+ /** Provides ways to specify date ranges on objects. */
4778
+ mitigated_date?: DateFilter;
4157
4779
  /**
4158
4780
  * The iteration mode to use. If "after", then entries after the provided
4159
4781
  * cursor will be returned, or if no cursor is provided, then from the
@@ -4166,12 +4788,18 @@ export interface IncidentsGroupRequest {
4166
4788
  modified_date?: DateFilter;
4167
4789
  /** Filters for incidents owned by any of the provided users. */
4168
4790
  owned_by?: string[];
4791
+ /** Filters for incidents with any of the provided reporters. */
4792
+ reported_by?: number[];
4169
4793
  /** Filters for incidents containing any of the provided severities. */
4170
4794
  severity?: number[];
4171
4795
  /** Comma-separated fields to sort the incidents by. */
4172
4796
  sort_by?: string[];
4797
+ /** Filters for incidents with any of the provided sources. */
4798
+ source?: number[];
4173
4799
  /** Filters for incidents in any of the provided stages. */
4174
4800
  stage?: string[];
4801
+ /** Provides ways to specify date ranges on objects. */
4802
+ target_close_date?: DateFilter;
4175
4803
  /** Filters for incidents by the provided titles. */
4176
4804
  title?: string[];
4177
4805
  }
@@ -4192,6 +4820,10 @@ export interface IncidentsGroupResponse {
4192
4820
  }
4193
4821
  /** incidents-list-request */
4194
4822
  export interface IncidentsListRequest {
4823
+ /** Provides ways to specify date ranges on objects. */
4824
+ acknowledged_date?: DateFilter;
4825
+ /** Provides ways to specify date ranges on objects. */
4826
+ actual_close_date?: DateFilter;
4195
4827
  /** Filters for incidents that apply to any of the provided parts. */
4196
4828
  applies_to_parts?: string[];
4197
4829
  /**
@@ -4206,11 +4838,15 @@ export interface IncidentsListRequest {
4206
4838
  * iteration starts from the beginning.
4207
4839
  */
4208
4840
  cursor?: string;
4841
+ /** Provides ways to specify date ranges on objects. */
4842
+ identified_date?: DateFilter;
4209
4843
  /**
4210
4844
  * The maximum number of items.
4211
4845
  * @format int32
4212
4846
  */
4213
4847
  limit?: number;
4848
+ /** Provides ways to specify date ranges on objects. */
4849
+ mitigated_date?: DateFilter;
4214
4850
  /**
4215
4851
  * The iteration mode to use. If "after", then entries after the provided
4216
4852
  * cursor will be returned, or if no cursor is provided, then from the
@@ -4223,12 +4859,18 @@ export interface IncidentsListRequest {
4223
4859
  modified_date?: DateFilter;
4224
4860
  /** Filters for incidents owned by any of the provided users. */
4225
4861
  owned_by?: string[];
4862
+ /** Filters for incidents with any of the provided reporters. */
4863
+ reported_by?: number[];
4226
4864
  /** Filters for incidents containing any of the provided severities. */
4227
4865
  severity?: number[];
4228
4866
  /** The list of fields to sort the items by and how to sort them. */
4229
4867
  sort_by?: string[];
4868
+ /** Filters for incidents with any of the provided sources. */
4869
+ source?: number[];
4230
4870
  /** Filters for incidents in any of the provided stages. */
4231
4871
  stage?: string[];
4872
+ /** Provides ways to specify date ranges on objects. */
4873
+ target_close_date?: DateFilter;
4232
4874
  /** Filters for incidents by the provided titles. */
4233
4875
  title?: string[];
4234
4876
  }
@@ -4247,8 +4889,86 @@ export interface IncidentsListResponse {
4247
4889
  */
4248
4890
  prev_cursor?: string;
4249
4891
  }
4892
+ /** incidents-update-request */
4893
+ export interface IncidentsUpdateRequest {
4894
+ /**
4895
+ * Timestamp when the incident was acknowledged.
4896
+ * @format date-time
4897
+ * @example "2023-01-01T12:00:00.000Z"
4898
+ */
4899
+ acknowledged_date?: string;
4900
+ applies_to_parts?: UpdateIncidentAppliesToParts;
4901
+ artifacts?: UpdateIncidentArtifacts;
4902
+ /** Body of the incident. */
4903
+ body?: string;
4904
+ /** Application-defined custom fields. */
4905
+ custom_fields?: object;
4906
+ /**
4907
+ * Requested custom schemas described abstractly. Every provided schema's
4908
+ * custom field must be specified, otherwise a bad request error is
4909
+ * returned. If a new custom schema specifier is provided, then it will be
4910
+ * added to the work, otherwise if a custom schema is omitted from the
4911
+ * specifier, it remains unmodified.
4912
+ */
4913
+ custom_schema_spec?: CustomSchemaSpec;
4914
+ /** The ID of the incident to be updated. */
4915
+ id: string;
4916
+ /**
4917
+ * Time when the incident was identified/reported.
4918
+ * @format date-time
4919
+ * @example "2023-01-01T12:00:00.000Z"
4920
+ */
4921
+ identified_date?: string;
4922
+ impact?: UpdateImpactedCustomerDetails;
4923
+ impacted_customers?: UpdateIncidentImpactedCustomers;
4924
+ /**
4925
+ * Timestamp when the incident was mitigated.
4926
+ * @format date-time
4927
+ * @example "2023-01-01T12:00:00.000Z"
4928
+ */
4929
+ mitigated_date?: string;
4930
+ owned_by?: UpdateIncidentOwnedBy;
4931
+ /**
4932
+ * The entity that first reported the incident.
4933
+ * @format int64
4934
+ */
4935
+ reported_by?: number;
4936
+ /**
4937
+ * Severity of the incident.
4938
+ * @format int64
4939
+ */
4940
+ severity?: number;
4941
+ /**
4942
+ * Source of where the incident was created. Only sys users and
4943
+ * service accounts are supposed to set this field.
4944
+ * @format int64
4945
+ */
4946
+ source?: number;
4947
+ /** Update object for Stage. */
4948
+ stage?: UpdateStage;
4949
+ stakeholders?: UpdateIncidentStakeholders;
4950
+ tags?: UpdateIncidentTags;
4951
+ /**
4952
+ * Timestamp when the incident is expected to be resolved.
4953
+ * @format date-time
4954
+ * @example "2023-01-01T12:00:00.000Z"
4955
+ */
4956
+ target_close_date?: string;
4957
+ /** Title of the incident. */
4958
+ title?: string;
4959
+ }
4960
+ /** incidents-update-response */
4961
+ export interface IncidentsUpdateResponse {
4962
+ incident: Incident;
4963
+ }
4250
4964
  /** issue */
4251
4965
  export type Issue = WorkBase & {
4966
+ /**
4967
+ * Actual start date for the object.
4968
+ * @format date-time
4969
+ * @example "2023-01-01T12:00:00.000Z"
4970
+ */
4971
+ actual_start_date?: string;
4252
4972
  /** Parts associated based on git events. */
4253
4973
  developed_with?: PartSummary[];
4254
4974
  /** Priority of the work based upon impact and criticality. */
@@ -4274,6 +4994,8 @@ export declare enum IssuePriority {
4274
4994
  export type IssueSummary = WorkBaseSummary & {
4275
4995
  /** Priority of the work based upon impact and criticality. */
4276
4996
  priority?: IssuePriority;
4997
+ /** Vista group item. */
4998
+ sprint?: VistaGroupItemSummary;
4277
4999
  };
4278
5000
  /**
4279
5001
  * job-history-item
@@ -4315,7 +5037,15 @@ export interface KeyringsCreateCallbackRequest {
4315
5037
  export interface LegacyStage {
4316
5038
  /** Current stage name of the work item. */
4317
5039
  name: string;
5040
+ /** Notes relevant to the stage. */
5041
+ notes?: string;
5042
+ /**
5043
+ * Current stage number of the work item (sortable).
5044
+ * @format int32
5045
+ */
5046
+ ordinal?: number;
4318
5047
  stage?: CustomStageSummary;
5048
+ state?: CustomStateSummary;
4319
5049
  }
4320
5050
  /**
4321
5051
  * legacy-stage-summary
@@ -4324,6 +5054,7 @@ export interface LegacyStage {
4324
5054
  export interface LegacyStageSummary {
4325
5055
  /** Current stage name of the work item. */
4326
5056
  name: string;
5057
+ stage?: CustomStageSummary;
4327
5058
  }
4328
5059
  /**
4329
5060
  * lines-of-code
@@ -4423,6 +5154,7 @@ export declare enum LinkType {
4423
5154
  DevelopedWith = "developed_with",
4424
5155
  Imports = "imports",
4425
5156
  IsAnalyzedBy = "is_analyzed_by",
5157
+ IsConvertedTo = "is_converted_to",
4426
5158
  IsDependentOn = "is_dependent_on",
4427
5159
  IsDuplicateOf = "is_duplicate_of",
4428
5160
  IsMergedInto = "is_merged_into",
@@ -5434,6 +6166,31 @@ export type PartsUpdateRequestProduct = object;
5434
6166
  export interface PartsUpdateResponse {
5435
6167
  part: Part;
5436
6168
  }
6169
+ /** preferences */
6170
+ export type Preferences = UserPreferences & {
6171
+ type: PreferencesType;
6172
+ };
6173
+ /** preferences-base */
6174
+ export type PreferencesBase = AtomBase;
6175
+ /** preferences-base-summary */
6176
+ export type PreferencesBaseSummary = AtomBaseSummary;
6177
+ /** preferences-get-request */
6178
+ export interface PreferencesGetRequest {
6179
+ type: PreferencesType;
6180
+ /**
6181
+ * The ID of the target object for which preferences object is to be
6182
+ * fetched.
6183
+ * @example "DEV-AbCdEfGh"
6184
+ */
6185
+ object: string;
6186
+ }
6187
+ /** preferences-get-response */
6188
+ export interface PreferencesGetResponse {
6189
+ preference: Preferences;
6190
+ }
6191
+ export declare enum PreferencesType {
6192
+ UserPreferences = "user_preferences"
6193
+ }
5437
6194
  /** product */
5438
6195
  export type Product = PartBase;
5439
6196
  /** product-summary */
@@ -5720,6 +6477,19 @@ export interface QuestionAnswersUpdateRequestTags {
5720
6477
  export interface QuestionAnswersUpdateResponse {
5721
6478
  question_answer: QuestionAnswer;
5722
6479
  }
6480
+ /** remove-tag-with-value */
6481
+ export interface RemoveTagWithValue {
6482
+ /**
6483
+ * The ID of the tag.
6484
+ * @example "TAG-12345"
6485
+ */
6486
+ id: string;
6487
+ }
6488
+ /**
6489
+ * removed-sla-metric-history
6490
+ * User, timestamp and metric id of removed metrics.
6491
+ */
6492
+ export type RemovedSlaMetricHistory = object;
5723
6493
  /**
5724
6494
  * resource
5725
6495
  * Resource details.
@@ -5785,7 +6555,7 @@ export interface RevOrgsCreateRequest {
5785
6555
  * Account Id to associate with this Rev organization.
5786
6556
  * @example "ACC-12345"
5787
6557
  */
5788
- account?: string;
6558
+ account: string;
5789
6559
  /**
5790
6560
  * The IDs of the artifacts to associate with the Rev organization.
5791
6561
  * @example ["ARTIFACT-12345"]
@@ -5802,7 +6572,10 @@ export interface RevOrgsCreateRequest {
5802
6572
  description?: string;
5803
6573
  /** Name of the Rev organization. */
5804
6574
  display_name: string;
5805
- /** Company's domain name. Example - 'devrev.ai'. */
6575
+ /**
6576
+ * Company's domain name. Example - 'devrev.ai'.
6577
+ * @deprecated
6578
+ */
5806
6579
  domain?: string;
5807
6580
  /** The environment of the Org. Defaults to 'production' if not specified. */
5808
6581
  environment?: OrgEnvironment;
@@ -5954,7 +6727,10 @@ export interface RevOrgsUpdateRequest {
5954
6727
  description?: string;
5955
6728
  /** Customer chosen name for the Rev organization. */
5956
6729
  display_name?: string;
5957
- /** Company's domain name. Example - 'devrev.ai'. */
6730
+ /**
6731
+ * Company's domain name. Example - 'devrev.ai'.
6732
+ * @deprecated
6733
+ */
5958
6734
  domain?: string;
5959
6735
  /** The environment of the Org. Defaults to 'production' if not specified. */
5960
6736
  environment?: OrgEnvironment;
@@ -6139,19 +6915,71 @@ export interface RevUsersListRequest {
6139
6915
  external_ref?: string[];
6140
6916
  /** Value of is_verified field to filter the Rev users. */
6141
6917
  is_verified?: boolean;
6142
- /**
6143
- * The maximum number of Rev users to return. The default is '50'.
6144
- * @format int32
6145
- */
6146
- limit?: number;
6147
- /**
6148
- * The iteration mode to use. If "after", then entries after the provided
6149
- * cursor will be returned, or if no cursor is provided, then from the
6150
- * beginning. If "before", then entries before the provided cursor will be
6151
- * returned, or if no cursor is provided, then from the end. Entries will
6152
- * always be returned in the specified sort-by order.
6153
- */
6154
- mode?: ListMode;
6918
+ /**
6919
+ * The maximum number of Rev users to return. The default is '50'.
6920
+ * @format int32
6921
+ */
6922
+ limit?: number;
6923
+ /**
6924
+ * The iteration mode to use. If "after", then entries after the provided
6925
+ * cursor will be returned, or if no cursor is provided, then from the
6926
+ * beginning. If "before", then entries before the provided cursor will be
6927
+ * returned, or if no cursor is provided, then from the end. Entries will
6928
+ * always be returned in the specified sort-by order.
6929
+ */
6930
+ mode?: ListMode;
6931
+ modified_date?: DateTimeFilter;
6932
+ /** List of phone numbers, in E.164 format, to filter Rev users on. */
6933
+ phone_numbers?: string[];
6934
+ /**
6935
+ * List of IDs of Rev organizations to be filtered.
6936
+ * @example ["REV-AbCdEfGh"]
6937
+ */
6938
+ rev_org?: string[];
6939
+ /** Fields to sort the Rev users by and the direction to sort them. */
6940
+ sort_by?: string[];
6941
+ /** List of tags to be filtered. */
6942
+ tags?: string[];
6943
+ }
6944
+ /**
6945
+ * rev-users-list-response
6946
+ * The response to listing all Rev users matching the filter criteria.
6947
+ */
6948
+ export interface RevUsersListResponse {
6949
+ /**
6950
+ * The cursor used to iterate subsequent results in accordance to the
6951
+ * sort order. If not set, then no later elements exist.
6952
+ */
6953
+ next_cursor?: string;
6954
+ /**
6955
+ * The cursor used to iterate preceding results in accordance to the
6956
+ * sort order. If not set, then no prior elements exist.
6957
+ */
6958
+ prev_cursor?: string;
6959
+ /** List containing all the Rev users. */
6960
+ rev_users: RevUser[];
6961
+ }
6962
+ /**
6963
+ * rev-users-scan-request
6964
+ * Scans the list of Rev users.
6965
+ */
6966
+ export interface RevUsersScanRequest {
6967
+ /** Filters for Rev users that were created by the specified user(s). */
6968
+ created_by?: string[];
6969
+ created_date?: DateTimeFilter;
6970
+ /**
6971
+ * The cursor to resume iteration, otherwise the beginning if not
6972
+ * provided.
6973
+ */
6974
+ cursor?: string;
6975
+ /** Filters for custom fields. */
6976
+ custom_fields?: object;
6977
+ /** List of emails of Rev users to be filtered. */
6978
+ email?: string[];
6979
+ /** List of external refs to filter Rev users for. */
6980
+ external_ref?: string[];
6981
+ /** Value of is_verified field to filter the Rev users. */
6982
+ is_verified?: boolean;
6155
6983
  modified_date?: DateTimeFilter;
6156
6984
  /** List of phone numbers, in E.164 format, to filter Rev users on. */
6157
6985
  phone_numbers?: string[];
@@ -6160,27 +6988,20 @@ export interface RevUsersListRequest {
6160
6988
  * @example ["REV-AbCdEfGh"]
6161
6989
  */
6162
6990
  rev_org?: string[];
6163
- /** Fields to sort the Rev users by and the direction to sort them. */
6164
- sort_by?: string[];
6165
6991
  /** List of tags to be filtered. */
6166
6992
  tags?: string[];
6167
6993
  }
6168
6994
  /**
6169
- * rev-users-list-response
6170
- * The response to listing all Rev users matching the filter criteria.
6995
+ * rev-users-scan-response
6996
+ * The response to scanning Rev users.
6171
6997
  */
6172
- export interface RevUsersListResponse {
6998
+ export interface RevUsersScanResponse {
6173
6999
  /**
6174
- * The cursor used to iterate subsequent results in accordance to the
6175
- * sort order. If not set, then no later elements exist.
7000
+ * The cursor that should be used to resume iteration, otherwise if
7001
+ * not provided, then iteration has completed.
6176
7002
  */
6177
7003
  next_cursor?: string;
6178
- /**
6179
- * The cursor used to iterate preceding results in accordance to the
6180
- * sort order. If not set, then no prior elements exist.
6181
- */
6182
- prev_cursor?: string;
6183
- /** List containing all the Rev users. */
7004
+ /** The iterated Rev users. */
6184
7005
  rev_users: RevUser[];
6185
7006
  }
6186
7007
  /**
@@ -6990,6 +7811,8 @@ export interface SetIssueSelector {
6990
7811
  * values.
6991
7812
  */
6992
7813
  custom_fields?: object;
7814
+ /** The SLA policy applies to the issues of these owners. */
7815
+ owners?: string[];
6993
7816
  /**
6994
7817
  * The SLA policy applies to the issues of these parts.
6995
7818
  * @example ["PROD-12345"]
@@ -7040,7 +7863,17 @@ export interface SetSlaSelector {
7040
7863
  * value is null, the field must have null value or not be present.
7041
7864
  */
7042
7865
  custom_fields?: object;
7866
+ /**
7867
+ * The SLA policy applies to the tickets or conversations of these
7868
+ * groups.
7869
+ */
7870
+ groups?: string[];
7043
7871
  issue_selector?: SetIssueSelector;
7872
+ /**
7873
+ * The SLA policy applies to the tickets or conversations of these
7874
+ * owners.
7875
+ */
7876
+ owners?: string[];
7044
7877
  /**
7045
7878
  * The SLA policy applies to the tickets of these parts.
7046
7879
  * @example ["PROD-12345"]
@@ -7059,6 +7892,8 @@ export interface SetSlaSelector {
7059
7892
  * @example ["TAG-12345"]
7060
7893
  */
7061
7894
  tags?: string[];
7895
+ /** The SLA policy applies to tickets with these source channels. */
7896
+ ticket_source_channel?: string[];
7062
7897
  }
7063
7898
  /** set-support-metric-target */
7064
7899
  export interface SetSupportMetricTarget {
@@ -7265,6 +8100,8 @@ export type SlaTracker = AtomBase & {
7265
8100
  applies_to_id?: string;
7266
8101
  /** Summary of the metrics target being tracked in the SLA tracker. */
7267
8102
  metric_target_summaries: ArchetypeMetricTarget[];
8103
+ /** User, timestamp and metric Id of removed metrics. */
8104
+ removed_sla_metric_history?: RemovedSlaMetricHistory[];
7268
8105
  sla?: SlaSummary;
7269
8106
  /**
7270
8107
  * Details of the applicable SLA policy. Can be omitted if no sla
@@ -7445,6 +8282,11 @@ export interface SlasUpdateRequest {
7445
8282
  export interface SlasUpdateResponse {
7446
8283
  sla: Sla;
7447
8284
  }
8285
+ /** snap-in */
8286
+ export type SnapIn = AtomBase & {
8287
+ /** Values of the inputs. */
8288
+ inputs_values?: object;
8289
+ };
7448
8290
  /** snap-in-version-summary */
7449
8291
  export type SnapInVersionSummary = AtomBaseSummary;
7450
8292
  /** snap-ins-resources-request */
@@ -7471,6 +8313,17 @@ export interface SnapInsResourcesResponseKeyringData {
7471
8313
  /** The secret value of the keyring. This must be handled with caution. */
7472
8314
  secret: string;
7473
8315
  }
8316
+ /** snap-ins-update-request */
8317
+ export interface SnapInsUpdateRequest {
8318
+ /** The ID of the snap-in to update. */
8319
+ id: string;
8320
+ /** The updated values of the inputs. */
8321
+ inputs_values?: object;
8322
+ }
8323
+ /** snap-ins-update-response */
8324
+ export interface SnapInsUpdateResponse {
8325
+ snap_in: SnapIn;
8326
+ }
7474
8327
  /** snap-widget */
7475
8328
  export type SnapWidget = EmailPreviewWidget & {
7476
8329
  type: SnapWidgetType;
@@ -7486,6 +8339,7 @@ export type SnapWidgetBase = AtomBase & {
7486
8339
  };
7487
8340
  /** Logical grouping of snap widgets. Useful for filtering. */
7488
8341
  export declare enum SnapWidgetNamespace {
8342
+ AiAssistantMessage = "ai_assistant_message",
7489
8343
  CommentSuggestionReplies = "comment_suggestion_replies",
7490
8344
  EmailPreview = "email_preview",
7491
8345
  LinkPreview = "link_preview",
@@ -7520,7 +8374,10 @@ export interface SnapWidgetsCreateResponse {
7520
8374
  * stage
7521
8375
  * Describes the current stage of a object.
7522
8376
  */
7523
- export type Stage = object;
8377
+ export interface Stage {
8378
+ stage?: CustomStageSummary;
8379
+ state?: CustomStateSummary;
8380
+ }
7524
8381
  /** stage-diagram-summary */
7525
8382
  export type StageDiagramSummary = AtomBaseSummary;
7526
8383
  /**
@@ -7929,6 +8786,8 @@ export interface SurveysSubmitRequest {
7929
8786
  export type SurveysSubmitResponse = object;
7930
8787
  /** sync-metadata-filter */
7931
8788
  export interface SyncMetadataFilter {
8789
+ /** Filters for issues with this specific external reference. */
8790
+ external_reference?: string[];
7932
8791
  last_sync_in?: SyncMetadataFilterSyncInFilter;
7933
8792
  last_sync_out?: SyncMetadataFilterSyncOutFilter;
7934
8793
  /** Filters for issues synced from this specific origin system. */
@@ -8260,7 +9119,8 @@ export declare enum TicketChannels {
8260
9119
  Email = "email",
8261
9120
  Plug = "plug",
8262
9121
  Slack = "slack",
8263
- Twilio = "twilio"
9122
+ Twilio = "twilio",
9123
+ TwilioSms = "twilio_sms"
8264
9124
  }
8265
9125
  /** Severity of the ticket. */
8266
9126
  export declare enum TicketSeverity {
@@ -8275,6 +9135,69 @@ export type TicketSummary = WorkBaseSummary & {
8275
9135
  /** Severity of the ticket. */
8276
9136
  severity?: TicketSeverity;
8277
9137
  };
9138
+ /** timeline-change-event */
9139
+ export type TimelineChangeEvent = TimelineEntryBase & {
9140
+ /** A timeline change event. */
9141
+ event?: TimelineChangeEventEvent;
9142
+ };
9143
+ /**
9144
+ * timeline-change-event-created
9145
+ * A creation event.
9146
+ */
9147
+ export interface TimelineChangeEventCreated {
9148
+ object?: AtomSummary;
9149
+ }
9150
+ /**
9151
+ * timeline-change-event-deleted
9152
+ * A deletion event.
9153
+ */
9154
+ export interface TimelineChangeEventDeleted {
9155
+ /** The ID correspending to the deleted object. */
9156
+ object_id?: string;
9157
+ }
9158
+ /**
9159
+ * timeline-change-event-event
9160
+ * A timeline change event.
9161
+ */
9162
+ export interface TimelineChangeEventEvent {
9163
+ /** The type of the event. */
9164
+ type?: TimelineChangeEventEventType;
9165
+ /** A creation event. */
9166
+ created?: TimelineChangeEventCreated;
9167
+ /** A deletion event. */
9168
+ deleted?: TimelineChangeEventDeleted;
9169
+ /** A linking event. */
9170
+ linked?: TimelineChangeEventLinked;
9171
+ /** An update event. */
9172
+ updated?: TimelineChangeEventUpdated;
9173
+ }
9174
+ /** The type of the event. */
9175
+ export declare enum TimelineChangeEventEventType {
9176
+ Annotated = "annotated",
9177
+ Created = "created",
9178
+ Deleted = "deleted",
9179
+ Linked = "linked",
9180
+ Updated = "updated"
9181
+ }
9182
+ /**
9183
+ * timeline-change-event-linked
9184
+ * A linking event.
9185
+ */
9186
+ export interface TimelineChangeEventLinked {
9187
+ link?: LinkSummary;
9188
+ }
9189
+ /** timeline-change-event-summary */
9190
+ export type TimelineChangeEventSummary = TimelineEntryBaseSummary;
9191
+ /**
9192
+ * timeline-change-event-updated
9193
+ * An update event.
9194
+ */
9195
+ export interface TimelineChangeEventUpdated {
9196
+ /** List of field changes. */
9197
+ field_deltas?: FieldDelta[];
9198
+ /** Type of DevRev object. */
9199
+ object_type?: string;
9200
+ }
8278
9201
  /** timeline-comment */
8279
9202
  export type TimelineComment = TimelineEntryBase & {
8280
9203
  /** The artifacts for the comment. */
@@ -8366,6 +9289,8 @@ export interface TimelineEntriesCreateRequestTimelineComment {
8366
9289
  /**
8367
9290
  * The external reference for the comment. This must be unique within
8368
9291
  * the object's timeline.
9292
+ * @minLength 1
9293
+ * @maxLength 512
8369
9294
  */
8370
9295
  external_ref?: string;
8371
9296
  /**
@@ -8415,6 +9340,8 @@ export interface TimelineEntriesGetRequest {
8415
9340
  /**
8416
9341
  * If set, then gets the entry with the given external reference for
8417
9342
  * the provided entry ID's timeline.
9343
+ * @minLength 1
9344
+ * @maxLength 512
8418
9345
  */
8419
9346
  external_ref?: string;
8420
9347
  /**
@@ -8516,6 +9443,14 @@ export interface TimelineEntriesUpdateRequestTimelineComment {
8516
9443
  body?: string;
8517
9444
  /** The type of the body to use for the comment. */
8518
9445
  body_type?: TimelineCommentBodyType;
9446
+ /**
9447
+ * The updated external reference for the comment. If set, this must
9448
+ * be unique within the object's timeline, otherwise if null, then
9449
+ * clears the value.
9450
+ * @minLength 1
9451
+ * @maxLength 512
9452
+ */
9453
+ external_ref?: string | null;
8519
9454
  link_previews?: TimelineEntriesUpdateRequestTimelineCommentLinkPreviews;
8520
9455
  /** Snap Kit Body of the comment. */
8521
9456
  snap_kit_body?: TimelineSnapKitBody;
@@ -8577,7 +9512,7 @@ export interface TimelineEntriesUpdateResponse {
8577
9512
  timeline_entry: TimelineEntry;
8578
9513
  }
8579
9514
  /** timeline-entry */
8580
- export type TimelineEntry = TimelineComment & {
9515
+ export type TimelineEntry = (TimelineChangeEvent | TimelineComment) & {
8581
9516
  type: TimelineEntryType;
8582
9517
  };
8583
9518
  /** timeline-entry-base */
@@ -8626,6 +9561,7 @@ export declare enum TimelineEntryObjectType {
8626
9561
  RevUser = "rev_user",
8627
9562
  Task = "task",
8628
9563
  Ticket = "ticket",
9564
+ TimelineChangeEvent = "timeline_change_event",
8629
9565
  TimelineComment = "timeline_comment"
8630
9566
  }
8631
9567
  /** Display panels for the Timeline entry. */
@@ -8635,6 +9571,7 @@ export declare enum TimelineEntryPanel {
8635
9571
  Events = "events"
8636
9572
  }
8637
9573
  export declare enum TimelineEntryType {
9574
+ TimelineChangeEvent = "timeline_change_event",
8638
9575
  TimelineComment = "timeline_comment"
8639
9576
  }
8640
9577
  /**
@@ -9051,6 +9988,79 @@ export interface UomsUpdateRequestDimensions {
9051
9988
  export interface UomsUpdateResponse {
9052
9989
  uom: Uom;
9053
9990
  }
9991
+ /** update-impacted-customer-details */
9992
+ export interface UpdateImpactedCustomerDetails {
9993
+ /**
9994
+ * Count of customers impacted.
9995
+ * @format int64
9996
+ */
9997
+ count?: number;
9998
+ customer_ids?: UpdateImpactedCustomerDetailsCustomerIds;
9999
+ }
10000
+ /** update-impacted-customer-details-customer-ids */
10001
+ export interface UpdateImpactedCustomerDetailsCustomerIds {
10002
+ /** Sets the list of customers impacted due to the incident. */
10003
+ set?: string[];
10004
+ }
10005
+ /** update-incident-applies-to-parts */
10006
+ export interface UpdateIncidentAppliesToParts {
10007
+ /** Sets the parts to which the incident is applicable to. */
10008
+ set?: string[];
10009
+ }
10010
+ /** update-incident-artifacts */
10011
+ export interface UpdateIncidentArtifacts {
10012
+ /**
10013
+ * Sets the artifacts attached to the incident.
10014
+ * @example ["ARTIFACT-12345"]
10015
+ */
10016
+ set?: string[];
10017
+ }
10018
+ /** update-incident-impacted-customers */
10019
+ export interface UpdateIncidentImpactedCustomers {
10020
+ /** Sets the list of customers impacted due to the incident. */
10021
+ set?: string[];
10022
+ }
10023
+ /** update-incident-owned-by */
10024
+ export interface UpdateIncidentOwnedBy {
10025
+ /** Sets the user IDs of the users that own the incident. */
10026
+ set?: string[];
10027
+ }
10028
+ /** update-incident-stakeholders */
10029
+ export interface UpdateIncidentStakeholders {
10030
+ /**
10031
+ * Sets the users, along with the incident commander, involved in
10032
+ * resolving incidents and handling communication.
10033
+ */
10034
+ set?: string[];
10035
+ }
10036
+ /** update-incident-tags */
10037
+ export interface UpdateIncidentTags {
10038
+ /** Sets the tags associated with the object. */
10039
+ set?: UpdateTagWithValue[];
10040
+ }
10041
+ /**
10042
+ * update-stage
10043
+ * Update object for Stage.
10044
+ */
10045
+ export interface UpdateStage {
10046
+ /** Notes relevant to the stage */
10047
+ notes?: string;
10048
+ /** DON of the stage. */
10049
+ stage?: string;
10050
+ }
10051
+ /**
10052
+ * update-tag-with-value
10053
+ * Update object for TagWithValue.
10054
+ */
10055
+ export interface UpdateTagWithValue {
10056
+ /**
10057
+ * ID of the referenced tag
10058
+ * @example "TAG-12345"
10059
+ */
10060
+ tag_id?: string;
10061
+ /** Value associated with the tag for the object. */
10062
+ value?: string;
10063
+ }
9054
10064
  /** user-base */
9055
10065
  export type UserBase = AtomBase & {
9056
10066
  /** The user's display name. The name is non-unique and mutable. */
@@ -9077,6 +10087,13 @@ export type UserBaseSummary = AtomBaseSummary & {
9077
10087
  /** State of the user. */
9078
10088
  state?: UserState;
9079
10089
  };
10090
+ /** user-preferences */
10091
+ export type UserPreferences = PreferencesBase & {
10092
+ /** Preferences group for General settings. */
10093
+ general_preferences?: GeneralPreferencesGroup;
10094
+ };
10095
+ /** user-preferences-summary */
10096
+ export type UserPreferencesSummary = PreferencesBaseSummary;
9080
10097
  /** user-search-summary */
9081
10098
  export type UserSearchSummary = SearchSummaryBase & {
9082
10099
  /**
@@ -9205,9 +10222,14 @@ export interface WebhookEventRequest {
9205
10222
  dev_user_updated?: EventDevUserUpdated;
9206
10223
  group_created?: EventGroupCreated;
9207
10224
  group_deleted?: EventGroupDeleted;
10225
+ group_member_added?: EventGroupMemberAdded;
10226
+ group_member_removed?: EventGroupMemberRemoved;
9208
10227
  group_updated?: EventGroupUpdated;
9209
10228
  /** The event's ID. */
9210
10229
  id: string;
10230
+ link_created?: EventLinkCreated;
10231
+ link_deleted?: EventLinkDeleted;
10232
+ link_updated?: EventLinkUpdated;
9211
10233
  part_created?: EventPartCreated;
9212
10234
  part_deleted?: EventPartDeleted;
9213
10235
  part_updated?: EventPartUpdated;
@@ -9220,9 +10242,12 @@ export interface WebhookEventRequest {
9220
10242
  sla_tracker_created?: EventSlaTrackerCreated;
9221
10243
  sla_tracker_deleted?: EventSlaTrackerDeleted;
9222
10244
  sla_tracker_updated?: EventSlaTrackerUpdated;
10245
+ survey_created?: EventSurveyCreated;
10246
+ survey_deleted?: EventSurveyDeleted;
9223
10247
  survey_response_created?: EventSurveyResponseCreated;
9224
10248
  survey_response_deleted?: EventSurveyResponseDeleted;
9225
10249
  survey_response_updated?: EventSurveyResponseUpdated;
10250
+ survey_updated?: EventSurveyUpdated;
9226
10251
  tag_created?: EventTagCreated;
9227
10252
  tag_deleted?: EventTagDeleted;
9228
10253
  tag_updated?: EventTagUpdated;
@@ -9273,7 +10298,12 @@ export declare enum WebhookEventType {
9273
10298
  DevUserUpdated = "dev_user_updated",
9274
10299
  GroupCreated = "group_created",
9275
10300
  GroupDeleted = "group_deleted",
10301
+ GroupMemberAdded = "group_member_added",
10302
+ GroupMemberRemoved = "group_member_removed",
9276
10303
  GroupUpdated = "group_updated",
10304
+ LinkCreated = "link_created",
10305
+ LinkDeleted = "link_deleted",
10306
+ LinkUpdated = "link_updated",
9277
10307
  PartCreated = "part_created",
9278
10308
  PartDeleted = "part_deleted",
9279
10309
  PartUpdated = "part_updated",
@@ -9286,6 +10316,12 @@ export declare enum WebhookEventType {
9286
10316
  SlaTrackerCreated = "sla_tracker_created",
9287
10317
  SlaTrackerDeleted = "sla_tracker_deleted",
9288
10318
  SlaTrackerUpdated = "sla_tracker_updated",
10319
+ SurveyCreated = "survey_created",
10320
+ SurveyDeleted = "survey_deleted",
10321
+ SurveyResponseCreated = "survey_response_created",
10322
+ SurveyResponseDeleted = "survey_response_deleted",
10323
+ SurveyResponseUpdated = "survey_response_updated",
10324
+ SurveyUpdated = "survey_updated",
9289
10325
  TagCreated = "tag_created",
9290
10326
  TagDeleted = "tag_deleted",
9291
10327
  TagUpdated = "tag_updated",
@@ -9336,7 +10372,10 @@ export type WebhookSummary = AtomBaseSummary;
9336
10372
  export interface WebhooksCreateRequest {
9337
10373
  /** The event types that the webhook endpoint will receive. */
9338
10374
  event_types?: WebhookEventType[];
9339
- /** @maxItems 8 */
10375
+ /**
10376
+ * The headers to include in every webhook invocation.
10377
+ * @maxItems 8
10378
+ */
9340
10379
  headers?: WebhookHeader[];
9341
10380
  /**
9342
10381
  * The secret to use when verifying webhook events. If provided, the
@@ -9461,11 +10500,23 @@ export interface WebhooksUpdateRequestEventTypes {
9461
10500
  }
9462
10501
  /** webhooks-update-request-headers */
9463
10502
  export interface WebhooksUpdateRequestHeaders {
9464
- /** @maxItems 8 */
10503
+ /**
10504
+ * The headers to be added to every webhook invocation. If a provided
10505
+ * header is already specified for the webhook, its value is replaced.
10506
+ * @maxItems 8
10507
+ */
9465
10508
  add?: WebhookHeader[];
9466
- /** @maxItems 8 */
10509
+ /**
10510
+ * The headers to be removed from every webhook invocation. If a
10511
+ * provided header is not specified for the webhook, then it's
10512
+ * ignored.
10513
+ * @maxItems 8
10514
+ */
9467
10515
  remove?: string[];
9468
- /** @maxItems 8 */
10516
+ /**
10517
+ * Sets the headers to include in every webhook invocation.
10518
+ * @maxItems 8
10519
+ */
9469
10520
  set?: WebhookHeader[];
9470
10521
  }
9471
10522
  /**
@@ -9486,6 +10537,12 @@ export type Work = (Issue | Opportunity | Task | Ticket) & {
9486
10537
  };
9487
10538
  /** work-base */
9488
10539
  export type WorkBase = AtomBase & {
10540
+ /**
10541
+ * Timestamp when the work was actually completed.
10542
+ * @format date-time
10543
+ * @example "2023-01-01T12:00:00.000Z"
10544
+ */
10545
+ actual_close_date?: string;
9489
10546
  applies_to_part?: PartSummary;
9490
10547
  /** The artifacts attached to the work item. */
9491
10548
  artifacts?: ArtifactSummary[];
@@ -10082,6 +11139,10 @@ export interface WorksUpdateRequestStagedInfoStagedInfoUpdate {
10082
11139
  }
10083
11140
  /** works-update-request-tags */
10084
11141
  export interface WorksUpdateRequestTags {
11142
+ /** Adds the provided tags on the work item. */
11143
+ add?: AddTagWithValue[];
11144
+ /** Removes the provided tags on the work item. */
11145
+ remove?: RemoveTagWithValue[];
10085
11146
  /** Sets the provided tags on the work item. */
10086
11147
  set?: SetTagWithValue[];
10087
11148
  }
@@ -10112,6 +11173,11 @@ export interface WorksUpdateRequestTicket {
10112
11173
  * @example "REV-AbCdEfGh"
10113
11174
  */
10114
11175
  rev_org?: string | null;
11176
+ /**
11177
+ * The enum ID for the sentiment of the ticket.
11178
+ * @format int64
11179
+ */
11180
+ sentiment?: number;
10115
11181
  /** Severity of the ticket. */
10116
11182
  severity?: TicketSeverity;
10117
11183
  }
@@ -10815,6 +11881,85 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10815
11881
  * @secure
10816
11882
  */
10817
11883
  codeChangesUpdate: (data: CodeChangesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesUpdateResponse, any>>;
11884
+ /**
11885
+ * @description Create the content template.
11886
+ *
11887
+ * @tags notifications
11888
+ * @name ContentTemplateCreate
11889
+ * @request POST:/content-template.create
11890
+ * @secure
11891
+ */
11892
+ contentTemplateCreate: (data: ContentTemplateCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateCreateResponse, any>>;
11893
+ /**
11894
+ * @description Get the content template.
11895
+ *
11896
+ * @tags notifications
11897
+ * @name ContentTemplateGet
11898
+ * @request GET:/content-template.get
11899
+ * @secure
11900
+ */
11901
+ contentTemplateGet: (query: {
11902
+ /** The content template's ID. */
11903
+ id: string;
11904
+ }, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateGetResponse, any>>;
11905
+ /**
11906
+ * @description Get the content template.
11907
+ *
11908
+ * @tags notifications
11909
+ * @name ContentTemplateGetPost
11910
+ * @request POST:/content-template.get
11911
+ * @secure
11912
+ */
11913
+ contentTemplateGetPost: (data: ContentTemplateGetRequest, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateGetResponse, any>>;
11914
+ /**
11915
+ * @description Lists the content templates.
11916
+ *
11917
+ * @tags notifications
11918
+ * @name ContentTemplateList
11919
+ * @request GET:/content-template.list
11920
+ * @secure
11921
+ */
11922
+ contentTemplateList: (query?: {
11923
+ /**
11924
+ * Filters for content template created by any of these users.
11925
+ * @example ["DEVU-12345"]
11926
+ */
11927
+ created_by?: string[];
11928
+ /**
11929
+ * The cursor to resume iteration from. If not provided, then iteration
11930
+ * starts from the beginning.
11931
+ */
11932
+ cursor?: string;
11933
+ /**
11934
+ * The maximum number of content template to return. The default is
11935
+ * '50'.
11936
+ * @format int32
11937
+ */
11938
+ limit?: number;
11939
+ /**
11940
+ * The iteration mode to use, otherwise if not set, then "after" is
11941
+ * used.
11942
+ */
11943
+ mode?: ListMode;
11944
+ /** Filters for content template based on name. */
11945
+ name?: string[];
11946
+ /**
11947
+ * Fields to sort the content template by and the direction to sort
11948
+ * them.
11949
+ */
11950
+ sort_by?: string[];
11951
+ /** Filters for content template of the provided types. */
11952
+ type?: ContentTemplateType[];
11953
+ }, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateListResponse, any>>;
11954
+ /**
11955
+ * @description Lists the content templates.
11956
+ *
11957
+ * @tags notifications
11958
+ * @name ContentTemplateListPost
11959
+ * @request POST:/content-template.list
11960
+ * @secure
11961
+ */
11962
+ contentTemplateListPost: (data: ContentTemplateListRequest, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateListResponse, any>>;
10818
11963
  /**
10819
11964
  * @description Creates a conversation.
10820
11965
  *
@@ -11430,6 +12575,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11430
12575
  cursor?: string;
11431
12576
  /** Filters the groups based on the group type. */
11432
12577
  group_type?: GroupType[];
12578
+ /** Filter groups by ingestion source(s). */
12579
+ ingestion_source?: GroupIngestionSource[];
11433
12580
  /** Whether to fetch default or custom groups. */
11434
12581
  is_default?: boolean;
11435
12582
  /**
@@ -11520,6 +12667,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11520
12667
  * @secure
11521
12668
  */
11522
12669
  groupsUpdate: (data: GroupsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsUpdateResponse, any>>;
12670
+ /**
12671
+ * @description Creates an incident.
12672
+ *
12673
+ * @tags operate
12674
+ * @name IncidentsCreate
12675
+ * @request POST:/incidents.create
12676
+ * @secure
12677
+ */
12678
+ incidentsCreate: (data: IncidentsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<IncidentsCreateResponse, any>>;
12679
+ /**
12680
+ * @description Deletes an incident.
12681
+ *
12682
+ * @tags operate
12683
+ * @name IncidentsDelete
12684
+ * @request POST:/incidents.delete
12685
+ * @secure
12686
+ */
12687
+ incidentsDelete: (data: IncidentsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
11523
12688
  /**
11524
12689
  * @description Gets an incident.
11525
12690
  *
@@ -11583,10 +12748,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11583
12748
  mode?: ListMode;
11584
12749
  /** Filters for incidents owned by any of the provided users. */
11585
12750
  owned_by?: string[];
12751
+ /** Filters for incidents with any of the provided reporters. */
12752
+ reported_by?: number[];
11586
12753
  /** Filters for incidents containing any of the provided severities. */
11587
12754
  severity?: number[];
11588
12755
  /** Comma-separated fields to sort the incidents by. */
11589
12756
  sort_by?: string[];
12757
+ /** Filters for incidents with any of the provided sources. */
12758
+ source?: number[];
11590
12759
  /** Filters for incidents in any of the provided stages. */
11591
12760
  stage?: string[];
11592
12761
  /** Filters for incidents by the provided titles. */
@@ -11634,10 +12803,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11634
12803
  mode?: ListMode;
11635
12804
  /** Filters for incidents owned by any of the provided users. */
11636
12805
  owned_by?: string[];
12806
+ /** Filters for incidents with any of the provided reporters. */
12807
+ reported_by?: number[];
11637
12808
  /** Filters for incidents containing any of the provided severities. */
11638
12809
  severity?: number[];
11639
12810
  /** The list of fields to sort the items by and how to sort them. */
11640
12811
  sort_by?: string[];
12812
+ /** Filters for incidents with any of the provided sources. */
12813
+ source?: number[];
11641
12814
  /** Filters for incidents in any of the provided stages. */
11642
12815
  stage?: string[];
11643
12816
  /** Filters for incidents by the provided titles. */
@@ -11652,6 +12825,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11652
12825
  * @secure
11653
12826
  */
11654
12827
  incidentsListPost: (data: IncidentsListRequest, params?: RequestParams) => Promise<AxiosResponse<IncidentsListResponse, any>>;
12828
+ /**
12829
+ * @description Updates an incident.
12830
+ *
12831
+ * @tags operate
12832
+ * @name IncidentsUpdate
12833
+ * @request POST:/incidents.update
12834
+ * @secure
12835
+ */
12836
+ incidentsUpdate: (data: IncidentsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<IncidentsUpdateResponse, any>>;
11655
12837
  /**
11656
12838
  * @description OAuth2 authorization callback.
11657
12839
  *
@@ -12081,6 +13263,33 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12081
13263
  * @secure
12082
13264
  */
12083
13265
  partsUpdate: (data: PartsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsUpdateResponse, any>>;
13266
+ /**
13267
+ * @description Get the preferences object.
13268
+ *
13269
+ * @tags preferences
13270
+ * @name PreferencesGet
13271
+ * @request GET:/preferences.get
13272
+ * @secure
13273
+ */
13274
+ preferencesGet: (query: {
13275
+ /**
13276
+ * The ID of the target object for which preferences object is to be
13277
+ * fetched.
13278
+ * @example "DEV-AbCdEfGh"
13279
+ */
13280
+ object: string;
13281
+ /** Type of the preference object to be fetched. */
13282
+ type: PreferencesType;
13283
+ }, params?: RequestParams) => Promise<AxiosResponse<PreferencesGetResponse, any>>;
13284
+ /**
13285
+ * @description Get the preferences object.
13286
+ *
13287
+ * @tags preferences
13288
+ * @name PreferencesGetPost
13289
+ * @request POST:/preferences.get
13290
+ * @secure
13291
+ */
13292
+ preferencesGetPost: (data: PreferencesGetRequest, params?: RequestParams) => Promise<AxiosResponse<PreferencesGetResponse, any>>;
12084
13293
  /**
12085
13294
  * @description Creates a question-answer.
12086
13295
  *
@@ -12456,6 +13665,75 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12456
13665
  * @secure
12457
13666
  */
12458
13667
  revUsersListPost: (data: RevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
13668
+ /**
13669
+ * @description Scans through all Rev users.
13670
+ *
13671
+ * @tags rev-users
13672
+ * @name RevUsersScan
13673
+ * @request GET:/rev-users.scan
13674
+ * @secure
13675
+ */
13676
+ revUsersScan: (query?: {
13677
+ /** Filters for Rev users that were created by the specified user(s). */
13678
+ created_by?: string[];
13679
+ /**
13680
+ * Filters for objects created after the provided timestamp (inclusive).
13681
+ * @format date-time
13682
+ * @example "2023-01-01T12:00:00.000Z"
13683
+ */
13684
+ 'created_date.after'?: string;
13685
+ /**
13686
+ * Filters for objects created before the provided timestamp
13687
+ * (inclusive).
13688
+ * @format date-time
13689
+ * @example "2023-01-01T12:00:00.000Z"
13690
+ */
13691
+ 'created_date.before'?: string;
13692
+ /**
13693
+ * The cursor to resume iteration, otherwise the beginning if not
13694
+ * provided.
13695
+ */
13696
+ cursor?: string;
13697
+ /** Filters for custom fields. */
13698
+ custom_fields?: object;
13699
+ /** List of emails of Rev users to be filtered. */
13700
+ email?: string[];
13701
+ /** List of external refs to filter Rev users for. */
13702
+ external_ref?: string[];
13703
+ /** Value of is_verified field to filter the Rev users. */
13704
+ is_verified?: boolean;
13705
+ /**
13706
+ * Filters for objects created after the provided timestamp (inclusive).
13707
+ * @format date-time
13708
+ * @example "2023-01-01T12:00:00.000Z"
13709
+ */
13710
+ 'modified_date.after'?: string;
13711
+ /**
13712
+ * Filters for objects created before the provided timestamp
13713
+ * (inclusive).
13714
+ * @format date-time
13715
+ * @example "2023-01-01T12:00:00.000Z"
13716
+ */
13717
+ 'modified_date.before'?: string;
13718
+ /** List of phone numbers, in E.164 format, to filter Rev users on. */
13719
+ phone_numbers?: string[];
13720
+ /**
13721
+ * List of IDs of Rev organizations to be filtered.
13722
+ * @example ["REV-AbCdEfGh"]
13723
+ */
13724
+ rev_org?: string[];
13725
+ /** List of tags to be filtered. */
13726
+ tags?: string[];
13727
+ }, params?: RequestParams) => Promise<AxiosResponse<RevUsersScanResponse, any>>;
13728
+ /**
13729
+ * @description Scans through all Rev users.
13730
+ *
13731
+ * @tags rev-users
13732
+ * @name RevUsersScanPost
13733
+ * @request POST:/rev-users.scan
13734
+ * @secure
13735
+ */
13736
+ revUsersScanPost: (data: RevUsersScanRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersScanResponse, any>>;
12459
13737
  /**
12460
13738
  * @description Unlinks a rev user from a rev org.
12461
13739
  *
@@ -12932,6 +14210,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12932
14210
  * @secure
12933
14211
  */
12934
14212
  snapInsResourcesPost: (data: SnapInsResourcesRequest, params?: RequestParams) => Promise<AxiosResponse<SnapInsResourcesResponse, any>>;
14213
+ /**
14214
+ * @description Updates a snap-in.
14215
+ *
14216
+ * @tags snap-ins
14217
+ * @name SnapInsUpdate
14218
+ * @request POST:/snap-ins.update
14219
+ * @secure
14220
+ */
14221
+ snapInsUpdate: (data: SnapInsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapInsUpdateResponse, any>>;
12935
14222
  /**
12936
14223
  * @description Create a snap widget object.
12937
14224
  *
@@ -13400,6 +14687,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
13400
14687
  /**
13401
14688
  * If set, then gets the entry with the given external reference for the
13402
14689
  * provided entry ID's timeline.
14690
+ * @minLength 1
14691
+ * @maxLength 512
13403
14692
  */
13404
14693
  external_ref?: string;
13405
14694
  }, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any>>;
@@ -13796,6 +15085,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
13796
15085
  'stage.name'?: string[];
13797
15086
  /** Filters for issues that are staged. */
13798
15087
  'staged_info.is_staged'?: boolean;
15088
+ /** Filters for issues with this specific external reference. */
15089
+ 'sync_metadata.external_reference'?: string[];
13799
15090
  /** Filters for works with selected sync statuses. */
13800
15091
  'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
13801
15092
  /** Filters for works modified with selected sync units. */
@@ -13950,6 +15241,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
13950
15241
  'stage.name'?: string[];
13951
15242
  /** Filters for issues that are staged. */
13952
15243
  'staged_info.is_staged'?: boolean;
15244
+ /** Filters for issues with this specific external reference. */
15245
+ 'sync_metadata.external_reference'?: string[];
13953
15246
  /** Filters for works with selected sync statuses. */
13954
15247
  'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
13955
15248
  /** Filters for works modified with selected sync units. */