Class: stcloud::Invitation

Inherits:
Object
  • Object
show all
Defined in:
lib/stcloud/models/invitation.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Invitation

Initializes the object



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
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
 
# File 'lib/stcloud/models/invitation.rb', line 99

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `stcloud::Invitation` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `stcloud::Invitation`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#app ⇒ Object

Returns the value of attribute app.



16
17
18
 
# File 'lib/stcloud/models/invitation.rb', line 16

def app
  @app
end

#apps ⇒ Object

For invite request, only apps.id needs to be set.



19
20
21
 
# File 'lib/stcloud/models/invitation.rb', line 19

def apps
  @apps
end

#id ⇒ Object

Returns the value of attribute id.



21
22
23
 
# File 'lib/stcloud/models/invitation.rb', line 21

def id
  @id
end

#invite_date ⇒ Object

Returns the value of attribute invite_date.



23
24
25
 
# File 'lib/stcloud/models/invitation.rb', line 23

def invite_date
  @invite_date
end

#invite_status ⇒ Object

Returns the value of attribute invite_status.



25
26
27
 
# File 'lib/stcloud/models/invitation.rb', line 25

def invite_status
  @invite_status
end

#invitee_email ⇒ Object

Returns the value of attribute invitee_email.



27
28
29
 
# File 'lib/stcloud/models/invitation.rb', line 27

def invitee_email
  @invitee_email
end

#invitee_role ⇒ Object

Returns the value of attribute invitee_role.



29
30
31
 
# File 'lib/stcloud/models/invitation.rb', line 29

def invitee_role
  @invitee_role
end

#invitee_status ⇒ Object

Returns the value of attribute invitee_status.



31
32
33
 
# File 'lib/stcloud/models/invitation.rb', line 31

def invitee_status
  @invitee_status
end

#inviter_email ⇒ Object

Returns the value of attribute inviter_email.



33
34
35
 
# File 'lib/stcloud/models/invitation.rb', line 33

def inviter_email
  @inviter_email
end

#uuid ⇒ Object

Returns the value of attribute uuid.



35
36
37
 
# File 'lib/stcloud/models/invitation.rb', line 35

def uuid
  @uuid
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/stcloud/models/invitation.rb', line 60

def self.attribute_map
  {
    :'app' => :'app',
    :'apps' => :'apps',
    :'id' => :'id',
    :'invite_date' => :'inviteDate',
    :'invite_status' => :'inviteStatus',
    :'invitee_email' => :'inviteeEmail',
    :'invitee_role' => :'inviteeRole',
    :'invitee_status' => :'inviteeStatus',
    :'inviter_email' => :'inviterEmail',
    :'uuid' => :'uuid'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



236
237
238
 
# File 'lib/stcloud/models/invitation.rb', line 236

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/stcloud/models/invitation.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/stcloud/models/invitation.rb', line 76

def self.openapi_types
  {
    :'app' => :'Object',
    :'apps' => :'Object',
    :'id' => :'Object',
    :'invite_date' => :'Object',
    :'invite_status' => :'Object',
    :'invitee_email' => :'Object',
    :'invitee_role' => :'Object',
    :'invitee_status' => :'Object',
    :'inviter_email' => :'Object',
    :'uuid' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/stcloud/models/invitation.rb', line 206

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      app == o.app &&
      apps == o.apps &&
      id == o.id &&
      invite_date == o.invite_date &&
      invite_status == o.invite_status &&
      invitee_email == o.invitee_email &&
      invitee_role == o.invitee_role &&
      invitee_status == o.invitee_status &&
      inviter_email == o.inviter_email &&
      uuid == o.uuid
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/stcloud/models/invitation.rb', line 266

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
    stcloud.const_get(type).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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/stcloud/models/invitation.rb', line 335

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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/stcloud/models/invitation.rb', line 243

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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]]))
    elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    end
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


223
224
225
 
# File 'lib/stcloud/models/invitation.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



229
230
231
 
# File 'lib/stcloud/models/invitation.rb', line 229

def hash
  [app, apps, id, invite_date, invite_status, invitee_email, invitee_role, invitee_status, inviter_email, uuid].hash
end

#list_invalid_properties ⇒ Object

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



157
158
159
160
 
# File 'lib/stcloud/models/invitation.rb', line 157

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



311
312
313
 
# File 'lib/stcloud/models/invitation.rb', line 311

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/stcloud/models/invitation.rb', line 317

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



305
306
307
 
# File 'lib/stcloud/models/invitation.rb', line 305

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



164
165
166
167
168
169
170
171
172
 
# File 'lib/stcloud/models/invitation.rb', line 164

def valid?
  invite_status_validator = EnumAttributeValidator.new('Object', ['PENDING', 'ACCEPTED', 'CANCELLED', 'DECLINED'])
  return false unless invite_status_validator.valid?(@invite_status)
  invitee_role_validator = EnumAttributeValidator.new('Object', ['SUPER_USER', 'OWNER', 'ADMIN', 'USER', 'DEMO', 'ANONYMOUS'])
  return false unless invitee_role_validator.valid?(@invitee_role)
  invitee_status_validator = EnumAttributeValidator.new('Object', ['INACTIVE', 'ACTIVE'])
  return false unless invitee_status_validator.valid?(@invitee_status)
  true
end