@devrev/typescript-sdk 1.1.24 → 1.1.25
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"]
|
|
@@ -1127,6 +1129,7 @@ export declare enum AuthTokenRequestedTokenType {
|
|
|
1127
1129
|
UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
|
|
1128
1130
|
UrnDevrevParamsOauthTokenTypeSessionDev0 = "urn:devrev:params:oauth:token-type:session:dev0",
|
|
1129
1131
|
UrnDevrevParamsOauthTokenTypeSessionOnetime = "urn:devrev:params:oauth:token-type:session:onetime",
|
|
1132
|
+
UrnDevrevParamsOauthTokenTypeSessionRevActAs = "urn:devrev:params:oauth:token-type:session:rev:act-as",
|
|
1130
1133
|
UrnDevrevParamsOauthTokenTypeSuper = "urn:devrev:params:oauth:token-type:super",
|
|
1131
1134
|
UrnDevrevParamsOauthTokenTypeSys = "urn:devrev:params:oauth:token-type:sys",
|
|
1132
1135
|
UrnIetfParamsOauthTokenTypeJwt = "urn:ietf:params:oauth:token-type:jwt"
|
|
@@ -1374,6 +1377,46 @@ export interface AuthTokensUserTraits {
|
|
|
1374
1377
|
/** Phone numbers of the Rev user. */
|
|
1375
1378
|
phone_numbers?: string[];
|
|
1376
1379
|
}
|
|
1380
|
+
/**
|
|
1381
|
+
* boolean-expression
|
|
1382
|
+
* Boolean expression.
|
|
1383
|
+
*/
|
|
1384
|
+
export type BooleanExpression = (BooleanExpressionAndExpression | BooleanExpressionNotExpression | BooleanExpressionOrExpression | BooleanExpressionPrimitiveExpression) & {
|
|
1385
|
+
type: BooleanExpressionType;
|
|
1386
|
+
};
|
|
1387
|
+
/**
|
|
1388
|
+
* boolean-expression-and-expression
|
|
1389
|
+
* All the expressions would be 'and'ed together.
|
|
1390
|
+
*/
|
|
1391
|
+
export interface BooleanExpressionAndExpression {
|
|
1392
|
+
expressions: BooleanExpression[];
|
|
1393
|
+
}
|
|
1394
|
+
/**
|
|
1395
|
+
* boolean-expression-not-expression
|
|
1396
|
+
* The expression would be negated.
|
|
1397
|
+
*/
|
|
1398
|
+
export interface BooleanExpressionNotExpression {
|
|
1399
|
+
/** Boolean expression. */
|
|
1400
|
+
expression: BooleanExpression;
|
|
1401
|
+
}
|
|
1402
|
+
/**
|
|
1403
|
+
* boolean-expression-or-expression
|
|
1404
|
+
* All the expressions would be 'or'ed together.
|
|
1405
|
+
*/
|
|
1406
|
+
export interface BooleanExpressionOrExpression {
|
|
1407
|
+
expressions: BooleanExpression[];
|
|
1408
|
+
}
|
|
1409
|
+
/**
|
|
1410
|
+
* boolean-expression-primitive-expression
|
|
1411
|
+
* The primitive expression type.
|
|
1412
|
+
*/
|
|
1413
|
+
export type BooleanExpressionPrimitiveExpression = object;
|
|
1414
|
+
export declare enum BooleanExpressionType {
|
|
1415
|
+
And = "and",
|
|
1416
|
+
Not = "not",
|
|
1417
|
+
Or = "or",
|
|
1418
|
+
Primitive = "primitive"
|
|
1419
|
+
}
|
|
1377
1420
|
/** capability */
|
|
1378
1421
|
export type Capability = PartBase;
|
|
1379
1422
|
/** capability-summary */
|
|
@@ -2182,6 +2225,161 @@ export interface CustomSchemaSpec {
|
|
|
2182
2225
|
/** Whether to enforce required fields validation. */
|
|
2183
2226
|
validate_required_fields?: boolean;
|
|
2184
2227
|
}
|
|
2228
|
+
/** custom-stage */
|
|
2229
|
+
export type CustomStage = AtomBase;
|
|
2230
|
+
/** custom-stages-create-request */
|
|
2231
|
+
export interface CustomStagesCreateRequest {
|
|
2232
|
+
/**
|
|
2233
|
+
* A reference to the marketplace item from which this stage was
|
|
2234
|
+
* imported.
|
|
2235
|
+
*/
|
|
2236
|
+
marketplace_ref?: string;
|
|
2237
|
+
/** The name of the custom stage. */
|
|
2238
|
+
name: string;
|
|
2239
|
+
/**
|
|
2240
|
+
* The ordinal of the custom stage used for ordering.
|
|
2241
|
+
* @format int32
|
|
2242
|
+
*/
|
|
2243
|
+
ordinal: number;
|
|
2244
|
+
/** The state ID. */
|
|
2245
|
+
state: string;
|
|
2246
|
+
}
|
|
2247
|
+
/** custom-stages-create-response */
|
|
2248
|
+
export interface CustomStagesCreateResponse {
|
|
2249
|
+
custom_stage: CustomStage;
|
|
2250
|
+
}
|
|
2251
|
+
/** custom-stages-get-request */
|
|
2252
|
+
export interface CustomStagesGetRequest {
|
|
2253
|
+
/** The ID of the custom stage to get. */
|
|
2254
|
+
id: string;
|
|
2255
|
+
}
|
|
2256
|
+
/** custom-stages-get-response */
|
|
2257
|
+
export interface CustomStagesGetResponse {
|
|
2258
|
+
custom_stage: CustomStage;
|
|
2259
|
+
}
|
|
2260
|
+
/** custom-stages-list-request */
|
|
2261
|
+
export interface CustomStagesListRequest {
|
|
2262
|
+
/**
|
|
2263
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
2264
|
+
* then iteration starts from the beginning.
|
|
2265
|
+
*/
|
|
2266
|
+
cursor?: string;
|
|
2267
|
+
/**
|
|
2268
|
+
* The maximum number of items.
|
|
2269
|
+
* @format int32
|
|
2270
|
+
*/
|
|
2271
|
+
limit?: number;
|
|
2272
|
+
/** The list of stage names. */
|
|
2273
|
+
name?: string[];
|
|
2274
|
+
/** The list of stage ordinals. */
|
|
2275
|
+
ordinal?: number[];
|
|
2276
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
2277
|
+
sort_by?: string[];
|
|
2278
|
+
}
|
|
2279
|
+
/** custom-stages-list-response */
|
|
2280
|
+
export interface CustomStagesListResponse {
|
|
2281
|
+
/**
|
|
2282
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
2283
|
+
* then iteration starts from the beginning.
|
|
2284
|
+
*/
|
|
2285
|
+
cursor?: string;
|
|
2286
|
+
/** The custom stages. */
|
|
2287
|
+
result: CustomStage[];
|
|
2288
|
+
}
|
|
2289
|
+
/** custom-stages-update-request */
|
|
2290
|
+
export interface CustomStagesUpdateRequest {
|
|
2291
|
+
/** The ID of the custom stage to update. */
|
|
2292
|
+
id: string;
|
|
2293
|
+
/** The updated name of the custom stage. */
|
|
2294
|
+
name?: string;
|
|
2295
|
+
/**
|
|
2296
|
+
* The ordinal of the custom stage.
|
|
2297
|
+
* @format int32
|
|
2298
|
+
*/
|
|
2299
|
+
ordinal?: number;
|
|
2300
|
+
/** The state ID. */
|
|
2301
|
+
state_id?: string;
|
|
2302
|
+
}
|
|
2303
|
+
/** custom-stages-update-response */
|
|
2304
|
+
export interface CustomStagesUpdateResponse {
|
|
2305
|
+
custom_stage: CustomStage;
|
|
2306
|
+
}
|
|
2307
|
+
/** custom-state */
|
|
2308
|
+
export type CustomState = AtomBase;
|
|
2309
|
+
/** custom-states-create-request */
|
|
2310
|
+
export interface CustomStatesCreateRequest {
|
|
2311
|
+
/** Whether this is a final state. */
|
|
2312
|
+
is_final?: boolean;
|
|
2313
|
+
/** The name of the custom state. */
|
|
2314
|
+
name: string;
|
|
2315
|
+
/**
|
|
2316
|
+
* Ordinal of the custom state used to identify system states.
|
|
2317
|
+
* @format int32
|
|
2318
|
+
*/
|
|
2319
|
+
ordinal: number;
|
|
2320
|
+
}
|
|
2321
|
+
/** custom-states-create-response */
|
|
2322
|
+
export interface CustomStatesCreateResponse {
|
|
2323
|
+
custom_state: CustomState;
|
|
2324
|
+
}
|
|
2325
|
+
/** custom-states-get-request */
|
|
2326
|
+
export interface CustomStatesGetRequest {
|
|
2327
|
+
/** The ID of the custom state to get. */
|
|
2328
|
+
id: string;
|
|
2329
|
+
}
|
|
2330
|
+
/** custom-states-get-response */
|
|
2331
|
+
export interface CustomStatesGetResponse {
|
|
2332
|
+
custom_state: CustomState;
|
|
2333
|
+
}
|
|
2334
|
+
/** custom-states-list-request */
|
|
2335
|
+
export interface CustomStatesListRequest {
|
|
2336
|
+
/**
|
|
2337
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
2338
|
+
* then iteration starts from the beginning.
|
|
2339
|
+
*/
|
|
2340
|
+
cursor?: string;
|
|
2341
|
+
/** Whether only final states should be filtered. */
|
|
2342
|
+
is_final?: boolean;
|
|
2343
|
+
/**
|
|
2344
|
+
* The maximum number of items.
|
|
2345
|
+
* @format int32
|
|
2346
|
+
*/
|
|
2347
|
+
limit?: number;
|
|
2348
|
+
/** The list of state names. */
|
|
2349
|
+
name?: string[];
|
|
2350
|
+
/** The list of state ordinals. */
|
|
2351
|
+
ordinal?: number[];
|
|
2352
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
2353
|
+
sort_by?: string[];
|
|
2354
|
+
}
|
|
2355
|
+
/** custom-states-list-response */
|
|
2356
|
+
export interface CustomStatesListResponse {
|
|
2357
|
+
/**
|
|
2358
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
2359
|
+
* then iteration starts from the beginning.
|
|
2360
|
+
*/
|
|
2361
|
+
cursor?: string;
|
|
2362
|
+
/** The custom states. */
|
|
2363
|
+
result: CustomState[];
|
|
2364
|
+
}
|
|
2365
|
+
/** custom-states-update-request */
|
|
2366
|
+
export interface CustomStatesUpdateRequest {
|
|
2367
|
+
/** The ID of the custom state to update. */
|
|
2368
|
+
id: string;
|
|
2369
|
+
/** Whether this is a final state. */
|
|
2370
|
+
is_final?: boolean;
|
|
2371
|
+
/** The name of the custom state. */
|
|
2372
|
+
name?: string;
|
|
2373
|
+
/**
|
|
2374
|
+
* Ordinal of the custom state used to identify system states.
|
|
2375
|
+
* @format int32
|
|
2376
|
+
*/
|
|
2377
|
+
ordinal?: number;
|
|
2378
|
+
}
|
|
2379
|
+
/** custom-states-update-response */
|
|
2380
|
+
export interface CustomStatesUpdateResponse {
|
|
2381
|
+
custom_state: CustomState;
|
|
2382
|
+
}
|
|
2185
2383
|
/** custom-type-fragment */
|
|
2186
2384
|
export type CustomTypeFragment = CustomSchemaFragmentBase & {
|
|
2187
2385
|
stage_diagram?: StageDiagramSummary;
|
|
@@ -2420,6 +2618,21 @@ export interface DevUserExternalIdentityFilter {
|
|
|
2420
2618
|
/** Issuer of the external identity of the user. */
|
|
2421
2619
|
issuer?: string;
|
|
2422
2620
|
}
|
|
2621
|
+
/** Job title of the Dev User. */
|
|
2622
|
+
export declare enum DevUserJobTitle {
|
|
2623
|
+
CustomerSuccessManager = "customer_success_manager",
|
|
2624
|
+
Cxo = "cxo",
|
|
2625
|
+
Designer = "designer",
|
|
2626
|
+
Developer = "developer",
|
|
2627
|
+
HeadOfSupport = "head_of_support",
|
|
2628
|
+
Operations = "operations",
|
|
2629
|
+
Others = "others",
|
|
2630
|
+
ProductManager = "product_manager",
|
|
2631
|
+
Qa = "qa",
|
|
2632
|
+
RevenueLeader = "revenue_leader",
|
|
2633
|
+
Support = "support",
|
|
2634
|
+
TechLead = "tech_lead"
|
|
2635
|
+
}
|
|
2423
2636
|
/** dev-user-summary */
|
|
2424
2637
|
export type DevUserSummary = UserBaseSummary;
|
|
2425
2638
|
/**
|
|
@@ -2499,6 +2712,41 @@ export type DevUsersSelfRequest = object;
|
|
|
2499
2712
|
export interface DevUsersSelfResponse {
|
|
2500
2713
|
dev_user: DevUser;
|
|
2501
2714
|
}
|
|
2715
|
+
/**
|
|
2716
|
+
* dev-users-self-update-request
|
|
2717
|
+
* A request to update the user's information for the authenticated Dev
|
|
2718
|
+
* user.
|
|
2719
|
+
*/
|
|
2720
|
+
export interface DevUsersSelfUpdateRequest {
|
|
2721
|
+
/** The updated display name of the Dev user. */
|
|
2722
|
+
display_name?: string;
|
|
2723
|
+
/** The updated full name of the Dev user. */
|
|
2724
|
+
full_name?: string;
|
|
2725
|
+
/** Job title of the Dev User. */
|
|
2726
|
+
job_title?: DevUserJobTitle;
|
|
2727
|
+
}
|
|
2728
|
+
/**
|
|
2729
|
+
* dev-users-update-request
|
|
2730
|
+
* A request to update the user's information corresponding to the
|
|
2731
|
+
* provided Dev user.
|
|
2732
|
+
*/
|
|
2733
|
+
export interface DevUsersUpdateRequest {
|
|
2734
|
+
/** The updated display name of the Dev user. */
|
|
2735
|
+
display_name?: string;
|
|
2736
|
+
/** The updated full name of the Dev user. */
|
|
2737
|
+
full_name?: string;
|
|
2738
|
+
/** The ID for the Dev user to be updated. */
|
|
2739
|
+
id: string;
|
|
2740
|
+
/** Job title of the Dev User. */
|
|
2741
|
+
job_title?: DevUserJobTitle;
|
|
2742
|
+
}
|
|
2743
|
+
/**
|
|
2744
|
+
* dev-users-update-response
|
|
2745
|
+
* The response to update a Dev user.
|
|
2746
|
+
*/
|
|
2747
|
+
export interface DevUsersUpdateResponse {
|
|
2748
|
+
dev_user: DevUser;
|
|
2749
|
+
}
|
|
2502
2750
|
/** directory-summary */
|
|
2503
2751
|
export type DirectorySummary = AtomBaseSummary;
|
|
2504
2752
|
/**
|
|
@@ -3473,6 +3721,7 @@ export interface GroupsListResponse {
|
|
|
3473
3721
|
export interface GroupsUpdateRequest {
|
|
3474
3722
|
/** The updated group's description. */
|
|
3475
3723
|
description?: string;
|
|
3724
|
+
dynamic_group_info?: GroupsUpdateRequestDynamicGroupInfo;
|
|
3476
3725
|
/** The ID of the group to update. */
|
|
3477
3726
|
id: string;
|
|
3478
3727
|
/** The updated group's name. */
|
|
@@ -3480,6 +3729,11 @@ export interface GroupsUpdateRequest {
|
|
|
3480
3729
|
/** The updated group's owner. */
|
|
3481
3730
|
owner?: string;
|
|
3482
3731
|
}
|
|
3732
|
+
/** groups-update-request-dynamic-group-info */
|
|
3733
|
+
export interface GroupsUpdateRequestDynamicGroupInfo {
|
|
3734
|
+
/** Boolean expression. */
|
|
3735
|
+
membership_expression: BooleanExpression;
|
|
3736
|
+
}
|
|
3483
3737
|
/**
|
|
3484
3738
|
* groups-update-response
|
|
3485
3739
|
* The response to group update.
|
|
@@ -3578,20 +3832,33 @@ export declare enum LinkEndpointType {
|
|
|
3578
3832
|
}
|
|
3579
3833
|
/**
|
|
3580
3834
|
* link-rev-user-to-rev-org-request
|
|
3581
|
-
*
|
|
3835
|
+
* Request to link a Rev user to an existing Rev organization.
|
|
3582
3836
|
*/
|
|
3583
3837
|
export interface LinkRevUserToRevOrgRequest {
|
|
3838
|
+
/** The ID of the Rev user. */
|
|
3839
|
+
id?: string;
|
|
3840
|
+
/**
|
|
3841
|
+
* The ID of the Rev organization to link the Rev user to.
|
|
3842
|
+
* @example "REV-AbCdEfGh"
|
|
3843
|
+
*/
|
|
3844
|
+
rev_org?: string;
|
|
3584
3845
|
/**
|
|
3585
|
-
* The don of the rev org to link the rev user to.
|
|
3846
|
+
* The don of the rev org to link the rev user to. This is deprecated,
|
|
3847
|
+
* use rev_org instead.
|
|
3848
|
+
* @deprecated
|
|
3586
3849
|
* @example "REV-AbCdEfGh"
|
|
3587
3850
|
*/
|
|
3588
|
-
rev_org_don
|
|
3589
|
-
/**
|
|
3590
|
-
|
|
3851
|
+
rev_org_don?: string;
|
|
3852
|
+
/**
|
|
3853
|
+
* The don of the rev user to link. This is deprecated, use id
|
|
3854
|
+
* instead.
|
|
3855
|
+
* @deprecated
|
|
3856
|
+
*/
|
|
3857
|
+
user_don?: string;
|
|
3591
3858
|
}
|
|
3592
3859
|
/**
|
|
3593
3860
|
* link-rev-user-to-rev-org-response
|
|
3594
|
-
*
|
|
3861
|
+
* Response for linking a Rev user to an existing Rev organization.
|
|
3595
3862
|
*/
|
|
3596
3863
|
export interface LinkRevUserToRevOrgResponse {
|
|
3597
3864
|
rev_user: RevUser;
|
|
@@ -5490,6 +5757,8 @@ export interface SchemaFieldDescriptorBase {
|
|
|
5490
5757
|
mfz?: SchemaFieldMfzMetadata;
|
|
5491
5758
|
/** Name of the field. */
|
|
5492
5759
|
name: string;
|
|
5760
|
+
/** The schema of oasis specific fields. */
|
|
5761
|
+
oasis?: SchemaFieldOasisMetadata;
|
|
5493
5762
|
/** Type this field is from. */
|
|
5494
5763
|
origin?: string;
|
|
5495
5764
|
/** The schema of ui specific fields. */
|
|
@@ -5540,6 +5809,11 @@ export interface SchemaFieldListViewUiMetadata {
|
|
|
5540
5809
|
* The schema of MFZ specific fields.
|
|
5541
5810
|
*/
|
|
5542
5811
|
export type SchemaFieldMfzMetadata = object;
|
|
5812
|
+
/**
|
|
5813
|
+
* schema-field-oasis-metadata
|
|
5814
|
+
* The schema of oasis specific fields.
|
|
5815
|
+
*/
|
|
5816
|
+
export type SchemaFieldOasisMetadata = object;
|
|
5543
5817
|
/**
|
|
5544
5818
|
* schema-field-summary-view-ui-metadata
|
|
5545
5819
|
* Summary view UI hint overrides.
|
|
@@ -5898,6 +6172,54 @@ export interface SearchCoreResponse {
|
|
|
5898
6172
|
/** The search results. */
|
|
5899
6173
|
results: SearchResult[];
|
|
5900
6174
|
}
|
|
6175
|
+
/** The namespaces for hybrid search. */
|
|
6176
|
+
export declare enum SearchHybridNamespace {
|
|
6177
|
+
Article = "article",
|
|
6178
|
+
Conversation = "conversation",
|
|
6179
|
+
Issue = "issue",
|
|
6180
|
+
Part = "part",
|
|
6181
|
+
QuestionAnswer = "question_answer",
|
|
6182
|
+
Ticket = "ticket",
|
|
6183
|
+
Work = "work"
|
|
6184
|
+
}
|
|
6185
|
+
/**
|
|
6186
|
+
* search-hybrid-request
|
|
6187
|
+
* Request for search with exact, prefix and infix matches.
|
|
6188
|
+
*/
|
|
6189
|
+
export interface SearchHybridRequest {
|
|
6190
|
+
/**
|
|
6191
|
+
* The maximum number of items to return in a page. The default is
|
|
6192
|
+
* '10'.
|
|
6193
|
+
* @format int32
|
|
6194
|
+
* @min 0
|
|
6195
|
+
* @max 50
|
|
6196
|
+
*/
|
|
6197
|
+
limit?: number;
|
|
6198
|
+
/** The namespaces for hybrid search. */
|
|
6199
|
+
namespace: SearchHybridNamespace;
|
|
6200
|
+
/**
|
|
6201
|
+
* The query string.
|
|
6202
|
+
* @minLength 1
|
|
6203
|
+
* @maxLength 400
|
|
6204
|
+
*/
|
|
6205
|
+
query: string;
|
|
6206
|
+
/**
|
|
6207
|
+
* The weightage for semantic search. Values between 0 and 1 are
|
|
6208
|
+
* accepted.
|
|
6209
|
+
* @format float
|
|
6210
|
+
* @min 0
|
|
6211
|
+
* @max 1
|
|
6212
|
+
*/
|
|
6213
|
+
semantic_weight?: number;
|
|
6214
|
+
}
|
|
6215
|
+
/**
|
|
6216
|
+
* search-hybrid-response
|
|
6217
|
+
* Hybrid search response.
|
|
6218
|
+
*/
|
|
6219
|
+
export interface SearchHybridResponse {
|
|
6220
|
+
/** The search results. */
|
|
6221
|
+
results: SearchResult[];
|
|
6222
|
+
}
|
|
5901
6223
|
/** The namespaces to search in. */
|
|
5902
6224
|
export declare enum SearchNamespace {
|
|
5903
6225
|
Account = "account",
|
|
@@ -6404,17 +6726,14 @@ export interface SnapInsResourcesRequest {
|
|
|
6404
6726
|
}
|
|
6405
6727
|
/** snap-ins-resources-response */
|
|
6406
6728
|
export interface SnapInsResourcesResponse {
|
|
6407
|
-
|
|
6729
|
+
/** The event sources for the snap-in. */
|
|
6730
|
+
event_sources?: Record<string, string>;
|
|
6408
6731
|
/** The inputs for the snap-in. */
|
|
6409
6732
|
inputs?: object;
|
|
6410
|
-
|
|
6733
|
+
/** Map of keyring names and its data. */
|
|
6734
|
+
keyrings?: Record<string, SnapInsResourcesResponseKeyringData>;
|
|
6411
6735
|
snap_in_version: SnapInVersionSummary;
|
|
6412
6736
|
}
|
|
6413
|
-
/** snap-ins-resources-response-event-sources-entry */
|
|
6414
|
-
export interface SnapInsResourcesResponseEventSourcesEntry {
|
|
6415
|
-
key: string;
|
|
6416
|
-
value: string;
|
|
6417
|
-
}
|
|
6418
6737
|
/** snap-ins-resources-response-keyring-data */
|
|
6419
6738
|
export interface SnapInsResourcesResponseKeyringData {
|
|
6420
6739
|
/** The ID of the keyring. */
|
|
@@ -6422,11 +6741,6 @@ export interface SnapInsResourcesResponseKeyringData {
|
|
|
6422
6741
|
/** The secret value of the keyring. This must be handled with caution. */
|
|
6423
6742
|
secret: string;
|
|
6424
6743
|
}
|
|
6425
|
-
/** snap-ins-resources-response-keyrings-entry */
|
|
6426
|
-
export interface SnapInsResourcesResponseKeyringsEntry {
|
|
6427
|
-
key: string;
|
|
6428
|
-
value: SnapInsResourcesResponseKeyringData;
|
|
6429
|
-
}
|
|
6430
6744
|
/** snap-widget */
|
|
6431
6745
|
export type SnapWidget = EmailPreviewWidget & {
|
|
6432
6746
|
type: SnapWidgetType;
|
|
@@ -6442,6 +6756,7 @@ export type SnapWidgetBase = AtomBase & {
|
|
|
6442
6756
|
};
|
|
6443
6757
|
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
6444
6758
|
export declare enum SnapWidgetNamespace {
|
|
6759
|
+
CommentSuggestionReplies = "comment_suggestion_replies",
|
|
6445
6760
|
EmailPreview = "email_preview",
|
|
6446
6761
|
LinkPreview = "link_preview",
|
|
6447
6762
|
PlugNudge = "plug_nudge"
|
|
@@ -6497,6 +6812,14 @@ export interface StageUpdate {
|
|
|
6497
6812
|
/** The updated name of the stage, otherwise unchanged if not set. */
|
|
6498
6813
|
name?: string;
|
|
6499
6814
|
}
|
|
6815
|
+
/** Type of stage validation options when creating an object. */
|
|
6816
|
+
export declare enum StageValidationOptionForCreate {
|
|
6817
|
+
AllowNonStart = "allow_non_start"
|
|
6818
|
+
}
|
|
6819
|
+
/** Type of state validation options when updating the stage of an object. */
|
|
6820
|
+
export declare enum StageValidationOptionForUpdate {
|
|
6821
|
+
AllowInvalidTransition = "allow_invalid_transition"
|
|
6822
|
+
}
|
|
6500
6823
|
/** staged-info-filter */
|
|
6501
6824
|
export interface StagedInfoFilter {
|
|
6502
6825
|
/** Filters for issues that are staged. */
|
|
@@ -7240,6 +7563,11 @@ export interface TimelineEntriesCreateRequestTimelineComment {
|
|
|
7240
7563
|
body?: string;
|
|
7241
7564
|
/** The type of the body to use for the comment. */
|
|
7242
7565
|
body_type?: TimelineCommentBodyType;
|
|
7566
|
+
/**
|
|
7567
|
+
* The external reference for the comment. This must be unique within
|
|
7568
|
+
* the object's timeline.
|
|
7569
|
+
*/
|
|
7570
|
+
external_ref?: string;
|
|
7243
7571
|
/**
|
|
7244
7572
|
* The IDs of the previews of the links posted in the comment.
|
|
7245
7573
|
* @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
|
|
@@ -7284,6 +7612,11 @@ export type TimelineEntriesDeleteResponse = object;
|
|
|
7284
7612
|
* The request to get a timeline entry.
|
|
7285
7613
|
*/
|
|
7286
7614
|
export interface TimelineEntriesGetRequest {
|
|
7615
|
+
/**
|
|
7616
|
+
* If set, then gets the entry with the given external reference for
|
|
7617
|
+
* the provided entry ID's timeline.
|
|
7618
|
+
*/
|
|
7619
|
+
external_ref?: string;
|
|
7287
7620
|
/**
|
|
7288
7621
|
* The ID of the timeline entry to get.
|
|
7289
7622
|
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
@@ -7449,6 +7782,11 @@ export type TimelineEntry = TimelineComment & {
|
|
|
7449
7782
|
};
|
|
7450
7783
|
/** timeline-entry-base */
|
|
7451
7784
|
export type TimelineEntryBase = AtomBase & {
|
|
7785
|
+
/**
|
|
7786
|
+
* An external reference that's associated with the Timeline entry
|
|
7787
|
+
* that's guaranteed to be unique among its siblings.
|
|
7788
|
+
*/
|
|
7789
|
+
external_ref?: string;
|
|
7452
7790
|
/** Labels that are associated with the Timeline entry. */
|
|
7453
7791
|
labels?: string[];
|
|
7454
7792
|
/** The object that the Timeline entry belongs to. */
|
|
@@ -7600,20 +7938,33 @@ export declare enum UnitType {
|
|
|
7600
7938
|
}
|
|
7601
7939
|
/**
|
|
7602
7940
|
* unlink-rev-user-from-rev-org-request
|
|
7603
|
-
*
|
|
7941
|
+
* Request to unlink/remove a Rev user from a Rev organization.
|
|
7604
7942
|
*/
|
|
7605
7943
|
export interface UnlinkRevUserFromRevOrgRequest {
|
|
7944
|
+
/** The ID of the Rev user. */
|
|
7945
|
+
id?: string;
|
|
7606
7946
|
/**
|
|
7607
|
-
* The
|
|
7947
|
+
* The ID of the Rev organization to unlink the Rev user from.
|
|
7608
7948
|
* @example "REV-AbCdEfGh"
|
|
7609
7949
|
*/
|
|
7610
|
-
|
|
7611
|
-
/**
|
|
7612
|
-
|
|
7950
|
+
rev_org?: string;
|
|
7951
|
+
/**
|
|
7952
|
+
* The don of the rev org to unlink the rev user from. This is
|
|
7953
|
+
* deprecated, use rev_org instead.
|
|
7954
|
+
* @deprecated
|
|
7955
|
+
* @example "REV-AbCdEfGh"
|
|
7956
|
+
*/
|
|
7957
|
+
rev_org_don?: string;
|
|
7958
|
+
/**
|
|
7959
|
+
* The don of the rev user to unlink. This is deprecated, use id
|
|
7960
|
+
* instead.
|
|
7961
|
+
* @deprecated
|
|
7962
|
+
*/
|
|
7963
|
+
user_don?: string;
|
|
7613
7964
|
}
|
|
7614
7965
|
/**
|
|
7615
7966
|
* unlink-rev-user-from-rev-org-response
|
|
7616
|
-
*
|
|
7967
|
+
* Response for unlinking/removing a Rev user from a Rev organization.
|
|
7617
7968
|
*/
|
|
7618
7969
|
export interface UnlinkRevUserFromRevOrgResponse {
|
|
7619
7970
|
rev_user: RevUser;
|
|
@@ -8348,6 +8699,8 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
|
|
|
8348
8699
|
reported_by?: string[];
|
|
8349
8700
|
/** Sets an object's initial stage. */
|
|
8350
8701
|
stage?: StageInit;
|
|
8702
|
+
/** The type of stage validations options when creating a work item. */
|
|
8703
|
+
stage_validation_options?: StageValidationOptionForCreate[];
|
|
8351
8704
|
/** Tags associated with the work item. */
|
|
8352
8705
|
tags?: SetTagWithValue[];
|
|
8353
8706
|
/**
|
|
@@ -8434,6 +8787,8 @@ export interface WorksCreateRequestTicket {
|
|
|
8434
8787
|
group?: string;
|
|
8435
8788
|
/** Whether the ticket is spam. */
|
|
8436
8789
|
is_spam?: boolean;
|
|
8790
|
+
/** Whether the ticket needs a response. */
|
|
8791
|
+
needs_response?: boolean;
|
|
8437
8792
|
/**
|
|
8438
8793
|
* The Rev organization that the ticket is associated with.
|
|
8439
8794
|
* @example "REV-AbCdEfGh"
|
|
@@ -8709,6 +9064,11 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
8709
9064
|
reported_by?: WorksUpdateRequestReportedBy;
|
|
8710
9065
|
/** Updates an object's stage. */
|
|
8711
9066
|
stage?: StageUpdate;
|
|
9067
|
+
/**
|
|
9068
|
+
* The type of stage validations options when updating the stage of an
|
|
9069
|
+
* object.
|
|
9070
|
+
*/
|
|
9071
|
+
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
8712
9072
|
staged_info?: WorksUpdateRequestStagedInfoStagedInfoUpdate;
|
|
8713
9073
|
tags?: WorksUpdateRequestTags;
|
|
8714
9074
|
/**
|
|
@@ -8847,6 +9207,8 @@ export interface WorksUpdateRequestTicket {
|
|
|
8847
9207
|
group?: string | null;
|
|
8848
9208
|
/** Updates whether the ticket is spam. */
|
|
8849
9209
|
is_spam?: boolean;
|
|
9210
|
+
/** Updates whether the ticket needs a response. */
|
|
9211
|
+
needs_response?: boolean;
|
|
8850
9212
|
/**
|
|
8851
9213
|
* Updates the Rev organization that the ticket is associated with.
|
|
8852
9214
|
* @example "REV-AbCdEfGh"
|
|
@@ -9122,6 +9484,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9122
9484
|
* @secure
|
|
9123
9485
|
*/
|
|
9124
9486
|
articlesCount: (query?: {
|
|
9487
|
+
/** The ancestor directory of the articles. */
|
|
9488
|
+
ancestor?: string;
|
|
9125
9489
|
/**
|
|
9126
9490
|
* Filters for articles belonging to any of the provided parts.
|
|
9127
9491
|
* @example ["PROD-12345"]
|
|
@@ -9886,6 +10250,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
9886
10250
|
* @secure
|
|
9887
10251
|
*/
|
|
9888
10252
|
devUsersSelfPost: (data: DevUsersSelfRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any>>;
|
|
10253
|
+
/**
|
|
10254
|
+
* @description Updates the authenticated user.
|
|
10255
|
+
*
|
|
10256
|
+
* @tags dev-users
|
|
10257
|
+
* @name DevUsersSelfUpdate
|
|
10258
|
+
* @request POST:/dev-users.self.update
|
|
10259
|
+
* @secure
|
|
10260
|
+
*/
|
|
10261
|
+
devUsersSelfUpdate: (data: DevUsersSelfUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any>>;
|
|
10262
|
+
/**
|
|
10263
|
+
* @description Updates the user corresponding to the input Id.
|
|
10264
|
+
*
|
|
10265
|
+
* @tags dev-users
|
|
10266
|
+
* @name DevUsersUpdate
|
|
10267
|
+
* @request POST:/dev-users.update
|
|
10268
|
+
* @secure
|
|
10269
|
+
*/
|
|
10270
|
+
devUsersUpdate: (data: DevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any>>;
|
|
9889
10271
|
/**
|
|
9890
10272
|
* @description Counts the engagement records.
|
|
9891
10273
|
*
|
|
@@ -11223,6 +11605,48 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11223
11605
|
* @secure
|
|
11224
11606
|
*/
|
|
11225
11607
|
searchCorePost: (data: SearchCoreRequest, params?: RequestParams) => Promise<AxiosResponse<SearchCoreResponse, any>>;
|
|
11608
|
+
/**
|
|
11609
|
+
* @description Performs search, using a combination of syntactic and semantic search.
|
|
11610
|
+
*
|
|
11611
|
+
* @tags search
|
|
11612
|
+
* @name SearchHybrid
|
|
11613
|
+
* @request GET:/search.hybrid
|
|
11614
|
+
* @secure
|
|
11615
|
+
*/
|
|
11616
|
+
searchHybrid: (query: {
|
|
11617
|
+
/** The hybrid namespace to search in. */
|
|
11618
|
+
namespace: SearchHybridNamespace;
|
|
11619
|
+
/**
|
|
11620
|
+
* The query string.
|
|
11621
|
+
* @minLength 1
|
|
11622
|
+
* @maxLength 400
|
|
11623
|
+
*/
|
|
11624
|
+
query: string;
|
|
11625
|
+
/**
|
|
11626
|
+
* The maximum number of items to return in a page. The default is '10'.
|
|
11627
|
+
* @format int32
|
|
11628
|
+
* @min 0
|
|
11629
|
+
* @max 50
|
|
11630
|
+
*/
|
|
11631
|
+
limit?: number | undefined;
|
|
11632
|
+
/**
|
|
11633
|
+
* The weightage for semantic search. Values between 0 and 1 are
|
|
11634
|
+
* accepted.
|
|
11635
|
+
* @format float
|
|
11636
|
+
* @min 0
|
|
11637
|
+
* @max 1
|
|
11638
|
+
*/
|
|
11639
|
+
semantic_weight?: number | undefined;
|
|
11640
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SearchHybridResponse, any>>;
|
|
11641
|
+
/**
|
|
11642
|
+
* @description Performs search, using a combination of syntactic and semantic search.
|
|
11643
|
+
*
|
|
11644
|
+
* @tags search
|
|
11645
|
+
* @name SearchHybridPost
|
|
11646
|
+
* @request POST:/search.hybrid
|
|
11647
|
+
* @secure
|
|
11648
|
+
*/
|
|
11649
|
+
searchHybridPost: (data: SearchHybridRequest, params?: RequestParams) => Promise<AxiosResponse<SearchHybridResponse, any>>;
|
|
11226
11650
|
/**
|
|
11227
11651
|
* @description Gets a service account.
|
|
11228
11652
|
*
|
|
@@ -11390,6 +11814,156 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11390
11814
|
* @secure
|
|
11391
11815
|
*/
|
|
11392
11816
|
snapWidgetsCreate: (data: SnapWidgetsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapWidgetsCreateResponse, any>>;
|
|
11817
|
+
/**
|
|
11818
|
+
* @description Creates a custom stage.
|
|
11819
|
+
*
|
|
11820
|
+
* @tags customization
|
|
11821
|
+
* @name CustomStagesCreate
|
|
11822
|
+
* @request POST:/stages.custom.create
|
|
11823
|
+
* @secure
|
|
11824
|
+
*/
|
|
11825
|
+
customStagesCreate: (data: CustomStagesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesCreateResponse, any>>;
|
|
11826
|
+
/**
|
|
11827
|
+
* @description Gets a custom stage.
|
|
11828
|
+
*
|
|
11829
|
+
* @tags customization
|
|
11830
|
+
* @name CustomStagesGet
|
|
11831
|
+
* @request GET:/stages.custom.get
|
|
11832
|
+
* @secure
|
|
11833
|
+
*/
|
|
11834
|
+
customStagesGet: (query: {
|
|
11835
|
+
/** The ID of the custom stage to get. */
|
|
11836
|
+
id: string;
|
|
11837
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any>>;
|
|
11838
|
+
/**
|
|
11839
|
+
* @description Gets a custom stage.
|
|
11840
|
+
*
|
|
11841
|
+
* @tags customization
|
|
11842
|
+
* @name CustomStagesGetPost
|
|
11843
|
+
* @request POST:/stages.custom.get
|
|
11844
|
+
* @secure
|
|
11845
|
+
*/
|
|
11846
|
+
customStagesGetPost: (data: CustomStagesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any>>;
|
|
11847
|
+
/**
|
|
11848
|
+
* @description Lists custom stages.
|
|
11849
|
+
*
|
|
11850
|
+
* @tags customization
|
|
11851
|
+
* @name CustomStagesList
|
|
11852
|
+
* @request GET:/stages.custom.list
|
|
11853
|
+
* @secure
|
|
11854
|
+
*/
|
|
11855
|
+
customStagesList: (query?: {
|
|
11856
|
+
/**
|
|
11857
|
+
* The cursor to resume iteration from, otherwise if not provided, then
|
|
11858
|
+
* iteration starts from the beginning.
|
|
11859
|
+
*/
|
|
11860
|
+
cursor?: string;
|
|
11861
|
+
/**
|
|
11862
|
+
* The maximum number of items.
|
|
11863
|
+
* @format int32
|
|
11864
|
+
*/
|
|
11865
|
+
limit?: number;
|
|
11866
|
+
/** The list of stage names. */
|
|
11867
|
+
name?: string[];
|
|
11868
|
+
/** The list of stage ordinals. */
|
|
11869
|
+
ordinal?: number[];
|
|
11870
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
11871
|
+
sort_by?: string[];
|
|
11872
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any>>;
|
|
11873
|
+
/**
|
|
11874
|
+
* @description Lists custom stages.
|
|
11875
|
+
*
|
|
11876
|
+
* @tags customization
|
|
11877
|
+
* @name CustomStagesListPost
|
|
11878
|
+
* @request POST:/stages.custom.list
|
|
11879
|
+
* @secure
|
|
11880
|
+
*/
|
|
11881
|
+
customStagesListPost: (data: CustomStagesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any>>;
|
|
11882
|
+
/**
|
|
11883
|
+
* @description Updates a custom stage.
|
|
11884
|
+
*
|
|
11885
|
+
* @tags customization
|
|
11886
|
+
* @name CustomStagesUpdate
|
|
11887
|
+
* @request POST:/stages.custom.update
|
|
11888
|
+
* @secure
|
|
11889
|
+
*/
|
|
11890
|
+
customStagesUpdate: (data: CustomStagesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesUpdateResponse, any>>;
|
|
11891
|
+
/**
|
|
11892
|
+
* @description Creates a custom state.
|
|
11893
|
+
*
|
|
11894
|
+
* @tags customization
|
|
11895
|
+
* @name CustomStatesCreate
|
|
11896
|
+
* @request POST:/states.custom.create
|
|
11897
|
+
* @secure
|
|
11898
|
+
*/
|
|
11899
|
+
customStatesCreate: (data: CustomStatesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesCreateResponse, any>>;
|
|
11900
|
+
/**
|
|
11901
|
+
* @description Gets a custom state.
|
|
11902
|
+
*
|
|
11903
|
+
* @tags customization
|
|
11904
|
+
* @name CustomStatesGet
|
|
11905
|
+
* @request GET:/states.custom.get
|
|
11906
|
+
* @secure
|
|
11907
|
+
*/
|
|
11908
|
+
customStatesGet: (query: {
|
|
11909
|
+
/** The ID of the custom state to get. */
|
|
11910
|
+
id: string;
|
|
11911
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any>>;
|
|
11912
|
+
/**
|
|
11913
|
+
* @description Gets a custom state.
|
|
11914
|
+
*
|
|
11915
|
+
* @tags customization
|
|
11916
|
+
* @name CustomStatesGetPost
|
|
11917
|
+
* @request POST:/states.custom.get
|
|
11918
|
+
* @secure
|
|
11919
|
+
*/
|
|
11920
|
+
customStatesGetPost: (data: CustomStatesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any>>;
|
|
11921
|
+
/**
|
|
11922
|
+
* @description Lists custom states.
|
|
11923
|
+
*
|
|
11924
|
+
* @tags customization
|
|
11925
|
+
* @name CustomStatesList
|
|
11926
|
+
* @request GET:/states.custom.list
|
|
11927
|
+
* @secure
|
|
11928
|
+
*/
|
|
11929
|
+
customStatesList: (query?: {
|
|
11930
|
+
/**
|
|
11931
|
+
* The cursor to resume iteration from, otherwise if not provided, then
|
|
11932
|
+
* iteration starts from the beginning.
|
|
11933
|
+
*/
|
|
11934
|
+
cursor?: string;
|
|
11935
|
+
/** Whether only final states should be filtered. */
|
|
11936
|
+
is_final?: boolean;
|
|
11937
|
+
/**
|
|
11938
|
+
* The maximum number of items.
|
|
11939
|
+
* @format int32
|
|
11940
|
+
*/
|
|
11941
|
+
limit?: number;
|
|
11942
|
+
/** The list of state names. */
|
|
11943
|
+
name?: string[];
|
|
11944
|
+
/** The list of state ordinals. */
|
|
11945
|
+
ordinal?: number[];
|
|
11946
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
11947
|
+
sort_by?: string[];
|
|
11948
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any>>;
|
|
11949
|
+
/**
|
|
11950
|
+
* @description Lists custom states.
|
|
11951
|
+
*
|
|
11952
|
+
* @tags customization
|
|
11953
|
+
* @name CustomStatesListPost
|
|
11954
|
+
* @request POST:/states.custom.list
|
|
11955
|
+
* @secure
|
|
11956
|
+
*/
|
|
11957
|
+
customStatesListPost: (data: CustomStatesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any>>;
|
|
11958
|
+
/**
|
|
11959
|
+
* @description Updates a custom state.
|
|
11960
|
+
*
|
|
11961
|
+
* @tags customization
|
|
11962
|
+
* @name CustomStatesUpdate
|
|
11963
|
+
* @request POST:/states.custom.update
|
|
11964
|
+
* @secure
|
|
11965
|
+
*/
|
|
11966
|
+
customStatesUpdate: (data: CustomStatesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesUpdateResponse, any>>;
|
|
11393
11967
|
/**
|
|
11394
11968
|
* @description Creates a schema for survey, which includes name and description of schema.
|
|
11395
11969
|
*
|
|
@@ -11689,6 +12263,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11689
12263
|
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
11690
12264
|
*/
|
|
11691
12265
|
id: string;
|
|
12266
|
+
/**
|
|
12267
|
+
* If set, then gets the entry with the given external reference for the
|
|
12268
|
+
* provided entry ID's timeline.
|
|
12269
|
+
*/
|
|
12270
|
+
external_ref?: string;
|
|
11692
12271
|
}, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any>>;
|
|
11693
12272
|
/**
|
|
11694
12273
|
* @description Gets an entry on an object's timeline.
|
|
@@ -33,8 +33,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
33
33
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
34
34
|
};
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.
|
|
37
|
-
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.QuestionAnswerStatus = exports.PartType = void 0;
|
|
36
|
+
exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MemberType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupType = exports.GroupMemberType = exports.EventSourceStatus = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsCreateRequestTypeValue = exports.CodeChangeSource = exports.BooleanExpressionType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
|
|
37
|
+
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SearchHybridNamespace = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.QuestionAnswerStatus = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = void 0;
|
|
38
38
|
var AccessLevel;
|
|
39
39
|
(function (AccessLevel) {
|
|
40
40
|
AccessLevel["External"] = "external";
|
|
@@ -149,6 +149,7 @@ var AuthTokenRequestedTokenType;
|
|
|
149
149
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSession"] = "urn:devrev:params:oauth:token-type:session";
|
|
150
150
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSessionDev0"] = "urn:devrev:params:oauth:token-type:session:dev0";
|
|
151
151
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSessionOnetime"] = "urn:devrev:params:oauth:token-type:session:onetime";
|
|
152
|
+
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSessionRevActAs"] = "urn:devrev:params:oauth:token-type:session:rev:act-as";
|
|
152
153
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSuper"] = "urn:devrev:params:oauth:token-type:super";
|
|
153
154
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSys"] = "urn:devrev:params:oauth:token-type:sys";
|
|
154
155
|
AuthTokenRequestedTokenType["UrnIetfParamsOauthTokenTypeJwt"] = "urn:ietf:params:oauth:token-type:jwt";
|
|
@@ -178,6 +179,13 @@ var AuthTokenTokenType;
|
|
|
178
179
|
(function (AuthTokenTokenType) {
|
|
179
180
|
AuthTokenTokenType["Bearer"] = "bearer";
|
|
180
181
|
})(AuthTokenTokenType = exports.AuthTokenTokenType || (exports.AuthTokenTokenType = {}));
|
|
182
|
+
var BooleanExpressionType;
|
|
183
|
+
(function (BooleanExpressionType) {
|
|
184
|
+
BooleanExpressionType["And"] = "and";
|
|
185
|
+
BooleanExpressionType["Not"] = "not";
|
|
186
|
+
BooleanExpressionType["Or"] = "or";
|
|
187
|
+
BooleanExpressionType["Primitive"] = "primitive";
|
|
188
|
+
})(BooleanExpressionType = exports.BooleanExpressionType || (exports.BooleanExpressionType = {}));
|
|
181
189
|
/** Source of the code change object. */
|
|
182
190
|
var CodeChangeSource;
|
|
183
191
|
(function (CodeChangeSource) {
|
|
@@ -246,6 +254,22 @@ var DevOrgAuthConnectionsUpdateRequestType;
|
|
|
246
254
|
DevOrgAuthConnectionsUpdateRequestType["Samlp"] = "samlp";
|
|
247
255
|
DevOrgAuthConnectionsUpdateRequestType["Waad"] = "waad";
|
|
248
256
|
})(DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsUpdateRequestType || (exports.DevOrgAuthConnectionsUpdateRequestType = {}));
|
|
257
|
+
/** Job title of the Dev User. */
|
|
258
|
+
var DevUserJobTitle;
|
|
259
|
+
(function (DevUserJobTitle) {
|
|
260
|
+
DevUserJobTitle["CustomerSuccessManager"] = "customer_success_manager";
|
|
261
|
+
DevUserJobTitle["Cxo"] = "cxo";
|
|
262
|
+
DevUserJobTitle["Designer"] = "designer";
|
|
263
|
+
DevUserJobTitle["Developer"] = "developer";
|
|
264
|
+
DevUserJobTitle["HeadOfSupport"] = "head_of_support";
|
|
265
|
+
DevUserJobTitle["Operations"] = "operations";
|
|
266
|
+
DevUserJobTitle["Others"] = "others";
|
|
267
|
+
DevUserJobTitle["ProductManager"] = "product_manager";
|
|
268
|
+
DevUserJobTitle["Qa"] = "qa";
|
|
269
|
+
DevUserJobTitle["RevenueLeader"] = "revenue_leader";
|
|
270
|
+
DevUserJobTitle["Support"] = "support";
|
|
271
|
+
DevUserJobTitle["TechLead"] = "tech_lead";
|
|
272
|
+
})(DevUserJobTitle = exports.DevUserJobTitle || (exports.DevUserJobTitle = {}));
|
|
249
273
|
/** Type of engagement. */
|
|
250
274
|
var EngagementType;
|
|
251
275
|
(function (EngagementType) {
|
|
@@ -521,6 +545,17 @@ var SchemaFieldDescriptorFieldType;
|
|
|
521
545
|
SchemaFieldDescriptorFieldType["Uenum"] = "uenum";
|
|
522
546
|
SchemaFieldDescriptorFieldType["Unknown"] = "unknown";
|
|
523
547
|
})(SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorFieldType || (exports.SchemaFieldDescriptorFieldType = {}));
|
|
548
|
+
/** The namespaces for hybrid search. */
|
|
549
|
+
var SearchHybridNamespace;
|
|
550
|
+
(function (SearchHybridNamespace) {
|
|
551
|
+
SearchHybridNamespace["Article"] = "article";
|
|
552
|
+
SearchHybridNamespace["Conversation"] = "conversation";
|
|
553
|
+
SearchHybridNamespace["Issue"] = "issue";
|
|
554
|
+
SearchHybridNamespace["Part"] = "part";
|
|
555
|
+
SearchHybridNamespace["QuestionAnswer"] = "question_answer";
|
|
556
|
+
SearchHybridNamespace["Ticket"] = "ticket";
|
|
557
|
+
SearchHybridNamespace["Work"] = "work";
|
|
558
|
+
})(SearchHybridNamespace = exports.SearchHybridNamespace || (exports.SearchHybridNamespace = {}));
|
|
524
559
|
/** The namespaces to search in. */
|
|
525
560
|
var SearchNamespace;
|
|
526
561
|
(function (SearchNamespace) {
|
|
@@ -647,6 +682,7 @@ var SlaSummaryStage;
|
|
|
647
682
|
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
648
683
|
var SnapWidgetNamespace;
|
|
649
684
|
(function (SnapWidgetNamespace) {
|
|
685
|
+
SnapWidgetNamespace["CommentSuggestionReplies"] = "comment_suggestion_replies";
|
|
650
686
|
SnapWidgetNamespace["EmailPreview"] = "email_preview";
|
|
651
687
|
SnapWidgetNamespace["LinkPreview"] = "link_preview";
|
|
652
688
|
SnapWidgetNamespace["PlugNudge"] = "plug_nudge";
|
|
@@ -665,6 +701,16 @@ var SnapWidgetsCreateRequestType;
|
|
|
665
701
|
(function (SnapWidgetsCreateRequestType) {
|
|
666
702
|
SnapWidgetsCreateRequestType["EmailPreview"] = "email_preview";
|
|
667
703
|
})(SnapWidgetsCreateRequestType = exports.SnapWidgetsCreateRequestType || (exports.SnapWidgetsCreateRequestType = {}));
|
|
704
|
+
/** Type of stage validation options when creating an object. */
|
|
705
|
+
var StageValidationOptionForCreate;
|
|
706
|
+
(function (StageValidationOptionForCreate) {
|
|
707
|
+
StageValidationOptionForCreate["AllowNonStart"] = "allow_non_start";
|
|
708
|
+
})(StageValidationOptionForCreate = exports.StageValidationOptionForCreate || (exports.StageValidationOptionForCreate = {}));
|
|
709
|
+
/** Type of state validation options when updating the stage of an object. */
|
|
710
|
+
var StageValidationOptionForUpdate;
|
|
711
|
+
(function (StageValidationOptionForUpdate) {
|
|
712
|
+
StageValidationOptionForUpdate["AllowInvalidTransition"] = "allow_invalid_transition";
|
|
713
|
+
})(StageValidationOptionForUpdate = exports.StageValidationOptionForUpdate || (exports.StageValidationOptionForUpdate = {}));
|
|
668
714
|
var StockSchemaFragmentsListRequestFilterPreset;
|
|
669
715
|
(function (StockSchemaFragmentsListRequestFilterPreset) {
|
|
670
716
|
StockSchemaFragmentsListRequestFilterPreset["CustomizableTypesPreset"] = "customizable_types_preset";
|
|
@@ -1525,6 +1571,24 @@ class Api extends HttpClient {
|
|
|
1525
1571
|
* @secure
|
|
1526
1572
|
*/
|
|
1527
1573
|
this.devUsersSelfPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.self`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1574
|
+
/**
|
|
1575
|
+
* @description Updates the authenticated user.
|
|
1576
|
+
*
|
|
1577
|
+
* @tags dev-users
|
|
1578
|
+
* @name DevUsersSelfUpdate
|
|
1579
|
+
* @request POST:/dev-users.self.update
|
|
1580
|
+
* @secure
|
|
1581
|
+
*/
|
|
1582
|
+
this.devUsersSelfUpdate = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.self.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1583
|
+
/**
|
|
1584
|
+
* @description Updates the user corresponding to the input Id.
|
|
1585
|
+
*
|
|
1586
|
+
* @tags dev-users
|
|
1587
|
+
* @name DevUsersUpdate
|
|
1588
|
+
* @request POST:/dev-users.update
|
|
1589
|
+
* @secure
|
|
1590
|
+
*/
|
|
1591
|
+
this.devUsersUpdate = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1528
1592
|
/**
|
|
1529
1593
|
* @description Counts the engagement records.
|
|
1530
1594
|
*
|
|
@@ -2326,6 +2390,24 @@ class Api extends HttpClient {
|
|
|
2326
2390
|
* @secure
|
|
2327
2391
|
*/
|
|
2328
2392
|
this.searchCorePost = (data, params = {}) => this.request(Object.assign({ path: `/search.core`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2393
|
+
/**
|
|
2394
|
+
* @description Performs search, using a combination of syntactic and semantic search.
|
|
2395
|
+
*
|
|
2396
|
+
* @tags search
|
|
2397
|
+
* @name SearchHybrid
|
|
2398
|
+
* @request GET:/search.hybrid
|
|
2399
|
+
* @secure
|
|
2400
|
+
*/
|
|
2401
|
+
this.searchHybrid = (query, params = {}) => this.request(Object.assign({ path: `/search.hybrid`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
2402
|
+
/**
|
|
2403
|
+
* @description Performs search, using a combination of syntactic and semantic search.
|
|
2404
|
+
*
|
|
2405
|
+
* @tags search
|
|
2406
|
+
* @name SearchHybridPost
|
|
2407
|
+
* @request POST:/search.hybrid
|
|
2408
|
+
* @secure
|
|
2409
|
+
*/
|
|
2410
|
+
this.searchHybridPost = (data, params = {}) => this.request(Object.assign({ path: `/search.hybrid`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2329
2411
|
/**
|
|
2330
2412
|
* @description Gets a service account.
|
|
2331
2413
|
*
|
|
@@ -2461,6 +2543,114 @@ class Api extends HttpClient {
|
|
|
2461
2543
|
* @secure
|
|
2462
2544
|
*/
|
|
2463
2545
|
this.snapWidgetsCreate = (data, params = {}) => this.request(Object.assign({ path: `/snap-widgets.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2546
|
+
/**
|
|
2547
|
+
* @description Creates a custom stage.
|
|
2548
|
+
*
|
|
2549
|
+
* @tags customization
|
|
2550
|
+
* @name CustomStagesCreate
|
|
2551
|
+
* @request POST:/stages.custom.create
|
|
2552
|
+
* @secure
|
|
2553
|
+
*/
|
|
2554
|
+
this.customStagesCreate = (data, params = {}) => this.request(Object.assign({ path: `/stages.custom.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2555
|
+
/**
|
|
2556
|
+
* @description Gets a custom stage.
|
|
2557
|
+
*
|
|
2558
|
+
* @tags customization
|
|
2559
|
+
* @name CustomStagesGet
|
|
2560
|
+
* @request GET:/stages.custom.get
|
|
2561
|
+
* @secure
|
|
2562
|
+
*/
|
|
2563
|
+
this.customStagesGet = (query, params = {}) => this.request(Object.assign({ path: `/stages.custom.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
2564
|
+
/**
|
|
2565
|
+
* @description Gets a custom stage.
|
|
2566
|
+
*
|
|
2567
|
+
* @tags customization
|
|
2568
|
+
* @name CustomStagesGetPost
|
|
2569
|
+
* @request POST:/stages.custom.get
|
|
2570
|
+
* @secure
|
|
2571
|
+
*/
|
|
2572
|
+
this.customStagesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/stages.custom.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2573
|
+
/**
|
|
2574
|
+
* @description Lists custom stages.
|
|
2575
|
+
*
|
|
2576
|
+
* @tags customization
|
|
2577
|
+
* @name CustomStagesList
|
|
2578
|
+
* @request GET:/stages.custom.list
|
|
2579
|
+
* @secure
|
|
2580
|
+
*/
|
|
2581
|
+
this.customStagesList = (query, params = {}) => this.request(Object.assign({ path: `/stages.custom.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
2582
|
+
/**
|
|
2583
|
+
* @description Lists custom stages.
|
|
2584
|
+
*
|
|
2585
|
+
* @tags customization
|
|
2586
|
+
* @name CustomStagesListPost
|
|
2587
|
+
* @request POST:/stages.custom.list
|
|
2588
|
+
* @secure
|
|
2589
|
+
*/
|
|
2590
|
+
this.customStagesListPost = (data, params = {}) => this.request(Object.assign({ path: `/stages.custom.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2591
|
+
/**
|
|
2592
|
+
* @description Updates a custom stage.
|
|
2593
|
+
*
|
|
2594
|
+
* @tags customization
|
|
2595
|
+
* @name CustomStagesUpdate
|
|
2596
|
+
* @request POST:/stages.custom.update
|
|
2597
|
+
* @secure
|
|
2598
|
+
*/
|
|
2599
|
+
this.customStagesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/stages.custom.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2600
|
+
/**
|
|
2601
|
+
* @description Creates a custom state.
|
|
2602
|
+
*
|
|
2603
|
+
* @tags customization
|
|
2604
|
+
* @name CustomStatesCreate
|
|
2605
|
+
* @request POST:/states.custom.create
|
|
2606
|
+
* @secure
|
|
2607
|
+
*/
|
|
2608
|
+
this.customStatesCreate = (data, params = {}) => this.request(Object.assign({ path: `/states.custom.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2609
|
+
/**
|
|
2610
|
+
* @description Gets a custom state.
|
|
2611
|
+
*
|
|
2612
|
+
* @tags customization
|
|
2613
|
+
* @name CustomStatesGet
|
|
2614
|
+
* @request GET:/states.custom.get
|
|
2615
|
+
* @secure
|
|
2616
|
+
*/
|
|
2617
|
+
this.customStatesGet = (query, params = {}) => this.request(Object.assign({ path: `/states.custom.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
2618
|
+
/**
|
|
2619
|
+
* @description Gets a custom state.
|
|
2620
|
+
*
|
|
2621
|
+
* @tags customization
|
|
2622
|
+
* @name CustomStatesGetPost
|
|
2623
|
+
* @request POST:/states.custom.get
|
|
2624
|
+
* @secure
|
|
2625
|
+
*/
|
|
2626
|
+
this.customStatesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/states.custom.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2627
|
+
/**
|
|
2628
|
+
* @description Lists custom states.
|
|
2629
|
+
*
|
|
2630
|
+
* @tags customization
|
|
2631
|
+
* @name CustomStatesList
|
|
2632
|
+
* @request GET:/states.custom.list
|
|
2633
|
+
* @secure
|
|
2634
|
+
*/
|
|
2635
|
+
this.customStatesList = (query, params = {}) => this.request(Object.assign({ path: `/states.custom.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
2636
|
+
/**
|
|
2637
|
+
* @description Lists custom states.
|
|
2638
|
+
*
|
|
2639
|
+
* @tags customization
|
|
2640
|
+
* @name CustomStatesListPost
|
|
2641
|
+
* @request POST:/states.custom.list
|
|
2642
|
+
* @secure
|
|
2643
|
+
*/
|
|
2644
|
+
this.customStatesListPost = (data, params = {}) => this.request(Object.assign({ path: `/states.custom.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2645
|
+
/**
|
|
2646
|
+
* @description Updates a custom state.
|
|
2647
|
+
*
|
|
2648
|
+
* @tags customization
|
|
2649
|
+
* @name CustomStatesUpdate
|
|
2650
|
+
* @request POST:/states.custom.update
|
|
2651
|
+
* @secure
|
|
2652
|
+
*/
|
|
2653
|
+
this.customStatesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/states.custom.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2464
2654
|
/**
|
|
2465
2655
|
* @description Creates a schema for survey, which includes name and description of schema.
|
|
2466
2656
|
*
|
|
@@ -518,6 +518,7 @@ export declare enum AuthTokenRequestedTokenType {
|
|
|
518
518
|
UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
|
|
519
519
|
UrnDevrevParamsOauthTokenTypeSessionDev0 = "urn:devrev:params:oauth:token-type:session:dev0",
|
|
520
520
|
UrnDevrevParamsOauthTokenTypeSessionOnetime = "urn:devrev:params:oauth:token-type:session:onetime",
|
|
521
|
+
UrnDevrevParamsOauthTokenTypeSessionRevActAs = "urn:devrev:params:oauth:token-type:session:rev:act-as",
|
|
521
522
|
UrnDevrevParamsOauthTokenTypeSuper = "urn:devrev:params:oauth:token-type:super",
|
|
522
523
|
UrnDevrevParamsOauthTokenTypeSys = "urn:devrev:params:oauth:token-type:sys",
|
|
523
524
|
UrnIetfParamsOauthTokenTypeJwt = "urn:ietf:params:oauth:token-type:jwt"
|
|
@@ -2136,6 +2137,14 @@ export interface StageUpdate {
|
|
|
2136
2137
|
/** The updated name of the stage, otherwise unchanged if not set. */
|
|
2137
2138
|
name?: string;
|
|
2138
2139
|
}
|
|
2140
|
+
/** Type of stage validation options when creating an object. */
|
|
2141
|
+
export declare enum StageValidationOptionForCreate {
|
|
2142
|
+
AllowNonStart = "allow_non_start"
|
|
2143
|
+
}
|
|
2144
|
+
/** Type of state validation options when updating the stage of an object. */
|
|
2145
|
+
export declare enum StageValidationOptionForUpdate {
|
|
2146
|
+
AllowInvalidTransition = "allow_invalid_transition"
|
|
2147
|
+
}
|
|
2139
2148
|
/** staged-info-filter */
|
|
2140
2149
|
export interface StagedInfoFilter {
|
|
2141
2150
|
/** Filters for issues that are staged. */
|
|
@@ -3054,6 +3063,8 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestTi
|
|
|
3054
3063
|
reported_by?: string[];
|
|
3055
3064
|
/** Sets an object's initial stage. */
|
|
3056
3065
|
stage?: StageInit;
|
|
3066
|
+
/** The type of stage validations options when creating a work item. */
|
|
3067
|
+
stage_validation_options?: StageValidationOptionForCreate[];
|
|
3057
3068
|
/** Tags associated with the work item. */
|
|
3058
3069
|
tags?: SetTagWithValue[];
|
|
3059
3070
|
/**
|
|
@@ -3098,6 +3109,8 @@ export interface WorksCreateRequestTicket {
|
|
|
3098
3109
|
group?: string;
|
|
3099
3110
|
/** Whether the ticket is spam. */
|
|
3100
3111
|
is_spam?: boolean;
|
|
3112
|
+
/** Whether the ticket needs a response. */
|
|
3113
|
+
needs_response?: boolean;
|
|
3101
3114
|
/**
|
|
3102
3115
|
* The Rev organization that the ticket is associated with.
|
|
3103
3116
|
* @example "REV-AbCdEfGh"
|
|
@@ -3331,6 +3344,11 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
3331
3344
|
reported_by?: WorksUpdateRequestReportedBy;
|
|
3332
3345
|
/** Updates an object's stage. */
|
|
3333
3346
|
stage?: StageUpdate;
|
|
3347
|
+
/**
|
|
3348
|
+
* The type of stage validations options when updating the stage of an
|
|
3349
|
+
* object.
|
|
3350
|
+
*/
|
|
3351
|
+
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
3334
3352
|
staged_info?: WorksUpdateRequestStagedInfoStagedInfoUpdate;
|
|
3335
3353
|
tags?: WorksUpdateRequestTags;
|
|
3336
3354
|
/**
|
|
@@ -3426,6 +3444,8 @@ export interface WorksUpdateRequestTicket {
|
|
|
3426
3444
|
group?: string | null;
|
|
3427
3445
|
/** Updates whether the ticket is spam. */
|
|
3428
3446
|
is_spam?: boolean;
|
|
3447
|
+
/** Updates whether the ticket needs a response. */
|
|
3448
|
+
needs_response?: boolean;
|
|
3429
3449
|
/**
|
|
3430
3450
|
* Updates the Rev organization that the ticket is associated with.
|
|
3431
3451
|
* @example "REV-AbCdEfGh"
|
|
@@ -33,7 +33,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
33
33
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
34
34
|
};
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TicketChannels = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.SlaSummaryStage = exports.SlaStatus = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgEnvironment = exports.ListMode = exports.IssuePriority = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = void 0;
|
|
36
|
+
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TicketChannels = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SlaSummaryStage = exports.SlaStatus = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgEnvironment = exports.ListMode = exports.IssuePriority = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = void 0;
|
|
37
37
|
var AuthConnectionToggle;
|
|
38
38
|
(function (AuthConnectionToggle) {
|
|
39
39
|
AuthConnectionToggle["Disable"] = "disable";
|
|
@@ -73,6 +73,7 @@ var AuthTokenRequestedTokenType;
|
|
|
73
73
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSession"] = "urn:devrev:params:oauth:token-type:session";
|
|
74
74
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSessionDev0"] = "urn:devrev:params:oauth:token-type:session:dev0";
|
|
75
75
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSessionOnetime"] = "urn:devrev:params:oauth:token-type:session:onetime";
|
|
76
|
+
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSessionRevActAs"] = "urn:devrev:params:oauth:token-type:session:rev:act-as";
|
|
76
77
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSuper"] = "urn:devrev:params:oauth:token-type:super";
|
|
77
78
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSys"] = "urn:devrev:params:oauth:token-type:sys";
|
|
78
79
|
AuthTokenRequestedTokenType["UrnIetfParamsOauthTokenTypeJwt"] = "urn:ietf:params:oauth:token-type:jwt";
|
|
@@ -260,6 +261,16 @@ var SlaSummaryStage;
|
|
|
260
261
|
SlaSummaryStage["Running"] = "running";
|
|
261
262
|
SlaSummaryStage["Warning"] = "warning";
|
|
262
263
|
})(SlaSummaryStage = exports.SlaSummaryStage || (exports.SlaSummaryStage = {}));
|
|
264
|
+
/** Type of stage validation options when creating an object. */
|
|
265
|
+
var StageValidationOptionForCreate;
|
|
266
|
+
(function (StageValidationOptionForCreate) {
|
|
267
|
+
StageValidationOptionForCreate["AllowNonStart"] = "allow_non_start";
|
|
268
|
+
})(StageValidationOptionForCreate = exports.StageValidationOptionForCreate || (exports.StageValidationOptionForCreate = {}));
|
|
269
|
+
/** Type of state validation options when updating the stage of an object. */
|
|
270
|
+
var StageValidationOptionForUpdate;
|
|
271
|
+
(function (StageValidationOptionForUpdate) {
|
|
272
|
+
StageValidationOptionForUpdate["AllowInvalidTransition"] = "allow_invalid_transition";
|
|
273
|
+
})(StageValidationOptionForUpdate = exports.StageValidationOptionForUpdate || (exports.StageValidationOptionForUpdate = {}));
|
|
263
274
|
var SyncMetadataFilterSyncInFilterStatus;
|
|
264
275
|
(function (SyncMetadataFilterSyncInFilterStatus) {
|
|
265
276
|
SyncMetadataFilterSyncInFilterStatus["Failed"] = "failed";
|