Class: Tremendous::Invoice
- Inherits:
-
Object
- Object
- Tremendous::Invoice
- Defined in:
- lib/tremendous/models/invoice.rb
Overview
Invoices are instruments to fund your Tremendous account’s balance. Invoices can be created by your organization programatically. Once we receive your payment, the invoice is marked as ‘PAID` and we add the respective funds to your account’s balance.
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#amount ⇒ Object
Amount of the invoice in USD.
-
#created_at ⇒ Object
Timestamp of when the invoice has been created.
-
#id ⇒ Object
The invoice number.
-
#orders ⇒ Object
List of orders related to the invoice (it doesn’t apply to prefunding).
-
#paid_at ⇒ Object
Timestamp of when the invoice has been paid.
-
#po_number ⇒ Object
Reference to the purchase order number within your organization.
-
#rewards ⇒ Object
List of rewards related to the invoice (it doesn’t apply to prefunding).
-
#status ⇒ Object
Status of this invoice <table> <thead> <tr> <th>Status</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>
DELETED
</td> <td>Invoice has been deleted by your organization</td> </tr> <tr> <td>PAID
</td> <td>Invoice has been paid by your organization</td> </tr> <tr> <td>OPEN
</td> <td>Invoice has been created by your organization but has not been paid, yet</td> </tr> </tbody> </table>.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Invoice
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 = {}) ⇒ Invoice
Initializes the object
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 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 |
# File 'lib/tremendous/models/invoice.rb', line 108 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Tremendous::Invoice` 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 `Tremendous::Invoice`. 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?(:'id') self.id = attributes[:'id'] else self.id = nil end if attributes.key?(:'po_number') self.po_number = attributes[:'po_number'] end if attributes.key?(:'amount') self.amount = attributes[:'amount'] else self.amount = nil end if attributes.key?(:'status') self.status = attributes[:'status'] else self.status = nil end if attributes.key?(:'orders') if (value = attributes[:'orders']).is_a?(Array) self.orders = value end end if attributes.key?(:'rewards') if (value = attributes[:'rewards']).is_a?(Array) self.rewards = value end end if attributes.key?(:'created_at') self.created_at = attributes[:'created_at'] else self.created_at = nil end if attributes.key?(:'paid_at') self.paid_at = attributes[:'paid_at'] else self.paid_at = nil end end |
Instance Attribute Details
#amount ⇒ Object
Amount of the invoice in USD
26 27 28 |
# File 'lib/tremendous/models/invoice.rb', line 26 def amount @amount end |
#created_at ⇒ Object
Timestamp of when the invoice has been created.
38 39 40 |
# File 'lib/tremendous/models/invoice.rb', line 38 def created_at @created_at end |
#id ⇒ Object
The invoice number
20 21 22 |
# File 'lib/tremendous/models/invoice.rb', line 20 def id @id end |
#orders ⇒ Object
List of orders related to the invoice (it doesn’t apply to prefunding)
32 33 34 |
# File 'lib/tremendous/models/invoice.rb', line 32 def orders @orders end |
#paid_at ⇒ Object
Timestamp of when the invoice has been paid.
41 42 43 |
# File 'lib/tremendous/models/invoice.rb', line 41 def paid_at @paid_at end |
#po_number ⇒ Object
Reference to the purchase order number within your organization
23 24 25 |
# File 'lib/tremendous/models/invoice.rb', line 23 def po_number @po_number end |
#rewards ⇒ Object
List of rewards related to the invoice (it doesn’t apply to prefunding)
35 36 37 |
# File 'lib/tremendous/models/invoice.rb', line 35 def rewards @rewards end |
#status ⇒ Object
Status of this invoice <table> <thead> <tr> <th>Status</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>DELETED
</td> <td>Invoice has been deleted by your organization</td> </tr> <tr> <td>PAID
</td> <td>Invoice has been paid by your organization</td> </tr> <tr> <td>OPEN
</td> <td>Invoice has been created by your organization but has not been paid, yet</td> </tr> </tbody> </table>
29 30 31 |
# File 'lib/tremendous/models/invoice.rb', line 29 def status @status end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
# File 'lib/tremendous/models/invoice.rb', line 269 def self._deserialize(type, value) case type.to_sym when :Time Time.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 # models (e.g. Pet) or oneOf klass = Tremendous.const_get(type) klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
80 81 82 |
# File 'lib/tremendous/models/invoice.rb', line 80 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/tremendous/models/invoice.rb', line 66 def self.attribute_map { :'id' => :'id', :'po_number' => :'po_number', :'amount' => :'amount', :'status' => :'status', :'orders' => :'orders', :'rewards' => :'rewards', :'created_at' => :'created_at', :'paid_at' => :'paid_at' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 |
# File 'lib/tremendous/models/invoice.rb', line 245 def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = nil elsif 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[attribute_map[key]].is_a?(Array) transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
99 100 101 102 103 104 |
# File 'lib/tremendous/models/invoice.rb', line 99 def self.openapi_nullable Set.new([ :'po_number', :'paid_at' ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/tremendous/models/invoice.rb', line 85 def self.openapi_types { :'id' => :'String', :'po_number' => :'String', :'amount' => :'Float', :'status' => :'String', :'orders' => :'Array<String>', :'rewards' => :'Array<String>', :'created_at' => :'Date', :'paid_at' => :'Date' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
217 218 219 220 221 222 223 224 225 226 227 228 |
# File 'lib/tremendous/models/invoice.rb', line 217 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && po_number == o.po_number && amount == o.amount && status == o.status && orders == o.orders && rewards == o.rewards && created_at == o.created_at && paid_at == o.paid_at end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
340 341 342 343 344 345 346 347 348 349 350 351 352 |
# File 'lib/tremendous/models/invoice.rb', line 340 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 |
#eql?(o) ⇒ Boolean
232 233 234 |
# File 'lib/tremendous/models/invoice.rb', line 232 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
238 239 240 |
# File 'lib/tremendous/models/invoice.rb', line 238 def hash [id, po_number, amount, status, orders, rewards, created_at, paid_at].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 |
# File 'lib/tremendous/models/invoice.rb', line 170 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @amount.nil? invalid_properties.push('invalid value for "amount", amount cannot be nil.') end if @status.nil? invalid_properties.push('invalid value for "status", status cannot be nil.') end if @created_at.nil? invalid_properties.push('invalid value for "created_at", created_at cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
316 317 318 |
# File 'lib/tremendous/models/invoice.rb', line 316 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/tremendous/models/invoice.rb', line 322 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
310 311 312 |
# File 'lib/tremendous/models/invoice.rb', line 310 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
194 195 196 197 198 199 200 201 202 203 |
# File 'lib/tremendous/models/invoice.rb', line 194 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' return false if @id.nil? return false if @amount.nil? return false if @status.nil? status_validator = EnumAttributeValidator.new('String', ["DELETED", "PAID", "OPEN", "MARKED_AS_PAID"]) return false unless status_validator.valid?(@status) return false if @created_at.nil? true end |