This page serves as a comprehensive reference for all fundamental types, interfaces, and enums used throughout the Quicksilver SDK. These definitions, primarily sourced from `src/types.ts`, underpin t
This page serves as a comprehensive reference for all fundamental types, interfaces, and enums used throughout the Quicksilver SDK. These definitions, primarily sourced from src/types.ts, underpin the data structures and interactions with the Quicksilver Engine API, as well as the fluent Domain-Specific Language (DSL) builders and active models.
AccountTypeDefines the permissible types for an account in the Quicksilver Engine.
TransactionTypeSpecifies the various kinds of transactions supported by the Quicksilver Engine.
TransactionStateRepresents the lifecycle states a transaction can be in.
StreamRateUnitDefines the units by which a streaming transaction's rate can be measured.
CurrencySpecifies supported currencies, including fiat and custom options.
QuickSilverEventAn enum defining standard events that can trigger conditional logic within the Quicksilver Engine. These events are crucial for orchestrating automated behaviors.
These interfaces represent the structured data used by the SDK's builders for defining dynamic behavior.
ActionThe fundamental interface for any action that can be performed by the Quicksilver Engine, typically as a result of a condition being met. Implemented by the Action class and ActionBuilder class.
ConditionRepresents a single conditional rule, consisting of a trigger (event or predicate) and a list of actions to perform. This is the underlying structure used by the ConditionBuilder class.
ProductDefinitionDefines the complete structure of a programmable product or service offered through the Quicksilver Engine. This includes its pricing, guarantees, and any associated multi-agent workflows. This is the underlying structure used by the ProductBuilder class.
These interfaces define the core entities managed by the Quicksilver Engine and form the basis for the Active Account Model and Active Transaction Model.
AccountRepresents an account entity in the Quicksilver Engine, encompassing its identity, type, metadata, limits, and verification status. This is the raw data structure before being wrapped by the Account active model.
TransactionRepresents a financial transaction, detailing its type, amount, parties involved, state, conditions, and metadata. This is the raw data structure before being wrapped by the Transaction active model.
StreamingTransactionExtends the base Transaction interface with properties specific to streaming payments, such as rate, unit, start/end times, and accumulated amount.
These interfaces define the structure of data sent to the API for creating or updating resources.
CreateAccountPayloadThe required and optional fields when creating a new account.
CreateTransactionPayloadThe required and optional fields when creating a new transaction.
CreateStreamingTransactionPayloadThe specific fields required when creating a streaming transaction.
These interfaces define the structure of standard responses from the API.
StatusResponseA common response format for operations that change the status of an entity, particularly streams.
These interfaces define the structure of events transmitted via Server-Sent Events (SSE) for real-time updates.
SSEStreamEventRepresents a generic event occurring on a streaming transaction, such as its lifecycle changes.
SSEBatchCreatedEventRepresents an event indicating that a batch payment has been created within a streaming transaction.
These interfaces define the structure of error responses returned by the API.
APIErrorThe standard format for an error response from the Quicksilver API.
These interfaces define the standard parameters for requesting paginated data and the structure of paginated responses from the API.
PaginationParamsParameters used to control pagination when listing resources.
PaginatedResponse<T>A generic wrapper for API responses that include paginated data, where T is the type of the items in the data array.