@devrev/typescript-sdk 1.1.60 → 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.
|
@@ -440,7 +440,9 @@ export interface AggregatedSchema {
|
|
|
440
440
|
/** aggregated-schema-get-request */
|
|
441
441
|
export interface AggregatedSchemaGetRequest {
|
|
442
442
|
/** The list of custom schema fragment DONs which are to be aggregated. */
|
|
443
|
-
custom_schema_fragment_ids
|
|
443
|
+
custom_schema_fragment_ids?: string[];
|
|
444
|
+
/** Custom schemas described using identifiers */
|
|
445
|
+
custom_schema_spec?: CustomSchemaSpecForRead;
|
|
444
446
|
/** Whether the leaf type corresponds to a custom object. */
|
|
445
447
|
is_custom_leaf_type?: boolean;
|
|
446
448
|
/**
|
|
@@ -664,6 +666,14 @@ export interface AiAgentEventSourceTarget {
|
|
|
664
666
|
*/
|
|
665
667
|
event_source: string;
|
|
666
668
|
}
|
|
669
|
+
/**
|
|
670
|
+
* ai-agent-event-suggestions
|
|
671
|
+
* A list of suggestions generated for the AI agent event.
|
|
672
|
+
*/
|
|
673
|
+
export interface AiAgentEventSuggestions {
|
|
674
|
+
/** The suggestions generated for the AI agent event. */
|
|
675
|
+
suggestions: AiAgentSuggestion[];
|
|
676
|
+
}
|
|
667
677
|
/**
|
|
668
678
|
* ai-agent-events-execute-async-request
|
|
669
679
|
* Request object to consume an input event and execute asynchronously.
|
|
@@ -724,6 +734,17 @@ export interface AiAgentMessageGenerationStarted {
|
|
|
724
734
|
}
|
|
725
735
|
/** ai-agent-session-summary */
|
|
726
736
|
export type AiAgentSessionSummary = AtomBaseSummary;
|
|
737
|
+
/**
|
|
738
|
+
* ai-agent-suggestion
|
|
739
|
+
* A suggestion generated for the AI agent event.
|
|
740
|
+
*/
|
|
741
|
+
export interface AiAgentSuggestion {
|
|
742
|
+
/**
|
|
743
|
+
* The text of the suggestion.
|
|
744
|
+
* @format text
|
|
745
|
+
*/
|
|
746
|
+
suggestion: string;
|
|
747
|
+
}
|
|
727
748
|
/**
|
|
728
749
|
* ai-agent-webhook-target
|
|
729
750
|
* The source of the event to send notifications to, of asynchronous
|
|
@@ -1246,6 +1267,12 @@ export type ArticlesDeleteResponse = object;
|
|
|
1246
1267
|
* The request to get an article.
|
|
1247
1268
|
*/
|
|
1248
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;
|
|
1249
1276
|
/**
|
|
1250
1277
|
* The ID of the required article.
|
|
1251
1278
|
* @format id
|
|
@@ -1293,6 +1320,12 @@ export interface ArticlesListRequest {
|
|
|
1293
1320
|
* @format text
|
|
1294
1321
|
*/
|
|
1295
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;
|
|
1296
1329
|
/**
|
|
1297
1330
|
* The maximum number of articles to return. The default is '50'.
|
|
1298
1331
|
* @format int32
|
|
@@ -4868,13 +4901,18 @@ export interface CustomLinkTypeCreateRequest {
|
|
|
4868
4901
|
* @format text
|
|
4869
4902
|
*/
|
|
4870
4903
|
backward_name: string;
|
|
4871
|
-
/**
|
|
4904
|
+
/**
|
|
4905
|
+
* Whether the link type is deprecated.
|
|
4906
|
+
* @deprecated
|
|
4907
|
+
*/
|
|
4872
4908
|
deprecated?: boolean;
|
|
4873
4909
|
/**
|
|
4874
4910
|
* The name of the link in the forward direction.
|
|
4875
4911
|
* @format text
|
|
4876
4912
|
*/
|
|
4877
4913
|
forward_name: string;
|
|
4914
|
+
/** Whether the link type is deprecated. */
|
|
4915
|
+
is_deprecated?: boolean;
|
|
4878
4916
|
/**
|
|
4879
4917
|
* The name of the custom link type.
|
|
4880
4918
|
* @format text
|
|
@@ -4914,8 +4952,13 @@ export interface CustomLinkTypeListRequest {
|
|
|
4914
4952
|
* @format text
|
|
4915
4953
|
*/
|
|
4916
4954
|
cursor?: string;
|
|
4917
|
-
/**
|
|
4955
|
+
/**
|
|
4956
|
+
* Whether only deprecated link types should be filtered.
|
|
4957
|
+
* @deprecated
|
|
4958
|
+
*/
|
|
4918
4959
|
deprecated?: boolean;
|
|
4960
|
+
/** Whether only deprecated link types should be filtered. */
|
|
4961
|
+
is_deprecated?: boolean;
|
|
4919
4962
|
/**
|
|
4920
4963
|
* The maximum number of items.
|
|
4921
4964
|
* @format int32
|
|
@@ -4934,7 +4977,11 @@ export interface CustomLinkTypeListRequest {
|
|
|
4934
4977
|
/** The list of fields to sort the items by and how to sort them. */
|
|
4935
4978
|
sort_by?: string[];
|
|
4936
4979
|
source_types?: LinkDescriptorFilter;
|
|
4980
|
+
/** Types from which a link can be made. */
|
|
4981
|
+
source_types_v2?: LinkTargetDescriptor[];
|
|
4937
4982
|
target_types?: LinkDescriptorFilter;
|
|
4983
|
+
/** Types to which a link can be made. */
|
|
4984
|
+
target_types_v2?: LinkTargetDescriptor[];
|
|
4938
4985
|
}
|
|
4939
4986
|
/** custom-link-type-list-response */
|
|
4940
4987
|
export interface CustomLinkTypeListResponse {
|
|
@@ -4962,7 +5009,10 @@ export interface CustomLinkTypeUpdateRequest {
|
|
|
4962
5009
|
* @format text
|
|
4963
5010
|
*/
|
|
4964
5011
|
backward_name?: string;
|
|
4965
|
-
/**
|
|
5012
|
+
/**
|
|
5013
|
+
* Whether the link type is deprecated.
|
|
5014
|
+
* @deprecated
|
|
5015
|
+
*/
|
|
4966
5016
|
deprecated?: boolean;
|
|
4967
5017
|
/**
|
|
4968
5018
|
* The updated name of the link in the forward direction.
|
|
@@ -4974,13 +5024,19 @@ export interface CustomLinkTypeUpdateRequest {
|
|
|
4974
5024
|
* @format id
|
|
4975
5025
|
*/
|
|
4976
5026
|
id: string;
|
|
5027
|
+
/** Whether the link type is deprecated. */
|
|
5028
|
+
is_deprecated?: boolean;
|
|
4977
5029
|
/**
|
|
4978
5030
|
* The updated name of the custom link type.
|
|
4979
5031
|
* @format text
|
|
4980
5032
|
*/
|
|
4981
5033
|
name?: string;
|
|
4982
5034
|
source_types?: UpdateLinkTargetDescriptorList;
|
|
5035
|
+
/** Types from which a link can be made. */
|
|
5036
|
+
source_types_v2?: LinkTargetDescriptor[];
|
|
4983
5037
|
target_types?: UpdateLinkTargetDescriptorList;
|
|
5038
|
+
/** Types to which a link can be made. */
|
|
5039
|
+
target_types_v2?: LinkTargetDescriptor[];
|
|
4984
5040
|
/**
|
|
4985
5041
|
* The updated tooltip of the custom link type.
|
|
4986
5042
|
* @format text
|
|
@@ -5117,6 +5173,8 @@ export interface CustomObjectsListRequest {
|
|
|
5117
5173
|
cursor?: string;
|
|
5118
5174
|
/** List of filters to apply. */
|
|
5119
5175
|
filter?: any[];
|
|
5176
|
+
/** List of filters to apply. */
|
|
5177
|
+
filters?: any[];
|
|
5120
5178
|
/**
|
|
5121
5179
|
* Leaf type to filter.
|
|
5122
5180
|
* @format text
|
|
@@ -5220,6 +5278,12 @@ export type CustomSchemaFragmentBase = AtomBase & {
|
|
|
5220
5278
|
fields?: SchemaFieldDescriptor[];
|
|
5221
5279
|
/** Type of the custom schema fragment. */
|
|
5222
5280
|
fragment_type?: CustomSchemaFragmentFragmentType;
|
|
5281
|
+
/**
|
|
5282
|
+
* Indicates if the fragment is deprecated. Modifications to this
|
|
5283
|
+
* field are done in-place and don't result in creation of a new
|
|
5284
|
+
* fragment in chain.
|
|
5285
|
+
*/
|
|
5286
|
+
is_deprecated?: boolean;
|
|
5223
5287
|
/**
|
|
5224
5288
|
* Leaf type this fragment applies to.
|
|
5225
5289
|
* @format text
|
|
@@ -5307,10 +5371,15 @@ export interface CustomSchemaFragmentsListRequest {
|
|
|
5307
5371
|
* @format text
|
|
5308
5372
|
*/
|
|
5309
5373
|
cursor?: string;
|
|
5310
|
-
/**
|
|
5374
|
+
/**
|
|
5375
|
+
* Whether only deprecated fragments should be filtered.
|
|
5376
|
+
* @deprecated
|
|
5377
|
+
*/
|
|
5311
5378
|
deprecated?: boolean;
|
|
5312
5379
|
/** Whether the leaf type corresponds to a custom object */
|
|
5313
5380
|
is_custom_leaf_type?: boolean;
|
|
5381
|
+
/** Whether the fragment has been deprecated. */
|
|
5382
|
+
is_deprecated?: boolean;
|
|
5314
5383
|
/** The list of leaf types. */
|
|
5315
5384
|
leaf_type?: string[];
|
|
5316
5385
|
/**
|
|
@@ -5367,7 +5436,10 @@ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAp
|
|
|
5367
5436
|
conditions?: CustomSchemaFragmentCondition[];
|
|
5368
5437
|
/** List of field names which are being dropped. */
|
|
5369
5438
|
deleted_fields?: string[];
|
|
5370
|
-
/**
|
|
5439
|
+
/**
|
|
5440
|
+
* Whether this fragment has been deprecated.
|
|
5441
|
+
* @deprecated
|
|
5442
|
+
*/
|
|
5371
5443
|
deprecated?: boolean;
|
|
5372
5444
|
/**
|
|
5373
5445
|
* The description of the custom schema fragment.
|
|
@@ -5378,6 +5450,8 @@ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAp
|
|
|
5378
5450
|
fields?: SchemaFieldDescriptor[];
|
|
5379
5451
|
/** Whether the leaf type corresponds to a custom object */
|
|
5380
5452
|
is_custom_leaf_type?: boolean;
|
|
5453
|
+
/** Whether this fragment has been deprecated. */
|
|
5454
|
+
is_deprecated?: boolean;
|
|
5381
5455
|
/**
|
|
5382
5456
|
* The leaf type this fragment applies to.
|
|
5383
5457
|
* @format text
|
|
@@ -5496,6 +5570,19 @@ export interface CustomSchemaSpecDrop {
|
|
|
5496
5570
|
*/
|
|
5497
5571
|
subtype?: boolean;
|
|
5498
5572
|
}
|
|
5573
|
+
/**
|
|
5574
|
+
* custom-schema-spec-for-read
|
|
5575
|
+
* Custom schemas described using identifiers
|
|
5576
|
+
*/
|
|
5577
|
+
export interface CustomSchemaSpecForRead {
|
|
5578
|
+
/** List of apps. */
|
|
5579
|
+
apps?: string[];
|
|
5580
|
+
/**
|
|
5581
|
+
* Name of the subtype.
|
|
5582
|
+
* @format text
|
|
5583
|
+
*/
|
|
5584
|
+
subtype?: string;
|
|
5585
|
+
}
|
|
5499
5586
|
/** custom-stage */
|
|
5500
5587
|
export type CustomStage = AtomBase & {
|
|
5501
5588
|
/**
|
|
@@ -6794,6 +6881,12 @@ export type DirectoriesDeleteResponse = object;
|
|
|
6794
6881
|
* The request to get a directory.
|
|
6795
6882
|
*/
|
|
6796
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;
|
|
6797
6890
|
/**
|
|
6798
6891
|
* The ID of the requested directory.
|
|
6799
6892
|
* @format id
|
|
@@ -6823,6 +6916,12 @@ export interface DirectoriesListRequest {
|
|
|
6823
6916
|
* @format text
|
|
6824
6917
|
*/
|
|
6825
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;
|
|
6826
6925
|
/**
|
|
6827
6926
|
* The maximum number of directories to return. The default is '50'.
|
|
6828
6927
|
* @format int32
|
|
@@ -8035,7 +8134,7 @@ export interface EventAiAgentResponse {
|
|
|
8035
8134
|
* @format id
|
|
8036
8135
|
*/
|
|
8037
8136
|
agent: string;
|
|
8038
|
-
agent_response?: 'error' | 'message' | 'message_generation_started' | 'progress';
|
|
8137
|
+
agent_response?: 'error' | 'message' | 'message_generation_started' | 'progress' | 'suggestions';
|
|
8039
8138
|
/** The metadata given by client to be passed to the event source. */
|
|
8040
8139
|
client_metadata?: object;
|
|
8041
8140
|
/**
|
|
@@ -8066,6 +8165,8 @@ export interface EventAiAgentResponse {
|
|
|
8066
8165
|
* @format text
|
|
8067
8166
|
*/
|
|
8068
8167
|
session_object: string;
|
|
8168
|
+
/** A list of suggestions generated for the AI agent event. */
|
|
8169
|
+
suggestions?: AiAgentEventSuggestions;
|
|
8069
8170
|
}
|
|
8070
8171
|
/** event-conversation-created */
|
|
8071
8172
|
export interface EventConversationCreated {
|
|
@@ -10757,7 +10858,7 @@ export interface MeetingsCreateRequest {
|
|
|
10757
10858
|
* @format date-time
|
|
10758
10859
|
* @example "2023-01-01T12:00:00.000Z"
|
|
10759
10860
|
*/
|
|
10760
|
-
scheduled_date
|
|
10861
|
+
scheduled_date?: string;
|
|
10761
10862
|
/** The state of meeting. */
|
|
10762
10863
|
state: MeetingState;
|
|
10763
10864
|
/** Tags associated with the meeting. */
|
|
@@ -12263,6 +12364,8 @@ export interface PartsListRequest {
|
|
|
12263
12364
|
owned_by?: string[];
|
|
12264
12365
|
/** The filter for specifying parent part. */
|
|
12265
12366
|
parent_part?: ParentPartFilter;
|
|
12367
|
+
/** Filters for subtypes. */
|
|
12368
|
+
subtype?: string[];
|
|
12266
12369
|
/**
|
|
12267
12370
|
* Filters for part with any of the provided tags.
|
|
12268
12371
|
* @example ["TAG-12345"]
|
|
@@ -19407,6 +19510,11 @@ export type WebCrawlerJob = AtomBase & {
|
|
|
19407
19510
|
state?: WebCrawlerJobState;
|
|
19408
19511
|
/** URLs to add to the seed set of URLs to crawl from. */
|
|
19409
19512
|
urls?: string[];
|
|
19513
|
+
/**
|
|
19514
|
+
* User agent to use for crawling websites in this job.
|
|
19515
|
+
* @format text
|
|
19516
|
+
*/
|
|
19517
|
+
user_agent?: string;
|
|
19410
19518
|
};
|
|
19411
19519
|
/** State of the web crawler job. */
|
|
19412
19520
|
export declare enum WebCrawlerJobState {
|
|
@@ -19505,6 +19613,12 @@ export interface WebCrawlerJobsCreateRequest {
|
|
|
19505
19613
|
sitemap_urls?: string[];
|
|
19506
19614
|
/** The list of URLs to crawl. */
|
|
19507
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;
|
|
19508
19622
|
}
|
|
19509
19623
|
/**
|
|
19510
19624
|
* web-crawler-jobs-create-response
|
|
@@ -21867,6 +21981,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21867
21981
|
* @example "ARTICLE-12345"
|
|
21868
21982
|
*/
|
|
21869
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;
|
|
21870
21990
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
|
|
21871
21991
|
/**
|
|
21872
21992
|
* @description Gets an article.
|
|
@@ -21916,6 +22036,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21916
22036
|
* @format text
|
|
21917
22037
|
*/
|
|
21918
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;
|
|
21919
22045
|
/**
|
|
21920
22046
|
* The maximum number of articles to return. The default is '50'.
|
|
21921
22047
|
* @format int32
|
|
@@ -23063,6 +23189,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23063
23189
|
cursor?: string;
|
|
23064
23190
|
/** List of filters to apply. */
|
|
23065
23191
|
filter?: any[];
|
|
23192
|
+
/** List of filters to apply. */
|
|
23193
|
+
filters?: any[];
|
|
23066
23194
|
/**
|
|
23067
23195
|
* The maximum number of items.
|
|
23068
23196
|
* @format int32
|
|
@@ -23449,6 +23577,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23449
23577
|
* @format id
|
|
23450
23578
|
*/
|
|
23451
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;
|
|
23452
23586
|
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesGetResponse, any>>;
|
|
23453
23587
|
/**
|
|
23454
23588
|
* @description Gets the specified directory.
|
|
@@ -23481,6 +23615,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23481
23615
|
* @format text
|
|
23482
23616
|
*/
|
|
23483
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;
|
|
23484
23624
|
/**
|
|
23485
23625
|
* The maximum number of directories to return. The default is '50'.
|
|
23486
23626
|
* @format int32
|
|
@@ -24229,8 +24369,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24229
24369
|
* @format text
|
|
24230
24370
|
*/
|
|
24231
24371
|
cursor?: string;
|
|
24232
|
-
/**
|
|
24372
|
+
/**
|
|
24373
|
+
* Whether only deprecated link types should be filtered.
|
|
24374
|
+
* @deprecated
|
|
24375
|
+
*/
|
|
24233
24376
|
deprecated?: boolean;
|
|
24377
|
+
/** Whether only deprecated link types should be filtered. */
|
|
24378
|
+
is_deprecated?: boolean;
|
|
24234
24379
|
/**
|
|
24235
24380
|
* The maximum number of items.
|
|
24236
24381
|
* @format int32
|
|
@@ -24263,6 +24408,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24263
24408
|
*/
|
|
24264
24409
|
'source_types.link_descriptors.subtype'?: string;
|
|
24265
24410
|
/** True when the descriptor describes a custom leaf type. */
|
|
24411
|
+
'source_types_v2.is_custom_leaf_type'?: boolean;
|
|
24412
|
+
/**
|
|
24413
|
+
* Set to true when only the specified leaf type (no subtypes) is
|
|
24414
|
+
* allowed as a link target.
|
|
24415
|
+
*/
|
|
24416
|
+
'source_types_v2.leaf_only'?: boolean;
|
|
24417
|
+
/**
|
|
24418
|
+
* Leaf type of the target objects.
|
|
24419
|
+
* @format text
|
|
24420
|
+
*/
|
|
24421
|
+
'source_types_v2.leaf_type'?: string;
|
|
24422
|
+
/**
|
|
24423
|
+
* Specific subtype of the target objects.
|
|
24424
|
+
* @format text
|
|
24425
|
+
*/
|
|
24426
|
+
'source_types_v2.subtype'?: string;
|
|
24427
|
+
/** True when the descriptor describes a custom leaf type. */
|
|
24266
24428
|
'target_types.link_descriptors.is_custom_leaf_type'?: boolean;
|
|
24267
24429
|
/**
|
|
24268
24430
|
* Set to true when only the specified leaf type (no subtypes) is
|
|
@@ -24279,6 +24441,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24279
24441
|
* @format text
|
|
24280
24442
|
*/
|
|
24281
24443
|
'target_types.link_descriptors.subtype'?: string;
|
|
24444
|
+
/** True when the descriptor describes a custom leaf type. */
|
|
24445
|
+
'target_types_v2.is_custom_leaf_type'?: boolean;
|
|
24446
|
+
/**
|
|
24447
|
+
* Set to true when only the specified leaf type (no subtypes) is
|
|
24448
|
+
* allowed as a link target.
|
|
24449
|
+
*/
|
|
24450
|
+
'target_types_v2.leaf_only'?: boolean;
|
|
24451
|
+
/**
|
|
24452
|
+
* Leaf type of the target objects.
|
|
24453
|
+
* @format text
|
|
24454
|
+
*/
|
|
24455
|
+
'target_types_v2.leaf_type'?: string;
|
|
24456
|
+
/**
|
|
24457
|
+
* Specific subtype of the target objects.
|
|
24458
|
+
* @format text
|
|
24459
|
+
*/
|
|
24460
|
+
'target_types_v2.subtype'?: string;
|
|
24282
24461
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeListResponse, any>>;
|
|
24283
24462
|
/**
|
|
24284
24463
|
* @description Lists custom link types.
|
|
@@ -25145,6 +25324,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25145
25324
|
* @example ["PROD-12345"]
|
|
25146
25325
|
*/
|
|
25147
25326
|
'parent_part.parts'?: string[];
|
|
25327
|
+
/** Filters for subtypes. */
|
|
25328
|
+
subtype?: string[];
|
|
25148
25329
|
/**
|
|
25149
25330
|
* Filters for part with any of the provided tags.
|
|
25150
25331
|
* @example ["TAG-12345"]
|
|
@@ -25955,9 +26136,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25955
26136
|
* @request GET:/schemas.aggregated.get
|
|
25956
26137
|
* @secure
|
|
25957
26138
|
*/
|
|
25958
|
-
aggregatedSchemaGet: (query
|
|
26139
|
+
aggregatedSchemaGet: (query?: {
|
|
25959
26140
|
/** The list of custom schema fragment DONs which are to be aggregated. */
|
|
25960
|
-
custom_schema_fragment_ids
|
|
26141
|
+
custom_schema_fragment_ids?: string[];
|
|
26142
|
+
/** List of apps. */
|
|
26143
|
+
'custom_schema_spec.apps'?: string[];
|
|
26144
|
+
/**
|
|
26145
|
+
* Name of the subtype.
|
|
26146
|
+
* @format text
|
|
26147
|
+
*/
|
|
26148
|
+
'custom_schema_spec.subtype'?: string;
|
|
25961
26149
|
/** Whether the leaf type corresponds to a custom object. */
|
|
25962
26150
|
is_custom_leaf_type?: boolean;
|
|
25963
26151
|
/**
|
|
@@ -26026,10 +26214,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26026
26214
|
* @format text
|
|
26027
26215
|
*/
|
|
26028
26216
|
cursor?: string;
|
|
26029
|
-
/**
|
|
26217
|
+
/**
|
|
26218
|
+
* Whether only deprecated fragments should be filtered.
|
|
26219
|
+
* @deprecated
|
|
26220
|
+
*/
|
|
26030
26221
|
deprecated?: boolean;
|
|
26031
26222
|
/** Whether the leaf type corresponds to a custom object */
|
|
26032
26223
|
is_custom_leaf_type?: boolean;
|
|
26224
|
+
/** Whether the fragment has been deprecated. */
|
|
26225
|
+
is_deprecated?: boolean;
|
|
26033
26226
|
/** The list of leaf types. */
|
|
26034
26227
|
leaf_type?: string[];
|
|
26035
26228
|
/**
|
|
@@ -387,6 +387,14 @@ export interface AiAgentEventExecuteProgressSkillTriggered {
|
|
|
387
387
|
workflow?: WorkflowSummary;
|
|
388
388
|
workflow_run?: WorkflowRunSummary;
|
|
389
389
|
}
|
|
390
|
+
/**
|
|
391
|
+
* ai-agent-event-suggestions
|
|
392
|
+
* A list of suggestions generated for the AI agent event.
|
|
393
|
+
*/
|
|
394
|
+
export interface AiAgentEventSuggestions {
|
|
395
|
+
/** The suggestions generated for the AI agent event. */
|
|
396
|
+
suggestions: AiAgentSuggestion[];
|
|
397
|
+
}
|
|
390
398
|
/**
|
|
391
399
|
* ai-agent-message-generation-started
|
|
392
400
|
* Additional metadata to indicate that the message generation has
|
|
@@ -401,6 +409,17 @@ export interface AiAgentMessageGenerationStarted {
|
|
|
401
409
|
*/
|
|
402
410
|
request_id: string;
|
|
403
411
|
}
|
|
412
|
+
/**
|
|
413
|
+
* ai-agent-suggestion
|
|
414
|
+
* A suggestion generated for the AI agent event.
|
|
415
|
+
*/
|
|
416
|
+
export interface AiAgentSuggestion {
|
|
417
|
+
/**
|
|
418
|
+
* The text of the suggestion.
|
|
419
|
+
* @format text
|
|
420
|
+
*/
|
|
421
|
+
suggestion: string;
|
|
422
|
+
}
|
|
404
423
|
/**
|
|
405
424
|
* archetype-metric-target
|
|
406
425
|
* Metric with corresponding target values.
|
|
@@ -736,6 +755,12 @@ export type ArticlesDeleteResponse = object;
|
|
|
736
755
|
* The request to get an article.
|
|
737
756
|
*/
|
|
738
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;
|
|
739
764
|
/**
|
|
740
765
|
* The ID of the required article.
|
|
741
766
|
* @format id
|
|
@@ -783,6 +808,12 @@ export interface ArticlesListRequest {
|
|
|
783
808
|
* @format text
|
|
784
809
|
*/
|
|
785
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;
|
|
786
817
|
/**
|
|
787
818
|
* The maximum number of articles to return. The default is '50'.
|
|
788
819
|
* @format int32
|
|
@@ -4094,6 +4125,12 @@ export type DirectoriesDeleteResponse = object;
|
|
|
4094
4125
|
* The request to get a directory.
|
|
4095
4126
|
*/
|
|
4096
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;
|
|
4097
4134
|
/**
|
|
4098
4135
|
* The ID of the requested directory.
|
|
4099
4136
|
* @format id
|
|
@@ -4123,6 +4160,12 @@ export interface DirectoriesListRequest {
|
|
|
4123
4160
|
* @format text
|
|
4124
4161
|
*/
|
|
4125
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;
|
|
4126
4169
|
/**
|
|
4127
4170
|
* The maximum number of directories to return. The default is '50'.
|
|
4128
4171
|
* @format int32
|
|
@@ -4886,7 +4929,7 @@ export interface EventAiAgentResponse {
|
|
|
4886
4929
|
* @format id
|
|
4887
4930
|
*/
|
|
4888
4931
|
agent: string;
|
|
4889
|
-
agent_response?: 'error' | 'message' | 'message_generation_started' | 'progress';
|
|
4932
|
+
agent_response?: 'error' | 'message' | 'message_generation_started' | 'progress' | 'suggestions';
|
|
4890
4933
|
/** The metadata given by client to be passed to the event source. */
|
|
4891
4934
|
client_metadata?: object;
|
|
4892
4935
|
/**
|
|
@@ -4917,6 +4960,8 @@ export interface EventAiAgentResponse {
|
|
|
4917
4960
|
* @format text
|
|
4918
4961
|
*/
|
|
4919
4962
|
session_object: string;
|
|
4963
|
+
/** A list of suggestions generated for the AI agent event. */
|
|
4964
|
+
suggestions?: AiAgentEventSuggestions;
|
|
4920
4965
|
}
|
|
4921
4966
|
/** event-conversation-created */
|
|
4922
4967
|
export interface EventConversationCreated {
|
|
@@ -6214,7 +6259,7 @@ export interface MeetingsCreateRequest {
|
|
|
6214
6259
|
* @format date-time
|
|
6215
6260
|
* @example "2023-01-01T12:00:00.000Z"
|
|
6216
6261
|
*/
|
|
6217
|
-
scheduled_date
|
|
6262
|
+
scheduled_date?: string;
|
|
6218
6263
|
/** The state of meeting. */
|
|
6219
6264
|
state: MeetingState;
|
|
6220
6265
|
/** Tags associated with the meeting. */
|
|
@@ -10984,6 +11029,11 @@ export type WebCrawlerJob = AtomBase & {
|
|
|
10984
11029
|
state?: WebCrawlerJobState;
|
|
10985
11030
|
/** URLs to add to the seed set of URLs to crawl from. */
|
|
10986
11031
|
urls?: string[];
|
|
11032
|
+
/**
|
|
11033
|
+
* User agent to use for crawling websites in this job.
|
|
11034
|
+
* @format text
|
|
11035
|
+
*/
|
|
11036
|
+
user_agent?: string;
|
|
10987
11037
|
};
|
|
10988
11038
|
/** State of the web crawler job. */
|
|
10989
11039
|
export declare enum WebCrawlerJobState {
|
|
@@ -11082,6 +11132,12 @@ export interface WebCrawlerJobsCreateRequest {
|
|
|
11082
11132
|
sitemap_urls?: string[];
|
|
11083
11133
|
/** The list of URLs to crawl. */
|
|
11084
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;
|
|
11085
11141
|
}
|
|
11086
11142
|
/**
|
|
11087
11143
|
* web-crawler-jobs-create-response
|
|
@@ -11913,6 +11969,8 @@ export interface WorksListRequest {
|
|
|
11913
11969
|
* @example ["DEVU-12345"]
|
|
11914
11970
|
*/
|
|
11915
11971
|
reported_by?: string[];
|
|
11972
|
+
/** Fields to sort the works by and the direction to sort them. */
|
|
11973
|
+
sort_by?: string[];
|
|
11916
11974
|
/** The filter for stages. */
|
|
11917
11975
|
stage?: StageFilter;
|
|
11918
11976
|
staged_info?: StagedInfoFilter;
|
|
@@ -12509,6 +12567,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12509
12567
|
* @example "ARTICLE-12345"
|
|
12510
12568
|
*/
|
|
12511
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;
|
|
12512
12576
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
|
|
12513
12577
|
/**
|
|
12514
12578
|
* @description Gets an article.
|
|
@@ -12558,6 +12622,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12558
12622
|
* @format text
|
|
12559
12623
|
*/
|
|
12560
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;
|
|
12561
12631
|
/**
|
|
12562
12632
|
* The maximum number of articles to return. The default is '50'.
|
|
12563
12633
|
* @format int32
|
|
@@ -13656,6 +13726,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13656
13726
|
* @format id
|
|
13657
13727
|
*/
|
|
13658
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;
|
|
13659
13735
|
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesGetResponse, any>>;
|
|
13660
13736
|
/**
|
|
13661
13737
|
* @description Gets the specified directory.
|
|
@@ -13688,6 +13764,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13688
13764
|
* @format text
|
|
13689
13765
|
*/
|
|
13690
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;
|
|
13691
13773
|
/**
|
|
13692
13774
|
* The maximum number of directories to return. The default is '50'.
|
|
13693
13775
|
* @format int32
|
|
@@ -16255,6 +16337,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16255
16337
|
* @example ["DEVU-12345"]
|
|
16256
16338
|
*/
|
|
16257
16339
|
reported_by?: string[];
|
|
16340
|
+
/** Fields to sort the works by and the direction to sort them. */
|
|
16341
|
+
sort_by?: string[];
|
|
16258
16342
|
/** Filters for records in the provided stage(s) by name. */
|
|
16259
16343
|
'stage.name'?: string[];
|
|
16260
16344
|
/** Filters for issues that are staged. */
|