class XeroRuby::Accounting::Schedule
Constants
- DAYSAFTERBILLDATE
- DAYSAFTERBILLMONTH
- DAYSAFTERINVOICEDATE
- DAYSAFTERINVOICEMONTH
- MONTHLY
- OFCURRENTMONTH
- OFFOLLOWINGMONTH
- WEEKLY
Attributes
Integer used with due date type e.g 20 (of following month), 31 (of current month)
the payment terms
Invoice
end date – only returned if the template has an end date set
The calendar date of the next invoice in the schedule to be generated
Integer used with the unit e.g. 1 (every 1 week), 2 (every 2 months)
Date the first invoice of the current version of the repeating schedule was generated (changes when repeating invoice is edited)
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/xero-ruby/models/accounting/schedule.rb, line 206 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# 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
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/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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
Custom attribute writer method checking allowed values (enum). @param [Object] due_date_type
Object to be assigned
# File lib/xero-ruby/models/accounting/schedule.rb, line 169 def due_date_type=(due_date_type) validator = EnumAttributeValidator.new('String', ["DAYSAFTERBILLDATE", "DAYSAFTERBILLMONTH", "DAYSAFTERINVOICEDATE", "DAYSAFTERINVOICEMONTH", "OFCURRENTMONTH", "OFFOLLOWINGMONTH"]) unless validator.valid?(due_date_type) fail ArgumentError, "invalid value for \"due_date_type\", must be one of #{validator.allowable_values}." end @due_date_type = due_date_type end
@see the `==` method @param [Object] Object to be compared
# File lib/xero-ruby/models/accounting/schedule.rb, line 193 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# 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
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/xero-ruby/models/accounting/schedule.rb, line 142 def list_invalid_properties invalid_properties = Array.new invalid_properties end
# 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 elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').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
Returns the object in the form of hash with snake_case
# File lib/xero-ruby/models/accounting/schedule.rb, line 299 def to_attributes to_hash(downcase: true) end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/xero-ruby/models/accounting/schedule.rb, line 275 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] unit Object to be assigned
# File lib/xero-ruby/models/accounting/schedule.rb, line 159 def unit=(unit) validator = EnumAttributeValidator.new('String', ["WEEKLY", "MONTHLY"]) unless validator.valid?(unit) fail ArgumentError, "invalid value for \"unit\", must be one of #{validator.allowable_values}." end @unit = unit end
Check to see if the all the properties in the model are valid @return true if the model is valid
# 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