@alvera-ai/platform-sdk 0.15.0 → 0.16.1
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/account_management.md +10 -0
- 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 +140 -4
- package/.agent/workflows.md +137 -38
- package/dist/index.d.mts +974 -151
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +138 -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
|
*
|
|
@@ -2632,6 +2807,16 @@ type ManualToolInvocationAwsLambdaCallResponse = AwsLambdaCallResponse & {
|
|
|
2632
2807
|
*/
|
|
2633
2808
|
type PingResponse = {
|
|
2634
2809
|
database_status: 'connected' | 'disconnected';
|
|
2810
|
+
/**
|
|
2811
|
+
* The platform's own IAM task role — the principal a customer names in the trust policy of
|
|
2812
|
+
* the role they create for the platform to assume (`auth_method: assume_role` on an AWS tool).
|
|
2813
|
+
*
|
|
2814
|
+
* Public by design: it has to reach every customer for onboarding to be possible. The control
|
|
2815
|
+
* against a confused deputy is the per-tool external ID the platform generates, not
|
|
2816
|
+
* concealment of this ARN. `null` where the platform runs without AWS, as in local development.
|
|
2817
|
+
*
|
|
2818
|
+
*/
|
|
2819
|
+
iam_role_arn?: string | null;
|
|
2635
2820
|
status: 'ok' | 'error';
|
|
2636
2821
|
timestamp: string;
|
|
2637
2822
|
version: string;
|
|
@@ -2700,6 +2885,10 @@ type RunWorkflowRequest = {
|
|
|
2700
2885
|
* Execution mode. 'live' fires real tool calls; 'dry_run' runs the full pipeline without making external calls.
|
|
2701
2886
|
*/
|
|
2702
2887
|
mode?: 'live' | 'dry_run';
|
|
2888
|
+
/**
|
|
2889
|
+
* 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.
|
|
2890
|
+
*/
|
|
2891
|
+
scheduled_at?: string | null;
|
|
2703
2892
|
/**
|
|
2704
2893
|
* SQL WHERE clause to filter dataset records (e.g. "status = 'active'")
|
|
2705
2894
|
*/
|
|
@@ -2810,6 +2999,8 @@ type ToolResponse = {
|
|
|
2810
2999
|
} & ToolEmailResponse) | ({
|
|
2811
3000
|
tool_body_type: 'sns';
|
|
2812
3001
|
} & ToolSnsResponse) | ({
|
|
3002
|
+
tool_body_type: 'twilio';
|
|
3003
|
+
} & ToolTwilioResponse) | ({
|
|
2813
3004
|
tool_body_type: 'end_user_messaging';
|
|
2814
3005
|
} & ToolEndUserMessagingResponse) | ({
|
|
2815
3006
|
tool_body_type: 'rest_api';
|
|
@@ -2900,6 +3091,12 @@ type DataSourceListResponse = {
|
|
|
2900
3091
|
data: Array<DataSourceResponse>;
|
|
2901
3092
|
meta: PaginationMeta;
|
|
2902
3093
|
};
|
|
3094
|
+
/**
|
|
3095
|
+
* ActionManualUploadCallRequest
|
|
3096
|
+
*/
|
|
3097
|
+
type ActionManualUploadCallRequest = ManualUploadCallRequest & {
|
|
3098
|
+
tool_call_type: 'manual_upload';
|
|
3099
|
+
};
|
|
2903
3100
|
/**
|
|
2904
3101
|
* SharePointExcelCallResponse
|
|
2905
3102
|
*
|
|
@@ -2954,10 +3151,18 @@ type SnsResponse = {
|
|
|
2954
3151
|
* Origination phone number in E.164 format (e.g., +15551234567)
|
|
2955
3152
|
*/
|
|
2956
3153
|
phone_number: string;
|
|
3154
|
+
/**
|
|
3155
|
+
* ID of the primary SNS tool supplying credentials; required when variant_type is variant
|
|
3156
|
+
*/
|
|
3157
|
+
primary_tool_id?: string | null;
|
|
2957
3158
|
/**
|
|
2958
3159
|
* AWS region (e.g., us-east-1)
|
|
2959
3160
|
*/
|
|
2960
3161
|
region: string;
|
|
3162
|
+
/**
|
|
3163
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
3164
|
+
*/
|
|
3165
|
+
variant_type?: 'primary' | 'variant';
|
|
2961
3166
|
};
|
|
2962
3167
|
/**
|
|
2963
3168
|
* InteroperabilityContractAiAgentResponse
|
|
@@ -3133,6 +3338,12 @@ type ToolListResponse = {
|
|
|
3133
3338
|
data: Array<ToolResponse>;
|
|
3134
3339
|
meta: PaginationMeta;
|
|
3135
3340
|
};
|
|
3341
|
+
/**
|
|
3342
|
+
* ManualToolInvocationSQLQueryCallResponse
|
|
3343
|
+
*/
|
|
3344
|
+
type ManualToolInvocationSqlQueryCallResponse = SqlQueryCallResponse & {
|
|
3345
|
+
tool_call_type: 'sql_query';
|
|
3346
|
+
};
|
|
3136
3347
|
/**
|
|
3137
3348
|
* SQSResponse
|
|
3138
3349
|
*
|
|
@@ -3220,6 +3431,10 @@ type EmailResponse = {
|
|
|
3220
3431
|
* Default sender display name
|
|
3221
3432
|
*/
|
|
3222
3433
|
from_name?: string | null;
|
|
3434
|
+
/**
|
|
3435
|
+
* ID of the primary Email tool supplying credentials; required when variant_type is variant
|
|
3436
|
+
*/
|
|
3437
|
+
primary_tool_id?: string | null;
|
|
3223
3438
|
/**
|
|
3224
3439
|
* Email provider (mock = in-process dev mailbox, no credentials)
|
|
3225
3440
|
*/
|
|
@@ -3244,6 +3459,10 @@ type EmailResponse = {
|
|
|
3244
3459
|
* SMTP username
|
|
3245
3460
|
*/
|
|
3246
3461
|
smtp_username?: string;
|
|
3462
|
+
/**
|
|
3463
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
3464
|
+
*/
|
|
3465
|
+
variant_type?: 'primary' | 'variant';
|
|
3247
3466
|
};
|
|
3248
3467
|
/**
|
|
3249
3468
|
* ManualToolInvocationMMSCallResponse
|
|
@@ -3530,21 +3749,34 @@ type DatalakeListResponse = {
|
|
|
3530
3749
|
/**
|
|
3531
3750
|
* RunWorkflowResponse
|
|
3532
3751
|
*
|
|
3533
|
-
*
|
|
3752
|
+
* Acknowledgement that a run has been scheduled.
|
|
3753
|
+
*
|
|
3754
|
+
* **Changed in 0.23.0.** This endpoint used to run the workflow inline and
|
|
3755
|
+
* return `enqueued_count`, `batch_id` and `workflow_run_log_id`. It now records
|
|
3756
|
+
* a workflow run and returns immediately, so none of those three are knowable
|
|
3757
|
+
* yet: the segment is resolved when the run fires, and the batch it produces
|
|
3758
|
+
* does not exist until then. Read them from the run via
|
|
3759
|
+
* `GET /tenants/{tenant_slug}/datalakes/{datalake_slug}/workflow-runs/{id}`
|
|
3760
|
+
* once its status leaves `scheduled`.
|
|
3761
|
+
*
|
|
3534
3762
|
*/
|
|
3535
3763
|
type RunWorkflowResponse = {
|
|
3536
3764
|
/**
|
|
3537
|
-
*
|
|
3765
|
+
* 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
3766
|
*/
|
|
3539
|
-
|
|
3767
|
+
matched_count?: number | null;
|
|
3768
|
+
/**
|
|
3769
|
+
* When the run will fire. Echoes the requested time, or the time the request was received when none was given.
|
|
3770
|
+
*/
|
|
3771
|
+
scheduled_at: string;
|
|
3540
3772
|
/**
|
|
3541
|
-
*
|
|
3773
|
+
* Run state at the moment of this response — always `scheduled` here.
|
|
3542
3774
|
*/
|
|
3543
|
-
|
|
3775
|
+
status: 'scheduled' | 'processing' | 'completed' | 'cancelled' | 'failed';
|
|
3544
3776
|
/**
|
|
3545
|
-
*
|
|
3777
|
+
* The scheduled run. Use it to poll status, or to cancel while still `scheduled`.
|
|
3546
3778
|
*/
|
|
3547
|
-
|
|
3779
|
+
workflow_run_id: string;
|
|
3548
3780
|
};
|
|
3549
3781
|
/**
|
|
3550
3782
|
* ExecuteActionResponse
|
|
@@ -3619,6 +3851,42 @@ type ExecuteSqlResponse = {
|
|
|
3619
3851
|
type ToolCloudWatchLogGroupResponse = CloudWatchLogGroupResponse & {
|
|
3620
3852
|
tool_body_type: 'cloud_watch_log_group';
|
|
3621
3853
|
};
|
|
3854
|
+
/**
|
|
3855
|
+
* TwilioRequest
|
|
3856
|
+
*
|
|
3857
|
+
* 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
|
|
3858
|
+
*/
|
|
3859
|
+
type TwilioRequest = {
|
|
3860
|
+
/**
|
|
3861
|
+
* Twilio Account SID (required on a primary; supplied by the primary on a variant)
|
|
3862
|
+
*/
|
|
3863
|
+
account_sid?: string | null;
|
|
3864
|
+
base_message?: ComplexTemplateConfigRequest;
|
|
3865
|
+
/**
|
|
3866
|
+
* Custom Twilio API base URL (e.g., http://localhost:8080 for WireMock); leave blank for https://api.twilio.com
|
|
3867
|
+
*/
|
|
3868
|
+
base_url?: string | null;
|
|
3869
|
+
/**
|
|
3870
|
+
* Origination phone number in E.164 format (e.g., +15551234567)
|
|
3871
|
+
*/
|
|
3872
|
+
from_number?: string | null;
|
|
3873
|
+
/**
|
|
3874
|
+
* Twilio Messaging Service SID, used instead of a from_number
|
|
3875
|
+
*/
|
|
3876
|
+
messaging_service_sid?: string | null;
|
|
3877
|
+
/**
|
|
3878
|
+
* ID of the primary Twilio tool supplying credentials; required when variant_type is variant
|
|
3879
|
+
*/
|
|
3880
|
+
primary_tool_id?: string | null;
|
|
3881
|
+
/**
|
|
3882
|
+
* Request timeout in milliseconds (1–300000)
|
|
3883
|
+
*/
|
|
3884
|
+
timeout_ms?: number | null;
|
|
3885
|
+
/**
|
|
3886
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
3887
|
+
*/
|
|
3888
|
+
variant_type: 'primary' | 'variant';
|
|
3889
|
+
};
|
|
3622
3890
|
/**
|
|
3623
3891
|
* CloudWatchQueryRequest
|
|
3624
3892
|
*
|
|
@@ -3715,6 +3983,24 @@ type InteroperabilityContractListResponse = {
|
|
|
3715
3983
|
type ToolEndUserMessagingResponse = EndUserMessagingResponse & {
|
|
3716
3984
|
tool_body_type: 'end_user_messaging';
|
|
3717
3985
|
};
|
|
3986
|
+
/**
|
|
3987
|
+
* TenantRequest
|
|
3988
|
+
*
|
|
3989
|
+
* Tenant resource. The auto-generated `TenantRequest` shape carries only
|
|
3990
|
+
* the writable fields (`name`, `description`); `TenantResponse` returns the
|
|
3991
|
+
* full read surface (`id`, `slug`, `name`, `description`).
|
|
3992
|
+
* Request
|
|
3993
|
+
*/
|
|
3994
|
+
type TenantRequest = {
|
|
3995
|
+
/**
|
|
3996
|
+
* Optional free-text description; max 1000 chars.
|
|
3997
|
+
*/
|
|
3998
|
+
description?: string | null;
|
|
3999
|
+
/**
|
|
4000
|
+
* Human-readable tenant name. Required on create; max 160 chars.
|
|
4001
|
+
*/
|
|
4002
|
+
name: string;
|
|
4003
|
+
};
|
|
3718
4004
|
/**
|
|
3719
4005
|
* ActionStatusUpdaterListResponse
|
|
3720
4006
|
*
|
|
@@ -3925,6 +4211,12 @@ type RunManuallyResponse = {
|
|
|
3925
4211
|
*/
|
|
3926
4212
|
batch_id: string;
|
|
3927
4213
|
};
|
|
4214
|
+
/**
|
|
4215
|
+
* ToolTwilioResponse
|
|
4216
|
+
*/
|
|
4217
|
+
type ToolTwilioResponse = TwilioResponse & {
|
|
4218
|
+
tool_body_type: 'twilio';
|
|
4219
|
+
};
|
|
3928
4220
|
/**
|
|
3929
4221
|
* ToolSFTPResponse
|
|
3930
4222
|
*/
|
|
@@ -4127,9 +4419,9 @@ type CloudStorageR2Response = {
|
|
|
4127
4419
|
*/
|
|
4128
4420
|
bucket: string;
|
|
4129
4421
|
/**
|
|
4130
|
-
*
|
|
4422
|
+
* Account-scoped R2 endpoint URL, e.g. https://<account-id>.r2.cloudflarestorage.com
|
|
4131
4423
|
*/
|
|
4132
|
-
endpoint
|
|
4424
|
+
endpoint: string;
|
|
4133
4425
|
/**
|
|
4134
4426
|
* R2 region (defaults to "auto")
|
|
4135
4427
|
*/
|
|
@@ -4184,37 +4476,46 @@ type DataSourceResponse = {
|
|
|
4184
4476
|
uri: string;
|
|
4185
4477
|
};
|
|
4186
4478
|
/**
|
|
4187
|
-
*
|
|
4188
|
-
*/
|
|
4189
|
-
type ToolRestapiResponse = RestapiResponse & {
|
|
4190
|
-
tool_body_type: 'rest_api';
|
|
4191
|
-
};
|
|
4192
|
-
/**
|
|
4193
|
-
* ContextDatasetResponse
|
|
4479
|
+
* TwilioResponse
|
|
4194
4480
|
*
|
|
4195
|
-
*
|
|
4481
|
+
* 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
4482
|
*/
|
|
4197
|
-
type
|
|
4483
|
+
type TwilioResponse = {
|
|
4198
4484
|
/**
|
|
4199
|
-
*
|
|
4485
|
+
* Twilio Account SID (required on a primary; supplied by the primary on a variant)
|
|
4200
4486
|
*/
|
|
4201
|
-
|
|
4487
|
+
account_sid?: string | null;
|
|
4488
|
+
base_message?: ComplexTemplateConfigResponse | null;
|
|
4202
4489
|
/**
|
|
4203
|
-
*
|
|
4490
|
+
* Custom Twilio API base URL (e.g., http://localhost:8080 for WireMock); leave blank for https://api.twilio.com
|
|
4204
4491
|
*/
|
|
4205
|
-
|
|
4492
|
+
base_url?: string | null;
|
|
4206
4493
|
/**
|
|
4207
|
-
*
|
|
4494
|
+
* Origination phone number in E.164 format (e.g., +15551234567)
|
|
4208
4495
|
*/
|
|
4209
|
-
|
|
4496
|
+
from_number?: string | null;
|
|
4210
4497
|
/**
|
|
4211
|
-
*
|
|
4498
|
+
* Twilio Messaging Service SID, used instead of a from_number
|
|
4212
4499
|
*/
|
|
4213
|
-
|
|
4500
|
+
messaging_service_sid?: string | null;
|
|
4214
4501
|
/**
|
|
4215
|
-
*
|
|
4502
|
+
* ID of the primary Twilio tool supplying credentials; required when variant_type is variant
|
|
4216
4503
|
*/
|
|
4217
|
-
|
|
4504
|
+
primary_tool_id?: string | null;
|
|
4505
|
+
/**
|
|
4506
|
+
* Request timeout in milliseconds (1–300000)
|
|
4507
|
+
*/
|
|
4508
|
+
timeout_ms?: number | null;
|
|
4509
|
+
/**
|
|
4510
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
4511
|
+
*/
|
|
4512
|
+
variant_type: 'primary' | 'variant';
|
|
4513
|
+
};
|
|
4514
|
+
/**
|
|
4515
|
+
* ToolRESTAPIResponse
|
|
4516
|
+
*/
|
|
4517
|
+
type ToolRestapiResponse = RestapiResponse & {
|
|
4518
|
+
tool_body_type: 'rest_api';
|
|
4218
4519
|
};
|
|
4219
4520
|
/**
|
|
4220
4521
|
* DatalakeRequest
|
|
@@ -4391,6 +4692,28 @@ type DatalakeRequestWritable = {
|
|
|
4391
4692
|
type ToolRestapiRequestWritable = RestapiRequestWritable & {
|
|
4392
4693
|
tool_body_type: 'rest_api';
|
|
4393
4694
|
};
|
|
4695
|
+
/**
|
|
4696
|
+
* EmailCallRequest
|
|
4697
|
+
*
|
|
4698
|
+
* Email tool-call config — Liquid-templated recipient, subject, and body. Request
|
|
4699
|
+
*/
|
|
4700
|
+
type EmailCallRequestWritable = {
|
|
4701
|
+
body: SimpleTemplateConfigRequest;
|
|
4702
|
+
subject: SimpleTemplateConfigRequest;
|
|
4703
|
+
to: SimpleTemplateConfigRequest;
|
|
4704
|
+
};
|
|
4705
|
+
/**
|
|
4706
|
+
* ActionEmailCallRequest
|
|
4707
|
+
*/
|
|
4708
|
+
type ActionEmailCallRequestWritable = EmailCallRequestWritable & {
|
|
4709
|
+
tool_call_type: 'email_request';
|
|
4710
|
+
};
|
|
4711
|
+
/**
|
|
4712
|
+
* ActionSMSCallRequest
|
|
4713
|
+
*/
|
|
4714
|
+
type ActionSmsCallRequestWritable = SmsCallRequestWritable & {
|
|
4715
|
+
tool_call_type: 'sms_request';
|
|
4716
|
+
};
|
|
4394
4717
|
/**
|
|
4395
4718
|
* DataActivationClientSharePointExcelCallRequest
|
|
4396
4719
|
*/
|
|
@@ -4404,13 +4727,13 @@ type DataActivationClientSharePointExcelCallRequestWritable = SharePointExcelCal
|
|
|
4404
4727
|
*/
|
|
4405
4728
|
type AgenticWorkflowRequestWritable = {
|
|
4406
4729
|
/**
|
|
4407
|
-
* Decision actions
|
|
4730
|
+
* Decision actions to attach to this workflow (request)
|
|
4408
4731
|
*/
|
|
4409
|
-
actions?: Array<
|
|
4732
|
+
actions?: Array<ActionRequestWritable>;
|
|
4410
4733
|
/**
|
|
4411
|
-
* Context-enrichment datasets
|
|
4734
|
+
* Context-enrichment datasets to load before the decision stage (request)
|
|
4412
4735
|
*/
|
|
4413
|
-
context_datasets?: Array<
|
|
4736
|
+
context_datasets?: Array<ContextDatasetRequestWritable>;
|
|
4414
4737
|
/**
|
|
4415
4738
|
* Dataset type the workflow listens on (e.g. patient, appointment, generic_table)
|
|
4416
4739
|
*/
|
|
@@ -4445,6 +4768,10 @@ type AgenticWorkflowRequestWritable = {
|
|
|
4445
4768
|
* 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
4769
|
*/
|
|
4447
4770
|
status: 'live' | 'draft' | 'manual';
|
|
4771
|
+
/**
|
|
4772
|
+
* 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.
|
|
4773
|
+
*/
|
|
4774
|
+
tags: Array<string>;
|
|
4448
4775
|
/**
|
|
4449
4776
|
* Last update timestamp
|
|
4450
4777
|
*/
|
|
@@ -4471,86 +4798,47 @@ type InteroperabilityContractAiAgentRequestWritable = {
|
|
|
4471
4798
|
position: number;
|
|
4472
4799
|
};
|
|
4473
4800
|
/**
|
|
4474
|
-
*
|
|
4801
|
+
* MMSCallRequest
|
|
4475
4802
|
*
|
|
4476
|
-
*
|
|
4803
|
+
* MMS tool-call config — Liquid-templated recipient and body, plain public media URL. Request
|
|
4477
4804
|
*/
|
|
4478
|
-
type
|
|
4479
|
-
|
|
4805
|
+
type MmsCallRequestWritable = {
|
|
4806
|
+
body: SimpleTemplateConfigRequest;
|
|
4480
4807
|
/**
|
|
4481
|
-
*
|
|
4808
|
+
* Public http(s) URL of the media to attach — fetched and re-staged into the tool's S3 media bucket
|
|
4482
4809
|
*/
|
|
4483
|
-
|
|
4810
|
+
media_url: string;
|
|
4811
|
+
to: SimpleTemplateConfigRequest;
|
|
4812
|
+
};
|
|
4813
|
+
/**
|
|
4814
|
+
* EndUserMessagingRequest
|
|
4815
|
+
*
|
|
4816
|
+
* AWS End User Messaging tool configuration for sending MMS via the SendMediaMessage API. Request
|
|
4817
|
+
*/
|
|
4818
|
+
type EndUserMessagingRequestWritable = {
|
|
4484
4819
|
/**
|
|
4485
|
-
*
|
|
4820
|
+
* AWS access key ID (used when auth_method is access_key)
|
|
4486
4821
|
*/
|
|
4487
|
-
|
|
4822
|
+
access_key_id?: string | null;
|
|
4488
4823
|
/**
|
|
4489
|
-
*
|
|
4824
|
+
* IAM role ARN to assume in the customer's AWS account (used when auth_method is assume_role)
|
|
4490
4825
|
*/
|
|
4491
|
-
|
|
4826
|
+
assume_role_arn?: string | null;
|
|
4492
4827
|
/**
|
|
4493
|
-
*
|
|
4828
|
+
* External ID for the STS AssumeRole call, unique per customer (auto-generated when auth_method is assume_role)
|
|
4494
4829
|
*/
|
|
4495
|
-
|
|
4830
|
+
assume_role_external_id?: string | null;
|
|
4496
4831
|
/**
|
|
4497
|
-
*
|
|
4832
|
+
* AWS authentication method
|
|
4498
4833
|
*/
|
|
4499
|
-
|
|
4834
|
+
auth_method: 'access_key' | 'iam_role' | 'assume_role';
|
|
4835
|
+
base_message?: ComplexTemplateConfigRequest;
|
|
4500
4836
|
/**
|
|
4501
|
-
*
|
|
4837
|
+
* AWS End User Messaging configuration set that routes delivery events to CloudWatch
|
|
4502
4838
|
*/
|
|
4503
|
-
|
|
4839
|
+
configuration_set_name: string;
|
|
4504
4840
|
/**
|
|
4505
|
-
*
|
|
4506
|
-
*/
|
|
4507
|
-
idempotency_template: string;
|
|
4508
|
-
/**
|
|
4509
|
-
* Display order within the workflow
|
|
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
|
|
4841
|
+
* Custom sms-voice endpoint URL (e.g. http://localhost:8080 for the WireMock stub); leave blank for real AWS
|
|
4554
4842
|
*/
|
|
4555
4843
|
endpoint_url?: string | null;
|
|
4556
4844
|
/**
|
|
@@ -4565,6 +4853,10 @@ type EndUserMessagingRequestWritable = {
|
|
|
4565
4853
|
* Origination phone number or identity in E.164 format (e.g., +15551234567); must be MMS-capable
|
|
4566
4854
|
*/
|
|
4567
4855
|
phone_number: string;
|
|
4856
|
+
/**
|
|
4857
|
+
* ID of the primary End User Messaging tool supplying credentials; required when variant_type is variant
|
|
4858
|
+
*/
|
|
4859
|
+
primary_tool_id?: string | null;
|
|
4568
4860
|
/**
|
|
4569
4861
|
* AWS region (e.g., us-west-2)
|
|
4570
4862
|
*/
|
|
@@ -4573,6 +4865,10 @@ type EndUserMessagingRequestWritable = {
|
|
|
4573
4865
|
* AWS secret access key (used when auth_method is access_key)
|
|
4574
4866
|
*/
|
|
4575
4867
|
secret_access_key?: string | null;
|
|
4868
|
+
/**
|
|
4869
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
4870
|
+
*/
|
|
4871
|
+
variant_type?: 'primary' | 'variant';
|
|
4576
4872
|
};
|
|
4577
4873
|
/**
|
|
4578
4874
|
* ToolSharePointRequest
|
|
@@ -4591,6 +4887,8 @@ type ToolRequestWritable = {
|
|
|
4591
4887
|
} & ToolEmailRequestWritable) | ({
|
|
4592
4888
|
tool_body_type: 'sns';
|
|
4593
4889
|
} & ToolSnsRequestWritable) | ({
|
|
4890
|
+
tool_body_type: 'twilio';
|
|
4891
|
+
} & ToolTwilioRequestWritable) | ({
|
|
4594
4892
|
tool_body_type: 'end_user_messaging';
|
|
4595
4893
|
} & ToolEndUserMessagingRequestWritable) | ({
|
|
4596
4894
|
tool_body_type: 'rest_api';
|
|
@@ -4680,6 +4978,81 @@ type AwsLambdaRequestWritable = {
|
|
|
4680
4978
|
type ToolSqsRequestWritable = SqsRequestWritable & {
|
|
4681
4979
|
tool_body_type: 'sqs';
|
|
4682
4980
|
};
|
|
4981
|
+
/**
|
|
4982
|
+
* ActionRequest
|
|
4983
|
+
*
|
|
4984
|
+
* 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
|
|
4985
|
+
*/
|
|
4986
|
+
type ActionRequestWritable = {
|
|
4987
|
+
action_type: ActionType;
|
|
4988
|
+
/**
|
|
4989
|
+
* Hour (0–23) when the action's execution window closes
|
|
4990
|
+
*/
|
|
4991
|
+
action_window_end?: number | null;
|
|
4992
|
+
/**
|
|
4993
|
+
* Hour (0–23) when the action's execution window opens (failsafe, typically SMS)
|
|
4994
|
+
*/
|
|
4995
|
+
action_window_start?: number | null;
|
|
4996
|
+
/**
|
|
4997
|
+
* Optional connected app — when set, the executor mints a per-recipient connected_app_form_url template variable; connected_app_route is required
|
|
4998
|
+
*/
|
|
4999
|
+
connected_app_id?: string | null;
|
|
5000
|
+
/**
|
|
5001
|
+
* Liquid template rendered to JSON at execution time and stored in the connected-app page token (optional)
|
|
5002
|
+
*/
|
|
5003
|
+
connected_app_metadata_template?: string | null;
|
|
5004
|
+
/**
|
|
5005
|
+
* Route path within the connected app — required when connected_app_id is set
|
|
5006
|
+
*/
|
|
5007
|
+
connected_app_route?: string | null;
|
|
5008
|
+
/**
|
|
5009
|
+
* Unique decision_key within the workflow — maps to a decision-table outcome
|
|
5010
|
+
*/
|
|
5011
|
+
decision_key: string;
|
|
5012
|
+
/**
|
|
5013
|
+
* Action ID — echo it back on update to modify the existing action rather than replace it
|
|
5014
|
+
*/
|
|
5015
|
+
id?: string;
|
|
5016
|
+
/**
|
|
5017
|
+
* Liquid template producing the idempotency key; receives checksum, subject_id, workflow_id, action_id, decision_key
|
|
5018
|
+
*/
|
|
5019
|
+
idempotency_template: string;
|
|
5020
|
+
/**
|
|
5021
|
+
* Display order within the workflow
|
|
5022
|
+
*/
|
|
5023
|
+
position?: number;
|
|
5024
|
+
/**
|
|
5025
|
+
* Liquid template evaluated at execution time; when falsy, the action is skipped
|
|
5026
|
+
*/
|
|
5027
|
+
runtime_filter?: string | null;
|
|
5028
|
+
tool_call: ({
|
|
5029
|
+
tool_call_type: 'sms_request';
|
|
5030
|
+
} & ActionSmsCallRequestWritable) | ({
|
|
5031
|
+
tool_call_type: 'mms_request';
|
|
5032
|
+
} & ActionMmsCallRequestWritable) | ({
|
|
5033
|
+
tool_call_type: 'email_request';
|
|
5034
|
+
} & ActionEmailCallRequestWritable) | ({
|
|
5035
|
+
tool_call_type: 'sql_query';
|
|
5036
|
+
} & ActionSqlQueryCallRequestWritable) | ({
|
|
5037
|
+
tool_call_type: 'restapi_request';
|
|
5038
|
+
} & ActionRestCallRequestWritable) | ({
|
|
5039
|
+
tool_call_type: 'sftp_request';
|
|
5040
|
+
} & ActionSftpCallRequestWritable) | ({
|
|
5041
|
+
tool_call_type: 'microsoft_share_point_excel_request';
|
|
5042
|
+
} & ActionSharePointExcelCallRequestWritable) | ({
|
|
5043
|
+
tool_call_type: 'aws_lambda_request';
|
|
5044
|
+
} & ActionAwsLambdaCallRequestWritable) | ({
|
|
5045
|
+
tool_call_type: 'manual_upload';
|
|
5046
|
+
} & ActionManualUploadCallRequest);
|
|
5047
|
+
/**
|
|
5048
|
+
* Tool that executes this action
|
|
5049
|
+
*/
|
|
5050
|
+
tool_id: string;
|
|
5051
|
+
/**
|
|
5052
|
+
* Liquid template that determines when this action executes
|
|
5053
|
+
*/
|
|
5054
|
+
trigger_template: string;
|
|
5055
|
+
};
|
|
4683
5056
|
/**
|
|
4684
5057
|
* DatalakeCloudStorageR2Request
|
|
4685
5058
|
*/
|
|
@@ -4708,6 +5081,74 @@ type WorkflowAiAgentRequestWritable = {
|
|
|
4708
5081
|
*/
|
|
4709
5082
|
position: number;
|
|
4710
5083
|
};
|
|
5084
|
+
/**
|
|
5085
|
+
* AiAgentRequest
|
|
5086
|
+
*
|
|
5087
|
+
* AI Agent configuration — reusable chat-completion resource Request
|
|
5088
|
+
*/
|
|
5089
|
+
type AiAgentRequestWritable = {
|
|
5090
|
+
/**
|
|
5091
|
+
* Data access level
|
|
5092
|
+
*/
|
|
5093
|
+
data_access: 'regulated' | 'unregulated';
|
|
5094
|
+
/**
|
|
5095
|
+
* Agent description
|
|
5096
|
+
*/
|
|
5097
|
+
description?: string | null;
|
|
5098
|
+
/**
|
|
5099
|
+
* Whether the agent is enabled
|
|
5100
|
+
*/
|
|
5101
|
+
enabled: boolean;
|
|
5102
|
+
/**
|
|
5103
|
+
* AI Agent ID
|
|
5104
|
+
*/
|
|
5105
|
+
id?: string;
|
|
5106
|
+
/**
|
|
5107
|
+
* JSON Schema describing the agent's input contract — validated by the runner against caller context on every invocation.
|
|
5108
|
+
*/
|
|
5109
|
+
input_schema: {
|
|
5110
|
+
[key: string]: unknown;
|
|
5111
|
+
};
|
|
5112
|
+
/**
|
|
5113
|
+
* Creation timestamp
|
|
5114
|
+
*/
|
|
5115
|
+
inserted_at?: string;
|
|
5116
|
+
/**
|
|
5117
|
+
* JSON Schema for LLM response format
|
|
5118
|
+
*/
|
|
5119
|
+
llm_response_schema: {
|
|
5120
|
+
[key: string]: unknown;
|
|
5121
|
+
} | null;
|
|
5122
|
+
/**
|
|
5123
|
+
* Maximum tokens for LLM response
|
|
5124
|
+
*/
|
|
5125
|
+
max_tokens: number;
|
|
5126
|
+
/**
|
|
5127
|
+
* LLM model identifier
|
|
5128
|
+
*/
|
|
5129
|
+
model: string;
|
|
5130
|
+
/**
|
|
5131
|
+
* Agent name
|
|
5132
|
+
*/
|
|
5133
|
+
name: string;
|
|
5134
|
+
prompt_config: SimpleTemplateConfigRequest;
|
|
5135
|
+
/**
|
|
5136
|
+
* URL-friendly slug
|
|
5137
|
+
*/
|
|
5138
|
+
slug?: string;
|
|
5139
|
+
/**
|
|
5140
|
+
* Sampling temperature (0.0–2.0)
|
|
5141
|
+
*/
|
|
5142
|
+
temperature: number;
|
|
5143
|
+
/**
|
|
5144
|
+
* Tool ID
|
|
5145
|
+
*/
|
|
5146
|
+
tool_id: string;
|
|
5147
|
+
/**
|
|
5148
|
+
* Last update timestamp
|
|
5149
|
+
*/
|
|
5150
|
+
updated_at?: string;
|
|
5151
|
+
};
|
|
4711
5152
|
/**
|
|
4712
5153
|
* EmailRequest
|
|
4713
5154
|
*
|
|
@@ -4738,6 +5179,10 @@ type EmailRequestWritable = {
|
|
|
4738
5179
|
* Default sender display name
|
|
4739
5180
|
*/
|
|
4740
5181
|
from_name?: string | null;
|
|
5182
|
+
/**
|
|
5183
|
+
* ID of the primary Email tool supplying credentials; required when variant_type is variant
|
|
5184
|
+
*/
|
|
5185
|
+
primary_tool_id?: string | null;
|
|
4741
5186
|
/**
|
|
4742
5187
|
* Email provider (mock = in-process dev mailbox, no credentials)
|
|
4743
5188
|
*/
|
|
@@ -4770,6 +5215,10 @@ type EmailRequestWritable = {
|
|
|
4770
5215
|
* SMTP username
|
|
4771
5216
|
*/
|
|
4772
5217
|
smtp_username?: string;
|
|
5218
|
+
/**
|
|
5219
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
5220
|
+
*/
|
|
5221
|
+
variant_type?: 'primary' | 'variant';
|
|
4773
5222
|
};
|
|
4774
5223
|
/**
|
|
4775
5224
|
* S3CloudStorageR2Request
|
|
@@ -4777,18 +5226,65 @@ type EmailRequestWritable = {
|
|
|
4777
5226
|
type S3CloudStorageR2RequestWritable = CloudStorageR2RequestWritable & {
|
|
4778
5227
|
storage_config_type: 'r2';
|
|
4779
5228
|
};
|
|
5229
|
+
/**
|
|
5230
|
+
* ToolTwilioRequest
|
|
5231
|
+
*/
|
|
5232
|
+
type ToolTwilioRequestWritable = TwilioRequestWritable & {
|
|
5233
|
+
tool_body_type: 'twilio';
|
|
5234
|
+
};
|
|
4780
5235
|
/**
|
|
4781
5236
|
* ToolSQLDatabaseRequest
|
|
4782
5237
|
*/
|
|
4783
5238
|
type ToolSqlDatabaseRequestWritable = SqlDatabaseRequestWritable & {
|
|
4784
5239
|
tool_body_type: 'sql_database';
|
|
4785
5240
|
};
|
|
5241
|
+
/**
|
|
5242
|
+
* ActionRESTCallRequest
|
|
5243
|
+
*/
|
|
5244
|
+
type ActionRestCallRequestWritable = RestCallRequestWritable & {
|
|
5245
|
+
tool_call_type: 'restapi_request';
|
|
5246
|
+
};
|
|
5247
|
+
/**
|
|
5248
|
+
* GenericTableRequest
|
|
5249
|
+
*
|
|
5250
|
+
* Generic Table — custom or system dataset table with column definitions. Request
|
|
5251
|
+
*/
|
|
5252
|
+
type GenericTableRequestWritable = {
|
|
5253
|
+
/**
|
|
5254
|
+
* Table column definitions
|
|
5255
|
+
*/
|
|
5256
|
+
columns?: Array<GenericTableColumnRequest>;
|
|
5257
|
+
/**
|
|
5258
|
+
* 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.
|
|
5259
|
+
*/
|
|
5260
|
+
data_domain?: 'healthcare' | 'core_banking' | 'payments' | 'subscription' | 'service_commerce' | 'trading' | 'foundation';
|
|
5261
|
+
/**
|
|
5262
|
+
* Table description
|
|
5263
|
+
*/
|
|
5264
|
+
description?: string;
|
|
5265
|
+
/**
|
|
5266
|
+
* User-friendly table title
|
|
5267
|
+
*/
|
|
5268
|
+
title?: string;
|
|
5269
|
+
};
|
|
4786
5270
|
/**
|
|
4787
5271
|
* ToolSFTPRequest
|
|
4788
5272
|
*/
|
|
4789
5273
|
type ToolSftpRequestWritable = SftpRequestWritable & {
|
|
4790
5274
|
tool_body_type: 'sftp';
|
|
4791
5275
|
};
|
|
5276
|
+
/**
|
|
5277
|
+
* ActionSQLQueryCallRequest
|
|
5278
|
+
*/
|
|
5279
|
+
type ActionSqlQueryCallRequestWritable = SqlQueryCallRequestWritable & {
|
|
5280
|
+
tool_call_type: 'sql_query';
|
|
5281
|
+
};
|
|
5282
|
+
/**
|
|
5283
|
+
* ActionSFTPCallRequest
|
|
5284
|
+
*/
|
|
5285
|
+
type ActionSftpCallRequestWritable = SftpCallRequest & {
|
|
5286
|
+
tool_call_type: 'sftp_request';
|
|
5287
|
+
};
|
|
4792
5288
|
/**
|
|
4793
5289
|
* AWSLambdaCallRequest
|
|
4794
5290
|
*
|
|
@@ -4807,6 +5303,12 @@ type AwsLambdaCallRequestWritable = {
|
|
|
4807
5303
|
type ToolCloudWatchLogGroupRequestWritable = CloudWatchLogGroupRequestWritable & {
|
|
4808
5304
|
tool_body_type: 'cloud_watch_log_group';
|
|
4809
5305
|
};
|
|
5306
|
+
/**
|
|
5307
|
+
* ManualToolInvocationSQLQueryCallRequest
|
|
5308
|
+
*/
|
|
5309
|
+
type ManualToolInvocationSqlQueryCallRequestWritable = SqlQueryCallRequestWritable & {
|
|
5310
|
+
tool_call_type: 'sql_query';
|
|
5311
|
+
};
|
|
4810
5312
|
/**
|
|
4811
5313
|
* DataActivationClientAWSLambdaCallRequest
|
|
4812
5314
|
*/
|
|
@@ -4844,9 +5346,9 @@ type CloudStorageR2RequestWritable = {
|
|
|
4844
5346
|
*/
|
|
4845
5347
|
bucket: string;
|
|
4846
5348
|
/**
|
|
4847
|
-
*
|
|
5349
|
+
* Account-scoped R2 endpoint URL, e.g. https://<account-id>.r2.cloudflarestorage.com
|
|
4848
5350
|
*/
|
|
4849
|
-
endpoint
|
|
5351
|
+
endpoint: string;
|
|
4850
5352
|
/**
|
|
4851
5353
|
* R2 region (defaults to "auto")
|
|
4852
5354
|
*/
|
|
@@ -4896,6 +5398,32 @@ type SharePointRequestWritable = {
|
|
|
4896
5398
|
*/
|
|
4897
5399
|
site_url?: string | null;
|
|
4898
5400
|
};
|
|
5401
|
+
/**
|
|
5402
|
+
* ManualToolInvocationSMSCallRequest
|
|
5403
|
+
*/
|
|
5404
|
+
type ManualToolInvocationSmsCallRequestWritable = SmsCallRequestWritable & {
|
|
5405
|
+
tool_call_type: 'sms_request';
|
|
5406
|
+
};
|
|
5407
|
+
/**
|
|
5408
|
+
* ManualToolInvocationRequest
|
|
5409
|
+
*
|
|
5410
|
+
* 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
|
|
5411
|
+
*/
|
|
5412
|
+
type ManualToolInvocationRequestWritable = {
|
|
5413
|
+
tool_call?: ({
|
|
5414
|
+
tool_call_type: 'sms_request';
|
|
5415
|
+
} & ManualToolInvocationSmsCallRequestWritable) | ({
|
|
5416
|
+
tool_call_type: 'mms_request';
|
|
5417
|
+
} & ManualToolInvocationMmsCallRequestWritable) | ({
|
|
5418
|
+
tool_call_type: 'email_request';
|
|
5419
|
+
} & ManualToolInvocationEmailCallRequestWritable) | ({
|
|
5420
|
+
tool_call_type: 'restapi_request';
|
|
5421
|
+
} & ManualToolInvocationRestCallRequestWritable) | ({
|
|
5422
|
+
tool_call_type: 'aws_lambda_request';
|
|
5423
|
+
} & ManualToolInvocationAwsLambdaCallRequestWritable) | ({
|
|
5424
|
+
tool_call_type: 'sql_query';
|
|
5425
|
+
} & ManualToolInvocationSqlQueryCallRequestWritable);
|
|
5426
|
+
};
|
|
4899
5427
|
/**
|
|
4900
5428
|
* SQLQueryCallRequest
|
|
4901
5429
|
*
|
|
@@ -4971,6 +5499,10 @@ type SnsRequestWritable = {
|
|
|
4971
5499
|
* Origination phone number in E.164 format (e.g., +15551234567)
|
|
4972
5500
|
*/
|
|
4973
5501
|
phone_number: string;
|
|
5502
|
+
/**
|
|
5503
|
+
* ID of the primary SNS tool supplying credentials; required when variant_type is variant
|
|
5504
|
+
*/
|
|
5505
|
+
primary_tool_id?: string | null;
|
|
4974
5506
|
/**
|
|
4975
5507
|
* AWS region (e.g., us-east-1)
|
|
4976
5508
|
*/
|
|
@@ -4979,6 +5511,10 @@ type SnsRequestWritable = {
|
|
|
4979
5511
|
* AWS secret access key (used when auth_method is access_key)
|
|
4980
5512
|
*/
|
|
4981
5513
|
secret_access_key?: string | null;
|
|
5514
|
+
/**
|
|
5515
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
5516
|
+
*/
|
|
5517
|
+
variant_type?: 'primary' | 'variant';
|
|
4982
5518
|
};
|
|
4983
5519
|
/**
|
|
4984
5520
|
* ToolEmailRequest
|
|
@@ -4986,6 +5522,24 @@ type SnsRequestWritable = {
|
|
|
4986
5522
|
type ToolEmailRequestWritable = EmailRequestWritable & {
|
|
4987
5523
|
tool_body_type: 'email';
|
|
4988
5524
|
};
|
|
5525
|
+
/**
|
|
5526
|
+
* ManualToolInvocationMMSCallRequest
|
|
5527
|
+
*/
|
|
5528
|
+
type ManualToolInvocationMmsCallRequestWritable = MmsCallRequestWritable & {
|
|
5529
|
+
tool_call_type: 'mms_request';
|
|
5530
|
+
};
|
|
5531
|
+
/**
|
|
5532
|
+
* ActionStatusUpdaterCloudWatchQueryRequest
|
|
5533
|
+
*/
|
|
5534
|
+
type ActionStatusUpdaterCloudWatchQueryRequestWritable = CloudWatchQueryRequest & {
|
|
5535
|
+
updater_body_type: 'cloud_watch_request';
|
|
5536
|
+
};
|
|
5537
|
+
/**
|
|
5538
|
+
* ActionStatusUpdaterRESTCallRequest
|
|
5539
|
+
*/
|
|
5540
|
+
type ActionStatusUpdaterRestCallRequestWritable = RestCallRequestWritable & {
|
|
5541
|
+
updater_body_type: 'restapi_request';
|
|
5542
|
+
};
|
|
4989
5543
|
/**
|
|
4990
5544
|
* SQSRequest
|
|
4991
5545
|
*
|
|
@@ -5028,6 +5582,12 @@ type SqsRequestWritable = {
|
|
|
5028
5582
|
type ToolAwsLambdaRequestWritable = AwsLambdaRequestWritable & {
|
|
5029
5583
|
tool_body_type: 'aws_lambda';
|
|
5030
5584
|
};
|
|
5585
|
+
/**
|
|
5586
|
+
* ActionSharePointExcelCallRequest
|
|
5587
|
+
*/
|
|
5588
|
+
type ActionSharePointExcelCallRequestWritable = SharePointExcelCallRequest & {
|
|
5589
|
+
tool_call_type: 'microsoft_share_point_excel_request';
|
|
5590
|
+
};
|
|
5031
5591
|
/**
|
|
5032
5592
|
* InteroperabilityContractRequest
|
|
5033
5593
|
*
|
|
@@ -5097,6 +5657,37 @@ type RestCallRequestWritable = {
|
|
|
5097
5657
|
params?: SimpleTemplateConfigRequest;
|
|
5098
5658
|
path: SimpleTemplateConfigRequest;
|
|
5099
5659
|
};
|
|
5660
|
+
/**
|
|
5661
|
+
* ContextDatasetRequest
|
|
5662
|
+
*
|
|
5663
|
+
* Context dataset for a workflow — declares which records the context builder should load (and under what filter) before the enrichment and decision stages. Request
|
|
5664
|
+
*/
|
|
5665
|
+
type ContextDatasetRequestWritable = {
|
|
5666
|
+
/**
|
|
5667
|
+
* Dataset type — either a standard industry resource (e.g. "patient", "appointment") or "generic_table" to reference a custom table
|
|
5668
|
+
*/
|
|
5669
|
+
dataset_type: string;
|
|
5670
|
+
/**
|
|
5671
|
+
* Required when `dataset_type == "generic_table"`
|
|
5672
|
+
*/
|
|
5673
|
+
generic_table_id?: string | null;
|
|
5674
|
+
/**
|
|
5675
|
+
* Context dataset ID — echo it back on update to modify the existing dataset rather than replace it
|
|
5676
|
+
*/
|
|
5677
|
+
id?: string;
|
|
5678
|
+
/**
|
|
5679
|
+
* Max records to load for this context dataset
|
|
5680
|
+
*/
|
|
5681
|
+
limit?: number | null;
|
|
5682
|
+
/**
|
|
5683
|
+
* Ordering within the context-builder pipeline
|
|
5684
|
+
*/
|
|
5685
|
+
position?: number;
|
|
5686
|
+
/**
|
|
5687
|
+
* Liquid-templated SQL WHERE clause for filtering records at runtime. The context builder appends the MDM subject FK automatically.
|
|
5688
|
+
*/
|
|
5689
|
+
where_clause?: string | null;
|
|
5690
|
+
};
|
|
5100
5691
|
/**
|
|
5101
5692
|
* RESTAPIRequest
|
|
5102
5693
|
*
|
|
@@ -5368,6 +5959,52 @@ type DataActivationClientRequestWritable = {
|
|
|
5368
5959
|
*/
|
|
5369
5960
|
tool_id: string;
|
|
5370
5961
|
};
|
|
5962
|
+
/**
|
|
5963
|
+
* ActionAWSLambdaCallRequest
|
|
5964
|
+
*/
|
|
5965
|
+
type ActionAwsLambdaCallRequestWritable = AwsLambdaCallRequestWritable & {
|
|
5966
|
+
tool_call_type: 'aws_lambda_request';
|
|
5967
|
+
};
|
|
5968
|
+
/**
|
|
5969
|
+
* TwilioRequest
|
|
5970
|
+
*
|
|
5971
|
+
* 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
|
|
5972
|
+
*/
|
|
5973
|
+
type TwilioRequestWritable = {
|
|
5974
|
+
/**
|
|
5975
|
+
* Twilio Account SID (required on a primary; supplied by the primary on a variant)
|
|
5976
|
+
*/
|
|
5977
|
+
account_sid?: string | null;
|
|
5978
|
+
/**
|
|
5979
|
+
* Twilio Auth Token (required on a primary; supplied by the primary on a variant)
|
|
5980
|
+
*/
|
|
5981
|
+
auth_token?: string | null;
|
|
5982
|
+
base_message?: ComplexTemplateConfigRequest;
|
|
5983
|
+
/**
|
|
5984
|
+
* Custom Twilio API base URL (e.g., http://localhost:8080 for WireMock); leave blank for https://api.twilio.com
|
|
5985
|
+
*/
|
|
5986
|
+
base_url?: string | null;
|
|
5987
|
+
/**
|
|
5988
|
+
* Origination phone number in E.164 format (e.g., +15551234567)
|
|
5989
|
+
*/
|
|
5990
|
+
from_number?: string | null;
|
|
5991
|
+
/**
|
|
5992
|
+
* Twilio Messaging Service SID, used instead of a from_number
|
|
5993
|
+
*/
|
|
5994
|
+
messaging_service_sid?: string | null;
|
|
5995
|
+
/**
|
|
5996
|
+
* ID of the primary Twilio tool supplying credentials; required when variant_type is variant
|
|
5997
|
+
*/
|
|
5998
|
+
primary_tool_id?: string | null;
|
|
5999
|
+
/**
|
|
6000
|
+
* Request timeout in milliseconds (1–300000)
|
|
6001
|
+
*/
|
|
6002
|
+
timeout_ms?: number | null;
|
|
6003
|
+
/**
|
|
6004
|
+
* Whether this tool holds the account credential (primary) or borrows another tool's (variant). Defaults to primary.
|
|
6005
|
+
*/
|
|
6006
|
+
variant_type: 'primary' | 'variant';
|
|
6007
|
+
};
|
|
5371
6008
|
/**
|
|
5372
6009
|
* DataActivationClientSFTPCallRequest
|
|
5373
6010
|
*/
|
|
@@ -5405,18 +6042,71 @@ type RunManuallyRequestWritable = {
|
|
|
5405
6042
|
type ToolEndUserMessagingRequestWritable = EndUserMessagingRequestWritable & {
|
|
5406
6043
|
tool_body_type: 'end_user_messaging';
|
|
5407
6044
|
};
|
|
6045
|
+
/**
|
|
6046
|
+
* ManualToolInvocationEmailCallRequest
|
|
6047
|
+
*/
|
|
6048
|
+
type ManualToolInvocationEmailCallRequestWritable = EmailCallRequestWritable & {
|
|
6049
|
+
tool_call_type: 'email_request';
|
|
6050
|
+
};
|
|
5408
6051
|
/**
|
|
5409
6052
|
* DatalakeCloudStorageAwsRequest
|
|
5410
6053
|
*/
|
|
5411
6054
|
type DatalakeCloudStorageAwsRequestWritable = CloudStorageAwsRequestWritable & {
|
|
5412
6055
|
cloud_storage_type: 'aws';
|
|
5413
6056
|
};
|
|
6057
|
+
/**
|
|
6058
|
+
* ActionMMSCallRequest
|
|
6059
|
+
*/
|
|
6060
|
+
type ActionMmsCallRequestWritable = MmsCallRequestWritable & {
|
|
6061
|
+
tool_call_type: 'mms_request';
|
|
6062
|
+
};
|
|
6063
|
+
/**
|
|
6064
|
+
* ManualToolInvocationAWSLambdaCallRequest
|
|
6065
|
+
*/
|
|
6066
|
+
type ManualToolInvocationAwsLambdaCallRequestWritable = AwsLambdaCallRequestWritable & {
|
|
6067
|
+
tool_call_type: 'aws_lambda_request';
|
|
6068
|
+
};
|
|
5414
6069
|
/**
|
|
5415
6070
|
* ToolS3Request
|
|
5416
6071
|
*/
|
|
5417
6072
|
type ToolS3RequestWritable = S3RequestWritable & {
|
|
5418
6073
|
tool_body_type: 's3';
|
|
5419
6074
|
};
|
|
6075
|
+
/**
|
|
6076
|
+
* ManualToolInvocationRESTCallRequest
|
|
6077
|
+
*/
|
|
6078
|
+
type ManualToolInvocationRestCallRequestWritable = RestCallRequestWritable & {
|
|
6079
|
+
tool_call_type: 'restapi_request';
|
|
6080
|
+
};
|
|
6081
|
+
/**
|
|
6082
|
+
* SignUpRequest
|
|
6083
|
+
*
|
|
6084
|
+
* Register a new user account. Mirrors the `/auth/register` LiveView form
|
|
6085
|
+
* submission shape. The created user is **unconfirmed** — caller must
|
|
6086
|
+
* confirm separately (e.g. via the email confirmation flow, or via
|
|
6087
|
+
* `PUT /api/v1/admin/users/:id/confirm` for tests) before signing in.
|
|
6088
|
+
*
|
|
6089
|
+
* No authentication is required.
|
|
6090
|
+
* Request
|
|
6091
|
+
*/
|
|
6092
|
+
type SignUpRequestWritable = {
|
|
6093
|
+
/**
|
|
6094
|
+
* User email
|
|
6095
|
+
*/
|
|
6096
|
+
email: string;
|
|
6097
|
+
/**
|
|
6098
|
+
* First name
|
|
6099
|
+
*/
|
|
6100
|
+
first_name: string | null;
|
|
6101
|
+
/**
|
|
6102
|
+
* Last name
|
|
6103
|
+
*/
|
|
6104
|
+
last_name: string | null;
|
|
6105
|
+
/**
|
|
6106
|
+
* Password (8–72 characters; mirrors the `/auth/register` LiveView form)
|
|
6107
|
+
*/
|
|
6108
|
+
password: string;
|
|
6109
|
+
};
|
|
5420
6110
|
/**
|
|
5421
6111
|
* DataActivationClientSQLQueryCallRequest
|
|
5422
6112
|
*/
|
|
@@ -5429,6 +6119,60 @@ type DataActivationClientSqlQueryCallRequestWritable = SqlQueryCallRequestWritab
|
|
|
5429
6119
|
type ToolSnsRequestWritable = SnsRequestWritable & {
|
|
5430
6120
|
tool_body_type: 'sns';
|
|
5431
6121
|
};
|
|
6122
|
+
/**
|
|
6123
|
+
* ActionStatusUpdaterRequest
|
|
6124
|
+
*
|
|
6125
|
+
* Action Status Updater — automated polling for delivery status updates. Request
|
|
6126
|
+
*/
|
|
6127
|
+
type ActionStatusUpdaterRequestWritable = {
|
|
6128
|
+
action_log_config: SimpleTemplateConfigRequest;
|
|
6129
|
+
/**
|
|
6130
|
+
* Cron schedule expression (e.g. "*30 * * * *")
|
|
6131
|
+
*/
|
|
6132
|
+
cron_expression: string;
|
|
6133
|
+
/**
|
|
6134
|
+
* Datalake ID
|
|
6135
|
+
*/
|
|
6136
|
+
datalake_id: string;
|
|
6137
|
+
/**
|
|
6138
|
+
* 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.
|
|
6139
|
+
*/
|
|
6140
|
+
events_output_schema?: {
|
|
6141
|
+
[key: string]: unknown;
|
|
6142
|
+
} | null;
|
|
6143
|
+
message_config: SimpleTemplateConfigRequest;
|
|
6144
|
+
/**
|
|
6145
|
+
* Updater name
|
|
6146
|
+
*/
|
|
6147
|
+
name: string;
|
|
6148
|
+
/**
|
|
6149
|
+
* 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.
|
|
6150
|
+
*/
|
|
6151
|
+
pagination_context_output_schema?: {
|
|
6152
|
+
[key: string]: unknown;
|
|
6153
|
+
} | null;
|
|
6154
|
+
/**
|
|
6155
|
+
* IDs of sender tools whose messages this updater monitors
|
|
6156
|
+
*/
|
|
6157
|
+
sender_tool_ids?: Array<string> | null;
|
|
6158
|
+
/**
|
|
6159
|
+
* 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.
|
|
6160
|
+
*/
|
|
6161
|
+
status?: 'active' | 'cycle_detected';
|
|
6162
|
+
updater_body: ({
|
|
6163
|
+
updater_body_type: 'cloud_watch_request';
|
|
6164
|
+
} & ActionStatusUpdaterCloudWatchQueryRequestWritable) | ({
|
|
6165
|
+
updater_body_type: 'restapi_request';
|
|
6166
|
+
} & ActionStatusUpdaterRestCallRequestWritable);
|
|
6167
|
+
/**
|
|
6168
|
+
* Tool providing auth credentials for polling
|
|
6169
|
+
*/
|
|
6170
|
+
updater_tool_id: string;
|
|
6171
|
+
/**
|
|
6172
|
+
* Updater type — determines the updater_body shape
|
|
6173
|
+
*/
|
|
6174
|
+
updater_type: 'cloud_watch' | 'restapi';
|
|
6175
|
+
};
|
|
5432
6176
|
/**
|
|
5433
6177
|
* ConnectedAppRequest
|
|
5434
6178
|
*
|
|
@@ -5559,6 +6303,19 @@ type SqlDatabaseRequestWritable = {
|
|
|
5559
6303
|
*/
|
|
5560
6304
|
user_name: string;
|
|
5561
6305
|
};
|
|
6306
|
+
/**
|
|
6307
|
+
* SMSCallRequest
|
|
6308
|
+
*
|
|
6309
|
+
* SMS tool-call config — Liquid-templated recipient and body plus transactional/promotional category. Request
|
|
6310
|
+
*/
|
|
6311
|
+
type SmsCallRequestWritable = {
|
|
6312
|
+
body: SimpleTemplateConfigRequest;
|
|
6313
|
+
/**
|
|
6314
|
+
* SMS category — transactional vs promotional
|
|
6315
|
+
*/
|
|
6316
|
+
sms_type?: 'transactional' | 'promotional';
|
|
6317
|
+
to: SimpleTemplateConfigRequest;
|
|
6318
|
+
};
|
|
5562
6319
|
type PlatformApiTenantControllerIndexData = {
|
|
5563
6320
|
body?: never;
|
|
5564
6321
|
path?: never;
|
|
@@ -5580,7 +6337,7 @@ type PlatformApiTenantControllerIndexData = {
|
|
|
5580
6337
|
*/
|
|
5581
6338
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5582
6339
|
/**
|
|
5583
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6340
|
+
* 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
6341
|
*/
|
|
5585
6342
|
filters?: Array<{
|
|
5586
6343
|
/**
|
|
@@ -5629,7 +6386,7 @@ type PlatformApiGenericTableControllerIndexData = {
|
|
|
5629
6386
|
*/
|
|
5630
6387
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5631
6388
|
/**
|
|
5632
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6389
|
+
* 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
6390
|
*/
|
|
5634
6391
|
filters?: Array<{
|
|
5635
6392
|
/**
|
|
@@ -5678,7 +6435,7 @@ type PlatformApiInteroperabilityContractControllerIndexData = {
|
|
|
5678
6435
|
*/
|
|
5679
6436
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5680
6437
|
/**
|
|
5681
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6438
|
+
* 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
6439
|
*/
|
|
5683
6440
|
filters?: Array<{
|
|
5684
6441
|
/**
|
|
@@ -5723,7 +6480,7 @@ type PlatformApiDatalakeControllerIndexData = {
|
|
|
5723
6480
|
*/
|
|
5724
6481
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5725
6482
|
/**
|
|
5726
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6483
|
+
* 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
6484
|
*/
|
|
5728
6485
|
filters?: Array<{
|
|
5729
6486
|
/**
|
|
@@ -5772,7 +6529,7 @@ type PlatformApiAiAgentControllerIndexData = {
|
|
|
5772
6529
|
*/
|
|
5773
6530
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5774
6531
|
/**
|
|
5775
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6532
|
+
* 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
6533
|
*/
|
|
5777
6534
|
filters?: Array<{
|
|
5778
6535
|
/**
|
|
@@ -5791,6 +6548,55 @@ type PlatformApiAiAgentControllerIndexData = {
|
|
|
5791
6548
|
};
|
|
5792
6549
|
url: '/api/v1/tenants/{tenant_slug}/datalakes/{datalake_slug}/ai-agents';
|
|
5793
6550
|
};
|
|
6551
|
+
type PlatformApiWorkflowRunControllerIndexData = {
|
|
6552
|
+
body?: never;
|
|
6553
|
+
path: {
|
|
6554
|
+
/**
|
|
6555
|
+
* Tenant slug
|
|
6556
|
+
*/
|
|
6557
|
+
tenant_slug: string;
|
|
6558
|
+
/**
|
|
6559
|
+
* Datalake slug
|
|
6560
|
+
*/
|
|
6561
|
+
datalake_slug: string;
|
|
6562
|
+
};
|
|
6563
|
+
query?: {
|
|
6564
|
+
/**
|
|
6565
|
+
* Page number (1-indexed). Defaults to 1 when omitted.
|
|
6566
|
+
*/
|
|
6567
|
+
page?: number;
|
|
6568
|
+
/**
|
|
6569
|
+
* Items per page (1-100). Defaults to the resource's Flop default when omitted.
|
|
6570
|
+
*/
|
|
6571
|
+
page_size?: number;
|
|
6572
|
+
/**
|
|
6573
|
+
* Fields to sort by, in order of precedence. Must appear in the resource schema's Flop `sortable:` list — unknown fields return 422.
|
|
6574
|
+
*/
|
|
6575
|
+
order_by?: Array<string>;
|
|
6576
|
+
/**
|
|
6577
|
+
* Sort direction(s), pair-wise with `order_by`. `asc` or `desc`. Defaults to `asc` per unpaired `order_by` entry.
|
|
6578
|
+
*/
|
|
6579
|
+
order_directions?: Array<'asc' | 'desc'>;
|
|
6580
|
+
/**
|
|
6581
|
+
* 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.
|
|
6582
|
+
*/
|
|
6583
|
+
filters?: Array<{
|
|
6584
|
+
/**
|
|
6585
|
+
* Filterable field name (must be in the resource's `filterable:`)
|
|
6586
|
+
*/
|
|
6587
|
+
field: string;
|
|
6588
|
+
/**
|
|
6589
|
+
* Comparison operator. Defaults to `==` when omitted.
|
|
6590
|
+
*/
|
|
6591
|
+
op?: '==' | '!=' | '<' | '<=' | '>' | '>=' | 'empty' | 'not_empty' | 'like' | 'ilike' | 'like_and' | 'like_or' | 'ilike_and' | 'ilike_or' | 'in' | 'not_in' | 'contains' | 'not_contains';
|
|
6592
|
+
/**
|
|
6593
|
+
* Filter value — shape depends on `field` and `op`.
|
|
6594
|
+
*/
|
|
6595
|
+
value: unknown;
|
|
6596
|
+
}>;
|
|
6597
|
+
};
|
|
6598
|
+
url: '/api/v1/tenants/{tenant_slug}/datalakes/{datalake_slug}/workflow-runs';
|
|
6599
|
+
};
|
|
5794
6600
|
type PlatformApiAgenticWorkflowOperationsControllerWorkflowLogsIndexData = {
|
|
5795
6601
|
body?: never;
|
|
5796
6602
|
path: {
|
|
@@ -5825,7 +6631,7 @@ type PlatformApiAgenticWorkflowOperationsControllerWorkflowLogsIndexData = {
|
|
|
5825
6631
|
*/
|
|
5826
6632
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5827
6633
|
/**
|
|
5828
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6634
|
+
* 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
6635
|
*/
|
|
5830
6636
|
filters?: Array<{
|
|
5831
6637
|
/**
|
|
@@ -5874,7 +6680,7 @@ type PlatformApiDataSourceControllerIndexData = {
|
|
|
5874
6680
|
*/
|
|
5875
6681
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5876
6682
|
/**
|
|
5877
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6683
|
+
* 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
6684
|
*/
|
|
5879
6685
|
filters?: Array<{
|
|
5880
6686
|
/**
|
|
@@ -5923,7 +6729,7 @@ type PlatformApiActionStatusUpdaterControllerIndexData = {
|
|
|
5923
6729
|
*/
|
|
5924
6730
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5925
6731
|
/**
|
|
5926
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6732
|
+
* 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
6733
|
*/
|
|
5928
6734
|
filters?: Array<{
|
|
5929
6735
|
/**
|
|
@@ -5972,7 +6778,7 @@ type PlatformApiConnectedAppMgmtControllerIndexData = {
|
|
|
5972
6778
|
*/
|
|
5973
6779
|
order_directions?: Array<'asc' | 'desc'>;
|
|
5974
6780
|
/**
|
|
5975
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6781
|
+
* 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
6782
|
*/
|
|
5977
6783
|
filters?: Array<{
|
|
5978
6784
|
/**
|
|
@@ -6021,7 +6827,7 @@ type PlatformApiAgenticWorkflowControllerIndexData = {
|
|
|
6021
6827
|
*/
|
|
6022
6828
|
order_directions?: Array<'asc' | 'desc'>;
|
|
6023
6829
|
/**
|
|
6024
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6830
|
+
* 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
6831
|
*/
|
|
6026
6832
|
filters?: Array<{
|
|
6027
6833
|
/**
|
|
@@ -6074,7 +6880,7 @@ type PlatformApiDataActivationClientControllerLogsIndexData = {
|
|
|
6074
6880
|
*/
|
|
6075
6881
|
order_directions?: Array<'asc' | 'desc'>;
|
|
6076
6882
|
/**
|
|
6077
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6883
|
+
* 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
6884
|
*/
|
|
6079
6885
|
filters?: Array<{
|
|
6080
6886
|
/**
|
|
@@ -6127,7 +6933,7 @@ type PlatformApiAgenticWorkflowOperationsControllerBatchLogsIndexData = {
|
|
|
6127
6933
|
*/
|
|
6128
6934
|
order_directions?: Array<'asc' | 'desc'>;
|
|
6129
6935
|
/**
|
|
6130
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6936
|
+
* 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
6937
|
*/
|
|
6132
6938
|
filters?: Array<{
|
|
6133
6939
|
/**
|
|
@@ -6176,7 +6982,7 @@ type PlatformApiDataActivationClientControllerIndexData = {
|
|
|
6176
6982
|
*/
|
|
6177
6983
|
order_directions?: Array<'asc' | 'desc'>;
|
|
6178
6984
|
/**
|
|
6179
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
6985
|
+
* 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
6986
|
*/
|
|
6181
6987
|
filters?: Array<{
|
|
6182
6988
|
/**
|
|
@@ -6225,7 +7031,7 @@ type PlatformApiToolControllerIndexData = {
|
|
|
6225
7031
|
*/
|
|
6226
7032
|
order_directions?: Array<'asc' | 'desc'>;
|
|
6227
7033
|
/**
|
|
6228
|
-
* Flop-native filter array. URL shape: `?filters[][field]=status&filters[][op]
|
|
7034
|
+
* 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
7035
|
*/
|
|
6230
7036
|
filters?: Array<{
|
|
6231
7037
|
/**
|
|
@@ -6802,7 +7608,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6802
7608
|
}>;
|
|
6803
7609
|
};
|
|
6804
7610
|
admin: {
|
|
6805
|
-
signUp: (body:
|
|
7611
|
+
signUp: (body: SignUpRequestWritable) => Promise<{
|
|
6806
7612
|
data: UserResponse;
|
|
6807
7613
|
request: Request;
|
|
6808
7614
|
response: Response;
|
|
@@ -6829,7 +7635,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6829
7635
|
request: Request;
|
|
6830
7636
|
response: Response;
|
|
6831
7637
|
}>;
|
|
6832
|
-
create: (body:
|
|
7638
|
+
create: (body: TenantRequest) => Promise<{
|
|
6833
7639
|
data: TenantResponse;
|
|
6834
7640
|
request: Request;
|
|
6835
7641
|
response: Response;
|
|
@@ -6841,7 +7647,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6841
7647
|
request: Request;
|
|
6842
7648
|
response: Response;
|
|
6843
7649
|
}>;
|
|
6844
|
-
create: (tenantSlug: string, body:
|
|
7650
|
+
create: (tenantSlug: string, body: InvitationRequest) => Promise<{
|
|
6845
7651
|
data: InvitationResponse;
|
|
6846
7652
|
request: Request;
|
|
6847
7653
|
response: Response;
|
|
@@ -6868,7 +7674,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6868
7674
|
request: Request;
|
|
6869
7675
|
response: Response;
|
|
6870
7676
|
}>;
|
|
6871
|
-
createUserSearch: (tenantSlug: string, datalakeSlug: string, dataset: string, body:
|
|
7677
|
+
createUserSearch: (tenantSlug: string, datalakeSlug: string, dataset: string, body: UserSearchRequest) => Promise<{
|
|
6872
7678
|
data: UserSearchResponse;
|
|
6873
7679
|
request: Request;
|
|
6874
7680
|
response: Response;
|
|
@@ -6890,7 +7696,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6890
7696
|
request: Request;
|
|
6891
7697
|
response: Response;
|
|
6892
7698
|
}>;
|
|
6893
|
-
checksum: (tenantSlug: string, body:
|
|
7699
|
+
checksum: (tenantSlug: string, body: DatalakeRequestWritable) => Promise<{
|
|
6894
7700
|
data: ChecksumResponse;
|
|
6895
7701
|
request: Request;
|
|
6896
7702
|
response: Response;
|
|
@@ -6972,7 +7778,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6972
7778
|
request: Request;
|
|
6973
7779
|
response: Response;
|
|
6974
7780
|
}>;
|
|
6975
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7781
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: DataSourceRequest) => Promise<{
|
|
6976
7782
|
data: ChecksumResponse;
|
|
6977
7783
|
request: Request;
|
|
6978
7784
|
response: Response;
|
|
@@ -7017,7 +7823,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
7017
7823
|
request: Request;
|
|
7018
7824
|
response: Response;
|
|
7019
7825
|
}>;
|
|
7020
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7826
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: ToolRequestWritable) => Promise<{
|
|
7021
7827
|
data: ChecksumResponse;
|
|
7022
7828
|
request: Request;
|
|
7023
7829
|
response: Response;
|
|
@@ -7032,7 +7838,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
7032
7838
|
request: Request;
|
|
7033
7839
|
response: Response;
|
|
7034
7840
|
}>;
|
|
7035
|
-
testInvocation: (tenantSlug: string, datalakeSlug: string, id: string, body:
|
|
7841
|
+
testInvocation: (tenantSlug: string, datalakeSlug: string, id: string, body: ManualToolInvocationRequestWritable) => Promise<{
|
|
7036
7842
|
data: ManualToolInvocationResponse;
|
|
7037
7843
|
request: Request;
|
|
7038
7844
|
response: Response;
|
|
@@ -7077,7 +7883,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
7077
7883
|
request: Request;
|
|
7078
7884
|
response: Response;
|
|
7079
7885
|
}>;
|
|
7080
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7886
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: GenericTableRequestWritable) => Promise<{
|
|
7081
7887
|
data: ChecksumResponse;
|
|
7082
7888
|
request: Request;
|
|
7083
7889
|
response: Response;
|
|
@@ -7112,7 +7918,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
7112
7918
|
request: Request;
|
|
7113
7919
|
response: Response;
|
|
7114
7920
|
}>;
|
|
7115
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7921
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: ActionStatusUpdaterRequestWritable) => Promise<{
|
|
7116
7922
|
data: ChecksumResponse;
|
|
7117
7923
|
request: Request;
|
|
7118
7924
|
response: Response;
|
|
@@ -7182,7 +7988,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
7182
7988
|
request: Request;
|
|
7183
7989
|
response: Response;
|
|
7184
7990
|
}>;
|
|
7185
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7991
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: AiAgentRequestWritable) => Promise<{
|
|
7186
7992
|
data: ChecksumResponse;
|
|
7187
7993
|
request: Request;
|
|
7188
7994
|
response: Response;
|
|
@@ -7227,17 +8033,17 @@ declare function _buildApi(myClient: Client): {
|
|
|
7227
8033
|
request: Request;
|
|
7228
8034
|
response: Response;
|
|
7229
8035
|
}>;
|
|
7230
|
-
create: (tenantSlug: string, datalakeSlug: string, body:
|
|
8036
|
+
create: (tenantSlug: string, datalakeSlug: string, body: ConnectedAppRequestWritable) => Promise<{
|
|
7231
8037
|
data: ConnectedAppResponse;
|
|
7232
8038
|
request: Request;
|
|
7233
8039
|
response: Response;
|
|
7234
8040
|
}>;
|
|
7235
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
8041
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: ConnectedAppRequestWritable) => Promise<{
|
|
7236
8042
|
data: ChecksumResponse;
|
|
7237
8043
|
request: Request;
|
|
7238
8044
|
response: Response;
|
|
7239
8045
|
}>;
|
|
7240
|
-
update: (tenantSlug: string, datalakeSlug: string, id: string, body:
|
|
8046
|
+
update: (tenantSlug: string, datalakeSlug: string, id: string, body: ConnectedAppRequestWritable) => Promise<{
|
|
7241
8047
|
data: ConnectedAppResponse;
|
|
7242
8048
|
request: Request;
|
|
7243
8049
|
response: Response;
|
|
@@ -7252,12 +8058,12 @@ declare function _buildApi(myClient: Client): {
|
|
|
7252
8058
|
request: Request;
|
|
7253
8059
|
response: Response;
|
|
7254
8060
|
}>;
|
|
7255
|
-
resolvePage: (tenantSlug: string, datalakeSlug: string, slug: string, body:
|
|
8061
|
+
resolvePage: (tenantSlug: string, datalakeSlug: string, slug: string, body: ResolvePageRequest) => Promise<{
|
|
7256
8062
|
data: ResolvePageResponse;
|
|
7257
8063
|
request: Request;
|
|
7258
8064
|
response: Response;
|
|
7259
8065
|
}>;
|
|
7260
|
-
updateMessageTracking: (tenantSlug: string, datalakeSlug: string, slug: string, body:
|
|
8066
|
+
updateMessageTracking: (tenantSlug: string, datalakeSlug: string, slug: string, body: UpdatePageRequest) => Promise<{
|
|
7261
8067
|
data: UpdatePageResponse;
|
|
7262
8068
|
request: Request;
|
|
7263
8069
|
response: Response;
|
|
@@ -7287,17 +8093,17 @@ declare function _buildApi(myClient: Client): {
|
|
|
7287
8093
|
request: Request;
|
|
7288
8094
|
response: Response;
|
|
7289
8095
|
}>;
|
|
7290
|
-
create: (tenantSlug: string, datalakeSlug: string, body:
|
|
8096
|
+
create: (tenantSlug: string, datalakeSlug: string, body: DataActivationClientRequestWritable) => Promise<{
|
|
7291
8097
|
data: DataActivationClientResponse;
|
|
7292
8098
|
request: Request;
|
|
7293
8099
|
response: Response;
|
|
7294
8100
|
}>;
|
|
7295
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
8101
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: DataActivationClientRequestWritable) => Promise<{
|
|
7296
8102
|
data: ChecksumResponse;
|
|
7297
8103
|
request: Request;
|
|
7298
8104
|
response: Response;
|
|
7299
8105
|
}>;
|
|
7300
|
-
update: (tenantSlug: string, datalakeSlug: string, id: string, body:
|
|
8106
|
+
update: (tenantSlug: string, datalakeSlug: string, id: string, body: DataActivationClientRequestWritable) => Promise<{
|
|
7301
8107
|
data: DataActivationClientResponse;
|
|
7302
8108
|
request: Request;
|
|
7303
8109
|
response: Response;
|
|
@@ -7320,12 +8126,12 @@ declare function _buildApi(myClient: Client): {
|
|
|
7320
8126
|
request: Request;
|
|
7321
8127
|
response: Response;
|
|
7322
8128
|
}>;
|
|
7323
|
-
runManually: (tenantSlug: string, datalakeSlug: string, slug: string, body?:
|
|
8129
|
+
runManually: (tenantSlug: string, datalakeSlug: string, slug: string, body?: RunManuallyRequestWritable) => Promise<{
|
|
7324
8130
|
data: RunManuallyResponse;
|
|
7325
8131
|
request: Request;
|
|
7326
8132
|
response: Response;
|
|
7327
8133
|
}>;
|
|
7328
|
-
ingest: (tenantSlug: string, datalakeSlug: string, slug: string, body:
|
|
8134
|
+
ingest: (tenantSlug: string, datalakeSlug: string, slug: string, body: IngestRequest) => Promise<{
|
|
7329
8135
|
data: IngestResponse;
|
|
7330
8136
|
request: Request;
|
|
7331
8137
|
response: Response;
|
|
@@ -7359,17 +8165,17 @@ declare function _buildApi(myClient: Client): {
|
|
|
7359
8165
|
request: Request;
|
|
7360
8166
|
response: Response;
|
|
7361
8167
|
}>;
|
|
7362
|
-
create: (tenantSlug: string, datalakeSlug: string, body:
|
|
8168
|
+
create: (tenantSlug: string, datalakeSlug: string, body: InteroperabilityContractRequestWritable) => Promise<{
|
|
7363
8169
|
data: InteroperabilityContractResponse;
|
|
7364
8170
|
request: Request;
|
|
7365
8171
|
response: Response;
|
|
7366
8172
|
}>;
|
|
7367
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
8173
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: InteroperabilityContractRequestWritable) => Promise<{
|
|
7368
8174
|
data: ChecksumResponse;
|
|
7369
8175
|
request: Request;
|
|
7370
8176
|
response: Response;
|
|
7371
8177
|
}>;
|
|
7372
|
-
update: (tenantSlug: string, datalakeSlug: string, id: string, body:
|
|
8178
|
+
update: (tenantSlug: string, datalakeSlug: string, id: string, body: InteroperabilityContractRequestWritable) => Promise<{
|
|
7373
8179
|
data: InteroperabilityContractResponse;
|
|
7374
8180
|
request: Request;
|
|
7375
8181
|
response: Response;
|
|
@@ -7392,14 +8198,14 @@ declare function _buildApi(myClient: Client): {
|
|
|
7392
8198
|
request: Request;
|
|
7393
8199
|
response: Response;
|
|
7394
8200
|
}>;
|
|
7395
|
-
run: (tenantSlug: string, datalakeSlug: string, slug: string, body:
|
|
8201
|
+
run: (tenantSlug: string, datalakeSlug: string, slug: string, body: InteroperabilityRunRequest) => Promise<{
|
|
7396
8202
|
data: InteroperabilityRunResponse;
|
|
7397
8203
|
request: Request;
|
|
7398
8204
|
response: Response;
|
|
7399
8205
|
}>;
|
|
7400
8206
|
};
|
|
7401
8207
|
mdm: {
|
|
7402
|
-
verify: (tenantSlug: string, datalakeSlug: string, body:
|
|
8208
|
+
verify: (tenantSlug: string, datalakeSlug: string, body: MdmVerifyRequest) => Promise<{
|
|
7403
8209
|
data: MdmVerifyResponse;
|
|
7404
8210
|
request: Request;
|
|
7405
8211
|
response: Response;
|
|
@@ -7416,17 +8222,17 @@ declare function _buildApi(myClient: Client): {
|
|
|
7416
8222
|
request: Request;
|
|
7417
8223
|
response: Response;
|
|
7418
8224
|
}>;
|
|
7419
|
-
create: (tenantSlug: string, datalakeSlug: string, body:
|
|
8225
|
+
create: (tenantSlug: string, datalakeSlug: string, body: AgenticWorkflowRequestWritable) => Promise<{
|
|
7420
8226
|
data: AgenticWorkflowResponse;
|
|
7421
8227
|
request: Request;
|
|
7422
8228
|
response: Response;
|
|
7423
8229
|
}>;
|
|
7424
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
8230
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: AgenticWorkflowRequestWritable) => Promise<{
|
|
7425
8231
|
data: ChecksumResponse;
|
|
7426
8232
|
request: Request;
|
|
7427
8233
|
response: Response;
|
|
7428
8234
|
}>;
|
|
7429
|
-
update: (tenantSlug: string, datalakeSlug: string, id: string, body:
|
|
8235
|
+
update: (tenantSlug: string, datalakeSlug: string, id: string, body: AgenticWorkflowRequestWritable) => Promise<{
|
|
7430
8236
|
data: AgenticWorkflowResponse;
|
|
7431
8237
|
request: Request;
|
|
7432
8238
|
response: Response;
|
|
@@ -7449,12 +8255,12 @@ declare function _buildApi(myClient: Client): {
|
|
|
7449
8255
|
request: Request;
|
|
7450
8256
|
response: Response;
|
|
7451
8257
|
}>;
|
|
7452
|
-
execute: (tenantSlug: string, datalakeSlug: string, workflowSlug: string, body:
|
|
8258
|
+
execute: (tenantSlug: string, datalakeSlug: string, workflowSlug: string, body: ExecuteActionRequest) => Promise<{
|
|
7453
8259
|
data: ExecuteActionResponse;
|
|
7454
8260
|
request: Request;
|
|
7455
8261
|
response: Response;
|
|
7456
8262
|
}>;
|
|
7457
|
-
run: (tenantSlug: string, datalakeSlug: string, workflowSlug: string, body:
|
|
8263
|
+
run: (tenantSlug: string, datalakeSlug: string, workflowSlug: string, body: RunWorkflowRequest) => Promise<{
|
|
7458
8264
|
data: RunWorkflowResponse;
|
|
7459
8265
|
request: Request;
|
|
7460
8266
|
response: Response;
|
|
@@ -7508,11 +8314,28 @@ declare function _buildApi(myClient: Client): {
|
|
|
7508
8314
|
}>;
|
|
7509
8315
|
};
|
|
7510
8316
|
};
|
|
8317
|
+
workflowRuns: {
|
|
8318
|
+
list: (tenantSlug: string, datalakeSlug: string, query?: PlatformApiWorkflowRunControllerIndexData["query"]) => Promise<{
|
|
8319
|
+
data: WorkflowRunListResponse;
|
|
8320
|
+
request: Request;
|
|
8321
|
+
response: Response;
|
|
8322
|
+
}>;
|
|
8323
|
+
get: (tenantSlug: string, datalakeSlug: string, id: string) => Promise<{
|
|
8324
|
+
data: WorkflowRunResponse;
|
|
8325
|
+
request: Request;
|
|
8326
|
+
response: Response;
|
|
8327
|
+
}>;
|
|
8328
|
+
cancel: (tenantSlug: string, datalakeSlug: string, id: string) => Promise<{
|
|
8329
|
+
data: WorkflowRunResponse;
|
|
8330
|
+
request: Request;
|
|
8331
|
+
response: Response;
|
|
8332
|
+
}>;
|
|
8333
|
+
};
|
|
7511
8334
|
};
|
|
7512
8335
|
//# sourceMappingURL=client.d.ts.map
|
|
7513
8336
|
//#endregion
|
|
7514
8337
|
//#region src/index.d.ts
|
|
7515
8338
|
declare function isEnvironmentName(name: string): name is EnvironmentName;
|
|
7516
8339
|
//#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 };
|
|
8340
|
+
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
8341
|
//# sourceMappingURL=index.d.mts.map
|