@devrev/typescript-sdk 1.1.25 → 1.1.28

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.
@@ -42,6 +42,11 @@ export type Account = OrgBase & {
42
42
  /** account-search-summary */
43
43
  export type AccountSearchSummary = SearchSummaryBase & {
44
44
  account: AccountSummary;
45
+ /**
46
+ * Comments on the work.
47
+ * @maxItems 5
48
+ */
49
+ comments?: CommentSearchSummary[];
45
50
  };
46
51
  /** account-summary */
47
52
  export type AccountSummary = OrgBaseSummary;
@@ -491,6 +496,11 @@ export interface ArticlesCountRequest {
491
496
  * @example ["DEVU-12345"]
492
497
  */
493
498
  created_by?: string[];
499
+ /**
500
+ * Filters for articles modified by any of the provided users.
501
+ * @example ["DEVU-12345"]
502
+ */
503
+ modified_by?: string[];
494
504
  /**
495
505
  * Filters for articles owned by any of the provided users.
496
506
  * @example ["DEVU-12345"]
@@ -644,6 +654,11 @@ export interface ArticlesListRequest {
644
654
  * always be returned in the specified sort-by order.
645
655
  */
646
656
  mode?: ListMode;
657
+ /**
658
+ * Filters for articles modified by any of the provided users.
659
+ * @example ["DEVU-12345"]
660
+ */
661
+ modified_by?: string[];
647
662
  /**
648
663
  * Filters for articles owned by any of the provided users.
649
664
  * @example ["DEVU-12345"]
@@ -1156,6 +1171,14 @@ export declare enum AuthTokenSubjectTokenType {
1156
1171
  export declare enum AuthTokenTokenType {
1157
1172
  Bearer = "bearer"
1158
1173
  }
1174
+ /**
1175
+ * auth-tokens-account-traits
1176
+ * Carries account info.
1177
+ */
1178
+ export interface AuthTokensAccountTraits {
1179
+ /** The display name of the account. */
1180
+ display_name?: string;
1181
+ }
1159
1182
  /**
1160
1183
  * auth-tokens-create-request
1161
1184
  * A request to create a new token corresponding to the requested token
@@ -1319,6 +1342,10 @@ export interface AuthTokensOrgTraits {
1319
1342
  * issue a Rev session token.
1320
1343
  */
1321
1344
  export interface AuthTokensRevInfo {
1345
+ /** An identifier which uniquely identifies an account. */
1346
+ account_ref?: string;
1347
+ /** Carries account info. */
1348
+ account_traits?: AuthTokensAccountTraits;
1322
1349
  /** An identifier which uniquely identifies a Rev org. */
1323
1350
  org_ref?: string;
1324
1351
  /** Carries Rev org info. */
@@ -1329,6 +1356,10 @@ export interface AuthTokensRevInfo {
1329
1356
  user_ref?: string;
1330
1357
  /** Carries Rev user info. */
1331
1358
  user_traits?: AuthTokensUserTraits;
1359
+ /** An identifier which uniquely identifies a workspace. */
1360
+ workspace_ref?: string;
1361
+ /** Carries Rev org info. */
1362
+ workspace_traits?: AuthTokensOrgTraits;
1332
1363
  }
1333
1364
  /**
1334
1365
  * auth-tokens-self-delete-request
@@ -1537,6 +1568,7 @@ export type CodeChange = AtomBase & {
1537
1568
  };
1538
1569
  /** Source of the code change object. */
1539
1570
  export declare enum CodeChangeSource {
1571
+ Bitbucket = "bitbucket",
1540
1572
  Github = "github"
1541
1573
  }
1542
1574
  /** code-changes-create-request */
@@ -1611,6 +1643,12 @@ export interface CodeChangesUpdateRequest {
1611
1643
  export interface CodeChangesUpdateResponse {
1612
1644
  code_change: CodeChange;
1613
1645
  }
1646
+ /** comment-search-summary */
1647
+ export interface CommentSearchSummary {
1648
+ comment?: TimelineCommentSummary;
1649
+ /** Text snippet where the search hit occurred. */
1650
+ snippet?: string;
1651
+ }
1614
1652
  /** conversation */
1615
1653
  export type Conversation = AtomBase & {
1616
1654
  /** Description of the conversation object. */
@@ -1645,6 +1683,11 @@ export interface ConversationMetadata {
1645
1683
  }
1646
1684
  /** conversation-search-summary */
1647
1685
  export type ConversationSearchSummary = SearchSummaryBase & {
1686
+ /**
1687
+ * Comments on the work.
1688
+ * @maxItems 5
1689
+ */
1690
+ comments?: CommentSearchSummary[];
1648
1691
  conversation: ConversationSummary;
1649
1692
  };
1650
1693
  /** conversation-summary */
@@ -1968,6 +2011,8 @@ export interface CreateEmailPreviewWidget {
1968
2011
  in_reply_to?: string;
1969
2012
  /** The list of inline attachments. */
1970
2013
  inlines?: CreateEmailInlineAttachment[];
2014
+ /** Whether the email is spam. */
2015
+ is_spam?: boolean;
1971
2016
  /** The message id of the email. */
1972
2017
  message_id?: string;
1973
2018
  /**
@@ -2039,6 +2084,12 @@ export interface CreateWeeklyOrgScheduleInterval {
2039
2084
  * Static collection of Devrev objects.
2040
2085
  */
2041
2086
  export type CuratedVistaSummary = VistaBaseSummary;
2087
+ /** custom-object-search-summary */
2088
+ export type CustomObjectSearchSummary = SearchSummaryBase & {
2089
+ custom_object: CustomObjectSummary;
2090
+ };
2091
+ /** custom-object-summary */
2092
+ export type CustomObjectSummary = AtomBaseSummary;
2042
2093
  /** custom-schema-fragment */
2043
2094
  export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFragment) & {
2044
2095
  type: CustomSchemaFragmentType;
@@ -2608,8 +2659,18 @@ export interface DevOrgAuthConnectionsUpdateResponse {
2608
2659
  }
2609
2660
  /** dev-user */
2610
2661
  export type DevUser = UserBase & {
2662
+ /**
2663
+ * Start date of the user's employment.
2664
+ * @format date-time
2665
+ * @example "2023-01-01T12:00:00.000Z"
2666
+ */
2667
+ experience_start_date?: string;
2611
2668
  /** IDs of the Dev User outside the DevRev SOR. */
2612
2669
  external_identities?: ExternalIdentity[];
2670
+ /** Job history of the user. */
2671
+ job_history?: JobHistoryItem[];
2672
+ /** Array of skills of the user. */
2673
+ skills?: UserSkill[];
2613
2674
  };
2614
2675
  /** dev-user-external-identity-filter */
2615
2676
  export interface DevUserExternalIdentityFilter {
@@ -2650,11 +2711,52 @@ export interface DevUsersGetRequest {
2650
2711
  export interface DevUsersGetResponse {
2651
2712
  dev_user: DevUser;
2652
2713
  }
2714
+ /**
2715
+ * dev-users-identities-link-request
2716
+ * Request to link external identity to a Dev user.
2717
+ */
2718
+ export interface DevUsersIdentitiesLinkRequest {
2719
+ /** The ID of the Dev user to link the external identity to. */
2720
+ dev_user: string;
2721
+ /** Display name of the Dev user in the external source. */
2722
+ display_name?: string;
2723
+ /** Unique ID of the Dev user in the external source. */
2724
+ id: string;
2725
+ /** Issuer of the external identity of the Dev user. */
2726
+ issuer: string;
2727
+ }
2728
+ /**
2729
+ * dev-users-identities-link-response
2730
+ * Response for the request to link an external identity to a Dev user.
2731
+ */
2732
+ export interface DevUsersIdentitiesLinkResponse {
2733
+ dev_user: DevUser;
2734
+ }
2735
+ /**
2736
+ * dev-users-identities-unlink-request
2737
+ * Request to unlink an external identity from a Dev user.
2738
+ */
2739
+ export interface DevUsersIdentitiesUnlinkRequest {
2740
+ /** The ID of the Dev user to unlink the external identity from. */
2741
+ dev_user: string;
2742
+ /** Issuer that needs to be unlinked from a Dev user. */
2743
+ issuer: string;
2744
+ }
2745
+ /**
2746
+ * dev-users-identities-unlink-response
2747
+ * Response for the request to unlink an external identity from a Dev
2748
+ * user.
2749
+ */
2750
+ export interface DevUsersIdentitiesUnlinkResponse {
2751
+ dev_user: DevUser;
2752
+ }
2653
2753
  /**
2654
2754
  * dev-users-list-request
2655
2755
  * A request to get the list of Dev user's information.
2656
2756
  */
2657
2757
  export interface DevUsersListRequest {
2758
+ /** Provides ways to specify date ranges on objects. */
2759
+ created_date?: DateFilter;
2658
2760
  /**
2659
2761
  * The cursor to resume iteration from. If not provided, then
2660
2762
  * iteration starts from the beginning.
@@ -2677,6 +2779,8 @@ export interface DevUsersListRequest {
2677
2779
  * always be returned in the specified sort-by order.
2678
2780
  */
2679
2781
  mode?: ListMode;
2782
+ /** Provides ways to specify date ranges on objects. */
2783
+ modified_date?: DateFilter;
2680
2784
  /** Fields to sort the Dev users by and the direction to sort them. */
2681
2785
  sort_by?: string[];
2682
2786
  /** Filters Dev users based on state. */
@@ -2788,6 +2892,8 @@ export type EmailPreviewWidget = SnapWidgetBase & {
2788
2892
  in_reply_to?: string;
2789
2893
  /** The list of inline attachments. */
2790
2894
  inlines: EmailInlineAttachment[];
2895
+ /** Whether the email is spam. */
2896
+ is_spam?: boolean;
2791
2897
  /** The message id of the email. */
2792
2898
  message_id?: string;
2793
2899
  raw_email_artifact?: ArtifactSummary;
@@ -3024,6 +3130,24 @@ export interface EngagementsUpdateResponse {
3024
3130
  export type Enhancement = PartBase;
3025
3131
  /** enhancement-summary */
3026
3132
  export type EnhancementSummary = PartBaseSummary;
3133
+ /**
3134
+ * enum-value
3135
+ * Enum Value defines the structure for an enum.
3136
+ */
3137
+ export interface EnumValue {
3138
+ /**
3139
+ * Unique ID of the enum value. This is immutable.
3140
+ * @format int64
3141
+ */
3142
+ id: number;
3143
+ /** Display label of the enum value. This is mutable. */
3144
+ label: string;
3145
+ /**
3146
+ * Order number of the enum value. This is mutable.
3147
+ * @format int64
3148
+ */
3149
+ ordinal: number;
3150
+ }
3027
3151
  /** error */
3028
3152
  export interface Error {
3029
3153
  /** Information about the error. */
@@ -3037,9 +3161,16 @@ export interface Error {
3037
3161
  type?: string;
3038
3162
  }
3039
3163
  /** error-bad-request */
3040
- export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
3164
+ export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
3041
3165
  type: ErrorBadRequestType;
3042
3166
  };
3167
+ /** error-bad-request-artifact-already-attached-to-a-parent */
3168
+ export interface ErrorBadRequestArtifactAlreadyAttachedToAParent {
3169
+ /** The existing parent attached to the artifact. */
3170
+ existing_parent: string;
3171
+ /** Whether the existing parent is the same as the new parent. */
3172
+ is_same: boolean;
3173
+ }
3043
3174
  /** error-bad-request-bad-request */
3044
3175
  export type ErrorBadRequestBadRequest = object;
3045
3176
  /** error-bad-request-invalid-api-version */
@@ -3061,6 +3192,11 @@ export interface ErrorBadRequestInvalidField {
3061
3192
  /** The field name that's invalid. */
3062
3193
  field_name: string;
3063
3194
  }
3195
+ /** error-bad-request-invalid-id */
3196
+ export interface ErrorBadRequestInvalidId {
3197
+ /** The field whose ID is invalid. */
3198
+ field_name: string;
3199
+ }
3064
3200
  /** error-bad-request-missing-dependency */
3065
3201
  export interface ErrorBadRequestMissingDependency {
3066
3202
  /** The dependent fields. */
@@ -3098,17 +3234,25 @@ export type ErrorBadRequestParseError = object;
3098
3234
  */
3099
3235
  export type ErrorBadRequestStaleSchemaFragments = object;
3100
3236
  export declare enum ErrorBadRequestType {
3237
+ ArtifactAlreadyAttachedToAParent = "artifact_already_attached_to_a_parent",
3101
3238
  BadRequest = "bad_request",
3102
3239
  InvalidApiVersion = "invalid_api_version",
3103
3240
  InvalidEnumValue = "invalid_enum_value",
3104
3241
  InvalidField = "invalid_field",
3242
+ InvalidId = "invalid_id",
3105
3243
  MissingDependency = "missing_dependency",
3106
3244
  MissingRequiredField = "missing_required_field",
3107
3245
  ParseError = "parse_error",
3108
3246
  StaleSchemaFragments = "stale_schema_fragments",
3247
+ UnexpectedIdType = "unexpected_id_type",
3109
3248
  UnexpectedJsonType = "unexpected_json_type",
3110
3249
  ValueNotPermitted = "value_not_permitted"
3111
3250
  }
3251
+ /** error-bad-request-unexpected-id-type */
3252
+ export interface ErrorBadRequestUnexpectedIdType {
3253
+ /** The field whose ID type is unexpected. */
3254
+ field_name: string;
3255
+ }
3112
3256
  /** error-bad-request-unexpected-json-type */
3113
3257
  export interface ErrorBadRequestUnexpectedJsonType {
3114
3258
  actual: ErrorBadRequestUnexpectedJsonTypeType;
@@ -3489,7 +3633,16 @@ export interface EventWorkUpdated {
3489
3633
  * external-identity
3490
3634
  * External identity of a user.
3491
3635
  */
3492
- export type ExternalIdentity = object;
3636
+ export interface ExternalIdentity {
3637
+ /** Display name of the user in the external source. */
3638
+ display_name?: string;
3639
+ /** Unique ID of the user in the external source. */
3640
+ id?: string;
3641
+ /** Whether the external identity is verified or not. */
3642
+ is_verified?: boolean;
3643
+ /** Issuer of the external identity of the user. */
3644
+ issuer?: string;
3645
+ }
3493
3646
  /** feature */
3494
3647
  export type Feature = PartBase;
3495
3648
  /** feature-summary */
@@ -3604,6 +3757,8 @@ export type GroupSearchSummary = SearchSummaryBase & {
3604
3757
  };
3605
3758
  /** group-summary */
3606
3759
  export type GroupSummary = AtomBaseSummary & {
3760
+ /** Type of the members in the group. */
3761
+ member_type?: GroupMemberType;
3607
3762
  /** Name of the group. */
3608
3763
  name?: string;
3609
3764
  };
@@ -3747,6 +3902,8 @@ export type Issue = WorkBase & {
3747
3902
  developed_with?: PartSummary[];
3748
3903
  /** Priority of the work based upon impact and criticality. */
3749
3904
  priority?: IssuePriority;
3905
+ /** Vista group item. */
3906
+ sprint?: VistaGroupItemSummary;
3750
3907
  /**
3751
3908
  * Target start date for the object.
3752
3909
  * @format date-time
@@ -3766,6 +3923,32 @@ export type IssueSummary = WorkBaseSummary & {
3766
3923
  /** Priority of the work based upon impact and criticality. */
3767
3924
  priority?: IssuePriority;
3768
3925
  };
3926
+ /**
3927
+ * job-history-item
3928
+ * Defines a job history line item.
3929
+ */
3930
+ export interface JobHistoryItem {
3931
+ /** Enum Value defines the structure for an enum. */
3932
+ employment_status?: EnumValue;
3933
+ /**
3934
+ * The end date of the job, or not specified if current.
3935
+ * @format date-time
3936
+ * @example "2023-01-01T12:00:00.000Z"
3937
+ */
3938
+ end_date?: string;
3939
+ /** Is this the current active job for the user. */
3940
+ is_current?: boolean;
3941
+ /** The job location for the user. */
3942
+ location?: string;
3943
+ /**
3944
+ * The start date of the job.
3945
+ * @format date-time
3946
+ * @example "2023-01-01T12:00:00.000Z"
3947
+ */
3948
+ start_date?: string;
3949
+ /** The job title for the user. */
3950
+ title?: string;
3951
+ }
3769
3952
  /**
3770
3953
  * legacy-stage
3771
3954
  * Describes the current stage of a work item.
@@ -4077,6 +4260,7 @@ export type MetricDefinition = AtomBase & {
4077
4260
  /** The list of item types on which the metric might be applied. */
4078
4261
  export declare enum MetricDefinitionAppliesTo {
4079
4262
  Conversation = "conversation",
4263
+ Issue = "issue",
4080
4264
  Ticket = "ticket"
4081
4265
  }
4082
4266
  /**
@@ -4089,6 +4273,15 @@ export declare enum MetricDefinitionMetricType {
4089
4273
  Time = "time",
4090
4274
  Value = "value"
4091
4275
  }
4276
+ /**
4277
+ * The status of the metric. 'active' metrics can be used to create new
4278
+ * SLAs, while 'inactive' metrics can not be used in new SLAs. Metrics can
4279
+ * be updated between 'active' and 'inactive' states.
4280
+ */
4281
+ export declare enum MetricDefinitionStatus {
4282
+ Active = "active",
4283
+ Inactive = "inactive"
4284
+ }
4092
4285
  /** metric-definition-summary */
4093
4286
  export type MetricDefinitionSummary = AtomBaseSummary & {
4094
4287
  /** Human readable name of the metric. */
@@ -4121,6 +4314,8 @@ export interface MetricDefinitionsListRequest {
4121
4314
  * always be returned in the specified sort-by order.
4122
4315
  */
4123
4316
  mode?: ListMode;
4317
+ /** The status of the metric definition. */
4318
+ status?: MetricDefinitionStatus[];
4124
4319
  /** The type of metric definitions sought. */
4125
4320
  type?: MetricDefinitionMetricType[];
4126
4321
  }
@@ -4621,6 +4816,11 @@ export type PartBaseSummary = AtomBaseSummary & {
4621
4816
  };
4622
4817
  /** part-search-summary */
4623
4818
  export type PartSearchSummary = SearchSummaryBase & {
4819
+ /**
4820
+ * Comments on the work.
4821
+ * @maxItems 5
4822
+ */
4823
+ comments?: CommentSearchSummary[];
4624
4824
  part: PartSummary;
4625
4825
  };
4626
4826
  /** part-summary */
@@ -4817,14 +5017,14 @@ export interface PartsUpdateRequestEnhancement {
4817
5017
  * @format date-time
4818
5018
  * @example "2023-01-01T12:00:00.000Z"
4819
5019
  */
4820
- target_close_date?: string;
5020
+ target_close_date?: string | null;
4821
5021
  /**
4822
5022
  * Updates the target start date of the enhancement. Example Date
4823
5023
  * Format: 2000-11-01T01:01:01Z
4824
5024
  * @format date-time
4825
5025
  * @example "2023-01-01T12:00:00.000Z"
4826
5026
  */
4827
- target_start_date?: string;
5027
+ target_start_date?: string | null;
4828
5028
  }
4829
5029
  /** parts-update-request-feature */
4830
5030
  export type PartsUpdateRequestFeature = object;
@@ -4872,6 +5072,7 @@ export type QuestionAnswerSearchSummary = SearchSummaryBase & {
4872
5072
  /** Status of the question answer. */
4873
5073
  export declare enum QuestionAnswerStatus {
4874
5074
  Archived = "archived",
5075
+ Discarded = "discarded",
4875
5076
  Draft = "draft",
4876
5077
  Published = "published",
4877
5078
  ReviewNeeded = "review_needed"
@@ -6227,6 +6428,7 @@ export declare enum SearchNamespace {
6227
6428
  Capability = "capability",
6228
6429
  Component = "component",
6229
6430
  Conversation = "conversation",
6431
+ CustomObject = "custom_object",
6230
6432
  CustomPart = "custom_part",
6231
6433
  CustomWork = "custom_work",
6232
6434
  Dashboard = "dashboard",
@@ -6253,7 +6455,7 @@ export declare enum SearchNamespace {
6253
6455
  Vista = "vista"
6254
6456
  }
6255
6457
  /** search-result */
6256
- export type SearchResult = (AccountSearchSummary | ArticleSearchSummary | ArtifactSearchSummary | ConversationSearchSummary | DashboardSearchSummary | GroupSearchSummary | LinkSearchSummary | ObjectMemberSearchSummary | OrgSearchSummary | PartSearchSummary | QuestionAnswerSearchSummary | TagSearchSummary | UserSearchSummary | VistaSearchSummary | WorkSearchSummary) & {
6458
+ export type SearchResult = (AccountSearchSummary | ArticleSearchSummary | ArtifactSearchSummary | ConversationSearchSummary | CustomObjectSearchSummary | DashboardSearchSummary | GroupSearchSummary | LinkSearchSummary | ObjectMemberSearchSummary | OrgSearchSummary | PartSearchSummary | QuestionAnswerSearchSummary | TagSearchSummary | UserSearchSummary | VistaSearchSummary | WorkSearchSummary) & {
6257
6459
  type: SearchResultType;
6258
6460
  };
6259
6461
  export declare enum SearchResultType {
@@ -6261,6 +6463,7 @@ export declare enum SearchResultType {
6261
6463
  Article = "article",
6262
6464
  Artifact = "artifact",
6263
6465
  Conversation = "conversation",
6466
+ CustomObject = "custom_object",
6264
6467
  Dashboard = "dashboard",
6265
6468
  Group = "group",
6266
6469
  Link = "link",
@@ -6315,6 +6518,36 @@ export interface ServiceAccountsGetRequest {
6315
6518
  export interface ServiceAccountsGetResponse {
6316
6519
  service_account: ServiceAccount;
6317
6520
  }
6521
+ /** set-issue-selector */
6522
+ export interface SetIssueSelector {
6523
+ /**
6524
+ * Custom fields on the issue with their fully qualified names and the
6525
+ * associated with their exact allowed values. The SLA policy applies
6526
+ * to issues where all named custom fields have exactly the specified
6527
+ * values.
6528
+ */
6529
+ custom_fields?: object;
6530
+ /**
6531
+ * The SLA policy applies to the issues of these parts.
6532
+ * @example ["PROD-12345"]
6533
+ */
6534
+ parts?: string[];
6535
+ /**
6536
+ * The SLA policy applies to the issues of these revorgs.
6537
+ * @example ["REV-AbCdEfGh"]
6538
+ */
6539
+ rev_orgs?: string[];
6540
+ /** The SLA policy applies to issues with these stages. */
6541
+ stage_name?: string[];
6542
+ /** The issue subtype for which the SLA policy applies. */
6543
+ subtype?: string[];
6544
+ /**
6545
+ * The SLA policy applies to issues with these tags. If empty, the tag
6546
+ * filter isn't applied.
6547
+ * @example ["TAG-12345"]
6548
+ */
6549
+ tags?: string[];
6550
+ }
6318
6551
  /** set-org-schedule-fragment-summary */
6319
6552
  export interface SetOrgScheduleFragmentSummary {
6320
6553
  /** Organization schedule fragment ID. */
@@ -6344,6 +6577,7 @@ export interface SetSlaSelector {
6344
6577
  * value is null, the field must have null value or not be present.
6345
6578
  */
6346
6579
  custom_fields?: object;
6580
+ issue_selector?: SetIssueSelector;
6347
6581
  /**
6348
6582
  * The SLA policy applies to the tickets of these parts.
6349
6583
  * @example ["PROD-12345"]
@@ -6448,6 +6682,8 @@ export type Sla = AtomBase & {
6448
6682
  * priority.
6449
6683
  */
6450
6684
  policies?: SlaPolicy[];
6685
+ /** Type of the SLA. */
6686
+ sla_type?: SlaType;
6451
6687
  /**
6452
6688
  * Status determines how an item can be used. In 'draft' status an item
6453
6689
  * can be edited but can't be used. When 'published' the item can longer
@@ -6455,6 +6691,16 @@ export type Sla = AtomBase & {
6455
6691
  */
6456
6692
  status: SlaStatus;
6457
6693
  };
6694
+ /**
6695
+ * The object types on which the SLA applies. An external SLA can apply to
6696
+ * multiple object types, but an internal SLA can apply to only one object
6697
+ * type.
6698
+ */
6699
+ export declare enum SlaAppliesTo {
6700
+ Conversation = "conversation",
6701
+ Issue = "issue",
6702
+ Ticket = "ticket"
6703
+ }
6458
6704
  /** sla-assign-result */
6459
6705
  export interface SlaAssignResult {
6460
6706
  error?: Error;
@@ -6490,9 +6736,10 @@ export type SlaPolicy = object;
6490
6736
  /** The item type for which the SLA policy applies. */
6491
6737
  export declare enum SlaSelectorAppliesTo {
6492
6738
  Conversation = "conversation",
6739
+ Issue = "issue",
6493
6740
  Ticket = "ticket"
6494
6741
  }
6495
- /** Th SLA policy applies to conversations with these priorities. */
6742
+ /** The SLA policy applies to conversations with these priorities. */
6496
6743
  export declare enum SlaSelectorPriority {
6497
6744
  P0 = "p0",
6498
6745
  P1 = "p1",
@@ -6519,6 +6766,8 @@ export declare enum SlaStatus {
6519
6766
  export type SlaSummary = AtomBaseSummary & {
6520
6767
  /** Human-readable name. */
6521
6768
  name: string;
6769
+ /** Type of the SLA. */
6770
+ sla_type?: SlaType;
6522
6771
  /**
6523
6772
  * Status determines how an item can be used. In 'draft' status an item
6524
6773
  * can be edited but can't be used. When 'published' the item can longer
@@ -6579,6 +6828,11 @@ export interface SlaTrackersGetRequest {
6579
6828
  export interface SlaTrackersGetResponse {
6580
6829
  sla_tracker: SlaTracker;
6581
6830
  }
6831
+ /** Type of the SLA. */
6832
+ export declare enum SlaType {
6833
+ External = "external",
6834
+ Internal = "internal"
6835
+ }
6582
6836
  /** slas-assign-request */
6583
6837
  export interface SlasAssignRequest {
6584
6838
  /**
@@ -6601,6 +6855,8 @@ export interface SlasAssignResponse {
6601
6855
  /** slas-create-request */
6602
6856
  export interface SlasCreateRequest {
6603
6857
  account_selector?: AccountsFilters;
6858
+ /** The object types this SLA can apply to. */
6859
+ applies_to?: SlaAppliesTo[];
6604
6860
  /** Description of the purpose and capabilities of the SLA. */
6605
6861
  description?: string;
6606
6862
  /**
@@ -6619,11 +6875,17 @@ export interface SlasCreateRequest {
6619
6875
  * priority.
6620
6876
  */
6621
6877
  policies?: SetSlaPolicy[];
6878
+ /** Type of the SLA. */
6879
+ sla_type?: SlaType;
6622
6880
  }
6623
6881
  /** slas-create-response */
6624
6882
  export interface SlasCreateResponse {
6625
6883
  sla: Sla;
6626
6884
  }
6885
+ export declare enum SlasFilterAppliesToOperatorType {
6886
+ All = "all",
6887
+ Any = "any"
6888
+ }
6627
6889
  /** slas-get-request */
6628
6890
  export interface SlasGetRequest {
6629
6891
  /** The ID of the SLA to get. */
@@ -6635,6 +6897,9 @@ export interface SlasGetResponse {
6635
6897
  }
6636
6898
  /** slas-list-request */
6637
6899
  export interface SlasListRequest {
6900
+ /** The object types the SLA applies to. */
6901
+ applies_to?: SlaAppliesTo[];
6902
+ applies_to_op?: SlasFilterAppliesToOperatorType;
6638
6903
  /**
6639
6904
  * The cursor to resume iteration from. If not provided, then
6640
6905
  * iteration starts from the beginning.
@@ -6653,6 +6918,8 @@ export interface SlasListRequest {
6653
6918
  * always be returned in the specified sort-by order.
6654
6919
  */
6655
6920
  mode?: ListMode;
6921
+ /** The SLA types the filter matches. */
6922
+ sla_type?: SlaType[];
6656
6923
  /** The SLA statuses the filter matches. */
6657
6924
  status?: SlaStatus[];
6658
6925
  }
@@ -6938,27 +7205,52 @@ export interface SubtypesListResponse {
6938
7205
  export type Survey = AtomBase & {
6939
7206
  /** Description of the survey. */
6940
7207
  description?: string;
7208
+ /** Text posted when introducing the survey to the responder. */
7209
+ introductory_text?: string;
6941
7210
  /**
6942
7211
  * Survey name associated with schema. This name would be unique per
6943
7212
  * dev org.
6944
7213
  */
6945
7214
  name?: string;
7215
+ /** Text posted after the response is collected. */
7216
+ response_text?: string;
6946
7217
  /** List of all fields in the schema. */
6947
- schema: SchemaFieldDescriptor[];
7218
+ schema?: SchemaFieldDescriptor[];
7219
+ /** List of all the fields and their respective metadata in the schema. */
7220
+ schema_with_metadata?: SurveyFieldWithMetadata[];
6948
7221
  };
6949
7222
  /**
6950
7223
  * survey-aggregation-filter
6951
7224
  * The filter for survey aggregation.
6952
7225
  */
6953
7226
  export type SurveyAggregationFilter = object;
7227
+ /**
7228
+ * survey-field-with-metadata
7229
+ * Field descriptors with additional metadata for surveys.
7230
+ */
7231
+ export interface SurveyFieldWithMetadata {
7232
+ /** Set of field attributes. */
7233
+ field?: SchemaFieldDescriptor;
7234
+ /** Additional metadata for the input field. */
7235
+ metadata?: object;
7236
+ /** The question linked to the input field. */
7237
+ question?: string;
7238
+ }
6954
7239
  /** survey-response */
6955
7240
  export type SurveyResponse = AtomBase & {
6956
7241
  /** The unique ID associated with the dispatched survey. */
6957
7242
  dispatch_id?: string;
7243
+ /** Source channels on which the survey is sent. */
7244
+ dispatched_channels?: EnumValue[];
6958
7245
  /** The ID of the object for which survey is taken. */
6959
7246
  object?: string;
7247
+ recipient?: UserSummary;
6960
7248
  /** Response for the survey. */
6961
7249
  response?: object;
7250
+ /** Enum Value defines the structure for an enum. */
7251
+ response_channel?: EnumValue;
7252
+ /** Enum Value defines the structure for an enum. */
7253
+ stage?: EnumValue;
6962
7254
  /** The ID of the survey for which response is taken. */
6963
7255
  survey?: string;
6964
7256
  };
@@ -6966,10 +7258,16 @@ export type SurveyResponse = AtomBase & {
6966
7258
  export interface SurveysCreateRequest {
6967
7259
  /** Description about the survey. */
6968
7260
  description?: string;
7261
+ /** Text posted when introducing the survey to the responder. */
7262
+ introductory_text?: string;
6969
7263
  /** The survey's name. */
6970
7264
  name: string;
7265
+ /** Text posted after the response is collected. */
7266
+ response_text?: string;
6971
7267
  /** Schema for the survey. */
6972
- schema: FieldDescriptor[];
7268
+ schema?: FieldDescriptor[];
7269
+ /** The schema with metadata for the survey. */
7270
+ schema_with_metadata?: SurveyFieldWithMetadata[];
6973
7271
  }
6974
7272
  /** surveys-create-response */
6975
7273
  export interface SurveysCreateResponse {
@@ -7072,6 +7370,8 @@ export interface SurveysResponsesListRequest {
7072
7370
  * them.
7073
7371
  */
7074
7372
  sort_by?: string[];
7373
+ /** Filters for survey response stages. */
7374
+ stages?: number[];
7075
7375
  /** Filters for survey responses for the provided survey IDs. */
7076
7376
  surveys?: string[];
7077
7377
  }
@@ -7111,14 +7411,21 @@ export type SurveysSendResponse = object;
7111
7411
  export interface SurveysSubmitRequest {
7112
7412
  /** The unique ID associated with the dispatched survey. */
7113
7413
  dispatch_id?: string;
7414
+ /** The ordinals of the source channels on which the survey is sent. */
7415
+ dispatched_channels?: number[];
7114
7416
  /**
7115
7417
  * The ID of the object this survey is on (e.g. ticket, conversation,
7116
7418
  * etc).
7117
7419
  * @example "ACC-12345"
7118
7420
  */
7119
7421
  object: string;
7422
+ /**
7423
+ * The unique ID associated with the recipient of the survey.
7424
+ * @example "DEVU-12345"
7425
+ */
7426
+ recipient?: string;
7120
7427
  /** Survey response submitted for the object. */
7121
- response: object;
7428
+ response?: object;
7122
7429
  /**
7123
7430
  * The response score for the survey. Only applicable for CSAT and
7124
7431
  * NPS.
@@ -7127,6 +7434,11 @@ export interface SurveysSubmitRequest {
7127
7434
  response_score?: number;
7128
7435
  /** The source channel from which survey response is submitted. */
7129
7436
  source_channel?: string;
7437
+ /**
7438
+ * The stage ordinal of the survey response object.
7439
+ * @format int64
7440
+ */
7441
+ stage?: number;
7130
7442
  /** The ID of the survey to submit the response to. */
7131
7443
  survey: string;
7132
7444
  }
@@ -7449,6 +7761,8 @@ export type Ticket = WorkBase & {
7449
7761
  /** Channels of the ticket. */
7450
7762
  channels?: TicketChannels[];
7451
7763
  group?: GroupSummary;
7764
+ /** Whether the ticket needs a response. */
7765
+ needs_response?: boolean;
7452
7766
  rev_org?: OrgSummary;
7453
7767
  /** Severity of the ticket. */
7454
7768
  severity?: TicketSeverity;
@@ -7460,7 +7774,8 @@ export type Ticket = WorkBase & {
7460
7774
  export declare enum TicketChannels {
7461
7775
  Email = "email",
7462
7776
  Plug = "plug",
7463
- Slack = "slack"
7777
+ Slack = "slack",
7778
+ Twilio = "twilio"
7464
7779
  }
7465
7780
  /** Severity of the ticket. */
7466
7781
  export declare enum TicketSeverity {
@@ -8273,8 +8588,21 @@ export type UserBaseSummary = AtomBaseSummary & {
8273
8588
  };
8274
8589
  /** user-search-summary */
8275
8590
  export type UserSearchSummary = SearchSummaryBase & {
8591
+ /**
8592
+ * Comments on the work.
8593
+ * @maxItems 5
8594
+ */
8595
+ comments?: CommentSearchSummary[];
8276
8596
  user: UserSummary;
8277
8597
  };
8598
+ /**
8599
+ * user-skill
8600
+ * Skill associated with the user.
8601
+ */
8602
+ export interface UserSkill {
8603
+ /** Name of the skill. */
8604
+ name?: string;
8605
+ }
8278
8606
  /** State of the user. */
8279
8607
  export declare enum UserState {
8280
8608
  Active = "active",
@@ -8299,6 +8627,43 @@ export type VistaBaseSummary = AtomBaseSummary & {
8299
8627
  /** Name of the vista. */
8300
8628
  name: string;
8301
8629
  };
8630
+ /** Defines the state of the group item. */
8631
+ export declare enum VistaGroupItemState {
8632
+ Active = "active",
8633
+ Completed = "completed",
8634
+ Planned = "planned"
8635
+ }
8636
+ /**
8637
+ * vista-group-item-summary
8638
+ * Vista group item.
8639
+ */
8640
+ export interface VistaGroupItemSummary {
8641
+ /**
8642
+ * Timestamp when the vista ends.
8643
+ * @format date-time
8644
+ * @example "2023-01-01T12:00:00.000Z"
8645
+ */
8646
+ end_date?: string;
8647
+ /** ID of the group item in don v2 format. */
8648
+ id: string;
8649
+ /** Name of the group. */
8650
+ name: string;
8651
+ /**
8652
+ * Timestamp when the vista starts.
8653
+ * @format date-time
8654
+ * @example "2023-01-01T12:00:00.000Z"
8655
+ */
8656
+ start_date?: string;
8657
+ /** Defines the state of the group item. */
8658
+ state?: VistaGroupItemState;
8659
+ /** Type of the group object. */
8660
+ type: VistaGroupItemType;
8661
+ }
8662
+ /** Type of the group object. */
8663
+ export declare enum VistaGroupItemType {
8664
+ Curated = "curated",
8665
+ Dynamic = "dynamic"
8666
+ }
8302
8667
  /** vista-search-summary */
8303
8668
  export type VistaSearchSummary = SearchSummaryBase & {
8304
8669
  /** Represents a collection of DevRev objects. */
@@ -8644,6 +9009,11 @@ export type WorkBaseSummary = AtomBaseSummary & {
8644
9009
  };
8645
9010
  /** work-search-summary */
8646
9011
  export type WorkSearchSummary = SearchSummaryBase & {
9012
+ /**
9013
+ * Comments on the work.
9014
+ * @maxItems 5
9015
+ */
9016
+ comments?: CommentSearchSummary[];
8647
9017
  work: WorkSummary;
8648
9018
  };
8649
9019
  /** work-summary */
@@ -8891,6 +9261,8 @@ export interface WorksFilterIssue {
8891
9261
  * @example ["REV-AbCdEfGh"]
8892
9262
  */
8893
9263
  rev_orgs?: string[];
9264
+ /** Filters for issues with any of the sprint. */
9265
+ sprint?: string[];
8894
9266
  /** Filters for issues with any of the provided subtypes. */
8895
9267
  subtype?: string[];
8896
9268
  /** Provides ways to specify date ranges on objects. */
@@ -9501,6 +9873,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9501
9873
  * @example ["DEVU-12345"]
9502
9874
  */
9503
9875
  created_by?: string[];
9876
+ /**
9877
+ * Filters for articles modified by any of the provided users.
9878
+ * @example ["DEVU-12345"]
9879
+ */
9880
+ modified_by?: string[];
9504
9881
  /**
9505
9882
  * Filters for articles owned by any of the provided users.
9506
9883
  * @example ["DEVU-12345"]
@@ -9597,6 +9974,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9597
9974
  * used.
9598
9975
  */
9599
9976
  mode?: ListMode;
9977
+ /**
9978
+ * Filters for articles modified by any of the provided users.
9979
+ * @example ["DEVU-12345"]
9980
+ */
9981
+ modified_by?: string[];
9600
9982
  /**
9601
9983
  * Filters for articles owned by any of the provided users.
9602
9984
  * @example ["DEVU-12345"]
@@ -10188,6 +10570,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10188
10570
  * @secure
10189
10571
  */
10190
10572
  devUsersGetPost: (data: DevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any>>;
10573
+ /**
10574
+ * @description Links an external/secondary identity to the Dev user.
10575
+ *
10576
+ * @tags dev-users
10577
+ * @name DevUsersIdentitiesLink
10578
+ * @request POST:/dev-users.identities.link
10579
+ * @secure
10580
+ */
10581
+ devUsersIdentitiesLink: (data: DevUsersIdentitiesLinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesLinkResponse, any>>;
10582
+ /**
10583
+ * @description Unlinks an external/secondary identity from the Dev user.
10584
+ *
10585
+ * @tags dev-users
10586
+ * @name DevUsersIdentitiesUnlink
10587
+ * @request POST:/dev-users.identities.unlink
10588
+ * @secure
10589
+ */
10590
+ devUsersIdentitiesUnlink: (data: DevUsersIdentitiesUnlinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesUnlinkResponse, any>>;
10191
10591
  /**
10192
10592
  * @description Lists users within your organization.
10193
10593
  *
@@ -10695,6 +11095,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10695
11095
  * used.
10696
11096
  */
10697
11097
  mode?: ListMode;
11098
+ /** The status of the metric definition. */
11099
+ status?: MetricDefinitionStatus[];
10698
11100
  /** The type of metric definitions sought. */
10699
11101
  type?: MetricDefinitionMetricType[];
10700
11102
  }, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
@@ -11737,6 +12139,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11737
12139
  * @secure
11738
12140
  */
11739
12141
  slasList: (query?: {
12142
+ /** The object types the SLA applies to. */
12143
+ applies_to?: SlaAppliesTo[];
12144
+ /**
12145
+ * The Filter operator to be applied on the applies to object types
12146
+ * filter.
12147
+ */
12148
+ applies_to_op?: SlasFilterAppliesToOperatorType;
11740
12149
  /**
11741
12150
  * The cursor to resume iteration from. If not provided, then iteration
11742
12151
  * starts from the beginning.
@@ -11752,6 +12161,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11752
12161
  * used.
11753
12162
  */
11754
12163
  mode?: ListMode;
12164
+ /** The SLA types the filter matches. */
12165
+ sla_type?: SlaType[];
11755
12166
  /** The SLA statuses the filter matches. */
11756
12167
  status?: SlaStatus[];
11757
12168
  }, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any>>;
@@ -12066,6 +12477,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12066
12477
  * them.
12067
12478
  */
12068
12479
  sort_by?: string[];
12480
+ /** Filters for survey response stages. */
12481
+ stages?: number[];
12069
12482
  /** Filters for survey responses for the provided survey IDs. */
12070
12483
  surveys?: string[];
12071
12484
  }, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any>>;
@@ -12631,6 +13044,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12631
13044
  * @example ["REV-AbCdEfGh"]
12632
13045
  */
12633
13046
  'issue.rev_orgs'?: string[];
13047
+ /** Filters for issues with any of the sprint. */
13048
+ 'issue.sprint'?: string[];
12634
13049
  /** Filters for issues with any of the provided subtypes. */
12635
13050
  'issue.subtype'?: string[];
12636
13051
  /**
@@ -12771,6 +13186,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12771
13186
  * @example ["REV-AbCdEfGh"]
12772
13187
  */
12773
13188
  'issue.rev_orgs'?: string[];
13189
+ /** Filters for issues with any of the sprint. */
13190
+ 'issue.sprint'?: string[];
12774
13191
  /** Filters for issues with any of the provided subtypes. */
12775
13192
  'issue.subtype'?: string[];
12776
13193
  /**