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, additional_properties: {}) ⇒ ProductFamily

Returns a new instance of ProductFamily.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/advanced_billing/models/product_family.rb', line 75

def initialize(id: SKIP, name: SKIP, handle: SKIP, accounting_code: SKIP,
               description: SKIP, created_at: SKIP, updated_at: SKIP,
               additional_properties: {})
  @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

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

Instance Attribute Details

#accounting_code ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def accounting_code
  @accounting_code
end

#created_at ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


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

def created_at
  @created_at
end

#description ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def description
  @description
end

#handle ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def handle
  @handle
end

#id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def id
  @id
end

#name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def name
  @name
end

#updated_at ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


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

def updated_at
  @updated_at
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/advanced_billing/models/product_family.rb', line 93

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 = if hash.key?('created_at')
                 (DateTimeHelper.from_rfc3339(hash['created_at']) if hash['created_at'])
               else
                 SKIP
               end
  updated_at = if hash.key?('updated_at')
                 (DateTimeHelper.from_rfc3339(hash['updated_at']) if hash['updated_at'])
               else
                 SKIP
               end

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

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

.names ⇒ Object

A mapping from model property names to API property names.



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

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



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

def self.nullables
  %w[
    accounting_code
    description
  ]
end

.optionals ⇒ Object

An array for optional fields



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

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

Instance Method Details

#to_custom_created_at ⇒ Object 



128
129
130
 
# File 'lib/advanced_billing/models/product_family.rb', line 128

def to_custom_created_at
  DateTimeHelper.to_rfc3339(created_at)
end

#to_custom_updated_at ⇒ Object 



132
133
134
 
# File 'lib/advanced_billing/models/product_family.rb', line 132

def to_custom_updated_at
  DateTimeHelper.to_rfc3339(updated_at)
end