Module models

Expand description

Typed models generated from Truto’s OpenAPI spec.

All structs decode leniently: unknown fields are ignored and missing fields take their default. Enums are open (unknown values land in Other(String) and serialise back unchanged), and unions keep the raw JSON with an as_<variant>() accessor per variant.

Structs§

AnalyticsBreakdownResponse
AnalyticsBreakdownResponseRowsItem
AnalyticsDashboardKpi
AnalyticsDashboardResponse
AnalyticsDashboardResponseAccountEventsItem
AnalyticsDashboardResponseAccounts: One page of the integrated accounts with the most API calls in the range. Only accounts that still exist are listed.
AnalyticsDashboardResponseAccountsRowsItem
AnalyticsDashboardResponseApiCalls: API calls per day (as billing counts them), aligned with buckets. null when it could not be loaded.
AnalyticsDashboardResponseApiCallsByCategoryItem
AnalyticsDashboardResponseApiCallsByIntegrationItem
AnalyticsDashboardResponseApiCallsTotalItem
AnalyticsDashboardResponseByCategoryItem
AnalyticsDashboardResponseErrorsByIntegrationItem
AnalyticsDashboardResponseHourlyApiCalls: API calls per hour (UTC) over the last 7 days of the range; an hour later today is null.
AnalyticsDashboardResponseIntegrationsItem
AnalyticsDashboardResponseInventory: The environment’s integrations and integrated accounts as they are now (sandbox accounts excluded).
AnalyticsDashboardResponseKpis: Each headline number for the range, the span of the same length before it, and a daily series. accounts, active_accounts and active_integrations describe the accounts as they are now, so they have no previous value or series.
AnalyticsDashboardResponseLatencyP95: p95 latency per day in ms, total and waiting on the provider; null on a day without requests.
AnalyticsDashboardResponsePrevious
AnalyticsDashboardResponseStatusCodesItem
AnalyticsDashboardResponseWindow: The days analytics can show (the last 90 days, up to today).
AnalyticsMetricsResponse
AnalyticsMetricsResponseCategoriesItem
AnalyticsMetricsResponseDimensionsItem
AnalyticsMetricsResponseMetricsItem
AnalyticsStatusResponse
AnalyticsStatusResponseWindow: The first and last UTC day that can be requested. to is today.
AnalyticsTimeseriesResponse
AnalyticsTimeseriesResponseSeriesItem
ApiTokenResponse
AppCredentialsNotConfiguredError: The refusal returned when a link token is requested for an integration that nothing can connect, because its app-level credentials were never configured in this environment.
BatchRequestResponse: The combined response returned by POST /batch-request. Successful resource records are grouped under result, keyed by the name of each resource in the request. Errors are surfaced under errors, keyed the same way.
BatchRequestResponseErrorsValueItem
BatchRequestSchema: The request body for creating a batch request, containing an integrated account ID and an array of resources.
BillingAccountResponse
BillingAccountResponseBillingAddress
BillingAccountResponsePaymentMethodSummary
BillingAccountResponseTaxIdsItem
BillingInvoiceResponse: A Stripe invoice mirrored into Truto. Stripe remains the system of record; use hosted_invoice_url to view or pay it.
BillingLine
BillingPlanResponse
BillingSummaryResponse
BillingSummaryResponseCurrentPeriod: Month-to-date charges priced against the plan. Everything — platform fee, fixed items and usage — bills in arrears, so these are invoiced on invoice_date, after the month ends. null when the team has no active plan.
BillingSummaryResponseCurrentPeriodUsage
BillingSummaryResponseCurrentPeriodUsageCounts
CapabilitiesResponse: Consolidated capabilities for an integration or integrated account.
CapabilitiesResponseIntegration
CapabilitiesResponseProxy
CapabilitiesResponseUnified
CapabilityAccount: Present on /integrated-account/{id}/capabilities only.
CapabilityAiReadiness: Coverage of proxy methods that have descriptions.
CapabilityAuth: Authentication formats and required fields for the integration.
CapabilityAuthFieldsItem
CapabilityProxyMethod: A single proxy method on a resource.
CapabilityProxyResource: A proxy resource and the methods it exposes.
CapabilityUnifiedResource: A unified resource grouped under a unified API.
CategorySchema
DatastoreConfig: Datastore configuration. The shape of config depends on the parent record’s type field. Truto deserializes the config blob into one of DatastoreMongoDataApiConfig, DatastoreGoogleCloudStorageConfig, DatastoreS3Config, or DatastoreQdrantConfig.
DatastoreCreateRequest
DatastoreDeleteResponse
DatastoreGoogleCloudStorageConfig: Configuration for the Google Cloud Storage datastore type.
DatastoreGoogleCloudStorageCredentials: Service-account JSON used to authenticate against Google Cloud Storage.
DatastoreMongoDataApiConfig: Configuration for the MongoDB Atlas Data API datastore type.
DatastoreQdrantConfig: Configuration for the Qdrant vector-store datastore type.
DatastoreS3Config: Configuration for the S3 / S3-compatible datastore type.
DatastoreSchema
DatastoreUpdateRequest
DeleteResponse
Documentation: A documentation row attached to an integration, environment integration, or unified model.
DocumentationCreateRequest
DocumentationPatchRequest
EnvironmentIntegrationConfig: Per-environment configuration override for an integration. Stored on environment_integration.override and deep-merged on top of the base integration.config at request time.
EnvironmentIntegrationCreateRequest
EnvironmentIntegrationDeleteResponse
EnvironmentIntegrationLinkUiConfig: Per-integration configuration for the embedded connections widget, and nothing else. It is never merged into integration.config, so it cannot affect proxy, unified or custom requests.
EnvironmentIntegrationResourceMethod: Per-environment override for a single resource method. Same shape as IntegrationResourceMethod but every field is optional (deep-merged on top of the base method). path is also optional here.
EnvironmentIntegrationResourceMethodMcpAnnotations: Per-environment override for the method’s MCP ToolAnnotations hints. See IntegrationResourceMethod.mcp_annotations. Absent means “no hint”. Hints merge per key with the base method, so to tighten a base read to destructive the override must also set readOnlyHint: false; a merged object with both true is treated as no hint.
EnvironmentIntegrationResponse
EnvironmentIntegrationUpdateRequest
EnvironmentResponse
EnvironmentUnifiedModelCreateRequest
EnvironmentUnifiedModelDeleteResponse
EnvironmentUnifiedModelDocs: Per-integration documentation overrides surfaced via GET /unified/meta/{model_name}/{integration_name}.
EnvironmentUnifiedModelMappingStep: A single before / after step. Used by unified-model resource methods, where Truto runs it around the main HTTP request, and by before on proxy resource methods (IntegrationResourceMethod.before), where Truto only stores it for engines that run proxy configs.
EnvironmentUnifiedModelOverride: Per-environment override for a unified-model installation. Stored on environment_unified_model.override and deep-merged on top of the base unified_model.
EnvironmentUnifiedModelResourceMethodCreateRequest
EnvironmentUnifiedModelResourceMethodDeleteResponse
EnvironmentUnifiedModelResourceMethodOverride: Per-environment override for a single unified-model resource method (e.g. crm.contacts.list on salesforce).
EnvironmentUnifiedModelResourceMethodRowResponse: One row of the environment_unified_model_resource_method table — an environment-scoped override of a single unified-model mapping. Writing here changes behaviour only for the environment that owns the parent environment_unified_model record; the base unified_model_resource_method row (and therefore every other environment) is untouched.
EnvironmentUnifiedModelResourceMethodUpdateRequest
EnvironmentUnifiedModelResourceOverride: Per-environment override for a single unified-model resource (e.g. contacts in the crm model).
EnvironmentUnifiedModelResponse
EnvironmentUnifiedModelSideLoad: Side-load configuration that fetches related records and merges them into the response under path.
EnvironmentUnifiedModelUpdateRequest
ForbiddenErrorInsightSchema: Present on a 403 from the provider, on both the Unified and Proxy APIs. Not every 403 is a scope problem: value.refusal_basis states what Truto can say the refusal rests on.
ForbiddenErrorInsightSchemaValue
GroupMappingResponse
HttpRequestFields: HTTP request/response context shared by log types that originate from an inbound HTTP request (unified_proxy_api and mcp).
IntegratedAccount
IntegratedAccountCreate
IntegratedAccountCredentialsUpdateRequest
IntegratedAccountFormTokenRequest
IntegratedAccountFormTokenResponse
IntegratedAccountLastForbiddenError: Details of the most recent 403 Forbidden returned by the third-party API for this account, or null if the most recent call succeeded. Cleared automatically on the next successful call.
IntegratedAccountMcpCreateRequest
IntegratedAccountMcpCreateRequestConfig
IntegratedAccountMcpUpdateRequest
IntegratedAccountMcpUpdateRequestConfig: Updated configuration settings for the MCP server
IntegratedAccountRefreshCredentialsRequest
IntegratedAccountRefreshCredentialsResponse
IntegratedAccountRefreshMappingCacheRequest
IntegratedAccountRefreshMappingCacheResponse
IntegratedAccountResponse
IntegratedAccountRunPostInstallActionsRequest
IntegratedAccountRunPostInstallActionsResponse
IntegratedAccountTokenRequest
IntegratedAccountTokenResponse
IntegratedAccountUnifiedModelOverrideMethod: The mapping fields an account-scoped override may set. Deliberately a subset of UnifiedModelResourceMethod: path_mapping, error_mapping, the header mappings, is_partial_*, static and mapping_version are not accepted here — set those on environment-unified-model-resource-method instead.
IntegratedAccountUnifiedModelOverrideValueValue
IntegratedAccountUpdate
IntegratedAccountValidateResponse
IntegratedAccountWebhookPayload: Internal representation of an inbound webhook event for an integrated account. The code: 1. Validates the request (signature, etc.) 2. Parses it into this payload structure 3. Maps it to a unified resource if appropriate.
IntegrationAction: A named integration action. Built-in actions are post_install, post_connect_user_form, refresh_token, and validation; arbitrary names are also allowed for custom flows triggered via the proxy or sync runtime.
IntegrationActionStep: A single step in an integration action (post-install hook, validation hook, refresh-token override, custom flows). Steps run sequentially with a shared context.
IntegrationApiKeyCredential: API-key based credential. Customer pastes one or more secret values that are stored verbatim and templated into request headers/queries.
IntegrationApiKeyCredentialConfig
IntegrationAuthorization: How Truto applies the resolved credential to outbound HTTP requests. The format discriminator selects which config shape applies.
IntegrationAwsStsCredential: AWS STS credential exchange. A long-lived AWS key signs one AssumeRole call and AWS returns a short-lived key belonging to whichever account owns the role.
IntegrationAwsStsCredentialConfig
IntegrationAwsStsCredentialConfigAuth
IntegrationAwsStsCredentialConfigRole: The role to assume. Every field supports {{...}} placeholders, plus {{token_key}}, which is bound to the resolved token key.
IntegrationAwsStsCredentialConfigSigning: The IAM key that signs the AssumeRole call — a bring-your-own-credential pair on the same footing as an OAuth app’s client.id / client.secret.
IntegrationBasicAuthorization: Adds an HTTP Basic Authorization: Basic base64(username:password) header.
IntegrationBasicAuthorizationConfig
IntegrationBearerAuthorization: Adds Authorization: Bearer <value> to every request.
IntegrationBearerAuthorizationConfig
IntegrationConfig: Complete integration configuration. Validated by Truto on POST /integration and PATCH /integration/{id}.
IntegrationCreateRequest
IntegrationCredential: A single integration credential definition. The format discriminator selects which credential shape applies.
IntegrationCursorPagination: Cursor-based pagination, where the next cursor is read from a path inside the response body or headers.
IntegrationCursorPaginationConfig: Cursor pagination options.
IntegrationDynamicPagination: Dynamic pagination driven entirely by JSONata expressions. Use this when none of the canonical strategies fit (e.g. SOAP-style request envelopes, HATEOAS links inside body fields, multi-step resumption tokens).
IntegrationDynamicPaginationConfig
IntegrationDynamicPaginationRequestContext: Input for pagination.config.get_initial_pagination_values_expression and get_pagination_values_expression.
IntegrationDynamicPaginationRequestResult: Return value from pagination.config.get_initial_pagination_values_expression / get_pagination_values_expression. All fields are optional; only what you return is applied.
IntegrationDynamicPaginationResponseContext: Input for pagination.config.get_cursor_from_response_expression.
IntegrationDynamicPaginationResponseResult: Return value from pagination.config.get_cursor_from_response_expression. Truto base64-encodes nextCursor and prevCursor before storing them on the synthetic query.next_cursor for the next page.
IntegrationErrorExpressionContext: Input passed to every error_expression JSONata expression.
IntegrationErrorExpressionResult: Return value from an error_expression. Return null (or omit) to indicate “no error”. Returning an object short-circuits with that error shape. When status < 400, the result field is bubbled up as a successful response (useful for vendors that signal “no data” via 200 with an error body).
IntegrationField: A single user-facing field rendered in the Truto Link SDK during account connection. Used inside an integration credential’s config.fields array to collect API keys, subdomains, OAuth client IDs, etc.
IntegrationFieldOptionsItem
IntegrationGeneratedField: A single value Truto generates once per connection, declared in a credential’s config.generated_fields array. Used where the provider requires the value to be produced by Truto rather than by the customer. It is generated for the connection and kept for its life — a reconnect never regenerates it, and a caller-supplied value for the same name is ignored.
IntegrationHeaderAuthorization: Adds arbitrary headers to every request. Provide either headers (static map) or expression (JSONata returning the request to send), but not both.
IntegrationHeaderAuthorizationConfig
IntegrationHeaderAuthorizationContext: Input for authorization.config.expression (only used when authorization.format is header and the integration needs custom URL/body manipulation alongside the auth header).
IntegrationHeaderAuthorizationResult: Return value from authorization.config.expression. Both url and requestOptions are required; Truto throws “Invalid result from custom header jsonata expression” when either is missing.
IntegrationJwtBearerCredential: JWT bearer assertion credential. Sign a JWT with a private key (or HMAC secret) and exchange it for an access token. Used for GitHub Apps, Google service accounts, Snowflake, and similar flows.
IntegrationJwtBearerCredentialConfig
IntegrationJwtBearerCredentialConfigAuth
IntegrationJwtBearerCredentialConfigJwt
IntegrationJwtBearerCredentialConfigOptions
IntegrationJwtBearerCredentialConfigSigning: App/service identity and signing material (not OAuth client_id / client_secret). Set key, or generated to sign with a key pair Truto made for the connection; when generated is set, key is ignored.
IntegrationKekaOAuthCredential: Vendor-specific OAuth credential for Keka (HRMS). Combines an API key with an OAuth client.
IntegrationKekaOAuthCredentialConfig
IntegrationKekaOAuthCredentialConfigClient
IntegrationLinkHeaderPagination: RFC 5988 Link: header pagination (e.g. GitHub-style). The next and prev URLs are extracted from the response Link header.
IntegrationLinkHeaderPaginationConfig
IntegrationOAuth2ClientCredential: OAuth 2.0 client-credentials grant. Used for service-to-service integrations where there is no end-user.
IntegrationOAuth2ClientCredentialConfig
IntegrationOAuth2ClientCredentialConfigAuth
IntegrationOAuth2ClientCredentialConfigClient
IntegrationOAuth2ClientCredentialConfigOptions
IntegrationOAuth2Credential: OAuth 2.0 authorization-code flow credential.
IntegrationOAuth2CredentialConfig
IntegrationOAuth2CredentialConfigAuth: Endpoint URLs for the OAuth dance.
IntegrationOAuth2CredentialConfigClient: Default Truto-managed OAuth client. Customers may supply their own via BYOA (Bring Your Own App).
IntegrationOAuth2CredentialConfigOptions
IntegrationOAuth2CredentialConfigPkce: Optional PKCE configuration. Required by some OAuth 2.0 providers.
IntegrationOAuthCredential: OAuth 1.0a credential (rare; used for legacy APIs like older Twitter, Trello).
IntegrationOAuthCredentialConfig
IntegrationOAuthCredentialConfigAuth
IntegrationOAuthCredentialConfigClient
IntegrationOAuthCredentialConfigOptions
IntegrationOffsetPagination: Offset/limit pagination (?offset=200&limit=100).
IntegrationOffsetPaginationConfig
IntegrationPagePagination: Page-number pagination (e.g. ?page=2&limit=100).
IntegrationPagePaginationConfig: Page-number pagination options. All fields optional; defaults shown.
IntegrationPagination: Pagination strategy for an integration or a single resource method. The format discriminator selects which config shape applies.
IntegrationPlaceholderContext: Runtime request context used to resolve every {{...}} placeholder in an integration config (headers, query, body, path, etc.) and to seed every update_context action step. Built per request from the integrated-account context plus the current call’s parameters.
IntegrationPlaceholderContextOauth: OAuth context. Tokens are nested under oauth.token (e.g. {{oauth.token.access_token}}, {{oauth.token.refresh_token}}).
IntegrationPlaceholderContextOauthToken: OAuth token bag merged from the most recent token-refresh response.
IntegrationRangePagination: Half-open [start, end) range pagination (e.g. ?start=0&end=100 then ?start=100&end=200).
IntegrationRangePaginationConfig
IntegrationRateLimit: How Truto detects and reacts to upstream rate-limiting. All fields are JSONata expressions evaluated against the upstream response.
IntegrationRateLimitExpressionContext: Input passed to rate_limit.is_rate_limited, rate_limit.retry_after_header_expression, and rate_limit.rate_limit_header_expression.
IntegrationRateLimitHeaderValues: Return value from rate_limit.rate_limit_header_expression. Truto rewrites these into the standard ratelimit-limit, ratelimit-remaining, and ratelimit-reset response headers.
IntegrationResourceMethod: Definition of a single resource method (e.g. users.list) for an integration.
IntegrationResourceMethodBodyFormatConfig: Extra options for the chosen body_format. Discriminated by the sibling body_format field — see IntegrationResourceMethodBodyFormatConfigRaw (for raw) and IntegrationResourceMethodBodyFormatConfigMultipart (for multipart). Ignored for json/form/xml. anyOf, not oneOf: the multipart shape has no required keys and no additionalProperties: false, so a raw config ({ content_type }) also satisfies it and oneOf rejected every raw method.
IntegrationResourceMethodBodyFormatConfigMultipart: body_format_config shape when body_format is multipart. Tunes how nested JSON values are serialized into multipart fields.
IntegrationResourceMethodBodyFormatConfigRaw: body_format_config shape when body_format is raw. The body is sent verbatim with the configured content_type.
IntegrationResourceMethodExample: Sample request/response payloads used by docs and the Truto MCP for tool descriptions.
IntegrationResourceMethodMcpAnnotations: Hints mirroring MCP ToolAnnotations for this method’s tool, read by consumers that classify tools (e.g. Elaichi) to decide read, write or destructive. Keys keep the MCP spec’s camelCase spelling on purpose. Absent means “no hint”: consumers fall back to their existing rules, and a missing flag is not read as false. readOnlyHint and destructiveHint cannot both be true.
IntegrationResponse
IntegrationSchema
IntegrationToolsResponse
IntegrationToolsResponseResultItem
IntegrationUnifiedApisResponse
IntegrationUnifiedApisResponseResultItem
IntegrationUnifiedApisResponseResultItemResourcesItem
IntegrationUpdateRequest
IntegrationWebhookBasicVerification: HTTP Basic signature verification.
IntegrationWebhookBasicVerificationConfig: HTTP Basic signature verification. Truto base64-encodes username:password and compares it with the second word of compare_with (i.e. Authorization: Basic <token>).
IntegrationWebhookBearerVerification: Bearer-token signature verification.
IntegrationWebhookBearerVerificationConfig: Bearer-token signature verification. Truto compares secret (constant-time) with the second word of compare_with (i.e. Authorization: Bearer <token>).
IntegrationWebhookConfig: How Truto receives and verifies inbound webhooks for this integration. Not to be confused with WebhookSchema elsewhere in this spec, which describes Truto’s outbound webhook delivered to your application.
IntegrationWebhookHandleVerificationResult: Return value from webhook.handle_verification.
IntegrationWebhookHandleVerificationResultVerificationResponse: Used when type: "verify". Truto sends this back as the HTTP response to the vendor’s handshake.
IntegrationWebhookHmacVerification: HMAC signature verification. Truto computes hmac(algorithm, secret, signed_string) and compares it (constant-time) with compare_with.
IntegrationWebhookHmacVerificationConfig: HMAC signature verification. Truto computes hmac(algorithm, secret, signed_string) and compares it (constant-time) with compare_with.
IntegrationWebhookJwtVerification: JWT signature verification.
IntegrationWebhookJwtVerificationConfig: JWT signature verification, in one of two modes.
IntegrationWebhookPayloadContext: Input passed to webhook.handle_verification, webhook.payload_transform, and the webhook.signature_verification.config placeholder resolver.
IntegrationWebhookSignatureVerification: Strategy used to verify an inbound webhook’s signature. The format discriminator selects which config shape applies.
JsonSchemaObject: Top-level JSON Schema object used by Truto’s unified-model resource definitions.
JsonSchemaObjectProperties: A single property entry in a JSON Schema-style declaration. Used for query_schema, body_schema, request_body_schema, and the inner properties map of JsonSchemaObject.
JsonSchemaObjectPropertiesItems: When type=array, the element schema (only type is enforced).
LinkToken
LinkTokenRequest
Log: A single log entry returned by GET /log. The log_type field on each row matches the log_type query parameter that was used to fetch it, and identifies which variant schema applies. Variants share the LogBase fields and may carry additional fields not enumerated in the spec — clients should treat unknown fields as opaque.
LogBase: Common fields present on every log entry returned by GET /log. Each concrete variant (e.g. UnifiedProxyApiLog, WebhookLog) extends this base with type-specific fields via allOf.
MCP: An MCP server attached to an integrated account. Each integrated account can have multiple MCP servers, each with its own scoping (config.methods and config.tags), tool exposure mode, and optional expiry.
MCPConfig: Optional scoping for the MCP server. When omitted, all available tools for the integrated account are exposed.
MCPCreateResponse: Response returned by POST /integrated-account/{integrated_account_id}/mcp. Includes the MCP server fields, the freshly minted bearer token, and the full url to use when configuring an MCP client. The token is only returned at creation time and cannot be retrieved later.
McpLog: Log entry produced by an MCP request handled by Truto’s MCP server.
ObservabilityDestinationCreateRequest
ObservabilityDestinationResponse
ObservabilityDestinationTestRequest
ObservabilityDestinationTestResponse
ObservabilityDestinationUpdateRequest
Passkey: A registered WebAuthn credential, sanitized for display. Credential material (credential_id, public_key) is never returned.
PasskeyAuthenticationOptions: A bare PublicKeyCredentialRequestOptionsJSON — pass it straight to navigator.credentials.get({ publicKey }). Note rpId is flat here, unlike the nested rp object on registration options.
PasskeyAuthenticationResponse: The PublicKeyCredential returned by navigator.credentials.get(), JSON-serialized (base64url). Extra fields the browser adds are accepted and ignored.
PasskeyAuthenticationResponseResponse
PasskeyRegistrationOptions: A bare PublicKeyCredentialCreationOptionsJSON — pass it straight to navigator.credentials.create({ publicKey }). Serialized by @simplewebauthn/server; the fields below are the ones the ceremony depends on.
PasskeyRegistrationOptionsAuthenticatorSelection: residentKey: required because sign-in is usernameless, and userVerification: required so every assertion carries a second factor — which is what lets a passkey login satisfy mfa_required.
PasskeyRegistrationOptionsExcludeCredentialsItem
PasskeyRegistrationOptionsExtensions: Client extensions the library asks for. credProps lets the browser report back whether the credential really was created as discoverable.
PasskeyRegistrationOptionsPubKeyCredParamsItem
PasskeyRegistrationOptionsRp: Relying party. id is the environment’s APP_URL host, so a passkey registered on one environment is never offered on another.
PasskeyRegistrationOptionsUser: User handle the authenticator groups credentials under. id is the base64url-encoded Truto user id.
PasskeyRegistrationResponse: The PublicKeyCredential returned by navigator.credentials.create(), JSON-serialized (base64url). Extra fields the browser adds (clientExtensionResults, authenticatorAttachment) are accepted and ignored.
PasskeyRegistrationResponseResponse
Ping: Health check response for the Truto API.
RapidBridgeLog: Log entry produced by a RapidBridge sync job run. These logs come from Durable Objects that drive sync jobs (rather than from inbound HTTP requests).
RemoteErrorResponseSchema: The body Truto returns when a third-party API refused the call, rather than Truto itself. Identified by truto_is_remote_error.
ScimGroupResponse
ScimTokenResponse
SessionTokenDeleteRequest
SessionTokenDeleteResponse
SessionTokenMeResponse
SessionTokenMeResponseCapabilities: Session tokens only. The environment’s resolved connections configuration — the same answer every server-side gate uses.
SessionTokenMeResponseIssuer: Session tokens only. The credential that minted this session.
SessionTokenMeResponseLayout: Session tokens only. The environment’s presentation defaults for the catalog. Not a security boundary — the SDK may override them per embed and the end user may change them in the widget’s own toolbar — but they belong to the environment, so they arrive with the session rather than being guessed client-side.
SessionTokenMeResponseScope: Session tokens only. What this session is confined to.
SessionTokenRenewResponse
SessionTokenRequest
SessionTokenResponse
SsoConnectionResponse
SsoConnectionResponseConfig: Non-secret protocol settings. Secret values (the OIDC client secret and SAML SP keys) are never returned.
SsoDomainResponse
StaticGateCreateRequest
StaticGateCreateResponse
StaticGateResponse
StaticGateUpdateRequest
SyncJobArgsSchemaSchema: Top-level JSON Schema object used by Truto’s unified-model resource definitions.
SyncJobCreateRequest
SyncJobCronTriggerCreateRequest
SyncJobCronTriggerLog: Log entry produced when a sync job’s cron alarm fires (one row per scheduled sync trigger). The Alarm Durable Object delivers the tick as an inbound POST /alarm, so these rows also carry the HTTP fields of that internal call — http_status_code reflects whether Truto accepted the tick, not anything about the upstream integration.
SyncJobCronTriggerSchema
SyncJobCronTriggerUpdateRequest
SyncJobResourceSchema
SyncJobRunCreateRequest
SyncJobRunResourceStatsValueValue
SyncJobRunResponse
SyncJobRunSchema
SyncJobRunState: A key/value entry stored within a sync job’s state namespace. Sync jobs use this to persist incremental cursors, dedupe markers, and other small bits of state across runs.
SyncJobRunStateCreateRequest
SyncJobRunStateListResponse
SyncJobRunStateUpdateRequest
SyncJobSchema
SyncJobTemplateCreate
SyncJobTemplateDeleteResponse
SyncJobTemplatePatch
SyncJobTemplateSchema
SyncJobUpdateRequest
TeamSchema
TenantBulkCreateResponse
TenantBulkCreateResponseSkippedItem
TenantBulkRequest
TenantBulkRequestTenantsItem
TenantCreateRequest
TenantResponse
TenantUpdateRequest
TenantVisibility: A closed predicate over tenant.metadata, evaluated server-side on the catalog list and again on connect. The rule itself is never sent to the browser, and a tenant that fails it cannot tell the integration from one that is not installed — connect answers 404.
TenantVisibilityCondition
ToolSchema
ToolSchemaBodySchema
ToolSchemaQuerySchema
ToolsResponseSchema
TrutoErrorInsightSchema: The truto_error_insight object on an error response body. Every key is optional and which ones appear depends on the failure; see the Errors guide for the full list. The Proxy API has no unified schema to compare a request against, so only forbidden_error is added there.
UnifiedApiMetaResponse: Response from GET /unified/{model_name}/{resource_name}/{integration_name}/meta/{method}. Returns the merged JSON schema, default query/body, and documentation link for a single integration mapping. Useful for inspecting what a unified call will accept and return without touching a real integrated account.
UnifiedMetaGetResponse
UnifiedModelCreateRequest
UnifiedModelDeleteResponse
UnifiedModelMethod: One element of the array form of method overrides. Used to dispatch to different integration methods based on a query/body discriminator.
UnifiedModelMethodConditionalFileUpload: A file-upload strategy that only applies when query_param matches query_param_value. Used in arrays to select different upload strategies based on caller intent.
UnifiedModelMethodFileUpload: File-upload strategy for create/update methods.
UnifiedModelRelatedResources: A related-resource fetch that runs after the main unified call and merges its response back in.
UnifiedModelResource: Definition of a single resource (e.g. users) inside a unified model.
UnifiedModelResourceDocs: Per-integration documentation surfaced via GET /unified/.../meta/{method}.
UnifiedModelResourceMethod: A single integration mapping for a unified-model method (e.g. crm.contacts.list on salesforce).
UnifiedModelResourceMethodCreateRequest
UnifiedModelResourceMethodDeleteResponse
UnifiedModelResourceMethodResource: One element of the array form of resource overrides. Used to merge multiple integration resources into a single unified call (e.g. fetching from users for some IDs and contacts for others).
UnifiedModelResourceMethodRowResponse: One row of the unified_model_resource_method table — the per-integration, per-resource, per-method mapping for a base unified model. This is the team-wide definition every environment inherits from.
UnifiedModelResourceMethodUpdateRequest
UnifiedModelResourceMethods: Resource-level method metadata.
UnifiedModelResponse
UnifiedModelUpdateRequest
UnifiedProxyApiLog: Log entry produced by an inbound request to the Unified API or Proxy API. Use request_type to distinguish a unified-mapping call from a raw proxy passthrough.
UnifiedProxyApiLogRemoteRequestsItem
WebhookCreateRequest
WebhookCreateResponse
WebhookLog: Log entry produced when Truto delivers a webhook to a customer endpoint. Delivery runs in the webhook_delivery Durable Object; the webhooks queue only hands the event to that object and emits no logs of its own, so these rows carry durable_object, not queue.
WebhookSchema
WebhookTestRequest
WebhookTestResponse
WebhookUpdateRequest
WorkflowConfigSchema: Workflow execution configuration.
WorkflowCreateSchema
WorkflowDeleteResponse
WorkflowRunResponse
WorkflowRunResultSchema
WorkflowRunStepSchema
WorkflowSchema
WorkflowStepSchema: A single executable step in a workflow.

Enums§

AnalyticsDashboardResponseRange: The named range shown, or custom for from / to.
AnalyticsMetricsResponseMetricsItemGranularitiesItem: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
AnalyticsMetricsResponseMetricsItemKind: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
AnalyticsMetricsResponseMetricsItemUnit: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
AppCredentialsNotConfiguredErrorAuthenticationMethodsItem: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
AppCredentialsNotConfiguredErrorTrutoErrorCode: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
BillingAccountResponseBillingStatus: Informational; nothing is enforced on it today.
BillingInvoiceResponseSource: automated when Truto generated it from a plan; stripe_manual when it was raised by hand in Stripe.
BillingInvoiceResponseStatus: Raw Stripe invoice status.
BillingLineKind: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
BillingLineMetric: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
BillingPlanResponseBaseFeeInterval: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
BillingPlanResponseBillingMode: automatic invoices are generated by the daily billing run on billing_day; manual plans are invoiced by Truto staff.
CapabilityUnifiedResourceMethodsItem: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
DatastoreCreateRequestType: The datastore type. Determines the shape of config.
DatastoreSchemaType: The datastore’s backend type. Determines the shape of config.
DocumentationEntityType: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
DocumentationType: Documentation row type. Per-method MCP tooling uses description, tool_name, query_schema, body_schema, and response_schema. Integration-wide rows include readme, oauth_*, and note.
EnvironmentIntegrationConfigQueryArrayFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
EnvironmentIntegrationResourceMethodBodyFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
EnvironmentIntegrationResourceMethodMethod: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
EnvironmentIntegrationResourceMethodPermissionVocabulary: Per-environment override for which vocabulary scopes and scopes_any_of are written in. See IntegrationResourceMethod.permission_vocabulary for what the values mean and why the field normally stays unset. Overriding it here corrects one environment without touching the base integration.
EnvironmentIntegrationResourceMethodQueryArrayFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
EnvironmentUnifiedModelMappingStepType: Step kind. request performs an HTTP call against any integration resource; state/replace_data are reserved for runtime state mutation.
EnvironmentUnifiedModelResourceMethodOverrideResponseMappingMethod: For object-form mappings, whether the response represents a single item or an array.
ForbiddenErrorInsightSchemaValuePermissionVocabulary: Which vocabulary the required permissions are written in, and therefore what the remedy is. Only oauth_scope is fixed by reconnecting.
ForbiddenErrorInsightSchemaValueRefusalBasis: Always present. Treat this as an open set: the values below are the ones Truto emits today, and the read path deliberately accepts an unrecognised one so a newly shipped state cannot break a client — or an older Truto build — that has not heard of it. Generate a permissive type from it and keep a default branch.
GroupMappingResponseRole: The role granted to members of the mapped SCIM group. Null leaves the role unchanged.
HttpRequestFieldsAuthenticationType: How the request was authenticated.
IntegratedAccountAuthenticationMethod: Type of authentication used.
IntegratedAccountCreateAuthenticationMethod: Type of authentication used.
IntegratedAccountCreateRegion: The region where the integrated account is placed.
IntegratedAccountRegion: The region where the integrated account is placed.
IntegratedAccountStatus: Status of the integrated account.
IntegratedAccountUnifiedModelOverrideMethodResponseMappingMethod: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegratedAccountWebhookPayloadWebhookType: The type of this webhook payload, if relevant (e.g. a “verify” event).
IntegrationActionStepType: Step kind: * request — perform an HTTP call (config matches IntegrationResourceMethod). * transform — apply a JSONata expression over the running context. * update_context / set_context — write into the shared step context. * get_context — read from the shared step context. * form — pause and ask the connected user to fill a form (post-connect form).
IntegrationApiKeyCredentialFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationAwsStsCredentialFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationBasicAuthorizationFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationBearerAuthorizationFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationConfigQueryArrayFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationCursorPaginationConfigCursorPathObject: Where to read cursor_path from.
IntegrationCursorPaginationConfigLimitDataType: Cast the limit value when sending it in the body.
IntegrationCursorPaginationFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationDynamicPaginationFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationFieldTransform: Optional transform applied to the user input before storing.
IntegrationFieldType: How the field is rendered in the Link UI.
IntegrationGeneratedFieldType: What is generated.
IntegrationHeaderAuthorizationFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationJwtBearerCredentialConfigAuthMethod: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationJwtBearerCredentialConfigJwtAlgorithm: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationJwtBearerCredentialConfigOptionsAuthorizationMethod: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationJwtBearerCredentialConfigOptionsBodyFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationJwtBearerCredentialFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationKekaOAuthCredentialFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationLinkHeaderPaginationFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationOAuth2ClientCredentialConfigOptionsAuthorizationMethod: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationOAuth2ClientCredentialConfigOptionsBodyFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationOAuth2ClientCredentialFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationOAuth2CredentialConfigOptionsAuthorizationMethod: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationOAuth2CredentialConfigOptionsBodyFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationOAuth2CredentialConfigPkceMethod: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationOAuth2CredentialFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationOAuthCredentialConfigOptionsSignatureMethod: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationOAuthCredentialFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationOffsetPaginationFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationPagePaginationFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationRangePaginationFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationResourceMethodBodyFormat: How the request body is serialized: * json — JSON-encoded (default). * form — application/x-www-form-urlencoded. * multipart — multipart/form-data. See IntegrationResourceMethodBodyFormatConfigMultipart for tuning options. The file field is declared in body_schema as type: string, format: binary. * raw — sent verbatim, with Content-Type set from body_format_config.content_type. For a file upload body_schema has exactly one property, file as type: string, format: binary; for a raw text body, a single plain type: string property. raw is also used to send a structured body under its own content type (for example application/vnd.api+json or application/scim+json), which is not a file and keeps an ordinary body_schema. * xml — converted to XML and sent as application/xml.
IntegrationResourceMethodMethod: HTTP method. Includes WebDAV/CalDAV verbs (e.g. propfind, report) for integrations such as Apple/iCloud Calendar.
IntegrationResourceMethodPermissionVocabulary: Which vocabulary scopes and scopes_any_of above are written in, declared rather than inferred. Normally omitted: Truto derives this from configuration that already exists, so every integration is classified without anyone labelling it. Set it only to correct a derivation that reads an integration wrongly.
IntegrationResourceMethodQueryArrayFormat: How array values are serialized in the query string. comma → ?a=1,2; brackets → ?a[]=1&a[]=2; indices → ?a[0]=1&a[1]=2; repeat → ?a=1&a=2.
IntegrationSchemaSharing: The sharing policy of the integration.
IntegrationWebhookBasicVerificationFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationWebhookBearerVerificationFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationWebhookHandleVerificationResultType: Branch selector — verify returns verification_response directly to the vendor; payload falls through to normal event handling.
IntegrationWebhookHmacVerificationFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationWebhookJwtVerificationFormat: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
IntegrationWebhookPayloadContextWebhookType: verify for handshake/challenge requests, payload for real event deliveries, meta for Truto metadata pings.
JsonSchemaObjectPropertiesItemsType: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
JsonSchemaObjectPropertiesType: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
JsonSchemaObjectType: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
LinkTokenRequestRegion: The region where the new integrated account will be placed. Only applies when creating a new integrated account via the link token (ignored for reauthorization).
LogBaseLogType: Discriminator. Echoed from the log_type query parameter so each row is self-describing. Use this to switch on variant when consuming the response programmatically.
MCPConfigToolExposure: How tools are exposed on tools/list. - all (default): every matching tool schema is listed. - discovery: only three meta-tools are listed (search_tools, get_tool_schema, call_tool). The client discovers and calls real tools through those.
McpLogLogType: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
McpLogMcpMethod: The MCP protocol method.
McpLogRequestType: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
ObservabilityDestinationCreateRequestType: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
ObservabilityDestinationResponseType: Destination type.
ObservabilityDestinationUpdateRequestType: Changing the type requires config and secrets for the new type in the same request.
PasskeyAuthenticationOptionsUserVerification: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
PasskeyRegistrationOptionsAttestation: v1 asks for no attestation.
RapidBridgeLogDurableObject: The Durable Object class that emitted the log.
RapidBridgeLogLogType: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
SessionTokenMeResponseIssuerType: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
SessionTokenMeResponseLayoutDefaultGroupBy: How the catalog is grouped when it opens.
SessionTokenMeResponseLayoutDefaultView: Which catalog layout the widget opens in.
SessionTokenMeResponseType: Which kind of credential this is. tenant is a session token minted by POST /session-token — the credential this resource is named for. api_token is an admin API key, and session is a signed-in dashboard user, neither of which is a session token in the sense used here. An integrated-account token never appears: it cannot reach this route at all (see the 403 below).
SsoConnectionResponseProtocol: The SSO protocol used by this connection.
SyncJobCronTriggerLogAlarmType: The alarm classifier emitted by the underlying Durable Object.
SyncJobCronTriggerLogLogType: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
SyncJobRunCreateRequestErrorHandling: Specify how to handle errors while running the sync job. fail_fast - stop the sync job run as soon as an error is encountered, ignore - continue running the sync job run even if an error is encountered. In case of ignore, you’ll receive sync_job_run:record_error events for each error encountered. In case of batch, you’ll receive sync_job_run:record_error events with multiple errors batched into the errors array, this is only supported when the version used for Sync Job Run is 2. By default, ignore is used.
SyncJobRunSchemaErrorHandling: Specifies the error handling strategy used for the sync job run. fail_fast - stop the sync job run as soon as an error is encountered, ignore - continue running the sync job run even if an error is encountered. In case of ignore, you’ll receive sync_job_run:record_error events for each error encountered. In case of batch, you’ll receive sync_job_run:record_error events with multiple errors batched into the errors array, this is only supported when the version used for Sync Job Run is 2.
SyncJobRunSchemaStatus: The status of the sync job run. created - waiting to run, running - running, rate_limited - temporarily paused after an upstream rate-limit response and will resume automatically after backoff, completed - completed successfully, failed - failed, stopped - stopped by the user.
SyncJobTemplateCreateSharing: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
SyncJobTemplatePatchSharing: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
SyncJobTemplateSchemaSharing: The sharing policy of the template.
TenantBulkCreateResponseSkippedItemReason: Why the row was skipped.
TenantBulkRequestMode: Collision behaviour. insert skips existing ids; upsert updates name/metadata on existing ids.
TenantVisibilityConditionOp: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
UnifiedModelMethodConditionalFileUploadFileUpload: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
UnifiedModelMethodFileUploadFileUpload: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
UnifiedModelResourceMethodResponseMappingMethod: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
UnifiedModelResponseSharing: The sharing policy of the unified model.
UnifiedProxyApiLogLogType: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
UnifiedProxyApiLogRequestType: Whether the request was served by a Unified API mapping or a raw Proxy API passthrough.
WebhookEventTypes: The event type of a webhook.
WebhookLogDurableObject: The Durable Object class that emitted the log.
WebhookLogLogType: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
WebhookLogMethod: Which delivery path emitted the row — deliver for the first attempt, alarm for a scheduled retry. This is not a Truto API method.
WebhookLogStatus: Only ever set to error, on a failed or skipped delivery. Absent on a successful delivery — read webhook_endpoint_status for the endpoint’s response code.
WebhookTestEventTypes: The event type to simulate with POST /webhook/test. Every event type the platform emits — each one delivers a payload shaped like the real thing.
WorkflowRunResponseStatus: Open enum: values this SDK does not know decode as Other and serialise back unchanged.
WorkflowStepSchemaType: Step execution type.

Type Aliases§

IntegratedAccountUnifiedModelOverride: Per-account unified-mapping overrides, keyed by unified model name and then by resource name. Only the method keys list, create, get, update and delete are read, and each accepts the subset of mapping fields in IntegratedAccountUnifiedModelOverrideMethod — any other field is dropped on write.
SyncJobRunResourceStats: Per-resource, per-method counters describing how much data the sync job moved. The outer keys are resource names (matching the resources[].name field of the sync job), the inner keys are the integration method invoked (list, get, etc.). Updated approximately every 10 seconds while the sync job run is in flight.
UnifiedModelResourceIntegrationMapping: Per-integration mapping table for a unified-model resource. Top-level keys are integration names; each value contains the per-method mapping.

Module models

Module models Copy item path

Structs§

Enums§

Type Aliases§

Module models