Class: VoucherifySdk::ClientQualificationsCheckEligibilityRequestBody

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

Overview

Request body schema for POST ‘/qualifications`.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ClientQualificationsCheckEligibilityRequestBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
131
132
133
134
135
136
137
138
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 98

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VoucherifySdk::ClientQualificationsCheckEligibilityRequestBody` 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::ClientQualificationsCheckEligibilityRequestBody`. 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?(:'customer')
    self.customer = attributes[:'customer']
  end

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

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

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

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

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

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

Instance Attribute Details

#customer ⇒ Object

Returns the value of attribute customer.



19
20
21
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 19

def customer
  @customer
end

#metadata ⇒ Object

A set of key/value pairs that you can send in the request body to check against redeemables requiring redemption metadata validation rules to be satisfied. The validation runs against rules that are defined through the <!– [Create Validation Rules](docs.voucherify.io/reference/create-validation-rules) –>[Create Validation Rules](ref:create-validation-rules) endpoint or via the Dashboard; in the _Advanced Rule Builder_ &rarr; Advanced &rarr; _Redemption metadata satisfy_ or _Basic Builder_ &rarr; _Attributes match_ &rarr; _REDEMPTION METADATA_. [Read more](support.voucherify.io/article/148-how-to-build-a-rule).



35
36
37
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 35

def metadata
  @metadata
end

#mode ⇒ Object

Defines which resources Voucherify will use. The ‘ADVANCED` mode is available after purchase only.



24
25
26
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 24

def mode
  @mode
end

#options ⇒ Object

Returns the value of attribute options.



32
33
34
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 32

def options
  @options
end

#order ⇒ Object

Returns the value of attribute order.



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

def order
  @order
end

#scenario ⇒ Object

Defines the scenario Voucherify should consider during the qualification process. - ‘ALL` - Scenario that returns all redeemables available for the customer in one API request. This scenario is used by default when no value is selected. - `CUSTOMER_WALLET` - returns vouchers applicable to the customer’s cart based on the vouchers assigned to the customer’s profile. - `AUDIENCE_ONLY` - returns all vouchers, promotion tiers, and campaigns available to the customer. Voucherify validates the rules based on the customer profile only. - `PRODUCTS` - returns all promotions available for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule). - `PRODUCTS_DISCOUNT` - returns all promotions available for products when a discount is defined as applicable to specific item(s). - `PROMOTION_STACKS` - returns the applicable promotion stacks. - `PRODUCTS_BY_CUSTOMER` - returns all promotions available for a customer for the products (when a discount is defined to be applied to the item or when the item is required in the validation rule). - `PRODUCTS_DISCOUNT_BY_CUSTOMER` - returns all promotions available for a customer for products when a discount is defined as applicable to specific item(s).



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

def scenario
  @scenario
end

#tracking_id ⇒ Object

Is correspondent to Customer’s source_id



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

def tracking_id
  @tracking_id
end

Class Method Details

._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



232
233
234
235
236
237
238
239
240
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
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 232

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



73
74
75
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 73

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 60

def self.attribute_map
  {
    :'customer' => :'customer',
    :'order' => :'order',
    :'mode' => :'mode',
    :'tracking_id' => :'tracking_id',
    :'scenario' => :'scenario',
    :'options' => :'options',
    :'metadata' => :'metadata'
  }
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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 208

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



91
92
93
94
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 91

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 78

def self.openapi_types
  {
    :'customer' => :'Customer',
    :'order' => :'Order',
    :'mode' => :'String',
    :'tracking_id' => :'String',
    :'scenario' => :'String',
    :'options' => :'QualificationsOption',
    :'metadata' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      customer == o.customer &&
      order == o.order &&
      mode == o.mode &&
      tracking_id == o.tracking_id &&
      scenario == o.scenario &&
      options == o.options &&
      metadata == o.metadata
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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 303

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


195
196
197
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 195

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



201
202
203
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 201

def hash
  [customer, order, mode, tracking_id, scenario, options, metadata].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



142
143
144
145
146
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 142

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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



279
280
281
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 279

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



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

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

Returns:

  • (String) —

    String presentation of the object



273
274
275
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 273

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



150
151
152
153
154
155
156
157
 
# File 'lib/VoucherifySdk/models/client_qualifications_check_eligibility_request_body.rb', line 150

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  mode_validator = EnumAttributeValidator.new('String', ["BASIC", "ADVANCED"])
  return false unless mode_validator.valid?(@mode)
  scenario_validator = EnumAttributeValidator.new('String', ["ALL", "CUSTOMER_WALLET", "AUDIENCE_ONLY", "PRODUCTS", "PRODUCTS_DISCOUNT", "PROMOTION_STACKS", "PRODUCTS_BY_CUSTOMER", "PRODUCTS_DISCOUNT_BY_CUSTOMER"])
  return false unless scenario_validator.valid?(@scenario)
  true
end