fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/operation_entity.rb

@@ -0,0 +1,150 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module FdxApi
+  # 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
+
+    # 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 [HateoasLink]
+    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['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
+        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, 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
+      @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
+      cut_off_time = if hash.key?('cutOffTime')
+                       (DateTimeHelper.from_rfc3339(hash['cutOffTime']) if hash['cutOffTime'])
+                     else
+                       SKIP
+                     end
+      link = HateoasLink.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,
+                          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}, 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}, cut_off_time: #{@cut_off_time.inspect}, link: #{@link.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/option_security_entity.rb

@@ -0,0 +1,135 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'security_entity'
+
+module FdxApi
+  # 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',
+                   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,
+            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'
+
+      # 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,
+                               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_api/models/option_type.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+  end
+end

data/lib/fdx_api/models/option_type2.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+  end
+end

data/lib/fdx_api/models/order_duration.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+  end
+end

data/lib/fdx_api/models/order_duration2.rb

@@ -0,0 +1,26 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # 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
+  end
+end

data/lib/fdx_api/models/order_type.rb

@@ -0,0 +1,41 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The type of the order
+  class OrderType
+    ORDER_TYPE = [
+      # TODO: Write general description for BUY
+      BUY = 'BUY'.freeze,
+
+      # TODO: Write general description for BUYTOCOVER
+      BUYTOCOVER = 'BUYTOCOVER'.freeze,
+
+      # TODO: Write general description for BUYTOOPEN
+      BUYTOOPEN = 'BUYTOOPEN'.freeze,
+
+      # TODO: Write general description for SELL
+      SELL = 'SELL'.freeze,
+
+      # TODO: Write general description for SELLCLOSE
+      SELLCLOSE = 'SELLCLOSE'.freeze,
+
+      # TODO: Write general description for SELLSHORT
+      SELLSHORT = 'SELLSHORT'.freeze,
+
+      # TODO: Write general description for SELLTOCOVER
+      SELLTOCOVER = 'SELLTOCOVER'.freeze,
+
+      # TODO: Write general description for SELLTOOPEN
+      SELLTOOPEN = 'SELLTOOPEN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/order_type2.rb

@@ -0,0 +1,42 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of order. One of BUY, SELL, BUYTOCOVER, BUYTOOPEN, SELLTOCOVER,
+  # SELLTOOPEN,  SELLSHORT, SELLCLOSE
+  class OrderType2
+    ORDER_TYPE2 = [
+      # TODO: Write general description for BUY
+      BUY = 'BUY'.freeze,
+
+      # TODO: Write general description for BUYTOCOVER
+      BUYTOCOVER = 'BUYTOCOVER'.freeze,
+
+      # TODO: Write general description for BUYTOOPEN
+      BUYTOOPEN = 'BUYTOOPEN'.freeze,
+
+      # TODO: Write general description for SELL
+      SELL = 'SELL'.freeze,
+
+      # TODO: Write general description for SELLCLOSE
+      SELLCLOSE = 'SELLCLOSE'.freeze,
+
+      # TODO: Write general description for SELLSHORT
+      SELLSHORT = 'SELLSHORT'.freeze,
+
+      # TODO: Write general description for SELLTOCOVER
+      SELLTOCOVER = 'SELLTOCOVER'.freeze,
+
+      # TODO: Write general description for SELLTOOPEN
+      SELLTOOPEN = 'SELLTOOPEN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/organization_name_entity.rb

@@ -0,0 +1,87 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Logical grouping of name attributes that are particular to an Organization
+  # type of payment initiation party
+  class OrganizationNameEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name value of the organization
+    # @return [String]
+    attr_accessor :company_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['company_name'] = 'companyName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        company_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(company_name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @company_name = company_name unless company_name == 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.
+      company_name = hash.key?('companyName') ? hash['companyName'] : 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.
+      OrganizationNameEntity.new(company_name: company_name,
+                                 additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [OrganizationNameEntity | 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} company_name: #{@company_name}, 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} company_name: #{@company_name.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/other_monetary_amount.rb

@@ -0,0 +1,94 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # A monetary amount with its source name and its currency code
+  class OtherMonetaryAmount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The monetary amount
+    # @return [Float]
+    attr_accessor :amount
+
+    # Currency code of the monetary amount
+    # @return [Iso4217CurrencyCode]
+    attr_accessor :currency
+
+    # The source name of this monetary amount
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currency
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, currency: SKIP, name: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount
+      @currency = currency unless currency == SKIP
+      @name = name unless name == 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.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      name = hash.key?('name') ? hash['name'] : 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.
+      OtherMonetaryAmount.new(amount: amount,
+                              currency: currency,
+                              name: name,
+                              additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, currency: #{@currency}, name: #{@name},"\
+      " 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} amount: #{@amount.inspect}, currency: #{@currency.inspect}, name:"\
+      " #{@name.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end