Release v1.0.2 (#4175)
This commit is contained in:
committed by
GitHub
parent
2961fdd721
commit
d9610701d3
@@ -6,7 +6,7 @@
|
||||
* include_deleted: true
|
||||
* }
|
||||
*/
|
||||
export interface ListBrowserProfilesV1BrowserProfilesGetRequest {
|
||||
export interface ListBrowserProfilesRequest {
|
||||
/** Include deleted browser profiles */
|
||||
include_deleted?: boolean;
|
||||
}
|
||||
@@ -25,6 +25,8 @@ export interface LoginRequest {
|
||||
totp_url?: string;
|
||||
/** ID of the browser session to use, which is prefixed by `pbs_` e.g. `pbs_123456` */
|
||||
browser_session_id?: string;
|
||||
/** ID of a browser profile to reuse for this run */
|
||||
browser_profile_id?: string;
|
||||
/** The CDP address for the task. */
|
||||
browser_address?: string;
|
||||
/** Additional HTTP headers to include in requests */
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
export type { CreateBrowserProfileRequest } from "./CreateBrowserProfileRequest.js";
|
||||
export type { CreateBrowserSessionRequest } from "./CreateBrowserSessionRequest.js";
|
||||
export type { CreateCredentialRequest } from "./CreateCredentialRequest.js";
|
||||
export type { CreateScriptRequest } from "./CreateScriptRequest.js";
|
||||
@@ -7,6 +8,7 @@ export type { GetCredentialsRequest } from "./GetCredentialsRequest.js";
|
||||
export type { GetRunArtifactsRequest } from "./GetRunArtifactsRequest.js";
|
||||
export type { GetScriptsRequest } from "./GetScriptsRequest.js";
|
||||
export type { GetWorkflowsRequest } from "./GetWorkflowsRequest.js";
|
||||
export type { ListBrowserProfilesRequest } from "./ListBrowserProfilesRequest.js";
|
||||
export type { LoginRequest } from "./LoginRequest.js";
|
||||
export type { RunSdkActionRequest } from "./RunSdkActionRequest.js";
|
||||
export type { RunTaskRequest } from "./RunTaskRequest.js";
|
||||
|
||||
16
skyvern-ts/client/src/api/errors/ConflictError.ts
Normal file
16
skyvern-ts/client/src/api/errors/ConflictError.ts
Normal file
@@ -0,0 +1,16 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
import type * as core from "../../core/index.js";
|
||||
import * as errors from "../../errors/index.js";
|
||||
|
||||
export class ConflictError extends errors.SkyvernError {
|
||||
constructor(body?: unknown, rawResponse?: core.RawResponse) {
|
||||
super({
|
||||
message: "ConflictError",
|
||||
statusCode: 409,
|
||||
body: body,
|
||||
rawResponse: rawResponse,
|
||||
});
|
||||
Object.setPrototypeOf(this, ConflictError.prototype);
|
||||
}
|
||||
}
|
||||
@@ -1,4 +1,5 @@
|
||||
export * from "./BadRequestError.js";
|
||||
export * from "./ConflictError.js";
|
||||
export * from "./ForbiddenError.js";
|
||||
export * from "./NotFoundError.js";
|
||||
export * from "./UnprocessableEntityError.js";
|
||||
|
||||
@@ -1,343 +0,0 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
|
||||
import { mergeHeaders, mergeOnlyDefinedHeaders } from "../../../../core/headers.js";
|
||||
import * as core from "../../../../core/index.js";
|
||||
import * as environments from "../../../../environments.js";
|
||||
import * as errors from "../../../../errors/index.js";
|
||||
import * as Skyvern from "../../../index.js";
|
||||
|
||||
export declare namespace BrowserProfiles {
|
||||
export interface Options extends BaseClientOptions {}
|
||||
|
||||
export interface RequestOptions extends BaseRequestOptions {}
|
||||
}
|
||||
|
||||
export class BrowserProfiles {
|
||||
protected readonly _options: BrowserProfiles.Options;
|
||||
|
||||
constructor(_options: BrowserProfiles.Options = {}) {
|
||||
this._options = _options;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all browser profiles for the organization
|
||||
*
|
||||
* @param {Skyvern.ListBrowserProfilesV1BrowserProfilesGetRequest} request
|
||||
* @param {BrowserProfiles.RequestOptions} requestOptions - Request-specific configuration.
|
||||
*
|
||||
* @throws {@link Skyvern.UnprocessableEntityError}
|
||||
*
|
||||
* @example
|
||||
* await client.browserProfiles.listBrowserProfiles({
|
||||
* include_deleted: true
|
||||
* })
|
||||
*/
|
||||
public listBrowserProfiles(
|
||||
request: Skyvern.ListBrowserProfilesV1BrowserProfilesGetRequest = {},
|
||||
requestOptions?: BrowserProfiles.RequestOptions,
|
||||
): core.HttpResponsePromise<Skyvern.BrowserProfile[]> {
|
||||
return core.HttpResponsePromise.fromPromise(this.__listBrowserProfiles(request, requestOptions));
|
||||
}
|
||||
|
||||
private async __listBrowserProfiles(
|
||||
request: Skyvern.ListBrowserProfilesV1BrowserProfilesGetRequest = {},
|
||||
requestOptions?: BrowserProfiles.RequestOptions,
|
||||
): Promise<core.WithRawResponse<Skyvern.BrowserProfile[]>> {
|
||||
const { include_deleted: includeDeleted } = request;
|
||||
const _queryParams: Record<string, string | string[] | object | object[] | null> = {};
|
||||
if (includeDeleted != null) {
|
||||
_queryParams.include_deleted = includeDeleted.toString();
|
||||
}
|
||||
|
||||
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
|
||||
this._options?.headers,
|
||||
mergeOnlyDefinedHeaders({ "x-api-key": requestOptions?.apiKey ?? this._options?.apiKey }),
|
||||
requestOptions?.headers,
|
||||
);
|
||||
const _response = await core.fetcher({
|
||||
url: core.url.join(
|
||||
(await core.Supplier.get(this._options.baseUrl)) ??
|
||||
(await core.Supplier.get(this._options.environment)) ??
|
||||
environments.SkyvernEnvironment.Cloud,
|
||||
"v1/browser_profiles",
|
||||
),
|
||||
method: "GET",
|
||||
headers: _headers,
|
||||
queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
|
||||
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
||||
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
||||
abortSignal: requestOptions?.abortSignal,
|
||||
});
|
||||
if (_response.ok) {
|
||||
return { data: _response.body as Skyvern.BrowserProfile[], rawResponse: _response.rawResponse };
|
||||
}
|
||||
|
||||
if (_response.error.reason === "status-code") {
|
||||
switch (_response.error.statusCode) {
|
||||
case 422:
|
||||
throw new Skyvern.UnprocessableEntityError(_response.error.body as unknown, _response.rawResponse);
|
||||
default:
|
||||
throw new errors.SkyvernError({
|
||||
statusCode: _response.error.statusCode,
|
||||
body: _response.error.body,
|
||||
rawResponse: _response.rawResponse,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
switch (_response.error.reason) {
|
||||
case "non-json":
|
||||
throw new errors.SkyvernError({
|
||||
statusCode: _response.error.statusCode,
|
||||
body: _response.error.rawBody,
|
||||
rawResponse: _response.rawResponse,
|
||||
});
|
||||
case "timeout":
|
||||
throw new errors.SkyvernTimeoutError("Timeout exceeded when calling GET /v1/browser_profiles.");
|
||||
case "unknown":
|
||||
throw new errors.SkyvernError({
|
||||
message: _response.error.errorMessage,
|
||||
rawResponse: _response.rawResponse,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {Skyvern.CreateBrowserProfileRequest} request
|
||||
* @param {BrowserProfiles.RequestOptions} requestOptions - Request-specific configuration.
|
||||
*
|
||||
* @throws {@link Skyvern.UnprocessableEntityError}
|
||||
*
|
||||
* @example
|
||||
* await client.browserProfiles.createBrowserProfile({
|
||||
* name: "name"
|
||||
* })
|
||||
*/
|
||||
public createBrowserProfile(
|
||||
request: Skyvern.CreateBrowserProfileRequest,
|
||||
requestOptions?: BrowserProfiles.RequestOptions,
|
||||
): core.HttpResponsePromise<Skyvern.BrowserProfile> {
|
||||
return core.HttpResponsePromise.fromPromise(this.__createBrowserProfile(request, requestOptions));
|
||||
}
|
||||
|
||||
private async __createBrowserProfile(
|
||||
request: Skyvern.CreateBrowserProfileRequest,
|
||||
requestOptions?: BrowserProfiles.RequestOptions,
|
||||
): Promise<core.WithRawResponse<Skyvern.BrowserProfile>> {
|
||||
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
|
||||
this._options?.headers,
|
||||
mergeOnlyDefinedHeaders({ "x-api-key": requestOptions?.apiKey ?? this._options?.apiKey }),
|
||||
requestOptions?.headers,
|
||||
);
|
||||
const _response = await core.fetcher({
|
||||
url: core.url.join(
|
||||
(await core.Supplier.get(this._options.baseUrl)) ??
|
||||
(await core.Supplier.get(this._options.environment)) ??
|
||||
environments.SkyvernEnvironment.Cloud,
|
||||
"v1/browser_profiles",
|
||||
),
|
||||
method: "POST",
|
||||
headers: _headers,
|
||||
contentType: "application/json",
|
||||
queryParameters: requestOptions?.queryParams,
|
||||
requestType: "json",
|
||||
body: request,
|
||||
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
||||
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
||||
abortSignal: requestOptions?.abortSignal,
|
||||
});
|
||||
if (_response.ok) {
|
||||
return { data: _response.body as Skyvern.BrowserProfile, rawResponse: _response.rawResponse };
|
||||
}
|
||||
|
||||
if (_response.error.reason === "status-code") {
|
||||
switch (_response.error.statusCode) {
|
||||
case 422:
|
||||
throw new Skyvern.UnprocessableEntityError(_response.error.body as unknown, _response.rawResponse);
|
||||
default:
|
||||
throw new errors.SkyvernError({
|
||||
statusCode: _response.error.statusCode,
|
||||
body: _response.error.body,
|
||||
rawResponse: _response.rawResponse,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
switch (_response.error.reason) {
|
||||
case "non-json":
|
||||
throw new errors.SkyvernError({
|
||||
statusCode: _response.error.statusCode,
|
||||
body: _response.error.rawBody,
|
||||
rawResponse: _response.rawResponse,
|
||||
});
|
||||
case "timeout":
|
||||
throw new errors.SkyvernTimeoutError("Timeout exceeded when calling POST /v1/browser_profiles.");
|
||||
case "unknown":
|
||||
throw new errors.SkyvernError({
|
||||
message: _response.error.errorMessage,
|
||||
rawResponse: _response.rawResponse,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a specific browser profile by ID
|
||||
*
|
||||
* @param {string} profileId - The ID of the browser profile. browser_profile_id starts with `bp_`
|
||||
* @param {BrowserProfiles.RequestOptions} requestOptions - Request-specific configuration.
|
||||
*
|
||||
* @throws {@link Skyvern.NotFoundError}
|
||||
* @throws {@link Skyvern.UnprocessableEntityError}
|
||||
*
|
||||
* @example
|
||||
* await client.browserProfiles.getBrowserProfile("bp_123456")
|
||||
*/
|
||||
public getBrowserProfile(
|
||||
profileId: string,
|
||||
requestOptions?: BrowserProfiles.RequestOptions,
|
||||
): core.HttpResponsePromise<Skyvern.BrowserProfile> {
|
||||
return core.HttpResponsePromise.fromPromise(this.__getBrowserProfile(profileId, requestOptions));
|
||||
}
|
||||
|
||||
private async __getBrowserProfile(
|
||||
profileId: string,
|
||||
requestOptions?: BrowserProfiles.RequestOptions,
|
||||
): Promise<core.WithRawResponse<Skyvern.BrowserProfile>> {
|
||||
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
|
||||
this._options?.headers,
|
||||
mergeOnlyDefinedHeaders({ "x-api-key": requestOptions?.apiKey ?? this._options?.apiKey }),
|
||||
requestOptions?.headers,
|
||||
);
|
||||
const _response = await core.fetcher({
|
||||
url: core.url.join(
|
||||
(await core.Supplier.get(this._options.baseUrl)) ??
|
||||
(await core.Supplier.get(this._options.environment)) ??
|
||||
environments.SkyvernEnvironment.Cloud,
|
||||
`v1/browser_profiles/${core.url.encodePathParam(profileId)}`,
|
||||
),
|
||||
method: "GET",
|
||||
headers: _headers,
|
||||
queryParameters: requestOptions?.queryParams,
|
||||
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
||||
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
||||
abortSignal: requestOptions?.abortSignal,
|
||||
});
|
||||
if (_response.ok) {
|
||||
return { data: _response.body as Skyvern.BrowserProfile, rawResponse: _response.rawResponse };
|
||||
}
|
||||
|
||||
if (_response.error.reason === "status-code") {
|
||||
switch (_response.error.statusCode) {
|
||||
case 404:
|
||||
throw new Skyvern.NotFoundError(_response.error.body as unknown, _response.rawResponse);
|
||||
case 422:
|
||||
throw new Skyvern.UnprocessableEntityError(_response.error.body as unknown, _response.rawResponse);
|
||||
default:
|
||||
throw new errors.SkyvernError({
|
||||
statusCode: _response.error.statusCode,
|
||||
body: _response.error.body,
|
||||
rawResponse: _response.rawResponse,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
switch (_response.error.reason) {
|
||||
case "non-json":
|
||||
throw new errors.SkyvernError({
|
||||
statusCode: _response.error.statusCode,
|
||||
body: _response.error.rawBody,
|
||||
rawResponse: _response.rawResponse,
|
||||
});
|
||||
case "timeout":
|
||||
throw new errors.SkyvernTimeoutError(
|
||||
"Timeout exceeded when calling GET /v1/browser_profiles/{profile_id}.",
|
||||
);
|
||||
case "unknown":
|
||||
throw new errors.SkyvernError({
|
||||
message: _response.error.errorMessage,
|
||||
rawResponse: _response.rawResponse,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a browser profile (soft delete)
|
||||
*
|
||||
* @param {string} profileId - The ID of the browser profile to delete. browser_profile_id starts with `bp_`
|
||||
* @param {BrowserProfiles.RequestOptions} requestOptions - Request-specific configuration.
|
||||
*
|
||||
* @throws {@link Skyvern.NotFoundError}
|
||||
* @throws {@link Skyvern.UnprocessableEntityError}
|
||||
*
|
||||
* @example
|
||||
* await client.browserProfiles.deleteBrowserProfile("bp_123456")
|
||||
*/
|
||||
public deleteBrowserProfile(
|
||||
profileId: string,
|
||||
requestOptions?: BrowserProfiles.RequestOptions,
|
||||
): core.HttpResponsePromise<void> {
|
||||
return core.HttpResponsePromise.fromPromise(this.__deleteBrowserProfile(profileId, requestOptions));
|
||||
}
|
||||
|
||||
private async __deleteBrowserProfile(
|
||||
profileId: string,
|
||||
requestOptions?: BrowserProfiles.RequestOptions,
|
||||
): Promise<core.WithRawResponse<void>> {
|
||||
const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
|
||||
this._options?.headers,
|
||||
mergeOnlyDefinedHeaders({ "x-api-key": requestOptions?.apiKey ?? this._options?.apiKey }),
|
||||
requestOptions?.headers,
|
||||
);
|
||||
const _response = await core.fetcher({
|
||||
url: core.url.join(
|
||||
(await core.Supplier.get(this._options.baseUrl)) ??
|
||||
(await core.Supplier.get(this._options.environment)) ??
|
||||
environments.SkyvernEnvironment.Cloud,
|
||||
`v1/browser_profiles/${core.url.encodePathParam(profileId)}`,
|
||||
),
|
||||
method: "DELETE",
|
||||
headers: _headers,
|
||||
queryParameters: requestOptions?.queryParams,
|
||||
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
||||
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
||||
abortSignal: requestOptions?.abortSignal,
|
||||
});
|
||||
if (_response.ok) {
|
||||
return { data: undefined, rawResponse: _response.rawResponse };
|
||||
}
|
||||
|
||||
if (_response.error.reason === "status-code") {
|
||||
switch (_response.error.statusCode) {
|
||||
case 404:
|
||||
throw new Skyvern.NotFoundError(_response.error.body as unknown, _response.rawResponse);
|
||||
case 422:
|
||||
throw new Skyvern.UnprocessableEntityError(_response.error.body as unknown, _response.rawResponse);
|
||||
default:
|
||||
throw new errors.SkyvernError({
|
||||
statusCode: _response.error.statusCode,
|
||||
body: _response.error.body,
|
||||
rawResponse: _response.rawResponse,
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
switch (_response.error.reason) {
|
||||
case "non-json":
|
||||
throw new errors.SkyvernError({
|
||||
statusCode: _response.error.statusCode,
|
||||
body: _response.error.rawBody,
|
||||
rawResponse: _response.rawResponse,
|
||||
});
|
||||
case "timeout":
|
||||
throw new errors.SkyvernTimeoutError(
|
||||
"Timeout exceeded when calling DELETE /v1/browser_profiles/{profile_id}.",
|
||||
);
|
||||
case "unknown":
|
||||
throw new errors.SkyvernError({
|
||||
message: _response.error.errorMessage,
|
||||
rawResponse: _response.rawResponse,
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1 +0,0 @@
|
||||
export * from "./requests/index.js";
|
||||
@@ -1,2 +0,0 @@
|
||||
export type { CreateBrowserProfileRequest } from "./CreateBrowserProfileRequest.js";
|
||||
export type { ListBrowserProfilesV1BrowserProfilesGetRequest } from "./ListBrowserProfilesV1BrowserProfilesGetRequest.js";
|
||||
@@ -1 +0,0 @@
|
||||
export * from "./client/index.js";
|
||||
@@ -1,5 +1,3 @@
|
||||
export * from "./browserProfiles/client/requests/index.js";
|
||||
export * as browserProfiles from "./browserProfiles/index.js";
|
||||
export * as scripts from "./scripts/index.js";
|
||||
export * from "./workflows/client/requests/index.js";
|
||||
export * as workflows from "./workflows/index.js";
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface ActionBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
@@ -25,7 +28,6 @@ export interface ActionBlock {
|
||||
download_suffix?: string;
|
||||
totp_verification_url?: string;
|
||||
totp_identifier?: string;
|
||||
cache_actions?: boolean;
|
||||
complete_verification?: boolean;
|
||||
include_action_history_in_verification?: boolean;
|
||||
download_timeout?: number;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface ActionBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
url?: string;
|
||||
@@ -17,6 +20,5 @@ export interface ActionBlockYaml {
|
||||
download_suffix?: string;
|
||||
totp_verification_url?: string;
|
||||
totp_identifier?: string;
|
||||
cache_actions?: boolean;
|
||||
disable_cache?: boolean;
|
||||
}
|
||||
|
||||
@@ -4,6 +4,7 @@ export const BlockType = {
|
||||
Task: "task",
|
||||
TaskV2: "task_v2",
|
||||
ForLoop: "for_loop",
|
||||
Conditional: "conditional",
|
||||
Code: "code",
|
||||
TextPrompt: "text_prompt",
|
||||
DownloadToS3: "download_to_s3",
|
||||
|
||||
13
skyvern-ts/client/src/api/types/BranchCondition.ts
Normal file
13
skyvern-ts/client/src/api/types/BranchCondition.ts
Normal file
@@ -0,0 +1,13 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
/**
|
||||
* Represents a single conditional branch edge within a ConditionalBlock.
|
||||
*/
|
||||
export interface BranchCondition {
|
||||
criteria?: Skyvern.BranchCriteria;
|
||||
next_block_label?: string;
|
||||
description?: string;
|
||||
is_default?: boolean;
|
||||
}
|
||||
10
skyvern-ts/client/src/api/types/BranchCriteria.ts
Normal file
10
skyvern-ts/client/src/api/types/BranchCriteria.ts
Normal file
@@ -0,0 +1,10 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
/**
|
||||
* Abstract interface describing how a branch condition should be evaluated.
|
||||
*/
|
||||
export interface BranchCriteria {
|
||||
criteria_type: string;
|
||||
expression: string;
|
||||
description?: string;
|
||||
}
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface CodeBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
export interface CodeBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
code: string;
|
||||
|
||||
18
skyvern-ts/client/src/api/types/ConditionalBlock.ts
Normal file
18
skyvern-ts/client/src/api/types/ConditionalBlock.ts
Normal file
@@ -0,0 +1,18 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
/**
|
||||
* Branching block that selects the next block label based on list-ordered conditions.
|
||||
*/
|
||||
export interface ConditionalBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
disable_cache?: boolean;
|
||||
branch_conditions?: Skyvern.BranchCondition[];
|
||||
}
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface DownloadToS3Block {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
export interface DownloadToS3BlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
url: string;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface ExtractionBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
@@ -25,7 +28,6 @@ export interface ExtractionBlock {
|
||||
download_suffix?: string;
|
||||
totp_verification_url?: string;
|
||||
totp_identifier?: string;
|
||||
cache_actions?: boolean;
|
||||
complete_verification?: boolean;
|
||||
include_action_history_in_verification?: boolean;
|
||||
download_timeout?: number;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface ExtractionBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
data_extraction_goal: string;
|
||||
@@ -14,7 +17,6 @@ export interface ExtractionBlockYaml {
|
||||
max_retries?: number;
|
||||
max_steps_per_run?: number;
|
||||
parameter_keys?: string[];
|
||||
cache_actions?: boolean;
|
||||
disable_cache?: boolean;
|
||||
}
|
||||
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface FileDownloadBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
@@ -25,7 +28,6 @@ export interface FileDownloadBlock {
|
||||
download_suffix?: string;
|
||||
totp_verification_url?: string;
|
||||
totp_identifier?: string;
|
||||
cache_actions?: boolean;
|
||||
complete_verification?: boolean;
|
||||
include_action_history_in_verification?: boolean;
|
||||
download_timeout?: number;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface FileDownloadBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
navigation_goal: string;
|
||||
@@ -17,7 +20,6 @@ export interface FileDownloadBlockYaml {
|
||||
download_suffix?: string;
|
||||
totp_verification_url?: string;
|
||||
totp_identifier?: string;
|
||||
cache_actions?: boolean;
|
||||
disable_cache?: boolean;
|
||||
download_timeout?: number;
|
||||
}
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface FileParserBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface FileParserBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
file_url: string;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface FileUploadBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface FileUploadBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
storage_type?: Skyvern.FileStorageType;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface ForLoopBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
|
||||
@@ -5,6 +5,7 @@ import type * as Skyvern from "../index.js";
|
||||
export type ForLoopBlockLoopBlocksItem =
|
||||
| Skyvern.ForLoopBlockLoopBlocksItem.Action
|
||||
| Skyvern.ForLoopBlockLoopBlocksItem.Code
|
||||
| Skyvern.ForLoopBlockLoopBlocksItem.Conditional
|
||||
| Skyvern.ForLoopBlockLoopBlocksItem.DownloadToS3
|
||||
| Skyvern.ForLoopBlockLoopBlocksItem.Extraction
|
||||
| Skyvern.ForLoopBlockLoopBlocksItem.FileDownload
|
||||
@@ -34,6 +35,10 @@ export namespace ForLoopBlockLoopBlocksItem {
|
||||
block_type: "code";
|
||||
}
|
||||
|
||||
export interface Conditional extends Skyvern.ConditionalBlock {
|
||||
block_type: "conditional";
|
||||
}
|
||||
|
||||
export interface DownloadToS3 extends Skyvern.DownloadToS3Block {
|
||||
block_type: "download_to_s3";
|
||||
}
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface ForLoopBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
loop_blocks: Skyvern.ForLoopBlockYamlLoopBlocksItem[];
|
||||
|
||||
23
skyvern-ts/client/src/api/types/GeoTarget.ts
Normal file
23
skyvern-ts/client/src/api/types/GeoTarget.ts
Normal file
@@ -0,0 +1,23 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
/**
|
||||
* Granular geographic targeting for proxy selection.
|
||||
*
|
||||
* Supports country, subdivision (state/region), and city level targeting.
|
||||
* Uses ISO 3166-1 alpha-2 for countries, ISO 3166-2 for subdivisions,
|
||||
* and GeoNames English names for cities.
|
||||
*
|
||||
* Examples:
|
||||
* - {"country": "US"} - United States (same as RESIDENTIAL)
|
||||
* - {"country": "US", "subdivision": "CA"} - California, US
|
||||
* - {"country": "US", "subdivision": "NY", "city": "New York"} - New York City
|
||||
* - {"country": "GB", "city": "London"} - London, UK
|
||||
*/
|
||||
export interface GeoTarget {
|
||||
/** ISO 3166-1 alpha-2 country code (e.g., 'US', 'GB', 'DE') */
|
||||
country: string;
|
||||
/** ISO 3166-2 subdivision code without country prefix (e.g., 'CA' for California, 'NY' for New York) */
|
||||
subdivision?: string;
|
||||
/** City name in English from GeoNames (e.g., 'New York', 'Los Angeles', 'London') */
|
||||
city?: string;
|
||||
}
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface HttpRequestBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
export interface HttpRequestBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
method?: string;
|
||||
|
||||
@@ -14,7 +14,10 @@ import type * as Skyvern from "../index.js";
|
||||
* - does not respond within the timeout period, the workflow terminates
|
||||
*/
|
||||
export interface HumanInteractionBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
@@ -36,7 +39,6 @@ export interface HumanInteractionBlock {
|
||||
download_suffix?: string;
|
||||
totp_verification_url?: string;
|
||||
totp_identifier?: string;
|
||||
cache_actions?: boolean;
|
||||
complete_verification?: boolean;
|
||||
include_action_history_in_verification?: boolean;
|
||||
download_timeout?: number;
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
export interface HumanInteractionBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
instructions?: string;
|
||||
|
||||
9
skyvern-ts/client/src/api/types/LocateElementAction.ts
Normal file
9
skyvern-ts/client/src/api/types/LocateElementAction.ts
Normal file
@@ -0,0 +1,9 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
/**
|
||||
* Locate element action parameters.
|
||||
*/
|
||||
export interface LocateElementAction {
|
||||
/** Natural language prompt to locate an element */
|
||||
prompt?: string;
|
||||
}
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface LoginBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
@@ -25,7 +28,6 @@ export interface LoginBlock {
|
||||
download_suffix?: string;
|
||||
totp_verification_url?: string;
|
||||
totp_identifier?: string;
|
||||
cache_actions?: boolean;
|
||||
complete_verification?: boolean;
|
||||
include_action_history_in_verification?: boolean;
|
||||
download_timeout?: number;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface LoginBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
url?: string;
|
||||
@@ -16,7 +19,6 @@ export interface LoginBlockYaml {
|
||||
parameter_keys?: string[];
|
||||
totp_verification_url?: string;
|
||||
totp_identifier?: string;
|
||||
cache_actions?: boolean;
|
||||
disable_cache?: boolean;
|
||||
complete_criterion?: string;
|
||||
terminate_criterion?: string;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface NavigationBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
@@ -25,7 +28,6 @@ export interface NavigationBlock {
|
||||
download_suffix?: string;
|
||||
totp_verification_url?: string;
|
||||
totp_identifier?: string;
|
||||
cache_actions?: boolean;
|
||||
complete_verification?: boolean;
|
||||
include_action_history_in_verification?: boolean;
|
||||
download_timeout?: number;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface NavigationBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
navigation_goal: string;
|
||||
@@ -18,7 +21,6 @@ export interface NavigationBlockYaml {
|
||||
download_suffix?: string;
|
||||
totp_verification_url?: string;
|
||||
totp_identifier?: string;
|
||||
cache_actions?: boolean;
|
||||
disable_cache?: boolean;
|
||||
complete_criterion?: string;
|
||||
terminate_criterion?: string;
|
||||
|
||||
@@ -14,4 +14,6 @@ export interface NonEmptyPasswordCredential {
|
||||
totp?: string;
|
||||
/** Type of 2FA method used for this credential */
|
||||
totp_type?: Skyvern.TotpType;
|
||||
/** Identifier (email or phone number) used to fetch TOTP codes */
|
||||
totp_identifier?: string;
|
||||
}
|
||||
|
||||
@@ -10,4 +10,6 @@ export interface PasswordCredentialResponse {
|
||||
username: string;
|
||||
/** Type of 2FA method used for this credential */
|
||||
totp_type?: Skyvern.TotpType;
|
||||
/** Identifier (email or phone number) used to fetch TOTP codes */
|
||||
totp_identifier?: string;
|
||||
}
|
||||
|
||||
@@ -7,7 +7,10 @@ import type * as Skyvern from "../index.js";
|
||||
* This block will be removed in a future version.
|
||||
*/
|
||||
export interface PdfParserBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
export interface PdfParserBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
file_url: string;
|
||||
|
||||
@@ -11,7 +11,8 @@ export type RunSdkActionRequestAction =
|
||||
| Skyvern.RunSdkActionRequestAction.AiInputText
|
||||
| Skyvern.RunSdkActionRequestAction.AiSelectOption
|
||||
| Skyvern.RunSdkActionRequestAction.AiUploadFile
|
||||
| Skyvern.RunSdkActionRequestAction.Extract;
|
||||
| Skyvern.RunSdkActionRequestAction.Extract
|
||||
| Skyvern.RunSdkActionRequestAction.LocateElement;
|
||||
|
||||
export namespace RunSdkActionRequestAction {
|
||||
export interface AiAct extends Skyvern.ActAction {
|
||||
@@ -37,4 +38,8 @@ export namespace RunSdkActionRequestAction {
|
||||
export interface Extract extends Skyvern.ExtractAction {
|
||||
type: "extract";
|
||||
}
|
||||
|
||||
export interface LocateElement extends Skyvern.LocateElementAction {
|
||||
type: "locate_element";
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface SendEmailBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
export interface SendEmailBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
smtp_host_secret_parameter_key: string;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface TaskBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
@@ -25,7 +28,6 @@ export interface TaskBlock {
|
||||
download_suffix?: string;
|
||||
totp_verification_url?: string;
|
||||
totp_identifier?: string;
|
||||
cache_actions?: boolean;
|
||||
complete_verification?: boolean;
|
||||
include_action_history_in_verification?: boolean;
|
||||
download_timeout?: number;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface TaskBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
url?: string;
|
||||
@@ -20,7 +23,6 @@ export interface TaskBlockYaml {
|
||||
download_suffix?: string;
|
||||
totp_verification_url?: string;
|
||||
totp_identifier?: string;
|
||||
cache_actions?: boolean;
|
||||
disable_cache?: boolean;
|
||||
complete_criterion?: string;
|
||||
terminate_criterion?: string;
|
||||
|
||||
@@ -40,8 +40,9 @@ export interface TaskRunRequest {
|
||||
* - US-FL: Florida
|
||||
* - US-WA: Washington
|
||||
* - NONE: No proxy
|
||||
* Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
|
||||
*/
|
||||
proxy_location?: Skyvern.ProxyLocation;
|
||||
proxy_location?: TaskRunRequest.ProxyLocation;
|
||||
/**
|
||||
* The schema for data to be extracted from the webpage. If you're looking for consistent data schema being returned by the agent, it's highly recommended to use https://json-schema.org/.
|
||||
*/
|
||||
@@ -87,6 +88,33 @@ export interface TaskRunRequest {
|
||||
}
|
||||
|
||||
export namespace TaskRunRequest {
|
||||
/**
|
||||
*
|
||||
* Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
|
||||
*
|
||||
* Available geotargeting options:
|
||||
* - RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.
|
||||
* - RESIDENTIAL_ES: Spain
|
||||
* - RESIDENTIAL_IE: Ireland
|
||||
* - RESIDENTIAL_GB: United Kingdom
|
||||
* - RESIDENTIAL_IN: India
|
||||
* - RESIDENTIAL_JP: Japan
|
||||
* - RESIDENTIAL_FR: France
|
||||
* - RESIDENTIAL_DE: Germany
|
||||
* - RESIDENTIAL_NZ: New Zealand
|
||||
* - RESIDENTIAL_ZA: South Africa
|
||||
* - RESIDENTIAL_AR: Argentina
|
||||
* - RESIDENTIAL_AU: Australia
|
||||
* - RESIDENTIAL_ISP: ISP proxy
|
||||
* - US-CA: California
|
||||
* - US-NY: New York
|
||||
* - US-TX: Texas
|
||||
* - US-FL: Florida
|
||||
* - US-WA: Washington
|
||||
* - NONE: No proxy
|
||||
* Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
|
||||
*/
|
||||
export type ProxyLocation = Skyvern.ProxyLocation | Skyvern.GeoTarget | Record<string, unknown>;
|
||||
/**
|
||||
*
|
||||
* The schema for data to be extracted from the webpage. If you're looking for consistent data schema being returned by the agent, it's highly recommended to use https://json-schema.org/.
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface TaskV2Block {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
export interface TaskV2BlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
prompt: string;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface TextPromptBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
export interface TextPromptBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
llm_key?: string;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface UploadToS3Block {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
export interface UploadToS3BlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
path?: string;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface UrlBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
@@ -25,7 +28,6 @@ export interface UrlBlock {
|
||||
download_suffix?: string;
|
||||
totp_verification_url?: string;
|
||||
totp_identifier?: string;
|
||||
cache_actions?: boolean;
|
||||
complete_verification?: boolean;
|
||||
include_action_history_in_verification?: boolean;
|
||||
download_timeout?: number;
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
export interface UrlBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
url: string;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface ValidationBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
@@ -25,7 +28,6 @@ export interface ValidationBlock {
|
||||
download_suffix?: string;
|
||||
totp_verification_url?: string;
|
||||
totp_identifier?: string;
|
||||
cache_actions?: boolean;
|
||||
complete_verification?: boolean;
|
||||
include_action_history_in_verification?: boolean;
|
||||
download_timeout?: number;
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
export interface ValidationBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
complete_criterion?: string;
|
||||
|
||||
@@ -3,7 +3,10 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface WaitBlock {
|
||||
/** Author-facing identifier for a block; unique within a workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the next block label when constructing a DAG. Defaults to sequential order when omitted. */
|
||||
next_block_label?: string;
|
||||
output_parameter: Skyvern.OutputParameter;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
// This file was auto-generated by Fern from our API Definition.
|
||||
|
||||
export interface WaitBlockYaml {
|
||||
/** Author-facing identifier; must be unique per workflow. */
|
||||
label: string;
|
||||
/** Optional pointer to the label of the next block. When omitted, it will default to sequential order. See [[s-4bnl]]. */
|
||||
next_block_label?: string;
|
||||
continue_on_failure?: boolean;
|
||||
model?: Record<string, unknown>;
|
||||
wait_sec?: number;
|
||||
|
||||
@@ -11,7 +11,7 @@ export interface Workflow {
|
||||
is_saved_task: boolean;
|
||||
description?: string;
|
||||
workflow_definition: Skyvern.WorkflowDefinition;
|
||||
proxy_location?: Skyvern.ProxyLocation;
|
||||
proxy_location?: Workflow.ProxyLocation;
|
||||
webhook_callback_url?: string;
|
||||
totp_verification_url?: string;
|
||||
totp_identifier?: string;
|
||||
@@ -31,3 +31,7 @@ export interface Workflow {
|
||||
modified_at: string;
|
||||
deleted_at?: string;
|
||||
}
|
||||
|
||||
export namespace Workflow {
|
||||
export type ProxyLocation = Skyvern.ProxyLocation | Skyvern.GeoTarget | Record<string, unknown>;
|
||||
}
|
||||
|
||||
@@ -5,7 +5,7 @@ import type * as Skyvern from "../index.js";
|
||||
export interface WorkflowCreateYamlRequest {
|
||||
title: string;
|
||||
description?: string;
|
||||
proxy_location?: Skyvern.ProxyLocation;
|
||||
proxy_location?: WorkflowCreateYamlRequest.ProxyLocation;
|
||||
webhook_callback_url?: string;
|
||||
totp_verification_url?: string;
|
||||
totp_identifier?: string;
|
||||
@@ -23,3 +23,7 @@ export interface WorkflowCreateYamlRequest {
|
||||
sequential_key?: string;
|
||||
folder_id?: string;
|
||||
}
|
||||
|
||||
export namespace WorkflowCreateYamlRequest {
|
||||
export type ProxyLocation = Skyvern.ProxyLocation | Skyvern.GeoTarget | Record<string, unknown>;
|
||||
}
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface WorkflowDefinition {
|
||||
version?: number;
|
||||
parameters: Skyvern.WorkflowDefinitionParametersItem[];
|
||||
blocks: Skyvern.WorkflowDefinitionBlocksItem[];
|
||||
}
|
||||
|
||||
@@ -5,6 +5,7 @@ import type * as Skyvern from "../index.js";
|
||||
export type WorkflowDefinitionBlocksItem =
|
||||
| Skyvern.WorkflowDefinitionBlocksItem.Action
|
||||
| Skyvern.WorkflowDefinitionBlocksItem.Code
|
||||
| Skyvern.WorkflowDefinitionBlocksItem.Conditional
|
||||
| Skyvern.WorkflowDefinitionBlocksItem.DownloadToS3
|
||||
| Skyvern.WorkflowDefinitionBlocksItem.Extraction
|
||||
| Skyvern.WorkflowDefinitionBlocksItem.FileDownload
|
||||
@@ -34,6 +35,10 @@ export namespace WorkflowDefinitionBlocksItem {
|
||||
block_type: "code";
|
||||
}
|
||||
|
||||
export interface Conditional extends Skyvern.ConditionalBlock {
|
||||
block_type: "conditional";
|
||||
}
|
||||
|
||||
export interface DownloadToS3 extends Skyvern.DownloadToS3Block {
|
||||
block_type: "download_to_s3";
|
||||
}
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
import type * as Skyvern from "../index.js";
|
||||
|
||||
export interface WorkflowDefinitionYaml {
|
||||
version?: number;
|
||||
parameters: Skyvern.WorkflowDefinitionYamlParametersItem[];
|
||||
blocks: Skyvern.WorkflowDefinitionYamlBlocksItem[];
|
||||
}
|
||||
|
||||
@@ -32,8 +32,9 @@ export interface WorkflowRunRequest {
|
||||
* - US-FL: Florida
|
||||
* - US-WA: Washington
|
||||
* - NONE: No proxy
|
||||
* Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
|
||||
*/
|
||||
proxy_location?: Skyvern.ProxyLocation;
|
||||
proxy_location?: WorkflowRunRequest.ProxyLocation;
|
||||
/** URL to send workflow status updates to after a run is finished. Refer to https://www.skyvern.com/docs/running-tasks/webhooks-faq for webhook questions. */
|
||||
webhook_url?: string;
|
||||
/**
|
||||
@@ -59,3 +60,33 @@ export interface WorkflowRunRequest {
|
||||
/** Whether to run the workflow with agent or code. */
|
||||
run_with?: string;
|
||||
}
|
||||
|
||||
export namespace WorkflowRunRequest {
|
||||
/**
|
||||
*
|
||||
* Geographic Proxy location to route the browser traffic through. This is only available in Skyvern Cloud.
|
||||
*
|
||||
* Available geotargeting options:
|
||||
* - RESIDENTIAL: the default value. Skyvern Cloud uses a random US residential proxy.
|
||||
* - RESIDENTIAL_ES: Spain
|
||||
* - RESIDENTIAL_IE: Ireland
|
||||
* - RESIDENTIAL_GB: United Kingdom
|
||||
* - RESIDENTIAL_IN: India
|
||||
* - RESIDENTIAL_JP: Japan
|
||||
* - RESIDENTIAL_FR: France
|
||||
* - RESIDENTIAL_DE: Germany
|
||||
* - RESIDENTIAL_NZ: New Zealand
|
||||
* - RESIDENTIAL_ZA: South Africa
|
||||
* - RESIDENTIAL_AR: Argentina
|
||||
* - RESIDENTIAL_AU: Australia
|
||||
* - RESIDENTIAL_ISP: ISP proxy
|
||||
* - US-CA: California
|
||||
* - US-NY: New York
|
||||
* - US-TX: Texas
|
||||
* - US-FL: Florida
|
||||
* - US-WA: Washington
|
||||
* - NONE: No proxy
|
||||
* Can also be a GeoTarget object for granular city/state targeting: {"country": "US", "subdivision": "CA", "city": "San Francisco"}
|
||||
*/
|
||||
export type ProxyLocation = Skyvern.ProxyLocation | Skyvern.GeoTarget | Record<string, unknown>;
|
||||
}
|
||||
|
||||
@@ -19,6 +19,8 @@ export * from "./BitwardenLoginCredentialParameterYaml.js";
|
||||
export * from "./BitwardenSensitiveInformationParameter.js";
|
||||
export * from "./BitwardenSensitiveInformationParameterYaml.js";
|
||||
export * from "./BlockType.js";
|
||||
export * from "./BranchCondition.js";
|
||||
export * from "./BranchCriteria.js";
|
||||
export * from "./BrowserProfile.js";
|
||||
export * from "./BrowserSessionResponse.js";
|
||||
export * from "./ClickAction.js";
|
||||
@@ -26,6 +28,7 @@ export * from "./ClickContext.js";
|
||||
export * from "./CodeBlock.js";
|
||||
export * from "./CodeBlockParametersItem.js";
|
||||
export * from "./CodeBlockYaml.js";
|
||||
export * from "./ConditionalBlock.js";
|
||||
export * from "./ContextParameter.js";
|
||||
export * from "./ContextParameterSource.js";
|
||||
export * from "./ContextParameterYaml.js";
|
||||
@@ -59,6 +62,7 @@ export * from "./ForLoopBlockLoopBlocksItem.js";
|
||||
export * from "./ForLoopBlockLoopOver.js";
|
||||
export * from "./ForLoopBlockYaml.js";
|
||||
export * from "./ForLoopBlockYamlLoopBlocksItem.js";
|
||||
export * from "./GeoTarget.js";
|
||||
export * from "./GetRunResponse.js";
|
||||
export * from "./HttpRequestBlock.js";
|
||||
export * from "./HttpRequestBlockParametersItem.js";
|
||||
@@ -69,6 +73,7 @@ export * from "./HumanInteractionBlockParametersItem.js";
|
||||
export * from "./HumanInteractionBlockYaml.js";
|
||||
export * from "./InputOrSelectContext.js";
|
||||
export * from "./InputTextAction.js";
|
||||
export * from "./LocateElementAction.js";
|
||||
export * from "./LoginBlock.js";
|
||||
export * from "./LoginBlockParametersItem.js";
|
||||
export * from "./LoginBlockYaml.js";
|
||||
|
||||
Reference in New Issue
Block a user