Class: WhiteLabelMachineName::SubscriberUpdate

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

Overview

A subscriber represents everyone who is subscribed to a product.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriberUpdate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
99
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
144
145
146
147
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscriber_update.rb', line 92

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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_allowed_payment_method_configurations ⇒ Object

Those payment methods which are allowed additionally will be available even when the product does not allow those methods.



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

def additional_allowed_payment_method_configurations
  @additional_allowed_payment_method_configurations
end

#billing_address ⇒ Object

Returns the value of attribute billing_address.



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

def billing_address
  @billing_address
end

#description ⇒ Object

The subscriber description can be used to add a description to the subscriber. This is used in the back office to identify the subscriber.



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

def description
  @description
end

#disallowed_payment_method_configurations ⇒ Object

Those payment methods which are disallowed will not be available to the subscriber even if the product allows those methods.



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

def disallowed_payment_method_configurations
  @disallowed_payment_method_configurations
end

#email_address ⇒ Object

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



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

def email_address
  @email_address
end

#id ⇒ Object

The ID is the primary key of the entity. The ID identifies the entity uniquely.



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

def id
  @id
end

#language ⇒ Object

The subscriber language determines the language which is used to communicate with the subscriber in emails and documents (e.g. invoices).



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

def language
  @language
end

#meta_data ⇒ Object

Meta data allow to store additional data along the object.



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

def meta_data
  @meta_data
end

#reference ⇒ Object

The subscriber reference identifies the subscriber in administrative interfaces (e.g. customer id).



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

def reference
  @reference
end

#shipping_address ⇒ Object

Returns the value of attribute shipping_address.



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

def shipping_address
  @shipping_address
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscriber_update.rb', line 57

def self.attribute_map
  {
    :'id' => :'id',
    :'version' => :'version',
    :'additional_allowed_payment_method_configurations' => :'additionalAllowedPaymentMethodConfigurations',
    :'billing_address' => :'billingAddress',
    :'description' => :'description',
    :'disallowed_payment_method_configurations' => :'disallowedPaymentMethodConfigurations',
    :'email_address' => :'emailAddress',
    :'language' => :'language',
    :'meta_data' => :'metaData',
    :'reference' => :'reference',
    :'shipping_address' => :'shippingAddress'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscriber_update.rb', line 74

def self.swagger_types
  {
    :'id' => :'Integer',
    :'version' => :'Integer',
    :'additional_allowed_payment_method_configurations' => :'Array<Integer>',
    :'billing_address' => :'AddressCreate',
    :'description' => :'String',
    :'disallowed_payment_method_configurations' => :'Array<Integer>',
    :'email_address' => :'String',
    :'language' => :'String',
    :'meta_data' => :'Hash<String, String>',
    :'reference' => :'String',
    :'shipping_address' => :'AddressCreate'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscriber_update.rb', line 219

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



271
272
273
274
275
276
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscriber_update.rb', line 271

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



337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscriber_update.rb', line 337

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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscriber_update.rb', line 250

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


237
238
239
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscriber_update.rb', line 237

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



243
244
245
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscriber_update.rb', line 243

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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscriber_update.rb', line 151

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

  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

  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



317
318
319
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscriber_update.rb', line 317

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



323
324
325
326
327
328
329
330
331
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscriber_update.rb', line 323

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



311
312
313
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscriber_update.rb', line 311

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



178
179
180
181
182
183
184
185
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/subscriber_update.rb', line 178

def valid?
  return false if @id.nil?
  return false if @version.nil?
  return false if !@description.nil? && @description.to_s.length > 200
  return false if !@email_address.nil? && @email_address.to_s.length > 254
  return false if !@reference.nil? && @reference.to_s.length > 100
  true
end