Class: VoucherifySdk::CampaignsUpdatePromotionCampaign

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignsUpdatePromotionCampaign

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 95

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#category ⇒ Object

The category assigned to the campaign. Either pass this parameter OR the ‘category_id`.



33
34
35
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 33

def category
  @category
end

#category_id ⇒ Object

Unique category ID that this campaign belongs to. Either pass this parameter OR the ‘category`.



42
43
44
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 42

def category_id
  @category_id
end

#description ⇒ Object

An optional field to keep any extra textual information about the campaign such as a campaign description and details.



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

def description
  @description
end

#expiration_date ⇒ Object

Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is *inactive after* this date.



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

def expiration_date
  @expiration_date
end

#metadata ⇒ Object

The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format.



36
37
38
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 36

def metadata
  @metadata
end

#start_date ⇒ Object

Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is *inactive before* this date.



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

def start_date
  @start_date
end

#unset_metadata_fields ⇒ Object

Determine which metadata should be removed from campaign.



39
40
41
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 39

def unset_metadata_fields
  @unset_metadata_fields
end

#validity_day_of_week ⇒ Object

Integer array corresponding to the particular days of the week in which the campaign is valid. - ‘0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday



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

def validity_day_of_week
  @validity_day_of_week
end

#validity_timeframe ⇒ Object

Returns the value of attribute validity_timeframe.



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

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



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
248
249
250
251
252
253
254
255
256
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 219

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



60
61
62
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 60

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 45

def self.attribute_map
  {
    :'start_date' => :'start_date',
    :'expiration_date' => :'expiration_date',
    :'validity_timeframe' => :'validity_timeframe',
    :'validity_day_of_week' => :'validity_day_of_week',
    :'description' => :'description',
    :'category' => :'category',
    :'metadata' => :'metadata',
    :'unset_metadata_fields' => :'unset_metadata_fields',
    :'category_id' => :'category_id'
  }
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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 195

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)



87
88
89
90
91
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 87

def self.openapi_all_of
  [
  :'CampaignsUpdateBase'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



80
81
82
83
84
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 80

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

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 65

def self.openapi_types
  {
    :'start_date' => :'Time',
    :'expiration_date' => :'Time',
    :'validity_timeframe' => :'CampaignBaseValidityTimeframe',
    :'validity_day_of_week' => :'Array<Integer>',
    :'description' => :'String',
    :'category' => :'String',
    :'metadata' => :'Object',
    :'unset_metadata_fields' => :'Array<String>',
    :'category_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 166

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      start_date == o.start_date &&
      expiration_date == o.expiration_date &&
      validity_timeframe == o.validity_timeframe &&
      validity_day_of_week == o.validity_day_of_week &&
      description == o.description &&
      category == o.category &&
      metadata == o.metadata &&
      unset_metadata_fields == o.unset_metadata_fields &&
      category_id == o.category_id
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



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 290

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


182
183
184
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 182

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



188
189
190
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 188

def hash
  [start_date, expiration_date, validity_timeframe, validity_day_of_week, description, category, metadata, unset_metadata_fields, category_id].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



151
152
153
154
155
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 151

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



266
267
268
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 266

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



272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 272

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



260
261
262
 
# File 'lib/VoucherifySdk/models/campaigns_update_promotion_campaign.rb', line 260

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end