Class: AdvancedBilling::PendingCancellationChange

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

Overview

PendingCancellationChange Model.

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(cancellation_state:, cancels_at:, additional_properties: {}) ⇒ PendingCancellationChange

Returns a new instance of PendingCancellationChange.



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

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

  @cancellation_state = cancellation_state
  @cancels_at = cancels_at
end

Instance Attribute Details

#cancellation_state ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


15
16
17
 
# File 'lib/advanced_billing/models/pending_cancellation_change.rb', line 15

def cancellation_state
  @cancellation_state
end

#cancels_at ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


19
20
21
 
# File 'lib/advanced_billing/models/pending_cancellation_change.rb', line 19

def cancels_at
  @cancels_at
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
67
 
# File 'lib/advanced_billing/models/pending_cancellation_change.rb', line 50

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  cancellation_state =
    hash.key?('cancellation_state') ? hash['cancellation_state'] : nil
  cancels_at = if hash.key?('cancels_at')
                 (DateTimeHelper.from_rfc3339(hash['cancels_at']) if hash['cancels_at'])
               end

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

  # Create object from extracted values.
  PendingCancellationChange.new(cancellation_state: cancellation_state,
                                cancels_at: cancels_at,
                                additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



35
36
37
 
# File 'lib/advanced_billing/models/pending_cancellation_change.rb', line 35

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



30
31
32
 
# File 'lib/advanced_billing/models/pending_cancellation_change.rb', line 30

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/advanced_billing/models/pending_cancellation_change.rb', line 75

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

  return false unless value.instance_of? Hash

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

Instance Method Details

#to_custom_cancels_at ⇒ Object 



69
70
71
 
# File 'lib/advanced_billing/models/pending_cancellation_change.rb', line 69

def to_custom_cancels_at
  DateTimeHelper.to_rfc3339(cancels_at)
end