hamza-payments-query-sdk 1.0.0

data/lib/payments/controllers/manage_payments_controller.rb

@@ -0,0 +1,272 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # ManagePaymentsController
+  class ManagePaymentsController < BaseController
+    # Query a payment. `linkData` refers to the pre-encoded segment of the URL
+    # that uniquely identifies a payment resource. It appears immediately after
+    # `/payments/` and continues until the next `/` or URL delimiter.
+    # @param [String] link_data Required parameter: TODO: type description
+    # here
+    # @param [WPApiVersionEnum] wp_api_version Required parameter: The API
+    # version
+    # @return [QueryEventsResponse] Response from the API call.
+    def query_events(link_data,
+                     wp_api_version)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/payments/{linkData}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(link_data, key: 'linkData')
+                                    .should_encode(true))
+                   .header_param(new_parameter(wp_api_version, key: 'WP-Api-Version'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(QueryEventsResponse.method(:from_hash))
+                    .local_error('400',
+                                 'Bad request',
+                                 ValidationErrorResponseException)
+                    .local_error('404',
+                                 'Not found',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Internal server error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    # Settle a payment. `linkData` refers to the pre-encoded segment of the URL
+    # that uniquely identifies a payment resource. It appears immediately after
+    # `/payments/` and continues until the next `/` or URL delimiter.
+    # @param [String] link_data Required parameter: TODO: type description
+    # here
+    # @param [WPApiVersionEnum] wp_api_version Required parameter: The API
+    # version
+    # @param [ContentTypeEnum] content_type Required parameter: Example:
+    # @return [SettleResponse] Response from the API call.
+    def settle(link_data,
+               wp_api_version,
+               content_type)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/payments/{linkData}/settlements',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(link_data, key: 'linkData')
+                                    .should_encode(true))
+                   .header_param(new_parameter(wp_api_version, key: 'WP-Api-Version'))
+                   .header_param(new_parameter(content_type, key: 'Content-Type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SettleResponse.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 ErrorResponseException)
+                    .local_error('404',
+                                 'Not found',
+                                 ErrorResponseException)
+                    .local_error('406',
+                                 'Not acceptable',
+                                 HeaderErrorResponseException)
+                    .local_error('415',
+                                 'Unsupported media type',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Internal server error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    # Partially settle a payment. `linkData` refers to the pre-encoded segment
+    # of the URL that uniquely identifies a payment resource. It appears
+    # immediately after `/payments/` and continues until the next `/` or URL
+    # delimiter.
+    # @param [String] link_data Required parameter: TODO: type description
+    # here
+    # @param [WPApiVersionEnum] wp_api_version Required parameter: The API
+    # version
+    # @param [PaymentsPartialSettleRequest] body Required parameter: TODO: type
+    # description here
+    # @return [PartialSettleResponse] Response from the API call.
+    def partial_settle(link_data,
+                       wp_api_version,
+                       body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/payments/{linkData}/partialSettlements',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(link_data, key: 'linkData')
+                                    .should_encode(true))
+                   .header_param(new_parameter(wp_api_version, key: 'WP-Api-Version'))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PartialSettleResponse.method(:from_hash))
+                    .local_error('400',
+                                 'Bad request',
+                                 ValidationErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 ErrorResponseException)
+                    .local_error('404',
+                                 'Not found',
+                                 ErrorResponseException)
+                    .local_error('406',
+                                 'Not acceptable',
+                                 HeaderErrorResponseException)
+                    .local_error('415',
+                                 'Unsupported media type',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Internal server error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    # Refund a payment. `linkData` refers to the pre-encoded segment of the URL
+    # that uniquely identifies a payment resource. It appears immediately after
+    # `/payments/` and continues until the next `/` or URL delimiter.
+    # @param [String] link_data Required parameter: TODO: type description
+    # here
+    # @param [WPApiVersionEnum] wp_api_version Required parameter: The API
+    # version
+    # @param [ContentTypeEnum] content_type Required parameter: Example:
+    # @return [RefundResponse] Response from the API call.
+    def refund(link_data,
+               wp_api_version,
+               content_type)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/payments/{linkData}/refunds',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(link_data, key: 'linkData')
+                                    .should_encode(true))
+                   .header_param(new_parameter(wp_api_version, key: 'WP-Api-Version'))
+                   .header_param(new_parameter(content_type, key: 'Content-Type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(RefundResponse.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 ErrorResponseException)
+                    .local_error('404',
+                                 'Not found',
+                                 ErrorResponseException)
+                    .local_error('406',
+                                 'Not acceptable',
+                                 HeaderErrorResponseException)
+                    .local_error('415',
+                                 'Unsupported media type',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Internal server error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    # Partially refund a payment. `linkData` refers to the pre-encoded segment
+    # of the URL that uniquely identifies a payment resource. It appears
+    # immediately after `/payments/` and continues until the next `/` or URL
+    # delimiter.
+    # @param [String] link_data Required parameter: TODO: type description
+    # here
+    # @param [WPApiVersionEnum] wp_api_version Required parameter: The API
+    # version
+    # @param [PaymentsPartialRefundRequest] body Required parameter: TODO: type
+    # description here
+    # @return [PartialRefundResponse] Response from the API call.
+    def partial_refund(link_data,
+                       wp_api_version,
+                       body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/payments/{linkData}/partialRefunds',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(link_data, key: 'linkData')
+                                    .should_encode(true))
+                   .header_param(new_parameter(wp_api_version, key: 'WP-Api-Version'))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PartialRefundResponse.method(:from_hash))
+                    .local_error('400',
+                                 'Bad request',
+                                 ValidationErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 ErrorResponseException)
+                    .local_error('404',
+                                 'Not found',
+                                 ErrorResponseException)
+                    .local_error('406',
+                                 'Not acceptable',
+                                 HeaderErrorResponseException)
+                    .local_error('415',
+                                 'Unsupported media type',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Internal server error',
+                                 ErrorResponseException))
+        .execute
+    end
+
+    # Cancel a payment. `linkData` refers to the pre-encoded segment of the URL
+    # that uniquely identifies a payment resource. It appears immediately after
+    # `/payments/` and continues until the next `/` or URL delimiter.
+    # @param [String] link_data Required parameter: TODO: type description
+    # here
+    # @param [WPApiVersionEnum] wp_api_version Required parameter: The API
+    # version
+    # @param [ContentTypeEnum] content_type Required parameter: Example:
+    # @return [CancelResponse] Response from the API call.
+    def cancel(link_data,
+               wp_api_version,
+               content_type)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/payments/{linkData}/cancellations',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(link_data, key: 'linkData')
+                                    .should_encode(true))
+                   .header_param(new_parameter(wp_api_version, key: 'WP-Api-Version'))
+                   .header_param(new_parameter(content_type, key: 'Content-Type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CancelResponse.method(:from_hash))
+                    .local_error('401',
+                                 'Unauthorized',
+                                 ErrorResponseException)
+                    .local_error('404',
+                                 'Not found',
+                                 ErrorResponseException)
+                    .local_error('406',
+                                 'Not acceptable',
+                                 HeaderErrorResponseException)
+                    .local_error('415',
+                                 'Unsupported media type',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Internal server error',
+                                 ErrorResponseException))
+        .execute
+    end
+  end
+end

data/lib/payments/controllers/payment_controller.rb

@@ -0,0 +1,51 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # PaymentController
+  class PaymentController < BaseController
+    # Initiate Payment. Take merchant entity as default if not provided
+    # @param [WPApiVersionEnum] wp_api_version Required parameter: The API
+    # version
+    # @param [PaymentRequest] body Required parameter: TODO: type description
+    # here
+    # @return [PaymentsResponse202] Response from the API call.
+    def payment(wp_api_version,
+                body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/payments',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(wp_api_version, key: 'WP-Api-Version'))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PaymentsResponse202.method(:from_hash))
+                    .local_error('400',
+                                 'Bad request',
+                                 ValidationErrorResponseException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 ErrorResponseException)
+                    .local_error('404',
+                                 'Not found',
+                                 ErrorResponseException)
+                    .local_error('406',
+                                 'Not acceptable',
+                                 HeaderErrorResponseException)
+                    .local_error('415',
+                                 'Unsupported media type',
+                                 ErrorResponseException)
+                    .local_error('500',
+                                 'Internal server error',
+                                 ErrorResponseException))
+        .execute
+    end
+  end
+end

data/lib/payments/controllers/payment_queries_controller.rb

@@ -0,0 +1,134 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # PaymentQueriesController
+  class PaymentQueriesController < BaseController
+    # Query payments within a specified date time range.
+    # These payments can be filtered by currency, minAmount, maxAmount,
+    # last4Digits & receivedEvents.
+    # The API returns data for payments processed after 25 June 2024. For
+    # payments processed before then use our [query for historical
+    # payments](/products/payment-queries/@v1/query-archive.md).
+    # @param [AcceptEnum] accept Required parameter: Example:
+    # @param [String] start_date Required parameter: An ISO 8601 date-time
+    # supplied as a string. Filters for payments that occurred after the
+    # specified date-time. Must be supplied alongside endDate.
+    # @param [String] end_date Required parameter: An ISO 8601 date-time
+    # supplied as a string. Filters for payments that occurred below the
+    # specified date-time. Must be supplied alongside startDate.
+    # @param [Integer] page_size Optional parameter: The maximum number of
+    # payments to be returned in the response (max 300).
+    # @param [String] currency Optional parameter: The three digit currency
+    # code.
+    # @param [Integer] min_amount Optional parameter: This is a whole number
+    # including the currency exponent (e.g. GBP has an exponent of 2, so for
+    # £2.50 supply:`250`).
+    # @param [Integer] max_amount Optional parameter: This is a whole number
+    # including the currency exponent (e.g. GBP has an exponent of 2, so for
+    # £2.50 supply:`250`).
+    # @param [String] last4_digits Optional parameter: The last four digits of
+    # the card number.
+    # @param [String] entity_references Optional parameter: Your entity
+    # reference(s).
+    # @param [String] received_events Optional parameter: Name of the event.
+    # @param [String] transaction_reference Optional parameter: A unique
+    # reference generated by you, used to identify a payment throughout its
+    # lifecycle. This shouldn't be used in conjunction with the above fields.
+    # Use it as a single parameter to query data.
+    # @return [PqQuerybydaterange200Response] Response from the API call.
+    def query_by_date_range(accept,
+                            start_date,
+                            end_date,
+                            page_size: nil,
+                            currency: nil,
+                            min_amount: nil,
+                            max_amount: nil,
+                            last4_digits: nil,
+                            entity_references: nil,
+                            received_events: nil,
+                            transaction_reference: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/paymentQueries/payments',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept, key: 'Accept'))
+                   .query_param(new_parameter(start_date, key: 'startDate'))
+                   .query_param(new_parameter(end_date, key: 'endDate'))
+                   .query_param(new_parameter(page_size, key: 'pageSize'))
+                   .query_param(new_parameter(currency, key: 'currency'))
+                   .query_param(new_parameter(min_amount, key: 'minAmount'))
+                   .query_param(new_parameter(max_amount, key: 'maxAmount'))
+                   .query_param(new_parameter(last4_digits, key: 'last4Digits'))
+                   .query_param(new_parameter(entity_references, key: 'entityReferences'))
+                   .query_param(new_parameter(received_events, key: 'receivedEvents'))
+                   .query_param(new_parameter(transaction_reference, key: 'transactionReference'))
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PqQuerybydaterange200Response.method(:from_hash))
+                    .local_error('400',
+                                 'Bad request',
+                                 PqQuerybydaterange400ResponseException))
+        .execute
+    end
+
+    # Retrieve a single payment by payment ID.
+    # The API returns detailed data for payments processed after 25 June 2024.
+    # For payments processed before then use our [query for historical
+    # payments](/products/payment-queries/@v1/query-archive.md).
+    # @param [String] accept Required parameter: TODO: type description here
+    # @param [String] payment_id Required parameter: Unique identifier generated
+    # for each payment. Historic `paymentId` values in UUID format.
+    # @return [PqQuerybypaymentid200Response] Response from the API call.
+    def retrieve_by_payment_id(accept,
+                               payment_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/paymentQueries/payments/{paymentId}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept, key: 'Accept'))
+                   .template_param(new_parameter(payment_id, key: 'paymentId')
+                                    .should_encode(true))
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PqQuerybypaymentid200Response.method(:from_hash))
+                    .local_error('404',
+                                 'The payment was not found.',
+                                 PqQuerybypaymentid404ResponseErrorException))
+        .execute
+    end
+
+    # Query payments processed before 25 June 2024.
+    # Provide a `transactionReference` and `entityReference` for a payment to
+    # find the matching payment in the archive.
+    # @param [String] accept Required parameter: TODO: type description here
+    # @param [String] transaction_reference Required parameter: A unique
+    # reference generated by you, used to identify a payment throughout its
+    # lifecycle.
+    # @param [String] entity_reference Required parameter: A merchant entity.
+    # @return [PqQueryhistoricalpayments200Response] Response from the API call.
+    def query_archived_payments(accept,
+                                transaction_reference,
+                                entity_reference)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/paymentQueries/archivedPayments',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept, key: 'Accept'))
+                   .query_param(new_parameter(transaction_reference, key: 'transactionReference'))
+                   .query_param(new_parameter(entity_reference, key: 'entityReference'))
+                   .auth(Single.new('BasicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PqQueryhistoricalpayments200Response.method(:from_hash))
+                    .local_error('400',
+                                 'Bad request',
+                                 PqQueryhistoricalpayments400ResponseException))
+        .execute
+    end
+  end
+end

data/lib/payments/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/payments/exceptions/error_response_exception.rb

@@ -0,0 +1,51 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # ErrorResponse class.
+  class ErrorResponseException < 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/header_error_response_exception.rb

@@ -0,0 +1,58 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # HeaderErrorResponse class.
+  class HeaderErrorResponseException < 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 :header_name
+
+    # 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
+      @header_name = hash.key?('headerName') ? hash['headerName'] : 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}, header_name:"\
+      " #{@header_name}>"
+    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},"\
+      " header_name: #{@header_name.inspect}>"
+    end
+  end
+end

data/lib/payments/exceptions/pq_querybydaterange400_response_exception.rb

@@ -0,0 +1,51 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # pq_querybydaterange_400_response class.
+  class PqQuerybydaterange400ResponseException < 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