apimatic-plaid-sdk 0.0.1

data/lib/plaid/models/w2.rb

@@ -0,0 +1,346 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # W2 is an object that represents income data taken from a W2 tax document.
+  class W2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Employer2]
+    attr_accessor :employer
+
+    # Data about the employee.
+    # @return [Employee]
+    attr_accessor :employee
+
+    # The tax year of the W2 document.
+    # @return [String]
+    attr_accessor :tax_year
+
+    # An employee identification number or EIN.
+    # @return [String]
+    attr_accessor :employer_id_number
+
+    # Wages from tips and other compensation.
+    # @return [String]
+    attr_accessor :wages_tips_other_comp
+
+    # Federal income tax withheld for the tax year.
+    # @return [String]
+    attr_accessor :federal_income_tax_withheld
+
+    # Wages from social security.
+    # @return [String]
+    attr_accessor :social_security_wages
+
+    # Social security tax withheld for the tax year.
+    # @return [String]
+    attr_accessor :social_security_tax_withheld
+
+    # Wages and tips from medicare.
+    # @return [String]
+    attr_accessor :medicare_wages_and_tips
+
+    # Medicare tax withheld for the tax year.
+    # @return [String]
+    attr_accessor :medicare_tax_withheld
+
+    # Tips from social security.
+    # @return [String]
+    attr_accessor :social_security_tips
+
+    # Allocated tips.
+    # @return [String]
+    attr_accessor :allocated_tips
+
+    # Contents from box 9 on the W2.
+    # @return [String]
+    attr_accessor :box_9
+
+    # Dependent care benefits.
+    # @return [String]
+    attr_accessor :dependent_care_benefits
+
+    # Nonqualified plans.
+    # @return [String]
+    attr_accessor :nonqualified_plans
+
+    # Nonqualified plans.
+    # @return [Array[W2Box12]]
+    attr_accessor :box_12
+
+    # Statutory employee.
+    # @return [String]
+    attr_accessor :statutory_employee
+
+    # Retirement plan.
+    # @return [String]
+    attr_accessor :retirement_plan
+
+    # Third party sick pay.
+    # @return [String]
+    attr_accessor :third_party_sick_pay
+
+    # Other.
+    # @return [String]
+    attr_accessor :other
+
+    # Other.
+    # @return [Array[W2StateAndLocalWages]]
+    attr_accessor :state_and_local_wages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['employer'] = 'employer'
+      @_hash['employee'] = 'employee'
+      @_hash['tax_year'] = 'tax_year'
+      @_hash['employer_id_number'] = 'employer_id_number'
+      @_hash['wages_tips_other_comp'] = 'wages_tips_other_comp'
+      @_hash['federal_income_tax_withheld'] = 'federal_income_tax_withheld'
+      @_hash['social_security_wages'] = 'social_security_wages'
+      @_hash['social_security_tax_withheld'] = 'social_security_tax_withheld'
+      @_hash['medicare_wages_and_tips'] = 'medicare_wages_and_tips'
+      @_hash['medicare_tax_withheld'] = 'medicare_tax_withheld'
+      @_hash['social_security_tips'] = 'social_security_tips'
+      @_hash['allocated_tips'] = 'allocated_tips'
+      @_hash['box_9'] = 'box_9'
+      @_hash['dependent_care_benefits'] = 'dependent_care_benefits'
+      @_hash['nonqualified_plans'] = 'nonqualified_plans'
+      @_hash['box_12'] = 'box_12'
+      @_hash['statutory_employee'] = 'statutory_employee'
+      @_hash['retirement_plan'] = 'retirement_plan'
+      @_hash['third_party_sick_pay'] = 'third_party_sick_pay'
+      @_hash['other'] = 'other'
+      @_hash['state_and_local_wages'] = 'state_and_local_wages'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        employer
+        employee
+        tax_year
+        employer_id_number
+        wages_tips_other_comp
+        federal_income_tax_withheld
+        social_security_wages
+        social_security_tax_withheld
+        medicare_wages_and_tips
+        medicare_tax_withheld
+        social_security_tips
+        allocated_tips
+        box_9
+        dependent_care_benefits
+        nonqualified_plans
+        box_12
+        statutory_employee
+        retirement_plan
+        third_party_sick_pay
+        other
+        state_and_local_wages
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        tax_year
+        employer_id_number
+        wages_tips_other_comp
+        federal_income_tax_withheld
+        social_security_wages
+        social_security_tax_withheld
+        medicare_wages_and_tips
+        medicare_tax_withheld
+        social_security_tips
+        allocated_tips
+        box_9
+        dependent_care_benefits
+        nonqualified_plans
+        statutory_employee
+        retirement_plan
+        third_party_sick_pay
+        other
+      ]
+    end
+
+    def initialize(employer: SKIP, employee: SKIP, tax_year: SKIP,
+                   employer_id_number: SKIP, wages_tips_other_comp: SKIP,
+                   federal_income_tax_withheld: SKIP,
+                   social_security_wages: SKIP,
+                   social_security_tax_withheld: SKIP,
+                   medicare_wages_and_tips: SKIP, medicare_tax_withheld: SKIP,
+                   social_security_tips: SKIP, allocated_tips: SKIP,
+                   box_9: SKIP, dependent_care_benefits: SKIP,
+                   nonqualified_plans: SKIP, box_12: SKIP,
+                   statutory_employee: SKIP, retirement_plan: SKIP,
+                   third_party_sick_pay: SKIP, other: SKIP,
+                   state_and_local_wages: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @employer = employer unless employer == SKIP
+      @employee = employee unless employee == SKIP
+      @tax_year = tax_year unless tax_year == SKIP
+      @employer_id_number = employer_id_number unless employer_id_number == SKIP
+      @wages_tips_other_comp = wages_tips_other_comp unless wages_tips_other_comp == SKIP
+      unless federal_income_tax_withheld == SKIP
+        @federal_income_tax_withheld =
+          federal_income_tax_withheld
+      end
+      @social_security_wages = social_security_wages unless social_security_wages == SKIP
+      unless social_security_tax_withheld == SKIP
+        @social_security_tax_withheld =
+          social_security_tax_withheld
+      end
+      @medicare_wages_and_tips = medicare_wages_and_tips unless medicare_wages_and_tips == SKIP
+      @medicare_tax_withheld = medicare_tax_withheld unless medicare_tax_withheld == SKIP
+      @social_security_tips = social_security_tips unless social_security_tips == SKIP
+      @allocated_tips = allocated_tips unless allocated_tips == SKIP
+      @box_9 = box_9 unless box_9 == SKIP
+      @dependent_care_benefits = dependent_care_benefits unless dependent_care_benefits == SKIP
+      @nonqualified_plans = nonqualified_plans unless nonqualified_plans == SKIP
+      @box_12 = box_12 unless box_12 == SKIP
+      @statutory_employee = statutory_employee unless statutory_employee == SKIP
+      @retirement_plan = retirement_plan unless retirement_plan == SKIP
+      @third_party_sick_pay = third_party_sick_pay unless third_party_sick_pay == SKIP
+      @other = other unless other == SKIP
+      @state_and_local_wages = state_and_local_wages unless state_and_local_wages == 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.
+      employer = Employer2.from_hash(hash['employer']) if hash['employer']
+      employee = Employee.from_hash(hash['employee']) if hash['employee']
+      tax_year = hash.key?('tax_year') ? hash['tax_year'] : SKIP
+      employer_id_number =
+        hash.key?('employer_id_number') ? hash['employer_id_number'] : SKIP
+      wages_tips_other_comp =
+        hash.key?('wages_tips_other_comp') ? hash['wages_tips_other_comp'] : SKIP
+      federal_income_tax_withheld =
+        hash.key?('federal_income_tax_withheld') ? hash['federal_income_tax_withheld'] : SKIP
+      social_security_wages =
+        hash.key?('social_security_wages') ? hash['social_security_wages'] : SKIP
+      social_security_tax_withheld =
+        hash.key?('social_security_tax_withheld') ? hash['social_security_tax_withheld'] : SKIP
+      medicare_wages_and_tips =
+        hash.key?('medicare_wages_and_tips') ? hash['medicare_wages_and_tips'] : SKIP
+      medicare_tax_withheld =
+        hash.key?('medicare_tax_withheld') ? hash['medicare_tax_withheld'] : SKIP
+      social_security_tips =
+        hash.key?('social_security_tips') ? hash['social_security_tips'] : SKIP
+      allocated_tips =
+        hash.key?('allocated_tips') ? hash['allocated_tips'] : SKIP
+      box_9 = hash.key?('box_9') ? hash['box_9'] : SKIP
+      dependent_care_benefits =
+        hash.key?('dependent_care_benefits') ? hash['dependent_care_benefits'] : SKIP
+      nonqualified_plans =
+        hash.key?('nonqualified_plans') ? hash['nonqualified_plans'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      box_12 = nil
+      unless hash['box_12'].nil?
+        box_12 = []
+        hash['box_12'].each do |structure|
+          box_12 << (W2Box12.from_hash(structure) if structure)
+        end
+      end
+
+      box_12 = SKIP unless hash.key?('box_12')
+      statutory_employee =
+        hash.key?('statutory_employee') ? hash['statutory_employee'] : SKIP
+      retirement_plan =
+        hash.key?('retirement_plan') ? hash['retirement_plan'] : SKIP
+      third_party_sick_pay =
+        hash.key?('third_party_sick_pay') ? hash['third_party_sick_pay'] : SKIP
+      other = hash.key?('other') ? hash['other'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      state_and_local_wages = nil
+      unless hash['state_and_local_wages'].nil?
+        state_and_local_wages = []
+        hash['state_and_local_wages'].each do |structure|
+          state_and_local_wages << (W2StateAndLocalWages.from_hash(structure) if structure)
+        end
+      end
+
+      state_and_local_wages = SKIP unless hash.key?('state_and_local_wages')
+
+      # 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.
+      W2.new(employer: employer,
+             employee: employee,
+             tax_year: tax_year,
+             employer_id_number: employer_id_number,
+             wages_tips_other_comp: wages_tips_other_comp,
+             federal_income_tax_withheld: federal_income_tax_withheld,
+             social_security_wages: social_security_wages,
+             social_security_tax_withheld: social_security_tax_withheld,
+             medicare_wages_and_tips: medicare_wages_and_tips,
+             medicare_tax_withheld: medicare_tax_withheld,
+             social_security_tips: social_security_tips,
+             allocated_tips: allocated_tips,
+             box_9: box_9,
+             dependent_care_benefits: dependent_care_benefits,
+             nonqualified_plans: nonqualified_plans,
+             box_12: box_12,
+             statutory_employee: statutory_employee,
+             retirement_plan: retirement_plan,
+             third_party_sick_pay: third_party_sick_pay,
+             other: other,
+             state_and_local_wages: state_and_local_wages,
+             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} employer: #{@employer}, employee: #{@employee}, tax_year: #{@tax_year},"\
+      " employer_id_number: #{@employer_id_number}, wages_tips_other_comp:"\
+      " #{@wages_tips_other_comp}, federal_income_tax_withheld: #{@federal_income_tax_withheld},"\
+      " social_security_wages: #{@social_security_wages}, social_security_tax_withheld:"\
+      " #{@social_security_tax_withheld}, medicare_wages_and_tips: #{@medicare_wages_and_tips},"\
+      " medicare_tax_withheld: #{@medicare_tax_withheld}, social_security_tips:"\
+      " #{@social_security_tips}, allocated_tips: #{@allocated_tips}, box_9: #{@box_9},"\
+      " dependent_care_benefits: #{@dependent_care_benefits}, nonqualified_plans:"\
+      " #{@nonqualified_plans}, box_12: #{@box_12}, statutory_employee: #{@statutory_employee},"\
+      " retirement_plan: #{@retirement_plan}, third_party_sick_pay: #{@third_party_sick_pay},"\
+      " other: #{@other}, state_and_local_wages: #{@state_and_local_wages}, 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} employer: #{@employer.inspect}, employee: #{@employee.inspect}, tax_year:"\
+      " #{@tax_year.inspect}, employer_id_number: #{@employer_id_number.inspect},"\
+      " wages_tips_other_comp: #{@wages_tips_other_comp.inspect}, federal_income_tax_withheld:"\
+      " #{@federal_income_tax_withheld.inspect}, social_security_wages:"\
+      " #{@social_security_wages.inspect}, social_security_tax_withheld:"\
+      " #{@social_security_tax_withheld.inspect}, medicare_wages_and_tips:"\
+      " #{@medicare_wages_and_tips.inspect}, medicare_tax_withheld:"\
+      " #{@medicare_tax_withheld.inspect}, social_security_tips: #{@social_security_tips.inspect},"\
+      " allocated_tips: #{@allocated_tips.inspect}, box_9: #{@box_9.inspect},"\
+      " dependent_care_benefits: #{@dependent_care_benefits.inspect}, nonqualified_plans:"\
+      " #{@nonqualified_plans.inspect}, box_12: #{@box_12.inspect}, statutory_employee:"\
+      " #{@statutory_employee.inspect}, retirement_plan: #{@retirement_plan.inspect},"\
+      " third_party_sick_pay: #{@third_party_sick_pay.inspect}, other: #{@other.inspect},"\
+      " state_and_local_wages: #{@state_and_local_wages.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/w2_box12.rb

@@ -0,0 +1,88 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # W2Box12 Model.
+  class W2Box12 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # W2 Box 12 code.
+    # @return [String]
+    attr_accessor :code
+
+    # W2 Box 12 amount.
+    # @return [String]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        code
+        amount
+      ]
+    end
+
+    def initialize(code: SKIP, amount: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @code = code unless code == SKIP
+      @amount = amount unless amount == 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : 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.
+      W2Box12.new(code: code,
+                  amount: amount,
+                  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} code: #{@code}, amount: #{@amount}, 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} code: #{@code.inspect}, amount: #{@amount.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/w2_state_and_local_wages.rb

@@ -0,0 +1,152 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # W2StateAndLocalWages Model.
+  class W2StateAndLocalWages < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # State associated with the wage.
+    # @return [String]
+    attr_accessor :state
+
+    # State identification number of the employer.
+    # @return [String]
+    attr_accessor :employer_state_id_number
+
+    # Wages and tips from the specified state.
+    # @return [String]
+    attr_accessor :state_wages_tips
+
+    # Income tax from the specified state.
+    # @return [String]
+    attr_accessor :state_income_tax
+
+    # Wages and tips from the locality.
+    # @return [String]
+    attr_accessor :local_wages_tips
+
+    # Income tax from the locality.
+    # @return [String]
+    attr_accessor :local_income_tax
+
+    # Name of the locality.
+    # @return [String]
+    attr_accessor :locality_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['state'] = 'state'
+      @_hash['employer_state_id_number'] = 'employer_state_id_number'
+      @_hash['state_wages_tips'] = 'state_wages_tips'
+      @_hash['state_income_tax'] = 'state_income_tax'
+      @_hash['local_wages_tips'] = 'local_wages_tips'
+      @_hash['local_income_tax'] = 'local_income_tax'
+      @_hash['locality_name'] = 'locality_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        state
+        employer_state_id_number
+        state_wages_tips
+        state_income_tax
+        local_wages_tips
+        local_income_tax
+        locality_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        state
+        employer_state_id_number
+        state_wages_tips
+        state_income_tax
+        local_wages_tips
+        local_income_tax
+        locality_name
+      ]
+    end
+
+    def initialize(state: SKIP, employer_state_id_number: SKIP,
+                   state_wages_tips: SKIP, state_income_tax: SKIP,
+                   local_wages_tips: SKIP, local_income_tax: SKIP,
+                   locality_name: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @state = state unless state == SKIP
+      @employer_state_id_number = employer_state_id_number unless employer_state_id_number == SKIP
+      @state_wages_tips = state_wages_tips unless state_wages_tips == SKIP
+      @state_income_tax = state_income_tax unless state_income_tax == SKIP
+      @local_wages_tips = local_wages_tips unless local_wages_tips == SKIP
+      @local_income_tax = local_income_tax unless local_income_tax == SKIP
+      @locality_name = locality_name unless locality_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.
+      state = hash.key?('state') ? hash['state'] : SKIP
+      employer_state_id_number =
+        hash.key?('employer_state_id_number') ? hash['employer_state_id_number'] : SKIP
+      state_wages_tips =
+        hash.key?('state_wages_tips') ? hash['state_wages_tips'] : SKIP
+      state_income_tax =
+        hash.key?('state_income_tax') ? hash['state_income_tax'] : SKIP
+      local_wages_tips =
+        hash.key?('local_wages_tips') ? hash['local_wages_tips'] : SKIP
+      local_income_tax =
+        hash.key?('local_income_tax') ? hash['local_income_tax'] : SKIP
+      locality_name = hash.key?('locality_name') ? hash['locality_name'] : 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.
+      W2StateAndLocalWages.new(state: state,
+                               employer_state_id_number: employer_state_id_number,
+                               state_wages_tips: state_wages_tips,
+                               state_income_tax: state_income_tax,
+                               local_wages_tips: local_wages_tips,
+                               local_income_tax: local_income_tax,
+                               locality_name: locality_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} state: #{@state}, employer_state_id_number: #{@employer_state_id_number},"\
+      " state_wages_tips: #{@state_wages_tips}, state_income_tax: #{@state_income_tax},"\
+      " local_wages_tips: #{@local_wages_tips}, local_income_tax: #{@local_income_tax},"\
+      " locality_name: #{@locality_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} state: #{@state.inspect}, employer_state_id_number:"\
+      " #{@employer_state_id_number.inspect}, state_wages_tips: #{@state_wages_tips.inspect},"\
+      " state_income_tax: #{@state_income_tax.inspect}, local_wages_tips:"\
+      " #{@local_wages_tips.inspect}, local_income_tax: #{@local_income_tax.inspect},"\
+      " locality_name: #{@locality_name.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/plaid/models/warning.rb

@@ -0,0 +1,98 @@
+# plaid
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Plaid
+  # It is possible for an Asset Report to be returned with missing account owner
+  # information. In such cases, the Asset Report will contain warning data in
+  # the response, indicating why obtaining the owner information failed.
+  class Warning < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The warning type, which will always be `ASSET_REPORT_WARNING`
+    # @return [String]
+    attr_accessor :warning_type
+
+    # The warning code identifies a specific kind of warning. Currently, the
+    # only possible warning code is `OWNERS_UNAVAILABLE`, which indicates that
+    # account-owner information is not available.
+    # @return [String]
+    attr_accessor :warning_code
+
+    # An error object and associated `item_id` used to identify a specific Item
+    # and error when a batch operation operating on multiple Items has
+    # encountered an error in one of the Items.
+    # @return [Cause]
+    attr_accessor :cause
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['warning_type'] = 'warning_type'
+      @_hash['warning_code'] = 'warning_code'
+      @_hash['cause'] = 'cause'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(warning_type:, warning_code:, cause:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @warning_type = warning_type
+      @warning_code = warning_code
+      @cause = cause
+      @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.
+      warning_type = hash.key?('warning_type') ? hash['warning_type'] : nil
+      warning_code = hash.key?('warning_code') ? hash['warning_code'] : nil
+      cause = Cause.from_hash(hash['cause']) if hash['cause']
+
+      # 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.
+      Warning.new(warning_type: warning_type,
+                  warning_code: warning_code,
+                  cause: cause,
+                  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} warning_type: #{@warning_type}, warning_code: #{@warning_code}, cause:"\
+      " #{@cause}, 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} warning_type: #{@warning_type.inspect}, warning_code:"\
+      " #{@warning_code.inspect}, cause: #{@cause.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end