class ZoomUs::Models::RecurrenceWebinar

Recurrence object.

Attributes

end_date_time[RW]

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

end_times[RW]

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

monthly_day[RW]

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

monthly_week[RW]

The week for a webinar to recur each month.
`-1` - Last week.
`1` - First week.
`2` - Second week.
`3` - Third week.
`4` - Fourth week.

monthly_week_day[RW]

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

repeat_interval[RW]

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

type[RW]

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

weekly_days[RW]

Days of the week the webinar 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.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/zoom_us/models/recurrence_webinar.rb, line 44
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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/zoom_us/models/recurrence_webinar.rb, line 73
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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/zoom_us/models/recurrence_webinar.rb, line 58
def self.swagger_types
  {
    :'type' => :'Integer',
    :'repeat_interval' => :'Integer',
    :'weekly_days' => :'Integer',
    :'monthly_day' => :'Integer',
    :'monthly_week' => :'Integer',
    :'monthly_week_day' => :'Integer',
    :'end_times' => :'Integer',
    :'end_date_time' => :'DateTime'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/zoom_us/models/recurrence_webinar.rb, line 142
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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/zoom_us/models/recurrence_webinar.rb, line 191
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/zoom_us/models/recurrence_webinar.rb, line 257
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/zoom_us/models/recurrence_webinar.rb, line 170
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
end_times=(end_times) click to toggle source

Custom attribute writer method with validation @param [Object] end_times Value to be assigned

# File lib/zoom_us/models/recurrence_webinar.rb, line 132
def end_times=(end_times)
  if !end_times.nil? && end_times > 50
    fail ArgumentError, 'invalid value for "end_times", must be smaller than or equal to 50.'
  end

  @end_times = end_times
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/zoom_us/models/recurrence_webinar.rb, line 157
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/zoom_us/models/recurrence_webinar.rb, line 163
def hash
  [type, repeat_interval, weekly_days, monthly_day, monthly_week, monthly_week_day, end_times, end_date_time].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/zoom_us/models/recurrence_webinar.rb, line 114
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() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/zoom_us/models/recurrence_webinar.rb, line 237
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/zoom_us/models/recurrence_webinar.rb, line 243
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/zoom_us/models/recurrence_webinar.rb, line 231
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/zoom_us/models/recurrence_webinar.rb, line 125
def valid?
  return false if !@end_times.nil? && @end_times > 50
  true
end