Class: Billabear::SubscriptionStartBody

Inherits:
Object
  • Object
show all
Defined in:
lib/billabear/models/subscription_start_body.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionStartBody

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
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
147
148
149
 
# File 'lib/billabear/models/subscription_start_body.rb', line 101

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Billabear::SubscriptionStartBody` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Billabear::SubscriptionStartBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'subscription_plan')
    self.subscription_plan = attributes[:'subscription_plan']
  end

  if attributes.key?(:'payment_details')
    self.payment_details = attributes[:'payment_details']
  end

  if attributes.key?(:'card_token')
    self.card_token = attributes[:'card_token']
  end

  if attributes.key?(:'price')
    self.price = attributes[:'price']
  end

  if attributes.key?(:'schedule')
    self.schedule = attributes[:'schedule']
  end

  if attributes.key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.key?(:'seat_numbrers')
    self.seat_numbrers = attributes[:'seat_numbrers']
  end

  if attributes.key?(:'deny_trial')
    self.deny_trial = attributes[:'deny_trial']
  end

  if attributes.key?(:'metadata')
    self.metadata = attributes[:'metadata']
  end
end

Instance Attribute Details

#card_token ⇒ Object

A stripe card token that’s been created using Stripe’s js sdk. It’ll create the payment details for the customer.



23
24
25
 
# File 'lib/billabear/models/subscription_start_body.rb', line 23

def card_token
  @card_token
end

#currency ⇒ Object

The currency of the plan that is to be started. Only used if price isn’t given. Requires schedule as well.



32
33
34
 
# File 'lib/billabear/models/subscription_start_body.rb', line 32

def currency
  @currency
end

#deny_trial ⇒ Object

Returns the value of attribute deny_trial.



36
37
38
 
# File 'lib/billabear/models/subscription_start_body.rb', line 36

def deny_trial
  @deny_trial
end

#metadata ⇒ Object

Any metadata you want to add to a subscription



39
40
41
 
# File 'lib/billabear/models/subscription_start_body.rb', line 39

def metadata
  @metadata
end

#payment_details ⇒ Object

The Id for the customer’s payment details to be used



20
21
22
 
# File 'lib/billabear/models/subscription_start_body.rb', line 20

def payment_details
  @payment_details
end

#price ⇒ Object

The ID for the price to be used



26
27
28
 
# File 'lib/billabear/models/subscription_start_body.rb', line 26

def price
  @price
end

#schedule ⇒ Object

The schedule of the plan that is to be started. Only used if price isn’t given. Requires currency as well.



29
30
31
 
# File 'lib/billabear/models/subscription_start_body.rb', line 29

def schedule
  @schedule
end

#seat_numbrers ⇒ Object

Returns the value of attribute seat_numbrers.



34
35
36
 
# File 'lib/billabear/models/subscription_start_body.rb', line 34

def seat_numbrers
  @seat_numbrers
end

#subscription_plan ⇒ Object

The ID for the subscription plan to be used (Can also be the code name)



17
18
19
 
# File 'lib/billabear/models/subscription_start_body.rb', line 17

def subscription_plan
  @subscription_plan
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/billabear/models/subscription_start_body.rb', line 64

def self.attribute_map
  {
    :'subscription_plan' => :'subscription_plan',
    :'payment_details' => :'payment_details',
    :'card_token' => :'card_token',
    :'price' => :'price',
    :'schedule' => :'schedule',
    :'currency' => :'currency',
    :'seat_numbrers' => :'seat_numbrers',
    :'deny_trial' => :'deny_trial',
    :'metadata' => :'metadata'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



212
213
214
 
# File 'lib/billabear/models/subscription_start_body.rb', line 212

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
 
# File 'lib/billabear/models/subscription_start_body.rb', line 94

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/billabear/models/subscription_start_body.rb', line 79

def self.openapi_types
  {
    :'subscription_plan' => :'Object',
    :'payment_details' => :'Object',
    :'card_token' => :'Object',
    :'price' => :'Object',
    :'schedule' => :'Object',
    :'currency' => :'Object',
    :'seat_numbrers' => :'Object',
    :'deny_trial' => :'Object',
    :'metadata' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/billabear/models/subscription_start_body.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      subscription_plan == o.subscription_plan &&
      payment_details == o.payment_details &&
      card_token == o.card_token &&
      price == o.price &&
      schedule == o.schedule &&
      currency == o.currency &&
      seat_numbrers == o.seat_numbrers &&
      deny_trial == o.deny_trial &&
      metadata == o.metadata
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/billabear/models/subscription_start_body.rb', line 242

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    Billabear.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/billabear/models/subscription_start_body.rb', line 311

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/billabear/models/subscription_start_body.rb', line 219

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


199
200
201
 
# File 'lib/billabear/models/subscription_start_body.rb', line 199

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



205
206
207
 
# File 'lib/billabear/models/subscription_start_body.rb', line 205

def hash
  [subscription_plan, payment_details, card_token, price, schedule, currency, seat_numbrers, deny_trial, metadata].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



153
154
155
156
157
158
159
160
 
# File 'lib/billabear/models/subscription_start_body.rb', line 153

def list_invalid_properties
  invalid_properties = Array.new
  if @subscription_plan.nil?
    invalid_properties.push('invalid value for "subscription_plan", subscription_plan cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



287
288
289
 
# File 'lib/billabear/models/subscription_start_body.rb', line 287

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/billabear/models/subscription_start_body.rb', line 293

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



281
282
283
 
# File 'lib/billabear/models/subscription_start_body.rb', line 281

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



164
165
166
167
168
169
 
# File 'lib/billabear/models/subscription_start_body.rb', line 164

def valid?
  return false if @subscription_plan.nil?
  schedule_validator = EnumAttributeValidator.new('Object', ['week', 'month', 'year', 'one-off'])
  return false unless schedule_validator.valid?(@schedule)
  true
end