Class: Wallee::SubscriptionLedgerEntry
- Inherits:
-
Object
- Object
- Wallee::SubscriptionLedgerEntry
- Defined in:
- lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb
Overview
The subscription ledger entry represents a single change on the subscription balance.
Instance Attribute Summary collapse
-
#aggregated_tax_rate ⇒ Object
Returns the value of attribute aggregated_tax_rate.
-
#amount_excluding_tax ⇒ Object
Returns the value of attribute amount_excluding_tax.
-
#amount_including_tax ⇒ Object
Returns the value of attribute amount_including_tax.
-
#created_by ⇒ Object
Returns the value of attribute created_by.
-
#created_on ⇒ Object
The date and time when the object was created.
-
#discount_including_tax ⇒ Object
Returns the value of attribute discount_including_tax.
-
#external_id ⇒ Object
A client generated nonce which identifies the entity to be created.
-
#id ⇒ Object
A unique identifier for the object.
-
#linked_space_id ⇒ Object
The ID of the space this object belongs to.
-
#planned_purge_date ⇒ Object
The date and time when the object is planned to be permanently removed.
-
#quantity ⇒ Object
Returns the value of attribute quantity.
-
#state ⇒ Object
The object’s current state.
-
#subscription_version ⇒ Object
Returns the value of attribute subscription_version.
-
#tax_amount ⇒ Object
Returns the value of attribute tax_amount.
-
#taxes ⇒ Object
Returns the value of attribute taxes.
-
#title ⇒ Object
Returns the value of attribute title.
-
#version ⇒ Object
The version is used for optimistic locking and incremented whenever the object is updated.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_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 ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SubscriptionLedgerEntry
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#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 = {}) ⇒ SubscriptionLedgerEntry
Initializes the object
122 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 151 152 153 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 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 122 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } if attributes.has_key?(:'aggregatedTaxRate') self.aggregated_tax_rate = attributes[:'aggregatedTaxRate'] end if attributes.has_key?(:'amountExcludingTax') self.amount_excluding_tax = attributes[:'amountExcludingTax'] end if attributes.has_key?(:'amountIncludingTax') self.amount_including_tax = attributes[:'amountIncludingTax'] end if attributes.has_key?(:'createdBy') self.created_by = attributes[:'createdBy'] end if attributes.has_key?(:'createdOn') self.created_on = attributes[:'createdOn'] end if attributes.has_key?(:'discountIncludingTax') self.discount_including_tax = attributes[:'discountIncludingTax'] end if attributes.has_key?(:'externalId') self.external_id = attributes[:'externalId'] end if attributes.has_key?(:'id') self.id = attributes[:'id'] end if attributes.has_key?(:'linkedSpaceId') self.linked_space_id = attributes[:'linkedSpaceId'] end if attributes.has_key?(:'plannedPurgeDate') self.planned_purge_date = attributes[:'plannedPurgeDate'] end if attributes.has_key?(:'quantity') self.quantity = attributes[:'quantity'] end if attributes.has_key?(:'state') self.state = attributes[:'state'] end if attributes.has_key?(:'subscriptionVersion') self.subscription_version = attributes[:'subscriptionVersion'] end if attributes.has_key?(:'taxAmount') self.tax_amount = attributes[:'taxAmount'] end if attributes.has_key?(:'taxes') if (value = attributes[:'taxes']).is_a?(Array) self.taxes = value end end if attributes.has_key?(:'title') self.title = attributes[:'title'] end if attributes.has_key?(:'version') self.version = attributes[:'version'] end end |
Instance Attribute Details
#aggregated_tax_rate ⇒ Object
Returns the value of attribute aggregated_tax_rate.
24 25 26 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 24 def aggregated_tax_rate @aggregated_tax_rate end |
#amount_excluding_tax ⇒ Object
Returns the value of attribute amount_excluding_tax.
27 28 29 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 27 def amount_excluding_tax @amount_excluding_tax end |
#amount_including_tax ⇒ Object
Returns the value of attribute amount_including_tax.
30 31 32 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 30 def amount_including_tax @amount_including_tax end |
#created_by ⇒ Object
Returns the value of attribute created_by.
33 34 35 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 33 def created_by @created_by end |
#created_on ⇒ Object
The date and time when the object was created.
36 37 38 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 36 def created_on @created_on end |
#discount_including_tax ⇒ Object
Returns the value of attribute discount_including_tax.
39 40 41 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 39 def discount_including_tax @discount_including_tax end |
#external_id ⇒ Object
A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
42 43 44 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 42 def external_id @external_id end |
#id ⇒ Object
A unique identifier for the object.
45 46 47 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 45 def id @id end |
#linked_space_id ⇒ Object
The ID of the space this object belongs to.
48 49 50 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 48 def linked_space_id @linked_space_id end |
#planned_purge_date ⇒ Object
The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
51 52 53 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 51 def planned_purge_date @planned_purge_date end |
#quantity ⇒ Object
Returns the value of attribute quantity.
54 55 56 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 54 def quantity @quantity end |
#state ⇒ Object
The object’s current state.
57 58 59 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 57 def state @state end |
#subscription_version ⇒ Object
Returns the value of attribute subscription_version.
60 61 62 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 60 def subscription_version @subscription_version end |
#tax_amount ⇒ Object
Returns the value of attribute tax_amount.
63 64 65 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 63 def tax_amount @tax_amount end |
#taxes ⇒ Object
Returns the value of attribute taxes.
66 67 68 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 66 def taxes @taxes end |
#title ⇒ Object
Returns the value of attribute title.
69 70 71 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 69 def title @title end |
#version ⇒ Object
The version is used for optimistic locking and incremented whenever the object is updated.
72 73 74 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 72 def version @version end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 75 def self.attribute_map { :'aggregated_tax_rate' => :'aggregatedTaxRate', :'amount_excluding_tax' => :'amountExcludingTax', :'amount_including_tax' => :'amountIncludingTax', :'created_by' => :'createdBy', :'created_on' => :'createdOn', :'discount_including_tax' => :'discountIncludingTax', :'external_id' => :'externalId', :'id' => :'id', :'linked_space_id' => :'linkedSpaceId', :'planned_purge_date' => :'plannedPurgeDate', :'quantity' => :'quantity', :'state' => :'state', :'subscription_version' => :'subscriptionVersion', :'tax_amount' => :'taxAmount', :'taxes' => :'taxes', :'title' => :'title', :'version' => :'version' } end |
.swagger_types ⇒ Object
Attribute type mapping.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 98 def self.swagger_types { :'aggregated_tax_rate' => :'Float', :'amount_excluding_tax' => :'Float', :'amount_including_tax' => :'Float', :'created_by' => :'Integer', :'created_on' => :'DateTime', :'discount_including_tax' => :'Float', :'external_id' => :'String', :'id' => :'Integer', :'linked_space_id' => :'Integer', :'planned_purge_date' => :'DateTime', :'quantity' => :'Float', :'state' => :'SubscriptionLedgerEntryState', :'subscription_version' => :'Integer', :'tax_amount' => :'Float', :'taxes' => :'Array<Tax>', :'title' => :'String', :'version' => :'Integer' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 238 def ==(o) return true if self.equal?(o) self.class == o.class && aggregated_tax_rate == o.aggregated_tax_rate && amount_excluding_tax == o.amount_excluding_tax && amount_including_tax == o.amount_including_tax && created_by == o.created_by && created_on == o.created_on && discount_including_tax == o.discount_including_tax && external_id == o.external_id && id == o.id && linked_space_id == o.linked_space_id && planned_purge_date == o.planned_purge_date && quantity == o.quantity && state == o.state && subscription_version == o.subscription_version && tax_amount == o.tax_amount && taxes == o.taxes && title == o.title && version == o.version end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 296 def _deserialize(type, value) case type.to_sym when :DateTime DateTime.parse(value) when :Date Date.parse(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 temp_model = Wallee.const_get(type).new temp_model.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
362 363 364 365 366 367 368 369 370 371 372 373 374 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 362 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
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 275 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_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
262 263 264 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 262 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
268 269 270 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 268 def hash [aggregated_tax_rate, amount_excluding_tax, amount_including_tax, created_by, created_on, discount_including_tax, external_id, id, linked_space_id, planned_purge_date, quantity, state, subscription_version, tax_amount, taxes, title, version].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
201 202 203 204 205 206 207 208 209 210 211 212 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 201 def list_invalid_properties invalid_properties = Array.new if !@title.nil? && @title.to_s.length > 150 invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 150.') end if !@title.nil? && @title.to_s.length < 1 invalid_properties.push('invalid value for "title", the character length must be great than or equal to 1.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
342 343 344 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 342 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
348 349 350 351 352 353 354 355 356 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 348 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
336 337 338 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 336 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
216 217 218 219 220 |
# File 'lib/wallee-ruby-sdk/models/subscription_ledger_entry.rb', line 216 def valid? return false if !@title.nil? && @title.to_s.length > 150 return false if !@title.nil? && @title.to_s.length < 1 true end |