Class: AdvancedBilling::ReferralCode

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

Overview

ReferralCode 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, site_id: SKIP, subscription_id: SKIP, code: SKIP, additional_properties: {}) ⇒ ReferralCode

Returns a new instance of ReferralCode.



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

def initialize(id: SKIP, site_id: SKIP, subscription_id: SKIP, code: SKIP,
               additional_properties: {})
  @id = id unless id == SKIP
  @site_id = site_id unless site_id == SKIP
  @subscription_id = subscription_id unless subscription_id == SKIP
  @code = code unless code == 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

TODO: Write general description for this method

Returns:

  • (String) 


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

def code
  @code
end

#id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def id
  @id
end

#site_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def site_id
  @site_id
end

#subscription_id ⇒ Integer

TODO: Write general description for this method

Returns:

  • (Integer) 


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

def subscription_id
  @subscription_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/advanced_billing/models/referral_code.rb', line 67

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  id = hash.key?('id') ? hash['id'] : SKIP
  site_id = hash.key?('site_id') ? hash['site_id'] : SKIP
  subscription_id =
    hash.key?('subscription_id') ? hash['subscription_id'] : SKIP
  code = hash.key?('code') ? hash['code'] : SKIP

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

  # Create object from extracted values.
  ReferralCode.new(id: id,
                   site_id: site_id,
                   subscription_id: subscription_id,
                   code: code,
                   additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['id'] = 'id'
  @_hash['site_id'] = 'site_id'
  @_hash['subscription_id'] = 'subscription_id'
  @_hash['code'] = 'code'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



49
50
51
 
# File 'lib/advanced_billing/models/referral_code.rb', line 49

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



39
40
41
42
43
44
45
46
 
# File 'lib/advanced_billing/models/referral_code.rb', line 39

def self.optionals
  %w[
    id
    site_id
    subscription_id
    code
  ]
end