Class: OpenApiOpenAIClient::Invite

Inherits:
ApiModelBase show all
Defined in:
lib/openapi_openai/models/invite.rb

Overview

Represents an individual invite to the organization.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
175
176
177
178
179
180
181
 
# File 'lib/openapi_openai/models/invite.rb', line 116

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accepted_at ⇒ Object

The Unix timestamp (in seconds) of when the invite was accepted.



41
42
43
 
# File 'lib/openapi_openai/models/invite.rb', line 41

def accepted_at
  @accepted_at
end

#email ⇒ Object

The email address of the individual to whom the invite was sent



26
27
28
 
# File 'lib/openapi_openai/models/invite.rb', line 26

def email
  @email
end

#expires_at ⇒ Object

The Unix timestamp (in seconds) of when the invite expires.



38
39
40
 
# File 'lib/openapi_openai/models/invite.rb', line 38

def expires_at
  @expires_at
end

#id ⇒ Object

The identifier, which can be referenced in API endpoints



23
24
25
 
# File 'lib/openapi_openai/models/invite.rb', line 23

def id
  @id
end

#invited_at ⇒ Object

The Unix timestamp (in seconds) of when the invite was sent.



35
36
37
 
# File 'lib/openapi_openai/models/invite.rb', line 35

def invited_at
  @invited_at
end

#object ⇒ Object

The object type, which is always organization.invite



20
21
22
 
# File 'lib/openapi_openai/models/invite.rb', line 20

def object
  @object
end

#projects ⇒ Object

The projects that were granted membership upon acceptance of the invite.



44
45
46
 
# File 'lib/openapi_openai/models/invite.rb', line 44

def projects
  @projects
end

#role ⇒ Object

owner or reader



29
30
31
 
# File 'lib/openapi_openai/models/invite.rb', line 29

def role
  @role
end

#status ⇒ Object

accepted,expired, or pending



32
33
34
 
# File 'lib/openapi_openai/models/invite.rb', line 32

def status
  @status
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



84
85
86
 
# File 'lib/openapi_openai/models/invite.rb', line 84

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/openapi_openai/models/invite.rb', line 89

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/openapi_openai/models/invite.rb', line 69

def self.attribute_map
  {
    :'object' => :'object',
    :'id' => :'id',
    :'email' => :'email',
    :'role' => :'role',
    :'status' => :'status',
    :'invited_at' => :'invited_at',
    :'expires_at' => :'expires_at',
    :'accepted_at' => :'accepted_at',
    :'projects' => :'projects'
  }
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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/openapi_openai/models/invite.rb', line 340

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



109
110
111
112
 
# File 'lib/openapi_openai/models/invite.rb', line 109

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/openapi_openai/models/invite.rb', line 94

def self.openapi_types
  {
    :'object' => :'String',
    :'id' => :'String',
    :'email' => :'String',
    :'role' => :'String',
    :'status' => :'String',
    :'invited_at' => :'Integer',
    :'expires_at' => :'Integer',
    :'accepted_at' => :'Integer',
    :'projects' => :'Array<InviteProjectsInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/openapi_openai/models/invite.rb', line 311

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      object == o.object &&
      id == o.id &&
      email == o.email &&
      role == o.role &&
      status == o.status &&
      invited_at == o.invited_at &&
      expires_at == o.expires_at &&
      accepted_at == o.accepted_at &&
      projects == o.projects
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


327
328
329
 
# File 'lib/openapi_openai/models/invite.rb', line 327

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



333
334
335
 
# File 'lib/openapi_openai/models/invite.rb', line 333

def hash
  [object, id, email, role, status, invited_at, expires_at, accepted_at, projects].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



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
 
# File 'lib/openapi_openai/models/invite.rb', line 185

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

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

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

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

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

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

  if @expires_at.nil?
    invalid_properties.push('invalid value for "expires_at", expires_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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/openapi_openai/models/invite.rb', line 362

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



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/openapi_openai/models/invite.rb', line 221

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @object.nil?
  object_validator = EnumAttributeValidator.new('String', ["organization.invite"])
  return false unless object_validator.valid?(@object)
  return false if @id.nil?
  return false if @email.nil?
  return false if @role.nil?
  role_validator = EnumAttributeValidator.new('String', ["owner", "reader"])
  return false unless role_validator.valid?(@role)
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["accepted", "expired", "pending"])
  return false unless status_validator.valid?(@status)
  return false if @invited_at.nil?
  return false if @expires_at.nil?
  true
end