Crate vynfi 

VynFi Rust SDK — synthetic financial data generation.

Example

use vynfi::Client;

#[tokio::main]
async fn main() -> Result<(), vynfi::VynFiError> {
    let client = Client::builder("vf_live_...").build()?;
    let sectors = client.catalog().list_sectors().await?;
    Ok(())
}

Structs

Adversarial

Adversarial probing resource (DS 3.0+, Enterprise tier).

AdversarialProbeResponse

AdversarialProbeResults

Ai

AI co-pilot resource (DS 3.0+, Scale+ tier).

AiChatRequest

AiChatResponse

AiTuneRequest

AiTuneResponse

AmlDetectabilityAnalysis

AmountDistributionAnalysis

ApiKey

An existing API key (secret not included).

ApiKeyCreated

A newly created API key (includes the full secret).

ApiKeys

API-key management resource — create, list, update, and revoke API keys.

AuditArtifacts

AuditOpinion

BalanceInfo

Balance information in a cost estimate.

BankingEvaluation

BenfordAnalysis

Billing

Billing resource — subscription, checkout, invoices, and payment methods.

CalibrationRequest

CancelJobResponse

Response from cancelling a job.

Catalog

Catalog resource — browse sectors, tables, and fingerprint profiles.

CatalogItem

A catalog item (from GET /v1/catalog).

ChartOfAccountsMeta

CheckoutRequest

Request body for creating a Stripe checkout session.

CheckoutResponse

Response containing a Stripe checkout URL.

Client

Async VynFi API client.

ClientBuilder

Builder for configuring and constructing a Client.

Column

A column definition within a table.

CompanyConfigResponse

ComposeConfigRequest

Request body for composing a config from layers.

ComposeConfigResponse

Response from composing a config.

Configs

Configs resource — save, list, update, validate, and estimate generation configs.

ConformanceRequest

CreateApiKeyRequest

Request body for creating an API key.

CreateConfigRequest

Request body for creating a saved config.

CreatePackRequest

CreateScenarioRequest

Request body for creating a what-if scenario.

CreateSessionRequest

Request body for creating a multi-period generation session.

CreateWebhookRequest

Request body for creating a webhook.

Credits

Credits resource — purchase prepaid credits and check balances.

DailyQuality

Aggregate quality score for a single day.

DailyUsage

Credits consumed on a single day.

DailyUsageResponse

Daily usage response with per-table totals.

DeletedResponse

Response from deleting a config.

EnrichCategoryRequest

ErrorBody

Structured error body from the VynFi API (RFC 7807).

EstimateCostRequest

Request body for estimating config cost.

EstimateCostResponse

Response from estimating config cost.

EstimateSizeRequest

EstimateSizeResponse

ExtendSessionRequest

Request body for extending a session with additional periods.

FileSchema

Fingerprint

Fingerprint synthesis resource (DS 3.0+, Team+).

FingerprintSynthesisResponse

FraudSplit

FraudTypeSplit

GenerateConfigRequest

Config-based generation request (portal-style).

GenerateRequest

Legacy generation request (tables-based).

GenerateSessionResponse

Response from generating the next period of a session.

GenerationSession

A multi-period generation session.

Invoice

An invoice from Stripe.

Job

A generation job.

JobAnalytics

JobArchive

Ergonomic wrapper around a downloaded job archive.

JobFile

JobFileList

JobLinks

Links returned with a submitted job.

JobList

Paginated list of jobs.

Jobs

Jobs resource — submit, list, get, cancel, stream, and download generation jobs.

KeyAuditMatter

KycCompletenessAnalysis

ListConfigsParams

Parameters for listing saved configs.

ListJobsParams

Parameters for listing jobs.

ListNotificationsParams

Parameters for listing notifications.

MarkReadRequest

Request body for marking notifications as read.

MonteCarloRequest

MultiplierEntry

A credit multiplier entry in a cost estimate.

NdjsonStreamParams

Parameters for NDJSON output streaming.

NlCompanyRequest

NlConfigResponse

NlDescriptionRequest

Notification

A user notification.

Notifications

Notifications resource — list and manage notifications.

Optimizer

Audit optimizer resource (VynFi API 4.1+, DS 4.1.2+, Scale+).

OptimizerResponse

PortalResponse

Response containing a Stripe billing portal URL.

PortfolioRequest

PrepaidBalanceResponse

Prepaid credit balance with active batches.

PrepaidBatch

A prepaid credit batch.

PrepaidHistoryResponse

Prepaid credit history (includes expired batches).

ProbeSample

PurchaseCreditsRequest

Request body for purchasing a prepaid credit pack.

PurchaseCreditsResponse

Response from purchasing credits (Stripe checkout URL).

Quality

Quality metrics resource — retrieve quality scores and trend data.

QualityScore

Quality score for a generated table.

QuickJobResponse

Response from a quick (synchronous) generation job.

RawConfigRequest

RawConfigResponse

ResourcesRequest

RevokeKeyResponse

Response from revoking an API key.

RiskScopeRequest

SaftExportConfig

SapExportConfig

SavedConfig

A saved generation configuration.

Scenario

A what-if scenario comparing baseline and counterfactual generation.

ScenarioTemplate

A scenario template with graph structure.

ScenarioTemplateEdge

An edge in a scenario template graph.

ScenarioTemplateNode

A node in a scenario template graph.

Scenarios

Scenarios resource — create and run what-if analysis scenarios.

Sector

A full sector with its tables (from GET /v1/sectors/{slug}).

SectorSummary

Abbreviated sector information (from GET /v1/sectors).

Sessions

Sessions resource — manage multi-period generation sessions.

SizeBucket

SseEvent

A parsed Server-Sent Event from the job progress stream.

SubmitJobResponse

Response from submitting an async generation job.

Subscription

Subscription details.

TableDef

A table definition within a sector.

TableSpec

A table specification within a legacy generation request.

TableUsage

Per-table usage breakdown.

Template

A system template for generation configs.

TemplatePack

TemplatePackCategoryContent

TemplatePackCategorySummary

TemplatePackEnrichResponse

TemplatePackList

TemplatePackValidation

TemplatePackValidationIssue

TemplatePacks

Template packs resource (VynFi API 4.1+, DS 3.2+, Team+).

TypologyDetection

UpdateApiKeyRequest

Request body for updating an API key.

UpdateConfigRequest

Request body for updating a saved config.

UpdatePackRequest

UpdateWebhookRequest

Request body for updating a webhook.

Usage

Usage resource — credit balance and daily usage breakdown.

UsageSummary

Credit usage summary.

ValidateConfigRequest

Request body for validating a config.

ValidateConfigResponse

Response from config validation.

ValidationFix

A suggested fix for a validation issue.

ValidationIssue

A validation issue (error or warning).

VariantAnalysis

Webhook

An existing webhook (list view).

WebhookCreated

A newly created webhook (includes the signing secret).

WebhookDelivery

A single webhook delivery attempt.

WebhookDetail

Webhook detail with delivery history.

Webhooks

Webhooks resource — create, list, update, delete, and test webhooks.

Enums

VynFiError

All errors returned by the VynFi SDK.

Constants

SAP_ALL_TABLES

Full SAP superset (DS 4.3+) — master data, transactional, open/cleared items for GL/AR/AP.

SAP_DEFAULT_TABLES

Default 8-table SAP set emitted when exportFormat == "sap" without an explicit tables list.