fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/tax_statement2.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 as
+  # ingested
+  class TaxStatement2 < 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.
+      TaxStatement2.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_statement4.rb

@@ -0,0 +1,175 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The TaxStatement json for a single tax document containing one or more tax
+  # reporting forms for the customer
+  class TaxStatement4 < 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.
+      TaxStatement4.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_statement6.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 document and all its contained forms including
+  # the indexing metadata values
+  class TaxStatement6 < 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.
+      TaxStatement6.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_statement_list.rb

@@ -0,0 +1,85 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Tax statement list containing one or more tax statements
+  class TaxStatementList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The list of tax statements
+    # @return [Array[TaxStatement]]
+    attr_accessor :statements
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['statements'] = 'statements'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        statements
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(statements: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @statements = statements unless statements == 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.
+      # Parameter is an array, so we need to iterate through it
+      statements = nil
+      unless hash['statements'].nil?
+        statements = []
+        hash['statements'].each do |structure|
+          statements << (TaxStatement.from_hash(structure) if structure)
+        end
+      end
+
+      statements = SKIP unless hash.key?('statements')
+
+      # 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.
+      TaxStatementList.new(statements: statements,
+                           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} statements: #{@statements}, 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} statements: #{@statements.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end