Class: PostfinancecheckoutRubySdk::SubscriptionProductCreate

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

Overview

A subscription product represents a product to which a subscriber can subscribe to. A product defines how much the subscription costs and in what cycles the subscribe is charged.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionProductCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_create.rb', line 115

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

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

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

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

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

  if attributes.key?(:'allowed_payment_method_configurations')
    if (value = attributes[:'allowed_payment_method_configurations']).is_a?(Array)
      self.allowed_payment_method_configurations = value
    end
  end

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

Instance Attribute Details

#allowed_payment_method_configurations ⇒ Object

The payment methods that can be used to subscribe to this product. If none are selected, no restriction is applied.



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

def allowed_payment_method_configurations
  @allowed_payment_method_configurations
end

#failed_payment_suspension_period ⇒ Object

The period after which a subscription that has been suspended due to a failed payment is terminated.



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

def failed_payment_suspension_period
  @failed_payment_suspension_period
end

#name ⇒ Object

The name used to identify the product.



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

def name
  @name
end

#product_locked ⇒ Object

Whether subscriptions can be switched to or from this product, or whether they are locked in.



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

def product_locked
  @product_locked
end

#reference ⇒ Object

The merchant’s reference used to identify the product, e.g. the SKU.



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

def reference
  @reference
end

#sort_order ⇒ Object

When listing products, they can be sorted by this number.



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

def sort_order
  @sort_order
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
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



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
315
316
317
318
319
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_create.rb', line 282

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

Returns all the JSON keys this model knows about



83
84
85
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_create.rb', line 83

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_create.rb', line 70

def self.attribute_map
  {
    :'sort_order' => :'sortOrder',
    :'name' => :'name',
    :'product_locked' => :'productLocked',
    :'state' => :'state',
    :'failed_payment_suspension_period' => :'failedPaymentSuspensionPeriod',
    :'allowed_payment_method_configurations' => :'allowedPaymentMethodConfigurations',
    :'reference' => :'reference'
  }
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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_create.rb', line 258

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)



107
108
109
110
111
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_create.rb', line 107

def self.openapi_all_of
  [
  :'AbstractSubscriptionProductActive'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



101
102
103
104
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_create.rb', line 101

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

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_create.rb', line 88

def self.openapi_types
  {
    :'sort_order' => :'Integer',
    :'name' => :'String',
    :'product_locked' => :'Boolean',
    :'state' => :'SubscriptionProductState',
    :'failed_payment_suspension_period' => :'String',
    :'allowed_payment_method_configurations' => :'Array<Integer>',
    :'reference' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_create.rb', line 233

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      sort_order == o.sort_order &&
      name == o.name &&
      product_locked == o.product_locked &&
      state == o.state &&
      failed_payment_suspension_period == o.failed_payment_suspension_period &&
      allowed_payment_method_configurations == o.allowed_payment_method_configurations &&
      reference == o.reference
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



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

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


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



253
254
255
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_create.rb', line 253

def hash
  [sort_order, name, product_locked, state, failed_payment_suspension_period, allowed_payment_method_configurations, reference].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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_create.rb', line 163

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

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

  if @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 !~ 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



329
330
331
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_create.rb', line 329

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_create.rb', line 335

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



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

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



188
189
190
191
192
193
194
195
196
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscription_product_create.rb', line 188

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