Class: AdvancedBilling::ProductFamily

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

Overview

ProductFamily Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(id = SKIP, name = SKIP, handle = SKIP, accounting_code = SKIP, description = SKIP, created_at = SKIP, updated_at = SKIP) ⇒ ProductFamily

Returns a new instance of ProductFamily.



74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/advanced_billing/models/product_family.rb', line 74

def initialize(id = SKIP, name = SKIP, handle = SKIP,
               accounting_code = SKIP, description = SKIP,
               created_at = SKIP, updated_at = SKIP)
  @id = id unless id == SKIP
  @name = name unless name == SKIP
  @handle = handle unless handle == SKIP
  @accounting_code = accounting_code unless accounting_code == SKIP
  @description = description unless description == SKIP
  @created_at = created_at unless created_at == SKIP
  @updated_at = updated_at unless updated_at == SKIP
end

Instance Attribute Details

#accounting_code ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


26
27
28
 
# File 'lib/advanced_billing/models/product_family.rb', line 26

def accounting_code
  @accounting_code
end

#created_at ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def created_at
  @created_at
end

#description ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


30
31
32
 
# File 'lib/advanced_billing/models/product_family.rb', line 30

def description
  @description
end

#handle ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def handle
  @handle
end

#id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def id
  @id
end

#name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def name
  @name
end

#updated_at ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def updated_at
  @updated_at
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/advanced_billing/models/product_family.rb', line 87

def self.from_hash(hash)
  return nil unless hash

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

  # Create object from extracted values.
  ProductFamily.new(id,
                    name,
                    handle,
                    accounting_code,
                    description,
                    created_at,
                    updated_at)
end

.names ⇒ Object

A mapping from model property names to API property names.



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/advanced_billing/models/product_family.rb', line 41

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

.nullables ⇒ Object

An array for nullable fields



67
68
69
70
71
72
 
# File 'lib/advanced_billing/models/product_family.rb', line 67

def self.nullables
  %w[
    accounting_code
    description
  ]
end

.optionals ⇒ Object

An array for optional fields



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/advanced_billing/models/product_family.rb', line 54

def self.optionals
  %w[
    id
    name
    handle
    accounting_code
    description
    created_at
    updated_at
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:

  • The (ProductFamily | Hash) —

    value against the validation is performed.



112
113
114
115
116
117
118
 
# File 'lib/advanced_billing/models/product_family.rb', line 112

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end