Class: Norbelys::WarmupSettings

Inherits:
Object
  • Object
show all
Defined in:
lib/norbelys/models/warmup_settings.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WarmupSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/norbelys/models/warmup_settings.rb', line 135

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

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

  if attributes.key?(:'daily_max')
    self.daily_max = attributes[:'daily_max']
  else
    self.daily_max = nil
  end

  if attributes.key?(:'daily_target')
    self.daily_target = attributes[:'daily_target']
  else
    self.daily_target = nil
  end

  if attributes.key?(:'enabled')
    self.enabled = attributes[:'enabled']
  else
    self.enabled = nil
  end

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

  if attributes.key?(:'rampup_enabled')
    self.rampup_enabled = attributes[:'rampup_enabled']
  else
    self.rampup_enabled = nil
  end

  if attributes.key?(:'rampup_increment')
    self.rampup_increment = attributes[:'rampup_increment']
  else
    self.rampup_increment = nil
  end

  if attributes.key?(:'reply_rate')
    self.reply_rate = attributes[:'reply_rate']
  else
    self.reply_rate = nil
  end

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

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

  if attributes.key?(:'weekdays_only')
    self.weekdays_only = attributes[:'weekdays_only']
  else
    self.weekdays_only = nil
  end

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

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

Instance Attribute Details

#auto_adjust ⇒ Object

Automatically adapt warmup volume and matching over time.



19
20
21
 
# File 'lib/norbelys/models/warmup_settings.rb', line 19

def auto_adjust
  @auto_adjust
end

#custom_templates ⇒ Object

Your own copy to warm — used for a share of daily openers.



22
23
24
 
# File 'lib/norbelys/models/warmup_settings.rb', line 22

def custom_templates
  @custom_templates
end

#daily_max ⇒ Object

Ramp ceiling (max warmup sends per day).



25
26
27
 
# File 'lib/norbelys/models/warmup_settings.rb', line 25

def daily_max
  @daily_max
end

#daily_target ⇒ Object

Warmup sends targeted today.



28
29
30
 
# File 'lib/norbelys/models/warmup_settings.rb', line 28

def daily_target
  @daily_target
end

#enabled ⇒ Object

Whether warmup is active for this mailbox.



31
32
33
 
# File 'lib/norbelys/models/warmup_settings.rb', line 31

def enabled
  @enabled
end

#language ⇒ Object

Language for stock warmup conversations: English or Spanish (default en).



34
35
36
 
# File 'lib/norbelys/models/warmup_settings.rb', line 34

def language
  @language
end

#rampup_enabled ⇒ Object

Grow the daily target over time.



37
38
39
 
# File 'lib/norbelys/models/warmup_settings.rb', line 37

def rampup_enabled
  @rampup_enabled
end

#rampup_increment ⇒ Object

Daily increase applied to the target while ramping.



40
41
42
 
# File 'lib/norbelys/models/warmup_settings.rb', line 40

def rampup_increment
  @rampup_increment
end

#reply_rate ⇒ Object

Fraction of warmup mail replied to, from 0 to 1.



43
44
45
 
# File 'lib/norbelys/models/warmup_settings.rb', line 43

def reply_rate
  @reply_rate
end

#timezone ⇒ Object

IANA timezone the sending window is evaluated in.



46
47
48
 
# File 'lib/norbelys/models/warmup_settings.rb', line 46

def timezone
  @timezone
end

#topics ⇒ Object

Optional topics woven into stock warmup openers.



49
50
51
 
# File 'lib/norbelys/models/warmup_settings.rb', line 49

def topics
  @topics
end

#weekdays_only ⇒ Object

Skip weekends.



52
53
54
 
# File 'lib/norbelys/models/warmup_settings.rb', line 52

def weekdays_only
  @weekdays_only
end

#window_from ⇒ Object

Window open, "HH:MM" in the mailbox timezone.



55
56
57
 
# File 'lib/norbelys/models/warmup_settings.rb', line 55

def window_from
  @window_from
end

#window_to ⇒ Object

Window close, "HH:MM" in the mailbox timezone.



58
59
60
 
# File 'lib/norbelys/models/warmup_settings.rb', line 58

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



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/norbelys/models/warmup_settings.rb', line 475

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 = Norbelys.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



103
104
105
 
# File 'lib/norbelys/models/warmup_settings.rb', line 103

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/norbelys/models/warmup_settings.rb', line 83

def self.attribute_map
  {
    :'auto_adjust' => :'autoAdjust',
    :'custom_templates' => :'customTemplates',
    :'daily_max' => :'dailyMax',
    :'daily_target' => :'dailyTarget',
    :'enabled' => :'enabled',
    :'language' => :'language',
    :'rampup_enabled' => :'rampupEnabled',
    :'rampup_increment' => :'rampupIncrement',
    :'reply_rate' => :'replyRate',
    :'timezone' => :'timezone',
    :'topics' => :'topics',
    :'weekdays_only' => :'weekdaysOnly',
    :'window_from' => :'windowFrom',
    :'window_to' => :'windowTo'
  }
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



451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/norbelys/models/warmup_settings.rb', line 451

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



128
129
130
131
 
# File 'lib/norbelys/models/warmup_settings.rb', line 128

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

.openapi_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/norbelys/models/warmup_settings.rb', line 108

def self.openapi_types
  {
    :'auto_adjust' => :'Boolean',
    :'custom_templates' => :'Array<WarmupTemplate>',
    :'daily_max' => :'Integer',
    :'daily_target' => :'Integer',
    :'enabled' => :'Boolean',
    :'language' => :'String',
    :'rampup_enabled' => :'Boolean',
    :'rampup_increment' => :'Integer',
    :'reply_rate' => :'Float',
    :'timezone' => :'String',
    :'topics' => :'Array<String>',
    :'weekdays_only' => :'Boolean',
    :'window_from' => :'String',
    :'window_to' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/norbelys/models/warmup_settings.rb', line 417

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      auto_adjust == o.auto_adjust &&
      custom_templates == o.custom_templates &&
      daily_max == o.daily_max &&
      daily_target == o.daily_target &&
      enabled == o.enabled &&
      language == o.language &&
      rampup_enabled == o.rampup_enabled &&
      rampup_increment == o.rampup_increment &&
      reply_rate == o.reply_rate &&
      timezone == o.timezone &&
      topics == o.topics &&
      weekdays_only == o.weekdays_only &&
      window_from == o.window_from &&
      window_to == o.window_to
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



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/norbelys/models/warmup_settings.rb', line 546

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


438
439
440
 
# File 'lib/norbelys/models/warmup_settings.rb', line 438

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



444
445
446
 
# File 'lib/norbelys/models/warmup_settings.rb', line 444

def hash
  [auto_adjust, custom_templates, daily_max, daily_target, enabled, language, rampup_enabled, rampup_increment, reply_rate, timezone, topics, weekdays_only, window_from, window_to].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



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
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
 
# File 'lib/norbelys/models/warmup_settings.rb', line 227

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @auto_adjust.nil?
    invalid_properties.push('invalid value for "auto_adjust", auto_adjust cannot be nil.')
  end

  if !@custom_templates.nil? && @custom_templates.length > 5
    invalid_properties.push('invalid value for "custom_templates", number of items must be less than or equal to 5.')
  end

  if @daily_max.nil?
    invalid_properties.push('invalid value for "daily_max", daily_max cannot be nil.')
  end

  if @daily_max < 0
    invalid_properties.push('invalid value for "daily_max", must be greater than or equal to 0.')
  end

  if @daily_target.nil?
    invalid_properties.push('invalid value for "daily_target", daily_target cannot be nil.')
  end

  if @daily_target < 0
    invalid_properties.push('invalid value for "daily_target", must be greater than or equal to 0.')
  end

  if @enabled.nil?
    invalid_properties.push('invalid value for "enabled", enabled cannot be nil.')
  end

  if @rampup_enabled.nil?
    invalid_properties.push('invalid value for "rampup_enabled", rampup_enabled cannot be nil.')
  end

  if @rampup_increment.nil?
    invalid_properties.push('invalid value for "rampup_increment", rampup_increment cannot be nil.')
  end

  if @rampup_increment < 0
    invalid_properties.push('invalid value for "rampup_increment", must be greater than or equal to 0.')
  end

  if @reply_rate.nil?
    invalid_properties.push('invalid value for "reply_rate", reply_rate cannot be nil.')
  end

  if @reply_rate > 1
    invalid_properties.push('invalid value for "reply_rate", must be smaller than or equal to 1.')
  end

  if @reply_rate < 0
    invalid_properties.push('invalid value for "reply_rate", must be greater than or equal to 0.')
  end

  if !@topics.nil? && @topics.length > 8
    invalid_properties.push('invalid value for "topics", number of items must be less than or equal to 8.')
  end

  if @weekdays_only.nil?
    invalid_properties.push('invalid value for "weekdays_only", weekdays_only cannot be nil.')
  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



522
523
524
 
# File 'lib/norbelys/models/warmup_settings.rb', line 522

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



528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/norbelys/models/warmup_settings.rb', line 528

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



516
517
518
 
# File 'lib/norbelys/models/warmup_settings.rb', line 516

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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/norbelys/models/warmup_settings.rb', line 295

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @auto_adjust.nil?
  return false if !@custom_templates.nil? && @custom_templates.length > 5
  return false if @daily_max.nil?
  return false if @daily_max < 0
  return false if @daily_target.nil?
  return false if @daily_target < 0
  return false if @enabled.nil?
  language_validator = EnumAttributeValidator.new('String', ["en", "es"])
  return false unless language_validator.valid?(@language)
  return false if @rampup_enabled.nil?
  return false if @rampup_increment.nil?
  return false if @rampup_increment < 0
  return false if @reply_rate.nil?
  return false if @reply_rate > 1
  return false if @reply_rate < 0
  return false if !@topics.nil? && @topics.length > 8
  return false if @weekdays_only.nil?
  true
end