Class: PostfinancecheckoutRubySdk::SubscriberCreate

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-ruby-sdk/models/subscriber_create.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 = {}) ⇒ SubscriberCreate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



140
141
142
143
144
145
146
147
148
149
150
151
152
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
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 140

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

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

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

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

  if attributes.key?(:'external_id')
    self.external_id = attributes[:'external_id']
  else
    self.external_id = nil
  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.



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

def additional_allowed_payment_method_configurations
  @additional_allowed_payment_method_configurations
end

#billing_address ⇒ Object

Returns the value of attribute billing_address.



52
53
54
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 52

def billing_address
  @billing_address
end

#description ⇒ Object

The description used to identify the subscriber.



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

def description
  @description
end

#disallowed_payment_method_configurations ⇒ Object

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



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

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.



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

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.



55
56
57
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 55

def external_id
  @external_id
end

#language ⇒ Object

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



50
51
52
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 50

def language
  @language
end

#meta_data ⇒ Object

Allow to store additional information about the object.



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

def meta_data
  @meta_data
end

#reference ⇒ Object

The merchant’s reference used to identify the subscriber.



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

def reference
  @reference
end

#shipping_address ⇒ Object

Returns the value of attribute shipping_address.



47
48
49
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 47

def shipping_address
  @shipping_address
end

#state ⇒ Object

Returns the value of attribute state.



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

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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 362

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

Returns attribute mapping this model knows about



99
100
101
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 99

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



104
105
106
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 104

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 82

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 338

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)



132
133
134
135
136
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 132

def self.openapi_all_of
  [
  :'AbstractSubscriberUpdate'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 126

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

.openapi_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 109

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 307

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



433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 433

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


325
326
327
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 325

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



331
332
333
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 331

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 209

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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

  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 @external_id.nil?
    invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
  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



409
410
411
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 409

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



415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 415

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



403
404
405
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 403

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



238
239
240
241
242
243
244
245
246
 
# File 'lib/postfinancecheckout-ruby-sdk/models/subscriber_create.rb', line 238

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  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
  return false if !@description.nil? && @description.to_s.length > 200
  return false if @external_id.nil?
  true
end