Class: PostfinancecheckoutRubySdk::Space

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Space

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 171

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

Returns the value of attribute account.



79
80
81
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 79

def 
  @account
end

#active ⇒ Object

Whether this space and all its parent accounts are active.



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

def active
  @active
end

#active_or_restricted_active ⇒ Object

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



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

def active_or_restricted_active
  @active_or_restricted_active
end

#created_by ⇒ Object

The ID of the user the space was created by.



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

def created_by
  @created_by
end

#created_on ⇒ Object

The date and time when the space was created.



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

def created_on
  @created_on
end

#database ⇒ Object

Returns the value of attribute database.



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

def database
  @database
end

#deleted_by ⇒ Object

The ID of the user the space was deleted by.



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

def deleted_by
  @deleted_by
end

#deleted_on ⇒ Object

The date and time when the space was deleted.



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

def deleted_on
  @deleted_on
end

#id ⇒ Object

A unique identifier for the object.



75
76
77
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 75

def id
  @id
end

#name ⇒ Object

The name used to identify the space.



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

def name
  @name
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/space.rb', line 35

def planned_purge_date
  @planned_purge_date
end

#postal_address ⇒ Object

Returns the value of attribute postal_address.



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

def postal_address
  @postal_address
end

#primary_currency ⇒ Object

The currency that is used to display aggregated amounts in the space.



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

def primary_currency
  @primary_currency
end

#request_limit ⇒ Object

The maximum number of API requests that are accepted within two minutes. This limit can only be changed with special privileges.



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

def request_limit
  @request_limit
end

#restricted_active ⇒ Object

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



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

def restricted_active
  @restricted_active
end

#state ⇒ Object

Returns the value of attribute state.



77
78
79
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 77

def state
  @state
end

#technical_contact_addresses ⇒ Object

The email address that will receive messages about technical issues and errors that occur in the space.



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

def technical_contact_addresses
  @technical_contact_addresses
end

#time_zone ⇒ Object

The time zone that is used to schedule and run background processes. This does not affect the formatting of dates in the user interface.



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

def time_zone
  @time_zone
end

#version ⇒ Object

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



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

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



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
416
417
418
419
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 382

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



129
130
131
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 129

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 104

def self.attribute_map
  {
    :'active_or_restricted_active' => :'activeOrRestrictedActive',
    :'deleted_on' => :'deletedOn',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'active' => :'active',
    :'time_zone' => :'timeZone',
    :'created_on' => :'createdOn',
    :'primary_currency' => :'primaryCurrency',
    :'version' => :'version',
    :'deleted_by' => :'deletedBy',
    :'request_limit' => :'requestLimit',
    :'database' => :'database',
    :'postal_address' => :'postalAddress',
    :'restricted_active' => :'restrictedActive',
    :'created_by' => :'createdBy',
    :'name' => :'name',
    :'technical_contact_addresses' => :'technicalContactAddresses',
    :'id' => :'id',
    :'state' => :'state',
    :'account' => :'account'
  }
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



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 358

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



164
165
166
167
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 164

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

.openapi_types ⇒ Object

Attribute type mapping.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 139

def self.openapi_types
  {
    :'active_or_restricted_active' => :'Boolean',
    :'deleted_on' => :'Time',
    :'planned_purge_date' => :'Time',
    :'active' => :'Boolean',
    :'time_zone' => :'String',
    :'created_on' => :'Time',
    :'primary_currency' => :'String',
    :'version' => :'Integer',
    :'deleted_by' => :'Integer',
    :'request_limit' => :'Integer',
    :'database' => :'TenantDatabase',
    :'postal_address' => :'SpaceAddress',
    :'restricted_active' => :'Boolean',
    :'created_by' => :'Integer',
    :'name' => :'String',
    :'technical_contact_addresses' => :'Array<String>',
    :'id' => :'Integer',
    :'state' => :'CreationEntityState',
    :'account' => :'Account'
  }
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
338
339
340
341
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 319

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 &&
      time_zone == o.time_zone &&
      created_on == o.created_on &&
      primary_currency == o.primary_currency &&
      version == o.version &&
      deleted_by == o.deleted_by &&
      request_limit == o.request_limit &&
      database == o.database &&
      postal_address == o.postal_address &&
      restricted_active == o.restricted_active &&
      created_by == o.created_by &&
      name == o.name &&
      technical_contact_addresses == o.technical_contact_addresses &&
      id == o.id &&
      state == o.state &&
       == o.
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



453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 453

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


345
346
347
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 345

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



351
352
353
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 351

def hash
  [active_or_restricted_active, deleted_on, planned_purge_date, active, time_zone, created_on, primary_currency, version, deleted_by, request_limit, database, postal_address, restricted_active, created_by, name, technical_contact_addresses, 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



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 266

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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



429
430
431
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 429

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



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

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



423
424
425
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 423

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



282
283
284
285
286
287
 
# File 'lib/postfinancecheckout-ruby-sdk/models/space.rb', line 282

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