Class: Vapi::CreateMakeCredentialDto

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/create_make_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:, team_id:, region:, api_key:, additional_properties: nil) ⇒ Vapi::CreateMakeCredentialDto

Parameters:

  • provider (String)
  • team_id (String) —

    Team ID

  • region (String) —

    Region of your application. For example: eu1, eu2, us1, us2

  • api_key (String) —

    This is not returned in the API.

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

    Additional properties unmapped to the current class definition



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

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



17
18
19
 
# File 'lib/vapi_server_sdk/types/create_make_credential_dto.rb', line 17

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.



15
16
17
 
# File 'lib/vapi_server_sdk/types/create_make_credential_dto.rb', line 15

def api_key
  @api_key
end

#provider ⇒ String (readonly)

Returns:

  • (String) 


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

def provider
  @provider
end

#region ⇒ String (readonly)

Returns Region of your application. For example: eu1, eu2, us1, us2.

Returns:

  • (String) —

    Region of your application. For example: eu1, eu2, us1, us2



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

def region
  @region
end

#team_id ⇒ String (readonly)

Returns Team ID.

Returns:

  • (String) —

    Team ID



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

def team_id
  @team_id
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::CreateMakeCredentialDto

Deserialize a JSON object to an instance of CreateMakeCredentialDto

Parameters:

  • json_object (String)

Returns:



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/vapi_server_sdk/types/create_make_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"]
  team_id = parsed_json["teamId"]
  region = parsed_json["region"]
  api_key = parsed_json["apiKey"]
  new(
    provider: provider,
    team_id: team_id,
    region: region,
    api_key: api_key,
    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) 


72
73
74
75
76
77
 
# File 'lib/vapi_server_sdk/types/create_make_credential_dto.rb', line 72

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.team_id.is_a?(String) != false || raise("Passed value for field obj.team_id is not the expected type, validation failed.")
  obj.region.is_a?(String) != false || raise("Passed value for field obj.region 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.")
end

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of CreateMakeCredentialDto to a JSON object

Returns:

  • (String) 


62
63
64
 
# File 'lib/vapi_server_sdk/types/create_make_credential_dto.rb', line 62

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