@devrev/typescript-sdk 1.1.15 → 1.1.16
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.
|
@@ -2607,6 +2607,198 @@ export declare enum PartType {
|
|
|
2607
2607
|
Feature = "feature",
|
|
2608
2608
|
Product = "product"
|
|
2609
2609
|
}
|
|
2610
|
+
/** parts-create-request */
|
|
2611
|
+
export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequestEnhancement | PartsCreateRequestFeature | PartsCreateRequestProduct) & {
|
|
2612
|
+
/**
|
|
2613
|
+
* The IDs of the artifacts.
|
|
2614
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
2615
|
+
*/
|
|
2616
|
+
artifacts?: string[];
|
|
2617
|
+
/** Custom fields. */
|
|
2618
|
+
custom_fields?: object;
|
|
2619
|
+
/**
|
|
2620
|
+
* The custom schema fragments to use.
|
|
2621
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
2622
|
+
*/
|
|
2623
|
+
custom_schema_fragments?: string[];
|
|
2624
|
+
/** Description of the part. */
|
|
2625
|
+
description?: string;
|
|
2626
|
+
/** Name of the part. */
|
|
2627
|
+
name: string;
|
|
2628
|
+
/**
|
|
2629
|
+
* The users that own the part.
|
|
2630
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
2631
|
+
*/
|
|
2632
|
+
owned_by: string[];
|
|
2633
|
+
type: PartType;
|
|
2634
|
+
};
|
|
2635
|
+
/** parts-create-request-capability */
|
|
2636
|
+
export interface PartsCreateRequestCapability {
|
|
2637
|
+
/**
|
|
2638
|
+
* ID of the parent product for the capability.
|
|
2639
|
+
* @maxItems 1
|
|
2640
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
2641
|
+
*/
|
|
2642
|
+
parent_part: string[];
|
|
2643
|
+
}
|
|
2644
|
+
/** parts-create-request-enhancement */
|
|
2645
|
+
export interface PartsCreateRequestEnhancement {
|
|
2646
|
+
/**
|
|
2647
|
+
* ID of the parent part on which the enhancement is to be created.
|
|
2648
|
+
* @maxItems 1
|
|
2649
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
2650
|
+
*/
|
|
2651
|
+
parent_part: string[];
|
|
2652
|
+
/**
|
|
2653
|
+
* Target close date by which enhancement is expected to be closed.
|
|
2654
|
+
* @format date-time
|
|
2655
|
+
*/
|
|
2656
|
+
target_close_date?: string;
|
|
2657
|
+
}
|
|
2658
|
+
/** parts-create-request-feature */
|
|
2659
|
+
export interface PartsCreateRequestFeature {
|
|
2660
|
+
/**
|
|
2661
|
+
* ID of the parent capability/feature for the feature.
|
|
2662
|
+
* @maxItems 1
|
|
2663
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
2664
|
+
*/
|
|
2665
|
+
parent_part: string[];
|
|
2666
|
+
}
|
|
2667
|
+
/** parts-create-request-product */
|
|
2668
|
+
export type PartsCreateRequestProduct = object;
|
|
2669
|
+
/** parts-create-response */
|
|
2670
|
+
export interface PartsCreateResponse {
|
|
2671
|
+
part: Part;
|
|
2672
|
+
}
|
|
2673
|
+
/** parts-delete-request */
|
|
2674
|
+
export interface PartsDeleteRequest {
|
|
2675
|
+
/**
|
|
2676
|
+
* The ID of the part to delete.
|
|
2677
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
|
|
2678
|
+
*/
|
|
2679
|
+
id: string;
|
|
2680
|
+
}
|
|
2681
|
+
/** parts-delete-response */
|
|
2682
|
+
export type PartsDeleteResponse = object;
|
|
2683
|
+
/** parts-get-request */
|
|
2684
|
+
export interface PartsGetRequest {
|
|
2685
|
+
/**
|
|
2686
|
+
* The ID of the part to retrieve.
|
|
2687
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
|
|
2688
|
+
*/
|
|
2689
|
+
id: string;
|
|
2690
|
+
}
|
|
2691
|
+
/** parts-get-response */
|
|
2692
|
+
export interface PartsGetResponse {
|
|
2693
|
+
part: Part;
|
|
2694
|
+
}
|
|
2695
|
+
/** parts-list-request */
|
|
2696
|
+
export interface PartsListRequest {
|
|
2697
|
+
/**
|
|
2698
|
+
* Filters for parts created by any of these users.
|
|
2699
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
2700
|
+
*/
|
|
2701
|
+
created_by?: string[];
|
|
2702
|
+
/**
|
|
2703
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2704
|
+
* iteration starts from the beginning.
|
|
2705
|
+
*/
|
|
2706
|
+
cursor?: string;
|
|
2707
|
+
/**
|
|
2708
|
+
* The maximum number of parts to return. The default is '50'.
|
|
2709
|
+
* @format int32
|
|
2710
|
+
*/
|
|
2711
|
+
limit?: number;
|
|
2712
|
+
/**
|
|
2713
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2714
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2715
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2716
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2717
|
+
* always be returned in the specified sort-by order.
|
|
2718
|
+
*/
|
|
2719
|
+
mode?: ListMode;
|
|
2720
|
+
/** Filters for parts of the provided name(s). */
|
|
2721
|
+
name?: string[];
|
|
2722
|
+
/**
|
|
2723
|
+
* Filters for parts owned by any of these users.
|
|
2724
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
2725
|
+
*/
|
|
2726
|
+
owned_by?: string[];
|
|
2727
|
+
/** Filters for parts of the provided type(s). */
|
|
2728
|
+
type?: PartType[];
|
|
2729
|
+
}
|
|
2730
|
+
/** parts-list-response */
|
|
2731
|
+
export interface PartsListResponse {
|
|
2732
|
+
/**
|
|
2733
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
2734
|
+
* sort order. If not set, then no later elements exist.
|
|
2735
|
+
*/
|
|
2736
|
+
next_cursor?: string;
|
|
2737
|
+
/** The list of parts. */
|
|
2738
|
+
parts: Part[];
|
|
2739
|
+
/**
|
|
2740
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
2741
|
+
* sort order. If not set, then no prior elements exist.
|
|
2742
|
+
*/
|
|
2743
|
+
prev_cursor?: string;
|
|
2744
|
+
}
|
|
2745
|
+
/** parts-update-request */
|
|
2746
|
+
export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUpdateRequestEnhancement | PartsUpdateRequestFeature | PartsUpdateRequestProduct) & {
|
|
2747
|
+
artifacts?: PartsUpdateRequestArtifacts;
|
|
2748
|
+
/** Custom fields. */
|
|
2749
|
+
custom_fields?: object;
|
|
2750
|
+
/**
|
|
2751
|
+
* The custom schema fragments to use.
|
|
2752
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
2753
|
+
*/
|
|
2754
|
+
custom_schema_fragments?: string[];
|
|
2755
|
+
/** The updated description of the part. */
|
|
2756
|
+
description?: string;
|
|
2757
|
+
/**
|
|
2758
|
+
* The ID of the part to update.
|
|
2759
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
|
|
2760
|
+
*/
|
|
2761
|
+
id: string;
|
|
2762
|
+
/** The updated name of the part. */
|
|
2763
|
+
name?: string;
|
|
2764
|
+
owned_by?: PartsUpdateRequestOwnedBy;
|
|
2765
|
+
type?: PartType;
|
|
2766
|
+
};
|
|
2767
|
+
/** parts-update-request-artifacts */
|
|
2768
|
+
export interface PartsUpdateRequestArtifacts {
|
|
2769
|
+
/**
|
|
2770
|
+
* Sets the artifacts to the provided IDs.
|
|
2771
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
2772
|
+
*/
|
|
2773
|
+
set?: string[];
|
|
2774
|
+
}
|
|
2775
|
+
/** parts-update-request-capability */
|
|
2776
|
+
export type PartsUpdateRequestCapability = object;
|
|
2777
|
+
/** parts-update-request-enhancement */
|
|
2778
|
+
export interface PartsUpdateRequestEnhancement {
|
|
2779
|
+
/**
|
|
2780
|
+
* Updates the target close date of the enhancement.
|
|
2781
|
+
* @format date-time
|
|
2782
|
+
*/
|
|
2783
|
+
target_close_date?: string;
|
|
2784
|
+
}
|
|
2785
|
+
/** parts-update-request-feature */
|
|
2786
|
+
export type PartsUpdateRequestFeature = object;
|
|
2787
|
+
/** parts-update-request-owned-by */
|
|
2788
|
+
export interface PartsUpdateRequestOwnedBy {
|
|
2789
|
+
/**
|
|
2790
|
+
* Sets the owner IDs to the provided user IDs. This must not be
|
|
2791
|
+
* empty.
|
|
2792
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
2793
|
+
*/
|
|
2794
|
+
set?: string[];
|
|
2795
|
+
}
|
|
2796
|
+
/** parts-update-request-product */
|
|
2797
|
+
export type PartsUpdateRequestProduct = object;
|
|
2798
|
+
/** parts-update-response */
|
|
2799
|
+
export interface PartsUpdateResponse {
|
|
2800
|
+
part: Part;
|
|
2801
|
+
}
|
|
2610
2802
|
/** product */
|
|
2611
2803
|
export type Product = PartBase;
|
|
2612
2804
|
/** product-summary */
|
|
@@ -4925,7 +5117,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
4925
5117
|
* Updates the timestamp for when the work is expected to be complete.
|
|
4926
5118
|
* @format date-time
|
|
4927
5119
|
*/
|
|
4928
|
-
target_close_date?: string;
|
|
5120
|
+
target_close_date?: string | null;
|
|
4929
5121
|
/** Updated title of the work object, or unchanged if not provided. */
|
|
4930
5122
|
title?: string;
|
|
4931
5123
|
type?: WorkType;
|
|
@@ -6144,6 +6336,105 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6144
6336
|
* @secure
|
|
6145
6337
|
*/
|
|
6146
6338
|
orgSchedulesUpdate: (data: OrgSchedulesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesUpdateResponse, any>>;
|
|
6339
|
+
/**
|
|
6340
|
+
* @description Creates new [part](https://devrev.ai/docs/product/parts).
|
|
6341
|
+
*
|
|
6342
|
+
* @tags parts
|
|
6343
|
+
* @name PartsCreate
|
|
6344
|
+
* @request POST:/parts.create
|
|
6345
|
+
* @secure
|
|
6346
|
+
*/
|
|
6347
|
+
partsCreate: (data: PartsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsCreateResponse, any>>;
|
|
6348
|
+
/**
|
|
6349
|
+
* @description Deletes a [part](https://devrev.ai/docs/product/parts).
|
|
6350
|
+
*
|
|
6351
|
+
* @tags parts
|
|
6352
|
+
* @name PartsDelete
|
|
6353
|
+
* @request POST:/parts.delete
|
|
6354
|
+
* @secure
|
|
6355
|
+
*/
|
|
6356
|
+
partsDelete: (data: PartsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
6357
|
+
/**
|
|
6358
|
+
* @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
|
|
6359
|
+
*
|
|
6360
|
+
* @tags parts
|
|
6361
|
+
* @name PartsGet
|
|
6362
|
+
* @request GET:/parts.get
|
|
6363
|
+
* @secure
|
|
6364
|
+
*/
|
|
6365
|
+
partsGet: (query: {
|
|
6366
|
+
/**
|
|
6367
|
+
* The ID of the part to retrieve.
|
|
6368
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
|
|
6369
|
+
*/
|
|
6370
|
+
id: string;
|
|
6371
|
+
}, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any>>;
|
|
6372
|
+
/**
|
|
6373
|
+
* @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
|
|
6374
|
+
*
|
|
6375
|
+
* @tags parts
|
|
6376
|
+
* @name PartsGetPost
|
|
6377
|
+
* @request POST:/parts.get
|
|
6378
|
+
* @secure
|
|
6379
|
+
*/
|
|
6380
|
+
partsGetPost: (data: PartsGetRequest, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any>>;
|
|
6381
|
+
/**
|
|
6382
|
+
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
6383
|
+
*
|
|
6384
|
+
* @tags parts
|
|
6385
|
+
* @name PartsList
|
|
6386
|
+
* @request GET:/parts.list
|
|
6387
|
+
* @secure
|
|
6388
|
+
*/
|
|
6389
|
+
partsList: (query?: {
|
|
6390
|
+
/**
|
|
6391
|
+
* Filters for parts created by any of these users.
|
|
6392
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
6393
|
+
*/
|
|
6394
|
+
created_by?: string[];
|
|
6395
|
+
/**
|
|
6396
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
6397
|
+
* starts from the beginning.
|
|
6398
|
+
*/
|
|
6399
|
+
cursor?: string;
|
|
6400
|
+
/**
|
|
6401
|
+
* The maximum number of parts to return. The default is '50'.
|
|
6402
|
+
* @format int32
|
|
6403
|
+
*/
|
|
6404
|
+
limit?: number;
|
|
6405
|
+
/**
|
|
6406
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
6407
|
+
* used.
|
|
6408
|
+
*/
|
|
6409
|
+
mode?: ListMode;
|
|
6410
|
+
/** Filters for parts of the provided name(s). */
|
|
6411
|
+
name?: string[];
|
|
6412
|
+
/**
|
|
6413
|
+
* Filters for parts owned by any of these users.
|
|
6414
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
6415
|
+
*/
|
|
6416
|
+
owned_by?: string[];
|
|
6417
|
+
/** Filters for parts of the provided type(s). */
|
|
6418
|
+
type?: PartType[];
|
|
6419
|
+
}, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
|
|
6420
|
+
/**
|
|
6421
|
+
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
6422
|
+
*
|
|
6423
|
+
* @tags parts
|
|
6424
|
+
* @name PartsListPost
|
|
6425
|
+
* @request POST:/parts.list
|
|
6426
|
+
* @secure
|
|
6427
|
+
*/
|
|
6428
|
+
partsListPost: (data: PartsListRequest, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
|
|
6429
|
+
/**
|
|
6430
|
+
* @description Updates a [part's](https://devrev.ai/docs/product/parts) information.
|
|
6431
|
+
*
|
|
6432
|
+
* @tags parts
|
|
6433
|
+
* @name PartsUpdate
|
|
6434
|
+
* @request POST:/parts.update
|
|
6435
|
+
* @secure
|
|
6436
|
+
*/
|
|
6437
|
+
partsUpdate: (data: PartsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsUpdateResponse, any>>;
|
|
6147
6438
|
/**
|
|
6148
6439
|
* @description Creates a Rev organization in the authenticated user's Dev organization.
|
|
6149
6440
|
*
|
|
@@ -1188,6 +1188,69 @@ class Api extends HttpClient {
|
|
|
1188
1188
|
* @secure
|
|
1189
1189
|
*/
|
|
1190
1190
|
this.orgSchedulesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1191
|
+
/**
|
|
1192
|
+
* @description Creates new [part](https://devrev.ai/docs/product/parts).
|
|
1193
|
+
*
|
|
1194
|
+
* @tags parts
|
|
1195
|
+
* @name PartsCreate
|
|
1196
|
+
* @request POST:/parts.create
|
|
1197
|
+
* @secure
|
|
1198
|
+
*/
|
|
1199
|
+
this.partsCreate = (data, params = {}) => this.request(Object.assign({ path: `/parts.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1200
|
+
/**
|
|
1201
|
+
* @description Deletes a [part](https://devrev.ai/docs/product/parts).
|
|
1202
|
+
*
|
|
1203
|
+
* @tags parts
|
|
1204
|
+
* @name PartsDelete
|
|
1205
|
+
* @request POST:/parts.delete
|
|
1206
|
+
* @secure
|
|
1207
|
+
*/
|
|
1208
|
+
this.partsDelete = (data, params = {}) => this.request(Object.assign({ path: `/parts.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1209
|
+
/**
|
|
1210
|
+
* @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
|
|
1211
|
+
*
|
|
1212
|
+
* @tags parts
|
|
1213
|
+
* @name PartsGet
|
|
1214
|
+
* @request GET:/parts.get
|
|
1215
|
+
* @secure
|
|
1216
|
+
*/
|
|
1217
|
+
this.partsGet = (query, params = {}) => this.request(Object.assign({ path: `/parts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1218
|
+
/**
|
|
1219
|
+
* @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
|
|
1220
|
+
*
|
|
1221
|
+
* @tags parts
|
|
1222
|
+
* @name PartsGetPost
|
|
1223
|
+
* @request POST:/parts.get
|
|
1224
|
+
* @secure
|
|
1225
|
+
*/
|
|
1226
|
+
this.partsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/parts.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1227
|
+
/**
|
|
1228
|
+
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
1229
|
+
*
|
|
1230
|
+
* @tags parts
|
|
1231
|
+
* @name PartsList
|
|
1232
|
+
* @request GET:/parts.list
|
|
1233
|
+
* @secure
|
|
1234
|
+
*/
|
|
1235
|
+
this.partsList = (query, params = {}) => this.request(Object.assign({ path: `/parts.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
1236
|
+
/**
|
|
1237
|
+
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
1238
|
+
*
|
|
1239
|
+
* @tags parts
|
|
1240
|
+
* @name PartsListPost
|
|
1241
|
+
* @request POST:/parts.list
|
|
1242
|
+
* @secure
|
|
1243
|
+
*/
|
|
1244
|
+
this.partsListPost = (data, params = {}) => this.request(Object.assign({ path: `/parts.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1245
|
+
/**
|
|
1246
|
+
* @description Updates a [part's](https://devrev.ai/docs/product/parts) information.
|
|
1247
|
+
*
|
|
1248
|
+
* @tags parts
|
|
1249
|
+
* @name PartsUpdate
|
|
1250
|
+
* @request POST:/parts.update
|
|
1251
|
+
* @secure
|
|
1252
|
+
*/
|
|
1253
|
+
this.partsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/parts.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1191
1254
|
/**
|
|
1192
1255
|
* @description Creates a Rev organization in the authenticated user's Dev organization.
|
|
1193
1256
|
*
|
|
@@ -2029,7 +2029,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
2029
2029
|
* Updates the timestamp for when the work is expected to be complete.
|
|
2030
2030
|
* @format date-time
|
|
2031
2031
|
*/
|
|
2032
|
-
target_close_date?: string;
|
|
2032
|
+
target_close_date?: string | null;
|
|
2033
2033
|
/** Updated title of the work object, or unchanged if not provided. */
|
|
2034
2034
|
title?: string;
|
|
2035
2035
|
type?: WorkType;
|
|
@@ -2592,6 +2592,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2592
2592
|
* used.
|
|
2593
2593
|
*/
|
|
2594
2594
|
mode?: ListMode;
|
|
2595
|
+
/** Filters for tags with the provided names. */
|
|
2596
|
+
name?: string[];
|
|
2597
|
+
/** Fields to sort tags by and the direction to sort them. */
|
|
2598
|
+
sort_by?: string[];
|
|
2595
2599
|
}, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any>>;
|
|
2596
2600
|
/**
|
|
2597
2601
|
* @description Updates a tag's information.
|