@airtop/sdk 1.0.0-alpha2.22 → 1.0.0-alpha2.24
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/index.cjs +77 -52
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +73 -66
- package/dist/index.d.ts +73 -66
- package/dist/index.js +77 -52
- package/dist/index.js.map +1 -1
- package/package.json +4 -4
package/dist/index.d.cts
CHANGED
@@ -4,17 +4,18 @@ import { AirtopJsonSchemaAdapter } from '@airtop/json-schema-adapter';
|
|
4
4
|
export { AirtopJsonSchemaAdapter } from '@airtop/json-schema-adapter';
|
5
5
|
import { ILogLayer } from 'loglayer';
|
6
6
|
export { ILogLayer } from 'loglayer';
|
7
|
-
import { Issue, SessionConfigV1, GetFileResponse, FilesResponse, ListAutomationsOutput, AutomationData, ServicePromptActionResponseEnvelope, ExternalSessionWithConnectionInfo, EnvelopeDefaultMeta, ExtractActionResponseEnvelope, ActActionResponseEnvelope, LlmActionResponseEnvelope, NodeHandle, WaitForPageActionResponseEnvelope, NavigateActionResponseEnvelope, FindOneActionResponseEnvelope, FindManyActionResponseEnvelope, AIPromptResponse as AIPromptResponse$1, WindowIDDataResponse, OperationOutcomeResponse } from '@airtop/core/resources/shared.js';
|
8
|
-
export { AIResponseEnvelope, ActActionResponseData, AgentInvocationData, AgentVersionData, AirtopPagination, AsyncConfig, AsyncSessionAIResponseEnvelope, BrowserWaitNavigationConfig, ClickConfig, ClientProvidedResponseMetadata, CreateFileData, EnvelopeDefaultMeta, ExternalSessionAIResponseMetadata, ExternalSessionAIResponseMetadataUsage, ExternalSessionConfig, ExternalSessionWithConnectionInfo, ExtractActionResponseData, FindManyActionResponseData, FindOneActionResponseData, GetFileData, IntervalMonitorConfig, Issue, LlmActionResponseData, MicroInteractionConfig, MonitorConfig, NavigateActionResponseData, OperationOutcome, OperationOutcomeResponse, PageQueryConfig, PageQueryExperimentalConfig, PaginatedExtractionConfig, ScrapeResponseContent, ScrapeResponseEnvelope, ScrapeResponseOutput, ScreenshotConfig, ScreenshotMetadata, ScreenshotRequestConfig, ScreenshotScrollPosition, ScreenshotViewportDimensions, ScrollByConfig, ScrollToEdgeConfig, ServicePromptActionResponseData, SummaryExperimentalConfig, VisualAnalysisConfig, WaitForPageActionResponseData, WindowIDData, WindowIDDataResponse, WindowInfo, WindowResponse } from '@airtop/core/resources/shared.js';
|
7
|
+
import { Issue, SessionConfigV1, GetFileResponse, FilesResponse, ListAutomationsOutput, AutomationData, ServicePromptActionResponseEnvelope, ExternalSessionWithConnectionInfo, EnvelopeDefaultMeta, ExtractActionResponseEnvelope, ActActionResponseEnvelope, LlmActionResponseEnvelope, NodeHandle, WaitForPageActionResponseEnvelope, NavigateActionResponseEnvelope, FindOneActionResponseEnvelope, FindManyActionResponseEnvelope, AIPromptResponse as AIPromptResponse$1, WindowIDDataResponse, OperationOutcomeResponse, WindowsResponse } from '@airtop/core/resources/shared.js';
|
8
|
+
export { AIResponseEnvelope, ActActionResponseData, AgentInvocationData, AgentVersionData, AirtopPagination, AsyncConfig, AsyncSessionAIResponseEnvelope, BrowserWaitNavigationConfig, ClickConfig, ClientProvidedResponseMetadata, CreateFileData, EnvelopeDefaultMeta, ExternalSessionAIResponseMetadata, ExternalSessionAIResponseMetadataUsage, ExternalSessionConfig, ExternalSessionWithConnectionInfo, ExtractActionResponseData, FindManyActionResponseData, FindOneActionResponseData, GetFileData, IntervalMonitorConfig, Issue, LlmActionResponseData, MicroInteractionConfig, MonitorConfig, NavigateActionResponseData, OperationOutcome, OperationOutcomeResponse, PageQueryConfig, PageQueryExperimentalConfig, PaginatedExtractionConfig, ScrapeResponseContent, ScrapeResponseEnvelope, ScrapeResponseOutput, ScreenshotConfig, ScreenshotMetadata, ScreenshotRequestConfig, ScreenshotScrollPosition, ScreenshotViewportDimensions, ScrollByConfig, ScrollToEdgeConfig, ServicePromptActionResponseData, SummaryExperimentalConfig, VisualAnalysisConfig, WaitForPageActionResponseData, WindowIDData, WindowIDDataResponse, WindowInfo, WindowResponse, WindowsResponse, WindowsWithMeta } from '@airtop/core/resources/shared.js';
|
9
9
|
import * as _airtop_core_resources_shared_mjs from '@airtop/core/resources/shared.mjs';
|
10
10
|
import { AutomationUpdateDescriptionParams } from '@airtop/core/resources/automations.js';
|
11
11
|
import { SessionListParams, ProfileOutput, FileListParams, FileCreateFileParams, WindowCreateParams, WindowIDData, EnvelopeDefaultMeta as EnvelopeDefaultMeta$1, Issue as Issue$1, WindowInfo, WindowGetParams, AIPromptResponse, ScrapeResponse } from '@airtop/core/resources/index.js';
|
12
12
|
export { AIPromptResponse, ScrapeResponse } from '@airtop/core/resources/index.js';
|
13
13
|
import * as _airtop_core_resources_sessions_mjs from '@airtop/core/resources/sessions.mjs';
|
14
|
-
import { WindowClickParams, WindowHoverParams, WindowLoadURLParams, WindowMonitorParams, WindowScrapeParams, WindowScreenshotParams, WindowScrollParams, WindowTypeParams, WindowExtractParams, WindowActParams, WindowLlmParams, WindowFindOneParams, WindowFindManyParams, WindowWaitForPageParams, WindowNavigateParams, WindowFillFormParams } from '@airtop/core/resources/windows.js';
|
15
|
-
export { WindowActParams, WindowClickParams, WindowExtractParams, WindowFillFormParams, WindowFindManyParams, WindowFindOneParams, WindowGetParams, WindowHoverParams, WindowLlmParams, WindowLoadURLParams, WindowMonitorParams, WindowNavigateParams, WindowPageQueryParams, WindowPaginatedExtractionParams, WindowScrapeParams, WindowScreenshotParams, WindowScrollParams, WindowTypeParams, WindowWaitForPageParams } from '@airtop/core/resources/windows.js';
|
16
14
|
import * as _airtop_core_resources_js from '@airtop/core/resources.js';
|
17
15
|
import { ConnectedServicesActionResponseEnvelope } from '@airtop/core/resources.js';
|
16
|
+
import { WindowClickParams, WindowHoverParams, WindowLoadURLParams, WindowMonitorParams, WindowPageQueryParams, WindowPaginatedExtractionParams, WindowScrapeParams, WindowScreenshotParams, WindowScrollParams, WindowTypeParams, WindowExtractParams, WindowActParams, WindowLlmParams, WindowFindOneParams, WindowFindManyParams, WindowWaitForPageParams, WindowNavigateParams, WindowFillFormParams } from '@airtop/core/resources/windows.js';
|
17
|
+
export { WindowActParams, WindowClickParams, WindowExtractParams, WindowFillFormParams, WindowFindManyParams, WindowFindOneParams, WindowGetParams, WindowHoverParams, WindowLlmParams, WindowLoadURLParams, WindowMonitorParams, WindowNavigateParams, WindowPageQueryParams, WindowPaginatedExtractionParams, WindowScrapeParams, WindowScreenshotParams, WindowScrollParams, WindowTypeParams, WindowWaitForPageParams } from '@airtop/core/resources/windows.js';
|
18
|
+
import { DeepOmit } from 'deep-utility-types';
|
18
19
|
export { DeepOmit } from 'deep-utility-types';
|
19
20
|
|
20
21
|
/**
|
@@ -58,7 +59,7 @@ interface CommonAirtopConfig {
|
|
58
59
|
* Configuration for defining the JSON schema output.
|
59
60
|
*/
|
60
61
|
interface OutputJsonSchemaConfig {
|
61
|
-
configuration
|
62
|
+
configuration?: {
|
62
63
|
/**
|
63
64
|
* JSON schema defining the structure of the output.
|
64
65
|
*/
|
@@ -214,7 +215,7 @@ interface AirtopConstructorConfig {
|
|
214
215
|
apiKey: string;
|
215
216
|
/**
|
216
217
|
* The base URL for the Airtop API.
|
217
|
-
* Defaults to https://api.airtop.ai/api
|
218
|
+
* Defaults to https://api.airtop.ai/api if not specified.
|
218
219
|
*/
|
219
220
|
airtopUrl?: string;
|
220
221
|
/**
|
@@ -458,16 +459,18 @@ interface WindowLoadUrlConfig extends Omit<WindowLoadURLParams, "sessionId" | "u
|
|
458
459
|
*/
|
459
460
|
interface WindowMonitorConfig extends Omit<WindowMonitorParams, "sessionId" | "condition"> {
|
460
461
|
}
|
462
|
+
interface WindowPageQueryParamsBase extends DeepOmit<WindowPageQueryParams, "sessionId" | "prompt" | "configuration.outputSchema"> {
|
463
|
+
}
|
461
464
|
/**
|
462
465
|
* Configuration parameters for performing a natural language query on page content.
|
463
466
|
*/
|
464
|
-
|
467
|
+
type WindowPageQueryConfig = WindowPageQueryParamsBase & OutputJsonSchemaConfig;
|
468
|
+
interface WindowPaginatedExtractionParamsBase extends DeepOmit<WindowPaginatedExtractionParams, "sessionId" | "prompt" | "configuration.outputSchema"> {
|
465
469
|
}
|
466
470
|
/**
|
467
471
|
* Configuration parameters for extracting paginated data from a window.
|
468
472
|
*/
|
469
|
-
|
470
|
-
}
|
473
|
+
type WindowPaginatedExtractionConfig = WindowPaginatedExtractionParamsBase & OutputJsonSchemaConfig;
|
471
474
|
/**
|
472
475
|
* Configuration parameters for scraping content from a window.
|
473
476
|
* Excludes session ID which is provided by the parent session.
|
@@ -893,7 +896,7 @@ declare class AirtopSessionClient extends AirtopBase {
|
|
893
896
|
* Returns the browser session ID.
|
894
897
|
*/
|
895
898
|
getSessionId(): string;
|
896
|
-
listWindows(requestOptions?: AirtopRequestOptions): Promise<
|
899
|
+
listWindows(requestOptions?: AirtopRequestOptions): Promise<WindowsResponse>;
|
897
900
|
/**
|
898
901
|
* Gets the state of the session using the attached session id.
|
899
902
|
* @param requestOptions - Request options
|
@@ -1121,23 +1124,25 @@ declare class AirtopMocks {
|
|
1121
1124
|
|
1122
1125
|
interface AirtopAgentCreateAgentParams extends Airtop.AgentCreateAgentParams {
|
1123
1126
|
}
|
1127
|
+
interface AirtopAgentGetAgentParams extends Airtop.AgentGetAgentParams {
|
1128
|
+
}
|
1124
1129
|
interface AirtopAgentGetAgentsParams extends Airtop.AgentGetAgentsParams {
|
1125
1130
|
}
|
1126
1131
|
interface AirtopAgentUpdateAgentParams extends Airtop.AgentUpdateAgentParams {
|
1127
1132
|
}
|
1128
1133
|
interface AirtopAgentDeleteAgentsParams extends Airtop.AgentDeleteAgentsParams {
|
1129
1134
|
}
|
1130
|
-
interface
|
1135
|
+
interface AirtopAgentCreateInvocationParams extends Airtop.AgentCreateInvocationParams {
|
1131
1136
|
}
|
1132
|
-
interface
|
1137
|
+
interface AirtopAgentGetInvocationsParams extends Airtop.AgentGetInvocationsParams {
|
1133
1138
|
}
|
1134
|
-
interface
|
1139
|
+
interface AirtopAgentCancelInvocationParams extends Omit<Airtop.AgentCancelInvocationParams, "id"> {
|
1135
1140
|
}
|
1136
|
-
interface
|
1141
|
+
interface AirtopAgentGetVersionDataParams extends Airtop.AgentGetCurrentAgentVersionParams {
|
1137
1142
|
}
|
1138
|
-
interface
|
1143
|
+
interface AirtopAgentUpdateVersionDataParams extends Omit<Airtop.AgentUpdateAgentVersionDataParams, "id"> {
|
1139
1144
|
}
|
1140
|
-
interface
|
1145
|
+
interface AirtopAgentPublishAgentParams extends Airtop.AgentPublishAgentParams {
|
1141
1146
|
}
|
1142
1147
|
interface AirtopCreateAgentResponse extends Airtop.CreateAgentResponse {
|
1143
1148
|
}
|
@@ -1149,18 +1154,20 @@ interface AirtopUpdateAgentResponse extends Airtop.UpdateAgentResponse {
|
|
1149
1154
|
}
|
1150
1155
|
interface AirtopDeleteAgentsResponse extends Airtop.DeleteResponse {
|
1151
1156
|
}
|
1152
|
-
interface AirtopDuplicateAgentResponse extends Airtop.DuplicateAgentResponse {
|
1153
|
-
}
|
1154
|
-
interface AirtopCreateAgentVersionResponse extends Airtop.CreateAgentVersionResponse {
|
1155
|
-
}
|
1156
|
-
interface AirtopGetAgentVersionsResponse extends Airtop.GetAgentVersionsResponse {
|
1157
|
-
}
|
1158
1157
|
interface AirtopCreateAgentInvocationResponse extends Airtop.CreateAgentInvocationResponse {
|
1159
1158
|
}
|
1160
1159
|
interface AirtopGetAgentInvocationsResponse extends Airtop.GetAgentInvocationsResponse {
|
1161
1160
|
}
|
1162
1161
|
interface AirtopAgentResponse extends Airtop.GetAgentResponse {
|
1163
1162
|
}
|
1163
|
+
interface AirtopCreateNewAgentDraftResponse extends Airtop.AgentCreateDraftResponse {
|
1164
|
+
}
|
1165
|
+
interface AirtopPublishNewAgentResponse extends Airtop.AgentPublishDraftResponse {
|
1166
|
+
}
|
1167
|
+
interface AirtopGetAgentVersionDataResponse extends Airtop.AgentGetVersionDataResponse {
|
1168
|
+
}
|
1169
|
+
interface AirtopUpdateVersionDataResponse extends Airtop.AgentUpdateVersionDataResponse {
|
1170
|
+
}
|
1164
1171
|
|
1165
1172
|
/**
|
1166
1173
|
* Client for making Agent-specific requests to the Airtop API.
|
@@ -1172,85 +1179,85 @@ declare class AirtopAgentClient extends AirtopBase {
|
|
1172
1179
|
*/
|
1173
1180
|
constructor(config: AirtopConstructorConfig);
|
1174
1181
|
/**
|
1175
|
-
* Creates a new agent.
|
1176
|
-
* @param params - Parameters for creating the agent.
|
1182
|
+
* Creates a new agent. A new draft version is created by default.
|
1183
|
+
* @param params - Parameters for creating the agent.
|
1177
1184
|
* @param requestOptions - Request options.
|
1178
|
-
* @returns The created agent data
|
1185
|
+
* @returns The created agent data.
|
1179
1186
|
*/
|
1180
1187
|
createAgent(params: AirtopAgentCreateAgentParams, requestOptions?: AirtopRequestOptions): Promise<AirtopCreateAgentResponse>;
|
1181
1188
|
/**
|
1182
1189
|
* Retrieves a specific agent by its ID.
|
1183
1190
|
* @param agentId - The ID of the agent to retrieve.
|
1184
1191
|
* @param requestOptions - Request options.
|
1185
|
-
* @returns The agent data
|
1192
|
+
* @returns The agent data.
|
1186
1193
|
*/
|
1187
|
-
getAgent(agentId: string,
|
1188
|
-
requestOptions?: AirtopRequestOptions): Promise<AirtopGetAgentResponse>;
|
1194
|
+
getAgent(agentId: string, params?: AirtopAgentGetAgentParams, requestOptions?: AirtopRequestOptions): Promise<AirtopGetAgentResponse>;
|
1189
1195
|
/**
|
1190
1196
|
* Lists agents.
|
1191
|
-
* @param params - Optional parameters for listing agents (e.g., pagination).
|
1197
|
+
* @param params - Optional parameters for listing agents (e.g., pagination).
|
1192
1198
|
* @param requestOptions - Request options.
|
1193
|
-
* @returns A list of agents
|
1199
|
+
* @returns A list of agents.
|
1194
1200
|
*/
|
1195
1201
|
listAgents(params?: AirtopAgentGetAgentsParams, requestOptions?: AirtopRequestOptions): Promise<AirtopGetAgentsResponse>;
|
1196
1202
|
/**
|
1197
|
-
*
|
1198
|
-
* @param agentId - The ID of the agent to
|
1199
|
-
* @param params - The new data for the agent. Corresponds to `AirtopAgentUpdateAgentParams`.
|
1203
|
+
* Creates a new draft version of an agent. If one already exists, does nothing.
|
1204
|
+
* @param agentId - The ID of the agent for which to create a new draft version.
|
1200
1205
|
* @param requestOptions - Request options.
|
1201
|
-
* @returns The
|
1206
|
+
* @returns The draft version data.
|
1202
1207
|
*/
|
1203
|
-
|
1204
|
-
params: AirtopAgentUpdateAgentParams, requestOptions?: AirtopRequestOptions): Promise<AirtopUpdateAgentResponse>;
|
1208
|
+
createNewAgentDraftVersion(agentId: string, requestOptions?: AirtopRequestOptions): Promise<AirtopCreateNewAgentDraftResponse>;
|
1205
1209
|
/**
|
1206
|
-
*
|
1207
|
-
* @param
|
1210
|
+
* Publishes a new version of an agent from the current draft.
|
1211
|
+
* @param agentId - The ID of the agent to publish.
|
1212
|
+
* @returns The published version data
|
1213
|
+
*/
|
1214
|
+
publishNewAgentVersion(agentId: string, params?: AirtopAgentPublishAgentParams, requestOptions?: AirtopRequestOptions): Promise<AirtopPublishNewAgentResponse>;
|
1215
|
+
/**
|
1216
|
+
* Retrieves the data for a specific version of an agent.
|
1217
|
+
* @param agentId - The ID of the agent.
|
1218
|
+
* @param version - The version number of the agent to retrieve.
|
1208
1219
|
* @param requestOptions - Request options.
|
1209
|
-
* @returns
|
1220
|
+
* @returns The agent version data.
|
1210
1221
|
*/
|
1211
|
-
|
1222
|
+
getAgentVersionData(agentId: string, version: number, requestOptions?: AirtopRequestOptions): Promise<AirtopGetAgentVersionDataResponse>;
|
1223
|
+
updateAgentVersionData(agentId: string, version: number, params: AirtopAgentUpdateVersionDataParams, requestOptions?: AirtopRequestOptions): Promise<AirtopUpdateVersionDataResponse>;
|
1212
1224
|
/**
|
1213
|
-
*
|
1214
|
-
* @param agentId - The ID of the agent
|
1215
|
-
* @param params -
|
1225
|
+
* Retrieves the current version data of an agent. This is the version that is currently active or in draft state.
|
1226
|
+
* @param agentId - The ID of the agent.
|
1227
|
+
* @param params - Optional parameters for retrieving the version data.
|
1216
1228
|
* @param requestOptions - Request options.
|
1217
|
-
* @returns The
|
1229
|
+
* @returns The current agent version data
|
1218
1230
|
*/
|
1219
|
-
|
1220
|
-
params: AirtopAgentDuplicateAgentParams, requestOptions?: AirtopRequestOptions): Promise<AirtopDuplicateAgentResponse>;
|
1231
|
+
getCurrentAgentVersionData(agentId: string, params?: AirtopAgentGetVersionDataParams, requestOptions?: AirtopRequestOptions): Promise<_airtop_core_resources_shared_mjs.AgentGetCurrentVersionDataResponse>;
|
1221
1232
|
/**
|
1222
|
-
*
|
1223
|
-
* @param agentId - The ID of the agent
|
1224
|
-
* @param params -
|
1233
|
+
* Updates an existing agent.
|
1234
|
+
* @param agentId - The ID of the agent to update.
|
1235
|
+
* @param params - The new data for the agent.
|
1225
1236
|
* @param requestOptions - Request options.
|
1226
|
-
* @returns The
|
1237
|
+
* @returns The updated agent data.
|
1227
1238
|
*/
|
1228
|
-
|
1229
|
-
params: AirtopAgentCreateVersionParams, requestOptions?: AirtopRequestOptions): Promise<AirtopCreateAgentVersionResponse>;
|
1239
|
+
updateAgent(agentId: string, params: AirtopAgentUpdateAgentParams, requestOptions?: AirtopRequestOptions): Promise<AirtopUpdateAgentResponse>;
|
1230
1240
|
/**
|
1231
|
-
*
|
1232
|
-
* @param
|
1233
|
-
* @param params - Optional parameters for listing agent versions. Corresponds to `AirtopAgentGetVersionsParams`.
|
1241
|
+
* Deletes one or more agents.
|
1242
|
+
* @param params - Parameters for deleting agents.
|
1234
1243
|
* @param requestOptions - Request options.
|
1235
|
-
* @returns A
|
1244
|
+
* @returns A response confirming the deletion.
|
1236
1245
|
*/
|
1237
|
-
|
1238
|
-
params?: AirtopAgentGetVersionsParams, requestOptions?: AirtopRequestOptions): Promise<AirtopGetAgentVersionsResponse>;
|
1246
|
+
deleteAgents(params: AirtopAgentDeleteAgentsParams, requestOptions?: AirtopRequestOptions): Promise<AirtopDeleteAgentsResponse>;
|
1239
1247
|
/**
|
1240
1248
|
* Creates an invocation for an agent.
|
1241
1249
|
* @param agentId - The ID of the agent for which to create an invocation.
|
1242
|
-
* @param params - Parameters for creating the agent invocation.
|
1250
|
+
* @param params - Parameters for creating the agent invocation.
|
1243
1251
|
* @param requestOptions - Request options.
|
1244
|
-
* @returns The created agent invocation data
|
1252
|
+
* @returns The created agent invocation data.
|
1245
1253
|
*/
|
1246
|
-
createAgentInvocation(agentId: string,
|
1247
|
-
params: AirtopAgentCreateInvocationParams, requestOptions?: AirtopRequestOptions): Promise<AirtopCreateAgentInvocationResponse>;
|
1254
|
+
createAgentInvocation(agentId: string, params: AirtopAgentCreateInvocationParams, requestOptions?: AirtopRequestOptions): Promise<AirtopCreateAgentInvocationResponse>;
|
1248
1255
|
/**
|
1249
1256
|
* Lists invocations of an agent.
|
1250
1257
|
* @param agentIds - The ID of the agent whose invocations to list.
|
1251
|
-
* @param params - Optional parameters for listing agent invocations.
|
1258
|
+
* @param params - Optional parameters for listing agent invocations.
|
1252
1259
|
* @param requestOptions - Request options.
|
1253
|
-
* @returns A list of agent invocations
|
1260
|
+
* @returns A list of agent invocations.
|
1254
1261
|
*/
|
1255
1262
|
listAgentInvocations(agentIds: string, // Renamed
|
1256
1263
|
params?: AirtopAgentGetInvocationsParams, requestOptions?: AirtopRequestOptions): Promise<AirtopGetAgentInvocationsResponse>;
|
@@ -1258,7 +1265,7 @@ declare class AirtopAgentClient extends AirtopBase {
|
|
1258
1265
|
* Cancels a specific invocation of an agent.
|
1259
1266
|
* @param agentId - The ID of the agent.
|
1260
1267
|
* @param invocationId - The ID of the invocation to cancel.
|
1261
|
-
* @param paramsBody - Optional body parameters for cancelling the invocation.
|
1268
|
+
* @param paramsBody - Optional body parameters for cancelling the invocation.
|
1262
1269
|
* @param requestOptions - Request options.
|
1263
1270
|
* @returns A promise that resolves when the operation is complete.
|
1264
1271
|
*/
|
@@ -1433,4 +1440,4 @@ interface AirtopPluginRegistration {
|
|
1433
1440
|
*/
|
1434
1441
|
declare function registerAirtopPlugin(plugin: AirtopPluginRegistration): void;
|
1435
1442
|
|
1436
|
-
export { type AirtopAgentCancelInvocationParams, AirtopAgentClient, type AirtopAgentCreateAgentParams, type AirtopAgentCreateInvocationParams, type
|
1443
|
+
export { type AirtopAgentCancelInvocationParams, AirtopAgentClient, type AirtopAgentCreateAgentParams, type AirtopAgentCreateInvocationParams, type AirtopAgentDeleteAgentsParams, type AirtopAgentGetAgentParams, type AirtopAgentGetAgentsParams, type AirtopAgentGetInvocationsParams, type AirtopAgentGetVersionDataParams, type AirtopAgentPublishAgentParams, type AirtopAgentResponse, type AirtopAgentUpdateAgentParams, type AirtopAgentUpdateVersionDataParams, type AirtopAutomationData, type AirtopAutomationListResponse, type AirtopAutomationUpdateDescriptionConfig, AirtopBase, AirtopClient, type AirtopClientPlugin, type AirtopConstructorConfig, type AirtopCreateAgentInvocationResponse, type AirtopCreateAgentResponse, type AirtopCreateNewAgentDraftResponse, type AirtopDeleteAgentsResponse, AirtopError, type AirtopFileListParams, type AirtopFileResponse, type AirtopFilesResponse, type AirtopGetAgentInvocationsResponse, type AirtopGetAgentResponse, type AirtopGetAgentVersionDataResponse, type AirtopGetAgentsResponse, AirtopMocks, AirtopNode, type AirtopNodeApiResponseData, AirtopPluginAugmentationType, type AirtopPluginRegistration, type AirtopPluginType, type AirtopProfile, type AirtopPublishNewAgentResponse, type AirtopRequestOptions, AirtopSession, AirtopSessionClient, type AirtopSessionClientPlugin, type AirtopSessionPlugin, type AirtopSessionResponse, type AirtopUpdateAgentResponse, type AirtopUpdateVersionDataResponse, AirtopWindow, AirtopWindowClient, type AirtopWindowClientPlugin, type AirtopWindowCreateResponse, type AirtopWindowGetInfoResponse, type AirtopWindowPlugin, AirtopWindowScreenshot, type AirtopWindowScreenshotPlugin, type AirtopWindowScreenshotResponse, type CommonAirtopConfig, type CommonResponse, type CommonWindowResponse, type CreateFileConfig, type CreateSessionConfig, type GetFilesConfig, type GetSessionsConfig, type OutputJsonSchemaConfig, type ScreenshotData, type SessionData, type SessionError, type SessionMetadata, type SessionServiceResponse, type SessionWarning, type WindowActConfig, type WindowActResponse, type WindowClickConfig, type WindowCreateData, type WindowCreateOptions, type WindowError, type WindowExtractConfig, type WindowExtractResponse, type WindowFillFormConfig, type WindowFindManyConfig, type WindowFindManyResponse, type WindowFindOneConfig, type WindowFindOneResponse, type WindowGetConfig, type WindowHoverConfig, type WindowInfoData, type WindowLlmConfig, type WindowLlmResponse, type WindowLoadUrlConfig, type WindowMetadata, type WindowMonitorConfig, type WindowNavigateConfig, WindowNavigateDirection, type WindowNavigateResponse, type WindowPageQueryConfig, type WindowPaginatedExtractionConfig, type WindowPromptResponse, type WindowScrapeConfig, type WindowScrapeResponse, type WindowScreenshotConfig, type WindowScrollConfig, type WindowTypeConfig, type WindowWaitForPageConfig, type WindowWaitForPageResponse, type WindowWarning, registerAirtopPlugin };
|
package/dist/index.d.ts
CHANGED
@@ -4,17 +4,18 @@ import { AirtopJsonSchemaAdapter } from '@airtop/json-schema-adapter';
|
|
4
4
|
export { AirtopJsonSchemaAdapter } from '@airtop/json-schema-adapter';
|
5
5
|
import { ILogLayer } from 'loglayer';
|
6
6
|
export { ILogLayer } from 'loglayer';
|
7
|
-
import { Issue, SessionConfigV1, GetFileResponse, FilesResponse, ListAutomationsOutput, AutomationData, ServicePromptActionResponseEnvelope, ExternalSessionWithConnectionInfo, EnvelopeDefaultMeta, ExtractActionResponseEnvelope, ActActionResponseEnvelope, LlmActionResponseEnvelope, NodeHandle, WaitForPageActionResponseEnvelope, NavigateActionResponseEnvelope, FindOneActionResponseEnvelope, FindManyActionResponseEnvelope, AIPromptResponse as AIPromptResponse$1, WindowIDDataResponse, OperationOutcomeResponse } from '@airtop/core/resources/shared.js';
|
8
|
-
export { AIResponseEnvelope, ActActionResponseData, AgentInvocationData, AgentVersionData, AirtopPagination, AsyncConfig, AsyncSessionAIResponseEnvelope, BrowserWaitNavigationConfig, ClickConfig, ClientProvidedResponseMetadata, CreateFileData, EnvelopeDefaultMeta, ExternalSessionAIResponseMetadata, ExternalSessionAIResponseMetadataUsage, ExternalSessionConfig, ExternalSessionWithConnectionInfo, ExtractActionResponseData, FindManyActionResponseData, FindOneActionResponseData, GetFileData, IntervalMonitorConfig, Issue, LlmActionResponseData, MicroInteractionConfig, MonitorConfig, NavigateActionResponseData, OperationOutcome, OperationOutcomeResponse, PageQueryConfig, PageQueryExperimentalConfig, PaginatedExtractionConfig, ScrapeResponseContent, ScrapeResponseEnvelope, ScrapeResponseOutput, ScreenshotConfig, ScreenshotMetadata, ScreenshotRequestConfig, ScreenshotScrollPosition, ScreenshotViewportDimensions, ScrollByConfig, ScrollToEdgeConfig, ServicePromptActionResponseData, SummaryExperimentalConfig, VisualAnalysisConfig, WaitForPageActionResponseData, WindowIDData, WindowIDDataResponse, WindowInfo, WindowResponse } from '@airtop/core/resources/shared.js';
|
7
|
+
import { Issue, SessionConfigV1, GetFileResponse, FilesResponse, ListAutomationsOutput, AutomationData, ServicePromptActionResponseEnvelope, ExternalSessionWithConnectionInfo, EnvelopeDefaultMeta, ExtractActionResponseEnvelope, ActActionResponseEnvelope, LlmActionResponseEnvelope, NodeHandle, WaitForPageActionResponseEnvelope, NavigateActionResponseEnvelope, FindOneActionResponseEnvelope, FindManyActionResponseEnvelope, AIPromptResponse as AIPromptResponse$1, WindowIDDataResponse, OperationOutcomeResponse, WindowsResponse } from '@airtop/core/resources/shared.js';
|
8
|
+
export { AIResponseEnvelope, ActActionResponseData, AgentInvocationData, AgentVersionData, AirtopPagination, AsyncConfig, AsyncSessionAIResponseEnvelope, BrowserWaitNavigationConfig, ClickConfig, ClientProvidedResponseMetadata, CreateFileData, EnvelopeDefaultMeta, ExternalSessionAIResponseMetadata, ExternalSessionAIResponseMetadataUsage, ExternalSessionConfig, ExternalSessionWithConnectionInfo, ExtractActionResponseData, FindManyActionResponseData, FindOneActionResponseData, GetFileData, IntervalMonitorConfig, Issue, LlmActionResponseData, MicroInteractionConfig, MonitorConfig, NavigateActionResponseData, OperationOutcome, OperationOutcomeResponse, PageQueryConfig, PageQueryExperimentalConfig, PaginatedExtractionConfig, ScrapeResponseContent, ScrapeResponseEnvelope, ScrapeResponseOutput, ScreenshotConfig, ScreenshotMetadata, ScreenshotRequestConfig, ScreenshotScrollPosition, ScreenshotViewportDimensions, ScrollByConfig, ScrollToEdgeConfig, ServicePromptActionResponseData, SummaryExperimentalConfig, VisualAnalysisConfig, WaitForPageActionResponseData, WindowIDData, WindowIDDataResponse, WindowInfo, WindowResponse, WindowsResponse, WindowsWithMeta } from '@airtop/core/resources/shared.js';
|
9
9
|
import * as _airtop_core_resources_shared_mjs from '@airtop/core/resources/shared.mjs';
|
10
10
|
import { AutomationUpdateDescriptionParams } from '@airtop/core/resources/automations.js';
|
11
11
|
import { SessionListParams, ProfileOutput, FileListParams, FileCreateFileParams, WindowCreateParams, WindowIDData, EnvelopeDefaultMeta as EnvelopeDefaultMeta$1, Issue as Issue$1, WindowInfo, WindowGetParams, AIPromptResponse, ScrapeResponse } from '@airtop/core/resources/index.js';
|
12
12
|
export { AIPromptResponse, ScrapeResponse } from '@airtop/core/resources/index.js';
|
13
13
|
import * as _airtop_core_resources_sessions_mjs from '@airtop/core/resources/sessions.mjs';
|
14
|
-
import { WindowClickParams, WindowHoverParams, WindowLoadURLParams, WindowMonitorParams, WindowScrapeParams, WindowScreenshotParams, WindowScrollParams, WindowTypeParams, WindowExtractParams, WindowActParams, WindowLlmParams, WindowFindOneParams, WindowFindManyParams, WindowWaitForPageParams, WindowNavigateParams, WindowFillFormParams } from '@airtop/core/resources/windows.js';
|
15
|
-
export { WindowActParams, WindowClickParams, WindowExtractParams, WindowFillFormParams, WindowFindManyParams, WindowFindOneParams, WindowGetParams, WindowHoverParams, WindowLlmParams, WindowLoadURLParams, WindowMonitorParams, WindowNavigateParams, WindowPageQueryParams, WindowPaginatedExtractionParams, WindowScrapeParams, WindowScreenshotParams, WindowScrollParams, WindowTypeParams, WindowWaitForPageParams } from '@airtop/core/resources/windows.js';
|
16
14
|
import * as _airtop_core_resources_js from '@airtop/core/resources.js';
|
17
15
|
import { ConnectedServicesActionResponseEnvelope } from '@airtop/core/resources.js';
|
16
|
+
import { WindowClickParams, WindowHoverParams, WindowLoadURLParams, WindowMonitorParams, WindowPageQueryParams, WindowPaginatedExtractionParams, WindowScrapeParams, WindowScreenshotParams, WindowScrollParams, WindowTypeParams, WindowExtractParams, WindowActParams, WindowLlmParams, WindowFindOneParams, WindowFindManyParams, WindowWaitForPageParams, WindowNavigateParams, WindowFillFormParams } from '@airtop/core/resources/windows.js';
|
17
|
+
export { WindowActParams, WindowClickParams, WindowExtractParams, WindowFillFormParams, WindowFindManyParams, WindowFindOneParams, WindowGetParams, WindowHoverParams, WindowLlmParams, WindowLoadURLParams, WindowMonitorParams, WindowNavigateParams, WindowPageQueryParams, WindowPaginatedExtractionParams, WindowScrapeParams, WindowScreenshotParams, WindowScrollParams, WindowTypeParams, WindowWaitForPageParams } from '@airtop/core/resources/windows.js';
|
18
|
+
import { DeepOmit } from 'deep-utility-types';
|
18
19
|
export { DeepOmit } from 'deep-utility-types';
|
19
20
|
|
20
21
|
/**
|
@@ -58,7 +59,7 @@ interface CommonAirtopConfig {
|
|
58
59
|
* Configuration for defining the JSON schema output.
|
59
60
|
*/
|
60
61
|
interface OutputJsonSchemaConfig {
|
61
|
-
configuration
|
62
|
+
configuration?: {
|
62
63
|
/**
|
63
64
|
* JSON schema defining the structure of the output.
|
64
65
|
*/
|
@@ -214,7 +215,7 @@ interface AirtopConstructorConfig {
|
|
214
215
|
apiKey: string;
|
215
216
|
/**
|
216
217
|
* The base URL for the Airtop API.
|
217
|
-
* Defaults to https://api.airtop.ai/api
|
218
|
+
* Defaults to https://api.airtop.ai/api if not specified.
|
218
219
|
*/
|
219
220
|
airtopUrl?: string;
|
220
221
|
/**
|
@@ -458,16 +459,18 @@ interface WindowLoadUrlConfig extends Omit<WindowLoadURLParams, "sessionId" | "u
|
|
458
459
|
*/
|
459
460
|
interface WindowMonitorConfig extends Omit<WindowMonitorParams, "sessionId" | "condition"> {
|
460
461
|
}
|
462
|
+
interface WindowPageQueryParamsBase extends DeepOmit<WindowPageQueryParams, "sessionId" | "prompt" | "configuration.outputSchema"> {
|
463
|
+
}
|
461
464
|
/**
|
462
465
|
* Configuration parameters for performing a natural language query on page content.
|
463
466
|
*/
|
464
|
-
|
467
|
+
type WindowPageQueryConfig = WindowPageQueryParamsBase & OutputJsonSchemaConfig;
|
468
|
+
interface WindowPaginatedExtractionParamsBase extends DeepOmit<WindowPaginatedExtractionParams, "sessionId" | "prompt" | "configuration.outputSchema"> {
|
465
469
|
}
|
466
470
|
/**
|
467
471
|
* Configuration parameters for extracting paginated data from a window.
|
468
472
|
*/
|
469
|
-
|
470
|
-
}
|
473
|
+
type WindowPaginatedExtractionConfig = WindowPaginatedExtractionParamsBase & OutputJsonSchemaConfig;
|
471
474
|
/**
|
472
475
|
* Configuration parameters for scraping content from a window.
|
473
476
|
* Excludes session ID which is provided by the parent session.
|
@@ -893,7 +896,7 @@ declare class AirtopSessionClient extends AirtopBase {
|
|
893
896
|
* Returns the browser session ID.
|
894
897
|
*/
|
895
898
|
getSessionId(): string;
|
896
|
-
listWindows(requestOptions?: AirtopRequestOptions): Promise<
|
899
|
+
listWindows(requestOptions?: AirtopRequestOptions): Promise<WindowsResponse>;
|
897
900
|
/**
|
898
901
|
* Gets the state of the session using the attached session id.
|
899
902
|
* @param requestOptions - Request options
|
@@ -1121,23 +1124,25 @@ declare class AirtopMocks {
|
|
1121
1124
|
|
1122
1125
|
interface AirtopAgentCreateAgentParams extends Airtop.AgentCreateAgentParams {
|
1123
1126
|
}
|
1127
|
+
interface AirtopAgentGetAgentParams extends Airtop.AgentGetAgentParams {
|
1128
|
+
}
|
1124
1129
|
interface AirtopAgentGetAgentsParams extends Airtop.AgentGetAgentsParams {
|
1125
1130
|
}
|
1126
1131
|
interface AirtopAgentUpdateAgentParams extends Airtop.AgentUpdateAgentParams {
|
1127
1132
|
}
|
1128
1133
|
interface AirtopAgentDeleteAgentsParams extends Airtop.AgentDeleteAgentsParams {
|
1129
1134
|
}
|
1130
|
-
interface
|
1135
|
+
interface AirtopAgentCreateInvocationParams extends Airtop.AgentCreateInvocationParams {
|
1131
1136
|
}
|
1132
|
-
interface
|
1137
|
+
interface AirtopAgentGetInvocationsParams extends Airtop.AgentGetInvocationsParams {
|
1133
1138
|
}
|
1134
|
-
interface
|
1139
|
+
interface AirtopAgentCancelInvocationParams extends Omit<Airtop.AgentCancelInvocationParams, "id"> {
|
1135
1140
|
}
|
1136
|
-
interface
|
1141
|
+
interface AirtopAgentGetVersionDataParams extends Airtop.AgentGetCurrentAgentVersionParams {
|
1137
1142
|
}
|
1138
|
-
interface
|
1143
|
+
interface AirtopAgentUpdateVersionDataParams extends Omit<Airtop.AgentUpdateAgentVersionDataParams, "id"> {
|
1139
1144
|
}
|
1140
|
-
interface
|
1145
|
+
interface AirtopAgentPublishAgentParams extends Airtop.AgentPublishAgentParams {
|
1141
1146
|
}
|
1142
1147
|
interface AirtopCreateAgentResponse extends Airtop.CreateAgentResponse {
|
1143
1148
|
}
|
@@ -1149,18 +1154,20 @@ interface AirtopUpdateAgentResponse extends Airtop.UpdateAgentResponse {
|
|
1149
1154
|
}
|
1150
1155
|
interface AirtopDeleteAgentsResponse extends Airtop.DeleteResponse {
|
1151
1156
|
}
|
1152
|
-
interface AirtopDuplicateAgentResponse extends Airtop.DuplicateAgentResponse {
|
1153
|
-
}
|
1154
|
-
interface AirtopCreateAgentVersionResponse extends Airtop.CreateAgentVersionResponse {
|
1155
|
-
}
|
1156
|
-
interface AirtopGetAgentVersionsResponse extends Airtop.GetAgentVersionsResponse {
|
1157
|
-
}
|
1158
1157
|
interface AirtopCreateAgentInvocationResponse extends Airtop.CreateAgentInvocationResponse {
|
1159
1158
|
}
|
1160
1159
|
interface AirtopGetAgentInvocationsResponse extends Airtop.GetAgentInvocationsResponse {
|
1161
1160
|
}
|
1162
1161
|
interface AirtopAgentResponse extends Airtop.GetAgentResponse {
|
1163
1162
|
}
|
1163
|
+
interface AirtopCreateNewAgentDraftResponse extends Airtop.AgentCreateDraftResponse {
|
1164
|
+
}
|
1165
|
+
interface AirtopPublishNewAgentResponse extends Airtop.AgentPublishDraftResponse {
|
1166
|
+
}
|
1167
|
+
interface AirtopGetAgentVersionDataResponse extends Airtop.AgentGetVersionDataResponse {
|
1168
|
+
}
|
1169
|
+
interface AirtopUpdateVersionDataResponse extends Airtop.AgentUpdateVersionDataResponse {
|
1170
|
+
}
|
1164
1171
|
|
1165
1172
|
/**
|
1166
1173
|
* Client for making Agent-specific requests to the Airtop API.
|
@@ -1172,85 +1179,85 @@ declare class AirtopAgentClient extends AirtopBase {
|
|
1172
1179
|
*/
|
1173
1180
|
constructor(config: AirtopConstructorConfig);
|
1174
1181
|
/**
|
1175
|
-
* Creates a new agent.
|
1176
|
-
* @param params - Parameters for creating the agent.
|
1182
|
+
* Creates a new agent. A new draft version is created by default.
|
1183
|
+
* @param params - Parameters for creating the agent.
|
1177
1184
|
* @param requestOptions - Request options.
|
1178
|
-
* @returns The created agent data
|
1185
|
+
* @returns The created agent data.
|
1179
1186
|
*/
|
1180
1187
|
createAgent(params: AirtopAgentCreateAgentParams, requestOptions?: AirtopRequestOptions): Promise<AirtopCreateAgentResponse>;
|
1181
1188
|
/**
|
1182
1189
|
* Retrieves a specific agent by its ID.
|
1183
1190
|
* @param agentId - The ID of the agent to retrieve.
|
1184
1191
|
* @param requestOptions - Request options.
|
1185
|
-
* @returns The agent data
|
1192
|
+
* @returns The agent data.
|
1186
1193
|
*/
|
1187
|
-
getAgent(agentId: string,
|
1188
|
-
requestOptions?: AirtopRequestOptions): Promise<AirtopGetAgentResponse>;
|
1194
|
+
getAgent(agentId: string, params?: AirtopAgentGetAgentParams, requestOptions?: AirtopRequestOptions): Promise<AirtopGetAgentResponse>;
|
1189
1195
|
/**
|
1190
1196
|
* Lists agents.
|
1191
|
-
* @param params - Optional parameters for listing agents (e.g., pagination).
|
1197
|
+
* @param params - Optional parameters for listing agents (e.g., pagination).
|
1192
1198
|
* @param requestOptions - Request options.
|
1193
|
-
* @returns A list of agents
|
1199
|
+
* @returns A list of agents.
|
1194
1200
|
*/
|
1195
1201
|
listAgents(params?: AirtopAgentGetAgentsParams, requestOptions?: AirtopRequestOptions): Promise<AirtopGetAgentsResponse>;
|
1196
1202
|
/**
|
1197
|
-
*
|
1198
|
-
* @param agentId - The ID of the agent to
|
1199
|
-
* @param params - The new data for the agent. Corresponds to `AirtopAgentUpdateAgentParams`.
|
1203
|
+
* Creates a new draft version of an agent. If one already exists, does nothing.
|
1204
|
+
* @param agentId - The ID of the agent for which to create a new draft version.
|
1200
1205
|
* @param requestOptions - Request options.
|
1201
|
-
* @returns The
|
1206
|
+
* @returns The draft version data.
|
1202
1207
|
*/
|
1203
|
-
|
1204
|
-
params: AirtopAgentUpdateAgentParams, requestOptions?: AirtopRequestOptions): Promise<AirtopUpdateAgentResponse>;
|
1208
|
+
createNewAgentDraftVersion(agentId: string, requestOptions?: AirtopRequestOptions): Promise<AirtopCreateNewAgentDraftResponse>;
|
1205
1209
|
/**
|
1206
|
-
*
|
1207
|
-
* @param
|
1210
|
+
* Publishes a new version of an agent from the current draft.
|
1211
|
+
* @param agentId - The ID of the agent to publish.
|
1212
|
+
* @returns The published version data
|
1213
|
+
*/
|
1214
|
+
publishNewAgentVersion(agentId: string, params?: AirtopAgentPublishAgentParams, requestOptions?: AirtopRequestOptions): Promise<AirtopPublishNewAgentResponse>;
|
1215
|
+
/**
|
1216
|
+
* Retrieves the data for a specific version of an agent.
|
1217
|
+
* @param agentId - The ID of the agent.
|
1218
|
+
* @param version - The version number of the agent to retrieve.
|
1208
1219
|
* @param requestOptions - Request options.
|
1209
|
-
* @returns
|
1220
|
+
* @returns The agent version data.
|
1210
1221
|
*/
|
1211
|
-
|
1222
|
+
getAgentVersionData(agentId: string, version: number, requestOptions?: AirtopRequestOptions): Promise<AirtopGetAgentVersionDataResponse>;
|
1223
|
+
updateAgentVersionData(agentId: string, version: number, params: AirtopAgentUpdateVersionDataParams, requestOptions?: AirtopRequestOptions): Promise<AirtopUpdateVersionDataResponse>;
|
1212
1224
|
/**
|
1213
|
-
*
|
1214
|
-
* @param agentId - The ID of the agent
|
1215
|
-
* @param params -
|
1225
|
+
* Retrieves the current version data of an agent. This is the version that is currently active or in draft state.
|
1226
|
+
* @param agentId - The ID of the agent.
|
1227
|
+
* @param params - Optional parameters for retrieving the version data.
|
1216
1228
|
* @param requestOptions - Request options.
|
1217
|
-
* @returns The
|
1229
|
+
* @returns The current agent version data
|
1218
1230
|
*/
|
1219
|
-
|
1220
|
-
params: AirtopAgentDuplicateAgentParams, requestOptions?: AirtopRequestOptions): Promise<AirtopDuplicateAgentResponse>;
|
1231
|
+
getCurrentAgentVersionData(agentId: string, params?: AirtopAgentGetVersionDataParams, requestOptions?: AirtopRequestOptions): Promise<_airtop_core_resources_shared_mjs.AgentGetCurrentVersionDataResponse>;
|
1221
1232
|
/**
|
1222
|
-
*
|
1223
|
-
* @param agentId - The ID of the agent
|
1224
|
-
* @param params -
|
1233
|
+
* Updates an existing agent.
|
1234
|
+
* @param agentId - The ID of the agent to update.
|
1235
|
+
* @param params - The new data for the agent.
|
1225
1236
|
* @param requestOptions - Request options.
|
1226
|
-
* @returns The
|
1237
|
+
* @returns The updated agent data.
|
1227
1238
|
*/
|
1228
|
-
|
1229
|
-
params: AirtopAgentCreateVersionParams, requestOptions?: AirtopRequestOptions): Promise<AirtopCreateAgentVersionResponse>;
|
1239
|
+
updateAgent(agentId: string, params: AirtopAgentUpdateAgentParams, requestOptions?: AirtopRequestOptions): Promise<AirtopUpdateAgentResponse>;
|
1230
1240
|
/**
|
1231
|
-
*
|
1232
|
-
* @param
|
1233
|
-
* @param params - Optional parameters for listing agent versions. Corresponds to `AirtopAgentGetVersionsParams`.
|
1241
|
+
* Deletes one or more agents.
|
1242
|
+
* @param params - Parameters for deleting agents.
|
1234
1243
|
* @param requestOptions - Request options.
|
1235
|
-
* @returns A
|
1244
|
+
* @returns A response confirming the deletion.
|
1236
1245
|
*/
|
1237
|
-
|
1238
|
-
params?: AirtopAgentGetVersionsParams, requestOptions?: AirtopRequestOptions): Promise<AirtopGetAgentVersionsResponse>;
|
1246
|
+
deleteAgents(params: AirtopAgentDeleteAgentsParams, requestOptions?: AirtopRequestOptions): Promise<AirtopDeleteAgentsResponse>;
|
1239
1247
|
/**
|
1240
1248
|
* Creates an invocation for an agent.
|
1241
1249
|
* @param agentId - The ID of the agent for which to create an invocation.
|
1242
|
-
* @param params - Parameters for creating the agent invocation.
|
1250
|
+
* @param params - Parameters for creating the agent invocation.
|
1243
1251
|
* @param requestOptions - Request options.
|
1244
|
-
* @returns The created agent invocation data
|
1252
|
+
* @returns The created agent invocation data.
|
1245
1253
|
*/
|
1246
|
-
createAgentInvocation(agentId: string,
|
1247
|
-
params: AirtopAgentCreateInvocationParams, requestOptions?: AirtopRequestOptions): Promise<AirtopCreateAgentInvocationResponse>;
|
1254
|
+
createAgentInvocation(agentId: string, params: AirtopAgentCreateInvocationParams, requestOptions?: AirtopRequestOptions): Promise<AirtopCreateAgentInvocationResponse>;
|
1248
1255
|
/**
|
1249
1256
|
* Lists invocations of an agent.
|
1250
1257
|
* @param agentIds - The ID of the agent whose invocations to list.
|
1251
|
-
* @param params - Optional parameters for listing agent invocations.
|
1258
|
+
* @param params - Optional parameters for listing agent invocations.
|
1252
1259
|
* @param requestOptions - Request options.
|
1253
|
-
* @returns A list of agent invocations
|
1260
|
+
* @returns A list of agent invocations.
|
1254
1261
|
*/
|
1255
1262
|
listAgentInvocations(agentIds: string, // Renamed
|
1256
1263
|
params?: AirtopAgentGetInvocationsParams, requestOptions?: AirtopRequestOptions): Promise<AirtopGetAgentInvocationsResponse>;
|
@@ -1258,7 +1265,7 @@ declare class AirtopAgentClient extends AirtopBase {
|
|
1258
1265
|
* Cancels a specific invocation of an agent.
|
1259
1266
|
* @param agentId - The ID of the agent.
|
1260
1267
|
* @param invocationId - The ID of the invocation to cancel.
|
1261
|
-
* @param paramsBody - Optional body parameters for cancelling the invocation.
|
1268
|
+
* @param paramsBody - Optional body parameters for cancelling the invocation.
|
1262
1269
|
* @param requestOptions - Request options.
|
1263
1270
|
* @returns A promise that resolves when the operation is complete.
|
1264
1271
|
*/
|
@@ -1433,4 +1440,4 @@ interface AirtopPluginRegistration {
|
|
1433
1440
|
*/
|
1434
1441
|
declare function registerAirtopPlugin(plugin: AirtopPluginRegistration): void;
|
1435
1442
|
|
1436
|
-
export { type AirtopAgentCancelInvocationParams, AirtopAgentClient, type AirtopAgentCreateAgentParams, type AirtopAgentCreateInvocationParams, type
|
1443
|
+
export { type AirtopAgentCancelInvocationParams, AirtopAgentClient, type AirtopAgentCreateAgentParams, type AirtopAgentCreateInvocationParams, type AirtopAgentDeleteAgentsParams, type AirtopAgentGetAgentParams, type AirtopAgentGetAgentsParams, type AirtopAgentGetInvocationsParams, type AirtopAgentGetVersionDataParams, type AirtopAgentPublishAgentParams, type AirtopAgentResponse, type AirtopAgentUpdateAgentParams, type AirtopAgentUpdateVersionDataParams, type AirtopAutomationData, type AirtopAutomationListResponse, type AirtopAutomationUpdateDescriptionConfig, AirtopBase, AirtopClient, type AirtopClientPlugin, type AirtopConstructorConfig, type AirtopCreateAgentInvocationResponse, type AirtopCreateAgentResponse, type AirtopCreateNewAgentDraftResponse, type AirtopDeleteAgentsResponse, AirtopError, type AirtopFileListParams, type AirtopFileResponse, type AirtopFilesResponse, type AirtopGetAgentInvocationsResponse, type AirtopGetAgentResponse, type AirtopGetAgentVersionDataResponse, type AirtopGetAgentsResponse, AirtopMocks, AirtopNode, type AirtopNodeApiResponseData, AirtopPluginAugmentationType, type AirtopPluginRegistration, type AirtopPluginType, type AirtopProfile, type AirtopPublishNewAgentResponse, type AirtopRequestOptions, AirtopSession, AirtopSessionClient, type AirtopSessionClientPlugin, type AirtopSessionPlugin, type AirtopSessionResponse, type AirtopUpdateAgentResponse, type AirtopUpdateVersionDataResponse, AirtopWindow, AirtopWindowClient, type AirtopWindowClientPlugin, type AirtopWindowCreateResponse, type AirtopWindowGetInfoResponse, type AirtopWindowPlugin, AirtopWindowScreenshot, type AirtopWindowScreenshotPlugin, type AirtopWindowScreenshotResponse, type CommonAirtopConfig, type CommonResponse, type CommonWindowResponse, type CreateFileConfig, type CreateSessionConfig, type GetFilesConfig, type GetSessionsConfig, type OutputJsonSchemaConfig, type ScreenshotData, type SessionData, type SessionError, type SessionMetadata, type SessionServiceResponse, type SessionWarning, type WindowActConfig, type WindowActResponse, type WindowClickConfig, type WindowCreateData, type WindowCreateOptions, type WindowError, type WindowExtractConfig, type WindowExtractResponse, type WindowFillFormConfig, type WindowFindManyConfig, type WindowFindManyResponse, type WindowFindOneConfig, type WindowFindOneResponse, type WindowGetConfig, type WindowHoverConfig, type WindowInfoData, type WindowLlmConfig, type WindowLlmResponse, type WindowLoadUrlConfig, type WindowMetadata, type WindowMonitorConfig, type WindowNavigateConfig, WindowNavigateDirection, type WindowNavigateResponse, type WindowPageQueryConfig, type WindowPaginatedExtractionConfig, type WindowPromptResponse, type WindowScrapeConfig, type WindowScrapeResponse, type WindowScreenshotConfig, type WindowScrollConfig, type WindowTypeConfig, type WindowWaitForPageConfig, type WindowWaitForPageResponse, type WindowWarning, registerAirtopPlugin };
|