fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/tax_party_type.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Whether the tax legal entity is a business or an individual
+  class TaxPartyType
+    TAX_PARTY_TYPE = [
+      # TODO: Write general description for BUSINESS
+      BUSINESS = 'BUSINESS'.freeze,
+
+      # TODO: Write general description for INDIVIDUAL
+      INDIVIDUAL = 'INDIVIDUAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/tax_party_type2.rb

@@ -0,0 +1,24 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Type of issuer or recipient legal entity, as "BUSINESS" or "INDIVIDUAL".
+  # Commonly BUSINESS for issuer and INDIVIDUAL for recipient
+  class TaxPartyType2
+    TAX_PARTY_TYPE2 = [
+      # TODO: Write general description for BUSINESS
+      BUSINESS = 'BUSINESS'.freeze,
+
+      # TODO: Write general description for INDIVIDUAL
+      INDIVIDUAL = 'INDIVIDUAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/tax_refund_direct_deposit.rb

@@ -0,0 +1,108 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # IRS Form 8888 Direct Deposit Information
+  class TaxRefundDirectDeposit < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of institution
+    # @return [String]
+    attr_accessor :institution_name
+
+    # Routing transit number
+    # @return [String]
+    attr_accessor :rtn
+
+    # Account number
+    # @return [String]
+    attr_accessor :account_number
+
+    # Account nickname
+    # @return [String]
+    attr_accessor :account_nick_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['institution_name'] = 'institutionName'
+      @_hash['rtn'] = 'rtn'
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['account_nick_name'] = 'accountNickName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        institution_name
+        rtn
+        account_number
+        account_nick_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(institution_name: SKIP, rtn: SKIP, account_number: SKIP,
+                   account_nick_name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @institution_name = institution_name unless institution_name == SKIP
+      @rtn = rtn unless rtn == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @account_nick_name = account_nick_name unless account_nick_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.
+      institution_name =
+        hash.key?('institutionName') ? hash['institutionName'] : SKIP
+      rtn = hash.key?('rtn') ? hash['rtn'] : SKIP
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      account_nick_name =
+        hash.key?('accountNickName') ? hash['accountNickName'] : 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.
+      TaxRefundDirectDeposit.new(institution_name: institution_name,
+                                 rtn: rtn,
+                                 account_number: account_number,
+                                 account_nick_name: account_nick_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} institution_name: #{@institution_name}, rtn: #{@rtn}, account_number:"\
+      " #{@account_number}, account_nick_name: #{@account_nick_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} institution_name: #{@institution_name.inspect}, rtn: #{@rtn.inspect},"\
+      " account_number: #{@account_number.inspect}, account_nick_name:"\
+      " #{@account_nick_name.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/tax_refund_direct_deposit2.rb

@@ -0,0 +1,108 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Tax refund direct deposit information
+  class TaxRefundDirectDeposit2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of institution
+    # @return [String]
+    attr_accessor :institution_name
+
+    # Routing transit number
+    # @return [String]
+    attr_accessor :rtn
+
+    # Account number
+    # @return [String]
+    attr_accessor :account_number
+
+    # Account nickname
+    # @return [String]
+    attr_accessor :account_nick_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['institution_name'] = 'institutionName'
+      @_hash['rtn'] = 'rtn'
+      @_hash['account_number'] = 'accountNumber'
+      @_hash['account_nick_name'] = 'accountNickName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        institution_name
+        rtn
+        account_number
+        account_nick_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(institution_name: SKIP, rtn: SKIP, account_number: SKIP,
+                   account_nick_name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @institution_name = institution_name unless institution_name == SKIP
+      @rtn = rtn unless rtn == SKIP
+      @account_number = account_number unless account_number == SKIP
+      @account_nick_name = account_nick_name unless account_nick_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.
+      institution_name =
+        hash.key?('institutionName') ? hash['institutionName'] : SKIP
+      rtn = hash.key?('rtn') ? hash['rtn'] : SKIP
+      account_number = hash.key?('accountNumber') ? hash['accountNumber'] : SKIP
+      account_nick_name =
+        hash.key?('accountNickName') ? hash['accountNickName'] : 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.
+      TaxRefundDirectDeposit2.new(institution_name: institution_name,
+                                  rtn: rtn,
+                                  account_number: account_number,
+                                  account_nick_name: account_nick_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} institution_name: #{@institution_name}, rtn: #{@rtn}, account_number:"\
+      " #{@account_number}, account_nick_name: #{@account_nick_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} institution_name: #{@institution_name.inspect}, rtn: #{@rtn.inspect},"\
+      " account_number: #{@account_number.inspect}, account_nick_name:"\
+      " #{@account_nick_name.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/tax_statement.rb

@@ -0,0 +1,174 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Tax statement containing one or more tax forms
+  class TaxStatement < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Year for which taxes are being paid
+    # @return [Integer]
+    attr_accessor :tax_year
+
+    # Long-term persistent id for the tax statement. Depending upon the data
+    # provider, this may be the same id as the id on the enclosed tax form(s),
+    # or this may be a different id
+    # @return [String]
+    attr_accessor :tax_statement_id
+
+    # Issuer's name, address, phone, and TIN. Issuer data need only be
+    # transmittted on TaxStatement, 'JSON' data type responses if it is the same
+    # on all included tax forms
+    # @return [TaxParty6]
+    attr_accessor :issuer
+
+    # Recipient's name, address, phone, and TIN. Recipient data need only be
+    # transmittted on TaxStatement, 'JSON' data type responses if it is the same
+    # on all included tax forms
+    # @return [TaxParty7]
+    attr_accessor :recipient
+
+    # Whether this `application/json` tax form response contains data in `forms`
+    # property (as 'JSON' format) or `pdf` property (as 'BASE64_PDF' format)
+    # @return [TypeDataType2]
+    attr_accessor :tax_data_type
+
+    # The list of data contents for all included tax forms, response should
+    # include one of `forms` or `pdf`
+    # @return [Array[TaxData]]
+    attr_accessor :forms
+
+    # PDF version of the tax statement containing all form pages, binary encoded
+    # as Base64, response should include one of `pdf` or `forms`
+    # @return [Binary]
+    attr_accessor :pdf
+
+    # Additional tax statement attributes that the provider wishes to include
+    # @return [Array[FiAttributeEntity]]
+    attr_accessor :attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_year'] = 'taxYear'
+      @_hash['tax_statement_id'] = 'taxStatementId'
+      @_hash['issuer'] = 'issuer'
+      @_hash['recipient'] = 'recipient'
+      @_hash['tax_data_type'] = 'taxDataType'
+      @_hash['forms'] = 'forms'
+      @_hash['pdf'] = 'pdf'
+      @_hash['attributes'] = 'attributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_year
+        tax_statement_id
+        issuer
+        recipient
+        tax_data_type
+        forms
+        pdf
+        attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_year: SKIP, tax_statement_id: SKIP, issuer: SKIP,
+                   recipient: SKIP, tax_data_type: SKIP, forms: SKIP, pdf: SKIP,
+                   attributes: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_year = tax_year unless tax_year == SKIP
+      @tax_statement_id = tax_statement_id unless tax_statement_id == SKIP
+      @issuer = issuer unless issuer == SKIP
+      @recipient = recipient unless recipient == SKIP
+      @tax_data_type = tax_data_type unless tax_data_type == SKIP
+      @forms = forms unless forms == SKIP
+      @pdf = pdf unless pdf == SKIP
+      @attributes = attributes unless attributes == 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_year = hash.key?('taxYear') ? hash['taxYear'] : SKIP
+      tax_statement_id =
+        hash.key?('taxStatementId') ? hash['taxStatementId'] : SKIP
+      issuer = TaxParty6.from_hash(hash['issuer']) if hash['issuer']
+      recipient = TaxParty7.from_hash(hash['recipient']) if hash['recipient']
+      tax_data_type = hash.key?('taxDataType') ? hash['taxDataType'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      forms = nil
+      unless hash['forms'].nil?
+        forms = []
+        hash['forms'].each do |structure|
+          forms << (TaxData.from_hash(structure) if structure)
+        end
+      end
+
+      forms = SKIP unless hash.key?('forms')
+      pdf = hash.key?('pdf') ? hash['pdf'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      attributes = nil
+      unless hash['attributes'].nil?
+        attributes = []
+        hash['attributes'].each do |structure|
+          attributes << (FiAttributeEntity.from_hash(structure) if structure)
+        end
+      end
+
+      attributes = SKIP unless hash.key?('attributes')
+
+      # 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.
+      TaxStatement.new(tax_year: tax_year,
+                       tax_statement_id: tax_statement_id,
+                       issuer: issuer,
+                       recipient: recipient,
+                       tax_data_type: tax_data_type,
+                       forms: forms,
+                       pdf: pdf,
+                       attributes: attributes,
+                       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_year: #{@tax_year}, tax_statement_id: #{@tax_statement_id}, issuer:"\
+      " #{@issuer}, recipient: #{@recipient}, tax_data_type: #{@tax_data_type}, forms: #{@forms},"\
+      " pdf: #{@pdf}, attributes: #{@attributes}, 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_year: #{@tax_year.inspect}, tax_statement_id:"\
+      " #{@tax_statement_id.inspect}, issuer: #{@issuer.inspect}, recipient:"\
+      " #{@recipient.inspect}, tax_data_type: #{@tax_data_type.inspect}, forms: #{@forms.inspect},"\
+      " pdf: #{@pdf.inspect}, attributes: #{@attributes.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/tax_statement1.rb

@@ -0,0 +1,175 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The full data contents of the tax document and all its included forms
+  # including the indexing metadata values
+  class TaxStatement1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Year for which taxes are being paid
+    # @return [Integer]
+    attr_accessor :tax_year
+
+    # Long-term persistent id for the tax statement. Depending upon the data
+    # provider, this may be the same id as the id on the enclosed tax form(s),
+    # or this may be a different id
+    # @return [String]
+    attr_accessor :tax_statement_id
+
+    # Issuer's name, address, phone, and TIN. Issuer data need only be
+    # transmittted on TaxStatement, 'JSON' data type responses if it is the same
+    # on all included tax forms
+    # @return [TaxParty6]
+    attr_accessor :issuer
+
+    # Recipient's name, address, phone, and TIN. Recipient data need only be
+    # transmittted on TaxStatement, 'JSON' data type responses if it is the same
+    # on all included tax forms
+    # @return [TaxParty7]
+    attr_accessor :recipient
+
+    # Whether this `application/json` tax form response contains data in `forms`
+    # property (as 'JSON' format) or `pdf` property (as 'BASE64_PDF' format)
+    # @return [TypeDataType2]
+    attr_accessor :tax_data_type
+
+    # The list of data contents for all included tax forms, response should
+    # include one of `forms` or `pdf`
+    # @return [Array[TaxData]]
+    attr_accessor :forms
+
+    # PDF version of the tax statement containing all form pages, binary encoded
+    # as Base64, response should include one of `pdf` or `forms`
+    # @return [Binary]
+    attr_accessor :pdf
+
+    # Additional tax statement attributes that the provider wishes to include
+    # @return [Array[FiAttributeEntity]]
+    attr_accessor :attributes
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_year'] = 'taxYear'
+      @_hash['tax_statement_id'] = 'taxStatementId'
+      @_hash['issuer'] = 'issuer'
+      @_hash['recipient'] = 'recipient'
+      @_hash['tax_data_type'] = 'taxDataType'
+      @_hash['forms'] = 'forms'
+      @_hash['pdf'] = 'pdf'
+      @_hash['attributes'] = 'attributes'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_year
+        tax_statement_id
+        issuer
+        recipient
+        tax_data_type
+        forms
+        pdf
+        attributes
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_year: SKIP, tax_statement_id: SKIP, issuer: SKIP,
+                   recipient: SKIP, tax_data_type: SKIP, forms: SKIP, pdf: SKIP,
+                   attributes: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tax_year = tax_year unless tax_year == SKIP
+      @tax_statement_id = tax_statement_id unless tax_statement_id == SKIP
+      @issuer = issuer unless issuer == SKIP
+      @recipient = recipient unless recipient == SKIP
+      @tax_data_type = tax_data_type unless tax_data_type == SKIP
+      @forms = forms unless forms == SKIP
+      @pdf = pdf unless pdf == SKIP
+      @attributes = attributes unless attributes == 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_year = hash.key?('taxYear') ? hash['taxYear'] : SKIP
+      tax_statement_id =
+        hash.key?('taxStatementId') ? hash['taxStatementId'] : SKIP
+      issuer = TaxParty6.from_hash(hash['issuer']) if hash['issuer']
+      recipient = TaxParty7.from_hash(hash['recipient']) if hash['recipient']
+      tax_data_type = hash.key?('taxDataType') ? hash['taxDataType'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      forms = nil
+      unless hash['forms'].nil?
+        forms = []
+        hash['forms'].each do |structure|
+          forms << (TaxData.from_hash(structure) if structure)
+        end
+      end
+
+      forms = SKIP unless hash.key?('forms')
+      pdf = hash.key?('pdf') ? hash['pdf'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      attributes = nil
+      unless hash['attributes'].nil?
+        attributes = []
+        hash['attributes'].each do |structure|
+          attributes << (FiAttributeEntity.from_hash(structure) if structure)
+        end
+      end
+
+      attributes = SKIP unless hash.key?('attributes')
+
+      # 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.
+      TaxStatement1.new(tax_year: tax_year,
+                        tax_statement_id: tax_statement_id,
+                        issuer: issuer,
+                        recipient: recipient,
+                        tax_data_type: tax_data_type,
+                        forms: forms,
+                        pdf: pdf,
+                        attributes: attributes,
+                        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_year: #{@tax_year}, tax_statement_id: #{@tax_statement_id}, issuer:"\
+      " #{@issuer}, recipient: #{@recipient}, tax_data_type: #{@tax_data_type}, forms: #{@forms},"\
+      " pdf: #{@pdf}, attributes: #{@attributes}, 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_year: #{@tax_year.inspect}, tax_statement_id:"\
+      " #{@tax_statement_id.inspect}, issuer: #{@issuer.inspect}, recipient:"\
+      " #{@recipient.inspect}, tax_data_type: #{@tax_data_type.inspect}, forms: #{@forms.inspect},"\
+      " pdf: #{@pdf.inspect}, attributes: #{@attributes.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end