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

package/dist/generated/trading/model/activityV2DetailTRD.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { ActivityV2DetailTRDExecutionType } from './activityV2DetailTRDExecutionType.js';
+import type { ActivityV2DetailTRDSide } from './activityV2DetailTRDSide.js';
+/**
+ * Activity details for a fill or partial_fill event
+ */
+export interface ActivityV2DetailTRD {
+    /** Asset ID (For options this represents the option contract ID) */
+    asset_id: string;
+    /** Order ID provided by the customer */
+    client_order_id?: string;
+    /** Commission to collect from the account holder */
+    commission?: string;
+    /** Total filled quantity on the order */
+    cum_qty: string;
+    /** CUSIP of the security involved with the activity */
+    cusip?: string;
+    /** The execution type */
+    execution_type: ActivityV2DetailTRDExecutionType;
+    /** Unfilled quantity on the order, when order is filled value could be 0 */
+    leaves_qty: string;
+    /** Order ID generated by Alpaca */
+    order_id: string;
+    /** Identifies the current status of the order */
+    order_status: string;
+    /** Represents what side of the transaction an order was on */
+    side: ActivityV2DetailTRDSide;
+    /** The symbol of the security involved with the activity */
+    symbol: string;
+}

package/dist/generated/trading/model/activityV2DetailTRDExecutionType.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * The execution type
+ */
+export type ActivityV2DetailTRDExecutionType = typeof ActivityV2DetailTRDExecutionType[keyof typeof ActivityV2DetailTRDExecutionType];
+export declare const ActivityV2DetailTRDExecutionType: {
+    readonly fill: "fill";
+    readonly trade_correct: "trade_correct";
+    readonly trade_bust: "trade_bust";
+};

package/dist/generated/trading/model/activityV2DetailTRDSide.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * Represents what side of the transaction an order was on
+ */
+export type ActivityV2DetailTRDSide = typeof ActivityV2DetailTRDSide[keyof typeof ActivityV2DetailTRDSide];
+export declare const ActivityV2DetailTRDSide: {
+    readonly buy: "buy";
+    readonly sell: "sell";
+};

package/dist/generated/trading/model/addAssetToWatchlistBody.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export type AddAssetToWatchlistBody = {
+    /** the symbol name to add to the watchlist */
+    symbol?: string;
+};

package/dist/generated/trading/model/addAssetToWatchlistByNameBody.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export type AddAssetToWatchlistByNameBody = {
+    /** the symbol name to add to the watchlist */
+    symbol?: string;
+};

package/dist/generated/trading/model/addAssetToWatchlistByNameParams.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export type AddAssetToWatchlistByNameParams = {
+    /**
+     * name of the watchlist
+     */
+    name: string;
+};

package/dist/generated/trading/model/advancedInstructions.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { AdvancedInstructionsAlgorithm } from './advancedInstructionsAlgorithm.js';
+import type { AdvancedInstructionsDestination } from './advancedInstructionsDestination.js';
+/**
+ * Advanced instructions for Elite Smart Router: https://docs.alpaca.markets/docs/alpaca-elite-smart-router
+ */
+export interface AdvancedInstructions {
+    /** The advanced routing algorithm to use for the order */
+    algorithm?: AdvancedInstructionsAlgorithm;
+    /** Target exchange for order execution */
+    destination?: AdvancedInstructionsDestination;
+    /** Maximum shares/contracts displayed on the exchange at any time. Must be in round lot increments */
+    display_qty?: string;
+    /** When the algorithm is to be done executing. Must be within current market trading hours */
+    end_time?: string;
+    /** Maximum percentage of the ticker's period volume this order might participate in. Must be 0 < max_percentage < 1, with up to 3 decimal points precision. */
+    max_percentage?: string;
+    /** When the algorithm is to start executing. Must be within current market trading hours */
+    start_time?: string;
+}

package/dist/generated/trading/model/advancedInstructionsAlgorithm.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * The advanced routing algorithm to use for the order
+ */
+export type AdvancedInstructionsAlgorithm = typeof AdvancedInstructionsAlgorithm[keyof typeof AdvancedInstructionsAlgorithm];
+export declare const AdvancedInstructionsAlgorithm: {
+    readonly DMA: "DMA";
+    readonly TWAP: "TWAP";
+    readonly VWAP: "VWAP";
+};

package/dist/generated/trading/model/advancedInstructionsDestination.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * Target exchange for order execution
+ */
+export type AdvancedInstructionsDestination = typeof AdvancedInstructionsDestination[keyof typeof AdvancedInstructionsDestination];
+export declare const AdvancedInstructionsDestination: {
+    readonly NYSE: "NYSE";
+    readonly NASDAQ: "NASDAQ";
+    readonly ARCA: "ARCA";
+};

package/dist/generated/trading/model/assetClass.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * This represents the category to which the asset belongs to. It serves to identify the nature of the financial instrument, with options including "us_equity" for U.S. equities, "us_option" for U.S. options, "crypto" for cryptocurrencies, and "ipo" for IPO indications of interest/orders. This `asset_class: ipo` value is distinct from the assets API `attributes: ["ipo"]` flag.
+ */
+export type AssetClass = typeof AssetClass[keyof typeof AssetClass];
+export declare const AssetClass: {
+    readonly us_equity: "us_equity";
+    readonly us_option: "us_option";
+    readonly crypto: "crypto";
+    readonly ipo: "ipo";
+};

package/dist/generated/trading/model/assets.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { AssetClass } from './assetClass.js';
+import type { AssetsAttributesItem } from './assetsAttributesItem.js';
+import type { AssetsBorrowStatus } from './assetsBorrowStatus.js';
+import type { AssetsStatus } from './assetsStatus.js';
+import type { Exchange } from './exchange.js';
+/**
+ * The assets API serves as the master list of assets available for trade and data consumption from Alpaca. Assets are sorted by asset class, exchange and symbol. Some assets are only available for data consumption via Polygon, and are not tradable with Alpaca. These assets will be marked with the flag tradable=false.
+ */
+export interface Assets {
+    /**
+       * Unique characteristics of the asset. Supported values:
+       * - `ptp_no_exception`: Asset is a Publicly Traded Partnership (PTP) without a qualified notice; non-U.S. customers may incur 10% withholding on gross proceeds as per IRS guidance, and are blocked from being purchased by default.
+       * - `ptp_with_exception`: Users can open positions in these PTPs without general restrictions.
+       * - `ipo`: Accepting limit orders only before the stock begins trading on the secondary market.
+       * - `has_options`: The underlying equity has listed options available on the platform. Note: if the equity had inactive/expired contracts in the past, this will still show up.
+       * - `options_late_close`: Indicates the underlying asset's options contracts close at 4:15pm ET instead of the standard 4:00pm ET.
+       * - `fractional_eh_enabled`: Indicates the asset accepts fractional orders during extended hours sessions (pre-market, post-market, and overnight if enabled).
+       * - `overnight_tradable`: Asset is eligible for overnight (24x5) trading in supported venues on the platform.
+       * - `overnight_halted`: Asset is eligible for overnight trading but is currently halted/blocked for overnight sessions due to risk, corporate action, compliance, or venue constraints.
+       */
+    attributes?: AssetsAttributesItem[];
+    /** Borrow status for US equity assets. This field is omitted for non-US-equity assets. */
+    borrow_status?: AssetsBorrowStatus;
+    class: AssetClass;
+    /**
+       * The CUSIP identifier for the asset (US Equities only).
+       * To request a specific CUSIP, please reach out to Alpaca support.
+       * @nullable
+       */
+    cusip?: string | null;
+    /**
+       * **deprecated**: Please use borrow_status instead.
+       * Asset is easy-to-borrow or not (filtering for easy_to_borrow = True is the best way to check whether the name is currently available to short at Alpaca).
+       * @deprecated
+       */
+    easy_to_borrow: boolean;
+    exchange: Exchange;
+    /** Asset is fractionable or not */
+    fractionable: boolean;
+    /** Asset ID */
+    id: string;
+    /**
+       * **deprecated**: Please use margin_requirement_long or margin_requirement_short instead. Note that these fields are of type string.
+       * Shows the margin requirement percentage for the asset (equities only).
+       * @deprecated
+       */
+    maintenance_margin_requirement?: number;
+    /** The margin requirement percentage for the asset's long positions (equities only). */
+    margin_requirement_long?: string;
+    /** The margin requirement percentage for the asset's short positions (equities only). */
+    margin_requirement_short?: string;
+    /** Asset is marginable or not */
+    marginable: boolean;
+    /**
+       * The official name of the asset
+       * @minLength 1
+       */
+    name: string;
+    /** Asset is shortable or not */
+    shortable: boolean;
+    /** active or inactive */
+    status: AssetsStatus;
+    /** The symbol of the asset */
+    symbol: string;
+    /** Asset is tradable on Alpaca or not */
+    tradable: boolean;
+}

package/dist/generated/trading/model/assetsAttributesItem.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export type AssetsAttributesItem = typeof AssetsAttributesItem[keyof typeof AssetsAttributesItem];
+export declare const AssetsAttributesItem: {
+    readonly ptp_no_exception: "ptp_no_exception";
+    readonly ptp_with_exception: "ptp_with_exception";
+    readonly ipo: "ipo";
+    readonly has_options: "has_options";
+    readonly options_late_close: "options_late_close";
+    readonly fractional_eh_enabled: "fractional_eh_enabled";
+    readonly overnight_tradable: "overnight_tradable";
+    readonly overnight_halted: "overnight_halted";
+};

package/dist/generated/trading/model/assetsBorrowStatus.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * Borrow status for US equity assets. This field is omitted for non-US-equity assets.
+ */
+export type AssetsBorrowStatus = typeof AssetsBorrowStatus[keyof typeof AssetsBorrowStatus];
+export declare const AssetsBorrowStatus: {
+    readonly easy_to_borrow: "easy_to_borrow";
+    readonly hard_to_borrow: "hard_to_borrow";
+};

package/dist/generated/trading/model/assetsStatus.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * active or inactive
+ */
+export type AssetsStatus = typeof AssetsStatus[keyof typeof AssetsStatus];
+export declare const AssetsStatus: {
+    readonly active: "active";
+    readonly inactive: "inactive";
+};

package/dist/generated/trading/model/bic.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * Business Identifier Code (BIC/SWIFT).
+ * @minLength 11
+ * @maxLength 11
+ * @pattern ^[A-Z0-9]{11}$
+ */
+export type Bic = string;

package/dist/generated/trading/model/bondStatus.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * Status of the bond.
+ */
+export type BondStatus = typeof BondStatus[keyof typeof BondStatus];
+export declare const BondStatus: {
+    readonly outstanding: "outstanding";
+    readonly matured: "matured";
+    readonly pre_issuance: "pre_issuance";
+};

package/dist/generated/trading/model/cDIVActivityV2.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { CommonCaActivityV2 } from './commonCaActivityV2.js';
+import type { CommonCDIVActivityV2 } from './commonCDIVActivityV2.js';
+/**
+ * Cash dividend
+ */
+export type CDIVActivityV2 = CommonCaActivityV2 & CommonCDIVActivityV2 & {
+    /** Total cash amount paid */
+    cash_payout: string;
+    /** Quantity of shares entitled to receive the dividend */
+    entitled_qty: string;
+};

package/dist/generated/trading/model/cSWActivityV2.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { CommonNTAActivityV2 } from './commonNTAActivityV2.js';
+/**
+ * Cash withdrawal
+ */
+export type CSWActivityV2 = CommonNTAActivityV2 & {
+    /** The bank transaction's ID */
+    bank_transaction_id?: string;
+};

package/dist/generated/trading/model/calendarDay.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * A calendar day.
+ */
+export interface CalendarDay {
+    /** The end time of the core market session. */
+    core_end: string;
+    /** The start time of the core market session. */
+    core_start: string;
+    /** The date of the calendar day. */
+    date: string;
+    /** The end time of the lunch session. */
+    lunch_end?: string;
+    /** The start time of the lunch session. */
+    lunch_start?: string;
+    /** The end time of the after-hours session. */
+    post_end?: string;
+    /** The start time of the after-hours session. */
+    post_start?: string;
+    /** The end time of the pre-market session. */
+    pre_end?: string;
+    /** The start time of the pre-market session. */
+    pre_start?: string;
+    /** The settlement date. */
+    settlement_date?: string;
+}

package/dist/generated/trading/model/calendarParams.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { EndParameter } from './endParameter.js';
+import type { StartParameter } from './startParameter.js';
+import type { TimezoneParameter } from './timezoneParameter.js';
+export type CalendarParams = {
+    /**
+     * The first date to retrieve data for (inclusive). Default: today.
+     */
+    start?: StartParameter;
+    /**
+     * The last date to retrieve data for (inclusive). Default: one week from the start date.
+     */
+    end?: EndParameter;
+    /**
+     * Timezone of the times. Default: the timezone of the market.
+     */
+    timezone?: TimezoneParameter;
+};

package/dist/generated/trading/model/callType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * The type of call on the bond refers to one of a variety of circumstances under which a callable bond may be called.
+ */
+export type CallType = typeof CallType[keyof typeof CallType];
+export declare const CallType: {
+    readonly ordinary: "ordinary";
+    readonly make_whole: "make_whole";
+    readonly regulatory: "regulatory";
+    readonly special: "special";
+};

package/dist/generated/trading/model/canceledOrderResponse.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+/**
+ * Represents the result of a request to cancel and order
+ */
+export interface CanceledOrderResponse {
+    /** orderId */
+    id?: string;
+    /** http response code */
+    status?: number;
+}

package/dist/generated/trading/model/clock.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { Phase } from './phase.js';
+import type { PublicMarket } from './publicMarket.js';
+export interface Clock {
+    /** Whether the clock is on a market day. */
+    is_market_day: boolean;
+    market: PublicMarket;
+    /** Next market close timestamp */
+    next_market_close: string;
+    /** Next market open timestamp */
+    next_market_open: string;
+    phase: Phase;
+    /** The end of the current phase. */
+    phase_until: string;
+    /** The time on the clock. */
+    timestamp: string;
+}

package/dist/generated/trading/model/clockParams.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { MarketsParameter } from './marketsParameter.js';
+import type { TimeParameter } from './timeParameter.js';
+export type ClockParams = {
+    /**
+     * Comma-separated list of markets. Available market codes by region:
+     *
+     * **United States**
+     * - `BMO`: Bank of Montreal. US banking calendar (US operations).
+     * - `BNYM`: The Bank of New York Mellon. US banking calendar.
+     * - `BOATS`: Blue Ocean Alternative Trading System. US overnight trading.
+     * - `IEX`: Investors Exchange. US equities.
+     * - `IEXG`: Investors Exchange. US equities.
+     * - `NASDAQ`: National Association of Securities Dealers Automated Quotations. US equities.
+     * - `NYSE`: New York Stock Exchange. US equities.
+     * - `OCEA`: BlueOcean ATS. US overnight trading.
+     * - `OPRA`: Options Price Reporting Authority. US options.
+     * - `OTC`: Over-The-Counter. US OTC equities.
+     * - `OTCM`: OTC Markets. US OTC equities.
+     * - `SIFMA`: Securities Industry and Financial Markets Association. US bonds.
+     * - `XNAS`: NASDAQ. US equities.
+     * - `XNYS`: New York Stock Exchange. US equities.
+     *
+     * **Europe**
+     * - `CEUX`: Cboe CEUX Europe. European equities (Cboe Netherlands).
+     * - `CHIX`: Cboe CHIX Europe. European equities (Cboe UK).
+     * - `ISE`: Euronext Dublin. Irish equities.
+     * - `LSE`: London Stock Exchange. UK equities.
+     * - `MTA`: Euronext Milan. Italian equities.
+     * - `MTAA`: Euronext Milan. Italian equities.
+     * - `XAMS`: Euronext Amsterdam. Dutch equities.
+     * - `XBRU`: Euronext Brussels. Belgian equities.
+     * - `XDUB`: Euronext Dublin. Irish equities.
+     * - `XETR`: Frankfurt Stock Exchange. German equities.
+     * - `XETRA`: Frankfurt Stock Exchange. German equities.
+     * - `XLIS`: Euronext Lisbon. Portuguese equities.
+     * - `XLON`: London Stock Exchange. UK equities.
+     * - `XPAR`: Euronext Paris. French equities.
+     *
+     * **Asia & Middle East**
+     * - `HKEX`: Hong Kong Stock Exchange. Hong Kong equities.
+     * - `JPX`: Japan Exchange Group. Japanese equities.
+     * - `TADAWUL`: Saudi Stock Exchange. Saudi equities.
+     * - `XHKG`: Hong Kong Stock Exchange. Hong Kong equities.
+     * - `XSAU`: Saudi Stock Exchange. Saudi equities.
+     * - `XTKS`: Japan Exchange Group. Japanese equities.
+     */
+    markets?: MarketsParameter;
+    /**
+     * Instead of the current time, use this time for the clock.
+     */
+    time?: TimeParameter;
+};

package/dist/generated/trading/model/clockResp.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { Clock } from './clock.js';
+/**
+ * Clock response.
+ */
+export interface ClockResp {
+    clocks: Clock[];
+}

package/dist/generated/trading/model/commonAcatActivityV2.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export interface CommonAcatActivityV2 {
+    /** The ID that DTCC assigned to this transfer */
+    external_id: string;
+    /**
+       * Hold date when the transfers settle
+       * @minLength 1
+       */
+    hold_date?: string;
+    /** The ID for original ACATS request */
+    request_id: string;
+}

package/dist/generated/trading/model/commonCDIVActivityV2.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+export interface CommonCDIVActivityV2 {
+    /** 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;
+    /**
+       * 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;
+    /** Dividend rate 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;
+}

package/dist/generated/trading/model/commonCaActivityV2.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Trading API
+ * Alpaca's Trading API is a modern platform for algorithmic trading.
+ * OpenAPI spec version: 2.0.1
+ */
+import type { CommonNTAActivityV2 } from './commonNTAActivityV2.js';
+export type CommonCaActivityV2 = CommonNTAActivityV2 & {
+    /** The unique identifier for this corporate action */
+    ca_id?: string;
+    /**
+       * The position_date for this corporate action
+       * @minLength 1
+       */
+    position_date: string;
+    /** The reorg identifier, if present in the source corporate action definition */
+    reorg_id?: string;
+};