Class: Tremendous::CreateOrderRequestReward

Inherits:
Object
  • Object
show all
Defined in:
lib/tremendous/models/create_order_request_reward.rb

Overview

A single reward, sent to a recipient. A reward is always part of an order. Either ‘products` or `campaign_id` must be specified.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOrderRequestReward

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
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
127
128
129
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 81

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

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

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

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

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

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

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

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

Instance Attribute Details

#campaign_id ⇒ Object

ID of the campaign in your account, that defines the available products (different gift cards, charity, etc.) that the recipient can choose from.



20
21
22
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 20

def campaign_id
  @campaign_id
end

#custom_fields ⇒ Object

Returns the value of attribute custom_fields.



32
33
34
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 32

def custom_fields
  @custom_fields
end

#deliver_at ⇒ Object

Timestamp of reward delivery within the next year. Note that if date-time is provided, the time values will be ignored.



30
31
32
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 30

def deliver_at
  @deliver_at
end

#delivery ⇒ Object

Returns the value of attribute delivery.



37
38
39
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 37

def delivery
  @delivery
end

#language ⇒ Object

Set this to translate the redemption experience for this reward. Pass a 2-letter [ISO-639-1 code](en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for the desired language. Defaults to ‘en`.



35
36
37
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 35

def language
  @language
end

#products ⇒ Object

List of IDs of product (different gift cards, charity, etc.) that will be available to the recipient to choose from. Providing a ‘products` array will override the products made available by the campaign specified using the `campaign_id` property unless the `products` array is empty. It will not override other campaign attributes, like the message and customization of the look and feel.



23
24
25
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 23

def products
  @products
end

#recipient ⇒ Object

Returns the value of attribute recipient.



27
28
29
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 27

def recipient
  @recipient
end

#value ⇒ Object

Returns the value of attribute value.



25
26
27
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 25

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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 257

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 = Tremendous.const_get(type)
    klass.respond_to?(:openapi_any_of) || 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



54
55
56
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 54

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 40

def self.attribute_map
  {
    :'campaign_id' => :'campaign_id',
    :'products' => :'products',
    :'value' => :'value',
    :'recipient' => :'recipient',
    :'deliver_at' => :'deliver_at',
    :'custom_fields' => :'custom_fields',
    :'language' => :'language',
    :'delivery' => :'delivery'
  }
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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 233

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



73
74
75
76
77
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 73

def self.openapi_nullable
  Set.new([
    :'campaign_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'campaign_id' => :'String',
    :'products' => :'Array<String>',
    :'value' => :'ListRewards200ResponseRewardsInnerValue',
    :'recipient' => :'ListRewards200ResponseRewardsInnerRecipient',
    :'deliver_at' => :'Date',
    :'custom_fields' => :'Array<ListRewards200ResponseRewardsInnerCustomFieldsInner>',
    :'language' => :'String',
    :'delivery' => :'CreateOrderRequestRewardDelivery'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 205

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      campaign_id == o.campaign_id &&
      products == o.products &&
      value == o.value &&
      recipient == o.recipient &&
      deliver_at == o.deliver_at &&
      custom_fields == o.custom_fields &&
      language == o.language &&
      delivery == o.delivery
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



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 328

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


220
221
222
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



226
227
228
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 226

def hash
  [campaign_id, products, value, recipient, deliver_at, custom_fields, language, delivery].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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 133

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/[A-Z0-9]{4,20}/)
  if !@campaign_id.nil? && @campaign_id !~ pattern
    invalid_properties.push("invalid value for \"campaign_id\", must conform to the pattern #{pattern}.")
  end

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

  pattern = Regexp.new(/YYYY-MM-DD/)
  if !@deliver_at.nil? && @deliver_at !~ pattern
    invalid_properties.push("invalid value for \"deliver_at\", must conform to the pattern #{pattern}.")
  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



304
305
306
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 304

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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 310

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



298
299
300
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 298

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



155
156
157
158
159
160
161
 
# File 'lib/tremendous/models/create_order_request_reward.rb', line 155

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@campaign_id.nil? && @campaign_id !~ Regexp.new(/[A-Z0-9]{4,20}/)
  return false if !@products.nil? && @products.length < 1
  return false if !@deliver_at.nil? && @deliver_at !~ Regexp.new(/YYYY-MM-DD/)
  true
end