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

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

@@ -0,0 +1,80 @@
+/**
+ * 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 a more specific classification to the `activity_type`.
+ * This field is optional and may not always be populated, depending on the activity type and the available data.
+ * Each `activity_type` has a set of valid `activity_sub_type` values.
+ *
+ * Full mapping of `activity_type` to `activity_sub_type`:
+ *
+ * - **DIV**: Dividend activity sub-types:
+ *   - **CDIV**: Cash Dividend
+ *   - **SDIV**: Stock Dividend
+ *   - **SPD**: Substitute Payment In Lieu Of Dividend
+ *
+ * - **FEE**: Fee-related activity sub-types:
+ *   - **REG**: Regulatory Fee
+ *   - **TAF**: Trading Activity Fee
+ *   - **LCT**: Local Currency Trading Fee
+ *   - **ORF**: Options Regulatory Fee
+ *   - **OCC**: Options Clearing Corporation Fee
+ *   - **NRC**: Non-Retail Commission Fee
+ *   - **NRV**: Non-Retail Venue Fee
+ *   - **COM**: Commission
+ *   - **CAT**: Consolidated Audit Trail Fee
+ *
+ * - **INT**: Interest-related activity sub-types:
+ *   - **MGN**: Margin Interest
+ *   - **CDT**: Credit Interest
+ *   - **SWP**: Sweep Interest
+ *   - **QII**: Qualified Interest
+ *
+ * - **MA**: Merger and Acquisition activity sub-types:
+ *   - **CMA**: Cash Merger
+ *   - **SMA**: Stock Merger
+ *   - **SCMA**: Stock & Cash Merger
+ *
+ * - **NC**: Name Change activity sub types
+ *   - **SNC**: Symbol Name Change
+ *   - **CNC**: CUSIP Name Change
+ *   - **SCNC**: Symbol & CUSIP Name Change
+ *
+ * - **OPCA**: Option Corporate Action activity sub-types:
+ *   - **DIV.CDIV**: Cash Dividend
+ *   - **DIV.SDIV**: Stock Dividend
+ *   - **MA.CMA**: Cash Merger
+ *   - **MA.SMA**: Stock Merger
+ *   - **MA.SCMA**: Stock & Cash Merger
+ *   - **NC.CNC**: CUSIP Name Change
+ *   - **NC.SNC**: Symbol Name Change
+ *   - **NC.SCNC**: Symbol & CUSIP Name Change
+ *   - **SPIN**: Spin-off
+ *   - **SPLIT.FSPLIT**: Forward Stock Split
+ *   - **SPLIT.RSPLIT**: Reverse Stock Split
+ *   - **SPLIT.USPLIT**: Unit Split
+ *
+ * - **REORG**: Reorganization activity sub-types:
+ *   - **WRM**: Worthless Removal
+ *
+ * - **SPLIT**: Stock Split activity sub-types:
+ *   - **FSPLIT**: Forward Stock Split
+ *   - **RSPLIT**: Reverse Stock Split
+ *   - **USPLIT**: Unit Split
+ *
+ * - **VOF**: Voluntary Offering activity sub-types:
+ *   - **VTND**: Tender Offer
+ *   - **VWRT**: Warrant Exercise
+ *   - **VRGT**: Rights Offer
+ *   - **VEXH**: Exchange Offer
+ *
+ * - **WH**: Withholding activity sub-types:
+ *   - **SWH**: State Withholding
+ *   - **FWH**: Federal Withholding
+ *   - **SLWH**: Sales Withholding
+ */
+export type ActivitySubType = string;

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

@@ -0,0 +1,103 @@
+/**
+ * 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 various kinds of activity.
+ *
+ * TradeActivity's will always have the type `FILL`
+ *
+ * - **FILL**
+ *   Order Fills (Partial/Full)
+ * - **ACATC**
+ *   ACATS IN/OUT (Cash)
+ * - **ACATS**
+ *   ACATS IN/OUT (Securities)
+ * - **CGD**
+ *   Capital Gain Distribution
+ * - **CIL**
+ *   Cash in Lieu of Stock
+ * - **CSD**
+ *   Cash Disbursement (+)
+ * - **CSW**
+ *   Cash Withdrawable
+ * - **DIV**
+ *   Dividend
+ * - **DIVCGL**
+ *   Dividend (Capital Gain Long Term)
+ * - **DIVCGS**
+ *   Dividend (Capital Gain Short Term)
+ * - **DIVNRA**
+ *   Dividend Adjusted (NRA Withheld)
+ * - **DIVROC**
+ *   Dividend Return of Capital
+ * - **DIVTXEX**
+ *   Dividend (Tax Exempt)
+ * - **FEE**
+ *   REG and TAF Fees
+ * - **INT**
+ *   Interest (Credit/Margin)
+ * - **JNLC**
+ *   Journal Entry (Cash)
+ * - **JNLS**
+ *   Journal Entry (Stock)
+ * - **OPASN**
+ *    Option Assignment
+ * - **OPCA**
+ *   Option Corporate Action
+ * - **OPCSH**
+ *    Option cash deliverable for non-standard contracts
+ * - **OPEXC**
+ *   Option Exercise
+ * - **OPEXP**
+ *   Option Expiration
+ * - **OPTRD**
+ *   Option Trade
+ * - **MA**
+ *   Merger/Acquisition
+ * - **PTC**
+ *   Pass Thru Change
+ * - **REORG**
+ *   Reorg CA
+ * - **SPIN**
+ *   Stock Spinoff
+ * - **SPLIT**
+ *   Stock Split
+ * - **FOPT**
+ *   Free of Payment Transfers
+ */
+export type ActivityType = typeof ActivityType[keyof typeof ActivityType];
+export declare const ActivityType: {
+    readonly FILL: "FILL";
+    readonly ACATC: "ACATC";
+    readonly ACATS: "ACATS";
+    readonly CGD: "CGD";
+    readonly CIL: "CIL";
+    readonly CSD: "CSD";
+    readonly CSW: "CSW";
+    readonly DIV: "DIV";
+    readonly DIVCGL: "DIVCGL";
+    readonly DIVCGS: "DIVCGS";
+    readonly DIVNRA: "DIVNRA";
+    readonly DIVROC: "DIVROC";
+    readonly DIVTXEX: "DIVTXEX";
+    readonly FEE: "FEE";
+    readonly INT: "INT";
+    readonly JNLC: "JNLC";
+    readonly JNLS: "JNLS";
+    readonly MA: "MA";
+    readonly OPASN: "OPASN";
+    readonly OPCA: "OPCA";
+    readonly OPCSH: "OPCSH";
+    readonly OPEXC: "OPEXC";
+    readonly OPEXP: "OPEXP";
+    readonly OPTRD: "OPTRD";
+    readonly PTC: "PTC";
+    readonly REORG: "REORG";
+    readonly SPIN: "SPIN";
+    readonly SPLIT: "SPLIT";
+    readonly FOPT: "FOPT";
+};

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

@@ -0,0 +1,44 @@
+/**
+ * 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 { AcatcActivityV2 } from './acatcActivityV2.js';
+import type { AcatsActivityV2 } from './acatsActivityV2.js';
+import type { CDIVActivityV2 } from './cDIVActivityV2.js';
+import type { CSWActivityV2 } from './cSWActivityV2.js';
+import type { DIVNRAActivityV2 } from './dIVNRAActivityV2.js';
+import type { DIVSPDActivityV2 } from './dIVSPDActivityV2.js';
+import type { ExchangeOfferActivityV2 } from './exchangeOfferActivityV2.js';
+import type { FEEActivityV2 } from './fEEActivityV2.js';
+import type { FixedIncomeRedemptionActivityV2 } from './fixedIncomeRedemptionActivityV2.js';
+import type { FOPTActivityV2 } from './fOPTActivityV2.js';
+import type { ForwardSplitActivityV2 } from './forwardSplitActivityV2.js';
+import type { JNLCActivityV2 } from './jNLCActivityV2.js';
+import type { JNLSActivityV2 } from './jNLSActivityV2.js';
+import type { MAActivityV2 } from './mAActivityV2.js';
+import type { NCActivityV2 } from './nCActivityV2.js';
+import type { OPASNActivityV2 } from './oPASNActivityV2.js';
+import type { OpcaCDIVActivityV2 } from './opcaCDIVActivityV2.js';
+import type { OpcaFSPLITActivityV2 } from './opcaFSPLITActivityV2.js';
+import type { OpcaMAActivityV2 } from './opcaMAActivityV2.js';
+import type { OpcaNCActivityV2 } from './opcaNCActivityV2.js';
+import type { OpcaRSPLITActivityV2 } from './opcaRSPLITActivityV2.js';
+import type { OpcaSDIVActivityV2 } from './opcaSDIVActivityV2.js';
+import type { OpcaSPINActivityV2 } from './opcaSPINActivityV2.js';
+import type { OpcaUSPLITActivityV2 } from './opcaUSPLITActivityV2.js';
+import type { OPEXCActivityV2 } from './oPEXCActivityV2.js';
+import type { OPEXPActivityV2 } from './oPEXPActivityV2.js';
+import type { OPTRDActivityV2 } from './oPTRDActivityV2.js';
+import type { ReverseSplitActivityV2 } from './reverseSplitActivityV2.js';
+import type { RightsDistributionActivityV2 } from './rightsDistributionActivityV2.js';
+import type { RightsSubscriptionElectionActivityV2 } from './rightsSubscriptionElectionActivityV2.js';
+import type { SDIVActivityV2 } from './sDIVActivityV2.js';
+import type { SpinoffActivityV2 } from './spinoffActivityV2.js';
+import type { TenderOfferActivityV2 } from './tenderOfferActivityV2.js';
+import type { UnitSplitActivityV2 } from './unitSplitActivityV2.js';
+import type { WarrantExerciseElectionActivityV2 } from './warrantExerciseElectionActivityV2.js';
+import type { WRMActivityV2 } from './wRMActivityV2.js';
+export type ActivityV2DetailNTA = (DIVSPDActivityV2 | CDIVActivityV2 | SDIVActivityV2 | ForwardSplitActivityV2 | ReverseSplitActivityV2 | UnitSplitActivityV2 | SpinoffActivityV2 | MAActivityV2 | NCActivityV2 | FixedIncomeRedemptionActivityV2 | RightsDistributionActivityV2 | RightsSubscriptionElectionActivityV2 | TenderOfferActivityV2 | ExchangeOfferActivityV2 | WarrantExerciseElectionActivityV2 | WRMActivityV2 | OpcaCDIVActivityV2 | OpcaSDIVActivityV2 | OpcaMAActivityV2 | OpcaNCActivityV2 | OpcaSPINActivityV2 | OpcaFSPLITActivityV2 | OpcaRSPLITActivityV2 | OpcaUSPLITActivityV2 | OPASNActivityV2 | OPEXCActivityV2 | OPEXPActivityV2 | OPTRDActivityV2 | AcatsActivityV2 | AcatcActivityV2 | FOPTActivityV2 | DIVNRAActivityV2 | JNLSActivityV2 | JNLCActivityV2 | CSWActivityV2 | FEEActivityV2);

package/dist/generated/broker/model/activityV2DetailTRD.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 { 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/broker/model/activityV2DetailTRDExecutionType.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
+ */
+/**
+ * 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/broker/model/activityV2DetailTRDSide.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
+ */
+/**
+ * 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/broker/model/adminActionBelongsTo.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
+ */
+import type { AdminActionBelongsToKind } from './adminActionBelongsToKind.js';
+/**
+ * Represents structure of an Identifier for all AdminAction type
+ */
+export interface AdminActionBelongsTo {
+    id_reference?: string;
+    kind?: AdminActionBelongsToKind;
+}

package/dist/generated/broker/model/adminActionBelongsToKind.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 AdminActionBelongsToKind = typeof AdminActionBelongsToKind[keyof typeof AdminActionBelongsToKind];
+export declare const AdminActionBelongsToKind: {
+    readonly account: "account";
+    readonly owner: "owner";
+    readonly correspondent: "correspondent";
+};

package/dist/generated/broker/model/adminActionCategory.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
+ */
+/**
+ * Category of the Admin Action
+ */
+export type AdminActionCategory = typeof AdminActionCategory[keyof typeof AdminActionCategory];
+export declare const AdminActionCategory: {
+    readonly order: "order";
+    readonly other: "other";
+};

package/dist/generated/broker/model/adminActionCreatedBy.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
+ */
+import type { AdminActionCreatedByKind } from './adminActionCreatedByKind.js';
+/**
+ * Represents structure of an Creator's Identifier for all AdminAction type
+ */
+export interface AdminActionCreatedBy {
+    id_reference?: string;
+    kind?: AdminActionCreatedByKind;
+}

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

@@ -0,0 +1,11 @@
+/**
+ * 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 AdminActionCreatedByKind = typeof AdminActionCreatedByKind[keyof typeof AdminActionCreatedByKind];
+export declare const AdminActionCreatedByKind: {
+    readonly admin: "admin";
+};

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

@@ -0,0 +1,32 @@
+/**
+ * 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 { AdminActionBelongsTo } from './adminActionBelongsTo.js';
+import type { AdminActionCategory } from './adminActionCategory.js';
+import type { AdminActionCreatedBy } from './adminActionCreatedBy.js';
+import type { AdminActionType } from './adminActionType.js';
+import type { AdminActionVisibility } from './adminActionVisibility.js';
+/**
+ * Represents general fields for all AdminAction type
+ */
+export interface AdminActionEventGeneral {
+    /** Timestamp of event */
+    at: string;
+    belongs_to: AdminActionBelongsTo;
+    category: AdminActionCategory;
+    /** Related correspondent */
+    correspondent: string;
+    created_by: AdminActionCreatedBy;
+    /** Lexically sortable, monotonically increasing character array */
+    event_id: string;
+    /** Free text form description of the admin action */
+    note: string;
+    /** Id of the replaced event (optional) */
+    replaces_event_id?: string;
+    type: AdminActionType;
+    visibility: AdminActionVisibility;
+}

package/dist/generated/broker/model/adminActionLegacyNote.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
+ */
+import type { AdminActionEventGeneral } from './adminActionEventGeneral.js';
+/**
+ * Represents structure of a LegacyNote type AdminAction
+ */
+export type AdminActionLegacyNote = AdminActionEventGeneral & {
+    /** Variable schema type which depends on the type */
+    context: {
+        [key: string]: unknown;
+    };
+};

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

@@ -0,0 +1,21 @@
+/**
+ * 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 { AdminActionEventGeneral } from './adminActionEventGeneral.js';
+/**
+ * Represents structure of a Liquidation type AdminAction
+ */
+export type AdminActionLiquidation = AdminActionEventGeneral & {
+    /** Variable schema type which depends on the type */
+    context: {
+        available_qty?: string;
+        error?: string;
+        reason?: string;
+        requested_qty?: string;
+        symbol?: string;
+    };
+};

package/dist/generated/broker/model/adminActionTransactionCancel.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 { AdminActionEventGeneral } from './adminActionEventGeneral.js';
+/**
+ * Represents structure of a TransactionCancel type AdminAction
+ */
+export type AdminActionTransactionCancel = AdminActionEventGeneral & {
+    /** Variable schema type which depends on the type */
+    context: {
+        entry_type?: string;
+        external_id?: string;
+        transaction_id?: string;
+    };
+};

package/dist/generated/broker/model/adminActionType.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
+ */
+/**
+ * Type of the Admin Action
+ */
+export type AdminActionType = typeof AdminActionType[keyof typeof AdminActionType];
+export declare const AdminActionType: {
+    readonly liquidation_admin_event: "liquidation_admin_event";
+    readonly legacy_note_admin_event: "legacy_note_admin_event";
+    readonly transaction_cancel_admin_event: "transaction_cancel_admin_event";
+};

package/dist/generated/broker/model/adminActionVisibility.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
+ */
+/**
+ * Visibility of the Admin Action
+ */
+export type AdminActionVisibility = typeof AdminActionVisibility[keyof typeof AdminActionVisibility];
+export declare const AdminActionVisibility: {
+    readonly internal: "internal";
+    readonly external: "external";
+    readonly correspondent_only: "correspondent_only";
+};

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

@@ -0,0 +1,82 @@
+/**
+ * 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 { AdminConfigurationsMaxMarginMultiplier } from './adminConfigurationsMaxMarginMultiplier.js';
+import type { AdminConfigurationsMaxOptionsTradingLevel } from './adminConfigurationsMaxOptionsTradingLevel.js';
+import type { RestrictToLiquidationReasons } from './restrictToLiquidationReasons.js';
+/**
+ * These configurations show account properties that are overriden either by Alpaca Broker Operations or an automated process.
+ *
+ * These values cannot be modified by the Broker Partners.
+ *
+ *
+ * For the **events** interface we are only broadcasting changes to admin configurations. In case nothing changed for a flag that will not be included in unrelated update events.
+ *
+ * Depending on the type of the Admin Configurations the sent event will behave differently. For bool flags we are only sending the new value.
+ *
+ * For example the following payload means, that the disable_shorting flag was set to true from false:
+ *
+ * ```
+ * {
+ *   "disable_shorting": false
+ * }
+ * ```
+ *
+ * For other data types, we are embeding the old and new values into the payload. For example changing the max_margin_multiplier from 4 to 1 will yield this payload:
+ *
+ * ```
+ * {
+ *   "max_margin_multiplier": {
+ *     "old": 4,
+ *     "new": 1,
+ *   }
+ * }
+ * ```
+ *
+ * Introducing an override value from the default will yield a null value as old. For example restricting the max_margin_multipler to 1 from default will yield the following payload:
+ *
+ * ```
+ * {
+ *   "max_margin_multiplier": {
+ *     "old": null,
+ *     "new": 1,
+ *   }
+ * }
+ * ```
+ */
+export interface AdminConfigurations {
+    /** Override the correspondent level daily transfer limits */
+    acct_daily_transfer_limit?: string;
+    /** If true, the account is allowed to perform instant ACH */
+    allow_instant_ach?: boolean;
+    /** If true, the account is allowed to access algo dash */
+    disable_algodash_access?: boolean;
+    /** If true, the account's API key will be disabled */
+    disable_api_key?: boolean;
+    /** If true, the account is not allowed to trade cryptos */
+    disable_crypto?: boolean;
+    /** If true, the account is not allowed to day trade (e.g. buy and sell the same security on the same day) */
+    disable_day_trading?: boolean;
+    /** If true, the account cannot create orders for fractional share positions */
+    disable_fractional?: boolean;
+    /** If true the account is not allowed to create short position orders */
+    disable_shorting?: boolean;
+    /** If true, incoming transfers to this account are rejected */
+    incoming_transfers_blocked?: boolean;
+    /** Max margin multipler is set by admin to this value */
+    max_margin_multiplier?: AdminConfigurationsMaxMarginMultiplier;
+    /** Max options trading level is set by admin to this value. It can be 0, 1 or 2. */
+    max_options_trading_level?: AdminConfigurationsMaxOptionsTradingLevel;
+    /** If true, outgoing transfers from this account are rejected */
+    outgoing_transfers_blocked?: boolean;
+    /**
+       * PDT check mode
+       * @deprecated
+       */
+    pdt_check_mode?: string;
+    restrict_to_liquidation_reasons?: RestrictToLiquidationReasons;
+}

package/dist/generated/broker/model/adminConfigurationsMaxMarginMultiplier.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
+ */
+/**
+ * Max margin multipler is set by admin to this value
+ */
+export type AdminConfigurationsMaxMarginMultiplier = {
+    /** Old value of margin multiplier */
+    from?: string;
+    /** New value of margin multiplier */
+    to?: string;
+};

package/dist/generated/broker/model/adminConfigurationsMaxOptionsTradingLevel.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
+ */
+/**
+ * Max options trading level is set by admin to this value. It can be 0, 1 or 2.
+ */
+export type AdminConfigurationsMaxOptionsTradingLevel = {
+    /** New value of max options trading level */
+    from?: string;
+    /** New value of max options trading level */
+    to?: string;
+};

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

@@ -0,0 +1,11 @@
+/**
+ * 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
+ */
+/**
+ * The response will include only ones submitted after this timestamp (exclusive)
+ */
+export type AfterParameter = string;

package/dist/generated/broker/model/aggregatePositionResponse.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
+ */
+import type { AssetClass } from './assetClass.js';
+export interface AggregatePositionResponse {
+    asset_type?: AssetClass;
+    /** EOD asset price per share at session close */
+    closing_price?: string;
+    /** Cusip (9 digits, can start with 0's) */
+    cusip?: string;
+    /** Aggregate notional dollar amount of the partner's long positions */
+    long_market_value?: string;
+    /** Aggregate number of shares that the partner is long */
+    long_qty?: string;
+    /** Number of accounts that have a position in this asset (either long or short) */
+    num_accounts?: number;
+    /** Aggregate notional dollar amount of the partner's short positions */
+    short_market_value?: string;
+    /** Aggregate number of shares that the partner is short */
+    short_qty?: string;
+    /** Symbol of asset */
+    symbol?: string;
+}