apimatic-pnl-sdk 1.0.0

data/lib/postnl_ecommerce/models/timeframes.rb

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

data/lib/postnl_ecommerce/models/timeframes_response_object.rb

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

data/lib/postnl_ecommerce/models/tuesday.rb

@@ -0,0 +1,62 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Tuesday Model.
+  class Tuesday < 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.
+      Tuesday.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/type_enum.rb

@@ -0,0 +1,64 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Type.
+  class TypeEnum
+    TYPE_ENUM = [
+      # TODO: Write general description for ENUM_2S
+      ENUM_2S = '2S'.freeze,
+
+      # TODO: Write general description for ENUM_3S
+      ENUM_3S = '3S'.freeze,
+
+      # TODO: Write general description for CC
+      CC = 'CC'.freeze,
+
+      # TODO: Write general description for CP
+      CP = 'CP'.freeze,
+
+      # TODO: Write general description for CD
+      CD = 'CD'.freeze,
+
+      # TODO: Write general description for CF
+      CF = 'CF'.freeze,
+
+      # TODO: Write general description for LA
+      LA = 'LA'.freeze,
+
+      # TODO: Write general description for RI
+      RI = 'RI'.freeze,
+
+      # TODO: Write general description for UE
+      UE = 'UE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_2S)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_2s' then ENUM_2S
+      when 'enum_3s' then ENUM_3S
+      when 'cc' then CC
+      when 'cp' then CP
+      when 'cd' then CD
+      when 'cf' then CF
+      when 'la' then LA
+      when 'ri' then RI
+      when 'ue' then UE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/postnl_ecommerce/models/updated_shipment_status.rb

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

data/lib/postnl_ecommerce/models/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
+  # Warning Model.
+  class Warning < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The Warning code
+    # @return [String]
+    attr_accessor :code
+
+    # The warning 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.
+      Warning.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/warnings.rb

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

data/lib/postnl_ecommerce/models/wednesday.rb

@@ -0,0 +1,62 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Wednesday Model.
+  class Wednesday < 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.
+      Wednesday.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/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+require 'date'
+module PostnlEcommerce
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/postnl_ecommerce/utilities/file_wrapper.rb

@@ -0,0 +1,28 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file}, content_type: #{@content_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def to_inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} file: #{@file.inspect}, content_type: #{@content_type.inspect}>"
+    end
+  end
+end