snaptrade 2.0.218 → 3.0.0

data/lib/snaptrade/models/connection_account.rb

@@ -0,0 +1,51 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'date'
+require 'time'
+
+module SnapTrade
+  # A single account under a connection, from the `kind`-discriminated union used by `Connections_listConnectionAccounts`. Use `kind` to determine which schema is present.  Only `investment` is implemented today; `deposit` and `line_of_credit` will be added as additional variants in a future release. 
+  module ConnectionAccount
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'InvestmentAccount'
+        ]
+      end
+
+      # Discriminator's property name (OpenAPI v3)
+      def openapi_discriminator_name
+        :'kind'
+      end
+
+      # Discriminator's mapping (OpenAPI v3)
+      def openapi_discriminator_mapping
+        {
+          :'investment' => :'InvestmentAccount'
+        }
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        discriminator_value = data[openapi_discriminator_name]
+        return nil if discriminator_value.nil?
+
+        klass = openapi_discriminator_mapping[discriminator_value.to_s.to_sym]
+        return nil unless klass
+
+        SnapTrade.const_get(klass).build_from_hash(data)
+      end
+    end
+  end
+
+end

data/lib/snaptrade/models/{connections_session_events200_response_inner.rb → connection_account_sync_status.rb}

@@ -11,33 +11,26 @@ require 'date'
 require 'time'
 
 module SnapTrade
-  class ConnectionsSessionEvents200ResponseInner
-    attr_accessor :id
+  # Contains status updates for the account sync process between SnapTrade and the brokerage, used only by `Connections_listConnectionAccounts`. Each property is optional -- a brokerage may not report sync status for every data type. `orders`/`positions`/`balances` are the timestamp of the last successful sync of that data type (null if never synced). 
+  class ConnectionAccountSyncStatus
+    attr_accessor :transactions
 
-    attr_accessor :session_event_type
+    # The last time orders were successfully synced by SnapTrade.
+    attr_accessor :orders
 
-    attr_accessor :session_id
+    # The last time positions were successfully synced by SnapTrade.
+    attr_accessor :positions
 
-    # SnapTrade User ID. This is chosen by the API partner and can be any string that is a) unique to the user, and b) immutable for the user. It is recommended to NOT use email addresses for this property because they are usually not immutable.
-    attr_accessor :user_id
-
-    # Time
-    attr_accessor :created_date
-
-    attr_accessor :brokerage_status_code
-
-    attr_accessor :brokerage_authorization_id
+    # The last time balances were successfully synced by SnapTrade.
+    attr_accessor :balances
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'session_event_type' => :'session_event_type',
-        :'session_id' => :'session_id',
-        :'user_id' => :'user_id',
-        :'created_date' => :'created_date',
-        :'brokerage_status_code' => :'brokerage_status_code',
-        :'brokerage_authorization_id' => :'brokerage_authorization_id'
+        :'transactions' => :'transactions',
+        :'orders' => :'orders',
+        :'positions' => :'positions',
+        :'balances' => :'balances'
       }
     end
 
@@ -49,71 +42,51 @@ module SnapTrade
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'id' => :'String',
-        :'session_event_type' => :'SessionEventType',
-        :'session_id' => :'String',
-        :'user_id' => :'String',
-        :'created_date' => :'String',
-        :'brokerage_status_code' => :'Integer',
-        :'brokerage_authorization_id' => :'String'
+        :'transactions' => :'TransactionsStatus',
+        :'orders' => :'Time',
+        :'positions' => :'Time',
+        :'balances' => :'Time'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'brokerage_status_code',
+        :'orders',
+        :'positions',
+        :'balances'
       ])
     end
 
-    # List of class defined in anyOf (OpenAPI v3)
-    def self.openapi_any_of
-      [
-      :'SessionEvent'
-      ]
-    end
-
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::ConnectionsSessionEvents200ResponseInner` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::ConnectionAccountSyncStatus` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::ConnectionsSessionEvents200ResponseInner`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::ConnectionAccountSyncStatus`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'id')
-        self.id = attributes[:'id']
-      end
-
-      if attributes.key?(:'session_event_type')
-        self.session_event_type = attributes[:'session_event_type']
-      end
-
-      if attributes.key?(:'session_id')
-        self.session_id = attributes[:'session_id']
-      end
-
-      if attributes.key?(:'user_id')
-        self.user_id = attributes[:'user_id']
+      if attributes.key?(:'transactions')
+        self.transactions = attributes[:'transactions']
       end
 
-      if attributes.key?(:'created_date')
-        self.created_date = attributes[:'created_date']
+      if attributes.key?(:'orders')
+        self.orders = attributes[:'orders']
       end
 
-      if attributes.key?(:'brokerage_status_code')
-        self.brokerage_status_code = attributes[:'brokerage_status_code']
+      if attributes.key?(:'positions')
+        self.positions = attributes[:'positions']
       end
 
-      if attributes.key?(:'brokerage_authorization_id')
-        self.brokerage_authorization_id = attributes[:'brokerage_authorization_id']
+      if attributes.key?(:'balances')
+        self.balances = attributes[:'balances']
       end
     end
 
@@ -127,18 +100,6 @@ module SnapTrade
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      _any_of_found = false
-      self.class.openapi_any_of.each do |_class|
-        _any_of = SnapTrade.const_get(_class).build_from_hash(self.to_hash)
-        if _any_of.valid?
-          _any_of_found = true
-        end
-      end
-
-      if !_any_of_found
-        return false
-      end
-
       true
     end
 
@@ -147,13 +108,10 @@ module SnapTrade
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          session_event_type == o.session_event_type &&
-          session_id == o.session_id &&
-          user_id == o.user_id &&
-          created_date == o.created_date &&
-          brokerage_status_code == o.brokerage_status_code &&
-          brokerage_authorization_id == o.brokerage_authorization_id
+          transactions == o.transactions &&
+          orders == o.orders &&
+          positions == o.positions &&
+          balances == o.balances
     end
 
     # @see the `==` method
@@ -165,7 +123,7 @@ module SnapTrade
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, session_event_type, session_id, user_id, created_date, brokerage_status_code, brokerage_authorization_id].hash
+      [transactions, orders, positions, balances].hash
     end
 
     # Builds the object from hash

data/lib/snaptrade/models/investment_account.rb

@@ -0,0 +1,372 @@
+=begin
+#SnapTrade
+
+#Connect brokerage accounts to your app for live positions and trading
+
+The version of the OpenAPI document: 1.0.0
+Contact: api@snaptrade.com
+=end
+
+require 'date'
+require 'time'
+
+module SnapTrade
+  # An investment/brokerage account under a connection. `opening_date`, `funding_date`, and `market_value` are real-time or cached depending on the caller's plan -- see `Connections_listConnectionAccounts`. 
+  class InvestmentAccount
+    # Discriminator for the account kind.
+    attr_accessor :kind
+
+    # Unique identifier for the connected brokerage account. This is the UUID used to reference the account in SnapTrade.
+    attr_accessor :id
+
+    # Unique identifier for the connection (brokerage_authorization_id). This is the UUID used to reference the connection in SnapTrade.
+    attr_accessor :connection_id
+
+    # A display name for the account. Either assigned by the user or by the brokerage itself.
+    attr_accessor :display_name
+
+    # The account number assigned by the brokerage. For some brokerages, this field may be masked for security reasons.
+    attr_accessor :number
+
+    # A stable and unique account identifier provided by the institution. Will be set to null if not provided. When present, can be used to check if a user has connected the same brokerage account across multiple connections.
+    attr_accessor :institution_account_id
+
+    # Unique identifier for the institution (brokerage) that holds the account.
+    attr_accessor :institution_id
+
+    # Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was opened at the brokerage.
+    attr_accessor :opening_date
+
+    attr_accessor :sync_status
+
+    # The account type as provided by the brokerage.
+    attr_accessor :raw_type
+
+    # Timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format indicating when the account was funded.
+    attr_accessor :funding_date
+
+    # Indicates whether the account is a paper (simulated) trading account.
+    attr_accessor :is_paper
+
+    attr_accessor :market_value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'kind' => :'kind',
+        :'id' => :'id',
+        :'connection_id' => :'connection_id',
+        :'display_name' => :'display_name',
+        :'number' => :'number',
+        :'institution_account_id' => :'institution_account_id',
+        :'institution_id' => :'institution_id',
+        :'opening_date' => :'opening_date',
+        :'sync_status' => :'sync_status',
+        :'raw_type' => :'raw_type',
+        :'funding_date' => :'funding_date',
+        :'is_paper' => :'is_paper',
+        :'market_value' => :'market_value'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'kind' => :'Kind',
+        :'id' => :'String',
+        :'connection_id' => :'String',
+        :'display_name' => :'String',
+        :'number' => :'String',
+        :'institution_account_id' => :'String',
+        :'institution_id' => :'String',
+        :'opening_date' => :'Time',
+        :'sync_status' => :'ConnectionAccountSyncStatus',
+        :'raw_type' => :'String',
+        :'funding_date' => :'Time',
+        :'is_paper' => :'Boolean',
+        :'market_value' => :'InvestmentAccountMarketValue'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'display_name',
+        :'institution_account_id',
+        :'opening_date',
+        :'raw_type',
+        :'funding_date',
+        :'market_value'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SnapTrade::InvestmentAccount` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SnapTrade::InvestmentAccount`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'kind')
+        self.kind = attributes[:'kind']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'connection_id')
+        self.connection_id = attributes[:'connection_id']
+      end
+
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
+      if attributes.key?(:'number')
+        self.number = attributes[:'number']
+      end
+
+      if attributes.key?(:'institution_account_id')
+        self.institution_account_id = attributes[:'institution_account_id']
+      end
+
+      if attributes.key?(:'institution_id')
+        self.institution_id = attributes[:'institution_id']
+      end
+
+      if attributes.key?(:'opening_date')
+        self.opening_date = attributes[:'opening_date']
+      end
+
+      if attributes.key?(:'sync_status')
+        self.sync_status = attributes[:'sync_status']
+      end
+
+      if attributes.key?(:'raw_type')
+        self.raw_type = attributes[:'raw_type']
+      end
+
+      if attributes.key?(:'funding_date')
+        self.funding_date = attributes[:'funding_date']
+      end
+
+      if attributes.key?(:'is_paper')
+        self.is_paper = attributes[:'is_paper']
+      end
+
+      if attributes.key?(:'market_value')
+        self.market_value = attributes[:'market_value']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @kind.nil?
+        invalid_properties.push('invalid value for "kind", kind cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @connection_id.nil?
+        invalid_properties.push('invalid value for "connection_id", connection_id cannot be nil.')
+      end
+
+      if @number.nil?
+        invalid_properties.push('invalid value for "number", number cannot be nil.')
+      end
+
+      if @sync_status.nil?
+        invalid_properties.push('invalid value for "sync_status", sync_status cannot be nil.')
+      end
+
+      if @is_paper.nil?
+        invalid_properties.push('invalid value for "is_paper", is_paper cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @kind.nil?
+      return false if @id.nil?
+      return false if @connection_id.nil?
+      return false if @number.nil?
+      return false if @sync_status.nil?
+      return false if @is_paper.nil?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          kind == o.kind &&
+          id == o.id &&
+          connection_id == o.connection_id &&
+          display_name == o.display_name &&
+          number == o.number &&
+          institution_account_id == o.institution_account_id &&
+          institution_id == o.institution_id &&
+          opening_date == o.opening_date &&
+          sync_status == o.sync_status &&
+          raw_type == o.raw_type &&
+          funding_date == o.funding_date &&
+          is_paper == o.is_paper &&
+          market_value == o.market_value
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [kind, id, connection_id, display_name, number, institution_account_id, institution_id, opening_date, sync_status, raw_type, funding_date, is_paper, market_value].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = SnapTrade.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end