apimatic-polpay-sdk 0.0.1

data/lib/poli_ap_is/models/link_payment.rb

@@ -0,0 +1,137 @@
+# poli_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module PoliApIs
+  # LinkPayment Model.
+  class LinkPayment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The POLi ID associated with the transaction
+    # @return [String]
+    attr_accessor :transaction_ref_no
+
+    # The actual amount paid for the transaction
+    # @return [Float]
+    attr_accessor :amount_paid
+
+    # Status of the transaction
+    # @return [String]
+    attr_accessor :transaction_status_code
+
+    # The date and time the transaction was initiated
+    # @return [DateTime]
+    attr_accessor :established_date_time
+
+    # The date and time the transaction was completed
+    # @return [DateTime]
+    attr_accessor :end_date_time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_ref_no'] = 'TransactionRefNo'
+      @_hash['amount_paid'] = 'AmountPaid'
+      @_hash['transaction_status_code'] = 'TransactionStatusCode'
+      @_hash['established_date_time'] = 'EstablishedDateTime'
+      @_hash['end_date_time'] = 'EndDateTime'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_ref_no
+        amount_paid
+        transaction_status_code
+        established_date_time
+        end_date_time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_ref_no: SKIP, amount_paid: SKIP,
+                   transaction_status_code: SKIP, established_date_time: SKIP,
+                   end_date_time: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transaction_ref_no = transaction_ref_no unless transaction_ref_no == SKIP
+      @amount_paid = amount_paid unless amount_paid == SKIP
+      @transaction_status_code = transaction_status_code unless transaction_status_code == SKIP
+      @established_date_time = established_date_time unless established_date_time == SKIP
+      @end_date_time = end_date_time unless end_date_time == 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.
+      transaction_ref_no =
+        hash.key?('TransactionRefNo') ? hash['TransactionRefNo'] : SKIP
+      amount_paid = hash.key?('AmountPaid') ? hash['AmountPaid'] : SKIP
+      transaction_status_code =
+        hash.key?('TransactionStatusCode') ? hash['TransactionStatusCode'] : SKIP
+      established_date_time = if hash.key?('EstablishedDateTime')
+                                (DateTimeHelper.from_rfc3339(hash['EstablishedDateTime']) if hash['EstablishedDateTime'])
+                              else
+                                SKIP
+                              end
+      end_date_time = if hash.key?('EndDateTime')
+                        (DateTimeHelper.from_rfc3339(hash['EndDateTime']) if hash['EndDateTime'])
+                      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.
+      LinkPayment.new(transaction_ref_no: transaction_ref_no,
+                      amount_paid: amount_paid,
+                      transaction_status_code: transaction_status_code,
+                      established_date_time: established_date_time,
+                      end_date_time: end_date_time,
+                      additional_properties: additional_properties)
+    end
+
+    def to_custom_established_date_time
+      DateTimeHelper.to_rfc3339(established_date_time)
+    end
+
+    def to_custom_end_date_time
+      DateTimeHelper.to_rfc3339(end_date_time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} transaction_ref_no: #{@transaction_ref_no}, amount_paid: #{@amount_paid},"\
+      " transaction_status_code: #{@transaction_status_code}, established_date_time:"\
+      " #{@established_date_time}, end_date_time: #{@end_date_time}, 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} transaction_ref_no: #{@transaction_ref_no.inspect}, amount_paid:"\
+      " #{@amount_paid.inspect}, transaction_status_code: #{@transaction_status_code.inspect},"\
+      " established_date_time: #{@established_date_time.inspect}, end_date_time:"\
+      " #{@end_date_time.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/poli_ap_is/models/merchant_details.rb

@@ -0,0 +1,100 @@
+# poli_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module PoliApIs
+  # MerchantDetails Model.
+  class MerchantDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The merchant reference passed in the InitiateTransaction request
+    # @return [String]
+    attr_accessor :merchant_reference
+
+    # The merchant’s bank account name
+    # @return [String]
+    attr_accessor :merchant_account_name
+
+    # The merchant’s account number
+    # @return [String]
+    attr_accessor :merchant_account_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_reference'] = 'MerchantReference'
+      @_hash['merchant_account_name'] = 'MerchantAccountName'
+      @_hash['merchant_account_number'] = 'MerchantAccountNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_reference
+        merchant_account_name
+        merchant_account_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_reference: SKIP, merchant_account_name: SKIP,
+                   merchant_account_number: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @merchant_reference = merchant_reference unless merchant_reference == SKIP
+      @merchant_account_name = merchant_account_name unless merchant_account_name == SKIP
+      @merchant_account_number = merchant_account_number unless merchant_account_number == 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.
+      merchant_reference =
+        hash.key?('MerchantReference') ? hash['MerchantReference'] : SKIP
+      merchant_account_name =
+        hash.key?('MerchantAccountName') ? hash['MerchantAccountName'] : SKIP
+      merchant_account_number =
+        hash.key?('MerchantAccountNumber') ? hash['MerchantAccountNumber'] : 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.
+      MerchantDetails.new(merchant_reference: merchant_reference,
+                          merchant_account_name: merchant_account_name,
+                          merchant_account_number: merchant_account_number,
+                          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} merchant_reference: #{@merchant_reference}, merchant_account_name:"\
+      " #{@merchant_account_name}, merchant_account_number: #{@merchant_account_number},"\
+      " 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} merchant_reference: #{@merchant_reference.inspect}, merchant_account_name:"\
+      " #{@merchant_account_name.inspect}, merchant_account_number:"\
+      " #{@merchant_account_number.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/poli_ap_is/models/payer_details.rb

@@ -0,0 +1,100 @@
+# poli_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module PoliApIs
+  # PayerDetails Model.
+  class PayerDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The first name of the user who paid
+    # @return [String]
+    attr_accessor :payer_first_name
+
+    # The last name of the user who paid
+    # @return [String]
+    attr_accessor :payer_family_name
+
+    # The account number of the user who paid
+    # @return [String]
+    attr_accessor :payer_account_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payer_first_name'] = 'PayerFirstName'
+      @_hash['payer_family_name'] = 'PayerFamilyName'
+      @_hash['payer_account_number'] = 'PayerAccountNumber'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payer_first_name
+        payer_family_name
+        payer_account_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payer_first_name: SKIP, payer_family_name: SKIP,
+                   payer_account_number: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @payer_first_name = payer_first_name unless payer_first_name == SKIP
+      @payer_family_name = payer_family_name unless payer_family_name == SKIP
+      @payer_account_number = payer_account_number unless payer_account_number == 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.
+      payer_first_name =
+        hash.key?('PayerFirstName') ? hash['PayerFirstName'] : SKIP
+      payer_family_name =
+        hash.key?('PayerFamilyName') ? hash['PayerFamilyName'] : SKIP
+      payer_account_number =
+        hash.key?('PayerAccountNumber') ? hash['PayerAccountNumber'] : 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.
+      PayerDetails.new(payer_first_name: payer_first_name,
+                       payer_family_name: payer_family_name,
+                       payer_account_number: payer_account_number,
+                       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} payer_first_name: #{@payer_first_name}, payer_family_name:"\
+      " #{@payer_family_name}, payer_account_number: #{@payer_account_number},"\
+      " 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} payer_first_name: #{@payer_first_name.inspect}, payer_family_name:"\
+      " #{@payer_family_name.inspect}, payer_account_number: #{@payer_account_number.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/poli_ap_is/models/poli_link_basic_info.rb

@@ -0,0 +1,116 @@
+# poli_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module PoliApIs
+  # PoliLinkBasicInfo Model.
+  class PoliLinkBasicInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The total amount the customer(s) pay when using the POLiLink
+    # @return [Float]
+    attr_accessor :total_amount
+
+    # The cumulative amount paid towards the POLi Link over all transactions
+    # @return [Float]
+    attr_accessor :total_paid_amount
+
+    # Status of the POLi Link
+    # @return [PoliLinkBasicInfoStatus]
+    attr_accessor :status
+
+    # The transaction history of this POLi Link
+    # @return [Array[LinkPayment]]
+    attr_accessor :transactions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_amount'] = 'TotalAmount'
+      @_hash['total_paid_amount'] = 'TotalPaidAmount'
+      @_hash['status'] = 'Status'
+      @_hash['transactions'] = 'Transactions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_amount
+        total_paid_amount
+        status
+        transactions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_amount: SKIP, total_paid_amount: SKIP, status: SKIP,
+                   transactions: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @total_amount = total_amount unless total_amount == SKIP
+      @total_paid_amount = total_paid_amount unless total_paid_amount == SKIP
+      @status = status unless status == SKIP
+      @transactions = transactions unless transactions == 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.
+      total_amount = hash.key?('TotalAmount') ? hash['TotalAmount'] : SKIP
+      total_paid_amount =
+        hash.key?('TotalPaidAmount') ? hash['TotalPaidAmount'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      transactions = nil
+      unless hash['Transactions'].nil?
+        transactions = []
+        hash['Transactions'].each do |structure|
+          transactions << (LinkPayment.from_hash(structure) if structure)
+        end
+      end
+
+      transactions = SKIP unless hash.key?('Transactions')
+
+      # 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.
+      PoliLinkBasicInfo.new(total_amount: total_amount,
+                            total_paid_amount: total_paid_amount,
+                            status: status,
+                            transactions: transactions,
+                            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} total_amount: #{@total_amount}, total_paid_amount: #{@total_paid_amount},"\
+      " status: #{@status}, transactions: #{@transactions}, 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} total_amount: #{@total_amount.inspect}, total_paid_amount:"\
+      " #{@total_paid_amount.inspect}, status: #{@status.inspect}, transactions:"\
+      " #{@transactions.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/poli_ap_is/models/poli_link_basic_info_status.rb

@@ -0,0 +1,48 @@
+# poli_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module PoliApIs
+  # Status of the POLi Link
+  class PoliLinkBasicInfoStatus
+    POLI_LINK_BASIC_INFO_STATUS = [
+      # TODO: Write general description for UNUSED
+      UNUSED = 'Unused'.freeze,
+
+      # TODO: Write general description for ACTIVATED
+      ACTIVATED = 'Activated'.freeze,
+
+      # TODO: Write general description for PARTPAID
+      PARTPAID = 'PartPaid'.freeze,
+
+      # TODO: Write general description for FUTURE
+      FUTURE = 'Future'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'Completed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      POLI_LINK_BASIC_INFO_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = UNUSED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'unused' then UNUSED
+      when 'activated' then ACTIVATED
+      when 'partpaid' then PARTPAID
+      when 'future' then FUTURE
+      when 'completed' then COMPLETED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/poli_ap_is/models/poli_link_payments_response.rb

@@ -0,0 +1,116 @@
+# poli_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module PoliApIs
+  # PoliLinkPaymentsResponse Model.
+  class PoliLinkPaymentsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The total amount the customer(s) pay when using the POLiLink
+    # @return [Float]
+    attr_accessor :total_amount
+
+    # The cumulative amount paid towards the POLi Link over all transactions
+    # @return [Float]
+    attr_accessor :total_paid_amount
+
+    # Status of the POLi Link
+    # @return [PoliLinkPaymentsResponseStatus]
+    attr_accessor :status
+
+    # The transaction history of this POLi Link
+    # @return [Array[PoliLinkPaymentsResponseTransactionsItems]]
+    attr_accessor :transactions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_amount'] = 'TotalAmount'
+      @_hash['total_paid_amount'] = 'TotalPaidAmount'
+      @_hash['status'] = 'Status'
+      @_hash['transactions'] = 'Transactions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_amount
+        total_paid_amount
+        status
+        transactions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_amount: SKIP, total_paid_amount: SKIP, status: SKIP,
+                   transactions: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @total_amount = total_amount unless total_amount == SKIP
+      @total_paid_amount = total_paid_amount unless total_paid_amount == SKIP
+      @status = status unless status == SKIP
+      @transactions = transactions unless transactions == 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.
+      total_amount = hash.key?('TotalAmount') ? hash['TotalAmount'] : SKIP
+      total_paid_amount =
+        hash.key?('TotalPaidAmount') ? hash['TotalPaidAmount'] : SKIP
+      status = hash.key?('Status') ? hash['Status'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      transactions = nil
+      unless hash['Transactions'].nil?
+        transactions = []
+        hash['Transactions'].each do |structure|
+          transactions << (PoliLinkPaymentsResponseTransactionsItems.from_hash(structure) if structure)
+        end
+      end
+
+      transactions = SKIP unless hash.key?('Transactions')
+
+      # 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.
+      PoliLinkPaymentsResponse.new(total_amount: total_amount,
+                                   total_paid_amount: total_paid_amount,
+                                   status: status,
+                                   transactions: transactions,
+                                   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} total_amount: #{@total_amount}, total_paid_amount: #{@total_paid_amount},"\
+      " status: #{@status}, transactions: #{@transactions}, 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} total_amount: #{@total_amount.inspect}, total_paid_amount:"\
+      " #{@total_paid_amount.inspect}, status: #{@status.inspect}, transactions:"\
+      " #{@transactions.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/poli_ap_is/models/poli_link_payments_response_status.rb

@@ -0,0 +1,48 @@
+# poli_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module PoliApIs
+  # Status of the POLi Link
+  class PoliLinkPaymentsResponseStatus
+    POLI_LINK_PAYMENTS_RESPONSE_STATUS = [
+      # TODO: Write general description for UNUSED
+      UNUSED = 'Unused'.freeze,
+
+      # TODO: Write general description for ACTIVATED
+      ACTIVATED = 'Activated'.freeze,
+
+      # TODO: Write general description for PARTPAID
+      PARTPAID = 'PartPaid'.freeze,
+
+      # TODO: Write general description for FUTURE
+      FUTURE = 'Future'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'Completed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      POLI_LINK_PAYMENTS_RESPONSE_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = UNUSED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'unused' then UNUSED
+      when 'activated' then ACTIVATED
+      when 'partpaid' then PARTPAID
+      when 'future' then FUTURE
+      when 'completed' then COMPLETED
+      else
+        default_value
+      end
+    end
+  end
+end