Class: ZoomUs::Models::UsersuserIdmeetingsRecurrence

Inherits:
Object
  • Object
show all
Defined in:
lib/zoom_us/models/usersuser_idmeetings_recurrence.rb

Overview

Recurrence object.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UsersuserIdmeetingsRecurrence

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
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 95

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'repeat_interval')
    self.repeat_interval = attributes[:'repeat_interval']
  end

  if attributes.has_key?(:'weekly_days')
    self.weekly_days = attributes[:'weekly_days']
  end

  if attributes.has_key?(:'monthly_day')
    self.monthly_day = attributes[:'monthly_day']
  end

  if attributes.has_key?(:'monthly_week')
    self.monthly_week = attributes[:'monthly_week']
  end

  if attributes.has_key?(:'monthly_week_day')
    self.monthly_week_day = attributes[:'monthly_week_day']
  end

  if attributes.has_key?(:'end_times')
    self.end_times = attributes[:'end_times']
  end

  if attributes.has_key?(:'end_date_time')
    self.end_date_time = attributes[:'end_date_time']
  end
end

Instance Attribute Details

#end_date_time ⇒ Object

Select a date the meeting will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. (Cannot be used with "end_times".)



41
42
43
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 41

def end_date_time
  @end_date_time
end

#end_times ⇒ Object

Select how many times the meeting will recur before it is canceled. (Cannot be used with "end_date_time".)



38
39
40
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 38

def end_times
  @end_times
end

#monthly_day ⇒ Object

Day in the month the meeting is to be scheduled. The value range is from 1 to 31.



29
30
31
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 29

def monthly_day
  @monthly_day
end

#monthly_week ⇒ Object

The week a meeting will recur each month.
‘-1` - Last week.
`1` - First week.
`2` - Second week.
`3` - Third week.
`4` - Fourth week.



32
33
34
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 32

def monthly_week
  @monthly_week
end

#monthly_week_day ⇒ Object

The weekday a meeting should recur each month.
‘1` - Sunday.
`2` - Monday.
`3` - Tuesday.
`4` - Wednesday.
`5` - Thursday.
`6` - Friday.
`7` - Saturday.



35
36
37
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 35

def monthly_week_day
  @monthly_week_day
end

#repeat_interval ⇒ Object

At which interval should the meeting repeat? For a daily meeting there’s a maximum of 90 days. For a weekly meeting there is a maximum of 12 weeks. For a monthly meeting there is a maximum of 3 months.



23
24
25
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 23

def repeat_interval
  @repeat_interval
end

#type ⇒ Object

Recurrence meeting types:
‘1` - Daily.
`2` - Weekly.
`3` - Monthly.



20
21
22
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 20

def type
  @type
end

#weekly_days ⇒ Object

Days of the week the meeting should repeat. Note: Multiple values should be separated by a comma.
‘1` - Sunday.
`2` - Monday.
`3` - Tuesday.
`4` - Wednesday.
`5` - Thursday.
`6` - Friday.
`7` - Saturday.



26
27
28
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 26

def weekly_days
  @weekly_days
end

Class Method Details

.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/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 66

def self.attribute_map
  {
    :'type' => :'type',
    :'repeat_interval' => :'repeat_interval',
    :'weekly_days' => :'weekly_days',
    :'monthly_day' => :'monthly_day',
    :'monthly_week' => :'monthly_week',
    :'monthly_week_day' => :'monthly_week_day',
    :'end_times' => :'end_times',
    :'end_date_time' => :'end_date_time'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 80

def self.swagger_types
  {
    :'type' => :'Integer',
    :'repeat_interval' => :'Integer',
    :'weekly_days' => :'String',
    :'monthly_day' => :'Integer',
    :'monthly_week' => :'Integer',
    :'monthly_week_day' => :'Integer',
    :'end_times' => :'Integer',
    :'end_date_time' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 176

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
    type == o.type &&
    repeat_interval == o.repeat_interval &&
    weekly_days == o.weekly_days &&
    monthly_day == o.monthly_day &&
    monthly_week == o.monthly_week &&
    monthly_week_day == o.monthly_week_day &&
    end_times == o.end_times &&
    end_date_time == o.end_date_time
end

#_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



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
257
258
259
260
261
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 225

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    ::DateTime.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
    temp_model = Models.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



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

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

#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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 204

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


191
192
193
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 191

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



197
198
199
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 197

def hash
  [type, repeat_interval, weekly_days, monthly_day, monthly_week, monthly_week_day, end_times, end_date_time].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



136
137
138
139
140
141
142
143
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 136

def list_invalid_properties
  invalid_properties = Array.new
  if !@end_times.nil? && @end_times > 50
    invalid_properties.push('invalid value for "end_times", must be smaller than or equal to 50.')
  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



271
272
273
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 271

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



277
278
279
280
281
282
283
284
285
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 277

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



265
266
267
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 265

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



147
148
149
150
151
152
 
# File 'lib/zoom_us/models/usersuser_idmeetings_recurrence.rb', line 147

def valid?
  weekly_days_validator = EnumAttributeValidator.new('String', ['1', '2', '3', '4', '5', '6', '7'])
  return false unless weekly_days_validator.valid?(@weekly_days)
  return false if !@end_times.nil? && @end_times > 50
  true
end