Class: WalleeRubySdk::SubscriptionSuspension

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

Defined Under Namespace

Classes: EnumAttributeValidator

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



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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 139

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `WalleeRubySdk::SubscriptionSuspension` 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::SubscriptionSuspension`. 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?(:'effective_end_date')
    self.effective_end_date = attributes[:'effective_end_date']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_on ⇒ Object

The date and time when the object was created.



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

def created_on
  @created_on
end

#effective_end_date ⇒ Object

The date and time when the suspension ended.



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

Returns the value of attribute end_action.



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

def end_action
  @end_action
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#note ⇒ Object

A note that contains details about the suspension. It is not disclosed to the subscriber.



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

def note
  @note
end

#period_bill ⇒ Object

The period bill that led to the suspension of the subscription.



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

def period_bill
  @period_bill
end

#planned_end_date ⇒ Object

The date and time when the suspension is planned to end.



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

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.



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

def planned_purge_date
  @planned_purge_date
end

#reason ⇒ Object

Returns the value of attribute reason.



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

def reason
  @reason
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#subscription ⇒ Object

Returns the value of attribute subscription.



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

def subscription
  @subscription
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/subscription_suspension.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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 301

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



107
108
109
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 107

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 277

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



132
133
134
135
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 132

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

.openapi_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 112

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 245

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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 372

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


266
267
268
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 266

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



272
273
274
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 272

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



211
212
213
214
215
216
217
218
219
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 211

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



348
349
350
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 348

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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 354

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



342
343
344
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 342

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



223
224
225
226
227
 
# File 'lib/wallee-ruby-sdk/models/subscription_suspension.rb', line 223

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@note.nil? && @note.to_s.length > 300
  true
end