apimatic-pnl-sdk 1.0.0

data/lib/postnl_ecommerce/models/labelling_label.rb

@@ -0,0 +1,84 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # LabellingLabel Model.
+  class LabellingLabel < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Base64 encoded label content
+    # @return [String]
+    attr_accessor :content
+
+    # Type of the label. See possible [Label
+    # types](https://developer.postnl.nl/docs/#/http/reference-data/reference-co
+    # des/label-types)
+    # @return [String]
+    attr_accessor :labeltype
+
+    # Content type of the label, e.g. zebra of pdf.
+    # @return [String]
+    attr_accessor :output_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['content'] = 'Content'
+      @_hash['labeltype'] = 'Labeltype'
+      @_hash['output_type'] = 'OutputType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        content
+        labeltype
+        output_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(content = SKIP, labeltype = SKIP, output_type = SKIP)
+      @content = content unless content == SKIP
+      @labeltype = labeltype unless labeltype == SKIP
+      @output_type = output_type unless output_type == 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.
+      content = hash.key?('Content') ? hash['Content'] : SKIP
+      labeltype = hash.key?('Labeltype') ? hash['Labeltype'] : SKIP
+      output_type = hash.key?('OutputType') ? hash['OutputType'] : SKIP
+
+      # Create object from extracted values.
+      LabellingLabel.new(content,
+                         labeltype,
+                         output_type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} content: #{@content}, labeltype: #{@labeltype}, output_type:"\
+      " #{@output_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} content: #{@content.inspect}, labeltype: #{@labeltype.inspect},"\
+      " output_type: #{@output_type.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/labelling_merged_label.rb

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

data/lib/postnl_ecommerce/models/labelling_request.rb

@@ -0,0 +1,112 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # LabellingRequest Model.
+  class LabellingRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [LabellingCustomer]
+    attr_accessor :customer
+
+    # GIF image of the signature (as a base64 encoded string) max size: 280x60
+    # mm (1058x226 pixels). This can be used to automatically sign the customs
+    # forms. The value of this element can have a maximum size of 65536
+    # characters. Note that the total request can have a maximum size of 200KB.
+    # Larger requests will not be accepted by the server for performance
+    # reasons. Requests that exceed this limit will not return a validation
+    # error,but a HTTP 404 error.
+    # @return [String]
+    attr_accessor :label_signature
+
+    # GIF image of the signature (as a base64 encoded string) max size: 280x60
+    # mm (1058x226 pixels). This can be used to automatically sign the customs
+    # forms. The value of this element can have a maximum size of 65536
+    # characters. Note that the total request can have a maximum size of 200KB.
+    # Larger requests will not be accepted by the server for performance
+    # reasons. Requests that exceed this limit will not return a validation
+    # error,but a HTTP 404 error.
+    # @return [LabellingCustomerMessage]
+    attr_accessor :message
+
+    # List of 1 or more Shipments. At least 1 shipment is required.
+    # @return [Array[LabellingCustomerShipment]]
+    attr_accessor :shipments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer'] = 'Customer'
+      @_hash['label_signature'] = 'LabelSignature'
+      @_hash['message'] = 'Message'
+      @_hash['shipments'] = 'Shipments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        label_signature
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(customer = nil, message = nil, shipments = nil,
+                   label_signature = SKIP)
+      @customer = customer
+      @label_signature = label_signature unless label_signature == SKIP
+      @message = message
+      @shipments = shipments
+    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 = LabellingCustomer.from_hash(hash['Customer']) if hash['Customer']
+      message = LabellingCustomerMessage.from_hash(hash['Message']) if hash['Message']
+      # Parameter is an array, so we need to iterate through it
+      shipments = nil
+      unless hash['Shipments'].nil?
+        shipments = []
+        hash['Shipments'].each do |structure|
+          shipments << (LabellingCustomerShipment.from_hash(structure) if structure)
+        end
+      end
+
+      shipments = nil unless hash.key?('Shipments')
+      label_signature =
+        hash.key?('LabelSignature') ? hash['LabelSignature'] : SKIP
+
+      # Create object from extracted values.
+      LabellingRequest.new(customer,
+                           message,
+                           shipments,
+                           label_signature)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer: #{@customer}, label_signature: #{@label_signature}, message:"\
+      " #{@message}, shipments: #{@shipments}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer: #{@customer.inspect}, label_signature:"\
+      " #{@label_signature.inspect}, message: #{@message.inspect}, shipments:"\
+      " #{@shipments.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/labelling_response.rb

@@ -0,0 +1,95 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # LabellingResponse Model.
+  class LabellingResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The merged label output; only returned if the printer type selected in
+    # your request merges the pdf labels into a single file (e.g. using
+    # GraphicFile|Merge).
+    # @return [Array[LabellingMergedLabel]]
+    attr_accessor :merged_labels
+
+    # The merged label output; only returned if the printer type selected in
+    # your request merges the pdf labels into a single file (e.g. using
+    # GraphicFile|Merge).
+    # @return [Array[LabellingResponseShipment]]
+    attr_accessor :response_shipments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merged_labels'] = 'MergedLabels'
+      @_hash['response_shipments'] = 'ResponseShipments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merged_labels
+        response_shipments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merged_labels = SKIP, response_shipments = SKIP)
+      @merged_labels = merged_labels unless merged_labels == SKIP
+      @response_shipments = response_shipments unless response_shipments == 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
+      merged_labels = nil
+      unless hash['MergedLabels'].nil?
+        merged_labels = []
+        hash['MergedLabels'].each do |structure|
+          merged_labels << (LabellingMergedLabel.from_hash(structure) if structure)
+        end
+      end
+
+      merged_labels = SKIP unless hash.key?('MergedLabels')
+      # Parameter is an array, so we need to iterate through it
+      response_shipments = nil
+      unless hash['ResponseShipments'].nil?
+        response_shipments = []
+        hash['ResponseShipments'].each do |structure|
+          response_shipments << (LabellingResponseShipment.from_hash(structure) if structure)
+        end
+      end
+
+      response_shipments = SKIP unless hash.key?('ResponseShipments')
+
+      # Create object from extracted values.
+      LabellingResponse.new(merged_labels,
+                            response_shipments)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merged_labels: #{@merged_labels}, response_shipments:"\
+      " #{@response_shipments}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merged_labels: #{@merged_labels.inspect}, response_shipments:"\
+      " #{@response_shipments.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/labelling_response_shipment.rb

@@ -0,0 +1,123 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # LabellingResponseShipment Model.
+  class LabellingResponseShipment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The product code of the shipment
+    # @return [String]
+    attr_accessor :product_code_delivery
+
+    # All labels belonging to the selected product
+    # @return [Array[LabellingLabel]]
+    attr_accessor :labels
+
+    # The barcode used on the label
+    # @return [String]
+    attr_accessor :barcode
+
+    # The barcode used on the label
+    # @return [Array[Object]]
+    attr_accessor :errors
+
+    # Possible warnings. See the [Error
+    # Codes](https://developer.postnl.nl/docs/#/http/reference-data/error-codes)
+    # for possible values
+    # @return [Array[Warning]]
+    attr_accessor :warnings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['product_code_delivery'] = 'ProductCodeDelivery'
+      @_hash['labels'] = 'Labels'
+      @_hash['barcode'] = 'Barcode'
+      @_hash['errors'] = 'Errors'
+      @_hash['warnings'] = 'Warnings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        product_code_delivery
+        labels
+        barcode
+        errors
+        warnings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(product_code_delivery = SKIP, labels = SKIP, barcode = SKIP,
+                   errors = SKIP, warnings = SKIP)
+      @product_code_delivery = product_code_delivery unless product_code_delivery == SKIP
+      @labels = labels unless labels == SKIP
+      @barcode = barcode unless barcode == SKIP
+      @errors = errors unless errors == 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.
+      product_code_delivery =
+        hash.key?('ProductCodeDelivery') ? hash['ProductCodeDelivery'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      labels = nil
+      unless hash['Labels'].nil?
+        labels = []
+        hash['Labels'].each do |structure|
+          labels << (LabellingLabel.from_hash(structure) if structure)
+        end
+      end
+
+      labels = SKIP unless hash.key?('Labels')
+      barcode = hash.key?('Barcode') ? hash['Barcode'] : SKIP
+      errors = hash.key?('Errors') ? hash['Errors'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      warnings = nil
+      unless hash['Warnings'].nil?
+        warnings = []
+        hash['Warnings'].each do |structure|
+          warnings << (Warning.from_hash(structure) if structure)
+        end
+      end
+
+      warnings = SKIP unless hash.key?('Warnings')
+
+      # Create object from extracted values.
+      LabellingResponseShipment.new(product_code_delivery,
+                                    labels,
+                                    barcode,
+                                    errors,
+                                    warnings)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_code_delivery: #{@product_code_delivery}, labels: #{@labels},"\
+      " barcode: #{@barcode}, errors: #{@errors}, warnings: #{@warnings}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} product_code_delivery: #{@product_code_delivery.inspect}, labels:"\
+      " #{@labels.inspect}, barcode: #{@barcode.inspect}, errors: #{@errors.inspect}, warnings:"\
+      " #{@warnings.inspect}>"
+    end
+  end
+end

data/lib/postnl_ecommerce/models/language_enum.rb

@@ -0,0 +1,48 @@
+# postnl_ecommerce
+#
+# This file was automatically generated for PostNL by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PostnlEcommerce
+  # language.
+  class LanguageEnum
+    LANGUAGE_ENUM = [
+      # TODO: Write general description for NL
+      NL = 'NL'.freeze,
+
+      # TODO: Write general description for EN
+      EN = 'EN'.freeze,
+
+      # TODO: Write general description for CN
+      CN = 'CN'.freeze,
+
+      # TODO: Write general description for DE
+      DE = 'DE'.freeze,
+
+      # TODO: Write general description for FR
+      FR = 'FR'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LANGUAGE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = NL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'nl' then NL
+      when 'en' then EN
+      when 'cn' then CN
+      when 'de' then DE
+      when 'fr' then FR
+      else
+        default_value
+      end
+    end
+  end
+end