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

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

@@ -0,0 +1,34 @@
+/**
+ * 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 { ACHRelationshipBankAccountType } from './aCHRelationshipBankAccountType.js';
+import type { ACHRelationshipStatus } from './aCHRelationshipStatus.js';
+export interface ACHRelationship {
+    account_id: string;
+    /**
+       * Name of the account owner
+       * @minLength 1
+       */
+    account_owner_name: string;
+    /** @minLength 1 */
+    bank_account_number?: string;
+    /**
+       * Must be CHECKING or SAVINGS
+       * @minLength 1
+       */
+    bank_account_type?: ACHRelationshipBankAccountType;
+    /** @minLength 1 */
+    bank_routing_number?: string;
+    /** Format: 2020-01-01T01:01:01Z */
+    created_at: string;
+    id: string;
+    /** @minLength 1 */
+    nickname?: string;
+    status: ACHRelationshipStatus;
+    /** Format: 2020-01-01T01:01:01Z */
+    updated_at: string;
+}

package/dist/generated/broker/model/aCHRelationshipBankAccountType.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
+ */
+/**
+ * Must be CHECKING or SAVINGS
+ * @minLength 1
+ */
+export type ACHRelationshipBankAccountType = typeof ACHRelationshipBankAccountType[keyof typeof ACHRelationshipBankAccountType];
+export declare const ACHRelationshipBankAccountType: {
+    readonly CHECKING: "CHECKING";
+    readonly SAVINGS: "SAVINGS";
+};

package/dist/generated/broker/model/aCHRelationshipStatus.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
+ */
+export type ACHRelationshipStatus = typeof ACHRelationshipStatus[keyof typeof ACHRelationshipStatus];
+export declare const ACHRelationshipStatus: {
+    readonly QUEUED: "QUEUED";
+    readonly APPROVED: "APPROVED";
+    readonly REJECTED: "REJECTED";
+    readonly PENDING: "PENDING";
+    readonly CANCEL_REQUESTED: "CANCEL_REQUESTED";
+};

package/dist/generated/broker/model/aPRTier.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 { APRTierDetails } from './aPRTierDetails.js';
+export interface APRTier {
+    /** The annualized account interest rate, in basis points. */
+    account_rate_bps?: number;
+    /** The annualized correspondent fee rate, in basis points. */
+    correspondent_rate_bps?: number;
+    /** The timestamp the APR tier was created, in RFC 3339 format. */
+    created_at?: string;
+    /** The currency of the APR tier */
+    currency?: string;
+    details?: APRTierDetails;
+    /** The unique identifier of the APR tier */
+    id?: string;
+    /** True if this is the default APR tier. Only one APR tier can be default per currency. */
+    is_default?: boolean;
+    /** The unique name of the APR tier */
+    name?: string;
+    /** The timestamp of the last update to the APR tier, in RFC 3339 format. */
+    updated_at?: string;
+}

package/dist/generated/broker/model/aPRTierDetails.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
+ */
+/**
+ * Additional details of the APR tier
+ */
+export interface APRTierDetails {
+    /** The date on which the total balance was recorded, at the end of the day. YYYY-MM-DD format. */
+    as_of?: string;
+    /** The total number of accounts assigned this APR tier. */
+    total_accounts?: number;
+    /** The total balance of funds in this APR tier. */
+    total_balance?: string;
+}

package/dist/generated/broker/model/acatcActivityV2.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 { CommonAcatActivityV2 } from './commonAcatActivityV2.js';
+import type { CommonNTAActivityV2 } from './commonNTAActivityV2.js';
+/**
+ * Automated customer account transfer service (cash)
+ */
+export type AcatcActivityV2 = CommonNTAActivityV2 & CommonAcatActivityV2;

package/dist/generated/broker/model/acatsActivityV2.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 { CommonAcatActivityV2 } from './commonAcatActivityV2.js';
+import type { CommonNTAActivityV2 } from './commonNTAActivityV2.js';
+/**
+ * Automated customer account transfer service (stock)
+ */
+export type AcatsActivityV2 = CommonNTAActivityV2 & CommonAcatActivityV2 & {
+    /** The symbol of the security involved with the activity */
+    symbol: string;
+};

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

@@ -0,0 +1,57 @@
+/**
+ * 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 { AccountCashInterestResponse } from './accountCashInterestResponse.js';
+import type { AccountFPSLResponse } from './accountFPSLResponse.js';
+import type { AccountStatus } from './accountStatus.js';
+import type { AccountType } from './accountType.js';
+import type { Agreement } from './agreement.js';
+import type { AssetClass } from './assetClass.js';
+import type { Contact } from './contact.js';
+import type { Currency } from './currency.js';
+import type { Disclosures } from './disclosures.js';
+import type { Identity } from './identity.js';
+import type { OwnerDocument } from './ownerDocument.js';
+import type { TrustedContact } from './trustedContact.js';
+/**
+ * Represents high level account info. Used when returning entire account information would not be useful like the getAllAccounts operation
+ */
+export interface Account {
+    /**
+       * A human-readable account number that can be shown to the end user
+       * @nullable
+       */
+    account_number: string | null;
+    account_type?: AccountType;
+    agreements?: Agreement[];
+    cash_interest?: AccountCashInterestResponse;
+    contact?: Contact;
+    /** Timestamp (RFC3339) of account creation. */
+    created_at: string;
+    crypto_status?: AccountStatus;
+    currency: Currency;
+    disclosures?: Disclosures;
+    /** The documents associated with the primary owner of the account */
+    documents?: OwnerDocument[];
+    /** Assets the user has enabled and is able to trade once status and/or crypto_status are ACTIVE */
+    enabled_assets?: AssetClass[];
+    fpsl?: AccountFPSLResponse;
+    /** UUID that identifies the account for later reference */
+    id: string;
+    identity?: Identity;
+    /** EOD equity calculation (cash + long market value + short market value) */
+    last_equity: string;
+    /**
+       * UUID that identifies the primary account holder (party) for accounts opened under the Multi-Live Accounts (MLA) flow.
+       * Only populated when the account was created by referencing an existing account holder via `primary_account_holder_id`
+       * on `POST /v1/accounts`. Otherwise `null`. Currently only supported for `account_type` of `trading` and `ira`.
+       * @nullable
+       */
+    primary_account_holder_id?: string | null;
+    status: AccountStatus;
+    trusted_contact?: TrustedContact;
+}

package/dist/generated/broker/model/accountCashInterestEvent.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
+ */
+/**
+ * This property is included when the account's cash interest program had changed due to an enrollment, APR tier change, or unenrollment.
+ * The from and to status or APR tier name will be included in the event, depending on the change.
+ */
+export interface AccountCashInterestEvent {
+    /** The APR tier name before the change */
+    apr_tier_name_from?: string;
+    /** The APR tier name after the change */
+    apr_tier_name_to?: string;
+    /** The currency of the cash interest program that changed. */
+    currency?: string;
+    /** The cash_interest program status of the account before the change */
+    status_from?: string;
+    /** The cash_interest program status of the account after the change */
+    status_to?: string;
+}

package/dist/generated/broker/model/accountCashInterestPatch.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 { AccountCashInterestProgram } from './accountCashInterestProgram.js';
+/**
+ * Use this property to change the account's configuration for the USD cash interest program.
+ * To enroll the account, specify the apr_tier_name. The status should not be specified on enrollment.
+ * To change the APR tier, specify the new apr_tier_name. The status should not be specified on tier changes.
+ * The unenroll, set the status to INACTIVE.
+ * After any change, the response will contain a status of PENDING_CHANGE.
+ * An event showing the status change to ACTIVE (for enrollment or tier changes) or INACTIVE (for unenrollment) will be generated when the change is complete.
+ */
+export interface AccountCashInterestPatch {
+    USD?: AccountCashInterestProgram;
+}

package/dist/generated/broker/model/accountCashInterestPost.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 { AccountCashInterestProgram } from './accountCashInterestProgram.js';
+/**
+ * The configuration of the account's USD cash interest program when creating an account.
+ * If cash_interest is not provided and there is a default APR tier defined, that tier will be used.
+ * To enroll the account in a non-default APR tier, provide the cash_interest object with the desired apr_tier_name. The status should not be specified on enrollment.
+ * The response will contain a status of PENDING_CHANGE. An event showing the status change to ACTIVE will be generated when the enrollment is complete.
+ */
+export interface AccountCashInterestPost {
+    USD?: AccountCashInterestProgram;
+}

package/dist/generated/broker/model/accountCashInterestProgram.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
+ */
+export interface AccountCashInterestProgram {
+    /** The unique name of the APR tier for a specific program */
+    apr_tier_name?: string;
+    /**
+       * The status of the account within a cash interest program. One of:
+       * - **ACTIVE**
+       * The account is enrolled and eligible for idle cash to be swept at the end of day (EOD).
+       * - **INACTIVE**
+       * The account is not enrolled due to it either not being eligible (e.g. the updated Alpaca Customer Agreement has not been signed), an APR tier needs to be assigned, or they have been unenrolled.
+       * - **PENDING_CHANGE**
+       * An enrollment, APR Tier change, or unenrollment is in progress
+       */
+    status?: string;
+}

package/dist/generated/broker/model/accountCashInterestResponse.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
+ */
+import type { AccountCashInterestProgram } from './accountCashInterestProgram.js';
+/**
+ * The configuration and status of the account's USD cash interest program
+ */
+export interface AccountCashInterestResponse {
+    USD?: AccountCashInterestProgram;
+}

package/dist/generated/broker/model/accountConfigurations.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 { AccountConfigurationsDtbpCheck } from './accountConfigurationsDtbpCheck.js';
+import type { AccountConfigurationsMaxOptionsTradingLevel } from './accountConfigurationsMaxOptionsTradingLevel.js';
+import type { AccountConfigurationsTradeConfirmEmail } from './accountConfigurationsTradeConfirmEmail.js';
+/**
+ * Represents additional configuration settings for an account
+ */
+export interface AccountConfigurations {
+    /** If true, overnight trading is disabled. */
+    disable_overnight_trading?: boolean;
+    /**
+       * both, entry, or exit. Controls Day Trading Margin Call (DTMC) checks.
+       * @deprecated
+       */
+    dtbp_check?: AccountConfigurationsDtbpCheck;
+    /** If true, account is able to participate in fractional trading */
+    fractional_trading?: boolean;
+    /** Can be "1" or "2" */
+    max_margin_multiplier?: string;
+    /** The desired maximum options trading level. 0=disabled, 1=Covered Call/Cash-Secured Put, 2=Long Call/Put, 3=Spreads/Straddles. */
+    max_options_trading_level?: AccountConfigurationsMaxOptionsTradingLevel;
+    /** If true, account becomes long-only mode. */
+    no_shorting?: boolean;
+    /** @deprecated */
+    pdt_check?: string;
+    /** If set to true then Alpaca will accept orders for PTP symbols with no exception. Default is false. */
+    ptp_no_exception_entry?: string;
+    /** If true, new orders are blocked. */
+    suspend_trade?: boolean;
+    /** all or none. If none, emails for order fills are not sent. */
+    trade_confirm_email?: AccountConfigurationsTradeConfirmEmail;
+}

package/dist/generated/broker/model/accountConfigurationsDtbpCheck.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
+ */
+/**
+ * both, entry, or exit. Controls Day Trading Margin Call (DTMC) checks.
+ * @deprecated
+ */
+export type AccountConfigurationsDtbpCheck = typeof AccountConfigurationsDtbpCheck[keyof typeof AccountConfigurationsDtbpCheck];
+export declare const AccountConfigurationsDtbpCheck: {
+    readonly both: "both";
+    readonly entry: "entry";
+    readonly exit: "exit";
+};

package/dist/generated/broker/model/accountConfigurationsMaxOptionsTradingLevel.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
+ */
+/**
+ * The desired maximum options trading level. 0=disabled, 1=Covered Call/Cash-Secured Put, 2=Long Call/Put, 3=Spreads/Straddles.
+ */
+export type AccountConfigurationsMaxOptionsTradingLevel = typeof AccountConfigurationsMaxOptionsTradingLevel[keyof typeof AccountConfigurationsMaxOptionsTradingLevel];
+export declare const AccountConfigurationsMaxOptionsTradingLevel: {
+    readonly NUMBER_0: 0;
+    readonly NUMBER_1: 1;
+    readonly NUMBER_2: 2;
+    readonly NUMBER_3: 3;
+};

package/dist/generated/broker/model/accountConfigurationsTradeConfirmEmail.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
+ */
+/**
+ * all or none. If none, emails for order fills are not sent.
+ */
+export type AccountConfigurationsTradeConfirmEmail = typeof AccountConfigurationsTradeConfirmEmail[keyof typeof AccountConfigurationsTradeConfirmEmail];
+export declare const AccountConfigurationsTradeConfirmEmail: {
+    readonly all: "all";
+    readonly none: "none";
+};

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

@@ -0,0 +1,63 @@
+/**
+ * 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 { AccountCashInterestPost } from './accountCashInterestPost.js';
+import type { AccountConfigurations } from './accountConfigurations.js';
+import type { AccountCreationRequestInvestmentObjective } from './accountCreationRequestInvestmentObjective.js';
+import type { AccountCreationRequestInvestmentTimeHorizon } from './accountCreationRequestInvestmentTimeHorizon.js';
+import type { AccountCreationRequestLiquidityNeeds } from './accountCreationRequestLiquidityNeeds.js';
+import type { AccountCreationRequestRiskTolerance } from './accountCreationRequestRiskTolerance.js';
+import type { AccountFPSLPost } from './accountFPSLPost.js';
+import type { AccountSubType } from './accountSubType.js';
+import type { AccountType } from './accountType.js';
+import type { Agreement } from './agreement.js';
+import type { AssetClass } from './assetClass.js';
+import type { Beneficiary } from './beneficiary.js';
+import type { Contact } from './contact.js';
+import type { Disclosures } from './disclosures.js';
+import type { Identity } from './identity.js';
+import type { OwnerDocumentUploadRequest } from './ownerDocumentUploadRequest.js';
+import type { TrustedContact } from './trustedContact.js';
+/**
+ * Represents the fields required to create a new account
+ */
+export interface AccountCreationRequest {
+    account_sub_type?: AccountSubType;
+    account_type?: AccountType;
+    /** The client must present the Alpaca Account and Margin Agreements to the end user, and confirm they have read and agreed to the agreement. */
+    agreements: Agreement[];
+    /** IRA Account only. A user can submit max 6 beneficiaries. */
+    beneficiaries?: Beneficiary[];
+    cash_interest?: AccountCashInterestPost;
+    contact: Contact;
+    disclosures: Disclosures;
+    documents?: OwnerDocumentUploadRequest[];
+    /** Will default to `us_equity`. Alpaca has the ability to update the default value upon request. */
+    enabled_assets?: AssetClass[];
+    fpsl?: AccountFPSLPost;
+    identity: Identity;
+    /** The user's investment objective. This field should be used instead of the deprecated `investment_objective` under identity. */
+    investment_objective?: AccountCreationRequestInvestmentObjective;
+    /** The expected period of time the user plan to invest to achieve his/her financial goal(s). This field should be used instead of the deprecated `investment_time_horizon` under identity. */
+    investment_time_horizon?: AccountCreationRequestInvestmentTimeHorizon;
+    /** The user's ability to quickly and easily convert to cash all or a portion of the investments in this account without experiencing significant loss in value. This field should be used instead of the deprecated `liquidity_needs` under identity. */
+    liquidity_needs?: AccountCreationRequestLiquidityNeeds;
+    /**
+       * UUID of an existing account holder (party) to use as the primary account holder for the new account.
+       * Used to open additional accounts under the Multi-Live Accounts (MLA) flow.
+       *
+       * When present:
+       * - `contact` and `identity` must be omitted (returns HTTP 400 otherwise).
+       * - `agreements` must still be supplied (e.g. `customer_agreement` for trading; `customer_agreement` and `etc_agreement` for IRA).
+       * - Only `account_type` values of `trading` and `ira` are supported.
+       */
+    primary_account_holder_id?: string;
+    /** The user's investment risk tolerance. This field should be used instead of the deprecated `risk_tolerance` under identity. */
+    risk_tolerance?: AccountCreationRequestRiskTolerance;
+    trading_configurations?: AccountConfigurations;
+    trusted_contact?: TrustedContact;
+}

package/dist/generated/broker/model/accountCreationRequestInvestmentObjective.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
+ */
+/**
+ * The user's investment objective. This field should be used instead of the deprecated `investment_objective` under identity.
+ */
+export type AccountCreationRequestInvestmentObjective = typeof AccountCreationRequestInvestmentObjective[keyof typeof AccountCreationRequestInvestmentObjective];
+export declare const AccountCreationRequestInvestmentObjective: {
+    readonly generate_income: "generate_income";
+    readonly preserve_wealth: "preserve_wealth";
+    readonly market_speculation: "market_speculation";
+    readonly growth: "growth";
+    readonly balance_preserve_wealth_with_growth: "balance_preserve_wealth_with_growth";
+};

package/dist/generated/broker/model/accountCreationRequestInvestmentTimeHorizon.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
+ */
+/**
+ * The expected period of time the user plan to invest to achieve his/her financial goal(s). This field should be used instead of the deprecated `investment_time_horizon` under identity.
+ */
+export type AccountCreationRequestInvestmentTimeHorizon = typeof AccountCreationRequestInvestmentTimeHorizon[keyof typeof AccountCreationRequestInvestmentTimeHorizon];
+export declare const AccountCreationRequestInvestmentTimeHorizon: {
+    readonly less_than_1_year: "less_than_1_year";
+    readonly '1_to_2_years': "1_to_2_years";
+    readonly '3_to_5_years': "3_to_5_years";
+    readonly '6_to_10_years': "6_to_10_years";
+    readonly more_than_10_years: "more_than_10_years";
+};

package/dist/generated/broker/model/accountCreationRequestLiquidityNeeds.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
+ */
+/**
+ * The user's ability to quickly and easily convert to cash all or a portion of the investments in this account without experiencing significant loss in value. This field should be used instead of the deprecated `liquidity_needs` under identity.
+ */
+export type AccountCreationRequestLiquidityNeeds = typeof AccountCreationRequestLiquidityNeeds[keyof typeof AccountCreationRequestLiquidityNeeds];
+export declare const AccountCreationRequestLiquidityNeeds: {
+    readonly very_important: "very_important";
+    readonly important: "important";
+    readonly somewhat_important: "somewhat_important";
+    readonly does_not_matter: "does_not_matter";
+};

package/dist/generated/broker/model/accountCreationRequestRiskTolerance.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 user's investment risk tolerance. This field should be used instead of the deprecated `risk_tolerance` under identity.
+ */
+export type AccountCreationRequestRiskTolerance = typeof AccountCreationRequestRiskTolerance[keyof typeof AccountCreationRequestRiskTolerance];
+export declare const AccountCreationRequestRiskTolerance: {
+    readonly conservative: "conservative";
+    readonly moderate: "moderate";
+    readonly significant_risk: "significant_risk";
+};

package/dist/generated/broker/model/accountDocument.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 { AccountDocumentType } from './accountDocumentType.js';
+/**
+ * A document associated with an account
+ */
+export interface AccountDocument {
+    date: string;
+    id: string;
+    name?: string;
+    /** The sub-type of the document. This is a free-form property. */
+    sub_type?: string;
+    type: AccountDocumentType;
+}

package/dist/generated/broker/model/accountDocumentType.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
+ */
+/**
+ * The type of the account document
+ */
+export type AccountDocumentType = typeof AccountDocumentType[keyof typeof AccountDocumentType];
+export declare const AccountDocumentType: {
+    readonly account_application: "account_application";
+    readonly account_statement: "account_statement";
+    readonly crypto_account_statement: "crypto_account_statement";
+    readonly options_application: "options_application";
+    readonly tax_statement: "tax_statement";
+    readonly trade_confirmation_json: "trade_confirmation_json";
+    readonly trade_confirmation: "trade_confirmation";
+};

package/dist/generated/broker/model/accountDocumentTypeParameter.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
+ */
+export type AccountDocumentTypeParameter = typeof AccountDocumentTypeParameter[keyof typeof AccountDocumentTypeParameter];
+export declare const AccountDocumentTypeParameter: {
+    readonly account_application: "account_application";
+    readonly account_statement: "account_statement";
+    readonly crypto_account_statement: "crypto_account_statement";
+    readonly options_application: "options_application";
+    readonly tax_statement: "tax_statement";
+    readonly trade_confirmation_json: "trade_confirmation_json";
+    readonly trade_confirmation: "trade_confirmation";
+};