Class: XeroRuby::Accounting::Schedule

Inherits:
Object
  • Object
show all
Defined in:
lib/xero-ruby/models/accounting/schedule.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Constant Summary collapse

WEEKLY =
"WEEKLY".freeze
MONTHLY =
"MONTHLY".freeze
DAYSAFTERBILLDATE =
"DAYSAFTERBILLDATE".freeze
DAYSAFTERBILLMONTH =
"DAYSAFTERBILLMONTH".freeze
DAYSAFTERINVOICEDATE =
"DAYSAFTERINVOICEDATE".freeze
DAYSAFTERINVOICEMONTH =
"DAYSAFTERINVOICEMONTH".freeze
OFCURRENTMONTH =
"OFCURRENTMONTH".freeze
OFFOLLOWINGMONTH =
"OFFOLLOWINGMONTH".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Schedule

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
133
134
135
136
137
138
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 98

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::Schedule` initialize method"
  end

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

  if attributes.key?(:'period')
    self.period = attributes[:'period']
  end

  if attributes.key?(:'unit')
    self.unit = attributes[:'unit']
  end

  if attributes.key?(:'due_date')
    self.due_date = attributes[:'due_date']
  end

  if attributes.key?(:'due_date_type')
    self.due_date_type = attributes[:'due_date_type']
  end

  if attributes.key?(:'start_date')
    self.start_date = attributes[:'start_date']
  end

  if attributes.key?(:'next_scheduled_date')
    self.next_scheduled_date = attributes[:'next_scheduled_date']
  end

  if attributes.key?(:'end_date')
    self.end_date = attributes[:'end_date']
  end
end

Instance Attribute Details

#due_dateObject

Integer used with due date type e.g 20 (of following month), 31 (of current month)


28
29
30
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 28

def due_date
  @due_date
end

#due_date_typeObject

the payment terms


31
32
33
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 31

def due_date_type
  @due_date_type
end

#end_dateObject

Invoice end date – only returned if the template has an end date set


46
47
48
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 46

def end_date
  @end_date
end

#next_scheduled_dateObject

The calendar date of the next invoice in the schedule to be generated


43
44
45
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 43

def next_scheduled_date
  @next_scheduled_date
end

#periodObject

Integer used with the unit e.g. 1 (every 1 week), 2 (every 2 months)


20
21
22
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 20

def period
  @period
end

#start_dateObject

Date the first invoice of the current version of the repeating schedule was generated (changes when repeating invoice is edited)


40
41
42
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 40

def start_date
  @start_date
end

#unitObject

One of the following - WEEKLY or MONTHLY


23
24
25
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 23

def unit
  @unit
end

Class Method Details

.attribute_mapObject

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


71
72
73
74
75
76
77
78
79
80
81
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 71

def self.attribute_map
  {
    :'period' => :'Period',
    :'unit' => :'Unit',
    :'due_date' => :'DueDate',
    :'due_date_type' => :'DueDateType',
    :'start_date' => :'StartDate',
    :'next_scheduled_date' => :'NextScheduledDate',
    :'end_date' => :'EndDate'
  }
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


206
207
208
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 206

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

.openapi_typesObject

Attribute type mapping.


84
85
86
87
88
89
90
91
92
93
94
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 84

def self.openapi_types
  {
    :'period' => :'Integer',
    :'unit' => :'String',
    :'due_date' => :'Integer',
    :'due_date_type' => :'String',
    :'start_date' => :'Date',
    :'next_scheduled_date' => :'Date',
    :'end_date' => :'Date'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


179
180
181
182
183
184
185
186
187
188
189
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 179

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      period == o.period &&
      unit == o.unit &&
      due_date == o.due_date &&
      due_date_type == o.due_date_type &&
      start_date == o.start_date &&
      next_scheduled_date == o.next_scheduled_date &&
      end_date == o.end_date
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


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
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 234

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(parse_date(value))
  when :Date
    Date.parse(parse_date(value))
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BigDecimal
    BigDecimal(value.to_s)
  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
    XeroRuby::Accounting.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value, downcase: false) ⇒ 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


307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 307

def _to_hash(value, downcase: false)
  if value.is_a?(Array)
    value.map do |v|
      v.to_hash(downcase: downcase)
    end
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash(downcase: downcase)
  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


213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 213

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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
      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

193
194
195
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 193

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code


199
200
201
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 199

def hash
  [period, unit, due_date, due_date_type, start_date, next_scheduled_date, end_date].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


142
143
144
145
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 142

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#parse_date(datestring) ⇒ Object


323
324
325
326
327
328
329
330
331
332
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 323

def parse_date(datestring)
  if datestring.include?('Date')
    date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
    original, date, timezone = *date_pattern.match(datestring)
    date = (date.to_i / 1000)
    Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
  else # handle date 'types' for small subset of payroll API's
    Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
  end
end

#to_attributesObject

Returns the object in the form of hash with snake_case


299
300
301
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 299

def to_attributes
  to_hash(downcase: true)
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


281
282
283
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 281

def to_body
  to_hash
end

#to_hash(downcase: false) ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


287
288
289
290
291
292
293
294
295
296
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 287

def to_hash(downcase: false)
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    key = downcase ? attr : param
    hash[key] = _to_hash(value, downcase: downcase)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


275
276
277
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 275

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


149
150
151
152
153
154
155
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 149

def valid?
  unit_validator = EnumAttributeValidator.new('String', ["WEEKLY", "MONTHLY"])
  return false unless unit_validator.valid?(@unit)
  due_date_type_validator = EnumAttributeValidator.new('String', ["DAYSAFTERBILLDATE", "DAYSAFTERBILLMONTH", "DAYSAFTERINVOICEDATE", "DAYSAFTERINVOICEMONTH", "OFCURRENTMONTH", "OFFOLLOWINGMONTH"])
  return false unless due_date_type_validator.valid?(@due_date_type)
  true
end