Class: WalleeRubySdk::SubscriptionPeriodBill

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionPeriodBill

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_on ⇒ Object

The date and time when the period bill was created.



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

def created_on
  @created_on
end

#effective_period_end_date ⇒ Object

The date and time when the period actually ended.



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

def effective_period_end_date
  @effective_period_end_date
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#language ⇒ Object

The language that is linked to the object.



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

def language
  @language
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#period_start_date ⇒ Object

The date and time when the period started.



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

def period_start_date
  @period_start_date
end

#planned_period_end_date ⇒ Object

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



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

def planned_period_end_date
  @planned_period_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.



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

def planned_purge_date
  @planned_purge_date
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#subscription_version ⇒ Object

Returns the value of attribute subscription_version.



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

def subscription_version
  @subscription_version
end

#version ⇒ Object

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



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

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



254
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_period_bill.rb', line 254

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



97
98
99
 
# File 'lib/wallee-ruby-sdk/models/subscription_period_bill.rb', line 97

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/wallee-ruby-sdk/models/subscription_period_bill.rb', line 80

def self.attribute_map
  {
    :'linked_space_id' => :'linkedSpaceId',
    :'period_start_date' => :'periodStartDate',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'subscription_version' => :'subscriptionVersion',
    :'effective_period_end_date' => :'effectivePeriodEndDate',
    :'language' => :'language',
    :'id' => :'id',
    :'state' => :'state',
    :'created_on' => :'createdOn',
    :'planned_period_end_date' => :'plannedPeriodEndDate',
    :'version' => :'version'
  }
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



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

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



119
120
121
122
 
# File 'lib/wallee-ruby-sdk/models/subscription_period_bill.rb', line 119

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

.openapi_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/wallee-ruby-sdk/models/subscription_period_bill.rb', line 102

def self.openapi_types
  {
    :'linked_space_id' => :'Integer',
    :'period_start_date' => :'Time',
    :'planned_purge_date' => :'Time',
    :'subscription_version' => :'SubscriptionVersion',
    :'effective_period_end_date' => :'Time',
    :'language' => :'String',
    :'id' => :'Integer',
    :'state' => :'SubscriptionPeriodBillState',
    :'created_on' => :'Time',
    :'planned_period_end_date' => :'Time',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      linked_space_id == o.linked_space_id &&
      period_start_date == o.period_start_date &&
      planned_purge_date == o.planned_purge_date &&
      subscription_version == o.subscription_version &&
      effective_period_end_date == o.effective_period_end_date &&
      language == o.language &&
      id == o.id &&
      state == o.state &&
      created_on == o.created_on &&
      planned_period_end_date == o.planned_period_end_date &&
      version == o.version
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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/wallee-ruby-sdk/models/subscription_period_bill.rb', line 325

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


219
220
221
 
# File 'lib/wallee-ruby-sdk/models/subscription_period_bill.rb', line 219

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [linked_space_id, period_start_date, planned_purge_date, subscription_version, effective_period_end_date, language, id, state, created_on, planned_period_end_date, 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



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

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



301
302
303
 
# File 'lib/wallee-ruby-sdk/models/subscription_period_bill.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
316
317
318
319
 
# File 'lib/wallee-ruby-sdk/models/subscription_period_bill.rb', line 307

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



295
296
297
 
# File 'lib/wallee-ruby-sdk/models/subscription_period_bill.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



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

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