apimatic-pnl-sdk 1.0.0

data/lib/postnl_ecommerce/models/no_timeframes_options.rb

@@ -0,0 +1,62 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # The option for which no timeframe was calculated for a specific date
+  class NoTimeframesOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TimeframeOptionsEnum]
+    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.
+      NoTimeframesOptions.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/old_status.rb

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

@@ -0,0 +1,121 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # The standard opening hours of the pickup location
+  class OpeningHours < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [OpeningHoursPerDay]
+    attr_accessor :monday
+
+    # TODO: Write general description for this method
+    # @return [OpeningHoursPerDay]
+    attr_accessor :tuesday
+
+    # TODO: Write general description for this method
+    # @return [OpeningHoursPerDay]
+    attr_accessor :wednesday
+
+    # TODO: Write general description for this method
+    # @return [OpeningHoursPerDay]
+    attr_accessor :thursday
+
+    # TODO: Write general description for this method
+    # @return [OpeningHoursPerDay]
+    attr_accessor :friday
+
+    # TODO: Write general description for this method
+    # @return [OpeningHoursPerDay]
+    attr_accessor :saturday
+
+    # TODO: Write general description for this method
+    # @return [OpeningHoursPerDay]
+    attr_accessor :sunday
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['monday'] = 'Monday'
+      @_hash['tuesday'] = 'Tuesday'
+      @_hash['wednesday'] = 'Wednesday'
+      @_hash['thursday'] = 'Thursday'
+      @_hash['friday'] = 'Friday'
+      @_hash['saturday'] = 'Saturday'
+      @_hash['sunday'] = 'Sunday'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        monday
+        tuesday
+        wednesday
+        thursday
+        friday
+        saturday
+        sunday
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(monday = SKIP, tuesday = SKIP, wednesday = SKIP,
+                   thursday = SKIP, friday = SKIP, saturday = SKIP,
+                   sunday = SKIP)
+      @monday = monday unless monday == SKIP
+      @tuesday = tuesday unless tuesday == SKIP
+      @wednesday = wednesday unless wednesday == SKIP
+      @thursday = thursday unless thursday == SKIP
+      @friday = friday unless friday == SKIP
+      @saturday = saturday unless saturday == SKIP
+      @sunday = sunday unless sunday == 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.
+      monday = OpeningHoursPerDay.from_hash(hash['Monday']) if hash['Monday']
+      tuesday = OpeningHoursPerDay.from_hash(hash['Tuesday']) if hash['Tuesday']
+      wednesday = OpeningHoursPerDay.from_hash(hash['Wednesday']) if hash['Wednesday']
+      thursday = OpeningHoursPerDay.from_hash(hash['Thursday']) if hash['Thursday']
+      friday = OpeningHoursPerDay.from_hash(hash['Friday']) if hash['Friday']
+      saturday = OpeningHoursPerDay.from_hash(hash['Saturday']) if hash['Saturday']
+      sunday = OpeningHoursPerDay.from_hash(hash['Sunday']) if hash['Sunday']
+
+      # Create object from extracted values.
+      OpeningHours.new(monday,
+                       tuesday,
+                       wednesday,
+                       thursday,
+                       friday,
+                       saturday,
+                       sunday)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} monday: #{@monday}, tuesday: #{@tuesday}, wednesday: #{@wednesday},"\
+      " thursday: #{@thursday}, friday: #{@friday}, saturday: #{@saturday}, sunday: #{@sunday}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} monday: #{@monday.inspect}, tuesday: #{@tuesday.inspect}, wednesday:"\
+      " #{@wednesday.inspect}, thursday: #{@thursday.inspect}, friday: #{@friday.inspect},"\
+      " saturday: #{@saturday.inspect}, sunday: #{@sunday.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/opening_hours_per_day.rb

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

data/lib/postnl_ecommerce/models/options.rb

@@ -0,0 +1,64 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # The delivery option for which the timeframe is calculated. See [Delivery
+  # Options](https://developer.postnl.nl/docs/#/http/reference-data/reference-co
+  # des/delivery-options) for possible values.
+  class Options < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TimeframeOptionsEnum]
+    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.
+      Options.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/origin_country_code_enum.rb

@@ -0,0 +1,36 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # OriginCountryCode.
+  class OriginCountryCodeEnum
+    ORIGIN_COUNTRY_CODE_ENUM = [
+      # TODO: Write general description for NL
+      NL = 'NL'.freeze,
+
+      # TODO: Write general description for BE
+      BE = 'BE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ORIGIN_COUNTRY_CODE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = NL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'nl' then NL
+      when 'be' then BE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/postnl_ecommerce/models/postalcode_check_address.rb

@@ -0,0 +1,116 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # PostalcodeCheckAddress Model.
+  class PostalcodeCheckAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # City of requested address
+    # @return [String]
+    attr_accessor :city
+
+    # Postalcode of requested address
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Street of requested address
+    # @return [String]
+    attr_accessor :street_name
+
+    # Housenumber of requested address
+    # @return [Integer]
+    attr_accessor :house_number
+
+    # Housenumber addition
+    # @return [String]
+    attr_accessor :house_number_addition
+
+    # Full formatted address according to PostNL standard (returns each line as
+    # a separate string)
+    # @return [Array[String]]
+    attr_accessor :formatted_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['city'] = 'city'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['street_name'] = 'streetName'
+      @_hash['house_number'] = 'houseNumber'
+      @_hash['house_number_addition'] = 'houseNumberAddition'
+      @_hash['formatted_address'] = 'formattedAddress'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        city
+        postal_code
+        street_name
+        house_number
+        house_number_addition
+        formatted_address
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(city = SKIP, postal_code = SKIP, street_name = SKIP,
+                   house_number = SKIP, house_number_addition = SKIP,
+                   formatted_address = SKIP)
+      @city = city unless city == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @street_name = street_name unless street_name == SKIP
+      @house_number = house_number unless house_number == SKIP
+      @house_number_addition = house_number_addition unless house_number_addition == SKIP
+      @formatted_address = formatted_address unless formatted_address == 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.
+      city = hash.key?('city') ? hash['city'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      street_name = hash.key?('streetName') ? hash['streetName'] : SKIP
+      house_number = hash.key?('houseNumber') ? hash['houseNumber'] : SKIP
+      house_number_addition =
+        hash.key?('houseNumberAddition') ? hash['houseNumberAddition'] : SKIP
+      formatted_address =
+        hash.key?('formattedAddress') ? hash['formattedAddress'] : SKIP
+
+      # Create object from extracted values.
+      PostalcodeCheckAddress.new(city,
+                                 postal_code,
+                                 street_name,
+                                 house_number,
+                                 house_number_addition,
+                                 formatted_address)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city}, postal_code: #{@postal_code}, street_name: #{@street_name},"\
+      " house_number: #{@house_number}, house_number_addition: #{@house_number_addition},"\
+      " formatted_address: #{@formatted_address}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} city: #{@city.inspect}, postal_code: #{@postal_code.inspect}, street_name:"\
+      " #{@street_name.inspect}, house_number: #{@house_number.inspect}, house_number_addition:"\
+      " #{@house_number_addition.inspect}, formatted_address: #{@formatted_address.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/postalcode_check_error.rb

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