Class: XeroRuby::Accounting::BrandingTheme
- Inherits:
-
Object
- Object
- XeroRuby::Accounting::BrandingTheme
- Defined in:
- lib/xero-ruby/models/accounting/branding_theme.rb
Defined Under Namespace
Classes: EnumAttributeValidator
Constant Summary collapse
- INVOICE =
"INVOICE".freeze
Instance Attribute Summary collapse
-
#branding_theme_id ⇒ Object
Xero identifier.
-
#created_date_utc ⇒ Object
UTC timestamp of creation date of branding theme.
-
#logo_url ⇒ Object
The location of the image file used as the logo on this branding theme.
-
#name ⇒ Object
Name of branding theme.
-
#sort_order ⇒ Object
Integer – ranked order of branding theme.
-
#type ⇒ Object
Always INVOICE.
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 = {}) ⇒ BrandingTheme
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 = {}) ⇒ BrandingTheme
Initializes the object
87 88 89 90 91 92 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 121 122 123 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 87 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::BrandingTheme` 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::BrandingTheme`. 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?(:'branding_theme_id') self.branding_theme_id = attributes[:'branding_theme_id'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'logo_url') self.logo_url = attributes[:'logo_url'] end if attributes.key?(:'type') self.type = attributes[:'type'] end if attributes.key?(:'sort_order') self.sort_order = attributes[:'sort_order'] end if attributes.key?(:'created_date_utc') self.created_date_utc = attributes[:'created_date_utc'] end end |
Instance Attribute Details
#branding_theme_id ⇒ Object
Xero identifier
21 22 23 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 21 def branding_theme_id @branding_theme_id end |
#created_date_utc ⇒ Object
UTC timestamp of creation date of branding theme
37 38 39 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 37 def created_date_utc @created_date_utc end |
#logo_url ⇒ Object
The location of the image file used as the logo on this branding theme
27 28 29 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 27 def logo_url @logo_url end |
#name ⇒ Object
Name of branding theme
24 25 26 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 24 def name @name end |
#sort_order ⇒ Object
Integer – ranked order of branding theme. The default branding theme has a value of 0
34 35 36 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 34 def sort_order @sort_order end |
#type ⇒ Object
Always INVOICE
30 31 32 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 30 def type @type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
62 63 64 65 66 67 68 69 70 71 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 62 def self.attribute_map { :'branding_theme_id' => :'BrandingThemeID', :'name' => :'Name', :'logo_url' => :'LogoUrl', :'type' => :'Type', :'sort_order' => :'SortOrder', :'created_date_utc' => :'CreatedDateUTC' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
178 179 180 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 178 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
74 75 76 77 78 79 80 81 82 83 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 74 def self.openapi_types { :'branding_theme_id' => :'String', :'name' => :'String', :'logo_url' => :'String', :'type' => :'String', :'sort_order' => :'Integer', :'created_date_utc' => :'DateTime' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
152 153 154 155 156 157 158 159 160 161 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 152 def ==(o) return true if self.equal?(o) self.class == o.class && branding_theme_id == o.branding_theme_id && name == o.name && logo_url == o.logo_url && type == o.type && sort_order == o.sort_order && created_date_utc == o.created_date_utc end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 206 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
273 274 275 276 277 278 279 280 281 282 283 284 285 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 273 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
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 185 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
165 166 167 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 165 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
171 172 173 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 171 def hash [branding_theme_id, name, logo_url, type, sort_order, created_date_utc].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
127 128 129 130 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 127 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#parse_date(datestring) ⇒ Object
customized data_parser
288 289 290 291 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 288 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)
253 254 255 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 253 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
259 260 261 262 263 264 265 266 267 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 259 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
247 248 249 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 247 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
134 135 136 137 138 |
# File 'lib/xero-ruby/models/accounting/branding_theme.rb', line 134 def valid? type_validator = EnumAttributeValidator.new('String', ["INVOICE"]) return false unless type_validator.valid?(@type) true end |