apimatic-pnl-sdk 1.0.0

data/lib/postnl_ecommerce/models/fault.rb

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

data/lib/postnl_ecommerce/models/fault_shipping_status_api.rb

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

data/lib/postnl_ecommerce/models/friday.rb

@@ -0,0 +1,62 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Friday Model.
+  class Friday < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    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.
+      Friday.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/get_locations_result_multiple.rb

@@ -0,0 +1,71 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # GetLocationsResultMultiple Model.
+  class GetLocationsResultMultiple < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[Location]]
+    attr_accessor :response_location
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['response_location'] = 'ResponseLocation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        response_location
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(response_location = SKIP)
+      @response_location = response_location unless response_location == 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.
+      # Parameter is an array, so we need to iterate through it
+      response_location = nil
+      unless hash['ResponseLocation'].nil?
+        response_location = []
+        hash['ResponseLocation'].each do |structure|
+          response_location << (Location.from_hash(structure) if structure)
+        end
+      end
+
+      response_location = SKIP unless hash.key?('ResponseLocation')
+
+      # Create object from extracted values.
+      GetLocationsResultMultiple.new(response_location)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} response_location: #{@response_location}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} response_location: #{@response_location.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/get_locations_result_single.rb

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

data/lib/postnl_ecommerce/models/group.rb

@@ -0,0 +1,97 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Group Model.
+  class Group < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Group sort that determines the type of group that is indicated. This is a
+    # code. For possible values, please see
+    # [here](https://developer.postnl.nl/docs/#/http/reference-data/reference-co
+    # des/group-types)
+    # @return [String]
+    attr_accessor :group_type
+
+    # Sequence number of the collo within the complete shipment (e.g. collo 2 of
+    # 4) Mandatory for multicollo shipments
+    # @return [Integer]
+    attr_accessor :group_sequence
+
+    # Total number of colli in the shipment (in case of multicolli shipments)
+    # Mandatory for multicollo shipments
+    # @return [Integer]
+    attr_accessor :group_count
+
+    # Main barcode for the shipment (in case of multicolli shipments) Mandatory
+    # for multicollo shipments
+    # @return [String]
+    attr_accessor :main_barcode
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['group_type'] = 'GroupType'
+      @_hash['group_sequence'] = 'GroupSequence'
+      @_hash['group_count'] = 'GroupCount'
+      @_hash['main_barcode'] = 'MainBarcode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        group_sequence
+        group_count
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(group_type = nil, main_barcode = nil, group_sequence = SKIP,
+                   group_count = SKIP)
+      @group_type = group_type
+      @group_sequence = group_sequence unless group_sequence == SKIP
+      @group_count = group_count unless group_count == SKIP
+      @main_barcode = main_barcode
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      group_type = hash.key?('GroupType') ? hash['GroupType'] : nil
+      main_barcode = hash.key?('MainBarcode') ? hash['MainBarcode'] : nil
+      group_sequence = hash.key?('GroupSequence') ? hash['GroupSequence'] : SKIP
+      group_count = hash.key?('GroupCount') ? hash['GroupCount'] : SKIP
+
+      # Create object from extracted values.
+      Group.new(group_type,
+                main_barcode,
+                group_sequence,
+                group_count)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} group_type: #{@group_type}, group_sequence: #{@group_sequence},"\
+      " group_count: #{@group_count}, main_barcode: #{@main_barcode}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} group_type: #{@group_type.inspect}, group_sequence:"\
+      " #{@group_sequence.inspect}, group_count: #{@group_count.inspect}, main_barcode:"\
+      " #{@main_barcode.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/hazardous_material.rb

@@ -0,0 +1,178 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # HazardousMaterial Model.
+  class HazardousMaterial < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Toxic substance code as stated in the ADR agreement
+    # @return [String]
+    attr_accessor :toxic_substance_code
+
+    # Array of additional toxic substance codes as stated in the ADR agreement
+    # @return [Array[String]]
+    attr_accessor :additional_toxic_substance_code
+
+    # The amount of ADR points
+    # @return [String]
+    attr_accessor :adr_points
+
+    # The code indicating for which category of tunnels passage is prohibited
+    # with these goods.
+    # @return [String]
+    attr_accessor :tunnel_code
+
+    # Code identifying the category of the packaging material.
+    # @return [String]
+    attr_accessor :packaging_group_code
+
+    # Description of the packaging material
+    # @return [String]
+    attr_accessor :packaging_group_description
+
+    # Gross weight of the goods in grams.
+    # @return [String]
+    attr_accessor :gross_weight
+
+    # The UNDG number
+    # @return [String]
+    attr_accessor :undg_number
+
+    # The transport category code
+    # @return [String]
+    attr_accessor :transport_category_code
+
+    # The chemical technical description of the goods.
+    # @return [String]
+    attr_accessor :chemical_technical_description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['toxic_substance_code'] = 'ToxicSubstanceCode'
+      @_hash['additional_toxic_substance_code'] =
+        'AdditionalToxicSubstanceCode'
+      @_hash['adr_points'] = 'ADRPoints'
+      @_hash['tunnel_code'] = 'TunnelCode'
+      @_hash['packaging_group_code'] = 'PackagingGroupCode'
+      @_hash['packaging_group_description'] = 'PackagingGroupDescription'
+      @_hash['gross_weight'] = 'GrossWeight'
+      @_hash['undg_number'] = 'UNDGNumber'
+      @_hash['transport_category_code'] = 'TransportCategoryCode'
+      @_hash['chemical_technical_description'] =
+        'ChemicalTechnicalDescription'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        additional_toxic_substance_code
+        adr_points
+        tunnel_code
+        packaging_group_code
+        packaging_group_description
+        gross_weight
+        undg_number
+        transport_category_code
+        chemical_technical_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(toxic_substance_code = nil,
+                   additional_toxic_substance_code = SKIP, adr_points = SKIP,
+                   tunnel_code = SKIP, packaging_group_code = SKIP,
+                   packaging_group_description = SKIP, gross_weight = SKIP,
+                   undg_number = SKIP, transport_category_code = SKIP,
+                   chemical_technical_description = SKIP)
+      @toxic_substance_code = toxic_substance_code
+      unless additional_toxic_substance_code == SKIP
+        @additional_toxic_substance_code =
+          additional_toxic_substance_code
+      end
+      @adr_points = adr_points unless adr_points == SKIP
+      @tunnel_code = tunnel_code unless tunnel_code == SKIP
+      @packaging_group_code = packaging_group_code unless packaging_group_code == SKIP
+      unless packaging_group_description == SKIP
+        @packaging_group_description =
+          packaging_group_description
+      end
+      @gross_weight = gross_weight unless gross_weight == SKIP
+      @undg_number = undg_number unless undg_number == SKIP
+      @transport_category_code = transport_category_code unless transport_category_code == SKIP
+      unless chemical_technical_description == SKIP
+        @chemical_technical_description =
+          chemical_technical_description
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      toxic_substance_code =
+        hash.key?('ToxicSubstanceCode') ? hash['ToxicSubstanceCode'] : nil
+      additional_toxic_substance_code =
+        hash.key?('AdditionalToxicSubstanceCode') ? hash['AdditionalToxicSubstanceCode'] : SKIP
+      adr_points = hash.key?('ADRPoints') ? hash['ADRPoints'] : SKIP
+      tunnel_code = hash.key?('TunnelCode') ? hash['TunnelCode'] : SKIP
+      packaging_group_code =
+        hash.key?('PackagingGroupCode') ? hash['PackagingGroupCode'] : SKIP
+      packaging_group_description =
+        hash.key?('PackagingGroupDescription') ? hash['PackagingGroupDescription'] : SKIP
+      gross_weight = hash.key?('GrossWeight') ? hash['GrossWeight'] : SKIP
+      undg_number = hash.key?('UNDGNumber') ? hash['UNDGNumber'] : SKIP
+      transport_category_code =
+        hash.key?('TransportCategoryCode') ? hash['TransportCategoryCode'] : SKIP
+      chemical_technical_description =
+        hash.key?('ChemicalTechnicalDescription') ? hash['ChemicalTechnicalDescription'] : SKIP
+
+      # Create object from extracted values.
+      HazardousMaterial.new(toxic_substance_code,
+                            additional_toxic_substance_code,
+                            adr_points,
+                            tunnel_code,
+                            packaging_group_code,
+                            packaging_group_description,
+                            gross_weight,
+                            undg_number,
+                            transport_category_code,
+                            chemical_technical_description)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} toxic_substance_code: #{@toxic_substance_code},"\
+      " additional_toxic_substance_code: #{@additional_toxic_substance_code}, adr_points:"\
+      " #{@adr_points}, tunnel_code: #{@tunnel_code}, packaging_group_code:"\
+      " #{@packaging_group_code}, packaging_group_description: #{@packaging_group_description},"\
+      " gross_weight: #{@gross_weight}, undg_number: #{@undg_number}, transport_category_code:"\
+      " #{@transport_category_code}, chemical_technical_description:"\
+      " #{@chemical_technical_description}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} toxic_substance_code: #{@toxic_substance_code.inspect},"\
+      " additional_toxic_substance_code: #{@additional_toxic_substance_code.inspect}, adr_points:"\
+      " #{@adr_points.inspect}, tunnel_code: #{@tunnel_code.inspect}, packaging_group_code:"\
+      " #{@packaging_group_code.inspect}, packaging_group_description:"\
+      " #{@packaging_group_description.inspect}, gross_weight: #{@gross_weight.inspect},"\
+      " undg_number: #{@undg_number.inspect}, transport_category_code:"\
+      " #{@transport_category_code.inspect}, chemical_technical_description:"\
+      " #{@chemical_technical_description.inspect}>"
+    end
+  end
+end