Class: VoucherifySdk::ListPublicationsItemVoucher

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ListPublicationsItemVoucher

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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/list_publications_item_voucher.rb', line 103

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

  if attributes.key?(:'object')
    self.object = attributes[:'object']
  else
    self.object = 'voucher'
  end

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

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

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

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

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

Instance Attribute Details

#campaign ⇒ Object

Campaign name



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

def campaign
  @campaign
end

#code ⇒ Object

Voucher code.



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

def code
  @code
end

#discount ⇒ Object

Returns the value of attribute discount.



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

def discount
  @discount
end

#gift ⇒ Object

Returns the value of attribute gift.



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

def gift
  @gift
end

#is_referral_code ⇒ Object

Flag indicating whether this voucher is a referral code; ‘true` for campaign type `REFERRAL_PROGRAM`.



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

def is_referral_code
  @is_referral_code
end

#loyalty_card ⇒ Object

Defines the loyalty card details.



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

def loyalty_card
  @loyalty_card
end

#object ⇒ Object

The type of the object represented by JSON.



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

def object
  @object
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



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
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/VoucherifySdk/models/list_publications_item_voucher.rb', line 210

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/list_publications_item_voucher.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/list_publications_item_voucher.rb', line 60

def self.attribute_map
  {
    :'code' => :'code',
    :'object' => :'object',
    :'campaign' => :'campaign',
    :'gift' => :'gift',
    :'loyalty_card' => :'loyalty_card',
    :'discount' => :'discount',
    :'is_referral_code' => :'is_referral_code'
  }
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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/VoucherifySdk/models/list_publications_item_voucher.rb', line 186

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
95
96
97
98
99
 
# File 'lib/VoucherifySdk/models/list_publications_item_voucher.rb', line 91

def self.openapi_nullable
  Set.new([
    :'code',
    :'object',
    :'campaign',
    :'loyalty_card',
    :'is_referral_code'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'code' => :'String',
    :'object' => :'String',
    :'campaign' => :'String',
    :'gift' => :'Gift',
    :'loyalty_card' => :'Object',
    :'discount' => :'Discount',
    :'is_referral_code' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code == o.code &&
      object == o.object &&
      campaign == o.campaign &&
      gift == o.gift &&
      loyalty_card == o.loyalty_card &&
      discount == o.discount &&
      is_referral_code == o.is_referral_code
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



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

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


173
174
175
 
# File 'lib/VoucherifySdk/models/list_publications_item_voucher.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



179
180
181
 
# File 'lib/VoucherifySdk/models/list_publications_item_voucher.rb', line 179

def hash
  [code, object, campaign, gift, loyalty_card, discount, is_referral_code].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/list_publications_item_voucher.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



257
258
259
 
# File 'lib/VoucherifySdk/models/list_publications_item_voucher.rb', line 257

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



263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/VoucherifySdk/models/list_publications_item_voucher.rb', line 263

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



251
252
253
 
# File 'lib/VoucherifySdk/models/list_publications_item_voucher.rb', line 251

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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  object_validator = EnumAttributeValidator.new('String', ["voucher"])
  return false unless object_validator.valid?(@object)
  true
end