Class: Vapi::CreateGoHighLevelMcpCredentialDto

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

Constant Summary collapse

OMIT = 
Object.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(authentication_session:, name: OMIT, additional_properties: nil) ⇒ Vapi::CreateGoHighLevelMcpCredentialDto

Parameters:

  • authentication_session (Vapi::Oauth2AuthenticationSession) —

    This is the authentication session for the credential.

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

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

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

    Additional properties unmapped to the current class definition



25
26
27
28
29
30
31
32
 
# File 'lib/vapi_server_sdk/types/create_go_high_level_mcp_credential_dto.rb', line 25

def initialize(authentication_session:, name: OMIT, additional_properties: nil)
  @authentication_session = authentication_session
  @name = name if name != OMIT
  @additional_properties = additional_properties
  @_field_set = { "authenticationSession": authentication_session, "name": name }.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



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

def additional_properties
  @additional_properties
end

#authentication_session ⇒ Vapi::Oauth2AuthenticationSession (readonly)

Returns This is the authentication session for the credential.

Returns:



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

def authentication_session
  @authentication_session
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.



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

def name
  @name
end

Class Method Details

.from_json(json_object:) ⇒ Vapi::CreateGoHighLevelMcpCredentialDto

Deserialize a JSON object to an instance of CreateGoHighLevelMcpCredentialDto

Parameters:

  • json_object (String)

Returns:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/vapi_server_sdk/types/create_go_high_level_mcp_credential_dto.rb', line 38

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  parsed_json = JSON.parse(json_object)
  if parsed_json["authenticationSession"].nil?
    authentication_session = nil
  else
    authentication_session = parsed_json["authenticationSession"].to_json
    authentication_session = Vapi::Oauth2AuthenticationSession.from_json(json_object: authentication_session)
  end
  name = parsed_json["name"]
  new(
    authentication_session: authentication_session,
    name: name,
    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) 


68
69
70
71
 
# File 'lib/vapi_server_sdk/types/create_go_high_level_mcp_credential_dto.rb', line 68

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

Instance Method Details

#to_json(*_args) ⇒ String

Serialize an instance of CreateGoHighLevelMcpCredentialDto to a JSON object

Returns:

  • (String) 


58
59
60
 
# File 'lib/vapi_server_sdk/types/create_go_high_level_mcp_credential_dto.rb', line 58

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