Class: PostfinancecheckoutRubySdk::SubscriptionPending

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionPending

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
141
142
143
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 100

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PostfinancecheckoutRubySdk::SubscriptionPending` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PostfinancecheckoutRubySdk::SubscriptionPending`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

Instance Attribute Details

#affiliate ⇒ Object

The affiliate that led to the creation of the subscription.



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

def affiliate
  @affiliate
end

#description ⇒ Object

A description used to identify the subscription.



29
30
31
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 29

def description
  @description
end

#planned_termination_date ⇒ Object

The date and time when the subscription is planned to be terminated.



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

def planned_termination_date
  @planned_termination_date
end

#reference ⇒ Object

The merchant’s reference used to identify the subscription.



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

def reference
  @reference
end

#subscriber ⇒ Object

The subscriber that the subscription belongs to.



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

def subscriber
  @subscriber
end

#token ⇒ Object

The payment token that is used to charge the customer.



47
48
49
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 47

def token
  @token
end

#version ⇒ Object

The version number indicates the version of the entity. The version is incremented whenever the entity is changed.



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

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 277

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 = PostfinancecheckoutRubySdk.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



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

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



68
69
70
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 68

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 50

def self.attribute_map
  {
    :'description' => :'description',
    :'planned_termination_date' => :'plannedTerminationDate',
    :'affiliate' => :'affiliate',
    :'version' => :'version',
    :'reference' => :'reference',
    :'subscriber' => :'subscriber',
    :'token' => :'token'
  }
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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 253

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



92
93
94
95
96
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 92

def self.openapi_all_of
  [
  :'SubscriptionUpdate'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 86

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

.openapi_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 73

def self.openapi_types
  {
    :'description' => :'String',
    :'planned_termination_date' => :'Time',
    :'affiliate' => :'Integer',
    :'version' => :'Integer',
    :'reference' => :'String',
    :'subscriber' => :'Integer',
    :'token' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 226

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      planned_termination_date == o.planned_termination_date &&
      affiliate == o.affiliate &&
      version == o.version &&
      reference == o.reference &&
      subscriber == o.subscriber &&
      token == o.token
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



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 348

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


240
241
242
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 240

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



246
247
248
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 246

def hash
  [description, planned_termination_date, affiliate, version, reference, subscriber, token].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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 147

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@description.nil? && @description.to_s.length > 200
    invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 200.')
  end

  if @version.nil?
    invalid_properties.push('invalid value for "version", version cannot be nil.')
  end

  if !@reference.nil? && @reference.to_s.length > 100
    invalid_properties.push('invalid value for "reference", the character length must be smaller than or equal to 100.')
  end

  pattern = Regexp.new(/[ \x20-\x7e]*/)
  if !@reference.nil? && @reference !~ pattern
    invalid_properties.push("invalid value for \"reference\", must conform to the pattern #{pattern}.")
  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



324
325
326
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 324

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



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 330

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



318
319
320
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_pending.rb', line 318

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



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@description.nil? && @description.to_s.length > 200
  return false if @version.nil?
  return false if !@reference.nil? && @reference.to_s.length > 100
  return false if !@reference.nil? && @reference !~ Regexp.new(/[ \x20-\x7e]*/)
  true
end