Package net.jacobpeterson.alpaca.openapi.broker.model

Class AccountConfigurations

java.lang.Object

net.jacobpeterson.alpaca.openapi.broker.model.AccountConfigurations

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-03-23T18:58:47.485165-07:00[America/Los_Angeles]")
public class AccountConfigurations
extends Object

Represents additional configuration settings for an account

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AccountConfigurations.CustomTypeAdapterFactory
static enum	AccountConfigurations.DtbpCheckEnum	both, entry, or exit.
static enum	AccountConfigurations.MaxOptionsTradingLevelEnum	The desired maximum options trading level.
static enum	AccountConfigurations.TradeConfirmEmailEnum	all or none.

Field Summary

Fields

Modifier and Type	Field	Description
static Predicate<com.google.gson.JsonElement>	isValid
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_DTBP_CHECK
static final String	SERIALIZED_NAME_FRACTIONAL_TRADING
static final String	SERIALIZED_NAME_MAX_MARGIN_MULTIPLIER
static final String	SERIALIZED_NAME_MAX_OPTIONS_TRADING_LEVEL
static final String	SERIALIZED_NAME_NO_SHORTING
static final String	SERIALIZED_NAME_PDT_CHECK
static final String	SERIALIZED_NAME_PTP_NO_EXCEPTION_ENTRY
static final String	SERIALIZED_NAME_SUSPEND_TRADE
static final String	SERIALIZED_NAME_TRADE_CONFIRM_EMAIL
static boolean	validate

Constructor Summary

Constructors

Constructor	Description
AccountConfigurations()

Method Summary

Modifier and Type	Method	Description
AccountConfigurations	dtbpCheck(AccountConfigurations.DtbpCheckEnum dtbpCheck)
boolean	equals(Object o)
AccountConfigurations	fractionalTrading(Boolean fractionalTrading)
static AccountConfigurations	fromJson(String jsonString)	Create an instance of AccountConfigurations given an JSON string
AccountConfigurations.DtbpCheckEnum	getDtbpCheck()	both, entry, or exit.
Boolean	getFractionalTrading()	If true, account is able to participate in fractional trading
String	getMaxMarginMultiplier()	Can be \"1\" or \"2\"
AccountConfigurations.MaxOptionsTradingLevelEnum	getMaxOptionsTradingLevel()	The desired maximum options trading level.
Boolean	getNoShorting()	If true, account becomes long-only mode.
String	getPdtCheck()	Get pdtCheck
String	getPtpNoExceptionEntry()	If set to true then Alpaca will accept orders for PTP symbols with no exception.
Boolean	getSuspendTrade()	If true, new orders are blocked.
AccountConfigurations.TradeConfirmEmailEnum	getTradeConfirmEmail()	all or none.
int	hashCode()
AccountConfigurations	maxMarginMultiplier(String maxMarginMultiplier)
AccountConfigurations	maxOptionsTradingLevel(AccountConfigurations.MaxOptionsTradingLevelEnum maxOptionsTradingLevel)
AccountConfigurations	noShorting(Boolean noShorting)
AccountConfigurations	pdtCheck(String pdtCheck)
AccountConfigurations	ptpNoExceptionEntry(String ptpNoExceptionEntry)
void	setDtbpCheck(AccountConfigurations.DtbpCheckEnum dtbpCheck)
void	setFractionalTrading(Boolean fractionalTrading)
void	setMaxMarginMultiplier(String maxMarginMultiplier)
void	setMaxOptionsTradingLevel(AccountConfigurations.MaxOptionsTradingLevelEnum maxOptionsTradingLevel)
void	setNoShorting(Boolean noShorting)
void	setPdtCheck(String pdtCheck)
void	setPtpNoExceptionEntry(String ptpNoExceptionEntry)
void	setSuspendTrade(Boolean suspendTrade)
void	setTradeConfirmEmail(AccountConfigurations.TradeConfirmEmailEnum tradeConfirmEmail)
AccountConfigurations	suspendTrade(Boolean suspendTrade)
String	toJson()	Convert an instance of AccountConfigurations to an JSON string
String	toString()
AccountConfigurations	tradeConfirmEmail(AccountConfigurations.TradeConfirmEmailEnum tradeConfirmEmail)
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SERIALIZED_NAME_DTBP_CHECK

public static final String SERIALIZED_NAME_DTBP_CHECK

See Also:

• Constant Field Values

SERIALIZED_NAME_TRADE_CONFIRM_EMAIL

public static final String SERIALIZED_NAME_TRADE_CONFIRM_EMAIL

See Also:

• Constant Field Values

SERIALIZED_NAME_SUSPEND_TRADE

public static final String SERIALIZED_NAME_SUSPEND_TRADE

See Also:

• Constant Field Values

SERIALIZED_NAME_NO_SHORTING

public static final String SERIALIZED_NAME_NO_SHORTING

See Also:

• Constant Field Values

SERIALIZED_NAME_FRACTIONAL_TRADING

public static final String SERIALIZED_NAME_FRACTIONAL_TRADING

See Also:

• Constant Field Values

SERIALIZED_NAME_MAX_MARGIN_MULTIPLIER

public static final String SERIALIZED_NAME_MAX_MARGIN_MULTIPLIER

See Also:

• Constant Field Values

SERIALIZED_NAME_MAX_OPTIONS_TRADING_LEVEL

public static final String SERIALIZED_NAME_MAX_OPTIONS_TRADING_LEVEL

See Also:

• Constant Field Values

SERIALIZED_NAME_PDT_CHECK

public static final String SERIALIZED_NAME_PDT_CHECK

See Also:

• Constant Field Values

SERIALIZED_NAME_PTP_NO_EXCEPTION_ENTRY

public static final String SERIALIZED_NAME_PTP_NO_EXCEPTION_ENTRY

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

validate

public static boolean validate

isValid

public static Predicate<com.google.gson.JsonElement> isValid

Constructor Details

AccountConfigurations

public AccountConfigurations()

Method Details

dtbpCheck

public AccountConfigurations dtbpCheck(AccountConfigurations.DtbpCheckEnum dtbpCheck)

getDtbpCheck

@Nonnull
public AccountConfigurations.DtbpCheckEnum getDtbpCheck()

both, entry, or exit. Controls Day Trading Margin Call (DTMC) checks.

Returns:

dtbpCheck

setDtbpCheck

public void setDtbpCheck(AccountConfigurations.DtbpCheckEnum dtbpCheck)

tradeConfirmEmail

public AccountConfigurations tradeConfirmEmail(AccountConfigurations.TradeConfirmEmailEnum tradeConfirmEmail)

getTradeConfirmEmail

@Nonnull
public AccountConfigurations.TradeConfirmEmailEnum getTradeConfirmEmail()

all or none. If none, emails for order fills are not sent.

Returns:

tradeConfirmEmail

setTradeConfirmEmail

public void setTradeConfirmEmail(AccountConfigurations.TradeConfirmEmailEnum tradeConfirmEmail)

suspendTrade

public AccountConfigurations suspendTrade(Boolean suspendTrade)

getSuspendTrade

@Nonnull
public Boolean getSuspendTrade()

If true, new orders are blocked.

Returns:

suspendTrade

setSuspendTrade

public void setSuspendTrade(Boolean suspendTrade)

noShorting

public AccountConfigurations noShorting(Boolean noShorting)

getNoShorting

@Nonnull
public Boolean getNoShorting()

If true, account becomes long-only mode.

Returns:

noShorting

setNoShorting

public void setNoShorting(Boolean noShorting)

fractionalTrading

public AccountConfigurations fractionalTrading(Boolean fractionalTrading)

getFractionalTrading

@Nonnull
public Boolean getFractionalTrading()

If true, account is able to participate in fractional trading

Returns:

fractionalTrading

setFractionalTrading

public void setFractionalTrading(Boolean fractionalTrading)

maxMarginMultiplier

public AccountConfigurations maxMarginMultiplier(String maxMarginMultiplier)

getMaxMarginMultiplier

@Nonnull
public String getMaxMarginMultiplier()

Can be \"1\" or \"2\"

Returns:

maxMarginMultiplier

setMaxMarginMultiplier

public void setMaxMarginMultiplier(String maxMarginMultiplier)

maxOptionsTradingLevel

public AccountConfigurations maxOptionsTradingLevel(AccountConfigurations.MaxOptionsTradingLevelEnum maxOptionsTradingLevel)

getMaxOptionsTradingLevel

@Nullable
public AccountConfigurations.MaxOptionsTradingLevelEnum getMaxOptionsTradingLevel()

The desired maximum options trading level. 0=disabled, 1=Covered Call/Cash-Secured Put, 2=Long Call/Put.

Returns:

maxOptionsTradingLevel

setMaxOptionsTradingLevel

public void setMaxOptionsTradingLevel(AccountConfigurations.MaxOptionsTradingLevelEnum maxOptionsTradingLevel)

pdtCheck

public AccountConfigurations pdtCheck(String pdtCheck)

getPdtCheck

@Nonnull
public String getPdtCheck()

Get pdtCheck

Returns:

pdtCheck

setPdtCheck

public void setPdtCheck(String pdtCheck)

ptpNoExceptionEntry

public AccountConfigurations ptpNoExceptionEntry(String ptpNoExceptionEntry)

getPtpNoExceptionEntry

@Nonnull
public String getPtpNoExceptionEntry()

If set to true then Alpaca will accept orders for PTP symbols with no exception. Default is false.

Returns:

ptpNoExceptionEntry

setPtpNoExceptionEntry

public void setPtpNoExceptionEntry(String ptpNoExceptionEntry)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Throws:

IOException

fromJson

public static AccountConfigurations fromJson(String jsonString)
                                      throws IOException

Create an instance of AccountConfigurations given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of AccountConfigurations

Throws:

IOException - if the JSON string is invalid with respect to AccountConfigurations

toJson

public String toJson()

Convert an instance of AccountConfigurations to an JSON string

Returns:

JSON string