payquicker-apimatic-sdk 1.0.0

data/lib/pay_quicker_sdk/models/gateway_transfer_quote.rb

@@ -0,0 +1,195 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # TODO
+  class GatewayTransferQuote < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier representing the [source of
+    # funds](#/rest/models/structures/source-token)
+    # @return [String]
+    attr_accessor :source_token
+
+    # Unique identifier representing the [destination of
+    # funds](#/rest/models/structures/destination-token)
+    # @return [String]
+    attr_accessor :destination_token
+
+    # [Optional comments](#/rest/models/structures/notes) visible to the user
+    # @return [String]
+    attr_accessor :note
+
+    # Optional internal [memo](#/rest/models/structures/memo) not visible to the
+    # user
+    # @return [String]
+    attr_accessor :memo
+
+    # Determines whether the quote is [automatically
+    # accepted](#/rest/models/structures/auto-accept-quote) or if a `POST`
+    # utilizing the token for the quote is required.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto_accept_quote
+
+    # [Unique value](#/rest/models/structures/client-transfer-id) provided by
+    # the client for the transfer, utilized for reference and deduplication.
+    # @return [String]
+    attr_accessor :client_transfer_id
+
+    # Allocated money to be sent in the transaction.
+    # @return [Float]
+    attr_accessor :destination_amount
+
+    # [Currency code type](#/rest/models/structures/country) for the object
+    # @return [Currencies]
+    attr_accessor :destination_currency
+
+    # Type of
+    # [lockside](page:additional-api-information/transfer-lockside-types) for
+    # transfers.
+    # @return [LockSideTypes]
+    attr_accessor :transfer_lock_side
+
+    # Optional transfer methods applicable only to bank and e-wallet transfers.
+    # @return [TransferMethodTypes]
+    attr_accessor :transfer_method_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['source_token'] = 'sourceToken'
+      @_hash['destination_token'] = 'destinationToken'
+      @_hash['note'] = 'note'
+      @_hash['memo'] = 'memo'
+      @_hash['auto_accept_quote'] = 'autoAcceptQuote'
+      @_hash['client_transfer_id'] = 'clientTransferId'
+      @_hash['destination_amount'] = 'destinationAmount'
+      @_hash['destination_currency'] = 'destinationCurrency'
+      @_hash['transfer_lock_side'] = 'transferLockSide'
+      @_hash['transfer_method_type'] = 'transferMethodType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        source_token
+        destination_token
+        note
+        memo
+        auto_accept_quote
+        client_transfer_id
+        destination_amount
+        destination_currency
+        transfer_lock_side
+        transfer_method_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(
+      source_token = 'acct-3908ab5a-6ce1-474d-8b80-a63a7b147860',
+      destination_token = 'dest-631b200f-665d-4dbe-bd01-3063c9dec97d',
+      note = SKIP, memo = SKIP, auto_accept_quote = SKIP,
+      client_transfer_id = SKIP, destination_amount = SKIP,
+      destination_currency = Currencies::USD, transfer_lock_side = SKIP,
+      transfer_method_type = SKIP, additional_properties = {}
+    )
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @source_token = source_token unless source_token == SKIP
+      @destination_token = destination_token unless destination_token == SKIP
+      @note = note unless note == SKIP
+      @memo = memo unless memo == SKIP
+      @auto_accept_quote = auto_accept_quote unless auto_accept_quote == SKIP
+      @client_transfer_id = client_transfer_id unless client_transfer_id == SKIP
+      @destination_amount = destination_amount unless destination_amount == SKIP
+      @destination_currency = destination_currency unless destination_currency == SKIP
+      @transfer_lock_side = transfer_lock_side unless transfer_lock_side == SKIP
+      @transfer_method_type = transfer_method_type unless transfer_method_type == 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.
+      source_token =
+        hash['sourceToken'] ||= 'acct-3908ab5a-6ce1-474d-8b80-a63a7b147860'
+      destination_token =
+        hash['destinationToken'] ||= 'dest-631b200f-665d-4dbe-bd01-3063c9dec97d'
+      note = hash.key?('note') ? hash['note'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      auto_accept_quote =
+        hash.key?('autoAcceptQuote') ? hash['autoAcceptQuote'] : SKIP
+      client_transfer_id =
+        hash.key?('clientTransferId') ? hash['clientTransferId'] : SKIP
+      destination_amount =
+        hash.key?('destinationAmount') ? hash['destinationAmount'] : SKIP
+      destination_currency = hash['destinationCurrency'] ||= Currencies::USD
+      transfer_lock_side =
+        hash.key?('transferLockSide') ? hash['transferLockSide'] : SKIP
+      transfer_method_type =
+        hash.key?('transferMethodType') ? hash['transferMethodType'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      GatewayTransferQuote.new(source_token,
+                               destination_token,
+                               note,
+                               memo,
+                               auto_accept_quote,
+                               client_transfer_id,
+                               destination_amount,
+                               destination_currency,
+                               transfer_lock_side,
+                               transfer_method_type,
+                               additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [GatewayTransferQuote | 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} source_token: #{@source_token}, destination_token: #{@destination_token},"\
+      " note: #{@note}, memo: #{@memo}, auto_accept_quote: #{@auto_accept_quote},"\
+      " client_transfer_id: #{@client_transfer_id}, destination_amount: #{@destination_amount},"\
+      " destination_currency: #{@destination_currency}, transfer_lock_side:"\
+      " #{@transfer_lock_side}, transfer_method_type: #{@transfer_method_type},"\
+      " 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} source_token: #{@source_token.inspect}, destination_token:"\
+      " #{@destination_token.inspect}, note: #{@note.inspect}, memo: #{@memo.inspect},"\
+      " auto_accept_quote: #{@auto_accept_quote.inspect}, client_transfer_id:"\
+      " #{@client_transfer_id.inspect}, destination_amount: #{@destination_amount.inspect},"\
+      " destination_currency: #{@destination_currency.inspect}, transfer_lock_side:"\
+      " #{@transfer_lock_side.inspect}, transfer_method_type: #{@transfer_method_type.inspect},"\
+      " additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/genders.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
+  # [Gender](#/rest/models/structures/gender) as a user identifies
+  class Genders
+    GENDERS = [
+      # TODO: Write general description for FEMALE
+      FEMALE = 'FEMALE'.freeze,
+
+      # TODO: Write general description for MALE
+      MALE = 'MALE'.freeze,
+
+      # TODO: Write general description for NOT_SPECIFIED
+      NOT_SPECIFIED = 'NOT_SPECIFIED'.freeze,
+
+      # TODO: Write general description for UNDEFINED
+      UNDEFINED = 'UNDEFINED'.freeze,
+
+      # TODO: Write general description for GENDER_NEUTRAL
+      GENDER_NEUTRAL = 'GENDER_NEUTRAL'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      GENDERS.include?(value)
+    end
+
+    def self.from_value(value, default_value = FEMALE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'female' then FEMALE
+      when 'male' then MALE
+      when 'not_specified' then NOT_SPECIFIED
+      when 'undefined' then UNDEFINED
+      when 'gender_neutral' then GENDER_NEUTRAL
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/government_ids.rb

@@ -0,0 +1,45 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Indicates the type of ID submitted for user verification purposes.
+  class GovernmentIds
+    GOVERNMENT_IDS = [
+      # Identity code for both citizens and residents of Mexico.
+      CURP = 'CURP'.freeze,
+
+      # Identity card with a photo issued by an official authority.
+      NATIONAL_ID_CARD = 'NATIONAL_ID_CARD'.freeze,
+
+      # Travel document that certifies the identity and nationality of its
+      # holder.
+      PASSPORT = 'PASSPORT'.freeze,
+
+      # Social Security number for citizens of the United States.
+      SSN = 'SSN'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      GOVERNMENT_IDS.include?(value)
+    end
+
+    def self.from_value(value, default_value = CURP)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'curp' then CURP
+      when 'national_id_card' then NATIONAL_ID_CARD
+      when 'passport' then PASSPORT
+      when 'ssn' then SSN
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/hateoas_relationship.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
+  # Indicates the HATEOS relationship between the target and current resources.
+  class HateoasRelationship < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates the relationship between the target and current resources.
+    # @return [String]
+    attr_accessor :rel
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['rel'] = 'rel'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(rel = 'self', additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @rel = rel
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      rel = hash['rel'] ||= 'self'
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      HateoasRelationship.new(rel,
+                              additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} rel: #{@rel}, 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} rel: #{@rel.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/hateoas_self_ref.rb

@@ -0,0 +1,84 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Indicates the external link with the full URL of the same page on which the
+  # link appears.
+  class HateoasSelfRef < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :href
+
+    # Indicates the HATEOS relationship between the target and current
+    # resources.
+    # @return [HateoasRelationship]
+    attr_accessor :params
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['params'] = 'params'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        href
+        params
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href = SKIP, params = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @href = href unless href == SKIP
+      @params = params unless params == 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.
+      href = hash.key?('href') ? hash['href'] : SKIP
+      params = HateoasRelationship.from_hash(hash['params']) if hash['params']
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      HateoasSelfRef.new(href,
+                         params,
+                         additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href}, params: #{@params}, 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} href: #{@href.inspect}, params: #{@params.inspect}, additional_properties:"\
+      " #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/identity_verification_providers.rb

@@ -0,0 +1,62 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Provider types of
+  # [verification](#/rest/models/structures/identity-verification-provider-type)
+  # that can be used for performing identity checks
+  class IdentityVerificationProviders
+    IDENTITY_VERIFICATION_PROVIDERS = [
+      # TODO: Write general description for EQUIFAX
+      EQUIFAX = 'EQUIFAX'.freeze,
+
+      # TODO: Write general description for W2
+      W2 = 'W2'.freeze,
+
+      # TODO: Write general description for FISIDOLOGY
+      FISIDOLOGY = 'FISIDOLOGY'.freeze,
+
+      # TODO: Write general description for OFACANALYZER
+      OFACANALYZER = 'OFACANALYZER'.freeze,
+
+      # TODO: Write general description for UNDEFINED
+      UNDEFINED = 'UNDEFINED'.freeze,
+
+      # TODO: Write general description for HOOYU
+      HOOYU = 'HOOYU'.freeze,
+
+      # TODO: Write general description for LEXISNEXISIVI
+      LEXISNEXISIVI = 'LEXISNEXISIVI'.freeze,
+
+      # TODO: Write general description for QOLO
+      QOLO = 'QOLO'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      IDENTITY_VERIFICATION_PROVIDERS.include?(value)
+    end
+
+    def self.from_value(value, default_value = EQUIFAX)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'equifax' then EQUIFAX
+      when 'w2' then W2
+      when 'fisidology' then FISIDOLOGY
+      when 'ofacanalyzer' then OFACANALYZER
+      when 'undefined' then UNDEFINED
+      when 'hooyu' then HOOYU
+      when 'lexisnexisivi' then LEXISNEXISIVI
+      when 'qolo' then QOLO
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/identity_verification_result_sub_types.rb

@@ -0,0 +1,38 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Sub result type of
+  # [verification](#/rest/models/structures/identity-verification-sub-result-typ
+  # e)
+  class IdentityVerificationResultSubTypes
+    IDENTITY_VERIFICATION_RESULT_SUB_TYPES = [
+      # TODO: Write general description for HARD
+      HARD = 'HARD'.freeze,
+
+      # TODO: Write general description for SOFT
+      SOFT = 'SOFT'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      IDENTITY_VERIFICATION_RESULT_SUB_TYPES.include?(value)
+    end
+
+    def self.from_value(value, default_value = HARD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'hard' then HARD
+      when 'soft' then SOFT
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/identity_verification_result_types.rb

@@ -0,0 +1,57 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Result type of
+  # [verification](#/rest/models/structures/identity-verification-result-type)
+  class IdentityVerificationResultTypes
+    IDENTITY_VERIFICATION_RESULT_TYPES = [
+      # TODO: Write general description for PASS
+      PASS = 'PASS'.freeze,
+
+      # TODO: Write general description for SERVICE_OFFLINE
+      SERVICE_OFFLINE = 'SERVICE_OFFLINE'.freeze,
+
+      # TODO: Write general description for FAIL
+      FAIL = 'FAIL'.freeze,
+
+      # TODO: Write general description for PROCESSING
+      PROCESSING = 'PROCESSING'.freeze,
+
+      # TODO: Write general description for UNDEFINED
+      UNDEFINED = 'UNDEFINED'.freeze,
+
+      # TODO: Write general description for NOTYETEXECUTED
+      NOTYETEXECUTED = 'NOTYETEXECUTED'.freeze,
+
+      # TODO: Write general description for EXPIRED
+      EXPIRED = 'EXPIRED'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      IDENTITY_VERIFICATION_RESULT_TYPES.include?(value)
+    end
+
+    def self.from_value(value, default_value = PASS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pass' then PASS
+      when 'service_offline' then SERVICE_OFFLINE
+      when 'fail' then FAIL
+      when 'processing' then PROCESSING
+      when 'undefined' then UNDEFINED
+      when 'notyetexecuted' then NOTYETEXECUTED
+      when 'expired' then EXPIRED
+      else
+        default_value
+      end
+    end
+  end
+end