apimatic-pnl-sdk 1.0.0

data/lib/postnl_ecommerce/models/product_option.rb

@@ -0,0 +1,74 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # ProductOption Model.
+  class ProductOption < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The characteristic of the ProductOption. Mandatory for some products,
+    # please see the [Products
+    # page](https://developer.postnl.nl/docs/#/http/reference-data/product-codes
+    # -dutch-domestic)
+    # @return [String]
+    attr_accessor :characteristic
+
+    # The product option code for this ProductOption. Mandatory for some
+    # products, please see the [Products
+    # page](https://developer.postnl.nl/docs/#/http/reference-data/product-codes
+    # -dutch-domestic)
+    # @return [String]
+    attr_accessor :option
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['characteristic'] = 'Characteristic'
+      @_hash['option'] = 'Option'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(characteristic = '118', option = '006')
+      @characteristic = characteristic
+      @option = option
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      characteristic = hash['Characteristic'] ||= '118'
+      option = hash['Option'] ||= '006'
+
+      # Create object from extracted values.
+      ProductOption.new(characteristic,
+                        option)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} characteristic: #{@characteristic}, option: #{@option}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} characteristic: #{@characteristic.inspect}, option: #{@option.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/reason_no_timeframe.rb

@@ -0,0 +1,104 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # ReasonNoTimeframe Model.
+  class ReasonNoTimeframe < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason code
+    # @return [String]
+    attr_accessor :code
+
+    # The date associated with the reason no timeframe was calculated
+    # @return [String]
+    attr_accessor :date
+
+    # The description associated with the reason no timeframe was calculated
+    # @return [String]
+    attr_accessor :description
+
+    # The option for which no timeframe was calculated for a specific date
+    # @return [NoTimeframesOptions]
+    attr_accessor :options
+
+    # 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['code'] = 'Code'
+      @_hash['date'] = 'Date'
+      @_hash['description'] = 'Description'
+      @_hash['options'] = 'Options'
+      @_hash['sustainability'] = 'Sustainability'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        date
+        description
+        options
+        sustainability
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP, date = SKIP, description = SKIP, options = SKIP,
+                   sustainability = SKIP)
+      @code = code unless code == SKIP
+      @date = date unless date == SKIP
+      @description = description unless description == SKIP
+      @options = options unless options == 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.
+      code = hash.key?('Code') ? hash['Code'] : SKIP
+      date = hash.key?('Date') ? hash['Date'] : SKIP
+      description = hash.key?('Description') ? hash['Description'] : SKIP
+      options = NoTimeframesOptions.from_hash(hash['Options']) if hash['Options']
+      sustainability = Sustainability.from_hash(hash['Sustainability']) if hash['Sustainability']
+
+      # Create object from extracted values.
+      ReasonNoTimeframe.new(code,
+                            date,
+                            description,
+                            options,
+                            sustainability)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, date: #{@date}, description: #{@description}, options:"\
+      " #{@options}, sustainability: #{@sustainability}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}, date: #{@date.inspect}, description:"\
+      " #{@description.inspect}, options: #{@options.inspect}, sustainability:"\
+      " #{@sustainability.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/reason_no_timeframes.rb

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

data/lib/postnl_ecommerce/models/saturday.rb

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

@@ -0,0 +1,50 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Type of shipment, possible values: Gift, Documents, Commercial Goods,
+  # Commercial Sample, Returned Goods. Is used to fill in the checkbox on the
+  # customs form on the shipment label.
+  class ShipmentTypeEnum
+    SHIPMENT_TYPE_ENUM = [
+      # TODO: Write general description for GIFT
+      GIFT = 'Gift'.freeze,
+
+      # TODO: Write general description for DOCUMENTS
+      DOCUMENTS = 'Documents'.freeze,
+
+      # TODO: Write general description for ENUM_COMMERCIAL_GOODS
+      ENUM_COMMERCIAL_GOODS = 'Commercial Goods'.freeze,
+
+      # TODO: Write general description for ENUM_COMMERCIAL_SAMPLE
+      ENUM_COMMERCIAL_SAMPLE = 'Commercial Sample'.freeze,
+
+      # TODO: Write general description for ENUM_RETURNED_GOODS
+      ENUM_RETURNED_GOODS = 'Returned Goods'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      SHIPMENT_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = GIFT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'gift' then GIFT
+      when 'documents' then DOCUMENTS
+      when 'enum_commercial_goods' then ENUM_COMMERCIAL_GOODS
+      when 'enum_commercial_sample' then ENUM_COMMERCIAL_SAMPLE
+      when 'enum_returned_goods' then ENUM_RETURNED_GOODS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/postnl_ecommerce/models/shippingstatus_address.rb

@@ -0,0 +1,204 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # ShippingstatusAddress Model.
+  class ShippingstatusAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The first name
+    # @return [String]
+    attr_accessor :first_name
+
+    # The last name
+    # @return [String]
+    attr_accessor :last_name
+
+    # The company name
+    # @return [String]
+    attr_accessor :company_name
+
+    # The department name
+    # @return [String]
+    attr_accessor :department_name
+
+    # The ISO2 country code
+    # @return [String]
+    attr_accessor :country_code
+
+    # The zipcode
+    # @return [String]
+    attr_accessor :zipcode
+
+    # The region name
+    # @return [String]
+    attr_accessor :region
+
+    # The district name
+    # @return [String]
+    attr_accessor :district
+
+    # The city name
+    # @return [String]
+    attr_accessor :city
+
+    # The street name
+    # @return [String]
+    attr_accessor :street
+
+    # The house number
+    # @return [String]
+    attr_accessor :house_number
+
+    # The house number suffix
+    # @return [String]
+    attr_accessor :house_number_suffix
+
+    # The building name
+    # @return [String]
+    attr_accessor :building
+
+    # The floor of the building
+    # @return [String]
+    attr_accessor :floor
+
+    # An additional remark
+    # @return [String]
+    attr_accessor :remark
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['first_name'] = 'FirstName'
+      @_hash['last_name'] = 'LastName'
+      @_hash['company_name'] = 'CompanyName'
+      @_hash['department_name'] = 'DepartmentName'
+      @_hash['country_code'] = 'CountryCode'
+      @_hash['zipcode'] = 'Zipcode'
+      @_hash['region'] = 'Region'
+      @_hash['district'] = 'District'
+      @_hash['city'] = 'City'
+      @_hash['street'] = 'Street'
+      @_hash['house_number'] = 'HouseNumber'
+      @_hash['house_number_suffix'] = 'HouseNumberSuffix'
+      @_hash['building'] = 'Building'
+      @_hash['floor'] = 'Floor'
+      @_hash['remark'] = 'Remark'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first_name
+        last_name
+        company_name
+        department_name
+        country_code
+        zipcode
+        region
+        district
+        city
+        street
+        house_number
+        house_number_suffix
+        building
+        floor
+        remark
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(first_name = SKIP, last_name = SKIP, company_name = SKIP,
+                   department_name = SKIP, country_code = SKIP, zipcode = SKIP,
+                   region = SKIP, district = SKIP, city = SKIP, street = SKIP,
+                   house_number = SKIP, house_number_suffix = SKIP,
+                   building = SKIP, floor = SKIP, remark = SKIP)
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @company_name = company_name unless company_name == SKIP
+      @department_name = department_name unless department_name == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @zipcode = zipcode unless zipcode == SKIP
+      @region = region unless region == SKIP
+      @district = district unless district == SKIP
+      @city = city unless city == SKIP
+      @street = street unless street == SKIP
+      @house_number = house_number unless house_number == SKIP
+      @house_number_suffix = house_number_suffix unless house_number_suffix == SKIP
+      @building = building unless building == SKIP
+      @floor = floor unless floor == SKIP
+      @remark = remark unless remark == 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.
+      first_name = hash.key?('FirstName') ? hash['FirstName'] : SKIP
+      last_name = hash.key?('LastName') ? hash['LastName'] : SKIP
+      company_name = hash.key?('CompanyName') ? hash['CompanyName'] : SKIP
+      department_name =
+        hash.key?('DepartmentName') ? hash['DepartmentName'] : SKIP
+      country_code = hash.key?('CountryCode') ? hash['CountryCode'] : SKIP
+      zipcode = hash.key?('Zipcode') ? hash['Zipcode'] : SKIP
+      region = hash.key?('Region') ? hash['Region'] : SKIP
+      district = hash.key?('District') ? hash['District'] : SKIP
+      city = hash.key?('City') ? hash['City'] : SKIP
+      street = hash.key?('Street') ? hash['Street'] : SKIP
+      house_number = hash.key?('HouseNumber') ? hash['HouseNumber'] : SKIP
+      house_number_suffix =
+        hash.key?('HouseNumberSuffix') ? hash['HouseNumberSuffix'] : SKIP
+      building = hash.key?('Building') ? hash['Building'] : SKIP
+      floor = hash.key?('Floor') ? hash['Floor'] : SKIP
+      remark = hash.key?('Remark') ? hash['Remark'] : SKIP
+
+      # Create object from extracted values.
+      ShippingstatusAddress.new(first_name,
+                                last_name,
+                                company_name,
+                                department_name,
+                                country_code,
+                                zipcode,
+                                region,
+                                district,
+                                city,
+                                street,
+                                house_number,
+                                house_number_suffix,
+                                building,
+                                floor,
+                                remark)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} first_name: #{@first_name}, last_name: #{@last_name}, company_name:"\
+      " #{@company_name}, department_name: #{@department_name}, country_code: #{@country_code},"\
+      " zipcode: #{@zipcode}, region: #{@region}, district: #{@district}, city: #{@city}, street:"\
+      " #{@street}, house_number: #{@house_number}, house_number_suffix: #{@house_number_suffix},"\
+      " building: #{@building}, floor: #{@floor}, remark: #{@remark}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} first_name: #{@first_name.inspect}, last_name: #{@last_name.inspect},"\
+      " company_name: #{@company_name.inspect}, department_name: #{@department_name.inspect},"\
+      " country_code: #{@country_code.inspect}, zipcode: #{@zipcode.inspect}, region:"\
+      " #{@region.inspect}, district: #{@district.inspect}, city: #{@city.inspect}, street:"\
+      " #{@street.inspect}, house_number: #{@house_number.inspect}, house_number_suffix:"\
+      " #{@house_number_suffix.inspect}, building: #{@building.inspect}, floor: #{@floor.inspect},"\
+      " remark: #{@remark.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/shippingstatus_amount.rb

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