@devrev/typescript-sdk 1.1.24 → 1.1.27

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.
@@ -474,6 +474,8 @@ export type ArticleSummary = AtomBaseSummary & {
474
474
  };
475
475
  /** articles-count-request */
476
476
  export interface ArticlesCountRequest {
477
+ /** The ancestor directory of the articles. */
478
+ ancestor?: string;
477
479
  /**
478
480
  * Filters for articles belonging to any of the provided parts.
479
481
  * @example ["PROD-12345"]
@@ -489,6 +491,11 @@ export interface ArticlesCountRequest {
489
491
  * @example ["DEVU-12345"]
490
492
  */
491
493
  created_by?: string[];
494
+ /**
495
+ * Filters for articles modified by any of the provided users.
496
+ * @example ["DEVU-12345"]
497
+ */
498
+ modified_by?: string[];
492
499
  /**
493
500
  * Filters for articles owned by any of the provided users.
494
501
  * @example ["DEVU-12345"]
@@ -642,6 +649,11 @@ export interface ArticlesListRequest {
642
649
  * always be returned in the specified sort-by order.
643
650
  */
644
651
  mode?: ListMode;
652
+ /**
653
+ * Filters for articles modified by any of the provided users.
654
+ * @example ["DEVU-12345"]
655
+ */
656
+ modified_by?: string[];
645
657
  /**
646
658
  * Filters for articles owned by any of the provided users.
647
659
  * @example ["DEVU-12345"]
@@ -1127,6 +1139,7 @@ export declare enum AuthTokenRequestedTokenType {
1127
1139
  UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
1128
1140
  UrnDevrevParamsOauthTokenTypeSessionDev0 = "urn:devrev:params:oauth:token-type:session:dev0",
1129
1141
  UrnDevrevParamsOauthTokenTypeSessionOnetime = "urn:devrev:params:oauth:token-type:session:onetime",
1142
+ UrnDevrevParamsOauthTokenTypeSessionRevActAs = "urn:devrev:params:oauth:token-type:session:rev:act-as",
1130
1143
  UrnDevrevParamsOauthTokenTypeSuper = "urn:devrev:params:oauth:token-type:super",
1131
1144
  UrnDevrevParamsOauthTokenTypeSys = "urn:devrev:params:oauth:token-type:sys",
1132
1145
  UrnIetfParamsOauthTokenTypeJwt = "urn:ietf:params:oauth:token-type:jwt"
@@ -1374,6 +1387,46 @@ export interface AuthTokensUserTraits {
1374
1387
  /** Phone numbers of the Rev user. */
1375
1388
  phone_numbers?: string[];
1376
1389
  }
1390
+ /**
1391
+ * boolean-expression
1392
+ * Boolean expression.
1393
+ */
1394
+ export type BooleanExpression = (BooleanExpressionAndExpression | BooleanExpressionNotExpression | BooleanExpressionOrExpression | BooleanExpressionPrimitiveExpression) & {
1395
+ type: BooleanExpressionType;
1396
+ };
1397
+ /**
1398
+ * boolean-expression-and-expression
1399
+ * All the expressions would be 'and'ed together.
1400
+ */
1401
+ export interface BooleanExpressionAndExpression {
1402
+ expressions: BooleanExpression[];
1403
+ }
1404
+ /**
1405
+ * boolean-expression-not-expression
1406
+ * The expression would be negated.
1407
+ */
1408
+ export interface BooleanExpressionNotExpression {
1409
+ /** Boolean expression. */
1410
+ expression: BooleanExpression;
1411
+ }
1412
+ /**
1413
+ * boolean-expression-or-expression
1414
+ * All the expressions would be 'or'ed together.
1415
+ */
1416
+ export interface BooleanExpressionOrExpression {
1417
+ expressions: BooleanExpression[];
1418
+ }
1419
+ /**
1420
+ * boolean-expression-primitive-expression
1421
+ * The primitive expression type.
1422
+ */
1423
+ export type BooleanExpressionPrimitiveExpression = object;
1424
+ export declare enum BooleanExpressionType {
1425
+ And = "and",
1426
+ Not = "not",
1427
+ Or = "or",
1428
+ Primitive = "primitive"
1429
+ }
1377
1430
  /** capability */
1378
1431
  export type Capability = PartBase;
1379
1432
  /** capability-summary */
@@ -2182,6 +2235,161 @@ export interface CustomSchemaSpec {
2182
2235
  /** Whether to enforce required fields validation. */
2183
2236
  validate_required_fields?: boolean;
2184
2237
  }
2238
+ /** custom-stage */
2239
+ export type CustomStage = AtomBase;
2240
+ /** custom-stages-create-request */
2241
+ export interface CustomStagesCreateRequest {
2242
+ /**
2243
+ * A reference to the marketplace item from which this stage was
2244
+ * imported.
2245
+ */
2246
+ marketplace_ref?: string;
2247
+ /** The name of the custom stage. */
2248
+ name: string;
2249
+ /**
2250
+ * The ordinal of the custom stage used for ordering.
2251
+ * @format int32
2252
+ */
2253
+ ordinal: number;
2254
+ /** The state ID. */
2255
+ state: string;
2256
+ }
2257
+ /** custom-stages-create-response */
2258
+ export interface CustomStagesCreateResponse {
2259
+ custom_stage: CustomStage;
2260
+ }
2261
+ /** custom-stages-get-request */
2262
+ export interface CustomStagesGetRequest {
2263
+ /** The ID of the custom stage to get. */
2264
+ id: string;
2265
+ }
2266
+ /** custom-stages-get-response */
2267
+ export interface CustomStagesGetResponse {
2268
+ custom_stage: CustomStage;
2269
+ }
2270
+ /** custom-stages-list-request */
2271
+ export interface CustomStagesListRequest {
2272
+ /**
2273
+ * The cursor to resume iteration from, otherwise if not provided,
2274
+ * then iteration starts from the beginning.
2275
+ */
2276
+ cursor?: string;
2277
+ /**
2278
+ * The maximum number of items.
2279
+ * @format int32
2280
+ */
2281
+ limit?: number;
2282
+ /** The list of stage names. */
2283
+ name?: string[];
2284
+ /** The list of stage ordinals. */
2285
+ ordinal?: number[];
2286
+ /** The list of fields to sort the items by and how to sort them. */
2287
+ sort_by?: string[];
2288
+ }
2289
+ /** custom-stages-list-response */
2290
+ export interface CustomStagesListResponse {
2291
+ /**
2292
+ * The cursor to resume iteration from, otherwise if not provided,
2293
+ * then iteration starts from the beginning.
2294
+ */
2295
+ cursor?: string;
2296
+ /** The custom stages. */
2297
+ result: CustomStage[];
2298
+ }
2299
+ /** custom-stages-update-request */
2300
+ export interface CustomStagesUpdateRequest {
2301
+ /** The ID of the custom stage to update. */
2302
+ id: string;
2303
+ /** The updated name of the custom stage. */
2304
+ name?: string;
2305
+ /**
2306
+ * The ordinal of the custom stage.
2307
+ * @format int32
2308
+ */
2309
+ ordinal?: number;
2310
+ /** The state ID. */
2311
+ state_id?: string;
2312
+ }
2313
+ /** custom-stages-update-response */
2314
+ export interface CustomStagesUpdateResponse {
2315
+ custom_stage: CustomStage;
2316
+ }
2317
+ /** custom-state */
2318
+ export type CustomState = AtomBase;
2319
+ /** custom-states-create-request */
2320
+ export interface CustomStatesCreateRequest {
2321
+ /** Whether this is a final state. */
2322
+ is_final?: boolean;
2323
+ /** The name of the custom state. */
2324
+ name: string;
2325
+ /**
2326
+ * Ordinal of the custom state used to identify system states.
2327
+ * @format int32
2328
+ */
2329
+ ordinal: number;
2330
+ }
2331
+ /** custom-states-create-response */
2332
+ export interface CustomStatesCreateResponse {
2333
+ custom_state: CustomState;
2334
+ }
2335
+ /** custom-states-get-request */
2336
+ export interface CustomStatesGetRequest {
2337
+ /** The ID of the custom state to get. */
2338
+ id: string;
2339
+ }
2340
+ /** custom-states-get-response */
2341
+ export interface CustomStatesGetResponse {
2342
+ custom_state: CustomState;
2343
+ }
2344
+ /** custom-states-list-request */
2345
+ export interface CustomStatesListRequest {
2346
+ /**
2347
+ * The cursor to resume iteration from, otherwise if not provided,
2348
+ * then iteration starts from the beginning.
2349
+ */
2350
+ cursor?: string;
2351
+ /** Whether only final states should be filtered. */
2352
+ is_final?: boolean;
2353
+ /**
2354
+ * The maximum number of items.
2355
+ * @format int32
2356
+ */
2357
+ limit?: number;
2358
+ /** The list of state names. */
2359
+ name?: string[];
2360
+ /** The list of state ordinals. */
2361
+ ordinal?: number[];
2362
+ /** The list of fields to sort the items by and how to sort them. */
2363
+ sort_by?: string[];
2364
+ }
2365
+ /** custom-states-list-response */
2366
+ export interface CustomStatesListResponse {
2367
+ /**
2368
+ * The cursor to resume iteration from, otherwise if not provided,
2369
+ * then iteration starts from the beginning.
2370
+ */
2371
+ cursor?: string;
2372
+ /** The custom states. */
2373
+ result: CustomState[];
2374
+ }
2375
+ /** custom-states-update-request */
2376
+ export interface CustomStatesUpdateRequest {
2377
+ /** The ID of the custom state to update. */
2378
+ id: string;
2379
+ /** Whether this is a final state. */
2380
+ is_final?: boolean;
2381
+ /** The name of the custom state. */
2382
+ name?: string;
2383
+ /**
2384
+ * Ordinal of the custom state used to identify system states.
2385
+ * @format int32
2386
+ */
2387
+ ordinal?: number;
2388
+ }
2389
+ /** custom-states-update-response */
2390
+ export interface CustomStatesUpdateResponse {
2391
+ custom_state: CustomState;
2392
+ }
2185
2393
  /** custom-type-fragment */
2186
2394
  export type CustomTypeFragment = CustomSchemaFragmentBase & {
2187
2395
  stage_diagram?: StageDiagramSummary;
@@ -2410,8 +2618,18 @@ export interface DevOrgAuthConnectionsUpdateResponse {
2410
2618
  }
2411
2619
  /** dev-user */
2412
2620
  export type DevUser = UserBase & {
2621
+ /**
2622
+ * Start date of the user's employment.
2623
+ * @format date-time
2624
+ * @example "2023-01-01T12:00:00.000Z"
2625
+ */
2626
+ experience_start_date?: string;
2413
2627
  /** IDs of the Dev User outside the DevRev SOR. */
2414
2628
  external_identities?: ExternalIdentity[];
2629
+ /** Job history of the user. */
2630
+ job_history?: JobHistoryItem[];
2631
+ /** Array of skills of the user. */
2632
+ skills?: UserSkill[];
2415
2633
  };
2416
2634
  /** dev-user-external-identity-filter */
2417
2635
  export interface DevUserExternalIdentityFilter {
@@ -2420,6 +2638,21 @@ export interface DevUserExternalIdentityFilter {
2420
2638
  /** Issuer of the external identity of the user. */
2421
2639
  issuer?: string;
2422
2640
  }
2641
+ /** Job title of the Dev User. */
2642
+ export declare enum DevUserJobTitle {
2643
+ CustomerSuccessManager = "customer_success_manager",
2644
+ Cxo = "cxo",
2645
+ Designer = "designer",
2646
+ Developer = "developer",
2647
+ HeadOfSupport = "head_of_support",
2648
+ Operations = "operations",
2649
+ Others = "others",
2650
+ ProductManager = "product_manager",
2651
+ Qa = "qa",
2652
+ RevenueLeader = "revenue_leader",
2653
+ Support = "support",
2654
+ TechLead = "tech_lead"
2655
+ }
2423
2656
  /** dev-user-summary */
2424
2657
  export type DevUserSummary = UserBaseSummary;
2425
2658
  /**
@@ -2437,6 +2670,41 @@ export interface DevUsersGetRequest {
2437
2670
  export interface DevUsersGetResponse {
2438
2671
  dev_user: DevUser;
2439
2672
  }
2673
+ /**
2674
+ * dev-users-identities-link-request
2675
+ * Request to link external identity to a Dev user.
2676
+ */
2677
+ export interface DevUsersIdentitiesLinkRequest {
2678
+ /** Display name of the Dev user in the external source. */
2679
+ display_name?: string;
2680
+ /** Unique ID of the Dev user in the external source. */
2681
+ id: string;
2682
+ /** Issuer of the external identity of the Dev user. */
2683
+ issuer: string;
2684
+ }
2685
+ /**
2686
+ * dev-users-identities-link-response
2687
+ * Response for the request to link an external identity to a Dev user.
2688
+ */
2689
+ export interface DevUsersIdentitiesLinkResponse {
2690
+ dev_user: DevUser;
2691
+ }
2692
+ /**
2693
+ * dev-users-identities-unlink-request
2694
+ * Request to unlink an external identity from a Dev user.
2695
+ */
2696
+ export interface DevUsersIdentitiesUnlinkRequest {
2697
+ /** Issuer that needs to be unlinked from a Dev user. */
2698
+ issuer: string;
2699
+ }
2700
+ /**
2701
+ * dev-users-identities-unlink-response
2702
+ * Response for the request to unlink an external identity from a Dev
2703
+ * user.
2704
+ */
2705
+ export interface DevUsersIdentitiesUnlinkResponse {
2706
+ dev_user: DevUser;
2707
+ }
2440
2708
  /**
2441
2709
  * dev-users-list-request
2442
2710
  * A request to get the list of Dev user's information.
@@ -2499,6 +2767,41 @@ export type DevUsersSelfRequest = object;
2499
2767
  export interface DevUsersSelfResponse {
2500
2768
  dev_user: DevUser;
2501
2769
  }
2770
+ /**
2771
+ * dev-users-self-update-request
2772
+ * A request to update the user's information for the authenticated Dev
2773
+ * user.
2774
+ */
2775
+ export interface DevUsersSelfUpdateRequest {
2776
+ /** The updated display name of the Dev user. */
2777
+ display_name?: string;
2778
+ /** The updated full name of the Dev user. */
2779
+ full_name?: string;
2780
+ /** Job title of the Dev User. */
2781
+ job_title?: DevUserJobTitle;
2782
+ }
2783
+ /**
2784
+ * dev-users-update-request
2785
+ * A request to update the user's information corresponding to the
2786
+ * provided Dev user.
2787
+ */
2788
+ export interface DevUsersUpdateRequest {
2789
+ /** The updated display name of the Dev user. */
2790
+ display_name?: string;
2791
+ /** The updated full name of the Dev user. */
2792
+ full_name?: string;
2793
+ /** The ID for the Dev user to be updated. */
2794
+ id: string;
2795
+ /** Job title of the Dev User. */
2796
+ job_title?: DevUserJobTitle;
2797
+ }
2798
+ /**
2799
+ * dev-users-update-response
2800
+ * The response to update a Dev user.
2801
+ */
2802
+ export interface DevUsersUpdateResponse {
2803
+ dev_user: DevUser;
2804
+ }
2502
2805
  /** directory-summary */
2503
2806
  export type DirectorySummary = AtomBaseSummary;
2504
2807
  /**
@@ -2776,6 +3079,24 @@ export interface EngagementsUpdateResponse {
2776
3079
  export type Enhancement = PartBase;
2777
3080
  /** enhancement-summary */
2778
3081
  export type EnhancementSummary = PartBaseSummary;
3082
+ /**
3083
+ * enum-value
3084
+ * Enum Value defines the structure for an enum.
3085
+ */
3086
+ export interface EnumValue {
3087
+ /**
3088
+ * Unique ID of the enum value. This is immutable.
3089
+ * @format int64
3090
+ */
3091
+ id: number;
3092
+ /** Display label of the enum value. This is mutable. */
3093
+ label: string;
3094
+ /**
3095
+ * Order number of the enum value. This is mutable.
3096
+ * @format int64
3097
+ */
3098
+ ordinal: number;
3099
+ }
2779
3100
  /** error */
2780
3101
  export interface Error {
2781
3102
  /** Information about the error. */
@@ -2789,9 +3110,16 @@ export interface Error {
2789
3110
  type?: string;
2790
3111
  }
2791
3112
  /** error-bad-request */
2792
- export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
3113
+ export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
2793
3114
  type: ErrorBadRequestType;
2794
3115
  };
3116
+ /** error-bad-request-artifact-already-attached-to-a-parent */
3117
+ export interface ErrorBadRequestArtifactAlreadyAttachedToAParent {
3118
+ /** The existing parent attached to the artifact. */
3119
+ existing_parent: string;
3120
+ /** Whether the existing parent is the same as the new parent. */
3121
+ is_same: boolean;
3122
+ }
2795
3123
  /** error-bad-request-bad-request */
2796
3124
  export type ErrorBadRequestBadRequest = object;
2797
3125
  /** error-bad-request-invalid-api-version */
@@ -2850,6 +3178,7 @@ export type ErrorBadRequestParseError = object;
2850
3178
  */
2851
3179
  export type ErrorBadRequestStaleSchemaFragments = object;
2852
3180
  export declare enum ErrorBadRequestType {
3181
+ ArtifactAlreadyAttachedToAParent = "artifact_already_attached_to_a_parent",
2853
3182
  BadRequest = "bad_request",
2854
3183
  InvalidApiVersion = "invalid_api_version",
2855
3184
  InvalidEnumValue = "invalid_enum_value",
@@ -3356,6 +3685,8 @@ export type GroupSearchSummary = SearchSummaryBase & {
3356
3685
  };
3357
3686
  /** group-summary */
3358
3687
  export type GroupSummary = AtomBaseSummary & {
3688
+ /** Type of the members in the group. */
3689
+ member_type?: GroupMemberType;
3359
3690
  /** Name of the group. */
3360
3691
  name?: string;
3361
3692
  };
@@ -3473,6 +3804,7 @@ export interface GroupsListResponse {
3473
3804
  export interface GroupsUpdateRequest {
3474
3805
  /** The updated group's description. */
3475
3806
  description?: string;
3807
+ dynamic_group_info?: GroupsUpdateRequestDynamicGroupInfo;
3476
3808
  /** The ID of the group to update. */
3477
3809
  id: string;
3478
3810
  /** The updated group's name. */
@@ -3480,6 +3812,11 @@ export interface GroupsUpdateRequest {
3480
3812
  /** The updated group's owner. */
3481
3813
  owner?: string;
3482
3814
  }
3815
+ /** groups-update-request-dynamic-group-info */
3816
+ export interface GroupsUpdateRequestDynamicGroupInfo {
3817
+ /** Boolean expression. */
3818
+ membership_expression: BooleanExpression;
3819
+ }
3483
3820
  /**
3484
3821
  * groups-update-response
3485
3822
  * The response to group update.
@@ -3493,6 +3830,8 @@ export type Issue = WorkBase & {
3493
3830
  developed_with?: PartSummary[];
3494
3831
  /** Priority of the work based upon impact and criticality. */
3495
3832
  priority?: IssuePriority;
3833
+ /** Vista group item. */
3834
+ sprint?: VistaGroupItemSummary;
3496
3835
  /**
3497
3836
  * Target start date for the object.
3498
3837
  * @format date-time
@@ -3512,6 +3851,32 @@ export type IssueSummary = WorkBaseSummary & {
3512
3851
  /** Priority of the work based upon impact and criticality. */
3513
3852
  priority?: IssuePriority;
3514
3853
  };
3854
+ /**
3855
+ * job-history-item
3856
+ * Defines a job history line item.
3857
+ */
3858
+ export interface JobHistoryItem {
3859
+ /** Enum Value defines the structure for an enum. */
3860
+ employment_status?: EnumValue;
3861
+ /**
3862
+ * The end date of the job, or not specified if current.
3863
+ * @format date-time
3864
+ * @example "2023-01-01T12:00:00.000Z"
3865
+ */
3866
+ end_date?: string;
3867
+ /** Is this the current active job for the user. */
3868
+ is_current?: boolean;
3869
+ /** The job location for the user. */
3870
+ location?: string;
3871
+ /**
3872
+ * The start date of the job.
3873
+ * @format date-time
3874
+ * @example "2023-01-01T12:00:00.000Z"
3875
+ */
3876
+ start_date?: string;
3877
+ /** The job title for the user. */
3878
+ title?: string;
3879
+ }
3515
3880
  /**
3516
3881
  * legacy-stage
3517
3882
  * Describes the current stage of a work item.
@@ -3578,20 +3943,33 @@ export declare enum LinkEndpointType {
3578
3943
  }
3579
3944
  /**
3580
3945
  * link-rev-user-to-rev-org-request
3581
- * A request to link a rev user to a rev org.
3946
+ * Request to link a Rev user to an existing Rev organization.
3582
3947
  */
3583
3948
  export interface LinkRevUserToRevOrgRequest {
3949
+ /** The ID of the Rev user. */
3950
+ id?: string;
3584
3951
  /**
3585
- * The don of the rev org to link the rev user to.
3952
+ * The ID of the Rev organization to link the Rev user to.
3586
3953
  * @example "REV-AbCdEfGh"
3587
3954
  */
3588
- rev_org_don: string;
3589
- /** The don of the rev user to link. */
3590
- user_don: string;
3955
+ rev_org?: string;
3956
+ /**
3957
+ * The don of the rev org to link the rev user to. This is deprecated,
3958
+ * use rev_org instead.
3959
+ * @deprecated
3960
+ * @example "REV-AbCdEfGh"
3961
+ */
3962
+ rev_org_don?: string;
3963
+ /**
3964
+ * The don of the rev user to link. This is deprecated, use id
3965
+ * instead.
3966
+ * @deprecated
3967
+ */
3968
+ user_don?: string;
3591
3969
  }
3592
3970
  /**
3593
3971
  * link-rev-user-to-rev-org-response
3594
- * The response to link a rev user to a rev org.
3972
+ * Response for linking a Rev user to an existing Rev organization.
3595
3973
  */
3596
3974
  export interface LinkRevUserToRevOrgResponse {
3597
3975
  rev_user: RevUser;
@@ -3810,6 +4188,7 @@ export type MetricDefinition = AtomBase & {
3810
4188
  /** The list of item types on which the metric might be applied. */
3811
4189
  export declare enum MetricDefinitionAppliesTo {
3812
4190
  Conversation = "conversation",
4191
+ Issue = "issue",
3813
4192
  Ticket = "ticket"
3814
4193
  }
3815
4194
  /**
@@ -3822,6 +4201,15 @@ export declare enum MetricDefinitionMetricType {
3822
4201
  Time = "time",
3823
4202
  Value = "value"
3824
4203
  }
4204
+ /**
4205
+ * The status of the metric. 'active' metrics can be used to create new
4206
+ * SLAs, while 'inactive' metrics can not be used in new SLAs. Metrics can
4207
+ * be updated between 'active' and 'inactive' states.
4208
+ */
4209
+ export declare enum MetricDefinitionStatus {
4210
+ Active = "active",
4211
+ Inactive = "inactive"
4212
+ }
3825
4213
  /** metric-definition-summary */
3826
4214
  export type MetricDefinitionSummary = AtomBaseSummary & {
3827
4215
  /** Human readable name of the metric. */
@@ -3854,6 +4242,8 @@ export interface MetricDefinitionsListRequest {
3854
4242
  * always be returned in the specified sort-by order.
3855
4243
  */
3856
4244
  mode?: ListMode;
4245
+ /** The status of the metric definition. */
4246
+ status?: MetricDefinitionStatus[];
3857
4247
  /** The type of metric definitions sought. */
3858
4248
  type?: MetricDefinitionMetricType[];
3859
4249
  }
@@ -4605,6 +4995,7 @@ export type QuestionAnswerSearchSummary = SearchSummaryBase & {
4605
4995
  /** Status of the question answer. */
4606
4996
  export declare enum QuestionAnswerStatus {
4607
4997
  Archived = "archived",
4998
+ Discarded = "discarded",
4608
4999
  Draft = "draft",
4609
5000
  Published = "published",
4610
5001
  ReviewNeeded = "review_needed"
@@ -5490,6 +5881,8 @@ export interface SchemaFieldDescriptorBase {
5490
5881
  mfz?: SchemaFieldMfzMetadata;
5491
5882
  /** Name of the field. */
5492
5883
  name: string;
5884
+ /** The schema of oasis specific fields. */
5885
+ oasis?: SchemaFieldOasisMetadata;
5493
5886
  /** Type this field is from. */
5494
5887
  origin?: string;
5495
5888
  /** The schema of ui specific fields. */
@@ -5540,6 +5933,11 @@ export interface SchemaFieldListViewUiMetadata {
5540
5933
  * The schema of MFZ specific fields.
5541
5934
  */
5542
5935
  export type SchemaFieldMfzMetadata = object;
5936
+ /**
5937
+ * schema-field-oasis-metadata
5938
+ * The schema of oasis specific fields.
5939
+ */
5940
+ export type SchemaFieldOasisMetadata = object;
5543
5941
  /**
5544
5942
  * schema-field-summary-view-ui-metadata
5545
5943
  * Summary view UI hint overrides.
@@ -5898,6 +6296,54 @@ export interface SearchCoreResponse {
5898
6296
  /** The search results. */
5899
6297
  results: SearchResult[];
5900
6298
  }
6299
+ /** The namespaces for hybrid search. */
6300
+ export declare enum SearchHybridNamespace {
6301
+ Article = "article",
6302
+ Conversation = "conversation",
6303
+ Issue = "issue",
6304
+ Part = "part",
6305
+ QuestionAnswer = "question_answer",
6306
+ Ticket = "ticket",
6307
+ Work = "work"
6308
+ }
6309
+ /**
6310
+ * search-hybrid-request
6311
+ * Request for search with exact, prefix and infix matches.
6312
+ */
6313
+ export interface SearchHybridRequest {
6314
+ /**
6315
+ * The maximum number of items to return in a page. The default is
6316
+ * '10'.
6317
+ * @format int32
6318
+ * @min 0
6319
+ * @max 50
6320
+ */
6321
+ limit?: number;
6322
+ /** The namespaces for hybrid search. */
6323
+ namespace: SearchHybridNamespace;
6324
+ /**
6325
+ * The query string.
6326
+ * @minLength 1
6327
+ * @maxLength 400
6328
+ */
6329
+ query: string;
6330
+ /**
6331
+ * The weightage for semantic search. Values between 0 and 1 are
6332
+ * accepted.
6333
+ * @format float
6334
+ * @min 0
6335
+ * @max 1
6336
+ */
6337
+ semantic_weight?: number;
6338
+ }
6339
+ /**
6340
+ * search-hybrid-response
6341
+ * Hybrid search response.
6342
+ */
6343
+ export interface SearchHybridResponse {
6344
+ /** The search results. */
6345
+ results: SearchResult[];
6346
+ }
5901
6347
  /** The namespaces to search in. */
5902
6348
  export declare enum SearchNamespace {
5903
6349
  Account = "account",
@@ -5993,6 +6439,36 @@ export interface ServiceAccountsGetRequest {
5993
6439
  export interface ServiceAccountsGetResponse {
5994
6440
  service_account: ServiceAccount;
5995
6441
  }
6442
+ /** set-issue-selector */
6443
+ export interface SetIssueSelector {
6444
+ /**
6445
+ * Custom fields on the issue with their fully qualified names and the
6446
+ * associated with their exact allowed values. The SLA policy applies
6447
+ * to issues where all named custom fields have exactly the specified
6448
+ * values.
6449
+ */
6450
+ custom_fields?: object;
6451
+ /**
6452
+ * The SLA policy applies to the issues of these parts.
6453
+ * @example ["PROD-12345"]
6454
+ */
6455
+ parts?: string[];
6456
+ /**
6457
+ * The SLA policy applies to the issues of these revorgs.
6458
+ * @example ["REV-AbCdEfGh"]
6459
+ */
6460
+ rev_orgs?: string[];
6461
+ /** The SLA policy applies to issues with these stages. */
6462
+ stage_name?: string[];
6463
+ /** The issue subtype for which the SLA policy applies. */
6464
+ subtype?: string[];
6465
+ /**
6466
+ * The SLA policy applies to issues with these tags. If empty, the tag
6467
+ * filter isn't applied.
6468
+ * @example ["TAG-12345"]
6469
+ */
6470
+ tags?: string[];
6471
+ }
5996
6472
  /** set-org-schedule-fragment-summary */
5997
6473
  export interface SetOrgScheduleFragmentSummary {
5998
6474
  /** Organization schedule fragment ID. */
@@ -6022,6 +6498,7 @@ export interface SetSlaSelector {
6022
6498
  * value is null, the field must have null value or not be present.
6023
6499
  */
6024
6500
  custom_fields?: object;
6501
+ issue_selector?: SetIssueSelector;
6025
6502
  /**
6026
6503
  * The SLA policy applies to the tickets of these parts.
6027
6504
  * @example ["PROD-12345"]
@@ -6126,6 +6603,8 @@ export type Sla = AtomBase & {
6126
6603
  * priority.
6127
6604
  */
6128
6605
  policies?: SlaPolicy[];
6606
+ /** Type of the SLA. */
6607
+ sla_type?: SlaType;
6129
6608
  /**
6130
6609
  * Status determines how an item can be used. In 'draft' status an item
6131
6610
  * can be edited but can't be used. When 'published' the item can longer
@@ -6133,6 +6612,16 @@ export type Sla = AtomBase & {
6133
6612
  */
6134
6613
  status: SlaStatus;
6135
6614
  };
6615
+ /**
6616
+ * The object types on which the SLA applies. An external SLA can apply to
6617
+ * multiple object types, but an internal SLA can apply to only one object
6618
+ * type.
6619
+ */
6620
+ export declare enum SlaAppliesTo {
6621
+ Conversation = "conversation",
6622
+ Issue = "issue",
6623
+ Ticket = "ticket"
6624
+ }
6136
6625
  /** sla-assign-result */
6137
6626
  export interface SlaAssignResult {
6138
6627
  error?: Error;
@@ -6168,9 +6657,10 @@ export type SlaPolicy = object;
6168
6657
  /** The item type for which the SLA policy applies. */
6169
6658
  export declare enum SlaSelectorAppliesTo {
6170
6659
  Conversation = "conversation",
6660
+ Issue = "issue",
6171
6661
  Ticket = "ticket"
6172
6662
  }
6173
- /** Th SLA policy applies to conversations with these priorities. */
6663
+ /** The SLA policy applies to conversations with these priorities. */
6174
6664
  export declare enum SlaSelectorPriority {
6175
6665
  P0 = "p0",
6176
6666
  P1 = "p1",
@@ -6257,6 +6747,11 @@ export interface SlaTrackersGetRequest {
6257
6747
  export interface SlaTrackersGetResponse {
6258
6748
  sla_tracker: SlaTracker;
6259
6749
  }
6750
+ /** Type of the SLA. */
6751
+ export declare enum SlaType {
6752
+ External = "external",
6753
+ Internal = "internal"
6754
+ }
6260
6755
  /** slas-assign-request */
6261
6756
  export interface SlasAssignRequest {
6262
6757
  /**
@@ -6279,6 +6774,8 @@ export interface SlasAssignResponse {
6279
6774
  /** slas-create-request */
6280
6775
  export interface SlasCreateRequest {
6281
6776
  account_selector?: AccountsFilters;
6777
+ /** The object types this SLA can apply to. */
6778
+ applies_to?: SlaAppliesTo[];
6282
6779
  /** Description of the purpose and capabilities of the SLA. */
6283
6780
  description?: string;
6284
6781
  /**
@@ -6297,11 +6794,17 @@ export interface SlasCreateRequest {
6297
6794
  * priority.
6298
6795
  */
6299
6796
  policies?: SetSlaPolicy[];
6797
+ /** Type of the SLA. */
6798
+ sla_type?: SlaType;
6300
6799
  }
6301
6800
  /** slas-create-response */
6302
6801
  export interface SlasCreateResponse {
6303
6802
  sla: Sla;
6304
6803
  }
6804
+ export declare enum SlasFilterAppliesToOperatorType {
6805
+ All = "all",
6806
+ Any = "any"
6807
+ }
6305
6808
  /** slas-get-request */
6306
6809
  export interface SlasGetRequest {
6307
6810
  /** The ID of the SLA to get. */
@@ -6313,6 +6816,9 @@ export interface SlasGetResponse {
6313
6816
  }
6314
6817
  /** slas-list-request */
6315
6818
  export interface SlasListRequest {
6819
+ /** The object types the SLA applies to. */
6820
+ applies_to?: SlaAppliesTo[];
6821
+ applies_to_op?: SlasFilterAppliesToOperatorType;
6316
6822
  /**
6317
6823
  * The cursor to resume iteration from. If not provided, then
6318
6824
  * iteration starts from the beginning.
@@ -6331,6 +6837,8 @@ export interface SlasListRequest {
6331
6837
  * always be returned in the specified sort-by order.
6332
6838
  */
6333
6839
  mode?: ListMode;
6840
+ /** The SLA types the filter matches. */
6841
+ sla_type?: SlaType[];
6334
6842
  /** The SLA statuses the filter matches. */
6335
6843
  status?: SlaStatus[];
6336
6844
  }
@@ -6404,17 +6912,14 @@ export interface SnapInsResourcesRequest {
6404
6912
  }
6405
6913
  /** snap-ins-resources-response */
6406
6914
  export interface SnapInsResourcesResponse {
6407
- event_sources?: SnapInsResourcesResponseEventSourcesEntry;
6915
+ /** The event sources for the snap-in. */
6916
+ event_sources?: Record<string, string>;
6408
6917
  /** The inputs for the snap-in. */
6409
6918
  inputs?: object;
6410
- keyrings?: SnapInsResourcesResponseKeyringsEntry;
6919
+ /** Map of keyring names and its data. */
6920
+ keyrings?: Record<string, SnapInsResourcesResponseKeyringData>;
6411
6921
  snap_in_version: SnapInVersionSummary;
6412
6922
  }
6413
- /** snap-ins-resources-response-event-sources-entry */
6414
- export interface SnapInsResourcesResponseEventSourcesEntry {
6415
- key: string;
6416
- value: string;
6417
- }
6418
6923
  /** snap-ins-resources-response-keyring-data */
6419
6924
  export interface SnapInsResourcesResponseKeyringData {
6420
6925
  /** The ID of the keyring. */
@@ -6422,11 +6927,6 @@ export interface SnapInsResourcesResponseKeyringData {
6422
6927
  /** The secret value of the keyring. This must be handled with caution. */
6423
6928
  secret: string;
6424
6929
  }
6425
- /** snap-ins-resources-response-keyrings-entry */
6426
- export interface SnapInsResourcesResponseKeyringsEntry {
6427
- key: string;
6428
- value: SnapInsResourcesResponseKeyringData;
6429
- }
6430
6930
  /** snap-widget */
6431
6931
  export type SnapWidget = EmailPreviewWidget & {
6432
6932
  type: SnapWidgetType;
@@ -6442,6 +6942,7 @@ export type SnapWidgetBase = AtomBase & {
6442
6942
  };
6443
6943
  /** Logical grouping of snap widgets. Useful for filtering. */
6444
6944
  export declare enum SnapWidgetNamespace {
6945
+ CommentSuggestionReplies = "comment_suggestion_replies",
6445
6946
  EmailPreview = "email_preview",
6446
6947
  LinkPreview = "link_preview",
6447
6948
  PlugNudge = "plug_nudge"
@@ -6497,6 +6998,14 @@ export interface StageUpdate {
6497
6998
  /** The updated name of the stage, otherwise unchanged if not set. */
6498
6999
  name?: string;
6499
7000
  }
7001
+ /** Type of stage validation options when creating an object. */
7002
+ export declare enum StageValidationOptionForCreate {
7003
+ AllowNonStart = "allow_non_start"
7004
+ }
7005
+ /** Type of state validation options when updating the stage of an object. */
7006
+ export declare enum StageValidationOptionForUpdate {
7007
+ AllowInvalidTransition = "allow_invalid_transition"
7008
+ }
6500
7009
  /** staged-info-filter */
6501
7010
  export interface StagedInfoFilter {
6502
7011
  /** Filters for issues that are staged. */
@@ -6634,6 +7143,7 @@ export type SurveyResponse = AtomBase & {
6634
7143
  dispatch_id?: string;
6635
7144
  /** The ID of the object for which survey is taken. */
6636
7145
  object?: string;
7146
+ recipient?: UserSummary;
6637
7147
  /** Response for the survey. */
6638
7148
  response?: object;
6639
7149
  /** The ID of the survey for which response is taken. */
@@ -6749,6 +7259,8 @@ export interface SurveysResponsesListRequest {
6749
7259
  * them.
6750
7260
  */
6751
7261
  sort_by?: string[];
7262
+ /** Filters for survey response stages. */
7263
+ stages?: number[];
6752
7264
  /** Filters for survey responses for the provided survey IDs. */
6753
7265
  surveys?: string[];
6754
7266
  }
@@ -6788,14 +7300,21 @@ export type SurveysSendResponse = object;
6788
7300
  export interface SurveysSubmitRequest {
6789
7301
  /** The unique ID associated with the dispatched survey. */
6790
7302
  dispatch_id?: string;
7303
+ /** The ordinals of the source channels on which the survey is sent. */
7304
+ dispatched_channels?: number[];
6791
7305
  /**
6792
7306
  * The ID of the object this survey is on (e.g. ticket, conversation,
6793
7307
  * etc).
6794
7308
  * @example "ACC-12345"
6795
7309
  */
6796
7310
  object: string;
7311
+ /**
7312
+ * The unique ID associated with the recipient of the survey.
7313
+ * @example "DEVU-12345"
7314
+ */
7315
+ recipient?: string;
6797
7316
  /** Survey response submitted for the object. */
6798
- response: object;
7317
+ response?: object;
6799
7318
  /**
6800
7319
  * The response score for the survey. Only applicable for CSAT and
6801
7320
  * NPS.
@@ -6804,6 +7323,11 @@ export interface SurveysSubmitRequest {
6804
7323
  response_score?: number;
6805
7324
  /** The source channel from which survey response is submitted. */
6806
7325
  source_channel?: string;
7326
+ /**
7327
+ * The stage ordinal of the survey response object.
7328
+ * @format int64
7329
+ */
7330
+ stage?: number;
6807
7331
  /** The ID of the survey to submit the response to. */
6808
7332
  survey: string;
6809
7333
  }
@@ -7137,7 +7661,8 @@ export type Ticket = WorkBase & {
7137
7661
  export declare enum TicketChannels {
7138
7662
  Email = "email",
7139
7663
  Plug = "plug",
7140
- Slack = "slack"
7664
+ Slack = "slack",
7665
+ Twilio = "twilio"
7141
7666
  }
7142
7667
  /** Severity of the ticket. */
7143
7668
  export declare enum TicketSeverity {
@@ -7240,6 +7765,11 @@ export interface TimelineEntriesCreateRequestTimelineComment {
7240
7765
  body?: string;
7241
7766
  /** The type of the body to use for the comment. */
7242
7767
  body_type?: TimelineCommentBodyType;
7768
+ /**
7769
+ * The external reference for the comment. This must be unique within
7770
+ * the object's timeline.
7771
+ */
7772
+ external_ref?: string;
7243
7773
  /**
7244
7774
  * The IDs of the previews of the links posted in the comment.
7245
7775
  * @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
@@ -7284,6 +7814,11 @@ export type TimelineEntriesDeleteResponse = object;
7284
7814
  * The request to get a timeline entry.
7285
7815
  */
7286
7816
  export interface TimelineEntriesGetRequest {
7817
+ /**
7818
+ * If set, then gets the entry with the given external reference for
7819
+ * the provided entry ID's timeline.
7820
+ */
7821
+ external_ref?: string;
7287
7822
  /**
7288
7823
  * The ID of the timeline entry to get.
7289
7824
  * @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
@@ -7449,6 +7984,11 @@ export type TimelineEntry = TimelineComment & {
7449
7984
  };
7450
7985
  /** timeline-entry-base */
7451
7986
  export type TimelineEntryBase = AtomBase & {
7987
+ /**
7988
+ * An external reference that's associated with the Timeline entry
7989
+ * that's guaranteed to be unique among its siblings.
7990
+ */
7991
+ external_ref?: string;
7452
7992
  /** Labels that are associated with the Timeline entry. */
7453
7993
  labels?: string[];
7454
7994
  /** The object that the Timeline entry belongs to. */
@@ -7600,20 +8140,33 @@ export declare enum UnitType {
7600
8140
  }
7601
8141
  /**
7602
8142
  * unlink-rev-user-from-rev-org-request
7603
- * A request to unlink a rev user from a rev org.
8143
+ * Request to unlink/remove a Rev user from a Rev organization.
7604
8144
  */
7605
8145
  export interface UnlinkRevUserFromRevOrgRequest {
8146
+ /** The ID of the Rev user. */
8147
+ id?: string;
8148
+ /**
8149
+ * The ID of the Rev organization to unlink the Rev user from.
8150
+ * @example "REV-AbCdEfGh"
8151
+ */
8152
+ rev_org?: string;
7606
8153
  /**
7607
- * The don of the rev org to unlink the rev user from.
8154
+ * The don of the rev org to unlink the rev user from. This is
8155
+ * deprecated, use rev_org instead.
8156
+ * @deprecated
7608
8157
  * @example "REV-AbCdEfGh"
7609
8158
  */
7610
- rev_org_don: string;
7611
- /** The don of the rev user to unlink. */
7612
- user_don: string;
8159
+ rev_org_don?: string;
8160
+ /**
8161
+ * The don of the rev user to unlink. This is deprecated, use id
8162
+ * instead.
8163
+ * @deprecated
8164
+ */
8165
+ user_don?: string;
7613
8166
  }
7614
8167
  /**
7615
8168
  * unlink-rev-user-from-rev-org-response
7616
- * The response to unlink a rev user from a rev org.
8169
+ * Response for unlinking/removing a Rev user from a Rev organization.
7617
8170
  */
7618
8171
  export interface UnlinkRevUserFromRevOrgResponse {
7619
8172
  rev_user: RevUser;
@@ -7924,6 +8477,14 @@ export type UserBaseSummary = AtomBaseSummary & {
7924
8477
  export type UserSearchSummary = SearchSummaryBase & {
7925
8478
  user: UserSummary;
7926
8479
  };
8480
+ /**
8481
+ * user-skill
8482
+ * Skill associated with the user.
8483
+ */
8484
+ export interface UserSkill {
8485
+ /** Name of the skill. */
8486
+ name?: string;
8487
+ }
7927
8488
  /** State of the user. */
7928
8489
  export declare enum UserState {
7929
8490
  Active = "active",
@@ -7948,6 +8509,11 @@ export type VistaBaseSummary = AtomBaseSummary & {
7948
8509
  /** Name of the vista. */
7949
8510
  name: string;
7950
8511
  };
8512
+ /**
8513
+ * vista-group-item-summary
8514
+ * Vista group item.
8515
+ */
8516
+ export type VistaGroupItemSummary = object;
7951
8517
  /** vista-search-summary */
7952
8518
  export type VistaSearchSummary = SearchSummaryBase & {
7953
8519
  /** Represents a collection of DevRev objects. */
@@ -8348,6 +8914,8 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
8348
8914
  reported_by?: string[];
8349
8915
  /** Sets an object's initial stage. */
8350
8916
  stage?: StageInit;
8917
+ /** The type of stage validations options when creating a work item. */
8918
+ stage_validation_options?: StageValidationOptionForCreate[];
8351
8919
  /** Tags associated with the work item. */
8352
8920
  tags?: SetTagWithValue[];
8353
8921
  /**
@@ -8434,6 +9002,8 @@ export interface WorksCreateRequestTicket {
8434
9002
  group?: string;
8435
9003
  /** Whether the ticket is spam. */
8436
9004
  is_spam?: boolean;
9005
+ /** Whether the ticket needs a response. */
9006
+ needs_response?: boolean;
8437
9007
  /**
8438
9008
  * The Rev organization that the ticket is associated with.
8439
9009
  * @example "REV-AbCdEfGh"
@@ -8536,6 +9106,8 @@ export interface WorksFilterIssue {
8536
9106
  * @example ["REV-AbCdEfGh"]
8537
9107
  */
8538
9108
  rev_orgs?: string[];
9109
+ /** Filters for issues with any of the sprint. */
9110
+ sprint?: string[];
8539
9111
  /** Filters for issues with any of the provided subtypes. */
8540
9112
  subtype?: string[];
8541
9113
  /** Provides ways to specify date ranges on objects. */
@@ -8709,6 +9281,11 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
8709
9281
  reported_by?: WorksUpdateRequestReportedBy;
8710
9282
  /** Updates an object's stage. */
8711
9283
  stage?: StageUpdate;
9284
+ /**
9285
+ * The type of stage validations options when updating the stage of an
9286
+ * object.
9287
+ */
9288
+ stage_validation_options?: StageValidationOptionForUpdate[];
8712
9289
  staged_info?: WorksUpdateRequestStagedInfoStagedInfoUpdate;
8713
9290
  tags?: WorksUpdateRequestTags;
8714
9291
  /**
@@ -8847,6 +9424,8 @@ export interface WorksUpdateRequestTicket {
8847
9424
  group?: string | null;
8848
9425
  /** Updates whether the ticket is spam. */
8849
9426
  is_spam?: boolean;
9427
+ /** Updates whether the ticket needs a response. */
9428
+ needs_response?: boolean;
8850
9429
  /**
8851
9430
  * Updates the Rev organization that the ticket is associated with.
8852
9431
  * @example "REV-AbCdEfGh"
@@ -9122,6 +9701,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9122
9701
  * @secure
9123
9702
  */
9124
9703
  articlesCount: (query?: {
9704
+ /** The ancestor directory of the articles. */
9705
+ ancestor?: string;
9125
9706
  /**
9126
9707
  * Filters for articles belonging to any of the provided parts.
9127
9708
  * @example ["PROD-12345"]
@@ -9137,6 +9718,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9137
9718
  * @example ["DEVU-12345"]
9138
9719
  */
9139
9720
  created_by?: string[];
9721
+ /**
9722
+ * Filters for articles modified by any of the provided users.
9723
+ * @example ["DEVU-12345"]
9724
+ */
9725
+ modified_by?: string[];
9140
9726
  /**
9141
9727
  * Filters for articles owned by any of the provided users.
9142
9728
  * @example ["DEVU-12345"]
@@ -9233,6 +9819,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9233
9819
  * used.
9234
9820
  */
9235
9821
  mode?: ListMode;
9822
+ /**
9823
+ * Filters for articles modified by any of the provided users.
9824
+ * @example ["DEVU-12345"]
9825
+ */
9826
+ modified_by?: string[];
9236
9827
  /**
9237
9828
  * Filters for articles owned by any of the provided users.
9238
9829
  * @example ["DEVU-12345"]
@@ -9824,6 +10415,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9824
10415
  * @secure
9825
10416
  */
9826
10417
  devUsersGetPost: (data: DevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any>>;
10418
+ /**
10419
+ * @description Links an external/secondary identity to the Dev user.
10420
+ *
10421
+ * @tags dev-users
10422
+ * @name DevUsersIdentitiesLink
10423
+ * @request POST:/dev-users.identities.link
10424
+ * @secure
10425
+ */
10426
+ devUsersIdentitiesLink: (data: DevUsersIdentitiesLinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesLinkResponse, any>>;
10427
+ /**
10428
+ * @description Unlinks an external/secondary identity from the Dev user.
10429
+ *
10430
+ * @tags dev-users
10431
+ * @name DevUsersIdentitiesUnlink
10432
+ * @request POST:/dev-users.identities.unlink
10433
+ * @secure
10434
+ */
10435
+ devUsersIdentitiesUnlink: (data: DevUsersIdentitiesUnlinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesUnlinkResponse, any>>;
9827
10436
  /**
9828
10437
  * @description Lists users within your organization.
9829
10438
  *
@@ -9886,6 +10495,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9886
10495
  * @secure
9887
10496
  */
9888
10497
  devUsersSelfPost: (data: DevUsersSelfRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any>>;
10498
+ /**
10499
+ * @description Updates the authenticated user.
10500
+ *
10501
+ * @tags dev-users
10502
+ * @name DevUsersSelfUpdate
10503
+ * @request POST:/dev-users.self.update
10504
+ * @secure
10505
+ */
10506
+ devUsersSelfUpdate: (data: DevUsersSelfUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any>>;
10507
+ /**
10508
+ * @description Updates the user corresponding to the input Id.
10509
+ *
10510
+ * @tags dev-users
10511
+ * @name DevUsersUpdate
10512
+ * @request POST:/dev-users.update
10513
+ * @secure
10514
+ */
10515
+ devUsersUpdate: (data: DevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any>>;
9889
10516
  /**
9890
10517
  * @description Counts the engagement records.
9891
10518
  *
@@ -10313,6 +10940,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
10313
10940
  * used.
10314
10941
  */
10315
10942
  mode?: ListMode;
10943
+ /** The status of the metric definition. */
10944
+ status?: MetricDefinitionStatus[];
10316
10945
  /** The type of metric definitions sought. */
10317
10946
  type?: MetricDefinitionMetricType[];
10318
10947
  }, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
@@ -11223,6 +11852,48 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11223
11852
  * @secure
11224
11853
  */
11225
11854
  searchCorePost: (data: SearchCoreRequest, params?: RequestParams) => Promise<AxiosResponse<SearchCoreResponse, any>>;
11855
+ /**
11856
+ * @description Performs search, using a combination of syntactic and semantic search.
11857
+ *
11858
+ * @tags search
11859
+ * @name SearchHybrid
11860
+ * @request GET:/search.hybrid
11861
+ * @secure
11862
+ */
11863
+ searchHybrid: (query: {
11864
+ /** The hybrid namespace to search in. */
11865
+ namespace: SearchHybridNamespace;
11866
+ /**
11867
+ * The query string.
11868
+ * @minLength 1
11869
+ * @maxLength 400
11870
+ */
11871
+ query: string;
11872
+ /**
11873
+ * The maximum number of items to return in a page. The default is '10'.
11874
+ * @format int32
11875
+ * @min 0
11876
+ * @max 50
11877
+ */
11878
+ limit?: number | undefined;
11879
+ /**
11880
+ * The weightage for semantic search. Values between 0 and 1 are
11881
+ * accepted.
11882
+ * @format float
11883
+ * @min 0
11884
+ * @max 1
11885
+ */
11886
+ semantic_weight?: number | undefined;
11887
+ }, params?: RequestParams) => Promise<AxiosResponse<SearchHybridResponse, any>>;
11888
+ /**
11889
+ * @description Performs search, using a combination of syntactic and semantic search.
11890
+ *
11891
+ * @tags search
11892
+ * @name SearchHybridPost
11893
+ * @request POST:/search.hybrid
11894
+ * @secure
11895
+ */
11896
+ searchHybridPost: (data: SearchHybridRequest, params?: RequestParams) => Promise<AxiosResponse<SearchHybridResponse, any>>;
11226
11897
  /**
11227
11898
  * @description Gets a service account.
11228
11899
  *
@@ -11313,6 +11984,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11313
11984
  * @secure
11314
11985
  */
11315
11986
  slasList: (query?: {
11987
+ /** The object types the SLA applies to. */
11988
+ applies_to?: SlaAppliesTo[];
11989
+ /**
11990
+ * The Filter operator to be applied on the applies to object types
11991
+ * filter.
11992
+ */
11993
+ applies_to_op?: SlasFilterAppliesToOperatorType;
11316
11994
  /**
11317
11995
  * The cursor to resume iteration from. If not provided, then iteration
11318
11996
  * starts from the beginning.
@@ -11328,6 +12006,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11328
12006
  * used.
11329
12007
  */
11330
12008
  mode?: ListMode;
12009
+ /** The SLA types the filter matches. */
12010
+ sla_type?: SlaType[];
11331
12011
  /** The SLA statuses the filter matches. */
11332
12012
  status?: SlaStatus[];
11333
12013
  }, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any>>;
@@ -11390,6 +12070,156 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11390
12070
  * @secure
11391
12071
  */
11392
12072
  snapWidgetsCreate: (data: SnapWidgetsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapWidgetsCreateResponse, any>>;
12073
+ /**
12074
+ * @description Creates a custom stage.
12075
+ *
12076
+ * @tags customization
12077
+ * @name CustomStagesCreate
12078
+ * @request POST:/stages.custom.create
12079
+ * @secure
12080
+ */
12081
+ customStagesCreate: (data: CustomStagesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesCreateResponse, any>>;
12082
+ /**
12083
+ * @description Gets a custom stage.
12084
+ *
12085
+ * @tags customization
12086
+ * @name CustomStagesGet
12087
+ * @request GET:/stages.custom.get
12088
+ * @secure
12089
+ */
12090
+ customStagesGet: (query: {
12091
+ /** The ID of the custom stage to get. */
12092
+ id: string;
12093
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any>>;
12094
+ /**
12095
+ * @description Gets a custom stage.
12096
+ *
12097
+ * @tags customization
12098
+ * @name CustomStagesGetPost
12099
+ * @request POST:/stages.custom.get
12100
+ * @secure
12101
+ */
12102
+ customStagesGetPost: (data: CustomStagesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any>>;
12103
+ /**
12104
+ * @description Lists custom stages.
12105
+ *
12106
+ * @tags customization
12107
+ * @name CustomStagesList
12108
+ * @request GET:/stages.custom.list
12109
+ * @secure
12110
+ */
12111
+ customStagesList: (query?: {
12112
+ /**
12113
+ * The cursor to resume iteration from, otherwise if not provided, then
12114
+ * iteration starts from the beginning.
12115
+ */
12116
+ cursor?: string;
12117
+ /**
12118
+ * The maximum number of items.
12119
+ * @format int32
12120
+ */
12121
+ limit?: number;
12122
+ /** The list of stage names. */
12123
+ name?: string[];
12124
+ /** The list of stage ordinals. */
12125
+ ordinal?: number[];
12126
+ /** The list of fields to sort the items by and how to sort them. */
12127
+ sort_by?: string[];
12128
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any>>;
12129
+ /**
12130
+ * @description Lists custom stages.
12131
+ *
12132
+ * @tags customization
12133
+ * @name CustomStagesListPost
12134
+ * @request POST:/stages.custom.list
12135
+ * @secure
12136
+ */
12137
+ customStagesListPost: (data: CustomStagesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any>>;
12138
+ /**
12139
+ * @description Updates a custom stage.
12140
+ *
12141
+ * @tags customization
12142
+ * @name CustomStagesUpdate
12143
+ * @request POST:/stages.custom.update
12144
+ * @secure
12145
+ */
12146
+ customStagesUpdate: (data: CustomStagesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesUpdateResponse, any>>;
12147
+ /**
12148
+ * @description Creates a custom state.
12149
+ *
12150
+ * @tags customization
12151
+ * @name CustomStatesCreate
12152
+ * @request POST:/states.custom.create
12153
+ * @secure
12154
+ */
12155
+ customStatesCreate: (data: CustomStatesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesCreateResponse, any>>;
12156
+ /**
12157
+ * @description Gets a custom state.
12158
+ *
12159
+ * @tags customization
12160
+ * @name CustomStatesGet
12161
+ * @request GET:/states.custom.get
12162
+ * @secure
12163
+ */
12164
+ customStatesGet: (query: {
12165
+ /** The ID of the custom state to get. */
12166
+ id: string;
12167
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any>>;
12168
+ /**
12169
+ * @description Gets a custom state.
12170
+ *
12171
+ * @tags customization
12172
+ * @name CustomStatesGetPost
12173
+ * @request POST:/states.custom.get
12174
+ * @secure
12175
+ */
12176
+ customStatesGetPost: (data: CustomStatesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any>>;
12177
+ /**
12178
+ * @description Lists custom states.
12179
+ *
12180
+ * @tags customization
12181
+ * @name CustomStatesList
12182
+ * @request GET:/states.custom.list
12183
+ * @secure
12184
+ */
12185
+ customStatesList: (query?: {
12186
+ /**
12187
+ * The cursor to resume iteration from, otherwise if not provided, then
12188
+ * iteration starts from the beginning.
12189
+ */
12190
+ cursor?: string;
12191
+ /** Whether only final states should be filtered. */
12192
+ is_final?: boolean;
12193
+ /**
12194
+ * The maximum number of items.
12195
+ * @format int32
12196
+ */
12197
+ limit?: number;
12198
+ /** The list of state names. */
12199
+ name?: string[];
12200
+ /** The list of state ordinals. */
12201
+ ordinal?: number[];
12202
+ /** The list of fields to sort the items by and how to sort them. */
12203
+ sort_by?: string[];
12204
+ }, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any>>;
12205
+ /**
12206
+ * @description Lists custom states.
12207
+ *
12208
+ * @tags customization
12209
+ * @name CustomStatesListPost
12210
+ * @request POST:/states.custom.list
12211
+ * @secure
12212
+ */
12213
+ customStatesListPost: (data: CustomStatesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any>>;
12214
+ /**
12215
+ * @description Updates a custom state.
12216
+ *
12217
+ * @tags customization
12218
+ * @name CustomStatesUpdate
12219
+ * @request POST:/states.custom.update
12220
+ * @secure
12221
+ */
12222
+ customStatesUpdate: (data: CustomStatesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesUpdateResponse, any>>;
11393
12223
  /**
11394
12224
  * @description Creates a schema for survey, which includes name and description of schema.
11395
12225
  *
@@ -11492,6 +12322,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11492
12322
  * them.
11493
12323
  */
11494
12324
  sort_by?: string[];
12325
+ /** Filters for survey response stages. */
12326
+ stages?: number[];
11495
12327
  /** Filters for survey responses for the provided survey IDs. */
11496
12328
  surveys?: string[];
11497
12329
  }, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any>>;
@@ -11689,6 +12521,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
11689
12521
  * @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
11690
12522
  */
11691
12523
  id: string;
12524
+ /**
12525
+ * If set, then gets the entry with the given external reference for the
12526
+ * provided entry ID's timeline.
12527
+ */
12528
+ external_ref?: string;
11692
12529
  }, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any>>;
11693
12530
  /**
11694
12531
  * @description Gets an entry on an object's timeline.
@@ -12052,6 +12889,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12052
12889
  * @example ["REV-AbCdEfGh"]
12053
12890
  */
12054
12891
  'issue.rev_orgs'?: string[];
12892
+ /** Filters for issues with any of the sprint. */
12893
+ 'issue.sprint'?: string[];
12055
12894
  /** Filters for issues with any of the provided subtypes. */
12056
12895
  'issue.subtype'?: string[];
12057
12896
  /**
@@ -12192,6 +13031,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
12192
13031
  * @example ["REV-AbCdEfGh"]
12193
13032
  */
12194
13033
  'issue.rev_orgs'?: string[];
13034
+ /** Filters for issues with any of the sprint. */
13035
+ 'issue.sprint'?: string[];
12195
13036
  /** Filters for issues with any of the provided subtypes. */
12196
13037
  'issue.subtype'?: string[];
12197
13038
  /**