@devrev/typescript-sdk 1.1.61 → 1.1.62
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.
|
@@ -1267,6 +1267,12 @@ export type ArticlesDeleteResponse = object;
|
|
|
1267
1267
|
* The request to get an article.
|
|
1268
1268
|
*/
|
|
1269
1269
|
export interface ArticlesGetRequest {
|
|
1270
|
+
/**
|
|
1271
|
+
* Optional Dev Org ID for the unauthenticated user.
|
|
1272
|
+
* @format id
|
|
1273
|
+
* @example "DEV-AbCdEfGh"
|
|
1274
|
+
*/
|
|
1275
|
+
dev_org?: string;
|
|
1270
1276
|
/**
|
|
1271
1277
|
* The ID of the required article.
|
|
1272
1278
|
* @format id
|
|
@@ -1314,6 +1320,12 @@ export interface ArticlesListRequest {
|
|
|
1314
1320
|
* @format text
|
|
1315
1321
|
*/
|
|
1316
1322
|
cursor?: string;
|
|
1323
|
+
/**
|
|
1324
|
+
* Optional Dev Org ID for the unauthenticated user.
|
|
1325
|
+
* @format id
|
|
1326
|
+
* @example "DEV-AbCdEfGh"
|
|
1327
|
+
*/
|
|
1328
|
+
dev_org?: string;
|
|
1317
1329
|
/**
|
|
1318
1330
|
* The maximum number of articles to return. The default is '50'.
|
|
1319
1331
|
* @format int32
|
|
@@ -6869,6 +6881,12 @@ export type DirectoriesDeleteResponse = object;
|
|
|
6869
6881
|
* The request to get a directory.
|
|
6870
6882
|
*/
|
|
6871
6883
|
export interface DirectoriesGetRequest {
|
|
6884
|
+
/**
|
|
6885
|
+
* Optional Dev Org ID for the unauthenticated user.
|
|
6886
|
+
* @format id
|
|
6887
|
+
* @example "DEV-AbCdEfGh"
|
|
6888
|
+
*/
|
|
6889
|
+
dev_org?: string;
|
|
6872
6890
|
/**
|
|
6873
6891
|
* The ID of the requested directory.
|
|
6874
6892
|
* @format id
|
|
@@ -6898,6 +6916,12 @@ export interface DirectoriesListRequest {
|
|
|
6898
6916
|
* @format text
|
|
6899
6917
|
*/
|
|
6900
6918
|
cursor?: string;
|
|
6919
|
+
/**
|
|
6920
|
+
* Optional Dev Org ID for the unauthenticated user.
|
|
6921
|
+
* @format id
|
|
6922
|
+
* @example "DEV-AbCdEfGh"
|
|
6923
|
+
*/
|
|
6924
|
+
dev_org?: string;
|
|
6901
6925
|
/**
|
|
6902
6926
|
* The maximum number of directories to return. The default is '50'.
|
|
6903
6927
|
* @format int32
|
|
@@ -10834,7 +10858,7 @@ export interface MeetingsCreateRequest {
|
|
|
10834
10858
|
* @format date-time
|
|
10835
10859
|
* @example "2023-01-01T12:00:00.000Z"
|
|
10836
10860
|
*/
|
|
10837
|
-
scheduled_date
|
|
10861
|
+
scheduled_date?: string;
|
|
10838
10862
|
/** The state of meeting. */
|
|
10839
10863
|
state: MeetingState;
|
|
10840
10864
|
/** Tags associated with the meeting. */
|
|
@@ -19486,6 +19510,11 @@ export type WebCrawlerJob = AtomBase & {
|
|
|
19486
19510
|
state?: WebCrawlerJobState;
|
|
19487
19511
|
/** URLs to add to the seed set of URLs to crawl from. */
|
|
19488
19512
|
urls?: string[];
|
|
19513
|
+
/**
|
|
19514
|
+
* User agent to use for crawling websites in this job.
|
|
19515
|
+
* @format text
|
|
19516
|
+
*/
|
|
19517
|
+
user_agent?: string;
|
|
19489
19518
|
};
|
|
19490
19519
|
/** State of the web crawler job. */
|
|
19491
19520
|
export declare enum WebCrawlerJobState {
|
|
@@ -19584,6 +19613,12 @@ export interface WebCrawlerJobsCreateRequest {
|
|
|
19584
19613
|
sitemap_urls?: string[];
|
|
19585
19614
|
/** The list of URLs to crawl. */
|
|
19586
19615
|
urls?: string[];
|
|
19616
|
+
/**
|
|
19617
|
+
* User agent to use for crawling websites in this job.
|
|
19618
|
+
* @format text
|
|
19619
|
+
* @maxLength 1024
|
|
19620
|
+
*/
|
|
19621
|
+
user_agent?: string;
|
|
19587
19622
|
}
|
|
19588
19623
|
/**
|
|
19589
19624
|
* web-crawler-jobs-create-response
|
|
@@ -21946,6 +21981,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21946
21981
|
* @example "ARTICLE-12345"
|
|
21947
21982
|
*/
|
|
21948
21983
|
id: string;
|
|
21984
|
+
/**
|
|
21985
|
+
* Optional Dev Org ID for the unauthenticated user.
|
|
21986
|
+
* @format id
|
|
21987
|
+
* @example "DEV-AbCdEfGh"
|
|
21988
|
+
*/
|
|
21989
|
+
dev_org?: string;
|
|
21949
21990
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
|
|
21950
21991
|
/**
|
|
21951
21992
|
* @description Gets an article.
|
|
@@ -21995,6 +22036,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21995
22036
|
* @format text
|
|
21996
22037
|
*/
|
|
21997
22038
|
cursor?: string;
|
|
22039
|
+
/**
|
|
22040
|
+
* Optional Dev Org ID for the unauthenticated user.
|
|
22041
|
+
* @format id
|
|
22042
|
+
* @example "DEV-AbCdEfGh"
|
|
22043
|
+
*/
|
|
22044
|
+
dev_org?: string;
|
|
21998
22045
|
/**
|
|
21999
22046
|
* The maximum number of articles to return. The default is '50'.
|
|
22000
22047
|
* @format int32
|
|
@@ -23530,6 +23577,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23530
23577
|
* @format id
|
|
23531
23578
|
*/
|
|
23532
23579
|
id: string;
|
|
23580
|
+
/**
|
|
23581
|
+
* Optional Dev Org ID for the unauthenticated user.
|
|
23582
|
+
* @format id
|
|
23583
|
+
* @example "DEV-AbCdEfGh"
|
|
23584
|
+
*/
|
|
23585
|
+
dev_org?: string;
|
|
23533
23586
|
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesGetResponse, any>>;
|
|
23534
23587
|
/**
|
|
23535
23588
|
* @description Gets the specified directory.
|
|
@@ -23562,6 +23615,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23562
23615
|
* @format text
|
|
23563
23616
|
*/
|
|
23564
23617
|
cursor?: string;
|
|
23618
|
+
/**
|
|
23619
|
+
* Optional Dev Org ID for the unauthenticated user.
|
|
23620
|
+
* @format id
|
|
23621
|
+
* @example "DEV-AbCdEfGh"
|
|
23622
|
+
*/
|
|
23623
|
+
dev_org?: string;
|
|
23565
23624
|
/**
|
|
23566
23625
|
* The maximum number of directories to return. The default is '50'.
|
|
23567
23626
|
* @format int32
|
|
@@ -755,6 +755,12 @@ export type ArticlesDeleteResponse = object;
|
|
|
755
755
|
* The request to get an article.
|
|
756
756
|
*/
|
|
757
757
|
export interface ArticlesGetRequest {
|
|
758
|
+
/**
|
|
759
|
+
* Optional Dev Org ID for the unauthenticated user.
|
|
760
|
+
* @format id
|
|
761
|
+
* @example "DEV-AbCdEfGh"
|
|
762
|
+
*/
|
|
763
|
+
dev_org?: string;
|
|
758
764
|
/**
|
|
759
765
|
* The ID of the required article.
|
|
760
766
|
* @format id
|
|
@@ -802,6 +808,12 @@ export interface ArticlesListRequest {
|
|
|
802
808
|
* @format text
|
|
803
809
|
*/
|
|
804
810
|
cursor?: string;
|
|
811
|
+
/**
|
|
812
|
+
* Optional Dev Org ID for the unauthenticated user.
|
|
813
|
+
* @format id
|
|
814
|
+
* @example "DEV-AbCdEfGh"
|
|
815
|
+
*/
|
|
816
|
+
dev_org?: string;
|
|
805
817
|
/**
|
|
806
818
|
* The maximum number of articles to return. The default is '50'.
|
|
807
819
|
* @format int32
|
|
@@ -4113,6 +4125,12 @@ export type DirectoriesDeleteResponse = object;
|
|
|
4113
4125
|
* The request to get a directory.
|
|
4114
4126
|
*/
|
|
4115
4127
|
export interface DirectoriesGetRequest {
|
|
4128
|
+
/**
|
|
4129
|
+
* Optional Dev Org ID for the unauthenticated user.
|
|
4130
|
+
* @format id
|
|
4131
|
+
* @example "DEV-AbCdEfGh"
|
|
4132
|
+
*/
|
|
4133
|
+
dev_org?: string;
|
|
4116
4134
|
/**
|
|
4117
4135
|
* The ID of the requested directory.
|
|
4118
4136
|
* @format id
|
|
@@ -4142,6 +4160,12 @@ export interface DirectoriesListRequest {
|
|
|
4142
4160
|
* @format text
|
|
4143
4161
|
*/
|
|
4144
4162
|
cursor?: string;
|
|
4163
|
+
/**
|
|
4164
|
+
* Optional Dev Org ID for the unauthenticated user.
|
|
4165
|
+
* @format id
|
|
4166
|
+
* @example "DEV-AbCdEfGh"
|
|
4167
|
+
*/
|
|
4168
|
+
dev_org?: string;
|
|
4145
4169
|
/**
|
|
4146
4170
|
* The maximum number of directories to return. The default is '50'.
|
|
4147
4171
|
* @format int32
|
|
@@ -6235,7 +6259,7 @@ export interface MeetingsCreateRequest {
|
|
|
6235
6259
|
* @format date-time
|
|
6236
6260
|
* @example "2023-01-01T12:00:00.000Z"
|
|
6237
6261
|
*/
|
|
6238
|
-
scheduled_date
|
|
6262
|
+
scheduled_date?: string;
|
|
6239
6263
|
/** The state of meeting. */
|
|
6240
6264
|
state: MeetingState;
|
|
6241
6265
|
/** Tags associated with the meeting. */
|
|
@@ -11005,6 +11029,11 @@ export type WebCrawlerJob = AtomBase & {
|
|
|
11005
11029
|
state?: WebCrawlerJobState;
|
|
11006
11030
|
/** URLs to add to the seed set of URLs to crawl from. */
|
|
11007
11031
|
urls?: string[];
|
|
11032
|
+
/**
|
|
11033
|
+
* User agent to use for crawling websites in this job.
|
|
11034
|
+
* @format text
|
|
11035
|
+
*/
|
|
11036
|
+
user_agent?: string;
|
|
11008
11037
|
};
|
|
11009
11038
|
/** State of the web crawler job. */
|
|
11010
11039
|
export declare enum WebCrawlerJobState {
|
|
@@ -11103,6 +11132,12 @@ export interface WebCrawlerJobsCreateRequest {
|
|
|
11103
11132
|
sitemap_urls?: string[];
|
|
11104
11133
|
/** The list of URLs to crawl. */
|
|
11105
11134
|
urls?: string[];
|
|
11135
|
+
/**
|
|
11136
|
+
* User agent to use for crawling websites in this job.
|
|
11137
|
+
* @format text
|
|
11138
|
+
* @maxLength 1024
|
|
11139
|
+
*/
|
|
11140
|
+
user_agent?: string;
|
|
11106
11141
|
}
|
|
11107
11142
|
/**
|
|
11108
11143
|
* web-crawler-jobs-create-response
|
|
@@ -11934,6 +11969,8 @@ export interface WorksListRequest {
|
|
|
11934
11969
|
* @example ["DEVU-12345"]
|
|
11935
11970
|
*/
|
|
11936
11971
|
reported_by?: string[];
|
|
11972
|
+
/** Fields to sort the works by and the direction to sort them. */
|
|
11973
|
+
sort_by?: string[];
|
|
11937
11974
|
/** The filter for stages. */
|
|
11938
11975
|
stage?: StageFilter;
|
|
11939
11976
|
staged_info?: StagedInfoFilter;
|
|
@@ -12530,6 +12567,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12530
12567
|
* @example "ARTICLE-12345"
|
|
12531
12568
|
*/
|
|
12532
12569
|
id: string;
|
|
12570
|
+
/**
|
|
12571
|
+
* Optional Dev Org ID for the unauthenticated user.
|
|
12572
|
+
* @format id
|
|
12573
|
+
* @example "DEV-AbCdEfGh"
|
|
12574
|
+
*/
|
|
12575
|
+
dev_org?: string;
|
|
12533
12576
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
|
|
12534
12577
|
/**
|
|
12535
12578
|
* @description Gets an article.
|
|
@@ -12579,6 +12622,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12579
12622
|
* @format text
|
|
12580
12623
|
*/
|
|
12581
12624
|
cursor?: string;
|
|
12625
|
+
/**
|
|
12626
|
+
* Optional Dev Org ID for the unauthenticated user.
|
|
12627
|
+
* @format id
|
|
12628
|
+
* @example "DEV-AbCdEfGh"
|
|
12629
|
+
*/
|
|
12630
|
+
dev_org?: string;
|
|
12582
12631
|
/**
|
|
12583
12632
|
* The maximum number of articles to return. The default is '50'.
|
|
12584
12633
|
* @format int32
|
|
@@ -13677,6 +13726,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13677
13726
|
* @format id
|
|
13678
13727
|
*/
|
|
13679
13728
|
id: string;
|
|
13729
|
+
/**
|
|
13730
|
+
* Optional Dev Org ID for the unauthenticated user.
|
|
13731
|
+
* @format id
|
|
13732
|
+
* @example "DEV-AbCdEfGh"
|
|
13733
|
+
*/
|
|
13734
|
+
dev_org?: string;
|
|
13680
13735
|
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesGetResponse, any>>;
|
|
13681
13736
|
/**
|
|
13682
13737
|
* @description Gets the specified directory.
|
|
@@ -13709,6 +13764,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13709
13764
|
* @format text
|
|
13710
13765
|
*/
|
|
13711
13766
|
cursor?: string;
|
|
13767
|
+
/**
|
|
13768
|
+
* Optional Dev Org ID for the unauthenticated user.
|
|
13769
|
+
* @format id
|
|
13770
|
+
* @example "DEV-AbCdEfGh"
|
|
13771
|
+
*/
|
|
13772
|
+
dev_org?: string;
|
|
13712
13773
|
/**
|
|
13713
13774
|
* The maximum number of directories to return. The default is '50'.
|
|
13714
13775
|
* @format int32
|
|
@@ -16276,6 +16337,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16276
16337
|
* @example ["DEVU-12345"]
|
|
16277
16338
|
*/
|
|
16278
16339
|
reported_by?: string[];
|
|
16340
|
+
/** Fields to sort the works by and the direction to sort them. */
|
|
16341
|
+
sort_by?: string[];
|
|
16279
16342
|
/** Filters for records in the provided stage(s) by name. */
|
|
16280
16343
|
'stage.name'?: string[];
|
|
16281
16344
|
/** Filters for issues that are staged. */
|