payquicker-apimatic-sdk 1.0.0

data/lib/pay_quicker_sdk/models/portal_payment_quote.rb

@@ -0,0 +1,228 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module PayQuickerSdk
+  # Response from a invitation request
+  class PortalPaymentQuote < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Allocated money to be sent in the transaction.
+    # @return [Float]
+    attr_accessor :amount
+
+    # [Currency code type](#/rest/models/structures/country) for the object
+    # @return [Currencies]
+    attr_accessor :currency
+
+    # Unique identifier representing the [source of
+    # funds](#/rest/models/structures/source-token)
+    # @return [String]
+    attr_accessor :source_token
+
+    # [Program identifier](#/rest/models/structures/program-user-id) for the
+    # user
+    # @return [String]
+    attr_accessor :program_user_id
+
+    # Contact [email address](#/rest/models/structures/email-address) for the
+    # user account for the user account
+    # @return [String]
+    attr_accessor :email
+
+    # [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
+
+    # Used to identify the [purpose of a
+    # payment](#/models/structures/payment-object) and impacts reporting and
+    # calculated taxable earnings (if utilizing tax services)
+    # @return [PaymentPurposes]
+    attr_accessor :purpose
+
+    # Unique value provided by the client for the
+    # [payment](page:resources/payments), utilized for reference and
+    # deduplication.
+    # @return [String]
+    attr_accessor :client_payment_id
+
+    # 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
+
+    # [Transfer](#/rest/models/structures/not-before-or-after) is scheduled and
+    # will not process before this time.
+    # @return [DateTime]
+    attr_accessor :not_before
+
+    # [Transfer](#/rest/models/structures/not-before-or-after) expires if not
+    # completed prior to this time.
+    # @return [DateTime]
+    attr_accessor :not_after
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['source_token'] = 'sourceToken'
+      @_hash['program_user_id'] = 'programUserId'
+      @_hash['email'] = 'email'
+      @_hash['note'] = 'note'
+      @_hash['memo'] = 'memo'
+      @_hash['purpose'] = 'purpose'
+      @_hash['client_payment_id'] = 'clientPaymentId'
+      @_hash['auto_accept_quote'] = 'autoAcceptQuote'
+      @_hash['not_before'] = 'notBefore'
+      @_hash['not_after'] = 'notAfter'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        currency
+        source_token
+        program_user_id
+        email
+        note
+        memo
+        purpose
+        client_payment_id
+        auto_accept_quote
+        not_before
+        not_after
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = 1.02, currency = Currencies::USD,
+                   source_token = 'acct-3908ab5a-6ce1-474d-8b80-a63a7b147860',
+                   program_user_id = SKIP, email = SKIP, note = SKIP,
+                   memo = SKIP, purpose = SKIP,
+                   client_payment_id = 'd4b6f130-1d1c-4ce2-903a-0c1ad128f55e',
+                   auto_accept_quote = SKIP, not_before = SKIP,
+                   not_after = SKIP, additional_properties = {})
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @amount = amount unless amount == SKIP
+      @currency = currency unless currency == SKIP
+      @source_token = source_token unless source_token == SKIP
+      @program_user_id = program_user_id unless program_user_id == SKIP
+      @email = email unless email == SKIP
+      @note = note unless note == SKIP
+      @memo = memo unless memo == SKIP
+      @purpose = purpose unless purpose == SKIP
+      @client_payment_id = client_payment_id unless client_payment_id == SKIP
+      @auto_accept_quote = auto_accept_quote unless auto_accept_quote == SKIP
+      @not_before = not_before unless not_before == SKIP
+      @not_after = not_after unless not_after == 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.
+      amount = hash['amount'] ||= 1.02
+      currency = hash['currency'] ||= Currencies::USD
+      source_token =
+        hash['sourceToken'] ||= 'acct-3908ab5a-6ce1-474d-8b80-a63a7b147860'
+      program_user_id =
+        hash.key?('programUserId') ? hash['programUserId'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      note = hash.key?('note') ? hash['note'] : SKIP
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      purpose = hash.key?('purpose') ? hash['purpose'] : SKIP
+      client_payment_id =
+        hash['clientPaymentId'] ||= 'd4b6f130-1d1c-4ce2-903a-0c1ad128f55e'
+      auto_accept_quote =
+        hash.key?('autoAcceptQuote') ? hash['autoAcceptQuote'] : SKIP
+      not_before = if hash.key?('notBefore')
+                     (DateTimeHelper.from_rfc3339(hash['notBefore']) if hash['notBefore'])
+                   else
+                     SKIP
+                   end
+      not_after = if hash.key?('notAfter')
+                    (DateTimeHelper.from_rfc3339(hash['notAfter']) if hash['notAfter'])
+                  else
+                    SKIP
+                  end
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      PortalPaymentQuote.new(amount,
+                             currency,
+                             source_token,
+                             program_user_id,
+                             email,
+                             note,
+                             memo,
+                             purpose,
+                             client_payment_id,
+                             auto_accept_quote,
+                             not_before,
+                             not_after,
+                             additional_properties)
+    end
+
+    def to_custom_not_before
+      DateTimeHelper.to_rfc3339(not_before)
+    end
+
+    def to_custom_not_after
+      DateTimeHelper.to_rfc3339(not_after)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PortalPaymentQuote | 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} amount: #{@amount}, currency: #{@currency}, source_token: #{@source_token},"\
+      " program_user_id: #{@program_user_id}, email: #{@email}, note: #{@note}, memo: #{@memo},"\
+      " purpose: #{@purpose}, client_payment_id: #{@client_payment_id}, auto_accept_quote:"\
+      " #{@auto_accept_quote}, not_before: #{@not_before}, not_after: #{@not_after},"\
+      " 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} amount: #{@amount.inspect}, currency: #{@currency.inspect}, source_token:"\
+      " #{@source_token.inspect}, program_user_id: #{@program_user_id.inspect}, email:"\
+      " #{@email.inspect}, note: #{@note.inspect}, memo: #{@memo.inspect}, purpose:"\
+      " #{@purpose.inspect}, client_payment_id: #{@client_payment_id.inspect}, auto_accept_quote:"\
+      " #{@auto_accept_quote.inspect}, not_before: #{@not_before.inspect}, not_after:"\
+      " #{@not_after.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/portal_spendback_quote.rb

@@ -0,0 +1,177 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # TODO
+  class PortalSpendbackQuote < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Allocated money to be sent in the transaction.
+    # @return [Float]
+    attr_accessor :amount
+
+    # [Currency code type](#/rest/models/structures/country) for the object
+    # @return [Currencies]
+    attr_accessor :currency
+
+    # [Program identifier](#/rest/models/structures/program-user-id) for the
+    # user
+    # @return [String]
+    attr_accessor :program_user_id
+
+    # Contact [email address](#/rest/models/structures/email-address) for the
+    # user account for the user account
+    # @return [String]
+    attr_accessor :email
+
+    # Unique identifier representing the [destination of
+    # funds](#/rest/models/structures/destination-token)
+    # @return [String]
+    attr_accessor :destination_token
+
+    # Optional internal [memo](#/rest/models/structures/memo) not visible to the
+    # user
+    # @return [String]
+    attr_accessor :memo
+
+    # [Optional comments](#/rest/models/structures/notes) visible to the user
+    # @return [String]
+    attr_accessor :note
+
+    # [Unique value](#/rest/models/structures/client-transfer-id) provided by
+    # the client for the spendback
+    # @return [String]
+    attr_accessor :client_spendback_id
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['program_user_id'] = 'programUserId'
+      @_hash['email'] = 'email'
+      @_hash['destination_token'] = 'destinationToken'
+      @_hash['memo'] = 'memo'
+      @_hash['note'] = 'note'
+      @_hash['client_spendback_id'] = 'clientSpendbackId'
+      @_hash['auto_accept_quote'] = 'autoAcceptQuote'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        amount
+        currency
+        program_user_id
+        email
+        destination_token
+        memo
+        note
+        client_spendback_id
+        auto_accept_quote
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(
+      amount = 1.02, currency = Currencies::USD, program_user_id = SKIP,
+      email = SKIP,
+      destination_token = 'dest-631b200f-665d-4dbe-bd01-3063c9dec97d',
+      memo = SKIP, note = SKIP, client_spendback_id = SKIP,
+      auto_accept_quote = SKIP, additional_properties = {}
+    )
+      # Add additional model properties to the instance.
+      additional_properties.each do |_name, _value|
+        instance_variable_set("@#{_name}", _value)
+      end
+
+      @amount = amount unless amount == SKIP
+      @currency = currency unless currency == SKIP
+      @program_user_id = program_user_id unless program_user_id == SKIP
+      @email = email unless email == SKIP
+      @destination_token = destination_token unless destination_token == SKIP
+      @memo = memo unless memo == SKIP
+      @note = note unless note == SKIP
+      @client_spendback_id = client_spendback_id unless client_spendback_id == SKIP
+      @auto_accept_quote = auto_accept_quote unless auto_accept_quote == 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.
+      amount = hash['amount'] ||= 1.02
+      currency = hash['currency'] ||= Currencies::USD
+      program_user_id =
+        hash.key?('programUserId') ? hash['programUserId'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      destination_token =
+        hash['destinationToken'] ||= 'dest-631b200f-665d-4dbe-bd01-3063c9dec97d'
+      memo = hash.key?('memo') ? hash['memo'] : SKIP
+      note = hash.key?('note') ? hash['note'] : SKIP
+      client_spendback_id =
+        hash.key?('clientSpendbackId') ? hash['clientSpendbackId'] : SKIP
+      auto_accept_quote =
+        hash.key?('autoAcceptQuote') ? hash['autoAcceptQuote'] : SKIP
+
+      # Clean out expected properties from Hash.
+      additional_properties = hash.reject { |k, _| names.value?(k) }
+
+      # Create object from extracted values.
+      PortalSpendbackQuote.new(amount,
+                               currency,
+                               program_user_id,
+                               email,
+                               destination_token,
+                               memo,
+                               note,
+                               client_spendback_id,
+                               auto_accept_quote,
+                               additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PortalSpendbackQuote | 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} amount: #{@amount}, currency: #{@currency}, program_user_id:"\
+      " #{@program_user_id}, email: #{@email}, destination_token: #{@destination_token}, memo:"\
+      " #{@memo}, note: #{@note}, client_spendback_id: #{@client_spendback_id}, auto_accept_quote:"\
+      " #{@auto_accept_quote}, 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} amount: #{@amount.inspect}, currency: #{@currency.inspect},"\
+      " program_user_id: #{@program_user_id.inspect}, email: #{@email.inspect}, destination_token:"\
+      " #{@destination_token.inspect}, memo: #{@memo.inspect}, note: #{@note.inspect},"\
+      " client_spendback_id: #{@client_spendback_id.inspect}, auto_accept_quote:"\
+      " #{@auto_accept_quote.inspect}, additional_properties: #{get_additional_properties}>"
+    end
+  end
+end

data/lib/pay_quicker_sdk/models/portal_transfer_quote.rb

@@ -0,0 +1,204 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # Response from a invitation request
+  class PortalTransferQuote < 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
+
+    # [Program identifier](#/rest/models/structures/program-user-id) for the
+    # user
+    # @return [String]
+    attr_accessor :program_user_id
+
+    # Contact [email address](#/rest/models/structures/email-address) for the
+    # user account for the user account
+    # @return [String]
+    attr_accessor :email
+
+    # [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['program_user_id'] = 'programUserId'
+      @_hash['email'] = 'email'
+      @_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
+        program_user_id
+        email
+        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',
+                   program_user_id = SKIP, email = SKIP, 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
+      @program_user_id = program_user_id unless program_user_id == SKIP
+      @email = email unless email == 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'
+      program_user_id =
+        hash.key?('programUserId') ? hash['programUserId'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      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.
+      PortalTransferQuote.new(source_token,
+                              program_user_id,
+                              email,
+                              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 [PortalTransferQuote | 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}, program_user_id: #{@program_user_id},"\
+      " email: #{@email}, 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}, program_user_id:"\
+      " #{@program_user_id.inspect}, email: #{@email.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