Class: PostfinancecheckoutRubySdk::Account

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Account

Initializes the object



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
233
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 156

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

Whether this account and all its parent accounts are active.



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

def active
  @active
end

#active_or_restricted_active ⇒ Object

Whether this account and all its parent accounts are active or restricted active.



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

def active_or_restricted_active
  @active_or_restricted_active
end

#created_by ⇒ Object

The ID of the user the account was created by.



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

def created_by
  @created_by
end

#created_on ⇒ Object

The date and time when the account was created.



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

def created_on
  @created_on
end

#deleted_by ⇒ Object

The ID of a user the account was deleted by.



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

def deleted_by
  @deleted_by
end

#deleted_on ⇒ Object

The date and time when the account was deleted.



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

def deleted_on
  @deleted_on
end

#id ⇒ Object

A unique identifier for the object.



65
66
67
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 65

def id
  @id
end

#name ⇒ Object

The name used to identify the account.



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

def name
  @name
end

#parent_account ⇒ Object

Returns the value of attribute parent_account.



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

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



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

def planned_purge_date
  @planned_purge_date
end

#restricted_active ⇒ Object

Whether this account and all its parent accounts are active or restricted active. There is at least one account that is restricted active.



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

def restricted_active
  @restricted_active
end

#scope ⇒ Object

Returns the value of attribute scope.



59
60
61
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 59

def scope
  @scope
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#subaccount_limit ⇒ Object

The number of sub-accounts that can be created within this account.



70
71
72
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 70

def subaccount_limit
  @subaccount_limit
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 340

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



117
118
119
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 117

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



122
123
124
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 122

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'active_or_restricted_active' => :'activeOrRestrictedActive',
    :'deleted_on' => :'deletedOn',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'active' => :'active',
    :'parent_account' => :'parentAccount',
    :'type' => :'type',
    :'created_on' => :'createdOn',
    :'version' => :'version',
    :'deleted_by' => :'deletedBy',
    :'restricted_active' => :'restrictedActive',
    :'created_by' => :'createdBy',
    :'scope' => :'scope',
    :'name' => :'name',
    :'id' => :'id',
    :'state' => :'state',
    :'subaccount_limit' => :'subaccountLimit'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 316

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



149
150
151
152
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 149

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

.openapi_types ⇒ Object

Attribute type mapping.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 127

def self.openapi_types
  {
    :'active_or_restricted_active' => :'Boolean',
    :'deleted_on' => :'Time',
    :'planned_purge_date' => :'Time',
    :'active' => :'Boolean',
    :'parent_account' => :'Account',
    :'type' => :'AccountType',
    :'created_on' => :'Time',
    :'version' => :'Integer',
    :'deleted_by' => :'Integer',
    :'restricted_active' => :'Boolean',
    :'created_by' => :'Integer',
    :'scope' => :'Scope',
    :'name' => :'String',
    :'id' => :'Integer',
    :'state' => :'AccountState',
    :'subaccount_limit' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 280

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active_or_restricted_active == o.active_or_restricted_active &&
      deleted_on == o.deleted_on &&
      planned_purge_date == o.planned_purge_date &&
      active == o.active &&
       == o. &&
      type == o.type &&
      created_on == o.created_on &&
      version == o.version &&
      deleted_by == o.deleted_by &&
      restricted_active == o.restricted_active &&
      created_by == o.created_by &&
      scope == o.scope &&
      name == o.name &&
      id == o.id &&
      state == o.state &&
      subaccount_limit == o.subaccount_limit
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 411

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

See Also:

  • `==` method


303
304
305
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 303

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



309
310
311
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 309

def hash
  [active_or_restricted_active, deleted_on, planned_purge_date, active, , type, created_on, version, deleted_by, restricted_active, created_by, scope, name, id, state, subaccount_limit].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 237

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@name.nil? && @name.to_s.length > 200
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 200.')
  end

  if !@name.nil? && @name.to_s.length < 3
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 3.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



387
388
389
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 387

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 393

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



381
382
383
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 381

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



253
254
255
256
257
258
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 253

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@name.nil? && @name.to_s.length > 200
  return false if !@name.nil? && @name.to_s.length < 3
  true
end