payrix-api-sdk 1.0.0

data/lib/payrix/models/assessments_response.rb

@@ -0,0 +1,653 @@
+# payrix
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payrix
+  # AssessmentsResponse Model.
+  class AssessmentsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The ID of this resource.
+    # @return [String]
+    attr_accessor :id
+
+    # The date and time at which this resource was created. The format should be
+    # YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [String]
+    attr_accessor :created
+
+    # The date and time at which this resource was modified. The format should
+    # be YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [String]
+    attr_accessor :modified
+
+    # The date and time at which this resource was modified. The format should
+    # be YYYY-MM-DD HH:MM:SS.SSSS
+    # @return [Object]
+    attr_accessor :creator
+
+    # The identifier of the Login that last modified this resource.
+    # @return [String]
+    attr_accessor :modifier
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :entity
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :onentity
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :forentity
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :partition
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :opposing_assessment
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :fee
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :disbursement
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :txn
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :chargeback
+
+    # The identifier of the Login that last modified this resource.
+    # @return [Object]
+    attr_accessor :merchant
+
+    # The type of event that triggered this assessments resource.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `1` - **DAYS**. This assessment triggers every day.
+    # - `2` - **WEEKS**. This assessment triggers every week.
+    # - `3` - **MONTHS**. This assessment triggers every month.
+    # - `4` - **YEARS**. This assessment triggers every year.
+    # - `5` - **SINGLE**. This assessment is a one-off event.
+    # - `6` - **AUTH**. This assessment triggers at the time of authorization of
+    # a transaction.
+    # - `7` - **CAPTURE**. This assessment triggers at the capture time of a
+    # Transaction.
+    # - `8` - **REFUND**. This assessment triggers when Refund transaction is
+    # processed.
+    # - `9` - **BOARD**. This assessment triggers when the Merchant is boarded.
+    # - `10` - **PAYOUT**. This assessment triggers when a payout is processed.
+    # - `11` - **CHARGEBACK**. This assessment triggers when a card chargeback
+    # occurs.
+    # - `12` - **OVERDRAFT**. This assessment triggers when an overdraft usage
+    # charge from a bank is levied.
+    # - `13` - **INTERCHANGE**. This assessment triggers when interchange Fees
+    # are assessed for the Transactions of this Merchant.
+    # - `14` - **PROCESSOR**. This assessment triggers when the Transactions of
+    # this Merchant are processed by a payment processor.
+    # - `15` - **ACHFAIL**. This assessment triggers when an automated clearing
+    # house failure occurs.
+    # - `16` - **ACCOUNT**. This assessment triggers when a bank account is
+    # verified.
+    # - `17` - **SIFT**. This assessment triggers on the Transaction fraud
+    # score.
+    # - `18` - **ADJUSTMENT**. This assessment triggers when the transaction is
+    # adjusted.
+    # - `19` - **RETRIEVAL**. This assessment triggers on Retrieval Request
+    # Chargeback.
+    # - `20` - **ARBITRATION**. This assessment triggers on an Arbitration
+    # Chargeback.
+    # - `21` - **ECSALE**. This assessment triggers on an eCheck Sale
+    # transaction.
+    # - `22` - **ECREFUND**. This assessment triggers on an eCheck Refund
+    # transaction.
+    # - `23` - **ECRETURN**. This assessment triggers on an eCheck Return
+    # transaction.
+    # - `24` - **SETTLEMENT**. This assessment triggers on a transaction
+    # settlement.
+    # - `25` - **MISUSE**. This assessment triggers on a Misuse of
+    # authorization.
+    # - `26` - **PROFIT_SHARE**. This assessment triggers on a Profit Sharing
+    # entry event.
+    # - `27` - **UNAUTH**. This assessment triggers at the time of an
+    # unauthorized entry.
+    # - `28` - **ACHNOC**. This assessment triggers at the time of an ACH
+    # Notification Change.
+    # - `29` - **ECNOC**. This assessment triggers at the time of an eCheck
+    # Notification Change.
+    # - `30` - **ECFAIL**. This assessment triggers at the time of an eCheck
+    # Fail.
+    # - `31` - **ECNSF**. This assessment triggers an the time of an eCheck
+    # non-disbursed funds.
+    # - `32` - **CURRENCY_CONVERSION**. This assessment triggers at the time of
+    # a currency conversion.
+    # - `33` - **TERMINAL_TXN**. This assessment triggers at the time of a
+    # terminal transaction.
+    # - `34` - **REVERSE_PAYOUT**. This assessment triggers when a payout has
+    # been partially reversed.
+    # - `35` - **PARTIAL_REVERSE_PAYOUT**. This assessment triggers when a
+    # payout is partially reversed.
+    # - `43` - **PAYMENT_CHECK** Single payment check (deprecated).
+    # - `44` - **PAYMENT_UPDATE**. This assessment triggers on a payment update
+    # for Account Updater.
+    # - `45` - **PAYMENT_GROUP_CHECK** Group payment check (deprecated).
+    # - `46` - **PAYMENT_GROUP_UPDATE**. This assessment triggers on a payment
+    # group update for Account Updater.
+    # - `47` - **ENTRY_REFUND**. This assessment triggers on an entry refund.
+    # - `51` - **STATEMENT** Payment of statement.
+    # - `52` - **MERCHANT_CREATION** Merchant fee upon creation.
+    # - `53` - **REALTIME_BUSINESS_SEARCH** Real-time business search.
+    # - `54` - **REALTIME_MEMBER_SEARCH** Real-time member search.
+    # - `55` - **MASTER_CARD_MATCH** Mastercard match.
+    # - `56` - **BUSINESS_INSTANT_ID** Business instant ID.
+    # - `57` - **CONSUMER_INSTANT_ID** Consumer instant ID.
+    # - `58` - **THREAT_METRIX** Threat metrix.
+    # - `59` - **LEGIT_SCRIPT_REGISTER** Legit script register.
+    # - `60` - **EQUIFAX_CONSUMER_REPORT** Equifax consumer report.
+    # - `61` - **GUIDE_STAR** Guidestar.
+    # - `62` - **PAYLOAD_ATTRIBUTE** Internal Decision V2.
+    # - `63` - **TIN_CHECK** Tin check.
+    # - `64` - **EQUIFAX_COMMERCIAL_REPORT** Equifax commercial report.
+    # - `65` - **LEGIT_SCRIPT_CHECK_MERCHANT** Legit script check merchant.
+    # - `66` - **PLAID** Plaid.
+    # - `67` - **STATEMENT_REVERSAL** Reversal of statement.
+    # - `68` - **GIACT_ECHECK** GIACT call made to verify creator Echeck bank
+    # Account.
+    # - `69` - **GIACT_BANK_ACCOUNT** Giact calls to verify merchant settlement
+    # account on sign-up or post-boarding account.
+    # - `70` - **BOARD_DECISION** Process decision fee after board.
+    # - `71` - **TXN_RISK_DECISION** Txn going through Risk decision.
+    # - `72` - **FANF** External Fees.
+    # - `73` - **MCLOCATION** External Fees.
+    # - `74` - **VISAINTEGRITY** External Fees.
+    # - `75` - **SAFERPAYMENTS_BASIC** External Fees.
+    # - `76` - **SAFERPAYMENTS_MANAGED** External Fees.
+    # - `77` - **SAFERPAYMENTS_PCI_NONVALIDATION** External Fees.
+    # - `78` - **OMNITOKENS_VOLUME** External Fees.
+    # - `79` - **PAYOUT_RETURN** Payout Return.
+    # - `80` - **PAYOUT_PARTIAL_RETURN** Payout Partial Return.
+    # - `81` - **REV_SHARE** Rev share.
+    # - `82` - **CARD_SETTLEMENT** Txns card settlement.
+    # - `83` - **ECHECK_SETTLEMENT** Txns e-check settlement.
+    # - `84` - **REV_SHARE_CARD** Rev Share Schedules.
+    # - `85` - **REV_SHARE_ECHECK** Rev Share Schedules.
+    # - `86` - **REV_SHARE_DBM** Rev Share Schedules.
+    # - `87` - **PREARBITRATION** Chargeback PreArbitration.
+    # - `88` - **PLAID_IDENTITY_MACH** Plaid.
+    # - `89` - **TXN_PLAID_IDENTITY_MACH** Txns Plaid.
+    # - `90` - **PLAID_GET_IDENTITY** Plaid.
+    # - `91` - **TXN_PLAID_GET_IDENTITY** Txns Plaid.
+    # - `92` - **PLAID_GET_AUTH** Plaid.
+    # - `93` - **TXN_PLAID_GET_AUTH** Txns Plaid.
+    # - `94` - **REVERSAL** Chargeback Reversal.
+    # - `95` - **REPRESENTMENT** Chargeback Representment.
+    # - `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.
+    # - `101` - **IC_RETAIN_PASSTHRU_REFUND** Interchange retain pass on refund.
+    # - `200` - **VALUTEC_ESSENTIAL_GIFT** External Fees.
+    # - `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN** External Fees.
+    # - `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE** External Fees.
+    # - `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN** External Fees.
+    # - `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE** External Fees.
+    # - `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN** External Fees.
+    # - `206` - **VALUTEC_TRANSACTION_FEE** External Fees.
+    # - `207` - **VALUTEC_SETUP_FEE** External Fees.
+    # - `208` - **VALUTEC_GIFT_ACH_POOLING** External Fees.
+    # - `209` - **VALUTEC_JUMP_START_KIT** External Fees.
+    # - `210` - **VALUTEC_LAUNCH_BOX_KIT** External Fees.
+    # - `211` - **VALUTEC_500_CUSTOM_CARDS** External Fees.
+    # - `212` - **VALUTEC_MAINTENANCE_FEE** External Fees.
+    # - `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME** External Fees.
+    # - `214` - **EFE_MWC_RESIDUAL_ATELIO** EFE External Fees.
+    # - `215` - **EFE_MWC_RESIDUAL_PARAFIN** EFE External Fees.
+    # - `216` - **EFE_MWC_BILLING** EFE External Fees.
+    # - `217` - **FRAUDSIGHT_CNP_DECISION** External Fees.
+    # - `218` - **FRAUDSIGHT_CP_DECISION** External Fees.
+    # - `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** External Fees.
+    # - `401` - **REVBOOST_EMBEDDED_TMS_PPT** External Fees.
+    # - `402` - **TXN_THREAT_METRIX** External Fees.
+    # - `403` - **THREAT_METRIX_EMAILAGE** External Fees.
+    # - `404` - **THREAT_METRIX_FRAUD_POINT** External Fees.
+    # - `405` - **GIACT_INQUIRY** External Fees.
+    # - `406` - **GIACT_TXN_GAUTHENTICATE** External Fees.
+    # - `407` - **TRULIOO_IDV** External Fees.
+    # - `408` - **TRULIOO_AMLLDV** External Fees.
+    # - `409` - **TRULIOO_BUSINESS_VERIFICATION** External Fees.
+    # - `410` - **THREAT_METRIX_PHONE_FINDER** External Fees.
+    # - `601` - **TIER_NON_QUALIFIED_COUNT** Risk Based Tier Fees.
+    # - `602` - **TIER_QUALIFIED_COUNT** Risk Based Tier Fees.
+    # - `603` - **TIER_MID_QUALIFIED_COUNT** Risk Based Tier Fees.
+    # - `604` - **TIER_HIGH_RISK_COUNT** Risk Based Tier Fees.
+    # - `605` - **TIER_NON_QUALIFIED_VOLUME** Risk Based Tier Fees.
+    # - `606` - **TIER_QUALIFIED_VOLUME** Risk Based Tier Fees.
+    # - `607` - **TIER_MID_QUALIFIED_VOLUME** Risk Based Tier Fees.
+    # - `608` - **TIER_HIGH_RISK_VOLUME** Risk Based Tier Fees
+    # </details>
+    # @return [AssessmentEventEnum]
+    attr_accessor :event
+
+    # The type of event that triggered this assessments resource.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `1` - **DAYS**. This assessment triggers every day.
+    # - `2` - **WEEKS**. This assessment triggers every week.
+    # - `3` - **MONTHS**. This assessment triggers every month.
+    # - `4` - **YEARS**. This assessment triggers every year.
+    # - `5` - **SINGLE**. This assessment is a one-off event.
+    # - `6` - **AUTH**. This assessment triggers at the time of authorization of
+    # a transaction.
+    # - `7` - **CAPTURE**. This assessment triggers at the capture time of a
+    # Transaction.
+    # - `8` - **REFUND**. This assessment triggers when Refund transaction is
+    # processed.
+    # - `9` - **BOARD**. This assessment triggers when the Merchant is boarded.
+    # - `10` - **PAYOUT**. This assessment triggers when a payout is processed.
+    # - `11` - **CHARGEBACK**. This assessment triggers when a card chargeback
+    # occurs.
+    # - `12` - **OVERDRAFT**. This assessment triggers when an overdraft usage
+    # charge from a bank is levied.
+    # - `13` - **INTERCHANGE**. This assessment triggers when interchange Fees
+    # are assessed for the Transactions of this Merchant.
+    # - `14` - **PROCESSOR**. This assessment triggers when the Transactions of
+    # this Merchant are processed by a payment processor.
+    # - `15` - **ACHFAIL**. This assessment triggers when an automated clearing
+    # house failure occurs.
+    # - `16` - **ACCOUNT**. This assessment triggers when a bank account is
+    # verified.
+    # - `17` - **SIFT**. This assessment triggers on the Transaction fraud
+    # score.
+    # - `18` - **ADJUSTMENT**. This assessment triggers when the transaction is
+    # adjusted.
+    # - `19` - **RETRIEVAL**. This assessment triggers on Retrieval Request
+    # Chargeback.
+    # - `20` - **ARBITRATION**. This assessment triggers on an Arbitration
+    # Chargeback.
+    # - `21` - **ECSALE**. This assessment triggers on an eCheck Sale
+    # transaction.
+    # - `22` - **ECREFUND**. This assessment triggers on an eCheck Refund
+    # transaction.
+    # - `23` - **ECRETURN**. This assessment triggers on an eCheck Return
+    # transaction.
+    # - `24` - **SETTLEMENT**. This assessment triggers on a transaction
+    # settlement.
+    # - `25` - **MISUSE**. This assessment triggers on a Misuse of
+    # authorization.
+    # - `26` - **PROFIT_SHARE**. This assessment triggers on a Profit Sharing
+    # entry event.
+    # - `27` - **UNAUTH**. This assessment triggers at the time of an
+    # unauthorized entry.
+    # - `28` - **ACHNOC**. This assessment triggers at the time of an ACH
+    # Notification Change.
+    # - `29` - **ECNOC**. This assessment triggers at the time of an eCheck
+    # Notification Change.
+    # - `30` - **ECFAIL**. This assessment triggers at the time of an eCheck
+    # Fail.
+    # - `31` - **ECNSF**. This assessment triggers an the time of an eCheck
+    # non-disbursed funds.
+    # - `32` - **CURRENCY_CONVERSION**. This assessment triggers at the time of
+    # a currency conversion.
+    # - `33` - **TERMINAL_TXN**. This assessment triggers at the time of a
+    # terminal transaction.
+    # - `34` - **REVERSE_PAYOUT**. This assessment triggers when a payout has
+    # been partially reversed.
+    # - `35` - **PARTIAL_REVERSE_PAYOUT**. This assessment triggers when a
+    # payout is partially reversed.
+    # - `43` - **PAYMENT_CHECK** Single payment check (deprecated).
+    # - `44` - **PAYMENT_UPDATE**. This assessment triggers on a payment update
+    # for Account Updater.
+    # - `45` - **PAYMENT_GROUP_CHECK** Group payment check (deprecated).
+    # - `46` - **PAYMENT_GROUP_UPDATE**. This assessment triggers on a payment
+    # group update for Account Updater.
+    # - `47` - **ENTRY_REFUND**. This assessment triggers on an entry refund.
+    # - `51` - **STATEMENT** Payment of statement.
+    # - `52` - **MERCHANT_CREATION** Merchant fee upon creation.
+    # - `53` - **REALTIME_BUSINESS_SEARCH** Real-time business search.
+    # - `54` - **REALTIME_MEMBER_SEARCH** Real-time member search.
+    # - `55` - **MASTER_CARD_MATCH** Mastercard match.
+    # - `56` - **BUSINESS_INSTANT_ID** Business instant ID.
+    # - `57` - **CONSUMER_INSTANT_ID** Consumer instant ID.
+    # - `58` - **THREAT_METRIX** Threat metrix.
+    # - `59` - **LEGIT_SCRIPT_REGISTER** Legit script register.
+    # - `60` - **EQUIFAX_CONSUMER_REPORT** Equifax consumer report.
+    # - `61` - **GUIDE_STAR** Guidestar.
+    # - `62` - **PAYLOAD_ATTRIBUTE** Internal Decision V2.
+    # - `63` - **TIN_CHECK** Tin check.
+    # - `64` - **EQUIFAX_COMMERCIAL_REPORT** Equifax commercial report.
+    # - `65` - **LEGIT_SCRIPT_CHECK_MERCHANT** Legit script check merchant.
+    # - `66` - **PLAID** Plaid.
+    # - `67` - **STATEMENT_REVERSAL** Reversal of statement.
+    # - `68` - **GIACT_ECHECK** GIACT call made to verify creator Echeck bank
+    # Account.
+    # - `69` - **GIACT_BANK_ACCOUNT** Giact calls to verify merchant settlement
+    # account on sign-up or post-boarding account.
+    # - `70` - **BOARD_DECISION** Process decision fee after board.
+    # - `71` - **TXN_RISK_DECISION** Txn going through Risk decision.
+    # - `72` - **FANF** External Fees.
+    # - `73` - **MCLOCATION** External Fees.
+    # - `74` - **VISAINTEGRITY** External Fees.
+    # - `75` - **SAFERPAYMENTS_BASIC** External Fees.
+    # - `76` - **SAFERPAYMENTS_MANAGED** External Fees.
+    # - `77` - **SAFERPAYMENTS_PCI_NONVALIDATION** External Fees.
+    # - `78` - **OMNITOKENS_VOLUME** External Fees.
+    # - `79` - **PAYOUT_RETURN** Payout Return.
+    # - `80` - **PAYOUT_PARTIAL_RETURN** Payout Partial Return.
+    # - `81` - **REV_SHARE** Rev share.
+    # - `82` - **CARD_SETTLEMENT** Txns card settlement.
+    # - `83` - **ECHECK_SETTLEMENT** Txns e-check settlement.
+    # - `84` - **REV_SHARE_CARD** Rev Share Schedules.
+    # - `85` - **REV_SHARE_ECHECK** Rev Share Schedules.
+    # - `86` - **REV_SHARE_DBM** Rev Share Schedules.
+    # - `87` - **PREARBITRATION** Chargeback PreArbitration.
+    # - `88` - **PLAID_IDENTITY_MACH** Plaid.
+    # - `89` - **TXN_PLAID_IDENTITY_MACH** Txns Plaid.
+    # - `90` - **PLAID_GET_IDENTITY** Plaid.
+    # - `91` - **TXN_PLAID_GET_IDENTITY** Txns Plaid.
+    # - `92` - **PLAID_GET_AUTH** Plaid.
+    # - `93` - **TXN_PLAID_GET_AUTH** Txns Plaid.
+    # - `94` - **REVERSAL** Chargeback Reversal.
+    # - `95` - **REPRESENTMENT** Chargeback Representment.
+    # - `96` - **OMNITOKENS_MONTHLY** Omnitokens Monthly Fee.
+    # - `101` - **IC_RETAIN_PASSTHRU_REFUND** Interchange retain pass on refund.
+    # - `200` - **VALUTEC_ESSENTIAL_GIFT** External Fees.
+    # - `201` - **VALUTEC_ESSENTIAL_MONTHLY_TXN** External Fees.
+    # - `202` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE** External Fees.
+    # - `203` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_TXN** External Fees.
+    # - `204` - **VALUTEC_LOYALTY_PLUS_PACKAGE** External Fees.
+    # - `205` - **VALUTEC_LOYALTY_PLUS_PACKAGE_TXN** External Fees.
+    # - `206` - **VALUTEC_TRANSACTION_FEE** External Fees.
+    # - `207` - **VALUTEC_SETUP_FEE** External Fees.
+    # - `208` - **VALUTEC_GIFT_ACH_POOLING** External Fees.
+    # - `209` - **VALUTEC_JUMP_START_KIT** External Fees.
+    # - `210` - **VALUTEC_LAUNCH_BOX_KIT** External Fees.
+    # - `211` - **VALUTEC_500_CUSTOM_CARDS** External Fees.
+    # - `212` - **VALUTEC_MAINTENANCE_FEE** External Fees.
+    # - `213` - **VALUTEC_DIGITAL_GIFT_PLUS_PACKAGE_ME** External Fees.
+    # - `214` - **EFE_MWC_RESIDUAL_ATELIO** EFE External Fees.
+    # - `215` - **EFE_MWC_RESIDUAL_PARAFIN** EFE External Fees.
+    # - `216` - **EFE_MWC_BILLING** EFE External Fees.
+    # - `217` - **FRAUDSIGHT_CNP_DECISION** External Fees.
+    # - `218` - **FRAUDSIGHT_CP_DECISION** External Fees.
+    # - `400` - **REVBOOST_EMBEDDED_TMS_MONTHLY** External Fees.
+    # - `401` - **REVBOOST_EMBEDDED_TMS_PPT** External Fees.
+    # - `402` - **TXN_THREAT_METRIX** External Fees.
+    # - `403` - **THREAT_METRIX_EMAILAGE** External Fees.
+    # - `404` - **THREAT_METRIX_FRAUD_POINT** External Fees.
+    # - `405` - **GIACT_INQUIRY** External Fees.
+    # - `406` - **GIACT_TXN_GAUTHENTICATE** External Fees.
+    # - `407` - **TRULIOO_IDV** External Fees.
+    # - `408` - **TRULIOO_AMLLDV** External Fees.
+    # - `409` - **TRULIOO_BUSINESS_VERIFICATION** External Fees.
+    # - `410` - **THREAT_METRIX_PHONE_FINDER** External Fees.
+    # - `601` - **TIER_NON_QUALIFIED_COUNT** Risk Based Tier Fees.
+    # - `602` - **TIER_QUALIFIED_COUNT** Risk Based Tier Fees.
+    # - `603` - **TIER_MID_QUALIFIED_COUNT** Risk Based Tier Fees.
+    # - `604` - **TIER_HIGH_RISK_COUNT** Risk Based Tier Fees.
+    # - `605` - **TIER_NON_QUALIFIED_VOLUME** Risk Based Tier Fees.
+    # - `606` - **TIER_QUALIFIED_VOLUME** Risk Based Tier Fees.
+    # - `607` - **TIER_MID_QUALIFIED_VOLUME** Risk Based Tier Fees.
+    # - `608` - **TIER_HIGH_RISK_VOLUME** Risk Based Tier Fees
+    # </details>
+    # @return [Object]
+    attr_accessor :event_id
+
+    # A description of this assessments resource.
+    # @return [String]
+    attr_accessor :description
+
+    # The amount involved in this assessments resource. It refers to the amount
+    # charged, transferred, or disbursed. 
+    # This field is specified in cents(up to three decimal points)
+    # @return [Float]
+    attr_accessor :amount
+
+    # The platform used to process this assessment.
+    # <details>
+    # <summary>Valid Values</summary>
+    # - `APPLE` - **Apple Payment Processor**
+    # - `ELAVON` - **ELAVON Payment Processor**
+    # - `FIRSTDATA` - **FirstData Payment Processor**
+    # - `GOOGLE` - **Google Payment Processor**
+    # - `VANTIV` - **Worldpay / Vantiv eComm Payment Processor (VAP)**
+    # - `VCORE` - **Worldpay / Vantiv Core Payment Processor**
+    # - `WELLSACH` - **Wells Fargo Merchant Services Payment Processor (ACH)**
+    # - `WELLSFARGO` - **Wells Fargo Merchant Services Payment Processor**
+    # - `WFSINGLE` - **Wells Fargo Single Payment Processor**
+    # - `WORLDPAY` - **Worldpay Payment Processor**
+    # - `TDBANKCA` - **TD Bank Canada Payment Processor**
+    # </details>
+    # @return [AssessmentPlatformEnum]
+    attr_accessor :platform
+
+    # The currency of the amount in this assessments resource. See <a
+    # href="https://www.iban.com/currency-codes" target="_blank">Currency
+    # codes</a>  for all valid values.
+    # @return [CurrencyEnum]
+    attr_accessor :currency
+
+    # The currency of the amount in this assessments resource. See <a
+    # href="https://www.iban.com/currency-codes" target="_blank">Currency
+    # codes</a>  for all valid values.
+    # @return [AssessmentsResponse]
+    attr_accessor :opposing_assessments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['created'] = 'created'
+      @_hash['modified'] = 'modified'
+      @_hash['creator'] = 'creator'
+      @_hash['modifier'] = 'modifier'
+      @_hash['entity'] = 'entity'
+      @_hash['onentity'] = 'onentity'
+      @_hash['forentity'] = 'forentity'
+      @_hash['partition'] = 'partition'
+      @_hash['opposing_assessment'] = 'opposingAssessment'
+      @_hash['fee'] = 'fee'
+      @_hash['disbursement'] = 'disbursement'
+      @_hash['txn'] = 'txn'
+      @_hash['chargeback'] = 'chargeback'
+      @_hash['merchant'] = 'merchant'
+      @_hash['event'] = 'event'
+      @_hash['event_id'] = 'eventId'
+      @_hash['description'] = 'description'
+      @_hash['amount'] = 'amount'
+      @_hash['platform'] = 'platform'
+      @_hash['currency'] = 'currency'
+      @_hash['opposing_assessments'] = 'opposingAssessments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        created
+        modified
+        creator
+        modifier
+        entity
+        onentity
+        forentity
+        partition
+        opposing_assessment
+        fee
+        disbursement
+        txn
+        chargeback
+        merchant
+        event
+        event_id
+        description
+        amount
+        platform
+        currency
+        opposing_assessments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        currency
+      ]
+    end
+
+    def initialize(id = SKIP, created = SKIP, modified = SKIP, creator = SKIP,
+                   modifier = SKIP, entity = SKIP, onentity = SKIP,
+                   forentity = SKIP, partition = SKIP,
+                   opposing_assessment = SKIP, fee = SKIP, disbursement = SKIP,
+                   txn = SKIP, chargeback = SKIP, merchant = SKIP, event = SKIP,
+                   event_id = SKIP, description = SKIP, amount = SKIP,
+                   platform = SKIP, currency = SKIP,
+                   opposing_assessments = SKIP)
+      @id = id unless id == SKIP
+      @created = created unless created == SKIP
+      @modified = modified unless modified == SKIP
+      @creator = creator unless creator == SKIP
+      @modifier = modifier unless modifier == SKIP
+      @entity = entity unless entity == SKIP
+      @onentity = onentity unless onentity == SKIP
+      @forentity = forentity unless forentity == SKIP
+      @partition = partition unless partition == SKIP
+      @opposing_assessment = opposing_assessment unless opposing_assessment == SKIP
+      @fee = fee unless fee == SKIP
+      @disbursement = disbursement unless disbursement == SKIP
+      @txn = txn unless txn == SKIP
+      @chargeback = chargeback unless chargeback == SKIP
+      @merchant = merchant unless merchant == SKIP
+      @event = event unless event == SKIP
+      @event_id = event_id unless event_id == SKIP
+      @description = description unless description == SKIP
+      @amount = amount unless amount == SKIP
+      @platform = platform unless platform == SKIP
+      @currency = currency unless currency == SKIP
+      @opposing_assessments = opposing_assessments unless opposing_assessments == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      created = hash.key?('created') ? hash['created'] : SKIP
+      modified = hash.key?('modified') ? hash['modified'] : SKIP
+      creator = hash.key?('creator') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AssessmentsResponseCreator), hash['creator']
+      ) : SKIP
+      modifier = hash.key?('modifier') ? hash['modifier'] : SKIP
+      entity = hash.key?('entity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AssessmentsResponseEntity), hash['entity']
+      ) : SKIP
+      onentity = hash.key?('onentity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AssessmentsResponseOnentity), hash['onentity']
+      ) : SKIP
+      forentity = hash.key?('forentity') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AssessmentsResponseForentity), hash['forentity']
+      ) : SKIP
+      partition = hash.key?('partition') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AssessmentsResponsePartition), hash['partition']
+      ) : SKIP
+      opposing_assessment = hash.key?('opposingAssessment') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AssessmentsResponseOpposingAssessment), hash['opposingAssessment']
+      ) : SKIP
+      fee = hash.key?('fee') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AssessmentsResponseFee), hash['fee']
+      ) : SKIP
+      disbursement = hash.key?('disbursement') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AssessmentsResponseDisbursement), hash['disbursement']
+      ) : SKIP
+      txn = hash.key?('txn') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AssessmentsResponseTxn), hash['txn']
+      ) : SKIP
+      chargeback = hash.key?('chargeback') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AssessmentsResponseChargeback), hash['chargeback']
+      ) : SKIP
+      merchant = hash.key?('merchant') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AssessmentsResponseMerchant), hash['merchant']
+      ) : SKIP
+      event = hash.key?('event') ? hash['event'] : SKIP
+      event_id = hash.key?('eventId') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:AssessmentsResponseEventId), hash['eventId']
+      ) : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      platform = hash.key?('platform') ? hash['platform'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      opposing_assessments = AssessmentsResponse.from_hash(hash['opposingAssessments']) if
+        hash['opposingAssessments']
+
+      # Create object from extracted values.
+      AssessmentsResponse.new(id,
+                              created,
+                              modified,
+                              creator,
+                              modifier,
+                              entity,
+                              onentity,
+                              forentity,
+                              partition,
+                              opposing_assessment,
+                              fee,
+                              disbursement,
+                              txn,
+                              chargeback,
+                              merchant,
+                              event,
+                              event_id,
+                              description,
+                              amount,
+                              platform,
+                              currency,
+                              opposing_assessments)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AssessmentsResponse | 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} id: #{@id}, created: #{@created}, modified: #{@modified}, creator:"\
+      " #{@creator}, modifier: #{@modifier}, entity: #{@entity}, onentity: #{@onentity},"\
+      " forentity: #{@forentity}, partition: #{@partition}, opposing_assessment:"\
+      " #{@opposing_assessment}, fee: #{@fee}, disbursement: #{@disbursement}, txn: #{@txn},"\
+      " chargeback: #{@chargeback}, merchant: #{@merchant}, event: #{@event}, event_id:"\
+      " #{@event_id}, description: #{@description}, amount: #{@amount}, platform: #{@platform},"\
+      " currency: #{@currency}, opposing_assessments: #{@opposing_assessments}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, created: #{@created.inspect}, modified:"\
+      " #{@modified.inspect}, creator: #{@creator.inspect}, modifier: #{@modifier.inspect},"\
+      " entity: #{@entity.inspect}, onentity: #{@onentity.inspect}, forentity:"\
+      " #{@forentity.inspect}, partition: #{@partition.inspect}, opposing_assessment:"\
+      " #{@opposing_assessment.inspect}, fee: #{@fee.inspect}, disbursement:"\
+      " #{@disbursement.inspect}, txn: #{@txn.inspect}, chargeback: #{@chargeback.inspect},"\
+      " merchant: #{@merchant.inspect}, event: #{@event.inspect}, event_id: #{@event_id.inspect},"\
+      " description: #{@description.inspect}, amount: #{@amount.inspect}, platform:"\
+      " #{@platform.inspect}, currency: #{@currency.inspect}, opposing_assessments:"\
+      " #{@opposing_assessments.inspect}>"
+    end
+  end
+end