apimatic-pnl-sdk 1.0.0

data/lib/postnl_ecommerce/models/deliverydate_options.rb

@@ -0,0 +1,65 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # The delivery options for which a delivery date is returned. Only one
+  # delivery option is specified. See [Delivery
+  # Options](https://developer.postnl.nl/docs/#/http/reference-data/reference-co
+  # des/delivery-options) for possible values.
+  class DeliverydateOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [DeliverydateOptionEnum]
+    attr_accessor :string
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['string'] = 'string'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        string
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(string = SKIP)
+      @string = string unless string == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      string = hash.key?('string') ? hash['string'] : SKIP
+
+      # Create object from extracted values.
+      DeliverydateOptions.new(string)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} string: #{@string}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} string: #{@string.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/deliverydate_shipping_response.rb

@@ -0,0 +1,62 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # DeliverydateShippingResponse Model.
+  class DeliverydateShippingResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :sent_date
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['sent_date'] = 'SentDate'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sent_date
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(sent_date = SKIP)
+      @sent_date = sent_date unless sent_date == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      sent_date = hash.key?('SentDate') ? hash['SentDate'] : SKIP
+
+      # Create object from extracted values.
+      DeliverydateShippingResponse.new(sent_date)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sent_date: #{@sent_date}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} sent_date: #{@sent_date.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/detail.rb

@@ -0,0 +1,62 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Detail Model.
+  class Detail < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :errorcode
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['errorcode'] = 'errorcode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        errorcode
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(errorcode = SKIP)
+      @errorcode = errorcode unless errorcode == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      errorcode = hash.key?('errorcode') ? hash['errorcode'] : SKIP
+
+      # Create object from extracted values.
+      Detail.new(errorcode)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} errorcode: #{@errorcode}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} errorcode: #{@errorcode.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/dimension.rb

@@ -0,0 +1,106 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Note: Length, Width, Height values are about the order of the size and need
+  # to be filled in from the longest to the shortest value. For example:
+  # shipment's official height is 700mm, width 500mm, length 300mm. The longest
+  # side (highest value) of 700mm needs to be entered at Length. Width value
+  # becomes 500mm, Height value: 300mm (the lowest). Entering the dimensions in
+  # the wrong order may result in incorrect shipping labels and longer delivery
+  # times. The maximum dimensions can be found in your PostNL contract.
+  class Dimension < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The shortest side of the shipment in millimeters (mm).
+    # @return [Integer]
+    attr_accessor :height
+
+    # The longest side of the shipment in millimeters (mm).
+    # @return [Integer]
+    attr_accessor :length
+
+    # Volume of the shipment in centimeters (cm3). Mandatory for E@H-products.
+    # @return [Integer]
+    attr_accessor :volume
+
+    # Weight of the shipment in grams. Approximate weight suffices
+    # @return [Integer]
+    attr_accessor :weight
+
+    # The second longest side of the shipment in millimeters (mm).
+    # @return [Integer]
+    attr_accessor :width
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['height'] = 'Height'
+      @_hash['length'] = 'Length'
+      @_hash['volume'] = 'Volume'
+      @_hash['weight'] = 'Weight'
+      @_hash['width'] = 'Width'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        height
+        length
+        volume
+        width
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(weight = nil, height = SKIP, length = SKIP, volume = SKIP,
+                   width = SKIP)
+      @height = height unless height == SKIP
+      @length = length unless length == SKIP
+      @volume = volume unless volume == SKIP
+      @weight = weight
+      @width = width unless width == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      weight = hash.key?('Weight') ? hash['Weight'] : nil
+      height = hash.key?('Height') ? hash['Height'] : SKIP
+      length = hash.key?('Length') ? hash['Length'] : SKIP
+      volume = hash.key?('Volume') ? hash['Volume'] : SKIP
+      width = hash.key?('Width') ? hash['Width'] : SKIP
+
+      # Create object from extracted values.
+      Dimension.new(weight,
+                    height,
+                    length,
+                    volume,
+                    width)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} height: #{@height}, length: #{@length}, volume: #{@volume}, weight:"\
+      " #{@weight}, width: #{@width}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} height: #{@height.inspect}, length: #{@length.inspect}, volume:"\
+      " #{@volume.inspect}, weight: #{@weight.inspect}, width: #{@width.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/error.rb

@@ -0,0 +1,73 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Error Model.
+  class Error < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_code
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :error_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['error_code'] = 'ErrorCode'
+      @_hash['error_description'] = 'ErrorDescription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        error_code
+        error_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(error_code = SKIP, error_description = SKIP)
+      @error_code = error_code unless error_code == SKIP
+      @error_description = error_description unless error_description == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      error_code = hash.key?('ErrorCode') ? hash['ErrorCode'] : SKIP
+      error_description =
+        hash.key?('ErrorDescription') ? hash['ErrorDescription'] : SKIP
+
+      # Create object from extracted values.
+      Error.new(error_code,
+                error_description)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code}, error_description: #{@error_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} error_code: #{@error_code.inspect}, error_description:"\
+      " #{@error_description.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/event.rb

@@ -0,0 +1,127 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Event Model.
+  class Event < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The event code
+    # @return [String]
+    attr_accessor :code
+
+    # The event description
+    # @return [String]
+    attr_accessor :description
+
+    # Location code of the destination
+    # @return [String]
+    attr_accessor :destination_location_code
+
+    # The current location code
+    # @return [String]
+    attr_accessor :location_code
+
+    # The route code
+    # @return [String]
+    attr_accessor :route_code
+
+    # The route number
+    # @return [String]
+    attr_accessor :route_number
+
+    # Timestamp of the event
+    # @return [String]
+    attr_accessor :time_stamp
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'Code'
+      @_hash['description'] = 'Description'
+      @_hash['destination_location_code'] = 'DestinationLocationCode'
+      @_hash['location_code'] = 'LocationCode'
+      @_hash['route_code'] = 'RouteCode'
+      @_hash['route_number'] = 'RouteNumber'
+      @_hash['time_stamp'] = 'TimeStamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        description
+        destination_location_code
+        location_code
+        route_code
+        route_number
+        time_stamp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP, description = SKIP,
+                   destination_location_code = SKIP, location_code = SKIP,
+                   route_code = SKIP, route_number = SKIP, time_stamp = SKIP)
+      @code = code unless code == SKIP
+      @description = description unless description == SKIP
+      unless destination_location_code == SKIP
+        @destination_location_code =
+          destination_location_code
+      end
+      @location_code = location_code unless location_code == SKIP
+      @route_code = route_code unless route_code == SKIP
+      @route_number = route_number unless route_number == SKIP
+      @time_stamp = time_stamp unless time_stamp == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      code = hash.key?('Code') ? hash['Code'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+      destination_location_code =
+        hash.key?('DestinationLocationCode') ? hash['DestinationLocationCode'] : SKIP
+      location_code = hash.key?('LocationCode') ? hash['LocationCode'] : SKIP
+      route_code = hash.key?('RouteCode') ? hash['RouteCode'] : SKIP
+      route_number = hash.key?('RouteNumber') ? hash['RouteNumber'] : SKIP
+      time_stamp = hash.key?('TimeStamp') ? hash['TimeStamp'] : SKIP
+
+      # Create object from extracted values.
+      Event.new(code,
+                description,
+                destination_location_code,
+                location_code,
+                route_code,
+                route_number,
+                time_stamp)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, description: #{@description}, destination_location_code:"\
+      " #{@destination_location_code}, location_code: #{@location_code}, route_code:"\
+      " #{@route_code}, route_number: #{@route_number}, time_stamp: #{@time_stamp}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}, description: #{@description.inspect},"\
+      " destination_location_code: #{@destination_location_code.inspect}, location_code:"\
+      " #{@location_code.inspect}, route_code: #{@route_code.inspect}, route_number:"\
+      " #{@route_number.inspect}, time_stamp: #{@time_stamp.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/expectation.rb

@@ -0,0 +1,71 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # The expected delivery timeframe
+  class Expectation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The start of the timeframe
+    # @return [String]
+    attr_accessor :eta_from
+
+    # The end of the timeframe
+    # @return [String]
+    attr_accessor :eta_to
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['eta_from'] = 'ETAFrom'
+      @_hash['eta_to'] = 'ETATo'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        eta_from
+        eta_to
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(eta_from = SKIP, eta_to = SKIP)
+      @eta_from = eta_from unless eta_from == SKIP
+      @eta_to = eta_to unless eta_to == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      eta_from = hash.key?('ETAFrom') ? hash['ETAFrom'] : SKIP
+      eta_to = hash.key?('ETATo') ? hash['ETATo'] : SKIP
+
+      # Create object from extracted values.
+      Expectation.new(eta_from,
+                      eta_to)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} eta_from: #{@eta_from}, eta_to: #{@eta_to}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} eta_from: #{@eta_from.inspect}, eta_to: #{@eta_to.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/extra_field.rb

@@ -0,0 +1,71 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # ExtraField Model.
+  class ExtraField < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :key
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['key'] = 'Key'
+      @_hash['value'] = 'Value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        key
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(key = SKIP, value = SKIP)
+      @key = key unless key == SKIP
+      @value = value unless value == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      key = hash.key?('Key') ? hash['Key'] : SKIP
+      value = hash.key?('Value') ? hash['Value'] : SKIP
+
+      # Create object from extracted values.
+      ExtraField.new(key,
+                     value)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} key: #{@key}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} key: #{@key.inspect}, value: #{@value.inspect}>"
+    end
+  end
+end