Class: WalleeRubySdk::Subscriber

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

Overview

A subscriber represents everyone who is subscribed to a product.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Subscriber

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 153

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_allowed_payment_method_configurations ⇒ Object

Allow the subscriber to use these payment methods even if subscription products do not accept them.



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

def additional_allowed_payment_method_configurations
  @additional_allowed_payment_method_configurations
end

#billing_address ⇒ Object

Returns the value of attribute billing_address.



64
65
66
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 64

def billing_address
  @billing_address
end

#description ⇒ Object

The description used to identify the subscriber.



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

def description
  @description
end

#disallowed_payment_method_configurations ⇒ Object

Prevent the subscriber from using these payment methods even if subscription products do accept them.



60
61
62
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 60

def disallowed_payment_method_configurations
  @disallowed_payment_method_configurations
end

#email_address ⇒ Object

The email address that is used to communicate with the subscriber. There can be only one subscriber per space with the same email address.



57
58
59
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 57

def email_address
  @email_address
end

#external_id ⇒ Object

A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.



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

def external_id
  @external_id
end

#id ⇒ Object

A unique identifier for the object.



67
68
69
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 67

def id
  @id
end

#language ⇒ Object

The language that is used when communicating with the subscriber via emails and documents.



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

def language
  @language
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
end

#meta_data ⇒ Object

Allow to store additional information about the object.



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

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



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

def planned_purge_date
  @planned_purge_date
end

#reference ⇒ Object

The merchant’s reference used to identify the subscriber.



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

def reference
  @reference
end

#shipping_address ⇒ Object

Returns the value of attribute shipping_address.



62
63
64
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 62

def shipping_address
  @shipping_address
end

#state ⇒ Object

Returns the value of attribute state.



69
70
71
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 69

def state
  @state
end

#version ⇒ Object

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



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

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



378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 378

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

Returns attribute mapping this model knows about



115
116
117
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 115

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 94

def self.attribute_map
  {
    :'planned_purge_date' => :'plannedPurgeDate',
    :'description' => :'description',
    :'external_id' => :'externalId',
    :'language' => :'language',
    :'version' => :'version',
    :'reference' => :'reference',
    :'additional_allowed_payment_method_configurations' => :'additionalAllowedPaymentMethodConfigurations',
    :'linked_space_id' => :'linkedSpaceId',
    :'meta_data' => :'metaData',
    :'email_address' => :'emailAddress',
    :'disallowed_payment_method_configurations' => :'disallowedPaymentMethodConfigurations',
    :'shipping_address' => :'shippingAddress',
    :'billing_address' => :'billingAddress',
    :'id' => :'id',
    :'state' => :'state'
  }
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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 354

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



146
147
148
149
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 146

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

.openapi_types ⇒ Object

Attribute type mapping.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 125

def self.openapi_types
  {
    :'planned_purge_date' => :'Time',
    :'description' => :'String',
    :'external_id' => :'String',
    :'language' => :'String',
    :'version' => :'Integer',
    :'reference' => :'String',
    :'additional_allowed_payment_method_configurations' => :'Array<Integer>',
    :'linked_space_id' => :'Integer',
    :'meta_data' => :'Hash<String, String>',
    :'email_address' => :'String',
    :'disallowed_payment_method_configurations' => :'Array<Integer>',
    :'shipping_address' => :'Address',
    :'billing_address' => :'Address',
    :'id' => :'Integer',
    :'state' => :'CreationEntityState'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 319

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      planned_purge_date == o.planned_purge_date &&
      description == o.description &&
      external_id == o.external_id &&
      language == o.language &&
      version == o.version &&
      reference == o.reference &&
      additional_allowed_payment_method_configurations == o.additional_allowed_payment_method_configurations &&
      linked_space_id == o.linked_space_id &&
      meta_data == o.meta_data &&
      email_address == o.email_address &&
      disallowed_payment_method_configurations == o.disallowed_payment_method_configurations &&
      shipping_address == o.shipping_address &&
      billing_address == o.billing_address &&
      id == o.id &&
      state == o.state
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



449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 449

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


341
342
343
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 341

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



347
348
349
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 347

def hash
  [planned_purge_date, description, external_id, language, version, reference, additional_allowed_payment_method_configurations, linked_space_id, meta_data, email_address, disallowed_payment_method_configurations, shipping_address, billing_address, id, 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



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 236

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

  if !@email_address.nil? && @email_address.to_s.length > 254
    invalid_properties.push('invalid value for "email_address", the character length must be smaller than or equal to 254.')
  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



425
426
427
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 425

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



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 431

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



419
420
421
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 419

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



261
262
263
264
265
266
267
268
 
# File 'lib/wallee-ruby-sdk/models/subscriber.rb', line 261

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