@devrev/typescript-sdk 1.1.59 → 1.1.61
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.
- package/dist/auto-generated/beta/beta-devrev-sdk.d.ts +382 -12
- package/dist/auto-generated/beta/beta-devrev-sdk.js +63 -4
- package/dist/auto-generated/public-devrev-sdk.d.ts +6475 -2268
- package/dist/auto-generated/public-devrev-sdk.js +1026 -2
- package/dist/snap-ins/schema.pb.d.ts +1 -0
- package/dist/snap-ins/schema.pb.js +6 -0
- package/dist/snap-ins/struct.pb.js +1 -1
- package/package.json +1 -1
|
@@ -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
|
/**
|
|
@@ -603,6 +605,11 @@ export interface AiAgentEventExecuteProgress {
|
|
|
603
605
|
export interface AiAgentEventExecuteProgressSkillExecuted {
|
|
604
606
|
/** The arguments for the skill call. */
|
|
605
607
|
args?: object;
|
|
608
|
+
/**
|
|
609
|
+
* The metadata of the skill call. The fields depend on the skill that
|
|
610
|
+
* was executed.
|
|
611
|
+
*/
|
|
612
|
+
metadata?: object;
|
|
606
613
|
/** The output of the skill call. */
|
|
607
614
|
output: object;
|
|
608
615
|
/**
|
|
@@ -659,6 +666,14 @@ export interface AiAgentEventSourceTarget {
|
|
|
659
666
|
*/
|
|
660
667
|
event_source: string;
|
|
661
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
|
+
}
|
|
662
677
|
/**
|
|
663
678
|
* ai-agent-events-execute-async-request
|
|
664
679
|
* Request object to consume an input event and execute asynchronously.
|
|
@@ -719,6 +734,17 @@ export interface AiAgentMessageGenerationStarted {
|
|
|
719
734
|
}
|
|
720
735
|
/** ai-agent-session-summary */
|
|
721
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
|
+
}
|
|
722
748
|
/**
|
|
723
749
|
* ai-agent-webhook-target
|
|
724
750
|
* The source of the event to send notifications to, of asynchronous
|
|
@@ -1018,6 +1044,8 @@ export declare enum ArticleStatus {
|
|
|
1018
1044
|
}
|
|
1019
1045
|
/** article-summary */
|
|
1020
1046
|
export type ArticleSummary = AtomBaseSummary & {
|
|
1047
|
+
/** Type of the article. */
|
|
1048
|
+
article_type?: ArticleType;
|
|
1021
1049
|
/** Resource details. */
|
|
1022
1050
|
resource?: ResourceSummary;
|
|
1023
1051
|
/** Sync information for records synced into/from DevRev. */
|
|
@@ -1031,7 +1059,8 @@ export type ArticleSummary = AtomBaseSummary & {
|
|
|
1031
1059
|
/** Type of the article. */
|
|
1032
1060
|
export declare enum ArticleType {
|
|
1033
1061
|
Article = "article",
|
|
1034
|
-
ContentBlock = "content_block"
|
|
1062
|
+
ContentBlock = "content_block",
|
|
1063
|
+
Page = "page"
|
|
1035
1064
|
}
|
|
1036
1065
|
/** articles-count-request */
|
|
1037
1066
|
export interface ArticlesCountRequest {
|
|
@@ -1055,6 +1084,8 @@ export interface ArticlesCountRequest {
|
|
|
1055
1084
|
* @example ["DEVU-12345"]
|
|
1056
1085
|
*/
|
|
1057
1086
|
authored_by?: string[];
|
|
1087
|
+
/** Filters for articles belonging to any of the provided brands. */
|
|
1088
|
+
brands?: string[];
|
|
1058
1089
|
/**
|
|
1059
1090
|
* Filters for articles created by any of the provided users.
|
|
1060
1091
|
* @example ["DEVU-12345"]
|
|
@@ -1111,6 +1142,11 @@ export interface ArticlesCreateRequest {
|
|
|
1111
1142
|
* @example ["DEVU-12345"]
|
|
1112
1143
|
*/
|
|
1113
1144
|
authored_by?: string[];
|
|
1145
|
+
/**
|
|
1146
|
+
* The brand associated with the article.
|
|
1147
|
+
* @format id
|
|
1148
|
+
*/
|
|
1149
|
+
brand?: string;
|
|
1114
1150
|
/** Content format of the article. */
|
|
1115
1151
|
content_format?: ArticleContentFormat;
|
|
1116
1152
|
/** Application-defined custom fields. */
|
|
@@ -1265,6 +1301,8 @@ export interface ArticlesListRequest {
|
|
|
1265
1301
|
* @example ["DEVU-12345"]
|
|
1266
1302
|
*/
|
|
1267
1303
|
authored_by?: string[];
|
|
1304
|
+
/** Filters for articles belonging to any of the provided brands. */
|
|
1305
|
+
brands?: string[];
|
|
1268
1306
|
/**
|
|
1269
1307
|
* Filters for articles created by any of the provided users.
|
|
1270
1308
|
* @example ["DEVU-12345"]
|
|
@@ -1344,6 +1382,11 @@ export interface ArticlesUpdateRequest {
|
|
|
1344
1382
|
applies_to_parts?: ArticlesUpdateRequestAppliesToParts;
|
|
1345
1383
|
artifacts?: ArticlesUpdateRequestArtifacts;
|
|
1346
1384
|
authored_by?: ArticlesUpdateRequestAuthoredBy;
|
|
1385
|
+
/**
|
|
1386
|
+
* The updated brand of the article.
|
|
1387
|
+
* @format id
|
|
1388
|
+
*/
|
|
1389
|
+
brand?: string | null;
|
|
1347
1390
|
content_blocks?: ArticlesUpdateRequestContentBlocks;
|
|
1348
1391
|
/** Content format of the article. */
|
|
1349
1392
|
content_format?: ArticleContentFormat;
|
|
@@ -1507,6 +1550,23 @@ export type Artifact = AtomBase & {
|
|
|
1507
1550
|
/** Defines a file object. */
|
|
1508
1551
|
file?: ArtifactFile;
|
|
1509
1552
|
};
|
|
1553
|
+
/** Represents a set of configuration to be used with the artifacts object. */
|
|
1554
|
+
export declare enum ArtifactConfigurationSet {
|
|
1555
|
+
ArticleMedia = "article_media",
|
|
1556
|
+
Default = "default",
|
|
1557
|
+
EmailMedia = "email_media",
|
|
1558
|
+
JobData = "job_data",
|
|
1559
|
+
MarketplaceListingIcon = "marketplace_listing_icon",
|
|
1560
|
+
MarketplaceMedia = "marketplace_media",
|
|
1561
|
+
OrgLogo = "org_logo",
|
|
1562
|
+
PlugSetting = "plug_setting",
|
|
1563
|
+
PlugSettingBannerCard = "plug_setting_banner_card",
|
|
1564
|
+
PortalCss = "portal_css",
|
|
1565
|
+
SnapInFunctionsCode = "snap_in_functions_code",
|
|
1566
|
+
SnapWidget = "snap_widget",
|
|
1567
|
+
UserProfilePicture = "user_profile_picture",
|
|
1568
|
+
Work = "work"
|
|
1569
|
+
}
|
|
1510
1570
|
/**
|
|
1511
1571
|
* artifact-file
|
|
1512
1572
|
* Defines a file object.
|
|
@@ -1679,6 +1739,8 @@ export interface ArtifactsLocateResponse {
|
|
|
1679
1739
|
* The request to prepare a URL to upload a file.
|
|
1680
1740
|
*/
|
|
1681
1741
|
export interface ArtifactsPrepareRequest {
|
|
1742
|
+
/** Represents a set of configuration to be used with the artifacts object. */
|
|
1743
|
+
configuration_set?: ArtifactConfigurationSet;
|
|
1682
1744
|
/**
|
|
1683
1745
|
* The name of the file that's being uploaded.
|
|
1684
1746
|
* @format text
|
|
@@ -2929,6 +2991,60 @@ export interface ChatsGetRequestDm {
|
|
|
2929
2991
|
export interface ChatsGetResponse {
|
|
2930
2992
|
chat: Chat;
|
|
2931
2993
|
}
|
|
2994
|
+
/** chats-update-request */
|
|
2995
|
+
export type ChatsUpdateRequest = (ChatsUpdateRequestDm | Empty) & {
|
|
2996
|
+
type?: ChatType;
|
|
2997
|
+
/** Application-defined custom fields. */
|
|
2998
|
+
custom_fields?: object;
|
|
2999
|
+
/**
|
|
3000
|
+
* Custom schemas described using identifiers. Each custom field in the
|
|
3001
|
+
* request must have the corresponding schema specified; omission results
|
|
3002
|
+
* in a Bad Request error. If a custom schema is not included in the
|
|
3003
|
+
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
3004
|
+
* it is recommended to provide tenant_fragment: true and
|
|
3005
|
+
* validate_required_fields: true.
|
|
3006
|
+
*/
|
|
3007
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
3008
|
+
/**
|
|
3009
|
+
* The chat's ID.
|
|
3010
|
+
* @format id
|
|
3011
|
+
* @example "CHAN-AbCdEfGh"
|
|
3012
|
+
*/
|
|
3013
|
+
id: string;
|
|
3014
|
+
/**
|
|
3015
|
+
* The updated title for the chat, or unchanged if not provided.
|
|
3016
|
+
* @format text
|
|
3017
|
+
*/
|
|
3018
|
+
title?: string;
|
|
3019
|
+
};
|
|
3020
|
+
/** chats-update-request-dm */
|
|
3021
|
+
export interface ChatsUpdateRequestDm {
|
|
3022
|
+
records?: ChatsUpdateRequestDmRecords;
|
|
3023
|
+
users?: ChatsUpdateRequestDmUsers;
|
|
3024
|
+
}
|
|
3025
|
+
/** chats-update-request-dm-records */
|
|
3026
|
+
export interface ChatsUpdateRequestDmRecords {
|
|
3027
|
+
/**
|
|
3028
|
+
* The associated records to set for this DM.
|
|
3029
|
+
* @maxItems 16
|
|
3030
|
+
*/
|
|
3031
|
+
set?: string[];
|
|
3032
|
+
}
|
|
3033
|
+
/** chats-update-request-dm-users */
|
|
3034
|
+
export interface ChatsUpdateRequestDmUsers {
|
|
3035
|
+
/**
|
|
3036
|
+
* The updated list of users to send direct messages to. The
|
|
3037
|
+
* authenticated user must be included in this list.
|
|
3038
|
+
* @maxItems 16
|
|
3039
|
+
* @minItems 1
|
|
3040
|
+
* @example ["DEVU-12345"]
|
|
3041
|
+
*/
|
|
3042
|
+
set: string[];
|
|
3043
|
+
}
|
|
3044
|
+
/** chats-update-response */
|
|
3045
|
+
export interface ChatsUpdateResponse {
|
|
3046
|
+
chat: Chat;
|
|
3047
|
+
}
|
|
2932
3048
|
/**
|
|
2933
3049
|
* client-context
|
|
2934
3050
|
* Properties of client to be used in track API.
|
|
@@ -3862,6 +3978,11 @@ export type ConversationSummary = AtomBaseSummary & {
|
|
|
3862
3978
|
*/
|
|
3863
3979
|
export interface ConversationsCreateRequest {
|
|
3864
3980
|
type: ConversationsCreateRequestTypeValue;
|
|
3981
|
+
/**
|
|
3982
|
+
* The brand associated with the conversation.
|
|
3983
|
+
* @format id
|
|
3984
|
+
*/
|
|
3985
|
+
brand?: string;
|
|
3865
3986
|
/** Channel IDs of the conversation. */
|
|
3866
3987
|
channels?: string[];
|
|
3867
3988
|
/** Application-defined custom fields. */
|
|
@@ -3967,6 +4088,8 @@ export interface ConversationsExportRequest {
|
|
|
3967
4088
|
* @example ["PROD-12345"]
|
|
3968
4089
|
*/
|
|
3969
4090
|
applies_to_parts?: string[];
|
|
4091
|
+
/** Filters for tickets that are associated with any of the brands. */
|
|
4092
|
+
brand?: string[];
|
|
3970
4093
|
/**
|
|
3971
4094
|
* Filters for conversations that are associated with any of the
|
|
3972
4095
|
* channels.
|
|
@@ -4071,6 +4194,8 @@ export interface ConversationsListRequest {
|
|
|
4071
4194
|
* @example ["PROD-12345"]
|
|
4072
4195
|
*/
|
|
4073
4196
|
applies_to_parts?: string[];
|
|
4197
|
+
/** Filters for tickets that are associated with any of the brands. */
|
|
4198
|
+
brand?: string[];
|
|
4074
4199
|
/**
|
|
4075
4200
|
* Filters for conversations that are associated with any of the
|
|
4076
4201
|
* channels.
|
|
@@ -4179,6 +4304,11 @@ export interface ConversationsListResponse {
|
|
|
4179
4304
|
*/
|
|
4180
4305
|
export interface ConversationsUpdateRequest {
|
|
4181
4306
|
applies_to_parts?: ConversationsUpdateRequestAppliesToParts;
|
|
4307
|
+
/**
|
|
4308
|
+
* The brand associated with the conversation.
|
|
4309
|
+
* @format id
|
|
4310
|
+
*/
|
|
4311
|
+
brand?: string;
|
|
4182
4312
|
channels?: ConversationsUpdateRequestChannels;
|
|
4183
4313
|
/** Application-defined custom fields. */
|
|
4184
4314
|
custom_fields?: object;
|
|
@@ -4759,13 +4889,18 @@ export interface CustomLinkTypeCreateRequest {
|
|
|
4759
4889
|
* @format text
|
|
4760
4890
|
*/
|
|
4761
4891
|
backward_name: string;
|
|
4762
|
-
/**
|
|
4892
|
+
/**
|
|
4893
|
+
* Whether the link type is deprecated.
|
|
4894
|
+
* @deprecated
|
|
4895
|
+
*/
|
|
4763
4896
|
deprecated?: boolean;
|
|
4764
4897
|
/**
|
|
4765
4898
|
* The name of the link in the forward direction.
|
|
4766
4899
|
* @format text
|
|
4767
4900
|
*/
|
|
4768
4901
|
forward_name: string;
|
|
4902
|
+
/** Whether the link type is deprecated. */
|
|
4903
|
+
is_deprecated?: boolean;
|
|
4769
4904
|
/**
|
|
4770
4905
|
* The name of the custom link type.
|
|
4771
4906
|
* @format text
|
|
@@ -4805,8 +4940,13 @@ export interface CustomLinkTypeListRequest {
|
|
|
4805
4940
|
* @format text
|
|
4806
4941
|
*/
|
|
4807
4942
|
cursor?: string;
|
|
4808
|
-
/**
|
|
4943
|
+
/**
|
|
4944
|
+
* Whether only deprecated link types should be filtered.
|
|
4945
|
+
* @deprecated
|
|
4946
|
+
*/
|
|
4809
4947
|
deprecated?: boolean;
|
|
4948
|
+
/** Whether only deprecated link types should be filtered. */
|
|
4949
|
+
is_deprecated?: boolean;
|
|
4810
4950
|
/**
|
|
4811
4951
|
* The maximum number of items.
|
|
4812
4952
|
* @format int32
|
|
@@ -4825,7 +4965,11 @@ export interface CustomLinkTypeListRequest {
|
|
|
4825
4965
|
/** The list of fields to sort the items by and how to sort them. */
|
|
4826
4966
|
sort_by?: string[];
|
|
4827
4967
|
source_types?: LinkDescriptorFilter;
|
|
4968
|
+
/** Types from which a link can be made. */
|
|
4969
|
+
source_types_v2?: LinkTargetDescriptor[];
|
|
4828
4970
|
target_types?: LinkDescriptorFilter;
|
|
4971
|
+
/** Types to which a link can be made. */
|
|
4972
|
+
target_types_v2?: LinkTargetDescriptor[];
|
|
4829
4973
|
}
|
|
4830
4974
|
/** custom-link-type-list-response */
|
|
4831
4975
|
export interface CustomLinkTypeListResponse {
|
|
@@ -4853,7 +4997,10 @@ export interface CustomLinkTypeUpdateRequest {
|
|
|
4853
4997
|
* @format text
|
|
4854
4998
|
*/
|
|
4855
4999
|
backward_name?: string;
|
|
4856
|
-
/**
|
|
5000
|
+
/**
|
|
5001
|
+
* Whether the link type is deprecated.
|
|
5002
|
+
* @deprecated
|
|
5003
|
+
*/
|
|
4857
5004
|
deprecated?: boolean;
|
|
4858
5005
|
/**
|
|
4859
5006
|
* The updated name of the link in the forward direction.
|
|
@@ -4865,13 +5012,19 @@ export interface CustomLinkTypeUpdateRequest {
|
|
|
4865
5012
|
* @format id
|
|
4866
5013
|
*/
|
|
4867
5014
|
id: string;
|
|
5015
|
+
/** Whether the link type is deprecated. */
|
|
5016
|
+
is_deprecated?: boolean;
|
|
4868
5017
|
/**
|
|
4869
5018
|
* The updated name of the custom link type.
|
|
4870
5019
|
* @format text
|
|
4871
5020
|
*/
|
|
4872
5021
|
name?: string;
|
|
4873
5022
|
source_types?: UpdateLinkTargetDescriptorList;
|
|
5023
|
+
/** Types from which a link can be made. */
|
|
5024
|
+
source_types_v2?: LinkTargetDescriptor[];
|
|
4874
5025
|
target_types?: UpdateLinkTargetDescriptorList;
|
|
5026
|
+
/** Types to which a link can be made. */
|
|
5027
|
+
target_types_v2?: LinkTargetDescriptor[];
|
|
4875
5028
|
/**
|
|
4876
5029
|
* The updated tooltip of the custom link type.
|
|
4877
5030
|
* @format text
|
|
@@ -5008,6 +5161,8 @@ export interface CustomObjectsListRequest {
|
|
|
5008
5161
|
cursor?: string;
|
|
5009
5162
|
/** List of filters to apply. */
|
|
5010
5163
|
filter?: any[];
|
|
5164
|
+
/** List of filters to apply. */
|
|
5165
|
+
filters?: any[];
|
|
5011
5166
|
/**
|
|
5012
5167
|
* Leaf type to filter.
|
|
5013
5168
|
* @format text
|
|
@@ -5111,6 +5266,12 @@ export type CustomSchemaFragmentBase = AtomBase & {
|
|
|
5111
5266
|
fields?: SchemaFieldDescriptor[];
|
|
5112
5267
|
/** Type of the custom schema fragment. */
|
|
5113
5268
|
fragment_type?: CustomSchemaFragmentFragmentType;
|
|
5269
|
+
/**
|
|
5270
|
+
* Indicates if the fragment is deprecated. Modifications to this
|
|
5271
|
+
* field are done in-place and don't result in creation of a new
|
|
5272
|
+
* fragment in chain.
|
|
5273
|
+
*/
|
|
5274
|
+
is_deprecated?: boolean;
|
|
5114
5275
|
/**
|
|
5115
5276
|
* Leaf type this fragment applies to.
|
|
5116
5277
|
* @format text
|
|
@@ -5198,10 +5359,15 @@ export interface CustomSchemaFragmentsListRequest {
|
|
|
5198
5359
|
* @format text
|
|
5199
5360
|
*/
|
|
5200
5361
|
cursor?: string;
|
|
5201
|
-
/**
|
|
5362
|
+
/**
|
|
5363
|
+
* Whether only deprecated fragments should be filtered.
|
|
5364
|
+
* @deprecated
|
|
5365
|
+
*/
|
|
5202
5366
|
deprecated?: boolean;
|
|
5203
5367
|
/** Whether the leaf type corresponds to a custom object */
|
|
5204
5368
|
is_custom_leaf_type?: boolean;
|
|
5369
|
+
/** Whether the fragment has been deprecated. */
|
|
5370
|
+
is_deprecated?: boolean;
|
|
5205
5371
|
/** The list of leaf types. */
|
|
5206
5372
|
leaf_type?: string[];
|
|
5207
5373
|
/**
|
|
@@ -5258,7 +5424,10 @@ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAp
|
|
|
5258
5424
|
conditions?: CustomSchemaFragmentCondition[];
|
|
5259
5425
|
/** List of field names which are being dropped. */
|
|
5260
5426
|
deleted_fields?: string[];
|
|
5261
|
-
/**
|
|
5427
|
+
/**
|
|
5428
|
+
* Whether this fragment has been deprecated.
|
|
5429
|
+
* @deprecated
|
|
5430
|
+
*/
|
|
5262
5431
|
deprecated?: boolean;
|
|
5263
5432
|
/**
|
|
5264
5433
|
* The description of the custom schema fragment.
|
|
@@ -5269,6 +5438,8 @@ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAp
|
|
|
5269
5438
|
fields?: SchemaFieldDescriptor[];
|
|
5270
5439
|
/** Whether the leaf type corresponds to a custom object */
|
|
5271
5440
|
is_custom_leaf_type?: boolean;
|
|
5441
|
+
/** Whether this fragment has been deprecated. */
|
|
5442
|
+
is_deprecated?: boolean;
|
|
5272
5443
|
/**
|
|
5273
5444
|
* The leaf type this fragment applies to.
|
|
5274
5445
|
* @format text
|
|
@@ -5387,6 +5558,19 @@ export interface CustomSchemaSpecDrop {
|
|
|
5387
5558
|
*/
|
|
5388
5559
|
subtype?: boolean;
|
|
5389
5560
|
}
|
|
5561
|
+
/**
|
|
5562
|
+
* custom-schema-spec-for-read
|
|
5563
|
+
* Custom schemas described using identifiers
|
|
5564
|
+
*/
|
|
5565
|
+
export interface CustomSchemaSpecForRead {
|
|
5566
|
+
/** List of apps. */
|
|
5567
|
+
apps?: string[];
|
|
5568
|
+
/**
|
|
5569
|
+
* Name of the subtype.
|
|
5570
|
+
* @format text
|
|
5571
|
+
*/
|
|
5572
|
+
subtype?: string;
|
|
5573
|
+
}
|
|
5390
5574
|
/** custom-stage */
|
|
5391
5575
|
export type CustomStage = AtomBase & {
|
|
5392
5576
|
/**
|
|
@@ -7926,7 +8110,7 @@ export interface EventAiAgentResponse {
|
|
|
7926
8110
|
* @format id
|
|
7927
8111
|
*/
|
|
7928
8112
|
agent: string;
|
|
7929
|
-
agent_response?: 'error' | 'message' | 'message_generation_started' | 'progress';
|
|
8113
|
+
agent_response?: 'error' | 'message' | 'message_generation_started' | 'progress' | 'suggestions';
|
|
7930
8114
|
/** The metadata given by client to be passed to the event source. */
|
|
7931
8115
|
client_metadata?: object;
|
|
7932
8116
|
/**
|
|
@@ -7957,6 +8141,8 @@ export interface EventAiAgentResponse {
|
|
|
7957
8141
|
* @format text
|
|
7958
8142
|
*/
|
|
7959
8143
|
session_object: string;
|
|
8144
|
+
/** A list of suggestions generated for the AI agent event. */
|
|
8145
|
+
suggestions?: AiAgentEventSuggestions;
|
|
7960
8146
|
}
|
|
7961
8147
|
/** event-conversation-created */
|
|
7962
8148
|
export interface EventConversationCreated {
|
|
@@ -12140,6 +12326,11 @@ export interface PartsListRequest {
|
|
|
12140
12326
|
* always be returned in the specified sort-by order.
|
|
12141
12327
|
*/
|
|
12142
12328
|
mode?: ListMode;
|
|
12329
|
+
/**
|
|
12330
|
+
* Filters for parts modified by any of these users.
|
|
12331
|
+
* @example ["DEVU-12345"]
|
|
12332
|
+
*/
|
|
12333
|
+
modified_by?: string[];
|
|
12143
12334
|
/** Filters for parts of the provided name(s). */
|
|
12144
12335
|
name?: string[];
|
|
12145
12336
|
/**
|
|
@@ -12149,6 +12340,8 @@ export interface PartsListRequest {
|
|
|
12149
12340
|
owned_by?: string[];
|
|
12150
12341
|
/** The filter for specifying parent part. */
|
|
12151
12342
|
parent_part?: ParentPartFilter;
|
|
12343
|
+
/** Filters for subtypes. */
|
|
12344
|
+
subtype?: string[];
|
|
12152
12345
|
/**
|
|
12153
12346
|
* Filters for part with any of the provided tags.
|
|
12154
12347
|
* @example ["TAG-12345"]
|
|
@@ -15037,6 +15230,31 @@ export interface ServiceAccountsGetRequest {
|
|
|
15037
15230
|
export interface ServiceAccountsGetResponse {
|
|
15038
15231
|
service_account: ServiceAccount;
|
|
15039
15232
|
}
|
|
15233
|
+
/**
|
|
15234
|
+
* service-accounts-update-request
|
|
15235
|
+
* The request object to update a service account.
|
|
15236
|
+
*/
|
|
15237
|
+
export interface ServiceAccountsUpdateRequest {
|
|
15238
|
+
/**
|
|
15239
|
+
* The service account's display name to be updated. A unique, human
|
|
15240
|
+
* readable name to identify a service account.
|
|
15241
|
+
* @format text
|
|
15242
|
+
*/
|
|
15243
|
+
display_name?: string;
|
|
15244
|
+
/**
|
|
15245
|
+
* The ID of the requested service account.
|
|
15246
|
+
* @format id
|
|
15247
|
+
*/
|
|
15248
|
+
id: string;
|
|
15249
|
+
}
|
|
15250
|
+
/**
|
|
15251
|
+
* service-accounts-update-response
|
|
15252
|
+
* The response object that carries the updated service account's
|
|
15253
|
+
* information.
|
|
15254
|
+
*/
|
|
15255
|
+
export interface ServiceAccountsUpdateResponse {
|
|
15256
|
+
service_account: ServiceAccount;
|
|
15257
|
+
}
|
|
15040
15258
|
/** set-issue-selector */
|
|
15041
15259
|
export interface SetIssueSelector {
|
|
15042
15260
|
/**
|
|
@@ -16580,6 +16798,18 @@ export interface SurveysDeleteRequest {
|
|
|
16580
16798
|
}
|
|
16581
16799
|
/** surveys-delete-response */
|
|
16582
16800
|
export type SurveysDeleteResponse = object;
|
|
16801
|
+
/** surveys-get-request */
|
|
16802
|
+
export interface SurveysGetRequest {
|
|
16803
|
+
/**
|
|
16804
|
+
* The ID of the survey to get.
|
|
16805
|
+
* @format id
|
|
16806
|
+
*/
|
|
16807
|
+
id: string;
|
|
16808
|
+
}
|
|
16809
|
+
/** surveys-get-response */
|
|
16810
|
+
export interface SurveysGetResponse {
|
|
16811
|
+
survey: Survey;
|
|
16812
|
+
}
|
|
16583
16813
|
/** surveys-list-request */
|
|
16584
16814
|
export interface SurveysListRequest {
|
|
16585
16815
|
/**
|
|
@@ -20636,6 +20866,11 @@ export interface WorksExportRequest {
|
|
|
20636
20866
|
*/
|
|
20637
20867
|
first?: number;
|
|
20638
20868
|
issue?: WorksFilterIssue;
|
|
20869
|
+
/**
|
|
20870
|
+
* Filters for work modified by any of these users.
|
|
20871
|
+
* @example ["DEVU-12345"]
|
|
20872
|
+
*/
|
|
20873
|
+
modified_by?: string[];
|
|
20639
20874
|
/** Provides ways to specify date ranges on objects. */
|
|
20640
20875
|
modified_date?: DateFilter;
|
|
20641
20876
|
opportunity?: WorksFilterOpportunity;
|
|
@@ -20718,6 +20953,8 @@ export interface WorksFilterOpportunity {
|
|
|
20718
20953
|
}
|
|
20719
20954
|
/** works-filter-ticket */
|
|
20720
20955
|
export interface WorksFilterTicket {
|
|
20956
|
+
/** Filters for tickets that are associated with any of the brands. */
|
|
20957
|
+
brand?: string[];
|
|
20721
20958
|
/** Filters for tickets with any of the provided channels. */
|
|
20722
20959
|
channels?: TicketChannels[];
|
|
20723
20960
|
/** Filters for tickets that are associated with any of the channels. */
|
|
@@ -20800,6 +21037,11 @@ export interface WorksListRequest {
|
|
|
20800
21037
|
* always be returned in the specified sort-by order.
|
|
20801
21038
|
*/
|
|
20802
21039
|
mode?: ListMode;
|
|
21040
|
+
/**
|
|
21041
|
+
* Filters for work modified by any of these users.
|
|
21042
|
+
* @example ["DEVU-12345"]
|
|
21043
|
+
*/
|
|
21044
|
+
modified_by?: string[];
|
|
20803
21045
|
/** Provides ways to specify date ranges on objects. */
|
|
20804
21046
|
modified_date?: DateFilter;
|
|
20805
21047
|
opportunity?: WorksFilterOpportunity;
|
|
@@ -21623,6 +21865,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21623
21865
|
* @example ["DEVU-12345"]
|
|
21624
21866
|
*/
|
|
21625
21867
|
authored_by?: string[];
|
|
21868
|
+
/** Filters for articles belonging to any of the provided brands. */
|
|
21869
|
+
brands?: string[];
|
|
21626
21870
|
/**
|
|
21627
21871
|
* Filters for articles created by any of the provided users.
|
|
21628
21872
|
* @example ["DEVU-12345"]
|
|
@@ -21738,6 +21982,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21738
21982
|
* @example ["DEVU-12345"]
|
|
21739
21983
|
*/
|
|
21740
21984
|
authored_by?: string[];
|
|
21985
|
+
/** Filters for articles belonging to any of the provided brands. */
|
|
21986
|
+
brands?: string[];
|
|
21741
21987
|
/**
|
|
21742
21988
|
* Filters for articles created by any of the provided users.
|
|
21743
21989
|
* @example ["DEVU-12345"]
|
|
@@ -22208,6 +22454,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22208
22454
|
* @secure
|
|
22209
22455
|
*/
|
|
22210
22456
|
chatsGetPost: (data: ChatsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ChatsGetResponse, any>>;
|
|
22457
|
+
/**
|
|
22458
|
+
* @description Updates a chat's information.
|
|
22459
|
+
*
|
|
22460
|
+
* @tags chats
|
|
22461
|
+
* @name ChatsUpdate
|
|
22462
|
+
* @summary Update Chat
|
|
22463
|
+
* @request POST:/chats.update
|
|
22464
|
+
* @secure
|
|
22465
|
+
*/
|
|
22466
|
+
chatsUpdate: (data: ChatsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ChatsUpdateResponse, any>>;
|
|
22211
22467
|
/**
|
|
22212
22468
|
* @description Creates a code change object.
|
|
22213
22469
|
*
|
|
@@ -22522,6 +22778,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22522
22778
|
* @example ["PROD-12345"]
|
|
22523
22779
|
*/
|
|
22524
22780
|
applies_to_parts?: string[];
|
|
22781
|
+
/** Filters for tickets that are associated with any of the brands. */
|
|
22782
|
+
brand?: string[];
|
|
22525
22783
|
/**
|
|
22526
22784
|
* Filters for conversations that are associated with any of the
|
|
22527
22785
|
* channels.
|
|
@@ -22664,6 +22922,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22664
22922
|
* @example ["PROD-12345"]
|
|
22665
22923
|
*/
|
|
22666
22924
|
applies_to_parts?: string[];
|
|
22925
|
+
/** Filters for tickets that are associated with any of the brands. */
|
|
22926
|
+
brand?: string[];
|
|
22667
22927
|
/**
|
|
22668
22928
|
* Filters for conversations that are associated with any of the
|
|
22669
22929
|
* channels.
|
|
@@ -22882,6 +23142,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22882
23142
|
cursor?: string;
|
|
22883
23143
|
/** List of filters to apply. */
|
|
22884
23144
|
filter?: any[];
|
|
23145
|
+
/** List of filters to apply. */
|
|
23146
|
+
filters?: any[];
|
|
22885
23147
|
/**
|
|
22886
23148
|
* The maximum number of items.
|
|
22887
23149
|
* @format int32
|
|
@@ -24048,8 +24310,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24048
24310
|
* @format text
|
|
24049
24311
|
*/
|
|
24050
24312
|
cursor?: string;
|
|
24051
|
-
/**
|
|
24313
|
+
/**
|
|
24314
|
+
* Whether only deprecated link types should be filtered.
|
|
24315
|
+
* @deprecated
|
|
24316
|
+
*/
|
|
24052
24317
|
deprecated?: boolean;
|
|
24318
|
+
/** Whether only deprecated link types should be filtered. */
|
|
24319
|
+
is_deprecated?: boolean;
|
|
24053
24320
|
/**
|
|
24054
24321
|
* The maximum number of items.
|
|
24055
24322
|
* @format int32
|
|
@@ -24082,6 +24349,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24082
24349
|
*/
|
|
24083
24350
|
'source_types.link_descriptors.subtype'?: string;
|
|
24084
24351
|
/** True when the descriptor describes a custom leaf type. */
|
|
24352
|
+
'source_types_v2.is_custom_leaf_type'?: boolean;
|
|
24353
|
+
/**
|
|
24354
|
+
* Set to true when only the specified leaf type (no subtypes) is
|
|
24355
|
+
* allowed as a link target.
|
|
24356
|
+
*/
|
|
24357
|
+
'source_types_v2.leaf_only'?: boolean;
|
|
24358
|
+
/**
|
|
24359
|
+
* Leaf type of the target objects.
|
|
24360
|
+
* @format text
|
|
24361
|
+
*/
|
|
24362
|
+
'source_types_v2.leaf_type'?: string;
|
|
24363
|
+
/**
|
|
24364
|
+
* Specific subtype of the target objects.
|
|
24365
|
+
* @format text
|
|
24366
|
+
*/
|
|
24367
|
+
'source_types_v2.subtype'?: string;
|
|
24368
|
+
/** True when the descriptor describes a custom leaf type. */
|
|
24085
24369
|
'target_types.link_descriptors.is_custom_leaf_type'?: boolean;
|
|
24086
24370
|
/**
|
|
24087
24371
|
* Set to true when only the specified leaf type (no subtypes) is
|
|
@@ -24098,6 +24382,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24098
24382
|
* @format text
|
|
24099
24383
|
*/
|
|
24100
24384
|
'target_types.link_descriptors.subtype'?: string;
|
|
24385
|
+
/** True when the descriptor describes a custom leaf type. */
|
|
24386
|
+
'target_types_v2.is_custom_leaf_type'?: boolean;
|
|
24387
|
+
/**
|
|
24388
|
+
* Set to true when only the specified leaf type (no subtypes) is
|
|
24389
|
+
* allowed as a link target.
|
|
24390
|
+
*/
|
|
24391
|
+
'target_types_v2.leaf_only'?: boolean;
|
|
24392
|
+
/**
|
|
24393
|
+
* Leaf type of the target objects.
|
|
24394
|
+
* @format text
|
|
24395
|
+
*/
|
|
24396
|
+
'target_types_v2.leaf_type'?: string;
|
|
24397
|
+
/**
|
|
24398
|
+
* Specific subtype of the target objects.
|
|
24399
|
+
* @format text
|
|
24400
|
+
*/
|
|
24401
|
+
'target_types_v2.subtype'?: string;
|
|
24101
24402
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeListResponse, any>>;
|
|
24102
24403
|
/**
|
|
24103
24404
|
* @description Lists custom link types.
|
|
@@ -24939,6 +25240,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24939
25240
|
* used.
|
|
24940
25241
|
*/
|
|
24941
25242
|
mode?: ListMode;
|
|
25243
|
+
/**
|
|
25244
|
+
* Filters for parts modified by any of these users.
|
|
25245
|
+
* @example ["DEVU-12345"]
|
|
25246
|
+
*/
|
|
25247
|
+
modified_by?: string[];
|
|
24942
25248
|
/** Filters for parts of the provided name(s). */
|
|
24943
25249
|
name?: string[];
|
|
24944
25250
|
/**
|
|
@@ -24959,6 +25265,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24959
25265
|
* @example ["PROD-12345"]
|
|
24960
25266
|
*/
|
|
24961
25267
|
'parent_part.parts'?: string[];
|
|
25268
|
+
/** Filters for subtypes. */
|
|
25269
|
+
subtype?: string[];
|
|
24962
25270
|
/**
|
|
24963
25271
|
* Filters for part with any of the provided tags.
|
|
24964
25272
|
* @example ["TAG-12345"]
|
|
@@ -25769,9 +26077,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25769
26077
|
* @request GET:/schemas.aggregated.get
|
|
25770
26078
|
* @secure
|
|
25771
26079
|
*/
|
|
25772
|
-
aggregatedSchemaGet: (query
|
|
26080
|
+
aggregatedSchemaGet: (query?: {
|
|
25773
26081
|
/** The list of custom schema fragment DONs which are to be aggregated. */
|
|
25774
|
-
custom_schema_fragment_ids
|
|
26082
|
+
custom_schema_fragment_ids?: string[];
|
|
26083
|
+
/** List of apps. */
|
|
26084
|
+
'custom_schema_spec.apps'?: string[];
|
|
26085
|
+
/**
|
|
26086
|
+
* Name of the subtype.
|
|
26087
|
+
* @format text
|
|
26088
|
+
*/
|
|
26089
|
+
'custom_schema_spec.subtype'?: string;
|
|
25775
26090
|
/** Whether the leaf type corresponds to a custom object. */
|
|
25776
26091
|
is_custom_leaf_type?: boolean;
|
|
25777
26092
|
/**
|
|
@@ -25840,10 +26155,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25840
26155
|
* @format text
|
|
25841
26156
|
*/
|
|
25842
26157
|
cursor?: string;
|
|
25843
|
-
/**
|
|
26158
|
+
/**
|
|
26159
|
+
* Whether only deprecated fragments should be filtered.
|
|
26160
|
+
* @deprecated
|
|
26161
|
+
*/
|
|
25844
26162
|
deprecated?: boolean;
|
|
25845
26163
|
/** Whether the leaf type corresponds to a custom object */
|
|
25846
26164
|
is_custom_leaf_type?: boolean;
|
|
26165
|
+
/** Whether the fragment has been deprecated. */
|
|
26166
|
+
is_deprecated?: boolean;
|
|
25847
26167
|
/** The list of leaf types. */
|
|
25848
26168
|
leaf_type?: string[];
|
|
25849
26169
|
/**
|
|
@@ -26142,6 +26462,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26142
26462
|
* @secure
|
|
26143
26463
|
*/
|
|
26144
26464
|
serviceAccountsGetPost: (data: ServiceAccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any>>;
|
|
26465
|
+
/**
|
|
26466
|
+
* @description Updates a service account.
|
|
26467
|
+
*
|
|
26468
|
+
* @tags service-accounts
|
|
26469
|
+
* @name ServiceAccountsUpdate
|
|
26470
|
+
* @summary Update Service Account
|
|
26471
|
+
* @request POST:/service-accounts.update
|
|
26472
|
+
* @secure
|
|
26473
|
+
*/
|
|
26474
|
+
serviceAccountsUpdate: (data: ServiceAccountsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsUpdateResponse, any>>;
|
|
26145
26475
|
/**
|
|
26146
26476
|
* @description Gets an SLA tracker.
|
|
26147
26477
|
*
|
|
@@ -26760,6 +27090,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26760
27090
|
* @secure
|
|
26761
27091
|
*/
|
|
26762
27092
|
surveysDelete: (data: SurveysDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
27093
|
+
/**
|
|
27094
|
+
* @description Gets a survey given the ID.
|
|
27095
|
+
*
|
|
27096
|
+
* @tags surveys
|
|
27097
|
+
* @name SurveysGet
|
|
27098
|
+
* @summary Get Survey
|
|
27099
|
+
* @request GET:/surveys.get
|
|
27100
|
+
* @secure
|
|
27101
|
+
*/
|
|
27102
|
+
surveysGet: (query: {
|
|
27103
|
+
/**
|
|
27104
|
+
* The ID of the survey to get.
|
|
27105
|
+
* @format id
|
|
27106
|
+
*/
|
|
27107
|
+
id: string;
|
|
27108
|
+
}, params?: RequestParams) => Promise<AxiosResponse<SurveysGetResponse, any>>;
|
|
27109
|
+
/**
|
|
27110
|
+
* @description Gets a survey given the ID.
|
|
27111
|
+
*
|
|
27112
|
+
* @tags surveys
|
|
27113
|
+
* @name SurveysGetPost
|
|
27114
|
+
* @summary Get Survey (POST)
|
|
27115
|
+
* @request POST:/surveys.get
|
|
27116
|
+
* @secure
|
|
27117
|
+
*/
|
|
27118
|
+
surveysGetPost: (data: SurveysGetRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysGetResponse, any>>;
|
|
26763
27119
|
/**
|
|
26764
27120
|
* @description List surveys requested by the user.
|
|
26765
27121
|
*
|
|
@@ -27638,6 +27994,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27638
27994
|
'issue.sprint'?: string[];
|
|
27639
27995
|
/** Filters for issues with any of the provided subtypes. */
|
|
27640
27996
|
'issue.subtype'?: string[];
|
|
27997
|
+
/**
|
|
27998
|
+
* Filters for work modified by any of these users.
|
|
27999
|
+
* @example ["DEVU-12345"]
|
|
28000
|
+
*/
|
|
28001
|
+
modified_by?: string[];
|
|
27641
28002
|
/**
|
|
27642
28003
|
* Filters for opportunities belonging to any of the provided accounts.
|
|
27643
28004
|
* @example ["ACC-12345"]
|
|
@@ -27691,6 +28052,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27691
28052
|
* @example ["TAG-12345"]
|
|
27692
28053
|
*/
|
|
27693
28054
|
tags?: string[];
|
|
28055
|
+
/** Filters for tickets that are associated with any of the brands. */
|
|
28056
|
+
'ticket.brand'?: string[];
|
|
27694
28057
|
/** Filters for tickets with any of the provided channels. */
|
|
27695
28058
|
'ticket.channels'?: TicketChannels[];
|
|
27696
28059
|
/** Filters for tickets that are associated with any of the channels. */
|
|
@@ -27815,6 +28178,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27815
28178
|
* used.
|
|
27816
28179
|
*/
|
|
27817
28180
|
mode?: ListMode;
|
|
28181
|
+
/**
|
|
28182
|
+
* Filters for work modified by any of these users.
|
|
28183
|
+
* @example ["DEVU-12345"]
|
|
28184
|
+
*/
|
|
28185
|
+
modified_by?: string[];
|
|
27818
28186
|
/**
|
|
27819
28187
|
* Filters for opportunities belonging to any of the provided accounts.
|
|
27820
28188
|
* @example ["ACC-12345"]
|
|
@@ -27868,6 +28236,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27868
28236
|
* @example ["TAG-12345"]
|
|
27869
28237
|
*/
|
|
27870
28238
|
tags?: string[];
|
|
28239
|
+
/** Filters for tickets that are associated with any of the brands. */
|
|
28240
|
+
'ticket.brand'?: string[];
|
|
27871
28241
|
/** Filters for tickets with any of the provided channels. */
|
|
27872
28242
|
'ticket.channels'?: TicketChannels[];
|
|
27873
28243
|
/** Filters for tickets that are associated with any of the channels. */
|