Skip to main content
Home
Browse packagesDocsSign in
This release is 4 versions behind 1.435.2 — the latest version of @windmill/windmill. Jump to latest

@windmill/windmill@1.434.1
Built and signed on GitHub Actions

windmill-labs/windmill

Client for windmill.dev

This package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
This package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
This package works with Browsers
JSR Score
76%
Published
a week ago (1.434.1)
T
$OpenApiTs
No documentation available
T
AcceptInviteData
No documentation available
T
AcceptInviteResponse
No documentation available
T
AcknowledgeAllCriticalAlertsResponse
No documentation available
T
AcknowledgeCriticalAlertData
No documentation available
T
AcknowledgeCriticalAlertResponse
No documentation available
T
AddGranularAclsResponse
No documentation available
T
AddOwnerToFolderData
No documentation available
T
AddOwnerToFolderResponse
No documentation available
T
AddUserData
No documentation available
T
AddUserResponse
No documentation available
T
AddUserToGroupData
No documentation available
T
AddUserToGroupResponse
No documentation available
T
AddUserToInstanceGroupData
No documentation available
T
AddUserToInstanceGroupResponse
No documentation available
c
AdminService
No documentation available
T
AiResource
No documentation available
c
ApiError
No documentation available
T
AppHistory
No documentation available
T
AppWithLastVersionWDraft
No documentation available
T
ArchiveFlowByPathData
No documentation available
T
ArchiveFlowByPathResponse
No documentation available
T
ArchiveScriptByHashData
No documentation available
T
ArchiveScriptByHashResponse
No documentation available
T
ArchiveScriptByPathData
No documentation available
T
ArchiveScriptByPathResponse
No documentation available
T
ArchiveWorkspaceData
No documentation available
T
ArchiveWorkspaceResponse
No documentation available
c
AuditService
No documentation available
T
BackendUptodateResponse
No documentation available
T
BackendVersionResponse
No documentation available
T
Base64
No documentation available
T
BranchAll
No documentation available
T
BranchOne
No documentation available
c
CancelError
No documentation available
T
CancelPersistentQueuedJobsResponse
No documentation available
T
CancelQueuedJobData
No documentation available
T
CancelQueuedJobResponse
No documentation available
T
CancelSelectionData
No documentation available
T
CancelSelectionResponse
No documentation available
T
CancelSuspendedJobGetResponse
No documentation available
T
CancelSuspendedJobPostResponse
No documentation available
T
ChangeWorkspaceIdData
No documentation available
T
ChangeWorkspaceIdResponse
No documentation available
T
ChangeWorkspaceNameData
No documentation available
T
ChangeWorkspaceNameResponse
No documentation available
T
ClearIndexData
No documentation available
T
ClearIndexResponse
No documentation available
T
ConcurrencyGroup
No documentation available
T
Config
No documentation available
T
ConnectCallbackData
No documentation available
T
ConnectCallbackResponse
No documentation available
T
ConnectSlackCallbackData
No documentation available
T
ConnectSlackCallbackInstanceData
No documentation available
T
ConnectSlackCallbackInstanceResponse
No documentation available
T
ConnectSlackCallbackResponse
No documentation available
T
CountCompletedJobsResponse
No documentation available
T
CountJobsByTagData
No documentation available
T
CountJobsByTagResponse
No documentation available
T
CountSearchLogsIndexData
No documentation available
T
CreateAccountData
No documentation available
T
CreateAccountResponse
No documentation available
T
CreateAppData
No documentation available
T
CreateAppResponse
No documentation available
T
CreateCaptureData
No documentation available
T
CreateCaptureResponse
No documentation available
T
CreateCustomerPortalSessionData
No documentation available
T
CreateCustomerPortalSessionResponse
No documentation available
T
CreateDraftData
No documentation available
T
CreateDraftResponse
No documentation available
T
CreateFlowData
No documentation available
T
CreateFlowResponse
No documentation available
T
CreateFolderData
No documentation available
T
CreateFolderResponse
No documentation available
T
CreateGroupData
No documentation available
T
CreateGroupResponse
No documentation available
T
CreateHttpTriggerData
No documentation available
T
CreateHttpTriggerResponse
No documentation available
T
CreateInput
No documentation available
T
CreateInputResponse
No documentation available
T
CreateInstanceGroupData
No documentation available
T
CreateInstanceGroupResponse
No documentation available
T
CreateJobSignatureResponse
No documentation available
T
CreateKafkaTriggerData
No documentation available
T
CreateKafkaTriggerResponse
No documentation available
T
CreateRawAppData
No documentation available
T
CreateRawAppResponse
No documentation available
T
CreateResourceResponse
No documentation available
T
CreateResourceTypeData
No documentation available
T
CreateResourceTypeResponse
No documentation available
T
CreateScheduleData
No documentation available
T
CreateScheduleResponse
No documentation available
T
CreateScriptData
No documentation available
T
CreateScriptResponse
No documentation available
T
CreateTokenData
No documentation available
T
CreateTokenImpersonateData
No documentation available
T
CreateTokenImpersonateResponse
No documentation available
T
CreateTokenResponse
No documentation available
T
CreateUserGloballyData
No documentation available
T
CreateUserGloballyResponse
No documentation available
T
CreateVariableResponse
No documentation available
T
CreateWebsocketTriggerResponse
No documentation available
T
CreateWorkspace
No documentation available
T
CreateWorkspaceData
No documentation available
T
CreateWorkspaceResponse
No documentation available
T
DatasetStorageTestConnectionResponse
No documentation available
T
DeclineInviteData
No documentation available
T
DeclineInviteResponse
No documentation available
T
DeleteAppData
No documentation available
T
DeleteAppResponse
No documentation available
T
DeleteCompletedJobData
No documentation available
T
DeleteCompletedJobResponse
No documentation available
T
DeleteConcurrencyGroupData
No documentation available
T
DeleteConcurrencyGroupResponse
No documentation available
T
DeleteConfigData
No documentation available
T
DeleteConfigResponse
No documentation available
T
DeleteDraftData
No documentation available
T
DeleteDraftResponse
No documentation available
T
DeleteFlowByPathData
No documentation available
T
DeleteFlowByPathResponse
No documentation available
T
DeleteFolderData
No documentation available
T
DeleteFolderResponse
No documentation available
T
DeleteGroupData
No documentation available
T
DeleteGroupResponse
No documentation available
T
DeleteHttpTriggerData
No documentation available
T
DeleteHttpTriggerResponse
No documentation available
T
DeleteInputData
No documentation available
T
DeleteInputResponse
No documentation available
T
DeleteInstanceGroupData
No documentation available
T
DeleteInstanceGroupResponse
No documentation available
T
DeleteInviteData
No documentation available
T
DeleteInviteResponse
No documentation available
T
DeleteKafkaTriggerData
No documentation available
T
DeleteKafkaTriggerResponse
No documentation available
T
DeleteRawAppData
No documentation available
T
DeleteRawAppResponse
No documentation available
T
DeleteResourceData
No documentation available
T
DeleteResourceResponse
No documentation available
T
DeleteResourceTypeData
No documentation available
T
DeleteResourceTypeResponse
No documentation available
T
DeleteS3FileData
No documentation available
T
DeleteS3FileResponse
No documentation available
T
DeleteScheduleData
No documentation available
T
DeleteScheduleResponse
No documentation available
T
DeleteScriptByHashData
No documentation available
T
DeleteScriptByHashResponse
No documentation available
T
DeleteScriptByPathData
No documentation available
T
DeleteScriptByPathResponse
No documentation available
T
DeleteTokenData
No documentation available
T
DeleteTokenResponse
No documentation available
T
DeleteUserData
No documentation available
T
DeleteUserResponse
No documentation available
T
DeleteVariableData
No documentation available
T
DeleteVariableResponse
No documentation available
T
DeleteWebsocketTriggerData
No documentation available
T
DeleteWebsocketTriggerResponse
No documentation available
T
DeleteWorkspaceData
No documentation available
T
DeleteWorkspaceResponse
No documentation available
f
denoS3LightClientSettings
No documentation available
T
DisconnectAccountData
No documentation available
T
DisconnectAccountResponse
No documentation available
T
DisconnectSlackData
No documentation available
T
DisconnectSlackResponse
No documentation available
c
DraftService
No documentation available
T
EditAutoInviteData
No documentation available
T
EditAutoInviteResponse
No documentation available
T
EditCopilotConfigData
No documentation available
T
EditCopilotConfigResponse
No documentation available
T
EditDefaultScriptsData
No documentation available
T
EditDefaultScriptsResponse
No documentation available
T
EditDeployToData
No documentation available
T
EditDeployToResponse
No documentation available
T
EditErrorHandlerData
No documentation available
T
EditErrorHandlerResponse
No documentation available
T
EditLargeFileStorageConfigResponse
No documentation available
T
EditResource
No documentation available
T
EditResourceType
No documentation available
T
EditSlackCommandData
No documentation available
T
EditSlackCommandResponse
No documentation available
T
EditVariable
No documentation available
T
EditWebhookData
No documentation available
T
EditWebhookResponse
No documentation available
T
EditWorkspaceDefaultAppResponse
No documentation available
T
EditWorkspaceDeployUiSettingsResponse
No documentation available
T
EditWorkspaceGitSyncConfigResponse
No documentation available
T
EditWorkspaceUser
No documentation available
T
EncryptValueData
No documentation available
T
EncryptValueResponse
No documentation available
T
ExecuteComponentData
No documentation available
T
ExecuteComponentResponse
No documentation available
T
ExistsAppData
No documentation available
T
ExistsAppResponse
No documentation available
T
ExistsEmailData
No documentation available
T
ExistsEmailResponse
No documentation available
T
ExistsFlowByPathData
No documentation available
T
ExistsFlowByPathResponse
No documentation available
T
ExistsHttpTriggerData
No documentation available
T
ExistsHttpTriggerResponse
No documentation available
T
ExistsKafkaTriggerData
No documentation available
T
ExistsKafkaTriggerResponse
No documentation available
T
ExistsRawAppData
No documentation available
T
ExistsRawAppResponse
No documentation available
T
ExistsResourceData
No documentation available
T
ExistsResourceResponse
No documentation available
T
ExistsResourceTypeData
No documentation available
T
ExistsResourceTypeResponse
No documentation available
T
ExistsRouteData
No documentation available
T
ExistsRouteResponse
No documentation available
T
ExistsScheduleData
No documentation available
T
ExistsScheduleResponse
No documentation available
T
ExistsScriptByPathData
No documentation available
T
ExistsScriptByPathResponse
No documentation available
T
ExistsUsernameData
No documentation available
T
ExistsUsernameResponse
No documentation available
T
ExistsVariableData
No documentation available
T
ExistsVariableResponse
No documentation available
T
ExistsWebsocketTriggerData
No documentation available
T
ExistsWebsocketTriggerResponse
No documentation available
T
ExistsWorkerWithTagData
No documentation available
T
ExistsWorkerWithTagResponse
No documentation available
T
ExistsWorkspaceData
No documentation available
T
ExistsWorkspaceResponse
No documentation available
T
ExportInstanceGroupsResponse
No documentation available
T
ExtraPerms
No documentation available
c
FavoriteService
No documentation available
T
FileDownloadParquetAsCsvResponse
No documentation available
T
FileDownloadResponse
No documentation available
T
FileResourceTypeToFileExtMapData
No documentation available
T
FileResourceTypeToFileExtMapResponse
No documentation available
T
FileUploadResponse
No documentation available
T
Flow
No documentation available
T
FlowModuleValue
No documentation available
T
FlowPreview
No documentation available
T
FlowVersion
No documentation available
T
ForceCancelQueuedJobResponse
No documentation available
T
GeDefaultTagsResponse
No documentation available
T
GetAppByPathData
No documentation available
T
GetAppByPathResponse
No documentation available
T
GetAppByPathWithDraftData
No documentation available
T
GetAppByPathWithDraftResponse
No documentation available
T
GetAppByVersionData
No documentation available
T
GetAppByVersionResponse
No documentation available
T
GetAppHistoryByPathData
No documentation available
T
GetAppHistoryByPathResponse
No documentation available
T
GetAppLatestVersionData
No documentation available
T
GetAppLatestVersionResponse
No documentation available
T
GetArgsFromHistoryOrSavedInputResponse
No documentation available
T
GetAuditLogData
No documentation available
T
GetAuditLogResponse
No documentation available
T
GetCaptureData
No documentation available
T
GetCaptureResponse
No documentation available
T
GetCompletedCountData
No documentation available
T
GetCompletedCountResponse
No documentation available
T
GetCompletedJobData
No documentation available
T
GetCompletedJobResponse
No documentation available
T
GetCompletedJobResultResponse
No documentation available
T
GetConcurrencyKeyData
No documentation available
T
GetConcurrencyKeyResponse
No documentation available
T
GetConfigData
No documentation available
T
GetConfigResponse
No documentation available
T
GetCopilotInfoData
No documentation available
T
GetCountsOfJobsWaitingPerTagResponse
No documentation available
T
GetCriticalAlertsData
No documentation available
T
GetCriticalAlertsResponse
No documentation available
T
GetCurrentEmailResponse
No documentation available
T
GetCustomTagsResponse
No documentation available
T
GetDbClockResponse
No documentation available
T
GetDefaultScriptsData
No documentation available
T
GetDefaultScriptsResponse
No documentation available
T
GetDeployToData
No documentation available
T
GetDeployToResponse
No documentation available
T
GetFlowByPathData
No documentation available
T
GetFlowByPathResponse
No documentation available
T
GetFlowByPathWithDraftData
No documentation available
T
GetFlowByPathWithDraftResponse
No documentation available
T
GetFlowDebugInfoData
No documentation available
T
GetFlowDebugInfoResponse
No documentation available
T
GetFlowHistoryData
No documentation available
T
GetFlowHistoryResponse
No documentation available
T
GetFlowLatestVersionData
No documentation available
T
GetFlowLatestVersionResponse
No documentation available
f
getFlowUserState

Get a flow user state

T
GetFlowUserStateData
No documentation available
T
GetFlowUserStateResponse
No documentation available
T
GetFlowVersionData
No documentation available
T
GetFlowVersionResponse
No documentation available
T
GetFolderData
No documentation available
T
GetFolderResponse
No documentation available
T
GetFolderUsageData
No documentation available
T
GetGlobalData
No documentation available
T
GetGlobalResponse
No documentation available
T
GetGranularAclsData
No documentation available
T
GetGranularAclsResponse
No documentation available
T
GetGroupData
No documentation available
T
GetGroupResponse
No documentation available
T
GetHttpTriggerData
No documentation available
T
GetHttpTriggerResponse
No documentation available
T
GetHubAppByIdData
No documentation available
T
GetHubAppByIdResponse
No documentation available
T
GetHubFlowByIdData
No documentation available
T
GetHubFlowByIdResponse
No documentation available
T
GetHubScriptByPathData
No documentation available
T
GetHubScriptContentByPathData
No documentation available
T
GetHubScriptContentByPathResponse
No documentation available
f
getIdToken

Get an OIDC jwt token for auth to external services (e.g: Vault, AWS) (ee only)

T
GetInputHistoryResponse
No documentation available
T
GetInstanceGroupData
No documentation available
T
GetInstanceGroupResponse
No documentation available
T
GetIsPremiumData
No documentation available
T
GetIsPremiumResponse
No documentation available
T
GetJobArgsData
No documentation available
T
GetJobArgsResponse
No documentation available
T
GetJobData
No documentation available
T
GetJobLogsData
No documentation available
T
GetJobLogsResponse
No documentation available
T
GetJobMetricsData
No documentation available
T
GetJobProgressData
No documentation available
T
GetJobProgressResponse
No documentation available
T
GetJobResponse
No documentation available
T
GetKafkaTriggerData
No documentation available
T
GetKafkaTriggerResponse
No documentation available
T
GetLargeFileStorageConfigData
No documentation available
T
GetLargeFileStorageConfigResponse
No documentation available
T
GetLatestKeyRenewalAttemptResponse
No documentation available
T
GetLicenseIdResponse
No documentation available
T
GetLocalResponse
No documentation available
T
GetLogFileData
No documentation available
T
GetLogFileFromStoreData
No documentation available
T
GetLogFileFromStoreResponse
No documentation available
T
GetLogFileResponse
No documentation available
T
GetOauthConnectData
No documentation available
T
GetOauthConnectResponse
No documentation available
T
GetOidcTokenData
No documentation available
T
GetOidcTokenResponse
No documentation available
T
GetOpenApiYamlResponse
No documentation available
T
GetPremiumInfoData
No documentation available
T
GetPublicAppBySecretData
No documentation available
T
GetPublicAppBySecretResponse
No documentation available
T
GetPublicResourceData
No documentation available
T
GetPublicResourceResponse
No documentation available
T
GetPublicSecretOfAppData
No documentation available
T
GetPublicSecretOfAppResponse
No documentation available
T
GetQueueCountData
No documentation available
T
GetQueueCountResponse
No documentation available
T
GetQueueMetricsResponse
No documentation available
T
GetRawAppDataData
No documentation available
T
GetRawAppDataResponse
No documentation available
f
getResource

Get a resource value by path

T
GetResourceData
No documentation available
T
GetResourceResponse
No documentation available
T
GetResourceTypeData
No documentation available
T
GetResourceTypeResponse
No documentation available
T
GetResourceValueData
No documentation available
T
GetResourceValueInterpolatedResponse
No documentation available
T
GetResourceValueResponse
No documentation available
f
getResumeUrls

Get URLs needed for resuming a flow after this step

T
GetResumeUrlsData
No documentation available
T
GetResumeUrlsResponse
No documentation available
f
getRootJobId

Get the true root job id

T
GetRootJobIdData
No documentation available
T
GetRootJobIdResponse
No documentation available
T
GetScheduleData
No documentation available
T
GetScheduleResponse
No documentation available
T
GetScriptByHashResponse
No documentation available
T
GetScriptByPathResponse
No documentation available
T
GetScriptByPathWithDraftData
No documentation available
T
GetScriptByPathWithDraftResponse
No documentation available
T
GetScriptDeploymentStatusData
No documentation available
T
GetScriptHistoryByPathData
No documentation available
T
GetScriptHistoryByPathResponse
No documentation available
T
GetScriptLatestVersionData
No documentation available
T
GetScriptLatestVersionResponse
No documentation available
T
GetSettingsData
No documentation available
f
getState

Get the state shared across executions

T
GetSuspendedJobFlowResponse
No documentation available
T
GetTopHubScriptsData
No documentation available
T
GetTopHubScriptsResponse
No documentation available
T
GetTriggersCountOfFlowData
No documentation available
T
GetTriggersCountOfFlowResponse
No documentation available
T
GetTriggersCountOfScriptData
No documentation available
T
GetTriggersCountOfScriptResponse
No documentation available
T
GetTutorialProgressResponse
No documentation available
T
GetUsageResponse
No documentation available
T
GetUsedTriggersData
No documentation available
T
GetUserData
No documentation available
T
GetUserResponse
No documentation available
f
getVariable

Get a variable by path

T
GetVariableResponse
No documentation available
T
GetVariableValueData
No documentation available
T
GetVariableValueResponse
No documentation available
T
GetWebsocketTriggerData
No documentation available
T
GetWebsocketTriggerResponse
No documentation available
T
GetWorkspaceDefaultAppData
No documentation available
T
GetWorkspaceEncryptionKeyData
No documentation available
T
GetWorkspaceEncryptionKeyResponse
No documentation available
T
GetWorkspaceNameData
No documentation available
T
GetWorkspaceNameResponse
No documentation available
T
GetWorkspaceUsageData
No documentation available
T
GetWorkspaceUsageResponse
No documentation available
T
GlobalSetting
No documentation available
T
GlobalUserDeleteData
No documentation available
T
GlobalUserDeleteResponse
No documentation available
T
GlobalUsernameInfoData
No documentation available
T
GlobalUserRenameData
No documentation available
T
GlobalUserRenameResponse
No documentation available
T
GlobalUsersExportResponse
No documentation available
T
GlobalUsersOverwriteData
No documentation available
T
GlobalUsersOverwriteResponse
No documentation available
T
GlobalUserUpdateData
No documentation available
T
GlobalUserUpdateResponse
No documentation available
T
GlobalWhoamiResponse
No documentation available
T
Group
No documentation available
T
HubScriptKind
No documentation available
T
Identity
No documentation available
T
InputTransform
No documentation available
T
InstanceGroup
No documentation available
c
IntegrationService
No documentation available
T
InviteUserData
No documentation available
T
InviteUserResponse
No documentation available
T
IsDefaultTagsPerWorkspaceResponse
No documentation available
T
IsDomainAllowedResponse
No documentation available
T
IsOwnerOfPathData
No documentation available
T
IsOwnerOfPathResponse
No documentation available
T
JavascriptTransform
No documentation available
T
Job
No documentation available
T
JobSearchHit
No documentation available
T
LeaveInstanceResponse
No documentation available
T
LeaveWorkspaceData
No documentation available
T
LeaveWorkspaceResponse
No documentation available
T
ListAppsResponse
No documentation available
T
ListAuditLogsResponse
No documentation available
T
ListAutoscalingEventsData
No documentation available
T
ListAutoscalingEventsResponse
No documentation available
T
ListCompletedJobsResponse
No documentation available
T
ListConcurrencyGroupsResponse
No documentation available
T
ListConfigsResponse
No documentation available
T
ListContextualVariablesData
No documentation available
T
ListContextualVariablesResponse
No documentation available
T
ListExtendedJobsResponse
No documentation available
T
ListFilteredUuidsResponse
No documentation available
T
ListFlowPathsData
No documentation available
T
ListFlowPathsResponse
No documentation available
T
ListFlowsResponse
No documentation available
T
ListFolderNamesData
No documentation available
T
ListFolderNamesResponse
No documentation available
T
ListFoldersData
No documentation available
T
ListFoldersResponse
No documentation available
T
ListGlobalSettingsResponse
No documentation available
T
ListGroupNamesData
No documentation available
T
ListGroupNamesResponse
No documentation available
T
ListGroupsData
No documentation available
T
ListGroupsResponse
No documentation available
T
ListHttpTriggersResponse
No documentation available
T
ListHubAppsResponse
No documentation available
T
ListHubFlowsResponse
No documentation available
T
ListHubIntegrationsData
No documentation available
T
ListHubIntegrationsResponse
No documentation available
T
ListInputsResponse
No documentation available
T
ListInstanceGroupsResponse
No documentation available
T
ListJobsResponse
No documentation available
T
ListKafkaTriggersResponse
No documentation available
T
ListLogFilesData
No documentation available
T
ListLogFilesResponse
No documentation available
T
ListOauthConnectsResponse
No documentation available
T
ListOauthLoginsResponse
No documentation available
T
ListPendingInvitesData
No documentation available
T
ListPendingInvitesResponse
No documentation available
T
ListQueueResponse
No documentation available
T
ListRawAppsResponse
No documentation available
T
ListResourceNamesData
No documentation available
T
ListResourceNamesResponse
No documentation available
T
ListResourceResponse
No documentation available
T
ListResourceTypeData
No documentation available
T
ListResourceTypeNamesData
No documentation available
T
ListResourceTypeNamesResponse
No documentation available
T
ListResourceTypeResponse
No documentation available
T
ListSchedulesResponse
No documentation available
T
ListSchedulesWithJobsData
No documentation available
T
ListSchedulesWithJobsResponse
No documentation available
T
ListScriptPathsData
No documentation available
T
ListScriptPathsResponse
No documentation available
T
ListScriptsResponse
No documentation available
T
ListSearchAppData
No documentation available
T
ListSearchAppResponse
No documentation available
T
ListSearchFlowData
No documentation available
T
ListSearchFlowResponse
No documentation available
T
ListSearchResourceData
No documentation available
T
ListSearchResourceResponse
No documentation available
T
ListSearchScriptData
No documentation available
T
ListSearchScriptResponse
No documentation available
T
ListTokensData
No documentation available
T
ListTokensOfFlowData
No documentation available
T
ListTokensOfFlowResponse
No documentation available
T
ListTokensOfScriptData
No documentation available
T
ListTokensOfScriptResponse
No documentation available
T
ListTokensResponse
No documentation available
T
ListUsernamesData
No documentation available
T
ListUsernamesResponse
No documentation available
T
ListUsersAsSuperAdminResponse
No documentation available
T
ListUsersData
No documentation available
T
ListUsersResponse
No documentation available
T
ListUsersUsageData
No documentation available
T
ListUsersUsageResponse
No documentation available
T
ListUserWorkspacesResponse
No documentation available
T
ListVariableData
No documentation available
T
ListVariableResponse
No documentation available
T
ListWebsocketTriggersResponse
No documentation available
T
ListWorkerGroupsResponse
No documentation available
T
ListWorkersData
No documentation available
T
ListWorkersResponse
No documentation available
T
ListWorkspaceInvitesResponse
No documentation available
T
ListWorkspacesAsSuperAdminData
No documentation available
T
ListWorkspacesAsSuperAdminResponse
No documentation available
T
ListWorkspacesResponse
No documentation available
T
LoadCsvPreviewResponse
No documentation available
T
LoadFileMetadataData
No documentation available
T
LoadFileMetadataResponse
No documentation available
T
LoadFilePreviewResponse
No documentation available
T
LoadParquetPreviewResponse
No documentation available
f
loadS3File

Load the content of a file stored in S3. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.

f
loadS3FileStream

Load the content of a file stored in S3 as a stream. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.

T
LoadTableRowCountResponse
No documentation available
T
Login
No documentation available
T
LoginData
No documentation available
T
LoginResponse
No documentation available
T
LoginWithOauthData
No documentation available
T
LoginWithOauthResponse
No documentation available
T
LogoutResponse
No documentation available
T
LogSearchHit
No documentation available
T
MetricDataPoint
No documentation available
T
MetricMetadata
No documentation available
T
MoveS3FileResponse
No documentation available
T
NewScriptWithDraft
No documentation available
T
NewToken
No documentation available
T
ObscuredJob
No documentation available
c
OidcService
No documentation available
T
OpenaiSyncFlowByPathResponse
No documentation available
T
OpenaiSyncScriptByPathResponse
No documentation available
v
OpenAPI
No documentation available
T
OpenFlow
No documentation available
T
OpenFlowWPath
No documentation available
T
OverwriteInstanceGroupsData
No documentation available
T
OverwriteInstanceGroupsResponse
No documentation available
T
ParameterAccountId
No documentation available
T
ParameterActionKind

filter on type of operation

T
ParameterAfter

filter on created after (exclusive) timestamp

T
ParameterArgsFilter

filter on jobs containing those args as a json subset (@> in postgres)

T
ParameterBefore

filter on started before (inclusive) timestamp

T
ParameterCacheTtl

Override the cache time to live (in seconds). Can not be used to disable caching, only override with a new cache ttl

T
ParameterClientName
No documentation available
T
ParameterConcurrencyId
No documentation available
T
ParameterCreatedAfter

filter on created after (exclusive) timestamp

T
ParameterCreatedBefore

filter on created before (inclusive) timestamp

T
ParameterCreatedBy

mask to filter exact matching user creator

T
ParameterCreatedOrStartedAfter

filter on created_at for non non started job and started_at otherwise after (exclusive) timestamp

T
ParameterCreatedOrStartedAfterCompletedJob

filter on created_at for non non started job and started_at otherwise after (exclusive) timestamp but only for the completed jobs

T
ParameterCreatedOrStartedBefore

filter on created_at for non non started job and started_at otherwise before (inclusive) timestamp

T
ParameterGetStarted
No documentation available
T
ParameterIncludeHeader

List of headers's keys (separated with ',') whove value are added to the args Header's key lowercased and '-'' replaced to '_' such that 'Content-Type' becomes the 'content_type' arg key

T
ParameterInputId
No documentation available
T
ParameterJobId
No documentation available
T
ParameterJobKinds

filter on job kind (values 'preview', 'script', 'dependencies', 'flow') separated by,

T
ParameterKey
No documentation available
T
ParameterLabel

mask to filter exact matching job's label (job labels are completed jobs with as a result an object containing a string in the array at key 'wm_labels')

T
ParameterName
No documentation available
T
ParameterNewJobId

The job id to assign to the created job. if missing, job is chosen randomly using the ULID scheme. If a job id already exists in the queue or as a completed job, the request to create one will fail (Bad Request)

T
ParameterOperation

filter on exact or prefix name of operation

T
ParameterOrderDesc

order by desc order (default true)

T
ParameterPage

which page to return (start at 1, default 1)

T
ParameterParentJob

The parent job that is at the origin and responsible for the execution of this script if any

T
ParameterPath
No documentation available
T
ParameterPathId
No documentation available
T
ParameterPathVersion
No documentation available
T
ParameterPayload

The base64 encoded payload that has been encoded as a JSON. e.g how to encode such payload encodeURIComponent encodeURIComponent(btoa(JSON.stringify({a: 2})))

T
ParameterPerPage

number of items to return for a given page (default 30, max 100)

T
ParameterQueueLimit

The maximum size of the queue for which the request would get rejected if that job would push it above that limit

T
ParameterResourceName

filter on exact or prefix name of resource

T
ParameterResultFilter

filter on jobs containing those result as a json subset (@> in postgres)

T
ParameterRunnableId
No documentation available
T
ParameterRunnableTypeQuery
No documentation available
T
ParameterRunning

filter on running jobs

T
ParameterScheduledForBeforeNow

filter on jobs scheduled_for before now (hence waitinf for a worker)

T
ParameterSchedulePath

mask to filter by schedule path

T
ParameterScriptExactHash

mask to filter exact matching path

T
ParameterScriptExactPath

mask to filter exact matching path

T
ParameterScriptHash
No documentation available
T
ParameterScriptPath
No documentation available
T
ParameterScriptStartPath

mask to filter matching starting path

T
ParameterStartedAfter

filter on started after (exclusive) timestamp

T
ParameterStartedBefore

filter on started before (inclusive) timestamp

T
ParameterSuccess

filter on successful jobs

T
ParameterSuspended

filter on suspended jobs

T
ParameterTag

filter on jobs with a given tag/worker group

T
ParameterToken
No documentation available
T
ParameterUsername

filter on exact username of user

T
ParameterVersionId
No documentation available
T
ParameterWorkerTag

Override the tag to use

T
ParameterWorkspaceId
No documentation available
T
PathFlow
No documentation available
T
PolarsClientKwargs
No documentation available
T
PreviewScheduleData
No documentation available
T
PreviewScheduleResponse
No documentation available
T
QueryHubScriptsData
No documentation available
T
QueryHubScriptsResponse
No documentation available
T
QueryResourceTypesData
No documentation available
T
QueryResourceTypesResponse
No documentation available
T
RawScriptByHashData
No documentation available
T
RawScriptByHashResponse
No documentation available
T
RawScriptByPathData
No documentation available
T
RawScriptByPathResponse
No documentation available
T
RawScriptByPathTokenedData
No documentation available
T
RawScriptByPathTokenedResponse
No documentation available
T
RawScriptForDependencies
No documentation available
T
RefreshTokenData
No documentation available
T
RefreshTokenResponse
No documentation available
T
RefreshUserTokenResponse
No documentation available
T
RemoveGranularAclsResponse
No documentation available
T
RemoveOwnerToFolderResponse
No documentation available
T
RemoveUserFromInstanceGroupResponse
No documentation available
T
RemoveUserToGroupData
No documentation available
T
RemoveUserToGroupResponse
No documentation available
T
RenewLicenseKeyData
No documentation available
T
RenewLicenseKeyResponse
No documentation available
T
RestartFlowAtStepResponse
No documentation available
T
ResultByIdData
No documentation available
T
ResultByIdResponse
No documentation available
T
ResumeSuspendedFlowAsOwnerResponse
No documentation available
T
ResumeSuspendedJobGetResponse
No documentation available
T
ResumeSuspendedJobPostResponse
No documentation available
T
Retry
No documentation available
T
RunCodeWorkflowTaskResponse
No documentation available
f
runFlow
No documentation available
f
runFlowAsync
No documentation available
T
RunFlowByPathResponse
No documentation available
T
RunFlowPreviewResponse
No documentation available
T
RunnableType
No documentation available
T
RunRawScriptDependenciesResponse
No documentation available
f
runScript
No documentation available
f
runScriptAsync
No documentation available
T
RunScriptByHashResponse
No documentation available
T
RunScriptByPathResponse
No documentation available
T
RunScriptPreviewResponse
No documentation available
T
RunSlackMessageTestJobResponse
No documentation available
T
RunWaitResultFlowByPathResponse
No documentation available
T
RunWaitResultScriptByPathGetResponse
No documentation available
T
RunWaitResultScriptByPathResponse
No documentation available
T
S3Object
No documentation available
T
S3ResourceInfoData
No documentation available
T
S3ResourceInfoResponse
No documentation available
T
ScalarMetric
No documentation available
T
ScheduleWJobs
No documentation available
T
ScriptArgs
No documentation available
T
ScriptHistory
No documentation available
T
SearchJobsIndexData
No documentation available
T
SearchJobsIndexResponse
No documentation available
T
SearchLogsIndexResponse
No documentation available
T
SendStatsResponse
No documentation available
c
ServiceLogsService
No documentation available
T
SetAutomaticBillingData
No documentation available
T
SetAutomaticBillingResponse
No documentation available
f
setClient
No documentation available
T
SetDefaultErrorOrRecoveryHandlerResponse
No documentation available
T
SetEnvironmentVariableResponse
No documentation available
f
setFlowUserState

Set a flow user state

T
SetFlowUserStateData
No documentation available
T
SetFlowUserStateResponse
No documentation available
T
SetGlobalData
No documentation available
T
SetGlobalResponse
No documentation available
T
SetJobProgressData
No documentation available
T
SetJobProgressResponse
No documentation available
T
SetKafkaTriggerEnabledResponse
No documentation available
T
SetLoginTypeForUserData
No documentation available
T
SetLoginTypeForUserResponse
No documentation available
T
SetPasswordData
No documentation available
T
SetPasswordForUserData
No documentation available
T
SetPasswordForUserResponse
No documentation available
T
SetPasswordResponse
No documentation available
f
setResource

Set a resource value by path

T
SetScheduleEnabledResponse
No documentation available
f
setState

Set the state

f
setVariable

Set a variable by path, create if not exist

T
SetWebsocketTriggerEnabledResponse
No documentation available
T
SetWorkspaceEncryptionKeyResponse
No documentation available
T
SlackToken
No documentation available
T
StarData
No documentation available
T
StarResponse
No documentation available
T
StaticTransform
No documentation available
f
task
No documentation available
T
TestCriticalChannelsData
No documentation available
T
TestCriticalChannelsResponse
No documentation available
T
TestLicenseKeyData
No documentation available
T
TestLicenseKeyResponse
No documentation available
T
TestMetadataData
No documentation available
T
TestMetadataResponse
No documentation available
T
TestObjectStorageConfigData
No documentation available
T
TestObjectStorageConfigResponse
No documentation available
T
TestSmtpData
No documentation available
T
TestSmtpResponse
No documentation available
T
TimeseriesMetric
No documentation available
T
ToggleWorkspaceErrorHandlerForFlowResponse
No documentation available
T
ToggleWorkspaceErrorHandlerForScriptResponse
No documentation available
T
UnarchiveWorkspaceData
No documentation available
T
UnarchiveWorkspaceResponse
No documentation available
T
UnstarData
No documentation available
T
UnstarResponse
No documentation available
T
UpdateAppData
No documentation available
T
UpdateAppHistoryResponse
No documentation available
T
UpdateAppResponse
No documentation available
T
UpdateCaptureData
No documentation available
T
UpdateCaptureResponse
No documentation available
T
UpdateConfigData
No documentation available
T
UpdateConfigResponse
No documentation available
T
UpdateFlowData
No documentation available
T
UpdateFlowHistoryResponse
No documentation available
T
UpdateFlowResponse
No documentation available
T
UpdateFolderData
No documentation available
T
UpdateFolderResponse
No documentation available
T
UpdateGroupData
No documentation available
T
UpdateGroupResponse
No documentation available
T
UpdateHttpTriggerData
No documentation available
T
UpdateHttpTriggerResponse
No documentation available
T
UpdateInput
No documentation available
T
UpdateInputData
No documentation available
T
UpdateInputResponse
No documentation available
T
UpdateInstanceGroupData
No documentation available
T
UpdateInstanceGroupResponse
No documentation available
T
UpdateKafkaTriggerResponse
No documentation available
T
UpdateRawAppData
No documentation available
T
UpdateRawAppResponse
No documentation available
T
UpdateResourceData
No documentation available
T
UpdateResourceResponse
No documentation available
T
UpdateResourceTypeResponse
No documentation available
T
UpdateResourceValueResponse
No documentation available
T
UpdateScheduleData
No documentation available
T
UpdateScheduleResponse
No documentation available
T
UpdateScriptHistoryResponse
No documentation available
T
UpdateTutorialProgressData
No documentation available
T
UpdateTutorialProgressResponse
No documentation available
T
UpdateUserData
No documentation available
T
UpdateUserResponse
No documentation available
T
UpdateVariableResponse
No documentation available
T
UpdateWebsocketTriggerResponse
No documentation available
T
UploadFilePart
No documentation available
f
usernameToEmail

Get email from workspace username This method is particularly useful for apps that require the email address of the viewer. Indeed, in the viewer context, WM_USERNAME is set to the username of the viewer but WM_EMAIL is set to the email of the creator of the app.

T
UsernameToEmailData
No documentation available
T
UsernameToEmailResponse
No documentation available
T
UserUsage
No documentation available
T
UserWorkspaceList
No documentation available
f
waitJob
No documentation available
T
WebsocketTriggerInitialMessage
No documentation available
T
WhoamiData
No documentation available
T
WhoamiResponse
No documentation available
T
WhoisData
No documentation available
T
WhoisResponse
No documentation available
T
WindmillFilePreview
No documentation available
T
WindmillLargeFile
No documentation available
T
WorkflowStatusRecord
No documentation available
T
WorkflowTask
No documentation available
T
Workspace
No documentation available
T
WorkspaceAcknowledgeAllCriticalAlertsResponse
No documentation available
T
WorkspaceAcknowledgeCriticalAlertResponse
No documentation available
T
WorkspaceGetCriticalAlertsResponse
No documentation available
T
WorkspaceMuteCriticalAlertsUiResponse
No documentation available
f
writeS3File

Persist a file to the S3 bucket. If the s3ResourcePath is undefined, it will default to the workspace S3 resource.