Class: AdvancedBilling::SubscriptionGroupSignupEventData

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

Overview

SubscriptionGroupSignupEventData Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

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

Returns a new instance of SubscriptionGroupSignupEventData.



40
41
42
43
44
45
46
47
48
# File 'lib/advanced_billing/models/subscription_group_signup_event_data.rb', line 40

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

  @subscription_group = subscription_group
  @customer = customer
end

Instance Attribute Details

#customerCustomer

TODO: Write general description for this method

Returns:



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

def customer
  @customer
end

#subscription_groupSubscriptionGroupSignupFailureData

TODO: Write general description for this method



14
15
16
# File 'lib/advanced_billing/models/subscription_group_signup_event_data.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.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/advanced_billing/models/subscription_group_signup_event_data.rb', line 51

def self.from_hash(hash)
  return nil unless hash

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

  # Clean out expected properties from Hash.
  additional_properties = hash.reject { |k, _| names.value?(k) }

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

.namesObject

A mapping from model property names to API property names.



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

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

.nullablesObject

An array for nullable fields



34
35
36
37
38
# File 'lib/advanced_billing/models/subscription_group_signup_event_data.rb', line 34

def self.nullables
  %w[
    customer
  ]
end

.optionalsObject

An array for optional fields



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

def self.optionals
  []
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



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

def self.validate(value)
  if value.instance_of? self
    return (
      APIHelper.valid_type?(value.subscription_group,
                            ->(val) { SubscriptionGroupSignupFailureData.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) { SubscriptionGroupSignupFailureData.validate(val) },
                          is_model_hash: true) and
      APIHelper.valid_type?(value['customer'],
                            ->(val) { Customer.validate(val) },
                            is_model_hash: true)
  )
end