Class: VoucherifySdk::ValidationsValidateRequestBody

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

Overview

Response body schema for POST ‘/validations`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ValidationsValidateRequestBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 82

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

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

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

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

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

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

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

Instance Attribute Details

#customer ⇒ Object

Returns the value of attribute customer.



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

def customer
  @customer
end

#metadata ⇒ Object

A set of key/value pairs that you can attach to a redemption object. It can be useful for storing additional information about the redemption in a structured format.



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

def metadata
  @metadata
end

#options ⇒ Object

Returns the value of attribute options.



34
35
36
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 34

def options
  @options
end

#order ⇒ Object

Returns the value of attribute order.



22
23
24
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 22

def order
  @order
end

#redeemables ⇒ Object

An array of redeemables. You can combine ‘voucher`(s) and `promotion_tier`(s). Alternatively, send one unique`promotion_stack` in the array.



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

def redeemables
  @redeemables
end

#session ⇒ Object

Returns the value of attribute session.



26
27
28
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 26

def session
  @session
end

#tracking_id ⇒ Object

Is correspondent to Customer’s source_id



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

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



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
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 229

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



50
51
52
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 50

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 37

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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 205

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)



74
75
76
77
78
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 74

def self.openapi_all_of
  [
  :'StackableValidateRedeemBase'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'redeemables' => :'Array<StackableValidateRedeemBaseRedeemablesItem>',
    :'order' => :'Order',
    :'customer' => :'Customer',
    :'session' => :'Session',
    :'tracking_id' => :'String',
    :'metadata' => :'Object',
    :'options' => :'ClientValidationsValidateRequestBodyAllOfOptions'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 178

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



300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 300

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


192
193
194
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 192

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



198
199
200
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 198

def hash
  [redeemables, order, customer, session, tracking_id, metadata, options].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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 130

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

  if @redeemables.length > 5
    invalid_properties.push('invalid value for "redeemables", number of items must be less than or equal to 5.')
  end

  if @redeemables.length < 1
    invalid_properties.push('invalid value for "redeemables", number of items must be greater than or equal to 1.')
  end

  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



276
277
278
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 276

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



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 282

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



270
271
272
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 270

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
 
# File 'lib/VoucherifySdk/models/validations_validate_request_body.rb', line 150

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @redeemables.nil?
  return false if @redeemables.length > 5
  return false if @redeemables.length < 1
  true
end