pq-api-matic-sdk 1.0.0

data/lib/pay_quicker_sdk/models/prepaid_card_authorizations.rb

@@ -0,0 +1,129 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Financial types for the [prepaid card](page:resources/prepaid-cards)
+  # authorization.
+  class PrepaidCardAuthorizations
+    PREPAID_CARD_AUTHORIZATIONS = [
+      # TODO: Write general description for UNDEFINED
+      UNDEFINED = 'UNDEFINED'.freeze,
+
+      # TODO: Write general description for BANK_TRANSFER
+      BANK_TRANSFER = 'BANK_TRANSFER'.freeze,
+
+      # TODO: Write general description for PAPER_CHECK
+      PAPER_CHECK = 'PAPER_CHECK'.freeze,
+
+      # TODO: Write general description for DEPOSIT
+      DEPOSIT = 'DEPOSIT'.freeze,
+
+      # TODO: Write general description for CARD_PURCHASE
+      CARD_PURCHASE = 'CARD_PURCHASE'.freeze,
+
+      # TODO: Write general description for CARD_PURCHASE_REFUND
+      CARD_PURCHASE_REFUND = 'CARD_PURCHASE_REFUND'.freeze,
+
+      # TODO: Write general description for FEE
+      FEE = 'FEE'.freeze,
+
+      # TODO: Write general description for FEE_REFUND
+      FEE_REFUND = 'FEE_REFUND'.freeze,
+
+      # TODO: Write general description for PAYMENT
+      PAYMENT = 'PAYMENT'.freeze,
+
+      # TODO: Write general description for CANCELLED_PAYMENT
+      CANCELLED_PAYMENT = 'CANCELLED_PAYMENT'.freeze,
+
+      # TODO: Write general description for CASH_WITHDRAWAL
+      CASH_WITHDRAWAL = 'CASH_WITHDRAWAL'.freeze,
+
+      # TODO: Write general description for SPENDBACK
+      SPENDBACK = 'SPENDBACK'.freeze,
+
+      # TODO: Write general description for BANK_TRANSFER_REVERSAL
+      BANK_TRANSFER_REVERSAL = 'BANK_TRANSFER_REVERSAL'.freeze,
+
+      # TODO: Write general description for SPENDBACK_RETURN
+      SPENDBACK_RETURN = 'SPENDBACK_RETURN'.freeze,
+
+      # TODO: Write general description for BANK_TRANSFER_RETURN
+      BANK_TRANSFER_RETURN = 'BANK_TRANSFER_RETURN'.freeze,
+
+      # TODO: Write general description for PREPAID_CARD_LOAD
+      PREPAID_CARD_LOAD = 'PREPAID_CARD_LOAD'.freeze,
+
+      # TODO: Write general description for PREPAID_CARD_UNLOAD
+      PREPAID_CARD_UNLOAD = 'PREPAID_CARD_UNLOAD'.freeze,
+
+      # TODO: Write general description for PROVISIONAL_REFUND
+      PROVISIONAL_REFUND = 'PROVISIONAL_REFUND'.freeze,
+
+      # TODO: Write general description for PAYMENT_RETRACTION
+      PAYMENT_RETRACTION = 'PAYMENT_RETRACTION'.freeze,
+
+      # TODO: Write general description for ACCOUNT_TO_ACCOUNT_TRANSFER
+      ACCOUNT_TO_ACCOUNT_TRANSFER = 'ACCOUNT_TO_ACCOUNT_TRANSFER'.freeze,
+
+      # TODO: Write general description for ESCHEATED_FUNDS_RETURN
+      ESCHEATED_FUNDS_RETURN = 'ESCHEATED_FUNDS_RETURN'.freeze,
+
+      # TODO: Write general description for UNSETTLED_AUTHORIZATION
+      UNSETTLED_AUTHORIZATION = 'UNSETTLED_AUTHORIZATION'.freeze,
+
+      # TODO: Write general description for FEE_REBATE
+      FEE_REBATE = 'FEE_REBATE'.freeze,
+
+      # TODO: Write general description for EFT_FX_MARGIN
+      EFT_FX_MARGIN = 'EFT_FX_MARGIN'.freeze,
+
+      # TODO: Write general description for ELECTRONIC_WALLET_TRANSFER
+      ELECTRONIC_WALLET_TRANSFER = 'ELECTRONIC_WALLET_TRANSFER'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PREPAID_CARD_AUTHORIZATIONS.include?(value)
+    end
+
+    def self.from_value(value, default_value = UNDEFINED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'undefined' then UNDEFINED
+      when 'bank_transfer' then BANK_TRANSFER
+      when 'paper_check' then PAPER_CHECK
+      when 'deposit' then DEPOSIT
+      when 'card_purchase' then CARD_PURCHASE
+      when 'card_purchase_refund' then CARD_PURCHASE_REFUND
+      when 'fee' then FEE
+      when 'fee_refund' then FEE_REFUND
+      when 'payment' then PAYMENT
+      when 'cancelled_payment' then CANCELLED_PAYMENT
+      when 'cash_withdrawal' then CASH_WITHDRAWAL
+      when 'spendback' then SPENDBACK
+      when 'bank_transfer_reversal' then BANK_TRANSFER_REVERSAL
+      when 'spendback_return' then SPENDBACK_RETURN
+      when 'bank_transfer_return' then BANK_TRANSFER_RETURN
+      when 'prepaid_card_load' then PREPAID_CARD_LOAD
+      when 'prepaid_card_unload' then PREPAID_CARD_UNLOAD
+      when 'provisional_refund' then PROVISIONAL_REFUND
+      when 'payment_retraction' then PAYMENT_RETRACTION
+      when 'account_to_account_transfer' then ACCOUNT_TO_ACCOUNT_TRANSFER
+      when 'escheated_funds_return' then ESCHEATED_FUNDS_RETURN
+      when 'unsettled_authorization' then UNSETTLED_AUTHORIZATION
+      when 'fee_rebate' then FEE_REBATE
+      when 'eft_fx_margin' then EFT_FX_MARGIN
+      when 'electronic_wallet_transfer' then ELECTRONIC_WALLET_TRANSFER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/prepaid_card_capabilities.rb

@@ -0,0 +1,69 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Capabilities of a [prepaid card](page:resources/prepaid-cards).
+  class PrepaidCardCapabilities
+    PREPAID_CARD_CAPABILITIES = [
+      # The prepaid card supports ApplePay and can be added to an iOS device.
+      APPLEPAY = 'APPLEPAY'.freeze,
+
+      # The prepaid card supports banking details that allow for loads (i.e.,
+      # direct deposit).
+      BANK_IN = 'BANK_IN'.freeze,
+
+      # The prepaid card supports transfers to external bank accounts.
+      BANK_OUT = 'BANK_OUT'.freeze,
+
+      # The prepaid card supports Google Pay and can be added to a supported
+      # Android device.
+      GOOGLEPAY = 'GOOGLEPAY'.freeze,
+
+      # The prepaid card supports revealing the card details or rendered card
+      # image via the API.
+      REVEAL_CARD = 'REVEAL_CARD'.freeze,
+
+      # TO BE DONE
+      REVEAL_PIN = 'REVEAL_PIN'.freeze,
+
+      # The prepaid card supports Samsung Pay and can be added to a supported
+      # Samsung device.
+      SAMSUNGPAY = 'SAMSUNGPAY'.freeze,
+
+      # The prepaid card supports setting the PIN via the API.
+      SET_PIN = 'SET_PIN'.freeze,
+
+      # The prepaid card supports contactless transactions at supported
+      # terminals.
+      CONTACTLESS = 'CONTACTLESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PREPAID_CARD_CAPABILITIES.include?(value)
+    end
+
+    def self.from_value(value, default_value = APPLEPAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'applepay' then APPLEPAY
+      when 'bank_in' then BANK_IN
+      when 'bank_out' then BANK_OUT
+      when 'googlepay' then GOOGLEPAY
+      when 'reveal_card' then REVEAL_CARD
+      when 'reveal_pin' then REVEAL_PIN
+      when 'samsungpay' then SAMSUNGPAY
+      when 'set_pin' then SET_PIN
+      when 'contactless' then CONTACTLESS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/prepaid_card_data_object.rb

@@ -0,0 +1,136 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # PrepaidCardDataObject Model.
+  class PrepaidCardDataObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique number on the prepaid card
+    # @return [Float]
+    attr_accessor :card_number
+
+    # Three- or four-digit [Card Verification Value
+    # (CVV)](#/rest/models/structures/cvv) number displayed on the back of a
+    # credit or debit card
+    # @return [String]
+    attr_accessor :cvv_number
+
+    # Date that the card will expire
+    # @return [String]
+    attr_accessor :expiration
+
+    # Name of the card's owner
+    # @return [String]
+    attr_accessor :name_on_card
+
+    # A token used to reveal prepaid card information in the form of image data
+    # (base64) or JSON.
+    # @return [String]
+    attr_accessor :token
+
+    # A token used to reveal prepaid card information in the form of image data
+    # (base64) or JSON.
+    # @return [Array[HateoasSelfRef]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_number'] = 'cardNumber'
+      @_hash['cvv_number'] = 'cvvNumber'
+      @_hash['expiration'] = 'expiration'
+      @_hash['name_on_card'] = 'nameOnCard'
+      @_hash['token'] = 'token'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_number
+        cvv_number
+        expiration
+        name_on_card
+        token
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_number = SKIP, cvv_number = SKIP, expiration = SKIP,
+                   name_on_card = SKIP, token = SKIP, links = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @card_number = card_number unless card_number == SKIP
+      @cvv_number = cvv_number unless cvv_number == SKIP
+      @expiration = expiration unless expiration == SKIP
+      @name_on_card = name_on_card unless name_on_card == SKIP
+      @token = token unless token == SKIP
+      @links = links unless links == 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.
+      card_number = hash.key?('cardNumber') ? hash['cardNumber'] : SKIP
+      cvv_number = hash.key?('cvvNumber') ? hash['cvvNumber'] : SKIP
+      expiration = hash.key?('expiration') ? hash['expiration'] : SKIP
+      name_on_card = hash.key?('nameOnCard') ? hash['nameOnCard'] : SKIP
+      token = hash.key?('token') ? hash['token'] : 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')
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      PrepaidCardDataObject.new(card_number,
+                                cvv_number,
+                                expiration,
+                                name_on_card,
+                                token,
+                                links,
+                                additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card_number: #{@card_number}, cvv_number: #{@cvv_number}, expiration:"\
+      " #{@expiration}, name_on_card: #{@name_on_card}, token: #{@token}, links: #{@links},"\
+      " 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} card_number: #{@card_number.inspect}, cvv_number: #{@cvv_number.inspect},"\
+      " expiration: #{@expiration.inspect}, name_on_card: #{@name_on_card.inspect}, token:"\
+      " #{@token.inspect}, links: #{@links.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/prepaid_card_data_result.rb

@@ -0,0 +1,146 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # PrepaidCardDataResult Model.
+  class PrepaidCardDataResult < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique number on the prepaid card
+    # @return [Float]
+    attr_accessor :card_number
+
+    # Three- or four-digit [Card Verification Value
+    # (CVV)](#/rest/models/structures/cvv) number displayed on the back of a
+    # credit or debit card
+    # @return [String]
+    attr_accessor :cvv_number
+
+    # Date that the card will expire
+    # @return [String]
+    attr_accessor :expiration
+
+    # Name of the card's owner
+    # @return [String]
+    attr_accessor :name_on_card
+
+    # A token used to reveal prepaid card information in the form of image data
+    # (base64) or JSON.
+    # @return [String]
+    attr_accessor :token
+
+    # A token used to reveal prepaid card information in the form of image data
+    # (base64) or JSON.
+    # @return [Array[HateoasSelfRef]]
+    attr_accessor :links
+
+    # A token used to reveal prepaid card information in the form of image data
+    # (base64) or JSON.
+    # @return [MetadataItems]
+    attr_accessor :meta
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_number'] = 'cardNumber'
+      @_hash['cvv_number'] = 'cvvNumber'
+      @_hash['expiration'] = 'expiration'
+      @_hash['name_on_card'] = 'nameOnCard'
+      @_hash['token'] = 'token'
+      @_hash['links'] = 'links'
+      @_hash['meta'] = 'meta'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_number
+        cvv_number
+        expiration
+        name_on_card
+        token
+        links
+        meta
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_number = SKIP, cvv_number = SKIP, expiration = SKIP,
+                   name_on_card = SKIP, token = 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
+
+      @card_number = card_number unless card_number == SKIP
+      @cvv_number = cvv_number unless cvv_number == SKIP
+      @expiration = expiration unless expiration == SKIP
+      @name_on_card = name_on_card unless name_on_card == SKIP
+      @token = token unless token == 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.
+      card_number = hash.key?('cardNumber') ? hash['cardNumber'] : SKIP
+      cvv_number = hash.key?('cvvNumber') ? hash['cvvNumber'] : SKIP
+      expiration = hash.key?('expiration') ? hash['expiration'] : SKIP
+      name_on_card = hash.key?('nameOnCard') ? hash['nameOnCard'] : SKIP
+      token = hash.key?('token') ? hash['token'] : 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.
+      PrepaidCardDataResult.new(card_number,
+                                cvv_number,
+                                expiration,
+                                name_on_card,
+                                token,
+                                links,
+                                meta,
+                                additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card_number: #{@card_number}, cvv_number: #{@cvv_number}, expiration:"\
+      " #{@expiration}, name_on_card: #{@name_on_card}, token: #{@token}, 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} card_number: #{@card_number.inspect}, cvv_number: #{@cvv_number.inspect},"\
+      " expiration: #{@expiration.inspect}, name_on_card: #{@name_on_card.inspect}, token:"\
+      " #{@token.inspect}, links: #{@links.inspect}, meta: #{@meta.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/prepaid_card_data_token_object.rb

@@ -0,0 +1,134 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # PrepaidCardDataTokenObject Model.
+  class PrepaidCardDataTokenObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The processor type for the prepaid card
+    # @return [CardProcessors]
+    attr_accessor :card_processor_type
+
+    # Value of the target resource
+    # @return [String]
+    attr_accessor :resource_value
+
+    # [Token](#/rest/models/structures/token) representing the resource
+    # @return [String]
+    attr_accessor :token
+
+    # Purpose of the token
+    # @return [TokenPurposes]
+    attr_accessor :token_purpose_type
+
+    # Full path of the URI to perform the request action against a prepaid card
+    # that replaces the need to build the URL with query params.
+    # @return [String]
+    attr_accessor :url
+
+    # Full path of the URI to perform the request action against a prepaid card
+    # that replaces the need to build the URL with query params.
+    # @return [Array[HateoasSelfRef]]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_processor_type'] = 'cardProcessorType'
+      @_hash['resource_value'] = 'resourceValue'
+      @_hash['token'] = 'token'
+      @_hash['token_purpose_type'] = 'tokenPurposeType'
+      @_hash['url'] = 'url'
+      @_hash['links'] = 'links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        resource_value
+        token
+        url
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_processor_type = nil, token_purpose_type = nil,
+                   resource_value = SKIP, token = SKIP, url = SKIP,
+                   links = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @card_processor_type = card_processor_type
+      @resource_value = resource_value unless resource_value == SKIP
+      @token = token unless token == SKIP
+      @token_purpose_type = token_purpose_type
+      @url = url unless url == SKIP
+      @links = links unless links == 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.
+      card_processor_type =
+        hash.key?('cardProcessorType') ? hash['cardProcessorType'] : nil
+      token_purpose_type =
+        hash.key?('tokenPurposeType') ? hash['tokenPurposeType'] : nil
+      resource_value = hash.key?('resourceValue') ? hash['resourceValue'] : SKIP
+      token = hash.key?('token') ? hash['token'] : SKIP
+      url = hash.key?('url') ? hash['url'] : 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')
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      PrepaidCardDataTokenObject.new(card_processor_type,
+                                     token_purpose_type,
+                                     resource_value,
+                                     token,
+                                     url,
+                                     links,
+                                     additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card_processor_type: #{@card_processor_type}, resource_value:"\
+      " #{@resource_value}, token: #{@token}, token_purpose_type: #{@token_purpose_type}, url:"\
+      " #{@url}, links: #{@links}, 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} card_processor_type: #{@card_processor_type.inspect}, resource_value:"\
+      " #{@resource_value.inspect}, token: #{@token.inspect}, token_purpose_type:"\
+      " #{@token_purpose_type.inspect}, url: #{@url.inspect}, links: #{@links.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end