Class: AdvancedBilling::SubscriptionGroupSignupSuccess

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

Overview

SubscriptionGroupSignupSuccess Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(subscription_group:, customer:, additional_properties: {}) ⇒ SubscriptionGroupSignupSuccess

Returns a new instance of SubscriptionGroupSignupSuccess.



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

def initialize(subscription_group:, customer:, additional_properties: {})
  @subscription_group = subscription_group
  @customer = customer

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

Instance Attribute Details

#customer ⇒ Customer

TODO: Write general description for this method

Returns:



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

def customer
  @customer
end

#subscription_group ⇒ SubscriptionGroupSignupSuccessData

TODO: Write general description for this method

Returns:



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

def subscription_group
  @subscription_group
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
60
61
62
63
64
65
 
# File 'lib/advanced_billing/models/subscription_group_signup_success.rb', line 49

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  if hash['subscription_group']
    subscription_group = SubscriptionGroupSignupSuccessData.from_hash(hash['subscription_group'])
  end
  customer = Customer.from_hash(hash['customer']) if hash['customer']

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

  # Create object from extracted values.
  SubscriptionGroupSignupSuccess.new(subscription_group: subscription_group,
                                     customer: customer,
                                     additional_properties: hash)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
 
# File 'lib/advanced_billing/models/subscription_group_signup_success.rb', line 29

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/advanced_billing/models/subscription_group_signup_success.rb', line 69

def self.validate(value)
  if value.instance_of? self
    return (
      APIHelper.valid_type?(value.subscription_group,
                            ->(val) { SubscriptionGroupSignupSuccessData.validate(val) },
                            is_model_hash: true) and
        APIHelper.valid_type?(value.customer,
                              ->(val) { Customer.validate(val) },
                              is_model_hash: true)
    )
  end

  return false unless value.instance_of? Hash

  (
    APIHelper.valid_type?(value['subscription_group'],
                          ->(val) { SubscriptionGroupSignupSuccessData.validate(val) },
                          is_model_hash: true) and
      APIHelper.valid_type?(value['customer'],
                            ->(val) { Customer.validate(val) },
                            is_model_hash: true)
  )
end