Class: Vapi::InviteUserDto

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/invite_user_dto.rb

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(emails:, role:, redirect_to: OMIT, additional_properties: nil) ⇒ Vapi::InviteUserDto

Parameters:

  • emails (Array<String>)
  • role (Vapi::InviteUserDtoRole)
  • redirect_to (String) (defaults to: OMIT)
  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



28
29
30
31
32
33
34
35
36
 
# File 'lib/vapi_server_sdk/types/invite_user_dto.rb', line 28

def initialize(emails:, role:, redirect_to: OMIT, additional_properties: nil)
  @emails = emails
  @role = role
  @redirect_to = redirect_to if redirect_to != OMIT
  @additional_properties = additional_properties
  @_field_set = { "emails": emails, "role": role, "redirectTo": redirect_to }.reject do |_k, v|
    v == OMIT
  end
end

Instance Attribute Details

#additional_properties ⇒ OpenStruct (readonly)

Returns Additional properties unmapped to the current class definition.

Returns:

  • (OpenStruct) —

    Additional properties unmapped to the current class definition



16
17
18
 
# File 'lib/vapi_server_sdk/types/invite_user_dto.rb', line 16

def additional_properties
  @additional_properties
end

#emails ⇒ Array<String> (readonly)

Returns:

  • (Array<String>) 


10
11
12
 
# File 'lib/vapi_server_sdk/types/invite_user_dto.rb', line 10

def emails
  @emails
end

#redirect_to ⇒ String (readonly)

Returns:

  • (String) 


14
15
16
 
# File 'lib/vapi_server_sdk/types/invite_user_dto.rb', line 14

def redirect_to
  @redirect_to
end

#role ⇒ Vapi::InviteUserDtoRole (readonly)

Returns:



12
13
14
 
# File 'lib/vapi_server_sdk/types/invite_user_dto.rb', line 12

def role
  @role
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::InviteUserDto

Deserialize a JSON object to an instance of InviteUserDto

Parameters:

  • json_object (String)

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/vapi_server_sdk/types/invite_user_dto.rb', line 42

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  emails = parsed_json["emails"]
  role = parsed_json["role"]
  redirect_to = parsed_json["redirectTo"]
  new(
    emails: emails,
    role: role,
    redirect_to: redirect_to,
    additional_properties: struct
  )
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


69
70
71
72
73
 
# File 'lib/vapi_server_sdk/types/invite_user_dto.rb', line 69

def self.validate_raw(obj:)
  obj.emails.is_a?(Array) != false || raise("Passed value for field obj.emails is not the expected type, validation failed.")
  obj.role.is_a?(Vapi::InviteUserDtoRole) != false || raise("Passed value for field obj.role is not the expected type, validation failed.")
  obj.redirect_to&.is_a?(String) != false || raise("Passed value for field obj.redirect_to is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of InviteUserDto to a JSON object

Returns:

  • (String) 


59
60
61
 
# File 'lib/vapi_server_sdk/types/invite_user_dto.rb', line 59

def to_json(*_args)
  @_field_set&.to_json
end