Class: ConnectWise::TimePeriodSetup

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/models/time_period_setup.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TimePeriodSetup

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
166
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 104

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity



38
39
40
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 38

def _info
  @_info
end

#days_past_end_date ⇒ Object

Returns the value of attribute days_past_end_date.



35
36
37
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 35

def days_past_end_date
  @days_past_end_date
end

#description ⇒ Object

Returns the value of attribute description.



17
18
19
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 17

def description
  @description
end

#first_period_end_date ⇒ Object

Returns the value of attribute first_period_end_date.



19
20
21
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 19

def first_period_end_date
  @first_period_end_date
end

#id ⇒ Object

Returns the value of attribute id.



7
8
9
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 7

def id
  @id
end

#last_day_flag ⇒ Object

Only needed when type is monthly



33
34
35
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 33

def last_day_flag
  @last_day_flag
end

#monthly_period_ends ⇒ Object

Only needed when type is monthly



22
23
24
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 22

def monthly_period_ends
  @monthly_period_ends
end

#number_future_periods ⇒ Object

Returns the value of attribute number_future_periods.



13
14
15
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 13

def number_future_periods
  @number_future_periods
end

#period_apply_to ⇒ Object

Returns the value of attribute period_apply_to.



9
10
11
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 9

def period_apply_to
  @period_apply_to
end

#semi_monthly_first_period ⇒ Object

Only needed when type is semi-monthly



25
26
27
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 25

def semi_monthly_first_period
  @semi_monthly_first_period
end

#semi_monthly_last_day_flag ⇒ Object

Returns the value of attribute semi_monthly_last_day_flag.



30
31
32
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 30

def semi_monthly_last_day_flag
  @semi_monthly_last_day_flag
end

#semi_monthly_second_period ⇒ Object

Only needed when type is semi-monthly



28
29
30
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 28

def semi_monthly_second_period
  @semi_monthly_second_period
end

#type ⇒ Object

Returns the value of attribute type.



15
16
17
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 15

def type
  @type
end

#year ⇒ Object

Returns the value of attribute year.



11
12
13
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 11

def year
  @year
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
76
77
78
79
80
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 63

def self.attribute_map
  {
    :'id' => :'id',
    :'period_apply_to' => :'periodApplyTo',
    :'year' => :'year',
    :'number_future_periods' => :'numberFuturePeriods',
    :'type' => :'type',
    :'description' => :'description',
    :'first_period_end_date' => :'firstPeriodEndDate',
    :'monthly_period_ends' => :'monthlyPeriodEnds',
    :'semi_monthly_first_period' => :'semiMonthlyFirstPeriod',
    :'semi_monthly_second_period' => :'semiMonthlySecondPeriod',
    :'semi_monthly_last_day_flag' => :'semiMonthlyLastDayFlag',
    :'last_day_flag' => :'lastDayFlag',
    :'days_past_end_date' => :'daysPastEndDate',
    :'_info' => :'_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'Integer',
    :'period_apply_to' => :'String',
    :'year' => :'Integer',
    :'number_future_periods' => :'Integer',
    :'type' => :'String',
    :'description' => :'String',
    :'first_period_end_date' => :'String',
    :'monthly_period_ends' => :'Integer',
    :'semi_monthly_first_period' => :'Integer',
    :'semi_monthly_second_period' => :'Integer',
    :'semi_monthly_last_day_flag' => :'BOOLEAN',
    :'last_day_flag' => :'BOOLEAN',
    :'days_past_end_date' => :'Integer',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 253

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      period_apply_to == o.period_apply_to &&
      year == o.year &&
      number_future_periods == o.number_future_periods &&
      type == o.type &&
      description == o.description &&
      first_period_end_date == o.first_period_end_date &&
      monthly_period_ends == o.monthly_period_ends &&
      semi_monthly_first_period == o.semi_monthly_first_period &&
      semi_monthly_second_period == o.semi_monthly_second_period &&
      semi_monthly_last_day_flag == o.semi_monthly_last_day_flag &&
      last_day_flag == o.last_day_flag &&
      days_past_end_date == o.days_past_end_date &&
      _info == o._info
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



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 308

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



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 374

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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 287

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


274
275
276
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 274

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



280
281
282
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 280

def hash
  [id, period_apply_to, year, number_future_periods, type, description, first_period_end_date, monthly_period_ends, semi_monthly_first_period, semi_monthly_second_period, semi_monthly_last_day_flag, last_day_flag, days_past_end_date, _info].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



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
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 170

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

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

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

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

  if !@description.nil? && @description.to_s.length > 100
    invalid_properties.push("invalid value for 'description', the character length must be smaller than or equal to 100.")
  end

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

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

  return 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



354
355
356
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 354

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



360
361
362
363
364
365
366
367
368
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 360

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



348
349
350
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 348

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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/connectwise-ruby-sdk/models/time_period_setup.rb', line 205

def valid?
  return false if @period_apply_to.nil?
  period_apply_to_validator = EnumAttributeValidator.new('String', ["Time", "Expense", "Both"])
  return false unless period_apply_to_validator.valid?(@period_apply_to)
  return false if @year.nil?
  return false if @number_future_periods.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["Weekly", "BiWeekly", "SemiMonthly", "Monthly"])
  return false unless type_validator.valid?(@type)
  return false if !@description.nil? && @description.to_s.length > 100
  return false if @first_period_end_date.nil?
  return false if @days_past_end_date.nil?
  return true
end