fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/security_type.rb

@@ -0,0 +1,51 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The type of a security   | Value | Description |   |-----|-----|   | BOND |
+  # Debt security as a loan to a government, agency or company, repaid with
+  # interest |   | DEBT | Any type of security that must be paid back in full
+  # along with interest |   | DIGITALASSET | Digital representation of an asset
+  # or right that is stored and transferred on a digital network such as the
+  # internet or a blockchain |   | MUTUALFUND | Pooled collection of assets
+  # invested in stocks, bonds, and other securities |   | OPTION | The right to
+  # buy a specific number of stock shares at a pre-set price |   | OTHER |
+  # Another type of security not listed here |   | STOCK | A share in the
+  # ownership of a company |   | SWEEP | Interest-earning account used to
+  # collect low- or non-interest-earning cash at close of day |
+  class SecurityType
+    SECURITY_TYPE = [
+      # TODO: Write general description for BOND
+      BOND = 'BOND'.freeze,
+
+      # TODO: Write general description for DEBT
+      DEBT = 'DEBT'.freeze,
+
+      # TODO: Write general description for DIGITALASSET
+      DIGITALASSET = 'DIGITALASSET'.freeze,
+
+      # TODO: Write general description for MUTUALFUND
+      MUTUALFUND = 'MUTUALFUND'.freeze,
+
+      # TODO: Write general description for OPTION
+      OPTION = 'OPTION'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for STOCK
+      STOCK = 'STOCK'.freeze,
+
+      # TODO: Write general description for SWEEP
+      SWEEP = 'SWEEP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/security_type2.rb

@@ -0,0 +1,41 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # BOND, DEBT, DIGITALASSET, MUTUALFUND, OPTION, OTHER, STOCK, SWEEP
+  class SecurityType2
+    SECURITY_TYPE2 = [
+      # TODO: Write general description for BOND
+      BOND = 'BOND'.freeze,
+
+      # TODO: Write general description for DEBT
+      DEBT = 'DEBT'.freeze,
+
+      # TODO: Write general description for DIGITALASSET
+      DIGITALASSET = 'DIGITALASSET'.freeze,
+
+      # TODO: Write general description for MUTUALFUND
+      MUTUALFUND = 'MUTUALFUND'.freeze,
+
+      # TODO: Write general description for OPTION
+      OPTION = 'OPTION'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for STOCK
+      STOCK = 'STOCK'.freeze,
+
+      # TODO: Write general description for SWEEP
+      SWEEP = 'SWEEP'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/state_and_local_tax_withholding.rb

@@ -0,0 +1,95 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Income in a state and/or locality and its or their tax withholding
+  class StateAndLocalTaxWithholding < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # State two-digit code
+    # @return [StateCode]
+    attr_accessor :state_code
+
+    # Amount of state income tax withheld
+    # @return [StateTaxWithholding2]
+    attr_accessor :state
+
+    # Amount of local income tax withheld, if any
+    # @return [LocalTaxWithholding1]
+    attr_accessor :local
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['state_code'] = 'stateCode'
+      @_hash['state'] = 'state'
+      @_hash['local'] = 'local'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        state_code
+        state
+        local
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(state_code: SKIP, state: SKIP, local: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @state_code = state_code unless state_code == SKIP
+      @state = state unless state == SKIP
+      @local = local unless local == 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.
+      state_code = hash.key?('stateCode') ? hash['stateCode'] : SKIP
+      state = StateTaxWithholding2.from_hash(hash['state']) if hash['state']
+      local = LocalTaxWithholding1.from_hash(hash['local']) if hash['local']
+
+      # 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.
+      StateAndLocalTaxWithholding.new(state_code: state_code,
+                                      state: state,
+                                      local: local,
+                                      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} state_code: #{@state_code}, state: #{@state}, local: #{@local},"\
+      " 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} state_code: #{@state_code.inspect}, state: #{@state.inspect}, local:"\
+      " #{@local.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/state_and_local_tax_withholding1.rb

@@ -0,0 +1,95 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Box 17, State and Local tax withholding
+  class StateAndLocalTaxWithholding1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # State two-digit code
+    # @return [StateCode]
+    attr_accessor :state_code
+
+    # Amount of state income tax withheld
+    # @return [StateTaxWithholding2]
+    attr_accessor :state
+
+    # Amount of local income tax withheld, if any
+    # @return [LocalTaxWithholding1]
+    attr_accessor :local
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['state_code'] = 'stateCode'
+      @_hash['state'] = 'state'
+      @_hash['local'] = 'local'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        state_code
+        state
+        local
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(state_code: SKIP, state: SKIP, local: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @state_code = state_code unless state_code == SKIP
+      @state = state unless state == SKIP
+      @local = local unless local == 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.
+      state_code = hash.key?('stateCode') ? hash['stateCode'] : SKIP
+      state = StateTaxWithholding2.from_hash(hash['state']) if hash['state']
+      local = LocalTaxWithholding1.from_hash(hash['local']) if hash['local']
+
+      # 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.
+      StateAndLocalTaxWithholding1.new(state_code: state_code,
+                                       state: state,
+                                       local: local,
+                                       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} state_code: #{@state_code}, state: #{@state}, local: #{@local},"\
+      " 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} state_code: #{@state_code.inspect}, state: #{@state.inspect}, local:"\
+      " #{@local.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/state_and_local_tax_withholding2.rb

@@ -0,0 +1,95 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # State and Local tax withholding, from IRS's IRIS schema
+  class StateAndLocalTaxWithholding2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # State two-digit code
+    # @return [StateCode]
+    attr_accessor :state_code
+
+    # Amount of state income tax withheld
+    # @return [StateTaxWithholding2]
+    attr_accessor :state
+
+    # Amount of local income tax withheld, if any
+    # @return [LocalTaxWithholding1]
+    attr_accessor :local
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['state_code'] = 'stateCode'
+      @_hash['state'] = 'state'
+      @_hash['local'] = 'local'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        state_code
+        state
+        local
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(state_code: SKIP, state: SKIP, local: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @state_code = state_code unless state_code == SKIP
+      @state = state unless state == SKIP
+      @local = local unless local == 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.
+      state_code = hash.key?('stateCode') ? hash['stateCode'] : SKIP
+      state = StateTaxWithholding2.from_hash(hash['state']) if hash['state']
+      local = LocalTaxWithholding1.from_hash(hash['local']) if hash['local']
+
+      # 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.
+      StateAndLocalTaxWithholding2.new(state_code: state_code,
+                                       state: state,
+                                       local: local,
+                                       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} state_code: #{@state_code}, state: #{@state}, local: #{@local},"\
+      " 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} state_code: #{@state_code.inspect}, state: #{@state.inspect}, local:"\
+      " #{@local.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/state_code.rb

@@ -0,0 +1,203 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # State two-digit code
+  class StateCode
+    STATE_CODE = [
+      # TODO: Write general description for AA
+      AA = 'AA'.freeze,
+
+      # TODO: Write general description for AE
+      AE = 'AE'.freeze,
+
+      # TODO: Write general description for AK
+      AK = 'AK'.freeze,
+
+      # TODO: Write general description for AL
+      AL = 'AL'.freeze,
+
+      # TODO: Write general description for AP
+      AP = 'AP'.freeze,
+
+      # TODO: Write general description for AR
+      AR = 'AR'.freeze,
+
+      # TODO: Write general description for AS
+      AS = 'AS'.freeze,
+
+      # TODO: Write general description for AZ
+      AZ = 'AZ'.freeze,
+
+      # TODO: Write general description for CA
+      CA = 'CA'.freeze,
+
+      # TODO: Write general description for CO
+      CO = 'CO'.freeze,
+
+      # TODO: Write general description for CT
+      CT = 'CT'.freeze,
+
+      # TODO: Write general description for DC
+      DC = 'DC'.freeze,
+
+      # TODO: Write general description for DE
+      DE = 'DE'.freeze,
+
+      # TODO: Write general description for FL
+      FL = 'FL'.freeze,
+
+      # TODO: Write general description for FM
+      FM = 'FM'.freeze,
+
+      # TODO: Write general description for GA
+      GA = 'GA'.freeze,
+
+      # TODO: Write general description for GU
+      GU = 'GU'.freeze,
+
+      # TODO: Write general description for HI
+      HI = 'HI'.freeze,
+
+      # TODO: Write general description for IA
+      IA = 'IA'.freeze,
+
+      # TODO: Write general description for ID
+      ID = 'ID'.freeze,
+
+      # TODO: Write general description for IL
+      IL = 'IL'.freeze,
+
+      # TODO: Write general description for IN
+      IN = 'IN'.freeze,
+
+      # TODO: Write general description for KS
+      KS = 'KS'.freeze,
+
+      # TODO: Write general description for KY
+      KY = 'KY'.freeze,
+
+      # TODO: Write general description for LA
+      LA = 'LA'.freeze,
+
+      # TODO: Write general description for MA
+      MA = 'MA'.freeze,
+
+      # TODO: Write general description for MD
+      MD = 'MD'.freeze,
+
+      # TODO: Write general description for ME
+      ME = 'ME'.freeze,
+
+      # TODO: Write general description for MH
+      MH = 'MH'.freeze,
+
+      # TODO: Write general description for MI
+      MI = 'MI'.freeze,
+
+      # TODO: Write general description for MN
+      MN = 'MN'.freeze,
+
+      # TODO: Write general description for MO
+      MO = 'MO'.freeze,
+
+      # TODO: Write general description for MP
+      MP = 'MP'.freeze,
+
+      # TODO: Write general description for MS
+      MS = 'MS'.freeze,
+
+      # TODO: Write general description for MT
+      MT = 'MT'.freeze,
+
+      # TODO: Write general description for NC
+      NC = 'NC'.freeze,
+
+      # TODO: Write general description for ND
+      ND = 'ND'.freeze,
+
+      # TODO: Write general description for NE
+      NE = 'NE'.freeze,
+
+      # TODO: Write general description for NH
+      NH = 'NH'.freeze,
+
+      # TODO: Write general description for NJ
+      NJ = 'NJ'.freeze,
+
+      # TODO: Write general description for NM
+      NM = 'NM'.freeze,
+
+      # TODO: Write general description for NV
+      NV = 'NV'.freeze,
+
+      # TODO: Write general description for NY
+      NY = 'NY'.freeze,
+
+      # TODO: Write general description for OH
+      OH = 'OH'.freeze,
+
+      # TODO: Write general description for OK
+      OK = 'OK'.freeze,
+
+      # TODO: Write general description for OR
+      OR = 'OR'.freeze,
+
+      # TODO: Write general description for PA
+      PA = 'PA'.freeze,
+
+      # TODO: Write general description for PR
+      PR = 'PR'.freeze,
+
+      # TODO: Write general description for PW
+      PW = 'PW'.freeze,
+
+      # TODO: Write general description for RI
+      RI = 'RI'.freeze,
+
+      # TODO: Write general description for SC
+      SC = 'SC'.freeze,
+
+      # TODO: Write general description for SD
+      SD = 'SD'.freeze,
+
+      # TODO: Write general description for TN
+      TN = 'TN'.freeze,
+
+      # TODO: Write general description for TX
+      TX = 'TX'.freeze,
+
+      # TODO: Write general description for UT
+      UT = 'UT'.freeze,
+
+      # TODO: Write general description for VA
+      VA = 'VA'.freeze,
+
+      # TODO: Write general description for VI
+      VI = 'VI'.freeze,
+
+      # TODO: Write general description for VT
+      VT = 'VT'.freeze,
+
+      # TODO: Write general description for WA
+      WA = 'WA'.freeze,
+
+      # TODO: Write general description for WI
+      WI = 'WI'.freeze,
+
+      # TODO: Write general description for WV
+      WV = 'WV'.freeze,
+
+      # TODO: Write general description for WY
+      WY = 'WY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/state_tax_withholding.rb

@@ -0,0 +1,95 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Income in a state and its tax withholding
+  class StateTaxWithholding < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount of state income tax withheld
+    # @return [Float]
+    attr_accessor :tax_withheld
+
+    # Filer's state tax id
+    # @return [String]
+    attr_accessor :tax_id
+
+    # Income amount for state tax purposes
+    # @return [Float]
+    attr_accessor :income
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_withheld'] = 'taxWithheld'
+      @_hash['tax_id'] = 'taxId'
+      @_hash['income'] = 'income'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_withheld
+        tax_id
+        income
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_withheld: SKIP, tax_id: SKIP, income: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_withheld = tax_withheld unless tax_withheld == SKIP
+      @tax_id = tax_id unless tax_id == SKIP
+      @income = income unless income == 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.
+      tax_withheld = hash.key?('taxWithheld') ? hash['taxWithheld'] : SKIP
+      tax_id = hash.key?('taxId') ? hash['taxId'] : SKIP
+      income = hash.key?('income') ? hash['income'] : 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.
+      StateTaxWithholding.new(tax_withheld: tax_withheld,
+                              tax_id: tax_id,
+                              income: income,
+                              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} tax_withheld: #{@tax_withheld}, tax_id: #{@tax_id}, income: #{@income},"\
+      " 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} tax_withheld: #{@tax_withheld.inspect}, tax_id: #{@tax_id.inspect}, income:"\
+      " #{@income.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end