Class: Vapi::UpdateDeepgramCredentialDto

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(provider:, api_key:, api_url: OMIT, additional_properties: nil) ⇒ Vapi::UpdateDeepgramCredentialDto

Parameters:

  • provider (String)
  • api_key (String) —

    This is not returned in the API.

  • api_url (String) (defaults to: OMIT) —

    This can be used to point to an onprem Deepgram instance. Defaults to api.deepgram.com.

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

    Additional properties unmapped to the current class definition



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

def initialize(provider:, api_key:, api_url: OMIT, additional_properties: nil)
  @provider = provider
  @api_key = api_key
  @api_url = api_url if api_url != OMIT
  @additional_properties = additional_properties
  @_field_set = { "provider": provider, "apiKey": api_key, "apiUrl": api_url }.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/update_deepgram_credential_dto.rb', line 16

def additional_properties
  @additional_properties
end

#api_key ⇒ String (readonly)

Returns This is not returned in the API.

Returns:

  • (String) —

    This is not returned in the API.



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

def api_key
  @api_key
end

#api_url ⇒ String (readonly)

Returns This can be used to point to an onprem Deepgram instance. Defaults to api.deepgram.com.

Returns:

  • (String) —

    This can be used to point to an onprem Deepgram instance. Defaults to api.deepgram.com.



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

def api_url
  @api_url
end

#provider ⇒ String (readonly)

Returns:

  • (String) 


9
10
11
 
# File 'lib/vapi_server_sdk/types/update_deepgram_credential_dto.rb', line 9

def provider
  @provider
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::UpdateDeepgramCredentialDto

Deserialize a JSON object to an instance of UpdateDeepgramCredentialDto

Parameters:

  • json_object (String)

Returns:



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

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


70
71
72
73
74
 
# File 'lib/vapi_server_sdk/types/update_deepgram_credential_dto.rb', line 70

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of UpdateDeepgramCredentialDto to a JSON object

Returns:

  • (String) 


60
61
62
 
# File 'lib/vapi_server_sdk/types/update_deepgram_credential_dto.rb', line 60

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