Class: SquareConnect::V1Discount

Inherits:
Object
  • Object
show all
Defined in:
lib/square_connect/models/v1_discount.rb

Overview

V1Discount

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ V1Discount

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/square_connect/models/v1_discount.rb', line 91

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

Instance Attribute Details

#amount_money ⇒ Object

The amount of the discount. This amount is 0 if discount_type is VARIABLE_AMOUNT. This field is not included for rate-based discounts.



25
26
27
 
# File 'lib/square_connect/models/v1_discount.rb', line 25

def amount_money
  @amount_money
end

#color ⇒ Object

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



34
35
36
 
# File 'lib/square_connect/models/v1_discount.rb', line 34

def color
  @color
end

#discount_type ⇒ Object

Indicates whether the discount is a FIXED value or entered at the time of sale. See [V1DiscountDiscountType](#type-v1discountdiscounttype) for possible values



28
29
30
 
# File 'lib/square_connect/models/v1_discount.rb', line 28

def discount_type
  @discount_type
end

#id ⇒ Object

The discount’s unique ID.



16
17
18
 
# File 'lib/square_connect/models/v1_discount.rb', line 16

def id
  @id
end

#name ⇒ Object

The discount’s name.



19
20
21
 
# File 'lib/square_connect/models/v1_discount.rb', line 19

def name
  @name
end

#pin_required ⇒ Object

Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment.



31
32
33
 
# File 'lib/square_connect/models/v1_discount.rb', line 31

def pin_required
  @pin_required
end

#rate ⇒ Object

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.



22
23
24
 
# File 'lib/square_connect/models/v1_discount.rb', line 22

def rate
  @rate
end

#v2_id ⇒ Object

The ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.



37
38
39
 
# File 'lib/square_connect/models/v1_discount.rb', line 37

def v2_id
  @v2_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/square_connect/models/v1_discount.rb', line 62

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

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/square_connect/models/v1_discount.rb', line 76

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/square_connect/models/v1_discount.rb', line 170

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

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/square_connect/models/v1_discount.rb', line 219

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

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/square_connect/models/v1_discount.rb', line 285

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/square_connect/models/v1_discount.rb', line 198

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


185
186
187
 
# File 'lib/square_connect/models/v1_discount.rb', line 185

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



191
192
193
 
# File 'lib/square_connect/models/v1_discount.rb', line 191

def hash
  [id, name, rate, amount_money, discount_type, pin_required, color, v2_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



133
134
135
136
 
# File 'lib/square_connect/models/v1_discount.rb', line 133

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



265
266
267
 
# File 'lib/square_connect/models/v1_discount.rb', line 265

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



271
272
273
274
275
276
277
278
279
 
# File 'lib/square_connect/models/v1_discount.rb', line 271

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



259
260
261
 
# File 'lib/square_connect/models/v1_discount.rb', line 259

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



140
141
142
143
144
145
146
 
# File 'lib/square_connect/models/v1_discount.rb', line 140

def valid?
  discount_type_validator = EnumAttributeValidator.new('String', ["FIXED", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"])
  return false unless discount_type_validator.valid?(@discount_type)
  color_validator = EnumAttributeValidator.new('String', ["9da2a6", "4ab200", "0b8000", "2952cc", "a82ee5", "e5457a", "b21212", "593c00", "e5BF00"])
  return false unless color_validator.valid?(@color)
  return true
end