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

Class AccountFPSLPatch

java.lang.Object
markets.alpaca.client.openapi.broker.model.AccountFPSLPatch
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class AccountFPSLPatch extends Object implements Serializable
The account's Fully Paid Securities Lending (FPSL) configuration. Use this property to change the account's configuration for the FPSL program. To enroll the account for a market, specify the tier_id. The status should not be specified on enrollment. To change the tier, specify the new tier_id. The status should not be specified on tier changes. To unenroll, set the status to INACTIVE. To re-enroll the account, set the status to ACTIVE. You can also specify the tier_id in case you want to change it. Currently only US market is supported.
See Also:

  • Field Details

  • Constructor Details

    • AccountFPSLPatch

      public AccountFPSLPatch()

  • Method Details

    • US

      public AccountFPSLPatch US(@Nullable AccountFPSLItem US)

    • getUS

      @Nullable public AccountFPSLItem getUS()
      Get US
      Returns:
      US

    • setUS

      public void setUS(@Nullable AccountFPSLItem US)

    • putAdditionalProperty

      public AccountFPSLPatch 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 AccountFPSLPatch 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 AccountFPSLPatch

    • fromJson

      public static AccountFPSLPatch fromJson(String jsonString) throws IOException
      Create an instance of AccountFPSLPatch given an JSON string
      Parameters:
      jsonString - JSON string
      Returns:
      An instance of AccountFPSLPatch
      Throws:
      IOException - if the JSON string is invalid with respect to AccountFPSLPatch

    • toJson

      public String toJson()
      Convert an instance of AccountFPSLPatch to an JSON string
      Returns:
      JSON string