@lunnoa/client 0.0.0-development → 1.0.0
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/LICENSE +202 -202
- package/README.md +372 -338
- package/dist/cli.js +31 -1
- package/dist/index.cjs +31 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +703 -585
- package/dist/index.d.ts +703 -585
- package/dist/index.js +31 -1
- package/dist/index.js.map +1 -1
- package/dist/react.cjs +31 -1
- package/dist/react.cjs.map +1 -1
- package/dist/react.d.cts +780 -719
- package/dist/react.d.ts +780 -719
- package/dist/react.js +31 -1
- package/dist/react.js.map +1 -1
- package/package.json +7 -5
- package/skills/lunnoa-client/SKILL.md +517 -0
- package/skills/lunnoa-solution-design/SKILL.md +190 -0
package/dist/react.d.ts
CHANGED
|
@@ -297,6 +297,8 @@ interface components {
|
|
|
297
297
|
CreateQueueDto: {
|
|
298
298
|
/** @description Human-readable name for the queue. */
|
|
299
299
|
name: string;
|
|
300
|
+
/** @description ObjectType IDs this queue accepts for linked items. Empty/omitted = any ObjectType (and untyped items) allowed. */
|
|
301
|
+
allowedObjectTypeIds?: string[];
|
|
300
302
|
/** @description Description of what the queue is used for. */
|
|
301
303
|
description?: string;
|
|
302
304
|
/** @description Maximum number of retry attempts per item. Defaults to 3. */
|
|
@@ -338,6 +340,14 @@ interface components {
|
|
|
338
340
|
/** @description Number of items in the queue. */
|
|
339
341
|
items: number;
|
|
340
342
|
};
|
|
343
|
+
QueueAllowedObjectTypeDto: {
|
|
344
|
+
/** @description Object type ID. */
|
|
345
|
+
id: string;
|
|
346
|
+
/** @description Object type name. */
|
|
347
|
+
name: string;
|
|
348
|
+
/** @description Object type slug. */
|
|
349
|
+
slug: string;
|
|
350
|
+
};
|
|
341
351
|
QueueResponseDto: {
|
|
342
352
|
/** @description Queue ID. */
|
|
343
353
|
id: string;
|
|
@@ -383,6 +393,8 @@ interface components {
|
|
|
383
393
|
createdByWorkspaceUser?: components["schemas"]["QueueCreatedByWorkspaceUserDto"];
|
|
384
394
|
/** @description Relation counts. Included when `expansion=itemCounts` is requested. */
|
|
385
395
|
_count?: components["schemas"]["QueueItemCountsDto"];
|
|
396
|
+
/** @description ObjectTypes this queue accepts for linked items. Empty means any type is allowed. Included when `expansion=allowedObjectTypes` is requested. */
|
|
397
|
+
allowedObjectTypes?: components["schemas"]["QueueAllowedObjectTypeDto"][];
|
|
386
398
|
};
|
|
387
399
|
QueueStatsResponseDto: {
|
|
388
400
|
/** @description Total number of items in the queue. */
|
|
@@ -401,6 +413,8 @@ interface components {
|
|
|
401
413
|
UpdateQueueDto: {
|
|
402
414
|
/** @description Human-readable name for the queue. */
|
|
403
415
|
name?: string;
|
|
416
|
+
/** @description ObjectType IDs this queue accepts for linked items. Empty/omitted = any ObjectType (and untyped items) allowed. */
|
|
417
|
+
allowedObjectTypeIds?: string[];
|
|
404
418
|
/** @description Description of what the queue is used for. */
|
|
405
419
|
description?: string;
|
|
406
420
|
/** @description Maximum number of retry attempts per item. Defaults to 3. */
|
|
@@ -421,6 +435,8 @@ interface components {
|
|
|
421
435
|
CreateQueueItemDto: {
|
|
422
436
|
/** @description External identifier used to deduplicate items within the queue. */
|
|
423
437
|
externalId?: string;
|
|
438
|
+
/** @description Optional Object (entity) this work item is about. Must belong to the same workspace. If the queue has allowed ObjectTypes configured, the Object type must be one of them. */
|
|
439
|
+
objectId?: string;
|
|
424
440
|
/** @description Arbitrary JSON payload for the item. Maximum size 64KB. */
|
|
425
441
|
data?: {
|
|
426
442
|
[key: string]: unknown;
|
|
@@ -467,11 +483,31 @@ interface components {
|
|
|
467
483
|
/** @description Workflow the execution belongs to. */
|
|
468
484
|
workflow: components["schemas"]["QueueItemExecutionWorkflowDto"];
|
|
469
485
|
};
|
|
486
|
+
QueueItemObjectTypeSummaryDto: {
|
|
487
|
+
/** @description Object type ID. */
|
|
488
|
+
id: string;
|
|
489
|
+
/** @description Object type name. */
|
|
490
|
+
name: string;
|
|
491
|
+
/** @description Object type slug. */
|
|
492
|
+
slug: string;
|
|
493
|
+
};
|
|
494
|
+
QueueItemObjectSummaryDto: {
|
|
495
|
+
/** @description Object ID. */
|
|
496
|
+
id: string;
|
|
497
|
+
/** @description Object display name. */
|
|
498
|
+
name: string;
|
|
499
|
+
/** @description Current object state ID. */
|
|
500
|
+
state: string | null;
|
|
501
|
+
/** @description Object type summary. */
|
|
502
|
+
objectType: components["schemas"]["QueueItemObjectTypeSummaryDto"];
|
|
503
|
+
};
|
|
470
504
|
QueueItemCreateResponseDto: {
|
|
471
505
|
/** @description Queue item ID. */
|
|
472
506
|
id: string;
|
|
473
507
|
/** @description External identifier used for deduplication. */
|
|
474
508
|
externalId: string | null;
|
|
509
|
+
/** @description Linked Object (entity) ID this work item is about, if any. */
|
|
510
|
+
objectId: string | null;
|
|
475
511
|
/** @description JSON payload for the item. */
|
|
476
512
|
data: {
|
|
477
513
|
[key: string]: unknown;
|
|
@@ -534,6 +570,8 @@ interface components {
|
|
|
534
570
|
queue?: components["schemas"]["QueueItemQueueSummaryDto"];
|
|
535
571
|
/** @description Most recently linked workflow execution. Included when `expansion=lastExecution` is requested. */
|
|
536
572
|
lastExecution?: components["schemas"]["QueueItemLastExecutionDto"] | null;
|
|
573
|
+
/** @description Linked Object summary. Included when `expansion=object` is requested. */
|
|
574
|
+
object?: components["schemas"]["QueueItemObjectSummaryDto"] | null;
|
|
537
575
|
/** @description True when an existing item with the same externalId was returned instead of creating a new one. */
|
|
538
576
|
isDuplicate: boolean;
|
|
539
577
|
};
|
|
@@ -554,6 +592,8 @@ interface components {
|
|
|
554
592
|
id: string;
|
|
555
593
|
/** @description External identifier used for deduplication. */
|
|
556
594
|
externalId: string | null;
|
|
595
|
+
/** @description Linked Object (entity) ID this work item is about, if any. */
|
|
596
|
+
objectId: string | null;
|
|
557
597
|
/** @description JSON payload for the item. */
|
|
558
598
|
data: {
|
|
559
599
|
[key: string]: unknown;
|
|
@@ -616,6 +656,8 @@ interface components {
|
|
|
616
656
|
queue?: components["schemas"]["QueueItemQueueSummaryDto"];
|
|
617
657
|
/** @description Most recently linked workflow execution. Included when `expansion=lastExecution` is requested. */
|
|
618
658
|
lastExecution?: components["schemas"]["QueueItemLastExecutionDto"] | null;
|
|
659
|
+
/** @description Linked Object summary. Included when `expansion=object` is requested. */
|
|
660
|
+
object?: components["schemas"]["QueueItemObjectSummaryDto"] | null;
|
|
619
661
|
};
|
|
620
662
|
BulkCreateQueueItemsSummaryDto: {
|
|
621
663
|
/** @description Number of items created. */
|
|
@@ -666,6 +708,8 @@ interface components {
|
|
|
666
708
|
updatedAt: string;
|
|
667
709
|
/** @description External identifier used for deduplication. */
|
|
668
710
|
externalId: string | null;
|
|
711
|
+
/** @description Linked Object (entity) ID this work item is about, if any. */
|
|
712
|
+
FK_objectId: string | null;
|
|
669
713
|
/** @description JSON payload for the item. */
|
|
670
714
|
data: {
|
|
671
715
|
[key: string]: unknown;
|
|
@@ -756,6 +800,8 @@ interface components {
|
|
|
756
800
|
UpdateQueueItemDto: {
|
|
757
801
|
/** @description External identifier used to deduplicate items within the queue. */
|
|
758
802
|
externalId?: string;
|
|
803
|
+
/** @description Optional Object (entity) this work item is about. Must belong to the same workspace. If the queue has allowed ObjectTypes configured, the Object type must be one of them. */
|
|
804
|
+
objectId?: string;
|
|
759
805
|
/** @description Arbitrary JSON payload for the item. Maximum size 64KB. */
|
|
760
806
|
data?: {
|
|
761
807
|
[key: string]: unknown;
|
|
@@ -921,233 +967,515 @@ interface components {
|
|
|
921
967
|
/** @description Marks the row as managed by code (CLI / SDK). Defaults to true on this endpoint. */
|
|
922
968
|
managedByCode?: boolean;
|
|
923
969
|
};
|
|
924
|
-
|
|
925
|
-
/**
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
/** @description App description. */
|
|
930
|
-
description: string;
|
|
931
|
-
/** @description URL of the app logo. */
|
|
932
|
-
logoUrl: string;
|
|
933
|
-
/** @description Whether the app is published and available for use. */
|
|
934
|
-
isPublished: boolean;
|
|
935
|
-
/** @description Whether the app requires a connection before its actions and triggers can run. */
|
|
936
|
-
needsConnection: boolean;
|
|
937
|
-
/** @description Whether the app can be used by agents. */
|
|
938
|
-
availableForAgent: boolean;
|
|
939
|
-
/** @description Action definitions, each with id, name, description, iconUrl, needsConnection, availableForAgent, viewOptions and the declarative inputConfig field metadata used to render action UIs. */
|
|
940
|
-
actions: {
|
|
941
|
-
[key: string]: unknown;
|
|
942
|
-
}[];
|
|
943
|
-
/** @description Trigger definitions, each with id, name, description, iconUrl, needsConnection and the declarative inputConfig field metadata used to render trigger UIs. */
|
|
944
|
-
triggers: {
|
|
945
|
-
[key: string]: unknown;
|
|
946
|
-
}[];
|
|
947
|
-
/** @description Connection type definitions supported by the app (e.g. oauth2, apiKey, basic), each with id, name, description, connectionType and any declarative inputConfig fields. */
|
|
948
|
-
connections: {
|
|
949
|
-
[key: string]: unknown;
|
|
950
|
-
}[];
|
|
951
|
-
};
|
|
952
|
-
ObjectTypeUserSummaryDto: {
|
|
953
|
-
/** @description User ID. */
|
|
954
|
-
id: string;
|
|
955
|
-
/** @description Email address of the user. */
|
|
956
|
-
email: string;
|
|
957
|
-
/** @description Display name of the user. */
|
|
958
|
-
name: string;
|
|
959
|
-
};
|
|
960
|
-
ObjectTypeCreatedByDto: {
|
|
961
|
-
/** @description Workspace user ID. */
|
|
962
|
-
id: string;
|
|
963
|
-
user: components["schemas"]["ObjectTypeUserSummaryDto"];
|
|
964
|
-
};
|
|
965
|
-
ObjectTypeCountDto: {
|
|
966
|
-
/** @description Number of non-deleted entities of this type. */
|
|
967
|
-
objects: number;
|
|
968
|
-
};
|
|
969
|
-
ObjectTypeResponseDto: {
|
|
970
|
-
/** @description Entity type ID. */
|
|
970
|
+
AgentResponseDto: {
|
|
971
|
+
/**
|
|
972
|
+
* @description Agent ID (UUID)
|
|
973
|
+
* @example 4f7c9d2e-8a1b-4c3d-9e5f-6a7b8c9d0e1f
|
|
974
|
+
*/
|
|
971
975
|
id: string;
|
|
972
|
-
/**
|
|
976
|
+
/**
|
|
977
|
+
* @description Agent name
|
|
978
|
+
* @example Invoice Triage Agent
|
|
979
|
+
*/
|
|
973
980
|
name: string;
|
|
974
|
-
/** @description
|
|
975
|
-
|
|
976
|
-
/** @description
|
|
977
|
-
|
|
978
|
-
/** @description
|
|
979
|
-
|
|
980
|
-
/** @description
|
|
981
|
-
color: string;
|
|
982
|
-
/** @description Whether the entity type is enabled. */
|
|
983
|
-
isEnabled: boolean;
|
|
984
|
-
/** @description Description of the entity type. Included when `expansion=description` is requested. */
|
|
981
|
+
/** @description Stable project-scoped slug for CLI / code deploy upserts. Included when `expansion=slug` is requested. */
|
|
982
|
+
slug?: string | null;
|
|
983
|
+
/** @description True when last written by code (CLI / SDK). Included when `expansion=managedByCode` is requested. */
|
|
984
|
+
managedByCode?: boolean;
|
|
985
|
+
/** @description ID of the AI provider connection assigned to the agent. Always included. Null when the agent falls back to the workspace default connection. */
|
|
986
|
+
FK_aiConnectionId: string | null;
|
|
987
|
+
/** @description Agent description. Included when `expansion=description` is requested. */
|
|
985
988
|
description?: string | null;
|
|
986
|
-
/** @description
|
|
987
|
-
|
|
988
|
-
[key: string]: unknown;
|
|
989
|
-
};
|
|
990
|
-
/** @description State machine definition. Included when `expansion=stateSchema` is requested. */
|
|
991
|
-
stateSchema?: {
|
|
992
|
-
[key: string]: unknown;
|
|
993
|
-
} | null;
|
|
989
|
+
/** @description Public URL of the agent profile image. Included when `expansion=profileImageUrl` is requested. */
|
|
990
|
+
profileImageUrl?: string | null;
|
|
994
991
|
/**
|
|
995
992
|
* Format: date-time
|
|
996
|
-
* @description Included when `expansion=createdAt` is requested.
|
|
993
|
+
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
997
994
|
*/
|
|
998
995
|
createdAt?: string;
|
|
999
996
|
/**
|
|
1000
997
|
* Format: date-time
|
|
1001
|
-
* @description Included when `expansion=updatedAt` is requested.
|
|
998
|
+
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
1002
999
|
*/
|
|
1003
1000
|
updatedAt?: string;
|
|
1004
|
-
/** @description
|
|
1005
|
-
|
|
1006
|
-
/** @description Included when `expansion=countObjects` is requested. */
|
|
1007
|
-
_count?: components["schemas"]["ObjectTypeCountDto"];
|
|
1008
|
-
};
|
|
1009
|
-
CreateObjectDto: {
|
|
1010
|
-
/** @description Display name of the entity. */
|
|
1011
|
-
name: string;
|
|
1001
|
+
/** @description System instructions authored for the agent. Included when `expansion=instructions` is requested. */
|
|
1002
|
+
instructions?: string | null;
|
|
1012
1003
|
/**
|
|
1013
|
-
*
|
|
1014
|
-
* @
|
|
1004
|
+
* @description Model temperature. Included when `expansion=temperature` is requested.
|
|
1005
|
+
* @example 1
|
|
1015
1006
|
*/
|
|
1016
|
-
|
|
1017
|
-
/** @description
|
|
1018
|
-
|
|
1019
|
-
/** @description Dynamic attribute values keyed by field ID. */
|
|
1020
|
-
attributes?: {
|
|
1021
|
-
[key: string]: unknown;
|
|
1022
|
-
};
|
|
1007
|
+
temperature?: number;
|
|
1008
|
+
/** @description Maximum output tokens per turn. Included when `expansion=maxOutputTokens` is requested. */
|
|
1009
|
+
maxOutputTokens?: number | null;
|
|
1023
1010
|
/**
|
|
1024
|
-
*
|
|
1025
|
-
* @
|
|
1011
|
+
* @description Top-p sampling. Included when `expansion=topP` is requested.
|
|
1012
|
+
* @example 1
|
|
1026
1013
|
*/
|
|
1027
|
-
|
|
1028
|
-
};
|
|
1029
|
-
ObjectTypeSummaryDto: {
|
|
1030
|
-
/** @description Entity type ID. */
|
|
1031
|
-
id: string;
|
|
1032
|
-
/** @description Singular display name of the entity type. */
|
|
1033
|
-
name: string;
|
|
1034
|
-
/** @description URL-safe slug of the entity type. */
|
|
1035
|
-
slug: string;
|
|
1036
|
-
/** @description Icon identifier for the entity type. */
|
|
1037
|
-
icon: string;
|
|
1038
|
-
/** @description Hex colour of the entity type. */
|
|
1039
|
-
color: string;
|
|
1040
|
-
/** @description Plural display name. Included when `expansion=objectType` is requested. */
|
|
1041
|
-
namePlural?: string;
|
|
1042
|
-
/** @description Field definitions grouped into sections. Included when `expansion=objectType` is requested on single-entity reads. */
|
|
1043
|
-
attributeSchema?: {
|
|
1044
|
-
[key: string]: unknown;
|
|
1045
|
-
};
|
|
1046
|
-
/** @description State machine definition. Included when `expansion=objectType` is requested. */
|
|
1047
|
-
stateSchema?: {
|
|
1048
|
-
[key: string]: unknown;
|
|
1049
|
-
} | null;
|
|
1050
|
-
};
|
|
1051
|
-
ObjectUserSummaryDto: {
|
|
1052
|
-
/** @description User ID. */
|
|
1053
|
-
id: string;
|
|
1054
|
-
/** @description Email address of the user. */
|
|
1055
|
-
email: string;
|
|
1056
|
-
/** @description Display name of the user. */
|
|
1057
|
-
name: string;
|
|
1058
|
-
};
|
|
1059
|
-
ObjectWorkspaceUserSummaryDto: {
|
|
1060
|
-
/** @description Workspace user ID. */
|
|
1061
|
-
id: string;
|
|
1062
|
-
user: components["schemas"]["ObjectUserSummaryDto"];
|
|
1063
|
-
};
|
|
1064
|
-
ObjectStateHistoryUserSummaryDto: {
|
|
1065
|
-
/** @description User ID. */
|
|
1066
|
-
id: string;
|
|
1067
|
-
/** @description Display name of the user. */
|
|
1068
|
-
name: string;
|
|
1069
|
-
};
|
|
1070
|
-
ObjectStateHistoryChangedByDto: {
|
|
1071
|
-
/** @description Workspace user ID. */
|
|
1072
|
-
id: string;
|
|
1073
|
-
user: components["schemas"]["ObjectStateHistoryUserSummaryDto"];
|
|
1074
|
-
};
|
|
1075
|
-
ObjectStateHistoryItemDto: {
|
|
1076
|
-
/** @description State history entry ID. */
|
|
1077
|
-
id: string;
|
|
1078
|
-
/** @description State the entity moved from. Null for the initial state. */
|
|
1079
|
-
fromState: string | null;
|
|
1080
|
-
/** @description State the entity moved to. */
|
|
1081
|
-
toState: string;
|
|
1082
|
-
/** @description Reason recorded for the state change, if any. */
|
|
1083
|
-
reason: string | null;
|
|
1014
|
+
topP?: number;
|
|
1084
1015
|
/**
|
|
1085
|
-
*
|
|
1086
|
-
* @
|
|
1016
|
+
* @description Frequency penalty. Included when `expansion=frequencyPenalty` is requested.
|
|
1017
|
+
* @example 0
|
|
1087
1018
|
*/
|
|
1088
|
-
|
|
1089
|
-
/** @description Workspace member who made the change, if recorded. */
|
|
1090
|
-
changedBy: components["schemas"]["ObjectStateHistoryChangedByDto"] | null;
|
|
1091
|
-
};
|
|
1092
|
-
ObjectResponseDto: {
|
|
1093
|
-
/** @description Entity ID. */
|
|
1094
|
-
id: string;
|
|
1095
|
-
/** @description Display name of the entity. */
|
|
1096
|
-
name: string;
|
|
1097
|
-
/** @description Current state of the entity, if the type defines states. */
|
|
1098
|
-
state: string | null;
|
|
1099
|
-
/** @description Dynamic attribute values keyed by field ID. */
|
|
1100
|
-
attributes: {
|
|
1101
|
-
[key: string]: unknown;
|
|
1102
|
-
};
|
|
1019
|
+
frequencyPenalty?: number;
|
|
1103
1020
|
/**
|
|
1104
|
-
*
|
|
1105
|
-
* @
|
|
1021
|
+
* @description Presence penalty. Included when `expansion=presencePenalty` is requested.
|
|
1022
|
+
* @example 0
|
|
1106
1023
|
*/
|
|
1107
|
-
|
|
1024
|
+
presencePenalty?: number;
|
|
1108
1025
|
/**
|
|
1109
|
-
*
|
|
1110
|
-
* @
|
|
1026
|
+
* @description Maximum retries for a failed model call. Included when `expansion=maxRetries` is requested.
|
|
1027
|
+
* @example 0
|
|
1111
1028
|
*/
|
|
1112
|
-
|
|
1113
|
-
/** @description
|
|
1114
|
-
|
|
1115
|
-
/**
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
/** @description
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
/** @description
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
/** @description
|
|
1138
|
-
|
|
1139
|
-
/** @description
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
/** @description
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
|
|
1029
|
+
maxRetries?: number;
|
|
1030
|
+
/** @description Fixed sampling seed. Included when `expansion=seed` is requested. */
|
|
1031
|
+
seed?: number | null;
|
|
1032
|
+
/**
|
|
1033
|
+
* @description Maximum tool roundtrips per turn. Included when `expansion=maxToolRoundtrips` is requested.
|
|
1034
|
+
* @example 5
|
|
1035
|
+
*/
|
|
1036
|
+
maxToolRoundtrips?: number;
|
|
1037
|
+
/**
|
|
1038
|
+
* @description How many previous messages are sent to the model. Included when `expansion=messageLookbackLimit` is requested.
|
|
1039
|
+
* @example 40
|
|
1040
|
+
*/
|
|
1041
|
+
messageLookbackLimit?: number;
|
|
1042
|
+
/** @description Configured tool nodes (app actions) for the agent. Included when `expansion=tools` is requested. */
|
|
1043
|
+
tools?: {
|
|
1044
|
+
[key: string]: unknown;
|
|
1045
|
+
}[] | null;
|
|
1046
|
+
/** @description Action IDs of the configured tools. Included when `expansion=toolIds` is requested. */
|
|
1047
|
+
toolIds?: string[];
|
|
1048
|
+
/** @description Instructions used when auto-naming new tasks. Included when `expansion=taskNamingInstructions` is requested. */
|
|
1049
|
+
taskNamingInstructions?: string | null;
|
|
1050
|
+
/** @description IDs of enabled provider built-in tools. Included when `expansion=enabledBuiltInTools` is requested. */
|
|
1051
|
+
enabledBuiltInTools?: string[];
|
|
1052
|
+
/** @description IDs of enabled platform tools. Included when `expansion=enabledPlatformTools` is requested. */
|
|
1053
|
+
enabledPlatformTools?: string[];
|
|
1054
|
+
/** @description Whether dynamic workflow-app action discovery is enabled. Included when `expansion=dynamicActionDiscoveryEnabled` is requested. */
|
|
1055
|
+
dynamicActionDiscoveryEnabled?: boolean;
|
|
1056
|
+
/** @description Whether dynamic MCP server discovery is enabled. Included when `expansion=dynamicMcpDiscoveryEnabled` is requested. */
|
|
1057
|
+
dynamicMcpDiscoveryEnabled?: boolean;
|
|
1058
|
+
/** @description Whether the agent maintains its own instructions. Included when `expansion=dynamicSelfInstructionsEnabled` is requested. */
|
|
1059
|
+
dynamicSelfInstructionsEnabled?: boolean;
|
|
1060
|
+
/** @description Whether long-term memory is enabled. Included when `expansion=memoryEnabled` is requested. */
|
|
1061
|
+
memoryEnabled?: boolean;
|
|
1062
|
+
/**
|
|
1063
|
+
* @description Memory partitioning scope. Included when `expansion=memoryScope` is requested.
|
|
1064
|
+
* @enum {string}
|
|
1065
|
+
*/
|
|
1066
|
+
memoryScope?: "PER_USER" | "PER_AGENT" | "PER_USER_PER_AGENT";
|
|
1067
|
+
/**
|
|
1068
|
+
* @description Days memories are retained. Included when `expansion=memoryRetentionDays` is requested.
|
|
1069
|
+
* @example 90
|
|
1070
|
+
*/
|
|
1071
|
+
memoryRetentionDays?: number;
|
|
1072
|
+
/** @description Suggested prompts shown to users starting a conversation. Included when `expansion=suggestedPrompts` is requested. */
|
|
1073
|
+
suggestedPrompts?: string[];
|
|
1074
|
+
/**
|
|
1075
|
+
* Format: date-time
|
|
1076
|
+
* @description When the first-time builder setup wizard was completed. Included when `expansion=builderSetupCompletedAt` is requested.
|
|
1077
|
+
*/
|
|
1078
|
+
builderSetupCompletedAt?: string | null;
|
|
1079
|
+
/** @description Saved canvas node positions for the agent builder. Included when `expansion=builderCanvasPositions` is requested. */
|
|
1080
|
+
builderCanvasPositions?: {
|
|
1081
|
+
[key: string]: unknown;
|
|
1082
|
+
} | null;
|
|
1083
|
+
/** @description Selected model ID within the AI provider connection. Included when `expansion=selectedModelId` is requested. */
|
|
1084
|
+
selectedModelId?: string | null;
|
|
1085
|
+
/** @description Assigned AI provider connection. Included when `expansion=aiConnection` is requested. */
|
|
1086
|
+
aiConnection?: {
|
|
1087
|
+
id?: string;
|
|
1088
|
+
name?: string;
|
|
1089
|
+
providerConfig?: {
|
|
1090
|
+
id?: string;
|
|
1091
|
+
providerSlug?: string;
|
|
1092
|
+
};
|
|
1093
|
+
} | null;
|
|
1094
|
+
/** @description Knowledge notebooks attached to the agent. Included when `expansion=knowledge` is requested. */
|
|
1095
|
+
agentKnowledge?: {
|
|
1096
|
+
id?: string;
|
|
1097
|
+
knowledge?: {
|
|
1098
|
+
id?: string;
|
|
1099
|
+
name?: string;
|
|
1100
|
+
};
|
|
1101
|
+
}[];
|
|
1102
|
+
/** @description Object types attached to the agent. Included when `expansion=objectTypes` is requested. */
|
|
1103
|
+
agentObjectTypes?: {
|
|
1104
|
+
id?: string;
|
|
1105
|
+
scope?: string;
|
|
1106
|
+
objectType?: {
|
|
1107
|
+
id?: string;
|
|
1108
|
+
name?: string;
|
|
1109
|
+
slug?: string;
|
|
1110
|
+
icon?: string | null;
|
|
1111
|
+
color?: string | null;
|
|
1112
|
+
};
|
|
1113
|
+
}[];
|
|
1114
|
+
/** @description Objects attached to the agent. Included when `expansion=objects` is requested. */
|
|
1115
|
+
agentObjects?: {
|
|
1116
|
+
id?: string;
|
|
1117
|
+
scope?: string;
|
|
1118
|
+
object?: {
|
|
1119
|
+
id?: string;
|
|
1120
|
+
name?: string;
|
|
1121
|
+
state?: string;
|
|
1122
|
+
objectType?: {
|
|
1123
|
+
id?: string;
|
|
1124
|
+
name?: string;
|
|
1125
|
+
slug?: string;
|
|
1126
|
+
icon?: string | null;
|
|
1127
|
+
color?: string | null;
|
|
1128
|
+
};
|
|
1129
|
+
};
|
|
1130
|
+
}[];
|
|
1131
|
+
/** @description App connections available to the agent. Included when `expansion=connections` is requested. */
|
|
1132
|
+
connections?: {
|
|
1133
|
+
id?: string;
|
|
1134
|
+
name?: string;
|
|
1135
|
+
}[];
|
|
1136
|
+
/** @description Variables attached to the agent. Included when `expansion=variables` is requested. */
|
|
1137
|
+
agentVariables?: {
|
|
1138
|
+
id?: string;
|
|
1139
|
+
variable?: {
|
|
1140
|
+
id?: string;
|
|
1141
|
+
name?: string;
|
|
1142
|
+
};
|
|
1143
|
+
}[];
|
|
1144
|
+
/** @description Workflows the agent can trigger. Included when `expansion=workflows` is requested. */
|
|
1145
|
+
agentWorkflows?: {
|
|
1146
|
+
id?: string;
|
|
1147
|
+
workflow?: {
|
|
1148
|
+
id?: string;
|
|
1149
|
+
name?: string;
|
|
1150
|
+
};
|
|
1151
|
+
}[];
|
|
1152
|
+
/** @description Sub-agent links for the agent. Included when `expansion=subAgents` is requested. */
|
|
1153
|
+
agentSubAgents?: {
|
|
1154
|
+
id?: string;
|
|
1155
|
+
subagent?: {
|
|
1156
|
+
id?: string;
|
|
1157
|
+
name?: string;
|
|
1158
|
+
};
|
|
1159
|
+
parentAgent?: {
|
|
1160
|
+
id?: string;
|
|
1161
|
+
name?: string;
|
|
1162
|
+
};
|
|
1163
|
+
}[];
|
|
1164
|
+
/** @description MCP servers attached to the agent, with per-tool overrides. Included when `expansion=mcpServers` is requested. */
|
|
1165
|
+
agentMcpServers?: {
|
|
1166
|
+
id?: string;
|
|
1167
|
+
mcpServer?: {
|
|
1168
|
+
id?: string;
|
|
1169
|
+
slug?: string;
|
|
1170
|
+
name?: string;
|
|
1171
|
+
provider?: string;
|
|
1172
|
+
logoUrl?: string | null;
|
|
1173
|
+
description?: string | null;
|
|
1174
|
+
};
|
|
1175
|
+
toolOverrides?: {
|
|
1176
|
+
id?: string;
|
|
1177
|
+
toolName?: string;
|
|
1178
|
+
enabled?: boolean;
|
|
1179
|
+
requireApproval?: boolean;
|
|
1180
|
+
}[];
|
|
1181
|
+
}[];
|
|
1182
|
+
/** @description A2A (agent-to-agent) endpoints attached to the agent. Included when `expansion=a2aAgents` is requested. */
|
|
1183
|
+
agentA2aAgents?: {
|
|
1184
|
+
id?: string;
|
|
1185
|
+
a2aAgent?: {
|
|
1186
|
+
id?: string;
|
|
1187
|
+
slug?: string;
|
|
1188
|
+
name?: string;
|
|
1189
|
+
logoUrl?: string | null;
|
|
1190
|
+
description?: string | null;
|
|
1191
|
+
authType?: string;
|
|
1192
|
+
};
|
|
1193
|
+
}[];
|
|
1194
|
+
/** @description Web access configuration. Included when `expansion=webAccess` is requested. */
|
|
1195
|
+
agentWebAccess?: {
|
|
1196
|
+
service?: string;
|
|
1197
|
+
webSearchEnabled?: boolean;
|
|
1198
|
+
websiteAccessEnabled?: boolean;
|
|
1199
|
+
} | null;
|
|
1200
|
+
/** @description Phone access configuration. Included when `expansion=phoneAccess` is requested. */
|
|
1201
|
+
agentPhoneAccess?: {
|
|
1202
|
+
service?: string;
|
|
1203
|
+
outboundCallsEnabled?: boolean;
|
|
1204
|
+
inboundCallsEnabled?: boolean;
|
|
1205
|
+
} | null;
|
|
1206
|
+
/** @description Project the agent belongs to. Included when `expansion=project` is requested. */
|
|
1207
|
+
project?: {
|
|
1208
|
+
id?: string;
|
|
1209
|
+
name?: string;
|
|
1210
|
+
};
|
|
1211
|
+
};
|
|
1212
|
+
UpsertAgentToolDto: {
|
|
1213
|
+
/** @description Workflow app id (catalogue slug). */
|
|
1214
|
+
appId: string;
|
|
1215
|
+
/** @description Catalogue action id. */
|
|
1216
|
+
actionId: string;
|
|
1217
|
+
/** @description Connection instance UUID pre-bound on the tool. */
|
|
1218
|
+
connectionId?: string;
|
|
1219
|
+
/** @description Tool display name for the model. */
|
|
1220
|
+
name?: string;
|
|
1221
|
+
/** @description Tool description shown to the model. */
|
|
1222
|
+
description?: string;
|
|
1223
|
+
/** @description Pre-filled tool config (fields left empty are filled by the model). */
|
|
1224
|
+
input?: {
|
|
1225
|
+
[key: string]: unknown;
|
|
1226
|
+
};
|
|
1227
|
+
};
|
|
1228
|
+
UpsertAgentBySlugDto: {
|
|
1229
|
+
/**
|
|
1230
|
+
* @description Stable project-scoped slug (lowercase, digits, hyphens). Used as the upsert key.
|
|
1231
|
+
* @example support-triage
|
|
1232
|
+
*/
|
|
1233
|
+
slug: string;
|
|
1234
|
+
/** @description Display name. Defaults to the slug when omitted. */
|
|
1235
|
+
name?: string;
|
|
1236
|
+
description?: string;
|
|
1237
|
+
/** @description System instructions / prompt for the agent. */
|
|
1238
|
+
instructions: string;
|
|
1239
|
+
/** @description Selected model id on the AI provider connection (e.g. `gpt-4o`). */
|
|
1240
|
+
model: string;
|
|
1241
|
+
/** @description AiProviderConnection UUID. When omitted, platform AI defaults apply. */
|
|
1242
|
+
aiConnectionId?: string;
|
|
1243
|
+
/** @description App Connection UUIDs the agent may use for tools. */
|
|
1244
|
+
connectionIds?: string[];
|
|
1245
|
+
/** @description Workflow UUIDs the agent may run (AgentWorkflow links). */
|
|
1246
|
+
workflowIds?: string[];
|
|
1247
|
+
/** @description Catalogue action tools (WorkflowNodeForRunner-shaped). */
|
|
1248
|
+
tools?: components["schemas"]["UpsertAgentToolDto"][];
|
|
1249
|
+
/** @description Marks the row as managed by code (CLI / SDK). Defaults to true on this endpoint. */
|
|
1250
|
+
managedByCode?: boolean;
|
|
1251
|
+
};
|
|
1252
|
+
WorkflowAppResponseDto: {
|
|
1253
|
+
/** @description App ID, e.g. `gmail`. Matches the appId used in workflow execution steps. */
|
|
1254
|
+
id: string;
|
|
1255
|
+
/** @description Human-readable app name. */
|
|
1256
|
+
name: string;
|
|
1257
|
+
/** @description App description. */
|
|
1258
|
+
description: string;
|
|
1259
|
+
/** @description URL of the app logo. */
|
|
1260
|
+
logoUrl: string;
|
|
1261
|
+
/** @description Whether the app is published and available for use. */
|
|
1262
|
+
isPublished: boolean;
|
|
1263
|
+
/** @description Whether the app requires a connection before its actions and triggers can run. */
|
|
1264
|
+
needsConnection: boolean;
|
|
1265
|
+
/** @description Whether the app can be used by agents. */
|
|
1266
|
+
availableForAgent: boolean;
|
|
1267
|
+
/** @description Action definitions, each with id, name, description, iconUrl, needsConnection, availableForAgent, viewOptions and the declarative inputConfig field metadata used to render action UIs. */
|
|
1268
|
+
actions: {
|
|
1269
|
+
[key: string]: unknown;
|
|
1270
|
+
}[];
|
|
1271
|
+
/** @description Trigger definitions, each with id, name, description, iconUrl, needsConnection and the declarative inputConfig field metadata used to render trigger UIs. */
|
|
1272
|
+
triggers: {
|
|
1273
|
+
[key: string]: unknown;
|
|
1274
|
+
}[];
|
|
1275
|
+
/** @description Connection type definitions supported by the app (e.g. oauth2, apiKey, basic), each with id, name, description, connectionType and any declarative inputConfig fields. */
|
|
1276
|
+
connections: {
|
|
1277
|
+
[key: string]: unknown;
|
|
1278
|
+
}[];
|
|
1279
|
+
};
|
|
1280
|
+
ObjectTypeUserSummaryDto: {
|
|
1281
|
+
/** @description User ID. */
|
|
1282
|
+
id: string;
|
|
1283
|
+
/** @description Email address of the user. */
|
|
1284
|
+
email: string;
|
|
1285
|
+
/** @description Display name of the user. */
|
|
1286
|
+
name: string;
|
|
1287
|
+
};
|
|
1288
|
+
ObjectTypeCreatedByDto: {
|
|
1289
|
+
/** @description Workspace user ID. */
|
|
1290
|
+
id: string;
|
|
1291
|
+
user: components["schemas"]["ObjectTypeUserSummaryDto"];
|
|
1292
|
+
};
|
|
1293
|
+
ObjectTypeCountDto: {
|
|
1294
|
+
/** @description Number of non-deleted entities of this type. */
|
|
1295
|
+
objects: number;
|
|
1296
|
+
};
|
|
1297
|
+
ObjectTypeResponseDto: {
|
|
1298
|
+
/** @description Entity type ID. */
|
|
1299
|
+
id: string;
|
|
1300
|
+
/** @description Singular display name of the entity type. */
|
|
1301
|
+
name: string;
|
|
1302
|
+
/** @description Plural display name of the entity type. */
|
|
1303
|
+
namePlural: string;
|
|
1304
|
+
/** @description URL-safe slug, unique within the workspace. */
|
|
1305
|
+
slug: string;
|
|
1306
|
+
/** @description Icon identifier for the entity type. */
|
|
1307
|
+
icon: string;
|
|
1308
|
+
/** @description Hex colour of the entity type. */
|
|
1309
|
+
color: string;
|
|
1310
|
+
/** @description Whether the entity type is enabled. */
|
|
1311
|
+
isEnabled: boolean;
|
|
1312
|
+
/** @description Description of the entity type. Included when `expansion=description` is requested. */
|
|
1313
|
+
description?: string | null;
|
|
1314
|
+
/** @description Field definitions grouped into sections. Included when `expansion=attributeSchema` is requested. */
|
|
1315
|
+
attributeSchema?: {
|
|
1316
|
+
[key: string]: unknown;
|
|
1317
|
+
};
|
|
1318
|
+
/** @description State machine definition. Included when `expansion=stateSchema` is requested. */
|
|
1319
|
+
stateSchema?: {
|
|
1320
|
+
[key: string]: unknown;
|
|
1321
|
+
} | null;
|
|
1322
|
+
/**
|
|
1323
|
+
* Format: date-time
|
|
1324
|
+
* @description Included when `expansion=createdAt` is requested.
|
|
1325
|
+
*/
|
|
1326
|
+
createdAt?: string;
|
|
1327
|
+
/**
|
|
1328
|
+
* Format: date-time
|
|
1329
|
+
* @description Included when `expansion=updatedAt` is requested.
|
|
1330
|
+
*/
|
|
1331
|
+
updatedAt?: string;
|
|
1332
|
+
/** @description Workspace member who created the entity type. Included when `expansion=createdBy` is requested. */
|
|
1333
|
+
createdBy?: components["schemas"]["ObjectTypeCreatedByDto"];
|
|
1334
|
+
/** @description Included when `expansion=countObjects` is requested. */
|
|
1335
|
+
_count?: components["schemas"]["ObjectTypeCountDto"];
|
|
1336
|
+
};
|
|
1337
|
+
CreateObjectDto: {
|
|
1338
|
+
/** @description Display name of the entity. */
|
|
1339
|
+
name: string;
|
|
1340
|
+
/**
|
|
1341
|
+
* Format: uuid
|
|
1342
|
+
* @description ID of the entity type to create the entity under.
|
|
1343
|
+
*/
|
|
1344
|
+
objectTypeId: string;
|
|
1345
|
+
/** @description Initial state ID. Must exist in the entity type state schema. Defaults to the schema initial state when omitted. */
|
|
1346
|
+
state?: string;
|
|
1347
|
+
/** @description Dynamic attribute values keyed by field ID. */
|
|
1348
|
+
attributes?: {
|
|
1349
|
+
[key: string]: unknown;
|
|
1350
|
+
};
|
|
1351
|
+
/**
|
|
1352
|
+
* Format: uuid
|
|
1353
|
+
* @description Workspace user ID of the entity owner.
|
|
1354
|
+
*/
|
|
1355
|
+
ownerId?: string;
|
|
1356
|
+
};
|
|
1357
|
+
ObjectTypeSummaryDto: {
|
|
1358
|
+
/** @description Entity type ID. */
|
|
1359
|
+
id: string;
|
|
1360
|
+
/** @description Singular display name of the entity type. */
|
|
1361
|
+
name: string;
|
|
1362
|
+
/** @description URL-safe slug of the entity type. */
|
|
1363
|
+
slug: string;
|
|
1364
|
+
/** @description Icon identifier for the entity type. */
|
|
1365
|
+
icon: string;
|
|
1366
|
+
/** @description Hex colour of the entity type. */
|
|
1367
|
+
color: string;
|
|
1368
|
+
/** @description Plural display name. Included when `expansion=objectType` is requested. */
|
|
1369
|
+
namePlural?: string;
|
|
1370
|
+
/** @description Field definitions grouped into sections. Included when `expansion=objectType` is requested on single-entity reads. */
|
|
1371
|
+
attributeSchema?: {
|
|
1372
|
+
[key: string]: unknown;
|
|
1373
|
+
};
|
|
1374
|
+
/** @description State machine definition. Included when `expansion=objectType` is requested. */
|
|
1375
|
+
stateSchema?: {
|
|
1376
|
+
[key: string]: unknown;
|
|
1377
|
+
} | null;
|
|
1378
|
+
};
|
|
1379
|
+
ObjectUserSummaryDto: {
|
|
1380
|
+
/** @description User ID. */
|
|
1381
|
+
id: string;
|
|
1382
|
+
/** @description Email address of the user. */
|
|
1383
|
+
email: string;
|
|
1384
|
+
/** @description Display name of the user. */
|
|
1385
|
+
name: string;
|
|
1386
|
+
};
|
|
1387
|
+
ObjectWorkspaceUserSummaryDto: {
|
|
1388
|
+
/** @description Workspace user ID. */
|
|
1389
|
+
id: string;
|
|
1390
|
+
user: components["schemas"]["ObjectUserSummaryDto"];
|
|
1391
|
+
};
|
|
1392
|
+
ObjectStateHistoryUserSummaryDto: {
|
|
1393
|
+
/** @description User ID. */
|
|
1394
|
+
id: string;
|
|
1395
|
+
/** @description Display name of the user. */
|
|
1396
|
+
name: string;
|
|
1397
|
+
};
|
|
1398
|
+
ObjectStateHistoryChangedByDto: {
|
|
1399
|
+
/** @description Workspace user ID. */
|
|
1400
|
+
id: string;
|
|
1401
|
+
user: components["schemas"]["ObjectStateHistoryUserSummaryDto"];
|
|
1402
|
+
};
|
|
1403
|
+
ObjectStateHistoryItemDto: {
|
|
1404
|
+
/** @description State history entry ID. */
|
|
1405
|
+
id: string;
|
|
1406
|
+
/** @description State the entity moved from. Null for the initial state. */
|
|
1407
|
+
fromState: string | null;
|
|
1408
|
+
/** @description State the entity moved to. */
|
|
1409
|
+
toState: string;
|
|
1410
|
+
/** @description Reason recorded for the state change, if any. */
|
|
1411
|
+
reason: string | null;
|
|
1412
|
+
/**
|
|
1413
|
+
* Format: date-time
|
|
1414
|
+
* @description When the state change occurred.
|
|
1415
|
+
*/
|
|
1416
|
+
createdAt: string;
|
|
1417
|
+
/** @description Workspace member who made the change, if recorded. */
|
|
1418
|
+
changedBy: components["schemas"]["ObjectStateHistoryChangedByDto"] | null;
|
|
1419
|
+
};
|
|
1420
|
+
ObjectResponseDto: {
|
|
1421
|
+
/** @description Entity ID. */
|
|
1422
|
+
id: string;
|
|
1423
|
+
/** @description Display name of the entity. */
|
|
1424
|
+
name: string;
|
|
1425
|
+
/** @description Current state of the entity, if the type defines states. */
|
|
1426
|
+
state: string | null;
|
|
1427
|
+
/** @description Dynamic attribute values keyed by field ID. */
|
|
1428
|
+
attributes: {
|
|
1429
|
+
[key: string]: unknown;
|
|
1430
|
+
};
|
|
1431
|
+
/**
|
|
1432
|
+
* Format: date-time
|
|
1433
|
+
* @description Included when `expansion=createdAt` is requested.
|
|
1434
|
+
*/
|
|
1435
|
+
createdAt?: string;
|
|
1436
|
+
/**
|
|
1437
|
+
* Format: date-time
|
|
1438
|
+
* @description Included by default on list responses, otherwise when `expansion=updatedAt` is requested.
|
|
1439
|
+
*/
|
|
1440
|
+
updatedAt?: string;
|
|
1441
|
+
/** @description Included by default on list responses with a minimal shape, otherwise when `expansion=objectType` is requested. */
|
|
1442
|
+
objectType?: components["schemas"]["ObjectTypeSummaryDto"];
|
|
1443
|
+
/** @description Included when `expansion=owner` is requested. */
|
|
1444
|
+
owner?: components["schemas"]["ObjectWorkspaceUserSummaryDto"] | null;
|
|
1445
|
+
/** @description Included when `expansion=createdBy` is requested. */
|
|
1446
|
+
createdBy?: components["schemas"]["ObjectWorkspaceUserSummaryDto"] | null;
|
|
1447
|
+
/** @description Most recent state changes (up to 50, newest first). Included when `expansion=stateHistory` is requested. */
|
|
1448
|
+
stateHistory?: components["schemas"]["ObjectStateHistoryItemDto"][];
|
|
1449
|
+
};
|
|
1450
|
+
ObjectPaginationDto: {
|
|
1451
|
+
/** @description Current page number (1-based). */
|
|
1452
|
+
page: number;
|
|
1453
|
+
/** @description Number of items per page (maximum 100). */
|
|
1454
|
+
pageSize: number;
|
|
1455
|
+
/** @description Total number of matching entities. */
|
|
1456
|
+
totalCount: number;
|
|
1457
|
+
/** @description Total number of pages. */
|
|
1458
|
+
totalPages: number;
|
|
1459
|
+
};
|
|
1460
|
+
PaginatedObjectsResponseDto: {
|
|
1461
|
+
data: components["schemas"]["ObjectResponseDto"][];
|
|
1462
|
+
pagination: components["schemas"]["ObjectPaginationDto"];
|
|
1463
|
+
};
|
|
1464
|
+
UpdateObjectDto: {
|
|
1465
|
+
/** @description New display name of the entity. */
|
|
1466
|
+
name?: string;
|
|
1467
|
+
/** @description Attribute values keyed by field ID. Merged into the existing attributes; fields not supplied are left unchanged. */
|
|
1468
|
+
attributes?: {
|
|
1469
|
+
[key: string]: unknown;
|
|
1470
|
+
};
|
|
1471
|
+
/** @description Workspace user ID of the new entity owner. */
|
|
1472
|
+
ownerId?: string;
|
|
1473
|
+
};
|
|
1474
|
+
ChangeObjectStateDto: {
|
|
1475
|
+
/** @description ID of the target state. Must be a valid transition from the current state when the entity type defines transitions. */
|
|
1476
|
+
newState: string;
|
|
1477
|
+
/** @description Reason for the state change. Required when the transition is configured with requiresReason. */
|
|
1478
|
+
reason?: string;
|
|
1151
1479
|
};
|
|
1152
1480
|
ChangeObjectStateResponseDto: {
|
|
1153
1481
|
/** @description Entity ID. */
|
|
@@ -1495,288 +1823,35 @@ interface components {
|
|
|
1495
1823
|
description?: string;
|
|
1496
1824
|
/** @description Selectable options when the field is a select-like input */
|
|
1497
1825
|
options?: {
|
|
1498
|
-
label?: string;
|
|
1499
|
-
value?: string;
|
|
1500
|
-
}[];
|
|
1501
|
-
};
|
|
1502
|
-
PendingInputDto: {
|
|
1503
|
-
/** @description ID of the waiting workflow node */
|
|
1504
|
-
nodeId: string;
|
|
1505
|
-
/** @description Human-friendly node name */
|
|
1506
|
-
label: string;
|
|
1507
|
-
/** @description Action ID of the waiting node, when it is an action step */
|
|
1508
|
-
actionId?: string;
|
|
1509
|
-
/** @description Optional instructions configured on the waiting node */
|
|
1510
|
-
instructions?: string;
|
|
1511
|
-
/** @description Fields the custom UI should collect. Submit values keyed by field `id` to POST /api/webhooks/executions/{executionId}/nodes/{nodeId}/input. */
|
|
1512
|
-
fields: components["schemas"]["PendingInputFieldDto"][];
|
|
1513
|
-
};
|
|
1514
|
-
ExecutionResponseDto: {
|
|
1515
|
-
/** @description Execution ID */
|
|
1516
|
-
id: string;
|
|
1517
|
-
/**
|
|
1518
|
-
* Format: date-time
|
|
1519
|
-
* @description Timestamp when the execution started. Always returned by GET /executions/{executionId}; included in list responses when `expansion=startedAt` is requested.
|
|
1520
|
-
*/
|
|
1521
|
-
startedAt?: string;
|
|
1522
|
-
/**
|
|
1523
|
-
* Format: date-time
|
|
1524
|
-
* @description Timestamp when the execution stopped. Included when `expansion=stoppedAt` is requested.
|
|
1525
|
-
*/
|
|
1526
|
-
stoppedAt?: string | null;
|
|
1527
|
-
/**
|
|
1528
|
-
* Format: date-time
|
|
1529
|
-
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
1530
|
-
*/
|
|
1531
|
-
createdAt?: string;
|
|
1532
|
-
/**
|
|
1533
|
-
* Format: date-time
|
|
1534
|
-
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
1535
|
-
*/
|
|
1536
|
-
updatedAt?: string | null;
|
|
1537
|
-
/** @description Sequential execution number within the workflow. Included when `expansion=executionNumber` is requested. */
|
|
1538
|
-
executionNumber?: number;
|
|
1539
|
-
/** @description Raw execution node state (JSON). Included when `expansion=nodes` is requested. Most integrations should prefer the `executionPath` expansion instead. */
|
|
1540
|
-
nodes?: {
|
|
1541
|
-
[key: string]: unknown;
|
|
1542
|
-
}[];
|
|
1543
|
-
/** @description Raw execution edge state (JSON). Included when `expansion=edges` is requested. */
|
|
1544
|
-
edges?: {
|
|
1545
|
-
[key: string]: unknown;
|
|
1546
|
-
}[];
|
|
1547
|
-
/**
|
|
1548
|
-
* @description Overall execution status. Included when `expansion=status` is requested.
|
|
1549
|
-
* @enum {string}
|
|
1550
|
-
*/
|
|
1551
|
-
status?: "RUNNING" | "SUCCESS" | "FAILED" | "NEEDS_INPUT" | "SCHEDULED" | "CANCELLED" | "WAITING";
|
|
1552
|
-
/** @description Human-readable status detail. Included when `expansion=statusMessage` is requested. */
|
|
1553
|
-
statusMessage?: string | null;
|
|
1554
|
-
/** @description Final output of the execution (JSON). Included when `expansion=output` is requested. */
|
|
1555
|
-
output?: {
|
|
1556
|
-
[key: string]: unknown;
|
|
1557
|
-
} | null;
|
|
1558
|
-
/**
|
|
1559
|
-
* Format: date-time
|
|
1560
|
-
* @description Timestamp when a waiting execution is scheduled to continue. Included when `expansion=continueExecutionAt` is requested.
|
|
1561
|
-
*/
|
|
1562
|
-
continueExecutionAt?: string | null;
|
|
1563
|
-
/**
|
|
1564
|
-
* @description Editor orientation of the workflow canvas at execution time. Included when `expansion=orientation` is requested.
|
|
1565
|
-
* @enum {string}
|
|
1566
|
-
*/
|
|
1567
|
-
workflowOrientation?: "HORIZONTAL" | "VERTICAL";
|
|
1568
|
-
/** @description Variables captured during the execution (JSON). Included when `expansion=executionVariables` is requested. */
|
|
1569
|
-
executionVariables?: {
|
|
1570
|
-
[key: string]: unknown;
|
|
1571
|
-
} | null;
|
|
1572
|
-
/** @description The workflow the execution belongs to. Included when `expansion=workflow` is requested. */
|
|
1573
|
-
workflow?: components["schemas"]["ExecutionWorkflowSummaryDto"];
|
|
1574
|
-
/** @description Business-readable, ordered representation of the executed (or queued) steps, derived from the raw node and edge state: step labels, per-step status (including NEEDS_INPUT for steps paused awaiting user input), start and end timings, and loop iteration metadata. Custom UIs render execution progress from this field. Included when `expansion=executionPath` is requested. Only returned by GET /executions/{executionId}. */
|
|
1575
|
-
executionPath?: components["schemas"]["ExecutionPathStepDto"][];
|
|
1576
|
-
/** @description Field schemas for steps currently paused in NEEDS_INPUT. Each entry includes the waiting nodeId, label, optional instructions, and the fields to collect. Submit values keyed by field id to POST /api/webhooks/executions/{executionId}/nodes/{nodeId}/input. Included when `expansion=pendingInput` is requested. Only returned by GET /executions/{executionId}. Null when no step is waiting for input. */
|
|
1577
|
-
pendingInput?: components["schemas"]["PendingInputDto"][] | null;
|
|
1578
|
-
/**
|
|
1579
|
-
* @description How the execution was started. `WORKFLOW` for graph runs; `SDK` for ad-hoc single-action runs from the Public API / client SDK. Included when `expansion=source` is requested.
|
|
1580
|
-
* @enum {string}
|
|
1581
|
-
*/
|
|
1582
|
-
source?: "WORKFLOW" | "SDK";
|
|
1583
|
-
/** @description Optional display name (set for ad-hoc SDK runs). Included when `expansion=name` is requested. */
|
|
1584
|
-
name?: string | null;
|
|
1585
|
-
};
|
|
1586
|
-
RunActionDto: {
|
|
1587
|
-
/** @description Workflow app id (catalogue slug), e.g. `http`, `gmail`. */
|
|
1588
|
-
appId: string;
|
|
1589
|
-
/** @description Action id within the app, e.g. `http_action_send-request`. Discover via GET /workflow-apps (`actions[].id` / `inputConfig`). */
|
|
1590
|
-
actionId: string;
|
|
1591
|
-
/** @description Connection instance UUID (`Connection.id`). Required when the action needs a connection and the workspace has more than one connection for the app with no single workspace default. When omitted: sole usable connection for the app is used; else the workspace default (`isDefault`); else 400 with candidates. Never silently picks among multiple non-default connections. */
|
|
1592
|
-
connectionId?: string;
|
|
1593
|
-
/** @description Project UUID used for variable/project scoping. When omitted and the workspace has exactly one project, that project is used; otherwise the request fails with 400. */
|
|
1594
|
-
projectId?: string;
|
|
1595
|
-
/** @description Action input fields (mirrors the action `inputConfig` keys). Combined with `connectionId` into the action configValue. */
|
|
1596
|
-
input?: {
|
|
1597
|
-
[key: string]: unknown;
|
|
1598
|
-
};
|
|
1599
|
-
/** @description Optional display name for the ad-hoc Execution. */
|
|
1600
|
-
name?: string;
|
|
1601
|
-
};
|
|
1602
|
-
RunActionResponseDto: {
|
|
1603
|
-
/** @description ID of the ad-hoc Execution. Use GET /executions/{executionId} (with expansion=executionPath) to re-read progress. */
|
|
1604
|
-
id: string;
|
|
1605
|
-
/**
|
|
1606
|
-
* @description Final execution status after the single action step.
|
|
1607
|
-
* @enum {string}
|
|
1608
|
-
*/
|
|
1609
|
-
status: "RUNNING" | "SUCCESS" | "FAILED" | "NEEDS_INPUT" | "SCHEDULED" | "CANCELLED" | "WAITING";
|
|
1610
|
-
/** @description Human-readable status detail. */
|
|
1611
|
-
statusMessage?: string | null;
|
|
1612
|
-
/** @description Action output on success (same shape as a workflow step output). Null on failure or when the run paused. */
|
|
1613
|
-
output?: {
|
|
1614
|
-
[key: string]: unknown;
|
|
1615
|
-
} | null;
|
|
1616
|
-
/** @description Single-step executionPath for the ad-hoc run (label, status, timings). */
|
|
1617
|
-
executionPath?: components["schemas"]["ExecutionPathStepDto"][];
|
|
1618
|
-
};
|
|
1619
|
-
RunStepDto: {
|
|
1620
|
-
/** @description Workflow app id (catalogue slug), e.g. `http`, `gmail`. */
|
|
1621
|
-
appId: string;
|
|
1622
|
-
/** @description Action id within the app, e.g. `http_action_send-request`. Discover via GET /workflow-apps. */
|
|
1623
|
-
actionId: string;
|
|
1624
|
-
/** @description Connection instance UUID. When omitted, the platform resolves: sole usable connection for the app, else the workspace default (`isDefault`), else 400 with candidates. */
|
|
1625
|
-
connectionId?: string;
|
|
1626
|
-
/** @description Action input fields (mirrors the action `inputConfig` keys). */
|
|
1627
|
-
input?: {
|
|
1628
|
-
[key: string]: unknown;
|
|
1629
|
-
};
|
|
1630
|
-
/** @description Optional display name for this step. */
|
|
1631
|
-
name?: string;
|
|
1632
|
-
};
|
|
1633
|
-
StartRunDto: {
|
|
1634
|
-
/** @description Linear catalogue-action steps. Executed as one multi-step Execution with `source: SDK` (not a soft batch / correlation id). */
|
|
1635
|
-
steps: components["schemas"]["RunStepDto"][];
|
|
1636
|
-
/** @description Project UUID for variable/project scoping. When omitted and the workspace has exactly one project, that project is used. */
|
|
1637
|
-
projectId?: string;
|
|
1638
|
-
/** @description Optional display name for the ad-hoc Execution. */
|
|
1639
|
-
name?: string;
|
|
1640
|
-
};
|
|
1641
|
-
CreateVariableDto: {
|
|
1642
|
-
/** @description Name of the variable. */
|
|
1643
|
-
name: string;
|
|
1644
|
-
/** @description Description of the variable. */
|
|
1645
|
-
description?: string;
|
|
1646
|
-
/**
|
|
1647
|
-
* @description Scope of the variable (system, workspace or project).
|
|
1648
|
-
* @enum {string}
|
|
1649
|
-
*/
|
|
1650
|
-
type: "system" | "workspace" | "project";
|
|
1651
|
-
/**
|
|
1652
|
-
* @description Data type of the variable value.
|
|
1653
|
-
* @enum {string}
|
|
1654
|
-
*/
|
|
1655
|
-
dataType: "string" | "number" | "boolean" | "date" | "json";
|
|
1656
|
-
/** @description Project ID to scope the variable to. Must belong to the current workspace. */
|
|
1657
|
-
projectId?: string;
|
|
1658
|
-
/** @description Variable value, submitted as a string. Values with dataType `number` are converted to numbers on save. */
|
|
1659
|
-
value: string;
|
|
1660
|
-
};
|
|
1661
|
-
VariableWorkspaceDto: {
|
|
1662
|
-
/** @description Workspace ID. */
|
|
1663
|
-
id: string;
|
|
1664
|
-
/** @description Workspace name. */
|
|
1665
|
-
name: string;
|
|
1666
|
-
};
|
|
1667
|
-
VariableProjectDto: {
|
|
1668
|
-
/** @description Project ID. */
|
|
1669
|
-
id: string;
|
|
1670
|
-
/** @description Project name. */
|
|
1671
|
-
name: string;
|
|
1672
|
-
};
|
|
1673
|
-
VariableResponseDto: {
|
|
1674
|
-
/** @description Variable ID. */
|
|
1675
|
-
id: string;
|
|
1676
|
-
/** @description Variable name. */
|
|
1677
|
-
name: string;
|
|
1678
|
-
/**
|
|
1679
|
-
* @description Data type of the variable value.
|
|
1680
|
-
* @enum {string}
|
|
1681
|
-
*/
|
|
1682
|
-
dataType: "string" | "number" | "boolean" | "date" | "json";
|
|
1683
|
-
/**
|
|
1684
|
-
* @description Scope of the variable (system, workspace or project).
|
|
1685
|
-
* @enum {string}
|
|
1686
|
-
*/
|
|
1687
|
-
type: "system" | "workspace" | "project";
|
|
1688
|
-
/** @description Variable value. Included when `expansion=value` is requested. */
|
|
1689
|
-
value?: Record<string, never>;
|
|
1690
|
-
/** @description Variable description. Included when `expansion=description` is requested. */
|
|
1691
|
-
description?: string;
|
|
1692
|
-
/**
|
|
1693
|
-
* Format: date-time
|
|
1694
|
-
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
1695
|
-
*/
|
|
1696
|
-
createdAt?: string;
|
|
1697
|
-
/**
|
|
1698
|
-
* Format: date-time
|
|
1699
|
-
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
1700
|
-
*/
|
|
1701
|
-
updatedAt?: string;
|
|
1702
|
-
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
1703
|
-
workspace?: components["schemas"]["VariableWorkspaceDto"];
|
|
1704
|
-
/** @description Owning project for project-scoped variables. Included when `expansion=project` is requested. */
|
|
1705
|
-
project?: components["schemas"]["VariableProjectDto"];
|
|
1706
|
-
};
|
|
1707
|
-
UpdateVariableDto: {
|
|
1708
|
-
/** @description Name of the variable. */
|
|
1709
|
-
name?: string;
|
|
1710
|
-
/** @description Description of the variable. */
|
|
1711
|
-
description?: string;
|
|
1712
|
-
/**
|
|
1713
|
-
* @description Scope of the variable (system, workspace or project).
|
|
1714
|
-
* @enum {string}
|
|
1715
|
-
*/
|
|
1716
|
-
type?: "system" | "workspace" | "project";
|
|
1717
|
-
/**
|
|
1718
|
-
* @description Data type of the variable value.
|
|
1719
|
-
* @enum {string}
|
|
1720
|
-
*/
|
|
1721
|
-
dataType?: "string" | "number" | "boolean" | "date" | "json";
|
|
1722
|
-
/** @description Project ID to scope the variable to. Must belong to the current workspace. */
|
|
1723
|
-
projectId?: string;
|
|
1724
|
-
/** @description Variable value, submitted as a string. Values with dataType `number` are converted to numbers on save. */
|
|
1725
|
-
value?: string;
|
|
1726
|
-
};
|
|
1727
|
-
ConnectionWorkspaceDto: {
|
|
1728
|
-
/** @description Workspace ID. */
|
|
1729
|
-
id: string;
|
|
1730
|
-
/** @description Workspace name. */
|
|
1731
|
-
name: string;
|
|
1826
|
+
label?: string;
|
|
1827
|
+
value?: string;
|
|
1828
|
+
}[];
|
|
1732
1829
|
};
|
|
1733
|
-
|
|
1734
|
-
/** @description
|
|
1830
|
+
PendingInputDto: {
|
|
1831
|
+
/** @description ID of the waiting workflow node */
|
|
1832
|
+
nodeId: string;
|
|
1833
|
+
/** @description Human-friendly node name */
|
|
1834
|
+
label: string;
|
|
1835
|
+
/** @description Action ID of the waiting node, when it is an action step */
|
|
1836
|
+
actionId?: string;
|
|
1837
|
+
/** @description Optional instructions configured on the waiting node */
|
|
1838
|
+
instructions?: string;
|
|
1839
|
+
/** @description Fields the custom UI should collect. Submit values keyed by field `id` to POST /api/webhooks/executions/{executionId}/nodes/{nodeId}/input. */
|
|
1840
|
+
fields: components["schemas"]["PendingInputFieldDto"][];
|
|
1841
|
+
};
|
|
1842
|
+
ExecutionResponseDto: {
|
|
1843
|
+
/** @description Execution ID */
|
|
1735
1844
|
id: string;
|
|
1736
|
-
/** @description Connection name. */
|
|
1737
|
-
name: string;
|
|
1738
1845
|
/**
|
|
1739
1846
|
* Format: date-time
|
|
1740
|
-
* @description
|
|
1847
|
+
* @description Timestamp when the execution started. Always returned by GET /executions/{executionId}; included in list responses when `expansion=startedAt` is requested.
|
|
1741
1848
|
*/
|
|
1742
|
-
|
|
1849
|
+
startedAt?: string;
|
|
1743
1850
|
/**
|
|
1744
1851
|
* Format: date-time
|
|
1745
|
-
* @description
|
|
1746
|
-
*/
|
|
1747
|
-
updatedAt?: string;
|
|
1748
|
-
/** @description App connection type ID (e.g. the OAuth2 or API key connection definition of the app). Included when `expansion=connectionId` is requested. */
|
|
1749
|
-
connectionId?: string;
|
|
1750
|
-
/** @description ID of the workflow app this connection belongs to. Included when `expansion=workflowAppId` or `expansion=workflowApp` is requested. */
|
|
1751
|
-
workflowAppId?: string;
|
|
1752
|
-
/** @description Full workflow app definition for this connection. Included when `expansion=workflowApp` is requested on the list endpoint. */
|
|
1753
|
-
workflowApp?: {
|
|
1754
|
-
[key: string]: unknown;
|
|
1755
|
-
};
|
|
1756
|
-
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
1757
|
-
workspace?: components["schemas"]["ConnectionWorkspaceDto"];
|
|
1758
|
-
};
|
|
1759
|
-
AgentResponseDto: {
|
|
1760
|
-
/**
|
|
1761
|
-
* @description Agent ID (UUID)
|
|
1762
|
-
* @example 4f7c9d2e-8a1b-4c3d-9e5f-6a7b8c9d0e1f
|
|
1763
|
-
*/
|
|
1764
|
-
id: string;
|
|
1765
|
-
/**
|
|
1766
|
-
* @description Agent name
|
|
1767
|
-
* @example Invoice Triage Agent
|
|
1852
|
+
* @description Timestamp when the execution stopped. Included when `expansion=stoppedAt` is requested.
|
|
1768
1853
|
*/
|
|
1769
|
-
|
|
1770
|
-
/** @description Stable project-scoped slug for CLI / code deploy upserts. Included when `expansion=slug` is requested. */
|
|
1771
|
-
slug?: string | null;
|
|
1772
|
-
/** @description True when last written by code (CLI / SDK). Included when `expansion=managedByCode` is requested. */
|
|
1773
|
-
managedByCode?: boolean;
|
|
1774
|
-
/** @description ID of the AI provider connection assigned to the agent. Always included. Null when the agent falls back to the workspace default connection. */
|
|
1775
|
-
FK_aiConnectionId: string | null;
|
|
1776
|
-
/** @description Agent description. Included when `expansion=description` is requested. */
|
|
1777
|
-
description?: string | null;
|
|
1778
|
-
/** @description Public URL of the agent profile image. Included when `expansion=profileImageUrl` is requested. */
|
|
1779
|
-
profileImageUrl?: string | null;
|
|
1854
|
+
stoppedAt?: string | null;
|
|
1780
1855
|
/**
|
|
1781
1856
|
* Format: date-time
|
|
1782
1857
|
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
@@ -1784,259 +1859,230 @@ interface components {
|
|
|
1784
1859
|
createdAt?: string;
|
|
1785
1860
|
/**
|
|
1786
1861
|
* Format: date-time
|
|
1787
|
-
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
1788
|
-
*/
|
|
1789
|
-
updatedAt?: string;
|
|
1790
|
-
/** @description
|
|
1791
|
-
|
|
1792
|
-
/**
|
|
1793
|
-
|
|
1794
|
-
|
|
1795
|
-
*/
|
|
1796
|
-
temperature?: number;
|
|
1797
|
-
/** @description Maximum output tokens per turn. Included when `expansion=maxOutputTokens` is requested. */
|
|
1798
|
-
maxOutputTokens?: number | null;
|
|
1799
|
-
/**
|
|
1800
|
-
* @description Top-p sampling. Included when `expansion=topP` is requested.
|
|
1801
|
-
* @example 1
|
|
1802
|
-
*/
|
|
1803
|
-
topP?: number;
|
|
1804
|
-
/**
|
|
1805
|
-
* @description Frequency penalty. Included when `expansion=frequencyPenalty` is requested.
|
|
1806
|
-
* @example 0
|
|
1807
|
-
*/
|
|
1808
|
-
frequencyPenalty?: number;
|
|
1809
|
-
/**
|
|
1810
|
-
* @description Presence penalty. Included when `expansion=presencePenalty` is requested.
|
|
1811
|
-
* @example 0
|
|
1812
|
-
*/
|
|
1813
|
-
presencePenalty?: number;
|
|
1814
|
-
/**
|
|
1815
|
-
* @description Maximum retries for a failed model call. Included when `expansion=maxRetries` is requested.
|
|
1816
|
-
* @example 0
|
|
1817
|
-
*/
|
|
1818
|
-
maxRetries?: number;
|
|
1819
|
-
/** @description Fixed sampling seed. Included when `expansion=seed` is requested. */
|
|
1820
|
-
seed?: number | null;
|
|
1821
|
-
/**
|
|
1822
|
-
* @description Maximum tool roundtrips per turn. Included when `expansion=maxToolRoundtrips` is requested.
|
|
1823
|
-
* @example 5
|
|
1824
|
-
*/
|
|
1825
|
-
maxToolRoundtrips?: number;
|
|
1826
|
-
/**
|
|
1827
|
-
* @description How many previous messages are sent to the model. Included when `expansion=messageLookbackLimit` is requested.
|
|
1828
|
-
* @example 40
|
|
1829
|
-
*/
|
|
1830
|
-
messageLookbackLimit?: number;
|
|
1831
|
-
/** @description Configured tool nodes (app actions) for the agent. Included when `expansion=tools` is requested. */
|
|
1832
|
-
tools?: {
|
|
1833
|
-
[key: string]: unknown;
|
|
1834
|
-
}[] | null;
|
|
1835
|
-
/** @description Action IDs of the configured tools. Included when `expansion=toolIds` is requested. */
|
|
1836
|
-
toolIds?: string[];
|
|
1837
|
-
/** @description Instructions used when auto-naming new tasks. Included when `expansion=taskNamingInstructions` is requested. */
|
|
1838
|
-
taskNamingInstructions?: string | null;
|
|
1839
|
-
/** @description IDs of enabled provider built-in tools. Included when `expansion=enabledBuiltInTools` is requested. */
|
|
1840
|
-
enabledBuiltInTools?: string[];
|
|
1841
|
-
/** @description IDs of enabled platform tools. Included when `expansion=enabledPlatformTools` is requested. */
|
|
1842
|
-
enabledPlatformTools?: string[];
|
|
1843
|
-
/** @description Whether dynamic workflow-app action discovery is enabled. Included when `expansion=dynamicActionDiscoveryEnabled` is requested. */
|
|
1844
|
-
dynamicActionDiscoveryEnabled?: boolean;
|
|
1845
|
-
/** @description Whether dynamic MCP server discovery is enabled. Included when `expansion=dynamicMcpDiscoveryEnabled` is requested. */
|
|
1846
|
-
dynamicMcpDiscoveryEnabled?: boolean;
|
|
1847
|
-
/** @description Whether the agent maintains its own instructions. Included when `expansion=dynamicSelfInstructionsEnabled` is requested. */
|
|
1848
|
-
dynamicSelfInstructionsEnabled?: boolean;
|
|
1849
|
-
/** @description Whether long-term memory is enabled. Included when `expansion=memoryEnabled` is requested. */
|
|
1850
|
-
memoryEnabled?: boolean;
|
|
1851
|
-
/**
|
|
1852
|
-
* @description Memory partitioning scope. Included when `expansion=memoryScope` is requested.
|
|
1853
|
-
* @enum {string}
|
|
1854
|
-
*/
|
|
1855
|
-
memoryScope?: "PER_USER" | "PER_AGENT" | "PER_USER_PER_AGENT";
|
|
1856
|
-
/**
|
|
1857
|
-
* @description Days memories are retained. Included when `expansion=memoryRetentionDays` is requested.
|
|
1858
|
-
* @example 90
|
|
1859
|
-
*/
|
|
1860
|
-
memoryRetentionDays?: number;
|
|
1861
|
-
/** @description Suggested prompts shown to users starting a conversation. Included when `expansion=suggestedPrompts` is requested. */
|
|
1862
|
-
suggestedPrompts?: string[];
|
|
1863
|
-
/**
|
|
1864
|
-
* Format: date-time
|
|
1865
|
-
* @description When the first-time builder setup wizard was completed. Included when `expansion=builderSetupCompletedAt` is requested.
|
|
1866
|
-
*/
|
|
1867
|
-
builderSetupCompletedAt?: string | null;
|
|
1868
|
-
/** @description Saved canvas node positions for the agent builder. Included when `expansion=builderCanvasPositions` is requested. */
|
|
1869
|
-
builderCanvasPositions?: {
|
|
1870
|
-
[key: string]: unknown;
|
|
1871
|
-
} | null;
|
|
1872
|
-
/** @description Selected model ID within the AI provider connection. Included when `expansion=selectedModelId` is requested. */
|
|
1873
|
-
selectedModelId?: string | null;
|
|
1874
|
-
/** @description Assigned AI provider connection. Included when `expansion=aiConnection` is requested. */
|
|
1875
|
-
aiConnection?: {
|
|
1876
|
-
id?: string;
|
|
1877
|
-
name?: string;
|
|
1878
|
-
providerConfig?: {
|
|
1879
|
-
id?: string;
|
|
1880
|
-
providerSlug?: string;
|
|
1881
|
-
};
|
|
1882
|
-
} | null;
|
|
1883
|
-
/** @description Knowledge notebooks attached to the agent. Included when `expansion=knowledge` is requested. */
|
|
1884
|
-
agentKnowledge?: {
|
|
1885
|
-
id?: string;
|
|
1886
|
-
knowledge?: {
|
|
1887
|
-
id?: string;
|
|
1888
|
-
name?: string;
|
|
1889
|
-
};
|
|
1890
|
-
}[];
|
|
1891
|
-
/** @description Object types attached to the agent. Included when `expansion=objectTypes` is requested. */
|
|
1892
|
-
agentObjectTypes?: {
|
|
1893
|
-
id?: string;
|
|
1894
|
-
scope?: string;
|
|
1895
|
-
objectType?: {
|
|
1896
|
-
id?: string;
|
|
1897
|
-
name?: string;
|
|
1898
|
-
slug?: string;
|
|
1899
|
-
icon?: string | null;
|
|
1900
|
-
color?: string | null;
|
|
1901
|
-
};
|
|
1902
|
-
}[];
|
|
1903
|
-
/** @description Objects attached to the agent. Included when `expansion=objects` is requested. */
|
|
1904
|
-
agentObjects?: {
|
|
1905
|
-
id?: string;
|
|
1906
|
-
scope?: string;
|
|
1907
|
-
object?: {
|
|
1908
|
-
id?: string;
|
|
1909
|
-
name?: string;
|
|
1910
|
-
state?: string;
|
|
1911
|
-
objectType?: {
|
|
1912
|
-
id?: string;
|
|
1913
|
-
name?: string;
|
|
1914
|
-
slug?: string;
|
|
1915
|
-
icon?: string | null;
|
|
1916
|
-
color?: string | null;
|
|
1917
|
-
};
|
|
1918
|
-
};
|
|
1919
|
-
}[];
|
|
1920
|
-
/** @description App connections available to the agent. Included when `expansion=connections` is requested. */
|
|
1921
|
-
connections?: {
|
|
1922
|
-
id?: string;
|
|
1923
|
-
name?: string;
|
|
1924
|
-
}[];
|
|
1925
|
-
/** @description Variables attached to the agent. Included when `expansion=variables` is requested. */
|
|
1926
|
-
agentVariables?: {
|
|
1927
|
-
id?: string;
|
|
1928
|
-
variable?: {
|
|
1929
|
-
id?: string;
|
|
1930
|
-
name?: string;
|
|
1931
|
-
};
|
|
1932
|
-
}[];
|
|
1933
|
-
/** @description Workflows the agent can trigger. Included when `expansion=workflows` is requested. */
|
|
1934
|
-
agentWorkflows?: {
|
|
1935
|
-
id?: string;
|
|
1936
|
-
workflow?: {
|
|
1937
|
-
id?: string;
|
|
1938
|
-
name?: string;
|
|
1939
|
-
};
|
|
1940
|
-
}[];
|
|
1941
|
-
/** @description Sub-agent links for the agent. Included when `expansion=subAgents` is requested. */
|
|
1942
|
-
agentSubAgents?: {
|
|
1943
|
-
id?: string;
|
|
1944
|
-
subagent?: {
|
|
1945
|
-
id?: string;
|
|
1946
|
-
name?: string;
|
|
1947
|
-
};
|
|
1948
|
-
parentAgent?: {
|
|
1949
|
-
id?: string;
|
|
1950
|
-
name?: string;
|
|
1951
|
-
};
|
|
1952
|
-
}[];
|
|
1953
|
-
/** @description MCP servers attached to the agent, with per-tool overrides. Included when `expansion=mcpServers` is requested. */
|
|
1954
|
-
agentMcpServers?: {
|
|
1955
|
-
id?: string;
|
|
1956
|
-
mcpServer?: {
|
|
1957
|
-
id?: string;
|
|
1958
|
-
slug?: string;
|
|
1959
|
-
name?: string;
|
|
1960
|
-
provider?: string;
|
|
1961
|
-
logoUrl?: string | null;
|
|
1962
|
-
description?: string | null;
|
|
1963
|
-
};
|
|
1964
|
-
toolOverrides?: {
|
|
1965
|
-
id?: string;
|
|
1966
|
-
toolName?: string;
|
|
1967
|
-
enabled?: boolean;
|
|
1968
|
-
requireApproval?: boolean;
|
|
1969
|
-
}[];
|
|
1970
|
-
}[];
|
|
1971
|
-
/** @description A2A (agent-to-agent) endpoints attached to the agent. Included when `expansion=a2aAgents` is requested. */
|
|
1972
|
-
agentA2aAgents?: {
|
|
1973
|
-
id?: string;
|
|
1974
|
-
a2aAgent?: {
|
|
1975
|
-
id?: string;
|
|
1976
|
-
slug?: string;
|
|
1977
|
-
name?: string;
|
|
1978
|
-
logoUrl?: string | null;
|
|
1979
|
-
description?: string | null;
|
|
1980
|
-
authType?: string;
|
|
1981
|
-
};
|
|
1862
|
+
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
1863
|
+
*/
|
|
1864
|
+
updatedAt?: string | null;
|
|
1865
|
+
/** @description Sequential execution number within the workflow. Included when `expansion=executionNumber` is requested. */
|
|
1866
|
+
executionNumber?: number;
|
|
1867
|
+
/** @description Raw execution node state (JSON). Included when `expansion=nodes` is requested. Most integrations should prefer the `executionPath` expansion instead. */
|
|
1868
|
+
nodes?: {
|
|
1869
|
+
[key: string]: unknown;
|
|
1982
1870
|
}[];
|
|
1983
|
-
/** @description
|
|
1984
|
-
|
|
1985
|
-
|
|
1986
|
-
|
|
1987
|
-
|
|
1871
|
+
/** @description Raw execution edge state (JSON). Included when `expansion=edges` is requested. */
|
|
1872
|
+
edges?: {
|
|
1873
|
+
[key: string]: unknown;
|
|
1874
|
+
}[];
|
|
1875
|
+
/**
|
|
1876
|
+
* @description Overall execution status. Included when `expansion=status` is requested.
|
|
1877
|
+
* @enum {string}
|
|
1878
|
+
*/
|
|
1879
|
+
status?: "RUNNING" | "SUCCESS" | "FAILED" | "NEEDS_INPUT" | "SCHEDULED" | "CANCELLED" | "WAITING";
|
|
1880
|
+
/** @description Human-readable status detail. Included when `expansion=statusMessage` is requested. */
|
|
1881
|
+
statusMessage?: string | null;
|
|
1882
|
+
/** @description Final output of the execution (JSON). Included when `expansion=output` is requested. */
|
|
1883
|
+
output?: {
|
|
1884
|
+
[key: string]: unknown;
|
|
1988
1885
|
} | null;
|
|
1989
|
-
/**
|
|
1990
|
-
|
|
1991
|
-
|
|
1992
|
-
|
|
1993
|
-
|
|
1886
|
+
/**
|
|
1887
|
+
* Format: date-time
|
|
1888
|
+
* @description Timestamp when a waiting execution is scheduled to continue. Included when `expansion=continueExecutionAt` is requested.
|
|
1889
|
+
*/
|
|
1890
|
+
continueExecutionAt?: string | null;
|
|
1891
|
+
/**
|
|
1892
|
+
* @description Editor orientation of the workflow canvas at execution time. Included when `expansion=orientation` is requested.
|
|
1893
|
+
* @enum {string}
|
|
1894
|
+
*/
|
|
1895
|
+
workflowOrientation?: "HORIZONTAL" | "VERTICAL";
|
|
1896
|
+
/** @description Variables captured during the execution (JSON). Included when `expansion=executionVariables` is requested. */
|
|
1897
|
+
executionVariables?: {
|
|
1898
|
+
[key: string]: unknown;
|
|
1994
1899
|
} | null;
|
|
1995
|
-
/** @description
|
|
1996
|
-
|
|
1997
|
-
|
|
1998
|
-
|
|
1999
|
-
}
|
|
1900
|
+
/** @description The workflow the execution belongs to. Included when `expansion=workflow` is requested. */
|
|
1901
|
+
workflow?: components["schemas"]["ExecutionWorkflowSummaryDto"];
|
|
1902
|
+
/** @description Business-readable, ordered representation of the executed (or queued) steps, derived from the raw node and edge state: step labels, per-step status (including NEEDS_INPUT for steps paused awaiting user input), start and end timings, and loop iteration metadata. Custom UIs render execution progress from this field. Included when `expansion=executionPath` is requested. Only returned by GET /executions/{executionId}. */
|
|
1903
|
+
executionPath?: components["schemas"]["ExecutionPathStepDto"][];
|
|
1904
|
+
/** @description Field schemas for steps currently paused in NEEDS_INPUT. Each entry includes the waiting nodeId, label, optional instructions, and the fields to collect. Submit values keyed by field id to POST /api/webhooks/executions/{executionId}/nodes/{nodeId}/input. Included when `expansion=pendingInput` is requested. Only returned by GET /executions/{executionId}. Null when no step is waiting for input. */
|
|
1905
|
+
pendingInput?: components["schemas"]["PendingInputDto"][] | null;
|
|
1906
|
+
/**
|
|
1907
|
+
* @description How the execution was started. `WORKFLOW` for graph runs; `SDK` for ad-hoc single-action runs from the Public API / client SDK. Included when `expansion=source` is requested.
|
|
1908
|
+
* @enum {string}
|
|
1909
|
+
*/
|
|
1910
|
+
source?: "WORKFLOW" | "SDK";
|
|
1911
|
+
/** @description Optional display name (set for ad-hoc SDK runs). Included when `expansion=name` is requested. */
|
|
1912
|
+
name?: string | null;
|
|
2000
1913
|
};
|
|
2001
|
-
|
|
2002
|
-
/** @description Workflow app id (catalogue slug). */
|
|
1914
|
+
RunActionDto: {
|
|
1915
|
+
/** @description Workflow app id (catalogue slug), e.g. `http`, `gmail`. */
|
|
2003
1916
|
appId: string;
|
|
2004
|
-
/** @description
|
|
1917
|
+
/** @description Action id within the app, e.g. `http_action_send-request`. Discover via GET /workflow-apps (`actions[].id` / `inputConfig`). */
|
|
2005
1918
|
actionId: string;
|
|
2006
|
-
/** @description Connection instance UUID
|
|
1919
|
+
/** @description Connection instance UUID (`Connection.id`). Required when the action needs a connection and the workspace has more than one connection for the app with no single workspace default. When omitted: sole usable connection for the app is used; else the workspace default (`isDefault`); else 400 with candidates. Never silently picks among multiple non-default connections. */
|
|
2007
1920
|
connectionId?: string;
|
|
2008
|
-
/** @description
|
|
1921
|
+
/** @description Project UUID used for variable/project scoping. When omitted and the workspace has exactly one project, that project is used; otherwise the request fails with 400. */
|
|
1922
|
+
projectId?: string;
|
|
1923
|
+
/** @description Action input fields (mirrors the action `inputConfig` keys). Combined with `connectionId` into the action configValue. */
|
|
1924
|
+
input?: {
|
|
1925
|
+
[key: string]: unknown;
|
|
1926
|
+
};
|
|
1927
|
+
/** @description Optional display name for the ad-hoc Execution. */
|
|
2009
1928
|
name?: string;
|
|
2010
|
-
|
|
2011
|
-
|
|
2012
|
-
/** @description
|
|
1929
|
+
};
|
|
1930
|
+
RunActionResponseDto: {
|
|
1931
|
+
/** @description ID of the ad-hoc Execution. Use GET /executions/{executionId} (with expansion=executionPath) to re-read progress. */
|
|
1932
|
+
id: string;
|
|
1933
|
+
/**
|
|
1934
|
+
* @description Final execution status after the single action step.
|
|
1935
|
+
* @enum {string}
|
|
1936
|
+
*/
|
|
1937
|
+
status: "RUNNING" | "SUCCESS" | "FAILED" | "NEEDS_INPUT" | "SCHEDULED" | "CANCELLED" | "WAITING";
|
|
1938
|
+
/** @description Human-readable status detail. */
|
|
1939
|
+
statusMessage?: string | null;
|
|
1940
|
+
/** @description Action output on success (same shape as a workflow step output). Null on failure or when the run paused. */
|
|
1941
|
+
output?: {
|
|
1942
|
+
[key: string]: unknown;
|
|
1943
|
+
} | null;
|
|
1944
|
+
/** @description Single-step executionPath for the ad-hoc run (label, status, timings). */
|
|
1945
|
+
executionPath?: components["schemas"]["ExecutionPathStepDto"][];
|
|
1946
|
+
};
|
|
1947
|
+
RunStepDto: {
|
|
1948
|
+
/** @description Workflow app id (catalogue slug), e.g. `http`, `gmail`. */
|
|
1949
|
+
appId: string;
|
|
1950
|
+
/** @description Action id within the app, e.g. `http_action_send-request`. Discover via GET /workflow-apps. */
|
|
1951
|
+
actionId: string;
|
|
1952
|
+
/** @description Connection instance UUID. When omitted, the platform resolves: sole usable connection for the app, else the workspace default (`isDefault`), else 400 with candidates. */
|
|
1953
|
+
connectionId?: string;
|
|
1954
|
+
/** @description Action input fields (mirrors the action `inputConfig` keys). */
|
|
2013
1955
|
input?: {
|
|
2014
1956
|
[key: string]: unknown;
|
|
2015
1957
|
};
|
|
1958
|
+
/** @description Optional display name for this step. */
|
|
1959
|
+
name?: string;
|
|
2016
1960
|
};
|
|
2017
|
-
|
|
1961
|
+
StartRunDto: {
|
|
1962
|
+
/** @description Linear catalogue-action steps. Executed as one multi-step Execution with `source: SDK` (not a soft batch / correlation id). */
|
|
1963
|
+
steps: components["schemas"]["RunStepDto"][];
|
|
1964
|
+
/** @description Project UUID for variable/project scoping. When omitted and the workspace has exactly one project, that project is used. */
|
|
1965
|
+
projectId?: string;
|
|
1966
|
+
/** @description Optional display name for the ad-hoc Execution. */
|
|
1967
|
+
name?: string;
|
|
1968
|
+
};
|
|
1969
|
+
CreateVariableDto: {
|
|
1970
|
+
/** @description Name of the variable. */
|
|
1971
|
+
name: string;
|
|
1972
|
+
/** @description Description of the variable. */
|
|
1973
|
+
description?: string;
|
|
2018
1974
|
/**
|
|
2019
|
-
* @description
|
|
2020
|
-
* @
|
|
1975
|
+
* @description Scope of the variable (system, workspace or project).
|
|
1976
|
+
* @enum {string}
|
|
2021
1977
|
*/
|
|
2022
|
-
|
|
2023
|
-
/**
|
|
1978
|
+
type: "system" | "workspace" | "project";
|
|
1979
|
+
/**
|
|
1980
|
+
* @description Data type of the variable value.
|
|
1981
|
+
* @enum {string}
|
|
1982
|
+
*/
|
|
1983
|
+
dataType: "string" | "number" | "boolean" | "date" | "json";
|
|
1984
|
+
/** @description Project ID to scope the variable to. Must belong to the current workspace. */
|
|
1985
|
+
projectId?: string;
|
|
1986
|
+
/** @description Variable value, submitted as a string. Values with dataType `number` are converted to numbers on save. */
|
|
1987
|
+
value: string;
|
|
1988
|
+
};
|
|
1989
|
+
VariableWorkspaceDto: {
|
|
1990
|
+
/** @description Workspace ID. */
|
|
1991
|
+
id: string;
|
|
1992
|
+
/** @description Workspace name. */
|
|
1993
|
+
name: string;
|
|
1994
|
+
};
|
|
1995
|
+
VariableProjectDto: {
|
|
1996
|
+
/** @description Project ID. */
|
|
1997
|
+
id: string;
|
|
1998
|
+
/** @description Project name. */
|
|
1999
|
+
name: string;
|
|
2000
|
+
};
|
|
2001
|
+
VariableResponseDto: {
|
|
2002
|
+
/** @description Variable ID. */
|
|
2003
|
+
id: string;
|
|
2004
|
+
/** @description Variable name. */
|
|
2005
|
+
name: string;
|
|
2006
|
+
/**
|
|
2007
|
+
* @description Data type of the variable value.
|
|
2008
|
+
* @enum {string}
|
|
2009
|
+
*/
|
|
2010
|
+
dataType: "string" | "number" | "boolean" | "date" | "json";
|
|
2011
|
+
/**
|
|
2012
|
+
* @description Scope of the variable (system, workspace or project).
|
|
2013
|
+
* @enum {string}
|
|
2014
|
+
*/
|
|
2015
|
+
type: "system" | "workspace" | "project";
|
|
2016
|
+
/** @description Variable value. Included when `expansion=value` is requested. */
|
|
2017
|
+
value?: Record<string, never>;
|
|
2018
|
+
/** @description Variable description. Included when `expansion=description` is requested. */
|
|
2019
|
+
description?: string;
|
|
2020
|
+
/**
|
|
2021
|
+
* Format: date-time
|
|
2022
|
+
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
2023
|
+
*/
|
|
2024
|
+
createdAt?: string;
|
|
2025
|
+
/**
|
|
2026
|
+
* Format: date-time
|
|
2027
|
+
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
2028
|
+
*/
|
|
2029
|
+
updatedAt?: string;
|
|
2030
|
+
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
2031
|
+
workspace?: components["schemas"]["VariableWorkspaceDto"];
|
|
2032
|
+
/** @description Owning project for project-scoped variables. Included when `expansion=project` is requested. */
|
|
2033
|
+
project?: components["schemas"]["VariableProjectDto"];
|
|
2034
|
+
};
|
|
2035
|
+
UpdateVariableDto: {
|
|
2036
|
+
/** @description Name of the variable. */
|
|
2024
2037
|
name?: string;
|
|
2038
|
+
/** @description Description of the variable. */
|
|
2025
2039
|
description?: string;
|
|
2026
|
-
/**
|
|
2027
|
-
|
|
2028
|
-
|
|
2029
|
-
|
|
2030
|
-
|
|
2031
|
-
|
|
2032
|
-
|
|
2033
|
-
|
|
2034
|
-
|
|
2035
|
-
|
|
2036
|
-
/** @description
|
|
2037
|
-
|
|
2038
|
-
/** @description
|
|
2039
|
-
|
|
2040
|
+
/**
|
|
2041
|
+
* @description Scope of the variable (system, workspace or project).
|
|
2042
|
+
* @enum {string}
|
|
2043
|
+
*/
|
|
2044
|
+
type?: "system" | "workspace" | "project";
|
|
2045
|
+
/**
|
|
2046
|
+
* @description Data type of the variable value.
|
|
2047
|
+
* @enum {string}
|
|
2048
|
+
*/
|
|
2049
|
+
dataType?: "string" | "number" | "boolean" | "date" | "json";
|
|
2050
|
+
/** @description Project ID to scope the variable to. Must belong to the current workspace. */
|
|
2051
|
+
projectId?: string;
|
|
2052
|
+
/** @description Variable value, submitted as a string. Values with dataType `number` are converted to numbers on save. */
|
|
2053
|
+
value?: string;
|
|
2054
|
+
};
|
|
2055
|
+
ConnectionWorkspaceDto: {
|
|
2056
|
+
/** @description Workspace ID. */
|
|
2057
|
+
id: string;
|
|
2058
|
+
/** @description Workspace name. */
|
|
2059
|
+
name: string;
|
|
2060
|
+
};
|
|
2061
|
+
ConnectionResponseDto: {
|
|
2062
|
+
/** @description Connection ID. */
|
|
2063
|
+
id: string;
|
|
2064
|
+
/** @description Connection name. */
|
|
2065
|
+
name: string;
|
|
2066
|
+
/**
|
|
2067
|
+
* Format: date-time
|
|
2068
|
+
* @description Creation timestamp. Included when `expansion=createdAt` is requested.
|
|
2069
|
+
*/
|
|
2070
|
+
createdAt?: string;
|
|
2071
|
+
/**
|
|
2072
|
+
* Format: date-time
|
|
2073
|
+
* @description Last update timestamp. Included when `expansion=updatedAt` is requested.
|
|
2074
|
+
*/
|
|
2075
|
+
updatedAt?: string;
|
|
2076
|
+
/** @description App connection type ID (e.g. the OAuth2 or API key connection definition of the app). Included when `expansion=connectionId` is requested. */
|
|
2077
|
+
connectionId?: string;
|
|
2078
|
+
/** @description ID of the workflow app this connection belongs to. Included when `expansion=workflowAppId` or `expansion=workflowApp` is requested. */
|
|
2079
|
+
workflowAppId?: string;
|
|
2080
|
+
/** @description Full workflow app definition for this connection. Included when `expansion=workflowApp` is requested on the list endpoint. */
|
|
2081
|
+
workflowApp?: {
|
|
2082
|
+
[key: string]: unknown;
|
|
2083
|
+
};
|
|
2084
|
+
/** @description Owning workspace. Included when `expansion=workspace` is requested. */
|
|
2085
|
+
workspace?: components["schemas"]["ConnectionWorkspaceDto"];
|
|
2040
2086
|
};
|
|
2041
2087
|
TaskListItemResponseDto: {
|
|
2042
2088
|
/**
|
|
@@ -2319,6 +2365,7 @@ type UpdateQueueInput = Schemas['UpdateQueueDto'];
|
|
|
2319
2365
|
type QueueStats = Schemas['QueueStatsResponseDto'];
|
|
2320
2366
|
type QueueItem = Schemas['QueueItemResponseDto'];
|
|
2321
2367
|
type QueueItemFull = Schemas['QueueItemFullResponseDto'];
|
|
2368
|
+
type QueueItemCreated = Schemas['QueueItemCreateResponseDto'];
|
|
2322
2369
|
type CreateQueueItemInput = Schemas['CreateQueueItemDto'];
|
|
2323
2370
|
type UpdateQueueItemInput = Schemas['UpdateQueueItemDto'];
|
|
2324
2371
|
type QueueItemList = Schemas['QueueItemListResponseDto'];
|
|
@@ -3042,8 +3089,15 @@ interface ListQueueItemsOptions {
|
|
|
3042
3089
|
limit?: number;
|
|
3043
3090
|
offset?: number;
|
|
3044
3091
|
expansion?: string | string[];
|
|
3092
|
+
/** Supports keys including `status`, `externalId`, `objectId`, `priority`. */
|
|
3045
3093
|
filterBy?: string | Record<string, string>;
|
|
3046
3094
|
}
|
|
3095
|
+
interface ListQueueItemsByObjectOptions {
|
|
3096
|
+
status?: string;
|
|
3097
|
+
limit?: number;
|
|
3098
|
+
offset?: number;
|
|
3099
|
+
expansion?: string | string[];
|
|
3100
|
+
}
|
|
3047
3101
|
declare class QueueItemsResource {
|
|
3048
3102
|
private readonly http;
|
|
3049
3103
|
constructor(http: HttpClient);
|
|
@@ -3053,8 +3107,15 @@ declare class QueueItemsResource {
|
|
|
3053
3107
|
iterate(queueId: string, options?: Omit<ListQueueItemsOptions, 'offset'>): AsyncGenerator<QueueItem, void, undefined>;
|
|
3054
3108
|
/** Returns a single queue item. */
|
|
3055
3109
|
get(queueId: string, itemId: string): Promise<QueueItemFull>;
|
|
3056
|
-
/** Adds an item to a queue. */
|
|
3057
|
-
create(queueId: string, data: CreateQueueItemInput): Promise<
|
|
3110
|
+
/** Adds an item to a queue. Pass `objectId` to link the item to an entity. */
|
|
3111
|
+
create(queueId: string, data: CreateQueueItemInput): Promise<QueueItemCreated>;
|
|
3112
|
+
/**
|
|
3113
|
+
* Lists queue items linked to an Object across all queues in the workspace.
|
|
3114
|
+
* Use for Object detail "Work" panels.
|
|
3115
|
+
*/
|
|
3116
|
+
listByObject(objectId: string, options?: ListQueueItemsByObjectOptions): Promise<QueueItemList>;
|
|
3117
|
+
/** Async-iterates every queue item linked to an Object. */
|
|
3118
|
+
iterateByObject(objectId: string, options?: Omit<ListQueueItemsByObjectOptions, 'offset'>): AsyncGenerator<QueueItem, void, undefined>;
|
|
3058
3119
|
/** Adds many items to a queue in one call. */
|
|
3059
3120
|
bulkCreate(queueId: string, data: BulkCreateQueueItemsInput): Promise<BulkCreateQueueItemsResult>;
|
|
3060
3121
|
/** Updates a queue item. */
|