Class: Ifeelgoods::PromotionDetailsRewardsInner

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/ifeelgoods/models/promotion_details_rewards_inner.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ PromotionDetailsRewardsInner

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/ifeelgoods/models/promotion_details_rewards_inner.rb', line 99

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

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

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

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

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

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

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

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

Instance Attribute Details

#name ⇒ Object

Uggy Gift Card 10€



19
20
21
 
# File 'lib/ifeelgoods/models/promotion_details_rewards_inner.rb', line 19

def name
  @name
end

#sku ⇒ Object

Unique identifier that represents the reward (eg. APP-ITC-10USD-US). It must be used with the redeem APIs.



22
23
24
 
# File 'lib/ifeelgoods/models/promotion_details_rewards_inner.rb', line 22

def sku
  @sku
end

#state ⇒ Object

Current availability outcome of the offer based on its setup and availability checks. This field explains why an offer can or cannot be used at the moment.



28
29
30
 
# File 'lib/ifeelgoods/models/promotion_details_rewards_inner.rb', line 28

def state
  @state
end

#status ⇒ Object

Current lifecycle status of the offer (enabled, paused, disabled). Use this field to understand whether the offer is currently intended to be active for your program.



25
26
27
 
# File 'lib/ifeelgoods/models/promotion_details_rewards_inner.rb', line 25

def status
  @status
end

#usages ⇒ Object

Returns the value of attribute usages.



33
34
35
 
# File 'lib/ifeelgoods/models/promotion_details_rewards_inner.rb', line 33

def usages
  @usages
end

#variable_value ⇒ Object

Indicates whether the reward should be redeemed with a value. Range can be found in dimensions.available_denominations_range.



31
32
33
 
# File 'lib/ifeelgoods/models/promotion_details_rewards_inner.rb', line 31

def variable_value
  @variable_value
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



70
71
72
 
# File 'lib/ifeelgoods/models/promotion_details_rewards_inner.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/ifeelgoods/models/promotion_details_rewards_inner.rb', line 75

def self.acceptable_attributes
  acceptable_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/ifeelgoods/models/promotion_details_rewards_inner.rb', line 58

def self.attribute_map
  {
    :'name' => :'name',
    :'sku' => :'sku',
    :'status' => :'status',
    :'state' => :'state',
    :'variable_value' => :'variable_value',
    :'usages' => :'usages'
  }
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



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

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



92
93
94
95
 
# File 'lib/ifeelgoods/models/promotion_details_rewards_inner.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/ifeelgoods/models/promotion_details_rewards_inner.rb', line 80

def self.openapi_types
  {
    :'name' => :'String',
    :'sku' => :'String',
    :'status' => :'String',
    :'state' => :'String',
    :'variable_value' => :'Boolean',
    :'usages' => :'Array<String>'
  }
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
 
# File 'lib/ifeelgoods/models/promotion_details_rewards_inner.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      sku == o.sku &&
      status == o.status &&
      state == o.state &&
      variable_value == o.variable_value &&
      usages == o.usages
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


194
195
196
 
# File 'lib/ifeelgoods/models/promotion_details_rewards_inner.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



200
201
202
 
# File 'lib/ifeelgoods/models/promotion_details_rewards_inner.rb', line 200

def hash
  [name, sku, status, state, variable_value, usages].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/ifeelgoods/models/promotion_details_rewards_inner.rb', line 142

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/ifeelgoods/models/promotion_details_rewards_inner.rb', line 229

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

#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/ifeelgoods/models/promotion_details_rewards_inner.rb', line 150

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  status_validator = EnumAttributeValidator.new('String', ["disabled", "enabled", "paused"])
  return false unless status_validator.valid?(@status)
  state_validator = EnumAttributeValidator.new('String', ["invalid_reward", "temporarily_unavailable", "invalid_reward_for_redemption_flow", "no_allocation", "ready"])
  return false unless state_validator.valid?(@state)
  true
end