=begin #Talon.One API #Use the Talon.One API to integrate with your application and to manage applications and campaigns: - Use the operations in the [Integration API section](#integration-api) are used to integrate with our platform - Use the operation in the [Management API section](#management-api) to manage applications and campaigns. ## Determining the base URL of the endpoints The API is available at the same hostname as your Campaign Manager deployment. For example, if you access the Campaign Manager at `https://yourbaseurl.talon.one/`, the URL for the [updateCustomerSessionV2](https://docs.talon.one/integration-api#operation/updateCustomerSessionV2) endpoint is `https://yourbaseurl.talon.one/v2/customer_sessions/{Id}` The version of the OpenAPI document: Generated by: https://openapi-generator.tech OpenAPI Generator version: 4.3.1 =end require 'date' module TalonOne class CartItem # Name of item. attr_accessor :name # Stock keeping unit of item. attr_accessor :sku # Number of units of this item. Due to [cart item flattening](https://docs.talon.one/docs/product/rules/understanding-cart-item-flattening), if you provide a quantity greater than 1, the item will be split in as many items as the provided quantity. This will impact the number of **per-item** effects triggered from your campaigns. attr_accessor :quantity # Number of returned items, calculated internally based on returns of this item. attr_accessor :returned_quantity # Remaining quantity of the item, calculated internally based on returns of this item. attr_accessor :remaining_quantity # Price of the item in the currency defined by your Application. This field is required if this item is not part of a [catalog](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs). If it is part of a catalog, setting a price here overrides the price from the catalog. attr_accessor :price # Type, group or model of the item. attr_accessor :category attr_accessor :product # Weight of item in grams. attr_accessor :weight # Height of item in mm. attr_accessor :height # Width of item in mm. attr_accessor :width # Length of item in mm. attr_accessor :length # Position of the Cart Item in the Cart (calculated internally). attr_accessor :position # Use this property to set a value for the attributes of your choice. [Attributes](https://docs.talon.one/docs/dev/concepts/attributes) represent any information to attach to this cart item. Custom _cart item_ attributes must be created in the Campaign Manager before you set them with this property. **Note:** Any previously defined attributes that you do not include in the array will be removed. attr_accessor :attributes # Use this property to set a value for the additional costs of this item, such as a shipping cost. They must be created in the Campaign Manager before you set them with this property. See [Managing additional costs](https://docs.talon.one/docs/product/account/dev-tools/managing-additional-costs). attr_accessor :additional_costs # The [catalog item ID](https://docs.talon.one/docs/product/account/dev-tools/managing-cart-item-catalogs/#synchronizing-a-cart-item-catalog). attr_accessor :catalog_item_id # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { :'name' => :'name', :'sku' => :'sku', :'quantity' => :'quantity', :'returned_quantity' => :'returnedQuantity', :'remaining_quantity' => :'remainingQuantity', :'price' => :'price', :'category' => :'category', :'product' => :'product', :'weight' => :'weight', :'height' => :'height', :'width' => :'width', :'length' => :'length', :'position' => :'position', :'attributes' => :'attributes', :'additional_costs' => :'additionalCosts', :'catalog_item_id' => :'catalogItemID' } end # Attribute type mapping. def self.openapi_types { :'name' => :'String', :'sku' => :'String', :'quantity' => :'Integer', :'returned_quantity' => :'Integer', :'remaining_quantity' => :'Integer', :'price' => :'Float', :'category' => :'String', :'product' => :'Product', :'weight' => :'Float', :'height' => :'Float', :'width' => :'Float', :'length' => :'Float', :'position' => :'Float', :'attributes' => :'Object', :'additional_costs' => :'Hash', :'catalog_item_id' => :'Integer' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ ]) 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 `TalonOne::CartItem` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::CartItem`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'sku') self.sku = attributes[:'sku'] end if attributes.key?(:'quantity') self.quantity = attributes[:'quantity'] end if attributes.key?(:'returned_quantity') self.returned_quantity = attributes[:'returned_quantity'] end if attributes.key?(:'remaining_quantity') self.remaining_quantity = attributes[:'remaining_quantity'] end if attributes.key?(:'price') self.price = attributes[:'price'] end if attributes.key?(:'category') self.category = attributes[:'category'] end if attributes.key?(:'product') self.product = attributes[:'product'] end if attributes.key?(:'weight') self.weight = attributes[:'weight'] end if attributes.key?(:'height') self.height = attributes[:'height'] end if attributes.key?(:'width') self.width = attributes[:'width'] end if attributes.key?(:'length') self.length = attributes[:'length'] end if attributes.key?(:'position') self.position = attributes[:'position'] end if attributes.key?(:'attributes') self.attributes = attributes[:'attributes'] end if attributes.key?(:'additional_costs') if (value = attributes[:'additional_costs']).is_a?(Hash) self.additional_costs = value end end if attributes.key?(:'catalog_item_id') self.catalog_item_id = attributes[:'catalog_item_id'] 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 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 great than or equal to 1.') end if @quantity.nil? invalid_properties.push('invalid value for "quantity", quantity cannot be nil.') end if @quantity < 1 invalid_properties.push('invalid value for "quantity", must be greater than or equal to 1.') 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? return false if @sku.nil? return false if @sku.to_s.length < 1 return false if @quantity.nil? return false if @quantity < 1 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 great 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 < 1 fail ArgumentError, 'invalid value for "quantity", must be greater than or equal to 1.' end @quantity = quantity 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 && name == o.name && sku == o.sku && quantity == o.quantity && returned_quantity == o.returned_quantity && remaining_quantity == o.remaining_quantity && price == o.price && category == o.category && product == o.product && weight == o.weight && height == o.height && width == o.width && length == o.length && position == o.position && attributes == o.attributes && additional_costs == o.additional_costs && catalog_item_id == o.catalog_item_id 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 [name, sku, quantity, returned_quantity, remaining_quantity, price, category, product, weight, height, width, length, position, attributes, additional_costs, catalog_item_id].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) new.build_from_hash(attributes) end # Builds the object from hash # @param [Hash] attributes Model attributes in the form of hash # @return [Object] Returns the model itself def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if 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[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end # Deserializes the data based on type # @param string type Data type # @param string value Value to be deserialized # @return [Object] Deserialized data def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?.+?), (?.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model TalonOne.const_get(type).build_from_hash(value) end end # Returns the string representation of the object # @return [String] String presentation of the object def to_s to_hash.to_s end # to_body is an alias to to_hash (backward compatibility) # @return [Hash] Returns the object in the form of hash def to_body to_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 # Outputs non-array value in the form of hash # For object, use to_hash. Otherwise, just return the value # @param [Object] value Any valid value # @return [Hash] Returns the value in the form of hash def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end end end