hamza-payments-query-sdk 1.0.0

data/lib/payments/exceptions/pq_querybypaymentid404_response_error_exception.rb

@@ -0,0 +1,51 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # pq_querybypaymentid_404_response_Error class.
+  class PqQuerybypaymentid404ResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error_name = hash.key?('errorName') ? hash['errorName'] : SKIP
+      @message = hash.key?('message') ? hash['message'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_name: #{@error_name}, message: #{@message}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_name: #{@error_name.inspect}, message: #{@message.inspect}>"
+    end
+  end
+end

data/lib/payments/exceptions/pq_queryhistoricalpayments400_response_exception.rb

@@ -0,0 +1,51 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # pq_queryhistoricalpayments_400_response class.
+  class PqQueryhistoricalpayments400ResponseException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of error.
+    # @return [String]
+    attr_accessor :error_name
+
+    # A description of the error
+    # @return [String]
+    attr_accessor :message
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error_name = hash.key?('errorName') ? hash['errorName'] : nil
+      @message = hash.key?('message') ? hash['message'] : nil
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_name: #{@error_name}, message: #{@message}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_name: #{@error_name.inspect}, message: #{@message.inspect}>"
+    end
+  end
+end

data/lib/payments/exceptions/validation_error_response_exception.rb

@@ -0,0 +1,58 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # ValidationErrorResponse class.
+  class ValidationErrorResponseException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :json_path
+
+    # The constructor.
+    # @param [String] reason The reason for raising an exception.
+    # @param [HttpResponse] response The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] hash The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      return nil unless hash
+
+      @error_name = hash.key?('errorName') ? hash['errorName'] : SKIP
+      @message = hash.key?('message') ? hash['message'] : SKIP
+      @json_path = hash.key?('jsonPath') ? hash['jsonPath'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_name: #{@error_name}, message: #{@message}, json_path:"\
+      " #{@json_path}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_name: #{@error_name.inspect}, message: #{@message.inspect},"\
+      " json_path: #{@json_path.inspect}>"
+    end
+  end
+end

data/lib/payments/http/auth/basic_auth.rb

@@ -0,0 +1,50 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Utility class for basic authorization.
+  class BasicAuth < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'BasicAuth: basic_auth_user_name or basic_auth_password is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(basic_auth_credentials)
+      auth_params = {}
+      unless basic_auth_credentials.nil? ||
+             basic_auth_credentials.username.nil? ||
+             basic_auth_credentials.password.nil?
+        auth_params['Authorization'] =
+          "Basic #{AuthHelper.get_base64_encoded_value(basic_auth_credentials.username,
+                                                       basic_auth_credentials.password)}"
+      end
+
+      super auth_params
+    end
+  end
+
+  # Data class for BasicAuthCredentials.
+  class BasicAuthCredentials
+    attr_reader :username, :password
+
+    def initialize(username:, password:)
+      raise ArgumentError, 'username cannot be nil' if username.nil?
+      raise ArgumentError, 'password cannot be nil' if password.nil?
+
+      @username = username
+      @password = password
+    end
+
+    def clone_with(username: nil, password: nil)
+      username ||= self.username
+      password ||= self.password
+
+      BasicAuthCredentials.new(username: username, password: password)
+    end
+  end
+end

data/lib/payments/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/payments/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/payments/http/http_request.rb

@@ -0,0 +1,10 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/payments/http/http_response.rb

@@ -0,0 +1,10 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/payments/http/proxy_settings.rb

@@ -0,0 +1,13 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+  end
+end

data/lib/payments/models/accept_enum.rb

@@ -0,0 +1,21 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Accept.
+  class AcceptEnum
+    ACCEPT_ENUM = [
+      # TODO: Write general description for
+      # ENUM_APPLICATIONVNDWORLDPAYPAYMENTQUERIESV1HALJSON
+      ENUM_APPLICATIONVNDWORLDPAYPAYMENTQUERIESV1HALJSON = 'application/vnd.worldpay.payment-queries-v1.hal+json'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCEPT_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/account_history.rb

@@ -0,0 +1,110 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Customer account history.
+  class AccountHistory < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Date the customer account was created.
+    # @return [String]
+    attr_accessor :created_at
+
+    # Date the customer account was last modified.
+    # @return [String]
+    attr_accessor :modified_at
+
+    # Date the password for the customer account was last modified.
+    # @return [String]
+    attr_accessor :password_modified_at
+
+    # Date the payment account was added to the cardholder account.
+    # @return [String]
+    attr_accessor :payment_account_enrolled_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['created_at'] = 'createdAt'
+      @_hash['modified_at'] = 'modifiedAt'
+      @_hash['password_modified_at'] = 'passwordModifiedAt'
+      @_hash['payment_account_enrolled_at'] = 'paymentAccountEnrolledAt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        created_at
+        modified_at
+        password_modified_at
+        payment_account_enrolled_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(created_at = SKIP, modified_at = SKIP,
+                   password_modified_at = SKIP,
+                   payment_account_enrolled_at = SKIP)
+      @created_at = created_at unless created_at == SKIP
+      @modified_at = modified_at unless modified_at == SKIP
+      @password_modified_at = password_modified_at unless password_modified_at == SKIP
+      unless payment_account_enrolled_at == SKIP
+        @payment_account_enrolled_at =
+          payment_account_enrolled_at
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      created_at = hash.key?('createdAt') ? hash['createdAt'] : SKIP
+      modified_at = hash.key?('modifiedAt') ? hash['modifiedAt'] : SKIP
+      password_modified_at =
+        hash.key?('passwordModifiedAt') ? hash['passwordModifiedAt'] : SKIP
+      payment_account_enrolled_at =
+        hash.key?('paymentAccountEnrolledAt') ? hash['paymentAccountEnrolledAt'] : SKIP
+
+      # Create object from extracted values.
+      AccountHistory.new(created_at,
+                         modified_at,
+                         password_modified_at,
+                         payment_account_enrolled_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AccountHistory | 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} created_at: #{@created_at}, modified_at: #{@modified_at},"\
+      " password_modified_at: #{@password_modified_at}, payment_account_enrolled_at:"\
+      " #{@payment_account_enrolled_at}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} created_at: #{@created_at.inspect}, modified_at: #{@modified_at.inspect},"\
+      " password_modified_at: #{@password_modified_at.inspect}, payment_account_enrolled_at:"\
+      " #{@payment_account_enrolled_at.inspect}>"
+    end
+  end
+end

data/lib/payments/models/account_updater_message1_enum.rb

@@ -0,0 +1,44 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Details on the type of payment instrument update.
+  class AccountUpdaterMessage1Enum
+    ACCOUNT_UPDATER_MESSAGE1_ENUM = [
+      # TODO: Write general description for
+      # ENUM_THE_MERCHANT_IS_NOT_REGISTERED_IN_THE_UPDATE_PROGRAM
+      ENUM_THE_MERCHANT_IS_NOT_REGISTERED_IN_THE_UPDATE_PROGRAM = 'The merchant is not registered in the update program'.freeze,
+
+      # TODO: Write general description for ENUM_THE_ACCOUNT_NUMBER_WAS_CHANGED
+      ENUM_THE_ACCOUNT_NUMBER_WAS_CHANGED = 'The account number was changed'.freeze,
+
+      # TODO: Write general description for ENUM_THE_ACCOUNT_WAS_CLOSED
+      ENUM_THE_ACCOUNT_WAS_CLOSED = 'The account was closed'.freeze,
+
+      # TODO: Write general description for ENUM_THE_EXPIRY_WAS_CHANGED
+      ENUM_THE_EXPIRY_WAS_CHANGED = 'The expiry was changed'.freeze,
+
+      # TODO: Write general description for
+      # ENUM_THE_ISSUING_BANK_DOES_NOT_PARTICIPATE_IN_THE_UPDATE_PROGRAM
+      ENUM_THE_ISSUING_BANK_DOES_NOT_PARTICIPATE_IN_THE_UPDATE_PROGRAM = 'The issuing bank does not participate in the update program'.freeze,
+
+      # TODO: Write general description for
+      # ENUM_CONTACT_THE_CARDHOLDER_FOR_UPDATED_INFORMATION
+      ENUM_CONTACT_THE_CARDHOLDER_FOR_UPDATED_INFORMATION = 'Contact the cardholder for updated information'.freeze,
+
+      # TODO: Write general description for ENUM_NO_MATCH_FOUND
+      ENUM_NO_MATCH_FOUND = 'No match found'.freeze,
+
+      # TODO: Write general description for ENUM_NO_CHANGES_FOUND
+      ENUM_NO_CHANGES_FOUND = 'No changes found'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCOUNT_UPDATER_MESSAGE1_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/account_updater_message_enum.rb

@@ -0,0 +1,41 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Details on the type of payment instrument update.
+  class AccountUpdaterMessageEnum
+    ACCOUNT_UPDATER_MESSAGE_ENUM = [
+      # TODO: Write general description for
+      # ENUM_THE_MERCHANT_IS_NOT_REGISTERED_IN_THE_UPDATE_PROGRAM
+      ENUM_THE_MERCHANT_IS_NOT_REGISTERED_IN_THE_UPDATE_PROGRAM = 'The merchant is not registered in the update program'.freeze,
+
+      # TODO: Write general description for ENUM_THE_ACCOUNT_NUMBER_WAS_CHANGED
+      ENUM_THE_ACCOUNT_NUMBER_WAS_CHANGED = 'The account number was changed'.freeze,
+
+      # TODO: Write general description for ENUM_THE_ACCOUNT_WAS_CLOSED
+      ENUM_THE_ACCOUNT_WAS_CLOSED = 'The account was closed'.freeze,
+
+      # TODO: Write general description for ENUM_THE_EXPIRY_WAS_CHANGED
+      ENUM_THE_EXPIRY_WAS_CHANGED = 'The expiry was changed'.freeze,
+
+      # TODO: Write general description for
+      # ENUM_THE_ISSUING_BANK_DOES_NOT_PARTICIPATE_IN_THE_UPDATE_PROGRAM
+      ENUM_THE_ISSUING_BANK_DOES_NOT_PARTICIPATE_IN_THE_UPDATE_PROGRAM = 'The issuing bank does not participate in the update program'.freeze,
+
+      # TODO: Write general description for
+      # ENUM_CONTACT_THE_CARDHOLDER_FOR_UPDATED_INFORMATION
+      ENUM_CONTACT_THE_CARDHOLDER_FOR_UPDATED_INFORMATION = 'Contact the cardholder for updated information'.freeze,
+
+      # TODO: Write general description for ENUM_NO_MATCH_FOUND
+      ENUM_NO_MATCH_FOUND = 'No match found'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ACCOUNT_UPDATER_MESSAGE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/advice.rb

@@ -0,0 +1,62 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Contains suggested next actions for this request.
+  class Advice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP)
+      @code = code unless code == 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+
+      # Create object from extracted values.
+      Advice.new(code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}>"
+    end
+  end
+end