apimatic-pnl-sdk 1.0.0

data/lib/postnl_ecommerce/models/checkout_address.rb

@@ -0,0 +1,120 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # CheckoutAddress Model.
+  class CheckoutAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Address type. 01 is for the receiver address, 02 is for the sender
+    # address.
+    # @return [AddressTypeEnum]
+    attr_accessor :address_type
+
+    # Street name; for Belgian addresses, it is strongly recommended to fill in
+    # the  street value
+    # @return [String]
+    attr_accessor :street
+
+    # The house number of the delivery address
+    # @return [Integer]
+    attr_accessor :house_nr
+
+    # House number extension
+    # @return [String]
+    attr_accessor :house_nr_ext
+
+    # Zipcode of the address
+    # @return [String]
+    attr_accessor :zipcode
+
+    # City of the address
+    # @return [String]
+    attr_accessor :city
+
+    # ISO2 country code. Limited to NL and BE.
+    # @return [CountrycodeEnum]
+    attr_accessor :countrycode
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address_type'] = 'AddressType'
+      @_hash['street'] = 'Street'
+      @_hash['house_nr'] = 'HouseNr'
+      @_hash['house_nr_ext'] = 'HouseNrExt'
+      @_hash['zipcode'] = 'Zipcode'
+      @_hash['city'] = 'City'
+      @_hash['countrycode'] = 'Countrycode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        street
+        house_nr_ext
+        city
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address_type = nil, house_nr = nil, zipcode = nil,
+                   countrycode = nil, street = SKIP, house_nr_ext = SKIP,
+                   city = SKIP)
+      @address_type = address_type
+      @street = street unless street == SKIP
+      @house_nr = house_nr
+      @house_nr_ext = house_nr_ext unless house_nr_ext == SKIP
+      @zipcode = zipcode
+      @city = city unless city == SKIP
+      @countrycode = countrycode
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      address_type = hash.key?('AddressType') ? hash['AddressType'] : nil
+      house_nr = hash.key?('HouseNr') ? hash['HouseNr'] : nil
+      zipcode = hash.key?('Zipcode') ? hash['Zipcode'] : nil
+      countrycode = hash.key?('Countrycode') ? hash['Countrycode'] : nil
+      street = hash.key?('Street') ? hash['Street'] : SKIP
+      house_nr_ext = hash.key?('HouseNrExt') ? hash['HouseNrExt'] : SKIP
+      city = hash.key?('City') ? hash['City'] : SKIP
+
+      # Create object from extracted values.
+      CheckoutAddress.new(address_type,
+                          house_nr,
+                          zipcode,
+                          countrycode,
+                          street,
+                          house_nr_ext,
+                          city)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address_type: #{@address_type}, street: #{@street}, house_nr: #{@house_nr},"\
+      " house_nr_ext: #{@house_nr_ext}, zipcode: #{@zipcode}, city: #{@city}, countrycode:"\
+      " #{@countrycode}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address_type: #{@address_type.inspect}, street: #{@street.inspect},"\
+      " house_nr: #{@house_nr.inspect}, house_nr_ext: #{@house_nr_ext.inspect}, zipcode:"\
+      " #{@zipcode.inspect}, city: #{@city.inspect}, countrycode: #{@countrycode.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/checkout_cut_off_day_enum.rb

@@ -0,0 +1,61 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # The day for which the cutoff time applies. 00 is your default cutoff that
+  # applies to all otherwise not specified days, 01 to 07 is Monday to Sunday.
+  class CheckoutCutOffDayEnum
+    CHECKOUT_CUT_OFF_DAY_ENUM = [
+      # TODO: Write general description for ENUM_00
+      ENUM_00 = '00'.freeze,
+
+      # TODO: Write general description for ENUM_01
+      ENUM_01 = '01'.freeze,
+
+      # TODO: Write general description for ENUM_02
+      ENUM_02 = '02'.freeze,
+
+      # TODO: Write general description for ENUM_03
+      ENUM_03 = '03'.freeze,
+
+      # TODO: Write general description for ENUM_04
+      ENUM_04 = '04'.freeze,
+
+      # TODO: Write general description for ENUM_05
+      ENUM_05 = '05'.freeze,
+
+      # TODO: Write general description for ENUM_06
+      ENUM_06 = '06'.freeze,
+
+      # TODO: Write general description for ENUM_07
+      ENUM_07 = '07'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHECKOUT_CUT_OFF_DAY_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_00)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_00' then ENUM_00
+      when 'enum_01' then ENUM_01
+      when 'enum_02' then ENUM_02
+      when 'enum_03' then ENUM_03
+      when 'enum_04' then ENUM_04
+      when 'enum_05' then ENUM_05
+      when 'enum_06' then ENUM_06
+      when 'enum_07' then ENUM_07
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/postnl_ecommerce/models/checkout_cut_off_time.rb

@@ -0,0 +1,91 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # CheckoutCutOffTime Model.
+  class CheckoutCutOffTime < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The day for which the cutoff time applies. 00 is your default cutoff that
+    # applies to all otherwise not specified days, 01 to 07 is Monday to Sunday.
+    # @return [CheckoutCutOffDayEnum]
+    attr_accessor :day
+
+    # Specifies whether you are available to process shipments during the
+    # selected day
+    # @return [TrueClass | FalseClass]
+    attr_accessor :available
+
+    # Specifies the type belonging to the cutoff time.
+    # @return [CheckoutCutOffTypeEnum]
+    attr_accessor :type
+
+    # Specifies the cutoff time (mandatory when Available is true)
+    # @return [String]
+    attr_accessor :time
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['day'] = 'Day'
+      @_hash['available'] = 'Available'
+      @_hash['type'] = 'Type'
+      @_hash['time'] = 'Time'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        available
+        type
+        time
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(day = nil, available = SKIP, type = SKIP, time = SKIP)
+      @day = day
+      @available = available unless available == SKIP
+      @type = type unless type == SKIP
+      @time = time unless time == 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.
+      day = hash.key?('Day') ? hash['Day'] : nil
+      available = hash.key?('Available') ? hash['Available'] : SKIP
+      type = hash.key?('Type') ? hash['Type'] : SKIP
+      time = hash.key?('Time') ? hash['Time'] : SKIP
+
+      # Create object from extracted values.
+      CheckoutCutOffTime.new(day,
+                             available,
+                             type,
+                             time)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} day: #{@day}, available: #{@available}, type: #{@type}, time: #{@time}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} day: #{@day.inspect}, available: #{@available.inspect}, type:"\
+      " #{@type.inspect}, time: #{@time.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/checkout_cut_off_type_enum.rb

@@ -0,0 +1,40 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Specifies the type belonging to the cutoff time.
+  class CheckoutCutOffTypeEnum
+    CHECKOUT_CUT_OFF_TYPE_ENUM = [
+      # TODO: Write general description for REGULAR
+      REGULAR = 'Regular'.freeze,
+
+      # TODO: Write general description for SAMEDAY
+      SAMEDAY = 'Sameday'.freeze,
+
+      # TODO: Write general description for TODAY
+      TODAY = 'Today'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHECKOUT_CUT_OFF_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = REGULAR)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'regular' then REGULAR
+      when 'sameday' then SAMEDAY
+      when 'today' then TODAY
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/postnl_ecommerce/models/checkout_delivery_option.rb

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

data/lib/postnl_ecommerce/models/checkout_location.rb

@@ -0,0 +1,126 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # CheckoutLocation Model.
+  class CheckoutLocation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The pickup location address
+    # @return [CheckoutPickupAddress]
+    attr_accessor :address
+
+    # Time from when the parcel can be retrieved at the pickup location
+    # @return [String]
+    attr_accessor :pickup_time
+
+    # The standard opening hours of the pickup location
+    # @return [OpeningHours]
+    attr_accessor :opening_hours
+
+    # The calculated distance (in meters) between the location specified and the
+    # address provided in the request
+    # @return [Integer]
+    attr_accessor :distance
+
+    # The location identifier
+    # @return [String]
+    attr_accessor :location_code
+
+    # The partner identifier; not used anymore
+    # @return [String]
+    attr_accessor :partner_id
+
+    # 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['address'] = 'Address'
+      @_hash['pickup_time'] = 'PickupTime'
+      @_hash['opening_hours'] = 'OpeningHours'
+      @_hash['distance'] = 'Distance'
+      @_hash['location_code'] = 'LocationCode'
+      @_hash['partner_id'] = 'PartnerID'
+      @_hash['sustainability'] = 'Sustainability'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address
+        pickup_time
+        opening_hours
+        distance
+        location_code
+        partner_id
+        sustainability
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address = SKIP, pickup_time = SKIP, opening_hours = SKIP,
+                   distance = SKIP, location_code = SKIP, partner_id = SKIP,
+                   sustainability = SKIP)
+      @address = address unless address == SKIP
+      @pickup_time = pickup_time unless pickup_time == SKIP
+      @opening_hours = opening_hours unless opening_hours == SKIP
+      @distance = distance unless distance == SKIP
+      @location_code = location_code unless location_code == SKIP
+      @partner_id = partner_id unless partner_id == 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.
+      address = CheckoutPickupAddress.from_hash(hash['Address']) if hash['Address']
+      pickup_time = hash.key?('PickupTime') ? hash['PickupTime'] : SKIP
+      opening_hours = OpeningHours.from_hash(hash['OpeningHours']) if hash['OpeningHours']
+      distance = hash.key?('Distance') ? hash['Distance'] : SKIP
+      location_code = hash.key?('LocationCode') ? hash['LocationCode'] : SKIP
+      partner_id = hash.key?('PartnerID') ? hash['PartnerID'] : SKIP
+      sustainability = Sustainability.from_hash(hash['Sustainability']) if hash['Sustainability']
+
+      # Create object from extracted values.
+      CheckoutLocation.new(address,
+                           pickup_time,
+                           opening_hours,
+                           distance,
+                           location_code,
+                           partner_id,
+                           sustainability)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address: #{@address}, pickup_time: #{@pickup_time}, opening_hours:"\
+      " #{@opening_hours}, distance: #{@distance}, location_code: #{@location_code}, partner_id:"\
+      " #{@partner_id}, sustainability: #{@sustainability}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address: #{@address.inspect}, pickup_time: #{@pickup_time.inspect},"\
+      " opening_hours: #{@opening_hours.inspect}, distance: #{@distance.inspect}, location_code:"\
+      " #{@location_code.inspect}, partner_id: #{@partner_id.inspect}, sustainability:"\
+      " #{@sustainability.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/checkout_option_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
+  # checkoutOption.
+  class CheckoutOptionEnum
+    CHECKOUT_OPTION_ENUM = [
+      # TODO: Write general description for DAYTIME
+      DAYTIME = 'Daytime'.freeze,
+
+      # TODO: Write general description for EVENING
+      EVENING = 'Evening'.freeze,
+
+      # TODO: Write general description for SUNDAY
+      SUNDAY = 'Sunday'.freeze,
+
+      # TODO: Write general description for SAMEDAY
+      SAMEDAY = 'Sameday'.freeze,
+
+      # TODO: Write general description for TODAY
+      TODAY = 'Today'.freeze,
+
+      # TODO: Write general description for ENUM_08001000
+      ENUM_08001000 = '08:00-10:00'.freeze,
+
+      # TODO: Write general description for ENUM_08001200
+      ENUM_08001200 = '08:00-12:00'.freeze,
+
+      # TODO: Write general description for ENUM_08001700
+      ENUM_08001700 = '08:00-17:00'.freeze,
+
+      # TODO: Write general description for PICKUP
+      PICKUP = 'Pickup'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHECKOUT_OPTION_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 'evening' then EVENING
+      when 'sunday' then SUNDAY
+      when 'sameday' then SAMEDAY
+      when 'today' then TODAY
+      when 'enum_08001000' then ENUM_08001000
+      when 'enum_08001200' then ENUM_08001200
+      when 'enum_08001700' then ENUM_08001700
+      when 'pickup' then PICKUP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/postnl_ecommerce/models/checkout_pickup_address.rb

@@ -0,0 +1,112 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # The pickup location address
+  class CheckoutPickupAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The pickup location street
+    # @return [String]
+    attr_accessor :street
+
+    # The pickup location zipcode
+    # @return [String]
+    attr_accessor :zipcode
+
+    # The pickup location housenumber
+    # @return [Integer]
+    attr_accessor :house_nr
+
+    # The pickup location housenumber extension
+    # @return [String]
+    attr_accessor :house_nr_ext
+
+    # The pickup location country
+    # @return [String]
+    attr_accessor :countrycode
+
+    # The pickup location company name
+    # @return [String]
+    attr_accessor :company_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['street'] = 'Street'
+      @_hash['zipcode'] = 'Zipcode'
+      @_hash['house_nr'] = 'HouseNr'
+      @_hash['house_nr_ext'] = 'HouseNrExt'
+      @_hash['countrycode'] = 'Countrycode'
+      @_hash['company_name'] = 'CompanyName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        street
+        zipcode
+        house_nr
+        house_nr_ext
+        countrycode
+        company_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(street = SKIP, zipcode = SKIP, house_nr = SKIP,
+                   house_nr_ext = SKIP, countrycode = SKIP, company_name = SKIP)
+      @street = street unless street == SKIP
+      @zipcode = zipcode unless zipcode == SKIP
+      @house_nr = house_nr unless house_nr == SKIP
+      @house_nr_ext = house_nr_ext unless house_nr_ext == SKIP
+      @countrycode = countrycode unless countrycode == SKIP
+      @company_name = company_name unless company_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.
+      street = hash.key?('Street') ? hash['Street'] : SKIP
+      zipcode = hash.key?('Zipcode') ? hash['Zipcode'] : SKIP
+      house_nr = hash.key?('HouseNr') ? hash['HouseNr'] : SKIP
+      house_nr_ext = hash.key?('HouseNrExt') ? hash['HouseNrExt'] : SKIP
+      countrycode = hash.key?('Countrycode') ? hash['Countrycode'] : SKIP
+      company_name = hash.key?('CompanyName') ? hash['CompanyName'] : SKIP
+
+      # Create object from extracted values.
+      CheckoutPickupAddress.new(street,
+                                zipcode,
+                                house_nr,
+                                house_nr_ext,
+                                countrycode,
+                                company_name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} street: #{@street}, zipcode: #{@zipcode}, house_nr: #{@house_nr},"\
+      " house_nr_ext: #{@house_nr_ext}, countrycode: #{@countrycode}, company_name:"\
+      " #{@company_name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} street: #{@street.inspect}, zipcode: #{@zipcode.inspect}, house_nr:"\
+      " #{@house_nr.inspect}, house_nr_ext: #{@house_nr_ext.inspect}, countrycode:"\
+      " #{@countrycode.inspect}, company_name: #{@company_name.inspect}>"
+    end
+  end
+end