@finatic/client 0.0.133 → 0.0.135

package/README.md

@@ -87,6 +87,15 @@ await finatic.placeOrder({
   timeInForce: 'day'
 });
 
+// Open portal with broker filtering
+await finatic.openPortal({
+  brokers: ['alpaca', 'robinhood'] // Only show these brokers
+});
+
+// Disconnect a company from a broker connection
+const disconnectResponse = await finatic.disconnectCompany('connection-uuid-here');
+console.log('Disconnect action:', disconnectResponse.response_data.action);
+
 // Close the portal when done
 finatic.closePortal();
 ```
@@ -120,6 +129,7 @@ Opens the authentication portal in an iframe.
   - `theme` (object, optional): Theme configuration
     - `preset` (string, optional): Preset theme name ('dark', 'light', 'corporateBlue', 'purple', 'green', 'orange')
     - `custom` (object, optional): Custom theme configuration object
+  - `brokers` (string[], optional): List of broker names to filter by (only these brokers will be shown)
 
 #### `closePortal()`
 
@@ -239,6 +249,69 @@ const modifiedTheme = createCustomThemeFromPreset('dark', {
 });
 ```
 
+### Portal Broker Filtering
+
+The Finatic Portal supports broker filtering via URL parameters. You can restrict which brokers are displayed in the portal by specifying a list of allowed broker names.
+
+#### Supported Brokers
+
+The following broker names are supported:
+- `alpaca` - Alpaca Markets
+- `robinhood` - Robinhood
+- `tasty_trade` - TastyTrade
+- `ninja_trader` - NinjaTrader
+
+#### Using Broker Filtering
+
+```javascript
+// Show only specific brokers
+await finatic.openPortal({
+  brokers: ['alpaca', 'robinhood']
+});
+
+// Show only one broker
+await finatic.openPortal({
+  brokers: ['tasty_trade']
+});
+
+// Combine with theme
+await finatic.openPortal({
+  theme: { preset: 'dark' },
+  brokers: ['alpaca', 'ninja_trader']
+});
+```
+
+#### Error Handling
+
+If you pass an unsupported broker name, it will be logged as a warning to the console, but the portal will still open with the supported brokers:
+
+```javascript
+// This will log a warning for 'unsupported_broker' but continue with 'alpaca'
+await finatic.openPortal({
+  brokers: ['alpaca', 'unsupported_broker']
+});
+```
+
+#### Broker Filtering Utilities
+
+```javascript
+import { 
+  convertBrokerNamesToIds, 
+  appendBrokerFilterToURL, 
+  getSupportedBrokerNames,
+  isBrokerSupported 
+} from 'finatic-sdk';
+
+// Convert broker names to IDs
+const { brokerIds, warnings } = convertBrokerNamesToIds(['alpaca', 'robinhood']);
+
+// Get list of supported broker names
+const supportedBrokers = getSupportedBrokerNames();
+
+// Check if a broker is supported
+const isSupported = isBrokerSupported('alpaca');
+```
+
 ### Data Access (Paginated)
 
 #### `getAccounts(params?)`
@@ -372,6 +445,20 @@ Returns broker connections for the authenticated user.
 
 Returns: Promise<BrokerConnection[]>
 
+#### `disconnectCompany(connectionId)`
+
+Disconnects a company from a broker connection.
+
+- `connectionId` (string): The connection ID to disconnect
+
+Returns: Promise<DisconnectCompanyResponse>
+
+The response includes:
+- `success` (boolean): Whether the operation was successful
+- `response_data.action` (string): Either 'company_access_removed' or 'connection_deleted'
+- `response_data.remaining_companies` (number, optional): Number of remaining companies if connection still exists
+- `response_data.message` (string): Human-readable message about the action taken
+
 ### Trading
 
 #### `placeOrder(order)`