Class: AdvancedBilling::CreateProductFamily

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

Overview

CreateProductFamily 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(name:, handle: SKIP, description: SKIP, additional_properties: {}) ⇒ CreateProductFamily

Returns a new instance of CreateProductFamily.



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/advanced_billing/models/create_product_family.rb', line 49

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

  @name = name
  @handle = handle unless handle == SKIP
  @description = description unless description == SKIP
end

Instance Attribute Details

#description ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def description
  @description
end

#handle ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def handle
  @handle
end

#name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def name
  @name
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

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

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

  # Create object from extracted values.
  CreateProductFamily.new(name: name,
                          handle: handle,
                          description: description,
                          additional_properties: additional_properties)
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_product_family.rb', line 25

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

.nullables ⇒ Object

An array for nullable fields



42
43
44
45
46
47
 
# File 'lib/advanced_billing/models/create_product_family.rb', line 42

def self.nullables
  %w[
    handle
    description
  ]
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    handle
    description
  ]
end