apimatic-pnl-sdk 1.0.0

data/lib/postnl_ecommerce/exceptions/labelling_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
+  # labellingResponseInvalid class.
+  class LabellingResponseInvalidException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A list of errors returned from the webservice. See the [Error
+    # codes](https://developer.postnl.nl/docs/#/http/reference-data/error-codes)
+    # for possible values.
+    # @return [Array[LabellingError]]
+    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 << (LabellingError.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/method_not_allowed_only_get_exception.rb

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

data/lib/postnl_ecommerce/exceptions/method_not_allowed_only_get_post_exception.rb

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

data/lib/postnl_ecommerce/exceptions/method_not_allowed_only_post_exception.rb

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

data/lib/postnl_ecommerce/exceptions/postalcode_check_response_invalid_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
+  # postalcodeCheckResponseInvalid class.
+  class PostalcodeCheckResponseInvalidException < APIException
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[PostalcodeCheckError]]
+    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 << (PostalcodeCheckError.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/too_many_requests_exception.rb

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

data/lib/postnl_ecommerce/exceptions/unauthorized_exception.rb

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

data/lib/postnl_ecommerce/http/api_response.rb

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

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

data/lib/postnl_ecommerce/http/http_call_back.rb

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

data/lib/postnl_ecommerce/http/http_method_enum.rb

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

data/lib/postnl_ecommerce/http/http_request.rb

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

data/lib/postnl_ecommerce/http/http_response.rb

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

data/lib/postnl_ecommerce/http/proxy_settings.rb

@@ -0,0 +1,22 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+    def self.from_env
+      address = ENV['PROXY_ADDRESS']
+      port = ENV['PROXY_PORT']
+      username = ENV['PROXY_USERNAME']
+      password = ENV['PROXY_PASSWORD']
+      return nil if address.nil? || address.strip.empty?
+
+      new(address: address, port: port, username: username, password: password)
+    end
+  end
+end