Class: VoucherifySdk::LoyaltiesEarningRulesCreateRequestBodyItemLoyalty

Inherits:
Object
  • Object
show all
Defined in:
lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoyaltiesEarningRulesCreateRequestBodyItemLoyalty

Initializes the object



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
130
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 97

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

  if attributes.key?(:'points')
    self.points = attributes[:'points']
  end

  if attributes.key?(:'calculation_type')
    self.calculation_type = attributes[:'calculation_type']
  end

  if attributes.key?(:'order')
    self.order = attributes[:'order']
  end

  if attributes.key?(:'order_items')
    self.order_items = attributes[:'order_items']
  end

  if attributes.key?(:'customer')
    self.customer = attributes[:'customer']
  end

  if attributes.key?(:'custom_event')
    self.custom_event = attributes[:'custom_event']
  end
end

Instance Attribute Details

#calculation_type ⇒ Object

Returns the value of attribute calculation_type.



23
24
25
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 23

def calculation_type
  @calculation_type
end

#custom_event ⇒ Object

Returns the value of attribute custom_event.



31
32
33
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 31

def custom_event
  @custom_event
end

#customer ⇒ Object

Returns the value of attribute customer.



29
30
31
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 29

def customer
  @customer
end

#order ⇒ Object

Returns the value of attribute order.



25
26
27
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 25

def order
  @order
end

#order_items ⇒ Object

Returns the value of attribute order_items.



27
28
29
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 27

def order_items
  @order_items
end

#points ⇒ Object

Defines how the points will be added to the loyalty card. FIXED adds a fixed number of points.



21
22
23
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 21

def points
  @points
end

#type ⇒ Object

Returns the value of attribute type.



18
19
20
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 18

def type
  @type
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



204
205
206
207
208
209
210
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
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 204

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

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 69

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'type' => :'type',
    :'points' => :'points',
    :'calculation_type' => :'calculation_type',
    :'order' => :'order',
    :'order_items' => :'order_items',
    :'customer' => :'customer',
    :'custom_event' => :'custom_event'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 180

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



87
88
89
90
91
92
93
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 87

def self.openapi_nullable
  Set.new([
    :'points',
    :'customer',
    :'custom_event'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 74

def self.openapi_types
  {
    :'type' => :'String',
    :'points' => :'Integer',
    :'calculation_type' => :'String',
    :'order' => :'LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrder',
    :'order_items' => :'LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyOrderItems',
    :'customer' => :'LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomer',
    :'custom_event' => :'LoyaltiesEarningRulesCreateRequestBodyItemLoyaltyCustomEvent'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 153

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      points == o.points &&
      calculation_type == o.calculation_type &&
      order == o.order &&
      order_items == o.order_items &&
      customer == o.customer &&
      custom_event == o.custom_event
end

#_to_hash(value) ⇒ Hash

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



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 275

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

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


167
168
169
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 167

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



173
174
175
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 173

def hash
  [type, points, calculation_type, order, order_items, customer, custom_event].hash
end

#list_invalid_properties ⇒ Object

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



134
135
136
137
138
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 134

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



251
252
253
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 251

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 257

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

#to_s ⇒ String

Returns the string representation of the object



245
246
247
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 245

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



142
143
144
145
146
147
148
149
 
# File 'lib/VoucherifySdk/models/loyalties_earning_rules_create_request_body_item_loyalty.rb', line 142

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  type_validator = EnumAttributeValidator.new('String', ["FIXED", "PROPORTIONAL"])
  return false unless type_validator.valid?(@type)
  calculation_type_validator = EnumAttributeValidator.new('String', ["ORDER_AMOUNT", "ORDER_TOTAL_AMOUNT", "ORDER_METADATA", "ORDER_ITEMS_QUANTITY", "ORDER_ITEMS_AMOUNT", "ORDER_ITEMS_SUBTOTAL_AMOUNT", "CUSTOMER_METADATA", "CUSTOM_EVENT_METADATA"])
  return false unless calculation_type_validator.valid?(@calculation_type)
  true
end