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

#to_hash, #to_json

Constructor Details

#initialize(name = SKIP, description = SKIP) ⇒ CreateProductFamily

Returns a new instance of CreateProductFamily.



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

def initialize(name = SKIP, description = SKIP)
  @name = name unless name == SKIP
  @description = description unless description == SKIP
end

Instance Attribute Details

#descriptionString

TODO: Write general description for this method

Returns:

  • (String)


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

def description
  @description
end

#nameString

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.



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

def self.from_hash(hash)
  return nil unless hash

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

  # Create object from extracted values.
  CreateProductFamily.new(name,
                          description)
end

.namesObject

A mapping from model property names to API property names.



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

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

.nullablesObject

An array for nullable fields



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

def self.nullables
  %w[
    description
  ]
end

.optionalsObject

An array for optional fields



29
30
31
32
33
34
# File 'lib/advanced_billing/models/create_product_family.rb', line 29

def self.optionals
  %w[
    name
    description
  ]
end