Class: WhiteLabelMachineName::AbstractSubscriptionProductActive

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AbstractSubscriptionProductActive

Initializes the object

Parameters:

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

    Model attributes in the form of hash



66
67
68
69
70
71
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_subscription_product_active.rb', line 66

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
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.



23
24
25
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_subscription_product_active.rb', line 23

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.



26
27
28
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_subscription_product_active.rb', line 26

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.



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

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.



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

def product_locked
  @product_locked
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.



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

def sort_order
  @sort_order
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_subscription_product_active.rb', line 41

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

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_subscription_product_active.rb', line 53

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'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



129
130
131
132
133
134
135
136
137
138
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_subscription_product_active.rb', line 129

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



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
208
209
210
211
212
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_subscription_product_active.rb', line 176

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 = WhiteLabelMachineName.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



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_subscription_product_active.rb', line 242

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_subscription_product_active.rb', line 155

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


142
143
144
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_subscription_product_active.rb', line 142

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



148
149
150
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_subscription_product_active.rb', line 148

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



101
102
103
104
105
106
107
108
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_subscription_product_active.rb', line 101

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

  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



222
223
224
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_subscription_product_active.rb', line 222

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



228
229
230
231
232
233
234
235
236
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_subscription_product_active.rb', line 228

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



216
217
218
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_subscription_product_active.rb', line 216

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



112
113
114
115
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/abstract_subscription_product_active.rb', line 112

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