@devrev/typescript-sdk 1.1.17 → 1.1.18
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.
|
@@ -10,11 +10,7 @@ export interface ArtifactsLocateRequest {
|
|
|
10
10
|
* @example "ARTIFACT-12345"
|
|
11
11
|
*/
|
|
12
12
|
id: string;
|
|
13
|
-
/**
|
|
14
|
-
* The version of the artifact that needs to be fetched.
|
|
15
|
-
* @format date-time
|
|
16
|
-
* @example "2023-01-01T12:00:00.000Z"
|
|
17
|
-
*/
|
|
13
|
+
/** The version of the artifact that needs to be fetched. */
|
|
18
14
|
version?: string;
|
|
19
15
|
}
|
|
20
16
|
/**
|
|
@@ -224,6 +220,7 @@ export declare enum AuthTokenRequestedTokenType {
|
|
|
224
220
|
UrnDevrevParamsOauthTokenTypeAatPublic = "urn:devrev:params:oauth:token-type:aat:public",
|
|
225
221
|
UrnDevrevParamsOauthTokenTypeDev = "urn:devrev:params:oauth:token-type:dev",
|
|
226
222
|
UrnDevrevParamsOauthTokenTypePat = "urn:devrev:params:oauth:token-type:pat",
|
|
223
|
+
UrnDevrevParamsOauthTokenTypeRat = "urn:devrev:params:oauth:token-type:rat",
|
|
227
224
|
UrnDevrevParamsOauthTokenTypeRev = "urn:devrev:params:oauth:token-type:rev",
|
|
228
225
|
UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
|
|
229
226
|
UrnDevrevParamsOauthTokenTypeSessionDev0 = "urn:devrev:params:oauth:token-type:session:dev0",
|
|
@@ -241,6 +238,7 @@ export declare enum AuthTokenStatus {
|
|
|
241
238
|
export declare enum AuthTokenSubjectTokenType {
|
|
242
239
|
UrnDevrevParamsOauthTokenTypeJwtAuth0 = "urn:devrev:params:oauth:token-type:jwt:auth0",
|
|
243
240
|
UrnDevrevParamsOauthTokenTypeJwtDev = "urn:devrev:params:oauth:token-type:jwt:dev",
|
|
241
|
+
UrnDevrevParamsOauthTokenTypeRat = "urn:devrev:params:oauth:token-type:rat",
|
|
244
242
|
UrnDevrevParamsOauthTokenTypeRevinfo = "urn:devrev:params:oauth:token-type:revinfo",
|
|
245
243
|
UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
|
|
246
244
|
UrnDevrevParamsOauthTokenTypeSysu = "urn:devrev:params:oauth:token-type:sysu",
|
|
@@ -917,6 +915,19 @@ export interface EventRevUserDeleted {
|
|
|
917
915
|
export interface EventRevUserUpdated {
|
|
918
916
|
rev_user: RevUser;
|
|
919
917
|
}
|
|
918
|
+
/** event-sla-tracker-created */
|
|
919
|
+
export interface EventSlaTrackerCreated {
|
|
920
|
+
sla_tracker: SlaTracker;
|
|
921
|
+
}
|
|
922
|
+
/** event-sla-tracker-deleted */
|
|
923
|
+
export interface EventSlaTrackerDeleted {
|
|
924
|
+
/** The ID of the SLA tracker that was deleted. */
|
|
925
|
+
id: string;
|
|
926
|
+
}
|
|
927
|
+
/** event-sla-tracker-updated */
|
|
928
|
+
export interface EventSlaTrackerUpdated {
|
|
929
|
+
sla_tracker: SlaTracker;
|
|
930
|
+
}
|
|
920
931
|
/** event-tag-created */
|
|
921
932
|
export interface EventTagCreated {
|
|
922
933
|
tag: Tag;
|
|
@@ -1004,6 +1015,14 @@ export declare enum IssuePriority {
|
|
|
1004
1015
|
P2 = "p2",
|
|
1005
1016
|
P3 = "p3"
|
|
1006
1017
|
}
|
|
1018
|
+
/**
|
|
1019
|
+
* legacy-stage
|
|
1020
|
+
* Describes the current stage of a work item.
|
|
1021
|
+
*/
|
|
1022
|
+
export interface LegacyStage {
|
|
1023
|
+
/** Current stage name of the work item. */
|
|
1024
|
+
name: string;
|
|
1025
|
+
}
|
|
1007
1026
|
/**
|
|
1008
1027
|
* The iteration mode to use. If "after", then entries after the provided
|
|
1009
1028
|
* cursor will be returned, or if no cursor is provided, then from the
|
|
@@ -1505,15 +1524,23 @@ export interface SetTagWithValue {
|
|
|
1505
1524
|
* sla-summary-filter
|
|
1506
1525
|
* The filter for SLA summary.
|
|
1507
1526
|
*/
|
|
1508
|
-
export
|
|
1527
|
+
export interface SlaSummaryFilter {
|
|
1528
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
1529
|
+
stage?: SlaSummaryStage[];
|
|
1530
|
+
}
|
|
1509
1531
|
/**
|
|
1510
|
-
* stage
|
|
1511
|
-
*
|
|
1532
|
+
* The stage of the SLA. This is the metric stage which is closest to
|
|
1533
|
+
* breach.
|
|
1512
1534
|
*/
|
|
1513
|
-
export
|
|
1514
|
-
|
|
1515
|
-
|
|
1535
|
+
export declare enum SlaSummaryStage {
|
|
1536
|
+
Breached = "breached",
|
|
1537
|
+
Completed = "completed",
|
|
1538
|
+
Paused = "paused",
|
|
1539
|
+
Running = "running",
|
|
1540
|
+
Warning = "warning"
|
|
1516
1541
|
}
|
|
1542
|
+
/** sla-tracker */
|
|
1543
|
+
export type SlaTracker = AtomBase;
|
|
1517
1544
|
/**
|
|
1518
1545
|
* stage-filter
|
|
1519
1546
|
* The filter for stages.
|
|
@@ -1789,6 +1816,7 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
1789
1816
|
export interface TimelineEntriesCreateRequestTimelineComment {
|
|
1790
1817
|
/**
|
|
1791
1818
|
* The IDs of the artifacts attached to the comment.
|
|
1819
|
+
* @maxItems 10
|
|
1792
1820
|
* @example ["ARTIFACT-12345"]
|
|
1793
1821
|
*/
|
|
1794
1822
|
artifacts?: string[];
|
|
@@ -1925,17 +1953,20 @@ export interface TimelineEntriesUpdateRequestTimelineCommentArtifacts {
|
|
|
1925
1953
|
* Adds the provided artifacts to the comment. An artifact cannot be
|
|
1926
1954
|
* added more than once, i.e. nothing is done if the artifact is
|
|
1927
1955
|
* already attached. Mutually exclusive with `set`.
|
|
1956
|
+
* @maxItems 10
|
|
1928
1957
|
* @example ["ARTIFACT-12345"]
|
|
1929
1958
|
*/
|
|
1930
1959
|
add?: string[];
|
|
1931
1960
|
/**
|
|
1932
1961
|
* Removes the provided artifacts from the comment. If an artifact is
|
|
1933
1962
|
* not present, then it's ignored. Mututally exclusive with `set`.
|
|
1963
|
+
* @maxItems 10
|
|
1934
1964
|
* @example ["ARTIFACT-12345"]
|
|
1935
1965
|
*/
|
|
1936
1966
|
remove?: string[];
|
|
1937
1967
|
/**
|
|
1938
1968
|
* Sets the field to the provided artifacts.
|
|
1969
|
+
* @maxItems 10
|
|
1939
1970
|
* @example ["ARTIFACT-12345"]
|
|
1940
1971
|
*/
|
|
1941
1972
|
set?: string[];
|
|
@@ -2086,6 +2117,9 @@ export interface WebhookEventRequest {
|
|
|
2086
2117
|
rev_user_created?: EventRevUserCreated;
|
|
2087
2118
|
rev_user_deleted?: EventRevUserDeleted;
|
|
2088
2119
|
rev_user_updated?: EventRevUserUpdated;
|
|
2120
|
+
sla_tracker_created?: EventSlaTrackerCreated;
|
|
2121
|
+
sla_tracker_deleted?: EventSlaTrackerDeleted;
|
|
2122
|
+
sla_tracker_updated?: EventSlaTrackerUpdated;
|
|
2089
2123
|
tag_created?: EventTagCreated;
|
|
2090
2124
|
tag_deleted?: EventTagDeleted;
|
|
2091
2125
|
tag_updated?: EventTagUpdated;
|
|
@@ -2314,7 +2348,7 @@ export type WorkBase = AtomBase & {
|
|
|
2314
2348
|
/** Users that reported the work. */
|
|
2315
2349
|
reported_by?: UserSummary[];
|
|
2316
2350
|
/** Describes the current stage of a work item. */
|
|
2317
|
-
stage?:
|
|
2351
|
+
stage?: LegacyStage;
|
|
2318
2352
|
/** Tags associated with the object. */
|
|
2319
2353
|
tags?: TagWithValue[];
|
|
2320
2354
|
/**
|
|
@@ -2372,6 +2406,12 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestTi
|
|
|
2372
2406
|
};
|
|
2373
2407
|
/** works-create-request-issue */
|
|
2374
2408
|
export interface WorksCreateRequestIssue {
|
|
2409
|
+
/**
|
|
2410
|
+
* The IDs of the parts associated with issue.
|
|
2411
|
+
* @maxItems 8
|
|
2412
|
+
* @example ["PROD-12345"]
|
|
2413
|
+
*/
|
|
2414
|
+
developed_with?: string[];
|
|
2375
2415
|
/** Priority of the work based upon impact and criticality. */
|
|
2376
2416
|
priority?: IssuePriority;
|
|
2377
2417
|
/** The sprint that the issue belongs to. */
|
|
@@ -2610,11 +2650,21 @@ export interface WorksUpdateRequestArtifactIds {
|
|
|
2610
2650
|
}
|
|
2611
2651
|
/** works-update-request-issue */
|
|
2612
2652
|
export interface WorksUpdateRequestIssue {
|
|
2653
|
+
developed_with?: WorksUpdateRequestIssueDevelopedWith;
|
|
2613
2654
|
/** Priority of the work based upon impact and criticality. */
|
|
2614
2655
|
priority?: IssuePriority;
|
|
2615
2656
|
/** Updates the sprint that the issue belongs to. */
|
|
2616
2657
|
sprint?: string | null;
|
|
2617
2658
|
}
|
|
2659
|
+
/** works-update-request-issue-developed-with */
|
|
2660
|
+
export interface WorksUpdateRequestIssueDevelopedWith {
|
|
2661
|
+
/**
|
|
2662
|
+
* Sets the IDs of the parts associated with issue.
|
|
2663
|
+
* @maxItems 8
|
|
2664
|
+
* @example ["PROD-12345"]
|
|
2665
|
+
*/
|
|
2666
|
+
set?: string[];
|
|
2667
|
+
}
|
|
2618
2668
|
/** works-update-request-owned-by */
|
|
2619
2669
|
export interface WorksUpdateRequestOwnedBy {
|
|
2620
2670
|
/**
|
|
@@ -2718,11 +2768,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2718
2768
|
* @example "ARTIFACT-12345"
|
|
2719
2769
|
*/
|
|
2720
2770
|
id: string;
|
|
2721
|
-
/**
|
|
2722
|
-
* The version of the artifact that needs to be fetched.
|
|
2723
|
-
* @format date-time
|
|
2724
|
-
* @example "2023-01-01T12:00:00.000Z"
|
|
2725
|
-
*/
|
|
2771
|
+
/** The version of the artifact that needs to be fetched. */
|
|
2726
2772
|
version?: string;
|
|
2727
2773
|
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any>>;
|
|
2728
2774
|
/**
|
|
@@ -2962,36 +3008,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2962
3008
|
/** Filters Dev users based on state. */
|
|
2963
3009
|
state?: UserState[];
|
|
2964
3010
|
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any>>;
|
|
2965
|
-
/**
|
|
2966
|
-
* @description Lists users within your organization.
|
|
2967
|
-
*
|
|
2968
|
-
* @tags dev-users
|
|
2969
|
-
* @name DevUsersList
|
|
2970
|
-
* @request GET:/dev-users.list
|
|
2971
|
-
* @secure */
|
|
2972
|
-
devUsersListPaginator(query?: {
|
|
2973
|
-
/**
|
|
2974
|
-
* The cursor to resume iteration from. If not provided, then iteration
|
|
2975
|
-
* starts from the beginning.
|
|
2976
|
-
*/
|
|
2977
|
-
cursor?: string;
|
|
2978
|
-
/** Filters Dev users based on email addresses. */
|
|
2979
|
-
email?: string[];
|
|
2980
|
-
/**
|
|
2981
|
-
* The maximum number of Dev users to return. The default is '50'.
|
|
2982
|
-
* @format int32
|
|
2983
|
-
*/
|
|
2984
|
-
limit?: number;
|
|
2985
|
-
/**
|
|
2986
|
-
* The iteration mode to use, otherwise if not set, then "after" is
|
|
2987
|
-
* used.
|
|
2988
|
-
*/
|
|
2989
|
-
mode?: ListMode;
|
|
2990
|
-
/** Fields to sort the Dev users by and the direction to sort them. */
|
|
2991
|
-
sort_by?: string[];
|
|
2992
|
-
/** Filters Dev users based on state. */
|
|
2993
|
-
state?: UserState[];
|
|
2994
|
-
}, params?: RequestParams): AsyncGenerator<DevUsersListResponse, void, unknown>;
|
|
2995
3011
|
/**
|
|
2996
3012
|
* @description Lists users within your organization.
|
|
2997
3013
|
*
|
|
@@ -3113,57 +3129,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3113
3129
|
/** Filters for parts of the provided type(s). */
|
|
3114
3130
|
type?: PartType[];
|
|
3115
3131
|
}, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
|
|
3116
|
-
/**
|
|
3117
|
-
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
3118
|
-
*
|
|
3119
|
-
* @tags parts
|
|
3120
|
-
* @name PartsList
|
|
3121
|
-
* @request GET:/parts.list
|
|
3122
|
-
* @secure */
|
|
3123
|
-
partsListPaginator(query?: {
|
|
3124
|
-
/**
|
|
3125
|
-
* Filters for parts created by any of these users.
|
|
3126
|
-
* @example ["DEVU-12345"]
|
|
3127
|
-
*/
|
|
3128
|
-
created_by?: string[];
|
|
3129
|
-
/**
|
|
3130
|
-
* The cursor to resume iteration from. If not provided, then iteration
|
|
3131
|
-
* starts from the beginning.
|
|
3132
|
-
*/
|
|
3133
|
-
cursor?: string;
|
|
3134
|
-
/**
|
|
3135
|
-
* The maximum number of parts to return. The default is '50'.
|
|
3136
|
-
* @format int32
|
|
3137
|
-
*/
|
|
3138
|
-
limit?: number;
|
|
3139
|
-
/**
|
|
3140
|
-
* The iteration mode to use, otherwise if not set, then "after" is
|
|
3141
|
-
* used.
|
|
3142
|
-
*/
|
|
3143
|
-
mode?: ListMode;
|
|
3144
|
-
/** Filters for parts of the provided name(s). */
|
|
3145
|
-
name?: string[];
|
|
3146
|
-
/**
|
|
3147
|
-
* Filters for parts owned by any of these users.
|
|
3148
|
-
* @example ["DEVU-12345"]
|
|
3149
|
-
*/
|
|
3150
|
-
owned_by?: string[];
|
|
3151
|
-
/**
|
|
3152
|
-
* Number of levels to fetch the part hierarchy up to.
|
|
3153
|
-
* @format int32
|
|
3154
|
-
* @min 1
|
|
3155
|
-
*/
|
|
3156
|
-
'parent_part.level'?: number;
|
|
3157
|
-
/**
|
|
3158
|
-
* Part IDs to fetch the hierarchy for. Required if any parent_part.*
|
|
3159
|
-
* fields are provided.
|
|
3160
|
-
* @minItems 1
|
|
3161
|
-
* @example ["PROD-12345"]
|
|
3162
|
-
*/
|
|
3163
|
-
'parent_part.parts'?: string[];
|
|
3164
|
-
/** Filters for parts of the provided type(s). */
|
|
3165
|
-
type?: PartType[];
|
|
3166
|
-
}, params?: RequestParams): AsyncGenerator<PartsListResponse, void, unknown>;
|
|
3167
3132
|
/**
|
|
3168
3133
|
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
3169
3134
|
*
|
|
@@ -3290,65 +3255,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3290
3255
|
*/
|
|
3291
3256
|
sort_by?: string[];
|
|
3292
3257
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any>>;
|
|
3293
|
-
/**
|
|
3294
|
-
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
3295
|
-
*
|
|
3296
|
-
* @tags rev-orgs
|
|
3297
|
-
* @name RevOrgsList
|
|
3298
|
-
* @request GET:/rev-orgs.list
|
|
3299
|
-
* @secure */
|
|
3300
|
-
revOrgsListPaginator(query?: {
|
|
3301
|
-
/** Filters by creator. */
|
|
3302
|
-
created_by?: string[];
|
|
3303
|
-
/**
|
|
3304
|
-
* Filters for objects created after the provided timestamp (inclusive).
|
|
3305
|
-
* @format date-time
|
|
3306
|
-
* @example "2023-01-01T12:00:00.000Z"
|
|
3307
|
-
*/
|
|
3308
|
-
'created_date.after'?: string;
|
|
3309
|
-
/**
|
|
3310
|
-
* Filters for objects created before the provided timestamp
|
|
3311
|
-
* (inclusive).
|
|
3312
|
-
* @format date-time
|
|
3313
|
-
* @example "2023-01-01T12:00:00.000Z"
|
|
3314
|
-
*/
|
|
3315
|
-
'created_date.before'?: string;
|
|
3316
|
-
/**
|
|
3317
|
-
* The cursor to resume iteration from. If not provided, then iteration
|
|
3318
|
-
* starts from the beginning.
|
|
3319
|
-
*/
|
|
3320
|
-
cursor?: string;
|
|
3321
|
-
/** List of external refs to filter Rev organizations for. */
|
|
3322
|
-
external_ref?: string[];
|
|
3323
|
-
/**
|
|
3324
|
-
* The maximum number of Rev organizations to be retrieved per page.
|
|
3325
|
-
* @format int32
|
|
3326
|
-
*/
|
|
3327
|
-
limit?: number;
|
|
3328
|
-
/**
|
|
3329
|
-
* The iteration mode to use, otherwise if not set, then "after" is
|
|
3330
|
-
* used.
|
|
3331
|
-
*/
|
|
3332
|
-
mode?: ListMode;
|
|
3333
|
-
/**
|
|
3334
|
-
* Filters for objects created after the provided timestamp (inclusive).
|
|
3335
|
-
* @format date-time
|
|
3336
|
-
* @example "2023-01-01T12:00:00.000Z"
|
|
3337
|
-
*/
|
|
3338
|
-
'modified_date.after'?: string;
|
|
3339
|
-
/**
|
|
3340
|
-
* Filters for objects created before the provided timestamp
|
|
3341
|
-
* (inclusive).
|
|
3342
|
-
* @format date-time
|
|
3343
|
-
* @example "2023-01-01T12:00:00.000Z"
|
|
3344
|
-
*/
|
|
3345
|
-
'modified_date.before'?: string;
|
|
3346
|
-
/**
|
|
3347
|
-
* Fields to sort the Rev organizations by and the direction to sort
|
|
3348
|
-
* them.
|
|
3349
|
-
*/
|
|
3350
|
-
sort_by?: string[];
|
|
3351
|
-
}, params?: RequestParams): AsyncGenerator<RevOrgsListResponse, void, unknown>;
|
|
3352
3258
|
/**
|
|
3353
3259
|
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
3354
3260
|
*
|
|
@@ -3438,34 +3344,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3438
3344
|
/** Fields to sort tags by and the direction to sort them. */
|
|
3439
3345
|
sort_by?: string[];
|
|
3440
3346
|
}, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any>>;
|
|
3441
|
-
/**
|
|
3442
|
-
* @description Lists the available tags.
|
|
3443
|
-
*
|
|
3444
|
-
* @tags tags
|
|
3445
|
-
* @name TagsList
|
|
3446
|
-
* @request GET:/tags.list
|
|
3447
|
-
* @secure */
|
|
3448
|
-
tagsListPaginator(query?: {
|
|
3449
|
-
/**
|
|
3450
|
-
* The cursor to resume iteration from. If not provided, then iteration
|
|
3451
|
-
* starts from the beginning.
|
|
3452
|
-
*/
|
|
3453
|
-
cursor?: string;
|
|
3454
|
-
/**
|
|
3455
|
-
* The maximum number of tags to return. The default is '50'.
|
|
3456
|
-
* @format int32
|
|
3457
|
-
*/
|
|
3458
|
-
limit?: number;
|
|
3459
|
-
/**
|
|
3460
|
-
* The iteration mode to use, otherwise if not set, then "after" is
|
|
3461
|
-
* used.
|
|
3462
|
-
*/
|
|
3463
|
-
mode?: ListMode;
|
|
3464
|
-
/** Filters for tags with the provided names. */
|
|
3465
|
-
name?: string[];
|
|
3466
|
-
/** Fields to sort tags by and the direction to sort them. */
|
|
3467
|
-
sort_by?: string[];
|
|
3468
|
-
}, params?: RequestParams): AsyncGenerator<TagsListResponse, void, unknown>;
|
|
3469
3347
|
/**
|
|
3470
3348
|
* @description Lists the available tags.
|
|
3471
3349
|
*
|
|
@@ -3563,42 +3441,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3563
3441
|
*/
|
|
3564
3442
|
visibility?: TimelineEntryVisibility[];
|
|
3565
3443
|
}, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
|
|
3566
|
-
/**
|
|
3567
|
-
* @description Lists the timeline entries for an object.
|
|
3568
|
-
*
|
|
3569
|
-
* @tags timeline-entries
|
|
3570
|
-
* @name TimelineEntriesList
|
|
3571
|
-
* @request GET:/timeline-entries.list
|
|
3572
|
-
* @secure */
|
|
3573
|
-
timelineEntriesListPaginator(query: {
|
|
3574
|
-
/**
|
|
3575
|
-
* The ID of the object to list timeline entries for.
|
|
3576
|
-
* @example "PROD-12345"
|
|
3577
|
-
*/
|
|
3578
|
-
object: string;
|
|
3579
|
-
/**
|
|
3580
|
-
* The cursor to resume iteration from. If not provided, then iteration
|
|
3581
|
-
* starts from the beginning.
|
|
3582
|
-
*/
|
|
3583
|
-
cursor?: string;
|
|
3584
|
-
/**
|
|
3585
|
-
* The maximum number of entries to return. If not set, then this
|
|
3586
|
-
* defaults to `50`.
|
|
3587
|
-
* @format int32
|
|
3588
|
-
*/
|
|
3589
|
-
limit?: number;
|
|
3590
|
-
/**
|
|
3591
|
-
* The iteration mode to use, otherwise if not set, then "after" is
|
|
3592
|
-
* used.
|
|
3593
|
-
*/
|
|
3594
|
-
mode?: ListMode;
|
|
3595
|
-
/**
|
|
3596
|
-
* The visibility of the timeline entries to filter for. Note this is a
|
|
3597
|
-
* strict filter, such that only entries with the exact visibilities
|
|
3598
|
-
* specified will be returned.
|
|
3599
|
-
*/
|
|
3600
|
-
visibility?: TimelineEntryVisibility[];
|
|
3601
|
-
}, params?: RequestParams): AsyncGenerator<TimelineEntriesListResponse, void, unknown>;
|
|
3602
3444
|
/**
|
|
3603
3445
|
* @description Lists the timeline entries for an object.
|
|
3604
3446
|
*
|
|
@@ -3762,6 +3604,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3762
3604
|
'ticket.rev_org'?: string[];
|
|
3763
3605
|
/** Filters for tickets with any of the provided severities. */
|
|
3764
3606
|
'ticket.severity'?: TicketSeverity[];
|
|
3607
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
3608
|
+
'ticket.sla_summary.stage'?: SlaSummaryStage[];
|
|
3765
3609
|
/** Filters for tickets with any of the provided source channels. */
|
|
3766
3610
|
'ticket.source_channel'?: string[];
|
|
3767
3611
|
/** Filters for work of the provided types. */
|
|
@@ -3867,82 +3711,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3867
3711
|
'ticket.rev_org'?: string[];
|
|
3868
3712
|
/** Filters for tickets with any of the provided severities. */
|
|
3869
3713
|
'ticket.severity'?: TicketSeverity[];
|
|
3714
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
3715
|
+
'ticket.sla_summary.stage'?: SlaSummaryStage[];
|
|
3870
3716
|
/** Filters for tickets with any of the provided source channels. */
|
|
3871
3717
|
'ticket.source_channel'?: string[];
|
|
3872
3718
|
/** Filters for work of the provided types. */
|
|
3873
3719
|
type?: WorkType[];
|
|
3874
3720
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
|
|
3875
|
-
/**
|
|
3876
|
-
* @description Lists a collection of work items.
|
|
3877
|
-
*
|
|
3878
|
-
* @tags works
|
|
3879
|
-
* @name WorksList
|
|
3880
|
-
* @request GET:/works.list
|
|
3881
|
-
* @secure */
|
|
3882
|
-
worksListPaginator(query?: {
|
|
3883
|
-
/**
|
|
3884
|
-
* Filters for work belonging to any of the provided parts.
|
|
3885
|
-
* @example ["PROD-12345"]
|
|
3886
|
-
*/
|
|
3887
|
-
applies_to_part?: string[];
|
|
3888
|
-
/**
|
|
3889
|
-
* Filters for work created by any of these users.
|
|
3890
|
-
* @example ["DEVU-12345"]
|
|
3891
|
-
*/
|
|
3892
|
-
created_by?: string[];
|
|
3893
|
-
/**
|
|
3894
|
-
* The cursor to resume iteration from. If not provided, then iteration
|
|
3895
|
-
* starts from the beginning.
|
|
3896
|
-
*/
|
|
3897
|
-
cursor?: string;
|
|
3898
|
-
/** Filters for issues with any of the provided priorities. */
|
|
3899
|
-
'issue.priority'?: IssuePriority[];
|
|
3900
|
-
/**
|
|
3901
|
-
* Filters for issues with any of the provided Rev organizations.
|
|
3902
|
-
* @example ["REV-AbCdEfGh"]
|
|
3903
|
-
*/
|
|
3904
|
-
'issue.rev_orgs'?: string[];
|
|
3905
|
-
/**
|
|
3906
|
-
* The maximum number of works to return. The default is '50'.
|
|
3907
|
-
* @format int32
|
|
3908
|
-
*/
|
|
3909
|
-
limit?: number;
|
|
3910
|
-
/**
|
|
3911
|
-
* The iteration mode to use, otherwise if not set, then "after" is
|
|
3912
|
-
* used.
|
|
3913
|
-
*/
|
|
3914
|
-
mode?: ListMode;
|
|
3915
|
-
/**
|
|
3916
|
-
* Filters for work owned by any of these users.
|
|
3917
|
-
* @example ["DEVU-12345"]
|
|
3918
|
-
*/
|
|
3919
|
-
owned_by?: string[];
|
|
3920
|
-
/** Filters for records in the provided stage(s) by name. */
|
|
3921
|
-
'stage.name'?: string[];
|
|
3922
|
-
/**
|
|
3923
|
-
* Filters for work with any of the provided tags.
|
|
3924
|
-
* @example ["TAG-12345"]
|
|
3925
|
-
*/
|
|
3926
|
-
tags?: string[];
|
|
3927
|
-
/** Filters for tickets belonging to specific groups. */
|
|
3928
|
-
'ticket.group'?: string[];
|
|
3929
|
-
/** Filters for tickets that are spam. */
|
|
3930
|
-
'ticket.is_spam'?: boolean;
|
|
3931
|
-
/** Filters for tickets that need response. */
|
|
3932
|
-
'ticket.needs_response'?: boolean;
|
|
3933
|
-
/**
|
|
3934
|
-
* Filters for tickets that are associated with any of the provided Rev
|
|
3935
|
-
* organizations.
|
|
3936
|
-
* @example ["REV-AbCdEfGh"]
|
|
3937
|
-
*/
|
|
3938
|
-
'ticket.rev_org'?: string[];
|
|
3939
|
-
/** Filters for tickets with any of the provided severities. */
|
|
3940
|
-
'ticket.severity'?: TicketSeverity[];
|
|
3941
|
-
/** Filters for tickets with any of the provided source channels. */
|
|
3942
|
-
'ticket.source_channel'?: string[];
|
|
3943
|
-
/** Filters for work of the provided types. */
|
|
3944
|
-
type?: WorkType[];
|
|
3945
|
-
}, params?: RequestParams): AsyncGenerator<WorksListResponse, void, unknown>;
|
|
3946
3721
|
/**
|
|
3947
3722
|
* @description Lists a collection of work items.
|
|
3948
3723
|
*
|