Class: AlfrescoAPI::PersonNetwork

Inherits:
Object
  • Object
show all
Defined in:
lib/alfresco_api/models/person_network.rb

Overview

A network is the group of users and sites that belong to an organization. Networks are organized by email domain. When a user signs up for an Alfresco account , their email domain becomes their Home Network.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PersonNetwork

Initializes the object

Parameters:

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

    Model attributes in the form of hash



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/alfresco_api/models/person_network.rb', line 84

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

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

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

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

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

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

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

end

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at.



26
27
28
 
# File 'lib/alfresco_api/models/person_network.rb', line 26

def created_at
  @created_at
end

#home_network ⇒ Object

Is this the home network?



22
23
24
 
# File 'lib/alfresco_api/models/person_network.rb', line 22

def home_network
  @home_network
end

#id ⇒ Object

This network’s unique id



19
20
21
 
# File 'lib/alfresco_api/models/person_network.rb', line 19

def id
  @id
end

#is_enabled ⇒ Object

Returns the value of attribute is_enabled.



24
25
26
 
# File 'lib/alfresco_api/models/person_network.rb', line 24

def is_enabled
  @is_enabled
end

Returns the value of attribute paid_network.



28
29
30
 
# File 'lib/alfresco_api/models/person_network.rb', line 28

def paid_network
  @paid_network
end

#quotas ⇒ Object

Returns the value of attribute quotas.



32
33
34
 
# File 'lib/alfresco_api/models/person_network.rb', line 32

def quotas
  @quotas
end

#subscription_level ⇒ Object

Returns the value of attribute subscription_level.



30
31
32
 
# File 'lib/alfresco_api/models/person_network.rb', line 30

def subscription_level
  @subscription_level
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/alfresco_api/models/person_network.rb', line 57

def self.attribute_map
  {
    :'id' => :'id',
    :'home_network' => :'homeNetwork',
    :'is_enabled' => :'isEnabled',
    :'created_at' => :'createdAt',
    :'paid_network' => :'paidNetwork',
    :'subscription_level' => :'subscriptionLevel',
    :'quotas' => :'quotas'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/alfresco_api/models/person_network.rb', line 70

def self.swagger_types
  {
    :'id' => :'String',
    :'home_network' => :'BOOLEAN',
    :'is_enabled' => :'BOOLEAN',
    :'created_at' => :'DateTime',
    :'paid_network' => :'BOOLEAN',
    :'subscription_level' => :'String',
    :'quotas' => :'Array<NetworkQuota>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/alfresco_api/models/person_network.rb', line 159

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      home_network == o.home_network &&
      is_enabled == o.is_enabled &&
      created_at == o.created_at &&
      paid_network == o.paid_network &&
      subscription_level == o.subscription_level &&
      quotas == o.quotas
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



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
 
# File 'lib/alfresco_api/models/person_network.rb', line 207

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



273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/alfresco_api/models/person_network.rb', line 273

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



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/alfresco_api/models/person_network.rb', line 186

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 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


173
174
175
 
# File 'lib/alfresco_api/models/person_network.rb', line 173

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



179
180
181
 
# File 'lib/alfresco_api/models/person_network.rb', line 179

def hash
  [id, home_network, is_enabled, created_at, paid_network, subscription_level, quotas].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/alfresco_api/models/person_network.rb', line 124

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push("invalid value for 'id', id cannot be nil.")
  end

  if @is_enabled.nil?
    invalid_properties.push("invalid value for 'is_enabled', is_enabled cannot be nil.")
  end

  return 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



253
254
255
 
# File 'lib/alfresco_api/models/person_network.rb', line 253

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



259
260
261
262
263
264
265
266
267
 
# File 'lib/alfresco_api/models/person_network.rb', line 259

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



247
248
249
 
# File 'lib/alfresco_api/models/person_network.rb', line 247

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



139
140
141
142
143
144
145
 
# File 'lib/alfresco_api/models/person_network.rb', line 139

def valid?
  return false if @id.nil?
  return false if @is_enabled.nil?
  subscription_level_validator = EnumAttributeValidator.new('String', ["Free", "Standard", "Enterprise"])
  return false unless subscription_level_validator.valid?(@subscription_level)
  return true
end