Class: SquareConnect::CatalogDiscount

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

Overview

A discount in the Catalog object model.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CatalogDiscount

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/square_connect/models/catalog_discount.rb', line 81

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?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'discount_type')
    self.discount_type = attributes[:'discount_type']
  end

  if attributes.has_key?(:'percentage')
    self.percentage = attributes[:'percentage']
  end

  if attributes.has_key?(:'amount_money')
    self.amount_money = attributes[:'amount_money']
  end

  if attributes.has_key?(:'pin_required')
    self.pin_required = attributes[:'pin_required']
  end

  if attributes.has_key?(:'label_color')
    self.label_color = attributes[:'label_color']
  end

end

Instance Attribute Details

#amount_money ⇒ Object

The amount of the discount. Specify an amount of ‘0` if `discount_type` is `VARIABLE_AMOUNT`. Do not include this field for percentage-based or variable discounts.



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

def amount_money
  @amount_money
end

#discount_type ⇒ Object

Indicates whether the discount is a fixed amount or percentage, or entered at the time of sale. See [CatalogDiscountType](#type-catalogdiscounttype) for all possible values.



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

def discount_type
  @discount_type
end

#label_color ⇒ Object

The color of the discount’s display label in the Square Point of Sale app.



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

def label_color
  @label_color
end

#name ⇒ Object

The discount’s name. Searchable.



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

def name
  @name
end

#percentage ⇒ Object

The percentage of the discount as a string representation of a decimal number, using a ‘.` as the decimal separator and without a `%` sign. A value of `7.5` corresponds to `7.5%`. Specify a percentage of `0` if `discount_type` is `VARIABLE_PERCENTAGE`. Do not include this field for amount-based or variable discounts.



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

def percentage
  @percentage
end

#pin_required ⇒ Object

Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment in the Square Point of Sale app.



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

def pin_required
  @pin_required
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/square_connect/models/catalog_discount.rb', line 56

def self.attribute_map
  {
    :'name' => :'name',
    :'discount_type' => :'discount_type',
    :'percentage' => :'percentage',
    :'amount_money' => :'amount_money',
    :'pin_required' => :'pin_required',
    :'label_color' => :'label_color'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/square_connect/models/catalog_discount.rb', line 68

def self.swagger_types
  {
    :'name' => :'String',
    :'discount_type' => :'String',
    :'percentage' => :'String',
    :'amount_money' => :'Money',
    :'pin_required' => :'BOOLEAN',
    :'label_color' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/square_connect/models/catalog_discount.rb', line 164

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      discount_type == o.discount_type &&
      percentage == o.percentage &&
      amount_money == o.amount_money &&
      pin_required == o.pin_required &&
      label_color == o.label_color
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



211
212
213
214
215
216
217
218
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
 
# File 'lib/square_connect/models/catalog_discount.rb', line 211

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



277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/square_connect/models/catalog_discount.rb', line 277

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/square_connect/models/catalog_discount.rb', line 190

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


177
178
179
 
# File 'lib/square_connect/models/catalog_discount.rb', line 177

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



183
184
185
 
# File 'lib/square_connect/models/catalog_discount.rb', line 183

def hash
  [name, discount_type, percentage, amount_money, pin_required, label_color].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



115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/square_connect/models/catalog_discount.rb', line 115

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push("invalid value for 'name', name cannot be nil.")
  end

  if @name.to_s.length < 1
    invalid_properties.push("invalid value for 'name', the character length must be great than or equal to 1.")
  end

  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



257
258
259
 
# File 'lib/square_connect/models/catalog_discount.rb', line 257

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



263
264
265
266
267
268
269
270
271
 
# File 'lib/square_connect/models/catalog_discount.rb', line 263

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



251
252
253
 
# File 'lib/square_connect/models/catalog_discount.rb', line 251

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



130
131
132
133
134
135
136
 
# File 'lib/square_connect/models/catalog_discount.rb', line 130

def valid?
  return false if @name.nil?
  return false if @name.to_s.length < 1
  discount_type_validator = EnumAttributeValidator.new('String', ["FIXED_PERCENTAGE", "FIXED_AMOUNT", "VARIABLE_PERCENTAGE", "VARIABLE_AMOUNT"])
  return false unless discount_type_validator.valid?(@discount_type)
  return true
end