apimatic-pnl-sdk 1.0.0

data/lib/postnl_ecommerce/controllers/postalcode_check_controller.rb

@@ -0,0 +1,60 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # PostalcodeCheckController
+  class PostalcodeCheckController < BaseController
+    # Please note that this API is not available on the sandbox environment.
+    # Request example:
+    # ```
+    # curl -X GET
+    # "https://api.postnl.nl/shipment/checkout/v1/postalcodecheck?postalcode=357
+    # 1ZZ&amp;housenumber=74&amp;housenumberaddition=bis" \
+    #  -H "Accept: application/json" \
+    #  -H "apikey: APIKEY-HERE"
+    # ```
+    # @param [String] postalcode Required parameter: TODO: type description
+    # here
+    # @param [String] housenumber Required parameter: TODO: type description
+    # here
+    # @param [String] housenumberaddition Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def checkout_postalcode_check(postalcode,
+                                  housenumber,
+                                  housenumberaddition: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/shipment/checkout/v1/postalcodecheck',
+                                     Server::POSTNL)
+                   .query_param(new_parameter(postalcode, key: 'postalcode'))
+                   .query_param(new_parameter(housenumber, key: 'housenumber'))
+                   .query_param(new_parameter(housenumberaddition, key: 'housenumberaddition'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyHeader')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(PostalcodeCheckAddress.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Bad request',
+                                 PostalcodeCheckResponseInvalidException)
+                    .local_error('401',
+                                 'Invalid apikey',
+                                 UnauthorizedException)
+                    .local_error('405',
+                                 'Method not allowed',
+                                 MethodNotAllowedOnlyGetException)
+                    .local_error('429',
+                                 'Too many requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal server error',
+                                 InternalServerErrorException))
+        .execute
+    end
+  end
+end

data/lib/postnl_ecommerce/controllers/shipment_controller.rb

@@ -0,0 +1,52 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # ShipmentController
+  class ShipmentController < BaseController
+    # TODO: type endpoint description here
+    # @param [LabellingRequest] body Required parameter: TODO: type description
+    # here
+    # @param [TrueClass | FalseClass] confirm Optional parameter: With the
+    # Confirm boolean in the request, you can determine if you want to confirm
+    # the shipment in the same call or not. If the Boolean variable is true the
+    # shipment will be preannounced. If this is set to false, then an additional
+    # Confirming API request needs to be made.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def generate_shipment_label(body,
+                                confirm: true)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/shipment/v2_2/label',
+                                     Server::POSTNL)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .query_param(new_parameter(confirm, key: 'confirm'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('APIKeyHeader')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LabellingResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Error payload',
+                                 LabellingResponseInvalidException)
+                    .local_error('401',
+                                 'Invalid apikey',
+                                 UnauthorizedException)
+                    .local_error('405',
+                                 'Method not allowed',
+                                 MethodNotAllowedOnlyPostException)
+                    .local_error('429',
+                                 'Too many requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal server error',
+                                 InternalServerErrorException))
+        .execute
+    end
+  end
+end

data/lib/postnl_ecommerce/controllers/shipping_status_controller.rb

@@ -0,0 +1,222 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # ShippingStatusController
+  class ShippingStatusController < BaseController
+    # Request example:
+    # ```
+    # curl -X GET
+    # "https://api-sandbox.postnl.nl/shipment/v2/status/barcode/3SDEVC172649258"
+    # \
+    #  -H "Accept: application/json" \
+    #  -H "apikey: APIKEY-HERE" \
+    # ```
+    # @param [String] barcode Required parameter: Barcode of the shipment. This
+    # is a unique value.
+    # @param [TrueClass | FalseClass] detail Optional parameter: Option to
+    # include old statuses in the response
+    # @param [LanguageEnum] language Optional parameter: Language of the
+    # returned shipment and status descriptions (default is Dutch).
+    # @param [String] max_days Optional parameter: Limit the number of days that
+    # will be searched (decrease this amount for better performance).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_status_by_barcode(barcode,
+                              detail: false,
+                              language: nil,
+                              max_days: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/shipment/v2/status/barcode/{barcode}',
+                                     Server::POSTNL)
+                   .template_param(new_parameter(barcode, key: 'barcode')
+                                    .should_encode(true))
+                   .query_param(new_parameter(detail, key: 'detail'))
+                   .query_param(new_parameter(language, key: 'language'))
+                   .query_param(new_parameter(max_days, key: 'maxDays'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyHeader')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ShippingstatusResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request',
+                                 InternalServerErrorException)
+                    .local_error('401',
+                                 'Invalid apikey',
+                                 UnauthorizedException)
+                    .local_error('405',
+                                 'Method not allowed',
+                                 MethodNotAllowedOnlyGetException)
+                    .local_error('429',
+                                 'Too many requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal server error',
+                                 InternalServerErrorException))
+        .execute
+    end
+
+    # Request example:
+    # ```
+    # curl -X GET
+    # "https://api-sandbox.postnl.nl/shipment/v2/status/reference?detail=true&la
+    # nguage=NL&customerCode={{CustomerCode}}&customerNumber={{CustomerNumber}}&
+    # reference=REF98173245876329" \
+    #  -H "Accept: application/json" \
+    #  -H "apikey: APIKEY-HERE"
+    # ```
+    # @param [String] customer_code Required parameter: Customer code as known
+    # at PostNL Pakketten
+    # @param [String] customer_number Required parameter: Customer number as
+    # known at PostNL Pakketten
+    # @param [String] reference_id Required parameter: The customer reference
+    # belonging to the shipment
+    # @param [TrueClass | FalseClass] detail Optional parameter: Option to
+    # include old statuses in the response
+    # @param [LanguageEnum] language Optional parameter: Language of the
+    # returned shipment and status descriptions (default is Dutch).
+    # @param [String] max_days Optional parameter: Limit the number of days that
+    # will be searched (decrease this amount for better performance). By default
+    # this is 90 days in the past.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_status_by_reference(customer_code,
+                                customer_number,
+                                reference_id,
+                                detail: false,
+                                language: nil,
+                                max_days: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/shipment/v2/status/reference/{referenceId}',
+                                     Server::POSTNL)
+                   .query_param(new_parameter(customer_code, key: 'customerCode'))
+                   .query_param(new_parameter(customer_number, key: 'customerNumber'))
+                   .template_param(new_parameter(reference_id, key: 'referenceId')
+                                    .should_encode(true))
+                   .query_param(new_parameter(detail, key: 'detail'))
+                   .query_param(new_parameter(language, key: 'language'))
+                   .query_param(new_parameter(max_days, key: 'maxDays'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyHeader')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ShippingstatusResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request',
+                                 InternalServerErrorException)
+                    .local_error('401',
+                                 'Invalid apikey',
+                                 UnauthorizedException)
+                    .local_error('405',
+                                 'Method not allowed',
+                                 MethodNotAllowedOnlyGetException)
+                    .local_error('429',
+                                 'Too many requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal server error',
+                                 InternalServerErrorException))
+        .execute
+    end
+
+    # Request example:
+    # ```
+    # curl -X GET
+    # "https://api-sandbox.postnl.nl/shipment/v2/status/signature/3SDEVC17264925
+    # 8" \
+    #  -H "Accept: application/json" \
+    #  -H "apikey: APIKEY-HERE"
+    # ```
+    # @param [String] barcode Required parameter: Barcode of the shipment
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_shipment_signature(barcode)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/shipment/v2/status/signature/{barcode}',
+                                     Server::POSTNL)
+                   .template_param(new_parameter(barcode, key: 'barcode')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyHeader')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ShippingstatusResponseSignature.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request',
+                                 InternalServerErrorException)
+                    .local_error('401',
+                                 'Invalid apikey',
+                                 UnauthorizedException)
+                    .local_error('405',
+                                 'Method not allowed',
+                                 MethodNotAllowedOnlyGetException)
+                    .local_error('429',
+                                 'Too many requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal server error',
+                                 InternalServerErrorException))
+        .execute
+    end
+
+    # Request example:
+    # ```
+    # curl -X GET
+    # "https://api-sandbox.postnl.nl/shipment/v2/status/11223344/updatedshipment
+    # s?period=2022-12-25T10:00:00&amp;period=2022-12-25T10:12:00" \
+    #  -H "Accept: application/json" \
+    #  -H "apikey: APIKEY-HERE" \
+    # ```
+    # @param [String] customernumber Required parameter: Your customer number
+    # @param [Array[String]] period Optional parameter: Optional array which
+    # defines a specific period in which to return updated shipments. For
+    # optimal results, schedule calls at a frequency between 5-15 minutes and
+    # align the requested period accordingly to ensure complete coverage of past
+    # updates. Shorter periods yield improved response times. The API
+    # accommodates a maximum requested period of 2 hours, granting access to
+    # shipment data up to 48 hours in the past. Please use the following format:
+    # YYYY-MM-DDTHH:MM:SS and repeat this variable to define the period (e.g.
+    # /updatedshipments?period=2022-11-07T12:00:00.000&period=2022-11-07T12:05:0
+    # 0.000).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_updated_status_by_customer_number(customernumber,
+                                              period: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/shipment/v2/status/{customernumber}/updatedshipments',
+                                     Server::POSTNL)
+                   .template_param(new_parameter(customernumber, key: 'customernumber')
+                                    .should_encode(true))
+                   .query_param(new_parameter(period, key: 'period'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyHeader')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ShippingstatusResponseUpdatedShipment.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Invalid request',
+                                 InternalServerErrorException)
+                    .local_error('401',
+                                 'Invalid apikey',
+                                 UnauthorizedException)
+                    .local_error('405',
+                                 'Method not allowed',
+                                 MethodNotAllowedOnlyGetException)
+                    .local_error('429',
+                                 'Too many requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal server error',
+                                 InternalServerErrorException))
+        .execute
+    end
+  end
+end

data/lib/postnl_ecommerce/controllers/timeframes_controller.rb

@@ -0,0 +1,90 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # TimeframesController
+  class TimeframesController < BaseController
+    # Request example:
+    # ```
+    # curl -X GET
+    # "https://api-sandbox.postnl.nl/shipment/v2_1/calculate/timeframes?AllowSun
+    # daySorting=false&StartDate=30-06-2022&EndDate=02-07-2022&CountryCode=NL&Po
+    # stalCode=2132WT&HouseNumber=42&HouseNrExt=A&City=Hoofddorp&Street=Siriusdr
+    # eef&Options=Daytime%2CEvening" \
+    #  -H "Accept: application/json" \
+    #  -H "apikey: APIKEY-HERE" \
+    # ```
+    # @param [TrueClass | FalseClass] allow_sunday_sorting Required parameter:
+    # Whether or not the requesting party allows for Sunday sorting (which leads
+    # to delivery on Monday).
+    # @param [String] start_date Required parameter: Date of the beginning of
+    # the timeframe. Format: dd-MM-yyyy
+    # @param [String] end_date Required parameter: Date of the enddate of the
+    # timeframe. Format:dd-MM-yyyy. Enddate may not be before StartDate.
+    # @param [CountrycodeEnum] country_code Required parameter: The ISO2 country
+    # code of the delivery address
+    # @param [String] postal_code Required parameter: Zipcode of the delivery
+    # address
+    # @param [Integer] house_number Required parameter: The house number of the
+    # delivery address
+    # @param [Array[TimeframeOptionsEnum]] options Required parameter: The
+    # delivery options for which expected timeframes should be calculated. At
+    # least one delivery option must be specified. Multiple values should be
+    # comma-separated.
+    # @param [String] house_nr_ext Optional parameter: House number extension of
+    # the delivery address
+    # @param [String] city Optional parameter: City of the delivery address
+    # @param [String] street Optional parameter: The street name of the delivery
+    # address
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def retrieve_delivery_timeframes(allow_sunday_sorting,
+                                     start_date,
+                                     end_date,
+                                     country_code,
+                                     postal_code,
+                                     house_number,
+                                     options,
+                                     house_nr_ext: nil,
+                                     city: nil,
+                                     street: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/shipment/v2_1/calculate/timeframes',
+                                     Server::POSTNL)
+                   .query_param(new_parameter(allow_sunday_sorting, key: 'AllowSundaySorting'))
+                   .query_param(new_parameter(start_date, key: 'StartDate'))
+                   .query_param(new_parameter(end_date, key: 'EndDate'))
+                   .query_param(new_parameter(country_code, key: 'CountryCode'))
+                   .query_param(new_parameter(postal_code, key: 'PostalCode'))
+                   .query_param(new_parameter(house_number, key: 'HouseNumber'))
+                   .query_param(new_parameter(options, key: 'Options'))
+                   .query_param(new_parameter(house_nr_ext, key: 'HouseNrExt'))
+                   .query_param(new_parameter(city, key: 'City'))
+                   .query_param(new_parameter(street, key: 'Street'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyHeader')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TimeframeResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request',
+                                 InvalidRequestException)
+                    .local_error('401',
+                                 'Invalid apikey',
+                                 UnauthorizedException)
+                    .local_error('405',
+                                 'Method not allowed',
+                                 MethodNotAllowedOnlyGetPostException)
+                    .local_error('429',
+                                 'Too many requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal server error',
+                                 InternalServerErrorException))
+        .execute
+    end
+  end
+end

data/lib/postnl_ecommerce/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # 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/postnl_ecommerce/exceptions/barcode_response_invalid_exception.rb

@@ -0,0 +1,57 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # barcodeResponseInvalid class.
+  class BarcodeResponseInvalidException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of errors. See [Error
+    # codes](https://developer.postnl.nl/docs/#/http/reference-data/error-codes)
+    # for possible values.
+    # @return [Array[BarcodeError]]
+    attr_accessor :errors
+
+    # 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
+
+      # Parameter is an array, so we need to iterate through it
+      @errors = nil
+      unless hash['errors'].nil?
+        @errors = []
+        hash['errors'].each do |structure|
+          @errors << (BarcodeError.from_hash(structure) if structure)
+        end
+      end
+
+      @errors = SKIP unless hash.key?('errors')
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} errors: #{@errors}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} errors: #{@errors.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/exceptions/confirming_response_error_exception.rb

@@ -0,0 +1,55 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # confirmingResponse_Error class.
+  class ConfirmingResponseErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[ConfirmingResponseShipment]]
+    attr_accessor :response_shipments
+
+    # 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
+
+      # Parameter is an array, so we need to iterate through it
+      @response_shipments = nil
+      unless hash['ResponseShipments'].nil?
+        @response_shipments = []
+        hash['ResponseShipments'].each do |structure|
+          @response_shipments << (ConfirmingResponseShipment.from_hash(structure) if structure)
+        end
+      end
+
+      @response_shipments = SKIP unless hash.key?('ResponseShipments')
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} response_shipments: #{@response_shipments}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} response_shipments: #{@response_shipments.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/exceptions/internal_server_error_exception.rb

@@ -0,0 +1,46 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # InternalServerError class.
+  class InternalServerErrorException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Fault]
+    attr_accessor :fault
+
+    # 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
+
+      @fault = Fault.from_hash(hash['fault']) if hash['fault']
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fault: #{@fault}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} fault: #{@fault.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/exceptions/invalid_request_exception.rb

@@ -0,0 +1,62 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module PostnlEcommerce
+  # InvalidRequest class.
+  class InvalidRequestException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DateTime]
+    attr_accessor :date
+
+    # TODO: Write general description for this method
+    # @return [Error]
+    attr_accessor :error
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :request_id
+
+    # 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
+
+      @date = if hash.key?('Date')
+                (DateTimeHelper.from_rfc3339(hash['Date']) if hash['Date'])
+              else
+                SKIP
+              end
+      @error = Error.from_hash(hash['Error']) if hash['Error']
+      @request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} date: #{@date}, error: #{@error}, request_id: #{@request_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} date: #{@date.inspect}, error: #{@error.inspect}, request_id:"\
+      " #{@request_id.inspect}>"
+    end
+  end
+end