windmill-utils-internal 1.3.3 → 1.3.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/config/config.js +16 -113
- package/dist/cjs/gen/core/OpenAPI.js +1 -1
- package/dist/cjs/gen/services.gen.d.ts +336 -92
- package/dist/cjs/gen/services.gen.js +681 -158
- package/dist/cjs/gen/types.gen.d.ts +2095 -301
- package/dist/cjs/inline-scripts/extractor.d.ts +6 -4
- package/dist/cjs/inline-scripts/extractor.js +10 -3
- package/dist/cjs/inline-scripts/replacer.d.ts +28 -1
- package/dist/cjs/inline-scripts/replacer.js +134 -0
- package/dist/cjs/parse/parse-schema.js +4 -0
- package/dist/cjs/path-utils/path-assigner.js +2 -0
- package/dist/esm/config/config.js +13 -77
- package/dist/esm/gen/core/OpenAPI.js +1 -1
- package/dist/esm/gen/services.gen.d.ts +336 -92
- package/dist/esm/gen/services.gen.js +638 -141
- package/dist/esm/gen/types.gen.d.ts +2095 -301
- package/dist/esm/inline-scripts/extractor.d.ts +6 -4
- package/dist/esm/inline-scripts/extractor.js +10 -3
- package/dist/esm/inline-scripts/replacer.d.ts +28 -1
- package/dist/esm/inline-scripts/replacer.js +131 -0
- package/dist/esm/parse/parse-schema.js +4 -0
- package/dist/esm/path-utils/path-assigner.js +2 -0
- package/package.json +2 -2
|
@@ -17,6 +17,10 @@ export type OpenFlow = {
|
|
|
17
17
|
schema?: {
|
|
18
18
|
[key: string]: unknown;
|
|
19
19
|
};
|
|
20
|
+
/**
|
|
21
|
+
* The flow will be run with the permissions of the user with this email.
|
|
22
|
+
*/
|
|
23
|
+
on_behalf_of_email?: string;
|
|
20
24
|
};
|
|
21
25
|
/**
|
|
22
26
|
* The flow structure containing modules and optional preprocessor/failure handlers
|
|
@@ -80,10 +84,10 @@ export type FlowValue = {
|
|
|
80
84
|
cache_ttl?: number;
|
|
81
85
|
cache_ignore_s3_path?: boolean;
|
|
82
86
|
/**
|
|
83
|
-
* Environment variables available to all steps
|
|
87
|
+
* Environment variables available to all steps. Values can be strings, JSON values, or special references: '$var:path' (workspace variable) or '$res:path' (resource).
|
|
84
88
|
*/
|
|
85
89
|
flow_env?: {
|
|
86
|
-
[key: string]:
|
|
90
|
+
[key: string]: unknown;
|
|
87
91
|
};
|
|
88
92
|
/**
|
|
89
93
|
* Execution priority (higher numbers run first)
|
|
@@ -287,10 +291,7 @@ export type FlowModule = {
|
|
|
287
291
|
/**
|
|
288
292
|
* Maps input parameters for a step. Can be a static value or a JavaScript expression that references previous results or flow inputs
|
|
289
293
|
*/
|
|
290
|
-
export type InputTransform = StaticTransform | JavascriptTransform |
|
|
291
|
-
type: 'ai';
|
|
292
|
-
};
|
|
293
|
-
export type type = 'ai';
|
|
294
|
+
export type InputTransform = StaticTransform | JavascriptTransform | AiTransform;
|
|
294
295
|
/**
|
|
295
296
|
* Static value passed directly to the step. Use for hardcoded values or resource references like '$res:path/to/resource'
|
|
296
297
|
*/
|
|
@@ -311,6 +312,56 @@ export type JavascriptTransform = {
|
|
|
311
312
|
expr: string;
|
|
312
313
|
type: 'javascript';
|
|
313
314
|
};
|
|
315
|
+
/**
|
|
316
|
+
* Value resolved by the AI runtime for this input. The AI engine decides how to satisfy the parameter.
|
|
317
|
+
*/
|
|
318
|
+
export type AiTransform = {
|
|
319
|
+
type: 'ai';
|
|
320
|
+
};
|
|
321
|
+
/**
|
|
322
|
+
* Complete AI provider configuration with resource reference and model selection
|
|
323
|
+
*/
|
|
324
|
+
export type ProviderConfig = {
|
|
325
|
+
/**
|
|
326
|
+
* Supported AI provider types
|
|
327
|
+
*/
|
|
328
|
+
kind: 'openai' | 'azure_openai' | 'anthropic' | 'mistral' | 'deepseek' | 'googleai' | 'groq' | 'openrouter' | 'togetherai' | 'customai' | 'aws_bedrock';
|
|
329
|
+
/**
|
|
330
|
+
* Resource reference in format '$res:{resource_path}' pointing to provider credentials
|
|
331
|
+
*/
|
|
332
|
+
resource: string;
|
|
333
|
+
/**
|
|
334
|
+
* Model identifier (e.g., 'gpt-4', 'claude-3-opus-20240229', 'gemini-pro')
|
|
335
|
+
*/
|
|
336
|
+
model: string;
|
|
337
|
+
};
|
|
338
|
+
/**
|
|
339
|
+
* Supported AI provider types
|
|
340
|
+
*/
|
|
341
|
+
export type kind = 'openai' | 'azure_openai' | 'anthropic' | 'mistral' | 'deepseek' | 'googleai' | 'groq' | 'openrouter' | 'togetherai' | 'customai' | 'aws_bedrock';
|
|
342
|
+
/**
|
|
343
|
+
* Conversation memory configuration
|
|
344
|
+
*/
|
|
345
|
+
export type MemoryConfig = {
|
|
346
|
+
kind: 'off';
|
|
347
|
+
} | {
|
|
348
|
+
kind: 'auto';
|
|
349
|
+
/**
|
|
350
|
+
* Maximum number of messages to retain in context
|
|
351
|
+
*/
|
|
352
|
+
context_length?: number;
|
|
353
|
+
/**
|
|
354
|
+
* Identifier for persistent memory across agent invocations
|
|
355
|
+
*/
|
|
356
|
+
memory_id?: string;
|
|
357
|
+
} | {
|
|
358
|
+
kind: 'manual';
|
|
359
|
+
messages: Array<{
|
|
360
|
+
role: 'user' | 'assistant' | 'system';
|
|
361
|
+
content: string;
|
|
362
|
+
}>;
|
|
363
|
+
};
|
|
364
|
+
export type kind2 = 'off';
|
|
314
365
|
/**
|
|
315
366
|
* The actual implementation of a flow step. Can be a script (inline or referenced), subflow, loop, branch, or special module type
|
|
316
367
|
*/
|
|
@@ -332,7 +383,7 @@ export type RawScript = {
|
|
|
332
383
|
/**
|
|
333
384
|
* Programming language for this script
|
|
334
385
|
*/
|
|
335
|
-
language: 'deno' | 'bun' | 'python3' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'oracledb' | 'graphql' | 'nativets' | 'php';
|
|
386
|
+
language: 'deno' | 'bun' | 'python3' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'oracledb' | 'graphql' | 'nativets' | 'php' | 'rust' | 'ansible' | 'csharp' | 'nu' | 'java' | 'ruby' | 'duckdb';
|
|
336
387
|
/**
|
|
337
388
|
* Optional path for saving this script
|
|
338
389
|
*/
|
|
@@ -373,21 +424,21 @@ export type RawScript = {
|
|
|
373
424
|
/**
|
|
374
425
|
* Type of asset
|
|
375
426
|
*/
|
|
376
|
-
kind: 's3object' | 'resource' | 'ducklake' | 'datatable';
|
|
427
|
+
kind: 's3object' | 'resource' | 'ducklake' | 'datatable' | 'volume';
|
|
377
428
|
/**
|
|
378
429
|
* Access level for this asset
|
|
379
430
|
*/
|
|
380
|
-
access_type?: 'r' | 'w' | 'rw';
|
|
431
|
+
access_type?: ('r' | 'w' | 'rw') | null;
|
|
381
432
|
/**
|
|
382
433
|
* Alternative access level
|
|
383
434
|
*/
|
|
384
|
-
alt_access_type?: 'r' | 'w' | 'rw';
|
|
435
|
+
alt_access_type?: ('r' | 'w' | 'rw') | null;
|
|
385
436
|
}>;
|
|
386
437
|
};
|
|
387
438
|
/**
|
|
388
439
|
* Programming language for this script
|
|
389
440
|
*/
|
|
390
|
-
export type language = 'deno' | 'bun' | 'python3' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'oracledb' | 'graphql' | 'nativets' | 'php';
|
|
441
|
+
export type language = 'deno' | 'bun' | 'python3' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'oracledb' | 'graphql' | 'nativets' | 'php' | 'rust' | 'ansible' | 'csharp' | 'nu' | 'java' | 'ruby' | 'duckdb';
|
|
391
442
|
/**
|
|
392
443
|
* Reference to an existing script by path. Use this when calling a previously saved script instead of writing inline code
|
|
393
444
|
*/
|
|
@@ -544,16 +595,69 @@ export type AiAgent = {
|
|
|
544
595
|
* Input parameters for the AI agent mapped to their values
|
|
545
596
|
*/
|
|
546
597
|
input_transforms: {
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
598
|
+
/**
|
|
599
|
+
* Provider configuration - can be static (ProviderConfig), JavaScript expression, or AI-determined
|
|
600
|
+
*/
|
|
601
|
+
provider: ({
|
|
602
|
+
value: ProviderConfig;
|
|
603
|
+
type: 'static';
|
|
604
|
+
} | JavascriptTransform | AiTransform);
|
|
605
|
+
/**
|
|
606
|
+
* Output format type.
|
|
607
|
+
* Valid values: 'text' (default) - plain text response, 'image' - image generation
|
|
608
|
+
*
|
|
609
|
+
*/
|
|
610
|
+
output_type: (InputTransform);
|
|
611
|
+
/**
|
|
612
|
+
* The user's prompt/message to the AI agent. Supports variable interpolation with flow.input syntax.
|
|
613
|
+
*/
|
|
614
|
+
user_message: (InputTransform);
|
|
615
|
+
/**
|
|
616
|
+
* System instructions that guide the AI's behavior, persona, and response style. Optional.
|
|
617
|
+
*/
|
|
618
|
+
system_prompt?: (InputTransform);
|
|
619
|
+
/**
|
|
620
|
+
* Boolean. If true, stream the AI response incrementally.
|
|
621
|
+
* Streaming events include: token_delta, tool_call, tool_call_arguments, tool_execution, tool_result
|
|
622
|
+
*
|
|
623
|
+
*/
|
|
624
|
+
streaming?: (InputTransform);
|
|
625
|
+
/**
|
|
626
|
+
* Memory configuration - can be static (MemoryConfig), JavaScript expression, or AI-determined
|
|
627
|
+
*/
|
|
628
|
+
memory?: ({
|
|
629
|
+
value: MemoryConfig;
|
|
630
|
+
type: 'static';
|
|
631
|
+
} | JavascriptTransform | AiTransform);
|
|
632
|
+
/**
|
|
633
|
+
* JSON Schema object defining structured output format. Used when you need the AI to return data in a specific shape.
|
|
634
|
+
* Supports standard JSON Schema properties: type, properties, required, items, enum, pattern, minLength, maxLength, minimum, maximum, etc.
|
|
635
|
+
* Example: { type: 'object', properties: { name: { type: 'string' }, age: { type: 'integer' } }, required: ['name'] }
|
|
636
|
+
*
|
|
637
|
+
*/
|
|
638
|
+
output_schema?: (InputTransform);
|
|
639
|
+
/**
|
|
640
|
+
* Array of image references for vision-capable models.
|
|
641
|
+
* Format: Array<{ bucket: string, key: string }> - S3 object references
|
|
642
|
+
* Example: [{ bucket: 'my-bucket', key: 'images/photo.jpg' }]
|
|
643
|
+
*
|
|
644
|
+
*/
|
|
645
|
+
user_images?: (InputTransform);
|
|
646
|
+
/**
|
|
647
|
+
* Integer. Maximum number of tokens the AI will generate in its response.
|
|
648
|
+
* Range: 1 to 4,294,967,295. Typical values: 256-4096 for most use cases.
|
|
649
|
+
*
|
|
650
|
+
*/
|
|
651
|
+
max_completion_tokens?: (InputTransform);
|
|
652
|
+
/**
|
|
653
|
+
* Float. Controls randomness/creativity of responses.
|
|
654
|
+
* Range: 0.0 to 2.0 (provider-dependent)
|
|
655
|
+
* - 0.0 = deterministic, focused responses
|
|
656
|
+
* - 0.7 = balanced (common default)
|
|
657
|
+
* - 1.0+ = more creative/random
|
|
658
|
+
*
|
|
659
|
+
*/
|
|
660
|
+
temperature?: (InputTransform);
|
|
557
661
|
};
|
|
558
662
|
/**
|
|
559
663
|
* Array of tools the agent can use. The agent decides which tools to call based on the task
|
|
@@ -596,6 +700,7 @@ export type AiAgent = {
|
|
|
596
700
|
*/
|
|
597
701
|
parallel?: boolean;
|
|
598
702
|
};
|
|
703
|
+
export type type = 'static';
|
|
599
704
|
/**
|
|
600
705
|
* Pass-through module that returns its input unchanged. Useful for flow structure or as a placeholder
|
|
601
706
|
*/
|
|
@@ -733,6 +838,142 @@ export type FlowNote = {
|
|
|
733
838
|
* Type of note - 'free' for standalone notes, 'group' for notes that group other nodes
|
|
734
839
|
*/
|
|
735
840
|
export type type3 = 'free' | 'group';
|
|
841
|
+
/**
|
|
842
|
+
* Health status response (cached with 5s TTL)
|
|
843
|
+
*/
|
|
844
|
+
export type HealthStatusResponse = {
|
|
845
|
+
/**
|
|
846
|
+
* Overall health status
|
|
847
|
+
*/
|
|
848
|
+
status: 'healthy' | 'degraded' | 'unhealthy';
|
|
849
|
+
/**
|
|
850
|
+
* Timestamp when the health check was actually performed (not cache return time)
|
|
851
|
+
*/
|
|
852
|
+
checked_at: string;
|
|
853
|
+
/**
|
|
854
|
+
* Whether the database is reachable
|
|
855
|
+
*/
|
|
856
|
+
database_healthy: boolean;
|
|
857
|
+
/**
|
|
858
|
+
* Number of workers that pinged within last 5 minutes
|
|
859
|
+
*/
|
|
860
|
+
workers_alive: number;
|
|
861
|
+
};
|
|
862
|
+
/**
|
|
863
|
+
* Overall health status
|
|
864
|
+
*/
|
|
865
|
+
export type status = 'healthy' | 'degraded' | 'unhealthy';
|
|
866
|
+
/**
|
|
867
|
+
* Detailed health status response (always fresh, no caching)
|
|
868
|
+
*/
|
|
869
|
+
export type DetailedHealthResponse = {
|
|
870
|
+
/**
|
|
871
|
+
* Overall health status
|
|
872
|
+
*/
|
|
873
|
+
status: 'healthy' | 'degraded' | 'unhealthy';
|
|
874
|
+
/**
|
|
875
|
+
* Timestamp when the health check was performed
|
|
876
|
+
*/
|
|
877
|
+
checked_at: string;
|
|
878
|
+
/**
|
|
879
|
+
* Server version (e.g., "EE 1.615.3")
|
|
880
|
+
*/
|
|
881
|
+
version: string;
|
|
882
|
+
checks: HealthChecks;
|
|
883
|
+
};
|
|
884
|
+
/**
|
|
885
|
+
* Detailed health checks
|
|
886
|
+
*/
|
|
887
|
+
export type HealthChecks = {
|
|
888
|
+
database: DatabaseHealth;
|
|
889
|
+
/**
|
|
890
|
+
* Worker status (null if database is unreachable)
|
|
891
|
+
*/
|
|
892
|
+
workers?: (WorkersHealth) | null;
|
|
893
|
+
/**
|
|
894
|
+
* Queue status (null if database is unreachable)
|
|
895
|
+
*/
|
|
896
|
+
queue?: (QueueHealth) | null;
|
|
897
|
+
readiness: ReadinessHealth;
|
|
898
|
+
};
|
|
899
|
+
/**
|
|
900
|
+
* Database health status
|
|
901
|
+
*/
|
|
902
|
+
export type DatabaseHealth = {
|
|
903
|
+
/**
|
|
904
|
+
* Whether the database is reachable
|
|
905
|
+
*/
|
|
906
|
+
healthy: boolean;
|
|
907
|
+
/**
|
|
908
|
+
* Database query latency in milliseconds
|
|
909
|
+
*/
|
|
910
|
+
latency_ms: number;
|
|
911
|
+
pool: PoolStats;
|
|
912
|
+
};
|
|
913
|
+
/**
|
|
914
|
+
* Database connection pool statistics
|
|
915
|
+
*/
|
|
916
|
+
export type PoolStats = {
|
|
917
|
+
/**
|
|
918
|
+
* Current number of connections in the pool
|
|
919
|
+
*/
|
|
920
|
+
size: number;
|
|
921
|
+
/**
|
|
922
|
+
* Number of idle connections
|
|
923
|
+
*/
|
|
924
|
+
idle: number;
|
|
925
|
+
/**
|
|
926
|
+
* Maximum number of connections allowed
|
|
927
|
+
*/
|
|
928
|
+
max_connections: number;
|
|
929
|
+
};
|
|
930
|
+
/**
|
|
931
|
+
* Workers health status
|
|
932
|
+
*/
|
|
933
|
+
export type WorkersHealth = {
|
|
934
|
+
/**
|
|
935
|
+
* Whether any workers are active
|
|
936
|
+
*/
|
|
937
|
+
healthy: boolean;
|
|
938
|
+
/**
|
|
939
|
+
* Number of active workers (pinged in last 5 minutes)
|
|
940
|
+
*/
|
|
941
|
+
active_count: number;
|
|
942
|
+
/**
|
|
943
|
+
* List of active worker groups
|
|
944
|
+
*/
|
|
945
|
+
worker_groups: Array<(string)>;
|
|
946
|
+
/**
|
|
947
|
+
* Minimum required worker version
|
|
948
|
+
*/
|
|
949
|
+
min_version: string;
|
|
950
|
+
/**
|
|
951
|
+
* List of active worker versions
|
|
952
|
+
*/
|
|
953
|
+
versions: Array<(string)>;
|
|
954
|
+
};
|
|
955
|
+
/**
|
|
956
|
+
* Job queue status
|
|
957
|
+
*/
|
|
958
|
+
export type QueueHealth = {
|
|
959
|
+
/**
|
|
960
|
+
* Number of pending jobs in the queue
|
|
961
|
+
*/
|
|
962
|
+
pending_jobs: number;
|
|
963
|
+
/**
|
|
964
|
+
* Number of currently running jobs
|
|
965
|
+
*/
|
|
966
|
+
running_jobs: number;
|
|
967
|
+
};
|
|
968
|
+
/**
|
|
969
|
+
* Server readiness status
|
|
970
|
+
*/
|
|
971
|
+
export type ReadinessHealth = {
|
|
972
|
+
/**
|
|
973
|
+
* Whether the server is ready to accept requests
|
|
974
|
+
*/
|
|
975
|
+
healthy: boolean;
|
|
976
|
+
};
|
|
736
977
|
/**
|
|
737
978
|
* Configuration for auto-inviting users to the workspace
|
|
738
979
|
*/
|
|
@@ -994,7 +1235,7 @@ export type EndpointTool = {
|
|
|
994
1235
|
} | null;
|
|
995
1236
|
};
|
|
996
1237
|
export type AIProvider = 'openai' | 'azure_openai' | 'anthropic' | 'mistral' | 'deepseek' | 'googleai' | 'groq' | 'openrouter' | 'togetherai' | 'aws_bedrock' | 'customai';
|
|
997
|
-
export type GitSyncObjectType = 'script' | 'flow' | 'app' | 'folder' | 'resource' | 'variable' | 'secret' | 'resourcetype' | 'schedule' | 'user' | 'group' | 'trigger' | 'settings' | 'key';
|
|
1238
|
+
export type GitSyncObjectType = 'script' | 'flow' | 'app' | 'folder' | 'resource' | 'variable' | 'secret' | 'resourcetype' | 'schedule' | 'user' | 'group' | 'trigger' | 'settings' | 'key' | 'workspacedependencies';
|
|
998
1239
|
export type AIProviderModel = {
|
|
999
1240
|
model: string;
|
|
1000
1241
|
provider: AIProvider;
|
|
@@ -1091,17 +1332,23 @@ export type Script = {
|
|
|
1091
1332
|
timeout?: number;
|
|
1092
1333
|
delete_after_use?: boolean;
|
|
1093
1334
|
visible_to_runner_only?: boolean;
|
|
1094
|
-
|
|
1335
|
+
auto_kind?: string;
|
|
1095
1336
|
codebase?: string;
|
|
1096
1337
|
has_preprocessor: boolean;
|
|
1097
1338
|
on_behalf_of_email?: string;
|
|
1339
|
+
/**
|
|
1340
|
+
* Additional script modules keyed by relative file path
|
|
1341
|
+
*/
|
|
1342
|
+
modules?: {
|
|
1343
|
+
[key: string]: ScriptModule;
|
|
1344
|
+
} | null;
|
|
1098
1345
|
};
|
|
1099
|
-
export type
|
|
1346
|
+
export type kind3 = 'script' | 'failure' | 'trigger' | 'command' | 'approval' | 'preprocessor';
|
|
1100
1347
|
export type NewScript = {
|
|
1101
1348
|
path: string;
|
|
1102
1349
|
parent_hash?: string;
|
|
1103
1350
|
summary: string;
|
|
1104
|
-
description
|
|
1351
|
+
description?: string;
|
|
1105
1352
|
content: string;
|
|
1106
1353
|
schema?: {
|
|
1107
1354
|
[key: string]: unknown;
|
|
@@ -1131,16 +1378,26 @@ export type NewScript = {
|
|
|
1131
1378
|
max_total_debouncing_time?: number;
|
|
1132
1379
|
max_total_debounces_amount?: number;
|
|
1133
1380
|
visible_to_runner_only?: boolean;
|
|
1134
|
-
|
|
1381
|
+
auto_kind?: string;
|
|
1135
1382
|
codebase?: string;
|
|
1136
1383
|
has_preprocessor?: boolean;
|
|
1137
1384
|
on_behalf_of_email?: string;
|
|
1385
|
+
/**
|
|
1386
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original on_behalf_of_email value instead of overwriting it.
|
|
1387
|
+
*/
|
|
1388
|
+
preserve_on_behalf_of?: boolean;
|
|
1138
1389
|
assets?: Array<{
|
|
1139
1390
|
path: string;
|
|
1140
1391
|
kind: AssetKind;
|
|
1141
1392
|
access_type?: 'r' | 'w' | 'rw';
|
|
1142
1393
|
alt_access_type?: 'r' | 'w' | 'rw';
|
|
1143
1394
|
}>;
|
|
1395
|
+
/**
|
|
1396
|
+
* Additional script modules keyed by relative file path
|
|
1397
|
+
*/
|
|
1398
|
+
modules?: {
|
|
1399
|
+
[key: string]: ScriptModule;
|
|
1400
|
+
} | null;
|
|
1144
1401
|
};
|
|
1145
1402
|
export type NewScriptWithDraft = NewScript & {
|
|
1146
1403
|
draft?: NewScript;
|
|
@@ -1605,11 +1862,25 @@ export type MainArgSignature = {
|
|
|
1605
1862
|
has_default?: boolean;
|
|
1606
1863
|
default?: unknown;
|
|
1607
1864
|
}>;
|
|
1608
|
-
|
|
1865
|
+
auto_kind: (string) | null;
|
|
1609
1866
|
has_preprocessor: (boolean) | null;
|
|
1610
1867
|
};
|
|
1611
1868
|
export type type5 = 'Valid' | 'Invalid';
|
|
1612
|
-
export type ScriptLang = 'python3' | 'deno' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'oracledb' | 'graphql' | 'nativets' | 'bun' | 'php' | 'rust' | 'ansible' | 'csharp' | 'nu' | 'java' | 'ruby' | 'duckdb';
|
|
1869
|
+
export type ScriptLang = 'python3' | 'deno' | 'go' | 'bash' | 'powershell' | 'postgresql' | 'mysql' | 'bigquery' | 'snowflake' | 'mssql' | 'oracledb' | 'graphql' | 'nativets' | 'bun' | 'php' | 'rust' | 'ansible' | 'csharp' | 'nu' | 'java' | 'ruby' | 'duckdb' | 'bunnative';
|
|
1870
|
+
/**
|
|
1871
|
+
* An additional module file associated with a script
|
|
1872
|
+
*/
|
|
1873
|
+
export type ScriptModule = {
|
|
1874
|
+
/**
|
|
1875
|
+
* The source code content of this module
|
|
1876
|
+
*/
|
|
1877
|
+
content: string;
|
|
1878
|
+
language: ScriptLang;
|
|
1879
|
+
/**
|
|
1880
|
+
* Lock file content for this module's dependencies
|
|
1881
|
+
*/
|
|
1882
|
+
lock?: (string) | null;
|
|
1883
|
+
};
|
|
1613
1884
|
export type Preview = {
|
|
1614
1885
|
/**
|
|
1615
1886
|
* The code to run
|
|
@@ -1629,8 +1900,15 @@ export type Preview = {
|
|
|
1629
1900
|
kind?: 'code' | 'identity' | 'http';
|
|
1630
1901
|
dedicated_worker?: boolean;
|
|
1631
1902
|
lock?: string;
|
|
1903
|
+
flow_path?: string;
|
|
1904
|
+
/**
|
|
1905
|
+
* Additional script modules keyed by relative file path
|
|
1906
|
+
*/
|
|
1907
|
+
modules?: {
|
|
1908
|
+
[key: string]: ScriptModule;
|
|
1909
|
+
} | null;
|
|
1632
1910
|
};
|
|
1633
|
-
export type
|
|
1911
|
+
export type kind4 = 'code' | 'identity' | 'http';
|
|
1634
1912
|
export type PreviewInline = {
|
|
1635
1913
|
/**
|
|
1636
1914
|
* The code to run
|
|
@@ -1639,6 +1917,9 @@ export type PreviewInline = {
|
|
|
1639
1917
|
args: ScriptArgs;
|
|
1640
1918
|
language: ScriptLang;
|
|
1641
1919
|
};
|
|
1920
|
+
export type InlineScriptArgs = {
|
|
1921
|
+
args?: ScriptArgs;
|
|
1922
|
+
};
|
|
1642
1923
|
export type WorkflowTask = {
|
|
1643
1924
|
args: ScriptArgs;
|
|
1644
1925
|
};
|
|
@@ -1720,47 +2001,121 @@ export type ResourceType = {
|
|
|
1720
2001
|
created_by?: string;
|
|
1721
2002
|
edited_at?: string;
|
|
1722
2003
|
format_extension?: string;
|
|
2004
|
+
is_fileset?: boolean;
|
|
1723
2005
|
};
|
|
1724
2006
|
export type EditResourceType = {
|
|
1725
2007
|
schema?: unknown;
|
|
1726
2008
|
description?: string;
|
|
2009
|
+
is_fileset?: boolean;
|
|
1727
2010
|
};
|
|
1728
2011
|
export type Schedule = {
|
|
2012
|
+
/**
|
|
2013
|
+
* The unique path identifier for this schedule
|
|
2014
|
+
*/
|
|
1729
2015
|
path: string;
|
|
2016
|
+
/**
|
|
2017
|
+
* Username of the last person who edited this schedule
|
|
2018
|
+
*/
|
|
1730
2019
|
edited_by: string;
|
|
2020
|
+
/**
|
|
2021
|
+
* Timestamp of the last edit
|
|
2022
|
+
*/
|
|
1731
2023
|
edited_at: string;
|
|
2024
|
+
/**
|
|
2025
|
+
* Cron expression with 6 fields (seconds, minutes, hours, day of month, month, day of week). Example '0 0 12 * * *' for daily at noon
|
|
2026
|
+
*/
|
|
1732
2027
|
schedule: string;
|
|
2028
|
+
/**
|
|
2029
|
+
* IANA timezone for the schedule (e.g., 'UTC', 'Europe/Paris', 'America/New_York')
|
|
2030
|
+
*/
|
|
1733
2031
|
timezone: string;
|
|
2032
|
+
/**
|
|
2033
|
+
* Whether the schedule is currently active and will trigger jobs
|
|
2034
|
+
*/
|
|
1734
2035
|
enabled: boolean;
|
|
2036
|
+
/**
|
|
2037
|
+
* Path to the script or flow to execute when triggered
|
|
2038
|
+
*/
|
|
1735
2039
|
script_path: string;
|
|
2040
|
+
/**
|
|
2041
|
+
* True if script_path points to a flow, false if it points to a script
|
|
2042
|
+
*/
|
|
1736
2043
|
is_flow: boolean;
|
|
1737
|
-
args?: ScriptArgs;
|
|
2044
|
+
args?: (ScriptArgs) | null;
|
|
2045
|
+
/**
|
|
2046
|
+
* Additional permissions for this schedule
|
|
2047
|
+
*/
|
|
1738
2048
|
extra_perms: {
|
|
1739
2049
|
[key: string]: (boolean);
|
|
1740
2050
|
};
|
|
2051
|
+
/**
|
|
2052
|
+
* Email of the user who owns this schedule, used for permissioned_as
|
|
2053
|
+
*/
|
|
1741
2054
|
email: string;
|
|
1742
|
-
|
|
1743
|
-
|
|
1744
|
-
|
|
1745
|
-
|
|
1746
|
-
|
|
1747
|
-
|
|
1748
|
-
|
|
1749
|
-
|
|
1750
|
-
|
|
1751
|
-
|
|
2055
|
+
/**
|
|
2056
|
+
* Last error message if the schedule failed to trigger
|
|
2057
|
+
*/
|
|
2058
|
+
error?: (string) | null;
|
|
2059
|
+
/**
|
|
2060
|
+
* Path to a script or flow to run when the scheduled job fails
|
|
2061
|
+
*/
|
|
2062
|
+
on_failure?: (string) | null;
|
|
2063
|
+
/**
|
|
2064
|
+
* Number of consecutive failures before the on_failure handler is triggered (default 1)
|
|
2065
|
+
*/
|
|
2066
|
+
on_failure_times?: (number) | null;
|
|
2067
|
+
/**
|
|
2068
|
+
* If true, trigger on_failure handler only on exactly N failures, not on every failure after N
|
|
2069
|
+
*/
|
|
2070
|
+
on_failure_exact?: (boolean) | null;
|
|
2071
|
+
on_failure_extra_args?: (ScriptArgs) | null;
|
|
2072
|
+
/**
|
|
2073
|
+
* Path to a script or flow to run when the schedule recovers after failures
|
|
2074
|
+
*/
|
|
2075
|
+
on_recovery?: (string) | null;
|
|
2076
|
+
/**
|
|
2077
|
+
* Number of consecutive successes before the on_recovery handler is triggered (default 1)
|
|
2078
|
+
*/
|
|
2079
|
+
on_recovery_times?: (number) | null;
|
|
2080
|
+
on_recovery_extra_args?: (ScriptArgs) | null;
|
|
2081
|
+
/**
|
|
2082
|
+
* Path to a script or flow to run after each successful execution
|
|
2083
|
+
*/
|
|
2084
|
+
on_success?: (string) | null;
|
|
2085
|
+
on_success_extra_args?: (ScriptArgs) | null;
|
|
2086
|
+
/**
|
|
2087
|
+
* If true, the workspace-level error handler will not be triggered for this schedule's failures
|
|
2088
|
+
*/
|
|
1752
2089
|
ws_error_handler_muted?: boolean;
|
|
1753
|
-
retry?: Retry;
|
|
1754
|
-
|
|
1755
|
-
|
|
2090
|
+
retry?: (Retry) | null;
|
|
2091
|
+
/**
|
|
2092
|
+
* Short summary describing the purpose of this schedule
|
|
2093
|
+
*/
|
|
2094
|
+
summary?: (string) | null;
|
|
2095
|
+
/**
|
|
2096
|
+
* Detailed description of what this schedule does
|
|
2097
|
+
*/
|
|
2098
|
+
description?: (string) | null;
|
|
2099
|
+
/**
|
|
2100
|
+
* If true, skip this schedule's execution if the previous run is still in progress (prevents concurrent runs)
|
|
2101
|
+
*/
|
|
1756
2102
|
no_flow_overlap?: boolean;
|
|
1757
|
-
tag?: string;
|
|
1758
|
-
paused_until?: string;
|
|
1759
|
-
cron_version?: string;
|
|
1760
2103
|
/**
|
|
1761
|
-
*
|
|
2104
|
+
* Worker tag to route jobs to specific worker groups
|
|
1762
2105
|
*/
|
|
1763
|
-
|
|
2106
|
+
tag?: (string) | null;
|
|
2107
|
+
/**
|
|
2108
|
+
* ISO 8601 datetime until which the schedule is paused. Schedule resumes automatically after this time
|
|
2109
|
+
*/
|
|
2110
|
+
paused_until?: (string) | null;
|
|
2111
|
+
/**
|
|
2112
|
+
* Cron parser version. Use 'v2' for extended syntax with additional features
|
|
2113
|
+
*/
|
|
2114
|
+
cron_version?: (string) | null;
|
|
2115
|
+
/**
|
|
2116
|
+
* Path to a script that validates scheduled datetimes. Receives scheduled_for datetime and returns boolean to skip (true) or run (false)
|
|
2117
|
+
*/
|
|
2118
|
+
dynamic_skip?: (string) | null;
|
|
1764
2119
|
};
|
|
1765
2120
|
export type ScheduleWJobs = Schedule & {
|
|
1766
2121
|
jobs?: Array<{
|
|
@@ -1772,211 +2127,224 @@ export type ScheduleWJobs = Schedule & {
|
|
|
1772
2127
|
export type ErrorHandler = 'custom' | 'slack' | 'teams' | 'email';
|
|
1773
2128
|
export type NewSchedule = {
|
|
1774
2129
|
/**
|
|
1775
|
-
* The path
|
|
2130
|
+
* The unique path identifier for this schedule
|
|
1776
2131
|
*/
|
|
1777
2132
|
path: string;
|
|
1778
2133
|
/**
|
|
1779
|
-
*
|
|
2134
|
+
* Cron expression with 6 fields (seconds, minutes, hours, day of month, month, day of week). Example '0 0 12 * * *' for daily at noon
|
|
1780
2135
|
*/
|
|
1781
2136
|
schedule: string;
|
|
1782
2137
|
/**
|
|
1783
|
-
*
|
|
2138
|
+
* IANA timezone for the schedule (e.g., 'UTC', 'Europe/Paris', 'America/New_York')
|
|
1784
2139
|
*/
|
|
1785
2140
|
timezone: string;
|
|
1786
2141
|
/**
|
|
1787
|
-
*
|
|
2142
|
+
* Path to the script or flow to execute when triggered
|
|
1788
2143
|
*/
|
|
1789
2144
|
script_path: string;
|
|
1790
2145
|
/**
|
|
1791
|
-
*
|
|
2146
|
+
* True if script_path points to a flow, false if it points to a script
|
|
1792
2147
|
*/
|
|
1793
2148
|
is_flow: boolean;
|
|
2149
|
+
args: (ScriptArgs) | null;
|
|
1794
2150
|
/**
|
|
1795
|
-
*
|
|
1796
|
-
*/
|
|
1797
|
-
args: ScriptArgs;
|
|
1798
|
-
/**
|
|
1799
|
-
* Whether the schedule is enabled
|
|
2151
|
+
* Whether the schedule is currently active and will trigger jobs
|
|
1800
2152
|
*/
|
|
1801
2153
|
enabled?: boolean;
|
|
1802
2154
|
/**
|
|
1803
|
-
*
|
|
1804
|
-
*/
|
|
1805
|
-
on_failure?: string;
|
|
1806
|
-
/**
|
|
1807
|
-
* The number of times to retry on failure
|
|
1808
|
-
*/
|
|
1809
|
-
on_failure_times?: number;
|
|
1810
|
-
/**
|
|
1811
|
-
* Whether the schedule should only run on the exact time
|
|
2155
|
+
* Path to a script or flow to run when the scheduled job fails
|
|
1812
2156
|
*/
|
|
1813
|
-
|
|
2157
|
+
on_failure?: (string) | null;
|
|
1814
2158
|
/**
|
|
1815
|
-
*
|
|
2159
|
+
* Number of consecutive failures before the on_failure handler is triggered (default 1)
|
|
1816
2160
|
*/
|
|
1817
|
-
|
|
2161
|
+
on_failure_times?: (number) | null;
|
|
1818
2162
|
/**
|
|
1819
|
-
*
|
|
2163
|
+
* If true, trigger on_failure handler only on exactly N failures, not on every failure after N
|
|
1820
2164
|
*/
|
|
1821
|
-
|
|
2165
|
+
on_failure_exact?: (boolean) | null;
|
|
2166
|
+
on_failure_extra_args?: (ScriptArgs) | null;
|
|
1822
2167
|
/**
|
|
1823
|
-
*
|
|
2168
|
+
* Path to a script or flow to run when the schedule recovers after failures
|
|
1824
2169
|
*/
|
|
1825
|
-
|
|
2170
|
+
on_recovery?: (string) | null;
|
|
1826
2171
|
/**
|
|
1827
|
-
*
|
|
2172
|
+
* Number of consecutive successes before the on_recovery handler is triggered (default 1)
|
|
1828
2173
|
*/
|
|
1829
|
-
|
|
2174
|
+
on_recovery_times?: (number) | null;
|
|
2175
|
+
on_recovery_extra_args?: (ScriptArgs) | null;
|
|
1830
2176
|
/**
|
|
1831
|
-
*
|
|
2177
|
+
* Path to a script or flow to run after each successful execution
|
|
1832
2178
|
*/
|
|
1833
|
-
on_success?: string;
|
|
2179
|
+
on_success?: (string) | null;
|
|
2180
|
+
on_success_extra_args?: (ScriptArgs) | null;
|
|
1834
2181
|
/**
|
|
1835
|
-
*
|
|
2182
|
+
* If true, the workspace-level error handler will not be triggered for this schedule's failures
|
|
1836
2183
|
*/
|
|
1837
|
-
|
|
2184
|
+
ws_error_handler_muted?: boolean;
|
|
2185
|
+
retry?: (Retry) | null;
|
|
1838
2186
|
/**
|
|
1839
|
-
*
|
|
2187
|
+
* If true, skip this schedule's execution if the previous run is still in progress (prevents concurrent runs)
|
|
1840
2188
|
*/
|
|
1841
|
-
|
|
2189
|
+
no_flow_overlap?: boolean;
|
|
1842
2190
|
/**
|
|
1843
|
-
*
|
|
2191
|
+
* Short summary describing the purpose of this schedule
|
|
1844
2192
|
*/
|
|
1845
|
-
|
|
2193
|
+
summary?: (string) | null;
|
|
1846
2194
|
/**
|
|
1847
|
-
*
|
|
2195
|
+
* Detailed description of what this schedule does
|
|
1848
2196
|
*/
|
|
1849
|
-
|
|
2197
|
+
description?: (string) | null;
|
|
1850
2198
|
/**
|
|
1851
|
-
*
|
|
2199
|
+
* Worker tag to route jobs to specific worker groups
|
|
1852
2200
|
*/
|
|
1853
|
-
|
|
2201
|
+
tag?: (string) | null;
|
|
1854
2202
|
/**
|
|
1855
|
-
*
|
|
2203
|
+
* ISO 8601 datetime until which the schedule is paused. Schedule resumes automatically after this time
|
|
1856
2204
|
*/
|
|
1857
|
-
|
|
2205
|
+
paused_until?: (string) | null;
|
|
1858
2206
|
/**
|
|
1859
|
-
*
|
|
2207
|
+
* Cron parser version. Use 'v2' for extended syntax with additional features
|
|
1860
2208
|
*/
|
|
1861
|
-
|
|
2209
|
+
cron_version?: (string) | null;
|
|
1862
2210
|
/**
|
|
1863
|
-
*
|
|
2211
|
+
* Path to a script that validates scheduled datetimes. Receives scheduled_for datetime and returns boolean to skip (true) or run (false)
|
|
1864
2212
|
*/
|
|
1865
|
-
|
|
2213
|
+
dynamic_skip?: (string) | null;
|
|
1866
2214
|
/**
|
|
1867
|
-
*
|
|
2215
|
+
* Email of the user who the scheduled jobs run as. Used during deployment to preserve the original schedule owner.
|
|
1868
2216
|
*/
|
|
1869
|
-
|
|
2217
|
+
email?: string;
|
|
1870
2218
|
/**
|
|
1871
|
-
*
|
|
2219
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
1872
2220
|
*/
|
|
1873
|
-
|
|
2221
|
+
preserve_email?: boolean;
|
|
1874
2222
|
};
|
|
1875
2223
|
export type EditSchedule = {
|
|
1876
2224
|
/**
|
|
1877
|
-
*
|
|
2225
|
+
* Cron expression with 6 fields (seconds, minutes, hours, day of month, month, day of week). Example '0 0 12 * * *' for daily at noon
|
|
1878
2226
|
*/
|
|
1879
2227
|
schedule: string;
|
|
1880
2228
|
/**
|
|
1881
|
-
*
|
|
2229
|
+
* IANA timezone for the schedule (e.g., 'UTC', 'Europe/Paris', 'America/New_York')
|
|
1882
2230
|
*/
|
|
1883
2231
|
timezone: string;
|
|
2232
|
+
args: (ScriptArgs) | null;
|
|
1884
2233
|
/**
|
|
1885
|
-
*
|
|
1886
|
-
*/
|
|
1887
|
-
args: ScriptArgs;
|
|
1888
|
-
/**
|
|
1889
|
-
* The path to the script or flow to trigger on failure
|
|
1890
|
-
*/
|
|
1891
|
-
on_failure?: string;
|
|
1892
|
-
/**
|
|
1893
|
-
* The number of times to retry on failure
|
|
2234
|
+
* Path to a script or flow to run when the scheduled job fails
|
|
1894
2235
|
*/
|
|
1895
|
-
|
|
2236
|
+
on_failure?: (string) | null;
|
|
1896
2237
|
/**
|
|
1897
|
-
*
|
|
2238
|
+
* Number of consecutive failures before the on_failure handler is triggered (default 1)
|
|
1898
2239
|
*/
|
|
1899
|
-
|
|
2240
|
+
on_failure_times?: (number) | null;
|
|
1900
2241
|
/**
|
|
1901
|
-
*
|
|
2242
|
+
* If true, trigger on_failure handler only on exactly N failures, not on every failure after N
|
|
1902
2243
|
*/
|
|
1903
|
-
|
|
2244
|
+
on_failure_exact?: (boolean) | null;
|
|
2245
|
+
on_failure_extra_args?: (ScriptArgs) | null;
|
|
1904
2246
|
/**
|
|
1905
|
-
*
|
|
2247
|
+
* Path to a script or flow to run when the schedule recovers after failures
|
|
1906
2248
|
*/
|
|
1907
|
-
on_recovery?: string;
|
|
2249
|
+
on_recovery?: (string) | null;
|
|
1908
2250
|
/**
|
|
1909
|
-
*
|
|
2251
|
+
* Number of consecutive successes before the on_recovery handler is triggered (default 1)
|
|
1910
2252
|
*/
|
|
1911
|
-
on_recovery_times?: number;
|
|
2253
|
+
on_recovery_times?: (number) | null;
|
|
2254
|
+
on_recovery_extra_args?: (ScriptArgs) | null;
|
|
1912
2255
|
/**
|
|
1913
|
-
*
|
|
2256
|
+
* Path to a script or flow to run after each successful execution
|
|
1914
2257
|
*/
|
|
1915
|
-
|
|
2258
|
+
on_success?: (string) | null;
|
|
2259
|
+
on_success_extra_args?: (ScriptArgs) | null;
|
|
1916
2260
|
/**
|
|
1917
|
-
*
|
|
2261
|
+
* If true, the workspace-level error handler will not be triggered for this schedule's failures
|
|
1918
2262
|
*/
|
|
1919
|
-
|
|
1920
|
-
|
|
1921
|
-
* The arguments to pass to the script or flow on success
|
|
1922
|
-
*/
|
|
1923
|
-
on_success_extra_args?: ScriptArgs;
|
|
2263
|
+
ws_error_handler_muted?: boolean;
|
|
2264
|
+
retry?: (Retry) | null;
|
|
1924
2265
|
/**
|
|
1925
|
-
*
|
|
2266
|
+
* If true, skip this schedule's execution if the previous run is still in progress (prevents concurrent runs)
|
|
1926
2267
|
*/
|
|
1927
|
-
|
|
2268
|
+
no_flow_overlap?: boolean;
|
|
1928
2269
|
/**
|
|
1929
|
-
*
|
|
2270
|
+
* Short summary describing the purpose of this schedule
|
|
1930
2271
|
*/
|
|
1931
|
-
|
|
2272
|
+
summary?: (string) | null;
|
|
1932
2273
|
/**
|
|
1933
|
-
*
|
|
2274
|
+
* Detailed description of what this schedule does
|
|
1934
2275
|
*/
|
|
1935
|
-
|
|
2276
|
+
description?: (string) | null;
|
|
1936
2277
|
/**
|
|
1937
|
-
*
|
|
2278
|
+
* Worker tag to route jobs to specific worker groups
|
|
1938
2279
|
*/
|
|
1939
|
-
|
|
2280
|
+
tag?: (string) | null;
|
|
1940
2281
|
/**
|
|
1941
|
-
*
|
|
2282
|
+
* ISO 8601 datetime until which the schedule is paused. Schedule resumes automatically after this time
|
|
1942
2283
|
*/
|
|
1943
|
-
|
|
2284
|
+
paused_until?: (string) | null;
|
|
1944
2285
|
/**
|
|
1945
|
-
*
|
|
2286
|
+
* Cron parser version. Use 'v2' for extended syntax with additional features
|
|
1946
2287
|
*/
|
|
1947
|
-
|
|
2288
|
+
cron_version?: (string) | null;
|
|
1948
2289
|
/**
|
|
1949
|
-
*
|
|
2290
|
+
* Path to a script that validates scheduled datetimes. Receives scheduled_for datetime and returns boolean to skip (true) or run (false)
|
|
1950
2291
|
*/
|
|
1951
|
-
|
|
2292
|
+
dynamic_skip?: (string) | null;
|
|
1952
2293
|
/**
|
|
1953
|
-
*
|
|
2294
|
+
* Email of the user who the scheduled jobs run as. Used during deployment to preserve the original schedule owner.
|
|
1954
2295
|
*/
|
|
1955
|
-
|
|
2296
|
+
email?: string;
|
|
1956
2297
|
/**
|
|
1957
|
-
*
|
|
2298
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
1958
2299
|
*/
|
|
1959
|
-
|
|
2300
|
+
preserve_email?: boolean;
|
|
1960
2301
|
};
|
|
1961
2302
|
/**
|
|
1962
2303
|
* job trigger kind (schedule, http, websocket...)
|
|
1963
2304
|
*/
|
|
1964
|
-
export type JobTriggerKind = 'webhook' | 'default_email' | 'email' | 'schedule' | 'http' | 'websocket' | 'postgres' | 'kafka' | 'nats' | 'mqtt' | 'sqs' | 'gcp';
|
|
2305
|
+
export type JobTriggerKind = 'webhook' | 'default_email' | 'email' | 'schedule' | 'http' | 'websocket' | 'postgres' | 'kafka' | 'nats' | 'mqtt' | 'sqs' | 'gcp' | 'google';
|
|
1965
2306
|
/**
|
|
1966
2307
|
* job trigger mode
|
|
1967
2308
|
*/
|
|
1968
2309
|
export type TriggerMode = 'enabled' | 'disabled' | 'suspended';
|
|
1969
2310
|
export type TriggerExtraProperty = {
|
|
2311
|
+
/**
|
|
2312
|
+
* The unique path identifier for this trigger
|
|
2313
|
+
*/
|
|
1970
2314
|
path: string;
|
|
2315
|
+
/**
|
|
2316
|
+
* Path to the script or flow to execute when triggered
|
|
2317
|
+
*/
|
|
1971
2318
|
script_path: string;
|
|
2319
|
+
/**
|
|
2320
|
+
* Email of the user who owns this trigger, used for permissioned_as
|
|
2321
|
+
*/
|
|
1972
2322
|
email: string;
|
|
2323
|
+
/**
|
|
2324
|
+
* Additional permissions for this trigger
|
|
2325
|
+
*/
|
|
1973
2326
|
extra_perms: {
|
|
1974
2327
|
[key: string]: (boolean);
|
|
1975
2328
|
};
|
|
2329
|
+
/**
|
|
2330
|
+
* The workspace this trigger belongs to
|
|
2331
|
+
*/
|
|
1976
2332
|
workspace_id: string;
|
|
2333
|
+
/**
|
|
2334
|
+
* Username of the last person who edited this trigger
|
|
2335
|
+
*/
|
|
1977
2336
|
edited_by: string;
|
|
2337
|
+
/**
|
|
2338
|
+
* Timestamp of the last edit
|
|
2339
|
+
*/
|
|
1978
2340
|
edited_at: string;
|
|
1979
|
-
|
|
2341
|
+
/**
|
|
2342
|
+
* True if script_path points to a flow, false if it points to a script
|
|
2343
|
+
*/
|
|
2344
|
+
is_flow: boolean;
|
|
2345
|
+
/**
|
|
2346
|
+
* Trigger mode (enabled/disabled)
|
|
2347
|
+
*/
|
|
1980
2348
|
mode: TriggerMode;
|
|
1981
2349
|
};
|
|
1982
2350
|
export type AuthenticationMethod = 'none' | 'windmill' | 'api_key' | 'basic_http' | 'custom_script' | 'signature';
|
|
@@ -2020,82 +2388,278 @@ export type GenerateOpenapiSpec = {
|
|
|
2020
2388
|
export type HttpMethod = 'get' | 'post' | 'put' | 'delete' | 'patch';
|
|
2021
2389
|
export type HttpRequestType = 'sync' | 'async' | 'sync_sse';
|
|
2022
2390
|
export type HttpTrigger = TriggerExtraProperty & {
|
|
2391
|
+
/**
|
|
2392
|
+
* The URL route path that will trigger this endpoint (e.g., 'api/myendpoint'). Must NOT start with a /.
|
|
2393
|
+
*/
|
|
2023
2394
|
route_path: string;
|
|
2395
|
+
/**
|
|
2396
|
+
* Configuration for serving static assets (s3 bucket, storage path, filename)
|
|
2397
|
+
*/
|
|
2024
2398
|
static_asset_config?: {
|
|
2399
|
+
/**
|
|
2400
|
+
* S3 bucket path for static assets
|
|
2401
|
+
*/
|
|
2025
2402
|
s3: string;
|
|
2403
|
+
/**
|
|
2404
|
+
* Storage path for static assets
|
|
2405
|
+
*/
|
|
2026
2406
|
storage?: string;
|
|
2407
|
+
/**
|
|
2408
|
+
* Filename for the static asset
|
|
2409
|
+
*/
|
|
2027
2410
|
filename?: string;
|
|
2028
|
-
};
|
|
2411
|
+
} | null;
|
|
2412
|
+
/**
|
|
2413
|
+
* HTTP method (get, post, put, delete, patch) that triggers this endpoint
|
|
2414
|
+
*/
|
|
2029
2415
|
http_method: HttpMethod;
|
|
2030
|
-
|
|
2031
|
-
|
|
2032
|
-
|
|
2416
|
+
/**
|
|
2417
|
+
* Path to the resource containing authentication configuration (for api_key, basic_http, custom_script, signature methods)
|
|
2418
|
+
*/
|
|
2419
|
+
authentication_resource_path?: (string) | null;
|
|
2420
|
+
/**
|
|
2421
|
+
* Short summary describing the purpose of this trigger
|
|
2422
|
+
*/
|
|
2423
|
+
summary?: (string) | null;
|
|
2424
|
+
/**
|
|
2425
|
+
* Detailed description of what this trigger does
|
|
2426
|
+
*/
|
|
2427
|
+
description?: (string) | null;
|
|
2428
|
+
/**
|
|
2429
|
+
* How the request is handled - 'sync' waits for result, 'async' returns job ID immediately, 'sync_sse' streams results via Server-Sent Events
|
|
2430
|
+
*/
|
|
2033
2431
|
request_type: HttpRequestType;
|
|
2432
|
+
/**
|
|
2433
|
+
* How requests are authenticated - 'none' (public), 'windmill' (Windmill token), 'api_key', 'basic_http', 'custom_script', 'signature'
|
|
2434
|
+
*/
|
|
2034
2435
|
authentication_method: AuthenticationMethod;
|
|
2436
|
+
/**
|
|
2437
|
+
* If true, serves static files from S3/storage instead of running a script
|
|
2438
|
+
*/
|
|
2035
2439
|
is_static_website: boolean;
|
|
2440
|
+
/**
|
|
2441
|
+
* If true, the route includes the workspace ID in the path
|
|
2442
|
+
*/
|
|
2036
2443
|
workspaced_route: boolean;
|
|
2444
|
+
/**
|
|
2445
|
+
* If true, wraps the request body in a 'body' parameter
|
|
2446
|
+
*/
|
|
2037
2447
|
wrap_body: boolean;
|
|
2448
|
+
/**
|
|
2449
|
+
* If true, passes the request body as a raw string instead of parsing as JSON
|
|
2450
|
+
*/
|
|
2038
2451
|
raw_string: boolean;
|
|
2452
|
+
/**
|
|
2453
|
+
* Path to a script or flow to run when the triggered job fails
|
|
2454
|
+
*/
|
|
2039
2455
|
error_handler_path?: string;
|
|
2456
|
+
/**
|
|
2457
|
+
* Arguments to pass to the error handler
|
|
2458
|
+
*/
|
|
2040
2459
|
error_handler_args?: ScriptArgs;
|
|
2460
|
+
/**
|
|
2461
|
+
* Retry configuration for failed executions
|
|
2462
|
+
*/
|
|
2041
2463
|
retry?: Retry;
|
|
2042
2464
|
};
|
|
2043
2465
|
export type NewHttpTrigger = {
|
|
2466
|
+
/**
|
|
2467
|
+
* The unique path identifier for this trigger
|
|
2468
|
+
*/
|
|
2044
2469
|
path: string;
|
|
2470
|
+
/**
|
|
2471
|
+
* Path to the script or flow to execute when triggered
|
|
2472
|
+
*/
|
|
2045
2473
|
script_path: string;
|
|
2474
|
+
/**
|
|
2475
|
+
* The URL route path that will trigger this endpoint (e.g., 'api/myendpoint'). Must NOT start with a /.
|
|
2476
|
+
*/
|
|
2046
2477
|
route_path: string;
|
|
2478
|
+
/**
|
|
2479
|
+
* If true, the route includes the workspace ID in the path
|
|
2480
|
+
*/
|
|
2047
2481
|
workspaced_route?: boolean;
|
|
2048
|
-
|
|
2049
|
-
|
|
2482
|
+
/**
|
|
2483
|
+
* Short summary describing the purpose of this trigger
|
|
2484
|
+
*/
|
|
2485
|
+
summary?: (string) | null;
|
|
2486
|
+
/**
|
|
2487
|
+
* Detailed description of what this trigger does
|
|
2488
|
+
*/
|
|
2489
|
+
description?: (string) | null;
|
|
2490
|
+
/**
|
|
2491
|
+
* Configuration for serving static assets (s3 bucket, storage path, filename)
|
|
2492
|
+
*/
|
|
2050
2493
|
static_asset_config?: {
|
|
2494
|
+
/**
|
|
2495
|
+
* S3 bucket path for static assets
|
|
2496
|
+
*/
|
|
2051
2497
|
s3: string;
|
|
2498
|
+
/**
|
|
2499
|
+
* Storage path for static assets
|
|
2500
|
+
*/
|
|
2052
2501
|
storage?: string;
|
|
2502
|
+
/**
|
|
2503
|
+
* Filename for the static asset
|
|
2504
|
+
*/
|
|
2053
2505
|
filename?: string;
|
|
2054
|
-
};
|
|
2506
|
+
} | null;
|
|
2507
|
+
/**
|
|
2508
|
+
* True if script_path points to a flow, false if it points to a script
|
|
2509
|
+
*/
|
|
2055
2510
|
is_flow: boolean;
|
|
2511
|
+
/**
|
|
2512
|
+
* HTTP method (get, post, put, delete, patch) that triggers this endpoint
|
|
2513
|
+
*/
|
|
2056
2514
|
http_method: HttpMethod;
|
|
2057
|
-
|
|
2515
|
+
/**
|
|
2516
|
+
* Path to the resource containing authentication configuration (for api_key, basic_http, custom_script, signature methods)
|
|
2517
|
+
*/
|
|
2518
|
+
authentication_resource_path?: (string) | null;
|
|
2058
2519
|
/**
|
|
2059
2520
|
* Deprecated, use request_type instead
|
|
2060
2521
|
*/
|
|
2061
2522
|
is_async?: boolean;
|
|
2523
|
+
/**
|
|
2524
|
+
* How the request is handled - 'sync' waits for result, 'async' returns job ID immediately, 'sync_sse' streams results via Server-Sent Events
|
|
2525
|
+
*/
|
|
2062
2526
|
request_type?: HttpRequestType;
|
|
2527
|
+
/**
|
|
2528
|
+
* How requests are authenticated - 'none' (public), 'windmill' (Windmill token), 'api_key', 'basic_http', 'custom_script', 'signature'
|
|
2529
|
+
*/
|
|
2063
2530
|
authentication_method: AuthenticationMethod;
|
|
2531
|
+
/**
|
|
2532
|
+
* If true, serves static files from S3/storage instead of running a script
|
|
2533
|
+
*/
|
|
2064
2534
|
is_static_website: boolean;
|
|
2535
|
+
/**
|
|
2536
|
+
* If true, wraps the request body in a 'body' parameter
|
|
2537
|
+
*/
|
|
2065
2538
|
wrap_body?: boolean;
|
|
2066
2539
|
mode?: TriggerMode;
|
|
2540
|
+
/**
|
|
2541
|
+
* If true, passes the request body as a raw string instead of parsing as JSON
|
|
2542
|
+
*/
|
|
2067
2543
|
raw_string?: boolean;
|
|
2544
|
+
/**
|
|
2545
|
+
* Path to a script or flow to run when the triggered job fails
|
|
2546
|
+
*/
|
|
2068
2547
|
error_handler_path?: string;
|
|
2548
|
+
/**
|
|
2549
|
+
* Arguments to pass to the error handler
|
|
2550
|
+
*/
|
|
2069
2551
|
error_handler_args?: ScriptArgs;
|
|
2552
|
+
/**
|
|
2553
|
+
* Retry configuration for failed executions
|
|
2554
|
+
*/
|
|
2070
2555
|
retry?: Retry;
|
|
2556
|
+
/**
|
|
2557
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
2558
|
+
*/
|
|
2559
|
+
email?: string;
|
|
2560
|
+
/**
|
|
2561
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
2562
|
+
*/
|
|
2563
|
+
preserve_email?: boolean;
|
|
2071
2564
|
};
|
|
2072
2565
|
export type EditHttpTrigger = {
|
|
2566
|
+
/**
|
|
2567
|
+
* The unique path identifier for this trigger
|
|
2568
|
+
*/
|
|
2073
2569
|
path: string;
|
|
2570
|
+
/**
|
|
2571
|
+
* Path to the script or flow to execute when triggered
|
|
2572
|
+
*/
|
|
2074
2573
|
script_path: string;
|
|
2574
|
+
/**
|
|
2575
|
+
* The URL route path that will trigger this endpoint (e.g., 'api/myendpoint'). Must NOT start with a /.
|
|
2576
|
+
*/
|
|
2075
2577
|
route_path?: string;
|
|
2076
|
-
|
|
2077
|
-
|
|
2578
|
+
/**
|
|
2579
|
+
* Short summary describing the purpose of this trigger
|
|
2580
|
+
*/
|
|
2581
|
+
summary?: (string) | null;
|
|
2582
|
+
/**
|
|
2583
|
+
* Detailed description of what this trigger does
|
|
2584
|
+
*/
|
|
2585
|
+
description?: (string) | null;
|
|
2586
|
+
/**
|
|
2587
|
+
* If true, the route includes the workspace ID in the path
|
|
2588
|
+
*/
|
|
2078
2589
|
workspaced_route?: boolean;
|
|
2590
|
+
/**
|
|
2591
|
+
* Configuration for serving static assets (s3 bucket, storage path, filename)
|
|
2592
|
+
*/
|
|
2079
2593
|
static_asset_config?: {
|
|
2594
|
+
/**
|
|
2595
|
+
* S3 bucket path for static assets
|
|
2596
|
+
*/
|
|
2080
2597
|
s3: string;
|
|
2598
|
+
/**
|
|
2599
|
+
* Storage path for static assets
|
|
2600
|
+
*/
|
|
2081
2601
|
storage?: string;
|
|
2602
|
+
/**
|
|
2603
|
+
* Filename for the static asset
|
|
2604
|
+
*/
|
|
2082
2605
|
filename?: string;
|
|
2083
|
-
};
|
|
2084
|
-
|
|
2606
|
+
} | null;
|
|
2607
|
+
/**
|
|
2608
|
+
* Path to the resource containing authentication configuration (for api_key, basic_http, custom_script, signature methods)
|
|
2609
|
+
*/
|
|
2610
|
+
authentication_resource_path?: (string) | null;
|
|
2611
|
+
/**
|
|
2612
|
+
* True if script_path points to a flow, false if it points to a script
|
|
2613
|
+
*/
|
|
2085
2614
|
is_flow: boolean;
|
|
2615
|
+
/**
|
|
2616
|
+
* HTTP method (get, post, put, delete, patch) that triggers this endpoint
|
|
2617
|
+
*/
|
|
2086
2618
|
http_method: HttpMethod;
|
|
2087
2619
|
/**
|
|
2088
2620
|
* Deprecated, use request_type instead
|
|
2089
2621
|
*/
|
|
2090
2622
|
is_async?: boolean;
|
|
2623
|
+
/**
|
|
2624
|
+
* How the request is handled - 'sync' waits for result, 'async' returns job ID immediately, 'sync_sse' streams results via Server-Sent Events
|
|
2625
|
+
*/
|
|
2091
2626
|
request_type?: HttpRequestType;
|
|
2627
|
+
/**
|
|
2628
|
+
* How requests are authenticated - 'none' (public), 'windmill' (Windmill token), 'api_key', 'basic_http', 'custom_script', 'signature'
|
|
2629
|
+
*/
|
|
2092
2630
|
authentication_method: AuthenticationMethod;
|
|
2631
|
+
/**
|
|
2632
|
+
* If true, serves static files from S3/storage instead of running a script
|
|
2633
|
+
*/
|
|
2093
2634
|
is_static_website: boolean;
|
|
2635
|
+
/**
|
|
2636
|
+
* If true, wraps the request body in a 'body' parameter
|
|
2637
|
+
*/
|
|
2094
2638
|
wrap_body?: boolean;
|
|
2639
|
+
/**
|
|
2640
|
+
* If true, passes the request body as a raw string instead of parsing as JSON
|
|
2641
|
+
*/
|
|
2095
2642
|
raw_string?: boolean;
|
|
2643
|
+
/**
|
|
2644
|
+
* Path to a script or flow to run when the triggered job fails
|
|
2645
|
+
*/
|
|
2096
2646
|
error_handler_path?: string;
|
|
2647
|
+
/**
|
|
2648
|
+
* Arguments to pass to the error handler
|
|
2649
|
+
*/
|
|
2097
2650
|
error_handler_args?: ScriptArgs;
|
|
2651
|
+
/**
|
|
2652
|
+
* Retry configuration for failed executions
|
|
2653
|
+
*/
|
|
2098
2654
|
retry?: Retry;
|
|
2655
|
+
/**
|
|
2656
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
2657
|
+
*/
|
|
2658
|
+
email?: string;
|
|
2659
|
+
/**
|
|
2660
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
2661
|
+
*/
|
|
2662
|
+
preserve_email?: boolean;
|
|
2099
2663
|
};
|
|
2100
2664
|
export type TriggersCount = {
|
|
2101
2665
|
primary_schedule?: {
|
|
@@ -2114,58 +2678,183 @@ export type TriggersCount = {
|
|
|
2114
2678
|
gcp_count?: number;
|
|
2115
2679
|
sqs_count?: number;
|
|
2116
2680
|
nextcloud_count?: number;
|
|
2681
|
+
google_count?: number;
|
|
2117
2682
|
};
|
|
2118
2683
|
export type WebsocketTrigger = TriggerExtraProperty & {
|
|
2684
|
+
/**
|
|
2685
|
+
* The WebSocket URL to connect to (can be a static URL or computed by a runnable)
|
|
2686
|
+
*/
|
|
2119
2687
|
url: string;
|
|
2688
|
+
/**
|
|
2689
|
+
* ID of the server currently handling this trigger (internal)
|
|
2690
|
+
*/
|
|
2120
2691
|
server_id?: string;
|
|
2692
|
+
/**
|
|
2693
|
+
* Timestamp of last server heartbeat (internal)
|
|
2694
|
+
*/
|
|
2121
2695
|
last_server_ping?: string;
|
|
2696
|
+
/**
|
|
2697
|
+
* Last error message if the trigger failed
|
|
2698
|
+
*/
|
|
2122
2699
|
error?: string;
|
|
2700
|
+
/**
|
|
2701
|
+
* Array of key-value filters to match incoming messages (only matching messages trigger the script)
|
|
2702
|
+
*/
|
|
2123
2703
|
filters: Array<{
|
|
2124
2704
|
key: string;
|
|
2125
2705
|
value: unknown;
|
|
2126
2706
|
}>;
|
|
2127
|
-
|
|
2128
|
-
|
|
2707
|
+
/**
|
|
2708
|
+
* Messages to send immediately after connecting (can be raw strings or computed by runnables)
|
|
2709
|
+
*/
|
|
2710
|
+
initial_messages?: Array<WebsocketTriggerInitialMessage> | null;
|
|
2711
|
+
/**
|
|
2712
|
+
* Arguments to pass to the script/flow that computes the WebSocket URL
|
|
2713
|
+
*/
|
|
2714
|
+
url_runnable_args?: (ScriptArgs) | null;
|
|
2715
|
+
/**
|
|
2716
|
+
* If true, the script can return a message to send back through the WebSocket
|
|
2717
|
+
*/
|
|
2129
2718
|
can_return_message: boolean;
|
|
2719
|
+
/**
|
|
2720
|
+
* If true, error results are sent back through the WebSocket
|
|
2721
|
+
*/
|
|
2130
2722
|
can_return_error_result: boolean;
|
|
2723
|
+
/**
|
|
2724
|
+
* Path to a script or flow to run when the triggered job fails
|
|
2725
|
+
*/
|
|
2131
2726
|
error_handler_path?: string;
|
|
2727
|
+
/**
|
|
2728
|
+
* Arguments to pass to the error handler
|
|
2729
|
+
*/
|
|
2132
2730
|
error_handler_args?: ScriptArgs;
|
|
2731
|
+
/**
|
|
2732
|
+
* Retry configuration for failed executions
|
|
2733
|
+
*/
|
|
2133
2734
|
retry?: Retry;
|
|
2134
2735
|
};
|
|
2135
2736
|
export type NewWebsocketTrigger = {
|
|
2737
|
+
/**
|
|
2738
|
+
* The unique path identifier for this trigger
|
|
2739
|
+
*/
|
|
2136
2740
|
path: string;
|
|
2741
|
+
/**
|
|
2742
|
+
* Path to the script or flow to execute when a message is received
|
|
2743
|
+
*/
|
|
2137
2744
|
script_path: string;
|
|
2745
|
+
/**
|
|
2746
|
+
* True if script_path points to a flow, false if it points to a script
|
|
2747
|
+
*/
|
|
2138
2748
|
is_flow: boolean;
|
|
2749
|
+
/**
|
|
2750
|
+
* The WebSocket URL to connect to (can be a static URL or computed by a runnable)
|
|
2751
|
+
*/
|
|
2139
2752
|
url: string;
|
|
2140
2753
|
mode?: TriggerMode;
|
|
2754
|
+
/**
|
|
2755
|
+
* Array of key-value filters to match incoming messages (only matching messages trigger the script)
|
|
2756
|
+
*/
|
|
2141
2757
|
filters: Array<{
|
|
2142
2758
|
key: string;
|
|
2143
2759
|
value: unknown;
|
|
2144
2760
|
}>;
|
|
2145
|
-
|
|
2146
|
-
|
|
2761
|
+
/**
|
|
2762
|
+
* Messages to send immediately after connecting (can be raw strings or computed by runnables)
|
|
2763
|
+
*/
|
|
2764
|
+
initial_messages?: Array<WebsocketTriggerInitialMessage> | null;
|
|
2765
|
+
/**
|
|
2766
|
+
* Arguments to pass to the script/flow that computes the WebSocket URL
|
|
2767
|
+
*/
|
|
2768
|
+
url_runnable_args?: (ScriptArgs) | null;
|
|
2769
|
+
/**
|
|
2770
|
+
* If true, the script can return a message to send back through the WebSocket
|
|
2771
|
+
*/
|
|
2147
2772
|
can_return_message: boolean;
|
|
2773
|
+
/**
|
|
2774
|
+
* If true, error results are sent back through the WebSocket
|
|
2775
|
+
*/
|
|
2148
2776
|
can_return_error_result: boolean;
|
|
2777
|
+
/**
|
|
2778
|
+
* Path to a script or flow to run when the triggered job fails
|
|
2779
|
+
*/
|
|
2149
2780
|
error_handler_path?: string;
|
|
2781
|
+
/**
|
|
2782
|
+
* Arguments to pass to the error handler
|
|
2783
|
+
*/
|
|
2150
2784
|
error_handler_args?: ScriptArgs;
|
|
2785
|
+
/**
|
|
2786
|
+
* Retry configuration for failed executions
|
|
2787
|
+
*/
|
|
2151
2788
|
retry?: Retry;
|
|
2789
|
+
/**
|
|
2790
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
2791
|
+
*/
|
|
2792
|
+
email?: string;
|
|
2793
|
+
/**
|
|
2794
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
2795
|
+
*/
|
|
2796
|
+
preserve_email?: boolean;
|
|
2152
2797
|
};
|
|
2153
2798
|
export type EditWebsocketTrigger = {
|
|
2799
|
+
/**
|
|
2800
|
+
* The WebSocket URL to connect to (can be a static URL or computed by a runnable)
|
|
2801
|
+
*/
|
|
2154
2802
|
url: string;
|
|
2803
|
+
/**
|
|
2804
|
+
* The unique path identifier for this trigger
|
|
2805
|
+
*/
|
|
2155
2806
|
path: string;
|
|
2807
|
+
/**
|
|
2808
|
+
* Path to the script or flow to execute when a message is received
|
|
2809
|
+
*/
|
|
2156
2810
|
script_path: string;
|
|
2811
|
+
/**
|
|
2812
|
+
* True if script_path points to a flow, false if it points to a script
|
|
2813
|
+
*/
|
|
2157
2814
|
is_flow: boolean;
|
|
2815
|
+
/**
|
|
2816
|
+
* Array of key-value filters to match incoming messages (only matching messages trigger the script)
|
|
2817
|
+
*/
|
|
2158
2818
|
filters: Array<{
|
|
2159
2819
|
key: string;
|
|
2160
2820
|
value: unknown;
|
|
2161
2821
|
}>;
|
|
2162
|
-
|
|
2163
|
-
|
|
2822
|
+
/**
|
|
2823
|
+
* Messages to send immediately after connecting (can be raw strings or computed by runnables)
|
|
2824
|
+
*/
|
|
2825
|
+
initial_messages?: Array<WebsocketTriggerInitialMessage> | null;
|
|
2826
|
+
/**
|
|
2827
|
+
* Arguments to pass to the script/flow that computes the WebSocket URL
|
|
2828
|
+
*/
|
|
2829
|
+
url_runnable_args?: (ScriptArgs) | null;
|
|
2830
|
+
/**
|
|
2831
|
+
* If true, the script can return a message to send back through the WebSocket
|
|
2832
|
+
*/
|
|
2164
2833
|
can_return_message: boolean;
|
|
2834
|
+
/**
|
|
2835
|
+
* If true, error results are sent back through the WebSocket
|
|
2836
|
+
*/
|
|
2165
2837
|
can_return_error_result: boolean;
|
|
2838
|
+
/**
|
|
2839
|
+
* Path to a script or flow to run when the triggered job fails
|
|
2840
|
+
*/
|
|
2166
2841
|
error_handler_path?: string;
|
|
2842
|
+
/**
|
|
2843
|
+
* Arguments to pass to the error handler
|
|
2844
|
+
*/
|
|
2167
2845
|
error_handler_args?: ScriptArgs;
|
|
2846
|
+
/**
|
|
2847
|
+
* Retry configuration for failed executions
|
|
2848
|
+
*/
|
|
2168
2849
|
retry?: Retry;
|
|
2850
|
+
/**
|
|
2851
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
2852
|
+
*/
|
|
2853
|
+
email?: string;
|
|
2854
|
+
/**
|
|
2855
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
2856
|
+
*/
|
|
2857
|
+
preserve_email?: boolean;
|
|
2169
2858
|
};
|
|
2170
2859
|
export type WebsocketTriggerInitialMessage = {
|
|
2171
2860
|
raw_message: string;
|
|
@@ -2191,92 +2880,302 @@ export type MqttSubscribeTopic = {
|
|
|
2191
2880
|
};
|
|
2192
2881
|
export type MqttClientVersion = 'v3' | 'v5';
|
|
2193
2882
|
export type MqttTrigger = TriggerExtraProperty & {
|
|
2883
|
+
/**
|
|
2884
|
+
* Path to the MQTT resource containing broker connection configuration
|
|
2885
|
+
*/
|
|
2194
2886
|
mqtt_resource_path: string;
|
|
2887
|
+
/**
|
|
2888
|
+
* Array of MQTT topics to subscribe to, each with topic name and QoS level
|
|
2889
|
+
*/
|
|
2195
2890
|
subscribe_topics: Array<MqttSubscribeTopic>;
|
|
2196
|
-
|
|
2197
|
-
|
|
2198
|
-
|
|
2199
|
-
|
|
2891
|
+
/**
|
|
2892
|
+
* MQTT v3 specific configuration (clean_session)
|
|
2893
|
+
*/
|
|
2894
|
+
v3_config?: (MqttV3Config) | null;
|
|
2895
|
+
/**
|
|
2896
|
+
* MQTT v5 specific configuration (clean_start, topic_alias_maximum, session_expiry_interval)
|
|
2897
|
+
*/
|
|
2898
|
+
v5_config?: (MqttV5Config) | null;
|
|
2899
|
+
/**
|
|
2900
|
+
* MQTT client ID for this connection
|
|
2901
|
+
*/
|
|
2902
|
+
client_id?: (string) | null;
|
|
2903
|
+
/**
|
|
2904
|
+
* MQTT protocol version ('v3' or 'v5')
|
|
2905
|
+
*/
|
|
2906
|
+
client_version?: (MqttClientVersion) | null;
|
|
2907
|
+
/**
|
|
2908
|
+
* ID of the server currently handling this trigger (internal)
|
|
2909
|
+
*/
|
|
2200
2910
|
server_id?: string;
|
|
2911
|
+
/**
|
|
2912
|
+
* Timestamp of last server heartbeat (internal)
|
|
2913
|
+
*/
|
|
2201
2914
|
last_server_ping?: string;
|
|
2915
|
+
/**
|
|
2916
|
+
* Last error message if the trigger failed
|
|
2917
|
+
*/
|
|
2202
2918
|
error?: string;
|
|
2919
|
+
/**
|
|
2920
|
+
* Path to a script or flow to run when the triggered job fails
|
|
2921
|
+
*/
|
|
2203
2922
|
error_handler_path?: string;
|
|
2923
|
+
/**
|
|
2924
|
+
* Arguments to pass to the error handler
|
|
2925
|
+
*/
|
|
2204
2926
|
error_handler_args?: ScriptArgs;
|
|
2927
|
+
/**
|
|
2928
|
+
* Retry configuration for failed executions
|
|
2929
|
+
*/
|
|
2205
2930
|
retry?: Retry;
|
|
2206
2931
|
};
|
|
2207
2932
|
export type NewMqttTrigger = {
|
|
2933
|
+
/**
|
|
2934
|
+
* Path to the MQTT resource containing broker connection configuration
|
|
2935
|
+
*/
|
|
2208
2936
|
mqtt_resource_path: string;
|
|
2937
|
+
/**
|
|
2938
|
+
* Array of MQTT topics to subscribe to, each with topic name and QoS level
|
|
2939
|
+
*/
|
|
2209
2940
|
subscribe_topics: Array<MqttSubscribeTopic>;
|
|
2210
|
-
|
|
2211
|
-
|
|
2212
|
-
|
|
2213
|
-
|
|
2941
|
+
/**
|
|
2942
|
+
* MQTT client ID for this connection
|
|
2943
|
+
*/
|
|
2944
|
+
client_id?: (string) | null;
|
|
2945
|
+
/**
|
|
2946
|
+
* MQTT v3 specific configuration (clean_session)
|
|
2947
|
+
*/
|
|
2948
|
+
v3_config?: (MqttV3Config) | null;
|
|
2949
|
+
/**
|
|
2950
|
+
* MQTT v5 specific configuration (clean_start, topic_alias_maximum, session_expiry_interval)
|
|
2951
|
+
*/
|
|
2952
|
+
v5_config?: (MqttV5Config) | null;
|
|
2953
|
+
/**
|
|
2954
|
+
* MQTT protocol version ('v3' or 'v5')
|
|
2955
|
+
*/
|
|
2956
|
+
client_version?: (MqttClientVersion) | null;
|
|
2957
|
+
/**
|
|
2958
|
+
* The unique path identifier for this trigger
|
|
2959
|
+
*/
|
|
2214
2960
|
path: string;
|
|
2961
|
+
/**
|
|
2962
|
+
* Path to the script or flow to execute when a message is received
|
|
2963
|
+
*/
|
|
2215
2964
|
script_path: string;
|
|
2965
|
+
/**
|
|
2966
|
+
* True if script_path points to a flow, false if it points to a script
|
|
2967
|
+
*/
|
|
2216
2968
|
is_flow: boolean;
|
|
2217
2969
|
mode?: TriggerMode;
|
|
2970
|
+
/**
|
|
2971
|
+
* Path to a script or flow to run when the triggered job fails
|
|
2972
|
+
*/
|
|
2218
2973
|
error_handler_path?: string;
|
|
2974
|
+
/**
|
|
2975
|
+
* Arguments to pass to the error handler
|
|
2976
|
+
*/
|
|
2219
2977
|
error_handler_args?: ScriptArgs;
|
|
2978
|
+
/**
|
|
2979
|
+
* Retry configuration for failed executions
|
|
2980
|
+
*/
|
|
2220
2981
|
retry?: Retry;
|
|
2982
|
+
/**
|
|
2983
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
2984
|
+
*/
|
|
2985
|
+
email?: string;
|
|
2986
|
+
/**
|
|
2987
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
2988
|
+
*/
|
|
2989
|
+
preserve_email?: boolean;
|
|
2221
2990
|
};
|
|
2222
2991
|
export type EditMqttTrigger = {
|
|
2992
|
+
/**
|
|
2993
|
+
* Path to the MQTT resource containing broker connection configuration
|
|
2994
|
+
*/
|
|
2223
2995
|
mqtt_resource_path: string;
|
|
2996
|
+
/**
|
|
2997
|
+
* Array of MQTT topics to subscribe to, each with topic name and QoS level
|
|
2998
|
+
*/
|
|
2224
2999
|
subscribe_topics: Array<MqttSubscribeTopic>;
|
|
2225
|
-
|
|
2226
|
-
|
|
2227
|
-
|
|
2228
|
-
|
|
3000
|
+
/**
|
|
3001
|
+
* MQTT client ID for this connection
|
|
3002
|
+
*/
|
|
3003
|
+
client_id?: (string) | null;
|
|
3004
|
+
/**
|
|
3005
|
+
* MQTT v3 specific configuration (clean_session)
|
|
3006
|
+
*/
|
|
3007
|
+
v3_config?: (MqttV3Config) | null;
|
|
3008
|
+
/**
|
|
3009
|
+
* MQTT v5 specific configuration (clean_start, topic_alias_maximum, session_expiry_interval)
|
|
3010
|
+
*/
|
|
3011
|
+
v5_config?: (MqttV5Config) | null;
|
|
3012
|
+
/**
|
|
3013
|
+
* MQTT protocol version ('v3' or 'v5')
|
|
3014
|
+
*/
|
|
3015
|
+
client_version?: (MqttClientVersion) | null;
|
|
3016
|
+
/**
|
|
3017
|
+
* The unique path identifier for this trigger
|
|
3018
|
+
*/
|
|
2229
3019
|
path: string;
|
|
3020
|
+
/**
|
|
3021
|
+
* Path to the script or flow to execute when a message is received
|
|
3022
|
+
*/
|
|
2230
3023
|
script_path: string;
|
|
3024
|
+
/**
|
|
3025
|
+
* True if script_path points to a flow, false if it points to a script
|
|
3026
|
+
*/
|
|
2231
3027
|
is_flow: boolean;
|
|
2232
3028
|
mode?: TriggerMode;
|
|
3029
|
+
/**
|
|
3030
|
+
* Path to a script or flow to run when the triggered job fails
|
|
3031
|
+
*/
|
|
2233
3032
|
error_handler_path?: string;
|
|
3033
|
+
/**
|
|
3034
|
+
* Arguments to pass to the error handler
|
|
3035
|
+
*/
|
|
2234
3036
|
error_handler_args?: ScriptArgs;
|
|
3037
|
+
/**
|
|
3038
|
+
* Retry configuration for failed executions
|
|
3039
|
+
*/
|
|
2235
3040
|
retry?: Retry;
|
|
3041
|
+
/**
|
|
3042
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
3043
|
+
*/
|
|
3044
|
+
email?: string;
|
|
3045
|
+
/**
|
|
3046
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
3047
|
+
*/
|
|
3048
|
+
preserve_email?: boolean;
|
|
2236
3049
|
};
|
|
3050
|
+
/**
|
|
3051
|
+
* Delivery mode for messages. 'push' for HTTP push delivery where messages are sent to a webhook endpoint, 'pull' for polling where the trigger actively fetches messages.
|
|
3052
|
+
*/
|
|
2237
3053
|
export type DeliveryType = 'push' | 'pull';
|
|
3054
|
+
/**
|
|
3055
|
+
* Configuration for push delivery mode.
|
|
3056
|
+
*/
|
|
2238
3057
|
export type PushConfig = {
|
|
3058
|
+
/**
|
|
3059
|
+
* The audience claim for OIDC tokens used in push authentication.
|
|
3060
|
+
*/
|
|
2239
3061
|
audience?: string;
|
|
3062
|
+
/**
|
|
3063
|
+
* If true, push messages will include OIDC authentication tokens.
|
|
3064
|
+
*/
|
|
2240
3065
|
authenticate: boolean;
|
|
2241
3066
|
};
|
|
3067
|
+
/**
|
|
3068
|
+
* A Google Cloud Pub/Sub trigger that executes a script or flow when messages are received.
|
|
3069
|
+
*/
|
|
2242
3070
|
export type GcpTrigger = TriggerExtraProperty & {
|
|
3071
|
+
/**
|
|
3072
|
+
* Path to the GCP resource containing service account credentials for authentication.
|
|
3073
|
+
*/
|
|
2243
3074
|
gcp_resource_path: string;
|
|
3075
|
+
/**
|
|
3076
|
+
* Google Cloud Pub/Sub topic ID to subscribe to.
|
|
3077
|
+
*/
|
|
2244
3078
|
topic_id: string;
|
|
3079
|
+
/**
|
|
3080
|
+
* Google Cloud Pub/Sub subscription ID.
|
|
3081
|
+
*/
|
|
2245
3082
|
subscription_id: string;
|
|
3083
|
+
/**
|
|
3084
|
+
* ID of the server currently handling this trigger (internal use).
|
|
3085
|
+
*/
|
|
2246
3086
|
server_id?: string;
|
|
2247
3087
|
delivery_type: DeliveryType;
|
|
2248
|
-
delivery_config?: PushConfig;
|
|
3088
|
+
delivery_config?: (PushConfig) | null;
|
|
2249
3089
|
subscription_mode: SubscriptionMode;
|
|
3090
|
+
/**
|
|
3091
|
+
* Timestamp of last server heartbeat (internal use).
|
|
3092
|
+
*/
|
|
2250
3093
|
last_server_ping?: string;
|
|
3094
|
+
/**
|
|
3095
|
+
* Last error message if the trigger failed.
|
|
3096
|
+
*/
|
|
2251
3097
|
error?: string;
|
|
3098
|
+
/**
|
|
3099
|
+
* Path to a script or flow to run when the triggered job fails.
|
|
3100
|
+
*/
|
|
2252
3101
|
error_handler_path?: string;
|
|
3102
|
+
/**
|
|
3103
|
+
* Arguments to pass to the error handler.
|
|
3104
|
+
*/
|
|
2253
3105
|
error_handler_args?: ScriptArgs;
|
|
3106
|
+
/**
|
|
3107
|
+
* Retry configuration for failed executions.
|
|
3108
|
+
*/
|
|
2254
3109
|
retry?: Retry;
|
|
2255
3110
|
};
|
|
2256
3111
|
/**
|
|
2257
3112
|
* The mode of subscription. 'existing' means using an existing GCP subscription, while 'create_update' involves creating or updating a new subscription.
|
|
2258
3113
|
*/
|
|
2259
3114
|
export type SubscriptionMode = 'existing' | 'create_update';
|
|
3115
|
+
/**
|
|
3116
|
+
* Data for creating or updating a Google Cloud Pub/Sub trigger.
|
|
3117
|
+
*/
|
|
2260
3118
|
export type GcpTriggerData = {
|
|
3119
|
+
/**
|
|
3120
|
+
* Path to the GCP resource containing service account credentials for authentication.
|
|
3121
|
+
*/
|
|
2261
3122
|
gcp_resource_path: string;
|
|
2262
3123
|
subscription_mode: SubscriptionMode;
|
|
3124
|
+
/**
|
|
3125
|
+
* Google Cloud Pub/Sub topic ID to subscribe to.
|
|
3126
|
+
*/
|
|
2263
3127
|
topic_id: string;
|
|
3128
|
+
/**
|
|
3129
|
+
* Google Cloud Pub/Sub subscription ID.
|
|
3130
|
+
*/
|
|
2264
3131
|
subscription_id?: string;
|
|
3132
|
+
/**
|
|
3133
|
+
* Base URL for push delivery endpoint.
|
|
3134
|
+
*/
|
|
2265
3135
|
base_endpoint?: string;
|
|
2266
3136
|
delivery_type?: DeliveryType;
|
|
2267
|
-
delivery_config?: PushConfig;
|
|
3137
|
+
delivery_config?: (PushConfig) | null;
|
|
3138
|
+
/**
|
|
3139
|
+
* The unique path identifier for this trigger.
|
|
3140
|
+
*/
|
|
2268
3141
|
path: string;
|
|
3142
|
+
/**
|
|
3143
|
+
* Path to the script or flow to execute when a message is received.
|
|
3144
|
+
*/
|
|
2269
3145
|
script_path: string;
|
|
3146
|
+
/**
|
|
3147
|
+
* True if script_path points to a flow, false if it points to a script.
|
|
3148
|
+
*/
|
|
2270
3149
|
is_flow: boolean;
|
|
2271
3150
|
mode?: TriggerMode;
|
|
3151
|
+
/**
|
|
3152
|
+
* If true, automatically acknowledge messages after processing.
|
|
3153
|
+
*/
|
|
2272
3154
|
auto_acknowledge_msg?: boolean;
|
|
2273
3155
|
/**
|
|
2274
3156
|
* Time in seconds within which the message must be acknowledged. If not provided, defaults to the subscription's acknowledgment deadline (600 seconds).
|
|
2275
3157
|
*/
|
|
2276
3158
|
ack_deadline?: number;
|
|
3159
|
+
/**
|
|
3160
|
+
* Path to a script or flow to run when the triggered job fails.
|
|
3161
|
+
*/
|
|
2277
3162
|
error_handler_path?: string;
|
|
3163
|
+
/**
|
|
3164
|
+
* Arguments to pass to the error handler.
|
|
3165
|
+
*/
|
|
2278
3166
|
error_handler_args?: ScriptArgs;
|
|
3167
|
+
/**
|
|
3168
|
+
* Retry configuration for failed executions.
|
|
3169
|
+
*/
|
|
2279
3170
|
retry?: Retry;
|
|
3171
|
+
/**
|
|
3172
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
3173
|
+
*/
|
|
3174
|
+
email?: string;
|
|
3175
|
+
/**
|
|
3176
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
3177
|
+
*/
|
|
3178
|
+
preserve_email?: boolean;
|
|
2280
3179
|
};
|
|
2281
3180
|
export type GetAllTopicSubscription = {
|
|
2282
3181
|
topic_id: string;
|
|
@@ -2286,15 +3185,45 @@ export type DeleteGcpSubscription = {
|
|
|
2286
3185
|
};
|
|
2287
3186
|
export type AwsAuthResourceType = 'oidc' | 'credentials';
|
|
2288
3187
|
export type SqsTrigger = TriggerExtraProperty & {
|
|
3188
|
+
/**
|
|
3189
|
+
* The full URL of the AWS SQS queue to poll for messages
|
|
3190
|
+
*/
|
|
2289
3191
|
queue_url: string;
|
|
3192
|
+
/**
|
|
3193
|
+
* Authentication type - 'credentials' for access key/secret, 'oidc' for OpenID Connect
|
|
3194
|
+
*/
|
|
2290
3195
|
aws_auth_resource_type: AwsAuthResourceType;
|
|
3196
|
+
/**
|
|
3197
|
+
* Path to the AWS resource containing credentials or OIDC configuration
|
|
3198
|
+
*/
|
|
2291
3199
|
aws_resource_path: string;
|
|
2292
|
-
|
|
3200
|
+
/**
|
|
3201
|
+
* Array of SQS message attribute names to include with each message
|
|
3202
|
+
*/
|
|
3203
|
+
message_attributes?: Array<(string)> | null;
|
|
3204
|
+
/**
|
|
3205
|
+
* ID of the server currently handling this trigger (internal)
|
|
3206
|
+
*/
|
|
2293
3207
|
server_id?: string;
|
|
3208
|
+
/**
|
|
3209
|
+
* Timestamp of last server heartbeat (internal)
|
|
3210
|
+
*/
|
|
2294
3211
|
last_server_ping?: string;
|
|
3212
|
+
/**
|
|
3213
|
+
* Last error message if the trigger failed
|
|
3214
|
+
*/
|
|
2295
3215
|
error?: string;
|
|
3216
|
+
/**
|
|
3217
|
+
* Path to a script or flow to run when the triggered job fails
|
|
3218
|
+
*/
|
|
2296
3219
|
error_handler_path?: string;
|
|
3220
|
+
/**
|
|
3221
|
+
* Arguments to pass to the error handler
|
|
3222
|
+
*/
|
|
2297
3223
|
error_handler_args?: ScriptArgs;
|
|
3224
|
+
/**
|
|
3225
|
+
* Retry configuration for failed executions
|
|
3226
|
+
*/
|
|
2298
3227
|
retry?: Retry;
|
|
2299
3228
|
};
|
|
2300
3229
|
export type LoggedWizardStatus = 'OK' | 'SKIP' | 'FAIL';
|
|
@@ -2320,30 +3249,106 @@ export type CustomInstanceDb = {
|
|
|
2320
3249
|
tag?: CustomInstanceDbTag;
|
|
2321
3250
|
};
|
|
2322
3251
|
export type NewSqsTrigger = {
|
|
3252
|
+
/**
|
|
3253
|
+
* The full URL of the AWS SQS queue to poll for messages
|
|
3254
|
+
*/
|
|
2323
3255
|
queue_url: string;
|
|
3256
|
+
/**
|
|
3257
|
+
* Authentication type - 'credentials' for access key/secret, 'oidc' for OpenID Connect
|
|
3258
|
+
*/
|
|
2324
3259
|
aws_auth_resource_type: AwsAuthResourceType;
|
|
3260
|
+
/**
|
|
3261
|
+
* Path to the AWS resource containing credentials or OIDC configuration
|
|
3262
|
+
*/
|
|
2325
3263
|
aws_resource_path: string;
|
|
2326
|
-
|
|
3264
|
+
/**
|
|
3265
|
+
* Array of SQS message attribute names to include with each message
|
|
3266
|
+
*/
|
|
3267
|
+
message_attributes?: Array<(string)> | null;
|
|
3268
|
+
/**
|
|
3269
|
+
* The unique path identifier for this trigger
|
|
3270
|
+
*/
|
|
2327
3271
|
path: string;
|
|
3272
|
+
/**
|
|
3273
|
+
* Path to the script or flow to execute when a message is received
|
|
3274
|
+
*/
|
|
2328
3275
|
script_path: string;
|
|
3276
|
+
/**
|
|
3277
|
+
* True if script_path points to a flow, false if it points to a script
|
|
3278
|
+
*/
|
|
2329
3279
|
is_flow: boolean;
|
|
2330
3280
|
mode?: TriggerMode;
|
|
3281
|
+
/**
|
|
3282
|
+
* Path to a script or flow to run when the triggered job fails
|
|
3283
|
+
*/
|
|
2331
3284
|
error_handler_path?: string;
|
|
3285
|
+
/**
|
|
3286
|
+
* Arguments to pass to the error handler
|
|
3287
|
+
*/
|
|
2332
3288
|
error_handler_args?: ScriptArgs;
|
|
3289
|
+
/**
|
|
3290
|
+
* Retry configuration for failed executions
|
|
3291
|
+
*/
|
|
2333
3292
|
retry?: Retry;
|
|
3293
|
+
/**
|
|
3294
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
3295
|
+
*/
|
|
3296
|
+
email?: string;
|
|
3297
|
+
/**
|
|
3298
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
3299
|
+
*/
|
|
3300
|
+
preserve_email?: boolean;
|
|
2334
3301
|
};
|
|
2335
3302
|
export type EditSqsTrigger = {
|
|
3303
|
+
/**
|
|
3304
|
+
* The full URL of the AWS SQS queue to poll for messages
|
|
3305
|
+
*/
|
|
2336
3306
|
queue_url: string;
|
|
3307
|
+
/**
|
|
3308
|
+
* Authentication type - 'credentials' for access key/secret, 'oidc' for OpenID Connect
|
|
3309
|
+
*/
|
|
2337
3310
|
aws_auth_resource_type: AwsAuthResourceType;
|
|
3311
|
+
/**
|
|
3312
|
+
* Path to the AWS resource containing credentials or OIDC configuration
|
|
3313
|
+
*/
|
|
2338
3314
|
aws_resource_path: string;
|
|
2339
|
-
|
|
3315
|
+
/**
|
|
3316
|
+
* Array of SQS message attribute names to include with each message
|
|
3317
|
+
*/
|
|
3318
|
+
message_attributes?: Array<(string)> | null;
|
|
3319
|
+
/**
|
|
3320
|
+
* The unique path identifier for this trigger
|
|
3321
|
+
*/
|
|
2340
3322
|
path: string;
|
|
3323
|
+
/**
|
|
3324
|
+
* Path to the script or flow to execute when a message is received
|
|
3325
|
+
*/
|
|
2341
3326
|
script_path: string;
|
|
3327
|
+
/**
|
|
3328
|
+
* True if script_path points to a flow, false if it points to a script
|
|
3329
|
+
*/
|
|
2342
3330
|
is_flow: boolean;
|
|
2343
3331
|
mode?: TriggerMode;
|
|
3332
|
+
/**
|
|
3333
|
+
* Path to a script or flow to run when the triggered job fails
|
|
3334
|
+
*/
|
|
2344
3335
|
error_handler_path?: string;
|
|
3336
|
+
/**
|
|
3337
|
+
* Arguments to pass to the error handler
|
|
3338
|
+
*/
|
|
2345
3339
|
error_handler_args?: ScriptArgs;
|
|
3340
|
+
/**
|
|
3341
|
+
* Retry configuration for failed executions
|
|
3342
|
+
*/
|
|
2346
3343
|
retry?: Retry;
|
|
3344
|
+
/**
|
|
3345
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
3346
|
+
*/
|
|
3347
|
+
email?: string;
|
|
3348
|
+
/**
|
|
3349
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
3350
|
+
*/
|
|
3351
|
+
preserve_email?: boolean;
|
|
2347
3352
|
};
|
|
2348
3353
|
export type Slot = {
|
|
2349
3354
|
name?: string;
|
|
@@ -2372,115 +3377,470 @@ export type TemplateScript = {
|
|
|
2372
3377
|
language: Language;
|
|
2373
3378
|
};
|
|
2374
3379
|
export type PostgresTrigger = TriggerExtraProperty & {
|
|
3380
|
+
/**
|
|
3381
|
+
* Path to the PostgreSQL resource containing connection configuration
|
|
3382
|
+
*/
|
|
2375
3383
|
postgres_resource_path: string;
|
|
3384
|
+
/**
|
|
3385
|
+
* Name of the PostgreSQL publication to subscribe to for change data capture
|
|
3386
|
+
*/
|
|
2376
3387
|
publication_name: string;
|
|
3388
|
+
/**
|
|
3389
|
+
* ID of the server currently handling this trigger (internal)
|
|
3390
|
+
*/
|
|
2377
3391
|
server_id?: string;
|
|
3392
|
+
/**
|
|
3393
|
+
* Name of the PostgreSQL logical replication slot to use
|
|
3394
|
+
*/
|
|
2378
3395
|
replication_slot_name: string;
|
|
3396
|
+
/**
|
|
3397
|
+
* Last error message if the trigger failed
|
|
3398
|
+
*/
|
|
2379
3399
|
error?: string;
|
|
3400
|
+
/**
|
|
3401
|
+
* Timestamp of last server heartbeat (internal)
|
|
3402
|
+
*/
|
|
2380
3403
|
last_server_ping?: string;
|
|
3404
|
+
/**
|
|
3405
|
+
* Path to a script or flow to run when the triggered job fails
|
|
3406
|
+
*/
|
|
2381
3407
|
error_handler_path?: string;
|
|
3408
|
+
/**
|
|
3409
|
+
* Arguments to pass to the error handler
|
|
3410
|
+
*/
|
|
2382
3411
|
error_handler_args?: ScriptArgs;
|
|
3412
|
+
/**
|
|
3413
|
+
* Retry configuration for failed executions
|
|
3414
|
+
*/
|
|
2383
3415
|
retry?: Retry;
|
|
2384
3416
|
};
|
|
2385
3417
|
export type NewPostgresTrigger = {
|
|
3418
|
+
/**
|
|
3419
|
+
* Name of the PostgreSQL logical replication slot to use
|
|
3420
|
+
*/
|
|
2386
3421
|
replication_slot_name?: string;
|
|
3422
|
+
/**
|
|
3423
|
+
* Name of the PostgreSQL publication to subscribe to for change data capture
|
|
3424
|
+
*/
|
|
2387
3425
|
publication_name?: string;
|
|
3426
|
+
/**
|
|
3427
|
+
* The unique path identifier for this trigger
|
|
3428
|
+
*/
|
|
2388
3429
|
path: string;
|
|
3430
|
+
/**
|
|
3431
|
+
* Path to the script or flow to execute when database changes are detected
|
|
3432
|
+
*/
|
|
2389
3433
|
script_path: string;
|
|
3434
|
+
/**
|
|
3435
|
+
* True if script_path points to a flow, false if it points to a script
|
|
3436
|
+
*/
|
|
2390
3437
|
is_flow: boolean;
|
|
2391
3438
|
mode?: TriggerMode;
|
|
3439
|
+
/**
|
|
3440
|
+
* Path to the PostgreSQL resource containing connection configuration
|
|
3441
|
+
*/
|
|
2392
3442
|
postgres_resource_path: string;
|
|
3443
|
+
/**
|
|
3444
|
+
* Configuration for creating/managing the publication (tables, operations)
|
|
3445
|
+
*/
|
|
2393
3446
|
publication?: PublicationData;
|
|
3447
|
+
/**
|
|
3448
|
+
* Path to a script or flow to run when the triggered job fails
|
|
3449
|
+
*/
|
|
2394
3450
|
error_handler_path?: string;
|
|
3451
|
+
/**
|
|
3452
|
+
* Arguments to pass to the error handler
|
|
3453
|
+
*/
|
|
2395
3454
|
error_handler_args?: ScriptArgs;
|
|
3455
|
+
/**
|
|
3456
|
+
* Retry configuration for failed executions
|
|
3457
|
+
*/
|
|
2396
3458
|
retry?: Retry;
|
|
3459
|
+
/**
|
|
3460
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
3461
|
+
*/
|
|
3462
|
+
email?: string;
|
|
3463
|
+
/**
|
|
3464
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
3465
|
+
*/
|
|
3466
|
+
preserve_email?: boolean;
|
|
2397
3467
|
};
|
|
2398
3468
|
export type EditPostgresTrigger = {
|
|
3469
|
+
/**
|
|
3470
|
+
* Name of the PostgreSQL logical replication slot to use
|
|
3471
|
+
*/
|
|
2399
3472
|
replication_slot_name: string;
|
|
3473
|
+
/**
|
|
3474
|
+
* Name of the PostgreSQL publication to subscribe to for change data capture
|
|
3475
|
+
*/
|
|
2400
3476
|
publication_name: string;
|
|
3477
|
+
/**
|
|
3478
|
+
* The unique path identifier for this trigger
|
|
3479
|
+
*/
|
|
2401
3480
|
path: string;
|
|
3481
|
+
/**
|
|
3482
|
+
* Path to the script or flow to execute when database changes are detected
|
|
3483
|
+
*/
|
|
2402
3484
|
script_path: string;
|
|
3485
|
+
/**
|
|
3486
|
+
* True if script_path points to a flow, false if it points to a script
|
|
3487
|
+
*/
|
|
2403
3488
|
is_flow: boolean;
|
|
2404
3489
|
mode?: TriggerMode;
|
|
3490
|
+
/**
|
|
3491
|
+
* Path to the PostgreSQL resource containing connection configuration
|
|
3492
|
+
*/
|
|
2405
3493
|
postgres_resource_path: string;
|
|
3494
|
+
/**
|
|
3495
|
+
* Configuration for creating/managing the publication (tables, operations)
|
|
3496
|
+
*/
|
|
2406
3497
|
publication?: PublicationData;
|
|
3498
|
+
/**
|
|
3499
|
+
* Path to a script or flow to run when the triggered job fails
|
|
3500
|
+
*/
|
|
2407
3501
|
error_handler_path?: string;
|
|
3502
|
+
/**
|
|
3503
|
+
* Arguments to pass to the error handler
|
|
3504
|
+
*/
|
|
2408
3505
|
error_handler_args?: ScriptArgs;
|
|
3506
|
+
/**
|
|
3507
|
+
* Retry configuration for failed executions
|
|
3508
|
+
*/
|
|
2409
3509
|
retry?: Retry;
|
|
3510
|
+
/**
|
|
3511
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
3512
|
+
*/
|
|
3513
|
+
email?: string;
|
|
3514
|
+
/**
|
|
3515
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
3516
|
+
*/
|
|
3517
|
+
preserve_email?: boolean;
|
|
2410
3518
|
};
|
|
2411
3519
|
export type KafkaTrigger = TriggerExtraProperty & {
|
|
3520
|
+
/**
|
|
3521
|
+
* Path to the Kafka resource containing connection configuration
|
|
3522
|
+
*/
|
|
2412
3523
|
kafka_resource_path: string;
|
|
3524
|
+
/**
|
|
3525
|
+
* Kafka consumer group ID for this trigger
|
|
3526
|
+
*/
|
|
2413
3527
|
group_id: string;
|
|
3528
|
+
/**
|
|
3529
|
+
* Array of Kafka topic names to subscribe to
|
|
3530
|
+
*/
|
|
2414
3531
|
topics: Array<(string)>;
|
|
3532
|
+
filters: Array<{
|
|
3533
|
+
key: string;
|
|
3534
|
+
value: unknown;
|
|
3535
|
+
}>;
|
|
3536
|
+
/**
|
|
3537
|
+
* Initial offset behavior when consumer group has no committed offset. 'latest' starts from new messages only, 'earliest' starts from the beginning.
|
|
3538
|
+
*/
|
|
3539
|
+
auto_offset_reset?: 'latest' | 'earliest';
|
|
3540
|
+
/**
|
|
3541
|
+
* When true (default), offsets are committed automatically after receiving each message. When false, you must manually commit offsets using the commit_offsets endpoint.
|
|
3542
|
+
*/
|
|
3543
|
+
auto_commit?: boolean;
|
|
3544
|
+
/**
|
|
3545
|
+
* ID of the server currently handling this trigger (internal)
|
|
3546
|
+
*/
|
|
2415
3547
|
server_id?: string;
|
|
3548
|
+
/**
|
|
3549
|
+
* Timestamp of last server heartbeat (internal)
|
|
3550
|
+
*/
|
|
2416
3551
|
last_server_ping?: string;
|
|
3552
|
+
/**
|
|
3553
|
+
* Last error message if the trigger failed
|
|
3554
|
+
*/
|
|
2417
3555
|
error?: string;
|
|
3556
|
+
/**
|
|
3557
|
+
* Path to a script or flow to run when the triggered job fails
|
|
3558
|
+
*/
|
|
2418
3559
|
error_handler_path?: string;
|
|
3560
|
+
/**
|
|
3561
|
+
* Arguments to pass to the error handler
|
|
3562
|
+
*/
|
|
2419
3563
|
error_handler_args?: ScriptArgs;
|
|
3564
|
+
/**
|
|
3565
|
+
* Retry configuration for failed executions
|
|
3566
|
+
*/
|
|
2420
3567
|
retry?: Retry;
|
|
2421
3568
|
};
|
|
3569
|
+
/**
|
|
3570
|
+
* Initial offset behavior when consumer group has no committed offset. 'latest' starts from new messages only, 'earliest' starts from the beginning.
|
|
3571
|
+
*/
|
|
3572
|
+
export type auto_offset_reset = 'latest' | 'earliest';
|
|
2422
3573
|
export type NewKafkaTrigger = {
|
|
3574
|
+
/**
|
|
3575
|
+
* The unique path identifier for this trigger
|
|
3576
|
+
*/
|
|
2423
3577
|
path: string;
|
|
3578
|
+
/**
|
|
3579
|
+
* Path to the script or flow to execute when a message is received
|
|
3580
|
+
*/
|
|
2424
3581
|
script_path: string;
|
|
3582
|
+
/**
|
|
3583
|
+
* True if script_path points to a flow, false if it points to a script
|
|
3584
|
+
*/
|
|
2425
3585
|
is_flow: boolean;
|
|
3586
|
+
/**
|
|
3587
|
+
* Path to the Kafka resource containing connection configuration
|
|
3588
|
+
*/
|
|
2426
3589
|
kafka_resource_path: string;
|
|
3590
|
+
/**
|
|
3591
|
+
* Kafka consumer group ID for this trigger
|
|
3592
|
+
*/
|
|
2427
3593
|
group_id: string;
|
|
3594
|
+
/**
|
|
3595
|
+
* Array of Kafka topic names to subscribe to
|
|
3596
|
+
*/
|
|
2428
3597
|
topics: Array<(string)>;
|
|
3598
|
+
filters: Array<{
|
|
3599
|
+
key: string;
|
|
3600
|
+
value: unknown;
|
|
3601
|
+
}>;
|
|
3602
|
+
/**
|
|
3603
|
+
* Initial offset behavior when consumer group has no committed offset.
|
|
3604
|
+
*/
|
|
3605
|
+
auto_offset_reset?: 'latest' | 'earliest';
|
|
3606
|
+
/**
|
|
3607
|
+
* When true (default), offsets are committed automatically after receiving each message. When false, you must manually commit offsets using the commit_offsets endpoint.
|
|
3608
|
+
*/
|
|
3609
|
+
auto_commit?: boolean;
|
|
2429
3610
|
mode?: TriggerMode;
|
|
3611
|
+
/**
|
|
3612
|
+
* Path to a script or flow to run when the triggered job fails
|
|
3613
|
+
*/
|
|
2430
3614
|
error_handler_path?: string;
|
|
3615
|
+
/**
|
|
3616
|
+
* Arguments to pass to the error handler
|
|
3617
|
+
*/
|
|
2431
3618
|
error_handler_args?: ScriptArgs;
|
|
3619
|
+
/**
|
|
3620
|
+
* Retry configuration for failed executions
|
|
3621
|
+
*/
|
|
2432
3622
|
retry?: Retry;
|
|
3623
|
+
/**
|
|
3624
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
3625
|
+
*/
|
|
3626
|
+
email?: string;
|
|
3627
|
+
/**
|
|
3628
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
3629
|
+
*/
|
|
3630
|
+
preserve_email?: boolean;
|
|
2433
3631
|
};
|
|
2434
3632
|
export type EditKafkaTrigger = {
|
|
3633
|
+
/**
|
|
3634
|
+
* Path to the Kafka resource containing connection configuration
|
|
3635
|
+
*/
|
|
2435
3636
|
kafka_resource_path: string;
|
|
3637
|
+
/**
|
|
3638
|
+
* Kafka consumer group ID for this trigger
|
|
3639
|
+
*/
|
|
2436
3640
|
group_id: string;
|
|
3641
|
+
/**
|
|
3642
|
+
* Array of Kafka topic names to subscribe to
|
|
3643
|
+
*/
|
|
2437
3644
|
topics: Array<(string)>;
|
|
3645
|
+
filters: Array<{
|
|
3646
|
+
key: string;
|
|
3647
|
+
value: unknown;
|
|
3648
|
+
}>;
|
|
3649
|
+
/**
|
|
3650
|
+
* Initial offset behavior when consumer group has no committed offset.
|
|
3651
|
+
*/
|
|
3652
|
+
auto_offset_reset?: 'latest' | 'earliest';
|
|
3653
|
+
/**
|
|
3654
|
+
* When true (default), offsets are committed automatically after receiving each message. When false, you must manually commit offsets using the commit_offsets endpoint.
|
|
3655
|
+
*/
|
|
3656
|
+
auto_commit?: boolean;
|
|
3657
|
+
/**
|
|
3658
|
+
* The unique path identifier for this trigger
|
|
3659
|
+
*/
|
|
2438
3660
|
path: string;
|
|
3661
|
+
/**
|
|
3662
|
+
* Path to the script or flow to execute when a message is received
|
|
3663
|
+
*/
|
|
2439
3664
|
script_path: string;
|
|
3665
|
+
/**
|
|
3666
|
+
* True if script_path points to a flow, false if it points to a script
|
|
3667
|
+
*/
|
|
2440
3668
|
is_flow: boolean;
|
|
3669
|
+
/**
|
|
3670
|
+
* Path to a script or flow to run when the triggered job fails
|
|
3671
|
+
*/
|
|
2441
3672
|
error_handler_path?: string;
|
|
3673
|
+
/**
|
|
3674
|
+
* Arguments to pass to the error handler
|
|
3675
|
+
*/
|
|
2442
3676
|
error_handler_args?: ScriptArgs;
|
|
3677
|
+
/**
|
|
3678
|
+
* Retry configuration for failed executions
|
|
3679
|
+
*/
|
|
2443
3680
|
retry?: Retry;
|
|
3681
|
+
/**
|
|
3682
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
3683
|
+
*/
|
|
3684
|
+
email?: string;
|
|
3685
|
+
/**
|
|
3686
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
3687
|
+
*/
|
|
3688
|
+
preserve_email?: boolean;
|
|
2444
3689
|
};
|
|
2445
3690
|
export type NatsTrigger = TriggerExtraProperty & {
|
|
3691
|
+
/**
|
|
3692
|
+
* Path to the NATS resource containing connection configuration
|
|
3693
|
+
*/
|
|
2446
3694
|
nats_resource_path: string;
|
|
3695
|
+
/**
|
|
3696
|
+
* If true, uses NATS JetStream for durable message delivery
|
|
3697
|
+
*/
|
|
2447
3698
|
use_jetstream: boolean;
|
|
2448
|
-
|
|
2449
|
-
|
|
3699
|
+
/**
|
|
3700
|
+
* JetStream stream name (required when use_jetstream is true)
|
|
3701
|
+
*/
|
|
3702
|
+
stream_name?: (string) | null;
|
|
3703
|
+
/**
|
|
3704
|
+
* JetStream consumer name (required when use_jetstream is true)
|
|
3705
|
+
*/
|
|
3706
|
+
consumer_name?: (string) | null;
|
|
3707
|
+
/**
|
|
3708
|
+
* Array of NATS subjects to subscribe to
|
|
3709
|
+
*/
|
|
2450
3710
|
subjects: Array<(string)>;
|
|
3711
|
+
/**
|
|
3712
|
+
* ID of the server currently handling this trigger (internal)
|
|
3713
|
+
*/
|
|
2451
3714
|
server_id?: string;
|
|
3715
|
+
/**
|
|
3716
|
+
* Timestamp of last server heartbeat (internal)
|
|
3717
|
+
*/
|
|
2452
3718
|
last_server_ping?: string;
|
|
3719
|
+
/**
|
|
3720
|
+
* Last error message if the trigger failed
|
|
3721
|
+
*/
|
|
2453
3722
|
error?: string;
|
|
3723
|
+
/**
|
|
3724
|
+
* Path to a script or flow to run when the triggered job fails
|
|
3725
|
+
*/
|
|
2454
3726
|
error_handler_path?: string;
|
|
3727
|
+
/**
|
|
3728
|
+
* Arguments to pass to the error handler
|
|
3729
|
+
*/
|
|
2455
3730
|
error_handler_args?: ScriptArgs;
|
|
3731
|
+
/**
|
|
3732
|
+
* Retry configuration for failed executions
|
|
3733
|
+
*/
|
|
2456
3734
|
retry?: Retry;
|
|
2457
3735
|
};
|
|
2458
3736
|
export type NewNatsTrigger = {
|
|
3737
|
+
/**
|
|
3738
|
+
* The unique path identifier for this trigger
|
|
3739
|
+
*/
|
|
2459
3740
|
path: string;
|
|
3741
|
+
/**
|
|
3742
|
+
* Path to the script or flow to execute when a message is received
|
|
3743
|
+
*/
|
|
2460
3744
|
script_path: string;
|
|
3745
|
+
/**
|
|
3746
|
+
* True if script_path points to a flow, false if it points to a script
|
|
3747
|
+
*/
|
|
2461
3748
|
is_flow: boolean;
|
|
3749
|
+
/**
|
|
3750
|
+
* Path to the NATS resource containing connection configuration
|
|
3751
|
+
*/
|
|
2462
3752
|
nats_resource_path: string;
|
|
3753
|
+
/**
|
|
3754
|
+
* If true, uses NATS JetStream for durable message delivery
|
|
3755
|
+
*/
|
|
2463
3756
|
use_jetstream: boolean;
|
|
2464
|
-
|
|
2465
|
-
|
|
3757
|
+
/**
|
|
3758
|
+
* JetStream stream name (required when use_jetstream is true)
|
|
3759
|
+
*/
|
|
3760
|
+
stream_name?: (string) | null;
|
|
3761
|
+
/**
|
|
3762
|
+
* JetStream consumer name (required when use_jetstream is true)
|
|
3763
|
+
*/
|
|
3764
|
+
consumer_name?: (string) | null;
|
|
3765
|
+
/**
|
|
3766
|
+
* Array of NATS subjects to subscribe to
|
|
3767
|
+
*/
|
|
2466
3768
|
subjects: Array<(string)>;
|
|
2467
3769
|
mode?: TriggerMode;
|
|
3770
|
+
/**
|
|
3771
|
+
* Path to a script or flow to run when the triggered job fails
|
|
3772
|
+
*/
|
|
2468
3773
|
error_handler_path?: string;
|
|
3774
|
+
/**
|
|
3775
|
+
* Arguments to pass to the error handler
|
|
3776
|
+
*/
|
|
2469
3777
|
error_handler_args?: ScriptArgs;
|
|
3778
|
+
/**
|
|
3779
|
+
* Retry configuration for failed executions
|
|
3780
|
+
*/
|
|
2470
3781
|
retry?: Retry;
|
|
3782
|
+
/**
|
|
3783
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
3784
|
+
*/
|
|
3785
|
+
email?: string;
|
|
3786
|
+
/**
|
|
3787
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
3788
|
+
*/
|
|
3789
|
+
preserve_email?: boolean;
|
|
2471
3790
|
};
|
|
2472
3791
|
export type EditNatsTrigger = {
|
|
3792
|
+
/**
|
|
3793
|
+
* Path to the NATS resource containing connection configuration
|
|
3794
|
+
*/
|
|
2473
3795
|
nats_resource_path: string;
|
|
3796
|
+
/**
|
|
3797
|
+
* If true, uses NATS JetStream for durable message delivery
|
|
3798
|
+
*/
|
|
2474
3799
|
use_jetstream: boolean;
|
|
2475
|
-
|
|
2476
|
-
|
|
3800
|
+
/**
|
|
3801
|
+
* JetStream stream name (required when use_jetstream is true)
|
|
3802
|
+
*/
|
|
3803
|
+
stream_name?: (string) | null;
|
|
3804
|
+
/**
|
|
3805
|
+
* JetStream consumer name (required when use_jetstream is true)
|
|
3806
|
+
*/
|
|
3807
|
+
consumer_name?: (string) | null;
|
|
3808
|
+
/**
|
|
3809
|
+
* Array of NATS subjects to subscribe to
|
|
3810
|
+
*/
|
|
2477
3811
|
subjects: Array<(string)>;
|
|
3812
|
+
/**
|
|
3813
|
+
* The unique path identifier for this trigger
|
|
3814
|
+
*/
|
|
2478
3815
|
path: string;
|
|
3816
|
+
/**
|
|
3817
|
+
* Path to the script or flow to execute when a message is received
|
|
3818
|
+
*/
|
|
2479
3819
|
script_path: string;
|
|
3820
|
+
/**
|
|
3821
|
+
* True if script_path points to a flow, false if it points to a script
|
|
3822
|
+
*/
|
|
2480
3823
|
is_flow: boolean;
|
|
3824
|
+
/**
|
|
3825
|
+
* Path to a script or flow to run when the triggered job fails
|
|
3826
|
+
*/
|
|
2481
3827
|
error_handler_path?: string;
|
|
3828
|
+
/**
|
|
3829
|
+
* Arguments to pass to the error handler
|
|
3830
|
+
*/
|
|
2482
3831
|
error_handler_args?: ScriptArgs;
|
|
3832
|
+
/**
|
|
3833
|
+
* Retry configuration for failed executions
|
|
3834
|
+
*/
|
|
2483
3835
|
retry?: Retry;
|
|
3836
|
+
/**
|
|
3837
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
3838
|
+
*/
|
|
3839
|
+
email?: string;
|
|
3840
|
+
/**
|
|
3841
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
3842
|
+
*/
|
|
3843
|
+
preserve_email?: boolean;
|
|
2484
3844
|
};
|
|
2485
3845
|
export type EmailTrigger = TriggerExtraProperty & {
|
|
2486
3846
|
local_part: string;
|
|
@@ -2499,6 +3859,14 @@ export type NewEmailTrigger = {
|
|
|
2499
3859
|
error_handler_args?: ScriptArgs;
|
|
2500
3860
|
retry?: Retry;
|
|
2501
3861
|
mode?: TriggerMode;
|
|
3862
|
+
/**
|
|
3863
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
3864
|
+
*/
|
|
3865
|
+
email?: string;
|
|
3866
|
+
/**
|
|
3867
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
3868
|
+
*/
|
|
3869
|
+
preserve_email?: boolean;
|
|
2502
3870
|
};
|
|
2503
3871
|
export type EditEmailTrigger = {
|
|
2504
3872
|
path: string;
|
|
@@ -2509,6 +3877,14 @@ export type EditEmailTrigger = {
|
|
|
2509
3877
|
error_handler_path?: string;
|
|
2510
3878
|
error_handler_args?: ScriptArgs;
|
|
2511
3879
|
retry?: Retry;
|
|
3880
|
+
/**
|
|
3881
|
+
* Email of the user who triggered jobs run as. Used during deployment to preserve the original trigger owner.
|
|
3882
|
+
*/
|
|
3883
|
+
email?: string;
|
|
3884
|
+
/**
|
|
3885
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original email value instead of overwriting it.
|
|
3886
|
+
*/
|
|
3887
|
+
preserve_email?: boolean;
|
|
2512
3888
|
};
|
|
2513
3889
|
export type Group = {
|
|
2514
3890
|
name: string;
|
|
@@ -2522,11 +3898,14 @@ export type InstanceGroup = {
|
|
|
2522
3898
|
name: string;
|
|
2523
3899
|
summary?: string;
|
|
2524
3900
|
emails?: Array<(string)>;
|
|
3901
|
+
instance_role?: ('superadmin' | 'devops') | null;
|
|
2525
3902
|
};
|
|
3903
|
+
export type instance_role = 'superadmin' | 'devops';
|
|
2526
3904
|
export type InstanceGroupWithWorkspaces = {
|
|
2527
3905
|
name: string;
|
|
2528
3906
|
summary?: string;
|
|
2529
3907
|
emails?: Array<(string)>;
|
|
3908
|
+
instance_role?: ('superadmin' | 'devops') | null;
|
|
2530
3909
|
workspaces?: Array<WorkspaceInfo>;
|
|
2531
3910
|
};
|
|
2532
3911
|
export type WorkspaceInfo = {
|
|
@@ -2565,6 +3944,7 @@ export type WorkerPing = {
|
|
|
2565
3944
|
memory_usage?: number;
|
|
2566
3945
|
wm_memory_usage?: number;
|
|
2567
3946
|
job_isolation?: string;
|
|
3947
|
+
native_mode?: boolean;
|
|
2568
3948
|
};
|
|
2569
3949
|
export type UserWorkspaceList = {
|
|
2570
3950
|
email: string;
|
|
@@ -2633,8 +4013,10 @@ export type GlobalUserInfo = {
|
|
|
2633
4013
|
username?: string;
|
|
2634
4014
|
operator_only?: boolean;
|
|
2635
4015
|
first_time_user: boolean;
|
|
4016
|
+
role_source: 'manual' | 'instance_group';
|
|
2636
4017
|
};
|
|
2637
4018
|
export type login_type = 'password' | 'github';
|
|
4019
|
+
export type role_source = 'manual' | 'instance_group';
|
|
2638
4020
|
export type Flow = OpenFlow & FlowMetadata & {
|
|
2639
4021
|
lock_error_logs?: string;
|
|
2640
4022
|
version_id?: number;
|
|
@@ -2668,6 +4050,10 @@ export type OpenFlowWPath = OpenFlow & {
|
|
|
2668
4050
|
timeout?: number;
|
|
2669
4051
|
visible_to_runner_only?: boolean;
|
|
2670
4052
|
on_behalf_of_email?: string;
|
|
4053
|
+
/**
|
|
4054
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original on_behalf_of_email value instead of overwriting it.
|
|
4055
|
+
*/
|
|
4056
|
+
preserve_on_behalf_of?: boolean;
|
|
2671
4057
|
};
|
|
2672
4058
|
export type FlowPreview = {
|
|
2673
4059
|
value: FlowValue;
|
|
@@ -2749,9 +4135,7 @@ export type AppWithLastVersion = {
|
|
|
2749
4135
|
versions: Array<(number)>;
|
|
2750
4136
|
created_by: string;
|
|
2751
4137
|
created_at: string;
|
|
2752
|
-
value:
|
|
2753
|
-
[key: string]: unknown;
|
|
2754
|
-
};
|
|
4138
|
+
value: unknown;
|
|
2755
4139
|
policy: Policy;
|
|
2756
4140
|
execution_mode: 'viewer' | 'publisher' | 'anonymous';
|
|
2757
4141
|
extra_perms: {
|
|
@@ -2922,10 +4306,11 @@ export type S3PermissionRule = {
|
|
|
2922
4306
|
allow: string;
|
|
2923
4307
|
};
|
|
2924
4308
|
export type GitRepositorySettings = {
|
|
2925
|
-
script_path
|
|
4309
|
+
script_path?: string;
|
|
2926
4310
|
git_repo_resource_path: string;
|
|
2927
4311
|
use_individual_branch?: boolean;
|
|
2928
4312
|
group_by_folder?: boolean;
|
|
4313
|
+
force_branch?: string;
|
|
2929
4314
|
collapsed?: boolean;
|
|
2930
4315
|
settings?: {
|
|
2931
4316
|
include_path?: Array<(string)>;
|
|
@@ -2980,9 +4365,28 @@ export type ExportedUser = {
|
|
|
2980
4365
|
};
|
|
2981
4366
|
export type GlobalSetting = {
|
|
2982
4367
|
name: string;
|
|
2983
|
-
value:
|
|
4368
|
+
value: unknown;
|
|
4369
|
+
};
|
|
4370
|
+
/**
|
|
4371
|
+
* Unified instance configuration combining global settings and worker group configs
|
|
4372
|
+
*/
|
|
4373
|
+
export type InstanceConfig = {
|
|
4374
|
+
/**
|
|
4375
|
+
* Global settings keyed by setting name. Known fields include base_url, license_key, retention_period_secs, smtp_settings, otel, etc. Unknown fields are preserved as-is.
|
|
4376
|
+
*
|
|
4377
|
+
*/
|
|
4378
|
+
global_settings?: {
|
|
2984
4379
|
[key: string]: unknown;
|
|
2985
4380
|
};
|
|
4381
|
+
/**
|
|
4382
|
+
* Worker group configurations keyed by group name (e.g. "default", "gpu"). Each value contains worker_tags, init_bash, autoscaling, etc.
|
|
4383
|
+
*
|
|
4384
|
+
*/
|
|
4385
|
+
worker_configs?: {
|
|
4386
|
+
[key: string]: {
|
|
4387
|
+
[key: string]: unknown;
|
|
4388
|
+
};
|
|
4389
|
+
};
|
|
2986
4390
|
};
|
|
2987
4391
|
export type Config = {
|
|
2988
4392
|
name: string;
|
|
@@ -2997,6 +4401,7 @@ export type ExportedInstanceGroup = {
|
|
|
2997
4401
|
id?: string;
|
|
2998
4402
|
scim_display_name?: string;
|
|
2999
4403
|
external_id?: string;
|
|
4404
|
+
instance_role?: ('superadmin' | 'devops') | null;
|
|
3000
4405
|
};
|
|
3001
4406
|
export type JobSearchHit = {
|
|
3002
4407
|
dancer?: string;
|
|
@@ -3149,7 +4554,7 @@ export type WorkspaceItemDiff = {
|
|
|
3149
4554
|
/**
|
|
3150
4555
|
* Type of the item
|
|
3151
4556
|
*/
|
|
3152
|
-
export type
|
|
4557
|
+
export type kind5 = 'script' | 'flow' | 'app' | 'resource' | 'variable' | 'resource_type';
|
|
3153
4558
|
export type CompareSummary = {
|
|
3154
4559
|
/**
|
|
3155
4560
|
* Total number of items with differences
|
|
@@ -3279,12 +4684,50 @@ export type TeamsChannel = {
|
|
|
3279
4684
|
};
|
|
3280
4685
|
export type AssetUsageKind = 'script' | 'flow' | 'job';
|
|
3281
4686
|
export type AssetUsageAccessType = 'r' | 'w' | 'rw';
|
|
3282
|
-
export type AssetKind = 's3object' | 'resource' | 'ducklake' | 'datatable';
|
|
4687
|
+
export type AssetKind = 's3object' | 'resource' | 'ducklake' | 'datatable' | 'volume';
|
|
3283
4688
|
export type Asset = {
|
|
3284
4689
|
path: string;
|
|
3285
4690
|
kind: AssetKind;
|
|
3286
4691
|
};
|
|
3287
|
-
export type
|
|
4692
|
+
export type Volume = {
|
|
4693
|
+
name: string;
|
|
4694
|
+
size_bytes: number;
|
|
4695
|
+
file_count: number;
|
|
4696
|
+
created_at: string;
|
|
4697
|
+
created_by: string;
|
|
4698
|
+
updated_at?: (string) | null;
|
|
4699
|
+
last_used_at?: (string) | null;
|
|
4700
|
+
extra_perms?: {
|
|
4701
|
+
[key: string]: unknown;
|
|
4702
|
+
};
|
|
4703
|
+
};
|
|
4704
|
+
/**
|
|
4705
|
+
* A workspace protection rule defining restrictions and bypass permissions
|
|
4706
|
+
*/
|
|
4707
|
+
export type ProtectionRuleset = {
|
|
4708
|
+
/**
|
|
4709
|
+
* Unique name for the protection rule
|
|
4710
|
+
*/
|
|
4711
|
+
name: string;
|
|
4712
|
+
workspace_id?: string;
|
|
4713
|
+
rules: ProtectionRules;
|
|
4714
|
+
bypass_groups: RuleBypasserGroups;
|
|
4715
|
+
bypass_users: RuleBypasserUsers;
|
|
4716
|
+
};
|
|
4717
|
+
/**
|
|
4718
|
+
* Configuration of protection restrictions
|
|
4719
|
+
*/
|
|
4720
|
+
export type ProtectionRules = Array<ProtectionRuleKind>;
|
|
4721
|
+
export type ProtectionRuleKind = 'DisableDirectDeployment' | 'DisableWorkspaceForking';
|
|
4722
|
+
/**
|
|
4723
|
+
* Groups that can bypass this ruleset
|
|
4724
|
+
*/
|
|
4725
|
+
export type RuleBypasserGroups = Array<(string)>;
|
|
4726
|
+
/**
|
|
4727
|
+
* Users that can bypass this ruleset
|
|
4728
|
+
*/
|
|
4729
|
+
export type RuleBypasserUsers = Array<(string)>;
|
|
4730
|
+
export type NativeServiceName = 'nextcloud' | 'google';
|
|
3288
4731
|
/**
|
|
3289
4732
|
* A native trigger stored in Windmill
|
|
3290
4733
|
*/
|
|
@@ -3358,6 +4801,10 @@ export type NativeTriggerWithExternal = {
|
|
|
3358
4801
|
export type WorkspaceIntegrations = {
|
|
3359
4802
|
service_name: NativeServiceName;
|
|
3360
4803
|
oauth_data?: (WorkspaceOAuthConfig) | null;
|
|
4804
|
+
/**
|
|
4805
|
+
* Path to the resource storing the OAuth token
|
|
4806
|
+
*/
|
|
4807
|
+
resource_path?: (string) | null;
|
|
3361
4808
|
};
|
|
3362
4809
|
export type WorkspaceOAuthConfig = {
|
|
3363
4810
|
/**
|
|
@@ -3431,6 +4878,25 @@ export type NextCloudEventType = {
|
|
|
3431
4878
|
category?: string;
|
|
3432
4879
|
path: string;
|
|
3433
4880
|
};
|
|
4881
|
+
export type GoogleCalendarEntry = {
|
|
4882
|
+
id: string;
|
|
4883
|
+
summary: string;
|
|
4884
|
+
primary?: boolean;
|
|
4885
|
+
};
|
|
4886
|
+
export type GoogleDriveFile = {
|
|
4887
|
+
id: string;
|
|
4888
|
+
name: string;
|
|
4889
|
+
mime_type: string;
|
|
4890
|
+
is_folder?: boolean;
|
|
4891
|
+
};
|
|
4892
|
+
export type GoogleDriveFilesResponse = {
|
|
4893
|
+
files: Array<GoogleDriveFile>;
|
|
4894
|
+
next_page_token?: string;
|
|
4895
|
+
};
|
|
4896
|
+
export type SharedDriveEntry = {
|
|
4897
|
+
id: string;
|
|
4898
|
+
name: string;
|
|
4899
|
+
};
|
|
3434
4900
|
export type ParameterId = string;
|
|
3435
4901
|
export type ParameterKey = string;
|
|
3436
4902
|
export type ParameterWorkspaceId = string;
|
|
@@ -3459,23 +4925,23 @@ export type ParameterPage = number;
|
|
|
3459
4925
|
*/
|
|
3460
4926
|
export type ParameterPerPage = number;
|
|
3461
4927
|
/**
|
|
3462
|
-
* trigger kind (schedule,
|
|
4928
|
+
* filter by trigger kind. Supports comma-separated list (e.g. 'schedule,webhook') and negation by prefixing all values with '!' (e.g. '!schedule,!webhook')
|
|
3463
4929
|
*/
|
|
3464
|
-
export type ParameterJobTriggerKind =
|
|
4930
|
+
export type ParameterJobTriggerKind = string;
|
|
3465
4931
|
/**
|
|
3466
4932
|
* order by desc order (default true)
|
|
3467
4933
|
*/
|
|
3468
4934
|
export type ParameterOrderDesc = boolean;
|
|
3469
4935
|
/**
|
|
3470
|
-
*
|
|
4936
|
+
* filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')
|
|
3471
4937
|
*/
|
|
3472
4938
|
export type ParameterCreatedBy = string;
|
|
3473
4939
|
/**
|
|
3474
|
-
*
|
|
4940
|
+
* filter by exact matching job label. Supports comma-separated list (e.g. 'deploy,release') and negation by prefixing all values with '!' (e.g. '!deploy,!release')
|
|
3475
4941
|
*/
|
|
3476
4942
|
export type ParameterLabel = string;
|
|
3477
4943
|
/**
|
|
3478
|
-
* worker this job
|
|
4944
|
+
* filter by worker this job ran on. Supports comma-separated list (e.g. 'worker-1,worker-2') and negation by prefixing all values with '!' (e.g. '!worker-1,!worker-2')
|
|
3479
4945
|
*/
|
|
3480
4946
|
export type ParameterWorker = string;
|
|
3481
4947
|
/**
|
|
@@ -3516,7 +4982,7 @@ export type ParameterSkipPreprocessor = boolean;
|
|
|
3516
4982
|
*/
|
|
3517
4983
|
export type ParameterPayload = string;
|
|
3518
4984
|
/**
|
|
3519
|
-
*
|
|
4985
|
+
* filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2')
|
|
3520
4986
|
*/
|
|
3521
4987
|
export type ParameterScriptStartPath = string;
|
|
3522
4988
|
/**
|
|
@@ -3524,11 +4990,11 @@ export type ParameterScriptStartPath = string;
|
|
|
3524
4990
|
*/
|
|
3525
4991
|
export type ParameterSchedulePath = string;
|
|
3526
4992
|
/**
|
|
3527
|
-
*
|
|
4993
|
+
* filter by trigger path. Supports comma-separated list (e.g. 'f/trigger1,f/trigger2') and negation by prefixing all values with '!' (e.g. '!f/trigger1,!f/trigger2')
|
|
3528
4994
|
*/
|
|
3529
4995
|
export type ParameterTriggerPath = string;
|
|
3530
4996
|
/**
|
|
3531
|
-
*
|
|
4997
|
+
* filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2')
|
|
3532
4998
|
*/
|
|
3533
4999
|
export type ParameterScriptExactPath = string;
|
|
3534
5000
|
/**
|
|
@@ -3596,7 +5062,7 @@ export type ParameterAllowWildcards = boolean;
|
|
|
3596
5062
|
*/
|
|
3597
5063
|
export type ParameterArgsFilter = string;
|
|
3598
5064
|
/**
|
|
3599
|
-
* filter
|
|
5065
|
+
* filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem')
|
|
3600
5066
|
*/
|
|
3601
5067
|
export type ParameterTag = string;
|
|
3602
5068
|
/**
|
|
@@ -3624,7 +5090,7 @@ export type ParameterResourceName = string;
|
|
|
3624
5090
|
*/
|
|
3625
5091
|
export type ParameterActionKind = 'Create' | 'Update' | 'Delete' | 'Execute';
|
|
3626
5092
|
/**
|
|
3627
|
-
* filter
|
|
5093
|
+
* filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies')
|
|
3628
5094
|
*/
|
|
3629
5095
|
export type ParameterJobKinds = string;
|
|
3630
5096
|
export type ParameterRunnableId = string;
|
|
@@ -3634,6 +5100,14 @@ export type ParameterGetStarted = boolean;
|
|
|
3634
5100
|
export type ParameterConcurrencyId = string;
|
|
3635
5101
|
export type ParameterRunnableKind = 'script' | 'flow';
|
|
3636
5102
|
export type BackendVersionResponse = (string);
|
|
5103
|
+
export type GetHealthStatusData = {
|
|
5104
|
+
/**
|
|
5105
|
+
* Force a fresh check, bypassing the cache
|
|
5106
|
+
*/
|
|
5107
|
+
force?: boolean;
|
|
5108
|
+
};
|
|
5109
|
+
export type GetHealthStatusResponse = (HealthStatusResponse);
|
|
5110
|
+
export type GetHealthDetailedResponse = (DetailedHealthResponse);
|
|
3637
5111
|
export type BackendUptodateResponse = (string);
|
|
3638
5112
|
export type GetLicenseIdResponse = (string);
|
|
3639
5113
|
export type QueryDocumentationData = {
|
|
@@ -4024,6 +5498,10 @@ export type TestObjectStorageConfigData = {
|
|
|
4024
5498
|
};
|
|
4025
5499
|
export type TestObjectStorageConfigResponse = (string);
|
|
4026
5500
|
export type SendStatsResponse = (string);
|
|
5501
|
+
export type GetStatsResponse = ({
|
|
5502
|
+
signature?: string;
|
|
5503
|
+
data?: string;
|
|
5504
|
+
});
|
|
4027
5505
|
export type GetLatestKeyRenewalAttemptResponse = ({
|
|
4028
5506
|
result: string;
|
|
4029
5507
|
attempted_at: string;
|
|
@@ -4044,6 +5522,14 @@ export type TestMetadataData = {
|
|
|
4044
5522
|
};
|
|
4045
5523
|
export type TestMetadataResponse = (string);
|
|
4046
5524
|
export type ListGlobalSettingsResponse = (Array<GlobalSetting>);
|
|
5525
|
+
export type GetInstanceConfigResponse = (InstanceConfig);
|
|
5526
|
+
export type SetInstanceConfigData = {
|
|
5527
|
+
/**
|
|
5528
|
+
* full instance configuration to apply
|
|
5529
|
+
*/
|
|
5530
|
+
requestBody: InstanceConfig;
|
|
5531
|
+
};
|
|
5532
|
+
export type SetInstanceConfigResponse = (string);
|
|
4047
5533
|
export type GetMinKeepAliveVersionResponse = ({
|
|
4048
5534
|
/**
|
|
4049
5535
|
* minimum version for normal workers
|
|
@@ -4159,6 +5645,21 @@ export type ImportInstallationData = {
|
|
|
4159
5645
|
workspace: string;
|
|
4160
5646
|
};
|
|
4161
5647
|
export type ImportInstallationResponse = (unknown);
|
|
5648
|
+
export type GhesInstallationCallbackData = {
|
|
5649
|
+
requestBody: {
|
|
5650
|
+
/**
|
|
5651
|
+
* The GitHub App installation ID from GHES
|
|
5652
|
+
*/
|
|
5653
|
+
installation_id: number;
|
|
5654
|
+
};
|
|
5655
|
+
workspace: string;
|
|
5656
|
+
};
|
|
5657
|
+
export type GhesInstallationCallbackResponse = (unknown);
|
|
5658
|
+
export type GetGhesConfigResponse = ({
|
|
5659
|
+
base_url: string;
|
|
5660
|
+
app_slug: string;
|
|
5661
|
+
client_id: string;
|
|
5662
|
+
});
|
|
4162
5663
|
export type AcceptInviteData = {
|
|
4163
5664
|
/**
|
|
4164
5665
|
* accept invite
|
|
@@ -4340,6 +5841,10 @@ export type GetSettingsResponse = ({
|
|
|
4340
5841
|
mute_critical_alerts?: boolean;
|
|
4341
5842
|
color?: string;
|
|
4342
5843
|
operator_settings?: OperatorSettings;
|
|
5844
|
+
/**
|
|
5845
|
+
* Rate limit for public app executions per minute per server. NULL or 0 means disabled.
|
|
5846
|
+
*/
|
|
5847
|
+
public_app_execution_limit_per_minute?: number;
|
|
4343
5848
|
});
|
|
4344
5849
|
export type GetDeployToData = {
|
|
4345
5850
|
workspace: string;
|
|
@@ -4767,6 +6272,7 @@ export type GetUsedTriggersResponse = ({
|
|
|
4767
6272
|
sqs_used: boolean;
|
|
4768
6273
|
email_used: boolean;
|
|
4769
6274
|
nextcloud_used: boolean;
|
|
6275
|
+
google_used: boolean;
|
|
4770
6276
|
});
|
|
4771
6277
|
export type ListUsersData = {
|
|
4772
6278
|
workspace: string;
|
|
@@ -4902,10 +6408,22 @@ export type ExistsVariableData = {
|
|
|
4902
6408
|
};
|
|
4903
6409
|
export type ExistsVariableResponse = (boolean);
|
|
4904
6410
|
export type ListVariableData = {
|
|
6411
|
+
/**
|
|
6412
|
+
* broad search across multiple fields (case-insensitive substring match)
|
|
6413
|
+
*/
|
|
6414
|
+
broadFilter?: string;
|
|
6415
|
+
/**
|
|
6416
|
+
* pattern match filter for description field (case-insensitive)
|
|
6417
|
+
*/
|
|
6418
|
+
description?: string;
|
|
4905
6419
|
/**
|
|
4906
6420
|
* which page to return (start at 1, default 1)
|
|
4907
6421
|
*/
|
|
4908
6422
|
page?: number;
|
|
6423
|
+
/**
|
|
6424
|
+
* exact path match filter
|
|
6425
|
+
*/
|
|
6426
|
+
path?: string;
|
|
4909
6427
|
/**
|
|
4910
6428
|
* filter variables by path prefix
|
|
4911
6429
|
*/
|
|
@@ -4914,6 +6432,10 @@ export type ListVariableData = {
|
|
|
4914
6432
|
* number of items to return for a given page (default 30, max 100)
|
|
4915
6433
|
*/
|
|
4916
6434
|
perPage?: number;
|
|
6435
|
+
/**
|
|
6436
|
+
* pattern match filter for non-secret variable values (case-insensitive)
|
|
6437
|
+
*/
|
|
6438
|
+
value?: string;
|
|
4917
6439
|
workspace: string;
|
|
4918
6440
|
};
|
|
4919
6441
|
export type ListVariableResponse = (Array<ListableVariable>);
|
|
@@ -4922,6 +6444,10 @@ export type ListContextualVariablesData = {
|
|
|
4922
6444
|
};
|
|
4923
6445
|
export type ListContextualVariablesResponse = (Array<ContextualVariable>);
|
|
4924
6446
|
export type GetSecondaryStorageNamesData = {
|
|
6447
|
+
/**
|
|
6448
|
+
* If true, include "_default_" in the list if primary workspace storage is set
|
|
6449
|
+
*/
|
|
6450
|
+
includeDefault?: boolean;
|
|
4925
6451
|
workspace: string;
|
|
4926
6452
|
};
|
|
4927
6453
|
export type GetSecondaryStorageNamesResponse = (Array<(string)>);
|
|
@@ -4967,6 +6493,73 @@ export type WorkspaceMuteCriticalAlertsUiData = {
|
|
|
4967
6493
|
workspace: string;
|
|
4968
6494
|
};
|
|
4969
6495
|
export type WorkspaceMuteCriticalAlertsUiResponse = (string);
|
|
6496
|
+
export type ListProtectionRulesData = {
|
|
6497
|
+
workspace: string;
|
|
6498
|
+
};
|
|
6499
|
+
export type ListProtectionRulesResponse = (Array<ProtectionRuleset>);
|
|
6500
|
+
export type CreateProtectionRuleData = {
|
|
6501
|
+
/**
|
|
6502
|
+
* New protection rule configuration
|
|
6503
|
+
*/
|
|
6504
|
+
requestBody: {
|
|
6505
|
+
/**
|
|
6506
|
+
* Unique name for the protection rule
|
|
6507
|
+
*/
|
|
6508
|
+
name: string;
|
|
6509
|
+
rules: ProtectionRules;
|
|
6510
|
+
bypass_groups: RuleBypasserGroups;
|
|
6511
|
+
bypass_users: RuleBypasserUsers;
|
|
6512
|
+
};
|
|
6513
|
+
workspace: string;
|
|
6514
|
+
};
|
|
6515
|
+
export type CreateProtectionRuleResponse = (string);
|
|
6516
|
+
export type UpdateProtectionRuleData = {
|
|
6517
|
+
/**
|
|
6518
|
+
* Updated protection rule configuration
|
|
6519
|
+
*/
|
|
6520
|
+
requestBody: {
|
|
6521
|
+
rules: ProtectionRules;
|
|
6522
|
+
bypass_groups: RuleBypasserGroups;
|
|
6523
|
+
bypass_users: RuleBypasserUsers;
|
|
6524
|
+
};
|
|
6525
|
+
/**
|
|
6526
|
+
* Name of the protection rule to update
|
|
6527
|
+
*/
|
|
6528
|
+
ruleName: string;
|
|
6529
|
+
workspace: string;
|
|
6530
|
+
};
|
|
6531
|
+
export type UpdateProtectionRuleResponse = (string);
|
|
6532
|
+
export type DeleteProtectionRuleData = {
|
|
6533
|
+
/**
|
|
6534
|
+
* Name of the protection rule to delete
|
|
6535
|
+
*/
|
|
6536
|
+
ruleName: string;
|
|
6537
|
+
workspace: string;
|
|
6538
|
+
};
|
|
6539
|
+
export type DeleteProtectionRuleResponse = (string);
|
|
6540
|
+
export type LogAiChatData = {
|
|
6541
|
+
requestBody: {
|
|
6542
|
+
session_id: string;
|
|
6543
|
+
provider: string;
|
|
6544
|
+
model: string;
|
|
6545
|
+
mode: string;
|
|
6546
|
+
};
|
|
6547
|
+
workspace: string;
|
|
6548
|
+
};
|
|
6549
|
+
export type LogAiChatResponse = (void);
|
|
6550
|
+
export type SetPublicAppRateLimitData = {
|
|
6551
|
+
/**
|
|
6552
|
+
* Public app rate limit configuration
|
|
6553
|
+
*/
|
|
6554
|
+
requestBody: {
|
|
6555
|
+
/**
|
|
6556
|
+
* Rate limit for public app executions per minute per server. NULL or 0 to disable.
|
|
6557
|
+
*/
|
|
6558
|
+
public_app_execution_limit_per_minute?: number;
|
|
6559
|
+
};
|
|
6560
|
+
workspace: string;
|
|
6561
|
+
};
|
|
6562
|
+
export type SetPublicAppRateLimitResponse = (string);
|
|
4970
6563
|
export type LoginWithOauthData = {
|
|
4971
6564
|
clientName: string;
|
|
4972
6565
|
/**
|
|
@@ -5222,10 +6815,22 @@ export type ExistsResourceData = {
|
|
|
5222
6815
|
};
|
|
5223
6816
|
export type ExistsResourceResponse = (boolean);
|
|
5224
6817
|
export type ListResourceData = {
|
|
6818
|
+
/**
|
|
6819
|
+
* broad search across multiple fields (case-insensitive substring match)
|
|
6820
|
+
*/
|
|
6821
|
+
broadFilter?: string;
|
|
6822
|
+
/**
|
|
6823
|
+
* pattern match filter for description field (case-insensitive)
|
|
6824
|
+
*/
|
|
6825
|
+
description?: string;
|
|
5225
6826
|
/**
|
|
5226
6827
|
* which page to return (start at 1, default 1)
|
|
5227
6828
|
*/
|
|
5228
6829
|
page?: number;
|
|
6830
|
+
/**
|
|
6831
|
+
* exact path match filter
|
|
6832
|
+
*/
|
|
6833
|
+
path?: string;
|
|
5229
6834
|
/**
|
|
5230
6835
|
* filter resources by path prefix
|
|
5231
6836
|
*/
|
|
@@ -5242,6 +6847,10 @@ export type ListResourceData = {
|
|
|
5242
6847
|
* resource_types to not list from, separated by ',',
|
|
5243
6848
|
*/
|
|
5244
6849
|
resourceTypeExclude?: string;
|
|
6850
|
+
/**
|
|
6851
|
+
* JSONB subset match filter using base64 encoded JSON
|
|
6852
|
+
*/
|
|
6853
|
+
value?: string;
|
|
5245
6854
|
workspace: string;
|
|
5246
6855
|
};
|
|
5247
6856
|
export type ListResourceResponse = (Array<ListableResource>);
|
|
@@ -5282,7 +6891,12 @@ export type CreateResourceTypeResponse = (string);
|
|
|
5282
6891
|
export type FileResourceTypeToFileExtMapData = {
|
|
5283
6892
|
workspace: string;
|
|
5284
6893
|
};
|
|
5285
|
-
export type FileResourceTypeToFileExtMapResponse = (
|
|
6894
|
+
export type FileResourceTypeToFileExtMapResponse = ({
|
|
6895
|
+
[key: string]: {
|
|
6896
|
+
format_extension?: (string) | null;
|
|
6897
|
+
is_fileset?: boolean;
|
|
6898
|
+
};
|
|
6899
|
+
});
|
|
5286
6900
|
export type DeleteResourceTypeData = {
|
|
5287
6901
|
path: string;
|
|
5288
6902
|
workspace: string;
|
|
@@ -5435,6 +7049,15 @@ export type GetHubAppByIdResponse = ({
|
|
|
5435
7049
|
value: unknown;
|
|
5436
7050
|
};
|
|
5437
7051
|
});
|
|
7052
|
+
export type GetHubRawAppByIdData = {
|
|
7053
|
+
id: number;
|
|
7054
|
+
};
|
|
7055
|
+
export type GetHubRawAppByIdResponse = ({
|
|
7056
|
+
app: {
|
|
7057
|
+
summary: string;
|
|
7058
|
+
value: unknown;
|
|
7059
|
+
};
|
|
7060
|
+
});
|
|
5438
7061
|
export type GetPublicAppByCustomPathData = {
|
|
5439
7062
|
customPath: string;
|
|
5440
7063
|
};
|
|
@@ -5523,7 +7146,7 @@ export type ListSearchScriptResponse = (Array<{
|
|
|
5523
7146
|
}>);
|
|
5524
7147
|
export type ListScriptsData = {
|
|
5525
7148
|
/**
|
|
5526
|
-
*
|
|
7149
|
+
* filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')
|
|
5527
7150
|
*/
|
|
5528
7151
|
createdBy?: string;
|
|
5529
7152
|
/**
|
|
@@ -6433,7 +8056,7 @@ export type ListSearchFlowResponse = (Array<{
|
|
|
6433
8056
|
}>);
|
|
6434
8057
|
export type ListFlowsData = {
|
|
6435
8058
|
/**
|
|
6436
|
-
*
|
|
8059
|
+
* filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')
|
|
6437
8060
|
*/
|
|
6438
8061
|
createdBy?: string;
|
|
6439
8062
|
/**
|
|
@@ -6669,7 +8292,7 @@ export type ListConversationMessagesData = {
|
|
|
6669
8292
|
export type ListConversationMessagesResponse = (Array<FlowConversationMessage>);
|
|
6670
8293
|
export type ListRawAppsData = {
|
|
6671
8294
|
/**
|
|
6672
|
-
*
|
|
8295
|
+
* filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')
|
|
6673
8296
|
*/
|
|
6674
8297
|
createdBy?: string;
|
|
6675
8298
|
/**
|
|
@@ -6701,11 +8324,6 @@ export type ListRawAppsData = {
|
|
|
6701
8324
|
workspace: string;
|
|
6702
8325
|
};
|
|
6703
8326
|
export type ListRawAppsResponse = (Array<ListableRawApp>);
|
|
6704
|
-
export type ExistsRawAppData = {
|
|
6705
|
-
path: string;
|
|
6706
|
-
workspace: string;
|
|
6707
|
-
};
|
|
6708
|
-
export type ExistsRawAppResponse = (boolean);
|
|
6709
8327
|
export type GetRawAppDataData = {
|
|
6710
8328
|
secretWithExtension: string;
|
|
6711
8329
|
workspace: string;
|
|
@@ -6720,7 +8338,7 @@ export type ListSearchAppResponse = (Array<{
|
|
|
6720
8338
|
}>);
|
|
6721
8339
|
export type ListAppsData = {
|
|
6722
8340
|
/**
|
|
6723
|
-
*
|
|
8341
|
+
* filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')
|
|
6724
8342
|
*/
|
|
6725
8343
|
createdBy?: string;
|
|
6726
8344
|
/**
|
|
@@ -6776,6 +8394,10 @@ export type CreateAppData = {
|
|
|
6776
8394
|
draft_only?: boolean;
|
|
6777
8395
|
deployment_message?: string;
|
|
6778
8396
|
custom_path?: string;
|
|
8397
|
+
/**
|
|
8398
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original on_behalf_of value in the policy instead of overwriting it.
|
|
8399
|
+
*/
|
|
8400
|
+
preserve_on_behalf_of?: boolean;
|
|
6779
8401
|
};
|
|
6780
8402
|
workspace: string;
|
|
6781
8403
|
};
|
|
@@ -6793,6 +8415,10 @@ export type CreateAppRawData = {
|
|
|
6793
8415
|
draft_only?: boolean;
|
|
6794
8416
|
deployment_message?: string;
|
|
6795
8417
|
custom_path?: string;
|
|
8418
|
+
/**
|
|
8419
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original on_behalf_of value in the policy instead of overwriting it.
|
|
8420
|
+
*/
|
|
8421
|
+
preserve_on_behalf_of?: boolean;
|
|
6796
8422
|
};
|
|
6797
8423
|
js?: string;
|
|
6798
8424
|
css?: string;
|
|
@@ -6874,36 +8500,6 @@ export type GetAppByVersionData = {
|
|
|
6874
8500
|
workspace: string;
|
|
6875
8501
|
};
|
|
6876
8502
|
export type GetAppByVersionResponse = (AppWithLastVersion);
|
|
6877
|
-
export type CreateRawAppData = {
|
|
6878
|
-
/**
|
|
6879
|
-
* new raw app
|
|
6880
|
-
*/
|
|
6881
|
-
requestBody: {
|
|
6882
|
-
path: string;
|
|
6883
|
-
value: string;
|
|
6884
|
-
summary: string;
|
|
6885
|
-
};
|
|
6886
|
-
workspace: string;
|
|
6887
|
-
};
|
|
6888
|
-
export type CreateRawAppResponse = (string);
|
|
6889
|
-
export type UpdateRawAppData = {
|
|
6890
|
-
path: string;
|
|
6891
|
-
/**
|
|
6892
|
-
* updateraw app
|
|
6893
|
-
*/
|
|
6894
|
-
requestBody: {
|
|
6895
|
-
path?: string;
|
|
6896
|
-
summary?: string;
|
|
6897
|
-
value?: string;
|
|
6898
|
-
};
|
|
6899
|
-
workspace: string;
|
|
6900
|
-
};
|
|
6901
|
-
export type UpdateRawAppResponse = (string);
|
|
6902
|
-
export type DeleteRawAppData = {
|
|
6903
|
-
path: string;
|
|
6904
|
-
workspace: string;
|
|
6905
|
-
};
|
|
6906
|
-
export type DeleteRawAppResponse = (string);
|
|
6907
8503
|
export type DeleteAppData = {
|
|
6908
8504
|
path: string;
|
|
6909
8505
|
workspace: string;
|
|
@@ -6921,6 +8517,10 @@ export type UpdateAppData = {
|
|
|
6921
8517
|
policy?: Policy;
|
|
6922
8518
|
deployment_message?: string;
|
|
6923
8519
|
custom_path?: string;
|
|
8520
|
+
/**
|
|
8521
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original on_behalf_of value in the policy instead of overwriting it.
|
|
8522
|
+
*/
|
|
8523
|
+
preserve_on_behalf_of?: boolean;
|
|
6924
8524
|
};
|
|
6925
8525
|
workspace: string;
|
|
6926
8526
|
};
|
|
@@ -6937,6 +8537,10 @@ export type UpdateAppRawData = {
|
|
|
6937
8537
|
policy?: Policy;
|
|
6938
8538
|
deployment_message?: string;
|
|
6939
8539
|
custom_path?: string;
|
|
8540
|
+
/**
|
|
8541
|
+
* When true and the caller is a member of the 'wm_deployers' group, preserves the original on_behalf_of value in the policy instead of overwriting it.
|
|
8542
|
+
*/
|
|
8543
|
+
preserve_on_behalf_of?: boolean;
|
|
6940
8544
|
};
|
|
6941
8545
|
js?: string;
|
|
6942
8546
|
css?: string;
|
|
@@ -7273,6 +8877,24 @@ export type RunScriptPreviewInlineData = {
|
|
|
7273
8877
|
workspace: string;
|
|
7274
8878
|
};
|
|
7275
8879
|
export type RunScriptPreviewInlineResponse = (unknown);
|
|
8880
|
+
export type RunScriptByPathInlineData = {
|
|
8881
|
+
path: string;
|
|
8882
|
+
/**
|
|
8883
|
+
* script args
|
|
8884
|
+
*/
|
|
8885
|
+
requestBody: InlineScriptArgs;
|
|
8886
|
+
workspace: string;
|
|
8887
|
+
};
|
|
8888
|
+
export type RunScriptByPathInlineResponse = (unknown);
|
|
8889
|
+
export type RunScriptByHashInlineData = {
|
|
8890
|
+
hash: string;
|
|
8891
|
+
/**
|
|
8892
|
+
* script args
|
|
8893
|
+
*/
|
|
8894
|
+
requestBody: InlineScriptArgs;
|
|
8895
|
+
workspace: string;
|
|
8896
|
+
};
|
|
8897
|
+
export type RunScriptByHashInlineResponse = (unknown);
|
|
7276
8898
|
export type RunScriptPreviewAndWaitResultData = {
|
|
7277
8899
|
/**
|
|
7278
8900
|
* preview
|
|
@@ -7364,7 +8986,7 @@ export type ListQueueData = {
|
|
|
7364
8986
|
*/
|
|
7365
8987
|
args?: string;
|
|
7366
8988
|
/**
|
|
7367
|
-
*
|
|
8989
|
+
* filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')
|
|
7368
8990
|
*/
|
|
7369
8991
|
createdBy?: string;
|
|
7370
8992
|
/**
|
|
@@ -7372,7 +8994,7 @@ export type ListQueueData = {
|
|
|
7372
8994
|
*/
|
|
7373
8995
|
isNotSchedule?: boolean;
|
|
7374
8996
|
/**
|
|
7375
|
-
* filter
|
|
8997
|
+
* filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies')
|
|
7376
8998
|
*/
|
|
7377
8999
|
jobKinds?: string;
|
|
7378
9000
|
/**
|
|
@@ -7412,11 +9034,11 @@ export type ListQueueData = {
|
|
|
7412
9034
|
*/
|
|
7413
9035
|
scriptHash?: string;
|
|
7414
9036
|
/**
|
|
7415
|
-
*
|
|
9037
|
+
* filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2')
|
|
7416
9038
|
*/
|
|
7417
9039
|
scriptPathExact?: string;
|
|
7418
9040
|
/**
|
|
7419
|
-
*
|
|
9041
|
+
* filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2')
|
|
7420
9042
|
*/
|
|
7421
9043
|
scriptPathStart?: string;
|
|
7422
9044
|
/**
|
|
@@ -7436,19 +9058,19 @@ export type ListQueueData = {
|
|
|
7436
9058
|
*/
|
|
7437
9059
|
suspended?: boolean;
|
|
7438
9060
|
/**
|
|
7439
|
-
* filter
|
|
9061
|
+
* filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem')
|
|
7440
9062
|
*/
|
|
7441
9063
|
tag?: string;
|
|
7442
9064
|
/**
|
|
7443
|
-
* trigger kind (schedule,
|
|
9065
|
+
* filter by trigger kind. Supports comma-separated list (e.g. 'schedule,webhook') and negation by prefixing all values with '!' (e.g. '!schedule,!webhook')
|
|
7444
9066
|
*/
|
|
7445
|
-
triggerKind?:
|
|
9067
|
+
triggerKind?: string;
|
|
7446
9068
|
/**
|
|
7447
|
-
*
|
|
9069
|
+
* filter by trigger path. Supports comma-separated list (e.g. 'f/trigger1,f/trigger2') and negation by prefixing all values with '!' (e.g. '!f/trigger1,!f/trigger2')
|
|
7448
9070
|
*/
|
|
7449
9071
|
triggerPath?: string;
|
|
7450
9072
|
/**
|
|
7451
|
-
* worker this job
|
|
9073
|
+
* filter by worker this job ran on. Supports comma-separated list (e.g. 'worker-1,worker-2') and negation by prefixing all values with '!' (e.g. '!worker-1,!worker-2')
|
|
7452
9074
|
*/
|
|
7453
9075
|
worker?: string;
|
|
7454
9076
|
workspace: string;
|
|
@@ -7513,7 +9135,7 @@ export type ListFilteredJobsUuidsData = {
|
|
|
7513
9135
|
*/
|
|
7514
9136
|
createdBeforeQueue?: string;
|
|
7515
9137
|
/**
|
|
7516
|
-
*
|
|
9138
|
+
* filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')
|
|
7517
9139
|
*/
|
|
7518
9140
|
createdBy?: string;
|
|
7519
9141
|
/**
|
|
@@ -7533,11 +9155,11 @@ export type ListFilteredJobsUuidsData = {
|
|
|
7533
9155
|
*/
|
|
7534
9156
|
isSkipped?: boolean;
|
|
7535
9157
|
/**
|
|
7536
|
-
* filter
|
|
9158
|
+
* filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies')
|
|
7537
9159
|
*/
|
|
7538
9160
|
jobKinds?: string;
|
|
7539
9161
|
/**
|
|
7540
|
-
*
|
|
9162
|
+
* filter by exact matching job label. Supports comma-separated list (e.g. 'deploy,release') and negation by prefixing all values with '!' (e.g. '!deploy,!release')
|
|
7541
9163
|
*/
|
|
7542
9164
|
label?: string;
|
|
7543
9165
|
/**
|
|
@@ -7573,11 +9195,11 @@ export type ListFilteredJobsUuidsData = {
|
|
|
7573
9195
|
*/
|
|
7574
9196
|
scriptHash?: string;
|
|
7575
9197
|
/**
|
|
7576
|
-
*
|
|
9198
|
+
* filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2')
|
|
7577
9199
|
*/
|
|
7578
9200
|
scriptPathExact?: string;
|
|
7579
9201
|
/**
|
|
7580
|
-
*
|
|
9202
|
+
* filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2')
|
|
7581
9203
|
*/
|
|
7582
9204
|
scriptPathStart?: string;
|
|
7583
9205
|
/**
|
|
@@ -7597,11 +9219,11 @@ export type ListFilteredJobsUuidsData = {
|
|
|
7597
9219
|
*/
|
|
7598
9220
|
suspended?: boolean;
|
|
7599
9221
|
/**
|
|
7600
|
-
* filter
|
|
9222
|
+
* filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem')
|
|
7601
9223
|
*/
|
|
7602
9224
|
tag?: string;
|
|
7603
9225
|
/**
|
|
7604
|
-
* worker this job
|
|
9226
|
+
* filter by worker this job ran on. Supports comma-separated list (e.g. 'worker-1,worker-2') and negation by prefixing all values with '!' (e.g. '!worker-1,!worker-2')
|
|
7605
9227
|
*/
|
|
7606
9228
|
worker?: string;
|
|
7607
9229
|
workspace: string;
|
|
@@ -7622,7 +9244,7 @@ export type ListFilteredQueueUuidsData = {
|
|
|
7622
9244
|
args?: string;
|
|
7623
9245
|
concurrencyKey?: string;
|
|
7624
9246
|
/**
|
|
7625
|
-
*
|
|
9247
|
+
* filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')
|
|
7626
9248
|
*/
|
|
7627
9249
|
createdBy?: string;
|
|
7628
9250
|
/**
|
|
@@ -7630,7 +9252,7 @@ export type ListFilteredQueueUuidsData = {
|
|
|
7630
9252
|
*/
|
|
7631
9253
|
isNotSchedule?: boolean;
|
|
7632
9254
|
/**
|
|
7633
|
-
* filter
|
|
9255
|
+
* filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies')
|
|
7634
9256
|
*/
|
|
7635
9257
|
jobKinds?: string;
|
|
7636
9258
|
/**
|
|
@@ -7670,11 +9292,11 @@ export type ListFilteredQueueUuidsData = {
|
|
|
7670
9292
|
*/
|
|
7671
9293
|
scriptHash?: string;
|
|
7672
9294
|
/**
|
|
7673
|
-
*
|
|
9295
|
+
* filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2')
|
|
7674
9296
|
*/
|
|
7675
9297
|
scriptPathExact?: string;
|
|
7676
9298
|
/**
|
|
7677
|
-
*
|
|
9299
|
+
* filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2')
|
|
7678
9300
|
*/
|
|
7679
9301
|
scriptPathStart?: string;
|
|
7680
9302
|
/**
|
|
@@ -7694,7 +9316,7 @@ export type ListFilteredQueueUuidsData = {
|
|
|
7694
9316
|
*/
|
|
7695
9317
|
suspended?: boolean;
|
|
7696
9318
|
/**
|
|
7697
|
-
* filter
|
|
9319
|
+
* filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem')
|
|
7698
9320
|
*/
|
|
7699
9321
|
tag?: string;
|
|
7700
9322
|
workspace: string;
|
|
@@ -7768,7 +9390,7 @@ export type ListCompletedJobsData = {
|
|
|
7768
9390
|
*/
|
|
7769
9391
|
args?: string;
|
|
7770
9392
|
/**
|
|
7771
|
-
*
|
|
9393
|
+
* filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')
|
|
7772
9394
|
*/
|
|
7773
9395
|
createdBy?: string;
|
|
7774
9396
|
/**
|
|
@@ -7788,11 +9410,11 @@ export type ListCompletedJobsData = {
|
|
|
7788
9410
|
*/
|
|
7789
9411
|
isSkipped?: boolean;
|
|
7790
9412
|
/**
|
|
7791
|
-
* filter
|
|
9413
|
+
* filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies')
|
|
7792
9414
|
*/
|
|
7793
9415
|
jobKinds?: string;
|
|
7794
9416
|
/**
|
|
7795
|
-
*
|
|
9417
|
+
* filter by exact matching job label. Supports comma-separated list (e.g. 'deploy,release') and negation by prefixing all values with '!' (e.g. '!deploy,!release')
|
|
7796
9418
|
*/
|
|
7797
9419
|
label?: string;
|
|
7798
9420
|
/**
|
|
@@ -7824,11 +9446,11 @@ export type ListCompletedJobsData = {
|
|
|
7824
9446
|
*/
|
|
7825
9447
|
scriptHash?: string;
|
|
7826
9448
|
/**
|
|
7827
|
-
*
|
|
9449
|
+
* filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2')
|
|
7828
9450
|
*/
|
|
7829
9451
|
scriptPathExact?: string;
|
|
7830
9452
|
/**
|
|
7831
|
-
*
|
|
9453
|
+
* filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2')
|
|
7832
9454
|
*/
|
|
7833
9455
|
scriptPathStart?: string;
|
|
7834
9456
|
/**
|
|
@@ -7844,11 +9466,11 @@ export type ListCompletedJobsData = {
|
|
|
7844
9466
|
*/
|
|
7845
9467
|
success?: boolean;
|
|
7846
9468
|
/**
|
|
7847
|
-
* filter
|
|
9469
|
+
* filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem')
|
|
7848
9470
|
*/
|
|
7849
9471
|
tag?: string;
|
|
7850
9472
|
/**
|
|
7851
|
-
* worker this job
|
|
9473
|
+
* filter by worker this job ran on. Supports comma-separated list (e.g. 'worker-1,worker-2') and negation by prefixing all values with '!' (e.g. '!worker-1,!worker-2')
|
|
7852
9474
|
*/
|
|
7853
9475
|
worker?: string;
|
|
7854
9476
|
workspace: string;
|
|
@@ -7906,6 +9528,10 @@ export type ListJobsData = {
|
|
|
7906
9528
|
* filter on jobs containing those args as a json subset (@> in postgres)
|
|
7907
9529
|
*/
|
|
7908
9530
|
args?: string;
|
|
9531
|
+
/**
|
|
9532
|
+
* broad search across multiple fields (case-insensitive substring match on path, tag, schedule path, trigger kind, label)
|
|
9533
|
+
*/
|
|
9534
|
+
broadFilter?: string;
|
|
7909
9535
|
/**
|
|
7910
9536
|
* filter on started after (exclusive) timestamp
|
|
7911
9537
|
*/
|
|
@@ -7931,7 +9557,7 @@ export type ListJobsData = {
|
|
|
7931
9557
|
*/
|
|
7932
9558
|
createdBeforeQueue?: string;
|
|
7933
9559
|
/**
|
|
7934
|
-
*
|
|
9560
|
+
* filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')
|
|
7935
9561
|
*/
|
|
7936
9562
|
createdBy?: string;
|
|
7937
9563
|
/**
|
|
@@ -7951,11 +9577,11 @@ export type ListJobsData = {
|
|
|
7951
9577
|
*/
|
|
7952
9578
|
isSkipped?: boolean;
|
|
7953
9579
|
/**
|
|
7954
|
-
* filter
|
|
9580
|
+
* filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies')
|
|
7955
9581
|
*/
|
|
7956
9582
|
jobKinds?: string;
|
|
7957
9583
|
/**
|
|
7958
|
-
*
|
|
9584
|
+
* filter by exact matching job label. Supports comma-separated list (e.g. 'deploy,release') and negation by prefixing all values with '!' (e.g. '!deploy,!release')
|
|
7959
9585
|
*/
|
|
7960
9586
|
label?: string;
|
|
7961
9587
|
/**
|
|
@@ -7987,11 +9613,11 @@ export type ListJobsData = {
|
|
|
7987
9613
|
*/
|
|
7988
9614
|
scriptHash?: string;
|
|
7989
9615
|
/**
|
|
7990
|
-
*
|
|
9616
|
+
* filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2')
|
|
7991
9617
|
*/
|
|
7992
9618
|
scriptPathExact?: string;
|
|
7993
9619
|
/**
|
|
7994
|
-
*
|
|
9620
|
+
* filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2')
|
|
7995
9621
|
*/
|
|
7996
9622
|
scriptPathStart?: string;
|
|
7997
9623
|
/**
|
|
@@ -8011,15 +9637,15 @@ export type ListJobsData = {
|
|
|
8011
9637
|
*/
|
|
8012
9638
|
suspended?: boolean;
|
|
8013
9639
|
/**
|
|
8014
|
-
* filter
|
|
9640
|
+
* filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem')
|
|
8015
9641
|
*/
|
|
8016
9642
|
tag?: string;
|
|
8017
9643
|
/**
|
|
8018
|
-
* trigger kind (schedule,
|
|
9644
|
+
* filter by trigger kind. Supports comma-separated list (e.g. 'schedule,webhook') and negation by prefixing all values with '!' (e.g. '!schedule,!webhook')
|
|
8019
9645
|
*/
|
|
8020
|
-
triggerKind?:
|
|
9646
|
+
triggerKind?: string;
|
|
8021
9647
|
/**
|
|
8022
|
-
* worker this job
|
|
9648
|
+
* filter by worker this job ran on. Supports comma-separated list (e.g. 'worker-1,worker-2') and negation by prefixing all values with '!' (e.g. '!worker-1,!worker-2')
|
|
8023
9649
|
*/
|
|
8024
9650
|
worker?: string;
|
|
8025
9651
|
workspace: string;
|
|
@@ -8229,24 +9855,28 @@ export type GetResumeUrlsResponse = ({
|
|
|
8229
9855
|
});
|
|
8230
9856
|
export type GetSlackApprovalPayloadData = {
|
|
8231
9857
|
approver?: string;
|
|
9858
|
+
cancelButtonText?: string;
|
|
8232
9859
|
channelId: string;
|
|
8233
9860
|
defaultArgsJson?: string;
|
|
8234
9861
|
dynamicEnumsJson?: string;
|
|
8235
9862
|
flowStepId: string;
|
|
8236
9863
|
id: string;
|
|
8237
9864
|
message?: string;
|
|
9865
|
+
resumeButtonText?: string;
|
|
8238
9866
|
slackResourcePath: string;
|
|
8239
9867
|
workspace: string;
|
|
8240
9868
|
};
|
|
8241
9869
|
export type GetSlackApprovalPayloadResponse = (unknown);
|
|
8242
9870
|
export type GetTeamsApprovalPayloadData = {
|
|
8243
9871
|
approver?: string;
|
|
9872
|
+
cancelButtonText?: string;
|
|
8244
9873
|
channelName: string;
|
|
8245
9874
|
defaultArgsJson?: string;
|
|
8246
9875
|
dynamicEnumsJson?: string;
|
|
8247
9876
|
flowStepId: string;
|
|
8248
9877
|
id: string;
|
|
8249
9878
|
message?: string;
|
|
9879
|
+
resumeButtonText?: string;
|
|
8250
9880
|
teamName: string;
|
|
8251
9881
|
workspace: string;
|
|
8252
9882
|
};
|
|
@@ -8392,6 +10022,14 @@ export type ListSchedulesData = {
|
|
|
8392
10022
|
* filter on jobs containing those args as a json subset (@> in postgres)
|
|
8393
10023
|
*/
|
|
8394
10024
|
args?: string;
|
|
10025
|
+
/**
|
|
10026
|
+
* broad search across multiple fields (case-insensitive substring match)
|
|
10027
|
+
*/
|
|
10028
|
+
broadFilter?: string;
|
|
10029
|
+
/**
|
|
10030
|
+
* pattern match filter for description field (case-insensitive)
|
|
10031
|
+
*/
|
|
10032
|
+
description?: string;
|
|
8395
10033
|
/**
|
|
8396
10034
|
* filter schedules by whether they target a flow
|
|
8397
10035
|
*/
|
|
@@ -8401,7 +10039,7 @@ export type ListSchedulesData = {
|
|
|
8401
10039
|
*/
|
|
8402
10040
|
page?: number;
|
|
8403
10041
|
/**
|
|
8404
|
-
* filter by path
|
|
10042
|
+
* filter by path (script path)
|
|
8405
10043
|
*/
|
|
8406
10044
|
path?: string;
|
|
8407
10045
|
/**
|
|
@@ -8412,6 +10050,14 @@ export type ListSchedulesData = {
|
|
|
8412
10050
|
* number of items to return for a given page (default 30, max 100)
|
|
8413
10051
|
*/
|
|
8414
10052
|
perPage?: number;
|
|
10053
|
+
/**
|
|
10054
|
+
* exact match on the schedule's path
|
|
10055
|
+
*/
|
|
10056
|
+
schedulePath?: string;
|
|
10057
|
+
/**
|
|
10058
|
+
* pattern match filter for summary field (case-insensitive)
|
|
10059
|
+
*/
|
|
10060
|
+
summary?: string;
|
|
8415
10061
|
workspace: string;
|
|
8416
10062
|
};
|
|
8417
10063
|
export type ListSchedulesResponse = (Array<Schedule>);
|
|
@@ -8686,6 +10332,24 @@ export type TestKafkaConnectionData = {
|
|
|
8686
10332
|
workspace: string;
|
|
8687
10333
|
};
|
|
8688
10334
|
export type TestKafkaConnectionResponse = (string);
|
|
10335
|
+
export type ResetKafkaOffsetsData = {
|
|
10336
|
+
path: string;
|
|
10337
|
+
workspace: string;
|
|
10338
|
+
};
|
|
10339
|
+
export type ResetKafkaOffsetsResponse = (unknown);
|
|
10340
|
+
export type CommitKafkaOffsetsData = {
|
|
10341
|
+
path: string;
|
|
10342
|
+
/**
|
|
10343
|
+
* offsets to commit
|
|
10344
|
+
*/
|
|
10345
|
+
requestBody: {
|
|
10346
|
+
topic: string;
|
|
10347
|
+
partition: number;
|
|
10348
|
+
offset: number;
|
|
10349
|
+
};
|
|
10350
|
+
workspace: string;
|
|
10351
|
+
};
|
|
10352
|
+
export type CommitKafkaOffsetsResponse = (unknown);
|
|
8689
10353
|
export type CreateNatsTriggerData = {
|
|
8690
10354
|
/**
|
|
8691
10355
|
* new nats trigger
|
|
@@ -8859,19 +10523,36 @@ export type GenerateNativeTriggerServiceConnectUrlData = {
|
|
|
8859
10523
|
workspace: string;
|
|
8860
10524
|
};
|
|
8861
10525
|
export type GenerateNativeTriggerServiceConnectUrlResponse = (string);
|
|
10526
|
+
export type CheckInstanceSharingAvailableData = {
|
|
10527
|
+
serviceName: NativeServiceName;
|
|
10528
|
+
workspace: string;
|
|
10529
|
+
};
|
|
10530
|
+
export type CheckInstanceSharingAvailableResponse = (boolean);
|
|
10531
|
+
export type GenerateInstanceConnectUrlData = {
|
|
10532
|
+
/**
|
|
10533
|
+
* redirect_uri
|
|
10534
|
+
*/
|
|
10535
|
+
requestBody: RedirectUri;
|
|
10536
|
+
serviceName: NativeServiceName;
|
|
10537
|
+
workspace: string;
|
|
10538
|
+
};
|
|
10539
|
+
export type GenerateInstanceConnectUrlResponse = (string);
|
|
8862
10540
|
export type DeleteNativeTriggerServiceData = {
|
|
8863
10541
|
serviceName: NativeServiceName;
|
|
8864
10542
|
workspace: string;
|
|
8865
10543
|
};
|
|
8866
10544
|
export type DeleteNativeTriggerServiceResponse = (string);
|
|
8867
10545
|
export type NativeTriggerServiceCallbackData = {
|
|
8868
|
-
code: string;
|
|
8869
10546
|
/**
|
|
8870
|
-
*
|
|
10547
|
+
* OAuth callback data
|
|
8871
10548
|
*/
|
|
8872
|
-
requestBody:
|
|
10549
|
+
requestBody: {
|
|
10550
|
+
code: string;
|
|
10551
|
+
state: string;
|
|
10552
|
+
redirect_uri: string;
|
|
10553
|
+
resource_path?: string;
|
|
10554
|
+
};
|
|
8873
10555
|
serviceName: NativeServiceName;
|
|
8874
|
-
state: string;
|
|
8875
10556
|
workspace: string;
|
|
8876
10557
|
};
|
|
8877
10558
|
export type NativeTriggerServiceCallbackResponse = (string);
|
|
@@ -8954,6 +10635,34 @@ export type ListNextCloudEventsData = {
|
|
|
8954
10635
|
workspace: string;
|
|
8955
10636
|
};
|
|
8956
10637
|
export type ListNextCloudEventsResponse = (Array<NextCloudEventType>);
|
|
10638
|
+
export type ListGoogleCalendarsData = {
|
|
10639
|
+
workspace: string;
|
|
10640
|
+
};
|
|
10641
|
+
export type ListGoogleCalendarsResponse = (Array<GoogleCalendarEntry>);
|
|
10642
|
+
export type ListGoogleDriveFilesData = {
|
|
10643
|
+
/**
|
|
10644
|
+
* token for next page of results
|
|
10645
|
+
*/
|
|
10646
|
+
pageToken?: string;
|
|
10647
|
+
/**
|
|
10648
|
+
* folder ID to list children of
|
|
10649
|
+
*/
|
|
10650
|
+
parentId?: string;
|
|
10651
|
+
/**
|
|
10652
|
+
* search query to filter files by name
|
|
10653
|
+
*/
|
|
10654
|
+
q?: string;
|
|
10655
|
+
/**
|
|
10656
|
+
* if true, list files shared with the user
|
|
10657
|
+
*/
|
|
10658
|
+
sharedWithMe?: boolean;
|
|
10659
|
+
workspace: string;
|
|
10660
|
+
};
|
|
10661
|
+
export type ListGoogleDriveFilesResponse = (GoogleDriveFilesResponse);
|
|
10662
|
+
export type ListGoogleSharedDrivesData = {
|
|
10663
|
+
workspace: string;
|
|
10664
|
+
};
|
|
10665
|
+
export type ListGoogleSharedDrivesResponse = (Array<SharedDriveEntry>);
|
|
8957
10666
|
export type NativeTriggerWebhookData = {
|
|
8958
10667
|
/**
|
|
8959
10668
|
* The internal database ID of the trigger
|
|
@@ -9379,7 +11088,7 @@ export type ListInstanceGroupsWithWorkspacesResponse = (Array<InstanceGroupWithW
|
|
|
9379
11088
|
export type GetInstanceGroupData = {
|
|
9380
11089
|
name: string;
|
|
9381
11090
|
};
|
|
9382
|
-
export type GetInstanceGroupResponse = (
|
|
11091
|
+
export type GetInstanceGroupResponse = (InstanceGroupWithWorkspaces);
|
|
9383
11092
|
export type CreateInstanceGroupData = {
|
|
9384
11093
|
/**
|
|
9385
11094
|
* create instance group
|
|
@@ -9397,6 +11106,10 @@ export type UpdateInstanceGroupData = {
|
|
|
9397
11106
|
*/
|
|
9398
11107
|
requestBody: {
|
|
9399
11108
|
new_summary: string;
|
|
11109
|
+
/**
|
|
11110
|
+
* Instance-level role for group members. 'superadmin', 'devops', 'user' or empty to clear.
|
|
11111
|
+
*/
|
|
11112
|
+
instance_role?: (string) | null;
|
|
9400
11113
|
};
|
|
9401
11114
|
};
|
|
9402
11115
|
export type UpdateInstanceGroupResponse = (string);
|
|
@@ -9785,7 +11498,7 @@ export type ListBlacklistedAgentTokensResponse = (Array<{
|
|
|
9785
11498
|
}>);
|
|
9786
11499
|
export type GetMinVersionResponse = (string);
|
|
9787
11500
|
export type GetGranularAclsData = {
|
|
9788
|
-
kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app' | 'http_trigger' | 'websocket_trigger' | 'kafka_trigger' | 'nats_trigger' | 'postgres_trigger' | 'mqtt_trigger' | 'gcp_trigger' | 'sqs_trigger' | 'email_trigger';
|
|
11501
|
+
kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app' | 'http_trigger' | 'websocket_trigger' | 'kafka_trigger' | 'nats_trigger' | 'postgres_trigger' | 'mqtt_trigger' | 'gcp_trigger' | 'sqs_trigger' | 'email_trigger' | 'volume';
|
|
9789
11502
|
path: string;
|
|
9790
11503
|
workspace: string;
|
|
9791
11504
|
};
|
|
@@ -9793,7 +11506,7 @@ export type GetGranularAclsResponse = ({
|
|
|
9793
11506
|
[key: string]: (boolean);
|
|
9794
11507
|
});
|
|
9795
11508
|
export type AddGranularAclsData = {
|
|
9796
|
-
kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app' | 'http_trigger' | 'websocket_trigger' | 'kafka_trigger' | 'nats_trigger' | 'postgres_trigger' | 'mqtt_trigger' | 'gcp_trigger' | 'sqs_trigger' | 'email_trigger';
|
|
11509
|
+
kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app' | 'http_trigger' | 'websocket_trigger' | 'kafka_trigger' | 'nats_trigger' | 'postgres_trigger' | 'mqtt_trigger' | 'gcp_trigger' | 'sqs_trigger' | 'email_trigger' | 'volume';
|
|
9797
11510
|
path: string;
|
|
9798
11511
|
/**
|
|
9799
11512
|
* acl to add
|
|
@@ -9806,7 +11519,7 @@ export type AddGranularAclsData = {
|
|
|
9806
11519
|
};
|
|
9807
11520
|
export type AddGranularAclsResponse = (string);
|
|
9808
11521
|
export type RemoveGranularAclsData = {
|
|
9809
|
-
kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app' | 'http_trigger' | 'websocket_trigger' | 'kafka_trigger' | 'nats_trigger' | 'postgres_trigger' | 'mqtt_trigger' | 'gcp_trigger' | 'sqs_trigger' | 'email_trigger';
|
|
11522
|
+
kind: 'script' | 'group_' | 'resource' | 'schedule' | 'variable' | 'flow' | 'folder' | 'app' | 'raw_app' | 'http_trigger' | 'websocket_trigger' | 'kafka_trigger' | 'nats_trigger' | 'postgres_trigger' | 'mqtt_trigger' | 'gcp_trigger' | 'sqs_trigger' | 'email_trigger' | 'volume';
|
|
9810
11523
|
path: string;
|
|
9811
11524
|
/**
|
|
9812
11525
|
* acl to add
|
|
@@ -9887,7 +11600,7 @@ export type DeleteCaptureResponse = (unknown);
|
|
|
9887
11600
|
export type StarData = {
|
|
9888
11601
|
requestBody?: {
|
|
9889
11602
|
path?: string;
|
|
9890
|
-
favorite_kind?: 'flow' | 'app' | 'script' | 'raw_app';
|
|
11603
|
+
favorite_kind?: 'flow' | 'app' | 'script' | 'raw_app' | 'asset';
|
|
9891
11604
|
};
|
|
9892
11605
|
workspace: string;
|
|
9893
11606
|
};
|
|
@@ -9895,7 +11608,7 @@ export type StarResponse = (unknown);
|
|
|
9895
11608
|
export type UnstarData = {
|
|
9896
11609
|
requestBody?: {
|
|
9897
11610
|
path?: string;
|
|
9898
|
-
favorite_kind?: 'flow' | 'app' | 'script' | 'raw_app';
|
|
11611
|
+
favorite_kind?: 'flow' | 'app' | 'script' | 'raw_app' | 'asset';
|
|
9899
11612
|
};
|
|
9900
11613
|
workspace: string;
|
|
9901
11614
|
};
|
|
@@ -10321,7 +12034,7 @@ export type ListExtendedJobsData = {
|
|
|
10321
12034
|
*/
|
|
10322
12035
|
createdBeforeQueue?: string;
|
|
10323
12036
|
/**
|
|
10324
|
-
*
|
|
12037
|
+
* filter by exact matching user creator. Supports comma-separated list (e.g. 'alice,bob') and negation by prefixing all values with '!' (e.g. '!alice,!bob')
|
|
10325
12038
|
*/
|
|
10326
12039
|
createdBy?: string;
|
|
10327
12040
|
/**
|
|
@@ -10341,11 +12054,11 @@ export type ListExtendedJobsData = {
|
|
|
10341
12054
|
*/
|
|
10342
12055
|
isSkipped?: boolean;
|
|
10343
12056
|
/**
|
|
10344
|
-
* filter
|
|
12057
|
+
* filter by job kind. Supports comma-separated list of values ('preview', 'script', 'dependencies', 'flow') and negation by prefixing all values with '!' (e.g. '!preview,!dependencies')
|
|
10345
12058
|
*/
|
|
10346
12059
|
jobKinds?: string;
|
|
10347
12060
|
/**
|
|
10348
|
-
*
|
|
12061
|
+
* filter by exact matching job label. Supports comma-separated list (e.g. 'deploy,release') and negation by prefixing all values with '!' (e.g. '!deploy,!release')
|
|
10349
12062
|
*/
|
|
10350
12063
|
label?: string;
|
|
10351
12064
|
/**
|
|
@@ -10382,11 +12095,11 @@ export type ListExtendedJobsData = {
|
|
|
10382
12095
|
*/
|
|
10383
12096
|
scriptHash?: string;
|
|
10384
12097
|
/**
|
|
10385
|
-
*
|
|
12098
|
+
* filter by exact matching script path. Supports comma-separated list (e.g. 'f/script1,f/script2') and negation by prefixing all values with '!' (e.g. '!f/script1,!f/script2')
|
|
10386
12099
|
*/
|
|
10387
12100
|
scriptPathExact?: string;
|
|
10388
12101
|
/**
|
|
10389
|
-
*
|
|
12102
|
+
* filter by script path prefix. Supports comma-separated list (e.g. 'f/folder1,f/folder2') and negation by prefixing all values with '!' (e.g. '!f/folder1,!f/folder2')
|
|
10390
12103
|
*/
|
|
10391
12104
|
scriptPathStart?: string;
|
|
10392
12105
|
/**
|
|
@@ -10402,13 +12115,13 @@ export type ListExtendedJobsData = {
|
|
|
10402
12115
|
*/
|
|
10403
12116
|
success?: boolean;
|
|
10404
12117
|
/**
|
|
10405
|
-
* filter
|
|
12118
|
+
* filter by tag/worker group. Supports comma-separated list (e.g. 'gpu,highmem') and negation by prefixing all values with '!' (e.g. '!gpu,!highmem')
|
|
10406
12119
|
*/
|
|
10407
12120
|
tag?: string;
|
|
10408
12121
|
/**
|
|
10409
|
-
* trigger kind (schedule,
|
|
12122
|
+
* filter by trigger kind. Supports comma-separated list (e.g. 'schedule,webhook') and negation by prefixing all values with '!' (e.g. '!schedule,!webhook')
|
|
10410
12123
|
*/
|
|
10411
|
-
triggerKind?:
|
|
12124
|
+
triggerKind?: string;
|
|
10412
12125
|
workspace: string;
|
|
10413
12126
|
};
|
|
10414
12127
|
export type ListExtendedJobsResponse = (ExtendedJobs);
|
|
@@ -10442,6 +12155,10 @@ export type SearchJobsIndexResponse = ({
|
|
|
10442
12155
|
* Is the current indexer service being replaced
|
|
10443
12156
|
*/
|
|
10444
12157
|
lost_lock_ownership?: boolean;
|
|
12158
|
+
/**
|
|
12159
|
+
* Maximum time window in seconds for indexing
|
|
12160
|
+
*/
|
|
12161
|
+
max_index_time_window_secs?: number;
|
|
10445
12162
|
};
|
|
10446
12163
|
});
|
|
10447
12164
|
export type SearchLogsIndexData = {
|
|
@@ -10483,6 +12200,36 @@ export type ClearIndexData = {
|
|
|
10483
12200
|
idxName: 'JobIndex' | 'ServiceLogIndex';
|
|
10484
12201
|
};
|
|
10485
12202
|
export type ClearIndexResponse = (string);
|
|
12203
|
+
export type GetIndexStorageSizesResponse = ({
|
|
12204
|
+
job_index?: {
|
|
12205
|
+
disk_size_bytes?: (number) | null;
|
|
12206
|
+
s3_size_bytes?: (number) | null;
|
|
12207
|
+
};
|
|
12208
|
+
service_log_index?: {
|
|
12209
|
+
disk_size_bytes?: (number) | null;
|
|
12210
|
+
s3_size_bytes?: (number) | null;
|
|
12211
|
+
};
|
|
12212
|
+
});
|
|
12213
|
+
export type GetIndexerStatusResponse = ({
|
|
12214
|
+
job_indexer?: {
|
|
12215
|
+
is_alive?: boolean;
|
|
12216
|
+
last_locked_at?: (string) | null;
|
|
12217
|
+
owner?: (string) | null;
|
|
12218
|
+
storage?: {
|
|
12219
|
+
disk_size_bytes?: (number) | null;
|
|
12220
|
+
s3_size_bytes?: (number) | null;
|
|
12221
|
+
};
|
|
12222
|
+
};
|
|
12223
|
+
log_indexer?: {
|
|
12224
|
+
is_alive?: boolean;
|
|
12225
|
+
last_locked_at?: (string) | null;
|
|
12226
|
+
owner?: (string) | null;
|
|
12227
|
+
storage?: {
|
|
12228
|
+
disk_size_bytes?: (number) | null;
|
|
12229
|
+
s3_size_bytes?: (number) | null;
|
|
12230
|
+
};
|
|
12231
|
+
};
|
|
12232
|
+
});
|
|
10486
12233
|
export type ListAssetsData = {
|
|
10487
12234
|
/**
|
|
10488
12235
|
* Filter by asset kinds (multiple values allowed)
|
|
@@ -10492,6 +12239,14 @@ export type ListAssetsData = {
|
|
|
10492
12239
|
* Filter by asset path (case-insensitive partial match)
|
|
10493
12240
|
*/
|
|
10494
12241
|
assetPath?: string;
|
|
12242
|
+
/**
|
|
12243
|
+
* broad search across multiple fields (case-insensitive substring match)
|
|
12244
|
+
*/
|
|
12245
|
+
broadFilter?: string;
|
|
12246
|
+
/**
|
|
12247
|
+
* JSONB subset match filter for columns using base64 encoded JSON
|
|
12248
|
+
*/
|
|
12249
|
+
columns?: string;
|
|
10495
12250
|
/**
|
|
10496
12251
|
* Cursor timestamp for pagination (created_at of last item from previous page)
|
|
10497
12252
|
*/
|
|
@@ -10500,6 +12255,10 @@ export type ListAssetsData = {
|
|
|
10500
12255
|
* Cursor ID for pagination (id of last item from previous page)
|
|
10501
12256
|
*/
|
|
10502
12257
|
cursorId?: number;
|
|
12258
|
+
/**
|
|
12259
|
+
* exact path match filter
|
|
12260
|
+
*/
|
|
12261
|
+
path?: string;
|
|
10503
12262
|
/**
|
|
10504
12263
|
* Number of items per page (max 1000, default 50)
|
|
10505
12264
|
*/
|
|
@@ -10518,6 +12277,12 @@ export type ListAssetsResponse = ({
|
|
|
10518
12277
|
path: string;
|
|
10519
12278
|
kind: AssetUsageKind;
|
|
10520
12279
|
access_type?: AssetUsageAccessType;
|
|
12280
|
+
/**
|
|
12281
|
+
* The columns used (for tables)
|
|
12282
|
+
*/
|
|
12283
|
+
columns?: {
|
|
12284
|
+
[key: string]: AssetUsageAccessType;
|
|
12285
|
+
};
|
|
10521
12286
|
/**
|
|
10522
12287
|
* When the asset was detected
|
|
10523
12288
|
*/
|
|
@@ -10571,6 +12336,35 @@ export type ListAssetsByUsageResponse = (Array<Array<{
|
|
|
10571
12336
|
kind: AssetKind;
|
|
10572
12337
|
access_type?: AssetUsageAccessType;
|
|
10573
12338
|
}>>);
|
|
12339
|
+
export type ListFavoriteAssetsData = {
|
|
12340
|
+
workspace: string;
|
|
12341
|
+
};
|
|
12342
|
+
export type ListFavoriteAssetsResponse = (Array<{
|
|
12343
|
+
/**
|
|
12344
|
+
* The asset path
|
|
12345
|
+
*/
|
|
12346
|
+
path: string;
|
|
12347
|
+
}>);
|
|
12348
|
+
export type ListVolumesData = {
|
|
12349
|
+
workspace: string;
|
|
12350
|
+
};
|
|
12351
|
+
export type ListVolumesResponse = (Array<Volume>);
|
|
12352
|
+
export type GetVolumeStorageData = {
|
|
12353
|
+
workspace: string;
|
|
12354
|
+
};
|
|
12355
|
+
export type GetVolumeStorageResponse = ((string) | null);
|
|
12356
|
+
export type CreateVolumeData = {
|
|
12357
|
+
requestBody: {
|
|
12358
|
+
name: string;
|
|
12359
|
+
};
|
|
12360
|
+
workspace: string;
|
|
12361
|
+
};
|
|
12362
|
+
export type CreateVolumeResponse = (string);
|
|
12363
|
+
export type DeleteVolumeData = {
|
|
12364
|
+
name: string;
|
|
12365
|
+
workspace: string;
|
|
12366
|
+
};
|
|
12367
|
+
export type DeleteVolumeResponse = (string);
|
|
10574
12368
|
export type ListMcpToolsData = {
|
|
10575
12369
|
workspace: string;
|
|
10576
12370
|
};
|