fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/iso93622014_business_identifier_code_entity.rb

@@ -0,0 +1,93 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # [ISO
+  # 9362:2014](https://www.swift.com/standards/data-standards/bic-business-ident
+  # ifier-code) Business Identifier Code for Financial Institutions (see
+  # [whitepaper](https://www.swift.com/swift-resource/14256/download))
+  # Deprecated and superseded by `Iso9362BusinessIdCode2022` (ISO 9362:2022).
+  # BICFIDec2014Identifier will be removed after multi-year transition from
+  # 9362:2014, expected to end by or before EOY 2026
+  class Iso93622014BusinessIdentifierCodeEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Business identifier code of the financial institution
+    # @return [String]
+    attr_accessor :bic_fi_dec2014_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bic_fi_dec2014_id'] = 'bicFIDec2014Id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bic_fi_dec2014_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(bic_fi_dec2014_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @bic_fi_dec2014_id = bic_fi_dec2014_id unless bic_fi_dec2014_id == 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.
+      bic_fi_dec2014_id =
+        hash.key?('bicFIDec2014Id') ? hash['bicFIDec2014Id'] : 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.
+      Iso93622014BusinessIdentifierCodeEntity.new(bic_fi_dec2014_id: bic_fi_dec2014_id,
+                                                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Iso93622014BusinessIdentifierCodeEntity | 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} bic_fi_dec2014_id: #{@bic_fi_dec2014_id}, 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} bic_fi_dec2014_id: #{@bic_fi_dec2014_id.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/iso93622022_business_identifier_code_entity.rb

@@ -0,0 +1,90 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # [ISO 9362:2022](https://www.iso.org/standard/84108.html) Business Identifier
+  # Code for Financial Institutions (see
+  # [whitepaper](https://www.swift.com/swift-resource/14256/download)),
+  # supersedes ISO 9362:2014
+  class Iso93622022BusinessIdentifierCodeEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO 9362:2022 business identifier code of the financial institution
+    # @return [String]
+    attr_accessor :business_id_code2022
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['business_id_code2022'] = 'businessIdCode2022'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        business_id_code2022
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(business_id_code2022: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @business_id_code2022 = business_id_code2022 unless business_id_code2022 == 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.
+      business_id_code2022 =
+        hash.key?('businessIdCode2022') ? hash['businessIdCode2022'] : 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.
+      Iso93622022BusinessIdentifierCodeEntity.new(business_id_code2022: business_id_code2022,
+                                                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Iso93622022BusinessIdentifierCodeEntity | 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} business_id_code2022: #{@business_id_code2022}, 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} business_id_code2022: #{@business_id_code2022.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/k1_alternative_minimum_tax.rb

@@ -0,0 +1,121 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Form 1065 and 1120-S Schedule K-1 supplemental alternative minimum tax
+  # information
+  class K1AlternativeMinimumTax < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Leased personal property - accelerated depreciation pre-1987 amounts
+    # included in 1065 K-1 box 17 or 1120-S K-1 box 15
+    # @return [Float]
+    attr_accessor :leased_property_depreciation
+
+    # Real property - accelerated depreciation pre-1987 amounts included in 1065
+    # K-1 box 17 or 1120-S K-1 box 15
+    # @return [Float]
+    attr_accessor :real_property_depreciation
+
+    # Oil and gas amounts included in 1065 K-1 box 17 or 1120-S K-1 box 15
+    # @return [K1AlternativeMinimumTaxDrilling3]
+    attr_accessor :oil_and_gas
+
+    # Geothermal amounts included in 1065 K-1 box 17 or 1120-S K-1 box 15
+    # @return [K1AlternativeMinimumTaxDrilling1]
+    attr_accessor :geothermal
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['leased_property_depreciation'] = 'leasedPropertyDepreciation'
+      @_hash['real_property_depreciation'] = 'realPropertyDepreciation'
+      @_hash['oil_and_gas'] = 'oilAndGas'
+      @_hash['geothermal'] = 'geothermal'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        leased_property_depreciation
+        real_property_depreciation
+        oil_and_gas
+        geothermal
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(leased_property_depreciation: SKIP,
+                   real_property_depreciation: SKIP, oil_and_gas: SKIP,
+                   geothermal: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      unless leased_property_depreciation == SKIP
+        @leased_property_depreciation =
+          leased_property_depreciation
+      end
+      unless real_property_depreciation == SKIP
+        @real_property_depreciation =
+          real_property_depreciation
+      end
+      @oil_and_gas = oil_and_gas unless oil_and_gas == SKIP
+      @geothermal = geothermal unless geothermal == 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.
+      leased_property_depreciation =
+        hash.key?('leasedPropertyDepreciation') ? hash['leasedPropertyDepreciation'] : SKIP
+      real_property_depreciation =
+        hash.key?('realPropertyDepreciation') ? hash['realPropertyDepreciation'] : SKIP
+      oil_and_gas = K1AlternativeMinimumTaxDrilling3.from_hash(hash['oilAndGas']) if
+        hash['oilAndGas']
+      geothermal = K1AlternativeMinimumTaxDrilling1.from_hash(hash['geothermal']) if
+        hash['geothermal']
+
+      # 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.
+      K1AlternativeMinimumTax.new(leased_property_depreciation: leased_property_depreciation,
+                                  real_property_depreciation: real_property_depreciation,
+                                  oil_and_gas: oil_and_gas,
+                                  geothermal: geothermal,
+                                  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} leased_property_depreciation: #{@leased_property_depreciation},"\
+      " real_property_depreciation: #{@real_property_depreciation}, oil_and_gas: #{@oil_and_gas},"\
+      " geothermal: #{@geothermal}, 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} leased_property_depreciation: #{@leased_property_depreciation.inspect},"\
+      " real_property_depreciation: #{@real_property_depreciation.inspect}, oil_and_gas:"\
+      " #{@oil_and_gas.inspect}, geothermal: #{@geothermal.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/k1_alternative_minimum_tax1.rb

@@ -0,0 +1,120 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Schedule K-1 Supplemental Alternative Minimum Tax Information
+  class K1AlternativeMinimumTax1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Leased personal property - accelerated depreciation pre-1987 amounts
+    # included in 1065 K-1 box 17 or 1120-S K-1 box 15
+    # @return [Float]
+    attr_accessor :leased_property_depreciation
+
+    # Real property - accelerated depreciation pre-1987 amounts included in 1065
+    # K-1 box 17 or 1120-S K-1 box 15
+    # @return [Float]
+    attr_accessor :real_property_depreciation
+
+    # Oil and gas amounts included in 1065 K-1 box 17 or 1120-S K-1 box 15
+    # @return [K1AlternativeMinimumTaxDrilling3]
+    attr_accessor :oil_and_gas
+
+    # Geothermal amounts included in 1065 K-1 box 17 or 1120-S K-1 box 15
+    # @return [K1AlternativeMinimumTaxDrilling1]
+    attr_accessor :geothermal
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['leased_property_depreciation'] = 'leasedPropertyDepreciation'
+      @_hash['real_property_depreciation'] = 'realPropertyDepreciation'
+      @_hash['oil_and_gas'] = 'oilAndGas'
+      @_hash['geothermal'] = 'geothermal'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        leased_property_depreciation
+        real_property_depreciation
+        oil_and_gas
+        geothermal
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(leased_property_depreciation: SKIP,
+                   real_property_depreciation: SKIP, oil_and_gas: SKIP,
+                   geothermal: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      unless leased_property_depreciation == SKIP
+        @leased_property_depreciation =
+          leased_property_depreciation
+      end
+      unless real_property_depreciation == SKIP
+        @real_property_depreciation =
+          real_property_depreciation
+      end
+      @oil_and_gas = oil_and_gas unless oil_and_gas == SKIP
+      @geothermal = geothermal unless geothermal == 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.
+      leased_property_depreciation =
+        hash.key?('leasedPropertyDepreciation') ? hash['leasedPropertyDepreciation'] : SKIP
+      real_property_depreciation =
+        hash.key?('realPropertyDepreciation') ? hash['realPropertyDepreciation'] : SKIP
+      oil_and_gas = K1AlternativeMinimumTaxDrilling3.from_hash(hash['oilAndGas']) if
+        hash['oilAndGas']
+      geothermal = K1AlternativeMinimumTaxDrilling1.from_hash(hash['geothermal']) if
+        hash['geothermal']
+
+      # 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.
+      K1AlternativeMinimumTax1.new(leased_property_depreciation: leased_property_depreciation,
+                                   real_property_depreciation: real_property_depreciation,
+                                   oil_and_gas: oil_and_gas,
+                                   geothermal: geothermal,
+                                   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} leased_property_depreciation: #{@leased_property_depreciation},"\
+      " real_property_depreciation: #{@real_property_depreciation}, oil_and_gas: #{@oil_and_gas},"\
+      " geothermal: #{@geothermal}, 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} leased_property_depreciation: #{@leased_property_depreciation.inspect},"\
+      " real_property_depreciation: #{@real_property_depreciation.inspect}, oil_and_gas:"\
+      " #{@oil_and_gas.inspect}, geothermal: #{@geothermal.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/k1_alternative_minimum_tax_drilling.rb

@@ -0,0 +1,113 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Supplemental Alternative Minimum Tax Information for Oil and Gas or
+  # Geothermal drilling for Form 1065 Schedule K-1 box 17 or Form 1120-S
+  # Schedule K-1 box 15
+  class K1AlternativeMinimumTaxDrilling < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Oil and gas or Geothermal gross income included in 1065 K-1 box 17 or
+    # 1120-S K-1 box 15
+    # @return [Float]
+    attr_accessor :gross_income
+
+    # Oil and gas or Geothermal deductions included in 1065 K-1 box 17 or 1120-S
+    # K-1 box 15
+    # @return [Float]
+    attr_accessor :deductions
+
+    # Oil and gas or Geothermal excess Intangible Drilling Costs (IDC) included
+    # in 1065 K-1 box 17 or 1120-S K-1 box 15
+    # @return [Float]
+    attr_accessor :excess_idc
+
+    # Oil and gas excess depletion included in 1065 K-1 box 17 or 1120-S K-1 box
+    # 15
+    # @return [Float]
+    attr_accessor :excess_depletion
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['gross_income'] = 'grossIncome'
+      @_hash['deductions'] = 'deductions'
+      @_hash['excess_idc'] = 'excessIdc'
+      @_hash['excess_depletion'] = 'excessDepletion'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        gross_income
+        deductions
+        excess_idc
+        excess_depletion
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(gross_income: SKIP, deductions: SKIP, excess_idc: SKIP,
+                   excess_depletion: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @gross_income = gross_income unless gross_income == SKIP
+      @deductions = deductions unless deductions == SKIP
+      @excess_idc = excess_idc unless excess_idc == SKIP
+      @excess_depletion = excess_depletion unless excess_depletion == 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.
+      gross_income = hash.key?('grossIncome') ? hash['grossIncome'] : SKIP
+      deductions = hash.key?('deductions') ? hash['deductions'] : SKIP
+      excess_idc = hash.key?('excessIdc') ? hash['excessIdc'] : SKIP
+      excess_depletion =
+        hash.key?('excessDepletion') ? hash['excessDepletion'] : 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.
+      K1AlternativeMinimumTaxDrilling.new(gross_income: gross_income,
+                                          deductions: deductions,
+                                          excess_idc: excess_idc,
+                                          excess_depletion: excess_depletion,
+                                          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} gross_income: #{@gross_income}, deductions: #{@deductions}, excess_idc:"\
+      " #{@excess_idc}, excess_depletion: #{@excess_depletion}, 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} gross_income: #{@gross_income.inspect}, deductions: #{@deductions.inspect},"\
+      " excess_idc: #{@excess_idc.inspect}, excess_depletion: #{@excess_depletion.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/k1_alternative_minimum_tax_drilling1.rb

@@ -0,0 +1,111 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Geothermal amounts included in 1065 K-1 box 17 or 1120-S K-1 box 15
+  class K1AlternativeMinimumTaxDrilling1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Oil and gas or Geothermal gross income included in 1065 K-1 box 17 or
+    # 1120-S K-1 box 15
+    # @return [Float]
+    attr_accessor :gross_income
+
+    # Oil and gas or Geothermal deductions included in 1065 K-1 box 17 or 1120-S
+    # K-1 box 15
+    # @return [Float]
+    attr_accessor :deductions
+
+    # Oil and gas or Geothermal excess Intangible Drilling Costs (IDC) included
+    # in 1065 K-1 box 17 or 1120-S K-1 box 15
+    # @return [Float]
+    attr_accessor :excess_idc
+
+    # Oil and gas excess depletion included in 1065 K-1 box 17 or 1120-S K-1 box
+    # 15
+    # @return [Float]
+    attr_accessor :excess_depletion
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['gross_income'] = 'grossIncome'
+      @_hash['deductions'] = 'deductions'
+      @_hash['excess_idc'] = 'excessIdc'
+      @_hash['excess_depletion'] = 'excessDepletion'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        gross_income
+        deductions
+        excess_idc
+        excess_depletion
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(gross_income: SKIP, deductions: SKIP, excess_idc: SKIP,
+                   excess_depletion: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @gross_income = gross_income unless gross_income == SKIP
+      @deductions = deductions unless deductions == SKIP
+      @excess_idc = excess_idc unless excess_idc == SKIP
+      @excess_depletion = excess_depletion unless excess_depletion == 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.
+      gross_income = hash.key?('grossIncome') ? hash['grossIncome'] : SKIP
+      deductions = hash.key?('deductions') ? hash['deductions'] : SKIP
+      excess_idc = hash.key?('excessIdc') ? hash['excessIdc'] : SKIP
+      excess_depletion =
+        hash.key?('excessDepletion') ? hash['excessDepletion'] : 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.
+      K1AlternativeMinimumTaxDrilling1.new(gross_income: gross_income,
+                                           deductions: deductions,
+                                           excess_idc: excess_idc,
+                                           excess_depletion: excess_depletion,
+                                           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} gross_income: #{@gross_income}, deductions: #{@deductions}, excess_idc:"\
+      " #{@excess_idc}, excess_depletion: #{@excess_depletion}, 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} gross_income: #{@gross_income.inspect}, deductions: #{@deductions.inspect},"\
+      " excess_idc: #{@excess_idc.inspect}, excess_depletion: #{@excess_depletion.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end