fdx-api-sdk-ruby 1.0.0

data/lib/fdx_api/models/royalty_income_statement.rb

@@ -0,0 +1,424 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Royalty Income Statement for IRS Form 1040 Schedule E
+  class RoyaltyIncomeStatement < 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 [Error1]
+    attr_accessor :error
+
+    # Links to retrieve this form as data or image, or to invoke other APIs
+    # @return [Array[HateoasLink]]
+    attr_accessor :links
+
+    # Box 1a, Physical address of property (street, city, state, ZIP code)
+    # @return [Address]
+    attr_accessor :property_address
+
+    # Box 3, Royalties received
+    # @return [Float]
+    attr_accessor :royalties
+
+    # Box 5, Advertising
+    # @return [Float]
+    attr_accessor :advertising
+
+    # Box 6, Auto and travel
+    # @return [Float]
+    attr_accessor :auto
+
+    # Box 7, Cleaning and maintenance
+    # @return [Float]
+    attr_accessor :cleaning
+
+    # Box 8, Commissions
+    # @return [Float]
+    attr_accessor :commissions
+
+    # Box 9, Insurance
+    # @return [Float]
+    attr_accessor :insurance
+
+    # Box 10, Legal and other professional fees
+    # @return [Float]
+    attr_accessor :legal
+
+    # Box 11, Management fees
+    # @return [Float]
+    attr_accessor :management_fees
+
+    # Box 12, Mortgage interest paid to banks, etc.
+    # @return [Float]
+    attr_accessor :mortgage_interest
+
+    # Box 13, Other interest
+    # @return [Float]
+    attr_accessor :other_interest
+
+    # Box 14, Repairs
+    # @return [Float]
+    attr_accessor :repairs
+
+    # Box 15, Supplies
+    # @return [Float]
+    attr_accessor :supplies
+
+    # Box 16, Taxes
+    # @return [Float]
+    attr_accessor :taxes
+
+    # Box 17, Utilities
+    # @return [Float]
+    attr_accessor :utilities
+
+    # Box 18, Depletion
+    # @return [Float]
+    attr_accessor :depletion_expense
+
+    # Box 19, Other expenses
+    # @return [Array[DescriptionAndAmount]]
+    attr_accessor :other_expenses
+
+    # Capital expenditures, for use in calculating Depreciation
+    # @return [Array[DateAndAmount]]
+    attr_accessor :capital_expenditures
+
+    # 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['property_address'] = 'propertyAddress'
+      @_hash['royalties'] = 'royalties'
+      @_hash['advertising'] = 'advertising'
+      @_hash['auto'] = 'auto'
+      @_hash['cleaning'] = 'cleaning'
+      @_hash['commissions'] = 'commissions'
+      @_hash['insurance'] = 'insurance'
+      @_hash['legal'] = 'legal'
+      @_hash['management_fees'] = 'managementFees'
+      @_hash['mortgage_interest'] = 'mortgageInterest'
+      @_hash['other_interest'] = 'otherInterest'
+      @_hash['repairs'] = 'repairs'
+      @_hash['supplies'] = 'supplies'
+      @_hash['taxes'] = 'taxes'
+      @_hash['utilities'] = 'utilities'
+      @_hash['depletion_expense'] = 'depletionExpense'
+      @_hash['other_expenses'] = 'otherExpenses'
+      @_hash['capital_expenditures'] = 'capitalExpenditures'
+      @_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
+        property_address
+        royalties
+        advertising
+        auto
+        cleaning
+        commissions
+        insurance
+        legal
+        management_fees
+        mortgage_interest
+        other_interest
+        repairs
+        supplies
+        taxes
+        utilities
+        depletion_expense
+        other_expenses
+        capital_expenditures
+      ]
+    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, property_address: SKIP, royalties: SKIP,
+                   advertising: SKIP, auto: SKIP, cleaning: SKIP,
+                   commissions: SKIP, insurance: SKIP, legal: SKIP,
+                   management_fees: SKIP, mortgage_interest: SKIP,
+                   other_interest: SKIP, repairs: SKIP, supplies: SKIP,
+                   taxes: SKIP, utilities: SKIP, depletion_expense: SKIP,
+                   other_expenses: SKIP, capital_expenditures: 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
+      @property_address = property_address unless property_address == SKIP
+      @royalties = royalties unless royalties == SKIP
+      @advertising = advertising unless advertising == SKIP
+      @auto = auto unless auto == SKIP
+      @cleaning = cleaning unless cleaning == SKIP
+      @commissions = commissions unless commissions == SKIP
+      @insurance = insurance unless insurance == SKIP
+      @legal = legal unless legal == SKIP
+      @management_fees = management_fees unless management_fees == SKIP
+      @mortgage_interest = mortgage_interest unless mortgage_interest == SKIP
+      @other_interest = other_interest unless other_interest == SKIP
+      @repairs = repairs unless repairs == SKIP
+      @supplies = supplies unless supplies == SKIP
+      @taxes = taxes unless taxes == SKIP
+      @utilities = utilities unless utilities == SKIP
+      @depletion_expense = depletion_expense unless depletion_expense == SKIP
+      @other_expenses = other_expenses unless other_expenses == SKIP
+      @capital_expenditures = capital_expenditures unless capital_expenditures == 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 = Error1.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')
+      property_address = Address.from_hash(hash['propertyAddress']) if hash['propertyAddress']
+      royalties = hash.key?('royalties') ? hash['royalties'] : SKIP
+      advertising = hash.key?('advertising') ? hash['advertising'] : SKIP
+      auto = hash.key?('auto') ? hash['auto'] : SKIP
+      cleaning = hash.key?('cleaning') ? hash['cleaning'] : SKIP
+      commissions = hash.key?('commissions') ? hash['commissions'] : SKIP
+      insurance = hash.key?('insurance') ? hash['insurance'] : SKIP
+      legal = hash.key?('legal') ? hash['legal'] : SKIP
+      management_fees =
+        hash.key?('managementFees') ? hash['managementFees'] : SKIP
+      mortgage_interest =
+        hash.key?('mortgageInterest') ? hash['mortgageInterest'] : SKIP
+      other_interest = hash.key?('otherInterest') ? hash['otherInterest'] : SKIP
+      repairs = hash.key?('repairs') ? hash['repairs'] : SKIP
+      supplies = hash.key?('supplies') ? hash['supplies'] : SKIP
+      taxes = hash.key?('taxes') ? hash['taxes'] : SKIP
+      utilities = hash.key?('utilities') ? hash['utilities'] : SKIP
+      depletion_expense =
+        hash.key?('depletionExpense') ? hash['depletionExpense'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      other_expenses = nil
+      unless hash['otherExpenses'].nil?
+        other_expenses = []
+        hash['otherExpenses'].each do |structure|
+          other_expenses << (DescriptionAndAmount.from_hash(structure) if structure)
+        end
+      end
+
+      other_expenses = SKIP unless hash.key?('otherExpenses')
+      # Parameter is an array, so we need to iterate through it
+      capital_expenditures = nil
+      unless hash['capitalExpenditures'].nil?
+        capital_expenditures = []
+        hash['capitalExpenditures'].each do |structure|
+          capital_expenditures << (DateAndAmount.from_hash(structure) if structure)
+        end
+      end
+
+      capital_expenditures = SKIP unless hash.key?('capitalExpenditures')
+
+      # 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.
+      RoyaltyIncomeStatement.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,
+                                 property_address: property_address,
+                                 royalties: royalties,
+                                 advertising: advertising,
+                                 auto: auto,
+                                 cleaning: cleaning,
+                                 commissions: commissions,
+                                 insurance: insurance,
+                                 legal: legal,
+                                 management_fees: management_fees,
+                                 mortgage_interest: mortgage_interest,
+                                 other_interest: other_interest,
+                                 repairs: repairs,
+                                 supplies: supplies,
+                                 taxes: taxes,
+                                 utilities: utilities,
+                                 depletion_expense: depletion_expense,
+                                 other_expenses: other_expenses,
+                                 capital_expenditures: capital_expenditures,
+                                 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}, property_address: #{@property_address}, royalties:"\
+      " #{@royalties}, advertising: #{@advertising}, auto: #{@auto}, cleaning: #{@cleaning},"\
+      " commissions: #{@commissions}, insurance: #{@insurance}, legal: #{@legal}, management_fees:"\
+      " #{@management_fees}, mortgage_interest: #{@mortgage_interest}, other_interest:"\
+      " #{@other_interest}, repairs: #{@repairs}, supplies: #{@supplies}, taxes: #{@taxes},"\
+      " utilities: #{@utilities}, depletion_expense: #{@depletion_expense}, other_expenses:"\
+      " #{@other_expenses}, capital_expenditures: #{@capital_expenditures}, 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}, property_address: #{@property_address.inspect}, royalties:"\
+      " #{@royalties.inspect}, advertising: #{@advertising.inspect}, auto: #{@auto.inspect},"\
+      " cleaning: #{@cleaning.inspect}, commissions: #{@commissions.inspect}, insurance:"\
+      " #{@insurance.inspect}, legal: #{@legal.inspect}, management_fees:"\
+      " #{@management_fees.inspect}, mortgage_interest: #{@mortgage_interest.inspect},"\
+      " other_interest: #{@other_interest.inspect}, repairs: #{@repairs.inspect}, supplies:"\
+      " #{@supplies.inspect}, taxes: #{@taxes.inspect}, utilities: #{@utilities.inspect},"\
+      " depletion_expense: #{@depletion_expense.inspect}, other_expenses:"\
+      " #{@other_expenses.inspect}, capital_expenditures: #{@capital_expenditures.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_api/models/sale_proceeds_type.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Gross or net proceeds. Used by Form 1099-B
+  class SaleProceedsType
+    SALE_PROCEEDS_TYPE = [
+      # TODO: Write general description for GROSS
+      GROSS = 'GROSS'.freeze,
+
+      # TODO: Write general description for NET
+      NET = 'NET'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/sale_proceeds_type2.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # Box 6, Reported to IRS: GROSS or NET
+  class SaleProceedsType2
+    SALE_PROCEEDS_TYPE2 = [
+      # TODO: Write general description for GROSS
+      GROSS = 'GROSS'.freeze,
+
+      # TODO: Write general description for NET
+      NET = 'NET'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/secured.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # How the option is secured
+  class Secured
+    SECURED = [
+      # TODO: Write general description for COVERED
+      COVERED = 'COVERED'.freeze,
+
+      # TODO: Write general description for NAKED
+      NAKED = 'NAKED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/secured2.rb

@@ -0,0 +1,23 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # How the option is secured. One of NAKED, COVERED
+  class Secured2
+    SECURED2 = [
+      # TODO: Write general description for COVERED
+      COVERED = 'COVERED'.freeze,
+
+      # TODO: Write general description for NAKED
+      NAKED = 'NAKED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end

data/lib/fdx_api/models/security_category.rb

@@ -0,0 +1,35 @@
+# fdx_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxApi
+  # The type of security
+  class SecurityCategory
+    SECURITY_CATEGORY = [
+      # TODO: Write general description for DEBT_SECURITY
+      DEBT_SECURITY = 'DEBT_SECURITY'.freeze,
+
+      # TODO: Write general description for MUTUAL_FUND_SECURITY
+      MUTUAL_FUND_SECURITY = 'MUTUAL_FUND_SECURITY'.freeze,
+
+      # TODO: Write general description for OPTION_SECURITY
+      OPTION_SECURITY = 'OPTION_SECURITY'.freeze,
+
+      # TODO: Write general description for OTHER_SECURITY
+      OTHER_SECURITY = 'OTHER_SECURITY'.freeze,
+
+      # TODO: Write general description for STOCK_SECURITY
+      STOCK_SECURITY = 'STOCK_SECURITY'.freeze,
+
+      # TODO: Write general description for SWEEP_SECURITY
+      SWEEP_SECURITY = 'SWEEP_SECURITY'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+  end
+end