Class: Wallee::ProductPeriodFee

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

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



87
88
89
90
91
92
93
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 87

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

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

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

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

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

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

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

  if attributes.has_key?(:'periodFee')
    if (value = attributes[:'periodFee']).is_a?(Array)
      self.period_fee = value
    end
  end

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

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

Instance Attribute Details

#component ⇒ Object

Returns the value of attribute component.



24
25
26
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 24

def component
  @component
end

#description ⇒ Object

The description of a component fee describes the fee to the subscriber. The description may be shown in documents or on certain user interfaces.



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

def description
  @description
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#ledger_entry_title ⇒ Object

The ledger entry title will be used for the title in the ledger entry and in the invoice.



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

def ledger_entry_title
  @ledger_entry_title
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#name ⇒ Object

The name of the fee should describe for the subscriber in few words for what the fee is for.



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

def name
  @name
end

#number_of_free_trial_periods ⇒ Object

The number of free trial periods specify how many periods are free of charge at the begining of the subscription.



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

def number_of_free_trial_periods
  @number_of_free_trial_periods
end

#period_fee ⇒ Object

The period fee is charged for every period of the subscription except for those periods which are trial periods.



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

def period_fee
  @period_fee
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 54

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

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 70

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 157

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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 208

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
    temp_model = Wallee.const_get(type).new
    temp_model.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



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 274

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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 187

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


174
175
176
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 174

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



180
181
182
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 180

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



144
145
146
147
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 144

def list_invalid_properties
  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



254
255
256
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 254

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



260
261
262
263
264
265
266
267
268
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 260

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



248
249
250
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 248

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



151
152
153
 
# File 'lib/wallee-ruby-sdk/models/product_period_fee.rb', line 151

def valid?
  true
end