Package markets.alpaca.client.openapi.broker.model

Class OptionsApprovalResponse

java.lang.Object

markets.alpaca.client.openapi.broker.model.OptionsApprovalResponse

All Implemented Interfaces:

Serializable

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class OptionsApprovalResponse
extends Object
implements Serializable

OptionsApprovalResponse

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OptionsApprovalResponse.ApprovedLevelEnum	The option trading level approved for this request.
static class	OptionsApprovalResponse.CustomTypeAdapterFactory
static enum	OptionsApprovalResponse.RequestedLevelEnum	The request option trading level.
static enum	OptionsApprovalResponse.RequesterEnum	The requester of the options approval request.

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ACCOUNT_ID
static final String	SERIALIZED_NAME_APPROVED_LEVEL
static final String	SERIALIZED_NAME_CREATED_AT
static final String	SERIALIZED_NAME_ID
static final String	SERIALIZED_NAME_REQUESTED_LEVEL
static final String	SERIALIZED_NAME_REQUESTER
static final String	SERIALIZED_NAME_STATUS
static final String	SERIALIZED_NAME_UPDATED_AT

Constructor Summary

Constructors

Constructor	Description
OptionsApprovalResponse()

Method Summary

Modifier and Type	Method	Description
OptionsApprovalResponse	accountId(UUID accountId)
OptionsApprovalResponse	approvedLevel(OptionsApprovalResponse.ApprovedLevelEnum approvedLevel)
OptionsApprovalResponse	createdAt(OffsetDateTime createdAt)
boolean	equals(Object o)
static OptionsApprovalResponse	fromJson(String jsonString)	Create an instance of OptionsApprovalResponse given an JSON string
UUID	getAccountId()	The account ID.
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
OptionsApprovalResponse.ApprovedLevelEnum	getApprovedLevel()	The option trading level approved for this request.
OffsetDateTime	getCreatedAt()	The time when the request was submitted.
UUID	getId()	The request ID.
OptionsApprovalResponse.RequestedLevelEnum	getRequestedLevel()	The request option trading level.
OptionsApprovalResponse.RequesterEnum	getRequester()	The requester of the options approval request.
OptionsApprovalStatus	getStatus()	Get status
OffsetDateTime	getUpdatedAt()	The time when the request was last updated.
int	hashCode()
OptionsApprovalResponse	id(UUID id)
OptionsApprovalResponse	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
OptionsApprovalResponse	requestedLevel(OptionsApprovalResponse.RequestedLevelEnum requestedLevel)
OptionsApprovalResponse	requester(OptionsApprovalResponse.RequesterEnum requester)
void	setAccountId(UUID accountId)
void	setApprovedLevel(OptionsApprovalResponse.ApprovedLevelEnum approvedLevel)
void	setCreatedAt(OffsetDateTime createdAt)
void	setId(UUID id)
void	setRequestedLevel(OptionsApprovalResponse.RequestedLevelEnum requestedLevel)
void	setRequester(OptionsApprovalResponse.RequesterEnum requester)
void	setStatus(OptionsApprovalStatus status)
void	setUpdatedAt(OffsetDateTime updatedAt)
OptionsApprovalResponse	status(OptionsApprovalStatus status)
String	toJson()	Convert an instance of OptionsApprovalResponse to an JSON string
String	toString()
OptionsApprovalResponse	updatedAt(OffsetDateTime updatedAt)
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_ACCOUNT_ID

public static final String SERIALIZED_NAME_ACCOUNT_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_APPROVED_LEVEL

public static final String SERIALIZED_NAME_APPROVED_LEVEL

See Also:

• Constant Field Values

SERIALIZED_NAME_CREATED_AT

public static final String SERIALIZED_NAME_CREATED_AT

See Also:

• Constant Field Values

SERIALIZED_NAME_ID

public static final String SERIALIZED_NAME_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_REQUESTED_LEVEL

public static final String SERIALIZED_NAME_REQUESTED_LEVEL

See Also:

• Constant Field Values

SERIALIZED_NAME_REQUESTER

public static final String SERIALIZED_NAME_REQUESTER

See Also:

• Constant Field Values

SERIALIZED_NAME_STATUS

public static final String SERIALIZED_NAME_STATUS

See Also:

• Constant Field Values

SERIALIZED_NAME_UPDATED_AT

public static final String SERIALIZED_NAME_UPDATED_AT

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

OptionsApprovalResponse

public OptionsApprovalResponse()

Method Details

accountId

public OptionsApprovalResponse accountId(@Nullable
 UUID accountId)

getAccountId

@Nullable
public UUID getAccountId()

The account ID.

Returns:

accountId

setAccountId

public void setAccountId(@Nullable
 UUID accountId)

approvedLevel

public OptionsApprovalResponse approvedLevel(@Nullable
 OptionsApprovalResponse.ApprovedLevelEnum approvedLevel)

getApprovedLevel

@Nullable
public OptionsApprovalResponse.ApprovedLevelEnum getApprovedLevel()

The option trading level approved for this request. Only present once the request has completed processiing. Note that a subsequent request may be approved for a different level. 0=Disabled, 1=Covered Call/Cash-Secured Put, 2=Long Call/Put, 3=Spreads/Straddles.\"

Returns:

approvedLevel

setApprovedLevel

public void setApprovedLevel(@Nullable
 OptionsApprovalResponse.ApprovedLevelEnum approvedLevel)

createdAt

public OptionsApprovalResponse createdAt(@Nullable
 OffsetDateTime createdAt)

getCreatedAt

@Nullable
public OffsetDateTime getCreatedAt()

The time when the request was submitted.

Returns:

createdAt

setCreatedAt

public void setCreatedAt(@Nullable
 OffsetDateTime createdAt)

id

public OptionsApprovalResponse id(@Nullable
 UUID id)

getId

@Nullable
public UUID getId()

The request ID.

Returns:

id

setId

public void setId(@Nullable
 UUID id)

requestedLevel

public OptionsApprovalResponse requestedLevel(@Nullable
 OptionsApprovalResponse.RequestedLevelEnum requestedLevel)

getRequestedLevel

@Nullable
public OptionsApprovalResponse.RequestedLevelEnum getRequestedLevel()

The request option trading level. 0=Disabled, 1=Covered Call/Cash-Secured Put, 2=Long Call/Put, 3=Spreads/Straddles.

Returns:

requestedLevel

setRequestedLevel

public void setRequestedLevel(@Nullable
 OptionsApprovalResponse.RequestedLevelEnum requestedLevel)

requester

public OptionsApprovalResponse requester(@Nullable
 OptionsApprovalResponse.RequesterEnum requester)

getRequester

@Nullable
public OptionsApprovalResponse.RequesterEnum getRequester()

The requester of the options approval request.

Returns:

requester

setRequester

public void setRequester(@Nullable
 OptionsApprovalResponse.RequesterEnum requester)

status

public OptionsApprovalResponse status(@Nullable
 OptionsApprovalStatus status)

getStatus

@Nullable
public OptionsApprovalStatus getStatus()

Get status

Returns:

status

setStatus

public void setStatus(@Nullable
 OptionsApprovalStatus status)

updatedAt

public OptionsApprovalResponse updatedAt(@Nullable
 OffsetDateTime updatedAt)

getUpdatedAt

@Nullable
public OffsetDateTime getUpdatedAt()

The time when the request was last updated.

Returns:

updatedAt

setUpdatedAt

public void setUpdatedAt(@Nullable
 OffsetDateTime updatedAt)

putAdditionalProperty

public OptionsApprovalResponse putAdditionalProperty(String key,
 Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - name of the property

value - value of the property

Returns:

the OptionsApprovalResponse instance itself

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

a map of objects

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - name of the property

Returns:

an object

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

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to OptionsApprovalResponse

fromJson

public static OptionsApprovalResponse fromJson(String jsonString)
                                        throws IOException

Create an instance of OptionsApprovalResponse given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of OptionsApprovalResponse

Throws:

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

toJson

public String toJson()

Convert an instance of OptionsApprovalResponse to an JSON string

Returns:

JSON string