@alvera-ai/platform-sdk 0.15.0 → 0.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.agent/ai_agents.md +1 -0
- package/.agent/cookbook/_setup/foundation.md +62 -0
- package/.agent/cookbook/_setup/healthcare.md +62 -0
- package/.agent/cookbook/_setup/payments.md +62 -0
- package/.agent/cookbook/_setup/subscription.md +62 -0
- package/.agent/cookbook/appointment-review-sms-workflow.md +16 -8
- package/.agent/cookbook/birthday-greeting-sms-trigger.md +11 -5
- package/.agent/cookbook/contact-us-triage-with-llm.md +11 -5
- package/.agent/cookbook/dunning-sms-for-delinquent.md +16 -8
- package/.agent/cookbook/kyc-notification-on-account-activation.md +16 -8
- package/.agent/cookbook/marketing-campaign-send.md +13 -7
- package/.agent/cookbook/sanctions-screening-with-agent-review.md +11 -5
- package/.agent/cookbook/score-leads-with-llm-categorization.md +11 -5
- package/.agent/cookbook/triage-prospects-by-priority.md +11 -5
- package/.agent/cookbook/welcome-sms-for-customers.md +16 -8
- package/.agent/errors.md +7 -1
- package/.agent/interoperability_contracts.md +58 -0
- package/.agent/tools.md +98 -4
- package/.agent/workflows.md +137 -38
- package/dist/index.d.mts +966 -153
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +133 -5
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -2
package/dist/index.d.mts
CHANGED
|
@@ -277,17 +277,17 @@ type DatalakeCloudStorageCustomResponse = CloudStorageCustomResponse & {
|
|
|
277
277
|
*/
|
|
278
278
|
type AgenticWorkflowResponse = {
|
|
279
279
|
/**
|
|
280
|
-
* Decision actions
|
|
280
|
+
* Decision actions attached to this workflow (response — includes id, workflow_id and timestamps)
|
|
281
281
|
*/
|
|
282
|
-
actions?: Array<ActionResponse>;
|
|
282
|
+
readonly actions?: Array<ActionResponse>;
|
|
283
283
|
/**
|
|
284
284
|
* SHA-256 drift fingerprint over authored fields (server-computed)
|
|
285
285
|
*/
|
|
286
286
|
readonly checksum?: string;
|
|
287
287
|
/**
|
|
288
|
-
* Context-enrichment datasets loaded before the decision stage
|
|
288
|
+
* Context-enrichment datasets loaded before the decision stage (response — includes id, workflow_id and timestamps)
|
|
289
289
|
*/
|
|
290
|
-
context_datasets?: Array<ContextDatasetResponse>;
|
|
290
|
+
readonly context_datasets?: Array<ContextDatasetResponse>;
|
|
291
291
|
datalake?: DatalakeResponse;
|
|
292
292
|
/**
|
|
293
293
|
* Dataset type the workflow listens on (e.g. patient, appointment, generic_table)
|
|
@@ -327,6 +327,10 @@ type AgenticWorkflowResponse = {
|
|
|
327
327
|
* Workflow status. live = auto-fired by event sampling; draft = preview only (dry-run); manual = never auto-fired, but runs for real when an operator explicitly invokes it.
|
|
328
328
|
*/
|
|
329
329
|
status: 'live' | 'draft' | 'manual';
|
|
330
|
+
/**
|
|
331
|
+
* Operator-authored labels. Free text — no taxonomy, no shared vocabulary. Not read by the execution pipeline, but they DO participate in the workflow checksum, so retagging shifts the drift fingerprint. REQUIRED on every write. Send `[]` for an untagged workflow — deliberately no default, so an omitted key is a 422 rather than a silent reset to empty.
|
|
332
|
+
*/
|
|
333
|
+
tags: Array<string>;
|
|
330
334
|
/**
|
|
331
335
|
* Last update timestamp
|
|
332
336
|
*/
|
|
@@ -354,6 +358,24 @@ type ManualToolInvocationResponse = {
|
|
|
354
358
|
* Creation timestamp
|
|
355
359
|
*/
|
|
356
360
|
readonly inserted_at?: string;
|
|
361
|
+
/**
|
|
362
|
+
* Provider response payload on success (provider-specific). SQL try-it returns `rows`, `row_count` and `truncated`; other providers return their own shape.
|
|
363
|
+
*/
|
|
364
|
+
readonly result?: {
|
|
365
|
+
/**
|
|
366
|
+
* SQL try-it only — number of rows in `rows`.
|
|
367
|
+
*/
|
|
368
|
+
row_count?: number;
|
|
369
|
+
/**
|
|
370
|
+
* SQL try-it only — result rows, each an array of column values.
|
|
371
|
+
*/
|
|
372
|
+
rows?: Array<Array<unknown>>;
|
|
373
|
+
/**
|
|
374
|
+
* SQL try-it only — `true` when the preview filled its 100-row window, meaning this is a partial view and the query returns at least this many rows. Render it as a partial result, never as the complete answer.
|
|
375
|
+
*/
|
|
376
|
+
truncated?: boolean;
|
|
377
|
+
[key: string]: unknown;
|
|
378
|
+
} | null;
|
|
357
379
|
/**
|
|
358
380
|
* Execution status — server-set. `pending` is the initial state, `success`/`error` reflect provider response.
|
|
359
381
|
*/
|
|
@@ -368,7 +390,9 @@ type ManualToolInvocationResponse = {
|
|
|
368
390
|
tool_call_type: 'restapi_request';
|
|
369
391
|
} & ManualToolInvocationRestCallResponse) | ({
|
|
370
392
|
tool_call_type: 'aws_lambda_request';
|
|
371
|
-
} & ManualToolInvocationAwsLambdaCallResponse)
|
|
393
|
+
} & ManualToolInvocationAwsLambdaCallResponse) | ({
|
|
394
|
+
tool_call_type: 'sql_query';
|
|
395
|
+
} & ManualToolInvocationSqlQueryCallResponse);
|
|
372
396
|
/**
|
|
373
397
|
* Last update timestamp
|
|
374
398
|
*/
|
|
@@ -471,7 +495,7 @@ type ComplexTemplateConfigRequest = {
|
|
|
471
495
|
/**
|
|
472
496
|
* DataActivationClientLogResponse
|
|
473
497
|
*
|
|
474
|
-
* One log row per `(batch_id, dataset_table)`. A batch fans out into one log per dataset table — so a single run (one `batch_id`) produces multiple log rows, one per table the DAC writes into. `output_files` carries
|
|
498
|
+
* One log row per `(batch_id, dataset_table)`. A batch fans out into one log per dataset table — so a single run (one `batch_id`) produces multiple log rows, one per table the DAC writes into. Once `BatchMergeWorker` has finished, `output_files` carries one entry per bucket mode, each an `object_key` — a cloud-storage key, not a URL. To read an archive, presign the key with `POST /datalakes/{datalake_slug}/download-link`.
|
|
475
499
|
*/
|
|
476
500
|
type DataActivationClientLogResponse = {
|
|
477
501
|
/**
|
|
@@ -490,6 +514,10 @@ type DataActivationClientLogResponse = {
|
|
|
490
514
|
* Number of existing rows whose checksum changed (trigger-maintained)
|
|
491
515
|
*/
|
|
492
516
|
dataset_updated?: number;
|
|
517
|
+
/**
|
|
518
|
+
* Structured failure reason when `status` is `failed`; null otherwise.
|
|
519
|
+
*/
|
|
520
|
+
readonly error?: string | null;
|
|
493
521
|
/**
|
|
494
522
|
* Run log ID
|
|
495
523
|
*/
|
|
@@ -507,6 +535,10 @@ type DataActivationClientLogResponse = {
|
|
|
507
535
|
* Total source rows ingested by this slice of the batch
|
|
508
536
|
*/
|
|
509
537
|
rows_ingested?: number;
|
|
538
|
+
/**
|
|
539
|
+
* `failed` when the batch died before enqueueing any row — the fetch itself errored. `rows_ingested` and `input_files` are 0/[] on such a row; read `error` for the reason.
|
|
540
|
+
*/
|
|
541
|
+
status?: 'succeeded' | 'failed';
|
|
510
542
|
readonly updated_at?: string;
|
|
511
543
|
};
|
|
512
544
|
/**
|
|
@@ -623,6 +655,81 @@ type IngestRequest = {
|
|
|
623
655
|
[key: string]: unknown;
|
|
624
656
|
};
|
|
625
657
|
};
|
|
658
|
+
/**
|
|
659
|
+
* WorkflowRunResponse
|
|
660
|
+
*
|
|
661
|
+
* A workflow invocation scheduled for a caller-chosen time. Every manual
|
|
662
|
+
* invocation creates one, including an immediate send, which is simply
|
|
663
|
+
* `scheduled_at` = now — there is no separate run-now path.
|
|
664
|
+
*
|
|
665
|
+
* A run is not a workflow run log. The run is the intent and is cancellable
|
|
666
|
+
* while `scheduled`; the run log is the outcome it produces, and run logs also
|
|
667
|
+
* arrive from Data Activation Client ingestion with no run behind them.
|
|
668
|
+
*
|
|
669
|
+
* The segment is resolved when the run **fires**, not when it is scheduled.
|
|
670
|
+
* `matched_count` is the preview the operator saw; the audience is whatever
|
|
671
|
+
* `execution_user_search_id` resolved to at send time, minus suppressed and
|
|
672
|
+
* unreachable records.
|
|
673
|
+
*
|
|
674
|
+
*/
|
|
675
|
+
type WorkflowRunResponse = {
|
|
676
|
+
/**
|
|
677
|
+
* Batch identifier for correlating with the workflow run log. Null until the run fires.
|
|
678
|
+
*/
|
|
679
|
+
readonly batch_id?: string | null;
|
|
680
|
+
/**
|
|
681
|
+
* When the run reached a terminal state.
|
|
682
|
+
*/
|
|
683
|
+
readonly completed_at?: string | null;
|
|
684
|
+
/**
|
|
685
|
+
* The search actually resolved when the run fired — its results are the audience that received the send. Null until the run fires; never the same row as `preview_user_search_id`.
|
|
686
|
+
*/
|
|
687
|
+
readonly execution_user_search_id?: string | null;
|
|
688
|
+
/**
|
|
689
|
+
* Why the run could not fan out, when status is 'failed'.
|
|
690
|
+
*/
|
|
691
|
+
readonly failure_reason?: string | null;
|
|
692
|
+
/**
|
|
693
|
+
* When the fan-out began. Null until the run fires.
|
|
694
|
+
*/
|
|
695
|
+
readonly fired_at?: string | null;
|
|
696
|
+
/**
|
|
697
|
+
* Workflow run ID
|
|
698
|
+
*/
|
|
699
|
+
readonly id?: string;
|
|
700
|
+
/**
|
|
701
|
+
* Bypasses dedupe and idempotency checks for every record this run matches.
|
|
702
|
+
*/
|
|
703
|
+
manual_override?: boolean;
|
|
704
|
+
/**
|
|
705
|
+
* Audience size previewed at schedule time. NOT the number that received the send — the segment is resolved again when the run fires, and suppressed records are excluded then.
|
|
706
|
+
*/
|
|
707
|
+
readonly matched_count?: number | null;
|
|
708
|
+
/**
|
|
709
|
+
* 'live' fires real tool calls; 'dry_run' runs the pipeline without making external calls.
|
|
710
|
+
*/
|
|
711
|
+
mode?: 'live' | 'dry_run';
|
|
712
|
+
/**
|
|
713
|
+
* The resolved search this run was scheduled against. Create it with `POST /datasets/:dataset/user-searches`; its `results_count` becomes this run's `matched_count`.
|
|
714
|
+
*/
|
|
715
|
+
preview_user_search_id: string;
|
|
716
|
+
/**
|
|
717
|
+
* When this run fires, in UTC. An immediate send is simply now. Each action still passes through the workflow's action window, so an action may execute later than this.
|
|
718
|
+
*/
|
|
719
|
+
scheduled_at: string;
|
|
720
|
+
/**
|
|
721
|
+
* Run state. Cancellation is refused once processing.
|
|
722
|
+
*/
|
|
723
|
+
readonly status?: 'scheduled' | 'processing' | 'completed' | 'cancelled' | 'failed';
|
|
724
|
+
/**
|
|
725
|
+
* The workflow this run invokes
|
|
726
|
+
*/
|
|
727
|
+
readonly workflow_id?: string;
|
|
728
|
+
/**
|
|
729
|
+
* The run log this run produced. Null until the run fires.
|
|
730
|
+
*/
|
|
731
|
+
readonly workflow_run_log_id?: string | null;
|
|
732
|
+
};
|
|
626
733
|
/**
|
|
627
734
|
* ToolIntent
|
|
628
735
|
*
|
|
@@ -1720,6 +1827,12 @@ type ActionStatusUpdaterRefreshRequest = {
|
|
|
1720
1827
|
updater_body_type: 'ActionStatusUpdaterCloudWatchQueryRequest';
|
|
1721
1828
|
} & ActionStatusUpdaterCloudWatchQueryRequest) | null;
|
|
1722
1829
|
};
|
|
1830
|
+
/**
|
|
1831
|
+
* ToolTwilioRequest
|
|
1832
|
+
*/
|
|
1833
|
+
type ToolTwilioRequest = TwilioRequest & {
|
|
1834
|
+
tool_body_type: 'twilio';
|
|
1835
|
+
};
|
|
1723
1836
|
/**
|
|
1724
1837
|
* WorkflowAiAgentResponse
|
|
1725
1838
|
*
|
|
@@ -2013,6 +2126,18 @@ type ManualUploadCallResponse = {
|
|
|
2013
2126
|
type ActionStatusUpdaterRestCallResponse = RestCallResponse & {
|
|
2014
2127
|
updater_body_type: 'restapi_request';
|
|
2015
2128
|
};
|
|
2129
|
+
/**
|
|
2130
|
+
* WorkflowRunListResponse
|
|
2131
|
+
*
|
|
2132
|
+
* Paginated list of workflow runs
|
|
2133
|
+
*/
|
|
2134
|
+
type WorkflowRunListResponse = {
|
|
2135
|
+
/**
|
|
2136
|
+
* List of workflow runs
|
|
2137
|
+
*/
|
|
2138
|
+
data: Array<WorkflowRunResponse>;
|
|
2139
|
+
meta: PaginationMeta;
|
|
2140
|
+
};
|
|
2016
2141
|
/**
|
|
2017
2142
|
* MinimalAiAgentResponse
|
|
2018
2143
|
*
|
|
@@ -2141,6 +2266,21 @@ type DatasetSearchResponse = {
|
|
|
2141
2266
|
};
|
|
2142
2267
|
user_search: UserSearchResponse;
|
|
2143
2268
|
};
|
|
2269
|
+
/**
|
|
2270
|
+
* InvitationRequest
|
|
2271
|
+
*
|
|
2272
|
+
* Pending tenant invitation — resolved into a Membership on accept. Request
|
|
2273
|
+
*/
|
|
2274
|
+
type InvitationRequest = {
|
|
2275
|
+
/**
|
|
2276
|
+
* Recipient email address. Must be unique per tenant.
|
|
2277
|
+
*/
|
|
2278
|
+
email: string;
|
|
2279
|
+
/**
|
|
2280
|
+
* Tenant-membership role to grant on acceptance. NOT the platform-wide `User.role` enum — `tenant_admin` here is a tenant-scoped admin, not a platform admin.
|
|
2281
|
+
*/
|
|
2282
|
+
role: 'member' | 'researcher' | 'admin';
|
|
2283
|
+
};
|
|
2144
2284
|
/**
|
|
2145
2285
|
* ActionAWSLambdaCallResponse
|
|
2146
2286
|
*/
|
|
@@ -2190,10 +2330,18 @@ type EndUserMessagingResponse = {
|
|
|
2190
2330
|
* Origination phone number or identity in E.164 format (e.g., +15551234567); must be MMS-capable
|
|
2191
2331
|
*/
|
|
2192
2332
|
phone_number: string;
|
|
2333
|
+
/**
|
|
2334
|
+
* ID of the primary End User Messaging tool supplying credentials; required when variant_type is variant
|
|
2335
|
+
*/
|
|
2336
|
+
primary_tool_id?: string | null;
|
|
2193
2337
|
/**
|
|
2194
2338
|
* AWS region (e.g., us-west-2)
|
|
2195
2339
|
*/
|
|
2196
2340
|
region: string;
|
|
2341
|
+
/**
|
|
2342
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
2343
|
+
*/
|
|
2344
|
+
variant_type?: 'primary' | 'variant';
|
|
2197
2345
|
};
|
|
2198
2346
|
/**
|
|
2199
2347
|
* ToolS3Response
|
|
@@ -2543,6 +2691,33 @@ type SftpResponse = {
|
|
|
2543
2691
|
type ToolSnsResponse = SnsResponse & {
|
|
2544
2692
|
tool_body_type: 'sns';
|
|
2545
2693
|
};
|
|
2694
|
+
/**
|
|
2695
|
+
* UserSearchRequest
|
|
2696
|
+
*
|
|
2697
|
+
* User SQL search resource. Created via `POST /datasets/:dataset/user-searches`
|
|
2698
|
+
* with a `WHERE`-clause body in `search_query`; the platform executes
|
|
2699
|
+
* `INSERT INTO search_results SELECT … WHERE <body>` to populate
|
|
2700
|
+
* `search_results` and reports back `status`, `results_count`, and
|
|
2701
|
+
* `error_message`.
|
|
2702
|
+
*
|
|
2703
|
+
* UserSearch carries no `data_access_mode` of its own — the capability check
|
|
2704
|
+
* runs at query time via `Platform.RegulatedDatalakeRepo.prepare_query/3`,
|
|
2705
|
+
* which reads the ambient session and raises 403 when the ceiling is
|
|
2706
|
+
* insufficient. ExOpenApiUtils derives `UserSearchRequest` (writeable subset)
|
|
2707
|
+
* and `UserSearchResponse` (full readable shape) from this declaration via
|
|
2708
|
+
* the readOnly/writeOnly markers on each property.
|
|
2709
|
+
* Request
|
|
2710
|
+
*/
|
|
2711
|
+
type UserSearchRequest = {
|
|
2712
|
+
/**
|
|
2713
|
+
* Generic-table identifier. Required when the dataset is a generic table; must be omitted otherwise.
|
|
2714
|
+
*/
|
|
2715
|
+
generic_table_id?: string | null;
|
|
2716
|
+
/**
|
|
2717
|
+
* SQL `WHERE`-clause body. The platform wraps it in `INSERT INTO search_results SELECT … WHERE <body>`. Reference the table aliases exposed by the dataset's base decomposed query (see `GET /datasets/:dataset_type/metadata`).
|
|
2718
|
+
*/
|
|
2719
|
+
search_query: string;
|
|
2720
|
+
};
|
|
2546
2721
|
/**
|
|
2547
2722
|
* AdminApiKeyResponse
|
|
2548
2723
|
*
|
|
@@ -2700,6 +2875,10 @@ type RunWorkflowRequest = {
|
|
|
2700
2875
|
* Execution mode. 'live' fires real tool calls; 'dry_run' runs the full pipeline without making external calls.
|
|
2701
2876
|
*/
|
|
2702
2877
|
mode?: 'live' | 'dry_run';
|
|
2878
|
+
/**
|
|
2879
|
+
* When the run should fire, as an ISO-8601 timestamp **with an offset** (e.g. "2026-08-12T09:00:00Z"). Omit to fire as soon as a worker picks it up. The segment is resolved when the run fires, not when it is scheduled, so a run scheduled for Friday reaches Friday's matches. Each action still passes through the workflow's action window, so an action may execute later than this.
|
|
2880
|
+
*/
|
|
2881
|
+
scheduled_at?: string | null;
|
|
2703
2882
|
/**
|
|
2704
2883
|
* SQL WHERE clause to filter dataset records (e.g. "status = 'active'")
|
|
2705
2884
|
*/
|
|
@@ -2810,6 +2989,8 @@ type ToolResponse = {
|
|
|
2810
2989
|
} & ToolEmailResponse) | ({
|
|
2811
2990
|
tool_body_type: 'sns';
|
|
2812
2991
|
} & ToolSnsResponse) | ({
|
|
2992
|
+
tool_body_type: 'twilio';
|
|
2993
|
+
} & ToolTwilioResponse) | ({
|
|
2813
2994
|
tool_body_type: 'end_user_messaging';
|
|
2814
2995
|
} & ToolEndUserMessagingResponse) | ({
|
|
2815
2996
|
tool_body_type: 'rest_api';
|
|
@@ -2900,6 +3081,12 @@ type DataSourceListResponse = {
|
|
|
2900
3081
|
data: Array<DataSourceResponse>;
|
|
2901
3082
|
meta: PaginationMeta;
|
|
2902
3083
|
};
|
|
3084
|
+
/**
|
|
3085
|
+
* ActionManualUploadCallRequest
|
|
3086
|
+
*/
|
|
3087
|
+
type ActionManualUploadCallRequest = ManualUploadCallRequest & {
|
|
3088
|
+
tool_call_type: 'manual_upload';
|
|
3089
|
+
};
|
|
2903
3090
|
/**
|
|
2904
3091
|
* SharePointExcelCallResponse
|
|
2905
3092
|
*
|
|
@@ -2954,10 +3141,18 @@ type SnsResponse = {
|
|
|
2954
3141
|
* Origination phone number in E.164 format (e.g., +15551234567)
|
|
2955
3142
|
*/
|
|
2956
3143
|
phone_number: string;
|
|
3144
|
+
/**
|
|
3145
|
+
* ID of the primary SNS tool supplying credentials; required when variant_type is variant
|
|
3146
|
+
*/
|
|
3147
|
+
primary_tool_id?: string | null;
|
|
2957
3148
|
/**
|
|
2958
3149
|
* AWS region (e.g., us-east-1)
|
|
2959
3150
|
*/
|
|
2960
3151
|
region: string;
|
|
3152
|
+
/**
|
|
3153
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
3154
|
+
*/
|
|
3155
|
+
variant_type?: 'primary' | 'variant';
|
|
2961
3156
|
};
|
|
2962
3157
|
/**
|
|
2963
3158
|
* InteroperabilityContractAiAgentResponse
|
|
@@ -3133,6 +3328,12 @@ type ToolListResponse = {
|
|
|
3133
3328
|
data: Array<ToolResponse>;
|
|
3134
3329
|
meta: PaginationMeta;
|
|
3135
3330
|
};
|
|
3331
|
+
/**
|
|
3332
|
+
* ManualToolInvocationSQLQueryCallResponse
|
|
3333
|
+
*/
|
|
3334
|
+
type ManualToolInvocationSqlQueryCallResponse = SqlQueryCallResponse & {
|
|
3335
|
+
tool_call_type: 'sql_query';
|
|
3336
|
+
};
|
|
3136
3337
|
/**
|
|
3137
3338
|
* SQSResponse
|
|
3138
3339
|
*
|
|
@@ -3220,6 +3421,10 @@ type EmailResponse = {
|
|
|
3220
3421
|
* Default sender display name
|
|
3221
3422
|
*/
|
|
3222
3423
|
from_name?: string | null;
|
|
3424
|
+
/**
|
|
3425
|
+
* ID of the primary Email tool supplying credentials; required when variant_type is variant
|
|
3426
|
+
*/
|
|
3427
|
+
primary_tool_id?: string | null;
|
|
3223
3428
|
/**
|
|
3224
3429
|
* Email provider (mock = in-process dev mailbox, no credentials)
|
|
3225
3430
|
*/
|
|
@@ -3244,6 +3449,10 @@ type EmailResponse = {
|
|
|
3244
3449
|
* SMTP username
|
|
3245
3450
|
*/
|
|
3246
3451
|
smtp_username?: string;
|
|
3452
|
+
/**
|
|
3453
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
3454
|
+
*/
|
|
3455
|
+
variant_type?: 'primary' | 'variant';
|
|
3247
3456
|
};
|
|
3248
3457
|
/**
|
|
3249
3458
|
* ManualToolInvocationMMSCallResponse
|
|
@@ -3530,21 +3739,34 @@ type DatalakeListResponse = {
|
|
|
3530
3739
|
/**
|
|
3531
3740
|
* RunWorkflowResponse
|
|
3532
3741
|
*
|
|
3533
|
-
*
|
|
3742
|
+
* Acknowledgement that a run has been scheduled.
|
|
3743
|
+
*
|
|
3744
|
+
* **Changed in 0.23.0.** This endpoint used to run the workflow inline and
|
|
3745
|
+
* return `enqueued_count`, `batch_id` and `workflow_run_log_id`. It now records
|
|
3746
|
+
* a workflow run and returns immediately, so none of those three are knowable
|
|
3747
|
+
* yet: the segment is resolved when the run fires, and the batch it produces
|
|
3748
|
+
* does not exist until then. Read them from the run via
|
|
3749
|
+
* `GET /tenants/{tenant_slug}/datalakes/{datalake_slug}/workflow-runs/{id}`
|
|
3750
|
+
* once its status leaves `scheduled`.
|
|
3751
|
+
*
|
|
3534
3752
|
*/
|
|
3535
3753
|
type RunWorkflowResponse = {
|
|
3536
3754
|
/**
|
|
3537
|
-
*
|
|
3755
|
+
* How many records the clause matched **when it was scheduled**. A preview for sanity-checking the clause, not the audience: the segment is resolved again at send time, and suppressed records are excluded then.
|
|
3538
3756
|
*/
|
|
3539
|
-
|
|
3757
|
+
matched_count?: number | null;
|
|
3758
|
+
/**
|
|
3759
|
+
* When the run will fire. Echoes the requested time, or the time the request was received when none was given.
|
|
3760
|
+
*/
|
|
3761
|
+
scheduled_at: string;
|
|
3540
3762
|
/**
|
|
3541
|
-
*
|
|
3763
|
+
* Run state at the moment of this response — always `scheduled` here.
|
|
3542
3764
|
*/
|
|
3543
|
-
|
|
3765
|
+
status: 'scheduled' | 'processing' | 'completed' | 'cancelled' | 'failed';
|
|
3544
3766
|
/**
|
|
3545
|
-
*
|
|
3767
|
+
* The scheduled run. Use it to poll status, or to cancel while still `scheduled`.
|
|
3546
3768
|
*/
|
|
3547
|
-
|
|
3769
|
+
workflow_run_id: string;
|
|
3548
3770
|
};
|
|
3549
3771
|
/**
|
|
3550
3772
|
* ExecuteActionResponse
|
|
@@ -3619,6 +3841,42 @@ type ExecuteSqlResponse = {
|
|
|
3619
3841
|
type ToolCloudWatchLogGroupResponse = CloudWatchLogGroupResponse & {
|
|
3620
3842
|
tool_body_type: 'cloud_watch_log_group';
|
|
3621
3843
|
};
|
|
3844
|
+
/**
|
|
3845
|
+
* TwilioRequest
|
|
3846
|
+
*
|
|
3847
|
+
* Twilio tool configuration for sending SMS via the Programmable Messaging API. A primary holds the account credential; a variant names its primary and carries only its own sender identity. Request
|
|
3848
|
+
*/
|
|
3849
|
+
type TwilioRequest = {
|
|
3850
|
+
/**
|
|
3851
|
+
* Twilio Account SID (required on a primary; supplied by the primary on a variant)
|
|
3852
|
+
*/
|
|
3853
|
+
account_sid?: string | null;
|
|
3854
|
+
base_message?: ComplexTemplateConfigRequest;
|
|
3855
|
+
/**
|
|
3856
|
+
* Custom Twilio API base URL (e.g., http://localhost:8080 for WireMock); leave blank for https://api.twilio.com
|
|
3857
|
+
*/
|
|
3858
|
+
base_url?: string | null;
|
|
3859
|
+
/**
|
|
3860
|
+
* Origination phone number in E.164 format (e.g., +15551234567)
|
|
3861
|
+
*/
|
|
3862
|
+
from_number?: string | null;
|
|
3863
|
+
/**
|
|
3864
|
+
* Twilio Messaging Service SID, used instead of a from_number
|
|
3865
|
+
*/
|
|
3866
|
+
messaging_service_sid?: string | null;
|
|
3867
|
+
/**
|
|
3868
|
+
* ID of the primary Twilio tool supplying credentials; required when variant_type is variant
|
|
3869
|
+
*/
|
|
3870
|
+
primary_tool_id?: string | null;
|
|
3871
|
+
/**
|
|
3872
|
+
* Request timeout in milliseconds (1–300000)
|
|
3873
|
+
*/
|
|
3874
|
+
timeout_ms?: number | null;
|
|
3875
|
+
/**
|
|
3876
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
3877
|
+
*/
|
|
3878
|
+
variant_type: 'primary' | 'variant';
|
|
3879
|
+
};
|
|
3622
3880
|
/**
|
|
3623
3881
|
* CloudWatchQueryRequest
|
|
3624
3882
|
*
|
|
@@ -3715,6 +3973,24 @@ type InteroperabilityContractListResponse = {
|
|
|
3715
3973
|
type ToolEndUserMessagingResponse = EndUserMessagingResponse & {
|
|
3716
3974
|
tool_body_type: 'end_user_messaging';
|
|
3717
3975
|
};
|
|
3976
|
+
/**
|
|
3977
|
+
* TenantRequest
|
|
3978
|
+
*
|
|
3979
|
+
* Tenant resource. The auto-generated `TenantRequest` shape carries only
|
|
3980
|
+
* the writable fields (`name`, `description`); `TenantResponse` returns the
|
|
3981
|
+
* full read surface (`id`, `slug`, `name`, `description`).
|
|
3982
|
+
* Request
|
|
3983
|
+
*/
|
|
3984
|
+
type TenantRequest = {
|
|
3985
|
+
/**
|
|
3986
|
+
* Optional free-text description; max 1000 chars.
|
|
3987
|
+
*/
|
|
3988
|
+
description?: string | null;
|
|
3989
|
+
/**
|
|
3990
|
+
* Human-readable tenant name. Required on create; max 160 chars.
|
|
3991
|
+
*/
|
|
3992
|
+
name: string;
|
|
3993
|
+
};
|
|
3718
3994
|
/**
|
|
3719
3995
|
* ActionStatusUpdaterListResponse
|
|
3720
3996
|
*
|
|
@@ -3925,6 +4201,12 @@ type RunManuallyResponse = {
|
|
|
3925
4201
|
*/
|
|
3926
4202
|
batch_id: string;
|
|
3927
4203
|
};
|
|
4204
|
+
/**
|
|
4205
|
+
* ToolTwilioResponse
|
|
4206
|
+
*/
|
|
4207
|
+
type ToolTwilioResponse = TwilioResponse & {
|
|
4208
|
+
tool_body_type: 'twilio';
|
|
4209
|
+
};
|
|
3928
4210
|
/**
|
|
3929
4211
|
* ToolSFTPResponse
|
|
3930
4212
|
*/
|
|
@@ -4127,9 +4409,9 @@ type CloudStorageR2Response = {
|
|
|
4127
4409
|
*/
|
|
4128
4410
|
bucket: string;
|
|
4129
4411
|
/**
|
|
4130
|
-
*
|
|
4412
|
+
* Account-scoped R2 endpoint URL, e.g. https://<account-id>.r2.cloudflarestorage.com
|
|
4131
4413
|
*/
|
|
4132
|
-
endpoint
|
|
4414
|
+
endpoint: string;
|
|
4133
4415
|
/**
|
|
4134
4416
|
* R2 region (defaults to "auto")
|
|
4135
4417
|
*/
|
|
@@ -4184,37 +4466,46 @@ type DataSourceResponse = {
|
|
|
4184
4466
|
uri: string;
|
|
4185
4467
|
};
|
|
4186
4468
|
/**
|
|
4187
|
-
*
|
|
4188
|
-
*/
|
|
4189
|
-
type ToolRestapiResponse = RestapiResponse & {
|
|
4190
|
-
tool_body_type: 'rest_api';
|
|
4191
|
-
};
|
|
4192
|
-
/**
|
|
4193
|
-
* ContextDatasetResponse
|
|
4469
|
+
* TwilioResponse
|
|
4194
4470
|
*
|
|
4195
|
-
*
|
|
4471
|
+
* Twilio tool configuration for sending SMS via the Programmable Messaging API. A primary holds the account credential; a variant names its primary and carries only its own sender identity.
|
|
4196
4472
|
*/
|
|
4197
|
-
type
|
|
4473
|
+
type TwilioResponse = {
|
|
4198
4474
|
/**
|
|
4199
|
-
*
|
|
4475
|
+
* Twilio Account SID (required on a primary; supplied by the primary on a variant)
|
|
4200
4476
|
*/
|
|
4201
|
-
|
|
4477
|
+
account_sid?: string | null;
|
|
4478
|
+
base_message?: ComplexTemplateConfigResponse | null;
|
|
4202
4479
|
/**
|
|
4203
|
-
*
|
|
4480
|
+
* Custom Twilio API base URL (e.g., http://localhost:8080 for WireMock); leave blank for https://api.twilio.com
|
|
4204
4481
|
*/
|
|
4205
|
-
|
|
4482
|
+
base_url?: string | null;
|
|
4206
4483
|
/**
|
|
4207
|
-
*
|
|
4484
|
+
* Origination phone number in E.164 format (e.g., +15551234567)
|
|
4208
4485
|
*/
|
|
4209
|
-
|
|
4486
|
+
from_number?: string | null;
|
|
4210
4487
|
/**
|
|
4211
|
-
*
|
|
4488
|
+
* Twilio Messaging Service SID, used instead of a from_number
|
|
4212
4489
|
*/
|
|
4213
|
-
|
|
4490
|
+
messaging_service_sid?: string | null;
|
|
4214
4491
|
/**
|
|
4215
|
-
*
|
|
4492
|
+
* ID of the primary Twilio tool supplying credentials; required when variant_type is variant
|
|
4216
4493
|
*/
|
|
4217
|
-
|
|
4494
|
+
primary_tool_id?: string | null;
|
|
4495
|
+
/**
|
|
4496
|
+
* Request timeout in milliseconds (1–300000)
|
|
4497
|
+
*/
|
|
4498
|
+
timeout_ms?: number | null;
|
|
4499
|
+
/**
|
|
4500
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
4501
|
+
*/
|
|
4502
|
+
variant_type: 'primary' | 'variant';
|
|
4503
|
+
};
|
|
4504
|
+
/**
|
|
4505
|
+
* ToolRESTAPIResponse
|
|
4506
|
+
*/
|
|
4507
|
+
type ToolRestapiResponse = RestapiResponse & {
|
|
4508
|
+
tool_body_type: 'rest_api';
|
|
4218
4509
|
};
|
|
4219
4510
|
/**
|
|
4220
4511
|
* DatalakeRequest
|
|
@@ -4391,6 +4682,28 @@ type DatalakeRequestWritable = {
|
|
|
4391
4682
|
type ToolRestapiRequestWritable = RestapiRequestWritable & {
|
|
4392
4683
|
tool_body_type: 'rest_api';
|
|
4393
4684
|
};
|
|
4685
|
+
/**
|
|
4686
|
+
* EmailCallRequest
|
|
4687
|
+
*
|
|
4688
|
+
* Email tool-call config — Liquid-templated recipient, subject, and body. Request
|
|
4689
|
+
*/
|
|
4690
|
+
type EmailCallRequestWritable = {
|
|
4691
|
+
body: SimpleTemplateConfigRequest;
|
|
4692
|
+
subject: SimpleTemplateConfigRequest;
|
|
4693
|
+
to: SimpleTemplateConfigRequest;
|
|
4694
|
+
};
|
|
4695
|
+
/**
|
|
4696
|
+
* ActionEmailCallRequest
|
|
4697
|
+
*/
|
|
4698
|
+
type ActionEmailCallRequestWritable = EmailCallRequestWritable & {
|
|
4699
|
+
tool_call_type: 'email_request';
|
|
4700
|
+
};
|
|
4701
|
+
/**
|
|
4702
|
+
* ActionSMSCallRequest
|
|
4703
|
+
*/
|
|
4704
|
+
type ActionSmsCallRequestWritable = SmsCallRequestWritable & {
|
|
4705
|
+
tool_call_type: 'sms_request';
|
|
4706
|
+
};
|
|
4394
4707
|
/**
|
|
4395
4708
|
* DataActivationClientSharePointExcelCallRequest
|
|
4396
4709
|
*/
|
|
@@ -4404,13 +4717,13 @@ type DataActivationClientSharePointExcelCallRequestWritable = SharePointExcelCal
|
|
|
4404
4717
|
*/
|
|
4405
4718
|
type AgenticWorkflowRequestWritable = {
|
|
4406
4719
|
/**
|
|
4407
|
-
* Decision actions
|
|
4720
|
+
* Decision actions to attach to this workflow (request)
|
|
4408
4721
|
*/
|
|
4409
|
-
actions?: Array<
|
|
4722
|
+
actions?: Array<ActionRequestWritable>;
|
|
4410
4723
|
/**
|
|
4411
|
-
* Context-enrichment datasets
|
|
4724
|
+
* Context-enrichment datasets to load before the decision stage (request)
|
|
4412
4725
|
*/
|
|
4413
|
-
context_datasets?: Array<
|
|
4726
|
+
context_datasets?: Array<ContextDatasetRequestWritable>;
|
|
4414
4727
|
/**
|
|
4415
4728
|
* Dataset type the workflow listens on (e.g. patient, appointment, generic_table)
|
|
4416
4729
|
*/
|
|
@@ -4445,6 +4758,10 @@ type AgenticWorkflowRequestWritable = {
|
|
|
4445
4758
|
* Workflow status. live = auto-fired by event sampling; draft = preview only (dry-run); manual = never auto-fired, but runs for real when an operator explicitly invokes it.
|
|
4446
4759
|
*/
|
|
4447
4760
|
status: 'live' | 'draft' | 'manual';
|
|
4761
|
+
/**
|
|
4762
|
+
* Operator-authored labels. Free text — no taxonomy, no shared vocabulary. Not read by the execution pipeline, but they DO participate in the workflow checksum, so retagging shifts the drift fingerprint. REQUIRED on every write. Send `[]` for an untagged workflow — deliberately no default, so an omitted key is a 422 rather than a silent reset to empty.
|
|
4763
|
+
*/
|
|
4764
|
+
tags: Array<string>;
|
|
4448
4765
|
/**
|
|
4449
4766
|
* Last update timestamp
|
|
4450
4767
|
*/
|
|
@@ -4471,90 +4788,51 @@ type InteroperabilityContractAiAgentRequestWritable = {
|
|
|
4471
4788
|
position: number;
|
|
4472
4789
|
};
|
|
4473
4790
|
/**
|
|
4474
|
-
*
|
|
4791
|
+
* MMSCallRequest
|
|
4475
4792
|
*
|
|
4476
|
-
*
|
|
4793
|
+
* MMS tool-call config — Liquid-templated recipient and body, plain public media URL. Request
|
|
4477
4794
|
*/
|
|
4478
|
-
type
|
|
4479
|
-
|
|
4795
|
+
type MmsCallRequestWritable = {
|
|
4796
|
+
body: SimpleTemplateConfigRequest;
|
|
4480
4797
|
/**
|
|
4481
|
-
*
|
|
4798
|
+
* Public http(s) URL of the media to attach — fetched and re-staged into the tool's S3 media bucket
|
|
4482
4799
|
*/
|
|
4483
|
-
|
|
4800
|
+
media_url: string;
|
|
4801
|
+
to: SimpleTemplateConfigRequest;
|
|
4802
|
+
};
|
|
4803
|
+
/**
|
|
4804
|
+
* EndUserMessagingRequest
|
|
4805
|
+
*
|
|
4806
|
+
* AWS End User Messaging tool configuration for sending MMS via the SendMediaMessage API. Request
|
|
4807
|
+
*/
|
|
4808
|
+
type EndUserMessagingRequestWritable = {
|
|
4484
4809
|
/**
|
|
4485
|
-
*
|
|
4810
|
+
* AWS access key ID (used when auth_method is access_key)
|
|
4486
4811
|
*/
|
|
4487
|
-
|
|
4812
|
+
access_key_id?: string | null;
|
|
4488
4813
|
/**
|
|
4489
|
-
*
|
|
4814
|
+
* IAM role ARN to assume in the customer's AWS account (used when auth_method is assume_role)
|
|
4490
4815
|
*/
|
|
4491
|
-
|
|
4816
|
+
assume_role_arn?: string | null;
|
|
4492
4817
|
/**
|
|
4493
|
-
*
|
|
4818
|
+
* External ID for the STS AssumeRole call, unique per customer (auto-generated when auth_method is assume_role)
|
|
4494
4819
|
*/
|
|
4495
|
-
|
|
4820
|
+
assume_role_external_id?: string | null;
|
|
4496
4821
|
/**
|
|
4497
|
-
*
|
|
4822
|
+
* AWS authentication method
|
|
4498
4823
|
*/
|
|
4499
|
-
|
|
4824
|
+
auth_method: 'access_key' | 'iam_role' | 'assume_role';
|
|
4825
|
+
base_message?: ComplexTemplateConfigRequest;
|
|
4500
4826
|
/**
|
|
4501
|
-
*
|
|
4827
|
+
* AWS End User Messaging configuration set that routes delivery events to CloudWatch
|
|
4502
4828
|
*/
|
|
4503
|
-
|
|
4829
|
+
configuration_set_name: string;
|
|
4504
4830
|
/**
|
|
4505
|
-
*
|
|
4831
|
+
* Custom sms-voice endpoint URL (e.g. http://localhost:8080 for the WireMock stub); leave blank for real AWS
|
|
4506
4832
|
*/
|
|
4507
|
-
|
|
4833
|
+
endpoint_url?: string | null;
|
|
4508
4834
|
/**
|
|
4509
|
-
*
|
|
4510
|
-
*/
|
|
4511
|
-
position?: number;
|
|
4512
|
-
/**
|
|
4513
|
-
* Liquid template evaluated at execution time; when falsy, the action is skipped
|
|
4514
|
-
*/
|
|
4515
|
-
runtime_filter?: string | null;
|
|
4516
|
-
/**
|
|
4517
|
-
* Tool that executes this action
|
|
4518
|
-
*/
|
|
4519
|
-
tool_id: string;
|
|
4520
|
-
/**
|
|
4521
|
-
* Liquid template that determines when this action executes
|
|
4522
|
-
*/
|
|
4523
|
-
trigger_template: string;
|
|
4524
|
-
};
|
|
4525
|
-
/**
|
|
4526
|
-
* EndUserMessagingRequest
|
|
4527
|
-
*
|
|
4528
|
-
* AWS End User Messaging tool configuration for sending MMS via the SendMediaMessage API. Request
|
|
4529
|
-
*/
|
|
4530
|
-
type EndUserMessagingRequestWritable = {
|
|
4531
|
-
/**
|
|
4532
|
-
* AWS access key ID (used when auth_method is access_key)
|
|
4533
|
-
*/
|
|
4534
|
-
access_key_id?: string | null;
|
|
4535
|
-
/**
|
|
4536
|
-
* IAM role ARN to assume in the customer's AWS account (used when auth_method is assume_role)
|
|
4537
|
-
*/
|
|
4538
|
-
assume_role_arn?: string | null;
|
|
4539
|
-
/**
|
|
4540
|
-
* External ID for the STS AssumeRole call, unique per customer (auto-generated when auth_method is assume_role)
|
|
4541
|
-
*/
|
|
4542
|
-
assume_role_external_id?: string | null;
|
|
4543
|
-
/**
|
|
4544
|
-
* AWS authentication method
|
|
4545
|
-
*/
|
|
4546
|
-
auth_method: 'access_key' | 'iam_role' | 'assume_role';
|
|
4547
|
-
base_message?: ComplexTemplateConfigRequest;
|
|
4548
|
-
/**
|
|
4549
|
-
* AWS End User Messaging configuration set that routes delivery events to CloudWatch
|
|
4550
|
-
*/
|
|
4551
|
-
configuration_set_name: string;
|
|
4552
|
-
/**
|
|
4553
|
-
* Custom sms-voice endpoint URL (e.g. http://localhost:8080 for the WireMock stub); leave blank for real AWS
|
|
4554
|
-
*/
|
|
4555
|
-
endpoint_url?: string | null;
|
|
4556
|
-
/**
|
|
4557
|
-
* S3 bucket (same region as the sending number) where author media is re-staged for SendMediaMessage
|
|
4835
|
+
* S3 bucket (same region as the sending number) where author media is re-staged for SendMediaMessage
|
|
4558
4836
|
*/
|
|
4559
4837
|
media_bucket: string;
|
|
4560
4838
|
/**
|
|
@@ -4565,6 +4843,10 @@ type EndUserMessagingRequestWritable = {
|
|
|
4565
4843
|
* Origination phone number or identity in E.164 format (e.g., +15551234567); must be MMS-capable
|
|
4566
4844
|
*/
|
|
4567
4845
|
phone_number: string;
|
|
4846
|
+
/**
|
|
4847
|
+
* ID of the primary End User Messaging tool supplying credentials; required when variant_type is variant
|
|
4848
|
+
*/
|
|
4849
|
+
primary_tool_id?: string | null;
|
|
4568
4850
|
/**
|
|
4569
4851
|
* AWS region (e.g., us-west-2)
|
|
4570
4852
|
*/
|
|
@@ -4573,6 +4855,10 @@ type EndUserMessagingRequestWritable = {
|
|
|
4573
4855
|
* AWS secret access key (used when auth_method is access_key)
|
|
4574
4856
|
*/
|
|
4575
4857
|
secret_access_key?: string | null;
|
|
4858
|
+
/**
|
|
4859
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
4860
|
+
*/
|
|
4861
|
+
variant_type?: 'primary' | 'variant';
|
|
4576
4862
|
};
|
|
4577
4863
|
/**
|
|
4578
4864
|
* ToolSharePointRequest
|
|
@@ -4591,6 +4877,8 @@ type ToolRequestWritable = {
|
|
|
4591
4877
|
} & ToolEmailRequestWritable) | ({
|
|
4592
4878
|
tool_body_type: 'sns';
|
|
4593
4879
|
} & ToolSnsRequestWritable) | ({
|
|
4880
|
+
tool_body_type: 'twilio';
|
|
4881
|
+
} & ToolTwilioRequestWritable) | ({
|
|
4594
4882
|
tool_body_type: 'end_user_messaging';
|
|
4595
4883
|
} & ToolEndUserMessagingRequestWritable) | ({
|
|
4596
4884
|
tool_body_type: 'rest_api';
|
|
@@ -4680,6 +4968,81 @@ type AwsLambdaRequestWritable = {
|
|
|
4680
4968
|
type ToolSqsRequestWritable = SqsRequestWritable & {
|
|
4681
4969
|
tool_body_type: 'sqs';
|
|
4682
4970
|
};
|
|
4971
|
+
/**
|
|
4972
|
+
* ActionRequest
|
|
4973
|
+
*
|
|
4974
|
+
* Workflow action — executes when the decision table routes to this `decision_key`. Polymorphic `tool_call` payload is variant-specific via `tool_call_type` discriminator. Request
|
|
4975
|
+
*/
|
|
4976
|
+
type ActionRequestWritable = {
|
|
4977
|
+
action_type: ActionType;
|
|
4978
|
+
/**
|
|
4979
|
+
* Hour (0–23) when the action's execution window closes
|
|
4980
|
+
*/
|
|
4981
|
+
action_window_end?: number | null;
|
|
4982
|
+
/**
|
|
4983
|
+
* Hour (0–23) when the action's execution window opens (failsafe, typically SMS)
|
|
4984
|
+
*/
|
|
4985
|
+
action_window_start?: number | null;
|
|
4986
|
+
/**
|
|
4987
|
+
* Optional connected app — when set, the executor mints a per-recipient connected_app_form_url template variable; connected_app_route is required
|
|
4988
|
+
*/
|
|
4989
|
+
connected_app_id?: string | null;
|
|
4990
|
+
/**
|
|
4991
|
+
* Liquid template rendered to JSON at execution time and stored in the connected-app page token (optional)
|
|
4992
|
+
*/
|
|
4993
|
+
connected_app_metadata_template?: string | null;
|
|
4994
|
+
/**
|
|
4995
|
+
* Route path within the connected app — required when connected_app_id is set
|
|
4996
|
+
*/
|
|
4997
|
+
connected_app_route?: string | null;
|
|
4998
|
+
/**
|
|
4999
|
+
* Unique decision_key within the workflow — maps to a decision-table outcome
|
|
5000
|
+
*/
|
|
5001
|
+
decision_key: string;
|
|
5002
|
+
/**
|
|
5003
|
+
* Action ID — echo it back on update to modify the existing action rather than replace it
|
|
5004
|
+
*/
|
|
5005
|
+
id?: string;
|
|
5006
|
+
/**
|
|
5007
|
+
* Liquid template producing the idempotency key; receives checksum, subject_id, workflow_id, action_id, decision_key
|
|
5008
|
+
*/
|
|
5009
|
+
idempotency_template: string;
|
|
5010
|
+
/**
|
|
5011
|
+
* Display order within the workflow
|
|
5012
|
+
*/
|
|
5013
|
+
position?: number;
|
|
5014
|
+
/**
|
|
5015
|
+
* Liquid template evaluated at execution time; when falsy, the action is skipped
|
|
5016
|
+
*/
|
|
5017
|
+
runtime_filter?: string | null;
|
|
5018
|
+
tool_call: ({
|
|
5019
|
+
tool_call_type: 'sms_request';
|
|
5020
|
+
} & ActionSmsCallRequestWritable) | ({
|
|
5021
|
+
tool_call_type: 'mms_request';
|
|
5022
|
+
} & ActionMmsCallRequestWritable) | ({
|
|
5023
|
+
tool_call_type: 'email_request';
|
|
5024
|
+
} & ActionEmailCallRequestWritable) | ({
|
|
5025
|
+
tool_call_type: 'sql_query';
|
|
5026
|
+
} & ActionSqlQueryCallRequestWritable) | ({
|
|
5027
|
+
tool_call_type: 'restapi_request';
|
|
5028
|
+
} & ActionRestCallRequestWritable) | ({
|
|
5029
|
+
tool_call_type: 'sftp_request';
|
|
5030
|
+
} & ActionSftpCallRequestWritable) | ({
|
|
5031
|
+
tool_call_type: 'microsoft_share_point_excel_request';
|
|
5032
|
+
} & ActionSharePointExcelCallRequestWritable) | ({
|
|
5033
|
+
tool_call_type: 'aws_lambda_request';
|
|
5034
|
+
} & ActionAwsLambdaCallRequestWritable) | ({
|
|
5035
|
+
tool_call_type: 'manual_upload';
|
|
5036
|
+
} & ActionManualUploadCallRequest);
|
|
5037
|
+
/**
|
|
5038
|
+
* Tool that executes this action
|
|
5039
|
+
*/
|
|
5040
|
+
tool_id: string;
|
|
5041
|
+
/**
|
|
5042
|
+
* Liquid template that determines when this action executes
|
|
5043
|
+
*/
|
|
5044
|
+
trigger_template: string;
|
|
5045
|
+
};
|
|
4683
5046
|
/**
|
|
4684
5047
|
* DatalakeCloudStorageR2Request
|
|
4685
5048
|
*/
|
|
@@ -4708,6 +5071,74 @@ type WorkflowAiAgentRequestWritable = {
|
|
|
4708
5071
|
*/
|
|
4709
5072
|
position: number;
|
|
4710
5073
|
};
|
|
5074
|
+
/**
|
|
5075
|
+
* AiAgentRequest
|
|
5076
|
+
*
|
|
5077
|
+
* AI Agent configuration — reusable chat-completion resource Request
|
|
5078
|
+
*/
|
|
5079
|
+
type AiAgentRequestWritable = {
|
|
5080
|
+
/**
|
|
5081
|
+
* Data access level
|
|
5082
|
+
*/
|
|
5083
|
+
data_access: 'regulated' | 'unregulated';
|
|
5084
|
+
/**
|
|
5085
|
+
* Agent description
|
|
5086
|
+
*/
|
|
5087
|
+
description?: string | null;
|
|
5088
|
+
/**
|
|
5089
|
+
* Whether the agent is enabled
|
|
5090
|
+
*/
|
|
5091
|
+
enabled: boolean;
|
|
5092
|
+
/**
|
|
5093
|
+
* AI Agent ID
|
|
5094
|
+
*/
|
|
5095
|
+
id?: string;
|
|
5096
|
+
/**
|
|
5097
|
+
* JSON Schema describing the agent's input contract — validated by the runner against caller context on every invocation.
|
|
5098
|
+
*/
|
|
5099
|
+
input_schema: {
|
|
5100
|
+
[key: string]: unknown;
|
|
5101
|
+
};
|
|
5102
|
+
/**
|
|
5103
|
+
* Creation timestamp
|
|
5104
|
+
*/
|
|
5105
|
+
inserted_at?: string;
|
|
5106
|
+
/**
|
|
5107
|
+
* JSON Schema for LLM response format
|
|
5108
|
+
*/
|
|
5109
|
+
llm_response_schema: {
|
|
5110
|
+
[key: string]: unknown;
|
|
5111
|
+
} | null;
|
|
5112
|
+
/**
|
|
5113
|
+
* Maximum tokens for LLM response
|
|
5114
|
+
*/
|
|
5115
|
+
max_tokens: number;
|
|
5116
|
+
/**
|
|
5117
|
+
* LLM model identifier
|
|
5118
|
+
*/
|
|
5119
|
+
model: string;
|
|
5120
|
+
/**
|
|
5121
|
+
* Agent name
|
|
5122
|
+
*/
|
|
5123
|
+
name: string;
|
|
5124
|
+
prompt_config: SimpleTemplateConfigRequest;
|
|
5125
|
+
/**
|
|
5126
|
+
* URL-friendly slug
|
|
5127
|
+
*/
|
|
5128
|
+
slug?: string;
|
|
5129
|
+
/**
|
|
5130
|
+
* Sampling temperature (0.0–2.0)
|
|
5131
|
+
*/
|
|
5132
|
+
temperature: number;
|
|
5133
|
+
/**
|
|
5134
|
+
* Tool ID
|
|
5135
|
+
*/
|
|
5136
|
+
tool_id: string;
|
|
5137
|
+
/**
|
|
5138
|
+
* Last update timestamp
|
|
5139
|
+
*/
|
|
5140
|
+
updated_at?: string;
|
|
5141
|
+
};
|
|
4711
5142
|
/**
|
|
4712
5143
|
* EmailRequest
|
|
4713
5144
|
*
|
|
@@ -4738,6 +5169,10 @@ type EmailRequestWritable = {
|
|
|
4738
5169
|
* Default sender display name
|
|
4739
5170
|
*/
|
|
4740
5171
|
from_name?: string | null;
|
|
5172
|
+
/**
|
|
5173
|
+
* ID of the primary Email tool supplying credentials; required when variant_type is variant
|
|
5174
|
+
*/
|
|
5175
|
+
primary_tool_id?: string | null;
|
|
4741
5176
|
/**
|
|
4742
5177
|
* Email provider (mock = in-process dev mailbox, no credentials)
|
|
4743
5178
|
*/
|
|
@@ -4770,6 +5205,10 @@ type EmailRequestWritable = {
|
|
|
4770
5205
|
* SMTP username
|
|
4771
5206
|
*/
|
|
4772
5207
|
smtp_username?: string;
|
|
5208
|
+
/**
|
|
5209
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
5210
|
+
*/
|
|
5211
|
+
variant_type?: 'primary' | 'variant';
|
|
4773
5212
|
};
|
|
4774
5213
|
/**
|
|
4775
5214
|
* S3CloudStorageR2Request
|
|
@@ -4777,18 +5216,65 @@ type EmailRequestWritable = {
|
|
|
4777
5216
|
type S3CloudStorageR2RequestWritable = CloudStorageR2RequestWritable & {
|
|
4778
5217
|
storage_config_type: 'r2';
|
|
4779
5218
|
};
|
|
5219
|
+
/**
|
|
5220
|
+
* ToolTwilioRequest
|
|
5221
|
+
*/
|
|
5222
|
+
type ToolTwilioRequestWritable = TwilioRequestWritable & {
|
|
5223
|
+
tool_body_type: 'twilio';
|
|
5224
|
+
};
|
|
4780
5225
|
/**
|
|
4781
5226
|
* ToolSQLDatabaseRequest
|
|
4782
5227
|
*/
|
|
4783
5228
|
type ToolSqlDatabaseRequestWritable = SqlDatabaseRequestWritable & {
|
|
4784
5229
|
tool_body_type: 'sql_database';
|
|
4785
5230
|
};
|
|
5231
|
+
/**
|
|
5232
|
+
* ActionRESTCallRequest
|
|
5233
|
+
*/
|
|
5234
|
+
type ActionRestCallRequestWritable = RestCallRequestWritable & {
|
|
5235
|
+
tool_call_type: 'restapi_request';
|
|
5236
|
+
};
|
|
5237
|
+
/**
|
|
5238
|
+
* GenericTableRequest
|
|
5239
|
+
*
|
|
5240
|
+
* Generic Table — custom or system dataset table with column definitions. Request
|
|
5241
|
+
*/
|
|
5242
|
+
type GenericTableRequestWritable = {
|
|
5243
|
+
/**
|
|
5244
|
+
* Table column definitions
|
|
5245
|
+
*/
|
|
5246
|
+
columns?: Array<GenericTableColumnRequest>;
|
|
5247
|
+
/**
|
|
5248
|
+
* Industry data domain. Each value carries a stability tier in the `x-stability` extension — `stable` domains hold their dataset shapes across releases; `experimental` domains may change without notice.
|
|
5249
|
+
*/
|
|
5250
|
+
data_domain?: 'healthcare' | 'core_banking' | 'payments' | 'subscription' | 'service_commerce' | 'trading' | 'foundation';
|
|
5251
|
+
/**
|
|
5252
|
+
* Table description
|
|
5253
|
+
*/
|
|
5254
|
+
description?: string;
|
|
5255
|
+
/**
|
|
5256
|
+
* User-friendly table title
|
|
5257
|
+
*/
|
|
5258
|
+
title?: string;
|
|
5259
|
+
};
|
|
4786
5260
|
/**
|
|
4787
5261
|
* ToolSFTPRequest
|
|
4788
5262
|
*/
|
|
4789
5263
|
type ToolSftpRequestWritable = SftpRequestWritable & {
|
|
4790
5264
|
tool_body_type: 'sftp';
|
|
4791
5265
|
};
|
|
5266
|
+
/**
|
|
5267
|
+
* ActionSQLQueryCallRequest
|
|
5268
|
+
*/
|
|
5269
|
+
type ActionSqlQueryCallRequestWritable = SqlQueryCallRequestWritable & {
|
|
5270
|
+
tool_call_type: 'sql_query';
|
|
5271
|
+
};
|
|
5272
|
+
/**
|
|
5273
|
+
* ActionSFTPCallRequest
|
|
5274
|
+
*/
|
|
5275
|
+
type ActionSftpCallRequestWritable = SftpCallRequest & {
|
|
5276
|
+
tool_call_type: 'sftp_request';
|
|
5277
|
+
};
|
|
4792
5278
|
/**
|
|
4793
5279
|
* AWSLambdaCallRequest
|
|
4794
5280
|
*
|
|
@@ -4807,6 +5293,12 @@ type AwsLambdaCallRequestWritable = {
|
|
|
4807
5293
|
type ToolCloudWatchLogGroupRequestWritable = CloudWatchLogGroupRequestWritable & {
|
|
4808
5294
|
tool_body_type: 'cloud_watch_log_group';
|
|
4809
5295
|
};
|
|
5296
|
+
/**
|
|
5297
|
+
* ManualToolInvocationSQLQueryCallRequest
|
|
5298
|
+
*/
|
|
5299
|
+
type ManualToolInvocationSqlQueryCallRequestWritable = SqlQueryCallRequestWritable & {
|
|
5300
|
+
tool_call_type: 'sql_query';
|
|
5301
|
+
};
|
|
4810
5302
|
/**
|
|
4811
5303
|
* DataActivationClientAWSLambdaCallRequest
|
|
4812
5304
|
*/
|
|
@@ -4844,9 +5336,9 @@ type CloudStorageR2RequestWritable = {
|
|
|
4844
5336
|
*/
|
|
4845
5337
|
bucket: string;
|
|
4846
5338
|
/**
|
|
4847
|
-
*
|
|
5339
|
+
* Account-scoped R2 endpoint URL, e.g. https://<account-id>.r2.cloudflarestorage.com
|
|
4848
5340
|
*/
|
|
4849
|
-
endpoint
|
|
5341
|
+
endpoint: string;
|
|
4850
5342
|
/**
|
|
4851
5343
|
* R2 region (defaults to "auto")
|
|
4852
5344
|
*/
|
|
@@ -4896,6 +5388,32 @@ type SharePointRequestWritable = {
|
|
|
4896
5388
|
*/
|
|
4897
5389
|
site_url?: string | null;
|
|
4898
5390
|
};
|
|
5391
|
+
/**
|
|
5392
|
+
* ManualToolInvocationSMSCallRequest
|
|
5393
|
+
*/
|
|
5394
|
+
type ManualToolInvocationSmsCallRequestWritable = SmsCallRequestWritable & {
|
|
5395
|
+
tool_call_type: 'sms_request';
|
|
5396
|
+
};
|
|
5397
|
+
/**
|
|
5398
|
+
* ManualToolInvocationRequest
|
|
5399
|
+
*
|
|
5400
|
+
* A manual test invocation of a tool. The request body carries only `tool_call` (polymorphic on `__type__`); all other fields are server-populated and returned in the response. Request
|
|
5401
|
+
*/
|
|
5402
|
+
type ManualToolInvocationRequestWritable = {
|
|
5403
|
+
tool_call?: ({
|
|
5404
|
+
tool_call_type: 'sms_request';
|
|
5405
|
+
} & ManualToolInvocationSmsCallRequestWritable) | ({
|
|
5406
|
+
tool_call_type: 'mms_request';
|
|
5407
|
+
} & ManualToolInvocationMmsCallRequestWritable) | ({
|
|
5408
|
+
tool_call_type: 'email_request';
|
|
5409
|
+
} & ManualToolInvocationEmailCallRequestWritable) | ({
|
|
5410
|
+
tool_call_type: 'restapi_request';
|
|
5411
|
+
} & ManualToolInvocationRestCallRequestWritable) | ({
|
|
5412
|
+
tool_call_type: 'aws_lambda_request';
|
|
5413
|
+
} & ManualToolInvocationAwsLambdaCallRequestWritable) | ({
|
|
5414
|
+
tool_call_type: 'sql_query';
|
|
5415
|
+
} & ManualToolInvocationSqlQueryCallRequestWritable);
|
|
5416
|
+
};
|
|
4899
5417
|
/**
|
|
4900
5418
|
* SQLQueryCallRequest
|
|
4901
5419
|
*
|
|
@@ -4971,6 +5489,10 @@ type SnsRequestWritable = {
|
|
|
4971
5489
|
* Origination phone number in E.164 format (e.g., +15551234567)
|
|
4972
5490
|
*/
|
|
4973
5491
|
phone_number: string;
|
|
5492
|
+
/**
|
|
5493
|
+
* ID of the primary SNS tool supplying credentials; required when variant_type is variant
|
|
5494
|
+
*/
|
|
5495
|
+
primary_tool_id?: string | null;
|
|
4974
5496
|
/**
|
|
4975
5497
|
* AWS region (e.g., us-east-1)
|
|
4976
5498
|
*/
|
|
@@ -4979,6 +5501,10 @@ type SnsRequestWritable = {
|
|
|
4979
5501
|
* AWS secret access key (used when auth_method is access_key)
|
|
4980
5502
|
*/
|
|
4981
5503
|
secret_access_key?: string | null;
|
|
5504
|
+
/**
|
|
5505
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
5506
|
+
*/
|
|
5507
|
+
variant_type?: 'primary' | 'variant';
|
|
4982
5508
|
};
|
|
4983
5509
|
/**
|
|
4984
5510
|
* ToolEmailRequest
|
|
@@ -4986,6 +5512,24 @@ type SnsRequestWritable = {
|
|
|
4986
5512
|
type ToolEmailRequestWritable = EmailRequestWritable & {
|
|
4987
5513
|
tool_body_type: 'email';
|
|
4988
5514
|
};
|
|
5515
|
+
/**
|
|
5516
|
+
* ManualToolInvocationMMSCallRequest
|
|
5517
|
+
*/
|
|
5518
|
+
type ManualToolInvocationMmsCallRequestWritable = MmsCallRequestWritable & {
|
|
5519
|
+
tool_call_type: 'mms_request';
|
|
5520
|
+
};
|
|
5521
|
+
/**
|
|
5522
|
+
* ActionStatusUpdaterCloudWatchQueryRequest
|
|
5523
|
+
*/
|
|
5524
|
+
type ActionStatusUpdaterCloudWatchQueryRequestWritable = CloudWatchQueryRequest & {
|
|
5525
|
+
updater_body_type: 'cloud_watch_request';
|
|
5526
|
+
};
|
|
5527
|
+
/**
|
|
5528
|
+
* ActionStatusUpdaterRESTCallRequest
|
|
5529
|
+
*/
|
|
5530
|
+
type ActionStatusUpdaterRestCallRequestWritable = RestCallRequestWritable & {
|
|
5531
|
+
updater_body_type: 'restapi_request';
|
|
5532
|
+
};
|
|
4989
5533
|
/**
|
|
4990
5534
|
* SQSRequest
|
|
4991
5535
|
*
|
|
@@ -5028,6 +5572,12 @@ type SqsRequestWritable = {
|
|
|
5028
5572
|
type ToolAwsLambdaRequestWritable = AwsLambdaRequestWritable & {
|
|
5029
5573
|
tool_body_type: 'aws_lambda';
|
|
5030
5574
|
};
|
|
5575
|
+
/**
|
|
5576
|
+
* ActionSharePointExcelCallRequest
|
|
5577
|
+
*/
|
|
5578
|
+
type ActionSharePointExcelCallRequestWritable = SharePointExcelCallRequest & {
|
|
5579
|
+
tool_call_type: 'microsoft_share_point_excel_request';
|
|
5580
|
+
};
|
|
5031
5581
|
/**
|
|
5032
5582
|
* InteroperabilityContractRequest
|
|
5033
5583
|
*
|
|
@@ -5097,6 +5647,37 @@ type RestCallRequestWritable = {
|
|
|
5097
5647
|
params?: SimpleTemplateConfigRequest;
|
|
5098
5648
|
path: SimpleTemplateConfigRequest;
|
|
5099
5649
|
};
|
|
5650
|
+
/**
|
|
5651
|
+
* ContextDatasetRequest
|
|
5652
|
+
*
|
|
5653
|
+
* Context dataset for a workflow — declares which records the context builder should load (and under what filter) before the enrichment and decision stages. Request
|
|
5654
|
+
*/
|
|
5655
|
+
type ContextDatasetRequestWritable = {
|
|
5656
|
+
/**
|
|
5657
|
+
* Dataset type — either a standard industry resource (e.g. "patient", "appointment") or "generic_table" to reference a custom table
|
|
5658
|
+
*/
|
|
5659
|
+
dataset_type: string;
|
|
5660
|
+
/**
|
|
5661
|
+
* Required when `dataset_type == "generic_table"`
|
|
5662
|
+
*/
|
|
5663
|
+
generic_table_id?: string | null;
|
|
5664
|
+
/**
|
|
5665
|
+
* Context dataset ID — echo it back on update to modify the existing dataset rather than replace it
|
|
5666
|
+
*/
|
|
5667
|
+
id?: string;
|
|
5668
|
+
/**
|
|
5669
|
+
* Max records to load for this context dataset
|
|
5670
|
+
*/
|
|
5671
|
+
limit?: number | null;
|
|
5672
|
+
/**
|
|
5673
|
+
* Ordering within the context-builder pipeline
|
|
5674
|
+
*/
|
|
5675
|
+
position?: number;
|
|
5676
|
+
/**
|
|
5677
|
+
* Liquid-templated SQL WHERE clause for filtering records at runtime. The context builder appends the MDM subject FK automatically.
|
|
5678
|
+
*/
|
|
5679
|
+
where_clause?: string | null;
|
|
5680
|
+
};
|
|
5100
5681
|
/**
|
|
5101
5682
|
* RESTAPIRequest
|
|
5102
5683
|
*
|
|
@@ -5368,6 +5949,52 @@ type DataActivationClientRequestWritable = {
|
|
|
5368
5949
|
*/
|
|
5369
5950
|
tool_id: string;
|
|
5370
5951
|
};
|
|
5952
|
+
/**
|
|
5953
|
+
* ActionAWSLambdaCallRequest
|
|
5954
|
+
*/
|
|
5955
|
+
type ActionAwsLambdaCallRequestWritable = AwsLambdaCallRequestWritable & {
|
|
5956
|
+
tool_call_type: 'aws_lambda_request';
|
|
5957
|
+
};
|
|
5958
|
+
/**
|
|
5959
|
+
* TwilioRequest
|
|
5960
|
+
*
|
|
5961
|
+
* Twilio tool configuration for sending SMS via the Programmable Messaging API. A primary holds the account credential; a variant names its primary and carries only its own sender identity. Request
|
|
5962
|
+
*/
|
|
5963
|
+
type TwilioRequestWritable = {
|
|
5964
|
+
/**
|
|
5965
|
+
* Twilio Account SID (required on a primary; supplied by the primary on a variant)
|
|
5966
|
+
*/
|
|
5967
|
+
account_sid?: string | null;
|
|
5968
|
+
/**
|
|
5969
|
+
* Twilio Auth Token (required on a primary; supplied by the primary on a variant)
|
|
5970
|
+
*/
|
|
5971
|
+
auth_token?: string | null;
|
|
5972
|
+
base_message?: ComplexTemplateConfigRequest;
|
|
5973
|
+
/**
|
|
5974
|
+
* Custom Twilio API base URL (e.g., http://localhost:8080 for WireMock); leave blank for https://api.twilio.com
|
|
5975
|
+
*/
|
|
5976
|
+
base_url?: string | null;
|
|
5977
|
+
/**
|
|
5978
|
+
* Origination phone number in E.164 format (e.g., +15551234567)
|
|
5979
|
+
*/
|
|
5980
|
+
from_number?: string | null;
|
|
5981
|
+
/**
|
|
5982
|
+
* Twilio Messaging Service SID, used instead of a from_number
|
|
5983
|
+
*/
|
|
5984
|
+
messaging_service_sid?: string | null;
|
|
5985
|
+
/**
|
|
5986
|
+
* ID of the primary Twilio tool supplying credentials; required when variant_type is variant
|
|
5987
|
+
*/
|
|
5988
|
+
primary_tool_id?: string | null;
|
|
5989
|
+
/**
|
|
5990
|
+
* Request timeout in milliseconds (1–300000)
|
|
5991
|
+
*/
|
|
5992
|
+
timeout_ms?: number | null;
|
|
5993
|
+
/**
|
|
5994
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
5995
|
+
*/
|
|
5996
|
+
variant_type: 'primary' | 'variant';
|
|
5997
|
+
};
|
|
5371
5998
|
/**
|
|
5372
5999
|
* DataActivationClientSFTPCallRequest
|
|
5373
6000
|
*/
|
|
@@ -5405,18 +6032,71 @@ type RunManuallyRequestWritable = {
|
|
|
5405
6032
|
type ToolEndUserMessagingRequestWritable = EndUserMessagingRequestWritable & {
|
|
5406
6033
|
tool_body_type: 'end_user_messaging';
|
|
5407
6034
|
};
|
|
6035
|
+
/**
|
|
6036
|
+
* ManualToolInvocationEmailCallRequest
|
|
6037
|
+
*/
|
|
6038
|
+
type ManualToolInvocationEmailCallRequestWritable = EmailCallRequestWritable & {
|
|
6039
|
+
tool_call_type: 'email_request';
|
|
6040
|
+
};
|
|
5408
6041
|
/**
|
|
5409
6042
|
* DatalakeCloudStorageAwsRequest
|
|
5410
6043
|
*/
|
|
5411
6044
|
type DatalakeCloudStorageAwsRequestWritable = CloudStorageAwsRequestWritable & {
|
|
5412
6045
|
cloud_storage_type: 'aws';
|
|
5413
6046
|
};
|
|
6047
|
+
/**
|
|
6048
|
+
* ActionMMSCallRequest
|
|
6049
|
+
*/
|
|
6050
|
+
type ActionMmsCallRequestWritable = MmsCallRequestWritable & {
|
|
6051
|
+
tool_call_type: 'mms_request';
|
|
6052
|
+
};
|
|
6053
|
+
/**
|
|
6054
|
+
* ManualToolInvocationAWSLambdaCallRequest
|
|
6055
|
+
*/
|
|
6056
|
+
type ManualToolInvocationAwsLambdaCallRequestWritable = AwsLambdaCallRequestWritable & {
|
|
6057
|
+
tool_call_type: 'aws_lambda_request';
|
|
6058
|
+
};
|
|
5414
6059
|
/**
|
|
5415
6060
|
* ToolS3Request
|
|
5416
6061
|
*/
|
|
5417
6062
|
type ToolS3RequestWritable = S3RequestWritable & {
|
|
5418
6063
|
tool_body_type: 's3';
|
|
5419
6064
|
};
|
|
6065
|
+
/**
|
|
6066
|
+
* ManualToolInvocationRESTCallRequest
|
|
6067
|
+
*/
|
|
6068
|
+
type ManualToolInvocationRestCallRequestWritable = RestCallRequestWritable & {
|
|
6069
|
+
tool_call_type: 'restapi_request';
|
|
6070
|
+
};
|
|
6071
|
+
/**
|
|
6072
|
+
* SignUpRequest
|
|
6073
|
+
*
|
|
6074
|
+
* Register a new user account. Mirrors the `/auth/register` LiveView form
|
|
6075
|
+
* submission shape. The created user is **unconfirmed** — caller must
|
|
6076
|
+
* confirm separately (e.g. via the email confirmation flow, or via
|
|
6077
|
+
* `PUT /api/v1/admin/users/:id/confirm` for tests) before signing in.
|
|
6078
|
+
*
|
|
6079
|
+
* No authentication is required.
|
|
6080
|
+
* Request
|
|
6081
|
+
*/
|
|
6082
|
+
type SignUpRequestWritable = {
|
|
6083
|
+
/**
|
|
6084
|
+
* User email
|
|
6085
|
+
*/
|
|
6086
|
+
email: string;
|
|
6087
|
+
/**
|
|
6088
|
+
* First name
|
|
6089
|
+
*/
|
|
6090
|
+
first_name: string | null;
|
|
6091
|
+
/**
|
|
6092
|
+
* Last name
|
|
6093
|
+
*/
|
|
6094
|
+
last_name: string | null;
|
|
6095
|
+
/**
|
|
6096
|
+
* Password (8–72 characters; mirrors the `/auth/register` LiveView form)
|
|
6097
|
+
*/
|
|
6098
|
+
password: string;
|
|
6099
|
+
};
|
|
5420
6100
|
/**
|
|
5421
6101
|
* DataActivationClientSQLQueryCallRequest
|
|
5422
6102
|
*/
|
|
@@ -5429,6 +6109,60 @@ type DataActivationClientSqlQueryCallRequestWritable = SqlQueryCallRequestWritab
|
|
|
5429
6109
|
type ToolSnsRequestWritable = SnsRequestWritable & {
|
|
5430
6110
|
tool_body_type: 'sns';
|
|
5431
6111
|
};
|
|
6112
|
+
/**
|
|
6113
|
+
* ActionStatusUpdaterRequest
|
|
6114
|
+
*
|
|
6115
|
+
* Action Status Updater — automated polling for delivery status updates. Request
|
|
6116
|
+
*/
|
|
6117
|
+
type ActionStatusUpdaterRequestWritable = {
|
|
6118
|
+
action_log_config: SimpleTemplateConfigRequest;
|
|
6119
|
+
/**
|
|
6120
|
+
* Cron schedule expression (e.g. "*30 * * * *")
|
|
6121
|
+
*/
|
|
6122
|
+
cron_expression: string;
|
|
6123
|
+
/**
|
|
6124
|
+
* Datalake ID
|
|
6125
|
+
*/
|
|
6126
|
+
datalake_id: string;
|
|
6127
|
+
/**
|
|
6128
|
+
* JSON Schema the rendered events_template output is validated against on every poll (required for restapi updaters). FLOOR: it must describe an array whose items are objects listing "external_id" in "required" — every event has to name the message it reconciles, so the events_template maps the provider's own id (messageId / id / sid) into external_id. Add whatever else your provider guarantees on top; the platform only enforces the floor.
|
|
6129
|
+
*/
|
|
6130
|
+
events_output_schema?: {
|
|
6131
|
+
[key: string]: unknown;
|
|
6132
|
+
} | null;
|
|
6133
|
+
message_config: SimpleTemplateConfigRequest;
|
|
6134
|
+
/**
|
|
6135
|
+
* Updater name
|
|
6136
|
+
*/
|
|
6137
|
+
name: string;
|
|
6138
|
+
/**
|
|
6139
|
+
* JSON Schema the rendered pagination_context_template output is validated against on every poll (required for restapi updaters). FLOOR: it must describe an object listing "has_next" in "required" — that key is what ends the page loop. Add the provider's cursor keys on top; the platform only enforces the floor.
|
|
6140
|
+
*/
|
|
6141
|
+
pagination_context_output_schema?: {
|
|
6142
|
+
[key: string]: unknown;
|
|
6143
|
+
} | null;
|
|
6144
|
+
/**
|
|
6145
|
+
* IDs of sender tools whose messages this updater monitors
|
|
6146
|
+
*/
|
|
6147
|
+
sender_tool_ids?: Array<string> | null;
|
|
6148
|
+
/**
|
|
6149
|
+
* Whether this updater may poll. The server sets cycle_detected when a run re-reads events it has already handled, and every later job then fails without calling the provider. Set it back to active to resume polling — nothing else clears it.
|
|
6150
|
+
*/
|
|
6151
|
+
status?: 'active' | 'cycle_detected';
|
|
6152
|
+
updater_body: ({
|
|
6153
|
+
updater_body_type: 'cloud_watch_request';
|
|
6154
|
+
} & ActionStatusUpdaterCloudWatchQueryRequestWritable) | ({
|
|
6155
|
+
updater_body_type: 'restapi_request';
|
|
6156
|
+
} & ActionStatusUpdaterRestCallRequestWritable);
|
|
6157
|
+
/**
|
|
6158
|
+
* Tool providing auth credentials for polling
|
|
6159
|
+
*/
|
|
6160
|
+
updater_tool_id: string;
|
|
6161
|
+
/**
|
|
6162
|
+
* Updater type — determines the updater_body shape
|
|
6163
|
+
*/
|
|
6164
|
+
updater_type: 'cloud_watch' | 'restapi';
|
|
6165
|
+
};
|
|
5432
6166
|
/**
|
|
5433
6167
|
* ConnectedAppRequest
|
|
5434
6168
|
*
|
|
@@ -5559,6 +6293,19 @@ type SqlDatabaseRequestWritable = {
|
|
|
5559
6293
|
*/
|
|
5560
6294
|
user_name: string;
|
|
5561
6295
|
};
|
|
6296
|
+
/**
|
|
6297
|
+
* SMSCallRequest
|
|
6298
|
+
*
|
|
6299
|
+
* SMS tool-call config — Liquid-templated recipient and body plus transactional/promotional category. Request
|
|
6300
|
+
*/
|
|
6301
|
+
type SmsCallRequestWritable = {
|
|
6302
|
+
body: SimpleTemplateConfigRequest;
|
|
6303
|
+
/**
|
|
6304
|
+
* SMS category — transactional vs promotional
|
|
6305
|
+
*/
|
|
6306
|
+
sms_type?: 'transactional' | 'promotional';
|
|
6307
|
+
to: SimpleTemplateConfigRequest;
|
|
6308
|
+
};
|
|
5562
6309
|
type PlatformApiTenantControllerIndexData = {
|
|
5563
6310
|
body?: never;
|
|
5564
6311
|
path?: never;
|
|
@@ -5580,7 +6327,7 @@ type PlatformApiTenantControllerIndexData = {
|
|
|
5580
6327
|
*/
|
|
5581
6328
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5582
6329
|
/**
|
|
5583
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6330
|
+
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]=%3D%3D&filters[][value]=pending` (empty brackets — consecutive `[]` entries group into one filter object per element; indexed brackets parse as a map and fail the array cast with 422). `op` is the symbol, percent-encoded — `%3D%3D` for `==`, `%3E%3D` for `>=` — not a word like `equal`; anything outside the enum above is a 422 before the request reaches Flop. Omit `op` entirely for equality. Unknown fields return 422 via Flop validation at the context layer.
|
|
5584
6331
|
*/
|
|
5585
6332
|
filters?: Array<{
|
|
5586
6333
|
/**
|
|
@@ -5629,7 +6376,7 @@ type PlatformApiGenericTableControllerIndexData = {
|
|
|
5629
6376
|
*/
|
|
5630
6377
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5631
6378
|
/**
|
|
5632
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6379
|
+
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]=%3D%3D&filters[][value]=pending` (empty brackets — consecutive `[]` entries group into one filter object per element; indexed brackets parse as a map and fail the array cast with 422). `op` is the symbol, percent-encoded — `%3D%3D` for `==`, `%3E%3D` for `>=` — not a word like `equal`; anything outside the enum above is a 422 before the request reaches Flop. Omit `op` entirely for equality. Unknown fields return 422 via Flop validation at the context layer.
|
|
5633
6380
|
*/
|
|
5634
6381
|
filters?: Array<{
|
|
5635
6382
|
/**
|
|
@@ -5678,7 +6425,7 @@ type PlatformApiInteroperabilityContractControllerIndexData = {
|
|
|
5678
6425
|
*/
|
|
5679
6426
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5680
6427
|
/**
|
|
5681
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6428
|
+
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]=%3D%3D&filters[][value]=pending` (empty brackets — consecutive `[]` entries group into one filter object per element; indexed brackets parse as a map and fail the array cast with 422). `op` is the symbol, percent-encoded — `%3D%3D` for `==`, `%3E%3D` for `>=` — not a word like `equal`; anything outside the enum above is a 422 before the request reaches Flop. Omit `op` entirely for equality. Unknown fields return 422 via Flop validation at the context layer.
|
|
5682
6429
|
*/
|
|
5683
6430
|
filters?: Array<{
|
|
5684
6431
|
/**
|
|
@@ -5723,7 +6470,7 @@ type PlatformApiDatalakeControllerIndexData = {
|
|
|
5723
6470
|
*/
|
|
5724
6471
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5725
6472
|
/**
|
|
5726
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6473
|
+
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]=%3D%3D&filters[][value]=pending` (empty brackets — consecutive `[]` entries group into one filter object per element; indexed brackets parse as a map and fail the array cast with 422). `op` is the symbol, percent-encoded — `%3D%3D` for `==`, `%3E%3D` for `>=` — not a word like `equal`; anything outside the enum above is a 422 before the request reaches Flop. Omit `op` entirely for equality. Unknown fields return 422 via Flop validation at the context layer.
|
|
5727
6474
|
*/
|
|
5728
6475
|
filters?: Array<{
|
|
5729
6476
|
/**
|
|
@@ -5772,7 +6519,7 @@ type PlatformApiAiAgentControllerIndexData = {
|
|
|
5772
6519
|
*/
|
|
5773
6520
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5774
6521
|
/**
|
|
5775
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6522
|
+
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]=%3D%3D&filters[][value]=pending` (empty brackets — consecutive `[]` entries group into one filter object per element; indexed brackets parse as a map and fail the array cast with 422). `op` is the symbol, percent-encoded — `%3D%3D` for `==`, `%3E%3D` for `>=` — not a word like `equal`; anything outside the enum above is a 422 before the request reaches Flop. Omit `op` entirely for equality. Unknown fields return 422 via Flop validation at the context layer.
|
|
5776
6523
|
*/
|
|
5777
6524
|
filters?: Array<{
|
|
5778
6525
|
/**
|
|
@@ -5791,6 +6538,55 @@ type PlatformApiAiAgentControllerIndexData = {
|
|
|
5791
6538
|
};
|
|
5792
6539
|
url: '/api/v1/tenants/{tenant_slug}/datalakes/{datalake_slug}/ai-agents';
|
|
5793
6540
|
};
|
|
6541
|
+
type PlatformApiWorkflowRunControllerIndexData = {
|
|
6542
|
+
body?: never;
|
|
6543
|
+
path: {
|
|
6544
|
+
/**
|
|
6545
|
+
* Tenant slug
|
|
6546
|
+
*/
|
|
6547
|
+
tenant_slug: string;
|
|
6548
|
+
/**
|
|
6549
|
+
* Datalake slug
|
|
6550
|
+
*/
|
|
6551
|
+
datalake_slug: string;
|
|
6552
|
+
};
|
|
6553
|
+
query?: {
|
|
6554
|
+
/**
|
|
6555
|
+
* Page number (1-indexed). Defaults to 1 when omitted.
|
|
6556
|
+
*/
|
|
6557
|
+
page?: number;
|
|
6558
|
+
/**
|
|
6559
|
+
* Items per page (1-100). Defaults to the resource's Flop default when omitted.
|
|
6560
|
+
*/
|
|
6561
|
+
page_size?: number;
|
|
6562
|
+
/**
|
|
6563
|
+
* Fields to sort by, in order of precedence. Must appear in the resource schema's Flop `sortable:` list — unknown fields return 422.
|
|
6564
|
+
*/
|
|
6565
|
+
order_by?: Array<string>;
|
|
6566
|
+
/**
|
|
6567
|
+
* Sort direction(s), pair-wise with `order_by`. `asc` or `desc`. Defaults to `asc` per unpaired `order_by` entry.
|
|
6568
|
+
*/
|
|
6569
|
+
order_directions?: Array<'asc' | 'desc'>;
|
|
6570
|
+
/**
|
|
6571
|
+
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]=%3D%3D&filters[][value]=pending` (empty brackets — consecutive `[]` entries group into one filter object per element; indexed brackets parse as a map and fail the array cast with 422). `op` is the symbol, percent-encoded — `%3D%3D` for `==`, `%3E%3D` for `>=` — not a word like `equal`; anything outside the enum above is a 422 before the request reaches Flop. Omit `op` entirely for equality. Unknown fields return 422 via Flop validation at the context layer.
|
|
6572
|
+
*/
|
|
6573
|
+
filters?: Array<{
|
|
6574
|
+
/**
|
|
6575
|
+
* Filterable field name (must be in the resource's `filterable:`)
|
|
6576
|
+
*/
|
|
6577
|
+
field: string;
|
|
6578
|
+
/**
|
|
6579
|
+
* Comparison operator. Defaults to `==` when omitted.
|
|
6580
|
+
*/
|
|
6581
|
+
op?: '==' | '!=' | '<' | '<=' | '>' | '>=' | 'empty' | 'not_empty' | 'like' | 'ilike' | 'like_and' | 'like_or' | 'ilike_and' | 'ilike_or' | 'in' | 'not_in' | 'contains' | 'not_contains';
|
|
6582
|
+
/**
|
|
6583
|
+
* Filter value — shape depends on `field` and `op`.
|
|
6584
|
+
*/
|
|
6585
|
+
value: unknown;
|
|
6586
|
+
}>;
|
|
6587
|
+
};
|
|
6588
|
+
url: '/api/v1/tenants/{tenant_slug}/datalakes/{datalake_slug}/workflow-runs';
|
|
6589
|
+
};
|
|
5794
6590
|
type PlatformApiAgenticWorkflowOperationsControllerWorkflowLogsIndexData = {
|
|
5795
6591
|
body?: never;
|
|
5796
6592
|
path: {
|
|
@@ -5825,7 +6621,7 @@ type PlatformApiAgenticWorkflowOperationsControllerWorkflowLogsIndexData = {
|
|
|
5825
6621
|
*/
|
|
5826
6622
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5827
6623
|
/**
|
|
5828
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6624
|
+
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]=%3D%3D&filters[][value]=pending` (empty brackets — consecutive `[]` entries group into one filter object per element; indexed brackets parse as a map and fail the array cast with 422). `op` is the symbol, percent-encoded — `%3D%3D` for `==`, `%3E%3D` for `>=` — not a word like `equal`; anything outside the enum above is a 422 before the request reaches Flop. Omit `op` entirely for equality. Unknown fields return 422 via Flop validation at the context layer.
|
|
5829
6625
|
*/
|
|
5830
6626
|
filters?: Array<{
|
|
5831
6627
|
/**
|
|
@@ -5874,7 +6670,7 @@ type PlatformApiDataSourceControllerIndexData = {
|
|
|
5874
6670
|
*/
|
|
5875
6671
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5876
6672
|
/**
|
|
5877
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6673
|
+
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]=%3D%3D&filters[][value]=pending` (empty brackets — consecutive `[]` entries group into one filter object per element; indexed brackets parse as a map and fail the array cast with 422). `op` is the symbol, percent-encoded — `%3D%3D` for `==`, `%3E%3D` for `>=` — not a word like `equal`; anything outside the enum above is a 422 before the request reaches Flop. Omit `op` entirely for equality. Unknown fields return 422 via Flop validation at the context layer.
|
|
5878
6674
|
*/
|
|
5879
6675
|
filters?: Array<{
|
|
5880
6676
|
/**
|
|
@@ -5923,7 +6719,7 @@ type PlatformApiActionStatusUpdaterControllerIndexData = {
|
|
|
5923
6719
|
*/
|
|
5924
6720
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5925
6721
|
/**
|
|
5926
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6722
|
+
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]=%3D%3D&filters[][value]=pending` (empty brackets — consecutive `[]` entries group into one filter object per element; indexed brackets parse as a map and fail the array cast with 422). `op` is the symbol, percent-encoded — `%3D%3D` for `==`, `%3E%3D` for `>=` — not a word like `equal`; anything outside the enum above is a 422 before the request reaches Flop. Omit `op` entirely for equality. Unknown fields return 422 via Flop validation at the context layer.
|
|
5927
6723
|
*/
|
|
5928
6724
|
filters?: Array<{
|
|
5929
6725
|
/**
|
|
@@ -5972,7 +6768,7 @@ type PlatformApiConnectedAppMgmtControllerIndexData = {
|
|
|
5972
6768
|
*/
|
|
5973
6769
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5974
6770
|
/**
|
|
5975
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6771
|
+
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]=%3D%3D&filters[][value]=pending` (empty brackets — consecutive `[]` entries group into one filter object per element; indexed brackets parse as a map and fail the array cast with 422). `op` is the symbol, percent-encoded — `%3D%3D` for `==`, `%3E%3D` for `>=` — not a word like `equal`; anything outside the enum above is a 422 before the request reaches Flop. Omit `op` entirely for equality. Unknown fields return 422 via Flop validation at the context layer.
|
|
5976
6772
|
*/
|
|
5977
6773
|
filters?: Array<{
|
|
5978
6774
|
/**
|
|
@@ -6021,7 +6817,7 @@ type PlatformApiAgenticWorkflowControllerIndexData = {
|
|
|
6021
6817
|
*/
|
|
6022
6818
|
order_directions?: Array<'asc' | 'desc'>;
|
|
6023
6819
|
/**
|
|
6024
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6820
|
+
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]=%3D%3D&filters[][value]=pending` (empty brackets — consecutive `[]` entries group into one filter object per element; indexed brackets parse as a map and fail the array cast with 422). `op` is the symbol, percent-encoded — `%3D%3D` for `==`, `%3E%3D` for `>=` — not a word like `equal`; anything outside the enum above is a 422 before the request reaches Flop. Omit `op` entirely for equality. Unknown fields return 422 via Flop validation at the context layer.
|
|
6025
6821
|
*/
|
|
6026
6822
|
filters?: Array<{
|
|
6027
6823
|
/**
|
|
@@ -6074,7 +6870,7 @@ type PlatformApiDataActivationClientControllerLogsIndexData = {
|
|
|
6074
6870
|
*/
|
|
6075
6871
|
order_directions?: Array<'asc' | 'desc'>;
|
|
6076
6872
|
/**
|
|
6077
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6873
|
+
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]=%3D%3D&filters[][value]=pending` (empty brackets — consecutive `[]` entries group into one filter object per element; indexed brackets parse as a map and fail the array cast with 422). `op` is the symbol, percent-encoded — `%3D%3D` for `==`, `%3E%3D` for `>=` — not a word like `equal`; anything outside the enum above is a 422 before the request reaches Flop. Omit `op` entirely for equality. Unknown fields return 422 via Flop validation at the context layer.
|
|
6078
6874
|
*/
|
|
6079
6875
|
filters?: Array<{
|
|
6080
6876
|
/**
|
|
@@ -6127,7 +6923,7 @@ type PlatformApiAgenticWorkflowOperationsControllerBatchLogsIndexData = {
|
|
|
6127
6923
|
*/
|
|
6128
6924
|
order_directions?: Array<'asc' | 'desc'>;
|
|
6129
6925
|
/**
|
|
6130
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6926
|
+
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]=%3D%3D&filters[][value]=pending` (empty brackets — consecutive `[]` entries group into one filter object per element; indexed brackets parse as a map and fail the array cast with 422). `op` is the symbol, percent-encoded — `%3D%3D` for `==`, `%3E%3D` for `>=` — not a word like `equal`; anything outside the enum above is a 422 before the request reaches Flop. Omit `op` entirely for equality. Unknown fields return 422 via Flop validation at the context layer.
|
|
6131
6927
|
*/
|
|
6132
6928
|
filters?: Array<{
|
|
6133
6929
|
/**
|
|
@@ -6176,7 +6972,7 @@ type PlatformApiDataActivationClientControllerIndexData = {
|
|
|
6176
6972
|
*/
|
|
6177
6973
|
order_directions?: Array<'asc' | 'desc'>;
|
|
6178
6974
|
/**
|
|
6179
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6975
|
+
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]=%3D%3D&filters[][value]=pending` (empty brackets — consecutive `[]` entries group into one filter object per element; indexed brackets parse as a map and fail the array cast with 422). `op` is the symbol, percent-encoded — `%3D%3D` for `==`, `%3E%3D` for `>=` — not a word like `equal`; anything outside the enum above is a 422 before the request reaches Flop. Omit `op` entirely for equality. Unknown fields return 422 via Flop validation at the context layer.
|
|
6180
6976
|
*/
|
|
6181
6977
|
filters?: Array<{
|
|
6182
6978
|
/**
|
|
@@ -6225,7 +7021,7 @@ type PlatformApiToolControllerIndexData = {
|
|
|
6225
7021
|
*/
|
|
6226
7022
|
order_directions?: Array<'asc' | 'desc'>;
|
|
6227
7023
|
/**
|
|
6228
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
7024
|
+
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]=%3D%3D&filters[][value]=pending` (empty brackets — consecutive `[]` entries group into one filter object per element; indexed brackets parse as a map and fail the array cast with 422). `op` is the symbol, percent-encoded — `%3D%3D` for `==`, `%3E%3D` for `>=` — not a word like `equal`; anything outside the enum above is a 422 before the request reaches Flop. Omit `op` entirely for equality. Unknown fields return 422 via Flop validation at the context layer.
|
|
6229
7025
|
*/
|
|
6230
7026
|
filters?: Array<{
|
|
6231
7027
|
/**
|
|
@@ -6802,7 +7598,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6802
7598
|
}>;
|
|
6803
7599
|
};
|
|
6804
7600
|
admin: {
|
|
6805
|
-
signUp: (body:
|
|
7601
|
+
signUp: (body: SignUpRequestWritable) => Promise<{
|
|
6806
7602
|
data: UserResponse;
|
|
6807
7603
|
request: Request;
|
|
6808
7604
|
response: Response;
|
|
@@ -6829,7 +7625,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6829
7625
|
request: Request;
|
|
6830
7626
|
response: Response;
|
|
6831
7627
|
}>;
|
|
6832
|
-
create: (body:
|
|
7628
|
+
create: (body: TenantRequest) => Promise<{
|
|
6833
7629
|
data: TenantResponse;
|
|
6834
7630
|
request: Request;
|
|
6835
7631
|
response: Response;
|
|
@@ -6841,7 +7637,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6841
7637
|
request: Request;
|
|
6842
7638
|
response: Response;
|
|
6843
7639
|
}>;
|
|
6844
|
-
create: (tenantSlug: string, body:
|
|
7640
|
+
create: (tenantSlug: string, body: InvitationRequest) => Promise<{
|
|
6845
7641
|
data: InvitationResponse;
|
|
6846
7642
|
request: Request;
|
|
6847
7643
|
response: Response;
|
|
@@ -6868,7 +7664,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6868
7664
|
request: Request;
|
|
6869
7665
|
response: Response;
|
|
6870
7666
|
}>;
|
|
6871
|
-
createUserSearch: (tenantSlug: string, datalakeSlug: string, dataset: string, body:
|
|
7667
|
+
createUserSearch: (tenantSlug: string, datalakeSlug: string, dataset: string, body: UserSearchRequest) => Promise<{
|
|
6872
7668
|
data: UserSearchResponse;
|
|
6873
7669
|
request: Request;
|
|
6874
7670
|
response: Response;
|
|
@@ -6890,7 +7686,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6890
7686
|
request: Request;
|
|
6891
7687
|
response: Response;
|
|
6892
7688
|
}>;
|
|
6893
|
-
checksum: (tenantSlug: string, body:
|
|
7689
|
+
checksum: (tenantSlug: string, body: DatalakeRequestWritable) => Promise<{
|
|
6894
7690
|
data: ChecksumResponse;
|
|
6895
7691
|
request: Request;
|
|
6896
7692
|
response: Response;
|
|
@@ -6972,7 +7768,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6972
7768
|
request: Request;
|
|
6973
7769
|
response: Response;
|
|
6974
7770
|
}>;
|
|
6975
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7771
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: DataSourceRequest) => Promise<{
|
|
6976
7772
|
data: ChecksumResponse;
|
|
6977
7773
|
request: Request;
|
|
6978
7774
|
response: Response;
|
|
@@ -7017,7 +7813,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
7017
7813
|
request: Request;
|
|
7018
7814
|
response: Response;
|
|
7019
7815
|
}>;
|
|
7020
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7816
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: ToolRequestWritable) => Promise<{
|
|
7021
7817
|
data: ChecksumResponse;
|
|
7022
7818
|
request: Request;
|
|
7023
7819
|
response: Response;
|
|
@@ -7032,7 +7828,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
7032
7828
|
request: Request;
|
|
7033
7829
|
response: Response;
|
|
7034
7830
|
}>;
|
|
7035
|
-
testInvocation: (tenantSlug: string, datalakeSlug: string, id: string, body:
|
|
7831
|
+
testInvocation: (tenantSlug: string, datalakeSlug: string, id: string, body: ManualToolInvocationRequestWritable) => Promise<{
|
|
7036
7832
|
data: ManualToolInvocationResponse;
|
|
7037
7833
|
request: Request;
|
|
7038
7834
|
response: Response;
|
|
@@ -7077,7 +7873,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
7077
7873
|
request: Request;
|
|
7078
7874
|
response: Response;
|
|
7079
7875
|
}>;
|
|
7080
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7876
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: GenericTableRequestWritable) => Promise<{
|
|
7081
7877
|
data: ChecksumResponse;
|
|
7082
7878
|
request: Request;
|
|
7083
7879
|
response: Response;
|
|
@@ -7112,7 +7908,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
7112
7908
|
request: Request;
|
|
7113
7909
|
response: Response;
|
|
7114
7910
|
}>;
|
|
7115
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7911
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: ActionStatusUpdaterRequestWritable) => Promise<{
|
|
7116
7912
|
data: ChecksumResponse;
|
|
7117
7913
|
request: Request;
|
|
7118
7914
|
response: Response;
|
|
@@ -7182,7 +7978,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
7182
7978
|
request: Request;
|
|
7183
7979
|
response: Response;
|
|
7184
7980
|
}>;
|
|
7185
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7981
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: AiAgentRequestWritable) => Promise<{
|
|
7186
7982
|
data: ChecksumResponse;
|
|
7187
7983
|
request: Request;
|
|
7188
7984
|
response: Response;
|
|
@@ -7227,17 +8023,17 @@ declare function _buildApi(myClient: Client): {
|
|
|
7227
8023
|
request: Request;
|
|
7228
8024
|
response: Response;
|
|
7229
8025
|
}>;
|
|
7230
|
-
create: (tenantSlug: string, datalakeSlug: string, body:
|
|
8026
|
+
create: (tenantSlug: string, datalakeSlug: string, body: ConnectedAppRequestWritable) => Promise<{
|
|
7231
8027
|
data: ConnectedAppResponse;
|
|
7232
8028
|
request: Request;
|
|
7233
8029
|
response: Response;
|
|
7234
8030
|
}>;
|
|
7235
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
8031
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: ConnectedAppRequestWritable) => Promise<{
|
|
7236
8032
|
data: ChecksumResponse;
|
|
7237
8033
|
request: Request;
|
|
7238
8034
|
response: Response;
|
|
7239
8035
|
}>;
|
|
7240
|
-
update: (tenantSlug: string, datalakeSlug: string, id: string, body:
|
|
8036
|
+
update: (tenantSlug: string, datalakeSlug: string, id: string, body: ConnectedAppRequestWritable) => Promise<{
|
|
7241
8037
|
data: ConnectedAppResponse;
|
|
7242
8038
|
request: Request;
|
|
7243
8039
|
response: Response;
|
|
@@ -7252,12 +8048,12 @@ declare function _buildApi(myClient: Client): {
|
|
|
7252
8048
|
request: Request;
|
|
7253
8049
|
response: Response;
|
|
7254
8050
|
}>;
|
|
7255
|
-
resolvePage: (tenantSlug: string, datalakeSlug: string, slug: string, body:
|
|
8051
|
+
resolvePage: (tenantSlug: string, datalakeSlug: string, slug: string, body: ResolvePageRequest) => Promise<{
|
|
7256
8052
|
data: ResolvePageResponse;
|
|
7257
8053
|
request: Request;
|
|
7258
8054
|
response: Response;
|
|
7259
8055
|
}>;
|
|
7260
|
-
updateMessageTracking: (tenantSlug: string, datalakeSlug: string, slug: string, body:
|
|
8056
|
+
updateMessageTracking: (tenantSlug: string, datalakeSlug: string, slug: string, body: UpdatePageRequest) => Promise<{
|
|
7261
8057
|
data: UpdatePageResponse;
|
|
7262
8058
|
request: Request;
|
|
7263
8059
|
response: Response;
|
|
@@ -7287,17 +8083,17 @@ declare function _buildApi(myClient: Client): {
|
|
|
7287
8083
|
request: Request;
|
|
7288
8084
|
response: Response;
|
|
7289
8085
|
}>;
|
|
7290
|
-
create: (tenantSlug: string, datalakeSlug: string, body:
|
|
8086
|
+
create: (tenantSlug: string, datalakeSlug: string, body: DataActivationClientRequestWritable) => Promise<{
|
|
7291
8087
|
data: DataActivationClientResponse;
|
|
7292
8088
|
request: Request;
|
|
7293
8089
|
response: Response;
|
|
7294
8090
|
}>;
|
|
7295
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
8091
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: DataActivationClientRequestWritable) => Promise<{
|
|
7296
8092
|
data: ChecksumResponse;
|
|
7297
8093
|
request: Request;
|
|
7298
8094
|
response: Response;
|
|
7299
8095
|
}>;
|
|
7300
|
-
update: (tenantSlug: string, datalakeSlug: string, id: string, body:
|
|
8096
|
+
update: (tenantSlug: string, datalakeSlug: string, id: string, body: DataActivationClientRequestWritable) => Promise<{
|
|
7301
8097
|
data: DataActivationClientResponse;
|
|
7302
8098
|
request: Request;
|
|
7303
8099
|
response: Response;
|
|
@@ -7320,12 +8116,12 @@ declare function _buildApi(myClient: Client): {
|
|
|
7320
8116
|
request: Request;
|
|
7321
8117
|
response: Response;
|
|
7322
8118
|
}>;
|
|
7323
|
-
runManually: (tenantSlug: string, datalakeSlug: string, slug: string, body?:
|
|
8119
|
+
runManually: (tenantSlug: string, datalakeSlug: string, slug: string, body?: RunManuallyRequestWritable) => Promise<{
|
|
7324
8120
|
data: RunManuallyResponse;
|
|
7325
8121
|
request: Request;
|
|
7326
8122
|
response: Response;
|
|
7327
8123
|
}>;
|
|
7328
|
-
ingest: (tenantSlug: string, datalakeSlug: string, slug: string, body:
|
|
8124
|
+
ingest: (tenantSlug: string, datalakeSlug: string, slug: string, body: IngestRequest) => Promise<{
|
|
7329
8125
|
data: IngestResponse;
|
|
7330
8126
|
request: Request;
|
|
7331
8127
|
response: Response;
|
|
@@ -7359,17 +8155,17 @@ declare function _buildApi(myClient: Client): {
|
|
|
7359
8155
|
request: Request;
|
|
7360
8156
|
response: Response;
|
|
7361
8157
|
}>;
|
|
7362
|
-
create: (tenantSlug: string, datalakeSlug: string, body:
|
|
8158
|
+
create: (tenantSlug: string, datalakeSlug: string, body: InteroperabilityContractRequestWritable) => Promise<{
|
|
7363
8159
|
data: InteroperabilityContractResponse;
|
|
7364
8160
|
request: Request;
|
|
7365
8161
|
response: Response;
|
|
7366
8162
|
}>;
|
|
7367
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
8163
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: InteroperabilityContractRequestWritable) => Promise<{
|
|
7368
8164
|
data: ChecksumResponse;
|
|
7369
8165
|
request: Request;
|
|
7370
8166
|
response: Response;
|
|
7371
8167
|
}>;
|
|
7372
|
-
update: (tenantSlug: string, datalakeSlug: string, id: string, body:
|
|
8168
|
+
update: (tenantSlug: string, datalakeSlug: string, id: string, body: InteroperabilityContractRequestWritable) => Promise<{
|
|
7373
8169
|
data: InteroperabilityContractResponse;
|
|
7374
8170
|
request: Request;
|
|
7375
8171
|
response: Response;
|
|
@@ -7392,14 +8188,14 @@ declare function _buildApi(myClient: Client): {
|
|
|
7392
8188
|
request: Request;
|
|
7393
8189
|
response: Response;
|
|
7394
8190
|
}>;
|
|
7395
|
-
run: (tenantSlug: string, datalakeSlug: string, slug: string, body:
|
|
8191
|
+
run: (tenantSlug: string, datalakeSlug: string, slug: string, body: InteroperabilityRunRequest) => Promise<{
|
|
7396
8192
|
data: InteroperabilityRunResponse;
|
|
7397
8193
|
request: Request;
|
|
7398
8194
|
response: Response;
|
|
7399
8195
|
}>;
|
|
7400
8196
|
};
|
|
7401
8197
|
mdm: {
|
|
7402
|
-
verify: (tenantSlug: string, datalakeSlug: string, body:
|
|
8198
|
+
verify: (tenantSlug: string, datalakeSlug: string, body: MdmVerifyRequest) => Promise<{
|
|
7403
8199
|
data: MdmVerifyResponse;
|
|
7404
8200
|
request: Request;
|
|
7405
8201
|
response: Response;
|
|
@@ -7416,17 +8212,17 @@ declare function _buildApi(myClient: Client): {
|
|
|
7416
8212
|
request: Request;
|
|
7417
8213
|
response: Response;
|
|
7418
8214
|
}>;
|
|
7419
|
-
create: (tenantSlug: string, datalakeSlug: string, body:
|
|
8215
|
+
create: (tenantSlug: string, datalakeSlug: string, body: AgenticWorkflowRequestWritable) => Promise<{
|
|
7420
8216
|
data: AgenticWorkflowResponse;
|
|
7421
8217
|
request: Request;
|
|
7422
8218
|
response: Response;
|
|
7423
8219
|
}>;
|
|
7424
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
8220
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: AgenticWorkflowRequestWritable) => Promise<{
|
|
7425
8221
|
data: ChecksumResponse;
|
|
7426
8222
|
request: Request;
|
|
7427
8223
|
response: Response;
|
|
7428
8224
|
}>;
|
|
7429
|
-
update: (tenantSlug: string, datalakeSlug: string, id: string, body:
|
|
8225
|
+
update: (tenantSlug: string, datalakeSlug: string, id: string, body: AgenticWorkflowRequestWritable) => Promise<{
|
|
7430
8226
|
data: AgenticWorkflowResponse;
|
|
7431
8227
|
request: Request;
|
|
7432
8228
|
response: Response;
|
|
@@ -7449,12 +8245,12 @@ declare function _buildApi(myClient: Client): {
|
|
|
7449
8245
|
request: Request;
|
|
7450
8246
|
response: Response;
|
|
7451
8247
|
}>;
|
|
7452
|
-
execute: (tenantSlug: string, datalakeSlug: string, workflowSlug: string, body:
|
|
8248
|
+
execute: (tenantSlug: string, datalakeSlug: string, workflowSlug: string, body: ExecuteActionRequest) => Promise<{
|
|
7453
8249
|
data: ExecuteActionResponse;
|
|
7454
8250
|
request: Request;
|
|
7455
8251
|
response: Response;
|
|
7456
8252
|
}>;
|
|
7457
|
-
run: (tenantSlug: string, datalakeSlug: string, workflowSlug: string, body:
|
|
8253
|
+
run: (tenantSlug: string, datalakeSlug: string, workflowSlug: string, body: RunWorkflowRequest) => Promise<{
|
|
7458
8254
|
data: RunWorkflowResponse;
|
|
7459
8255
|
request: Request;
|
|
7460
8256
|
response: Response;
|
|
@@ -7508,11 +8304,28 @@ declare function _buildApi(myClient: Client): {
|
|
|
7508
8304
|
}>;
|
|
7509
8305
|
};
|
|
7510
8306
|
};
|
|
8307
|
+
workflowRuns: {
|
|
8308
|
+
list: (tenantSlug: string, datalakeSlug: string, query?: PlatformApiWorkflowRunControllerIndexData["query"]) => Promise<{
|
|
8309
|
+
data: WorkflowRunListResponse;
|
|
8310
|
+
request: Request;
|
|
8311
|
+
response: Response;
|
|
8312
|
+
}>;
|
|
8313
|
+
get: (tenantSlug: string, datalakeSlug: string, id: string) => Promise<{
|
|
8314
|
+
data: WorkflowRunResponse;
|
|
8315
|
+
request: Request;
|
|
8316
|
+
response: Response;
|
|
8317
|
+
}>;
|
|
8318
|
+
cancel: (tenantSlug: string, datalakeSlug: string, id: string) => Promise<{
|
|
8319
|
+
data: WorkflowRunResponse;
|
|
8320
|
+
request: Request;
|
|
8321
|
+
response: Response;
|
|
8322
|
+
}>;
|
|
8323
|
+
};
|
|
7511
8324
|
};
|
|
7512
8325
|
//# sourceMappingURL=client.d.ts.map
|
|
7513
8326
|
//#endregion
|
|
7514
8327
|
//#region src/index.d.ts
|
|
7515
8328
|
declare function isEnvironmentName(name: string): name is EnvironmentName;
|
|
7516
8329
|
//#endregion
|
|
7517
|
-
export { type ActionStatusUpdaterCloudWatchQueryRequest, type ActionStatusUpdaterResponse, type ActionStatusUpdaterRestCallRequest, ActionType, type AgenticWorkflowListResponse, type AgenticWorkflowRequestWritable, type AgenticWorkflowResponse, type AiAgentResponse, type AlveraApiError, type AlveraClient, type ApiConfig, type ApiDebugConfig, type BatchLogListResponse, type BatchLogResponse, type ConnectedAppListResponse, type ConnectedAppRequestWritable, type ConnectedAppResponse, type CreateActionStatusUpdaterRequest, type CreateAiAgentRequest, type CreateGenericTableRequest, type CreateSessionParams, DEFAULT_ENVIRONMENT, type DataActivationClientListResponse, type DataActivationClientLogListResponse, type DataActivationClientLogResponse, type DataActivationClientRequestWritable, type DataActivationClientResponse, type DataSourceRequest, type DataSourceRequestWritable, type DataSourceResponse, type DatalakeRequestWritable, type DatalakeResponse, type DatasetMetadataOptions, type DatasetSearchOptions, type DatasetSearchResponse, type DownloadUrlResponse, ENVIRONMENTS, type EnvironmentName, type ErrorResponse, type ExecuteActionRequest, type ExecuteActionResponse, type ExecuteSqlMeta, type ExecuteSqlRequest, type ExecuteSqlResponse, type GenericTableColumnRequest, type GenericTableColumnResponse, type GenericTableResponse, type IngestFileRequest, type IngestRequest, type InteroperabilityContractAiAgentRequestWritable, type InteroperabilityContractListResponse, type InteroperabilityContractRequestWritable, type InteroperabilityContractResponse, type InteroperabilityRunRequest, type InteroperabilityRunResponse, type MdmVerifyRequest, type MdmVerifyResponse, type PaginationMeta, type PlatformApi, type ResolvePageRequest, type RunManuallyRequestWritable, type RunManuallyResponse, type RunWorkflowRequest, type RunWorkflowResponse, type SessionResponse, type SessionResult, type SyncRoutesResponse, type TemplateConfig, type TenantListResponse, type TenantResponse, type TextToSqlRequest, type TextToSqlResponse, ToolIntent, type ToolRequest, type ToolRequestWritable, type ToolResponse, type UpdatePageRequest, type UploadLinkRequest, type UploadLinkResponse, type WorkflowAiAgentRequestWritable, type WorkflowLogListResponse, type WorkflowLogResponse, createBootstrapSession, createIsolatedPlatformApi, createPlatformApi, createSession, isEnvironmentName, revokeSession };
|
|
8330
|
+
export { type ActionStatusUpdaterCloudWatchQueryRequest, type ActionStatusUpdaterResponse, type ActionStatusUpdaterRestCallRequest, ActionType, type AgenticWorkflowListResponse, type AgenticWorkflowRequestWritable, type AgenticWorkflowResponse, type AiAgentResponse, type AlveraApiError, type AlveraClient, type ApiConfig, type ApiDebugConfig, type BatchLogListResponse, type BatchLogResponse, type ConnectedAppListResponse, type ConnectedAppRequestWritable, type ConnectedAppResponse, type CreateActionStatusUpdaterRequest, type CreateAiAgentRequest, type CreateGenericTableRequest, type CreateSessionParams, DEFAULT_ENVIRONMENT, type DataActivationClientListResponse, type DataActivationClientLogListResponse, type DataActivationClientLogResponse, type DataActivationClientRequestWritable, type DataActivationClientResponse, type DataSourceRequest, type DataSourceRequestWritable, type DataSourceResponse, type DatalakeRequestWritable, type DatalakeResponse, type DatasetMetadataOptions, type DatasetSearchOptions, type DatasetSearchResponse, type DownloadUrlResponse, ENVIRONMENTS, type EnvironmentName, type ErrorResponse, type ExecuteActionRequest, type ExecuteActionResponse, type ExecuteSqlMeta, type ExecuteSqlRequest, type ExecuteSqlResponse, type GenericTableColumnRequest, type GenericTableColumnResponse, type GenericTableResponse, type IngestFileRequest, type IngestRequest, type InteroperabilityContractAiAgentRequestWritable, type InteroperabilityContractListResponse, type InteroperabilityContractRequestWritable, type InteroperabilityContractResponse, type InteroperabilityRunRequest, type InteroperabilityRunResponse, type MdmVerifyRequest, type MdmVerifyResponse, type PaginationMeta, type PlatformApi, type ResolvePageRequest, type RunManuallyRequestWritable, type RunManuallyResponse, type RunWorkflowRequest, type RunWorkflowResponse, type SessionResponse, type SessionResult, type SyncRoutesResponse, type TemplateConfig, type TenantListResponse, type TenantResponse, type TextToSqlRequest, type TextToSqlResponse, ToolIntent, type ToolRequest, type ToolRequestWritable, type ToolResponse, type ToolTwilioRequest, type ToolTwilioRequestWritable, type ToolTwilioResponse, type TwilioRequest, type TwilioRequestWritable, type TwilioResponse, type UpdatePageRequest, type UploadLinkRequest, type UploadLinkResponse, type WorkflowAiAgentRequestWritable, type WorkflowLogListResponse, type WorkflowLogResponse, type WorkflowRunListResponse, type WorkflowRunResponse, createBootstrapSession, createIsolatedPlatformApi, createPlatformApi, createSession, isEnvironmentName, revokeSession };
|
|
7518
8331
|
//# sourceMappingURL=index.d.mts.map
|