Class: XeroRuby::Accounting::Schedule
- Inherits:
-
Object
- Object
- XeroRuby::Accounting::Schedule
- 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
-
#due_date ⇒ Object
Integer used with due date type e.g 20 (of following month), 31 (of current month).
-
#due_date_type ⇒ Object
the payment terms.
-
#end_date ⇒ Object
Invoice end date – only returned if the template has an end date set.
-
#next_scheduled_date ⇒ Object
The calendar date of the next invoice in the schedule to be generated.
-
#period ⇒ Object
Integer used with the unit e.g.
-
#start_date ⇒ Object
Date the first invoice of the current version of the repeating schedule was generated (changes when repeating invoice is edited).
-
#unit ⇒ Object
One of the following - WEEKLY or MONTHLY.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Schedule
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#parse_date(datestring) ⇒ Object
customized data_parser.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Schedule
Initializes the object
97 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 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 97 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_date ⇒ Object
Integer used with due date type e.g 20 (of following month), 31 (of current month)
27 28 29 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 27 def due_date @due_date end |
#due_date_type ⇒ Object
the payment terms
30 31 32 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 30 def due_date_type @due_date_type end |
#end_date ⇒ Object
Invoice end date – only returned if the template has an end date set
45 46 47 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 45 def end_date @end_date end |
#next_scheduled_date ⇒ Object
The calendar date of the next invoice in the schedule to be generated
42 43 44 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 42 def next_scheduled_date @next_scheduled_date end |
#period ⇒ Object
Integer used with the unit e.g. 1 (every 1 week), 2 (every 2 months)
19 20 21 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 19 def period @period end |
#start_date ⇒ Object
Date the first invoice of the current version of the repeating schedule was generated (changes when repeating invoice is edited)
39 40 41 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 39 def start_date @start_date end |
#unit ⇒ Object
One of the following - WEEKLY or MONTHLY
22 23 24 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 22 def unit @unit end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
70 71 72 73 74 75 76 77 78 79 80 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 70 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
205 206 207 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 205 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 83 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.
178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 178 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
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 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 233 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 :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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 298 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
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 212 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
192 193 194 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 192 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
198 199 200 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 198 def hash [period, unit, due_date, due_date_type, start_date, next_scheduled_date, end_date].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
141 142 143 144 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 141 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#parse_date(datestring) ⇒ Object
customized data_parser
313 314 315 316 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 313 def parse_date(datestring) seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0 return Time.at(seconds_since_epoch).to_s end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
278 279 280 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 278 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
284 285 286 287 288 289 290 291 292 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 284 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
272 273 274 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 272 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
148 149 150 151 152 153 154 |
# File 'lib/xero-ruby/models/accounting/schedule.rb', line 148 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 |