ps-apimatic-sdk 0.0.1

data/lib/paysecure_api_documentation_live/models/purchase_success3.rb

@@ -0,0 +1,471 @@
+# paysecure_api_documentation_live
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PaysecureApiDocumentationLive
+  # PurchaseSuccess3 Model.
+  class PurchaseSuccess3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :purchase_id
+
+    # TODO: Write general description for this method
+    # @return [Client35]
+    attr_accessor :client
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :updated_on
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :payment_method
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :amount_unit
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_msg
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :redirect_type
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :force_recurring
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :created_on
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :merchant_ref
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :instruction
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :merchant_name
+
+    # TODO: Write general description for this method
+    # @return [Purchase21]
+    attr_accessor :purchase
+
+    # TODO: Write general description for this method
+    # @return [Payment3]
+    attr_accessor :payment
+
+    # TODO: Write general description for this method
+    # @return [IssuerDetails]
+    attr_accessor :issuer_details
+
+    # TODO: Write general description for this method
+    # @return [TransactionData6]
+    attr_accessor :transaction_data
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :status
+
+    # TODO: Write general description for this method
+    # @return [Array[StatusHistory]]
+    attr_accessor :status_history
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_test
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :brand_id
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :send_receipt
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_recurring_token
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :skip_capture
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reference_generated
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :issued
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :due
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :refund_upto
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :cc_descriptor
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :fraud_score
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :trust_score
+
+    # TODO: Write general description for this method
+    # @return [PayInDetails4]
+    attr_accessor :pay_in_details
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :refund_availability
+
+    # TODO: Write general description for this method
+    # @return [Float]
+    attr_accessor :refundable_amount
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :success_redirect
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :failure_redirect
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :cancel_redirect
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :success_callback
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :failure_callback
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :platform
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :created_from_ip
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :checkout_url
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['purchase_id'] = 'purchaseId'
+      @_hash['client'] = 'client'
+      @_hash['updated_on'] = 'updated_on'
+      @_hash['type'] = 'type'
+      @_hash['payment_method'] = 'paymentMethod'
+      @_hash['amount_unit'] = 'amountUnit'
+      @_hash['error_msg'] = 'errorMsg'
+      @_hash['redirect_type'] = 'redirectType'
+      @_hash['force_recurring'] = 'force_recurring'
+      @_hash['created_on'] = 'created_on'
+      @_hash['merchant_ref'] = 'merchantRef'
+      @_hash['instruction'] = 'instruction'
+      @_hash['merchant_name'] = 'merchantName'
+      @_hash['purchase'] = 'purchase'
+      @_hash['payment'] = 'payment'
+      @_hash['issuer_details'] = 'issuer_details'
+      @_hash['transaction_data'] = 'transaction_data'
+      @_hash['status'] = 'status'
+      @_hash['status_history'] = 'status_history'
+      @_hash['is_test'] = 'is_test'
+      @_hash['brand_id'] = 'brand_id'
+      @_hash['send_receipt'] = 'send_receipt'
+      @_hash['is_recurring_token'] = 'is_recurring_token'
+      @_hash['skip_capture'] = 'skip_capture'
+      @_hash['reference_generated'] = 'reference_generated'
+      @_hash['issued'] = 'issued'
+      @_hash['due'] = 'due'
+      @_hash['refund_upto'] = 'refund_upto'
+      @_hash['cc_descriptor'] = 'cc_descriptor'
+      @_hash['fraud_score'] = 'fraudScore'
+      @_hash['trust_score'] = 'trustScore'
+      @_hash['pay_in_details'] = 'payInDetails'
+      @_hash['refund_availability'] = 'refund_availability'
+      @_hash['refundable_amount'] = 'refundable_amount'
+      @_hash['success_redirect'] = 'success_redirect'
+      @_hash['failure_redirect'] = 'failure_redirect'
+      @_hash['cancel_redirect'] = 'cancel_redirect'
+      @_hash['success_callback'] = 'success_callback'
+      @_hash['failure_callback'] = 'failure_callback'
+      @_hash['platform'] = 'platform'
+      @_hash['created_from_ip'] = 'created_from_ip'
+      @_hash['checkout_url'] = 'checkout_url'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(purchase_id:, client:, updated_on:, type:, payment_method:,
+                   amount_unit:, error_msg:, redirect_type:, force_recurring:,
+                   created_on:, merchant_ref:, instruction:, merchant_name:,
+                   purchase:, payment:, issuer_details:, transaction_data:,
+                   status:, status_history:, is_test:, brand_id:, send_receipt:,
+                   is_recurring_token:, skip_capture:, reference_generated:,
+                   issued:, due:, refund_upto:, cc_descriptor:, fraud_score:,
+                   trust_score:, pay_in_details:, refund_availability:,
+                   refundable_amount:, success_redirect:, failure_redirect:,
+                   cancel_redirect:, success_callback:, failure_callback:,
+                   platform:, created_from_ip:, checkout_url:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @purchase_id = purchase_id
+      @client = client
+      @updated_on = updated_on
+      @type = type
+      @payment_method = payment_method
+      @amount_unit = amount_unit
+      @error_msg = error_msg
+      @redirect_type = redirect_type
+      @force_recurring = force_recurring
+      @created_on = created_on
+      @merchant_ref = merchant_ref
+      @instruction = instruction
+      @merchant_name = merchant_name
+      @purchase = purchase
+      @payment = payment
+      @issuer_details = issuer_details
+      @transaction_data = transaction_data
+      @status = status
+      @status_history = status_history
+      @is_test = is_test
+      @brand_id = brand_id
+      @send_receipt = send_receipt
+      @is_recurring_token = is_recurring_token
+      @skip_capture = skip_capture
+      @reference_generated = reference_generated
+      @issued = issued
+      @due = due
+      @refund_upto = refund_upto
+      @cc_descriptor = cc_descriptor
+      @fraud_score = fraud_score
+      @trust_score = trust_score
+      @pay_in_details = pay_in_details
+      @refund_availability = refund_availability
+      @refundable_amount = refundable_amount
+      @success_redirect = success_redirect
+      @failure_redirect = failure_redirect
+      @cancel_redirect = cancel_redirect
+      @success_callback = success_callback
+      @failure_callback = failure_callback
+      @platform = platform
+      @created_from_ip = created_from_ip
+      @checkout_url = checkout_url
+      @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.
+      purchase_id = hash.key?('purchaseId') ? hash['purchaseId'] : nil
+      client = Client35.from_hash(hash['client']) if hash['client']
+      updated_on = hash.key?('updated_on') ? hash['updated_on'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      payment_method = hash.key?('paymentMethod') ? hash['paymentMethod'] : nil
+      amount_unit = hash.key?('amountUnit') ? hash['amountUnit'] : nil
+      error_msg = hash.key?('errorMsg') ? hash['errorMsg'] : nil
+      redirect_type = hash.key?('redirectType') ? hash['redirectType'] : nil
+      force_recurring =
+        hash.key?('force_recurring') ? hash['force_recurring'] : nil
+      created_on = hash.key?('created_on') ? hash['created_on'] : nil
+      merchant_ref = hash.key?('merchantRef') ? hash['merchantRef'] : nil
+      instruction = hash.key?('instruction') ? hash['instruction'] : nil
+      merchant_name = hash.key?('merchantName') ? hash['merchantName'] : nil
+      purchase = Purchase21.from_hash(hash['purchase']) if hash['purchase']
+      payment = Payment3.from_hash(hash['payment']) if hash['payment']
+      issuer_details = IssuerDetails.from_hash(hash['issuer_details']) if hash['issuer_details']
+      transaction_data = TransactionData6.from_hash(hash['transaction_data']) if
+        hash['transaction_data']
+      status = hash.key?('status') ? hash['status'] : nil
+      # Parameter is an array, so we need to iterate through it
+      status_history = nil
+      unless hash['status_history'].nil?
+        status_history = []
+        hash['status_history'].each do |structure|
+          status_history << (StatusHistory.from_hash(structure) if structure)
+        end
+      end
+
+      status_history = nil unless hash.key?('status_history')
+      is_test = hash.key?('is_test') ? hash['is_test'] : nil
+      brand_id = hash.key?('brand_id') ? hash['brand_id'] : nil
+      send_receipt = hash.key?('send_receipt') ? hash['send_receipt'] : nil
+      is_recurring_token =
+        hash.key?('is_recurring_token') ? hash['is_recurring_token'] : nil
+      skip_capture = hash.key?('skip_capture') ? hash['skip_capture'] : nil
+      reference_generated =
+        hash.key?('reference_generated') ? hash['reference_generated'] : nil
+      issued = hash.key?('issued') ? hash['issued'] : nil
+      due = hash.key?('due') ? hash['due'] : nil
+      refund_upto = hash.key?('refund_upto') ? hash['refund_upto'] : nil
+      cc_descriptor = hash.key?('cc_descriptor') ? hash['cc_descriptor'] : nil
+      fraud_score = hash.key?('fraudScore') ? hash['fraudScore'] : nil
+      trust_score = hash.key?('trustScore') ? hash['trustScore'] : nil
+      pay_in_details = PayInDetails4.from_hash(hash['payInDetails']) if hash['payInDetails']
+      refund_availability =
+        hash.key?('refund_availability') ? hash['refund_availability'] : nil
+      refundable_amount =
+        hash.key?('refundable_amount') ? hash['refundable_amount'] : nil
+      success_redirect =
+        hash.key?('success_redirect') ? hash['success_redirect'] : nil
+      failure_redirect =
+        hash.key?('failure_redirect') ? hash['failure_redirect'] : nil
+      cancel_redirect =
+        hash.key?('cancel_redirect') ? hash['cancel_redirect'] : nil
+      success_callback =
+        hash.key?('success_callback') ? hash['success_callback'] : nil
+      failure_callback =
+        hash.key?('failure_callback') ? hash['failure_callback'] : nil
+      platform = hash.key?('platform') ? hash['platform'] : nil
+      created_from_ip =
+        hash.key?('created_from_ip') ? hash['created_from_ip'] : nil
+      checkout_url = hash.key?('checkout_url') ? hash['checkout_url'] : nil
+
+      # 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.
+      PurchaseSuccess3.new(purchase_id: purchase_id,
+                           client: client,
+                           updated_on: updated_on,
+                           type: type,
+                           payment_method: payment_method,
+                           amount_unit: amount_unit,
+                           error_msg: error_msg,
+                           redirect_type: redirect_type,
+                           force_recurring: force_recurring,
+                           created_on: created_on,
+                           merchant_ref: merchant_ref,
+                           instruction: instruction,
+                           merchant_name: merchant_name,
+                           purchase: purchase,
+                           payment: payment,
+                           issuer_details: issuer_details,
+                           transaction_data: transaction_data,
+                           status: status,
+                           status_history: status_history,
+                           is_test: is_test,
+                           brand_id: brand_id,
+                           send_receipt: send_receipt,
+                           is_recurring_token: is_recurring_token,
+                           skip_capture: skip_capture,
+                           reference_generated: reference_generated,
+                           issued: issued,
+                           due: due,
+                           refund_upto: refund_upto,
+                           cc_descriptor: cc_descriptor,
+                           fraud_score: fraud_score,
+                           trust_score: trust_score,
+                           pay_in_details: pay_in_details,
+                           refund_availability: refund_availability,
+                           refundable_amount: refundable_amount,
+                           success_redirect: success_redirect,
+                           failure_redirect: failure_redirect,
+                           cancel_redirect: cancel_redirect,
+                           success_callback: success_callback,
+                           failure_callback: failure_callback,
+                           platform: platform,
+                           created_from_ip: created_from_ip,
+                           checkout_url: checkout_url,
+                           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} purchase_id: #{@purchase_id}, client: #{@client}, updated_on:"\
+      " #{@updated_on}, type: #{@type}, payment_method: #{@payment_method}, amount_unit:"\
+      " #{@amount_unit}, error_msg: #{@error_msg}, redirect_type: #{@redirect_type},"\
+      " force_recurring: #{@force_recurring}, created_on: #{@created_on}, merchant_ref:"\
+      " #{@merchant_ref}, instruction: #{@instruction}, merchant_name: #{@merchant_name},"\
+      " purchase: #{@purchase}, payment: #{@payment}, issuer_details: #{@issuer_details},"\
+      " transaction_data: #{@transaction_data}, status: #{@status}, status_history:"\
+      " #{@status_history}, is_test: #{@is_test}, brand_id: #{@brand_id}, send_receipt:"\
+      " #{@send_receipt}, is_recurring_token: #{@is_recurring_token}, skip_capture:"\
+      " #{@skip_capture}, reference_generated: #{@reference_generated}, issued: #{@issued}, due:"\
+      " #{@due}, refund_upto: #{@refund_upto}, cc_descriptor: #{@cc_descriptor}, fraud_score:"\
+      " #{@fraud_score}, trust_score: #{@trust_score}, pay_in_details: #{@pay_in_details},"\
+      " refund_availability: #{@refund_availability}, refundable_amount: #{@refundable_amount},"\
+      " success_redirect: #{@success_redirect}, failure_redirect: #{@failure_redirect},"\
+      " cancel_redirect: #{@cancel_redirect}, success_callback: #{@success_callback},"\
+      " failure_callback: #{@failure_callback}, platform: #{@platform}, created_from_ip:"\
+      " #{@created_from_ip}, checkout_url: #{@checkout_url}, 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} purchase_id: #{@purchase_id.inspect}, client: #{@client.inspect},"\
+      " updated_on: #{@updated_on.inspect}, type: #{@type.inspect}, payment_method:"\
+      " #{@payment_method.inspect}, amount_unit: #{@amount_unit.inspect}, error_msg:"\
+      " #{@error_msg.inspect}, redirect_type: #{@redirect_type.inspect}, force_recurring:"\
+      " #{@force_recurring.inspect}, created_on: #{@created_on.inspect}, merchant_ref:"\
+      " #{@merchant_ref.inspect}, instruction: #{@instruction.inspect}, merchant_name:"\
+      " #{@merchant_name.inspect}, purchase: #{@purchase.inspect}, payment: #{@payment.inspect},"\
+      " issuer_details: #{@issuer_details.inspect}, transaction_data:"\
+      " #{@transaction_data.inspect}, status: #{@status.inspect}, status_history:"\
+      " #{@status_history.inspect}, is_test: #{@is_test.inspect}, brand_id: #{@brand_id.inspect},"\
+      " send_receipt: #{@send_receipt.inspect}, is_recurring_token:"\
+      " #{@is_recurring_token.inspect}, skip_capture: #{@skip_capture.inspect},"\
+      " reference_generated: #{@reference_generated.inspect}, issued: #{@issued.inspect}, due:"\
+      " #{@due.inspect}, refund_upto: #{@refund_upto.inspect}, cc_descriptor:"\
+      " #{@cc_descriptor.inspect}, fraud_score: #{@fraud_score.inspect}, trust_score:"\
+      " #{@trust_score.inspect}, pay_in_details: #{@pay_in_details.inspect}, refund_availability:"\
+      " #{@refund_availability.inspect}, refundable_amount: #{@refundable_amount.inspect},"\
+      " success_redirect: #{@success_redirect.inspect}, failure_redirect:"\
+      " #{@failure_redirect.inspect}, cancel_redirect: #{@cancel_redirect.inspect},"\
+      " success_callback: #{@success_callback.inspect}, failure_callback:"\
+      " #{@failure_callback.inspect}, platform: #{@platform.inspect}, created_from_ip:"\
+      " #{@created_from_ip.inspect}, checkout_url: #{@checkout_url.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end