Class: AdvancedBilling::SubscriptionGroupSignupItem

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

Overview

SubscriptionGroupSignupItem Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

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

Constructor Details

#initialize(product_handle: SKIP, product_id: SKIP, product_price_point_id: SKIP, product_price_point_handle: SKIP, offer_id: SKIP, reference: SKIP, primary: SKIP, currency: SKIP, coupon_codes: SKIP, components: SKIP, custom_price: SKIP, calendar_billing: SKIP, metafields: SKIP, additional_properties: {}) ⇒ SubscriptionGroupSignupItem

Returns a new instance of SubscriptionGroupSignupItem.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/advanced_billing/models/subscription_group_signup_item.rb', line 118

def initialize(product_handle: SKIP, product_id: SKIP,
               product_price_point_id: SKIP,
               product_price_point_handle: SKIP, offer_id: SKIP,
               reference: SKIP, primary: SKIP, currency: SKIP,
               coupon_codes: SKIP, components: SKIP, custom_price: SKIP,
               calendar_billing: SKIP, metafields: SKIP,
               additional_properties: {})
  # Add additional model properties to the instance.

  additional_properties.each do |_name, _value|
    instance_variable_set("@#{_name}", _value)
  end

  @product_handle = product_handle unless product_handle == SKIP
  @product_id = product_id unless product_id == SKIP
  @product_price_point_id = product_price_point_id unless product_price_point_id == SKIP
  unless product_price_point_handle == SKIP
    @product_price_point_handle =
      product_price_point_handle
  end
  @offer_id = offer_id unless offer_id == SKIP
  @reference = reference unless reference == SKIP
  @primary = primary unless primary == SKIP
  @currency = currency unless currency == SKIP
  @coupon_codes = coupon_codes unless coupon_codes == SKIP
  @components = components unless components == SKIP
  @custom_price = custom_price unless custom_price == SKIP
  @calendar_billing = calendar_billing unless calendar_billing == SKIP
  @metafields = metafields unless metafields == SKIP
end

Instance Attribute Details

#calendar_billing ⇒ CalendarBilling

(Optional). Cannot be used when also specifying next_billing_at

Returns:



67
68
69
 
# File 'lib/advanced_billing/models/subscription_group_signup_item.rb', line 67

def calendar_billing
  @calendar_billing
end

#components ⇒ Array[SubscriptionGroupSignupComponent]

An array for all the coupons attached to the subscription.

Returns:



57
58
59
 
# File 'lib/advanced_billing/models/subscription_group_signup_item.rb', line 57

def components
  @components
end

#coupon_codes ⇒ Array[String]

An array for all the coupons attached to the subscription.

Returns:

  • (Array[String]) 


53
54
55
 
# File 'lib/advanced_billing/models/subscription_group_signup_item.rb', line 53

def coupon_codes
  @coupon_codes
end

#currency ⇒ String

(Optional) If Multi-Currency is enabled and the currency is configured in Chargify, pass it at signup to create a subscription on a non-default currency. Note that you cannot update the currency of an existing subscription.

Returns:

  • (String) 


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

def currency
  @currency
end

#custom_price ⇒ SubscriptionCustomPrice

(Optional) Used in place of product_price_point_id to define a custom price point unique to the subscription. A subscription can have up to 30 custom price points. Exceeding this limit will result in an API error.

Returns:



63
64
65
 
# File 'lib/advanced_billing/models/subscription_group_signup_item.rb', line 63

def custom_price
  @custom_price
end

#metafields ⇒ Hash[String, String]

(Optional) A set of key/value pairs representing custom fields and their values. Metafields will be created “on-the-fly” in your site for a given key, if they have not been created yet.

Returns:

  • (Hash[String, String]) 


73
74
75
 
# File 'lib/advanced_billing/models/subscription_group_signup_item.rb', line 73

def metafields
  @metafields
end

#offer_id ⇒ Integer

Use in place of passing product and component information to set up the subscription with an existing offer. May be either the Chargify ID of the offer or its handle prefixed with handle:

Returns:

  • (Integer) 


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

def offer_id
  @offer_id
end

#primary ⇒ TrueClass | FalseClass

One of the subscriptions must be marked as primary in the group.

Returns:

  • (TrueClass | FalseClass) 


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

def primary
  @primary
end

#product_handle ⇒ String

The API Handle of the product for which you are creating a subscription. Required, unless a product_id is given instead.

Returns:

  • (String) 


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

def product_handle
  @product_handle
end

#product_id ⇒ Integer

The Product ID of the product for which you are creating a subscription. You can pass either product_id or product_handle.

Returns:

  • (Integer) 


20
21
22
 
# File 'lib/advanced_billing/models/subscription_group_signup_item.rb', line 20

def product_id
  @product_id
end

#product_price_point_handle ⇒ String

The user-friendly API handle of a product’s particular price point.

Returns:

  • (String) 


28
29
30
 
# File 'lib/advanced_billing/models/subscription_group_signup_item.rb', line 28

def product_price_point_handle
  @product_price_point_handle
end

#product_price_point_id ⇒ Integer

The ID of the particular price point on the product.

Returns:

  • (Integer) 


24
25
26
 
# File 'lib/advanced_billing/models/subscription_group_signup_item.rb', line 24

def product_price_point_id
  @product_price_point_id
end

#reference ⇒ String

The reference value (provided by your app) for the subscription itelf.

Returns:

  • (String) 


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

def reference
  @reference
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/advanced_billing/models/subscription_group_signup_item.rb', line 149

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  product_handle =
    hash.key?('product_handle') ? hash['product_handle'] : SKIP
  product_id = hash.key?('product_id') ? hash['product_id'] : SKIP
  product_price_point_id =
    hash.key?('product_price_point_id') ? hash['product_price_point_id'] : SKIP
  product_price_point_handle =
    hash.key?('product_price_point_handle') ? hash['product_price_point_handle'] : SKIP
  offer_id = hash.key?('offer_id') ? hash['offer_id'] : SKIP
  reference = hash.key?('reference') ? hash['reference'] : SKIP
  primary = hash.key?('primary') ? hash['primary'] : SKIP
  currency = hash.key?('currency') ? hash['currency'] : SKIP
  coupon_codes = hash.key?('coupon_codes') ? hash['coupon_codes'] : SKIP
  # Parameter is an array, so we need to iterate through it

  components = nil
  unless hash['components'].nil?
    components = []
    hash['components'].each do |structure|
      components << (SubscriptionGroupSignupComponent.from_hash(structure) if structure)
    end
  end

  components = SKIP unless hash.key?('components')
  custom_price = SubscriptionCustomPrice.from_hash(hash['custom_price']) if
    hash['custom_price']
  calendar_billing = CalendarBilling.from_hash(hash['calendar_billing']) if
    hash['calendar_billing']
  metafields = hash.key?('metafields') ? hash['metafields'] : SKIP

  # Clean out expected properties from Hash.

  additional_properties = hash.reject { |k, _| names.value?(k) }

  # Create object from extracted values.

  SubscriptionGroupSignupItem.new(product_handle: product_handle,
                                  product_id: product_id,
                                  product_price_point_id: product_price_point_id,
                                  product_price_point_handle: product_price_point_handle,
                                  offer_id: offer_id,
                                  reference: reference,
                                  primary: primary,
                                  currency: currency,
                                  coupon_codes: coupon_codes,
                                  components: components,
                                  custom_price: custom_price,
                                  calendar_billing: calendar_billing,
                                  metafields: metafields,
                                  additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['product_handle'] = 'product_handle'
  @_hash['product_id'] = 'product_id'
  @_hash['product_price_point_id'] = 'product_price_point_id'
  @_hash['product_price_point_handle'] = 'product_price_point_handle'
  @_hash['offer_id'] = 'offer_id'
  @_hash['reference'] = 'reference'
  @_hash['primary'] = 'primary'
  @_hash['currency'] = 'currency'
  @_hash['coupon_codes'] = 'coupon_codes'
  @_hash['components'] = 'components'
  @_hash['custom_price'] = 'custom_price'
  @_hash['calendar_billing'] = 'calendar_billing'
  @_hash['metafields'] = 'metafields'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



114
115
116
 
# File 'lib/advanced_billing/models/subscription_group_signup_item.rb', line 114

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/advanced_billing/models/subscription_group_signup_item.rb', line 95

def self.optionals
  %w[
    product_handle
    product_id
    product_price_point_id
    product_price_point_handle
    offer_id
    reference
    primary
    currency
    coupon_codes
    components
    custom_price
    calendar_billing
    metafields
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:



203
204
205
206
207
208
209
 
# File 'lib/advanced_billing/models/subscription_group_signup_item.rb', line 203

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/advanced_billing/models/subscription_group_signup_item.rb', line 223

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} product_handle: #{@product_handle.inspect}, product_id:"\
  " #{@product_id.inspect}, product_price_point_id: #{@product_price_point_id.inspect},"\
  " product_price_point_handle: #{@product_price_point_handle.inspect}, offer_id:"\
  " #{@offer_id.inspect}, reference: #{@reference.inspect}, primary: #{@primary.inspect},"\
  " currency: #{@currency.inspect}, coupon_codes: #{@coupon_codes.inspect}, components:"\
  " #{@components.inspect}, custom_price: #{@custom_price.inspect}, calendar_billing:"\
  " #{@calendar_billing.inspect}, metafields: #{@metafields.inspect}, additional_properties:"\
  " #{get_additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



212
213
214
215
216
217
218
219
220
 
# File 'lib/advanced_billing/models/subscription_group_signup_item.rb', line 212

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} product_handle: #{@product_handle}, product_id: #{@product_id},"\
  " product_price_point_id: #{@product_price_point_id}, product_price_point_handle:"\
  " #{@product_price_point_handle}, offer_id: #{@offer_id}, reference: #{@reference}, primary:"\
  " #{@primary}, currency: #{@currency}, coupon_codes: #{@coupon_codes}, components:"\
  " #{@components}, custom_price: #{@custom_price}, calendar_billing: #{@calendar_billing},"\
  " metafields: #{@metafields}, additional_properties: #{get_additional_properties}>"
end