fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/data_provider_records_at_ecosystem_registry.rb

@@ -0,0 +1,105 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Data provider records at Ecosystem Registry. Properties in this structure
+  # use 'snake_case' names to match the properties in [IETF RFC
+  # 7591](https://datatracker.ietf.org/doc/rfc7591/).
+  class DataProviderRecordsAtEcosystemRegistry < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Page keys for navigating result sets
+    # @return [PageMetadata]
+    attr_accessor :page
+
+    # Resource URLs for navigating result sets
+    # @return [PageMetadataLinks1]
+    attr_accessor :links
+
+    # Data providers retrieved by the operation
+    # @return [Array[DataProviderAtEcosystemRegistry]]
+    attr_accessor :data_providers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['links'] = 'links'
+      @_hash['data_providers'] = 'data_providers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data_providers:, page: SKIP, links: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page unless page == SKIP
+      @links = links unless links == SKIP
+      @data_providers = data_providers
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      data_providers = nil
+      unless hash['data_providers'].nil?
+        data_providers = []
+        hash['data_providers'].each do |structure|
+          data_providers << (DataProviderAtEcosystemRegistry.from_hash(structure) if structure)
+        end
+      end
+
+      data_providers = nil unless hash.key?('data_providers')
+      page = PageMetadata.from_hash(hash['page']) if hash['page']
+      links = PageMetadataLinks1.from_hash(hash['links']) if hash['links']
+
+      # 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.
+      DataProviderRecordsAtEcosystemRegistry.new(data_providers: data_providers,
+                                                 page: page,
+                                                 links: links,
+                                                 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} page: #{@page}, links: #{@links}, data_providers: #{@data_providers},"\
+      " 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} page: #{@page.inspect}, links: #{@links.inspect}, data_providers:"\
+      " #{@data_providers.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/date_and_amount.rb

@@ -0,0 +1,95 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Date, description, and amount. When used in 1098-Q, description is optional
+  class DateAndAmount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Date of amount. When used in 1098-Q, date of last payment in month
+    # @return [Date]
+    attr_accessor :date
+
+    # Description of amount. When used in 1098-Q, may use MonthAbbreviation
+    # @return [String]
+    attr_accessor :description
+
+    # Amount of payment or receipt. When used in 1098-Q, monthly total
+    # @return [Float]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['date'] = 'date'
+      @_hash['description'] = 'description'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        date
+        description
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(date: SKIP, description: SKIP, amount: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @date = date unless date == SKIP
+      @description = description unless description == SKIP
+      @amount = amount unless amount == 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.
+      date = hash.key?('date') ? hash['date'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : 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.
+      DateAndAmount.new(date: date,
+                        description: description,
+                        amount: amount,
+                        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} date: #{@date}, description: #{@description}, amount: #{@amount},"\
+      " 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} date: #{@date.inspect}, description: #{@description.inspect}, amount:"\
+      " #{@amount.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/debit_credit_memo.rb

@@ -0,0 +1,40 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The posting type of a transaction
+  class DebitCreditMemo
+    DEBIT_CREDIT_MEMO = [
+      # TODO: Write general description for CREDIT
+      CREDIT = 'CREDIT'.freeze,
+
+      # TODO: Write general description for DEBIT
+      DEBIT = 'DEBIT'.freeze,
+
+      # TODO: Write general description for MEMO
+      MEMO = 'MEMO'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CREDIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'credit' then CREDIT
+      when 'debit' then DEBIT
+      when 'memo' then MEMO
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/debit_credit_memo2.rb

@@ -0,0 +1,40 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # DEBIT, CREDIT, MEMO
+  class DebitCreditMemo2
+    DEBIT_CREDIT_MEMO2 = [
+      # TODO: Write general description for CREDIT
+      CREDIT = 'CREDIT'.freeze,
+
+      # TODO: Write general description for DEBIT
+      DEBIT = 'DEBIT'.freeze,
+
+      # TODO: Write general description for MEMO
+      MEMO = 'MEMO'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CREDIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'credit' then CREDIT
+      when 'debit' then DEBIT
+      when 'memo' then MEMO
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/debt_class.rb

@@ -0,0 +1,44 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The classification of a debt instrument
+  class DebtClass
+    DEBT_CLASS = [
+      # TODO: Write general description for CORPORATE
+      CORPORATE = 'CORPORATE'.freeze,
+
+      # TODO: Write general description for MUNICIPAL
+      MUNICIPAL = 'MUNICIPAL'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for TREASURY
+      TREASURY = 'TREASURY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CORPORATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'corporate' then CORPORATE
+      when 'municipal' then MUNICIPAL
+      when 'other' then OTHER
+      when 'treasury' then TREASURY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/debt_class2.rb

@@ -0,0 +1,44 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Classification of debt. One of TREASURY, MUNICIPAL, CORPORATE, OTHER
+  class DebtClass2
+    DEBT_CLASS2 = [
+      # TODO: Write general description for CORPORATE
+      CORPORATE = 'CORPORATE'.freeze,
+
+      # TODO: Write general description for MUNICIPAL
+      MUNICIPAL = 'MUNICIPAL'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for TREASURY
+      TREASURY = 'TREASURY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = CORPORATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'corporate' then CORPORATE
+      when 'municipal' then MUNICIPAL
+      when 'other' then OTHER
+      when 'treasury' then TREASURY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/debt_security_entity.rb

@@ -0,0 +1,240 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'security_entity'
+
+module FdxV660Api
+  # An investment in a debt security
+  class DebtSecurityEntity < SecurityEntity
+    # Par value amount
+    # @return [Float]
+    attr_accessor :par_value
+
+    # Debt type. One of COUPON, ZERO
+    # @return [DebtType2]
+    attr_accessor :debt_type
+
+    # Classification of debt. One of TREASURY, MUNICIPAL, CORPORATE, OTHER
+    # @return [DebtClass2]
+    attr_accessor :debt_class
+
+    # Bond coupon rate for next closest call date
+    # @return [Float]
+    attr_accessor :coupon_rate
+
+    # Maturity date for next coupon
+    # @return [Date]
+    attr_accessor :coupon_date
+
+    # When coupons mature. One of MONTHLY, QUARTERLY, SEMIANNUAL, ANNUAL, OTHER
+    # @return [CouponMatureFrequency2]
+    attr_accessor :coupon_mature_frequency
+
+    # Bond call price
+    # @return [Float]
+    attr_accessor :call_price
+
+    # Yield to next call
+    # @return [Float]
+    attr_accessor :yield_to_call
+
+    # Next call date
+    # @return [Date]
+    attr_accessor :call_date
+
+    # Type of next call. One of CALL, PUT, PREFUND, MATURITY
+    # @return [CallType2]
+    attr_accessor :call_type
+
+    # Yield to maturity
+    # @return [Float]
+    attr_accessor :yield_to_maturity
+
+    # Bond maturity date
+    # @return [Date]
+    attr_accessor :bond_maturity_date
+
+    # Discriminators mapping.
+    def self.discriminators
+      if @_discriminators.nil?
+        @_discriminators = {}
+        @_discriminators['Bond Security entity'] = BondSecurityEntity
+      end
+      @_discriminators
+    end
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['par_value'] = 'parValue'
+      @_hash['debt_type'] = 'debtType'
+      @_hash['debt_class'] = 'debtClass'
+      @_hash['coupon_rate'] = 'couponRate'
+      @_hash['coupon_date'] = 'couponDate'
+      @_hash['coupon_mature_frequency'] = 'couponMatureFrequency'
+      @_hash['call_price'] = 'callPrice'
+      @_hash['yield_to_call'] = 'yieldToCall'
+      @_hash['call_date'] = 'callDate'
+      @_hash['call_type'] = 'callType'
+      @_hash['yield_to_maturity'] = 'yieldToMaturity'
+      @_hash['bond_maturity_date'] = 'bondMaturityDate'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        par_value
+        debt_type
+        debt_class
+        coupon_rate
+        coupon_date
+        coupon_mature_frequency
+        call_price
+        yield_to_call
+        call_date
+        call_type
+        yield_to_maturity
+        bond_maturity_date
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(par_value: SKIP, debt_type: SKIP, debt_class: SKIP,
+                   coupon_rate: SKIP, coupon_date: SKIP,
+                   coupon_mature_frequency: SKIP, call_price: SKIP,
+                   yield_to_call: SKIP, call_date: SKIP, call_type: SKIP,
+                   yield_to_maturity: SKIP, bond_maturity_date: SKIP,
+                   security_category: 'Debt Security entity',
+                   fi_attributes: SKIP, additional_properties: nil)
+      @par_value = par_value unless par_value == SKIP
+      @debt_type = debt_type unless debt_type == SKIP
+      @debt_class = debt_class unless debt_class == SKIP
+      @coupon_rate = coupon_rate unless coupon_rate == SKIP
+      @coupon_date = coupon_date unless coupon_date == SKIP
+      @coupon_mature_frequency = coupon_mature_frequency unless coupon_mature_frequency == SKIP
+      @call_price = call_price unless call_price == SKIP
+      @yield_to_call = yield_to_call unless yield_to_call == SKIP
+      @call_date = call_date unless call_date == SKIP
+      @call_type = call_type unless call_type == SKIP
+      @yield_to_maturity = yield_to_maturity unless yield_to_maturity == SKIP
+      @bond_maturity_date = bond_maturity_date unless bond_maturity_date == 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
+
+      # Delegate unboxing to another function if a discriminator
+      # value for a child class is present.
+      unboxer = discriminators[hash['securityCategory']]
+      return unboxer.send(:from_hash, hash) if unboxer
+
+      # Extract variables from the hash.
+      par_value = hash.key?('parValue') ? hash['parValue'] : SKIP
+      debt_type = hash.key?('debtType') ? hash['debtType'] : SKIP
+      debt_class = hash.key?('debtClass') ? hash['debtClass'] : SKIP
+      coupon_rate = hash.key?('couponRate') ? hash['couponRate'] : SKIP
+      coupon_date = hash.key?('couponDate') ? hash['couponDate'] : SKIP
+      coupon_mature_frequency =
+        hash.key?('couponMatureFrequency') ? hash['couponMatureFrequency'] : SKIP
+      call_price = hash.key?('callPrice') ? hash['callPrice'] : SKIP
+      yield_to_call = hash.key?('yieldToCall') ? hash['yieldToCall'] : SKIP
+      call_date = hash.key?('callDate') ? hash['callDate'] : SKIP
+      call_type = hash.key?('callType') ? hash['callType'] : SKIP
+      yield_to_maturity =
+        hash.key?('yieldToMaturity') ? hash['yieldToMaturity'] : SKIP
+      bond_maturity_date =
+        hash.key?('bondMaturityDate') ? hash['bondMaturityDate'] : SKIP
+      security_category = hash['securityCategory'] ||= 'Debt 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.
+      DebtSecurityEntity.new(par_value: par_value,
+                             debt_type: debt_type,
+                             debt_class: debt_class,
+                             coupon_rate: coupon_rate,
+                             coupon_date: coupon_date,
+                             coupon_mature_frequency: coupon_mature_frequency,
+                             call_price: call_price,
+                             yield_to_call: yield_to_call,
+                             call_date: call_date,
+                             call_type: call_type,
+                             yield_to_maturity: yield_to_maturity,
+                             bond_maturity_date: bond_maturity_date,
+                             security_category: security_category,
+                             fi_attributes: fi_attributes,
+                             additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [DebtSecurityEntity | 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
+
+      # Delegate validation to another function if a discriminator
+      # value for a child class is present.
+      validator = discriminators[value['securityCategory']]
+      return validator.send(:validate, value) if validator
+
+      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}, par_value: #{@par_value}, debt_type: #{@debt_type},"\
+      " debt_class: #{@debt_class}, coupon_rate: #{@coupon_rate}, coupon_date: #{@coupon_date},"\
+      " coupon_mature_frequency: #{@coupon_mature_frequency}, call_price: #{@call_price},"\
+      " yield_to_call: #{@yield_to_call}, call_date: #{@call_date}, call_type: #{@call_type},"\
+      " yield_to_maturity: #{@yield_to_maturity}, bond_maturity_date: #{@bond_maturity_date}>"
+    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}, par_value: #{@par_value.inspect}, debt_type:"\
+      " #{@debt_type.inspect}, debt_class: #{@debt_class.inspect}, coupon_rate:"\
+      " #{@coupon_rate.inspect}, coupon_date: #{@coupon_date.inspect}, coupon_mature_frequency:"\
+      " #{@coupon_mature_frequency.inspect}, call_price: #{@call_price.inspect}, yield_to_call:"\
+      " #{@yield_to_call.inspect}, call_date: #{@call_date.inspect}, call_type:"\
+      " #{@call_type.inspect}, yield_to_maturity: #{@yield_to_maturity.inspect},"\
+      " bond_maturity_date: #{@bond_maturity_date.inspect}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/debt_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 debt instrument
+  class DebtType
+    DEBT_TYPE = [
+      # TODO: Write general description for COUPON
+      COUPON = 'COUPON'.freeze,
+
+      # TODO: Write general description for ZERO
+      ZERO = 'ZERO'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = COUPON)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'coupon' then COUPON
+      when 'zero' then ZERO
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/debt_type2.rb

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