apimatic-pnl-sdk 1.0.0

data/lib/postnl_ecommerce/models/location.rb

@@ -0,0 +1,174 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Location Model.
+  class Location < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [LocationsAddress]
+    attr_accessor :address
+
+    # The options belonging to the pickup location. The delivery options RETA,
+    # UL, PU, DO, BW, RT and BWUL can be shown in the response. Please ignore
+    # these codes. These codes are internal PostNL codes.
+    # @return [DeliveryOptions]
+    attr_accessor :delivery_options
+
+    # The distance from the address/coordinates provided in the request to the
+    # pickup location returned. Distance in meters.
+    # @return [Integer]
+    attr_accessor :distance
+
+    # The latitude of the pickup location
+    # @return [Float]
+    attr_accessor :latitude
+
+    # The pickup location identifier
+    # @return [Integer]
+    attr_accessor :location_code
+
+    # The longitude of the pickup location
+    # @return [Float]
+    attr_accessor :longitude
+
+    # The name of the pickup location
+    # @return [String]
+    attr_accessor :name
+
+    # The standard opening times of the pickup location
+    # @return [LocationsOpeningHours]
+    attr_accessor :opening_hours
+
+    # 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
+
+    # The partner name belonging to the pickup location. Can be ignored, no
+    # longer used.
+    # @return [String]
+    attr_accessor :partner_name
+
+    # The retail network belonging to the pickup location. Can be ignored, no
+    # longer used
+    # @return [String]
+    attr_accessor :retail_network_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address'] = 'Address'
+      @_hash['delivery_options'] = 'DeliveryOptions'
+      @_hash['distance'] = 'Distance'
+      @_hash['latitude'] = 'Latitude'
+      @_hash['location_code'] = 'LocationCode'
+      @_hash['longitude'] = 'Longitude'
+      @_hash['name'] = 'Name'
+      @_hash['opening_hours'] = 'OpeningHours'
+      @_hash['sustainability'] = 'Sustainability'
+      @_hash['partner_name'] = 'PartnerName'
+      @_hash['retail_network_id'] = 'RetailNetworkID'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address
+        delivery_options
+        distance
+        latitude
+        location_code
+        longitude
+        name
+        opening_hours
+        sustainability
+        partner_name
+        retail_network_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address = SKIP, delivery_options = SKIP, distance = SKIP,
+                   latitude = SKIP, location_code = SKIP, longitude = SKIP,
+                   name = SKIP, opening_hours = SKIP, sustainability = SKIP,
+                   partner_name = SKIP, retail_network_id = SKIP)
+      @address = address unless address == SKIP
+      @delivery_options = delivery_options unless delivery_options == SKIP
+      @distance = distance unless distance == SKIP
+      @latitude = latitude unless latitude == SKIP
+      @location_code = location_code unless location_code == SKIP
+      @longitude = longitude unless longitude == SKIP
+      @name = name unless name == SKIP
+      @opening_hours = opening_hours unless opening_hours == SKIP
+      @sustainability = sustainability unless sustainability == SKIP
+      @partner_name = partner_name unless partner_name == SKIP
+      @retail_network_id = retail_network_id unless retail_network_id == 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 = LocationsAddress.from_hash(hash['Address']) if hash['Address']
+      delivery_options = DeliveryOptions.from_hash(hash['DeliveryOptions']) if
+        hash['DeliveryOptions']
+      distance = hash.key?('Distance') ? hash['Distance'] : SKIP
+      latitude = hash.key?('Latitude') ? hash['Latitude'] : SKIP
+      location_code = hash.key?('LocationCode') ? hash['LocationCode'] : SKIP
+      longitude = hash.key?('Longitude') ? hash['Longitude'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      opening_hours = LocationsOpeningHours.from_hash(hash['OpeningHours']) if
+        hash['OpeningHours']
+      sustainability = Sustainability.from_hash(hash['Sustainability']) if hash['Sustainability']
+      partner_name = hash.key?('PartnerName') ? hash['PartnerName'] : SKIP
+      retail_network_id =
+        hash.key?('RetailNetworkID') ? hash['RetailNetworkID'] : SKIP
+
+      # Create object from extracted values.
+      Location.new(address,
+                   delivery_options,
+                   distance,
+                   latitude,
+                   location_code,
+                   longitude,
+                   name,
+                   opening_hours,
+                   sustainability,
+                   partner_name,
+                   retail_network_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address: #{@address}, delivery_options: #{@delivery_options}, distance:"\
+      " #{@distance}, latitude: #{@latitude}, location_code: #{@location_code}, longitude:"\
+      " #{@longitude}, name: #{@name}, opening_hours: #{@opening_hours}, sustainability:"\
+      " #{@sustainability}, partner_name: #{@partner_name}, retail_network_id:"\
+      " #{@retail_network_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address: #{@address.inspect}, delivery_options:"\
+      " #{@delivery_options.inspect}, distance: #{@distance.inspect}, latitude:"\
+      " #{@latitude.inspect}, location_code: #{@location_code.inspect}, longitude:"\
+      " #{@longitude.inspect}, name: #{@name.inspect}, opening_hours: #{@opening_hours.inspect},"\
+      " sustainability: #{@sustainability.inspect}, partner_name: #{@partner_name.inspect},"\
+      " retail_network_id: #{@retail_network_id.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/location_response_single.rb

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

data/lib/postnl_ecommerce/models/locations_address.rb

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

data/lib/postnl_ecommerce/models/locations_delivery_option_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
+  # locationsDeliveryOption.
+  class LocationsDeliveryOptionEnum
+    LOCATIONS_DELIVERY_OPTION_ENUM = [
+      # TODO: Write general description for PG
+      PG = 'PG'.freeze,
+
+      # TODO: Write general description for PA
+      PA = 'PA'.freeze,
+
+      # TODO: Write general description for PG_EX
+      PG_EX = 'PG_EX'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LOCATIONS_DELIVERY_OPTION_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = PG)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'pg' then PG
+      when 'pa' then PA
+      when 'pg_ex' then PG_EX
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/postnl_ecommerce/models/locations_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 times of the pickup location
+  class LocationsOpeningHours < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Monday]
+    attr_accessor :monday
+
+    # TODO: Write general description for this method
+    # @return [Tuesday]
+    attr_accessor :tuesday
+
+    # TODO: Write general description for this method
+    # @return [Wednesday]
+    attr_accessor :wednesday
+
+    # TODO: Write general description for this method
+    # @return [Thursday]
+    attr_accessor :thursday
+
+    # TODO: Write general description for this method
+    # @return [Friday]
+    attr_accessor :friday
+
+    # TODO: Write general description for this method
+    # @return [Saturday]
+    attr_accessor :saturday
+
+    # TODO: Write general description for this method
+    # @return [Sunday]
+    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 = Monday.from_hash(hash['Monday']) if hash['Monday']
+      tuesday = Tuesday.from_hash(hash['Tuesday']) if hash['Tuesday']
+      wednesday = Wednesday.from_hash(hash['Wednesday']) if hash['Wednesday']
+      thursday = Thursday.from_hash(hash['Thursday']) if hash['Thursday']
+      friday = Friday.from_hash(hash['Friday']) if hash['Friday']
+      saturday = Saturday.from_hash(hash['Saturday']) if hash['Saturday']
+      sunday = Sunday.from_hash(hash['Sunday']) if hash['Sunday']
+
+      # Create object from extracted values.
+      LocationsOpeningHours.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/locations_response_multiple.rb

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

data/lib/postnl_ecommerce/models/monday.rb

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