univapay-client-sdk 1.0.0

data/lib/univapay_client_sdk/models/bank_transfer_ledger.rb

@@ -0,0 +1,199 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module UnivapayClientSdk
+  # Single bank transfer ledger entry associated with a charge.
+  class BankTransferLedger < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Bank Transfer Ledger Bank Ledger Type schema.
+    # @return [BankTransferLedgerBankLedgerType]
+    attr_accessor :bank_ledger_type
+
+    # Amount in the smallest currency unit.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # Current balance in the smallest currency unit.
+    # @return [Integer]
+    attr_accessor :balance
+
+    # Virtual bank account holder name.
+    # @return [String]
+    attr_accessor :virtual_bank_account_holder_name
+
+    # Virtual bank account number.
+    # @return [String]
+    attr_accessor :virtual_bank_account_number
+
+    # Virtual account id value.
+    # @return [String]
+    attr_accessor :virtual_account_id
+
+    # Transaction date.
+    # @return [Date]
+    attr_accessor :transaction_date
+
+    # Transaction timestamp.
+    # @return [DateTime]
+    attr_accessor :transaction_timestamp
+
+    # Bank Transfer Ledger Mode schema.
+    # @return [BankTransferLedgerMode]
+    attr_accessor :mode
+
+    # Timestamp when the resource was created.
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['bank_ledger_type'] = 'bank_ledger_type'
+      @_hash['amount'] = 'amount'
+      @_hash['balance'] = 'balance'
+      @_hash['virtual_bank_account_holder_name'] =
+        'virtual_bank_account_holder_name'
+      @_hash['virtual_bank_account_number'] = 'virtual_bank_account_number'
+      @_hash['virtual_account_id'] = 'virtual_account_id'
+      @_hash['transaction_date'] = 'transaction_date'
+      @_hash['transaction_timestamp'] = 'transaction_timestamp'
+      @_hash['mode'] = 'mode'
+      @_hash['created_on'] = 'created_on'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        bank_ledger_type
+        amount
+        balance
+        virtual_bank_account_holder_name
+        virtual_bank_account_number
+        virtual_account_id
+        transaction_date
+        transaction_timestamp
+        mode
+        created_on
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(bank_ledger_type: SKIP, amount: SKIP, balance: SKIP,
+                   virtual_bank_account_holder_name: SKIP,
+                   virtual_bank_account_number: SKIP, virtual_account_id: SKIP,
+                   transaction_date: SKIP, transaction_timestamp: SKIP,
+                   mode: SKIP, created_on: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @bank_ledger_type = bank_ledger_type unless bank_ledger_type == SKIP
+      @amount = amount unless amount == SKIP
+      @balance = balance unless balance == SKIP
+      unless virtual_bank_account_holder_name == SKIP
+        @virtual_bank_account_holder_name =
+          virtual_bank_account_holder_name
+      end
+      unless virtual_bank_account_number == SKIP
+        @virtual_bank_account_number =
+          virtual_bank_account_number
+      end
+      @virtual_account_id = virtual_account_id unless virtual_account_id == SKIP
+      @transaction_date = transaction_date unless transaction_date == SKIP
+      @transaction_timestamp = transaction_timestamp unless transaction_timestamp == SKIP
+      @mode = mode unless mode == SKIP
+      @created_on = created_on unless created_on == 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.
+      bank_ledger_type =
+        hash.key?('bank_ledger_type') ? hash['bank_ledger_type'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      balance = hash.key?('balance') ? hash['balance'] : SKIP
+      virtual_bank_account_holder_name =
+        hash.key?('virtual_bank_account_holder_name') ? hash['virtual_bank_account_holder_name'] : SKIP
+      virtual_bank_account_number =
+        hash.key?('virtual_bank_account_number') ? hash['virtual_bank_account_number'] : SKIP
+      virtual_account_id =
+        hash.key?('virtual_account_id') ? hash['virtual_account_id'] : SKIP
+      transaction_date =
+        hash.key?('transaction_date') ? hash['transaction_date'] : SKIP
+      transaction_timestamp = if hash.key?('transaction_timestamp')
+                                (DateTimeHelper.from_rfc3339(hash['transaction_timestamp']) if hash['transaction_timestamp'])
+                              else
+                                SKIP
+                              end
+      mode = hash.key?('mode') ? hash['mode'] : SKIP
+      created_on = if hash.key?('created_on')
+                     (DateTimeHelper.from_rfc3339(hash['created_on']) if hash['created_on'])
+                   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.
+      BankTransferLedger.new(bank_ledger_type: bank_ledger_type,
+                             amount: amount,
+                             balance: balance,
+                             virtual_bank_account_holder_name: virtual_bank_account_holder_name,
+                             virtual_bank_account_number: virtual_bank_account_number,
+                             virtual_account_id: virtual_account_id,
+                             transaction_date: transaction_date,
+                             transaction_timestamp: transaction_timestamp,
+                             mode: mode,
+                             created_on: created_on,
+                             additional_properties: additional_properties)
+    end
+
+    def to_custom_transaction_timestamp
+      DateTimeHelper.to_rfc3339(transaction_timestamp)
+    end
+
+    def to_custom_created_on
+      DateTimeHelper.to_rfc3339(created_on)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} bank_ledger_type: #{@bank_ledger_type}, amount: #{@amount}, balance:"\
+      " #{@balance}, virtual_bank_account_holder_name: #{@virtual_bank_account_holder_name},"\
+      " virtual_bank_account_number: #{@virtual_bank_account_number}, virtual_account_id:"\
+      " #{@virtual_account_id}, transaction_date: #{@transaction_date}, transaction_timestamp:"\
+      " #{@transaction_timestamp}, mode: #{@mode}, created_on: #{@created_on},"\
+      " 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} bank_ledger_type: #{@bank_ledger_type.inspect}, amount: #{@amount.inspect},"\
+      " balance: #{@balance.inspect}, virtual_bank_account_holder_name:"\
+      " #{@virtual_bank_account_holder_name.inspect}, virtual_bank_account_number:"\
+      " #{@virtual_bank_account_number.inspect}, virtual_account_id:"\
+      " #{@virtual_account_id.inspect}, transaction_date: #{@transaction_date.inspect},"\
+      " transaction_timestamp: #{@transaction_timestamp.inspect}, mode: #{@mode.inspect},"\
+      " created_on: #{@created_on.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/bank_transfer_ledger_bank_ledger_type.rb

@@ -0,0 +1,36 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Bank Transfer Ledger Bank Ledger Type schema.
+  class BankTransferLedgerBankLedgerType
+    BANK_TRANSFER_LEDGER_BANK_LEDGER_TYPE = [
+      # TODO: Write general description for DEPOSIT
+      DEPOSIT = 'deposit'.freeze,
+
+      # TODO: Write general description for PAYMENT
+      PAYMENT = 'payment'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BANK_TRANSFER_LEDGER_BANK_LEDGER_TYPE.include?(value)
+    end
+
+    def self.from_value(value, default_value = DEPOSIT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'deposit' then DEPOSIT
+      when 'payment' then PAYMENT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/models/bank_transfer_ledger_list.rb

@@ -0,0 +1,104 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Paginated list of bank transfer ledger entries.
+  class BankTransferLedgerList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # List of resources.
+    # @return [Array[BankTransferLedger]]
+    attr_accessor :items
+
+    # Whether more results are available.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :has_more
+
+    # Total number of matching resources.
+    # @return [Integer]
+    attr_accessor :total_hits
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['items'] = 'items'
+      @_hash['has_more'] = 'has_more'
+      @_hash['total_hits'] = 'total_hits'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        items
+        has_more
+        total_hits
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(items: SKIP, has_more: SKIP, total_hits: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @items = items unless items == SKIP
+      @has_more = has_more unless has_more == SKIP
+      @total_hits = total_hits unless total_hits == 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.
+      # Parameter is an array, so we need to iterate through it
+      items = nil
+      unless hash['items'].nil?
+        items = []
+        hash['items'].each do |structure|
+          items << (BankTransferLedger.from_hash(structure) if structure)
+        end
+      end
+
+      items = SKIP unless hash.key?('items')
+      has_more = hash.key?('has_more') ? hash['has_more'] : SKIP
+      total_hits = hash.key?('total_hits') ? hash['total_hits'] : 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.
+      BankTransferLedgerList.new(items: items,
+                                 has_more: has_more,
+                                 total_hits: total_hits,
+                                 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} items: #{@items}, has_more: #{@has_more}, total_hits: #{@total_hits},"\
+      " 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} items: #{@items.inspect}, has_more: #{@has_more.inspect}, total_hits:"\
+      " #{@total_hits.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/univapay_client_sdk/models/bank_transfer_ledger_mode.rb

@@ -0,0 +1,36 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Bank Transfer Ledger Mode schema.
+  class BankTransferLedgerMode
+    BANK_TRANSFER_LEDGER_MODE = [
+      # TODO: Write general description for LIVE
+      LIVE = 'live'.freeze,
+
+      # TODO: Write general description for TEST
+      TEST = 'test'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BANK_TRANSFER_LEDGER_MODE.include?(value)
+    end
+
+    def self.from_value(value, default_value = LIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'live' then LIVE
+      when 'test' then TEST
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/models/bank_transfer_payment_status.rb

@@ -0,0 +1,44 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module UnivapayClientSdk
+  # Payment status of a bank transfer charge.
+  class BankTransferPaymentStatus
+    BANK_TRANSFER_PAYMENT_STATUS = [
+      # TODO: Write general description for UNPAID
+      UNPAID = 'unpaid'.freeze,
+
+      # TODO: Write general description for INSUFFICIENT
+      INSUFFICIENT = 'insufficient'.freeze,
+
+      # TODO: Write general description for EXACT
+      EXACT = 'exact'.freeze,
+
+      # TODO: Write general description for EXCEEDED
+      EXCEEDED = 'exceeded'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BANK_TRANSFER_PAYMENT_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = UNPAID)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'unpaid' then UNPAID
+      when 'insufficient' then INSUFFICIENT
+      when 'exact' then EXACT
+      when 'exceeded' then EXCEEDED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/univapay_client_sdk/models/bank_transfer_status_data.rb

@@ -0,0 +1,229 @@
+# univapay_client_sdk
+#
+# This file was automatically generated for Univapay
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module UnivapayClientSdk
+  # Data payload for `bank_transfer_status_updated` webhook events. Contains the
+  # bank transfer extension fields inlined alongside amount and metadata.
+  class BankTransferStatusData < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Bank transfer charge extension ID.
+    # @return [UUID | String]
+    attr_accessor :id
+
+    # ID of the associated charge.
+    # @return [UUID | String]
+    attr_accessor :charge_id
+
+    # Payment status of a bank transfer charge.
+    # @return [BankTransferPaymentStatus]
+    attr_accessor :payment_status
+
+    # Date of the most recent deposit.
+    # @return [DateTime]
+    attr_accessor :latest_deposit_date
+
+    # When the bank transfer extension record was created.
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # Amount of the most recent deposit in minor currency units.
+    # @return [Integer]
+    attr_accessor :latest_deposit_amount
+
+    # Current outstanding balance in minor currency units.
+    # @return [Integer]
+    attr_accessor :balance
+
+    # ISO 4217 currency code.
+    # @return [String]
+    attr_accessor :currency
+
+    # Total charge amount in minor currency units.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # Difference between paid and expected amount (positive = over, negative =
+    # under).
+    # @return [Integer]
+    attr_accessor :amount_difference
+
+    # A free-form dictionary for custom metadata.
+    # @return [GenericMetadata]
+    attr_accessor :token_metadata
+
+    # A free-form dictionary for custom metadata.
+    # @return [GenericMetadata]
+    attr_accessor :charge_metadata
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['charge_id'] = 'charge_id'
+      @_hash['payment_status'] = 'payment_status'
+      @_hash['latest_deposit_date'] = 'latest_deposit_date'
+      @_hash['created_on'] = 'created_on'
+      @_hash['latest_deposit_amount'] = 'latest_deposit_amount'
+      @_hash['balance'] = 'balance'
+      @_hash['currency'] = 'currency'
+      @_hash['amount'] = 'amount'
+      @_hash['amount_difference'] = 'amount_difference'
+      @_hash['token_metadata'] = 'token_metadata'
+      @_hash['charge_metadata'] = 'charge_metadata'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        charge_id
+        payment_status
+        latest_deposit_date
+        created_on
+        latest_deposit_amount
+        balance
+        currency
+        amount
+        amount_difference
+        token_metadata
+        charge_metadata
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        id
+        latest_deposit_date
+        created_on
+        latest_deposit_amount
+        balance
+        amount_difference
+      ]
+    end
+
+    def initialize(id: SKIP, charge_id: SKIP, payment_status: SKIP,
+                   latest_deposit_date: SKIP, created_on: SKIP,
+                   latest_deposit_amount: SKIP, balance: SKIP, currency: SKIP,
+                   amount: SKIP, amount_difference: SKIP, token_metadata: SKIP,
+                   charge_metadata: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @id = id unless id == SKIP
+      @charge_id = charge_id unless charge_id == SKIP
+      @payment_status = payment_status unless payment_status == SKIP
+      @latest_deposit_date = latest_deposit_date unless latest_deposit_date == SKIP
+      @created_on = created_on unless created_on == SKIP
+      @latest_deposit_amount = latest_deposit_amount unless latest_deposit_amount == SKIP
+      @balance = balance unless balance == SKIP
+      @currency = currency unless currency == SKIP
+      @amount = amount unless amount == SKIP
+      @amount_difference = amount_difference unless amount_difference == SKIP
+      @token_metadata = token_metadata unless token_metadata == SKIP
+      @charge_metadata = charge_metadata unless charge_metadata == 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'] : SKIP
+      charge_id = hash.key?('charge_id') ? hash['charge_id'] : SKIP
+      payment_status =
+        hash.key?('payment_status') ? hash['payment_status'] : SKIP
+      latest_deposit_date = if hash.key?('latest_deposit_date')
+                              (DateTimeHelper.from_rfc3339(hash['latest_deposit_date']) if hash['latest_deposit_date'])
+                            else
+                              SKIP
+                            end
+      created_on = if hash.key?('created_on')
+                     (DateTimeHelper.from_rfc3339(hash['created_on']) if hash['created_on'])
+                   else
+                     SKIP
+                   end
+      latest_deposit_amount =
+        hash.key?('latest_deposit_amount') ? hash['latest_deposit_amount'] : SKIP
+      balance = hash.key?('balance') ? hash['balance'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      amount = hash.key?('amount') ? hash['amount'] : SKIP
+      amount_difference =
+        hash.key?('amount_difference') ? hash['amount_difference'] : SKIP
+      token_metadata = GenericMetadata.from_hash(hash['token_metadata']) if hash['token_metadata']
+      charge_metadata = GenericMetadata.from_hash(hash['charge_metadata']) if
+        hash['charge_metadata']
+
+      # 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.
+      BankTransferStatusData.new(id: id,
+                                 charge_id: charge_id,
+                                 payment_status: payment_status,
+                                 latest_deposit_date: latest_deposit_date,
+                                 created_on: created_on,
+                                 latest_deposit_amount: latest_deposit_amount,
+                                 balance: balance,
+                                 currency: currency,
+                                 amount: amount,
+                                 amount_difference: amount_difference,
+                                 token_metadata: token_metadata,
+                                 charge_metadata: charge_metadata,
+                                 additional_properties: additional_properties)
+    end
+
+    def to_custom_latest_deposit_date
+      DateTimeHelper.to_rfc3339(latest_deposit_date)
+    end
+
+    def to_custom_created_on
+      DateTimeHelper.to_rfc3339(created_on)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [BankTransferStatusData | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? 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}, charge_id: #{@charge_id}, payment_status: #{@payment_status},"\
+      " latest_deposit_date: #{@latest_deposit_date}, created_on: #{@created_on},"\
+      " latest_deposit_amount: #{@latest_deposit_amount}, balance: #{@balance}, currency:"\
+      " #{@currency}, amount: #{@amount}, amount_difference: #{@amount_difference},"\
+      " token_metadata: #{@token_metadata}, charge_metadata: #{@charge_metadata},"\
+      " 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}, charge_id: #{@charge_id.inspect}, payment_status:"\
+      " #{@payment_status.inspect}, latest_deposit_date: #{@latest_deposit_date.inspect},"\
+      " created_on: #{@created_on.inspect}, latest_deposit_amount:"\
+      " #{@latest_deposit_amount.inspect}, balance: #{@balance.inspect}, currency:"\
+      " #{@currency.inspect}, amount: #{@amount.inspect}, amount_difference:"\
+      " #{@amount_difference.inspect}, token_metadata: #{@token_metadata.inspect},"\
+      " charge_metadata: #{@charge_metadata.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end