Class: AdvancedBilling::SubscriptionGroupSignupSuccessData

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

Overview

SubscriptionGroupSignupSuccessData Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(uid = nil, scheme = nil, customer_id = nil, payment_profile_id = nil, subscription_ids = nil, primary_subscription_id = nil, next_assessment_at = nil, state = nil, cancel_at_end_of_period = nil) ⇒ SubscriptionGroupSignupSuccessData

Returns a new instance of SubscriptionGroupSignupSuccessData.



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_data.rb', line 73

def initialize(uid = nil,
               scheme = nil,
               customer_id = nil,
               payment_profile_id = nil,
               subscription_ids = nil,
               primary_subscription_id = nil,
               next_assessment_at = nil,
               state = nil,
               cancel_at_end_of_period = nil)
  @uid = uid
  @scheme = scheme
  @customer_id = customer_id
  @payment_profile_id = payment_profile_id
  @subscription_ids = subscription_ids
  @primary_subscription_id = primary_subscription_id
  @next_assessment_at = next_assessment_at
  @state = state
  @cancel_at_end_of_period = cancel_at_end_of_period
end

Instance Attribute Details

#cancel_at_end_of_periodTrueClass | FalseClass

TODO: Write general description for this method

Returns:



46
47
48
# File 'lib/advanced_billing/models/subscription_group_signup_success_data.rb', line 46

def cancel_at_end_of_period
  @cancel_at_end_of_period
end

#customer_idInteger

TODO: Write general description for this method

Returns:



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

def customer_id
  @customer_id
end

#next_assessment_atString

TODO: Write general description for this method

Returns:



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

def next_assessment_at
  @next_assessment_at
end

#payment_profile_idInteger

TODO: Write general description for this method

Returns:



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

def payment_profile_id
  @payment_profile_id
end

#primary_subscription_idInteger

TODO: Write general description for this method

Returns:



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

def primary_subscription_id
  @primary_subscription_id
end

#schemeInteger

TODO: Write general description for this method

Returns:



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

def scheme
  @scheme
end

#stateString

TODO: Write general description for this method

Returns:



42
43
44
# File 'lib/advanced_billing/models/subscription_group_signup_success_data.rb', line 42

def state
  @state
end

#subscription_idsArray[Integer]

TODO: Write general description for this method

Returns:



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

def subscription_ids
  @subscription_ids
end

#uidString

TODO: Write general description for this method

Returns:



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

def uid
  @uid
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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
# File 'lib/advanced_billing/models/subscription_group_signup_success_data.rb', line 94

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  uid = hash.key?('uid') ? hash['uid'] : nil
  scheme = hash.key?('scheme') ? hash['scheme'] : nil
  customer_id = hash.key?('customer_id') ? hash['customer_id'] : nil
  payment_profile_id =
    hash.key?('payment_profile_id') ? hash['payment_profile_id'] : nil
  subscription_ids =
    hash.key?('subscription_ids') ? hash['subscription_ids'] : nil
  primary_subscription_id =
    hash.key?('primary_subscription_id') ? hash['primary_subscription_id'] : nil
  next_assessment_at =
    hash.key?('next_assessment_at') ? hash['next_assessment_at'] : nil
  state = hash.key?('state') ? hash['state'] : nil
  cancel_at_end_of_period =
    hash.key?('cancel_at_end_of_period') ? hash['cancel_at_end_of_period'] : nil

  # Create object from extracted values.

  SubscriptionGroupSignupSuccessData.new(uid,
                                         scheme,
                                         customer_id,
                                         payment_profile_id,
                                         subscription_ids,
                                         primary_subscription_id,
                                         next_assessment_at,
                                         state,
                                         cancel_at_end_of_period)
end

.namesObject

A mapping from model property names to API property names.



49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/advanced_billing/models/subscription_group_signup_success_data.rb', line 49

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['uid'] = 'uid'
  @_hash['scheme'] = 'scheme'
  @_hash['customer_id'] = 'customer_id'
  @_hash['payment_profile_id'] = 'payment_profile_id'
  @_hash['subscription_ids'] = 'subscription_ids'
  @_hash['primary_subscription_id'] = 'primary_subscription_id'
  @_hash['next_assessment_at'] = 'next_assessment_at'
  @_hash['state'] = 'state'
  @_hash['cancel_at_end_of_period'] = 'cancel_at_end_of_period'
  @_hash
end

.nullablesObject

An array for nullable fields



69
70
71
# File 'lib/advanced_billing/models/subscription_group_signup_success_data.rb', line 69

def self.nullables
  []
end

.optionalsObject

An array for optional fields



64
65
66
# File 'lib/advanced_billing/models/subscription_group_signup_success_data.rb', line 64

def self.optionals
  []
end