Class: VoucherifySdk::ManagementProjectsBrandingCreateRequestBodyCockpits

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

Overview

Defines customer cockpit details.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ManagementProjectsBrandingCreateRequestBodyCockpits

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 114

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

  if attributes.key?(:'loyalty_enabled')
    self.loyalty_enabled = attributes[:'loyalty_enabled']
  else
    self.loyalty_enabled = true
  end

  if attributes.key?(:'gift_cards_enabled')
    self.gift_cards_enabled = attributes[:'gift_cards_enabled']
  else
    self.gift_cards_enabled = true
  end

  if attributes.key?(:'coupons_enabled')
    self.coupons_enabled = attributes[:'coupons_enabled']
  else
    self.coupons_enabled = true
  end

  if attributes.key?(:'referrals_enabled')
    self.referrals_enabled = attributes[:'referrals_enabled']
  else
    self.referrals_enabled = true
  end

  if attributes.key?(:'theme')
    self.theme = attributes[:'theme']
  else
    self.theme = 'default'
  end

  if attributes.key?(:'use_custom_double_opt_in_redirect_url')
    self.use_custom_double_opt_in_redirect_url = attributes[:'use_custom_double_opt_in_redirect_url']
  else
    self.use_custom_double_opt_in_redirect_url = false
  end

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

Instance Attribute Details

#campaigns_overview_enabled ⇒ Object

Enables the campaign overview for customers.



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

def campaigns_overview_enabled
  @campaigns_overview_enabled
end

#coupons_enabled ⇒ Object

Enables the discount coupon overview for customers.



29
30
31
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 29

def coupons_enabled
  @coupons_enabled
end

#custom_double_opt_in_redirect_url ⇒ Object

Defines the URL for the double opt-in consent. It must be a valid URL format.



41
42
43
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 41

def custom_double_opt_in_redirect_url
  @custom_double_opt_in_redirect_url
end

#gift_cards_enabled ⇒ Object

Enables the gift card overview for customers.



26
27
28
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 26

def gift_cards_enabled
  @gift_cards_enabled
end

#loyalty_enabled ⇒ Object

Enables the loyalty campaign overview for customers.



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

def loyalty_enabled
  @loyalty_enabled
end

#referrals_enabled ⇒ Object

Enables the referral campaign overview for customers.



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

def referrals_enabled
  @referrals_enabled
end

#theme ⇒ Object

Determines the color scheme of the customer cockpit.



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

def theme
  @theme
end

#use_custom_double_opt_in_redirect_url ⇒ Object

Enables the double opt-in option. It must be a valid URL format.



38
39
40
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 38

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 238

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



80
81
82
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'campaigns_overview_enabled' => :'campaigns_overview_enabled',
    :'loyalty_enabled' => :'loyalty_enabled',
    :'gift_cards_enabled' => :'gift_cards_enabled',
    :'coupons_enabled' => :'coupons_enabled',
    :'referrals_enabled' => :'referrals_enabled',
    :'theme' => :'theme',
    :'use_custom_double_opt_in_redirect_url' => :'use_custom_double_opt_in_redirect_url',
    :'custom_double_opt_in_redirect_url' => :'custom_double_opt_in_redirect_url'
  }
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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 214

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



99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 99

def self.openapi_nullable
  Set.new([
    :'campaigns_overview_enabled',
    :'loyalty_enabled',
    :'gift_cards_enabled',
    :'coupons_enabled',
    :'referrals_enabled',
    :'theme',
    :'use_custom_double_opt_in_redirect_url',
    :'custom_double_opt_in_redirect_url'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 85

def self.openapi_types
  {
    :'campaigns_overview_enabled' => :'Boolean',
    :'loyalty_enabled' => :'Boolean',
    :'gift_cards_enabled' => :'Boolean',
    :'coupons_enabled' => :'Boolean',
    :'referrals_enabled' => :'Boolean',
    :'theme' => :'String',
    :'use_custom_double_opt_in_redirect_url' => :'Boolean',
    :'custom_double_opt_in_redirect_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 186

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      campaigns_overview_enabled == o.campaigns_overview_enabled &&
      loyalty_enabled == o.loyalty_enabled &&
      gift_cards_enabled == o.gift_cards_enabled &&
      coupons_enabled == o.coupons_enabled &&
      referrals_enabled == o.referrals_enabled &&
      theme == o.theme &&
      use_custom_double_opt_in_redirect_url == o.use_custom_double_opt_in_redirect_url &&
      custom_double_opt_in_redirect_url == o.custom_double_opt_in_redirect_url
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



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 309

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


201
202
203
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 201

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



207
208
209
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 207

def hash
  [campaigns_overview_enabled, loyalty_enabled, gift_cards_enabled, coupons_enabled, referrals_enabled, theme, use_custom_double_opt_in_redirect_url, custom_double_opt_in_redirect_url].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



169
170
171
172
173
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 169

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



285
286
287
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 285

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



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

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



279
280
281
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 279

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



177
178
179
180
181
182
 
# File 'lib/VoucherifySdk/models/management_projects_branding_create_request_body_cockpits.rb', line 177

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  theme_validator = EnumAttributeValidator.new('String', ["blue", "dark-green", "default", "green", "grey", "orange", "purple", "red"])
  return false unless theme_validator.valid?(@theme)
  true
end