Class: WalleeRubySdk::ProductPeriodFee

Inherits:
Object
  • Object
show all
Defined in:
lib/wallee-ruby-sdk/models/product_period_fee.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProductPeriodFee

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 121

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `WalleeRubySdk::ProductPeriodFee` 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|
    unless self.class.attribute_map.key?(k.to_sym)
      fail ArgumentError, "`#{k}` is not a valid attribute in `WalleeRubySdk::ProductPeriodFee`. 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?(:'period_fee')
    if (value = attributes[:'period_fee']).is_a?(Array)
      self.period_fee = value
    end
  end

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

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

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

  if attributes.key?(:'name')
    if (value = attributes[:'name']).is_a?(Hash)
      self.name = value
    end
  end

  if attributes.key?(:'description')
    if (value = attributes[:'description']).is_a?(Hash)
      self.description = value
    end
  end

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

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

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

  if attributes.key?(:'ledger_entry_title')
    if (value = attributes[:'ledger_entry_title']).is_a?(Hash)
      self.ledger_entry_title = value
    end
  end
end

Instance Attribute Details

#component ⇒ Object

Returns the value of attribute component.



32
33
34
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 32

def component
  @component
end

#description ⇒ Object

The localized description of the fee that is displayed to the customer.



41
42
43
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 41

def description
  @description
end

#id ⇒ Object

A unique identifier for the object.



44
45
46
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 44

def id
  @id
end

#ledger_entry_title ⇒ Object

The localized title that be used on ledger entries and invoices.



52
53
54
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 52

def ledger_entry_title
  @ledger_entry_title
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



30
31
32
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 30

def linked_space_id
  @linked_space_id
end

#name ⇒ Object

The localized name of the fee that is displayed to the customer.



38
39
40
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 38

def name
  @name
end

#number_of_free_trial_periods ⇒ Object

The number of subscription billing cycles that count as a trial phase and during which no fees are charged.



35
36
37
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 35

def number_of_free_trial_periods
  @number_of_free_trial_periods
end

#period_fee ⇒ Object

The amount charged to the customer for each billing cycle during the term of a subscription.



27
28
29
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 27

def period_fee
  @period_fee
end

#type ⇒ Object

Returns the value of attribute type.



46
47
48
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 46

def type
  @type
end

#version ⇒ Object

The version is used for optimistic locking and incremented whenever the object is updated.



49
50
51
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 49

def version
  @version
end

Class Method Details

._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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 262

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = WalleeRubySdk.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



93
94
95
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 93

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 77

def self.attribute_map
  {
    :'period_fee' => :'periodFee',
    :'linked_space_id' => :'linkedSpaceId',
    :'component' => :'component',
    :'number_of_free_trial_periods' => :'numberOfFreeTrialPeriods',
    :'name' => :'name',
    :'description' => :'description',
    :'id' => :'id',
    :'type' => :'type',
    :'version' => :'version',
    :'ledger_entry_title' => :'ledgerEntryTitle'
  }
end

.build_from_hash(attributes) ⇒ Object

Returns the model itself

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 238

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



114
115
116
117
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 114

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

.openapi_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 98

def self.openapi_types
  {
    :'period_fee' => :'Array<PersistableCurrencyAmount>',
    :'linked_space_id' => :'Integer',
    :'component' => :'SubscriptionProductComponent',
    :'number_of_free_trial_periods' => :'Integer',
    :'name' => :'Hash<String, String>',
    :'description' => :'Hash<String, String>',
    :'id' => :'Integer',
    :'type' => :'ProductFeeType',
    :'version' => :'Integer',
    :'ledger_entry_title' => :'Hash<String, String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      period_fee == o.period_fee &&
      linked_space_id == o.linked_space_id &&
      component == o.component &&
      number_of_free_trial_periods == o.number_of_free_trial_periods &&
      name == o.name &&
      description == o.description &&
      id == o.id &&
      type == o.type &&
      version == o.version &&
      ledger_entry_title == o.ledger_entry_title
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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 333

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


227
228
229
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 227

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



233
234
235
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 233

def hash
  [period_fee, linked_space_id, component, number_of_free_trial_periods, name, description, id, type, version, ledger_entry_title].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



185
186
187
188
189
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 185

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



309
310
311
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 309

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



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 315

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



303
304
305
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 303

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



193
194
195
196
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 193

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end