apimatic-pnl-sdk 1.0.0

data/lib/postnl_ecommerce/models/shippingstatus_customer.rb

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

data/lib/postnl_ecommerce/models/shippingstatus_dimension.rb

@@ -0,0 +1,101 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # ShippingstatusDimension Model.
+  class ShippingstatusDimension < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The weight of the shipment
+    # @return [String]
+    attr_accessor :weight
+
+    # The height of the shipment
+    # @return [String]
+    attr_accessor :height
+
+    # The length of the shipment
+    # @return [String]
+    attr_accessor :length
+
+    # The width of the shipment
+    # @return [String]
+    attr_accessor :width
+
+    # The volume of the shipment
+    # @return [String]
+    attr_accessor :volume
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['weight'] = 'Weight'
+      @_hash['height'] = 'Height'
+      @_hash['length'] = 'Length'
+      @_hash['width'] = 'Width'
+      @_hash['volume'] = 'Volume'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        weight
+        height
+        length
+        width
+        volume
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(weight = SKIP, height = SKIP, length = SKIP, width = SKIP,
+                   volume = SKIP)
+      @weight = weight unless weight == SKIP
+      @height = height unless height == SKIP
+      @length = length unless length == SKIP
+      @width = width unless width == SKIP
+      @volume = volume unless volume == 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'] : SKIP
+      height = hash.key?('Height') ? hash['Height'] : SKIP
+      length = hash.key?('Length') ? hash['Length'] : SKIP
+      width = hash.key?('Width') ? hash['Width'] : SKIP
+      volume = hash.key?('Volume') ? hash['Volume'] : SKIP
+
+      # Create object from extracted values.
+      ShippingstatusDimension.new(weight,
+                                  height,
+                                  length,
+                                  width,
+                                  volume)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} weight: #{@weight}, height: #{@height}, length: #{@length}, width:"\
+      " #{@width}, volume: #{@volume}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} weight: #{@weight.inspect}, height: #{@height.inspect}, length:"\
+      " #{@length.inspect}, width: #{@width.inspect}, volume: #{@volume.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/shippingstatus_product_option.rb

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

data/lib/postnl_ecommerce/models/shippingstatus_product_options.rb

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

data/lib/postnl_ecommerce/models/shippingstatus_response.rb

@@ -0,0 +1,94 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # ShippingstatusResponse Model.
+  class ShippingstatusResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The current status and old statuses of the shipment
+    # @return [CompleteStatus]
+    attr_accessor :complete_status
+
+    # The current status and old statuses of the shipment
+    # @return [CurrentStatus]
+    attr_accessor :current_status
+
+    # Possible warnings (see [Error
+    # Codes](https://developer.postnl.nl/docs/#/http/reference-data/error-codes)
+    # for possible values)
+    # @return [Array[ShippingstatusWarning]]
+    attr_accessor :warnings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['complete_status'] = 'CompleteStatus'
+      @_hash['current_status'] = 'CurrentStatus'
+      @_hash['warnings'] = 'Warnings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        complete_status
+        current_status
+        warnings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(complete_status = SKIP, current_status = SKIP,
+                   warnings = SKIP)
+      @complete_status = complete_status unless complete_status == SKIP
+      @current_status = current_status unless current_status == SKIP
+      @warnings = warnings unless warnings == 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.
+      complete_status = CompleteStatus.from_hash(hash['CompleteStatus']) if hash['CompleteStatus']
+      current_status = CurrentStatus.from_hash(hash['CurrentStatus']) if hash['CurrentStatus']
+      # Parameter is an array, so we need to iterate through it
+      warnings = nil
+      unless hash['Warnings'].nil?
+        warnings = []
+        hash['Warnings'].each do |structure|
+          warnings << (ShippingstatusWarning.from_hash(structure) if structure)
+        end
+      end
+
+      warnings = SKIP unless hash.key?('Warnings')
+
+      # Create object from extracted values.
+      ShippingstatusResponse.new(complete_status,
+                                 current_status,
+                                 warnings)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} complete_status: #{@complete_status}, current_status: #{@current_status},"\
+      " warnings: #{@warnings}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} complete_status: #{@complete_status.inspect}, current_status:"\
+      " #{@current_status.inspect}, warnings: #{@warnings.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/shippingstatus_response_signature.rb

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

data/lib/postnl_ecommerce/models/shippingstatus_response_updated_shipment.rb

@@ -0,0 +1,105 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # ShippingstatusResponseUpdatedShipment Model.
+  class ShippingstatusResponseUpdatedShipment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The barcode belonging to the status update
+    # @return [String]
+    attr_accessor :barcode
+
+    # The date of the update
+    # @return [String]
+    attr_accessor :creation_date
+
+    # The customer number
+    # @return [String]
+    attr_accessor :customer_number
+
+    # The customer code
+    # @return [String]
+    attr_accessor :customer_code
+
+    # The status update. See [Status
+    # codes](https://developer.postnl.nl/docs/#/http/reference-data/error-codes)
+    # for possible values.
+    # @return [UpdatedShipmentStatus]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['barcode'] = 'Barcode'
+      @_hash['creation_date'] = 'CreationDate'
+      @_hash['customer_number'] = 'CustomerNumber'
+      @_hash['customer_code'] = 'CustomerCode'
+      @_hash['status'] = 'Status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        barcode
+        creation_date
+        customer_number
+        customer_code
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(barcode = SKIP, creation_date = SKIP, customer_number = SKIP,
+                   customer_code = SKIP, status = SKIP)
+      @barcode = barcode unless barcode == SKIP
+      @creation_date = creation_date unless creation_date == SKIP
+      @customer_number = customer_number unless customer_number == SKIP
+      @customer_code = customer_code unless customer_code == SKIP
+      @status = status unless status == 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.
+      barcode = hash.key?('Barcode') ? hash['Barcode'] : SKIP
+      creation_date = hash.key?('CreationDate') ? hash['CreationDate'] : SKIP
+      customer_number =
+        hash.key?('CustomerNumber') ? hash['CustomerNumber'] : SKIP
+      customer_code = hash.key?('CustomerCode') ? hash['CustomerCode'] : SKIP
+      status = UpdatedShipmentStatus.from_hash(hash['Status']) if hash['Status']
+
+      # Create object from extracted values.
+      ShippingstatusResponseUpdatedShipment.new(barcode,
+                                                creation_date,
+                                                customer_number,
+                                                customer_code,
+                                                status)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} barcode: #{@barcode}, creation_date: #{@creation_date}, customer_number:"\
+      " #{@customer_number}, customer_code: #{@customer_code}, status: #{@status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} barcode: #{@barcode.inspect}, creation_date: #{@creation_date.inspect},"\
+      " customer_number: #{@customer_number.inspect}, customer_code: #{@customer_code.inspect},"\
+      " status: #{@status.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/shippingstatus_warning.rb

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