Class: Vapi::CredentialSessionDto

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(provider:, additional_properties: nil) ⇒ Vapi::CredentialSessionDto

Parameters:

  • provider (Vapi::CredentialSessionDtoProvider) —

    The type of credential to generate a session for. Only Nango user-facing providers are supported.

  • additional_properties (OpenStruct) (defaults to: nil) —

    Additional properties unmapped to the current class definition



24
25
26
27
28
 
# File 'lib/vapi_server_sdk/types/credential_session_dto.rb', line 24

def initialize(provider:, additional_properties: nil)
  @provider = provider
  @additional_properties = additional_properties
  @_field_set = { "provider": provider }
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



13
14
15
 
# File 'lib/vapi_server_sdk/types/credential_session_dto.rb', line 13

def additional_properties
  @additional_properties
end

#provider ⇒ Vapi::CredentialSessionDtoProvider (readonly)

Returns The type of credential to generate a session for. Only Nango user-facing providers are supported.

Returns:



11
12
13
 
# File 'lib/vapi_server_sdk/types/credential_session_dto.rb', line 11

def provider
  @provider
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::CredentialSessionDto

Deserialize a JSON object to an instance of CredentialSessionDto

Parameters:

  • json_object (String)

Returns:



34
35
36
37
38
39
 
# File 'lib/vapi_server_sdk/types/credential_session_dto.rb', line 34

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  provider = parsed_json["provider"]
  new(provider: provider, 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) 


54
55
56
 
# File 'lib/vapi_server_sdk/types/credential_session_dto.rb', line 54

def self.validate_raw(obj:)
  obj.provider.is_a?(Vapi::CredentialSessionDtoProvider) != false || raise("Passed value for field obj.provider is not the expected type, validation failed.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of CredentialSessionDto to a JSON object

Returns:

  • (String) 


44
45
46
 
# File 'lib/vapi_server_sdk/types/credential_session_dto.rb', line 44

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