apimatic-pnl-sdk 1.0.0

data/lib/postnl_ecommerce/models/confirming_error.rb

@@ -0,0 +1,71 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # ConfirmingError Model.
+  class ConfirmingError < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The error code
+    # @return [String]
+    attr_accessor :code
+
+    # The error description
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'Code'
+      @_hash['description'] = 'Description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP, description = SKIP)
+      @code = code unless code == SKIP
+      @description = description unless 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.
+      code = hash.key?('Code') ? hash['Code'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+
+      # Create object from extracted values.
+      ConfirmingError.new(code,
+                          description)
+    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}>"
+    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}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/confirming_message.rb

@@ -0,0 +1,70 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # ConfirmingMessage Model.
+  class ConfirmingMessage < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ID of the message
+    # @return [String]
+    attr_accessor :message_id
+
+    # Date/time of sending the message. Format: dd-mm-yyyy hh:mm:ss
+    # @return [String]
+    attr_accessor :message_time_stamp
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message_id'] = 'MessageID'
+      @_hash['message_time_stamp'] = 'MessageTimeStamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(message_id = nil, message_time_stamp = nil)
+      @message_id = message_id
+      @message_time_stamp = message_time_stamp
+    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_id = hash.key?('MessageID') ? hash['MessageID'] : nil
+      message_time_stamp =
+        hash.key?('MessageTimeStamp') ? hash['MessageTimeStamp'] : nil
+
+      # Create object from extracted values.
+      ConfirmingMessage.new(message_id,
+                            message_time_stamp)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message_id: #{@message_id}, message_time_stamp: #{@message_time_stamp}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} message_id: #{@message_id.inspect}, message_time_stamp:"\
+      " #{@message_time_stamp.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/confirming_request.rb

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

data/lib/postnl_ecommerce/models/confirming_response.rb

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

data/lib/postnl_ecommerce/models/confirming_response_shipment.rb

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