apimatic-pnl-sdk 1.0.0

data/lib/postnl_ecommerce/models/current_status.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 current status and old statuses of the shipment
+  class CurrentStatus < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CurrentStatusShipment]
+    attr_accessor :shipment
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['shipment'] = 'Shipment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        shipment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(shipment = SKIP)
+      @shipment = shipment unless shipment == 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.
+      shipment = CurrentStatusShipment.from_hash(hash['Shipment']) if hash['Shipment']
+
+      # Create object from extracted values.
+      CurrentStatus.new(shipment)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} shipment: #{@shipment}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} shipment: #{@shipment.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/current_status_shipment.rb

@@ -0,0 +1,207 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # CurrentStatusShipment Model.
+  class CurrentStatusShipment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The main barcode of the shipment
+    # @return [String]
+    attr_accessor :main_barcode
+
+    # The barcode of the shipment
+    # @return [String]
+    attr_accessor :barcode
+
+    # The amount of parcels in the multi-collo shipment
+    # @return [String]
+    attr_accessor :shipment_amount
+
+    # The sequence of this parcel in the multi-collo shipment
+    # @return [String]
+    attr_accessor :shipment_counter
+
+    # The sequence of this parcel in the multi-collo shipment
+    # @return [ShippingstatusCustomer]
+    attr_accessor :customer
+
+    # The product code of the shipment
+    # @return [String]
+    attr_accessor :product_code
+
+    # The description of the product code
+    # @return [String]
+    attr_accessor :product_description
+
+    # The customer reference belonging to the shipment
+    # @return [String]
+    attr_accessor :reference
+
+    # The expected delivery date of the shipment
+    # @return [String]
+    attr_accessor :delivery_date
+
+    # The expected delivery date of the shipment
+    # @return [ShippingstatusDimension]
+    attr_accessor :dimension
+
+    # A list of addresses belonging to the shipment
+    # @return [Array[ShippingstatusAddress]]
+    attr_accessor :address
+
+    # A list of product options.
+    # @return [Array[ShippingstatusProductOptions]]
+    attr_accessor :product_options
+
+    # The current status of the shipment (see the [Status
+    # codes](https://developer.postnl.nl/docs/#/http/reference-data/t-t-status-c
+    # odes/event-codes) for possible values.
+    # @return [Status]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['main_barcode'] = 'MainBarcode'
+      @_hash['barcode'] = 'Barcode'
+      @_hash['shipment_amount'] = 'ShipmentAmount'
+      @_hash['shipment_counter'] = 'ShipmentCounter'
+      @_hash['customer'] = 'Customer'
+      @_hash['product_code'] = 'ProductCode'
+      @_hash['product_description'] = 'ProductDescription'
+      @_hash['reference'] = 'Reference'
+      @_hash['delivery_date'] = 'DeliveryDate'
+      @_hash['dimension'] = 'Dimension'
+      @_hash['address'] = 'Address'
+      @_hash['product_options'] = 'ProductOptions'
+      @_hash['status'] = 'Status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        main_barcode
+        barcode
+        shipment_amount
+        shipment_counter
+        customer
+        product_code
+        product_description
+        reference
+        delivery_date
+        dimension
+        address
+        product_options
+        status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(main_barcode = SKIP, barcode = SKIP, shipment_amount = SKIP,
+                   shipment_counter = SKIP, customer = SKIP,
+                   product_code = SKIP, product_description = SKIP,
+                   reference = SKIP, delivery_date = SKIP, dimension = SKIP,
+                   address = SKIP, product_options = SKIP, status = SKIP)
+      @main_barcode = main_barcode unless main_barcode == SKIP
+      @barcode = barcode unless barcode == SKIP
+      @shipment_amount = shipment_amount unless shipment_amount == SKIP
+      @shipment_counter = shipment_counter unless shipment_counter == SKIP
+      @customer = customer unless customer == SKIP
+      @product_code = product_code unless product_code == SKIP
+      @product_description = product_description unless product_description == SKIP
+      @reference = reference unless reference == SKIP
+      @delivery_date = delivery_date unless delivery_date == SKIP
+      @dimension = dimension unless dimension == SKIP
+      @address = address unless address == SKIP
+      @product_options = product_options unless product_options == SKIP
+      @status = status unless status == 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.
+      main_barcode = hash.key?('MainBarcode') ? hash['MainBarcode'] : SKIP
+      barcode = hash.key?('Barcode') ? hash['Barcode'] : SKIP
+      shipment_amount =
+        hash.key?('ShipmentAmount') ? hash['ShipmentAmount'] : SKIP
+      shipment_counter =
+        hash.key?('ShipmentCounter') ? hash['ShipmentCounter'] : SKIP
+      customer = ShippingstatusCustomer.from_hash(hash['Customer']) if hash['Customer']
+      product_code = hash.key?('ProductCode') ? hash['ProductCode'] : SKIP
+      product_description =
+        hash.key?('ProductDescription') ? hash['ProductDescription'] : SKIP
+      reference = hash.key?('Reference') ? hash['Reference'] : SKIP
+      delivery_date = hash.key?('DeliveryDate') ? hash['DeliveryDate'] : SKIP
+      dimension = ShippingstatusDimension.from_hash(hash['Dimension']) if hash['Dimension']
+      # Parameter is an array, so we need to iterate through it
+      address = nil
+      unless hash['Address'].nil?
+        address = []
+        hash['Address'].each do |structure|
+          address << (ShippingstatusAddress.from_hash(structure) if structure)
+        end
+      end
+
+      address = SKIP unless hash.key?('Address')
+      # Parameter is an array, so we need to iterate through it
+      product_options = nil
+      unless hash['ProductOptions'].nil?
+        product_options = []
+        hash['ProductOptions'].each do |structure|
+          product_options << (ShippingstatusProductOptions.from_hash(structure) if structure)
+        end
+      end
+
+      product_options = SKIP unless hash.key?('ProductOptions')
+      status = Status.from_hash(hash['Status']) if hash['Status']
+
+      # Create object from extracted values.
+      CurrentStatusShipment.new(main_barcode,
+                                barcode,
+                                shipment_amount,
+                                shipment_counter,
+                                customer,
+                                product_code,
+                                product_description,
+                                reference,
+                                delivery_date,
+                                dimension,
+                                address,
+                                product_options,
+                                status)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} main_barcode: #{@main_barcode}, barcode: #{@barcode}, shipment_amount:"\
+      " #{@shipment_amount}, shipment_counter: #{@shipment_counter}, customer: #{@customer},"\
+      " product_code: #{@product_code}, product_description: #{@product_description}, reference:"\
+      " #{@reference}, delivery_date: #{@delivery_date}, dimension: #{@dimension}, address:"\
+      " #{@address}, product_options: #{@product_options}, status: #{@status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} main_barcode: #{@main_barcode.inspect}, barcode: #{@barcode.inspect},"\
+      " shipment_amount: #{@shipment_amount.inspect}, shipment_counter:"\
+      " #{@shipment_counter.inspect}, customer: #{@customer.inspect}, product_code:"\
+      " #{@product_code.inspect}, product_description: #{@product_description.inspect}, reference:"\
+      " #{@reference.inspect}, delivery_date: #{@delivery_date.inspect}, dimension:"\
+      " #{@dimension.inspect}, address: #{@address.inspect}, product_options:"\
+      " #{@product_options.inspect}, status: #{@status.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/customer.rb

@@ -0,0 +1,123 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Customer Model.
+  class Customer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CustomerAddress]
+    attr_accessor :address
+
+    # Code of delivery location at PostNL Pakketten
+    # @return [String]
+    attr_accessor :collection_location
+
+    # Name of customer contact person
+    # @return [String]
+    attr_accessor :contact_person
+
+    # Customer code as known at PostNL Pakketten
+    # @return [String]
+    attr_accessor :customer_code
+
+    # Name of customer contact person
+    # @return [String]
+    attr_accessor :customer_number
+
+    # E-mail address of the customer. Mandatory for Non EU destinations.
+    # @return [String]
+    attr_accessor :email
+
+    # Customer name
+    # @return [String]
+    attr_accessor :name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address'] = 'Address'
+      @_hash['collection_location'] = 'CollectionLocation'
+      @_hash['contact_person'] = 'ContactPerson'
+      @_hash['customer_code'] = 'CustomerCode'
+      @_hash['customer_number'] = 'CustomerNumber'
+      @_hash['email'] = 'Email'
+      @_hash['name'] = 'Name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address
+        collection_location
+        contact_person
+        email
+        name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(customer_code = nil, customer_number = nil, address = SKIP,
+                   collection_location = SKIP, contact_person = SKIP,
+                   email = SKIP, name = SKIP)
+      @address = address unless address == SKIP
+      @collection_location = collection_location unless collection_location == SKIP
+      @contact_person = contact_person unless contact_person == SKIP
+      @customer_code = customer_code
+      @customer_number = customer_number
+      @email = email unless email == SKIP
+      @name = name unless 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.
+      customer_code = hash.key?('CustomerCode') ? hash['CustomerCode'] : nil
+      customer_number =
+        hash.key?('CustomerNumber') ? hash['CustomerNumber'] : nil
+      address = CustomerAddress.from_hash(hash['Address']) if hash['Address']
+      collection_location =
+        hash.key?('CollectionLocation') ? hash['CollectionLocation'] : SKIP
+      contact_person = hash.key?('ContactPerson') ? hash['ContactPerson'] : SKIP
+      email = hash.key?('Email') ? hash['Email'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+
+      # Create object from extracted values.
+      Customer.new(customer_code,
+                   customer_number,
+                   address,
+                   collection_location,
+                   contact_person,
+                   email,
+                   name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address: #{@address}, collection_location: #{@collection_location},"\
+      " contact_person: #{@contact_person}, customer_code: #{@customer_code}, customer_number:"\
+      " #{@customer_number}, email: #{@email}, name: #{@name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address: #{@address.inspect}, collection_location:"\
+      " #{@collection_location.inspect}, contact_person: #{@contact_person.inspect},"\
+      " customer_code: #{@customer_code.inspect}, customer_number: #{@customer_number.inspect},"\
+      " email: #{@email.inspect}, name: #{@name.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/customer_address.rb

@@ -0,0 +1,237 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # CustomerAddress Model.
+  class CustomerAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Address 02 is mandatory. It can either be placed in the Customer segment
+    # or in the Shipment segment. Note that if you put it in the Shipment
+    # segment, it should go into all Shipment segments.
+    # @return [String]
+    attr_accessor :address_type
+
+    # Area of the address
+    # @return [String]
+    attr_accessor :area
+
+    # Building name of the address
+    # @return [String]
+    attr_accessor :buildingname
+
+    # City of the address
+    # @return [String]
+    attr_accessor :city
+
+    # This field has a dependency with the field Name. One of both fields must
+    # be filled mandatory; using both fields is also allowed. Mandatory when
+    # AddressType is 09.
+    # @return [String]
+    attr_accessor :company_name
+
+    # The ISO2 country codes
+    # @return [String]
+    attr_accessor :countrycode
+
+    # Send to specific department of a company
+    # @return [String]
+    attr_accessor :department
+
+    # Door code of address. Mandatory for some international shipments.
+    # @return [String]
+    attr_accessor :doorcode
+
+    # Remark: please add FirstName and Name (lastname) of the receiver to
+    # improve the parcel tracking experience of your customer.
+    # @return [String]
+    attr_accessor :first_name
+
+    # Send to specific floor of a company
+    # @return [String]
+    attr_accessor :floor
+
+    # Mandatory for shipments to Benelux. Max. length is 5 characters (only for
+    # Benelux addresses). For Benelux addresses,this field should always be
+    # numeric.
+    # @return [String]
+    attr_accessor :house_nr
+
+    # House number extension
+    # @return [String]
+    attr_accessor :house_nr_ext
+
+    # Last name of person. This field has a dependency with the field
+    # CompanyName. One of both fields must be filled mandatory; using both
+    # fields is also allowed. Remark: please add FirstName and Name (lastname)
+    # of the receiver to improve the parcel tracking experience of your
+    # customer.
+    # @return [String]
+    attr_accessor :name
+
+    # Region of the address
+    # @return [String]
+    attr_accessor :region
+
+    # This field has a dependency with the field StreetHouseNrExt. One of both
+    # fields must be filled mandatory; using both fields simultaneously is
+    # discouraged.
+    # @return [String]
+    attr_accessor :street
+
+    # Combination of Street, HouseNr and HouseNrExt. Please see
+    # [Guidelines](https://developer.postnl.nl/docs/#/http/api-endpoints/send-tr
+    # ack/confirming/guidelines) for the explanation.
+    # @return [String]
+    attr_accessor :street_house_nr_ext
+
+    # Zipcode of the address. Mandatory for shipments to Benelux. Max length
+    # (NL) 6 characters,(BE;LU) 4 numeric characters
+    # @return [String]
+    attr_accessor :zipcode
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address_type'] = 'AddressType'
+      @_hash['area'] = 'Area'
+      @_hash['buildingname'] = 'Buildingname'
+      @_hash['city'] = 'City'
+      @_hash['company_name'] = 'CompanyName'
+      @_hash['countrycode'] = 'Countrycode'
+      @_hash['department'] = 'Department'
+      @_hash['doorcode'] = 'Doorcode'
+      @_hash['first_name'] = 'FirstName'
+      @_hash['floor'] = 'Floor'
+      @_hash['house_nr'] = 'HouseNr'
+      @_hash['house_nr_ext'] = 'HouseNrExt'
+      @_hash['name'] = 'Name'
+      @_hash['region'] = 'Region'
+      @_hash['street'] = 'Street'
+      @_hash['street_house_nr_ext'] = 'StreetHouseNrExt'
+      @_hash['zipcode'] = 'Zipcode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        area
+        buildingname
+        company_name
+        department
+        doorcode
+        first_name
+        floor
+        house_nr
+        house_nr_ext
+        name
+        region
+        street
+        street_house_nr_ext
+        zipcode
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address_type = nil, city = nil, countrycode = nil,
+                   area = SKIP, buildingname = SKIP, company_name = SKIP,
+                   department = SKIP, doorcode = SKIP, first_name = SKIP,
+                   floor = SKIP, house_nr = SKIP, house_nr_ext = SKIP,
+                   name = SKIP, region = SKIP, street = SKIP,
+                   street_house_nr_ext = SKIP, zipcode = SKIP)
+      @address_type = address_type
+      @area = area unless area == SKIP
+      @buildingname = buildingname unless buildingname == SKIP
+      @city = city
+      @company_name = company_name unless company_name == SKIP
+      @countrycode = countrycode
+      @department = department unless department == SKIP
+      @doorcode = doorcode unless doorcode == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @floor = floor unless floor == SKIP
+      @house_nr = house_nr unless house_nr == SKIP
+      @house_nr_ext = house_nr_ext unless house_nr_ext == SKIP
+      @name = name unless name == SKIP
+      @region = region unless region == SKIP
+      @street = street unless street == SKIP
+      @street_house_nr_ext = street_house_nr_ext unless street_house_nr_ext == 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.
+      address_type = hash.key?('AddressType') ? hash['AddressType'] : nil
+      city = hash.key?('City') ? hash['City'] : nil
+      countrycode = hash.key?('Countrycode') ? hash['Countrycode'] : nil
+      area = hash.key?('Area') ? hash['Area'] : SKIP
+      buildingname = hash.key?('Buildingname') ? hash['Buildingname'] : SKIP
+      company_name = hash.key?('CompanyName') ? hash['CompanyName'] : SKIP
+      department = hash.key?('Department') ? hash['Department'] : SKIP
+      doorcode = hash.key?('Doorcode') ? hash['Doorcode'] : SKIP
+      first_name = hash.key?('FirstName') ? hash['FirstName'] : SKIP
+      floor = hash.key?('Floor') ? hash['Floor'] : SKIP
+      house_nr = hash.key?('HouseNr') ? hash['HouseNr'] : SKIP
+      house_nr_ext = hash.key?('HouseNrExt') ? hash['HouseNrExt'] : SKIP
+      name = hash.key?('Name') ? hash['Name'] : SKIP
+      region = hash.key?('Region') ? hash['Region'] : SKIP
+      street = hash.key?('Street') ? hash['Street'] : SKIP
+      street_house_nr_ext =
+        hash.key?('StreetHouseNrExt') ? hash['StreetHouseNrExt'] : SKIP
+      zipcode = hash.key?('Zipcode') ? hash['Zipcode'] : SKIP
+
+      # Create object from extracted values.
+      CustomerAddress.new(address_type,
+                          city,
+                          countrycode,
+                          area,
+                          buildingname,
+                          company_name,
+                          department,
+                          doorcode,
+                          first_name,
+                          floor,
+                          house_nr,
+                          house_nr_ext,
+                          name,
+                          region,
+                          street,
+                          street_house_nr_ext,
+                          zipcode)
+    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}, area: #{@area}, buildingname:"\
+      " #{@buildingname}, city: #{@city}, company_name: #{@company_name}, countrycode:"\
+      " #{@countrycode}, department: #{@department}, doorcode: #{@doorcode}, first_name:"\
+      " #{@first_name}, floor: #{@floor}, house_nr: #{@house_nr}, house_nr_ext: #{@house_nr_ext},"\
+      " name: #{@name}, region: #{@region}, street: #{@street}, street_house_nr_ext:"\
+      " #{@street_house_nr_ext}, zipcode: #{@zipcode}>"
+    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}, area: #{@area.inspect},"\
+      " buildingname: #{@buildingname.inspect}, city: #{@city.inspect}, company_name:"\
+      " #{@company_name.inspect}, countrycode: #{@countrycode.inspect}, department:"\
+      " #{@department.inspect}, doorcode: #{@doorcode.inspect}, first_name:"\
+      " #{@first_name.inspect}, floor: #{@floor.inspect}, house_nr: #{@house_nr.inspect},"\
+      " house_nr_ext: #{@house_nr_ext.inspect}, name: #{@name.inspect}, region:"\
+      " #{@region.inspect}, street: #{@street.inspect}, street_house_nr_ext:"\
+      " #{@street_house_nr_ext.inspect}, zipcode: #{@zipcode.inspect}>"
+    end
+  end
+end