Class: ConnectWise::TimePeriodSetup

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/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

Raises:

  • (ArgumentError) 


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
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 117

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::TimePeriodSetup` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `ConnectWise::TimePeriodSetup`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.period_apply_to = attributes[:period_apply_to] if attributes.key?(:period_apply_to)

  self.year = attributes[:year] if attributes.key?(:year)

  self.number_future_periods = attributes[:number_future_periods] if attributes.key?(:number_future_periods)

  self.type = attributes[:type] if attributes.key?(:type)

  self.first_period_end_date = attributes[:first_period_end_date] if attributes.key?(:first_period_end_date)

  self.days_past_end_date = attributes[:days_past_end_date] if attributes.key?(:days_past_end_date)

  self.id = attributes[:id] if attributes.key?(:id)

  self.description = attributes[:description] if attributes.key?(:description)

  self.monthly_period_ends = attributes[:monthly_period_ends] if attributes.key?(:monthly_period_ends)

  self.semi_monthly_first_period = attributes[:semi_monthly_first_period] if attributes.key?(:semi_monthly_first_period)

  self.semi_monthly_second_period = attributes[:semi_monthly_second_period] if attributes.key?(:semi_monthly_second_period)

  self.semi_monthly_last_day_flag = attributes[:semi_monthly_last_day_flag] if attributes.key?(:semi_monthly_last_day_flag)

  self.last_day_flag = attributes[:last_day_flag] if attributes.key?(:last_day_flag)

  return unless attributes.key?(:_info)
  return unless (value = attributes[:_info]).is_a?(Hash)

  self._info = value
end

Instance Attribute Details

#_info ⇒ Object

Returns the value of attribute _info.



16
17
18
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 16

def _info
  @_info
end

#days_past_end_date ⇒ Object

Returns the value of attribute days_past_end_date.



16
17
18
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 16

def days_past_end_date
  @days_past_end_date
end

#description ⇒ Object

Max length: 100;



19
20
21
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 19

def description
  @description
end

#first_period_end_date ⇒ Object

Returns the value of attribute first_period_end_date.



16
17
18
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 16

def first_period_end_date
  @first_period_end_date
end

#id ⇒ Object

Returns the value of attribute id.



16
17
18
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 16

def id
  @id
end

#last_day_flag ⇒ Object

Only needed when type is monthly



31
32
33
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 31

def last_day_flag
  @last_day_flag
end

#monthly_period_ends ⇒ Object

Only needed when type is monthly



22
23
24
 
# File 'lib/connect_wise/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.



16
17
18
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 16

def number_future_periods
  @number_future_periods
end

#period_apply_to ⇒ Object

Returns the value of attribute period_apply_to.



16
17
18
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 16

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/connect_wise/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.



16
17
18
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 16

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/connect_wise/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.



16
17
18
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 16

def type
  @type
end

#year ⇒ Object

Returns the value of attribute year.



16
17
18
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 16

def year
  @year
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 75

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 55

def self.attribute_map
  {
    period_apply_to: :periodApplyTo,
    year: :year,
    number_future_periods: :numberFuturePeriods,
    type: :type,
    first_period_end_date: :firstPeriodEndDate,
    days_past_end_date: :daysPastEndDate,
    id: :id,
    description: :description,
    monthly_period_ends: :monthlyPeriodEnds,
    semi_monthly_first_period: :semiMonthlyFirstPeriod,
    semi_monthly_second_period: :semiMonthlySecondPeriod,
    semi_monthly_last_day_flag: :semiMonthlyLastDayFlag,
    last_day_flag: :lastDayFlag,
    _info: :_info
  }
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



236
237
238
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 236

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 100

def self.openapi_nullable
  Set.new(i[
            period_apply_to
            year
            number_future_periods
            type
            days_past_end_date
            monthly_period_ends
            semi_monthly_first_period
            semi_monthly_second_period
            semi_monthly_last_day_flag
            last_day_flag
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 80

def self.openapi_types
  {
    period_apply_to: :String,
    year: :Integer,
    number_future_periods: :Integer,
    type: :String,
    first_period_end_date: :Date,
    days_past_end_date: :Integer,
    id: :Integer,
    description: :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,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 201

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    period_apply_to == other.period_apply_to &&
    year == other.year &&
    number_future_periods == other.number_future_periods &&
    type == other.type &&
    first_period_end_date == other.first_period_end_date &&
    days_past_end_date == other.days_past_end_date &&
    id == other.id &&
    description == other.description &&
    monthly_period_ends == other.monthly_period_ends &&
    semi_monthly_first_period == other.semi_monthly_first_period &&
    semi_monthly_second_period == other.semi_monthly_second_period &&
    semi_monthly_last_day_flag == other.semi_monthly_last_day_flag &&
    last_day_flag == other.last_day_flag &&
    _info == other._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



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
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 266

def _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 = ConnectWise.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 337

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 243

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send("#{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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


223
224
225
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 223

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



229
230
231
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 229

def hash
  [period_apply_to, year, number_future_periods, type, first_period_end_date, days_past_end_date, id, description, monthly_period_ends, semi_monthly_first_period, semi_monthly_second_period, semi_monthly_last_day_flag, last_day_flag, _info].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



161
162
163
164
165
166
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 161

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "first_period_end_date", first_period_end_date cannot be nil.') if @first_period_end_date.nil?

  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



313
314
315
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 313

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



319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 319

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



307
308
309
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 307

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



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/connect_wise/models/time_period_setup.rb', line 170

def valid?
  period_apply_to_validator = EnumAttributeValidator.new('String', %w[Both Expense Time])
  return false unless period_apply_to_validator.valid?(@period_apply_to)

  type_validator = EnumAttributeValidator.new('String', %w[Weekly BiWeekly SemiMonthly Monthly])
  return false unless type_validator.valid?(@type)
  return false if @first_period_end_date.nil?

  true
end