apimatic-cp-sdk 0.0.1

data/lib/cell_point_api/models/payment_transaction.rb

@@ -0,0 +1,605 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module CellPointApi
+  # A Payment Transaction is a transaction that is processed by a payment
+  # processor.
+  class PaymentTransaction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for this transaction.
+    # @return [String]
+    attr_accessor :id
+
+    # Identifier for an order.
+    # @return [String]
+    attr_accessor :order_id
+
+    # Discriminator used to identify the type of transaction.
+    # @return [Type2]
+    attr_accessor :type
+
+    # Details about a failure that happened on a transaction.
+    # @return [TransactionFailure]
+    attr_accessor :failure
+
+    # When the transaction was created.
+    # @return [DateTime]
+    attr_accessor :created_at
+
+    # Acquirer or Payment Service Provider (PSP) that processed the payment.
+    # @return [PaymentProcessor]
+    attr_accessor :payment_processor
+
+    # States that a transaction can be in.
+    # <table>
+    #   <thead>
+    #     <tr>
+    #       <th>Status</th>
+    #       <th>Description</th>
+    #     </tr>
+    #   </thead>
+    #   <tbody>
+    #     <tr>
+    #       <td>AUTHORIZED</td>
+    #       <td>A transaction has been fully authorized and the funds are being
+    # held.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>AUTHORIZE_FAILED</td>
+    #       <td>Authorization has failed. No funds are being held.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>AUTHORIZE_INITIATED</td>
+    #       <td>A payment authorization has been initiated with CellPoint
+    # Digital.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>CANCELED</td>
+    #       <td>Authorization has been canceled and no funds are being held
+    # anymore.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>CANCELLATION_FAILED</td>
+    #       <td>Cancellation has failed. Funds are still held as part of the
+    # authorization.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>CANCELLATION_INITIATED</td>
+    #       <td>Cancellation of funds have been initiated and is pending
+    # completion.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>CAPTURED</td>
+    #       <td>
+    #         Authorized transaction that has been fully captured.
+    #         Depending on how settlement is done by payment processor, funds
+    # have been moved from buyer's account to merchant's account.
+    #       </td>
+    #     </tr>
+    #     <tr>
+    #       <td>CAPTURE_FAILED</td>
+    #       <td>Capture has failed. Funds are still held as part of the
+    # authorization, but have not moved.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>CAPTURE_INITIATED</td>
+    #       <td>Capture has been initiated, but is pending completion.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>CAPTURE_PENDING</td>
+    #       <td>Authorization has already happened, and the transaction has now
+    # been marked as pending for capture. Capture will take place automatically
+    # as per configured schedule.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>CAPTURE_BATCHED</td>
+    #       <td>Authorization has already happened, and the transaction has been
+    # sent for capturing in a batch. Capture will finally take place
+    # automatically as per configured schedule.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>PARTIALLY_CANCELED</td>
+    #       <td>Authorized transaction is partially canceled<td>
+    #     </tr>
+    #     <tr>
+    #       <td>PARTIALLY_CAPTURED</td>
+    #       <td>Authorized transaction is partially captured<td>
+    #     </tr>
+    #     <tr>
+    #       <td>PENDING_ACTION_COMPLETION</td>
+    #       <td>The transaction is in a state where an action has been
+    # initiated, but is pending completion.</td>
+    #     </tr>
+    #     <tr>
+    #       <td>CLOSED</td>
+    #       <td>The transaction that has previously failed has been closed to
+    # avoid its stagnation in review pools.</td>
+    #     </tr>
+    #   </tbody>
+    # </table>
+    # @return [PaymentStatus]
+    attr_accessor :status
+
+    # When the transaction was authorized.
+    # @return [DateTime]
+    attr_accessor :authorized_at
+
+    # When the transaction's funds were captured.
+    # If multiple captures have happened, this is the latest capture.
+    # @return [DateTime]
+    attr_accessor :captured_at
+
+    # When the transaction's authorization was canceled.
+    # @return [DateTime]
+    attr_accessor :canceled_at
+
+    # List of refund transaction(s) that have happened for this payment.
+    # @return [Array[RelatedRefund]]
+    attr_accessor :refunds
+
+    # If the transaction had to failover to a different payment processor.
+    # List of failover failures can be found in `failovers` property.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_failed_over
+
+    # If the transaction had to failover to a different payment processor.
+    # List of failover failures can be found in `failovers` property.
+    # @return [Array[Failover]]
+    attr_accessor :failovers
+
+    # If `status` is `AUTHORIZE_INITIATED` this is the amount that will be
+    # attempted to be authorized.
+    # @return [PaymentTransactionPendingAuthorizeAmount]
+    attr_accessor :pending_authorize_amount
+
+    # Amount that was authorized on the transaction.
+    # @return [PaymentTransactionAuthorizedAmount]
+    attr_accessor :authorized_amount
+
+    # If `status` is `CAPTURE_PENDING`, this will be the amount that will be
+    # captured.
+    # @return [PaymentTransactionPendingCaptureAmount]
+    attr_accessor :pending_capture_amount
+
+    # Amount captured from an authorised transaction.
+    # @return [PaymentTransactionCapturedAmount]
+    attr_accessor :captured_amount
+
+    # Amount refunded from a captured transaction.
+    # @return [PaymentTransactionRefundedAmount]
+    attr_accessor :refunded_amount
+
+    # During the cancellation process this will be the amount that will be
+    # canceled.
+    # @return [PaymentTransactionPendingCancelAmount]
+    attr_accessor :pending_cancel_amount
+
+    # Amount canceled from an authorized transaction.
+    # @return [PaymentTransactionCanceledAmount]
+    attr_accessor :canceled_amount
+
+    # If there is a fee for using the payment method (i.e. $5 fee for using
+    # ACH), that should be included here.
+    # @return [PaymentTransactionProcessingFee]
+    attr_accessor :processing_fee
+
+    # The payment instrument that is being used in the transaction.
+    # @return [Object]
+    attr_accessor :payment_instrument
+
+    # Authorization group ID that this transaction belongs to.
+    # @return [String]
+    attr_accessor :authorization_group_id
+
+    # Address Verification Status (AVS)
+    # <table>
+    # <thead>
+    #   <tr>
+    #     <th>AVS Status</th>
+    #     <th>Description</th>
+    #   </tr>
+    # </thead>
+    # <tbody>
+    #   <tr>
+    #     <td>MATCH</td>
+    #     <td>Both address or postal code match</td>
+    #   </tr>
+    #   <tr>
+    #     <td>PARTIAL_MATCH_POSTAL_CODE_ONLY</td>
+    #     <td>postal code matches but address does not</td>
+    #   </tr>
+    #   <tr>
+    #     <td>PARTIAL_MATCH_ADDRESS_ONLY</td>
+    #     <td>address matches but postal code does not</td>
+    #   </tr>
+    #   <tr>
+    #     <td>FAILURE</td>
+    #     <td>neither address or postal code match</td>
+    #   </tr>
+    #   <tr>
+    #     <td>UNAVAILABLE</td>
+    #     <td>AVS is unavailable for card/country</td>
+    #   </tr>
+    # </tbody>
+    # </table>
+    # @return [AddressVerificationStatus]
+    attr_accessor :address_verification_status
+
+    # Security Code Status
+    # <table>
+    # <thead>
+    #   <tr>
+    #     <th>Security Code Status</th>
+    #     <th>Description</th>
+    #   </tr>
+    # </thead>
+    # <tbody>
+    #   <tr>
+    #     <td>MATCH</td>
+    #     <td>Provided Security Code matches expected value.</td>
+    #   </tr>
+    #   <tr>
+    #     <td>NOT_PROVIDED</td>
+    #     <td>Security Code not provided.</td>
+    #   </tr>
+    #   <tr>
+    #     <td>FAILURE</td>
+    #     <td>Security Code does not match expected value.</td>
+    #   </tr>
+    #   <tr>
+    #     <td>UNAVAILABLE</td>
+    #     <td>Security Code check not available.</td>
+    #   </tr>
+    # </tbody>
+    # </table>
+    # @return [SecurityCodeMatchStatus]
+    attr_accessor :security_code_status
+
+    # List of assessments on if the transaction is considered acceptable or not.
+    # @return [Array[FraudAssessment]]
+    attr_accessor :fraud_assessments
+
+    # The action to be taken on the transaction.
+    # @return [Object]
+    attr_accessor :action
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['order_id'] = 'orderId'
+      @_hash['type'] = 'type'
+      @_hash['failure'] = 'failure'
+      @_hash['created_at'] = 'createdAt'
+      @_hash['payment_processor'] = 'paymentProcessor'
+      @_hash['status'] = 'status'
+      @_hash['authorized_at'] = 'authorizedAt'
+      @_hash['captured_at'] = 'capturedAt'
+      @_hash['canceled_at'] = 'canceledAt'
+      @_hash['refunds'] = 'refunds'
+      @_hash['has_failed_over'] = 'hasFailedOver'
+      @_hash['failovers'] = 'failovers'
+      @_hash['pending_authorize_amount'] = 'pendingAuthorizeAmount'
+      @_hash['authorized_amount'] = 'authorizedAmount'
+      @_hash['pending_capture_amount'] = 'pendingCaptureAmount'
+      @_hash['captured_amount'] = 'capturedAmount'
+      @_hash['refunded_amount'] = 'refundedAmount'
+      @_hash['pending_cancel_amount'] = 'pendingCancelAmount'
+      @_hash['canceled_amount'] = 'canceledAmount'
+      @_hash['processing_fee'] = 'processingFee'
+      @_hash['payment_instrument'] = 'paymentInstrument'
+      @_hash['authorization_group_id'] = 'authorizationGroupId'
+      @_hash['address_verification_status'] = 'addressVerificationStatus'
+      @_hash['security_code_status'] = 'securityCodeStatus'
+      @_hash['fraud_assessments'] = 'fraudAssessments'
+      @_hash['action'] = 'action'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        order_id
+        failure
+        created_at
+        payment_processor
+        authorized_at
+        captured_at
+        canceled_at
+        refunds
+        has_failed_over
+        failovers
+        pending_authorize_amount
+        authorized_amount
+        pending_capture_amount
+        captured_amount
+        refunded_amount
+        pending_cancel_amount
+        canceled_amount
+        processing_fee
+        authorization_group_id
+        address_verification_status
+        security_code_status
+        fraud_assessments
+        action
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, type:, status:, payment_instrument:, order_id: SKIP,
+                   failure: SKIP, created_at: SKIP, payment_processor: SKIP,
+                   authorized_at: SKIP, captured_at: SKIP, canceled_at: SKIP,
+                   refunds: SKIP, has_failed_over: SKIP, failovers: SKIP,
+                   pending_authorize_amount: SKIP, authorized_amount: SKIP,
+                   pending_capture_amount: SKIP, captured_amount: SKIP,
+                   refunded_amount: SKIP, pending_cancel_amount: SKIP,
+                   canceled_amount: SKIP, processing_fee: SKIP,
+                   authorization_group_id: SKIP,
+                   address_verification_status: SKIP,
+                   security_code_status: SKIP, fraud_assessments: SKIP,
+                   action: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @order_id = order_id unless order_id == SKIP
+      @type = type
+      @failure = failure unless failure == SKIP
+      @created_at = created_at unless created_at == SKIP
+      @payment_processor = payment_processor unless payment_processor == SKIP
+      @status = status
+      @authorized_at = authorized_at unless authorized_at == SKIP
+      @captured_at = captured_at unless captured_at == SKIP
+      @canceled_at = canceled_at unless canceled_at == SKIP
+      @refunds = refunds unless refunds == SKIP
+      @has_failed_over = has_failed_over unless has_failed_over == SKIP
+      @failovers = failovers unless failovers == SKIP
+      @pending_authorize_amount = pending_authorize_amount unless pending_authorize_amount == SKIP
+      @authorized_amount = authorized_amount unless authorized_amount == SKIP
+      @pending_capture_amount = pending_capture_amount unless pending_capture_amount == SKIP
+      @captured_amount = captured_amount unless captured_amount == SKIP
+      @refunded_amount = refunded_amount unless refunded_amount == SKIP
+      @pending_cancel_amount = pending_cancel_amount unless pending_cancel_amount == SKIP
+      @canceled_amount = canceled_amount unless canceled_amount == SKIP
+      @processing_fee = processing_fee unless processing_fee == SKIP
+      @payment_instrument = payment_instrument
+      @authorization_group_id = authorization_group_id unless authorization_group_id == SKIP
+      unless address_verification_status == SKIP
+        @address_verification_status =
+          address_verification_status
+      end
+      @security_code_status = security_code_status unless security_code_status == SKIP
+      @fraud_assessments = fraud_assessments unless fraud_assessments == SKIP
+      @action = action unless action == 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.
+      id = hash.key?('id') ? hash['id'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+      payment_instrument = hash.key?('paymentInstrument') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PaymentInstrument), hash['paymentInstrument']
+      ) : nil
+      order_id = hash.key?('orderId') ? hash['orderId'] : SKIP
+      failure = TransactionFailure.from_hash(hash['failure']) if hash['failure']
+      created_at = if hash.key?('createdAt')
+                     (DateTimeHelper.from_rfc3339(hash['createdAt']) if hash['createdAt'])
+                   else
+                     SKIP
+                   end
+      payment_processor = PaymentProcessor.from_hash(hash['paymentProcessor']) if
+        hash['paymentProcessor']
+      authorized_at = if hash.key?('authorizedAt')
+                        (DateTimeHelper.from_rfc3339(hash['authorizedAt']) if hash['authorizedAt'])
+                      else
+                        SKIP
+                      end
+      captured_at = if hash.key?('capturedAt')
+                      (DateTimeHelper.from_rfc3339(hash['capturedAt']) if hash['capturedAt'])
+                    else
+                      SKIP
+                    end
+      canceled_at = if hash.key?('canceledAt')
+                      (DateTimeHelper.from_rfc3339(hash['canceledAt']) if hash['canceledAt'])
+                    else
+                      SKIP
+                    end
+      # Parameter is an array, so we need to iterate through it
+      refunds = nil
+      unless hash['refunds'].nil?
+        refunds = []
+        hash['refunds'].each do |structure|
+          refunds << (RelatedRefund.from_hash(structure) if structure)
+        end
+      end
+
+      refunds = SKIP unless hash.key?('refunds')
+      has_failed_over =
+        hash.key?('hasFailedOver') ? hash['hasFailedOver'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      failovers = nil
+      unless hash['failovers'].nil?
+        failovers = []
+        hash['failovers'].each do |structure|
+          failovers << (Failover.from_hash(structure) if structure)
+        end
+      end
+
+      failovers = SKIP unless hash.key?('failovers')
+      if hash['pendingAuthorizeAmount']
+        pending_authorize_amount = PaymentTransactionPendingAuthorizeAmount.from_hash(hash['pendingAuthorizeAmount'])
+      end
+      authorized_amount = PaymentTransactionAuthorizedAmount.from_hash(hash['authorizedAmount']) if
+        hash['authorizedAmount']
+      if hash['pendingCaptureAmount']
+        pending_capture_amount = PaymentTransactionPendingCaptureAmount.from_hash(hash['pendingCaptureAmount'])
+      end
+      captured_amount = PaymentTransactionCapturedAmount.from_hash(hash['capturedAmount']) if
+        hash['capturedAmount']
+      refunded_amount = PaymentTransactionRefundedAmount.from_hash(hash['refundedAmount']) if
+        hash['refundedAmount']
+      if hash['pendingCancelAmount']
+        pending_cancel_amount = PaymentTransactionPendingCancelAmount.from_hash(hash['pendingCancelAmount'])
+      end
+      canceled_amount = PaymentTransactionCanceledAmount.from_hash(hash['canceledAmount']) if
+        hash['canceledAmount']
+      processing_fee = PaymentTransactionProcessingFee.from_hash(hash['processingFee']) if
+        hash['processingFee']
+      authorization_group_id =
+        hash.key?('authorizationGroupId') ? hash['authorizationGroupId'] : SKIP
+      address_verification_status =
+        hash.key?('addressVerificationStatus') ? hash['addressVerificationStatus'] : SKIP
+      security_code_status =
+        hash.key?('securityCodeStatus') ? hash['securityCodeStatus'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      fraud_assessments = nil
+      unless hash['fraudAssessments'].nil?
+        fraud_assessments = []
+        hash['fraudAssessments'].each do |structure|
+          fraud_assessments << (FraudAssessment.from_hash(structure) if structure)
+        end
+      end
+
+      fraud_assessments = SKIP unless hash.key?('fraudAssessments')
+      action = hash.key?('action') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:Action), hash['action']
+      ) : 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.
+      PaymentTransaction.new(id: id,
+                             type: type,
+                             status: status,
+                             payment_instrument: payment_instrument,
+                             order_id: order_id,
+                             failure: failure,
+                             created_at: created_at,
+                             payment_processor: payment_processor,
+                             authorized_at: authorized_at,
+                             captured_at: captured_at,
+                             canceled_at: canceled_at,
+                             refunds: refunds,
+                             has_failed_over: has_failed_over,
+                             failovers: failovers,
+                             pending_authorize_amount: pending_authorize_amount,
+                             authorized_amount: authorized_amount,
+                             pending_capture_amount: pending_capture_amount,
+                             captured_amount: captured_amount,
+                             refunded_amount: refunded_amount,
+                             pending_cancel_amount: pending_cancel_amount,
+                             canceled_amount: canceled_amount,
+                             processing_fee: processing_fee,
+                             authorization_group_id: authorization_group_id,
+                             address_verification_status: address_verification_status,
+                             security_code_status: security_code_status,
+                             fraud_assessments: fraud_assessments,
+                             action: action,
+                             additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_authorized_at
+      DateTimeHelper.to_rfc3339(authorized_at)
+    end
+
+    def to_custom_captured_at
+      DateTimeHelper.to_rfc3339(captured_at)
+    end
+
+    def to_custom_canceled_at
+      DateTimeHelper.to_rfc3339(canceled_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentTransaction | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.id,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.type,
+                                  ->(val) { Type2.validate(val) }) and
+            APIHelper.valid_type?(value.status,
+                                  ->(val) { PaymentStatus.validate(val) }) and
+            UnionTypeLookUp.get(:PaymentInstrument)
+                           .validate(value.payment_instrument)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['type'],
+                                ->(val) { Type2.validate(val) }) and
+          APIHelper.valid_type?(value['status'],
+                                ->(val) { PaymentStatus.validate(val) }) and
+          UnionTypeLookUp.get(:PaymentInstrument)
+                         .validate(value['paymentInstrument'])
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, order_id: #{@order_id}, type: #{@type}, failure: #{@failure},"\
+      " created_at: #{@created_at}, payment_processor: #{@payment_processor}, status: #{@status},"\
+      " authorized_at: #{@authorized_at}, captured_at: #{@captured_at}, canceled_at:"\
+      " #{@canceled_at}, refunds: #{@refunds}, has_failed_over: #{@has_failed_over}, failovers:"\
+      " #{@failovers}, pending_authorize_amount: #{@pending_authorize_amount}, authorized_amount:"\
+      " #{@authorized_amount}, pending_capture_amount: #{@pending_capture_amount},"\
+      " captured_amount: #{@captured_amount}, refunded_amount: #{@refunded_amount},"\
+      " pending_cancel_amount: #{@pending_cancel_amount}, canceled_amount: #{@canceled_amount},"\
+      " processing_fee: #{@processing_fee}, payment_instrument: #{@payment_instrument},"\
+      " authorization_group_id: #{@authorization_group_id}, address_verification_status:"\
+      " #{@address_verification_status}, security_code_status: #{@security_code_status},"\
+      " fraud_assessments: #{@fraud_assessments}, action: #{@action}, 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} id: #{@id.inspect}, order_id: #{@order_id.inspect}, type: #{@type.inspect},"\
+      " failure: #{@failure.inspect}, created_at: #{@created_at.inspect}, payment_processor:"\
+      " #{@payment_processor.inspect}, status: #{@status.inspect}, authorized_at:"\
+      " #{@authorized_at.inspect}, captured_at: #{@captured_at.inspect}, canceled_at:"\
+      " #{@canceled_at.inspect}, refunds: #{@refunds.inspect}, has_failed_over:"\
+      " #{@has_failed_over.inspect}, failovers: #{@failovers.inspect}, pending_authorize_amount:"\
+      " #{@pending_authorize_amount.inspect}, authorized_amount: #{@authorized_amount.inspect},"\
+      " pending_capture_amount: #{@pending_capture_amount.inspect}, captured_amount:"\
+      " #{@captured_amount.inspect}, refunded_amount: #{@refunded_amount.inspect},"\
+      " pending_cancel_amount: #{@pending_cancel_amount.inspect}, canceled_amount:"\
+      " #{@canceled_amount.inspect}, processing_fee: #{@processing_fee.inspect},"\
+      " payment_instrument: #{@payment_instrument.inspect}, authorization_group_id:"\
+      " #{@authorization_group_id.inspect}, address_verification_status:"\
+      " #{@address_verification_status.inspect}, security_code_status:"\
+      " #{@security_code_status.inspect}, fraud_assessments: #{@fraud_assessments.inspect},"\
+      " action: #{@action.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end