apimatic-pnl-sdk 1.0.0

data/lib/postnl_ecommerce/models/signature.rb

@@ -0,0 +1,84 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Signature Model.
+  class Signature < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The barcode of the shipment for which the signature is returned
+    # @return [String]
+    attr_accessor :barcode
+
+    # The date of the signature
+    # @return [String]
+    attr_accessor :signature_date
+
+    # The signature content; base64 encoded GIF format.
+    # @return [String]
+    attr_accessor :signature_image
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['barcode'] = 'Barcode'
+      @_hash['signature_date'] = 'SignatureDate'
+      @_hash['signature_image'] = 'SignatureImage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        barcode
+        signature_date
+        signature_image
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(barcode = SKIP, signature_date = SKIP,
+                   signature_image = SKIP)
+      @barcode = barcode unless barcode == SKIP
+      @signature_date = signature_date unless signature_date == SKIP
+      @signature_image = signature_image unless signature_image == 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
+      signature_date = hash.key?('SignatureDate') ? hash['SignatureDate'] : SKIP
+      signature_image =
+        hash.key?('SignatureImage') ? hash['SignatureImage'] : SKIP
+
+      # Create object from extracted values.
+      Signature.new(barcode,
+                    signature_date,
+                    signature_image)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} barcode: #{@barcode}, signature_date: #{@signature_date}, signature_image:"\
+      " #{@signature_image}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} barcode: #{@barcode.inspect}, signature_date: #{@signature_date.inspect},"\
+      " signature_image: #{@signature_image.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/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 current status of the shipment (see the [Status
+  # codes](https://developer.postnl.nl/docs/#/http/reference-data/t-t-status-cod
+  # es/event-codes) for possible values.
+  class Status < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status timestamp
+    # @return [String]
+    attr_accessor :time_stamp
+
+    # 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['time_stamp'] = '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[
+        time_stamp
+        status_code
+        status_description
+        phase_code
+        phase_description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(time_stamp = SKIP, status_code = SKIP,
+                   status_description = SKIP, phase_code = SKIP,
+                   phase_description = SKIP)
+      @time_stamp = time_stamp unless time_stamp == 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.
+      time_stamp = 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.
+      Status.new(time_stamp,
+                 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} time_stamp: #{@time_stamp}, 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} time_stamp: #{@time_stamp.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/sunday.rb

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

@@ -0,0 +1,73 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Sustainability score; see [Sustainability
+  # codes](https://developer.postnl.nl/docs/#/http/reference-data/reference-code
+  # s/sustainability-codes) for possible values.
+  class Sustainability < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Sustainability score code
+    # @return [CodeEnum]
+    attr_accessor :code
+
+    # Sustainability score code 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.
+      Sustainability.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/thursday.rb

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

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

data/lib/postnl_ecommerce/models/timeframe_options_enum.rb

@@ -0,0 +1,60 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # timeframeOptions.
+  class TimeframeOptionsEnum
+    TIMEFRAME_OPTIONS_ENUM = [
+      # TODO: Write general description for DAYTIME
+      DAYTIME = 'Daytime'.freeze,
+
+      # TODO: Write general description for TODAY
+      TODAY = 'Today'.freeze,
+
+      # TODO: Write general description for SAMEDAY
+      SAMEDAY = 'Sameday'.freeze,
+
+      # TODO: Write general description for EVENING
+      EVENING = 'Evening'.freeze,
+
+      # TODO: Write general description for MORNING
+      MORNING = 'Morning'.freeze,
+
+      # TODO: Write general description for NOON
+      NOON = 'Noon'.freeze,
+
+      # TODO: Write general description for SUNDAY
+      SUNDAY = 'Sunday'.freeze,
+
+      # TODO: Write general description for AFTERNOON
+      AFTERNOON = 'Afternoon'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TIMEFRAME_OPTIONS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = DAYTIME)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'daytime' then DAYTIME
+      when 'today' then TODAY
+      when 'sameday' then SAMEDAY
+      when 'evening' then EVENING
+      when 'morning' then MORNING
+      when 'noon' then NOON
+      when 'sunday' then SUNDAY
+      when 'afternoon' then AFTERNOON
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/postnl_ecommerce/models/timeframe_response.rb

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

data/lib/postnl_ecommerce/models/timeframe_timeframe.rb

@@ -0,0 +1,96 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # TimeframeTimeframe Model.
+  class TimeframeTimeframe < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The start time of the expected delivery window
+    # @return [String]
+    attr_accessor :from
+
+    # The delivery option for which the timeframe is calculated. See [Delivery
+    # Options](https://developer.postnl.nl/docs/#/http/reference-data/reference-
+    # codes/delivery-options) for possible values.
+    # @return [Options]
+    attr_accessor :options
+
+    # The end time of the expected delivery window
+    # @return [String]
+    attr_accessor :to
+
+    # Sustainability score; see [Sustainability
+    # codes](https://developer.postnl.nl/docs/#/http/reference-data/reference-co
+    # des/sustainability-codes) for possible values.
+    # @return [Sustainability]
+    attr_accessor :sustainability
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['from'] = 'From'
+      @_hash['options'] = 'Options'
+      @_hash['to'] = 'To'
+      @_hash['sustainability'] = 'Sustainability'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        from
+        options
+        to
+        sustainability
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(from = SKIP, options = SKIP, to = SKIP,
+                   sustainability = SKIP)
+      @from = from unless from == SKIP
+      @options = options unless options == SKIP
+      @to = to unless to == SKIP
+      @sustainability = sustainability unless sustainability == 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.
+      from = hash.key?('From') ? hash['From'] : SKIP
+      options = Options.from_hash(hash['Options']) if hash['Options']
+      to = hash.key?('To') ? hash['To'] : SKIP
+      sustainability = Sustainability.from_hash(hash['Sustainability']) if hash['Sustainability']
+
+      # Create object from extracted values.
+      TimeframeTimeframe.new(from,
+                             options,
+                             to,
+                             sustainability)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} from: #{@from}, options: #{@options}, to: #{@to}, sustainability:"\
+      " #{@sustainability}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} from: #{@from.inspect}, options: #{@options.inspect}, to: #{@to.inspect},"\
+      " sustainability: #{@sustainability.inspect}>"
+    end
+  end
+end