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

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.

Catalog

Catalog resource — browse sectors and their table definitions.

Client

Async VynFi API client.

ClientBuilder

Builder for configuring and constructing a Client.

Column

A column definition within a table.

CreateApiKeyRequest

Request body for creating an API key.

CreditBalance

Prepaid credit balance.

CreditBatch

A single prepaid credit batch.

CreditHistory

Credit purchase history.

CreditHistoryBatch

A credit batch with full history details.

Credits

Credits resource — purchase credit packs and view prepaid balance.

DailyUsage

Credits consumed on a single day.

DailyUsageResponse

Daily usage breakdown with per-table totals.

DownloadResponse

Response from the download endpoint (presigned URL).

ErrorBody

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

FieldError

A single field-level validation error.

GenerateRequest

Request body for generating synthetic data.

Job

A generation job.

JobList

Paginated list of jobs.

Jobs

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

ListJobsParams

Parameters for listing jobs.

PurchaseCreditsRequest

Request body for purchasing a credit pack.

PurchaseCreditsResponse

Response from purchasing credits (Stripe checkout URL).

Sector

A full sector with its tables.

SectorSummary

Abbreviated sector information (no tables).

SubmitJobResponse

Response from submitting an async generation job.

TableDef

A table definition within a sector.

TableSpec

A table specification within a generation request.

UpdateApiKeyRequest

Request body for updating an API key.

Usage

Usage resource — credit balance and daily usage breakdown.

UsageSummary

Credit usage summary.

Enums

VynFiError

All errors returned by the VynFi SDK.