class VoucherifySdk::InapplicableTo
Attributes
Maximum discount amount per order. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount on the entire order is written as 600. This value is definable for the following discount effects: - ‘APPLY_TO_ITEMS` (each item subtotal is discounted equally) - `APPLY_TO_ITEMS_BY_QUANTITY` (each unit of matched products has the same discount value)
The maximum number of units allowed to be discounted combined across all matched order line items.
Upper limit allowed to be applied as a discount per order line item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $6 maximum discount is written as 600.
Unique product collection, product, or SKU identifier assigned by Voucherify.
This object stores information about the resource to which the discount is applicable.
Determines the order in which the discount is applied to the products or SKUs sent in the ‘order` object in the request. The counting begins from `0`.
New fixed price of an item. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 price is written as 1000. In case of the fixed price being calculated by the formula, i.e. the price_formula
parameter is present in the fixed price definition, this value becomes the fallback value. Such that in a case where the formula cannot be calculated due to missing metadata, for example, this value will be used as the fixed price.
Formula used to calculate the discounted price of an item.
Parent product’s unique ID assigned by Voucherify.
Parent product’s source ID from your inventory system.
The maximum number of units allowed to be discounted per order line item.
Determines the recurrence of the discount, e.g. ‘"repeat": 3` means that the discount is applied to every third item.
Determines how many items are skipped before the discount is applied.
The source identifier from your inventory system.
Determines to which kinds of objects the discount is applicable. ‘"ITEM"` includes products and SKUs.
Public Class Methods
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/VoucherifySdk/models/inapplicable_to.rb, line 328 def self._deserialize(type, value) case type.to_sym when :Time Time.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<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\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 # models (e.g. Pet) or oneOf klass = VoucherifySdk.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Returns all the JSON keys this model knows about
# File lib/VoucherifySdk/models/inapplicable_to.rb, line 113 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/VoucherifySdk/models/inapplicable_to.rb, line 90 def self.attribute_map { :'object' => :'object', :'id' => :'id', :'source_id' => :'source_id', :'product_id' => :'product_id', :'product_source_id' => :'product_source_id', :'strict' => :'strict', :'price' => :'price', :'price_formula' => :'price_formula', :'effect' => :'effect', :'quantity_limit' => :'quantity_limit', :'aggregated_quantity_limit' => :'aggregated_quantity_limit', :'amount_limit' => :'amount_limit', :'aggregated_amount_limit' => :'aggregated_amount_limit', :'order_item_indices' => :'order_item_indices', :'repeat' => :'repeat', :'skip_initially' => :'skip_initially', :'target' => :'target' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/VoucherifySdk/models/inapplicable_to.rb, line 304 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/VoucherifySdk/models/inapplicable_to.rb, line 164 def initialize(attributes = {}) # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.key?(:'object') self.object = attributes[:'object'] end if attributes.key?(:'id') self.id = attributes[:'id'] end if attributes.key?(:'source_id') self.source_id = attributes[:'source_id'] end if attributes.key?(:'product_id') self.product_id = attributes[:'product_id'] end if attributes.key?(:'product_source_id') self.product_source_id = attributes[:'product_source_id'] end if attributes.key?(:'strict') self.strict = attributes[:'strict'] end if attributes.key?(:'price') self.price = attributes[:'price'] end if attributes.key?(:'price_formula') self.price_formula = attributes[:'price_formula'] end if attributes.key?(:'effect') self.effect = attributes[:'effect'] else self.effect = nil end if attributes.key?(:'quantity_limit') self.quantity_limit = attributes[:'quantity_limit'] end if attributes.key?(:'aggregated_quantity_limit') self.aggregated_quantity_limit = attributes[:'aggregated_quantity_limit'] end if attributes.key?(:'amount_limit') self.amount_limit = attributes[:'amount_limit'] end if attributes.key?(:'aggregated_amount_limit') self.aggregated_amount_limit = attributes[:'aggregated_amount_limit'] end if attributes.key?(:'order_item_indices') if (value = attributes[:'order_item_indices']).is_a?(Array) self.order_item_indices = value end end if attributes.key?(:'repeat') self.repeat = attributes[:'repeat'] end if attributes.key?(:'skip_initially') self.skip_initially = attributes[:'skip_initially'] end if attributes.key?(:'target') self.target = attributes[:'target'] end end
List of attributes with nullable: true
# File lib/VoucherifySdk/models/inapplicable_to.rb, line 141 def self.openapi_nullable Set.new([ :'object', :'id', :'source_id', :'product_id', :'product_source_id', :'strict', :'price', :'price_formula', :'quantity_limit', :'aggregated_quantity_limit', :'amount_limit', :'aggregated_amount_limit', :'order_item_indices', :'repeat', :'skip_initially', :'target' ]) end
Attribute type mapping.
# File lib/VoucherifySdk/models/inapplicable_to.rb, line 118 def self.openapi_types { :'object' => :'String', :'id' => :'String', :'source_id' => :'String', :'product_id' => :'String', :'product_source_id' => :'String', :'strict' => :'Boolean', :'price' => :'Float', :'price_formula' => :'Float', :'effect' => :'ApplicableToEffect', :'quantity_limit' => :'Integer', :'aggregated_quantity_limit' => :'Integer', :'amount_limit' => :'Integer', :'aggregated_amount_limit' => :'Integer', :'order_item_indices' => :'Array<Integer>', :'repeat' => :'Integer', :'skip_initially' => :'Integer', :'target' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/VoucherifySdk/models/inapplicable_to.rb, line 267 def ==(o) return true if self.equal?(o) self.class == o.class && object == o.object && id == o.id && source_id == o.source_id && product_id == o.product_id && product_source_id == o.product_source_id && strict == o.strict && price == o.price && price_formula == o.price_formula && effect == o.effect && quantity_limit == o.quantity_limit && aggregated_quantity_limit == o.aggregated_quantity_limit && amount_limit == o.amount_limit && aggregated_amount_limit == o.aggregated_amount_limit && order_item_indices == o.order_item_indices && repeat == o.repeat && skip_initially == o.skip_initially && target == o.target 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
# File lib/VoucherifySdk/models/inapplicable_to.rb, line 399 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/VoucherifySdk/models/inapplicable_to.rb, line 291 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/VoucherifySdk/models/inapplicable_to.rb, line 297 def hash [object, id, source_id, product_id, product_source_id, strict, price, price_formula, effect, quantity_limit, aggregated_quantity_limit, amount_limit, aggregated_amount_limit, order_item_indices, repeat, skip_initially, target].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/VoucherifySdk/models/inapplicable_to.rb, line 245 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if @effect.nil? invalid_properties.push('invalid value for "effect", effect cannot be nil.') end invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/VoucherifySdk/models/inapplicable_to.rb, line 381 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/VoucherifySdk/models/inapplicable_to.rb, line 369 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/VoucherifySdk/models/inapplicable_to.rb, line 257 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' object_validator = EnumAttributeValidator.new('String', ["product", "sku", "products_collection"]) return false unless object_validator.valid?(@object) return false if @effect.nil? true end