class SquareConnect::CreateOrderRequestDiscount
__Deprecated__: Please use the [OrderLineItemDiscount](type-orderlineitemdiscount) type in the order field of [CreateOrderRequest](type-createorderrequest) instead. Represents a discount that can apply to either a single line item or an entire order.
Attributes
Only used for ad hoc discounts. The monetary amount of the discount.
Only used for catalog discounts. The catalog object ID for an existing [CatalogDiscount](type-catalogdiscount). Do not provide a value for this field if you provide values in other fields for an ad hoc discount.
Only used for ad hoc discounts. The discount's name.
Only used for ad hoc discounts. The percentage of the discount, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. This value range between 0.0 up to 100.0
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/square_connect/models/create_order_request_discount.rb, line 29 def self.attribute_map { :'catalog_object_id' => :'catalog_object_id', :'name' => :'name', :'percentage' => :'percentage', :'amount_money' => :'amount_money' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/square_connect/models/create_order_request_discount.rb, line 50 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'catalog_object_id') self.catalog_object_id = attributes[:'catalog_object_id'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'percentage') self.percentage = attributes[:'percentage'] end if attributes.has_key?(:'amount_money') self.amount_money = attributes[:'amount_money'] end end
Attribute type mapping.
# File lib/square_connect/models/create_order_request_discount.rb, line 39 def self.swagger_types { :'catalog_object_id' => :'String', :'name' => :'String', :'percentage' => :'String', :'amount_money' => :'Money' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/square_connect/models/create_order_request_discount.rb, line 137 def ==(o) return true if self.equal?(o) self.class == o.class && catalog_object_id == o.catalog_object_id && name == o.name && percentage == o.percentage && amount_money == o.amount_money end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/square_connect/models/create_order_request_discount.rb, line 182 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<(?<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 temp_model = SquareConnect.const_get(type).new temp_model.build_from_hash(value) end 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/square_connect/models/create_order_request_discount.rb, line 248 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/square_connect/models/create_order_request_discount.rb, line 161 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the 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
Custom attribute writer method with validation @param [Object] catalog_object_id
Value to be assigned
# File lib/square_connect/models/create_order_request_discount.rb, line 104 def catalog_object_id=(catalog_object_id) if !catalog_object_id.nil? && catalog_object_id.to_s.length > 192 fail ArgumentError, "invalid value for 'catalog_object_id', the character length must be smaller than or equal to 192." end @catalog_object_id = catalog_object_id end
@see the `==` method @param [Object] Object to be compared
# File lib/square_connect/models/create_order_request_discount.rb, line 148 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/square_connect/models/create_order_request_discount.rb, line 154 def hash [catalog_object_id, name, percentage, amount_money].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properies with the reasons
# File lib/square_connect/models/create_order_request_discount.rb, line 76 def list_invalid_properties invalid_properties = Array.new if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192 invalid_properties.push("invalid value for 'catalog_object_id', the character length must be smaller than or equal to 192.") end if !@name.nil? && @name.to_s.length > 255 invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 255.") end if !@percentage.nil? && @percentage.to_s.length > 10 invalid_properties.push("invalid value for 'percentage', the character length must be smaller than or equal to 10.") end return invalid_properties end
Custom attribute writer method with validation @param [Object] name Value to be assigned
# File lib/square_connect/models/create_order_request_discount.rb, line 115 def name=(name) if !name.nil? && name.to_s.length > 255 fail ArgumentError, "invalid value for 'name', the character length must be smaller than or equal to 255." end @name = name end
Custom attribute writer method with validation @param [Object] percentage Value to be assigned
# File lib/square_connect/models/create_order_request_discount.rb, line 126 def percentage=(percentage) if !percentage.nil? && percentage.to_s.length > 10 fail ArgumentError, "invalid value for 'percentage', the character length must be smaller than or equal to 10." end @percentage = percentage end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/square_connect/models/create_order_request_discount.rb, line 234 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) next if value.nil? hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/square_connect/models/create_order_request_discount.rb, line 222 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/square_connect/models/create_order_request_discount.rb, line 95 def valid? return false if !@catalog_object_id.nil? && @catalog_object_id.to_s.length > 192 return false if !@name.nil? && @name.to_s.length > 255 return false if !@percentage.nil? && @percentage.to_s.length > 10 return true end