apimatic-polpay-sdk 0.0.1

data/lib/poli_ap_is/models/fetch_statusof_poli_link_response200_text.rb

@@ -0,0 +1,48 @@
+# poli_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module PoliApIs
+  # FetchStatusofPOLiLinkResponse200Text.
+  class FetchStatusofPoliLinkResponse200Text
+    FETCH_STATUSOF_POLI_LINK_RESPONSE200_TEXT = [
+      # 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?
+
+      FETCH_STATUSOF_POLI_LINK_RESPONSE200_TEXT.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/financial_institution.rb

@@ -0,0 +1,95 @@
+# poli_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module PoliApIs
+  # FinancialInstitution Model.
+  class FinancialInstitution < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the financial institution
+    # @return [String]
+    attr_accessor :name
+
+    # The code of the financial institution
+    # @return [String]
+    attr_accessor :code
+
+    # Indicates whether the financial institution is online
+    # @return [TrueClass | FalseClass]
+    attr_accessor :online
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'Name'
+      @_hash['code'] = 'Code'
+      @_hash['online'] = 'Online'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        code
+        online
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, code: SKIP, online: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @code = code unless code == SKIP
+      @online = online unless online == 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.
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      code = hash.key?('Code') ? hash['Code'] : SKIP
+      online = hash.key?('Online') ? hash['Online'] : 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.
+      FinancialInstitution.new(name: name,
+                               code: code,
+                               online: online,
+                               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} name: #{@name}, code: #{@code}, online: #{@online}, 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} name: #{@name.inspect}, code: #{@code.inspect}, online: #{@online.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/poli_ap_is/models/get_transaction_response.rb

@@ -0,0 +1,109 @@
+# poli_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module PoliApIs
+  # GetTransactionResponse Model.
+  class GetTransactionResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TransactionDetails]
+    attr_accessor :transaction_details
+
+    # TODO: Write general description for this method
+    # @return [BankDetails]
+    attr_accessor :bank_details
+
+    # TODO: Write general description for this method
+    # @return [MerchantDetails]
+    attr_accessor :merchant_details
+
+    # TODO: Write general description for this method
+    # @return [PayerDetails]
+    attr_accessor :payer_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['transaction_details'] = 'TransactionDetails'
+      @_hash['bank_details'] = 'BankDetails'
+      @_hash['merchant_details'] = 'MerchantDetails'
+      @_hash['payer_details'] = 'PayerDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        transaction_details
+        bank_details
+        merchant_details
+        payer_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(transaction_details: SKIP, bank_details: SKIP,
+                   merchant_details: SKIP, payer_details: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @transaction_details = transaction_details unless transaction_details == SKIP
+      @bank_details = bank_details unless bank_details == SKIP
+      @merchant_details = merchant_details unless merchant_details == SKIP
+      @payer_details = payer_details unless payer_details == 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_details = TransactionDetails.from_hash(hash['TransactionDetails']) if
+        hash['TransactionDetails']
+      bank_details = BankDetails.from_hash(hash['BankDetails']) if hash['BankDetails']
+      merchant_details = MerchantDetails.from_hash(hash['MerchantDetails']) if
+        hash['MerchantDetails']
+      payer_details = PayerDetails.from_hash(hash['PayerDetails']) if hash['PayerDetails']
+
+      # 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.
+      GetTransactionResponse.new(transaction_details: transaction_details,
+                                 bank_details: bank_details,
+                                 merchant_details: merchant_details,
+                                 payer_details: payer_details,
+                                 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} transaction_details: #{@transaction_details}, bank_details:"\
+      " #{@bank_details}, merchant_details: #{@merchant_details}, payer_details:"\
+      " #{@payer_details}, 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_details: #{@transaction_details.inspect}, bank_details:"\
+      " #{@bank_details.inspect}, merchant_details: #{@merchant_details.inspect}, payer_details:"\
+      " #{@payer_details.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/poli_ap_is/models/initiate_transaction_request.rb

@@ -0,0 +1,201 @@
+# poli_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module PoliApIs
+  # InitiateTransactionRequest Model.
+  class InitiateTransactionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The transaction amount the customer should be charged. Value up to 2
+    # decimal places.
+    # @return [Float]
+    attr_accessor :amount
+
+    # The currency of the transaction. Typically a 3-character code.
+    # @return [String]
+    attr_accessor :currency_code
+
+    # Unique reference specified by the merchant for the transaction. Special
+    # characters will be replaced with spaces in the bank field.
+    # @return [String]
+    attr_accessor :merchant_reference
+
+    # Specifies a reconciliation format (used for NZ reconciliation).
+    # @return [String]
+    attr_accessor :merchant_reference_format
+
+    # Merchant-specified information carried along with the transaction for
+    # internal use post-transaction.
+    # @return [String]
+    attr_accessor :merchant_data
+
+    # Complete URL displayed on the POLi landing page.
+    # @return [String]
+    attr_accessor :merchant_homepage_url
+
+    # Complete URL to redirect the customer to if the transaction is successful.
+    # The transaction token will be appended as a query parameter.
+    # @return [String]
+    attr_accessor :success_url
+
+    # Complete URL to redirect the customer to if the transaction is not
+    # successful. The transaction token will be appended as a query parameter.
+    # @return [String]
+    attr_accessor :failure_url
+
+    # Complete URL to redirect the customer to if they cancel the transaction.
+    # The transaction token will be appended as a query parameter.
+    # @return [String]
+    attr_accessor :cancellation_url
+
+    # URL where POLi will deliver the Nudge POST when the transaction reaches a
+    # terminal state.
+    # @return [String]
+    attr_accessor :notification_url
+
+    # Timeout for the transaction in seconds. Defaults to 900 (15 minutes).
+    # @return [Integer]
+    attr_accessor :timeout
+
+    # Pre-selects a bank to skip the POLi landing page.
+    # @return [String]
+    attr_accessor :selected_fi_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'Amount'
+      @_hash['currency_code'] = 'CurrencyCode'
+      @_hash['merchant_reference'] = 'MerchantReference'
+      @_hash['merchant_reference_format'] = 'MerchantReferenceFormat'
+      @_hash['merchant_data'] = 'MerchantData'
+      @_hash['merchant_homepage_url'] = 'MerchantHomepageURL'
+      @_hash['success_url'] = 'SuccessURL'
+      @_hash['failure_url'] = 'FailureURL'
+      @_hash['cancellation_url'] = 'CancellationURL'
+      @_hash['notification_url'] = 'NotificationURL'
+      @_hash['timeout'] = 'Timeout'
+      @_hash['selected_fi_code'] = 'SelectedFICode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_reference_format
+        merchant_data
+        failure_url
+        cancellation_url
+        notification_url
+        timeout
+        selected_fi_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount:, currency_code:, merchant_reference:,
+                   merchant_homepage_url:, success_url:,
+                   merchant_reference_format: SKIP, merchant_data: SKIP,
+                   failure_url: SKIP, cancellation_url: SKIP,
+                   notification_url: SKIP, timeout: SKIP,
+                   selected_fi_code: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @amount = amount
+      @currency_code = currency_code
+      @merchant_reference = merchant_reference
+      unless merchant_reference_format == SKIP
+        @merchant_reference_format =
+          merchant_reference_format
+      end
+      @merchant_data = merchant_data unless merchant_data == SKIP
+      @merchant_homepage_url = merchant_homepage_url
+      @success_url = success_url
+      @failure_url = failure_url unless failure_url == SKIP
+      @cancellation_url = cancellation_url unless cancellation_url == SKIP
+      @notification_url = notification_url unless notification_url == SKIP
+      @timeout = timeout unless timeout == SKIP
+      @selected_fi_code = selected_fi_code unless selected_fi_code == 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.
+      amount = hash.key?('Amount') ? hash['Amount'] : nil
+      currency_code = hash.key?('CurrencyCode') ? hash['CurrencyCode'] : nil
+      merchant_reference =
+        hash.key?('MerchantReference') ? hash['MerchantReference'] : nil
+      merchant_homepage_url =
+        hash.key?('MerchantHomepageURL') ? hash['MerchantHomepageURL'] : nil
+      success_url = hash.key?('SuccessURL') ? hash['SuccessURL'] : nil
+      merchant_reference_format =
+        hash.key?('MerchantReferenceFormat') ? hash['MerchantReferenceFormat'] : SKIP
+      merchant_data = hash.key?('MerchantData') ? hash['MerchantData'] : SKIP
+      failure_url = hash.key?('FailureURL') ? hash['FailureURL'] : SKIP
+      cancellation_url =
+        hash.key?('CancellationURL') ? hash['CancellationURL'] : SKIP
+      notification_url =
+        hash.key?('NotificationURL') ? hash['NotificationURL'] : SKIP
+      timeout = hash.key?('Timeout') ? hash['Timeout'] : SKIP
+      selected_fi_code =
+        hash.key?('SelectedFICode') ? hash['SelectedFICode'] : 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.
+      InitiateTransactionRequest.new(amount: amount,
+                                     currency_code: currency_code,
+                                     merchant_reference: merchant_reference,
+                                     merchant_homepage_url: merchant_homepage_url,
+                                     success_url: success_url,
+                                     merchant_reference_format: merchant_reference_format,
+                                     merchant_data: merchant_data,
+                                     failure_url: failure_url,
+                                     cancellation_url: cancellation_url,
+                                     notification_url: notification_url,
+                                     timeout: timeout,
+                                     selected_fi_code: selected_fi_code,
+                                     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} amount: #{@amount}, currency_code: #{@currency_code}, merchant_reference:"\
+      " #{@merchant_reference}, merchant_reference_format: #{@merchant_reference_format},"\
+      " merchant_data: #{@merchant_data}, merchant_homepage_url: #{@merchant_homepage_url},"\
+      " success_url: #{@success_url}, failure_url: #{@failure_url}, cancellation_url:"\
+      " #{@cancellation_url}, notification_url: #{@notification_url}, timeout: #{@timeout},"\
+      " selected_fi_code: #{@selected_fi_code}, 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} amount: #{@amount.inspect}, currency_code: #{@currency_code.inspect},"\
+      " merchant_reference: #{@merchant_reference.inspect}, merchant_reference_format:"\
+      " #{@merchant_reference_format.inspect}, merchant_data: #{@merchant_data.inspect},"\
+      " merchant_homepage_url: #{@merchant_homepage_url.inspect}, success_url:"\
+      " #{@success_url.inspect}, failure_url: #{@failure_url.inspect}, cancellation_url:"\
+      " #{@cancellation_url.inspect}, notification_url: #{@notification_url.inspect}, timeout:"\
+      " #{@timeout.inspect}, selected_fi_code: #{@selected_fi_code.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/poli_ap_is/models/initiate_transaction_response.rb

@@ -0,0 +1,118 @@
+# poli_ap_is
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module PoliApIs
+  # InitiateTransactionResponse Model.
+  class InitiateTransactionResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates if the transaction was successful.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :success
+
+    # The URL to redirect the customer to proceed with the payment.
+    # @return [String]
+    attr_accessor :navigate_url
+
+    # Error code if the transaction failed.
+    # @return [Integer]
+    attr_accessor :error_code
+
+    # Error message if the transaction failed.
+    # @return [String]
+    attr_accessor :error_message
+
+    # Reference number for the transaction.
+    # @return [String]
+    attr_accessor :transaction_ref_no
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['success'] = 'Success'
+      @_hash['navigate_url'] = 'NavigateURL'
+      @_hash['error_code'] = 'ErrorCode'
+      @_hash['error_message'] = 'ErrorMessage'
+      @_hash['transaction_ref_no'] = 'TransactionRefNo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        success
+        navigate_url
+        error_code
+        error_message
+        transaction_ref_no
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(success: SKIP, navigate_url: SKIP, error_code: SKIP,
+                   error_message: SKIP, transaction_ref_no: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @success = success unless success == SKIP
+      @navigate_url = navigate_url unless navigate_url == SKIP
+      @error_code = error_code unless error_code == SKIP
+      @error_message = error_message unless error_message == SKIP
+      @transaction_ref_no = transaction_ref_no unless transaction_ref_no == 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.
+      success = hash.key?('Success') ? hash['Success'] : SKIP
+      navigate_url = hash.key?('NavigateURL') ? hash['NavigateURL'] : SKIP
+      error_code = hash.key?('ErrorCode') ? hash['ErrorCode'] : SKIP
+      error_message = hash.key?('ErrorMessage') ? hash['ErrorMessage'] : SKIP
+      transaction_ref_no =
+        hash.key?('TransactionRefNo') ? hash['TransactionRefNo'] : 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.
+      InitiateTransactionResponse.new(success: success,
+                                      navigate_url: navigate_url,
+                                      error_code: error_code,
+                                      error_message: error_message,
+                                      transaction_ref_no: transaction_ref_no,
+                                      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} success: #{@success}, navigate_url: #{@navigate_url}, error_code:"\
+      " #{@error_code}, error_message: #{@error_message}, transaction_ref_no:"\
+      " #{@transaction_ref_no}, 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} success: #{@success.inspect}, navigate_url: #{@navigate_url.inspect},"\
+      " error_code: #{@error_code.inspect}, error_message: #{@error_message.inspect},"\
+      " transaction_ref_no: #{@transaction_ref_no.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end