pq-api-matic-sdk 1.0.0

data/lib/pay_quicker_sdk/models/transfer_statuses.rb

@@ -0,0 +1,76 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Current status of a [transfer](#/rest/models/structures/transfer)
+  class TransferStatuses
+    TRANSFER_STATUSES = [
+      # TODO: Write general description for ACCEPTED
+      ACCEPTED = 'ACCEPTED'.freeze,
+
+      # TODO: Write general description for CANCELLED
+      CANCELLED = 'CANCELLED'.freeze,
+
+      # TODO: Write general description for COMPLETED
+      COMPLETED = 'COMPLETED'.freeze,
+
+      # TODO: Write general description for EXPIRED
+      EXPIRED = 'EXPIRED'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'FAILED'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'PENDING'.freeze,
+
+      # TODO: Write general description for PENDING_ACCEPTANCE
+      PENDING_ACCEPTANCE = 'PENDING_ACCEPTANCE'.freeze,
+
+      # TODO: Write general description for QUOTED
+      QUOTED = 'QUOTED'.freeze,
+
+      # TODO: Write general description for RETURNED
+      RETURNED = 'RETURNED'.freeze,
+
+      # TODO: Write general description for SCHEDULED
+      SCHEDULED = 'SCHEDULED'.freeze,
+
+      # TODO: Write general description for VERIFICATION_HOLD
+      VERIFICATION_HOLD = 'VERIFICATION_HOLD'.freeze,
+
+      # TODO: Write general description for VOIDED
+      VOIDED = 'VOIDED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRANSFER_STATUSES.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACCEPTED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'accepted' then ACCEPTED
+      when 'cancelled' then CANCELLED
+      when 'completed' then COMPLETED
+      when 'expired' then EXPIRED
+      when 'failed' then FAILED
+      when 'pending' then PENDING
+      when 'pending_acceptance' then PENDING_ACCEPTANCE
+      when 'quoted' then QUOTED
+      when 'returned' then RETURNED
+      when 'scheduled' then SCHEDULED
+      when 'verification_hold' then VERIFICATION_HOLD
+      when 'voided' then VOIDED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/transfer_types.rb

@@ -0,0 +1,112 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # [Transfer type](#/rest/models/structures/transfer-type)
+  class TransferTypes
+    TRANSFER_TYPES = [
+      # TODO: Write general description for ACCOUNT_TO_ACCOUNT_TRANSFER
+      ACCOUNT_TO_ACCOUNT_TRANSFER = 'ACCOUNT_TO_ACCOUNT_TRANSFER'.freeze,
+
+      # TODO: Write general description for BANK_TRANSFER
+      BANK_TRANSFER = 'BANK_TRANSFER'.freeze,
+
+      # TODO: Write general description for BANK_TRANSFER_RETURN
+      BANK_TRANSFER_RETURN = 'BANK_TRANSFER_RETURN'.freeze,
+
+      # TODO: Write general description for BANK_TRANSFER_REVERSAL
+      BANK_TRANSFER_REVERSAL = 'BANK_TRANSFER_REVERSAL'.freeze,
+
+      # TODO: Write general description for CANCELLED_PAYMENT
+      CANCELLED_PAYMENT = 'CANCELLED_PAYMENT'.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 CASH_WITHDRAWAL
+      CASH_WITHDRAWAL = 'CASH_WITHDRAWAL'.freeze,
+
+      # TODO: Write general description for DEPOSIT
+      DEPOSIT = 'DEPOSIT'.freeze,
+
+      # TODO: Write general description for ESCHEATED_FUNDS_RETURN
+      ESCHEATED_FUNDS_RETURN = 'ESCHEATED_FUNDS_RETURN'.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 PAPER_CHECK
+      PAPER_CHECK = 'PAPER_CHECK'.freeze,
+
+      # TODO: Write general description for PAYMENT
+      PAYMENT = 'PAYMENT'.freeze,
+
+      # TODO: Write general description for PAYMENT_RETRACTION
+      PAYMENT_RETRACTION = 'PAYMENT_RETRACTION'.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 SPENDBACK
+      SPENDBACK = 'SPENDBACK'.freeze,
+
+      # TODO: Write general description for SPENDBACK_RETURN
+      SPENDBACK_RETURN = 'SPENDBACK_RETURN'.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?
+
+      TRANSFER_TYPES.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACCOUNT_TO_ACCOUNT_TRANSFER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'account_to_account_transfer' then ACCOUNT_TO_ACCOUNT_TRANSFER
+      when 'bank_transfer' then BANK_TRANSFER
+      when 'bank_transfer_return' then BANK_TRANSFER_RETURN
+      when 'bank_transfer_reversal' then BANK_TRANSFER_REVERSAL
+      when 'cancelled_payment' then CANCELLED_PAYMENT
+      when 'card_purchase' then CARD_PURCHASE
+      when 'card_purchase_refund' then CARD_PURCHASE_REFUND
+      when 'cash_withdrawal' then CASH_WITHDRAWAL
+      when 'deposit' then DEPOSIT
+      when 'escheated_funds_return' then ESCHEATED_FUNDS_RETURN
+      when 'fee' then FEE
+      when 'fee_refund' then FEE_REFUND
+      when 'paper_check' then PAPER_CHECK
+      when 'payment' then PAYMENT
+      when 'payment_retraction' then PAYMENT_RETRACTION
+      when 'prepaid_card_load' then PREPAID_CARD_LOAD
+      when 'prepaid_card_unload' then PREPAID_CARD_UNLOAD
+      when 'provisional_refund' then PROVISIONAL_REFUND
+      when 'spendback' then SPENDBACK
+      when 'spendback_return' then SPENDBACK_RETURN
+      when 'electronic_wallet_transfer' then ELECTRONIC_WALLET_TRANSFER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/translation.rb

@@ -0,0 +1,85 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # [Localized](#/rest/models/structures/key-value-pair-language-type-string)
+  # requirement description for display purposes
+  class Translation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The [Language](#/rest/models/structures/language) type in IETF's BCP 47
+    # format
+    # @return [Languages]
+    attr_accessor :language
+
+    # Translated string in the specified language
+    # @return [String]
+    attr_accessor :translation
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['language'] = 'language'
+      @_hash['translation'] = 'translation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        language
+        translation
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(language = SKIP, translation = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @language = language unless language == SKIP
+      @translation = translation unless translation == 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.
+      language = hash.key?('language') ? hash['language'] : SKIP
+      translation = hash.key?('translation') ? hash['translation'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      Translation.new(language,
+                      translation,
+                      additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} language: #{@language}, translation: #{@translation},"\
+      " 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} language: #{@language.inspect}, translation: #{@translation.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/uat_instance.rb

@@ -0,0 +1,48 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # uat_instance.
+  class UatInstance
+    UAT_INSTANCE = [
+      # TODO: Write general description for UAT1
+      UAT1 = 'uat1'.freeze,
+
+      # TODO: Write general description for UAT2
+      UAT2 = 'uat2'.freeze,
+
+      # TODO: Write general description for UAT3
+      UAT3 = 'uat3'.freeze,
+
+      # TODO: Write general description for UAT4
+      UAT4 = 'uat4'.freeze,
+
+      # TODO: Write general description for UAT5
+      UAT5 = 'uat5'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      UAT_INSTANCE.include?(value)
+    end
+
+    def self.from_value(value, default_value = UAT1)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'uat1' then UAT1
+      when 'uat2' then UAT2
+      when 'uat3' then UAT3
+      when 'uat4' then UAT4
+      when 'uat5' then UAT5
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/update_card_pin.rb

@@ -0,0 +1,87 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # UpdateCardPin Model.
+  class UpdateCardPin < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # [Token](#/rest/models/structures/prepaid-card-pin-token) used as part of a
+    # two-leg card PIN reveal request sent directly from the client that
+    # generally involves a second piece of data, such as the CVV code on the
+    # back of the card.
+    # @return [String]
+    attr_accessor :card_pin_token
+
+    # [Card PIN](#/rest/models/structures/prepaid-card-pin) for ATM and Debit
+    # usage
+    # @return [String]
+    attr_accessor :card_pin
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_pin_token'] = 'cardPinToken'
+      @_hash['card_pin'] = 'cardPin'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_pin_token
+        card_pin
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_pin_token = SKIP, card_pin = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @card_pin_token = card_pin_token unless card_pin_token == SKIP
+      @card_pin = card_pin unless card_pin == 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_pin_token = hash.key?('cardPinToken') ? hash['cardPinToken'] : SKIP
+      card_pin = hash.key?('cardPin') ? hash['cardPin'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      UpdateCardPin.new(card_pin_token,
+                        card_pin,
+                        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_pin_token: #{@card_pin_token}, card_pin: #{@card_pin},"\
+      " 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_pin_token: #{@card_pin_token.inspect}, card_pin: #{@card_pin.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/update_prepaid_card.rb

@@ -0,0 +1,85 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # UpdatePrepaidCard Model.
+  class UpdatePrepaidCard < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # [Package](#/rest/models/structures/prepaid-card-package) for the card
+    # being displayed, including artwork, packaging, and delivery method
+    # @return [String]
+    attr_accessor :card_package
+
+    # Current [status](#/rest/models/structures/prepaid-card-status) of the
+    # prepaid card
+    # @return [PrepaidCardStatuses]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_package'] = 'cardPackage'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_package
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_package = SKIP, status = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @card_package = card_package unless card_package == SKIP
+      @status = status unless status == 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_package = hash.key?('cardPackage') ? hash['cardPackage'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      UpdatePrepaidCard.new(card_package,
+                            status,
+                            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_package: #{@card_package}, status: #{@status}, 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_package: #{@card_package.inspect}, status: #{@status.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/upload_fields.rb

@@ -0,0 +1,40 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # __UploadFields.
+  class UploadFields
+    UPLOAD_FIELDS = [
+      # TODO: Write general description for EXPIRATION_DATE
+      EXPIRATION_DATE = 'EXPIRATION_DATE'.freeze,
+
+      # TODO: Write general description for STATUS
+      STATUS = 'STATUS'.freeze,
+
+      # TODO: Write general description for TYPE
+      TYPE = 'TYPE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      UPLOAD_FIELDS.include?(value)
+    end
+
+    def self.from_value(value, default_value = EXPIRATION_DATE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'expiration_date' then EXPIRATION_DATE
+      when 'status' then STATUS
+      when 'type' then TYPE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/user_action.rb

@@ -0,0 +1,40 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # _UserAction.
+  class UserAction
+    USER_ACTION = [
+      # TODO: Write general description for NO_ACTION
+      NO_ACTION = 'NO_ACTION'.freeze,
+
+      # TODO: Write general description for UPLOAD_DOCUMENTS
+      UPLOAD_DOCUMENTS = 'UPLOAD_DOCUMENTS'.freeze,
+
+      # TODO: Write general description for REVISE_DOCUMENTS
+      REVISE_DOCUMENTS = 'REVISE_DOCUMENTS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      USER_ACTION.include?(value)
+    end
+
+    def self.from_value(value, default_value = NO_ACTION)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'no_action' then NO_ACTION
+      when 'upload_documents' then UPLOAD_DOCUMENTS
+      when 'revise_documents' then REVISE_DOCUMENTS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/user_doc_req_item_docs_items_metadata_items.rb

@@ -0,0 +1,101 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # UserDocReqItemDocsItemsMetadataItems Model.
+  class UserDocReqItemDocsItemsMetadataItems < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :data_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :field_type
+
+    # TODO: Write general description for this method
+    # @return [Array[UserDocReqItemDocsItemsMetadataItemsNameItems]]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['data_type'] = 'dataType'
+      @_hash['field_type'] = 'fieldType'
+      @_hash['name'] = 'name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        data_type
+        field_type
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(data_type = SKIP, field_type = SKIP, name = SKIP,
+                   additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @data_type = data_type unless data_type == SKIP
+      @field_type = field_type unless field_type == SKIP
+      @name = name unless name == 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.
+      data_type = hash.key?('dataType') ? hash['dataType'] : SKIP
+      field_type = hash.key?('fieldType') ? hash['fieldType'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      name = nil
+      unless hash['name'].nil?
+        name = []
+        hash['name'].each do |structure|
+          name << (UserDocReqItemDocsItemsMetadataItemsNameItems.from_hash(structure) if structure)
+        end
+      end
+
+      name = SKIP unless hash.key?('name')
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      UserDocReqItemDocsItemsMetadataItems.new(data_type,
+                                               field_type,
+                                               name,
+                                               additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} data_type: #{@data_type}, field_type: #{@field_type}, name: #{@name},"\
+      " 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} data_type: #{@data_type.inspect}, field_type: #{@field_type.inspect}, name:"\
+      " #{@name.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end