zippendo 1.0.0

data/lib/zippendo/models/create_shipment201_response_parcels_inner_order_lines_inner.rb

@@ -0,0 +1,402 @@
+=begin
+#Zippendo Public API
+
+#Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@zippendo.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zippendo
+  class CreateShipment201ResponseParcelsInnerOrderLinesInner < ApiModelBase
+    # Unique order line identifier.
+    attr_accessor :id
+
+    # Stock keeping unit of the product.
+    attr_accessor :sku
+
+    # Number of units in this order line.
+    attr_accessor :quantity
+
+    # Human-readable product description.
+    attr_accessor :description
+
+    # Price per unit in the order line currency.
+    attr_accessor :unit_price
+
+    # ISO 4217 currency code.
+    attr_accessor :currency
+
+    # VAT percentage applied to the unit price.
+    attr_accessor :vat_percent
+
+    # Warehouse picking location.
+    attr_accessor :location
+
+    # ISO 3166-1 alpha-2 country of origin.
+    attr_accessor :country_of_origin
+
+    # Customs tariff (HS) code.
+    attr_accessor :tarrif_number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'sku' => :'sku',
+        :'quantity' => :'quantity',
+        :'description' => :'description',
+        :'unit_price' => :'unitPrice',
+        :'currency' => :'currency',
+        :'vat_percent' => :'vatPercent',
+        :'location' => :'location',
+        :'country_of_origin' => :'countryOfOrigin',
+        :'tarrif_number' => :'tarrifNumber'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'sku' => :'String',
+        :'quantity' => :'Integer',
+        :'description' => :'String',
+        :'unit_price' => :'Float',
+        :'currency' => :'String',
+        :'vat_percent' => :'Float',
+        :'location' => :'String',
+        :'country_of_origin' => :'String',
+        :'tarrif_number' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'description',
+        :'unit_price',
+        :'currency',
+        :'vat_percent',
+        :'location',
+        :'tarrif_number'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Zippendo::CreateShipment201ResponseParcelsInnerOrderLinesInner` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zippendo::CreateShipment201ResponseParcelsInnerOrderLinesInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'sku')
+        self.sku = attributes[:'sku']
+      else
+        self.sku = nil
+      end
+
+      if attributes.key?(:'quantity')
+        self.quantity = attributes[:'quantity']
+      else
+        self.quantity = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'unit_price')
+        self.unit_price = attributes[:'unit_price']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'vat_percent')
+        self.vat_percent = attributes[:'vat_percent']
+      end
+
+      if attributes.key?(:'location')
+        self.location = attributes[:'location']
+      end
+
+      if attributes.key?(:'country_of_origin')
+        self.country_of_origin = attributes[:'country_of_origin']
+      end
+
+      if attributes.key?(:'tarrif_number')
+        self.tarrif_number = attributes[:'tarrif_number']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @sku.nil?
+        invalid_properties.push('invalid value for "sku", sku cannot be nil.')
+      end
+
+      if @sku.to_s.length < 1
+        invalid_properties.push('invalid value for "sku", the character length must be greater than or equal to 1.')
+      end
+
+      if @quantity.nil?
+        invalid_properties.push('invalid value for "quantity", quantity cannot be nil.')
+      end
+
+      if @quantity > 9007199254740991
+        invalid_properties.push('invalid value for "quantity", must be smaller than or equal to 9007199254740991.')
+      end
+
+      if @quantity < 1
+        invalid_properties.push('invalid value for "quantity", must be greater than or equal to 1.')
+      end
+
+      if !@description.nil? && @description.to_s.length < 1
+        invalid_properties.push('invalid value for "description", the character length must be greater than or equal to 1.')
+      end
+
+      if !@unit_price.nil? && @unit_price < 0
+        invalid_properties.push('invalid value for "unit_price", must be greater than or equal to 0.')
+      end
+
+      if !@currency.nil? && @currency.to_s.length > 3
+        invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.')
+      end
+
+      if !@currency.nil? && @currency.to_s.length < 3
+        invalid_properties.push('invalid value for "currency", the character length must be greater than or equal to 3.')
+      end
+
+      if !@vat_percent.nil? && @vat_percent < 0
+        invalid_properties.push('invalid value for "vat_percent", must be greater than or equal to 0.')
+      end
+
+      if !@country_of_origin.nil? && @country_of_origin.to_s.length > 2
+        invalid_properties.push('invalid value for "country_of_origin", the character length must be smaller than or equal to 2.')
+      end
+
+      if !@country_of_origin.nil? && @country_of_origin.to_s.length < 2
+        invalid_properties.push('invalid value for "country_of_origin", the character length must be greater than or equal to 2.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @sku.nil?
+      return false if @sku.to_s.length < 1
+      return false if @quantity.nil?
+      return false if @quantity > 9007199254740991
+      return false if @quantity < 1
+      return false if !@description.nil? && @description.to_s.length < 1
+      return false if !@unit_price.nil? && @unit_price < 0
+      return false if !@currency.nil? && @currency.to_s.length > 3
+      return false if !@currency.nil? && @currency.to_s.length < 3
+      return false if !@vat_percent.nil? && @vat_percent < 0
+      return false if !@country_of_origin.nil? && @country_of_origin.to_s.length > 2
+      return false if !@country_of_origin.nil? && @country_of_origin.to_s.length < 2
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sku Value to be assigned
+    def sku=(sku)
+      if sku.nil?
+        fail ArgumentError, 'sku cannot be nil'
+      end
+
+      if sku.to_s.length < 1
+        fail ArgumentError, 'invalid value for "sku", the character length must be greater than or equal to 1.'
+      end
+
+      @sku = sku
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] quantity Value to be assigned
+    def quantity=(quantity)
+      if quantity.nil?
+        fail ArgumentError, 'quantity cannot be nil'
+      end
+
+      if quantity > 9007199254740991
+        fail ArgumentError, 'invalid value for "quantity", must be smaller than or equal to 9007199254740991.'
+      end
+
+      if quantity < 1
+        fail ArgumentError, 'invalid value for "quantity", must be greater than or equal to 1.'
+      end
+
+      @quantity = quantity
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if !description.nil? && description.to_s.length < 1
+        fail ArgumentError, 'invalid value for "description", the character length must be greater than or equal to 1.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] unit_price Value to be assigned
+    def unit_price=(unit_price)
+      if !unit_price.nil? && unit_price < 0
+        fail ArgumentError, 'invalid value for "unit_price", must be greater than or equal to 0.'
+      end
+
+      @unit_price = unit_price
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] currency Value to be assigned
+    def currency=(currency)
+      if !currency.nil? && currency.to_s.length > 3
+        fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.'
+      end
+
+      if !currency.nil? && currency.to_s.length < 3
+        fail ArgumentError, 'invalid value for "currency", the character length must be greater than or equal to 3.'
+      end
+
+      @currency = currency
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] vat_percent Value to be assigned
+    def vat_percent=(vat_percent)
+      if !vat_percent.nil? && vat_percent < 0
+        fail ArgumentError, 'invalid value for "vat_percent", must be greater than or equal to 0.'
+      end
+
+      @vat_percent = vat_percent
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country_of_origin Value to be assigned
+    def country_of_origin=(country_of_origin)
+      if country_of_origin.nil?
+        fail ArgumentError, 'country_of_origin cannot be nil'
+      end
+
+      if country_of_origin.to_s.length > 2
+        fail ArgumentError, 'invalid value for "country_of_origin", the character length must be smaller than or equal to 2.'
+      end
+
+      if country_of_origin.to_s.length < 2
+        fail ArgumentError, 'invalid value for "country_of_origin", the character length must be greater than or equal to 2.'
+      end
+
+      @country_of_origin = country_of_origin
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          sku == o.sku &&
+          quantity == o.quantity &&
+          description == o.description &&
+          unit_price == o.unit_price &&
+          currency == o.currency &&
+          vat_percent == o.vat_percent &&
+          location == o.location &&
+          country_of_origin == o.country_of_origin &&
+          tarrif_number == o.tarrif_number
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, sku, quantity, description, unit_price, currency, vat_percent, location, country_of_origin, tarrif_number].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end