Class: SmplkitGeneratedClient::App::Invitation

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb

Overview

An invitation for a person to join an account. Invitations carry a time-limited token; the recipient redeems the token to become a member of the inviting account at the assigned role.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ Invitation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 115

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_name ⇒ Object

Name of the account the recipient is being invited to join.



35
36
37
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 35

def 
  @account_name
end

#created_at ⇒ Object

When the invitation was issued.



47
48
49
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 47

def created_at
  @created_at
end

#email ⇒ Object

Email address the invitation was sent to.



20
21
22
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 20

def email
  @email
end

#expires_at ⇒ Object

When the invitation token stops being redeemable.



44
45
46
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 44

def expires_at
  @expires_at
end

#groups ⇒ Object

Environment Access Group ids the invitee will be added to on acceptance, in addition to the always-applied ‘default` group. Empty array or `null` means default-only.



32
33
34
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 32

def groups
  @groups
end

#invited_by ⇒ Object

UUID of the user who sent the invitation.



29
30
31
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 29

def invited_by
  @invited_by
end

#inviter_display_name ⇒ Object

Display name of the user who sent the invitation.



38
39
40
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 38

def inviter_display_name
  @inviter_display_name
end

#role ⇒ Object

Role to assign on acceptance. One of ‘ADMIN`, `MEMBER`, or `VIEWER`.



23
24
25
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 23

def role
  @role
end

#status ⇒ Object

Lifecycle state of the invitation. One of ‘PENDING`, `ACCEPTED`, `REVOKED`, or `EXPIRED`.



26
27
28
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 26

def status
  @status
end

#token ⇒ Object

Single-use token that the recipient redeems to accept the invitation. Echoed on responses so the inviting client can construct the acceptance link.



41
42
43
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 41

def token
  @token
end

#updated_at ⇒ Object

When the invitation record was last modified.



50
51
52
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 50

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



70
71
72
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 75

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 53

def self.attribute_map
  {
    :'email' => :'email',
    :'role' => :'role',
    :'status' => :'status',
    :'invited_by' => :'invited_by',
    :'groups' => :'groups',
    :'account_name' => :'account_name',
    :'inviter_display_name' => :'inviter_display_name',
    :'token' => :'token',
    :'expires_at' => :'expires_at',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at'
  }
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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 224

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 97

def self.openapi_nullable
  Set.new([
    :'email',
    :'role',
    :'status',
    :'invited_by',
    :'groups',
    :'account_name',
    :'inviter_display_name',
    :'token',
    :'expires_at',
    :'created_at',
    :'updated_at'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 80

def self.openapi_types
  {
    :'email' => :'String',
    :'role' => :'String',
    :'status' => :'String',
    :'invited_by' => :'String',
    :'groups' => :'Array<String>',
    :'account_name' => :'String',
    :'inviter_display_name' => :'String',
    :'token' => :'String',
    :'expires_at' => :'Time',
    :'created_at' => :'Time',
    :'updated_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 193

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email == o.email &&
      role == o.role &&
      status == o.status &&
      invited_by == o.invited_by &&
      groups == o.groups &&
       == o. &&
      inviter_display_name == o.inviter_display_name &&
      token == o.token &&
      expires_at == o.expires_at &&
      created_at == o.created_at &&
      updated_at == o.updated_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


211
212
213
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 211

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



217
218
219
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 217

def hash
  [email, role, status, invited_by, groups, , inviter_display_name, token, expires_at, created_at, updated_at].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



178
179
180
181
182
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 178

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 246

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



186
187
188
189
 
# File 'lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb', line 186

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end