Class: Vapi::DeepgramCredential

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/deepgram_credential.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:, id:, org_id:, created_at:, updated_at:, name: OMIT, api_url: OMIT, additional_properties: nil) ⇒ Vapi::DeepgramCredential

Parameters:

  • provider (String)
  • api_key (String) —

    This is not returned in the API.

  • id (String) —

    This is the unique identifier for the credential.

  • org_id (String) —

    This is the unique identifier for the org that this credential belongs to.

  • created_at (DateTime) —

    This is the ISO 8601 date-time string of when the credential was created.

  • updated_at (DateTime) —

    This is the ISO 8601 date-time string of when the assistant was last updated.

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

    This is the name of credential. This is just for your reference.

  • 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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/vapi_server_sdk/types/deepgram_credential.rb', line 45

def initialize(provider:, api_key:, id:, org_id:, created_at:, updated_at:, name: OMIT, api_url: OMIT,
               additional_properties: nil)
  @provider = provider
  @api_key = api_key
  @id = id
  @org_id = org_id
  @created_at = created_at
  @updated_at = updated_at
  @name = name if name != OMIT
  @api_url = api_url if api_url != OMIT
  @additional_properties = additional_properties
  @_field_set = {
    "provider": provider,
    "apiKey": api_key,
    "id": id,
    "orgId": org_id,
    "createdAt": created_at,
    "updatedAt": updated_at,
    "name": name,
    "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



27
28
29
 
# File 'lib/vapi_server_sdk/types/deepgram_credential.rb', line 27

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.



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

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.



25
26
27
 
# File 'lib/vapi_server_sdk/types/deepgram_credential.rb', line 25

def api_url
  @api_url
end

#created_at ⇒ DateTime (readonly)

Returns This is the ISO 8601 date-time string of when the credential was created.

Returns:

  • (DateTime) —

    This is the ISO 8601 date-time string of when the credential was created.



18
19
20
 
# File 'lib/vapi_server_sdk/types/deepgram_credential.rb', line 18

def created_at
  @created_at
end

#id ⇒ String (readonly)

Returns This is the unique identifier for the credential.

Returns:

  • (String) —

    This is the unique identifier for the credential.



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

def id
  @id
end

#name ⇒ String (readonly)

Returns This is the name of credential. This is just for your reference.

Returns:

  • (String) —

    This is the name of credential. This is just for your reference.



22
23
24
 
# File 'lib/vapi_server_sdk/types/deepgram_credential.rb', line 22

def name
  @name
end

#org_id ⇒ String (readonly)

Returns This is the unique identifier for the org that this credential belongs to.

Returns:

  • (String) —

    This is the unique identifier for the org that this credential belongs to.



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

def org_id
  @org_id
end

#provider ⇒ String (readonly)

Returns:

  • (String) 


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

def provider
  @provider
end

#updated_at ⇒ DateTime (readonly)

Returns This is the ISO 8601 date-time string of when the assistant was last updated.

Returns:

  • (DateTime) —

    This is the ISO 8601 date-time string of when the assistant was last updated.



20
21
22
 
# File 'lib/vapi_server_sdk/types/deepgram_credential.rb', line 20

def updated_at
  @updated_at
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::DeepgramCredential

Deserialize a JSON object to an instance of DeepgramCredential

Parameters:

  • json_object (String)

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/vapi_server_sdk/types/deepgram_credential.rb', line 74

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"]
  id = parsed_json["id"]
  org_id = parsed_json["orgId"]
  created_at = (DateTime.parse(parsed_json["createdAt"]) unless parsed_json["createdAt"].nil?)
  updated_at = (DateTime.parse(parsed_json["updatedAt"]) unless parsed_json["updatedAt"].nil?)
  name = parsed_json["name"]
  api_url = parsed_json["apiUrl"]
  new(
    provider: provider,
    api_key: api_key,
    id: id,
    org_id: org_id,
    created_at: created_at,
    updated_at: updated_at,
    name: name,
    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) 


111
112
113
114
115
116
117
118
119
120
 
# File 'lib/vapi_server_sdk/types/deepgram_credential.rb', line 111

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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
  obj.org_id.is_a?(String) != false || raise("Passed value for field obj.org_id is not the expected type, validation failed.")
  obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
  obj.updated_at.is_a?(DateTime) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")
  obj.name&.is_a?(String) != false || raise("Passed value for field obj.name 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 DeepgramCredential to a JSON object

Returns:

  • (String) 


101
102
103
 
# File 'lib/vapi_server_sdk/types/deepgram_credential.rb', line 101

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