Class: VoucherifySdk::ValidationRulesCreateRequestBody

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

Overview

Request body schema for POST ‘/validation-rules`.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ValidationRulesCreateRequestBody

Initializes the object



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
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 101

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VoucherifySdk::ValidationRulesCreateRequestBody` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `VoucherifySdk::ValidationRulesCreateRequestBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

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

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

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

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'expression'
  end

  if attributes.key?(:'context_type')
    self.context_type = attributes[:'context_type']
  else
    self.context_type = 'global'
  end
end

Instance Attribute Details

#applicable_to ⇒ Object

Returns the value of attribute applicable_to.



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

def applicable_to
  @applicable_to
end

#context_type ⇒ Object

Validation rule context type. | **Context Type** | Definition | |:—|:—| | earning_rule.order.paid | | | earning_rule.custom_event | | | earning_rule.customer.segment.entered | | | campaign.discount_coupons | | | campaign.discount_coupons.discount.apply_to_order | | | campaign.discount_coupons.discount.apply_to_items | | | campaign.discount_coupons.discount.apply_to_items_proportionally | | | campaign.discount_coupons.discount.apply_to_items_proportionally_by_quantity | | | campaign.discount_coupons.discount.fixed.apply_to_items | | | campaign.gift_vouchers | | | campaign.gift_vouchers.gift.apply_to_order | | | campaign.gift_vouchers.gift.apply_to_items | | | campaign.referral_program | | | campaign.referral_program.discount.apply_to_order | | | campaign.referral_program.discount.apply_to_items | | | campaign.referral_program.discount.apply_to_items_proportionally | | | campaign.referral_program.discount.apply_to_items_proportionally_by_quantity | | | campaign.referral_program.discount.fixed.apply_to_items | | | campaign.promotion | | | campaign.promotion.discount.apply_to_order | | | campaign.promotion.discount.apply_to_items | | | campaign.promotion.discount.apply_to_items_proportionally | | | campaign.promotion.discount.apply_to_items_proportionally_by_quantity | | | campaign.promotion.discount.fixed.apply_to_items | | | campaign.loyalty_program | | | campaign.lucky_draw | | | voucher.discount_voucher | | | voucher.discount_voucher.discount.apply_to_order | | | voucher.discount_voucher.discount.apply_to_items | | | voucher.discount_voucher.discount.apply_to_items_proportionally | | | voucher.discount_voucher.discount.apply_to_items_proportionally_by_quantity | | | voucher.discount_voucher.discount.fixed.apply_to_items | | | voucher.gift_voucher | | | voucher.gift_voucher.gift.apply_to_order | | | voucher.gift_voucher.gift.apply_to_items | | | voucher.loyalty_card | | | voucher.lucky_draw_code | | | distribution.custom_event | | | reward_assignment.pay_with_points | | | global | |



33
34
35
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 33

def context_type
  @context_type
end

#error ⇒ Object

Returns the value of attribute error.



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

def error
  @error
end

#name ⇒ Object

Custom, unique name for set of validation rules.



20
21
22
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 20

def name
  @name
end

#rules ⇒ Object

Contains all the rule definitions for the validation rule. It is a set of key value pairs representing the rules and logic between the rules. The keys are numbered consecutively beginning from ‘1`. The values are objects containing the rule conditions.



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

def rules
  @rules
end

#type ⇒ Object

Type of validation rule.



30
31
32
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 30

def type
  @type
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 241

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



70
71
72
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'name' => :'name',
    :'rules' => :'rules',
    :'error' => :'error',
    :'applicable_to' => :'applicable_to',
    :'type' => :'type',
    :'context_type' => :'context_type'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 217

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



93
94
95
96
97
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 93

def self.openapi_all_of
  [
  :'ValidationRuleBase'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



87
88
89
90
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 87

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'name' => :'String',
    :'rules' => :'Object',
    :'error' => :'ValidationRuleBaseError',
    :'applicable_to' => :'ValidationRuleBaseApplicableTo',
    :'type' => :'String',
    :'context_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 191

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      rules == o.rules &&
      error == o.error &&
      applicable_to == o.applicable_to &&
      type == o.type &&
      context_type == o.context_type
end

#_to_hash(value) ⇒ Hash

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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 312

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


204
205
206
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



210
211
212
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 210

def hash
  [name, rules, error, applicable_to, type, context_type].hash
end

#list_invalid_properties ⇒ Object

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



147
148
149
150
151
152
153
154
155
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 147

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



288
289
290
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 288

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 294

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



282
283
284
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 282

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



159
160
161
162
163
164
165
166
167
 
# File 'lib/VoucherifySdk/models/validation_rules_create_request_body.rb', line 159

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  type_validator = EnumAttributeValidator.new('String', ["expression", "basic", "advanced", "complex"])
  return false unless type_validator.valid?(@type)
  context_type_validator = EnumAttributeValidator.new('String', ["earning_rule.order.paid", "earning_rule.custom_event", "earning_rule.customer.segment.entered", "earning_rule.customer.tier.joined", "earning_rule.customer.tier.left", "earning_rule.customer.tier.upgraded", "earning_rule.customer.tier.downgraded", "earning_rule.customer.tier.prolonged", "campaign.discount_coupons", "campaign.discount_coupons.discount.apply_to_order", "campaign.discount_coupons.discount.apply_to_items", "campaign.discount_coupons.discount.apply_to_items_proportionally", "campaign.discount_coupons.discount.apply_to_items_proportionally_by_quantity", "campaign.discount_coupons.discount.apply_to_items_by_quantity", "campaign.discount_coupons.discount.fixed.apply_to_items", "campaign.discount_coupons.discount.percent.apply_to_items", "campaign.gift_vouchers", "campaign.gift_vouchers.gift.apply_to_order", "campaign.gift_vouchers.gift.apply_to_items", "campaign.referral_program", "campaign.referral_program.discount.apply_to_order", "campaign.referral_program.discount.apply_to_items", "campaign.referral_program.discount.apply_to_items_proportionally", "campaign.referral_program.discount.apply_to_items_proportionally_by_quantity", "campaign.referral_program.discount.apply_to_items_by_quantity", "campaign.referral_program.discount.fixed.apply_to_items", "campaign.referral_program.discount.percent.apply_to_items", "campaign.promotion", "campaign.promotion.discount.apply_to_order", "campaign.promotion.discount.apply_to_items", "campaign.promotion.discount.apply_to_items_proportionally", "campaign.promotion.discount.apply_to_items_proportionally_by_quantity", "campaign.promotion.discount.apply_to_items_by_quantity", "campaign.promotion.discount.fixed.apply_to_items", "campaign.promotion.discount.percent.apply_to_items", "campaign.loyalty_program", "campaign.lucky_draw", "voucher.discount_voucher", "voucher.discount_voucher.discount.apply_to_order", "voucher.discount_voucher.discount.apply_to_items", "voucher.discount_voucher.discount.apply_to_items_proportionally", "voucher.discount_voucher.discount.apply_to_items_proportionally_by_quantity", "voucher.discount_voucher.discount.apply_to_items_by_quantity", "voucher.discount_voucher.discount.fixed.apply_to_items", "voucher.discount_voucher.discount.percent.apply_to_items", "voucher.gift_voucher", "voucher.gift_voucher.gift.apply_to_order", "voucher.gift_voucher.gift.apply_to_items", "voucher.loyalty_card", "voucher.lucky_draw_code", "distribution.custom_event", "distribution.order.paid", "distribution.order.created", "distribution.order.canceled", "distribution.order.updated", "reward_assignment.pay_with_points", "global"])
  return false unless context_type_validator.valid?(@context_type)
  true
end