apimatic-cp-sdk 0.0.1

data/lib/cell_point_api/models/refund_transaction.rb

@@ -0,0 +1,311 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module CellPointApi
+  # A Refund Transaction is a transaction that is used to refund funds to a
+  # customer.
+  class RefundTransaction < 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
+
+    # Optional merchant-defined reason for the refund.
+    # @return [RefundReason]
+    attr_accessor :reason
+
+    # Status of the refund.
+    # @return [RefundStatus]
+    attr_accessor :status
+
+    # When the refund was last processed.
+    # A refund can be processed multiple times if it fails initially.
+    # Note: this is different from `refundedAt` which is when the refund was
+    # successfully completed,
+    # whereas `processedAt` is when refund processing started.
+    # @return [DateTime]
+    attr_accessor :processed_at
+
+    # When the refund was successfully completed.
+    # @return [DateTime]
+    attr_accessor :refunded_at
+
+    # Type of refund to do, either partial or full. The actual refund however
+    # can be for any amount regardless of this type.
+    # The reason being that there may be fees so the refund can be full even
+    # though some amount is kept.
+    # @return [RefundType]
+    attr_accessor :refund_type
+
+    # Method of refunding the payment.
+    # @return [RefundMethod]
+    attr_accessor :refund_method
+
+    # Amount that was attempted.
+    # @return [RefundTransactionAmount]
+    attr_accessor :amount
+
+    # Payment transaction(s) that are being refunded.
+    # This will often only be a single transaction,
+    # but there are situations depending on merchant configuration
+    # where a single refund will be against multiple payments.
+    # @return [Array[RelatedPayment]]
+    attr_accessor :original_payment_transactions
+
+    # The payment instrument that is being used in the transaction.
+    # @return [Object]
+    attr_accessor :refunding_payment_instrument
+
+    # 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['reason'] = 'reason'
+      @_hash['status'] = 'status'
+      @_hash['processed_at'] = 'processedAt'
+      @_hash['refunded_at'] = 'refundedAt'
+      @_hash['refund_type'] = 'refundType'
+      @_hash['refund_method'] = 'refundMethod'
+      @_hash['amount'] = 'amount'
+      @_hash['original_payment_transactions'] = 'originalPaymentTransactions'
+      @_hash['refunding_payment_instrument'] = 'refundingPaymentInstrument'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        order_id
+        failure
+        created_at
+        payment_processor
+        reason
+        processed_at
+        refunded_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, type:, status:, refund_type:, refund_method:, amount:,
+                   original_payment_transactions:,
+                   refunding_payment_instrument:, order_id: SKIP, failure: SKIP,
+                   created_at: SKIP, payment_processor: SKIP, reason: SKIP,
+                   processed_at: SKIP, refunded_at: 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
+      @reason = reason unless reason == SKIP
+      @status = status
+      @processed_at = processed_at unless processed_at == SKIP
+      @refunded_at = refunded_at unless refunded_at == SKIP
+      @refund_type = refund_type
+      @refund_method = refund_method
+      @amount = amount
+      @original_payment_transactions = original_payment_transactions
+      @refunding_payment_instrument = refunding_payment_instrument
+      @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
+      refund_type = hash.key?('refundType') ? hash['refundType'] : nil
+      refund_method = hash.key?('refundMethod') ? hash['refundMethod'] : nil
+      amount = RefundTransactionAmount.from_hash(hash['amount']) if hash['amount']
+      # Parameter is an array, so we need to iterate through it
+      original_payment_transactions = nil
+      unless hash['originalPaymentTransactions'].nil?
+        original_payment_transactions = []
+        hash['originalPaymentTransactions'].each do |structure|
+          original_payment_transactions << (RelatedPayment.from_hash(structure) if structure)
+        end
+      end
+
+      original_payment_transactions = nil unless hash.key?('originalPaymentTransactions')
+      refunding_payment_instrument = hash.key?('refundingPaymentInstrument') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PaymentInstrument), hash['refundingPaymentInstrument']
+      ) : 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']
+      reason = RefundReason.from_hash(hash['reason']) if hash['reason']
+      processed_at = if hash.key?('processedAt')
+                       (DateTimeHelper.from_rfc3339(hash['processedAt']) if hash['processedAt'])
+                     else
+                       SKIP
+                     end
+      refunded_at = if hash.key?('refundedAt')
+                      (DateTimeHelper.from_rfc3339(hash['refundedAt']) if hash['refundedAt'])
+                    else
+                      SKIP
+                    end
+
+      # 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.
+      RefundTransaction.new(id: id,
+                            type: type,
+                            status: status,
+                            refund_type: refund_type,
+                            refund_method: refund_method,
+                            amount: amount,
+                            original_payment_transactions: original_payment_transactions,
+                            refunding_payment_instrument: refunding_payment_instrument,
+                            order_id: order_id,
+                            failure: failure,
+                            created_at: created_at,
+                            payment_processor: payment_processor,
+                            reason: reason,
+                            processed_at: processed_at,
+                            refunded_at: refunded_at,
+                            additional_properties: additional_properties)
+    end
+
+    def to_custom_created_at
+      DateTimeHelper.to_rfc3339(created_at)
+    end
+
+    def to_custom_processed_at
+      DateTimeHelper.to_rfc3339(processed_at)
+    end
+
+    def to_custom_refunded_at
+      DateTimeHelper.to_rfc3339(refunded_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RefundTransaction | 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) { RefundStatus.validate(val) }) and
+            APIHelper.valid_type?(value.refund_type,
+                                  ->(val) { RefundType.validate(val) }) and
+            APIHelper.valid_type?(value.refund_method,
+                                  ->(val) { RefundMethod.validate(val) }) and
+            APIHelper.valid_type?(value.amount,
+                                  ->(val) { RefundTransactionAmount.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.original_payment_transactions,
+                                  ->(val) { RelatedPayment.validate(val) },
+                                  is_model_hash: true,
+                                  is_inner_model_hash: true) and
+            UnionTypeLookUp.get(:PaymentInstrument)
+                           .validate(value.refunding_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) { RefundStatus.validate(val) }) and
+          APIHelper.valid_type?(value['refundType'],
+                                ->(val) { RefundType.validate(val) }) and
+          APIHelper.valid_type?(value['refundMethod'],
+                                ->(val) { RefundMethod.validate(val) }) and
+          APIHelper.valid_type?(value['amount'],
+                                ->(val) { RefundTransactionAmount.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['originalPaymentTransactions'],
+                                ->(val) { RelatedPayment.validate(val) },
+                                is_model_hash: true,
+                                is_inner_model_hash: true) and
+          UnionTypeLookUp.get(:PaymentInstrument)
+                         .validate(value['refundingPaymentInstrument'])
+      )
+    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}, reason: #{@reason},"\
+      " status: #{@status}, processed_at: #{@processed_at}, refunded_at: #{@refunded_at},"\
+      " refund_type: #{@refund_type}, refund_method: #{@refund_method}, amount: #{@amount},"\
+      " original_payment_transactions: #{@original_payment_transactions},"\
+      " refunding_payment_instrument: #{@refunding_payment_instrument}, 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}, reason: #{@reason.inspect}, status: #{@status.inspect},"\
+      " processed_at: #{@processed_at.inspect}, refunded_at: #{@refunded_at.inspect}, refund_type:"\
+      " #{@refund_type.inspect}, refund_method: #{@refund_method.inspect}, amount:"\
+      " #{@amount.inspect}, original_payment_transactions:"\
+      " #{@original_payment_transactions.inspect}, refunding_payment_instrument:"\
+      " #{@refunding_payment_instrument.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/refund_transaction_amount.rb

@@ -0,0 +1,105 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Amount that was attempted.
+  class RefundTransactionAmount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO 4217 currency code. Must be UPPERCASE.
+    # @return [String]
+    attr_accessor :currency
+
+    # Cost in the lowest denominator of the currency. 
+    # E.g. 101 for £1.01
+    # @return [Integer]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency:, value:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @currency = currency
+      @value = value
+      @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.
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      value = hash.key?('value') ? hash['value'] : 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.
+      RefundTransactionAmount.new(currency: currency,
+                                  value: value,
+                                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RefundTransactionAmount | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.currency,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.value,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['currency'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['value'],
+                                ->(val) { val.instance_of? Integer })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency}, value: #{@value}, 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} currency: #{@currency.inspect}, value: #{@value.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/refund_type.rb

@@ -0,0 +1,38 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Type of refund to do, either partial or full. The actual refund however can
+  # be for any amount regardless of this type. The reason being that there may
+  # be fees so the refund can be full even though some amount is kept.
+  class RefundType
+    REFUND_TYPE = [
+      # TODO: Write general description for FULL
+      FULL = 'FULL'.freeze,
+
+      # TODO: Write general description for PARTIAL
+      PARTIAL = 'PARTIAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REFUND_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = FULL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'full' then FULL
+      when 'partial' then PARTIAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/cell_point_api/models/related_payment.rb

@@ -0,0 +1,106 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Contains the payment transaction that is being refunded.
+  class RelatedPayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for this transaction.
+    # @return [String]
+    attr_accessor :id
+
+    # Amount refunded from a captured transaction.
+    # @return [PaymentTransactionRefundedAmount]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, amount:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @amount = amount
+      @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
+      amount = PaymentTransactionRefundedAmount.from_hash(hash['amount']) if hash['amount']
+
+      # 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.
+      RelatedPayment.new(id: id,
+                         amount: amount,
+                         additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RelatedPayment | 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.amount,
+                                  ->(val) { PaymentTransactionRefundedAmount.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount'],
+                                ->(val) { PaymentTransactionRefundedAmount.validate(val) },
+                                is_model_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}, amount: #{@amount}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, amount: #{@amount.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/cell_point_api/models/related_refund.rb

@@ -0,0 +1,106 @@
+# cell_point_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module CellPointApi
+  # Contains the refund transaction that is being refunded.
+  class RelatedRefund < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for this transaction.
+    # @return [String]
+    attr_accessor :id
+
+    # Amount that was attempted.
+    # @return [RefundTransactionAmount]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id:, amount:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id
+      @amount = amount
+      @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
+      amount = RefundTransactionAmount.from_hash(hash['amount']) if hash['amount']
+
+      # 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.
+      RelatedRefund.new(id: id,
+                        amount: amount,
+                        additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RelatedRefund | 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.amount,
+                                  ->(val) { RefundTransactionAmount.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['id'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount'],
+                                ->(val) { RefundTransactionAmount.validate(val) },
+                                is_model_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}, amount: #{@amount}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, amount: #{@amount.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end