payquicker-apimatic-sdk 1.0.0

data/lib/pay_quicker_sdk/models/bank_account_result.rb

@@ -0,0 +1,234 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module PayQuickerSdk
+  # BankAccountResult Model.
+  class BankAccountResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier representing the [destination of
+    # funds](#/rest/models/structures/destination-token)
+    # @return [String]
+    attr_accessor :token
+
+    # Account [ownership types](#/rest/models/structures/bank-account-ownership)
+    # @return [BankAccountOwnership]
+    attr_accessor :bank_account_ownership_type
+
+    # Throughout the PayQuicker API, the usage of the 2-letter alpha code is
+    # used in place of the country name, e.g., for bank country or residential
+    # country.
+    # The 2-letter codes adhere to the ISO 3166-1 spec and are listed here for
+    # convenience.
+    # @return [Countries]
+    attr_accessor :bank_country
+
+    # [Currency code type](#/rest/models/structures/country) for the object
+    # @return [Currencies]
+    attr_accessor :bank_currency
+
+    # [Currency code type](#/rest/models/structures/country) for the object
+    # @return [BankAccountAddress]
+    attr_accessor :address
+
+    # Time object was [created](#/rest/models/structures/created-on)
+    # @return [DateTime]
+    attr_accessor :created_on
+
+    # User-supplied description of the bank account for reference
+    # @return [String]
+    attr_accessor :description
+
+    # User-supplied description of the bank account for reference
+    # @return [Array[BankAccountField]]
+    attr_accessor :fields
+
+    # Current verification status type of the [bank
+    # account](#/rest/models/structures/bank-account-status)
+    # @return [BankAccountStatuses]
+    attr_accessor :status
+
+    # Financial purpose of the [bank
+    # account](#/rest/models/structures/bank-account-type)
+    # @return [BankAccountTypes]
+    attr_accessor :type
+
+    # Optional transfer methods applicable only to bank and e-wallet transfers.
+    # @return [TransferMethodTypes]
+    attr_accessor :transfer_method_type
+
+    # Optional transfer methods applicable only to bank and e-wallet transfers.
+    # @return [Array[HateoasSelfRef]]
+    attr_accessor :links
+
+    # Optional transfer methods applicable only to bank and e-wallet transfers.
+    # @return [MetadataItems]
+    attr_accessor :meta
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['token'] = 'token'
+      @_hash['bank_account_ownership_type'] = 'bankAccountOwnershipType'
+      @_hash['bank_country'] = 'bankCountry'
+      @_hash['bank_currency'] = 'bankCurrency'
+      @_hash['address'] = 'address'
+      @_hash['created_on'] = 'createdOn'
+      @_hash['description'] = 'description'
+      @_hash['fields'] = 'fields'
+      @_hash['status'] = 'status'
+      @_hash['type'] = 'type'
+      @_hash['transfer_method_type'] = 'transferMethodType'
+      @_hash['links'] = 'links'
+      @_hash['meta'] = 'meta'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        token
+        bank_account_ownership_type
+        bank_country
+        bank_currency
+        address
+        created_on
+        description
+        fields
+        status
+        type
+        transfer_method_type
+        links
+        meta
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(token = 'dest-631b200f-665d-4dbe-bd01-3063c9dec97d',
+                   bank_account_ownership_type = SKIP, bank_country = SKIP,
+                   bank_currency = Currencies::USD, address = SKIP,
+                   created_on = SKIP, description = SKIP, fields = SKIP,
+                   status = SKIP, type = SKIP, transfer_method_type = SKIP,
+                   links = SKIP, meta = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @token = token unless token == SKIP
+      unless bank_account_ownership_type == SKIP
+        @bank_account_ownership_type =
+          bank_account_ownership_type
+      end
+      @bank_country = bank_country unless bank_country == SKIP
+      @bank_currency = bank_currency unless bank_currency == SKIP
+      @address = address unless address == SKIP
+      @created_on = created_on unless created_on == SKIP
+      @description = description unless description == SKIP
+      @fields = fields unless fields == SKIP
+      @status = status unless status == SKIP
+      @type = type unless type == SKIP
+      @transfer_method_type = transfer_method_type unless transfer_method_type == SKIP
+      @links = links unless links == SKIP
+      @meta = meta unless meta == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      token = hash['token'] ||= 'dest-631b200f-665d-4dbe-bd01-3063c9dec97d'
+      bank_account_ownership_type =
+        hash.key?('bankAccountOwnershipType') ? hash['bankAccountOwnershipType'] : SKIP
+      bank_country = hash.key?('bankCountry') ? hash['bankCountry'] : SKIP
+      bank_currency = hash['bankCurrency'] ||= Currencies::USD
+      address = BankAccountAddress.from_hash(hash['address']) if hash['address']
+      created_on = if hash.key?('createdOn')
+                     (DateTimeHelper.from_rfc3339(hash['createdOn']) if hash['createdOn'])
+                   else
+                     SKIP
+                   end
+      description = hash.key?('description') ? hash['description'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      fields = nil
+      unless hash['fields'].nil?
+        fields = []
+        hash['fields'].each do |structure|
+          fields << (BankAccountField.from_hash(structure) if structure)
+        end
+      end
+
+      fields = SKIP unless hash.key?('fields')
+      status = hash.key?('status') ? hash['status'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      transfer_method_type =
+        hash.key?('transferMethodType') ? hash['transferMethodType'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      links = nil
+      unless hash['links'].nil?
+        links = []
+        hash['links'].each do |structure|
+          links << (HateoasSelfRef.from_hash(structure) if structure)
+        end
+      end
+
+      links = SKIP unless hash.key?('links')
+      meta = MetadataItems.from_hash(hash['meta']) if hash['meta']
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      BankAccountResult.new(token,
+                            bank_account_ownership_type,
+                            bank_country,
+                            bank_currency,
+                            address,
+                            created_on,
+                            description,
+                            fields,
+                            status,
+                            type,
+                            transfer_method_type,
+                            links,
+                            meta,
+                            additional_properties)
+    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} token: #{@token}, bank_account_ownership_type:"\
+      " #{@bank_account_ownership_type}, bank_country: #{@bank_country}, bank_currency:"\
+      " #{@bank_currency}, address: #{@address}, created_on: #{@created_on}, description:"\
+      " #{@description}, fields: #{@fields}, status: #{@status}, type: #{@type},"\
+      " transfer_method_type: #{@transfer_method_type}, links: #{@links}, meta: #{@meta},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} token: #{@token.inspect}, bank_account_ownership_type:"\
+      " #{@bank_account_ownership_type.inspect}, bank_country: #{@bank_country.inspect},"\
+      " bank_currency: #{@bank_currency.inspect}, address: #{@address.inspect}, created_on:"\
+      " #{@created_on.inspect}, description: #{@description.inspect}, fields: #{@fields.inspect},"\
+      " status: #{@status.inspect}, type: #{@type.inspect}, transfer_method_type:"\
+      " #{@transfer_method_type.inspect}, links: #{@links.inspect}, meta: #{@meta.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/bank_account_statuses.rb

@@ -0,0 +1,49 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Current verification status type of the [bank
+  # account](#/rest/models/structures/bank-account-status)
+  class BankAccountStatuses
+    BANK_ACCOUNT_STATUSES = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'ACTIVE'.freeze,
+
+      # TODO: Write general description for DELETED
+      DELETED = 'DELETED'.freeze,
+
+      # TODO: Write general description for PENDING_VERIFICATION
+      PENDING_VERIFICATION = 'PENDING_VERIFICATION'.freeze,
+
+      # TODO: Write general description for VERIFIED
+      VERIFIED = 'VERIFIED'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'UNKNOWN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BANK_ACCOUNT_STATUSES.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'deleted' then DELETED
+      when 'pending_verification' then PENDING_VERIFICATION
+      when 'verified' then VERIFIED
+      when 'unknown' then UNKNOWN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/bank_account_types.rb

@@ -0,0 +1,47 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Financial purpose of the [bank
+  # account](#/rest/models/structures/bank-account-type)
+  class BankAccountTypes
+    BANK_ACCOUNT_TYPES = [
+      # An account at a financial institution against which checks can be drawn
+      # by the account depositor.
+      CHECKING = 'CHECKING'.freeze,
+
+      # An interest-bearing account at a bank or credit union.
+      MONEY_MARKET = 'MONEY_MARKET'.freeze,
+
+      # An account at a financial institution that pays interest but cannot be
+      # used directly as money in the narrow sense of a medium of exchange.
+      SAVINGS = 'SAVINGS'.freeze,
+
+      # Unknown or unrecognized.
+      UNDEFINED = 'UNDEFINED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BANK_ACCOUNT_TYPES.include?(value)
+    end
+
+    def self.from_value(value, default_value = CHECKING)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'checking' then CHECKING
+      when 'money_market' then MONEY_MARKET
+      when 'savings' then SAVINGS
+      when 'undefined' then UNDEFINED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/bank_types.rb

@@ -0,0 +1,68 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Name of the bank
+  class BankTypes
+    BANK_TYPES = [
+      # TODO: Write general description for MCB
+      MCB = 'MCB'.freeze,
+
+      # TODO: Write general description for PEOPLES
+      PEOPLES = 'PEOPLES'.freeze,
+
+      # TODO: Write general description for PPS
+      PPS = 'PPS'.freeze,
+
+      # TODO: Write general description for TOKA
+      TOKA = 'TOKA'.freeze,
+
+      # TODO: Write general description for UNDEFINED
+      UNDEFINED = 'UNDEFINED'.freeze,
+
+      # TODO: Write general description for CHOICELTD
+      CHOICELTD = 'CHOICELTD'.freeze,
+
+      # TODO: Write general description for FLEX
+      FLEX = 'FLEX'.freeze,
+
+      # TODO: Write general description for REWARDS
+      REWARDS = 'REWARDS'.freeze,
+
+      # TODO: Write general description for PATHWARD
+      PATHWARD = 'PATHWARD'.freeze,
+
+      # TODO: Write general description for SUTTON
+      SUTTON = 'SUTTON'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BANK_TYPES.include?(value)
+    end
+
+    def self.from_value(value, default_value = MCB)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'mcb' then MCB
+      when 'peoples' then PEOPLES
+      when 'pps' then PPS
+      when 'toka' then TOKA
+      when 'undefined' then UNDEFINED
+      when 'choiceltd' then CHOICELTD
+      when 'flex' then FLEX
+      when 'rewards' then REWARDS
+      when 'pathward' then PATHWARD
+      when 'sutton' then SUTTON
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/base_model.rb

@@ -0,0 +1,122 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+
+    def get_additional_properties      
+      # Collect all additional properties
+      additional_props = instance_variables.each_with_object({}) do |var, hash|
+        var_name = var.to_s.delete('@').to_sym
+        if !self.class.names.key?(var_name.to_s)
+          hash[var_name] = instance_variable_get(var)
+        end
+      end
+
+      additional_props
+    end
+  end
+  # rubocop:enable all
+end

data/lib/pay_quicker_sdk/models/business_contact_roles.rb

@@ -0,0 +1,44 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Business contact role
+  class BusinessContactRoles
+    BUSINESS_CONTACT_ROLES = [
+      # TODO: Write general description for MANAGER
+      MANAGER = 'MANAGER'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'OTHER'.freeze,
+
+      # TODO: Write general description for OWNER
+      OWNER = 'OWNER'.freeze,
+
+      # TODO: Write general description for PARTNER
+      PARTNER = 'PARTNER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BUSINESS_CONTACT_ROLES.include?(value)
+    end
+
+    def self.from_value(value, default_value = MANAGER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'manager' then MANAGER
+      when 'other' then OTHER
+      when 'owner' then OWNER
+      when 'partner' then PARTNER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/card_networks.rb

@@ -0,0 +1,36 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Major [credit card network](#/rest/models/structures/card-network) types
+  class CardNetworks
+    CARD_NETWORKS = [
+      # TODO: Write general description for MASTER_CARD
+      MASTER_CARD = 'MASTER_CARD'.freeze,
+
+      # TODO: Write general description for VISA
+      VISA = 'VISA'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CARD_NETWORKS.include?(value)
+    end
+
+    def self.from_value(value, default_value = MASTER_CARD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'master_card' then MASTER_CARD
+      when 'visa' then VISA
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/card_processors.rb

@@ -0,0 +1,52 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # The processor type for the prepaid card
+  class CardProcessors
+    CARD_PROCESSORS = [
+      # TODO: Write general description for FIS
+      FIS = 'FIS'.freeze,
+
+      # TODO: Write general description for FLEX
+      FLEX = 'FLEX'.freeze,
+
+      # TODO: Write general description for EPS
+      EPS = 'EPS'.freeze,
+
+      # TODO: Write general description for TOKA
+      TOKA = 'TOKA'.freeze,
+
+      # TODO: Write general description for QOLO
+      QOLO = 'QOLO'.freeze,
+
+      # TODO: Write general description for UNDEFINED
+      UNDEFINED = 'UNDEFINED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CARD_PROCESSORS.include?(value)
+    end
+
+    def self.from_value(value, default_value = FIS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'fis' then FIS
+      when 'flex' then FLEX
+      when 'eps' then EPS
+      when 'toka' then TOKA
+      when 'qolo' then QOLO
+      when 'undefined' then UNDEFINED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/category_types.rb

@@ -0,0 +1,36 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Category types
+  class CategoryTypes
+    CATEGORY_TYPES = [
+      # TODO: Write general description for COMPANY
+      COMPANY = 'COMPANY'.freeze,
+
+      # TODO: Write general description for USER
+      USER = 'USER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CATEGORY_TYPES.include?(value)
+    end
+
+    def self.from_value(value, default_value = COMPANY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'company' then COMPANY
+      when 'user' then USER
+      else
+        default_value
+      end
+    end
+  end
+end