fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/open_order_entity.rb

@@ -0,0 +1,231 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # An open investment transaction order
+  class OpenOrderEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Long-term persistent identity of the order. Id for this order transaction
+    # @return [String]
+    attr_accessor :order_id
+
+    # Unique identifier of security
+    # @return [String]
+    attr_accessor :security_id
+
+    # CINS, CMC, CME, CUSIP, ISIN, ITSA, NASDAQ, SEDOL, SICC, VALOR, WKN
+    # @return [SecurityIdType1]
+    attr_accessor :security_id_type
+
+    # Market symbol
+    # @return [String]
+    attr_accessor :symbol
+
+    # Description of order
+    # @return [String]
+    attr_accessor :description
+
+    # Number of units (shares or bonds etc.)
+    # @return [Float]
+    attr_accessor :units
+
+    # Type of order. One of BUY, SELL, BUYTOCOVER, BUYTOOPEN, SELLTOCOVER,
+    # SELLTOOPEN, SELLSHORT, SELLCLOSE
+    # @return [OrderType2]
+    attr_accessor :order_type
+
+    # Order date
+    # @return [Date]
+    attr_accessor :order_date
+
+    # Unit price
+    # @return [Float]
+    attr_accessor :unit_price
+
+    # Type of unit. One of SHARES, CURRENCY
+    # @return [UnitType3]
+    attr_accessor :unit_type
+
+    # This order is good for DAY, GOODTILLCANCEL, IMMEDIATE
+    # @return [OrderDuration2]
+    attr_accessor :order_duration
+
+    # CASH, MARGIN, SHORT, OTHER
+    # @return [SubAccountType4]
+    attr_accessor :sub_account
+
+    # Limit price
+    # @return [Float]
+    attr_accessor :limit_price
+
+    # Stop price
+    # @return [Float]
+    attr_accessor :stop_price
+
+    # For 401(k) accounts, source of money for this order. PRETAX, AFTERTAX,
+    # MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST. Default if not
+    # present is OTHERNONVEST
+    # @return [Investment401KSourceType1]
+    attr_accessor :inv401k_source
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['order_id'] = 'orderId'
+      @_hash['security_id'] = 'securityId'
+      @_hash['security_id_type'] = 'securityIdType'
+      @_hash['symbol'] = 'symbol'
+      @_hash['description'] = 'description'
+      @_hash['units'] = 'units'
+      @_hash['order_type'] = 'orderType'
+      @_hash['order_date'] = 'orderDate'
+      @_hash['unit_price'] = 'unitPrice'
+      @_hash['unit_type'] = 'unitType'
+      @_hash['order_duration'] = 'orderDuration'
+      @_hash['sub_account'] = 'subAccount'
+      @_hash['limit_price'] = 'limitPrice'
+      @_hash['stop_price'] = 'stopPrice'
+      @_hash['inv401k_source'] = 'inv401kSource'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        order_id
+        security_id
+        security_id_type
+        symbol
+        description
+        units
+        order_type
+        order_date
+        unit_price
+        unit_type
+        order_duration
+        sub_account
+        limit_price
+        stop_price
+        inv401k_source
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(order_id: SKIP, security_id: SKIP, security_id_type: SKIP,
+                   symbol: SKIP, description: SKIP, units: SKIP,
+                   order_type: SKIP, order_date: SKIP, unit_price: SKIP,
+                   unit_type: SKIP, order_duration: SKIP, sub_account: SKIP,
+                   limit_price: SKIP, stop_price: SKIP, inv401k_source: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @order_id = order_id unless order_id == SKIP
+      @security_id = security_id unless security_id == SKIP
+      @security_id_type = security_id_type unless security_id_type == SKIP
+      @symbol = symbol unless symbol == SKIP
+      @description = description unless description == SKIP
+      @units = units unless units == SKIP
+      @order_type = order_type unless order_type == SKIP
+      @order_date = order_date unless order_date == SKIP
+      @unit_price = unit_price unless unit_price == SKIP
+      @unit_type = unit_type unless unit_type == SKIP
+      @order_duration = order_duration unless order_duration == SKIP
+      @sub_account = sub_account unless sub_account == SKIP
+      @limit_price = limit_price unless limit_price == SKIP
+      @stop_price = stop_price unless stop_price == SKIP
+      @inv401k_source = inv401k_source unless inv401k_source == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      order_id = hash.key?('orderId') ? hash['orderId'] : SKIP
+      security_id = hash.key?('securityId') ? hash['securityId'] : SKIP
+      security_id_type =
+        hash.key?('securityIdType') ? hash['securityIdType'] : SKIP
+      symbol = hash.key?('symbol') ? hash['symbol'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      units = hash.key?('units') ? hash['units'] : SKIP
+      order_type = hash.key?('orderType') ? hash['orderType'] : SKIP
+      order_date = hash.key?('orderDate') ? hash['orderDate'] : SKIP
+      unit_price = hash.key?('unitPrice') ? hash['unitPrice'] : SKIP
+      unit_type = hash.key?('unitType') ? hash['unitType'] : SKIP
+      order_duration = hash.key?('orderDuration') ? hash['orderDuration'] : SKIP
+      sub_account = hash.key?('subAccount') ? hash['subAccount'] : SKIP
+      limit_price = hash.key?('limitPrice') ? hash['limitPrice'] : SKIP
+      stop_price = hash.key?('stopPrice') ? hash['stopPrice'] : SKIP
+      inv401k_source = hash.key?('inv401kSource') ? hash['inv401kSource'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      OpenOrderEntity.new(order_id: order_id,
+                          security_id: security_id,
+                          security_id_type: security_id_type,
+                          symbol: symbol,
+                          description: description,
+                          units: units,
+                          order_type: order_type,
+                          order_date: order_date,
+                          unit_price: unit_price,
+                          unit_type: unit_type,
+                          order_duration: order_duration,
+                          sub_account: sub_account,
+                          limit_price: limit_price,
+                          stop_price: stop_price,
+                          inv401k_source: inv401k_source,
+                          additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OpenOrderEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_id: #{@order_id}, security_id: #{@security_id}, security_id_type:"\
+      " #{@security_id_type}, symbol: #{@symbol}, description: #{@description}, units: #{@units},"\
+      " order_type: #{@order_type}, order_date: #{@order_date}, unit_price: #{@unit_price},"\
+      " unit_type: #{@unit_type}, order_duration: #{@order_duration}, sub_account:"\
+      " #{@sub_account}, limit_price: #{@limit_price}, stop_price: #{@stop_price}, inv401k_source:"\
+      " #{@inv401k_source}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_id: #{@order_id.inspect}, security_id: #{@security_id.inspect},"\
+      " security_id_type: #{@security_id_type.inspect}, symbol: #{@symbol.inspect}, description:"\
+      " #{@description.inspect}, units: #{@units.inspect}, order_type: #{@order_type.inspect},"\
+      " order_date: #{@order_date.inspect}, unit_price: #{@unit_price.inspect}, unit_type:"\
+      " #{@unit_type.inspect}, order_duration: #{@order_duration.inspect}, sub_account:"\
+      " #{@sub_account.inspect}, limit_price: #{@limit_price.inspect}, stop_price:"\
+      " #{@stop_price.inspect}, inv401k_source: #{@inv401k_source.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/operation_entity.rb

@@ -0,0 +1,161 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxV660Api
+  # Definition of a supported API for the /capability response object
+  class OperationEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Operation ID (e.g. name) of this API
+    # @return [FdxResourceOperationId1]
+    attr_accessor :id
+
+    # Whether and how this API is currently supported
+    # @return [AvailabilityEntity1]
+    attr_accessor :availability
+
+    # Additional FDX API endpoints supported at this API, e.g. Transactions
+    # within Accounts, or TxImages within Transactions
+    # @return [Array[FdxResourceOperationId]]
+    attr_accessor :also_supported
+
+    # Data provider's implementation version number for this operation, which is
+    # unrelated to the FDX API version
+    # @return [String]
+    attr_accessor :version
+
+    # FDX schema versions supported at this endpoint
+    # @return [Array[FdxVersion]]
+    attr_accessor :fdx_versions
+
+    # HTTP response media types supported at this endpoint
+    # @return [Array[ContentTypes]]
+    attr_accessor :content_types
+
+    # Cut off time for same-day execution of activity request submitted to this
+    # API. Alternatively, the as-of time when EOD account balances are typically
+    # set
+    # @return [DateTime]
+    attr_accessor :cut_off_time
+
+    # General HATEOAS link for this API, specifying supported action (GET, POST,
+    # etc) and contentTypes (application/json, image/png, etc), but without any
+    # path parameter values
+    # @return [HateoasLink4]
+    attr_accessor :link
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['availability'] = 'availability'
+      @_hash['also_supported'] = 'alsoSupported'
+      @_hash['version'] = 'version'
+      @_hash['fdx_versions'] = 'fdxVersions'
+      @_hash['content_types'] = 'contentTypes'
+      @_hash['cut_off_time'] = 'cutOffTime'
+      @_hash['link'] = 'link'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        availability
+        also_supported
+        version
+        fdx_versions
+        content_types
+        cut_off_time
+        link
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id: SKIP, availability: SKIP, also_supported: SKIP,
+                   version: SKIP, fdx_versions: SKIP, content_types: SKIP,
+                   cut_off_time: SKIP, link: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @availability = availability unless availability == SKIP
+      @also_supported = also_supported unless also_supported == SKIP
+      @version = version unless version == SKIP
+      @fdx_versions = fdx_versions unless fdx_versions == SKIP
+      @content_types = content_types unless content_types == SKIP
+      @cut_off_time = cut_off_time unless cut_off_time == SKIP
+      @link = link unless link == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      availability = AvailabilityEntity1.from_hash(hash['availability']) if hash['availability']
+      also_supported = hash.key?('alsoSupported') ? hash['alsoSupported'] : SKIP
+      version = hash.key?('version') ? hash['version'] : SKIP
+      fdx_versions = hash.key?('fdxVersions') ? hash['fdxVersions'] : SKIP
+      content_types = hash.key?('contentTypes') ? hash['contentTypes'] : SKIP
+      cut_off_time = if hash.key?('cutOffTime')
+                       (DateTimeHelper.from_rfc3339(hash['cutOffTime']) if hash['cutOffTime'])
+                     else
+                       SKIP
+                     end
+      link = HateoasLink4.from_hash(hash['link']) if hash['link']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      OperationEntity.new(id: id,
+                          availability: availability,
+                          also_supported: also_supported,
+                          version: version,
+                          fdx_versions: fdx_versions,
+                          content_types: content_types,
+                          cut_off_time: cut_off_time,
+                          link: link,
+                          additional_properties: additional_properties)
+    end
+
+    def to_custom_cut_off_time
+      DateTimeHelper.to_rfc3339(cut_off_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, availability: #{@availability}, also_supported:"\
+      " #{@also_supported}, version: #{@version}, fdx_versions: #{@fdx_versions}, content_types:"\
+      " #{@content_types}, cut_off_time: #{@cut_off_time}, link: #{@link}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, availability: #{@availability.inspect}, also_supported:"\
+      " #{@also_supported.inspect}, version: #{@version.inspect}, fdx_versions:"\
+      " #{@fdx_versions.inspect}, content_types: #{@content_types.inspect}, cut_off_time:"\
+      " #{@cut_off_time.inspect}, link: #{@link.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/option_security_entity.rb

@@ -0,0 +1,147 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'security_entity'
+
+module FdxV660Api
+  # An option
+  class OptionSecurityEntity < SecurityEntity
+    # How the option is secured. One of NAKED, COVERED
+    # @return [Secured2]
+    attr_accessor :secured
+
+    # Option type. One of PUT, CALL
+    # @return [OptionType2]
+    attr_accessor :option_type
+
+    # Strike price / Unit price
+    # @return [Float]
+    attr_accessor :strike_price
+
+    # Expiration date of option
+    # @return [Date]
+    attr_accessor :expire_date
+
+    # Shares per contract
+    # @return [Float]
+    attr_accessor :shares_per_contract
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['secured'] = 'secured'
+      @_hash['option_type'] = 'optionType'
+      @_hash['strike_price'] = 'strikePrice'
+      @_hash['expire_date'] = 'expireDate'
+      @_hash['shares_per_contract'] = 'sharesPerContract'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        secured
+        option_type
+        strike_price
+        expire_date
+        shares_per_contract
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(secured: SKIP, option_type: SKIP, strike_price: SKIP,
+                   expire_date: SKIP, shares_per_contract: SKIP,
+                   security_category: 'Option Security entity',
+                   fi_attributes: SKIP, additional_properties: nil)
+      @secured = secured unless secured == SKIP
+      @option_type = option_type unless option_type == SKIP
+      @strike_price = strike_price unless strike_price == SKIP
+      @expire_date = expire_date unless expire_date == SKIP
+      @shares_per_contract = shares_per_contract unless shares_per_contract == SKIP
+      @additional_properties = additional_properties
+
+      # Call the constructor of the base class
+      super(security_category: security_category,
+            fi_attributes: fi_attributes,
+            additional_properties: additional_properties)
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      secured = hash.key?('secured') ? hash['secured'] : SKIP
+      option_type = hash.key?('optionType') ? hash['optionType'] : SKIP
+      strike_price = hash.key?('strikePrice') ? hash['strikePrice'] : SKIP
+      expire_date = hash.key?('expireDate') ? hash['expireDate'] : SKIP
+      shares_per_contract =
+        hash.key?('sharesPerContract') ? hash['sharesPerContract'] : SKIP
+      security_category = hash['securityCategory'] ||= 'Option Security entity'
+      # Parameter is an array, so we need to iterate through it
+      fi_attributes = nil
+      unless hash['fiAttributes'].nil?
+        fi_attributes = []
+        hash['fiAttributes'].each do |structure|
+          fi_attributes << (FiAttributeEntity.from_hash(structure) if structure)
+        end
+      end
+
+      fi_attributes = SKIP unless hash.key?('fiAttributes')
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      OptionSecurityEntity.new(secured: secured,
+                               option_type: option_type,
+                               strike_price: strike_price,
+                               expire_date: expire_date,
+                               shares_per_contract: shares_per_contract,
+                               security_category: security_category,
+                               fi_attributes: fi_attributes,
+                               additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OptionSecurityEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, secured: #{@secured}, option_type: #{@option_type},"\
+      " strike_price: #{@strike_price}, expire_date: #{@expire_date}, shares_per_contract:"\
+      " #{@shares_per_contract}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      super_string = super().inspect.sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, secured: #{@secured.inspect}, option_type:"\
+      " #{@option_type.inspect}, strike_price: #{@strike_price.inspect}, expire_date:"\
+      " #{@expire_date.inspect}, shares_per_contract: #{@shares_per_contract.inspect}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/option_type.rb

@@ -0,0 +1,36 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The type of a stock option
+  class OptionType
+    OPTION_TYPE = [
+      # TODO: Write general description for CALL
+      CALL = 'CALL'.freeze,
+
+      # TODO: Write general description for PUT
+      PUT = 'PUT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CALL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'call' then CALL
+      when 'put' then PUT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/option_type2.rb

@@ -0,0 +1,36 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Option type. One of PUT, CALL
+  class OptionType2
+    OPTION_TYPE2 = [
+      # TODO: Write general description for CALL
+      CALL = 'CALL'.freeze,
+
+      # TODO: Write general description for PUT
+      PUT = 'PUT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CALL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'call' then CALL
+      when 'put' then PUT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/order_duration.rb

@@ -0,0 +1,40 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The duration of the order
+  class OrderDuration
+    ORDER_DURATION = [
+      # TODO: Write general description for DAY
+      DAY = 'DAY'.freeze,
+
+      # TODO: Write general description for GOODTILLCANCEL
+      GOODTILLCANCEL = 'GOODTILLCANCEL'.freeze,
+
+      # TODO: Write general description for IMMEDIATE
+      IMMEDIATE = 'IMMEDIATE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'day' then DAY
+      when 'goodtillcancel' then GOODTILLCANCEL
+      when 'immediate' then IMMEDIATE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/order_duration2.rb

@@ -0,0 +1,40 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # This order is good for DAY, GOODTILLCANCEL, IMMEDIATE
+  class OrderDuration2
+    ORDER_DURATION2 = [
+      # TODO: Write general description for DAY
+      DAY = 'DAY'.freeze,
+
+      # TODO: Write general description for GOODTILLCANCEL
+      GOODTILLCANCEL = 'GOODTILLCANCEL'.freeze,
+
+      # TODO: Write general description for IMMEDIATE
+      IMMEDIATE = 'IMMEDIATE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'day' then DAY
+      when 'goodtillcancel' then GOODTILLCANCEL
+      when 'immediate' then IMMEDIATE
+      else
+        default_value
+      end
+    end
+  end
+end