apimatic-pnl-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0ae661d6648705d8f45dc8db003f31c44f54a9087b6538e0feb783cd14c3c3d0
+  data.tar.gz: 5d257cff2d3f6c6148e7e13e08c90de8367c380b48cb95f5825a4ae67ad7dca4
+SHA512:
+  metadata.gz: 0ecb52cc87a3c4ac72758a31ba42e03bbf3b54b34fb290686671ccc0c44775474e7ead0b55e07741dadd3d4cff44538b3b66d5e5f0f40683f7bbcd812c7e0bbc
+  data.tar.gz: 5ba05a22d58caa390430f1ec2dbaca9d8ae1acd394fd52d31d1e888f258fe5ad4025c416a5cafdb4668e1e42b3a3369f29b1f11f78bf34565d9bf978578e022f

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2026 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,164 @@
+
+# Getting Started with Postnl-Ecommerce
+
+## Introduction
+
+<div><p><b>PostNL Ecommerce APIs</b></p><p>Explore our technical documentation, test your integration and go live with PostNL service.</p><p><b>Start using PostNL APIs for e-commerce processes</b></p><p>To get to know the PostNL APIs better, read all about it in our <a href='https://developer.postnl.nl/api-overview/'>API overview</a>. Learn everything you need to about our API's before embarking on integration with PostNL.</p><p>To connect to PostNL, you can request an API key via <a href='https://mijn.postnl.nl/c/BP2_Mod_Login.app?inresponseto=&RelayState=&startURL=%2F'>Mijn PostNL</a> portal. Choose your APIs and build your integration. Explore our guides, examples, and resources to guide you through each phase of integration and start testing. Ensure that you can make successful test calls towards all endpoints used in the solution.</p><p>Contact our integrations team to have your test calls reviewed and gain access to our API production environment. Once everything is configured and validated, you'll be ready to go live and start using the PostNL service.</p><p>For help contact us via our support form: <a href='https://developer.postnl.nl/support/form/'>Need help? Submit a case | PostNL</a>.</p></div>
+
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install apimatic-pnl-sdk -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'apimatic-pnl-sdk', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the apimatic-pnl-sdk gem](https://rubygems.org/gems/apimatic-pnl-sdk/versions/1.0.0).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'postnl_ecommerce'
+include PostnlEcommerce
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/postnl_ecommerce
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
+
+## Test the SDK
+
+To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:
+
+```
+rake
+```
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION_SERVER`** |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 60** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 3** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| custom_header_authentication_credentials | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'postnl_ecommerce'
+include PostnlEcommerce
+
+client = Client.new(
+  custom_header_authentication_credentials: CustomHeaderAuthenticationCredentials.new(
+    apikey: 'apikey'
+  ),
+  environment: Environment::PRODUCTION_SERVER
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'postnl_ecommerce'
+include PostnlEcommerce
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md) section for details.
+
+## Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| PRODUCTION_SERVER | **Default** Production server |
+| NON_PRODUCTION_SERVER | Sandbox environment for testing |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`APIKeyHeader (Custom Header Signature)`](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature.md)
+
+## List of APIs
+
+* [Postalcodecheck](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/controllers/postalcodecheck.md)
+* [Barcode](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/controllers/barcode.md)
+* [Checkout](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/controllers/checkout.md)
+* [Confirming](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/controllers/confirming.md)
+* [Deliverydate](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/controllers/deliverydate.md)
+* [Labelling](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/controllers/labelling.md)
+* [Locations](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/controllers/locations.md)
+* [Shipment](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/controllers/shipment.md)
+* [Shipping Status](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/controllers/shipping-status.md)
+* [Timeframes](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/controllers/timeframes.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/apimatic-pnl-ruby-sdk/tree/1.0.0/doc/date-time-helper.md)
+

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'postnl_ecommerce'
+
+puts 'PostnlEcommerce SDK loaded!'
+puts 'You can now create a client with: client = PostnlEcommerce::Client.new'
+puts 'Or use from_env: client = PostnlEcommerce::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/postnl_ecommerce/api_helper.rb

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

data/lib/postnl_ecommerce/client.rb

@@ -0,0 +1,126 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  #  postnl_ecommerce client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Access to barcode controller.
+    # @return [BarcodeController] Returns the controller instance.
+    def barcode
+      @barcode ||= BarcodeController.new @global_configuration
+    end
+
+    # Access to checkout controller.
+    # @return [CheckoutController] Returns the controller instance.
+    def checkout
+      @checkout ||= CheckoutController.new @global_configuration
+    end
+
+    # Access to confirming controller.
+    # @return [ConfirmingController] Returns the controller instance.
+    def confirming
+      @confirming ||= ConfirmingController.new @global_configuration
+    end
+
+    # Access to deliverydate controller.
+    # @return [DeliverydateController] Returns the controller instance.
+    def deliverydate
+      @deliverydate ||= DeliverydateController.new @global_configuration
+    end
+
+    # Access to labelling controller.
+    # @return [LabellingController] Returns the controller instance.
+    def labelling
+      @labelling ||= LabellingController.new @global_configuration
+    end
+
+    # Access to locations controller.
+    # @return [LocationsController] Returns the controller instance.
+    def locations
+      @locations ||= LocationsController.new @global_configuration
+    end
+
+    # Access to postalcode_check controller.
+    # @return [PostalcodeCheckController] Returns the controller instance.
+    def postalcode_check
+      @postalcode_check ||= PostalcodeCheckController.new @global_configuration
+    end
+
+    # Access to shipment controller.
+    # @return [ShipmentController] Returns the controller instance.
+    def shipment
+      @shipment ||= ShipmentController.new @global_configuration
+    end
+
+    # Access to shipping_status controller.
+    # @return [ShippingStatusController] Returns the controller instance.
+    def shipping_status
+      @shipping_status ||= ShippingStatusController.new @global_configuration
+    end
+
+    # Access to timeframes controller.
+    # @return [TimeframesController] Returns the controller instance.
+    def timeframes
+      @timeframes ||= TimeframesController.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 3, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      environment: Environment::PRODUCTION_SERVER, apikey: nil,
+      custom_header_authentication_credentials: nil, config: nil
+    )
+      @config = if config.nil?
+                  Configuration.new(
+                    connection: connection, adapter: adapter, timeout: timeout,
+                    max_retries: max_retries, retry_interval: retry_interval,
+                    backoff_factor: backoff_factor,
+                    retry_statuses: retry_statuses,
+                    retry_methods: retry_methods, http_callback: http_callback,
+                    proxy_settings: proxy_settings, environment: environment,
+                    apikey: apikey,
+                    custom_header_authentication_credentials: custom_header_authentication_credentials
+                  )
+                else
+                  config
+                end
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseController::GLOBAL_ERRORS)
+                                                 .user_agent(BaseController.user_agent)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[APIKeyHeader].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['APIKeyHeader'] = CustomHeaderAuthentication.new(
+        http_client_config.custom_header_authentication_credentials
+      )
+    end
+
+    # Creates a client directly from environment variables.
+    def self.from_env(**overrides)
+      default_config = Configuration.build_default_config_from_env
+      new_config = default_config.clone_with(**overrides)
+      new(config: new_config)
+    end
+  end
+end

data/lib/postnl_ecommerce/configuration.rb

@@ -0,0 +1,195 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # An enum for SDK environments.
+  class Environment
+    # PRODUCTION_SERVER: Production server
+    # NON_PRODUCTION_SERVER: Sandbox environment for testing
+    ENVIRONMENT = [
+      PRODUCTION_SERVER = 'Production server'.freeze,
+      NON_PRODUCTION_SERVER = 'Non-Production server'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = PRODUCTION_SERVER)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'production_server' then PRODUCTION_SERVER
+      when 'non_production_server' then NON_PRODUCTION_SERVER
+
+      else
+        warn "[Environment] Unknown environment '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    end
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      POSTNL = 'postnl'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = POSTNL)
+      return default_value if value.nil?
+
+      default_value
+    end
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    def apikey
+      @custom_header_authentication_credentials.apikey
+    end
+
+    # The attribute readers for properties.
+    attr_reader :environment, :custom_header_authentication_credentials
+
+    class << self
+      attr_reader :environments
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      max_retries: 3, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      environment: Environment::PRODUCTION_SERVER, apikey: nil,
+      custom_header_authentication_credentials: nil
+    )
+      super connection: connection, adapter: adapter, timeout: timeout,
+            max_retries: max_retries, retry_interval: retry_interval,
+            backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+            retry_methods: retry_methods, http_callback: http_callback,
+            proxy_settings: proxy_settings
+
+      # Current API environment
+      @environment = String(environment)
+
+      # TODO: Replace
+      @apikey = apikey
+
+      # Initializing Custom Header Signature credentials with the provided auth parameters
+      @custom_header_authentication_credentials = create_auth_credentials_object(
+        apikey, custom_header_authentication_credentials
+      )
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   proxy_settings: nil, environment: nil, apikey: nil,
+                   custom_header_authentication_credentials: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      proxy_settings ||= self.proxy_settings
+      environment ||= self.environment
+      custom_header_authentication_credentials = create_auth_credentials_object(
+        apikey,
+        custom_header_authentication_credentials || self.custom_header_authentication_credentials
+      )
+
+      Configuration.new(
+        connection: connection, adapter: adapter, timeout: timeout,
+        max_retries: max_retries, retry_interval: retry_interval,
+        backoff_factor: backoff_factor, retry_statuses: retry_statuses,
+        retry_methods: retry_methods, http_callback: http_callback,
+        proxy_settings: proxy_settings, environment: environment,
+        custom_header_authentication_credentials: custom_header_authentication_credentials
+      )
+    end
+
+    def create_auth_credentials_object(apikey,
+                                       custom_header_authentication_credentials)
+      return custom_header_authentication_credentials if apikey.nil?
+
+      warn('The \'apikey\' params are deprecated. Use \'custom_header_authenti'\
+           'cation_credentials\' param instead.')
+
+      unless custom_header_authentication_credentials.nil?
+        return custom_header_authentication_credentials.clone_with(
+          apikey: apikey
+        )
+      end
+
+      CustomHeaderAuthenticationCredentials.new(apikey: apikey)
+    end
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION_SERVER => {
+        Server::POSTNL => 'https://api.postnl.nl'
+      },
+      Environment::NON_PRODUCTION_SERVER => {
+        Server::POSTNL => 'https://api-sandbox.postnl.nl'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::POSTNL)
+      ENVIRONMENTS[environment][server].clone
+    end
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'production_server'))
+      timeout = (ENV['TIMEOUT'] || 60).to_f
+      max_retries = (ENV['MAX_RETRIES'] || 3).to_i
+      retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
+      backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
+      retry_statuses = ENV.fetch('RETRY_STATUSES',
+                                 '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+      retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Authentication credentials ===
+      custom_header_authentication_credentials = CustomHeaderAuthenticationCredentials.from_env
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+
+      Configuration.new(
+        environment: environment,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        custom_header_authentication_credentials: custom_header_authentication_credentials,
+        proxy_settings: proxy_settings
+      )
+    end
+  end
+end

data/lib/postnl_ecommerce/controllers/barcode_controller.rb

@@ -0,0 +1,71 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # BarcodeController
+  class BarcodeController < BaseController
+    # Request example:
+    # ```
+    # curl -X GET
+    # "https://api-sandbox.postnl.nl/shipment/v1_1/barcode?CustomerCode=DEVC&amp
+    # ;CustomerNumber=11223344&amp;Type=3S&amp;Serie=000000000-999999999&amp" \
+    #  -H "Accept: application/json" \
+    #  -H "apikey: APIKEY-HERE"
+    # ```
+    # @param [String] customer_code Required parameter: The customer code for
+    # which you want a barcode to be generated
+    # @param [String] customer_number Required parameter: The customer code for
+    # which you want a barcode to be generated
+    # @param [TypeEnum] type Required parameter: The barcode type that you want
+    # to be generated
+    # @param [String] serie Optional parameter: Barcode serie in the format
+    # '###000000-###000000', for example 100000-20000. The range must consist of
+    # a minimal difference of 100.000. It is allowed to add extra leading zeros
+    # at the beginning of the serie. See
+    # [Guidelines](https://developer.postnl.nl/docs/#/http/api-endpoints/send-tr
+    # ack/barcode/guidelines) for more information.
+    # @param [String] range Optional parameter: Only used for International Mail
+    # and Packet products (PEPS) shipments (with type LA, RI, UE). Identifying
+    # the issuing postal administration's country (NL in this case).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def generate_barcode(customer_code,
+                         customer_number,
+                         type,
+                         serie: nil,
+                         range: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/shipment/v1_1/barcode',
+                                     Server::POSTNL)
+                   .query_param(new_parameter(customer_code, key: 'CustomerCode'))
+                   .query_param(new_parameter(customer_number, key: 'CustomerNumber'))
+                   .query_param(new_parameter(type, key: 'Type'))
+                   .query_param(new_parameter(serie, key: 'Serie'))
+                   .query_param(new_parameter(range, key: 'Range'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyHeader')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(BarcodeResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Invalid request',
+                                 BarcodeResponseInvalidException)
+                    .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/controllers/base_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
+  # BaseController.
+  class BaseController
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'APIMATIC 3.0'
+    end
+
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end