Class: AdvancedBilling::CreateReasonCode

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

Overview

CreateReasonCode Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(code:, description:, position: SKIP, additional_properties: {}) ⇒ CreateReasonCode

Returns a new instance of CreateReasonCode.



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

def initialize(code:, description:, position: SKIP,
               additional_properties: {})
  @code = code
  @description = description
  @position = position unless position == SKIP

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

Instance Attribute Details

#code ⇒ String

The unique identifier for the ReasonCode

Returns:

  • (String) 


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

def code
  @code
end

#description ⇒ String

The friendly summary of what the code signifies

Returns:

  • (String) 


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

def description
  @description
end

#position ⇒ Integer

The order that code appears in lists

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/advanced_billing/models/create_reason_code.rb', line 22

def position
  @position
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  code = hash.key?('code') ? hash['code'] : nil
  description = hash.key?('description') ? hash['description'] : nil
  position = hash.key?('position') ? hash['position'] : SKIP

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

  # Create object from extracted values.
  CreateReasonCode.new(code: code,
                       description: description,
                       position: position,
                       additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/advanced_billing/models/create_reason_code.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['code'] = 'code'
  @_hash['description'] = 'description'
  @_hash['position'] = 'position'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
 
# File 'lib/advanced_billing/models/create_reason_code.rb', line 34

def self.optionals
  %w[
    position
  ]
end