@alpaca-open-api/core 0.1.0-rc.0

package/dist/generated/broker/model/createFundingWalletRecipientBankBody.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { CreateFundingWalletRecipientBankBodyAccountType } from './createFundingWalletRecipientBankBodyAccountType.js';
+import type { CreateFundingWalletRecipientBankBodyRoutingCodeType } from './createFundingWalletRecipientBankBodyRoutingCodeType.js';
+export type CreateFundingWalletRecipientBankBody = {
+    /** Bank account number. */
+    account_number: string;
+    /** Bank account type. */
+    account_type?: CreateFundingWalletRecipientBankBodyAccountType;
+    /** Bank account holder's name. */
+    bank_account_holder_name?: string;
+    /** Two-letter code for the country in which the beneficiary's bank account is held. */
+    bank_country: string;
+    bank_name: string;
+    /** BIC/SWIFT code */
+    bic_swift?: string;
+    /** City */
+    city: string;
+    /** Currency in which money is held in the beneficiary's bank account. ISO-3 currency code. */
+    currency: string;
+    /** IBAN code */
+    iban?: string;
+    /** Postal code */
+    postal_code?: string;
+    /** Routing code for routing_code_type. If supplied, routing_code_type should also be supplied. */
+    routing_code?: string;
+    /** Local payment routing system. If supplied, routing_code should also be supplied. */
+    routing_code_type?: CreateFundingWalletRecipientBankBodyRoutingCodeType;
+    /** State or province. */
+    state_or_province?: string;
+    /** First line of address. */
+    street_address: string;
+};

package/dist/generated/broker/model/createFundingWalletRecipientBankBodyAccountType.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * Bank account type.
+ */
+export type CreateFundingWalletRecipientBankBodyAccountType = typeof CreateFundingWalletRecipientBankBodyAccountType[keyof typeof CreateFundingWalletRecipientBankBodyAccountType];
+export declare const CreateFundingWalletRecipientBankBodyAccountType: {
+    readonly checking: "checking";
+    readonly savings: "savings";
+};

package/dist/generated/broker/model/createFundingWalletRecipientBankBodyRoutingCodeType.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * Local payment routing system. If supplied, routing_code should also be supplied.
+ */
+export type CreateFundingWalletRecipientBankBodyRoutingCodeType = typeof CreateFundingWalletRecipientBankBodyRoutingCodeType[keyof typeof CreateFundingWalletRecipientBankBodyRoutingCodeType];
+export declare const CreateFundingWalletRecipientBankBodyRoutingCodeType: {
+    readonly sort_code: "sort_code";
+    readonly aba: "aba";
+    readonly bsb_code: "bsb_code";
+    readonly institution_no: "institution_no";
+    readonly bank_code: "bank_code";
+    readonly branch_code: "branch_code";
+    readonly clabe: "clabe";
+    readonly cnaps: "cnaps";
+    readonly ifsc: "ifsc";
+};

package/dist/generated/broker/model/createFundingWalletWithdrawalRequest.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { FundingDetailPaymentType } from './fundingDetailPaymentType.js';
+export interface CreateFundingWalletWithdrawalRequest {
+    desired_currency?: string;
+    payment_type?: FundingDetailPaymentType;
+    usd_amount?: string;
+}

package/dist/generated/broker/model/createIFTransferRequest.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * Request to create a new instant funding transfer
+ */
+export interface CreateIFTransferRequest {
+    account_no: string;
+    amount: string;
+    source_account_no: string;
+}

package/dist/generated/broker/model/createJITSettlementRequest.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { JITAssetClass } from './jITAssetClass.js';
+import type { SettlementAccount } from './settlementAccount.js';
+/**
+ * Request to create a new settlement. All transfers included must use the same source account, and the total amount received must be in the same currency as the base currency of the source account.
+ */
+export interface CreateJITSettlementRequest {
+    accounts: SettlementAccount[];
+    /** Additional remittance information. Include if the funding source may require additional information to associate to the source account or settlement. */
+    additional_info?: string;
+    asset_class: JITAssetClass;
+    /** The currency of the settlement. All accounts identified should have this base currency. */
+    currency: string;
+}

package/dist/generated/broker/model/createJournalRequest.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { JournalEntryType } from './journalEntryType.js';
+/**
+ * Journals API allows you to move cash or securities from one account to another.
+ *
+ * This model represents the fields you can specify when creating a Journal
+ *
+ * Fixture Rules
+ *
+ * - No Fixtures
+ *   - anything below limit is executed immediately
+ *   - anything above limit is pending until executed at EOD,
+ * - With Fixtures
+ *   - any status = rejected will be rejected EOD
+ *   - any status = pending will be pending forever
+ */
+export interface CreateJournalRequest {
+    /** Required if `entry_type` = `JNLC` */
+    amount?: string;
+    currency?: string;
+    /**
+       * Max 1024 characters. Can include fixtures for amounts that are above the transaction limit
+       * @maxLength 1024
+       */
+    description?: string;
+    entry_type: JournalEntryType;
+    /**
+       * The account_id you wish to journal from
+       * @minLength 1
+       */
+    from_account: string;
+    /** Required if `entry_type` = `JNLS` */
+    qty?: string;
+    /** Required if `entry_type` = `JNLS` */
+    symbol?: string;
+    /**
+       * The account_id you wish to journal to
+       * @minLength 1
+       */
+    to_account: string;
+    /**
+       * Max 255 characters. See more details about [Travel Rule](https://alpaca.markets/docs/broker/integration/funding/#travel-rule) in our main documentation.
+       * @maxLength 255
+       */
+    transmitter_account_number?: string;
+    /**
+       * Max 255 characters. See more details about [Travel Rule](https://alpaca.markets/docs/broker/integration/funding/#travel-rule) in our main documentation.
+       * @maxLength 255
+       */
+    transmitter_address?: string;
+    /**
+       * Max 255 characters. See more details about [Travel Rule](https://alpaca.markets/docs/broker/integration/funding/#travel-rule) in our main documentation.
+       * @maxLength 255
+       */
+    transmitter_financial_institution?: string;
+    /**
+       * Max 255 characters. See more details about [Travel Rule](https://alpaca.markets/docs/broker/integration/funding/#travel-rule) in our main documentation.
+       * @maxLength 255
+       */
+    transmitter_name?: string;
+    /** RFC 3339 format. See more details about [Travel Rule](https://alpaca.markets/docs/broker/integration/funding/#travel-rule) in our main documentation. */
+    transmitter_timestamp?: string;
+}

package/dist/generated/broker/model/createOrderRequest.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { CommissionType } from './commissionType.js';
+import type { CreateOrderRequestStopLoss } from './createOrderRequestStopLoss.js';
+import type { CreateOrderRequestTakeProfit } from './createOrderRequestTakeProfit.js';
+import type { MLegOrderLeg } from './mLegOrderLeg.js';
+import type { OrderClass } from './orderClass.js';
+import type { OrderSide } from './orderSide.js';
+import type { OrderType } from './orderType.js';
+import type { PositionIntent } from './positionIntent.js';
+import type { TimeInForce } from './timeInForce.js';
+export interface CreateOrderRequest {
+    /**
+       * A unique identifier for the order. Automatically generated if not sent. (<= 128 characters)
+       * @maxLength 128
+       */
+    client_order_id?: string;
+    /** The commission you want to collect from the user. */
+    commission?: string;
+    /**
+       * **deprecated**: Please use the commission_type = bps instead and set the desired bps value in the `commission` field.
+       * The percent commission you want to charge the end user on the order (expressed in bps). Alpaca will convert the order to a notional amount for purposes of calculating commission.
+       * @deprecated
+       */
+    commission_bps?: string;
+    commission_type?: CommissionType;
+    /** Defaults to false. If true, order will be eligible for execution in the pre-market, after-hours, and overnight sessions. Only works with type `limit` and time_in_force set to either `day` or `gtc`. */
+    extended_hours?: boolean;
+    instructions?: string;
+    /**
+       * list of order legs (<= 4)
+       * @maxItems 4
+       */
+    legs?: MLegOrderLeg[];
+    /**
+       * Required if type is `limit` or `stop_limit`.
+       * - In case of `mleg`, the limit_price parameter is expressed with the following notation:
+       *   - A positive value indicates a debit, representing a cost or payment to be made.
+       *   - A negative value signifies a credit, reflecting an amount to be received.
+       * - In case of Fied Income, the price is expressed in percentage of par value (face value).
+       * Price is always clean price, meaning it does not include accrued interest.
+       */
+    limit_price?: string;
+    /** Dollar amount to trade. Cannot work with qty. Only market and limit orders supported with time_in_force = day; Only limit orders for extended hours. */
+    notional?: string;
+    order_class?: OrderClass;
+    position_intent?: PositionIntent;
+    /**
+       * - For equities, the number of shares to trade. Can be fractionable for only market and day order types.
+       * - Required for `mleg` order class, represents the number of units to trade of this strategy.
+       * - For Fixed Income securities, qty represents the order size in par value (face value).
+       * For example, to place an order for 1 bond with a face value of $1,000, provide a qty of 1000.
+       */
+    qty?: string;
+    side?: OrderSide;
+    source?: string;
+    /** Takes in a string/number values for stop_price and limit_price */
+    stop_loss?: CreateOrderRequestStopLoss;
+    /** Required if type is stop or stop_limit */
+    stop_price?: string;
+    subtag?: string;
+    swap_fee_bps?: string;
+    /** Symbol or asset ID to identify the asset to trade. Required for all order classes except for `mleg`. */
+    symbol?: string;
+    /** Takes in a string/number value for limit_price */
+    take_profit?: CreateOrderRequestTakeProfit;
+    time_in_force: TimeInForce;
+    /** If type is trailing_stop, then one of trail_price or trail_percent is required */
+    trail_percent?: string;
+    /** If type is trailing_stop, then one of trail_price or trail_percent is required */
+    trail_price?: string;
+    type: OrderType;
+}

package/dist/generated/broker/model/createOrderRequestStopLoss.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * Takes in a string/number values for stop_price and limit_price
+ */
+export type CreateOrderRequestStopLoss = {
+    limit_price?: string;
+    stop_price?: string;
+};

package/dist/generated/broker/model/createOrderRequestTakeProfit.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * Takes in a string/number value for limit_price
+ */
+export type CreateOrderRequestTakeProfit = {
+    limit_price?: string;
+};

package/dist/generated/broker/model/createSettlementRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { SettlementTransfer } from './settlementTransfer.js';
+/**
+ * Request to create a new settlement. All transfers included must use the same source account, and the total amount received must be in the same currency as the base currency of the source account as well as the transmitter information.
+ */
+export interface CreateSettlementRequest {
+    /** Additional remittance information. Include if the funding source may require additional information to associate to the source account or settlement. */
+    additional_info?: string;
+    transfers: SettlementTransfer[];
+}

package/dist/generated/broker/model/createTransferRequest.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { CreateTransferRequestTiming } from './createTransferRequestTiming.js';
+import type { FeePaymentMethod } from './feePaymentMethod.js';
+import type { TransferDirection } from './transferDirection.js';
+import type { TransferIRA } from './transferIRA.js';
+import type { TransferType } from './transferType.js';
+/**
+ * [See main docs here](https://alpaca.markets/docs/api-references/broker-api/funding/transfers/#creating-a-transfer-entity)
+ */
+export interface CreateTransferRequest {
+    /**
+       * Additional details for when type = `wire`
+       * @nullable
+       */
+    additional_information?: string | null;
+    /** Must be > 0.00 */
+    amount: string;
+    /**
+       * Required if type = `wire`
+       *
+       * The bank_relationship created for the account_id [here](https://alpaca.markets/docs/api-references/broker-api/funding/bank/#creating-a-new-bank-relationship)
+       */
+    bank_id?: string;
+    direction: TransferDirection;
+    fee_payment_method?: FeePaymentMethod;
+    ira?: TransferIRA;
+    /**
+       * Required if type = `ach`
+       *
+       * The ach_relationship created for the account_id [here](https://alpaca.markets/docs/api-references/broker-api/funding/ach/#creating-an-ach-relationship)
+       */
+    relationship_id?: string;
+    /**
+       * Deprecated. Not honored by the API; values sent are silently ignored and this field will be removed.
+       * @deprecated
+       */
+    timing?: CreateTransferRequestTiming;
+    transfer_type: TransferType;
+}

package/dist/generated/broker/model/createTransferRequestTiming.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * Deprecated. Not honored by the API; values sent are silently ignored and this field will be removed.
+ * @deprecated
+ */
+export type CreateTransferRequestTiming = typeof CreateTransferRequestTiming[keyof typeof CreateTransferRequestTiming];
+export declare const CreateTransferRequestTiming: {
+    readonly immediate: "immediate";
+};

package/dist/generated/broker/model/createWatchlistRequest.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * This model represents the fields you can specify when Creating or Updating/Replacing a Watchlist
+ */
+export interface CreateWatchlistRequest {
+    /** The watchlist name */
+    name: string;
+    /** The new list of symbol names to watch */
+    symbols: string[];
+}

package/dist/generated/broker/model/createWhitelistedAddressBody.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { CreateWhitelistedAddressBodyChain } from './createWhitelistedAddressBodyChain.js';
+export type CreateWhitelistedAddressBody = {
+    /** The address to be whitelisted */
+    address?: string;
+    /** Symbol of underlying asset for the whitelisted address */
+    asset?: string;
+    /** Optional chain identifier. Use when the underlying asset for the whitelisted address is a multi-chain crypto asset. */
+    chain?: CreateWhitelistedAddressBodyChain;
+};

package/dist/generated/broker/model/createWhitelistedAddressBodyChain.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * Optional chain identifier. Use when the underlying asset for the whitelisted address is a multi-chain crypto asset.
+ */
+export type CreateWhitelistedAddressBodyChain = typeof CreateWhitelistedAddressBodyChain[keyof typeof CreateWhitelistedAddressBodyChain];
+export declare const CreateWhitelistedAddressBodyChain: {
+    readonly SOL: "SOL";
+    readonly ETH: "ETH";
+    readonly BTC: "BTC";
+    readonly XRP: "XRP";
+    readonly ARB: "ARB";
+};

package/dist/generated/broker/model/cryptoTransfer.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { CryptoTransferStatus } from './cryptoTransferStatus.js';
+import type { TransferDirection } from './transferDirection.js';
+/**
+ * Transfers allow you to transfer assets into your end customer's account (deposits) or out (withdrawal).
+ */
+export interface CryptoTransfer {
+    /** Amount of transfer denominated in the underlying crypto asset */
+    amount?: string;
+    /** Symbol of crypto asset for given transfer (e.g. BTC) */
+    asset?: string;
+    /** Underlying network for given transfer */
+    chain?: string;
+    /** Timestamp when transfer was created */
+    created_at?: string;
+    direction?: TransferDirection;
+    fees?: string;
+    /** Originating address of the transfer */
+    from_address?: string;
+    /** The crypto transfer ID */
+    id?: string;
+    network_fee?: string;
+    status?: CryptoTransferStatus;
+    /** Destination address of the transfer */
+    to_address?: string;
+    /** On-chain transaction hash (e.g. 0xabc...xyz) */
+    tx_hash?: string;
+    /** Equivalent USD value at time of transfer */
+    usd_value?: string;
+}

package/dist/generated/broker/model/cryptoTransferStatus.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export type CryptoTransferStatus = typeof CryptoTransferStatus[keyof typeof CryptoTransferStatus];
+export declare const CryptoTransferStatus: {
+    readonly PROCESSING: "PROCESSING";
+    readonly FAILED: "FAILED";
+    readonly COMPLETE: "COMPLETE";
+};

package/dist/generated/broker/model/cryptoWallet.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export interface CryptoWallet {
+    address?: string;
+    chain?: string;
+    /** Timestamp (RFC3339) of account creation. */
+    created_at?: string;
+}

package/dist/generated/broker/model/currency.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * "USD" // US Dollar
+ * "JPY" // Japanese Yen
+ * "EUR" // Euro
+ * "CAD" // Canadian Dollar
+ * "GBP" // British Pound Sterling
+ * "CHF" // Swiss Franc
+ * "TRY" // Turkish Lira
+ * "AUD" // Australian Dollar
+ * "CZK" // Czech Koruna
+ * "SEK" // Swedish Krona
+ * "DKK" // Danish Krone
+ * "SGD" // Singapore Dollar
+ * "HKD" // Hong Kong Dollar
+ * "HUF" // Hungarian Forint
+ * "NZD" // New Zealand Dollar
+ * "NOK" // Norwegian Krone
+ * "PLN" // Poland Złoty
+ */
+export type Currency = string;

package/dist/generated/broker/model/custodialAccountMinorIdentity.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { TaxIdType } from './taxIdType.js';
+/**
+ * Represents Identity information for a minor that an account of type "custodial" is for
+ */
+export interface CustodialAccountMinorIdentity {
+    country_of_birth?: string;
+    country_of_citizenship?: string;
+    country_of_tax_residence: string;
+    date_of_birth: string;
+    email: string;
+    family_name: string;
+    given_name: string;
+    state: string;
+    tax_id?: string;
+    tax_id_type?: TaxIdType;
+}

package/dist/generated/broker/model/custodialAccountType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * Represents the type of custodial account based on the state where the beneficiary resides.
+ * This value is returned only when the `country_of_tax_residence` is `USA`. For other countries, this property is not included in the response.
+ *
+ * **Possible Return Values**
+ *
+ * `CustodianTypeUTMA` - Indicates that the custodial account is governed by the Uniform Transfers to Minors Act.
+ * `CustodianTypeUGMA` - Indicates that the custodial account is governed by the Uniform Gifts to Minors Act.
+ */
+export type CustodialAccountType = string;

package/dist/generated/broker/model/dIVNRAActivityV2.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { CommonNTAActivityV2 } from './commonNTAActivityV2.js';
+/**
+ * Dividend withholding for non resident aliens
+ */
+export type DIVNRAActivityV2 = CommonNTAActivityV2 & {
+    /** The CUSIP of the security involved with the activity */
+    cusip: string;
+    /** The ref_id of the parent dividend */
+    parent_id: string;
+    /** The symbol of the security involved with the activity */
+    symbol: string;
+};

package/dist/generated/broker/model/dIVSPDActivityV2.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { CommonCaActivityV2 } from './commonCaActivityV2.js';
+/**
+ * Substitute payment in lieu of dividend
+ */
+export type DIVSPDActivityV2 = CommonCaActivityV2 & {
+    /** Total cash amount paid */
+    cash_payout: string;
+    /** The CUSIP of the security involved with the activity */
+    cusip: string;
+    /**
+       * When due bills stop applying for this event
+       * @minLength 1
+       */
+    due_bill_off_date?: string;
+    /**
+       * When due bills begin to apply for this event
+       * @minLength 1
+       */
+    due_bill_on_date?: string;
+    /** Quantity of shares entitled to receive cash in lieu */
+    entitled_qty: string;
+    /**
+       * The ex_date for this corporate action
+       * @minLength 1
+       */
+    ex_date?: string;
+    /** Indicates if related to a non-US security */
+    foreign: boolean;
+    /**
+       * The payable_date for this corporate action
+       * @minLength 1
+       */
+    payable_date?: string;
+    /** Cash payout per share */
+    rate: string;
+    /**
+       * The record_date for this corporate action
+       * @minLength 1
+       */
+    record_date?: string;
+    /** Indicates if this is a special dividend */
+    special: boolean;
+    /** The symbol of the security involved with the activity */
+    symbol: string;
+};