fdx-apimatic-sdk 0.0.1

data/lib/fdx_v660_api/models/account_type4.rb

@@ -0,0 +1,343 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Type of bank account into which deposit was made, typically CHECKING or
+  # SAVINGS. Canadian accounts will also use CHECKING for chequing account types
+  # to ensure interoperability
+  class AccountType4
+    ACCOUNT_TYPE4 = [
+      # TODO: Write general description for ENUM_401A
+      ENUM_401A = '401A'.freeze,
+
+      # TODO: Write general description for ENUM_401K
+      ENUM_401K = '401K'.freeze,
+
+      # TODO: Write general description for ENUM_403B
+      ENUM_403B = '403B'.freeze,
+
+      # TODO: Write general description for ENUM_529
+      ENUM_529 = '529'.freeze,
+
+      # TODO: Write general description for ANNUITY
+      ANNUITY = 'ANNUITY'.freeze,
+
+      # TODO: Write general description for AUTOLOAN
+      AUTOLOAN = 'AUTOLOAN'.freeze,
+
+      # TODO: Write general description for BNPL
+      BNPL = 'BNPL'.freeze,
+
+      # TODO: Write general description for BROKERAGEPRODUCT
+      BROKERAGEPRODUCT = 'BROKERAGEPRODUCT'.freeze,
+
+      # TODO: Write general description for CD
+      CD = 'CD'.freeze,
+
+      # TODO: Write general description for CHARGE
+      CHARGE = 'CHARGE'.freeze,
+
+      # TODO: Write general description for CHECKING
+      CHECKING = 'CHECKING'.freeze,
+
+      # TODO: Write general description for COMMERCIALDEPOSIT
+      COMMERCIALDEPOSIT = 'COMMERCIALDEPOSIT'.freeze,
+
+      # TODO: Write general description for COMMERCIALINVESTMENT
+      COMMERCIALINVESTMENT = 'COMMERCIALINVESTMENT'.freeze,
+
+      # TODO: Write general description for COMMERCIALLINEOFCREDIT
+      COMMERCIALLINEOFCREDIT = 'COMMERCIALLINEOFCREDIT'.freeze,
+
+      # TODO: Write general description for COMMERCIALLOAN
+      COMMERCIALLOAN = 'COMMERCIALLOAN'.freeze,
+
+      # TODO: Write general description for COVERDELL
+      COVERDELL = 'COVERDELL'.freeze,
+
+      # TODO: Write general description for CREDITCARD
+      CREDITCARD = 'CREDITCARD'.freeze,
+
+      # TODO: Write general description for DEFERREDPROFITSHARINGPLAN
+      DEFERREDPROFITSHARINGPLAN = 'DEFERREDPROFITSHARINGPLAN'.freeze,
+
+      # TODO: Write general description for DEFINEDBENEFIT
+      DEFINEDBENEFIT = 'DEFINEDBENEFIT'.freeze,
+
+      # TODO: Write general description for DIGITALASSET
+      DIGITALASSET = 'DIGITALASSET'.freeze,
+
+      # TODO: Write general description for DIGITALWALLET
+      DIGITALWALLET = 'DIGITALWALLET'.freeze,
+
+      # TODO: Write general description for ESCROW
+      ESCROW = 'ESCROW'.freeze,
+
+      # TODO: Write general description for ESOP
+      ESOP = 'ESOP'.freeze,
+
+      # TODO: Write general description for FIRSTHOMESAVINGSACCOUNT
+      FIRSTHOMESAVINGSACCOUNT = 'FIRSTHOMESAVINGSACCOUNT'.freeze,
+
+      # TODO: Write general description for FIXEDANNUITY
+      FIXEDANNUITY = 'FIXEDANNUITY'.freeze,
+
+      # TODO: Write general description for GUARDIAN
+      GUARDIAN = 'GUARDIAN'.freeze,
+
+      # TODO: Write general description for HIGHINTERESTSAVINGSACCOUNT
+      HIGHINTERESTSAVINGSACCOUNT = 'HIGHINTERESTSAVINGSACCOUNT'.freeze,
+
+      # TODO: Write general description for HOMEEQUITYLOAN
+      HOMEEQUITYLOAN = 'HOMEEQUITYLOAN'.freeze,
+
+      # TODO: Write general description for HOMELINEOFCREDIT
+      HOMELINEOFCREDIT = 'HOMELINEOFCREDIT'.freeze,
+
+      # TODO: Write general description for INDIVIDUALPENSIONPLAN
+      INDIVIDUALPENSIONPLAN = 'INDIVIDUALPENSIONPLAN'.freeze,
+
+      # TODO: Write general description for INSTALLMENT
+      INSTALLMENT = 'INSTALLMENT'.freeze,
+
+      # TODO: Write general description for INSTITUTIONALTRUST
+      INSTITUTIONALTRUST = 'INSTITUTIONALTRUST'.freeze,
+
+      # TODO: Write general description for INVESTMENTACCOUNT
+      INVESTMENTACCOUNT = 'INVESTMENTACCOUNT'.freeze,
+
+      # TODO: Write general description for IRA
+      IRA = 'IRA'.freeze,
+
+      # TODO: Write general description for KEOGH
+      KEOGH = 'KEOGH'.freeze,
+
+      # TODO: Write general description for LIFEINCOMEFUND
+      LIFEINCOMEFUND = 'LIFEINCOMEFUND'.freeze,
+
+      # TODO: Write general description for LIMITEDPURPOSECHECKING
+      LIMITEDPURPOSECHECKING = 'LIMITEDPURPOSECHECKING'.freeze,
+
+      # TODO: Write general description for LINEOFCREDIT
+      LINEOFCREDIT = 'LINEOFCREDIT'.freeze,
+
+      # TODO: Write general description for LOAN
+      LOAN = 'LOAN'.freeze,
+
+      # TODO: Write general description for LOCKEDINRETIREMENTACCOUNT
+      LOCKEDINRETIREMENTACCOUNT = 'LOCKEDINRETIREMENTACCOUNT'.freeze,
+
+      # TODO: Write general description for LOCKEDINRETIREMENTINCOMEFUND
+      LOCKEDINRETIREMENTINCOMEFUND = 'LOCKEDINRETIREMENTINCOMEFUND'.freeze,
+
+      # TODO: Write general description for LOCKEDINRETIREMENTSAVINGSPLAN
+      LOCKEDINRETIREMENTSAVINGSPLAN = 'LOCKEDINRETIREMENTSAVINGSPLAN'.freeze,
+
+      # TODO: Write general description for LONGTERMDISABILITY
+      LONGTERMDISABILITY = 'LONGTERMDISABILITY'.freeze,
+
+      # TODO: Write general description for MILITARYLOAN
+      MILITARYLOAN = 'MILITARYLOAN'.freeze,
+
+      # TODO: Write general description for MONEYMARKET
+      MONEYMARKET = 'MONEYMARKET'.freeze,
+
+      # TODO: Write general description for MORTGAGE
+      MORTGAGE = 'MORTGAGE'.freeze,
+
+      # TODO: Write general description for NONQUALIFIEDPLAN
+      NONQUALIFIEDPLAN = 'NONQUALIFIEDPLAN'.freeze,
+
+      # TODO: Write general description for OTHERDEPOSIT
+      OTHERDEPOSIT = 'OTHERDEPOSIT'.freeze,
+
+      # TODO: Write general description for OTHERINVESTMENT
+      OTHERINVESTMENT = 'OTHERINVESTMENT'.freeze,
+
+      # TODO: Write general description for PERSONALLOAN
+      PERSONALLOAN = 'PERSONALLOAN'.freeze,
+
+      # TODO: Write general description for POOLEDREGISTEREDPENSIONPLAN
+      POOLEDREGISTEREDPENSIONPLAN = 'POOLEDREGISTEREDPENSIONPLAN'.freeze,
+
+      # TODO: Write general description for PREPAID
+      PREPAID = 'PREPAID'.freeze,
+
+      # TODO: Write general description for
+      # PRESCRIBEDREGISTEREDRETIREMENTINCOMEFUND
+      PRESCRIBEDREGISTEREDRETIREMENTINCOMEFUND = 'PRESCRIBEDREGISTEREDRETIREMENTINCOMEFUND'.freeze,
+
+      # TODO: Write general description for REGISTEREDDISABILITYSAVINGSPLAN
+      REGISTEREDDISABILITYSAVINGSPLAN = 'REGISTEREDDISABILITYSAVINGSPLAN'.freeze,
+
+      # TODO: Write general description for REGISTEREDEDUCATIONSAVINGSPLAN
+      REGISTEREDEDUCATIONSAVINGSPLAN = 'REGISTEREDEDUCATIONSAVINGSPLAN'.freeze,
+
+      # TODO: Write general description for REGISTEREDPENSIONPLAN
+      REGISTEREDPENSIONPLAN = 'REGISTEREDPENSIONPLAN'.freeze,
+
+      # TODO: Write general description for REGISTEREDRETIREMENTINCOMEFUND
+      REGISTEREDRETIREMENTINCOMEFUND = 'REGISTEREDRETIREMENTINCOMEFUND'.freeze,
+
+      # TODO: Write general description for REGISTEREDRETIREMENTSAVINGSPLAN
+      REGISTEREDRETIREMENTSAVINGSPLAN = 'REGISTEREDRETIREMENTSAVINGSPLAN'.freeze,
+
+      # TODO: Write general description for RESTRICTEDLIFEINCOMEFUND
+      RESTRICTEDLIFEINCOMEFUND = 'RESTRICTEDLIFEINCOMEFUND'.freeze,
+
+      # TODO: Write general description for RESTRICTEDLOCKEDINSAVINGSPLAN
+      RESTRICTEDLOCKEDINSAVINGSPLAN = 'RESTRICTEDLOCKEDINSAVINGSPLAN'.freeze,
+
+      # TODO: Write general description for ROLLOVER
+      ROLLOVER = 'ROLLOVER'.freeze,
+
+      # TODO: Write general description for ROTH
+      ROTH = 'ROTH'.freeze,
+
+      # TODO: Write general description for SARSEP
+      SARSEP = 'SARSEP'.freeze,
+
+      # TODO: Write general description for SAVINGS
+      SAVINGS = 'SAVINGS'.freeze,
+
+      # TODO: Write general description for SHORTTERMDISABILITY
+      SHORTTERMDISABILITY = 'SHORTTERMDISABILITY'.freeze,
+
+      # TODO: Write general description for SMBLOAN
+      SMBLOAN = 'SMBLOAN'.freeze,
+
+      # TODO: Write general description for SPECIFIEDPENSIONPLAN
+      SPECIFIEDPENSIONPLAN = 'SPECIFIEDPENSIONPLAN'.freeze,
+
+      # TODO: Write general description for STUDENTLOAN
+      STUDENTLOAN = 'STUDENTLOAN'.freeze,
+
+      # TODO: Write general description for TAXABLE
+      TAXABLE = 'TAXABLE'.freeze,
+
+      # TODO: Write general description for TAXFREESAVINGSACCOUNT
+      TAXFREESAVINGSACCOUNT = 'TAXFREESAVINGSACCOUNT'.freeze,
+
+      # TODO: Write general description for TDA
+      TDA = 'TDA'.freeze,
+
+      # TODO: Write general description for TERM
+      TERM = 'TERM'.freeze,
+
+      # TODO: Write general description for TRUST
+      TRUST = 'TRUST'.freeze,
+
+      # TODO: Write general description for UGMA
+      UGMA = 'UGMA'.freeze,
+
+      # TODO: Write general description for UNIVERSALLIFE
+      UNIVERSALLIFE = 'UNIVERSALLIFE'.freeze,
+
+      # TODO: Write general description for UTMA
+      UTMA = 'UTMA'.freeze,
+
+      # TODO: Write general description for VARIABLEANNUITY
+      VARIABLEANNUITY = 'VARIABLEANNUITY'.freeze,
+
+      # TODO: Write general description for WHOLELIFE
+      WHOLELIFE = 'WHOLELIFE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ENUM_401A)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_401a' then ENUM_401A
+      when 'enum_401k' then ENUM_401K
+      when 'enum_403b' then ENUM_403B
+      when 'enum_529' then ENUM_529
+      when 'annuity' then ANNUITY
+      when 'autoloan' then AUTOLOAN
+      when 'bnpl' then BNPL
+      when 'brokerageproduct' then BROKERAGEPRODUCT
+      when 'cd' then CD
+      when 'charge' then CHARGE
+      when 'checking' then CHECKING
+      when 'commercialdeposit' then COMMERCIALDEPOSIT
+      when 'commercialinvestment' then COMMERCIALINVESTMENT
+      when 'commerciallineofcredit' then COMMERCIALLINEOFCREDIT
+      when 'commercialloan' then COMMERCIALLOAN
+      when 'coverdell' then COVERDELL
+      when 'creditcard' then CREDITCARD
+      when 'deferredprofitsharingplan' then DEFERREDPROFITSHARINGPLAN
+      when 'definedbenefit' then DEFINEDBENEFIT
+      when 'digitalasset' then DIGITALASSET
+      when 'digitalwallet' then DIGITALWALLET
+      when 'escrow' then ESCROW
+      when 'esop' then ESOP
+      when 'firsthomesavingsaccount' then FIRSTHOMESAVINGSACCOUNT
+      when 'fixedannuity' then FIXEDANNUITY
+      when 'guardian' then GUARDIAN
+      when 'highinterestsavingsaccount' then HIGHINTERESTSAVINGSACCOUNT
+      when 'homeequityloan' then HOMEEQUITYLOAN
+      when 'homelineofcredit' then HOMELINEOFCREDIT
+      when 'individualpensionplan' then INDIVIDUALPENSIONPLAN
+      when 'installment' then INSTALLMENT
+      when 'institutionaltrust' then INSTITUTIONALTRUST
+      when 'investmentaccount' then INVESTMENTACCOUNT
+      when 'ira' then IRA
+      when 'keogh' then KEOGH
+      when 'lifeincomefund' then LIFEINCOMEFUND
+      when 'limitedpurposechecking' then LIMITEDPURPOSECHECKING
+      when 'lineofcredit' then LINEOFCREDIT
+      when 'loan' then LOAN
+      when 'lockedinretirementaccount' then LOCKEDINRETIREMENTACCOUNT
+      when 'lockedinretirementincomefund' then LOCKEDINRETIREMENTINCOMEFUND
+      when 'lockedinretirementsavingsplan' then LOCKEDINRETIREMENTSAVINGSPLAN
+      when 'longtermdisability' then LONGTERMDISABILITY
+      when 'militaryloan' then MILITARYLOAN
+      when 'moneymarket' then MONEYMARKET
+      when 'mortgage' then MORTGAGE
+      when 'nonqualifiedplan' then NONQUALIFIEDPLAN
+      when 'otherdeposit' then OTHERDEPOSIT
+      when 'otherinvestment' then OTHERINVESTMENT
+      when 'personalloan' then PERSONALLOAN
+      when 'pooledregisteredpensionplan' then POOLEDREGISTEREDPENSIONPLAN
+      when 'prepaid' then PREPAID
+      when 'prescribedregisteredretirementincomefund' then PRESCRIBEDREGISTEREDRETIREMENTINCOMEFUND
+      when 'registereddisabilitysavingsplan' then REGISTEREDDISABILITYSAVINGSPLAN
+      when 'registerededucationsavingsplan' then REGISTEREDEDUCATIONSAVINGSPLAN
+      when 'registeredpensionplan' then REGISTEREDPENSIONPLAN
+      when 'registeredretirementincomefund' then REGISTEREDRETIREMENTINCOMEFUND
+      when 'registeredretirementsavingsplan' then REGISTEREDRETIREMENTSAVINGSPLAN
+      when 'restrictedlifeincomefund' then RESTRICTEDLIFEINCOMEFUND
+      when 'restrictedlockedinsavingsplan' then RESTRICTEDLOCKEDINSAVINGSPLAN
+      when 'rollover' then ROLLOVER
+      when 'roth' then ROTH
+      when 'sarsep' then SARSEP
+      when 'savings' then SAVINGS
+      when 'shorttermdisability' then SHORTTERMDISABILITY
+      when 'smbloan' then SMBLOAN
+      when 'specifiedpensionplan' then SPECIFIEDPENSIONPLAN
+      when 'studentloan' then STUDENTLOAN
+      when 'taxable' then TAXABLE
+      when 'taxfreesavingsaccount' then TAXFREESAVINGSACCOUNT
+      when 'tda' then TDA
+      when 'term' then TERM
+      when 'trust' then TRUST
+      when 'ugma' then UGMA
+      when 'universallife' then UNIVERSALLIFE
+      when 'utma' then UTMA
+      when 'variableannuity' then VARIABLEANNUITY
+      when 'wholelife' then WHOLELIFE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/accounts_entity.rb

@@ -0,0 +1,109 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # An optionally paginated array of accounts
+  class AccountsEntity < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Page keys for navigating result sets
+    # @return [PageMetadata]
+    attr_accessor :page
+
+    # Resource URLs for navigating result sets
+    # @return [PageMetadataLinks1]
+    attr_accessor :links
+
+    # An array of accounts with entity types dependent on the account type
+    # (deposit, investment, loan, line of credit, annuity, insurance,
+    # commercial, or digital wallet)
+    # @return [Array[Object]]
+    attr_accessor :accounts
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['page'] = 'page'
+      @_hash['links'] = 'links'
+      @_hash['accounts'] = 'accounts'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        page
+        links
+        accounts
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(page: SKIP, links: SKIP, accounts: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @page = page unless page == SKIP
+      @links = links unless links == SKIP
+      @accounts = accounts unless accounts == 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.
+      page = PageMetadata.from_hash(hash['page']) if hash['page']
+      links = PageMetadataLinks1.from_hash(hash['links']) if hash['links']
+      accounts = hash.key?('accounts') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AccountsEntityAccounts), hash['accounts']
+      ) : 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.
+      AccountsEntity.new(page: page,
+                         links: links,
+                         accounts: accounts,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AccountsEntity | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} page: #{@page}, links: #{@links}, accounts: #{@accounts},"\
+      " 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} page: #{@page.inspect}, links: #{@links.inspect}, accounts:"\
+      " #{@accounts.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/fdx_v660_api/models/active_inactive_status.rb

@@ -0,0 +1,36 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # Specifies the employment status of ACTIVE or INACTIVE
+  class ActiveInactiveStatus
+    ACTIVE_INACTIVE_STATUS = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for INACTIVE
+      INACTIVE = 'INACTIVE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'inactive' then INACTIVE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/active_inactive_status2.rb

@@ -0,0 +1,36 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # The employee's employment status, ACTIVE or INACTIVE
+  class ActiveInactiveStatus2
+    ACTIVE_INACTIVE_STATUS2 = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for INACTIVE
+      INACTIVE = 'INACTIVE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'inactive' then INACTIVE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/fdx_v660_api/models/address.rb

@@ -0,0 +1,152 @@
+# fdx_v660_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module FdxV660Api
+  # U.S. domestic address or a foreign address with country other than 'US'
+  class Address < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Address line 1
+    # @return [String]
+    attr_accessor :line1
+
+    # Address line 2
+    # @return [String]
+    attr_accessor :line2
+
+    # Address line 3
+    # @return [String]
+    attr_accessor :line3
+
+    # City
+    # @return [String]
+    attr_accessor :city
+
+    # State, Province, Territory, Canton or Prefecture. From [Universal Postal
+    # Union](https://www.upu.int/en/Postal-Solutions/Programmes-Services/Address
+    # ing-Solutions#addressing-s42-standard) as of 2-26-2020, [S42 International
+    # Address
+    # Standards](https://www.upu.int/UPU/media/upu/documents/PostCode/S42_Intern
+    # ational-Addressing-Standards.pdf). For U.S. addresses can be a 2-character
+    # code from `StateCode`. For Canadian addresses can be a 2-character code
+    # from `ProvinceTerritoryCode`
+    # @return [String]
+    attr_accessor :region
+
+    # Postal code
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Country code
+    # @return [Iso3166CountryCode1]
+    attr_accessor :country
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line1'] = 'line1'
+      @_hash['line2'] = 'line2'
+      @_hash['line3'] = 'line3'
+      @_hash['city'] = 'city'
+      @_hash['region'] = 'region'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['country'] = 'country'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line1
+        line2
+        line3
+        city
+        region
+        postal_code
+        country
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line1: SKIP, line2: SKIP, line3: SKIP, city: SKIP,
+                   region: SKIP, postal_code: SKIP, country: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @line1 = line1 unless line1 == SKIP
+      @line2 = line2 unless line2 == SKIP
+      @line3 = line3 unless line3 == SKIP
+      @city = city unless city == SKIP
+      @region = region unless region == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @country = country unless country == 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.
+      line1 = hash.key?('line1') ? hash['line1'] : SKIP
+      line2 = hash.key?('line2') ? hash['line2'] : SKIP
+      line3 = hash.key?('line3') ? hash['line3'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      region = hash.key?('region') ? hash['region'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      country = hash.key?('country') ? hash['country'] : 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.
+      Address.new(line1: line1,
+                  line2: line2,
+                  line3: line3,
+                  city: city,
+                  region: region,
+                  postal_code: postal_code,
+                  country: country,
+                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Address | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line1: #{@line1}, line2: #{@line2}, line3: #{@line3}, city: #{@city},"\
+      " region: #{@region}, postal_code: #{@postal_code}, country: #{@country},"\
+      " 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} line1: #{@line1.inspect}, line2: #{@line2.inspect}, line3:"\
+      " #{@line3.inspect}, city: #{@city.inspect}, region: #{@region.inspect}, postal_code:"\
+      " #{@postal_code.inspect}, country: #{@country.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end