Class: Wallee::SubscriptionProductCreate

Inherits:
Object
  • Object
show all
Defined in:
lib/wallee-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.

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_create.rb', line 72

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?(:'allowedPaymentMethodConfigurations')
    if (value = attributes[:'allowedPaymentMethodConfigurations']).is_a?(Array)
      self.allowed_payment_method_configurations = value
    end
  end

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

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

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

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

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

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

Instance Attribute Details

#allowed_payment_method_configurations ⇒ Object

The allowed payment method configurations control which payment methods can be used with this product. When none is selected all methods will be allowed.



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

def allowed_payment_method_configurations
  @allowed_payment_method_configurations
end

#failed_payment_suspension_period ⇒ Object

When a payment fails, the subscription to which the payment belongs to will be suspended. When the suspension is not removed within the specified period the subscription will be terminated. A payment is considered as failed when the subscriber issues a refund or when a subscription charge fails.



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

def failed_payment_suspension_period
  @failed_payment_suspension_period
end

#name ⇒ Object

The product name is used internally to identify the configuration in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.



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

def name
  @name
end

#product_locked ⇒ Object

Marks the product as locked. Meaning that customer can not change away from this product or change to this product later on.



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

def product_locked
  @product_locked
end

#reference ⇒ Object

The product reference identifies the product for external systems. This field may contain the product’s SKU.



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

def reference
  @reference
end

#sort_order ⇒ Object

The sort order controls in which order the product is listed. The sort order is used to order the products in ascending order.



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

def sort_order
  @sort_order
end

#state ⇒ Object

The object’s current state.



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

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_create.rb', line 45

def self.attribute_map
  {
    :'allowed_payment_method_configurations' => :'allowedPaymentMethodConfigurations',
    :'failed_payment_suspension_period' => :'failedPaymentSuspensionPeriod',
    :'name' => :'name',
    :'product_locked' => :'productLocked',
    :'sort_order' => :'sortOrder',
    :'state' => :'state',
    :'reference' => :'reference'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_create.rb', line 58

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_create.rb', line 163

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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_create.rb', line 211

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



277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_create.rb', line 277

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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_create.rb', line 190

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


177
178
179
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_create.rb', line 177

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

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



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

def list_invalid_properties
  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

  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



257
258
259
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_create.rb', line 257

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



263
264
265
266
267
268
269
270
271
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_create.rb', line 263

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



251
252
253
 
# File 'lib/wallee-ruby-sdk/models/subscription_product_create.rb', line 251

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



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

def valid?
  return false if !@name.nil? && @name.to_s.length > 100
  return false if @reference.nil?
  return false if @reference.to_s.length > 100
  true
end