Class: PostFinanceCheckout::Account

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Account

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

Whether this account and all its parent accounts are active.



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

def active
  @active
end

#active_or_restricted_active ⇒ Object

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



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

def active_or_restricted_active
  @active_or_restricted_active
end

#created_by ⇒ Object

The ID of the user the account was created by.



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

def created_by
  @created_by
end

#created_on ⇒ Object

The date and time when the account was created.



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

def created_on
  @created_on
end

#deleted_by ⇒ Object

The ID of a user the account was deleted by.



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

def deleted_by
  @deleted_by
end

#deleted_on ⇒ Object

The date and time when the account was deleted.



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

def deleted_on
  @deleted_on
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#last_modified_date ⇒ Object

The date and time when the object was last modified.



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

def last_modified_date
  @last_modified_date
end

#name ⇒ Object

The name used to identify the account.



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

def name
  @name
end

#parent_account ⇒ Object

The parent account responsible for administering this account.



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

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.



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

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.



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

def restricted_active
  @restricted_active
end

#scope ⇒ Object

The scope that the account belongs to.



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

def scope
  @scope
end

#state ⇒ Object

The object’s current state.



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

def state
  @state
end

#subaccount_limit ⇒ Object

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



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

def subaccount_limit
  @subaccount_limit
end

#type ⇒ Object

The account’s type which defines its role and capabilities.



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

def type
  @type
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 75

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      active_or_restricted_active == o.active_or_restricted_active &&
      created_by == o.created_by &&
      created_on == o.created_on &&
      deleted_by == o.deleted_by &&
      deleted_on == o.deleted_on &&
      id == o.id &&
      last_modified_date == o.last_modified_date &&
      name == o.name &&
       == o. &&
      planned_purge_date == o.planned_purge_date &&
      restricted_active == o.restricted_active &&
      scope == o.scope &&
      state == o.state &&
      subaccount_limit == o.subaccount_limit &&
      type == o.type &&
      version == o.version
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



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 294

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 360

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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 273

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


260
261
262
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 260

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



266
267
268
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 266

def hash
  [active, active_or_restricted_active, created_by, created_on, deleted_by, deleted_on, id, last_modified_date, name, , planned_purge_date, restricted_active, scope, state, subaccount_limit, type, version].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



199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 199

def list_invalid_properties
  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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



340
341
342
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 340

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



346
347
348
349
350
351
352
353
354
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 346

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



334
335
336
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 334

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



214
215
216
217
218
 
# File 'lib/postfinancecheckout-ruby-sdk/models/account.rb', line 214

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