Class: AdvancedBilling::UpdateSubscriptionNote

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

Overview

Updatable fields for Subscription Note

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(body:, sticky:, additional_properties: {}) ⇒ UpdateSubscriptionNote

Returns a new instance of UpdateSubscriptionNote.



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

def initialize(body:, sticky:, additional_properties: {})
  @body = body
  @sticky = sticky

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

Instance Attribute Details

#body ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def body
  @body
end

#sticky ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def sticky
  @sticky
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  body = hash.key?('body') ? hash['body'] : nil
  sticky = hash.key?('sticky') ? hash['sticky'] : nil

  # Clean out expected properties from Hash.
  names.each_value { |k| hash.delete(k) }

  # Create object from extracted values.
  UpdateSubscriptionNote.new(body: body,
                             sticky: sticky,
                             additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  []
end