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

#to_hash, #to_json

Constructor Details

#initialize(cancellation_state = nil, cancels_at = nil) ⇒ PendingCancellationChange

Returns a new instance of PendingCancellationChange.



38
39
40
41
 
# File 'lib/advanced_billing/models/pending_cancellation_change.rb', line 38

def initialize(cancellation_state = nil, cancels_at = nil)
  @cancellation_state = cancellation_state
  @cancels_at = cancels_at
end

Instance Attribute Details

#cancellation_state ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def cancellation_state
  @cancellation_state
end

#cancels_at ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def cancels_at
  @cancels_at
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/advanced_billing/models/pending_cancellation_change.rb', line 44

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

  # Create object from extracted values.

  PendingCancellationChange.new(cancellation_state,
                                cancels_at)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/advanced_billing/models/pending_cancellation_change.rb', line 59

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? String })
    )
  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