Class: VoucherifySdk::QualificationsOption

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

Overview

Configure parameters returned in the response.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ QualificationsOption

Initializes the object



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

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

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

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

  if attributes.key?(:'expand')
    if (value = attributes[:'expand']).is_a?(Array)
      self.expand = value
    end
  end

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

Instance Attribute Details

#expand ⇒ Object

The expand array lets you configure the parameters included in the response. Depending on the strings included in the array, the response will contain different details. | **Expand Option** | **Response Body** | |:—|:—| | [‘"redeemable"`] | Returns the redeemables’:
- metadata
- redeemable name,
- campaign name,
- campaign ID| | [‘"category"`] | - Returns an expanded `categories` object, showing details about the category. | | [`"validation_rules"`] | - Returns an expanded `validation_rules` object, showing details about the validation rules. |



28
29
30
 
# File 'lib/VoucherifySdk/models/qualifications_option.rb', line 28

def expand
  @expand
end

#filters ⇒ Object

Returns the value of attribute filters.



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

def filters
  @filters
end

#limit ⇒ Object

The maximum number of redeemables to be returned in the API request. The actual number of returned redeemables will be determined by the API. The default value is set to 5



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

def limit
  @limit
end

#sorting_rule ⇒ Object

Is used to determine the order in which data is displayed in the result array. - ‘DEFAULT` - Sorting descending by `created_at` - `BEST_DEAL` - Sorting descending by `total_applied_discount_amount` - `LEAST_DEAL` - Sorting ascending by `total_applied_discount_amount`



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

def sorting_rule
  @sorting_rule
end

#starting_after ⇒ Object

Cursor used for paging.



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

def starting_after
  @starting_after
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



197
198
199
200
201
202
203
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
 
# File 'lib/VoucherifySdk/models/qualifications_option.rb', line 197

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



67
68
69
 
# File 'lib/VoucherifySdk/models/qualifications_option.rb', line 67

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

def self.attribute_map
  {
    :'limit' => :'limit',
    :'starting_after' => :'starting_after',
    :'filters' => :'filters',
    :'expand' => :'expand',
    :'sorting_rule' => :'sorting_rule'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/VoucherifySdk/models/qualifications_option.rb', line 173

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



83
84
85
86
87
88
89
90
91
 
# File 'lib/VoucherifySdk/models/qualifications_option.rb', line 83

def self.openapi_nullable
  Set.new([
    :'limit',
    :'starting_after',
    :'filters',
    :'expand',
    :'sorting_rule'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



72
73
74
75
76
77
78
79
80
 
# File 'lib/VoucherifySdk/models/qualifications_option.rb', line 72

def self.openapi_types
  {
    :'limit' => :'Integer',
    :'starting_after' => :'Time',
    :'filters' => :'QualificationsOptionFilters',
    :'expand' => :'Array<String>',
    :'sorting_rule' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      limit == o.limit &&
      starting_after == o.starting_after &&
      filters == o.filters &&
      expand == o.expand &&
      sorting_rule == o.sorting_rule
end

#_to_hash(value) ⇒ Hash

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



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/VoucherifySdk/models/qualifications_option.rb', line 268

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


160
161
162
 
# File 'lib/VoucherifySdk/models/qualifications_option.rb', line 160

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



166
167
168
 
# File 'lib/VoucherifySdk/models/qualifications_option.rb', line 166

def hash
  [limit, starting_after, filters, expand, sorting_rule].hash
end

#list_invalid_properties ⇒ Object

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



126
127
128
129
130
131
132
133
134
 
# File 'lib/VoucherifySdk/models/qualifications_option.rb', line 126

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@limit.nil? && @limit > 100
    invalid_properties.push('invalid value for "limit", must be smaller than or equal to 100.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



244
245
246
 
# File 'lib/VoucherifySdk/models/qualifications_option.rb', line 244

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/VoucherifySdk/models/qualifications_option.rb', line 250

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



238
239
240
 
# File 'lib/VoucherifySdk/models/qualifications_option.rb', line 238

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



138
139
140
141
142
143
144
 
# File 'lib/VoucherifySdk/models/qualifications_option.rb', line 138

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@limit.nil? && @limit > 100
  sorting_rule_validator = EnumAttributeValidator.new('String', ["BEST_DEAL", "LEAST_DEAL", "DEFAULT"])
  return false unless sorting_rule_validator.valid?(@sorting_rule)
  true
end