@alvera-ai/platform-sdk 0.14.0 → 0.15.0-next.g2f28e7b
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/action_status_updaters.md +113 -14
- package/.agent/ai_agents.md +1 -0
- package/.agent/cookbook/appointment-review-sms-workflow.md +1 -0
- package/.agent/cookbook/birthday-greeting-sms-trigger.md +2 -1
- package/.agent/cookbook/contact-us-triage-with-llm.md +2 -1
- package/.agent/cookbook/dunning-sms-for-delinquent.md +2 -1
- package/.agent/cookbook/kyc-notification-on-account-activation.md +2 -1
- package/.agent/cookbook/marketing-campaign-send.md +1 -0
- package/.agent/cookbook/paginated-restapi-poller.md +62 -8
- package/.agent/cookbook/sanctions-screening-with-agent-review.md +2 -1
- package/.agent/cookbook/score-leads-with-llm-categorization.md +2 -1
- package/.agent/cookbook/triage-prospects-by-priority.md +2 -1
- package/.agent/cookbook/welcome-sms-for-customers.md +2 -1
- package/.agent/datalakes.md +44 -3
- package/.agent/errors.md +7 -1
- package/.agent/workflows.md +23 -0
- package/dist/index.d.mts +574 -113
- package/dist/index.d.mts.map +1 -1
- 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
|
*/
|
|
@@ -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
|
/**
|
|
@@ -2141,6 +2173,21 @@ type DatasetSearchResponse = {
|
|
|
2141
2173
|
};
|
|
2142
2174
|
user_search: UserSearchResponse;
|
|
2143
2175
|
};
|
|
2176
|
+
/**
|
|
2177
|
+
* InvitationRequest
|
|
2178
|
+
*
|
|
2179
|
+
* Pending tenant invitation — resolved into a Membership on accept. Request
|
|
2180
|
+
*/
|
|
2181
|
+
type InvitationRequest = {
|
|
2182
|
+
/**
|
|
2183
|
+
* Recipient email address. Must be unique per tenant.
|
|
2184
|
+
*/
|
|
2185
|
+
email: string;
|
|
2186
|
+
/**
|
|
2187
|
+
* 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.
|
|
2188
|
+
*/
|
|
2189
|
+
role: 'member' | 'researcher' | 'admin';
|
|
2190
|
+
};
|
|
2144
2191
|
/**
|
|
2145
2192
|
* ActionAWSLambdaCallResponse
|
|
2146
2193
|
*/
|
|
@@ -2543,6 +2590,33 @@ type SftpResponse = {
|
|
|
2543
2590
|
type ToolSnsResponse = SnsResponse & {
|
|
2544
2591
|
tool_body_type: 'sns';
|
|
2545
2592
|
};
|
|
2593
|
+
/**
|
|
2594
|
+
* UserSearchRequest
|
|
2595
|
+
*
|
|
2596
|
+
* User SQL search resource. Created via `POST /datasets/:dataset/user-searches`
|
|
2597
|
+
* with a `WHERE`-clause body in `search_query`; the platform executes
|
|
2598
|
+
* `INSERT INTO search_results SELECT … WHERE <body>` to populate
|
|
2599
|
+
* `search_results` and reports back `status`, `results_count`, and
|
|
2600
|
+
* `error_message`.
|
|
2601
|
+
*
|
|
2602
|
+
* UserSearch carries no `data_access_mode` of its own — the capability check
|
|
2603
|
+
* runs at query time via `Platform.RegulatedDatalakeRepo.prepare_query/3`,
|
|
2604
|
+
* which reads the ambient session and raises 403 when the ceiling is
|
|
2605
|
+
* insufficient. ExOpenApiUtils derives `UserSearchRequest` (writeable subset)
|
|
2606
|
+
* and `UserSearchResponse` (full readable shape) from this declaration via
|
|
2607
|
+
* the readOnly/writeOnly markers on each property.
|
|
2608
|
+
* Request
|
|
2609
|
+
*/
|
|
2610
|
+
type UserSearchRequest = {
|
|
2611
|
+
/**
|
|
2612
|
+
* Generic-table identifier. Required when the dataset is a generic table; must be omitted otherwise.
|
|
2613
|
+
*/
|
|
2614
|
+
generic_table_id?: string | null;
|
|
2615
|
+
/**
|
|
2616
|
+
* 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`).
|
|
2617
|
+
*/
|
|
2618
|
+
search_query: string;
|
|
2619
|
+
};
|
|
2546
2620
|
/**
|
|
2547
2621
|
* AdminApiKeyResponse
|
|
2548
2622
|
*
|
|
@@ -2900,6 +2974,12 @@ type DataSourceListResponse = {
|
|
|
2900
2974
|
data: Array<DataSourceResponse>;
|
|
2901
2975
|
meta: PaginationMeta;
|
|
2902
2976
|
};
|
|
2977
|
+
/**
|
|
2978
|
+
* ActionManualUploadCallRequest
|
|
2979
|
+
*/
|
|
2980
|
+
type ActionManualUploadCallRequest = ManualUploadCallRequest & {
|
|
2981
|
+
tool_call_type: 'manual_upload';
|
|
2982
|
+
};
|
|
2903
2983
|
/**
|
|
2904
2984
|
* SharePointExcelCallResponse
|
|
2905
2985
|
*
|
|
@@ -3133,6 +3213,12 @@ type ToolListResponse = {
|
|
|
3133
3213
|
data: Array<ToolResponse>;
|
|
3134
3214
|
meta: PaginationMeta;
|
|
3135
3215
|
};
|
|
3216
|
+
/**
|
|
3217
|
+
* ManualToolInvocationSQLQueryCallResponse
|
|
3218
|
+
*/
|
|
3219
|
+
type ManualToolInvocationSqlQueryCallResponse = SqlQueryCallResponse & {
|
|
3220
|
+
tool_call_type: 'sql_query';
|
|
3221
|
+
};
|
|
3136
3222
|
/**
|
|
3137
3223
|
* SQSResponse
|
|
3138
3224
|
*
|
|
@@ -3715,6 +3801,24 @@ type InteroperabilityContractListResponse = {
|
|
|
3715
3801
|
type ToolEndUserMessagingResponse = EndUserMessagingResponse & {
|
|
3716
3802
|
tool_body_type: 'end_user_messaging';
|
|
3717
3803
|
};
|
|
3804
|
+
/**
|
|
3805
|
+
* TenantRequest
|
|
3806
|
+
*
|
|
3807
|
+
* Tenant resource. The auto-generated `TenantRequest` shape carries only
|
|
3808
|
+
* the writable fields (`name`, `description`); `TenantResponse` returns the
|
|
3809
|
+
* full read surface (`id`, `slug`, `name`, `description`).
|
|
3810
|
+
* Request
|
|
3811
|
+
*/
|
|
3812
|
+
type TenantRequest = {
|
|
3813
|
+
/**
|
|
3814
|
+
* Optional free-text description; max 1000 chars.
|
|
3815
|
+
*/
|
|
3816
|
+
description?: string | null;
|
|
3817
|
+
/**
|
|
3818
|
+
* Human-readable tenant name. Required on create; max 160 chars.
|
|
3819
|
+
*/
|
|
3820
|
+
name: string;
|
|
3821
|
+
};
|
|
3718
3822
|
/**
|
|
3719
3823
|
* ActionStatusUpdaterListResponse
|
|
3720
3824
|
*
|
|
@@ -4189,33 +4293,6 @@ type DataSourceResponse = {
|
|
|
4189
4293
|
type ToolRestapiResponse = RestapiResponse & {
|
|
4190
4294
|
tool_body_type: 'rest_api';
|
|
4191
4295
|
};
|
|
4192
|
-
/**
|
|
4193
|
-
* ContextDatasetResponse
|
|
4194
|
-
*
|
|
4195
|
-
* Context dataset for a workflow — declares which records the context builder should load (and under what filter) before the enrichment and decision stages.
|
|
4196
|
-
*/
|
|
4197
|
-
type ContextDatasetResponseWritable = {
|
|
4198
|
-
/**
|
|
4199
|
-
* Dataset type — either a standard industry resource (e.g. "patient", "appointment") or "generic_table" to reference a custom table
|
|
4200
|
-
*/
|
|
4201
|
-
dataset_type: string;
|
|
4202
|
-
/**
|
|
4203
|
-
* Required when `dataset_type == "generic_table"`
|
|
4204
|
-
*/
|
|
4205
|
-
generic_table_id?: string | null;
|
|
4206
|
-
/**
|
|
4207
|
-
* Max records to load for this context dataset
|
|
4208
|
-
*/
|
|
4209
|
-
limit?: number | null;
|
|
4210
|
-
/**
|
|
4211
|
-
* Ordering within the context-builder pipeline
|
|
4212
|
-
*/
|
|
4213
|
-
position?: number;
|
|
4214
|
-
/**
|
|
4215
|
-
* Liquid-templated SQL WHERE clause for filtering records at runtime. The context builder appends the MDM subject FK automatically.
|
|
4216
|
-
*/
|
|
4217
|
-
where_clause?: string | null;
|
|
4218
|
-
};
|
|
4219
4296
|
/**
|
|
4220
4297
|
* DatalakeRequest
|
|
4221
4298
|
*
|
|
@@ -4391,6 +4468,28 @@ type DatalakeRequestWritable = {
|
|
|
4391
4468
|
type ToolRestapiRequestWritable = RestapiRequestWritable & {
|
|
4392
4469
|
tool_body_type: 'rest_api';
|
|
4393
4470
|
};
|
|
4471
|
+
/**
|
|
4472
|
+
* EmailCallRequest
|
|
4473
|
+
*
|
|
4474
|
+
* Email tool-call config — Liquid-templated recipient, subject, and body. Request
|
|
4475
|
+
*/
|
|
4476
|
+
type EmailCallRequestWritable = {
|
|
4477
|
+
body: SimpleTemplateConfigRequest;
|
|
4478
|
+
subject: SimpleTemplateConfigRequest;
|
|
4479
|
+
to: SimpleTemplateConfigRequest;
|
|
4480
|
+
};
|
|
4481
|
+
/**
|
|
4482
|
+
* ActionEmailCallRequest
|
|
4483
|
+
*/
|
|
4484
|
+
type ActionEmailCallRequestWritable = EmailCallRequestWritable & {
|
|
4485
|
+
tool_call_type: 'email_request';
|
|
4486
|
+
};
|
|
4487
|
+
/**
|
|
4488
|
+
* ActionSMSCallRequest
|
|
4489
|
+
*/
|
|
4490
|
+
type ActionSmsCallRequestWritable = SmsCallRequestWritable & {
|
|
4491
|
+
tool_call_type: 'sms_request';
|
|
4492
|
+
};
|
|
4394
4493
|
/**
|
|
4395
4494
|
* DataActivationClientSharePointExcelCallRequest
|
|
4396
4495
|
*/
|
|
@@ -4404,13 +4503,13 @@ type DataActivationClientSharePointExcelCallRequestWritable = SharePointExcelCal
|
|
|
4404
4503
|
*/
|
|
4405
4504
|
type AgenticWorkflowRequestWritable = {
|
|
4406
4505
|
/**
|
|
4407
|
-
* Decision actions
|
|
4506
|
+
* Decision actions to attach to this workflow (request)
|
|
4408
4507
|
*/
|
|
4409
|
-
actions?: Array<
|
|
4508
|
+
actions?: Array<ActionRequestWritable>;
|
|
4410
4509
|
/**
|
|
4411
|
-
* Context-enrichment datasets
|
|
4510
|
+
* Context-enrichment datasets to load before the decision stage (request)
|
|
4412
4511
|
*/
|
|
4413
|
-
context_datasets?: Array<
|
|
4512
|
+
context_datasets?: Array<ContextDatasetRequestWritable>;
|
|
4414
4513
|
/**
|
|
4415
4514
|
* Dataset type the workflow listens on (e.g. patient, appointment, generic_table)
|
|
4416
4515
|
*/
|
|
@@ -4445,6 +4544,10 @@ type AgenticWorkflowRequestWritable = {
|
|
|
4445
4544
|
* 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
4545
|
*/
|
|
4447
4546
|
status: 'live' | 'draft' | 'manual';
|
|
4547
|
+
/**
|
|
4548
|
+
* 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.
|
|
4549
|
+
*/
|
|
4550
|
+
tags: Array<string>;
|
|
4448
4551
|
/**
|
|
4449
4552
|
* Last update timestamp
|
|
4450
4553
|
*/
|
|
@@ -4471,56 +4574,17 @@ type InteroperabilityContractAiAgentRequestWritable = {
|
|
|
4471
4574
|
position: number;
|
|
4472
4575
|
};
|
|
4473
4576
|
/**
|
|
4474
|
-
*
|
|
4577
|
+
* MMSCallRequest
|
|
4475
4578
|
*
|
|
4476
|
-
*
|
|
4579
|
+
* MMS tool-call config — Liquid-templated recipient and body, plain public media URL. Request
|
|
4477
4580
|
*/
|
|
4478
|
-
type
|
|
4479
|
-
|
|
4581
|
+
type MmsCallRequestWritable = {
|
|
4582
|
+
body: SimpleTemplateConfigRequest;
|
|
4480
4583
|
/**
|
|
4481
|
-
*
|
|
4482
|
-
*/
|
|
4483
|
-
action_window_end?: number | null;
|
|
4484
|
-
/**
|
|
4485
|
-
* Hour (0–23) when the action's execution window opens (failsafe, typically SMS)
|
|
4486
|
-
*/
|
|
4487
|
-
action_window_start?: number | null;
|
|
4488
|
-
/**
|
|
4489
|
-
* Optional connected app — when set, the executor mints a per-recipient connected_app_form_url template variable; connected_app_route is required
|
|
4490
|
-
*/
|
|
4491
|
-
connected_app_id?: string | null;
|
|
4492
|
-
/**
|
|
4493
|
-
* Liquid template rendered to JSON at execution time and stored in the connected-app page token (optional)
|
|
4494
|
-
*/
|
|
4495
|
-
connected_app_metadata_template?: string | null;
|
|
4496
|
-
/**
|
|
4497
|
-
* Route path within the connected app — required when connected_app_id is set
|
|
4498
|
-
*/
|
|
4499
|
-
connected_app_route?: string | null;
|
|
4500
|
-
/**
|
|
4501
|
-
* Unique decision_key within the workflow — maps to a decision-table outcome
|
|
4502
|
-
*/
|
|
4503
|
-
decision_key: string;
|
|
4504
|
-
/**
|
|
4505
|
-
* Liquid template producing the idempotency key; receives checksum, subject_id, workflow_id, action_id, decision_key
|
|
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
|
|
4584
|
+
* Public http(s) URL of the media to attach — fetched and re-staged into the tool's S3 media bucket
|
|
4522
4585
|
*/
|
|
4523
|
-
|
|
4586
|
+
media_url: string;
|
|
4587
|
+
to: SimpleTemplateConfigRequest;
|
|
4524
4588
|
};
|
|
4525
4589
|
/**
|
|
4526
4590
|
* EndUserMessagingRequest
|
|
@@ -4680,6 +4744,81 @@ type AwsLambdaRequestWritable = {
|
|
|
4680
4744
|
type ToolSqsRequestWritable = SqsRequestWritable & {
|
|
4681
4745
|
tool_body_type: 'sqs';
|
|
4682
4746
|
};
|
|
4747
|
+
/**
|
|
4748
|
+
* ActionRequest
|
|
4749
|
+
*
|
|
4750
|
+
* 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
|
|
4751
|
+
*/
|
|
4752
|
+
type ActionRequestWritable = {
|
|
4753
|
+
action_type: ActionType;
|
|
4754
|
+
/**
|
|
4755
|
+
* Hour (0–23) when the action's execution window closes
|
|
4756
|
+
*/
|
|
4757
|
+
action_window_end?: number | null;
|
|
4758
|
+
/**
|
|
4759
|
+
* Hour (0–23) when the action's execution window opens (failsafe, typically SMS)
|
|
4760
|
+
*/
|
|
4761
|
+
action_window_start?: number | null;
|
|
4762
|
+
/**
|
|
4763
|
+
* Optional connected app — when set, the executor mints a per-recipient connected_app_form_url template variable; connected_app_route is required
|
|
4764
|
+
*/
|
|
4765
|
+
connected_app_id?: string | null;
|
|
4766
|
+
/**
|
|
4767
|
+
* Liquid template rendered to JSON at execution time and stored in the connected-app page token (optional)
|
|
4768
|
+
*/
|
|
4769
|
+
connected_app_metadata_template?: string | null;
|
|
4770
|
+
/**
|
|
4771
|
+
* Route path within the connected app — required when connected_app_id is set
|
|
4772
|
+
*/
|
|
4773
|
+
connected_app_route?: string | null;
|
|
4774
|
+
/**
|
|
4775
|
+
* Unique decision_key within the workflow — maps to a decision-table outcome
|
|
4776
|
+
*/
|
|
4777
|
+
decision_key: string;
|
|
4778
|
+
/**
|
|
4779
|
+
* Action ID — echo it back on update to modify the existing action rather than replace it
|
|
4780
|
+
*/
|
|
4781
|
+
id?: string;
|
|
4782
|
+
/**
|
|
4783
|
+
* Liquid template producing the idempotency key; receives checksum, subject_id, workflow_id, action_id, decision_key
|
|
4784
|
+
*/
|
|
4785
|
+
idempotency_template: string;
|
|
4786
|
+
/**
|
|
4787
|
+
* Display order within the workflow
|
|
4788
|
+
*/
|
|
4789
|
+
position?: number;
|
|
4790
|
+
/**
|
|
4791
|
+
* Liquid template evaluated at execution time; when falsy, the action is skipped
|
|
4792
|
+
*/
|
|
4793
|
+
runtime_filter?: string | null;
|
|
4794
|
+
tool_call: ({
|
|
4795
|
+
tool_call_type: 'sms_request';
|
|
4796
|
+
} & ActionSmsCallRequestWritable) | ({
|
|
4797
|
+
tool_call_type: 'mms_request';
|
|
4798
|
+
} & ActionMmsCallRequestWritable) | ({
|
|
4799
|
+
tool_call_type: 'email_request';
|
|
4800
|
+
} & ActionEmailCallRequestWritable) | ({
|
|
4801
|
+
tool_call_type: 'sql_query';
|
|
4802
|
+
} & ActionSqlQueryCallRequestWritable) | ({
|
|
4803
|
+
tool_call_type: 'restapi_request';
|
|
4804
|
+
} & ActionRestCallRequestWritable) | ({
|
|
4805
|
+
tool_call_type: 'sftp_request';
|
|
4806
|
+
} & ActionSftpCallRequestWritable) | ({
|
|
4807
|
+
tool_call_type: 'microsoft_share_point_excel_request';
|
|
4808
|
+
} & ActionSharePointExcelCallRequestWritable) | ({
|
|
4809
|
+
tool_call_type: 'aws_lambda_request';
|
|
4810
|
+
} & ActionAwsLambdaCallRequestWritable) | ({
|
|
4811
|
+
tool_call_type: 'manual_upload';
|
|
4812
|
+
} & ActionManualUploadCallRequest);
|
|
4813
|
+
/**
|
|
4814
|
+
* Tool that executes this action
|
|
4815
|
+
*/
|
|
4816
|
+
tool_id: string;
|
|
4817
|
+
/**
|
|
4818
|
+
* Liquid template that determines when this action executes
|
|
4819
|
+
*/
|
|
4820
|
+
trigger_template: string;
|
|
4821
|
+
};
|
|
4683
4822
|
/**
|
|
4684
4823
|
* DatalakeCloudStorageR2Request
|
|
4685
4824
|
*/
|
|
@@ -4708,6 +4847,74 @@ type WorkflowAiAgentRequestWritable = {
|
|
|
4708
4847
|
*/
|
|
4709
4848
|
position: number;
|
|
4710
4849
|
};
|
|
4850
|
+
/**
|
|
4851
|
+
* AiAgentRequest
|
|
4852
|
+
*
|
|
4853
|
+
* AI Agent configuration — reusable chat-completion resource Request
|
|
4854
|
+
*/
|
|
4855
|
+
type AiAgentRequestWritable = {
|
|
4856
|
+
/**
|
|
4857
|
+
* Data access level
|
|
4858
|
+
*/
|
|
4859
|
+
data_access: 'regulated' | 'unregulated';
|
|
4860
|
+
/**
|
|
4861
|
+
* Agent description
|
|
4862
|
+
*/
|
|
4863
|
+
description?: string | null;
|
|
4864
|
+
/**
|
|
4865
|
+
* Whether the agent is enabled
|
|
4866
|
+
*/
|
|
4867
|
+
enabled: boolean;
|
|
4868
|
+
/**
|
|
4869
|
+
* AI Agent ID
|
|
4870
|
+
*/
|
|
4871
|
+
id?: string;
|
|
4872
|
+
/**
|
|
4873
|
+
* JSON Schema describing the agent's input contract — validated by the runner against caller context on every invocation.
|
|
4874
|
+
*/
|
|
4875
|
+
input_schema: {
|
|
4876
|
+
[key: string]: unknown;
|
|
4877
|
+
};
|
|
4878
|
+
/**
|
|
4879
|
+
* Creation timestamp
|
|
4880
|
+
*/
|
|
4881
|
+
inserted_at?: string;
|
|
4882
|
+
/**
|
|
4883
|
+
* JSON Schema for LLM response format
|
|
4884
|
+
*/
|
|
4885
|
+
llm_response_schema: {
|
|
4886
|
+
[key: string]: unknown;
|
|
4887
|
+
} | null;
|
|
4888
|
+
/**
|
|
4889
|
+
* Maximum tokens for LLM response
|
|
4890
|
+
*/
|
|
4891
|
+
max_tokens: number;
|
|
4892
|
+
/**
|
|
4893
|
+
* LLM model identifier
|
|
4894
|
+
*/
|
|
4895
|
+
model: string;
|
|
4896
|
+
/**
|
|
4897
|
+
* Agent name
|
|
4898
|
+
*/
|
|
4899
|
+
name: string;
|
|
4900
|
+
prompt_config: SimpleTemplateConfigRequest;
|
|
4901
|
+
/**
|
|
4902
|
+
* URL-friendly slug
|
|
4903
|
+
*/
|
|
4904
|
+
slug?: string;
|
|
4905
|
+
/**
|
|
4906
|
+
* Sampling temperature (0.0–2.0)
|
|
4907
|
+
*/
|
|
4908
|
+
temperature: number;
|
|
4909
|
+
/**
|
|
4910
|
+
* Tool ID
|
|
4911
|
+
*/
|
|
4912
|
+
tool_id: string;
|
|
4913
|
+
/**
|
|
4914
|
+
* Last update timestamp
|
|
4915
|
+
*/
|
|
4916
|
+
updated_at?: string;
|
|
4917
|
+
};
|
|
4711
4918
|
/**
|
|
4712
4919
|
* EmailRequest
|
|
4713
4920
|
*
|
|
@@ -4783,12 +4990,53 @@ type S3CloudStorageR2RequestWritable = CloudStorageR2RequestWritable & {
|
|
|
4783
4990
|
type ToolSqlDatabaseRequestWritable = SqlDatabaseRequestWritable & {
|
|
4784
4991
|
tool_body_type: 'sql_database';
|
|
4785
4992
|
};
|
|
4993
|
+
/**
|
|
4994
|
+
* ActionRESTCallRequest
|
|
4995
|
+
*/
|
|
4996
|
+
type ActionRestCallRequestWritable = RestCallRequestWritable & {
|
|
4997
|
+
tool_call_type: 'restapi_request';
|
|
4998
|
+
};
|
|
4999
|
+
/**
|
|
5000
|
+
* GenericTableRequest
|
|
5001
|
+
*
|
|
5002
|
+
* Generic Table — custom or system dataset table with column definitions. Request
|
|
5003
|
+
*/
|
|
5004
|
+
type GenericTableRequestWritable = {
|
|
5005
|
+
/**
|
|
5006
|
+
* Table column definitions
|
|
5007
|
+
*/
|
|
5008
|
+
columns?: Array<GenericTableColumnRequest>;
|
|
5009
|
+
/**
|
|
5010
|
+
* 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.
|
|
5011
|
+
*/
|
|
5012
|
+
data_domain?: 'healthcare' | 'core_banking' | 'payments' | 'subscription' | 'service_commerce' | 'trading' | 'foundation';
|
|
5013
|
+
/**
|
|
5014
|
+
* Table description
|
|
5015
|
+
*/
|
|
5016
|
+
description?: string;
|
|
5017
|
+
/**
|
|
5018
|
+
* User-friendly table title
|
|
5019
|
+
*/
|
|
5020
|
+
title?: string;
|
|
5021
|
+
};
|
|
4786
5022
|
/**
|
|
4787
5023
|
* ToolSFTPRequest
|
|
4788
5024
|
*/
|
|
4789
5025
|
type ToolSftpRequestWritable = SftpRequestWritable & {
|
|
4790
5026
|
tool_body_type: 'sftp';
|
|
4791
5027
|
};
|
|
5028
|
+
/**
|
|
5029
|
+
* ActionSQLQueryCallRequest
|
|
5030
|
+
*/
|
|
5031
|
+
type ActionSqlQueryCallRequestWritable = SqlQueryCallRequestWritable & {
|
|
5032
|
+
tool_call_type: 'sql_query';
|
|
5033
|
+
};
|
|
5034
|
+
/**
|
|
5035
|
+
* ActionSFTPCallRequest
|
|
5036
|
+
*/
|
|
5037
|
+
type ActionSftpCallRequestWritable = SftpCallRequest & {
|
|
5038
|
+
tool_call_type: 'sftp_request';
|
|
5039
|
+
};
|
|
4792
5040
|
/**
|
|
4793
5041
|
* AWSLambdaCallRequest
|
|
4794
5042
|
*
|
|
@@ -4807,6 +5055,12 @@ type AwsLambdaCallRequestWritable = {
|
|
|
4807
5055
|
type ToolCloudWatchLogGroupRequestWritable = CloudWatchLogGroupRequestWritable & {
|
|
4808
5056
|
tool_body_type: 'cloud_watch_log_group';
|
|
4809
5057
|
};
|
|
5058
|
+
/**
|
|
5059
|
+
* ManualToolInvocationSQLQueryCallRequest
|
|
5060
|
+
*/
|
|
5061
|
+
type ManualToolInvocationSqlQueryCallRequestWritable = SqlQueryCallRequestWritable & {
|
|
5062
|
+
tool_call_type: 'sql_query';
|
|
5063
|
+
};
|
|
4810
5064
|
/**
|
|
4811
5065
|
* DataActivationClientAWSLambdaCallRequest
|
|
4812
5066
|
*/
|
|
@@ -4896,6 +5150,32 @@ type SharePointRequestWritable = {
|
|
|
4896
5150
|
*/
|
|
4897
5151
|
site_url?: string | null;
|
|
4898
5152
|
};
|
|
5153
|
+
/**
|
|
5154
|
+
* ManualToolInvocationSMSCallRequest
|
|
5155
|
+
*/
|
|
5156
|
+
type ManualToolInvocationSmsCallRequestWritable = SmsCallRequestWritable & {
|
|
5157
|
+
tool_call_type: 'sms_request';
|
|
5158
|
+
};
|
|
5159
|
+
/**
|
|
5160
|
+
* ManualToolInvocationRequest
|
|
5161
|
+
*
|
|
5162
|
+
* 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
|
|
5163
|
+
*/
|
|
5164
|
+
type ManualToolInvocationRequestWritable = {
|
|
5165
|
+
tool_call?: ({
|
|
5166
|
+
tool_call_type: 'sms_request';
|
|
5167
|
+
} & ManualToolInvocationSmsCallRequestWritable) | ({
|
|
5168
|
+
tool_call_type: 'mms_request';
|
|
5169
|
+
} & ManualToolInvocationMmsCallRequestWritable) | ({
|
|
5170
|
+
tool_call_type: 'email_request';
|
|
5171
|
+
} & ManualToolInvocationEmailCallRequestWritable) | ({
|
|
5172
|
+
tool_call_type: 'restapi_request';
|
|
5173
|
+
} & ManualToolInvocationRestCallRequestWritable) | ({
|
|
5174
|
+
tool_call_type: 'aws_lambda_request';
|
|
5175
|
+
} & ManualToolInvocationAwsLambdaCallRequestWritable) | ({
|
|
5176
|
+
tool_call_type: 'sql_query';
|
|
5177
|
+
} & ManualToolInvocationSqlQueryCallRequestWritable);
|
|
5178
|
+
};
|
|
4899
5179
|
/**
|
|
4900
5180
|
* SQLQueryCallRequest
|
|
4901
5181
|
*
|
|
@@ -4986,6 +5266,24 @@ type SnsRequestWritable = {
|
|
|
4986
5266
|
type ToolEmailRequestWritable = EmailRequestWritable & {
|
|
4987
5267
|
tool_body_type: 'email';
|
|
4988
5268
|
};
|
|
5269
|
+
/**
|
|
5270
|
+
* ManualToolInvocationMMSCallRequest
|
|
5271
|
+
*/
|
|
5272
|
+
type ManualToolInvocationMmsCallRequestWritable = MmsCallRequestWritable & {
|
|
5273
|
+
tool_call_type: 'mms_request';
|
|
5274
|
+
};
|
|
5275
|
+
/**
|
|
5276
|
+
* ActionStatusUpdaterCloudWatchQueryRequest
|
|
5277
|
+
*/
|
|
5278
|
+
type ActionStatusUpdaterCloudWatchQueryRequestWritable = CloudWatchQueryRequest & {
|
|
5279
|
+
updater_body_type: 'cloud_watch_request';
|
|
5280
|
+
};
|
|
5281
|
+
/**
|
|
5282
|
+
* ActionStatusUpdaterRESTCallRequest
|
|
5283
|
+
*/
|
|
5284
|
+
type ActionStatusUpdaterRestCallRequestWritable = RestCallRequestWritable & {
|
|
5285
|
+
updater_body_type: 'restapi_request';
|
|
5286
|
+
};
|
|
4989
5287
|
/**
|
|
4990
5288
|
* SQSRequest
|
|
4991
5289
|
*
|
|
@@ -5028,6 +5326,12 @@ type SqsRequestWritable = {
|
|
|
5028
5326
|
type ToolAwsLambdaRequestWritable = AwsLambdaRequestWritable & {
|
|
5029
5327
|
tool_body_type: 'aws_lambda';
|
|
5030
5328
|
};
|
|
5329
|
+
/**
|
|
5330
|
+
* ActionSharePointExcelCallRequest
|
|
5331
|
+
*/
|
|
5332
|
+
type ActionSharePointExcelCallRequestWritable = SharePointExcelCallRequest & {
|
|
5333
|
+
tool_call_type: 'microsoft_share_point_excel_request';
|
|
5334
|
+
};
|
|
5031
5335
|
/**
|
|
5032
5336
|
* InteroperabilityContractRequest
|
|
5033
5337
|
*
|
|
@@ -5097,6 +5401,37 @@ type RestCallRequestWritable = {
|
|
|
5097
5401
|
params?: SimpleTemplateConfigRequest;
|
|
5098
5402
|
path: SimpleTemplateConfigRequest;
|
|
5099
5403
|
};
|
|
5404
|
+
/**
|
|
5405
|
+
* ContextDatasetRequest
|
|
5406
|
+
*
|
|
5407
|
+
* Context dataset for a workflow — declares which records the context builder should load (and under what filter) before the enrichment and decision stages. Request
|
|
5408
|
+
*/
|
|
5409
|
+
type ContextDatasetRequestWritable = {
|
|
5410
|
+
/**
|
|
5411
|
+
* Dataset type — either a standard industry resource (e.g. "patient", "appointment") or "generic_table" to reference a custom table
|
|
5412
|
+
*/
|
|
5413
|
+
dataset_type: string;
|
|
5414
|
+
/**
|
|
5415
|
+
* Required when `dataset_type == "generic_table"`
|
|
5416
|
+
*/
|
|
5417
|
+
generic_table_id?: string | null;
|
|
5418
|
+
/**
|
|
5419
|
+
* Context dataset ID — echo it back on update to modify the existing dataset rather than replace it
|
|
5420
|
+
*/
|
|
5421
|
+
id?: string;
|
|
5422
|
+
/**
|
|
5423
|
+
* Max records to load for this context dataset
|
|
5424
|
+
*/
|
|
5425
|
+
limit?: number | null;
|
|
5426
|
+
/**
|
|
5427
|
+
* Ordering within the context-builder pipeline
|
|
5428
|
+
*/
|
|
5429
|
+
position?: number;
|
|
5430
|
+
/**
|
|
5431
|
+
* Liquid-templated SQL WHERE clause for filtering records at runtime. The context builder appends the MDM subject FK automatically.
|
|
5432
|
+
*/
|
|
5433
|
+
where_clause?: string | null;
|
|
5434
|
+
};
|
|
5100
5435
|
/**
|
|
5101
5436
|
* RESTAPIRequest
|
|
5102
5437
|
*
|
|
@@ -5368,6 +5703,12 @@ type DataActivationClientRequestWritable = {
|
|
|
5368
5703
|
*/
|
|
5369
5704
|
tool_id: string;
|
|
5370
5705
|
};
|
|
5706
|
+
/**
|
|
5707
|
+
* ActionAWSLambdaCallRequest
|
|
5708
|
+
*/
|
|
5709
|
+
type ActionAwsLambdaCallRequestWritable = AwsLambdaCallRequestWritable & {
|
|
5710
|
+
tool_call_type: 'aws_lambda_request';
|
|
5711
|
+
};
|
|
5371
5712
|
/**
|
|
5372
5713
|
* DataActivationClientSFTPCallRequest
|
|
5373
5714
|
*/
|
|
@@ -5405,18 +5746,71 @@ type RunManuallyRequestWritable = {
|
|
|
5405
5746
|
type ToolEndUserMessagingRequestWritable = EndUserMessagingRequestWritable & {
|
|
5406
5747
|
tool_body_type: 'end_user_messaging';
|
|
5407
5748
|
};
|
|
5749
|
+
/**
|
|
5750
|
+
* ManualToolInvocationEmailCallRequest
|
|
5751
|
+
*/
|
|
5752
|
+
type ManualToolInvocationEmailCallRequestWritable = EmailCallRequestWritable & {
|
|
5753
|
+
tool_call_type: 'email_request';
|
|
5754
|
+
};
|
|
5408
5755
|
/**
|
|
5409
5756
|
* DatalakeCloudStorageAwsRequest
|
|
5410
5757
|
*/
|
|
5411
5758
|
type DatalakeCloudStorageAwsRequestWritable = CloudStorageAwsRequestWritable & {
|
|
5412
5759
|
cloud_storage_type: 'aws';
|
|
5413
5760
|
};
|
|
5761
|
+
/**
|
|
5762
|
+
* ActionMMSCallRequest
|
|
5763
|
+
*/
|
|
5764
|
+
type ActionMmsCallRequestWritable = MmsCallRequestWritable & {
|
|
5765
|
+
tool_call_type: 'mms_request';
|
|
5766
|
+
};
|
|
5767
|
+
/**
|
|
5768
|
+
* ManualToolInvocationAWSLambdaCallRequest
|
|
5769
|
+
*/
|
|
5770
|
+
type ManualToolInvocationAwsLambdaCallRequestWritable = AwsLambdaCallRequestWritable & {
|
|
5771
|
+
tool_call_type: 'aws_lambda_request';
|
|
5772
|
+
};
|
|
5414
5773
|
/**
|
|
5415
5774
|
* ToolS3Request
|
|
5416
5775
|
*/
|
|
5417
5776
|
type ToolS3RequestWritable = S3RequestWritable & {
|
|
5418
5777
|
tool_body_type: 's3';
|
|
5419
5778
|
};
|
|
5779
|
+
/**
|
|
5780
|
+
* ManualToolInvocationRESTCallRequest
|
|
5781
|
+
*/
|
|
5782
|
+
type ManualToolInvocationRestCallRequestWritable = RestCallRequestWritable & {
|
|
5783
|
+
tool_call_type: 'restapi_request';
|
|
5784
|
+
};
|
|
5785
|
+
/**
|
|
5786
|
+
* SignUpRequest
|
|
5787
|
+
*
|
|
5788
|
+
* Register a new user account. Mirrors the `/auth/register` LiveView form
|
|
5789
|
+
* submission shape. The created user is **unconfirmed** — caller must
|
|
5790
|
+
* confirm separately (e.g. via the email confirmation flow, or via
|
|
5791
|
+
* `PUT /api/v1/admin/users/:id/confirm` for tests) before signing in.
|
|
5792
|
+
*
|
|
5793
|
+
* No authentication is required.
|
|
5794
|
+
* Request
|
|
5795
|
+
*/
|
|
5796
|
+
type SignUpRequestWritable = {
|
|
5797
|
+
/**
|
|
5798
|
+
* User email
|
|
5799
|
+
*/
|
|
5800
|
+
email: string;
|
|
5801
|
+
/**
|
|
5802
|
+
* First name
|
|
5803
|
+
*/
|
|
5804
|
+
first_name: string | null;
|
|
5805
|
+
/**
|
|
5806
|
+
* Last name
|
|
5807
|
+
*/
|
|
5808
|
+
last_name: string | null;
|
|
5809
|
+
/**
|
|
5810
|
+
* Password (8–72 characters; mirrors the `/auth/register` LiveView form)
|
|
5811
|
+
*/
|
|
5812
|
+
password: string;
|
|
5813
|
+
};
|
|
5420
5814
|
/**
|
|
5421
5815
|
* DataActivationClientSQLQueryCallRequest
|
|
5422
5816
|
*/
|
|
@@ -5429,6 +5823,60 @@ type DataActivationClientSqlQueryCallRequestWritable = SqlQueryCallRequestWritab
|
|
|
5429
5823
|
type ToolSnsRequestWritable = SnsRequestWritable & {
|
|
5430
5824
|
tool_body_type: 'sns';
|
|
5431
5825
|
};
|
|
5826
|
+
/**
|
|
5827
|
+
* ActionStatusUpdaterRequest
|
|
5828
|
+
*
|
|
5829
|
+
* Action Status Updater — automated polling for delivery status updates. Request
|
|
5830
|
+
*/
|
|
5831
|
+
type ActionStatusUpdaterRequestWritable = {
|
|
5832
|
+
action_log_config: SimpleTemplateConfigRequest;
|
|
5833
|
+
/**
|
|
5834
|
+
* Cron schedule expression (e.g. "*30 * * * *")
|
|
5835
|
+
*/
|
|
5836
|
+
cron_expression: string;
|
|
5837
|
+
/**
|
|
5838
|
+
* Datalake ID
|
|
5839
|
+
*/
|
|
5840
|
+
datalake_id: string;
|
|
5841
|
+
/**
|
|
5842
|
+
* 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.
|
|
5843
|
+
*/
|
|
5844
|
+
events_output_schema?: {
|
|
5845
|
+
[key: string]: unknown;
|
|
5846
|
+
} | null;
|
|
5847
|
+
message_config: SimpleTemplateConfigRequest;
|
|
5848
|
+
/**
|
|
5849
|
+
* Updater name
|
|
5850
|
+
*/
|
|
5851
|
+
name: string;
|
|
5852
|
+
/**
|
|
5853
|
+
* 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.
|
|
5854
|
+
*/
|
|
5855
|
+
pagination_context_output_schema?: {
|
|
5856
|
+
[key: string]: unknown;
|
|
5857
|
+
} | null;
|
|
5858
|
+
/**
|
|
5859
|
+
* IDs of sender tools whose messages this updater monitors
|
|
5860
|
+
*/
|
|
5861
|
+
sender_tool_ids?: Array<string> | null;
|
|
5862
|
+
/**
|
|
5863
|
+
* 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.
|
|
5864
|
+
*/
|
|
5865
|
+
status?: 'active' | 'cycle_detected';
|
|
5866
|
+
updater_body: ({
|
|
5867
|
+
updater_body_type: 'cloud_watch_request';
|
|
5868
|
+
} & ActionStatusUpdaterCloudWatchQueryRequestWritable) | ({
|
|
5869
|
+
updater_body_type: 'restapi_request';
|
|
5870
|
+
} & ActionStatusUpdaterRestCallRequestWritable);
|
|
5871
|
+
/**
|
|
5872
|
+
* Tool providing auth credentials for polling
|
|
5873
|
+
*/
|
|
5874
|
+
updater_tool_id: string;
|
|
5875
|
+
/**
|
|
5876
|
+
* Updater type — determines the updater_body shape
|
|
5877
|
+
*/
|
|
5878
|
+
updater_type: 'cloud_watch' | 'restapi';
|
|
5879
|
+
};
|
|
5432
5880
|
/**
|
|
5433
5881
|
* ConnectedAppRequest
|
|
5434
5882
|
*
|
|
@@ -5559,6 +6007,19 @@ type SqlDatabaseRequestWritable = {
|
|
|
5559
6007
|
*/
|
|
5560
6008
|
user_name: string;
|
|
5561
6009
|
};
|
|
6010
|
+
/**
|
|
6011
|
+
* SMSCallRequest
|
|
6012
|
+
*
|
|
6013
|
+
* SMS tool-call config — Liquid-templated recipient and body plus transactional/promotional category. Request
|
|
6014
|
+
*/
|
|
6015
|
+
type SmsCallRequestWritable = {
|
|
6016
|
+
body: SimpleTemplateConfigRequest;
|
|
6017
|
+
/**
|
|
6018
|
+
* SMS category — transactional vs promotional
|
|
6019
|
+
*/
|
|
6020
|
+
sms_type?: 'transactional' | 'promotional';
|
|
6021
|
+
to: SimpleTemplateConfigRequest;
|
|
6022
|
+
};
|
|
5562
6023
|
type PlatformApiTenantControllerIndexData = {
|
|
5563
6024
|
body?: never;
|
|
5564
6025
|
path?: never;
|
|
@@ -6802,7 +7263,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6802
7263
|
}>;
|
|
6803
7264
|
};
|
|
6804
7265
|
admin: {
|
|
6805
|
-
signUp: (body:
|
|
7266
|
+
signUp: (body: SignUpRequestWritable) => Promise<{
|
|
6806
7267
|
data: UserResponse;
|
|
6807
7268
|
request: Request;
|
|
6808
7269
|
response: Response;
|
|
@@ -6829,7 +7290,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6829
7290
|
request: Request;
|
|
6830
7291
|
response: Response;
|
|
6831
7292
|
}>;
|
|
6832
|
-
create: (body:
|
|
7293
|
+
create: (body: TenantRequest) => Promise<{
|
|
6833
7294
|
data: TenantResponse;
|
|
6834
7295
|
request: Request;
|
|
6835
7296
|
response: Response;
|
|
@@ -6841,7 +7302,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6841
7302
|
request: Request;
|
|
6842
7303
|
response: Response;
|
|
6843
7304
|
}>;
|
|
6844
|
-
create: (tenantSlug: string, body:
|
|
7305
|
+
create: (tenantSlug: string, body: InvitationRequest) => Promise<{
|
|
6845
7306
|
data: InvitationResponse;
|
|
6846
7307
|
request: Request;
|
|
6847
7308
|
response: Response;
|
|
@@ -6868,7 +7329,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6868
7329
|
request: Request;
|
|
6869
7330
|
response: Response;
|
|
6870
7331
|
}>;
|
|
6871
|
-
createUserSearch: (tenantSlug: string, datalakeSlug: string, dataset: string, body:
|
|
7332
|
+
createUserSearch: (tenantSlug: string, datalakeSlug: string, dataset: string, body: UserSearchRequest) => Promise<{
|
|
6872
7333
|
data: UserSearchResponse;
|
|
6873
7334
|
request: Request;
|
|
6874
7335
|
response: Response;
|
|
@@ -6890,7 +7351,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6890
7351
|
request: Request;
|
|
6891
7352
|
response: Response;
|
|
6892
7353
|
}>;
|
|
6893
|
-
checksum: (tenantSlug: string, body:
|
|
7354
|
+
checksum: (tenantSlug: string, body: DatalakeRequestWritable) => Promise<{
|
|
6894
7355
|
data: ChecksumResponse;
|
|
6895
7356
|
request: Request;
|
|
6896
7357
|
response: Response;
|
|
@@ -6972,7 +7433,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
6972
7433
|
request: Request;
|
|
6973
7434
|
response: Response;
|
|
6974
7435
|
}>;
|
|
6975
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7436
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: DataSourceRequest) => Promise<{
|
|
6976
7437
|
data: ChecksumResponse;
|
|
6977
7438
|
request: Request;
|
|
6978
7439
|
response: Response;
|
|
@@ -7017,7 +7478,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
7017
7478
|
request: Request;
|
|
7018
7479
|
response: Response;
|
|
7019
7480
|
}>;
|
|
7020
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7481
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: ToolRequestWritable) => Promise<{
|
|
7021
7482
|
data: ChecksumResponse;
|
|
7022
7483
|
request: Request;
|
|
7023
7484
|
response: Response;
|
|
@@ -7032,7 +7493,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
7032
7493
|
request: Request;
|
|
7033
7494
|
response: Response;
|
|
7034
7495
|
}>;
|
|
7035
|
-
testInvocation: (tenantSlug: string, datalakeSlug: string, id: string, body:
|
|
7496
|
+
testInvocation: (tenantSlug: string, datalakeSlug: string, id: string, body: ManualToolInvocationRequestWritable) => Promise<{
|
|
7036
7497
|
data: ManualToolInvocationResponse;
|
|
7037
7498
|
request: Request;
|
|
7038
7499
|
response: Response;
|
|
@@ -7077,7 +7538,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
7077
7538
|
request: Request;
|
|
7078
7539
|
response: Response;
|
|
7079
7540
|
}>;
|
|
7080
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7541
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: GenericTableRequestWritable) => Promise<{
|
|
7081
7542
|
data: ChecksumResponse;
|
|
7082
7543
|
request: Request;
|
|
7083
7544
|
response: Response;
|
|
@@ -7112,7 +7573,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
7112
7573
|
request: Request;
|
|
7113
7574
|
response: Response;
|
|
7114
7575
|
}>;
|
|
7115
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7576
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: ActionStatusUpdaterRequestWritable) => Promise<{
|
|
7116
7577
|
data: ChecksumResponse;
|
|
7117
7578
|
request: Request;
|
|
7118
7579
|
response: Response;
|
|
@@ -7182,7 +7643,7 @@ declare function _buildApi(myClient: Client): {
|
|
|
7182
7643
|
request: Request;
|
|
7183
7644
|
response: Response;
|
|
7184
7645
|
}>;
|
|
7185
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7646
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: AiAgentRequestWritable) => Promise<{
|
|
7186
7647
|
data: ChecksumResponse;
|
|
7187
7648
|
request: Request;
|
|
7188
7649
|
response: Response;
|
|
@@ -7227,17 +7688,17 @@ declare function _buildApi(myClient: Client): {
|
|
|
7227
7688
|
request: Request;
|
|
7228
7689
|
response: Response;
|
|
7229
7690
|
}>;
|
|
7230
|
-
create: (tenantSlug: string, datalakeSlug: string, body:
|
|
7691
|
+
create: (tenantSlug: string, datalakeSlug: string, body: ConnectedAppRequestWritable) => Promise<{
|
|
7231
7692
|
data: ConnectedAppResponse;
|
|
7232
7693
|
request: Request;
|
|
7233
7694
|
response: Response;
|
|
7234
7695
|
}>;
|
|
7235
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7696
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: ConnectedAppRequestWritable) => Promise<{
|
|
7236
7697
|
data: ChecksumResponse;
|
|
7237
7698
|
request: Request;
|
|
7238
7699
|
response: Response;
|
|
7239
7700
|
}>;
|
|
7240
|
-
update: (tenantSlug: string, datalakeSlug: string, id: string, body:
|
|
7701
|
+
update: (tenantSlug: string, datalakeSlug: string, id: string, body: ConnectedAppRequestWritable) => Promise<{
|
|
7241
7702
|
data: ConnectedAppResponse;
|
|
7242
7703
|
request: Request;
|
|
7243
7704
|
response: Response;
|
|
@@ -7252,12 +7713,12 @@ declare function _buildApi(myClient: Client): {
|
|
|
7252
7713
|
request: Request;
|
|
7253
7714
|
response: Response;
|
|
7254
7715
|
}>;
|
|
7255
|
-
resolvePage: (tenantSlug: string, datalakeSlug: string, slug: string, body:
|
|
7716
|
+
resolvePage: (tenantSlug: string, datalakeSlug: string, slug: string, body: ResolvePageRequest) => Promise<{
|
|
7256
7717
|
data: ResolvePageResponse;
|
|
7257
7718
|
request: Request;
|
|
7258
7719
|
response: Response;
|
|
7259
7720
|
}>;
|
|
7260
|
-
updateMessageTracking: (tenantSlug: string, datalakeSlug: string, slug: string, body:
|
|
7721
|
+
updateMessageTracking: (tenantSlug: string, datalakeSlug: string, slug: string, body: UpdatePageRequest) => Promise<{
|
|
7261
7722
|
data: UpdatePageResponse;
|
|
7262
7723
|
request: Request;
|
|
7263
7724
|
response: Response;
|
|
@@ -7287,17 +7748,17 @@ declare function _buildApi(myClient: Client): {
|
|
|
7287
7748
|
request: Request;
|
|
7288
7749
|
response: Response;
|
|
7289
7750
|
}>;
|
|
7290
|
-
create: (tenantSlug: string, datalakeSlug: string, body:
|
|
7751
|
+
create: (tenantSlug: string, datalakeSlug: string, body: DataActivationClientRequestWritable) => Promise<{
|
|
7291
7752
|
data: DataActivationClientResponse;
|
|
7292
7753
|
request: Request;
|
|
7293
7754
|
response: Response;
|
|
7294
7755
|
}>;
|
|
7295
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7756
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: DataActivationClientRequestWritable) => Promise<{
|
|
7296
7757
|
data: ChecksumResponse;
|
|
7297
7758
|
request: Request;
|
|
7298
7759
|
response: Response;
|
|
7299
7760
|
}>;
|
|
7300
|
-
update: (tenantSlug: string, datalakeSlug: string, id: string, body:
|
|
7761
|
+
update: (tenantSlug: string, datalakeSlug: string, id: string, body: DataActivationClientRequestWritable) => Promise<{
|
|
7301
7762
|
data: DataActivationClientResponse;
|
|
7302
7763
|
request: Request;
|
|
7303
7764
|
response: Response;
|
|
@@ -7320,12 +7781,12 @@ declare function _buildApi(myClient: Client): {
|
|
|
7320
7781
|
request: Request;
|
|
7321
7782
|
response: Response;
|
|
7322
7783
|
}>;
|
|
7323
|
-
runManually: (tenantSlug: string, datalakeSlug: string, slug: string, body?:
|
|
7784
|
+
runManually: (tenantSlug: string, datalakeSlug: string, slug: string, body?: RunManuallyRequestWritable) => Promise<{
|
|
7324
7785
|
data: RunManuallyResponse;
|
|
7325
7786
|
request: Request;
|
|
7326
7787
|
response: Response;
|
|
7327
7788
|
}>;
|
|
7328
|
-
ingest: (tenantSlug: string, datalakeSlug: string, slug: string, body:
|
|
7789
|
+
ingest: (tenantSlug: string, datalakeSlug: string, slug: string, body: IngestRequest) => Promise<{
|
|
7329
7790
|
data: IngestResponse;
|
|
7330
7791
|
request: Request;
|
|
7331
7792
|
response: Response;
|
|
@@ -7359,17 +7820,17 @@ declare function _buildApi(myClient: Client): {
|
|
|
7359
7820
|
request: Request;
|
|
7360
7821
|
response: Response;
|
|
7361
7822
|
}>;
|
|
7362
|
-
create: (tenantSlug: string, datalakeSlug: string, body:
|
|
7823
|
+
create: (tenantSlug: string, datalakeSlug: string, body: InteroperabilityContractRequestWritable) => Promise<{
|
|
7363
7824
|
data: InteroperabilityContractResponse;
|
|
7364
7825
|
request: Request;
|
|
7365
7826
|
response: Response;
|
|
7366
7827
|
}>;
|
|
7367
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7828
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: InteroperabilityContractRequestWritable) => Promise<{
|
|
7368
7829
|
data: ChecksumResponse;
|
|
7369
7830
|
request: Request;
|
|
7370
7831
|
response: Response;
|
|
7371
7832
|
}>;
|
|
7372
|
-
update: (tenantSlug: string, datalakeSlug: string, id: string, body:
|
|
7833
|
+
update: (tenantSlug: string, datalakeSlug: string, id: string, body: InteroperabilityContractRequestWritable) => Promise<{
|
|
7373
7834
|
data: InteroperabilityContractResponse;
|
|
7374
7835
|
request: Request;
|
|
7375
7836
|
response: Response;
|
|
@@ -7392,14 +7853,14 @@ declare function _buildApi(myClient: Client): {
|
|
|
7392
7853
|
request: Request;
|
|
7393
7854
|
response: Response;
|
|
7394
7855
|
}>;
|
|
7395
|
-
run: (tenantSlug: string, datalakeSlug: string, slug: string, body:
|
|
7856
|
+
run: (tenantSlug: string, datalakeSlug: string, slug: string, body: InteroperabilityRunRequest) => Promise<{
|
|
7396
7857
|
data: InteroperabilityRunResponse;
|
|
7397
7858
|
request: Request;
|
|
7398
7859
|
response: Response;
|
|
7399
7860
|
}>;
|
|
7400
7861
|
};
|
|
7401
7862
|
mdm: {
|
|
7402
|
-
verify: (tenantSlug: string, datalakeSlug: string, body:
|
|
7863
|
+
verify: (tenantSlug: string, datalakeSlug: string, body: MdmVerifyRequest) => Promise<{
|
|
7403
7864
|
data: MdmVerifyResponse;
|
|
7404
7865
|
request: Request;
|
|
7405
7866
|
response: Response;
|
|
@@ -7416,17 +7877,17 @@ declare function _buildApi(myClient: Client): {
|
|
|
7416
7877
|
request: Request;
|
|
7417
7878
|
response: Response;
|
|
7418
7879
|
}>;
|
|
7419
|
-
create: (tenantSlug: string, datalakeSlug: string, body:
|
|
7880
|
+
create: (tenantSlug: string, datalakeSlug: string, body: AgenticWorkflowRequestWritable) => Promise<{
|
|
7420
7881
|
data: AgenticWorkflowResponse;
|
|
7421
7882
|
request: Request;
|
|
7422
7883
|
response: Response;
|
|
7423
7884
|
}>;
|
|
7424
|
-
checksum: (tenantSlug: string, datalakeSlug: string, body:
|
|
7885
|
+
checksum: (tenantSlug: string, datalakeSlug: string, body: AgenticWorkflowRequestWritable) => Promise<{
|
|
7425
7886
|
data: ChecksumResponse;
|
|
7426
7887
|
request: Request;
|
|
7427
7888
|
response: Response;
|
|
7428
7889
|
}>;
|
|
7429
|
-
update: (tenantSlug: string, datalakeSlug: string, id: string, body:
|
|
7890
|
+
update: (tenantSlug: string, datalakeSlug: string, id: string, body: AgenticWorkflowRequestWritable) => Promise<{
|
|
7430
7891
|
data: AgenticWorkflowResponse;
|
|
7431
7892
|
request: Request;
|
|
7432
7893
|
response: Response;
|
|
@@ -7449,12 +7910,12 @@ declare function _buildApi(myClient: Client): {
|
|
|
7449
7910
|
request: Request;
|
|
7450
7911
|
response: Response;
|
|
7451
7912
|
}>;
|
|
7452
|
-
execute: (tenantSlug: string, datalakeSlug: string, workflowSlug: string, body:
|
|
7913
|
+
execute: (tenantSlug: string, datalakeSlug: string, workflowSlug: string, body: ExecuteActionRequest) => Promise<{
|
|
7453
7914
|
data: ExecuteActionResponse;
|
|
7454
7915
|
request: Request;
|
|
7455
7916
|
response: Response;
|
|
7456
7917
|
}>;
|
|
7457
|
-
run: (tenantSlug: string, datalakeSlug: string, workflowSlug: string, body:
|
|
7918
|
+
run: (tenantSlug: string, datalakeSlug: string, workflowSlug: string, body: RunWorkflowRequest) => Promise<{
|
|
7458
7919
|
data: RunWorkflowResponse;
|
|
7459
7920
|
request: Request;
|
|
7460
7921
|
response: Response;
|