@luisjpf/alpaca-sdk 0.3.3 → 0.3.4

package/dist/index.d.cts

@@ -5358,7 +5358,7 @@ declare function createTradingClient(config: TradingClientConfig): {
             hwm?: string | null;
             position_intent?: components$2["schemas"]["PositionIntent"];
         }>;
-        /** Cancel an order */
+        /** Cancel an order. Returns void on success (204 No Content). */
         cancel(orderId: string, options?: RequestOptions): Promise<void>;
         /** Cancel all open orders */
         cancelAll(options?: RequestOptions): Promise<{
@@ -5575,7 +5575,7 @@ declare function createTradingClient(config: TradingClientConfig): {
             name: string;
             assets?: components$2["schemas"]["Assets"][];
         }>;
-        /** Delete a watchlist */
+        /** Delete a watchlist. Returns void on success (204 No Content). */
         delete(watchlistId: string, options?: RequestOptions): Promise<void>;
     };
 };
@@ -26044,7 +26044,7 @@ declare function createBrokerClient(config: BrokerClientConfig): {
             fee_payment_method?: string | null;
             ira?: components["schemas"]["TransferIRADetails"];
         }>;
-        /** Delete/cancel a transfer */
+        /** Delete/cancel a transfer. Returns void on success (204 No Content). */
         delete(accountId: string, transferId: string, options?: RequestOptions): Promise<void>;
     };
     /** ACH relationship operations */
@@ -26075,7 +26075,7 @@ declare function createBrokerClient(config: BrokerClientConfig): {
             bank_routing_number?: string;
             nickname?: string;
         }>;
-        /** Delete an ACH relationship */
+        /** Delete an ACH relationship. Returns void on success (204 No Content). */
         delete(accountId: string, achRelationshipId: string, options?: RequestOptions): Promise<void>;
     };
     /** Trading operations on behalf of accounts */
@@ -26254,7 +26254,7 @@ declare function createBrokerClient(config: BrokerClientConfig): {
                 swap_fee_bps?: string;
                 usd?: Record<string, never>;
             }>;
-            /** Cancel an order */
+            /** Cancel an order. Returns void on success (204 No Content). */
             cancel(accountId: string, orderId: string, options?: RequestOptions): Promise<void>;
             /** Cancel all orders */
             cancelAll(accountId: string, options?: RequestOptions): Promise<{
@@ -26531,6 +26531,21 @@ interface TradeUpdate {
     qty?: string;
     timestamp?: string;
 }
+/**
+ * Type guard to check if a message is a Trade.
+ * Validates both the discriminant (T) and the symbol (S) property.
+ */
+declare function isTrade(message: unknown): message is Trade;
+/**
+ * Type guard to check if a message is a Quote.
+ * Validates both the discriminant (T) and the symbol (S) property.
+ */
+declare function isQuote(message: unknown): message is Quote;
+/**
+ * Type guard to check if a message is a Bar.
+ * Validates both the discriminant (T) and the symbol (S) property.
+ */
+declare function isBar(message: unknown): message is Bar;
 
 /**
  * Stock market data streaming
@@ -26727,4 +26742,4 @@ interface AlpacaClient {
  */
 declare function createAlpacaClient(config: AlpacaClientConfig): AlpacaClient;
 
-export { type ACHRelationship, ALPACA_URLS, type AccountActivity, type AccountCreationRequest, type AccountDocument, type AccountExtended, type AccountStatus, type AccountUpdateRequest, type Activity, type ActivityType, type AlpacaClient, type AlpacaClientConfig, type AlpacaConfig, type AlpacaEnvironment, AlpacaError, type ApiError, type ApiKeyAuth, type AuthHeaders, type AuthenticationApiError, AuthenticationError, type BasicAuth, type Account as BrokerAccount, type AccountConfigurations as BrokerAccountConfigurations, type Calendar as BrokerCalendar, type BrokerClient, type BrokerClientConfig, type Clock as BrokerClock, type NonTradeActivity as BrokerNonTradeActivity, type Order as BrokerOrder, type OrderClass as BrokerOrderClass, type OrderSide as BrokerOrderSide, type OrderType as BrokerOrderType, type Position as BrokerPosition, type TimeInForce as BrokerTimeInForce, type TradeActivity as BrokerTradeActivity, type Contact, type CorporateActions, type CreateACHRelationshipRequest, type CreateOrderRequest, type CreateTransferRequest, type CryptoBar, type CryptoOrderbook, type CryptoQuote, type CryptoSnapshot, type CryptoStream, type CryptoTrade, type Disclosures, ErrorType, type ForbiddenApiError, ForbiddenError, type Identity, type InsufficientFundsApiError, InsufficientFundsError, type MarketClosedApiError, MarketClosedError, type MarketDataClient, type MarketDataClientConfig, type MostActive, type Mover, type News, type NewsImage, type NonTradeActivity$1 as NonTradeActivity, type NotFoundApiError, NotFoundError, NotImplementedError, type OAuthAuth, type OpenApiFetchResponse, type OptionBar, type OptionGreeks, type OptionQuote, type OptionSnapshot, type OptionTrade, type OrderRequest, type OrderStatus, type OwnerDocument, type PatchOrderRequest, type PortfolioHistory, type RateLimitApiError, RateLimitError, type RequestOptions, type ResolvedAlpacaConfig, type Result, type ServerApiError, ServerError, type StockAuction, type StockBar, type StockQuote, type StockSnapshot, type StockStream, type StockTrade, type StreamConfig, type StreamState, type TradeAccount, type TradeUpdatesStream, type Account$1 as TradingAccount, type AccountConfigurations$1 as TradingAccountConfigurations, type TradingActivity, type Asset as TradingAsset, type Calendar$1 as TradingCalendar, type TradingClient, type TradingClientConfig, type Clock$1 as TradingClock, type Order$1 as TradingOrder, type OrderClass$1 as TradingOrderClass, type OrderSide$1 as TradingOrderSide, type OrderType$1 as TradingOrderType, type Position$1 as TradingPosition, type TimeInForce$1 as TradingTimeInForce, type Transfer, type TransferDirection, type TransferType, type TrustedContact, type UnknownApiError, type ValidationApiError, ValidationError, type Watchlist, type WebSocketAuthMessage, createAlpacaClient, createAlpacaError, createApiError, createApiFetch, createApiKeyAuth, createBasicAuth, createBrokerClient, createCryptoStream, createHeaders, createMarketDataClient, createOAuthAuth, createStockStream, createTradeUpdatesStream, createTradingClient, createWebSocketAuth, createWebSocketOAuth, err, fetchWithRetry, isApiError, isAuthenticationError, isInsufficientFundsError, isMarketClosedError, isNotFoundError, isRateLimitError, isServerError, isValidationError, ok, resolveConfig, toApiError, unwrap, unwrapList, unwrapOptional };
+export { type ACHRelationship, ALPACA_URLS, type AccountActivity, type AccountCreationRequest, type AccountDocument, type AccountExtended, type AccountStatus, type AccountUpdateRequest, type Activity, type ActivityType, type AlpacaClient, type AlpacaClientConfig, type AlpacaConfig, type AlpacaEnvironment, AlpacaError, type ApiError, type ApiKeyAuth, type AuthHeaders, type AuthenticationApiError, AuthenticationError, type Bar, type BasicAuth, type Account as BrokerAccount, type AccountConfigurations as BrokerAccountConfigurations, type Calendar as BrokerCalendar, type BrokerClient, type BrokerClientConfig, type Clock as BrokerClock, type NonTradeActivity as BrokerNonTradeActivity, type Order as BrokerOrder, type OrderClass as BrokerOrderClass, type OrderSide as BrokerOrderSide, type OrderType as BrokerOrderType, type Position as BrokerPosition, type TimeInForce as BrokerTimeInForce, type TradeActivity as BrokerTradeActivity, type Contact, type CorporateActions, type CreateACHRelationshipRequest, type CreateOrderRequest, type CreateTransferRequest, type CryptoBar, type CryptoOrderbook, type CryptoQuote, type CryptoSnapshot, type CryptoStream, type CryptoTrade, type Disclosures, ErrorType, type ForbiddenApiError, ForbiddenError, type Identity, type InsufficientFundsApiError, InsufficientFundsError, type MarketClosedApiError, MarketClosedError, type MarketDataClient, type MarketDataClientConfig, type MostActive, type Mover, type News, type NewsImage, type NonTradeActivity$1 as NonTradeActivity, type NotFoundApiError, NotFoundError, NotImplementedError, type OAuthAuth, type OpenApiFetchResponse, type OptionBar, type OptionGreeks, type OptionQuote, type OptionSnapshot, type OptionTrade, type OrderRequest, type OrderStatus, type OwnerDocument, type PatchOrderRequest, type PortfolioHistory, type Quote, type RateLimitApiError, RateLimitError, type RequestOptions, type ResolvedAlpacaConfig, type Result, type ServerApiError, ServerError, type StockAuction, type StockBar, type StockQuote, type StockSnapshot, type StockStream, type StockTrade, type StreamConfig, type StreamState, type Trade, type TradeAccount, type TradeUpdate, type TradeUpdatesStream, type Account$1 as TradingAccount, type AccountConfigurations$1 as TradingAccountConfigurations, type TradingActivity, type Asset as TradingAsset, type Calendar$1 as TradingCalendar, type TradingClient, type TradingClientConfig, type Clock$1 as TradingClock, type Order$1 as TradingOrder, type OrderClass$1 as TradingOrderClass, type OrderSide$1 as TradingOrderSide, type OrderType$1 as TradingOrderType, type Position$1 as TradingPosition, type TimeInForce$1 as TradingTimeInForce, type Transfer, type TransferDirection, type TransferType, type TrustedContact, type UnknownApiError, type ValidationApiError, ValidationError, type Watchlist, type WebSocketAuthMessage, createAlpacaClient, createAlpacaError, createApiError, createApiFetch, createApiKeyAuth, createBasicAuth, createBrokerClient, createCryptoStream, createHeaders, createMarketDataClient, createOAuthAuth, createStockStream, createTradeUpdatesStream, createTradingClient, createWebSocketAuth, createWebSocketOAuth, err, fetchWithRetry, isApiError, isAuthenticationError, isBar, isInsufficientFundsError, isMarketClosedError, isNotFoundError, isQuote, isRateLimitError, isServerError, isTrade, isValidationError, ok, resolveConfig, toApiError, unwrap, unwrapList, unwrapOptional };

package/dist/index.d.ts

@@ -5358,7 +5358,7 @@ declare function createTradingClient(config: TradingClientConfig): {
             hwm?: string | null;
             position_intent?: components$2["schemas"]["PositionIntent"];
         }>;
-        /** Cancel an order */
+        /** Cancel an order. Returns void on success (204 No Content). */
         cancel(orderId: string, options?: RequestOptions): Promise<void>;
         /** Cancel all open orders */
         cancelAll(options?: RequestOptions): Promise<{
@@ -5575,7 +5575,7 @@ declare function createTradingClient(config: TradingClientConfig): {
             name: string;
             assets?: components$2["schemas"]["Assets"][];
         }>;
-        /** Delete a watchlist */
+        /** Delete a watchlist. Returns void on success (204 No Content). */
         delete(watchlistId: string, options?: RequestOptions): Promise<void>;
     };
 };
@@ -26044,7 +26044,7 @@ declare function createBrokerClient(config: BrokerClientConfig): {
             fee_payment_method?: string | null;
             ira?: components["schemas"]["TransferIRADetails"];
         }>;
-        /** Delete/cancel a transfer */
+        /** Delete/cancel a transfer. Returns void on success (204 No Content). */
         delete(accountId: string, transferId: string, options?: RequestOptions): Promise<void>;
     };
     /** ACH relationship operations */
@@ -26075,7 +26075,7 @@ declare function createBrokerClient(config: BrokerClientConfig): {
             bank_routing_number?: string;
             nickname?: string;
         }>;
-        /** Delete an ACH relationship */
+        /** Delete an ACH relationship. Returns void on success (204 No Content). */
         delete(accountId: string, achRelationshipId: string, options?: RequestOptions): Promise<void>;
     };
     /** Trading operations on behalf of accounts */
@@ -26254,7 +26254,7 @@ declare function createBrokerClient(config: BrokerClientConfig): {
                 swap_fee_bps?: string;
                 usd?: Record<string, never>;
             }>;
-            /** Cancel an order */
+            /** Cancel an order. Returns void on success (204 No Content). */
             cancel(accountId: string, orderId: string, options?: RequestOptions): Promise<void>;
             /** Cancel all orders */
             cancelAll(accountId: string, options?: RequestOptions): Promise<{
@@ -26531,6 +26531,21 @@ interface TradeUpdate {
     qty?: string;
     timestamp?: string;
 }
+/**
+ * Type guard to check if a message is a Trade.
+ * Validates both the discriminant (T) and the symbol (S) property.
+ */
+declare function isTrade(message: unknown): message is Trade;
+/**
+ * Type guard to check if a message is a Quote.
+ * Validates both the discriminant (T) and the symbol (S) property.
+ */
+declare function isQuote(message: unknown): message is Quote;
+/**
+ * Type guard to check if a message is a Bar.
+ * Validates both the discriminant (T) and the symbol (S) property.
+ */
+declare function isBar(message: unknown): message is Bar;
 
 /**
  * Stock market data streaming
@@ -26727,4 +26742,4 @@ interface AlpacaClient {
  */
 declare function createAlpacaClient(config: AlpacaClientConfig): AlpacaClient;
 
-export { type ACHRelationship, ALPACA_URLS, type AccountActivity, type AccountCreationRequest, type AccountDocument, type AccountExtended, type AccountStatus, type AccountUpdateRequest, type Activity, type ActivityType, type AlpacaClient, type AlpacaClientConfig, type AlpacaConfig, type AlpacaEnvironment, AlpacaError, type ApiError, type ApiKeyAuth, type AuthHeaders, type AuthenticationApiError, AuthenticationError, type BasicAuth, type Account as BrokerAccount, type AccountConfigurations as BrokerAccountConfigurations, type Calendar as BrokerCalendar, type BrokerClient, type BrokerClientConfig, type Clock as BrokerClock, type NonTradeActivity as BrokerNonTradeActivity, type Order as BrokerOrder, type OrderClass as BrokerOrderClass, type OrderSide as BrokerOrderSide, type OrderType as BrokerOrderType, type Position as BrokerPosition, type TimeInForce as BrokerTimeInForce, type TradeActivity as BrokerTradeActivity, type Contact, type CorporateActions, type CreateACHRelationshipRequest, type CreateOrderRequest, type CreateTransferRequest, type CryptoBar, type CryptoOrderbook, type CryptoQuote, type CryptoSnapshot, type CryptoStream, type CryptoTrade, type Disclosures, ErrorType, type ForbiddenApiError, ForbiddenError, type Identity, type InsufficientFundsApiError, InsufficientFundsError, type MarketClosedApiError, MarketClosedError, type MarketDataClient, type MarketDataClientConfig, type MostActive, type Mover, type News, type NewsImage, type NonTradeActivity$1 as NonTradeActivity, type NotFoundApiError, NotFoundError, NotImplementedError, type OAuthAuth, type OpenApiFetchResponse, type OptionBar, type OptionGreeks, type OptionQuote, type OptionSnapshot, type OptionTrade, type OrderRequest, type OrderStatus, type OwnerDocument, type PatchOrderRequest, type PortfolioHistory, type RateLimitApiError, RateLimitError, type RequestOptions, type ResolvedAlpacaConfig, type Result, type ServerApiError, ServerError, type StockAuction, type StockBar, type StockQuote, type StockSnapshot, type StockStream, type StockTrade, type StreamConfig, type StreamState, type TradeAccount, type TradeUpdatesStream, type Account$1 as TradingAccount, type AccountConfigurations$1 as TradingAccountConfigurations, type TradingActivity, type Asset as TradingAsset, type Calendar$1 as TradingCalendar, type TradingClient, type TradingClientConfig, type Clock$1 as TradingClock, type Order$1 as TradingOrder, type OrderClass$1 as TradingOrderClass, type OrderSide$1 as TradingOrderSide, type OrderType$1 as TradingOrderType, type Position$1 as TradingPosition, type TimeInForce$1 as TradingTimeInForce, type Transfer, type TransferDirection, type TransferType, type TrustedContact, type UnknownApiError, type ValidationApiError, ValidationError, type Watchlist, type WebSocketAuthMessage, createAlpacaClient, createAlpacaError, createApiError, createApiFetch, createApiKeyAuth, createBasicAuth, createBrokerClient, createCryptoStream, createHeaders, createMarketDataClient, createOAuthAuth, createStockStream, createTradeUpdatesStream, createTradingClient, createWebSocketAuth, createWebSocketOAuth, err, fetchWithRetry, isApiError, isAuthenticationError, isInsufficientFundsError, isMarketClosedError, isNotFoundError, isRateLimitError, isServerError, isValidationError, ok, resolveConfig, toApiError, unwrap, unwrapList, unwrapOptional };
+export { type ACHRelationship, ALPACA_URLS, type AccountActivity, type AccountCreationRequest, type AccountDocument, type AccountExtended, type AccountStatus, type AccountUpdateRequest, type Activity, type ActivityType, type AlpacaClient, type AlpacaClientConfig, type AlpacaConfig, type AlpacaEnvironment, AlpacaError, type ApiError, type ApiKeyAuth, type AuthHeaders, type AuthenticationApiError, AuthenticationError, type Bar, type BasicAuth, type Account as BrokerAccount, type AccountConfigurations as BrokerAccountConfigurations, type Calendar as BrokerCalendar, type BrokerClient, type BrokerClientConfig, type Clock as BrokerClock, type NonTradeActivity as BrokerNonTradeActivity, type Order as BrokerOrder, type OrderClass as BrokerOrderClass, type OrderSide as BrokerOrderSide, type OrderType as BrokerOrderType, type Position as BrokerPosition, type TimeInForce as BrokerTimeInForce, type TradeActivity as BrokerTradeActivity, type Contact, type CorporateActions, type CreateACHRelationshipRequest, type CreateOrderRequest, type CreateTransferRequest, type CryptoBar, type CryptoOrderbook, type CryptoQuote, type CryptoSnapshot, type CryptoStream, type CryptoTrade, type Disclosures, ErrorType, type ForbiddenApiError, ForbiddenError, type Identity, type InsufficientFundsApiError, InsufficientFundsError, type MarketClosedApiError, MarketClosedError, type MarketDataClient, type MarketDataClientConfig, type MostActive, type Mover, type News, type NewsImage, type NonTradeActivity$1 as NonTradeActivity, type NotFoundApiError, NotFoundError, NotImplementedError, type OAuthAuth, type OpenApiFetchResponse, type OptionBar, type OptionGreeks, type OptionQuote, type OptionSnapshot, type OptionTrade, type OrderRequest, type OrderStatus, type OwnerDocument, type PatchOrderRequest, type PortfolioHistory, type Quote, type RateLimitApiError, RateLimitError, type RequestOptions, type ResolvedAlpacaConfig, type Result, type ServerApiError, ServerError, type StockAuction, type StockBar, type StockQuote, type StockSnapshot, type StockStream, type StockTrade, type StreamConfig, type StreamState, type Trade, type TradeAccount, type TradeUpdate, type TradeUpdatesStream, type Account$1 as TradingAccount, type AccountConfigurations$1 as TradingAccountConfigurations, type TradingActivity, type Asset as TradingAsset, type Calendar$1 as TradingCalendar, type TradingClient, type TradingClientConfig, type Clock$1 as TradingClock, type Order$1 as TradingOrder, type OrderClass$1 as TradingOrderClass, type OrderSide$1 as TradingOrderSide, type OrderType$1 as TradingOrderType, type Position$1 as TradingPosition, type TimeInForce$1 as TradingTimeInForce, type Transfer, type TransferDirection, type TransferType, type TrustedContact, type UnknownApiError, type ValidationApiError, ValidationError, type Watchlist, type WebSocketAuthMessage, createAlpacaClient, createAlpacaError, createApiError, createApiFetch, createApiKeyAuth, createBasicAuth, createBrokerClient, createCryptoStream, createHeaders, createMarketDataClient, createOAuthAuth, createStockStream, createTradeUpdatesStream, createTradingClient, createWebSocketAuth, createWebSocketOAuth, err, fetchWithRetry, isApiError, isAuthenticationError, isBar, isInsufficientFundsError, isMarketClosedError, isNotFoundError, isQuote, isRateLimitError, isServerError, isTrade, isValidationError, ok, resolveConfig, toApiError, unwrap, unwrapList, unwrapOptional };