Class: AsposeEmailCloud::YearlyRecurrencePatternDto

Inherits:
RecurrencePatternDto show all
Defined in:
lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb

Overview

Yearly recurrence pattern.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(interval: nil, occurs: nil, end_date: nil, week_start: nil, start_day: nil, start_month: nil, start_offset: nil, start_position: nil) ⇒ YearlyRecurrencePatternDto

Initializes the object

Parameters:

  • interval (Integer) (defaults to: nil) —

    Number of recurrence units.

  • occurs (Integer) (defaults to: nil) —

    Number of occurrences of the recurrence pattern.

  • end_date (DateTime) (defaults to: nil) —

    End date.

  • week_start (String) (defaults to: nil) —

    Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay

  • start_day (String) (defaults to: nil) —

    Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay

  • start_month (String) (defaults to: nil) —

    Represents a calendar month. Enum, available values: None, January, February, March, April, May, June, July, August, September, October, November, December

  • start_offset (Integer) (defaults to: nil) —

    Start offset.

  • start_position (String) (defaults to: nil) —

    Day positions, typically found in a month. Enum, available values: None, First, Second, Third, Fourth, Last



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 101

def initialize(
  interval: nil,
  occurs: nil,
  end_date: nil,
  week_start: nil,
  start_day: nil,
  start_month: nil,
  start_offset: nil,
  start_position: nil)
  self.interval = interval if interval
  self.occurs = occurs if occurs
  self.end_date = end_date if end_date
  self.week_start = week_start if week_start
  self.start_day = start_day if start_day
  self.start_month = start_month if start_month
  self.start_offset = start_offset if start_offset
  self.start_position = start_position if start_position
end

Instance Attribute Details

#end_date ⇒ DateTime

End date.

Returns:

  • (DateTime) 


39
40
41
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 39

def end_date
  @end_date
end

#interval ⇒ Integer

Number of recurrence units.

Returns:

  • (Integer) 


33
34
35
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 33

def interval
  @interval
end

#occurs ⇒ Integer

Number of occurrences of the recurrence pattern.

Returns:

  • (Integer) 


36
37
38
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 36

def occurs
  @occurs
end

#start_day ⇒ String

Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay

Returns:

  • (String) 


52
53
54
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 52

def start_day
  @start_day
end

#start_month ⇒ String

Represents a calendar month. Enum, available values: None, January, February, March, April, May, June, July, August, September, October, November, December

Returns:

  • (String) 


55
56
57
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 55

def start_month
  @start_month
end

#start_offset ⇒ Integer

Start offset.

Returns:

  • (Integer) 


58
59
60
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 58

def start_offset
  @start_offset
end

#start_position ⇒ String

Day positions, typically found in a month. Enum, available values: None, First, Second, Third, Fourth, Last

Returns:

  • (String) 


61
62
63
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 61

def start_position
  @start_position
end

#week_start ⇒ String

Represents the day of the week. Enum, available values: None, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Day, WeekDay, WeekendDay

Returns:

  • (String) 


42
43
44
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 42

def week_start
  @week_start
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 63

def self.attribute_map
  {
    :'interval' => :'interval',
    :'occurs' => :'occurs',
    :'end_date' => :'endDate',
    :'week_start' => :'weekStart',
    :'discriminator' => :'discriminator',
    :'start_day' => :'startDay',
    :'start_month' => :'startMonth',
    :'start_offset' => :'startOffset',
    :'start_position' => :'startPosition'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 78

def self.swagger_types
  {
    :'interval' => :'Integer',
    :'occurs' => :'Integer',
    :'end_date' => :'DateTime',
    :'week_start' => :'String',
    :'discriminator' => :'String',
    :'start_day' => :'String',
    :'start_month' => :'String',
    :'start_offset' => :'Integer',
    :'start_position' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 180

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      interval == o.interval &&
      occurs == o.occurs &&
      end_date == o.end_date &&
      week_start == o.week_start &&
      discriminator == o.discriminator &&
      start_day == o.start_day &&
      start_month == o.start_month &&
      start_offset == o.start_offset &&
      start_position == o.start_position
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



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
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 232

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
    sub_type = value[:type] || value[:discriminator] || type
    if AsposeEmailCloud.const_defined?(sub_type)
      type = sub_type
    end
    temp_model = AsposeEmailCloud.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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 302

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 209

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    attribute_key = self.class.attribute_map[key]
    attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
    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[attribute_key].is_a?(Array)
        self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_key].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_key]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#discriminator ⇒ Object

getter method



43
44
45
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 43

def discriminator #getter method
  self.class.name.split('::').last
end

#discriminator=(discriminator) ⇒ Object

setter method, parameter ignored



47
48
49
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 47

def discriminator=(discriminator) #setter method, parameter ignored
  @discriminator = self.class.name.split('::').last
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


196
197
198
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 196

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



202
203
204
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 202

def hash
  [interval, occurs, end_date, week_start, discriminator, start_day, start_month, start_offset, start_position].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



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
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 122

def list_invalid_properties
  invalid_properties = Array.new
  if @interval.nil?
    invalid_properties.push('invalid value for "interval", interval cannot be nil.')
  end

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

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

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

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

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

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

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

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



282
283
284
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 282

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



288
289
290
291
292
293
294
295
296
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 288

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



276
277
278
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 276

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



165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/aspose-email-cloud/models/yearly_recurrence_pattern_dto.rb', line 165

def valid?
  return false if @interval.nil?
  return false if @occurs.nil?
  return false if @end_date.nil?
  return false if @week_start.nil?
  return false if @discriminator.nil?
  return false if @start_day.nil?
  return false if @start_month.nil?
  return false if @start_offset.nil?
  return false if @start_position.nil?
  true
end