class SquareConnect::V1Discount
Attributes
The amount of the discount. This amount is 0 if discount_type
is VARIABLE_AMOUNT. This field is not included for rate-based discounts.
The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1DiscountColor](type-v1discountcolor) for possible values
Indicates whether the discount is a FIXED value or entered at the time of sale. See [V1DiscountDiscountType](type-v1discountdiscounttype) for possible values
The discount's unique ID.
The discount's name.
Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment.
The rate of the discount, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. This rate is 0 if discount_type
is VARIABLE_PERCENTAGE.
The ID of the CatalogObject
in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/square_connect/models/v1_discount.rb, line 41 def self.attribute_map { :'id' => :'id', :'name' => :'name', :'rate' => :'rate', :'amount_money' => :'amount_money', :'discount_type' => :'discount_type', :'pin_required' => :'pin_required', :'color' => :'color', :'v2_id' => :'v2_id' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/square_connect/models/v1_discount.rb, line 70 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?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'rate') self.rate = attributes[:'rate'] end if attributes.has_key?(:'amount_money') self.amount_money = attributes[:'amount_money'] end if attributes.has_key?(:'discount_type') self.discount_type = attributes[:'discount_type'] end if attributes.has_key?(:'pin_required') self.pin_required = attributes[:'pin_required'] end if attributes.has_key?(:'color') self.color = attributes[:'color'] end if attributes.has_key?(:'v2_id') self.v2_id = attributes[:'v2_id'] end end
Attribute type mapping.
# File lib/square_connect/models/v1_discount.rb, line 55 def self.swagger_types { :'id' => :'String', :'name' => :'String', :'rate' => :'String', :'amount_money' => :'V1Money', :'discount_type' => :'String', :'pin_required' => :'BOOLEAN', :'color' => :'String', :'v2_id' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/square_connect/models/v1_discount.rb, line 125 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && name == o.name && rate == o.rate && amount_money == o.amount_money && discount_type == o.discount_type && pin_required == o.pin_required && color == o.color && v2_id == o.v2_id 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/v1_discount.rb, line 174 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/v1_discount.rb, line 240 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/v1_discount.rb, line 153 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
@see the `==` method @param [Object] Object to be compared
# File lib/square_connect/models/v1_discount.rb, line 140 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/square_connect/models/v1_discount.rb, line 146 def hash [id, name, rate, amount_money, discount_type, pin_required, color, v2_id].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/v1_discount.rb, line 112 def list_invalid_properties invalid_properties = Array.new return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/square_connect/models/v1_discount.rb, line 226 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/v1_discount.rb, line 214 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/v1_discount.rb, line 119 def valid? return true end