Class: WhiteLabelMachineName::Space

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

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



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
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
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space.rb', line 137

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account ⇒ Object

The account to which the space belongs to.



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

def 
  @account
end

#active ⇒ Object

Active means that this account and all accounts in the hierarchy are active.



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

def active
  @active
end

#active_or_restricted_active ⇒ Object

This property is true when all accounts in the hierarchy are active or restricted active.



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

def active_or_restricted_active
  @active_or_restricted_active
end

#created_by ⇒ Object

The ID of the user who created this entity.



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

def created_by
  @created_by
end

#created_on ⇒ Object

The date and time when this entity was created.



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

def created_on
  @created_on
end

#database ⇒ Object

The database in which the space’s data are stored in.



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

def database
  @database
end

#deleted_by ⇒ Object

The ID of a user that deleted this entity.



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

def deleted_by
  @deleted_by
end

#deleted_on ⇒ Object

The date and time when this entity was deleted.



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

def deleted_on
  @deleted_on
end

#id ⇒ Object

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



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

def id
  @id
end

#last_modified_date ⇒ Object

Returns the value of attribute last_modified_date.



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

def last_modified_date
  @last_modified_date
end

#name ⇒ Object

The space name is used internally to identify the space in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.



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

def name
  @name
end

#planned_purge_date ⇒ Object

The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.



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

def planned_purge_date
  @planned_purge_date
end

#postal_address ⇒ Object

The address to use in communication with clients for example in email, documents etc.



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

def postal_address
  @postal_address
end

#primary_currency ⇒ Object

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



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

def primary_currency
  @primary_currency
end

#request_limit ⇒ Object

The request limit defines the maximum number of API request accepted within 2 minutes for this space. This limit can only be changed with special privileges.



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

def request_limit
  @request_limit
end

#restricted_active ⇒ Object

Restricted active means that at least one account in the hierarchy is only restricted active, but all are either restricted active or active.



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

def restricted_active
  @restricted_active
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#technical_contact_addresses ⇒ Object

The email address provided as contact addresses will be informed about technical issues or errors triggered by the space.



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

def technical_contact_addresses
  @technical_contact_addresses
end

#time_zone ⇒ Object

The time zone assigned to the space determines the time offset for calculating dates within the space. This is typically used for background processed which needs to be triggered on a specific hour within the day. Changing the space time zone will not change the display of dates.



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

def time_zone
  @time_zone
end

#version ⇒ Object

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



81
82
83
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space.rb', line 81

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space.rb', line 84

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

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space.rb', line 110

def self.swagger_types
  {
    :'account' => :'Account',
    :'active' => :'BOOLEAN',
    :'active_or_restricted_active' => :'BOOLEAN',
    :'created_by' => :'Integer',
    :'created_on' => :'DateTime',
    :'database' => :'TenantDatabase',
    :'deleted_by' => :'Integer',
    :'deleted_on' => :'DateTime',
    :'id' => :'Integer',
    :'last_modified_date' => :'DateTime',
    :'name' => :'String',
    :'planned_purge_date' => :'DateTime',
    :'postal_address' => :'SpaceAddress',
    :'primary_currency' => :'String',
    :'request_limit' => :'Integer',
    :'restricted_active' => :'BOOLEAN',
    :'state' => :'CreationEntityState',
    :'technical_contact_addresses' => :'Array<String>',
    :'time_zone' => :'String',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space.rb', line 265

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      active == o.active &&
      active_or_restricted_active == o.active_or_restricted_active &&
      created_by == o.created_by &&
      created_on == o.created_on &&
      database == o.database &&
      deleted_by == o.deleted_by &&
      deleted_on == o.deleted_on &&
      id == o.id &&
      last_modified_date == o.last_modified_date &&
      name == o.name &&
      planned_purge_date == o.planned_purge_date &&
      postal_address == o.postal_address &&
      primary_currency == o.primary_currency &&
      request_limit == o.request_limit &&
      restricted_active == o.restricted_active &&
      state == o.state &&
      technical_contact_addresses == o.technical_contact_addresses &&
      time_zone == o.time_zone &&
      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



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space.rb', line 326

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



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

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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space.rb', line 305

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


292
293
294
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space.rb', line 292

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



298
299
300
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space.rb', line 298

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



228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space.rb', line 228

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



372
373
374
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space.rb', line 372

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



378
379
380
381
382
383
384
385
386
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space.rb', line 378

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



366
367
368
 
# File 'lib/whitelabelmachinename-ruby-sdk/models/space.rb', line 366

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



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

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