Class: OryClient::MemberInvite

Inherits:
ApiModelBase show all
Defined in:
lib/ory-client/models/member_invite.rb

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ MemberInvite

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/ory-client/models/member_invite.rb', line 125

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

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

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

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

  if attributes.key?(:'owner_email')
    self.owner_email = attributes[:'owner_email']
  else
    self.owner_email = nil
  end

  if attributes.key?(:'owner_id')
    self.owner_id = attributes[:'owner_id']
  else
    self.owner_id = nil
  end

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

The Project’s Revision Creation Date



19
20
21
 
# File 'lib/ory-client/models/member_invite.rb', line 19

def created_at
  @created_at
end

#id ⇒ Object

The invite’s ID.



22
23
24
 
# File 'lib/ory-client/models/member_invite.rb', line 22

def id
  @id
end

#invitee_email ⇒ Object

The invitee’s email



25
26
27
 
# File 'lib/ory-client/models/member_invite.rb', line 25

def invitee_email
  @invitee_email
end

#invitee_id ⇒ Object

Returns the value of attribute invitee_id.



27
28
29
 
# File 'lib/ory-client/models/member_invite.rb', line 27

def invitee_id
  @invitee_id
end

#owner_email ⇒ Object

The invite owner’s email Usually the project’s owner email



30
31
32
 
# File 'lib/ory-client/models/member_invite.rb', line 30

def owner_email
  @owner_email
end

#owner_id ⇒ Object

The invite owner’s ID Usually the project’s owner



33
34
35
 
# File 'lib/ory-client/models/member_invite.rb', line 33

def owner_id
  @owner_id
end

#project_id ⇒ Object

Returns the value of attribute project_id.



35
36
37
 
# File 'lib/ory-client/models/member_invite.rb', line 35

def project_id
  @project_id
end

#role ⇒ Object

Returns the value of attribute role.



37
38
39
 
# File 'lib/ory-client/models/member_invite.rb', line 37

def role
  @role
end

#status ⇒ Object

The invite’s status Keeps track of the invites status such as pending, accepted, declined, expired pending PENDING accepted ACCEPTED declined DECLINED expired EXPIRED cancelled CANCELLED removed REMOVED



40
41
42
 
# File 'lib/ory-client/models/member_invite.rb', line 40

def status
  @status
end

#updated_at ⇒ Object

Last Time Project’s Revision was Updated



43
44
45
 
# File 'lib/ory-client/models/member_invite.rb', line 43

def updated_at
  @updated_at
end

#workspace_id ⇒ Object

Returns the value of attribute workspace_id.



45
46
47
 
# File 'lib/ory-client/models/member_invite.rb', line 45

def workspace_id
  @workspace_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



87
88
89
 
# File 'lib/ory-client/models/member_invite.rb', line 87

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



92
93
94
 
# File 'lib/ory-client/models/member_invite.rb', line 92

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/ory-client/models/member_invite.rb', line 70

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'id' => :'id',
    :'invitee_email' => :'invitee_email',
    :'invitee_id' => :'invitee_id',
    :'owner_email' => :'owner_email',
    :'owner_id' => :'owner_id',
    :'project_id' => :'project_id',
    :'role' => :'role',
    :'status' => :'status',
    :'updated_at' => :'updated_at',
    :'workspace_id' => :'workspace_id'
  }
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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/ory-client/models/member_invite.rb', line 353

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



114
115
116
117
118
119
120
121
 
# File 'lib/ory-client/models/member_invite.rb', line 114

def self.openapi_nullable
  Set.new([
    :'invitee_id',
    :'project_id',
    :'role',
    :'workspace_id'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/ory-client/models/member_invite.rb', line 97

def self.openapi_types
  {
    :'created_at' => :'Time',
    :'id' => :'String',
    :'invitee_email' => :'String',
    :'invitee_id' => :'String',
    :'owner_email' => :'String',
    :'owner_id' => :'String',
    :'project_id' => :'String',
    :'role' => :'String',
    :'status' => :'String',
    :'updated_at' => :'Time',
    :'workspace_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/ory-client/models/member_invite.rb', line 322

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      id == o.id &&
      invitee_email == o.invitee_email &&
      invitee_id == o.invitee_id &&
      owner_email == o.owner_email &&
      owner_id == o.owner_id &&
      project_id == o.project_id &&
      role == o.role &&
      status == o.status &&
      updated_at == o.updated_at &&
      workspace_id == o.workspace_id
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


340
341
342
 
# File 'lib/ory-client/models/member_invite.rb', line 340

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



346
347
348
 
# File 'lib/ory-client/models/member_invite.rb', line 346

def hash
  [created_at, id, invitee_email, invitee_id, owner_email, owner_id, project_id, role, status, updated_at, workspace_id].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



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
 
# File 'lib/ory-client/models/member_invite.rb', line 200

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

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

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

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

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/ory-client/models/member_invite.rb', line 375

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



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/ory-client/models/member_invite.rb', line 236

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @created_at.nil?
  return false if @id.nil?
  return false if @invitee_email.nil?
  return false if @owner_email.nil?
  return false if @owner_id.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["pending", "accepted", "declined", "expired", "cancelled", "removed"])
  return false unless status_validator.valid?(@status)
  return false if @updated_at.nil?
  true
end