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

Class Agreement

java.lang.Object
markets.alpaca.client.openapi.broker.model.Agreement
All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.23.0") public class Agreement extends Object implements Serializable
Agreement
See Also:

  • Field Details

  • Constructor Details

    • Agreement

      public Agreement()

  • Method Details

    • agreement

      public Agreement agreement(@Nonnull AgreementType agreement)

    • getAgreement

      @Nonnull public AgreementType getAgreement()
      Get agreement
      Returns:
      agreement

    • setAgreement

      public void setAgreement(@Nonnull AgreementType agreement)

    • ipAddress

      public Agreement ipAddress(@Nonnull String ipAddress)

    • getIpAddress

      @Nonnull public String getIpAddress()
      The ip_address the signed agreements were sent from by the user.
      Returns:
      ipAddress

    • setIpAddress

      public void setIpAddress(@Nonnull String ipAddress)

    • revision

      public Agreement revision(@Nullable String revision)

    • getRevision

      @Nullable public String getRevision()
      The agreement revision. The format is XX.YYYY.MM where XX is an incrementing revision number, YYYY is the year and MM is the month. If the revision is not specified in a POST or PATCH request, the active revision will be used, which will align with the [Alpaca Documents Library](https://alpaca.markets/disclosures).
      Returns:
      revision

    • setRevision

      public void setRevision(@Nullable String revision)

    • signedAt

      public Agreement signedAt(@Nonnull OffsetDateTime signedAt)

    • getSignedAt

      @Nonnull public OffsetDateTime getSignedAt()
      The timestamp the agreement was signed.
      Returns:
      signedAt

    • setSignedAt

      public void setSignedAt(@Nonnull OffsetDateTime signedAt)

    • putAdditionalProperty

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

    • fromJson

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

    • toJson

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