wesley-key-sdk 3.0.7 → 4.0.0

data/lib/webhooks_and_callbacks_api/events/webhooks/webhooks_handler.rb

@@ -0,0 +1,67 @@
+# webhooks_and_callbacks_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module WebhooksAndCallbacksApi
+  # WebhooksHandler is responsible for verifying request signatures
+  # and parsing incoming webhooks events into strongly typed objects.
+  class WebhooksHandler
+    include CoreLibrary
+    # Creates a new instance of the WebhooksHandler.
+    # Initializes the handler.
+    # @param [String] secret_key
+    # The secret used to generate and validate HMAC signatures for verifying request authenticity.
+    # @raise [ArgumentError] If the secret_key is not provided.
+    def initialize(secret_key)
+      raise ArgumentError, 'secret_key must be provided for signature verification.' unless secret_key
+
+      @verifier = HmacSignatureVerifier.new(
+        secret_key: secret_key,
+        signature_header: 'X-Signature',
+        hash_algorithm: 'sha256',
+        encoder: HexEncoder.new
+      )
+    end
+
+    # Perform signature verification and return the result.
+    #
+    # @param [Rack::Request] request The incoming HTTP request to verify.
+    # @return [SignatureVerificationResult] The result of the signature verification.
+    def verify(request)
+      @verifier.verify(request)
+    end
+
+    # Verify the request signature and parse the event.
+    #
+    # @param [Rack::Request] request The incoming HTTP request containing the event payload.
+    # @return[OrderCreatedEvent, OrderUpdatedEvent, PaymentCompletedEvent,
+    # PrimitiveCollectionEvent, SignatureVerificationFailure, UnknownEvent]
+    # OrderCreatedEvent, OrderUpdatedEvent, PaymentCompletedEvent,
+    # PrimitiveCollectionEvent for successful parsing;
+    #
+    # SignatureVerificationFailure when signature fails;
+    # UnknownEvent for
+    # unknown events.
+    def verify_and_parse_event(request)
+      unless request.respond_to?(:env) && request.env.is_a?(Hash)
+        return SignatureVerificationFailure.new(['Invalid request env.'])
+      end
+
+      raw_body = RackRequestHelper.read_raw_body(request)
+      return SignatureVerificationFailure.new(['Invalid request body.']) if raw_body.nil? || raw_body.empty?
+
+      verification_result = verify(request)
+      return SignatureVerificationFailure.new(verification_result.errors) unless verification_result.ok
+
+      # Deserialize payload
+      begin
+        union = UnionTypeLookUp.get(:Webhooks)
+        raw = RackRequestHelper.read_raw_body(request)
+        APIHelper.deserialize_union_type(union, raw, false, true)
+      rescue StandardError => e
+        UnknownEvent.new(['Deserialization failed.', e.message])
+      end
+    end
+  end
+end

data/lib/webhooks_and_callbacks_api/events/webhooks/webhooks_no_verification_handler.rb

@@ -0,0 +1,39 @@
+# webhooks_and_callbacks_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module WebhooksAndCallbacksApi
+  # WebhooksNoVerificationHandler is responsible for verifying request signatures
+  # and parsing incoming webhooksNoVerification events into strongly typed objects.
+  class WebhooksNoVerificationHandler
+    include CoreLibrary
+    # Creates a new instance of the WebhooksNoVerificationHandler.
+    def initialize; end
+
+    # Parse the event.
+    #
+    # @param [Rack::Request] request The incoming HTTP request containing the event payload.
+    # @return[AuditLogEvent, RootLevelPrimitiveOneOfEventRequest, Integer,
+    # Array<RootLevelPrimitiveOneOfEventRequest1>, Array<Integer>, UnknownEvent]
+    # AuditLogEvent, RootLevelPrimitiveOneOfEventRequest, Integer,
+    # Array[RootLevelPrimitiveOneOfEventRequest1], Array[Integer] for successful
+    # parsing;
+    # UnknownEvent for unknown events.
+    def parse_event(request)
+      return UnknownEvent.new(['Invalid request env.']) unless request.respond_to?(:env) && request.env.is_a?(Hash)
+
+      raw_body = RackRequestHelper.read_raw_body(request)
+      return UnknownEvent.new(['Invalid request body.']) if raw_body.nil? || raw_body.empty?
+
+      # Deserialize payload
+      begin
+        union = UnionTypeLookUp.get(:WebhooksNoVerification)
+        raw = RackRequestHelper.read_raw_body(request)
+        APIHelper.deserialize_union_type(union, raw, false, true)
+      rescue StandardError => e
+        UnknownEvent.new(['Deserialization failed.', e.message])
+      end
+    end
+  end
+end

data/lib/{cypress_test_api → webhooks_and_callbacks_api}/exceptions/api_exception.rb

@@ -1,9 +1,9 @@
-# cypress_test_api
+# webhooks_and_callbacks_api
 #
-# This file was automatically generated by APIMATIC v3.0
-# ( https://www.apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
-module CypressTestApi
+module WebhooksAndCallbacksApi
   # 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.

data/lib/webhooks_and_callbacks_api/exceptions/error_exception.rb

@@ -0,0 +1,57 @@
+# webhooks_and_callbacks_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module WebhooksAndCallbacksApi
+  # Error class.
+  class ErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Error code
+    # @return [String]
+    attr_accessor :error
+
+    # Human-readable error message
+    # @return [String]
+    attr_accessor :message
+
+    # Additional error details
+    # @return [Object]
+    attr_accessor :details
+
+    # 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 = hash.key?('error') ? hash['error'] : nil
+      @message = hash.key?('message') ? hash['message'] : nil
+      @details = hash.key?('details') ? hash['details'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error}, message: #{@message}, details: #{@details}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error: #{@error.inspect}, message: #{@message.inspect}, details:"\
+      " #{@details.inspect}>"
+    end
+  end
+end

data/lib/webhooks_and_callbacks_api/http/api_response.rb

@@ -0,0 +1,19 @@
+# webhooks_and_callbacks_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module WebhooksAndCallbacksApi
+  # Http response received.
+  class ApiResponse < CoreLibrary::ApiResponse
+    # The constructor
+    # @param [HttpResponse] http_response The original, raw response from the api.
+    # @param [Object] data The data field specified for the response.
+    # @param [Array<String>] errors Any errors returned by the server.
+    def initialize(http_response,
+                   data: nil,
+                   errors: nil)
+      super
+    end
+  end
+end

data/lib/webhooks_and_callbacks_api/http/auth/api_key.rb

@@ -0,0 +1,52 @@
+# webhooks_and_callbacks_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module WebhooksAndCallbacksApi
+  # Utility class for custom header authorization.
+  class ApiKey < CoreLibrary::HeaderAuth
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'ApiKey: x_api_key is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(api_key_credentials)
+      auth_params = {}
+      auth_params['X-API-Key'] = api_key_credentials.x_api_key unless
+        api_key_credentials.nil? || api_key_credentials.x_api_key.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for ApiKeyCredentials.
+  # Data class for ApiKeyCredentials.
+  class ApiKeyCredentials
+    attr_reader :x_api_key
+
+    def initialize(x_api_key:)
+      raise ArgumentError, 'x_api_key cannot be nil' if x_api_key.nil?
+
+      @x_api_key = x_api_key
+    end
+
+    def self.from_env
+      x_api_key = ENV['API_KEY_X_API_KEY']
+      all_nil = [
+        x_api_key
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(x_api_key: x_api_key)
+    end
+
+    def clone_with(x_api_key: nil)
+      x_api_key ||= self.x_api_key
+
+      ApiKeyCredentials.new(x_api_key: x_api_key)
+    end
+  end
+end

data/lib/webhooks_and_callbacks_api/http/auth/bearer_auth.rb

@@ -0,0 +1,53 @@
+# webhooks_and_callbacks_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module WebhooksAndCallbacksApi
+  # Utility class for OAuth 2 authorization and token management.
+  class BearerAuth < CoreLibrary::HeaderAuth
+    include CoreLibrary
+    # Display error message on occurrence of authentication failure.
+    # @returns [String] The oAuth error message.
+    def error_message
+      'BearerAuth: access_token is undefined.'
+    end
+
+    # Initialization constructor.
+    def initialize(bearer_auth_credentials)
+      auth_params = {}
+      @_access_token = bearer_auth_credentials.access_token unless
+        bearer_auth_credentials.nil? || bearer_auth_credentials.access_token.nil?
+      auth_params[:Authorization] = "Bearer #{@_access_token}" unless @_access_token.nil?
+
+      super auth_params
+    end
+  end
+
+  # Data class for BearerAuthCredentials.
+  class BearerAuthCredentials
+    attr_reader :access_token
+
+    def initialize(access_token:)
+      raise ArgumentError, 'access_token cannot be nil' if access_token.nil?
+
+      @access_token = access_token
+    end
+
+    def self.from_env
+      access_token = ENV['BEARER_AUTH_ACCESS_TOKEN']
+      all_nil = [
+        access_token
+      ].all?(&:nil?)
+      return nil if all_nil
+
+      new(access_token: access_token)
+    end
+
+    def clone_with(access_token: nil)
+      access_token ||= self.access_token
+
+      BearerAuthCredentials.new(access_token: access_token)
+    end
+  end
+end

data/lib/webhooks_and_callbacks_api/http/http_call_back.rb

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

data/lib/webhooks_and_callbacks_api/http/http_method_enum.rb

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

data/lib/webhooks_and_callbacks_api/http/http_request.rb

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

data/lib/webhooks_and_callbacks_api/http/http_response.rb

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

data/lib/{cypress_test_api → webhooks_and_callbacks_api}/http/proxy_settings.rb

@@ -1,9 +1,9 @@
-# cypress_test_api
+# webhooks_and_callbacks_api
 #
-# This file was automatically generated by APIMATIC v3.0
-# ( https://www.apimatic.io ).
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
 
-module CypressTestApi
+module WebhooksAndCallbacksApi
   ##
   # ProxySettings encapsulates HTTP proxy configuration for Faraday,
   # including optional basic authentication.

data/lib/webhooks_and_callbacks_api/logging/configuration/api_logging_configuration.rb

@@ -0,0 +1,186 @@
+# webhooks_and_callbacks_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module WebhooksAndCallbacksApi
+  # Initializes a new instance of RequestLoggingConfiguration.
+  class RequestLoggingConfiguration < CoreLibrary::ApiRequestLoggingConfiguration
+    # @param log_body [Boolean] Indicates whether the message body should be logged. Default is false.
+    # @param log_headers [Boolean] Indicates whether the message headers should be logged. Default is false.
+    # @param headers_to_exclude [Array<String>] Array of headers not displayed in logging. Default is an empty array.
+    # @param headers_to_include [Array<String>] Array of headers to be displayed in logging. Default is an empty array.
+    # @param headers_to_unmask [Array<String>] Array of headers which values are non-sensitive to display in logging.
+    #   Default is an empty array.
+    def initialize(log_body: false, log_headers: false, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil,
+                   include_query_in_path: false)
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask,
+        include_query_in_path
+      )
+    end
+
+    def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil, include_query_in_path: nil)
+      log_body ||= self.log_body
+      log_headers ||= self.log_headers
+      headers_to_include ||= self.headers_to_include
+      headers_to_exclude ||= self.headers_to_exclude
+      headers_to_unmask ||= self.headers_to_unmask
+      include_query_in_path ||= self.include_query_in_path
+
+      RequestLoggingConfiguration.new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask,
+        include_query_in_path: include_query_in_path
+      )
+    end
+
+    def self.from_env
+      log_body = ENV['REQUEST_LOG_BODY']
+      log_headers = ENV['REQUEST_LOG_HEADERS']
+      headers_to_include = ENV['REQUEST_HEADERS_TO_INCLUDE']
+      headers_to_exclude = ENV['REQUEST_HEADERS_TO_EXCLUDE']
+      headers_to_unmask = ENV['REQUEST_HEADERS_TO_UNMASK']
+      include_query_in_path = ENV['REQUEST_INCLUDE_QUERY_IN_PATH']
+
+      new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask,
+        include_query_in_path: include_query_in_path
+      )
+    end
+
+    def self.any_logging_configured?
+      %w[
+        REQUEST_LOG_BODY
+        REQUEST_LOG_HEADERS
+        REQUEST_HEADERS_TO_INCLUDE
+        REQUEST_HEADERS_TO_EXCLUDE
+        REQUEST_HEADERS_TO_UNMASK
+        REQUEST_INCLUDE_QUERY_IN_PATH
+      ].any? { |key| ENV.key?(key) && !ENV[key].nil? && !ENV[key].empty? }
+    end
+  end
+
+  # Initializes a new instance of ResponseLoggingConfiguration.
+  class ResponseLoggingConfiguration < CoreLibrary::ApiResponseLoggingConfiguration
+    def initialize(log_body: false, log_headers: false, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil)
+      super(
+        log_body,
+        log_headers,
+        headers_to_exclude,
+        headers_to_include,
+        headers_to_unmask
+      )
+    end
+
+    def clone_with(log_body: nil, log_headers: nil, headers_to_include: nil,
+                   headers_to_exclude: nil, headers_to_unmask: nil)
+      log_body ||= self.log_body
+      log_headers ||= self.log_headers
+      headers_to_include ||= self.headers_to_include
+      headers_to_exclude ||= self.headers_to_exclude
+      headers_to_unmask ||= self.headers_to_unmask
+
+      ResponseLoggingConfiguration.new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask
+      )
+    end
+
+    def self.from_env
+      log_body = ENV['RESPONSE_LOG_BODY']
+      log_headers = ENV['RESPONSE_LOG_HEADERS']
+      headers_to_include = ENV['RESPONSE_HEADERS_TO_INCLUDE']
+      headers_to_exclude = ENV['RESPONSE_HEADERS_TO_EXCLUDE']
+      headers_to_unmask = ENV['RESPONSE_HEADERS_TO_UNMASK']
+
+      new(
+        log_body: log_body,
+        log_headers: log_headers,
+        headers_to_include: headers_to_include,
+        headers_to_exclude: headers_to_exclude,
+        headers_to_unmask: headers_to_unmask
+      )
+    end
+
+    def self.any_logging_configured?
+      %w[
+        RESPONSE_LOG_BODY
+        RESPONSE_LOG_HEADERS
+        RESPONSE_HEADERS_TO_INCLUDE
+        RESPONSE_HEADERS_TO_EXCLUDE
+        RESPONSE_HEADERS_TO_UNMASK
+      ].any? { |key| ENV.key?(key) && !ENV[key].nil? && !ENV[key].empty? }
+    end
+  end
+
+  # Initializes a new instance of LoggingConfiguration.
+  class LoggingConfiguration < CoreLibrary::ApiLoggingConfiguration
+    def initialize(logger: nil, log_level: nil, mask_sensitive_headers: true,
+                   request_logging_config: nil,
+                   response_logging_config: nil)
+      request_logging_config ||= RequestLoggingConfiguration.new
+      response_logging_config ||= ResponseLoggingConfiguration.new
+      super(
+        logger,
+        log_level,
+        request_logging_config,
+        response_logging_config,
+        mask_sensitive_headers
+      )
+    end
+
+    def clone_with(logger: nil, log_level: nil, mask_sensitive_headers: nil,
+                   request_logging_config: nil, response_logging_config: nil)
+      logger ||= self.logger
+      log_level ||= self.log_level
+      mask_sensitive_headers ||= self.mask_sensitive_headers
+      request_logging_config ||= self.request_logging_config.clone
+      response_logging_config ||= self.response_logging_config.clone
+
+      LoggingConfiguration.new(
+        logger: logger,
+        log_level: log_level,
+        mask_sensitive_headers: mask_sensitive_headers,
+        request_logging_config: request_logging_config,
+        response_logging_config: response_logging_config
+      )
+    end
+
+    def self.from_env
+      log_level = ENV['LOG_LEVEL']
+      mask_sensitive_headers = ENV['MASK_SENSITIVE_HEADERS']
+
+      new(
+        log_level: log_level,
+        mask_sensitive_headers: mask_sensitive_headers,
+        request_logging_config: RequestLoggingConfiguration.from_env,
+        response_logging_config: ResponseLoggingConfiguration.from_env
+      )
+    end
+
+    def self.any_logging_configured?
+      RequestLoggingConfiguration.any_logging_configured? ||
+        ResponseLoggingConfiguration.any_logging_configured? ||
+        ENV.key?('LOG_LEVEL') ||
+        ENV.key?('MASK_SENSITIVE_HEADERS')
+    end
+  end
+end

data/lib/webhooks_and_callbacks_api/logging/sdk_logger.rb

@@ -0,0 +1,17 @@
+# webhooks_and_callbacks_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module WebhooksAndCallbacksApi
+  # Represents the generic logger facade
+  class AbstractLogger < Logger
+    # Logs a message with a specified log level and additional parameters.
+    # @param level [Symbol] The log level of the message.
+    # @param message [String] The message to log.
+    # @param params [Hash] Additional parameters to include in the log message.
+    def log(level, message, params)
+      raise NotImplementedError, 'This method needs to be implemented in a child class.'
+    end
+  end
+end

data/lib/webhooks_and_callbacks_api/models/address.rb

@@ -0,0 +1,114 @@
+# webhooks_and_callbacks_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module WebhooksAndCallbacksApi
+  # Address Model.
+  class Address < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :street
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :city
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :zip
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['street'] = 'street'
+      @_hash['city'] = 'city'
+      @_hash['zip'] = 'zip'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        zip
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(street:, city:, zip: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @street = street
+      @city = city
+      @zip = zip unless zip == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      street = hash.key?('street') ? hash['street'] : nil
+      city = hash.key?('city') ? hash['city'] : nil
+      zip = hash.key?('zip') ? hash['zip'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Address.new(street: street,
+                  city: city,
+                  zip: zip,
+                  additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Address | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.street,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.city,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['street'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['city'],
+                                ->(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} street: #{@street}, city: #{@city}, zip: #{@zip}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} street: #{@street.inspect}, city: #{@city.inspect}, zip: #{@zip.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end