hamza-payments-query-sdk 1.0.0

data/lib/payments/models/value4.rb

@@ -0,0 +1,91 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object that contains payment amount and currency.
+  class Value4 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This is a whole number including the currency exponent (e.g. GBP has an
+    # exponent of 2, so for £2.50 supply:`250`).
+    # @return [Integer]
+    attr_accessor :amount
+
+    # The 3 digit currency code.
+    # @return [String]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, currency = nil)
+      @amount = amount
+      @currency = currency
+    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 = Number.from_hash(hash['amount']) if hash['amount']
+      currency = hash.key?('currency') ? hash['currency'] : nil
+
+      # Create object from extracted values.
+      Value4.new(amount,
+                 currency)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Value4 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.amount,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.currency,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['amount'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['currency'],
+                                ->(val) { val.instance_of? String })
+      )
+    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}>"
+    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}>"
+    end
+  end
+end

data/lib/payments/models/verification.rb

@@ -0,0 +1,173 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Details of the outcome of the 3DS authentication
+  class Verification < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # If the request was authenticated successfully or an authentication outage
+    # exemption was applied in authorization. See details on [Authentication
+    # Outage](/products/payments/enable-features/3ds-authentication#how-to-enabl
+    # e-authentication-outage-exemptions)
+    # @return [Outcome7Enum]
+    attr_accessor :outcome
+
+    # If the issuer decides to challenge the customer or proceed (frictionless)
+    # @return [IssuerResponseEnum]
+    attr_accessor :issuer_response
+
+    # The version of 3DS used to process the transaction.
+    # @return [String]
+    attr_accessor :version
+
+    # Electronic Commerce Indicator (ECI). Indicates the outcome of the 3DS
+    # authentication.
+    # | ECI | Meaning |
+    # | --- | --- |
+    # | 02 or 05 | Fully Authenticated Transaction
+    # | 01 or 06 | Attempted Authentication Transaction
+    # | 00 or 07 | Non 3-D Secure Transaction
+    # | Scheme | Value |
+    # | --- | --- |
+    # | Mastercard | 02, 01, 00 |
+    # | Visa | 05, 06, 07 |
+    # | Amex | 05, 06, 07 |
+    # | JCB | 05, 06, 07 |
+    # | Diners | 05, 06, 07 |
+    # @return [String]
+    attr_accessor :eci
+
+    # An identifier assigned by the Access Control Server (ACS) to identify a
+    # single transaction. Used primarily for Mastercard 3RI subsequent
+    # transactions to link the subsequent transaction back to a previous
+    # cardholder authentication. Can be disregarded unless otherwise needed.
+    # @return [String]
+    attr_accessor :acs_transaction_id
+
+    # Directory server transaction Id, if provided should be used in the payment
+    # authorization authentication object.
+    # @return [String]
+    attr_accessor :ds_transaction_id
+
+    # Indicates the outcome of the authentication or verification request.
+    # - `Y` - Successful authentication
+    # - `N` - Failed authentication
+    # - `U` - Unable to complete authentication
+    # - `A` - Successful attempts authentication
+    # - `C` - Challenged authentication
+    # - `R` - Authentication rejected (merchant _must not_ submit for
+    # authorization)
+    # - `I` - Exemption acknowledged
+    # @return [String]
+    attr_accessor :status
+
+    # Indicates the preferred challenge behavior. __Returned for Cartes
+    # Bancaires authentications only__ and must be applied in the following
+    # authorization request.
+    # - `noPreference`
+    # - `noChallengeRequested`
+    # - `challengeRequested`
+    # - `challengeMandated`
+    # - `noChallengeRequestedTRAPerformed`
+    # @return [String]
+    attr_accessor :challenge_preference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['outcome'] = 'outcome'
+      @_hash['issuer_response'] = 'issuerResponse'
+      @_hash['version'] = 'version'
+      @_hash['eci'] = 'eci'
+      @_hash['acs_transaction_id'] = 'acsTransactionId'
+      @_hash['ds_transaction_id'] = 'dsTransactionId'
+      @_hash['status'] = 'status'
+      @_hash['challenge_preference'] = 'challengePreference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        outcome
+        issuer_response
+        version
+        eci
+        acs_transaction_id
+        ds_transaction_id
+        status
+        challenge_preference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(outcome = Outcome7Enum::AUTHENTICATED,
+                   issuer_response = SKIP, version = SKIP, eci = SKIP,
+                   acs_transaction_id = SKIP, ds_transaction_id = SKIP,
+                   status = SKIP, challenge_preference = SKIP)
+      @outcome = outcome unless outcome == SKIP
+      @issuer_response = issuer_response unless issuer_response == SKIP
+      @version = version unless version == SKIP
+      @eci = eci unless eci == SKIP
+      @acs_transaction_id = acs_transaction_id unless acs_transaction_id == SKIP
+      @ds_transaction_id = ds_transaction_id unless ds_transaction_id == SKIP
+      @status = status unless status == SKIP
+      @challenge_preference = challenge_preference unless challenge_preference == 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.
+      outcome = hash['outcome'] ||= Outcome7Enum::AUTHENTICATED
+      issuer_response =
+        hash.key?('issuerResponse') ? hash['issuerResponse'] : SKIP
+      version = hash.key?('version') ? hash['version'] : SKIP
+      eci = hash.key?('eci') ? hash['eci'] : SKIP
+      acs_transaction_id =
+        hash.key?('acsTransactionId') ? hash['acsTransactionId'] : SKIP
+      ds_transaction_id =
+        hash.key?('dsTransactionId') ? hash['dsTransactionId'] : SKIP
+      status = hash.key?('status') ? hash['status'] : SKIP
+      challenge_preference =
+        hash.key?('challengePreference') ? hash['challengePreference'] : SKIP
+
+      # Create object from extracted values.
+      Verification.new(outcome,
+                       issuer_response,
+                       version,
+                       eci,
+                       acs_transaction_id,
+                       ds_transaction_id,
+                       status,
+                       challenge_preference)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} outcome: #{@outcome}, issuer_response: #{@issuer_response}, version:"\
+      " #{@version}, eci: #{@eci}, acs_transaction_id: #{@acs_transaction_id}, ds_transaction_id:"\
+      " #{@ds_transaction_id}, status: #{@status}, challenge_preference:"\
+      " #{@challenge_preference}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} outcome: #{@outcome.inspect}, issuer_response: #{@issuer_response.inspect},"\
+      " version: #{@version.inspect}, eci: #{@eci.inspect}, acs_transaction_id:"\
+      " #{@acs_transaction_id.inspect}, ds_transaction_id: #{@ds_transaction_id.inspect}, status:"\
+      " #{@status.inspect}, challenge_preference: #{@challenge_preference.inspect}>"
+    end
+  end
+end

data/lib/payments/models/wallet_payment_instrument.rb

@@ -0,0 +1,100 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # WalletPaymentInstrument Model.
+  class WalletPaymentInstrument < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of instrument.
+    # @return [String]
+    attr_reader :type
+
+    # The type of instrument.
+    # @return [String]
+    attr_accessor :wallet_token
+
+    # Contains the billing address information.
+    # @return [BillingAddress]
+    attr_accessor :billing_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['wallet_token'] = 'walletToken'
+      @_hash['billing_address'] = 'billingAddress'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        billing_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(wallet_token = nil, billing_address = SKIP)
+      @type = 'encrypted'
+      @wallet_token = wallet_token
+      @billing_address = billing_address unless billing_address == 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.
+      wallet_token = hash.key?('walletToken') ? hash['walletToken'] : nil
+      billing_address = BillingAddress.from_hash(hash['billingAddress']) if hash['billingAddress']
+
+      # Create object from extracted values.
+      WalletPaymentInstrument.new(wallet_token,
+                                  billing_address)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [WalletPaymentInstrument | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.wallet_token,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['walletToken'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, wallet_token: #{@wallet_token}, billing_address:"\
+      " #{@billing_address}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, wallet_token: #{@wallet_token.inspect},"\
+      " billing_address: #{@billing_address.inspect}>"
+    end
+  end
+end

data/lib/payments/models/window_size_enum.rb

@@ -0,0 +1,34 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Specify the challenge window size (width x height) that the issuer should
+  # use. This is to better tailor the experience to the customers device.
+  # Default is 390x400.
+  class WindowSizeEnum
+    WINDOW_SIZE_ENUM = [
+      # TODO: Write general description for ENUM_250X400
+      ENUM_250X400 = '250x400'.freeze,
+
+      # TODO: Write general description for ENUM_390X400
+      ENUM_390X400 = '390x400'.freeze,
+
+      # TODO: Write general description for ENUM_600X400
+      ENUM_600X400 = '600x400'.freeze,
+
+      # TODO: Write general description for ENUM_500X600
+      ENUM_500X600 = '500x600'.freeze,
+
+      # TODO: Write general description for FULLPAGE
+      FULLPAGE = 'fullPage'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WINDOW_SIZE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/wp_api_version_enum.rb

@@ -0,0 +1,20 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The API version
+  class WPApiVersionEnum
+    WP_API_VERSION_ENUM = [
+      # TODO: Write general description for ENUM_20240601
+      ENUM_20240601 = '2024-06-01'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      WP_API_VERSION_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require 'date'
+module Payments
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/payments/utilities/file_wrapper.rb

@@ -0,0 +1,28 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file}, content_type: #{@content_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def to_inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file.inspect}, content_type: #{@content_type.inspect}>"
+    end
+  end
+end

data/lib/payments/utilities/union_type_lookup.rb

@@ -0,0 +1,78 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The `UnionTypeLookUp` class serves as a utility class for
+  # storing and managing type combinator templates. It acts as a container for the templates
+  # used in handling various oneof/anyof instances within the sdk.
+  class UnionTypeLookUp
+    include CoreLibrary
+    # rubocop:disable Lint/RedundantCopDisableDirective, Style/HashSyntax, Layout/FirstArgumentIndentation
+    def self.union_types
+      {
+        :PaymentsInstructionPaymentInstrument => AnyOf.new(
+          [
+            LeafType.new(PaymentsCardPlainPaymentInstrument),
+            LeafType.new(SessionPaymentInstrument),
+            LeafType.new(TokenPaymentInstrument),
+            LeafType.new(WalletPaymentInstrument)
+          ]
+        ),
+
+        :PaymentsInstructionCustomerAgreement => AnyOf.new(
+          [
+            LeafType.new(PaymentsCardOnFileCustomerAgreement),
+            LeafType.new(PaymentsInstallmentCustomerAgreement),
+            LeafType.new(PaymentsSubscriptionCustomerAgreement),
+            LeafType.new(PaymentsUnscheduledCustomerAgreement)
+          ],
+          UnionTypeContext.new(
+            is_optional: true
+          )
+        ),
+
+        :PqQuerybypaymentid200ResponseEvents => OneOf.new(
+          [
+            LeafType.new(AuthorizationRequested),
+            LeafType.new(AuthorizationSucceeded),
+            LeafType.new(AuthorizationRefused),
+            LeafType.new(AuthorizationFailed),
+            LeafType.new(AuthorizationTimedOut),
+            LeafType.new(SaleRequested),
+            LeafType.new(SaleSucceeded),
+            LeafType.new(SaleRefused),
+            LeafType.new(SaleFailed),
+            LeafType.new(SaleTimedOut),
+            LeafType.new(SettlementRequested),
+            LeafType.new(SettlementRequestSubmitted),
+            LeafType.new(SettlementFailed),
+            LeafType.new(SettlementTimedOut),
+            LeafType.new(RefundRequested),
+            LeafType.new(RefundRequestSubmitted),
+            LeafType.new(RefundFailed),
+            LeafType.new(RefundTimedOut),
+            LeafType.new(CancellationRequested),
+            LeafType.new(CancellationRequestSubmitted),
+            LeafType.new(CancellationFailed),
+            LeafType.new(CancellationTimedOut),
+            LeafType.new(ReversalRequested),
+            LeafType.new(ReversalRequestSubmitted),
+            LeafType.new(ReversalFailed),
+            LeafType.new(ReversalTimedOut)
+          ],
+          UnionTypeContext.new(
+            is_array: true,
+            is_optional: true
+          )
+        )
+      }
+    end
+    # rubocop:enable Lint/RedundantCopDisableDirective, Style/HashSyntax, Layout/FirstArgumentIndentation
+
+    def self.get(name)
+      UnionTypeLookUp.union_types[name]
+    end
+  end
+end