fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/form1097_btc1.rb

@@ -0,0 +1,313 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Bond Tax Credit
+  class Form1097Btc1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Year for which taxes are being paid
+    # @return [Integer]
+    attr_accessor :tax_year
+
+    # True to indicate this is a corrected tax form
+    # @return [TrueClass | FalseClass]
+    attr_accessor :corrected
+
+    # Long-term persistent identity of the source account. Not the account
+    # number
+    # @return [String]
+    attr_accessor :account_id
+
+    # Long-term persistent id for this tax form. Depending upon the data
+    # provider, this may be the same id as the enclosing tax statement id, or
+    # this may be a different id, or this id may be omitted.
+    # @return [String]
+    attr_accessor :tax_form_id
+
+    # Date of production or delivery of the tax form
+    # @return [Date]
+    attr_accessor :tax_form_date
+
+    # Additional explanation text or content about this tax form
+    # @return [String]
+    attr_accessor :additional_information
+
+    # Enumerated name of the tax form entity e.g. "TaxW2"
+    # @return [TypeFormType1]
+    attr_accessor :tax_form_type
+
+    # Issuer's name, address, phone, and TIN. Issuer data need only be
+    # transmitted on enclosing TaxStatement, if it is the same on all its
+    # included tax forms.
+    # @return [TaxParty8]
+    attr_accessor :issuer
+
+    # Recipient's name, address, phone, and TIN. Recipient data need only be
+    # transmitted on enclosing TaxStatement, if it is the same on all its
+    # included tax forms.
+    # @return [TaxParty1]
+    attr_accessor :recipient
+
+    # Additional attributes for this tax form when defined fields are not
+    # available. Some specific additional attributes already defined by
+    # providers: Fields required by [IRS
+    # FIRE](https://www.irs.gov/e-file-providers/filing-information-returns-elec
+    # tronically-fire): Name Control, Type of Identification Number (EIN, SSN,
+    # ITIN, ATIN). (ATIN is tax ID number for pending adoptions.) Tax form
+    # provider field for taxpayer notification: Recipient Email Address.
+    # @return [Array[TaxFormAttribute]]
+    attr_accessor :attributes
+
+    # Present if an error was encountered while retrieving this form
+    # @return [Error2]
+    attr_accessor :error
+
+    # Links to retrieve this form as data or image, or to invoke other APIs
+    # @return [Array[HateoasLink]]
+    attr_accessor :links
+
+    # Form 1097-BTC issuer is: Issuer of bond or its agent filing current year
+    # Form 1097-BTC for credit being reported
+    # @return [TrueClass | FalseClass]
+    attr_accessor :filing_for_credit
+
+    # Form 1097-BTC issuer is: An entity or a person that received or should
+    # have received a current year Form 1097-BTC and is distributing part or all
+    # of that credit to others
+    # @return [TrueClass | FalseClass]
+    attr_accessor :as_nominee
+
+    # Box 1, Total
+    # @return [Float]
+    attr_accessor :total
+
+    # Box 2a, Code
+    # @return [String]
+    attr_accessor :bond_code
+
+    # Box 2b, Unique Identifier
+    # @return [String]
+    attr_accessor :unique_id
+
+    # Box 3, Bond type
+    # @return [String]
+    attr_accessor :bond_type
+
+    # Box 5, Amounts by month
+    # @return [Array[MonthAndAmount]]
+    attr_accessor :amounts
+
+    # Box 6, Comments
+    # @return [String]
+    attr_accessor :comments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tax_year'] = 'taxYear'
+      @_hash['corrected'] = 'corrected'
+      @_hash['account_id'] = 'accountId'
+      @_hash['tax_form_id'] = 'taxFormId'
+      @_hash['tax_form_date'] = 'taxFormDate'
+      @_hash['additional_information'] = 'additionalInformation'
+      @_hash['tax_form_type'] = 'taxFormType'
+      @_hash['issuer'] = 'issuer'
+      @_hash['recipient'] = 'recipient'
+      @_hash['attributes'] = 'attributes'
+      @_hash['error'] = 'error'
+      @_hash['links'] = 'links'
+      @_hash['filing_for_credit'] = 'filingForCredit'
+      @_hash['as_nominee'] = 'asNominee'
+      @_hash['total'] = 'total'
+      @_hash['bond_code'] = 'bondCode'
+      @_hash['unique_id'] = 'uniqueId'
+      @_hash['bond_type'] = 'bondType'
+      @_hash['amounts'] = 'amounts'
+      @_hash['comments'] = 'comments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tax_year
+        corrected
+        account_id
+        tax_form_id
+        tax_form_date
+        additional_information
+        tax_form_type
+        issuer
+        recipient
+        attributes
+        error
+        links
+        filing_for_credit
+        as_nominee
+        total
+        bond_code
+        unique_id
+        bond_type
+        amounts
+        comments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tax_year: SKIP, corrected: SKIP, account_id: SKIP,
+                   tax_form_id: SKIP, tax_form_date: SKIP,
+                   additional_information: SKIP, tax_form_type: SKIP,
+                   issuer: SKIP, recipient: SKIP, attributes: SKIP, error: SKIP,
+                   links: SKIP, filing_for_credit: SKIP, as_nominee: SKIP,
+                   total: SKIP, bond_code: SKIP, unique_id: SKIP,
+                   bond_type: SKIP, amounts: SKIP, comments: 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
+      @corrected = corrected unless corrected == SKIP
+      @account_id = account_id unless account_id == SKIP
+      @tax_form_id = tax_form_id unless tax_form_id == SKIP
+      @tax_form_date = tax_form_date unless tax_form_date == SKIP
+      @additional_information = additional_information unless additional_information == SKIP
+      @tax_form_type = tax_form_type unless tax_form_type == SKIP
+      @issuer = issuer unless issuer == SKIP
+      @recipient = recipient unless recipient == SKIP
+      @attributes = attributes unless attributes == SKIP
+      @error = error unless error == SKIP
+      @links = links unless links == SKIP
+      @filing_for_credit = filing_for_credit unless filing_for_credit == SKIP
+      @as_nominee = as_nominee unless as_nominee == SKIP
+      @total = total unless total == SKIP
+      @bond_code = bond_code unless bond_code == SKIP
+      @unique_id = unique_id unless unique_id == SKIP
+      @bond_type = bond_type unless bond_type == SKIP
+      @amounts = amounts unless amounts == SKIP
+      @comments = comments unless comments == 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
+      corrected = hash.key?('corrected') ? hash['corrected'] : SKIP
+      account_id = hash.key?('accountId') ? hash['accountId'] : SKIP
+      tax_form_id = hash.key?('taxFormId') ? hash['taxFormId'] : SKIP
+      tax_form_date = hash.key?('taxFormDate') ? hash['taxFormDate'] : SKIP
+      additional_information =
+        hash.key?('additionalInformation') ? hash['additionalInformation'] : SKIP
+      tax_form_type = hash.key?('taxFormType') ? hash['taxFormType'] : SKIP
+      issuer = TaxParty8.from_hash(hash['issuer']) if hash['issuer']
+      recipient = TaxParty1.from_hash(hash['recipient']) if hash['recipient']
+      # Parameter is an array, so we need to iterate through it
+      attributes = nil
+      unless hash['attributes'].nil?
+        attributes = []
+        hash['attributes'].each do |structure|
+          attributes << (TaxFormAttribute.from_hash(structure) if structure)
+        end
+      end
+
+      attributes = SKIP unless hash.key?('attributes')
+      error = Error2.from_hash(hash['error']) if hash['error']
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (HateoasLink.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+      filing_for_credit =
+        hash.key?('filingForCredit') ? hash['filingForCredit'] : SKIP
+      as_nominee = hash.key?('asNominee') ? hash['asNominee'] : SKIP
+      total = hash.key?('total') ? hash['total'] : SKIP
+      bond_code = hash.key?('bondCode') ? hash['bondCode'] : SKIP
+      unique_id = hash.key?('uniqueId') ? hash['uniqueId'] : SKIP
+      bond_type = hash.key?('bondType') ? hash['bondType'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      amounts = nil
+      unless hash['amounts'].nil?
+        amounts = []
+        hash['amounts'].each do |structure|
+          amounts << (MonthAndAmount.from_hash(structure) if structure)
+        end
+      end
+
+      amounts = SKIP unless hash.key?('amounts')
+      comments = hash.key?('comments') ? hash['comments'] : 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.
+      Form1097Btc1.new(tax_year: tax_year,
+                       corrected: corrected,
+                       account_id: account_id,
+                       tax_form_id: tax_form_id,
+                       tax_form_date: tax_form_date,
+                       additional_information: additional_information,
+                       tax_form_type: tax_form_type,
+                       issuer: issuer,
+                       recipient: recipient,
+                       attributes: attributes,
+                       error: error,
+                       links: links,
+                       filing_for_credit: filing_for_credit,
+                       as_nominee: as_nominee,
+                       total: total,
+                       bond_code: bond_code,
+                       unique_id: unique_id,
+                       bond_type: bond_type,
+                       amounts: amounts,
+                       comments: comments,
+                       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}, corrected: #{@corrected}, account_id:"\
+      " #{@account_id}, tax_form_id: #{@tax_form_id}, tax_form_date: #{@tax_form_date},"\
+      " additional_information: #{@additional_information}, tax_form_type: #{@tax_form_type},"\
+      " issuer: #{@issuer}, recipient: #{@recipient}, attributes: #{@attributes}, error:"\
+      " #{@error}, links: #{@links}, filing_for_credit: #{@filing_for_credit}, as_nominee:"\
+      " #{@as_nominee}, total: #{@total}, bond_code: #{@bond_code}, unique_id: #{@unique_id},"\
+      " bond_type: #{@bond_type}, amounts: #{@amounts}, comments: #{@comments},"\
+      " 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}, corrected: #{@corrected.inspect},"\
+      " account_id: #{@account_id.inspect}, tax_form_id: #{@tax_form_id.inspect}, tax_form_date:"\
+      " #{@tax_form_date.inspect}, additional_information: #{@additional_information.inspect},"\
+      " tax_form_type: #{@tax_form_type.inspect}, issuer: #{@issuer.inspect}, recipient:"\
+      " #{@recipient.inspect}, attributes: #{@attributes.inspect}, error: #{@error.inspect},"\
+      " links: #{@links.inspect}, filing_for_credit: #{@filing_for_credit.inspect}, as_nominee:"\
+      " #{@as_nominee.inspect}, total: #{@total.inspect}, bond_code: #{@bond_code.inspect},"\
+      " unique_id: #{@unique_id.inspect}, bond_type: #{@bond_type.inspect}, amounts:"\
+      " #{@amounts.inspect}, comments: #{@comments.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end