apimatic-pnl-sdk 1.0.0

data/lib/postnl_ecommerce/models/checkout_pickup_option.rb

@@ -0,0 +1,103 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # CheckoutPickupOption Model.
+  class CheckoutPickupOption < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Date from which the parcel can be picked up at the PostNL location
+    # @return [String]
+    attr_accessor :pickup_date
+
+    # The date when you need to deliver the shipment to PostNL to ensure the
+    # expected delivery date is achieved. Will be returned as 'null' if not
+    # calculated
+    # @return [String]
+    attr_accessor :shipping_date
+
+    # The pickup option
+    # @return [String]
+    attr_accessor :option
+
+    # Array of pickup locations
+    # @return [Array[CheckoutLocation]]
+    attr_accessor :locations
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['pickup_date'] = 'PickupDate'
+      @_hash['shipping_date'] = 'ShippingDate'
+      @_hash['option'] = 'Option'
+      @_hash['locations'] = 'Locations'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        pickup_date
+        shipping_date
+        option
+        locations
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(pickup_date = SKIP, shipping_date = SKIP, option = SKIP,
+                   locations = SKIP)
+      @pickup_date = pickup_date unless pickup_date == SKIP
+      @shipping_date = shipping_date unless shipping_date == SKIP
+      @option = option unless option == SKIP
+      @locations = locations unless locations == 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.
+      pickup_date = hash.key?('PickupDate') ? hash['PickupDate'] : SKIP
+      shipping_date = hash.key?('ShippingDate') ? hash['ShippingDate'] : SKIP
+      option = hash.key?('Option') ? hash['Option'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      locations = nil
+      unless hash['Locations'].nil?
+        locations = []
+        hash['Locations'].each do |structure|
+          locations << (CheckoutLocation.from_hash(structure) if structure)
+        end
+      end
+
+      locations = SKIP unless hash.key?('Locations')
+
+      # Create object from extracted values.
+      CheckoutPickupOption.new(pickup_date,
+                               shipping_date,
+                               option,
+                               locations)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pickup_date: #{@pickup_date}, shipping_date: #{@shipping_date}, option:"\
+      " #{@option}, locations: #{@locations}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} pickup_date: #{@pickup_date.inspect}, shipping_date:"\
+      " #{@shipping_date.inspect}, option: #{@option.inspect}, locations: #{@locations.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/checkout_request.rb

@@ -0,0 +1,152 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # CheckoutRequest Model.
+  class CheckoutRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The order date of the shipment. Format dd-MM-YYYY HH:mm:ss
+    # @return [String]
+    attr_accessor :order_date
+
+    # The amount of days it takes for a parcel to be received by PostN. If you
+    # delivery the parcel the same day as the order is placed on the webshop,
+    # please use the value of 1. A value of 2 means the parcel will arrive at
+    # PostNL a day later etc.
+    # @return [Integer]
+    attr_accessor :shipping_duration
+
+    # Array of CutOffTimes
+    # @return [Array[CheckoutCutOffTime]]
+    attr_accessor :cut_off_times
+
+    # Specifies whether you are available to ship parcels to PostNL during
+    # holidays
+    # @return [TrueClass | FalseClass]
+    attr_accessor :holiday_sorting
+
+    # Specifies the delivery and pickup options.
+    # @return [Array[CheckoutOptionEnum]]
+    attr_accessor :options
+
+    # Specifies the number of locations you want returned. This can be a value
+    # of 1-3
+    # @return [Integer]
+    attr_accessor :locations
+
+    # Specifies the number of days for which the timeframes are returned. This
+    # can be a value of 1-9
+    # @return [Integer]
+    attr_accessor :days
+
+    # Array of addresses
+    # @return [Array[CheckoutAddress]]
+    attr_accessor :addresses
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['order_date'] = 'OrderDate'
+      @_hash['shipping_duration'] = 'ShippingDuration'
+      @_hash['cut_off_times'] = 'CutOffTimes'
+      @_hash['holiday_sorting'] = 'HolidaySorting'
+      @_hash['options'] = 'Options'
+      @_hash['locations'] = 'Locations'
+      @_hash['days'] = 'Days'
+      @_hash['addresses'] = 'Addresses'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        shipping_duration
+        holiday_sorting
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(order_date = nil, cut_off_times = nil, options = nil,
+                   locations = nil, days = nil, addresses = nil,
+                   shipping_duration = SKIP, holiday_sorting = SKIP)
+      @order_date = order_date
+      @shipping_duration = shipping_duration unless shipping_duration == SKIP
+      @cut_off_times = cut_off_times
+      @holiday_sorting = holiday_sorting unless holiday_sorting == SKIP
+      @options = options
+      @locations = locations
+      @days = days
+      @addresses = addresses
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      order_date = hash.key?('OrderDate') ? hash['OrderDate'] : nil
+      # Parameter is an array, so we need to iterate through it
+      cut_off_times = nil
+      unless hash['CutOffTimes'].nil?
+        cut_off_times = []
+        hash['CutOffTimes'].each do |structure|
+          cut_off_times << (CheckoutCutOffTime.from_hash(structure) if structure)
+        end
+      end
+
+      cut_off_times = nil unless hash.key?('CutOffTimes')
+      options = hash.key?('Options') ? hash['Options'] : nil
+      locations = hash.key?('Locations') ? hash['Locations'] : nil
+      days = hash.key?('Days') ? hash['Days'] : nil
+      # Parameter is an array, so we need to iterate through it
+      addresses = nil
+      unless hash['Addresses'].nil?
+        addresses = []
+        hash['Addresses'].each do |structure|
+          addresses << (CheckoutAddress.from_hash(structure) if structure)
+        end
+      end
+
+      addresses = nil unless hash.key?('Addresses')
+      shipping_duration =
+        hash.key?('ShippingDuration') ? hash['ShippingDuration'] : SKIP
+      holiday_sorting =
+        hash.key?('HolidaySorting') ? hash['HolidaySorting'] : SKIP
+
+      # Create object from extracted values.
+      CheckoutRequest.new(order_date,
+                          cut_off_times,
+                          options,
+                          locations,
+                          days,
+                          addresses,
+                          shipping_duration,
+                          holiday_sorting)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_date: #{@order_date}, shipping_duration: #{@shipping_duration},"\
+      " cut_off_times: #{@cut_off_times}, holiday_sorting: #{@holiday_sorting}, options:"\
+      " #{@options}, locations: #{@locations}, days: #{@days}, addresses: #{@addresses}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} order_date: #{@order_date.inspect}, shipping_duration:"\
+      " #{@shipping_duration.inspect}, cut_off_times: #{@cut_off_times.inspect}, holiday_sorting:"\
+      " #{@holiday_sorting.inspect}, options: #{@options.inspect}, locations:"\
+      " #{@locations.inspect}, days: #{@days.inspect}, addresses: #{@addresses.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/checkout_response.rb

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

data/lib/postnl_ecommerce/models/checkout_time_frame.rb

@@ -0,0 +1,108 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # CheckoutTimeFrame Model.
+  class CheckoutTimeFrame < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Format hh:mm:ss
+    # @return [String]
+    attr_accessor :from
+
+    # Format hh:mm:ss
+    # @return [String]
+    attr_accessor :to
+
+    # The delivery options applicable to the timeframe information. See
+    # [Delivery
+    # Options](https://developer.postnl.nl/docs/#/http/reference-data/reference-
+    # codes/delivery-options) for possible values.
+    # @return [Array[CheckoutOptionEnum]]
+    attr_accessor :options
+
+    # The date when you need to deliver the shipment to PostNL to ensure the
+    # expected delivery date is achieved. Will be returned as 'null' if not
+    # calculated
+    # @return [String]
+    attr_accessor :shipping_date
+
+    # 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['to'] = 'To'
+      @_hash['options'] = 'Options'
+      @_hash['shipping_date'] = 'ShippingDate'
+      @_hash['sustainability'] = 'Sustainability'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        from
+        to
+        options
+        shipping_date
+        sustainability
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(from = SKIP, to = SKIP, options = SKIP, shipping_date = SKIP,
+                   sustainability = SKIP)
+      @from = from unless from == SKIP
+      @to = to unless to == SKIP
+      @options = options unless options == SKIP
+      @shipping_date = shipping_date unless shipping_date == 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
+      to = hash.key?('To') ? hash['To'] : SKIP
+      options = hash.key?('Options') ? hash['Options'] : SKIP
+      shipping_date = hash.key?('ShippingDate') ? hash['ShippingDate'] : SKIP
+      sustainability = Sustainability.from_hash(hash['Sustainability']) if hash['Sustainability']
+
+      # Create object from extracted values.
+      CheckoutTimeFrame.new(from,
+                            to,
+                            options,
+                            shipping_date,
+                            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}, to: #{@to}, options: #{@options}, shipping_date:"\
+      " #{@shipping_date}, 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}, to: #{@to.inspect}, options: #{@options.inspect},"\
+      " shipping_date: #{@shipping_date.inspect}, sustainability: #{@sustainability.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/checkout_warning.rb

@@ -0,0 +1,95 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # CheckoutWarning Model.
+  class CheckoutWarning < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Deliverydate that triggered the warning
+    # @return [String]
+    attr_accessor :delivery_date
+
+    # Warning code (for a possible list of warnings, see the generic error codes
+    # page)
+    # @return [String]
+    attr_accessor :code
+
+    # Warning description (for a possible list of warnings, see the generic
+    # error codes page)
+    # @return [String]
+    attr_accessor :description
+
+    # Warning description (for a possible list of warnings, see the generic
+    # error codes page)
+    # @return [CheckoutWarningOptionEnum]
+    attr_accessor :options
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['delivery_date'] = 'DeliveryDate'
+      @_hash['code'] = 'Code'
+      @_hash['description'] = 'Description'
+      @_hash['options'] = 'Options'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        delivery_date
+        code
+        description
+        options
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(delivery_date = SKIP, code = SKIP, description = SKIP,
+                   options = SKIP)
+      @delivery_date = delivery_date unless delivery_date == SKIP
+      @code = code unless code == SKIP
+      @description = description unless description == SKIP
+      @options = options unless options == 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
+      code = hash.key?('Code') ? hash['Code'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+      options = hash.key?('Options') ? hash['Options'] : SKIP
+
+      # Create object from extracted values.
+      CheckoutWarning.new(delivery_date,
+                          code,
+                          description,
+                          options)
+    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}, code: #{@code}, description:"\
+      " #{@description}, options: #{@options}>"
+    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}, code: #{@code.inspect},"\
+      " description: #{@description.inspect}, options: #{@options.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/checkout_warning_option_enum.rb

@@ -0,0 +1,68 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # checkoutWarningOption.
+  class CheckoutWarningOptionEnum
+    CHECKOUT_WARNING_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 SAMEDAY
+      SAMEDAY = 'Sameday'.freeze,
+
+      # TODO: Write general description for SUNDAY
+      SUNDAY = 'Sunday'.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 ENUM_08000900
+      ENUM_08000900 = '08:00-09:00'.freeze,
+
+      # TODO: Write general description for PICKUP
+      PICKUP = 'Pickup'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHECKOUT_WARNING_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 'sameday' then SAMEDAY
+      when 'sunday' then SUNDAY
+      when 'today' then TODAY
+      when 'enum_08001000' then ENUM_08001000
+      when 'enum_08001200' then ENUM_08001200
+      when 'enum_08001700' then ENUM_08001700
+      when 'enum_08000900' then ENUM_08000900
+      when 'pickup' then PICKUP
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/postnl_ecommerce/models/code_enum.rb

@@ -0,0 +1,44 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Sustainability score code
+  class CodeEnum
+    CODE_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
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CODE_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
+      else
+        default_value
+      end
+    end
+  end
+end