Class: Wallee::SubscriptionSuspension

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionSuspension

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 107

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?(:'createdOn')
    self.created_on = attributes[:'createdOn']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_on ⇒ Object

The date and time when the object was created.



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

def created_on
  @created_on
end

#effective_end_date ⇒ Object

Returns the value of attribute effective_end_date.



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

def effective_end_date
  @effective_end_date
end

#end_action ⇒ Object

When the suspension reaches the planned end date the end action will be carried out. This action is only executed when the suspension is ended automatically based on the end date.



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

def end_action
  @end_action
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#note ⇒ Object

The note may contain some internal information for the suspension. The note will not be disclosed to the subscriber.



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

def note
  @note
end

#period_bill ⇒ Object

Returns the value of attribute period_bill.



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

def period_bill
  @period_bill
end

#planned_end_date ⇒ Object

The planned end date of the suspension identifies the date on which the suspension will be ended automatically.



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

def planned_end_date
  @planned_end_date
end

#planned_purge_date ⇒ Object

The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.



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

def planned_purge_date
  @planned_purge_date
end

#reason ⇒ Object

The suspension reason indicates why a suspension has been created.



54
55
56
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 54

def reason
  @reason
end

#state ⇒ Object

The object’s current state.



57
58
59
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 57

def state
  @state
end

#subscription ⇒ Object

Returns the value of attribute subscription.



60
61
62
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 60

def subscription
  @subscription
end

#version ⇒ Object

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



63
64
65
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 63

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'created_on' => :'createdOn',
    :'effective_end_date' => :'effectiveEndDate',
    :'end_action' => :'endAction',
    :'id' => :'id',
    :'language' => :'language',
    :'linked_space_id' => :'linkedSpaceId',
    :'note' => :'note',
    :'period_bill' => :'periodBill',
    :'planned_end_date' => :'plannedEndDate',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'reason' => :'reason',
    :'state' => :'state',
    :'subscription' => :'subscription',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 86

def self.swagger_types
  {
    :'created_on' => :'DateTime',
    :'effective_end_date' => :'DateTime',
    :'end_action' => :'SubscriptionSuspensionAction',
    :'id' => :'Integer',
    :'language' => :'String',
    :'linked_space_id' => :'Integer',
    :'note' => :'String',
    :'period_bill' => :'Integer',
    :'planned_end_date' => :'DateTime',
    :'planned_purge_date' => :'DateTime',
    :'reason' => :'SubscriptionSuspensionReason',
    :'state' => :'SubscriptionSuspensionState',
    :'subscription' => :'Integer',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_on == o.created_on &&
      effective_end_date == o.effective_end_date &&
      end_action == o.end_action &&
      id == o.id &&
      language == o.language &&
      linked_space_id == o.linked_space_id &&
      note == o.note &&
      period_bill == o.period_bill &&
      planned_end_date == o.planned_end_date &&
      planned_purge_date == o.planned_purge_date &&
      reason == o.reason &&
      state == o.state &&
      subscription == o.subscription &&
      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



255
256
257
258
259
260
261
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
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 255

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



321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 321

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 234

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


221
222
223
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 221

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [created_on, effective_end_date, end_action, id, language, linked_space_id, note, period_bill, planned_end_date, planned_purge_date, reason, state, subscription, 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



172
173
174
175
176
177
178
179
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 172

def list_invalid_properties
  invalid_properties = Array.new
  if !@note.nil? && @note.to_s.length > 300
    invalid_properties.push('invalid value for "note", the character length must be smaller than or equal to 300.')
  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



301
302
303
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 301

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



307
308
309
310
311
312
313
314
315
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 307

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



295
296
297
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 295

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



183
184
185
186
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 183

def valid?
  return false if !@note.nil? && @note.to_s.length > 300
  true
end