zippendo 1.0.0

data/lib/zippendo/models/create_order201_response_order_lines_inner.rb

@@ -0,0 +1,533 @@
+=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 CreateOrder201ResponseOrderLinesInner < ApiModelBase
+    # Stock keeping unit identifier.
+    attr_accessor :sku
+
+    # Product name.
+    attr_accessor :name
+
+    # Quantity ordered.
+    attr_accessor :quantity
+
+    # Price per unit.
+    attr_accessor :unit_price
+
+    # Total price for the line.
+    attr_accessor :total_price
+
+    # ISO 4217 currency code.
+    attr_accessor :currency
+
+    # Item weight in the given unit.
+    attr_accessor :weight
+
+    # Unit of the weight value.
+    attr_accessor :weight_unit
+
+    # Platform variant identifier.
+    attr_accessor :variant_id
+
+    # Platform product identifier.
+    attr_accessor :product_id
+
+    # Product image URL.
+    attr_accessor :image_url
+
+    # Harmonized System customs code (6-13 digits).
+    attr_accessor :hs_code
+
+    # ISO 3166-1 alpha-2 country of origin.
+    attr_accessor :country_of_origin
+
+    # ISO 3166-2 province of origin.
+    attr_accessor :province_of_origin
+
+    # Item barcode (EAN/UPC).
+    attr_accessor :barcode
+
+    # Whether the item requires shipping.
+    attr_accessor :requires_shipping
+
+    # Whether the item is taxable.
+    attr_accessor :taxable
+
+    # Whether the item is a gift card.
+    attr_accessor :gift_card
+
+    # Vendor or brand name.
+    attr_accessor :vendor
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sku' => :'sku',
+        :'name' => :'name',
+        :'quantity' => :'quantity',
+        :'unit_price' => :'unitPrice',
+        :'total_price' => :'totalPrice',
+        :'currency' => :'currency',
+        :'weight' => :'weight',
+        :'weight_unit' => :'weightUnit',
+        :'variant_id' => :'variantId',
+        :'product_id' => :'productId',
+        :'image_url' => :'imageUrl',
+        :'hs_code' => :'hsCode',
+        :'country_of_origin' => :'countryOfOrigin',
+        :'province_of_origin' => :'provinceOfOrigin',
+        :'barcode' => :'barcode',
+        :'requires_shipping' => :'requiresShipping',
+        :'taxable' => :'taxable',
+        :'gift_card' => :'giftCard',
+        :'vendor' => :'vendor'
+      }
+    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
+      {
+        :'sku' => :'String',
+        :'name' => :'String',
+        :'quantity' => :'Integer',
+        :'unit_price' => :'Float',
+        :'total_price' => :'Float',
+        :'currency' => :'String',
+        :'weight' => :'Float',
+        :'weight_unit' => :'String',
+        :'variant_id' => :'String',
+        :'product_id' => :'String',
+        :'image_url' => :'String',
+        :'hs_code' => :'String',
+        :'country_of_origin' => :'String',
+        :'province_of_origin' => :'String',
+        :'barcode' => :'String',
+        :'requires_shipping' => :'Boolean',
+        :'taxable' => :'Boolean',
+        :'gift_card' => :'Boolean',
+        :'vendor' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'sku',
+        :'unit_price',
+        :'total_price',
+        :'currency',
+        :'weight',
+        :'weight_unit',
+        :'variant_id',
+        :'product_id',
+        :'image_url',
+        :'hs_code',
+        :'country_of_origin',
+        :'province_of_origin',
+        :'barcode',
+        :'requires_shipping',
+        :'taxable',
+        :'gift_card',
+        :'vendor'
+      ])
+    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::CreateOrder201ResponseOrderLinesInner` 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::CreateOrder201ResponseOrderLinesInner`. 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?(:'sku')
+        self.sku = attributes[:'sku']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'quantity')
+        self.quantity = attributes[:'quantity']
+      else
+        self.quantity = nil
+      end
+
+      if attributes.key?(:'unit_price')
+        self.unit_price = attributes[:'unit_price']
+      end
+
+      if attributes.key?(:'total_price')
+        self.total_price = attributes[:'total_price']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'weight')
+        self.weight = attributes[:'weight']
+      end
+
+      if attributes.key?(:'weight_unit')
+        self.weight_unit = attributes[:'weight_unit']
+      end
+
+      if attributes.key?(:'variant_id')
+        self.variant_id = attributes[:'variant_id']
+      end
+
+      if attributes.key?(:'product_id')
+        self.product_id = attributes[:'product_id']
+      end
+
+      if attributes.key?(:'image_url')
+        self.image_url = attributes[:'image_url']
+      end
+
+      if attributes.key?(:'hs_code')
+        self.hs_code = attributes[:'hs_code']
+      end
+
+      if attributes.key?(:'country_of_origin')
+        self.country_of_origin = attributes[:'country_of_origin']
+      end
+
+      if attributes.key?(:'province_of_origin')
+        self.province_of_origin = attributes[:'province_of_origin']
+      end
+
+      if attributes.key?(:'barcode')
+        self.barcode = attributes[:'barcode']
+      end
+
+      if attributes.key?(:'requires_shipping')
+        self.requires_shipping = attributes[:'requires_shipping']
+      end
+
+      if attributes.key?(:'taxable')
+        self.taxable = attributes[:'taxable']
+      end
+
+      if attributes.key?(:'gift_card')
+        self.gift_card = attributes[:'gift_card']
+      end
+
+      if attributes.key?(:'vendor')
+        self.vendor = attributes[:'vendor']
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", 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 <= 0
+        invalid_properties.push('invalid value for "quantity", must be greater than 0.')
+      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 !@total_price.nil? && @total_price < 0
+        invalid_properties.push('invalid value for "total_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 !@weight.nil? && @weight < 0
+        invalid_properties.push('invalid value for "weight", 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 @name.nil?
+      return false if @name.to_s.length < 1
+      return false if @quantity.nil?
+      return false if @quantity > 9007199254740991
+      return false if @quantity <= 0
+      return false if !@unit_price.nil? && @unit_price < 0
+      return false if !@total_price.nil? && @total_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 !@weight.nil? && @weight < 0
+      weight_unit_validator = EnumAttributeValidator.new('String', ["kg", "g", "lb", "oz"])
+      return false unless weight_unit_validator.valid?(@weight_unit)
+      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] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be greater than or equal to 1.'
+      end
+
+      @name = name
+    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 <= 0
+        fail ArgumentError, 'invalid value for "quantity", must be greater than 0.'
+      end
+
+      @quantity = quantity
+    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] total_price Value to be assigned
+    def total_price=(total_price)
+      if !total_price.nil? && total_price < 0
+        fail ArgumentError, 'invalid value for "total_price", must be greater than or equal to 0.'
+      end
+
+      @total_price = total_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] weight Value to be assigned
+    def weight=(weight)
+      if !weight.nil? && weight < 0
+        fail ArgumentError, 'invalid value for "weight", must be greater than or equal to 0.'
+      end
+
+      @weight = weight
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] weight_unit Object to be assigned
+    def weight_unit=(weight_unit)
+      validator = EnumAttributeValidator.new('String', ["kg", "g", "lb", "oz"])
+      unless validator.valid?(weight_unit)
+        fail ArgumentError, "invalid value for \"weight_unit\", must be one of #{validator.allowable_values}."
+      end
+      @weight_unit = weight_unit
+    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? && 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.nil? && 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 &&
+          sku == o.sku &&
+          name == o.name &&
+          quantity == o.quantity &&
+          unit_price == o.unit_price &&
+          total_price == o.total_price &&
+          currency == o.currency &&
+          weight == o.weight &&
+          weight_unit == o.weight_unit &&
+          variant_id == o.variant_id &&
+          product_id == o.product_id &&
+          image_url == o.image_url &&
+          hs_code == o.hs_code &&
+          country_of_origin == o.country_of_origin &&
+          province_of_origin == o.province_of_origin &&
+          barcode == o.barcode &&
+          requires_shipping == o.requires_shipping &&
+          taxable == o.taxable &&
+          gift_card == o.gift_card &&
+          vendor == o.vendor
+    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
+      [sku, name, quantity, unit_price, total_price, currency, weight, weight_unit, variant_id, product_id, image_url, hs_code, country_of_origin, province_of_origin, barcode, requires_shipping, taxable, gift_card, vendor].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