Class: AdvancedBilling::ChangeInvoiceCollectionMethodEventData

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/advanced_billing/models/change_invoice_collection_method_event_data.rb

Overview

Example schema for an ‘change_invoice_collection_method` event

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(from_collection_method = SKIP, to_collection_method = SKIP) ⇒ ChangeInvoiceCollectionMethodEventData

Returns a new instance of ChangeInvoiceCollectionMethodEventData.



41
42
43
44
 
# File 'lib/advanced_billing/models/change_invoice_collection_method_event_data.rb', line 41

def initialize(from_collection_method = SKIP, to_collection_method = SKIP)
  @from_collection_method = from_collection_method unless from_collection_method == SKIP
  @to_collection_method = to_collection_method unless to_collection_method == SKIP
end

Instance Attribute Details

#from_collection_method ⇒ String

The previous collection method of the invoice.

Returns:

  • (String) 


14
15
16
 
# File 'lib/advanced_billing/models/change_invoice_collection_method_event_data.rb', line 14

def from_collection_method
  @from_collection_method
end

#to_collection_method ⇒ String

The new collection method of the invoice.

Returns:

  • (String) 


18
19
20
 
# File 'lib/advanced_billing/models/change_invoice_collection_method_event_data.rb', line 18

def to_collection_method
  @to_collection_method
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/advanced_billing/models/change_invoice_collection_method_event_data.rb', line 47

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  from_collection_method =
    hash.key?('from_collection_method') ? hash['from_collection_method'] : SKIP
  to_collection_method =
    hash.key?('to_collection_method') ? hash['to_collection_method'] : SKIP

  # Create object from extracted values.
  ChangeInvoiceCollectionMethodEventData.new(from_collection_method,
                                             to_collection_method)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/advanced_billing/models/change_invoice_collection_method_event_data.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['from_collection_method'] = 'from_collection_method'
  @_hash['to_collection_method'] = 'to_collection_method'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/advanced_billing/models/change_invoice_collection_method_event_data.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/advanced_billing/models/change_invoice_collection_method_event_data.rb', line 29

def self.optionals
  %w[
    from_collection_method
    to_collection_method
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



63
64
65
66
67
68
69
 
# File 'lib/advanced_billing/models/change_invoice_collection_method_event_data.rb', line 63

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end