apimatic-pnl-sdk 1.0.0

data/lib/postnl_ecommerce/models/address.rb

@@ -0,0 +1,240 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Address Model.
+  class Address < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of the address. This is a code. You can find the possible values at
+    # [Address
+    # types](https://developer.postnl.nl/docs/#/http/reference-data/reference-co
+    # des/address-types)
+    # @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. Mandatory for Non EU destinations where a region is
+    # applicable.
+    # @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
+        city
+        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 = '01', countrycode = nil, area = SKIP,
+                   buildingname = SKIP, city = 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 unless city == SKIP
+      @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['AddressType'] ||= '01'
+      countrycode = hash.key?('Countrycode') ? hash['Countrycode'] : nil
+      area = hash.key?('Area') ? hash['Area'] : SKIP
+      buildingname = hash.key?('Buildingname') ? hash['Buildingname'] : SKIP
+      city = hash.key?('City') ? hash['City'] : 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.
+      Address.new(address_type,
+                  countrycode,
+                  area,
+                  buildingname,
+                  city,
+                  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

data/lib/postnl_ecommerce/models/address_type_enum.rb

@@ -0,0 +1,36 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Address type. 01 is for the receiver address, 02 is for the sender address.
+  class AddressTypeEnum
+    ADDRESS_TYPE_ENUM = [
+      # TODO: Write general description for ENUM_01
+      ENUM_01 = '01'.freeze,
+
+      # TODO: Write general description for ENUM_02
+      ENUM_02 = '02'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ADDRESS_TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = ENUM_01)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'enum_01' then ENUM_01
+      when 'enum_02' then ENUM_02
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/postnl_ecommerce/models/amount.rb

@@ -0,0 +1,138 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Amount Model.
+  class Amount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount type. Please see [Amount
+    # types](https://developer.postnl.nl/docs/#/http/reference-data/reference-co
+    # des/amount-types) for the available types.
+    # @return [String]
+    attr_accessor :amount_type
+
+    # Name of bank account owner
+    # @return [String]
+    attr_accessor :account_name
+
+    # BIC number,optional for COD shipments (mandatory for bank account number
+    # other than originating in The Netherlands)
+    # @return [String]
+    attr_accessor :bic
+
+    # Currency code. only EUR, GBP, USD and CNY are allowed.
+    # @return [String]
+    attr_accessor :currency
+
+    # IBAN bank account number,mandatory for COD shipments. Dutch IBAN numbers
+    # are 18 characters
+    # @return [String]
+    attr_accessor :iban
+
+    # Personal payment reference
+    # @return [String]
+    attr_accessor :reference
+
+    # Transaction number
+    # @return [String]
+    attr_accessor :transaction_number
+
+    # Money value in EUR (unless value Currency is specified for another
+    # currency). Value format (N6.2): #####0.00 (2 digits behind decimal dot).
+    # Mandatory for COD, Insured products (with the exception of certain
+    # productcodes with a standard insured amount).
+    # @return [Float]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount_type'] = 'AmountType'
+      @_hash['account_name'] = 'AccountName'
+      @_hash['bic'] = 'BIC'
+      @_hash['currency'] = 'Currency'
+      @_hash['iban'] = 'IBAN'
+      @_hash['reference'] = 'Reference'
+      @_hash['transaction_number'] = 'TransactionNumber'
+      @_hash['value'] = 'Value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_name
+        bic
+        currency
+        iban
+        reference
+        transaction_number
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount_type = nil, value = nil, account_name = SKIP,
+                   bic = SKIP, currency = SKIP, iban = SKIP, reference = SKIP,
+                   transaction_number = SKIP)
+      @amount_type = amount_type
+      @account_name = account_name unless account_name == SKIP
+      @bic = bic unless bic == SKIP
+      @currency = currency unless currency == SKIP
+      @iban = iban unless iban == SKIP
+      @reference = reference unless reference == SKIP
+      @transaction_number = transaction_number unless transaction_number == SKIP
+      @value = value
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount_type = hash.key?('AmountType') ? hash['AmountType'] : nil
+      value = hash.key?('Value') ? hash['Value'] : nil
+      account_name = hash.key?('AccountName') ? hash['AccountName'] : SKIP
+      bic = hash.key?('BIC') ? hash['BIC'] : SKIP
+      currency = hash.key?('Currency') ? hash['Currency'] : SKIP
+      iban = hash.key?('IBAN') ? hash['IBAN'] : SKIP
+      reference = hash.key?('Reference') ? hash['Reference'] : SKIP
+      transaction_number =
+        hash.key?('TransactionNumber') ? hash['TransactionNumber'] : SKIP
+
+      # Create object from extracted values.
+      Amount.new(amount_type,
+                 value,
+                 account_name,
+                 bic,
+                 currency,
+                 iban,
+                 reference,
+                 transaction_number)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount_type: #{@amount_type}, account_name: #{@account_name}, bic: #{@bic},"\
+      " currency: #{@currency}, iban: #{@iban}, reference: #{@reference}, transaction_number:"\
+      " #{@transaction_number}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount_type: #{@amount_type.inspect}, account_name:"\
+      " #{@account_name.inspect}, bic: #{@bic.inspect}, currency: #{@currency.inspect}, iban:"\
+      " #{@iban.inspect}, reference: #{@reference.inspect}, transaction_number:"\
+      " #{@transaction_number.inspect}, value: #{@value.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/barcode_error.rb

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

data/lib/postnl_ecommerce/models/barcode_response.rb

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

data/lib/postnl_ecommerce/models/base_model.rb

@@ -0,0 +1,110 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end