Class: XeroRuby::Accounting::Quote
- Inherits:
-
Object
- Object
- XeroRuby::Accounting::Quote
- Defined in:
- lib/xero-ruby/models/accounting/quote.rb
Instance Attribute Summary collapse
-
#branding_theme_id ⇒ Object
See BrandingThemes.
-
#contact ⇒ Object
Returns the value of attribute contact.
-
#currency_code ⇒ Object
Returns the value of attribute currency_code.
-
#currency_rate ⇒ Object
The currency rate for a multicurrency quote.
-
#date ⇒ Object
Date quote was issued – YYYY-MM-DD.
-
#date_string ⇒ Object
Date the quote was issued (YYYY-MM-DD).
-
#expiry_date ⇒ Object
Date the quote expires – YYYY-MM-DD.
-
#expiry_date_string ⇒ Object
Date the quote expires – YYYY-MM-DD.
-
#line_amount_types ⇒ Object
Returns the value of attribute line_amount_types.
-
#line_items ⇒ Object
See LineItems.
-
#quote_id ⇒ Object
QuoteID GUID is automatically generated and is returned after create or GET.
-
#quote_number ⇒ Object
Unique alpha numeric code identifying a quote (Max Length = 255).
-
#reference ⇒ Object
Additional reference number.
-
#status ⇒ Object
Returns the value of attribute status.
-
#status_attribute_string ⇒ Object
A string to indicate if a invoice status.
-
#sub_total ⇒ Object
Total of quote excluding taxes.
-
#summary ⇒ Object
Summary text for the quote.
-
#terms ⇒ Object
Terms of the quote.
-
#title ⇒ Object
Title text for the quote.
-
#total ⇒ Object
Total of Quote tax inclusive (i.e. SubTotal + TotalTax).
-
#total_discount ⇒ Object
Total of discounts applied on the quote line items.
-
#total_tax ⇒ Object
Total tax on quote.
-
#updated_date_utc ⇒ Object
Last modified date UTC format.
-
#validation_errors ⇒ Object
Displays array of validation error messages from the API.
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 = {}) ⇒ Quote
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 = {}) ⇒ Quote
Initializes the object
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 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 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 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 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 154 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::Quote` 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::Quote`. 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?(:'quote_id') self.quote_id = attributes[:'quote_id'] end if attributes.key?(:'quote_number') self.quote_number = attributes[:'quote_number'] end if attributes.key?(:'reference') self.reference = attributes[:'reference'] end if attributes.key?(:'terms') self.terms = attributes[:'terms'] end if attributes.key?(:'contact') self.contact = attributes[:'contact'] end if attributes.key?(:'line_items') if (value = attributes[:'line_items']).is_a?(Array) self.line_items = value end end if attributes.key?(:'date') self.date = attributes[:'date'] end if attributes.key?(:'date_string') self.date_string = attributes[:'date_string'] end if attributes.key?(:'expiry_date') self.expiry_date = attributes[:'expiry_date'] end if attributes.key?(:'expiry_date_string') self.expiry_date_string = attributes[:'expiry_date_string'] end if attributes.key?(:'status') self.status = attributes[:'status'] end if attributes.key?(:'currency_code') self.currency_code = attributes[:'currency_code'] end if attributes.key?(:'currency_rate') self.currency_rate = attributes[:'currency_rate'] end if attributes.key?(:'sub_total') self.sub_total = attributes[:'sub_total'] end if attributes.key?(:'total_tax') self.total_tax = attributes[:'total_tax'] end if attributes.key?(:'total') self.total = attributes[:'total'] end if attributes.key?(:'total_discount') self.total_discount = attributes[:'total_discount'] end if attributes.key?(:'title') self.title = attributes[:'title'] end if attributes.key?(:'summary') self.summary = attributes[:'summary'] end if attributes.key?(:'branding_theme_id') self.branding_theme_id = attributes[:'branding_theme_id'] end if attributes.key?(:'updated_date_utc') self.updated_date_utc = attributes[:'updated_date_utc'] end if attributes.key?(:'line_amount_types') self.line_amount_types = attributes[:'line_amount_types'] end if attributes.key?(:'status_attribute_string') self.status_attribute_string = attributes[:'status_attribute_string'] end if attributes.key?(:'validation_errors') if (value = attributes[:'validation_errors']).is_a?(Array) self.validation_errors = value end end end |
Instance Attribute Details
#branding_theme_id ⇒ Object
See BrandingThemes
78 79 80 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 78 def branding_theme_id @branding_theme_id end |
#contact ⇒ Object
Returns the value of attribute contact.
33 34 35 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 33 def contact @contact end |
#currency_code ⇒ Object
Returns the value of attribute currency_code.
54 55 56 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 54 def currency_code @currency_code end |
#currency_rate ⇒ Object
The currency rate for a multicurrency quote
57 58 59 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 57 def currency_rate @currency_rate end |
#date ⇒ Object
Date quote was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation
39 40 41 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 39 def date @date end |
#date_string ⇒ Object
Date the quote was issued (YYYY-MM-DD)
42 43 44 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 42 def date_string @date_string end |
#expiry_date ⇒ Object
Date the quote expires – YYYY-MM-DD.
45 46 47 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 45 def expiry_date @expiry_date end |
#expiry_date_string ⇒ Object
Date the quote expires – YYYY-MM-DD.
48 49 50 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 48 def expiry_date_string @expiry_date_string end |
#line_amount_types ⇒ Object
Returns the value of attribute line_amount_types.
84 85 86 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 84 def line_amount_types @line_amount_types end |
#line_items ⇒ Object
See LineItems
36 37 38 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 36 def line_items @line_items end |
#quote_id ⇒ Object
QuoteID GUID is automatically generated and is returned after create or GET.
21 22 23 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 21 def quote_id @quote_id end |
#quote_number ⇒ Object
Unique alpha numeric code identifying a quote (Max Length = 255)
24 25 26 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 24 def quote_number @quote_number end |
#reference ⇒ Object
Additional reference number
27 28 29 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 27 def reference @reference end |
#status ⇒ Object
Returns the value of attribute status.
51 52 53 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 51 def status @status end |
#status_attribute_string ⇒ Object
A string to indicate if a invoice status
87 88 89 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 87 def status_attribute_string @status_attribute_string end |
#sub_total ⇒ Object
Total of quote excluding taxes.
60 61 62 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 60 def sub_total @sub_total end |
#summary ⇒ Object
Summary text for the quote
75 76 77 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 75 def summary @summary end |
#terms ⇒ Object
Terms of the quote
30 31 32 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 30 def terms @terms end |
#title ⇒ Object
Title text for the quote
72 73 74 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 72 def title @title end |
#total ⇒ Object
Total of Quote tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts
66 67 68 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 66 def total @total end |
#total_discount ⇒ Object
Total of discounts applied on the quote line items
69 70 71 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 69 def total_discount @total_discount end |
#total_tax ⇒ Object
Total tax on quote
63 64 65 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 63 def total_tax @total_tax end |
#updated_date_utc ⇒ Object
Last modified date UTC format
81 82 83 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 81 def updated_date_utc @updated_date_utc end |
#validation_errors ⇒ Object
Displays array of validation error messages from the API
90 91 92 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 90 def validation_errors @validation_errors end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 93 def self.attribute_map { :'quote_id' => :'QuoteID', :'quote_number' => :'QuoteNumber', :'reference' => :'Reference', :'terms' => :'Terms', :'contact' => :'Contact', :'line_items' => :'LineItems', :'date' => :'Date', :'date_string' => :'DateString', :'expiry_date' => :'ExpiryDate', :'expiry_date_string' => :'ExpiryDateString', :'status' => :'Status', :'currency_code' => :'CurrencyCode', :'currency_rate' => :'CurrencyRate', :'sub_total' => :'SubTotal', :'total_tax' => :'TotalTax', :'total' => :'Total', :'total_discount' => :'TotalDiscount', :'title' => :'Title', :'summary' => :'Summary', :'branding_theme_id' => :'BrandingThemeID', :'updated_date_utc' => :'UpdatedDateUTC', :'line_amount_types' => :'LineAmountTypes', :'status_attribute_string' => :'StatusAttributeString', :'validation_errors' => :'ValidationErrors' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
402 403 404 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 402 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
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 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 123 def self.openapi_types { :'quote_id' => :'String', :'quote_number' => :'String', :'reference' => :'String', :'terms' => :'String', :'contact' => :'Contact', :'line_items' => :'Array<LineItem>', :'date' => :'Date', :'date_string' => :'String', :'expiry_date' => :'Date', :'expiry_date_string' => :'String', :'status' => :'QuoteStatusCodes', :'currency_code' => :'CurrencyCode', :'currency_rate' => :'Float', :'sub_total' => :'BigDecimal', :'total_tax' => :'BigDecimal', :'total' => :'BigDecimal', :'total_discount' => :'BigDecimal', :'title' => :'String', :'summary' => :'String', :'branding_theme_id' => :'String', :'updated_date_utc' => :'DateTime', :'line_amount_types' => :'QuoteLineAmountTypes', :'status_attribute_string' => :'String', :'validation_errors' => :'Array<ValidationError>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 358 def ==(o) return true if self.equal?(o) self.class == o.class && quote_id == o.quote_id && quote_number == o.quote_number && reference == o.reference && terms == o.terms && contact == o.contact && line_items == o.line_items && date == o.date && date_string == o.date_string && expiry_date == o.expiry_date && expiry_date_string == o.expiry_date_string && status == o.status && currency_code == o.currency_code && currency_rate == o.currency_rate && sub_total == o.sub_total && total_tax == o.total_tax && total == o.total && total_discount == o.total_discount && title == o.title && summary == o.summary && branding_theme_id == o.branding_theme_id && updated_date_utc == o.updated_date_utc && line_amount_types == o.line_amount_types && status_attribute_string == o.status_attribute_string && validation_errors == o.validation_errors end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 430 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
497 498 499 500 501 502 503 504 505 506 507 508 509 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 497 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
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 409 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
389 390 391 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 389 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
395 396 397 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 395 def hash [quote_id, quote_number, reference, terms, contact, line_items, date, date_string, expiry_date, expiry_date_string, status, currency_code, currency_rate, sub_total, total_tax, total, total_discount, title, summary, branding_theme_id, updated_date_utc, line_amount_types, status_attribute_string, validation_errors].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 270 def list_invalid_properties invalid_properties = Array.new if !@quote_number.nil? && @quote_number.to_s.length > 255 invalid_properties.push('invalid value for "quote_number", the character length must be smaller than or equal to 255.') end if !@reference.nil? && @reference.to_s.length > 4000 invalid_properties.push('invalid value for "reference", the character length must be smaller than or equal to 4000.') end if !@terms.nil? && @terms.to_s.length > 4000 invalid_properties.push('invalid value for "terms", the character length must be smaller than or equal to 4000.') end if !@title.nil? && @title.to_s.length > 100 invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 100.') end if !@summary.nil? && @summary.to_s.length > 3000 invalid_properties.push('invalid value for "summary", the character length must be smaller than or equal to 3000.') end invalid_properties end |
#parse_date(datestring) ⇒ Object
customized data_parser
512 513 514 515 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 512 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)
477 478 479 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 477 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
483 484 485 486 487 488 489 490 491 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 483 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
471 472 473 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 471 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
297 298 299 300 301 302 303 304 |
# File 'lib/xero-ruby/models/accounting/quote.rb', line 297 def valid? return false if !@quote_number.nil? && @quote_number.to_s.length > 255 return false if !@reference.nil? && @reference.to_s.length > 4000 return false if !@terms.nil? && @terms.to_s.length > 4000 return false if !@title.nil? && @title.to_s.length > 100 return false if !@summary.nil? && @summary.to_s.length > 3000 true end |