# API Reference: Resources (Legacy/Advanced) While the Quicksilver SDK emphasizes a fluent Domain-Specific Language (DSL) and active models for common interactions, it also exposes the underlying resource classes (`src/resources/*`) for direct REST API calls. These classes are primarily used internally by the active models (like [API Reference: Account Model](/wiki/lantos1618/quicksilver-sdk/api-account-model) and [API Reference: Transaction Model](/wiki/lantos1618/quicksilver-sdk/api-transaction-model)) and the main [API Reference: QuicksilverClient](/wiki/lantos1618/quicksilver-sdk/api-client) to perform CRUD operations. Developers requiring fine-grained control over API requests, or integrating with legacy systems, may choose to interact with these resources directly. ## AccountsResource Class Manages direct interactions with the `/accounts` API endpoint for account creation, retrieval, listing, updating, and deletion. ```typescript class AccountsResource { /** * Initializes the AccountsResource. * @param httpClient The HttpClient instance used for API requests. */ constructor(httpClient: HttpClient); /** * Create a new account. * @param payload The details of the account to create. * @returns A Promise resolving to an Account active model. */ create(payload: CreateAccountPayload): Promise; /** * Retrieve an account by its ID. * @param id The ID of the account to retrieve. * @returns A Promise resolving to an Account active model. */ retrieve(id: string): Promise; /** * List all accounts with optional pagination. * @param params Pagination parameters. * @returns A Promise resolving to a paginated response of Account active models. */ list(params?: PaginationParams): Promise>; /** * Update an account. * @param id The ID of the account to update. * @param payload The updated account details. * @returns A Promise resolving to an Account active model. */ update(id: string, payload: Partial): Promise; /** * Delete an account. * @param id The ID of the account to delete. * @returns A Promise that resolves when the account is successfully deleted. */ delete(id: string): Promise; /** * Get all child accounts of a parent account. * @param parentId The ID of the parent account. * @param params Pagination parameters. * @returns A Promise resolving to a paginated response of child Account active models. */ getChildren(parentId: string, params?: PaginationParams): Promise>; } ``` ## TransactionsResource Class Manages direct interactions with the `/transactions` API endpoint for transaction creation, retrieval, listing, updating, and deletion. ```typescript class TransactionsResource { /** * Initializes the TransactionsResource. * @param httpClient The HttpClient instance used for API requests. */ constructor(httpClient: HttpClient); /** * Create a new transaction. * @param payload The details of the transaction. * @returns A Promise resolving to a Transaction active model. */ create(payload: CreateTransactionPayload): Promise; /** * Retrieve a transaction by its ID. * @param id The ID of the transaction. * @returns A Promise resolving to a Transaction active model. */ retrieve(id: string): Promise; /** * List all transactions with optional pagination and filtering. * @param params Pagination parameters and optional filters. * @returns A Promise resolving to a paginated response of Transaction active models. */ list(params?: PaginationParams & {from?: string; to?: string; transaction_type?: string; state?: string;}): Promise>; /** * Update a transaction. * @param id The ID of the transaction to update. * @param payload The updated transaction details. * @returns A Promise resolving to a Transaction active model. */ update(id: string, payload: Partial): Promise; /** * Delete a transaction. * @param id The ID of the transaction to delete. * @returns A Promise that resolves when the transaction is successfully deleted. */ delete(id: string): Promise; /** * Get all child transactions of a parent transaction. * @param parentId The ID of the parent transaction. * @param params Pagination parameters. * @returns A Promise resolving to a paginated response of child Transaction active models. */ getChildren(parentId: string, params?: PaginationParams): Promise>; /** * Execute a transaction through a gateway. * @param transactionId The ID of the transaction to execute. * @param gatewayId The ID of the gateway to use. * @returns A Promise resolving to the updated TransactionData. */ execute(transactionId: string, gatewayId: string): Promise; /** * Converts a base transaction into a streaming transaction. * @param baseTransactionId The ID of the transaction to convert into a stream. * @param payload The configuration for the stream. * @returns A Promise resolving to the StreamingTransaction details. */ createStream(baseTransactionId: string, payload: CreateStreamingTransactionPayload): Promise; /** * Get all transactions for a specific account. * @param accountId The ID of the account. * @param params Pagination parameters and optional filters. * @returns A Promise resolving to a paginated response of Transaction active models. */ getForAccount(accountId: string, params?: PaginationParams & {transaction_type?: string; state?: string;}): Promise>; } ``` ## StreamsResource Class Manages direct interactions with the `/streams` API endpoint for streaming payment operations and real-time event subscriptions. ```typescript class StreamsResource { /** * Initializes the StreamsResource. * @param httpClient The HttpClient instance used for API requests. * @param baseURL The base URL of the Quicksilver API. * @param apiKey The API key used for authentication. */ constructor(httpClient: HttpClient, baseURL: string, apiKey: string); /** * Retrieve the current state of a streaming transaction. * @param id The ID of the stream. * @returns A Promise resolving to the StreamingTransaction details. */ retrieve(id: string): Promise; /** * List all streaming transactions with optional pagination. * @param params Pagination parameters and optional filters. * @returns A Promise resolving to a paginated response of StreamingTransaction details. */ list(params?: PaginationParams & {from?: string; to?: string; state?: string;}): Promise>; /** * Pause a running stream. * @param id The ID of the stream to pause. * @returns A Promise resolving to a StatusResponse. */ pause(id: string): Promise; /** * Resume a paused stream. * @param id The ID of the stream to resume. * @returns A Promise resolving to a StatusResponse. */ resume(id: string): Promise; /** * Permanently stop a stream. * @param id The ID of the stream to stop. * @returns A Promise resolving to a StatusResponse. */ stop(id: string): Promise; /** * Update stream configuration. * @param id The ID of the stream to update. * @param payload The updated stream configuration. * @returns A Promise resolving to the updated StreamingTransaction details. */ update(id: string, payload: {rate?: number; rate_unit?: string; end_time?: string;}): Promise; /** * Get all streams for a specific account. * @param accountId The ID of the account. * @param params Pagination parameters and optional filters. * @returns A Promise resolving to a paginated response of StreamingTransaction details. */ getForAccount(accountId: string, params?: PaginationParams & {state?: string;}): Promise>; /** * Subscribe to real-time events for a specific stream. * @param id The ID of the stream to subscribe to. * @returns A StreamConnection object to handle event listeners. */ subscribe(id: string): StreamConnection; /** * Subscribe to real-time events for all streams of an account. * @param accountId The ID of the account. * @returns A StreamConnection object to handle event listeners. */ subscribeToAccount(accountId: string): StreamConnection; /** * Subscribe to real-time events for all streams (global). * @returns A StreamConnection object to handle event listeners. */ subscribeToAll(): StreamConnection; } ``` ## AdminResource Class Provides administrative operations, typically requiring elevated privileges on the Quicksilver Engine. ```typescript class AdminResource { /** * Initializes the AdminResource. * @param httpClient The HttpClient instance used for API requests. */ constructor(httpClient: HttpClient); /** * Get system statistics. * @returns A Promise resolving to system statistics including account and transaction counts. */ getStats(): Promise; /** * List all accounts in the system. * @returns A Promise resolving to a list of all raw Account objects. */ listAccounts(): Promise; /** * List all transactions in the system. * @returns A Promise resolving to a list of all raw Transaction objects. */ listTransactions(): Promise; /** * List all active streaming transactions. * @returns A Promise resolving to a list of active StreamingTransaction details. */ listActiveStreams(): Promise; } ``` ## GatewaysResource Class Manages interactions with payment gateways. ```typescript class GatewaysResource { /** * Initializes the GatewaysResource. * @param httpClient The HttpClient instance used for API requests. */ constructor(httpClient: HttpClient); /** * List available payment gateways. * @returns A Promise resolving to a list of available GatewayInfo. */ list(): Promise; /** * Execute a transaction through a payment gateway. * @param transactionId The ID of the transaction to execute. * @returns A Promise resolving to the gateway transaction result. */ executeTransaction(transactionId: string): Promise; } ``` ## KycResource Class Manages KYC (Know Your Customer) identity verification processes. ```typescript class KycResource { /** * Initializes the KycResource. * @param httpClient The HttpClient instance used for API requests. */ constructor(httpClient: HttpClient); /** * Initiate KYC verification for an account. * @param payload The KYC initiation details. * @returns A Promise resolving to a KycInitiateResponse. */ initiate(payload: KycInitiatePayload): Promise; /** * Get KYC status for an account. * @param accountId The ID of the account. * @returns A Promise resolving to the KycStatus for the account. */ getStatus(accountId: string): Promise; /** * Process KYC webhook (internal use). * @param webhookData The webhook payload from the KYC provider. * @returns A Promise resolving to a success indicator. */ processWebhook(webhookData: any): Promise<{ success: boolean }>; } ``` ## HealthResource Class Provides methods for checking the health and status of the Quicksilver API. ```typescript class HealthResource { /** * Initializes the HealthResource. * @param client The HttpClient instance used for API requests. */ constructor(client: HttpClient); /** * Check the health status of the service. * @returns A Promise resolving to a HealthStatus object. */ check(): Promise; /** * Ping the service to check if it's responsive. * @returns A Promise resolving to a PingResponse message and timestamp. */ ping(): Promise; } ```

API Reference: Resources (Legacy/Advanced)

Page Viewers

Guest Views