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

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(from_collection_method:, to_collection_method:, additional_properties: {}) ⇒ ChangeInvoiceCollectionMethodEventData

Returns a new instance of ChangeInvoiceCollectionMethodEventData.



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/advanced_billing/models/change_invoice_collection_method_event_data.rb', line 38

def initialize(from_collection_method:, to_collection_method:,
               additional_properties: {})
  # Add additional model properties to the instance.
  additional_properties.each do |_name, _value|
    instance_variable_set("@#{_name}", _value)
  end

  @from_collection_method = from_collection_method
  @to_collection_method = to_collection_method
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.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/advanced_billing/models/change_invoice_collection_method_event_data.rb', line 50

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'] : nil
  to_collection_method =
    hash.key?('to_collection_method') ? hash['to_collection_method'] : nil

  # Clean out expected properties from Hash.
  additional_properties = hash.reject { |k, _| names.value?(k) }

  # Create object from extracted values.
  ChangeInvoiceCollectionMethodEventData.new(from_collection_method: from_collection_method,
                                             to_collection_method: to_collection_method,
                                             additional_properties: additional_properties)
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



34
35
36
 
# File 'lib/advanced_billing/models/change_invoice_collection_method_event_data.rb', line 34

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/advanced_billing/models/change_invoice_collection_method_event_data.rb', line 70

def self.validate(value)
  if value.instance_of? self
    return (
      APIHelper.valid_type?(value.from_collection_method,
                            ->(val) { val.instance_of? String }) and
        APIHelper.valid_type?(value.to_collection_method,
                              ->(val) { val.instance_of? String })
    )
  end

  return false unless value.instance_of? Hash

  (
    APIHelper.valid_type?(value['from_collection_method'],
                          ->(val) { val.instance_of? String }) and
      APIHelper.valid_type?(value['to_collection_method'],
                            ->(val) { val.instance_of? String })
  )
end